Reports

Reports

A report is a network analysis tool that helps you

  • see data insights about your network's status and operation,

  • customize report content, format, and scheduling, and

  • support diverse operational use cases, such as capacity planning, usage trend analysis, and network health monitoring.

Examples of report use cases

  • Capacity planning: Understand how your network devices are used within the application.

  • Change of pattern: Track changes in usage patterns for clients, devices, bands, or applications on your network.

  • Operational reporting: Review reports about network operations, such as upgrade completions or provisioning failures.

  • Network health: Use reports to determine the overall health of your network.


Note


Each report has a specific maximum row limit. If you try to generate a report that exceeds this limit, you will receive a notification in the GUI and must reduce the report's scope before proceeding.


Generate your first report

Run specialized data reports about your network using this procedure.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports.

Step 2

In the Run Your First Report window, click Start.

You see the supported reporting categories in the Report Templates window. Each category has a link. Click the link to view the supported reports for that category.

Figure 1. Report Templates window
Figure 22: Displays the Report Templates Window

Note

 

Available options depend on the type of report selected.

Step 3

After you click a link, review the Report Templates window that corresponds to the selected category.

Each tile represents a template, provides report information, and includes links you can use to generate a report. Decide which template you want to use to generate your report. Each tile includes icons for PDF, CSV, Tableau Data Extract (TDE), or JSON file types.

Step 4

In the tile, click the header to view a sample report.

A Preview window appears. Use the sidebar to scroll and review the entire sample report. The sample report includes

  • applied filters (data filters that are used in building the report,

  • data metrics and summaries,

  • graphical representations of the data, such as line graphs, bar graphs, and pie graphs, and

  • tables that help you analyze data.

Note

 

You can use the sample report to plan how you want your report to look.

Step 5

Close the preview window.

Step 6

In the tile, click the Generate link to configure parameters to build a report.

The Generate window allows you to choose a format type for the report, apply data filters for your reports, and set up schedules for report generation.

Step 7

In the Generate a New Report window, click Let's Do It to get started with the wizard.

Alternatively, click the menu icon and choose Workflows > Generating a New Report to launch the wizard to generate a new report.

Step 8

In the Select Report Template window, select the template for the report.

The Template consists of the individual report types within the categories for the release. Review an autogenerated sample in the same window.

Click Next to proceed to the Setup Report Scope window.

Step 9

Enter a name for the report and select scope.

Enter a report name in the Report Name field and click the Scope field to display the available filter. Select the filter options for your report.

Note

 

The Setup Report Scope options change depending upon the selected Template Group.

Click Next to proceed to the Select File Type.

Step 10

Select the file type for the report.

The available File Type options for reports vary depending on the report you are creating.

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, use the Fields option to select attributes for the CSV, JSON, and Tableau Data Extract results.

Step 11

In the Schedule Report window, select the schedule for the report. Then, click Next to proceed to the Delivery and Notification window.

Step 12

Select the delivery mechanism for the report.

Figure 2. Delivery and Notification window
Displays the Delivery and Notification Window.
  • None: No email or webhook notifications are sent.

  • Email Report: Receive the email report as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: The Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, you can uncheck the check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You receive status updates for the report as webhook notifications such as 'In Queue', 'In Progress', and 'Success'. You can also view these notifications in the GUI.

Step 13

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report to start generating the report.

After you generate the report, a success window opens.

Step 14

Click View all Reports.

The Generated Reports window shows instance details of the scheduled report.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate an access point report

Do this procedure to configure Access Point (AP) reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window, you can view the reporting categories. Each category is shown as a clickable link. Click the link for the category you want to review supported reports.

Step 2

After clicking a link, review the Report Templates window for the selected category.

Figure 3. AP report
Figure 23: AP report sample view in the Report Templates window.

Each report template is shown as a tile with report information and links for generating reports. Select the template you want to use.

Step 3

In the tile, click the report header to view a sample report.

When the sample report appears, use the sidebar to scroll through it.

Note

 

Use the sample report to plan the layout and content of your custom report.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you choose the report format, apply data filters, and schedule report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

To skip this screen in the future, check the Don't show this to me again check box.

Step 7

In the Select Report Template window, choose the template from Template drop-down list.

Note

 

The Template consists of the individual report types that are within the category for the release.

You can review an auto-generated sample in the same window.

Step 8

Click Next.

Step 9

In the Setup Report Scope window, name the report, choose the scope and choose the time range.

Enter a name in the Report Name field, then click Scope to show the available filters. Select the filter options for the report and choose a Time Range.

Note

 

The Setup Report Scope options change based on the selected Template. AP reports retain data for up to 90 days (3 months).

Step 10

Click Next.

Step 11

In the Select File Type window, choose the file type for the report.

Depending on the report, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, the Fields option lets you select attributes for CSV, JSON, and Tableau Data Extract results.

Step 12

Click Next to continue.

Step 13

In the Schedule Report window, choose the schedule for the report. Then, click Next.

Step 14

In the Delivery and Notification window, choose the delivery mechanism for the report:

  • None: No email or webhook notifications are sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • As a Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • As an Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, clear the check boxes you do not wish to use.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Choose a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    Catalyst Center sends these status webhook notifications for the report:

    • In Queue

    • In Progress

    • Success

Step 15

Click Next.

Step 16

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report.

When the report is generated, you see a success window.

Step 17

Click View the Generated Reports .

The Generated Reports window shows instance details of the report that was scheduled.

Download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate an audit log report

Follow this procedure to configure Audit Log reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. Check if a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories. Each category is represented by a link. Click the link to view the available reports for that category.

Step 2

After clicking a link, review the Report Templates window for the selected category.

Figure 4. Audit Log report
Displays Audit Log report template.

Each template appears as a tile that contains information about the report and provides links to generate it. Choose the template that best fits your reporting needs.

Step 3

In the tile, click the header to view a sample report.

A window appears containing the sample report. Use the sidebar in the window to review the sample report.

Note

 

You can use the sample report to plan how you want your report to look.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

To skip this screen in the future, check the Don't show this to me again check box.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down lists.

Note

 

The Template list consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Step 8

Click Next.

Step 9

In the Setup Report Scope window, name the report and select the scope.

Enter a report name in the Report Name field. Click in the Scope field to display the available filter. Select the filter options for the report. Choose the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template.

Click Next.

Step 10

In the Select File Type window, select the file type for the report.

Catalyst Center displays these File Type options for the Audit Log report type:

  • CSV

  • JSON

For the CSV and JSON file types, select attributes using the Fields option.

Step 11

Click Next.

Step 12

In the Schedule Report window, select the schedule for the report. Then, click Next.

Step 13

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email notifications or webhook notifications are sent.

  • Email Report: The email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, you can uncheck the check boxes as needed.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list in the Subscription Profile field.

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You will receive status webhook notifications for the report. For example, you will receive "In Queue," "In Progress," and "Success" webhook notifications. You will also be able to view these notifications in the GUI.

Step 14

Click Next.

Step 15

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report.

A success window appears after the report is generated.

Step 16

Click View the Generated Reports.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information about managing generated reports, see Manage generated reports.


Generate a client report

Perform this procedure to configure specialized Client reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. Verify if a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the reporting categories. Each category is represented by a link. Select a link to view reports in that category.

Step 2

After clicking a link, review the Report Templates window for the selected category.

Figure 5. Client Report
Figure 24: The figure shows the Client report templates, including template tiles for various report types.

Each template appears as a tile with information about the report and links for generating a report. To generate a report, select a template.

Step 3

In the tile, click the header to view a sample report.

A window appears showing the sample report. To view the complete report, use the sidebar to scroll. Some client reports include this data:

  • Applied filters (data filters that were used to build the report).

  • Data metrics and summaries.

  • Graphical representation of the data (including line, bar, and pie graphs).

  • Tables that assist you in analyzing the data.

Note

 

Use the sample report to plan your report’s appearance.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

In the Generate window, select a file format, apply data filters, and schedule when to generate the report.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

To skip this screen in the future, check the Don't show this to me again check box.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down lists.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Step 8

Click Next.

Step 9

In the Setup Report Scope window, name the report and select the scope.

Enter a report name in the Report Name field and click in the Scope field to display the available filter. Select the filter options for the report, and then choose the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template. Client Trend, Unique Clients and Users Summary, Client Summary, and Client Detail reports cover up to 180 days. Other report types support up to 90 days of data.

Select Next.

Step 10

In the Select File Type window, select the file type for the report.

Depending on the report that you create, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, a Fields option lets you select attributes (additional fields) for the CSV, JSON, and Tableau Data Extract results.

Step 11

Select Next.

Step 12

In the Schedule Report window, select the schedule for the report. Then, click Next.

Step 13

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, a prompt appears to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    Clear the corresponding check boxes to reduce the number of notifications.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    Status webhook notifications are sent for the report. For example, you will receive "In Queue," "In Progress," and "Success" webhook notifications.

Step 14

Click Next.

Step 15

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report.

After the report is generated, a success window displays.

Step 16

Select the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate a compliance report

Catalyst Center allows you to retrieve a consolidated compliance audit report that shows the compliance status of individual network devices. This report provides complete visibility of your network.

This procedure describes how to configure a Compliance report for your network.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories.

Step 2

Click Compliance to display the Compliance templates.

Each template appears as a tile and includes report information and links for report generation.

Figure 6. Compliance report
In the Report Templates window, Compliance is selected, and the Network Device Compliance template is displayed.

Step 3

In the tile, click the header to view a sample report.

The sample report window opens. Use the sidebar to scroll and review the entire sample report.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure report parameters.

Step 6

In the Generate a New Report window, click Let's Do It.

To skip this screen in the future, check the Don't show this to me again check box.

Step 7

In the Select Report Template window, you can change the template from Template drop-down list.

Note

 

You can review an automatically generated sample in the same window.

Step 8

Click Next.

The Setup Report Scope window appears.

Step 9

In the Report Name field, enter a report name.

Step 10

In the Scope area, choose the Compliance Status, Compliance Category, Device Family, and Device Type to include in the report.

Note

 

The Setup Report Scope options change depending on the template that you select.

Step 11

Click Next.

Step 12

In the Select File Type window, select the file type for the report.

Catalyst Center displays these File Type options for the Compliance report type:

  • PDF

  • CSV

  • JSON

For the CSV and JSON file types, a Fields option lets you select attributes for the CSV and JSON results.

Step 13

Click Next.

Step 14

When the Schedule Report window appears, select the schedule for the report. Then, click Next.

Step 15

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    If an SMTP server is not configured for emails, Catalyst Center prompts you to configure one. Click the link to configure the email destination in System > Settings > External Services > Destinations > Email.

    • As a Link: The email notification of a successful compiled report contains a link back to itself and the Generated Reports page under Reports. You can view and download the report from the provided link.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you must add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform checks the email addresses for correct syntax and sends a notification if there is an error.

    • As an Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you must add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, uncheck the relevant check boxes.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL).

    Note

     

    If a webhook is not created, Catalyst Center prompts you to create one. Click the link to configure a webhook in Webhook tab in System > Settings > External Services > Destinations > Webhook.

    Catalyst Center sends you these status webhook notifications for the report:

    • In Queue

    • In Progress

    • Success

    You can view the event notification status in Platform > Runtime Dashboard > Event Summary.

Step 16

Click Next.

Step 17

In the Summary window, review the configuration and edit any of the files, if necessary.

Step 18

Click Generate Report.

After the report is generated, a success window appears.

Step 19

Click the View the Generated Reports link.

The Generated Reports window opens and displays the instance details of the scheduled report.

You can download the report, review it, edit it, duplicate it, or delete it in the Generated Reports window. For more information, see View Generated Reports.


Generate a configuration archive report

Use this procedure to get a consolidated report of configuration changes on your network devices.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories.

Step 2

From the left pane, click Configuration Archive to display the template.

Figure 7. Configuration Archive report
Displays Configuration Archive report template.

Each template is represented by a tile and contains information about the report and links to generate a report.

Step 3

In the tile, click the header to view a sample report.

A window displays the sample report. Use the sidebar to scroll and review the entire sample report.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

To skip this screen in the future, check the Don't show this to me again check box.

Step 7

In the Select Report Template window, you can change the template from the Template drop-down list.

Note

 

You can review an automatically generated sample in the same window.

Step 8

Click Next.

The Setup Report Scope window appears.

Step 9

In the Report Name field, enter a report name.

Step 10

In the Scope area, select Category from the drop-down list.

In band refers to configuration changes done by Catalyst Center.

Out Of Band refers to the configuration changes done outside Catalyst Center.

Step 11

Select the Device Family and Device Type to include in the report.

Note

 

The Setup Report Scope options change depending on the selected template.

Step 12

Click Next.

Step 13

In the Select File Type window, select the file type for the report.

Catalyst Center displays these File Type options for the Configuration Archive report type:

  • PDF

  • CSV

  • JSON

For CSV and JSON file types, you can use the Fields option to select attributes for the results..

Step 14

Click Next.

Step 15

When the Schedule Report window appears, select the schedule for the report. Then, click Next.

Step 16

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    If an SMTP server is not configured for emails, Catalyst Center prompts you to configure one. Click the link to configure the email destination in System > Settings > External Services > Destinations > Email.

    • As a Link: The email notification of a successful compiled report contains a link back to itself and the Generated Reports page under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you must add each email address separately and click Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • As an Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you must add each email address separately and click Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, uncheck the check boxes, as needed.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL).

    Note

     

    If a webhook is not created, Catalyst Center prompts you to create one. Click the link to configure a webhook in the Webhook tab in System > Settings > External Services > Destinations > Webhook.

    Catalyst Center sends you these status webhook notifications for the report:

    • In Queue

    • In Progress

    • Success

You can view the event notification status in Platform > Runtime Dashboard > Event Summary.

Step 17

Click Next.

Step 18

In the Summary window, review the configuration and edit any of the files, if necessary.

Step 19

Click Generate Report.

After the report is generated, a success window appears.

Step 20

Click the View the Generated Reports link.

The Generated Reports window displays with instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see View Generated Reports.


Generate an end-of-life report

This procedure describes how to configure an End of Life (EoX) report for your network.

Before you begin

  • You must accept the end-user license agreement (EULA) before downloading software or provisioning a device. For more information, see the Accept the License Agreement topic in the Cisco Catalyst Center Administrator Guide.

  • Ensure that the Cisco CX cloud connection is enabled. For more information, see the Update the Machine Reasoning Knowledge Base topic in the Cisco Catalyst Center Administrator Guide.

  • Run a successful Discovery job in Catalyst Center. Check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window opens and displays supported reporting categories as links. Each category appears as a link.

In the Report Templates window, each template appears as a tile. The tile contains information about the report and links for report generation. Choose the template you want to use.

Step 2

In the tile, click the header to view a sample report.

A window opens with the sample report. Use the sidebar to review the complete sample report.

Step 3

Click the close button to exit the preview.

Step 4

In the tile, click the Generate link to configure parameters to build a report.

Figure 8. EoX report
Figure 26: EoX report templates shown in the Report Templates window.

Step 5

In the Generate a New Report window, click Let's Do It to get started.

To skip this screen in the future, check the Don't show this to me again check box.

Step 6

In the Select Report Template window, select the template from Template drop-down list.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an automatically generated sample report in the same window.

Step 7

Click Next.

The Setup Report Scope window displays.

Step 8

In the Report Name field, enter a report name.

Step 9

In the Scope area, select the Device Type and Location to include in the report.

Note

 

The Setup Report Scope options change depending on the selected template.

Step 10

Click Next.

Step 11

In the Select File Type window, select the file type for the report.

Based on your report, Catalyst Center shows several File Type options:

  • PDF

  • CSV

  • Tableau Data Extract

For the CSV and Tableau Data Extract file types, a Fields option allows you to choose attributes (additional fields) for the CSV and Tableau Data Extract results.

Step 12

Click Next.

In the Schedule Report window, select the schedule for the report.

Step 13

Click Next.

Step 14

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications are sent.

  • Email Report: Email report is sent as a link or attachment.

    Follow the prompts to the Email tab in the Catalyst Center GUI to configure an SMTP server.

    If an SMTP server is not configured for emails, Catalyst Center prompts you to configure one.

    • As a Link: The email notification of a successful compiled report contains a link back to itself and the Generated Reports page under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to twenty email addresses. To add multiple email addresses, after each addition, press Enter on your keyboard. Catalyst Center platform checks the email addresses and sends a notification if the syntax is incorrect.

    • As an Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and support up to ten email addresses. To add multiple email addresses, you must add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

Catalyst Center sends these email notifications for the report:

  • Report is in the queue waiting to be processed.

  • Report processing is in progress.

  • Report been has successfully compiled and is completed.

To reduce the number of notifications, clear the check boxes as needed.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL).

Note

 

If a webhook is not created, Catalyst Center prompts you to create one. Follow the prompts to the Webhook tab in the Catalyst Center GUI to configure a webhook.

Catalyst Center sends you these status webhook notifications for the report:

  • In Queue

  • In Progress

  • Success

You can view these notifications in the GUI.

Step 15

Click Next.

Step 16

In the Summary window, review the configuration and edit any files, if necessary.

Step 17

Click Generate Report.

After the report is generated, a success window appears.

Step 18

Click the View the Generated Reports link.

The Generated Reports window displays with instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see View Generated Reports.


Generate an executive summary report

Follow this procedure to configure Executive Summary reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories. Each category appears as a link. Click a link to view the reports supported for that category.

Step 2

After clicking a link, review the Report Templates window for that selected category.

Figure 9. Executive Summary report
Figure 27: Executive Summary Report window for the selected category.

Each template appears as a tile containing report information and links for generating a report. Select your template to generate a report. The tile contains icons that represent the supported file types for the reports.

Step 3

In the tile, click the header to view a sample report.

A sample report appears in the window. Use the sidebar to scroll and review the report data.

  • Data metrics and summaries.

  • Graphical representations of the data, including line graphs, bar graphs, and pie charts.

  • Tables that assist you in analyzing the data.

Note

 

You can use the sample report to plan how you want your report to look.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you select a format type for the report, apply data filters for your reports, and set up schedules for the actual report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down list.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Click Next.

Step 8

In the Setup Report Scope window, name the report and select the scope and the time range.

Enter a report name in the Report Name field. Click Scope to display available filters. Select the filter options for the report. Choose the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template. The Executive Summary reports support up to 90 days of data retention.

Click Next.

Step 9

In the Select File Type window, select the file type for the report.

Depending on the report that you are creating, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, a Fields option lets you select attributes (additional fields) for the CSV, JSON, and Tableau Data Extract result files.

Click Next.

Step 10

In the Schedule Report window, select the schedule for the report. Then, click Next.

Step 11

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Select System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, you can clear the check boxes, as needed.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You will receive status webhook notifications for the report. For example, you will receive "In Queue," "In Progress," and "Success" webhook notifications. You will also be able to view these notifications in the GUI.

Click Next.

Step 12

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report.

After the report is generated, a success window appears.

Step 13

Click the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate an inventory report

Follow this procedure to configure Inventory reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. To verify that the Discovery job succeeded, open Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the available reporting categories. A link represents each category. Click a link to view the supported reports in that category.

Step 2

After clicking a link, review the Report Templates window for that selected category.

Figure 10. Inventory report
Figure 28: Window displays Inventory report templates

Each template is represented by a tile and contains information about the report and links to generate a report. Select the template you want to use to generate a report. Within the tile are icons that represent the supported file types for the reports.

Step 3

In the tile, click the header to view a sample report.

A window appears with the sample report. Use the sidebar in this window to scroll and review the sample report, which displays these details:

  • applied filters, which are data filters used to build the report,

  • data metrics and summaries,

  • graphical representation of the data, including line, bar, and pie graphs, and

  • tables that assist you in analyzing the data.

Note

 

Use the sample report to plan your desired report layout.

Step 4

Click X to close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you select a format type for the report, apply data filters for your reports, and set up schedules for the actual report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

You can skip this screen in the future by checking the Don't show this to me again check box.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down lists.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Click Next.

Step 8

In the Setup Report Scope window, name the report and select the scope.

Enter a report name in the Report Name field and click in the Scope field to display the available filter. Select the filter options you want to apply for the report.

Note

 

The Setup Report Scope options change depending on the selected Template.

Click Next.

Step 9

In the Select File Type window, select the file type for the report.

Step 10

Click Next.

Step 11

In the Schedule Report window, select the schedule for the report.

Click Next.

Step 12

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, clear these check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address, also called a callback URL. Select a webhook from the drop-down list in the Subscription Profile field.

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You will receive status webhook notifications for the report. For example, you will receive "In Queue," "In Progress," and "Success" webhook notifications. You will also be able to view these notifications in the GUI.

Click Next.

Step 13

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report.

After the report is generated, a success window appears.

Step 14

Click the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate a license report

Follow this procedure to configure Licensing reports about your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories. Each category appears as a link. Click a link to view only the supported reports for that category.

Step 2

After clicking a link, review the Report Templates window for that selected category.

Figure 11. Licensing report
Figure 29: Window displays Licensing report templates

Each template is represented by a tile. The tile contains information about the report and links that allow you to generate a report. Icons within the tile represent the supported file types for the reports.

Step 3

In the tile, click the header to view a sample report.

A window opens for the sample report. Use the sidebar to scroll and review the sample report. The report includes:

  • applied filters (data filters that were used to build the report),

  • data metrics and summaries, and

  • tables that assist you in analyzing the data.

Note

 

You can use the sample report to plan how you want your report to look.

Step 4

Close the preview.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

In the Generate window, select a format type, apply data filters, and set up a report schedule.

Step 6

In the Generate a New Report window, click Let's Do It.

To skip this screen next time, check Don't show this to me again.

Step 7

In the Select Report Template window, select the template for the report.

select the Template from the drop-down lists.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Click Next.

Step 8

In the Setup Report Scope window, name the report and select the scope and the time range.

In the Report Name field, enter a name for the report. Select the Scope field to display available filters. Select the filter options you want for the report, and then choose the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template.

Click Next.

Step 9

In the Select File Type window, select the file type for the report.

Depending on the report that you are creating, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, a Fields option lets you select attributes (additional fields) for the CSV, JSON, and Tableau Data Extract results.

Click Next.

Step 10

In the Schedule Report window, select the schedule for the report.

Click Next.

Step 11

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link to the report and to the Generated Reports window under Reports. You can view and download the report from this location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, you can clear these check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You receive status webhook notifications for the report, for example, In Queue, In Progress, and Success. You are also able to view these notifications in the GUI.

Click Next.

Step 12

In the Summary window, review the configuration and edit the files, if necessary.

Click Generate Report.

After the report is generated, a success window appears.

Step 13

Click the View the Generated Reports link.

The Generated Reports window shows the instance details of the report that was scheduled.

In the Generated Reports window, you can download, review, edit, duplicate, or delete the report. For more information, see Manage generated reports.


Generate a network devices report

Follow this procedure to configure Network Devices reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories. Each category is represented by a link. Click a link to view only the supported reports for that category.

Step 2

After you click a link, review the Report Templates window for that selected category.

Figure 12. Network Devices report
Figure 30: Network Devices report templates window showing available categories and sample reports.

Each template is represented by a tile. The tile contains information about the report and provides links to configure or generate a report. Determine which template you want to use to generate a report. Within the tile are icons that represent the supported file types for the reports.

Step 3

In the tile, click the header to view a sample report.

A window shows the sample report. Use the sidebar to review the sample report. The sample report displays:

  • applied filters, the data filters that were used to build the report,

  • data metrics and summaries,

  • graphical representation of the data (including line, bar, and pie graphs), and

  • tables that assist you analyze the data.

Note

 

You can use the sample report to plan how you want your report to look.

Step 4

Close the preview window.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you select a format type for the report, apply data filters for your reports, and set up schedules for the actual report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

Step 7

In the Setup the Report Template window, select the template for the report.

Select a template from the drop-down menus.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an autogenerated sample in the same window.

Click Next to open the Setup Report Scope window.

Step 8

Name the report and select the scope and the time range.

Enter a report name in the Report Name field and click the Scope field to show the available filters. Click the filter options you want for the report. Then select the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template.

Click Next to open the Select File Type window.

Step 9

Select the file type for the report.

Depending on the report that you are creating, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, use the Fields option to select attributes for your results.

Click Next to open the Schedule Report window.

Step 10

Select the schedule for the report.

Click Next to open the Delivery and Notification window.

Step 11

Select the delivery mechanism for the report:

  • None: No email or webhook notifications are sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report will have a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends the appropriate email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, you can uncheck the check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down menu (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You will receive status webhook notifications for the report. For example, you will receive "In Queue," "In Progress," and "Success" webhook notifications. You will also be able to view these notifications in the GUI.

Click Next to open the Summary window.

Step 12

Review your configuration and edit files if needed.

Click Generate Report.

After you generate the report, a success window appears.

Step 13

Click the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate a rogue and aWIPS report

Follow this procedure to configure Rogue and aWIPS reports for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories. A link represents each category. Click a link to see the supported reports in that category.

Step 2

After clicking a link, review the Report Templates window for that selected category.

Figure 13. Rogue and aWIPS report
Figure 31: Window displays Rogue and aWIPS report templates.

Each template is represented by a tile. Each tile displays information about the report and links for generating a report. Choose the template you want to use to generate a report. Icons in each tile show the supported file types for reports.

Step 3

Click the header to see a sample report.

A window displays the sample report. Use the sidebar to review its contents. The sample report displays:

  • applied filters, which are the data filters used to build the report,

  • data metrics and summaries,

  • graphical representation of the data (including line, bar, and pie graphs), and

  • tables that help you analyze the data.

Note

 

You can use the sample report to plan how you want your report to look.

Step 4

Close the preview window.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you select a format type for the report, apply data filters for your reports, and set up schedules for the actual report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down list.

Note

 

The Template contains individual report types for each release category.

You can review an auto-generated sample in the same window.

Click Next to proceed to the Setup Report Scope window.

Step 8

Name the report, select the scope, and then select the time range.

Enter a report name in the Report Name field and click the Scope field to display the available filters. Select the options you want for the report, and then select the Time Range.

Note

 
  • The Setup Report Scope options vary based on the selected Template.

  • If all the access points (APs) in your network are not assigned to a floor and you select Global in the Location filter, the Rogue and aWIPS report displays only the threats associated with assigned AP devices under the global hierarchy.

    To see threats for unassigned APs, leave the location filter empty.

Click Next to open the Select File Type window.

Step 9

Select the file type for the report.

The available File Type options depend on the report that you are creating:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, you can use the Fields option to select additional attributes for the output.

Click Next to open the Schedule Report window.

Step 10

Select the schedule for the report.

Click Next.

Step 11

In the Delivery and Notification window, select the delivery mechanism for the report:

  • None: No email or webhook notifications sent.

  • Email Report: Email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification of a successfully compiled report has a link back to itself and the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, uncheck the check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list in the Subscription Profile field.

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. To configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You will receive status webhook notifications for the report. For example, you will receive 'In Queue', 'In Progress', and 'Success' webhook notifications.

Click Next to open the Summary window.

Step 12

Review the configuration and edit any of the files, if necessary.

Click Generate Report.

After the report is generated, a success window appears.

Step 13

Click the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

In the Generated Reports window, you can download, review, edit, duplicate, or delete the report. For more information, see Manage generated reports.


Generate an ROI report

The Catalyst Center platform ROI Insights report shows you how your network operations improve in productivity with Catalyst Center and gives you ROI insights compared to a traditional NMS.

Use this procedure to configure an ROI report for your network operation.

Procedure


Step 1

From the main menu, choose Reports > Usage Insights.

The Usage Insights window shows these details.

  • SAVINGS: displays the time and cost saved on network operation with Catalyst Center for a selected time range.

  • ROI Insights: lists the ROI Insights report which you create based on the report features, time saved, cost saved, usage KPIs, traditional NMS time, and actions.

  • Savings Trends: displays the savings trend of Cost and Time for an ROI Insights report.

    Note

     

    The Savings Trends area appears only if the selected time range is more than a month.

Step 2

In the Campus Network Assurance, Network Device Onboarding, Campus Software Image Management, and Campus Network Segmentation areas, enter the time savings for both a traditional NMS and Catalyst Center in the Hours and Minutes fields.

  • Traditional NMS: Average time to detect and resolve an issue in the network without Catalyst Center.

  • Catalyst Center: Average time to detect and resolve an issue in the network with Catalyst Center.

Step 3

To change the Cost Inputs and IT Inputs, click Customize ROI Insights and make changes.

The Customize ROI Insights area shows the preconfigured Average Cost per IT Staff, Currency, Number of IT Staff, and Average Annual Hours Worked.

Step 4

To edit the time savings for a feature, click the corresponding Edit link under the Actions column and update the time in the subsequent pop-up window.

Step 5

To view the ROI report for a specific time range, click the time range drop-down list in the Customize ROI Insights pane and select the desired radio button.

  1. Select from the available time range options: 1 Month, 3 Months, 6 Months, and 1 Year.

  2. To customize the time range of ROI reports, click the time range drop-down list, click Custom, and define the Start Date and End Date.

Figure 14. Usage Insights report dashboard
Figure 32: Window displays usage insights report dashboard.

Step 6

Click Learn how these numbers are calculated in the center pane to view details for the ROI Insights table calculations.

The Calculation Details window shows how to calculate Time Saved and Cost Saved.

Step 7

To export the ROI report, click Export.

The supported file types for the reports are PDF and CSV files.


Generate a security advisories report

Follow these steps to configure a Security Advisories report for your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

In the Report Templates window, you see the available report categories. Each category appears as a link. Click the link for the report category you want to view

Step 2

After clicking a link, review the Report Templates window for that selected category.

Figure 15. Security Advisories report
Figure 33: Window displays Security advisories report templates.

Each template appears as a tile that contains information about the report and links to generate a report. Within the tile are icons that represent the supported file types for the reports.

Step 3

In the tile, click the header to view a sample report.

A window appears displaying the sample report. Use the sidebar to scroll and review the full report. The report data includes:

  • applied filters used to build the report,

  • data metrics and summaries, and

  • tables that assist you in analyzing the data.

Note

 

Use the sample report to plan your report.

Step 4

Close the preview window.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you select a format type for the report, apply data filters for your reports, and set up schedules for the actual report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down list.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Click Next.

Step 8

In the Setup Report Scope window, name the report and select the scope and time range.

Enter a report name in the Report Name field. Click in the Scope field to display the available filter. Choose the filter options you want for the report. Select the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template.

Click Next.

Step 9

In the Select File Type window, select the file type for the report.

Depending on the report that you are creating, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, a Fields option lets you select attributes (additional fields) for the CSV, JSON, and Tableau Data Extract results.

Click Next.

Step 10

In the Schedule Report window, select the schedule for the report.

Click Next.

Step 11

In the Delivery and Notification window, select the delivery mechanism for the report.

  • Email Report: You receive the email report as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: The email notification includes a link so you can access the report and open the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: Report is attached to the email notification.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, uncheck the check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You receive status webhook notifications for the report, such as 'In Queue,' 'In Progress,' and 'Success.' You can also view these notifications in the GUI.

Click Next.

Step 12

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Generate Report to create the report.

After you generate the report, a success window appears.

Step 13

Click the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate a SWIM report

Follow this procedure to configure SWIM reports about your network.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

The Report Templates window displays the supported reporting categories. Each category is represented by a link. Click a link to view supported reports for that category.

Step 2

After clicking a link, review the Report Templates window for that selected category.

Figure 16. SWIM report
Figure 34: SWIM Report for selected category.

Each template appears as a tile. The tile contains information about the report and provides links to generate a report. Within the tile are icons that represent the supported file types for the reports.

Step 3

Click the header within the tile to view a sample report.

A window appears and shows the sample report. Use the sidebar to scroll and review the entire report. The sample report shows:

  • applied filters, which contains data filters that were used to build the report,

  • data metrics and summaries, and

  • tables that assist you in analyzing the data.

Note

 

You can use the sample report to plan how you want your report to look.

Step 4

Close the preview window.

Step 5

In the tile, click the Generate link to configure parameters to build a report.

The Generate window lets you select a format type for the report, apply data filters for your reports, and set up schedules for the actual report generation.

Step 6

In the Generate a New Report window, click Let's Do It to get started.

If you do not want to see this screen again, select the Don't show this to me again check box.

Step 7

In the Select Report Template window, select the template for the report.

Select the Template from the drop-down lists.

Note

 

The Template consists of the individual report types within the categories for the release.

You can review an auto-generated sample in the same window.

Click Next.

Step 8

In the Setup Report Scope window, name the report and select the scope and time range.

Enter a report name in the Report Name field. Click the Scope field to display available filters. Choose the filter options you want for the report, and select the Time Range.

Note

 

The Setup Report Scope options change depending on the selected Template.

Click Next.

Step 9

In the Select File Type window, select the file type for the report.

Depending on the report you are creating, these File Type options may be available:

  • PDF

  • CSV

  • Tableau Data Extract

  • JSON

For the CSV, JSON, and Tableau Data Extract file types, a Fields option lets you select attributes for the CSV, JSON, and Tableau Data Extract results.

Click Next.

Step 10

In the Schedule Report window, select the time range and schedule for the report.

Click Next.

Step 11

In the Delivery and Notification window, select the delivery mechanism for the report.

  • None: No email or webhook notifications are sent.

  • Email Report: The email report is sent as a link or attachment.

    Note

     

    If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Link: A successfully compiled report notification includes a link back to itself and to the Generated Reports window under Reports. You can view and download the report from this link and location.

      Note

       

      Email notifications with embedded links to reports support up to 20 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    • Attachment: The email notification includes the report as an attachment.

      Note

       

      PDF reports support email notification attachments of up to 20 MB in size and up to 10 email addresses. To add multiple email addresses, you need to add each email address separately and press Enter (on your keyboard) after each addition. Catalyst Center platform validates the email addresses and notifies you if the syntax is incorrect.

    Catalyst Center sends these email notifications for the report:

    • Report is in the queue waiting to be processed.

    • Report processing is in progress.

    • Report has successfully been compiled and is completed.

    To reduce the number of notifications, you can uncheck the check boxes, as desired.

  • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

    Note

     

    If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

    You will receive status messages as webhook notifications for the report. For example, you will receive status webhook notifications stating 'In Queue,' 'In Progress,' and 'Success.

Click Next.

Step 12

In the Summary window, review the configuration and edit any of the files, if necessary.

Click Next.

After the report is generated, a success window appears.

Step 13

Click the View the Generated Reports link.

The Generated Reports window shows instance details of the report that was scheduled.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Generate a flexible report

Catalyst Center allows you the flexibility to generate customized reports for your wired and wireless networks. This procedure describes how to configure Flexible reports. You can choose the entity, attributes, aggregation, and filters.

You can configure Flexible reports using the Reports window in the Catalyst Center GUI.

Before you begin

Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

Procedure


Step 1

From the main menu, choose Reports > Report Templates.

Figure 17. Generate a flexible report
Figure 35: Window displays the Generate a Flexible Report option

Step 2

Click Generate a Flexible Report.

Note

 

Alternatively, click the menu icon and choose Workflows > Flexible Report.

Step 3

In the Flexible Report window, click Let’s Do it to get started.

The Name Your Report and Select a Time Range for this Report window appears.

Note

 

To avoid seeing the Flexible Report dialog box in the future, check the Don't show this to me again check box.

Step 4

In the Report Name field, enter the name of your report. Select the Time Range.

Note

 
  • You can generate the AP, Client, and Network Device reports for the past 180 days.

  • For the PoE reports, the supported time range is 30 days.

  • The supported time range for the AP Ethernet Interface reports is the last 30 days and the duration for each report is within 24 hours.

Step 5

Click Next.

Step 6

In the Create a Subreport window, enter the Subreport Name. Select the entity, report type, filter criteria, and respective attributes.

In this release, the Select an entity drop-down list includes these options:

  • Network Device

  • PoE

  • AP

  • SWIM

  • Client

  • AP Ethernet Interface

The Report Type options available are:

  • Trend

  • Summary

  • Top N

  • Distribution

Select the filter criteria for the chosen report type.

For example, for a Trend report type, select Trending Interval from the drop-down list.

Select attributes in the Attributes available for this report type area.

You can configure groups based on the group-by, sort-by, and aggregate options available for each attribute.

Note

 
For Trend and Distribution report types, you must select attributes that support group-by and aggregate options. For Top N report types, you must select an attribute that supports the sort-by option.

Step 7

Click Next.

Step 8

In the Configure Group By, Aggregates and Sorting Options as Applicable window, complete these tasks

  • Select Configure Group By.

    Note

     

    Configure Group By is required or optional based on the chosen report type.

  • Select Aggregate Options for each of the supported attributes from the drop-down list.

  • In Configure Sorting Option, you can select either Target Attributes or Sort Type for each subreport, and then select respective options from the drop-down list.

Step 9

Click Next.

The Filters for the Current Subreport window appears.

  • Select a filter option from the drop-down list and set corresponding filter values.

    Check the Apply this filter for the entire report check box, if necessary.

  • Configure the field filters available for the report.

    Select a filter from the drop-down list. Based on the selection, configure the Operator and Value options, or select a range, and then select the corresponding Unit.

    Note

     

    In this release, the operator-based filter options are available for the Client, AP and Network Device entities.

Step 10

Click Next.

The Would you like to add another Subreport window opens.

Step 11

Select Yes to add another subreport.

In the Subreports Created area, you can edit the parameters of any subreport, if necessary.

Click Next.

Step 12

In the Schedule the Report, Select Output Format and Choose the Delivery Method window, do these tasks:

  • Select the schedule for the report.

  • Select the output file format.

    Note

     

    In this release, the supported report file format is CSV. The flexible report allows you to generate or view separate CSV files for each subreport, or download or view related subreports together as a ZIP file.

  • Select the delivery mechanism for the report.

    Note

     

    You can configure Integration Settings using the link available to enable delivery options.

    The report delivery options include:

    • None: You can select to only view the report.

    • Email Report: Email report is sent as a link or attachment.

      Note

       

      If you have not yet configured an SMTP server for the emails, you are prompted to configure one. Follow the prompts to the Email tab in the GUI to configure an SMTP server. Choose System > Settings > External Services > Destinations > Email.

    • Webhook Notification: Notification is sent as a webhook to the configured webhook URL address (callback URL). Select a webhook from the drop-down list (Subscription Profile field).

      Note

       

      If you have not yet created a webhook, you are prompted to create one. Follow the prompts to the Webhook tab in the GUI to configure a webhook. In general, to configure a webhook, choose System > Settings > External Services > Destinations > Webhook.

      Catalyst Center sends these status webhook notifications for the report:

      • In queue

      • In progress

      • Success

    You can also view these notifications in the GUI.

Step 13

Click Next.

In the Summary window, you can review the subreports and edit the parameters, if necessary.

Step 14

Click Generate Report.

After you generate the report, a success window appears with these options:

  • Create Another Flexible Report

  • View the Generated Reports

Step 15

Click View the Generated Reports.

The Generated Reports window shows details of the new flexible report.

You can download, review, edit, duplicate, or delete the report in the Generated Reports window. For more information, see Manage generated reports.


Manage generated reports

Follow this procedure to download, review, edit, duplicate, or delete a previously generated report.

Figure 18. Generated reports
Figure 36: Window displays generated reports.

Before you begin

  • Run a successful Discovery job in Catalyst Center. You can check whether a Discovery job is successful in Device Inventory. From the main menu, choose Provision > Inventory to view the results.

  • Create a report using the Schedule functionality in the Catalog.

Procedure


Step 1

From the main menu, choose Reports.

Step 2

Click Generated Reports.

This information is shown:

  • Report Name: Name of the report.

    If you did not name the report, the system assigns a default name that includes the report type, date, and time.

    Note

     

    To view a report, click the report name link in the Generated Reports window. To download a report, click Download.

  • Schedule: One-time generated report or recurring report. Also shown is a brief description of the schedule that generated the report.

  • Last Run: Displays report execution status and details. The possible report execution status types include those that are:

    • Not Initiated: Report scheduled but not yet started.

    • In Queue: Report scheduled and in the processing queue to be executed.

    • In Progress: Report currently being executed.

    • Completed: Report execution completed displaying the date and time.

      Click the downward-pointing arrow icon to download the last generated report.

    • Expired: Report expired and no longer available in Catalyst Center.

    • Error: Report execution failed.

  • Reports: The number of generated reports, up to seven.

    Hover the mouse pointer over the displayed report number to see View Report List. Click View Report List to open a dialog box listing all report executions and their status (Not Initiated, In Queue, In Progress, Completed, Expired, and Error). The dialog box also shows a Download button to download a copy. Click Error to view any errors or warnings for the report execution.

    Important

     

    Catalyst Center retains a total of seven reports. Specifically, it retains the last seven executed reports and the last seven executed over the last seven days. For example, if you run eight reports in a single day, only the most recent seven reports remain. If you schedule one report per day, only the seven most recent daily reports are kept. You can export reports in various formats and archive them to a safe location.

  • Format: File format type, such as PDF or CSV.

  • Template Category: Type of report based on the catalog options (Client, Executive Summary, SWIM, or Inventory).

  • Report Template: Template used when generating the report.

  • Actions: List of tasks you can perform with the reports.

To filter downloads in the GUI, click the Filter icon and use the filter or enter a keyword in the Find field.

Step 3

Click Actions to perform one or more tasks.

  • View Config: Opens a window where the configured parameters for the report are displayed (including the schedule). You can review the configured report parameters in this window. You cannot make any changes to the report configuration in this read-only window. If you must edit the configuration, click Edit. You can both view and edit a report configuration by clicking Edit.

  • Edit: Opens a window where configured parameters for the report are displayed (including the schedule). You can review the parameters and also edit them in this window. Click Save after making any edits to the report.

    Important

     

    After you edit and update the report configuration, any future report executions reflect this new configuration. This is important if reports are being generated on a reoccurring schedule. Also, if you edit and update a report configuration, all the previous reports in Catalyst Center will be deleted. The GUI displays a warning about the deletion when clicking Save. Click Save to delete all previous reports, even if you do not make any changes to the configuration.

  • Duplicate: Opens the Duplicate window, where you can either view or configure the parameters for the report. Click Generate Report to generate the report again.

    Note

     

    To create a new report based on the configuration of an existing report, use Duplicate and modify the settings. The original report and its settings remain unchanged. To replace an existing report, use View Config and Edit

    .
  • Run Now: Starts the process to execute the report. After the report runs successfully, a message confirms the successful execution.

    Note

     

    If you try to run a report and seven reports already exist, the GUI warns you that only the last seven reports are saved. Use Run Now to generate a report outside the report schedule.

  • Delete: Deletes the report. You are prompted to confirm the action before the report is deleted.