Command Line Interface Reference Guide for Cisco Unified

Communications Solutions, Release 12.5(1)SU4

First Published: 2021-02-23

Last Modified: 2023-10-03

Americas Headquarters

Cisco Systems, Inc.

170 West Tasman Drive

San Jose, CA 95134-1706

USA

http://www.cisco.com

Tel: 408 526-4000

800 553-NETS (6387)

Fax: 408 527-0883

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

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.

All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.

Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.

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:

https://www.cisco.com/c/en/us/about/legal/trademarks.html. 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. (1721R)

CONTENTS

Preface xxiii

PREFACE

Purpose xxiii

Audience xxiii

Organization xxiii

Related Topics

set cert bulk sftp, on page 62

set cert bulk export

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

set cert bulk export unit

Syntax Description

DescriptionParameters

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

Represents the unit name.unit

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 1

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert bulk consolidate

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 Topics

set cert bulk sftp, on page 62

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

DescriptionParameters

Represents the unit

name.

unit

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 Topics

set cert bulk sftp, on page 62

set cert bulk sftp

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert bulk import

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 default-ca-list disable

This command disables all or particular default CA certificates from all servers in the cluster.

When you try to execute this command, a warning message appears displaying that this operation disables

all or particular default Cisco CA certificates.

set cert default-ca-list disable {all | common-name}

• Please ensure that you are executing this command from the Unified Communications Manager publisher

node.

• The default CA certificate names can be obtained by executing the show cert default-ca-list command.

Note

Syntax Description

DescriptionParameters

Deletes all the default CA certificates from all servers

in the cluster.

all

Deletes the particular default CA certificate from all

servers in the cluster.

common-name

Command Modes

Administrator (admin:)

Usage Guidelines

Consider the following information after you disable all the default CA certificates.

• Restart the “Cisco Tomcat”, “Cisco CallManager”, “Cisco Tftp”, and “Cisco Certificate Authority Proxy

Function” services.

Consider the following information after you disable the specific default CA certificate.

• Restart the “Cisco CallManager”, “Cisco Tftp”, and “Cisco Certificate Authority Proxy Function” services.

• If you are disabling “VeriSign Class 3 Secure Server CA - G3” certificate, then restarting of only “Cisco

Tomcat” service is sufficient.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert default-ca-list disable

Requirements

Command privilege level: 1

Applies to: Unified Communications Manager

Example

admin:set cert default-ca-list disable all

WARNING: This operation will disable all Cisco CA certificates that have been installed

by default. You can use the "show cert default-ca-list" to view the list of default

Cisco CA certificates.

You must restart the "Cisco Tomcat", "Cisco CallManager", "Cisco Tftp" and

"Cisco Certificate Authority Proxy Function" services after running this command.

This command should be run from the Publisher.

Do you wish to proceed (yes|no)? yes

Successfully disabled the default Cisco CA certificates.

Please wait for a few min to UI to reflect the correct status.

admin:set cert default-ca-list disable common-name

Enter the Common Name of Default CA Certificate : CAP-RTP-001

WARNING: This operation will disable the "CAP-RTP-001" Cisco CA certificate.

You must restart the "Cisco CallManager", "Cisco Certificate Authority Proxy Function" and

"Cisco Tftp" services after running this command. This command should be run from the

Publisher.

Do you wish to proceed (yes|no)? yes

Successfully disabled default "CAP-RTP-001" certificate.

admin:set cert default-ca-list disable common-name

Enter the Common Name of Default CA Certificate : VeriSign Class 3 Secure Server CA - G3

WARNING: This operation will disable the "VeriSign Class 3 Secure Server CA - G3" Cisco CA

certificate. You must restart the "Cisco Tomcat" services after running this command.

This command should be run from the Publisher.

Do you wish to proceed (yes|no)? yes

Successfully disabled default "VeriSign Class 3 Secure Server CA - G3" certificate.

admin:set cert default-ca-list enable common-name

Enter the Common Name of Default CA Certificate : capf

The capf certificate is not in the list of default Cisco CA certificates.

admin:

set cert default-ca-list enable

This command enables all or particular default CA certificates except CAPF-trust on all servers in the cluster.

CAPF-trust certificate enable only on the Unified Communications Manager publisher node not across the

cluster.

When you try to execute this command, a warning message appears displaying that this operation enables all

or particular default Cisco CA certificates as a trusted certificate.

set cert default-ca-list enable {all | common-name}

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert default-ca-list enable

• Please ensure that you are executing this command from the Unified Communications Manger publisher

node.

• The default CA certificate names can be obtained by executing the show cert default-ca-list command.

Note

Syntax Description

DescriptionParameters

Enables all the default CA certificates on all servers

in the cluster.

all

Enables the particular default CA certificate on all

servers in the cluster.

common-name

Command Modes

Administrator (admin:)

Usage Guidelines

Consider the following information after you enable all the default CA certificates.

• Restart the “Cisco Tomcat”, “Cisco CallManager”, “Cisco Tftp”, and “Cisco Certificate Authority Proxy

Function” services.

Consider the following information after you enable the specific default CA certificate.

• Restart the “Cisco CallManager”, “Cisco Tftp”, and “Cisco Certificate Authority Proxy Function” services.

• If you are enabling “VeriSign Class 3 Secure Server CA - G3” certificate, then restarting of only “Cisco

Tomcat” service is sufficient.

Requirements

Command privilege level: 1

Applies to: Unified Communications Manager

Example

admin:set cert default-ca-list enable all

WARNING: This operation will enable all default Cisco CA certificates

as trusted certificates for all nodes in this cluster.

You can use the "show cert default-ca-list" to view the list of default

Cisco CA certificates. You must restart the "Cisco Tomcat", "Cisco CallManager",

"Cisco Tftp" and "Cisco Certificate Authority Proxy Function" services after

running this command. This command should be run from the Publisher.

Do you wish to proceed (yes|no)? yes

Successfully enabled the default Cisco CA certificates.

Please wait for a few minutes for the UI to reflect the correct status.

admin:set cert default-ca-list enable common-name

Enter the Common Name of Default CA Certificate : CAP-RTP-002

WARNING: This operation will install the "CAP-RTP-002" certificate as a trusted certificate

for all nodes in this cluster. You must restart the "Cisco CallManager",

"Cisco Certificate Authority Proxy Function" and "Cisco Tftp" services after running this

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert default-ca-list enable

command. This command should be run from the Publisher.

Do you wish to proceed (yes|no)? yes

Successfully enabled default "CAP-RTP-002" certificate.

admin:set cert default-ca-list enable common-name

Enter the Common Name of Default CA Certificate : VeriSign Class 3 Secure Server CA - G3

WARNING: This operation will install the "VeriSign Class 3 Secure Server CA - G3" certificate

as a trusted certificate for all nodes in this cluster. You must restart the "Cisco Tomcat"

services after running this command. This command should be run from the Publisher.

Do you wish to proceed (yes|no)? yes

Successfully enabled default "VeriSign Class 3 Secure Server CA - G3" certificate.

admin:set cert default-ca-list enable common-name

Enter the Common Name of Default CA Certificate : CAP-RTP-003

The CAP-RTP-003 certificate is not in the list of default Cisco CA certificates.

admin:

set cert delete

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

set cert delete unit name

Syntax Description

DescriptionParameters

Specifies the name of the trust category, as “own” or “trust”.unit

Certificate file name.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]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert delete

Syntax Description

DescriptionParameters

Specifies the certificate type as “own” or “trust”.type

Represents the unit name.name

Represents the name of the CA certificate file name.[caCert]

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

DescriptionParameters

Represents the unit

name.

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert regen

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

DescriptionParameters

Represents the ITLRecovery certificate.ITLRecovery

Command Modes

Administrator (admin:)

Requirements

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

Caution

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

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cert regen ITLRecovery

set cli pagination {on | off}

Syntax Description

DescriptionParameters

Turns pagination

on.

Turns pagination

off.

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

DescriptionParameters

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

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.

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

Note

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cli session timeout

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

DescriptionParameters

Turns on command count.enable

Turns off command

count.

disable

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

DescriptionParameters

Specifies the unit on which the certificate is generated.name

Command Modes

Administrator (admin:)

Requirements

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

and Cisco Unity Connection.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set commandcount

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

DescriptionParameters

Enables the error log on the Jetty

server. Be aware that enable is case

sensitive.

enable

Disables the error log on the Jetty

server. Be aware that disable is case

sensitive.

disable

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

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 .

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cuc jetty stderrlog

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

DescriptionParameters

Enables the standard input and

output log on the Jetty server. Be

aware that enable is case sensitive.

enable

Disables the standard input and

output log on the Jetty server. Be

aware that disable is case sensitive.

disable

Command Modes

Administrator (admin:)

Usage Guidelines

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

server.

Caution

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cuc jetty stdoutlog

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

DescriptionParameters

Enables the request log on the Jetty

server. Be aware that “enable” is

case sensitive.

enable

Disables the request log on the Jetty

server. Be aware that “disable” is

case sensitive.

disable

Command Modes

Administrator (admin:)

Usage Guidelines

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

Caution

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 speechview registration certificate size

This command sets up new certificate bit size for Speech to Text service registration and Voicemail transcription

with Nuance server.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cuc jetty requestlog

set cuc speechview registration certificate size bit_size

Syntax Description

DescriptionParameters

Specifies the bit_size of certificate.

Its allowed values are 1k, 2k or 4k.

bit_size

Command Modes

Administrator (admin:)

Usage Guidelines

To set the desired certificate bit size, use the set cuc speechview registration certificate size (Cisco Unity

Connection Only) command. The CLI must be executed on the publisher. It will restart the Connection

SpeechView Processor service.

Requirements

Command privilege level: 4

set cuc srsv timeout

This command sets the value for SRSV session timeout.

set cuc srsv timeout timeout_value

Syntax Description

DescriptionParameters

Sets the time for session logout.timeout_value

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

DescriptionParameters

Enables Connection traces.enable

Disables Connection traces.disable

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set cuc srsv timeout

DescriptionParameters

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.

level

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 Topics

show cuc trace levels, on page 160

set date

This command changes the time and date on the server.

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

Syntax Description

DescriptionParameters

Represents the time format (24 hours format).HH:mm:ss

Represents the date format.

Date format MM/DD/YYYY is

also accepted.

Note

MM/DD/YY

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set date

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}{allport_tag}

Syntax Description

DescriptionParameters

Disables all DSCP port tags.all

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set dscp defaults

DescriptionParameters

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.

port_tag

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

DescriptionParameters

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.

port_tag

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.

value

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set dscp marking

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 {ALLgroup}

Syntax Description

DescriptionParameters

Enables all ipsec policy groups.ALL

Specifies the name of a particular ipsec policy group to

enable.

group

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 { policy_group policy_name }

Syntax Description

DescriptionParameters

Specifies the name of a particular

ipsec policy group to enable.

policy_group

Specifies the name of a particular

ipsec policy to enable.

policy_name

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set ipsec policy_group

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager and Cisco Unity Connection.

set key regen authz encryption

Run this command on the Unified Communications Manager publisher node to regenerate the symmetric

encryption key that encrypts OAuth access tokens and refresh tokens that are used in Cisco Jabber

authentication.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager and the IM and Presence Service.

set key regen authz signing

Run this command on the Unified Communications Manager publisher node to regenerate the asymmetric

RSA key pair for signing the OAuth access tokens and refresh tokens that are used in Cisco Jabber

authentication.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager and the IM and Presence Service.

set logging

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

set logging {enable | disable}

Syntax Description

DescriptionParameters

Turns on logging.enable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set key regen authz encryption

DescriptionParameters

Turns off

logging.

disable

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

DescriptionParameters

Sets the LoginGraceTimeout value for login grace timeout.LoginGr aceTimeout value

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

DescriptionParameters

Specifies the hostname of the

network cluster.

hostname

Specifies the ip address of the

network cluster.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set Login Grace Timeout

DescriptionParameters

Hostname or IP address to assign

to the network cluster publisher.

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.

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

DescriptionParameter

Choose one of these products for this parameter— Unified

Communications Manager, IM and Presence Service, and

Cisco Unity Connection. This field is mandatory.

servertype

The hostname of the node that you add to the cluster. The

hostname is supported on the same domain. This field is

mandatory.

hostname

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.

The domain name of the IM and Presence Service publisher.

This field is mandatory for IM and Presence publisher.

domainname

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network cluster subscriber details

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

DescriptionParameter

Enables the Dynamic Cluster Configuration for 24 hours.default

Specifies a value from 1 to 24 hours.no. of

hours

Command Modes

Administrator (admin)

Requirements

Applies to 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

set network dhcp eth0 {enable | disable } {node_ipnet_maskgateway_ip }

Syntax Description

DescriptionParameters

Specifies Ethernet interface 0.eth0

This enables DHCP.enable

This disables DHCP.disable

Represents the static IP address for the server.node_ip

Represents the subnet mask for the server.net_mask

Represents the IP address of the default gateway.gateway_ip

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network cluster subscriber dynamic-cluster-configuration

Usage Guidelines

If you continue, this command causes the system to restart. We also recommend that you restart all nodes

whenever any IP address gets changed.

Caution

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

DescriptionParameters

primary

secondary

Represents the IP address of the

primary or secondary DNS server.

addr

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.

If you change the IP address for the DNS servers, you must reboot the server through the utils system restart

CLI command.

Note

set network dns options

This command sets DNS options.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network dns

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

Syntax Description

DescriptionParameters

Sets the DNS timeout.timeout

Sets the number of times to attempt a DNS request.attempts

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

Specifies the DNS timeout period in seconds.seconds

Specifies the number of attempts.number

Usage Guidelines

Running this command causes an automatic system restart.

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.

Changing the domain name triggers an automatic regeneration of all 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.

Note

set network domain [domain-name]

Syntax Description

DescriptionParameters

Represents the system domain that you want to assign.domain_name

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network domain

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

Caution

If you use the set network domain domain-name command to change the domain name, you must manually

regenerate all of your security certificates in Cisco Unified Operating System Administration. The list of

certificates depends on your software release but may include cup.pem, cup-xmpp.pem, cup-xmpp-s2s.pem,

tomcat, ipsec and so on. Note that you must restart the tomcat service after the tomcat cert is regenerated and

you can only restart this service using the CLI. For more information about regenerating security certificates,

see the Cisco Unified Communications Operating System Administration Guide (on Cisco.com).

After you regenerate your security certificates, you must reboot all the servers in the cluster. This will ensure

that database replication keeps working correctly. After the servers have rebooted, confirm that there are no

issues reported on the Cisco Unified Reporting report for Database Replication. After you reboot the server,

we recommend that you manually delete old certificates that have become disassociated by the domain name

change. For every ICSA peer that exists on the local node, you must either update the ICSA entry for the peer

node with the new FQDN hostname, or delete that entry and add a new ICSA peer entry with the new FQDN

hostname.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified 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

DescriptionParameters

Enables Network Fault Tolerance.ena

Disables Network Fault Tolerance.dis

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network failover

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

DescriptionParameters

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

Caution

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network gateway

Syntax Description

DescriptionParameters

Represents the new network hostname of the system.

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.

Note

hostname

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

Caution

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network hostname

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.

Note: Changing the IP address will automatically restart

system services cluster wide.

Note: The command should not be issued during normal operating hours.

=======================================================

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

the hostname, respond no.

Note

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. Also, before attempting

an IP address change, the administrator should perform the following:

• verify that 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

DescriptionParameters

Specifies Ethernet interface 0.eth0

Represents the IP address that you

want to assign.

addr

Represents the IP mask that you

want to assign.

mask

Represents the IP default GW that

you want to assign.

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network ip eth0

Usage Guidelines

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

If you continue, this command restarts the following services:

• NIC driver

• NTP

• CLM

• Service Manager

Caution

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 network ip eth0

......

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

=======================================================

Note: Please verify that the new ip address is unique across the cluster

and, if DNS services are utilized, any DNS configuration is

completed before proceeding.

Note: Changing the IP address will automatically restart

system services cluster wide.

Note: The command should not be issued during normal operating hours.

=======================================================

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

DescriptionParameters

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.

dhcp

Enables IPv6 support.enable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network ipv6 dhcp

DescriptionParameters

Disables IPv6 support.disable

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

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

DescriptionParameters

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.

gateway

The IPv6 gateway address.addr

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

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.

IPv6 is not supported in Cisco Business Edition 5000.

Note

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network ipv6 gateway

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

DescriptionParameters

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.

service

Enables IPv6 service on the server.enable

Disables IPv6 service on the server.disable

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

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.

IPv6 is not supported in Cisco Business Edition 5000.

Note

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

DescriptionParameters

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.

static_address

Specifies the static IPv6 address you assign to the server.addr

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network ipv6 service

DescriptionParameters

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

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 max_ip_conntrack

This command sets the ip_conntrack_max value.

set network max_ip_conntrack ip_conntrack_max value

Syntax Description

DescriptionParameters

Specifies the value for ip_conntrack_max.

The value of ip_conntrack_max cannot be less

than 65536.

Note

ip_conntrac k_maxvalue

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.

Example

admin:set network max_ip_conntrack 65536

set network mtu

This command sets the maximum MTU value.

set network mtu mtu_max

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network max_ip_conntrack

Syntax Description

DescriptionParameters

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

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.

Caution

mtu_max

Command Modes

Administrator (admin:)

Usage Guidelines

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

If you continue, the system loses network connectivity temporarily.

Caution

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

DescriptionParameters

The boolean value must be either yes or no.value

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network name-service hosts cache-enable

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

DescriptionParameters

Enter the number of bytes for the database size.value

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

DescriptionParameters

Enter the number of seconds.value

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network name-service hosts max-db-size

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

DescriptionParameters

Enter a value for a service.value

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

DescriptionParameters

Enter the number of seconds.value

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network name-service hosts persistent

set network name-service hosts suggested-size value

Syntax Description

DescriptionParameters

Enter a prime number for optimum efficiency.value

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

DescriptionParameters

The boolean value must be either yes or no.value

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

DescriptionParameters

Enter the value in number of bytes.value

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network name-service services cache-enable

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

DescriptionParameters

Enter a prime number for optimum efficiency.value

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

DescriptionParameters

Enter a value for a service.value

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

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

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

DescriptionParameters

Enter the number of seconds.value

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

DescriptionParameters

Enter a prime number for optimum efficiency.value

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

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

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

DescriptionParameters

Specifies Ethernet interface 0.eth0

Specifies whether auto negotiation

gets enabled or disabled.

auto

Specifies whether the speed of the

Ethernet connection: 10 or 100

Mb/s.

speed

Specifies half-duplex or

full-duplex.

duplex

Command Modes

Administrator (admin:)

Usage Guidelines

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

You can enable only one active NIC at a time.

Note

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

Caution

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 ntp option

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

set network ntp option

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

Set Commands

set network nic eth0

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

DescriptionParameters

Enables Path MTU Discovery.enable

Disables Path MTU Discovery.disable

Command Modes

Administrator (admin:)

Usage Guidelines

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

If you continue, the system loses network connectivity temporarily.

Caution

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

100

Set Commands

set network pmtud state

set network restore eth0 ip-address network-mask gateway

Syntax Description

DescriptionParameters

Specifies Ethernet interface 0.eth0

Represents the IP address of the primary or secondary DNS server, or the network gateway

that you want to assign. If you continue, this command causes a temporary loss of network

connectivity. If you change the IP address for the primary DNS server, you must also restart

the Cisco Tomcat service. For more information, see the utils service command. We also

recommend that you restart all nodes whenever any IP address gets changed.

ip-address

Represents the subnet mask for the server.network-mask

Specifies the IP address of the default gateway.gateway

Represents the IP address of the primary or secondary DNS server, or the network gateway

that you want to assign. If you continue, this command causes a temporary loss of network

connectivity. If you change the IP address for the primary DNS server, you must also restart

the Cisco Tomcat service. For more information, see the utils service command. We also

recommend that you restart all nodes whenever any IP address gets changed.

ip-address

Command Modes

Administrator (admin:)

Usage Guidelines

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.

Caution

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.

Example

admin:set network restore eth0 10.94.150.108 255.255.255.0 10.94.150.1

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

101

Set Commands

set network restore

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

DescriptionParameters

Specifies Ethernet interface 0.eth0

Sets the status of Ethernet interface 0 to up.up

Sets the status of Ethernet interface 0 to down.down

Command Modes

Administrator (admin:)

Usage Guidelines

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

If you continue, the system loses network connectivity temporarily.

Caution

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 name-service

This command displays name service cache attributes.

set network name-service [attribute] [value]

Syntax Description

ValueAttribute

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

itself periodically.

Paranoia

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

more verbose the output.

debug-level

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.

reload-count

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

102

Set Commands

set network status eth0

ValueAttribute

Sets the restart interval to time seconds if periodic restart is enabled by enabling paranoia

mode. The default value is 3600.

restart-inter val

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 length for the OS administration accounts.

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

Note

set password complexity minimum-length max-repeat

Syntax Description

DescriptionParameters

Enter a value of or greater than 6.value

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 password age

This command modifies the value for password age, in days, for Cisco Collaboration Communication OS

(C3OS) accounts.

set password age {maximum | minimum} days

Syntax Description

DescriptionParameters

Specifies the maximum age.maximum

Specifies the minimum age.minimum

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

103

Set Commands

set password complexity minimum-length

DescriptionParameters

Specifies the maximum password

age and must be greater-than or

equal-to 90 days.

days

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

DescriptionParameters

This does not force users to change their password.disable

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

Specifies the affected user account.userid

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

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: IM and Presence Service on 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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

104

Set Commands

set password change-at-login

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.

Note

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

Syntax Description

DescriptionParameters

This turns off password complexity for character types.disable

This turns on password complexity for character types.

When you disable password complexity, you also turn off password character

difference, password character max-repeat, and password history.

Note

enable

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

num-char

Command Modes

Administrator (admin:)

Usage Guidelines

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

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

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

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

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

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

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

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

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

and Cisco Unity Connection.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

105

Set Commands

set password complexity character

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

DescriptionParameters

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

num-char

Command Modes

Administrator (admin:)

Usage Guidelines

Enter 0 to indicate no difference.

The maximum password length is 31 characters.

Note

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

DescriptionParameters

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

password.

• Value range: 0 – 10

Default value: 0

max-r epeat

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

106

Set Commands

set password complexity character difference

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 password expiry maximum-age

This command enables or disables the password expiry maximum age settings for Cisco Collaboration

Communication OS (C3OS) Administrator accounts.

set password expiry maximum-age {enable | disable}

Syntax Description

DescriptionParameters

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.

enable

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.

disable

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 password expiry maximum-age disable

Operation Successful.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

107

Set Commands

set password expiry maximum-age

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

DescriptionParameters

Enter Cisco Collaboration Communication OS (C3OS)

Administrator account.

userid

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

maximum password age

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

DescriptionParameters

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 Collaboration

Communication OS (C3OS)

Administrator accounts.

enable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

108

Set Commands

set password expiry user maximum-age configure

DescriptionParameters

Turns off password expiry

minimum age settings for Cisco

Collaboration Communication OS

(C3OS) administrator accounts.

This means that passwords for

administrator accounts can be

changed at any interval.

disable

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

DescriptionParameters

Turns on the maximum age password expiry settings for a particular Cisco Collaboration

Communication OS (C3OS) 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.

enable

Turns on the maximum age password expiry settings for a particularCisco Collaboration

Communication OS (C3OS) 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

Specifies a particular Cisco Collaboration Communication OS (C3OS) Administrator account.userid

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

109

Set Commands

set password expiry user maximum-age

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

DescriptionParameters

Turns on the minimum age

password expiry settings for a

particular Cisco Unified Operating

System administrator account.

enable

Turns off the minimum age

password expiry settings for a

particular Cisco Unified Operating

System administrator account.

disable

Specifies a particular Cisco Unified

Operating System Administrator

account.

userid

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 password expiry user minimum-age disable

Operation Successful.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

110

Set Commands

set password expiry user minimum-age

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

DescriptionParameters

Specifies the mandatory number of passwords to maintain in history.number

Command Modes

Administrator (admin:)

Usage Guidelines

• To disable, enter 0.

• Default specifies 10.

• Upper limit specifies 20.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

and Cisco Unity Connection.

set password inactivity

set password inactivity {enable | disable | period} days

Syntax Description

DescriptionParameters

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

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

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

the setting.

period

Specify the number of days of inactivity after a password has expired before the account gets

disabled. Valid range is 1 - 99.

days

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

111

Set Commands

set password history

• 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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.

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

Note

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

112

Set Commands

set password system bootloader encryptHash

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

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

Note

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

the cluster after you change the security password.

We recommend that you restart each server after the password is changed on that server.

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

Failure to reboot the servers (nodes) causes system service problems and problems with the Cisco Collaboration

Communication OS (C3OS) Administration windows on the subscriber servers.

Note

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

113

Set Commands

set password user security

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

DescriptionParameters

Turns on the replication monitoring service.enable

Turns off the replication monitoring servicedisable

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

DescriptionParameters

Specifies the trace level. The available options are:

• DEBUG

• INFO

• WARNING

• ERROR

• FATAL

The default trace level is INFO.

Note

trace level

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

114

Set Commands

Set replication-sync monitor

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

DescriptionParameters

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

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

maxlimit

Acceptable values are 1 - 10.value

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 smtp

This command sets the SMTP server hostname.

set smtp hostname

Syntax Description

DescriptionParameters

Represents the SMTP server name.hostname

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

115

Set Commands

set session maxlimit

set strace enable

This command enables the service trace and sets the trace level.

set strace enable [all]tracevalue servicename

Syntax Description

DescriptionParameters

Optional parameter to propagate the service trace settings change to all nodes.all

Represents allowed trace values. Allowed trace values are [Info|Debug|Warn|Error|Fatal]tracevalue

Represents the service for which the trace is enabled.servicename

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

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

Manager

set strace disable

This command disables the service trace.

set strace disable [all] servicename

Syntax Description

DescriptionParameters

Optional parameter to propagate the service trace settings change to all nodes.all

Represents the service for which the trace is enabled.servicename

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

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

Manager

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

116

Set Commands

set strace enable

set timezone

This command lets you change the system timezone.

set timezone zone

Syntax Description

DescriptionParameters

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.

zone

Command Modes

Administrator (admin:)

Usage Guidelines

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

Changing the system time zone to US time zone may require system compliance to FCC Call Routing

Regulations in US. Unified Communications Manager Administrator must refer the Emergency Call Routing

Regulations page and complete necessary configuration.

Note

You must restart the system after you change the timezone.

Caution

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 Setting Timezone to Pacific Time

admin:set timezone Pac

set tls min-version

This command sets the minimum version of Transport Layer Security (TLS) protocol.

• After you set the minimum TLS version, the system reboots.

• Configure the minimum TLS version for each node.

Note

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

117

Set Commands

set timezone

set tls min-version tls minVersion

Syntax Description

DescriptionParameters

Type one of the following options to set it as the minimum TLS version:

• 1.0

• 1.1

• 1.2

tls

minVersion

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

Example

admin: set tls min-version 1.1

This command will result in setting minimum TLS version to 1.1 on all the secure interfaces.

If you have custom applications that makes secure connection to the system, please ensure

they support the TLS version you have chosen to configure.

Also, please refer to the Cisco Unified Reporting Administration Guide to ensure the

endpoints in your deployment supports this feature.

****************************************************************************************************

Warning: This will set the minimum TLS to 1.1 and the server will reboot.

****************************************************************************************************

Do you want to continue (yes/no) ? yes

Successfully set minimum TLS version to 1.1

The system will reboot in few minutes.

set trace disable

This command unsets trace activity for the specified task.

set trace disable tname

Syntax Description

DescriptionParameters

Unsets the task trace settings.disable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

118

Set Commands

set trace disable

DescriptionParameters

Represents the task for which you want to disable traces.tname

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

DescriptionParameters

Sets task trace settings to the arbitrary level.Arbitrary

Sets task trace settings to the detailed level.Detailed

Sets task trace settings to the entry_exit level.Entry_exit

Sets task trace settings to the error level.Error

Sets task trace settings to the significant level.Significant

Sets task trace settings to the special level.Special

Sets task trace settings to the state transition level.State_transition

Represents the task for which you want to disable traces.tname

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

119

Set Commands

set trace enable

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

DescriptionParameters

Enter a value up to 3600 seconds. The TLS sessions are invalid after the configured value.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 tlstrace*

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 Unified Communications Manager.

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

set tlstrace disable

This CLI command disables the TLS tracing for a service.

set tlstrace disable service

Syntax Description

DescriptionParameters

Specifies the service that you use to disable TLS tracing.service

Command Modes

Administrator (admin:)

Example

admin:set tlstrace disable tomcat

TLS tracing is disabled for: tomcat

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

120

Set Commands

set tlsresumptiontimeout

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

DescriptionParameters

Specifies the service that you use to enable TLS tracing.service

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

DescriptionParameters

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.

For OU’s that already contains a backslash, do not enter one more backslash

as SLM registration and CSR generation fails during the time of installation.

Note

orgunit

Represents the organizational name.orgname

Represents the organization location.locality

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

121

Set Commands

set tlstrace enable

DescriptionParameters

Represents the organization state.state

(Optional) Represents the organization country.country

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

alternatehostname

The set web-security command when adding in the alternate hostname will apply and will be added to all

future generated CSR's including, Tomcat, CallManager, CAPF, TVS, and IPsec.

Note

Command Modes

Administrator (admin:)

Usage Guidelines

In case you are planning to rebuild the Unified CM server, ensure that you should use the same OU subject

parameters. Else, this will create discrepancies when you execute the command show web-security. This is

because the platformConfig.xml file will not have the saved parameters information provided before the

rebuild as this file is not backed up during DRS backup.

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.

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

set web-security "Voice\Video" "Cisco" "RTP" NC

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

122

Set Commands

set web-security

set webapp session timeout

This command sets the time, in minutes, that can elapse before a web application, such as 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.

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.

Caution

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

Note

set webapp session timeout minutes

Syntax Description

DescriptionParameters

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

minutes

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 webapp session maxlimit

This command sets the maximum limit for concurrent web application sessions per user. This applies to the

following interfaces:

• Cisco Unified CM Administration

• Cisco Unified Serviceability

• Cisco Unified Reporting

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

123

Set Commands

set webapp session timeout

• Cisco Unified Communications Self Care Portal

• Cisco Unified CM IM and Presence Administration

• Cisco Unified IM and Presence Serviceability

• Cisco Unified IM and Presence Reporting

For the session maximum limit setting to become effective, the administrator must restart the Cisco Tomcat

service.

Restarting the Cisco Tomcat service ends all active sessions and can affect the system performance. Cisco

recommends that you only execute this command during off-peak traffic hours.

Caution

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

Note

set webapp session maxlimit number

Syntax Description

DescriptionParameters

Specifies the number to limit the concurrent web application sessions.

The value ranges from 1 to 10.

Default value is 10.

If the utils EnhancedSecurityMode is enabled, then the session limit is restricted to 3. For

more details on how to Configure Enhanced Security Mode, see the “FIPS 140-2 Mode Setup”

chapter in the Security Guide for Cisco Unified Communications Manager, Release 11.5(1)SU1

at https://www.cisco.com/c/en/us/support/unified-communications/

unified-communications-manager-callmanager/products-maintenance-guides-list.html.

Note

• When you exceed the defined sign-in sessions maximum limit, then the

interface sign-in page displays the Logon Status message as: The Session

limit has already been reached for <username>. Please

logout from those sessions or wait 30 minutes for

inactive sessions to be automatically closed.

• When Enhanced Security Mode is enabled, then the session limit is restricted

to 3. However, Administrator can change the session limit using the set

webapp session maxlimit command to any value ranging from 1 to 10.

number

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

124

Set Commands

set webapp session maxlimit

Applies to: Unified Communications Manager, Unified Communications Manager IM and Presence Service

and Cisco Unity Connection.

Example

This example details on how to set webapp session maxlimit to 4:

admin:set webapp session maxlimit 4

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

The Cisco Tomcat service needs to be restarted for the changes to take effect.This will

disconnect active web sessions and all web applications on this node will be unavailable

until the service restarts.This service restart will take several minutes to complete.

Do you want to continue (yes/no) ? yes

*************Restarting Tomcat***************

Service Manager is running

Cisco Tomcat[STOPPING]

Cisco Tomcat[STARTING]

Cisco Tomcat[STARTED]

The webapp session limit has been successfully set to 4.

This example details on how to enable utils EnhancedSecurityMode:

admin:utils EnhancedSecurityMode enable

The system is operating in NON-FIPS and NOT operating in Enhanced Security Mode.

Enhanced Security Mode can be enabled only when the system is operating in FIPS mode

Do you wish to enable FIPS mode as well (yes/no) ? yes

Warning : This operation will modify the password policies

1)Password Length should be between 14 to 127 characters.

2)Password should have at least 1 lowercase, 1 uppercase, 1 digit and 1 special character.

3)Any of the previous 24 passwords cannot be reused.

4)Minimum age of the password is 1 day and Maximum age of the password is 60 days.

5)Any newly generated password's character sequence will need to differ by at least 4

characters from the old password's character sequence.

Warning : This mode will limit the total number of concurrent web application sessions to

*****************************************************************

This will change the system to Enhanced Security Mode and will reboot

*****************************************************************

Do you want to continue (yes/no) ? yes

The protocol for communication with remote syslog server is already set to tcp. No changes

required.

The system is already operating in contact search authentication enable mode; no change

required. Exiting.

The concurrent web application session limit has been successfully set to 3.

Setting password restrictions as part of Enhanced Security Mode enable

Calling fips enable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

125

Set Commands

set webapp session maxlimit

Security Warning : The operation will regenerate certificates for

1)CallManager

2)Tomcat

3)IPsec

4)TVS

5)CAPF

6)SSH

7)ITLRecovery

Any third party CA signed certificates that have been uploaded for the above

components will need to be re-uploaded.

If the system is operating in mixed mode, then the CTL client needs to be run

again to update the CTL file.

If there are other servers in the cluster, please wait and do not change the

FIPS settings on any other node until the FIPS operation on this node is complete

and the system is back up and running.

*********************************************************************************

This will change the system to FIPS mode and will reboot.

*********************************************************************************

set workingdir

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

set workingdir {activelog | inactivelog | tftp} directory

Syntax Description

DescriptionParameters

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

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

Sets the working directory for TFTP files.tftp

Represents the current working directory.directory

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

126

Set Commands

set workingdir

CHAPTER 7

Show Commands

• show account, on page 131

• show accountlocking, on page 131

• show cert default-ca-list, on page 132

• show cert list, on page 133

• show cert list type, on page 134

• show cert own, on page 134

• show cert trust, on page 135

• show cli pagination, on page 135

• show cli session timeout, on page 136

• show csr list, on page 136

• show csr list type, on page 137

• show csr own, on page 137

• show csr own name, on page 138

• show ctl, on page 139

• show cuc cluster status, on page 139

• show cuc config groups, on page 139

• show cuc config settings, on page 140

• show cuc dbconsistency, on page 141

• show cuc dbcontents, on page 142

• show cuc dbschema, on page 143

• show cuc dbserver disk, on page 144

• show cuc dbserver session, on page 144

• show cuc dbserver sessions all, on page 145

• show cuc dbserver sessions list, on page 145

• show cuc dbserver user list, on page 146

• show cuc dbserver user waiting, on page 146

• show cuc dbtable contents, on page 146

• show cuc dbtable list, on page 147

• show cuc dbtable schema, on page 148

• show cuc dbview contents, on page 150

• show cuc dbview list, on page 151

• show cuc dbview schema, on page 152

• show cuc jetty ssl status , on page 153

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

127

• show cuc locales, on page 153

• show cuc speechview registration certificate size, on page 154

• show cuc sysagent task list, on page 154

• show cuc sysagent task results, on page 155

• show cuc sysinfo, on page 156

• show cuc tech dbschemaversion, on page 157

• show cuc tech dbserver all, on page 158

• show cuc tech dbserver integrity, on page 158

• show cuc tech dbserver log diagnostic, on page 159

• show cuc tech dbserver log message, on page 159

• show cuc tech dbserver status, on page 160

• show cuc trace levels, on page 160

• show cuc version, on page 161

• show date, on page 162

• show diskusage , on page 162

• show dscp all, on page 163

• show dscp defaults, on page 163

• show dscp marking, on page 163

• show dscp status, on page 164

• show environment fans, on page 165

• show environment power-supply, on page 165

• show environment temperatures, on page 165

• show fileserver transferspeed, on page 166

• show haproxy client-auth, on page 166

• show haproxy num-threads, on page 167

• show hardware, on page 168

• show ipsec information, on page 168

• show ipsec policy_group, on page 169

• show ipsec policy_name, on page 170

• show ipsec status, on page 170

• show itl, on page 170

• show logins, on page 171

• show key authz encryption, on page 172

• show key authz signing, on page 172

• show license all, on page 173

• show license status, on page 173

• show license summary, on page 173

• show license tech support, on page 174

• show license trace, on page 174

• show license UDI, on page 174

• show license usage, on page 175

• show Login Grace Timeout, on page 175

• show media streams, on page 175

• show memory, on page 177

• show myself, on page 177

• show network all, on page 178

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

128

Show Commands

• show network cluster, on page 178

• show network dhcp eth0, on page 178

• show network eth0, on page 179

• show network failover, on page 179

• show network ip_conntrack, on page 180

• show network ipprefs, on page 180

• show network ipv6, on page 181

• show network max_ip_conntrack, on page 181

• show network ntp option, on page 182

• show network route, on page 182

• show network status, on page 183

• show network name-service attributes, on page 183

• show network name-service cache-stats, on page 184

• show network name-service {hosts|services} attributes, on page 185

• show open files all, on page 185

• show open files process, on page 186

• show open files regexp, on page 186

• show open ports all, on page 186

• show open ports regexp, on page 187

• show packages, on page 187

• show password, on page 188

• show password complexity character, on page 189

• show password complexity length, on page 189

• show password expiry, on page 189

• show password expiry user, on page 190

• show password expiry user list, on page 190

• show perf counterhelp, on page 191

• show perf list categories, on page 191

• show perf list classes, on page 191

• show perf list counters, on page 192

• show perf list instances, on page 192

• show perf query class, on page 193

• show perf query counter, on page 193

• show perf query instance, on page 194

• show perf query path, on page 195

• show process list, on page 195

• show process load, on page 196

• show process name, on page 197

• show process name process-name , on page 197

• show process open, on page 198

• show process open-fd, on page 198

• show process pid, on page 199

• show process search, on page 199

• show process user, on page 200

• show process using-most cpu, on page 200

• show process using-most memory, on page 201

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

129

Show Commands

• show registry, on page 201

• show risdb list, on page 202

• show risdb query, on page 203

• show samltrace level, on page 203

• show session maxlimit, on page 204

• show smtp, on page 204

• show stats io, on page 204

• show status, on page 205

• show tech activesql, on page 206

• show tech all, on page 206

• show tech ccm_service, on page 206

• show tech database, on page 207

• show tech dberrcode, on page 207

• show tech dbhighcputasks, on page 208

• show tech dbintegrity, on page 208

• show tech dbschema, on page 208

• show tech dbinuse, on page 209

• show tech dbstateinfo, on page 209

• show tech devdefaults, on page 210

• show tech dumpCSVandXML, on page 210

• show tech gateway, on page 211

• show tech locales, on page 211

• show tech network all, on page 211

• show tech network hosts, on page 212

• show tech network interfaces, on page 212

• show tech network resolv, on page 213

• show tech network routes, on page 214

• show tech network sockets, on page 214

• show tech notify, on page 215

• show tech params, on page 215

• show tech prefs, on page 215

• show tech procedures, on page 216

• show tech repltimeout, on page 216

• show tech routepatterns, on page 217

• show tech routeplan, on page 217

• show tech runtime, on page 217

• show tech sqlhistory, on page 218

• show tech systables, on page 218

• show tech system, on page 219

• show tech table, on page 220

• show tech triggers, on page 220

• show tech version, on page 220

• show timezone config, on page 221

• show timezone list, on page 221

• show tls trace, on page 222

• show tls min-version, on page 222

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

130

Show Commands

• show tlsresumptiontimeout, on page 223

• show trace, on page 223

• show ups status, on page 223

• show version active, on page 224

• show version inactive, on page 224

• show vos version , on page 225

• show web-security, on page 225

• show webapp session timeout, on page 226

• show workingdir, on page 226

• show logins unsuccessful, on page 226

show account

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

show account

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection.

Example

admin:show accountlocking

Account Lockout is enabled

Unlock Time : 300 seconds

Retry Count : 3 attempts

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

131

Show Commands

show account

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

show cert default-ca-list

This command displays all the default CA certificates, which are bundled with Unified Communications

Manager and IM and Presence Service.

show cert default-ca-list

Command Modes

Administrator (admin:)

Requirements

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

Example

admin:show cert default-ca-list

Common Name Trust Stores Purpose

"VeriSign Class 3 tomcat-trust This certificate is used by UCM

Secure Server CA - G3" to communicate with Cisco if

Call-Home feature is enabled.

"CAP-RTP-002" CallManager-trust, This certificate was used to

CAPF-trust sign the MIC installed on Cisco

endpoint.Presence of this

certificate allows the end point

to communicate securely with UCM

using the MIC when associated

with a secure profile

"Cisco Manufacturing CallManager-trust, This certificate was used to

CA" CAPF-trust sign the MIC installed on Cisco

endpoint. Presence of this

certificate allows the end point

to communicate securely with UCM

using the MIC when associated

with a secure profile.

"CAP-RTP-001" CallManager-trust, This certificate was used to

CAPF-trust sign the MIC installed on Cisco

endpoint. Presence of this

certificate allows the end point

to communicate securely with UCM

using the MIC when associated

with a secure profile

"ACT2 SUDI CA" CallManager-trust, This certificate was used to

CAPF-trust sign the MIC installed on Cisco

endpoint. Presence of this

certificate allows the end point

to communicate securely with UCM

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

132

Show Commands

show cert default-ca-list

using the MIC when associated

with a secure profile.

"Cisco Manufacturing CallManager-trust, This certificate was used to

CA SHA2" CAPF-trust sign the MIC installed on Cisco

endpoint. Presence of this

certificate allows the end point

to communicate securely with UCM

using the MIC when associated

with a secure profile.

"Cisco Root CA 2048" CallManager-trust, This certificate was used to

CAPF-trust sign the MIC installed on Cisco

endpoint. Presence of this

certificate allows the end point

to communicate securely with UCM

using the MIC when associated

with a secure profile.

"Cisco Root CA M2" CallManager-trust, This certificate was used to

CAPF-trust sign the MIC installed on Cisco

endpoint. Presence of this

certificate allows the end point

to communicate securely with UCM

using the MIC when associated

with a secure profile.

show cert list

This command displays certificate trust lists.

show cert list {own | trust}

Syntax Description

DescriptionParameters

Specifies owned certificates.own

Specifies trusted certificates.trust

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:cert list own

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

133

Show Commands

show cert list

show cert list type

This command displays the available selected type certificate files.

show cert list type {own | trust}

Syntax Description

DescriptionParameters

Specifies owned certificates.own

Specifies trusted certificates.trust

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.

show cert own

This command displays certificate contents.

show cert own filename

Syntax Description

DescriptionParameters

Specifies owned certificates.own

Represents the name of the

certificate file.

filename

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

134

Show Commands

show cert list type

show cert trust

This command displays certificate contents.

show cert trust filename

Syntax Description

DescriptionParameters

Specifies trusted certificates.trust

Represents the name of the

certificate file.

filename

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.

show cli pagination

This command displays the status of automatic CLI automatic pagination.

show cli pagination

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

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

and Cisco Unity Connection.

Example

admin:show cli pagination

Automatic Pagination : Off.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

135

Show Commands

show cert trust

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Shows a list of owned Certificate Sign Requests.own

Shows a list of trusted Certificate Sign Requests.trust

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: Unified Communications Manager, IM and Presence service on Unified Communications Manager,

Cisco Unity Connection

Example

admin: show csr list own

tomcat/tomcat.csr

Vipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr

.....

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

136

Show Commands

show cli session timeout

.....

show csr list type

This command displays the selected own Certificate Sign Request files.

show csr list type own

Syntax Description

DescriptionParameters

Shows a list of owned Certificate Sign Requests.own

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

show csr own

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

show csr own name

Syntax Description

DescriptionParameters

The name of the CSR file.name

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: Unified Communications Manager, IM and Presence service on Unified Communications Manager,

Cisco Unity Connection

Example

admin:show csr own tomcat/tomcat.csr

[

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

137

Show Commands

show csr list type

[

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

DescriptionParameters

The name of the CSR file.name

The name of the certificate sign request.name of 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: Unified Communications Manager, IM and Presence service on Unified Communications Manager,

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

138

Show Commands

show csr own name

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

139

Show Commands

show ctl

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin: show cuc config groups

CiscoLicensing

ConfigurationAssistant

Conversations

category

Displays detailed information.detail

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 perf list counters

This command lists perfmon counters for the specified perfmon class.

show perf list counters class-name [{detail}]

Syntax Description

DescriptionParameters

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

Displays detailed information.detail

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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}]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

192

Show Commands

show perf list counters

Syntax Description

DescriptionParameters

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

Displays detailed information.detail

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

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

Command Modes

Administrator (admin:)

Usage Guidelines

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

You can specify a maximum of five classes for each command.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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...}]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

193

Show Commands

show perf query class

Syntax Description

DescriptionParameters

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

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

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.

The output that this command returns depends on the number of endpoints that is configured in the Route

Groups in Unified Communications Manager.

Note

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

DescriptionParameters

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

Specifies the perfmon instance to view.instance-name

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

194

Show Commands

show perf query instance

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Specifies a perfmon path.path-spec

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 non instance-based perfmon class (a singleton), you must specify path-spec as follows:

class-name\counter-name

You can specify a maximum of five paths for each command.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Outputs the results to the file that is specified by the filename variable.file

Specifies the filename.filename

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

195

Show Commands

show perf query path

DescriptionParameters

Displays detailed output.detail

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

DescriptionParameters

Repeats the command continuously.cont

Clears the screen before displaying output.clear

Ignores the idle or zombie processes.noidle

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.

num

number

Displays threads.thread

Sorts output by CPU usage. This is the default sorting.cpu

Sorts output by memory usage.memory

Sorts output by time usage.time

Displays the output in pages.page

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

196

Show Commands

show process load

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

DescriptionParameters

Specifies the name of a process.process

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

filename

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

DescriptionParameters

Specifies the name of a process.process

name

(Optional) Shows the file name where the output is to be received.file

(Optional) Shows the virtual memory of the process.vm

(Optional) Shows the details, such as page fault, virtual memory, and start time of the process.detail

(Optional) Repeats the command continuously.cont

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

197

Show Commands

show process name

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

(Optional) Shows the file name where the output is to be received.file

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

DescriptionParameters

Specifies the process-id.process-id

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

198

Show Commands

show process open

show process pid

This command shows a specific process number or command name.

show process pid pid [{file filename}]

Syntax Description

DescriptionParameters

Specifies the process ID number of a process.pid

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

filename

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

DescriptionParameters

Represents a regular expression.regexp

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

filename

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

199

Show Commands

show process pid

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

DescriptionParameters

Specifies the username.username

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

filename

(Optional) Shows the virtual memory of the process.vm

(Optional) Shows the details, such as page fault, virtual memory, and start time of the process.detail

(Optional) Repeats the command continuously.cont

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 process using-most cpu

This command displays a list of the most CPU-intensive processes.

show process using-most cpu [{ number }] [{ file filename | [{ cont }] }]

Syntax Description

DescriptionParameters

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

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

filename

Repeats the command continuosly.cont

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

200

Show Commands

show process user

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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 | [{ cont }] }]

Syntax Description

DescriptionParameters

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

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

filename

Repeats the command continuously.cont

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 registry

This command displays the contents of the registry.

show registry system component [{name}] [{page}]

Syntax Description

DescriptionParameters

Represents the registry system name.system

Represents the registry component name.component

Represents the name of the parameter to show.name

Displays one page at a time.page

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

201

Show Commands

show process using-most memory

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Outputs the information to a file.file

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

Allowed during upgrade: Yes

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

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

202

Show Commands

show risdb list

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

DescriptionParameters

Specifies the name of a table.table1

Outputs the information to a file.file

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

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

203

Show Commands

show risdb query

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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

show smtp

This command displays the name of the SMTP host.

show smtp

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

Example

admin:show smtp

SMTP hostname: mail.cisco.com

show stats io

This command displays the IO statistics.

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

Syntax Description

DescriptionParameters

Displays statistics in kilobytes.kilo

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

204

Show Commands

show session maxlimit

DescriptionParameters

Displays detailed statistics on every available device on the system and overrides the kilo

option.

detail

Displays one page at a time.page

Outputs the information to a file specified by filenamefile

filename

Command Modes

Administrator (admin:)

Usage Guidelines

The file option saves the information to platform/cli/filename.txt. Ensure that the filename does

not contain the “.” character.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

205

Show Commands

show status

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Displays one page at a time.page

Outputs the information to a file.file

filename

Command Modes

Administrator (admin:)

Usage Guidelines

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

not contain the “.” character

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Cisco Unity Connection

show tech ccm_service

This command displays information about all services that can run on the system.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

206

Show Commands

show tech activesql

show tech ccm_service

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 tech database

This command shows information about the database.

show tech database {dump | sessions}

Syntax Description

DescriptionParameters

Creates a CSV file of the entire database.dump

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

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

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

DescriptionParameters

Specifies the error code as a positive integer.errorcode

Command Modes

Administrator (admin:)

Usage Guidelines

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

207

Show Commands

show tech database

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 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Represents the car database.car

Represents the cm database.cm

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

208

Show Commands

show tech dbhighcputasks

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 tech dbinuse

This command displays the database in use.

show tech dbinuse [{car | cm}]

Syntax Description

DescriptionParameters

Represents the car database.car

Represents the cm database.cm

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 tech dbstateinfo

This command displays the state of the database.

show tech dbstateinfo [{car | cm}]

Syntax Description

DescriptionParameters

Represents the car database.car

Represents the cm database.cm

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

209

Show Commands

show tech dbinuse

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Traceand Log Central > Collect Files > CiscoDatabase Cli Output > Install and upgrade

log.

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

210

Show Commands

show tech devdefaults

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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Displays one page at a time.page

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

Outputs the information to a file.file

filename

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

211

Show Commands

show tech gateway

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Displays one page at a time.page

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

Outputs the information to a file.file

filename

Command Modes

Administrator (admin:)

Usage Guidelines

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

not contain the “.” character

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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}]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

212

Show Commands

show tech network hosts

Syntax Description

DescriptionParameters

Displays one page at a time.page

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

Outputs the information to a file.file

filename

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Displays one page at a time.page

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

Outputs the information to a file.file

filename

Command Modes

Administrator (admin:)

Usage Guidelines

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

not contain the “.” character

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

213

Show Commands

show tech network resolv

show tech network routes

This command displays information about network routes.

show tech network routes [{page}] [{search text}] [{file filename}]

Syntax Description

DescriptionParameters

Displays one page at a time.page

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

Outputs the information to a file.file

filename

Command Modes

Administrator (admin:)

Usage Guidelines

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

not contain the “.” character

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Displays the numerical addresses of the ports instead of determining symbolic hosts. This

parameter is equivalent to running the Linux shell numeric [-n] command.

numeric

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

214

Show Commands

show tech network routes

show tech notify

This command displays the database change notify monitor.

show tech notify [search pattern_to_match]

Syntax Description

DescriptionParameters

Represents the string that needs to be searched in the command output.searchpattern_to_match

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 tech params

This command displays the database parameters.

show tech params {all | enterprise | service}

Syntax Description

DescriptionParameters

Displays all the database parameters.all

Displays the database enterprise parameters.enterprise

Displays the database service parameters.service

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 tech prefs

This command displays database settings.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

215

Show Commands

show tech notify

show tech prefs

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 tech procedures

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

show tech procedures {car | cm}

Syntax Description

DescriptionParameters

Specifies the CAR procedures.car

Specifies the CM procedures.cm

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

216

Show Commands

show tech procedures

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 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

217

Show Commands

show tech routepatterns

Syntax Description

DescriptionParameters

Displays all runtime information.all

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

Displays system disk usage information.disk

Displays environment variables.env

Displays memory usage information.memory

Displays one page at a time.page

Outputs the information to a specified file.

This option saves the information to platform/cli/<filename>.txt. Ensure that the

file name does not contain the "." character.

Note

file

filename

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

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: Unified Communications Manager, IM and Presence Service on 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 Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

218

Show Commands

show tech sqlhistory

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

DescriptionParameters

Displays all the system information.all

Displays information about the data

buses on the server.

bus

Displays information about the

server hardware.

hardware

Displays information about the

server.

host

Lists the installed kernel modules.kernel modules

Displays information about the

installed software versions.

software

Displays information about the

software tools on the server.

tools

Displays one page at a time.page

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.

file filename

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

219

Show Commands

show tech system

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Represents the name of the table to display.table_name

Displays the output one page at a time.page

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 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

show tech version

This command displays the version of the installed components.

show tech version [page]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

220

Show Commands

show tech table

Syntax Description

DescriptionParameters

Displays one page at a time.page

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 timezone config

This command displays the current timezone settings.

show timezone config

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

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

Cisco Unity Connection

show timezone list

This command displays the available timezones.

show timezone list [{page}]

Syntax Description

DescriptionParameters

Displays the output one page at a time.page

Command Modes

Administrator (admin:)

Usage Guidelines

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

the Factory timezone.

Requirements

Command privilege level: 0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

221

Show Commands

show timezone config

Allowed during upgrade: Yes

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

Cisco Unity Connection

show tls trace

This command shows the status of TLS trace for a service.

show tls trace [{ service }]

Syntax Description

DescriptionParameters

Represents the TLS tracing status of a service. It is a mandatory parameter.service

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 tls min-version

This command shows the minimum configured version of Transport Layer Security (TLS) protocol.

show tls min-version

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

Example

admin:show tls min-version

Configured TLS minimum version: 1.0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

222

Show Commands

show tls trace

show tlsresumptiontimeout

This command shows the TLS session resumption timeout.

show tlsresumptiontimeout

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 trace

This command displays trace information for a particular task.

show trace [{task_name}]

Syntax Description

DescriptionParameters

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

Command Modes

Administrator (admin:)

Usage Guidelines

If you do not enter a parameter, the command returns a list of available tasks.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

223

Show Commands

show tlsresumptiontimeout

show ups status

Command Modes

Administrator (admin:)

Usage Guidelines

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

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

224

Show Commands

show version active

show vos version

With Unity Connection 12.0(1) and later, Unity Connection supports a specific ISO that is separated from the

Unified CM ISO. However, Unity Connection will provide all the latest VOS changes. To see the VOS version

integrated with Unity Connection show vos version CLI is introduced.

This command displays the VOS version stored in the active and inactive partitions. If there is no VOS version

in the inactive partition, it displays "VOS version not available".

For more information, see "Support for Cisco Unity Connection ISO" section of the Release Notes for Cisco

Unity Connection 12.0(1) available at

http://www.cisco.com/c/en/us/support/unified-communications/unity-connection/products-release-notes-list.html

show vos version

Command Modes

Administrator (admin:)

Usage Guidelines

This command always displays the VOS version in the active partition. If the active partition contains an

upgrade, the command also shows the VOS version in the inactive partition.

If you are upgrading from Cisco Unity Connection 11.5(1) or earlier version to 12.0(1) or later, the inactive

partition does not contain the information of VOS version.

Note

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

admin:show vos version

Active version: 12.0.1.10000-1

Inactive version: VOS version not available

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

225

Show Commands

show vos version

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

show logins unsuccessful

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

• On Unified Communications Manager

• Disaster Recovery System

• Cisco Unified OS Administration

• On IM and Presence Service

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

226

Show Commands

show webapp session timeout

• IM and Presence Disaster Recovery System

• Unified IM and Presence OS Administration

show logins unsuccessful [number]

Syntax Description

DescriptionParameters

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

Command Modes

Administrator (admin)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to Unified Communications Manager and IM and Presence Service

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

227

Show Commands

show logins unsuccessful

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

228

Show Commands

show logins unsuccessful

CHAPTER 8

Unset Commands

• unset ipsec policy_group, on page 229

• unset ipsec policy_name, on page 229

• unset network cluster subscriber details, on page 230

• unset network cluster subscriber dynamic-cluster-configuration, on page 230

• unset network dns options, on page 231

• unset network domain, on page 231

• unset network ntp options, on page 232

• unset network ipv6 gateway, on page 232

• unset network ipv6 static_address, on page 233

unset ipsec policy_group

This command disables the ipsec policy on the specified group.

unset ipsec policy_group policy_group

Syntax Description

DescriptionParameters

Specifies the group

name.

policy_gr oup

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

unset ipsec policy_name

This command disables the ipsec policy with the specified name.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

229

unset ipsec policy_name policy_group policy_name

Syntax Description

DescriptionParameters

Specifies the name of a particular ipsec policy group to disable.policy_gr oup

Specifies the policy name to disable.policy_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,

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 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 Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

230

Unset Commands

unset network cluster subscriber details

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

unset network dns options

This command unsets DNS options.

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

Syntax Description

DescriptionParameters

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

Sets the number of DNS attempts to make before the system fails to the default.attempts

Sets the method for selecting a nameserver to the default. This affects how loads are distributed

across nameservers.

rotate

Usage Guidelines

Running this command causes an automatic system restart.

Command Modes

Administrator (admin:)

Usage Guidelines

You are asked to confirm that you want to execute this command.

If you continue, the system loses network connectivity temporarily.

Caution

Requirements

Applies to: Unified Communications Manager, IM and Presence Service on 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:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

231

Unset Commands

unset network dns options

Usage Guidelines

You are asked to confirm that you want to execute this command.

Requirements

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Reboots the server after applying the change.

By default, the reboot on the server does

not happen.

Note

reboot

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

232

Unset Commands

unset network ntp options

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

unset network ipv6 static_address

This command unsets the IPV6 static address.

unset network ipv6 static_address [{reboot}]

Syntax Description

DescriptionParameters

Reboots the server after applying the change.reboot

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: 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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

233

Unset Commands

unset network ipv6 static_address

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

234

Unset Commands

unset network ipv6 static_address

CHAPTER 9

Utils Commands

• utils auditd, on page 240

• utils BE6000Mode enable, on page 240

• utils BE6000Mode disable, on page 241

• utils BE6000Mode status, on page 241

• utils branding enable, on page 241

• utils branding disable, on page 242

• utils branding status, on page 242

• utils contactsearchauthentication disable, on page 242

• utils contactsearchauthentication enable, on page 242

• utils contactsearchauthentication status, on page 243

• utils core analyze, on page 243

• utils core list, on page 244

• utils capf cert import, on page 244

• utils capf set keep_alive, on page 244

• utils capf stale-lsc, on page 245

• utils create report, on page 245

• utils create report database, on page 246

• utils ctl, on page 246

• utils cuc activate CUSRSV, on page 248

• utils cuc auto ITL download, on page 248

• utils cuc cluster activate, on page 249

• utils cuc cluster deactivate, on page 250

• utils cuc cluster makeprimary, on page 250

• utils cuc cluster overwritedb, on page 250

• utils cuc cluster renegotiate, on page 251

• utils cuc create report, on page 251

• utils cuc dbreplication 01_tear_down , on page 252

• utils cuc dbreplication 02_define_servers , on page 253

• utils cuc dbreplication 03_define_db_template, on page 253

• utils cuc dbreplication 04_sync_database, on page 254

• utils cuc dbreplication reset_all, on page 255

• utils cuc encryption, on page 255

• utils cuc jetty ssl disable, on page 256

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

235

• utils cuc jetty ssl enable, on page 257

• utils cuc networking clear_replication, on page 258

• utils cuc networking dscp, on page 258

• utils cuc reset password, on page 259

• utils cuc set PinExpiry_PromptTime “Authentication Rule Name”, on page 259

• utils dbreplication dropadmindb, on page 260

• utils dbreplication forcedatasyncsub, on page 260

• utils dbreplication quickaudit, on page 261

• utils dbreplication rebuild, on page 262

• utils dbreplication repair, on page 262

• utils dbreplication repairreplicate, on page 263

• utils dbreplication repairtable, on page 264

• utils dbreplication reset, on page 264

• utils dbreplication runtimestate, on page 265

• utils dbreplication setprocess, on page 265

• utils dbreplication setrepltimeout, on page 266

• utils dbreplication status, on page 267

• utils dbreplication stop, on page 268

• utils imdb_replication replication status, on page 268

• utils diagnose, on page 269

• utils disaster_recovery backup network, on page 269

• utils disaster_recovery cancel_backup, on page 270

• utils disaster_recovery device add network, on page 270

• utils disaster_recovery device delete, on page 271

• utils disaster_recovery device list, on page 271

• utils disaster_recovery estimate_tar_size , on page 272

• utils disaster_recovery history, on page 272

• utils disaster_recovery jschLogs operation, on page 273

• utils disaster_recovery prepare restore pub_from_sub, on page 273

• utils disaster_recovery restore network, on page 274

• utils disaster_recovery schedule add, on page 274

• utils disaster_recovery schedule, on page 275

• utils disaster_recovery schedule delete, on page 275

• utils disaster_recovery schedule disable, on page 276

• utils disaster_recovery schedule list, on page 276

• utils disaster_recovery show_backupfiles, on page 277

• utils disaster_recovery show_registration, on page 277

• utils disaster_recovery status, on page 278

• utils EnhancedSecurityMode disable, on page 278

• utils EnhancedSecurityMode enable, on page 278

• utils EnhancedSecurityMode status, on page 279

• utils filebeat config, on page 279

• utils filebeat disable, on page 280

• utils filebeat enable, on page 280

• utils filebeat status, on page 280

• utils filebeat tls, on page 281

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

236

Utils Commands

• utils fior, on page 281

• utils fior disable, on page 282

• utils fior enable, on page 282

• utils fior list, on page 282

• utils fior start, on page 283

• utils fior status, on page 283

• utils fior stop, on page 284

• utils fior top, on page 284

• utils fips, on page 284

• utils fips_common_criteria, on page 286

• utils firewall ipv4 debug, on page 286

• utils firewall ipv4, on page 287

• utils firewall ipv4 list, on page 288

• utils firewall ipv4 status, on page 288

• utils firewall ipv6 debug, on page 288

• utils firewall ipv6, on page 289

• utils firewall ipv6 list, on page 290

• utils firewall ipv6 status, on page 290

• utils ha failover, on page 291

• utils ha fallback, on page 291

• utils haproxy set {required|optional|disable} client-auth, on page 292

• utils haproxy set num-threads, on page 294

• utils ha recover, on page 295

• utils ha status, on page 296

• utils ils showpeerinfo, on page 297

• utils import config, on page 297

• utils iostat, on page 298

• utils iothrottle, on page 299

• utils itl reset, on page 299

• utils ipsec restart, on page 300

• utils ldap config, on page 301

• utils managementAgent alarms minpushLevel, on page 302

• utils managementAgent alarms pushfrequency, on page 302

• utils managementAgent alarms pushnow, on page 303

• utils network arp delete, on page 303

• utils network arp set, on page 303

• utils network arp list, on page 304

• utils network capture, on page 305

• utils network capture-rotate, on page 306

• utils network connectivity, on page 307

• utils network host, on page 308

• utils network ipv6 host, on page 308

• utils network ipv6 traceroute, on page 309

• utils network ipv6 ping, on page 309

• utils network ping, on page 310

• utils network traceroute, on page 310

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

237

Utils Commands

• utils network name-service {hosts|services} cache invalidate, on page 311

• utils ntp auth symmetric-key, on page 311

• utils ntp auth auto-key, on page 313

• utils ntp server add, on page 316

• utils ntp server delete, on page 317

• utils ntp config, on page 319

• utils ntp restart, on page 319

• utils ntp server list, on page 320

• utils ntp start, on page 320

• utils ntp status, on page 320

• utils os kerneldump , on page 321

• utils os kerneldump ssh, on page 321

• utils os kerneldump status, on page 322

• utils os secure , on page 322

• utils os secure dynamic-policies compile, on page 323

• utils os secure dynamic-policies list, on page 323

• utils os secure dynamic-policies load, on page 324

• utils os secure dynamic-policies remove, on page 324

• utils os secure dynamic-policies show, on page 325

• utils os secure dynamic-policies start-recording, on page 325

• utils os secure dynamic-policies stop-recording, on page 326

• utils PlatformWebAccess disable, on page 326

• utils PlatformWebAccess enable, on page 327

• utils PlatformWebAccess status, on page 327

• utils processCoreDumps disable, on page 328

• utils processCoreDumps enable, on page 328

• utils processCoreDumps status, on page 328

• utils remote_account create, on page 329

• utils remote_account disable, on page 329

• utils remote_account enable, on page 329

• utils remote_account status, on page 330

• utils remotesyslog set protocol tcp, on page 330

• utils remotesyslog set protocol udp, on page 330

• utils remotesyslog set protocol tls, on page 331

• utils remotesyslog show protocol, on page 331

• utils reset_application_ui_administrator_name, on page 332

• utils reset_application_ui_administrator_password, on page 332

• utils restore_application_ui_administrator_account, on page 333

• utils rosters list limited, on page 333

• utils rosters list full, on page 333

• utils rosters list watchers, on page 334

• utils rosters list contacts, on page 334

• utils rosters delete, on page 334

• utils scheduled-task disable, on page 335

• utils scheduled-task enable , on page 335

• utils scheduled-task list, on page 335

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

238

Utils Commands

• utils set urlpattern disable, on page 336

• utils set urlpattern enable, on page 336

• utils service, on page 337

• utils service list, on page 337

• utils service auto-restart, on page 338

• utils service start, on page 339

• utils service stop, on page 339

• utils snmp config 1/2c community-string, on page 339

• utils snmp config 1/2c inform, on page 340

• utils snmp config 1/2c trap, on page 341

• utils snmp config 3 inform, on page 341

• utils snmp config mib2, on page 342

• utils snmp config 3 trap, on page 342

• utils snmp config 3 user, on page 343

• utils snmp get, on page 344

• utils snmp get 1, on page 344

• utils snmp get 2c, on page 345

• utils snmp get 3, on page 346

• utils snmp hardware-agents, on page 346

• utils snmp test, on page 347

• utils snmp walk, on page 348

• utils snmp walk 1, on page 349

• utils snmp walk 2c, on page 350

• utils snmp walk 3, on page 350

• utils soap realtimeservice test, on page 351

• utils sso, on page 351

• utils sso recovery-url, on page 352

• utils system restart, on page 352

• utils system shutdown, on page 353

• utils system switch-version, on page 353

• utils system boot, on page 354

• utils system upgrade, on page 354

• utils system upgrade cluster, on page 357

• utils system enableAdministration, on page 360

• utils update dst, on page 361

• utils users validate, on page 362

• utils vmtools refresh, on page 362

• utils vmtools status, on page 363

• utils vmtools switch open, on page 363

• utils vmtools switch native, on page 364

• utils system boot status, on page 364

• utils system upgrade dataexport initiate, on page 364

• utils system upgrade dataexport status, on page 365

• utils system upgrade dataexport cancel, on page 365

• utils ucmgmt agent disable, on page 366

• utils ucmgmt agent enable, on page 366

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

239

Utils Commands

• utils ucmgmt agent remove, on page 367

• utils ucmgmt agent restart, on page 367

• utils ucmgmt agent status, on page 367

• utils ucmgmt agent verification, on page 368

• utils ucmgmt config export, on page 368

• utils ucmgmt config import, on page 369

• utils ucmgmt organization, on page 369

• utils ucmgmt proxy add, on page 370

• utils ucmgmt proxy clear, on page 371

• utils ucmgmt proxy force add, on page 371

• utils ucmgmt proxy list, on page 372

utils auditd

This command starts, stops, and provides the status of the system auditing service.

utils auditd {enable | disable | status}

Syntax Description

DescriptionParameters

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 .

enable

Disables the collection of audit logs.disable

Displays the status of audit log collection. We recommend that you retrieve the audit log by

using the Real-Time Monitoring Tool, but you can also retrieve it by using the CLI.

status

Command Modes

Administrator (admin:)

Usage Guidelines

After the service has been enabled, it monitors and logs activity on the system. Be aware that the system

auditing service logs a lot of information. Care must be taken not to overfill the disk.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

and Cisco Unity Connection.

utils BE6000Mode enable

Run this command to enable BE6000 mode on Unified Communications Manager.

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

240

Utils Commands

utils auditd

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager

utils BE6000Mode disable

Run this command to disable BE6000 mode on Unified Communications Manager.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager

utils BE6000Mode status

Run this command to see the Status of BE6000 mode on Unified Communications Manager.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified Communications Manager

utils branding enable

Run this command to enable branding on this node.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

241

Utils Commands

utils BE6000Mode disable

utils branding disable

Run this command to disable branding on this node.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

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

utils branding status

Run this command to see the status of whether branding is enabled or disabled on this node.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Applies to: Unified Communications Manager, IM and Presence Service, or 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

Unified Communications Manager, IM and Presence Service on 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 Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

242

Utils Commands

utils branding disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Unified Communications Manager, IM and Presence Service on 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

Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Specifies an active versionactive

Specifies an inactive versioninactive

Specifies the name of the core file

from which to generate the stack

trace.

core_filename

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

243

Utils Commands

utils contactsearchauthentication status

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 core list

This command displays all active or inactive core files.

utils core {active | inactive} list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

and Cisco Unity Connection.

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: Unified Communications Manager

utils capf set keep_alive

Run this command to set the keep_alive timer for all connections between the Certificate Authority Proxy

Function (CAPF) service and endpoints. The system default is 15 minutes.

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

244

Utils Commands

utils core list

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified Communications Manager

utils capf stale-lsc

utils capf stale-lsc {delete | list}

This command helps you manage your system's stale LSC certificates.

Syntax Description

DescriptionParameters

Deletes all stale LSC certificates from your system.delete

Lists all stale LSC certificates on the system.list

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified Communications Manager

utils create report

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

utils create report {csa | hardware | platform | security}

Syntax Description

DescriptionParameters

Collects all the files required for the Cisco Security Agent (CSA) diagnostics and assembles

them into a single CSA diagnostics file. You can retrieve this file using the file get command.

csa

Creates a system report that contains disk array, remote console, diagnostic, and environmental

data.

hardware

Collects the platform configuration files into a TAR file.platform

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.

security

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

245

Utils Commands

utils capf stale-lsc

Usage Guidelines

You are prompted to continue after you enter the command.

After you create a report, use the command file get activelog platform/log/filename command, to get the

report. where filename specifies the report filename that displays after the command completes.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence Service on 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 {csa | hardware | platform | security}

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

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

DescriptionParameters

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 need

to confirm your action.

To enable mixed-mode, ensure that the Communications Manager is

registered with the Cisco Smart Software Manager or Cisco Smart

Software Manager satellite and the Registration Token received from

the Smart account or Virtual account has Allow export-controlled

functionality enabled while registering with this cluster.

Note

set-cluster

mixed-mode

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

246

Utils Commands

utils create report database

DescriptionParameters

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.

set-cluster

non-secure-mode

Updates the CTL file in each of the nodes of the cluster.

To update the CTLFile in mixed-mode, ensure that the Unified

Communications Manager is registered with the Cisco Smart Software

Manager or Cisco Smart Software Manager satellite and the Registration

Token received from the Smart account or Virtual account has Allow

export-controlled functionality enabled while registering with this cluster.

Note

update CTLFile

Command Modes

Administrator (admin:)

Usage Guidelines

The CLI must be executed on the publisher. On all other nodes, this CLI command is disabled.

Ensure that you reset all the Encrypted and Authenticated phones for the CTL file updates to take effect.

Note

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager.

utils ctl reset localkey

This command is used to regenerate the CTL file and sign it with the secondary SAST role (CallManager).

Use this command when the ITLRecovery certificate that was used to sign the original CTL file has changed

and the endpoints are locked out.

utils ctl reset {localkey}

Syntax Description

Generates a new CTL file, updates the CTL file on the publisher. The command signs the CTLfile

with CallManager key.

localkey

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

247

Utils Commands

utils ctl reset localkey

Usage Guidelines

• You must run this command on the Unified Communications Manager publisher node.

• After the endpoints receive the new CTL file, which is signed by CallManager Key and contains the new

ITLRecovery certificate, execute the CTL update command (utils ctl update CTLFile) again to sign it

with the ITLRecovery certificate. The CTL file is regenerated but signed by the new ITLRecovery

certificate, which is now trusted by the endpoint.

Note

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 auto ITL download

This command allows Unity Connection to disable the functionality of automatically downloading CallManager

certificate for Cisco Unity Connection.

utils cuc auto ITL download { enable | disable | status }

Syntex Description

DescriptionParameters

Enables the functionality of automatically downloading the CallManager certificates on

port-group reset.

By default, the functionality is enabled.

enable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

248

Utils Commands

utils cuc activate CUSRSV

DescriptionParameters

Disables the functionality of automatically downloading the CallManager certificates. When

disabled, you need to upload the certificates manually.

disable

Displays the status of the functionality.status

In case of a cluster, the CLI commands are executed only on publisher server.

Note

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unity Connection

Example

admin:utils cuc auto ITL download enable

After successful execution,Unity Connection will download trust list from the TFTP server

automatically.

For this, you must do the following:

1.Configure TFTP server for Next Generation enabled port groups through Cisco Unity Connection

Administration

2. Restart the Connection Conversation Manager on all nodes in the cluster

Auto downloading of ITL enabled successfully

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

249

Utils Commands

utils cuc cluster activate

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

DescriptionParameters

Specifies the name of the server to take the primary server status in a Cisco Unity Connection

cluster.

server

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

250

Utils Commands

utils cuc cluster deactivate

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

251

Utils Commands

utils cuc cluster renegotiate

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.

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

252

Utils Commands

utils cuc dbreplication 01_tear_down

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.

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.

Note

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

253

Utils Commands

utils cuc dbreplication 02_define_servers

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

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.

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

254

Utils Commands

utils cuc dbreplication 04_sync_database

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

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

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Cisco Unity Connection

utils cuc encryption

This command enables, disables and provides the status of the encryption on Cisco Unity Connection.

utils cuc encryption { enable | disable | status }

Syntex Description

DescriptionParameters

Enables the encryption on Unity Connection. When enabled, Unity connection allows you to

use the security features.

enable

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

255

Utils Commands

utils cuc dbreplication reset_all

DescriptionParameters

Disables the encryption on Unity Connection. When disabled, you can not use the security

features in Unity Connection.

disable

Displays the encryption status of the Unity Connection.status

Usage Guidelines

When you enable the encryption on Unity Connection, make sure the following:

• The Cisco Unity Connection is registered with Cisco Smart Software Manager (CSSM) or Cisco Smart

Software Manager satellite.

• Export Control Functionality is enabled for the product.

For more information on how to register and enable the Export Control Functionality for Cisco Unity

Connection, see " Configuring Cisco Smart Software Licensing in Unity Connection" section of "Managing

Licenses" chapter of Install, Upgrade and Maintenance Guide for Cisco Unity Connection Release 12.x

available at

"https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/12x/install_upgrade/guide/b_12xcuciumg.html".

In case of cluster, the CLI is executed only on publisher server.

Note

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Cisco Unity Connection

Example

admin:utils cuc encryption enable

After successful execution, restart the following services on all nodes in the cluster

1.Connection Conversation Manager

2.Connection IMAP Server

Do you want to proceed (yes/no)? yes

Encryption enabled successfully

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

256

Utils Commands

utils cuc jetty ssl disable

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 enable the SSL on the Jetty Server for notifications.

utils cuc jetty ssl enable

Usage Guidelines

When you enable the SSL on the Jetty server, make sure the following:

• You are using the Restricted version of Cisco Unity Connection.

• The encryption is enabled on the Cisco Unity Connection.

In Evaluation Mode, you are not allowed to run the CLI command.

Note

For more information, see "Cisco Unity Connection- Restricted and Unrestricted Version" chapter of Security

Guide for Cisco Unity Connection Release 12.x available at

https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/12x/security/b_12xcucsecx.html.

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?

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

257

Utils Commands

utils cuc jetty ssl enable

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

DescriptionParameters

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

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

value.

off

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

258

Utils Commands

utils cuc networking clear_replication

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

259

Utils Commands

utils cuc reset password

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

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.

nodename

Minimizes the usage of the publisher server during the forcedatasyncsub process.

Adding this option increases the time taken for forcedatasyncsub to finish.

Note

offloadpub

Specifies the recovery timeout value for each node in minutes (should be greater than the

default timeout).

Default: 40 minutes.

timeoutvalue

Command Modes

Administrator (admin:)

Usage Guidelines

Use this command before you run the utils dbreplication repair command several times; but the utils

dbreplication status command still shows non-dynamic tables that aren't in sync.

Don't run this command if only dynamic tables are out of sync; dynamic tables can be out of sync during

normal system operation.

Note

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

260

Utils Commands

utils dbreplication dropadmindb

You can run this command only 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.

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.

Note

Reboot the subscriber node after the utils dbreplication forcedatasyncsub command is executed.

Cisco DB service will be in the stopped state in the subscriber node where the utils dbreplication

forcedatasyncsub command is executed; unless reboot on the subscriber(s) is performed.

Note

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

utils dbreplication quickaudit

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

utils dbreplication quickaudit {nodename | all}

Syntax Description

DescriptionParameters

Specifies the node on which the quick audit should be run.nodename

Causes the audit to be run on all nodesall

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

261

Utils Commands

utils dbreplication quickaudit

utils dbreplication rebuild

This command is used to set up database replication across the cluster and runs 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

DescriptionParameters

Specifies the node or nodes on which database replication will be rebuilt.nodename

Specifies that database replication will be rebuilt on all nodes in the cluster.all

Command Modes

Administrator (admin:)

Usage Guidelines

This command can affect performance of other nodes in your cluster. We recommend that you run this

command during a system maintenance window.

Caution

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

utils dbreplication repair

This command repairs database replication.

utils dbreplication repair {nodename | all}

Syntax Description

DescriptionParameters

Specifies a particular subscriber server for data repair.nodename

Causes data repair to take place on all subscriber servers.all

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

262

Utils Commands

utils dbreplication rebuild

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: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Specifies the replicate to repair.r eplicatename

Specifies the node on which to repair replication.nodename

Specifies to fix replication on all nodes.all

Command Modes

Administrator (admin:)

Usage Guidelines

The parameter nodename may not specify the publisher; any subscriber node name is acceptable.

This command can be executed on the publisher.

Note

This command does not repair replication setup

Note

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

263

Utils Commands

utils dbreplication repairreplicate

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

DescriptionParameters

Specifies the table to repairtablename

Specifies the node on which to repair replication.nodename

Specifies to fix replication on all nodes.all

Command Modes

Administrator (admin:)

Usage Guidelines

This command does not repair replication setup.

Note

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

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

DescriptionParameters

Specifies a particular subscriber

server to on which to have

replication rebuilt.

nodename

Specifies that all subscriber servers

in the cluster have replication

rebuilt.

all

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

264

Utils Commands

utils dbreplication repairtable

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.

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.

Tip

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

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

DescriptionParameters

Specifies the node to monitor.nodename

Command Modes

Administrator (admin:)

Usage Guidelines

If you provide a node name, the system provides the replication state from the context of the selected node.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

265

Utils Commands

utils dbreplication runtimestate

Syntax Description

DescriptionParameters

The new database replication . Ensure that the value is between 1 and 40.

Default value: 1

process

Command Modes

Administrator (admin:)

Usage Guidelines

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.

Caution

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

DescriptionParameters

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

3600.

Default value: 300 (5 minutes)

timeout

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.

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.

Tip

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

266

Utils Commands

utils dbreplication setrepltimeout

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.

Note

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

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

DescriptionParameters

Specifies to show the status of all servers.all

Specifies the node for which to show status.node

Specifies the replicate for which to show status.replicate

Command Modes

Administrator (admin:)

Usage Guidelines

You should run this command only on the first node (publisher server) of a cluster.

Note

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

267

Utils Commands

utils dbreplication status

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

DescriptionParameters

Specifies the name of the node on which to stop the automatic setup of database replication.nodename

Stops database replication on all nodes.all

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

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

268

Utils Commands

utils dbreplication stop

utils diagnose

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

utils diagnose { fix | list | test | version } [module_name]

Syntax Description

DescriptionParameters

Runs all diagnostic commands and attempts to fix problems.fix

Lists all the diagnostic commands available for HCS services.hcs

Lists all available diagnostic commands.list

Runs a single diagnostic command or group of commands and attempts to fix problems.module

Runs all diagnostic commands but does not attempt to fix problems.test

Displays the diagnostic framework version.version

Specifies the name of a diagnostics module.module_name

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0 for version and 1 for all other parameters

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Specifies a list of features to back up, separated by commas.[featurelist]

Represents the location of the backup files on the remote server.[path]

Represents the IP address or hostname of the server where you stored the backup files.[servername]

Represents the username that is needed to log in to the remote server.[username]

Command Modes

Administrator (admin:)

Usage Guidelines

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

269

Utils Commands

utils diagnose

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 disaster_recovery cancel_backup

This command cancels the ongoing backup.

utils disaster_recovery cancel_backup [confirm]

Command Modes

Administrator (admin:)

Usage Guidelines

After you enter the command, you must confirm that you want to cancel the backup. Enter Y to cancel the

backup or any other key to continue the backup.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Specifies the name of the backup device to be added (mandatory).devicename

Specifies the path to retrieve the backup device (mandatory).path

Specifies the hostname or IP address of the server where the backup file is stored

(mandatory).

server_name/ip_addr ess

Specifies the userid required to connect to the remote machine (mandatory).username

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

270

Utils Commands

utils disaster_recovery cancel_backup

DescriptionParameters

Specifies the number of backups to store on the Network Directory (default 2). This

parameter is optional.

[Number_of_backups]

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

DescriptionParameters

Name of the device to be deleted.device_name

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: Unified Communications Manager, IM and Presence Service on 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 Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

271

Utils Commands

utils disaster_recovery device delete

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

DescriptionParameters

Specifies a list of features to back up, separated by commas.featurelist

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

utils disaster_recovery history

This command displays the history of previous backups and restores.

utils disaster_recovery history [operation]

Syntax Description

DescriptionParameters

Specifies backup or

restore.

operation

Command Modes

Administrator (admin:)

Requirements

Command privilege level:

Allowed during upgrade:

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

272

Utils Commands

utils disaster_recovery estimate_tar_size

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Specifies the name of operation—enable or disable.operation

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 disaster_recovery prepare restore pub_from_sub

This command handles the tasks to prepare for restore of a publisher node from a subscriber node.

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.

Note

utils disaster_recovery prepare restore pub_from_sub

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

273

Utils Commands

utils disaster_recovery jschLogs operation

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

and Cisco Unity Connection

utils disaster_recovery restore network

This command restores a remote server. You must restore the 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

DescriptionParameters

Specifies the hostname of the remote server that you want to restore.r estor e_server

Specifies the name of the file to restore.tarfilename

Specifies the name of the device on which to restore files.devicename

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 disaster_recovery schedule add

This command adds the configured schedules.

utils disaster_recovery schedule add schedulename devicename featurelist datetime frequency

Syntax Description

DescriptionParameters

Represents the name of the scheduler (mandatory).schedulename

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

Represents the comma-separated feature list to back up (mandatory).featurelist

Represents the date when the scheduler is set (mandatory). Format specified

(yyyy/mm/dd-hh:mm) 24-hr clock.

datetime

Represents the frequency at which the schedule is set to take a backup. Examples: once, daily,

weekly and monthly.

frequency

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

274

Utils Commands

utils disaster_recovery restore network

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

utils disaster_recovery schedule

This command enables or disables the specified schedule.

utils disaster_recovery schedule {enable | disable} [schedulename]

Syntax Description

DescriptionParameters

Enables the specified schedule.enable

Disables the specified schedule.disable

Represents the name of the scheduler.schedulename

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

DescriptionParameters

Represents the name of the schedule that is to be deleted.schedulename

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

275

Utils Commands

utils disaster_recovery schedule

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

utils disaster_recovery schedule disable

This command disables the configured schedules.

utils disaster_recovery schedule disable schedulename

Syntax Description

DescriptionParameters

Represents the name of the schedule that is to be disabled.schedulename

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

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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

276

Utils Commands

utils disaster_recovery schedule disable

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

DescriptionParameters

Represents the name of the device to show backup files at the storage location.devicename

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

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

DescriptionParameters

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

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,

and Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

277

Utils Commands

utils disaster_recovery show_backupfiles

utils disaster_recovery status

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

utils disaster_recovery status operation

Syntax Description

DescriptionParameters

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

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

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: Unified Communications Manager, IM and Presence Service on 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:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

278

Utils Commands

utils disaster_recovery status

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

utils filebeat config

The command configures the Logstash server details for downloading the information.

utils filebeat configIP addressport numberlog type

Syntax Description

DescriptionParameters

Enter the IP address of the Logstash server.IP address

Enter the port number of Logstash server.port

number

Enter the log type that you have to uploaded to the Logstash server.log type

You can also secure the FileBeat service by enabling TLS. The following prompt is displayed after setting

the parameters.

Do you wish to secure the filebeat service by enabling TLS?

Enter (yes/no) ?

Enter Yes to enable TLS.

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

279

Utils Commands

utils EnhancedSecurityMode status

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

280

Utils Commands

utils filebeat disable

Requirements

Command privilege level: 4

Allowed during upgrade: No

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

and Cisco Unity Connection

utils filebeat tls

This command configures Transport Layer Security (TLS) 1.2 as the protocol for communication between

the FileBeat client and the logstash server. This enables a secure connection between the FileBeat client and

the logstash server, which is a requirement for compliance with Common Criteria guidelines.

In Common Criteria Mode, strict host name verification is implemented. Hence, it is required to configure

the server with a fully qualified domain name (FQDN) which matches the certificate.

utils filebeat tls {enable | disable | status}

Syntax Description

DescriptionParameters

Enables a secure connection between the FileBeat client and the logstash server.enable

Disables the TLS for FileBeat client.disable

Displays the status for TLS.status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

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

Manager

A security certificate has to be uploaded from logstash server to the tomcat trust store on Unified

Communications Manager and IM and Presence Service.

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

281

Utils Commands

utils filebeat tls

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

utils fior enable

This command enables I/O statistics monitoring.

Use this command before monitoring begins.

Note

utils fior enable

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 fior list

This command displays a list of the I/O events for all processes.

utils fior list

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

282

Utils Commands

utils fior disable

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

Enable the I/O statistics utility monitoring begins before the monitoring begins.

Note

utils fior start

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 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

283

Utils Commands

utils fior start

utils fior stop

This command stops the I/O statistics monitoring and data collection. However, this command does not delete

the collected data.

If I/O statistics are no longer needed, disable the cleanup of the monitoring data from the platform logs.

Note

utils fior stop

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 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

utils fips

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 Unified Communications Manager.

For information about which releases are FIPS compliant and to view their certifications, see the FIPS 140

document at https://www.cisco.com/c/en/us/solutions/industries/government/global-government-certifications/

fips-140.html.

Caution

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

284

Utils Commands

utils fior stop

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

DescriptionParameters

Activates FIPS 140-2 mode.enable

Deactivates FIPS 140-2 mode.disable

Displays the status of FIPS 140-2 mode.status

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.

Certificates and SSH key are regenerated automatically, in accordance with FIPS requirements.

Note

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 Service 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 the IM 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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

285

Utils Commands

utils fips

Allowed during upgrade: No

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

and Cisco Unity Connection

utils fips_common_criteria

This command configures the Common Criteria mode in the system.

utils fips_common_criteria {enable | disable | status}

Syntax Description

DescriptionParameters

Enables the Common Criteria mode in the systemenable

Disables the Common Criteria mode in the system

When Common Criteria mode is disabled, a prompt is displayed to set the minimum TLS version.

disable

Displays the status of Common Criteria mode in the systemstatus

Command Modes

Administrator (admin:)

Usage Guidelines

Secure connections using TLS version 1.0 are not permitted after enabling the Common Criteria mode. FIPS

mode will be enabled while enabling Common Criteria mode. Enabling or disabling Common Criteria mode

does not require certificates to be regenerated. However, enabling or disabling FIPS does require rebooting

of the system along with regeneration of certificates.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager and IM and Presence Service

This CLI command is not applicable to Cisco Unity Connection.

Note

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

286

Utils Commands

utils fips_common_criteria

Syntax Description

DescriptionParameters

Turns off the IPv4 firewall debugging. If you do not enter the time parameter, this command

disables the firewall for 5 minutes.

off

(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

time

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 firewall ipv4

This commands enables and disables IPv4 firewall.

utils firewall ipv4 {enable | disable[time]}

Syntax Description

DescriptionParameters

Turns on the IPv4 firewall.enable

Turns off the IPv4 firewall. If you do not enter the time parameter, this command disables the

firewall for 5 minutes.

disable

(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

time

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

287

Utils Commands

utils firewall ipv4

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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.

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils ipv6 firewall debug {off[time]}

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

288

Utils Commands

utils firewall ipv4 list

Syntax Description

DescriptionParameters

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

off

(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

time

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 firewall ipv6

This commands enables and disables IPv6 firewall.

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils firewall ipv6 {enable | disable[time]}

Syntax Description

DescriptionParameters

Turns on the IPv6 firewall.enable

Turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the

firewall for 5 minutes.

disable

(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

time

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

289

Utils Commands

utils firewall ipv6

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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection.

utils firewall ipv6 list

This commands displays the current configuration of the IPv6 firewall.

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils firewall ipv6 list

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.

utils firewall ipv6 status

This command displays the current status of the IPv6 firewall.

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils firewall ipv6 status

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

290

Utils Commands

utils firewall ipv6 list

Applies to: Unified Communications Manager, IM and Presence Service on 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 Service nodes, the backup node must be another IM and Presence Service. 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

DescriptionParameters

Specifies the node on which to

perform the manual failover.

node name

Command Modes

Administrator (admin:)

Requirements

Applies to: Unified Communications Manager and IM and Presence Service on 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

DescriptionParameters

Specifies the node on which to perform a manual fallback.node

name

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

291

Utils Commands

utils ha failover

Requirements

Applies to: Unified Communications Manager and IM and Presence Service on 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 haproxy set {required|optional|disable} client-auth

This command sets the value of client authentication on a specified port. The supported values for authentication

are Required, Optional, or Disable.

The following table depicts the default values for the ports.

Table 2: Default Values for the Ports

Default ValuePort

Optional6971

Optional6972

Required9443

Setting the client authentication to anything other than default value could have serious implications. Please

change these values only as per Cisco TAC team advise.

Warning

utils haproxy set {required | optional | disable}client-auth portnum

Syntax Description

DescriptionParameter

Enter the port number to set HAProxy client

authentication.

The supported port numbers are 6971,

6972 and 9443.

Note

portnum

Sets the value of client authentication to “required”

on a specified port.

required

Sets the value of client authentication to “optional”

on a specified port.

optional

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

292

Utils Commands

utils haproxy set {required|optional|disable} client-auth

DescriptionParameter

Sets the value of client authentication to “disable” on

a specified port.

disable

Command Modes

Administrator (admin:)

Usage Guidelines

• If the user enters a portnum value other than 6971, 6972 or 9443, an error message is displayed to enter

a valid port number.

• Administrator can execute the help utils haproxy set optional client-auth command to view the help

content.

• The configured client-auth value for the portnum is retained during the upgrades and while performing

a backup using Disaster Recovery System (DRS) and restore.

• If you set client authentication to “required”, then server requests for a certificate from the clients. The

client must present the requested certificate to the server. Hence, the request can forward to the further

services.

• If you set client authentication to “optional”, then server requests for a certificate from the clients.

Although if the client does not present the requested certificate to the server, the request can forward to

the further services.

• If you set client authentication to “disable”, then the server will not request for a certificate from the

clients.

• The HAProxy process restarts when you execute this command.

Requirements

Command privilege level: 1

Applies to: Unified Communications Manager

Example

admin:utils haproxy set required client-auth 6971

This command will result in the HA Proxy service set the client

authentication as per your specification and restart the

HAProxy process. Restarting of the HAProxy process might

result in momentary disconnection of all Phones and Jabber

clients that are accessing this service for secure

configuration file downloads. It is recommended this

operation be performed during off-busy hours and ensure

there are no TFTP operations in progress.

Warning: Setting the client authentication to anything other

than default value could have serious implications.

Please change these values only as per Cisco TAC team's advise

Do you want to continue (yes/no) ? yes

Successfully set client authentication to required

HAProxy Process already running .. restarting

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

293

Utils Commands

utils haproxy set {required|optional|disable} client-auth

admin:

admin:utils haproxy set disable client-auth 6972

HAProxy client authentication is already set to

disable on port 6972 . No action will be taken.

admin:utils haproxy client-auth set 1234 disable

Please enter valid values for the port.

Supported values are 6971, 6972 and 9443

admin:help utils haproxy set required client-auth 6971

utils haproxy set required client-auth

This command updates the value of client authentication

as required on specified port.

Example:

admin:utils haproxy set required client-auth 6971

HAProxy client authentication is already set to

required on port 6971. No action will be taken.

admin:

utils haproxy set num-threads

This command sets the number of threads, spawn by the HAProxy service.

Setting this parameter to anything other than default value could have serious implications. Please change

these values only as per Cisco TAC team's advice.

Warning

utils haproxy set num-threads numThreads

Syntax Description

DescriptionParameter

Enter the number of HAProxy threads to be configure.

The default value is 1.

The supported values for the number of

threads are 1, 2, 3 and 4.

Note

numThreads

Command Modes

Administrator (admin:)

Usage Guidelines

• If the user enters a numThreads value other than 1, 2, 3 or 4, an error message is displayed to enter a

valid number of HAProxy threads.

• Administrator can execute the help utils haproxy set num-threads command to view the help content.

• The configured numThreads value is retained during the upgrades as well as while performing a backup

using Disaster Recovery System (DRS) and restore.

• The HAProxy process restarts when you execute this command.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

294

Utils Commands

utils haproxy set num-threads

Requirements

Command privilege level: 1

Applies to: Unified Communications Manager

Example

admin:utils haproxy set num-threads 3

This command will result in the HAProxy service spawn as many threads

as you have specified and restart the HAProxy process. Restarting of

the HAProxy process might result in momentary disconnection of all

Phones and Jabber clients that are accessing this service for

secure configuration file downloads and authenticated users data

access. It is recommended this operation be performed during

off-busy hours and ensure there are no TFTP operations in progress.

Warning: Setting this parameter to anything other than default

value could have serious implications. Please change these values

only as per Cisco TAC team's advise

Do you want to continue (yes/no) ? yes

Successfully set number of HAProxy threads to 3

Restarting HAProxy process

admin:

admin:utils haproxy set num-threads 5

Please enter a valid number of HAProxy threads.

Supported values are 1, 2, 3 and 4

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

DescriptionParameters

Specifies the presence redundancy group on which to

monitor HA status. If no presence redundancy group

name is provided, all cluster information is provided.

presence redundancy group name

Command Modes

Administrator (admin:)

Requirements

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

Manager

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

295

Utils Commands

utils ha recover

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

DescriptionParameters

Specifies the presence redundancy group for which to monitor HA status.

If no presence redundancy group name is provided, all cluster information

is displayed.

presence r edundancygr oup name

Command Modes

Administrator (admin:)

Requirements

Applies to: Unified Communications Manager and IM and Presence Service on 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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

296

Utils Commands

utils ha status

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

DescriptionParameters

Specifies the fully qualified domain name of the publisher node for a Unified Communications

Manager cluster in an ILS network.

clustername

Command Modes

Administrator (admin:)

Usage Guidelines

The peer info vector contains information about a cluster in an ILS network. The available information includes

clustername, cluster ID and IP addresses for the cluster nodes. If you want information about a specific cluster

in an ILS network, enter the clustername parameter. If you want information on all the clusters in the network,

leave the clustername parameter empty

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified 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.

1. Power on the VMware.

2. Use the Answer File Generator (AFG) tool ( http://www.cisco.com/web/cuc_afg/index.html ) to create a

platformConfig.xml file.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

297

Utils Commands

utils ils showpeerinfo

3. Insert the Config.xml file into a virtual floppy instance (see

http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1739for

directions).

4. Mount the .flp file in the floppy drive of the new VMware.

5. Sign in to the CLI of the VM (with console or SSH) and execute the utils import config command.

The command cycles through all of the data found in the xml file and if data is found that is different than

what is currently set on the VM, it modifies the VM to match the new data.

6. The system reboots with the new identity.

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

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

DescriptionParameters

Sets the seconds between two iostat readings. You must set this value if you are using the iteration

parameter

interval

Sets the number of iostat iterations. You must set this value if you are using the interval parameter.iterations

Redirects the output to a file.filename

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

298

Utils Commands

Execute utils import config in Vmware Deployment

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Enables I/0 throttling enhancements which lowers the impact of upgrades on an active system.Enable

Disables I/0 throttling enhancements.Disable

Displays the status of I/0 throttling enhancements.Status

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

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 CallManager certificate key.

localkey

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

remotekey

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

299

Utils Commands

utils iothrottle

Usage Guidelines

You must run this command on the publisher node.

Note

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to:

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 ipsec restart

This command is used to restart the ipsec service.

utils ipsec restart

Command Modes

Administrator (admin:)

Requirments

Command privilege level:1

Allowed during upgrade: No

Applies to: Unified Communications Manager

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

300

Utils Commands

utils ipsec restart

Example

admin:utils ipsec restart

ipsec_setup: Stopping Openswan IPsec...

ipsec_setup: stop ordered, but IPsec appears to be already stopped!

ipsec_setup: doing cleanup anyway...

ipsec_setup: Starting Openswan IPsec U2.6.32/K2.6.32-573.18.1.el6.x86_64...

ipsec_setup: /usr/libexec/ipsec/addconn Non-fips mode set in /proc/sys/crypto/fips_enabled

ipsec_setup: pluto appears to be running already (`/var/run/pluto/pluto.pid' exists), will

not start another

Successfully Restarted IPsec Service

admin:

utils ldap config

This command configures the system LDAP authentication.

utils ldap config {fqdnipaddr}

Syntax Description

DescriptionParameters

Configures the system to use an FQDN for LDAP authentication.fqdn

Configures the system to use an IP address for LDAP authenticationipaddr

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: Unified Communications Manager and Cisco Unity Connection

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

301

Utils Commands

utils ldap config

Allowed during upgrade: Yes

utils managementAgent alarms minpushLevel

If Push Notifications is enabled, run this command to configure the minimum alarm severity for which Unified

Communications Manager sends push notifications alarms to the Cisco cloud.

utils managementAgent alarms minpushLevelseverity

Syntax Description

DescriptionParameters

This value represents the minimum alarm severity for which Unified Communications Manager

sends Push Notifications alarms to the Cisco cloud. The possible options are:

• Critical

• Error (this is the default)

• Warning

• Notice

• Information

severity

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager and IM and Presence Service

utils managementAgent alarms pushfrequency

If Push Notifications is enabled, run this command to configure the interval following which Unified

Communications Manager sends push notifications alarms to the Cisco cloud.

utils managementAgent alarms pushfrequencyminutes

Syntax Description

DescriptionParameters

The upload frequency in minutes. This value must be an integer between 5 and 90 with a default

of 30 minutes.

minutes

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

302

Utils Commands

utils managementAgent alarms minpushLevel

Allowed during upgrade: No

Applies to: Unified Communications Manager and IM and Presence Service

utils managementAgent alarms pushnow

If Push Notifications is enabled, run this command to send push notifications alarms to the Cisco cloud

immediately, without having to wait for the next scheduled upload.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager and IM and Presence Service

utils network arp delete

This command deletes an entry in the Address Resolution Protocol table.

utils network arp delete host

Syntax Description

DescriptionParameters

(Optional) Represents the host name or IP address of the host to delete from the table.host

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.

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}

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

303

Utils Commands

utils managementAgent alarms pushnow

Syntax Description

DescriptionParameters

Represents the host name or IP address of the host to add to the table.host

Represents the hardware address (MAC) of the host to be added in the format:

XX:XX:XX:XX:XX:XX

addr

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

DescriptionParameters

host

hostname

(Optional) page, numeric

• Page: Pauses to display the output one page at a

time.

• Numeric: Shows hosts as dotted IP addresses.

options

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

304

Utils Commands

utils network arp list

Applies to: Unified Communications Manager, IM and Presence Service on 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] [{filefname}] [{countnum}] [{sizebytes}] [{srcaddr}]

[{destaddr}] [{portnum}]

Syntax Description

DescriptionParameters

Specifies Ethernet interface 0.eth0

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

page

(Optional) Displays hosts as dotted IP addresses.numeric

(Optional) Outputs the information to a file.

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

contain the “.” character.

file fname

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

countnum

(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 either 262144 bytes or ALL.

sizebytes

(Optional) Specifies the source address of the packet as a host name or IPV4 address.src addr

(Optional) Specifies the destination address of the packet as a host name or IPV4 address.destaddr

(Optional) Specifies the port number of the packet, either source or destination.portnum

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

305

Utils Commands

utils network capture

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.

utils network capture-rotate

This command captures IP packets beyond the 100,000 packet limit of utils network capture.

utils network capture-rotate {filefname} [{sizebytes}] [{sizePerFilemegabytes }] {maxFiles

num}[{srcaddr}] [{destaddr}] [{portnum}][{host protocoladdr}]

Syntax Description

DescriptionParameters

Outputs the information to a file.

The file will be saved in platform/cli/fname. fname should not contain

the "." character.

Note

file fname

The number of bytes of the packet to capture. Valid values include any number up

to 65535 or ALL. The default is ALL.

sizebytes

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.

sizePerFile megabytes

the maxFiles indicates the maximum number of log files to be created. The default

value of maxFiles is 10.

maxFiles num

(Optional) Specifies the source address of the packet as a hostname or IPV4 address.src addr

(Optional) Specifies the destination address of the packet as a host name or IPV4

address.

dest addr

(Optional) Specifies the port number of the packet, either source or destination.port num

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

host protocol addr

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

306

Utils Commands

utils network capture-rotate

utils network connectivity

This command verifies the node network connection to the first node in the cluster (this connection is only

valid on a subsequent node) and to a remote node.

utils network connectivity [{reset}] [hostname/ip address]

utils network connectivity [hostname/ip address] [port-number] [timeout]

Syntax Description

DescriptionParameters

This command verifies the node

network connection to the first node

in the cluster.

It is also used to check connectivity

to a remote node, where there are

two mandatory parameters,

hostname/ip address and

port-number.

connectivity

(Optional) Clears previous return

codes.

reset

• (Optional) Hostname or IP

address of cluster node to

check network connectivity

with the publisher or the first

node.

• (Mandatory) Hostname or IP

address of the host that has to

be tested for the TCP

connection, to check network

connectivity on the remote

server.

hostname/ip address

(Mandatory) Port number of the

host that requires connection test.

port-number

(Optional) Specifies the time in

seconds after which port

connectivity message is displayed.

timeout

Command Modes

Administrator (admin:)

Usage Guidelines

• The utils network connectivity [reset] [hostname/ip address] command is used to check the network

connectivity to the publisher or the first node.

• The utils network connectivity [hostname/ip address] [port-number] [timeout] command is

used to check the network connectivity to a remote server.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

307

Utils Commands

utils network connectivity

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.

utils network host

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

utils network host name [{serverserv}] [page] [detail] [srv]

Syntax Description

DescriptionParameters

Represents the host name or IP address that you want to resolve.name

(Optional) Specifies an alternate domain name server.serv

(Optional) Displays the output one screen at a time.[page]

(Optional) Displays a detailed listing.[detail]

(Optional) Displays DNS SRV records.[srv]

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.

utils network ipv6 host

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

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils network ipv6 host {host_nameipv6_address}

Syntax Description

DescriptionParameters

Specifies the name of the server.host_name

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

308

Utils Commands

utils network host

DescriptionParameters

Specifies the IPv6 address of the server.ipv6_addr ess

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager and Cisco Unity Connection.

utils network ipv6 traceroute

This command to traces an IPv6 address or hostname.

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils network ipv6 traceroute [{ipv6-addresshostname}]

Syntax Description

DescriptionParameters

Specifies IPv6 address that you want to trace.ipv6-addr ess

Specifies the host name that you want to trace.hostname

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager and Cisco Unity Connection.

utils network ipv6 ping

This command allows you to ping an IPv6 address or hostname.

IPv6 is not supported in Cisco Business Edition 5000.

Note

utils network ipv6 ping destination [count]

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

309

Utils Commands

utils network ipv6 traceroute

Syntax Description

DescriptionParameters

Specifies a valid IPv6 address or host name that you want to ping.destination

Specifies the number of times to ping the external server. The default count equals 4.[count]

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: 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

DescriptionParameters

Represents the ip address or host name of the server that you want to ping.destination

Specifies the number of times to ping the external server. The default count is 4.[count]

Specifies the size of ping packets in bytes. The default value is 56.[size]

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.

utils network traceroute

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

utils network traceroute [destination]

Syntax Description

DescriptionParameters

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

310

Utils Commands

utils network ping

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.

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

DescriptionParameters

Host services cacheHosts

Services service cacheServices

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 auth symmetric-key

utils ntp auth symmetric-key {enable | disable | status}

This command helps you enable or disable authentication of the selected NTP server. The authentication is

based on symmetric keyID and key. The symmetric key is stored in the encrypted format in Unified

Communications Manager.

Before you run this command, ensure that you know the NTP server keyID and its corresponding key.

Note

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

311

Utils Commands

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

Syntax Description

DescriptionParameters

Choose one of the NTP servers from the list of available servers and enable it for authentication.enable

Choose one of the NTP servers from the list of available servers and disable it for authentication.disable

Shows the authentication status of all the listed NTP servers.status

Usage Guidelines

The system prompts you to enter the KeyID or Symmetric key for authentication of an NTP server.

• Unified Communications Manager sends Syslog alert messages when the authentication status of an NTP

server changes. You can secure the connections to the syslog server with TLS.

• You can configure the NTP server authentication after you install Unified Communications Manager.

Note

Requirements

Command privilege level: Level 1 can execute all commands, Level 0 can execute only status command

Allowed during upgrade: No

Applies to: Unified Communications Manager

Example: utils ntp auth symmetric-key status - View status when NTP authentication is not enabled

admin:utils ntp auth symmetric-key status

10.77.32.92 : NTP Authentication is disabled.

10.77.46.203 : NTP Authentication is disabled.

ind assid status conf reach auth condition last_event cnt

==========================================================

1 8468 963a yes yes none sys.peer sys_peer 3

2 8469 9024 yes yes none reject reachable 2

Example: utils ntp auth symmetric-key enable - Enable NTP authentication

admin:utils ntp auth symmetric-key enable

The List of NTP servers Configured:

1. 10.77.32.92

2. 10.77.46.203

q. press q to exit

Enter the selection for which to configure NTP authentication: 1

Please enter the Key ID [1-65534]:

Please enter the Symmetric Key of the NTP Server (SHA1):

Restarting NTP

please run the utils ntp auth symmetric-key status to check the status of NTP Authentication

Example: utils ntp auth symmetric-key status - View status after NTP authentication is enabled

admin:utils ntp auth symmetric-key status

10.77.46.203 : NTP Authentication is disabled.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

312

Utils Commands

utils ntp auth symmetric-key

10.77.32.92 : NTP Authentication is enabled.

ind assid status conf reach auth condition last_event cnt

=========================================================

1 57733 9044 yes yes none reject reachable 4

2 57734 f014 yes yes ok reject reachable 1

Example: utils ntp auth symmetric-key disable - Disable NTP authentication

admin:utils ntp auth symmetric-key disable

The List of NTP servers Configured:

0. All

1. 10.77.46.203

2. 10.77.32.92

q. press q to exit

Enter the selection for which to disable NTP authentication: 2

NTP authentication has been disabled on the particular server.

Restarting NTP

Example: utils ntp auth symmetric-key status - View status after NTP authentication is disabled

10.77.46.203 : NTP Authentication is disabled.

10.77.32.92 : NTP Authentication is disabled.

ind assid status conf reach auth condition last_event cnt

===========================================================

1 42767 9144 yes yes none falsetick reachable 4

2 42768 912a yes yes none falsetick sys_peer 2

Example: utils ntp auth symmetric-key status - View status of NTP authentication

admin:utils ntp auth symmetric-key status

10.77.32.92 : NTP authentication is failed. Please check the NTP authentication Key ID

and Symmetric Key entered is correct. To update, disable and reenable authentication for

this NTP server.

10.77.32.78 : NTP Authentication is disabled.

ind assid status conf reach auth condition last_event cnt

===========================================================

1 31609 c02c yes no bad reject 2

2 31610 803a yes no none reject sys_peer 3

utils ntp auth auto-key

utils ntp auth auto-key {enable | disable | status}

This command helps you enable or disable authentication of the selected NTP server. The authentication is

based on the client key. It also allows you to check the authentication status of the ntp servers.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

313

Utils Commands

utils ntp auth auto-key

You can configure the PKI-based authentication with the IFF identity scheme on the NTP server only if you

enable common criteria mode on the Unified Communication Manager.

Note

You can enable either symmetric key or PKI-based NTP authentication on Unified Communications Manager.

If you try to enable the symmetric key on the PKI enabled server, the following warning message is displayed:

NTP authentication using Autokey is currently enabled and must be disabled before the symmetric key is

enabled. Use the command 'utils ntp auth auto-key disable' to disable NTP authentication, then retry this

command.

Warning

If you try to enable the Autokey on the symmetric key enabled server, the following warning message is

displayed:

NTP authentication using symmetric key is currently enabled and must be disabled before Autokey is enabled.

Use the command 'utils ntp auth symmetric-key disable' to disable NTP authentication, then retry this command.

Warning

NTP servers require ntp version 4 and the rpm version ntp-4.2.6p5-1.el6.x86_64.rpm and above.

Note

Syntax Description

DescriptionParameters

Choose one of the NTP servers from the list of available servers and enable it for authentication.enable

Choose one of the NTP servers from the list of PKI authentication enabled NTP servers and

disable authentication.

disable

Shows the authentication status of all the listed NTP servers.status

Usage Guidelines

While enabling NTP authentication, system prompts you to enter the IFF client key for authentication of an

NTP server. When the client key is uploaded successfully, it restarts the NTP service on the Unified

Communications Manager publisher node. Post that authentication is enabled between the Unified

Communications Manager and NTP server.

• You can configure the NTP server authentication after you install or upgrade the Unified Communications

Manager.

• Do not terminate the execution by pressing “Ctrl-C” key during the CLI execution.

Note

Requirements

Command privilege level:: Level 1 can execute all commands, Level 0 can execute only status command

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

314

Utils Commands

utils ntp auth auto-key

Allowed during upgrade: No

Applies to:: Unified Communications Manager

admin:utils ntp auth auto-key enable-Enable NTP authentication

1: 10.78.83.146

2: 10.77.46.203

3: 10.77.32.92

Select the server for which auto-key based NTP authentication is to be enabled (Enter q to

exit):2

Enter the IFF client key for the 10.77.46.203:

# ntpkey_iffpar_ccm203.3705887848

# Thu Jun 8 10:47:28 2017

-----BEGIN PRIVATE KEY-----

MIGzAgEAMIGoBgcqhkjOOAQBMIGcAkEA4r3EkDFdP05QSpzVpGHnZN3JgOkW0Ch9

erxLB7zSxrwNdnDIlWg5bUhZZWKZceQd/nyD6FLpZNFrpHnylkBUgQIVAJEjgjZM

r2aaMGSN5x2yUmhT4MqNAkBp2gkQNi8sluLre0YKyc+kdICiRkEK2jKwBETXs7Mh

aEd/c4DQnZkd5U9gco4v9zPpsfPOqftvymVyVmRyKX0NBAMCAQE=

-----END PRIVATE KEY-----

The Client key does not match the hostname of the selected NTP server. This could be because

a DNS server is not configured or the DNS entry for this host is not present.

Please verify the client key uploaded corresponds to the selected NTP server and that the

DNS configuration is correct.

Do you want to continue with this operation?<yes/no>:

Client key uploaded succesfully

Restarting NTP service.

Please run 'utils ntp auth auto-key status' to check the status of NTP authentication.

The above user warning prompt is not displayed, if the DNS server is able to resolve the hostname

of the selected NTP server and if it matches with the hostname in the client key provided.

Note

admin:utils ntp auth auto-key status - View status when NTP authentication is enabled

1.10.78.83.146 : NTP Authentication is disabled.

2.10.77.46.203 : NTP Authentication is enabled.

3.10.77.32.92 : NTP Authentication is disabled.

Select the server for which auto-key based NTP authentication details is to be displayed

(Enter q to exit):

NTP public certificate:

# ntpkey_RSA-SHA1cert_ccm-90.3708840303

# Wed Jul 12 14:55:03 2017

-----BEGIN CERTIFICATE-----

MIICwTCCAamgAwIBAgIFAN0QaW8wDQYJKoZIhvcNAQEFBQAwETEPMA0GA1UEAxMG

Y2NtLTkwMB4XDTE3MDcxMjA5MjUwM1oXDTE4MDcxMjA5MjUwM1owETEPMA0GA1UE

AxMGY2NtLTkwMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv0no6hNu

C88VXyCkMCJ6w6hny7eG6JU8LzEjMIN5aqD0FDjnRzIKK/DL5DMReRy4j/4YQTR7

nT9ThudFwyUu0y86OpPWBgfKeII6kjtkElo4mp8RyMLJDp4e0jOh63wCP0cJsdZ1

dXfvx0/OjK6ZdX7OeHtcZn2ycLkSZP6hkos6Un//5zfu1IG47QEliIh3bpPWq647

JiHELeuigcNm2plLSorXgmA3LFBI99pamwFl9Lmqb49y0Ie/QchXhudOOsG0zuaL

PaEnkPdyNtxvQbCQ24cVBmHup7UBkdZYA+5unpbczMzzE3tQsl/CvizmUbfA+/gi

/DWSBC4Hfc011QIDAQABoyAwHjAPBgNVHRMBAf8EBTADAQH/MAsGA1UdDwQEAwIC

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

315

Utils Commands

utils ntp auth auto-key

hDANBgkqhkiG9w0BAQUFAAOCAQEAttJbav0+qVPk9abAWlWcmhQUbjW58qrLE9A0

2ZvIvHKq2TyBAIxYcUSQQ3GXSwBDHKZUNSAzrFrTQ+vLFqFvoSH0o5EFruIdrwyn

zCD1OqNJXsCPsxyofSDuT/+pxvVxGXlcIpmDa2tieEUcdSvaGxol+ABhOO8YI6uf

bHNUCdjNSYbF6W0LMs643VSlNEUmBE4Tp+YWpLgbmXDXGa1wHlog5fZfnywk161J

n34asWwWmR467WADnPBfMJDWzU1GMceh1lXQ/gbYYX3+rpileAZF6x9Z/goexhNc

L4WyzBrlR7iueJ1wYdFZ5THXOat3bxWMWU4fDzqTWA7G9hpP6w==

-----END CERTIFICATE-----

Client Key:

# ntpkey_iffpar_ccm203.3705887848

# Thu Jun 8 10:47:28 2017

-----BEGIN PRIVATE KEY-----

MIGzAgEAMIGoBgcqhkjOOAQBMIGcAkEA4r3EkDFdP05QSpzVpGHnZN3JgOkW0Ch9

erxLB7zSxrwNdnDIlWg5bUhZZWKZceQd/nyD6FLpZNFrpHnylkBUgQIVAJEjgjZM

r2aaMGSN5x2yUmhT4MqNAkBp2gkQNi8sluLre0YKyc+kdICiRkEK2jKwBETXs7Mh

aEd/c4DQnZkd5U9gco4v9zPpsfPOqftvymVyVmRyKX0NBAMCAQE=

-----END PRIVATE KEY-----

admin:

admin:utils ntp auth auto-key disable-Disable NTP authentication

The List of NTP servers Configured:

1. 10.77.46.203

Enter the NTP server in which the authentication needs to be disabled(Enter q to exit): 1

NTP authentication has been disabled on 10.77.46.203

Restarting NTP

admin:

utils ntp server add

The command adds a maximum of five specified NTP servers.

utils ntp server add s1 [{s1s2s3s4s5}] [norestart]

Syntax Description

DescriptionParameters

Specifies the NTP servers.s1...

Causes the NTP service to not restart after you add the servers.norestart

Command Modes

Administrator (admin:)

Usage Guidelines

If you use norestart, an explicit restart of the NTP service is required for the changes to take effect.

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: Unified Communications Manager

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

316

Utils Commands

utils ntp server add

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]

Example: Attempting to Add a Server Using norestart Without Specifying a Server

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]

Example: Adding servers without 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.

Example: Adding Servers That Are Already Added, Without norestart

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

Example: Adding Server to Self Without norestart

admin: utils ntp server add bglr-ccm26

bglr-ccm26 : [This server cannot be added as an NTP server.]

Example: Adding Inaccessible Server Without norestart

admin: utils ntp server add clock3.cisco.com

clock3.cisco.com : [ Inaccessible NTP server. Not added. ]

Example: Adding Servers with norestart

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.

Example: Adding Servers When Five Are Already Configured

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

317

Utils Commands

utils ntp server delete

Usage Guidelines

This command allows you to delete a configured Network Time Protocol (NTP) server or multiple NTP

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

It is required to have at least 1 NTP server configured. Therefore, you cannot delete an NTP server if only

one is configured. If you select the option to delete all the NTP servers, the NTP servers are deleted in top

down order and the last NTP server on the list does not get deleted. The process is similar to the top down

order followed during utils ntp config or utils ntp status

Note

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: 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

Example: Deleting Single Server with NTP Restart

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.

Example: Deleting All Servers Without NTP Restart

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

318

Utils Commands

utils ntp server delete

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 : [The NTP server was not deleted. At least one NTP server is required.]

The NTP service will need to be restarted for the changes to take effect.

Example: Deleting All Servers When No Servers Are Configured

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.

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.

Note

utils ntp config

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

utils ntp restart

This command restarts the NTP service.

utils ntp restart

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

319

Utils Commands

utils ntp config

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager and IM and Presence Service on Unified Communications

Manager

utils ntp start

This command starts the NTP service if it is not already running.

You can not stop the NTP service from the command line interface. Use this command when the utils ntp

status command returns stopped.

Note

utils ntp start

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

utils ntp status

This command displays the current status of NTP.

utils ntp status

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

320

Utils Commands

utils ntp server list

Command Modes

Administrator (admin:)

Requirements

Command privilege level:

Allowed during upgrade:

Applies to: Unified Communications Manager and IM and Presence Service on 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.

The netdump commands have been removed from release 8.6(1) and have been replaced with the kerneldump

commands.

Note

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

321

Utils Commands

utils os kerneldump

Syntax Description

DescriptionParameters

Configures an external SSH server as a kerneldump server to kernel dumps.enable

Removes support of the external SSH server that is configured to collect kernel dumps.disable

Indicates whether an external SSH server is configured or not, to collect kernel dumps.status

Command Modes

Administrator (admin:)

Usage Guidelines

If external SSH server has the kerneldump service enabled and a kernel crash occurs, the capture kernel dumps

the core on the external server that is configured to collect the dump.

Enabling and disabling kerneldump require a system reboot for the changes to come into effect.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

utils os secure

This command is used to specify the level of security provided by selinux.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

322

Utils Commands

utils os kerneldump status

utils os secure {enforce | permissive | status}

Syntax Description

DescriptionParameters

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: Unified Communications Manager and IM and Presence Service on Unified Communications

Manager

utils os secure dynamic-policies compile

This command generates the selinux policy module and type enforcement that resolves the recorded denials

under the dynamic policy.

utils os secure dynamic-policies compile policy name

Syntax Description

DescriptionParameters

Type the dynamic policy name under which the compilation of the selinux policy module and

type enforcement is done.

policy

name

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

utils os secure dynamic-policies list

This command lists all the operating system dynamic policies with their statuses.

utils os secure dynamic-policies list

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

323

Utils Commands

utils os secure dynamic-policies compile

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

utils os secure dynamic-policies load

This command loads the selinux policy module for the dynamic policy into selinux. This command applies

new rules into selinux that prevent the denials that are recorded under the dynamic policy from reoccurring.

utils os secure dynamic-policies load policy name

Syntax Description

DescriptionParameters

Type the dynamic policy name that has a generated selinux policy module, which is not loaded

into selinux..

policy

name

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

utils os secure dynamic-policies remove

This command deletes all the data for the dynamic policy from the operating system. The data includes

unloading the policy module from selinux and deleting the generated policy module, type enforcements,

recorded denials, and delta logs.

utils os secure dynamic-policies remove policy name

Syntax Description

DescriptionParameters

Type the dynamic policy name that is unnecessary or no longer required.policy

name

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

324

Utils Commands

utils os secure dynamic-policies load

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

utils os secure dynamic-policies show

This command displays the rules to be introduced by loading the generated selinux policy module of the

dynamic policy. Run this command after the successful compilation to verify that the rules to be loaded are

secure.

utils os secure dynamic-policies show policy name

Syntax Description

DescriptionParameters

Type the dynamic policy name for which you want to view the rules.policy

name

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

utils os secure dynamic-policies start-recording

This command starts recording the selinux denials and organizes them under the new dynamic policy.

• This command sets the system into the permissive mode.

• The dynamic-policies are generated on a per-node basis. As a restriction, these policies cannot be exported

or imported. This restriction has the following advantages:

• Prevent loading external and unsigned policy modules into selinux that may create security

vulnerabilities.

• Prevent the transfer of policy modules between Unified Communications Manager clusters with

different configurations.

Note

utils os secure dynamic-policies start-recording policy name

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

325

Utils Commands

utils os secure dynamic-policies show

Syntax Description

DescriptionParameters

Type the dynamic policy name where the selinux denials and future policy data is to be organized.policy

name

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Manager

utils os secure dynamic-policies stop-recording

This command stops recording the selinux denials for the dynamic policy. This command switches the system

back to the original enforcement mode—either permissive mode or enforcing mode. This log generates a delta

log for all selinux denials that occurred between the start of the recording till it ends.

This command fails if the delta log has no new denials. Then, the dynamic policy is purged and you will have

to use this command again.

Note

utils os secure dynamic-policies stop-recording policy name

Syntax Description

DescriptionParameters

Type the dynamic policy name the recording of which you want to stop.policy

name

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager and IM and Presence Service on 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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

326

Utils Commands

utils os secure dynamic-policies stop-recording

utils PlatformWebAccess disable

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

327

Utils Commands

utils PlatformWebAccess enable

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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

328

Utils Commands

utils processCoreDumps disable

utils remote_account create

This command creates a remote account.

utils remote_account create

Command Modes

Administrator (admin:)

Usage Guidelines

A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the

system for the specified life of the account.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

329

Utils Commands

utils remote_account create

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 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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on 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 Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

330

Utils Commands

utils remote_account status

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

utils remotesyslog set protocol tls

This command configures the protocol for communication with the remote syslog server as Transport Layer

Security (TLS) 1.2 on the system. TLS 1.2 enables Unified Communications Manager and IM and Presence

Service to establish a secure connection with syslog servers. This enables Unified Communications Manager

and IM and Presence Service to comply with Common Criteria guidelines.

• Ensure that the syslog server supports TLS 1.2 protocols as a secure connection will be established only

if the syslog server supports TLS 1.2 protocols.

• In Common Criteria Mode, strict host name verification is implemented. Hence, it is required to configure

the server with a fully qualified domain name (FQDN) which matches the certificate.

Note

Restart the node for the changes to take effect.

utils remotesyslog set protocol tls

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 4

Allowed during upgrade: No

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

Manager

A security certificate has to be uploaded from the syslog server to the tomcat trust store on Unified

Communications Manager and IM and Presence Service.

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 Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

331

Utils Commands

utils remotesyslog set protocol tls

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

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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

and Cisco Unity Connection

utils reset_application_ui_administrator_password

This command resets the application user interface administrator password.

For password changes on IM and Presence nodes, stop the Cisco Presence Engine service in all IM and

Presence nodes before resetting the administrator password. After the password reset, restart Cisco Presence

Engine service in all the nodes. Make sure that you perform this task during maintenance because you may

face presence issues when the PE is stopped. If you change the password from IM and Presence nodes, make

sure the new password is same as the current administrator password in Unified Communication Manager.

Note

utils reset_application_ui_administrator_password

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

332

Utils Commands

utils reset_application_ui_administrator_name

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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

utils rosters list limited

Run this command on the database publisher node to obtain a count of invalid watchers and invalid contacts.

The total counts display in the CLI.

Command Modes

Administrator (admin:)

Usage Guidelines

We recommend that you run this command only during a maintenance window. This command will list only

the count and no details of the invalid records. For details on the invalid records, try utils rosters list [ watchers

| contacts | full.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: IM and Presence Service

utils rosters list full

Run this command on the database publisher node to write the details of all invalid watchers and invalid

contacts to a file. The command also displays the total counts in the CLI.

Command Modes

Administrator (admin:)

Usage Guidelines

We recommend that you run this command only during a maintenance window.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

333

Utils Commands

utils restore_application_ui_administrator_account

Applies to: IM and Presence Service

utils rosters list watchers

Run this command on the database publisher node to write the details of all invalid watchers in the cluster to

a file. The total count of invalid contacts also displays in the CLI.

Command Modes

Administrator (admin:)

Usage Guidelines

We recommend that you run this command only during a maintenance windows. While executing, progress

is displayed in the CLI as well as in a log file.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: IM and Presence Service

utils rosters list contacts

Run this command on the database publisher node to write the details of all invalid contacts in the cluster to

a file. The total count of invalid contacts also displays in CLI.

Command Modes

Administrator (admin:)

Usage Guidelines

We recommend that you run this command only during a maintenance window.

Requirements

Command privilege level: 4

Allowed during upgrade: No

Applies to: IM and Presence Service

utils rosters delete

Run this command on the database publisher node to delete all invalid watchers and invalid contacts in the

IM and Presence cluster.

Command Modes

Administrator (admin:)

Usage Guidelines

We recommend that you run this command only during a maintenance windows. While executing, progress

is displayed in the CLI as well as in a log file.

Requirements

Command privilege level: 4

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

334

Utils Commands

utils rosters list watchers

Allowed during upgrade: No

Applies to: IM and Presence Service

utils scheduled-task disable

This command disables the scheduled-task.

utils scheduled-task disable scheduled-task

Syntax Description

DescriptionParameters

Enter the name of the task that you need to disable.scheduled-task

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

utils scheduled-task enable

This command enables the scheduled-task.

utils scheduled-task enable scheduled-task

Syntax Description

DescriptionParameters

Enter the name of the task that you need to enable.scheduled-task

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

utils scheduled-task list

This command lists all the scheduled tasks.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

335

Utils Commands

utils scheduled-task disable

utils scheduled-task list

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

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: Unified Communications Manager, IM and Presence Service on 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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

336

Utils Commands

utils set urlpattern disable

utils service

This command activates, deactivates, starts, stops, or restarts a service.

utils service {activate | deactivate | start | stop | restart} service_name

Syntax Description

DescriptionParameters

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

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.

Note

service_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

utils service list

This command retrieves a list of all services.

utils service list [page]

Syntax Description

DescriptionParameters

Displays the output one page at a time.[page]

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

337

Utils Commands

utils service

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to: Unified Communications Manager and IM and Presence Service on 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

DescriptionParameters

Starts auto-restart.enable

Stops auto-restart.disable

Shows the status of a service.show

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

service-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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

338

Utils Commands

utils service auto-restart

utils service start

This command starts a service.

utils service start

Syntax Description

DescriptionParameters

Enter the name of a service, which can consist of multiple words.service

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence Service onUnified Communications Manager,

and Cisco Unity Connection

utils service stop

This command stops a service.

utils service stop

Syntax Description

DescriptionParameters

Enter the name of a service, which can consist of multiple words.service

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence Service onUnified 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}

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

339

Utils Commands

utils service start

Syntax Description

DescriptionParameters

Adds a new community string.add

Deletes a community string.delete

Lists all community strings.list

Updates a community string.update

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command

after execution until restart is complete. If the command is aborted during service restart, verify service status

of “SNMP Master Agent” by using utils service list. If service is down, start it by using utils service

start SNMP Master Agent

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Adds a notification destination.add

Deletes a notification destination.delete

Lists all notification destinations.list

Updates a notification destination.update

Command Modes

Administrator (admin:)

Requirements

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

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

340

Utils Commands

utils snmp config 1/2c inform

utils snmp config 1/2c trap

This interactive command affects trap notifications.

utils snmp config 1/2c trap {add | delete | list | update}

Syntax Description

DescriptionParameters

Adds a new v1/2c trap notification destination associated with a configured v1/2c community

string.

add

Deletes the configuration information for an existing v1/2c trap notification destination.delete

Lists the v1/2c trap notifications currently configured.list

Updates configuration information for an existing v1/2c trap notification destination.update

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: 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

DescriptionParameters

Adds a new v3 inform notification destination associated with a configured v3 username.add

Deletes the configuration information for an existing v3 inform notification destination.delete

Lists the v3 inform notifications currently configured.list

Updates configuration information for an existing v3 inform notification destination.update

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

341

Utils Commands

utils snmp config 1/2c trap

of “SNMP Master Agent” by using utils service list. If service is down, start it by using utils service

start SNMP Master Agent

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Adds the Mib2 configuration information.add

Deletes the Mib2 configuration information.delete

Lists the Mib2 configuration information.list

Updates the Mib2 configuration information.update

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

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

utils snmp config 3 trap

This interactive command affects trap notifications.

utils snmp config 3 trap {add | delete | list | update}

Syntax Description

DescriptionParameters

Adds a new v3 trap notification destination associated with a configured v3 username.add

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

342

Utils Commands

utils snmp config mib2

DescriptionParameters

Deletes the configuration information for an existing v 3 trap notification destination.delete

Lists the v3 trap notifications currently configured.list

Updates configuration information for an existing v3 trap notification destination.update

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Unified Communications Manager, IM and Presence Service on 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

DescriptionParameters

Adds a new v3 user with the v3 authentication and privacy passwords.add

Deletes the configuration information for an existing v3 user.delete

Lists the v3 users currently configured.list

Updates configuration information for an existing v3 user.update

Command Modes

Administrator (admin:)

Usage Guidelines

The system prompts you for the parameters.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

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

Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

343

Utils Commands

utils snmp config 3 user

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

DescriptionParameters

Specifies the SNMP version.

Possible values include 1, 2c or 3.

version

Specifies the SNMP community

string.

community

Specifies the IPv4/IPv6 address of

the server. Enter 127.0.0.0 to

specify the local host. You can

enter the IPv4/IPv6 address of

another node in the cluster to run

the command on that node.

ip-address

Specifies the SNMP Object ID

(OID) to get.

object

Specifies a file in which to save the

command output.

file

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 IPv4/IPv6 address of a remote host, the command gets executed on the remote host.

The IPv4/IPv6 address is required. You cannot use a domain name.

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

utils snmp get 1

This command gets the SNMP data using version 1 for the specified MIB OID.

utils snmp get 1 version

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

344

Utils Commands

utils snmp get

Syntax Description

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

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

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

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

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

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

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

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

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

345

Utils Commands

utils snmp get 2c

utils snmp get 3

This command gets the SNMP data for the specified MIB OID.

utils snmp get 3 version

Syntax Description

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

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

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

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

utils snmp hardware-agents

This command affects the SNMP agents on the server.

utils snmp hardware-agents {status | start | stop | restart}

Syntax Description

DescriptionParameters

Displays the status of the SNMP agents provided by the vendor of the hardware.

Only agents that provide status get displayed by this command. Not all hardware

agents provide status.

Note

status

Stops all SNMP agents provided by the hardware vendor.stop

Restarts all of the SNMP agents provided by the vendor of the hardware.restart

Starts all of the SNMP agents provided by the vendor of the hardware.start

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

346

Utils Commands

utils snmp get 3

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

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: Unified Communications Manager, IM and Presence Service on 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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

347

Utils Commands

utils snmp test

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

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

Specifies the SNMP Object ID (OID) to walkobject

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

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

For the below example, community string is created using the utils snmp config 1/2c

community-string command.

admin:utils snmp walk 1

ctrl-c: To quit the input.

Enter the community string:: public

Enter the ip address of the Server, use 127.0.0.1 for localhost.

Note that you need to provide the IP address, not the hostname.:: <enter the IP address of

your server>

The Object ID (OID):: iso.3.6.1.2.1.1.1.0

Enter parameter as "file" to log the output to a file. [nofile]::

This command may temporarily impact CPU performance.

Continue (y/n)?y

SNMPv2-MIB::sysDescr.0 = STRING: Linux release:3.10.0-1062.18.1.el7.x86_64 machine:x86_64

#####################################################################################################

utils snmp walk 2c -> same as utils snmp walk 1

#####################################################################################################

For the below example, user is created using

utils snmp config 3 user add

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

348

Utils Commands

utils snmp walk

utils snmp walk 3

admin:utils snmp walk 3

ctrl-c: To quit the input.

Enter the user name:: test

Enter the authentication protocol [SHA]:: SHA

Enter the authentication protocol pass phrase:: ********

Enter the privacy protocol [AES128]:: AES128

Enter the privacy protocol pass phrase:: ********

Enter the ip address of the Server, use 127.0.0.1 for localhost.

Note that you need to provide the IP address, not the hostname.:: <enter the IP address of

your server>

The Object ID (OID):: iso.3.6.1.2.1.1.1.0

Enter parameter as "file" to log the output to a file. [nofile]::

This command may temporarily impact CPU performance.

Continue (y/n)?y

SNMPv2-MIB::sysDescr.0 = STRING: Linux release:3.10.0-1062.18.1.el7.x86_64 machine:x86_64

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

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

Specifies the SNMP Object ID (OID) to walkobject

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

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

349

Utils Commands

utils snmp walk 1

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

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

Specifies the SNMP Object ID (OID) to walkobject

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

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

utils snmp walk 3

This interactive command walks through the SNMP MIB starting with the specified OID.

utils snmp walk 3 version

Syntax Description

DescriptionParameters

Specifies the SNMP version. Possible values include 1, 2c or 3.version

Specifies the SNMP community string.community

Specifies the SNMP Object ID (OID) to walkobject

Specifies the IPv4/IPv6 address of the server. Enter 127.0.0.0 to specify the local host. You can

enter the IPv4/IPv6 address of another node in the cluster to run the command on that node.

ip-address

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

350

Utils Commands

utils snmp walk 2c

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

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

DescriptionParameters

Specifies the IP address of the server under test.remote-ip

Specifies a username with access to the SOAP API.remote-https-user

Specifies the password for the account with SOAP API access.r emote-https-password

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

utils sso

This command provides information about SAML SSO authentication.

utils sso {enable | disable | status}

Syntax Description

DescriptionParameters

Provides the location in Cisco Unified CM Administration where you can enable SAML SSO.enable

Disables SAML SSO based authentication.disable

Provides the status of SAML SSO.status

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

351

Utils Commands

utils soap realtimeservice test

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

DescriptionParameters

Enables recovery URL for SAML SSO based authentication.enable

Disables recovery URL for SAML SSO based authentication.disable

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

352

Utils Commands

utils sso recovery-url

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

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.

If the server is forced to shutdown and restart from your virtual machine, the file system may become corrupted.

Caution

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

utils system switch-version

This command allows you to restart the system on the inactive partition.

utils system switch-version

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

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

and Cisco Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

353

Utils Commands

utils system shutdown

utils system boot

This command redirects where the system boot output gets sent.

utils system boot {console | serial}

Syntax Description

DescriptionParameters

Redirects the system boot output to the console.console

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

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 0

Allowed during upgrade: Yes

Applies to: 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

DescriptionParameters

Cancels the active upgrade.cancel

Starts a new upgrade wizard or assumes control of an existing upgrade

wizard. The wizard prompts you for the location of the upgrade file from

the source.

initiate

Displays the status of an upgrade.status

Command Modes

Administrator (admin:)

Usage Guidelines

The wizard prompts you to enter information about your upgrade:

• Credentials Information―Make sure that you have the credentials of the server on which the upgrade

image is saved. If you are not upgrading the Unified Communications Manager publisher node, and you

have previously upgrade this node, you can use download credentials from the publisher node. The default

value of the Use download credentials from Publisher is yes.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

354

Utils Commands

utils system boot

You can use download credentials from the publisher node only when you upgrade

individual cluster node. This option is not applicable for cluster-wide upgrade.

Note

• Upgrade file source―Enter the location for the server where your upgrade file is saved. You can upgrade

from a local source(CD or DVD), or you can use FTP or SFTP to download a remote upgrade file, or if

you want to resume an upgrade after a cancel operation, you can use the previously downloaded upgrade

file through the local image source option.

• Continue with upgrade after download―You must indicate whether you want the upgrade to proceed

automatically once the upgrade file is downloaded (the default value is yes). If you choose to upgrade

automatically, no checksum or SHA details get displayed. If you set the value of to yes or no, the setting

remains in the system.

• Version switching―You must indicate whether you want to switch to the new version automatically

once the upgrade completes (the default value is no). If you enter yes, the system switches to the new

version and reboots automatically after the upgrade completes. If you set the value to yes or no, the

setting remains in the system.

Requirements

Command privilege level: 0

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

Cisco Unity Connection.

If a cluster upgrade is in progress, and another upgrade is initiated using CLI, then the following message is

displayed:

A cluster upgrade is in progress. You can check the status of the cluster upgrade using the

CLI or GUI of the CUCM Publisher.

Note

Example:

admin:utils system upgrade initiate

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

Warning: A cluster upgrade is in progress. You can check the status of the cluster upgrade

using the CLI or GUI of the CUCM Publisher.

Use download credentials from Publisher(yes/no)[yes]:no

Source:

1) Remote Filesystem via SFTP

2) Remote Filesystem via FTP

3) Local DVD/CD

4) Local Image<UCSInstall_UCOS_12.5.0.98000-889.iso>

q) quit

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

Please enter SMTP Host Server (optional):

Checking for valid upgrades.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

355

Utils Commands

utils system upgrade

Please wait...

Available options and upgrades in "upgrade" directory:

1) UCSInstall_UCOS_12.5.0.98000-338.iso

q) quit

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

Accessing the file.

Please wait...

Validating the file...

A system reboot is required when the upgrade process completes or is canceled.

This will ensure services affected by the upgrade process are functioning properly.

Downloaded: UCSInstall_UCOS_12.5.0.98000-338.iso

File version: 12.5.0.98000-338

File checksum : (MD5): 8f:ce:0b:12:6b:d5:6f:d5:fd:25:d9:aa:12:d0:d5:30

(SHA512):

84ac0fd21723173ae89f1c01926a0852f46941c1785ae8e55dc8eb426dd9fb42fdc1ce07e0c9e3ac7bb01a4f7812f239fc38390dc2bc44d5161ebf13617c3050

Automatically switch versions if the upgrade is successful (yes/no): yes

Start installation (yes/no): yes

Example:

admin:utils system upgrade initiate

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

Use download credentials from Publisher (yes/no) [yes]:yes

Using publisher setting

Checking for valid upgrades. Please wait...

Available options and upgrades in "10.65.104.39:/var/sftp/uploads":

1.dp-ffr.3-1-7.NL.k3.cop q) quit

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

Example:

admin:utils system upgrade initiate

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

Use download credentials from Publisher(yes/no)[yes]:no

Source:

1) Remote Filesystem via SFTP

2) Remote Filesystem via FTP

3) Local DVD/CD

4) Local Image<UCSInstall_UCOS_12.5.0.98000-889.iso>

q) quit

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

Please enter SMTP Host Server (optional):

Continue with upgrade after download (yes/no) [yes]:

switch-version server after upgrade (yes/no) [no]

Checking for valid upgrades.

Please wait...

Available options and upgrades in "upgrade" directory:

1) UCSInstall_UCOS_12.5.0.98000-338.iso

q) quit

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

Accessing the file.

Please wait...

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

356

Utils Commands

utils system upgrade

Validating the file...

A system reboot is required when the upgrade process completes or is canceled.

This will ensure services affected by the upgrade process are functioning properly.

Downloaded: UCSInstall_UCOS_12.5.0.98000-338.iso

File version: 12.5.0.98000-338

Automatically switch versions if the upgrade is successful (yes/no): yes

Start installation (yes/no): yes

utils system upgrade cluster

This command allows you to install upgrades for cluster nodes (Unified Communications Manager and IM

and Presence) and Cisco Option Package (COP) files from both local and remote directories.

utils system upgrade cluster {initiate | cancel | status}

Syntax Description

DescriptionParameters

Cancels the active upgrade.cancel

Starts a new upgrade wizard or assumes control of an existing cluster

upgrade wizard.

This option allows you to perform a cluster-wide upgrade from the

Unified Communications Manager publisher.

This option is available only for the Unified Communications Manager

publisher and not for the Unified Communications Manager subscriber

or IM and Presence nodes.

initiate

Displays the status of an upgrade for each node in the cluster with the

following fields:

• Node—The hostname of the node.

• Role—The role of the node.

• Step—The current Step number or the Total number of steps to be

executed for upgrade completion.

• Description—The current component which is currently upgrading

for the particular node.

• Historical Time—The amount of time taken to complete the current

component/step for the respective node based on previous

clusterwide upgrade runs.

• Elapsed Time—The amount of time that passes from the start of

the current component/step to its finish for the respective node.

status

Command Modes

Administrator (admin:)

Usage Guidelines

The wizard prompts you to enter information about your upgrade:

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

357

Utils Commands

utils system upgrade cluster

• Credentials Information―Make sure that you have the credentials of the server on which the upgrade

image is saved.

• Upgrade file source―Enter the location for the server where your upgrade file is saved. You can upgrade

from a local source(CD or DVD), or you can use FTP or SFTP to download a remote upgrade file, or if

you want to resume an upgrade after a cancel operation, you can use the previously downloaded upgrade

file through the local image source option.

• Continue with upgrade after download―You must indicate whether you want the upgrade to proceed

automatically once the upgrade file is downloaded (the default value is yes). If you choose to upgrade

automatically, no checksum or SHA details get displayed. If you set the value of to yes or no, the setting

remains in the system.

• Version switching―You must indicate whether you want to switch to the new version automatically

once the upgrade completes (the default value is no). If you enter yes, the system switches to the new

version and reboots automatically after the upgrade completes. If you set the value to yes or no, the

setting remains in the system.

Requirements

Command privilege level: 0

Applies to: Unified Communications Manager on Unified Communications Manager.

If a single-node upgrade is in progress, and a cluster upgrade is initiated, then, the following message is

displayed:

failed (Local upgrade is in progress.)

If a single-node upgrade is in progress in Unified Communication Manager publisher, either using CLI or

User Interface, if you initiate a cluster upgrade using CLI, then the following message is displayed:

A Single-node upgrade is in progress. You can cancel the upgrade to initiate Cluster upgrade.

If a cluster upgrade session is in progress in Unified Communication Manager publisher either using User

Interface or CLI, if you initiate another cluster session using CLI, then the following message is displayed:

Another user session is currently configuring a cluster upgrade. Assume control (yes/no):

yes

Note

Example:

admin:utils system upgrade cluster initiate

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

Source:

1) Remote Filesystem via SFTP

2) Remote Filesystem via FTP

3) Local DVD/CD

4) Local Image<None>

q) quit

Please select an option (1 - 4 or "q" ): 1Directory [/home/image/BOTH]:

Server [10.65.104.19]:

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

358

Utils Commands

utils system upgrade cluster

User Name [image]:

Password [******]:

Please enter SMTP Host Server (optional):

Continue with upgrade after download (yes/no) [no]:

Switch-version cluster after upgrade [valid only for ISO] (yes/no) [no]:

Checking for valid upgrades. Please wait...

Available CUCM options and upgrades in "10.65.104.19:/home/image/BOTH":

1) UCSInstall_UCOS_12.5.0.98000-541.iso

2) UCSInstall_UCOS_UNRST_12.5.0.98000-541.iso

3) ciscocm.free_common_space_v1.1.cop

4) ciscocm.migrate-export-v1.20.cop.sgn

q) quit

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

Available IMP options and upgrades in "10.65.104.19:/home/image/BOTH":

1) UCSInstall_CUP_12.5.0.98000-661.iso

2) UCSInstall_CUP_UNRST_12.5.0.98000-661.iso

3) ciscocm.free_common_space_v1.1.cop

4) ciscocm.migrate-export-v1.20.cop.sgn

q) quit

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

Processing the cluster wide download ...

UCM1-PUB.ciscoctg.com Downloading..287mb

UCM1-SUB-1B.ciscoctg.com Downloading..115mb

UCM1-SUB-1A.ciscoctg.com Downloading..347mb

IMP1-SUB-1B.ciscoctg.com failed (Local upgrade is in progress.)

UCM1-SUB-2B.ciscoctg.com Downloading..490mb

IMP1-PUB.ciscoctg.com Downloading..55mb

UCM1-SUB-2A.ciscoctg.com failed

Exiting upgrade command. Please wait...

Example:

admin:utils system upgrade cluster initiate

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

Cluster upgrade is in progress. You may not take over the installation.

Source:

1) Remote Filesystem via SFTP

2) Remote Filesystem via FTP

3) Local DVD/CD

4) Local Image <UCSInstall_UCOS_12.5.0.98000-569.iso>

q) quit

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

Please enter SMTP Host Server (optional):

Continue with upgrade after download (yes/no) [no]: no

Switch-version cluster after upgrade [valid only for ISO] (yes/no) [no]: no

Checking for valid upgrades. Please wait...

Available CUCM options and upgrades in "upgrade" directory:

1) UCSInstall_UCOS_12.5.0.98000-569.iso

q) quit

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

Available IMP options and upgrades in "upgrade" directory:

1) UCSInstall_CUP_12.5.0.98000-695.iso

q) quit

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

359

Utils Commands

utils system upgrade cluster

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

Processing the cluster wide download ...

UCM1-SUB-1B.ciscoctg.com Download complete

UCM1-SUB-2A.ciscoctg.com Download complete

IMP1-SUB-1B.ciscoctg.com Download complete

UCM1-SUB-1A.ciscoctg.com Download complete

UCM1-PUB.ciscoctg.com Download complete

UCM1-SUB-2B.ciscoctg.com Download complete

IMP1-PUB.ciscoctg.com Download complete

Cluster wide Download complete

A system reboot is required when the upgrade process is complete or cancelled.

This will ensure the services affected by the upgrade process are functioning properly

Downloaded UCM Image: UCSInstall_UCOS_12.5.0.98000-569.iso

File version: 12.5.0.98000-569

File checksum : (MD5): 66:93:bc:4d:c5:ae:19:34:72:77:96:5a:be:1a:28:3d

(SHA512): fdaab4a67072528927a2a6c9600b761e086af4894ac0b

85221e731fea864567674f6ac2c806fb2a8a05d

fe31485ef92ca63f8f4d37448d30715c79bf2738dfd2

Downloaded IMP Image: UCSInstall_CUP_12.5.0.98000-695.iso

File version: 12.5.0.98000-695

File checksum : (MD5): 9e:f3:4e:e0:49:e3:c5:44:16:a5:f9:0e:8d:d5:a7:36

(SHA512): 57393dd5e70d43137d5ffb906fd815097f66a5a33e1fc

24bf4b6ed86894a6e0794f5f2165bc8395d2217

e24ae0b05b4d168b52ae480e5c9f7a29b7170f2ed92a

The IMP servers in the cluster must be rebooted after Unified CM publisher is switched

to the new version,even IF IMP servers are not being being upgraded

Automatically switch versions if the upgrade is successful (yes/no): no

Start installation (yes/no): yes

Cluster-wide upgrade has been initiated...

Node Role Step Description Historical time Elapsed

to complete Time

Ucm_Pub1 CUCM Publisher 1/15 Installing 1:37:13 00:07:14

IM&P_Pub1 IM&P Publisher 0/15 Waiting on Pub 1:20:13

Ucm_Sub1 CUCM Subscriber 0/15 Waiting on Pub 1:37:13

Cluster None overall Overall upgrade 4:34:26 00:07:14

utils system enableAdministration

Configuration changes are not permitted during an upgrade; however, you can use this command to enable

emergency provisioning during an upgrade.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

360

Utils Commands

utils system enableAdministration

Once you begin the upgrade process, configuration changes are not permitted until the upgrade is complete

and you have performed all of the post-upgrade tasks. Configuration changes include:

• changes made through any of the Unified Communications Manager or IM and Presence Service graphical

user interfaces (GUI), the command line interface (CLI), or the AXL API

• LDAP synchronizations, including incremental synchronizations that are pushed to Unified

Communications Manager from an Oracle LDAP

• automated jobs

• devices attempting to autoregister

Any configuration changes that you make during an upgrade may be lost, and some configuration changes

can cause the upgrade to fail.

Caution

utils system enableAdministration

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1 and 4

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.

Restart the phones after you execute the command. Not restarting the phones results in wrong DST start and

stop dates.

Caution

Requirements

Command privilege level: 0

Allowed during upgrade: No

Applies to Unified Communications Manager and IM and Presence Service.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

361

Utils Commands

utils update dst

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

DescriptionParameters

Validate the userid and directory URI values for all users in the nodes and clusters.all

Validate the userid value for all users in the nodes and clusters.userid

Validate the directory URI value for all users in the nodes and clusters.uri

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: IM and Presence Service on 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.

After the initial reboot, VMware Tools are in the running state. When you upgrade to a newer version of

VMware Tools, selinux may initially block the installation. In this case, the system still allows VMware Tools

to install, but a new dynamic policy is generated to suppress any additional selinux blockage. You can view

the new dynamic policy with the utils os secure dynamic-policies list command. For more information, see

the utils os secure dynamic-policies CLI command.

Note

This is applicable for native vmtools.

Note

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.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

362

Utils Commands

utils users validate

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 status

This command displays the type and the version of currently installed VMware Tools.

utils vmtools status

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

utils vmtools switch open

This command uninstalls the currently installed native VMware Tools and installs the open VMware Tools.

utils vmtools switch open

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

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

363

Utils Commands

utils vmtools status

utils vmtools switch native

This command uninstalls the currently installed open VMware Tools and installs the native VMware Tools.

utils vmtools switch native

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

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: Unified Communications Manager, IM and Presence Service on Unified Communications Manager,

Cisco Unity Connection

utils system upgrade dataexport initiate

This command exports the nodes configuration and user data to a remote SFTP server, for use in a later fresh

install with data import.

utils system upgrade dataexport initiate

Syntax Description

DescriptionParameters

Remote directoryExport Data Directory

Remote SFTPRemote Server Name or IP

Username of remote serverRemote Server Login ID

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

364

Utils Commands

utils vmtools switch native

DescriptionParameters

Password for remote serverRemote Server Password

Destination hostnameNew Hostname

Destination IPNew IP Address

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

This command should be executed on Publisher first followed by all subscriber nodes in the cluster. Same

SFTP Remote server details should be configured for all nodes in the cluster.

Note

utils system upgrade dataexport status

This command displays the status of the dataexport operation for this cluster node.

utils system upgrade dataexport status

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 upgrade dataexport cancel

This command cancels the ongoing dataexport operation.

utils system upgrade dataexport cancel

Command Modes

Administrator (admin:)

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

365

Utils Commands

utils system upgrade dataexport status

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 ucmgmt agent disable

This command will disable the agent, stop it from running, and prevent it from restarting.

utils ucmgmt agent disable

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 Unity Connection

Example

admin:utils ucmgmt agent disable

Stopping cloud_agent (via systemctl): [ OK ]

utils ucmgmt agent enable

This command will start the agent and enable the watchdog process to ensure that it is running.

utils ucmgmt agent enable

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:utils ucmgmt agent enable

Agent watchdog activated.

Agent will start up shortly(~ 5 minutes).

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

366

Utils Commands

utils ucmgmt agent disable

utils ucmgmt agent remove

This command will remove the agent and all of its configurations. This is equivalent to running the uninstall

cop file.

utils ucmgmt agent remove

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 Unity Connection

Example

admin:utils ucmgmt agent remove

Removing agent..

Starting removal of UC Management Agent

Agent removal complete.

utils ucmgmt agent restart

This command will restart a running agent immediately, and force the agent to register with the cloud service.

utils ucmgmt agent restart

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 Unity Connection

Example

admin:utils ucmgmt agent restart

Stopping agent..

Agent is restarting. Check agent status with 'utils ucmgmt agent status'.

utils ucmgmt agent status

This command display status information about the agent.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

367

Utils Commands

utils ucmgmt agent remove

utils ucmgmt agent status

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 Unity Connection

Example

admin:utils ucmgmt agent status

Agent Config Information:

Verification Code: ZUSXXXP9

Installed UCMGMT Agent version: 20210831-VOS

Agent's organization id: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Agent Runtime Information:

Agent process is not running.

To start up the agent, run 'utils ucmgmt agent restart'.

Agent process is enabled.

Agent watchdog is enabled.

Agent is not verified in Webex Control Hub.

utils ucmgmt agent verification

This command displays the verification code of the successfully installed agent.

utils ucmgmt agent verification

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 Unity Connection

Example

admin:utils ucmgmt agent verification

Verification Code: XXXXXXXX

utils ucmgmt config export

This command creates an agent configuration string for import into an unconfigured agent node.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

368

Utils Commands

utils ucmgmt agent verification

utils ucmgmt config export

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 Unity Connection

Example

admin:utils ucmgmt config export

Organization and proxy configuration processing complete.

This config can be imported into an unconfigured destination node by running (if available):

'utils ucmgmt config import [[2SedFCjFJiXYUuzwYrxf9mlY9FdH_....==]]'

utils ucmgmt config import

This command imports a configured agent and enables this agent. The agent still needs to be verified in Control

Hub.

utils ucmgmt config import

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 Unity Connection

Example

admin:utils ucmgmt config import

[[2SedFCjFJiXYUuzwYrxf9mlY9FdH_U2FsdGVkX18QtlFwVd4dYKIQqnlLLuvilAGRhTapcaKxWdEFPmhsWIzApSmrymrkYHJq4.....

HE0AUZBfkjBvDpnq5incYdS8SOPTfVilxcKk7x/BIzuSYAIpcRKu+uP6XNQ318z/KigrDClCN03Z+bjrCrxg6ySzrPzA=]]

Found compatible org in config (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX).

Configuration import is complete.

Agent service will auto-start in the next 5 minutes.

To start the UCMGMT agent immediately run 'utils ucmgmt agent restart'

utils ucmgmt organization

This command sets the Control Hub organization ID for the agent if it is not already set.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

369

Utils Commands

utils ucmgmt config import

utils ucmgmt organization

Syntax Description

DescriptionParameters

Organization ID can be found on the Control Hub. This is a mandatory field.organization_id

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 Unity Connection

Example

min:utils ucmgmt organization

XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

utils ucmgmt proxy add

This command will validate the cloud controller access by using the supplied proxy information. If successful,

the proxy is added to the ucmgmt proxy list.

utils ucmgmt proxy add

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 Unity Connection

Example

admin:utils ucmgmt proxy add http://proxy.proxy-example.com:8080 test

(Optional) Validating Proxy Password (won't display):

Re-enter Proxy Password (won't display):

Attempting to contact UCMGMT Cloud Controller... please wait (upto 30 seconds).

Successfully contacted controller.

{"serviceName": "Lookup Service", "serviceType":

"REQUIRED", "serviceState": "online", "message": "Healthy",

"lastUpdated": "2022-10-04T22:49:53", "upstreamServices": []}

Adding proxy.proxy-example.com:8080 to proxy list.

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

370

Utils Commands

utils ucmgmt proxy add

Example

admin:utils ucmgmt proxy add http://proxy.proxy-example.com:80

Attempting to contact UCMGMT Cloud Controller... please wait (upto 30 seconds).

Successfully contacted controller.

{"serviceName": "Lookup Service", "serviceType": "REQUIRED",

"serviceState": "online", "message": "Healthy",

"lastUpdated": "2022-10-06T17:10:30", "upstreamServices": []}

Adding http://proxy.proxy-example.com:80 to proxy list.

utils ucmgmt proxy clear

This command will clear all the proxies stored for this node.

utils ucmgmt proxy clear

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 Unity Connection

Example

admin:utils ucmgmt proxy clear

utils ucmgmt proxy force add

This command will add an unvalidated proxy to the agent configured. Proxy will be added to the ucmgmt

proxy list without access validation.

utils ucmgmt proxy force add

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 Unity Connection

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

371

Utils Commands

utils ucmgmt proxy clear

Example

admin:utils ucmgmt proxy force add http://staged.proxy.example.com:8080 user1

(Optional) Validating Proxy Password (won't display):

Re-enter Proxy Password (won't display):

Adding http://staged.proxy.example.com:8080 to proxy list.

Example

admin:utils ucmgmt proxy force add http://proxy.proxy-example.com:80

Adding http://proxy.proxy-example.com:80 to proxy list.

utils ucmgmt proxy list

This command lists all the proxies stored for this node. Authenticating proxy credentials listings will redact

passwords.

utils ucmgmt proxy list

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 Unity Connection

Example

admin:utils ucmgmt proxy list

"http://proxy.example.com:80"

"http://user1:<REDACTED>@staged.proxy.example.com:8080"

Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 12.5(1)SU4

372

Utils Commands

utils ucmgmt proxy list