Starting a CLI Session

You can access the Cisco Unified Operating System CLI remotely or locally:

•From a web client workstation, such as the workstation that you use for Cisco Unified Operating System Administration, you can use SSH to connect securely to the Cisco Unified Operating System.

•You can access the Cisco Unified Operating System CLI directly by using the monitor and keyboard that you used during installation or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.

Before You Begin

Ensure you have the following information that gets defined during installation:

•A primary IP address and hostname

•An administrator ID

•A password

You will need this information to log in to the Cisco IPT Platform.

Perform the following steps to start a CLI session:

Step 1 Do one of the following actions depending on your method of access:

•From a remote system, use SSH to connect securely to the Cisco IPT Platform. In your SSH client, enter

ssh adminname@hostname

where adminname specifies the Administrator ID and hostnamespecifies 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 host name 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 section contains basic tips for using the command line interface.

Completing Commands

To complete commands, use Tab:

•Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, set gets completed.

•Enter a full command name and press Tab to display all the commands or subcommands that are available. For example, if you enter set and press Tab, you see all the set subcommands. An * identifies the commands that have subcommands.

•If you reach a command, keep pressing Tab, and the current command line repeats; this indicates that no additional expansion is available.

Getting Help on Commands

You can get two kinds of help on any command:

•Detailed help that includes a definition of the command and an example of its use

•Short query help that includes only command syntax

Procedure

To get detailed help, at the CLI prompt, enter

helpcommand

Where command specifies the command name or the command and parameter. See Example 1-1.

Note If you enter the help command without specifying the name of a particular command as the optional parameter, the system provides information about the CLI system.

To query only command syntax, at the CLI prompt, enter

command?

Where command represents the command name or the command and parameter. See Example 1-2.

Note If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available.

Example 1-1 Detailed Help Example:

admin:help file list activelog

activelog help:

This will list active logging files

options are:

page - pause output

detail - show detailed listing

reverse - reverse sort order

date - sort by date

size - sort by size

file-spec can contain '*' as wildcards

Example:

admin:file list activelog platform detail

02 Dec,2004 12:00:59 <dir> drf

02 Dec,2004 12:00:59 <dir> log

16 Nov,2004 21:45:43 8,557 enGui.log

27 Oct,2004 11:54:33 47,916 startup.log

dir count = 2, file count = 2

Example 1-2 Query Example:

admin:file list activelog?

Syntax:

file list activelog file-spec [options]

file-spec mandatory file to view

options optional page|detail|reverse|[date|size]

Exiting a Command with the Ctrl-C Key Sequence

You can stop most interactive commands by entering the Ctrl-C key sequence, as shown in the following example:

Example 3 Exiting a Command with Ctrl-C

admin:utils system upgrade initiate

Warning: Do not close this window without first exiting the upgrade command.

Source:

1) Remote Filesystem

2) DVD/CD

q) quit

Please select an option (1 - 2 or "q" ):

Exiting upgrade command. Please wait...

Control-C pressed

admin:

Note If you execute the command utils system switch-version and enter Yes to start the process, entering Ctrl-C exits the command but does not stop the switch-version process.

Ending a CLI Session

At the CLI prompt, enter quit. If you are logged in remotely, you get logged off, and the ssh session gets dropped. If you are logged in locally, you get logged off, and the login prompt returns.

The following sections list and describe the CLI commands that are available for the Cisco Unified Operating System.

Conventions

This document uses the following conventions:

Convention

Description

boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[ ]

Elements in square brackets are optional.

{ x | y | z }

Alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

screen font

Terminal sessions and information the system displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen font.

This pointer highlights an important line of text in an example.

^

The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

< >

Nonprinting characters, such as passwords, are in angle brackets.

Notes use the following conventions:

Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

Timesavers use the following conventions:

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

Tips use the following conventions:

Tip Meansthe information contains useful tips.

Cautions use the following conventions:

Caution Means
reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Warnings use the following conventions:

Warning This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents.

Before you run this command, you must stop the Connection Conversation Manager and Connection Mixer services. After you run this command, you must restart the Connection Conversation Manager and Connection Mixer services.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example deletes the en-GB locale and all of the associated files and settings.

delete cuc locale en-GB

en-GB uninstalled

delete dns

This command allows you to delete the IP address for a DNS server.

Command Syntax

delete dns ip-address

Parameters

•ip-address represents the IP address of the DNS server that you want to delete.

Usage Guidelines

The system asks whether you want to continue to execute this command.

Caution If you continue, this command causes a temporary loss of network connectivity.

Requirements

Command privilege level: 1

Allowed during upgrade: No

delete ipsec policy_group

This command deletes all policies within the specified group.

Command Syntax

delete ipsec policy_group [group]

Parameters

•[group] (mandatory) [ALL or group]

Usage Guidelines

Use the all option to delete all the groups.

Requirements

Command privilege level : 1

Allowed during upgrade: No

delete ipsec policy_name

This command deletes an ipsec policy with given policy name.

Command Syntax

delete ipsec policy_name [policy_name]

Parameters

•[policy_name] (mandatory) [ALL or policy name]

Requirements

Command privilege level: 1

Allowed during upgrade: No

delete process

This command allows you to delete a particular process.

Command Syntax

delete process process-id [force | terminate | crash]

Parameters

•process-id represents the process ID number.

Options

•force—Tells the process to stop.

•terminate—Tells the operating system to terminate the process.

•crash—Crashes the process and produces a crash dump.

Usage Guidelines

Note Use the force option only if the command alone does not delete the process and use the terminate option only if force does not delete the process.

•directory/filename represents the path to the file(s) to search. You can use the wildcard character, *, to represent all or part of the filename.

Options

•abstime—Specifies which files to search based on file creation time. Enter a start time and an end time.

•days|hours|minutes—Specifies whether the file age is in days, hours, or minutes.

•ignorecase—Ignores case when searching.

•reltime—Specifies which files to search based on file creation time. Enter the age of files to search.

•hh:mm:ss mm/dd/yyyy—An absolute time, in the format hours:minutes:seconds month/day/year.

•timevalue—The age of files to search. Specify the unit of this value with the {days | hours | minutes}option.

Usage Guidelines

Write the search term in the form of a regular expression, which is a special text string for describing a search pattern.

If the search term is found in only one file, the filename appears at the top of the output. If the search term is found in multiple files, each line of the output begins with the filename in which the matching line was found.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

file search activelog platform/log/platform.log Err[a-z] ignorecase

file tail

This command tails (prints the last few lines) of a log file.

Command Syntax

file tail

activelogdirectory/filename [detail] [hex] [lines]

inactivelogdirectory/filename [detail] [hex] [lines]

installdirectory/filename [detail] [hex] [lines]

tftpdirectory/filename [detail] [hex] [lines]

Parameters

•activelog specifies a log on the active side.

•inactivelog specifies a log on the inactive side.

•install specifies an installation log.

•tftp specifies a TFTP file.

•directory/filename specifies the path to the file to tail. You can use the wildcard character, *, for filename as long as it resolves to one file.

Options

•detail—Long listing with date and time

•hex—Hexadecimal listing

•lines—Number of lines to display

Requirements

Command privilege level: 1 for logs, 0 for TFTP files

Allowed during upgrade: Yes

Example

This example tails the operating system CLI log file.

file tail activelog platform/log/cli00001.log

file view

This command displays the contents of a file.

Command Syntax

file view

activelogdirectory/filename

activelog auditdirectory/filename

inactivelogdirectory/filename

inactivelog audit directory/filename

installdirectory/filename

licensefilename

system-management-log

tftp directory/filename

Parameters

•activelog specifies a log on the active side.

•activelog audit specifies an audit log on the active side.

•inactivelog specifies a log on the inactive side.

•inactivelog audit specifies an audit log on the inactive side.

•install specifies an installation log.

•license filenameviews the license file that is specified by license. You can enter the wildcard character (*) as filename to view all the license files.

•system-management-log displays the contents of the Integrated Management Logs (IML).

•tftp specifies a TFTP file.

•directory/filename specifies the path to the file to view. You can use the wildcard character, *, for filename as long as it resolves to one file.

Usage Guidelines

Caution Do not use this command to view binary files because this can corrupt the terminal session.

run cuc dbquery (Cisco Unity Connection Only)

•database_name specifies the database that sql_statement operates on. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

•sql_statement specifies the SQL query that you want to run.

Option

•page—Causes the output to display one page at a time. Be aware that Be aware that page is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example runs the SQL query select alias from vw_usertemplate on the unitydirdb database.

run cuc dbquery unitydirdb select alias from vw_usertemplate

alias

---------------------

AdministratorTemplate

VoiceMailUserTemplate

run cuc sysagent task (Cisco Unity Connection Only)

SK

This command runs a Sysagent task.

Command Syntax

run cuc sysagent tasktask_name

Parameters

•task_name specifies the name of the sysagent task that you want to run.

The following example runs the Sysagent task CleanDeletedMessagesTask.

run cuc sysagent task CleanDeletedMessagesTask

CleanDeletedMessagesTask started

run cuc vui rebuild (Cisco Unity Connection Only)

TF, added for 7.0

This command instructs the voice recognition transport utility to immediately rebuild the voice recognition name grammars with any pending changes.

Command Syntax

run cuc vui rebuild

Usage Guidelines

Running this command will only rebuild grammars that have changes flagged in the database. This command ignores any name grammar update blackout schedules and will execute immediately. Due to the overhead of retrieving potentially large amounts of name-related data from the database, you should use this command sparingly and only when absolutely necessary.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

run loadxml

Run this command as a workaround when service parameters or product-specific information does not appear in the administration window as expected.

Note The administrator account that the system creates when Unified CM installs has a privilege level of 4. The administrator can run all commands in the CLI.

Requirements

Command privilege level: 0

Allowed during upgrade: No

set account enable

This command enables the OS user account that was disabled because of password inactivity.

Command syntax

Set account enableuser-id

Parameters

•user-id specifies the user ID of the account that was disabled.

set accountlocking enable

This command enables accountlocking for the current admin accounts.

Command syntax

set accountlocking enable

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: No

set accountlocking disable

This command disables accountlocking for the current admin accounts.

Command syntax

set accountlocking disable

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: No

set cert regen

This command regenerates the certificate for the specified unit.

Command Syntax

set cert regen [name]

Parameters

name (mandatory) represents the unit name

Example

admin: set cert regen tomcat

Successfully regenerated certificate for tomcat.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set commandcount

This command changes the CLI command prompt, so it displays how many CLI commands have executed.

Command Syntax

set commandcount {enable | disable}

Parameters

•enable turns on command count.

•disable turns off command count.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set cli pagination

For the current CLI session, this command turns automatic pagination On or Off.

Command Syntax

set cli pagination {on | off}

Parameters

•on turns pagination On.

•off turns pagination Off.

Requirements

Level privilege: 1

Command privilege: 1

Allowed during upgrade: No

Example

admin:set cli pagination off

Automatic pagination is turned off

set cuc ldapfilter (Cisco Unity Connection Only)

This command filters the users in the LDAP directory whose accounts can be accessed by Connection.

Command Syntax

set cuc ldapfilter

Usage Guidelines

•You can only create one filter for each Connection server, so the LDAP filter must specify all of the users that you want to synchronize with Connection users that are homed on this Connection server.

•When you configure LDAP synchronization in Connection, you can further filter the LDAP users by your choice of user search bases.

•The filter must adhere to the LDAP filter syntax specified in RFC 2254, "The String Representation of LDAP Search Filters."

•The filter syntax is not verified, and no error message is returned. We recommend that you verify the LDAP filter syntax before you include it in this command.

•After you run this command, you must do the following steps for the LDAP users specified by the filter to be accessible to Connection:

a. Deactivate and reactivate the Cisco DirSync service. In Cisco Unified Serviceability, click Tools > Service Activation. Uncheck the check box next to Cisco DirSync, and click Save to deactivate the service. Then check the check box next to Cisco DirSync, and click Save to reactivate the service.

b. Perform a full synchonization in Cisco Unity Connection Administration.

•If you re-run this command and specify a filter that excludes some of the users who were accessible with the previous filter, the Connection users who are associated with the now-inaccessible LDAP users will be converted to standalone Connection users over the next two scheduled synchronizations or 24 hours, whichever is greater. The users will still be able to log on to Connection using the telephone user interface, callers can still leave messages for them, and their messages will not be deleted. However, they will not be able to log on to Connection web applications while Connection is converting them to standalone users, and after they have become standalone users, their web-application password will be the password that that was assigned when their Connection account was created.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

In the following example, values entered by the user are in bold.

set cuc ldapfilter

Please select the LDAP server type for which you wish to set the filter:

1 Microsoft Active Directory

2 Netscape or Sun ONE LDAP Server

3 OpenLDAP

Selection: 3

Current filter:

(objectclass=user)

New Filter:

(objectclass=inetOrgPerson)

Filter updated successfully.

set cuc trace (Cisco Unity Connection Only)

SK

This command enables or disables the specified traces and trace levels.

•trace_name specifies the name of the trace to enable or disable. Be aware that trace names are case sensitive.

•level specifies the level(s) of trace_name that you want to enable or disable. Each trace comprises up to 31 levels, numbered 0 to 30; each level provides a different type of information for the specified trace. When you are enabling or disabling multiple levels, use a comma to separate levels and a hyphen to indicate a range of levels. Do not include spaces.

Caution 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

set network dns

This command sets the IP address for the primary or secondary DNS server.

Command Syntax

set network dns {primary | secondary} ip-address

Parameters

•ip-address represents the IP address of the primary or secondary DNS server.

Usage Guidelines

The system asks whether you want to continue to execute this command.

Note If you change the IP address for the primary DNS server, you must also restart the Cisco Tomcat service. For more information, see the utils service command.

Caution If you continue, this command causes a temporary loss of network connectivity. If you change the IP address of the DNS server, you must restart Cisco Tomcat and Cluster Manager. For more information, see
utils service.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set network dns options

This command sets DNS options.

Command Syntax

set network dns options [timeoutseconds] [attemptsnumber] [rotate]

Parameters

•timeout sets the DNS request timeout.

•attempts sets the number of times to attempt a DNS request before quitting.

•rotate causes the system to rotate among the configured DNS servers, distributing the load.

•seconds specifies the DNS timeout period, in seconds.

•number specifies the number of attempts.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

set network domain

This command sets the domain name for the system.

Command Syntax

set network domaindomain-name

Parameters

•domain-name represents domain in which the system resides.

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.

The domain name must follow the rules for ARPANET host names.They must:

This commands sets the network host name and then causes a restart of the system.

Command Syntax

set network hostnamehostname

Parameters

•hostname represents the new network hostname of the system.

Note The host name must follow the rules for ARPANET host hames. It must start with an alphabetic character, end with an alphanumeric character, and consist of alphanumeric characters and hyphens. The host name can have have a maximum length of 63 characters.

set network ipv6

Note IPv6 is not supported in Cisco Unified Communications Manager Business Edition or Cisco Unity Connection.

Command Syntax

set network ipv6

dhcp {enable|disable} [reboot]

service {enable|disable} [reboot]

static_addressipv6_address mask [reboot]

Parameters

•dhcp enables or disables the DHCPv6 client on the server. By default, the server does not restart after you enable the DHCPv6 client. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.

•service enables or disables the IPv6 service on the server. By default, the server restarts after you enable or disable the IPv6 service. If you enter the noreboot parameter, the server does not restart automatically, and you must restart it manually before your changes take effect.

•static_address assigns a static IPv6 address to the server. By default, the server does not restart after you assign the static IPv6 address. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.

•ipv6_address specifies the static IPv6 address you assign to the server.

•mask specifies the IPv6 network mask (0-128).

•reboot causes the server to automaticfally restart after you enter the command.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set network mtu

This command sets the maximum MTU value.

Command Syntax

set network mtu mtu_max

Parameters

•mtu_max specifies the maximum MTU value.

Note The system default MTU value equals 1500.

Usage Guidelines

The system asks whether you want to continue to execute this command.

Caution If you continue, the system will temporarily lose network connectivity.

Requirements

Level privilege: 1

Command privilege: 1

Allowed during upgrade: No

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 max_ip_conntrack

This command sets the ip_conntrack_max value.

Command Syntax

set network max_ip_conntrack ip_conntrack_max

Parameters

•ip_conntrack_max specifies the value for ip_conntrack_max.

set network nic

This command sets the properties of the Ethernet Interface 0. You cannot configure Ethernet interface 1.

•speed specifies whether the speed of the Ethernet connection: 10 or 100 Mb/s.

•duplex specifies half-duplex or full-duplex.

Usage Guidelines

The system asks whether you want to continue to execute this command.

Note 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

set network pmtud

This command enables and disables Path MTU Discovery.

Command Syntax

set network pmtud [enable | disable]

Parameters

•enable enables Path MTU Discovery.

•disable disables Path MTU Discovery.

Usage Guidelines

The system asks whether you want to continue to execute this command.

Caution If you continue, the system will temporarily lose network connectivity.

Requirements

Level privilege: 1

Command privilege: 1

Allowed during upgrade: No

Example

admin:set network pmtud enable

*** W A R N I N G ***

This will cause the system to temporarily lose network connectivity

Do you want to continue ?

Enter "yes" to continue or any other key to abort

yes

executing...

admin:

set network restore

This command configures the specified Ethernet port to use a specified static IP address.

Caution Only use this command option if you cannot restore network connectivity by using any other
set network commands. This command deletes all previous network settings for the specified network interface, including Network Fault Tolerance. After running this command, you must restore your previous network configuration manually.

Caution The server temporarily loses network connectivity when you run this command.

Command Syntax

set network restore eth0 ip-addressnetwork-maskgateway

Parameters

•eth0 specifies Ethernet interface 0.

•ip-address specifies the IP address.

•network-mask specifies the subnet mask.

•gateway specifies the IP address of the default gateway.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

set network status

This command sets the status of Ethernet 0 to up or down. You cannot configure Ethernet interface 1.

Command Syntax

set network statuseth0 {up | down}

Parameters

•eth0 specifies Ethernet interface 0.

Usage Guidelines

The system asks whether you want to continue to execute this command.

Caution If you continue, the system will temporarily lose network connectivity.

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 perioddays command. This command configures the password inactivity globaly and updates individual OS users according to the setting.

set password user

This command allows you to change the administrator and security passwords.

Command Syntax

set passworduser {admin | security}

Parameters

•admin specifies the administrator password.

•security specifies the security password.

Usage Guidelines

The systems prompts you for the old and new passwords.

Note The password must contain at least six characters, and the system checks it for strength.

Servers in a cluster use the security password to authenticate communication between servers. You must reset the cluster after you change the security password.

Procedure

Step 1 Change the security password on the publisher server (first node) and then reboot the server (node).

Step 2 Change the security password on all the subsequent servers/nodes to the same password that you created on the first node and restart subsequent nodes, including application servers, to propagate the password change.

Note Cisco recommends that you restart each server after the password is changed on that server.

Caution 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

set smtp

This command sets the SMTP server hostname.

Command Syntax

set smtp hostname

Parameters

•hostname represents the SMTP server name.

Requirements

Command privilege level: 0

Allowed during upgrade: No

set timezone

This command lets you change the system time zone.

Command Syntax

set timezone timezone

Parameters

•timezone specifies the new time zone.

Note Although the list of available time zones produced by the show timezone list command includes Factory, Cisco Unified Communications Manager does not support the Factory time zone.

Usage Guidelines

Enter enough characters to uniquely identify the new time zone. Be aware that the time-zone name is case-sensitive.

Caution You must restart the system after you change the time zone.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Example

This example sets the time zone to Pacific time.

set timezone Pac

set trace

This command sets trace activity for the specified task.

Command Syntax

set trace

enable Errortname

enable Specialtname

enable State_Transitiontname

enable Significanttname

enable Entry_exittname

enable Arbitrarytname

enable Detailedtname

disabletname

Parameters

•tname represents the task for which you want to enable or disable traces.

Tip You can use this command to enter multiple organizational units. To enter more than one organizational unit name, separate the entries with a comma. For entries that already contain a comma, enter a backslash before the comma that is included as part of the entry. To enter multiple values for organizational unit, enclose them in quotation marks, as shown in the example for this command.

•orgname represents the 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.

Note When you set an alternate-host-name parameter with the setweb-security command, self-signed certificates for tomcat will contain the Subject Alternate Name extension with the alternate-host-name specified. CSR for Cisco Unified Communications Manager will contain Subject Alternate Name Extension with the alternate host name included in the CSR.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Example

This example shows the set web-security command with multiple organizational unit names that include commas.

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example shows the configuration settings for the group SA.

show cuc config settings SA

SA Setting Value

------------------ -----

SessionTimeout 20

Use24HrClockFormat 0

show cuc dbconsistency (Cisco Unity Connection Only)

This command checks the tables and indexes of a specified database for inconsistencies.

Command Syntax

show cuc dbconsistencydatabase_name

Parameters

•database_name specifies the name of the database that you want to check. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

Usage Guidelines

When the command completes, the system saves detailed information in a log file and displays a summary of the results, including the location of the log file. Use the file commands to display the contents of the file.

Caution Checking database consistency makes a significant impact on system performance. Run this command only when little or no system activity is occurring. After the operation begins, you cannot cancel it. Do not restart the server during the operation; the operation must complete successfully before Connection will function properly.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example checks the consistency of the unityrptdb database.

show cuc dbconsistency unityrptdb

Checking consistency of unityrptdb tables. Please wait.

Consistency check of unityrptdb tables successful.

Validation of unityrptdb indexes successful.

Output is in file: cuc/cli/consistency_unityrptdb_070404-123636.txt

show cuc dbcontents (Cisco Unity Connection Only)

This command exports the data from a specified database to a CSV file.

Command Syntax

show cuc dbcontentsdatabase_name

Parameters

•database_name specifies the name of the database whose data you want to export to a CSV file. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

Usage Guidelines

When the command completes, the location of the CSV file displays. Use the file commands to display the contents of the file.

Caution Saving the contents of a database to a CSV file affects system performance. Run this command only when little or no system activity is occurring.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example exports the data from the unitydirdb database to a CSV file and displays the location of the file.

show cuc dbcontents unitydirdb

This operation may take a few minutes to complete. Please wait.

Output is in file: cuc/cli/contents_unitydirdb_070404-124027.csv

show cuc dbschema (Cisco Unity Connection Only)

This command exports the SQL statements that are necessary to replicate the schema for a specified database to a file.

Command Syntax

show cuc dbschemadatabase_name

Parameters

•database_name specifies the name of the database whose schema you want to export. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

Usage Guidelines

When the command completes, the location of the file displays. Use the file commands to display the file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example exports the schema of the unitydirdb database to a file and displays the location of the file.

show cuc dbschema unitydirdb

Output is in file: cuc/cli/schema_unitydirdb_061013-115815.sql

show cuc dbserver disk (Cisco Unity Connection Only)

This command displays summary information about Informix storage space for all Connection databases on the current server.

Command Syntax

show cuc dbserver disk [page | file]

Options

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

•file—Saves the output to a file. If you include this option, the summary includes the location of the file. Be aware that file is case sensitive.

show cuc dbserver user list (Cisco Unity Connection Only)

This command displays a list of the active Connection internal database users.

Command Syntax

show cuc dbserver user list [page]

Option

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Usage Guidelines

The names of internal database users generally correspond with the names of Connection components.

Results get sorted first by database and then by user.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbserver user list

Database User Session PID

----------- ------------------ ------- ----

unitydirdb tomcat 18 4707

unitydirdb cunotifier 5064 8690

unitydirdb cumta 5028 8504

unitydirdb cumixer 5018 8190

unitydirdb cuscavenger 5114 8943

show cuc dbserver user waiting (Cisco Unity Connection Only)

This command displays a list of the Connection internal users, if any, that are waiting for a resource.

Command Syntax

show cuc dbserver user waiting [page]

Option

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Usage Guidelines

The names of internal database users generally correspond with the names of Connection components.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbserver user waiting

User Session Waiting On

Name ID Latch Lock Buffer Chkpt Trans In Crit

------------------ ------- ----- ---- ------ ----- ----- -------

cucsmgr 5403 N N N N N N

cudbeventpublisher 4989 N N N N N N

cugalsvc 5097 N N N N N N

show cuc dbtable contents (Cisco Unity Connection Only)

This command exports the contents of a specified Connection table to a CSV file.

Command Syntax

show cuc dbtable contentsdatabase_nametable_name

Parameters

•database_name specifies the database that contains the table whose contents you want to export to a CSV file. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

•table_name specifies the table whose contents you want to export to a CSV file.

When the command completes, the location of the CSV file displays. Use the file commands to display the contents of the file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbtable contents unitydirdb tbl_cos

Output is in file: cuc/cli/contents_tbl_cos_1013-113910.csv

show cuc dbtable list (Cisco Unity Connection Only)

This command displays a list of the tables in a specified database.

Command Syntax

show cuc dbtable listdatabase_name [page]

Parameter

•database_name specifies the database for which you want a list of tables. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

Option

•page—Causes the output to display one page at a time. Be aware that page is is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbtable list unitydirdb

tbl_accountlogonpolicy

tbl_agency

tbl_agencyextensionrange

tbl_alias

tbl_alternatename

tbl_broadcastmessage

tbl_broadcastmessagerecipient

...

tbl_waveformat

show cuc dbtable schema (Cisco Unity Connection Only)

This command displays a description for a specified table and a list of the columns in the table.

Command Syntax

show cuc dbtable schemadatabase_nametable_name [page]

Parameters

•database_name specifies the database that contains the table whose schema you want to display. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example displays the schema for the table tbl_user in the database unitydirdb.

show cuc dbtable schema unitydirdb tbl_cos

A collection of service privileges for subscribers that control access to

features and use of the system into classes. Class Of Service objects

determine which features a subscriber is licensed to use, the maximum length

of their greetings and messages, what numbers they are allowed to dial, and

what options are available to the subscriber among other things.

Columns:

displayname

movetodeletefolder

accessunifiedclient

...

accesslivereply

show cuc dbview contents (Cisco Unity Connection Only)

This command saves the results from a specified SQL view in a CSV file.

Command Syntax

show cuc dbview contentsdatabase_nameview_name

Parameters

•database_name specifies the database that contains the view whose results you want to save to a file. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

•view_name specifies the view whose results you want to save to a file.

When the command completes, the location of the CSV file displays. Use the file commands to display the contents of the file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example saves the results from the view vw_cos, in the database unitydirdb, to a CSV file.

show cuc dbview contents unitydirdb vw_cos

Output is in file: cuc/cli/contents_vw_cos_061013-113910.csv

show cuc dbview list (Cisco Unity Connection Only)

This command displays a list of the views in a specified database.

Command Syntax

show cuc dbview listdatabase_name [page]

Parameter

•database_name specifies the database for which you want a list of views. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

Option

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example displays a list of the views in the unitydirdb database.

show cuc dbview list unitydirdb

vw_agency

vw_agencyextensionrange

vw_alias

vw_alternatename

vw_broadcastmessage

vw_broadcastmessagerecipient

vw_callaction

...

vw_waveformat

show cuc dbview schema (Cisco Unity Connection Only)

This command displays the schema for a specified view.

Command Syntax

show cuc dbview schemadatabase_nameview_name [page]

Parameters

•database_name specifies the database that contains the view for which you want to display the schema. Be aware that database names are case sensitive. Connection databases include

–unitydirdb—contains the directory and configuration data.

–unitydyndb—contains dynamic data that Connection uses internally.

–unitymbxdb1 to unitymbxdb5—contains the data about the current voice messages in the corresponding mailbox store, including pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

–unityrptdb—contains audit log data.

•view_name specifies the view for which you want to display the schema.

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example displays the schema for the view vw_user in the database unitydirdb.

show cuc dbview schema unitydirdb vw_cos

A simple view for tbl_Cos.

Columns:

objectid

accessfaxmail

accesstts

callholdavailable

callscreenavailable

canrecordname

...

requiresecuremessages

show cuc locales (Cisco Unity Connection Only)

This command displays a list of the locales currently installed.

Command Syntax

show cuc locales

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc locales

Installed Locale Package Locale

------------------------- ------

uc-locale-en_GB-6.0.0.0-0 en-GB

uc-locale-fr_CA-6.0.0.0-0 fr-CA

show cuc sysagent task list (Cisco Unity Connection Only)

This command displays a list of the Sysagent tasks.

Command Syntax

show cuc sysagent task list [page]

Option

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Usage Guidelines

To run a sysagent task, use the run cuc sysagent task (Cisco Unity Connection Only) command. If the value of the Is Singleton column is Y for a specified task, the task can only be run on the primary server in a multi-server cluster. If this server is standalone, then all tasks will run on this server.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc sysagent task list

Task Name Is Singleton

-------------------------------------- ------------

BroadcastMessagePurge N

CallManagerSubscriberTemplateSynchTask Y

CallManagerUserSynchTask Y

CleanDeletedMessagesTask Y

CleanDirectoryStreamFilesTask N

CleanOrphanAttachmentFilesTask Y

...

UpdateDatabaseStats N

show cuc sysagent task results (Cisco Unity Connection Only)

This command displays the time(s) at which the specified task started and completed, with the most recent time listed first.

Command Syntax

show cuc sysagent task resultstask_name [page]

Parameters

•task_name specifies the task for which you want to display information about when the task was started and completed.

The following example displays the times at which the Sysagent task CleanDeletedMessages started and completed.

show cuc sysagent task results CleanDeletedMessagesTask

Time Started Time Completed

----------------------- -----------------------

2006-10-25 17:31:45.689 2006-10-25 17:31:45.785

2006-10-25 17:16:45.702 2006-10-25 17:16:45.742

2006-10-25 17:01:45.690 2006-10-25 17:01:45.730

show cuc tech dbschemaversion (Cisco Unity Connection Only)

This command displays the schema version information for each database.

Command Syntax

show cuc tech dbschemaversion [page]

Option

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc tech dbschemaversion

unitydirdb

==========

Schema Version Product Version Date

-------------- --------------- ---------------------

1.2.363 2.1 2007-02-13 19:10:50.0

show cuc tech dbserver all (Cisco Unity Connection Only)

This command runs all the show cuc tech commands in sequence and saves the results in a text file.

Command Syntax

show cuc tech dbserver all

Usage Guidelines

When the command completes, detailed information gets saved in a text file, and the location of the text file displays. Use the file commands to display the contents of the file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc tech dbserver all

Output is in file: cuc/cli/dbserverall_061013-111801.txt

show cuc tech dbserver integrity (Cisco Unity Connection Only)

This command checks the integrity of the Informix database server storage space structure.

Command Syntax

show cuc tech dbserver integrity

Usage Guidelines

When the command completes, detailed information gets saved in a text file, and a summary of the results displays, including the location of the file. Use the file commands to display the contents of the file.

Be aware that the following warning is expected and should be ignored in the output file:

WARNING: No syssyntable records found

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc tech dbserver integrity

Database system catalog tables were successfully validated.

Database disk extents were successfully validated.

Database reserved pages were successfully validated.

Output is in file: cuc/cli/integrity_061013-95853.txt

show cuc tech dbserver log diagnostic (Cisco Unity Connection Only)

This command checks for the existence of Informix assertion-failure and shared-memory-dump logs.

Command Syntax

show cuc tech dbserver log diagnostic

Usage Guidelines

If the logs exist, their location displays. Use the file commands to display the contents of the files.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc tech dbserver log diagnostic

The following Informix logs are available for the UC database server:

core/af.3599c

core/af.36858

show cuc tech dbserver log message (Cisco Unity Connection Only)

This command displays the last n lines of the Informix message log.

Command Syntax

show cuc tech dbserver log message [lines] [page]

Parameter

•lines specifies the number of lines that display at the end of the Informix message log. If the lines parameter is not included, the last 20 lines of the log are displayed.

Option

•page—Causes the output to display one page at a time. Be aware that page is case sensitive.

show cuc version (Cisco Unity Connection Only)

This command displays the Cisco Unity Connection version that is currently installed on the active and inactive partitions.

Command Syntax

show cuc version

Usage Guidelines

This command always displays the version in the active partition. If the active partition contains an upgrade, the command will also show the version in the inactive partition. The current Engineering Special, if any, also displays.

show tech gateway

show tech locales

This command displays the locale information for devices, device pools, and end users.

Command Syntax

show tech locales

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech network

This command displays network aspects of the server.

Command Syntax

show tech network

all [page] [searchtext] [filefilename]

hosts [page] [searchtext] [filefilename]

interfaces [page] [searchtext] [filefilename]

resolv [page] [searchtext] [filefilename]

routes [page] [searchtext] [filefilename]

sockets {numeric}

Parameters

•all displays all network tech information.

•hosts displays information about hosts configuration.

•interfaces displays information about the network interfaces.

•resolv displays information about hostname resolution.

•routes displays information about network routes.

•sockets displays the list of open sockets.

Options

•page—Displays one page at a time.

•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.

•numeric—Displays the numerical addresses of the ports instead of determining symbolic hosts. This parameter is equivalent to running the Linux shell command netstat [-n] command.

Usage Guidelines

The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech notify

This command displays the database change notify monitor.

Command Syntax

show tech notify

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech params all

This command displays all the database parameters.

Command Syntax

show tech params all

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech params enterprise

This command displays the database enterprise parameters.

Command Syntax

show tech params enterprise

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech params service

This command displays the database service parameters.

Command Syntax

show tech params service

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech prefs

This command displays database settings.

Command Syntax

show tech prefs

show tech procedures

This command displays the procedures that are in use for the database.

Command Syntax

show tech procedures

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech repltimeout

Displays the replication timeout.

Command Syntax

show tech repltimeout

Parameters

None

Usage Guidelines

When it gets increased, it ensures that as many servers as possible in a large system will get included in the first round of replication setup. If you have the maximum number of servers and devices, set the replication timeout to the maximum value. Be aware that this will delay the initial set up of replication (giving a chance for all servers to be ready for setup).

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech routepatterns

This command displays the route patterns that are configured for the system.

Command Syntax

show tech routepatterns

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech routeplan

This command displays the route plan that are configured for the system.

Command Syntax

show tech routeplan

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech runtime

This command displays runtime aspects of the server.

Command Syntax

show tech runtime

all [page] [filefilename]

cpu [page] [filefilename]

disk [page] [filefilename]

env [page] [filefilename]

memory [page] [filefilename]

Parameters

•all displays all runtime information.

•cpu displays CPU usage information at the time the command is run.

•disk displays system disk usage information.

•env displays environment variables.

•memory displays memory usage information.

Options

•page—Displays one page at a time.

•filefilename—Outputs the information to a file.

Usage Guidelines

The file option saves the information to platform/cli/filename.txt. Ensure that the file name cannot contain the "." character.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech systables

This command displays the name of all tables in the sysmaster database.

Command Syntax

show tech systables

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech system

The show tech system command gets updated as described in this section. This command displays system aspects of the server.

Command Syntax

show tech system

all [page] [filefilename]

bus [page] [filefilename]

hardware [page] [filefilename]

host [page] [filefilename]

kernel [page] [filefilename]

software [page] [filefilename]

tools [page] [filefilename]

Parameters

•all displays all the system information.

•bus displays information about the data buses on the server.

•hardware displays information about the server hardware.

•host displays information about the server.

•kernel lists the installed kernel modules.

•software displays information about the installed software versions.

•tools displays information about the software tools on the server.

Options

•page—Displays one page at a time.

•filefilename—Outputs the information to a file.

Usage Guidelines

The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech table

This command displays the contents of the specified database table.

Command Syntax

show tech tabletable_name [page] [csv]

Parameters

table_name represents the name of the table to display.

Options

•page—Displays the output one page at a time.

•csv—Sends the output to a comma separated values file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech triggers

This command displays table names and the triggers that are associated with those tables.

Command Syntax

show tech triggers

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech version

This command displays the version of the installed components.

Command Syntax

show tech version [page]

Options

Page—Displays the output one page at a time.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show timezone

This command displays time zone information.

Command Syntax

show timezone

config

list [page]

Parameters

•config displays the current time zone settings.

•list displays the available time zones.

Note Although the list of available time zones includes Factory, Cisco Unified Communications Manager does not support the Factory time zone.

Options

•page—Displays the output one page at a time.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show trace

This command displays trace information for a particular task.

Command Syntax

show trace [task_name]

Parameters

task_name represents the name of the task for which you want to display the trace information.

Note If you do not enter any parameters, the command returns a list of available tasks.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

This example displays trace information for CDP.

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 it is not already started.

This command provides full status only for 7835-H2 and 7825-H2 servers.

Command Syntax

show ups status

show version

Be aware that this command displays the software version on the active or inactive partition.

Command Syntax

show version

active

inactive

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show web-security

This command displays the contents of the current web-security certificate.

Command Syntax

show web-security

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show workingdir

This command retrieves the current working directory for activelog, inactivelog, install, and TFTP.

utils auditd

This command enables, disables, and provides the status of audit logging. When enabled, the system monitors and records user actions in both Cisco Unified Communications Manager and Cisco Unified Serviceability.

Cisco recommends that you retrieve the audit log by using the Real-Time Monitoring Tool, but you can also retrieve it by using the CLI.

Command Syntax

utils auditd {enable|disable|status}

Parameters

enable—Turns on audit logging.

disable—Turns off audit logging.

status—Displays whether audit logging is on or off.

utils core inactive list

This command displays a list of core files.

Command Syntax

utils core inactive list

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils core inactive analyze

This command displays backtrace for the specified core file. A list of core files can be obtained via the utils core inactive list command.

Command Syntax

utils core inactive analyzecore_file_name

Parameter

core_file_name (mandatory) specifies the name of the core file from which to get a stack trace.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils create report

This command creates reports about the server in the platform/log directory.

•csa collects all the files required for CSA diagnostics and assembles them ino a single CSA diagnostics file. You can retrieve this file by using the file get command.

Usage Guidelines

You are prompted to continue after you enter the command.

After creating a report, use the command file get activelog platform/log/filename, where filename specifies the report filename that displays after the command completes, to get the report.

Requirements

Level privilege: 1

Command privilege: 1

Allowed during upgrade: No

utils csa disable

This command stops Cisco Security Agent (CSA).

Command Syntax

utils csa disable

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils csa enable

This command enables Cisco Security Agent (CSA).

Command Syntax

utils csa enable

Usage Guidelines

The system prompts you to confirm that you want to enable CSA.

Caution You must restart the system after you start CSA.ca

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils csa status

This command displays the current status of Cisco Security Agent (CSA).

Command Syntax

utils csa status

Usage Guidelines

The system indicates whether CSA is running.

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils cuc cluster activate (Cisco Unity Connection Only)

This command activates this server in a Cisco Unity Connection cluster.

Command Syntax

utils cuc cluster activate

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils cuc cluster activate

utils cuc cluster deactivate (Cisco Unity Connection Only)

This command deactivates this server in a Cisco Unity Connection cluster.

Command Syntax

utils cuc cluster deactivate

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils cuc cluster deactivate

utils cuc cluster makeprimary (Cisco Unity Connection Only)

This command forces the specified server to take the primary server status in a Cisco Unity Connection cluster.

Command Syntax

utils cuc cluster makeprimary [server]

Parameters

•server specifies the name of the server to take the primary server status. If you do not specify a server, the other server in the Connection cluster takes the primary server status.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils cuc cluster makeprimary

utils cuc cluster overwritedb (Cisco Unity Connection Only)

This command overwrites the database on this server with the database on the other server in a Connection cluster.

Command Syntax

utils cuc cluster overwritedb

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 will restart after the database is overwritten. This method is useful if you restored one server from an old backup and must copy the older data to the other server. You may need to run the utils cuc cluster renegotiate (Cisco Unity Connection Only) command before you run this command.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils cuc cluster overwritedb

utils cuc cluster renegotiate (Cisco Unity Connection Only)

This command sets up a trust relationship between the servers in a Connection cluster.

Command Syntax

utils cuc cluster renegotiate

Usage Guidelines

Run this command on the subscriber server in a Connection cluster to set up a trust with the publisher server.

When the command completes, detailed information gets saved in a .zip file, and the location of the .zip file displays. Use the file getcommand 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

Example

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 (Cisco Unity Connection Only)

This command stops all Digital Networking replication activities occurring on the server.

Command Syntax

utils cuc networking clear_replication

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

utils cuc reset password (Cisco Unity Connection Only)

This command resets the password for a specified user account.

Syntax

utils cuc reset password

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

admin:utils cuc reset password jdoe

Enter password:

Re-enter password:

jdoe

07/29/2008 12:41:14.704 : Update SUCCEEDED

utils dbreplication clusterreset

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 will tear down and rebuild replication for the entire cluster. After using 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.

Command Syntax

utils dbreplication clusterreset

Usage Guidelines

Before you run this command, run the command utils dbreplication stop first on all subscribers servers and then on the publisher server.

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils dbreplication dropadmindb

This command drops the Informix syscdr database on any server in the cluster.

Command Syntax

utils dbreplication dropadmindb

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

utils dbreplication forcedatasyncsub

This command forces a subscriber server to have its data restored from data on the publisher server.

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. Use the all parameter to force sync on all subscriber servers in the cluster. If only one subscriber server is out of sync, use the hostname parameter.

After you run this command, you must restart the restored subscriber servers.

This command can take a significant amount of time to execute and can affect the system-wide IOWAIT.

Command Syntax

utils dbreplication forcedatasyncsub {all|hostname}

Parameters

•all causes all subscriber servers in the cluster to have their data restored from data on the publisher server.

•hostname specifies a particular subscriber server to have its data restored from data on the publisher server.

Usage Guidelines

The utils dbreplication forcedatasyncsub command takes a database backup of the publisher server and restores that data into the database on the subscriber server.

Note This command erases all existing data on the subscriber server and replaces it with the database from the publisher server, which makes it impossible to determine the original root cause for the subscriber server tables going out of sync.

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils dbreplication quickaudit

This command runs a quick database check on selected content on dynamic tables.

Command Syntax

utils dbreplication quickauditnodename | all

Parameters

•nodename specifies the node on which the quick audit should be run.

•all causes the audit to be run on all nodes.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils dbreplication repair

This command repairs database replication.

Command Syntax

utils dbreplication repair {all|hostname}

Parameters

•all causes data repair to take place on all subscriber servers.

•hostname specifies a particular subscriber server for data repair.

Usage Guidelines

If the command utils dbreplication status show that servers are connected but one or more tables have data that is out of sync, this command will repair the data on the subscriber servers so that it is in sync with the data on the publisher server.

Use the all parameter to repair all nodes in the cluster, or if only one subscriber server is out of sync, specifiy the hostname parameter.

Requirements

Command privilege level: 0

Allowed during upgrde: No

utils dbreplication repairreplicate

This command repairs mismatched data between cluster nodes and changes the node data to match the publisher data. It does not repair replication setup.

Command Syntax

utils dbreplication repairreplicate replicatename [nodename]|all

Parameters

•replicatename specifies the replicate to repair.

•nodename specifies the node on which to repair replication.

•all specifies fix replication on all nodes.

Usage Guidelines

Nodename may not specify the publisher; any subscriber nodename is acceptable.

If "all" is specified, the table gets repaired on all subscribers.

This command can be executed on publisher.

Requirements

Command privilege level: 0

Allowed During Upgrade: Yes

utils dbreplication repairtable

This command repairs mismatched data between cluster nodes; and changes the node. to match the publisher data. It does not repair replication setup.

Command Syntax

utils dbreplication repairtabletablename [nodename]|all

Parameters

•tablename specifies the table to repair.

•nodename specifies the node on which to repair replication.

•all specifies fix replication on all nodes.

Usage Guidelines

This command repairs mismatched data between cluster nodes; and changes the node. to match the publisher data. It does not repair replication setup.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils dbreplication reset

This command resets and restarts database replication. It can be used to tear down and rebuild replication when the system has not set up properly.

Command Syntax

utils dbreplication reset {all|hostname}

•all causes all subscriber servers in the cluster to have replication torn down and rebuilt.

•hostname specifies a particular subscriber server to have replication torn down and rebuilt.

Usage Guidelines

This is the best command to use when servers show an RTMT state of 4. If only one subscriber server is showing 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 will be reset and then on the publisher server.

When the first subscriber server requests replication with the publisher server, the system sets this timer. When 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 will be included in the batch.

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. When the first subscriber server requests replication, the publisher server will set the replication timer based on the new value.

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.

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils dbreplication status

This command displays the status of database replication and indicates whether the servers in the cluster are connected and the data is in sync. You should run this command only on the first node (publisher server) of a cluster.

Command Syntax

utils dbreplication status

Requirements

Command privilege level: 0

Allowed during upgrde: No

utils dbreplication stop

This command stops the automatic setup of database replication. Use this command on subscriber and publisher servers prior to 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.

Command Syntax

utils dbreplication stop [nodename | all]

Requirements

Command privilege level: 0

Allowed during upgrde: No

utils diagnose

This command enables you to diagnose and attempt to automatically fix system problems.

Command Syntax

utils diagnose

fix

list

module module_name

test

version

Parameters

•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.

utils disaster_recovery backup tape

This command starts a backup job and stores the resulting Tar file on tape.

Command Syntax

utils disaster_recovery backup tape featurelisttapeid

Parameters

•featurelist specifies the list of features to back up, separated by commas.

•tapeid represents the ID of an available tape device.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils disaster_recovery backup network

This command starts a backup job and stores the resulting Tar file on a remote server.

•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.

•enable—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.

•list—This command displays a list of file I/O events, in chronological order, from oldest to newest.

•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.

•status—Displays the status of the file I/O reporting service.

•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.

•top—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.

•start—Specifies a starting date and time.

•stop—Specifies a stopping date and time.

•date-time—specifies a date and time, in any of the following formats: H:M, H:M:Sa, H:M, a, H:M:SY-m-d, H:M, Y-m-d, H:M:S.

•number—Specifies how many of the top processes to list.

•[read | write | read-rate | write-rate]—Specifies the metric that is used to sort the list of top process.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils firewall ipv4

This commands sets options and displays status for the IPv4 firewall.

Command Syntax

utils network ipv4 firewall

debug [off|time]

disable [time]

enable

list

status

Parameters

•debug turns debugging on or off. If you do not enter the time parameter, this command turns on debugging for 5 minutes.

•disable turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.

•enable turns on the IPv6 firewall.

•list displays the current configuration of the firewall.

•status displays the current status of the firewall.

•time sets duration for the command in one of the following formats:

–Minutes: 0-1440m

–Hours: 0-23h

–Hours and minutes: 0-23h 0-60m

utils firewall ipv6

This commands sets options and displays status for the IPv6 network firewall.

Note IPv6 is not supported in Cisco Unified Communications Manager Business Edition or Cisco Unity Connection.

Command Syntax

utils network ipv6 firewall

debug [off|time]

disable [time]

enable

list

status

Parameters

•debug turns debugging on or off. If you do not enter the time parameter, this command turns on debugging for 5 minutes.

•disable turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.

•enable turns on the IPv6 firewall.

•list displays the current configuration of the firewall.

•status displays the current status of the firewall.

•time sets duration for the command in one of the following formats:

–Minutes: 0-1440m

–Hours: 0-23h

–Hours and minutes: 0-23h 0-60m

utils iostat

This command displays the iostat output for the given number of iterations and interval.

Command Syntax

utils iostat [interval] [iterations] [filename]

Parameters

•interval represents the value in seconds between two iostat readings (mandatory if you specify the number of iterations)

•interations represents the number of iostat iterations to be performed (mandatory if you specify an interval)

•filename redirects the output to a file

Requirements

Command privilege: 1

Allowed during upgrade: No

utils iothrottle threshold

This command is used to modify the low iowait threshold used by the iowait monitor tool during upgrades.

Caution Do not use this tool without Cisco Support supervision.

Command Syntax

utils iothrottle threshold

lowvalue modifies the low iowait threshold used by the iowait monitor tool during upgrades

status shows the current custom iowait threshold set by the utils iothrottle threshold low command.

utils iothrottle enable

This command enables I/O throttling enhancements. When enabled, I/O throttling enhancements lower the impact of upgrades on an active system.

Command Syntax

utils iothrottle enable

utils iothrottle disable

This command disables I/O throttling enhancements. This could adversely affect the system during upgrades.

Command Syntax

utils iothrottle disable

utils iothrottle status

This command displays the status of I/O throttling enhancements.

Command Syntax

utils iothrottle status

utils ldap config fqdn

This command configures the sytem to use an FQDN for LDAP authentication, which is the preferred method.

Note Because this method requires that DNS is configured, if the system is not configured to use DNS, execute utils ldap config ipaddr instead.

Command Syntax

utils ldap config fqdn

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils ldap config ipaddr

This command configures the sytem to use an IP address for LDAP authentication.

Note Because using an IP address for LDAP authentication is not the preferred method, use this command if the system is not, or cannot, be configured to use DNS. If your system is configured to use DNS, use utils ldap config fqdn instead.

Command Syntax

utils ldap config ipaddr

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils netdump client

This command configures the netdump client.

Command Syntax

utils netdump client

startip-address-of-netdump-server

status

stop

Parameters

•start starts the netdump client.

•status displays the status of the netdump client.

•stop stops the netdump client.

•ip-address-of-netdump-server specifies the IP address of the netdump server to which the client will send diagnostic information.

Usage Guidelines

If a kernel panic crash occurs, the netdump client sends diagnostic information about the crash to a netdump server.

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils netdump server

This command configures the netdump server.

Command Syntax

utils netdump server

add-clientip-address-of-netdump-client

delete-clientip-address-of-netdump-client

list-clients

start

status

stop

Parameters

•add-client adds a netdump client.

•delete-client deletes a netdump client.

•list-clients lists the clients that are registered with this netdump server.

•start starts the netdump server.

•status displays the status of the netdump server.

•stop stops the netdump server.

•ip-address-of-netdump-client specifies the IP address of a netdump client.

Usage Guidelines

If a kernel panic crash occurs, a netdump-enabled client system sends diagnostic information about the crash to the netdump server.

The netdump diagnostic information gets stored in the following location on the netdump server: crash/. The subdirectories whose names comprise a client IP address and a date contain netdump information.

You can configure each Cisco Unified Operating System server as both a netdump client and server.

If the server is on another Cisco Unified Operating System server, only the kernel panic trace signature gets sent to the server; otherwise, an entire core dump gets sent.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Parameters

•list lists the contents of the address resolution protocol table.

•set sets an entry in the address resolution protocol table.

•delete deletes an entry in the address resolution table.

•host represents the host name or IP address of the host to add or delete to the table.

•address represents the MAC address of the host to be added. Enter the MAC address in the following format: XX:XX:XX:XX:XX:XX.

For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL

•srcaddr—Specifies the source address of the packet as a host name or IPV4 address

•destaddr—Specifies the destination address of the packet as a host name or IPV4 address

•portnum—Specifies the port number of the packet, either source or destination

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network connectivity

This command verifies the node network connection to the first node in the cluster. Be aware that it is only valid on a subsequent node.

Command Syntax

utils network connectivity

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network host

This command resolves a host name to an address or an address to a host name.

Command Syntax

utils network hosthostname [serverserver-name] [page] [detail] [srv]

Parameters

•hostname represents the host name or IP address that you want to resolve.

Options

•server-name—Specifies an alternate domain name server.

•page—Displays the output one screen at a time.

•detail—Displays a detailed listing.

•srv—Displays DNS SRV records.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network ipv6 traceroute

This command to traces an IPv6 address or hostname.

Command Syntax

utils network ipv6 tracerouteipv6-address or hostname

Parameters

•ipv6-address specifies IPv6 address that you want to trace.

•hostname specifies the host name that you want to trace.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network ipv6 host

This command does an IPv6 host lookup (or IPv6 address lookup) for the specified host name or IPv6 address.

Note IPv6 is not supported in Cisco Unified Communications Manager Business Edition or Cisco Unity Connection.

Command Syntax

utils network ipv6 host {host_name|ipv6_address}

Parameters

•host_name specifies the name of the server.

•ipv6_address specifies the IPv6 address of the server.

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 or Cisco Unity Connection.

Command Syntax

utils network destination [count]

Parameters

•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.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network ping

This command allows you to ping another server.

Command Syntax

utils network pingdestination [count]

Parameters

•destination represents the hostname or IP address of the server that you want to ping.

Options

•count—Specifies the number of times to ping the external server. The default count equals 4.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network traceroute

This command traces IP packets that are sent to a remote destination.

Command Syntax

utils network tracertdestination

Parameters

•destination represents the hostname or IP address of the server to which you want to send a trace.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils ntp

This command displays the NTP status or configuration.

Command Syntax

utils ntp {status | config}

Note To avoid potential compatibility, accuracy, and network jitter problems, the external NTP servers that you specify for the primary node should be NTP v4 (version 4). If you are using IPv6 addressing, external NTP servers must be NTP v4.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils ntp restart

This command restarts the NTP service.

Command Syntax

utils ntp restart

Parameters

None

Requirements

Command privilege: 0

Allowed during upgrade: Yes

utils ntp start

If it is not already running, this command starts the NTP service.

Note You cannot stop the NTP service from the command line interface. Use this command when the utils ntp status command returns stopped.

server, which will be one higher than that of the currently active NTP server

being used for synchronization.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils remote_account

This command allows you to enable, disable, create, and check the status of a remote account.

Command Syntax

utils remote_account

status

enable

disable

createusernamelife

Parameters

•username specifies the name of the remote account. The username can contain only lowercase characters and must be more than six characters long.

•life specifies the life of the account in days. After the specified number of day, the account expires.

Usage Guidelines

A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account. You can have only one remote account that is enabled at a time.

Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at

Cisco Product Security Overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0907R)