Chapter 1. About CLI

CLI Privilege Levels

Start CLI session

Tab completes command

Command help

Ctrl-C exits command

Quit CLI session

Chapter 2. Delete Commands

delete account

delete cuc futuredelivery

delete cuc locale

delete dns

delete dscp

delete ipsec policy_group

delete ipsec policy_name

delete process

delete smtp

Chapter 3. File Commands

file build log

file check

file delete

file delete tftp

file delete dir tftp

file dump

file dump sftpdetails

file dump tftp

file fragmentation sdi

file fragmentation sdi file

file fragmentation sdi all

file fragmentation sdl

file fragmentation sdl file

file fragmentation sdl all

file get

file get salog

file get tftp

file list

file list salog

file list tftp

file search

file search tftp

file tail activelog

file tail tftp

file view

file view system-management-log

file view tftp

Chapter 4. License Commands

license client reset registration

license file

license management change user name

license management reset user password

license management list users

license management product re-register all

license management reset

license management security update

license management service

license management set log level core_services

license management set log level product_instances

license management show log level core_services

license management show log level product_instances

license management show system

license management system remove

license management unlock admin

Chapter 5. Run Commands

run cuc dbquery

run cuc preupgrade test

run cuc smtptest

run cuc sysagent task

run cuc vui rebuild

run loadcsv

run loadxml

run sql

run pe sql

Chapter 6. Set Commands

set account enable

set account name

set accountlocking

set accountlocking count

set accountlocking unlocktime

set cert bulk consolidate

set cert bulk export

set cert bulk import

set cert bulk sftp

set cert delete

set cert import

set cert regen

set cert regen ITLRecovery

set cli pagination

set cli session timeout

set commandcount

set csr gen

set cuc jetty stderrlog

set cuc jetty stdoutlog

set cuc jetty requestlog

set cuc srsv timeout

set cuc trace

set date

set dscp defaults

set dscp

set dscp marking

set ipsec policy_group

set ipsec policy_name

set logging

set Login Grace Timeout

set network cluster publisher

set network cluster subscriber details

set network cluster subscriber dynamic-cluster-configuration

set network dhcp eth0

set network dns

set network dns options

set network domain

set network failover

set network gateway

set network hostname

set network ip eth0

set network ipv6 dhcp

set network ipv6 gateway

set network ipv6 service

set network ipv6 static_address

set network max_ip_conntrack

set network mtu

set network name-service hosts cache-enable

set network name-service hosts max-db-size

set network name-service hosts negative-time-to-live

set network name-service hosts persistent

set network name-service hosts positive-time-to-live

set network name-service hosts suggested-size

set network name-service services cache-enable

set network name-service services max-db-size

set network name-service services negative-time-to-live

set network name-service services persistent

set network name-service services positive-time-to-live

set network name-service services suggested-size

set network nic eth0

set network ntp option

set network pmtud state

set network restore

set network status eth0

set network name-service

set password complexity minimum-length

set password age

set password change-at-login

set password complexity character

set password complexity character difference

set password complexity character max-repeat

set password complexity minimum-length

set password expiry maximum-age

set password expiry user maximum-age configure

set password expiry minimum-age

set password expiry user maximum-age

set password expiry user minimum-age

set password history

set password inactivity

set password system bootloader encryptHash

set password user admin

set password user security

Set replication-sync monitor

set samltrace level

set session maxlimit

set smtp

set timezone

set trace disable

set trace enable

set tlsresumptiontimeout

set tlstrace*

set tlstrace disable

set tlstrace enable

set web-security

set webapp session timeout

set workingdir

Chapter 7. Show Commands

show account

show accountlocking

show cert list

show cert list type

show cert own

show cert trust

show cli pagination

show cli session timeout

show csr list

show csr list type

show csr own

show csr own name

show ctl

show cuc cluster status

show cuc config groups

show cuc config settings

show cuc dbconsistency

show cuc dbcontents

show cuc dbschema

show cuc dbserver disk

show cuc dbserver session

show cuc dbserver sessions all

show cuc dbserver sessions list

show cuc dbserver user list

show cuc dbserver user waiting

show cuc dbtable contents

show cuc dbtable list

show cuc dbtable schema

show cuc dbview contents

show cuc dbview list

show cuc dbview schema

show cuc jetty ssl status

show cuc locales

show cuc sysagent task list

show cuc sysagent task results

show cuc sysinfo

show cuc tech dbschemaversion

show cuc tech dbserver all

show cuc tech dbserver integrity

show cuc tech dbserver log diagnostic

show cuc tech dbserver log message

show cuc tech dbserver status

show cuc trace levels

show cuc version

show date

show diskusage

show dscp all

show dscp defaults

show dscp marking

show dscp status

show environment fans

show environment power-supply

show environment temperatures

show fileserver transferspeed

show hardware

show ipsec information

show ipsec policy_group

show ipsec policy_name

show ipsec status

show itl

show logins

show logins successful

show logins unsuccessful

show Login Grace Timeout

show media streams

show memory

show myself

show network all

show network cluster

show network dhcp eth0

show network eth0

show network failover

show network ip_conntrack

show network ipprefs

show network ipv6

show network max_ip_conntrack

show network ntp option

show network route

show network status

show network name-service attributes

show network name-service cache-stats

show network name-service {hosts|services} attributes

show open files all

show open files process

show open files regexp

show open ports all

show open ports process

show open ports regexp

show packages

show password

show password change-at-login

show password complexity character

show password complexity length

show password expiry

show password expiry user

show password expiry user list

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 list

show process load

show process name

show process name process-name

show process open

show process open-fd

show process pid

show process search

show process user

show process using-most cpu

show process using-most memory

show registry

show risdb list

show risdb query

show samltrace level

show session maxlimit

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 dbhighcputasks

show tech dbintegrity

show tech dbschema

show tech dbinuse

show tech dbstateinfo

show tech devdefaults

show tech dumpCSVandXML

show tech gateway

show tech locales

show tech network all

show tech network hosts

show tech network interfaces

show tech network resolv

show tech network routes

show tech network sockets

show tech notify

show tech params

show tech prefs

show tech procedures

show tech repltimeout

show tech routepatterns

show tech routeplan

show tech runtime

show tech sqlhistory

show tech systables

show tech system

show tech table

show tech triggers

show tech version

show timezone config

show timezone list

show tlstrace

show tlsresumptiontimeout

show trace

show ups status

show version active

show version inactive

show web-security

show webapp session timeout

show workingdir

show logins unsuccessful

Chapter 8. Unset Commands

unset ipsec policy_group

unset ipsec policy_name

unset network cluster subscriber details

unset network cluster subscriber dynamic-cluster-configuration

unset network dns options

unset network domain

unset network ntp options

unset network ipv6 gateway

unset network ipv6 static_address

Chapter 9. Utils Commands

utils auditd

utils contactsearchauthentication disable

utils contactsearchauthentication enable

utils contactsearchauthentication status

utils core analyze

utils core list

utils capf cert import

utils capf csr

utils create report

utils create report database

utils ctl

utils ctl reset localkey

utils cuc activate CUSRSV

utils cuc cluster activate

utils cuc cluster deactivate

utils cuc cluster makeprimary

utils cuc cluster overwritedb

utils cuc cluster renegotiate

utils cuc create report

utils cuc dbreplication 01_tear_down

utils cuc dbreplication 02_define_servers

utils cuc dbreplication 03_define_db_template

utils cuc dbreplication 04_sync_database

utils cuc dbreplication reset_all

utils cuc jetty ssl disable

utils cuc jetty ssl enable

utils cuc networking clear_replication

utils cuc networking dscp

utils cuc reset password

utils cuc set PinExpiry_PromptTime â€œAuthentication Rule Nameâ€

utils dbreplication clusterreset

utils dbreplication dropadmindb

utils dbreplication forcedatasyncsub

utils dbreplication quickaudit

utils dbreplication rebuild

utils dbreplication repair

utils dbreplication repairreplicate

utils dbreplication repairtable

utils dbreplication reset

utils dbreplication runtimestate

utils dbreplication setprocess

utils dbreplication setrepltimeout

utils dbreplication status

utils dbreplication stop

utils imdb_replication replication status

utils diagnose

utils disaster_recovery backup network

utils disaster_recovery cancel_backup

utils disaster_recovery device add network

utils disaster_recovery device delete

utils disaster_recovery device list

utils disaster_recovery estimate_tar_size

utils disaster_recovery history

utils disaster_recovery jschLogs operation

utils disaster_recovery prepare restore pub_from_sub

utils disaster_recovery restore network

utils disaster_recovery schedule add

utils disaster_recovery schedule

utils disaster_recovery schedule delete

utils disaster_recovery schedule disable

utils disaster_recovery schedule list

utils disaster_recovery show_backupfiles

utils disaster_recovery show_registration

utils disaster_recovery status

utils EnhancedSecurityMode disable

utils EnhancedSecurityMode enable

utils EnhancedSecurityMode status

utils filebeat config

utils filebeat disable

utils filebeat enable

utils filebeat status

utils fior

utils fior disable

utils fior enable

utils fior list

utils fior start

utils fior status

utils fior stop

utils fior top

utils fips

utils firewall ipv4 debug

utils firewall ipv4

utils firewall ipv4 list

utils firewall ipv4 status

utils firewall ipv6 debug

utils firewall ipv6

utils firewall ipv6 list

utils firewall ipv6 status

utils ha failover

utils ha fallback

utils ha recover

utils ha status

utils ils showpeerinfo

utils import config

Execute utils import config in Vmware Deployment

utils iostat

utils iothrottle

utils itl reset

utils ldap config

utils ldap config status

utils network arp delete

utils network arp set

utils network arp list

utils network capture

utils network capture-rotate

utils network connectivity

utils network host

utils network ipv6 host

utils network ipv6 traceroute

utils network ipv6 ping

utils network ping

utils network traceroute

utils network name-service {hosts|services} cache invalidate

utils ntp server add

utils ntp server delete

utils ntp config

utils ntp restart

utils ntp server list

utils ntp start

utils ntp status

utils os kerneldump

utils os kerneldump ssh

utils os kerneldump status

utils os secure

utils PlatformWebAccess disable

utils PlatformWebAccess enable

utils PlatformWebAccess status

utils processCoreDumps disable

utils processCoreDumps enable

utils processCoreDumps status

utils remote_account create

utils remote_account disable

utils remote_account enable

utils remote_account status

utils remotesyslog set protocol tcp

utils remotesyslog set protocol udp

utils remotesyslog show protocol

utils reset_application_ui_administrator_name

utils reset_application_ui_administrator_password

utils restore_application_ui_administrator_account

utils scheduled-task disable

utils scheduled-task enable

utils scheduled-task list

utils set urlpattern disable

utils set urlpattern enable

utils service

utils service list

utils service auto-restart

utils service start

utils service stop

utils snmp config 1/2c community-string

utils snmp config 1/2c inform

utils snmp config 1/2c trap

utils snmp config 3 inform

utils snmp config mib2

utils snmp config 3 trap

utils snmp config 3 user

utils snmp get

utils snmp get 1

utils snmp get 2c

utils snmp get 3

utils snmp hardware-agents

utils snmp test

utils snmp walk

utils snmp walk 1

utils snmp walk 2c

utils snmp walk 3

utils soap realtimeservice test

utils sso

utils sso recovery-url

utils system restart

utils system shutdown

utils system switch-version

utils system boot

utils system upgrade

utils update dst

utils users validate

utils vmtools refresh

utils vmtools upgrade

utils system boot status

Preface

Purpose

Audience

Organization

Related Documents

Copyright Page

Chapter 1. About CLI

- CLI Privilege Levels

- Start CLI session

- Tab completes command

- Command help

- Ctrl-C exits command

- Quit CLI session

CLI Privilege Levels

During installation of Cisco Unified Communications Manager, an administrator with level 4 privilege is created at the platform level. This administrator has all privileges to execute all the command line interface (CLI) commands. Through the CLI commands, the administrator with level 4 privilege creates the following administrators:

- Administrator with level 0 privilege—This administrator has read-only access privilege on the interface.

- Administrator with level 1 privilege—This administrator has both read and write access privilege on the interface.

Note

Administrators can execute CLI commands based on the privileges defined for each of them.

After the administrators with the various privileges are created, you can start the CLI session.

Start CLI session

Note

This procedure applies to both Cisco Unified Communications Manager and the IM and Presence Service. The Operating System for Cisco Unified Communications Manager is called the Cisco Unified Operating System. The Operating System for the IM and Presence Service is called the Cisco Unified IM and Presence Operating System. To start a CLI session for the IM and Presence Service, you must use the Cisco Unified IM and Presence Operating System.

You can access the Cisco Unified Operating System (or, for the IM and Presence Service, the Cisco Unified IM and Presence Operating System) 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 is 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 Unified Operating System.

Procedure

Step 1

Perform one of the following actions depending on your method of access:

1. From a remote system, use SSH to connect securely to the Cisco Unified Operating System. 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.

2. From a direct connection, you receive this prompt automatically:

ipt-1 login:

where ipt-1 represents the host name of the system.

Enter the administrator ID that was defined during installation.

Step 2

Enter the password that was defined at installation.
The CLI prompt displays. The prompt represents the Administrator ID; for example:

admin:

You can now use any CLI command.

Tab completes command

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 is completed.

- Enter a full command name and press Tab to display all the commands or subcommands that are available. For example, if you enter set and press Tab, you see all the set subcommands. An * 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.

Command help

You can get two kinds of help about 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

If you want to:

At the CLI prompt:

Get detailed help

Enter

help command

Where command specifies the command name or the command and parameter. See "Detailed Help Example."

Query only command syntax

Enter

command?

Where command represents the command name or the command and parameter. See "Query Example."

Troubleshooting Tips

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

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

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]

Ctrl-C exits command

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

Exiting a Command with Ctrl-C

admin:utils system upgrade initiateWarning: 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.

Quit CLI session

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

Chapter 2. Delete Commands

- delete account

- delete cuc futuredelivery

- delete cuc locale

- delete dns

- delete dscp

- delete ipsec policy_group

- delete ipsec policy_name

- delete process

- delete smtp

delete account

This command allows you to delete an administrator account.

delete account account-name

Syntax Description

Parameters

Description

account-name

Specifies the name of an administrator account.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

delete cuc futuredelivery

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

delete cuc futuredelivery

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

The following example deletes two messages that have been marked for future delivery.

admin: 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

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

delete cuc locale locale-id

Syntax Description

Parameters

Description

locale-id

Specifies the ID of the locale that you want to delete.

Command Modes

Administrator (admin:)

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. While running "delete cuc" locale command, you can choose to retain or not retain the locale mappings at your Unity Connection System.

If you choose to retain locale mapping, then after re-install of same locale, all objects like Subscribers and Call handlers  are automatically mapped to retained locale. If you choose not to retain the locale mapping, then after uninstall all locale mappings are lost.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

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

admin:delete cuc locale en-GB

en-GB uninstalled

delete dns

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

delete dns addr

Syntax Description

Parameters

Description

addr

Represents the IP address of the DNS server that you want to delete.

Command Modes

Administrator (admin:)

Usage Guidelines

After you execute this command, the system asks whether you want to continue.

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

delete dscp

This command deletes a DSCP port tag.

delete dscp port-tag

Syntax Description

Parameters

Description

port-tag

Represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field displayed when you use the command show dscp defaults. The set of port tags is predefined.

Command Modes

Administrator (admin:)

Usage Guidelines

After you delete an enabled port tag, DSCP marking on that port tag stops. You can recreate a deleted port tag when you use the set dscp marking command; enter the name of the port tag that you previously deleted.

Tip

Use the command show dscp defaults to list the configured port tags.

Requirements

Command privilege level: 1

Applies to: Unified Communications Manager, Cisco Unity Connection

delete ipsec policy_group

This command deletes all policies within the specified group or all groups.

delete ipsec policy_group { group | | all }

Syntax Description

Parameters

Description

group

Represents a specific group name.

all

Deletes all groups.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, Cisco Unity Connection

delete ipsec policy_name

This command deletes an Ipsec policy with given policy name.

delete ipsec policy_name { policy_name | all }

Syntax Description

Parameters

Description

policy_name

Represents the policy name.

all

Deletes policies within all policy names.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, Cisco Unity Connection

delete process

This command allows you to delete a particular process.

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

Syntax Description

Parameters

Description

process-id

Represents the process ID number.

force

Causes the process to stop.

terminate

Causes the operating system to terminate the process.

crash

Crashes the process and produces a crash dump.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

delete smtp

This command allows you to delete the SMTP host.

delete smtp

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Chapter 3. File Commands

- file build log

- file check

file build log

This command collects log information by service or feature and duration.

file build log service /feature duration

Syntax Description

Parameters

Description

service/feature

specifies the component or functional area from which to retrieve log information

duration

specifies the time period, measured in days, from which the log information is retrieved.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level:

Allowed during upgrade:

Examples

This command collects logs for the Client Profile Agent.

admin: file build log cpa 10
Collecting logs

Collecting: logname1.txt
Collecting: logname2.txt

To retrieve run the following command:
file get epas/trace/acdc_2012-06-28-111258.tar.gz

This command collects all logs defined in the xml config.

admin:file build log all
Collecting logs

Collecting: logname1.txt
Collecting: logname2.txt

To retrieve run the following command:
file get epas/trace/acdc_2012-06-28-111258.tar.gz

This command collects logs for multiple services.

admin:file build log dbmon cpa
Collecting logs

Collecting: logname1.txt
Collecting: logname2.txt

To retrieve run the following command:
file get epas/trace/acdc_2012-06-28-111258.tar.gz

This command shows help.

admin:file build log ?
Syntax:
file build log [serviceName [serviceName] ..]

Service Names:
FullName                           ShortName

cisco_client_profile_agent         cpa
cisco_database_layer_monitor       dbmon
cisco_audit_logs                   audit
cisco_ris_dat_collector            risdc

This command shows information for the deployment.

admin: file build log deployment info 0

DB Queriesmay take up to 5 minutes to complete. Please be patient...
About to start queries for deployment data... please wait...
---------------------------------------------------
Gathering CUCM Version...
ccmversion
11.0.1.100000(9)
---------------------------------------------------
Gathering CUCM Publisher Node
ccmpublisherhostname
gwydlg050498vm1
---------------------------------------------------
Gathering Rosters table...
rosters
3032681
---------------------------------------------------
Gathering Groups table...
groups
1518966
---------------------------------------------------
Gathering Non-Presence contacts...
nonpresencecontacts
502573
---------------------------------------------------
Gathering Number of inter-cluster users...
enduser
0
---------------------------------------------------
Gathering CUCM Nodes in cluster...
processnode
2
---------------------------------------------------
Gathering CUCM Node names in cluster...
name
EnterpriseWideData
processnode
gwydlg050408vm1
---------------------------------------------------
Gathering IM&P nodes in cluster...
processnode
2
---------------------------------------------------
Gathering XCP Routing Node...
paramvalue
t
---------------------------------------------------
Gathering Exchange Calendaring...
pebackendgateway
---------------------------------------------------
Gathering SIP Inter-domain Federation...
domainname

paramvaluegwydlg050408vm2-public.cisco.com
---------------------------------------------------
Gathering XMPP Inter-domain Federation...
xmpps2ssnodes
0
---------------------------------------------------
Gathering Intra-domain Partitioned Federation...
enablepartitionedfedwithacs
f
---------------------------------------------------
Gathering Inter-cluster Peering...
cupsinterclusterpeers

---------------------------------------------------
Gathering Message Archiver...
pkid
8fede7a9-b6a6-4ad4-8da6-b8ea4c8d5411
databasetype
Postgres
databasename
tcmadb
name
gwydlg050408vm2
tknodeusage
0
tkprocessnoderole
2
nodeid
3
---------------------------------------------------
Gathering Third-party compliance...
ftextdbprocessnodemap
0
---------------------------------------------------
Gathering Persistent Chat...
enablepersistentgear
t
databasetype
Postgres
datanasename
tcmadb
name
gwydlg050408vm2
tknodeusage
0
tkprocessnoderole
2
nodeid
2
---------------------------------------------------
Gathering Advanced File Transfer...
tkfiletransfer
2
databasetype
Postgres
datbasename
tcmadb
name
gwydlg050408vm2
tknodeusage
0
tkprocessnoderole
2
nodeid
3
---------------------------------------------------
Gathering AD Groups...
paramvalue
t
---------------------------------------------------
Gathering XEP-198...
paramvalue
t
---------------------------------------------------
Gathering DB Replication Status...
replicationdynamic
2
Services on this node that currently have debug logging enabled are:

Cisco Presence Engine
Cisco DRF Local
Cisco XCP File Transfer Manager

Collecting Logs for deployment_info

Collected: platformConfig.xml
Collected: deployment_info.xml
Collected: system_info.txt

To retrieve the logs, run the following CLI Command:
file get activelog epas/trace/log_2015-08-17-154010.tar.gz
To maintain a stable system it is recommended that you remove the file after retrieval.
To do this run the CLI Command:
file delete activelog epas/trace/log_2015-08-17-154010.tar.gz
Please Note: Debug logging is not enabled for any of the files you have retrieved

file check

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

file check [detection-size-kb]

Syntax Description

Parameters

Description

detection-size-kb

Specifies the minimum file size change that is required for the command to display the file as changed.

Default value: 100 KB.

Command Modes

Administrator (admin:)

Usage Guidelines

The command notifies you about a possible impact to system performance and asks you whether you want to continue.  The display includes both deleted and new files.

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

file delete

This command deletes a log on the active or inactive side.

file delete { activelog | inactivelog | install } file-spec [detail] [noconfirm]

Syntax Description

Parameters

Description

activelog

Specifies a log on the active side.

inactivelog

Specifies a log on the inactive side.

install

Specifies an installation log.

file-spec

Specifies the path and filename of the log or logs to delete (includes install log files).

detail

Shows a listing of deleted files with the date and time.

noconfirm

Deletes files without asking you to confirm each deletion.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

You cannot recover a deleted file, but you may be able to with The Disaster Recovery System.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

file delete tftp

This command deletes a TFTP file.

file delete tftp file-spec [detail] [noconfirm]

Syntax Description

Parameters

Description

file-spec

Represents the TFTP file name.

detail

Shows a listing of deleted files with the date and time.

noconfirm

Deletes files without asking you to confirm each deletion.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

You cannot recover a deleted file, but you may be able to with The Disaster Recovery System.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to:Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

- file delete dir tftp

file delete dir tftp

This command deletes the TFTP directory.

file delete dir tftp dir-name [detail]

Syntax Description

Parameters

Description

dir-name

Specifies the TFTP directory to delete.

detail

Shows a listing of deleted files with the date and time.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

You cannot recover a deleted file, but you may be able to with The Disaster Recovery System.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

file dump

This command dumps the contents of a log, a page at a time.

file dump { activelog | inactivelog | install } file-spec [hex] [recent] [ regexp expression ]

Syntax Description

Parameters

Description

activelog

Specifies a log on the active side.

inactivelog

Specifies a log on the inactive side.

install

Specifies an installation log.

file-spec

Represents the log file to dump.

hex

Shows output in hexadecimal.

recent

Dumps the most recently changed file in the directory.

regexp expression

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Example

This command dumps contents of file _cdrIndex.idx.

admin: file dump activelog cm/cdr/_cdrIndex.idx

file dump sftpdetails

This command specifies the list of files that can be dumped in the SFTP context and allows you to choose which file to dump.

file dump sftpdetails

Command Modes

Administrator (admin:)

Usage Guidelines

Enter a to dump all SFTP-related files. Enter q to exit this command.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, Cisco Unity Connection

file dump tftp

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

file dump tftp file-spec [page] [detail] [hex]

Syntax Description

Parameters

Description

file-spec

Represents the name of a TFTP file.

page

Displays the output one screen at a time.

detail

Displays the listing with the date and time.

hex

Displays the output in hexadecimal.

Command Modes

Administrator (admin:)

Usage Guidelines

Note

file-spec must resolve to a single file.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, Cisco Unity Connection

file fragmentation sdi

This command shows file fragmentation information about SDI log files.

file fragmentation sdi most { fragmented | recent } [number]

Syntax Description

Parameters

Description

most fragmented

Represents the most fragmented log files.

most recent

Represents the most recent logs files.

number

Represents the number of files to list.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

- file fragmentation sdi file

- file fragmentation sdi all

file fragmentation sdi file

This command shows file fragmentation information about an SDI log file.

file fragmentation sdi file filename [verbose]

Syntax Description

Parameters

Description

filename

Represents the SDI log file name.

verbose

Shows more detailed information on the screen.

Command Modes

Administrator (admin:)

Requirements

Command privilege level:1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

file fragmentation sdi all

This command shows file fragmentation information about all SDI log files in the directory.

file fragmentation sdi all filename

Syntax Description

Parameters

Description

filename

Specifies the SDI log file name for which you want to show all fragmentation details.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

file fragmentation sdl

This command shows file fragmentation information about the most fragmented SDL log files.

file fragmentation sdl most { fragmented | recent } [number]

Syntax Description

Parameters

Description

most fragmented

Represents the most fragmented log files.

most recent

Represents the most recent log files.

number

Represents the number of files to list.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection.

- file fragmentation sdl file

- file fragmentation sdl all

file fragmentation sdl file

This command displays file fragmentation information about an SDL log file.

file fragmentation sdl file filename [verbose]

Syntax Description

Parameters

Description

filename

Represents the file name of the SDL log file.

verbose

Shows more detailed information on the screen.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection.

file fragmentation sdl all

This command shows file fragmentation information about all SDL log files in the directory.

file fragmentation sdl all filename

Syntax Description

Parameters

Description

filename

Represents the file name for which you want to show all fragmentation details.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection.

file get

This command sends a log to another system by using SFTP.

file get { activelog | inactivelog | install } file-spec [ reltime | abstime ] [ match regex ] [recurs] [compress]

Syntax Description

Parameters

Description

activelog

Specifies a log on the active side.

inactivelog

Specifies a log on the inactive side.

install

Specifies an installation log.

file-spec

Specifies the name of the file to transfer.

reltime

The relative time period, specified in minutes | hours | days | weeks | months | time value

abstime

The absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY

match regex

Match a particular string in the filename, specified as regex.

recurs

Get all files, including subdirectories.

compress

Transfer files as compressed file.

tftp

Command Modes

Administrator (admin:)

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

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Example

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

admin: file get activelog platform match plat

This example 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 get salog

file get salog

This command sends the partBsalog or salog directory to another system by using SFTP.

file get { partBsalog | salog } file-spec [ reltime | abstime ] [ match regex ] [recurs] [compress]

Syntax Description

Parameters

Description

partBsalog

Specifies the partBsalog directory.

salog

Specifies the salog directory.

file-spec

Specifies the name of the file to transfer.

reltime

The relative time period, specified in minutes | hours | days | weeks | months | time value

abstime

The absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY

match regex

Match a particular string in the filename, specified as regex.

recurs

Get all files, including subdirectories.

compress

Transfer files as compressed file.

Command Modes

Administrator (admin:)

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

Applies to: Unified Communications Manager, Cisco Unity Connection

file get tftp

This command sends a TFTP file to another system by using SFTP.

file get tftp file-spec [ reltime | abstime ] [ match regex ] [recurs] [compress]

Syntax Description

Parameters

Description

file-spec

Specifies the name of the TFTP file to transfer.

reltime

The relative time period, specified in minutes | hours | days | weeks | months | time value

abstime

The absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY

match regex

Match a particular string in the filename, specified as regex.

recurs

Get all files, including subdirectories.

compress

Transfer files as compressed file.

Command Modes

Administrator (admin:)

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

Applies to: Unified Communications Manager, Cisco Unity Connection

file list

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

file list { activelog | inactivelog | install } file-spec [ page | detail | reverse ] [ date | size ]

Syntax Description

Parameters

Description

activelog

Specifies a log on the active side.

inactivelog

Specifies a log on the inactive side.

install

Specifies an installation log.

file-spec

Specifies the name of the log file .

page

Shows the output one screen at a time.

detail

Shows a detailed listing with date and time.

reverse

Reverses the sort direction.

date

Sorts files by date.

size

Sorts files by size.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Example: Log Files with Details

This example lists operating system log files with details.

admin: file list activelog platform/log page detail

This example lists directories in CDR repository.

admin: file list activelog cm/cdr_repository

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

admin: file list activelog cm/cdr_repository/processed/20050812 size

- file list salog

file list salog

This command lists the partBsalog or salog directory.

file list { partBsalog | salog } file-spec [ page | detail | reverse ] [ date | size ]

Syntax Description

Parameters

Description

partBsalog

Specifies the partBsalog log directory.

salog

Specifies the salog log directory.

file-spec

Specifies the path to the file or files to list.

page

Shows the output one screen at a time.

detail

Shows a detailed listing with date and time.

reverse

Reverses the sort direction.

date

Sorts files by date.

size

Sorts files by size.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to:Unified Communications Manager, Cisco Unity Connection

file list tftp

This command lists TFTP files.

file list tftp file-spec [ page | detail | reverse ] [ date | size ]

Syntax Description

Parameters

Description

file-spec

Specifies the name of the TFTP file .

page

Shows the output one screen at a time.

detail

Shows a detailed listing with date and time.

reverse

Reverses the sort direction.

date

Sorts files by date.

size

Sorts files by size.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, Cisco Unity Connection

file search

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

file search { activelog | inactivelog | install } file-spec [ reltime | abstime ] [ignorecase]

Syntax Description

Parameters

Description

activelog

Specifies a log on the active side.

inactivelog

Specifies a log on the inactive side.

install

Specifies an installation log.

file-spec

Specifies the name of the file to search.

reltime

The relative time period, specified in minutes | hours | days | weeks | months | time value

abstime

The absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY

ignorecase

Ignores case in a search.

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

file search tftp

This command searches the content of a TFTP file and shows the matching lines a page at a time.

file search tftp file-spec [ reltime | abstime ] [ignorecase]

Syntax Description

Parameters

Description

file-spec

Specifies the name of the TFTP file to search.

reltime

The relative time period, specified in minutes | hours | days | weeks | months | time value

abstime

The absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY

ignorecase

Ignores case in a search.

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

file tail activelog

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

file tail { activelog | inactivelog | install } filespec [hex] [lines] [ regexp expression ]

Syntax Description

Parameters

Description

activelog

Specifies a log on the active side.

inactivelog

Specifies a log on the inactive side.

install

Specifies an installation log.

filespec

Specifies the path to the file. You can use the wildcard character, *, for filename as long as it resolves to one file.

hex

Show the listing in hexadecimal.

lines

Specifies the number of lines to display.

regexp expression

Tails log files that match expression

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Example

This example tails the operating system CLI log file.

admin: file tail activelog platform/log/cli00001.log

file tail tftp

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

file tail tftp filespec [detail] [hex] [lines]

Syntax Description

Parameters

Description

filespec

Specifies the path to the file. You can use the wildcard character, *, for filename as long as it resolves to one file.

detail

Long listing with date and time

hex

Show the listing in hexadecimal.

lines

Specifies the number of lines to display.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, Cisco Unity Connection

file view

This command shows the contents of log files.

file view { activelog | inactivelog | install } file-spec

Syntax Description

Parameters

Description

activelog

Shows the contents of an active side logging files

inactivelog

Shows the contents of an inactive side logging files

install

Shows the contents of an install logging file

file-spec

Specifies the path to the file to view. You can use the wildcard character, *, as long as it resolves to one file.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on Unified Communications Manager, Cisco Unity Connection

Example

This example shows a particular CDR log on the active side.

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

- file view system-management-log

file view system-management-log

This command shows the contents of the Integrated Management Logs (IML).

file view system-management-log

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, Cisco Unity Connection

file view tftp

This command displays the contents of the installation log.

file view tftp file-spec

Syntax Description

Parameters

Description

file-spec

Specifies the path to the file to view. You can use the wildcard character, *, as long as it resolves to one file.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, Cisco Unity Connection

Chapter 4. License Commands

- license client reset registration

- license file

- license management system remove

- license management unlock admin

license client reset registration

Use this command to reset the license client registration state to unregistered.

license client reset registration

Command Modes

Administrator (admin)

Requirements

Command privilege level: 1 and 4

Allowed during upgrade: No

Applies to: Cisco Prime License Manager

license file

This command asks to select a license file from a list.

license file { diagnose | get }

Syntax Description

Parameters

Description

diagnose

Prints diagnostic information of the selected file.

get

Creates a TAR file of the license file(s) on the system and transfers the TAR file to a remote area.

Command Modes

Administrator (admin:)

Requirements

Command privilege level for diagnose : 1 and 4

Command privilege level for get : 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management change user name

This command takes parameters interactively and changes the username of the administrator.

license management change user { name }

Syntax Description

Parameters

Description

name

Specifies the administrator username.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management reset user password

This command takes parameters interactively and changes the password of the administrator.

license management reset user { password }

Syntax Description

Parameters

Description

password

Specifies the administrator password.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Prime License Manager

license management list users

This command lists the administrative users.

license management list users

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0,1, and 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management product re-register all

This command forces re-registration of all product instances associated with this Enterprise License Manager/Cisco Prime License Manager server. This command may take some time for re-registration and synchronization with all product instances to complete.

license management product re-register all

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1 and 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management reset

This command resets the identity, store data, and essentially removes all the installed licenses. It also restarts the Cisco Prime License Manager server process to make the changes effective.

license management reset { identity | registration }

Syntax Description

Parameters

Description

identity

Resets the identity

registration

Resets the registration

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management security update

Use this command to download the Cisco Prime License Manager security update from the specified remote server location and install the contents of the specified security update file.

license management security update

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management service

This command activates or deactivates a given service on the Cisco Prime License Manager server.

license management service { activate | deactivate }

Syntax Description

Parameters

Description

activate

Activates a given service on the Cisco Prime License Manager server.

deactivate

Deactivates a given service on the Cisco Prime License Manager server.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1 and 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management set log level core_services

This command sets the log level for core services.

license management set log level core_services { error | warning | info | debug }

Syntax Description

Parameters

Description

error

Provides runtime errors or unexpected conditions that could be critical.

warning

Provides messages about potential problems.

info

Provides general information that may be useful. This parameter is set by default.

debug

Provides detailed information about the flow of the process. We recommend that you use set this parameter on an as needed basis only.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0, 1, and 4

Allowed during upgrade: No

Applies to: Cisco Prime License Manager.

license management set log level product_instances

This command sets the log level for product instances.

license management set log level product_instances { error | warning | info | debug }

Syntax Description

Parameters

Description

error

Provides runtime errors or unexpected conditions that could be critical.

warning

Provides messages about potential problems.

info

Provides general information that may be useful. This parameter is set by default.

debug

Provides detailed information about the flow of the process. We recommend that you use set this parameter on an as needed basis only.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0,1, and 4

Allowed during upgrade: No

Applies to: Cisco Prime License Manager.

license management show log level core_services

This command displays the current log level for core services.

license management show log level core_services

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Prime License Manager.

license management show log level product_instances

This command displays the current log level for product instances.

license management show log level product_instances

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Prime License Manager.

license management show system

This command lists the administrative users.

license management show system

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1 and 4

Allowed during upgrade: No

Applies to: Enterprise License Manager, Cisco Prime License Manager

license management system remove

This command allows you to remove an unused Cisco Prime License Manager instance from a coresident deployment.

license management system remove

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Prime License Manager

license management unlock admin

Use this command to unlock a Cisco Prime Licence Manager server defined user. The command prompts for the name of the user to unlock.

license management unlock admin

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1 and 4

Allowed during upgrade: No

Applies to: Cisco Prime License Manager

Chapter 5. Run Commands

- run loadcsv

- run loadxml

- run sql

- run pe sql

run cuc dbquery

This command runs an SQL query and displays the results.

run cuc dbquery database_name sql_query [page]

Syntax Description

Parameters

Description

database_name

Specifies the database that sql_statement operates on.

Note:
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. This data includes 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_query

Specifies the SQL query that you want to run.

page

Shows the output one page at a time.

Note:
Be aware that page is case sensitive.

Command Modes

Administrator (admin:)

Usage Guidelines

You can also use the run cuc dbquery command with the csp_ConfigurationModify procedure, which configures the Wait for Blind Transfer Ringing timer. The command usage for this timer is as follows:

run cuc dbquery unitydirdb execute procedure csp_ConfigurationModify(pFullName='System.Telephony.WaitForBlindTransferLongTimeoutMs',pvaluelong="new value"

where, new value specifies the value of the Wait for Blind Transfer Ringing Timer parameter. The default and minimum value of this parameter is 500ms. The maximum value of this parameter can be 5000ms.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

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

admin: run cuc dbquery unitydirdb select alias from vw_usertemplate

alias

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

AdministratorTemplate

VoiceMailUserTemplate

run cuc preupgrade test

This command verifies the state of the connection server on which the upgrade process is to be performed and specifies the actions that can be taken before upgrading the system.

run cuc preupgrade test

Command Modes

Administrator (admin:)

Usage Guidelines

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

admin:run cuc preupgrade test
===========================================================================
DISCLAIMER ::
This cli command should be executed from publisher before upgrade to
check system health. This cli command is not intended to correct the
system state , rather it aims at informing the administrator what all
actions are advised to be taken before running upgrade.
===========================================================================
Checking connection db. Please wait...Done
Checking critical services. Please wait...Done
Checking cluster state. Please wait...Done
Checking cop file installation. Please wait...Done
Checking locales installation. Please wait...Done
Checking drs backup history. Please wait...Done
===========================================================================
R E P O R T    C A R D
===========================================================================
Locales Installation Test: PASS
Connection DB Test: PASS
DRS Backup History Test: FAIL
Cluster State Test: SKIPPED
Critical Services Test: PASS
Cop File Installation Test: SKIPPED
===========================================================================
A C T I O N   S U M M A R Y
===========================================================================
ACTION : Connection DB is online.
NO constraints were found disabled in :unitydirdb,NO ACTION required before upgrade.
NO indexes were found disabled in :unitydirdb,NO ACTION required before upgrade.
NO constraints were found disabled in :unitydyndb,NO ACTION required before upgrade.
NO indexes were found disabled in :unitydyndb,NO ACTION required before upgrade.
NO constraints were found disabled in :unitymbxdb1,NO ACTION required before upgrade.
NO indexes were found disabled in :unitymbxdb1,NO ACTION required before upgrade.
NO constraints were found disabled in :unityrptdb,NO ACTION required before upgrade.
NO indexes were found disabled in :unityrptdb,NO ACTION required before upgrade.
Connection DB state is GOOD,NO ACTION required before upgrade.
ACTION : All Critical services are running ,NO ACTION required before upgrade.
ACTION : Standalone/Cores detected , excluding cluster state checking
ACTION : Skipping COP installation check, product version detected :'8.6.2.21018-1',NO ACTION required before upgrade.
ACTION : No locales were found installed ,NO ACTION required before upgrade.
ACTION : Make Sure DRS backup is taken aleast a day before upgrade.
Check report /var/log/active/cuc/cli/preupgrade_120325-224523.txt for details.

run cuc smtptest

This command initiates a test that helps to verify the outgoing or incoming SMTP configuration for SpeechView transcriptions.

run cuc smtptest email-address

Syntax Description

Parameters

Description

email-address

Specifies the email address.

Command Modes

Administrator (admin:)

Usage Guidelines

The test sends a test message to a specified email address. You then access the email account and reply to the test message without changing the subject line. The test passes after the Cisco Unity Connection server receives the response. The success or failure of parts of the test help to pinpoint problems in the outgoing or incoming SMTP configuration for transcriptions.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection.

Example

The following example runs the Sysagent task CleanDeletedMessagesTask.

admin: run cuc sysagent task CleanDeletedMessagesTask

run cuc sysagent task

This command runs a Sysagent task.

run cuc sysagent task task_name

Syntax Description

Parameters

Description

task_name

Specifies the name of the Sysagent task that you want to run.

In an HTTP(S) network, you need to provide the HTTP(S) link display name as a parameter in the command to run directory synchronization (Data.LocalNetworkSync) and voice name synchronization (Data.LocalNetworkSync.Voicename) tasks. The syntax is shown below:

run cuc sysagent task task_name HTTP(S)LinkDisplayName

The following example runs the Data.LocalNetworkSync task:

admin: run cuc sysagent task Data.LocalNetworkSync HTTP(S)LinkDisplayName1

Data.LocalNetworkSync started

Where HTTP(S)LinkDisplayName is the display name of the HTTP(S) link with which you want to synchronize the directory information.

Note

Before running the command, make sure that the scheduled task for directory or voice name synchronization is disabled for the specified HTTP(S) link "HTTP(S)LinkDisplayName" to avoid any issues in synchronization.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Applies to: Cisco Unity Connection

Example

The following example runs the Sysagent task Umss.CleanDeletedMessagesTask.

admin: run cuc sysagent task Umss.CleanDeletedMessagesTask

Umss.CleanDeletedMessagesTask started

run cuc vui rebuild

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

run cuc vui rebuild

Command Modes

Administrator (admin:)

Usage Guidelines

This command rebuilds only grammars that have changes flagged in the database. This command ignores name grammar update blackout schedules and executes 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

Applies to: Cisco Unity Connection

run loadcsv

This command is used on the publisher node to install the csv files that are available on a server.

run loadcsv

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

run loadxml

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

run loadxml

Command Modes

Administrator (admin:)

Usage Guidelines

Note

This command is processor intensive, and you may need to restart some services after you run this command.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

run sql

This command allows you to run an SQL command.

run sql sql_statement

Syntax Description

Parameters

Description

sql_statement

Specifies the SQL command to run.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: 0

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Note

Users with ordinary privileges can run read-only SQL commands.

Example

This example runs an SQL command.

admin: run sql select name from device

run pe sql

This command allows you to run an input SQL statement against the specified presence datastore.

run pe sql datastore_name sql_statement

Syntax Description

Parameters

Description

datastore_name

Represents the name of the datastore.

sql_statement

Represents the SQL command to run.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: IM and Presence service on Unified Communications Manager

Note

Users with ordinary privileges can run read-only SQL commands.

Example

This example runs an SQL command against the datastore.

admin: run pe sql ttsoft select * from presenceeventtable

Chapter 6. Set Commands

- set commandcount

- set csr gen

- set cuc srsv timeout

- set cuc trace

- set date

- set logging

- set Login Grace Timeout

- Set replication-sync monitor

- set samltrace level

- set session maxlimit

- set smtp

- set timezone

- set tlsresumptiontimeout

- set tlstrace*

- set web-security

- set webapp session timeout

- set workingdir

set account enable

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

set account enable user-id

Syntax Description

Parameters

Description

user-id

Specifies the user ID of the account that was disabled.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

set account name

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

set account name name

Syntax Description

Parameters

Description

name

Represents the username for the new account.

Command Modes

Administrator (admin:)

Usage Guidelines

After you enter the username, the system prompts you to enter the privilege level (0 or 1) and password for the new account. The privilege levels 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 Communications Manager installs has a privilege level of 4. The administrator can run all commands in the CLI.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

set accountlocking

This command enables or disables account locking for the current administration accounts.

set accountlocking { enable | disable }

Syntax Description

Parameters

Description

enable

Enable account locking.

disable

Disable account locking.

Command Modes

Administrator (admin:)

Usage Guidelines

Note

After you run this command with enable, the system automatically enables account lockout notification after the system enables the audit logging function.

Requirements

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

set accountlocking count

This command sets the global consecutive failed sign-in attempt count that triggers locking a user account.

set accountlocking count attempts

Syntax Description

Parameters

Description

attempts

Represents the number of consecutive sign-in attempts before the system locks the account.

Value Range: 2-5

Default value: 3

Command Modes

Administrator (admin:)

Usage Guidelines

To change the global value for consecutive failed sign-in attempts before the system locks a user account, execute this command.

Note

This command is only valid when account locking is enabled. If account locking is disabled, the system does not remember the account locking value and uses the default value, 3, after you enable account locking.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

set accountlocking unlocktime

This command configures the unlock time for the current Unified Communications Manager admin accounts.

set accountlocking unlocktime seconds

Syntax Description

Parameters

Description

seconds

Specifies the unlock time in seconds.

Value Range: 30-3600

Default value: 300

Note

- The account gets automatically unlocked only after the configured unlock time.

- This command is only valid when account locking is enabled. If account locking is disabled, the system does not remember the account locking unlock time and uses the default value, 300, after you enable account locking.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

set cert bulk consolidate

This command consolidates all the certificates that are available on the unit.

set cert bulk consolidate unit

Syntax Description

Parameters

Description

unit

Represents the unit name.

Command Modes

Administrator (admin:)

Usage Guidelines

You must specify the SFTP server information to use for cert bulk operations.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Related References

set cert bulk sftp

set cert bulk export

This command exports all the certificates that are available on the unit.

set cert bulk export unit

Syntax Description

Parameters

Description

export

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

unit

Represents the unit name.

Command Modes

Administrator (admin:)

Usage Guidelines

You must specify the SFTP server information to use for cert bulk operations.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

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

Related References

set cert bulk sftp

set cert bulk import

This command imports the certificates that are in the SFTP location into the specified unit trust-store.

set cert bulk import unit

Syntax Description

Parameters

Description

unit

Represents the unit name.

Command Modes

Administrator (admin:)

Usage Guidelines

You must specify the SFTP server information to use for cert bulk operations.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

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

Related References

set cert bulk sftp

set cert bulk sftp

This command prompts for the SFTP server information to use for bulk operations.

set cert bulk sftp

Command Modes

Administrator (admin:)

Usage Guidelines

You must specify the SFTP server information to use for cert bulk operations.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set cert delete

This command deletes a specific certificate file from the trust unit.

set cert delete unit name

Syntax Description

Parameters

Description

unit

Specifies the name of the trust category, as "own" or "trust".

name

Certificate file name.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set cert delete cucm siptest.pem

set cert import

This command imports the specified certificate for the specified certificate type.

set cert import type name [caCert]

Syntax Description

Parameters

Description

type

Specifies the certificate type as "own" or "trust".

name

Represents the unit name.

caCert

Represents the name of the CA certificate file name.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set cert import trust tomcat
Successfully imported certificate for tomcat.
Please restart services related to tomcat for the new certificate to
become active.

set cert regen

This command regenerates the certificate for the specified unit.

set cert regen name

Syntax Description

Parameters

Description

name

Represents the unit name.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

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

set cert regen ITLRecovery

This command regenerates the ITLRecovery certificate for the specified unit.

After you type this command, a warning message appears displaying that if you are using a tokenless CTL and if the you are regenerating the CallManager certificate, ensure that the CTL file has the updated CallManager certificate and that certificate is updated to endpoints. To regenerate the certificate, type yes or else type no.

set cert regen ITLRecovery

Syntax Description

Parameters

Description

ITLRecovery

Represents the ITLRecovery certificate.

Command Modes

Administrator (admin:)

Requirements

Caution

You must restart the services related to ITLRecovery for the regenerated certificates to become active.

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set cert regen ITLRecovery

WARNING: If you are using a tokenless CTL and if the CallManager certificate is recently
generated, please ensure that the CTL File already has the new CallManager certificate and is
updated to the endpoints, before generating the ITL Recovery certificate. Are you sure want
to proceed?

Proceed with regeneration (yes|no)? yes

Successfully Regenerated Certificate for ITLRecovery.

You must restart the services related to ITLRecovery for the regenerated certificates to
become active.

set cli pagination

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

set cli pagination { on | off }

Syntax Description

Parameters

Description

on

Turns pagination on.

off

Turns pagination off.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

admin:set cli pagination off
Automatic pagination is turned off

set cli session timeout

This command sets the time, in minutes, after which an active CLI session times out and disconnects.

set cli session timeout minutes

Syntax Description

Parameters

Description

minutes

Specifies the time, in minutes, that can elapse before an active CLI session times out and disconnects.

- Value range: 5-99999 minutes

- Default value: 30 minutes

Command Modes

Administrator (admin:)

Usage Guidelines

Be aware that the new session timeout value becomes effective immediately for a new CLI session; however, active sessions retain their original timeout value. Also the show cli session timeout command reflects the new value, even if the current session does not use that value.

Note

This setting gets preserved through a software upgrade and does not get reset to the default value.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set commandcount

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

set commandcount { enable | disable }

Syntax Description

Parameters

Description

enable

Turns on command count.

disable

Turns off command count.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set csr gen

This command generates the csr for the unit name.

set csr gen name

Syntax Description

Parameters

Description

name

Specifies the unit on which the certificate is generated.

Command Modes

Administrator (admin:)

Requirements

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set csr gen tomcat
Successfully Generated CSR for tomcat.

Requirements

Command privilege level: 1

Allowed during upgrade: No

set cuc jetty stderrlog

This command enables or disables the error log getting generated while any standard error occurs during communicating with the Jetty server. This error log gets generated and is available at the path /var/log/active/jetty/.

set cuc jetty stderrlog { enable | disable }

Syntax Description

Parameters

Description

enable

Enables the error log on the Jetty server. Be aware that enable is case sensitive.

disable

Disables the error log on the Jetty server. Be aware that disable is case sensitive.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

You must restart the Jetty services after enabling or disabling the error log on the Jetty server.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unity Connection only.

Enable Error Log on Jetty Server Example

admin:set cuc jetty stderrlog enable

Command is executed successfully
To effect changes restart jetty server
Restart Jetty Server through Unity Connection Serviciabilty .
Go to Tools -> Service Management -> Restart Connection Jetty Service.
Check the logs that should not be generated after running above command.
Check the requestlog by sending one voice message through webinbox.
Notifications should not come in logs

set cuc jetty stdoutlog

This command enables or disables the standard input and output log getting generated while communicating with Jetty server. This standard input and output log gets generated and is available at the path /var/log/active/jetty/.

set cuc jetty stdoutlog { enable | disable }

Syntax Description

Parameters

Description

enable

Enables the standard input and output log on the Jetty server. Be aware that enable is case sensitive.

disable

Disables the standard input and output log on the Jetty server. Be aware that disable is case sensitive.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

You must restart the Jetty services after enabling or disabling the standard input and output log on the Jetty server.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unity Connection only.

Enable Standard Input and Output Log on Jetty Server Example

admin:set cuc jetty stdoutlog enable

Command is executed successfully
To effect changes restart jetty server
Restart Jetty Server through Unity Connection Serviciabilty .
Go to Tools -> Service Management -> Restart Connection Jetty Service.
Check the logs that should not be generated after running above command.
Check the requestlog by sending one voice message through webinbox.
Notifications should not  come in logs

set cuc jetty requestlog

This command enables or disables the request log getting generated from the Jetty server while any request is raised for notifications. This request log gets generated and is available at the path /usr/local/jetty/logs/.

set cuc jetty requestlog { enable | disable }

Syntax Description

Parameters

Description

enable

Enables the request log on the Jetty server. Be aware that "enable" is case sensitive.

disable

Disables the request log on the Jetty server. Be aware that "disable" is case sensitive.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

You must restart the Jetty services after enabling or disabling the request log on the Jetty server.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unity Connection only.

Enable Request Log on Jetty Server Example

admin:set cuc jetty requestlog enable

Command is executed successfully
To effect changes restart jetty server
Restart Jetty Server through Unity Connection Serviciabilty .
Go to Tools -> Service Management -> Restart Connection Jetty Service.
Check the logs that should not be generated after running above command.
Check the requestlog by sending one voice message through webinbox.
Notifications should not come in logs

set cuc srsv timeout

This command sets the value for SRSV session timeout.

set cuc srsv timeout timeout_value

Syntax Description

Parameters

Description

timeout_value

Sets the time for session logout.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

set cuc trace

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

set cuc trace { enable | disable } trace_name level

Syntax Description

Parameters

Description

enable

Enables Connection traces.

disable

Disables Connection traces.

trace_name

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

level

Specifies the level or levels 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 enable or disable multiple levels, use a comma to separate levels and a hyphen to indicate a range of levels. Do not include spaces.

Command Modes

Administrator (admin:)

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: No

Applies to: Cisco Unity Connection only.

Enable VUI Traces 1, 13, and 17 Through 20 Example

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

Disable VUI Traces 17 Through 20 While VUI Trace Levels 1 and 13 Remain Set Example

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

Related References

show cuc trace levels

set date

This command changes the time and date on the server.

set date HH:mm:ss:MM/DD/YY

Syntax Description

Parameters

Description

HH:mm:ss

Represents the time format (24 hours format).

MM/DD/YY

Represents the date format.
Note:
Date format MM/DD/YYYY is also accepted.

Command Modes

Administrator (admin:)

Usage Guidelines

If the server is configured to synchronize with external NTP servers, this command requires the user to remove all of those NTP servers.

Requirements

Applies to: Unified Communications Manager and Cisco Unity Connection.

Set Date and Time to 2:10:33 Pm April 13th 2012 Example

admin:set date 14:10:33:04/13/12

Requirements

Command privilege level: 1

Allowed during upgrade: No

set dscp defaults

This command sets the factory default DSCP settings for all of the port tags.

set dscp defaults

Command Modes

Administrator (admin:)

Usage Guidelines

All non-default DSCP settings get removed after you run this command.

You can use the command show dscp defaults to see the factory default DSCP settings.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set dscp

This command enables or disables DSCP marking on outgoing TCP or UDP packets. You can enable or disable DSCP on a single port tag, or on all port tags at once.

set dscp { enable | disable } { all | port_tag }

Syntax Description

Parameters

Description

all

Disables all DSCP port tags.

port_tag

Represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field displayed when you use the command show dscp defaults. The set of port tags is predefined.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set dscp marking

This command sets DSCP markings on port tags by using well-known DSCP classes and numeric values.

set dscp marking port_tag value

Syntax Description

Parameters

Description

port_tag

Represents a DSCP port tag, which is a string that is mapped to a TCP or UDP port to identify the application that uses the port. This value is for the portTag field displayed when you use the command show dscp defaults. The set of port tags is predefined.

value

A DSCP value. You can enter the name of a well-known DSCP class or a numeric value in decimal or hexadecimal format. Precede hexadecimal values with 0x or 0X.

Command Modes

Administrator (admin:)

Usage Guidelines

The valid class names as defined by DSCP are:

- Class Selector: values CS0, CS1, CS2, CS3, CS5, CS6, CS7

The class selector (CS) values correspond to IP Precedence values and are fully compatible with IP Precedence.

- Expedited Forwarding: value EF

EF PHB is ideally suited for applications such as VoIP that require low bandwidth, guaranteed bandwidth, low delay, and low jitter.

- Best Effort: value BE

Also called default PHB, this value essentially specifies that a packet be marked with 0x00, which gets

the traditional best-effort service from the network router.

- Assured Forwarding: values AF11, AF12, AF13, AF21, AF22, AF23, AF41, AF42, AF43

There are four types of Assured Forwarding classes, each of which has three drop precedence values.

These precedence values define the order in which a packet is dropped (if needed) due to network

congestion. For example, packets in AF13 class are dropped before packets in the AF12 class.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set ipsec policy_group

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

set ipsec policy_group { ALL | group }

Syntax Description

Parameters

Description

ALL

Enables all ipsec policy groups.

group

Specifies the name of a particular ipsec policy group to enable.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager and Cisco Unity Connection.

set ipsec policy_name

This command enables the specified ipsec policy.

set ipsec policy_name { ALL | policy_name }

Syntax Description

Parameters

Description

ALL

Enables all ipsec policies.

policy_name

Specifies the name of a particular ipsec policy to enable.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager and Cisco Unity Connection.

set logging

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

set logging { enable | disable }

Syntax Description

Parameters

Description

enable

Turns on logging.

disable

Turns off logging.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set Login Grace Timeout

This command allows you to configure the LoginGraceTimeout value to the mentioned value.

set Login Grace Timeout LoginGraceTimeout value

Syntax Description

Parameters

Description

LoginGraceTimeout value

Sets the LoginGraceTimeout value for login grace timeout.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network cluster publisher

This command sets the network cluster publisher hostname and IP address.

set network cluster publisher { hostname | ip } name

Syntax Description

Parameters

Description

hostname

Specifies the hostname of the network cluster.

ip

Specifies the ip address of the network cluster.

name

Hostname or IP address to assign to the network cluster publisher.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network cluster subscriber details

Use this command to add subscriber to the processnode or appserver table when Tomcat Webserver is server down and GUI is inaccessible.

set network cluster subscriber details servertype hostname ip domainname

Syntax Description

Parameter

Description

servertype

Choose one of these products for this parameter—Cisco Unified Communications Manager, IM and Presence Service, and Cisco Unity Connection. This field is mandatory.

hostname

The hostname of the node that you add to the cluster. The hostname is supported on the same domain. This field is mandatory.

ip

The IPv4 address of the node that you add to the cluster. This field is mandatory for IM and Presence publisher and Cisco Unity Connection.

domainname

The domain name of the IM and Presence Service publisher. This field is mandatory for IM and Presence publisher.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to Cisco Unified Communications Manager, IM and Presence Service, and Cisco Unity Connection

set network cluster subscriber dynamic-cluster-configuration

Use this command to enable the Dynamic Cluster Configuration on the publisher. Use this command to specify the duration in which you can add subscriber nodes to the publisher server table. The addition of subscriber nodes is authenticated immediately and those nodes need not wait for the publisher details during the installation of the subscriber nodes.

set network cluster subscriber dynamic-cluster-configuration { default | no. of hours }

Syntax Description

Parameter

Description

default

Enables the Dynamic Cluster Configuration for 24 hours.

no. of hours

Specifies a value from 1 to 24 hours.

Command Modes

Administrator (admin)

Requirements

Applies to Cisco Unified Communications Manager, IM and Presence Service, and Cisco Unity Connection

set network dhcp eth0

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

set network dhcp eth0 { enable | disable } { node_ip | net_mask | gateway_ip }

Syntax Description

Parameters

Description

eth0

Specifies Ethernet interface 0.

enable

This enables DHCP.

disable

This disables DHCP.

disable

This disables DHCP.

node_ip

Represents the static IP address for the server.

net_mask

Represents the subnet mask for the server.

gateway_ip

Represents the IP address of the default gateway.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network dns

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

set network dns { primary | secondary } addr

Syntax Description

Parameters

Description

primary

secondary

addr

Represents the IP address of the primary or secondary DNS server.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network dns options

This command sets DNS options.

set network dns options [ timeout | seconds ] [ attempts | number ] [ rotate ]

Syntax Description

Parameters

Description

timeout

Sets the DNS timeout.

attempts

Sets the number of times to attempt a DNS request.

rotate

Causes the system to rotate among the configured DNS servers and distribute the load.

seconds

Specifies the DNS timeout period in seconds.

number

Specifies the number of attempts.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network domain

This command sets the domain name for the system.

Note

Changing the domain name triggers an automatic regeneration of all Cisco Unified Communications Manager certificates, including any third party signed certificates that have been uploaded. After the server reboots automatically, phones running in secure (mixed) mode cannot connect to the server until after the CTL client updates the new CTL file to the phones.

Note

Reboot the servers one at a time in order for the phones to register correctly. For more information about changing the domain name, see Changing the IP Address and Hostname for Cisco Unified Communications Manager.

set network domain [domain-name]

Syntax Description

Parameters

Description

domain_name

Represents the system domain that you want to assign.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network failover

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

set network failover { ena | dis }

Syntax Description

Parameters

Description

ena

Enables Network Fault Tolerance.

dis

Disables Network Fault Tolerance.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network gateway

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

set network gateway addr

Syntax Description

Parameters

Description

addr

Represents the IP address of the network gateway that you want to assign.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set network hostname

This command allows an administrator to set the network host name, change the IP address of the node, and restart the system.

Before attempting this command, the administrator should have a valid DRF backup. Additionally, before attempting a Hostname (or Hostname and IP address) change, the administrator should perform the following:

- verify the cluster configuration does not have any configuration problems by executing show hcs cluster verify detailed

- update the cluster configuration by executing set hcs cluster config

- validate the cluster configuration by executing show hcs cluster verify detailed

set network hostname hostname

Syntax Description

Parameters

Description

hostname

Represents the new network hostname of the system.

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set network hostname

WARNING: Changing this setting will invalidate software license
on this server. The license will have to be re-hosted.
Continue(y/n):
Continue (y/n)?y

ctrl-c: To quit the input.

*** W A R N I N G ***
Do not close this window without first canceling the command.

This command will automatically restart system services.
The command should not be issued during normal operating
hours.

=======================================================
Note: Please verify that the new hostname is a unique
name across the cluster and, if DNS services are
utilized, any DNS configuration is completed
before proceeding.
=======================================================

Security Warning : This operation will regenerate
all CUCM Certificates including any third party
signed Certificates that have been uploaded.

Enter the hostname:: app-lfwelty5
Would you like to change the network ip address at this time [yes]::

Warning: Do not close this window until command finishes.

ctrl-c: To quit the input.

*** W A R N I N G ***
=======================================================
Note: Please verify that the new ip address is unique
across the cluster.
=======================================================

Enter the ip address:: 106.1.34.154
Enter the ip subnet mask:: 255.0.0.0
Enter the ip address of the gateway:: 106.1.1.1
Hostname: app-lfwelty5
IP Address: 106.1.34.154
IP Subnet Mask: 255.0.0.0
Gateway: 106.1.1.1

Do you want to continue [yes/no]? yes
...

Note

The administrator can change both the hostname and IP address by responding yes. To change just the hostname, respond no.

set network ip eth0

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

Before attempting this command, the administrator should have a valid DRF backup. Additionally, before attempting an IP address change, the administrator should perform the following:

- verify the cluster configuration does not have any configuration problems by executing show hcs cluster verify detailed

- update the cluster configuration by executing set hcs cluster config

- validate the cluster configuration by executing show hcs cluster verify detailed

set network ip eth0 addr mask gw

Syntax Description

Parameters

Description

eth0

Specifies Ethernet interface 0.

addr

Represents the IP address that you want to assign.

mask

Represents the IP mask that you want to assign.

gw

Represents the IP default gw that you want to assign.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set network ipv6 dhcp

This command sets the DHCPv6 client on the server and enables IPv6 support. For changes to take effect, you must restart the server.

set network ipv6 dhcp { enable | disable } [reboot]

Syntax Description

Parameters

Description

dhcp

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

enable

Enables IPv6 support.

disable

Disables IPv6 support.

reboot

(Optional) Causes the server to automatically restart after you enter the command.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Unified Communications Manager, and Cisco Unity Connection.

set network ipv6 gateway

This command sets the IPv6 gateway for the server. For changes to take effect, you must restart the server.

set network ipv6 gateway addr [reboot]

Syntax Description

Parameters

Description

gateway

Sets the IPv6 gateway for the server. By default, the server does not restart after you set the IPv6 gateway for the server. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.

addr

The IPv6 gateway address.

reboot

(Optional) Causes the server to automatically restart after you enter the command.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Unified Communications Manager, and Cisco Unity Connection.

set network ipv6 service

This command enables or disables the IPv6 service on the server. For changes to take effect, you must restart the server.

set network ipv6 service { enable | disable } [reboot]

Syntax Description

Parameters

Description

service

Sets the IPv6 service on the server. By default, the server does not restart after you enable or disable the IPv6 service on the server. For your changes to take effect, you must restart the server by either entering the reboot parameter or manually restarting the server.

enable

Enables IPv6 service on the server.

disable

Disables IPv6 service on the server.

reboot

(Optional) Causes the server to automatically restart after you enter the command.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Unified Communications Manager, and Cisco Unity Connection.

set network ipv6 static_address

This command assigns the static IPv6 address to the server. For changes to take effect, you must restart the server.

set network ipv6 static_address addr mask [reboot]

Syntax Description

Parameters

Description

static_address

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

addr

Specifies the static IPv6 address you assign to the server.

mask

Specifies the IPv6 network mask (0-128).

reboot

(Optional) Causes the server to automatically restart after you enter the command.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Unified Communications Manager, and Cisco Unity Connection.

set network max_ip_conntrack

This command sets the ip_conntrack_max value.

set network max_ip_conntrack ip_conntrack_max value

Syntax Description

Parameters

Description

ip_conntrack_max value

Specifies the value for ip_conntrack_max.

Note:
The value of ip_conntrack_max cannot be less than 65536.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set network max_ip_conntrack 65536

set network mtu

This command sets the maximum MTU value.

set network mtu mtu_max

Syntax Description

Parameters

Description

mtu_max

Specifies the maximum MTU value. The system default MTU value equals 1500.

Caution:
When packets on UDP port 8500 that have the DF bit set are exchanged between nodes, if there is any policy on the WAN router to clear the DF bit and fragment large packets, this may cause dbreplication issues.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

If you continue, the system loses network connectivity temporarily.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set network mtu 576      W A R N I N G
This will cause the system to temporarily lose network connectivity
Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...

set network name-service hosts cache-enable

This command enables the nscd related cache.

set network name-service hosts cache-enable value

Syntax Description

Parameters

Description

value

The boolean value must be either yes or no.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service hosts max-db-size

This command sets the maximum allowed size for a service.

set network name-service hosts max-db-size value

Syntax Description

Parameters

Description

value

Enter the number of bytes for the database size.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service hosts negative-time-to-live

This command sets the time-to-live (TTL) for negative entries or unsuccessful queries in the specified cache for service. So, using this command improves the performance if there are various files owned by user IDs (UIDs) and are unavailable in system databases. For example, files that are available in the Linux kernel sources as root. To reduce the cache coherency problems, the number of such files should be kept to the minimum.

set network name-service hosts negative-time-to-live value

Syntax Description

Parameters

Description

value

Enter the number of seconds.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service hosts persistent

This command retains the content of the cache for service over server restarts. This command is useful when paranoia mode is configured.

set network name-service hosts persistent value

Syntax Description

Parameters

Description

value

Enter a value for a service.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service hosts positive-time-to-live

This command sets the time-to-live (TTL) for positive entries or successful queries in the specified cache for service. Configure the value in seconds. Larger values increase cache hit rates and reduce mean response times. However, such values increase problems with cache coherence.

set network name-service hosts positive-time-to-live value

Syntax Description

Parameters

Description

value

Enter the number of seconds.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service hosts suggested-size

This command changes the internal hash table size.

set network name-service hosts suggested-size value

Syntax Description

Parameters

Description

value

Enter a prime number for optimum efficiency.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service services cache-enable

This command enables the nscd related cache.

set network name-service services cache-enable value

Syntax Description

Parameters

Description

value

The boolean value must be either yes or no.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service services max-db-size

This command sets the maximum allowed size for the service.

set network name-service services max-db-size value

Syntax Description

Parameters

Description

value

Enter the value in number of bytes.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service services negative-time-to-live

This command sets the time-to-live (TTL) for negative entries or unsuccessful queries in the specified cache for service. So, using this command improves the performance if there are various files owned by user IDs (UIDs) and are unavailable in system databases. For example, files that are available in the Linux kernel sources as root. To reduce the cache coherency problems, the number of such files should be kept to the minimum.

set network name-service services negative-time-to-live value

Syntax Description

Parameters

Description

value

Enter a prime number for optimum efficiency.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service services persistent

This command retains the content of the cache for service over server restarts. This command is useful when paranoia mode is configured.

set network name-service services persistent value

Syntax Description

Parameters

Description

value

Enter a value for a service.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service services positive-time-to-live

This command sets the time-to-live (TTL) for positive entries or successful queries in the specified cache for service. If you enter a large value for this command, it increases cache hit rates and reduces mean response times. However, a large value increases issues with cache coherence.

set network name-service services positive-time-to-live value

Syntax Description

Parameters

Description

value

Enter the number of seconds.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network name-service services suggested-size

This command sets the internal hash table size.

set network name-service services suggested-size value

Syntax Description

Parameters

Description

value

Enter a prime number for optimum efficiency.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network nic eth0

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

set network nic eth0 { auto | { en | dis } } { speed | { 10 | 100 } } { duplex half | { half | full } }

Syntax Description

Parameters

Description

eth0

Specifies Ethernet interface 0.

auto

Specifies whether auto negotiation gets enabled or disabled.

speed

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

duplex

Specifies half-duplex or full-duplex.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Note

You can enable only one active NIC at a time.

Caution

If you continue, this command causes a temporary loss of network connections while the NIC gets reset.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set network ntp option

This command adds the noquery option to the /etc/config file.

set network ntp option

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set network pmtud state

This command enables and disables Path MTU Discovery.

set network pmtud state { enable | disable }

Syntax Description

Parameters

Description

enable

Enables Path MTU Discovery.

disable

Disables Path MTU Discovery.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

If you continue, the system loses network connectivity temporarily.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set network pmtud state enable      W A R N I N G
This will cause the system to temporarily lose network connectivity
Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...

set network restore

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

set network restore eth0 ip-address network-mask gateway

Syntax Description

Parameters

Description

eth0

Specifies Ethernet interface 0.

ip-address

Represents the IP address of the primary or secondary DNS server, or the network gateway that you want to assign. If you continue, this command causes a temporary loss of network connectivity. If you change the IP address for the primary DNS server, you must also restart the Cisco Tomcat service. For more information, see the utils service command. We also recommend that you restart all nodes whenever any IP address gets changed.

network-mask

Represents the subnet mask for the server.

gateway

Specifies the IP address of the default gateway.

ip-address

Represents the IP address of the primary or secondary DNS server, or the network gateway that you want to assign. If you continue, this command causes a temporary loss of network connectivity. If you change the IP address for the primary DNS server, you must also restart the Cisco Tomcat service. For more information, see the utils service command. We also recommend that you restart all nodes whenever any IP address gets changed.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

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

Caution

The server temporarily loses network connectivity after you run this command.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set network restore eth0   10.94.150.108   255.255.255.0   10.94.150.1

set network status eth0

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

set network status eth0 { up | down }

Syntax Description

Parameters

Description

eth0

Specifies Ethernet interface 0.

up

Sets the status of Ethernet interface 0 to up.

down

Sets the status of Ethernet interface 0 to down.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

If you continue, the system loses network connectivity temporarily.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set network name-service

This command displays name service cache attributes.

set network name-service [attribute] [value]

Syntax Description

Attribute

Value

Paranoia

Bool must be either Yes or No. Enabling paranoia mode causes Name Service to restart itself periodically.

debug-level

If level is higher than 0, Name Service will create some debug output. Higher the level, more verbose the output.

reload-count

Sets the number of times a cached record is reloaded before it is pruned from the cache. Each cache record has a timeout. When that timeout expires Name Service will either reload it (query the NSS service again if the data hasn't changed) or drop it.

restart-interval

Sets the restart interval to time seconds if periodic restart is enabled by enabling paranoia mode. The default value is 3600.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

set password complexity minimum-length

This command modifies the value of minimum password lengthe for the OS administration accounts.

Note

Use this command after you enable the character complexity of passwords.

set password complexity minimum-length max-repeat

Syntax Description

Parameters

Description

value

Enter a value of or greater than 6.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password age

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

set password age { maximum | minimum } days

Syntax Description

Parameters

Description

maximum

Specifies the maximum age.

minimum

Specifies the minimum age.

days

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password change-at-login

Use this command to force new or existing users to change their password when they sign in to the system the next time.

set password change-at-login { disable | enable } userid

Syntax Description

Parameters

Description

disable

This does not force users to change their password.

enable

This forces users to change their password when they sign in to the system the next time.

userid

Specifies the affected user account.

Command Modes

Administrator (admin:)

Usage Guidelines

By default, this command is enabled for new users, so users have to change their password the first time they sign in to the system.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: IM and Presence service on Cisco Unified Communications Manager only.

set password complexity character

Use this command to enable or disable password complexity rules for the type of characters in a password.

Note

After you enable password complexity, this command also enables password history if it has not already been enabled (for more information, see the set password history command). If you had not previously enabled password history, the password history number parameter value gets set to 10. If you previously enabled password history with a value of less than 10, the value gets reset to 10 after you execute this command. If you previously enabled password history with a value of 10 or greater, the value remains unchanged after you execute this command.

set password complexity character { disable | enable } num-char

Syntax Description

Parameters

Description

disable

This turns off password complexity for character types.

enable

This turns on password complexity for character types.

Note:
When you disable password complexity, you also turn off password character difference, password character max-repeat, and password history.

num-char

This specifies the number of characters required from each of the four character sets: lowercase, uppercase, numbers, and special characters.

- Value range: 0-8

- Default value: 1

Command Modes

Administrator (admin:)

Usage Guidelines

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

- It must have at least the current setting, num-chars, of lower-case character.

- It must have at least the current setting, num-chars, of uppercase characters.

- It must have at least the current setting, num-chars, of digit characters.

- It must have at least the current setting, num-chars, of special characters.

- You cannot use adjacent characters on the keyboard; for example, qwerty.

- You cannot reuse any of the previous passwords that match the passwords retained by password history.

- By default, the admin user password can be changed only once in a 24-hour day.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password complexity character difference

This command specifies the number of characters that the character sequence in a new password must differ from the character sequence in the old password.

set password complexity character difference num-char

Syntax Description

Parameters

Description

num-char

This specifies the number of characters that the character sequence in a new password must differ from the character sequence in the old password.

- Value range: 0-31

Command Modes

Administrator (admin:)

Usage Guidelines

Enter 0 to indicate no difference.

Note

The maximum password length is 31 characters.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password complexity character max-repeat

This command specifies the number of times you can consecutively repeat a single character in a new password.

set password complexity character max-repeat max-repeat

Syntax Description

Parameters

Description

max-repeat

This specifies the number of times you can consecutively repeat a single character in a new password.

- Value range: 0 – 10

Default value: 0

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password complexity minimum-length

This command modifies the value of minimum password lengthe for the OS administration accounts.

Note

Use this command after you enable the character complexity of passwords.

set password complexity minimum-length max-repeat

Syntax Description

Parameters

Description

value

Enter a value of or greater than 6.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password expiry maximum-age

This command enables or disables the password expiry maximum age settings for Cisco Unified Operating System Administrator accounts.

set password expiry maximum-age { enable | disable }

Syntax Description

Parameters

Description

enable

Turns on password expiry maximum age settings for Cisco Unified Operating System administrator accounts. The set password expiry enable command sets the value of maximum password age to 3650 days (10 yrs) for Cisco Unified Operating System Administrator accounts.

disable

Turns off password expiry maximum age settings for Cisco Unified Operating System administrator accounts. The set password expiry disable command results in Cisco Unified Operating System Administrator accounts never expiring.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set password expiry maximum-age disable
Operation Successful.

set password expiry user maximum-age configure

This command modifies the value of the maximum password age for a particular Cisco Collaboration Communication OS Administration account in days.

set password expiry user maximum-age configure userid maximum password age

Syntax Description

Parameters

Description

userid

Enter Cisco Collaboration Communication OS (C3OS) Administrator account.

maximum password age

Enter the maximum password age in days. This value must be equal to or greater than 10 days but less than 3650 days (10 years).

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password expiry minimum-age

This command enables or disables the password expiry minimum age settings for Cisco Unified Operating System Administrator accounts.

set password expiry minimum-age { enable | disable }

Syntax Description

Parameters

Description

enable

Turns on password expiry minimum age settings for Cisco Unified Operating System administrator accounts. The set password expiry enable command sets the value of minimum password age to one day (24 hrs) for Cisco Unified Operating System Administrator accounts.

disable

Turns off password expiry minimum age settings for Cisco Unified Operating System administrator accounts. This means that passwords for administrator accounts can be changed at any interval.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set password expiry minimum-age disable
Operation Successful.

set password expiry user maximum-age

This command disables the maximum age password expiry for a particular Cisco Unified Operating System Administrator account.

set password expiry user maximum-age { enable | disable } userid

Syntax Description

Parameters

Description

enable

Turns on the maximum age password expiry settings for a particular Cisco Unified Operating System administrator account. The set password expiry user enable command sets the value of maximum password age to 3650 days (10 yrs) for the Cisco Unified Operating System Administrator account.

disable

Turns off the maximum age password expiry settings for a particular Cisco Unified Operating System administrator account. The set password expiry user disable command results in that Cisco Unified Operating System Administrator account never expiring.

userid

Specifies a particular Cisco Unified Operating System Administrator account.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set password expiry user maximum-age enable
Operation Successful.

set password expiry user minimum-age

This command enables or disables the maximum age password expiry for a particular Cisco Unified Operating System Administrator account.

set password expiry user minimum-age { enable | disable } userid

Syntax Description

Parameters

Description

enable

Turns on the minimum age password expiry settings for a particular Cisco Unified Operating System administrator account.

disable

Turns off the minimum age password expiry settings for a particular Cisco Unified Operating System administrator account.

userid

Specifies a particular Cisco Unified Operating System Administrator account.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:set password expiry user minimum-age disable
Operation Successful.

set password history

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

set password history number

Syntax Description

Parameters

Description

number

Specifies the mandatory number of passwords to maintain in history.

Command Modes

Administrator (admin:)

Usage Guidelines

- To disable, enter 0.

- Default specifies 10.

- Upper limit specifies 20.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password inactivity

set password inactivity { enable | disable | period } days

Syntax Description

Parameters

Description

enable

Enable the password inactivity globally and update individual OS users according to the setting.

disable

Disable the password inactivity globally and update individual OS users according to the setting.

period

Configure the password inactivity period globally and update individual OS users according to the setting.

days

Specify the number of days of inactivity after a password has expired before the account gets disabled. Valid range is 1 - 99.

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

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

- To configure the password inactivity period execute the set password inactivity period days command. This command configures the password inactivity globally and updates individual OS users according to the setting.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password system bootloader encryptHash

Use this command to configure the encrypted password in the grub.conf file for the system boot loader.

set password system bootloader encryptHash

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password user admin

This command allows you to change the administrator password.

set password user admin

Command Modes

Administrator (admin:)

Usage Guidelines

The systems prompts you for the old and new passwords.

Note

- You can change the password only for the administrator account that you logged in to.

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set password user security

This command allows you to change the security password.

set password user security

Command Modes

Administrator (admin:)

Usage Guidelines

The systems prompts you for the old and new passwords.

Note

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

Note

Before running the set user password security command on the IM and Presence Service servers (nodes), you must first go to the Cisco Unified CM IM and Presence Administration > System > CUCM Publisher window for each IM and Presence Service server (node), and enter the new security password.

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

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

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

Note

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

Note

Failure to reboot the servers (nodes) causes system service problems and problems with the Cisco Unified Communications Manager Administration windows on the subscriber servers.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

Set replication-sync monitor

This command enables or disables replication monitoring by the Cisco Replication Watcher service. The Cisco Replication Watcher service blocks other services from starting until database replication is setup and functioning normally.

set replication-sync monitor {enable | disable}

Syntax Description

Parameters

Description

enable

Turns on the replication monitoring service.

disable

Turns off the replication monitoring service

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: IM and Presence service on Unified Communications Manager only

set samltrace level

This command sets the SAML trace level.

set samltrace level trace level

Syntax Description

Parameters

Description

trace level

Specifies the trace level. The available options are:

- DEBUG

- INFO

- WARNING

- ERROR

- FATAL

Note:
The default trace level is INFO.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection.

set session maxlimit

This command sets the upper limit for concurrent sessions.

set session maxlimit [value]

Syntax Description

Parameters

Description

maxlimit

This command sets the upper limit for concurrent sessions. Acceptable values are 1 - 100.

If no upper limit is entered, the default value of 10 is assigned to sshd_config param.

value

Acceptable values are 1 - 100.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set smtp

This command sets the SMTP server hostname.

set smtp hostname

Syntax Description

Parameters

Description

hostname

Represents the SMTP server name.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set timezone

This command lets you change the system timezone.

set timezone zone

Syntax Description

Parameters

Description

zone

Specifies the new timezone. Enter the appropriate string or zone index id to uniquely identify the timezone. To view a list of valid timezones, use the CLI command: show timezone list.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

You must restart the system after you change the timezone.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example Setting Timezone to Pacific Time

admin:set timezone Pac

set trace disable

This command unsets trace activity for the specified task.

set trace disable tname

Syntax Description

Parameters

Description

disable

Unsets the task trace settings.

tname

Represents the task for which you want to disable traces.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set trace enable

This command sets trace activity for the specified task.

set trace enable { Arbitrary | Detailed | Entry_exit | Error | Significant | Special | State_Transition } tname

Syntax Description

Parameters

Description

Arbitrary

Sets task trace settings to the arbitrary level.

Detailed

Sets task trace settings to the detailed level.

Entry_exit

Sets task trace settings to the entry_exit level.

Error

Sets task trace settings to the error level.

Significant

Sets task trace settings to the significant level.

Special

Sets task trace settings to the special level.

State_transition

Sets task trace settings to the state transition level.

tname

Represents the task for which you want to disable traces.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set tlsresumptiontimeout

This command sets the number of seconds after which TLS resumption will not work and sessions are invalidated.

set tlsresumptiontimeout seconds

Syntax Description

Parameters

Description

seconds

Enter a value up to 3600 seconds. The TLS sessions are invalid after the configured value.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set tlstrace*

Cisco Unified Communications Manager Release 11.0 onwards, you can enable or disable TLS tracing for services. Currently, Tomcat is the only supported service. Use the CLI commands to view the reasons of connection failure of TLS connections to Cisco Unified Communications Manager.

Following TLS-based CLI commands are added for TLS tracing:

- set tlstrace disable

- set tlstrace enable

set tlstrace disable

This CLI command disables the TLS tracing for a service.

set tlstrace disable service

Syntax Description

Parameters

Description

service

Specifies the service that you use to disable TLS tracing.

Command Modes

Administrator (admin:)

Example

admin:set tlstrace disable tomcat
TLS tracing is disabled for: tomcat

Requirements

Command privilege level: 1

Allowed during upgrade: No

set tlstrace enable

This CLI command enables the TLS tracing for a service.

set tlstrace enable service

Syntax Description

Parameters

Description

service

Specifies the service that you use to enable TLS tracing.

Command Modes

Administrator (admin:)

Example

admin:set tlstrace enable tomcat
TLS tracing is enabled for: tomcat

Requirements

Command privilege level: 1

Allowed during upgrade: No

set web-security

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

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

Syntax Description

Parameters

Description

orgunit

Represents the organizational unit (OU) name.

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

orgname

Represents the organizational name.

locality

Represents the organization location.

state

Represents the organization state.

country

(Optional) Represents the organization country.

alternatehostname

(Optional) Specifies an alternate name for the host when you generate a web-server (Tomcat) certificate.

You can use alternatehostname to set subject alternate hostname for self signed certificates. Subject alternate hostname for CSR is defined in the Certificate Management page. If you have set the alternate hostname for CSR using this command, the CSR generation process replaces the set alternate hostname.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

This example shows the web-security command with multiple organizational unit names using comma separators. The certificate has three OU fields:

- OU=accounting

- OU=personnel, CA

- OU=personnel, MA

admin:set web-security “accounting,personnel\,CA,personnel\,MA” Cisco Milpitas
CA

set webapp session timeout

This command sets the time, in minutes, that can elapse before a web application, such as Cisco Unified Communications Manager Administration, times out and logs off the user.

For the new webapp session timeout setting to become effective, you must restart the Cisco Tomcat service. Until you restart the Cisco Tomcat service, the show webapp session timeout command reflects the new values, but system continues to use and reflect the old values. This command prompts you to restart the service.

Caution

Restarting the Cisco Tomcat service ends all active sessions and can affect system performance. Cisco recommends that you only execute this command during off-peak traffic hours.

Note

This setting gets preserved through a software upgrade and does not get reset to the default value.

set webapp session timeout minutes

Syntax Description

Parameters

Description

minutes

Specifies the time, in minutes, that can elapse before a web application times out and logs off the user.

- Value range: 5-99999 minutes

- Default value: 30 minutes

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

set workingdir

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

set workingdir { activelog | inactivelog | tftp } directory

Syntax Description

Parameters

Description

activelog

Sets the working directory for active logs. Choose a valid sub-directory of activelog.

inactivelog

Set the working directory for inactive logs. Choose a valid sub-directory of inactivelog.

tftp

Sets the working directory for TFTP files.

directory

Represents the current working directory.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Chapter 7. Show Commands

- show account

- show accountlocking

- show ctl

- show date

- show diskusage

- show fileserver transferspeed

- show hardware

- show itl

- show Login Grace Timeout

- show media streams

- show memory

- show myself

- show packages

- show registry

- show samltrace level

- show session maxlimit

- show smtp

- show stats io

- show status

- show tlstrace

- show tlsresumptiontimeout

- show trace

- show ups status

- show web-security

- show webapp session timeout

- show workingdir

- show logins unsuccessful

show account

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

show account

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

show accountlocking

This command displays the current account locking settings.

show accountlocking

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:show accountlocking
Account Lockout is enabled
Unlock Time : 300 seconds
Retry Count : 3 attempts

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show cert list

This command displays certificate trust lists.

show cert list { own | trust }

Syntax Description

Parameters

Description

own

Specifies owned certificates.

trust

Specifies trusted certificates.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:cert list own

show cert list type

This command displays the available selected type certificate files.

show cert list type { own | trust }

Syntax Description

Parameters

Description

own

Specifies owned certificates.

trust

Specifies trusted certificates.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

show cert own

This command displays certificate contents.

show cert own filename

Syntax Description

Parameters

Description

own

Specifies owned certificates.

filename

Represents the name of the certificate file.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

show cert trust

This command displays certificate contents.

show cert trust filename

Syntax Description

Parameters

Description

trust

Specifies trusted certificates.

filename

Represents the name of the certificate file.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

show cli pagination

This command displays the status of automatic CLI automatic pagination.

show cli pagination

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Example

admin:show cli pagination
Automatic Pagination : Off.

show cli session timeout

This command displays the CLI session timeout value, which is the amount of time, in minutes, that can elapse before a CLI session times out and disconnects.

show cli session timeout

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

show csr list

This command displays Certificate Sign Request contents and certificate trust lists.

show csr list { own | | trust }

Syntax Description

Parameters

Description

own

Shows a list of owned Certificate Sign Requests.

trust

Shows a list of trusted Certificate Sign Requests.

Command Modes

Administrator (admin:)

Usage Guidelines

The certificate name can be obtained by using the show cert list own command.

Requirements

Command privilege level: 1

Allowed during upgrade:

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin: show csr list own

tomcat/tomcat.csr

Vipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr

.....

.....

.....

show csr list type

This command displays the selected own Certificate Sign Request files.

show csr list type own

Syntax Description

Parameters

Description

own

Shows a list of owned Certificate Sign Requests.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show csr own

This command displays Certificate Sign Request (CSR) contents and certificate trust lists.

show csr own name

Syntax Description

Parameters

Description

name

The name of the CSR file.

Command Modes

Administrator (admin:)

Usage Guidelines

The certificate name can be obtained by using the show cert list own command.

Requirements

Command privilege level: 1

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin:show csr own tomcat/tomcat.csr

[

[

-----BEGIN CERTIFICATE SIGN REQUEST-----

MIIDrDCCAxUCBENeUewwDQYJKoZIhvcNAQEEBQAwggEbMTQwMgYDVQQGEytVbmFibGUgdG8gZmlu

ZCBDb3VudHJ5IGluIHBsYXRmb3JtIGRhdGFiYXNlMTIwMAYDVQQIEylVbmFibGUgdG8gZmluZCBT

dGF0ZSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTE1MDMGA1UEBxMsVW5hYmxlIHRvIGZpbmQgTG9jYXRp

b24gaW4gcGxhdGZvcm0gZGF0YWJhc2UxMDAuBgNVBAoTJ1VuYWJsZSB0byBmaW5kIE9yZyBpbiBw

bGF0Zm9ybSBkYXRhYmFzZTExMC8GA1UECxMoVW5hYmxlIHRvIGZpbmQgVW5pdCBpbiBwbGF0Zm9y

bSBkYXRhYmFzZTETMBEGA1UEAxMKYmxkci1jY20zNjAeFw0wNTEwMjUxNTQwMjhaFw0xMDEwMjQx

NTQwMjhaMIIBGzE0MDIGA1UEBhMrVW5hYmxlIHRvIGZpbmQgQ291bnRyeSBpbiBwbGF0Zm9ybSBk

YXRhYmFzZTEyMDAGA1UECBMpVW5hYmxlIHRvIGZpbmQgU3RhdGUgaW4gcGxhdGZvcm0gZGF0YWJh

c2UxNTAzBgNVBAcTLFVuYWJsZSB0byBmaW5kIExvY2F0aW9uIGluIHBsYXRmb3JtIGRhdGFiYXNl

MTAwLgYDVQQKEydVbmFibGUgdG8gZmluZCBPcmcgaW4gcGxhdGZvcm0gZGF0YWJhc2UxMTAvBgNV

BAsTKFVuYWJsZSB0byBmaW5kIFVuaXQgaW4gcGxhdGZvcm0gZGF0YWJhc2UxEzARBgNVBAMTCmJs

ZHItY2NtMzYwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMoZ4eLmk1Q3uEFwmb4iU5nrMbhm

J7bexSnC3PuDGncxT3Au4zpGgMaQRL+mk+dAt8gDZfFKz8uUkUoibcUhvqk4h3FoTEM+6qgFWVMk

gSNUU+1i9MST4m1aq5hCP87GljtPbnCXEsFXaKH+gxBq5eBvmmzmO1D/otXrsfsnmSt1AgMBAAEw

DQYJKoZIhvcNAQEEBQADgYEAKwhDyOoUDiZvlAOJVTNF3VuUqv4nSJlGafB6WFldnh+3yqBWwfGn

show csr own name

This command displays Certificate Sign Request (CSR) own certificate files.

show csr own name name of certificate sign request

Syntax Description

Parameters

Description

name

The name of the CSR file.

name of certificate sign request

The name of the certificate sign request.

Command Modes

Administrator (admin:)

Usage Guidelines

The certificate name can be obtained by using the show cert list own command.

Requirements

Command privilege level: 1

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show ctl

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

show ctl

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show cuc cluster status

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

show cuc cluster status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

show cuc config groups

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

show cuc config groups [page]

Syntax Description

Parameters

Description

page

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

Command Modes

Administrator (admin:)

Usage Guidelines

To see a list of the settings for a specified group, run the command show cuc config settings.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: show cuc config groups

CiscoLicensing
ConfigurationAssistant
Conversations
Directory
Groupware
LogMgr
Messaging
:
:
Telephony

show cuc config settings

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

show cuc config settings group_name page

Syntax Description

Parameters

Description

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. Be aware that group names are case sensitive.

pagepage

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Configuration Settings for the Group SA

admin: show cuc config settings SA

SA Setting                          Value

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

SessionTimeout          20
Use24HrClockFormat   0

show cuc dbconsistency

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

show cuc dbconsistency [database_name]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

After 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 can not cancel it. Do not restart the server during the operation; the operation must complete successfully before Connection will function properly.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example of a Consistency Check of the unityrptdb Database

admin: 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

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

show cuc dbcontents [database_name]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

After 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

Applies to: Cisco Unity Connection

Example of Exporting the Data From the unitydirdb Database to a CSV File and Displays the Location of the File

admin: 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

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

show cuc dbschema [database_name]

Syntax Description

Parameters

Description

database_name

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example of Exporting the Schema of the unitydirdb Database to a File and Displays the Location of the File

admin: show cuc dbschema unitydirdb

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

show cuc dbserver disk

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

show cuc dbserver disk [page] [file]

Syntax Description

Parameters

Description

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

show cuc dbserver session

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

show cuc dbserver session session_id [page] [file]

Syntax Description

Parameters

Description

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 command or the show cuc dbserver user list command.

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

show cuc dbserver sessions all

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

show cuc dbserver sessions all [page] [file]

Syntax Description

Parameters

Description

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

show cuc dbserver sessions list

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

show cuc dbserver sessions list [page]

Syntax Description

Parameters

Description

[page]

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

Command Modes

Administrator (admin:)

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 command to obtain the required session id.
Results are sorted by session id.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

show cuc dbserver user list

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

show cuc dbserver user list [page]

Syntax Description

Parameters

Description

[page]

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

Command Modes

Administrator (admin:)

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

Applies to: Cisco Unity Connection

show cuc dbserver user waiting

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

show cuc dbserver user waiting [page]

Syntax Description

Parameters

Description

[page]

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

show cuc dbtable contents

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

show cuc dbtable contents { database_name | table_name }

Syntax Description

Parameters

Description

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.
Note:
For a list of the tables in a specified database, use the show cuc dbtable list command. Be aware that table names are case sensitive.

Command Modes

Administrator (admin:)

Usage Guidelines

After 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

Applies to: Cisco Unity Connection

Example

admin: show cuc dbtable contents unitydirdb tbl_cos

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

show cuc dbtable list

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

show cuc dbtable list database_name [page]

Syntax Description

Parameters

Description

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.

[page]

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: 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

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

show cuc dbtable schema { database_name | table_name } [page]

Syntax Description

Parameters

Description

database_name

Specifies the database that contains the table show 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.
Note:
For a list of the tables in a specified database, use the show cuc dbtable list command. Be aware that table names are case sensitive.

[page]

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example of Displaying the Schema for the Table tbl_user in the unitydirdb Database

admin: 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

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

show cuc dbview contents { database_name | view_name }

Syntax Description

Parameters

Description

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.
Note:
For a list of the views in a specified database, use the show cuc dbview list command. Be aware that view names are case sensitive.

Command Modes

Administrator (admin:)

Usage Guidelines

After 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

Applies to: Cisco Unity Connection

Example

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

admin: show cuc dbview contents unitydirdb vw_cos_061013-113910.csv

show cuc dbview list

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

show cuc dbview list database_name [page]

Syntax Description

Parameters

Description

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.

[page]

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Example

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

admin: 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

This command displays the schema for a specified view.

show cuc dbview schema { database_name | view_name } [page]

Syntax Description

Parameters

Description

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.
Note:   For a list of the views in a specified database, use the show cuc dbview list command. Be aware that view names are case sensitive.

[page]

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

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

admin: show cuc dbview schema unitydirdb vw_cos

A simple view for tbl_Cos.

Columns:
objectid
accessfaxmail
accesstts
callholdavailable
callscreenavailable
canrecordname
...
requiresecuremessages

show cuc jetty ssl status

This command allows you to check the status of SSL (Enabled/Disabled) on the Jetty server for notifications.

show cuc jetty ssl status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: show cuc jetty ssl status

Command completed successfully.
SSL notification is DISABLED

show cuc locales

This command displays a list of the locales currently installed.

show cuc locales

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: 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

This command displays a list of the Sysagent tasks.

show cuc sysagent task list [page]

Syntax Description

Parameters

Description

[page]

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

Command Modes

Administrator (admin:)

Usage Guidelines

To run a sysagent task, use the run cuc sysagent task 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 run on this server.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: show cuc sysagent task list

Task Name                                                                                                                Is Singleton

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

Data.BroadcastMessagePurge                                                                N

Umss.CleanDeletedMessagesTask                                                    Y

Umss.CleanDirectoryStreamFilesTask                                Y

Umss.CleanOrphanAttachmentFilesTask                            Y

...

Data.UpdateDatabaseStats                                                                        N

show cuc sysagent task results

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

show cuc sysagent task results task_name [page]

Syntax Description

Parameters

Description

task_name

Specifies the task for which you want to display information when the task starts and completes.
Note:
For a list of task names, run the show cuc sysagent task list command. Be aware that task names are case sensitive.

[page]

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

Command Modes

Administrator (admin:)

Usage Guidelines

To run a Sysagent task, use the run cuc sysagent task command.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

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

admin: show cuc sysagent task results Umss.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

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.

show cuc sysinfo

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unity Connection

Example

admin: show cuc sysinfo

Gather Data/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

This command displays the schema version information for each database.

show cuc tech dbschemaversion [page]

Syntax Description

Parameters

Description

[page]

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: 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

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

show cuc tech dbserver all

Command Modes

Administrator (admin:)

Usage Guidelines

After 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

admin: show cuc tech dbserver all

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

show cuc tech dbserver integrity

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

show cuc tech dbserver integrity

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: 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

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

show cuc tech dbserver log diagnostic

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

admin: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

This command displays the end of the Informix message log.

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

Syntax Description

Parameters

Description

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.

page

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

admin: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

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

show cuc tech dbserver status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

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

show cuc trace levels

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

show cuc trace levels [ page ]

Syntax Description

Parameters

Description

page

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

Command Modes

Administrator (admin:)

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: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

admin: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 -

Related References

set cuc trace

show cuc version

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

show cuc version

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

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

show date

This command displays the date and time on the server.

show date

Command Modes

Administrator (admin:)

Example

admin: show date
Sat Jul 17 01:28:57 IST 2010

show diskusage

This command displays disk usage information about specific directories.

show diskusage activelog { activelog | common | inactivelog | install | tftp | tmp } filename filename { directory | sort }

Syntax Description

Parameters

Description

filename filename

Saves the output to a specified file. These files are stored in the platform/cli directory. To view saved files, use the file view activelog command.

directory

Displays the directory sizes only.

sort

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show dscp all

This command displays the current DSCP traffic markings on all the ports. It displays the DSCP markings in decimal and hexidecimal. If the value corresponds to a class then it displays the correct class. If the value does not correspond to a class, then it displays N/A.

show dscp all

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

show dscp defaults

This command displays the default factory DSCP settings. These values take effect if the set dscp defaults command is executed.

show dscp defaults

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

show dscp marking

This command displays the current DSCP traffic markings for a particular DSCP value.

show dscp marking value

Syntax Description

Parameters

Description

value

DSCP value. You can enter the name of a well-known DSCP class, or a numeric value in decimal or hexadecimal format. Precede hexadecimal values with 0x or 0X.

Command Modes

Administrator (admin:)

Usage Guidelines

The valid class names as defined by DSCP are:

- Class Selector: values CSO, CS1, CS2, CS3, CS5, CS6 CS7

The class selector (CS) values correspond to IP Precedence values and are fully compatible with IP Precedence.

- Expedited Forwarding: value EF

EF PHB is ideally suited for applications such as VoIP that require low bandwidth, guaranteed bandwidth, low delay, and low jitter.

- Best Effort: value BE

Also called default PHB, this value essentially specifies that a packet be marked with 0x00, which gets the traditional best-effort service from the network router.

- Assured Forwarding: values AF11, AF12, AF13, AF21, AF22, AF23, AF41, AF42, AF43

There are four types of Assured Forwarding classes, each of which has three drop precedence values. These precedence values define the order in which a packet is dropped (if needed) due to network congestion. For example, packets in AF13 class are dropped before packets in the AF12 class.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show dscp status

This command displays the current DSCP traffic markings.

show dscp status { enabled | disabled }

Syntax Description

Parameters

Description

enabled

Filters the output to show only DSCP traffic markings that are enabled. If you do not specify a status, this filter is the default option.

disabled

Filters the output to show only DSCP traffic markings that are disabled.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show environment fans

This command shows the status of the fan sensors.

show environment fans

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show environment power-supply

This command shows the status of the power supply for MCS-7845, MCS-7835, MCS-7825H3/H4, and MCS-7816H3 servers—those with redundant power supply or embedded health hardware.

show tlstrace

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show environment temperatures

This command retrieves the status of the temperature sensors.

show environment temperatures

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show fileserver transferspeed

This command shows the reading and writing speed between the IM and Presence Service node and the external file server. It involves copying a large file onto the mounted directory and then copying it back onto the node. As a result, this command may have a performance impact on the node from which it is run.

show fileserver transferspeed

Command Modes

Administrator (admin:)

Requirements

Applies to: IM and Presence Service on Cisco Unified Communications Manager.

Example

admin:show fileserver transferspeed

WARNING: This command involves copying a large file to and from the mounted directory. It can impact the performance of the system.

Do you want to continue? (y/n):y

Creating a file to perform the test, please wait...

Copying the file onto the mounted file system. Please note the writing speed recorded below.
262144+0 records in
262144+0 records out
1073741824 bytes (1.1 GB) copied, 28.9302 s, 37.1 MB/s

Copying the file from the mounted file system. Please note the reading speed recorded below.
262144+0 records in
262144+0 records out
1073741824 bytes (1.1 GB) copied, 67.7504 s, 15.8 MB/s

Clean-up finised
admin:

show hardware

This command displays hardware-related information about the platform.

show hardware

Command Modes

Administrator (admin:)

Usage Guidelines

The following information is displayed:

- Platform

- Serial number

- BIOS build level

- BIOS manufacturer

- Active processors

- RAID controller status

- Disk partition details

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show ipsec information

This command displays detailed information about the specified ipsec policy.

show ipsec information { policy_group | policy_name }

Syntax Description

Parameters

Description

policy_group

policy_name

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: yes

Applies to: IM and Presence service on Cisco Unified Communications Manager

Example

admin:show ipsec information test test1
PolicyGroup             : test
PolicyName              : test1
Type                    : transport
Source Address          : 10.94.171.3
Source Type             : ip
Destination Address     : 10.94.1.2
Destination Type        : ip
Protocol                : tcp
Source Port             : Any
Destination Port        : Any
Remote Port             : Any
Authentication Method   : psk
Destination Certificate : null
PSK                     : cisco
Phase 1 Life Time       : 3600
Encryption Algorithm    : des
Hash Algorithm          : sha1
Phase 1 DH Value        : null
Phase 2 Life Time       : 3600
ESP                     : null_enc
AH                      : hmac_sha1
Phase 2 DH Value        : null
Peer Type               : null
Status                  : disabled
Source Certificate      : null

show ipsec policy_group

This command displays all the ipsec policy group on the node.

show ipsec policy_group

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

show ipsec policy_name

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

show ipsec policy_name policy_group

Syntax Description

Parameters

Description

policy_group

Specifies the policy group name.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

show ipsec status

show ipsec status

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level:

Allowed during upgrade:

Applies to: IM and Presence service on Cisco Unified Communications Manager

show itl

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

show itl

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show logins

This command lists recent logins to the server

show login [number]

Syntax Description

Parameters

Description

number

Specifies the number of the most recent logins to display. The default is 20.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

- show logins successful

- show logins unsuccessful

show logins successful

This command shows the previous successful logins.

show logins successful [ last n ]

Syntax Description

Parameters

Description

last n

(Optional) Represents the last number of logins. By default, the value of this variable is 20.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show logins unsuccessful

Use this command to list recent unsuccessful login attempts to the following web applications:

- On Cisco Unified Communications Manager

- Disaster Recovery System

- Cisco Unified OS Administration

- On IM and Presence Service

- IM and Presence Disaster Recovery System

- Cisco Unified IM and Presence OS Administration

show logins unsuccessful [number]

Syntax Description

Parameters

Description

number

Specifies the number of most recent logins to display. The default is 20.

Command Modes

Administrator (admin)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to Cisco Unified Communications Manager and IM and Presence Service

show Login Grace Timeout

This command shows the login Grace Timeout.

show Login Grace Timeout

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show media streams

This command captures information on current media stream connections.

show media streams [options]

Syntax Description

Parameters

Description

options

Enter one of the following options:

- file fname: Limit (valid characters alphanumeric [a-Z, A-Z, 0-9, (-) ad , (_)]. 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.

- trace: Activates extra trace from media driver to system log.
Note:
Ignore any kernel messages that display on the console screen when show media streams trace is entered.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

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, PayId=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:42
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.

show memory { count | modules | size }

Syntax Description

Parameters

Description

count

Displays the number of memory modules on the system.

modules

Displays detailed information about all the memory modules.

size

Displays the total amount of physical memory.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show myself

This command displays information about the current account.

show myself

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show network all

This command shows network information for listening and nonlistening sockets.

show network all [detail] [page] [ search srchtext ]

Syntax Description

Parameters

Description

detail

Shows additional information.

page

Displays information one page at a time.

search srchtext

Searches for srchtext in the output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network cluster

This command lists nodes in the network cluster and also shows the remaining timer value when you enable Dynamic Cluster Configuration.

show network cluster

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network dhcp eth0

This command shows DHCP status information.

show network dhcp eth0

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network eth0

This command shows network information for ethernet 0.

show network eth0 [detail] [ search srchtxt ]

Syntax Description

Parameters

Description

detail

Shows additional information.

search srchtxt

Searches for srchtxt in the output.

Command Modes

Administrator (admin:)

Usage Guidelines

The eth0 parameter displays Ethernet port 0 settings

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network failover

This command shows Network Fault Tolerance information.

show network failover [detail] [page]

Syntax Description

Parameters

Description

detail

Shows additional information.

page

Shows information one page at a time.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network ip_conntrack

This command shows ip_conntrack usage information.

show network ip_conntrack

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network ipprefs

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

show network ipprefs { all | enabled | public }

Syntax Description

Parameters

Description

all

Shows all incoming ports that may be used on the product.

enabled

Shows all incoming ports that are currently opened.

public

Shows all incoming ports that are currently opened for a remote client.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin:show network ipprefs public
Application IPProtocol PortValue HashLimit (max:rate) H-Status ConnLimit C-Status Type XlatedPort Status  Description
----------- ---------  --------- -------------------- -------- --------- -------- ---- ---------- ------  ------------
sshd            tcp        22        1500:25/second    enabled     -     disabled public   -      enabled sftp and ssh
tomcat          tcp        443       4000:50/second    disabled   300     enabled public  8443    enabled  secure web
tomcat          tcp        80        4000:50/second    disabled   300     enabled public  8080

show network ipv6

This command shows IPv6 network routes and network settings.

show network ipv6 { route | settings }

Syntax Description

Parameters

Description

route

Shows all IPv6 routes.

settings

Shows all IPv6 network settings.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, Cisco Unity Connection

show network max_ip_conntrack

This command shows max_ip_conntrack information.

show network max_ip_conntrack

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network ntp option

This command displays the security option that is configured in the /etc/config file.

show network ntp option

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network route

This command shows network routing information.

show network route [detail] [ search srchtext ]

Syntax Description

Parameters

Description

detail

Shows additional information.

search srchtext

Searches for the srchtext in the output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show network status

This command shows active internet connections.

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

Syntax Description

Parameters

Description

detail

Shows additional information.

listen

Shows only listening sockets.

process

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

all

Shows both listening and nonlistening sockets.

nodns

Shows numerical addresses without any DNS information.

search stext

Searches for the stext in the output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

This example displays active internet connections.

admin: show network status

show network name-service attributes

This command displays name service cache general attributes.

show network name - service attributes

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Example:

admin:show network name-service hosts attributes
enable-cache                 yes
positive-time-to-live        3600
negative-time-to-live        20

Successful

show network name-service cache-stats

This command displays name service cache statistics.

show network name-services [host] [services] cache-stats

Syntax Description

Parameters

Description

hosts

host services cache.

services

services service cache.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Example:

admin:show network name-service hosts cache-stats
yes  cache is enabled
no  cache is persistent
yes  cache is shared
211  suggested size
216064  total data pool size
272  used data pool size
3600  seconds time to live for positive entries
20  seconds time to live for negative entries
0  cache hits on positive entries
0  cache hits on negative entries
2  cache misses on positive entries
0  cache misses on negative entries
0% cache hit rate
2  current number of cached values
2  maximum number of cached values
0  maximum chain length searched
0  number of delays on rdlock
0  number of delays on wrlock
0  memory allocations failed
yes  check /etc/hosts for changes

Successful

show network name-service {hosts|services} attributes

This command displays name service cache attributes.

show networkname - service{hosts|services} attributes

Syntax Description

Parameters

Description

hosts

hosts services cache.

services

services service cache.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Example:

admin:show network name-service hosts attributes
enable-cache                 yes
positive-time-to-live        3600
negative-time-to-live        20
suggested-size               211
persistent                   no
max-db-size                  33554432

Successful

show open files all

This command shows all open files on the system.

show open files all

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show open files process

The command shows open files that belong to a specified process.

show open files process processID

Syntax Description

Parameters

Description

processID

Specifies a process.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show open files regexp

This command shows open files that match the specified regular expression.

show open files regexp reg_exp

Syntax Description

Parameters

Description

reg_exp

Specifies a regular expression.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show open ports all

This command shows all open ports on the system.

show open ports all

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show open ports process

This command displays open ports the belong to a specified process.

show open ports process processID

Syntax Description

Parameters

Description

processID

Specifies a process.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show open ports regexp

This command shows open ports that match the specified regular expression.

show open ports regexp reg_exp

Syntax Description

Parameters

Description

reg_exp

Specifies a regular expression.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show packages

This command displays the name and version for installed packages.

show packages { active | inactive } name [page]

Syntax Description

Parameters

Description

active

Specifies active packages.

inactive

Specifies inactive packages.

name

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

page

Shows the output one page at a time

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show password

This command shows information about the configured password.

show password { age | history | inactivity }

Syntax Description

Parameters

Description

age

Shows information about the configured password age parameters

history

Shows the number of passwords that the history maintains for OS administration accounts.

inactivity

Shows the status of the password inactivity for OS accounts. Password inactivity is the number of days of inactivity after a password has expired before the account is disabled.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

- show password change-at-login

show password change-at-login

This command shows whether a user is forced to change passwords after the user signs in to the system the next time.

show password change-at-login userid

Syntax Description

Parameters

Description

userid

Specifies the user account that you want to show.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show password complexity character

This command displays the status of the password complexity rules—whether they are disabled or enabled. If the password complexity rules are enabled, this command displays the shows their current configuration.

show password complexity character

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show password complexity length

This command displays the minimum length of passwords that need to be used for Cisco OS administrator accounts. The default minimum length of a password is six characters.

show password complexity length

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show password expiry

This command shows the configured password expiration parameters.

show password expiry { maximum-age | minimum-age }

Syntax Description

Parameters

Description

maximum-age

Shows the maximum number of days for set password expiry.

minimum-age

Shows the minimum number of days for set password expiry.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show password expiry user

This command shows the configured password expiration parameters for the specified user.

show password expiry user { maximum-age | minimum-age } userid

Syntax Description

Parameters

Description

maximum-age

Shows the maximum number of days for set password expiry.

minimum-age

Shows the minimum number of days for set password expiry.

userid

Specifies the user account that you want to show.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show password expiry user list

This command shows the password maximum age and password minimum age for each CLI user in the system.

show password expiry user

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf counterhelp

This command displays information about the specified perfmon counter.

show perf counterhelp class-name counter-name

Syntax Description

Parameters

Description

class-name

Represents the class name that contains the counter.

counter-name

Represents the counter that you want to view.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf list categories

This command lists the categories in the perfmon system.

show perf list categories

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf list classes

This command lists perfmon classes (objects).

show perf list classes [ cat category ] [ detail ]

Syntax Description

Parameters

Description

cat category

Displays perfmon classes for the specified category.

detail

Displays detailed information.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf list counters

This command lists perfmon counters for the specified perfmon class.

show perf list counters class-name [ detail ]

Syntax Description

Parameters

Description

class-name

Represents the class name that contains the counter.

detail

Displays detailed information.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf list instances

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

show perf list instances class-name [ detail ]

Syntax Description

Parameters

Description

class-name

Represents the class name that contains the counter.

detail

Displays detailed information.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf query class

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

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

Syntax Description

Parameters

Description

class-name

Represents the class name that contains the counter.

Command Modes

Administrator (admin:)

Usage Guidelines

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

You can specify a maximum of five classes for each command.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf query counter

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

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

Syntax Description

Parameters

Description

class-name

Represents the class name that contains the counter.

counter-name

Represents the counter that you want to view.

Command Modes

Administrator (admin:)

Usage Guidelines

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

You can specify a maximum of five counters for each command.

Note

The output that this command returns depends on the number of endpoints that is configured in the Route Groups in Cisco Unified Communications Manager.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf query instance

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

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

Syntax Description

Parameters

Description

class-name

Represents the class name that contains the counter.

instance-name

Specifies the perfmon instance to view.

Command Modes

Administrator (admin:)

Usage Guidelines

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

You can specify a maximum of five instances for each command.

This command does not apply to singleton perfmon classes.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show perf query path

This command queries a specified perfmon path.

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

Syntax Description

Parameters

Description

path-spec

Specifies a perfmon path.

Command Modes

Administrator (admin:)

Usage Guidelines

For an instance-based perfmon class, you must specify path-spec as follows: class-name(instance-name)\counter-name

For a noninstance-based perfmon class (a singleton), you must specify path-spec as follows: class-name\counter-name

You can specify a maximum of five paths for each command.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

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

show process list

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

show process list [ file filename ] [ detail ]

Syntax Description

Parameters

Description

file

Outputs the results to the file that is specified by the filename variable.

filename

Specifies the filename.

detail

Displays detailed output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process load

This command displays the current load on the system.

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

Syntax Description

Parameters

Description

cont

Repeats the command continuously.

clear

Clears the screen before displaying output.

noidle

Ignores the idle or zombie processes.

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

Sorts output by CPU usage. This is the default sorting.

memory

Sorts output by memory usage.

time

Sorts output by time usage.

page

Displays the output in pages.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process name

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

show process name process [ file filename ]

Syntax Description

Parameters

Description

process

Specifies the name of a process.

file filename

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process name process-name

The command shows the details of processes that share the same name. This commands displays parent-child relationship.

show process name process name [ file vm detail cont ]

Syntax Description

Parameters

Description

process name

Specifies the name of a process.

file

(Optional) Shows the file name where the output is to be received.

vm

(Optional) Shows the virtual memory of the process.

detail

(Optional) Shows the details, such as page fault, virtual memory, and start time of the process.

cont

(Optional) Repeats the command continuously.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process open

This command lists the open file descriptors for a comma separated list of process IDs.

show process open file

Syntax Description

Parameters

Description

file

(Optional) Shows the file name where the output is to be received.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process open-fd

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

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

Syntax Description

Parameters

Description

process-id

Specifies the process-id.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process pid

This command shows a specific process number or command name.

show process pid pid [ file filename ]

Syntax Description

Parameters

Description

pid

Specifies the process ID number of a process.

file filename

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process search

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

show process search regexp [ file filename ]

Syntax Description

Parameters

Description

regexp

Represents a regular expression.

file filename

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process user

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

show process user username [ file detail detail detail cont ]

Syntax Description

Parameters

Description

username

Specifies the username.

file filename

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

vm

(Optional) Shows the virtual memory of the process.

detail

(Optional) Shows the details, such as page fault, virtual memory, and start time of the process.

cont

(Optional) Repeats the command continuously.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process using-most cpu

This command displays a list of the most CPU-intensive processes.

show process using-most cpu [ number ] [ file filename ]

Syntax Description

Parameters

Description

number

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

file filename

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show process using-most memory

This command displays a list of the most memory-intensive processes.

show process using-most memory [ number ] [ file filename ]

Syntax Description

Parameters

Description

number

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

file filename

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show registry

This command displays the contents of the registry.

show registry system component [ name ] [ page ]

Syntax Description

Parameters

Description

system

Represents the registry system name.

component

Represents the registry component name.

name

Represents the name of the parameter to show.

page

Displays one page at a time.

Command Modes

Administrator (admin:)

Usage Guidelines

If the name is “page,” and you want to display the output one page at a time, use the command show registry system  component  name page page

To show all components in a system, enter the wildcard character * in the command:  show registry system  *

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

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

admin:show registry cm dbl/sdi
system = cm
component = dbl/sdi
tracelevel=127
enable=1
outputdebugstringflag=0
numminutes=1440
tracefile=/var/log/active/cm/trace/dbl/sdi/dbl.log
numfiles=250
numlines=10000

show risdb list

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

show risdb list [ file filename ]

Syntax Description

Parameters

Description

file filename

Outputs the information to a file.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

This command displays a list of all RIS database tables.

admin: show risdb list

show risdb query

This command displays the contents of the specified RIS tables.

show risdb query table1 table2 table3 ... [ file filename ]

Syntax Description

Parameters

Description

table1

Specifies the name of a table.

file filename

Outputs the information to a file.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show samltrace level

This command displays the trace level that is currently configured.

show samltrace level

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on Unified Communications Manager, Cisco Unity Connection.

show session maxlimit

This command shows the upper limit for concurrent SSH sessions.

show session maxlimit

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show smtp

This command displays the name of the SMTP host.

show snmp

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show stats io

This command displays the IO statistics.

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

Syntax Description

Parameters

Description

kilo

Displays statistics in kilobytes.

detail

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

page

Displays one page at a time.

file filename

Outputs the information to a file specified by filename

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show status

This command displays basic platform status.

show status

Command Modes

Administrator (admin:)

Usage Guidelines

This command displays the following basic platform status:

- hostname

- date

- timezone

- locale

- product version

- platform version

- CPU usage

- memory and disk usage

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech activesql

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

show tech activesql

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech all

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

show tech all [ page ] [ file filename ]

Syntax Description

Parameters

Description

page

Displays one page at a time.

file filename

Outputs the information to a file.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech ccm_service

This command displays information about all services that can run on the system.

show tech ccm_service

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech database

This command shows information about the database.

show tech database { dump | sessions }

Syntax Description

Parameters

Description

dump

Creates a CSV file of the entire database.

sessions

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dberrcode

This command displays information (from the database log files) about the error code that is specified.

show tech dberrcode errorcode

Syntax Description

Parameters

Description

errorcode

Specifies the error code as a positive integer.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dbhighcputasks

This command displays the currently running high cost tasks and high CPU-intensive tasks.

show tech dbhighcputasks

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dbintegrity

This command displays the database integrity.

show tech dbintegrity

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dbschema

This command displays the database schema in a CSV file.

show tech dbschema [ car | cm ]

Syntax Description

Parameters

Description

car

Represents the car database.

cm

Represents the cm database.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dbinuse

This command displays the database in use.

show tech dbinuse [ car | cm ]

Syntax Description

Parameters

Description

car

Represents the car database.

cm

Represents the cm database.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dbstateinfo

This command displays the state of the database.

show tech dbstateinfo [ car | cm ]

Syntax Description

Parameters

Description

car

Represents the car database.

cm

Represents the cm database.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech devdefaults

This command displays the device defaults table.

show tech devdefaults

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech dumpCSVandXML

This command provides detailed information for customer support in the case of a standard upgrade condition.

show tech dumpCSVandXML

Command Modes

Administrator (admin:)

Usage Guidelines

You can get this file in 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: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech gateway

This command displays the gateway table from the database.

show tech gateway

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech locales

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

show tech locales

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech network all

This command displays all network tech information.

show tech network all [ page ] [ search text ] [ file filename ]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech network hosts

This command displays information about hosts configuration.

show tech network hosts [ page ] [ search text ] [ file filename ]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech network interfaces

This command displays information about the network interfaces.

show tech network interfaces [ page ] [ search text ] [ file filename ]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech network resolv

This command displays information about hostname resolution.

show tech network resolv [ page ] [ search text ] [ file filename ]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech network routes

This command displays information about network routes.

show tech network routes [ page ] [ search text ] [ file filename ]

Syntax Description

Parameters

Description

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.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech network sockets

This command displays the list of open sockets.

show tech network sockets { numeric }

Syntax Description

Parameters

Description

numeric

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech notify

This command displays the database change notify monitor.

show tech notify [search pattern_to_match]

Syntax Description

Parameters

Description

search pattern_to_match

Represents the string that needs to be searched in the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech params

This command displays the database parameters.

show tech params { all | | enterprise | | service }

Syntax Description

Parameters

Description

all

Displays all the database parameters.

enterprise

Displays the database enterprise parameters.

service

Displays the database service parameters.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech prefs

This command displays database settings.

show tech prefs

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech procedures

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

show tech procedures { car | | cm }

Syntax Description

Parameters

Description

car

Specifies the CAR procedures.

cm

Specifies the CM procedures.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech repltimeout

This command displays the replication timeout.

show tech repltimeout

Command Modes

Administrator (admin:)

Usage Guidelines

When you increase the replication timeout, ensure that as many servers as possible in a large system are 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 delays the initial set up of replication to give all servers time to get ready for setup.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech routepatterns

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

show tech routepatterns

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech routeplan

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

show tech routeplan

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech runtime

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

show tech runtime { all | cpu | disk | env | memory } page file filename

Syntax Description

Parameters

Description

all

Displays all runtime information.

cpu

Displays CPU usage information at the time the command is run.

disk

Displays system disk usage information.

env

Displays environment variables.

memory

Displays memory usage information.

page

Displays one page at a time.

file filename

Outputs the information to a specified file.

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

show tech sqlhistory

This command prints the history of SQL statements executed.

show tech sqlhistory

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech systables

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

show tech systables

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech system

This command displays all the system information.

show tech system { all | bus | hardware | host | kernel modules | software | tools } page file filename

Syntax Description

Parameters

Description

all

Displays all the system information.

bus

Displays information about the data buses on the server.

hardware

Displays information about the server hardware.

host

Displays information about the server.

kernel modules

Lists the installed kernel modules.

software

Displays information about the installed software versions.

tools

Displays information about the software tools on the server.

page

Displays one page at a time.

file filename

Outputs the information to a file. This option saves the information to platform/cli/<filename>.txt. Ensure that the file name does not contain the "." character.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech table

This command displays the contents of the specified database table.

show tech table table_name [page]

Syntax Description

Parameters

Description

table_name

Represents the name of the table to display.

page

Displays the output one page at a time.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech triggers

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

show tech triggers

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tech version

This command displays the version of the installed components.

show tech version [page]

Syntax Description

Parameters

Description

page

Displays one page at a time.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show timezone config

This command displays the current timezone settings.

show timezone config

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show timezone list

This command displays the available timezones.

show timezone list [ page ]

Syntax Description

Parameters

Description

page

Displays the output one page at a time.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tlstrace

This command shows the status of TLS trace for a service.

show tlstrace [ service ]

Syntax Description

Parameters

Description

service

Represents the TLS tracing status of a service. It is a mandatory parameter.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show tlsresumptiontimeout

This command shows the TLS session resumption timeout.

show tlsresumptiontimeout

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show trace

This command displays trace information for a particular task.

show trace [ task_name ]

Syntax Description

Parameters

Description

task_name

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

Command Modes

Administrator (admin:)

Usage Guidelines

If you do not enter a parameter, the command returns a list of available tasks.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin: show trace cdps

show ups status

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

show ups status

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show version active

This command displays the software version on the active partition.

show version active

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show version inactive

This command displays the software version on the inactive partition

show version inactive

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show web-security

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

show web-security

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show webapp session timeout

This command displays the webapp session timeout value, which is the amount of time, in minutes, that can elapse before a web application times out and logs off the user.

show webapp session timeout

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show workingdir

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

show workingdir

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

show logins unsuccessful

Use this command to list recent unsuccessful login attempts to the following web applications:

- On Cisco Unified Communications Manager

- Disaster Recovery System

- Cisco Unified OS Administration

- On IM and Presence Service

- IM and Presence Disaster Recovery System

- Cisco Unified IM and Presence OS Administration

show logins unsuccessful [number]

Syntax Description

Parameters

Description

number

Specifies the number of most recent logins to display. The default is 20.

Command Modes

Administrator (admin)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to Cisco Unified Communications Manager and IM and Presence Service

Chapter 8. Unset Commands

unset ipsec policy_group

This command disables the ipsec policy on the specified group.

unset ipsec policy_group policy_group

Syntax Description

Parameters

Description

policy_group

Specifies the group name.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

unset ipsec policy_name

This command disables the ipsec policy with the specified name.

unset ipsec policy_name policy_name

Syntax Description

Parameters

Description

policy_name

Specifies the policy name to disable.

Command Modes

Administrator (admin:)

Usage Guidelines

Enter ALL for policy_name to disable all policy names.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

unset network cluster subscriber details

This command shows the message that you need to delete a subscriber node from the GUI instead of the command prompt.

unset network cluster subscriber details

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to Cisco Unified Communications Manager, IM and Presence Service on Communications Manager, and Cisco Unity Connection

Message to delete the subscriber from GUI

admin: unset network cluster subscriber details
Please use the Cisco Unified Communications Manager on the first node.
Navigate to System > Server and click “Find”.
Unable to del: NULL
Executed command unsuccessfully.

unset network cluster subscriber dynamic-cluster-configuration

This command disables Dynamic Cluster Configuration on the publisher. The value of Dynamic Cluster Configuration option is set to zero on publisher.

unset network cluster subscriber dynamic-cluster-configuration

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, and Cisco Unity Connection

unset network dns options

This command unsets DNS options.

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

Syntax Description

Parameters

Description

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 the system fails to the default.

rotate

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

Command Modes

Administrator (admin:)

Usage Guidelines

You are asked to confirm that you want to execute this command.

Caution

If you continue, the system loses network connectivity temporarily.

Requirements

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

unset network domain

This command unsets the domain name and restarts the server.

unset network domain

Command Modes

Administrator (admin:)

Usage Guidelines

You are asked to confirm that you want to execute this command.

Requirements

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin: unset network domain

cmdSetIp.domain.name.change.warning

Continue (y/n)?

trying to restart system...

Warning: Restart could take up to 5 minutes...

Shutting down Service Manager. Please wait...

unset network ntp options

This command unsets the domain name and restarts the server.

unset network ntp options

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

unset network ipv6 gateway

This command unsets the IPv6 gateway on the server.

unset network ipv6 gateway [ reboot ]

Syntax Description

Parameters

Description

reboot

Reboots the server after applying the change.

Note:
By default, the reboot on the server does not happen.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

unset network ipv6 static_address

This command unsets the IPV6 static address.

unset network ipv6 static_address [ reboot ]

Syntax Description

Parameters

Description

reboot

Reboots the server after applying the change.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin: admin:unset network ipv6 static_address

W A R N I N G

The Server must be rebooted for these changes to take effect.

Please make sure that you reboot this server.

IPv6 static address was removed.

Chapter 9. Utils Commands

- utils auditd

- utils create report

- utils create report database

- utils ctl

- utils diagnose

- utils fips

- utils ils showpeerinfo

- utils import config

- utils iostat

- utils iothrottle

- utils itl reset

- utils ldap config

- utils remotesyslog show protocol

- utils reset_application_ui_administrator_name

- utils reset_application_ui_administrator_password

- utils restore_application_ui_administrator_account

- utils soap realtimeservice test

- utils update dst

- utils users validate

- utils system boot status

utils auditd

This command starts, stops, and provides the status of the system auditing service.

utils auditd { enable | disable | status }

Syntax Description

Parameters

Description

enable

Enables the collection of audit logs. When enabled, the system monitors and records user actions as well as Linux events such as the creation and removal of users, as well as the editing and deleting of files .

disable

Disables the collection of audit logs.

status

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

Command Modes

Administrator (admin:)

Usage Guidelines

After the service has been enabled, it monitors and logs activity on the system. Be aware that the system auditing service logs a lot of information. Care must be taken not to overfill the disk.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils contactsearchauthentication disable

This command disables the secure contact search authentication mode. After this mode is disabled, you need to reset the phone for the changes to take effect.

utils contactsearchauthentication disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils contactsearchauthentication enable

This command enables the secure contact search authentication mode. After this mode is enabled, reset the phone for the changes to take effect.

utils contactsearchauthentication enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils contactsearchauthentication status

This command shows whether the system is operating in contact search authentication enable mode or contact search authentication disable mode.

utils contactsearchauthentication status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils core analyze

This command generates a backtrace for a core file, a thread list, and the current value of all CPU registers.

utils core { active | inactive } analyze [core_filename]

Syntax Description

Parameters

Description

active

Specifies an active version

inactive

Specifies an inactive version

core_filename

Specifies the name of the core file from which to generate the stack trace.

Command Modes

Administrator (admin:)

Usage Guidelines

This command creates a file of the same name as the core file, with a .txt extension, in the same directory as the core file. After you execute this command on a core file created by cimserver, an unexpected message displays. This message is a known limitation of the command.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils core list

This command displays all active or inactive core files.

utils core { active | inactive } list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils capf cert import

utils capf cert import

Use this command to upload signed phone certificates to your system.

Usage Guidelines

You can choose to import your signed certificates through either FTP or TFTP.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager

utils capf csr

utils capf csr { dump | count | delete }

This command helps you manage third-party CA signed certificates on your system.

Syntax Description

Parameters

Description

count

View the number of certificates and CSRs available on your system.

delete

Remove all certificates and CSRs on your system.

dump

After all CSRs are signed by the CA, download them to your local server with this parameter.

Usage Guidelines

For information about how to use this command set, see the "Generate and Import Third Party CA-Signed LSCs" procedure in the Cisco Unified Communications Manager Security Guide at Click Here .

Requirements

Command privilege level: 0 for the count parameter, 1 for delete and dump parameters.

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager

utils create report

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

utils create report { hardware | platform | security }

Syntax Description

Parameters

Description

hardware

Creates a system report that contains disk array, remote console, diagnostic, and environmental data.

platform

Collects the platform configuration files into a TAR file.

security

Collects the diagnostic reports and creates a TAR file that you can download for troubleshooting purposes. You can retrieve this file with the file get command.

Command Modes

Administrator (admin:)

Usage Guidelines

You are prompted to continue after you enter the command.

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils create report database

This command collects all log the files that are needed for database troubleshooting.

utils create report { hardware | platform | security }

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils ctl

utils ctl { set-cluster mixed-mode | set-cluster non-secure-mode | update CTLFile }

This command changes the cluster security mode or updates the CTL file in each of the nodes.

Syntax Description

Parameters

Description

set-cluster mixed-mode

Updates the CTL file and sets the cluster to mixed mode (db secure mode is set to 1).

If the cluster is already in mixed mode, this command shows that Unified Communications Manager is in mixed mode and Autoregistration is active. You will need to confirm your action.

set-cluster non-secure-mode

Updates the CTL file and set the cluster to non-secure mode.

If the cluster is already in mixed mode, this command shows that Unified Communications Manager is in non-secure mode.

update CTLFile

Updates the CTL file in each of the nodes of the cluster.

Command Modes

Administrator (admin:)

Usage Guidelines

The CLI must be executed on the publisher. On all other nodes, this CLI command is disabled.

Note

After you regenerate the CTL file, you must restart CallManager and TFTP services across the cluster.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager.

- utils ctl reset localkey

utils ctl reset localkey

This command is used to regenerate the CTL file and sign it with the secondary SAST role (ITLRecovery). Use this command where the CallManager certificate that was used to sign the original CTL file has changed and so, the endpoints are locked out.

utils ctl reset { localkey }

Syntax Description

localkey

Generates a new CTL file, updates the CTL file on the publisher. The command signs the CTLfile with ITLRecovery key.

Command Modes

Administrator (admin:)

Usage Guidelines

Note

- You must run this command on the Unified Communications Manager publisher node.

- After the endpoints receive the new CTL file, which is signed by ITLrecovery and contains the new CallManager certificate, execute the CTL update command again to sign it with the new CallManager certificate. The CTL file is regenerated but signed by the new CallManager certificate, which is then trusted by the endpoints.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager

utils cuc activate CUSRSV

This command converts the standalone Cisco Unity Connection server to Cisco Unity Connection SRSV server.

utils cuc activate CUSRSV

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc cluster activate

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

utils cuc cluster activate

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

utils cuc cluster deactivate

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

utils cuc cluster deactivate

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

utils cuc cluster makeprimary

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

utils cuc cluster makeprimary

Syntax Description

Parameters

Description

server

Specifies the name of the server to take the primary server status in a Cisco Unity Connection cluster.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

utils cuc cluster overwritedb

This command overwrites the data on the server with the data on the other server in a Cisco Unity Connection cluster.

utils cuc cluster overwritedb

Command Modes

Administrator (admin:)

Usage Guidelines

This command overwrites the database on the server on which you run this command with the database from the other server in the Connection cluster. Replication restarts after the database is overwritten. This method is used when you restore one server from a backup and must copy the restored data to the other server.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

utils cuc cluster renegotiate

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

utils cuc cluster renegotiate

Command Modes

Administrator (admin:)

Usage Guidelines

Run this command on the subscriber server in a Connection cluster to set up a trust with a publisher server that has been replaced or on which Connection has been reinstalled.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

utils cuc create report

This command collects data that is helpful to technical support staff for troubleshooting the system. Data collected includes version information, cluster status, service information, database information, trace files, log files, disk information, memory information, and restart information.

utils cuc create report

Command Modes

Administrator (admin:)

Usage Guidelines

After the command completes, detailed information gets saved in a .zip file, and the location of the zip file displays. Use the file get command to move the file to a computer on which you can uncompress the file and view the contents.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only

Example

admin: utils cuc create report
Getting unity connection version. Please wait...Done
Getting cluster status. Please wait...Done
Getting service information. Please wait...Done
Getting installed locales. Please wait...Done
Getting database schema version. Please wait...Done
Getting database integrity. Please wait...Done
Getting database diagnostic log. Please wait...Done
Getting database message log. Please wait...Done
Getting trace files. Please wait...Done
Getting log files. Please wait...Done
Getting platform status. Please wait...Done
Compressing 75 files. Please wait...Done
Output is in file: cuc/cli/systeminfo_080318-140843.zip
To free disk space, delete the file after copying it to another computer

utils cuc dbreplication 01_tear_down

This command breaks the replication and connectivity between two Unity Connection servers in a cluster. Running this command on both the servers ensures ideal cleanup before establishing a good replication between the servers.
utils cuc dbreplication 01_tear_down

Command Modes

Administrator (admin:)

Usage Guidelines

In case of long Unity Connection database CDR queue buildup, this command cleans the buildup for providing clean ground to establish server connectivity and replication between the two servers in the cluster.

Note

It is recommended to :

- Take the system backup before running the command.

- Collect the screen log information along with command line logs if the command fails and escalate it to Cisco TAC.

- Ensure that only Cisco TAC runs the command.

- Run the command on the server with obsolete data as the synchronization process deletes the data that clashes with the information on the other server.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc dbreplication 02_define_servers

This command establishes the network connectivity between the two Unity Connection servers in a cluster.

utils cuc dbreplication 02_define_servers

Command Modes

Administrator (admin:)

Usage Guidelines

You can use this command to track and report the CDR traffic from one server to another in a Unity Connection cluster. During SBR process, this command helps in defining the roles of the two server in a cluster.

Note

It is recommended to :

- Take the system backup before running the command.

- Collect the screen log information along with command line logs if the command fails and escalate it to Cisco TAC.

- Ensure that only Cisco TAC runs the command.

- Run the command on the server with obsolete data as the synchronization process deletes the data that clashes with the information on the other server.

Note

You should run this command on the server that has obsolete data in a Unity Connection cluster.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc dbreplication 03_define_db_template

This command creates the replication record of the set of tables in Unity Connection databases for replication synchronization. This command also negotiates the table templates of Unity Connection database on which the replication scheme needs to be established.

utils cuc dbreplication 03_define_db_template

Command Modes

Administrator (admin:)

Usage Guidelines

This command lists all the tables and defines templates on basis of which the data is negotiated and synchronized between the two servers in a Unity Connection cluster.

Note

It is recommended to :

- Take the system backup before running the command.

- Collect the screen log information along with command line logs if the command fails and escalate it to Cisco TAC.

- Ensure that only Cisco TAC runs the command.

- Run the command on the server with obsolete data as the synchronization process deletes the data that clashes with the information on the other server.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc dbreplication 04_sync_database

This command synchronizes the database from the remote server to the server on which the command is executed.

utils cuc dbreplication 04_sync_database

Command Modes

Administrator (admin:)

Usage Guidelines

You should run this command on the server that has obsolete data in a Unity Connection cluster to copy the recent data from the remote server on the current server.

Note

It is recommended to :

- Take the system backup before running the command.

- Collect the screen log information along with command line logs if the command fails and escalate it to Cisco TAC.

- Ensure that only Cisco TAC runs the command.

- Run the command on the server with obsolete data as the synchronization process deletes the data that clashes with the information on the other server.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc dbreplication reset_all

This command performs all the tasks, such as tear down and defining servers required to reset database replication between the two servers in a Unity Connection cluster.

utils cuc dbreplication reset_all

Command Modes

Administrator (admin:)

Usage Guidelines

This command executes the following commands sequentially to successfully reset database replication between the two servers in a Unity Connection cluster:

- utils cuc dbreplication01_tear_down

- utils cuc dbreplication 02_define_servers

- utils cuc dbreplication 03_define_db_template

- utils cuc dbreplication 04_sync_database

Note

It is recommended to :

- Take the system backup before running the command.

- Collect the screen log information along with command line logs if the command fails and escalate it to Cisco TAC.

- Ensure that only Cisco TAC runs the command.

- Run the command on the server with obsolete data as the synchronization process deletes the data that clashes with the information on the other server.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc jetty ssl disable

This command allows you to set the status of SSL (Disabled) on the Jetty Server for notifications.

utils cuc jetty ssl disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: utils cuc jetty ssl disable

After successful execution of this command restart of Jetty server is required, which will result in loss of current event subscriptions. Are you sure?
Enter (yes/no)? yes

Command completed successfully.
Please restart Connection Jetty Service.
In case of cluster, run this command on the other node also.

utils cuc jetty ssl enable

This command allows you to set the status of SSL (Enabled) on the Jetty Server for notifications.

utils cuc jetty ssl enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: utils cuc jetty ssl enable

After successful execution of this command restart of Jetty server is required, which will result in loss of current event subscriptions. Are you sure?
Enter (yes/no)? yes

Command completed successfully.
Please restart Connection Jetty Service.
In case of cluster, run this command on the other node also.

utils cuc networking clear_replication

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

utils cuc networking clear_replication

Command Modes

Administrator (admin:)

Usage Guidelines

This command stops the Connection Digital Networking Replication Agent and Connection SMTP service, 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 and Connection SMTP service. Depending on the size of the replication folders, this operation may take several minutes.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc networking dscp

This command causes Connection either to start or to stop including a DSCP value of 18 in packets sent between the Connection servers in a cluster, so a router configured to prioritize packets based on their DSCP value can prioritize Connection data and voice messages.

utils cuc networking dscp { on | off }

Syntax Description

Parameters

Description

on

Causes Connection to start including a DSCP value of 18 packets sent over the network.

off

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

Command Modes

Administrator (admin:)

Usage Guidelines

This command makes the DSCP value available in the packets being passed between the Connection servers in a  cluster. For the information to be used, you must configure the router. The command lets you control whether a DSCP value is included in outgoing packets, but you can not change the value.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only

utils cuc reset password

This command resets the password for a specified user account. If Connection locked the account because of too many failed sign-in attempts, this command also unlocks the account.

utils cuc reset password

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only

Example

admin: utils cuc reset password jdoe
Enter password:
Re-enter password:
jdoe
07/29/2008 12:41:14.704 : Update SUCCESSED

utils cuc set PinExpiry_PromptTime “Authentication Rule Name”

This Command enables the Cisco Unity Connection telephone user interface (touchtone conversation) PIN feature and allows you to update the time interval during when the conditional expiry warning prompt will be played.

Requirements

If the value is set to:

- 0: disabled

- 1: enabled

- Enter the time interval

For more information on utilscuc set PinExpiry_PromptTime "Authentication Rule Name" CLI command, see the Cisco Unity Connection telephone user interface (touchtone conversation) PIN section in Release Notes for Cisco Unity Connection 10.0(1).

utils dbreplication clusterreset

This command resets replication on an entire cluster.

utils dbreplication clusterreset

Command Modes

Administrator (admin:)

Usage Guidelines

Note

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

You can use this command to debug database replication. However, you should only use it if you have already tried utils dbreplication reset all, and it failed to restart replication on the cluster. This command tears down and rebuilds replication for the entire cluster. After you use this command, you must restart each subscriber server. After all subscriber servers have been restarted, you must go to the publisher server and issue the CLI command utils dbreplication reset all.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication dropadmindb

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

utils dbreplication dropadmindb

Command Modes

Administrator (admin:)

Usage Guidelines

You should run this command only if database replication reset or cluster reset fails and replication cannot be restarted.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication forcedatasyncsub

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

utils dbreplication forcedatasyncsub nodename [offloadpub] [timeoutvalue]

Syntax Description

Parameters

Description

nodename

Specifies a particular subscriber server to have its data restored from data on the publisher server. Enter all to restore data on all subscriber servers.

offloadpub

Minimizes the usage of the publisher server during the forcedatasyncsub process.

Note:
Adding this option increases the time taken for forcedatasyncsub to finish

timeoutvalue

Specifies the recovery timeout value for each node in minutes (should be greater than the default timeout).

Default: 40 minutes.

Command Modes

Administrator (admin:)

Usage Guidelines

Use this command only after you have run the utils dbreplication repair command several times, but the utils dbreplication status command still shows non-dynamic tables that are not in sync

Note

Do not run this command if only dynamic tables are out of sync; dynamic tables can be out of sync during normal system operation.

You can only run this command from the publisher server. Enter all to force sync on all subscriber servers in the cluster. If only one subscriber server is out of sync, use the nodename parameter.

Note

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication quickaudit

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

utils dbreplication quickaudit { nodename | all }

Syntax Description

Parameters

Description

nodename

Specifies the node on which the quick audit should be run.

all

Causes the audit to be run on all nodes

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication rebuild

After you change the hostname of a Unified Communications Manager publisher or subscriber node, you must run this command to set up database replication across the cluster. This command will run the following commands on the specified nodes:

- utils dbreplication stop

- utils dbreplication dropadmindb or dropadmindbforce

- utils dbreplication reset

utils dbreplication rebuild { [nodename] | | all }

Syntax Description

Parameters

Description

nodename

Specifies the node or nodes on which database replication will be rebuilt.

all

Specifies that database replication will be rebuilt on all nodes in the cluster.

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

This command can affect performance of other nodes in your cluster. We recommend that you run this command during a system maintenance window.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication repair

This command repairs database replication.

utils dbreplication repair { nodename | all }

Syntax Description

Parameters

Description

nodename

Specifies a particular subscriber server for data repair.

all

Causes data repair to take place on all subscriber servers.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Specify all to repair all nodes in the cluster, or if only one subscriber server is out of sync, specify the nodename parameter.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication repairreplicate

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

utils dbreplication repairreplicate replicatename [ nodename | all ]

Syntax Description

Parameters

Description

replicatename

Specifies the replicate to repair.

nodename

Specifies the node on which to repair replication.

all

Specifies to fix replication on all nodes.

Command Modes

Administrator (admin:)

Usage Guidelines

The parameter nodename may not specify the publisher; any subscriber node name is acceptable.

Note

This command can be executed on the publisher.

Note

This command does not repair replication setup

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication repairtable

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

utils dbreplication repairtable tablename [ nodename | all ]

Syntax Description

Parameters

Description

tablename

Specifies the table to repair

nodename

Specifies the node on which to repair replication.

all

Specifies to fix replication on all nodes.

Command Modes

Administrator (admin:)

Usage Guidelines

Note

This command does not repair replication setup.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication reset

This command resets and restarts database replication. You can use this command to rebuild replication when the system has not set up replication properly.

utils dbreplication reset { nodename | all }

Syntax Description

Parameters

Description

nodename

Specifies a particular subscriber server to on which to have replication rebuilt.

all

Specifies that all subscriber servers in the cluster have replication rebuilt.

Command Modes

Administrator (admin:)

Usage Guidelines

This command is the best option to use when servers show an RTMT state of 4. If only one subscriber server shows an RTMT state of 4, you may reset that server by specifying the hostname parameter. To reset the entire cluster, use the all parameter.

Tip

Before you run this command, first run the command utils dbreplication stop on all subscriber servers that are reset and then on the publisher server.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication runtimestate

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

utils dbreplication runtimestate nodename

Syntax Description

Parameters

Description

nodename

Specifies the node to monitor.

Command Modes

Administrator (admin:)

Usage Guidelines

If you provide a node name, the system provides the replication state from the context of the selected node.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication setprocess

This command improves replication performance of clusters that have nodes separated by WANs with delay (Clustering over WAN configuration).

utils dbreplication setprocess [process]

Syntax Description

Parameters

Description

process

The new database replication . Ensure that the value is between 1 and 40.

Default value: 1

Command Modes

Administrator (admin:)

Usage Guidelines

Caution

Setting the PROCESS option to near maximum consumes more system resources.

Changes made to this setting after an upgrade but before the switch-over to the new version will need to be manually re-applied.

Requirements

Command privilege level: 1

Allowed during upgrade: No

utils dbreplication setrepltimeout

This command sets the timeout for database replication on large clusters.

utils dbreplication setrepltimeout timeout

Syntax Description

Parameters

Description

timeout

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

Default value: 300 (5 minutes)

Command Modes

Administrator (admin:)

Usage Guidelines

After the first subscriber server requests replication with the publisher server, the system sets this timer. After the timer expires, the first subscriber server, plus all other subscriber servers that requested replication within that time period, begin data replication with the publisher server in a batch. If you have several subscriber servers, batch replication is more efficient than individual server replication. For large clusters, you can use the command to increase the default timeout value, so that more subscriber servers are included in the batch.

Tip

Cisco recommends that you restore this value back to the default of 300 (5 minutes) after you finish upgrading the entire cluster, and the subscriber servers have successfully set up replication.

Note

After you upgrade the publisher server and restart it on the upgraded partition, you should set this timer value before you switch the first subscriber server to the new release. After the first subscriber server requests replication, the publisher server sets the replication timer based on the new value.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication status

This command shows the status of database replication and indicates whether the servers in the cluster are connected and the data is in sync.

utils dbreplication status { all | node | replicate }

Syntax Description

Parameters

Description

all

Specifies to show the status of all servers.

node

Specifies the node for which to show status.

replicate

Specifies the replicate for which to show status.

Command Modes

Administrator (admin:)

Usage Guidelines

Note

You should run this command only on the first node (publisher server) of a cluster.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils dbreplication stop

This command stops the automatic setup of database replication. Run this command on subscriber and publisher servers before executing the CLI command utils dbreplication reset or utils dbreblication clusterreset. You can run this command on the subscriber servers simultaneously, before you run it on the publisher server.

utils dbreplication stop { nodename | all }

Syntax Description

Parameters

Description

nodename

Specifies the name of the node on which to stop the automatic setup of database replication.

all

Stops database replication on all nodes.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils imdb_replication replication status

This command validates that In Memory Database (IMDB) replication between the node pairs in each subcluster of the deployment has run correctly.

The command performs writes and reads on IMDB tables in each relevant Datastore using a utility from the calling IM and Presence Service node.

utils imdb_replication status

Command Modes

Administrator (admin:)

Usage Guidelines

For the utility to run successfully, ports 6603, 6604, and 6605 must be opened on any firewalls that are configured between the nodes on the IM and Presence Service clusters.

This is not required for the normal operation of the IMDB.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: IM and Presence Service

utils diagnose

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

utils diagnose { fix | list | module | test | version } [module_name]

Syntax Description

Parameters

Description

fix

Runs all diagnostic commands and attempts to fix problems.

list

Lists all available diagnostic commands.

module

Runs a single diagnostic command or group of commands and attempts to fix problems

test

Runs all diagnostic commands but does not attempt to fix problems.

version

Displays the diagnostic framework version.

module_name

Specifies the name of a diagnostics module.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0 for version and 1 for all other parameters

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery backup network

Displays information about the backup files that are stored on a remote server.

utils disaster_recovery backup network [featurelist] [path] [servername] [username]

Syntax Description

Parameters

Description

featurelist

Specifies a list of features to back up, separated by commas.

path

Represents the location of the backup files on the remote server.

servername

Represents the IP address or hostname of the server where you stored the backup files.

username

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery cancel_backup

This command cancels the ongoing backup.

utils disaster_recovery cancel_backup [confirm]

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

Example

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

utils disaster_recovery device add network

This command adds the backup network device.

utils disaster_recovery device add network devicename path server_namei/ip_address username [Number_of_backups]

Syntax Description

Parameters

Description

devicename

Specifies the name of the backup device to be added (mandatory).

path

Specifies the path to retrieve the backup device (mandatory).

server_name/ip_address

Specifies the hostname or IP address of the server where the backup file is stored (mandatory).

username

Specifies the userid required to connect to the remote machine (mandatory).

Number_of_backups

Specifies the number of backups to store on the Network Directory (default 2). This parameter is optional.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

Example

admin: utils disaster_recovery device add network networkDevice /root 10.77.31.116 root 3

utils disaster_recovery device delete

This command deletes the specified device.

utils disaster_recovery device delete device_name | *

Syntax Description

Parameters

Description

device_name

Name of the device to be deleted.

*

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

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery device list

Displays the device name, device type, and device path for all the backup devices.

utils disaster_recovery device list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery estimate_tar_size

This command provides the estimated size of last successful backup from SFTP or local device.

utils disaster_recovery estimate_tar_size utils disaster_recovery device list

Syntax Description

Parameters

Description

featurelist

Specifies a list of features to back up, separated by commas.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery history

This command displays the history of previous backups and restores.

utils disaster_recovery history [operation]

Syntax Description

Parameters

Description

operation

Specifies backup or restore.

Command Modes

Administrator (admin:)

Requirements

Command privilege level:

Allowed during upgrade:

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

Example

admin: utils disaster_recovery history backup
Tar Filename: Backup Device: Completed On: Result: Backup Type: Features Backed Up:
2009-10-30-14-53-32.tar TAPE Fri Oct 30 14:55:31 CDT 2009 ERROR MANUAL
2009-12-10-10-30-17.tar TAPE Thu Dec 10 10:35:22 CST 2009 SUCCESS MANUAL CDR_CAR,CCM

utils disaster_recovery jschLogs operation

This command enables and disables the detailed JSch logging.

utils disaster_recovery jschLogs operation [operation]

Syntax Description

Parameters

Description

operation

Specifies the name of operation—enable or disable.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery prepare restore pub_from_sub

This command handles the tasks to prepare for restore of a publisher node from a subscriber node.

Note

This command is applicable only when a publisher node is rebuilt and restored from the subscriber node database. A specific procedure is used for restore instead of restoring the data from the remote backup source. After a publisher node is rebuilt, you must use this command prior to the insertion of process node information.

utils disaster_recovery prepare restore pub_from_sub

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery restore network

This command restores a remote server. You must restore the Cisco Unified Communications Manager publisher node before you restore subscriber nodes in the same cluster. If you are restoring IM and Presence Service nodes, you must restore the database publisher node before you restore subscriber nodes in the same cluster.

utils disaster_recovery restore network restore_server tarfilename devicename

Syntax Description

Parameters

Description

restore_server

Specifies the hostname of the remote server that you want to restore.

tarfilename

Specifies the name of the file to restore.

devicename

Specifies the name of the device on which to restore files.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery schedule add

This command adds the configured schedules.

utils disaster_recovery schedule add schedulename devicename featurelist datetime frequency

Syntax Description

Parameters

Description

schedulename

Represents the name of the scheduler (mandatory).

devicename

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

featurelist

Represents the comma-separated feature list to back up (mandatory).

datetime

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

frequency

Represents the frequency at which the schedule is set to take a backup. Examples: once, daily, weekly and monthly.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery schedule

This command enables or disables the specified schedule.

utils disaster_recovery schedule { enable | disable } [schedulename]

Syntax Description

Parameters

Description

enable

Enables the specified schedule.

disable

Disables the specified schedule.

schedulename

Represents the name of the scheduler.

Command Modes

Administrator (admin:)

Requirements

Command privilege level:1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

Example

admin: utils disaster_recovery schedule enable schedule1
Schedule enabled successfully.

utils disaster_recovery schedule delete

This command deletes the configured schedules.

utils disaster_recovery schedule delete schedulename

Syntax Description

Parameters

Description

schedulename

Represents the name of the schedule that is to be deleted.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery schedule disable

This command disables the configured schedules.

utils disaster_recovery schedule disable schedulename

Syntax Description

Parameters

Description

schedulename

Represents the name of the schedule that is to be disabled.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery schedule list

Displays the schedules that are configured.

utils disaster_recovery schedule list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

Example

admin: utils disaster_recovery schedule list
schedule name    device name    Schedule Status
-----------------------------------------
schedule1                    device 1                    enabled
schedule2                    device 2                    disabled

utils disaster_recovery show_backupfiles

This command retrieves the information of backup files, which are available at storage location.

utils disaster_recovery show_backupfiles devicename

Syntax Description

Parameters

Description

devicename

Represents the name of the device to show backup files at the storage location.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery show_registration

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

utils disaster_recovery show_registration hostname

Syntax Description

Parameters

Description

hostname

Specifies the server for which you want to display registration information.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils disaster_recovery status

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

utils disaster_recovery status operation

Syntax Description

Parameters

Description

operation

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils EnhancedSecurityMode disable

The command disables the EnhancedSecurityMode mode on the system. The system reboots after this mode is disabled.

utils EnhancedSecurityMode disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils EnhancedSecurityMode enable

The command enables the EnhancedSecurityMode mode on the system. The system reboots after this mode is enabled.

utils EnhancedSecurityMode enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils EnhancedSecurityMode status

The command displays whether the system is operating in EnhancedSecurityMode or non-EnhancedSecurityMode mode.

utils EnhancedSecurityMode status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils filebeat config

The command configures the Logstash server details for downloading the information.

utils filebeat config IP address port number log type

Syntax Description

Parameters

Description

IP address

Enter the IP address of the Logstash server.

port number

Enter the port number of Logstash server.

log type

Enter the log type that you have to uploaded to the Logstash server.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils filebeat disable

The command disables the filebeat configuration on the system.

utils filebeat disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils filebeat enable

The command enables the filebeat configuration on the system.

utils filebeat disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils filebeat status

The command shows whether the filebeat is running or not and its configuration values.

utils filebeat status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior

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

utils fior

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior disable

This command disables I/O statistics monitoring and deletes all the monitoring data collected on the system. Use this command to disable monitoring and free up disk space that is used by the monitoring data.

utils fior disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior enable

This command enables I/O statistics monitoring.

Note

Use this command before monitoring begins.

utils fior enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior list

This command displays a list of the I/O events for all processes.

utils fior list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior start

This command starts the I/O statistics utility monitoring and data collection. After the monitoring starts, the I/O statistics data is collected in the platform logs. This data can range up to 25 MB per day. Data is rotated after 7 days of data collection. This data is deleted after you disable the I/O statistics utility monitoring.

Note

Enable the I/O statistics utility monitoring begins before the monitoring begins.

utils fior start

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior status

This command provides the status of the I/O statistics monitoring utility.

utils fior status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior stop

This command stops the I/O statistics monitoring and data collection. However, this command does not delete the collected data.

Note

If I/O statistics are no longer needed, disable the cleanup of the monitoring data from the platform logs.

utils fior stop

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fior top

This command displays a list of I/O statistics for I/O bound processes at the time that you run this command.

utils fior top

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils fips

Caution

FIPS mode is only supported on releases that have been through FIPS compliance. Be warned that FIPS mode should be disabled before you upgrade to a non-FIPS compliance version of Cisco Unified Communications Manager.

For information about which releases are FIPS compliant and to view their certifications, see the FIPS 140 document at Click Here .

This command enables, disables, or displays the status of FIPS 140-2 mode. FIPS 140-2 mode is disabled by default; only an administrator can enable FIPS.

utils fips { enable | disable | status }

Syntax Description

Parameters

Description

enable

Activates FIPS 140-2 mode.

disable

Deactivates FIPS 140-2 mode.

status

Displays the status of FIPS 140-2 mode.

Command Modes

Administrator (admin:)

Usage Guidelines

Before enabling FIPS mode, we recommend that you perform a system backup. If FIPS checks fail at start-up, the system halts and requires a recovery CD to be restored.

Consider the following information before you enable FIPS 140-2 mode:

- When you switch from non-FIPS to FIPS mode, the MD5 and DES protocols will not be functional.

- After FIPS mode is enabled on a server, please wait until the server reboots and the phones re-register successfully before enabling FIPS on the next server.

- In FIPS mode, the IM and Presence service uses Red Hat Openswan (FIPS validated) in place of Racoon (non-FIPS validated). If the security policies in Racoon contain functions that are not FIPS approved, the CLI command asks you to redefine the security policies with FIPS approved functions and abort.

Note

Certificates and SSH key are regenerated automatically, in accordance with FIPS requirements.

Consider the following information before you disable FIPS 140-2 mode: In multiple server clusters, each server must be disabled separately; FIPS mode is not disabled cluster-wide but on a per server basis.

Consider the following information after you enable FIPS 140-2 mode: If you have a single server cluster and chose to apply "Prepare Cluster for Rolback to pre 8.0" enterprise parameter before enabling FIPS mode, disable this parameter after making sure that all the phones registered successfully with the server.

Consider the following information before you enable or disable FIPS 140-2 mode for IM and Presence Service: After you enable or disable FIPS 140-2 mode for IM and Presence Service, the Tomcat certificate is regenerated and the node reboots. The Intercluster Sync Agent syncs the new Tomcat certificate across the cluster; this can take up to 30 minutes. Until the new Tomcat certificate is synced across the cluster, an IM and Presence Servicee subscriber node cannot access information from the IM and Presence Service database publisher node. For example, a user who is logged into the Cisco Unified Serviceability GUI on a subscriber node will not be able to view services on theIM and Presence Service database publisher node. Users will see the following error message until the sync is complete: Connection to server cannot be established (certificate exception)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils firewall ipv4 debug

This command turns IPv4 firewall debugging on or off. If you do not enter a time parameter, this command turns on debugging for 5 minutes.

utils firewall ipv4 debug { off | | [time] }

Syntax Description

Parameters

Description

off

Turns off the IPv4 firewall debugging. If you do not enter the time parameter, this command disables the firewall for 5 minutes.

time

(Optional) Sets the duration for which the firewall debugging is to be enabled in the following formats:

- Minutes: 0–1440m

- Hours: 0–23h

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils firewall ipv4

This commands enables and disables IPv4 firewall.

utils firewall ipv4 { enable | disable | [time] }

Syntax Description

Parameters

Description

enable

Turns on the IPv4 firewall.

disable

Turns off the IPv4 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes.

time

(Optional) Sets the duration for which the firewall is to be disabled in the following formats:

- Minutes: 0–1440m

- Hours: 0–23h

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils firewall ipv4 list

This commands displays the current configuration of the IPv4 firewall.

utils firewall ipv4 list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils firewall ipv4 status

This command displays the current status of the IPv4 firewall.

utils firewall ipv4 status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils firewall ipv6 debug

This command turns IPv6 firewall debugging on for the configured time period. The default value of time period is 5 minutes.

utils ipv6 firewall debug { off | | [time] }

Syntax Description

Parameters

Description

off

(Optional) Turns off the IPv6 firewall debugging. If you do not enter the time parameter, this command disables the firewall as per the default time period value.

time

(Optional) Sets the duration for which the firewall debugging is to be enabled in the following formats:

- Minutes: 0–1440m

- Hours: 0–23h

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, and Cisco Unity Connection.

utils firewall ipv6

This commands enables and disables IPv6 firewall.

utils firewall ipv6 { enable | disable | [time] }

Syntax Description

Parameters

Description

enable

Turns on the IPv6 firewall.

disable

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

time

(Optional) Sets the duration for which the firewall is to be disabled in the following formats:

- Minutes: 0–1440m

- Hours: 0–23h

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

Command Modes

Administrator (admin:)

Usage Guidelines

You can use this command to enable or disable firewall tables. If you are testing the Unified Communications Manager for compliance with the USGv6 Profile, you must disable the IPv6 firewall tables for a duration of 23 hours before you begin the test.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection.

utils firewall ipv6 list

This commands displays the current configuration of the IPv6 firewall.

utils firewall ipv6 list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection.

utils firewall ipv6 status

This command displays the current status of the IPv6 firewall.

utils firewall ipv6 status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection.

utils ha failover

This command initiates a manual failover for a specified node, where the Cisco Server Recovery Manager stops the critical services on the failed node and moves all users to the backup node.

For IM and Presence nodes, the backup node must be another IM and Presence server. Two servers must be assigned to the same presence redundancy group before you specify the backup server. The back-up server you specify is the other server that is assigned to the presence redundancy group.

utils ha failover { node name }

Syntax Description

Parameters

Description

node name

Specifies the node on which to perform the manual failover.

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager and IM and Presence service on Cisco Unified Communications Manager

Failover Example

admin: ha failover shorty-cups
Initiate Manual Failover for Node > shorty-cups
Request SUCCESSFUL.
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Taking Over Reason: On Admin Request
Node 2 Name : shorty-cups State: Failover Reason: On Admin Request

utils ha fallback

This command initiates a manual fallback for a specified node, where the Cisco Server Recovery Manager restarts the critical services on the active node and moves users back to the active node.

utils ha fallback node name

Syntax Description

Parameters

Description

node name

Specifies the node on which to perform a manual fallback.

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager and IM and Presence service on Cisco Unified Communications Manager

Fallback Example

admin: ha fallback shorty-cups
Initiate Manual fallback for Node >shorty-cups<
Request SUCCESSFUL.
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Falling Back Reason: On Admin Request
Node 2 Name : shorty-cups State: Taking Back Reason: On Admin Request

utils ha recover

This command initiates a manual recovery of the presence redundancy group (when nodes are in a Failed state), where IM and Presence restarts the Cisco Server Recovery Manager service in that presence redundancy group.

utils ha recover presence redundancy group name

Syntax Description

Parameters

Description

presence redundancy group name

Specifies the presence redundancy group on which to monitor HA status. If no presence redundancy group name is provided, all cluster information is provided.

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager and IM and Presence service on Cisco Unified Communications Manager

Recover Example

admin: ha recover Defaultcluster
Stopping services... Stopped
Starting services... Started
admin:

utils ha status

This command displays the HA status for a specified presence redundancy group.

utils ha status presence redundancy group name

Syntax Description

Parameters

Description

presence redundancy group name

Specifies the presence redundancy group for which to monitor HA status. If no presence redundancy group name is provided, all cluster information is displayed.

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager and IM and Presence service on Cisco Unified Communications Manager

Status Example with HA Not Enabled

admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Unknown Reason: High Availability Not Enabled
Node 2 Name : shorty-cups State: Unknown Reason: High Availability Not Enabled

Status Example with HA Enabled

admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Normal
Node 2 Name : shorty-cups State: Normal

Status Example with a Critical Service Down

admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Failed Over with Critical Services not Running Reason:
Critical Service Down
Node 2 Name : shorty-cups State: Running in Backup Mode Reason: Critical Service Down

Status Example Failed

admin: ha status
Subcluster Name: DefaultCluster
Node 1 Name : kal-cup1 State: Failed Reason: Critical Service Down
Node 2 Name : shorty-cups State: Failed Reason: Critical Service Down

utils ils showpeerinfo

This command returns the peer info vector for either a single cluster in an ILS network, or for all the clusters in an ILS network.

utils ils showpeerinfo clustername

Syntax Description

Parameters

Description

clustername

Specifies the fully qualified domain name of the publisher node for a Cisco Unified Communications Manager cluster in an ILS network.

Command Modes

Administrator (admin:)

Usage Guidelines

The peer info vector contains information about a cluster in an ILS network. The available information includes clustername, cluster ID and IP addresses for the cluster nodes. If you want information about a specific cluster in an ILS network, enter the clustername parameter. If you want information on all the clusters in the network, leave the clustername parameter empty

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager

utils import config

This command takes data from the platformConfig.xml file on the virtual floppy drive and modifies the system to match the configuration file. The system reboots after the command successfully completes.

utils import config

Command Modes

Administrator (admin:)

Usage Guidelines

This command can be executed on any VMware deployment.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

- Execute utils import config in Vmware Deployment

Execute utils import config in Vmware Deployment

Procedure

utils iostat

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

utils iostat { interval | iterations | filename }

Syntax Description

Parameters

Description

interval

Sets the seconds between two iostat readings. You must set this value if you are using the iteration parameter

iterations

Sets the number of iostat iterations. You must set this value if you are using the interval parameter.

filename

Redirects the output to a file.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils iothrottle

This command allows you to manage and monitor IO throttling on the server.

utils iothrottle { enable | disable | status }

Syntax Description

Parameters

Description

Enable

Enables I/0 throttling enhancements which lowers the impact of upgrades on an active system.

Disable

Disables I/0 throttling enhancements.

Status

Displays the status of I/0 throttling enhancements.

Command Modes

Administrator (admin:)

Usage Guidelines

Disabling I/0 throttling enhancements can adversely affect the system during upgrades.

Requirements

Command privilege level: 1 for Enable and Disable, 0 for Status

utils itl reset

This command is used when endpoints are unable to validate their configuration files.

utils itl reset { localkey | remotekey }

Syntax Description

localkey

Generates a new ITL file by taking the existing ITL file on the publisher. The command replaces the signature of that ITL file and signs the new ITL file with the ITL recovery key.

remotekey

Generates a new ITL file after importing the PKCS 12 bag that contains the recovery certificate key pair from the remote location. It then signs the newly generated ITL file with the recovery private key.

remotekey has the following parameters:

- IP address or hostname

- User ID

- ITLRecovery.p12

Command Modes

Administrator (admin:)

Usage Guidelines

Note

You must run this command on the Unified Communications Manager publisher node.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager

Example

admin:utils itl reset

Name is None

Generating the reset ITL file.....

The reset ITL file was generated successfully

Locating active Tftp servers in the cluster.....

Following is the list of Active tftp servers in the cluster

====================

se032c-94-42

=====================

Number of Active TFTP servers in the cluster : 1

Transferring new reset ITL file to the TFTP server nodes in the cluster.........

Successfully transferred reset ITL to node se032c-94-42

utils ldap config

This command configures the system LDAP authentication.

utils ldap config { fqdn | ipaddr }

Syntax Description

Parameters

Description

fqdn

Configures the system to use an FQDN for LDAP authentication.

ipaddr

Configures the system to use an IP address for LDAP authentication

Command Modes

Administrator (admin:)

Usage Guidelines

- utils ldap config fqdn—This command is preferred for LDAP authentication, however, you can only use this command if DNS is configured on the system; if the system is not configured to use DNS, use utils ldap config ipaddr.

- utils ldap config ipaddr—This command is not preferred and should only be used if the system is not, or can not be, configured to use DNS; if the system is configured to use DNS, use utils ldap config fqdn.

Requirements

Command privilege level: 1

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

- utils ldap config status

utils ldap config status

This command displays the utils ldap configuration status.

utils ldap config status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

utils network arp delete

This command deletes an entry in the Address Resolution Protocol table.

utils network arp delete host

Syntax Description

Parameters

Description

host

(Optional) Represents the host name or IP address of the host to delete from the table.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Delete Example

admin:utils network arp delete myhost

utils network arp set

This command sets an entry in the Address Resolution Protocol table.

utils network arp set { host } { addr }

Syntax Description

Parameters

Description

host

Represents the host name or IP address of the host to add to the table.

addr

Represents the hardware address (MAC) of the host to be added in the format: XX:XX:XX:XX:XX:XX

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

Set Example

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

utils network arp list

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

utils network arp list host hostname [options]

Syntax Description

Parameters

Description

host

hostname

options

(Optional) page, numeric

- Page: Pauses to display the output one page at a time.

- Numeric: Shows hosts as dotted IP addresses.

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

List example

admin:admin: utils network arp listAddress 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

utils network capture

This command captures IP packets on the specified Ethernet interface.

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

Syntax Description

Parameters

Description

eth0

Specifies Ethernet interface 0.

page

(Optional) 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

(Optional) Displays hosts as dotted IP addresses.

file fname

(Optional) Outputs the information to a file.

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

countnum

(Optional) 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.

sizebytes

(Optional) 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

(Optional) Specifies the source address of the packet as a host name or IPV4 address.

destaddr

(Optional) Specifies the destination address of the packet as a host name or IPV4 address.

portnum

(Optional) Specifies the port number of the packet, either source or destination.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils network capture-rotate

This command captures IP packets beyond the 100,000 packet limit of utils network capture.

utils network capture-rotate { file | fname } [ size | bytes ] [ sizePerFile | megabytes ] { maxFiles | | num } [ src | addr ] [ dest | addr ] [ port | num ] [ host protocol | addr ]

Syntax Description

Parameters

Description

file fname

Outputs the information to a file.

Note:
The file will be saved in platform/cli/fname. fname should not contain the "." character.

sizebytes

The number of bytes of the packet to capture. Valid values include any number up to 65535 or ALL. The default is ALL.

sizePerFile megabytes

The sizePerFile sets the value for the size of the log files. (Unit is millions of bytes.) The default value of sizePerFile is 25 MB.

maxFiles num

the maxFiles indicates the maximum number of log files to be created. The default value of maxFiles is 10.

src addr

(Optional) Specifies the source address of the packet as a hostname or IPV4 address.

dest addr

(Optional) Specifies the destination address of the packet as a host name or IPV4 address.

port num

(Optional) Specifies the port number of the packet, either source or destination.

host protocol addr

(Optional) Limits capture to traffic to and from a specific host. Options for protocol are IP, arp, rarp, all, and addr must be in IPv4 or hostname format. If host is used, do not provide src or dest.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils network connectivity

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

utils network connectivity [ reset ] [hostname/ip address]

Syntax Description

Parameters

Description

connectivity

This command verifies the node network connection to the first node in the cluster.

reset

(Optional) Clears previous return codes.

hostname/ip address

(Optional) Hostname or ip address of cluster node.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils network host

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

utils network host name [ server | serv ] [page] [detail] [srv]

Syntax Description

Parameters

Description

name

Represents the host name or IP address that you want to resolve.

serv

(Optional) Specifies an alternate domain name server.

[page]

(Optional) Displays the output one screen at a time.

[detail]

(Optional) Displays a detailed listing.

[srv]

(Optional) Displays DNS SRV records.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils network ipv6 host

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

utils network ipv6 host { host_name | ipv6_address }

Syntax Description

Parameters

Description

host_name

Specifies the name of the server.

ipv6_address

Specifies the IPv6 address of the server.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection.

utils network ipv6 traceroute

This command to traces an IPv6 address or hostname.

utils network ipv6 traceroute [ ipv6-address | hostname ]

Syntax Description

Parameters

Description

ipv6-address

Specifies IPv6 address that you want to trace.

hostname

Specifies the host name that you want to trace.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection.

utils network ipv6 ping

This command allows you to ping an IPv6 address or hostname.

utils network ipv6 ping destination [count]

Syntax Description

Parameters

Description

destination

Specifies a valid IPv6 address or host name that you want to ping.

count

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection.

utils network ping

This command allows you to ping another server.

utils network ping destination [count] [size]

Syntax Description

Parameters

Description

destination

Represents the ip address or host name of the server that you want to ping.

count

Specifies the number of times to ping the external server. The default count is 4.

size

Specifies the size of ping packets in bytes. The default value is 56.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils network traceroute

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

utils network traceroute [destination]

Syntax Description

Parameters

Description

destination

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection.

utils network name-service {hosts|services} cache invalidate

This command clears the name service cache.

utils network name-service {hosts \ services} [cache invalidate]

Syntax Description

Parameters

Description

Hosts

Host services cache

Services

Services service cache

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Consider the following example for flushing/clearing the cache:

admin:utils network name-service hosts cache invalidate
admin:
Successful

utils ntp server add

The command adds a maximum of five specified NTP servers.

utils ntp server add s1 [ s1 | s2 | s3 | s4 | s5 ] [norestart]

Syntax Description

Parameters

Description

s1...

Specifies the NTP servers.

norestart

Causes the NTP service to not restart after you add the servers.

Command Modes

Administrator (admin:)

Usage Guidelines

If you use norestart, an explicit restart of the NTP service is required for the changes to take effect.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager

Example: Attempting to Add Servers with Incorrect Command Line Parameters

admin: admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8
Incorrect number of parameters entered for add
usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]

admin: utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8
Incorrect number of parameters entered for add
usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]

admin: utils ntp server add clock1.cisco.com clock2.cisco.com
clock1.cisco.com :  added successfully.
clock2.cisco.com :  added successfully.
Restarting NTP on the server.

admin: utils ntp server add clock1.cisco.com clock2.cisco.com
clock1.cisco.com : [The host has already been added as an NTP server.]
clock2.cisco.com : [The host has already been added as an NTP server.]

admin: utils ntp server add bglr-ccm26
bglr-ccm26 : [This server cannot be added as an NTP server.]

admin: utils ntp server add clock3.cisco.com
clock3.cisco.com : [ Inaccessible NTP server. Not added. ]

admin: utils ntp server add ntp01-syd.cisco.com ntp02-syd.cisco.com clock.cisco.com norestart
ntp01-syd.cisco.com :  added successfully.
ntp02-syd.cisco.com :  added successfully.
clock.cisco.com :  added successfully.
The NTP service will need to be restarted for the changes to take effect.

admin:utils ntp server add clock3.cisco.com
The maximum permissible limit of 5 NTP servers is already configured.

utils ntp server delete

This command deletes NTP servers that are configured.

utils ntp server delete

Command Modes

Administrator (admin:)

Usage Guidelines

This command allows you to delete a configured NTP server or all of them. When you choose the server to delete, you are prompted to indicate if you want to restart the NTP service. If you choose no, the NTP service does not get restarted after the server is deleted.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager

Example: Deleting Servers with Incorrect Command Line Parameters

admin: utils ntp server delete clock1.cisco.com clock2.cisco.com
Incorrect number of optional parameters entered for delete
usage: utils ntp server delete

admin: utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit

Choice: 1

Restart NTP (y/n): y

clock1.cisco.com will be deleted from the list of configured NTP servers.
Continue (y/n)?y

clock1.cisco.com :  deleted successfully.
Restarting NTP on the server.

admin: utils ntp server delete
1: clock1.cisco.com
2: clock2.cisco.com
3: ntp01-syd.cisco.com
4: ntp02-syd.cisco.com
5: clock.cisco.com
a: all
q: quit

Choice: a

Restart NTP (y/n): n

This will result in all the configured NTP servers being deleted.
Continue (y/n)?y

clock1.cisco.com :  deleted successfully.
clock2.cisco.com :  deleted successfully.
ntp01-syd.cisco.com :  deleted successfully.
ntp02-syd.cisco.com :  deleted successfully.
clock.cisco.com :  deleted successfully.
The NTP service will need to be restarted for the changes to take effect.

admin: utils ntp server delete
There are no NTP servers configured to delete.

utils ntp config

This command displays the current configuration of the NTP client and server.

Note

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

utils ntp config

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence server on Cisco Unified Communications Manager, Cisco Unity Connection

utils ntp restart

This command restarts the NTP service.

utils ntp restart

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils ntp server list

This command lists all NTP servers.

utils ntp server list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: IM and Presence server on Cisco Unified Communications Manager

utils ntp start

This command starts the NTP service if it is not already running.

Note

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

utils ntp start

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence server on Cisco Unified Communications Manager, and Cisco Unity Connection

utils ntp status

This command displays the current status of NTP.

utils ntp status

Command Modes

Administrator (admin:)

Requirements

Command privilege level:

Allowed during upgrade:

Applies to: IM and Presence service on Cisco Unified Communications Manager.

utils os kerneldump

This command configures kerneldump to provide a kernel crash dumping mechanism. The kernel captures the dump to the local disk, in case of a kernel crash.

Note

The netdump commands have been removed from release 8.6(1) and have been replaced with the kerneldump commands.

utils os kerneldump { enable | disable }

Command Modes

Administrator (admin:)

Usage Guidelines

If a kernel crash occurs, the capture kernel dumps the core on the local disk of the server. The primary kernel reserves 128MB of physical memory that the capture kernel uses to boot. The kerneldump uses the kexec command to boot into a capture kernel whenever the kernel crashes.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

Example

admin: utils os kerneldump enable
***************WARNING*******************
Enabling kerneldump requires system reboot
Would you like to boot the machine (y/n):y
kerneldump enable operation succeeded
System going for a reboot

utils os kerneldump ssh

This command enables, disables, or displays the status of an external SSH server.

utils os kerneldump ssh { enable | disable | status }

Syntax Description

Parameters

Description

enable

Configures an external SSH server as a kerneldump server to kernel dumps.

disable

Removes support of the external SSH server that is configured to collect kernel dumps.

status

Indicates whether an external SSH server is configured or not, to collect kernel dumps.

Command Modes

Administrator (admin:)

Usage Guidelines

If external SSH server has the kerneldump service enabled and a kernel crash occurs, the capture kernel dumps the core on the external server that is configured to collect the dump.
Enabling and disabling kerneldump require a system reboot for the changes to come into effect.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

Example

admin: utils os kerneldump ssh disable 10.77.31.60
Disabling kerneldump requires system reboot
Would you like to continue (y/n): y
kerneldump disable operation succeeded
System going for a reboot

utils os kerneldump status

This command provides the status of the kdump service.

utils os kerneldump status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils os secure

This command is used to specify the level of security provided by selinux.

utils os secure { enforce | permissive | status }

Syntax Description

Parameters

Description

enforce

permissive

status

Command Modes

Administrator (admin:)

Usage Guidelines

Note that selinux does not handle rate limiting. Rate limiting is handled by ipprefs and ip tables.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: IM and Presence service on Cisco Unified Communications Manager

utils PlatformWebAccess disable

Use this command to restrict the user sign-in to Cisco OS Administration and Disaster Recovery System applications when SSO is enabled.

utils PlatformWebAccess disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils PlatformWebAccess enable

Use this command to enable the user sign-in to Cisco OS Administration and Disaster Recovery System applications.

utils PlatformWebAccess enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils PlatformWebAccess status

Use this command to display the status of the web access of the system—whether the platform web access is enabled or disabled for Cisco OS Administration and Disaster Recovery System applications.

utils PlatformWebAccess status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils processCoreDumps disable

This command disables the process core dumps.

utils processCoreDumps disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils processCoreDumps enable

This command enables the process core dumps.

utils processCoreDumps enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils processCoreDumps status

This command provides the status of the kdump service.

utils processCoreDumps status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils remote_account create

This command creates a remote account.

utils remote_account create

Command Modes

Administrator (admin:)

Usage Guidelines

A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils remote_account disable

This command allows you to disable a remote account.

utils remote_account disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils remote_account enable

This command allows you to enable a remote account.

utils remote_account enable

Command Modes

Administrator (admin:)

Usage Guidelines

You can have only one remote account that is enabled at a time.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils remote_account status

This command allows you to check the status of a remote account.

utils remote_account status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils remotesyslog set protocol tcp

This command configures the protocol for communication with remote syslog server as TCP on the system. Restart the node for changes to take effect.

utils remotesyslog set protocol tcp

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils remotesyslog set protocol udp

This command configures the protocol for communication with remote syslog server as UDP on the system. Restart the node for changes to take effect.

utils remotesyslog set protocol udp

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils remotesyslog show protocol

This command shows whether the protocol for communication with remote syslog server is TCP or UDP on the system.

utils remotesyslog show protocol

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils reset_application_ui_administrator_name

This command resets the application user interface administrator name.

utils reset_application_ui_administrator_name

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils reset_application_ui_administrator_password

This command resets the application user interface administrator password.

utils reset_application_ui_administrator_password

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils restore_application_ui_administrator_account

This command restores the application user interface administrator account.

utils restore_application_ui_administrator_account

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils scheduled-task disable

This command disables the scheduled-task.

utils scheduled-task disable scheduled-task

Syntax Description

Parameters

Description

scheduled-task

Enter the name of the task that you need to disable.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils scheduled-task enable

This command enables the scheduled-task.

utils scheduled-task enable scheduled-task

Syntax Description

Parameters

Description

scheduled-task

Enter the name of the task that you need to enable.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils scheduled-task list

This command lists all the scheduled tasks.

utils scheduled-task list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils set urlpattern disable

This command disables the URL pattern and modifies the zzz20_product_profile.sh file. After the URL pattern is disabled, this command appends the following line:

export TOMCAT_EXCLUDE_URLPATTERNS="/ucmuser"

utils set urlpattern disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils set urlpattern enable

This command enables the URL pattern and modifies the zzz20_product_profile.sh file. After the URL pattern is enabled, this command appends the following line:

export TOMCAT_EXCLUDE_URLPATTERNS=""

utils set urlpattern enable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils service

This command activates, deactivates, starts, stops, or restarts a service.

utils service { activate | deactivate | start | stop | restart } service_name

Syntax Description

Parameters

Description

service_name

Represents the name of the service you want to affect, for example:

- System NTP

- System SSH

- Service Manager

- A Cisco DB

- Cisco Database Layer Monitor

- Cisco Unified Serviceability

This list is not exhaustive. For a full list of services for the node enter the command: utils service list

Note:
If you want to restart the Cisco Tomcat service for standalone Cisco Prime License Manager, execute the following command or reboot the server: utils service restart Cisco Prime LM Server.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils service list

This command retrieves a list of all services.

utils service list [page]

Syntax Description

Parameters

Description

[page]

Displays the output one page at a time.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: IM and Presence service on Cisco Unified Communications Manager

utils service auto-restart

This command starts or stops a specified service.

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

Syntax Description

Parameters

Description

enable

Starts auto-restart.

disable

Stops auto-restart.

show

Shows the status of a service.

service-name

Represents the name of the service that you want to start, stop, or show:

- System NTP

- System SSH

- Service Manager

- A Cisco DB

- Cisco Tomcat

- Cisco Database Layer Monitor

- Cisco Unified Serviceability

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils service start

This command starts a service.

utils service start

Syntax Description

Parameters

Description

service

Enter the name of a service, which can consist of multiple words.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service onCisco Unified Communications Manager, and Cisco Unity Connection

utils service stop

This command stops a service.

utils service stop

Syntax Description

Parameters

Description

service

Enter the name of a service, which can consist of multiple words.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service onCisco Unified Communications Manager, and Cisco Unity Connection

utils snmp config 1/2c community-string

This interactive command adds, deletes, lists or updates a community string.

utils snmp config 1/2c community-string { add | | delete | | list | | update }

Syntax Description

Parameters

Description

add

Adds a new community string.

delete

Deletes a community string.

list

Lists all community strings.

update

Updates a community string.

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of “SNMP Master Agent” by using utils service list. If service is down, start it by using utils service start SNMP Master Agent

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp config 1/2c inform

This interactive command adds, deletes, lists or updates inform notification destinations.

utils snmp config 1/2c inform { add | | delete | | list | | update }

Syntax Description

Parameters

Description

add

Adds a notification destination.

delete

Deletes a notification destination.

list

Lists all notification destinations.

update

Updates a notification destination.

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp config 1/2c trap

This interactive command affects trap notifications.

utils snmp config 1/2c trap { add | delete | list | update }

Syntax Description

Parameters

Description

add

Adds a new v1/2c trap notification destination associated with a configured v1/2c community string.

delete

Deletes the configuration information for an existing v1/2c trap notification destination.

list

Lists the v1/2c trap notifications currently configured.

update

Updates configuration information for an existing v1/2c trap notification destination.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

utils snmp config 3 inform

This interactive command affects the v3 inform notification.

utils snmp config 3 inform { add | | delete | | list | | update }

Syntax Description

Parameters

Description

add

Adds a new v3 inform notification destination associated with a configured v3 username.

delete

Deletes the configuration information for an existing v3 inform notification destination.

list

Lists the v3 inform notifications currently configured.

update

Updates configuration information for an existing v3 inform notification destination.

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of “SNMP Master Agent” by using utils service list. If service is down, start it by using utils service start SNMP Master Agent

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp config mib2

This interactive command affects the Mib2 configuration information.

utils snmp config mib2 { add | | delete | | list | | update }

Syntax Description

Parameters

Description

add

Adds the Mib2 configuration information.

delete

Deletes the Mib2 configuration information.

list

Lists the Mib2 configuration information.

update

Updates the Mib2 configuration information.

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp config 3 trap

This interactive command affects trap notifications.

utils snmp config 3 trap { add | | delete | | list | | update }

Syntax Description

Parameters

Description

add

Adds a new v3 trap notification destination associated with a configured v3 username.

delete

Deletes the configuration information for an existing v 3 trap notification destination.

list

Lists the v3 trap notifications currently configured.

update

Updates configuration information for an existing v3 trap notification destination.

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp config 3 user

This interactive command affects v3 user configuration.

utils snmp config 3 user { add | | delete | | list | | update }

Syntax Description

Parameters

Description

add

Adds a new v3 user with the v3 authentication and privacy passwords.

delete

Deletes the configuration information for an existing v3 user.

list

Lists the v3 users currently configured.

update

Updates configuration information for an existing v3 user.

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp get

This interactive command gets the SNMP data using the specified version for the specified MIB OID.

utils snmp get version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to get.

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Usage Guidelines

If you run the command on a specific OID (leaf) in the MIB, you get the value of the MIB. For example to get the system uptime: iso.3.6.1.2.1.25.1.1.0 = Timeticks: (19836825) 2 days, 7:06:08.25

If you provide the IP address  of a remote host, the command gets executed on the remote host.

The IP address  is required. You cannot use a domain name.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp get 1

This command gets the SNMP data using version 1 for the specified MIB OID.

utils snmp get 1 version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to get.

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp get 2c

This command gets the SNMP data using version 2c for the specified MIB OID.

utils snmp get 2c version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to get.

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp get 3

This command gets the SNMP data for the specified MIB OID.

utils snmp get 3 version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to get.

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp hardware-agents

This command affects the SNMP agents on the server.

utils snmp hardware-agents { status | | start | | stop | | restart }

Syntax Description

Parameters

Description

status

Displays the status of the SNMP agents provided by the vendor of the hardware.

Note:
Only agents that provide status get displayed by this command. Not all hardware agents provide status.

stop

Stops all SNMP agents provided by the hardware vendor.

restart

Restarts all of the SNMP agents provided by the vendor of the hardware.

start

Starts all of the SNMP agents provided by the vendor of the hardware.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp test

This command sends sample alarms to local syslog and remote syslog.

utils snmp test

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

admin: admin:utils snmp test

Service Manager is running

Test SNMP Trap starts with Local Host Name, Specify a Remote Sever Name to test Remote Syslog

TestAlarmInformational sent [Returncode=0]

TestAlarmEmergency sent [Returncode=0]

TestAlarmAlert sent [returncode=0]

TestAlarmCritical sent [Returncode=0]

TestAlarmDebug sent [Returncode=0]

TestAlarmNotice sent [Returncode=0]

TestAlarmWarning sent [Returncode=0]

TestAlarmError sent [Returncode=0]

TestAlarmWindows sent [Returncode=0]

Message from syslogd@ipcbu-plat44 at Sat Jul 17 03:56:11 2010 ...

ipcbu-plat44 local7 0 : 1: ipcbu-plat44.blr.eng: Jul 16 2010 22:26:11.53 UTC :

%UC_-0-TestAlarmEmergency: %[AppID=Cisco CallManager][ClusterID=][NodeID=ipcbu-plat44]:

Testing EMERGENCY_ALARM

utils snmp walk

This interactive command command walks through the SNMP MIB using the specified version, starting with the specified OID.

utils snmp walk version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to walk

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

Example

If you run snmp walk on a leaf in the MIB, you basically get what you want with utils snmp get ... command. Here in the example we are getting the system's uptime.

iso.3.6.1.2.1.1.1.0 = STRING: "Hardware:7825H, 1 Intel(R) Pentium(R) 4 CPU 3.40GHz, 2048 MB Memory: Software:UCOS 2.0.1.0-62"

iso.3.6.1.2.1.1.2.0 = OID: iso.3.6.1.4.1.9.1.583

iso.3.6.1.2.1.1.3.0 = Timeticks: (15878339) 1 day, 20:06:23.39

iso.3.6.1.2.1.1.4.0 = ""

iso.3.6.1.2.1.1.5.0 = STRING: "bldr-ccm34.cisco.com"

iso.3.6.1.2.1.1.6.0 = ""

iso.3.6.1.2.1.1.7.0 = INTEGER: 72

iso.3.6.1.2.1.2.1.0 = INTEGER: 3

iso.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1

iso.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2

iso.3.6.1.2.1.2.2.1.1.3 = INTEGER: 3

iso.3.6.1.2.1.2.2.1.2.1 = STRING: "lo"

Press <enter> for 1 line, <space> for one page, or <q> to quit

utils snmp walk 1

This interactive command walks through the SNMP MIB using SNMP version 1 starting with the specified OID

utils snmp walk 1 version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to walk

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp walk 2c

This interactive command walks through the SNMP MIB using SNMP version 2c starting with the specified OID.

utils snmp walk 2c version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

ip-address

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

object

Specifies the SNMP Object ID (OID) to walk

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils snmp walk 3

This interactive command walks through the SNMP MIB starting with the specified OID.

utils snmp walk 3 version

Syntax Description

Parameters

Description

version

Specifies the SNMP version. Possible values include 1, 2c or 3.

community

Specifies the SNMP community string.

object

Specifies the SNMP Object ID (OID) to walk

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.

file

Specifies a file in which to save the command output.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence Service on Cisco Unified Communications Manager, Cisco Unity Connection

utils soap realtimeservice test

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

utils soap realtimeservice test [remote-ip] remote-httpsremote https-password

Syntax Description

Parameters

Description

remote-ip

Specifies the IP address of the server under test.

remote-https-user

Specifies a username with access to the SOAP API.

remote-https-password

Specifies the password for the account with SOAP API access.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on IM and Presence, Cisco Unity Connection

utils sso

This command provides information about SAML SSO authentication.

utils sso { enable | disable | status }

Syntax Description

Parameters

Description

enable

Provides the location in Cisco Unified CM Administration where you can enable SAML SSO.

disable

Disables SAML SSO based authentication.

status

Provides the status of SAML SSO.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

Example

Admin: utils sso enable
*** W A R N I N G ***
SSO cannot be enabled using CLI command
=======================================================
To enable Cluster wide SAML SSO please access
Cisco Unified CM Administration Page->System->SAML Single Sign On

=======================================================

utils sso recovery-url

This command enables or disables recovery URL for SAML SSO based authentication.

utils sso recovery-url { enable | disable }

Syntax Description

Parameters

Description

enable

Enables recovery URL for SAML SSO based authentication.

disable

Disables recovery URL for SAML SSO based authentication.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, and Cisco Unity Connection

utils system restart

This command allows you to restart the system on the same partition.

utils system restart

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils system shutdown

This command allows you to shut down the system.

utils system shutdown

Command Modes

Administrator (admin:)

Usage Guidelines

This command has a five-minute timeout. If the system does not shut down within five minutes, the command gives you the option of doing a forced shutdown.

Caution

If the server is forced to shutdown and restart from your virtual machine, the file system may become corrupted.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils system switch-version

This command allows you to restart the system on the inactive partition.

utils system switch-version

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils system boot

This command redirects where the system boot output gets sent.

utils system boot { console | serial }

Syntax Description

Parameters

Description

console

Redirects the system boot output to the console.

serial

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager and Cisco Unity Connection

utils system upgrade

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

utils system upgrade { initiate | cancel | status }

Syntax Description

Parameters

Description

cancel

Cancels the active upgrade.

initiate

Starts a new upgrade wizard or assumes control of an existing upgrade wizard. The wizard prompts you for the location of the upgrade file.

status

Displays the status of an upgrade.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

utils update dst

This command updates the daylight saving time (DST) rules for the current year.

utils update dst

Command Modes

Administrator (admin:)

Usage Guidelines

This command takes a backup of the existing DST rules file and creates a new DST rules file for the current year.

Caution

Restart the phones after you execute the command. Not restarting the phones results in wrong DST start and stop dates.

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to Unified Communications Manager and IM and Presence service.

utils users validate

This command checks user records across all nodes and clusters in the deployment to identify duplicate or invalid userid or directory URI values.

utils users validate { all | userid | uri }

Syntax Description

Parameters

Description

all

Validate the userid and directory URI values for all users in the nodes and clusters.

userid

Validate the userid value for all users in the nodes and clusters.

uri

Validate the directory URI value for all users in the nodes and clusters.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: IM and Presence Service on Cisco Unified Communications Manager

utils vmtools refresh

This command refreshes the currently installed VMware Tools to the latest version that is prescribed by the ESXi host for that VM.

utils vmtools refresh

Command Modes

Administrator (admin:)

Usage Guidelines

To update the current version of the VMware Tools, select Guest > Install/Upgrade VMWare Tools > Interactive Tools Upgrade.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence Service on Unified Communications Manager, and Cisco Unity Connection.

Example

admin:utils vmtools refresh
VMware Tools match host. Upgrade allowed, though not required.

***   W A R N I N G   ***
Running this command will update your current version of VMware Tools
to the latest version prescribed by the ESXi host on which this VM is
running. The tools install will cause your system to reboot twice.

utils vmtools upgrade

This command updates the currently installed VMware Tools to the latest version prescribed by the ESXi host for that VM.

utils vmtools upgrade

Command Modes

Administrator (admin:)

Requirements

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, and Cisco Unity Connection

utils system boot status

This command shows the location where the system boot messages are to be sent. The location is either console or serial port one.

utils system boot status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unified Communications Manager, IM and Presence service on Cisco Unified Communications Manager, Cisco Unity Connection

Preface

- Purpose

- Audience

- Organization

- Related Documents

Purpose

The Command Line Interface Reference Guide for Cisco Unified Communications Solutions provides information about all the commands supported on the IM and Presence service, Cisco Unified Communications, and Cisco Unity Connection. Every command includes an "Applies to" section identifying applicable products.

Audience

The Command Line Interface Reference Guide for Cisco Unified Communications Solutions provides information to execute specific commands for network administrators responsible for managing and supporting IM and Presence, Cisco Unified Communications Manager, and Cisco Unity Connection.

Organization

The following table shows the organization for this guide:

Organization of Command Line Interface Reference Guide for Cisco Unified Communications Solutions

Chapter

Description

About CLI

Provides information about the CLI and tips to help make the management of the products easier to navigate.

Delete commands

Lists all commands relating to the removal of specific information.

File commands

Lists all commands relating to the management of files and logs.

License commands

Lists all commands relating to licensing.

Run commands

Lists all commands relating to the execution of sql queries, various tests, and tasks.

Set commands

Lists all commands relating to the tasks such as enabling, disabling, importing, and exporting.

Show commands

Lists all commands relating to the display of specified information.

Unset commands

Lists all commands relating to the disabling of specified network and ipsec options.

Utils commands

Lists all commands relating to utilities.

Related Documents

See the Cisco Unified Communications Manager Documentation Guide to learn about the documentation for Cisco Unified Communications Manager and IM and Presence Service.

For the latest IM and Presence Service and Cisco Unified Communications Manager requirements, see the Release Notes for Cisco Unified Communications Manager.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Click Here . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)