command line interface reference guide for cisco unified presence 8.6

Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

April 30, 2013

The command line interface (CLI), which you can access from the console or through a secure shell connection to the server, provides a subset of the operating system functionality that is available through the operating system user interface.

This appendix describes the CLI commands that you can use on the Cisco Unified Operating System to perform basic operating system functions. The Cisco Unified Operating System Administration application also makes these functions available. Keep in mind that the CLI commands are designed for system emergencies and not as a replacement for the user interface. Typically, you would use the CLI only when a problem occurs while you are using the Cisco Unified Operating System Administration interface.

How to Work with the CLI, page 1 Delete Commands, page 4 File Commands, page 6 Set Commands, page 15 Show Commands, page 33 Unset Commands, page 55 Utils Commands, page 55 Related Documentation, page 87

How to Work with the CLIAmericas Headquarters:Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA

Starting a CLI Session, page 2 Completing Commands, page 2 Getting Help on Commands, page 3

How to Work with the CLI Exiting a Command with the Ctrl-C Key Sequence, page 4 Ending a CLI Session, page 4

Starting a CLI SessionYou can access the Cisco Unified Operating System remotely or locally:

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

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

Before You Begin

Ensure you have the following information that is defined during installation: A primary IP address and hostname An administrator ID A password

You will need this information to log in to the Cisco Unified Operating System.

Procedure

Step 1 Perform one of the following actions depending on your method of access:a. From a remote system, use SSH to connect securely to the Cisco Unified Operating System. In your

SSH client, enterssh adminname@hostnamewhere adminname specifies the Administrator ID and hostname specifies the hostname that was defined during installation. For example, ssh admin@ipt-1.

b. From a direct connection, you receive this prompt automatically:ipt-1 login:

where ipt-1 represents the host name of the system.Enter the administrator ID that was defined during installation.

Step 2 Enter the password that was defined at installation.The CLI prompt displays. The prompt represents the Administrator ID; for example:admin:You can now use any CLI command.

Completing CommandsTo complete commands, use Tab:2Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

How to Work with the CLI Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, set is completed.

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

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

Getting Help on CommandsYou can get two kinds of help about any command:

Detailed help that includes a definition of the command and an example of its use Short query help that includes only command syntax

Troubleshooting Tips

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

Example 1 Detailed Help Example:

admin:help file list activelog

activelog help:This will list active logging files

options are:page - pause outputdetail - show detailed listingreverse - reverse sort orderdate - sort by datesize - sort by size

file-spec can contain '*' as wildcards

Example:admin:file list activelog platform detail02 Dec,2004 12:00:59 drf02 Dec,2004 12:00:59 log

If you want to: At the CLI prompt:

Get detailed help Enterhelp commandWhere command specifies the command name or the command and parameter. See Example 1.

Query only command syntax Entercommand? Where command represents the command name or the command and parameter. See Example 2.3Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Delete Commands16 Nov,2004 21:45:43 8,557 enGui.log27 Oct,2004 11:54:33 47,916 startup.logdir count = 2, file count = 2

Example 2 Query Example:

admin:file list activelog?Syntax:file list activelog file-spec [options]file-spec mandatory file to viewoptions optional page|detail|reverse|[date|size]

Exiting a Command with the Ctrl-C Key SequenceYou can stop most interactive commands by entering the Ctrl-C key sequence, as shown in the following example:

Example 3 Exiting a Command with Ctrl-C

admin:utils system upgrade initiateWarning: Do not close this window without first exiting the upgrade command.Source:1) Remote Filesystem2) DVD/CDq) quitPlease select an option (1 - 2 or "q" ):Exiting upgrade command. Please wait...Control-C pressedadmin:

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

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

Delete Commands delete account, page 4 delete dns, page 5 delete process, page 5 delete smtp, page 6

delete accountThis command allows you to delete an administrator account.4Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Delete CommandsCommand Syntax

delete account account-name

Parameters

account-nameRepresents the name of an administrator account.

Requirements

Command privilege level: 4Allowed during upgrade: No

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

Command Syntax

delete dns ip-address

Parameters

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

Usage Guidelines

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

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

Requirements


delete processThis command allows you to delete a particular process.

Command Syntax

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

process-idRepresents the process ID number.

Options

forceCauses the process to stop terminateCauses the operating system to terminate the process crashCrashes the process and produces a crash dump5Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File CommandsUsage Guidelines

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

Requirements

Command privilege level: 1Allowed during upgrade: Yes

delete smtpThis command allows you to delete the SMTP host.

Command Syntax

delete smtp

Requirements


File Commands file check, page 6 file delete, page 7 file dump, page 8 file fragmentation sdl, page 9 file get, page 9 file list, page 10 file search, page 11

file tail, page 12 file view, page 13

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

Command Syntax

file check [detection-size-kb]6Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File CommandsOptions

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

Usage Guidelines

The command notifies you about a possible impact to system performance and requests confirmation that you want to continue.

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

The display includes both deleted and new files.

Defaults

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

Requirements


file deleteThis command deletes one or more files.

Command Syntax

file deleteactivelog directory/filename {detail | noconfirm}inactivelog directory/filename {detail | noconfirm}install directory/filename {detail | noconfirm}license directory/filename {detail | noconfirm}

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. directory/filenameSpecifies the path and filename of the file(s) to delete. You can use the wildcard

character, *, for filename.

Options

detailDisplays a listing of deleted files with the date and time. noconfirmDeletes files without asking you to confirm each deletion.7Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File CommandsUsage Guidelines

Caution You can only recover a deleted file using the Disaster Recovery System.

Requirements


Example

The following example deletes the install log.file delete install install.log

The following example deletes the license file.file delete license .lic

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

Command Syntax

file dumpactivelog directory/filename [detail] [hex]inactivelog directory/filename [detail] [hex]install directory/filename [detail] [hex]

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. directory/filenameSpecifies the path and filename of the file to dump. You can use the wildcard

character, *, for filename as long as it resolves to one file.

Options

detailDisplays listing with the date and time hexDisplays output in hexadecimal

Requirements

Command privilege level: 1 for logs, 0 for TFTP filesAllowed during upgrade: Yes

Example

This command dumps contents of file _cdrIndex.idx.file dump activelog cm/cdr/_cdrIndex.idx8Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File Commandsfile fragmentation sdlThis command displays file fragmentation information about SDL log files.

Command Syntax

file fragmentation sdlall outfilenamefile filename {verbose}most fragmented numbermost recent number

Parameters

allRecords information about all files in the directory in the file that is specified by outfilename. fileDisplays information about the file that is specified by filename. most fragmentedDisplays information about the most fragmented files. most recentDisplays information about the most recently logged fragmented file. numberSpecifies the number of files to list.

Options

verboseDisplays more detailed information

Requirements


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

Command Syntax

file getactivelog directory/filename [reltime] [abstime] [match] [recurs]inactivelog directory/filename [reltime] [abstime] [match] [recurs]install directory/filename [reltime] [abstime] [match] [recurs]

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. directory/filenameSpecifies the path to the file(s) to delete. You can use the wildcard character, *,

for filename as long as it resolves to one file.9Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File CommandsOptions

abstimeAbsolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY reltimeRelative time period, specified as minutes | hours | days | weeks | months value matchMatch a particular string in the filename, specified as string value recursGet all files, including subdirectories

Usage Guidelines

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

Requirements


Examples

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

This command gets all operating system log files for a particular time period.file get activelog platform/log abstime 18:00:9/27/2005 18:00:9/28/2005

file listThis command lists the log files in an available log directory.

Command Syntax

file listactivelog directory [page] [detail] [reverse] [date | size]inactivelog directory [page] [detail] [reverse] [date | size]install directory [page] [detail] [reverse] [date | size]license directory [page] [detail] [reverse] [date | size]

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. directorySpecifies the path to the directory to list. You can use a wildcard character, *, for

directory as long as it resolves to one directory.

Options

detailLong listing with date and time dateSort by date sizeSort by file size reverseReverse sort direction10Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File Commands pageDisplays the output one screen at a time.

Requirements

Command privilege level: 1 for logsAllowed during upgrade: Yes

Examples

This example lists operating system log files with details.file list activelog platform/log page detail

This example lists directories in CDR repository.file list activelog cm/cdr_repository

This example lists CDR files in a specified directory by size.file list activelog cm/cdr_repository/processed/20050812 size

This example lists the names of the licenses.file list license *

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

Command Syntax

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

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. reg-expRepresents a regular expression.

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

Options

abstimeSpecifies which files to search based on file creation time. Enter a start time and an end time.

days|hours|minutesSpecifies whether the file age is in days, hours, or minutes. ignorecaseIgnores case when searching.11Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File Commands reltimeSpecifies which files to search based on file creation time. Enter the age of files to search. hh:mm:ss mm/dd/yyyyAn absolute time, in the format hours:minutes:seconds month/day/year. timevalueThe age of files to search. Specify the unit of this value with the {days | hours |

minutes} option.

Usage Guidelines

Write the search term in the form of a regular expression, which is a special text string for describing a search pattern.If the search term is found in only one file, the filename appears at the top of the output. If the search term is found in multiple files, each line of the output begins with the filename in which the matching line was found.

Requirements


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

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

Command Syntax

file tailactivelog directory/filename [detail] [hex] [lines]inactivelog directory/filename [detail] [hex] [lines]install directory/filename [detail] [hex] [lines]

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. directory/filenameSpecifies the path to the file to tail. You can use the wildcard character, *, for

filename as long as it resolves to one file.

Options

detailLong listing with date and time hexHexadecimal listing linesNumber of lines to display

Requirements

Command privilege level: 1 for logsAllowed during upgrade: Yes12Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File CommandsExample

This example tails the operating system CLI log file.file tail activelog platform/log/cli00001.log

file viewThis command displays the contents of a file.

Command Syntax

file viewactivelog directory/filenameinactivelog directory/filenameinstall directory/filenamelicense directory/filename

Parameters

activelogSpecifies a log on the active side. inactivelogSpecifies a log on the inactive side. installSpecifies an installation log. directory/filenameSpecifies the path to the file to view. You can use the wildcard character, *, for

filename as long as it resolves to one file.

Usage Guidelines

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

Requirements


Examples

This example displays the install log.file view install install.log

This example displays a particular CDR file.file view activelog /cm/cdr_repository/processed/20058012/{filename}

This example displays the contents of the license file.file view license .lic

Run Commands run pe sql, page 1413Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

File Commands run sql, page 15

run pe sql

Cisco Unified Presence Release 8.6(3) and Earlier

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

Command Syntax

run pe sql database-name sql-statement

Parameters

database-nameRepresents the name of the TimesTen datastore. sql_statementRepresents the SQL command to run.

Example

This example runs an SQL command against the TimesTen datastore.run pe sql tthard select * from package

Requirements


Cisco Unified Presence Release 8.6(4) and Later

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

Command Syntax

run pe sql datastore-name sql-statement

Parameters

datastore-nameRepresents the name of the datastore. sql_statementRepresents the SQL command to run.

Example

This example runs an SQL command against the datastore.run pe sql ttroute select * from route

Requirements

Command privilege level: 1Allowed during upgrade: Yes14Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commandsrun sqlThis command allows you to run an SQL command.

Command Syntax

run sql sql_statement

Parameters

sql_statementRepresents the SQL command to run.

Requirements


Example

This example runs an SQL command.run sql select name from device

Set Commands set account, page 16 set cert, page 16 set cli pagination, page 17 set cli session timeout, page 17

set csr gen, page 18 set commandcount, page 18 set logging, page 18 set network, page 19 set password, page 23 set password complexity character, page 24 set password complexity character difference, page 25 set password complexity character max-repeat, page 25 set password complexity minimum-length, page 26 set password expiry, page 26 set replwatcher monitor, page 28 set smtp, page 28 set strace, page 28 set timezone, page 29 set trace, page 30 set webapp session timeout, page 31 set web-security, page 3115Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commands set workingdir, page 32

set accountThis command sets up a new account on the operating system.

Command Syntax

set account name

Parameters

nameRepresents the username for the new account.

Usage Guidelines

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

Requirements


set certThis command affects the certificates available in the preconfigured SFTP location.

Command syntax

set cert

delete unitnameCommand privilege level:1Allowed during upgrade:Yes

import [type][name][caCert]Command privilege level: 1Allowed during upgrade: Yes

regen [name]Command privilege level: 1Allowed during upgrade: No

Parameters

deleteDeletes the specified file from the specified unit. importImports the specified certificate for the specified certificate type. regenRegenerates the certificate for the specified unit.

Options

type(mandatory) Specifies the certificate type.16Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commands unit (mandatory) Specifies the name of the trust category, as own or trust. name(mandatory) Represents the unit name. caCert(optional) Represents the name of the CA certificate.

Delete Exampleadmin: set cert delete [cup] [ siptest.pem](Successfully deletes the certificate siptest.pem from the cup trust category)

Import Exampleadmin: set cert import trust tomcatSuccessfully imported certificate for tomcat.Please restart services related to tomcat for the new certificate to become active.

Regen Exampleadmin: set cert regen tomcatSuccessfully regenerated certificate for tomcat.

Requirements

Command privilege level:1Allowed during upgrade:Yes

set cli paginationFor the current CLI session, this command turns automatic pagination On or Off.

Command Syntax

set cli pagination {on | off}Requirements


Exampleadmin:set cli pagination offAutomatic pagination is turned off

set cli session timeoutThis command sets the time, in minutes, after which an active CLI session times out and disconnects.Be aware that the new session timeout value becomes effective immediately for a new CLI session; however, active sessions retain their original timeout value. Also the show cli session timeout command reflects the new value, even if the current session does not use that value.

Note This setting gets preserved through a software upgrade and does not get reset to the default value.17Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsCommand Syntax

set cli session timeout minutes

Parameters

minutesSpecifies the time, in minutes, that can elapse before an active CLI session times out and disconnects (value range is 5-99999 minutes and default value is 30 minutes).

Requirements


set csr genThis command regenerates the Certificate Signing Request (CSR) for the specified unit.

Command Syntax

set csr gen unitname

Parameters

unitnameSpecifies the unit on which the certificate is generated.

Exampleadmin:set csr gen tomcatSuccessfully generated CSR for tomcat

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

Command Syntax

set commandcount {enable | disable}Parameters

enableTurns on command count. disableTurns off command count.

Requirements


set loggingThis command allows you to enable or disable logging.18Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsCommand Syntax

set logging {enable | disable}Parameters

enableTurns on logging. disableTurns off logging.

Requirements


set network This command allows you to configure how your system is connected to the network.

Command Syntax

set network

dhcp eth0 {enable | disable} node_ip net_mask gateway_ipCommand privilege level: 1Allowed during upgrade: No

dns {primary | secondary} ip-addressCommand privilege level: 1Allowed during upgrade: No

dns options [timeout seconds] [attempts number] [rotate]Command privilege level: 0Allowed during upgrade: Yes

domain domain-nameCommand privilege level: 1Allowed during upgrade: No

failover {enable | disable}Command privilege level: 1Allowed during upgrade: No

gateway ip-addressCommand privilege level: 1Allowed during upgrade: No

hostname hostnameCommand privilege level: 1Allowed during upgrade: No

ip eth0 ip-address ip-mask gateway_ipCommand privilege level: 119Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsAllowed during upgrade: Nomtu mtu_max


max_ip_conntrack ip_conntrack_maxCommand privilege level: 1Allowed during upgrade: No

nic eth0 [auto en | dis] [speed 10 | 100] [duplex half | full]Command privilege level: 1Allowed during upgrade: No

pmtud [enable | disable]Command privilege level: 1Allowed during upgrade: No

restore eth0 ip-address network-mask gatewayCommand privilege level: 0Allowed during upgrade: Yes

status eth0 {up | down}Command privilege level: 1Allowed during upgrade: No

Parameters

dhcp eth0Enables or disables DHCP for Ethernet interface 0. You cannot configure Ethernet interface 1. If you continue, this command causes the system to restart.

enableEnables DHCP, Network Fault Tolerance or Path MTU Discovery. disableDisables DHCP, Network Fault Tolerance or Path MTU Discovery. node_ipRepresents the new static IP address for the server. net_maskRepresents the subnet mask for the server. gateway_ipRepresents the IP address of the default gateway. dnsSets the IP address for the primary or secondary DNS server. ip-addressRepresents 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.

dns optionsSets DNS options. domainSets the domain name for the system. If you add, delete or change the domain name using

this command, you must regenerate certificates and reboot the server. See the Troubleshooting Tips for more information.

domain-nameRepresents the system domain that you want to assign. If you add, delete or change the domain name using this command, you must regenerate certificates and reboot the server. See the Troubleshooting Tips for more information.20Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commands failoverEnables and disables Network Fault Tolerance on the Media Convergence Server network interface card.

gatewayEnables you to configure the IP address of the network gateway. hostnameSets the network hostname and then causes a restart of the system. hostnameRepresents the hostname that you wish to assign. ip eth0Sets the IP address for Ethernet interface 0. You cannot configure Ethernet interface 1.

Cisco Unified Presence does not support changing the IP address. If you change the IP address, Cisco Unified Presence may not function properly.

ip-maskRepresents the IP mask that you want to assign. mtuSets the maximum MTU value. mtu_maxSpecifies the maximum MTU value. If you continue, the system will temporarily lose

network connectivity.

max_ip_conntrack Sets the ip_conntrack_max value. ip_conntrack_maxSpecifies the value for ip_conntrack_max. nic eth0Sets the properties of the Ethernet Interface 0. You cannot configure Ethernet interface

1.You can enable only one active NIC at a time. If you continue, this command causes a temporary loss of network connections while the NIC is reset.

network_maskRepresents the subnet mask for the server. pmtudEnables and disables Path MTU Discovery. If you continue, the system will temporarily

lose network connectivity. restoreConfigures the specified Ethernet port to use a specified static IP address. Only use this

command option if you cannot restore network connectivity by using any other set network commands. This command deletes all previous network settings for the specified network interface, including Network Fault Tolerance. After running this command, you must restore your previous network configuration manually. The server temporarily loses network connectivity when you run this command. The IP address must be a valid IP address to be assigned to this server.

statusSets the status of Ethernet 0 to up or down. You cannot configure Ethernet interface 1

Options

timeoutSets the DNS request timeout. secondsSpecifies the DNS timeout period, in seconds. attemptsSets the number of times to attempt a DNS request before quitting. numberSpecifies the number of attempts. rotateCauses the system to rotate among the configured DNS servers, distributing the load. autoSpecifies whether auto negotiation is enabled or disabled. speedSpecifies whether the speed of the Ethernet connection: 10 or 100 Mbps. duplexSpecifies half-duplex or full-duplex.

Examples

Example: set network hostname

admin:set network hostname myname

W A R N I N G 21Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsThis will cause the system to restart - Do you want to continue ?Enter "yes" to continue and restart or any other key to abortyesexecuting...Broadcast message from root (Thu Jun 24 13:00:21 2008):

The system is going down for restart NOW!

Example: set network mtuadmin: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

yesexecuting...

Example: set network pmtud

admin:set network pmtud enable W A R N I N G This will cause the system to temporarily lose network connectivity

Do you want to continue ?

Enter "yes" to continue or any other key to abortyesexecuting...admin:

Example: set network restore eth0

Exampleset network restore eth0 10.94.150.108 255.255.255.0 10.94.150.1

Troubleshooting Tips

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 relevant chapter of the Cisco Unified Operating System Maintenance 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. 22Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsUsage Guidelines

If you change the NIC speed, NIC duplex, hostname, DHCP, IP address, IP mask, gateway, or primary DNS, the license MAC value will change if the server is hosted on virtual hardware. You must request a new license with the new license MAC value, upload the new license, and restart the License Manager. Cisco recommends that you delete the old license before you request a new one. For more information, see the Installation Guide for Cisco Unified Presence, Release 8.6.

set passwordThis command allows you to change the administrator and security passwords.

Command Syntax

set password age {maximum days| minimum days}

age maximum: Command privilege level: 1Allowed during upgrade: Noage minimum: Command privilege level:1Allowed during upgrade:Yes

age {user admin | user security}Command privilege level: 1Allowed during upgrade: No

history numberCommand privilege level:1Allowed during upgrade:Yes

Parameters

maximumSets the value of the maximum password age for Cisco Unified Operating System administrator accounts in days.

minimum Sets the value of the minimum password age for Cisco Unified Operating System administrator accounts in days.

daysSpecifies the minimum password age, with acceptable values of between 0 - 10. Specifies the maximum password age, which must be greater-than or equal-to 90 days.

user adminSets a new administrator password. user securitySets a new platform security password. The security password on all nodes in a

cluster must match, including Cisco Unified Communication Manager and all Cisco Unified Presence nodes. Once the password has been changed on Cisco Unified Communication Manager, it must be retyped on the Cisco Unified Presence Admin pages in System->Cisco Unified Communication Manager Publisher for the communication to re-establish.

historySpecifies the number of passwords that are maintained in the history for Cisco Unified Operating System Administrator accounts. New passwords matching remembered passwords are rejected

numberSpecifies the number of passwords (mandatory) to maintain in history To disable, enter 0.23Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commands Default specifies 10. Upper limit specifies 20.

Usage Guidelines

The systems prompts you for the old and new passwords.

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

set password complexity character

Note This command only applies to Cisco Unified Presence Release 8.6(4) and later.

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

Command Syntax

set password complexity character {enable|disable} [num-chars]Parameters

enableTurns on password complexity for character types disableTurns off password complexity for character types

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

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

Note After you enable password complexity, this command also enables password history if it has not already been enabled (for more information, see the set password 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 the command.

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 lowercase characters. 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.24Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

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


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.

Command syntax

set password complexity character difference num-chars

Parameters

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

Note The maximum password length is 31 characters.

Usage Guidelines

Enter 0 to indicate no difference.

Requirements


set password complexity character max-repeat


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

Command syntax

set password complexity character max-repeat num-repeat25Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsParameters

num-repeat specifies the number of times you can consecutively repeat a single character in a new password. Value range: 0-10 Default value: 0 (disabled)

Requirements


set password complexity minimum-length


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

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

Command Syntax

set password complexity minimum-length length

Parameters

length specifies the minimum number of characters. If password character complexity (see set password complexity character) has been enabled at least once on the system, the value must be greater-than or equal-to 8. Otherwise, if password character complexity has never been enabled on the system, the value must be greater-than or equal-to 6.

Requirements


set password expiryThis command enables or disables password expiry and minimum/maximum age settings for Cisco Unified Operating System Administrator accounts.

Command Syntax

set password expirymaximum- age {enable | disable}minimum- age {enable | disable} user maximum- age {enable | disable} useriduser minimum- age {disable | enable} userid26Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx


enableTurns on password expiry and minimum/maximum age settings for the specified Cisco Unified Operating System administrator account. 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.

disableTurns off password expiry and minimum/maximum age settings for the specified Cisco Unified Operating System administrator account. The set password expiry disable command results in Cisco Unified Operating System Administrator accounts never expiring.

maximum-ageDisplays the value of the maximum password age for Cisco Unified Operating System administrator accounts in days.

minimum-age Displays the value of the minimum password age for Cisco Unified Operating System administrator accounts in days.

daysSpecifies the minimum password age, with acceptable values of between 0 - 3650 (10 years). Specifies the maximum password age, which must be greater-than or equal-to 90 days.

user maximum-age Enables or disables the maximum age password expiry for a particular Cisco Unified Operating System Administrator account.

user minimum-ageEnables or disables the minimum age password expiry for a particular Cisco Unified Operating System Administrator account.

useridSpecifies a particular Cisco Unified Operating System Administrator account.

Requirements


Enable Examplesadmin:set password expiry maximum-age

Operation Successful.

admin: set password expiry maximum-age enable


Disable Exampleadmin: set password expiry maximum-age disable


User Examplesadmin:set password expiry user


admin:set password expiry user maximum-age enable

Operation Successful.27Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

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

Command Syntax

set commandcount {enable | disable}Parameters

enableTurns on the replication monitoring service. disableTurns off the replication monitoring service.

Requirements


set smtpThis command sets the SMTP server hostname.

Command Syntax

set smtp hostname

Parameters

hostnameRepresents the SMTP server name.

Usage Guidelines

If you change the SMTP location, the license MAC value will change if the server is hosted on virtual hardware. You must request a new license with the new license MAC value, upload the new license, and restart the License Manager. Cisco recommends that you delete the old license before you request a new one. For more information, see the Installation Guide for Cisco Unified Presence, Release 8.6.

Requirements


set straceThis command enables or disables the service trace and sets the trace level.

Command Syntax

set strace

enable [all] tracevalue servicenamedisable [all] servicename28Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx


[all] Optional parameter to propagate the service trace setting change (enable/disable) to all nodes.

tracevalueAllowed trace values are [ Info| Debug | Warn | Error | Fatal] servicenameRepresents the service for which the trace is set (enabled/disabled)

Requirements


Enable Examplesadmin: set strace enable Info Cisco UP Sync Agent


admin:set strace enable all Debug Cisco UP SIP Proxy


Disable Exampleadmin: set strace disable Cisco UP Sync Agent


admin:set strace disable all Cisco UP SIP Proxy


set timezoneThis command lets you change the system time zone.

Command Syntax

set timezone timezone

Parameters

timezoneSpecifies the new timezone.

Usage Guidelines

Enter characters to uniquely identify the new time zone. Be aware that the timezone name is case-sensitive.If you change the primary nodes time zone, the license MAC value will change if the server is hosted on virtual hardware. You must request a new license with the new license MAC value, upload the new license, and restart the License Manager. Cisco recommends that you delete the old license before you request a new one. For more information, see the Installation Guide for Cisco Unified Presence, Release 8.6.

Caution You must restart the system after you change the timezone.29Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set CommandsRequirements


Example

This example sets the time zone to Pacific time.set timezone Pac

set traceThis command sets trace activity for the specified task.

Command Syntax

set trace

enable Error tnameenable Special tnameenable State_Transition tnameenable Significant tnameenable Entry_exit tnameenable Arbitrary tnameenable Detailed tnamedisable tname

Parameters

tnameRepresents the task for which you want to enable or disable traces. enable ErrorSets task trace settings to the error level. enable SpecialSets task trace settings to the special level. enable State_TransitionSets task trace settings to the state transition level. enable SignificantSets task trace settings to the significant level. enable Entry_exit Sets task trace settings to the entry_exit level. enable ArbitrarySets task trace settings to the arbitrary level. enable DetailedSets task trace settings to the detailed level. disableUnsets the task trace settings.

Requirements

Command privilege level: 1Allowed during upgrade: No30Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commandsset webapp session timeoutThis command sets the time, in minutes, that can elapse before a web application, such as Cisco Unified Presence Administration, times out and logs off the user. For the new webapp session timeout to become effective, you must restart the Cisco Tomcat service. This command prompts you to restart the service.

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

Tip Until you restart the Cisco Tomcat service, the show webapp session timeout command reflects the new values, but the system continues to use and reflect the old values.

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

Note This command is only supported in Cisco Unified Presence 8.6(4) and later.

Command Syntax

set webapp session timeout minutes

Parameters

minutesSpecifies the time, in minutes, that can elapse before a web application times out and logs off the user (Value range is 5-99999 minutes and default value is 30 minutes)

Requirements


set web-securityThis command sets the web security certificate information for the operating system.

Command Syntax

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

Parameters

orgunitRepresents the organizational unit (OU) name.

Tip You can use this command to enter multiple organizational units. To enter more than one organizational unit name, separate the entries with a comma. For entries that already contain a comma, enter a backslash before the comma that is included as part of the entry. To enter multiple values for organizational unit, enclose them in quotation marks, as shown in the example for this command.31Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Set Commands orgnameRepresents the organizational name. localityRepresents the organization location. stateRepresents the organization state. country (optional)Represents the organization country. alternatehostname (optional) Specifies an alternate name for the host when you generate a

web-server (Tomcat) certificate.

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

Usage Guidelines

If you change the certificate information, the license MAC value will change if the server is hosted on virtual hardware. You must request a new license with the new license MAC value, upload the new license, and restart the License Manager. Cisco recommends that you delete the old license before you request a new one. For more information, see the Installation Guide for Cisco Unified Presence, Release 8.6.

Requirements


Example

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

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

In the above example, the certificate will have three OU fields: OU=accounting OU=personnel, CA OU=personnel, MA

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

Command Syntax

set workingdiractivelog directoryinactivelog directoryinstall directory32Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show CommandsParameters

activelogSets the working directory for active logs. inactivelogSets the working directory for inactive logs. installSets the working directory for installation logs. directoryRepresents the current working directory.

Requirements

Command privilege level: 0 for logsAllowed during upgrade: Yes

Show Commands show account, page 34 show cert, page 34 show cli pagination, page 35 show cli session timeout, page 35 show csr, page 35 show ctl, page 36 show date, page 37 show diskusage, page 37 show environment, page 38 show hardware, page 38 show itl, page 39 show logins, page 39 show memory, page 39 show myself, page 40 show network, page 40 show open, page 41 show packages, page 42

show password, page 42 show password expiry, page 43 show pe dbstatus, page 43 show pe dbconnections, page 44 show perf, page 45 show process, page 46 show registry, page 47 show risdb, page 47 show smtp, page 4833Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands show stats io, page 48 show status, page 49 show tech, page 50 show timezone, page 52 show trace, page 53 show ups status, page 53 show version, page 53 show webapp session timeout, page 54 show web-security, page 54 show workingdir, page 54

show accountThis command lists current administrator accounts, except the master administrator account.

Command Syntax

show account

Requirements


show certThis command displays certificate contents and certificate trust lists.

Command Syntax

show cert

own filenametrust filenamelist {own | trust}

Parameters

filenameRepresents the name of the certificate file. ownSpecifies owned certificates. trustSpecifies trusted certificates. listSpecifies a certificate trust list.

Requirements


OL-xxxxx-xx

Show CommandsExample

This command displays own certificate trust lists.show cert list own

show cli paginationThis command displays the status of automatic pagination.

Command Syntax

show cli pagination

Requirements


Exampleadmin: show cli paginationAutomatic Pagination : Off.

show cli session timeoutThis 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.

Command Syntax

show cli session timeout

Parameters

None

Requirements


show csrThis command displays Certificate Sign Request (CSR) contents.

Command Syntax

show csr

own name

list {own | trust}Parameters

nameRepresents the name of the csr file.35Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands ownSpecifies owned csr. trustSpecifies trusted csr.

Usage guidelines

Use the show cert list own command to obtain the certificate name.

Exampleadmin:show csr own tomcat/tomcat.csr[[-----BEGIN CERTIFICATE SIGN REQUEST-----MIIDrDCCAxUCBENeUewwDQYJKoZIhvcNAQEEBQAwggEbMTQwMgYDVQQGEytVbmFibGUgdG8gZmluZCBDb3VudHJ5IGluIHBsYXRmb3JtIGRhdGFiYXNlMTIwMAYDVQQIEylVbmFibGUgdG8gZmluZCBTdGF0ZSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTE1MDMGA1UEBxMsVW5hYmxlIHRvIGZpbmQgTG9jYXRpb24gaW4gcGxhdGZvcm0gZGF0YWJhc2UxMDAuBgNVBAoTJ1VuYWJsZSB0byBmaW5kIE9yZyBpbiBw

bGF0Zm9ybSBkYXRhYmFzZTExMC8GA1UECxMoVW5hYmxlIHRvIGZpbmQgVW5pdCBpbiBwbGF0Zm9ybSBkYXRhYmFzZTETMBEGA1UEAxMKYmxkci1jY20zNjAeFw0wNTEwMjUxNTQwMjhaFw0xMDEwMjQxNTQwMjhaMIIBGzE0MDIGA1UEBhMrVW5hYmxlIHRvIGZpbmQgQ291bnRyeSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTEyMDAGA1UECBMpVW5hYmxlIHRvIGZpbmQgU3RhdGUgaW4gcGxhdGZvcm0gZGF0YWJhc2UxNTAzBgNVBAcTLFVuYWJsZSB0byBmaW5kIExvY2F0aW9uIGluIHBsYXRmb3JtIGRhdGFiYXNl

MTAwLgYDVQQKEydVbmFibGUgdG8gZmluZCBPcmcgaW4gcGxhdGZvcm0gZGF0YWJhc2UxMTAvBgNVBAsTKFVuYWJsZSB0byBmaW5kIFVuaXQgaW4gcGxhdGZvcm0gZGF0YWJhc2UxEzARBgNVBAMTCmJsZHItY2NtMzYwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMoZ4eLmk1Q3uEFwmb4iU5nrMbhmJ7bexSnC3PuDGncxT3Au4zpGgMaQRL+mk+dAt8gDZfFKz8uUkUoibcUhvqk4h3FoTEM+6qgFWVMkgSNUU+1i9MST4m1aq5hCP87GljtPbnCXEsFXaKH+gxBq5eBvmmzmO1D/otXrsfsnmSt1AgMBAAEwDQYJKoZIhvcNAQEEBQADgYEAKwhDyOoUDiZvlAOJVTNF3VuUqv4nSJlGafB6WFldnh+3yqBWwfGnadmin:show csr list own

tomcat/tomcat.csrVipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr.....

.....

.....

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

Command Syntax

show ctl

Requirements


OL-xxxxx-xx

Show Commandsshow dateThis command displays the date and time on the server.

Command Syntax

show date

Parameters

None

Exampleadmin:show date

Sat Jul 17 01:28:57 IST 2010

show diskusageThis command displays information about disk usage on the server.

Command Syntax

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

Parameters

activelogDisplays disk usage information about the activelog directory. commonDisplays disk usage information about the common directory. inactivelogDisplays disk usage information about the inactivelog directory. installDisplays disk usage information about the install directory. tftp Displays disk usage information about the TFTP directory. tmpDisplays disk usage information about the TMP directory.

Options

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

directoryDisplays just the directory sizes. sortSorts the output on the basis of file size. File sizes display in 1024-byte blocks.

Requirements

Command privilege level: 037Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show CommandsAllowed during upgrade: Yes

show environmentThis command displays environmental information for three types of hardware components.

Command Syntax

show environmentfanspower-supply

temperatures

Parameters

fansDisplays the fan speeds in Rotations per Minute (RPMs), fan-speed thresholds, and status. power-supplyDisplays the power-supply status only MCS-7845, MCS-7835, MCS-7825H3/H4,

and MCS-7816H3 servers (those servers with redundant power supplies or embedded health hardware).

temperaturesDisplays the temperature sensor temperature values, thresholds, and status.The output data from the show environment command varies between IBM and HP server models.

Requirements

Command Level Privilege: 0Allowed During Upgrade:Yes

show hardwareThis command displays the following information about the platform hardware.

Command Syntax

show hardware

Usage Guidelines

This command displays the following information about the platform hardware: Platform Serial number BIOS build level BIOS manufacturer Active processors RAID controller status

Requirements


OL-xxxxx-xx

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

Command syntax

show itl

Parameters

None

Requirements


show loginsThis command lists recent logins to the server.

Command Syntax

show logins number

Parameters

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

show memoryThis command displays information about the onboard memory.

Command Syntax

show memory

count

modulessize

Options

countDisplays the number of memory modules on the system. modulesDisplays detailed information about all the memory modules. sizeDisplays the total amount of physical memory.

Parameters

None

Requirements

Command Level Privilege: 039Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show CommandsAllowed During Upgrade:Yes

show myselfThis command displays information about the current account.

Command Syntax

show myself

Requirements


show networkThis command displays network information.

Command Syntax

show network

eth0 [detail]failover [detail] [page]route [detail]status [detail] [listen] [process] [all] [nodns] [search stext]ip_conntrackmax_ip_conntrackdhcp eth0 statusall [detail]ipprefs allipprefs enabledipprefs public

Parameters

eth0 specifies Ethernet 0. failover specifies Network Fault Tolerance information. route specifies network routing information.

status specifies active Internet connections. ip_conntrack specifies ip_conntrack usage information. max_ip_conntrack specifies max_ip_conntrack information. dhcp eth0 status displays DHCP status information. all specifies all basic network information. ipprefs all displays all incoming ports that may be used on Cisco Unified Presence.40Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands ipprefs enabled displays all incoming ports that are currently open. ipprefs public displays all incoming ports that are currently open for any remote client.

Options

detailDisplays additional information. pageDisplays information 1 page at a time. listenDisplays only listening sockets processDisplays the process ID and name of the program to which each socket belongs. allDisplays both listening and nonlistening sockets. nodnsDisplays numerical addresses without any DNS information. search stextSearches for the stext in the output.

Usage Guidelines

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

Requirements


Example

This example displays active Internet connections.show network status

show openThis command displays open files and ports on the system.

Syntax Description

show open

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

Parameters

filesDisplays open files on the system. portsDisplays open ports on the system.

Options

allDisplays all open files or ports

processDisplays open files that belong to the specified process processIDSpecifies a process regexpDisplays open files or ports that match the specified regular expression reg_expA regular expression41Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commandsshow packagesThis command displays the name and version for installed packages.

Command Syntax

show packages

active name [page]inactive name [page]

Parameters

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

Options

pageDisplays the output one page at a time

Requirements


show passwordThis command displays the information about the configured password.

Command Syntax

show passwordageDisplays information about the configured password age parameterscomplexity [character|length]Displays password complexity or length parameters for OS accounts.

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

Parameters

characterDisplays the status of the password complexity as enabled or disabled. lengthDisplays the minimum length of passwords that get used for OS accounts. If password

character complexity (see set password complexity character) has been enabled at least once on the system, the default length value is 8. If password complexity has never been enabled, the default value is 6.

Requirements


OL-xxxxx-xx

Show Commandsshow password expiryThis command enables or disables password expiry for Cisco Unified Operating System Administrator accounts.

Command Syntax

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

Parameters

maximum-ageDisplays the value of the maximum password age for Cisco Unified Operating System administrator accounts in days.

minimum-age Displays the value of the minimum password age for Cisco Unified Operating System administrator accounts in days.

daysSpecifies the minimum password age, with acceptable values of between 0 - 3650 (10 years). Specifies the maximum password age, which must be greater-than or equal-to 90 days.

user maximum-age Displays the maximum age password expiry for a particular Cisco Unified Operating System Administrator account.

user minimum-ageDisplays the minimum age password expiry for a particular Cisco Unified Operating System Administrator account.

useridDisplays a particular Cisco Unified Operating System Administrator account.

Requirements


show pe dbstatus

Note This command only applies to Cisco Unified Presence Release 8.6(3) and earlier.

This command displays the status of the Presence Engine's datastores in the TimesTen database.

Command Syntax

show pe dbstatus

Exampleshow pe dbstatus

** Datastore: ttsoft **RAM Residence Policy : inUseReplication Agent Policy : manual Replication Manually Started : FalseCache Agent Policy : manualCache Agent Manually Started : False43Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands** Datastore: tthard **RAM Residence Policy : inUseReplication Agent Policy : manualReplication Manually Started : FalseCache Agent Policy : manualCache Agent Manually Started : False

Requirements


show pe dbconnections

Note This command only applies to Cisco Unified Presence Release 8.6(3) and earlier.

This command displays the connections to each of the Presence Engine datastores in the TimesTen database.

Command Syntax:

show pe dbconnections

Example

admin:show pe dbconnections ...

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

Data store /common/tt/db/data/tt60/ttsoftThere are 86 connections to the data storeData store is in shared modeShared Memory KEY 0x04017e6b ID 196612Type PID Context Connection Name ConnIDProcess 13347 0x0b95f6e8 pe 1Process 13347 0x0b9d42f8 pe 23Process 13347 0x96452990 pe 82Process 13347 0x96500880 pe 79Process 13347 0x965718b0 pe 80Process 13347 0x965e2918 pe 81Process 13347 0x9661e750 pe 77Process 13347 0x9668f7b8 pe 78Process 13347 0x9673c660 pe 75Process 13347 0x967ad6d8 pe 76Process 13347 0x967eb008 pe 72Process 13347 0x9685a590 pe 73Process 13347 0x968cb5f8 pe 74Process 13347 0x96908440 pe 70

Requirements


OL-xxxxx-xx

Show Commandsshow perf This command displays information about the specified perfmon counter.

Command Syntax

show perf counterhelp class-name counter-namelist

categories.classes [cat category] [detail]counters class-name [detail]instances class-name [detail]

query

class class-name [,class-name...]counter class-name counter-name [,counter-name...]instance class-name instance-name [,instance-name...]path path-spec [,path-spec...]

Parameters

counterhelpDisplays the explanation text for the specified perfmon counter. class-nameRepresents the class name that contains the counter. counter-nameRepresents the counter that you want to view.

listDisplays the information about the perform system. categoriesLists all categories in the perfmon system. classLists or queries a perfmon class and displays all the instances and counter values of each

instance.

counterLists or queries perfmon counters for the specified perfmon class. instanceLists or queries the perfmon instances for the specified perfmon class. queryDisplays the information about the perform system. pathQueries a specified perfmon path.

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

Options

detailDisplays detailed information about the perfmon classes or objects. cat categoryDisplays perfmon classes for the specified category. class-nameSpecifies the perfmon class that you want to query. You can specify a maximum of 5

classes per command. counter-nameSpecifies the counter to view. You can specify a maximum of 5 counters per

command.45Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands instance-nameSpecifies the perfmon instance to view. You can specify a maximum of 5 instances per command. This command does not apply to singleton perfmon classes.

path-specYou can specify a maximum of 5 paths per command. For an instance-based perfmon class, specify path-spec as

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

class-name\counter-name.

Example

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

Requirements


show processThis command displays process and load information.

Command Syntax

show process

load [cont] [clear] [noidle] [num xx] [thread] [cpu] [memory] [time] [specified] [page]list [page] [short] [detail] [thread] [fd] [cont] [clear] [process id id] [argument id id] [owner name name]

Parameters

loadDisplays the CPU load for each active process. listDisplays all processes.

Options

contCommand repeats continuously clearClears screen before displaying output noidleIgnore idle or zombie processes num xxSets the number of processes to display (Default=10, all = all processes) threadDisplays threads cpuDisplays output by CPU usage memorySorts output by memory usage shortDisplays short listing timeSorts output by time usage pageDisplays one page at a time

detailDisplays a detailed listing process id idShows only specific process number or command name46Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands argument name nameShow only specific process with argument name threadInclude thread processes in the listing fdShow file descriptors that are associated with a process

Requirements


Example

This example shows detailed process listing one page at a time.show process list detail page

show registryThis command displays the contents of the registry.

Command Syntax

show registry system component [name] [page]

Parameters

system(mandatory) Represents the registry system name. component(mandatory) Represents the registry component name. name(optional) Represents the name of the parameter to show.

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

Options

page Displays one page at a time.

Requirements


Example

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

show risdbThis command displays RIS database table information.

Command Syntax

show risdb47Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commandslist [file filename]query table1 table2 table3 ... [file filename]

Parameters

listDisplays the tables supported in the Realtime Information Service (RIS) database. queryDisplays the contents of the RIS tables.

Options

file filenameOutputs the information to a file

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

Requirements


Example

This example displays a list of RIS database tables.show risdb list

show smtpThis command displays the name of the SMTP host.

Command Syntax

show smtp

Requirements


show stats ioThis command displays system I/O statistics.

Command Syntax

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

Options

kiloDisplays statistics in kilobytes detailDisplays detailed statistics on every available device on the system and overrides the kilo

option file filenameOutputs the information to a file48Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show CommandsNote The file option saves the information to platform/cli/filename.txt. The file name cannot contain the . character.

Requirements


show statusThis command displays basic platform status.

Command Syntax

show status

Usage Guidelines

This command displays the following basic platform status: Host name

Date

Time zone Locale

Product version Platform version CPU usage Memory and disk usage

Requirements

Command privilege level: 0

show straceThis command lists the current service trace level.

Command Syntax

show strace servicename

Parameters

servicenameRepresents the service for which the trace is set (enabled/disabled)

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

Requirements

Command privilege level: 049Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show CommandsAllowed during upgrade: No

Exampleadmin:show strace Cisco UP XCP RouterTrace is enabledTrace level is set to Info

show tech This command displays the information about the database.

Command Syntax

show tech

activesqlall [page] [file filename]ccm_servicedatabase dump sessions dberrcode [errorcode]dbintegritydbinusedbschemadbstateinfodevdefaultsdumpCSVandXMLgateway

locales

network [page] [file filename]notifyparams all

params enterprise\params runtime [all] [cpu] [disk] [env] [memory] [page] [file filename]params serviceprefsproceduresrepltimeoutroutepatterns

routeplan

systablessystem [all] [bus] [hardware] [host] [kernal] [software] [tools] [page] [file filename]table table_name [page] [csv]50Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commandstriggersversion [page]

Parameters

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

allDisplays the combined output of all show tech commands. ccm_service Displays information about all Cisco Unified Communications services that can run

on the system.

database dump Creates a CSV file of the entire database. sessionsRedirects the session and SQL information of the present session IDs to a file. dbintegrityDisplays the database integrity. dbinuseDisplays the database in use. dbschemaDisplays the database schema in a CSV file. dbstateinfoDisplays the state of the database. devdefaultsDisplays the device defaults table. dumpCSVandXMLdisplays the device defaults table. collects csv and xml files into a single tar

file. You can retrieve the tar file using any of these methods: Enter file view activelog cm/trace/dbl/xmlcsv.tar to view the contents of the file. Enter file get activelog cm/trace/dbl/xmlcsv.tar to download the file. Use RTMT.

gatewayDisplays the gateway table from the database. localesDisplays the locale information for devices, device pools, and end users. network [page] [file filename]Displays network aspects of the server. notifyDisplays the database change notify monitor. params allDisplays all the database parameters. params enterpriseDisplays the database enterprise parameters. params runtimeDisplays runtime aspects of the server. params serviceDisplays the database service parameters. prefsDisplays database settings. proceduresDisplays the procedures in use for the database. repltimeoutDisplays the replication timeout. When it increases, it ensures that as many servers

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

routepatternsDisplays the route patterns that are configured for the system. routeplanDisplays the route plan that are configured for the system. systablesDisplays the name of all tables in the sysmaster database. systemDisplays system aspects of the server.51Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commands tableDisplays the contents of the specified database table. triggersDisplays table names and the triggers that are associated with those tables. versionDisplays the version of the installed components. table_nameRepresents the name of the table to display.

Options

pageDisplays one page at a time.

file filenameOutputs the information to a file.The file option saves the information to platform/cli/filename.txt. The file name cannot contain the . character.

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

cpuDisplays the cpu usage (top) at the time the command is executed. diskDisplays the disk usage for the system. envDisplays the runtime environment variables. memoryDisplays disk usage information for the system. busDisplays information about the data buses on the server. hardwareDisplays information about the server hardware. hostDisplays information about the server. kernelLists the installed kernel modules. softwareDisplays information about the installed software versions. toolsDisplays information about the software tools on the server. csvSends the output to a comma separated values file

Requirements


show timezoneThis command displays timezone information.

Command Syntax

show timezoneconfiglist [page]

Parameters

configDisplays the current time zone settings. listDisplays the available time zones.

Options

pageDisplays the output one page at a time52Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show CommandsRequirements


show traceThis command displays trace information for a particular task.

Command Syntax

show trace [task_name]

Parameters

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

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

Requirements


Example

This example displays trace information for cdp.show trace cdps

show ups statusThis command shows the current status of the USB-connected APC smart-UPS device and starts the monitoring service if it is not already started.This command provides full status only for 7835-H2 and 7825-H2 servers.

Command Syntax

show ups status

Requirements


show versionThis command displays the software version on the active or inactive partition.

Command Syntax

show version53Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Show Commandsactiveinactive

Requirements


show webapp session timeoutThis 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.

Command Syntax

show webapp session timeout

Parameters

None

Requirements


show web-securityThis command displays the contents of the current web-security certificate.

Command Syntax

show web-security

Requirements


show workingdirThis command retrieves the current working directory for activelog, inactivelog, and install.

Command Syntax

show workingdir

Requirements


OL-xxxxx-xx

Unset CommandsUnset Commands unset network dns options, page 55

unset network dns optionsThis command unsets DNS options.

Command Syntax

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

Parameters

timeoutSets the wait time before the system considers a DNS query failed to the default. attemptsSets the number of DNS attempts to make before failing to the default. rotateSets the method for selecting a nameserver to the default. This affects how loads are

distributed across nameservers.

Usage Guidelines

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

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

Utils Commands utils auditd, page 57 utils core analyze, page 57 utils core list, page 57 utils create report, page 58 utils csa, page 58 utils dbreplication, page 59 utils diagnose, page 61 utils disaster_recovery backup, page 62 utils disaster_recovery cancel_backup, page 62 utils disaster_recovery device, page 62 utils disaster_recovery restore, page 63 utils disaster_recovery schedule, page 64 utils disaster_recovery show_backupfiles, page 65 utils disaster_recovery show_registration, page 66 utils disaster_recovery show_tapeid, page 66 utils disaster_recovery status, page 6655Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Utils Commands utils fior, page 67 utils fips enable, page 68 utils fips disable, page 68 utils fips status, page 69 utils ha, page 69 utils import config, page 70 utils iostat, page 71 utils iothrottle, page 71

utils netdump, page 72 utils network arp, page 73 utils network capture eth0, page 74 utils network host, page 75 utils network ipv4 firewall, page 75 utils network, page 76 utils nscd, page 76 utils ntp, page 77 utils ntp config, page 77

utils ntp restart, page 77 utils ntp server list, page 77 utils ntp start, page 78 utils ntp status, page 78 utils pe replication-agent, page 79 utils remote_account, page 79 utils reset_ui_administrator_name, page 80 utils reset_ui_administrator_password, page 80 utils service, page 80 utils snmp, page 81 utils snmp config, page 83 utils soap realtimeservice test, page 83 utils sso, page 84 utils system, page 85 utils system upgrade, page 85 utils vmtools status, page 86 utils vmtools upgrade, page 8656Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Utils Commandsutils auditdThis command is used to start or stop the system auditing service. The system auditing service monitors Linux events such as the creation and removal of users, as well as the editing or deleting of files.

Command Syntax

utils auditd [enable | disable | status]Parameters

enableEnables the collection of audit logs disableDisables the collection of audit logs statusProvides a status of the audit log collection

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


utils core analyzeThis command generates a backtrace for the specified core file, a thread list, and the current value of all CPU registers.

Command Syntax

utils core [active | inactive] analyze core file nameParameters

activeSpecifies an active version inactiveSpecifies an inactive version core file nameSpecifies the name of a core file.

Usage Guidelines

The command creates a file of the same name as the core file, with a .txt extension, in the same directory as the core file. This command works only on the active partition.

Requirements


utils core listThis command lists all existing core files.57Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6

OL-xxxxx-xx

Utils CommandsCommand Syntax

utils core [active | inactive] listParameters

activeSpecifies an active version inactiveSpecifies an inactive version

Requirements


utils create reportThis command creates reports about the server in the platform/log directory.

Command Syntax

utils create reporthardwareplatformcsa

Parameters

hardwareCreates a system report that contains disk array, remote console, diagnostic, and environmental data.

platformCollects

command line interface reference guide for cisco unified presence 8.6

Documents