The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes the command line interface (CLI) commands that are available for the Cisco Hosted Collaboration Mediation Fulfillment server.
This document comprises the following sections:
You can access the Cisco Unified Communications Operating System CLI remotely or locally:
•From a web client workstation, such as the workstation that you use for Cisco Unified Communications Operating System Administration, you can use SSH to connect securely to the Cisco Unified Communications Operating System.
•You can access the Cisco Unified Communications Operating System CLI directly by using the monitor and keyboard that you used during installation or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.
Before You Begin
Ensure you have the following information that gets defined during installation:
•A primary IP address and hostname
•An administrator ID
•A password
You will need this information to log in to the Cisco IPT Platform.
Perform the following steps to start a CLI session:
Step 1 Do one of the following actions depending on your method of access:
•From a remote system, use SSH to connect securely to the Cisco IPT Platform. In your SSH client, enter
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.
•From a direct connection, you receive this prompt automatically:
ipt-1 login:
where ipt-1 represents the hostname of the system.
Enter your administrator ID.
In either case, the system prompts you for a password.
Step 2 Enter your password.
The CLI prompt displays. The prompt represents the Administrator ID; for example:
admin:
The following section contains basic tips for using the command line interface.
To complete commands, use Tab:
•Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, set gets completed.
•Enter a full command name and press Tab to display all the commands or subcommands that are available. For example, if you enter set and press Tab, you see all the set subcommands. An * identifies the commands that have subcommands.
•If you reach a command, keep pressing Tab, and the current command line repeats; this indicates that no additional expansion is available.
You can get two kinds of help on any command:
•Detailed help that includes a definition of the command and an example of its use
•Short query help that includes only command syntax
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 10-1.
Note If you enter the help command without specifying the name of a particular command as the optional parameter, the system provides information about the CLI system.
To query only command syntax, at the CLI prompt, enter
command?
Where command represents the command name or the command and parameter. See Example 10-2.
Note If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available.
Example 10-1 Detailed Help Example
admin:help file list activelog
activelog help:
This will list active logging files
options are:
page - pause output
detail - show detailed listing
reverse - reverse sort order
date - sort by date
size - sort by size
file-spec can contain '*' as wildcards
Example
admin:file list activelog platform detail
02 Dec,2004 12:00:59 <dir> drf
02 Dec,2004 12:00:59 <dir> log
16 Nov,2004 21:45:43 8,557 enGui.log
27 Oct,2004 11:54:33 47,916 startup.log
dir count = 2, file count = 2
Example 10-2 Query Example
admin:file list activelog?
Syntax:
file list activelog file-spec [options]
file-spec mandatory file to view
options optional page|detail|reverse|[date|size]
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.
Each CLI command has a "Command Privilege Level" setting. The CLI has privilege levels 0 (lowest) through 4 (highest). Each Level, that is, the collection of commands such as "show," and each command has a privilege associated with it. A user will only be able to execute a command if the account they are using has sufficient privilege. The original Admin account, created during install, has the highest privilege level (4). This is the only account with this privilege level. When other accounts are created in the CLI using the CLI command set account, the account is assigned a privilege level. A new account can only have a privilege level of 0 or 1. Privilege levels 2 and 3 are currently unassigned and reserved for future use.
Each CLI command has an "Allow during upgrade?" setting. This setting controls whether the command can be run while an L2 upgrade is taking place. During an L2 upgrade, an administrator can log into the system and try to execute CLI commands. Since the CLI parser can figure out if an L2 is in progress, it can refuse to run any commands that are not permitted during an upgrade.
•help
•quit
This command displays help for the specified command.
Command syntax
help [command]
Parameters
command specifies the command for which help is required.
Requirements
Command privilege level: 0
Allowed during upgrade: Unknown
This command exits the CLI.
Command syntax
quit
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Unknown
This command allows you to delete an administrator account.
Command Syntax
delete account account-name
Parameters
account-name represents the name of an administrator account.
Requirements
Command privilege level: 4
Allowed during upgrade: Yes
This command allows you to delete the IP address for a DNS server.
Command Syntax
delete dns ip-address
Parameters
ip-address represents the IP address of the DNS server that you want to delete.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command deletes a DSCP port tag.
delete dscp port_tag
Parameters
port_tag represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field that is displayed when you use the command show dscp defaults. The set of port tags is predefined.
Usage Guidelines
After you delete an enabled port tag, DSCP marking on that port tag stops. You can re-create a deleted port tag when you use the set dscp marking command; enter the name of the port tag that you previously deleted.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command deletes all policies within the specified group.
Command syntax
delete ipsec policy_group [group | all]
Parameters
[group] (mandatory) [ALL or group]
Usage Guidelines
Use the all option to delete all the groups.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command deletes an IPsec policy with given policy name.
Command Syntax
delete ipsec policy_name [policy_name | all]
Parameters
[policy_name] (mandatory) [ALL or policy name]
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command allows you to delete a particular process.
Command Syntax
delete process process-id {force | terminate | crash}
Parameters
process-id represents the process ID number.
Options
•force—Tells the process to stop.
•terminate—Tells the operating system to terminate the process.
•crash—Crashes the process and produces a crash dump.
Usage Guidelines
Note Use the force option only if the command alone does not delete the process and use the terminate option only if force does not delete the process.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command allows you to delete the SMTP host.
Command Syntax
delete smtp
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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.
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
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
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•directory/filename specifies the path and filename of the files to delete. You can use the wildcard character, *, for filename.
Options
•detail—Displays a listing of deleted files with the date and time.
•noconfirm—Deletes files without asking you to confirm each deletion.
Usage Guidelines
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.
Example
The following example deletes the install log.
file delete install install.log
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command dumps the contents of a file to the screen, a page at a time.
Command Syntax
file dump
activelog directory/filename [hex] [regexp expression][recent]
inactivelog directory/filename [hex] [regexp expression][recent]
install directory/filename [hex] [regexp expression][recent]
sftpdetails filename [hex] [regexp expression] [recent]
Parameters
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•sftpdetails specifies SFTP-related files.
•directory/filename specifies the path and filename of the file to dump. You can use the wildcard character, *, for filename as long as it resolves to one file.
•filename specifies the filename of the file to dump.
Options
•hex—Displays output in hexadecimal.
•regexp expression—Displays only the lines in the file that match the regular expression expression.
•recent—Displays the most recently modified file in the directory.
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.
Example
This command dumps contents of file _cdrIndex.idx.
file dump activelog cm/cdr/_cdrIndex.idx
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: No
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
•all records information about all files in the directory in the file that is specified by outfilename.
•file displays information about the file that is specified by filename.
most fragmented displays information about the most fragmented files.
most recent displays information about the most recently logged fragmented file.
•number specifies the number of files to list.
Options
verbose—Displays more detailed information.
Requirements
Command privilege level: 1
Allowed during upgrade: No
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
•all records information about all files in the directory in the file that is specified by outfilename.
•file displays information about the file that is specified by filename.
•most fragmented displays information about the most fragmented files.
•most recent displays information about the most recently logged fragmented file.
•number specifies the number of files to list.
Options
verbose—Displays more detailed information
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command sends the file to another system by using SFTP.
Command Syntax
file get
activelog directory/filename [reltime] [abstime] [match regex] [recurs][compress]
inactivelog directory/filename [reltime] [abstime] [match regex] [recurs][compress]
install directory/filename [reltime] [abstime] [match regex] [recurs][compress]
partBsalog directory/filename [reltime] [abstime] [match regex] [recurs][compress]
salog directory/filename [reltime] [abstime] [match regex] [recurs][compress]
Parameters
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•partBsalog specifies the partBsalog log directory.
•salog specifies the salog log directory.
•directory/filename specifies the path to the files to delete. You can use the wildcard character, *, for filename as long as it resolves to one file.
Options
•abstime—Absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY
•reltime—Relative time period, specified as minutes | hours | days | weeks | months value
•match regex—Match a particular string in the filename, specified as string value
•recurs—Get all files, including subdirectories
•compress—Transfer files as compressed file
Usage Guidelines
After the command identifies the specified files, you get prompted to enter an SFTP host, username, and password.
Examples
This command gets all files in the active log operating system directory that match the string "plat".
file get activelog platform match plat
This 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/2005
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•directory specifies the path to the directory to list. You can use a wildcard character, *, for directory as long as it resolves to one directory.
Options
•detail—Long listing with date and time
•date—Sort by date
•size—Sort by file size
•reverse—Reverse sort direction
•page—Displays the output one screen at a time.
Examples
This example lists operating system log files with details.
file list activelog platform/log page detail
This example lists directories in CDR repository.
file list activelog cm/cdr_repository
This example lists CDR files in a specified directory by size.
file list activelog cm/cdr_repository/processed/20050812 size
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: No
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] [reltime {days | hours | minutes} timevalue][ignorecase, recurs]
inactivelog directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [reltime {days | hours | minutes} timevalue][ignorecase, recurs]
install directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy]
[reltime {days | hours | minutes} timevalue][ignorecase, recurs]
Parameters
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•tftp specifies a TFTP file.
•reg-exp represents a regular expression.
•directory/filename represents the path to the files to search. You can use the wildcard character, *, to represent all or part of the filename.
Options
•abstime—Specifies which files to search based on file creation time. Enter a start time and an end time.
•days|hours|minutes—Specifies whether the file age is in days, hours, or minutes.
•ignorecase—Ignores case when searching.
•reltime—Specifies which files to search based on file creation time. Enter the age of files to search.
•hh:mm:ss mm/dd/yyyy—An absolute time, in the format hours:minutes:seconds month/day/year.
•timevalue—The age of files to search. Specify the unit of this value with the {days | hours | minutes} option.
•recurs—Get all files, including subdirectories
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.
Example
file search activelog platform/log/platform.log Err[a-z] ignorecase
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command tails (prints the last few lines) of a log file.
Command Syntax
file tail
activelog directory/filename [hex] [lines] [regexp expression][recent]
inactivelog directory/filename [hex] [lines][regexp expression][recent]
install directory/filename [hex] [lines][regexp expression][recent]
Parameters
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•directory/filename specifies the path to the file to tail. You can use the wildcard character, *, for filename as long as it resolves to one file.
Options
•regexp expression—Displays only the lines in the file that match the regular expression expression.
•recent—Displays the most recently modified file in the directory.
•hex—Hexadecimal listing
•lines—Number of lines to display
Example
This example tails the operating system CLI log file.
file tail activelog platform/log/cli00001.log
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: No
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
•activelog specifies a log on the active side.
•inactivelog specifies a log on the inactive side.
•install specifies an installation log.
•system-management-log displays the contents of the Integrated Management Logs (IML).
•directory/filename specifies the path to the file to view. You can use the wildcard character, *, for filename as long as it resolves to one file.
Usage Guidelines
Examples
This example displays the install log.
file view install install.log
This example displays a particular CDR file.
file view activelog /cm/cdr_repository/processed/20058012/{filename}
Requirements
Command privilege level: 0
Allowed during upgrade: No
•set accountlocking unlocktime
•set auditlog remotesyslogseverity
•set auditlog remotesyslogserver
•set hcs fulfillment auto-vm-linkage
•set hcs vcentersync require-vcenter-certificate
•set password complexity minimum-length
•set password expiry minimum-age
•set password expiry minimum-age
•set password expiry user maximum-age
•set password expiry user minimum-age
This command sets up a new account on the operating system.
Command Syntax
set account name
Parameters
name represents the username for the new account.
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: 4
Allowed during upgrade: Yes
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
user-id specifies the name of the user account that was disabled.
Example
User account test was disabled due to password inactivity. Its enabled as follows:
admin:set account enable test
Enabling the account 'test' with current settings....
.....
Successfully enabled account 'test'
Requirements
Command privilege level: 4
Allowed during upgrade: Yes
This command enables or disables account locking for the current admin accounts.
Command Syntax
set accountlocking {enable | disable}
Parameters
•enable turns on the account locking.
•disable turns off the account locking.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the global consecutive failed sign-in attempt count that triggers locking a user account.
Note This command is valid only when account locking is enabled. If account locking is disabled, the system does not remember the account locking value and uses the default value, 3, after you enable account locking.
Command Syntax
set accountlocking count n
Parameters
•n specifies the number of consecutive failed sign-in attempts before the system locks the user account.
–Value range: 2-5
–Default value: 3
Usage Guidelines
To change the global value for consecutive failed sign-in attempts before the system locks a user account, execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Use this command to configure the unlock time for Cisco Unified Communications Manager (CUCM) OS admin accounts in seconds.
Command Syntax
set accountlocking unlocktime seconds
Parameters
unlocktime is in seconds.
Acceptable values should be greater than or equal to 300 seconds but less than 3600 seconds (60 minutes).
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command sets the alarm configuration to the factory defaults.
Command Syntax
set alarm default
Note The system prompts you for the service name.
Parameter
See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade No
This command enables or disables the specified monitor for the specified service.
Command Syntax
set alarm status
Note The system prompts you to enable or disable a specified monitor name for a specified service.
Parameters
•status
•enable
•disable.
•monitor name
–SDI
–SDL
–Event_Log
–Sys_Log
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade : No
This command sets the specified monitor alarm to the specified severity for the specified service.
Command Syntax
set alarm severity
Note The system prompts you for the severity, the monitor name and the service name.
Parameters
•severity
–Emergency
–Alert
–Critical
–Error
–Warning
–Notice
–Informational
–Debug
•monitor name
–SDI
–SDL
–Event_Log
–Sys_Log
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the alarm for the remote syslog server.
Command Syntax
set alarm remotesyslogserver
Note The system prompts you for the parameters.
Parameters
•remotesyslogserver specifies the name of the remote syslog server.
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables or disables the audit log.
Command Syntax
set auditlog status
Note The system prompts you for the parameters.
Parameters
•status
–enable
–disable
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables or disables audit log purging.
Command Syntax
set auditlog purging
Note The system prompts you for the parameters.
•status
–enable
–disable
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables or disables the audit log log rotation.
Command Syntax
set auditlog logrotation
Note The system prompts you for the parameters.
Parameters
•status
–enable
–disable
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the audit log maximum file size.
Command Syntax
set auditlog maxfilesize
Note The system prompts you for the parameters.
Parameters
size specifies an integer between 1 and 10.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the audit log maximum number of files count.
Command Syntax
set auditlog maxnumfiles
Note The system prompts you for the parameters.
Parameters
filecount specifies an integer between 1 and 10000.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the audit log remote syslog severity to the specified severity.
Command Syntax
set auditlog remotesyslogseverity
Note The system prompts you for the parameters.
Parameters
•severity
–Emergency
–Alert
–Critical
–Error
–Warning
–Notice
–Informational
–Debug
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the remote syslog server name to a name specified.
Command Syntax
set auditlog remotesyslogserver
Note The system prompts you for the parameters.
Parameters
remotesyslogserver name represents a valid hostname of a remote syslog server.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command affects the certificates available in the preconfigured SFTP location.
Command Syntax
set cert
import [type][name][caCert]
Command privilege level: 1
Allowed during upgrade: Yes
regen [name]
Command privilege level: 1
Allowed during upgrade: Yes
delete [unit] [name]
Command privilege level: 1
Allowed during upgrade: Yes
Parameters
•import imports the certificates available in the SFTP location into the specified unit trust-store.
•regen regenerates the certificate for the specified unit.
•delete deletes the certificate siptest.pem for the specified unit.
Options
•unit specifies "own" or "trust."
•name represents the unit name.
•type represents the certificate type.
•caCert represents the name of the caCert.
Import Example
admin:set cert import all
Successfully imported tomcat certificates.
Successfully imported tftp certificates.
Regen Example
admin: set cert regen tomcat
Successfully regenerated certificate for tomcat.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
For the current CLI session, this command turns automatic pagination On or Off.
Command Syntax
set cli pagination {on | off}
Parameters
•on turns pagination on.
•off turns pagination off.
Example
admin:set cli pagination off
Automatic pagination is turned off
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the time, in minutes, after which an active CLI session times out and disconnects. Be aware that the new session timeout value becomes effective immediately for a new CLI session; however, active sessions retain their original timeout value. Also the show cli session timeout command reflects the new value, even if the current session does not use that value.
Note This setting gets preserved through a software upgrade and does not get reset to the default value.
Command Syntax
set cli session timeout minutes
Parameters
•minutes specifies the time, in minutes, that can elapse before an active CLI session times out and disconnects.
–Value range: 5-99999 minutes
–Default value: 30 minutes
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command changes the CLI command prompt, so it displays how many CLI commands have executed.
Command Syntax
set commandcount {enable | disable}
Parameters
•enable turns on command count.
•disable turns off command count.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command regenerates the certificate for the specified unit name.
Command Syntax
set csr gen unitname
Parameters
unitname is mandatory and specifies the unit name from which the certificate is generated.
Example
admin:set csr gen tomcat
Successfully regenerated certificate for tomcat.
Please restart services related to tomcat for the new certificate to become active.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command changes the date/time on the server.
Command Syntax
set date HH:mm:ss:MM/DD/YY
Parameters
•HH:mm:ss specifies the time (24-hours format).
•MM/DD/YY specifies the date.
Usage Guidelines
The following date format is also accepted: MM/DD/YYYY.
If the server is configured to synchronize with any external NTP servers, this command requires the user to remove all such NTP servers.
Example
To set date and time to 2:10:33 pm, Feb 13th 2008
admin:set date 14:10:33:02/13/08
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the factory default DSCP settings for all of the port tags.
Command Syntax
set dscp defaults
Usage Guidelines
All non default DSCP settings get removed after you run this command. You can use the command show dscp defaults to see the factory default DSCP settings.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command disables DSCP marking on outgoing TCP or UDP packets. You can disable DSCP on a single port tag, or on all port tags at once.
Command Syntax
set dscp disable [all | port_tag]
Parameters
•all disables all DSCP port tags.
•port_tag represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field that is displayed when you use the command show dscp defaults. The set of port tags is predefined.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command enables DSCP marking on outgoing TCP or UDP packets You can enable DSCP on a single port tag, or on all port tags at once.
Command Syntax
set dscp enable [all | port_tag]
Parameters
•all enables all DSCP port tags.
•port_tag represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field that is displayed when you use the command show dscp defaults. The set of port tags is predefined.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets DSCP markings on port tags by using well-known DSCP classes and numeric values.
Command Syntax
set dscp marking port_tag value
Parameters
•port_tag represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field that is displayed when you use the command show dscp defaults. The set of port tags is predefined.
•value is a DSCP value. You can enter the name of a well-known DSCP class, or a numeric value in decimal or hexadecimal format. Precede hexadecimal values with 0x or 0X.
Usage Guidelines
The valid class names as defined by DSCP are:
•Class Selector: values CS0, CS1, CS2, CS3, CS5, CS6, CS7
The class selector (CS) values correspond to IP Precedence values and are fully compatible with IP Precedence.
•Expedited Forwarding: value EF
EF PHB is ideally suited for applications such as VoIP that require low bandwidth, guaranteed bandwidth, low delay, and low jitter.
•Best Effort: value BE
Also called default PHB, this value essentially specifies that a packet be marked with 0x00, which gets the traditional best-effort service from the network router.
•Assured Forwarding: values AF11, AF12, AF13, AF21, AF22, AF23, AF41, AF42, AF43
There are four types of Assured Forwarding classes, each of which has three drop precedence values. These precedence values define the order in which a packet is dropped (if needed) due to network congestion. For example, packets in AF13 class are dropped before packets in the AF12 class.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command determines whether or not Cisco Hosted Collaboration Mediation Fulfillment Service will attempt to automatically associate a virtual machine with an Application Instance in SDR. When this command is enabled, the service will look for a match between the virtual machine's guest OS hostname and the hostname of the Network Address associated with the Application Instance. If there is a match, the virtual machine links to the Application Instance. When this command is disabled, no such automatic behavior is attempted.
Command Syntax
set hcs fulfillment auto-vm-linkage {enable | disable}
Parameters
•enable turns on the hcs fulfillment auto-vm-linkage.
•disable turns off the hcs fulfillment auto-vm-linkage.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command controls whether VCenterSync service needs to verify the security certificate of the vCenters that it connects to. If the value is set to Enable, then the vCenters that the Cisco HCS VCenter Sync Service connects to needs to have its public certificate uploaded to the Cisco HCM-F platform. If the value is set to Disable, then the Cisco HCS VCenter Sync Service does not check the vCenter's certificate when they are connected. Use the command set cert import to upload the certificate.
Command Syntax
set hcs vcentersync require-vcenter-certificate {enable | disable}
Parameters
•enable turns on the vcentersync require-vcenter-certificate.
•disable turns off the vcentersync require-vcenter-certificate.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables policies within the specified policy group name.
Command Syntax
set ipsec policy_group [group | all]
Parameters
[group] (mandatory) [ALL or group]
Usage Guidelines
Use the all option to delete all the groups.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command enables an IPsec policy with given policy name.
Command Syntax
set ipsec policy_name [policy_name | all]
Parameters
[policy_name] (mandatory) [ALL or policy name]
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command allows you to enable or disable logging for the current administrator.
Command Syntax
set logging {enable | disable}
Parameters
•enable turns on logging.
•disable turns off logging.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables or disables DHCP for Ethernet interface 0. You cannot configure Ethernet interface 1.
Command Syntax
set network dhcp eth0
enable
disable node_ip net_mask gateway_ip
Parameters
•eth0 specifies Ethernet interface 0.
•enable enables DHCP.
•disable disables DHCP.
•node_ip represents the new static IP address for the server.
•net_mask represents the subnet mask for the server.
•gateway_ip represents the IP address of the default gateway.
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the IP address for the primary or secondary DNS server.
Command Syntax
set network dns {primary | secondary} ip-address
Parameters
ip-address represents the IP address of the primary or secondary DNS server.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Note If you change the IP address for the primary DNS server, you must also restart the Cisco Tomcat service. For more information, see the utils service command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets DNS options.
Command Syntax
set network dns options [timeout seconds] [attempts number] [rotate]
Parameters
•timeout sets the DNS request timeout.
•attempts sets the number of times to attempt a DNS request before quitting.
•rotate causes the system to rotate among the configured DNS servers, distributing the load.
•seconds specifies the DNS timeout period, in seconds.
•number specifies the number of attempts.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the domain name for the system.
Command Syntax
set network domain domain-name
Parameters
domain-name represents the system domain that you want to assign.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command enables or disables network failover.
Command Syntax
set network failover {enable | disable}
Parameters
•enable enables network failover.
•disable disables network failover.
Usage Guidelines
When you enable network failover, a virtual interface (bond0) gets created. The virtual interface (bond0) uses the ethernet interface eth0, but fails over to eth1 if eth0 fails. 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, the system restarts.
Example
admin:set network failover enable
Creating virtual interface bond0 to failover ethernet interface eth0 to eth1
should 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 abort
yes
executing...
Broadcast message from root (Thu Jun 24 13:00:21 2004):
The system is going down for restart NOW!
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command enables you to configure the IP address of the network gateway.
Command Syntax
set network gateway ip-address
Parameters
ip-address represents the IP address of the network gateway that you want to assign.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the network hostname, and restarts the system.
Command Syntax
set network hostname name
Parameters
name—hostname to be assigned.
The name should follow ARPANET rules for hostnames. 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.
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 abort
yes
executing...
Broadcast message from root (Thu Jun 24 13:00:21 2004):
The system is going down for restart NOW!
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
•eth0 specifies Ethernet interface 0.
•ip-address represents the IP address that you want to assign.
•ip-mask represents the IP mask that you want to assign.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets system and network options for IPv6.
Note IPv6 is not supported in Cisco Business Edition or Cisco Unity Connection.
Command Syntax
set network ipv6
dhcp {enable|disable} [reboot]
gateway ipv6_address [reboot]
service {enable|disable} [reboot]
static_address ipv6_address mask [reboot]
Parameters
•dhcp enables or disables the DHCPv6 client on the server. By default, the server does not restart after you enable the DHCPv6 client. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.
•gateway enables the IPv6 service on the server. The server does not restart automatically, and you must restart it manually before your changes take effect.
•service enables or disables the IPv6 service on the server. By default, the server restarts after you enable or disable the IPv6 service. If you enter the no reboot parameter, the server does not restart automatically, and you must restart it manually before your changes take effect.
•static_address assigns a static IPv6 address to the server. By default, the server does not restart after you assign the static IPv6 address. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.
•ipv6_address specifies the static IPv6 address you assign to the server.
•mask specifies the IPv6 network mask (0-128).
•reboot causes the server to automatically restart after you enter the command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the maximum MTU value.
Command Syntax
set network mtu mtu_max
Parameters
mtu_max specifies the maximum MTU value.
Note The system default MTU value equals 1500.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Example
admin:set network mtu 576
W A R N I N G
This will cause the system to temporarily lose network connectivity
Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command sets the ip_conntrack_max value.
Command Syntax
set network max_ip_conntrack ip_conntrack_max
Parameters
ip_conntrack_max specifies the value for ip_conntrack_max.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•eth0 specifies Ethernet interface 0.
•auto specifies whether auto negotiation gets enabled or disabled.
•speed specifies 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 You can enable only one active NIC at a time.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables and disables Path MTU Discovery.
Command Syntax
set network pmtud [enable | disable]
Parameters
•enable enables Path MTU Discovery.
•disable disables Path MTU Discovery.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Example
admin:set network pmtud enable
W A R N I N G
This will cause the system to temporarily lose network connectivity
Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...
admin:
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command configures the specified Ethernet port to use a specified static IP address.
Command Syntax
set network restore eth0 ip-address network-mask gateway
Parameters
•eth0 specifies Ethernet interface 0.
•ip-address specifies the IP address.
•network-mask specifies the subnet mask.
•gateway specifies the IP address of the default gateway.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
eth0 specifies Ethernet interface 0.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
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
days is mandatory and represents the password age. Acceptable values specify 0 to10.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Use this command to force new or existing users to change their password when they sign in to the system the next time.
Note By default, this command is enabled for new users, so users have to change their password the first time they sign in to the system.
Command Syntax
set password change-at-login {enable|disable} userid
Parameters
•enable forces users to change their password when they sign in to the system the next time.
•disable does not force users to change their password.
•userid specifies the affected user account.
Requirements
Command privilege level: 4
Allowed during upgrade: Yes
This command modifies the value for the minimum password length for Cisco Unified Communications Operating System accounts.
Note Use this command only after you enable password character complexity.
Command Syntax
set password complexity minimum-length length
Parameters
length specifies the minimum number of characters and must be greater than or equal to 6.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command disables or enables minimum password aging for OS accounts.
Command Syntax
set password expiry minimum-age {enable | disable}
Parameters
•enable enables password expiry for OS accounts. This command sets the value of minimum password age to one day (24-hrs) for OS admin accounts.
•disable disables minimum password aging for OS accounts. This means that passwords for OS admin accounts can be changed at any interval.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command disables or enables password expiry maximum age settings for a specified OS account.
Command Syntax
set password expiry user maximum- age {disable | enable} userid
Parameters
•disable disables password expiry maximum age settings for the specified OS account.
•enable enables password expiry maximum age settings for the specified OS account.
•userid specifies the affected OS account.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command disables or enables password expiry minimum age settings for a specified OS account.
Command Syntax
set password expiry user minimum- age {disable | enable} userid
Parameters
•disable disables password expiry minimum age settings for the specified OS account.
•enable enables password expiry minimum age settings for the specified OS account.
•userid specifies the affected OS account.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command enables, disables, and configures password inactivity.
Command Syntax
set password inactivity [enable | disable | period days]
Parameters
days specifies the number of days of inactivity after a password has expired before the account gets disabled.
Usage guidelines
•To enable password inactivity globally, execute the set password inactivity enable command. This command enables the password inactivity globally and updates individual OS users according to the setting.
•To disable password inactivity globally, execute the set password inactivity disable command. This command disables the password inactivity globally and updates individual OS users according to the setting.
A user whose account is disabled must contact the system administrator to use the system again.
•To configure the password inactivity period execute the set password inactivity period days command. This command configures the password inactivity globally and updates individual OS users according to the setting.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
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
•number specifies the number of passwords to be maintained in history
–Enter 0 to disable this option
–Default value is 10
–Upper limit is 20
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command allows you to change the administrator and security passwords.
Command Syntax
set password user {admin | security}
Parameters
•admin specifies the administrator password.
•security specifies the security password.
Usage Guidelines
The systems prompts you for the old and new passwords.
Note The password must contain at least six characters, and the system checks it for strength.
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 Change the security password on the publisher server (first node) and then reboot the server (node).
Step 2 Change the security password on all the subsequent servers/nodes to the same password that you created on the first node and restart subsequent nodes, including application servers, to propagate the password change.
Note Cisco recommends that you restart each server after the password is changed on that server.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This command sets the number of concurrent sessions that can be opened.
Command Syntax
set session maxlim number
Parameters
•number specifies the number of sessions
–Lower limit is 1
–Upper limit is 100
–Default value is 10
Requirements
Command privilege level: 4
Allowed during upgrade: No
This command sets the SMTP server hostname.
Command Syntax
set smtp hostname
Parameters
hostname represents the SMTP server name.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command lets you change the system time zone.
Command Syntax
set timezone timezone
Parameters
timezone specifies the new time zone.
Note Although the list of available time zones produced by the show timezone list command includes Factory, Cisco Unified Communications Manager does not support the Factory time zone.
Usage Guidelines
Enter enough characters to uniquely identify the new time zone. Be aware that the time-zone name is case-sensitive.
Example
This example sets the time zone to Pacific time.
set timezone Pac
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This command sets the default (factory reset) trace configuration for the specified service.
Command Syntax
set trace default
Note The system prompts you for the service name.
Usage Guidelines
See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables or disables the tracing for the specified service.
set trace status
Note The system prompts you for the status and service name.
Parameters
•status = enable | disable
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This commands sets the trace level for the specified service.
Command Syntax
set trace tracelevel
Note The system prompts you for the trace level and service name.
Parameters
•tracelevel = use "show tracelevels" CLI command to find allowed trace levels for a given service name.
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the max trace file size for the specified service.
Command Syntax
set trace maxfilesize
Note The system prompts you for the size (in MBs) and the service name.
Parameters
•size in MBs specifies an integer value between 1 and 10.
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the maximum trace file count for the specified service.
Command Syntax
set trace maxnumfiles
Note The system prompts you for the file count and the service name.
Parameters
•filecount represents an integer value from 1 to 10000.
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the user categories flag to the value provided for the service specified.
Command Syntax
set trace usercategories
Note The system prompts you for the flag number and the service name.
Parameters
•flagnumber specifies 0 to 7FFF. 7FFF means all the flags get enabled.
•See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the web security certificate information for the operating system.
Command Syntax
set web-security orgunit orgname locality state [country alternatehostname]
Parameters
orgunit represents the organizational unit (OU) name.
Tip You can use this command to enter multiple organizational units. To enter more than one organizational unit name, separate the entries with a comma. For entries that already contain a comma, enter a backslash before the comma that is included as part of the entry. To enter multiple values for organizational unit, enclose them in quotation marks, as shown in the example for this command.
•orgname represents the organization name.
•locality represents the organization location.
•state represents the organization state.
•country (optional) represents the organization country.
•alternatehostname (optional) specifies an alternate name for the host when you generate a web-server (Tomcat) certificate.
Note When you set an alternate-host-name parameter with the set web-security command, self-signed certificates for tomcat will contain the Subject Alternate Name extension with the alternate-host-name specified. CSR for Cisco Unified Communications Manager will contain Subject Alternate Name Extension with the alternate hostname included in the CSR.
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 CA
In this example, the certificate will have three OU fields:
•OU=accounting
•OU=personnel, CA
•OU=personnel, MA
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command sets the working directory for active, inactive, and installation logs.
Command Syntax
set workingdir
activelog directory
inactivelog directory
Parameters
•activelog sets the working directory for active logs.
•inactivelog sets the working directory for inactive logs.
•directory represents the current working directory.
Requirements
Command privilege level: 0 for logs
Allowed during upgrade: No
This command sets the time, in minutes, that can elapse before a web application, such as Cisco Unified Communications Manager Administration, times out and logs off the user. For the new webapp session timeout setting to become effective, you must restart the Cisco Tomcat service. This command prompts you to restart the service.
Tip Until you restart the Cisco Tomcat service, the show webapp session timeout command reflects the new values, but system continues to use and reflect the old values.
Note This setting gets preserved through a software upgrade and does not get reset to the default value.
Command Syntax
set webapp session timeout minutes
Parameters
•minutes specifies the time, in minutes, that can elapse before a web application times out and logs off the user.
–Value range: 5-99999 minutes
–Default value: 30 minutes
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
•show hcs fulfillment auto-vm-linkage
•show hcs vcentersync require-vcenter-certificate
•show password complexity character
•show password complexity length
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: No
This command displays the current account locking settings.
Command Syntax
show accountlocking
Example
admin:show accountlocking
Account Lockout is disabled
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays alarm configurations.
Command Syntax
show alarm
Usage Guidelines
•The system prompts you for the service name. Service name can comprise multiple words.
•Enter service name all to show alarm configurations of all the services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the audit log configuration.
Command Syntax
show auditlog
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays certificate contents and certificate trust lists.
Command Syntax
show cert
own filename
trust filename
list {own | trust}
Parameters
•filename represents the name of the certificate file.
•own specifies owned certificates.
•trust specifies trusted certificates.
•list specifies a certificate trust list.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the status of automatic CLI pagination.
Command Syntax
show cli pagination
Parameters
None
Example
admin: show cli pagination
Automatic Pagination : Off.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the CLI session timeout value, which is the amount of time, in minutes, that can elapse before a CLI session times out and disconnects.
Command Syntax
show cli session timeout
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the selected own certificate file.
Command Syntax
show csr own name
Parameters
name is mandatory and represents the name of the certificate sign request.
Usage Guidelines
You can get the certificate name by executing the show cert list own command.
Example
admin:show csr own tomcat/tomcat.csr
[
[
-----BEGIN CERTIFICATE SIGN REQUEST-----
MIIDrDCCAxUCBENeUewwDQYJKoZIhvcNAQEEBQAwggEbMTQwMgYDVQQGEytVbmFibGUgdG8gZmlu
ZCBDb3VudHJ5IGluIHBsYXRmb3JtIGRhdGFiYXNlMTIwMAYDVQQIEylVbmFibGUgdG8gZmluZCBT
dGF0ZSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTE1MDMGA1UEBxMsVW5hYmxlIHRvIGZpbmQgTG9jYXRp
b24gaW4gcGxhdGZvcm0gZGF0YWJhc2UxMDAuBgNVBAoTJ1VuYWJsZSB0byBmaW5kIE9yZyBpbiBw
bGF0Zm9ybSBkYXRhYmFzZTExMC8GA1UECxMoVW5hYmxlIHRvIGZpbmQgVW5pdCBpbiBwbGF0Zm9y
bSBkYXRhYmFzZTETMBEGA1UEAxMKYmxkci1jY20zNjAeFw0wNTEwMjUxNTQwMjhaFw0xMDEwMjQx
NTQwMjhaMIIBGzE0MDIGA1UEBhMrVW5hYmxlIHRvIGZpbmQgQ291bnRyeSBpbiBwbGF0Zm9ybSBk
YXRhYmFzZTEyMDAGA1UECBMpVW5hYmxlIHRvIGZpbmQgU3RhdGUgaW4gcGxhdGZvcm0gZGF0YWJh
c2UxNTAzBgNVBAcTLFVuYWJsZSB0byBmaW5kIExvY2F0aW9uIGluIHBsYXRmb3JtIGRhdGFiYXNl
MTAwLgYDVQQKEydVbmFibGUgdG8gZmluZCBPcmcgaW4gcGxhdGZvcm0gZGF0YWJhc2UxMTAvBgNV
BAsTKFVuYWJsZSB0byBmaW5kIFVuaXQgaW4gcGxhdGZvcm0gZGF0YWJhc2UxEzARBgNVBAMTCmJs
ZHItY2NtMzYwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMoZ4eLmk1Q3uEFwmb4iU5nrMbhm
J7bexSnC3PuDGncxT3Au4zpGgMaQRL+mk+dAt8gDZfFKz8uUkUoibcUhvqk4h3FoTEM+6qgFWVMk
gSNUU+1i9MST4m1aq5hCP87GljtPbnCXEsFXaKH+gxBq5eBvmmzmO1D/otXrsfsnmSt1AgMBAAEw
DQYJKoZIhvcNAQEEBQADgYEAKwhDyOoUDiZvlAOJVTNF3VuUqv4nSJlGafB6WFldnh+3yqBWwfGn
Q3ocBr9CZ5OTt7N6asZth4ggZ0ihJGXy6LKQmuUNIlJbNyQteM2Ak/E6usYBiCmUq0uhkf8g+ZFc
UmmqGOBORwQDSAEC69T98IUeTYM3jBwtGFRE3qsxWok=
-----END CERTIFICATE SIGN REQUEST -----
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the own CSR file.
Command Syntax
show csr list own
Parameters
own specifies owned csr.
Usage guidelines
The certificate name can be obtained by using the show cert list own command.
Example
admin:show csr list own
tomcat/tomcat.csr
Vipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr
Requirements
Command privilege level: 1
Allowed during upgrade: No
The command displays the date and time on the server.
Command Syntax
show date
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•activelog displays disk usage information about the activelog directory.
•common displays disk usage information about the common directory.
•inactivelog displays disk usage information about the inactivelog directory.
•install displays disk usage information about the install directory.
•tftp displays disk usage information about the TFTP directory.
•tmp displays disk usage information about the TMP directory.
Options
•filename filename—Saves the output to a file that is specified by filename. These files get stored in the platform/cli directory. To view saved files, use the file view activelog command.
•directory—Displays just the directory sizes.
•sort—Sorts the output on the basis of file size. File sizes display in 1024-byte blocks.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the current DSCP traffic markings on all of the ports. It displays the DSCP markings in decimal and hexadecimal. If the value corresponds to a class then it displays the correct class. If the value does not corresponds to a class then it displays N/A.
Command Syntax
show dscp all
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the default factory DSCP settings. These values take effect if the set dscp defaults command is executed.
Command Syntax
show dscp defaults
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the current DSCP traffic markings for a particular DSCP value.
Command Syntax
show dscp marking value
Parameters
value is a DSCP value. You can enter the name of a well-known DSCP class, or a numeric value in decimal or hexadecimal format. Precede hexadecimal values with 0x or 0X.
Usage Guidelines
The valid class names as defined by DSCP are:
•Class Selector: values CS0, CS1, CS2, CS3, CS5, CS6, CS7
The class selector (CS) values correspond to IP Precedence values and are fully compatible with IP Precedence.
•Expedited Forwarding: value EF
EF PHB is ideally suited for applications such as VoIP that require low bandwidth, guaranteed bandwidth, low delay, and low jitter.
•Best Effort: value BE
Also called default PHB, this value essentially specifies that a packet be marked with 0x00, which gets the traditional best-effort service from the network router.
•Assured Forwarding: values AF11, AF12, AF13, AF21, AF22, AF23, AF41, AF42, AF43
There are four types of Assured Forwarding classes, each of which has three drop precedence values. These precedence values define the order in which a packet is dropped (if needed) due to network congestion. For example, packets in AF13 class are dropped before packets in the AF12 class.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the current DSCP traffic markings.
Command Syntax
show dscp status [enabled | disabled]
Parameters
•enabled filters the output to show only DSCP traffic markings that are enabled. If you do not specify a status, this filter is the default option.
•disabled filters the output to show only DSCP traffic markings that are disabled.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays environmental information for three types of hardware components.
Command Syntax
show environment
fans
power-supply
temperatures
Options
•fans—Displays the fan speeds in Rotations per Minute (RPMs), fan-speed thresholds, and status.
•power-supply—Displays the power-supply status only on servers with redundant power supplies.
•temperatures—Displays the temperature sensor temperature values, thresholds, and status.
Note The output data from the show environment command varies between IBM and HP server models.
•RAID controller status
Requirements
Command privilege level: 0
Allowed during upgrade: No
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:
•Platform
•Serial number
•BIOS build level
•BIOS manufacturer
•Active processors
•RAID controller status
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the state of the Cisco Hosted Collaboration Mediation Fulfillment Auto-VM-Linkage. The state of the Cisco Hosted Collaboration Mediation Fulfillment Auto-VM-Linkage is either enable or disable.
Command Syntax
show hcs fulfillment auto-vm-linkage
Parameters
None
Example
read service parameter: fulfillment auto-vm-linkage
HCS fulfillment auto-vm-linkage is enable
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the state of the HCS vcentersync require-vcenter-certificate. The state of the vcentersync require-vcenter-certificate is either enable or disable.
Command Syntax
show hcs vcentersync require-vcenter-certificate
Parameters
None
Example
read service parameter: vcentersync require-vcenter-certificate
HCS fulfillment auto-vm-linkage is enable
Requirements
Command privilege level: 0
Allowed during upgrade: No
This commands displays detailed information about the specified IPsec policy.
Command Syntax
show ipsec information [policy_group] [policy_name]
Parameters
•[policy_group] (mandatory) specifies the policy group name.
•[policy_name] (mandatory) specifies the policy name.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This commands displays all the IPsec policy groups on the node.
Command Syntax
show ipsec policy_group
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the list of IPsec policy names that exist in the specified policy group.
Command Syntax
show ipsec policy_name [policy_group]
Parameters
[policy_group] (mandatory) specifies the policy group name
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the status of all IPsec tunnels defined in the system.
Command Syntax
show ipsec status
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command lists recent administrator logins to the server.
Command Syntax
show logins number
Parameters
number specifies the number of most recent administrator logins to display. The default specifies 20.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays information about the onboard memory.
Command Syntax
show memory
count
modules
module {modulenumber | all}
size
Options
•count—Displays the number of memory modules on the system.
•modules—Displays detailed information about all the memory modules.
•size—Displays the total amount of physical memory.
•modulenumber specifies the module number to be displayed.
•all specifies that all modules will be displayed.
Parameters
•None
•show memory module [module number | all]
–module number specifies mandatory module number to be fetched or ALL
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays information about the current account.
Command Syntax
show myself
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays network information.
Command Syntax
show network
eth0 [detail][ search srchtxt]
failover [detail] [page]
route [detail ][ search srchtxt]
status [detail] [listen] [process] [all] [nodns] [search stext]
ip_conntrack
max_ip_conntrack
dhcp eth0 stat
all [detail] [page] [ search srchtxt]
Parameters
•eth0 specifies Ethernet 0.
•failover specifies Network Fault Tolerance information.
•route specifies network routing information.
•status specifies active Internet connections.
•ip_conntrack specifies ip_conntrack usage information.
•max_ip_conntrack specifies max_ip_conntrack information.
•dhcp eth0 status displays DHCP status information.
•all specifies all basic network information.
Options
•detail—Displays additional information.
•page—Displays information one page at a time.
•listen—Displays only listening sockets.
•process—Displays the process ID and name of the program to which each socket belongs.
•all—Displays both listening and nonlistening sockets.
•nodns—Displays numerical addresses without any DNS information.
•search stext—Searches for the stext in the output.
Usage Guidelines
The eth0 parameter displays Ethernet port 0 settings, including DHCP and DNS configurations and options.
Example
This example displays active Internet connections.
show network status
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the list of ports that have been requested to be opened or translated in the firewall.
Command Syntax
show network 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.
Example
admin:show network ipprefs public
Application IPProtocol PortValue Type XlatedPort Status Description
------------ ------------ ------------ ------------ ------------ ------------ ------------
sshd tcp 22 public - enabled sftp and ssh access
tomcat tcp 8443 translated 443 enabled secure web access
tomcat tcp 8080 translated 80 enabled web access
clm udp 8500 public - enabled cluster manager
clm tcp 8500 public - enabled cluster manager
ntpd udp 123 public - enabled network time sync
snmpdm udp 161 public - enabled SNMP
ccm tcp 2000 public - enabled SCCP-SIG
ctftp udp 6969 translated 69 enabled TFTP access to CUCM TFTP Server
ctftp tcp 6970 public - enabled HTTP access to CUCM TFTP Server
admin:
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays IPv6 network routes and network settings.
Note IPv6 is not supported in Cisco Business Edition or Cisco Unity Connection.
Command Syntax
show network ipv6 {route | settings}
Parameters
•route displays all IPv6 routes.
•settings displays IPv6 network settings.
Command privilege level: 1
Allowed during upgrade: No
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
•files displays open files on the system.
•ports displays open ports on the system.
Options
•all—Displays all open files or ports.
•process—Displays open files that belong to the specified process.
•processID—Specifies a process.
•regexp—Displays open files or ports that match the specified regular expression.
•reg_exp—Represents a regular expression.
Command privilege level: 4
Allowed during upgrade: Unknown
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
page—Displays the output one page at a time
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
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: No
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 password must adhere to the following guidelines:
•It must contain at least one lowercase character.
•It must contain at least one uppercase character.
•It must contain one digit.
•It must contain one special character.
•A password comprised of all adjacent characters on the keyboard will not be accepted.
•None of the previous ten passwords can be reused.
•The admin user password can be changed only once in 24-hours.
A violation of any of the these rules will result in a failure.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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: No
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: No
This command displays the status of password inactivity.
Command Syntax
show password inactivity
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the description of the specified perfmon counter.
Command Syntax
show perf counterhelp class-name counter-name
Parameters
•class-name is mandatory and specifies the perf class name that contains the perf counter.
•counter-name is mandatory and specifies the perf counter name to display.
Usage Guidelines
If class-name or counter-name contains white space, class-name or counter-name must be included in double quotation marks.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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.
Command privilege level: 1
Allowed during upgrade: No
This command displays all categories in the perfmon system.
Command Syntax
show perf list categories
Parameters
None
Example
admin:show perf list categories
==>list categories:
...
- RISSystemAccess
...
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This command displays perfmon classes (objects).
Command Syntax
show perf list classes [cat category | cat category detail | detail]
Parameters
•cat category displays perfmon classes for the specified category.
•detail displays detailed information.
Usage Guidelines
If the category name contains white space, category must be included in double quotation marks.
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 222
Requirements
Command privilege level: 0
Allowed during upgrade: No
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 must be included in double quotation marks.
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 218
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays perfmon instances of a specified perfmon class.
Command Syntax
show perf list instances 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 must be included in double quotation marks.
Example
admin:show perf list instances Processor detail
==>perf class (Processor) has instances:
* Instance Name index
- _Total 0
- 0 1
- 1 2
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command queries specific perfmon paths.
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
•If path-spec contains white space, it must be included in double quotation marks.
•You can query a maximum of five paths at the same time delimited by commas with no space after the comma (for example, path-spec,path-spec).
Example
admin:show perf query path "Processor(0)\System Percentage,System\Total CPU Time"
- query path :
Processor(0)\System Percentage = 0
System\Total CPU Time = 56273840
Processor(0)\System Percentage = 9
System\Total CPU Time = 56274645
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command queries perfmon classes 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
•If class-name contains white space, it must be included in double quotation marks.
•You can query a maximum of five class-names at the same time delimited by commas with no space after the comma (for example, class-name,class-name):
•You can execute the show perf list classes command to display the list of perfmon class display names.
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 = 45
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•class-name is mandatory and represents the perf class name that contains the perf counter.
•counter-name counter-name is mandatory and represents the perf counter name to display. A maximum of five counters can be queried at the same time.
Usage Guidelines
If class-name or counter-name contains white space, the name must be included in double quotation marks.
Example
admin:show perf query counter System "Max FDs"
- Perf class System(Max FDs) has values:
-> Max FDs = 102535
admin:show perf query counter System "Max FDs,Total Threads"
- Perf class System(Max FDs,Total Threads) has values:
-> Max FDs = 102535
-> Total Threads = 324
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•class-name is mandatory and represents the perf class name that contains the perf instance.
•instance-name instance-name is mandatory and represents the perf instance name to display.
Usage Guidelines
•If the class-name or instance-name contains white space, the name must be included in double quotation marks.
•A maximum of five instances can be queried at the same time delimited by a comma with no space after the comma.
Example
admin:show perf query instance Processor 0,1
- Perf class Processor(0,1) has values:
0 -> % CPU Time = 22
0 -> IOwait Percentage = 1
0 -> Idle Percentage = 78
0 -> Irq Percentage = 0
0 -> Nice Percentage = 4
0 -> Softirq Percentage = 0
0 -> System Percentage = 14
0 -> User Percentage = 3
1 -> % CPU Time = 22
1 -> IOwait Percentage = 1
1 -> Idle Percentage = 78
1 -> Irq Percentage = 0
1 -> Nice Percentage = 3
1 -> Softirq Percentage = 0
1 -> System Percentage = 13
1 -> User Percentage = 5
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•list displays a list of all the processes and critical information about each process and visually indicates the child-parent relationships between the processes.
•load displays the current load on the system.
•name displays the details of processes that share the same name and indicates their parent-child relationship.
•open-fd lists the open file descriptors for a comma-separated list of process IDs.
•search searches for the pattern that the regular expression regexp specifies in the output of the operating system-specific process listing.
•user username retrieves details of processes that share the username and displays parent-child relationship.
•using-most cpu displays a list of the most CPU-intensive processes.
•using-most memory displays a list of the most memory-intensive processes.
Options
•file filename—Outputs the results to the file that is specified by filename.
•detail—Displays detailed output.
•cont—Repeats the command continuously.
•clear—Clears the screen before displaying output.
•noidle—Ignores the idle/zombie processes.
•num number—Displays the number of processes that are specified by number. The default number of processes is 10. Set number to all to display all processes.
•thread—Displays threads.
•[cpu | memory | time]—Sorts output by CPU usage, memory usage, or time usage. The default specifies to sort by CPU usage.
•page—Displays the output in pages.
•process—Specifies the name of a process.
•pid—Specifies the process ID number of a process.
•regexp—Represents a regular expression.
•number—Specifies the number of processes to display. The default specifies 5.
•username—(mandatory) Specifies the username.
•vm—Displays the virtual memory of the process.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the contents of the registry of a number of systems and components. The registry is a repository for a variety of component-specific settings.
Command Syntax
show registry {system} {component} [name] [page]
Parameters
•system represents the registry system name.
•component represents the registry component name.
•name the name of the parameter to display.
•page pauses the output.
Usage Guidelines
To display the contents of the registry of all the systems and components, use the following command:
show registry * *
If the name of the parameter that you want to display is page, and you want to view the output by page. Use the following command:
show registry system component page page
Example
admin:show registry cm dbl/sdi
system = cm
component = dbl/sdi
tracelevel=127
enable=1
outputdebugstringflag=0
numminutes=1440
tracefile=/var/log/active/cm/trace/dbl/sdi/dbl.log
numfiles=250
numlines=10000
Requirements
Command privilege level: 0
Allowed during upgrade: No
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.
•The file gets saved in platform/cli/filename.txt.
•filename should not contain the "." character.
•If the specified file already exists, it will be renamed.
Example
admin: show risdb list file TableList
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the contents of the Realtime Information Service (RIS) database.
Command Syntax
show risdb query [tablename] [tablename] file filename
Parameters
•tablename is mandatory and represents the name of the tables or tables that are listed when show risdb list command is run.
•filename represents the name of the file to which the output should be sent.
Usage Guidelines
•The file will be saved in platform/cli/filename.txt.
•filename should not contain the "." character.
•If the specified file already exists it will be renamed.
Example
admin: show risdb query genalarm file genalarmtable
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the session limit value which controls the number of concurrent SSH sessions.
Command Syntax
show session maxlimit
Parameters
None
Example
admin: show session maxlimit
concurrent sessions is limited to 10
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the name of the SMTP host.
Command Syntax
show snmp
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays system IO statistics.
Command Syntax
show stats io [kilo] [detail] [page] [file filename]
Options
•kilo—Displays statistics in kilobytes.
•detail—Displays detailed statistics on every available device on the system and overrides the kilo option.
•file filename—Outputs the information to a file.
Note 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: No
This command displays basic platform status.
Command Syntax
show status
Usage Guidelines
This command displays the following basic platform status:
•Hostname
•Date
•Time zone
•Locale
•Product version
•Platform version
•CPU usage
•Memory and disk usage
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the combined output of all show tech commands.
Command Syntax
show tech all [page] [file filename]
Options
•page—Displays one page at a time.
•file filename—Outputs the information to a file.
Note 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: No
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 [page] [search text] [file filename][numeric]
Parameters
•all displays all network tech information.
•hosts displays information about hosts configuration.
•interfaces displays information about the network interfaces.
•resolv displays information about hostname resolution.
•routes displays information about network routes.
•sockets displays the list of open sockets.
Options
•page—Displays one page at a time.
•search text—Searches the output for the string that text specifies. Be aware that the search is case insensitive.
•file filename—Outputs the information to a file.
•numeric—Displays the numerical addresses of the ports instead of determining symbolic hosts. This parameter is equivalent to running the Linux shell command netstat [-n] command.
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: No
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
•all displays all the system information.
•bus displays information about the data buses on the server.
•hardware displays information about the server hardware.
•host displays information about the server.
•kernel modules lists the installed kernel modules.
•software displays information about the installed software versions.
•tools displays information about the software tools on the server.
Options
•page—Displays one page at a time.
•file filename—Outputs the information to a file.
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: No
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
•all displays all runtime information.
•cpu displays CPU usage information at the time the command is run.
•disk displays system disk usage information.
•env displays environment variables.
•memory displays memory usage information.
Options
•page—Displays one page at a time.
•file filename—Outputs the information to a file.
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays time zone information.
Command Syntax
show timezone
config
list [page]
Parameters
•config displays the current time zone settings.
•list displays the available time zones.
Note Although the list of available time zones includes Factory, Cisco Unified Communications Manager does not support the Factory time zone.
Options
page—Displays the output one page at a time.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the trace configuration for the specified service.
Command Syntax
show trace
Usage Guidelines
See the "Services on the Cisco HCM-F Platform" section for a list of services.
Enter all to display the trace configurations of all the services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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. See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
Requirements
Command privilege level: 0
Allowed during upgrade: No
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: No
This command displays the contents of the current web-security certificate.
Command Syntax
show web-security
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the webapp session timeout value, which is the amount of time, in minutes, that can elapse before a web application times out and logs off the user.
Command Syntax
show webapp session timeout
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command retrieves the current working directory for active log, inactive log, install, and TFTP.
Command Syntax
show workingdir
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command disables the IPsec policy on the specified group.
Command Syntax
unset ipsec policy_name [policy_group]
Parameters
policy_group (mandatory) specifies the group name
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command disables the IPsec policy with the specified name.
Command Syntax
unset ipsec policy_name [policy_name]
Parameters
•policy_name (mandatory) specifies the policy name to disable.
–ALL
–policy name
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command unsets DNS options.
Command Syntax
unset network dns options [timeout] [attempts] [rotate]
Parameters
•timeout sets the wait time before the system considers a DNS query as failed to the default.
•attempts sets the number of DNS attempts to make before failing to the default.
•rotate sets the method for selecting a name server to the default. This affects how loads are distributed across name servers.
Usage Guidelines
The system asks whether you want to continue to execute this command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command unsets the domain name and restarts the server.
Command Syntax
unset network domain
Parameters
None
Usage Guidelines
You are asked to confirm that you want to execute this command.
Example
admin:unset network domain
cmdSetIp.domain.name.change.warning
Continue (y/n)?
trying to restart system...
Warning: Restart could take up to 5 minutes...
Shutting down Service Manager. Please wait...
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command unsets the ipv6 static address.
Command Syntax
unset network ipv6 [static_address |gateway] [reboot]
Parameters
reboot causes the server to reboot the server after the changes get applied.
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: Yes
•utils disaster_recovery backup local
•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 estimate_tar_size
•utils disaster_recovery history
•utils disaster_recovery maverick
•utils disaster_recovery restore local
•utils disaster_recovery restore network
•utils disaster_recovery schedule
•utils disaster_recovery show_backupfiles tape
•utils disaster_recovery show_backupfiles network
•utils disaster_recovery show_registration
•utils disaster_recovery status
•utils migrate service inventory
•utils os kerneldump ssh enable
•utils os kerneldump ssh disable
•utils os kerneldump ssh status
•utils snmp config 1/2c community-string
•utils snmp config 1/2c inform
•utils snmp config 1/2c 3 trap
•utils snmp config mib2 delete
•utils snmp config mib2 update
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.
Command Syntax
utils auditd {enable | disable | status}
Parameters
•enable—Turns on audit logging.
•disable—Turns off audit logging.
•status—Displays whether audit logging is on or off.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command affects existing core files.
Command Syntax
utils core active
list
analyze core_file_name
Parameters
•list displays the existing core files.
•analyze displays the stack trace for the specified core file.
Options
core_file_name name of core file from which to get stack trace.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays a list of core files.
Command Syntax
utils core inactive list
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays back trace for the specified core file. A list of core files can be obtained by using 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: No
This command creates reports about the server in the platform/log directory.
Command Syntax
utils create report
hardware
platform
security
Parameters
•hardware creates a system report that contains disk array, remote console, diagnostic, and environmental data.
•platform collects the platform configuration files into a TAR file.
•security collects the diagnostic reports and creates a TAR file that you can download for troubleshooting purposes. You can retrieve this file by using the file get command.
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
This command is not supported for HCM-F. Refer to utils os secure permissive CLI command for replacement.
This command is not supported for HCM-F. Refer to utils os secure enforce CLI command for replacement.
This command is not supported for HCM-F. Refer to utils os secure status CLI command for replacement.
This command enables you to diagnose and attempt to automatically fix system problems.
Command Syntax
utils diagnose
fix
hcs
list
module module_name
test
version
Parameters
•fix runs all diagnostic commands and attempts to fix problems.
•hcs lists all the diagnostic commands available for HCS services.
•list lists all available diagnostic commands.
•module runs a single diagnostic command or group of commands and attempts to fix problems.
•test runs all diagnostic commands but does not attempt to fix problems.
•version displays the diagnostic framework version.
•module_name specifies the name of a diagnostics module.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command enables you to diagnose problems for HCS services.
Command Syntax
utils diagnose hcs
cnf
dmacuom
fulfillment
nbi
si
vcentersync
cucdmsync
Parameters
•cnf displays the diagnostics information for the underlying change notification messages. This information is helpful for debugging purposes.
•dmacuom displays the diagnostics information for the DMA CUOM Service. This information is helpful for debugging purposes.
•fulfillment displays the diagnostics information for the fulfillment Service. This information is helpful for debugging purposes.
•nbi displays the diagnostics information for the North Bound Interface Service. This information is helpful for debugging purposes.
•si displays the diagnostics information for the Service Inventory Service. This information is helpful for debugging purposes.
•vcentersync displays the diagnostics information for the VCenterSync Service. This information is helpful for debugging purposes.
•cucdmsync displays the diagnostics information for the CUCDMSync Service. This information is helpful for debugging purposes.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•featurelist is mandatory and comprises a comma-separated feature list to back up.
•device_name is mandatory and specifies the name of the backup device to be added.
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.
Example
admin:utils disaster_recovery backup local VIPR localdevice
Backup initiated successfully.Please run 'utils showstatus backup' command to see the status.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
•featurelist specifies the list of features to back up, separated by commas.
•path represents the location of the backup files on the remote server.
•servername represents the IP address or hostname of the server where you stored the backup files.
•username represents the username that is needed to log in to the remote server.
Usage Guidelines
Note The system prompts you to enter the password for the account on the remote server.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command cancels the ongoing backup job.
Command Syntax
utils disaster_recovery cancel_backup confirm
Usage Guidelines
After you enter the command, you must confirm that you want to cancel the backup. Enter Y to cancel the backup or any other key to continue the backup.
Example
admin:utils disaster_recovery cancel_backup yes
Cancelling backup...
Backup cancelled successfully.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command provides the estimated size of the last successful backup from the SFTP/local device.
Command Syntax
utils disaster_recovery estimate_tar_size featurelist
Parameters
featurelist specifies the list of features to back up, separated by commas.
Usage Guidelines
Use utils disaster_recovery show_registration <servername> to display the list of registered features.
Example
admin:utils disaster_recovery estimate_tar_size UCM
Estimated tar size successfully: Estimated size of backup for selected features is 42.52 MB.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command displays the history of previous backups and restores.
Command Syntax
utils disaster_recovery history operation
Parameters
operation specifies backup or restore
Example
admin:utils disaster_recovery history backup
Tar Filename: Backup Device: Completed On: Result: Backup Type: Features Backed Up:
2009-10-30-14-53-32.tar TAPE Fri Oct 30 14:55:31 CDT 2009 ERROR MANUAL
2009-12-10-10-30-17.tar TAPE Thu Dec 10 10:35:22 CST 2009 SUCCESS MANUAL
CDR_CAR,CCM
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command enables or disables the detailed maverick logging.
Command Syntax
utils disaster_recovery maverick [enable] [disable]
Parameters
•enable enables the detailed maverick logging
•disable disables the detailed maverick logging
Example
admin:utils disaster_recovery maverick enable
drfCliCommand: maverick Maverick detailed logging enabled.
Restart Master and Local Agent in this machine for the changes to take effect.
admin:utils disaster_recovery maverick disable
drfCliCommand: maverick Maverick detailed logging disabled.
Restart Master and Local Agent in this machine for the changes to take effect.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command adds:
•backup tape device
•backup local device
•backup network device
Command Syntax
utils disaster_recovery device add
local device_name Number_of_backups
network device_name path server_name username Number_of_backups
Parameters
•device_name—name of the backup device to be added
•path—path to retrieve backup device from this location
•server_name—hostname of the server where the backup file needs to be stored
•username—user ID to connect to the remote machine
•Number_of_backups—Number of backups to be stored on the local or the network directory (default value is 2)
Examples:
admin:utils disaster_recovery device add local localBackup 3
admin:utils disaster_recovery device add network networkDevice /root
10.77.31.116 root 3
admin:utils disaster_recovery device add tape tapeDevice /dev/nst0
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command deletes the specified device.
Command Syntax
utils disaster_recovery device delete [device_name|*]
Parameters
•device_name is mandatory and specifies the name of the device to be deleted.
•* deletes all the existing devices except for the ones associated to a schedule
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: Yes
This command displays the device name, device type, and device path for all the backup devices.
Command Syntax
utils disaster_recovery device list
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
•restore_server is mandatory and represents the hostname of the server to be restored.
•tarfilename is mandatory and specifies the file that will get restored (without the file extension, for example: 2008-01-21-18-25-03).
•device_name is mandatory and specifies the name of the backup device to be added.
Note The tar files must be stored in a restore directory before starting the restore operation.
Usage Guidelines
Use utils disaster_recovery device list to display the configured device list.
Example
admin:utils disaster_recovery restore local SW075B-CM11 2008-01-21-18-25-03 localdevice
Restore initiated successfully.Please run 'utils showstatus restore' command to see the status.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
•restore_server specifies the hostname of the server that you want to restore.
•tarfilename specifies the name of the file to restore.
•path represents the location of the backup files on the remote server.
•servername represents the IP address or hostname of the server where you stored the backup files.
•username represents the username that you need to log in to the remote server.
Usage Guidelines
Note The system prompts you to enter the password for the account on the remote server.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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: Yes
disable schedulename
Command privilege level: 1
Allowed during upgrade: No
delete [schedulename|*]
Command privilege level: 1
Allowed during upgrade: No
Parameters
•list displays the schedules that are configured.
•add adds the configured schedules.
•enable enables the specified schedule.
•disable disables the specified schedule
•delete deletes the specified schedule.
Options
•schedulename (mandatory) name of the scheduler
•devicename (mandatory) name of the device for which scheduling is done
•featurelist (mandatory) comma-separated feature list to back up
•datetime (mandatory) date when the scheduler is set. Format specified: (yyyy/mm/dd-hh:mm) 24-hrs clock
•frequency (mandatory) frequency at which the scheduler is set to take a backup. Examples: once, daily, weekly and monthly
•* all
List Example
admin:utils disaster_recovery schedule list
schedule name device name Schedule Status
----------------------------------------
schedule1 dev1 enabled
schedule2 dev2 disabled
Enable Example
utils disaster_recovery schedule enable schedule1
Schedule enabled successfully.
Disable Example
utils disaster_recovery schedule disable schedule1
Schedule disabled successfully.
Command Syntax
utils disaster_recovery show_backupfiles local backup|restore
Parameters
directory—name of the local backup/restore directory
Example
admin:utils disaster_recovery show_backupfiles local backup/restore
2009-05-14-21-12-00
2009-05-16-21-12-00
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command retrieves the information in the backup files that are available on tape.
Command Syntax
utils disaster_recovery show_backupfiles tape tapeid
Parameters
tapeid is mandatory and specifies the tape from which to display backup files.
Usage Guidelines
To display the list of tape IDs, execute the utils disaster_recovery show_tapeid command.
Example
admin:utils disaster_recovery show_backupfiles tape /dev/nst0
20050426181203853
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command retrieves information in the backup files that are available on the network drive.
Command Syntax
utils disaster_recovery show_backupfiles network path servername userid
Parameters
•path is mandatory and specifies the path to the backup files location.
•servername is mandatory and specifies the server IP address/hostname where the backup file is stored.
•userid is mandatory and specifies the user ID used to connect to the remote machine.
Example
admin:utils disaster_recovery show_backupfiles network /usr/local/ 10.77.31.55 administrator
Please enter password to connect to network server 10.77.31.55:****
20050426181203855
20050426181203853
20050426181203857
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the registered features and components on the specified server.
Command Syntax
utils disaster_recovery show_registration hostname
Parameters
hostname specifies the server for which you want to display registration information.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command displays the status of the current backup or restore job.
Command Syntax
utils disaster_recovery status operation
Parameters
operation specifies the name of the ongoing operation: backup or restore.
Requirements
Command privilege level: 1
Allowed during upgrade: No
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
•debug turns debugging on or off. If you do not enter the time parameter, this command turns on debugging for 5 minutes.
•disable turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.
•enable turns on the IPv6 firewall.
•list displays the current configuration of the firewall.
•status displays the current status of the firewall.
•time sets duration for the command in one of the following formats:
–Minutes: 0-1440m
–Hours: 0-23h
–Hours and minutes: 0-23h 0-60m
Requirements
Command privilege level: 0
Allowed during upgrade: No
This commands sets options and displays status for the IPv6 network firewall.
Note IPv6 is not supported in Cisco Business Edition or Cisco Unity Connection.
Command Syntax
utils firewall ipv6
debug [off | time]
disable [time]
enable
list
status
Parameters
•debug turns debugging on or off. If you do not enter the time parameter, this command turns on debugging for 5 minutes.
•disable turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.
•enable turns on the IPv6 firewall.
•list displays the current configuration of the firewall.
•status displays the current status of the firewall.
•time sets duration for the command in one of the following formats:
–Minutes: 0-1440m
–Hours: 0-23h
–Hours and minutes: 0-23h 0-60m
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command takes data from the platformConfig.xml file on the virtual floppy drive and modifies the system to match the configuration file. The system reboots after the command successfully completes.
Command Syntax
utils import config
Parameters
None
Usage guidelines
To execute this command on a VMware deployment that has been cloned (copied) from a template.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command displays the iostat output for the given number of iterations and interval.
Command Syntax
utils iostat [interval] [iterations] [filename]
Parameters
•interval represents the value in seconds between two iostat readings (mandatory if you specify the number of iterations)
•iterations represents the number of iostat iterations to be performed (mandatory if you specify an interval)
•filename redirects the output to a file
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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
•enable turns on the I/O throttling enhancements. When enabled, I/O throttline enhancements lower the impact of upgrades on an active system.
•disable turns off the I/O throttling enhancements. This can adversely affect the system during upgrades.
•status displays the status of I/O throttling enhancements.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command configures your system to use an FQDN for LDAP authentication. If your system is not DNS configured, use the command: utils ldap config ipaddr.
Command Syntax
utils ldap config fqdn
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command configures your system to use an IP address for LDAP authentication. This is not the preferred method. It is required if your system is not or cannot be configured to use DNS. In such case use the command: utils ldap config fqdn.
Command Syntax
utils ldap config ipaddr
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command migrates configuration data and backs up report files from another host that is running HCS Service Inventory to the local host that is running HCS Service Inventory.
For HCM-F Release 8.6(2) platform, this command upgrades HCS Service Inventory 8.6(1) to HCS Service Inventory 8.6(2). For more information, refer to the Upgrading Components for Cisco Hosted Collaboration Solution for (HCS) 8.6.(2).
Command Syntax
utils migrate serviceinventory [hostname] [username]
Parameters
•hostname represents the hostname or IP address of the server that is running the older software version of Service Inventory.
Note Make sure that the DNS is configured if the hostname is specified.
•username represents a valid user account name on the server that is running the older software version of Service Inventory.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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: No
set host addr
Command privilege level: 1
Allowed during upgrade: No
delete host
Command privilege level: 1
Allowed during upgrade: Yes
Options
•host (optional) specifies host you want to list/set/delete.
•hostname (optional) the hostname of the specified host.
•options (optional) page, numeric
–page pauses output.
–numeric shows hosts as dotted IP addresses.
•addr (mandatory) the hardware address (MAC) of the host.
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 list
Address HWtype HWaddress Flags Mask Iface
sjc21-3f-hsrp.cisco.com ether 00:00:0C:07:AC:71 C eth0
philly.cisco.com ether 00:D0:B7:85:98:8E C eth0
Entries: 2 Skipped: 0 Found: 2
Set Example
admin: utils network arp set myhost 11:22:33:44:55:66
Delete Example
admin: utils network arp delete myhost
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
eth0 specifies Ethernet interface 0.
Options
•page—Displays the output one page at a time
When you use the page or file options, the complete capture of all requested packets must occur before the command completes.
•numeric—Displays hosts as dotted IP addresses
•file fname—Outputs the information to a file
The file option saves the information to platform/cli/fname.cap. The filename cannot contain the "." character.
•count num—Sets a count of the number of packets to capture
For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10000.
•size bytes—Sets the number of bytes of the packet to capture
For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL.
•src addr—Specifies the source address of the packet as a hostname or IPv4 address
•dest addr—Specifies the destination address of the packet as a hostname or IPv4 address
•port num—Specifies the port number of the packet, either source or destination
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command resolves a hostname to an address or an address to a hostname.
Command Syntax
utils network host hostname [server server-name] [page] [detail] [srv]
Parameters
hostname represents the hostname or IP address that you want to resolve.
Options
•server-name—Specifies an alternate domain name server.
•page—Displays the output one screen at a time.
•detail—Displays a detailed listing.
•srv—Displays DNS SRV records.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•ping pings the specified IPv6 address or hostname.
•traceroute trace routes the specified IPv6 address or hostname.
•host looks up the specified IPv6 address or hostname.
•IPv6-address specifies the IPv6 address about which to get information.
•hostname specifies the hostname about which to get information.
•count specifies the number of ICMPv6 messages that will get exchanged. Default specifies 4.
Usage Guidelines
The hostname must resolve to a valid IPv6 address.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command allows you to ping another server.
Command Syntax
utils network ping destination [count] [size]
Parameters
destination represents the hostname or IP address of the server that you want to ping.
Options
•count—Specifies the number of times to ping the external server. The default count equals 4.
•size represents the size of ping packet in bytes. The default size is 56.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command traces IP packets that are sent to a remote destination.
Command Syntax
utils network traceroute destination
Parameters
destination represents the hostname or IP address of the server to which you want to send a trace.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the NTP status or configuration.
Command Syntax
utils ntp {status | config}
Note To avoid potential compatibility, accuracy, and network jitter problems, the external NTP servers that you specify for the primary node should be NTP v4 (version 4). If you are using IPv6 addressing, external NTP servers must be NTP v4.
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command restarts the NTP service.
Command Syntax
utils ntp restart
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
The command adds up to 5 specified NTP servers.
Command Syntax
utils ntp server add s1 [s2 s3 s4 s5] [norestart]
Parameters
•at least one (and up to 5) ntp servers is added.
•norestart results in the NTP service not being restarted after the server gets added.
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 s8
Incorrect number of parameters entered for add
usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]
admin:
Example: Adding using norestart without specifying a server
-----------------------------------------------------------
admin:utils ntp server add norestart
At 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.com
clock1.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.com
clock1.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-ccm26
bglr-ccm26 : [This server cannot be added as an NTP server.]
admin:
Example: Adding inaccessible server without norestart
-----------------------------------------------------
admin:utils ntp server add clock3.cisco.com
clock3.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 norestart
ntp01-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.com
The maximum permissible limit of 5 NTP servers is already configured.
admin:
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
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 servers.
If you choose not to restart the NTP service, an explicit restart of the NTP service is required for the changes to take effect.
Example: Deleting servers with incorrect command line parameters
----------------------------------------------------------------
admin:utils ntp server delete clock1.cisco.com clock2.cisco.com
Incorrect number of optional parameters entered for delete
usage: utils ntp server delete
admin:
Example: Deleting single server with ntp restart
------------------------------------------------
admin:utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit
Choice: 1
Restart NTP (y/n): y
clock1.cisco.com will be deleted from the list of configured NTP servers.
Continue (y/n)?y
clock1.cisco.com : deleted successfully.
Restarting NTP on the server.
admin:
Example: Deleting all servers without ntp restart
-------------------------------------------------
admin:utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit
Choice: a
Restart NTP (y/n): n
This will result in all the configured NTP servers being deleted.
Continue (y/n)?y
clock1.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 delete
There are no NTP servers configured to delete.
admin:
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays a list of the configured NTP servers.
Command Syntax
utils ntp server list
Parameters
None
Example: Listing servers with incorrect command line parameters
---------------------------------------------------------------
admin:utils ntp server list all
Incorrect optional parameter entered for list
usage: utils ntp server list
admin:
Example: Listing servers
------------------------
admin:utils ntp server list
clock1.cisco.com
clock2.cisco.com
ntp01-syd.cisco.com
ntp02-syd.cisco.com
clock.cisco.com
admin:
Example: Listing servers when no servers are configured
-------------------------------------------------------
admin:utils ntp server list
There are no NTP servers configured.
Requirements
Command privilege level: 0
Allowed during upgrade: No
If it is not already running, this command starts the NTP service.
Note You cannot stop the NTP service from the command line interface. Use this command when the utils ntp status command returns stopped.
Command Syntax
utils ntp start
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: No
This command displays the current status of NTP.
Command Syntax
utils ntp status
Parameters
None
Example
admin:utils ntp status
ntpd (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.638
synchronised to NTP server (10.81.254.131) at stratum 2
time correct to within 37 ms
polling server every 1024 s
Current time in UTC is : Thu Feb 12 22:33:43 UTC 2009
Current time in America/Los_Angeles is : Thu Feb 12 14:33:43 PST 2009
The 'remote' column lists the remote NTP servers. The local hardware clock is
configured 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 synchronization
Any 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 jitter
The 'refid' column indicates the remote's time source. "LOCAL(0)" applies to
the local hardware clock. ".INIT." means initialization has not yet succeeded.
The 'st' column is the stratum of the remote NTP server. 16 is a invalid
stratum 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' means
the remote is being polled every 64 seconds. The shortest interval NTP uses
is every 64 seconds and the longest is 1024 seconds. The better a NTP source
is rated over time, the longer the interval.
The 'reach' column indicates the trend of reachability tests in octal, where
each digit, when converted to binary represents whether a particular poll was
successful (binary 1) or unsuccessful (binary 0). E.G., '1' means only one
poll has been done thus far and it was successful. '3' (= binary 11) means the
last 2 polls were successful. '7' (= binary 111) means the last 3 polls were
successful. '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 to
that was unsuccessful, and the poll prior to that was successful.
When a poll is done for the active NTP server selected for synchronization is
done, a time correction using that NTP server's time is also done.
The delay, offset and jitter are the round-trip delay, dispersion, and jitter
in seconds.
"At stratum #" shown below the table shows the stratum of this host's NTP
server, which will be one higher than that of the currently active NTP server
being used for synchronization.
Requirements
Command privilege level: 0
Allowed during upgrade: No
The command adds a maximum of 5 specified NTP servers.
Command Syntax
utils ntp server add s1 [s1 | s2 | s3 | s4 | s5] [norestart]
Parameters
norestart causes the NTP service to not restart after adding the servers.
Usage Guidelines
If norestart gets used, an explicit restart of the NTP service is required for the changes to take effect.
Example: Attempting to add servers with incorrect command line parameters
--------------------------------------------------------------
admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8
Incorrect number of parameters entered for add
usage: 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 norestart
At 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.com
clock1.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.com
clock1.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-ccm26
bglr-ccm26 : [This server cannot be added as an NTP server.]
admin:
Example: Adding inaccessible server without norestart
-----------------------------------------------------
admin:utils ntp server add clock3.cisco.com
clock3.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 norestart
ntp01-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.com
The maximum permissible limit of 5 NTP servers is already configured.
admin:
Requirements
Command privilege level: 0
Allowed during upgrade: No
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.
Example: Deleting servers with incorrect command line parameters
----------------------------------------------------------------
admin:utils ntp server delete clock1.cisco.com clock2.cisco.com
Incorrect number of optional parameters entered for delete
usage: utils ntp server delete
admin:
Example: Deleting single server with ntp restart
------------------------------------------------
admin:utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit
Choice: 1
Restart NTP (y/n): y
clock1.cisco.com will be deleted from the list of configured NTP servers.
Continue (y/n)?y
clock1.cisco.com : deleted successfully.
Restarting NTP on the server.
admin:
Example: Deleting all servers without ntp restart
-------------------------------------------------
admin:utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit
Choice: a
Restart NTP (y/n): n
This will result in all the configured NTP servers being deleted.
Continue (y/n)?y
clock1.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 delete
There are no NTP servers configured to delete.
admin:
Requirements
Command privilege level: 0
Allowed during upgrade: No
The command displays a list of the configured ntp servers.
Command Syntax
utils ntp server list
Parameters
None
Example: Listing servers with incorrect command line parameters
---------------------------------------------------------------
admin:utils ntp server list all
Incorrect optional parameter entered for list
usage: utils ntp server list
admin:
Example: Listing servers
------------------------
admin:utils ntp server list
clock1.cisco.com
clock2.cisco.com
ntp01-syd.cisco.com
ntp02-syd.cisco.com
clock.cisco.com
admin:
Example: Listing servers when no servers are configured
-------------------------------------------------------
admin:utils ntp server list
There are no NTP servers configured.
admin:
Requirements
Command privilege level: 0
Allowed during upgrade: No
Note The netdump commands have been removed from Release 8.6(1) and have been replaced with the kerneldump commands.
This command configures kerneldump to provide a kernel crash dumping mechanism. The kernel captures the dump to the local disk, in case of a kernel crash.
Note The MCS-7835-H2 and MCS-7845-H2 models do not support this command.
Command Syntax
utils os kerneldump enable
Parameters
None
Usage Guidelines
If a kernel crash occurs, the capture kernel dumps the core on the local disk of the server. The primary kernel reserves 128 MB of physical memory that the capture kernel uses to boot. The kerneldump uses kexec command to boot into a capture kernel whenever the kernel crashes.
This command reboots the system for the changes to come into effect.
Example
admin:utils os kerneldump enable
***************WARNING******************
Enabling kerneldump requires system reboot
Would you like to reboot the machine(y/n):y
kerneldump enable operation succeeded
System going for a reboot
Retrieving core files
The core files are dumped to /var/log/install/crash location. You can collect these files by using the file get install command.
Example
admin: file get install crash/127.0.0.1-2011-03-15-13:59:02/vmcore
where
–127.0.0.1-2011-03-15-13:59:02 is the crash directory indicating the time of kernel crash
–vmcore is the dump file that contains the system information during kernel crash.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command disables the kerneldump service; dumps are not captured after this.
Note The MCS-7835-H2 and MCS-7845-H2 models do not support this command.
Command Syntax
utils os kerneldump disable
Parameters
None
Usage Guidelines
This command frees the memory reserved for the crash kernel and the dumps are not collected in case of a kernel panic. This command reboots the system for the changes to come into effect.
Example
admin:utils os kerneldump disable
***************WARNING******************
Disabling kerneldump requires system reboot
Would you like to continue(y/n):y
kerneldump disable operation succeeded
System going for a reboot
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command states whether the kerneldump service is enabled or disabled.
Note The MCS-7835-H2 and MCS-7845-H2 models do not support this command.
Command Syntax
utils os kerneldump status
Parameters
None
Usage Guidelines
User can query the status of the kerneldump service.
Example
admin: utils os kerneldump status
kerneldump is enabled
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command configures an external SSH server as a kerneldump server to collect kernel dumps.
Command Syntax
utils os kerneldump ssh enable
Parameters
ip_address
Usage Guidelines
If a kernel crash occurs, the capture kernel dumps the core on the external server that is configured to collect the dump. This command reboots the system for the changes to come into effect.
Example
admin:utils os kerneldump ssh enable 10.77.31.60
****************WARNING*****************
Enabling kerneldump requires system reboot
Would you like to reboot the machine(y/n): y
Enter server username:
root
Enter server password:
Do you wish to change dump location ?(y/n):y
Enter new dump location: /root/abc
Your core will be dumped to /root/abc on 10.77.31.60
kerneldump enable operation succeeded
System going for a reboot
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command removes support of the external SSH server that is configured to collect kernel dumps.
Command Syntax
utils os kerneldump ssh disable
Parameters
ip_address
Usage Guidelines
If a kernel panic occurs, the capture kernel does not dump the core to external server. This command reboots the system for the changes to come into effect.
Example
admin:utils os kerneldump ssh disable 10.77.31.60
***************WARNING******************
Disabling kerneldump requires system reboot
Would you like to continue(y/n):y
kerneldump disable operation succeeded
System going for a reboot
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command states whether an external SSH server is configured or not, to collect kernel dumps.
Command Syntax
utils os kerneldump ssh status
Parameters
None
Usage Guidelines
User can query the status of the kerneldump service for external SSH server. If an external server is configured to collect dumps, the output of the command is enabled; if not, the output is disabled.
Example
admin:utils os kerneldump ssh status
Dumping to external server is disabled
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command monitors and controls SELinux.
Command Syntax
utils os secure [status | enforce | permissive]
Parameters
•status displays to the CLI user the SELinux status. Tells whether SELinux is disabled or enabled. If enabled, it also returns the SELinux mode (enforcing or permissive).
•enforce allows the CLI user to change the SELinux mode from permissive to enforcing. Rules are enforced only in enforcing mode.
•permissive allows the CLI user to change the SELinux mode from enforcing to permissive. Rules are not enforced but the denials are logged.
Usage Guidelines
If SELinux is enabled, you do not have to reboot when you use utils os secure enforce or utils os secure
If SELinux is disabled, you can use utils os secure enforce or utils os secure permissive to enable it. If you do this, however, you must reboot before SELinux becomes enabled.
Requirements
Command privilege level: 1
Allowed during upgrade: No
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
•username specifies the name of the remote account. The username can contain only lowercase characters and must be more than six characters long.
•life specifies the life of the account in days. After the specified number of days, the account expires.
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.
Example
utils remote_account status
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command activates, deactivates, stops, starts, or restarts a service.
Command Syntax
utils service
activate service-name
deactivate service-name
start service-name
stop service-name
restart service-name
Parameters
•activate activates a service. The service name may consist of multiple words.
•deactivate deactivates a service. The service name may consist of multiple words.
•list retrieves all services status.
•start starts a service. The service name may consist of multiple words.
•stop stops a service. The service name may consist of multiple words.
•restart restarts a service. The service name may consist of multiple words.
•service-name represents the name of the service that you want to activate, deactivate, stop or start. See the "Services on the Cisco HCM-F Platform" section for a list of services.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command retrieves a list of all services and their status.
Command Syntax
utils service list [page]
Options
page—Displays the output one page at a time
Requirements
Command privilege level: 0
Allowed during upgrade: No
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
•get gets the SNMP data using the specified version 1 or version 2c, for the specified MIB OID.
•hardware-agents status displays the status of the hardware agents on the server.
•hardware-agents stop stops all SNMP agents provided by the hardware vendor.
•hardware-agents restart restarts the hardware agents on the server.
•hardware-agents start starts all of the SNMP agents provided by the vendor of the hardware.
•test tests the SNMP host by sending sample alarms to local syslog, remote syslog, and SNMP trap.
•walk walks the SNMP MIB using the specified version(1 or 2c), starting with the specified MIB OID.
•version specifies the SNMP version. Possible values are 1 or 2c.
•community specifies the SNMP community string.
•ip-address specifies the IP address of the server. Enter 127.0.0.0 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node.
•object specifies the SNMP Object ID (OID) to get.
•file specifies a file in which to save the command output.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the 1/2c community string.
Command Syntax
utils snmp config 1/2c community-string[ add | delete | list | update ]
Parameters
•add adds a new community string.
•delete deletes the configuration information for an existing 1/2c community string.
•list lists 1/2c community string that are currently configured.
•update updates the configuration information for an existing 1/2c community string
Note The system prompts you for parameters.
Usage guidelines
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of "SNMP Master Agent" by using utils service list. If service is down, start it by using utils service start SNMP Master Agent.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the 1/2c community string inform.
Command Syntax
utils snmp config 1/2c inform [add | delete | list | update]
Parameters
•add adds a new v2 inform notification destination that is associated with a configured 1/2c community string.
•delete deletes the configuration information for an existing v2 inform notification destination.
•list lists the v2 inform notifications that are currently configured.
•update updates the configuration information for an existing v2 inform notification destination.
Note The system prompts you for parameters.
Usage guidelines
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of "SNMP Master Agent" by using utils service list. If service is down, start it by using utils service start SNMP Master Agent.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the v3 trap.
Command Syntax
utils snmp config 1/2c 3 trap[add | delete | list | update]
Parameters
•add adds a new v2 trap notification destination that is associated with a configured 1/2c community string.
•delete deletes the configuration information for an existing v2 trap notification destination.
•list lists the v2 trap notifications that are currently configured.
•update updates configuration information for an existing v2 trap notification destination.
Note The system prompts you for parameters.
Usage guidelines
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of "SNMP Master Agent" by using utils service list. If service is down, start it by using utils service start SNMP Master Agent.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the v3 inform notification.
Command Syntax
utils snmp config 3 inform[add | delete | list | update]
Parameters
•add adds a new v3 inform notification destination that is associated with a configured v3 username.
•delete deletes the configuration information for an existing v3 inform notification destination.
•list lists the v3 inform notifications that are currently configured.
•update updates configuration information for an existing v3 inform notification destination.
Note The system prompts you for parameters.
Usage guidelines
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of "SNMP Master Agent" by using utils service list. If service is down, start it by using utils service start SNMP Master Agent.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the v3 trap.
Command Syntax
utils snmp config 3 trap[add | delete | list | update]
Parameters
•add adds a new v3 trap notification destination that is associated with a configured v3 username.
•delete deletes the configuration information for an existing v3 trap notification destination.
•list lists the v3 trap notifications that are currently configured.
•update updates configuration information for an existing v3 trap notification destination.
Note The system prompts you for parameters.
Usage guidelines
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of "SNMP Master Agent" by using utils service list. If service is down, start it by using utils service start SNMP Master Agent.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This interactive command affects the v3 user.
Command Syntax
utils snmp config 3 user[add | delete | list | update]
Parameters
•add adds a new v3 user with the v3 authentication and privacy passwords.
•delete deletes the configuration information for an existing v3 user.
•list lists the v3 users that are currently configured.
•update updates the configuration information for an existing v3 user.
Note The system prompts you for parameters.
Usage guidelines
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of "SNMP Master Agent" by using utils service list. If service is down, start it by using utils service start SNMP Master Agent.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This command adds mib2 configuration information (for example, system contact and system location).
Command Syntax
utils snmp config mib2 add SysContact SysLocation
Parameter
•SysContact is mandatory and represents the mib2 system contact information.
•SysLocation is mandatory and represents the mib2 system location information.
Example
utils snmp config mib2 add cisco india
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
This command deletes the mib2 configuration information (for example, system contact and system location).
utils snmp config mib2 delete
None
utils snmp config mib2 delete cisco india
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This command lists the mib2 configuration information (for example, system contact and system location).
Command Syntax
utils snmp config mib2 list
Parameter
None
Example
utils snmp config mib2 list cisco india
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This command updates the mib2 configuration information (for example, system contact and system location).
Command Syntax
utils snmp config mib2 update SysContact SysLocation
Parameters
SysContact is mandatory and represents the mib2 system contact information.
•SysLocation is mandatory and represents the mib2 system location information.
Example
utils snmp config mib2 update cisco india
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
This interactive command gets the SNMP data using the specified version for the specified MIB OID.
Command Syntax
utils snmp get version
Note The system prompts you for parameters.
Parameters
•version (mandatory) specifies the SNMP version. Possible values include 1, 2c, or 3.
•community specifies the SNMP community string.
•ip-address specifies the IP address of the server. Enter 127.0.0.0 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node.
•object specifies the SNMP Object ID (OID) to get.
•file specifies a file in which to save the command output.
Usage guidelines
If you run the command on a specific OID (leaf) in the MIB you would get the value of the MIB. For example to get the system uptime:
iso.3.6.1.2.1.25.1.1.0 = Timeticks: (19836825) 2 days, 7:06:08.25
If you provide the IP address of a remote host, the command gets executed on the remote host.
Be aware that the IP address is required. You cannot use a domain name.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command affects the SNMP agents on the server.
Command Syntax
utils snmp hardware-agents [status | start | stop | restart]
Parameters
status displays the status of the SNMP agents provided by the vendor of the hardware.
Note Only agents that provide status get displayed by this command. Not all hardware agents provide status.
•stop stops all SNMP agents provided by the hardware vendor.
•restart restarts all of the SNMP agents provided by the vendor of the hardware.
•start starts all of the SNMP agents provided by the vendor of the hardware.
Requirements
Command privilege level: 1
Allowed during upgrade: No
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
This command is used to walk the SNMP MIB starting with the specified OID.
Command Syntax
utils snmp walk version
Note system prompts you for the parameters.
Parameters
•version (mandatory) specifies the SNMP version. Possible values include 1, 2c, or 3.
•community specifies the SNMP community string.
•ip-address specifies the IP address of the server. Enter 127.0.0.0 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node.
•object specifies the SNMP Object ID (OID) to walk.
Usage Guidelines
•If you run snmp walk on a leaf in the MIB, output is same as that of the utils snmp get command.
•To execute this command on a remote host, provide the IP address of a remote host. Ensure that you provide the IP address of the remote host and not the domain name.
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 CPU
3.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.583
iso.3.6.1.2.1.1.3.0 = Timeticks: (15878339) 1 day, 20:06:23.39
iso.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: 72
iso.3.6.1.2.1.2.1.0 = INTEGER: 3
iso.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1
iso.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2
iso.3.6.1.2.1.2.2.1.1.3 = INTEGER: 3
iso.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: 24
iso.3.6.1.2.1.2.2.1.3.2 = INTEGER: 6
iso.3.6.1.2.1.2.2.1.3.3 = INTEGER: 6
iso.3.6.1.2.1.2.2.1.4.1 = INTEGER: 16436
iso.3.6.1.2.1.2.2.1.4.2 = INTEGER: 1500
iso.3.6.1.2.1.2.2.1.4.3 = INTEGER: 1500
iso.3.6.1.2.1.2.2.1.5.1 = Gauge32: 0
iso.3.6.1.2.1.2.2.1.5.2 = Gauge32: 100000000
iso.3.6.1.2.1.2.2.1.5.3 = Gauge32: 10000000
iso.3.6.1.2.1.2.2.1.6.1 = Hex-STRING: 00 00 00 00 00 00
iso.3.6.1.2.1.2.2.1.6.2 = Hex-STRING: 00 16 35 5C 61 D0
iso.3.6.1.2.1.2.2.1.6.3 = Hex-STRING: 00 16 35 5C 61 CF
iso.3.6.1.2.1.2.2.1.7.1 = INTEGER: 1
Requirements
Command privilege level: 1
Allowed during upgrade: No
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: Yes
This commands redirects where the system boot output gets sent.
Command Syntax
utils system boot {console | serial | status}
Parameters
•console redirects the system boot output to the console.
•serial redirects the system boot output to the COM1 (serial port 1).
•status displays the where the serial boot output will currently get sent.
Requirements
Command privilege level: 1
Allowed during upgrade: No
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
•cancel cancels the active upgrade.
•initiate starts a new upgrade wizard or assumes control of an existing upgrade wizard. The wizard prompts you for the location of the upgrade file.
•status displays the status of an upgrade.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command shows the version of VMware Tools that is currently running.
Command Syntax
utils vmtools status
Parameters
No optional parameters.
Requirements
Command privilege level: 1
Allowed during upgrade: No
This command updates the currently installed VMware Tools to the latest version prescribed by the ESXi host for that VM.
Command Syntax
utils vmtools upgrade
Parameters
No optional parameters.
Requirements
Command privilege level: 1
Allowed during upgrade: No