CLI Command Set for CTS-Manager 1.5
Available Languages
Table Of Contents
Command Line Interface Reference Guide for Cisco TelePresence Manager
Command Line Interface Reference Guide for Cisco TelePresence Manager
Created: February 25, 2009, OL-13673-04This document describes the Command Line Interface (CLI) commands that are available for CTS-Manager.
Contents
This document comprises the following sections:
Starting a CLI Session
You can access the CTS-Manager CLI remotely or locally:
•
From a web client workstation, such as the workstation that you use for CTS-Manager administration, you can use SSH to connect securely to CTS-Manager.
•
Before You Begin
Ensure you have the following information that gets defined during installation:
•
•
•
You will need this information to log in to the Cisco IPT Platform.
Perform the following steps to start a CLI session:
Step 1
•
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.
•
ipt-1 login:where ipt-1 represents the host name of the system.
Enter your administrator ID.
In either case, the system prompts you for a password.
Step 2
The CLI prompt displays. The prompt represents the Administrator ID; for example:
admin:
CLI Basics
The following section contains basic tips for using the command line interface.
Completing Commands
To complete commands, use Tab:
•
•
•
Getting Help on Commands
You can get two kinds of help on any command:
•
•
Procedure
To get detailed help, at the CLI prompt, enter
help command
Where command specifies the command name or the command and parameter. See Example 2-1.
Note
To query only command syntax, at the CLI prompt, enter
command?
Where command represents the command name or the command and parameter. See Example 2-2.
Note
Example 2-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-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]Ending a CLI Session
At the CLI prompt, enter quit. If you are logged in remotely, you get logged off, and the ssh session gets dropped. If you are logged in locally, you get logged off, and the login prompt returns.
The following sections list and describe the CLI commands that are available for the Cisco Unified Operating System.
Conventions
This document uses the following conventions:
Notes use the following conventions:
Note
Timesavers use the following conventions:
Timesaver
Tips use the following conventions:
Tip
Cautions use the following conventions:
Caution
Warnings use the following conventions:
Warning
Delete Commands
This section contains descriptions of the following 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]
Parameters
•
Options
•
•
•
Usage Guidelines
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
File Commands
This section contains descriptions of the following commands:
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]
Parameters
•
•
•
•
Options
•
•
Usage Guidelines
Caution
You get prompted for confirmation after entering the command. You cannot delete directories or files that are in use.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
Example
The following example deletes the install log.
file delete install install.logfile 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
•
•
Usage Guidelines
To determine which files you can dump with the activelogdetails parameter, first enter the following command:
file list activelogdetails *
The output lists the filenames that you can dump.
Requirements
Command privilege level: 1 for logs
Allowed during upgrade: Yes
Example
This command dumps contents of file _cdrIndex.idx.
file dump activelog cm/cdr/_cdrIndex.idxfile 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 get prompted to enter an SFTP host, username, and password.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Examples
This command gets all files in the activelog operating system directory that match the string "plat".
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]
tftp directory [page] [detail] [reverse] [date | size]
Parameters
•
•
•
•
•
Options
•
•
•
•
•
Requirements
Command privilege level: 1 for logs, 0 for TFTP files
Allowed during upgrade: Yes
Examples
This example lists operating system log files with details.
file list activelog platform/log page 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 sizefile 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, 0 for TFTP files
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
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}Set Commands
This section contains descriptions of the following 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 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}
Requirements
Command privilege level: 0
Allowed during upgrade: No
set network dhcp
This command enables or disables DHCP for Ethernet interface 0. You cannot configure Ethernet interface 1.
Command Syntax
set network dhcp eth0
enable
disable node_ip net_mask gateway_ip
Parameters
•
•
•
•
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network dns
This command sets the IP address for the primary or secondary DNS server.
Command Syntax
set network dns {primary | secondary} ip-address
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Note
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network dns options
This command sets DNS options.
Command Syntax
set network dns options [timeout seconds] [attempts number] [rotate]
Parameters
•
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
set network domain
This command sets the domain name for the system.
Command Syntax
set network domain domain-name
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network failover
This command enables and disables Network Fault Tolerance on the Media Convergence Server network interface card.
Command Syntax
failover {enable | disable}
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network gateway
This command enables you to configure the IP address of the network gateway.
Command Syntax
set network gateway ip-address
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network ip
This command sets the IP address for Ethernet interface 0. You cannot configure Ethernet interface 1.
Command Syntax
set network ip eth0 ip-address ip-mask
Parameters
•
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network mtu
This command sets the maximum MTU value.
Command Syntax
set network mtu mtu_max
Parameters
•
Note
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Level privilege: 1
Command privilege: 1
Allowed during upgrade: No
Example
admin:set network mtu 576*** W A R N I N G ***This will cause the system to temporarily lose network connectivityDo you want to continue ?Enter "yes" to continue or any other key to abortyesexecuting...set network max_ip_conntrack
This command sets the ip_conntrack_max value.
Command Syntax
set network max_ip_conntrack ip_conntrack_max
Parameters
•
set network nic
This command sets the properties of the Ethernet Interface 0. You cannot configure Ethernet interface 1.
Command Syntax
set network nic eth0 [auto en | dis] [speed 10 | 100] [duplex half | full]
Parameters
•
•
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Note
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set network pmtud
This command enables and disables Path MTU Discovery.
Command Syntax
set network pmtud [enable | disable]
Parameters
•
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Level privilege: 1
Command privilege: 1
Allowed during upgrade: No
Example
admin:set network pmtud enable*** W A R N I N G ***This will cause the system to temporarily lose network connectivityDo you want to continue ?Enter "yes" to continue or any other key to abortyesexecuting...admin:set network status
This command sets the status of Ethernet 0 to up or down. You cannot configure Ethernet interface 1.
Command Syntax
set network status eth0 {up | down}
Parameters
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set password
This command allows you to change the administrator and security passwords.
Command Syntax
set password {admin | security}
Parameters
•
Usage Guidelines
The systems prompts you for the old and new passwords.
Note
Servers in a cluster use the security password to authenticate communication between servers. You must reset the cluster after you change the security password.
Procedure
Step 1
Step 2
Note
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set snmp trapdest
This command adds or deletes a trap destination.
Command Syntax
set snmp trapdest
add
delete
Parameters
add
delete
Options
Usage Guidelines
Requirements
Example
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 alternate-host-name
Parameters
•
•
•
•
•
•
Note
Requirements
Command privilege level: 0
Allowed during upgrade: No
set workingdir
This command sets the working directory for active, inactive, and installation logs.
Command Syntax
set workingdir
activelog directory
inactivelog directory
install directory
tftp directory
Parameters
•
•
•
•
•
Requirements
Command privilege level: 0 for logs, 1 for TFTP
Allowed during upgrade: Yes
Show Commands
This section contains descriptions of the following commands:
show account
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 firewall list
This command displays system aspects of the server.
Command Syntax
show firewall list [detail] [page] [file filename]
Options
•
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show hardware
This command displays the following information on the platform hardware.
Command Syntax
show hardware
Usage Guidelines
This command displays the following information on the platform hardware:
•
•
•
•
•
•
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 equals 20.
show myself
This command displays information about the current account.
Command Syntax
show myself
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show network
This command displays network information.
Command Syntax
show network
cluster
eth0 [detail]
failover [detail] [page]
route [detail]
status [detail] [listen] [process] [all] [nodns] [search stext]
ip_conntrack
max_ip_conntrack
dhcp eth0 status
all [detail]
Parameters
•
•
•
•
•
•
•
•
•
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.
Command Syntax
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 process
This command displays information about process that is running on the system.
Syntax
show process
list [file filename] [detail]
load [cont] [clear] [noidle] [num number] [thread] [cpu | memory| time] [page]
Parameters
•
•
Options
•
•
•
•
•
•
•
•
•
•
•
•
•
show stats io
This command displays system IO 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 tech all
This command displays the combined output of all show tech commands.
Command Syntax
show tech all [page] [file filename]
Options
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech network
This command displays network aspects of the server.
Command Syntax
show tech network
all [page] [search text] [file filename]
hosts [page] [search text] [file filename]
interfaces [page] [search text] [file filename]
resolv [page] [search text] [file filename]
routes [page] [search text] [file filename]
sockets {numeric}
Parameters
•
•
•
•
•
•
Options
•
•
•
•
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech runtime
This command displays runtime aspects of the server.
Command Syntax
show tech runtime
all [page] [file filename]
cpu [page] [file filename]
disk [page] [file filename]
env [page] [file filename]
memory [page] [file filename]
Parameters
•
•
•
•
•
Options
•
•
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name cannot contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech system
The show tech system command gets updated as described in this section. This command displays system aspects of the server.
Command Syntax
show tech system
all [page] [file filename]
bus [page] [file filename]
hardware [page] [file filename]
host [page] [file filename]
kernel [page] [file filename]
software [page] [file filename]
tools [page] [file filename]
Parameters
•
•
•
•
•
•
•
Options
•
•
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. Ensure that the file name does not contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show timezone
This command displays time zone information.
Command Syntax
show timezone
config
list [page]
Parameters
•
•
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show version
Be aware that this command displays the software version on the active or inactive partition.
Command Syntax
show version
active
inactive
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show workingdir
This command retrieves the current working directory for activelog, inactivelog, install, and TFTP.
Command Syntax
show workingdir
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
Unset Commnds
This section contains descriptions of the following commands:
unset network
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
This section contains descriptions of the following commands:
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]
Options
•
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils iothrottle enable
This command enables I/O throttling enhancements. When enabled, I/O throttling enhancements lower the impact of upgrades on an active system.
Command Syntax
utils iothrottle enable
utils iothrottle disable
This command disables I/O throttling enhancements. This could adversely affect the system during upgrades.
Command Syntax
utils iothrottle disable
utils iothrottle status
This command displays the status of I/O throttling enhancements.
Command Syntax
utils iothrottle status
utils network arp
This command lists, sets, or deletes Address Resolution Protocol (ARP) table entries.
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
utils network capture eth0
This command captures IP packets on the specified Ethernet interface.
Command Syntax
utils network capture eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]
Parameters
•
Options
•
When you use the page or file options, the complete capture of all requested packets must occur before the command completes.
•
•
The file option saves the information to platform/cli/fname.cap. The filename cannot contain the "." character.
•
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 ping
This command allows you to ping another server.
Command Syntax
utils network ping destination [count]
Parameters
•
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils network tracert
This command traces IP packets that are sent to a remote destination.
Command Syntax
utils network tracert destination
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils ntp
This command displays the NTP status or configuration.
Command Syntax
utils ntp {status | config}
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils remote_account
This command allows you to enable, disable, create, and check the status of a remote account.
Command Syntax
utils remote_account
status
enable
disable
create username life
Parameters
•
•
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 service list
This command retrieves a list of all services and their status.
Command Syntax
utils service list [page]
Options
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils service
This command stops, starts, or restarts a service.
Command Syntax
utils service
start service-name
stop service-name
restart service-name
Parameters
•
–
–
–
–
–
–
–
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils system
This command allows you to restart the system on the same partition, restart the system on the inactive partition, or shut down the system.
Command Syntax
utils system {restart | shutdown | switch-version [nodatasync]}
Parameters
restart restarts the system.
shutdown shuts down the system.
switch-version switches to the product release that is installed on the inactive partition.
Options
•
Usage Guidelines
The utils system shutdown command provides a 5-minute timeout. If the system does not shut down within 5 minutes, the command gives you the option of doing a forced shutdown.
A warning message displays, and you are prompted for confirmation before this command runs with the nodatasync option.
If you use the nodatasync option, any changes to UFF data on the active partition will get lost. You should use this option only to force the versions to switch if the system will not switch versions otherwise because a data synchronization failure occurred. For more information about UFF data, refer to the Cisco Unified Communications Solution Reference Network Design (SRND):
http://cisco.com/en/US/products/sw/voicesw/ps556/products_implementation_design_guides_list.html
Note
The nodatasync option does not support command auto-completion. You must enter the entire option name.
Requirements
Command privilege level: 1
Allowed during upgrade: No
FeedbackContact Cisco
- Open a Support Case
- (Requires a Cisco Service Contract)
This Document Applies to These Products
- Collaboration Endpoints - Retired Products
- Conferencing - Retired Products
- Contact Center - Retired Products
- Optical Networking - Retired Products
- Routers - Retired Products
- Security - Retired Products
- Servers - Unified Computing (UCS) Retired Products
- Storage Networking Retired Products
- Switches - Retired Products
- Video - Retired Products
- Wireless - Retired Products