-
Cisco Emergency Responder Administration Guide 8.0
-
Preface
-
Chapter 1: Planning for Cisco Emergency Responder 8.0
-
Chapter 2: Installing Cisco Emergency Responder 8.0
-
Chapter 3: Configuring Cisco Unified Communication Manager 4.1, 4.2 and 4.3 for Cisco Emergency Responder 8.0
-
Chapter 4: Configuring Cisco Unified Communications Manager Versions 5.0 and Later for Cisco Emergency Responder 8.0
-
Chapter 5: Configuring Cisco Emergency Responder 8.0
-
Chapter 6: Using Cisco Emergency Responder with Intrado V9-1-1 Enterprise Services
-
Chapter 7: Configuring Cisco Emergency Responder 8.0 Serviceability
-
Chapter 8: Configuring the Cisco Unified Operating System for Cisco Emergency Responder 8.0
-
Chapter 9: Configuring the Cisco Emergency Responder 8.0 Disaster Recovery System
-
Chapter 10: Using the Cisco Emergency Responder 8.0 Admin Utility
-
Chapter 11: Preparing Users for Cisco Emergency Responder
-
Chapter 12: Troubleshooting Cisco Emergency Responder
-
Chapter 13: Using the ALI Formatting Tool
-
Appendix A: Administration Web Interface For Cisco Emergency Responder
-
Appendix B: Serviceability Web Interface For Cisco Emergency Responder
-
Appendix C: Cisco Unified Operating System Administration Web Interface For Cisco Emergency Responder
-
Appendix D: Disaster Recovery System Web Interface For Cisco Emergency Responder
-
Appendix E: Admin Utility Web Interface For Cisco Emergency Responder
-
Appendix F: Command Line Interface
-
Appendix G: Using the AFT for Specific Service Providers
-
Appendix H: Event Log Messages
-
Appendix I: Port Usage in Cisco ER
-
Index
-
Feedback
Table Of Contents
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 tape
utils disaster_recovery show_backupfiles network
utils disaster_recovery show_registration
utils disaster_recovery show_tapeid
utils disaster_recovery status
utils reset_ui_administrator_password
Command Line Interface
This appendix describes Cisco Unified Operating System (OS) commands that you can use on the Cisco Emergency Responder (Cisco ER) platform to perform basic operating system functions. The Cisco Unified OS Administration web interface also makes these functions available. Typically, you would use the command-line interface (CLI) only when a problem occurs while you are using the Cisco Unified OS Administration web interface.
These topics describe how to use the CLI:
•
Cisco Unified OS CLI Commands
Starting a CLI Session
You can access the CLI remotely or locally using the following methods:
•
•
Before You Begin
Ensure you have the following information, which is defined during installation:
•
•
•
You will need this information to log in to the Cisco ER platform.
To start a CLI session, follow these steps:
Procedure
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@cer-1.
•
cer-1 login:
where cer-1 represents the host name of the system.
Enter the administrator ID that was defined during installation.
In either case, the system prompts you for a password.
Step 2
The CLI prompt appears. The prompt represents the Administrator ID; for example:
admin:
You can now use any CLI command.
CLI Basics
The following topics describe how to perform basic functions 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:
•
•
To get help on commands, follow these steps:
Procedure
Step 1
help command
where command specifies the command name or the command and parameter. See Example F-1.
Step 2
command?
where command represents the command name or the command and parameter. See Example F-2.
Note
Example F-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 F-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
To end a CLI session, enter quit at the CLI prompt. If you are logged in remotely, you are logged off and the ssh session is dropped. If you are logged in locally, you are logged off and the login prompt returns.
Cisco Unified OS CLI Commands
The following sections list and describe the CLI commands that are available for the Cisco Unified OS running on the Cisco ER platform.
Note
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
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]
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
•
•
•
•
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]
partBsalog directory/filename [reltime] [abstime] [match] [recurs]
salog 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]
partBsalog directory [page] [detail] [reverse] [date | size]
salog 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 created for Cisco ER logs.
file list activelog er/logsThis example lists Cisco ER logs in a specified directory by size.
file list activelog er/logs 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
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
system-management-log
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 er/logs/CERAdmin01.logrun 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
Examples
This example runs an SQL command:
run sql select * from cerserverset 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 cli pagination
For the current CLI session, this command turns automatic pagination On or Off.
Command Syntax
set cli pagination {on | off}
Parameters
•
•
Requirements
Level privilege: 1
Command privilege: 1
Allowed during upgrade: No
Example
admin:set cli pagination offAutomatic pagination is turned offset 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 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.
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.
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_contrack
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 restore
This command configures the specified Ethernet port to use a specified static IP address.
Caution
Caution
Command Syntax
set network restore eth0 ip-address network-mask gateway
Parameters
•
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
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 password.
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 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 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
Parameters
•
•
•
•
Requirements
Command privilege level: 0 for logs
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 cli pagination
This command deploys the status of automatic CLI pagination.
Command Syntax
show cli pagination
Parameters
None
Requirements
Level privilege: 0
Command privilege: 0
Allowed during upgrade: Yes
Example
admin: show cli paginationAutomatic Pagination : Off.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
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}
tmp {filename filename | directory | sort}
Parameters
•
•
•
•
•
Options
•
•
•
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
show 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
•
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 connections.
show network statusshow network ipprefs
This command displays the list of ports that have been requested to be opened or translated in the firewall.
Command Syntax
ipprefs {all | enabled | public}
Parameters
all—Displays all incoming ports that may be used on the product.
enabled—Displays all incoming ports that are currently opened.
public—Displays all incoming ports that are currently opened for any remote client.
Requirements
Level privilege: 0
Command privilege: 0
Allowed during upgrade: Yes
Example
admin:show network ipprefs publicApplication IPProtocol PortValue Type XlatedPort Status Description------------ ------------ ------------ ------------ ------------ ------------ ------------sshd tcp 22 public - enabled sftp and ssh accesstomcat tcp 8443 translated 443 enabled secure web accesstomcat tcp 8080 translated 80 enabled web accessclm udp 8500 public - enabled cluster managerclm tcp 8500 public - enabled cluster managerntpd udp 123 public - enabled network time syncsnmpdm udp 161 public - enabled SNMPccm tcp 2000 public - enabled SCCP-SIGctftp udp 6969 translated 69 enabled TFTP access to CUCM TFTP Serverctftp tcp 6970 public - enabled HTTP access to CUCM TFTP Serveradmin:show 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 process
This command displays information about process running on the system.
Syntax
show process
list [file filename] [detail]
load [cont] [clear] [noidle] [num number] [thread] [cpu | memory| time] [page]
name process [file filename]
open-fd process-id [, process-id2]
search regexp [file filename]
using-most cpu [number] [file filename]
using-most memory [number] [file filename]
Parameters
•
•
•
•
•
•
•
Options
•
•
•
•
•
•
•
•
•
•
•
•
•
show smtp
This command displays the name of the SMTP host.
Command Syntax
show snmp
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
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
all [page] [file filename]
Options
•
•
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech database
This command creates a CSV file of the entire database.
Command Syntax
show tech database
dump
sessions
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech dbintegrity
This command displays the database integrity.
Command Syntax
show tech dbintegrity
show tech dbinuse
This command displays the database in use.
Command Syntax
show tech dbinuse
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech dbschema
This command displays the database schema in a CSV file.
Command Syntax
show tech dbschema
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech dbstateinfo
This command displays the state of the database.
Command Syntax
show tech dbstateinfo
show tech network
This command displays network aspects of the server.
Command Syntax
show tech network [page] [file filename]
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. The file name cannot contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech prefs
This command displays all preferences files for Cisco ER and its database. This information is written to a file, which can be viewed subsequently using the file view CLI.
Command Syntax
show tech prefs
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. The file name cannot contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech systables
This command displays the name of all tables in the sysmaster database.
Command Syntax
show tech systables
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech system
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
page—Displays one page at a time
file filename—Outputs the information to a file
Usage Guidelines
The file option saves the information to platform/cli/filename.txt. The file name cannot contain the "." character.
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech table
This command displays the contents of the specified database table.
Command Syntax
show tech table table_name [page] [csv]
Parameters
table_name represents the name of the table to display.
Options
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
show tech version
This command displays the version of the installed components.
Command Syntax
show tech version [page]
Options
page—Displays the output one page at a time
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 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 not already started.
This command to give full status is only available on 7835-H2 and 7825-H2 servers.
Command Syntax
show ups status
show version
This command displays the software version on the active or inactive partition.
Command Syntax
show version
active
inactive
Parameters
active displays the version running on the active partition.
inactive displays the version on the inactive partition.
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 ipsec
This command allows you to disable IPSec policies and associations.
Command Syntax
unset ipsec
policy {ALL | policy-name}
association policy-name {ALL | association-name}
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
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 core list
This command lists all existing core files.
Command Syntax
utils core list
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 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.
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 is the report filename that is displayed after the command completes, to get the report.
Requirements
Level privilege: 1
Command privilege level: 0
Allowed during upgrade: Yes
utils csa disable
This command stops Cisco Security Agent (CSA).
Command Syntax
utils csa disable
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils csa enable
This command enables Cisco Security Agent (CSA).
Command Syntax
utils csa enable
Usage Guidelines
The system prompts you to confirm that you want to enable CSA.
Caution
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils csa status
This command displays the current status of Cisco Security Agent (CSA).
Command Syntax
utils csa status
Usage Guidelines
The system indicates whether CSA is running.
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils dbreplication status
This command displays the status of database replication. You should run this command only on the first Publisher server of a cluster.
Command Syntax
utils dbreplication status
utils dbreplication repair
This command repairs database replication.
Command Syntax
utils dbreplication repair
utils dbreplication reset
This command resets and restarts database replication.
Command Syntax
utils dbreplication reset
Note
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
•
•
•
•
•
•
utils disaster_recovery backup tape
This command starts a backup job and stores the resulting tar file on tape.
Command Syntax
utils disaster_recovery backup tape featurelist tapeid
Parameters
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery backup network
This command starts a backup job and stores the resulting tar file on a remote server.
Command Syntax
utils disaster_recovery backup network featurelist path servername username
Parameters
•
•
•
•
Usage Guidelines
Note
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 restore tape
This command starts a restore job and takes the backup tar file from tape.
Command Syntax
utils disaster_recovery restore tape server tarfilename tapeid
Parameters
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery restore network
This command starts a restore job and takes the backup tar file from a remote server.
Command Syntax
utils disaster_recovery restore network restore_server tarfilename path servername username
Parameters
•
•
•
•
•
Usage Guidelines
Note
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils disaster_recovery show_backupfiles tape
This command displays information about the backup files that are stored on a tape.
Command Syntax
utils disaster_recovery show_backupfiles tape tapeid
Parameters
•
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils disaster_recovery show_backupfiles network
This command displays information about the backup files that are stored on a remote server.
Command Syntax
utils disaster_recovery show_backupfiles network path servername username
Parameters
•
•
•
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]
Options
•
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
utils firewall
This command manages the firewall on the node.
Command Syntax
utils firewall
disable {time}
enable
list
status
Parameters
•
•
–
–
–
If you do not specify a time, the default is 5 minutes.
•
•
Usage Guidelines
When the firewall is disabled, you must enter the URL of the Cisco Unified Communications Manager server in the following format to log into the web interface:
https://server:8443/where server is the servername or IP address of the server.
Disabling the firewall is not recommended.
Requirements
Command privilege level: 0
Allowed during upgrade: Yes
utils iostat
This command displays the iostat output for the given number of iterations and interval.
Command Syntax
utils iostat [interval] [iterations] [filename]
Parameters
•
•
•
Requirements
Level privilege: 0
Command privilege: 1
Allowed during upgrade: No
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 netdump client
This command configures the netdump client.
Command Syntax
utils netdump client
start ip-address-of-netdump-server
status
stop
Parameters
•
•
•
•
Usage Guidelines
In the event of a kernel panic crash, the netdump client sends diagnostic information about the crash to a netdump server.
Requirements
Command privilege level: 0
Allowed during upgrade: No
utils netdump server
This command configures the netdump server.
Command Syntax
utils netdump server
add-client ip-address-of-netdump-client
delete-client ip-address-of-netdump-client
list-clients
start
status
stop
Parameters
•
•
•
•
•
•
•
Usage Guidelines
In the event of a kernel panic crash, a netdump-enabled client system sends diagnostic information about the crash to the netdump server.
netdump diagnostic information gets stored in the following location on the netdump server: crash/. The subdirectories whose names comprise a client IP address and a date contain netdump information.
You can configure each Cisco ER server as both a netdump client and server.
If the server is on another Cisco ER server, only the kernel panic trace signature gets sent to the server; otherwise, an entire core dump gets sent.
Requirements
Command privilege level: 0
Allowed during upgrade: No
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 connectivity
This command verifies the server's network connection to the publisher server. It is only valid on a subscriber server.
Command Syntax
utils network connectivity
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 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 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 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_password
This command resets the Cisco ER Administration password.
Command Syntax
utils reset_ui_administrator_password
utils service
This command stops, starts, or restarts a service.
Command Syntax
utils service
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 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 sftp handshake
This command exchanges SFTP SSH keys to all members of the cluster.
Command Syntax
utils sftp handshake
utils snmp
This command manages SNMP on the server.
Command Syntax
utils snmp
get version community ip-address object [file]
hardware-agents [status | restart]
test
walk version community ip-address object [file]
Parameters
•
•
•
•
•
•
•
•
•
•
•
Requirements
Command privilege level: 1
Allowed during upgrade: Yes
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}
Parameters
restart restarts the system.
shutdown shuts down the system.
switch-version switches to the product release installed on the inactive partition.
Usage Guidelines
The utils system shutdown command has 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.
Requirements
Command privilege level: 1
Allowed during upgrade: No
utils system boot
This commands redirects where the system boot output gets sent.
Command Syntax
utils system boot {console | serial | status}
Parameters
•
•
•
Requirements
Level privilege: 1
Command privilege: 1
Allowed during upgrade: Yes
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 {initiate | cancel | status}
Parameters
•
•
•
Usage Guidelines
To upgrade the system, follow these major steps:
1.
2.
3.
