Cisco Prime Network User Guide, 5.2

Setting Up Native Reports

---

Prime Network provides two reporting functions. The native reports feature is launched from the Reports menu in the Vision client, Events client, or Administration client; this reporting tool is described in the following topics. The Operations Reports feature is an optional application and is described in Cisco Prime Network 5.2 Operations Reports User Guide.

These topics describe how to set up the native reports feature:

• Workflow for Setting Up Regular Reports
• Checking Global Settings for Report Operations
• Setting Up Your Report Folders
• Inventory Hardware and Software Reports
• Network Service Reports
• Creating Your Customized Report
• Entering Report Criteria and Testing Your Report
• Scheduling a Recurring Report
• Sending a Report Through E-mail Notification

Whether you can perform these setup tasks depends on your account privileges. See Permissions Required to Perform Tasks Using the Prime Network Clients for more information.

Workflow for Setting Up Regular Reports

This workflow shows the steps required to set up regular, scheduled reports. If you simply want to run an existing predefined report, see:

• Inventory Hardware and Software Reports
• Network Service Reports

The following table provides the basic workflow for setting up scheduled reports.

Checking Global Settings for Report Operations

The following default report behavior is controlled from the Administration client and will affect report users:

• The report actions users can perform, and the devices users can view and manage. When a user account is created the administrator assigns a user access level to the user account (Viewer, Operator, Operator Plus, Configurator, or Administrator).

– The user access level controls which reports a user can generate.

– The device scope determines which devices a user has permission to access, and which devices they can run reports against.

For a matrix of actions users can perform depending on their user access level and device scope assignments, see Permissions Required to Perform Tasks Using the Prime Network Clients .

• Whether users can create public (shared) reports. By default, users cannot create shared reports.

Users with Administrator privileges can change these settings. They can also configure Prime Network to generate a warning message whenever a user executes a command script. For more information, see the Cisco Prime Network 5.2 Administrator Guide.

Setting Up Your Report Folders

Create nested folders to organize your reports under the existing Report Manager categories: Events Reports, Inventory Reports, and Network Service Reports. You can then place your customized reports under these folders (by specifying the Location field when you create the report).

Step 1 Choose Reports > Report Manager from the Prime Network client main menu.

Step 2 In Report Manager, choose Events Reports > New Folder.

Step 3 In the New Folder dialog, enter a folder name. The new folder appears under the Events Reports.

You can also move folders and reports to new locations from the Report Manager.

Event Reports

These event reports can be run from the Vision client, Events client, or Administration client:

• Generalized Network Event Reports (Tickets, Service Events, Traps, Syslogs)
• Generalized Network Event Reports (Tickets, Service Events, Traps, Syslogs)
• Ticket Event Reports
• Service Event Reports
• Syslog-Specific Event Reports
• Trap-Specific Event Reports
• Database-Related Event Reports
• Audit, Provisioning, System, Security Event Reports (Non-Network Reports)

Inventory Hardware and Software Reports

For all inventory reports, Prime Network retrieves the inventory information from the network element. These inventory reports can be run from the Vision client, Events client, or Administration client:

• Hardware Reports
• Software Reports

Hardware Reports

 

Hardware inventory information:	Type of report:	Can you choose devices?
Hardware details (you can filter this report using a string from the device, chassis, module, or port name): Chassis—Description and serial number; shelf description, serial number, and status Note When the last Virtualized Services Module (VSM) blade is removed from the chassis, a notification stating that the data center has been removed is sent by the Prime Network. When this notification is received and transformed by Prime Network Integration Layer to the Operations Support Systems (OSS) client, the client is expected to delete all objects (Hosts, VM) under this specific virtual device context (VDC). Module—Module and sub module name; module status, hardware type, and version Port—Port location, type, and status; port alias, if port is sending alarms, if port is managed, PID, pluggable type serial number.	Hardware Detailed	Yes
Hardware details you can optionally group (the report also provides the device IP address and serial number): Device name or system name Vendor, product, device series, element type, or chassis	Hardware Summary	Yes
Module details (you can filter this report using a string from the module name): Device IP Address Serial Number Hardware Version Software Version Pluggable Transceiver properties: Note For a module which contains ports but no pluggable transceiver ports, these properties will be marked as N/A. Interface Name Connector Type Connector Description Connector Serial Number Pluggable Type Pluggable Transceiver ID Pluggable Port State	Modules SFP Summary (By Type)	Yes
Module details (you can filter this report using a string from the module name): Device IP Address Serial Number Hardware Version Software Version	Modules Summary (By Type)	Yes

Network Service Reports

The following network service reports can be run from the Vision client, Events client, or Administration client.

Creating Your Customized Report

Customized reports can be added to Report Manager so that other users can run them using their own criteria (depending on their user access level and device scopes). If you created new report folders as described in Setting Up Your Report Folders, customized reports can be organized under that folder (using the Location field).

This example shows how to create a report called 24-Hour Critical Tickets. The customized report will be stored under a user-created folder called Critical Tickets - Daily Report - August 2014.

Step 1 Right-click Events Reports > Detailed Network Events > Detailed Tickets > Define Report of This Type.

Step 2 In the Create Report dialog, enter the required information, such as:

• Report Settings

– Name— 24-Hour Critical Tickets

– Location—Click Browse and navigate to Events Reports > Critical Tickets - Daily Report - August 2014 in the Move To dialog box.

• Date Selection— Last 1 days
• Device Selection— All Devices
• Filter Events/Tickets By Severity— Critical

Step 3 Click OK.

Creating Detailed Standard Events Report

This example shows how to create a Detailed Standard Events report for devices from Prime Network Vision client, using the Report Manager. When you create a Detailed Standard Events you can schedule, according to the severity and events you can filter the reports. After creating the report you can view the job and export Job details in a report format that are managed by Prime Network. You can save the reports in any one of the following formats PDF, XM,.CSV, HTML, and XLS.

You can export these Standard events report through Prime Network Vision client, schedule and send email notification automatically. Also, you can use the Prime Network Administrator and Events clients to generate the Detailed Standard Events report.

To create a detailed standard events report in Prime Network Vision client:

Step 1 Log in to the Prime Network Vision.client.

Step 2 Select Reports > Reports Manager > Events Reports > Detailed Network Events > Detailed Standard Events.

Step 3 Right-click the Detailed Standard Events > Run. The Create Report window appears.

Note You can also choose Reports > Run Report > Events Reports > Detailed Network Reports > Detailed Standard Events.

Step 4 In the Create Report window, on the General tab, enter the required information:

• Report Settings

– Name— Specify the name of the report.

– Description—Enter the description of the report.

– Report Security—Click the Private or Public radio button to set the security.

• Date Selection— Last 1 days
• Device Selection— Select Devices or All Devices

Note You can also click Add to add a network element to create a report.

• Filter Events/Tickets By Severity— Critical
• Filter Events—Click the Syslogs or Traps or All radio button
• Additional Report Specifications—Enter the additional description, if required.
• On the Scheduling tab, enter the required information:

– Run Now—Click the radio button to run the report

– Schedule Job—Click the radio to specify all job criteria.

• On the E-mail Notifications tab, enter the required information.

Step 5 Click OK, t o generate the detailed standard events report in PDF, XM,.CSV, HTML, or XLS format.

Step 6 In the Reports Manager window, the created report details will be displayed and you can click View As to select the format, save and download the report in the specified format.

Entering Report Criteria and Testing Your Report

To enter criteria and test a customized report:

Step 1 Select Reports > Report Manager > Run Report and navigate to your customized report.

Step 2 Right-click the report and choose Run Now.

Step 3 Supply your report criteria. What you must supply depends on the report type. Most criteria is self-explanatory, but the following provides some additional details on the choices.

Note The settings that are displayed depend on the report type.

• General Criteria:

Report Settings
Report Security	Note This field is displayed only if report sharing is enabled. See Checking Global Settings for Report Operations. Private—Can only be viewed by creator. Public—Can be viewed by all users, even if the devices are outside their scope. If sharing is enabled, this setting can be changed after the report is created (by right-clicking the report and selecting Share or Unshare).
Display n	Number of items to be displayed in report.
Data Source	Run report based on actionable or generic events
Include pie charts in report output	Also generate pie chart.
Device Selection
Select Devices	To select specific devices: 1. Click Select Devices. 2. Click Add. 3. In the Add Network Element dialog box: – Click Search to find NEs based on your criteria. – Click Show All to choose from a list of all NEs. 4. Select the NEs and click OK.

• Special Criteria for Traps:

Traps Detailed Description	Include traps with descriptions that match string.
Long Description	(Actionable events) Include traps that have string in their long description. 1. Check Show Long Description check box. 2. Enter the string that the trap long description must contain.
SNMP Version	(Generic events) SNMP versions to include in the report: All, 1, 2, or 3.
Generic	Include generic (non-actionable) traps:
	All	All generic traps
	0	coldStart
	1	warmStart
	2	linkDown
	3	linkUp
	4	authenticationFailure
	5	egpNeighborLoss
	6	enterpriseSpecific (enter comma-separated OIDs, up to 125 digits, in Vendor Specific field)

Step 4 Click the Scheduling tab and choose Run Now.

Step 5 Verify the results in Report Manager or when the report is displayed in the web browser.

Scheduling a Recurring Report

To schedule a recurring customized report, use the Report Manager. If you want to schedule a predefined report, you can run it from Report Manager or directly from the Prime Network client Reports menu. To run a report immediately, click the Schedule tab and choose Run Now.

To schedule a report:

Step 1 Select the report you want to schedule.

Step 2 Supply your report criteria.

Step 3 Click the Scheduling tab and give the job a meaningful title (for example, 24-Hour Ticket Report Job).

Step 4 Enter the schedule criteria—for example: Recurring, Daily, Run Indefinitely, and from the current time for 30 days.

Once you schedule a job, the job information can only be edited from the Job Manager by choosing Tools > Schedule Job from the Vision client main menu. You can also rerun the job and clone the job using the Job Manager.

Sending a Report Through E-mail Notification

To send a report, you can enter the e-mail notification criteria in the Create Report window. If e-mail notification details are provided, you can run the report and automatically the report is mailed as an attachment in a desired format. You can attach reports in the XML, PDF, CSV, XLS, or HTML format.

To enter criteria and send a report through e-mail notification:

Step 1 Select Reports > Report Manager. I n the Reports Manager window, expand either one of the Events Reports, Inventory Reports, or Network Service Reports node.

Note You can also create and send a report by using the following navigation path:
Select Reports >Run Report >Events Reports > click a report
Select Reports >Run Report >Inventory Reports > click a report.
Select Reports >Run Report >Network Service Reports > click a report.

Step 2 Choose a report > right-click a selected report > click Run. The Create Report page appears.

Figure 5-1 E-mail Notification Tab

Step 3 Click the E-Mail Notifications tab, enter a valid Email Servers, To-Address, From-Address (es), and Subject details.

Note If you have configured the Email Server and From Address in the Global Report Settings then those details will be displayed by default.

Step 4 From the Attach results as drop-down list, choose a report format to attach in an email.

Step 5 Click OK to create a report and to send the report as an attachment.

Saving Reports

Use the Prime Network Report Manager to specify a report format (default format is XML) and save all reports in the path specified by you as soon as the reports are generated. You can also change the save location while generating a report. The following actions are also available:

• View the saved report location path on the Save Report tab in the Create Report window for all reports.
• Check AVM 11 logs if report is not saved in the provided location.
• If you save two reports with the same name in the same location, and completing on the same time it will override the other one.

Note If you want to purge reports you must do it manually.

Prerequisites

• The location for saving reports must be created.
• Read-write permission must be enabled before generating reports.

This example shows how to save a report.

---

Step 1 Select Reports > Report Manager. I n the Reports Manager window, expand either one of the Events Reports, Inventory Reports, or Network Service Reports node.

Step 2 Choose a report > right-click a selected report > click Run. The Create Report page appears.

 

Step 3 In the Create Report window, on the General tab, enter the required information:

• Report Settings

– Name— Specify the name of the report.

– Description—Enter the description of the report.

– Report Security—Click the Private or Public radio button to set the security.

• Date Selection— Last 1 days
• Device Selection— Select Devices or All Devices

---

Note You can also click Add to add a network element to create a report.

---

• Filter Events/Tickets By Severity— Critical
• Filter Events—Click the Syslogs or Traps or All radio button
• Additional Report Specifications—Enter the additional description, if required.
• On the Scheduling tab, enter the required information:

– Run Now—Click the radio button to run the report

– Schedule Job—Click the radio to specify all job criteria.

• On the E-mail Notifications tab, enter the required information.
• On the Save Report tab, in the Save reports upon completion field the location path that you have specified in the Report Manager window is displayed. You can modify the path if required.

 

– From the Save report as drop-down list, choose a format to generate and save the report.

Step 4 Click OK, t o generate and save a report in the desired format.

In the Reports Manager window, the created report details with the save location is displayed.

In the Location field, either one of the following detail is displayed:

• The location of the report saved when the provided location is available and if it has read/write permission
• NA— Displayed as “NA” when save report option is disabled
• Saving failed:Path not exists—Displayed as “Saving failed:Path not exists” when the location path does not exists and when the location provided does not exist.
• Saving Failed Permission denied —Displayed as “Saving failed: Permission Denied” when the location exist and it does not have write permission.

---

 

---