- Using Cisco Unified SIP Proxy Software
- Cisco Unified SIP Proxy Module EXEC Commands
- Cisco Unified SIP Proxy EXEC Commands
- Cisco Unified SIP Proxy Configuration Commands
- Cisco Unified SIP Proxy SIP Commands
- Cisco Unified SIP Proxy SIP Server Commands
- Cisco Unified SIP Proxy Radius Server Commands
- Cisco Unified SIP Proxy Trigger Commands
- Cisco Unified SIP Proxy Route Commands
- Cisco Unified SIP Proxy Policy Commands
- Cisco Unified SIP Proxy Accounting Commands
- Cisco Unified SIP Proxy Security Commands
- Module Commands for Cisco Unified SIP Proxy
- backup (module)
- backup category
- backup security key
- backup security enforced
- backup security protected
- backup server authenticate
- clock timezone
- continue
- copy core
- copy sftp:
- copy sftp: configuration active
- hostname
- interface gigabitethernet
- ip address
- ip broadcast-address
- ip tcp keepalive-time
- log console
- log console monitor
- log server
- log trace boot
- log trace buffer save
- ntp server
- offline
- process cpu threshold type
- reload
- restore
- restore factory default
- security ssh known-hosts
- show backup
- show backup history
- show backup server
- show clock
- show cpu-usage history
- show cps history
- show disk-usage
- show interfaces
- show logs
- show ntp associations
- show ntp servers
- show ntp source
- show ntp status
- show memory-usage history
- show process
- show running-config
- show security ssh known-hosts
- show software
- show trace log
- show startup-config
- show version
- snmp-server community
- snmp-server contact
- snmp-server enable traps
- snmp-server host
- snmp-server location
- software download
- software upgrade
- system monitor
- write
Module Commands for Cisco Unified SIP Proxy
- backup (module)
- backup category
- backup security key
- backup security enforced
- backup security protected
- backup server authenticate
- clock timezone
- continue
- copy core
- copy sftp:
- copy sftp: configuration active
- hostname
- interface gigabitethernet
- ip address
- ip broadcast-address
- ip tcp keepalive-time
- log console
- log console monitor
- log server
- log trace boot
- log trace buffer save
- ntp server
- offline
- reload
- restore
- restore factory default
- security ssh known-hosts
- show backup
- show backup history
- show backup server
- show clock
- show cpu-usage history
- show cps history
- show disk-usage
- show interfaces
- show logs
- show ntp associations
- show ntp servers
- show ntp source
- show ntp status
- show memory-usage history
- show process
- show running-config
- show security ssh known-hosts
- show software
- show trace log
- show startup-config
- show version
- snmp-server community
- snmp-server contact
- snmp-server enable traps
- snmp-server host
- snmp-server location
- software download
- software upgrade
- system monitor
- write
backup (module)
To set the backup parameters, use the backup command in module configuration mode. To delete the number of revisions or the backup server URL, use the no form of this command.
backup { revisions number | server url sftp-url username sftp-username password sftp-password }
no backup { revisions number | server url sftp-url }
Syntax Description
Number of revision files stored in the Cisco Unified SIP Proxy database. |
|
URL to the SFTP server where the backup files are to be stored. |
|
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Set these parameters before backing up any files.
Consider the amount of storage space that each backup file requires when setting the number of files to store. When the number is reached, the next backup file overwrites the oldest stored backup file.
The system automatically numbers and dates the backup files and identifies the revision number in a backupid field. Reference this backup ID value when restoring a file.
Performing different backup types at various times causes different backup IDs for data backups and configuration backups. For example, the last data backup ID might be 3 and the last configuration backup might be 4. Performing an all backup might result in a backup ID of 5 for both data and configuration. See the backup category command for information about different backup types.
There are two backup commands: this command in module configuration mode, and another command in offline EXEC mode.
If the backup (module) command is unset, and the backup (offline EXEC) command is unset, the command fails.
If the backup (module) command is set, and the backup (offline EXEC) command is unset, the backup (module) command is used
If the backup (module) command is unset, and the backup (offline EXEC) command is set, the backup (offline EXEC) command is used.
If both commands are set, the backup (offline EXEC) command is used.
Examples
The following example sets 7 revisions on SFTP server /branch/vmbackups.
Related Commands
|
|
|
|---|---|
backup category
To specify the type of data to be backed up, use the backup category command in offline mode.
backup category { all | configuration | data }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to indicate the type of Cisco Unified SIP Proxy data.
Examples
The following examples illustrate all the backup categories:
Related Commands
|
|
|
|---|---|
backup security key
To create or delete the primary key used for encrypting and signing the backup files, use the backup security key command in module configuration mode.
backup security key {generate | delete}
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the backup security key command in Cisco Unified SIP Proxy configuration mode to create or delete the primary key used for encrypting and signing the backup files. When creating a backup security key, you are prompted to enter the password from which the key will be derived.
This command is not saved in the startup configuration when you use the write command.
Examples
The following example creates a primary key:
The following example deletes a primary key:
Related Commands
|
|
|
|---|---|
Specifies that only protected and untampered backup files can be restored. |
|
Copies the running configuration to the startup configuration. |
backup security enforced
To specify that only protected and untampered backup files can be restored, use the backup security enforced command in Cisco Unified SIP Proxy configuration mode.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Before you can use this command, you must generate a backup security key by using the backup security key generate command.
Use the backup security enforced command in Cisco Unified SIP Proxy configuration mode to specify that only protected and untampered backup files can be restored. By default, the system also restores unprotected (clear) backup files, as protected backup files and untampered backup files.
Examples
The following example specifies that only protected and untampered backup files can be restored:
Related Commands
|
|
|
|---|---|
Creates or deletes the primary key used for encrypting and signing the backup files. |
|
backup security protected
To enable secure mode for backups, use the backup security protected command in Cisco Unified SIP Proxy configuration mode.
Syntax Description
Command Default
Backup files are stored in unprotected mode on the remote server.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Before using this command, you must generate backup security key by using the backup security key generate command.
Use the backup security protected command in Cisco Unified SIP Proxy configuration mode to enable secure mode for backups. In secure mode, all backup files are protected using encryption and a signature.
Examples
The following example enables secure mode for backups:
Related Commands
|
|
|
|---|---|
Specifies that only protected and untampered backup files can be restored. |
|
Creates or deletes the primary key used for encrypting and signing the backup files. |
backup server authenticate
To retrieve the fingerprint of the backup server’s host key, use the backup server authenticate command in module configuration mode.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the backup server authenticate command in module configuration mode to retrieve the fingerprint of the backup server’s host key. Before using this command, users must configure the backup server URL and the login credential. The backup server URL must start with “sftp://.” After the fingerprint is retrieved from the backup server, the system prompts the user for confirmation.
If this command is accepted, the fingerprint is stored in the form of “backup server authenticate fingerprint fingerprint-string ” in the running configuration.This command is not saved in the startup configuration when you use the write command.
Examples
The following example retrieves the fingerprint of the backup server’s host key:
se-10-1-0-0(config)# backup server authenticate
The fingerprint of host 10.30.30.100 (key type ssh-rsa) is:
a5:3a:12:6d:e9:48:a3:34:be:8f:ee:50:30:e5:e6:c3
Related Commands
clock timezone
To set the time zone for the Cisco Unified SIP Proxy service module, use the clock timezone command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The configured NTP server provides the date-stamp system and application functions. The clock timezone command specifies the local time zone where Cisco Unified SIP Proxy is installed.
If you know the phrase for the time-zone, enter it for the time-zone value. If you do not know the time zone phrase, leave the time-zone value blank and a series of menus appear to guide you through the time zone selection process.
Examples
To select United States Pacific Time using the time-zone menu:
Related Commands
|
|
|
|---|---|
continue
To return the Cisco Unified SIP Proxy system to online mode, use the continue command in module offline mode.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command returns the Cisco Unified SIP Proxy system to the previous online mode, such as after a backup procedure or to discontinue a restore to factory defaults. The system begins processing new calls and voice messages. Cisco Unified SIP Proxy still routes calls in offline mode.
Examples
The following example illustrates the use of the continue command in the backup procedure:
Related Commands
|
|
|
|---|---|
Terminates all active calls and prevents new calls from connecting to the Cisco Unified SIP Proxy application. |
|
copy core
To copy a core file to a remote URL, use the copy core command in module EXEC mode.
copy core core-name url sftp/http url
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The standard SFTP URL format is supported where the user ID and password are mandatory attributes:
Examples
The following command copies the core to sftp://uid:pw@sftp.example.com/pub/.
Related Commands
|
|
|
|---|---|
Copies a new configuration from an SFTP server to another Cisco Unified SIP Proxy location. |
|
copy sftp:
To copy a new configuration from an SFTP server to another Cisco Unified SIP Proxy location, use the copy sftp: command in module EXEC mode.
copy sftp: { nvram:startup-config | running-config | startup-config | system:running-config }
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
When you copy from the SFTP server, the copy sftp: command becomes interactive and prompts you for the necessary information.
The standard SFTP URL format is as follows: userid : password @ sftp-server-address / directory,
where the user ID and password are mandatory attributes and you must provide the absolute path of the SFTP directory.
If you do not specify the absolute path of the directory value, the software uses the root directory.
The copy sftp: command does not copy Cisco Unified SIP Proxy related configuration. To copy Cisco Unified SIP Proxy configurations use the copy sftp: configuration active command.
Examples
The following example shows copying the configuration file named start from the SFTP server in the default directory to the startup configuration in NVRAM:
In the following example, the file named start in the SFTP server configs directory is copied to the startup configuration:
Related Commands
|
|
|
|---|---|
Copies a new Cisco Unified SIP Proxy configuration from an SFTP server to another Cisco Unified SIP Proxy location. |
|
Copies the running configuration to the startup configuration. |
copy sftp: configuration active
To copy a new Cisco Unified SIP Proxy configuration from an SFTP server to another Cisco Unified SIP Proxy location, use the copy sftp: configuration active command in Cisco Unified SIP Proxy EXEC mode.
copy sftp: configuration active
Syntax Description
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
|
|
|
|---|---|
Usage Guidelines
When you copy from the SFTP server, the copy sftp: configuration active command becomes interactive and prompts you for the necessary information.
The standard SFTP URL format is as follows: userid : password @ sftp-server-address / directory,
where the user ID and password are mandatory attributes and you must provide the absolute path of the SFTP directory.
If you do not specify the absolute path of the directory value, the software uses the root directory.
Examples
The following example shows copying the configuration file named start from the SFTP server in the default directory to the startup configuration in NVRAM:
Related Commands
|
|
|
|---|---|
Copies a new configuration from an SFTP server to another Cisco Unified SIP Proxy location. |
hostname
To configure a hostname for the application that is different from the name used for the host, use the hostname command in Cisco Unified SIP Proxy application service configuration mode. To disable the hostname for the application, use the no form of this command.
Syntax Description
Defaults
Command Default
Command Modes
Cisco Unified SIP Proxy application service configuration.
Command History
|
|
|
|---|---|
Usage Guidelines
This command configures the hostname for the application, if it is different from the hostname configured for the Cisco Unified SIP Proxy host. The hostname is limited to 32 characters.
The following error message appears if more than 32 characters are entered:
This command modifies configuration directives in /etc/hosts. It updates the hostname of the hostname-ip mapping entry. If the /etc/hosts file does not exist, this command creates the /etc/hosts file and adds an entry in the file. If an application package already has its own bundled /etc/hosts, the new entries are appended to the existing ones and the original entries remain intact.
Examples
The following example shows two entries in file etc/hosts:
The IP address, ipaddr in the /etc/hosts file is modified when you use the bind interface command.
The first binding of the interface provides the ipaddr. For example, if interface eth0 is bound to each virtual instance by default, ipaddr is normally eth0. Use the bind interface command for multiple bindings.
Related Commands
|
|
|
|---|---|
interface gigabitethernet
To create virtual interfaces for the Cisco Unified SIP Proxy module, use the interface gigabitethernet command in module configuration mode. To remove virtual interfaces, use the no form of this command.
interface gigabitethernet interface . vid
no interface gigabitethernet interface . vid
Syntax Description
VLAN ID. Valid values are 0 to 4094. For example, gig 0.345 is on VLAN 345. |
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Up to 8 virtual interfaces can be created for each physical interface.
Examples
The following example creates a virtual interface:
The following example removes a virtual interface:
ip address
To configure the IP address for a network interface, use the ip address command in module interface configuration mode. To remove the IP address interface configuration, use the no form of this command.
ip address ip-address subnet-mask
no ip address ip-address subnet-mask
Syntax Description
Command Default
Command Modes
Module interface configuration (config-subif)
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to configure the IP address and network mask for the specified network interface. Changing the IP address for a bound interface results in a message warning the user that the application is bound to the interface. To remove the old IP configuration, reset the virtual instance.
Examples
The following example sets the IP address of the Gigabit Ethernet interface 0.1:
Related Commands
|
|
|
|---|---|
Creates virtual interfaces for the Cisco Unified SIP Proxy module. |
ip broadcast-address
To define a broadcast address for an interface, use the ip broadcast-address command in module interface configuration mode. To restore the default IP broadcast address, use the no form of this command.
ip broadcast-address ip-address
no ip broadcast-address ip-address
Syntax Description
Command Default
Command Modes
Module interface configuration (config-subif)
Command History
|
|
|
|---|---|
Examples
The following example specifies an IP broadcast address of 0.0.0.0:
ip tcp keepalive-time
To configure the amount of idle time that is allowed to pass before sending a keepalive probe, use the ip tcp keepalive-time command in module configuration mode. To return to the default value, use the no form of this command.
no ip tcp keepalive-time seconds
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
The following example sets the keepalive time to 2000 seconds:
The following example sets the keepalive time to the default value, 7200 seconds:
log console
To configure the types of messages to be displayed on the console, use the log console command in module configuration mode. To stop messages from displaying, use the no form of this command.
log console { errors | info | warning }
no log console { errors | info | warning }
This command generates many screen messages that scroll down the screen until you turn off the display. Seeing the prompt to turn off the display might be difficult. Pressing CTRL-c does not work for this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Because the messages on the console display are also saved in the messages.log file you can use these messages for debugging purposes.
Examples
The following example configures error messages to be displayed on the console:
Related Commands
|
|
|
|---|---|
Displays the types of messages that are displayed on the console. |
log console monitor
To display system messages on the console, use the log console monitor command in module EXEC mode. To stop messages from displaying, use the no form of this command.
log console monitor { module | entity | activity }
no log console monitor { module | entity | activity }
This command generates many screen messages that scroll down the screen until you turn off the display. Seeing the prompt to turn off the display might be difficult. Pressing CTRL-c does not work for this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Because the messages on the console monitor are also saved in the messages.log file you can use these messages for debugging purposes.
Examples
The following example displays messages for results of the database entity in the networking module:
Related Commands
|
|
|
|---|---|
Displays the types of messages that are displayed on the console. |
log server
To configure an external server for saving log messages, use the log server command in module configuration mode. To delete the log server, use the no form of this command.
log server address { ip-address | hostname }
no log server address { ip-address | hostname }
Syntax Description
Command Default
No external log server is configured. The local hard disk is used for saving log messages.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
An external log server contains a copy of the messages.log file that is stored on the hard disk of the router that contains the Cisco Unified SIP Proxy module. Copying the file to a server permits flexibility in viewing, printing, and troubleshooting system messages.
Examples
The following example assigns 10.1.61.16 as the external log server:
Related Commands
|
|
|
|---|---|
Specifies the server that stores the Cisco Unified SIP Proxy applications. |
|
log trace boot
To save the trace configuration on rebooting, use the log trace boot command in module EXEC mode.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The current trace configuration is lost on reboot because tracing is CPU intensive. To ensure that the current trace configuration is saved when the module is rebooted, use the log trace boot command.
Examples
The following example illustrates the log trace boot command:
Related Commands
|
|
|
|---|---|
log trace buffer save
To save the current trace information, use the log trace buffer save command in module EXEC mode. To turn off the log trace, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Current trace information stored in the memory buffer can be saved to a file. The file created with the log trace buffer save command is atrace_save.log.
Examples
The following example illustrates the log trace buffer save command:
Related Commands
|
|
|
|---|---|
ntp server
To synchronize the Cisco Unified SIP Proxy application system clock with a remote Network Time Protocol (NTP) server, use the ntp server command in module configuration mode. To disable the Cisco Unified SIP Proxy application system clock from being synchronized with an NTP server, use the no form of this command.
ntp server { hostname | ip-address } [ prefer ]
no ntp server { hostname | ip-address }
Syntax Description
Command Default
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command in conjunction with the clock timezone command to set the timing functions for Cisco Unified SIP Proxy systems and applications.
The prefer option indicates that the specified server is chosen for synchronization from among a set of correctly operating hosts.
The
no ntp server command deletes the NTP server hostname or IP address. Use this command with caution.
Examples
The following example assigns the server with address 192.168.1.100 as the preferred NTP server:
The following example assigns the server with hostname main_ntp as the NTP server:
Related Commands
|
|
|
|---|---|
offline
To enter the environment for the backup and restore procedures, use the offline command in module EXEC mode.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Backup and restore procedures require that you backup your current active configuration using write command if you are going offline to do backup. The offline command disables management interfaces.
The offline command does not start the backup or restore procedure. Use the backup and restore commands to initiate those procedures.
Examples
The following example illustrates the use of the offline command:
Related Commands
|
|
|
|---|---|
process cpu threshold type
To define the rising and falling threshold values of CPU utilization traps, use the process cpu threshold type command.
process cpu threshold type total rising percentage interval seconds falling percentage interval seconds
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Backup and restore procedures require that you backup your current active configuration using write command if you are going offline to do backup. The offline command disables management interfaces.
The offline command does not start the backup or restore procedure. Use the backup and restore commands to initiate those procedures.
Examples
The following example illustrates the use of the offline command:
reload
To restart the Cisco Unified SIP Proxy system, use the reload command in module offline mode.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example illustrates the use of the reload command after a restore procedure:
Related Commands
|
|
|
|---|---|
Exits offline mode and returns to Cisco Unified SIP Proxy EXEC mode. |
|
Switches the Cisco Unified SIP Proxy system to offline mode. |
|
restore
To restore a backup file, use the restore command in module offline mode.
restore id backup-id category { all | configuration | data }
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
When the restore procedure begins, all active calls are terminated. Cisco Unified SIP Proxy does not support scheduled restores. Consider restoring a file when the phones are least active.
After completing the restore procedure, use the reload command to activate the file data.
Use the show backup history command to locate the backup-id value of the file to be restored.
Examples
The following example restores the file with the ID data5, which is a data-only file.
Related Commands
|
|
|
|---|---|
Displays the network SFTP server designated as the backup server. |
restore factory default
To restore the system to the factory defaults, use the restore factory default command in module offline mode.
This feature is not reversible. All data and configuration files are erased. Use this feature with caution. We recommend that you do a full system backup before proceeding with this feature.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Restoring the system to the factory defaults has the following effects:
- Replaces the current database with an empty database.
- Initializes Lightweight Directory Access Protocol (LDAP) to an empty state.
- Replaces the startup configuration with the template startup configuration that ships with the system.
- Erases all postinstallation configuration data.
- Deletes all subscriber and custom prompts.
When the system is clean, the administrator sees a message that the system will reload, and the system begins to reload. When the reload is complete, the system prompts the administrator to go through the postinstallation process.
Examples
The following example restores the system to factory defaults.
Step 1 Put the system into offline mode.
Step 2 Restore the system to factory defaults.
Step 3 Do one of the following:
The operation is canceled, and the system remains in offline mode. To return to online mode, enter continue.
When the system is clean, a message appears indicating that the system will start to reload. When the reload is complete, a prompt appears to start the postinstallation process.
Related Commands
|
|
|
|---|---|
security ssh known-hosts
To configure the MD5 (Message-Digest algorithm 5) fingerprint and type of host key for the SSH (Secure Shell) server’s host key, use the security ssh known-hosts command in module configuration mode. Use the no form of this command to remove the MD5 fingerprint.
security ssh known-hosts host {ssh-rsa | ssh-dsa} fingerprint-string
no security ssh known-hosts host {ssh-rsa | ssh-dsa} fingerprint-string
Syntax Description
The RSA encryption algorithm was used to create this fingerprint for an SSH server’s host key. |
|
The DSA (Digital Signature Algorithm) was used to create this fingerprint for an SSH server’s host key. |
|
Command Default
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the security ssh known-hosts command in Cisco Unified SIP Proxy EXEC mode to configure the MD5 fingerprint of the SSH server’s host key. When the fingerprint is configured, the local SSH/SFTP client performs server authentication by comparing the configured fingerprint with the one returned from the SSH server.
The host argument can be either a hostname or a IP address.
If the fingerprint is not configured, no server authentication is performed. The fingerprint is not saved in the startup configuration when you use the write command.
Examples
The following example specifies the MD5 fingerprint of a SSH-RSA server’s host key:
Related Commands
|
|
|
|---|---|
Displays a list of configured SSH servers and their fingerprints. |
|
Copies the running configuration to the startup configuration. |
show backup
To display information about the server that is used to store backup files, use the show backup command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command displays the SFTP server URL, the subscriber account on the SFTP server, and the number of backup file revisions that are to be stored on the server.
Examples
The following is sample output from the show backup command:
Table 1 describes the significant fields shown in the display.
|
|
|
|---|---|
Number of backup files to store before the oldest one is overwritten. |
Related Commands
|
|
|
|---|---|
show backup history
To display the success or failure of backup and restore procedures, use the show backup history command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command displays each backup file, its backup ID, the type of data stored in the file, and the success or failure of the backup procedure.
Examples
The following is sample output from the show backup history command:
Table 2 describes the significant fields shown in the display.
|
|
|
|---|---|
Specifies the type of file (data, configuration, or all) that was backed up. |
|
If the operation failed, this field gives the reason for the failure. |
Related Commands
|
|
|
|---|---|
show backup server
To display the details of the most recent backup files, use the show backup server command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to display a list of the backup files available on the backup server. The files are grouped by category, with the date of each backup and the backup file ID. For information on the success or failure of a backup procedure, see the show backup history command.
Examples
The following is sample output for the show backup server command:
Table 3 describes the significant fields shown in the display.
|
|
|
|---|---|
Related Commands
|
|
|
|---|---|
Displays the success or failure of backup and restore procedures. |
show clock
To display clock statistics, use the show clock command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
In the following example, the clock statistics are displayed on the screen.
Related Commands
|
|
|
|---|---|
show cpu-usage history
To display Central Processing Unit (CPU) utilization percentage in different time stamp (60-seconds, 60-minutes, and 72 hours), use the show cpu-usage history c ommand in module EXEC mode.
show cpu-usage history [60-minutes | 60-seconds | 72-hours]
Note When the application is down or shutdown, CPU or memory data is erased and system starts fetching the new CPU or memory data post reload.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
In the following example, the CPU-usage is displayed on the screen for past 60-seconds.
In the following example, the CPU-usage is displayed on the screen for past 60-minutes.
Note One-minute CPU usage percentage is calculated by getting the average of 60 seconds data of that minute.
Note One-hour CPU usage percentage is calculated by getting the average of 60 minutes data of that hour.
Related Commands
|
|
|
|---|---|
Displays a summary of the diagnostic information for the application. |
show cps history
To display Calls Per Second (CPS) data in different time stamp (60-minutes, and 72 hours), use the show cps history c ommand in module EXEC mode.
show cps history [60-minutes | 72-hours]
Note When the application is down or shutdown, CPS data is set to predefined value that is zero and the system starts fetching the new CPS data post reload.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
In the following example, the CPS history is displayed on the screen for past 60-minutes.
Note One-minute CPS data is calculated by getting the average of 60 seconds data of that minute.
In the following example, the CPS history is displayed on the screen for past 72-hours.
Note One-hour CPS data is calculated by getting the average of 60 minutes data of that hour.
In the following example, CPS data is displayed on the screen by getting the average of every 5th minute CPS data of that hour.
Related Commands
|
|
|
|---|---|
Displays a summary of the diagnostic information for the application. |
show disk-usage
To display system disk utilization, use the show disk-usage c ommand in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
In the following example, the system disk utilization is displayed on the screen.
Related Commands
|
|
|
|---|---|
Displays a summary of the diagnostic information for the application. |
show interfaces
To display all the configured interfaces, including virtual and VLAN interfaces, use the show interfaces command in module EXEC mode.
show interfaces [ | GigabitEthernet | ide ]
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
In the following example, the show interfaces command displays all configured interfaces on the screen: a Gigabit Ethernet interface and an IDE (hard disk) interface.
Related Commands
|
|
|
|---|---|
show logs
To display a list of system logs, use the show logs command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to display all the log files under the /var/log directory of the virtual instance.
Examples
In the following example, the show logs command shows the log files under the /var/log directory of the virtual instance.
show ntp associations
To display the association identifier and status for all Network Time Protocol (NTP) servers, use the show ntp associations command in module EXEC mode.
show ntp associations [ assocID association-id ]
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the show ntp associations command to display the association identifier and status for all the NTP servers configured for Cisco Unified SIP Proxy and not details about the servers. The show ntp associations assocID association-id command provides details on the status of a specified NTP server.
Use the status field to determine the configuration and status of all the NTP servers. This field consists of 4 hexadecimal digits:
- The first two digits specify the server configuration and how far it progressed through the clock selection process. See Table 4 .
- The second two digits indicate the number of events and the type of the last event. See Table 5.
Table 4 shows common status codes and their descriptions. The first digit specifies the configuration, reachability, and authentication status for the specified server. The second digit records how well the specified server passed through the clock selection algorithm.
Table 5 lists the event codes. The third digit indicates the number of events that occurred since the last time an error was returned to the console by NTP or by one of the show ntp commands. This value does not wrap and stops incrementing at 15 (or hex F).
For a properly running server, the value should be xx1x, unless one of the show ntp commands has queried the server since startup. In that case, the value should be xx0x. If the third digit is any other value, check for the event causing errors.
The fourth digit in the field indicates the last event that occurred. For properly running servers, the event should be the server becoming reachable.
The flash field indicates the status of the packets while a series of 12 diagnostic tests are performed on them. The tests are performed in a specified sequence to gain maximum information while protecting against accidental or malicious errors.
The flash variable is set to zero as each packet is received. If any bits are set as a result of the tests, the packet is discarded.
The tests look for the following information:
- TEST1 to TEST3 check the packet time stamps from which the offset and delay are calculated. If no bits are set, the packet header variables are saved.
- TEST4 and TEST5 check access control and cryptographic authentication. If no bits are set, no values are saved.
- TEST6 to TEST8 check the health of the server. If no bits are set, the offset and delay relative to the server are calculated and saved.
- TEST9 checks the health of the association. If no bits are set, the saved variables are passed to the clock filter and mitigation algorithm.
- TEST10 to TEST12 check the authentication state using Autokey public-key cryptography. If any bits are set and the association was previously marked as reachable, the packet is discarded. Otherwise, the originate and receive time stamps are saved with a continuation of the process.
Table 6 lists the flash bits for each test.
Examples
The following example show the output that appears after using the basic show ntp associations command:
Table 7 describes the significant fields shown in the display.
|
|
|
|---|---|
Hexadecimal value of the server status. See Table 4 and Table 5 for a description of these field codes. |
|
Indicates whether the server is configured or not. Valid values are yes and no. |
|
Indicates whether the peer is reachable or not. Valid values are yes and no. |
|
Type of association in the clock selection process. Valid values are:
|
|
Last event that occurred in the system. Valid values are: See Table 5 for descriptions of these values. |
|
Number of events that occurred since the last time an error was returned to the console by the NTP. This value does not wrap and stops incrementing at 15 (or hex F). For a properly functioning server, this value must be 1 or 0. |
The following example shows the ntp associations for a particular assocID, using the show ntp associations assocID command:
Table 8 describes the significant fields shown in the display.
|
|
|
|---|---|
Status of the peer. See Table 4, Table 5, and Table 7 for descriptions of the values in this line. |
|
Two-bit coded warning of an impending leap second to be inserted in the NTP timescale. Valid values are: |
|
Server hop count to the primary clock source. Valid values are: If the stratum value is 15, the server is probably unsynchronized and its clock needs to be reset. |
|
Total round-trip delay, in seconds, to the primary reference source at the root of the synchronization subnet. |
|
Maximum error, in seconds, relative to the primary reference source at the root of the synchronization subnet. |
|
Peer reachability status history, in octal. Each bit is set to 1 if the server is reached during a polling period and is set to 0 otherwise. The value 377 indicates that the last 8 attempts were good. |
|
Number of poll intervals since the last valid packet was received. |
|
Minimum interval, in seconds as a power of two, between transmitted messages from the host. |
|
Minimum interval, in seconds as a power of two, between transmitted messages to the peer. |
|
Status of the packet after a series of diagnostic tests are performed on the packet. See the description of the flash field values in Table 5. |
|
ID of the cryptographic key used to generate the message-authentication code. |
|
Time difference between the client and the server, in milliseconds. |
|
Measure, in milliseconds, of how scattered the time offsets are from a specific time server. |
|
Estimated time error, in milliseconds, of the Cisco Unified SIP Proxy clock measured as an exponential average of RMS time differences. |
|
Local time, in time-stamp format, when the local clock was last updated. If the local clock was never synchronized, the value is zero. |
|
Local time, in time-stamp format, at the peer when its latest NTP message was sent. If the peer becomes unreachable, the value is zero. |
|
Local time, in time-stamp format, when the latest NTP message from the peer arrived. If the peer becomes unreachable, the value is zero. |
|
Local time, in time-stamp format, at which the NTP message departed from the sender. |
|
Round-trip delay, in seconds, between the peer clock and the local clock over the network between them. |
|
Offset, in seconds, of the peer clock relative to the local clock. |
|
Maximum error, in seconds, of the peer clock relative to the local clock over the network between them. Only values greater than zero are possible. |
Related Commands
|
|
|
|---|---|
show ntp servers
To display a list of Network Time Protocol (NTP) servers, their current states, and a summary of the remote peers associated with each server, use the show ntp servers command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the show ntp servers command after changing the ntp server configuration.
Examples
The following example shows sample output for the show ntp servers command:
Table 9 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
Displays a list of association identifiers and peer statuses for an NTP server. |
|
show ntp source
To display the time source for a Network Time Protocol (NTP) server, use the show ntp source command in module EXEC mode. The display extends back to the primary time source, starting from the local host.
Syntax Description
(Optional) Additional NTP server details including: precision, leap, refit, delay, dispersion, root delay, root dispersion, reference time, originate timestamp, and transmit timestamp. |
Command Modes
Command History
|
|
|
|---|---|
Examples
The following example shows the sample output for the show ntp source command:
Table 10 describes the significant fields shown in the display.
The following example shows the sample output for the show ntp source detail command:
Table 11 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
Displays a list of association identifiers and peer statuses for an NTP server. |
|
show ntp status
To display statistics for the Network Time Protocol (NTP) server, use the show ntp status command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
The following is sample output for the show ntp status command:
Table 12 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
show memory-usage history
To display memory utilization in different time stamp (60-seconds, 60-minutes, and 72 hours), use the show memory-usage history c ommand in module EXEC mode.
show memory-usage history [60-minutes | 60-seconds | 72-hours]
Note When the application is down or shutdown, CPU or memory data is erased and system starts fetching the new CPU or memory data post reload.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
In the following example, the memory-usage is displayed on the screen for past 60-seconds.
In the following example, the memory-usage is displayed on the screen for past 60-minutes.
Note One-minute memory usage percentage is calculated by getting the average of 60 seconds data of that minute.
Note One-hour memory usage percentage is calculated by getting the average of 60 minutes data of that hour.
Related Commands
|
|
|
|---|---|
Displays a summary of the diagnostic information for the application. |
show process
To display all processes in the application environment, use the show process command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to display all processes in the virtual application environment sorted by process ID in ascending order.
Examples
The following example displays CPU utilization:
The following example displays all processes in the virtual application environment:
Related Commands
|
|
|
|---|---|
Displays a summary of the diagnostic information for the application. |
show running-config
To display the committed running configuration of the Cisco Unified SIP Proxy application environment, use the show running-config command in Cisco Unified SIP Proxy application service EXEC mode.
Syntax Description
Command Modes
Cisco Unified SIP Proxy application service EXEC
Command History
|
|
|
|---|---|
Usage Guidelines
For the Cisco Unified SIP Proxy, the running configuration only displays the configuration changes that were committed with the commit command.
Examples
Related Commands
|
|
|
|---|---|
Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect. |
|
Displays a summary of the diagnostic information for the application. |
show security ssh known-hosts
To display a list of configured SSH (Secure Shell) servers and their fingerprints, use the show security ssh known-hosts command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use the show security ssh known-hosts command in module EXEC mode to display a list of configured SSH servers and their fingerprints. These fingerprints are used to perform SSH server authentication.
Examples
The following is sample output for the show security ssh known-hosts command:
Related Commands
|
|
|
|---|---|
Configures the MD5 fingerprint of the SSH server’s host key. |
show software
To display characteristics of the installed software, use the show software command in module EXEC mode.
Note The keywords packages, directory, download server, and dependencies no longer exist.
Syntax Description
Displays the current versions of the configured software and applications. |
Command Modes
Command History
|
|
|
|---|---|
The keywords packages, directory, download server, and dependencies were removed. |
Examples
The following is sample output for the show software command:
show trace log
To display trace log files on the Cisco Unified SIP Proxy service module, use the show logs command in Cisco Unified SIP Proxy EXEC mode.
Syntax Description
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to display the contents of the Cisco Unified SIP Proxy trace log.
Examples
In the following example, the show trace log command shows the log files on the Cisco Unified SIP Proxy service module.
Related Commands
|
|
|
|---|---|
show startup-config
To display the current startup configuration, use the show startup-config command in Cisco Unified SIP Proxy EXEC mode.
Syntax Description
(Optional) Displays enough output to fill the current viewing screen. |
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
This command displays the startup configuration stored in flash memory.
Examples
The following is sample output for the show startup-config command:
Related Commands
|
|
|
|---|---|
Copies the running configuration to the startup configuration. |
show version
To display versions of Cisco Unified SIP Proxy components, use the show version command in module EXEC mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to display a list of the installed Cisco Unified SIP Proxy hardware components with their versions and serial numbers.
Examples
Table 14 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
Displays the version numbers of the installed Cisco Unified SIP Proxy software components. |
snmp-server community
To set up the community access string to permit access to the Simple Network Management Protocol (SNMP), use the snmp-server community command in global configuration mode. To remove the specified community string, use the no form of this command.
snmp-server community string [ ro | rw ]
no snmp-server community string
Syntax Description
Command Default
An SNMP community string permits read-only access to all objects.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
The no snmp-server command disables all versions of SNMP (SNMPv1, SNMPv2C, SNMPv3).
The first snmp-server command that you enter enables all versions of SNMP.
To configure SNMP community strings for the MPLS LDP MIB, use the snmp-server community command on the host network management station (NMS).
Note The @ symbol is used as a delimiter between the community string and the context in which it is used. For example, specific VLAN information in BRIDGE-MIB may be polled using community@VLAN_ID (for example, public@100) where 100 is the VLAN number. Avoid using the @ symbol as part of the SNMP community string when configuring this command.
Examples
The following example shows how to set the read/write community string to newstring:
The following example shows how to remove the community comaccess:
The following example shows how to disable all versions of SNMP:
Related Commands
|
|
|
|---|---|
Enables the router to send SNMP notification messages to a designated network management workstation. |
|
Specifies the targeted recipient of an SNMP notification operation. |
snmp-server contact
To set the system contact (sysContact) string, use the snmp-server contact command in global configuration mode. To remove the system contact information, use the no form of this command.
Syntax DescriptionSyntax Description
Command Modes
Command History
|
|
|
|---|---|
Examples
The following is an example of a system contact string:
Related Commands
|
|
|
|---|---|
snmp-server enable traps
To enable Simple Network Management Protocol (SNMP) notification types that are available on your system, use the snmp-server enable traps command in global configuration mode. To enable a specific trap, follow snmp-server enable traps with the command relevant to that trap. To disable all available SNMP notifications, use the no form of this command.
snmp-server enable traps [ All | System-State | Server-Group | SG-Element | CPU-Rising | CPU-Falling | License-State | License-Exceeded ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Enabling SNMP trap is a two step process. The first step is to activate the command snmp-server enable traps, followed by the command specific to the required trap (Commands specific to traps include All, System-State, Server-Group, SG-Element, CPU-Rising, CPU-Falling, License-State, and License-Exceeded). The second step is to enable the global command snmp-server enable traps to enable SNMP functionality on Cisco Unified SIP Proxy Release 9.1. Traps are sent to the host only when this global command is enabled.
For example, you can use snmp-server enable traps All to activate all traps, and follow it up with the global command snmp-server enable traps to ensure that the trap is generated and sent to the host.
Examples
The following example shows how to enable the router to send all traps to the host specified by the name myhost.cisco.com, using the community string defined as public:
Related Commands
snmp-server host
To specify the recipient of a Simple Network Management Protocol (SNMP) notification operation, use the snmp-server host command in global configuration mode. To remove the specified host from the configuration, use the no form of this command.
snmp-server host ip-address community-string
no snmp-server host ip-address community-string
Syntax Description
Command Default
This command behavior is disabled by default. A recipient is not specified to receive notifications.
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
When you enter this command, the default is to send all notification-type traps to the host.
The no snmp-server host command with no keywords disables traps, but not informs, to the host.
Note If a community string is not defined using the snmp-server community command prior to using this command, the default form of the snmp-server community command will automatically be inserted into the configuration. The password (community string) used for this automatic configuration of the snmp-server community will be the same as that specified in the snmp-server host command. This automatic command insertion and use of passwords is the default behavior for Cisco IOS Release 12.0(3) and later releases.
SNMP notifications can be sent as traps or inform requests. Traps are unreliable because the receiver does not send acknowledgments when it receives traps. The sender cannot determine if the traps were received. However, an SNMP entity that receives an inform request acknowledges the message with an SNMP response protocol data unit (PDU). If the sender never receives the response, the inform request can be sent again. Thus, informs are more likely than traps to reach their intended destination.
Compared to traps, informs consume more resources in the agent and in the network. Unlike a trap, which is discarded as soon as it is sent, an inform request must be held in memory until a response is received or the request times out. Also, traps are sent only once; an inform may be tried several times. The retries increase traffic and contribute to a higher overhead on the network.
If you do not enter an snmp-server host command, no notifications are sent. To configure the router to send SNMP notifications, you must enter at least one snmp-server host command. If you enter the command with no optional keywords, all trap types are enabled for the host.
To enable multiple hosts, you must issue a separate snmp-server host command for each host. You can specify multiple notification types in the command for each host.
When multiple snmp-server host commands are given for the same host and kind of notification (trap or inform), each succeeding command overwrites the previous command. Only the last snmp-server host command will be in effect. For example, if you enter an snmp-server host inform command for a host and then enter another snmp-server host inform command for the same host, the second command will replace the first.
The snmp-server host command is used in conjunction with the snmp-server enable command. Use the snmp-server enable command to specify which SNMP notifications are sent globally. For a host to receive most notifications, at least one snmp-server enable command and the snmp-server host command for that host must be enabled.
Examples
The following example shows how to enable the router to send all traps to the host 192.30.2.160 using the community string public:
Related Commands
|
|
|
|---|---|
snmp-server location
To set the system location string, use the snmp-server location command in global configuration mode. To remove the location string, use the no form of this command.
Syntax DescriptionSyntax Description
Command Default
Command Modes
Command History
|
|
|
|---|---|
Examples
The following example shows how to set a system location string:
Related Commands
|
|
|
|---|---|
software download
To configure the SFTP server URL where patch files are stored, use the software download command in Cisco Unified SIP Proxy Configuration mode.
software download url <url> username <username> password <password>
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy Configuration mode (config)
Command History
|
|
|
|---|---|
Usage Guidelines
Know the SFTP server url, username, and password before executing this command.
Examples
The following example configures the SFTP server details:
Related Commands
|
|
|
|---|---|
software upgrade
To install the patch file and upgrade Cisco Unified SIP Proxy to a newer patch release version, use software upgrade command in offline mode.
Syntax Description
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
Configure the SFTP server url, username, and password before executing the software upgrade command.
Examples
The following example upgrades the Cisco Unified SIP Proxy to a newer patch release version.:
!!!WARNING!!!: If you are going offline to do a backup, it is recommended
that you save the current running configuration using the 'write' command,
prior to going to the offline state.
Putting the system offline will disable management interfaces.
Are you sure you want to go offline?[confirm]
se-10-1-0-0(offline)# software upgrade
Source filename: vCUSP_10.2.0_v1.cop.sha512
Taking backup before upgrade...
Proceeding with patch installation..
Do you wish to continue?[confirm]y
Please wait while the patch is being installed...
Patch installation is successful. Use 'continue' to bring the system back online
Related Commands
|
|
|
|---|---|
Configures the SFTP server URL where patch files are stored. |
system monitor
To configure a Java Management Extensions (JMX) monitor user having read-only connection to the virtual Cisco Unified SIP Proxy through the jConsole, use the system monitor command in module configuration mode. Use no form of the command to remove a JMX monitor user.
system monitor user <USER> password <PASS>
no system monitor user <USER> password <PASS>
Syntax Description
A case-sensitive character sequence to authenticate the JMX monitor user. The password must contain at least one symbol, one upper-case letter, one lower-case letter and one number. |
Command Modes
Command History
|
|
|
|---|---|
Usage Guidelines
You must reload the virtual Cisco Unified SIP Proxy before using the configured username and password through JMX.
Examples
Related Commands
|
|
|
|---|---|
write
To erase, copy, or display the running configuration, use the write command in Cisco Unifies SIP Proxy EXEC mode.
write [ erase | memory | terminal ]
Syntax Description
Writes the running configuration to the startup configuration. This is the default. |
|
Defaults
Command Default
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
|
|
|
|---|---|
Usage Guidelines
Use the write or write memory command as a shortcut for the copy running-config startup-config command.
Related Commands
|
|
|
|---|---|
Feedback