 Feedback
|
Table Of Contents
Cisco Intercompany Media Engine Command Line Interface Reference Guide
delete ime validation-confirmation-required
set amc serviceparam AmcCollectionEnabled
set amc serviceparam AmcCollectionPollingRate
set amc serviceparam AlertMgrEnabled
set amc serviceparam LoggerEnabled
set auditlog remotesyslogseverity
set auditlog remotesyslogserver
set enterprise serviceparam ClusterID
set enterprise serviceparam RemoteSyslogServerName
set enterprise serviceparam RemoteSyslogSeverity
set ime dht local readbufferdepth
set ime serviceparam DhtRcvdMsgTraceFlag
set ime serviceparam DhtSentMsgTraceFlag
set ime serviceparam MaxVtraceP2pRecordsPerPeer
set ime serviceparam MaxVtraceValRecordsPerPeer
set ime serviceparam MaxVtraceVapRecordsPerPeer
set ime serviceparam MaxVtraceTlsRecordsPerPeer
set ime serviceparam MaxVtraceFetchRecordsPerPeer
set ime serviceparam MaxVtraceStoreRecordsPerPeer
set ime serviceparam NetMaskForNATEnvironment
set ime serviceparam SdlTraceDataFlags
set ime serviceparam SdlTraceDataSize
set ime serviceparam SdlTraceFlag
set ime serviceparam SdlTraceMaxFileSize
set ime serviceparam SdlTraceTotalNumFiles
set ime serviceparam SdlTraceTypeFlags
set ime serviceparam TLSMaxConnections
set ime serviceparam TLSValidationThreshhold
set ime vapusercredentials epoch
set password complexity minimum-length
set risdc serviceparam RisClientTimeout
set risdc serviceparam RisCleanupTimeOftheDay
set risdc serviceparam RisSystemAccessMaxProcessesThreads
set risdc serviceparam RisTLCThrottleEnable
set risdc serviceparam RisTLCIOThrottleLimit
set risdc serviceparam RisTLCCPUThrottleLimit
set risdc serviceparam RisTLCThrottlePollRate
set risdc serviceparam RisTLCSFTPKeepaliveDelay
set risdc serviceparam RisTSEnableLogging
set risdc serviceparam RisTSPollingInterval
set risdc serviceparam RisTSFileSize
set risdc serviceparam RisTSTotalNumberFiles
show amc serviceparam AmcCollectionEnabled
show amc serviceparam AmcCollectionPollingRate
show amc serviceparam AlertMgrEnabled
show amc serviceparam LoggerEnabled
show enterprise serviceparam ClusterID
show enterprise serviceparam RemoteSyslogServerName
show enterprise serviceparam RemoteSyslogSeverity
show ime certenrollment serverID
show ime serviceparam DhtRcvdMsgTraceFlag
show ime serviceparam DhtSentMsgTraceFlag
show ime serviceparam MaxVtraceP2pRecordsPerPeer
show ime serviceparam MaxVtraceValRecordsPerPeer
show ime serviceparam MaxVtraceVapRecordsPerPeer
show ime serviceparam MaxVtraceTlsRecordsPerPeer
show ime serviceparam MaxVtraceFetchRecordsPerPeer
show ime serviceparam MaxVtraceStoreRecordsPerPeer
show ime serviceparam NetMaskForNATEnvironment
show ime serviceparam SdlTraceDataFlags
show ime serviceparam SdlTraceDataSize
show ime serviceparam SdlTraceFlag
show ime serviceparam SdlTraceMaxFileSize
show ime serviceparam SdlTraceTotalNumFiles
show ime serviceparam SdlTraceTypeFlags
show ime serviceparam TLSMaxConnections
show ime serviceparam TLSValidationThreshhold
show ime software-config version
show ime validation originating-aborted
show ime validation confirmation-required
show ime validation terminating-aborted
show ime validation route-discarded
show ime vapstatus subscriptions
show password complexity character
show password complexity length
show risdc serviceparam RisClientTimeout
show risdc serviceparam RisCleanupTimeOftheDay
show risdc serviceparam RisSystemAccessMaxProcessesThreads
show risdc serviceparam RisTLCThrottleEnable
show risdc serviceparam RisTLCIOThrottleLimit
show risdc serviceparam RisTLCCPUThrottleLimit
show risdc serviceparam RisTLCThrottlePollRate
show risdc serviceparam RisTLCSFTPKeepaliveDelay
show risdc serviceparam RisTSEnableLogging
show risdc serviceparam RisTSPollingInterval
show risdc serviceparam RisTSFileSize
show risdc serviceparam RisTSTotalNumberFiles
unset network ipv6 static_address
utils ime certenrollment enroll
utils ime license file install
utils disaster_recovery backup local
utils disaster_recovery backup tape
utils disaster_recovery backup network
utils disaster_recovery cancel_backup
utils disaster_recovery device add
utils disaster_recovery device delete
utils disaster_recovery device list
utils disaster_recovery restore local
utils disaster_recovery restore tape
utils disaster_recovery restore network
utils disaster_recovery schedule
utils disaster_recovery show_backupfiles local
utils disaster_recovery show_backupfiles tape
utils disaster_recovery show_backupfiles network
utils disaster_recovery show_registration
utils disaster_recovery show_tapeid
utils disaster_recovery status
utils iothrottle threshold low
utils iothrottle threshold clear
utils iothrottle threshold status
utils snmp config inform 3 add
utils snmp config inform 3 delete
utils snmp config inform 3 list
utils snmp config inform 3 update
utils snmp config trap 3 update
utils snmp config user 3 delete
utils snmp config user 3 update
Obtaining Documentation and Submitting a Service Request
Cisco Product Security Overview
Cisco Intercompany Media Engine Command Line Interface Reference Guide
This document describes the Command Line Interface (CLI) commands that are available for the Cisco Intercompany Media Engine server.
Contents
This document comprises the following sections:
•
Obtaining Documentation and Submitting a Service Request
Starting a CLI Session
You can access the Cisco Unified Communications Operating System CLI remotely or locally:
•
•
Before You Begin
Ensure you have the following information that gets defined during installation:
•
•
•
You will need this information to log in to the Cisco IPT Platform.
Perform the following steps to start a CLI session:
Step 1
•
ssh adminname@hostname
where adminname specifies the Administrator ID and hostname specifies the hostname that was defined during installation.
For example, ssh admin@ipt-1.
•
ipt-1 login:where ipt-1 represents the host name of the system.
Enter your administrator ID.
In either case, the system prompts you for a password.
Step 2
The CLI prompt displays. The prompt represents the Administrator ID; for example:
admin:
CLI Basics
The following section contains basic tips for using the command line interface.
Completing Commands
To complete commands, use Tab:
•
•
•
Getting Help on Commands
You can get two kinds of help on any command:
•
•
Procedure
To get detailed help, at the CLI prompt, enter
help command
Where command specifies the command name or the command and parameter. See Example 1-1.
Note
To query only command syntax, at the CLI prompt, enter
command?
Where command represents the command name or the command and parameter. See Example 1-2.
Note
Example 1-1 Detailed Help Example:
admin:help file list activelogactivelog help:This will list active logging filesoptions are:page - pause outputdetail - show detailed listingreverse - reverse sort orderdate - sort by datesize - sort by sizefile-spec can contain '*' as wildcardsExample:admin:file list activelog platform detail02 Dec,2004 12:00:59 <dir> drf02 Dec,2004 12:00:59 <dir> log16 Nov,2004 21:45:43 8,557 enGui.log27 Oct,2004 11:54:33 47,916 startup.logdir count = 2, file count = 2Example 1-2 Query Example:
admin:file list activelog?Syntax:file list activelog file-spec [options]file-spec mandatory file to viewoptions optional page|detail|reverse|[date|size]Ending a CLI Session
At the CLI prompt, enter quit. If you are logged in remotely, you get logged off, and the ssh session gets dropped. If you are logged in locally, you get logged off, and the login prompt returns.
The following sections list and describe the CLI commands that are available for the Cisco Unified Communications Operating System.
Conventions
This document uses the following conventions:
Notes use the following conventions:
Note
Timesavers use the following conventions:
Timesaver
Tips use the following conventions:
Tip
Cautions use the following conventions:
Caution
Warnings use the following conventions:
Generic Commands
•
•
help
This command displays help for the specified command.
Requirements
Command privilege level: 0
Allowed during upgrade: Unknown
Command syntax
help [command]
Parameters
command specifies the command for which help is required.
quit
This command exits the CLI.
Requirements
Command privilege level: 0
Allowed during upgrade: Unknown
Command syntax
quit
Parameters
None
Add Commands
add ime vapserver
This command adds a vapserver.
Command syntax
add ime vapserver vapservername [portnumber]
Parameters
•
•
Usage Guidelines
•
–
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
add ime vapusercredentials
This command adds a new user credential to the system.
This user name and password must match the ones that exist on the Unified CM client, to allow VAP messages to be sent between the IME server and Unified CM client.
Command syntax
add ime vapusercredentials
After you enter the command, the system prompts you for the parameters.
Parameters
•
•
•
•
Usage Guidelines
Appusername cannot match an existing appusername field for a row in the table.
Example
add ime vapusercredentials(user is prompted for input, and fields such as password will be obscured)Application User name: johnPassword: ******Reconfirm Password: ******Ticket password: ******Reconfirm Ticket password: ******Epoch [1]:Record added successfullyRequirements
Command privilege level: 0
Allowed during upgrade: Yes
Delete Commands
•
•
delete account
This command allows you to delete an administrator account.
Command Syntax
delete account account-name
Parameters
•
Requirements
Command privilege level: 4
Allowed during upgrade: No
delete dns
This command allows you to delete the IP address for a DNS server.
Command Syntax
delete dns ip-address
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
delete ime validation-confirmation-required
This command deletes entries that are pending validation.
Command syntax
delete ime validation-confirmation-required {called-dn | all}{publicKey | all]
Parameters
•
•
•
Example
delete ime validation-confirmation-required +123455689 all
This command deletes the all the confirmation-required for calling number +123455689.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
delete ime vapserver
This command deletes the specified vapserver.
Command syntaxdelete ime vapserver vapservername
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
delete ime vapusercredentials
This command deletes the specified user credential.
Command syntax
delete ime vapusercredentials appusername
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
delete process
This command allows you to delete a particular process.
Command Syntax
delete process process-id {force | terminate | crash}
Parameters
•
Options
•
•
•
Usage Guidelines
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
delete smtp
This command allows you to delete the SMTP host.
Command Syntax
delete smtp
Requirements
Command privilege level: 1
Allowed during upgrade: No
File Commands
file check
This command checks the /usr directory tree to see whether any files or directories have been added, removed, or changed in size since the last fresh installation or upgrade and displays the results.
Command Syntax
file check detection-size-kb
Options
detection-size-kb specifies the minimum file size change that is required for the command to display the file as changed.
Usage Guidelines
The command notifies you about a possible impact to system performance and asks you whether you want to continue.
Caution
The display includes both deleted and new files.
Defaults
The default value of detection-size-kb specifies 100 KB.
Requirements
Command privilege level: 0
Allowed during upgrade: No
file delete
This command deletes one or more files.
Command Syntax
file delete
activelog directory/filename {detail | noconfirm}
inactivelog directory/filename {detail | noconfirm}
install directory/filename {detail | noconfirm}
Parameters
•
•
•
•
Options
•
•
Usage Guidelines
Caution
You get prompted for confirmation after entering the command. You cannot delete directories or files that are in use.
If you delete a TFTP data file on the inactive side, you may need to manually restore that file if you switch versions to the inactive side.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
The following example deletes the install log.
file delete install install.logfile dump
This command dumps the contents of a file to the screen, a page at a time.
Command Syntax
file dump
activelog directory/filename [detail] [hex]
inactivelog directory/filename [detail] [hex]
install directory/filename [detail] [hex]
sftpdetails filename [hex] [regexp expression] [recent]
Parameters
•
•
•
•
•
•
Options
•
•
•
•
Usage Guidelines
To determine which files you can dump with the sftpdetails parameter, first enter the following command:
file list sftpdetails *
The output lists the filenames that you can dump.
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: Yes
Example
This command dumps contents of file _cdrIndex.idx.
file dump activelog cm/cdr/_cdrIndex.idxfile fragmentation sdi
This command displays file fragmentation information about SDI log files.
Command Syntax
file fragmentation sdi
all outfilename
file filename {verbose}
most fragmented number
most recent number
Parameters
•
•
most fragmented displays information about the most fragmented files.
most recent displays information about the most recently logged fragmented file.
•
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
file fragmentation sdl
This command displays file fragmentation information about SDL log files.
Command Syntax
file fragmentation sdl
all outfilename
file filename {verbose}
most fragmented number
most recent number
Parameters
•
•
•
•
•
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yesfile get
This command sends the file to another system by using SFTP.
Command Syntax
file get
activelog directory/filename [reltime] [abstime] [match] [recurs]
inactivelog directory/filename [reltime] [abstime] [match] [recurs]
install directory/filename [reltime] [abstime] [match] [recurs]
partBsalog directory/filename [reltime] [abstime] [match] [recurs]
salog directory/filename [reltime] [abstime] [match] [recurs]
Parameters
•
•
•
•
•
•
Options
•
•
•
•
Usage Guidelines
After the command identifies the specified files, you get prompted to enter an SFTP host, username, and password.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Examples
This command gets all files in the activelog operating system directory that match the string "plat".
file get activelog platform match platThis command gets all operating system log files for a particular time period.
file get activelog platform/log abstime 18:00:9/27/2005 18:00:9/28/2005file list
This command lists the log files in an available log directory.
Command Syntax
file list
activelog directory [page] [detail] [reverse] [date | size]
inactivelog directory [page] [detail] [reverse] [date | size]
install directory [page] [detail] [reverse] [date | size]
partBsalog directory [page] [detail] [reverse] [date | size]
salog directory [page] [detail] [reverse] [date | size]
Parameters
•
•
•
•
Options
•
•
•
•
•
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: Yes
Examples
This example lists operating system log files with details.
file list activelog platform/log page detailThis example lists directories in CDR repository.
file list activelog cm/cdr_repositoryThis example lists CDR files in a specified directory by size.
file list activelog cm/cdr_repository/processed/20050812 sizeIn Cisco Unity Connection and in Cisco Unified Communications Manager Business Edition, this example lists all files in the cuc log directory.
file list activelog cuc *file search
This command searches the content of a log and displays the matching lines a page at a time.
Command Syntax
file search
activelog directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]
inactivelog directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]
install directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]
Parameters
•
•
•
•
•
•
Options
•
•
•
•
•
•
Usage Guidelines
Write the search term in the form of a regular expression, which is a special text string for describing a search pattern.
If the search term is found in only one file, the filename appears at the top of the output. If the search term is found in multiple files, each line of the output begins with the filename in which the matching line was found.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
file search activelog platform/log/platform.log Err[a-z] ignorecasefile tail
This command tails (prints the last few lines) of a log file.
Command Syntax
file tail
activelog directory/filename [detail] [hex] [lines]
inactivelog directory/filename [detail] [hex] [lines]
install directory/filename [detail] [hex] [lines]
Parameters
•
•
•
•
Options
•
•
•
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: Yes
Example
This example tails the operating system CLI log file.
file tail activelog platform/log/cli00001.logfile view
This command displays the contents of a file.
Command Syntax
file view
activelog directory/filename
inactivelog directory/filename
install directory/filename
system-management-log
Parameters
•
•
•
•
•
Usage Guidelines
Caution
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Examples
This example displays the install log.
file view install install.logThis example displays a particular CDR file.
file view activelog /cm/cdr_repository/processed/20058012/{filename}Set Commands
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
set account name
This command sets up a new account on the operating system.
Command Syntax
set account name name
Parameters
•
Usage Guidelines
After you enter the username, the system prompts you to enter the privilege level and password for the new account.
Requirements
Command privilege level: 0
Allowed during upgrade: No
set account enable
This command enables the OS user account that was disabled because of password inactivity.
Password inactivity period is the number of days of inactivity after a password has expired, before the account is disabled. Upon executing this command the user account is enabled with current system settings. The system settings are Password min days, Password Max days, and Password inactivity period.
Command syntax
Set account enable user-id
Parameters
•
Requirements
Command privilege level: 4
Allowed during upgrade: No
Example
User account test was disabled due to password inactivity. Its enabled as follows:
admin:set account enable testEnabling the account 'test' with current settings.........Successfully enabled account 'test'set accountlocking
This command enables or disables accountlocking for the current admin accounts.
Command syntax
set accountlocking {enable | disable}
Requirements
Command privilege level: 0
Allowed during upgrade Yes
set accountlocking unlocktime
Use this command to configure the unlock time for CUCM OS admin accounts in
seconds.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Command syntax
set accountlocking unlocktime seconds
Parameters
•
Acceptable values should be greater than or equal to 300 seconds but less than 3600 seconds (60 minutes).
set alarm default
This command sets the alarm configuration to the factory defaults.
Command syntax
set alarm default
Note
Parameter
Service names comprise:
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade Yes
set alarm status
This command enables or disables the specified monitor for the specified service.
Command syntax
set alarm status
Note
Parameters
•
•
•
•
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade Yes
set alarm severity
This command sets the specified monitor alarm to the specified severity for the specified service.
Command syntax
set alarm severity
Note
Parameters
•
–
–
–
–
–
–
–
–
•
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade Yes
set alarm remotesyslogserver
This command sets the alarm for the remote syslog server.
Command syntax
set alarm remotesyslogserver
Note
Parameters
•
•
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set amc serviceparam AmcCollectionEnabled
This commands sets the amc serviceparam for collecting, and alerting of the real-time cluster information.
Command syntax
show amc serviceparam AmcCollectionEnabled [ true | false | default ]
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
set amc serviceparam AmcCollectionPollingRate
This command sets the AMC collecting rate, in seconds.
Command syntax
set amc serviceparam AmcCollectionPollingRate [ paramValue ]
Parameters
•
•
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
set amc serviceparam AlertMgrEnabled
This parameter enables or disables the alerting (email/epage) feature. This command is used only for AMC troubleshooting purposes.
Command syntax
set amc serviceparam AlertMgrEnabled [ true | false | default ]
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
set amc serviceparam LoggerEnabled
This parameter enables or disables the logging feature(.csv files for generating reports). This command is used for AMC troubleshooting purpose only.
Command syntax
set amc serviceparam LoggerEnabled [ true | false | default ]
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
set auditlog status
This command enables or disables the auditlog.
Command syntax
set auditlog status
Note
Parameters
•
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set auditlog purging
This command enables or disables auditlog purging.
Command syntax
set auditlog purging
Note
Parameters•
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set auditlog logrotation
This command enables or disables the auditlog logrotation.
Command syntax
set auditlog logrotation
Note
Parameters
•
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set auditlog maxfilesize
This command sets the auditlog maxfilesize.
Command syntax
set auditlog maxfilesize
Note
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set auditlog maxnumfiles
This command sets the auditlog maxnumfiles count.
Command syntax
set auditlog maxnumfiles
Note
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set auditlog remotesyslogseverity
This command sets the auditlog remotesyslogseverity to the specified severity.
Command syntax
set auditlog remotesyslogseverity
Note
Parameters
•
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set auditlog remotesyslogserver
This command sets the remote syslog server name to a name specified.
Command syntax
set auditlog remotesyslogserver
Note
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set cert
This command affect the certificates available in the preconfigured SFTP location.
Command syntax
set cert
import [unit]
Command privilege level: 1
Allowed during upgrade: Yes
regen [name]
Command privilege level: 1
Allowed during upgrade: No
delete [unit] [name]
Command privilege level: 1
Allowed during upgrade: No
Parameters
•
•
•
Options
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Import Example
admin:set cert import allSuccessfully imported tomcat certificates.Successfully imported tftp certificates.Regen Example
admin: set cert regen tomcatSuccessfully regenerated certificate for tomcat.set cli pagination
For the current CLI session, this command turns automatic pagination On or Off.
Command Syntax
set cli pagination {on | off}
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:set cli pagination offAutomatic pagination is turned offset commandcount
This command changes the CLI command prompt, so it displays how many CLI commands have executed.
Command Syntax
set commandcount {enable | disable}
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set csr gen
This command regenerates the certificate for the specified unit name.
Command syntax
set csr gen unitname
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:set csr gen tomcatSuccessfully regenerated certificate for tomcat.Please restart services related to tomcat for the new certificate to become active.set date
This command changes the date/time on the server.
Command syntax
set date HH:mm:ss:MM/DD/YY
Parameters
•
•
Usage Guidelines
The following date format is also accepted: MM/DD/YYYY.
If the server is configured to synchronize with any external NTP server(s), this command requires the user to remove all such NTP servers.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
To set date and time to 2:10:33 pm Feb 13th 2008
admin:set date 14:10:33:02/13/08set enterprise serviceparam ClusterID
This parameter provides a unique identifier for this cluster.
Command syntax
set enterprise serviceparam ClusterID [ paramValue | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set enterprise serviceparam RemoteSyslogServerName
Enter the name or the IP address of the remote Syslog server that should accept Syslog messages. If the server name is not specified, Cisco Unified Serviceability does not send the Syslog messages. Do not specify a Cisco Unified Communications Manager.
Command syntax
set enterprise serviceparam RemoteSyslogServerName [ paramValue | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set enterprise serviceparam RemoteSyslogSeverity
Select the desired severity for the syslog messages that are to be sent to the remote syslog server. All the syslog messages with the selected or higher severity level are sent to the remote syslog. If the remote server name is not specified, Cisco Unified Serviceability does not send the syslog messages.
Command syntax
set enterprise serviceparam RemoteSyslogSeverity [ paramValue ]
Parameters
•
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime addressing dht
This command sets the IP addresses for this server in the public and private networks.
Command syntax
set ime addressing dht
publicipaddrv4 ipaddr
privateipaddrv4 ipaddr
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Examples
set ime addressing dht publicipaddrv4 10.76.242.45set ime addressing dht privateipaddrv4 10.76.242.45set ime validator local
This command sets the configuration parameters for validation on this server.
Command syntax
set ime validator local
roundinginterval ms
ticketvalidationlifetime secs
cleanupinterval secs
maxvalidationtime secs
minvalidationtime secs
bucketentropy bits
sameDNvalidationint secs
Parameters
•
•
–
–
–
–
–
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime dht local readbufferdepth
This command sets the depth of the local read request queue.
Command syntax
set ime dht local
readbufferdepth depth
joinretrytimer seconds
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime peerid
This command enables or disables the peerids on the server.
Note
Command syntax
set ime peerid {enabled | disabled} all
Parameters
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam DhtRcvdMsgTraceFlag
This parameter specifies whether the received DHT messages should be traced.
Command syntax
set ime serviceparam DhtRcvdMsgTraceFlag [ true | false | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam DhtSentMsgTraceFlag
This parameter specifies whether the DHT messages sent should be traced.
Command syntax
set ime serviceparam DhtSentMsgTraceFlag [ true | false | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam MaxVtraceP2pRecordsPerPeer
This parameter specifies the maximum number of P2P vtrace records that would be maintained.
Command syntax
set ime serviceparam MaxVtraceP2pRecordsPerPeer [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam MaxVtraceValRecordsPerPeer
This parameter specifies the maximum number of Validation vtrace records that would be maintained. Increasing this number makes the vtrace feature use more space.
Command syntax
set ime serviceparam MaxVtraceValRecordsPerPeer [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam MaxVtraceVapRecordsPerPeer
This parameter specifies the maximum number of VAP vtrace records that would be maintained. Increasing this number makes the vtrace feature use more space.
Command syntax
set ime serviceparam MaxVtraceVapRecordsPerPeer [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam MaxVtraceTlsRecordsPerPeer
This parameter specifies the maximum number of TLS vtrace records that would be maintained. Increasing this number makes the vtrace feature use more space.
Command syntax
set ime serviceparam MaxVtraceTlsRecordsPerPeer [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam MaxVtraceFetchRecordsPerPeer
This parameter specifies the maximum number of fetch records per peer, that vtrace maintains. Increasing this number makes the vtrace feature to use more space.
Command syntax
set ime serviceparam MaxVtraceFetchRecordsPerPeer [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam MaxVtraceStoreRecordsPerPeer
This parameter specifies the maximum number of store records per peer that vtrace would maintain. Increasing this number makes the vtrace feature use more space.
Command syntax
set ime serviceparam MaxVtraceStoreRecordsPerPeer [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam NetMaskForNATEnvironment
This parameter is used in a NAT environment to determine if outbound TCP/TLS connections are attempted to a remote IME Server, using its configured public or private IP address. The public and private IP addresses for an IME Server can be displayed.
Command syntax
set ime serviceparam NetMaskForNATEnvironment [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam SdlTraceDataFlags
This parameter provides a bit mask for enabling tracing of SDL non-application-specific components, or for modifying the behavior of SDL tracing. Keep this parameter set to the default value, unless a Cisco support engineer instructs otherwise.
Command syntax
set ime serviceparam SdlTraceDataFlags [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam SdlTraceDataSize
This parameter specifies the number of bytes of raw SDL data that is to be dumped into the SDL trace file, from each signal.
Command syntax
set ime serviceparam SdlTraceDataSize [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam SdlTraceFlag
This command enables or disables the SDL traces. Specifying True enables SDL tracing, and specifying False disables SDL tracing.
Command syntax
set ime serviceparam SdlTraceFlag [ true | false | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam SdlTraceMaxFileSize
This parameter specifies the maximum number of Megabytes of space in each file, before the next file is started. You can update this parameter from SDL Trace Configuration in Cisco Unified CM Serviceability.
Command syntax
set ime serviceparam SdlTraceMaxFileSize [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam SdlTraceTotalNumFiles
This parameter specifies the maximum number of SDL trace files created, before the file count restarts. Old files are overwritten in a round-robin fashion, with the oldest file getting overwritten first. You can update this parameter from the SDL Trace Configuration in Cisco Unified CM Serviceability.
Command syntax
set ime serviceparam SdlTraceTotalNumFiles [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam SdlTraceTypeFlags
This parameter provides an application-specific bit mask, that is used for the application tracing and signal tracing. Retain the default value of the parameter unless a Cisco support engineer instructs otherwise.
Command syntax
set ime serviceparam SdlTraceTypeFlags [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam TLSMaxConnections
This parameter specifies the maximum number of TLS connections the server can have.
Command syntax
set ime serviceparam TLSMaxConnections [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime serviceparam TLSValidationThreshhold
This parameter specifies the maximum number of TLS connections that can be used on this server by the Cisco IME Service, for Validation.
Command syntax
set ime serviceparam TLSValidationThreshhold [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime vapserver
This command changes a parameter value for a vapserver that is administered on this system.
Command syntax
set ime vapserver
authenticationmode vapservername {authenticated | encrypted}
enabled vapservername enabledvalue
keepaliveinterval vapservername secs
maxconnectionsallowed vapservername count
port vapservername portnumber
Parameters
•
•
•
•
•
Options
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime vapusercredentials
This command changes a parameter for a vapusercredentials entry.
Command syntax
set ime vapusercredentials
password appusername password
ticketpassword appusername ticketpassword
Parameters
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set ime vapusercredentials epoch
This command sets the value of the version of the ticketpassword you use.
Command syntax
set ime vapusercredentials epoch {appusername} {value}
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set logging
This command allows you to enable or disable logging.
Command Syntax
set logging {enable | disable}
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
set network dns
This command sets the IP address for the primary or secondary DNS server.
Command Syntax
set network dns {primary | secondary} ip-address
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Note
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network dns options
This command sets DNS options.
Command Syntax
set network dns options [timeout seconds] [attempts number] [rotate]
Parameters
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set network domain
This command sets the domain name for the system.
Command Syntax
set network domain domain-name
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network failover
This command enables or disables network failover.
Command syntax
set network failover {enable | disable}
Parameters
•
•
Usage Guidelines
When you enable network failover a virtual interface (bond0) that uses the ethernet interface eth0, but fails over to eth1 if eth0 fails gets created. All three interfaces (bond0, eth0, and eth1) share the same IP and MAC addresses.
When you disable network failover ethernet interface eth0 with equivalent configuration parameters gets restored and virtual interface bond0 gets removed.
When you set failover a restart of the system occurs.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:set network failover enableCreating virtual interface bond0 to failover ethernet interface eth0 to eth1should eth0 fail.*** W A R N I N G ***This will cause the system to restart - Do you want to continue?Enter "yes" to continue and restart or any other key to abortyesexecuting...Broadcast message from root (Thu Jun 24 13:00:21 2004):The system is going down for restart NOW!set network gateway
This command enables you to configure the IP address of the network gateway.
Command Syntax
set network gateway ip-address
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network hostname
This command sets the network hostname, and restarts the system.
Command Syntax
set network hostname name
Parameters
•
The name should follow ARPANET rules for host names. The hostname must start with an alphabet, end with an alphanumeric, and may contain alphanumeric characters or hyphen in between. The maximum length of the hostname can be 63 characters.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example:
admin:set network hostname myname*** W A R N I N G ***This will cause the system to restart - Do you want to continue ?Enter "yes" to continue and restart or any other key to abortyesexecuting...Broadcast message from root (Thu Jun 24 13:00:21 2004):The system is going down for restart NOW!set network ip
This command sets the IP address for Ethernet interface 0. You cannot configure Ethernet interface 1.
Command Syntax
set network ip eth0 ip-address ip-mask
Parameters
•
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network ipv6
This command sets system and network options for IPv6.
Note
Command Syntax
set network ipv6
dhcp {enable|disable} [reboot]
service {enable|disable} [reboot]
static_address ipv6_address mask [reboot]
Parameters
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network mtu
This command sets the maximum MTU value.
Command Syntax
set network mtu mtu_max
Parameters
•
Note
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:set network mtu 576W A R N I N GThis will cause the system to temporarily lose network connectivityDo you want to continue ?Enter "yes" to continue or any other key to abortyesexecuting...set network max_ip_conntrack
This command sets the ip_conntrack_max value.
Command Syntax
set network max_ip_conntrack ip_conntrack_max
Parameters
•
set network nic
This command sets the properties of the Ethernet Interface 0. You cannot configure Ethernet interface 1.
Command Syntax
set network nic eth0 [auto en | dis] [speed 10 | 100] [duplex half | full]
Parameters
•
auto specifies whether auto negotiation gets enabled or disabled.
speed specifies whether the speed of the Ethernet connection: 10 or 100 Mb/s.
duplex specifies half-duplex or full-duplex.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Note
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network pmtud
This command enables and disables Path MTU Discovery.
Command Syntax
set network pmtud [enable | disable]
Parameters
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:set network pmtud enableW A R N I N GThis will cause the system to temporarily lose network connectivityDo you want to continue ?Enter "yes" to continue or any other key to abortyesexecuting...admin:set network restore
This command configures the specified Ethernet port to use a specified static IP address.
Caution
Caution
Command Syntax
set network restore eth0 ip-address network-mask gateway
Parameters
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set network status
This command sets the status of Ethernet 0 to up or down. You cannot configure Ethernet interface 1.
Command Syntax
set network status eth0 {up | down}
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password age maximum
This command modifies the value for maximum password age, in days, for Cisco Unified Communications Operating System accounts.
Command Syntax
set password age maximum days
Parameters
days specifies the maximum password age and must be greater-than or equal-to 90 days.
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password age minimum
Use this command to modify the value of minimum password age for OS admin accounts in days.
Command syntax
set password age minimum days
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
set password complexity minimum-length
This command modifies the value for the minimum password length for Cisco Unified Communications Operating System accounts.
Note
Command Syntax
set password complexity minimum-length length
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password inactivity
This command enables, disables and configures password inactivity.
Command syntax
set password inactivity [enable | disable | period days]
Parameters
•
Usage guidelines
•
•
A user whose account is disabled must contact the system administrator to use the system again.
•
set password history
This command sets the number of passwords that will be maintained in the history, for OS admin accounts. New passwords that match the existing passwords in history will not be allowed.
Command Syntax
set password history number
Parameters
•
–
–
–
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
set password user
This command allows you to change the administrator and security passwords.
Command Syntax
set password user {admin | security}
Parameters
•
•
Usage Guidelines
The systems prompts you for the old and new passwords.
Note
Servers in a cluster use the security password to authenticate communication between servers. You must reset the cluster after you change the security password.
Procedure
Step 1
Step 2
Note
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set risdc serviceparam RisClientTimeout
This parameter specifies the time, in seconds, that a RIS client will wait for a reply from the Cisco RIS Data Collector service. The RIS Data Collector service running on each node internally, distributes 90 percent of the value specified in this parameter.
Command Syntax
set risdc serviceparam RisClientTimeout [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisCleanupTimeOftheDay
This parameter specifies the time of the day that the RIS database will be cleaned up to remove any unused, old device information. During this time, the NumofRegistrationAttempts performance counters for all devices are reset to 0.
Command Syntax
set risdc serviceparam RisCleanupTimeOftheDay [ paramValue | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisSystemAccessMaxProcessesThreads
This parameter specifies the maximum number of processes and threads that can run on a machine. If the total number of processes and threads running on the machine exceeds this maximum number, SystemAccess sends the TotalProcessesThreadsExceededThresholdStart alarm.
Command Syntax
set risdc serviceparam RisSystemAccessMaxProcessesThreads [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTLCThrottleEnable
This parameter enables or disables the throttling behavior of Trace and Log Central.
Command Syntax
set risdc serviceparam RisTLCThrottleEnable [ true | false | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTLCIOThrottleLimit
This parameter specifies the system IOWait percentage that TLC throttles toward.
Command Syntax
set risdc serviceparam RisTLCIOThrottleLimit [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTLCCPUThrottleLimit
This parameter specifies the system CPU utilization percentage that TLC throttles towards.
Command Syntax
set risdc serviceparam RisTLCCPUThrottleLimit [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTLCThrottlePollRate
This parameter specifies the minimum delay in milliseconds between IO wait and CPU usage polls, for the purpose of trace collection throttling.
Command Syntax
set risdc serviceparam RisTLCThrottlePollRate [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTLCSFTPKeepaliveDelay
This parameter specifies the maximum number of times an SFTP transfer will be paused, in order to prevent timeouts.
Command Syntax
set risdc serviceparam RisTLCSFTPKeepaliveDelay [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTSEnableLogging
This parameter determines whether collecting and logging of troubleshooting perfmon data is enabled (True), or disabled (False).
Command Syntax
set risdc serviceparam RisTSEnableLogging [ true | false | default ]
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTSPollingInterval
This parameter specifies the polling rate for troubleshooting perfmon data, in seconds.
Command Syntax
set risdc serviceparam RisTSPollingInterval [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTSFileSize
This parameter specifies the maximum file size in megabytes, for each troubleshooting perfmon log file, before the next file is started. If the Maximum File Size is set to a large number, you should reduce the Maximum Number of Files.
Command Syntax
set risdc serviceparam RisTSFileSize [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set risdc serviceparam RisTSTotalNumberFiles
This parameter specifies the maximum number of troubleshooting perfmon log files that are saved on the disk. If the Maximum Number of Files is set to a large number, you should reduce the Maximum File Size.
Command Syntax
set risdc serviceparam RisTSTotalNumberFiles [ paramValue ]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set smtp
This command sets the SMTP server hostname.
Command Syntax
set smtp hostname
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
set timezone
This command lets you change the system time zone.
Command Syntax
set timezone timezone
Parameters
•
Note
Usage Guidelines
Enter enough characters to uniquely identify the new time zone. Be aware that the time-zone name is case-sensitive.
Caution
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
This example sets the time zone to Pacific time.
set timezone Pacset trace default
This command sets the default (factory reset) trace configuration for the specified service.
Command syntax
set trace default
Note
Usage Guidelines
Service names comprise:
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set trace status
This command enables or disables the tracing for the specified service.
Command syntaxset trace status
Usage Guidelines
The system prompts you for the status and servicename.
•
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set trace tracelevel
This commands sets the tracelevel for the specified service.
Command syntax
set trace tracelevel
Parameters
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Usage Guidelines
The system prompts you for the tracelevel and the service name.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set trace maxfilesize
This command sets the max trace file size for the specified service.
Command syntax
set trace maxfilesize
Note
Parameters
•
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set trace maxnumfiles
This command sets the maximum trace file count for the specified service.
Command syntax
set trace maxnumfiles
Note
Parameters
•
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set trace usercategories
This command sets the usercategories flag to the value provided for the service specified.
Command syntax
set trace usercategories
Note
Parameters
•
•
–
–
–
–
–
–
–
–
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set web-security
This command sets the web security certificate information for the operating system.
Command Syntax
set web-security orgunit orgname locality state [country alternatehostname]
Parameters
•
Tip
•
•
•
•
•
Note
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
This example shows the set web-security command with multiple organizational unit names that include commas.
set web-security "accounting,personnel\,CA,personnel\,MA" Cisco Milpitas CAIn the above example, the certificate will have three OU fields:
•
•
•
set workingdir
This command sets the working directory for active, inactive, and installation logs.
Command Syntax
set workingdir
activelog directory
inactivelog directory
tftp directory
Parameters
•
•
•
•
Requirements
Command privilege level: 0 for logs, 1 for TFTP
Allowed during upgrade: Yes
Show Commands
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
show account
This command lists current administrator accounts, except the master administrator account.
Command Syntax
show account
Parameters
None
Requirements
Command privilege level: 4
Allowed during upgrade: Yes
show accountlocking
This command displays the current account locking settings.
Command Syntax
show accountlocking
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example:
admin:show accountlockingAccount Lockout is disabledshow alarm
This command displays alarm configurations.
Command syntax
show alarm
Usage Guidelines
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show amc serviceparam AmcCollectionEnabled
This commands displays if the amc serviceparam is enabled (True) for collecting, and alerting of the real-time cluster information.
Command syntax
show amc serviceparam AmcCollectionEnabled
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
show amc serviceparam AmcCollectionPollingRate
This command displays the AMC collecting rate, in seconds.
Command syntax
show amc serviceparam AmcCollectionPollingRate
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
show amc serviceparam AlertMgrEnabled
This parameter enables or disables the alerting (email/epage) feature. This command is used for AMC troubleshooting purpose only.
Command syntax
show amc serviceparam AlertMgrEnabled
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
show amc serviceparam LoggerEnabled
This parameter enables or disables the logging feature(.csv files for generating reports). This command is used for AMC troubleshooting purpose only.
Command syntax
show amc serviceparam LoggerEnabled
Requirements
Command Privilege level: 0
Allowed During Upgrade: Yes
show auditlog
This command displays the AuditLog configuration.
Command syntax
show auditlog
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show auditlogconfig
This command displays the AuditLog configuration.
Command syntax
show auditlogconfig
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show cert
This command displays certificate contents and certificate trust lists.
Command Syntax
show cert
own filename
trust filename
list {own | trust}
Parameters
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show cli pagination
This command displays the status of automatic CLI pagination.
Command Syntax
show cli pagination
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin: show cli paginationAutomatic Pagination : Off.show csr own
This command displays the selected own certificate file.
Command syntax
show csr own name
Parameters
•
Usage Guidelines
You can get the certificate name by executing the show cert list own command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
admin:show csr own tomcat/tomcat.csr[[-----BEGIN CERTIFICATE SIGN REQUEST-----MIIDrDCCAxUCBENeUewwDQYJKoZIhvcNAQEEBQAwggEbMTQwMgYDVQQGEytVbmFibGUgdG8gZmluZCBDb3VudHJ5IGluIHBsYXRmb3JtIGRhdGFiYXNlMTIwMAYDVQQIEylVbmFibGUgdG8gZmluZCBTdGF0ZSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTE1MDMGA1UEBxMsVW5hYmxlIHRvIGZpbmQgTG9jYXRpb24gaW4gcGxhdGZvcm0gZGF0YWJhc2UxMDAuBgNVBAoTJ1VuYWJsZSB0byBmaW5kIE9yZyBpbiBwbGF0Zm9ybSBkYXRhYmFzZTExMC8GA1UECxMoVW5hYmxlIHRvIGZpbmQgVW5pdCBpbiBwbGF0Zm9ybSBkYXRhYmFzZTETMBEGA1UEAxMKYmxkci1jY20zNjAeFw0wNTEwMjUxNTQwMjhaFw0xMDEwMjQxNTQwMjhaMIIBGzE0MDIGA1UEBhMrVW5hYmxlIHRvIGZpbmQgQ291bnRyeSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTEyMDAGA1UECBMpVW5hYmxlIHRvIGZpbmQgU3RhdGUgaW4gcGxhdGZvcm0gZGF0YWJhc2UxNTAzBgNVBAcTLFVuYWJsZSB0byBmaW5kIExvY2F0aW9uIGluIHBsYXRmb3JtIGRhdGFiYXNlMTAwLgYDVQQKEydVbmFibGUgdG8gZmluZCBPcmcgaW4gcGxhdGZvcm0gZGF0YWJhc2UxMTAvBgNVBAsTKFVuYWJsZSB0byBmaW5kIFVuaXQgaW4gcGxhdGZvcm0gZGF0YWJhc2UxEzARBgNVBAMTCmJsZHItY2NtMzYwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMoZ4eLmk1Q3uEFwmb4iU5nrMbhmJ7bexSnC3PuDGncxT3Au4zpGgMaQRL+mk+dAt8gDZfFKz8uUkUoibcUhvqk4h3FoTEM+6qgFWVMkgSNUU+1i9MST4m1aq5hCP87GljtPbnCXEsFXaKH+gxBq5eBvmmzmO1D/otXrsfsnmSt1AgMBAAEwDQYJKoZIhvcNAQEEBQADgYEAKwhDyOoUDiZvlAOJVTNF3VuUqv4nSJlGafB6WFldnh+3yqBWwfGnQ3ocBr9CZ5OTt7N6asZth4ggZ0ihJGXy6LKQmuUNIlJbNyQteM2Ak/E6usYBiCmUq0uhkf8g+ZFcUmmqGOBORwQDSAEC69T98IUeTYM3jBwtGFRE3qsxWok=-----END CERTIFICATE SIGN REQUEST -----show csr list own
This command displays the own CSR file.
Command syntax
show csr list own
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
admin:show csr list owntomcat/tomcat.csrVipr-QuetzalCoatl/Vipr-QuetzalCoatl.csrshow date
The command displays the date and time on the server.
Command syntax
show date
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show diskusage
This command displays information about disk usage on the server.
Command Syntax
show diskusage
activelog {filename filename | directory | sort}
common {filename filename | directory | sort}
inactivelog {filename filename | directory | sort}
install {filename filename | directory | sort}
tftp {filename filename | directory | sort}
tmp {filename filename | directory | sort}
Parameters
•
•
•
•
•
•
Options
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show environment
This command displays environmental information for three types of hardware components.
Command Syntax
show environment
fans
power-supply
temperatures
Options
•
•
•
Note
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show enterprise serviceparam ClusterID
This parameter provides a unique identifier for this cluster.
Command Syntax
show enterprise serviceparam ClusterID
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show enterprise serviceparam RemoteSyslogServerName
Enter the name or the IP address of the remote Syslog server that should accept Syslog messages. If the server name is not specified, Cisco Unified Serviceability does not send the Syslog messages. Do not specify a Cisco Unified Communications Manager.
Command Syntax
show enterprise serviceparam RemoteSyslogServerName
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show enterprise serviceparam RemoteSyslogSeverity
This command displays the selected severity of the Syslog messages that are sent to the remote syslog server. All the syslog messages with the selected or higher severity level are sent to the remote syslog server. If remote server name is not specified, Cisco Unified Serviceability does not send the Syslog messages.
Command Syntax
show enterprise serviceparam RemoteSyslogSeverity
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show hardware
This command displays the following information on the platform hardware.
Command Syntax
show hardware
Usage Guidelines
This command displays the following information on the platform hardware:
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime accesscontrollist
This command displays the black-listed peerids.
Command syntax
show ime accesscontrollist
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime addressing dht
This command displays the dht addressing configuration for this overlay.
Command syntax
show ime addressing dht
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime addressing validator
This command displays the validator addressing configuration for this overlay.
Command syntax
show ime addressing validator
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime certenrollment serverID
This will retrieve the Cisco IME Server ID number assigned by the Certification Authority.
Command syntax
show ime certenrollment serverID
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example:
admin:show ime certenrollment serverIDCisco IME ServerID: 12345show ime dht config local
This command displays local DHT configuration data associated with this server.
Command syntax
show ime dht config local
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime motd
This command displays the Message of the Day for the system.
Command syntax
show ime motd
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime dht
This dynamic command shows the current status for the server.
Command syntax
show ime dht
peerIDStatus [peerID | all]
summary peerID
route-table peerID
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime dht counters
This command displays all the DHT counters.
Command syntax
show ime dht counters
server
peer
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime peerid
This command displays the peerids for the server.
Command syntax
show ime peerid [peerID | peerIndex | all]
Parameters
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam DhtRcvdMsgTraceFlag
This parameter specifies whether the received DHT messages should be traced.
Command syntax
show ime serviceparam DhtRcvdMsgTraceFlag
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam DhtSentMsgTraceFlag
This parameter specifies whether the DHT messages sent should be traced.
Command syntax
show ime serviceparam DhtSentMsgTraceFlag
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam MaxVtraceP2pRecordsPerPeer
This parameter specifies the maximum number of P2P vtrace records that would be maintained.
Command syntax
show ime serviceparam MaxVtraceP2pRecordsPerPeer
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam MaxVtraceValRecordsPerPeer
This parameter specifies the maximum number of Validation vtrace records that would be maintained. Increasing this number makes the vtrace feature use more space.
Command syntax
show ime serviceparam MaxVtraceValRecordsPerPeer
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam MaxVtraceVapRecordsPerPeer
This parameter specifies the maximum number of VAP vtrace records that would be maintained. Increasing this number makes the vtrace feature use more space.
Command syntax
show ime serviceparam MaxVtraceVapRecordsPerPeer
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam MaxVtraceTlsRecordsPerPeer
This parameter specifies the maximum number of TLS vtrace records that would be maintained. Increasing this number makes the vtrace feature use more space.
Command syntax
show ime serviceparam MaxVtraceTlsRecordsPerPeer
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam MaxVtraceFetchRecordsPerPeer
This parameter specifies the maximum number of fetch records per peer, that vtrace maintains. Increasing this number makes the vtrace feature to use more space.
Command syntax
show ime serviceparam MaxVtraceFetchRecordsPerPeer
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam MaxVtraceStoreRecordsPerPeer
This parameter specifies the maximum number of store records per peer that vtrace would maintain. Increasing this number makes the vtrace feature use more space.
Command syntax
show ime serviceparam MaxVtraceStoreRecordsPerPeer
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam NetMaskForNATEnvironment
This parameter is used in a NAT environment to determine if outbound TCP/TLS connections are attempted to a remote IME Server, using its configured public or private IP address. The public and private IP addresses for an IME Server can be displayed.
Command syntax
show ime serviceparam NetMaskForNATEnvironment
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam SdlTraceDataFlags
This parameter provides a bit mask for enabling tracing of SDL non-application-specific components, or for modifying the behavior of SDL tracing. Keep this parameter set to the default value, unless a Cisco support engineer instructs otherwise.
Command syntax
show ime serviceparam SdlTraceDataFlags
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam SdlTraceDataSize
This command displays the number of bytes of raw SDL data that has been dumped into the SDL trace file, for each signal.
Command syntax
show ime serviceparam SdlTraceDataSize
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam SdlTraceFlag
This parameter indicates whether the SDL traces are enabled. Valid values can be True or False.
Command syntax
show ime serviceparam SdlTraceFlag
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam SdlTraceMaxFileSize
This parameter specifies the maximum number of Megabytes of space in each file, before the next file is started. You can update this parameter from the SDL Trace Configuration in Cisco Unified CM Serviceability.
Command syntax
show ime serviceparam SdlTraceMaxFileSize
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam SdlTraceTotalNumFiles
This parameter specifies the maximum number of SDL trace files created, before the file count restarts. Old files are overwritten in a round-robin fashion, with the oldest file getting overwritten first. You can update this parameter from the SDL Trace Configuration in Cisco Unified CM Serviceability.
Command syntax
show ime serviceparam SdlTraceTotalNumFiles
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam SdlTraceTypeFlags
This parameter provides an application-specific bit mask, that is used for the application tracing and signal tracing. Retain the default value of the parameter unless a Cisco support engineer instructs otherwise.
Command syntax
show ime serviceparam SdlTraceTypeFlags
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam TLSMaxConnections
This parameter specifies the maximum number of TLS connections the server can have.
Command syntax
show ime serviceparam TLSMaxConnections
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime serviceparam TLSValidationThreshhold
This parameter specifies the maximum number of TLS connections that can be used on this server by the Cisco IME Service, for Validation.
Command syntax
show ime serviceparam TLSValidationThreshhold
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime software-config version
This command displays the contents of the software configuration table. This table contains instructions for upgrading software versions.
Command syntax
show ime software-config version [versionnumber | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation counters
This command displays information about the validation counters.
Command syntax
show ime validation counters
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show ime validation countersDID Not Found in DHT = 2Route Sent = 2Original sRP attempts = 2sRP validation attempts = 1Total terminal VCR records = 4DHT Sent Message CountersDHT Reads............................ = 1DHT Stores........................... = 180DHT Reads/Sec........................ = 0DHT Stores/Sec....................... = 0DHT Remove Reqs...................... = 0DHT Ping Reqs........................ = 1DHT Fetch Err........................ = 0DHT Store Err........................ = 0DHT Remove Err....................... = 0DHT Ping Err......................... = 0DHT Received Message CountersDHT Fetch Reqs....................... = 1DHT Store Reqs....................... = 19620DHT Fetch/Sec........................ = 0DHT Store/Sec........................ = 0DHT Remove Req....................... = 0DHT Ping Reqs........................ = 1DHT Diag. Reqs....................... = 0DHT Diag./Sec........................ = 0DHT Maintenance CountersMtce StoreRepls Sent................. = 108Mtce UpdateReqs Sent................. = 50099Mtce PingDhtReqs Sent................ = 83341Mtce S-CDhtReqs Sent................. = 8352Mtce JoinDhtReqs Sent................ = 1Mtce UpdateReqs Recv................. = 49731Mtce PingDhtReqs Recv................ = 82821Mtce S-CDhtReqs Recv................. = 12443Mtce JoinDhtReqs Recv................ = 0show ime validation details
This command displays all DiDs for validations that are discarded, failed-noroute, success, failed, pending, rate-limited, confirmation-required and remote-terminated.
Command syntax
show ime validation details [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation DID
This command displays all DiDs for validations.
Command syntax
show ime validation DID [all]
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation originating-aborted
This commands lists the most recent DiDs that did not validate because the DiD could not be retrieved from the DHT. Presence of a DiD in this list does not indicate a failure. The DiD may not be published by a IME server.
Command syntax
show ime validation discarded
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation pending
This command displays the most recent validation-pending DiDs. Each pending DiD indicates that the number has successfully validated, but the IME server is waiting for sufficient entropy before passing the learned routes to Cisco Unified CM as successful validations.
Command syntax
show ime validation pending [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation summary
This command displays all the public keys with counters for discarded, failed-noroute, success, failed, pending, rate-limited, confirmation-required and remote-terminated validations.
Command syntax
show ime validation summary
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation success
This command lists the most recent successfully validated DiDs. Each successfully validated DiD indicates that the learned route has been passed to the Cisco Unified CM.
Command syntax
show ime validation success [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation confirmation-required
This command displays the most recent validation-pending DiDs that are awaiting further validations.
Each confirmation-required DiD indicates that the number has successfully validated, but IME server is waiting for more successful validations to this same DiD since a previous validation failed.
Command syntax
show ime validation confirmation-required [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation terminating-aborted
This command displays the most recent remote-terminated DiDs. Each remote-terminated DiD indicates that a validation attempt was initiated to the given public key, but the validation failed because the terminating IME server could not find a matching call record or had too many overlapping call records to complete validation.
Command syntax
show ime validation remote-terminated [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation failed
This command lists the most recent validation failed DiDs. Each DiD failure indicates that a validation attempt was made to the given public key, but the validation failed due to mismatched VCR records.
Command syntax
show ime validation failed [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validation route-discarded
This command displays the most recent DiDs that validated successfully, but failed to send to the Cisco Unified CM because a subsequent failed validation occurred.
Command syntax
show ime validation failed-to-send [public key | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime validator config
This command displays validator configuration data.
Command syntax
show ime validator config {global | local}
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime vapserver
This command displays the vapserver entries that get administered on the server, and the ports they use, as well as other associated parameters (for example, authentication).
Command syntax
show ime vapserver [vapservername | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime vapstatus summary
This command displays the registration status for the client specified by port number.
Command syntax
show ime vapstatus summary [port | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime vapstatus subscriptions
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Command syntax
show ime vapstatus subscriptions [clientname | all]
Parameters
•
•
show ime vapusercredentials
This command displays user credentials.
Command syntax
show ime vapusercredentials [appusername | all]
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime voicerecord details
This command displays the voicerecord details.
Command syntax
show ime voicerecord details
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime voicerecord summary
This command displays the voicerecord summary.
Command syntax
show ime voicerecord summary
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ime vservice
This command displays information about the Vservices that are published.
Command syntax
show ime vservice {details | summary}
details
summary
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show logins
This command lists recent logins to the server.
Command Syntax
show logins number
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show memory
This command displays information about the onboard memory.
Command Syntax
show memory
count
modules
module {modulenumber | all}
size
Options
•
•
•
•
•
Parameters
None
show memory module [module number]
module number mandatory module number to be fetched or ALL
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show myself
This command displays information about the current account.
Command Syntax
show myself
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show network
This command displays network information.
Command Syntax
show network
cluster
eth0 [detail]
failover [detail] [page]
route [detail]
status [detail] [listen] [process] [all] [nodns] [search stext]
ip_conntrack
max_ip_conntrack
dhcp eth0 status
all [detail]
Parameters
•
•
•
•
•
•
•
•
•
Options
•
•
•
•
•
•
•
Usage Guidelines
The eth0 parameter displays Ethernet port 0 settings, including DHCP and DNS configurations and options.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
This example displays active Internet connections.
show network statusshow network ipprefs
This command displays the list of ports that have been requested to be opened or translated in the firewall.
Command Syntax
ipprefs {all | enabled | public}
Parameters
all—Displays all incoming ports that may be used on the product.
enabled—Displays all incoming ports that are currently opened.
public—Displays all incoming ports that are currently opened for any remote client.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show network ipprefs publicApplication IPProtocol PortValue Type XlatedPort Status Description------------ ------------ ------------ ------------ ------------ ------------ ------------sshd tcp 22 public - enabled sftp and ssh accesstomcat tcp 8443 translated 443 enabled secure web accesstomcat tcp 8080 translated 80 enabled web accessclm udp 8500 public - enabled cluster managerclm tcp 8500 public - enabled cluster managerntpd udp 123 public - enabled network time syncsnmpdm udp 161 public - enabled SNMPccm tcp 2000 public - enabled SCCP-SIGctftp udp 6969 translated 69 enabled TFTP access to CUCM TFTP Serverctftp tcp 6970 public - enabled HTTP access to CUCM TFTP Serveradmin:show network ipv6
This command displays IPv6 network routes and network settings.
Note
Command Syntax
show network ipv6 {route | settings}
Parameters
route displays all IPv6 routes.
settings displays IPv6 network settings.
Command privilege level: 0
Allowed during upgrade: Yes
show open
This command displays open files and ports on the system.
Command Syntax
show open
files [all] [process processID] [regexp reg_exp]
ports [all] [regexp reg_exp]
Parameters
•
•
Options
•
•
•
•
•
show packages
This command displays the name and version for installed packages.
Command Syntax
show packages
active name [page]
inactive name [page]
Parameters
name represents the package name. To display all active or inactive packages, use the wildcard character, *.
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password age
This command displays the information about the configured password.
Command Syntax
show password
age - displays information about the configured password age parameters
expiry [minimum-age | maximum-age] - displays the configured password expiration parameters.
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password complexity character
This command displays the status of the password complexity as enabled or disabled.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Command syntax
show password complexity character
Parameters
None
Usage Guidelines
When enabled, the passwords must adhere to the following guidelines:
•
•
•
•
•
•
•
A violation of any of the above rules will result in a failure.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password complexity length
This command displays the minimum length of Unified CM OS account passwords. The default specifies 6.
Command syntax
show password complexity length
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password history
This command displays the number of passwords that are maintained in the password history, for OS admin accounts.
Command syntax
show password history
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password inactivity
This command displays the status of password inactivity.
Command syntax
show password inactivity
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show perf counterhelp
This command displays the description of the specified perfmon counter.
Command syntax
show perf counterhelp class-name counter-name
Parameters
•
•
Usage Guidelines
If class-name or counter-name contains white space, class-name or counter-name should be included in double quotes.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf counterhelp System "Total Threads"==>perf counter (System -> Total Threads) has help text:* help text :- This represents the total number of threads on the system.show perf list categories
This command displays all categories in the perfmon system.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Command syntax
show perf list categories
Parameters
None
Example
admin:show perf list categories==>list categories:...- RISSystemAccess...show perf list classes
This command displays perfmon classes (objects).
Command syntax
show perf list classes [cat category | cat category detail | detail]
Parameters
•
•
Usage Guidelines
If the category name contains white space, category should be included in double quotes.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf list classes cat RISSystemAccess detail==>list classes for category (RISSystemAccess) :* Display Name Enum ClassId- Process 1 0- Partition 2 32- Memory 3 58- Processor 4 106- Thread 5 124- IP 6 130- TCP 7 160- Network Interface 8 180- System 9 206- IP6 10 222show perf list counters
This command displays perfmon counters in a specified perfmon class.
Command syntax
show perf list counters class-name [detail]
Parameters
class-name is mandatory and specifies the perf class to display.
Options
detail displays detailed information.
Usage Guidelines
If the class-name contains white space, class-name should be included in double quotes.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf list counters System detail==>perf class (System) has counters:* Display Name CounterId- Allocated FDs 208- Being Used FDs 212- Freed FDs 210- Max FDs 214- Total CPU Time 220- Total Processes 216- Total Threads 218show perf list instances
This command displays perfmon instances of a specified perfmon class
Command syntax
show perf list instances class-name [detail]
Parameters
•
Options
•
Usage Guidelines
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
If the class-name contains white space, class name should be included in double quotes.
Example
admin:show perf list instances Processor detail==>perf class (Processor) has instances:* Instance Name index- _Total 0- 0 1- 1 2show perf query path
This command queries specific perfmon path(s).
Command syntax
show perf query path path-spec
Parameters
path-spec is mandatory and represents the perfmon query path to display.
If the perfmon class is instance-based, path-spec comprises:
class-name(instance-name)\counter-name (for example "Processor(0)\System Percentage".)
If the perfmon class is not instance-ased (singleton), path-spec comprises:
class-name\counter-name (for example "System\Total CPU Time".)
Usage Guidelines
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf query path "Processor(0)\System Percentage,System\Total CPU Time"- query path :Processor(0)\System Percentage = 0System\Total CPU Time = 56273840Processor(0)\System Percentage = 9System\Total CPU Time = 56274645show perf query class
This command queries perfmon class(es) to display all instances and counter values of each instance.
Command syntax
show perf query class class-name
Parameters
class-name is mandatory and specifies the display name of the perfmon class.
Usage Guideline
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf query class System,TCP==>query class :- Perf class (System) has instances and values:-> Allocated FDs = 66345-> Being Used FDs = 66345-> Freed FDs = 0-> Max FDs = 102535-> Total CPU Time = 56309336-> Total Processes = 96-> Total Threads = 314- Perf class (TCP) has instances and values:-> Active Opens = 151754-> Attempt Fails = 0-> Curr Estab = 37-> Estab Resets = 131-> In Segs = 3688813-> InOut Segs = 7328568-> Out Segs = 3639755-> Passive Opens = 58152-> RetransSegs = 45show perf query counter
This command queries the specified counter to show the counter value of all instances.
Command syntax
show perf query counter class-name counter-name counter-name
Parameters
•
•
Usage Guidelines
If class-name or counter-name contains white space, the name should be included in double quotes.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf query counter System "Max FDs"- Perf class System(Max FDs) has values:-> Max FDs = 102535admin:show perf query counter System "Max FDs,Total Threads"- Perf class System(Max FDs,Total Threads) has values:-> Max FDs = 102535-> Total Threads = 324show perf query instance
This command queries a particular instance to show all counter values. This command is not applicable for singleton perfmon class.
Command syntax
show perf query instance {class-name} instance-name instance-name
Parameters
•
•
Usage Guidelines
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:show perf query instance Processor 0,1- Perf class Processor(0,1) has values:0 -> % CPU Time = 220 -> IOwait Percentage = 10 -> Idle Percentage = 780 -> Irq Percentage = 00 -> Nice Percentage = 40 -> Softirq Percentage = 00 -> System Percentage = 140 -> User Percentage = 31 -> % CPU Time = 221 -> IOwait Percentage = 11 -> Idle Percentage = 781 -> Irq Percentage = 01 -> Nice Percentage = 31 -> Softirq Percentage = 01 -> System Percentage = 131 -> User Percentage = 5show process
This command displays information about processes that run on the system.
Syntax
show process
list [file filename] [detail]
load [cont] [clear] [noidle] [num number] [thread] [cpu | memory| time] [page]
name process [file filename]
open-fd process-id [, process-id2]
pid pid [file file-name]
search regexp [file filename]
user username [file filename]
using-most cpu [number] [file filename]
using-most memory [number] [file filename]
Parameters
•
•
•
•
•
•
•
•
Options
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
show registry
This command displays the contents of the registry.
Command syntax
show registry {system} {component} [name] [page]
Parameters
•
•
•
•
Usage Guidelines
If the name of the parameter that you want to display is 'page', and you want to page the output, use the following command:
show registry system component page page
Example
admin:show registry cm dbl/sdisystem = cmcomponent = dbl/sditracelevel=127enable=1outputdebugstringflag=0numminutes=1440tracefile=/var/log/active/cm/trace/dbl/sdi/dbl.lognumfiles=250numlines=10000Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdb list
This command displays the list of tables supported in Realtime Information Service(RIS) database.
Command syntax
show risdb list [file filename]
Parameters
file filename specifies the file into which the output goes.
Usage Guidelines•
•
•
Example
admin: show risdb list file TableListRequirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdb query
This command displays the contents of the Realtime Information Service(RIS) database.
Command syntax
show risdb query [tablename] [tablename] file filename
Parameters
•
•
Usage Guidelines
•
•
•
Example
admin: show risdb query genalarm file genalarmtableRequirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisClientTimeout
This parameter specifies the time, in seconds, that a RIS client will wait for a reply from the Cisco RIS Data Collector service. The RIS Data Collector service running on each node internally, distributes 90 percent of the value specified in this parameter.
Command syntax
show risdc serviceparam RisClientTimeout
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisCleanupTimeOftheDay
This parameter specifies the time of the day that the RIS database will be cleaned up to remove any unused, old device information. During this time, the NumofRegistrationAttempts performance counters for all devices are reset to 0.
Command syntax
show risdc serviceparam RisCleanupTimeOftheDay
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisSystemAccessMaxProcessesThreads
This parameter specifies the maximum number of processes and threads that can run on a machine. If the total number of processes and threads running on the machine exceeds this maximum number, SystemAccess sends the TotalProcessesThreadsExceededThresholdStart alarm.
Command syntax
show risdc serviceparam RisSystemAccessMaxProcessesThreads
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTLCThrottleEnable
This parameter enables or disables the throttling behavior of Trace and Log Central.
Command syntax
show risdc serviceparam RisTLCThrottleEnable
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTLCIOThrottleLimit
This parameter specifies the system IOWait percentage that TLC throttles toward.
Command syntax
show risdc serviceparam RisTLCIOThrottleLimit
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTLCCPUThrottleLimit
This parameter specifies the system CPU utilization percentage that TLC throttles towards.
Command syntax
show risdc serviceparam RisTLCCPUThrottleLimit
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTLCThrottlePollRate
This parameter specifies the minimum delay in milliseconds between IO wait and CPU usage polls, for the purpose of trace collection throttling.
Command syntax
show risdc serviceparam RisTLCThrottlePollRate
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTLCSFTPKeepaliveDelay
This parameter specifies the maximum number of times an SFTP transfer will be paused, in order to prevent time-outs.
Command Syntax
show risdc serviceparam RisTLCSFTPKeepaliveDelay
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTSEnableLogging
This parameter determines whether collecting and logging of troubleshooting perfmon data is enabled (True), or disabled (False).
Command Syntax
show risdc serviceparam RisTSEnableLogging
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTSPollingInterval
This parameter specifies the polling rate for troubleshooting perfmon data, in seconds.
Command Syntax
show risdc serviceparam RisTSPollingInterval
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTSFileSize
This parameter specifies the maximum file size in megabytes, for each troubleshooting perfmon log file, before the next file is started. If the Maximum File Size is set to a large number, you should reduce the Maximum Number of Files.
Command Syntax
show risdc serviceparam RisTSFileSize
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show risdc serviceparam RisTSTotalNumberFiles
This parameter specifies the maximum number of troubleshooting perfmon log files that are saved on the disk. If the Maximum Number of Files is set to a large number, you should reduce the Maximum File Size.
Command Syntax
show risdc serviceparam RisTSTotalNumberFiles
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show smtp
This command displays the name of the SMTP host.
Command Syntax
show snmp
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show stats io
This command displays system IO statistics.
Command Syntax
show stats io [kilo] [detail] [page] [file filename]
Options
•
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show status
This command displays basic platform status.
Command Syntax
show status
Usage Guidelines
This command displays the following basic platform status:
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 0
show tech all
This command displays the combined output of all show tech commands.
Command Syntax
show tech all [page] [file filename]
Options
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech network
This command displays network aspects of the server.
Command Syntax
show tech network
all [page] [search text] [file filename]
hosts [page] [search text] [file filename]
interfaces [page] [search text] [file filename]
resolv [page] [search text] [file filename]
routes [page] [search text] [file filename]
sockets {numeric}
Parameters
•
•
•
•
•
•
Options
•
•
•
•
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech system
The show tech system command gets updated as described in this section. This command displays system aspects of the server.
Command Syntax
show tech system
all [page] [file filename]
bus [page] [file filename]
hardware [page] [file filename]
host [page] [file filename]
kernel modules [page] [file filename]
software [page] [file filename]
tools [page] [file filename]
Parameters
•
•
•
•
•
•
•
Options
•
•
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech runtime
This command displays runtime aspects of the server.
Command Syntax
show tech runtime
all [page] [file filename]
cpu [page] [file filename]
disk [page] [file filename]
env [page] [file filename]
memory [page] [file filename]
Parameters
•
•
•
•
•
Options
•
•
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name cannot contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show timezone
This command displays time zone information.
Command Syntax
show timezone
config
list [page]
Parameters
•
•
Note
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show trace
This command displays the trace configuration for the specified service.
Command syntax
show trace
Usage Guidelines
The system prompts you for the service name. Service names comprise:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Enter all to display the trace configurations of all the services.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show tracelevels
This command displays the allowed trace levels for the specified service name.
Command syntax
show tracelevels
Usage Guidelines
The system prompts you for the service name. Service names comprise:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show ups status
This command shows the current status of the USB-connected APC smart-UPS device and starts the monitoring service if it is not already started.
This command provides full status only for 7835-H2 and 7825-H2 servers.
Command Syntax
show ups status
show version
Be aware that this command displays the software version on the active or inactive partition.
Command Syntax
show version
active
inactive
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show web-security
This command displays the contents of the current web-security certificate.
Command Syntax
show web-security
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show workingdir
This command retrieves the current working directory for activelog, inactivelog, install, and TFTP.
Command Syntax
show workingdir
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Unset Commands
•
unset network dns options
This command unsets DNS options.
Command Syntax
unset network dns options [timeout] [attempts] [rotate]
Parameters
•
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
unset network ipv6 static_address
This command unsets the ipv6 static address.
Command syntax
unset network ipv6 static_address [reboot]
Parameters
•
Example
admin:unset network ipv6 static_address*** W A R N I N G ***The Server must be rebooted for these changes to take effect.Please make sure that you reboot this server.IPv6 static address was removed.Requirements
Command privilege level: 1
Allowed during upgrade: No
Utils Commands
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
utils auditd
This command enables, disables, and provides the status of audit logging. When enabled, the system monitors and records user actions in both Cisco Unified Communications Manager and Cisco Unified Serviceability.
Cisco recommends that you retrieve the audit log by using the Real Time Monitoring Tool, but you can also retrieve it by using the CLI.
Command Syntax
utils auditd {enable | disable | status}
Parameters
•
•
•
utils ime certenrollment enroll
This command enrolls with GoDaddy WebService, to obtain the GoDaddy CA signed certficate for Cisco IME Server.
Command Syntax
utils ime certenrollment enroll
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example:
admin:utils ime certenrollment enrollCongratulations, Cisco IME Certificate Enrollment Successfulutils ime enroll
This command communicates with GoDaddy WebService to obtain the GoDaddy CA signed certficate for the ime server
Command syntax
utils ime enroll
Parameters
None
ime Certificate Enrollment SuccessfulRequirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:utils ime enrollutils ime fetch did
This command indicates whether or not the DID was found in the DHT or not.
If a DID is found, that means it was published by a IME server somewhere on the network.
Command syntax
utils ime fetch did
Parameters
did specifies the number you want to look for in the system.
Example
utils ime fetch did +3035551001
This command will return either:
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ime license file install
This command install license files.
Command syntax
utils ime license file install file-name
Parameters
•
Usage Guidelines
This command assumes that the user has uploaded the license file on the system in the SFTP license directory. When this command is executed it looks into this directory and then installs the file.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ime license file list
This command lists all the installed license files.
Command syntax
utils ime license file list
page
detail
reverse
date
size
Parameters
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ime license file report
This command allows the user to view random number, signature, and peer ID count information, which gets used to obtain the certificate for the IME server.
Command syntax
utils ime license file report
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ime license file view
This command displays the contents of certain license file.
Command syntax
utils ime license file view file-name
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ime reset peerid
This command resets the peerID.
Command syntax
utils ime reset peerid peerID
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils core active
This command affects existing core files.
Command syntax
utils core active
list
analyze core_file_name
Parameters
•
•
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils core inactive list
This command displays a list of core files.
Command Syntax
utils core inactive list
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils core inactive analyze
This command displays backtrace for the specified core file. A list of core files can be obtained via the utils core inactive list command.
Command Syntax
utils core inactive analyze core_file_name
Parameter
core_file_name (mandatory) specifies the name of the core file from which to get a stack trace.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils create report
This command creates reports about the server in the platform/log directory.
Command Syntax
utils create report
hardware
platform
csa
Parameters
•
•
•
Usage Guidelines
You are prompted to continue after you enter the command.
After creating a report, use the command file get activelog platform/log/filename, where filename specifies the report filename that displays after the command completes, to get the report.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils csa disable
This command stops Cisco Security Agent (CSA).
Command Syntax
utils csa disable
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils csa enable
This command enables Cisco Security Agent (CSA).
Command Syntax
utils csa enable
Usage Guidelines
The system prompts you to confirm that you want to enable CSA.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils csa status
This command displays the current status of Cisco Security Agent (CSA).
Command Syntax
utils csa status
Usage Guidelines
The system indicates whether CSA is running.
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils diagnose
This command enables you to diagnose and attempt to automatically fix system problems.
Command Syntax
utils diagnose
fix
list
module module_name
test
version
Parameters
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils disaster_recovery backup local
This command invokes the backup and creates the tar file on the local drive.
Command syntax
utils disaster_recovery backup local featurelist device_name
Parameters
•
•
Usage Guidelines
Use utils disaster_recovery show_registration to display the list of registered features.
Use utils disaster_recovery device list to display the configured device list.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:utils disaster_recovery backup local VIPR localdeviceBackup initiated successfully.Please run 'utils showstatus backup' command to see the status.utils disaster_recovery backup tape
This command starts a backup job and stores the resulting Tar file on tape.
Command Syntax
utils disaster_recovery backup tape featurelist tapeid
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery backup network
This command starts a backup job and stores the resulting Tar file on a remote server.
Command Syntax
utils disaster_recovery backup network featurelist path servername username
Parameters
•
•
•
•
Usage Guidelines
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery cancel_backup
This command cancels the ongoing backup job.
Command Syntax
utils disaster_recovery cancel_backup
Usage Guidelines
The system prompts you to confirm that you want to cancel the backup job.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery device add
This command adds:
•
•
•
Command Syntax
utils disaster_recovery device add
local device_name Number_of_backups
network device_name path server_name username Number_of_backups
tape device_name tapeid
Parameters
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Examples:
admin:utils disaster_recovery device add local localBackup 3admin:utils disaster_recovery device add network networkDevice /root10.77.31.116 root 3admin:utils disaster_recovery device add tape tapeDevice /dev/nst0utils disaster_recovery device delete
This command deletes the specified device.
Command syntax
utils disaster_recovery device delete [device_name|*]
Parameters
•
Usage Guidelines
This command deletes all the existing devices except for the ones associated to a schedule.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery device list
This command display the device name, device type and device path for all the backup device.
Command syntax
utils disaster_recovery device list
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery restore local
This command invokes the restore and takes the tar file from network drive.
Command syntax
utils disaster_recovery restore local restore_server tarfilename device_name
Parameters
•
•
•
Usage Guidelines
Use utils disaster_recovery device list to display the configured device list.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:utils disaster_recovery restore local SW075B-CM11 2008-01-21-18-25-03 localdeviceRestore initiated successfully.Please run 'utils showstatus restore' command to see the status.utils disaster_recovery restore tape
This command starts a restore job and takes the backup tar file from tape.
Command syntax
utils disaster_recovery restore tape server tarfilename tapeid
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery restore network
This command starts a restore job and takes the backup Tar file from a remote server.
Command Syntax
utils disaster_recovery restore network restore_server tarfilename path servername username
Parameters
•
•
•
•
•
Usage Guidelines
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery schedule
This command affects schedules that are configured.
Command syntax
utils disaster_recovery schedule
list
Command privilege level: 1
Allowed during upgrade: Yes
add schedulename devicename featurelist datetime frequency
Command privilege level: 1
Allowed during upgrade: No
enable schedulename
Command privilege level: 1
Allowed during upgrade: No
disable schedulename
Command privilege level: 1
Allowed during upgrade: No
delete [schedulename|*]
Command privilege level: 1
Allowed during upgrade: No
Parameters
•
•
•
•
•
Options
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
List Example
admin:utils disaster_recovery schedule listschedule name device name Schedule Status----------------------------------------schedule1 dev1 enabledschedule2 dev2 disabledEnable Example
utils disaster_recovery schedule enable schedule1Schedule enabled successfully.Disable Example
utils disaster_recovery schedule disable schedule1Schedule disabled successfully.
utils disaster_recovery show_backupfiles local
Command syntax
utils disaster_recovery show_backupfiles local backup|restore
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example:
admin:utils disaster_recovery show_backupfiles local backup/restore2009-05-14-21-12-002009-05-16-21-12-00utils disaster_recovery show_backupfiles tape
This command retrieves information of backup files available on tape.
Command syntax
utils disaster_recovery show_backupfiles tape tapeid
Parameters
•
Usage Guidelines
To display the list of tape IDs, execute the utils disaster_recovery show_tapeid command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
admin:utils disaster_recovery show_backupfiles tape /dev/nst020050426181203853utils disaster_recovery show_backupfiles network
This command retrieves information about backup files available on the network drive.
Command syntax
utils disaster_recovery show_backupfiles network path servername userid
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
admin:utils disaster_recovery show_backupfiles network /usr/local/ 10.77.31.55 administratorPlease enter password to connect to network server 10.77.31.55:****200504261812038552005042618120385320050426181203857utils disaster_recovery show_registration
This command displays the registered features and components on the specified server.
Command Syntax
utils disaster_recovery show_registration hostname
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery show_tapeid
This command displays a list of tape device IDs.
Command Syntax
utils disaster_recovery show_tapeid
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery status
This command displays the status of the current backup or restore job.
Command Syntax
utils disaster_recovery status operation
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils fior
This command allows you to monitor the I/O on the server. The File I/O Reporting service provides a kernel-based daemon for collecting file I/O per process.
Command Syntax
utils fior
disable
enable
list [start=date-time] [stop=date-time]
start
status
stop
top number [read | write | read-rate | write-rate] [start=date-time] [stop=date-time]
Parameters
•
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils firewall ipv4
This commands sets options and displays status for the IPv4 firewall.
Command Syntax
utils network ipv4 firewall
debug [off|time]
disable [time]
enable
list
status
Parameters
•
•
•
•
•
•
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils firewall ipv6
This commands sets options and displays status for the IPv6 network firewall.
Note
Command Syntax
utils firewall ipv6
debug [off|time]
disable [time]
enable
list
status
Parameters
•
•
•
•
•
•
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils iostat
This command displays the iostat output for the given number of iterations and interval.
Command Syntax
utils iostat [interval] [iterations] [filename]
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils iothrottle
This command affects I/O throttling enhancements. When enabled, I/O throttling enhancements lower the impact of upgrades on an active system.
Command Syntax
utils iothrottle {enable | disable | status}
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils iothrottle threshold low
This command modifies the low iowait threshold used by the iowait monitor tool during upgrades.
Command syntax
utils iothrottle threshold low value
Parameters
•
Usage Guideline
Do not use this tool without Cisco Support supervision.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils iothrottle threshold clear
This command clears the low iowait threshold that got configured via the utils iothrottle threshold low command.
Command syntax
utils iothrottle threshold clear
Usage Guidelines
Do not use this tool without Cisco Support supervision.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils iothrottle threshold status
This command displays the current custom iowait threshold set by the utils iothrottle threshold low command.
Command syntax
utils iothrottle threshold status
Usage Guideline
Do not use this tool without Cisco Support supervision.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils netdump client
This command configures the netdump client.
Command Syntax
utils netdump client
start ip-address-of-netdump-server
status
stop
Parameters
•
•
•
•
Usage Guidelines
If a kernel panic crash occurs, the netdump client sends diagnostic information about the crash to a netdump server.
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils netdump server
This command configures the netdump server.
Command Syntax
utils netdump server
add-client ip-address-of-netdump-client
delete-client ip-address-of-netdump-client
list-clients
start
status
stop
Parameters
•
•
•
•
•
•
•
Usage Guidelines
If a kernel panic crash occurs, a netdump-enabled client system sends diagnostic information about the crash to the netdump server.
The netdump diagnostic information gets stored in the following location on the netdump server: crash/. The subdirectories whose names comprise a client IP address and a date contain netdump information.
You can configure each Cisco Unified Communications Operating System server as both a netdump client and server.
If the server is on another Cisco Unified Communications Operating System server, only the kernel panic trace signature gets sent to the server; otherwise, an entire core dump gets sent.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Parameters
•
•
•
•
•
Options
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network arp
This command lists the contents of the Address Resolution Protocol table.
Command syntax
utils network arp
list [host hostname][options]
Command privilege level: 0
Allowed during upgrade: Yes
set host addr
Command privilege level: 1
Allowed during upgrade: No
delete host
Command privilege level: 1
Allowed during upgrade: Yes
Options
•
•
•
–
–
•
Format XX:XX:XX:XX:XX:XX
Format XX:XX:XX:XX:XX:XX
List Usage Guidelines
In the Flags column, C=cached, M=permanent, P=published.
List Example
admin: utils network arp listAddress HWtype HWaddress Flags Mask Ifacesjc21-3f-hsrp.cisco.com ether 00:00:0C:07:AC:71 C eth0philly.cisco.com ether 00:D0:B7:85:98:8E C eth0Entries: 2 Skipped: 0 Found: 2Set Example
admin: utils network arp set myhost 11:22:33:44:55:66Delete Example
admin: utils network arp delete myhostutils network capture eth0
This command captures IP packets on the specified Ethernet interface.
Command Syntax
utils network capture eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]
Parameters
•
Options
•
When you use the page or file options, the complete capture of all requested packets must occur before the command completes.
•
•
The file option saves the information to platform/cli/fname.cap. The filename cannot contain the "." character.
•
For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10,000.
•
For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network host
This command resolves a host name to an address or an address to a host name.
Command Syntax
utils network host hostname [server server-name] [page] [detail] [srv]
Parameters
•
Options
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network ipv6
This command displays information about a specified IPv6 address or hostname.
Command syntax
utils network ipv6
ping {IPv6-address | hostname} [count]
traceroute {IPv6-address | hostname}
host {IPv6-address | hostname}
Parameters
•
•
•
•
•
•
Usage Guidelines
The hostname must resolve to a valid IPv6 address.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network ping
This command allows you to ping another server.
Command Syntax
utils network ping destination [count]
Parameters
•
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network traceroute
This command traces IP packets that are sent to a remote destination.
Command Syntax
utils network tracert destination
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ntp
This command displays the NTP status or configuration.
Command Syntax
utils ntp {status | config}
Note
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ntp restart
This command restarts the NTP service.
Command Syntax
utils ntp restart
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ntp server add
The command adds up to 5 specified NTP servers.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Command syntax
utils ntp server add s1 [s2 s3 s4 s5] [norestart]
Parameters
•
•
Usage Guidelines
If the norestart parameter gets used, an explicit restart of the NTP service is required for the changes to take effect.
Example: Adding servers with incorrect command line parameters
--------------------------------------------------------------admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8Incorrect number of parameters entered for addusage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]admin:Example: Adding using norestart without specifying a server
-----------------------------------------------------------admin:utils ntp server add norestartAt least one NTP server must be specified for add operation.usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]Example: Adding servers without norestart
-----------------------------------------admin:utils ntp server add clock1.cisco.com clock2.cisco.comclock1.cisco.com : added successfully.clock2.cisco.com : added successfully.Restarting NTP on the server.Example: Adding servers that are already added, without norestart
-----------------------------------------------------------------admin:utils ntp server add clock1.cisco.com clock2.cisco.comclock1.cisco.com : [The host has already been added as an NTP server.]clock2.cisco.com : [The host has already been added as an NTP server.]admin:Example: Adding server to self without norestart
------------------------------------------------admin:utils ntp server add bglr-ccm26bglr-ccm26 : [This server cannot be added as an NTP server.]admin:Example: Adding inaccessible server without norestart
-----------------------------------------------------admin:utils ntp server add clock3.cisco.comclock3.cisco.com : [ Inaccessible NTP server. Not added. ]admin:Example: Adding servers with norestart
--------------------------------------admin:utils ntp server add ntp01-syd.cisco.com ntp02-syd.cisco.com clock.cisco.com norestartntp01-syd.cisco.com : added successfully.ntp02-syd.cisco.com : added successfully.clock.cisco.com : added successfully.The NTP service will need to be restarted for the changes to take effect.Example: Adding servers when 5 are already configured
-----------------------------------------------------admin:utils ntp server add clock3.cisco.comThe maximum permissible limit of 5 NTP servers is already configured.admin:utils ntp server delete
This command deletes NTP servers.
Command syntax
utils ntp server delete
Parameters
None
Usage Guidelines
When you execute this command, you have the option to delete any configured NTP server or all of them. After you enter your choice, you have the option to restart the NTP service. If you choose No, the NTP service does not restart after deleting the server(s).
If you choose not to restart the NTP service, an explicit restart of the NTP service is required for the changes to take effect.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example: Deleting servers with incorrect command line parameters
----------------------------------------------------------------admin:utils ntp server delete clock1.cisco.com clock2.cisco.comIncorrect number of optional parameters entered for deleteusage: utils ntp server deleteadmin:Example: Deleting single server with ntp restart
------------------------------------------------admin:utils ntp server delete1: clock1.cisco.com2: clock2.cisco.com3: ntp01-syd.cisco.com4: ntp02-syd.cisco.com5: clock.cisco.coma: allq: quitChoice: 1Restart NTP (y/n): yclock1.cisco.com will be deleted from the list of configured NTP servers.Continue (y/n)?yclock1.cisco.com : deleted successfully.Restarting NTP on the server.admin:Example: Deleting all servers without ntp restart
-------------------------------------------------admin:utils ntp server delete1: clock1.cisco.com2: clock2.cisco.com3: ntp01-syd.cisco.com4: ntp02-syd.cisco.com5: clock.cisco.coma: allq: quitChoice: aRestart NTP (y/n): nThis will result in all the configured NTP servers being deleted.Continue (y/n)?yclock1.cisco.com : deleted successfully.clock2.cisco.com : deleted successfully.ntp01-syd.cisco.com : deleted successfully.ntp02-syd.cisco.com : deleted successfully.clock.cisco.com : deleted successfully.The NTP service will need to be restarted for the changes to take effect.admin:Example: Deleting all servers when no servers are configured
------------------------------------------------------------admin:utils ntp server deleteThere are no NTP servers configured to delete.admin:utils ntp server list
This command displays a list of the configured ntp servers.
Command syntax
utils ntp server list
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example: Listing servers with incorrect command line parameters
---------------------------------------------------------------admin:utils ntp server list allIncorrect optional parameter entered for listusage: utils ntp server listadmin:Example: Listing servers
------------------------admin:utils ntp server listclock1.cisco.comclock2.cisco.comntp01-syd.cisco.comntp02-syd.cisco.comclock.cisco.comadmin:Example: Listing servers when no servers are configured
-------------------------------------------------------admin:utils ntp server listThere are no NTP servers configured.utils ntp start
If it is not already running, this command starts the NTP service.
Note
Command Syntax
utils ntp start
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ntp status
This command displays the current status of NTP.
Command Syntax
utils ntp status
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin:utils ntp statusntpd (pid 18705) is running...remote refid st t when poll reach delay offset jitter==============================================================================127.127.1.0 LOCAL(0) 10 l 12 64 377 0.000 0.000 0.004+171.68.10.80 10.81.254.131 2 u 331 1024 377 35.201 -0.498 0.673*10.81.254.131 .GPS. 1 u 356 1024 377 64.304 -0.804 0.638synchronised to NTP server (10.81.254.131) at stratum 2time correct to within 37 mspolling server every 1024 sCurrent time in UTC is : Thu Feb 12 22:33:43 UTC 2009Current time in America/Los_Angeles is : Thu Feb 12 14:33:43 PST 2009The 'remote' column lists the remote NTP servers. The local hardware clock isconfigured as 127.127.1.0 and is always shown, even when not active.The leftmost column below the 'remote' column header has the following meaning:" " discarded due to high stratum and/or failed sanity checks"+" a candidate NTP server and included in the final selection set"*" selected for synchronizationAny other values indicate the NTP server is not being used for synchronization.Other possible values are:"x" designated false ticker (is an invalid NTP server)"." culled from the end of the candidate list (is considered non viable)"-" discarded"#" selected for synchronization, but has high delay, offset or jitterThe 'refid' column indicates the remote's time source. "LOCAL(0)" applies tothe local hardware clock. ".INIT." means initialization has not yet succeeded.The 'st' column is the stratum of the remote NTP server. 16 is a invalidstratum value meaning "this server is not considered a time provider".This can be for various reasons, the most common reasons are "time provider not synchronized", "configured source does not exist" or "ntp server not running".The 'when' column indicates how many seconds ago the remote was queried.The 'poll' column indicates the polling interval in seconds. E.G., '64' meansthe remote is being polled every 64 seconds. The shortest interval NTP usesis every 64 seconds and the longest is 1024 seconds. The better a NTP sourceis rated over time, the longer the interval.The 'reach' column indicates the trend of reachability tests in octal, whereeach digit, when converted to binary represents whether a particular poll wassuccessful (binary 1) or unsuccessful (binary 0). E.G., '1' means only onepoll has been done thus far and it was successful. '3' (= binary 11) means thelast 2 polls were successful. '7' (= binary 111) means the last 3 polls weresuccessful. '17' (= binary 1 111) means the last 4 polls were successful.'15' (= binary 1 101) means the last 2 polls were successful, the poll prior tothat was unsuccessful, and the poll prior to that was successful.When a poll is done for the active NTP server selected for synchronization isdone, a time correction using that NTP server's time is also done.The delay, offset and jitter are the round-trip delay, dispersion, and jitterin seconds."At stratum #" shown below the table shows the stratum of this host's NTPserver, which will be one higher than that of the currently active NTP serverbeing used for synchronization.utils ntp server add
The command adds a maximum of 5 specified NTP server(s).
Command syntax
utils ntp server add s1 [s1 | s2 | s3 | s4 | s5] [norestart]
Parameters
•
Usage Guidelines
If norestart gets used, an explicit restart of the NTP service is required for the changes to take effect.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example: Attempting to add servers with incorrect command line parameters
--------------------------------------------------------------admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8Incorrect number of parameters entered for addusage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]admin:Example: Attempting to add a server using norestart without specifying a server
-----------------------------------------------------------admin:utils ntp server add norestartAt least one NTP server must be specified for add operation.usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]Example: Adding servers without norestart
-----------------------------------------admin:utils ntp server add clock1.cisco.com clock2.cisco.comclock1.cisco.com : added successfully.clock2.cisco.com : added successfully.Restarting NTP on the server.Example: Adding servers that are already added, without norestart
-----------------------------------------------------------------admin:utils ntp server add clock1.cisco.com clock2.cisco.comclock1.cisco.com : [The host has already been added as an NTP server.]clock2.cisco.com : [The host has already been added as an NTP server.]admin:Example: Adding server to self without norestart
------------------------------------------------admin:utils ntp server add bglr-ccm26bglr-ccm26 : [This server cannot be added as an NTP server.]admin:Example: Adding inaccessible server without norestart
-----------------------------------------------------admin:utils ntp server add clock3.cisco.comclock3.cisco.com : [ Inaccessible NTP server. Not added. ]admin:Example: Adding servers with norestart
--------------------------------------admin:utils ntp server add ntp01-syd.cisco.com ntp02-syd.cisco.com clock.cisco.com norestartntp01-syd.cisco.com : added successfully.ntp02-syd.cisco.com : added successfully.clock.cisco.com : added successfully.The NTP service will need to be restarted for the changes to take effect.Example: Adding servers when 5 are already configured
-----------------------------------------------------admin:utils ntp server add clock3.cisco.comThe maximum permissible limit of 5 NTP servers is already configured.admin:utils ntp server delete
This command deletes configured NTP servers.
Command syntax
utils ntp server delete
Parameters
None
Usage Guidelines
This command results in the option to delete a configured NTP server or all of them. When you choose the server to delete, you get prompted to indicate if you want to restart the NTP service. If you choose no, the NTP service does not get restarted after the server gets deleted.
If you chose not to restart the NTP service, an explicit restart of the NTP service is required for the changes to take effect.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example: Deleting servers with incorrect command line parameters
----------------------------------------------------------------admin:utils ntp server delete clock1.cisco.com clock2.cisco.comIncorrect number of optional parameters entered for deleteusage: utils ntp server deleteadmin:Example: Deleting single server with ntp restart
------------------------------------------------admin:utils ntp server delete1: clock1.cisco.com2: clock2.cisco.com3: ntp01-syd.cisco.com4: ntp02-syd.cisco.com5: clock.cisco.coma: allq: quitChoice: 1Restart NTP (y/n): yclock1.cisco.com will be deleted from the list of configured NTP servers.Continue (y/n)?yclock1.cisco.com : deleted successfully.Restarting NTP on the server.admin:Example: Deleting all servers without ntp restart
-------------------------------------------------admin:utils ntp server delete1: clock1.cisco.com2: clock2.cisco.com3: ntp01-syd.cisco.com4: ntp02-syd.cisco.com5: clock.cisco.coma: allq: quitChoice: aRestart NTP (y/n): nThis will result in all the configured NTP servers being deleted.Continue (y/n)?yclock1.cisco.com : deleted successfully.clock2.cisco.com : deleted successfully.ntp01-syd.cisco.com : deleted successfully.ntp02-syd.cisco.com : deleted successfully.clock.cisco.com : deleted successfully.The NTP service will need to be restarted for the changes to take effect.admin:Example: Deleting all servers when no servers are configured
------------------------------------------------------------admin:utils ntp server deleteThere are no NTP servers configured to delete.admin:utils ntp server list
The command displays a list of the configured ntp servers.
Command syntax
utils ntp server list
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example: Listing servers with incorrect command line parameters
---------------------------------------------------------------admin:utils ntp server list allIncorrect optional parameter entered for listusage: utils ntp server listadmin:Example: Listing servers
------------------------admin:utils ntp server listclock1.cisco.comclock2.cisco.comntp01-syd.cisco.comntp02-syd.cisco.comclock.cisco.comadmin:Example: Listing servers when no servers are configured
-------------------------------------------------------admin:utils ntp server listThere are no NTP servers configured.admin:utils remote_account
This command allows you to enable, disable, create, and check the status of a remote account.
Command Syntax
utils remote_account
status
enable
disable
create username life
Parameters
•
•
Usage Guidelines
A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account. You can have only one remote account that is enabled at a time.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
utils remote_account statusutils service
This command stops, starts, or restarts a service.
Command Syntax
utils service
start service-name
stop service-name
restart service-name
auto-restart {enable | disable | show} service-name
Parameters
•
–
–
–
–
–
–
–
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils service list
This command retrieves a list of all services and their status.
Command Syntax
utils service list [page]
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils snmp
This command manages SNMP on the server.
Command Syntax
utils snmp
get version community ip-address object [file]
hardware-agents [status | start | stop | restart]
test
walk version community ip-address object [file]
Parameters
•
•
•
•
•
•
Please clarify if the above option is valid
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils snmp get 3
This command gets the SNMP data for the specified MIB OID.
Command Syntax
utils snmp get 3
[system will prompt you for the parameters]
Requirements
Command privilege level: 1
Allowed during upgrade: No
Usage Guidelines
•
•
Example:
Following is the snmp get output of system uptime:
iso.3.6.1.2.1.25.1.1.0 = Timeticks: (19836825) 2 days, 7:06:08.25utils snmp walk 3
This command is used to walk the SNMP MIB starting with the specified OID.
Command Syntax
utils snmp walk 3
[system will prompt you for the parameters]
Requirements
Command privilege level: 1
Allowed during upgrade: No
Usage Guidelines
•
•
Example
Here is the sample walk output for the OID 1.3.6:
iso.3.6.1.2.1.1.1.0 = STRING: "Hardware:7825H, 1 Intel(R) Pentium(R) 4 CPU3.40GHz, 2048 MB Memory: Software:UCOS 2.0.1.0-62"iso.3.6.1.2.1.1.2.0 = OID: iso.3.6.1.4.1.9.1.583iso.3.6.1.2.1.1.3.0 = Timeticks: (15878339) 1 day, 20:06:23.39iso.3.6.1.2.1.1.4.0 = ""iso.3.6.1.2.1.1.5.0 = STRING: "bldr-ccm34.cisco.com"iso.3.6.1.2.1.1.6.0 = ""iso.3.6.1.2.1.1.7.0 = INTEGER: 72iso.3.6.1.2.1.2.1.0 = INTEGER: 3iso.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1iso.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2iso.3.6.1.2.1.2.2.1.1.3 = INTEGER: 3iso.3.6.1.2.1.2.2.1.2.1 = STRING: "lo"iso.3.6.1.2.1.2.2.1.2.2 = STRING: "eth0"iso.3.6.1.2.1.2.2.1.2.3 = STRING: "eth1"iso.3.6.1.2.1.2.2.1.3.1 = INTEGER: 24iso.3.6.1.2.1.2.2.1.3.2 = INTEGER: 6iso.3.6.1.2.1.2.2.1.3.3 = INTEGER: 6iso.3.6.1.2.1.2.2.1.4.1 = INTEGER: 16436iso.3.6.1.2.1.2.2.1.4.2 = INTEGER: 1500iso.3.6.1.2.1.2.2.1.4.3 = INTEGER: 1500iso.3.6.1.2.1.2.2.1.5.1 = Gauge32: 0iso.3.6.1.2.1.2.2.1.5.2 = Gauge32: 100000000iso.3.6.1.2.1.2.2.1.5.3 = Gauge32: 10000000iso.3.6.1.2.1.2.2.1.6.1 = Hex-STRING: 00 00 00 00 00 00iso.3.6.1.2.1.2.2.1.6.2 = Hex-STRING: 00 16 35 5C 61 D0iso.3.6.1.2.1.2.2.1.6.3 = Hex-STRING: 00 16 35 5C 61 CFiso.3.6.1.2.1.2.2.1.7.1 = INTEGER: 1utils snmp config inform 3 add
This command adds a new v3 inform notification destination that is associated with a configured v3 username.
Command syntax
utils snmp config inform 3 add {ipaddress} {portno} {username} {authprotocol} {authpassphrase} {privprotocol} {privpassphrase} {accessprivilege} {engineId}
Parameters
•
Note
•
•
•
•
•
•
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
utils snmp config inform 3 add 10.77.31.26 162 testuser SHA authpass AES128 privpass ReadWriteNotify 00:00:00:63:00:00:00:a1:0a:4d:1f:1autils snmp config inform 3 delete
This command deletes the configuration information for an existing v3 inform notification destination.
Command syntax
utils snmp config inform 3 delete {ipaddress}{portno}{username}{deletuserconf}
Parameter
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
utils snmp config inform 3 delete 10.77.31.26 162 testuser Yutils snmp config inform 3 list
This command lists the v3 inform notifications currently configured
Command syntaxutils snmp config inform 3 list
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils snmp config inform 3 update
This command updates the configuration information for an existing v3 inform notification destination.
Command syntax
utils snmp config inform 3 update {ipaddress} {oldportno} {newportno} {oldusername} {newusername} {deletuserconf} {authprotocol} {authpassphrase} {privprotocol} {privpassphrase} {accessprivilege} {engineId}
Parameters
•
•
•
•
•
•
•
•
•
•
•
•
Note
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
utils snmp config inform 3 update 10.77.31.26 162 6162 testuser testuser1 Y SHA authpass AES128 privpass ReadWriteNotify 00:00:00:63:00:00:00:a1:0a:4d:1f:1autils snmp config mib2 add
This command adds mib2 configuration information (for example, system contact and system location).
Command syntax
utils snmp config mib2 add SysContact SysLocation
Parameter
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
utils snmp config mib2 add cisco indiautils snmp config mib2 delete
This command deletes the mib2 configuration information (for example, system contact and system location).
Command syntaxutils snmp config mib2 delete
ParametersNone
Requirements
Command privilege level: 1
Allowed during upgrade: No
Exampleutils snmp config mib2 delete cisco indiautils snmp config mib2 list
This command lists the mib2 configuration information (for example, system contact and system location).
Command syntax
utils snmp config mib2 list
Parameter
None
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
utils snmp config mib2 list cisco indiautils snmp config mib2 update
This command updates the mib2 configuration information (for example, system contact and system location.)
Command syntax
utils snmp config mib2 update SysContact SysLocation
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
utils snmp config mib2 update cisco indiautils snmp config trap 3 add
This command adds a new v3 trap notification destination that is associated with a configured v3 username.
Command syntax
utils snmp config trap 3 add {ipaddress} {portno} {username}
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
utils snmp config trap 3 add 10.77.31.26 162 testuserutils snmp config trap 3 update
This command updates the configuration information for an existing v3 trap notification destination.
Command syntax
utils snmp config trap 3 update {ipaddress} {oldportno} {newportno} {oldusername} {newusername}
Parameters
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
utils snmp config trap 3 update 10.77.31.26 162 6162 testuser testuser1utils snmp config trap 3
This command deletes the configuration information for an existing v3 trap notification destination
Command syntax
utils snmp config trap 3 delete {ipaddress} {portno} {username}
Parameters
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
utils snmp config trap 3 delete 10.77.31.26 162 testuserutils snmp config trap 3 list
This command displays the v3 trap notifications currently configured
Command syntax
utils snmp config trap 3 list
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils snmp config user 3 add
This command adds a new v3 user with the v3 authentication and privacy passwords.
Command syntax
utils snmp config user 3 add {username} {authprotocol} {authpassphrase} {privprotocol} {privpassphrase} {accessprivilege} [ipaddress1 ipaddress2]
Parameters
•
•
•
•
•
•
Options
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
utils snmp config user 3 add testuser SHA authpass AES128 privpass ReadWriteNotify 10.77.31.26 10.77.31.29utils snmp config user 3 delete
Command syntax
utils snmp config user 3 delete username
Parameter
usernameis mandatory and represents the v3 username.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
utils snmp config user 3 delete testuserutils snmp config user 3 list
This command lists the v3 users currently configured.
Command syntax
utils snmp config user 3 list
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils snmp config user 3 update
This command updates the configuration information for an existing v3 user
Command syntax
utils snmp config user 3 update {username} {authprotocol} {authpassphrase {privprotocol} {privpassphrase} {accessprivilege} [ipaddress1 ipaddress2]
Parameters
•
•
•
•
•
•
Options
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
utils snmp config user 3 update testuser SHA authpass AES128 privpass ReadWriteNotify 10.77.31.26 10.77.31.29utils snmp test
This command sends snmp test sample alarms to local syslog, remote syslog and SNMP trap.
Command syntax
utils snmp test
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils system
This command allows you to restart the system on the same partition, restart the system on the inactive partition, or shut down the system.
Command Syntax
utils system {restart | shutdown | switch-version}
Parameters
restart restarts the system.
shutdown shuts down the system.
switch-version switches to the product release that is installed on the inactive partition.
Usage Guidelines
The utils system shutdown command provides a 5-minute timeout. If the system does not shut down within 5 minutes, the command gives you the option of doing a forced shutdown.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils system boot
This commands redirects where the system boot output gets sent.
Command Syntax
utils system boot {console | serial | status}
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils system upgrade
This command allows you to install upgrades and Cisco Option Package (COP) files from both local and remote directories.
Command Syntax
utils system upgrade {initiate | cancel | status}
Parameters
•
•
•
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.
Cisco Product Security Overview
This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.
A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html. If you require further assistance please contact us by sending email to export@cisco.com.
CCVP, the Cisco logo, and Welcome to the Human Network are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn is a service mark of Cisco Systems, Inc.; and Access Registrar, Aironet, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, LightStream, Linksys, MeetingPlace, MGX, Networkers, Networking Academy, Network Registrar, PIX, ProConnect, ScriptShare, SMARTnet, StackWise, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0711R)
