The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Book Contents Book ContentsCisco Prime Performance Manager User Guide, 1.7
The Cisco Prime Performance Manager web interface is the primary method for displaying network reports and managing network devices and information. The following topics tell you how to launch the Prime Performance Manager web interface and customize web interface display and polling:
The Prime Performance Manager web interface requires one of the following web browsers with JavaScript enabled:
Note Microsoft Internet Explorer 8.0 is not supported. Later IE versions have not been formally tested, but should work in most cases.
Note Later Firefox versions have not been formally tested, but should work in most cases.
In addition, your browser must have cookies enabled. If cookies are not enabled, enable them following procedures appropriate for your browser.
Note If you open Cisco Prime Performance Manager in an unsupported browser, a warning is displayed. If the browser does not have JavaScript enabled, the Prime Performance Manager web interface cannot function.
To access the Cisco Prime Performance Manager web interface:
Step 1 Enter the following in the browser URL field:
http://ppm-server:4440
Where ppm-server is the name of the server where Prime Performance Manager is installed and Port 4440 is the default port.
Note If SSL is enabled, use https instead of http. For information, see Enabling SSL on Gateways and Units and ppm ssl.
Note If you connect the gateway with its literal IPv6 address, enclose the address with brackets, for example, http://[2011::2:21b:78ff:febd:9e16]:4440.
Step 2 If user access is enabled (see Setting Up User Access and Security), the Prime Performance Manager login screen appears. The screen displays:
Step 3 After you enter your username and password, click Log In.
The Cisco Prime Performance Manager GUI application launches. By default, the Performance Reports View Editor is displayed (Figure 3-1). The View Editor allows you to create custom views with report data pulled from different reports and devices. It allows you to view the network performance areas that are of special interest. For more information, see Creating and Managing Custom Report Views.
The GUI window is comprised of the following elements:
Note The System and Administration menus are only displayed for Administrator users.
– Getting Started—Displayed for Administrator users, the popup window provides links to administration, network, and reports areas. The Quick Start appears at startup, but can be turned off by checking Do not show this on startup. Getting Started can be displayed at any time by clicking the flag tool.
– User Preferences—Allows users to customize Prime Performance Manager display. For information, see Customizing the GUI and Information Display.
– Refresh—Refreshes the currently-displayed window.
– Send Announcement—Allows you to send messsages to online users. For information, see Sending Announcements to Online Users.
– Page Help—Displays the online help topic for the currently-displayed window.
– Device Browser—Lists all network devices and allows you to perform actions on them. The window contains a subset of properties that are displayed when you choose Network > Devices. For information, see Displaying Device Properties at the Network Level.
– Alarm Browser—Lists all network alarms by the occurrence date and time. The browser contains the same information that is displayed when you choose Network > Alarms/Events. For information, see Displaying Alarm and Event Properties.
– Alarm Summary—Shows the number of alarms by device. This window is intended as a quick reference. The number of alarms displayed corresponds to the device history limit user preference. For information, see Customizing the GUI and Information Display.
The Device and Alarm Browser and the Alarm Summary appear whenever you move your cursor over them. You can turn off this feature. For information, see Customizing the GUI and Information Display.
Figure 3-1 Prime Performance Manager Window
Performance Reports search field
Performance Reports navigation area
Information about Prime Performance Manager
Context help tool
Table 3-1 lists the Prime Performance Manager navigation menus and submenus, and provides topics where more information about the menu function is provided.
Table 3-1 Navigation Menus
Polling Group Editor
Report Mail Editor
Web Report Editor
Prime Central Integration
Prime Network Integration
Prime Network Services Controller Integration
OpenStack Tenant Integration
Report Custom Aging
The Help menu provides in-depth information about Prime Performance Manager reports and commands, and other application details that can be useful for those seeking a deeper understanding of Prime Performance Manager. Help menu items include:
– README—Describes Prime Performance Manager system requirements and installation procedures.
– CHANGES—Lists the changes, bug fixes, and new features in the 1.7 release.
– Devices Info—Displays a list of devices that have been used with Prime Performance Manager by customers and in labs.
– Collectors Info—Provides a list of supported data collectors.
– CLI Commands—A summary list of Prime Performance Manager commands.
– CLI Commands Help—More detailed command information from the Prime Performance Manager online help.
– Release Notes—Displays system release note information.
– Quick Start—Displays quick start steps to help you get up and running quickly.
– Reports XML Definitions—Provides the XML, properties, and notes for Prime Performance Manager reports.
– System Reports Readme—Displays the contents of README-Reports-system.html. This file contains report information including the MIB variables Prime Performance Manager polls, the formulas used in metric calculations, the format of CSV export files, and other report details.
– User Reports Readme—Displays contents of README-Reports-user.html. This file contains user-created report information including the MIB variables polls, the formulas used in metric calculations, the format of CSV export files, and other report information.
– Reports List Readme—Displays an alphabetical list of all Prime Performance Manager reports.
– IETF RFCs—Provides links to industry-standard RFCs supported by Prime Performance Manager.
– SNMP MIBs—Provides the SNMP MIBs supported by Prime Performance Manager.
– System Capability Definitions—Displays the SystemCapability.xml file (located in /opt/CSCOppm-gw/etc/), which defines the Prime Performance Manager system capabilities used for enabling and disabling reports.
– User Capability Definitions—Displays the UserCapability.xml file (located in /opt/CSCOppm-gw/etc/), which defines any user-created report functions.
– Threshold API Parameters—Threshold API parameters for REST report users who want to create TCAs based on REST report data. Each report (including dashboard reports) includes the reportKey and kpiReport threshold parameters. The following metadata is added for each column: dataType plus the threshold parameters, columnName and kpiName. (The last two are empty for non-thresholdable columns.) You can also run a script on specific files and folders to generate a list of API parameters and thresholdable columns. For information, see the Cisco Prime Performance Manager 1.7 Integration Developer Guide ,
– REST API Documentation—Displays REST API methods that can be used to retrieve Prime Performance Manager reports.
After you display the Prime Performance Manager web interface, you can check your web browser and screen settings:
Step 1 From the Help menu, choose Browser Check.
Step 2 Review the browser information:
Includes Dojo and XWT Version. This internal data is used by Cisco TAC for customer support.
Prime Performance Manager provides many options that allow you to change the information that is displayed and how it is displayed in the Prime Performance Manager GUI. These options help you tailor the GUI to your individual needs and preferences.
User preferences apply only to the individual user. However, user preferences can be saved to the Prime Performance Manager gateway and made available for use by any user. How user preferences are applied depend upon whether the gateway has user security enabled:
To customize the Prime Performance Manager GUI and information display:
Step 1 On the right side of the main menu bar, click User Preferences. (If user security is enabled, you can also choose User Preferences from the user ID at the top of the window.)
Step 2 In the User Preferences window, user preferences are accessed through the Device Display, General Display, Graph Color, Report, Utilization Color, and Graph tabs described in the following sections:
Device Display Preferences
Indicates how devices are identified in the Prime Performance Manager GUI:
– The device time zone provided when the device is imported from Prime Network, or by querying the device running configuration. If this option is not enabled, device times are displayed in gateway server time zone.
– None turns off this feature.
– Mouse Hover Details Popup displays device information as a popup when you move your cursor over the device link.
– Mouse Click 360 Device View displays the 360 Network Device View window. This window includes detailed device information including alarms, events, availability, collector status, and polling information. For information on the 360 Network Device View window, see Displaying the 360 Device Details View.
General Display Preferences
– Month: m, M, mm, MM, mmm, MMM, mmmm, MMMM (for example 6, 06, Jun, June)
– Day: d or dd (for example, 5 or 05)
– Year: yy or yyyy (for example, 14 or 2014)
– Upper and lower case are accepted. You can use a slash (/), dot (.), dash (-), or space as separators.
– All—Displays all reports, not just tenant reports.
– All Tenants—Displays all tenant reports.
– SELECTED—Allows you to select and display reports for individual tenants.
– Name (internal tenant name)
For information about managing multi-tenancy in Prime Performance Manager, see Chapter16, “Managing Multi-Tenant Services”
Graph Color Preferences
Allows you to edit the colors used in report and group graphs, as well as:
Fifty colors are available. To edit a color, you can edit the color hex # directly in the color sample, or click the Color Picker to the right of the color sample. In the Color Picker dialog box, edit any of the following attributes:
Alternatively, you can pick colors visually from any of the three color selection areas; the HSV, RGB, hex values will populate automatically. The new and existing colors are displayed side-by-side. Click OK when you complete your edits.
Note The default colors are web-safe and selected to provide the highest differentiation on report charts. If you edit them, verify that they meet web requirements and do not reduce data differentiation on reports. To return to the default colors, click Revert to Default Colors.
– Min—The report minimum value,
– Min Date—The date the report minimum value was reached,
– Avg—The average report value,
Note If the Avg value is enabled, an Average [data value] As% is displayed for certain reports, for example NetFlow reports. Average As% is the percentage of the total of all data averages for all data series. In other words, add all the averages for all data series and then divide the average for this specific data series by the sum of all averages for all data series. For example, if the report shows the input for multiple interfaces, this value shows how the average of one interface compares to the average of the others.
– Max—The report maximum value,
– Max Date—The date the report maximum value was reached,
– Total—The total of all data points for that line item. For example, in an hourly report with 5-minute polling, Total represents the sum of 12 data points.
Note Total is only meaningful if the data series is a numeric.
– Std Dev—Is the standard deviation for that data series, that is, a measurement of how spread out the data series values are. A low value indicates that the data points tend to be very close to the mean; a high value indicates that the data points are spread out over a large range of values. Standard deviation is the square root of the variance.
– Variance— Is the data series variance, that is, the mean of the squares of individual differences from the mean of the data series.
– Current—The current report value.
Min Date, Avg, Max, and Max Date are enabled by default.
Utilization Color Preferences
Allow you to define the ascending and descending utilization ranges to assign to green, gold, orange and red colors in report charts to make utilization values in various states of criticality easier to distinguish. Default values:
– On—Turns on the utilization colors for text.
– Off—Turns off the utilization colors for text.
– Red/Orange/Gold Only—Turns on utilization colors for text only red, gold, and orange colors.
– Reports—Turns on the utilization colors for report chart table cells.
– Dashboards/Views—Turns on the utilization colors for dashboard and view chart table cells.
– Both—Turns on utilization colors for reports, dashboards, and view chart table cells.
– Off—Turns off utilization colors for chart backgrounds.
Change display options in report, dashboard, and view graphs:
Allows you to save user preferences to the Prime Performance Manager gateway where they can be loaded by other users. See Saving and Loading User Preferences.
Step 3 After you complete your changes, return to the previous Prime Performance Manager window.
Step 4 To view the new preferences, click Reload Report on the report toolbar (if a report is displayed), or click Reload Page on the main toolbar at the top of the Prime Performance Manager window.
After modifying user preferences, you can save them to the Prime Performance Manager gateway where they can be loaded by other Prime Performance Manager users.
To save your modified user preferences:
Step 1 On the right side of the main menu bar, click Preferences. (If user security is enabled, you can also choose User Preferences from the user ID at the top of the window.)
Step 2 In the User Preferences window, click Load/Save.
Step 3 In the Load/Save Preferences window, click Save Current Preferences to Gateway.
Step 4 In the Save User Preferences to Gateway dialog box, choose the preference groups you want to save:
Step 5 Enter a file name. File names can be any alphanumeric character including spaces, underscores, and hyphens. Special characters are not allowed.
Step 6 Click OK.
The file is displayed in Load/Save Preferences table.
Note Saved user preferences cannot be edited or deleted.
To load a saved user preferences file:
Step 1 On the right side of the main menu bar, click Preferences.
Step 2 In the User Preferences window, click Load/Save.
Step 3 In the list of preferences, select the preference file you want to load, then click Load Selected Preferences.
The new preferences are loaded and will take effect immediately.
Information in the Prime Performance Manager GUI is generally presented in tables, including summary tables, report tables, and editors. You can customize the number of table entries using the Page Size field. This field is located in the toolbar of every page allowing customization.
Prime Performance Manager retains your entry for each table. For example, you can set the page size for the Devices window to 400 if you prefer to see all device data at one time, and set the page size for SNMP Editor to 25, if you want that screen to load quickly instead of seeing a large volume of data at once.
Page size values are maintained across user sessions.
Table 3-2 shows the Prime Performance Manager windows where you can adjust the page size.
Note The Page Size field maximum is controlled by the Maximum Rows for Table Pages in the Administration Configuration Settings window. For information, see Changing System Configuration Settings.
Table 3-2 Windows Affected by the Page Size Preference