You can access the PAWS-M 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 also access the Cisco PAWS-M CLI from the virtual console of the virtual machine it is installed on. Use this method if a problem exists with the IP address.
Perform the following steps to start a CLI session:
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.
Procedure
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:
CLI basics
The following sections contains basic tips for using the command line interface.
Enter the start of a command and press Tab to complete the command. For example, if you enter set and press Tab, set is 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 asterix (*) 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.
Obtain Help for commands
You can obtain two types 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
To get detailed help, at the CLI prompt, enter
helpcommand
Where command specifies the command name or the command and parameter. See the example below.
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.
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
To query only command syntax, at the CLI prompt, enter
command?
Where command represents the command name or the command and parameter. See the example below.
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.
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]
End CLI sessions
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 PAWS-M.
CLI command properties
Command Privilege Level
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.
Allowed during Upgrade
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.
This command allows you to delete an administrator account.
delete accountaccount-name
Syntax Description
Parameters
Description
account-name
Specifies the name of an administrator account.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 4
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
delete dns
This command allows you to delete the IP address for a DNS server.
delete dnsaddr
Syntax Description
Parameters
Description
addr
Represents the IP address of the DNS server that you want to delete.
Command Modes
Administrator (admin:)
Usage Guidelines
After you execute this command, the system asks whether you want to continue.
Caution
If you continue, this command causes a temporary loss of network connectivity.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
delete dscp
This command deletes a DSCP port tag.
delete dscpport-tag
Syntax Description
Parameters
Description
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 displayed when you use the command show dscp defaults. The set of port tags is predefined.
Command Modes
Administrator (admin:)
Usage Guidelines
After you delete an enabled port tag, DSCP marking on that port tag stops. You can recreate a deleted port tag when you use the set dscp marking command; enter the name of the port tag that you previously deleted.
Tip
Use the command show dscp defaults to list the configured port tags.
Requirements
Applies to: Unified CM, Cisco Unity Connection
delete ipsec policy_group
This command deletes all policies within the specified group or all groups.
delete ipsec policy_group
{ group |
| all }
Syntax Description
Parameters
Description
group
Represents a specific group name.
all
Deletes all groups.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, Cisco Unity Connection
delete ipsec policy_name
This command deletes an Ipsec policy with given policy name.
delete ipsec policy_name
{ policy_name | all }
Syntax Description
Parameters
Description
policy_name
Represents the policy name.
all
Deletes policies within all policy names.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, Cisco Unity Connection
delete process
This command allows you to delete a particular process.
delete processprocess-id
[ force | terminate | crash ]
Syntax Description
Parameters
Description
process-id
Represents the process ID number.
force
Causes the process to stop.
terminate
Causes the operating system to terminate the process.
crash
Crashes the process and produces a crash dump.
Command Modes
Administrator (admin:)
Usage Guidelines
Use the force option only if the command alone does not delete the process; use the terminate option only if force does not delete the process.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
delete smtp
This command allows you to delete the SMTP host.
delete smtp
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
File commands
file check
This command checks the /usr directory tree to see whether files or directories have been added, removed, or changed in size since the last fresh installation or upgrade and shows the results.
file check [detection-size-kb]
Syntax Description
Parameters
Description
detection-size-kb
Specifies the minimum file size change that is required for the command to display the file as changed.
Default value: 100 KB.
Command Modes
Administrator (admin:)
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.
Caution
Because this command can affect system performance, Cisco recommends that you run the command during off-peak hours.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
The relative time period, specified in minutes | hours | days | weeks | months | time value
abstime
The absolute time period, specified as hh:mm:MM/DD/YYhh:mm:MM/DD/YY
ignorecase
Ignores case in a search.
Command Modes
Administrator (admin:)
Usage Guidelines
Write the search term in the form of a regular expression, which
is a special text string to describe a search pattern.
If the search term is found in only one file, the filename
appears at the top of the output. If the search term is found in
multiple files, each line of the output begins with the filename in
which the matching line was found.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
file tail*
file tail activelog
This command tails (prints the last few lines) of a log file.
This command shows the contents of the Integrated Management Logs (IML).
file view system-management-log
Command Modes
Administrator (admin:)
Usage Guidelines
Caution
Do not use this command to view binary files because this can corrupt the terminal session.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, Cisco Unity Connection
Set commands
set account*
set account enable
This command enables the OS user account that was disabled because of password inactivity.
set account enableuser-id
Syntax Description
Parameters
Description
user-id
Specifies the user ID of the account that was disabled.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
set account name
This command sets up a new account on the operating system.
set account namename
Syntax Description
Parameters
Description
name
Represents the username for the new account.
Command Modes
Administrator (admin:)
Usage Guidelines
After you enter the username, the system prompts you to enter the privilege level and password for the new account.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
set accountlocking*
set accountlocking
This command enables or disables account locking for the current administration accounts.
set accountlocking
{ enable | disable }
Syntax Description
Parameters
Description
enable
Enable account locking.
disable
Disable account locking.
Command Modes
Administrator (admin:)
Usage Guidelines
Note
After you run this command with enable, the system automatically enables account lockout notification after the system enables the audit logging function.
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
set accountlocking count
This command sets the global consecutive failed sign-in attempt count that triggers locking a user account.
set accountlocking countattempts
Syntax Description
Parameters
Description
attempts
Represents the number of consecutive sign-in attempts before the system locks the account.
Value Range: 2-5
Default value: 3
Command Modes
Administrator (admin:)
Usage Guidelines
To change the global value for consecutive failed sign-in attempts before the system locks a user account, execute this command.
Note
This command is only valid 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.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
set accountlocking unlocktime
This command configures the unlock time for the current Unified CM admin accounts
set accountlocking unlocktimeseconds
Syntax Description
Parameters
Description
seconds
Specifies the unlock time in seconds.
Valid values: greater than 300 seconds, but less than 3600 seconds (60 minutes).
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
set cli*
set cli pagination
For the current CLI session, this command turns automatic pagination On or Off.
set cli pagination
{ on | off }
Syntax Description
Parameters
Description
on
Turns pagination on.
off
Turns pagination off.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
admin:set cli pagination off
Automatic pagination is turned off
set cli session timeout
This command sets the time, in minutes, after which an active CLI session times out and disconnects.
set cli session timeoutminutes
Syntax Description
Parameters
Description
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
Command Modes
Administrator (admin:)
Usage Guidelines
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.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set commandcount
This command changes the CLI command prompt, so it displays how many CLI commands have executed.
set commandcount
{ enable | disable }
Syntax Description
Parameters
Description
enable
Turns on command count.
disable
Turns off command count.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set csr gen
This command regenerates the certificate for the specified unit.
set csr genname
Syntax Description
Parameters
Description
name
Specifies the unit on which the certificate is generated.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:set csr gen tomcat
Successfully regenerated certificate for tomcat.
Please restart services related to tomcat for the new certificate to become active.
set date
This command changes the time and date on the server.
set dateHH:mm:ss:MM/DD/YY
Syntax Description
Parameters
Description
HH:mm:ss
Represents the time format (24 hours format).
MM/DD/YY
Represents the date format.
Note
Date format MM/DD/YYYY is also accepted.
Command Modes
Administrator (admin:)
Usage Guidelines
If the server is configured to synchronize with external NTP servers, this command requires the user to remove all of those NTP servers.
Requirements
Applies to: Unified CM and Cisco Unity Connection.
Set date and time to 2:10:33 pm April 13th 2012 example
admin:set date 14:10:33:04/13/12
set dscp*
set dscp defaults
This command sets the factory default DSCP settings for all of the port tags.
set dscp defaults
Command Modes
Administrator (admin:)
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: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set dscp
This command enables or disables DSCP marking on outgoing TCP or UDP packets. You can enable or disable DSCP on a single port tag, or on all port tags at once.
set dscp
{ enable | disable } { all | port_tag }
Syntax Description
Parameters
Description
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 displayed when you use the command show dscp defaults. The set of port tags is predefined.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set dscp marking
This command sets DSCP markings on port tags by using well-known DSCP classes and numeric values.
set dscp markingport_tag value
Syntax Description
Parameters
Description
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 displayed when you use the command show dscp defaults. The set of port tags is predefined.
value
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.
Command Modes
Administrator (admin:)
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: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set ipsec*
set ipsec policy_group
This command enables ipsec policies with the specified policy group name.
set ipsec policy_group
{ ALL | group }
Syntax Description
Parameters
Description
ALL
Enables all ipsec policy groups.
group
Specifies the name of a particular ipsec policy group to enable.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection.
set ipsec policy_name
This command enables the specified ipsec policy.
set ipsec policy_name
{ ALL | policy_name }
Syntax Description
Parameters
Description
ALL
Enables all ipsec policies.
policy_name
Specifies the name of a particular ipsec policy to enable.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection.
set logging
This command allows you to enable or disable CLI Admin logs.
set logging
{ enable | disable }
Syntax Description
Parameters
Description
enable
Turns on logging.
disable
Turns off logging.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network*
set network cluster publisher
This command sets the network cluster publisher hostname and IP address.
set network cluster publisher
{ hostname | ip }
name
Syntax Description
Parameters
Description
hostname
Specifies the hostname of the network cluster.
ip
Specifies the ip address of the network cluster.
name
Hostname or IP address to assign to the network cluster publisher.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network dhcp eth0
This command enables or disables DHCP for Ethernet interface 0. You cannot configure Ethernet interface 1.
If you continue, this command causes the system to restart. Cisco also recommends that you restart all nodes whenever any IP address gets changed.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network dns
This command sets the IP address for the primary or secondary DNS server.
set network dns
{ primary | secondary }
addr
Syntax Description
Parameters
Description
primary
secondary
addr
Represents the IP address of the primary or secondary DNS server.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network dns options
This command sets DNS options.
set network dns options
[ timeout | seconds ]
[ attempts | number ]
[ rotate ]
Syntax Description
Parameters
Description
timeout
Sets the DNS timeout.
attempts
Sets the number of times to attempt a DNS request.
rotate
Causes the system to rotate among the configured DNS servers and distribute the load.
seconds
Specifies the DNS timeout period in seconds.
number
Specifies the number of attempts.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network domain
This command sets the domain name for the system.
Note
Changing the domain name triggers an automatic regeneration of all Cisco Unified Communications Manager certificates, including any third party signed certificates that have been uploaded. After the server reboots automatically, phones running in secure (mixed) mode cannot connect to the server until after the CTL client updates the new CTL file to the phones.
set network domain [domain-name]
Syntax Description
Parameters
Description
domain_name
Represents the system domain that you want to assign.
Command Modes
Administrator (admin:)
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
If you continue, this command causes a temporary loss of network connectivity.
If you use the set network domaindomain-name command to change the domain name, you must manually regenerate all of your security certificates in Cisco Unified Operating System Administration. The list of certificates depends on your software release but may include cup.pem, cup-xmpp.pem, cup-xmpp-s2s.pem, tomcat, ipsec and so on. Note that you must restart the tomcat service after the tomcat cert is regenerated and you can only restart this service using the CLI. For more information about regenerating security certificates, see the Cisco Unified Communications Operating System Administration Guide (on Cisco.com).
After you regenerate your security certificates, you must reboot all the servers in the cluster. This will ensure that database replication keeps working correctly. After the servers have rebooted, confirm that there are no issues reported on the Cisco Unified Reporting report for Database Replication. After you reboot the server, we recommend that you manually delete old certificates that have become disassociated by the domain name change. For every ICSA peer that exists on the local node, you must either update the ICSA entry for the peer node with the new FQDN hostname, or delete that entry and add a new ICSA peer entry with the new FQDN hostname.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network failover
This command enables and disables Network Fault Tolerance on the Media Convergence Server network interface card.
set network failover
{ ena | dis }
Syntax Description
Parameters
Description
ena
Enables Network Fault Tolerance.
dis
Disables Network Fault Tolerance.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network gateway
This command enables you to configure the IP address of the network gateway.
set network gatewayaddr
Syntax Description
Parameters
Description
addr
Represents the IP address of the network gateway that you want to assign.
Command Modes
Administrator (admin:)
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
If you continue, this command causes the system to restart.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network hostname
This commands sets the network host name and then causes a restart of the system.
set network hostnamehostname
Syntax Description
Parameters
Description
hostname
Represents the new network hostname of the system.
Note
The host name must follow the rules for ARPANET host names. It must start with an alphabetic character, end with an alphanumeric character, and consist of alphanumeric characters and hyphens. The host name can have a maximum length of 63 characters.
The system asks whether you want to continue to execute this command.
Caution
If you continue, this command causes the system to restart.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
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 21 13:00:21 2012):
The system is going down for restart NOW!
set network ip eth0
This command sets the IP address for Ethernet interface 0. You cannot configure Ethernet interface 1.
set network ip eth0addrmaskgw
Syntax Description
Parameters
Description
eth0
Specifies Ethernet interface 0.
addr
Represents the IP address that you want to assign.
mask
Represents the IP mask that you want to assign.
gw
Represents the IP default gw that you want to assign.
Command Modes
Administrator (admin:)
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
If you continue, this command causes the system to restart.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network ipv6 dhcp
This command sets the DHCPv6 client on the server and enables IPv6 support. For changes to take effect, you must restart the server.
set network ipv6 dhcp
{ enable | disable }
[reboot]
Syntax Description
Parameters
Description
dhcp
Sets 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.
enable
Enables IPv6 support.
disable
Disables IPv6 support.
reboot
(Optional) Causes the server to automatically restart after you enter the command.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
set network ipv6 gateway
This command sets the IPv6 gateway for the server. For changes to take effect, you must restart the server.
set network ipv6 gatewayaddr [reboot]
Syntax Description
Parameters
Description
gateway
Sets the IPv6 gateway for the server. By default, the server does not restart after you set the IPv6 gateway for the server. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.
addr
The IPv6 gateway address.
reboot
(Optional) Causes the server to automatically restart after you enter the command.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
set network ipv6 service
This command enables or disables the IPv6 service on the server. For changes to take effect, you must restart the server.
set network ipv6 service
{ enable | disable }
[reboot]
Syntax Description
Parameters
Description
service
Sets the IPv6 service on the server. By default, the server does not restart after you enable or disable the IPv6 service on the server. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.
enable
Enables IPv6 service on the server.
disable
Disables IPv6 service on the server.
reboot
(Optional) Causes the server to automatically restart after you enter the command.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
set network ipv6 static_address
This command assigns the static IPv6 address to the server. For changes to take effect, you must restart the server.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
set network ipv6 static_addressaddrmask [reboot]
Syntax Description
Parameters
Description
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.
addr
Specifies the static IPv6 address you assign to the server.
mask
Specifies the IPv6 network mask (0-128).
reboot
(Optional) Causes the server to automatically restart after you enter the command.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection.
set network max_ip_conntrack
This command sets the ip_conntrack_max value.
set network max_ip_conntrackip_conntrack_max value
Syntax Description
Parameters
Description
ip_conntrack_max value
Specifies the value for ip_conntrack_max.
Note
The value of ip_conntrack_max cannot be less than 65536.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:set network max_ip_conntrack 65536
set network mtu
This command sets the maximum MTU value.
set network mtumtu_max
Syntax Description
Parameters
Description
mtu_max
Specifies the maximum MTU value. The system default MTU value equals 1500.
Command Modes
Administrator (admin:)
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
If you continue, the system loses network connectivity temporarily.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
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...
set network nic eth0
This command sets the properties of the Ethernet Interface 0. You cannot configure Ethernet interface 1.
set network nic eth0
{ auto | { en | dis } }
{ speed | { 10 | 100 } }
{ duplex half | { half | full } }
Syntax Description
Parameters
Description
eth0
Specifies Ethernet interface 0.
auto
Specifies whether auto negotiation gets enabled or disabled.
speed
Specifies whether the speed of the Ethernet connection: 10 or 100 Mb/s.
duplex
Specifies half-duplex or full-duplex.
Command Modes
Administrator (admin:)
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.
Caution
If you continue, this command causes a temporary loss of network connections while the NIC gets reset.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set network pmtud
This command enables and disables Path MTU Discovery.
set network pmtud
{ enable | disable }
Syntax Description
Parameters
Description
enable
Enables Path MTU Discovery.
disable
Disables Path MTU Discovery.
Command Modes
Administrator (admin:)
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
If you continue, the system loses network connectivity temporarily.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
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...
set network restore
This command configures the specified Ethernet port to use a specified static IP address.
set network restore eth0ip-addressnetwork-maskgateway
Syntax Description
Parameters
Description
eth0
Specifies Ethernet interface 0.
ip-address
Represents the IP address of the primary or secondary DNS server, or the network gateway that you want to assign. If you continue, this command causes a temporary loss of network connectivity. 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. We also recommend that you restart all nodes whenever any IP address gets changed.
network-mask
Represents the subnet mask for the server.
gateway
Specifies the IP address of the default gateway.
ip-address
Represents the IP address of the primary or secondary DNS server, or the network gateway that you want to assign. If you continue, this command causes a temporary loss of network connectivity. 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. We also recommend that you restart all nodes whenever any IP address gets changed.
ip-address
Represents the IP address of the primary or secondary DNS server, or the network gateway that you want to assign. If you continue, this command causes a temporary loss of network connectivity. 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. We also recommend that you restart all nodes whenever any IP address gets changed.
Command Modes
Administrator (admin:)
Usage Guidelines
Caution
Only use this command option if you cannot restore network connectivity through any other set network commands. This command deletes all previous network settings for the specified network interface, including Network Fault Tolerance. After you run this command, you must restore your previous network configuration manually.
Caution
The server temporarily loses network connectivity after you run this command.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
This command sets the status of Ethernet 0 to up or down. You cannot configure Ethernet interface 1.
set network status eth0
{ up | down }
Syntax Description
Parameters
Description
eth0
Specifies Ethernet interface 0.
up
Sets the status of Ethernet interface 0 to up.
down
Sets the status of Ethernet interface 0 to down.
Command Modes
Administrator (admin:)
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
If you continue, the system loses network connectivity temporarily.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password*
set password age
This command modifies the value for password age, in days, for Cisco Unified Communications Operating System accounts.
set password age
{ maximum | minimum }
days
Syntax Description
Parameters
Description
maximum
Specifies the maximum age.
minimum
Specifies the minimum age.
days
Specifies the maximum password age and must be greater-than or equal-to 90 days.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password change-at-login
Use this command to force new or existing users to change their password when they sign in to the system the next time.
set password change-at-login
{ disable | enable }
userid
Syntax Description
Parameters
Description
disable
This does not force users to change their password.
enable
This forces users to change their password when they sign in to the system the next time.
userid
Specifies the affected user account.
Command Modes
Administrator (admin:)
Usage Guidelines
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.
Requirements
Command privilege level: 4
Allowed during upgrade: No
Applies to: IM and Presence service on Unified CM only.
set password complexity character
Use this command to enable or disable password complexity rules for the type of characters in a password.
Note
After you enable password complexity, this command also enables password history if it has not already been enabled (for more information, see the set password history command). If you had not previously enabled password history, the password history number parameter value gets set to 10. If you previously enabled password history with a value of less than 10, the value gets reset to 10 after you execute this command. If you previously enabled password history with a value of 10 or greater, the value remains unchanged after you execute this command.
set password complexity character
{ disable | enable }
num-char
Syntax Description
Parameters
Description
disable
This turns off password complexity for character types.
enable
This turns on password complexity for character types.
Note
When you disable password complexity, you also turn off password character difference, password character max-repeat, and password history.
num-char
This specifies the number of characters required from each of the four character sets: lowercase, uppercase, numbers, and special characters.
Value range: 0-8
Default value: 1
Command Modes
Administrator (admin:)
Usage Guidelines
When you enable password complexity, you must follow these guidelines when you assign a password:
It must have at least the current setting, num-chars, of lower-case character.
It must have at least the current setting, num-chars, of uppercase characters.
It must have at least the current setting, num-chars, of digit characters.
It must have at least the current setting, num-chars, of special characters.
You cannot use adjacent characters on the keyboard; for example, qwerty.
You cannot reuse any of the previous passwords that match the passwords retained by password history.
By default, the admin user password can be changed only once in a 24-hour day.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
This command specifies the number of characters that the character sequence in a new password must differ from the character sequence in the old password.
set password complexity character differencenum-char
Syntax Description
Parameters
Description
num-char
This specifies the number of characters that the character sequence in a new password must differ from the character sequence in the old password.
Value range: 0-31
Command Modes
Administrator (admin:)
Usage Guidelines
Enter 0 to indicate no difference.
Note
The maximum password length is 31 characters.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password complexity character max-repeat
This command specifies the number of times you can consecutively repeat a single character in a new password.
set password complexity character max-repeatmax-repeat
Syntax Description
Parameters
Description
max-repeat
This specifies the number of times you can consecutively repeat a single character in a new password.
Value range: 0 – 10
Default value: 0
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password expiry maximum-age
This command enables or disables the password expiry maximum age settings for Cisco Unified Operating System Administrator accounts.
set password expiry maximum-age
{ enable | disable }
Syntax Description
Parameters
Description
enable
Turns on password expiry maximum age settings for Cisco Unified Operating System administrator accounts. The set password expiry enable command sets the value of maximum password age to 3650 days (10 yrs) for Cisco Unified Operating System Administrator accounts.
disable
Turns off password expiry maximum age settings for Cisco Unified Operating System administrator accounts. The set password expiry disable command results in Cisco Unified Operating System Administrator accounts never expiring.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
This command enables or disables the password expiry minimum age settings for Cisco Unified Operating System Administrator accounts.
set password expiry minimum-age
{ enable | disable }
Syntax Description
Parameters
Description
enable
Turns on password expiry minimum age settings for Cisco Unified Operating System administrator accounts. The set password expiry enable command sets the value of minimum password age to one day (24 hrs) for Cisco Unified Operating System Administrator accounts.
disable
Turns off password expiry minimum age settings for Cisco Unified Operating System administrator accounts. This means that passwords for administrator accounts can be changed at any interval.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
This command disables the maximum age password expiry for a particular Cisco Unified Operating System Administrator account.
set password expiry user maximum-age
{ enable | disable }
userid
Syntax Description
Parameters
Description
enable
Turns on the maximum age password expiry settings for a particular Cisco Unified Operating System administrator account. The set password expiry user enable command sets the value of maximum password age to 3650 days (10 yrs) for the Cisco Unified Operating System Administrator account.
disable
Turns off the maximum age password expiry settings for a particular Cisco Unified Operating System administrator account. The set password expiry user disable command results in that Cisco Unified Operating System Administrator account never expiring.
userid
Specifies a particular Cisco Unified Operating System Administrator account.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:set password expiry user maximum-age enable
Operation Successful.
set password expiry user minimum-age
This command enables or disables the maximum age password expiry for a particular Cisco Unified Operating System Administrator account.
set password expiry user minimum-age
{ enable | disable }
userid
Syntax Description
Parameters
Description
enable
Turns on the minimum age password expiry settings for a particular Cisco Unified Operating System administrator account.
disable
Turns off the minimum age password expiry settings for a particular Cisco Unified Operating System administrator account.
userid
Specifies a particular Cisco Unified Operating System Administrator account.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:set password expiry user minimum-age disable
Operation Successful.
set password history
This command modifies the number of passwords that get maintained in the history for OS admin accounts. New passwords matching remembered passwords get rejected.
set password historynumber
Syntax Description
Parameters
Description
number
Specifies the mandatory number of passwords to maintain in history.
Command Modes
Administrator (admin:)
Usage Guidelines
To disable, enter 0.
Default specifies 10.
Upper limit specifies 20.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password inactivity
set password inactivity
{ enable | disable | period }
days
Syntax Description
Parameters
Description
enable
Enable the password inactivity globally and update individual OS users according to the setting.
disable
Disable the password inactivity globally and update individual OS users according to the setting.
period
Configure the password inactivity period globally and update individual OS users according to the setting.
days
Specify the number of days of inactivity after a password has expired before the account gets disabled. Valid range is 1 - 99.
Command Modes
Administrator (admin:)
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: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password user admin
This command allows you to change the administrator password.
set password user admin
Command Modes
Administrator (admin:)
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.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set password user security
This command allows you to change the security password.
set password user security
Command Modes
Administrator (admin:)
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.
Change the security password on the publisher server (first node) and then reboot the server (node).
Change the security password on all the subsequent servers and 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.
Note
Failure to reboot the servers (nodes) causes system service problems and problems with the Cisco Unified Communications Manager Administration windows on the subscriber servers.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set session maxlimit
This command sets the upper limit for concurrent sessions.
set session maxlimit [value]
Syntax Description
Parameters
Description
maxlimit
This command sets the upper limit for concurrent sessions. Acceptable values are 1 - 100.
If no upper limit is entered, the default value of 10 is assigned to sshd_config param.
value
Acceptable values are 1 - 100.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set smtp
This command sets the SMTP server hostname.
set smtphostname
Syntax Description
Parameters
Description
hostname
Represents the SMTP server name.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set timezone
This command lets you change the system time zone.
set timezonezone
Syntax Description
Parameters
Description
zone
Specifies the new timezone. Enter the appropriate string or zone index id to uniquely identify the timezone. To view a list of valid time zones, use the CLI command: show timezone list.
Command Modes
Administrator (admin:)
Usage Guidelines
Enter characters to uniquely identify the new time zone. Be aware that the timezone name is case-sensitive.
Caution
You must restart the system after you change the timezone.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example setting time zone to Pacific time
admin:set timezone Pac
set trace*
set trace disable
This command unsets trace activity for the specified task.
set trace disabletname
Syntax Description
Parameters
Description
disable
Unsets the task trace settings.
tname
Represents the task for which you want to disable traces.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set trace enable
This command sets trace activity for the specified task.
set trace enable
{ Arbitrary | Detailed | Entry_exit | Error | Significant | Special | State_Transition }
tname
Syntax Description
Parameters
Description
Arbitrary
Sets task trace settings to the arbitrary level.
Detailed
Sets task trace settings to the detailed level.
Entry_exit
Sets task trace settings to the entry_exit level.
Error
Sets task trace settings to the error level.
Significant
Sets task trace settings to the significant level.
Special
Sets task trace settings to the special level.
State_transition
Sets task trace settings to the state transition level.
tname
Represents the task for which you want to disable traces.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set web-security
This command sets the web security certificate information for the operating system.
set web-securityorgunit orgname locality state [alternatehostname] [alternatehostname]
Syntax Description
Parameters
Description
orgunit
Represents the organizational unit (OU) name.
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 organizational 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.
When you set an alternate-host-name parameter with the set web-security command, self-signed certificates for tomcat contain the Subject Alternate Name extension with the alternate-host-name specified. CSR for Cisco Unified Communications Manager contains Subject Alternate Name Extension with the alternate host name included in the CSR.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
This example shows the web-security command with multiple organizational unit names using comma separators. The certificate has three OU fields:
OU=accounting
OU=personnel, CA
OU=personnel, MA
admin:set web-security “accounting,personnel\,CA,personnel\,MA” Cisco Milpitas
CA
set webapp session timeout
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. 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. This command prompts you to restart the service.
Caution
Restarting the Cisco Tomcat service ends all active sessions and can affect system performance. Cisco recommends that you only execute this command during off-peak traffic hours.
Note
This setting gets preserved through a software upgrade and does not get reset to the default value.
set webapp session timeoutminutes
Syntax Description
Parameters
Description
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
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
set workingdir
This command sets the working directory for active, inactive, and installation logs.
set workingdir
{ activelog | inactivelog | tftp }
directory
Syntax Description
Parameters
Description
activelog
Sets the working directory for active logs. Choose a valid sub-directory of activelog.
inactivelog
Set the working directory for inactive logs. Choose a valid sub-directory of inactivelog.
tftp
Sets the working directory for TFTP files.
directory
Represents the current working directory.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0 for logs, 1 for TFTP
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Show commands
show account
This command lists current administrator accounts, except the master administrator account.
show account
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 4
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
show accountlocking
This command displays the current account locking settings.
show accountlocking
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:show accountlocking
Account Lockout is disabled
show cert*
show cert list
This command displays certificate trust lists.
show cert list
{ own | trust }
Syntax Description
Parameters
Description
own
Specifies owned certificates.
trust
Specifies trusted certificates.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:cert list own
show cert own
This command displays certificate contents.
show cert ownfilename
Syntax Description
Parameters
Description
own
Specifies owned certificates.
filename
Represents the name of the certificate file.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
show cert trust
This command displays certificate contents.
show cert trustfilename
Syntax Description
Parameters
Description
trust
Specifies trusted certificates.
filename
Represents the name of the certificate file.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
show cli*
show cli pagination
This command displays the status of automatic CLI automatic pagination.
show cli pagination
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
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.
show cli session timeout
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
show csr*
show csr list
This command displays Certificate Sign Request contents and certificate trust lists.
show csr list
{ own |
| trust }
Syntax Description
Parameters
Description
own
Shows a list of owned Certificate Sign Requests.
trust
Shows a list of trusted Certificate Sign Requests.
Command Modes
Administrator (admin:)
Usage Guidelines
The certificate name can be obtained by using the show cert list own command.
Requirements
Command privilege level:
Allowed during upgrade:
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
admin: show csr list own
tomcat/tomcat.csr
Vipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr
.....
.....
.....
show csr own
This command displays Certificate Sign Request (CSR) contents and certificate trust lists.
show csr ownname
Syntax Description
Parameters
Description
name
The name of the CSR file.
Command Modes
Administrator (admin:)
Usage Guidelines
The certificate name can be obtained by using the show cert list own command.
Requirements
Command privilege level:
Allowed during upgrade:
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Saves the output to a specified file. These files are stored in the platform/cli directory. To view saved files, use the file view activelog command.
directory
Displays the directory sizes only.
sort
Sorts the output on the basis of file size. File sizes display in 1024-byte blocks.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show dscp*
show dscp all
This command displays the current DSCP traffic markings on all the ports. It displays the DSCP markings in decimal and hexidecimal. If the value corresponds to a class then it displays the correct class. If the value does not correspond to a class, then it displays N/A.
show dscp all
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection
show dscp defaults
This command displays the default factory DSCP settings. These values take effect if the set dscp defaults command is executed.
show dscp defaults
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM and Cisco Unity Connection
show dscp marking
This command displays the current DSCP traffic markings for a particular DSCP value.
show dscp markingvalue
Syntax Description
Parameters
Description
value
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.
Command Modes
Administrator (admin:)
Usage Guidelines
The valid class names as defined by DSCP are:
Class Selector: values CSO, CS1, CS2, CS3, CS5, CS6CS7
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: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show dscp status
This command displays the current DSCP traffic markings.
show dscp status
{ enabled | disabled }
Syntax Description
Parameters
Description
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.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show environment
This command displays environmental information for three types of hardware components.
show environment
{ fans | power-supply | temperatures }
Syntax Description
Parameters
Description
fans
Displays the fan speeds in Rotations per Minute (RPMs), fan-speed thresholds, and status.
power-supply
Displays the power-supply status only MCS-7845, MCS-7835, MCS-7825H3/H4, and MCS-7816H3 servers (those servers with redundant power supplies or embedded health hardware).
temperatures
Displays the temperature sensor temporary values, thresholds, and status.
Command Modes
Administrator (admin:)
Usage Guidelines
The output data from this command varies between IBM and HP server models.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show hardware
This command displays hardware-related information about the platform.
show hardware
Command Modes
Administrator (admin:)
Usage Guidelines
The following information is displayed:
Platform
Serial number
BIOS build level
BIOS manufacturer
Active processors
RAID controller status
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show ipsec*
show ipsec information
show ipsec information
{ policy_group | policy_name }
Syntax Description
Parameters
Description
policy_group
policy_name
Command Modes
Administrator (admin:)
Usage Guidelines
Requirements
Command privilege level:
Allowed during upgrade:
Applies to: IM and Presence service on Unified CM
Example title
admin:
show ipsec policy_group
This command displays all the ipsec policy group on the node.
show ipsec policy_group
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection
show ipsec policy_name
This command displays the list of ipsec policy names that exist in the specified policy group.
show ipsec policy_namepolicy_group
Syntax Description
Parameters
Description
policy_group
Specifies the policy group name.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection
show ipsec status
show ipsec status
Command Modes
Administrator (admin:)
Usage Guidelines
Requirements
Command privilege level:
Allowed during upgrade:
Applies to: IM and Presence service on Unified CM
show logins
This command lists recent logins to the server
show logins [number]
Syntax Description
Parameters
Description
number
Specifies the number of the most recent logins to display. The default is 20.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection
show memory
This command displays information about the onboard memory.
show memory
{ count | modules | size }
Syntax Description
Parameters
Description
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.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show myself
This command displays information about the current account.
show myself
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show network*
show network all
This command shows network information for listening and nonlistening sockets.
show network all [detail] [page]
[ searchsrchtext ]
Syntax Description
Parameters
Description
detail
Shows additional information.
page
Displays information one page at a time.
searchsrchtext
Searches for srchtext in the output.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network cluster
This command lists nodes in the network cluster.
show network cluster
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network dhcp eth0
This command shows DHCP status information.
show network dhcp eth0
Command Modes
Administrator (admin:)
Usage Guidelines
The eth0 parameter displays Ethernet port 0 settings, including DHCP configurations and options.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network eth0
This command shows network information for ethernet 0.
show network eth0 [detail]
[ searchsrchtxt ]
Syntax Description
Parameters
Description
detail
Shows additional information.
searchsrchtxt
Searches for srchtxt in the output.
Command Modes
Administrator (admin:)
Usage Guidelines
The eth0 parameter displays Ethernet port 0 settings
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network failover
This command shows Network Fault Tolerance information.
show network failover [detail] [page]
Syntax Description
Parameters
Description
detail
Shows additional information.
page
Shows information one page at a time.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network ip_conntrack
This command shows ip_conntrack usage information.
show network ip_conntrack
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network ipprefs
show network ipprefs
This command shows the list of ports that have been requested to be opened or translated in the firewall.
show network ipprefs
{ all | enabled | public }
Syntax Description
Parameters
Description
all
Shows all incoming ports that may be used on the product.
enabled
Shows all incoming ports that are currently opened.
public
Shows all incoming ports that are currently opened for a remote client.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
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
show network ipv6
This command shows IPv6 network routes and network settings.
show network ipv6
{ route | settings }
Syntax Description
Parameters
Description
route
Shows all IPv6 routes.
settings
Shows all IPv6 network settings.
Command Modes
Administrator (admin:)
Usage Guidelines
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, Cisco Unity Connection
show network max_ip_conntrack
This command shows max_ip_conntrack information.
show network max_ip_conntrack
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network route
This command shows network routing information.
show network route [detail]
[ searchsrchtext ]
Syntax Description
Parameters
Description
detail
Shows additional information.
searchsrchtext
Searches for the srchtext in the output.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show network status
This command shows active internet connections.
show network status [detail] [listen] [process] [all] [nodns] [ searchstext ]
Syntax Description
Parameters
Description
detail
Shows additional information.
listen
Shows only listening sockets.
process
Shows the process ID and name of the program to which each socket belongs.
all
Shows both listening and nonlistening sockets.
nodns
Shows numerical addresses without any DNS information.
searchstext
Searches for the stext in the output.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
This example displays active internet connections.
admin: show network status
show open*
show open files*
show open files all
This command shows all open files on the system.
show open files all
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show open files process
The command shows open files that belong to a specified process.
show open files processprocessID
Syntax Description
Parameters
Description
processID
Specifies a process.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show open files regexp
This command shows open files that match the specified regular expression.
show open files regexpreg_exp
Syntax Description
Parameters
Description
reg_exp
Specifies a regular expression.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show open ports*
show open ports all
This command shows all open ports on the system.
show open ports all
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show open ports process
This command displays open ports the belong to a specified process.
show open ports processprocessID
Syntax Description
Parameters
Description
processID
Specifies a process.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show open ports regexp
This command shows open ports that match the specified regular expression.
show open ports regexpreg_exp
Syntax Description
Parameters
Description
reg_exp
Specifies a regular expression.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show packages
This command displays the name and version for installed packages.
show packages
{ active | inactive }
name [page]
Syntax Description
Parameters
Description
active
Specifies active packages.
inactive
Specifies inactive packages.
name
Specifies the package name. To display all active or inactive packages, use the wildcard character, *.
page
Shows the output one page at a time
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show password*
show password
This command shows information about the configured password.
show password
{ age | history | inactivity }
Syntax Description
Parameters
Description
age
Shows information about the configured password age parameters
history
Shows the number of passwords that the history maintains for OS administration accounts.
inactivity
Shows the status of the password inactivity for OS accounts. Password inactivity is the number of days of inactivity after a password has expired before the account is disabled.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
This command shows whether a user is forced to change passwords after the user signs in to the system the next time.
show password change-at-loginuserid
Syntax Description
Parameters
Description
userid
Specifies the user account that you want to show.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show password expiry*
show password expiry
This command shows the configured password expiration parameters.
show password expiry
{ maximum-age | minimum-age }
Syntax Description
Parameters
Description
maximum-age
Shows the maximum number of days for set password expiry.
minimum-age
Shows the minimum number of days for set password expiry.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show password expiry user
This command shows the configured password expiration parameters for the specified user.
show password expiry user
{ maximum-age | minimum-age }
userid
Syntax Description
Parameters
Description
maximum-age
Shows the maximum number of days for set password expiry.
minimum-age
Shows the minimum number of days for set password expiry.
userid
Specifies the user account that you want to show.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show password expiry user list
This command shows the password maximum age and password minimum age for each CLI user in the system.
show password expiry user
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf*
show perf counterhelp
This command displays information about the specified perfmon counter.
show perf counterhelpclass-namecounter-name
Syntax Description
Parameters
Description
class-name
Represents the class name that contains the counter.
counter-name
Represents the counter that you want to view.
Command Modes
Administrator (admin:)
Usage Guidelines
If the class name or counter name contains white spaces, enclose the name in double quotation marks.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf list categories
This command lists the categories in the perfmon system.
show perf list categories
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf list classes
This command lists perfmon classes (objects).
show perf list classes
[ catcategory ]
[ detail ]
Syntax Description
Parameters
Description
catcategory
Displays perfmon classes for the specified category.
detail
Displays detailed information.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf list counters
This command lists perfmon counters for the specified perfmon class.
show perf list countersclass-name
[ detail ]
Syntax Description
Parameters
Description
class-name
Represents the class name that contains the counter.
detail
Displays detailed information.
Command Modes
Administrator (admin:)
Usage Guidelines
If the class name contains white spaces, enclose the name in double quotation marks.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf list instances
This command lists the perfmon instances for the specified perfmon class.
show perf list instancesclass-name
[ detail ]
Syntax Description
Parameters
Description
class-name
Represents the class name that contains the counter.
detail
Displays detailed information.
Command Modes
Administrator (admin:)
Usage Guidelines
If the class name contains white spaces, enclose the name in double quotation marks.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf query class
This command queries a perfmon class and displays all the instances and counter values of each instance.
show perf query classclass-name
[ ,class-name... ]
Syntax Description
Parameters
Description
class-name
Represents the class name that contains the counter.
Command Modes
Administrator (admin:)
Usage Guidelines
If the class name contains white spaces, enclose the name in double quotation marks.
You can specify a maximum of five classes for each command.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf query counter
This command queries the specified counter or counters and displays the counter value of all instances.
show perf query counterclass-namecounter-name
[ ,counter-name... ]
Syntax Description
Parameters
Description
class-name
Represents the class name that contains the counter.
counter-name
Represents the counter that you want to view.
Command Modes
Administrator (admin:)
Usage Guidelines
If the class name or counter name contains white spaces, enclose the name in double quotation marks.
You can specify a maximum of five counters for each command.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf query instance
This command queries the specified instance and displays all its counter values.
show perf query instanceclass-nameinstance-name
[ ,instance-name... ]
Syntax Description
Parameters
Description
class-name
Represents the class name that contains the counter.
instance-name
Specifies the perfmon instance to view.
Command Modes
Administrator (admin:)
Usage Guidelines
If the class name contains white spaces, enclose the name in double quotation marks.
You can specify a maximum of five instances for each command.
This command does not apply to singleton perfmon classes.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show perf query path
This command queries a specified perfmon path.
show perf query pathpath-spec
[ ,path-spec... ]
Syntax Description
Parameters
Description
path-spec
Specifies a perfmon path.
Command Modes
Administrator (admin:)
Usage Guidelines
For an instance-based perfmon class, you must specify path-spec as follows: class-name(instance-name)\counter-name
For a noninstance-based perfmon class (a singleton), you must specify path-spec as follows: class-name\counter-name
You can specify a maximum of five paths for each command.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
admin: show perf query path "Cisco Phones(phone-0)\CallsAttempted","Cisco Unified Communications Manager\T1ChannelsActive"
show process*
show process list
This command displays a list of all the processes and critical information about each process and visually indicates the child-parent relationships between the processes.
show process list
[ filefilename ]
[ detail ]
Syntax Description
Parameters
Description
file
Outputs the results to the file that is specified by the filename variable.
filename
Specifies the filename.
detail
Displays detailed output.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process load
This command displays the current load on the system.
show process load
[ cont ]
[ clear ]
[ noidle ]
[ numnumber ]
[ thread ]
[ cpu |
| memory |
| time ]
[ page ]
Syntax Description
Parameters
Description
cont
Repeats the command continuously.
clear
Clears the screen before displaying output.
noidle
Ignores the idle or zombie processes.
numnumber
Displays the number of processes that are specified by number. The default number of processes equals 10. Set number to all to display all processes.
thread
Displays threads.
cpu
Sorts output by CPU usage. This is the default sorting.
memory
Sorts output by memory usage.
time
Sorts output by time usage.
page
Displays the output in pages.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process name
This command displays the details of processes that share the same name and indicates their parent-child relationship.
show process nameprocess
[ filefilename ]
Syntax Description
Parameters
Description
process
Specifies the name of a process.
filefilename
Outputs the results to the file that is specified by filename.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process open-fd
This command lists the open file descriptors for a comma-separated list of process IDs.
show process open-fdprocess-id
[ ,process-id2 ]
Syntax Description
Parameters
Description
process-id
Specifies the process-id.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process pid
This command shows a specific process number or command name.
show process pidpid
[ filefilename ]
Syntax Description
Parameters
Description
pid
Specifies the process ID number of a process.
filefilename
Outputs the results to the file that is specified by filename.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process search
This command searches for the pattern that the regular expression regexp specifies in the output of the operating system-specific process listing.
show process search regexp
[ filefilename ]
Syntax Description
Parameters
Description
regexp
Represents a regular expression.
filefilename
Outputs the results to the file that is specified by filename.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process user
This command retrieves details of processes that share the user name and displays parent-child relationship.
show process userusername
[ filefilename ]
Syntax Description
Parameters
Description
username
Specifies the username.
filefilename
Outputs the results to the file that is specified by filename.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process using-most cpu
This command displays a list of the most CPU-intensive processes.
show process using-most cpu
[ number ]
[ filefilename ]
Syntax Description
Parameters
Description
number
Specifies the number of processes to display. The default specifies 5.
filefilename
Outputs the results to the file that is specified by filename.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show process using-most memory
This command displays a list of the most memory-intensive processes.
show process using-most memory
[ number ]
[ filefilename ]
Syntax Description
Parameters
Description
number
Specifies the number of processes to display. The default specifies 5.
filefilename
Outputs the results to the file that is specified by filename.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show registry
This command displays the contents of the registry.
show registrysystemcomponent
[ name ]
[ page ]
Syntax Description
Parameters
Description
system
Represents the registry system name.
component
Represents the registry component name.
name
Represents the name of the parameter to show.
page
Displays one page at a time.
Command Modes
Administrator (admin:)
Usage Guidelines
If the name is “page,” and you want to display the output one page at a time, use the command show registrysystemcomponentnamepagepage
To show all components in a system, enter the wildcard character * in the command: show registrysystem*
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
This example shows the contents of the cm system, dbl/sdi component.
admin: show registry cm dbl/sdi
show risdb*
show risdb list
This command displays the tables that are supported in the Realtime Information Service (RIS) database.
show risdb list
[ filefilename ]
Syntax Description
Parameters
Description
filefilename
Outputs the information to a file.
Command Modes
Administrator (admin:)
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the filename does not contain the "." character.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
This command displays a list of all RIS database tables.
admin: show risdb list
show risdb query
This command displays the contents of the specified RIS tables.
show risdb querytable1table2table3... [ filefilename ]
Syntax Description
Parameters
Description
table1
Specifies the name of a table.
filefilename
Outputs the information to a file.
Command Modes
Administrator (admin:)
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the filename does not contain the "." character.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show session maxlimit
This command shows the upper limit for concurrent SSH sessions.
show session maxlimit
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show smtp
This command displays the name of the SMTP host.
show snmp
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show stats io
This command displays the IO statistics.
show stats io
[ kilo ]
[ detail ]
[ page ]
[ filefilename ]
Syntax Description
Parameters
Description
kilo
Displays statistics in kilobytes.
detail
Displays detailed statistics on every available device on the system and overrides the kilo option.
page
Displays one page at a time.
filefilename
Outputs the information to a file specified by filename
Command Modes
Administrator (admin:)
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the filename does not contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show status
This command displays basic platform status.
show status
Command Modes
Administrator (admin:)
Usage Guidelines
This command displays the following basic platform status:
hostname
date
timezone
locale
product version
platform version
CPU usage
memory and disk usage
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show tech*
show tech activesql
This command displays the active queries to the database taken at one minute intervals as far back as the logs allow.
show tech activesql
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show tech all
This command displays the combined output of all show tech commands.
show tech all
[ page ]
[ filefilename ]
Syntax Description
Parameters
Description
page
Displays one page at a time.
filefilename
Outputs the information to a file.
Command Modes
Administrator (admin:)
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show tech network all
This command displays all network tech information.
show tech network all
[ page ]
[ searchtext ]
[ filefilename ]
Syntax Description
Parameters
Description
page
Displays one page at a time.
searchtext
Searches the output for the string that text specifies. Be aware that the search is case insensitive.
filefilename
Outputs the information to a file.
Command Modes
Administrator (admin:)
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show tech network hosts
This command displays information about hosts configuration.
Searches the output for the string that text specifies. Be aware that the search is case insensitive.
filefilename
Outputs the information to a file.
Command Modes
Administrator (admin:)
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show tech network sockets
This command displays the list of open sockets.
show tech network sockets
{ numeric }
Syntax Description
Parameters
Description
numeric
Displays the numerical addresses of the ports instead of determining symbolic hosts. This parameter is equivalent to running the Linux shell numeric-n command.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show tech runtime
This command displays CPU usage information at the time the command is run.
show tech runtime
{ all | cpu | disk | env | memory }
pagefilefilename
Syntax Description
Parameters
Description
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.
page
Displays one page at a time.
filefilename
Outputs the information to a specified file.
Note
This option saves the information to platform/cli/<filename>.txt. Ensure that the file name does not contain the "." character.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
show tech system
This command displays all the system information.
show tech system
{ all | bus | hardware | host | kernel modules | software | tools }
pagefilefilename
Syntax Description
Parameters
Description
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.
page
Displays one page at a time.
filefilename
Outputs the information to a file. This option saves the information to platform/cli/<filename>.txt. Ensure that the file name does not contain the "." character.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show timezone
show timezone config
This command displays the current timezone settings.
show timezone config
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show timezone list
This command displays the available timezones.
show timezone list
[ page ]
Syntax Description
Parameters
Description
page
Displays the output one page at a time.
Command Modes
Administrator (admin:)
Usage Guidelines
Although the list of available time zones includes Factory, Unified CM does not support the Factory timezone.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show trace
This command displays trace information for a particular task.
show trace
[ task_name ]
Syntax Description
Parameters
Description
task_name
Represents the name of the task for which you want to display the trace information.
Command Modes
Administrator (admin:)
Usage Guidelines
If you do not enter a parameter, the command returns a list of available tasks.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
admin: show trace cdps
show ups status
This command shows the current status of the USB-connected APC smart-UPS device and starts the monitoring service if this service is not already started.
show ups status
Command Modes
Administrator (admin:)
Usage Guidelines
This command provides full status only for 7835-H2 and 7825-H2 servers.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show version*
show version active
This command displays the software version on the active partition.
show version active
Command Modes
Administrator (admin:)
Requirements
Command privilege level: o
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show version inactive
This command displays the software version on the inactive partition
show version inactive
Command Modes
Administrator (admin:)
Requirements
Command privilege level: o
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show web-security
This command displays the contents of the current web-security certificate.
show web-security
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show webapp session timeout
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.
show webapp session timeout
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
show workingdir
This command retrieves the current working directory for activelog, inactivelog, install, and TFTP.
show workingdir
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Unset commands
unset ipsec*
unset ipsec policy_group
This command disables the ipsec policy on the specified group.
unset ipsec policy_grouppolicy_group
Syntax Description
Parameters
Description
policy_group
Specifies the group name.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
unset ipsec policy_name
This command disables the ipsec policy with the specified name.
unset ipsec policy_namepolicy_name
Syntax Description
Parameters
Description
policy_name
Specifies the policy name to disable.
Command Modes
Administrator (admin:)
Usage Guidelines
Enter ALL for policy_name to disable all policy names.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
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 the system fails to the default.
rotate
Sets the method for selecting a nameserver to the default. This affects how loads are distributed across nameservers.
Command Modes
Administrator (admin:)
Usage Guidelines
You are asked to confirm that you want to execute this command.
Caution
If you continue, the system loses network connectivity temporarily.
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
unset network domain
This command unsets the domain name and restarts the server.
unset network domain
Command Modes
Administrator (admin:)
Usage Guidelines
You are asked to confirm that you want to execute this command.
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
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...
unset network ipv6 static_address
This command unsets the IPV6 static address.
unset network ipv6 static_address
[ reboot ]
Syntax Description
Parameters
Description
reboot
Reboots the server after applying the change.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, Cisco Unity Connection
Example
admin: 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.
Utils commands
utils auditd
This command starts, stops, and provides the status of the system auditing service.
utils auditd
{ enable | disable | status }
Syntax Description
Parameters
Description
enable
Enables the collection of audit logs. When enabled, the system monitors and records user actions as well as Linux events such as the creation and removal of users, as well as the editing and deleting of files .
disable
Disables the collection of audit logs.
status
Displays the status of audit log collection. Cisco recommends that you retrieve the audit log by using the Real-Time Monitoring Tool, but you can also retrieve it by using the CLI.
Command Modes
Administrator (admin:)
Usage Guidelines
After the service has been enabled, it monitors and logs activity on the system. Be aware that the system auditing service logs a lot of information. Care must be taken not to overfill the disk.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils core*
utils core analyze
This command generates a backtrace for a core file, a thread list, and the current value of all CPU registers.
utils core
{ active | inactive }
analyze [core_filename]
Syntax Description
Parameters
Description
active
Specifies an active version
inactive
Specifies an inactive version
core_filename
Specifies the name of the core file from which to generate the stack trace.
Command Modes
Administrator (admin:)
Usage Guidelines
This command creates a file of the same name as the core file, with a .txt extension, in the same directory as the core file. After you execute this command on a core file created by cimserver, an unexpected message displays. This message is a known limitation of the command.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils core list
This command displays all active or inactive core files.
utils core
{ active | inactive }
list
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils create report
This command creates reports about the server in the platform/log directory.
Collects all the files required for the Cisco Security Agent (CSA) diagnostics and assembles them into a single CSA diagnostics file. You can retrieve this file using the file get command.
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 with the file get command.
Command Modes
Administrator (admin:)
Usage Guidelines
You are prompted to continue after you enter the command.
After you create a report, use the command file get activelog platform/log/filename command, to get the report. where filename specifies the report filename that displays after the command completes.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils diagnose
This command enables you to diagnose and attempt to automatically fix system problems.
utils diagnose
{ fix | list | module | test | version }
[module_name]
Syntax Description
Parameters
Description
fix
Runs all diagnostic commands and attempts to fix problems.
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.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils disaster_recovery*
utils disaster_recovery backup local
This command invokes the backup and creates the tar file on
the local drive.
Comprises a comma-separated feature
list to backup.
device_name
Specifies the name of the backup
device to be added.
Command Modes
Administrator (admin:)
Usage Guidelines
Use
utils disaster_recovery show_registration to display the list of
registered features.
Use
utils disaster_recovery device list to display the configured
device list.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence on Unified CM, Cisco Unity Connection
utils disaster_recovery cancel_backup
This command cancels the ongoing backup.
utils disaster_recovery cancel_backup [confirm]
Command Modes
Administrator (admin:)
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.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
represents the hostname of the
server to be restored.
tarfilename
specifies the file that will get
restored (without the file extension, for example: 2008-01-21-18-25-03).
device_name
specifies the name of the backup
device to be added.
Command Modes
Administrator (admin:)
Usage Guidelines
Use
utils disaster_recovery device list to display the configured
device list.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:utils disaster_recovery restore local SW075B-CM11 2008-01-21-18-25-03 localdeviceRestore initiated successfully.Please run 'utils showstatus restore' command to see the status.
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
Example
admin: utils disaster_recovery schedule list
schedule name device name Schedule Status
-----------------------------------------
schedule1 device 1 enabled
schedule2 device 2 disabled
utils disaster_recovery show_backupfiles
This command displays information about backup files.
utils disaster_recovery show_backupfiles
{ | }
[]
Syntax Description
Parameters
Description
Command Modes
Administrator (admin:)
Usage Guidelines
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils disaster_recovery show_registration
This command displays the registered features and components on the specified server.
utils disaster_recovery show_registrationhostname
Syntax Description
Parameters
Description
hostname
Specifies the server for which you want to display registration information.
Command Modes
Administrator (admin:)
Usage Guidelines
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils disaster_recovery status
This command displays the status of the current backup or restore job.
utils disaster_recovery statusoperation
Syntax Description
Parameters
Description
operation
Specifies the name of the ongoing operation: backup or restore.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils firewall*
utils firewall ipv4 debug
This command turns IPv4 firewall debugging on or off. If you do not enter a time parameter, this command turns on debugging for 5 minutes.
utils firewall ipv4 debug
{ off |
| [time] }
Syntax Description
Parameters
Description
off
Turns off the IPv4 firewall debugging. If you do not enter the time parameter, this command disables the firewall for 5 minutes.
time
(Optional) Sets the duration for which the firewall debugging is to be enabled in the following formats:
Minutes: 0–1440m
Hours: 0–23h
Hours and minutes: 0–23h 0–60m
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils firewall ipv4
This commands enables and disables IPv4 firewall.
utils firewall ipv4
{ enable | disable | [time] }
Syntax Description
Parameters
Description
enable
Turns on the IPv4 firewall.
disable
Turns off the IPv4 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.
time
(Optional) Sets the duration for which the firewall is to be disabled in the following formats:
Minutes: 0–1440m
Hours: 0–23h
Hours and minutes: 0–23h 0–60m
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils firewall ipv4 list
This commands displays the current configuration of the IPv4 firewall.
utils firewall ipv4 list
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils firewall ipv4 status
This command displays the current status of the IPv4 firewall.
utils firewall ipv4 status
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils firewall ipv6 debug
This command turns IPv6 firewall debugging on or off. If you do not enter a time parameter, this command turns on debugging for 5 minutes.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
utils ipv6 firewall debug
{ off |
| [time] }
Syntax Description
Parameters
Description
off
Turns off the IPv6 firewall debugging. If you do not enter the time parameter, this command disables the firewall for 5 minutes.
time
(Optional) Sets the duration for which the firewall debugging is to be enabled in the following formats:
Minutes: 0–1440m
Hours: 0–23h
Hours and minutes: 0–23h 0–60m
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection.
utils firewall ipv6
This commands enables and disables IPv6 firewall.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
utils firewall ipv6
{ enable | disable | [time] }
Syntax Description
Parameters
Description
enable
Turns on the IPv6 firewall.
disable
Turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.
time
(Optional) Sets the duration for which the firewall is to be disabled in the following formats:
Minutes: 0–1440m
Hours: 0–23h
Hours and minutes: 0–23h 0–60m
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection.
utils firewall ipv6 list
This commands displays the current configuration of the IPv6 firewall.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
utils firewall ipv6 list
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection.
utils firewall ipv6 status
This command displays the current status of the IPv6 firewall.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
utils firewall ipv6 status
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection.
utils import config
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.
utils import config
Command Modes
Administrator (admin:)
Usage Guidelines
This command can be executed on any VMware deployment.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
This command displays the iostat output for the given number of iterations and intervals.
utils iostat
{ interval | iterations | filename }
Syntax Description
Parameters
Description
interval
Sets the seconds between two iostat readings. You must set this value if you are using the iteration parameter
iterations
Sets the number of iostat iterations. You must set this value if you are using the interval parameter.
filename
Redirects the output to a file.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils iothrottle
This command allows you to manage and monitor IO throttling on the server.
utils iothrottle
{ enable | disable | status }
Syntax Description
Parameters
Description
Enable
Enables I/0 throttling enhancements which lowers the impact of upgrades on an active system.
Disable
Disables I/0 throttling enhancements.
Status
Displays the status of I/0 throttling enhancements.
Command Modes
Administrator (admin:)
Usage Guidelines
Disabling I/0 throttling enhancements can adversely affect the system during upgrades.
utils ldap config
This command configures the system LDAP authentication.
utils ldap config
{ fqdn | ipaddr }
Syntax Description
Parameters
Description
fqdn
Configures the system to use an FQDN for LDAP authentication.
ipaddr
Configures the system to use an IP address for LDAP authentication
Command Modes
Administrator (admin:)
Usage Guidelines
utils ldap config fqdn—This command is preferred for LDAP authentication, however, you can only use this command if DNS is configured on the system; if the system is not configured to use DNS, use utils ldap config ipaddr.
utils ldap config ipaddr—This command is not preferred and should only be used if the system is not, or can not be, configured to use DNS; if the system is configured to use DNS, use utils ldap config fqdn.
Requirements
Applies to: Unified CM and Cisco Unity Connection
utils network*
utils network arp delete
This command deletes an entry in the Address Resolution Protocol table.
utils network arp deletehost
Syntax Description
Parameters
Description
host
(Optional) Represents the host name or IP address of the host to delete from the table.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Delete example
admin:utils network arp delete myhost
utils network arp set
This command sets an entry in the Address Resolution Protocol table.
utils network arp set
{ host }
{ addr }
Syntax Description
Parameters
Description
host
Represents the host name or IP address of the host to add to the table.
addr
Represents the hardware address (MAC) of the host to be added in the format: XX:XX:XX:XX:XX:XX
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Set example
admin:utils network arp set myhost 11:22:33:44:55:66
utils network arp list
This command lists the contents of the Address Resolution Protocol table.
utils network arp listhosthostname [options]
Syntax Description
Parameters
Description
host
hostname
options
(Optional) page, numeric
Page: Pauses to display the output one page at a time.
Numeric: Shows hosts as dotted IP addresses.
Command Modes
Administrator (admin:)
Usage Guidelines
In the Flags column, C=cached, M=permanent, P=published.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Applies to: Unified CM and Cisco Unity Connection.
utils network ipv6 ping
This command allows you to ping an IPv6 address or hostname.
Note
IPv6 is not supported in Cisco Unified Communications Manager Business Edition 5000.
utils network ipv6 pingdestination [count]
Syntax Description
Parameters
Description
destination
Specifies a valid IPv6 address or host name that you want to ping.
count
Specifies the number of times to ping the external server. The default count equals 4.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection.
utils network ping
This command allows you to ping another server.
utils network pingdestination [count]
Syntax Description
Parameters
Description
destination
Represents the ip address or host name of the server that you want to ping.
count
Specifies the number of times to ping the external server. The default count equals 4.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils network traceroute
This command traces IP packets that are sent to a remote destination.
utils network traceroute [destination]
Syntax Description
Parameters
Description
destination
Represents the hostname or IP address of the server to which you want to send a trace.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
utils ntp*
utils ntp config
This command displays the current configuration of the NTP client and server.
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.
utils ntp config
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence server on Unified CM, Cisco Unity Connection
utils ntp restart
This command restarts the NTP service.
utils ntp restart
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils ntp server list
This command lists all NTP servers.
utils ntp server list
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: IM and Presence server on Unified CM
utils ntp start
This command starts the NTP service if it is not already running.
Note
You can not stop the NTP service from the command line interface. Use this command when the utils ntp status command returns stopped.
utils ntp start
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence server on Unified CM, and Cisco Unity Connection
utils ntp status
This command displays the current status of NTP.
utils ntp status
Command Modes
Administrator (admin:)
Requirements
Command privilege level:
Allowed during upgrade:
Applies to: IM and Presence service on Unified CM.
utils os*
utils os kerneldump
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.
The MCS-7835-H2 and MCS-7845-H2 models do not support this command.
Note
The netdump commands have been removed from release 8.6(1) and have been replaced with the kerneldump commands.
utils os kerneldump
{ enable | disable }
Command Modes
Administrator (admin:)
Usage Guidelines
If a kernel crash occurs, the capture kernel dumps th core on the local disk of the server. The primary kernel reserves 128MB 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.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection
Example
admin: utils os kerneldump enable
***************WARNING*******************
Enabling kerneldump requires system reboot
Would you like to boot the machine (y/n):y
kerneldump enable operation succeeded
System going for a reboot
utils os kerneldump ssh
This command enables, disables, or displays the status of an external SSH server.
utils os kerneldump ssh
{ enable | disable | status }
Syntax Description
Parameters
Description
enable
Configures an external SSH server as a kerneldump server to kernel dumps.
disable
Removes support of the external SSH server that is configured to collect kernel dumps.
status
Indicates whether an external SSH server is configured or not, to collect kernel dumps.
Command Modes
Administrator (admin:)
Usage Guidelines
If external SSH server has the kerneldump service enabled and a kernel crash occurs, the capture kernel dumps the core on the external server that is configured to collect the dump.
Enabling and disabling kerneldump require a system reboot for the changes to come into effect.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection
Example
admin: utils os kerneldump ssh disable 10.77.31.60
Disabling kerneldump requires system reboot
Would you like to continue (y/n): y
kerneldump disable operation succeeded
System going for a reboot
utils os secure
This command is used to specify the level of security provided by selinux.
utils os secure
{ enforce | permissive | status }
Syntax Description
Parameters
Description
enforce
permissive
status
Command Modes
Administrator (admin:)
Usage Guidelines
Note that selinux does not handle rate limiting. Rate limiting is handled by ipprefs and ip tables.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: IM and Presence service on Unified CM
utils remote_account*
utils remote_account create
This command creates a remote account.
utils remote_account create
Command Modes
Administrator (admin:)
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.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils remote_account disable
This command allows you to disable a remote account.
utils remote_account disable
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils remote_account enable
This command allows you to enable a remote account.
utils remote_account enable
Command Modes
Administrator (admin:)
Usage Guidelines
You can have only one remote account that is enabled at a time.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils remote_account status
This command allows you to check the status of a remote account.
utils remote_account status
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils service*
utils service
This command activates, deactivates, starts, stops, or restarts a service.
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
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils snmp config 1/2c inform
This interactive command adds, deletes, lists or updates inform notification destinations.
Adds a new v3 inform notification destination associated with a configured v3 username.
delete
Deletes the configuration information for an existing v3 inform notification destination.
list
Lists the v3 inform notifications currently configured.
update
Updates configuration information for an existing v3 inform notification destination.
Command Modes
Administrator (admin:)
Usage Guidelines
The system prompts you for the parameters.
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
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils snmp config mib2
This interactive command affects the Mib2 configuration information.
Adds a new v3 trap notification destination associated with a configured v3 username.
delete
Deletes the configuration information for an existing v 3 trap notification destination.
list
Lists the v3 trap notifications currently configured.
update
Updates configuration information for an existing v3 trap notification destination.
Command Modes
Administrator (admin:)
Usage Guidelines
The system prompts you for the parameters.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils snmp config 3 user
This interactive command affects v3 user configuration.
utils snmp config 3 user
{ add |
| delete |
| list |
| update }
Syntax Description
Parameters
Description
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 currently configured.
update
Updates configuration information for an existing v3 user.
Command Modes
Administrator (admin:)
Usage Guidelines
The system prompts you for the parameters.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils snmp get
This interactive command gets the SNMP data using the specified version for the specified MIB OID.
utils snmp getversion
Syntax Description
Parameters
Description
version
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.
Command Modes
Administrator (admin:)
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: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils snmp hardware-agents
This command affects the SNMP agents on the server.
This interactive commands walks through the SNMP MIB using the specified version, starting with the specified OID.
utils snmp walkversion
Syntax Description
Parameters
Description
version
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
file
Specifies a file in which to save the command output.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Example
If you run snmp walk on a leaf in the MIB you basically get what you would get with utils snmp get ... command. Here in the example we are getting the system's uptime.
Press <enter> for 1 line, <space> for one page, or <q> to quit
utils system*
utils system restart
This command allows you to restart the system on the same partition.
utils system restart
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils system shutdown
This command allows you to shut down the system.
utils system shutdown
Command Modes
Administrator (admin:)
Usage Guidelines
This command has a five-minute timeout. If the system does not shut down within five minutes, the command gives you the option of doing a forced shutdown.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unifed CM, Cisco Unity Connection
utils system switch-version
This command allows you to restart the system on the inactive partition.
utils system switch-version
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
utils system boot
This command redirects where the system boot output gets sent.
utils system boot
{ console | serial }
Syntax Description
Parameters
Description
console
Redirects the system boot output to the console.
serial
Redirects the system boot output to the COM1 (serial port 1).
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Unified CM and Cisco Unity Connection
utils system upgrade
This command allows you to install upgrades and Cisco Option (COP) files from both local and remote directories.
utils system upgrade
{ initiate | cancel | status }
Syntax Description
Parameters
Description
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.
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
Feedback
