Table Of Contents
Cisco IPT Platform CLI Commands
utils disaster_recovery backup tape
utils disaster_recovery backup network
utils disaster_recovery cancel_backup
utils disaster_recovery restore tape
utils disaster_recovery restore network
utils disaster_recovery show_backupfiles network
utils disaster_recovery show_backupfiles tape
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
Overview
This appendix describes the CLI commands that are available on the Cisco Unified Communications Operating System server.
Starting a CLI Session
You can access the Cisco Unified Communications Operating System CLI remotely or locally:
•
From a web client workstation, such as the workstation that you use for Cisco Unified Communications Operating System Administration, you can use SSH to connect securely to the Cisco Unified Communications Operating System.
•
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 A-1.
To query only command syntax, at the CLI prompt, enter
command?
Where command represents the command name or the command and parameter. See Example A-2.
Note
Example A-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 A-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.
Cisco IPT Platform CLI Commands
The following sections list and describe the CLI commands that are available for the Cisco Unified Communications Operating System.
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 ipsec
This command allows you to delete IPSec policies and associations.
Command Syntax
delete ipsec
policy {ALL | policy-name}
association policy name {ALL | association-name}
Parameters
•
•
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
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 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 asks you whether you want to continue.
Caution
The display includes both deleted and new files.
Defaults
The default value of detection-size-kb is 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]
tftp directory/filename [detail]
Parameters
•
•
•
•
•
Options
•
•
Usage Guidelines
Caution
If you delete a TFTP data file on the inactive side, you may need to manually restore that file if you switch versions to the inactive side.
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]
tftp 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 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]
tftp 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]
tftp 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]
tftp 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
tftp 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}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 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 ipsec
This command allows you to set IPSec policies and associations.
Command Syntax
set ipsec
policy {ALL | policy-name}
association policy-name {ALL | association-name}
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}
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.
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
•
Usage Guidelines
The system asks whether you want to continue to execute this command.
Caution
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
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.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
set smtp
This command sets the SMTP server hostname.
Command Syntax
set smtp hostname
Parameters
•
Requirements
Command privilege level: 0
Allowed during upgrade: No
set timezone
This command lets you change the system time zone.
Command Syntax
set timezone timezone
Parameters
•
Usage Guidelines
Enter enough characters to uniquely identify the new time zone. Be aware that the time-zone name is case-sensitive.
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 web-security
This command sets the web security certificate information for the operating system.
Command Syntax
set web-security orgunit orgname locality state country
Parameters
•
•
•
•
•
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 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 environment
This command displays information about the server hardware.
Command Syntax
show environment
fans
power-supply
temperatures
Options
•
•
•
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 ipsec
This command displays information on IPSec policies and associations.
Command Syntax
show ipsec
policy
association policy
information policy association
status
Parameters
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: yes
Example
This example displays IPSec policies.
show ipsec policyshow 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 server memory.
Command Syntax
show memory
count
module [ALL | module_number]
size
Options
•
•
•
Parameters
ALL displays information about all installed memory modules.
module_number specifies which memory module to display.
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]
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 connecti
