Prime Performance Manager Commands
Prime Performance Manager provides commands that allow you to perform functions from the command line interface. Many command functions can also be performed in the Prime Performance Manager GUI, but many others, particularly administrative or root user functions, can only be performed in the CLI. Commands can be run on Solaris and Linux. Some commands can be performed on both the gateway and unit, others on only the gateway or only the unit. You run commands from:
install_directory/bin
where install_directory is the directory where Prime Performance Manager is installed (by default, /opt/CSCOppm-gw or /opt/CSCOppm-unit)
Alternatively, if install_directory/bin is in your path, you can run commands from your path.
By default, all Prime Performance Manager commands require Superuser privilege with the exception of commands requiring root user privilege listed in Table B-1 . The root user can run any Prime Performance Manager command. If you use the ppm superuser command to set Prime Performance Manager to run under a user ID other than root, all commands other than ones requiring root user privilege, can be run under that user ID.
Table B-1 Root User, Super User, and All User Commands
Commands Requiring Root User Privilege
|
Commands Requiring Root /Super User Privilege
|
Commands Available to all Users
|
- ppm uninstall
- ppm superuser
|
- ppm authtype
- ppm backup
- ppm backupdir
- ppm checksystem
- ppm certtool
- ppm datadir
- ppm devcachedir
- ppm dbbackupdir
- ppm evilstop
- ppm genkey
- ppm jspport
- ppm keytool
- ppm logdir
- ppm msglogdir (ppm logdir and ppm msglogdir perform the same action.)
- ppm netflowport
- ppm ramdisksize
- ppm reboot
- ppm reportdir
- ppm repdir
- ppm restore
- ppm rpm
- ppm restoreprops
|
- ppm threshcachedir
- ppm reportdir (same as ppm repair)
- ppm shutdown
- ppm setpath (when setting path for another user)
- ppm ssl
- ppm syncusers
- ppm tac
- ppm uaenable
- ppm uadisable
- ppm webport
|
- ppm help
- ppm sechelp
- ppm rephelp
- ppm status
- ppm version
- ppm readme
- ppm quickstart
- ppm relnotes
- ppm osinfo
- ppm changes
- ppm localhacommands
- ppm msglog
- ppm netlog
- ppm rootvars
- ppm rephelp
- ppm backupstats
- ppm setpath
- ppm starbuild
- ppm sslver
- ppm javaver
- ppm logger
- ppm pmess
- ppm statreps
- ppm csvstats
- ppm setpath (when setting path for user running CLI)
|
A quick reference of commands organized in functional groups is available from the Prime Performance Manager GUI. To view them, from the Help menu choose Readmes and CLI Commands > PPM Commands.
Prime Performance Manager commands in alphabetical order are described in the following topics:
Prime Performance Manager
Command Description
Displays the command syntax for the Prime Performance Manager command and all of its options. The function of this command is identical to /opt/CSCOppm-gw/bin/ppm help.
Prime Performance Manager help is network specific, so only the commands pertaining to each network type appear. If you set all network types, you can see all the commands.
Available in GUI
No
Related Topic
Chapter 3, “Managing the Web Interface”
ppm addcreds
Syntax
/opt/CSCOppm-gw/bin/ppm addcreds -i ipaddress/hostname [ -u user name -n enable_username ] [ -r protocoltype ] [ -o port ] [ -s sub_system ]
Command Description
Adds the Telnet and SSH credentials to access the device with the given IP address or hostname.
- -i ipaddress —The device IP address or hostname.
- -u username —The username to log into the device.
- -n enable_username —Enables the privileged username.
- -r protocoltype —Indicates the protocol type: Telnet, SSHv1, SSHv2, WSMA over SSHv2, AVI_HTTPS.
- [ -o port ] —The port number used to access the device.
- [ -s sub_system ]— The subsystem used by transport protocol if a subsystem is defined on the device
Available in GUI
Yes
ppm addsnmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm addsnmpcomm -i ipaddress -c read community | -u snmpv3 username [ -a authentication protocol | -A authentication password ] [ -x privacy protocol | -X privacy password ] [ -v 1 |2c | 3 ]
Command Description
Adds an SNMP configuration to Prime Performance Manager server.
- -i ipaddress —The IP address of the device (required)
- -c read community —The SNMP read community. Read community is required for SNMP v1 and 2c.
- -u snmpv3 username —The SNMP username. The username is required for SNMP v3.
- -a authentication protocol —The authentication protocol.
- -A authentication password —The authentication password.
- -x privacy protocol —The privacy protocol.
- -X privacy password —The privacy password.
- -v version —The SNMP version, 1, 2c, or 3. The default is 2c.
- -c community —The read community string of the device (required)
You do not need to restart Prime Performance Manager server.
Available in GUI
Yes
Related Topic
ppm addunitconf
Syntax
/opt/CSCOppm-gw/bin/ppm addunitconf {-i ipaddress | -u unitname}
Command Description
Command uses the option -i (ipaddress) and -u (unitname) to add a unit configuration.
Available in GUI
Yes
ppm adduser
Syntax
/opt/CSCOppm-gw/bin/ppm adduser [-n username [1 | 3 | 5 | 11 | 12] [-f filename ]
Command Description
If you enable Prime Performance Manager User-Based Access, adds the specified user(s) to the authentication list.
Options
- -n username —Adds the specified user with the default password, ppm124A@ and the specified authentication level:
– 1 —Basic User
– 3 —Network Operator
– 5 —System Administrator
– 11—Custom Level 1
– 12—Custom Level 2
- -f filename —Adds a group of users with the default password, ppm124A@. Format: userID]:[acessLevel
Default password for users created using this command is ppm124A@. You can change thisin "/opt/CSCOppm-gw/properties/System.properties.
You must log in as the root/super user to use this command.
Note If you enable Solaris authentication, you must log in as the root user, to use this command (see User Authentication).
Available in GUI
Yes
Related Topics
ppm alarmwarning
Syntax
/opt/CSCOppm-gw/bin/ppm alarmwarning {enable | disable}
Command Description
Allows you to define warning and informational threshold alarms.
Available in GUI
Yes
Related Topic
ppm allowgiantnames
Syntax
/opt/CSCOppm-gw/bin/ppm allowgiantnames {enable | disable | status}
Command Description
Allows custom names for nodes or devices to be up to 255 characters. By default, the limit is 100 characters.
- enable—Enables giant names and allows custom names for devices to be up to 255 characters.
- disable—Disables giant names and reduces the length for custom names to 100 characters.
- status—Displays the status of the giant names option, either enabled or disabled.
Available in GUI
No
ppm apdiff
Syntax
/opt/CSCOppm-gw/bin/ppm apdiff [ oldcsv ] [ newcsv ]
Command Description
Finds the differences between an older AP CSV file and a new AP CSV file. Both files must be in the Prime Performance Manager installation directory.
Available in GUI
No
ppm apgenxml
Syntax
/opt/CSCOppm-gw/bin/ppm apdiff
Command Description
Generates an AP XML file.
Available in GUI
No
ppm authtype
Syntax
/opt/CSCOppm-gw/bin/ppm authtype [ local | solaris | linux ]
Command Description
Configures Prime Performance Manager security authentication:
- local —Allows you to create user accounts and passwords that are local to the Prime Performance Manager system. When using this method, you manage usernames, passwords, and access levels by using Prime Performance Manager commands.
- solaris —Uses standard Solaris-based user accounts and passwords, as the /etc/nsswitch.conf file specifies. You can provide authentication with the local /etc/passwd file. You can do this:
– From a distributed Network Information Services (NIS) system
Or
– With any other authentication tool, such as RADIUS or TACACS+.
- linux —Uses standard Linux-based user accounts and passwords, as the /etc/nsswitch.conf file specifies. You can provide authentication with the local /etc/passwd file; from a distributed NIS system; or with any other authentication tool, such as RADIUS or TACACS+.
Note When using the Solaris or Linux options, if you have enabled user access, you must enable SSL (see Managing Users and User Security to ensure secure passwords between Prime Performance Manager client and server.)
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topics
ppm backup
Syntax
/opt/CSCOppm-gw/bin/ppm backup [ gw | unit | both ]
Command Description
Note Because backups can be large, verify that your file system has enough space to handle the backups.
Backs up Prime Performance Manager data files to Prime Performance Manager installation directory. Prime Performance Manager automatically backs up all data files nightly at 2:30 AM for the unit and 3:30 AM for the gateway. However, you can use this command to back up the files at any other time. If you installed Prime Performance Manager in the default directory ( /opt) the locations of the backup files are /ppm10-$SERVERTYPE-$SERVERNAME-backup.tar, where $SERVERTYPE = gateway or unit as appropriate and $SERVERNAME = the name of the server as specified during installation.
If you installed Prime Performance Manager in a different directory, the backup files reside in that directory.
Command options allow you to choose whether to back up the gateway, unit, or both:
- gw—Backs up the gateway.
- unit—Backs up the unit.
- both—Backs up the gateway and unit.
To restore Prime Performance Manager data files from the previous night’s backup, use /opt/CSCOppm-gw/bin/ppm restore command. Do not try to extract the backup files manually.
You must log in as the root/super user to use this command. If the super user is running the backup command, then the backup directory must be changed before running the command to the super user’s home directory or any other directory for which the super user has write access.
Note Prime Performance Manager performs a database integrity check during the backup. If the check fails, the previous backup is not overwritten. Instead, Prime Performance Manager creates a new failed file (for example: ppm10-gateway-ems-lnx001-backup-failed.tar).
Available in GUI
No
Related Topics
ppm backupdata
Syntax
/opt/CSCOppm-gw/bin/ppm backupdata [ enable | disable | status ] [ gw | unit | both ]
Command Description
This command enables and disables the backup of the Prime Performance Manager database. You must log in as the root/super user to use this command. Command options allow you to choose whether to back up the gateway, unit, or both:
- gw—Backs up the gateway.
- unit—Backs up the unit.
- both—Backs up the gateway and unit.
Available in GUI
Yes
ppm backupdays
Syntax
/opt/CSCOppm-gw/bin/ppm backupdays [ days ] [ gw | unit | both ]
Command Description
This command sets the number of days to save backup files on Prime Performance Manager server and client. The default value is one day, but you can configure Prime Performance Manager to save multiple days of backup files.
Command options allow you to choose whether to back up the gateway, unit, or both:
- gw—Backs up the gateway.
- unit—Backs up the unit.
- both—Backs up the gateway and unit.
This command accepts values from 1 to 30 days. If you attempt to set a value outside of this range, Prime Performance Manager responds with this message:
Value out of range of 1-30.
Prime Performance Manager stores backup files in the backup directory (see ppm backupdir). Prime Performance Manager uses this file naming convention when there are multiple backup files:
ppm< releasenumber> - [gateway|unit]-backup.tar.[ date ]
For example:
ppm10-gateway-ems-lnx001-backup.tar[ date ]
ppm10-unit-ems-lnx001-backup.tar[ date ]
If the number of backup days is more than one, and you run the /opt/CSCOppm-gw/bin/ppm restore command, Prime Performance Manager prompts you for a server or client backup file to restore from. This is because there would be more than one backup file to choose from). See ppm restore.
The following is an example of setting the number of backup days to five days:
Enter number of days to save backup files <1-30>: [1] 5
Setting number of days to save backup files to 5 days.
In this example, Prime Performance Manager saves backup files for the last five days. Prime Performance Manager deletes backup files that are older than five days.
Note If you notice multiple backups, ensure that there is enough free space in the backupdir file system (see ppm backupdir).
Available in GUI
Yes
Related Topics
ppm backupuncheckeddata
Syntax
/opt/CSCOppm-gw/bin/ppm backupuncheckeddata [ enable | disable | status ] [ gw | unit | both ]
Command Description
Enables or disables the inclusion of unverified data in the Prime Performance Manager database backup tar files. Prime Performance Manager daily backups maintain a snapshot directory of the database with data integrity under the backup directory. The snapshot directory is updated each day using incremental data backups. The directory is then included in the main backup tar file as long as the backupdata function (see ppm backupdata) is enabled. (If the backupdata option is disabled the backupuncheckeddata option has no impact.)
In the event the snapshot directory of the database cannot be written to during backup, backupuncheckeddata controls whether the backup should include the main database files directly from their source directory. If backups occur while the server is running, inconsistent data could be included in the backup, which could lead to issues during a restore from this backup.
If you do not wish to include data from the main database files while running backups during this condition, disable this option. If the Prime Performance Manager backup directory never becomes full or experiences other access issues, enabling backupuncheckeddata will have no impact.
Command options:
- enable—Enables the backup of unchecked Prime Performance Manager data.
- disable—Disables the backup of unchecked Prime Performance Manager data.
- gw—Enables or disables the unchecked data backups for the gateway.
- unit—Enables or disables the unchecked data backups for the unit.
- both—Enables or disables the unchecked data backups for the gateway and unit.
Note The backupuncheckeddata option requires the backupdata option to be enabled. For information, see ppm backupdata.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm backupminfree
Syntax
/opt/CSCOppm-gw/bin/ppm backupminfree [ gw | unit | both ] MB
Command Description
Sets the minimum available space, in megabytes that must be available before a backup is started. Options include:
- gw—Sets the minumum space for the gateway.
- unit—Sets the minumum space for the unit.
- both—Sets the minumum space for the gateway and unit.
Available in GUI
Yes
ppm backupdir
Syntax
/opt/CSCOppm-gw/bin/ppm backupdir [ directory ] [ gw | unit | both ]
Command Description
Note You must stop Prime Performance Manager server before performing this command. You are prompted whether you want to continue.
Command options allow you to choose whether to back up the gateway, unit, or both:
- gw—Backs up the gateway.
- unit—Backs up the unit.
- both—Backs up the gateway and unit.
You can change the directory in which Prime Performance Manager stores its nightly backup files. The default backup directory is the directory in which Prime Performance Manager is installed. If you installed Prime Performance Manager in:
- The default directory, /opt, then the default backup directory is also /opt.
- A different directory, then the default backup directory is that directory.
If you specify a new directory that does not exist, Prime Performance Manager does not change the directory and issues an appropriate message.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topics
ppm backuplog
Syntax
/opt/CSCOppm-gw/bin/ppm backuplog [ clear | -r ]
Command Description
Uses PAGER to display the contents of the system backup log.
To clear the log, enter /opt/CSCOppm-gw/bin/ppm backuplog clear.
To display the contents of the log in reverse order, with the most recent commands at the beginning of
the log, enter /opt/CSCOppm-gw/bin/ppm backuplog -r.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm backuplogs
Syntax
/opt/CSCOppm-gw/bin/ ppm backuplogs [enable|disable|status] [ gw | unit | both ]
Command Description
Determines whether to include logs in backups or not.
Command options allow you to choose whether to back up the gateway, unit, or both:
- gw—Backs up the gateway.
- unit—Backs up the unit.
- both—Backs up the gateway and unit.
If this command is enabled, logs are included in backups. If this command is not enabled, then log files backup are not included. The status option tells whether this command is enabled or not and the gw/unit/both options indicate whether this applies only to gateway backups, unit backups, or both.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm backuprep
Syntax
/opt/CSCOppm-gw/bin/ppm backuprep [ enable | disable | status ]
Command Description
This command enables and disables the backup of the Prime Performance Manager reports. You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm backuprestorescript
Syntax
/opt/CSCOppm-gw/bin/ppm backuprestorescript [ path | clear ]
Command Description
This command calls a script before and after a backup or restore occurs. You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm backupstats
Syntax
/opt/CSCOppm-gw/bin/ppm backupstats
Command Description
This command displays statistics on backup process. You must log in as the root/super user to use this command.
Available in GUI
No
ppm badloginalarm
Syntax
/opt/CSCOppm-gw/bin/ppm badloginalarm [ tries | clear ]
Command Description
Number of unsuccessful log-in attempts allowed before Prime Performance Manager generates an alarm.
There can be an unlimited number of unsuccessful attempts. The default value is five unsuccessful attempts.
Prime Performance Manager records alarms in the system security log file. The default path and filename for the system security log file is /opt/CSCOppm-gw/logs/sgmSecurityLog.txt. If you installed Prime Performance Manager in a directory other than /opt, then the system security log file resides in that directory.
To view the system security log file, enter /opt/CSCOppm-gw/bin/ppm seclog. You can also view the system security log on Prime Performance Manager System Security Log web page (see Displaying the System Security Log).
To disable this function (that is, to prevent Prime Performance Manager from automatically generating an alarm after unsuccessful log-in attempts), enter /opt/CSCOppm-gw/bin/ppm badloginalarm clear.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Editing User Security Settings
ppm badlogindisable
Syntax
/opt/CSCOppm-gw/bin/ppm badlogindisable [ tries | clear ]
Command Description
Number of unsuccessful log-in attempts by a user allowed before Prime Performance Manager disables the user’s authentication. To re-enable the user’s authentication, use /opt/CSCOppm-gw/bin/ppm enableuser command.
There can be an unlimited number of unsuccessful attempts. The default value is 10 unsuccessful attempts.
To disable this function (that is, to prevent Prime Performance Manager from automatically disabling a user’s authentication after unsuccessful log-in attempts), enter /opt/CSCOppm-gw/bin/ppm badlogindisable clear.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Editing User Security Settings
ppm buildstarconfig
Syntax
/opt/CSCOppm-gw/bin/ppm buildstarconfig [{ schemafilename | default } ppm | no | zero ]
Command Description
Sets up bulk statistics reporting configurations for Cisco ASR 5000 and Cisco ASR 5500 devices.
- schemafilename—The schema file name containing the bulk statistics schema you want to use
- default—Generates a configuration for all counters and all schemas supported by Prime Performance Manager. The default file is:
/opt/CSCOppm-gw/install/ASR5K_BulkStats_StarOS_Schema_Counters.csv
- ppm —Creates the configuration file to enable the Cisco ASR 5000 and Cisco ASR 5500 device to generates bulk statistics in the format expected by Prime Performance Manager.
- no —Removes the device configuration.
- zero —Sets the configuration to zero.
Available in GUI
No
ppm bulkstatsage
Syntax
/opt/CSCOppm-gw/bin/ppm bulkstatsage [ days ]
Command Description
Specifies the number of days bulk statistic files are retained. The default is 14 days. You do not need to restart Prime Performance Manager server. (This command is supported only on the gateway.)
Available in GUI
Yes
ppm bulkstatver
Syntax
/opt/CSCOppm-gw/bin/ppm bulkstatver
Command Description
Prints the StarOS BulkStat version.
Available in GUI
No
ppm certtool
Syntax
/opt/CSCOppm-gw/bin/ppm certtool [ clear | delete alias | export alias [ -file filename ] | import alias [ -file filename ] | list ]
Command Description
If you enable the Secure Sockets Layer (SSL) icon your Prime Performance Manager system, you can use this command to manage SSL certificates on Prime Performance Manager web interface from the command line.
Note If you installed Prime Performance Manager server gateway and unit on the same workstation, running this command is not necessary. Instead, when you use the ppm keytool command (see ppm keytool) to manage SSL certificates on the server, Prime Performance Manager automatically manages the certificates on the web interface.
Use these keywords and arguments with this command:
- import alias [ -file filename ]—Imports a signed SSL certificate in X.509 format. This is the most common use for this command.
The alias argument can be any character string; the hostname of the server from which you are importing the certificate is a good choice.
To import the certificate from a file, specify the optional -file keyword and a filename.
- export alias [ -file filename ]—Exports the specified SSL certificate in X.509 format.
To export the certificate to a file, specify the optional -file keyword and a filename.
- list —Lists all SSL certificates on Prime Performance Manager.
- delete alias —Removes the specified SSL certificate from Prime Performance Manager.
- clear —Removes all SSL certificates from Prime Performance Manager.
Available in GUI
No
Related Topics
ppm changes
Command Description
Displays the contents of the Prime Performance Manager CHANGES file. The CHANGES file lists all bugs that have been resolved in Prime Performance Manager, sorted by release. If you installed Prime Performance Manager in:
- The default directory, /opt, then Prime Performance Manager CHANGES file resides in the /opt/CSCOppm-gw/install directory.
- A different directory, then the file resides in that directory.
Available in GUI
Yes
ppm checksystem
Command Description
Checks the system for a server installation and reviews the:
- System requirements
- TCP/IP address and port usage checks
- Disk space usage check
- Server summary
- Error summary
You must log in as the root/super user to use all features of this command. The logs/troubleshooting folder has limited permissions to read when the user is not a root user.
Available in GUI
Yes
ppm cleancache
Syntax
/opt/CSCOppm-gw/bin/ppm cleancache [gw |unit | both]
Command Description
- Remove device and TCA cache files:
- gw—Removes device and TCA files from the gateway.
- unit—Removes device and TCA files from the unit.
- both—Removes device and TCA files from the gateway and unit.
Available in GUI
No
ppm clientclocktolerance
Syntax
/opt/CSCOppm-gw/bin/ppm clientclocktolerance [ secs ]
Command Description
Sets the number of seconds timing between Prime Performance Manager and a client can be out of synchronization before an alarm is raised. The default is 900 seconds.
Available in GUI
No
ppm clitimeout
Syntax
/opt/CSCOppm-gw/bin/ppm clitimeout [ mins | clear ]
Command Description
Specifies how long, in minutes, a Prime Performance Manager client can be inactive before Prime Performance Manager automatically disconnects it.
This function is disabled by default. If you do not specify this command, clients are never disconnected as a result of inactivity.
If you enter /opt/CSCOppm-gw/bin/ppm clitimeout command, the valid range is zero (clears the command) to an unlimited number of minutes. No default value exists.
If you enable this function and you want to disable it (that is, never disconnect a client as a result of inactivity), enter /opt/CSCOppm-gw/bin/ppm clitimeout clear command.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Editing User Security Settings
ppm clocktolerance
Syntax
/opt/CSCOppm-gw/bin/ppm clocktolerance [ client | [ device | server ] [ secs ]
Command Description
Sets the number of seconds timing between Prime Performance Manager and a client, device, or server can be out of synchronization before an alarm is raised. The default is 900 seconds.
Available in GUI
No
ppm cmdlog
Syntax
/opt/CSCOppm-gw/bin/ppm cmdlog [ clear | -r ]
Command Description
Uses PAGER to display the contents of the system command log. The system command log lists:
- All ppm commands that were entered for the Prime Performance Manager server.
- The time each command was entered.
- The user who entered the command.
To clear the log, enter ppm cmdlog clear.
To display the contents of the log in reverse order, with the most recent commands at the beginning of the log, enter ppm cmdlog -r.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm compilemibs
Syntax
/opt/CSCOppm-gw/bin/ppm compilemibs
Command Description
Compiles MIB files in the /opt/CSCOppm-gw/etc/mibs folder and generates a compiled output file. During execution the system reports inconsistencies like duplicate variables names, duplicate OIDs and missing dependent MIBs. After it has completed, you are prompted to reload the compiled output to the Prime Performance Manager server.
This command is available only on the gateway.
Available in GUI
No
ppm console
Command Description
Displays the contents of the console log file, sgmConsoleLog.latest.
The console log file contains unexpected error and warning messages from Prime Performance Manager server, such as those that might occur if Prime Performance Manager server cannot start.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm consolelogsize
Syntax
/opt/CSCOppm-gw/bin/ppm consolelogsize [ megs ]
Command Description
Sets the maximum size (in megabytes) of the console log file.
To view help for this command, include the following parameter: -h.
Available in GUI
Yes
ppm countnodes
Command Description
Displays the number of nodes in the current Prime Performance Manager database.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm criticalalarm
Syntax
/opt/CSCOppm-gw/bin/ppm criticalalarm [Critical Alarm]
Command Description
Generates a critical Prime Performance Manager alarm. This alarm is generated on the Prime Performance Manager gateway and will also be forwarded northbound if configured.
Available in GUI
No
ppm crosslaunch
Syntax
/opt/CSCOppm-gw/bin/ppmcrosslaunch [ install | [ hideLegend | hideNavigator | hideDateString | hideButtons | hideTitle ] uninstall ]
Command Description
Installs (or uninstalls) the ability to cross launch Prime Performance Manager from Prime Network. Installation options allow you to hide Prime Performance Manager chart elements when reports are launched from Prime Network:
- hideLegend—Hides the chart legend. Users can normally turn legends on or off using the Toggle Legend tool. This option turns the legend off when launched from Prime Network.
- hideNavigator—Hides the bar that appears at the bottom of charts in full screen or leaf graph mode that lets you scroll to or select a specific area of the chart.
- hideDateString—Hides the report date string that appears at the bottom of charts.
- hideButtons—Hides the Zoom, Graph Style, and Export options that appear within an individual chart.
- hideTitle—Hides the report title and/or subtitle that normally appears inside a chart.
Available in GUI
Yes
ppm csvdropdir
Syntax
/opt/CSCOppm-unit/bin/ppmcsvdropdir [ dir ]
Command Description
Changes the Bulk Statistics Drop directory and updates the CSV_DROP_DIR property in /opt/CSCOppm-unit/properties/BulkStats.properties. The default directory location is /opt/CSCOppm-unit/csvdrop. This command sets a new directory location.
You do not need to restart Prime Performance Manager server.
The command is only supported on units.
Available in GUI
No
ppm datadir
Syntax
/opt/CSCOppm-gw/bin/ppm datadir [ directory ] [ nostart ]
Command Description
Note You must stop Prime Performance Manager server before performing this command. You are prompted whether to continue.
Sets the directory where Prime Performance Manager data files are stored. Use this command if you want to store data files in a different directory; for example, in a Network File System location on another server.
The default data storage directory is in the Prime Performance Manager installation directory. If you installed Prime Performance Manager in /opt, the default directory is /opt/CSCOppm-gw/data. If you installed Prime Performance Manager in a different directory, the default directory is in that directory.
The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm dbbackupdir
Syntax
/opt/CSCOppm-gw/bin/ppmdbbackupdir [ directory ] [ nostart ]
Command Description
Sets the directory used for database backup staging. The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
Available in GUI
No
ppm delete
Syntax
/opt/CSCOppm-gw/bin/ppm delete [ all | node [ all | node [ node ]...] | sp [ all | point-code : net [ point-code : net ]...] | linkset [ all | node / linkset [ node / linkset ]...]
Command Description
Deletes objects from Prime Performance Manager database.
- all —Deletes all objects from Prime Performance Manager database.
- node all —Deletes all nodes from Prime Performance Manager database.
- node node [ node ]...—Deletes one or more nodes from Prime Performance Manager database. Use the node arguments to specify one or more nodes.
- sp all —Deletes all nodes from Prime Performance Manager database.
- sp point-code : net [ point-code : net ]...—Deletes one or more signaling points from Prime Performance Manager database. Use the point-code : net arguments to specify one or more signaling points, which the point code and network name identify; for example, 1.22.0:net0.
- linkset all —Deletes all linksets from Prime Performance Manager database.
- linkset node / linkset [ node / linkset ]...—Deletes one or more linksets from Prime Performance Manager database. Use the node / linkset arguments to specify one or more linksets associated with specific nodes.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm deletecreds
Syntax
/opt/CSCOppm-gw/bin/ppm deletecreds -i [ ipaddress/hostname ] -a
Command Description
Deletes the Telnet and SSH device credentials for the specified device or all credentials on the Prime Performance Manager gateway.
-i ipaddress/hostname —Deletes the Telnet and SSH device credentials for the specified IP address or hostname.
-a —Deletes all Telnet and SSH device credentials on the gateway.
Available in GUI
Yes
ppm deletesnmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm deletesnmpcomm -i ipaddress
Command Description
Deletes an SNMP configuration from Prime Performance Manager server.
-i ipaddress —The IP address of the device (required)
You do not need to restart Prime Performance Manager server.
Available in GUI
Yes
Related Topics
ppm deleteunitconf
Syntax
/opt/CSCOppm-gw/bin/ppm deleteunitconf [-i (ipaddress)]
Command Description
This command deletes the existing configuration that specifies the relationship between nodes and their managed units.
Available in GUI
Yes
ppm deluser
Syntax
/opt/CSCOppm-gw/bin/ppm deluser [ username | filename ]
Command Description
Deletes a user or a list of users. If you enable Prime Performance Manager user-based access, deletes the specified user from the authentication list. To add the user back to the list, use the ppm adduser command. (See ppm adduser.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Manually Disabling Users and Passwords
ppm devcachedir
Syntax
/opt/CSCOppm-gw/bin/ppmdevcachedir [ directory ] [ nostart ]
Command Description
Sets the directory used for device cache files. The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
Available in GUI
No
ppm deviceclocktolerance
Syntax
/opt/CSCOppm-gw/bin/ppm deviceclocktolerance [ secs ]
Command Description
Sets the number of seconds timing between Prime Performance Manager and a device can be out of synchronization before an alarm is raised. The default is 900 seconds.
Available in GUI
No
ppm disablepass
Syntax
/opt/CSCOppm-gw/bin/ppm disablepass [ username | filename ]
Command Description
Disable password for a user or a list of users. If you enable Prime Performance Manager User-Based Access, and set ppm authtype to local, it disables the specified user’s authentication and password. Prime Performance Manager does not delete the user from the authentication list.
Prime Performance Manager only disables the user’s authentication and password. To re-enable the user’s authentication with:
- The same password as before, use /opt/CSCOppm-gw/bin/ppm enableuser command.
- A new password, use /opt/CSCOppm-gw/bin/ppm userpass command.
Note The user can re-enable authentication with a new password by attempting to log in by using the old password; Prime Performance Manager then prompts the user for a new password.
If you set /opt/CSCOppm-gw/bin/ppm authtype to Solaris or Linux, you cannot use this command; instead, you must manage passwords on the external authentication servers.
You must log in as the root/super user to use this command. You must also set /opt/CSCOppm-gw/bin/ppm authtype to local.
Available in GUI
Yes
Related Topic
Manually Disabling Users and Passwords
ppm disablepwdage
Syntax
/opt/CSCOppm-gw/bin/ppm enablepwdage [ username | filename ]
Command Description
Disables password aging for the specified user or a list of users.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
ppm enablepwdage
ppm disableuser
Syntax
/opt/CSCOppm-gw/bin/ppm disableuser [ username | filename ]
Command Description
Disable a user or a list of users. If you enable Prime Performance Manager User-Based Access, this disables the specified user’s authentication. Prime Performance Manager does not delete the user from the authentication list, Prime Performance Manager only disables the user’s authentication. To re-enable the user’s authentication with:
- The same password as before, use the /opt/CSCOppm-gw/bin/ppm enableuser command.
- A new password, use the /opt/CSCOppm-gw/bin/ppm userpass command.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Manually Disabling Users and Passwords
ppm discover
Syntax
/opt/CSCOppm-gw/bin/ppm discover [ seed-node ] [ seed-node ]...
Command Description
You use this command to discover the network from the command line. Use the seed-node arguments to specify the DNS names or IP addresses of one or more seed nodes.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Running Device Discovery
ppm discovertype
Syntax
/opt/CSCOppm-gw/bin/ppm discovertype { seed1 }. [ seed2 ],... [ seedN ] -p { collect1 ], [ collect2 ], [ collectN ]
Normally you use the ppm discover { seed1 } [ seed2 ] [ seedN ] [-p [ collect1... [ collectN ] command to discover a seed set using collector1 > collectorN in a multi-collector context. This process has two steps:
- Configure the polling policy for the seed set so that Prime Performance Manager uses the specified collector to collect data from the devices.
- Discover the specified seed sets and begin regular polling.
However, in some scenarios the modified policy file does not synchronize to the unit in time. As a result, the first poll of the specified seed set fails because the unit does not have the updated polling policy. In this case you can use ppm discovertype to update the polling policy including unit synchronization. You can then run ppm discover to discover the specified seed set based on the latest polling policy.
ppm discoveryrange
Syntax
/opt/CSCOppm-gw/bin/ppm discoveryrange [true | false]
Command Description
You use this command to discover the devices IP address is within the network range.
If this command is true, then devices within address range that are not reachable are deleted from Prime Performance Manager. If this command is false, then the devices that are not reachable during discovery are retained in Prime Performance Manager in an unmanaged state.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm diskcheck
Syntax
/opt/CSCOppm-gw/bin/ppm diskcheck
Command Description
Manually runs the disk space usage check.
You must log in as the root/super user to use this command.
Related Topic
ppm diskmonitor
ppm diskmonitor
Syntax
/opt/CSCOppm-gw/bin/ppm diskmonitor [ enable | disable | status ] | warning { MBs } | critical { MBs } | warnscript { path | clear } | critscript { path | clear } [ gw | unit | both ]
Command Description
Monitors the Prime Performance Manager installed directories disk space usage. When enabled, the diskWatcher.sh script runs every ten minutes to check two thresholds:
- Warning—When the disk space use passes the threshold defined with the warning option, a disk space major alarm is created and logged in the sgmConsoleLog.txt file. For example:
WARNING: The following partition is getting low on free disk space:
The script identified with the warnscript option is executed to begin disk cleanup.
Critical—When the disk space use passes the threshold defined with the critical option, a disk space critical alarm is created and logged in the sgmConsoleLog.txt file. For example:
WARNING: The following partition is getting low on free disk space:
The script identified with the critscript option is executed to begin disk cleanup.
Options:
- enable—Enables the Prime Performance Manager installed directories disk space usage check.
- disable—Disables the Prime Performance Manager installed directories disk space usage check.
- status—Displays the disk monitor status, either enabled or disabled.
- warning {MBs}—Sets the warning threshold. The default is 1000 MB.
- critical {MBs}—Sets the critical threshold. The default is 100 MB.
- warnscript {path | clear}—Provides the path to the script to call when the warning threshold is crossed. The script should initiate disk cleanup. The clear option clears the diskmonitor warning alarm.
- critscript {path | clear }—Provides the path to the script to call when the critical threshold is crossed. The script should initiate disk cleanup. The clear option clears the diskmonitor critical alarm.
- gw—Applies the command actions to the gateway.
- unit—Applies the command actions to the unit.
- both—Applies the command action to both the gateway and unit.
You must log in as the root/super user to use this command.
Available in GUI
- enable, disable, status: Yes
- warnscript, critscript: No
Related Topic
ppm diskcheck
ppm dumpdb
Syntax
/opt/CSCOppm-gw/bin/ppm dumpdb [ directory ]
Command Description
Dumps the current database, incremental, if it exists, to the provided directory. Allows an external process to trigger a database dump to a staging area that could be used by another backup, restore, or archival system.
Available in GUI
No
ppm enablepwdage
Syntax
/opt/CSCOppm-gw/bin/ppm enablepwdage [ username | filename ]
Command Description
Enables password aging for the specified user or a list of users.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topics
ppm enableuser
Syntax
/opt/CSCOppm-gw/bin/ppm enableuser [ username | filename ]
Command Description
Enable a user or a list of users. If you enable Prime Performance Manager user-based access, re-enables the specified user’s authentication, which had been disabled either automatically by Prime Performance Manager root user.
The user’s authentication is re-enabled with the same password as before.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Enabling User Accounts and Passwords Using the CLI
ppm eventautolog
Syntax
/opt/CSCOppm-gw/bin/ppm eventautolog [ clear | -r ]
Command Description
Uses PAGER to display the contents of Prime Performance Manager event automation log. The event automation log lists all messages generated by scripts launched by event automation.
To clear the log and restart the server, enter /opt/CSCOppm-gw/bin/ppm eventautolog clear.
To display the contents of the log in reverse order, with the most recent events at the beginning of the log, enter /opt/CSCOppm-gw/bin/ppm eventautolog -r.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm eventconfig
Syntax
/opt/CSCOppm-gw/bin/ppm eventconfig [ view | edit | restore | master ]
Command Description
Manages the event configuration. Options:
- view —Displays the event configuration file.
- edit —Allows you to edit the event configuration file in your environment with a text editor. (The default text editor is 'vi'.)
- restore —Restore the event configuration file to the last active copy.
- master —Stores the event configuration file to the master copy (the default copy shipped with Prime Performance Manager).
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm eventlimitsconfig
Syntax
/opt/CSCOppm-gw/bin/ppm eventlimitsconfig [ view | edit | restore | master ]
Command Description
Manages the event limits configuration. Options:
- view —Displays the event limits configuration file.
- edit —Allows you to edit the event limits configuration file in your environment with a text editor. (The default text editor is 'vi'.)
- restore —Restore the event limits configuration file to the last active copy.
- master —Stores the event limits configuration file to the master copy (the default copy shipped with Prime Performance Manager).
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm eventsnmpserversconfig
Syntax
/opt/CSCOppm-gw/bin/ppm eventsnmpserverssconfig [ view | edit | restore | master ]
Command Description
Manages the SNMP servers configuration. Options:
- view —Displays the SNMP servers configuration file.
- edit —Allows you to edit the SNMP servers configuration file in your environment with a text editor. (The default text editor is 'vi'.)
- restore —Restore the SNMP servers configuration file to the last active copy.
- master —Stores the SNMP servers configuration file to the master copy (the default copy shipped with Prime Performance Manager).
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm eventtool
Syntax
/opt/CSCOppm-gw/bin/ppm eventtool { -a actionName } { parameters }
Command Description
Invokes Prime Performance Manager event API operations.
These action names (and any corresponding required parameters) can be specified with the -a option:
|
|
|
-a |
acknowledgeEvents |
-l or -L -u -n |
appendNote |
-e -n -u |
changeSeverities |
-s -l or -L -u -n |
clearEvents |
-l or -L -u -n |
deleteEvents |
-l or -L -u -n |
getAllEventsAsTraps |
-t |
getAllOpenAlarmsAsTraps |
-t -H -p -S -h |
getFilteredEventsAsTraps |
-t -f |
getNote |
-e |
setNote |
-e -n -u |
These parameters can be used:
|
|
-e |
Specifies an event ID parameter. |
-f |
Specifies a file name for EventFilter, which is an XML element defined in Prime Performance Manager WSDL definitions. |
-l |
Specifies a file name for EventIDList, which is an XML element defined in Prime Performance Manager WSDL definitions. |
-n |
Specifies an event note string. |
-s |
Specifies an event severity. |
-t |
Specifies a file name for TrapTarget, which is an XML element defined in Prime Performance Manager WSDL definitions. |
-u |
Specifies a user ID for event operation. |
-H |
Specifies a hostname to connect to. If unspecified, the default value is obtained from the Prime Performance Manager server System.properties file, SERVER_NAME property. |
-p |
Specifies a port to connect to. If unspecified, the default value is obtained from the Prime Performance Manager server System.properties file, WEB_PORT property. |
-L |
Specifies a list of event IDs, separated by '|'. |
-S |
Specifies whether to use SSL (https) for NBAPI access. Default is no SSL. |
-h |
Prints help information. |
You must log in as the root/super user to use this command.
Available in GUI
No
ppm evilstop
Command Description
Forcefully stops all Prime Performance Manager servers on the local host.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm export
Syntax
/opt/CSCOppm-gw/bin/ppm export
Command Description
Exports current Prime Performance Manager data.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm exportcustnames
Syntax
/opt/CSCOppm-gw/bin/ppm exportcustnames
Command Description
Allows to export custom names for import to another server.
Available in GUI
Yes
ppm exportusers
Syntax
/opt/CSCOppm-gw/bin/ppm exportusers
Command Description
Allows to export users for import to another server.
Available in GUI
No
ppm extrarunpath
Syntax
/opt/CSCOppm-gw/bin/ppm extrarunpath [ path ]
Command Description
Appends { path } to the run path for alarm scripts. This can be useful when running scripts when TCAs occur. To add multiple directories, separate each directory with a colon, for example:
path1:path2
Available in GUI
No
ppm fastinterval
Syntax
/opt/CSCOppm-gw/bin/ppm fastinterval
Command Description
Displays the interval between slow and fast SNMP polling threads.
Available in GUI
Yes
Related Topics
ppm gatewayname
Syntax
/opt/CSCOppm-gw/bin/ppm gatewayname [ gatewayname ] [nostopstart]
Command Description
Command resets Prime Performance Manager remote unit’s connected gateway name, where gatewayname is the connected gateway’s hostname or IP address.
- Verify that the new gatewayname is connectible. If not, you might not be able to connect to the remote gateway.
- Verify that the unit-side IP protocol is consistent with gatewayname used in the gateway side. See ppm servername.
- You must log in as root/super user to run this command.
- nostopstart—The server is not stopped and started automatically while running this command.
Available in GUI
No
ppm genkey
Syntax
/opt/CSCOppm-gw/bin/ppm genkey [ gw | unit | both | ]
Command Description
Creates SSL keys and certificates. The command provides an easy way to regenerate SSL keys and certificates after the Prime Performance Manager has been running for a while with SSL enabled. This might be needed if a certificate expires or if you have a policy to regenerate the certificates after a period of time. The command is normally used as:
The both option generates new keys and certificates, then exchanges them between gateway and unit automatically so you can regenerate the set of keys and certifications at one time. If you use only the gw or unit option, you must import the certificates to the other side.
Available in GUI
No
ppm getbackuptimes
Syntax
/opt/CSCOppm-gw/bin/ppm getbackuptimes
Command Description
Displays the following Prime Performance Manager and collocated unit (if installed) backup information:
- Last Backup Start—The date and time the gateway backup was started.
- Last Backup Start—The date and time the gateway backup was completed.
- Next Backup Start—The date and time the next gateway backup will begin.
Available in GUI
Yes
ppm grouptool
Syntax
/opt/CSCOppm-gw/bin/ppm grouptool
Command Description
Displays the contents of the add group, delete group, update group and get group information probe details.
- -a—Specifies the type of operation to be performed.
- -l—Specifies a file name for the group.
- -k—Specifies the name for the group.
- -H—Specifies a hostname to connect to. If not specified, default value is obtained from the gateway System.properties file, SERVER_NAME property.
- -p—Specifies a port to connect to. If not specified, default value is obtained from the gateway System.properties file, WEB_PORT property.
- -S—Specifies whether to use SSL (https) for NBAPI access, default is no SSL.
- -h—Print help information.
You must log in as the root/super user to use this command.
ppm grouptool -a addGroup
-l <XML file>
[-H <hostname>]
[-p <port number>]
[-S <y|n>]
[-h <help>]
ppm grouptool -a updateGroup
-l <XML file>
-n <note>
[-H <hostname>]
[-p <port number>]
[-S <y|n>]
[-h <help>]
ppm grouptool -a deleteGroup
-k <groupName>
[-H <hostname>]
[-p <port number>]
[-S <y|n>]
[-h <help>]
ppm grouptool -a getGroupInfo
-k <groupName>
[-H <hostname>]
[-p <port number>]
[-S <y|n>]
[-h <help>]
Available in GUI
Yes
Example of Prime Performance Manager Group File
<ns:Group xmlns:ns="http://cisco.com/ppm">
<matchingAlgorithm>If(Contains(cmStatusName, "online"), true, false)</matchingAlgorithm>
<dateSource>AGG_CMTS_CM_UP_STATE</dateSource>
</GroupProcessingSection>
</ns:Group>
Example Probe.xml file for Command Line Interface
<ns2:Probe xmlns:ns2="http://cisco.com/ppm">
<Value>ppm-lnx-vm012.cisco.com</Value>
<Value>HTTP-Probe-2</Value>
<Property name="Description">
<Value>HTTP Probe 1</Value>
<Property name="Enabled">
<Property name="Interval">
<Property name="OpenTimeout">
<Property name="ResponseTimeout">
<Property name="IPAddress">
<Value>google.com</Value>
<Property name="Username">
<Property name="Password">
<Property name="HttpHeaderFieldTable">
<Property name="HttpRequestMethod">
<Property name="HttpStatusCodeTable">
<Property name="HttpStatusCodeRow">
<Property name="HttpStatusCode">
<Property name="HttpStatusCodeRangeBegin">
<Property name="HttpStatusCodeRangeEnd">
<Property name="Protocol">
<Property name="Application">
<Property name="UrlPath">
<Value>HTTPS://google.com:80/mail</Value>
ppm help
Syntax
/opt/CSCOppm-gw/bin/ppm help [ keyword ]
Command Description
Displays the command syntax for the Prime Performance Manager command and all of its options. The function of this command is identical to Prime Performance Manager.
Prime Performance Manager help is network specific, so only the commands pertaining to each network type appear. If you set all network types, you can see all the commands.
To see the syntax for a specific command, enter /opt/CSCOppm-gw/bin/ppm help and that command. For example, if you enter /opt/CSCOppm-gw/bin/ppm help restart, Prime Performance Manager displays:
ppm restart - Restarts all ppm Servers on the local host.
ppm restart web - Restarts Web servers on the local host.
ppm restart jsp - Restarts JSP servers on the local host.
ppm restart pm - Restarts Process Manager on the local host.
Related Topic
Chapter 3, “Managing the Web Interface”
ppm hypervisor checklibrary
Syntax
/opt/CSCOppm-gw/bin/ppm hypervisor checklibrary
Command Description
Checks the Linux OS library to ensure it contains all RPMs required for Prime Performance Manager to successfully connect to hypervisors. The command will indicate whether the library is complete. If the library is incomplete, a list of needed RPMs is provided.
Available in GUI
No
ppm hypervisor connect
Syntax
/opt/CSCOppm-gw/bin/ppm hypervisor connect [hypervisor URL]
Command Description
Checks the connection between the Prime Performance Manager gateway and the hypervisor. Hypervisor URLs are entered in the following format:
./ppm hypervisor connect esx://nnn.nnn.nnn.nnn/?no_verify=1
./ppm hypervisor connect hyperv://nnn.nnn.nnn.nnn/?no_verify=1
./ppm hypervisor connect vpx://nnn.nnn.nnn.nnn/?no_verify=1
./ppm hypervisor connect xen://nnn.nnn.nnn.nnn/?no_verify=1\&pkipath=/opt/CSCOppm-gw/hypervisor/libvirt/etc/pki/CA
./ppm hypervisor connect qemu://nnn.nnn.nnn.nnn/system?no_verify=1\&pkipath=/opt/CSCOppm-gw/hypervisor/libvirt/etc/pki/CA
Available in GUI
No
ppm ifnameformat
Syntax
/opt/CSCOppm-gw/bin/ppm ifnameformat [ desc | alias | both | ifindex ]
Command Description
Defines the format for displaying interface names in the Prime Performance Manager GUI:
- desc—Only the interface description is displayed.
- alias—Only the interface alias is displayed.
- both—Both the interface description and alias are displayed.
- ifindex—Displays the interface by its Interface Index value, a unique identifying number associated with a physical and logical interfaces.
You can run this command on the gateway, and it will update all units.
Note After you change the interface name format, restart the gateway and all units. See ppm restart.
Available in GUI
ppm importcustnames
Syntax
/opt/CSCOppm-gw/bin/ppm importcustnames [ inputfile ]
Command Description
Allows to import custom names from another server.
Available in GUI
No
ppm importcw
Syntax
/opt/CSCOppm-gw/bin/ppm importcw [ cwfile ] [ force | telnet ]
Command Description
Imports device hostname and read-community strings from the CiscoWorks v3 server to Prime Performance Manager. SSH is the default import protocol.
cwfile —File name of the CiscoWorks export file. The file must be in CSV format.
The following parameters are not required if Prime Performance Managerdoes not have any communities or credentials.
force—Overrides any preexisting SNMP communities. Instead of adding new communities, the existing communities are modified automatically. This parameter applies to all imported communities.
telnet—Sets the connection protocol to Telnet and the port to 23. SSH v2 is the default import protocol and 22 the default port. This parameter applies to all imported communities.
You must log in as the root/super user to use this command. You do not need to restart the server to activate this command. After running this command, Prime Performance Manager discovers the imported nodes.
Available in GUI
No
ppm inactiveuserdays
Syntax
/opt/CSCOppm-gw/bin/ppm inactiveuserdays [ days | clear ]
Command Description
If you enable Prime Performance Manager user-based access, number of days a user can be inactive before disabling that user account.
This function is disabled by default. If you do not specify this command, user accounts are never disabled as a result of inactivity.
If you enter the ppm inactiveuserdays command, the valid range is zero (clears the command) to an unlimited number of days. There is no default setting.
If you have enabled this function and you want to disable it (that is, prevent Prime Performance Manager from automatically disabling user accounts as a result of inactivity), enter /opt/CSCOppm-gw/bin/ppm inactiveuserdays clear.
To re-enable the user’s authentication, use /opt/CSCOppm-gw/bin/ppm enableuser command.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topics
ppm installlog
Syntax
/opt/CSCOppm-gw/bin/ppm installlog [ server | client ]
Command Description
Displays the latest install log for the server or client. If you do not specify server or client, displays the latest install log for both the server and client.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm inventoryimport
Syntax
/opt/CSCOppm-gw/bin/ppm inventoryimport [- strictSync | - looseSync ]
Command Description
Imports device information from Prime Network (Cisco ANA) device inventory.
strictSync — In Strict Synchronization mode, only Prime Network type of devices are discovered.
looseSync — In Loose Synchronization mode, beside the devices imported from Prime Network, Prime Performance Manager can manage devices that are not in Prime Network inventory.
Available in GUI
Yes
ppm iosreport
Syntax
/opt/CSCOppm-gw/bin/ppm iosreport
Command Description
Lists the IOS versions of all devices that are managed by Prime Performance Manager. The command’s CSV output format is:
node name, custom name, node type, IOS version, serial number, system name, system location. IP address
To run this command, you must log in as the root/super user.
Available in GUI
Yes
ppm ipaccess
Syntax
ppm ipaccess [ add [ ip-addr ] | clear | edit | list | rem [ ip-addr ] | sample ]
Command Description
You use this command to create and manage a list of client IP addresses that can connect to the Prime Performance Manager server.
The list of allowed client IP addresses resides in the ipaccess.conf file. By default, when you first install Prime Performance Manager, the ipaccess.conf file does not exist and all client IP addresses can connect to Prime Performance Manager server.
To create the ipaccess.conf file and specify the list of allowed client IP addresses, use one of these keywords:
- add —Add the specified client IP address to the ipaccess.conf file. If the ipaccess.conf file does not already exist, this command creates a file with the first entry.
- clear —Remove all client IP addresses from the ipaccess.conf file and allow connections from any Prime Performance Manager client IP address.
- edit —Open and edit the ipaccess.conf file directly. If the ipaccess.conf file does not already exist, this command creates an empty file.
- list —List all client IP addresses currently in the ipaccess.conf file. If no client IP addresses appear (that is, the list is empty), connections from any Prime Performance Manager client IP address are allowed.
- rem —Remove the specified client IP address from the ipaccess.conf file.
- sample —Print out a sample ipaccess.conf file.
Any changes you make take effect when you restart Prime Performance Manager server.
See User Authentication for more information about using this command.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm ipslaftpfilesize
Syntax
/opt/CSCOppm-gw/bin/ppm ipslaftpfilesize [ file size in bytes ]
Command Description
When an IP SLA probe sends FTP transfer requests to a remote server, it retrieves a file with a specified size from the FTP server. This command tells Prime Performance Manager the size of the file, so it can compute the transfer rate. Unless you use this command to specify otherwise, Prime Performance Manager assumes the FTP file size is 1 MB.
Available in GUI
No
ppm javaver
Syntax
/opt/CSCOppm-gw/bin/ppm javaver
Command Description
Displays the version of Java that is used.
Available in GUI
No
ppm jspport
Syntax
/opt/CSCOppm-gw/bin/ppm jspport [ port-number ]
Command Description
Sets a new port number for the JSP server, where port-number is the new port number. Only numeric entries can be entered. Prime Performance Manager verifies that the new port number is not already used.
This command can be used to change the port number after you install Prime Performance Manager and, for example, find that another application needs the port.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm jvmsize
Syntax
/opt/CSCOppm-gw/bin/ppm jvmsize {megs} {gw|unit} {list}
Command Description
Sets the gateway or unit Java Virtual Machine (JVM) size in MBs.
You must log in as a Prime Performance Manager Superuser to use this command.
Available in GUI
No
ppm keytool
Syntax
/opt/CSCOppm-gw/bin/ppm keytool [ clear | genkey | import_cert cert_filename | import_key key_filename cert_filename | list | print_csr | print_crt ]
Command Description
If you implement SSL in your Prime Performance Manager system, manages SSL keys and certificates on Prime Performance Manager server.
Use these keywords and arguments with this command:
- clear —Stops Prime Performance Manager server, if necessary, and removes all SSL keys and certificates from the server. Before restarting the server, you must either generate new SSL keys by using the ppm keytool genkey command; or, you must completely disable SSL by using the ppm ssl disable command.
- genkey —Stops Prime Performance Manager server, if necessary, and generates a new self-signed public or private SSL key pair on Prime Performance Manager server. The new keys take effect when you restart the server.
- import_cert cert_filename —Imports the specified signed SSL certificate in X.509 format.
- import_key key_filename cert_filename —Imports the specified SSL key in OpenSSL format and the specified signed SSL certificate in X.509 format.
- list —Lists all SSL key-certificate pairs on Prime Performance Manager server.
- print_csr —Prints a certificate signing request (CSR) in X.509 format.
- print_crt —Prints Prime Performance Manager server’s SSL certificate in X.509 format.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topic
Managing Users and User Security
ppm listusers
Syntax
/opt/CSCOppm-gw/bin/ppm listusers [ username ]
Command Description
If you enable Prime Performance Manager User-Based Access, lists all currently defined users in the authentication list, including this information for each user:
- Username.
- Last time the user logged in.
- User’s authentication access level.
- User’s current authentication status, such as Account Enabled or Password Disabled.
To list information for a specific user, use the username argument to specify the user.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Listing Currently Defined Users
ppm localhabackupflag
Syntax
/opt/CSCOppm-gw/bin/ppm localhabackupflag [enable | disable | status ]
Command Description
This command is used when a Prime Performance Manager gateway is installed in the local directory and want to upgrade it to a gateway HA environment. (The SAN storage must be installed.) For information about upgrading a non-HA gateway to an HA environment, see the Cisco Prime Performance Manager 1.2 Quick Start Guide.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm localhacommands
Syntax
/opt/CSCOppm-gw/bin/ppm localhacommands
Command Description
Prints Prime Performance Manager gateway local HA commands usage information such as how to do switchover, freeze, or unfreeze a gateway in an HA environment. Example:
[root@crdc-ucs-109 ~]# /ha/CSCOppm-gw/bin/ppm hacommands
ppmGatewayHA.sh switchover - Switch the service to another cluster node.
ppmGatewayHA.sh freeze - Freeze the service in RHCS.
ppmGatewayHA.sh unfreeze - Unfreeze the service in RHCS.
ppmGatewayHA.sh status - Show the service status in RHCS.
***** Do NOT run these commands in ppm install directory. *****
***** Please go to /var/CSCOppm-ha/ppm-ha-bin directory to run these commands. *****
You must log in as the root/super user to use this command.
Available in GUI
No
ppm localhappmtimeout
Syntax
/opt/CSCOppm-gw/bin/ppm localhappmtimeout [ start | stop | info ] [ minutes ]
Specify or show ppm start/stop timeout minutes.
Command Description
Specifies or shows the Prime Performance Manager start and stop timeout in minutes for Prime Performance Manager gateways in an HA environment.
The default start timeout value is 3 minutes. The default stop timeout value is 2 minutes. You can use these commands to adjust the timeout values.
You must log in as the root/super user to use this command.
ppm logdir
Syntax
/opt/CSCOppm-gw/bin/ppm logdir [ directory ] [ nostart ]
Command Description
Sets the directory used for log files. The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
Available in GUI
No
ppm logger
Command Description
Displays the system messages messageLog.txt file with tail -f.
To stop the display, press Ctrl-C.
Available in GUI
Yes
ppm lognum
Syntax
/opt/CSCOppm-gw/bin/ppm lognum [ num ]
Command Description
Sets the maximum number of logs to retain, after which, logs will be archived.
Available in GUI
No
ppm logsize
Syntax
/opt/CSCOppm-gw/bin/ppm logsize [ number-of-lines ]
Command Description
Sets the maximum size for truncating and rolling log files.
- Message log files are in $LOGDIR/messageLog-archives (typically, /opt/CSCOppm-gw/logs/messageLog-archives).
- Network log files are in $LOGDIR/netStatus/archive
If you enter this command without the number-of-lines argument, Prime Performance Manager displays the current maximum number of lines. You can change this value.
The message and network log process archives the log file when the maximum number of lines is reached. The filename format of archived log files is:
- messageLog. YYYY : MMDD : hhmm : y.txt.Z
or
- networkLog. YYYY : MMDD : hhmm : y.txt.Z
where:
- YYYY is the year
- MM is the month in a two-digit format
- DD is the day of the month
- hh is the hour of the day in 24-hour notation
- mm is the minute within the hour
- y is one of these variables:
|
|
|
r |
The log file was created because Prime Performance Manager server restarted. |
messageLog.2008:0328:1427:r.txt.Z networkLog.2008:0328:1427:r.txt.Z |
c |
The log file was created because a user ran /opt/CSCOppm-gw/bin/ppm msglog clear command. |
messageLog.2008:0328:1433:c.txt.Z networkLog.2008:0328:1433:c.txt.Z |
o |
The log file was created from a pre-existing messageLog-old.txt file (used in previous Prime Performance Manager releases). |
messageLog.2008:0328:1413:o.txt.Z networkLog.2008:0328:1413:o.txt.Z |
0 (or higher number) |
A counter that starts at 0 and increments sequentially. The number resets to 0 when the server restarts. |
messageLog.2008:0328:1427:3.txt.Z networkLog.2008:0328:1427:3.txt.Z |
When messageLog.txt or networkLog.txt reaches the number of lines specified by /opt/CSCOppm-gw/bin/ppm logsize command, Prime Performance Manager creates a new log archive file by using the filename format above.
When the maximum number of lines is reached, the log filename contains a counter value to differentiate itself from other archived files (for example, messageLog.2011:0328:1427:1.txt.Z and messageLog.2011:0328:1427:2.txt.Z).
The default value for number-of-lines is 500,000 lines.
The valid range is 1,000 lines to an unlimited number of lines. The default value is 500,000 lines. If you specify a larger file size for the log file, the log file and its copy require proportionally more disk space.
When changing the number of lines to display, remember that every 5,000 lines require approximately 1 MB of disk space. You need to balance your need to refer to old messages against the amount of disk space they occupy.
Note All log files are aged out by a timing mechanism (/opt/CSCOppm-gw/bin/ppm msglogage). You can estimate a size for the $LOGDIR/messageLog-archives directory based on the number of lines, the amount of data that is logged (/opt/CSCOppm-gw/bin/ppm mldebug), and the log age.
You must log in as the root/super user to use this command. If you change the number-of-lines value, you must restart the server (/opt/CSCOppm-gw/bin/ppm restart).
Available in GUI
No
ppm logtimemode
Syntax
/opt/CSCOppm-gw/bin/ppm logtimemode [ 12 | 24 ]
Command Description
Sets the time mode for dates in log files:
- 12 —Use 12-hour time, with AM and PM so that 1:00 in the afternoon is 1:00 PM.
- 24 —Use 24-hour time, also called military time so that 1:00 in the afternoon is 13:00. This is the default setting.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm majoralarm
Syntax
/opt/CSCOppm-gw/bin/ppm majoralarm [Major Alarm]
Command Description
Generates a major Prime Performance Manager alarm. This alarm is generated on the Prime Performance Manager gateway and will also be forwarded northbound if configured.
Available in GUI
No
ppm manageulsredundancy
Syntax
/opt/CSCOppm-gw/bin/ppm manageulsredundancy [ list | set | delete | partitioner ]
Command Description
Manages small cell upload server (ULS) redundancy.
Options:
- list—Lists all ULS redundancy groups.
- set [ redundancygroup device1 device2 device3...] —Creates a ULS redundancy group. Requires the redundancy group name and the devices you want in the group.
- delete [ redundancygroup ]—Deletes the ULS redundancy group.
- partitioner—Manages the ULS partitions:
– print—Prints the current file fetching partitions.
– repartition—Repartitions the set of APs each active unit is responsible for.
– delete—Deletes the current partitions.
Caution : After you invoke the delete option, a new set of partitions are created and files are retrieved from the Max Back Time onward.
Available in GUI
No
ppm maxhtmlrows
Syntax
/opt/CSCOppm-gw/bin/ppm maxhtmlrows [ number-of-rows ]
Command Description
Sets the maximum number of rows for Prime Performance Manager HTML web output; for example, statistics reports, status change messages, or SNMP trap messages.
Note If you have set the Page Size on web interface, this command does not override that setting. When you set the Page Size feature on the Prime Performance Manager web interface, browser cookies store the setting until the cookie expires or Prime Performance Manager deletes it.
If you enter this command without the number-of-rows argument, Prime Performance Manager displays the current maximum number of rows. You can then change that value or leave it. The valid range is one row to an unlimited number of rows. The default value is 100 rows.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Chapter 3, “Managing the Web Interface”
ppm maxpagesize
Syntax
/opt/CSCOppm-gw/bin/ppm maxpagesize [ number-of-rows ]
Command Description
Sets the maximum browser page size for table reports. 800 rows is the default.
Available in GUI
No
ppm maxrepqueries
Syntax
/opt/CSCOppm-gw/bin/ppm maxrepqueries [ number ]
Command Description
Sets the maximum number of report sessions that can be open at one time.
Available in GUI
No
Note After changing this setting, you must restart the Prime Performance Manager server. See ppm restart.
ppm maxquerycachecolumns
Syntax
/opt/CSCOppm-gw/bin/ppm maxquerycachecolumns [ number ]
Command Description
Sets the maximum number of columns that will be kept in the query cache for a report. 50 columns is the default.
Available in GUI
No
ppm messagequeuetool
Syntax
/opt/CSCOppm-gw/bin/ppm messagequeuetool [ -a | -i | -b | -T | -v | -u | -w | -E | -o ]
Command Description
Sets the set up message brokers that listen for OpenStack tenant changes and update the Prime Performance Manager tenant data when they occur. The message brokers supplement the ongoing tenant data synchronization set up at 30-minute, one-hour, or six-hour intervals when you add the tenant entry to Prime Performance Manager. Message brokers have two requirements:
- OpenStack must use the RabbitMq message broker. Qpid and ZeroMQ are not supported.
- At least one OpenStack tenant must be added to Prime Performance Manager.
Options:
- -a—The primary message broker action:
– addOpenstackMessageQ—Adds a new message broker.
– updateOpenstackMessageQ—Update an existing message broker.
– deleteOpenstackMessageQ—Deletes an existing messasge broker.
– listOpenstackMessageQ—Displays a list of created messasge broker entries. When an entry status is active, that means Prime Performance Manager is listening to the OpenStack tenant it is set up to monitor.
– -i uniqueName -b msgBroker -T port -v vHost -u user -w password -E enabled -o openstack to add an configuration entry, where
- -i Name —is the unique name for the message broker entry.
- -b— MessageBrokerIP —The IP address of the RabbitMq message broker
- -T ListenerPort —The message broker port used to listen for updates.
- -v VirtualHost —The virtual host configured on the message broker. The default is ‘/’.
- -u username —The user name used to connect to the message broker.
- -w password —The username password.
- -E—Indicates whether the message broker is enabled, true (default) or false.
- -o openstack, ip —The OpenStack IP address containing the tenant that the message broker will monitor. The OpenStack IP must be added to Prime Performance Manager through the OpenStack tenant integration process.
Available in GUI
Yes
Related Topics
ppm mibcap
Syntax
/opt/CSCOppm-gw/bin/ppm mibcap [ device_name ]
Command Description
Displays device MIB capabilities.
Available in GUI
No
ppm mibver
Syntax
/opt/CSCOppm-gw/bin/ppm mibver
Command Description
Displays all SNMP MIB versions.
Available in GUI
No
ppm minoralarm
Syntax
/opt/CSCOppm-gw/bin/ppm minoralarm [Minor Alarm]
Command Description
Generates a minor Prime Performance Manager alarm. This alarm is generated on the Prime Performance Manager gateway and will also be forwarded northbound if configured.
Available in GUI
No
ppm mldebug
Syntax
/opt/CSCOppm-gw/bin/ppm mldebug [ mode ]
Command Description
Sets the mode for logging Prime Performance Manager debug messages:
- normal —Logs all action, error, and info messages. Use ppm mldebug normal to revert to the default settings if you accidentally enter ppm mldebug command.
- list —Displays the current settings for ppm mldebug command.
- all —Logs all messages, of any type.
- none —Logs no messages at all.
- minimal —Logs all error messages.
- action —Logs all action messages.
- debug —Logs all debug messages.
- dump —Logs all dump messages.
- error —Logs all error messages.
- info —Logs all info messages.
- NBAPI-SOAP —Logs all northbound SOAP messages.
- snmp —Logs all SNMP messages.
- trace —Logs all trace messages.
- trapsIn —Logs all incoming trap messages.
- trapsOut —Logs all outgoing trap messages.
This command can adversely affect Prime Performance Manager performance. Use this command only under guidance from the Cisco Technical Assistance Center (TAC).
You must log in as the root/super user to use this command.
Available in GUI
No
ppm modifysnmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm addsnmpcomm -i ipaddress -c read community | -u snmpv3 username [ -a authentication protocol | -A authentication password ] [ -p privacy protocol | -P privacy password ] [ -v 1 |2c | 3 ]
Command Description
Modifies an SNMP configuration on a Prime Performance Manager server.
- -i ipaddress —The IP address of the device (required)
- -c read community —The SNMP read community. Read community is required for SNMP v1 and 2c.
- -u snmpv3 username —The SNMP username. The username is required for SNMP v3.
- -a authentication protocol —The authentication protocol.
- -A authentication password —The authentication password.
- -p privacy protocol —The privacy protocol.
- -P privacy password —The privacy password.
- -v version —The SNMP version, 1, 2c, or 3. The default is 2c.
- -c community —The read community string of the device (required)
You do not need to restart Prime Performance Manager server.
Available in GUI
Yes
Related Topics
ppm modifyunitconf
Syntax
/opt/CSCOppm-gw/bin/ppm modifyunitconf {-i ipaddress | -u unitname }
Command Description
Command uses the option -i (ipaddress) and -u (unitname) to modify a unit configuration.
Available in GUI
Yes
ppm motd
Syntax
/opt/CSCOppm-gw/bin/ppm motd [ cat | disable | edit | enable ]
Command Description
Manages Prime Performance Manager Message of the Day file, which is a user-specified Prime Performance Manager system notice. You can set the Message of the Day to inform users of important changes or events in Prime Performance Manager system.
The Message of the Day also provides users with the chance to exit Prime Performance Manager before launching.
If you enable the Message of the Day, it appears whenever a user attempts to launch an Prime Performance Manager client. If the user:
- Accepts the message, the client launches.
- Declines the message, the client does not launch.
Use these keywords with this command:
- enable —Enables the Message of the Day function. Initially, the message of the day file is blank; use ppm motd edit command to specify the message text.
- edit —Edits the Message of the Day.
- cat —Displays the contents of the Message of the Day file.
- disable —Disables this function (that is, stops displaying the Message of the Day whenever a user attempts to launch an Prime Performance Manager or GTT client).
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topics
ppm premotd
Launching the Web Interface
ppm movenode
Syntax
/opt/CSCOppm-gw/bin/ppm movenode [ node1 unit1 ] [ node2 unit2... ]
Command Description
Moves devices from one unit to another.
Available in GUI
Yes.
ppm msglog
Syntax
/opt/CSCOppm-gw/bin/ppm msglog [ clear | -r ]
Command Description
Uses PAGER to display the contents of the system message log.
To save the current contents of the log, clear the log, and restart the server, enter /opt/CSCOppm-gw/bin/ppm msglog clear.
To display the contents of the log in reverse order, with the most recent messages at the beginning of the log, enter /opt/CSCOppm-gw/bin/ppm msglog -r.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm msglogage
Syntax
/opt/CSCOppm-gw/bin/ppm msglogage [ number-of-days ]
Command Description
Sets the maximum number of days to archive all types of log files before deleting them from Prime Performance Manager server.
If you enter this command without the number-of-days argument, Prime Performance Manager displays the current maximum number of days. You can then change that value or leave it. The valid range is one day to an unlimited number of days. The default value is 31 days.
The start date for aging out and deleting files is always yesterday at 12 AM. For example, say that you set the value to one day and you run the ppm msglogage command at 3 PM on January 10th.
To find files that will be deleted by the aging process, count back to 12 AM on January 10th, then add the number of days set in the command. In this example, we added one more day, so any file with an earlier timestamp than January 9th at 12 AM will be removed.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm msglogdir
Syntax
/opt/CSCOppm-gw/bin/ppm msglogdir [ directory ]
Command Description
Note You must stop Prime Performance Manager server before performing this command. You are prompted whether to continue.
Changes the default location of all Prime Performance Manager system message log files. By default, the system message log files reside on Prime Performance Manager server at /opt/CSCOppm-xxx/logs. Where xxx denotes a unit or gateway.
Note Do not set the new directory to any of these: /usr, /var, /opt, or /tmp. Also, do not set the new directory to the same directory in which you are storing GTT files (ppm gttdir), report files (ppm repdir), route table files (ppm routedir), or address table files (ppm atbldir).
After you change the directory, Prime Performance Manager asks if you want to restart Prime Performance Manager server. The new directory takes effect when you restart Prime Performance Manager server.
You must log in as the root/super user to use this command. If you change to a default location outside Prime Performance Manager, you must have appropriate permissions for that location.
Available in GUI
No
ppm netflow
Syntax
/opt/CSCOppm-unit/bin/ppm netflow [ enable | disable | status ]
Command Description
Enables, disables or checks the status of the NetFlow collection on the unit server. If enabled, the NetFlow collector listens for and processes NetFlow packets on the unit. The NetFlow collector must be enabled to generate NetFlow reports. The command changes the NETFLOW_ACTIVE property in /opt/CSCOppm-unit/properties/NetFlow.properties. The default value is enabled. However, if you are not generating NetFlow reports, disabling NetFlow is recommended to free up memory.
The command is available only on the unit. Enabling or disabling NetFlow requires a unit restart. The restart is performed by the ppm restart command (see ppm restart).
Available in GUI
No
ppm netflowport
Syntax
/opt/CSCOppm-unit/bin/ppm netflowport [ port ]
Command Description
Changes the NetFlow collector port where the collector listens for NetFlow packets from devices. The command changes the UDP_PORT property in /opt/CSCOppm-unit/properties/NetFlow.properties. The default value is 9991 port. The command is available only on the unit. Changing the NetFlow port requires a unit restart. The restart is performed by the command.
Available in GUI
No
ppm netflowservfile
Syntax
/opt/CSCOppm-unit/bin/ppm netflowservfile [ file ]
Command Description
Changes the NetFlow services files used by GetServByPort macro. The macro looks up service names for NetFlow ports and protocol. By default, the file is /opt/CSCOppm-gw/etc/services and /opt/CSCOppm-unit/etc/services. (The file is available on both gateway and unit.) You can add or modify the services file entries on the gateway and the changes are automatically sent to all the units.
If you have your own lookup file that you want to use instead of the default services file, use this command to specify the alternate file. The new file must be in the same syntax as the default services file.
This command changes the NETFLOW_PORTSERVICES_FILE property in System.properties. You must execute the command on both the gateway and unit servers for the changes to take effect.
Available in GUI
No
ppm netlog
Syntax
/opt/CSCOppm-gw/bin/ppm netlog [clear | -r]
Command Description
Uses PAGER to display the contents of the network status log. To:
- Save the current contents of the log, clear the log, and restart the server, enter /opt/CSCOppm-gw/bin/ppm netlog clear.
- Display the contents of the log in reverse order, with the most recent network status messages at the beginning of the log, enter /opt/CSCOppm-gw/bin/ppm netlog -r.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm netlogger
Server Only
Command Description
Displays the current contents of the network status log file with tail -f command.
To stop the display, enter Ctrl-c.
Available in GUI
Yes
ppm newlevel
Syntax
/opt/CSCOppm-gw/bin/ppm newlevel [ username ]
Command Description
If you enable Prime Performance Manager User-Based Access, changes the authentication level for the specified user. Valid levels are:
- 1 —Basic User
- 3 —Network Operator
- 5 —System Administrator
- 11 & 12 — Custom Level
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Enabling User Accounts and Passwords Using the CLI
ppm nontoerrcount
Syntax
/opt/CSCOppm-gw/bin/ppm nontoerrcount [ number ]
Command Description
Sets the number of non-timeout errors allowed in a report sequence. This command and the ppm toerrcount command control the number of polling errors to get from a device in a polling sequence before giving up on that entire polling sequence.The default is 1.
Available in GUI
No
Related Topic
ppm numfastthreads
Syntax
/opt/CSCOppm-gw/bin/ppm numfastthreads
Command Description
Displays the number of fast SNMP polling threads.
Available in GUI
Yes
Related Topics
ppm numslowthreads
Syntax
/opt/CSCOppm-gw/bin/ppm numslowthreads
Command Description
Displays the number of slow SNMP polling threads.
Available in GUI
Yes
Related Topics
ppm optimizecapabilitypoll
Syntax
/opt/CSCOppm-gw/bin/ppm optimizecapabilitypoll { enable | disable | status }
Command Description
Enables or disables capability poll optimization. If enabled, Prime Performance Manager capability polling polls devices for capabilities based on network-level or device-level enabled reports. If disabled, Prime Performance Manager polls devices for all the device capabilities regardless of whether reports are enabled at the network or device levels. Use these keywords and arguments with this command:
- enable —Enables capability poll optimization.
- disable —Disables capability poll optimization.
- status —Displays the capability poll optimization status.
Available in GUI
No
Related Topic
Device Report Capability Polling
ppm osinfo
Syntax
/opt/CSCOppm-gw/bin/ppm osinfo
Command Description
Depending on the networks that you have set, displays the operating system versions of software that Prime Performance Manager supports.
Available in GUI
Yes
ppm passwordage
Note You should have already changed your password at least once for this command to properly age the password.
Syntax
/opt/CSCOppm-gw/bin/ppm passwordage [ days | clear ]
Command Description
If you enable Prime Performance Manager User-Based Access and you set /opt/CSCOppm-gw/bin/ppm authtype to local, number of days allowed before forcing users to change passwords. The number of days start to accrue beginning yesterday at 12 AM.
Note For more details on how this works, see ppm msglogage.
This function is disabled by default. If you do not specify this command, users will never need to change their passwords.
If you enter /opt/CSCOppm-gw/bin/ppm passwordage command, the valid range is one day to an unlimited number of days. No default setting exists.
If you enabled this function and you want to disable it (that is, prevent Prime Performance Manager from forcing users to change passwords), enter /opt/CSCOppm-gw/bin/ppm passwordage clear.
Note If /opt/CSCOppm-gw/bin/ppm authtype is set to solaris, you cannot use this command. Instead, you must manage passwords on the external authentication servers.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Editing User Security Settings
ppm patchlog
Syntax
/opt/CSCOppm-gw/bin/ppm patchlog
Command Description
Uses PAGER to display the contents of the patch log, which lists the patches that you installed on Prime Performance Manager server.
The default path and filename for the patch log file is /opt/CSCOppm-gw/install/sgmPatch.log. If you installed Prime Performance Manager in a directory other than /opt, then the patch log file resides in that directory.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm ping
Syntax
/opt/CSCOppm-gw/bin/ppm ping [ hostname ]
Command Description
You use this command to ping a device from the command line.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm pingpolldelay
Syntax
/opt/CSCOppm-gw/bin/ppm pingpolldelay [ minutes ]
Command Description
You use this command to set the polling delay, in minutes.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm pnscintegration
Syntax
/opt/CSCOppm-gw/bin/ppm pncsintegration [ remove ]
Command Description
Integrates Prime Performance Manager with Cisco Prime Network Services Controller. Running ppm pnscintegration displays the following prompts:
- PNSC Host—The Prime Network Service Controller host name.
- PNSC Admin Username—The Prime Network Service Controller username.
- PNSC Admin Password—The Prime Network Service Controller user password.
- PPM Admin Username (New)—If user security is not enabled on Prime Performance Manager, the new administrator user that will be used to log into Prime Performance Manager from Prime Network Services Controller. (If user security is enabled, this prompt is not displayed._
- PPM Admin Password (New) The new administrator user password.
Command options:
- Remove—Removes the integration.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topics
ppm policytool
Syntax
/opt/CSCOppm-gw/bin/ppm pol icytool [-a actionName] [parameters]
Command Description
Invokes report policy API operations.
Actions and parameters:
– -A <deviceName>,<policyName>
– -H <hostname>
– -p <port number>
– -S <y|n>
– -h <help>
– -n <policyName>
– -H <hostname>
– -p <port number>
– -S <y|n>
– -h <help>
– -w <deviceName>
– -P <policyName>
– -R <categoryName>
– -r <reportName>
– -o <outputType>
– -H <hostname>
– -p <port number>
– -S <y|n>
– -h <help>
– -u <policyFile>
– -H <hostname>]
– -p <port number>
– -S <y|n>
– -h <help>
The updateReportPolicies file should contain an xml ReportPolicyList produced by the getReportPolicies action. The ordering of categories, reports, flags, and numbers is not significant. The command will always generate output in the same order but can handle any input order as long as the types are in the correct order.
For each update flag set, you can specify that all intervals are enabled or disabled, or you can specify individual interval settings. You cannot do both. Trying to do both will cause a validation failure.
The updateReportPolicies action does not change unspecified settings; you do not need to specify any settings that you do not want to change.
Parameters:
- -a—Specifies the operation type to perform.
- -A—Specifies a comma-separated assignment <deviceName>,<policyName>. Repeat for multiple assignments.
- -n—Specifies a policy name to delete. Repeat for multiple deletions.
- -u—Specifies a file name for the policies with the same format as the getReportPolicies xml output.
- -w—Specifies the device name (blank for all).
- -P—Specifies the policy name (blank for all, 'Default' for default).
- -R—Specifies the category name (blank for all, 'master' for global).
- -r—Specifies the report name (blank for all)
- -o—Specifies the output type (xml [default] or json)
- -H—Specifies a hostname to connect to. If not specified, the default value is obtained from the gateway System.properties file, SERVER_NAME property.
- -p—Specifies a port to connect to. If not specified, the default value is obtained from the gateway System.properties file, WEB_PORT property.
- -S—Specifies whether to use SSL (https) for NBAPI access, default is no SSL.
- -h—Print help information.
Available in GUI
Yes
ppm poll
Syntax
/opt/CSCOppm-gw/bin/ppm poll [ node ] [ node ]...
Command Description
You use this command to poll one or more known nodes from the command line. Use the node arguments to specify the DNS names or IP addresses of one or more known nodes.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm pollstarschemas
Syntax
/opt/CSCOppm-gw/bin/ppm pollstarschemas [ schemaName ] [ schemaName2 ][ schemaNameN ]...
Command Description
Poll for all or selected StarOS schemas for the discovered device.
Available in GUI
No
ppm premotd
Syntax
/opt/CSCOppm-gw/bin/ppm premotd [ cat | disable | edit | enable ]
Command Description
Manages the message that appears at the bottom of the Prime Performance Manager login window.
Use these keywords with this command:
- enable —Enables the message at the bottom of the login window.
- edit —Edits the message at the bottom of the login window.
- cat —Displays the message at the bottom of the login window.
- disable —Disables the login window message.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topics
ppm motd
Launching the Web Interface
ppm primecentralintegration
Syntax
/opt/CSCOppm-gw/bin/ppm primecentralintegration
Command Description
Use this command to integration Prime Performance Manager with Cisco Prime Central. After you enter the command, you will be prompted for the following information:
- Enter Prime Central Server—Enter the Prime Central database server IP address or hostname.
- Enter SID [primedb]—Enter the Prime Central database service name, which is primedb by default.
- Enter DB User [primedba]—Enter the Prime Central database username, which is primedba by default.
- Enter DB Password [*****]—Enter the Prime Central database user password; for example, Test456!
- Enter DB Port [1521]—Enter the Prime Central database port number, which is 1521 by default.
- Restart Prime Central Integration Layer [Yes]—Enter Y to restart the integration layer server.
You must log in as the root/super user to use this command. For additional information, see Chapter4, “Importing Devices From Other Cisco Prime Applications”
Available in GUI
Yes
ppm primeha
Syntax
/opt/CSCOppm-gw/bin/ppm primeha [ status | switch | configure {peergatewayname | peergatewayrmiport | healthcheckinterval | maxfailnum | synccsv | ageout | cachelimit } | backupdb ( path )| freeze | unfreeze | backup | restore ( file name ) ]
Command Description
Manages Prime Performance Manager geographical HA implementation.
Use these keywords with this command:
- status —Shows the geographical HA status.
- switch —Immediately moves from the primary HA gateway to secondary gateway.
- configure —Configures the following geographical HA parameters
– peergatewayname —The peer gateway IP address or host name.
– peergatewayrmiport —The peer gateway RMI port.
– healthcheckinterval —The health check interval, in seconds.
– maxfailnum —The maximum number of health check failures before a failover is initiated.
– synccsv —Synchronizes the CSV files.
– ageout —Sets the age time out.
– cachelimit —Sets the cache limit.
- backupdb { path }—Backs up the primary gateway database. If the primary gateway is out of sync, sets it to in sync.
You must log in as the root/super user to use this command option.
- freeze —Stop the health check of remote Secondary Gateway. Prevent failover during the Primary Gateway restart.
- unfreeze —Start the health check of remote Secondary Gateway.
- backup —Backs up data files to a backup location.
You must log in as the root/super user to use this command option.
- restore { filename }—Restores gateway system files with specified backup file.
You must log in as the root/super user to use this command option.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topic
Managing Geographical High Availability
ppm primenetworkintegration
Syntax
/opt/CSCOppm-gw/bin/ppm primenetworkintegration [remove]
Command Description
Use this command to integrate Prime Performance Manager with Cisco Prime Network. After you enter the command, you will be prompted for the following information:
- Enter Prime Network Host Name or IP Address—Enter the Prime Network hostname or IP address.
- Enter the Prime Network port—Enter the Prime Network port.
- Secured?—Enter y if the port is secured; n if it is not.
- Enter Prime Network User Name—Enter the Prime Network username.
- Enter Prime Network User Password [*****]—Enter the Prime Network user password; for example, Test456!
- Enable Strict Synchronization?—Enter y if the port is secured if you want to enable strict synchronization; n if you do not. If strict synchronization is enabled, Prime Performance Manager can only generate reports from devices imported from Prime Network
You must log in as the root/super user to use this command. For additional information, see Chapter4, “Importing Devices From Other Cisco Prime Applications”
Available in GUI
Yes
ppm print
Syntax
/opt/CSCOppm-gw/bin/ppm print { all | device | snmp | task | alarmsummary [ severity ] [quiet] }
Command Description
Displays information about device versions, SNMP settings, running tasks, summary of alarms, or all of this information.
Use these keywords with this command:
- device —Prints name, state, and system description of all nodes in the network.
- snmp —Prints SNMP information such as read and write community strings.
- task —Prints a list of task IDs and related information.
- alarmsummary —Prints a list of alarms sorted by severity types (critical, major, minor, and so on).
– severity —Prints a list of alarms of a specified severity type. The severity takes one of these values: critical, major, minor, warning, informational, or indeterminate.
– quiet —Use this keyword to print only the alarm counts (without the severity label)
- all —Prints the information available in all of the keywords of this command.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm printreportstatus
Syntax
/opt/CSCOppm-gw/bin/ppm printreportstatus { enable | disable }
Command Description
Enables or disables report status printing in the Prime Performance Manager GUI.
Available in GUI
Yes
ppm props
Syntax
/opt/CSCOppm-gw/bin/ppm props
Command Description
Displays the contents of the System.properties files for both Prime Performance Manager server and client installations.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm probetool
Syntax
/opt/CSCOppm-gw/bin/ppm probetool -a { addProbe | updateProbe | deleteProbe | getProbeInfo }
Command Description
This command adds and manages probes in Prime Performance Manager.
Options
- addProbe—Adds a probe to Prime Performance Manager. Options:
– -u <XML file>
– [-H <hostname>]
– [-p <port number>]
– [-S <y|n>]
– [-h <help>]
- updateProbe—Updates a probe. Options:
– -u <XML file>
– [-H <hostname>]
– [-p <port number>]
– [-S <y|n>]
– [-h <help>]
- deleteProbe—Deletes a probe. Options:
– -w <deviceName>
– -v <probeName>
– [-H <hostname>]
– [-p <port number>]
– [-S <y|n>]
– [-h <help>]
- getProbeInfo—Gets probe information. Options:
– -w <deviceName>
– -v <probeName>
– [-H <hostname>]
– [-p <port number>]
– [-S <y|n>]
– [-h <help>]
Parameters:
- -a—Specifies the type of operation to be performed.
- -u—Specifies a file name for the probe.
- -v—Specifies the name for the probe.
- -w—Specifies the name for the device
- -H—Specifies a hostname to connect to. If not specified, default value is obtained from the gateway System.properties file, SERVER_NAME property.
- -p—Specifies a port to connect to. If not specified, default value is obtained from the gateway System.properties file, WEB_PORT property.
- -S—Specifies whether to use SSL (https) for NBAPI access, default is no SSL.
- -h—Print help information.
Available in GUI
Yes
ppm purgedb
Syntax
/opt/CSCOppm-gw/bin/ppm purgedb
Command Description
Permanently deletes all components in Prime Performance Manager database marked for deletion. Prime Performance Manager retains information about older objects in its database even after they are deleted. This is considered a logically deleted state. The command also starts the report aging task so any report data that has reached the aging time for any report and time interval is removed.
Prime Performance Manager retains this information to maintain any user customized data associated with an object (for instance, a customized name) in case the object is rediscovered in the future. Logically deleted data is physically deleted after seven days if it is not reused by then.
This command immediately removes logically deleted data from the Prime Performance Manager database. Unfortunately, this benefit may have a side effect. In certain cases, rediscovery of a deleted object may cause Prime Performance Manager to use obsolete information in the database, rather than the new information. Some configuration changes might not be detected, and the viewable data displayed in the client application is incorrect.
Note This command does not cause the loss of any collected statistical data.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm pwdchangeinterval
Syntax
/opt/CSCOppm-gw/bin/ppm pwdchangeinterval [ hours ]
Command Description
If password change restriction is enabled, specifies the length of time within which users cannot change their password more than the number of times specified in ppm pwdchangelimit applies in hours. The default is 48 hours. The allowable range is 1 through 745 hours.
Available in GUI
Yes
Related Topics
ppm pwdchangelimit
Syntax
/opt/CSCOppm-gw/bin/ppm pwdchangelimit [ limit ]
Command Description
If password change restriction is enabled, specifies the number of times users can change their passwords within length of time specified in ppm pwdchangeinterval. The default is 2. The allowable range is 1 through 10.
Available in GUI
Yes
Related Topics
ppm pwdchangerestrict
Syntax
/opt/CSCOppm-gw/bin/ppm pwdchangerestrict { enable | disable }
Command Description
Enables or disables the password change restriction. If enabled, users cannot change their passwords more frequently than the number specified in ppm pwdchangelimit with the time interval specified in ppm pwdchangeinterval.
Available in GUI
Yes
Related Topics
ppm ramdisksize
Syntax
/opt/CSCOppm-gw/bin/ppm ramdisksize {[ MB ] gw | unit }
Command Description
Sets the gateway or unit RAM disk size. You can run the command in two ways. You can enter the command with the specified MB value, or you can enter the command and enter responses to command prompts.
Options:
- ppm ramdisksize—Displays the current value and prompts you to enter a new value for both the gateway and collocated unit (if present). If you change the RAM value, a message is shown to restart the gateway and unit.
- ppm ramdisksize nnn —Changes the RAM disk size immediately for both the gateway and collocated unit (if present) for the new nnn RAM value, then shows the restart gateway and restart unit messages.
- ppm ramdisksize nnn gw—Changes the gateway RAM disk size immediately to the nnn value and displays the restart gateway message.
- ppm ramdisksize nnn unit—Changes the unit RAM disk size immediately to the nnn value and displays the restart unit message.
Note Before running this command, check for the available memory.
Note You must restart the gateway or unit after you change its RAM disk size.
Available in GUI
No.
ppm readme
Syntax
/opt/CSCOppm-gw/bin/ppm readme
Command Description
Displays the Prime Performance Manager README file contents.
Available in GUI
Yes
Related Topic
Chapter 3, “Managing the Web Interface”
ppm reboot
Syntax
/opt/CSCOppm-gw/bin/ppm reboot
Command Description
Reboots the Solaris Prime Performance Manager system.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm redistributenodes
Syntax
/opt/CSCOppm-gw/bin/ppm redistributenodes
Command Description
Redistributes discovered network devices based upon the current unit configuration.
Available in GUI
Yes
ppm redundancygroups
Syntax
/opt/CSCOppm-gw/bin/ppm redundancygroups [ list | detail | create | add | remove | delete | redundant | delay | enable | disable | failover | failback | import | export ]
Command Description
Creates and manages unit protection groups. Use the following keywords with this command:
- list —Lists the redundancy groups defined on the gateway, similar to the following:
ppm redundancygroups list
groupA, Enabled, Number of Units: 2
groupB, Enabled, Number of Units: 4
- detail [ group name ]—Lists the redundancy group details, similar to the following:
ppm redundancygroups detail groupA
Created: Wed Sep 21 11:44:36 EDT 2011
Last Modified: Wed Sep 21 11:44:36 EDT 2011
Last Modified User: localhost
- create [ group name | delay | unit(s)... ]—Creates a redundancy group with the provided group name, switchover delay (in seconds), and unit(s).
- add [ group name | unit(s)... ]—Adds unit(s) to a redundancy group.
- remove [ group name | unit(s)... ]—Removes a unit(s) from a redundancy group.
Note A redundant unit cannot be removed from a redundancy group. To remove a redundant unit, you must change the redundant unit for the group, then you can remove the old redundant unit. Another option is to delete and recreate the redundancy group.
- delete [ group name ]—Deletes a redundancy group. The unit redundancy mode is not checked.
- redundant [ group name | unit ]—Changes the redundant unit of a redundancy group. No devices can be attached to the new redundant node.
- delay [ group name | delay ]—Changes the failover delay of a redundancy group. The delay, specified in seconds, is the amount of time the gateway waits after detecting a unit is unavailable before initiating a failover to the redundant unit
- enable [ group name ]—Enables a redundancy group.
- disable [ group name ]—Disables a redundancy group. When a group is disabled automatic failovers will not occur. However, you can perform manual failovers and failbacks.
- failover [ unit ]—Forces the failover of a unit to the redundant unit of the redundancy group.
- failback [ unit ]—Initiates a return of control from the redundant unit to the specified unit.
- import [/ directory/filename ]—Imports a redundancy group definitions from the provided file name.
- export [/ directory/filename ]—Exports redundancy group definitions to the provided file name.
Available in GUI
No
Related Topic
Managing Unit Redundancy Groups
ppm reloadbulkstats
Syntax
/opt/CSCOppm-gw/bin/ppm reloadbulkstats
Command Description
Reloads the bulkstatsschema.csv schema file. The bulkstatsschema.csv, located in the /opt/CSCOppm-gw/etc/, gathers bulk statistics from the Cisco ASR 5000 and 5500 Series devices. The bulk statistics include counters that Prime Performance Manager uses for reports. The counters are grouped into schemas, and schemas are grouped into types. For example, card is a type, so card schema 1 might have 20 card counters, card schema 2 might have another 20 card counters, and so on.
To generate reports from ASR 5000 and 5500, the devices must be configured with the schemas and counters, and the schema file must be generated in CSV format and exported at regular intervals to Prime Performance Manager.
Only counter values are exported. The bulkstatsschema.csv file provides the corresponding counter names used by Prime Performance Manager to read the CSV files (bulk statistics) generated from the ASR 5000/5500. If the ASR 5000/5500 devices are configured with a new schema or type or the counter sequence changed, the bulkstatsschema.csv file must be updated. This command updates the Prime Performance Manager in-memory schema counters list with the new counter information from /opt/CSCOppm-gw/etc/bulkstatsschema.csv.
You do not need to restart Prime Performance Manager.
The command supported only on the gateway.
Available in GUI
No
ppm reloadmibs
Syntax
/opt/CSCOppm-gw/bin/ppm reloadmibs
Command Description
Reloads the current or master snmpinfo.dat file.
Available in GUI
Yes
ppm rename
Syntax
/opt/CSCOppm-gw/bin/ppm rename dnsname customname
Command Description
Renames a device DNS name to a custom name:
- dnsname—The DNS name you want to change.
- customname—The new custom name.
Available in GUI
No
ppm repdir
Syntax
/opt/CSCOppm-gw/bin/ppm repdir [ directory ] [ nostart ]
Command Description
Command to set directory used for reports. The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm reportdir
Syntax
/opt/CSCOppm-gw/bin/ppm reportdir
Command Description
Command to set directory used for reports. The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm rephelp
Syntax
/opt/CSCOppm-gw/bin/ppm rephelp
Command Description
Displays Help for all commands that are related to Prime Performance Manager reports.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm resolvehostnames
Syntax
/opt/CSCOppm-gw/bin/ppm resolvehostnames [ object ] [ arg { argument }]
Command Description
Returns the host name in a string format. The hostname is resolved using the naming resolution defined in the optional arg parameter. If the arg parameter is not provided, the macro uses the naming resolution defined in RESOLVE_HOST_NAMES in the Reports.properties file. If RESOLVE_HOST_NAMES is not found in Reports.properties, the macro uses DNS to resolve the IP to a hostname. Regardless of the naming resolution strategy, if the command cannot resolve the IP address, it returns the IP address as the hostname.
- object—Is an IP address.
- arg—An optional parameter that defines the naming resolution, either DNS name or Prime Performance Manager device name:
– dns—Resolves the IP address using the DNS. If the IP is not resolved to a name, it returns the IP address.
– ppm—Resolves the IP address using the Prime Performance Manager device name based on the definition specified in the ppm statreps nametype command.
– ppm,dns—Resolves the IP address using the Prime Performance Manager device name. If the device cannot be found for that IP address, it resolves the IP using the DNS.
– dns,ppm—Resolves the IP address using the DNS. If the IP cannot be resolved to a name because the IP is not registered in the DNS, it uses the Prime Performance Manager device name.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm restart
Syntax
/opt/CSCOppm-gw/bin/ppm restart [ jsp | pm | web ]
Command Description
Restarts Prime Performance Manager servers on the local host:
- jsp —Restarts Prime Performance Manager JSP Server.
- pm —Restarts Prime Performance Manager Application Server and all managed processes.
- web —Restarts Prime Performance Manager web Server.
If you do not specify a keyword, /opt/CSCOppm-gw/bin/ppm restart restarts all Prime Performance Manager servers.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm restore
Syntax
/opt/CSCOppm-gw/bin/ppm restore [ logs | reports | security ]
Command Description
Restores Prime Performance Manager data files from a previous backup, stored in Prime Performance Manager installation directory. If you installed Prime Performance Manager in:
- The default directory, /opt, then the locations of the backup files are /opt/ ppm10-Unit-ems-lnx001-backup.tar and /opt/ ppm10-gateway-ems-lnx001-backup.tar.
- A different directory, then the backup files reside in that directory.
You can restore data files on the same Solaris or Linux server; or, on a different Solaris or Linux server that is running Prime Performance Manager 1.x.
To restore only specific parts of Prime Performance Manager data files, use these keywords:
- logs —Restores only Prime Performance Manager log files, such as the message log files.
- reports —Restores only Prime Performance Manager report files, such as the statistics report files.
- security —Restores only the security-related parts of Prime Performance Manager data files. This command is useful if you inadvertently delete your user accounts or make other unwanted changes to your Prime Performance Manager security information.
Note If /opt/CSCOppm-gw/bin/ppm backupdays was previously used to set the number of backup days to more than one day, /opt/CSCOppm-gw/bin/ppm restore command prompts you for a server or client backup file to restore from. This is because there would be more than one backup file to choose from).
To change the directory in which Prime Performance Manager stores these backup files, use /opt/CSCOppm-gw/bin/ppm backupdir command.
The server is restarted automatically after running /opt/CSCOppm-gw/bin/ppm restore command.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topics
ppm restore all
Syntax
/opt/CSCOppm-gw/bin/ppm restore all [ nostart ]
Command Description
Restores all system files. The server must be restarted for the directory changes to take effect. This normally occurs after running the command. Enter the nostart option if you want to restart server at a later time.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm restoreprops
Command Description
Restores Prime Performance Manager server and client System.properties files and other important configuration files to the backup versions of the files.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm rootvars
Command Description
Displays the Prime Performance Manager gateway and unit root installation location, which is stored in the /etc/CSCOppm.sh file.
Available in GUI
Yes
ppm rpm
Syntax
/opt/CSCOppm-gw/bin/ppm rpm
Command Description
Displays Prime Performance Manager RPMs instlalled.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm sechelp
Syntax
/opt/CSCOppm-gw/bin/ppm sechelp
Command Description
Displays help for all commands that are related to Prime Performance Manager security.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topic
Chapter 6, “Managing Users and Security”
ppm seclog
Syntax
/opt/CSCOppm-gw/bin/ppm seclog [ clear | -r ]
Command Description
Uses PAGER to display the contents of the system security log.
These security events are recorded in the log:
- All changes to system security, including adding users.
- Log in attempts, whether successful or unsuccessful, and log offs.
- Attempts to switch to another user's account, whether successful or unsuccessful.
- Attempts to access files or resources of higher authentication level.
- Access to all privileged files and processes.
- Operating system configuration changes and program changes, at the Solaris level.
- Prime Performance Manager restarts.
- Failures of computers, programs, communications, and operations, at the Solaris level.
To clear the log, enter /opt/CSCOppm-gw/bin/ppm seclog clear.
To display the contents of the log in reverse order, with the most recent security events at the beginning of the log, enter /opt/CSCOppm-gw/bin/ppm seclog -r.
The default path and filename for the system security log file is /opt/CSCOppm-gw/logs/sgmSecurityLog.txt. If you installed Prime Performance Manager in a directory other than /opt, then the system security log file resides in that directory.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Displaying the System Security Log
ppm serverclocktolerance
Syntax
/opt/CSCOppm-gw/bin/ppm serverclocktolerance [ secs ]
Command Description
Sets the number of seconds timing between Prime Performance Manager and a server can be out of synchronization before an alarm is raised. The default is 900 seconds.
Available in GUI
No
ppm servername
Syntax
/opt/CSCOppm-gw/bin/ppm servername [ hostname ] [nostopstart]
Command Description
Command resets Prime Performance Manager server default hostname, where hostname is the new default hostname.
- Verify that the new default hostname is valid and defined in your /etc/hosts file. If not, you might not be able to start the Prime Performance Manager server.
- Verify that the IP address of the resolved server name is the same to connect the gateway name.
- You must log in as root/super user to run this command.
- nostopstart - The server is not stopped and started automatically while running this command.
Available in GUI
No
Related Topic
ppm setpath
Syntax
/opt/CSCOppm-gw/bin/ppm setpath [ username ]
Command Description
Appends binary (bin) directories to the user path so users can append Prime Performance Manager binary directories to their paths without manually editing the .profile and .cshrc files.
This command appends lines such as these to the user's .profile file:
PATH=$PATH:/opt/CSCOppm-gw/bin:/opt/CSCOppm-gw Client/bin # CiscoPPM
and appends lines such as these to the user's .cshrc file:
set path=($path /opt/CSCOppm-gw/bin /opt/CSCOppm-gw Client/bin) # CiscoPPM
Thereafter, you can enter Prime Performance Manager commands as:
/opt/CSCOppm-gw/bin/ppm help
When entering this command, remember that:
- If you enter this command and you do not specify a username, Prime Performance Manager appends the bin directories to your path (that is, to the path for the user who is currently logged in and entering /opt/CSCOppm-gw/bin/ppm setpath command).
- If you enter this command and you specify a username, Prime Performance Manager appends the bin directories to the path for the specified user. To specify a username, follow these conditions:
– You must log in as the root/super user.
– The specified username must exist in the local /etc/passwd file.
– You cannot specify a username that is defined in a distributed Network Information Services (NIS) system or in an Network File System-mounted (NFS-mounted) home directory.
- If you enter this command more than once for the same user, each command overwrites the previous command. Prime Performance Manager does not append multiple bin directories to the same path.
Available in GUI
No
ppm setpctrapdestination
Syntax
/opt/CSCOppm-gw/bin/ppm setpctrapdestination
Command Description
After you integrate Prime Performance Manager with Prime Central, this command allows you to change the default trap destination. After integration, traps are sent to the Prime Central Fault Management. This command allows you to change the trap destination to Prime Network. When you run the command, output similar to the following is displayed:
Trap destinations registered with Prime Central:
1. Prime Fault Management (hostname)
2. Prime Network (hostname)
Enter trap destination: [1, 2] 2
Prime Performance is sending traps to: Prime Network
Available in GUI
No
ppm setservicerole
Syntax
/opt/CSCOppm-gw/bin/ppm setservicerole [primary | secondary ]
Command Description
In an High Availability (HA) configuration, sets the primary and secondary servers.
Available in GUI
No
ppm showcreds
Syntax
/opt/CSCOppm-gw/bin/ppm showcreds -i ipaddress/hostname
Command Description
Displays the Telnet and SSH device credentials on the Prime Performance Manager gateway.
-i ipaddress/hostname —The IP address or hostname of the device (required)
Available in GUI
Yes
ppm showsnmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm showsnmpcomm [ -i ipaddress ]
Command Description
Shows the specified SNMP configuration, or all SNMP configurations, on Prime Performance Manager server.
-i ipaddress —the IP address of the device (optional). If not specified, displays all SNMP configurations on the server.
Available in GUI
Yes
Related Topics
ppm showunitconf
Syntax
/opt/CSCOppm-gw/bin/ppm showunitconf [-i (ipaddress)]
Command Description
Shows the configuration that specifies the relationship between nodes and their managed units.
-i ipaddress - IP address of the node is optional. If not specified, displays all configured entries on the server.
Available in GUI
Yes
Note If a node is not specified in the configuration, it means the node will be managed by the default unit. The default unit is the unit which connects to the gateway first.
ppm shutdown
Syntax
/opt/CSCOppm-gw/bin/ppm shutdown
Command Description
This command will completely shutdown the hardware system.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm singlesess
Syntax
/opt/CSCOppm-gw/bin/ppm singlesess [enable | disable | block | status]
Command Description
Defines whether a user can log into multiple web interface sessions.
- enable—Only a single session is allowed per user. If a user logs into a second web interface session, the first session is ended.
- disable—Disables the single session per user restriction. The user can log in as the same user from multiple web interfaces.
- block —Only a single session is allowed per user. If a user attempts to log into a second web interface session, they are blocked until they close the first session.
- status—Shows the status of the single session per user.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm smallcellver
Syntax
/opt/CSCOppm-gw/bin/ppm smallcellver
Command Description
Prints versions for small cell counter compliance.
Available in GUI
No
ppm snmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm snmpcomm [ name ]
Command Description
Sets a new default SNMP read community name. Prime Performance Manager automatically updates the name in the SNMP parameters file. The default path and filename for the SNMP parameters file is /opt/CSCOppm-gw/etc/communities.conf.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm snmpconf
Syntax
/opt/CSCOppm-gw/bin/ppm snmpconf [ filename ]
Command Description
Sets the file used for SNMP parameters, such as community names, timeouts, and retries.
The default path and filename for the SNMP parameters file is /opt/CSCOppm-gw/etc/communities.conf. If you installed Prime Performance Manager in a directory other than /opt, then the file resides in that directory.
When you specify a new path or filename, Prime Performance Manager restarts the servers.
Note The SNMP parameters file uses the HP OpenView format; therefore, you can set this path and filename to point to the HP OpenView ovsnmp.conf file in an existing OpenView system. For information about exporting SNMP community names from CiscoWorks Resource Manager Essentials (RME).
You must log in as the root/super user to use this command.
Available in GUI
No
ppm snmpget
Syntax
/opt/CSCOppm-gw/bin/ppm snmpget [ -J JVM_ARG1 [ -J JVM_ARG2 ]...] [ -v snmp_version ] [ -c community_string ] [ -r retry ] [ -t timeout ] [ -d output_delimiter ] [ -u snmpv3_username ] [ -a authentication protocol | -A authentication password ] [ -p privacy protocol | -P privacy password ] [ --header | --no-header ] [ --raw-octets | --no-raw-octets ] [ --str-octets | --no-str-octets ] [ --raw-timeticks | --no-raw-timeticks ] [ --resolve-integer | --no-resolve-integer ] [ --resolve-bits | --no-resolve-bits ] [ --get-sysuptime | --no-get-sysuptime ] [ --instance oids ] [ --int-instance integer ] [ --str-instance string ] [ hostname ] [ oid ] [ oid ]...
Command Description
Queries the specified hostname by using SNMP GetRequests. Use these optional keywords and arguments with this command:
- -J JVM_ARG1 —JVM options. You must specify the -J keyword and arguments before any other keywords and arguments.
For example, by default JVM uses a maximum of 64 MB of memory. However, if you are working in a large table, JVM might require more memory. To enable JVM to use a maximum of 256 MB of memory, use this syntax:
-J-Xmx256m
- -v snmp_version —SNMP protocol version. Valid versions are 1, 2c, or 3. The default version is 2c.
- -c community_string —SNMP community string. You specify the default community string in the SNMP parameters file, communities.conf.
- -u snmpv3_username —The SNMP username. The username is required for SNMP v3.
- -a authentication_protocol —The authentication protocol.
- -A authentication_password —The authentication password.
- -p privacy_protocol —The privacy protocol.
- -P privacy_password —The privacy password.
- -r retry —SNMP retry count. You specify the default retry count in the SNMP parameters file, communities.conf.
- -t timeout —SNMP timeout, in seconds. You specify the default timeout in the SNMP parameters file, communities.conf.
- -d output_delimiter —Output delimiter. The default output delimiter is a colon (:).
- --header | --no-header —Specifies whether to display variable names as table headers:
– Specify --header to display variable names as table headers for tabular output, or to display MIB variable OIDs with the value for nontabular output. This is the default setting.
– Specify --no-header if you do not want to display variable names as table headers for tabular output, or MIB variable OIDs with the value for nontabular output.
- --raw-octets | --no-raw-octets —Specifies whether to display octets as raw octets:
– Specify --raw-octets to display raw octets, such as 6c 69 6e 6b, for octet strings.
– Specify --no-raw-octets if you do not want to display raw octets for octet strings. This is the default setting.
The other option for displaying octets is --str-octets | --no-str-octets.
- --str-octets | --no-str-octets —Specifies whether to display octets as strings:
– Specify --str-octets to display octets as strings, such as link. This is the default setting.
– Specify --no-str-octets if you do not want to display octets as strings.
The other option for displaying octets is --raw-octets | --no-raw-octets.
- --raw-timeticks | --no-raw-timeticks —Specifies the time format:
– Specify --raw-timeticks to specify raw timeticks, such as 2313894.
– Specify --no-raw-timeticks to specify formatted timeticks, such as 6 Hours 26 Mins 12 Secs. This is the default setting.
- --resolve-integer | --no-resolve-integer —Specifies the time format. Use:
– --resolve-integer to display integers using the string description in the MIB, such as available or unavailable.
– --no-resolve-integer to display integers as numbers. This is the default setting.
- --resolve-bits | --no-resolve-bits —Specifies the time format. Use:
– --resolve-bits to display bits using the string description in the MIB, such as continue or ruleset.
– --no-resolve-bits to display bits as numbers, such as 1 or 14. This is the default setting.
- --get-sysuptime | --no-get-sysuptime —Specifies whether to retrieve the sysuptime. Use:
– --get-sysuptime to retrieve the sysuptime in the same packet as each SNMP operation.
– --no-get-sysuptime if you do not want to retrieve the sysuptime in the same packet. This s the default setting.
- --instance oids —Appends instance OIDs to each polling MIB variable. For example, these commands perform the same function:
ppm snmpget --instance 172.18.16.10 node_1 ipAdEntIfIndex ipAdEntNetMask
ppm snmpget node_1 ipAdEntIfIndex.172.18.16.10 ipAdEntNetMask.172.18.16.10
- --int-instance integer —Appends the specified integer instance OID to each polling MIB variable.
- --str-instance string —Appends string instance OIDs to each polling MIB variable; for example, these commands perform the same function:
ppm snmpget --str-instance link_1 node_1 cItpSpLinksetState
ppm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
- hostname —Name of the host to query.
- oid —One or more OIDs or variable names.
The default path for the SNMP parameters file, communities.conf, is /opt/CSCOppm-gw/etc/
communities.conf. If you installed Prime Performance Manager in a directory other than /opt, then the file resides in that directory. You can edit the file manually or using Prime Performance Manager web interface.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm snmphelp
Syntax
/opt/CSCOppm-gw/bin/ppm snmphelp
Command Description
Displays help for all commands that are related to SNMP queries.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm snmpmaxrows
Syntax
/opt/CSCOppm-gw/bin/ppm snmpmaxrows [ number-of-rows ]
Command Description
Sets the value of maximum rows for SNMP walk.
Prime Performance Manager collects network information from device MIBs using SNMP protocol. In certain ITP networks, some MIB tables can be very large (such as GTT tables, MTP3 accounting statistics tables, etc.)
The default value of 100,000 rows is usually sufficient even for large networks. However, for very large networks, if the limit needs to be increased, you can customize the this parameter. It is not recommended to exceed 300,000 rows.
If you enter this command without the number-of-rows argument, Prime Performance Manager displays the current maximum number of rows. You can then change that value or leave it. The valid range is 1 row to an unlimited number of rows. However, it is not recommended to set this number at less than 10,000. The default value is 100,000 rows.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm snmpnext
Syntax
ppm snmpnext [ -J JVM_ARG1 [ -J JVM_ARG2 ]...] [ -v snmp_version ] [ -c community_string ] [ -r retry ] [ -t timeout ] [ -d output_delimiter ] [ -u snmpv3_username ] [ -a authentication protocol | -A authentication password ] [ -p privacy protocol | -P privacy password ] [ --header | --no-header ] [ --raw-octets | --no-raw-octets ] [ --str-octets | --no-str-octets ] [ --raw-timeticks | --no-raw-timeticks ] [ --resolve-integer | --no-resolve-integer ] [ --resolve-bits | --no-resolve-bits ] [ --get-sysuptime | --no-get-sysuptime ] [ --instance oids ] [ --int-instance integer ] [ --str-instance string ] [ hostname ] [ oid ] [ oid ]...
Command Description
Queries the specified hostname by using SNMP GetNextRequests. Use these optional keywords and arguments with this command:
- -J JVM_ARG1 —JVM options. You must specify the -J keyword and arguments before any other keywords and arguments.
For example, by default JVM uses a maximum of 64 MB of memory; however, if you explore a large table, JVM might require more memory. To enable JVM to use a maximum of 256 MB of memory, use this option:
-J-Xmx256m
- -v snmp_version —SNMP protocol version. Valid versions are 1, 2c, or 3. The default version is 2c.
- -c community_string —SNMP community string. You specify the default community string in the SNMP parameters file, communities.conf.
- -u snmpv3_username —The SNMP username. The username is required for SNMP v3.
- -a authentication_protocol —The authentication protocol.
- -A authentication_password —The authentication password.
- -p privacy_protocol —The privacy protocol.
- -P privacy_password —The privacy password.
- -r retry —SNMP retry count. You specify the default retry count in the SNMP parameters file, communities.conf.
- -t timeout —SNMP timeout, in seconds. You specify the default timeout in the SNMP parameters file, communities.conf.
- -d output_delimiter —Output delimiter. The default output delimiter is a colon (:).
- --header | --no-header —Specifies whether to display variable names as table headers:
– Specify --header to display variable names as table headers for tabular output or MIB variable OIDs with the value for nontabular output. This is the default setting.
– Specify --no-header if you do not want to display variable names as table headers for tabular output or MIB variable OIDs with the value for nontabular output.
- --raw-octets | --no-raw-octets —Specifies whether to display octets as raw octets. Use:
– --raw-octets to display raw octets, such as 6c 69 6e 6b, for octet strings.
– --no-raw-octets if you do not want to display raw octets for octet strings. This is the default setting.
The other option for displaying octets is --str-octets | --no-str-octets.
- --str-octets | --no-str-octets —Specifies whether to display octets as strings. Use:
– --str-octets to display octets as strings, such as link. This is the default setting.
– --no-str-octets if you do not want to display octets as strings.
The other option for displaying octets is --raw-octets | --no-raw-octets.
- --raw-timeticks | --no-raw-timeticks —Specifies the time format:
– Specify --raw-timeticks to specify raw timeticks, such as 2313894.
– Specify --no-raw-timeticks to specify formatted timeticks, such as 6 Hours 26 Mins 12 Secs. This is the default setting.
- --resolve-integer | --no-resolve-integer —Specifies the time format. Use:
– --resolve-integer to display integers using the string description in the MIB, such as available or unavailable.
– --no-resolve-integer to display integers as numbers. This is the default setting.
- --resolve-bits | --no-resolve-bits —Specifies the time format:
– Specify --resolve-bits to display bits using the string description in the MIB, such as continue or ruleset.
– Specify --no-resolve-bits to display bits as numbers, such as 1 or 14. This is the default setting.
- --get-sysuptime | --no-get-sysuptime —Specifies whether to retrieve the sysuptime. Use:
– --get-sysuptime to retrieve the sysuptime in the same packet as each SNMP operation.
– --no-get-sysuptime if you do not want to retrieve the sysuptime in the same packet. This is the default setting.
- --instance oids —Appends instance OIDs to each polling MIB variable. For example, these commands perform the same function:
ppm snmpget --instance 172.18.16.10 node_1 ipAdEntIfIndex ipAdEntNetMask
ppm snmpget node_1 ipAdEntIfIndex.172.18.16.10 ipAdEntNetMask.172.18.16.10
- --int-instance integer —Appends the specified integer instance OID to each polling MIB variable.
- --str-instance string —Appends string instance OIDs to each polling MIB variable. For example, these commands perform the same function:
ppm snmpget --str-instance link_1 node_1 cItpSpLinksetState
ppm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
- hostname —Name of the host to be queried.
- oid —One or more OIDs or variable names.
The default path for the SNMP parameters file, communities.conf, is /opt/CSCOppm-gw/etc/communities.conf. If you installed Prime Performance Manager in a directory other than /opt, then the file resides in that directory. You can edit the file manually or by using Prime Performance Manager client.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm snmpwalk
Syntax
/opt/CSCOppm-gw/bin/ppm snmpwalk [ -J JVM_ARG1 [ -J JVM_ARG2 ]...] [ -v snmp_version ] [ -c community_string ] [ -r retry ] [ -t timeout ] [ -x maximum_rows ] [ -d output_delimiter ] [ -u snmpv3_username ] [ -a authentication protocol | -A authentication password ] [ -p privacy protocol | -P privacy password ] [ --tabular | --no-tabular ] [ --getbulk | --no-getbulk ] [ --header | --no-header ] [ --raw-octets | --no-raw-octets ] [ --str-octets | --no-str-octets ] [ --raw-timeticks | --no-raw-timeticks ] [-- date-timeticks|--no-date-timeticks ] [-- date-format date_format ] [ --resolve-integer | --no-resolve-integer ] [ --resolve-bits | --no-resolve-bits ] [ --get-sysuptime | --no-get-sysuptime ] [ --instance oids ] [ --int-instance integer ] [ --str-instance string ] [ hostname ] [ oid ] [ oid ]...
Command Description
Queries the specified hostname by using SNMP GetNextRequests to go through the MIB. Use these optional keywords and arguments with this command:
- -J JVM_ARG1 —JVM options. You must specify the -J keyword and arguments before any other keywords and arguments.
For example, by default JVM uses a maximum of 64 MB of memory; however, if you are going through a large table, JVM might require more memory. To enable JVM to use a maximum of 256 MB of memory, use this option:
-J-Xmx256m
- -v snmp_version —SNMP protocol version. Valid versions are 1, 2c, or 3. The default version is 2c.
- -c community_string —SNMP community string. You specify the default community string in the SNMP parameters file, communities.conf.
- -u snmpv3_username —The SNMP username. The username is required for SNMP v3.
- -a authentication_protocol —The authentication protocol.
- -A authentication_password —The authentication password.
- -p privacy_protocol —The privacy protocol.
- -P privacy_password —The privacy password.
- -r retry —SNMP retry count. You specify the default retry count in the SNMP parameters file, communities.conf.
- -t timeout —SNMP timeout, in seconds. You specify the default timeout in the SNMP parameters file, communities.conf.
- -x maximum_rows —Maximum number of rows to go through. If a table has more than the maximum number of rows, ppm snmpwalk command fails. You can use the -m keyword and argument to increase the maximum number of rows to go through. The default setting is 10,000 rows.
However, for every 10,000 rows gone through, JVM requires an additional 10 MB of memory. You can use the -J keyword and argument to increase the memory available to JVM.
- -d output_delimiter —Output delimiter. The default output delimiter is a colon (:).
- --tabular | --no-tabular —Specifies whether to print the result of the query in tabular format. Use:
– --tabular to print the result in tabular format. This is the default setting.
– --no-tabular if you do not want to print the result in tabular format.
- --getbulk | --no-getbulk —(SNMP version 2c only) Specifies whether to use the getbulk command to go through the table. Use:
– --getbulk to use the getbulk command. This is the default setting.
– --no-getbulk if you do not want to use the getbulk command.
- --header | --no-header —Specifies whether to display variable names as table headers. Use:
– --header to display variable names as table headers for tabular output or to display MIB variable OIDs with the value for nontabular output. This is the default setting.
– --no-header if you do not want to display variable names as table headers for tabular output or MIB variable OIDs with the value for nontabular output.
- --raw-octets | --no-raw-octets —Specifies whether to display octets as raw octets. Use:
– --raw-octets to display raw octets, such as 6c 69 6e 6b, for octet strings.
– --no-raw-octets if you do not want to display raw octets for octet strings. This is the default setting.
The other option for displaying octets is --str-octets | --no-str-octets.
- --str-octets | --no-str-octets —Specifies whether to display octets as strings. Use:
– --str-octets to display octets as strings, such as link. This is the default setting.
– --no-str-octets if you do not want to display octets as strings.
The other option for displaying octets is --raw-octets | --no-raw-octets.
- --raw-timeticks | --no-raw-timeticks —Specifies the time format. Use:
– --raw-timeticks to specify raw timeticks, such as 2313894.
– --no-raw-timeticks to specify formatted timeticks, such as 6 Hours 26 Mins 12 Secs. This is the default setting.
- -date-timeticks|-no-date-timeticks - Specifies format timetick data in date format. Use:
– -date-timeticks to format timetick data in date format, such as 2015-09-16 00:03:45
– -no-date-timeticks to use default timeticks format, such as 6 Hours 26 Mins 12 Secs. This is the default setting.
Note: -raw-timeticks overrides -date-timeticks.
- -date-format date_format - Specifies date format to use when -date-timeticks is specified. Use:
– -date-format "yyyy-MM-dd HH:mm:ss" to specify format to use. The example in quotes will render "2015-09-16 00:03:45" format which is the default.
Note: Any Java SimpleDateFormat format strings are acceptable for the double quoted format.
- --resolve-integer | --no-resolve-integer —Specifies the time format. Use:
– --resolve-integer to display integers using the string description in the MIB, such as available or unavailable.
– --no-resolve-integer to display integers as numbers. This is the default setting.
- --resolve-bits | --no-resolve-bits —Specifies the time format. Use:
– --resolve-bits to display bits using the string description in the MIB, such as continue or ruleset.
– --no-resolve-bits to display bits as numbers, such as 1 or 14. This is the default setting.
- --get-sysuptime | --no-get-sysuptime —Specifies whether to retrieve the sysuptime. Use:
– --get-sysuptime to retrieve the sysuptime in the same packet as each SNMP operation.
– --no-get-sysuptime if you do not want to retrieve the sysuptime in the same packet. This is the default setting.
- --detect-mib-error —Detects errors in returned MIB variables, such as noSuchInstance, noSuchObject, and endOfMibView. If the system detects any such errors, an error message and error code appear.
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
– Specified --detect-mib-error, none of the correct values appear, only the error message and an error code is returned.
– Did not specify --detect-mib-error, a return code of 0 and all MIB variables appear; even noSuchInstance appears as a returned value. This is the default setting, with --detect-mib-error not specified.
- --instance oids —Appends instance OIDs to each polling MIB variable. For example, these commands perform the same function:
ppm snmpget --instance 172.18.16.10 node_1 ipAdEntIfIndex ipAdEntNetMask
ppm snmpget node_1 ipAdEntIfIndex.172.18.16.10 ipAdEntNetMask.172.18.16.10
- --int-instance integer —Appends the specified integer instance OID to each polling MIB variable.
- --str-instance string —Appends string instance OIDs to each polling MIB variable. For example, these commands perform the same function:
ppm snmpget --str-instance link_1 node_1 cItpSpLinksetState
ppm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
- hostname —Name of the host to query.
- oid —One or more OIDs or variable names.
The default path for the SNMP parameters file, communities.conf, is /opt/CSCOppm-gw/etc/communities.conf. If you installed Prime Performance Manager in a directory other than /opt, then the file resides in that directory. You can edit the file manually or using Prime Performance Manager client.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm ssl
Syntax
/opt/CSCOppm-gw/bin/ppm ssl [ enable | disable | status ]
Command Description
If you enable the SSL on Prime Performance Manager and you have an SSL key-certificate pair on Prime Performance Manager, you can use this command to manage SSL support in Prime Performance Manager:
- enable —Enables SSL support.
- disable —Disables SSL support.
- status —Displays the current status of SSL support in Prime Performance Manager, including whether you enabled or disabled SSL support, and which SSL keys and certificates exist.
You must log in as the root/super user to use this command.
Available in GUI
no
Related Topic
Managing Users and User Security
ppm sslstatus
Syntax
/opt/CSCOppm-gw/bin/ppm sslstatus
Command Description
Displays the current status for SSL that Prime Performance Manager supports, including whether you enabled or disabled SSL support; and, which SSL keys and certificates exist.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Managing Users and User Security
ppm sslver
Syntax
/opt/CSCOppm-gw/bin/ppm sslver
Command Description
Displays the version of openSSL that is used.
Available in GUI
No
ppm starbuild
Syntax
/opt/CSCOppm-gw/bin/ppm starbuild [{ schemafilename | default } ppm | no | zero ]
Command Description
Sets up bulk statistics reporting configurations for Cisco ASR 5000 and Cisco ASR 5500 devices.
- schemafilename—The schema file name containing the bulk statistics schema you want to use
- default—Generates a configuration for all counters and all schemas supported by Prime Performance Manager. The default file is:
/opt/CSCOppm-gw/install/ASR5K_BulkStats_StarOS_Schema_Counters.csv
- ppm —Creates the configuration file to enable the Cisco ASR 5000 and Cisco ASR 5500 device to generates bulk statistics in the format expected by Prime Performance Manager.
- no —Removes the device configuration.
- zero —Sets the configuration to zero.
A sample command sequence using the default option is shown below:
ppm17-demo> ppm starbuild default
Enter IP Address of PPM Unit To Send Files To: 1.2.3.4
Enter File Directory On PPM Unit To Drop Files To: /opt/csvdrop
Enter Output Filename To Write StarOS Config To: staros-config
StarOS Config File Written To: staros-config
You must log in as the root/super user to use this command.
Related Topic
Setting Up StarOS Bulk Statistics Reports
ppm starexpcollectioninterval starttime
Syntax
ppm starexpcollectioninterval starttime [enable|disable|status]
Command Description
Enables, disables, or checks the status of the StarOS Direct Conversion Export using Start Time Collection Interval. If enabled, Prime Performance Manager will consider the start time of the collection interval as the reporting interval. The command sets the EXPORT_START_COLLECTION_INTERVAL_ENABLED property in /opt/CSCOppm-unit/properties/BulkStats.properties.
The default value is disabled.
You do not need to restart Prime Performance Manager server. The command is only supported on units.
Available in GUI
No
ppm starcollectioninterval starttime
Syntax
ppm starcollectioninterval starttime [enable|disable|status]
Command Description
Enables, disables or checks the status of the StarOS Bulk Statistics Reporting using Start Time Collection Interval. If enabled, Prime Performance Manager will consider the start time of the collection interval as the reporting interval. The command sets the START_COLLECTION_INTERVAL_ENABLED property in /opt/CSCOppm-unit/properties/BulkStats.properties.
The default value is disabled.
You do not need to restart Prime Performance Manager server. The command is only supported on units.
Available in GUI
No
ppm stardiffs
Syntax
/opt/CSCOppm-gw/bin/ppm stardiffs [ ipaddress ]
Command Description
Finds differences between the StarOS install CSV and the polled CSV. Polls StarOS version if IP is provided.
Available in GUI
No
ppm stargenall
Syntax
/opt/CSCOppm-gw/bin/ppm stargenall
Command Description
Polls, diffs, and generates the StarOS schema file and regenerates all counter pollers with new counter information.
Available in GUI
No
ppm stargenschema
Syntax
/opt/CSCOppm-gw/bin/ppm stargenschema <ipaddress/hostname> [all]
Command Description
This command updates bulkstatsschema.csv schema with new bulkstats variable information in a StarOS release. It runs the command, show bulkstats variables, on the device entered as the argument, compares the device output with bulkstats variables information in /opt/CSCOppm-gw/install/ASR5K_BulkStats_StarOS_Schema_Counters.csv, and identifies the differences, for example, new schemas, new bulkstats variables, and other changes. The differences are updated in the /opt/CSCOppm-gw/install/ASR5K_BulkStats_StarOS_Schema_Counters.csv, and a bulkstatsschema.csv file is generated with the new bulkstats variables.
- ipaddress/hostname —The IP address or hostname of the Cisco ASR 5000, Cisco ASR 5500, or Cisco Quantum Virtualized Packet Core (QvPC) device in Prime Performance Manager. The StarOS release must be loaded on the device. Also, the device must have an Active status and valid Telnet/SSH credentials so show commands can run on it.
- [all] —(optional) Identifies the data type gauge/counter, obsolete counter, and removed bulkstats variable differences found in the StarOS release and updates the /opt/CSCOppm-gw/install/ASR5K_BulkStats_StarOS_Schema_Counters.csv. Use this option only if required because the option could change the way the Prime Performance Manager reads the StarOS bulkstats files.
As an intermediate step the command generates the Prime Performance Manager StarOS config file with the new bulkstats variables, which you can use to configure the new schemas or bulkstats variables on the device.
After the command finishes, you can copy the generated bulkstatsschema.csv schema file to /opt/CSCOppm-gw/etc/. This updates the Prime Performance Manager in-memory schema counters list with the new counter information from /opt/CSCOppm-gw/etc/bulkstatsschema.csv. Make a copy of the file before loading a new version.
Note This command has potential risks for StarOS report processing. Verify the device you provide has a valid StarOS release image as the contents of bulkstatsschema.csv. If not, the /opt/CSCOppm-gw/install/ASR5K_BulkStats_StarOS_Schema_Counters.csv could receive invalid information and jeopardize its ability to parse StarOS bulkstats files correctly.
The command supported only on the gateway.
Available in GUI
No
ppm start
Syntax
/opt/CSCOppm-gw/bin/ppm start
Command Description
Starts the Prime Performance Manager gateway and unit (if installed on the same machine).
You must log in as the root/super user to use this command.
Available in GUI
No
Note If the database has an exception during start up, the gateway and unit (if installed) will not start.
Related Topic
Managing Gateways and Units Using the CLI
ppm starexp
Syntax
/opt/CSCOppm-unit/bin/ppm starexp [enable | disable | status]
Command Description
Enables, disables or checks the status of the StarOS Direct Conversion Export on the unit server. If enabled, the StarOS input Bulk Statistics CSV files are converted to 3GPP XML files or CSV files with deltas calculations. The command changes the EXPORT_ENABLED property in /opt/CSCOppm-unit/properties/BulkStats.properties. The default value is disabled.
You do not need to restart Prime Performance Manager server. The command is only supported on units.
Available in GUI
No
ppm starexpdropdir
Syntax
/opt/CSCOppm-unit/bin/ppm starexpdropdir [dir]
Command Description
Sets the StarOS export drop directory for collecting the converted bulk statistics files and updates the EXPORT_DROP_DIR property in /opt/CSCOppm-unit/properties/BulkStats.properties. You do not need to restart Prime Performance Manager server. The command is only supported on units.
Available in GUI
No
Related Topics
ppm starexprules
Syntax
/opt/CSCOppm-unit/bin/ppm starexprules {3gppxml|3gppxmldeltas|csvdeltas}
Command Description
Sets the StarOS direct conversion export rules for converting the input CSV Bulk Statistics files. Valid options are 3GPP XML files with or without delta calculations or CSV files with Delta calculations. It updates the EXPORT_RULE property in /opt/CSCOppm-unit/properties/BulkStats.properties. Default option is 3GPP XML with delta calculations. You do not need to restart Prime Performance Manager server. The command is only supported on units.
Available in GUI
No
Related Topics
ppm starexpxmlformat
Syntax
/opt/CSCOppm-unit/bin/ppm starexpxmlformat {allinone|oneperfile}
Command Description
Sets the StarOS direct conversion export formats for converting the input CSV Bulk Statistics files. This option is specific for 3GPP XML rule and controls if all StarOS Bulk Statistics schema is saved in the same XML file or if a new XML file is created for each schema. It updates the EXPORT_3GPP_XML_FORMAT property in /opt/CSCOppm-unit/properties/BulkStats.properties. Default option is All Schemas in one XML file. You do not need to restart Prime Performance Manager server. The command is only supported on units.
Available in GUI
No
Related Topics
ppm statreps bulkstatsexpage
Syntax
/opt/CSCOppm-gw/bin/ppm statreps bulkstatsexpage [days]
Command Description
Specifies the number of days StarOS direct conversion export files are retained in Prime Performance Manager server. The default is 14 days. You do not need to restart Prime Performance Manager server. This command is supported only on the gateway.
Available in GUI
Yes
Related Topics
ppm statreps
Full Syntax
/opt/CSCOppm-gw/bin/ppm statreps [none] [default] [all] [enable | disable] [noexport | export] [nogenerate | generate] status, [status [node]] status config, status reps, config, reps, [setstatus[category | all ] [enable | disable] [ interval ], [setstatus [categoryy | all ] [enable | disable] [node | interval ]], [5min [enable|disable|enableall]], [15min [enable|disable|enableall]], [hourly [enable|disable|enableall]], [hourly [enable|disable|enableall]], [daily [enable |disable|enableall]], [weekly [enable |disable|enableall]], [monthly [enable |disable|enableall]], [5mincsvage [days]], [15mincsvage [days]], [hourlycsvage [days]], [dailycsvage [days]], [weeklycsvage [days]], [monthlycsvage [days]][5minage [days]], [15minage [days]], [hourlyage [days]], [dailyage [days]], weeklyage [days]], monthlyage [days]],[ nodiskcheck | diskcheck], [timemode [12 | 24]], [csvnames [ ppm | 3gpp ]], [csvdevtypes [ enable | disable]], [expformat [ xml]], [nametype[dnsname] [customname | sysname]], [csvtype [ allnodes | pernodeuniq]], [zipcsvdelay [mins]] [zipcsvfiles [internal | script]] [zipcsvnotifscript [path | disable]] [show | hide [ xmlfilename ] ]
This command defines the master report settings. Optionally, you can specify a hostname or IP address to enable or disable the specified report for a specific device. For example the following command enables CPU reports for the device with the IP address specified in ip address.
ppm statreps cpu <ip address>
If you specify a command in which the hostname or IP address is not applicable, the host parameter is ignored and does not cause an error.
Command Description
[enable | disable]—Enable or disable the master report.
[all ]—Enable all report types.
[default ]—Enable all default report types.
[none ]—Disable all report types.
[noexport | export ]—Enable or disable all csv files.
[ nogenerate | generate }—Generate database reports
status—Display network report settings.
status [ node]—Display node report settings.
status config—Display master report configuration settings.
status reps—Display individual report enable status.
config—Display master report configuration settings.
reps—Display individual report enable status.
setstatus [[category | all ] [enable | disable] [ interval ]—Enable or disable network report settings, where interval = 1min, 5min, 15min, hourly, daily, weekly, monthly, db, csv.
setstatus [[category | all ] [ enable | disable ] [ node | interval ]]—Enable or disable device report settings, where interval = 1min, 5min, 15min, hourly, daily, weekly, monthly, db, csv.
1min [enable | disable | enableall]—Enable, disable, or enable all 1 minute master report.
5min [enable | disable | enableall]—Enable, disable, or enable all 5 minute master report.
15min [enable | disable] | enableall—Enable, disable, or enable all 15 minute master report.
hourly [enable | disable | enableall]—Enable, disable, or enable all hourly master report.
daily [enable | disable] | enableall—Enable, disable, or enable all daily master report.
weekly [enable | disable] | enableall—Enable, disable, or enable all weekly master report.
monthly [enable | disable] | enableall—Enable, disable, or enable all monthly master report.
5mincsvage [days]—Specifies the days to keep 5 min csv files.
15mincsvage [days]—Specifies the days to keep 15 min csv files.
hourlycsvage [days]—Specifies the days to keep hourly csv files.
dailycsvage [days]—Specifies the days to keep daily csv files.
weeklycsvage [days]—Specifies the days to keep weekly csv files.
monthlycsvage [days]—Specifies the days to keep monthly csv files.
ppm statreps bulkstatsage [days]—Specifies the days to keep bulk statistics import files.
5minage [days]—Specifies the days to keep 5min data.
15minage [days]—Specifies the days to keep 15min data.
hourlyage [days]—Specifies the days to keep hourly data.
dailyage [days]—Specifies the days to keep daily data.
weeklyage [days]—Specifies the days to keep weekly data.
monthlyage [days]—Specifies the days to keep monthly data.
ppm statreps [ nodiskcheck | diskcheck ]—Enables or disables disk space monitoring.
timemode [12 | 24]—Display in 12 or 24 hour time.
csvnames [ ppm | 3gpp ]—Specifies the format for csv file names, either ppm (CSV) or 3rd Generation Partnership Program (3GPP).
csvdevtypes [ enable | disable ]—If enabled, the device type is included as the third column in all CSV exported files.
expformat [ xml ]—Specifies the export format as XML.
nametype [dnsname | customname | sysname]—Specifies the device name type for csv files.
csvtype [allnodes | pernodeuniq]—Specifies the combined or pernode csv Files.
zipcsvdelay [mins] —Specifies the minutes to wait before zipping csv files.
zipcsvfiles [internal | script]—Zips CSV files using the Prime Performance Manager internal process or a script.
zipcsvnotifscript [path | disable]—Allows you to call another script after the CSV file is zipped, for example, for auditing.
show | hide [ xml file name ]—Enables the RMS 4G AP All Counters (rms4GApAllCounters.xml) or RMS All Counters report (rmsApPerfAllCounters.xml) small cell reports. The reports store over 450 columns for 3G and over 1500 columns for 4G in one table. They are purposefully disabled because their size and system resource requirements make display in the Prime Performance Manager GUI impractical. However, these commands, which are intended for lab and testing environments, allow you to enable the reports so you can export the data from these reports to CSV files.
Available in GUI
- nodiskcheck, diskcheck, and timemode options: Yes
- All other options: No
Related Topic
Customizing General Report Settings
ppm status
Syntax
/opt/CSCOppm-gw/bin/ppm status
Command Description
Displays the status of all Prime Performance Manager servers on the local host.
Available in GUI
Yes
Related Topic
Chapter 3, “Managing the Web Interface”
ppm smtpport
Syntax
/opt/CSCOppm-gw/bin/ppm stmpport [ port #)
Command Description
Changes the STMP mail server port for sending alarm e-mails. The default is 25.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topic
Configuring Alarms Send to E-mail Addresses
ppm superuser
Syntax
/opt/CSCOppm-gw/bin/ppm superuser [ username ]
Command Description
Displays all the commands that superuser can perform on the gateway and units files. The command also changes the Linux user account used to perform Superuser functions which by default are required to perform the root user account. This user account must exist in the local /etc/passwd file. It is not possible to assign these functions to a user defined in a remote authentication service such as NIS. After the Superuser functions are assigned to another user account this user account can perform all functions such as starting and stopping the server, viewing and changing server configurations, and managing security features. The unit is stopped to perform this operation.
You must log in as the root user to execute this command.
Available in GUI
No
ppm syncunits
Syntax
/opt/CSCOppm-gw/bin/ppm syncunits [enable | disable | status | now | force]
Command Description
Manages the synchronizations of configuration files between the gateway and units. The gateway is the master of configuration files. A change to the gateway report poller or other configuration file is replicated to the units by default.
Command options:
- enable—Enables file synchronization. It is enabled by default.
- disable—Disables file synchronization.
- status—Displays current status of file synchronization.
- now—Starts synchronization of changed or deleted files.
- force—Starts syncrhonization of all files.
Note Running the ppm syncunits force option can affect system performance. Use this option only for troubleshooting known problems.
Available in GUI
No
ppm traprelay
Syntax
/opt/CSCOppm-gw/bin/ppm traprelay 1
Command Description
Enables or disables trap relays directly to hosts bypassing the Prime Performance Manager alarm processing. Before you enable the trap relay, you must add the host information to TrapForwarder.properties. See Forwarding Traps Directly to Hosts.
Available in GUI
No
ppm tac
Syntax
/opt/CSCOppm-gw/bin/ppm tac [ short ]
Command Description
Collects important troubleshooting information for the Cisco Technical Assistance Center and writes the information to the /opt/CSCOppm-gw/tmp/cisco_ppm_tshoot.log file.
short—Collects the basic information required for diagnosis of the problem.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm thresholdtool
Syntax
/opt/CSCOppm-gw/bin/ppm thresholdtool {-a actionName} {parameters}
Command Description
Invokes Prime Performance Manager threshold API operations. The action names (and any corresponding required parameters) can be specified with the -a option described in Table B-2 .
Table B-2 ppm thresholdtool Operations
|
|
|
-a |
addThreshold |
[-B <baselineParameters>]
[-E <continuousAlarmEnabled>]
|
|
addThresholdInfoList |
|
|
editThreshold |
[-B <baselineParameters>]
[-E <continuousAlarmEnabled>]
|
|
editThresholdInfoList |
|
|
enableThreshold |
|
|
disableThreshold |
|
|
rearmThreshold |
|
|
deleteThreshold |
|
|
getThresholdInfo |
|
|
getAllThresholdInfo |
|
|
getFilteredThresholdInfo |
[-B <baselineParameters>]
[-E <continuousAlarmEnabled>]
|
Table B-3 lists the parameters that can be used.
Table B-3 ppm thresholdtool Parameters
|
|
-a |
The action to perform. |
-b |
Enables or disables the baseline. The default is false. See Creating Baseline Thresholds. |
-c |
The KPI name. |
-d |
The threshold applicable days, indicated with true or false separated by “,” Monday through Sunday. The default is true, true, true, true, true, true, true, which means the threshold applies to all days of the week. |
-e |
Enables or disables the threshold. The default is true, enabled. |
-f |
The from email address. To set to null, enter "". |
-g |
The message to send. To set to null, enter "". |
-h |
Prints help information. |
-i |
The threshold interval. The default is 15MIN. |
-j |
The email subject. To set to null, enter "". |
-m |
The email address to receive the message. To set to null, enter "". |
-n |
The threshold name. |
-o |
The output type: xml or json. (Blank is legacy, xml.) |
-p |
Specifies a port to connect to. If unspecified, the default value is obtained from the WEB_PORT property in the gateway server System.properties file. |
-r |
The KPI report. |
-s |
The threshold scope. The default is default, that is, all applicable devices. |
-t |
The threshold begin and end time, separated by “,”. The format is hh:mm,aa,hh:mm,The default is 12:00,AM,12:00,AM which means the threshold applies to the entire day. |
-x |
Specifies the tenant list, which is a list of tenant names separated by commas with no spaces. Examples:
- ALL
- ALL_TENANTS
- MyCustomer1,MyCustomer2
|
-A |
The threshold alarm nature. Default is “ADAC”. |
-B |
Sets the baseline method and window size. Format, Operation,WindowSize. Examples:
- average,10
- exponential\ average,12
- exponential\ average,12
|
-C |
The critical alarm threshold values separated by “,”. Format: Onset,Onset Occurrences, Abate,Abate Occurences, [Policy Override]. Example: 95,1, 90, 1. |
-D |
The threshold description. |
-E |
Indicates if the continuous alarm is enabled. Default is “false” (disabled). |
-H |
Specifies a hostname to connect to. If unspecified, the default value is obtained from the SERVER_NAME property in the gateway server System.properties file. |
-I |
The informational alarm threshold values separated by “,”. Format: Onset, Onset Occurrences, Abate,Abate Occurences, [Policy Override]. Example: 55,1, 50, 1. |
-L |
The threshold alarm script. |
-M |
The major alarm threshold values separated by “,”. Format: Onset,Onset Occurrences, Abate,Abate Occurences, [Policy Override]. Example: 85,1, 80, 1. |
-N |
The minor alarm threshold values separated by “,”. Format: Onset,Onset Occurrences, Abate,Abate Occurences, [Policy Override]. Example: 5,1, 70, 1. |
-P |
The threshold probable cause. The default is ThresholdCrossed. |
-R |
The threshold type: “true” for rising and “false” for falling. Default is “true”. |
-S |
Specifies whether to use SSL (https) for NBAPI access. The default is no SSL. |
-T |
The threshold alarm type. The default is Communications. |
-W |
The warning alarm threshold values separated by “,”. Format: Onset,Onset Occurrences, Abate,Abate Occurences, [Policy Override]. Example: 65,1, 60, 1. |
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppmtoerrcount
Syntax
/opt/CSCOppm-gw/bin/ppm toerrcount [ number ]
Command Description
Sets the number of timeouts allowed in a report sequence. This command and the ppm nontoerrcount command control the number of polling errors to get from a device in a polling sequence before giving up on that entire polling sequence.The default is 0.
Available in GUI
No
Related Topic
ppm tomcatver
Syntax
/opt/CSCOppm-gw/bin/ppm tomcatver
Command Description
Displays the version of Tomcat that is used.
Available in GUI
No
ppm topxxsize
Syntax
/opt/CSCOppm-gw/bin/ppm topxxsize [ number ]
Command Description
Sets the number of entries displayed in the Top nn reports. By default, Prime Performance Manager displays the top 10 entries. This command can be used to change the default.
Available in GUI
Yes
ppm topxxsizenetflow
Syntax
/opt/CSCOppm-gw/bin/ppm topxxsizenetflow [ number ]
Command Description
Sets the number of entries displayed in the Top nn NetFlow reports. By default, Prime Performance Manager displays the top 10 entries. This command can be used to change the default.
Note Before the Top XX feature can be implemented, you must modify the NetFlow report. See Setting Up NetFlow Reports.
Available in GUI
Yes
ppm traceroute
Syntax
/opt/CSCOppm-gw/bin/ppm traceroute [ hostname ]
Command Description
You use this command to run the trace the route from a gateway to a device.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm tune
Syntax
/opt/CSCOppm-gw/bin/ppm tune [small | med | large | verylarge | verylargedist | extreme | extreme5min | max | medepc | epcsingle | epcdist | smallcell | netflow | collectd | esxi | dcm | kvm | ceph | largegeo]
Command Description
You use this command to tune Prime Performance Manager for different size networks and technologies. Most command options are described in the “Installation Requirements” in the Cisco Prime Performance Manager 1.7 Quick Start Guide.
Command options:
- small—Proof of concept single-server installation.
- med—Medium network single-server installation.
- large—Large network single-server installation.
- verylarge—Very large network single-server installation.
- verylargedist—Very large network distributed server installation.
- extreme—Extremely large network distributed server installation.
- extreme5min—Extremely large network distributed server installation with 5-minute reports enabled.
- max—Maximum supported network distributed server installation.
- medepc—Mediume Evolved Packet Core (StarOS) installation.
- epcsingle—Single-server Evolved Packet Core installation.
- epcdists—Distributed server Evolved Packet Core installation.
- smallcell—Small cell support.
- netflow—NetFlow support.
- collectd—collectd support
- esxi—ESXi hypervisor support.
- dcm—Data Collection Manager support.
- kvm—KVM hypervisor support.
- ceph—Ceph support.
- largegeo—Large geographical HA support.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm uadisable
Syntax
/opt/CSCOppm-gw/bin/ppm disenable
Command Description
Disables user access and SSL on a collocated server.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm uaenable
Syntax
/opt/CSCOppm-gw/bin/ppm uaenable
Command Description
Enables user access and SSL on a collocated server (gateway and unit installed on the same server). The command performs all the SSL functions including key generation and swapping between gateway and unit, and prompting for creation of the first admin user.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm uninstall
Syntax
/opt/CSCOppm-gw/bin/ppm uninstall
Command Description
Uninstalls Prime Performance Manager.
You must log in as the root user to use this command.
Available in GUI
No
ppm unknownage
Syntax
/opt/CSCOppm-gw/bin/ppm unknownage [ number-of-days ]
Command Description
Sets the maximum number of days to retain Unknown objects before deleting them from Prime Performance Manager database.
If you enter this command without the number-of-days argument, Prime Performance Manager displays the current maximum number of days. You can then change that value or leave it. The valid range is one day to an unlimited number of days. The default value is seven days. Setting this value to 0 days means that, after one hour, the system deletes Unknown.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm updateuser
Syntax
/opt/CSCOppm-gw/bin/ppm updateuser [ username ]
Command Description
If you enable Prime Performance Manager User-Based Access, changes the authentication level for the specified user. Valid levels are:
- 1 —Basic User
- 3 —Network Operator
- 5 —System Administrator
- 11 & 12 — Custom Level
If you set ppm authtype to local, you also use this command to change the user’s password. When setting the password, follow the rules and considerations in Modifying the Password Policy.
See Enabling User Accounts and Passwords Using the CLI for more information on authentication levels and the use of this command.
You must log in as the root/super user to use this command.
Available in GUI
Yes
ppm upgradelog
Syntax
/opt/CSCOppm-gw/bin/ppm upgradelog
Command Description
Displays the latest upgrade log.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm useraccess
Syntax
/opt/CSCOppm-gw/bin/ppm useraccess [ disable | enable ]
Command Description
Enables or disables Prime Performance Manager User-Based Access. User-Based Access provides multilevel password-protected access to Prime Performance Manager features. Each user can have a unique username and password. You can also assign each user to one of five levels of access, which control the list of Prime Performance Manager features accessible by that user.
Note You must enable Prime Performance Manager User-Based Access to use the associated Prime Performance Manager security commands (see Setting Up User Access and Security).
The ppm useraccess command goes through the following commands:
- ppm useraccess—Enabled or disabled.
- ppm authtype—If you have not set Prime Performance Manager authentication type, you must do so now.
- ppm adduser—If you have created users, Prime Performance Manager asks if you want to use the same user database, or create a new one. If you have not assigned users, you must do so now.
You must log in as the root/super user to use this command.
Available in GUI
No
Related Topic
Setting Up User Access and Security
ppm userpass
Syntax
/opt/CSCOppm-gw/bin/ppm userpass [ username ]
Command Description
If you enable Prime Performance Manager User-Based Access and /opt/CSCOppm-gw/bin/ppm authtype is set to local, changes the specified user’s Prime Performance Manager security authentication password.
If Prime Performance Manager automatically disables the user’s authentication, this command re-enables the user’s authentication with a new password.
If /opt/CSCOppm-gw/bin/ppm authtype is set to Solaris or Linux, you cannot use this command; instead, you must manage passwords on the external authentication servers.
You must log in as the root/super user to use this command.
Available in GUI
Yes
Related Topic
Enabling User Accounts and Passwords Using the CLI
ppm version
Syntax
/opt/CSCOppm-gw/bin/ppm version
Command Description
Displays version information for Prime Performance Manager servers and clients on the local host.
Available in GUI
Yes
ppm webport
Syntax
/opt/CSCOppm-gw/bin/ppm webport
Command Description
Displays port number and allows to change the JSP/Web Server port number.
You must log in as the root/super user to use this command.
Available in GUI
No
ppm who
Syntax
/opt/CSCOppm-gw/bin/ppm who
Command Description
Displays a list of all client usernames and processes connected to the server.
Available in GUI
Yes
ppm xmlpoll
Syntax
/opt/CSCOppm-gw/bin/ppm xmlpoll -i [ ipaddress/hostname ] -p [ package ] -a [ Action ] -d [ parameters ]
Command Description
Runs the XML poller to get the device XML output.
- -i ipaddress/hostname —The IP address or hostname of the device (required)
- -p —Package
- -a —Action
- -d —Parameters
Available in GUI
No
ppm zipoldbackups
Syntax
/opt/CSCOppm-gw/bin/ppm zipoldbackups [ disable | enable | status ] [ gw | unit | both ]
Command Description
If enabled, zips Prime Performance Manager backups older than the number of days specified by ppm backupdays. If disabled, backups older than the number of specified backup days are deleted.
- enabled —(default) Backups older than the specified backup days are automatically zipped.
- disabled —Backups older than the specified backup days are deleted.
- status —Displays the ppm zipppmbackups status.
- gw —Backs up the gateway.
- unit —Backs up the unit.
- both —Backs up the gateway and unit.
Available in GUI
Yes
Related Topic