Reports

Table 1. Feature History

Feature Name

Release Information

Description

Reports

Cisco vManage Release 20.10.1

Cisco IOS XE Catalyst SD-WAN Release 17.10.1a

You can schedule a report, download it as a PDF document, and receive it as an email. The Reports menu has been added to Cisco SD-WAN Manager.

Additional Report Types and Formats

Cisco Catalyst SD-WAN Manager Release 20.15.1

This feature introduces several new report types, including Security reports, which are available in CSV or PDF format.

CPU, Memory and Energy Report

Cisco Catalyst SD-WAN Manager Release 26.1.1.1

This feature introduces a new CPU, Memory and Energy Report in addition to the preexisting reports.

Upgrade Pre-check Report

Cisco Catalyst SD-WAN Manager release 26.2.1

This feature introduces a new upgrade pre-check report in addition to the preexisting reports.

Information About Reports

In Cisco SD-WAN Manager, you can generate reports with information about the health of your sites, devices, and tunnels.

The following reports are available in Cisco SD-WAN Manager:

  • Executive Summary Report

  • Link Availability Report

  • Site Availability Report

  • Link Utilization Report

  • Link SLA Report

    From Cisco Catalyst SD-WAN Manager Release 26.2.1 the Link SLA Report is renamed to Link Performance Report.

  • Application Usage Report

  • IPS Event Collection Report

  • Firewall Enforcement Report

  • Malware File Collection Report

  • Internet Browsing Report

  • All Applications Report

    The All Applications Report is available only on a Converged dasboard. For more information about Converged dashboard, see Converged Dashboard for SD-WAN Analytics and SD-WAN Manager.

  • CPU, Memory, Energy Report

    (Minimum supported release: Cisco Catalyst SD-WAN Manager Release 26.1.x)

  • Upgrade Pre-check Report

    (Minimum supported release: Cisco Catalyst SD-WAN Manager Release 26.2.1)

  • Link SLA Change Report

    (Minimum supported release: Cisco Catalyst SD-WAN Manager Release 26.2.1)

    The Link SLA Change report provides historical data on changes to SLA metrics over time. It includes an SLA Change Reason field, which identifies whether an event was triggered by packet loss, latency, or jitter to facilitate precise root cause analysis.

You can generate these reports in PDF or CSV formats. You can generate up to 100 reports in PDF format, while CSV has no limit.

Restrictions for Reports

  • Reports are available in both single-tenant and multitenant deployments. In a multitenant environment, the reports are accessible only through the tenant dashboard.

  • From Cisco Catalyst SD-WAN Manager Release 20.18.1, NMS service status is changed to an on-demand model.

    The command request nms all status shows Enabled: false and Status: not running when inactive.

Run a Report

Before You Begin

Ensure you configure email settings in Cisco SD-WAN Manager for scheduling reports. For more information, see Configure Email Settings. This step is necessary only if you want the report to be emailed.

Run a Report

  1. From the Cisco SD-WAN Manager menu, choose Reports > Reports.

  2. Click Report Templates.

  3. Choose a report and click Generate on the report.

    Field

    Description

    Report Name

    Enter a name for the report.

    Sites

    Choose the sites for which you want to generate the report.

    File Type

    Choose a file type in which to render the report.

    Time Range

    Choose the time range for which you want to generate the report.

    Default: 7 days

    Schedule

    Choose one of the schedule options.

    • Run Now: Run the report immediately.

    • Run Later (One-Time): To run the report once, enter the start date and start time.

    • Run Recurring: To run the report periodically, enter the start date and start time, and choose a frequency from the Repeats drop-down list.

    Delivery

    • Email Report: Send the report via email.

    • Email: Enter up to five email addresses.

  4. Click Generate Report.

Configure Email Settings

  1. From the Cisco SD-WAN Manager menu, choose Administration > Settings.

  2. In Alarm Notifications, choose Enabled.

    From Cisco Catalyst SD-WAN Manager Release 20.13.1, click the toggle button to enable cloud services.

  3. Check the Email Settings check box.

  4. Choose the security level for sending the email notifications. The security level can be None, SSL, or TLS.

  5. In the SMTP Server field, enter the name or the IP address of the SMTP server to receive the email notifications.

  6. In the SMTP Port field, enter the SMTP port number. For no security, the default port is 25; for SSL it is 465; and for TLS it is 587.

  7. In the From address field, enter the full email address to include as the sender in email notifications.

  8. In the Reply to address field, enter the full email address to include in the Reply-To field of the email. This address can be a no-reply address, such as noreply@cisco.com.

  9. Check the Use SMTP Authentication check box to enable SMTP authentication to the SMTP server.

    If you enable SMTP authentication and do not select an SMTP port (port 25), Cisco SD-WAN Manager internally sets the SSL protocol property when it sends the email notification. This ensures the email is sent securely.

    Enter the username and password to use for SMTP authentication. The default user email suffix is appended to the username. The password that you type is hidden.

  10. Click Save.

View Generated Reports

  1. From the Cisco SD-WAN Manager menu, choose Reports.

  2. Click My Reports.

    The My Reports page displays all the generated reports. Use the filter options (schedule, status, and time frame) in the Summary pane or enter a keyword in the search bar to view the reports of your interest.

Download a Report

The download option is available only if the report generation is complete.

  1. From the Cisco SD-WAN Manager menu, choose Reports.

  2. Click My Reports.

  3. Click … adjacent to the corresponding report name and choose Download.

Edit a Report

  1. From the Cisco SD-WAN Manager menu, choose Reports.

  2. Click My Reports.

  3. Click … adjacent to the corresponding report name and choose Edit.

  4. In the Executive Summary Report pane, review and edit the configured parameters of the report.

  5. Click Update Report.

After you edit and update the report configuration, any future report generations reflect the new configuration.

Rerun a Report

The option to rerun a report is available when a report is in the scheduled, completed, or failed state.

  1. From the Cisco SD-WAN Manager menu, choose Reports.

  2. Click My Reports.

  3. Click … adjacent to the corresponding report name and choose Run Now.

Cancel a Scheduled Report

The cancel option is available only when a report is in the scheduled state.

  1. From the Cisco SD-WAN Manager menu, choose Reports.

  2. Click My Reports.

  3. Click … adjacent to the corresponding report name and choose Cancel.

Delete a Report

The delete option is available when a report is in the scheduled, completed, or failed state.

  1. From the Cisco SD-WAN Manager menu, choose Reports.

  2. Click My Reports.

  3. Click … adjacent to the corresponding report name and choose Delete.

Generate CPU, memory, energy report

Field Description
Report Name Enter a name for the report.
Sites Choose the sites for which you want to generate the report.
File Type Choose a file type in which to render the report.
Time Range

Choose the time range for which you want to generate the report.

Default: 7 days
Schedule

Choose one of the schedule options.

  • Run Now: Run the report immediately.

  • Run Later (One-Time): To run the report once, enter the start date and start time.

  • Run Recurring: To run the report periodically, enter the start date and start time, and choose a frequency from the Repeats drop-down list.

Delivery

  • Email Report: Send the report via email.

  • Email: Enter up to five email addresses.

Generate energy management report

Procedure

Step 1

From the Cisco SD-WAN Manager menu, choose Reports > Reports.

Step 2

Click Report Templates.

Step 3

In the Report Templates page, choose a Energy management report card and click Generate.

The Energy management report window appears.

Step 4

In the Energy management window, enter the name of the report in the Report name field.

Step 5

Choose sites from the Sites drop-down list.

Step 6

Choose the File type.

  • CSV
  • PDF

Step 7

Choose the Time range.

Step 8

Choose the Schedule.

  • Run now
  • Run later (one-time)
  • Run recurring

Step 9

(Optional) Choose the Delivery method.

You can enter up to 5 email addresses in the Email field.

A new energy management report is created in the specified format and are available in the My reports tab. Reports are also delivered to the email addresses mentioned. For more details on the Reports, see Reports.

Generate Upgrade Pre-check Report

Procedure

Step 1

From the Cisco SD-WAN Manager menu, choose Reports > Reports.

Step 2

Click Report Templates.

Step 3

In the Report Templates page, choose a Upgrade Pre-check report card and click Generate.

The Upgrade Pre-check report window appears.

Step 4

In the Upgrade Pre-check report window, enter the name of the report in the Report name field.

Note

 

To ensure the current device versions are compatible with the desired upgrade version for custom selection, ensure to check the compatibility matrix for the desired upgrade version SD-WAN compatibility matrix.

Step 5

In the Recommended image pane, to onboard Cisco Services, click Register now after reading the End User License Agreement OR select the Custom option and choose the image from the Select and image drop-down list.

Step 6

(Optional) Click Add New Image to add new image.

Step 7

Choose the File type.

  • CSV
  • PDF

Step 8

(Optional) To enable email delivery, configure email settings in the Settings page.