-
Cisco Prime Performance Manager User Guide, 1.3
-
Preface
-
Prime Performance Manager Overview
-
Managing Gateways and Units Using the Command Line Interface
-
Managing the Web Interface
-
Integrating Prime Performance Manager with Prime Central
-
Discovering Network Devices
-
Managing Users
-
Managing Reports and Dashboards
-
Managing Devices
-
Managing Network Alarms and Events
-
Managing Thresholds
-
Displaying System Properties, Statuses, Messages, and Logs
-
Managing Gateways and Units
-
Configuring Prime Performance Manager for Firewalls
-
Backing Up and Restoring Prime Performance Manager
-
Prime Performance Manager and IPv6
-
Commands Reference
-
Predefined Thresholds
-
Glossary
-
Index
-
FeedbackTable Of Contents
Prime Performance Manager Commands
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.
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.
•
•
•
•
•
Available in GUI
Yes
ppm addsnmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm addsnmpcomm -i ipaddress [-r retry | -t timeout | -p poll] -c community
Command Description
Adds an SNMP configuration to Prime Performance Manager server.
•
•
•
•
•
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 [username]
Command Description
If you enable Prime Performance Manager User-Based Access, adds the specified user to the authentication list.
When you add a user, Prime Performance Manager prompts you for this information:
•
•
•
–
–
–
–
–
You must log in as the root user to use this command.
Note
Available in GUI
Yes
Related Topic
•
ppm authtype
Syntax
/opt/CSCOppm-gw/bin/ppm authtype [local | solaris | linux]
Command Description
Configures Prime Performance Manager security authentication:
•
•
–
Or
–
•
Note
You must log in as the root user to use this command.
Available in GUI
No
Related Topic
•
ppm backup
Syntax
/opt/CSCOppm-gw/bin/ppm backup
Command Description
Note
Backs up Prime Performance Manager data files to Prime Performance Manager installation directory. Prime Performance Manager automatically backs up all data files nightly at 1:30 AM. However, you can use this command to back up the files at any other time. If you installed Prime Performance Manager in:
•
•
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 user to use this command.
Note
Available in GUI
No
Related Topics
•
ppm backupdata
Syntax
/opt/CSCOppm-gw/bin/ppm backupdata [enable | disable | status]
Command Description
This command enables and disables the backup of the Prime Performance Manager database. You must log in as the root user to use this command.
Available in GUI
No
ppm backupdays
Syntax
/opt/CSCOppm-gw/bin/ppm backupdays [days]
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.
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:
# ./ppm backupdaysCurrent value is: 1Enter number of days to save backup files <1-30>: [1] 5Setting 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
Available in GUI
No
Related Topic
•
ppm backupdir
Syntax
/opt/CSCOppm-gw/bin/ppm backupdir [directory]
Command Description
Note
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:
•
•
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 user to use this command.
Available in GUI
No
Related Topic
•
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 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 user to use this command.
Available in GUI
No
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 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 Display 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 user to use this command.
Available in GUI
Yes
Related Topic
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 user to use this command.
Available in GUI
Yes
Related Topic
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 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
Use these keywords and arguments with 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.
•
To export the certificate to a file, specify the optional -file keyword and a filename.
•
•
•
Solaris Only: You must log in as the root user to use this command in Solaris.
Available in GUI
No
Related Topic
•
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:
•
•
Available in GUI
Yes
ppm checksystem
Command Description
Checks the system for a server installation and reviews the:
•
•
•
•
•
You must log in as the root 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 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 user to use this command.
Available in GUI
Yes
Related Topic
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:
•
•
•
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 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 dependant 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 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 user to use this command.
Available in GUI
Yes
ppm crosslaunch
Syntax
/opt/CSCOppm-gw/bin/ppmcrosslaunch [install | uninstall]
Command Description
Installs or uninstalls cross launch on Prime Network so that Prime Performance Manager can be launched from Prime Network.
Available in GUI
Yes
ppm csvdrop
Syntax
/opt/CSCOppm-gw/bin/ppmcsvdrop [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
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 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.
•
•
•
•
•
•
•
You must log in as the root 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 Topic
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]
Command Description
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 /opt/CSCOppm-gw/bin/ppm adduser command.
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
Manually Disable 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 disablepass
Syntax
/opt/CSCOppm-gw/bin/ppm disablepass [username]
Command Description
If you enable Prime Performance Manager User-Based Access, and set ppm authtype to local, 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:
•
•
Note
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 user to use this command. You must also set /opt/CSCOppm-gw/bin/ppm authtype to local.
Available in GUI
Yes
Related Topic
Manually Disable Users and Passwords
ppm disablepwdage
Syntax
/opt/CSCOppm-gw/bin/ppm enablepwdage [username]
Command Description
Disables password aging for the specified user.
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
ppm disableuser
Syntax
/opt/CSCOppm-gw/bin/ppm disableuser [username]
Command Description
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:
•
•
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
Manually Disable 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 user to use this command.
Available in GUI
Yes
Related Topic
Running Device Discovery from Prime Performance Manager
ppm diskcheck
Syntax
/opt/CSCOppm-gw/bin/ppm diskcheck
Command Description
Manually runs the disk space usage check.
Related Topic
ppm diskmonitor
Syntax
/opt/CSCOppm-gw/bin/ppm diskmonitor [enable | disable | status] | warning {MBs} | critical {MBs} | warnscript {path | clear} | critscript {path | clear}
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: The following partition is getting low on free disk space:/optSpace left = 905 MBThe script identified with the warnscript option is executed to begin disk cleanup.
•
WARNING: The following partition is getting low on free disk space:/optSpace left = 100 MBThe script identified with the critscript option is executed to begin disk cleanup.
The ppm diskmonitor parameters include:
•
•
•
•
•
•
•
You must log in as the root user to use this command.
Available in GUI
•
•
Related Topic
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]
Command Description
Enables password aging for the specified user.
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
•
ppm enableuser
Syntax
/opt/CSCOppm-gw/bin/ppm enableuser [username]
Command Description
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 user to use this command.
Available in GUI
Yes
Related Topic
Enable 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 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:
•
•
•
•
You must log in as the root 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:
•
•
•
•
You must log in as the root 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:
•
•
•
•
You must log in as the root 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:
These parameters can be used:
You must log in as the root 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 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 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 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.
•
•
•
•
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:
ppm genkey bothThe 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 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 ifnameformat
Syntax
/opt/CSCOppm-gw/bin/ppm ifnameformat [desc | alias | both|]
Command Description
Defines the format for displaying interface names in the Prime Performance Manager GUI:
•
•
•
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 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 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 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 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:
•
•
•
•
•
•
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 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 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 user to use this command.
Note
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:
•
•
•
•
•
•
•
You must log in as the root 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:
•
•
•
•
To list information for a specific user, use the username argument to specify the user.
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
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 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 hacommandsUsage: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 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 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 logsize
Syntax
/opt/CSCOppm-gw/bin/ppm logsize [number-of-lines]
Command Description
Sets the maximum size for truncating and rolling log files.
•
•
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:
•
or
•
where:
•
•
•
•
•
•
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
You must log in as the root 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:
•
•
You must log in as the root user to use this command.
Available in GUI
No
ppm maxasciirows
Syntax
/opt/CSCOppm-gw/bin/ppm maxasciirows [number-of-rows]
Command Description
Sets the maximum browser rows for ASCII web log output.
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 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 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
ppm mldebug
Syntax
/opt/CSCOppm-gw/bin/ppm mldebug [mode]
Command Description
Sets the mode for logging Prime Performance Manager debug 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 user to use this command.
Available in GUI
No
ppm modifysnmpcomm
Syntax
/opt/CSCOppm-gw/bin/ppm modifysnmpcomm -i ipaddress {-r retry | -t timeout | -p poll -c community}
Command Description
Modifies an existing SNMP configuration on Prime Performance Manager server.
•
•
–
–
–
–
You do not need to restart Prime Performance Manager server.
Available in GUI
Yes
Related Topic
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:
•
•
Use these keywords with this command:
•
•
•
•
You must log in as the root user to use this command.
Available in GUI
No
Related Topic
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 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 user to use this command.
Available in GUI
Yes
ppm msglogdir
Syntax
/opt/CSCOppm-gw/bin/ppm msglogdir [directory]
Command Description
Note
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
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 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 netlog
Syntax
/opt/CSCOppm-gw/bin/ppm netlog [clear | -r]
Command Description
Uses PAGER to display the contents of the network status log. To:
•
•
You must log in as the root 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:
•
•
•
•
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
Enable User Accounts and Passwords Using the CLI
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:
•
•
•
Available in GUI
No
Related Topic
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
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
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
You must log in as the root user to use this command.
Available in GUI
Yes
Related Topic
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 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 user to use this command.
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 user to use this command.
Available in GUI
Yes
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 (see Figure 3-1.
Use these keywords with this command:
•
•
•
•
You must log in as the root user to use this command.
Available in GUI
No
Related Topics
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:
•
•
•
•
•
•
You must log in as the root user to use this command. For additional information, see Chapter 4 "Prime Central Integration."
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:
•
•
•
–
–
–
–
–
–
–
•
•
•
•
•
You must log in as the root user to use this command.
Available in GUI
No
Related Topics
Managing Geographical High Availability
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:
•
•
•
•
–
–
•
You must log in as the root 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 user to use this command.
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.
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
You must log in as the root 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 Topic
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 Topic
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 Topic
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 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:
•
ppm redundancygroups listgroupA, Enabled, Number of Units: 2groupB, Enabled, Number of Units: 4•
ppm redundancygroups detail groupAID: 54001Name: groupAEnabledCreated: Wed Sep 21 11:44:36 EDT 2011Create User: localhostLast Modified: Wed Sep 21 11:44:36 EDT 2011Last Modified User: localhostEnabledFail over delay: 60Units: [unit1, Primary,unit2, Redundantunit3, Primaryunit4, Primary•
•
•
Note
•
•
•
•
•
•
•
•
•
Available in GUI
No
Related Topic
Creating Unit Protection 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 snmpinfo.dat file.
Available in GUI
Yes
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 user to use this command.
Available in GUI
No
ppm rephelp
Command Description
Displays Help for all commands that are related to Prime Performance Manager reports.
You must log in as the root user to use this command.
Available in GUI
Yes
ppm restart
Syntax
/opt/CSCOppm-gw/bin/ppm restart [jsp | pm | web]
Command Description
Restarts Prime Performance Manager servers on the local host:
•
•
•
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 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:
•
•
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:
•
•
•
Note
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 user to use this command.
Available in GUI
No
Related Topic
•
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 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 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 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 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:
•
•
•
•
•
•
•
•
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 user to use this command.
Available in GUI
Yes
Related Topic
Display the System Security Log
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.
•
•
•
•
Note
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:
•
•
–
–
–
•
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] 2Prime Performance is sending traps to: Prime NetworkAvailable 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 Topic
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
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.
•
•
•
•
You must log in as the root user to use this command.
Available in GUI
Yes
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 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
You must log in as the root user to use this command.
Available in GUI
No
ppm snmpget
Syntax
/opt/CSCOppm-gw/bin/ppm snmpget [-JJVM_ARG1 [-JJVM_ARG2]...] [-v snmp_version] [-c community_string] [-r retry] [-t timeout] [-d output_delimiter] [--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] [--detect-mib-error] [--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:
•
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
•
•
•
•
•
•
–
–
•
–
–
The other option for displaying octets is --str-octets|--no-str-octets.
•
–
–
The other option for displaying octets is --raw-octets|--no-raw-octets.
•
–
–
•
–
–
•
–
–
•
–
–
•
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
–
–
•
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
•
•
ppm snmpget --str-instance link_1 node_1 cItpSpLinksetState
ppm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
•
•
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 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 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 user to use this command.
Available in GUI
No
ppm snmpnext
Syntax
ppm snmpnext [-JJVM_ARG1 [-JJVM_ARG2]...] [-v snmp_version] [-c community_string] [-r retry] [-t timeout] [-d output_delimiter] [--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] [--detect-mib-error] [--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:
•
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
•
•
•
•
•
•
–
–
•
–
–
The other option for displaying octets is --str-octets|--no-str-octets.
•
–
–
The other option for displaying octets is --raw-octets|--no-raw-octets.
•
–
–
•
–
–
•
–
–
•
–
–
•
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
–
–
•
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
•
•
ppm snmpget --str-instance link_1 node_1 cItpSpLinksetState
ppm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
•
•
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 user to use this command.
Available in GUI
No
ppm snmpsetup
Syntax
/opt/CSCOppm-gw/bin/ppm snmpsetup
Command Description
Set SNMP community strings for multiple devices and discover. You do not need to restart the server when using this command.
Available in GUI
Yes
Related Topics
ppm snmpwalk
Syntax
/opt/CSCOppm-gw/bin/ppm snmpwalk [-JJVM_ARG1 [-JJVM_ARG2]...] [-v snmp_version] [-c community_string] [-r retry] [-t timeout] [-x maximum_rows] [-d output_delimiter] [--tabular|--no-tabular] [--getbulk|--no-getbulk] [--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] [--detect-mib-error] [--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:
•
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
•
•
•
•
•
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.
•
•
–
–
•
–
–
•
–
–
•
–
–
The other option for displaying octets is --str-octets|--no-str-octets.
•
–
–
The other option for displaying octets is --raw-octets|--no-raw-octets.
•
–
–
•
–
–
•
–
–
•
–
–
•
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
–
–
•
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
•
•
ppm snmpget --str-instance link_1 node_1 cItpSpLinksetState
ppm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
•
•
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 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:
•
•
•
You must log in as the root user to use this command.
Available in GUI
no
Related Topics
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 user to use this command.
Available in GUI
Yes
Related Topic
Managing Users and User Security
ppm starbuild
Syntax
/opt/CSCOppm-gw/bin/ppm starbuild [ppm | no | zero]
Command Description
Sets up bulk statistics reporting configurations for Cisco ASR 5000 and Cisco ASR 5500 devices.
•
•
•
You must log in as the root user to use this command.
Related Topic
Setting Up Bulk Statistics Reports
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 user to use this command.
Available in GUI
No
Note
Related Topic
Managing Gateways and Units Using the CLI
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] [enable | disable]], [setstatus[category] [enable | disable] [node]], [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 ]], [expformat [ xml]], [nametype[dnsname] [customname | sysname]], [csvtype [ allnodes | pernodeuniq]], [zipcsvdelay [mins]] [zipcsvfiles [internal | script]] [zipcsvnotifscript [path | disable]]
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] [enable | disable]] - Enable or disable network report settings.
setstatus [[category] [enable | disable] [node]] - Enable or disable node report settings.
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).
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.
Available in GUI
•
•
Related Topic
Changing the Master 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 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 user to use this command.
Available in GUI
No
Related Topic
Configuring Alarms Sent to E-mail Addresses
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:
•
•
•
•
•
Note
Available in GUI
No
ppm traprelay
Syntax
/opt/CSCOppm-gw/bin/ppm traprelay [enable | disable | status]
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 user to use this command.
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 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 user to use this command.
Available in GUI
Yes
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 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:
•
•
•
•
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 Enable 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 user to use this command.
Available in GUI
Yes
Note
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
The ppm useraccess command goes through the following commands:
•
•
•
You must log in as the root 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 user to use this command.
Available in GUI
Yes
Related Topic
Enable 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 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 -a [-d parameters]
Command Description
Runs the XML poller to get the device XML output.
•
•
•
•
Available in GUI
No
