Guest

Cisco Unified Communications Manager (CallManager)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions Release 8.0(1)

  • Viewing Options

  • PDF (1.3 MB)
  • Feedback
Command Line Interface Reference Guide for Cisco Unified Solutions Release 8.0(1)

Table Of Contents

Command Line Interface Reference Guide for Cisco Unified Solutions Release 8.0(1)

Contents

Starting a CLI Session

CLI Basics

Completing Commands

Getting Help on Commands

Exiting a Command with the Ctrl-C Key Sequence

Ending a CLI Session

Conventions

Delete Commands

delete account

delete cuc futuredelivery (Cisco Unity Connection Only)

delete cuc locale (Cisco Unity Connection Only)

delete dns

delete ipsec policy_group

delete ipsec policy_name

delete process

delete smtp

File Commands

file check

file delete

file dump

file fragmentation sdi

file fragmentation sdl

file get

file list

file search

file tail

file view

Run Commands

run cuc dbquery (Cisco Unity Connection Only)

run cuc sysagent task (Cisco Unity Connection Only)

run cuc vui rebuild (Cisco Unity Connection Only)

run loadxml

run sql

Set Commands

set account name

set account enable

set cert

set commandcount

set cli pagination

set cuc trace (Cisco Unity Connection Only)

set ipsec policy_group

set ipsec policy_name

set logging

set network dhcp

set network dns

set network dns options

set network domain

set network failover

set network gateway

set network hostname (Cisco Unified Communications Manager Only)

set network ip

set network ipv6

set network mtu

set network max_ip_conntrack

set network nic

set network pmtud

set network restore

set network status

set password expiry

set password age maximum

set password age minimum

set password complexity character

set password complexity minimum-length

set password history

set password inactivity

set password user

set registry

set smtp

set timezone

set trace

set web-security

set workingdir

Show Commands

show account

show cert

show cli pagination

show ctl

show cuc cluster status (Cisco Unity Connection Only)

show cuc config groups (Cisco Unity Connection Only)

show cuc config settings (Cisco Unity Connection Only)

show cuc dbconsistency (Cisco Unity Connection Only)

show cuc dbcontents (Cisco Unity Connection Only)

show cuc dbschema (Cisco Unity Connection Only)

show cuc dbserver disk (Cisco Unity Connection Only)

show cuc dbserver session (Cisco Unity Connection Only)

show cuc dbserver sessions all (Cisco Unity Connection Only)

show cuc dbserver sessions list (Cisco Unity Connection Only)

show cuc dbserver user list (Cisco Unity Connection Only)

show cuc dbserver user waiting (Cisco Unity Connection Only)

show cuc dbtable contents (Cisco Unity Connection Only)

show cuc dbtable list (Cisco Unity Connection Only)

show cuc dbtable schema (Cisco Unity Connection Only)

show cuc dbview contents (Cisco Unity Connection Only)

show cuc dbview list (Cisco Unity Connection Only)

show cuc dbview schema (Cisco Unity Connection Only)

show cuc locales (Cisco Unity Connection Only)

show cuc sysagent task list (Cisco Unity Connection Only)

show cuc sysagent task results (Cisco Unity Connection Only)

show cuc sysinfo (Cisco Unity Connection Only)

show cuc tech dbschemaversion (Cisco Unity Connection Only)

show cuc tech dbserver all (Cisco Unity Connection Only)

show cuc tech dbserver integrity (Cisco Unity Connection Only)

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

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

show cuc tech dbserver status (Cisco Unity Connection Only)

show cuc trace levels (Cisco Unity Connection Only)

show cuc version (Cisco Unity Connection Only)

show diskusage

show environment

show hardware

show itl

show ipsec policy_group

show ipsec policy_name

show logins

show media streams

show memory

show myself

show network

show network ipprefs

show network ipv6

show open

show packages

show password age

show password inactivity

show perf counterhelp

show perf list categories

show perf list classes

show perf list counters

show perf list instances

show perf query class

show perf query counter

show perf query instance

show perf query path

show process

show registry

show risdb

show smtp

show stats io

show status

show tech activesql

show tech all

show tech ccm_service

show tech database

show tech dberrcode

show tech dbintegrity

show tech dbinuse

show tech dbschema

show tech dbstateinfo

show tech devdefaults

show tech dumpCSVandXML

show tech gateway

show tech locales

show tech network

show tech notify

show tech params all

show tech params enterprise

show tech params service

show tech prefs

show tech procedures

show tech repltimeout

show tech routepatterns

show tech routeplan

show tech runtime

show tech systables

show tech system

show tech table

show tech triggers

show tech version

show timezone

show trace

show traceconfig

show ups status

show version

show web-security

show workingdir

Unset Commands

unset ipsec policy_group

unset ipsec policy_name

unset network dns options

unset network ipv6 static_address

Utils Commands

utils auditd

utils core active

utils core inactive list

utils core inactive analyze

utils create report

utils csa disable

utils csa enable

utils csa status

utils cuc cluster activate (Cisco Unity Connection Only)

utils cuc cluster deactivate (Cisco Unity Connection Only)

utils cuc cluster makeprimary (Cisco Unity Connection Only)

utils cuc cluster overwritedb (Cisco Unity Connection Only)

utils cuc cluster renegotiate (Cisco Unity Connection Only)

utils cuc create report (Cisco Unity Connection Only)

utils cuc networking clear_replication (Cisco Unity Connection Only)

utils cuc networking dscp (Cisco Unity Connection Only)

utils cuc reset password (Cisco Unity Connection Only)

utils dbreplication clusterreset

utils dbreplication dropadmindb

utils dbreplication forcedatasyncsub

utils dbreplication quickaudit

utils dbreplication repair

utils dbreplication repairreplicate

utils dbreplication repairtable

utils dbreplication reset

utils dbreplication runtimestate

utils dbreplication repairreplicate

utils dbreplication repairtable - ARE THERE TWO IN THIS DOC?

utils dbreplication setrepltimeout

utils dbreplication status

utils dbreplication stop

utils diagnose

utils disaster_recovery cancel_backup

utils disaster_recovery backup tape

utils disaster_recovery backup network

utils disaster_recovery cancel_backup

utils disaster_recovery device delete

utils disaster_recovery device list

utils disaster_recovery restore tape

utils disaster_recovery restore network

utils disaster_recovery schedule

utils disaster_recovery show_backupfiles network

utils disaster_recovery show_backupfiles tape

utils disaster_recovery show_registration

utils disaster_recovery show_tapeid

utils disaster_recovery status

utils fior

utils firewall ipv4

utils firewall ipv6

utils iostat

utils iothrottle enable

utils iothrottle disable

utils iothrottle status

utils netdump client

utils netdump server

utils network arp

utils network capture eth0

utils network connectivity

utils network host

utils network ipv6 traceroute

utils network ipv6 host

utils network ipv6 ping

utils network ping

utils network traceroute

utils ntp

utils ntp restart

utils ntp start

utils ntp status

utils remote_account

utils reset_application_ui_administrator_name

utils reset_application_ui_administrator_password

utils reset_ui_administrator_name (Cisco Unified Communications Manager Only)

utils reset_ui_administrator_password (Cisco Unified Communications Manager Only)

utils service list

utils service

utils snmp

utils soap realtimeservice test

utils system

utils system boot

utils system upgrade

Related Documentation

Obtaining Documentation, Obtaining Support, and Security Guidelines

Cisco Product Security Overview


Command Line Interface Reference Guide for Cisco Unified Solutions Release 8.0(1)


This document describes the Command Line Interface (CLI) commands that are available for the Cisco Unified Operating System.

Contents

This document comprises the following sections:

Starting a CLI Session

CLI Basics

Delete Commands

File Commands

Run Commands

Set Commands

Show Commands

Unset Commands

Utils Commands

Related Documentation

Obtaining Documentation, Obtaining Support, and Security Guidelines

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 hostname specifies the hostname that was defined during installation.

For example, ssh admin@ipt-1.

From a direct connection, you receive this prompt automatically:

ipt-1 login: 
 
   

where ipt-1 represents the 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

Getting Help on Commands

Exiting a Command with the Ctrl-C Key Sequence

Ending a CLI Session

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

help command

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 Means the 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.

Delete Commands

This section contains descriptions of the following commands:

delete account

delete cuc futuredelivery (Cisco Unity Connection Only)

delete cuc locale (Cisco Unity Connection Only)

delete dns

delete ipsec policy_group

delete ipsec policy_name

delete process

delete smtp

delete account

This command allows you to delete an administrator account.

Command Syntax

delete account account-name

Parameters

account-name represents the name of an administrator account.

Requirements

Command privilege level: 4

Allowed during upgrade: No

delete cuc futuredelivery (Cisco Unity Connection Only)

This command deletes all messages that have been marked for future delivery.

Command Syntax

delete cuc futuredelivery

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

delete cuc futuredelivery
 
Deleting File : UmssMtaFutureDelivery/UnityMbxDb1/5C56C086-E64B-11DC-9BAF-41FC55D89593.eml
Deleting File : UmssMtaFutureDelivery/UnityMbxDb1/6D7DD796-E64B-11DC-A0E6-D1FD55D89593.eml
Files : Found = 2, Deleted = 2
 
   
Note: Files that are in use cannot be deleted
 
   

delete cuc locale (Cisco Unity Connection Only)

This command deletes the specified locale and all of the associated files and settings from Connection.

Command Syntax

delete cuc locale locale-id

Parameters

locale-id represents the ID of the locale that you want to delete.

For a list of installed locales and their IDs, run the show cuc locales (Cisco Unity Connection Only) command. Be aware that locale IDs are case sensitive.

Usage Guidelines

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 | all]

Parameters

[group] (mandatory) [ALL or group]

Usage Guidelines

Use the all option to delete all the groups.

Requirements

Command privilege level : 1

Allowed during upgrade: No

delete ipsec policy_name

This command deletes an ipsec policy with given policy name.

Command Syntax

delete ipsec policy_name [policy_name | all]

Parameters

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

Requirements

Command privilege level: 1

Allowed during upgrade: 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.


Requirements

Command privilege level: 1

Allowed during upgrade: Yes

delete smtp

This command allows you to delete the SMTP host.

Command Syntax

delete smtp

Requirements

Command privilege level: 1

Allowed during upgrade: No

File Commands

This section contains descriptions of the following commands:

file check

file delete

file fragmentation sdi

file fragmentation sdl

file get

file list

file search

file tail

file view

file check

This command checks the /usr directory tree to see whether any files or directories have been added, removed, or changed in size since the last fresh installation or upgrade and displays the results.

Command Syntax

file check detection-size-kb

Options

detection-size-kb specifies the minimum file size change that is required for the command to display the file as changed.

Usage Guidelines

The command notifies you about a possible impact to system performance and asks you whether you want to continue.


Caution Because running this command can affect system performance, Cisco recommends that you run the command during off-peak hours.

The display includes both deleted and new files.

Defaults

The default value of detection-size-kb specifies 100 KB.

Requirements

Command privilege level: 0

Allowed during upgrade: No

file delete

This command deletes one or more files.

Command Syntax

file delete

activelog directory/filename {detail | noconfirm}

dir tftp directory detail

inactivelog directory/filename {detail | noconfirm}

install directory/filename {detail | noconfirm}

license filename detail

tftp directory/filename detail

Parameters

activelog specifies a log on the active side.

dir tftp directory deletes the TFTP directory that is specified by directory. You cannot enter the wildcard character (*) in directory.

inactivelog specifies a log on the inactive side.

install specifies an installation log.

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

tftp specifies a TFTP file.

directory/filename specifies the path and filename of the file(s) to delete. You can use the wildcard character, *, for filename.

Options

detail—Displays a listing of deleted files with the date and time.

noconfirm—Deletes files without asking you to confirm each deletion.

Usage Guidelines


Caution You cannot recover a deleted file except, possibly, by using the Disaster Recovery System.

You get prompted for confirmation after entering the command. You cannot delete directories or files that are in use.

If you delete a TFTP data file on the inactive side, you may need to manually restore that file if you switch versions to the inactive side.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example deletes the install log.

file delete install install.log
 
   

file dump

This command dumps the contents of a file to the screen, a page at a time.

Command Syntax

file dump

activelog directory/filename [detail] [hex]

inactivelog directory/filename [detail] [hex]

install directory/filename [detail] [hex]

sftpdetails filename [hex] [regexp expression] [recent]

tftp directory/filename [detail] [hex]

Parameters

activelog specifies a log on the active side.

inactivelog specifies a log on the inactive side.

install specifies an installation log.

sftpdetails specifies SFTP-related files.

tftp specifies a TFTP file.

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

filename specifies the filename of the file to dump.

Options

detail—Displays listing with the date and time

hex—Displays output in hexadecimal

regexp expression—Displays only the lines in the file that match the regular expression expression.

recent—Displays the most recently modified file in the directory.

Usage Guidelines

To determine which files you can dump with the sftpdetails parameter, first enter the following command:

file list sftpdetails *

The output lists the filenames that you can dump.

Requirements

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

Allowed during upgrade: Yes

Example

This command dumps contents of file _cdrIndex.idx.

file dump activelog cm/cdr/_cdrIndex.idx
 
   

file fragmentation sdi

This command displays file fragmentation information about SDI log files.

Command Syntax

file fragmentation sdi

all outfilename

file filename {verbose}

most fragmented number

most recent number

Parameters

all records information about all files in the directory in the file that is specified by outfilename.

file displays information about the file that is specified by filename.

most fragmented displays information about the most fragmented files.

most recent displays information about the most recently logged fragmented file.

number specifies the number of files to list.

Options

verbose—Displays more detailed information.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

file fragmentation sdl

This command displays file fragmentation information about SDL log files.

Command Syntax

file fragmentation sdl

all outfilename

file filename {verbose}

most fragmented number

most recent number

Parameters

all records information about all files in the directory in the file that is specified by outfilename.

file displays information about the file that is specified by filename.

most fragmented displays information about the most fragmented files.

most recent displays information about the most recently logged fragmented file.

number specifies the number of files to list.

Options

verbose—Displays more detailed information

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

file get

This command sends the file to another system by using SFTP.

Command Syntax

file get

activelog directory/filename [reltime] [abstime] [match] [recurs]

inactivelog directory/filename [reltime] [abstime] [match] [recurs]

install directory/filename [reltime] [abstime] [match] [recurs]

license filename [reltime] [abstime] [match] [recurs] [compress]

partBsalog directory/filename [reltime] [abstime] [match] [recurs]

salog directory/filename [reltime] [abstime] [match] [recurs]

tftp directory/filename [reltime] [abstime] [match] [recurs]

Parameters

activelog specifies a log on the active side.

inactivelog specifies a log on the inactive side.

install specifies an installation log.

license specifies license file.

partBsalog specifies the partBsalog log directory.

salog specifies the salog log directory.

tftp specifies a TFTP file.

directory/filename specifies the path to the file(s) to delete. You can use the wildcard character, *, for  filename as long as it resolves to one file.

Options

abstime—Absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY

reltime—Relative time period, specified as minutes | hours | days | weeks | months value

match—Match a particular string in the filename, specified as string value

recurs—Get all files, including subdirectories

compress—Transfer files as compressed file

Usage Guidelines

After the command identifies the specified files, you get prompted to enter an SFTP host, username, and password.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Examples

This command gets all files in the activelog operating system directory that match the string "plat".

admin: file get activelog platform match plat
 
   

This command gets all operating system log files for a particular time period.

admin: file get activelog platform/log abstime 18:00:10/20/13 18:00:10/21/13
 
   

file list

This command lists the log files in an available log directory.

Command Syntax

file list

activelog directory [page] [detail] [reverse] [date | size]

inactivelog directory [page] [detail] [reverse] [date | size]

install directory [page] [detail] [reverse] [date | size]

license filename [page] [detail] [reverse] [date | size]

partBsalog directory [page] [detail] [reverse] [date | size]

salog directory [page] [detail] [reverse] [date | size]

tftp directory [page] [detail] [reverse] [date | size]

Parameters

activelog specifies a log on the active side.

activelog audit specifies audit logs on the active side.

inactivelog specifies a log on the inactive side.

inactivelog audit specifies audit logs on the inactive side.

install specifies an installation log.

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

partBsalog specifies the partBsalog log directory.

salog specifies the salog log directory.

tftp specifies a TFTP file.

directory specifies the path to the directory to list. You can use a wildcard character, *, for directory as long as it resolves to one directory.

Options

detail—Long listing with date and time

date—Sort by date

size—Sort by file size

reverse—Reverse sort direction

page—Displays the output one screen at a time.

Requirements

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

Allowed during upgrade: Yes

Examples

This example lists operating system log files with details.

file list activelog platform/log page detail
 
   

This example lists directories in CDR repository.

file list activelog cm/cdr_repository
 
   

This example lists CDR files in a specified directory by size.

file list activelog cm/cdr_repository/processed/20050812 size
 
   

In Cisco Unity Connection and in Cisco Unified Communications Manager Business Edition, this example lists all files in the cuc log directory.

file list activelog cuc *
 
   

file search

This command searches the content of a log and displays the matching lines a page at a time.

Command Syntax

file search

iactivelog directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]

inactivelog directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]

install directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]

tftp directory/filename reg-exp [abstime hh:mm:ss mm/dd/yyyy hh:mm:ss mm/dd/yyyy] [ignorecase] [reltime {days | hours | minutes} timevalue]

Parameters

activelog specifies a log on the active side.

inactivelog specifies a log on the inactive side.

install specifies an installation log.

tftp specifies a TFTP file.

reg-exp represents a regular expression.

directory/filename represents the path to the 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

activelog directory/filename [detail] [hex] [lines]

inactivelog directory/filename [detail] [hex] [lines]

install directory/filename [detail] [hex] [lines]

tftp directory/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

activelog directory/filename

inactivelog directory/filename

install directory/filename

license filename

system-management-log

tftp directory/filename

Parameters

activelog specifies a log on the active side.

inactivelog specifies a log on the inactive side.

install specifies an installation log.

license filename views 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.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Examples

This example displays the install log.

file view install install.log
 
   

This example displays a particular CDR file.

file view activelog /cm/cdr_repository/processed/20058012/{filename}
 
   

Run Commands

This section contains descriptions of the following commands:

run cuc dbquery (Cisco Unity Connection Only)

run cuc sysagent task (Cisco Unity Connection Only)

run cuc vui rebuild (Cisco Unity Connection Only)

run loadxml

run sql

run cuc dbquery (Cisco Unity Connection Only)

SK

This command runs an SQL query and displays the results.

Command Syntax

run cuc dbquery database_name sql_statement [page]

Parameters

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 task task_name

Parameters

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

For a list of Sysagent tasks, run the command show cuc sysagent task list (Cisco Unity Connection Only). Be aware that sysagent task names are case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example runs the Sysagent task CleanDeletedMessagesTask.

run cuc sysagent task CleanDeletedMessagesTask
 
   
CleanDeletedMessagesTask started
 
   

run cuc vui rebuild (Cisco Unity Connection Only)

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.

You may need to restart of some services after this command.

Command Syntax

run loadxml

Requirements

Command privilege level: 1

Allowed during upgrade: No

run sql

This command allows you to run an SQL command.

Command Syntax

run sql sql_statement

Parameters

sql_statement represents the SQL command to run.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Example

This example runs an SQL command.

run sql select name from device
 
   

Set Commands

This section contains descriptions of the following commands:

set account name

set account enable

set cert

set commandcount

set cli pagination

set cuc trace (Cisco Unity Connection Only)

set ipsec policy_group

set ipsec policy_name

set logging

set network dhcp

set network dns

set network dns options

set network domain

set network failover

set network gateway

set network hostname (Cisco Unified Communications Manager Only)

set network ip

set network ipv6

set network mtu

set network max_ip_conntrack

set network nic

set network pmtud

set network restore

set network status

set password expiry

set password age maximum

set password age minimum

set password complexity character

set password complexity minimum-length

set password history

set password inactivity

set password user

set registry

set smtp

set timezone

set trace

set web-security

setset workingdir

set account name

This command sets up a new account on the operating system.

Command Syntax

set account name name

Parameters

name represents the username for the new account.

Usage Guidelines

After you enter the username, the system prompts you to enter the privilege level and password for the new account.

The privilege level definitions are as follows:

Privilege level 0: Specifies an ordinary privilege level. Users with ordinary privileges can run CLI commands with privilege level 0 only.

Privilege level 1: Specifies an advanced privilege level. Users with advanced privileges can run CLI commands with privilege level 1 and below.


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 enable user-id

Parameters

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

set cert

This command affect the certificates available in the preconfigured SFTP location.

Command syntax

set cert

bulk [unit]

Command privilege level: 1

Allowed during upgrade: Yes

export [unit]

Command privilege level: 1

Allowed during upgrade: Yes

import [unit]

Command privilege level: 1

Allowed during upgrade: Yes

regen [name]

Command privilege level: 1

Allowed during upgrade: No

sftp

Command privilege level: 1

Allowed during upgrade: Yes

Parameters

bulk consolidates all the certificates in the preconfigured SFTP location, and exportes the consolidated file to the same SFTP location.

export exports all the available certificates for this unit in this cluster to the preconfigured SFTP location.

import imports the certificates available in the SFTP location into the specified unit trust-store.

regen regenerates the certificate for the specified unit.

sftp prompts for the SFTP server information to be used for bulk operations.

Options

unit represents the unit name.

name represents the unit name.

Bulk Example

admin:set cert bulk all
 
   
Successfully consolidated certifactes for unit tomcat.
Successfully consolidated certifactes for unit tftp

Export Example

admin:set cert export all
 
   
Successfully exported tomcat certificate(s) to sftp server.
Successfully exported tftp certificate(s) to sftp server.

Import Example

admin:set cert import all
 
   
Successfully imported tomcat certificates.
Successfully imported tftp certificates.									

SFTP Example

admin:set cert sftp
SFTP Ip Address :1.1.1.1
SFTP server port [22] :
User Id :user
Password :*
Remote Directory :/tmp
Sftp configuration update is successful.

Regen Example

admin: set cert regen tomcat
Successfully regenerated certificate for tomcat.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set cli pagination off
Automatic pagination is turned off

set cuc trace (Cisco Unity Connection Only)

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

Command Syntax

set cuc trace {enable | disable} trace_name level

Parameters

enable enables Connection traces. Be aware that enable is case sensitive.

disable disables Connection traces. Be aware that disable is case sensitive.

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.

Usage Guidelines

To display a list of the traces and trace levels that are currently enabled, use the show cuc trace levels (Cisco Unity Connection Only) command.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example enables VUI traces 1, 13, and 17 through 20.

set cuc trace enable VUI 1,13,17-20
 
   
VUI trace levels are now set to: 1,13,17-20
 
   

The following example disables vui traces 17 through 20. VUI trace levels 1 and 13 are still set.

set cuc trace disable VUI 17-20
 
   
VUI trace levels are now set to: 1,13
 
   

set ipsec policy_group

This command enables ipsec policies with the specified policy group name.

Command Syntax

set ipsec policy_group [group]

Parameters

[group] (mandatory) ALL or group name

Requirements

Command privilege level: 1

Allowed during upgrade: No

set ipsec policy_name

This command enables the specified policy.

Command Syntax

set ipsec policy_name [policy_name]

Parameters

[policy_name] (mandatory) ALL or policy name

Requirements

Command privilege level: 1

Allowed during upgrade: No

set logging

This command allows you to enable or disable CLI Admin logs.

Command Syntax

set logging {enable | disable}

Parameters

enable turns on logging.

disable turns off logging.

Requirements

Command privilege level: 0

Allowed during upgrade: No

set network dhcp

This command enables or disables DHCP for Ethernet interface 0. You cannot configure Ethernet interface 1.

Command Syntax

set network dhcp eth0

enable

disable node_ip net_mask gateway_ip

Parameters

eth0 specifies Ethernet interface 0.

enable enables DHCP.

disable disables DHCP.

node_ip represents the new static IP address for the server.

net_mask represnets the subnet mask for the server.

gateway_ip represents the IP address of the default gateway.

Usage Guidelines

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


Caution If you continue, this command causes the system to restart. 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. 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 [timeout seconds] [attempts number] [rotate]

Parameters

timeout sets the DNS request timeout.

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

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

seconds specifies the DNS timeout period, in seconds.

number specifies the number of attempts.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

set network domain

This command sets the domain name for the system.

Command Syntax

set network domain domain-name

Parameters

domain-name represents the system domain that you want to assign.

Usage Guidelines

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


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

Requirements

Command privilege level: 1

Allowed during upgrade: No

set network failover

This command enables and disables Network Fault Tolerance on the Media Convergence Server network interface card.

Command Syntax

failover {enable | disable}

Parameters

enable enables Network Fault Tolerance.

disable disables Network Fault Tolerance.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set network gateway

This command enables you to configure the IP address of the network gateway.

Command Syntax

set network gateway ip-address

Parameters

ip-address represents the IP address of the network gateway that you want to assign.

Usage Guidelines

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


Caution If you continue, this command causes the system to restart.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set network hostname (Cisco Unified Communications Manager Only)


Note For information on changing the host name of a Cisco Unity Connection server, see the "Renaming Cisco Unity Connection Servers" chapter in the applicable Reconfiguration and Upgrade Guide for Cisco Unity Connection at http://www.cisco.com/en/US/products/ps6509/prod_installation_guides_list.html.


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

Command Syntax

set network hostname hostname

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.


Usage Guidelines

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


Caution If you continue, this command causes the system to restart.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Example

admin:set network hostname myname
 
   
             W A R N I N G   
 
   
This will cause the system to restart - Do you want to continue ?
Enter "yes" to continue and restart or any other key to abort
yes
executing...
Broadcast message from root (Thu Jun 24 13:00:21 2008):
 
   
The system is going down for restart NOW!
 
   

set network ip

This command sets the IP address for Ethernet interface 0. You cannot configure Ethernet interface 1.

Command Syntax

set network ip eth0 ip-address ip-mask

Parameters

eth0 specifies Ethernet interface 0.

ip-address represents the IP address that you want to assign.

ip-mask represents the IP mask that you want to assign.

Usage Guidelines

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


Caution If you continue, this command causes the system to restart.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set network ipv6

This command sets system and network options for IPv6 and provides administrators with following

functions:

writing IPv6 addresses in /etc/hosts

enabling DHCPv6 or assigning a static IPv6 address to the server.


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_address ipv6_address mask [reboot]

Parameters

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

service enables or disables the IPv6 service on the server. By default, the server restarts after you enable or disable the IPv6 service.

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

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

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

reboot causes the server to automatically restart after you enter the command.

Requirements

Command privilege level: 1

Allowed during upgrade: 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

Command privilege level: 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.

Command Syntax

set network nic eth0 [auto en | dis] [speed 10 | 100] [duplex half | full]

Parameters

eth0 specifies Ethernet interface 0.

auto specifies whether auto negotiation gets enabled or disabled.

speed specifies 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

Command privilege level: 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-address network-mask gateway

Parameters

eth0 specifies Ethernet interface 0.

ip-address specifies the IP address.

network-mask specifies the subnet mask.

gateway specifies the IP address of the default gateway.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

set network status

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

Command Syntax

set network status eth0 {up | down}

Parameters

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.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set password expiry

This command enables or disables password expiry for Unified CM OS accounts.

Command Syntax

set password expiry{enable|disable}

Parameters

enable turns on password expiry.

disable turns off password expiry.

Usage Guidelines

The set password expiry enable command sets the value of maximum password age to 3650 days (10 yrs) for Unified CM OS admin accounts.

The set password expiry disable command results in CUCM OS admin accounts never expiring.

Requirements

Command privilege level: 1

Allowed during upgrade: es

set password age maximum

This command modifies the value for maximum password age, in days, for Cisco Unified Operating System accounts.

Command Syntax

set password age maximum days

Parameters

days specifies the maximum password age and must be greater-than or equal-to 90 days.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set password age minimum

Use this command to modify the value of minimim password age for OS admin accounts in days.

Command syntax

set password age minimum days

Parameters

days mandatory Acceptable values equal 0 - 10.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

set password complexity character

This command to enables password complexity rules for the type of characters in a password.

Command Syntax

set password complexity character {enable|disable}

Parameters

enable turns on password complexity for characters.

disable turns off password complexity for characters.

Usage Notes

When you enable password complexity, you must follow these guidelines when assigning a password:

It must have at least one lower-case character.

It must have at least one uppercase, one digit, and one special character.

You cannot use adjacent characters on the keyboard.

You cannot reuse any of the previous ten passwords.

The admin user password can only be changed only once in 24 hours.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set password complexity minimum-length

This command modifies the value for the minimum password length for Cisco Unified Operating System accounts.


Note Use this command only after you enable password character complexity.


Command Syntax

set password complexity minimum-length length

Parameters

length specifies the minimum number of characters and must be greater-than or equal-to 6.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set password history

This command modifies the number of passwords that get maintained in the history for OS admin accounts. New passwords matching remembered passwords get rejected.

Command syntax

set password history number

Parameters

number mandatory number of passwords to maintain in history

Useage Guidelines

To disable, enter 0.

Default specifies 10.

Upper limit specifies 20.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

set password inactivity

This command enables, disables and configures password inactivity.

Command syntax

set password inactivity [enable | disable | period days]

Parameters

days specifies the number of days of inactivity after a password has expired before the account gets disabled.

Usage guidelines

To enable password inactivity globaly, execute the set password inactivity enable command. This command enables the password inactivity globaly and updates individual OS users according to the setting.

To disable password inactivity globaly, execute the set password inactivity disable command. This command disables the password inactivity globaly and updates individual OS users according to the setting.

A user whose account is disabled must contact the system administrator to use the system again.

To configure the password inactivity period execute the set password inactivity period days command. This command configures the password inactivity 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 password user {admin | security}

Parameters

admin specifies the administrator password.

security specifies the security password.

Usage Guidelines

The systems prompts you for the old and new passwords.


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


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

Procedure


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

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


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



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 registry

This command sets a registry entry to a new value.

Command syntax

set registry {system | component} param value

Parameters

system specifies the registry system name.

component specifies the registry component name.

Options

param the name of the parameter to set.

value the value to assign to the param.

Example

admin:set registry cm dbl/sdi numlines 500
system = cm
   component = dbl/sdi
      numlines old value = 10000
      numlines new value = 500

Requirements

Command privilege level: 99

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 Error tname

enable Special tname

enable State_Transition tname

enable Significant tname

enable Entry_exit tname

enable Arbitrary tname

enable Detailed tname

disable tname

Parameters

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

enable Error sets task trace settings to the error level.

enable Special sets task trace settings to the special level.

enable State_Transition sets task trace settings to the state transition level.

enable Significant sets task trace settings to the significant level.

enable Entry_exit sets task trace settings to the entry_exit level.

enable Arbitrary sets task trace settings to the arbitrary level.

enable Detailed sets task trace settings to the detailed level.

disable unsets the task trace settings.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set web-security

This command sets the web security certificate information for the operating system.

Command Syntax

set web-security orgunit orgname locality state [country alternatehostname]

Parameters

orgunit represents the organizational unit (OU) name.


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


orgname represents the 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 set web-security command, self-signed certificates for tomcat will contain the Subject Alternate Name extension with the alternate-host-name specified. CSR for Cisco Unified Communications Manager will contain Subject Alternate Name Extension with the alternate 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.

set web-security "accounting,personnel\,CA,personnel\,MA" Cisco Milpitas CA
 
   

In the above example, the certificate will have three OU fields:

OU=accounting

OU=personnel, CA

OU=personnel, MA

set workingdir

This command sets the working directory for active, inactive, and installation logs.

Command Syntax

set workingdir

activelog directory

inactivelog directory

tftp directory

Parameters

activelog sets the working directory for active logs.

inactivelog set the working directory for inactive logs.

tftp sets the working directory for TFTP files.

directory represents the current working directory.

Requirements

Command privilege level: 0 for logs, 1 for TFTP

Allowed during upgrade: Yes

Show Commands

This section contains descriptions of the following commands:

show account

show cert

show cli pagination

show ctl

show cuc cluster status (Cisco Unity Connection Only)

show cuc config groups (Cisco Unity Connection Only)

show cuc config settings (Cisco Unity Connection Only)

show cuc dbconsistency (Cisco Unity Connection Only)

show cuc dbcontents (Cisco Unity Connection Only)

show cuc dbschema (Cisco Unity Connection Only)

show cuc dbserver disk (Cisco Unity Connection Only)

show cuc dbserver session (Cisco Unity Connection Only)

show cuc dbserver sessions all (Cisco Unity Connection Only)

show cuc dbserver sessions list (Cisco Unity Connection Only)

show cuc dbserver user list (Cisco Unity Connection Only)

show cuc dbserver user waiting (Cisco Unity Connection Only)

show cuc dbtable contents (Cisco Unity Connection Only)

show cuc dbtable list (Cisco Unity Connection Only)

show cuc dbtable schema (Cisco Unity Connection Only)

show cuc dbview contents (Cisco Unity Connection Only)

show cuc dbview list (Cisco Unity Connection Only)

show cuc dbview schema (Cisco Unity Connection Only)

show cuc locales (Cisco Unity Connection Only)

show cuc sysagent task list (Cisco Unity Connection Only)

show cuc sysagent task results (Cisco Unity Connection Only)

show cuc sysinfo (Cisco Unity Connection Only)

show cuc tech dbschemaversion (Cisco Unity Connection Only)

show cuc tech dbserver all (Cisco Unity Connection Only)

show cuc tech dbserver integrity (Cisco Unity Connection Only)

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

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

show cuc tech dbserver status (Cisco Unity Connection Only)

show cuc trace levels (Cisco Unity Connection Only)

show cuc version (Cisco Unity Connection Only)

Have to add show date - VIPR command

show diskusage

show environment

show hardware

show itl

show ipsec policy_group

show ipsec policy_name

show logins

show media streams

show memory

show myself

show network

show network ipprefs

show network ipv6

show open

show packages

show password age

show password inactivity

show perf counterhelp

show perf counterhelp

show perf list categories

show perf list classes

show perf list counters

show perf list instances

show perf query class

show perf query counter

show perf query instance

show perf query path

show process

show registry

show risdb

show smtp

Have to add show status

show stats io

show status

show tech activesql

show tech all

show tech ccm_service

show tech database

show tech dberrcode

show tech dbintegrity

show tech dbinuse

show tech dbschema

show tech dbstateinfo

show tech devdefaults

show tech dumpCSVandXML

show tech gateway

show tech locales

show tech network

show tech notify

show tech params all

show tech params enterprise

show tech params service

show tech prefs

show tech procedures

show tech repltimeout

show tech routepatterns

show tech routeplan

show tech runtime

show tech systables

show tech system

show tech table

show tech triggers

show tech version

show timezone

show trace

show ups status

show version

show web-security

show workingdir

show account

This command lists current administrator accounts, except the master administrator account.

Command Syntax

show account

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

show cert

This command displays certificate contents and certificate trust lists.

Command Syntax

show cert

own filename

trust filename

list {own | trust}

Parameters

filename represents the name of the certificate file.

own specifies owned certificates.

trust specifies trusted certificates.

list specifies a certificate trust list.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

This command displays owned certificate trust lists.

show cert list own

show cli pagination

This command diplays the status of automatic CLI pagination.

Command Syntax

show cli pagination

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin: show cli pagination
Automatic Pagination : Off.

show ctl

This command displays the contents of the Certificate Trust List (CTL) file on the server. It notifies you if the CTL is not valid.

Command Syntax

show ctl

show cuc cluster status (Cisco Unity Connection Only)

This command shows the status of the servers in the cluster..

Command Syntax

show cuc cluster status

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc cluster status
 
   
Server Name     Member ID  Server State  Internal State  Reason
--------------  ---------  ------------  --------------  ------
cuc-server-1    0          Primary       Pri Active      Normal
cuc-server-2    1          Secondary     Sec Active      Normal

show cuc config groups (Cisco Unity Connection Only)

This command displays a list of the valid configuration group names.

Command Syntax

show cuc config groups [page]

Option

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

Usage Guidelines

To see a list of the settings for a specified group, run the command show cuc config settings (Cisco Unity Connection Only).

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc config groups
 
   
CiscoLicensing         
ConfigurationAssistant 
Conversations          
Directory              
Groupware              
LogMgr                 
Messaging              
    :
    :
Telephony
 
   

show cuc config settings (Cisco Unity Connection Only)

This command displays the settings and values for a specified group of Connection configuration settings.

Command Syntax

show cuc config settings group_name [page]

Parameter

group_name specifies the name of the configuration group whose settings you want to display.

To see a list of valid group names, run the command show cuc config groups (Cisco Unity Connection Only). Be aware that group names are case sensitive.

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 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 dbconsistency database_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 dbcontents database_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 dbschema database_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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbserver disk
 
   
Dbspaces
========
Dbspace  Dbspace             Size    Used   Free    Percent
Number   Name                MB      MB     MB      Free
-------  ------------------  ------  -----  ------  -------
1        rootdbs             300.0   107.3  192.7   64
2        ciscounity_sbspace  20.0    19.0   1.0     5
 
   
Chunks
======
               Size    Free
Chunk  Offset  MB      MB      Path
-----  ------  ------  ------  -------------------------------------------------
1      0       300.0   192.7   /var/opt/cisco/connection/db/root_dbspace
2      250     20.0    1.0     /usr/local/cm/db/informix/databases/ciscounity_sbspace
 
   

show cuc dbserver session (Cisco Unity Connection Only)

This command displays summary information about a specified Informix database user session.

Command Syntax

show cuc dbserver session session_id [page | file]

Parameter

session_id specifies the database user session for which you want to display summary information. To get a list of current sessions, use either the show cuc dbserver sessions list (Cisco Unity Connection Only) command or the show cuc dbserver user list (Cisco Unity Connection Only) command.

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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

The following example displays summary information about database user session 63.

show cuc dbserver session 63
 
   
IBM Informix Dynamic Server Version 10.00.UC4W3   -- On-Line -- Up 5 days 20:38:40 -- 
255716 Kbytes
 
   
session                                      #RSAM    total      used       dynamic 
id       user     tty      pid      hostname threads  memory     memory     explain 
63       dbuser   -        11488    smilliga 1        184320     143808     off 
 
   
tid      name     rstcb    flags    curstk   status
108      sqlexec  4bedd2b0 Y--P---  4064     cond wait(netnorm)
 
   
Memory pools    count 1
name         class addr     totalsize freesize #allocfrag #freefrag 
63           V     4e774020 180224    38064    134        30        
 
   
name           free       used           name           free       used      
sql            0          40             rdahead        0          448       
 
   
Sess  SQL            Current            Iso Lock       SQL  ISAM F.E.
Id    Stmt type      Database           Lvl Mode       ERR  ERR  Vers Explain    
63    -              ccm0500v0000       CR  Wait 30    0    0    9.03 Off        
 
   
Last parsed SQL statement :
  select paramvalue from processconfig where
    paramName='RisCleanupTimeOftheDay'
 
   

show cuc dbserver sessions all (Cisco Unity Connection Only)

This command displays summary information about all the current Informix database user sessions.

Command Syntax

show cuc dbserver sessions all [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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbserver sessions all
 
   
IBM Informix Dynamic Server Version 10.00.UC4W3   -- On-Line -- Up 5 days 20:38:40 -- 
255716 Kbytes
 
   
session                                      #RSAM    total      used       dynamic
id       user     tty      pid      hostname threads  memory     memory     explain 
63       dbuser   -        11488    smilliga 1        184320     143808     off 
 
   
tid      name     rstcb    flags    curstk   status
108      sqlexec  4bedd2b0 Y--P---  4064     cond wait(netnorm)
 
   
Memory pools    count 1
name         class addr     totalsize freesize #allocfrag #freefrag
63           V     4e774020 180224    38064    134        30
 
   
name           free       used           name           free       used    
opentable      0          3256           filetable      0          704 
 
   
Sess  SQL            Current            Iso Lock       SQL  ISAM F.E.
Id    Stmt type      Database           Lvl Mode       ERR  ERR  Vers Explain    
63    -              ccm0500v0000       CR  Wait 30    0    0    9.03 Off        
 
   
Last parsed SQL statement :
  select paramvalue from processconfig where
    paramName='RisCleanupTimeOftheDay	'
 
   

show cuc dbserver sessions list (Cisco Unity Connection Only)

This command displays a list of the current Informix database user sessions.

Command Syntax

show cuc dbserver sessions 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. Run this command before you run the show cuc dbserver session (Cisco Unity Connection Only) command to obtain the required session id.

Results are sorted by session id.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc dbserver sessions list
 
   
Session  Database     User                PID
-------  -----------  ------------------  ----
14       unitydirdb   tomcat              4707
4986     unitydirdb   cudbeventpublisher  5818
 
   

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 contents database_name table_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.

For a list of the tables in a specified database, use the show cuc dbtable list (Cisco Unity Connection Only) command. Be aware that table names are case sensitive.

Usage Guidelines

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 list database_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 schema database_name table_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.

unityrptdb—contains audit log data.

table_name specifies the table whose schema you want to display.

For a list of the tables in a specified database, use the show cuc dbtable list (Cisco Unity Connection Only) command. Be aware that table names are case sensitive.

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 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 contents database_name view_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.

For a list of the views in a specified database, use the show cuc dbview list (Cisco Unity Connection Only) command. Be aware that view names are case sensitive.

Usage Guidelines

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 list database_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 schema database_name view_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.

For a list of the views in a specified database, use the show cuc dbview list (Cisco Unity Connection Only) command. Be aware that view names are case sensitive.

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 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 results task_name [page]

Parameters

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

For a list of task names, run the show cuc sysagent task list (Cisco Unity Connection Only) command. Be aware that task names are case sensitive.

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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

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

This command displays a summary of hardware and software system information for the current Connection server, including the version installed on the active and inactive partitions; whether a cluster is configured; QOS settings; hardware specifications; the amount of used and free disk space on the active, inactive, and common partitions; licensing information; and so on.

Command Syntax

show cuc sysinfo

Requirements

Command privilege level: 1

Allowed during upgrade: No

Example

Gather Date/Time : Wed Oct 21 09:45:29 PDT 2009
Connection Install Information:
 
   
  Host Name : connection1
 
   
  Version:
    Active Version : 8.0.0.98000-210
 
   
    Inactive Version : 8.0.0.98000-201
 
   
  High Availability (this server is) : Pri_Single_Server
 
   
    Publisher : connection1.cisco.com - 10.10.10.10
 
   
    Subscriber(s) : None
 
   
  QOS Settings :
    Call Signaling DSCP : CS3
    Media Signaling DSCP : EF
 
   
  Hardware :
    HW Platform          : 7825I3
    Processors           : 1
    Type                 : Family: Core 2
    CPU Speed            : 2130
    Memory               : 2048
    Object Id            : 1.3.6.1.4.1.9.1.746
    OS Version           : UCOS 4.0.0.0-31
    ...

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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc tech dbserver log message
 
   
Message Log File: online.ciscounity.log
 
   
18:09:01  Fuzzy Checkpoint Completed:  duration was 0 seconds, 6 buffers not flushed.
18:09:01  Checkpoint loguniq 57, logpos 0x208418, timestamp: 0x33b807
 
   
18:09:01  Maximum server connections 159
18:14:01  Fuzzy Checkpoint Completed:  duration was 0 seconds, 6 buffers not flushed.
18:14:01  Checkpoint loguniq 57, logpos 0x20a57c, timestamp: 0x33b9fc
 
   

show cuc tech dbserver status (Cisco Unity Connection Only)

This command saves a detailed status report of the database server instance to a file.

Command Syntax

show cuc tech dbserver status

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc tech dbserver status
 
   
Output is in file: cuc/cli/status_061013-95031.txt
 
   

show cuc trace levels (Cisco Unity Connection Only)

This command displays a list of all the diagnostic traces and trace levels that are currently enabled.

Command Syntax

show cuc trace levels [page]

Option

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

Usage Guidelines

To enable or disable specified traces and trace levels, use the set cuc trace (Cisco Unity Connection Only) command.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc trace levels
 
   
Trace Name                 Levels
-------------------------  --------------
Arbiter                    -
AudioStore                 0
AxlAccess                  -
BulkAdministrationTool     0
CCL                        10,11
CDE                        3,14
CDL                        11,13,15,17
   :
   :
VirtualQueue               -
 
   

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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

show cuc version
 
   
Active version: 7.0.1.10000-323
Inactive version: 7.0.0.39700-277
 
   

show diskusage

This command displays information about disk usage on the server.

Command Syntax

show diskusage

activelog {filename filename | directory | sort}

common {filename filename | directory | sort}

inactivelog {filename filename | directory | sort}

install {filename filename | directory | sort}

tftp {filename filename | directory | sort}

tmp {filename filename | directory | sort}

Parameters

activelog displays disk usage information about the activelog directory.

common displays disk usage information about the common directory.

inactivelog displays disk usage information about the inactivelog directory.

install displays disk usage information about the install directory.

tftp displays disk usage information about the TFTP directory.

tmp displays disk usage information about the TMP directory.

Options

filename filename—Saves the output to a file that is specified by filename. These files get stored in the platform/cli directory. To view saved files, use the file view activelog command.

directory—Displays just the directory sizes.

sort—Sorts the output on the basis of file size. File sizes display in 1024-byte blocks.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show environment

This command displays environmental information for three types of hardware components.

Command Syntax

show environment

fans

power-supply

temperatures

Options

fans—Displays the fan speeds in Rotations per Minute (RPMs), fan-speed thresholds, and status.

power-supply—Displays the power-supply status only on servers with redundant power supplies.

temperatures—Displays the temperture sensor temperature values, thresholds, and status.


Note The output data from the show environment command varies between IBM and HP server models.


show hardware

This command displays the following information on the platform hardware.

Command Syntax

show hardware

Usage Guidelines

This command displays the following information on the platform hardware:

Platform

Serial number

BIOS build level

BIOS manufacturer

Active processors

RAID controller status

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show itl

This command displays the ITL file contents or prints an error message if the ITL file is not valid.

Command syntax

show itl

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show ipsec policy_group

This commands displays all the ipsec policy groups on the node.

Command Syntax

show ipsec policy_group

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show ipsec policy_name

This command displays the list of ipsec policy names that exist in the specified policy group.

Command Syntax

show ipsec policy_name [policy_group]

Parameters

[policy_group] (mandatory) specifies the policy group name

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show logins

This command lists recent logins to the server.

Command Syntax

show logins number

Parameters

number specifies the number of most recent logins to display. The default equals 20.

show media streams

This command capturea information on current media stream connections.

Command Syntax

show media streams [options]

Options

file fname—Limit: (valid characters alphanumeric [a-z, A-Z, 0-9), (-) and, (_)]. Default: mediainfo

count #—Range: 1-1000, Default: 2

sleep #—Range: 1-300 seconds, Default: 5

device {ALL | ANN | CFB | CRA | MOH | MTP} Default: device ALL

info—Displays extra information.

buffers—Displays buffer usage information.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin: show media streams info buffers

Resulting file /platform/log/mediainfo.txt contains:

Time: 2008.03.04 11:01:42
I/F Ver=5, #Apps: Free=   7, Alloc=   4, #Conf: Free=  12, #Streams: Free=   40
Buffer Size =   652, Allocated Buffers =     1, Free Buffers =  5147
Buffer Size =  8192, Allocated Buffers =     0, Free Buffers =   450
App ID=  332, Cfg=CFB, Dead App Timer=86400, Active=Yes, Streams: Available=   92 Active=    
4
Conf ID = 16777225, Type = Two No Sum, Streams: Tx =     2, Rx =     2, Active = Yes
Rx Stream: PktCnt= 5979, PID=16777653, PktSz=20ms, Payld=uLaw, IP=10.89.80.178:24652, 
MCast=N, Mute=N, UsrMd=N, Actv=Y, QdPkts=2, PktOR=0, DtmfPL=0 DiscTimeSlice= 0 DiscPkts= 0 
10:59:42
Buffer Size =   652, Used Buffers =     1
Buffer Size =  8192, Used Buffers =     0
Rx Stream: PktCnt= 6179, PID=16777651, PktSz=20ms, Payld=uLaw, IP=10.89.80.178:24650, 
MCast=N, Mute=N, UsrMd=N, Actv=Y, QdPkts=0, PktOR=0, DtmfPL=0 DiscTimeSlice= 0 DiscPkts= 0 
10:59:38
Buffer Size =   652, Used Buffers =     0
Buffer Size =  8192, Used Buffers =     0
Tx Stream: PktCnt= 5988, PID=16777653, PktSz=20ms, Payld=uLaw, 
IP=10.13.5.189:29450(24652), MCast=N, Mute=N, UsrMd=N, Actv=Y, DtmfPL=0, DtmfQ=0 10:59:42
Buffer Size =   652, Used Buffers =     0
Buffer Size =  8192, Used Buffers =     0
Tx Stream: PktCnt= 6193, PID=16777651, PktSz=20ms, Payld=uLaw, 
IP=10.13.5.182:28516(24650), MCast=N, Mute=N, UsrMd=N, Actv=Y, DtmfPL=0, DtmfQ=0 10:59:38
Buffer Size =   652, Used Buffers =     0
Buffer Size =  8192, Used Buffers =     0
App ID=  331, Cfg=ANN, Dead App Timer=86400, Active=Yes, Streams: Available=   96 Active=    
0
App ID=  330, Cfg=MOH, Dead App Timer=86400, Active=Yes, Streams: Available=  658 Active=    
0
App ID=  329, Cfg=MTP, Dead App Timer=86400, Active=Yes, Streams: Available=   96 Active=    
0

show memory

This command displays information about the onboard memory.

Command Syntax

show memory

count

modules

size

Options

count—Displays the number of memory modules on the system.

modules—Displays detailed information about all the memory modules.

size—Displays the total amount of physical memory.

Parameters

None

show myself

This command displays information about the current account.

Command Syntax

show myself

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show network

This command displays network information.

Command Syntax

show network

cluster

eth0 [detail]

failover [detail] [page]

route [detail]

status [detail] [listen] [process] [all] [nodns] [search stext]

ip_conntrack

max_ip_conntrack

dhcp eth0 status

all [detail]

Parameters

cluster displays a list of the nodes in the network cluster.

eth0 specifies Ethernet 0.

failover specifies Network Fault Tolerance information.

route specifies network routing information.

status specifies active Internet connections.

ip_conntrack specifies ip_conntrack usage information.

max_ip_conntrack specifies max_ip_conntrack information.

dhcp eth0 status displays DHCP status information.

all specifies all basic network information.

Options

detail—Displays additional information.

page—Displays information 1 page at a time.

listen—Displays only listening sockets

process—Displays the process ID and name of the program to which each socket belongs.

all—Displays both listening and nonlistening sockets.

nodns—Displays numerical addresses without any DNS information.

search stext—Searches for the stext in the output.

Usage Guidelines

The eth0 parameter displays Ethernet port 0 settings, including DHCP and DNS configurations and options.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

This example displays active Internet connections.

show network status
 
   

show network ipprefs

This command displays the list of ports that have been requested to be opened or translated in the firewall.

Command Syntax

ipprefs {all | enabled | public}

Parameters

all—Displays all incoming ports that may be used on the product.

enabled—Displays all incoming ports that are currently opened.

public—Displays all incoming ports that are currently opened for any remote client.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

admin:show network ipprefs public 
 
   
Application  IPProtocol   PortValue    Type         XlatedPort   Status       Description  
------------ ------------ ------------ ------------ ------------ ------------ ------------ 
sshd         tcp          22           public       -            enabled      sftp and ssh 
access 
tomcat       tcp          8443         translated   443          enabled      secure web 
access 
tomcat       tcp          8080         translated   80           enabled      web access   
clm          udp          8500         public       -            enabled      cluster 
manager 
clm          tcp          8500         public       -            enabled      cluster 
manager 
ntpd         udp          123          public       -            enabled      network time 
sync 
snmpdm       udp          161          public       -            enabled      SNMP         
ccm          tcp          2000         public       -            enabled      SCCP-SIG     
ctftp        udp          6969         translated   69           enabled      TFTP access 
to CUCM TFTP Server 
ctftp        tcp          6970         public       -            enabled      HTTP access 
to CUCM TFTP Server
admin:

show network ipv6

This command displays IPv6 network routes and network settings.


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


Command Syntax

show network ipv6 {route|settings}

Parameters

route displays all IPv6 routes.

settings displays IPv6 network settings.

Command privilege level: 0

Allowed during upgrade: Yes

show open

This command displays open files and ports on the system.

Command Syntax

show open

files [all] [process processID] [regexp reg_exp]

ports [all] [regexp reg_exp]

Parameters

files displays open files on the system.

ports displays open ports on the system.

Options

all—Displays all open files or ports.

process—Displays open files that belong to the specified process.

processID—Specifies a process.

regexp—Displays open files or ports that match the specified regular expression.

reg_exp—Represents a regular expression.

show packages

This command displays the name and version for installed packages.

Command Syntax

show packages

active name [page]

inactive name [page]

Parameters

name represents the package name. To display all active or inactive packages, use the wildcard character, *.

Options

page—Displays the output one page at a time

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show password age

This command displays the information about the configured password.

Command Syntax

show password

age - displays information abou the configured password age parameters

expiry [minimum-age | maximum-age] - displays the configured password expiration parameters.

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show password inactivity

This command displays the status of password inactivity.

Command syntax

show password inactivity

Parameters

None

show perf counterhelp

This command displays the explanation text for the specified perfmon counter.

Command Syntax

show perf counterhelp class-name counter-name

Parameters

class-name represents the class name that contains the counter.

counter-name represents the counter that you want to view.


Note If the class name or counter name contains white spaces, enclose the name in double quotation marks.


Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf list categories

This command lists all categories in the perfmon system.

Command Syntax

show perf list categories

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf list classes

This commands lists the perfmon classes or objects.

Command Syntax

show perf list classes [cat category] [detail]

Options

detail—Displays detailed information

cat category—Displays perfmon classes for the specified category

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf list counters

This command lists perfmon counters for the specified perfmon class.

Command Syntax

list counters class-name [detail]

Parameters

class-name represents a perfmon class name for which you want to list the counters.


Note If the class name or counter name contains white spaces, enclose the name in double quotation marks.


Options

detail—Displays detailed information

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf list instances

The command lists the perfmon instances for the specified perfmon class.

Command Syntax

list instances class-name [detail]

Parameters

class-name represents a perfmon class name for which you want to list the counters.


Note If the class name contains white spaces, enclose the name in double quotation marks.


Options

detail—Displays detailed information

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf query class

This command queries a perfmon class and displays all the instances and counter values of each instance.

Command Syntax

show perf query class class-name [,class-name...]

Parameters

class-name specifies the perfmon class that you want to query. You can specify a maximum of five classes per command.


Note If the class name contains white spaces, enclose the name in double quotation marks.


Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf query counter

This command queries the specified counter and displays the counter value of all instances.

Command Syntax

show perf query counter class-name counter-name [,counter-name...]

Parameters

class-name specifies the perfmon class that you want to query.

counter-name specifies the counter to view. You can specify a maximum of five counters per command.


Note If the class name or counter name contains white spaces, enclose the name in double quotation marks.


Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf query instance

This command queries the specified instance and displays all its counter values.

Command Syntax

show perf query instance class-name instance-name [,instance-name...]

Parameters

class-name specifies the perfmon class that you want to query.

instance-name specifies the perfmon instance to view. You can specify a maximum of five instances per command.


Note If the class name or instance name contains white spaces, enclose the name in double quotation marks.


Usage Guidelines

This command does not apply to singleton perfmon classes.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show perf query path

This command queries a specified perfmon path.

Command Syntax

show perf query path path-spec [,path-spec...]

Parameters

For an instance-based perfmon class, specify path-spec as class-name(instance-name)\counter-name.

For a noninstance-based perfmon class (a singleton), specify path-spec as class-name\counter-name.

You can specify a maximum of five paths per command.


Note If the path name contains white spaces, enclose the name in double quotation marks.


Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

show perf query path "Cisco Phones(phone-0)\CallsAttempted", 
"Cisco Unified Communications Manager\T1ChannelsActive"
 
   

show process

This command displays information about processes that run on the system.

Syntax

show process

list [file filename] [detail]

load [cont] [clear] [noidle] [num number] [thread] [cpu | memory| time] [page]

name process [file filename]

open-fd process-id [, process-id2]

pid pid [file file-name]

search regexp [file filename]

user username [file filename]

using-most cpu [number] [file filename]

using-most memory [number] [file filename]

Parameters

list displays a list of all the processes and critical information about each process and visually indicates the child-parent relationships between the processes.

load displays the current load on the system.

name displays the details of processes that share the same name and indicates their parent-child relationship.

open-fd lists the open file descriptors for a comma-separated list of process IDs.

search searches for the pattern that the regular expression regexp specifies in the output of the operating system-specific process listing.

user username retrieves details of processes that share the user name and displays parent-child relationship.

using-most cpu displays a list of the most CPU-intensive processes.

using-most memory displays a list of the most memory-intensive processes.

Options

file filename—Outputs the results to the file that is specified by filename

detail—Displays detailed output

cont—Repeats the command continuously

clear—Clears the screen before displaying output

noidle—Ignore the idle/zombie processes

num number—Displays the number of processes that are specified by number. The default number of processes equals 10. Set number to all to display all processes.

thread—Displays threads

[cpu | memory | time]—Sorts output by CPU usage, memory usage, or time usage. The default specifies to sort by CPU usage.

page—Displays the output in pages

process—Specifies the name of a process

pid—Specifies the process ID number of a process

regexp—Represents a regular expression

number—Specifies the number of processes to display. The default specifies 5.

username—(mandatory) Specifies the username.

vm—Displays the virtual memory of the process.

show registry

This command displays the contents of the registry.

Command Syntax

show registry system component [name] [page]

Parameters

system represents the registry system name.

component represents the registry component name.

name represents the name of the parameter to show.


Note To display all items, enter the wildcard character, *.


Options

page—Displays one page at a time

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

This example shows contents of the cm system, dbl/sdi component.

show registry cm dbl/sdi

show risdb

This command displays RIS database table information.

Command Syntax

show risdb

list [file filename]

query table1 table2 table3 ... [file filename]

Parameters

list displays the tables that are supported in the Realtime Information Service (RIS) database.

query displays the contents of the RIS tables.

Options

file filename—Outputs the information to a file.


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


Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

This example displays a list of RIS database tables.

show risdb list

show smtp

This command displays the name of the SMTP host.

Command Syntax

show snmp

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show stats io

This command displays system IO statistics.

Command Syntax

show stats io [kilo] [detail] [page] [file filename]

Options

kilo—Displays statistics in kilobytes.

detail—Displays detailed statistics on every available device on the system and overrides the kilo option.

file filename—Outputs the information to a file.


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


Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show status

This command displays basic platform status.

Command Syntax

show status

Usage Guidelines

This command displays the following basic platform status:

Host name

Date

Time zone

Locale

Product version

Platform version

CPU usage

Memory and disk usage

License MAC

Requirements

Command privilege level: 0

show tech activesql

This command displays the active queries to the database taken at one minute intervals as far back as the logs allow.

Command Syntax

show tech activesql

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech all

This command displays the combined output of all show tech commands.

Command Syntax

show tech all [page] [file filename]

Options

page—Displays one page at a time.

file filename—Outputs the information to a file.


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


Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech ccm_service

This command displays information on all Cisco Unified Communications Manager services that can run on the system.

Command Syntax

show tech ccm_service

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show tech database

This command shows information about the database.

Command Syntax

show tech database

dump

sessions

Parameters

dump creates a CSV file of the entire database.

sessions redirects the session and SQL information of the present session IDs to a file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech dberrcode

Displays information (from the database log files) about the error code that is specified

Command Syntax

show tech dberrcode [errorcode]

Parameters

[errorcode] (mandatory) specifies the error code as positive integer

Usage Guidelines

If the error code is a negative number, enter it without the minus sign (-).

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech dbintegrity

This command displays the database integrity.

Command Syntax

show tech dbintegrity

show tech dbinuse

This command displays the database in use.

Command Syntax

show tech dbinuse

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech dbschema

This command displays the database schema in a CSV file.

Command Syntax

show tech dbschema

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech dbstateinfo

This command displays the state of the database.

Command Syntax

show tech dbstateinfo

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech devdefaults

This command displays the device defaults table.

Command Syntax

show tech devdefaults

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech dumpCSVandXML

This command provides detailed information for customer support in the case of an L2 upgrade condition.

Command Syntax

show tech dumpCSVandXML

Parameters

None

Usage Guidelines

You can get this file in any of the following ways.

1. Use the file view activelog cm/trace/dbl/xmlcsv.tar command to view the contents of the file.

2. Use the file get activelog cm/trace/dbl/xmlcsv.tar command to download the file.

3. Use RTMT (Trace and Log Central > Collect Files > Cisco Database Cli Output > Install and upgrade log).

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech gateway

This command displays the gateway table from the database.

Command Syntax

show tech gateway

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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] [search text] [file filename]

hosts [page] [search text] [file filename]

interfaces [page] [search text] [file filename]

resolv [page] [search text] [file filename]

routes [page] [search text] [file filename]

sockets {numeric}

Parameters

all displays all network tech information.

hosts displays information about hosts configuration.

interfaces displays information about the network interfaces.

resolv displays information about hostname resolution.

routes displays information about network routes.

sockets displays the list of open sockets.

Options

page—Displays one page at a time.

search text—Searches the output for the string that text specifies. Be aware that the search is case insensitive.

file filename—Outputs the information to a file.

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

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: 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] [file filename]

cpu [page] [file filename]

disk [page] [file filename]

env [page] [file filename]

memory [page] [file filename]

Parameters

all displays all runtime information.

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

disk displays system disk usage information.

env displays environment variables.

memory displays memory usage information.

Options

page—Displays one page at a time.

file filename—Outputs the information to a file.

Usage Guidelines

The file option saves the information to platform/cli/filename.txt. Ensure that the file name 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] [file filename]

bus [page] [file filename]

hardware [page] [file filename]

host [page] [file filename]

kernel [page] [file filename]

software [page] [file filename]

tools [page] [file filename]

Parameters

all displays all the system information.

bus displays information about the data buses on the server.

hardware displays information about the server hardware.

host displays information about the server.

kernel lists the installed kernel modules.

software displays information about the installed software versions.

tools displays information about the software tools on the server.

Options

page—Displays one page at a time.

file filename—Outputs the information to a file.

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

show tech table

This command displays the contents of the specified database table.

Command Syntax

show tech table table_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 traceconfig

Command Privilege: 0

Allowed During Upgrade: Yes

Syntax:

show traceconfig [servicename]

Required Parameter:

[servicename] can take one of these values :

Cisco_AMC_Service |

Cisco_DRF_Local |

Cisco_DRF_Master |

Cisco_Unified_B2B_Link_Service |

Cisco_Unified_B2BLCfgMgr_Service |

Cisco_RIS_Data_Collector |

Cisco_Trace_Collection_Service |

Cisco_Audit_Event_Service |

Cisco_CallManager_Serviceability_RTMT |

Cisco_Log_Partition_Monitoring_Tool |

all

Help:

show traceconfig Cisco_AMC_Service

help:

This will show the Trace Configuration for the selected service

Example:

admin:

show traceconfig all

show traceconfig Cisco_AMC_Service

show traceconfig Cisco_DRF_Local

show traceconfig Cisco_DRF_Master

show traceconfig Cisco_Unified_B2B_Link_Service

show traceconfig Cisco_Unified_B2BLCfgMgr_Service

show traceconfig Cisco_RIS_Data_Collector

show traceconfig Cisco_Trace_Collection_Service

show traceconfig Cisco_Audit_Event_Service

show traceconfig Cisco_CallManager_Serviceability_RTMT

show traceconfig Cisco_Log_Partition_Monitoring_Tool

show ups status

This command shows the current status of the USB-connected APC smart-UPS device and starts the monitoring service if it is not already started.

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

Command Syntax

show ups status

show version

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

Command Syntax

show version

active

inactive

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show web-security

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

Command Syntax

show web-security

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show workingdir

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

Command Syntax

show workingdir

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Unset Commands

This section contains descriptions of the following commands:

unset ipsec policy_group

unset ipsec policy_name

unset network dns options

unset network ipv6 static_address

unset ipsec policy_group

This command disables the ipsec policy on the specified group.

Syntax

unset ipsec policy_name [policy_group]

Parameters

policy_group (mandatory) specifies the group name

Requirements

Command privilege level: 1

Allowed during upgrade: No

unset ipsec policy_name

This command disables the ipsec policy with the specified name.

Syntax

unset ipsec policy_name [policy_name]

Parameters

policy_name (mandatory) specifies the policy name to disable.

ALL

policy name

Requirements

Command privilege level: 1

Allowed during upgrade: No

unset network dns options

This command unsets DNS options.

Command Syntax

unset network dns options [timeout] [attempts] [rotate]

Parameters

timeout sets the wait time before the system considers a DNS query as failed to the default.

attempts sets the number of DNS attempts to make before failing to the default.

rotate sets the method for selecting a nameserver to the default. This affects how loads are distributed across nameservers.

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.

unset network ipv6 static_address

This command unsets the IPV6 static address.

Command Syntax

unset network ipv6 static_address [reboot]

Parameters

None

Options

reboot reboots the server after applying the change.

Example

admin:unset network ipv6 static_address 
   W A R N I N G   
The Server must be rebooted for these changes to take effect.
Please make sure that you reboot this server. 
 
   
 
   
 
   
IPv6 static address was removed.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Utils Commands

This section contains descriptions of the following commands:

utils auditd

utils core active

utils core inactive list

utils core inactive analyze

utils create report

utils csa disable

utils csa enable

utils csa status

utils cuc cluster activate (Cisco Unity Connection Only)

utils cuc cluster deactivate (Cisco Unity Connection Only)

utils cuc cluster makeprimary (Cisco Unity Connection Only)

utils cuc cluster overwritedb (Cisco Unity Connection Only)

utils cuc cluster renegotiate (Cisco Unity Connection Only)

utils cuc create report (Cisco Unity Connection Only)

utils cuc networking clear_replication (Cisco Unity Connection Only)

utils cuc networking dscp (Cisco Unity Connection Only)

utils cuc reset password (Cisco Unity Connection Only)

utils dbreplication clusterreset

utils dbreplication dropadmindb

utils dbreplication forcedatasyncsub

utils dbreplication quickaudit

utils dbreplication repair

utils dbreplication repairreplicate

utils dbreplication repairtable

utils dbreplication reset

utils dbreplication runtimestate

utils dbreplication repairreplicate

utils dbreplication repairtable - ARE THERE TWO IN THIS DOC?

utils dbreplication setrepltimeout

utils dbreplication status

utils dbreplication stop

utils diagnose

utils disaster_recovery cancel_backup

utils disaster_recovery backup tape

utils disaster_recovery backup network

utils disaster_recovery cancel_backup

utils disaster_recovery device delete

utils disaster_recovery device list

utils disaster_recovery restore tape

utils disaster_recovery restore network

*utils disaster_recovery schedule

utils disaster_recovery show_backupfiles network

utils disaster_recovery show_backupfiles tape

utils disaster_recovery show_registration

utils disaster_recovery show_tapeid

utils disaster_recovery status

utils fior

utils firewall ipv4

utils firewall ipv4

utils firewall ipv6

utils iostat

utils iothrottle enable

utils iothrottle enable

utils iothrottle disable

utils iothrottle status

utils netdump client

utils netdump server

utils network arp

utils network capture eth0

utils network connectivity

utils network host

utils network ipv6 traceroute

utils network ipv6 host

utils network ipv6 ping

utils network ping

utils network traceroute

utils ntp

utils ntp restart

utils ntp start

utils ntp status

utils remote_account

utils reset_application_ui_administrator_name

utils reset_application_ui_administrator_password

utils reset_ui_administrator_name (Cisco Unified Communications Manager Only)

utils reset_ui_administrator_password (Cisco Unified Communications Manager Only)

utils service list

utils service

utils snmp

utils soap realtimeservice test

utils system

utils system boot

utils system upgrade

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.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils core active

This command affects existing core files.

Command syntax

utils core active

list

analyze core_file_name

Parameters

list displays the existing core files.

analyze displays the stack trace for the specified core file.

Options

core_file_name name of core file from which to get stack trace.

Usage Guidelines

When you execute the utils core active analyze core_file_name command on a core file created by cimserver, an unexpected message displays. This is a known limitation of the command.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils core inactive list

This command displays a list of core files.

Command Syntax

utils core inactive list

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils core inactive analyze

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

Command Syntax

utils core inactive analyze core_file_name

Parameter

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils create report

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

Command Syntax

utils create report

hardware

platform

csa

Parameters

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.

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

Command privilege level: 1

Allowed during upgrade: No

utils csa disable

This command stops Cisco Security Agent (CSA).

Command Syntax

utils csa disable

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils csa enable

This command enables Cisco Security Agent (CSA).

Command Syntax

utils csa enable

Usage Guidelines

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


Caution 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 data on this server with the data 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 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

Example

utils cuc cluster overwritedb
 
   

utils cuc cluster renegotiate (Cisco Unity Connection Only)

This command creates a cluster relationship with the publisher server in a Connection cluster after the server was replaced or after Connection was reinstalled on the publisher server. The command overwrites all data on the publisher server with data from the subscriber server and initializes data replication between the servers.

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 a publisher server that has been replaced or on which Connection has been reinstalled.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils cuc cluster renegotiate
 
   

utils cuc create report (Cisco Unity Connection Only)

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.

Command Syntax

utils cuc create report

Usage Guidelines

When 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

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

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.

Command Syntax

utils cuc networking dscp {on|off}

Parameters

on causes Connection to start including a DSCP value of 18 in packets sent over the network.

off causes to stop including a DSCP value of 18 in packets sent over the network. This is the default value.

Usage Guidelines

The utils cuc networking dscp command simply 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 cannot change the value.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils cuc networking dscp on
 
   

utils cuc reset password (Cisco Unity Connection Only)

This command resets the password for a specified user account.

Command 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 quickaudit nodename | 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 repairtable tablename [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.


Requirements

Command privilege level: 0

Allowed during upgrde: No

utils dbreplication runtimestate

This command monitors progress of the database replication process and provides replication state in the cluster.

Command Syntax

utils dbreplication runtimestate [nodename]

Parameters

nodename (optional) specifies the node to monitor.

Usage Guidelines

If a nodename is provided, the replication state is provided from the view point of the selected node.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils dbreplication repairreplicate

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

Command Syntax

utils dbreplication repairreplicate replicatename [nodename]|alll

Parameters

replicatename specifies the replicate to repair.

nodename specifies which node to repair replication on.

all causes fix replication on all nodes.

Requirements

Command privilege level level: 0

Allowed during upgrade: Yes

utils dbreplication repairtable - ARE THERE TWO IN THIS DOC?

This command repairs mismatched data between cluster nodes and changes the node to match the publisher data.

Command Syntax

utils dbreplication repairtable tablename [nodename]|all

Parameters

tablename specifies the table to repair.

nodename specifies on which node to repair replication.

all causes fix replication on all nodes.

Usage Guidelines

This command can be executed on the publisher server.

It does not repair replication setup.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils dbreplication setrepltimeout

You can use this command to set the timeout for database replication on large clusters.

Command Syntax

utils dbreplication setrepltimeout timeout

Options

timeout—The new database replication timeout, in seconds. Ensure that the value is between 300 and 3600.

Usage Guidelines

The default database replication timeout equals 5 minutes (value of 300).

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 cancel_backup

This command cancels the ongoing backup.

Command syntax

utils disaster_recovery cancel_backup confirm

Usage Guidelines

After you enter the command, you must confirm that you wnat to cancel the backup. Enter Y to cancel the backup or any other key to continue the backup.

Example

admin:utils disaster_recovery cancel_backup yes
Cancelling backup...
Backup cancelled successfully.

Requirements

Command privilege level: 1

Allowed during upgrade:No

utils disaster_recovery backup tape

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

Command Syntax

utils disaster_recovery backup tape featurelist tapeid

Parameters

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.

Command Syntax

utils disaster_recovery backup network featurelist path servername username

Parameters

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

path represents the location of the backup files on the remote server.

servername represents the IP address or host name of the server where you stored the backup files.

username represents the username that is needed to log in to the remote server.

Usage Guidelines


Note The system prompts you to enter the password for the account on the remote server.


Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils disaster_recovery cancel_backup

This command cancels the ongoing backup job.

Command Syntax

utils disaster_recovery cancel_backup

Usage Guidelines

The system prompts you to confirm that you want to cancel the backup job.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils disaster_recovery device delete

This command deletes the specified device.

Command syntax

utils disaster_recovery device delete [device_name|*]

Parameters

device_name mandatory name of the device to be deleted

* deletes all the existing devices except for the ones associated to a schedule.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils disaster_recovery device list

This command display the device name, device type and device path for all the backup device.

Command syntax

utils disaster_recovery device list

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils disaster_recovery restore tape

This command starts a restore job and takes the backup tar file from tape.

Command syntax

utils disaster_recovery restore tape server tarfilename tapeid

Parameters

server specifies the hostname of the server that you want to restore.

tarfilename specifies the name of the file to restore.

tapeid specifies the name of the tape device from which to perform the restore job.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils disaster_recovery restore network

This command starts a restore job and takes the backup Tar file from a remote server.

Command Syntax

utils disaster_recovery restore network restore_server tarfilename path servername username

Parameters

restore_server specifies the hostname of the server that you want to restore.

tarfilename specifies the name of the file to restore.

path represents the location of the backup files on the remote server.

servername represents the IP address or host name of the server where you stored the backup files.

username represents the username that is needed to log in to the remote server.

Usage Guidelines


Note The system prompts you to enter the password for the account on the remote server.


Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils disaster_recovery schedule

This command affects schedules that are configured.

Command syntax

utils disaster_recovery schedule

list

Command privilege level: 1

Allowed during upgrade: Yes

add schedulename devicename featurelist datetime frequency

Command privilege level: 1

Allowed during upgrade: No

enable schedulename

Command privilege level: 1

Allowed during upgrade: No

disable schedulename

Command privilege level: 1

Allowed during upgrade: No

delete [schedulename|*]

Command privilege level: 1

Allowed during upgrade: No

Parameters

list displays the schedules that are configured.

add adds the configured schedules.

enable enables the specified schedule.

disable disables the specified schedule

delete deletes the specified schedule.

Options

schedulename (mandatory) name of the scheduler

devicename(mandatory) name of the device for which scheduling is done

featurelist (mandatory) comma-seperated feature list to backup

datetime (mandatory) date when the scheduler is set. Format specified (yyyy/mm/dd-hh:mm) 24 hr clock

frequency (mandatory) frequency at which the scheduler is set to take a backup. Examples: once, daily, weekly and monthly

* all

List Example

admin:utils disaster_recovery schedule list
schedule name device name Schedule Status
----------------------------------------
schedule1      dev1         enabled
schedule2      dev2         disabled

Enable Example

utils disaster_recovery schedule enable schedule1
Schedule enabled successfully.

Disable Example

utils disaster_recovery schedule disable schedule1
Schedule disabled successfully.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils disaster_recovery show_backupfiles network

This command starts a restore job and takes the backup Tar file from a remote server.

Command Syntax

utils disaster_recovery show_backupfiles network path servername username

Parameters

path represents the location of the backup files on the remote server.

servername represents the IP address or host name of the server where you stored the backup files.

username represents the username that is needed to log in to the remote server.

Usage Guidelines


Note The system prompts you to enter the password for the account on the remote server.


Requirements

Command privilege level: 1

Allowed during upgrade: No

utils disaster_recovery show_backupfiles tape

This command displays information about the backup files that are stored on a tape.

Command Syntax

utils disaster_recovery show_backupfiles tape tapeid

Parameters

tapeid represents the ID of an available tape device.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils disaster_recovery show_registration

This command displays the registered features and components on the specified server.

Command Syntax

utils disaster_recovery show_registration hostname

Parameters

hostname specifies the server for which you want to display registration information.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils disaster_recovery show_tapeid

This command displays a list of tape device IDs.

Command Syntax

utils disaster_recovery show_tapeid

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils disaster_recovery status

This command displays the status of the current backup or restore job.

Command Syntax

utils disaster_recovery status operation

Parameters

operation specifies the name of the ongoing operation: backup or restore.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils fior

This command allows you to monitor the I/O on the server. The File I/O Reporting service provides a kernel-based daemon for collecting file I/O per process.

Command Syntax

utils fior

disable

enable

list [start=date-time] [stop=date-time]

start

status

stop

top number [read | write | read-rate | write-rate] [start=date-time] [stop=date-time]

Parameters

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:S a, H:M, a, H:M:S Y-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 level: 1

Allowed during upgrade: No

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 netdump client

This command configures the netdump client.

Command Syntax

utils netdump client

start ip-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-client ip-address-of-netdump-client

delete-client ip-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.

Options

page—Displays the output one page at a time

numeric—Displays hosts as dotted IP addresses

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network arp

This command lists the contents of the Address Resolution Protocol table.

Command syntax

utils network arp

list [host hostname][options]

Command privilege level: 0

Allowed during upgrade: Yes

set host addr

Command privilege level: 1

Allowed during upgrade: No

delete host

Command privilege level: 1

Allowed during upgrade: Yes

Options

host (optional) specifies host you want to list/set/delete.

hostname (optional) the hostname of the specified host.

options (optional) page, numeric

page pauses output.

numeric shows hosts as dotted IP addresses.

addr (mandatory) the hardware address (MAC) of the host.

Format XX:XX:XX:XX:XX:XX

Format XX:XX:XX:XX:XX:XX

List Usage Guidelines

In the Flags column, C=cached, M=permanent, P=published.

List Example

admin: utils network arp list
Address                  HWtype  HWaddress           Flags Mask           Iface
sjc21-3f-hsrp.cisco.com  ether   00:00:0C:07:AC:71   C                    eth0
philly.cisco.com         ether   00:D0:B7:85:98:8E   C                    eth0
Entries: 2      Skipped: 0      Found: 2

Set Example

admin: utils network arp set myhost 11:22:33:44:55:66

Delete Example

admin: utils network arp delete myhost

utils network capture eth0

This command captures IP packets on the specified Ethernet interface.

Command Syntax

utils network capture eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]

Parameters

eth0 specifies Ethernet interface 0.

Options

page—Displays the output one page at a time

When you use the page or file options, the complete capture of all requested packets must occur before the command completes.

numeric—Displays hosts as dotted IP addresses

file fname—Outputs the information to a file

The file option saves the information to platform/cli/fname.cap. The filename cannot contain the "." character.

count num—Sets a count of the number of packets to capture

For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10,000.

size bytes—Sets the number of bytes of the packet to capture

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

src addr—Specifies the source address of the packet as a host name or IPV4 address

dest addr—Specifies the destination address of the packet as a host name or IPV4 address

port num—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 host hostname [server server-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 traceroute [ipv6-address | 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 ping destination [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 tracert destination

Parameters

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

Requirements

Command privilege level: 0

Allowed during upgrade: 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 level: 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.


Command Syntax

utils ntp start

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils ntp status

This command displays the current status of NTP.

Command Syntax

utils ntp status

Parameters

None

Example

admin:utils ntp status
ntpd (pid 18705) is running...
 
   
     remote           refid      st t when poll reach   delay   offset  jitter
==============================================================================
 127.127.1.0     LOCAL(0)        10 l   12   64  377    0.000    0.000   0.004
+171.68.10.80    10.81.254.131    2 u  331 1024  377   35.201   -0.498   0.673
*10.81.254.131   .GPS.            1 u  356 1024  377   64.304   -0.804   0.638
 
   
 
   
synchronised to NTP server (10.81.254.131) at stratum 2
   time correct to within 37 ms
   polling server every 1024 s
 
   
Current time in UTC is : Thu Feb 12 22:33:43 UTC 2009
Current time in America/Los_Angeles is : Thu Feb 12 14:33:43 PST 2009
 
   
The 'remote' column lists the remote NTP servers.  The local hardware clock is
configured as 127.127.1.0 and is always shown, even when not active.
 
   
The leftmost column below the 'remote' column header has the following meaning:
  " " discarded due to high stratum and/or failed sanity checks
  "+" a candidate NTP server and included in the final selection set
  "*" selected for synchronization
 
   
Any other values indicate the NTP server is not being used for synchronization.
Other possible values are:
  "x" designated false ticker (is an invalid NTP server)
  "." culled from the end of the candidate list (is considered non viable)
  "-" discarded
  "#" selected for synchronization, but has high delay, offset or jitter
 
   
The 'refid' column indicates the remote's time source.  "LOCAL(0)" applies to
the local hardware clock.  ".INIT." means initialization has not yet succeeded.
 
   
The 'st' column is the stratum of the remote NTP server.  16 is a invalid
stratum value meaning "this server is not considered a time provider".
This can be for various reasons, the most common reasons are "time provider not 
synchronized", "configured source does not exist" or "ntp server not running".
 
   
The 'when' column indicates how many seconds ago the remote was queried.
 
   
The 'poll' column indicates the polling interval in seconds.  E.G., '64' means
the remote is being polled every 64 seconds.  The shortest interval NTP uses
is every 64 seconds and the longest is 1024 seconds.  The better a NTP source
is rated over time, the longer the interval.
 
   
The 'reach' column indicates the trend of reachability tests in octal, where
each digit, when converted to binary represents whether a particular poll was
successful (binary 1) or unsuccessful (binary 0).  E.G., '1' means only one
poll has been done thus far and it was successful.  '3' (= binary 11) means the
last 2 polls were successful.  '7' (= binary 111) means the last 3 polls were
successful.  '17' (= binary 1 111) means the last 4 polls were successful.
'15' (= binary 1 101) means the last 2 polls were successful, the poll prior to
that was unsuccessful, and the poll prior to that was successful.
 
   
When a poll is done for the active NTP server selected for synchronization is
done, a time correction using that NTP server's time is also done.
 
   
The delay, offset and jitter are the round-trip delay, dispersion, and jitter
in seconds.
 
   
"At stratum #" shown below the table shows the stratum of this host's NTP
server, which will be one higher than that of the currently active NTP server
being used for synchronization.

Requirements

Command privilege level: 0

Allowed during upgrade: 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

create username life

Parameters

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

life specifies the life of the account in days. After the specified number of 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.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Example

utils remote_account status
 
   

utils reset_application_ui_administrator_name

This command resets the application user interface administrator name.

Command Syntax

utils reset_application_ui_administrator_name

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils reset_application_ui_administrator_password

This command resets the application user interface administrator password.

Command Syntax

utils reset_application_ui_administrator_password

Parameters

None

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils reset_ui_administrator_name (Cisco Unified Communications Manager Only)


Note To change the administrator user name for Cisco Unity Connection, use Cisco Unity Connection Administration.


This command resets the administrator user name you use to log in the administration user interface for the installed product.

Command Syntax

utils reset_ui_administrator_name

utils reset_ui_administrator_password (Cisco Unified Communications Manager Only)


Note To change the password for a Cisco Unity Connection user, use the utils cuc reset password command. See the "utils cuc reset password (Cisco Unity Connection Only)" section.


This command resets the administrator password you use to log in the administration user interface for the installed product.

Command Syntax

utils reset_ui_administrator_password

utils service list

This command retrieves a list of all services and their status.

Command Syntax

utils service list [page]

Options

page—Displays the output one page at a time

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils service

This command stops, starts, or restarts a service.

Command Syntax

utils service

start service-name

stop service-name

restart service-name

auto-restart {enable | disable | show} service-name

Parameters

service-name represents the name of the service that you want to stop or start:

System SSH

Cluster Manager

Service Manager

Cisco Tomcat

Cisco Database Layer Monitor

Cisco CallManager Serviceability

auto-restart causes a service to automatically restart.

enable enables auto-restart.

disable disables auto-restart.

show shows the auto-restart status.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils snmp

This command manages SNMP on the server.

Command Syntax

utils snmp

get version community ip-address object [file]

hardware-agents [status | start | stop | restart]

test

walk version community ip-address object [file]

Parameters

get displays the value of the specified SNMP object.

hardware-agents status displays the status of the hardware agents on the server.

hardware-agents stop stops all SNMP agents provided by the hardware vendor.

hardware-agents restart restarts the hardware agents on the server.

hardware-agents start starts all of the SNMP agents provided by the vendor of the hardware.

test tests the SNMP host by sending sample alarms to local syslog, remote syslog, and SNMP trap.

walk walks the SNMP MIB, starting with the specified SNMP object.

version specifies the SNMP version. Possible values include 1 or 2c.

community specifies the SNMP community string.

ip-address specifies the IP address of the server. Enter 127.0.0.0 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node.

object specifies the SNMP Object ID (OID) to get.

file specifies a file in which to save the command output.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils soap realtimeservice test

This command executes a number of test cases on the remote server.

Command Syntax

utils soap realtimeservice test remote-ip remote-https-user remote-https-password

Parameters

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.

Requirements

Command privilege level: 0

Allowed during upgrade: No

utils system

This command allows you to restart the system on the same partition, restart the system on the inactive partition, or shut down the system.

Command Syntax

utils system {restart | shutdown | switch-version}

Parameters

restart restarts the system.

shutdown shuts down the system.

switch-version switches to the product release that is installed on the inactive partition.

Usage Guidelines

The utils system shutdown command provides a 5-minute timeout. If the system does not shut down within 5 minutes, the command gives you the option of doing a forced shutdown.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils system boot

This commands redirects where the system boot output gets sent.

Command Syntax

utils system boot {console | serial | status}

Parameters

console redirects the system boot output to the console.

serial redirects the system boot output to the COM1 (serial port 1).

status displays the where the serial boot output will currently get sent.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

utils system upgrade

This command allows you to install upgrades and Cisco Option Package (COP) files from both local and remote directories.

Command Syntax

utils system upgrade {initiate | cancel | status}

Parameters

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.

Related Documentation

For further information about related Cisco IP telephony applications and products, refer to the Cisco Unified Communications Manager Documentation Guide for your release at

http://cisco.com/en/US/products/sw/voicesw/ps556/products_documentation_roadmaps_list.html

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

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

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.

Further information regarding U.S. export regulations may be found at

http://www.access.gpo.gov/bis/ear/ear_data.html