 Feedback
|
Table Of Contents
Command Line Interface (CLI) Reference Guide for Cisco Unified Presence Release 8.0, 8.5, and 8.6
Exiting a Command with the Ctrl-C Key Sequence
Cisco Unified Presence Release 8.6(3) and Earlier
Cisco Unified Presence Release 8.6(4) and Later
set password complexity character
set password complexity character difference
set password complexity character max-repeat
set password complexity minimum-length
utils disaster_recovery backup
utils disaster_recovery cancel_backup
utils disaster_recovery device
utils disaster_recovery restore
utils disaster_recovery schedule
utils disaster_recovery show_backupfiles
utils disaster_recovery show_registration
utils disaster_recovery show_tapeid
utils disaster_recovery status
utils reset_ui_administrator_name
utils reset_ui_administrator_password
utils soap realtimeservice test
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
•
Exiting a Command with the Ctrl-C Key Sequence
Starting a CLI Session
You can access the Cisco Unified Operating System remotely or locally:
•
•
Before You Begin
Ensure you have the following information that is defined during installation:
•
•
•
You will need this information to log in to the Cisco Unified Operating System.
Procedure
Step 1
a.
ssh adminname@hostname
where adminname specifies the Administrator ID and hostname specifies the hostname that was defined during installation.
For example, ssh admin@ipt-1.
b.
ipt-1 login:
where ipt-1 represents the host name of the system.
Enter the administrator ID that was defined during installation.
Step 2
The CLI prompt displays. The prompt represents the Administrator ID; for example:
admin:You can now use any CLI command.
Completing Commands
To complete commands, use Tab:
•
•
•
Getting Help on Commands
You can get two kinds of help about any command:
•
•
Get detailed help
Enter
help command
Where command specifies the command name or the command and parameter. See Example 1.
Query only command syntax
Enter
command?
Where command represents the command name or the command and parameter. See Example 2.
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 activelogactivelog help:This will list active logging filesoptions are:page - pause outputdetail - show detailed listingreverse - reverse sort orderdate - sort by datesize - sort by sizefile-spec can contain '*' as wildcardsExample:admin:file list activelog platform detail02 Dec,2004 12:00:59 <dir> drf02 Dec,2004 12:00:59 <dir> log16 Nov,2004 21:45:43 8,557 enGui.log27 Oct,2004 11:54:33 47,916 startup.logdir count = 2, file count = 2Example 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 Sequence
You can stop most interactive commands by entering the Ctrl-C key sequence, as shown in the following example:
Example 3 Exiting a Command with Ctrl-C
admin:utils system upgrade 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
Ending a CLI Session
At the CLI prompt, enter quit. If you are logged in remotely, you get logged off, and the ssh session is dropped. If you are logged in locally, you get logged off, and the login prompt returns.
Delete Commands
delete account
This command allows you to delete an administrator account.
Command Syntax
delete account account-name
Parameters
•
Requirements
Command privilege level: 4
Allowed during upgrade: No
delete dns
This command allows you to delete the IP address for a DNS server.
Command Syntax
delete dns ip-address
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
delete process
This command allows you to delete a particular process.
Command Syntax
delete process process-id [force | terminate | crash]
Parameter
•
Options
•
•
•
Usage Guidelines
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
delete smtp
This command allows you to delete the SMTP host.
Command Syntax
delete smtp
Requirements
Command privilege level: 1
Allowed during upgrade: No
File Commands
file check
This command checks the /usr directory tree to see whether any files or directories have been added, removed, or changed in size since the last fresh installation or upgrade and displays the results.
Command Syntax
file check [detection-size-kb]
Options
detection-size-kb—Specifies the minimum file size change that is required for the command to display the file as changed.
Usage Guidelines
The command notifies you about a possible impact to system performance and requests confirmation that you want to continue.
Caution
The display includes both deleted and new files.
Defaults
The default value of detection-size-kb specifies 100 KB.
Requirements
Command privilege level: 0
Allowed during upgrade: No
file delete
This command deletes one or more files.
Command Syntax
file delete
activelog directory/filename {detail | noconfirm}
inactivelog directory/filename {detail | noconfirm}
install directory/filename {detail | noconfirm}
license directory/filename {detail | noconfirm}
Parameters
•
•
•
•
Options
•
•
Usage Guidelines
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
The following example deletes the install log.
file delete install install.log
The following example deletes the license file.
file delete license <licName>.lic
file dump
This command dumps the contents of a file to the screen, a page at a time.
Command Syntax
file dump
activelog directory/filename [detail] [hex]
inactivelog directory/filename [detail] [hex]
install directory/filename [detail] [hex]
Parameters
•
•
•
•
Options
•
•
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: Yes
Example
This command dumps contents of file _cdrIndex.idx.
file dump activelog cm/cdr/_cdrIndex.idxfile fragmentation sdl
This command displays file fragmentation information about SDL log files.
Command Syntax
file fragmentation sdl
all outfilename
file filename {verbose}
most fragmented number
most recent number
Parameters
•
•
•
•
•
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
file get
This command sends the file to another system by using SFTP.
Command Syntax
file get
activelog directory/filename [reltime] [abstime] [match] [recurs]
inactivelog directory/filename [reltime] [abstime] [match] [recurs]
install directory/filename [reltime] [abstime] [match] [recurs]
Parameters
•
•
•
•
Options
•
•
•
•
Usage Guidelines
After the command identifies the specified files, you are prompted to enter an SFTP host, username, and password.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Examples
This command gets all files in the activelog operating system directory that match the string "plat".
file get activelog platform match platThis 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/2005file list
This command lists the log files in an available log directory.
Command Syntax
file list
activelog directory [page] [detail] [reverse] [date | size]
inactivelog directory [page] [detail] [reverse] [date | size]
install directory [page] [detail] [reverse] [date | size]
license directory [page] [detail] [reverse] [date | size]
Parameters
•
•
•
•
Options
•
•
•
•
•
Requirements
Command privilege level: 1 for logs
Allowed during upgrade: Yes
Examples
This example lists operating system log files with details.
file list activelog platform/log page detailThis example lists directories in CDR repository.
file list activelog cm/cdr_repositoryThis example lists CDR files in a specified directory by size.
file list activelog cm/cdr_repository/processed/20050812 sizeThis example lists the names of the licenses.
file list license *file search
This command searches the content of a log and displays the matching lines a page at a time.
Command Syntax
file search
activelog 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
•
•
•
•
•
Options
•
•
•
•
•
•
Usage Guidelines
Write the search term in the form of a regular expression, which is a special text string for describing a search pattern.
If the search term is found in only one file, the filename appears at the top of the output. If the search term is found in multiple files, each line of the output begins with the filename in which the matching line was found.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
file search activelog platform/log/platform.log Err[a-z] ignorecasefile tail
This command tails (prints the last few lines) of a log file.
Command Syntax
file tail
activelog directory/filename [detail] [hex] [lines]
inactivelog directory/filename [detail] [hex] [lines]
install directory/filename [detail] [hex] [lines]
Parameters
•
•
•
•
Options
•
•
•
Requirements
Command privilege level: 1 for logs
Allowed during upgrade: Yes
Example
This example tails the operating system CLI log file.
file tail activelog platform/log/cli00001.logfile view
This command displays the contents of a file.
Command Syntax
file view
activelog directory/filename
inactivelog directory/filename
install directory/filename
license directory/filename
Parameters
•
•
•
•
Usage Guidelines
Caution
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Examples
This example displays the install log.
file view install install.logThis 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 <licName>.licRun Commands
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
•
•
Example
This example runs an SQL command against the TimesTen datastore.
run pe sql tthard select * from packageRequirements
Command privilege level: 1
Allowed during upgrade: Yes
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
•
•
Example
This example runs an SQL command against the datastore.
run pe sql ttroute select * from routeRequirements
Command privilege level: 1
Allowed during upgrade: Yes
run sql
This command allows you to run an SQL command.
Command Syntax
run sql sql_statement
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
This example runs an SQL command.
run sql select name from deviceSet Commands
•
•
•
•
set account
This command sets up a new account on the operating system.
Command Syntax
set account name
Parameters
•
Usage Guidelines
After you enter the username, the system prompts you to enter the privilege level and password for the new account.
Requirements
Command privilege level: 0
Allowed during upgrade: No
set cert
This command affects the certificates available in the preconfigured SFTP location.
Command syntax
set cert
delete unitname
Command privilege level:1
Allowed during upgrade:Yes
import [type][name][caCert]
Command privilege level: 1
Allowed during upgrade: Yes
regen [name]
Command privilege level: 1
Allowed during upgrade: No
Parameters
•
•
•
Options
•
•
•
•
Delete Example
admin: set cert delete [cup] [ siptest.pem](Successfully deletes the certificate siptest.pem from the cup trust category)
Import Example
admin: set cert import trust tomcatSuccessfully imported certificate for tomcat.Please restart services related to tomcat for the new certificate to become active.Regen Example
admin: set cert regen tomcatSuccessfully regenerated certificate for tomcat.Requirements
Command privilege level: 1
Allowed during upgrade: Yes
set cli pagination
For the current CLI session, this command turns automatic pagination On or Off.
Command Syntax
set cli pagination {on | off}
Requirements
Command privilege level: 1
Allowed during upgrade: No
Example
admin:set cli pagination offAutomatic 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.
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
Command Syntax
set cli session timeout minutes
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set csr gen
This command regenerates the Certificate Signing Request (CSR) for the specified unit.
Command Syntax
set csr gen unitname
Parameters
•
Example
admin:set csr gen tomcatSuccessfully generated CSR for tomcat
set commandcount
This command changes the CLI command prompt, so it displays how many CLI commands have executed.
Command Syntax
set commandcount {enable | disable}
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set logging
This command allows you to enable or disable logging.
Command Syntax
set logging {enable | disable}
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
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_ip
Command privilege level: 1
Allowed during upgrade: No
dns {primary | secondary} ip-address
Command privilege level: 1
Allowed during upgrade: No
dns options [timeout seconds] [attempts number] [rotate]
Command privilege level: 0
Allowed during upgrade: Yes
domain domain-name
Command privilege level: 1
Allowed during upgrade: No
failover {enable | disable}
Command privilege level: 1
Allowed during upgrade: No
gateway ip-address
Command privilege level: 1
Allowed during upgrade: No
hostname hostname
Command privilege level: 1
Allowed during upgrade: No
ip eth0 ip-address ip-mask gateway_ip
Command privilege level: 1
Allowed during upgrade: No
mtu mtu_max
Command privilege level: 1
Allowed during upgrade: No
max_ip_conntrack ip_conntrack_max
Command privilege level: 1
Allowed during upgrade: No
nic eth0 [auto en | dis] [speed 10 | 100] [duplex half | full]
Command privilege level: 1
Allowed during upgrade: No
pmtud [enable | disable]
Command privilege level: 1
Allowed during upgrade: No
restore eth0 ip-address network-mask gateway
Command privilege level: 0
Allowed during upgrade: Yes
status eth0 {up | down}
Command privilege level: 1
Allowed during upgrade: No
Parameters
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Options
•
•
•
•
•
•
•
•
Examples
Example: set network hostname
admin:set network hostname mynameW A R N I N GThis 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 mtu
admin:set network mtu 576W A R N I N GThis will cause the system to temporarily lose network connectivityDo you want to continue ?Enter "yes" to continue or any other key to abortyesexecuting...
Example: set network pmtud
admin:set network pmtud enableW A R N I N GThis will cause the system to temporarily lose network connectivityDo 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.1Troubleshooting Tips
•
•
•
Usage 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 password
This command allows you to change the administrator and security passwords.
Command Syntax
set password
age {maximum days| minimum days}
age maximum: Command privilege level: 1
Allowed during upgrade: No
age minimum: Command privilege level:1
Allowed during upgrade:Yes
age {user admin | user security}
Command privilege level: 1
Allowed during upgrade: No
history number
Command privilege level:1
Allowed during upgrade:Yes
Parameters
•
•
•
•
•
•
•
–
–
–
Usage Guidelines
The systems prompts you for the old and new passwords.
Caution
set password complexity character
Note
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
•
•
Note
•
–
–
Note
Usage Guidelines
When you enable password complexity, you must follow these guidelines when you assign a password:
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password complexity character difference
Note
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
•
–
Note
Usage Guidelines
Enter 0 to indicate no difference.
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password complexity character max-repeat
Note
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-repeat
Parameters
•
–
–
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password complexity minimum-length
Note
This command modifies the value for the minimum password length for Cisco Unified Operating System accounts.
Note
Command Syntax
set password complexity minimum-length length
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
set password expiry
This command enables or disables password expiry and minimum/maximum age settings for Cisco Unified Operating System Administrator accounts.
Command Syntax
set password expiry
maximum- age {enable | disable}
minimum- age {enable | disable}
user maximum- age {enable | disable} userid
user minimum- age {disable | enable} userid
Parameters
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
Enable Examples
admin:set password expiry maximum-age
Operation Successful.
admin: set password expiry maximum-age enable
Operation Successful.
Disable Example
admin: set password expiry maximum-age disable
Operation Successful.
User Examples
admin:set password expiry user
Operation Successful.
admin:set password expiry user maximum-age enable
Operation Successful.
set replwatcher monitor
This 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
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set smtp
This command sets the SMTP server hostname.
Command Syntax
set smtp hostname
Parameters
•
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
Command privilege level: 0
Allowed during upgrade: No
set strace
This command enables or disables the service trace and sets the trace level.
Command Syntax
set strace
enable [all] tracevalue servicename
disable [all] servicename
Parameters
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
Enable Examples
admin: set strace enable Info Cisco UP Sync Agent
Operation Successful.
admin:set strace enable all Debug Cisco UP SIP Proxy
Operation Successful.
Disable Example
admin: set strace disable Cisco UP Sync Agent
Operation Successful.
admin:set strace disable all Cisco UP SIP Proxy
Operation Successful.
set timezone
This command lets you change the system time zone.
Command Syntax
set timezone timezone
Parameters
•
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 node's 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
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
This example sets the time zone to Pacific time.
set timezone Pacset trace
This command sets trace activity for the specified task.
Command Syntax
set trace
enable Error tname
enable Special tname
enable State_Transition tname
enable Significant tname
enable Entry_exit tname
enable Arbitrary tname
enable Detailed tname
disable tname
Parameters
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set webapp session timeout
This 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
Tip
Note
Note
Command Syntax
set webapp session timeout minutes
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set web-security
This command sets the web security certificate information for the operating system.
Command Syntax
set web-security orgunit orgname locality state [country alternatehostname]
Parameters
•
Tip
•
•
•
•
•
Note
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
Command privilege level: 0
Allowed during upgrade: No
Example
This example shows the set web-security command with multiple organizational unit names that include commas.
set web-security "accounting,personnel\,CA,personnel\,MA" Cisco Milpitas CAIn the above example, the certificate will have three OU fields:
•
•
•
set workingdir
This command sets the working directory for active, inactive, and installation logs.
Command Syntax
set workingdir
activelog directory
inactivelog directory
install directory
Parameters
•
•
•
•
Requirements
Command privilege level: 0 for logs
Allowed during upgrade: Yes
Show Commands
show account
This command lists current administrator accounts, except the master administrator account.
Command Syntax
show account
Requirements
Command privilege level: 4
Allowed during upgrade: Yes
show cert
This command displays certificate contents and certificate trust lists.
Command Syntax
show cert
own filename
trust filename
list {own | trust}
Parameters
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
This command displays own certificate trust lists.
show cert list ownshow cli pagination
This command displays the status of automatic pagination.
Command Syntax
show cli pagination
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
admin: show cli paginationAutomatic Pagination : Off.
show cli session timeout
This command displays the CLI session timeout value, which is the amount of time, in minutes, that can elapse before a CLI session times out and disconnects.
Command Syntax
show cli session timeout
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show csr
This command displays Certificate Sign Request (CSR) contents.
Command Syntax
show csr
own name
list {own | trust}
Parameters
•
•
•
Usage guidelines
Use the show cert list own command to obtain the certificate name.
Example
admin:show csr own tomcat/tomcat.csr
[
[
-----BEGIN CERTIFICATE SIGN REQUEST-----
MIIDrDCCAxUCBENeUewwDQYJKoZIhvcNAQEEBQAwggEbMTQwMgYDVQQGEytVbmFibGUgdG8gZmlu
ZCBDb3VudHJ5IGluIHBsYXRmb3JtIGRhdGFiYXNlMTIwMAYDVQQIEylVbmFibGUgdG8gZmluZCBT
dGF0ZSBpbiBwbGF0Zm9ybSBkYXRhYmFzZTE1MDMGA1UEBxMsVW5hYmxlIHRvIGZpbmQgTG9jYXRp
b24gaW4gcGxhdGZvcm0gZGF0YWJhc2UxMDAuBgNVBAoTJ1VuYWJsZSB0byBmaW5kIE9yZyBpbiBw
bGF0Zm9ybSBkYXRhYmFzZTExMC8GA1UECxMoVW5hYmxlIHRvIGZpbmQgVW5pdCBpbiBwbGF0Zm9y
bSBkYXRhYmFzZTETMBEGA1UEAxMKYmxkci1jY20zNjAeFw0wNTEwMjUxNTQwMjhaFw0xMDEwMjQx
NTQwMjhaMIIBGzE0MDIGA1UEBhMrVW5hYmxlIHRvIGZpbmQgQ291bnRyeSBpbiBwbGF0Zm9ybSBk
YXRhYmFzZTEyMDAGA1UECBMpVW5hYmxlIHRvIGZpbmQgU3RhdGUgaW4gcGxhdGZvcm0gZGF0YWJh
c2UxNTAzBgNVBAcTLFVuYWJsZSB0byBmaW5kIExvY2F0aW9uIGluIHBsYXRmb3JtIGRhdGFiYXNl
MTAwLgYDVQQKEydVbmFibGUgdG8gZmluZCBPcmcgaW4gcGxhdGZvcm0gZGF0YWJhc2UxMTAvBgNV
BAsTKFVuYWJsZSB0byBmaW5kIFVuaXQgaW4gcGxhdGZvcm0gZGF0YWJhc2UxEzARBgNVBAMTCmJs
ZHItY2NtMzYwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMoZ4eLmk1Q3uEFwmb4iU5nrMbhm
J7bexSnC3PuDGncxT3Au4zpGgMaQRL+mk+dAt8gDZfFKz8uUkUoibcUhvqk4h3FoTEM+6qgFWVMk
gSNUU+1i9MST4m1aq5hCP87GljtPbnCXEsFXaKH+gxBq5eBvmmzmO1D/otXrsfsnmSt1AgMBAAEw
DQYJKoZIhvcNAQEEBQADgYEAKwhDyOoUDiZvlAOJVTNF3VuUqv4nSJlGafB6WFldnh+3yqBWwfGn
admin:show csr list own
tomcat/tomcat.csr
Vipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr
.....
.....
.....
show ctl
This command displays the contents of the Certificate Trust List (CTL) file on the server. It notifies you if the CTL is not valid.
Command Syntax
show ctl
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show date
This command displays the date and time on the server.
Command Syntax
show date
Parameters
None
Example
admin:show date
Sat Jul 17 01:28:57 IST 2010
show diskusage
This command displays information about disk usage on the server.
Command Syntax
show diskusage
activelog {filename filename | directory | sort}
common {filename filename | directory | sort}
inactivelog {filename filename | directory | sort}
install {filename filename | directory | sort}
tftp {filename filename | directory | sort}
tmp {filename filename | directory | sort}
Parameters
•
•
•
•
•
•
Options
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show environment
This command displays environmental information for three types of hardware components.
Command Syntax
show environment
fans
power-supply
temperatures
Parameters
•
•
•
The output data from the show environment command varies between IBM and HP server models.
Requirements
Command Level Privilege: 0
Allowed During Upgrade: Yes
show hardware
This 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:
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show itl
This command displays the ITL file contents or prints an error message if the ITL file is not valid.
Command syntax
show itl
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show logins
This command lists recent logins to the server.
Command Syntax
show logins number
Parameters
number—Specifies the number of most recent logins to display. The default is 20.
show memory
This command displays information about the onboard memory.
Command Syntax
show memory
count
modules
size
Options
•
•
•
Parameters
None
Requirements
Command Level Privilege: 0
Allowed During Upgrade: Yes
show myself
This command displays information about the current account.
Command Syntax
show myself
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show network
This command displays network information.
Command Syntax
show network
eth0 [detail]
failover [detail] [page]
route [detail]
status [detail] [listen] [process] [all] [nodns] [search stext]
ip_conntrack
max_ip_conntrack
dhcp eth0 status
all [detail]
ipprefs all
ipprefs enabled
ipprefs public
Parameters
•
•
•
•
•
•
•
•
•
•
•
Options
•
•
•
•
•
•
•
Usage Guidelines
The eth0 parameter displays Ethernet port 0 settings, including DHCP and DNS configurations and options.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
This example displays active Internet connections.
show network statusshow open
This 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
•
•
Options
•
•
•
•
•
show packages
This command displays the name and version for installed packages.
Command Syntax
show packages
active name [page]
inactive name [page]
Parameters
name—Represents the package name. To display all active or inactive packages, use the wildcard character, *.
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password
This command displays the information about the configured password.
Command Syntax
show password
age—Displays information about the configured password age parameters
complexity [character|length]—Displays password complexity or length parameters for OS accounts.
history number—Displays the number of passwords that the history maintains for OS administration accounts.
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show password expiry
This 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
•
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
show pe dbstatus
Note
This command displays the status of the Presence Engine's datastores in the TimesTen database.
Command Syntax
show pe dbstatus
Example
show pe dbstatus** Datastore: ttsoft **RAM Residence Policy : inUseReplication Agent Policy : manualReplication Manually Started : FalseCache Agent Policy : manualCache Agent Manually Started : False** Datastore: tthard **RAM Residence Policy : inUseReplication Agent Policy : manualReplication Manually Started : FalseCache Agent Policy : manualCache Agent Manually Started : FalseRequirements
Command privilege level: 1
Allowed during upgrade: Yes
show pe dbconnections
Note
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 70Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show perf
This command displays information about the specified perfmon counter.
Command Syntax
show perf
counterhelp class-name counter-name
list
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
•
•
•
•
•
•
•
•
•
•
Note
Options
•
•
•
•
•
•
–
–
Example
show perf query path "Cisco Phones(phone-0)\CallsAttempted",
"Cisco Unified Communications Manager\T1ChannelsActive"Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show process
This 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
•
•
Options
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
This example shows detailed process listing one page at a time.
show process list detail pageshow registry
This command displays the contents of the registry.
Command Syntax
show registry system component [name] [page]
Parameters
•
•
•
Note
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
This example shows contents of the cm system, dbl/sdi component.
show registry cm dbl/sdishow risdb
This command displays RIS database table information.
Command Syntax
show risdb
list [file filename]
query table1 table2 table3 ... [file filename]
Parameters
•
•
Options
file filename—Outputs the information to a file
Note
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
This example displays a list of RIS database tables.
show risdb listshow smtp
This command displays the name of the SMTP host.
Command Syntax
show smtp
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show stats io
This command displays system I/O statistics.
Command Syntax
show stats io [kilo] [detail] [page] [file filename]
Options
•
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show status
This command displays basic platform status.
Command Syntax
show status
Usage Guidelines
This command displays the following basic platform status:
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 0
show strace
This command lists the current service trace level.
Command Syntax
show strace servicename
Parameters
•
Note
Requirements
Command privilege level: 0
Allowed during upgrade: No
Example
admin:show strace Cisco UP XCP RouterTrace is enabledTrace level is set to Infoshow tech
This command displays the information about the database.
Command Syntax
show tech
activesql
all [page] [file filename]
ccm_service
database dump sessions
dberrcode [errorcode]
dbintegrity
dbinuse
dbschema
dbstateinfo
devdefaults
dumpCSVandXML
gateway
locales
network [page] [file filename]
notify
params all
params enterprise\
params runtime [all] [cpu] [disk] [env] [memory] [page] [file filename]
params service
prefs
procedures
repltimeout
routepatterns
routeplan
systables
system [all] [bus] [hardware] [host] [kernal] [software] [tools] [page] [file filename]
table table_name [page] [csv]
triggers
version [page]
Parameters
•
•
•
•
•
•
•
•
•
•
•
–
–
–
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Options
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show timezone
This command displays timezone information.
Command Syntax
show timezone
config
list [page]
Parameters
•
•
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show trace
This command displays trace information for a particular task.
Command Syntax
show trace [task_name]
Parameters
task_name—Represents the name of the task for which you want to display the trace information.
Note
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Example
This example displays trace information for cdp.
show trace cdpsshow ups status
This command shows the current status of the USB-connected APC smart-UPS device and starts the monitoring service if it is not already started.
This command provides full status only for 7835-H2 and 7825-H2 servers.
Command Syntax
show ups status
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show version
This command displays the software version on the active or inactive partition.
Command Syntax
show version
active
inactive
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show 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.
Command Syntax
show webapp session timeout
Parameters
None
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show web-security
This command displays the contents of the current web-security certificate.
Command Syntax
show web-security
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show workingdir
This command retrieves the current working directory for activelog, inactivelog, and install.
Command Syntax
show workingdir
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Unset Commands
unset network dns options
This command unsets DNS options.
Command Syntax
unset network dns options [timeout] [attempts] [rotate]
Parameters
•
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Utils Commands
•
•
•
•
•
•
•
•
•
•
•
•
utils auditd
This 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
•
•
•
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
utils core analyze
This 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 name
Parameters
•
•
•
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
Command privilege level: 1
Allowed during upgrade: Yes
utils core list
This command lists all existing core files.
Command Syntax
utils core [active | inactive] list
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils create report
This command creates reports about the server in the platform/log directory.
Command Syntax
utils create report
hardware
platform
csa
Parameters
•
•
•
Usage Guidelines
You are prompted to continue after you enter the command.
After creating a report, use the command file get activelog platform/log/filename, where filename specifies the report filename that displays after the command completes, to get the report.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils csa
This command starts and stops the Cisco Security Agent (CSA).
Command Syntax
utils csa
disable
enable
status
Parameters
•
•
•
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils dbreplication
This command displays information about database replication.
Command Syntax
utils dbreplication
status
stop [nodename | all]
repair
reset [nodename | all]
clusterreset
dropadmindb
forcedatasyncsub
quickaudit [nodename | all]
repairreplicate replicatename [nodename | all]]
repairtable tablename [nodename | all]]
runtimestate [nodename]
setrepltimeout
Parameters
•
•
•
•
•
•
•
Caution
•
•
•
•
•
•
•
Tip
Parameters
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils diagnose
This command enables you to diagnose and attempt to automatically fix system problems.
Command Syntax
utils diagnose
fix
list
module module_name
test
version
Parameters
•
•
•
•
•
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery backup
This command backs up files on tape, and on a remote server.
Command Syntax
utils disaster_recovery backup
tape featurelist device_name
network featurelist path servername username
Parameters
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery cancel_backup
This command cancels the ongoing backup job.
Command Syntax
utils disaster_recovery cancel_backup
Usage Guidelines
The system prompts you to confirm that you want to cancel the backup job.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery device
This command allows you to manage the devices for backup operations.
Command syntax
utils disaster_recovery device
list
Command privilege level:1
Allowed during upgrade:Yes
delete [device_name|*]
Command privilege level:1
Allowed during upgrade:No
add tape device_name tapeid
add network device_name path servername username Number_of_backups
Parameters
•
•
•
•
•
Options
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery restore
This command backs up files on tape, and a remote servers.
Command Syntax
utils disaster_recovery restore
tape server tarfilename device_name
network restore_server tarfilename device_name
Parameters
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery schedule
This command affects schedules that are configured.
Command syntax
utils disaster_recovery schedule
list
Command privilege level: 1
Allowed during upgrade: Yes
add schedulename devicename featurelist datetime frequency
Command privilege level: 1
Allowed during upgrade: No
enable schedulename
Command privilege level: 1
Allowed during upgrade: No
disable schedulename
Command privilege level: 1
Allowed during upgrade: No
delete [schedulename|*]
Command privilege level: 1
Allowed during upgrade: No
Parameters
•
•
•
•
•
Options
•
•
•
•
•
•
List Example
admin:utils disaster_recovery schedule listschedule name device name Schedule Status----------------------------------------schedule1 dev1 enabledschedule2 dev2 disabledEnable Example
utils disaster_recovery schedule enable schedule1Schedule enabled successfully.Disable Example
utils disaster_recovery schedule disable schedule1Schedule disabled successfully.Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery show_backupfiles
This command displays information about backup files.
Command Syntax
utils disaster_recovery show_backupfiles
network path servername username
tape tapeid
Parameters
•
•
•
•
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery show_registration
This command displays the registered features and components on the specified server.
Command Syntax
utils disaster_recovery show_registration hostname
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery show_tapeid
This command displays a list of tape device IDs.
Command Syntax
utils disaster_recovery show_tapeid
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery status
This command displays the status of the current backup or restore job.
Command Syntax
utils disaster_recovery status operation
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils fior
This command allows you to monitor the I/O on the server. The File I/O Reporting service provides a kernel-based daemon for collecting file I/O per process.
Command Syntax
utils fior
disable
enable
list [start=date-time] [stop=date-time]
start
status
stop
top number [read | write | read-rate | write-rate] [start=date-time] [stop=date-time]
Parameters
•
•
•
•
•
•
•
•
•
•
•
Options
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils fips enable
This command allows you to enable FIPS mode. By default, Cisco Unified Presence is in non-FIPS mode. The administrator must enable FIPS mode.
Caution
Consider the following information before you enable FIPS 140-2 mode on Cisco Unified Presence:
•
•
Command Syntax
utils fips enable
Note
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils fips disable
This command allows you to disable FIPS mode.
Consider the following information before you disable FIPS 140-2 mode on Cisco Unified Presence:
•
Command Syntax
utils fips disable
Note
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils fips status
This command allows you to check the status of FIPS mode to determine whether FIPS is enabled or disabled.
Command Syntax
utils fips status
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils ha
This command supports high availability (HA) in a subcluster, which means that if a node in the subcluster fails, the Instant Message and Availability services from that node can fail over to the second node in the subcluster, fall back to the first node, and/or be recovered from a Failed state.
Command Syntax
utils ha
failover [node name]
fallback [node name]
recover [subcluster name]
status [subcluster name]
Parameters
•
•
•
•
•
•
Failover Example
admin: ha failover shorty-cupsInitiate Manual Failover for Node >shorty-cups<Request SUCCESSFUL.Subcluster Name: DefaultCUPSubClusterNode 1 Name : kal-cup1 State: Taking Over Reason: On Admin RequestNode 2 Name : shorty-cups State: Failing Over Reason: On Admin RequestFallback Example
admin: ha fallback shorty-cupsInitiate Manual fallback for Node >shorty-cups<Request SUCCESSFUL.Subcluster Name: DefaultCUPSubClusterNode 1 Name : kal-cup1 State: Falling Back Reason: On Admin RequestNode 2 Name : shorty-cups State: Taking Back Reason: On Admin RequestRecover Example
admin: ha recover DefaultCUPSubclusterStopping services... StoppedStarting services... Startedadmin:Status Example - HA Not Enabled
admin: ha statusSubcluster Name: DefaultCUPSubClusterNode 1 Name : kal-cup1 State: Unknown Reason: High Availability Not EnabledNode 2 Name : shorty-cups State: Unknown Reason: High Availability Not EnabledStatus Example - HA Enabled
admin: ha statusSubcluster Name: DefaultCUPSubClusterNode 1 Name : kal-cup1 State: Normal Reason: NormalNode 2 Name : shorty-cups State: Normal Reason: NormalStatus Example - Critical Service Down
admin: ha statusSubcluster Name: DefaultCUPSubClusterNode 1 Name : kal-cup1 State: Failed Over with Critical Services not Running Reason: Critical Service DownNode 2 Name : shorty-cups State: Running in Backup Mode Reason: Critical Service DownStatus Example - Failed
admin: ha statusSubcluster Name: DefaultCUPSubClusterNode 1 Name : kal-cup1 State: Failed Reason: Critical Service DownNode 2 Name : shorty-cups State: Failed Reason: Critical Service Downutils 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.
Command Syntax
utils import config
Parameters
None
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Usage Guidelines
This command can be executed on any VMware deployment.
Step 1
Step 2
Step 3
Step 4
Step 5
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.Step 6
When you first sign-in to the Cisco Unified Presence Administration GUI, the post-install wizard will run. This is the same post-install wizard that runs after a fresh installation is completed. You need to identify the Cisco Unified Communications Manager you want Cisco Unified Presence to point to.utils iostat
This command displays the iostat output for the given number of iterations and interval.
Command Syntax
utils iostat [interval | iterations | filename]
Options
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils iothrottle
This command allows you to manage and monitor IO throttling on the server.
Command Syntax
utils iothrottle
disable
enable
status
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils netdump
This command configures the netdump client and server.
Command Syntax
utils netdump
client
start ip-address-of-netdump-server
status
stop
server
add-client ip-address-of-netdump-client
delete-client ip-address-of-netdump-client
list-clients
start
status
stop
Parameters
•
•
•
•
•
•
•
•
•
•
Usage Guidelines
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils network arp
This command lists the contents of the Address Resolution Protocol (ARP) table.
Command Syntax
utils network arp
list [host host] [page] [numeric]
set {host} {address}
delete host
Parameters
•
•
•
•
•
Options
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
List Usage Guidelines
In the Flags column, C=cached, M=permanent, P=published.
List Example
admin: utils network arp listAddress HWtype HWaddress Flags Mask Ifacesjc21-3f-hsrp.cisco.com ether 00:00:0C:07:AC:71 C eth0philly.cisco.com ether 00:D0:B7:85:98:8E C eth0Entries: 2 Skipped: 0 Found: 2Set Example
admin: utils network arp set myhost 11:22:33:44:55:66Delete Example
admin: utils network arp delete myhostutils network capture eth0
This command captures IP packets on the specified Ethernet interface.
Command Syntax
utils network capture
eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]
Parameters
•
Options
•
•
•
•
For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10,000.
•
For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network host
This command resolves a host name to an address or an address to a host name.
Command Syntax
utils network host
hostname [server server-name] [page] [detail] [srv]
Parameters
•
Options
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network ipv4 firewall
This commands sets options and displays status for the IPv4 firewall.
Command Syntax
utils network ipv4 firewall
debug [off|time]
disable [time]
enable
list
status
Parameters
•
•
•
•
•
Options
•
–
–
–
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network
This command monitors network communication and traffic.
Command Syntax
utils network
ping destination [count]
tracert destination
Parameters
•
•
•
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils nscd
This command allows you to manage the network service cache daemon (nscd)
Command Syntax
utils nscd
restart
status
Parameters
•
•
utils ntp
This command displays the NTP status or configuration.
Command Syntax
utils ntp {status | config}
Note
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ntp config
This command displays the current configuration of the NTP client and server.
Command Syntax
utils ntp config
Parameters
None
utils ntp restart
This command restarts the NTP service.
Command Syntax
utils ntp restart
Parameters
None
Requirements
Level privilege: 0
Command privilege: 0
Allowed during upgrade: Yes
utils ntp server list
This command lists all NTP servers.
Note
Command Syntax
utils ntp server list
Parameters
None
Requirements
Level privilege: 0
Command privilege: 0
Allowed during upgrade: Yes
utils ntp start
If it is not already running, this command starts the NTP service.
Note
Command Syntax
utils ntp start
Parameters
None
Requirements
Level privilege: 0
Command privilege: 0
Allowed during upgrade: Yes
utils ntp status
This command displays the current status of NTP.
Command Syntax
utils ntp status
Parameters
None
utils pe replication-agent
Note
This command is used to manage the replication agent for the Presence Engine (PE).
Command Syntax
utils pe replication-agent
start
stop
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils remote_account
This command allows you to enable, disable, create, and check the status of a remote account.
Command Syntax
utils remote_account
status
enable
disable
create username life
Parameters
•
•
Usage Guidelines
A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account. You can have only one remote account that is enabled at a time.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
utils remote_account statusutils reset_ui_administrator_name
This command resets the Administrator user name that you use to log in the administration user interface for the installed product.
Command Syntax
utils reset_ui_administrator_name
Usage Guidelines
If this user name is reset, you must manually update the user name of the Cisco Ajax XMPP Libraries (AXL) on each intercluster peer (if any) to match it: Select Cisco Unified Presence Administration > Presence > Inter-clustering.
utils reset_ui_administrator_password
This command resets the Administrator password that you use to log in the administration user interface for the installed product.
Command Syntax
utils reset_ui_administrator_password
Usage Guidelines
If this password is reset, you must manually update the Cisco Ajax XMPP Libraries (AXL) on each intercluster peer (if any) to match it: Select Cisco Unified Presence Administration > Presence > Inter-clustering.
utils service
This command stops, starts, or restarts a service, and retrieves a list of all services and their status.
Command Syntax
utils service
list [page]
start service-name
stop service-name
restart service-name
auto-restart {enable | disable | show} service-name
Parameters
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils snmp
This command manages SNMP on the server.
Command Syntax
utils snmp
get version
hardware-agents [status | start | stop | restart]
test
walk version
Parameters
•
iso.3.6.1.2.1.25.1.1.0 = Timeticks: (19836825) 2 days, 7:06:08.25
If you provide the IP address of a remote host, the command gets executed on the remote host.
Be aware that the IP address is required. You cannot use a domain name.
•
•
•
•
•
•
•
Test Example
admin:utils snmp testService Manager is runningTest SNMP Trap starts with Local Host Name, Specify a Remote Sever Name to test RemoteSyslogTestAlarmInformational 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_ALARMWalk Example
If you run snmp walk on a leaf in the MIB you basically get what you would get with 'utils snmp get ...' command. Here in the example that displays for the system's uptime.iso.3.6.1.2.1.1.1.0 = STRING: "Hardware:7825H, 1 Intel(R) Pentium(R) 4 CPU 3.40GHz, 2048MB Memory: Software:UCOS 2.0.1.0-62"iso.3.6.1.2.1.1.2.0 = OID: iso.3.6.1.4.1.9.1.583iso.3.6.1.2.1.1.3.0 = Timeticks: (15878339) 1 day, 20:06:23.39iso.3.6.1.2.1.1.4.0 = ""iso.3.6.1.2.1.1.5.0 = STRING: "bldr-ccm34.cisco.com"iso.3.6.1.2.1.1.6.0 = ""iso.3.6.1.2.1.1.7.0 = INTEGER: 72iso.3.6.1.2.1.2.1.0 = INTEGER: 3iso.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1iso.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2iso.3.6.1.2.1.2.2.1.1.3 = INTEGER: 3iso.3.6.1.2.1.2.2.1.2.1 = STRING: "lo"Press <enter> for 1 line, <space> for one page, or <q> to quitRequirements
Command privilege level: 1
Allowed during upgrade: Yes
utils snmp config
This interactive command affects the v3 inform notification, Mib2 configuration information, trap notifications., and v3 user configuration.
Command Syntax
utils snmp config
inform 3 [ add | delete | list | update ]
mib 2 [ add | delete | list | update ]
trap 3 [ add | delete | list | update ]
user 3 [ add | delete | list | update ]
Parameters
•
•
•
•
Usage guidelines - utils snmp config inform 3
The SNMP Master Agent service will be 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
utils soap realtimeservice test
This command executes a number of test cases on the remote server.
Command Syntax
utils soap realtimeservice test remote-ip remote-https-user remote-https-password
Parameters
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils sso
This command affects SSO based authentication.
Command Syntax
utils sso [enable | disable | status]
Parameters
•
•
•
Example
The following example makes use of the parameters and values provided in the Configuring Single Sign-On chapter of the Deployment Guide for Cisco Unified Presence Release 8.6.
Note
admin:utils sso enable *****WARNING***** This command will restart Tomcat for successful completion.This command needs to be executed on all the nodes in the cluster. Do you want to continue (yes/no): yes List of apps for which SSO can be enabled: 1) Cisco Unified Presence Administration (CUP Admin, CU Serviceability, CU Reporting) 2) Cisco Unified Operating System Administration (CUOS Admin, DRF) 3) Cisco UP Client Profile Agent4) RTMT 4) Cisco Unified Presence User Options (CUP User options)Do you want to enable SSO for Cisco Unified Presence Administration (CUP Admin, CU Serviceability, CU Reporting) (yes/no): yes Do you want to enable SSO For Cisco Unified Operating System Administration (CUOS Admin, DRF) (yes/no): yes Do you want to enable SSO for Cisco UP Client Profile Agent (yes/no): yesDo you want to enable SSO for RTMT (yes/no):yesDo you want to enable SSO for Cisco Unified Presence User Options (CUP End User options) (yes/no): yes Enter URL of the Open Access Manager (OpenAM) server: https://examplehost.corp.com:8443/opensso Enter the relative path where the policy agent should be deployed: agentapp Enter the name of the profile configured for this policy agent: CUPUser Enter the password of the profile name: ******** Enter the login module instance name configured for Windows Desktop SSO: CUPUserValidating connectivity and profile with Open Access Manager (OpenAM) Server: https://examplehost.corp.com:8443/opensso Valid profileValid module nameEnabling SSO ... This will take up to 5 minutesSSO Enable Successutils system
This command allows you to restart the system on the same partition, restart the system on the inactive partition, or shut down the system.
Command Syntax
utils system {restart | shutdown | switch-version}
Parameters
•
•
•
Usage Guidelines
The utils system shutdown 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.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils system upgrade
This command allows you to install upgrades and Cisco Option Package (COP) files from both local and remote directories.
Command Syntax
utils system upgrade
cancel
get {local | remote} filename
list {local | remote] path
start
Parameters
•
•
•
•
–
–
•
•
utils vmtools status
For information about this command, see the Command Line Interface Reference Guide for Cisco Unified Communications Solutions Release 8.5(1).
utils vmtools upgrade
For information about this command, see the Command Line Interface Reference Guide for Cisco Unified Communications Solutions Release 8.5(1).
Related Documentation
For the latest Cisco Unified Presence requirements, see the Release Notes for Cisco Unified Presence at the following URL:
http://www.cisco.com/en/US/products/ps6837/prod_release_notes_list.htmlCisco 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: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Book Title
Copyright © 2012 Cisco Systems, Inc. All rights reserved.
