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 cuc*
utils cuc activate CUSRSV
This command converts the standalone Cisco Unity Connection server to Cisco Unity Connection SRSV server.
utils cuc activate CUSRSV
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Cisco Unity Connection
utils cuc cluster activate
This command activates this server in a Cisco Unity Connection cluster.
utils cuc cluster activate
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection
utils cuc cluster deactivate
This command deactivates this server in a Cisco Unity Connection cluster.
utils cuc cluster deactivate
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection
utils cuc cluster makeprimary
This command forces the specified server to take the primary server status in a Cisco Unity Connection cluster.
utils cuc cluster makeprimary
Syntax Description
Parameters
Description
server
Specifies the name of the server to take the primary server status in a Cisco Unity Connection cluster.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection
utils cuc cluster overwritedb
This command overwrites the data on the server with the data on the other server in a Cisco Unity Connection cluster.
utils cuc cluster overwritedb
Command Modes
Administrator (admin:)
Usage Guidelines
This command overwrites the database on the server on which you run this command with the database from the other server in the Connection cluster. Replication restarts after the database is overwritten. This method is used when you restore one server from a backup and must copy the restored data to the other server.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection
utils cuc cluster renegotiate
This command creates a cluster relationship with the publisher server in a Connection cluster after the server was replaced or the Connection was reinstalled on the publisher server. This command overwrites all data on the publisher server with data from the subscriber server and initializes replication between the servers.
utils cuc cluster renegotiate
Command Modes
Administrator (admin:)
Usage Guidelines
Run this command on the subscriber server in a Connection cluster to set up a trust with a publisher server that has been replaced or on which Connection has been reinstalled.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection
utils cuc create report
This command collects data that is helpful to technical support staff for troubleshooting the system. Data collected includes version information, cluster status, service information, database information, trace files, log files, disk information, memory information, and restart information.
utils cuc create report
Command Modes
Administrator (admin:)
Usage Guidelines
After the command completes, detailed information gets saved in a .zip file, and the location of the zip file displays. Use the file get command to move the file to a computer on which you can uncompress the file and view the contents.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection only
Example
admin: utils cuc create report
Getting unity connection version. Please wait...Done
Getting cluster status. Please wait...Done
Getting service information. Please wait...Done
Getting installed locales. Please wait...Done
Getting database schema version. Please wait...Done
Getting database integrity. Please wait...Done
Getting database diagnostic log. Please wait...Done
Getting database message log. Please wait...Done
Getting trace files. Please wait...Done
Getting log files. Please wait...Done
Getting platform status. Please wait...Done
Compressing 75 files. Please wait...Done
Output is in file: cuc/cli/systeminfo_080318-140843.zip
To free disk space, delete the file after copying it to another computer
utils cuc networking clear_replication
This command stops all Digital Networking replication activities on the server.
utils cuc networking clear_replication
Command Modes
Administrator (admin:)
Usage Guidelines
This command stops the Connection Digital Networking Replication Agent, deletes the drop, queue, and pickup replication folders, clears the status of in-progress directory pushes to or pulls from this server, and restarts the Connection Digital Networking Replication Agent. Depending on the size of the replication folders, this operation may take several minutes.
Requirements
Command privilege level: 1
Allowed during upgrade: No
Applies to: Cisco Unity Connection
utils cuc networking dscp
This command causes Connection either to start or to stop including a DSCP value of 18 in packets sent between the Connection servers in a cluster, so a router configured to prioritize packets based on their DSCP value can prioritize Connection data and voice messages.
utils cuc networking dscp
{ on | off }
Syntax Description
Parameters
Description
on
Causes Connection to start including a DSCP value of 18 packets sent over the network.
off
Causes to stop including a DSCP value of 18 in packets sent over the network. 18 is the default value.
Command Modes
Administrator (admin:)
Usage Guidelines
This command makes the DSCP value available in the packets being passed between the Connection servers in a cluster. For the information to be used, you must configure the router. The command lets you control whether a DSCP value is included in outgoing packets, but you can not change the value.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Applies to: Cisco Unity Connection only
utils cuc reset password
This command resets the password for a specified user account. If Connection locked the account because of too many failed sign-in attempts, this command also unlocks the account.
This command resets replication on an entire cluster.
utils dbreplication clusterreset
Command Modes
Administrator (admin:)
Usage Guidelines
Note
Before you run this command, run the command utils dbreplication stop first on all subscribers servers and then on the publisher server.
You can use this command to debug database replication. However, you should only use it if you have already tried utils dbreplication reset all, and it failed to restart replication on the cluster. This command tears down and rebuilds replication for the entire cluster. After you use this command, you must restart each subscriber server. After all subscriber servers have been restarted, you must go to the publisher server and issue the CLI command utils dbreplication reset all.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication dropadmindb
This command drops the Informix syscdr database on any server in the cluster.
utils dbreplication dropadmindb
Command Modes
Administrator (admin:)
Usage Guidelines
You should run this command only if database replication reset or cluster reset fails and replication cannot be restarted.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication forcedatasyncsub
This command forces a subscriber server to have its data restored from data on the publisher server.
nodename [offloadpub] [timeoutvalue]
Syntax Description
Parameters
Description
nodename
Specifies a particular subscriber server to have its data restored from data on the publisher server. Enter all to restore data on all subscriber servers.
offloadpub
Minimizes the usage of the publisher server during the forcedatasyncsub process.
Note
Adding this option increases the time taken for forcedatasyncsub to finish
timeoutvalue
Specifies the recovery timeout value for each node in minutes (should be greater than the default timeout).
Default: 40 minutes.
Command Modes
Administrator (admin:)
Usage Guidelines
Use this command only after you have run the utils dbreplication repair command several times, but the utils dbreplication status command still shows non-dynamic tables that are not in sync
Note
Do not run this command if only dynamic tables are out of sync; dynamic tables can be out of sync during normal system operation.
You can only run this command from the publisher server. Enter all to force sync on all subscriber servers in the cluster. If only one subscriber server is out of sync, use the nodename parameter.
Note
This command erases all existing data on the subscriber server and replaces it with the database from the publisher server. This erasure makes it impossible to determine the root cause for the subscriber server tables going out of sync.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication quickaudit
This command runs a quick database check on selected content on dynamic tables.
utils dbreplication quickaudit
{ nodename | all }
Syntax Description
Parameters
Description
nodename
Specifies the node on which the quick audit should be run.
all
Causes the audit to be run on all nodes
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
utils dbreplication repair
This command repairs database replication.
utils dbreplication repair
{ nodename | all }
Syntax Description
Parameters
Description
nodename
Specifies a particular subscriber server for data repair.
all
Causes data repair to take place on all subscriber servers.
Command Modes
Administrator (admin:)
Usage Guidelines
If the command utils dbreplication status
shows that servers are connected but one or more tables have data
that is out of sync, the utils dbreplication repair repairs the data on the
subscriber servers so that the data is in sync with the data on the
publisher server.
Specify all to repair all nodes
in the cluster, or if only one subscriber server is out of sync,
specify the nodename parameter.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication repairreplicate
This command repairs mismatched data between cluster nodes and changes the node data to match the publisher data.
utils dbreplication repairreplicatereplicatename
[ nodename | all ]
Syntax Description
Parameters
Description
replicatename
Specifies the replicate to repair.
nodename
Specifies the node on which to repair replication.
all
Specifies to fix replication on all nodes.
Command Modes
Administrator (admin:)
Usage Guidelines
The parameter nodename may not specify the publisher; any subscriber node name
is acceptable.
Note
This command can be executed on the publisher.
Note
This command does not repair replication setup
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication repairtable
This command repairs mismatched data between cluster nodes and changes the node to match the publisher data.
utils dbreplication repairtabletablename
[ nodename | all ]
Syntax Description
Parameters
Description
tablename
Specifies the table to repair
nodename
Specifies the node on which to repair replication.
all
Specifies to fix replication on all nodes.
Command Modes
Administrator (admin:)
Usage Guidelines
Note
This command does not repair replication setup.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication reset
This command resets and restarts database replication. You can use this command to rebuild replication when the system has not set up replication properly.
utils dbreplication reset
{ nodename | all }
Syntax Description
Parameters
Description
nodename
Specifies a particular subscriber server to on which to have replication rebuilt.
all
Specifies that all subscriber servers in the cluster have replication rebuilt.
Command Modes
Administrator (admin:)
Usage Guidelines
This command is the best option to use when servers show an RTMT state of 4. If only one subscriber server shows an RTMT state of 4, you may reset that server by specifying the hostname parameter. To reset the entire cluster, use the all parameter.
Tip
Before you run this command, first run the command utils dbreplication stop on all subscriber servers that are reset and then on the publisher server.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication runtimestate
This command monitors progress of the database replication process and provides replication state in the cluster.
utils dbreplication runtimestatenodename
Syntax Description
Parameters
Description
nodename
Specifies the node to monitor.
Command Modes
Administrator (admin:)
Usage Guidelines
If you provide a node name, the system provides the replication state from the context of the selected node.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication setrepltimeout
This command sets the timeout for database replication on large clusters.
utils dbreplication setrepltimeouttimeout
Syntax Description
Parameters
Description
timeout
The new database replication timeout, in seconds. Ensure that the value is between 300 and 3600.
Default value: 300 (5 minutes)
Command Modes
Administrator (admin:)
Usage Guidelines
After the first subscriber server requests replication with the
publisher server, the system sets this timer. After the timer
expires, the first subscriber server, plus all other subscriber
servers that requested replication within that time period, begin
data replication with the publisher server in a batch. If you have
several subscriber servers, batch replication is more efficient
than individual server replication. For large clusters, you can use
the command to increase the default timeout value, so that more
subscriber servers are included in the batch.
Tip
Cisco recommends that you restore this value back to the default of 300 (5 minutes) after you finish upgrading the entire cluster, and the subscriber servers have successfully set up replication.
Note
After you upgrade the publisher server and restart it on the upgraded partition, you should set this timer value before you switch the first subscriber server to the new release. After the first subscriber server requests replication, the publisher server sets the replication timer based on the new value.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication status
This command shows the status of database replication and indicates whether the servers in the cluster are connected and the data is in sync.
utils dbreplication status
{ all | node | replicate }
Syntax Description
Parameters
Description
all
Specifies to show the status of all servers.
node
Specifies the node for which to show status.
replicate
Specifies the replicate for which to show status.
Command Modes
Administrator (admin:)
Usage Guidelines
Note
You should run this command only on the first node (publisher server) of a cluster.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on Unified CM, Cisco Unity Connection
utils dbreplication stop
This command stops the automatic setup of database replication. Run this command on subscriber and publisher servers before executing the CLI command utils dbreplication reset or utils dbreblication clusterreset. You can run this command on the subscriber servers simultaneously, before you run it on the publisher server.
utils dbreplication stop
{ nodename | all }
Syntax Description
Parameters
Description
nodename
Specifies the name of the node on which to stop the automatic setup of database replication.
all
Stops database replication on all nodes.
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
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 network
Displays information about the backup files that are stored on a remote server.
Specifies a list of features to back up, separated by commas.
devicename
Represents the name of the device (mandatory) to back up.
Command Modes
Administrator (admin:)
Usage Guidelines
The system prompts you to enter the password for the account on the remote server.
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 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
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 show_tapeid
This command displays a list of tape device IDs.
utils disaster_recovery show_tapeid
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 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 fior*
utils fior
This command allows you to monitor the I/O on the server. The File I/O Reporting service provides a kernel-base daemon for collecting file I/O per process.
Enables the file I/O reporting service to start automatically when
the machine boots. This command does not start the service without
a reboot. Use the start option to start the
service immediately.
disable
Prevents the file I/O reporting service from starting automatically
when the machine boots. This command does not stop the service
without a reboot. Use the stop option to stop
the service immediately.
start
Starts a previously stopped file I/O reporting service. The service
remains in a started state until it is manually stopped or the
machine is rebooted.
stop
Stops the file I/O reporting service. The service remains in a
stopped state until it is manually started or the machine is
rebooted.
status
Displays the status of the file I/O reporting service.
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 fior list
This command displays a list of the file I/O events, in chronological order, from oldest to newest.
utils fior liststart= [date-time] stop=date-time
Syntax Description
Parameters
Description
startdate-time\
Specifies a starting date and time, in any of the following formats: H:M, H:M:S a, H:M, a, H:M:S Y-m-d, H:M, Y-m-d, H:M:s
stopdate-time\
Specifies a stopping date and time, in any of the following formats: H:M, H:M:S a, H:M, a, H:M:S Y-m-d, H:M, Y-m-d, H:M:s
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 fior top
This command displays a list of top processes that create file I/O. You can sort this list by the total number of bytes read, the total number of bytes written, the rate of bytes read, or the rate of bytes written.
Sorts the list of top processes by the total number of bytes read.
write
Sorts the list of top processes by the total number of bytes written
read-rate
Sorts the list of top processes by the rate of bytes read.
write-rate
Sorts the list of top processes by the rate of bytes written
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 fips
Warning
Unified CM 8.6(1) is the only version at this time that has
been through FIPS 140-2 Level 1 compliance. FIPS mode is only
supported on releases that have been through FIPS compliance. Be warned that FIPS mode
should be disabled prior to upgrading to a non-FIPS compliance
version of Unified CM.
This command enables, disables, or displays the status of FIPS 140-2 mode. FIPS 140-2 mode is disabled by default; only an administrator can enable FIPS.
utils fips
{ enable | disable | status }
Syntax Description
Parameters
Description
enable
Activates FIPS 140-2 mode.
disable
Deactivates FIPS 140-2 mode.
status
Displays the status of FIPS 140-2 mode.
Command Modes
Administrator (admin:)
Usage Guidelines
Before enabling FIPS mode, Cisco recommends that you perform a system backup. If FIPS checks fail at start-up, the system halts and requires a recovery CD to be restored.
Consider the following information before you enable FIPS 140-2 mode:
After FIPS mode is enabled on a server, please wait until the server reboots and the phones re-register successfully before enabling FIPS on the next server.
In FIPS mode, the IM and Presence service uses Red Hat Openswan (FIPS validated) in place of Racoon (non-FIPS validated). If the security policies in Racoon contain functions that are not FIPS approved, the CLI command asks you to redefine the security policies with FIPS approved functions and abort.
Note
Certificates and SSH key are regenerated automatically, in accordance with FIPS requirements.
Consider the following information after you enable FIPS 140-2 mode: If you have a single server cluster and chose to apply "Prepare Cluster for Rolback to pre 8.0" enterprise parameter before enabling FIPS mode, disable this parameter after making sure that all the phones registered successfully with the server.
Consider the following information before you disable FIPS 140-2 mode: In multiple server clusters, each server must be disabled separately; FIPS mode is not disabled cluster-wide but on a per server basis.
Requirements
Command privilege level: 0
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 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 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 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 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 ha*
utils ha failover
This command initiates a manual failover for a specified node, where the Cisco Server Recovery Manager stops the critical services on the failed node and moves all users to the backup node.
utils ha failover
{ node name }
Syntax Description
Parameters
Description
node name
Specifies the node on which to perform the manual failover.
Command Modes
Administrator (admin:)
Requirements
Applies to: IM and Presence service on Unified CM
Failover example
admin: ha failover shorty-cups
Initiate Manual Failover for Node > shorty-cups
Request SUCCESSFUL.
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Taking Over Reason: On Admin Request
Node 2 Name : shorty-cups State: Failover Reason: On Admin Request
utils ha fallback
This command initiates a manual fallback for a specified node, where the Cisco Server Recovery Manager restarts the critical services on the active node and moves users back to the active node.
utils ha fallbacknode name
Syntax Description
Parameters
Description
node name
Specifies the node on which to perform a manual fallback.
Command Modes
Administrator (admin:)
Requirements
Applies to: IM and Presence service on Unified CM
Fallback example
admin: ha fallback shorty-cups
Initiate Manual fallback for Node >shorty-cups<
Request SUCCESSFUL.
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Falling Back Reason: On Admin Request
Node 2 Name : shorty-cups State: Taking Back Reason: On Admin Request
utils ha recover
This command initiates a manual recovery of the subcluster (when nodes are in a Failed state) where IM and Presence restarts the Cisco Server Recovery Manager service on that subcluster.
utils ha recover subcluster name
Syntax Description
Parameters
Description
subcluster name
Specifies the subcluster on which to monitor HA status. If no Subcluster Name is provided, all cluster information is provided.
Command Modes
Administrator (admin:)
Requirements
Applies to: IM and Presence service on Unified CM
Recover example
admin: ha recover Defaultcluster
Stopping services... Stopped
Starting services... Started
admin:
utils ha status
This command displays the HA status for a specified subcluster.
utils ha statussubcluster name
Syntax Description
Parameters
Description
subcluster name
Specifies the subcluster on which to monitor HA status. If no Subcluster name is provided, all cluster information is displayed.
Command Modes
Administrator (admin:)
Requirements
Applies to: IM and Presence service on Unified CM
Status example with HA not enabled
admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Unknown Reason: High Availability Not Enabled
Node 2 Name : shorty-cups State: Unknown Reason: High Availability Not Enabled
Status example with HA enabled
admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Normal
Node 2 Name : shorty-cups State: Normal
Status example with a critical service down
admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Failed Over with Critical Services not Running Reason:
Critical Service Down
Node 2 Name : shorty-cups State: Running in Backup Mode Reason: Critical Service Down
Status example failed
admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Failed Reason: Critical Service Down
Node 2 Name : shorty-cups State: Failed Reason: Critical Service Down
utils ils*
utils ils findroutestring
This command returns all route strings that are associated with this directory URI, including the route string for the local cluster.
utils ils findroutestringDirectory URI
Syntax Description
Parameters
Description
Directory URI
Specifies a directory URI address that can be dialed in an outgoing call.
Command Modes
Administrator (admin:)
Usage Guidelines
This command can be used to troubleshoot problems involving duplicate directory URIs.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM
utils ils findxnode
This command returns the current xnode for the local cluster.
utils ils findxnode
Command Modes
Administrator (admin:)
Usage Guidelines
This command can be used for troubleshooting ILS communications with remote clusters. The xnode is the server within the cluster that communicates ILS updates with remote clusters. Once you know the xnode, you can run diagnostic traces on the xnode.
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM
utils ils lookup
This command returns the route string that is used for call routing when this directory URI is dialed from this cluster.
utils ilslookupDirectory URI
Syntax Description
Parameters
Description
Directory URI
Specifies a directory URI that can be dialed in an outgoing call
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM
utils ils showpeerinfo
This command returns the peer info vector for either a single cluster in an ILS network, or for all the clusters in an ILS network.
utils ils showpeerinfoclustername
Syntax Description
Parameters
Description
clustername
Specifies the fully qualified domain name of the publisher node for a Unified CM cluster in an ILS network.
Command Modes
Administrator (admin:)
Usage Guidelines
The peer info vector contains information about a cluster in an ILS network. The available information includes clustername, cluster ID and IP addresses for the cluster nodes. If you want information about a specific cluster in an ILS network, enter the clustername parameter. If you want information on all the clusters in the network, leave the clustername parameter empty
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM
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.
Causes the NTP service to not restart after you add the servers.
Command Modes
Administrator (admin:)
Usage Guidelines
If
you use norestart, an explicit restart of the NTP service is
required for the changes to take effect.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM
Example: Attempting to add servers with incorrect command
line parameters
admin: admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8
Incorrect number of parameters entered for add
usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]
admin: utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8
Incorrect number of parameters entered for add
usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]
admin: utils ntp server add clock1.cisco.com clock2.cisco.com
clock1.cisco.com : added successfully.
clock2.cisco.com : added successfully.
Restarting NTP on the server.
admin: utils ntp server add clock1.cisco.com clock2.cisco.com
clock1.cisco.com : [The host has already been added as an NTP server.]
clock2.cisco.com : [The host has already been added as an NTP server.]
admin: utils ntp server add bglr-ccm26
bglr-ccm26 : [This server cannot be added as an NTP server.]
admin: utils ntp server add clock3.cisco.com
clock3.cisco.com : [ Inaccessible NTP server. Not added. ]
admin: utils ntp server add ntp01-syd.cisco.com ntp02-syd.cisco.com clock.cisco.com norestart
ntp01-syd.cisco.com : added successfully.
ntp02-syd.cisco.com : added successfully.
clock.cisco.com : added successfully.
The NTP service will need to be restarted for the changes to take effect.
admin:utils ntp server add clock3.cisco.com
The maximum permissible limit of 5 NTP servers is already configured.
utils ntp server delete
This command deletes NTP servers that are configured.
utils ntp server delete
Command Modes
Administrator (admin:)
Usage Guidelines
This command allows you to delete a configured
NTP server or all of them. When you choose the server to delete, you are prompted to indicate if you want to restart the NTP service. If you choose no,
the NTP service does not get restarted after the server is deleted.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Applies to: Unified CM
Example: Deleting servers with incorrect command line
parameters
admin: utils ntp server delete clock1.cisco.com clock2.cisco.com
Incorrect number of optional parameters entered for delete
usage: utils ntp server delete
admin: utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit
Choice: 1
Restart NTP (y/n): y
clock1.cisco.com will be deleted from the list of configured NTP servers.
Continue (y/n)?y
clock1.cisco.com : deleted successfully.
Restarting NTP on the server.
admin: utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit
Choice: a
Restart NTP (y/n): n
This will result in all the configured NTP servers being deleted.
Continue (y/n)?y
clock1.cisco.com : deleted successfully.
clock2.cisco.com : deleted successfully.
ntp01-syd.cisco.com : deleted successfully.
ntp02-syd.cisco.com : deleted successfully.
clock.cisco.com : deleted successfully.
The NTP service will need to be restarted for the changes to take effect.
admin: utils ntp server delete
There are no NTP servers configured to delete.
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 reset_application_ui_administrator_name
This command resets the application user interface administrator name.
utils reset_application_ui_administrator_name
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 reset_application_ui_administrator_password
This command resets the application user interface administrator password.
utils reset_application_ui_administrator_password
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 reset_ui_administrator_name
This command resets the administrator user name you use to sign in to the administration user interface for the installed product.
Note
To change the administrator user name for Cisco Unity Connection, use Cisco Unity Connection Administration.
utils reset_ui_administrator_name
Command Modes
Administrator (admin:)
Usage Guidelines
For IM and Presence, if the user name is reset, you must manually update the user name of the Cisco Ajax XMPP Libraries (AXL) on each intercluster peer (if any) to match it: Select Unified CM IM and Presence Administration > Presence > Inter-clustering.
Requirements
Applies to: Unified CM and IM and Presence service on Unified CM
utils reset_ui_administrator_password
This command resets the administrator password you use to sign in to the administration user interface for the installed product.
Note
To change the password for a Cisco Unity Connection user, use the utils cuc reset password command.
utils reset_ui_administrator_password
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM and IM and Presence service on Unified CM
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 soap realtimeservice test
This command executes a number of test cases on the remote server.
utils soap realtimeservice test [remote-ip] remote-httpsremote https-password
Syntax Description
Parameters
Description
remote-ip
Specifies the IP address of the server under test.
remote-https-user
Specifies a username with access to the SOAP API.
remote-https-password
Specifies the password for the account with SOAP API access.
Command Modes
Administrator (admin:)
Requirements
Command privilege level: 0
Allowed during upgrade: No
Applies to: Unified CM, IM and Presence service on IM and Presence, Cisco Unity Connection
utils sso
This command affects SSO based authentication.
utils sso
{ enable | disable | status }
Syntax Description
Parameters
Description
enable
Enables SSO based authentication.
disable
Disables SSO based authentication
status
Provides the status of SSO on this node.
Command Modes
Administrator (admin:)
Usage Guidelines
Note
If Tomcat is not running because the OpenAM server is inaccessible, and if you executed util SSO disable to disable SSO, then Tomcat takes more time to appear. The approximate time for Tomcat to appear is 10 minutes.
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
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
utils vmtools*
utils vmtools status
This command displays the status of VMware Tools.
utils vmtools status
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection.
Example
admin:utils vmtools status
VMWare tools are OK. No further action is needed
utils vmtools upgrade
This command updates the currently installed VMware Tools to the latest version prescribed by the ESXi host for that VM.
utils vmtools upgrade
Command Modes
Administrator (admin:)
Requirements
Applies to: Unified CM, IM and Presence service on Unified CM, and Cisco Unity Connection
Feedback
