`report`

Creates and updates the report configurations.

Syntax

report report-title

no
                  					report

report-title

After the report command is entered to enter Report configuration mode, the following configuration syntax is available:

{ email email-address | enable-export | pdf-format | type { client-number | continuously-disconnected-aps | switch-traffic-statistics | system-resource-utilization | tx-rx-bytes } }

{ resource-filter { device { ap ap-name | domain domain-name | zone zone-name } | radio { 2.4g | 5g } | ssid ssid } }

{ schedule { daily hour minute minute | hourly minute | monthly date-of-month hour hour minute minute | weekly day-of-week hour hour minute minute }

{ time-filter { 3min | 15min | hourly } hours hour }

After the enable-export command is entered, the following configuration syntax is available:

[ export ftp-url ]

Command Default

A report is not configured.

Parameters

report-title

Name of the report.

email email-address

Sets email notification address.

enable-export

Enable the export report results to be sent to an FTP server.

pdf-format

Outputs the report to a PDF.

type

Sets the report type.

client-number: This report shows the historical view of the maximum and minimum number of clients connect to the system. Client number can be shown in different time intervals for a specified duration. The report can be generated based on specific management domain, AP zone, AP, SSID, or radio type.
continuously-disconnected-aps: This report shows the list of access points disconnected with specified time range. The report can be generated based on specific management domain and AP zone.
switch-traffic-statistics: This report shows the traffic statistics of switches, including the packets of InFrame, OutFrame, InMulticast, OutMulticast, InBroadcast, and OutBroadcast. The numbers of InError, OutError, CrcError, and InDiscard packets are also included.
system-resource-utilization: This report shows the historical view of the CPU and memory usage of the system. The CPU and memory usage can be shown in different time intervals for a specific duration. The report can be generated based on specific plane.
tx-rx-bytes: This report shows the historical view of the transmitted and received bytes of the system. The transmitted and received bytes can be shown in different time intervals for a specified duration. The report can be generated based on specific management domain, AP zone, AP, SSID or radio type.

resource-filter

Sets the resource filter criteria for the report.

device

Filtered by device parameters.

ap ap-name: Filtered by AP name.
domain domain: Fitlered by domain name or the administration domain.
zone zone-name: Fitlered by zone name.

radio

Filtered by radio frequency.

2.4g: Filtered by 2.4g.
5g: Fitlered by 5g.

ssid ssid

SSID

schedule

Sets the schedule criteria for when the report is run.

daily

Run the report on a daily schedule.

hour: Specifies the hour.
minute minute: Specifies the minute.

hourly minute

Runs the report on the same minute every hour.

monthly ssid

Runs the report on a monthly schedule.

date-of-month: Specifies the day in the month.
hour hour: Specifies the hour.
minute minute: Specifies the minute.

monthly ssid

Runs the report on a monthly schedule.

day-of-week: Specifies the day in the week.
hour hour: Specifies the hour.
minute minute: Specifies the minute.

time-filter

Sets the period of time during which the data is gathered for the report.

3min: Sets the time period to 3 minutes.
15min: Sets the time period to 15 minutes.
hourly: Sets the time period to hourly.
hour hour: Specifies the hour.

export ftp-url

Sets the FTP URL to which the reports are exported. The FTP format is ftp://<username>:<pwd>@<ftp-host>[/<dir-path>].

Modes

Global configuration mode

Usage Guidelines

Although you can configure the options individually and some are optional, you must configure the following options to create and export a report.

email email-address

You must specify an FTP server for export.

Before you can configure the export command and the FTP server details, you must enter the enable-export command.

This command is supported on all SmartZone platforms except SmartZone Data Plane controller.

Use the no form of this command with a report name to remove the configuration for the specified report.

Examples

The following example shows how to create a report configuration to export a report in PDF format to an FTP server. The report type displays the historical view of the maximum and minimum number of clients connect to the system for the mktg-zone2 zone and it is scheduled to run daily at 32 minutes past the 20th hour.

device# config
device(config)# report report2 
device(config-report)# email user2.mktg@commscope.com
device(config-report)# pdf-format
device(config-report)# resource-filter device zone mktg-zone2
device(config-report)# schedule daily 20 minute 32
device(config-report)# type client-number
device(config-report)# enable-export
device(config-report)# export ftp://user2:abc123@10.10.2.4/reports
Password: ***
Retype: ***

Commands O through Sh

report

`report`