Administration Guide for Cisco Emergency Responder 8.7
CLI
Downloads: This chapterpdf (PDF - 2.1MB) The complete bookPDF (PDF - 9.16MB) | Feedback

CLI

Contents

CLI

This appendix describes Cisco Unified Operating System (OS) commands that you can use on the Cisco Emergency Responder (Emergency Responder) platform to perform basic operating system functions. The Cisco Unified OS Administration web interface also makes these functions available. Typically, you would use the CLI only when a problem occurs while you are using the Cisco Unified OS Administration web interface.

This appendix contains the following information:

Start CLI Session

You can access the CLI remotely or locally using the following methods:

  • You can access the CLI remotely from a web client workstation, such as the workstation that you use for Emergency Responder administration, by using SSH Secure Shell to connect securely to the Emergency Responder.
  • You can access the CLI locally by using the monitor and keyboard that you used during installation or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.
Before You Begin

Ensure you have the following information, which is defined during installation:

  • A primary IP address and hostname
  • An administrator ID
  • An administrator password

You need this information to log in to the Emergency Responder platform.

To start a CLI session, follow these steps:

Procedure
    Step 1   Depending on your method of access, do one of the following actions:
    • From a remote system, use SSH Secure Shell to connect securely to the Emergency Responder platform. In your SSH client, enter

      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.

    • From a direct connection, you receive this prompt automatically:

      cer-1 login:

      where cer-1 represents the host name of the system.

      Enter the administrator ID that was defined during installation.

    Step 2   Enter the password that was defined at installation.

    The CLI prompt appears. The prompt represents the Administrator ID; for example:

    admin:

    You can now use any CLI command.


    CLI Basics

    The following sections describe how to perform basic functions using the CLI.

    Complete Commands

    To complete commands, use Tab:

    • Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, se is expanded to the set command.

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

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

    Get Command Help

    You can get two kinds of help on any command:
    • Detailed help that includes a definition of the command and an example of its use
    • Short query help that includes only command syntax

    To get help on commands, follow these steps:

    Procedure
      Step 1   To get detailed help, at the CLI prompt, enter helpcommand where command specifies the command name or the command and parameter.

      Example:
      admin:help file list activelog
      activelog help:
      This will list active logging files
      
      options are:
      page - pause output
      detail - show detailed listing
      reverse - reverse sort order
      date - sort by date
      size - sort by size
      
      file-spec can contain '*' as wildcards
      
      Example:
      admin:file list activelog platform detail
      02 Dec,2004 12:00:59 <dir> drf
      02 Dec,2004 12:00:59 <dir> log
      16 Nov,2004 21:45:43 8,557 enGui.log
      27 Oct,2004 11:54:33 47,916 startup.log
      dir count = 2, file count = 2
      Step 2   To query only command syntax, at the CLI prompt, enter command? where command represents the command name or the command and parameter.
      Note   

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



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

      End CLI Session

      Procedure
      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 Emergency Responder platform.


      Note


      The File I/O Reporting Service (FIOR) provides a kernel-based daemon for collecting file I/O per process. It must be enabled from the CLI; it is disabled by default.


      delete account

      This command allows you to delete an administrator account.

      Command Syntax

      delete account account-name

      Parameters

      • account-name represents the name of an administrator account.

      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

      • ip-address represents the IP address of the DNS server you want to delete.

      Usage Guidelines

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


      Caution


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


      Requirements

      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

      • policy-name represents an IPSec policy.
      • association-name represents an IPSec association.

      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

      • process-id represents the process ID number.

      Options

      • force—Tells the process to stop
      • terminate—Tells the operating system to terminate the process
      • crash—Crashes the process and produces a crash dump

      Usage Guidelines


      Note


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


      Requirements

      Command privilege level: 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


      Because running this command can affect system performance, Cisco recommends that you run the command during off-peak hours.


      The display includes both deleted and new files.

      Defaults

      The default value of detection-size-kb 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

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • directory/filename specifies the path and filename of the files to delete. You can use the wildcard character (*) for filename.

      Options

      • detail—Displays a listing of deleted files with the date and time.
      • noconfirm—Deletes files without asking you to confirm each deletion.

      Usage Guidelines


      Caution


      You cannot recover a deleted file except, possibly, by using the Disaster Recovery System.


      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.log

      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

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • directory/filename specifies the path and filename of the file to dump. You can use the wildcard character (*) for filename as long as it resolves to one file.

      Options

      • detail—Displays listing with the date and time
      • hex—Displays output in hexadecimal
      • regexp expression—Displays only the lines in the file that match the regular expression expression.
      • recent—Displays the most recently modified file in the directory.

      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.idx

      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]

      partBsalog directory/filename [reltime] [abstime] [match] [recurs]

      salog directory/filename [reltime] [abstime] [match] [recurs]

      Parameters

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • partBsalog specifies the partBsalog log directory.
      • salog specifies the salog log directory.
      • directory/filename specifies the path to the files to delete. You can use the wildcard character (*) for filename as long as it resolves to one file.

      Options

      • abstime—Absolute time period, specified as hh:mm:MM/DD/YY hh:mm:MM/DD/YY
      • reltime—Relative time period, specified as months | weeks | days | hours | minutes value
      • match—Match a particular string in the filename, specified as string value
      • recurs—Get all files, including subdirectories

      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 plat

      This command gets all operating system log files for a particular time period:

      file get activelog platform/log abstime 18:00:9/27/2005 18:00:9/28/2005

      file 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

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • partBsalog specifies the partBsalog log directory.
      • salog specifies the salog log directory.
      • directory specifies the path to the directory to list. You can use a wildcard character (*) for directory as long as it resolves to one directory.

      Options

      • detail—Long listing with date and time
      • date—Sort by date
      • size—Sort by file size
      • reverse—Reverse sort direction
      • page—Displays the output one screen at a time

      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 detail

      This example lists directories created for Emergency Responder logs.

      file list activelog er/logs

      This example lists Emergency Responder logs in a specified directory by size.

      file list activelog er/logs size

      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

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • reg-exp represents a regular expression.
      • directory/filename represents the path to the files to search. You can use the wildcard character (*) to represent all or part of the filename.

      Options

      • abstime—Specifies which files to search based on file creation time. Enter a start time and an end time.
      • days|hours|minutes—Specifies whether the file age is in days, hours, or minutes.
      • ignorecase—Ignores case when searching
      • reltime—Specifies which files to search based on file creation time. Enter the age of files to search.
      • hh:mm:ss mm/dd/yyyy—An absolute time, in the format hours:minutes:seconds month/day/year.
      • timevalue—The age of files to search. The unit of this value is specified with the {days | hours | minutes} option.

      Usage Guidelines

      Write the search term in the form of a regular expression, which is a special text string for describing a search pattern.

      If the search term is found in only one file, the filename appears at the top of the output. If the search term is found in multiple files, each line of the output begins with the filename in which the matching line was found.

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      Example

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

      file 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

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • directory/filename specifies the path to the file to tail. You can use the wildcard character (*) for filename as long as it resolves to one file.

      Options

      • detail—Long listing with date and time
      • hex—Hexadecimal listing
      • lines—Number of lines to display

      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.log

      file 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

      • activelog specifies a log on the active side.
      • inactivelog specifies a log on the inactive side.
      • install specifies an installation log.
      • system-management-log displays the contents of the Integrated Management Logs (IML).
      • directory/filename specifies the path to the file to view. You can use the wildcard character (*) for filename as long as it resolves to one file.

      Usage Guidelines


      Caution


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


      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      Examples

      This example displays the install log:

      file view install install.log

      This example displays a particular CDR file:

      file view activelog er/logs/CERAdmin01.log

      run sql

      This command allows you to run an SQL command.

      Command Syntax

      run sql sql_statement

      Parameters

      • sql_statement represents the SQL command to run.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      Examples

      This example runs an SQL command:

      run sql select * from cerserver

      set account

      This command sets up a new account on the operating system.

      Command Syntax

      set account name

      Parameters

      • name represents the username for the new account.

      Usage Guidelines

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

      Requirements

      Command privilege level: 0

      Allowed during upgrade: No

      set account enable

      This command is used to enable the user account if the account is disabled due to password inactivity feature.

      Password inactivity period is the number of days of inactivity after a password has expired before the account is disabled.

      Upon executing this command the user account is enabled with current system settings.The system settings are Password min days, Password Max days, Password inactivity period.

      Command Syntax

      set account enable userid

      Parameter

      userid is name of the user account

      Example

      set account enable test

      Enabling the account 'test' with current settings....

      .....

      Successfully enabled account 'test'

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      show accountlocking

      This shows the current account locking settings

      Command Syntax

      show accountlocking

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set accountlocking disable

      This command disables accountlocking for the current admin accounts.

      Command Syntax

      set accountlocking disable

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set accountlocking enable

      This command enables accountlocking for the current admin accounts.

      Command Syntax

      set accountlocking enable

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      set accountlocking unlocktime

      This command is used to configure the unlock time for Emergency Responder OS admin accounts in seconds.

      Acceptable values should be equal to or greater than 300 seconds but less than 3600 seconds (60 mins).

      Command Syntax

      set accountlocking unlocktime seconds

      Parameter

      seconds is unlocktime in seconds

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set cert delete

      It deletes the certificate test.pem for the unit ipsec.

      Command Syntax

      set cert delete [unit] [name]

      Parameter

      unit is name of the trust category

      name is certificate file name

      Example:

      set cert delete ipsec test.pem

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set cert import

      It imports the certificate for the unit name of type own | trust.

      Command Syntax

      set cert import [unit name]

      Parameter

      name is unit name

      Example:

      set cert import trust tomcat

      Successfully regenerated certificate for tomcat.

      Please restart services related to tomcat for the new certificate to become active.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set csr gen

      It regenerates the certificate for the unit name.

      Command Syntax

      set csr gen [name]

      Parameter

      name is unit name; for example tomcat.

      Example

      set csr gen tomcat

      Successfully regenerated certificate for tomcat.

      Please restart services related to tomcat for the new certificate to become active.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set cert regen

      It regenerates the certificate for the unit name.

      Command Syntax

      set cert regen [name]

      Parameter

      Name is unit name

      Example:

      set cert regen tomcat

      Successfully regenerated certificate for tomcat.

      Please restart services related to tomcat for the new certificate to become active.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      show csr list

      This displays the selected own CSR File.

      Command Syntax

      show csr list type

      Example

      show csr list own

      tomcat/tomcat.csr

      Vipr-QuetzalCoatl/Vipr-QuetzalCoatl.csr

      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

      • unit-name represents the name of the certificate that you want to regenerate.

      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

      • on turns pagination On.
      • off turns pagination Off.

      Requirements

      Level privilege: 1

      Command privilege: 1

      Allowed during upgrade: No

      Example

      admin:set cli pagination offAutomatic pagination is turned off

      set date

      This command sets the date on system.

      Command Syntax

      set date HH:mm:ss:MM/DD/YY

      HH:mm:ss: The time format (24 hours format)

      MM/DD/YY: The date format.


      Note


      Following format is also accepted: MM/DD/YYYY: The date format.


      Example

      To set date and time to 2:10:33 p.m. February 13, 2008

      set date 14:10:33:02/13/08

      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

      • policy-name represents an IPSec policy.
      • association-name represents an IPSec association.

      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 cluster publisher hostname

      This command configures the cluster publisher hostname. Changing the hostname is possible only from the subscriber in a server group. This is supported when migrating from MCS to VMware platforms, but not in any other scenarios.

      A temporary loss of network connectivity occurs while the network is being restarted with the new configuration.

      Command Syntax

      set network cluster publisher hostname name

      Name is hostname to be assigned

      set network cluster publisher ip

      This command configures the cluster publisher IP address.

      A temporary loss of network connectivity occurs while the network is being restarted with the new configuration.

      Command Syntax

      set network cluster publisher ip addr

      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

      • eth0 specifies Ethernet interface 0.
      • enable enables DHCP.
      • disable disables DHCP.
      • node_ip is the new static IP address for the server.
      • net_mask is the subnet mask for the server.
      • gateway_ip is the IP address of the default gateway.

      Usage Guidelines

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


      Caution


      If you continue, this command causes the system to restart. Cisco also recommends that you restart all nodes whenever any IP address gets changed.


      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

      • ip-address represents the IP address of the primary or secondary DNS server.

      Usage Guidelines

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


      Caution


      If you continue, this command causes a temporary loss of network connectivity. If you change the IP address of the DNS server, you must restart Cisco Tomcat. For more information, see utils service.


      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

      • timeout sets the DNS request timeout.
      • attempts sets the number of times to attempt a DNS request before quitting.
      • rotate causes the system to rotate among the configured DNS servers, distributing the load.
      • seconds specifies the DNS timeout period, in seconds.
      • number specifies the number of attempts.

      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

      • domain-name represents the system domain that you want to assign.

      Usage Guidelines

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


      Caution


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


      Requirements

      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

      • enable enables Network Fault Tolerance.
      • disable disables Network Fault Tolerance.

      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

      • ip-address represents the IP address of the network gateway that you want to assign.

      Usage Guidelines

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


      Caution


      If you continue, this command causes the system to restart.


      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

      • eth0 specifies Ethernet interface 0.
      • ip-address represents the IP address that you want assign.
      • ip-mask represents the IP mask that you want to assign.

      Usage Guidelines

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


      Caution


      If you continue, this command causes the system to restart.


      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

      • mtu_max specifies the maximum MTU value.

      Note


      The system default MTU value equals 1500.


      Usage Guidelines

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


      Caution


      If you continue, the system temporarily loses network connectivity.


      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 connectivity
      
                Do you want to continue?
      
      Enter "yes" to continue or any other key to abort
      
      yes
      executing...

      set network max_ip_contrack

      This command sets the ip_conntrack_max value.

      Command Syntax

      set network max_ip_conntrack ip_conntrack_max

      Parameters

      • ip_conntrack_max specifies the value for ip_conntrack_max.

      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

      • eth0 specifies Ethernet interface 0.
      • auto specifies whether auto negotiation gets enabled or disabled.
      • speed specifies whether the speed of the Ethernet connection: 10 or 100 Mbps.
      • duplex specifies half-duplex or full-duplex.

      Usage Guidelines

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


      Note


      You can enable only one active NIC at a time.



      Caution


      If you continue, this command causes a temporary loss of network connections while the NIC gets reset.


      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

      • enable enables Path MTU Discovery.
      • disable disables Path MTU Discovery.

      Usage Guidelines

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


      Caution


      If you continue, the system temporarily loses network connectivity.


      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 connectivity
      
                Do you want to continue?
      
      Enter "yes" to continue or any other key to abort
      yes
      executing...
      admin:

      set network restore

      This command configures the specified Ethernet port to use a specified static IP address.


      Caution


      Only use this command option if you cannot restore network connectivity using any other set network commands. This command deletes all previous network settings for the specified network interface, including Network Fault Tolerance. After running this command, you must restore your previous network configuration manually.



      Caution


      The server temporarily loses network connectivity when you run this command.


      Command Syntax

      set network restore eth0 ip-address network-mask gateway

      Parameters

      • eth0 specifies Ethernet interface 0.
      • ip-address specifies the IP address.
      • network-mask specifies the subnet mask.
      • gateway specifies the IP address of the default gateway.

      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

      • eth0 specifies Ethernet interface 0.

      Usage Guidelines

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


      Caution


      If you continue, the system temporarily loses network connectivity.


      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

      • eth0 specifies Ethernet interface 0.

      Usage Guidelines

      The systems prompts you for the old and new passwords.


      Note


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


      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

      1. Change the security password on the publisher server and then reboot the server.
      2. Change the security password on all the subscriber servers to the same password that you created on the publisher server and restart the subscriber server to propagate the password change.

      Note


      Cisco recommends that you restart each server after the password is changed on that server.



      Caution


      Failure to reboot the servers causes system service problems and problems with the Emergency Responder Administration on the subscriber servers.


      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set password history

      This command sets number of passwords to maintain in history.

      Command Syntax

      set password history number

      Parameters

      • number represents the number of passwords to maintain in history.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set password inactivity disable

      This command disables the password inactivity for the OS accounts.

      Command Syntax

      set password inactivity disable

      set password inactivity enable

      This command enables the password inactivity for the OS accounts with the default value set as 10 days.

      Command Syntax

      set password inactivity enable

      set password inactivity period

      This command sets the password inactivity for the OS accounts with the configured value.

      Acceptable values are 1-99 days.

      Command Syntax

      set password inactivity period days

      Parameters

      days represents the number of days for which we have to set inactivity.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set password expiry maximum-age enable

      This command is used to enable password expiry for OS accounts. This command sets the value of maximum password age to 3650 days (10 yrs) for Emergency Responder OS admin accounts.

      Command Syntax

      set password expiry maximum-age enable

      set password expiry maximum-age disable

      This command is used to disable password expiry for OS accounts.

      This means passwords for Emergency Responder OS admin accounts never expires.

      Command Syntax

      set password expiry maximum-age disable

      set password expiry minimum-age enable

      This command is used to enable password expiry for OS accounts.

      This command sets the value of minimum password age to 1 day (24 hrs) for OS admin accounts.

      Command Syntax

      set password expiry minimum-age enable

      set password expiry minimum-age disable

      This command is used to disable minimum password aging for OS accounts.

      This means passwords for OS admin accounts can be changed at any interval.

      Command Syntax

      set password expiry minimum-age disable

      set password expiry user maximum-age disable

      This command is used to disable password expiry for a particular OS account.

      Command Syntax

      set password expiry user maximum-age disable userid

      Parameter

      userid is the name of account for which we want to disable maximum password age settings.

      set password expiry user maximum-age enable

      Use this command to enable password expiry for a particular OS account.

      Command Syntax

      set password expiry user maximum-age enable userid

      Parameter

      userid is the name of account for which we want to enable maximum password age settings.

      set password expiry user minimum-age disable

      This command is used to disable minimum password age settings for a particular OS account.

      Command Syntax

      set password expiry user minimum-age disable userid

      Parameter

      userid is the account for which we want to disable minimum password age settings.

      set password expiry minimum-age enable

      This command is used to enable minimum password age for a particular OS account.

      Command Syntax

      set password expiry user minimum-age enable userid

      Parameter

      userid is the account for which we want to enable minimum password age settings.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set password age minimum

      This command is used to modify the value of minimum password age for OS admin accounts in days.

      Acceptable values should be equal to or greater than 0 days but less or equal to 10 days.

      Command Syntax

      set password age minimum days

      Parameter

      days is the minimum password age in days

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set password age maximum

      This command is used to modify the value of maximum password age for Emergency Responder OS admin accounts in days.

      Acceptable values should be equal to or greater than 10 days but less than 3650 days (10 years).

      Command Syntax

      set password age maximum days

      Parameter

      Days is maximum password age in days

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set password complexity character disable

      This disables password complexity. Changes take effect only at the next password change.

      When disabled the password created or changed after executing the command is no longer strong. In other words password need not have a uppercase, lowercase, digit and special characters.

      Command Syntax

      set password complexity character disable

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      set password complexity character enable

      Use this command to enable password complexity rules for the type of characters in a password.

      When enabled, the passwords needs to follow these guidelines:

      1. It must have at least one lower-case character.

      2. It must have at least one uppercase, one digit and one special character.

      3. All of the adjacent characters on the keyboard are not accepted.

      4. Any of the previous ten passwords cannot be reused.

      5. The admin user password can only be changed only once in 24 hours.

      A violation of any of the preceding rules results in a failure.

      Command Syntax

      set password complexity character enable

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set password complexity minimum-length

      This command is used to modify the value of minimum password length for Unified CM OS accounts.

      Acceptable values should be equal to or greater than 6. Use this command only after

      enabling the character complexity of passwords.

      Command Syntax

      set password complexity minimum-length length

      Parameter

      Length is minimum password length

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set password user admin

      This sets a new admin password

      Command Syntax

      set password user admin

      Example:

      set password user admin

      Please enter the old password :********

      Please enter the new password:********

      re-enter new password to confirm:********

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      set password user security

      This sets a new platform security password

      Command Syntax

      set password user security

      Example:

      set password user security

      Please enter the password:********

      re-enter the password to confirm: ********

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils import config

      This command imports all configuration settings found on the platformConfig.xml file and then reboots the system.

      Command Syntax

      utils import config

      set smtp

      This command sets the SMTP server hostname.

      Command Syntax

      set smtp hostname

      Parameters

      • hostname represents the SMTP server name.

      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

      • timezone specifies the new timezone.

      Usage Guidelines

      Enter enough characters to uniquely identify the new time zone. Be aware that the time-zone name is case-sensitive.


      Caution


      You must restart the system after you change the time zone.


      Requirements

      Command privilege level: 0

      Allowed during upgrade: No

      Example

      This example sets the time zone to Pacific time.

      set timezone Pac

      set 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

      • tname represents the task for which you want to enable or disable traces.
      • enable Error sets task trace settings to the error level.
      • enable Special sets task trace settings to the special level.
      • enable State_Transition sets task trace settings to the state transition level.
      • enable Significant sets task trace settings to the significant level.
      • enable Entry_exit sets task trace settings to the entry_exit level.
      • enable Arbitrary sets task trace settings to the arbitrary level.
      • enable Detailed sets task trace settings to the detailed level.
      • disable unsets the task trace settings.

      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

      • orgunit represents the organizational unit.
      • orgname represents the organizational name.
      • locality represents the organization location.
      • state represents the organization state.
      • country represents the organization country.
      • alternate-host-name (optional) specifies an alternate name for the host when you generate a web-server (Tomcat) certificate.

        Note


        When you set an alternate-host-name parameter with the set web-security command, self-signed certificates for tomcat contains the Subject Alternate Name extension with the alternate-host-name specified. CSR for Emergency Responder contains Subject Alternate Name Extension with the alternate host name included in the CSR.


      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

      • activelog sets the working directory for active logs.
      • inactivelog set the working directory for inactive logs.
      • install sets the working directory for installation logs.
      • directory represents the current working directory.

      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

      • filename represents the name of the certificate file.
      • own specifies owned certificates.
      • trust specifies trusted certificates.
      • list specifies a certificate trust list.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      Example

      This command displays own certificate trust lists.

      show cert list own

      show 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 date

      This command shows the system date.

      Command Syntax

      show date

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      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

      • activelog displays disk usage information about the activelog directory.
      • common displays disk usage information about the common directory.
      • inactivelog displays disk usage information about the inactivelog directory.
      • install displays disk usage information about the install directory.
      • tmp displays disk usage information about the tmp directory.

      Options

      • filename filename—Saves the output to a file specified by filename. These files are stored in the platform/cli directory. To view saved files, use the file view activelog command.
      • directory—Displays just the directory sizes.
      • sort—Sorts the output based on file size. File sizes are displayed in 1024-byte blocks.

      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

      • fans—Displays information gathered by fan probes
      • power-supply—Displays information gathered by power supply probes
      • temperatures—Displays information gathered by temperature probes

      show firewall list

      This command displays system aspects of the server.

      Command Syntax

      show firewall list [detail] [page] [file filename]

      Options

      • detail—Displays detailed statistics on every available device on the system
      • page—Displays the output one page at a time
      • file filename—Outputs the information to a file

      Note


      The file option saves the information to platform/cli/filename.txt. Ensure the file name does not contain the "." character.


      Requirements

      Command privilege level: 1

      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:

      • Platform
      • Serial number
      • BIOS build level
      • BIOS manufacturer
      • Active processors
      • RAID controller status

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      show ipsec

      This command displays information about IPSec policies and associations.

      Command Syntax

      show ipsec

      policy

      association policy

      information policy association

      status

      Parameters

      • policy displays all IPSec policies on the node.
      • association displays the association list and status for the policy.
      • information displays the association details and status for the policy.
      • status displays the status of all IPsec tunnels that are defined in the system.
      • policy represents the name of a specific IPSec policy.
      • association represents the association name.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: yes

      Example

      This example displays IPSec policies.

      show ipsec policy

      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 server memory.

      Command Syntax

      show memory

      count

      module [ALL | module_number]

      size

      Options

      • count—Displays the number of memory modules on the system
      • module—Displays detailed information about each memory module
      • size—Displays the total amount of memory

      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

      • eth0 specifies Ethernet 0.
      • failover specifies Network Fault Tolerance information.
      • route specifies network routing information.
      • status specifies active Internet connections.
      • ip_conntrack specifies ip_conntrack usage information.
      • max_ip_conntrack specifies max_ip_conntrack information.
      • dhcp eth0 status displays DHCP status information.
      • all specifies all basic network information.

      Options

      • options—Displays additional information
      • detail—Displays more detailed additional information
      • page—Displays information 1 page at a time.
      • listen—Displays only listening sockets
      • process—Displays the process ID and name of the program to which each socket belongs
      • all—Displays both listening and nonlistening sockets
      • nodns—Displays numerical addresses without any DNS information
      • search stext—Searches for the stext in the output

      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 status

      show 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 public 
      Application IPProtocol PortValue  Type       XlatedPort Status   Description  
      ----------- ---------- ---------- ---------- ---------- -------- ------------ 
      sshd         tcp       22         public     -          enabled  sftp and ssh access 
      tomcat       tcp       8443       translated 443        enabled  secure web access 
      tomcat       tcp       8080       translated 80         enabled  web access   
      clm          udp       8500       public     -          enabled  cluster manager 
      clm          tcp       8500       public     -          enabled  cluster manager 
      ntpd         udp       123        public     -          enabled  network time sync 
      snmpdm       udp       161        public     -          enabled  SNMP         
      ccm          tcp       2000       public     -          enabled  SCCP-SIG     
      ctftp        udp       6969       translated 69         enabled  TFTP access to CUCM TFTP Server 
      ctftp        tcp       6970       public     -          enabled  HTTP access to CUCM TFTP Server
      admin:

      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

      • files displays open files on the system.
      • ports displays open ports on the system.

      Options

      • all—Displays all open files or ports
      • process—Displays open files that belong to the specified process
      • processID—Specifies a process
      • regexp—Displays open files or ports that match the specified regular expression
      • reg_exp—A regular expression

      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

      • page—Displays the output one page at a time

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      show password expiry maximum-age

      This command can be used to see the configured password expiration parameters.

      Command Syntax

      show password expiry maximum-age

      show password expiry minimum-age

      This command can be used to see the configured password expiration parameters.

      Command Syntax

      show password expiry minimum-age

      show password expiry user maximum-age

      This command can be used to see the configured password expiration parameters for a particular OS user.

      Command Syntax

      show password expiry user maximum-age userid

      show password expiry user minimum-age

      This command can be used to see the configured password expiration parameters for a particular OS user.

      Command Syntax

      show password expiry user minimum-age userid

      show password history

      This command displays the number of passwords that are maintained in the history

      for OS admin accounts.

      Command Syntax

      show password history

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      show password inactivity

      This command displays the status of the password inactivity for OS accounts.

      Password inactivity is the number of days of inactivity after a password has expired before the account is disabled.

      Command Syntax

      show password inactivity

      Example

      show password inactivity

      Password Inactivity: Enabled and is currently set to 10 days

      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

      • list displays a list of all the processes and critical information about each process, and visually indicates the child-parent relationships between the processes.
      • load displays the current load on the system.
      • name displays the details of processes that share the same name and indicates their parent-child relationship.
      • open-fd lists the open file descriptors for a comma-separated list of process IDs.
      • search searches for the pattern specified by the regular expression regexp in the output of the operating system-specific process listing.
      • using-most cpu displays a list of the most CPU-intensive processes.
      • using-most memory displays a list of the most memory-intensive processes.

      Options

      • file filename—Outputs the results to the file specified by filename
      • detail—Displays detailed output
      • cont—Repeats the command continuously
      • clear—Clears the screen before displaying output
      • noidle—Ignore the idle/zombie processes
      • num number—Displays the number of processes specified by number. The default number of processes is 10. Set number to all to display all processes.
      • thread—Displays threads
      • [cpu | memory | time]—Sorts output by CPU usage, memory usage, or time usage. The default is to sort by CPU usage.
      • page—Displays the output in pages
      • process—Specifies the name of a process
      • process-id—Specifies the process ID number of a process
      • regexp—A regular expression
      • number—The number of processes to display. The default is 5.

      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

      • kilo—Displays statistics in kilobytes
      • detail—Displays detailed statistics on every available device on the system and overrides the kilo option
      • page—Displays one page at a time
      • file filename—Outputs the information to a file

      Note


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


      Requirements

      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:

      • Host name
      • Date
      • Time zone
      • Locale
      • Product version
      • Platform version
      • CPU usage
      • Memory and disk usage

      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

      • page—Displays one page at a time
      • file filename—Outputs the information to a file

      Note


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


      Requirements

      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

      • dump creates a CSV file of the entire database.
      • sessions redirects the session and SQL information of the present session IDs to a file.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      show tech database dump

      This command creates a CSV file of the entire database.

      Command Syntax

      show tech database dump

      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

      • all displays all network tech information.
      • hosts displays information about hosts configuration.
      • interfaces displays information about the network interfaces.
      • resolv displays information about hostname resolution.
      • routes displays information about network routes.
      • sockets displays the list of open sockets.

      Options

      • page—Displays one page at a time
      • search text—Searches the output for the string specified by text. The search is case insensitive.
      • file filename—Outputs the information to a file
      • numeric—Displays the numerical addresses of the ports instead of determining symbolic hosts. It is equivalent to running the Linux shell command netstat [-n] command.

      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 Emergency Responder 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

      • all displays all runtime information.
      • cpu displays CPU usage information at the time the command is run.
      • disk displays system disk usage information.
      • env displays environment variables.
      • memory displays memory usage information.

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

      • all displays all of the system information.
      • bus displays information about the data buses on the server.
      • hardware displays information about the server hardware.
      • host displays information about the server.
      • kernel lists the installed kernel modules.
      • software displays information about the installed software versions.
      • tools displays information about the software tools on the server.

      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

      • page—Displays the output one page at a time
      • csv—Sends the output to a comma separated values file

      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

      • config displays the current time zone settings.
      • list displays the available time zones.

      Options

      • page—Displays the output one page at a time

      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


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


      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      Example

      This example displays trace information for CDP.

      show trace cdps

      show 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

      • policy-name represents the name of an IPSec policy.
      • association-name represents the name of an IPSec association.

      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

      • timeout sets the wait time before the system considers a DNS query failed to the default.
      • attempts sets the number of DNS attempts to make before failing to the default.
      • rotate sets the method for selecting a nameserver to the default. This affects how loads are distributed across nameservers.

      Usage Guidelines

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


      Caution


      If you continue, the system temporarily loses network connectivity.


      unset network domain

      This command unsets the domain name, the command restarts the server.

      Command Syntax

      unset network domain

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      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

      • core file name specifies the name of a core file.

      Usage Guidelines

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

      utils create report

      This command creates reports about the server in the platform/log directory.

      Command Syntax

      utils create report

      hardware

      platform

      csa

      Parameters

      • hardware creates a system report containing disk array, remote console, diagnostic, and environmental data.
      • platform collects the platform configuration files into a TAR file.
      • csa collects all the files required for CSA diagnostics and assembles them into a single CSA diagnostics file. You can retrieve this file by using the file get command.

      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


      You must restart the system after you start CSA.


      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


      You must restart the Emergency Responder Subscriber node from CUOS Administration or using the CLI command utils system restart after executing utils dbreplication reset command. Please see help utils dbreplication reset CLI command for more details.


      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

      • fix runs all diagnostic commands and attempts to fix problems.
      • list lists all available diagnostic commands.
      • module runs a single diagnostic command or group of commands and attempts to fix problems.
      • test runs all diagnostic commands but does not attempt to fix problems.
      • version displays the diagnostic framework version.
      • module_name is the name of a diagnostics module.

      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

      • featurelist specifies the list of features to back up, separated by commas.
      • tapeid represents the ID of an available tape device.

      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

      • featurelist specifies the list of features to back up, separated by commas.
      • path represents the location of the backup files on the remote server.
      • servername represents the IP address or host name of the server where you stored the backup files.
      • username represents the username that is needed to log in to the remote server.

      Usage Guidelines


      Note


      The system prompts you to enter the password for the account on the remote server.


      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 add local

      This adds the backup local device.

      Command Syntax

      utils disaster_recovery device add local device_name Number_of_backups

      Parameter

      device_name is name of back up device

      Number_of_backups is the number of back ups we want.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery device add network

      This adds the backup network device.

      Command Syntax

      utils disaster_recovery device add network device_name path server_name/ip_address username Number_of_backups

      Parameters

      device_name is name of the backup device to be added

      path is path to retrieve backup device from this location

      server_name/ip_address is hostname or ip address of the server where the backup file needs to be stored.

      username is user id to connect to remote machine

      Optional Parameter

      Number_of_backups Number of backups to store on Network Directory(default 2)

      Example:

      utils disaster_recovery device add network 
      networkDevice /root 10.77.31.116 root 3

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery device add tape

      This adds the backup tape device.

      Command Syntax

      utils disaster_recovery device add tape device_name tapeid

      Parameter

      device_name is name of the backup device to be added

      tapeid is tapeid

      Example:

      utils disaster_recovery device add tape tapeDevice /dev/nst0

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery device delete

      This deletes the device.

      Command Syntax

      utils disaster_recovery device delete device_name|*

      Parameter

      device_name is name of the device to be deleted

      * means deletes all the existing devices except for the ones associated to a schedule.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery device list

      This shows device name device type and device path for all the backup device.

      Command Syntax

      utils disaster_recovery device list

      Example:

      utils disaster_recovery device list
      sftpdevice                 NETWORK               10.77.31.116 : /root
      tapedevice                 TAPE                  /dev/nst0
      localdevice                LOCAL                 /common/drfbackup

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      utils disaster_recovery history

      This shows the history of previous Backup\Restore

      Command Syntax

      utils disaster_recovery history operation

      Parameter

      Operation is name of operation like Backup\Restore

      Example:

      utils disaster_recovery history backup
      Tar Filename: Backup Device: Completed On: Result: Backup Type: Features Backed Up:
      2009-10-30-14-53-32.tar TAPE  Fri Oct 30 14:55:31 CDT 2009   ERROR    MANUAL
      2009-12-10-10-30-17.tar TAPE  Thu Dec 10 10:35:22 CST 2009   SUCCESS  MANUAL          CDR_CAR,CCM

      utils disaster_recovery schedule add

      This adds the configured schedules

      Command Syntax

      utils disaster_recovery schedule add schedulename devicename featurelist datetime frequency

      Parameter

      schedulename is name of the scheduler.

      devicename is name of the device for which scheduling is done.

      featurelist is Comma separated feature list to backup.

      datetime is date when the scheduler is set. format - (yyyy/mm/dd-hh:mm) 24 hr clock

      frequency is frequency at which the scheduler is set to take a backup.eg: ONCE, DAILY, WEEKLY and MONTHLY

      Example:

      utils disaster_recovery schedule add schedulename devicename featurelist 
      datetime frequency
      Schedule has been saved successfully.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      utils disaster_recovery schedule delete

      The specified schedule is deleted

      Command Syntax

      utils disaster_recovery schedule delete schedulename|*

      Parameter

      schedulename is the name of the schedule that needs to be deleted

      * deletes all the existing schedules

      Example:

      utils disaster_recovery schedule delete schedule1|*
      Schedules deleted successfully.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery schedule disable

      The specified schedule is disabled

      Command Syntax

      utils disaster_recovery schedule disable schedulename

      Parameter

      schedulename is the name of the schedule that needs to be disabled

      Example:

      utils disaster_recovery schedule disable schedule1
      Schedule disabled successfully.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery schedule enable

      The specified schedule is enabled

      Command Syntax

      utils disaster_recovery schedule enable schedulename

      Parameter

      schedulename is the name of the schedule that needs to be enabled

      Example:

      utils disaster_recovery schedule enable schedule1
      Schedule enabled successfully.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils disaster_recovery schedule list

      This shows all the schedules configured

      Command Syntax

      utils disaster_recovery schedule list

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      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

      • server specifies the hostname of the server that you want to restore.
      • tarfilename specifies the name of the file to restore.
      • tapeid specifies the name of the tape device from which to perform the restore job.

      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

      • restore_server specifies the hostname of the server that you want to restore.
      • tarfilename specifies the name of the file to restore.
      • path represents the location of the backup files on the remote server.
      • servername represents the IP address or host name of the server where you stored the backup files.
      • username represents the username that is needed to log in to the remote server.

      Usage Guidelines


      Note


      The system prompts you to enter the password for the account on the remote server.


      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

      • tapeid represents the ID of an available tape device.

      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

      • path represents the location of the backup files on the remote server.
      • servername represents the IP address or host name of the server where you stored the backup files.
      • username represents the username that is needed to log in to the remote server.

      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

      • hostname specifies the server for which you want to display registration information.

      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

      • operation specifies the name of the ongoing operation: backup or restore.

      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

      • disable—Prevents the file I/O reporting service from starting automatically when the machine boots. This command does not stop the service without a reboot. Use the stop option to stop the service immediately.
      • enable—Enables the file I/O reporting service to start automatically when the machine boots. This command does not start the service without a reboot. Use the start option to start the service immediately.
      • list—This command displays a list of file I/O events, in chronological order, from oldest to newest.
      • start—Starts a previously stopped file I/O reporting service. The service remains in a started state until it is manually stopped or the machine is rebooted.
      • status—Displays the status of the file I/O reporting service.
      • stop—Stops the file I/O reporting service. The service remains in a stopped state until it is manually started or the machine is rebooted.
      • top—Displays a list of top processes that create file I/O. This list can be sorted by the total number of bytes read, the total number of bytes written, the rate of bytes read, or the rate of bytes written.
      • start—Specifies a starting date and time.
      • stop—Specifies a stopping date and time.
      • date-time—specifies a date and time, in any of the following formats: H:M, H:M:S a, H:M, a, H:M:S Y-m-d, H:M, Y-m-d, H:M:S.
      • number—Specifies how many of the top processes to list.
      • [read | write | read-rate | write-rate]—Specifies the metric used to sort the list of top process.

      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

      • disable disables the firewall.
      • time specifies the duration for which the firewall is disabled, in one of these formats:
        • [0-1440]m to specify a duration in minutes.
        • [0-24]h to specify a duration in hours.
        • [0-23]h[0-60]m to specify a duration in hours and minutes. If you do not specify a time, the default is 5 minutes.
      • list displays the current firewall configuration.
      • status displays the status of the firewall.

      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

      • interval represents the value in seconds between two iostat readings (mandatory if you specify the number of iterations)
      • interations represents the number of iostat iterations to be performed (mandatory if you specify an interval)
      • filename redirects the output to a file

      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

      • start starts the netdump client.
      • status displays the status of the netdump client.
      • stop stops the netdump client.
      • ip-address-of-netdump-server specifies the IP address of the netdump server to which the client sends diagnostic information.

      Usage Guidelines

      If a kernel panic crashes, 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

      • add-client adds a netdump client.
      • delete-client deletes a netdump client.
      • list-clients lists the clients that are registered with this netdump server.
      • start starts the netdump server.
      • status displays the status of the netdump server.
      • stop stops the netdump server.
      • ip-address-of-netdump-client specifies the IP address of a netdump client.

      Usage Guidelines

      If a kernel panic crashs, 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 Emergency Responder server as both a netdump client and server.

      If the server is on another Emergency Responder 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

      • list lists the contents of the address resolution protocol table.
      • set sets an entry in the address resolution protocol table.
      • delete deletes an entry in the address resolution table.
      • host represents the host name or IP address of the host to add or delete to the table.
      • address represents the MAC address of the host to be added. Enter the MAC address in the following format: XX:XX:XX:XX:XX:XX.

      Options

      • page—Displays the output one page at a time
      • numeric—Displays hosts as dotted IP addresses

      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

      • eth0 specifies Ethernet interface 0.

      Options

      • page—Displays the output one page at a time When you use the page or file options, the complete capture of all requested packets must occur before the command completes.
      • numeric—Displays hosts as dotted IP addresses
      • file fname—Outputs the information to a file The file option saves the information to platform/cli/fname.cap. The filename cannot contain the "." character.
      • count num—Sets a count of the number of packets to capture For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10,000.
      • size bytes—Sets the number of bytes of the packet to capture For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL.
      • src addr—Specifies the source address of the packet as a host name or IPV4 address
      • dest addr—Specifies the destination address of the packet as a host name or IPV4 address
      • port num—Specifies the port number of the packet, either source or destination

      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

      • hostname represents the host name or IP address that you want to resolve.

      Options

      • server-name—Specifies an alternate domain name server
      • page—Displays the output one screen at a time
      • detail—Displays a detailed listing
      • srv—Displays DNS SRV records.

      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

      • destination represents the hostname or IP address of the server that you want to ping.

      Options

      • count—Specifies the number of times to ping the external server. The default count equals 4.

      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

      • destination represents the hostname or IP address of the server to which you want to send a trace.

      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 server add

      The command adds up to 5 specified ntp servers.

      norestart results in the ntp service not being restarted after adding the servers.


      Note


      If the norestart option is used, an explicit restart of the NTP service is required for the changes to take effect.


      Command Syntax

      utils ntp server add s1 [s2 s3 s4 s5] [norestart]

      Parameter

      mandatory parameter: at least one ntp server to add

      optional parameters: up to four more ntp servers and the norestart option.

      Example 1: Adding servers with incorrect command line parameters

      --------------------------------------------------------------
      admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8
      Incorrect number of parameters entered for add
      usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]
      admin:

      Example 2: Adding using norestart without specifying a server

      -----------------------------------------------------------
      admin:utils ntp server add norestart
      At least one NTP server must be specified for add operation.
      usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]

      Example 3: Adding servers without norestart

      -----------------------------------------
      admin:utils ntp server add clock1.cisco.com clock2.cisco.com
      clock1.cisco.com :  added successfully.
      clock2.cisco.com :  added successfully.
      Restarting NTP on the server.

      Example 4: Adding servers that are already added, without norestart

      -----------------------------------------------------------------
      admin:utils ntp server add clock1.cisco.com clock2.cisco.com
      clock1.cisco.com : [The host has already been added as an NTP server.]
      clock2.cisco.com : [The host has already been added as an NTP server.]
      admin:

      Example 5: Adding server to self without norestart

      ------------------------------------------------
      admin:utils ntp server add bglr-ccm26
      bglr-ccm26 : [This server cannot be added as an NTP server.]
      admin:

      Example 6: Adding inaccessible server without norestart

      -----------------------------------------------------
      admin:utils ntp server add clock3.cisco.com
      clock3.cisco.com : [ Inaccessible NTP server. Not added. ]
      admin:

      Example 7: Adding servers with norestart

      --------------------------------------
      admin:utils ntp server add ntp01-syd.cisco.com ntp02-syd.cisco.com clock.cisco.com 
      norestart
      ntp01-syd.cisco.com:  added successfully.
      ntp02-syd.cisco.com:  added successfully.
      clock.cisco.com:  added successfully.
      The NTP service must be restarted for the changes to take effect.

      Example 8: Adding servers when 5 are already configured

      -----------------------------------------------------
      admin:utils ntp server add clock3.cisco.com
      The maximum permissible limit of 5 NTP servers is already configured

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      utils ntp server delete

      The command presents the user with the option to delete any configured ntp server or all of them.

      After the user enters their choice, they are prompted if they would like to restart the NTP service.

      Answering No results in the ntp service not being restarted after deleting the servers.


      Note


      If the user chooses not to restart the NTP service, an explicit restart of the NTP service is required for the changes to take effect.


      Command Syntax

      utils ntp server delete

      Example 1: Deleting servers with incorrect command line parameters

      ----------------------------------------------------------------
      admin:utils ntp server delete clock1.cisco.com clock2.cisco.com
      Incorrect number of optional parameters entered for delete
      usage: utils ntp server delete
      admin:

      Example 2: Deleting single server with ntp restart

      ------------------------------------------------
      admin:utils ntp server delete
      1: clock1.cisco.com
      2: clock2.cisco.com
      3: ntp01-syd.cisco.com
      4: ntp02-syd.cisco.com
      5: clock.cisco.com
      a: all
      q: quit
      Choice: 1
      Restart NTP (y/n): y
      clock1.cisco.com is deleted from the list of configured NTP servers.
      Continue (y/n)?y
      clock1.cisco.com:  deleted successfully.
      Restarting NTP on the server.
      admin:

      Example 3: Deleting all servers without ntp restart

      -------------------------------------------------
      admin:utils ntp server delete
      1: clock1.cisco.com
      2: clock2.cisco.com
      3: ntp01-syd.cisco.com
      4: ntp02-syd.cisco.com
      5: clock.cisco.com
      a: all
      q: quit
      Choice: a
      Restart NTP (y/n): n
      This results in all the configured NTP servers being deleted.
      Continue (y/n)?y
      clock1.cisco.com:  deleted successfully.
      clock2.cisco.com:  deleted successfully.
      ntp01-syd.cisco.com:  deleted successfully.
      ntp02-syd.cisco.com:  deleted successfully.
      clock.cisco.com:  deleted successfully.
      The NTP service must be restarted for the changes to take effect.
      admin:

      Example 4: Deleting all servers when no servers are configured

      ------------------------------------------------------------
      admin:utils ntp server delete
      There are no NTP servers configured to delete.

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      utils ntp server list

      The command lists the configured ntp servers.

      Command Syntax

      utils ntp server list

      Example 1: Listing servers with incorrect command line parameters

      ---------------------------------------------------------------
      admin:utils ntp server list all
      Incorrect optional parameter entered for list
      usage: utils ntp server list
      admin:

      Example 2: Listing servers

      ------------------------
      admin:utils ntp server list
      clock1.cisco.com
      clock2.cisco.com
      ntp01-syd.cisco.com
      ntp02-syd.cisco.com
      clock.cisco.com
      admin:

      Example 3: Listing servers when no servers are configured

      -------------------------------------------------------
      admin:utils ntp server list
      There are no NTP servers configured.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      utils ntp start

      If it is not already running, this command starts the NTP service.


      Note


      You cannot stop the NTP service from the CLI. Use this command when the utils ntp status command returns stopped.


      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

      • username specifies the name of the remote account. The username can contain only lowercase characters and must be more than six-characters long.
      • life specifies the life of the account in days. After the specified number of day, the account expires.

      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 status

      utils reset_ui_administrator_password

      This command resets the Emergency Responder 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

      • service-name represents the name of the service that you want to stop or start:
        • System NTP
        • System SSH
        • Cisco IDS
        • Cisco Tomcat
        • Cisco Database Layer Monitor
        • Cisco Emergency Responder
        • Cisco Phone Tracking Engine
      • auto-restart causes a service to automatically restart.
      • enable enables auto-restart.
      • disable disables auto-restart.
      • show shows the auto-restart status.

      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

      • page—Displays the output one page at a time

      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

      • get displays the value of the specified SNMP object.
      • hardware-agents status displays the status of the hardware agents on the server.
      • hardware-agents stop stops all SNMP agents provided by the hardware vendor.
      • hardware-agents restart restarts the hardware agents on the server.
      • test tests the SNMP host by sending sample alarms to local syslog and remote syslog.
      • walk walks the SNMP MIB, starting with the specified SNMP object.
      • version specifies the SNMP version. Possible values are 1 or 2c.
      • community specifies the SNMP community string.
      • ip-address specifies the IP address of the server. Enter 127.0.0.1 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node.
      • object specifies the SNMP Object ID (OID) to get.
      • file specifies a file in which to save the command output.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: Yes

      utils snmp walk 3

      This command is used to walk the SNMP MIB starting with the specified OID.

      Command Syntax

      utils snmp walk 3

      [system prompts you for the parameters]

      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 is the sample walk 
      output we are getting for the OID 1.3.6
      iso.3.6.1.2.1.1.1.0 = STRING: "Hardware:7825H, 1 Intel(R) Pentium(R) 4 CPU 
      3.40GHz, 2048 MB 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.583
      iso.3.6.1.2.1.1.3.0 = Timeticks: (15878339) 1 day, 20:06:23.39
      iso.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: 72
      iso.3.6.1.2.1.2.1.0 = INTEGER: 3
      iso.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1
      iso.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2
      iso.3.6.1.2.1.2.2.1.1.3 = INTEGER: 3
      iso.3.6.1.2.1.2.2.1.2.1 = STRING: "lo"
      iso.3.6.1.2.1.2.2.1.2.2 = STRING: "eth0"
      iso.3.6.1.2.1.2.2.1.2.3 = STRING: "eth1"
      iso.3.6.1.2.1.2.2.1.3.1 = INTEGER: 24
      iso.3.6.1.2.1.2.2.1.3.2 = INTEGER: 6
      iso.3.6.1.2.1.2.2.1.3.3 = INTEGER: 6
      iso.3.6.1.2.1.2.2.1.4.1 = INTEGER: 16436
      iso.3.6.1.2.1.2.2.1.4.2 = INTEGER: 1500
      iso.3.6.1.2.1.2.2.1.4.3 = INTEGER: 1500
      iso.3.6.1.2.1.2.2.1.5.1 = Gauge32: 0
      iso.3.6.1.2.1.2.2.1.5.2 = Gauge32: 100000000
      iso.3.6.1.2.1.2.2.1.5.3 = Gauge32: 10000000
      iso.3.6.1.2.1.2.2.1.6.1 = Hex-STRING: 00 00 00 00 00 00
      iso.3.6.1.2.1.2.2.1.6.2 = Hex-STRING: 00 16 35 5C 61 D0
      iso.3.6.1.2.1.2.2.1.6.3 = Hex-STRING: 00 16 35 5C 61 CF
      iso.3.6.1.2.1.2.2.1.7.1 = INTEGER: 1
      .....
      

      If you provide an IP address of a remote host then the command is executed on that remote host. Note you have to provide the ip-address not domain name.

      Requirements

      Command privilege level: 1

      Allowed during upgrade: No

      utils snmp get 3

      This command gets the SNMP data for the specified MIB OID.

      Command Syntax

      utils snmp get 3

      [system prompts you for the parameters]

      Example:

      If you run it on a specific OID (leaf) in the MIB you would get the value of the MIB. Following is the snmp get output of system uptime iso.3.6.1.2.1.25.1.1.0 = Timeticks: (19836825) 2 days, 7:06:08.25

      If you provide an IP address of a remote host then the command is executed on that remote host. Note you have to provide the ip-address not domain name.

      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}

      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

      • console redirects the system boot output to the console.
      • serial redirects the system boot output to the COM1 (serial port 1).
      • status displays the where the serial boot output currently gets sent.

      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

      • cancel cancels the active upgrade.
      • initiate starts a new upgrade wizard or assumes control of an existing upgrade wizard. The wizard prompts you for the location of the upgrade file.
      • status displays the status of an upgrade.

      Usage Guidelines

      To upgrade the system, follow these major steps:

      1. Use the utils system upgrade list command to display a list of the .iso upgrade files that are available on the local disk or remote server from which you plan to upgrade.
      2. Use the utils system upgrade get command to get the upgrade file that you want to use.
      3. Use the utils system upgrade start command to start upgrading from the upgrade file you got.

      utils vmtools status

      This command shows the version of the currently running VMware Tools.

      Command Syntax

      utils vmtools status

      Requirements

      Command privilege level: 0

      Allowed during upgrade: Yes

      utils vmtools upgrade

      This command updates the currently installed VMware Tools to the latest version prescribed by the ESXi host for that VM.

      Command Syntax

      utils vmtools upgrade

      Unsupported VMware Commands

      • show environment fans
      • show environment power-supply
      • show environment temperatures
      • show memory size
      • show memory count
      • show memory modules all
      • utils create report hardware
      • utils snmp hardware-agents restart
      • utils snmp hardware-agents start
      • utils snmp hardware-agents status
      • utils snmp hardware-agents stop