Cisco Unified SIP Proxy EXEC Commands

configure

To enter Cisco Unified SIP Proxy configuration mode, use the configure command in Cisco Unified SIP Proxy EXEC mode. To exit Cisco Unified SIP Proxy configuration mode, use the exit command.

configure

 
Syntax Description

This command has no arguments or keywords.

 
Command Default

None

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

Use this command to enter Cisco Unified SIP Proxy configuration mode. From configuration mode you can enter all configuration submodes. After you enter the configure command, the system prompt changes from router-name (cusp)> to router-name (cusp-config)>, indicating that the router is in Cisco Unified SIP Proxy configuration mode. To leave Cisco Unified SIP Proxy configuration mode and return to the Cisco Unified SIP Proxy EXEC prompt, enter end.

Examples

The following example accesses the Cisco Unified SIP Proxy module, then enters Cisco Unified SIP Proxy EXEC mode, and finally enters Cisco Unified SIP Proxy configuration mode:

Router# service-module integrated-service-engine 1/0 session
 
se-10-1-0-0> cusp
se-10-1-0-0(cusp)> configure
se-10-1-0-0(cusp-config)>

 
Related Commands

Command
Description

cusp

Enters Cisco Unified SIP Proxy EXEC mode.

end

Exits out of Cisco Unified SIP Proxy configuration mode.

exit

Exits out of a Cisco Unified SIP Proxy configuration mode or submode back to the higher mode.

copy configuration active

To copy the active configuration to a specified remote file system, use the following syntax of the copy configuration active command in Cisco Unified SIP Proxy EXEC mode.

copy configuration active { sftp-url | pfs-url | tftp-url }

To copy the specified remote file system to the active configuration, use the following syntax of the copy configuration active command in Cisco Unified SIP Proxy EXEC mode.

copy { sftp-url | pfs-url | tftp-url } configuration active

 
Syntax Description

sftp-url

Specifies the SFTP URL that the active configuration will be copied to, or the SFTP URL that will be copied to the active configuration.

pfs-url

Specifies the Public File System (PFS) URL that the active configuration will be copied to, or the PFS URL that will be copied to the active configuration. PFS URLs must be of the format: pfs:/cusp/config/ file_path.

tftp-url

Specifies the TFTP URL that the active configuration will be copied to, or the TFTP URL that will be copied to the active configuration.

 
Command Default

None

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

If you copy a remote file system to the active configuration (using the copy { sftp-url | pfs-url | tftp-url } configuration active syntax), then the system must be rebooted.

Examples

The following example copies an active configuration to a remote file system:

se-192-168-20-51(cusp)> copy configuration active sftp://192.168.1.47/pub/cusp/mycfg
Address or name of remote host [192.168.1.47]?
Destination filename [pub/cusp/mycfg]?
Loading configuration to sftp://192.168.1.47/pub/cusp/mycfg: !
[OK - 777 bytes]
777 bytes transferred in 0.029 secs (26793 bytes/sec)
se-192-168-20-51(cusp)>

 
Related Commands

Command
Description

show configuration active

Displays the active Cisco Unified SIP Proxy configuration.

rollback

To roll back to the most recently-committed configuration when you reboot the Cisco Unified SIP Proxy module, use the rollback command in Cisco Unified SIP Proxy EXEC mode.

rollback

 
Syntax Description

This command has no arguments or keywords.

 
Command Default

None

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

Use the show configuration active command to display the committed configuration that is effective after the module is rebooted.

Examples

The following example configures the system to roll back to the most recently-committed configuration when the Cisco Unified SIP Proxy module is rebooted:

se-10-1-0-0(cusp)> rollback

 
Related Commands

Command
Description

rollback factory-default

Rolls back the system to the factory default configuration after the Cisco Unified SIP Proxy module is rebooted.

show configuration active

Displays the active Cisco Unified SIP Proxy configuration.

rollback factory-default

To roll back the system to the factory default configuration when you reboot the Cisco Unified SIP Proxy module, use the rollback factory-default command in Cisco Unified SIP Proxy EXEC mode.

rollback factory-default

 
Syntax Description

This command has no arguments or keywords.

 
Command Default

None

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

Use the show configuration factory-default command to display the factory-default configuration that is effective after the module is rebooted.

Examples

The following example configures the system to roll back to the factory-default configuration when the Cisco Unified SIP Proxy module is rebooted:

se-10-1-0-0(cusp)> rollback factory-default

 
Related Commands

Command
Description

rollback

Rolls back to the most recently-committed configuration when you reboot the Cisco Unified SIP Proxy module.

show configuration factory-default

Displays the factory-default Cisco Unified SIP Proxy configuration.
 
 

show fd statistics

To display the maximum number of open file descriptor counts, use the show fd statistics command in Cisco Unified SIP Proxy EXEC mode.

show fd statistics

 
Syntax Description

This command has no arguments or keywords.

 
Command Default

None

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

8.5.13 and 9.1.4

This command was introduced.

 
Usage Guidelines

Use the show fd statistics command to display the open file descriptor counts.

Examples

The following is sample output from the show fd statistics command:

se-10-1-0-0(cusp)> show fd statistics
MaxOpenFileDescriptorCount: 25000
OpenFileDescriptorCount: 35
se-10-1-0-0(cusp)#

show performance-data cps

Command
Description

rollback factory-default

Rolls back the system to the factory default configuration after the Cisco Unified SIP Proxy module is rebooted.

show configuration active

Displays the active Cisco Unified SIP Proxy configuration.

To display information, including useful call load troubleshooting information, about the number of calls the Cisco Unified SIP Proxy is handling, use the show performance-data cps command in Cisco Unified SIP Proxy EXEC mode.

show performance-data cps

 
Syntax Description

This command has no arguments or keywords.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.1.4

This command was introduced.

Examples

The following example shows Cisco Unified SIP Proxy performance data:

se-192-168-20-42(cusp)> show performance-data cps
 
Rolling average data-
Rolling averages are used for license enforcement and cannot be cleared.
Rolling average for last 5 minutes (cps): 10.0
Rolling values (last ten 30-second windows):
300 300 300 300 300 300 300 300 300 300
 
Performance data since last clear-
Average call rate (cps): 10.0
Peak call rate (cps): 10.07
Number of dropped calls: 0
Performance data was last cleared at: Tue Sep 15 15:27:05 EDT 2009

show route table

To display Cisco Unified SIP Proxy route information for a given table and key based on a specified lookup rule, use the show route table command in Cisco Unified SIP Proxy EXEC mode.

show route table table-name key key rule [ exact | prefix | fixed number ]

 
Syntax Description

table table-name

Specifies the route table name.

key key

Specifies the route table key. The key argument can contain the * wildcard.

rule

Specifies the rule to be used to match: exact, prefix, or fixed.

exact

Performs a lookup using the exact match rule of the key in the specified table.

prefix

Performs a lookup using the longest prefix match rule of the key in the specified table.

fixed

Performs a lookup using a fixed number of characters match rule, instead of an exact match, of the key in the specified table.

number

The fixed number of characters to match the key in the specified table

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.1.4

This command was introduced.

Examples

The following example shows sample output from the show route table command using the prefix match rule:

se-10.0.0.0(cusp)> show route table t1 key 1800 rule prefix
key 1800 default-sip n1
 

The following example shows sample output from the show route table command using the exact match rule, where “key 555” does not exist in the route table:

se-10.0.0.0(cusp)> show route table t1 key 555 rule exact
No matching route found.

 
Related Commands

Command
Description

key default-sip

Configures the message in the route table to be routed using RFC 3263.

key group

Assigns a route group to a routing table and associates it with a key number.

key policy

Assigns a route policy to a key in a routing table.

key response

Assigns a response code to a key in a routing table.

key route-uri target-destination

Assigns a route-URI to a lookup key in a routing table and replaces the target destination with the specified value in the outgoing SIP request.

key target-destination

Replaces a target destination with the specified value in an outgoing SIP request.

route table

Creates a route table and enters route table configuration mode.

route table file

Loads the routes for a route table from a file.

show routes table

To display the possible multiple Cisco Unified SIP Proxy routes for a given table and key, use the show routes table command in Cisco Unified SIP Proxy EXEC mode.

show routes table table-name key key [ max-size max-size ]

 
Syntax Description

table table-name

Specifies the route table name.

key key

Specifies the route table key. The key argument can contain the * wildcard.

max-size max-size

Specifies the maximum number of routes to return. The default is 100.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

Examples

The following example shows sample output from the show routes table command:

se-10.0.0.0(cusp)> show routes table t1 key * max-size 10
First 10 matches in the t1 table that match the key *:
key k3 default-sip n1
key k2 request-uri-host-port ahost n1
key k1 response 408
 

The second column in the output is the route table lookup key. The third column is the route.

 
Related Commands

Command
Description

key default-sip

Configures the message in the route table to be routed using RFC 3263.

key group

Assigns a route group to a routing table and associates it with a key number.

key policy

Assigns a route policy to a key in a routing table.

key response

Assigns a response code to a key in a routing table.

key route-uri target-destination

Assigns a route-URI to a lookup key in a routing table and replaces the target destination with the specified value in the outgoing SIP request.

key target-destination

Replaces a target destination with the specified value in an outgoing SIP request.

route table

Creates a route table and enters route table configuration mode.

route table file

Loads the routes for a route table from a file.

show status queue

To display the statistics for active SIP queues, use the show status queue command in Cisco Unified SIP Proxy EXEC mode.

show status queue

 
Syntax Description

This command has no arguments or keywords.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

Examples

The following example shows sample output from the show status queue command:

se-192-168-20-51(cusp)> show status queue
 
Queue Name Current Length Active Threads
timer 0 0
radius 0 0
st-callback 0 0
request 0 0
message 0 0
response 0 0
xcl 0 0
 
se-192-168-20-51(cusp)>
 

Table 1 describes the significant fields shown in the display.

 

Table 1 show status queue Field Descriptions

Field
Description

Queue Name

The name of the SIP queue.

Current Length

The current length of the SIP queue.

Active Threads

The number of active threads for the SIP queue.

 
Related Commands

Command
Description

show configuration active sip network

Displays SIP network interface configuration.

show configuration active sip record-route

Displays SIP record-route configuration.

show status sip

Displays the status of the Cisco Unified SIP Proxy.

sip queue

Creates a SIP queue and enters SIP queue configuration mode.

show status sip

To display the status of the Cisco Unified SIP Proxy, use the show status sip command in Cisco Unified SIP Proxy EXEC mode.

show status sip

 
Syntax Description

This command has no arguments or keywords.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

This command displays active client and server transactions, as well as TCP/TLS writer thread information. This command displays queues that might not be SIP-related.

Examples

The following example shows sample output from the show status sip command:

se-192-168-20-51(cusp)> show status sip
 
SIP Stack Status
Client Transactions: 7575
Server Transactions: 3473
Total Threads for TCP/TLS Writer: 0
Min Threads for TCP/TLS Writer: 0
Active Threads for TCP/TLS Writer: 0
se-192-168-20-51(cusp)>
 

Table 2 describes the significant fields shown in the display.

 

Table 2 show status sip Field Descriptions

Field
Description

Client Transactions

The number of active client transactions.

Server Transactions

The number of active server transactions.

Total Threads for TCP/TLS Writer

The total number of TCP/TLS writer threads.

Min Threads for TCP/TLS Writer

The minimum number of TCP/TLS writer threads.

Active Threads for TCP/TLS Writer

The number of active threads for TCP/TLS writers.

 
Related Commands

Command
Description

show configuration active sip network

Displays SIP network interface configuration.

show configuration active sip record-route

Displays SIP record-route configuration.

show status queue

Displays the statistics for currently active SIP queues.

show trace options

To display whether trace logging is enabled or disabled, use the show trace options command in Cisco Unified SIP Proxy EXEC mode.

show trace options

 
Syntax Description

This command has no arguments or keywords.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

This command displays levels for any of the configured categories or components.

Examples

The following example shows that trace is enabled at the debug level with category root.

se-192-168-20-51(cusp)> show trace options
 
Trace is enabled.
 
Category Level
root debug
 

 
Related Commands

Command
Description

trace disable

Disables tracing.

trace enable

Enables tracing.

trace level

Sets the trace level.

trace disable

To disable tracing, use the trace disable command in Cisco Unified SIP Proxy EXEC mode. To enable tracing, use the trace enable command.

trace disable

 
Syntax Description

This command has no arguments or keywords.

 
Command Default

Trace is enabled.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

Using the trace disable command has the same effect as setting the trace level to off using the trace level command with the category root.

Examples

The following example disables trace:

se-192-168-20-51(cusp)> trace disable
 

 
Related Commands

Command
Description

show trace options

Displays whether trace is enabled or disabled.

trace enable

Enables tracing.

trace level

Sets the trace level.

trace enable

To enable tracing, use the trace enable command in Cisco Unified SIP Proxy EXEC mode. To disable tracing, use the trace disable command.

trace enable

 
Syntax Description

This command has no arguments or keywords.

 
Command Default

Trace is enabled.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

 
Usage Guidelines

After enabling tracing, you must set the trace level using the trace level command.

Examples

The following example enables trace:

se-192-168-20-51(cusp)> trace enable
 

 
Related Commands

Command
Description

show trace options

Displays whether trace is enabled or disabled.

trace disable

Disables tracing.

trace level

Sets the trace level.

trace level

To set the trace level, use the trace level command in Cisco Unified SIP Proxy EXEC mode. To turn off trace level, set the trace level to off.

trace level [ debug | default | error | fatal | info | off | warn ] category/component category/component-name

 
Syntax Description

category/component

Log messages from the category/component-name subsystem only. Components are basically predefined lists of categories.

category/component-name

Subsystem from which to log messages.

debug

Log messages of debug severity or higher.

default

Use the trace level of the parent.

error

Log messages of error severity or higher.

fatal

Log messages of fatal severity or higher.

info

Log messages of info severity or higher.

off

Do not log messages.

warn

Log messages of warning severity or higher.

 
Command Default

Trace level is debug category root.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.

1.1.4

This command was modified.

 
Usage Guidelines

When trace is enabled using the trace enable command, the trace level can be set. In the list order of most logging to least logging, the trace levels are:

  • debug
  • info
  • warning
  • error
  • fatal

Setting the trace level to off has the same effect as using the trace disable command if the category is root. Setting the trace level to debug has a huge performance impact.

The category or component can be used to only log messages for particular features. Because components are basically predefined lists of categories, we recommend that you debug using the component option. Trace level settings are not persistent and are reset after a reboot. The only category available currently is root.

Examples

The following example enables trace at the category root:

se-192-168-20-51(cusp)> trace level debug category root
 

The following example enables trace at the routing component:

se-192-168-20-51(cusp)> trace level debug component routing

 
Related Commands

Command
Description

show trace options

Displays whether trace is enabled or disabled.

trace disable

Disables tracing.

trace enable

Enables tracing.

trace logsize

To change the logsize, use the trace logsize command in Cisco Unified SIP Proxy EXEC mode.

trace logSize

 
Syntax Description

default

Use the trace logsize of the parent.

<200-5000>

Define the logsize in MB. The range is from 200 to 5000.

 
Command Default

By default, this command is disabled.

 
Command Modes

Cisco Unified SIP Proxy EXEC (cusp)

 
Command History

Cisco Unified SIP Proxy Version
Modification

8.5.8

This command was introduced.

 
Usage Guidelines

Use this command to increase the logsize from the default of 200Mb to 5Gb capacity.

Examples

The following example displays the two options under the trace logsize command:

se-10-104-45-249(cusp)# trace logsize ?
default Restore the default log Size, 200 MB
<200-5000> Log Size in MB, default 200 MB, min val
 

200MB

The following example displays the logsize and file count defined:

se-10-106-97-200(cusp)# trace logFileSize 200 ?
fileCount Specify number of files to be generated
se-10-106-97-200(cusp)# trace logFileSize 200 f
se-10-106-97-200(cusp)# trace logFileSize 200 fileCount ?
<20-500> Number of trace files to be generated,more number of files
with less size, better the performance
se-10-106-97-200(cusp)# trace logFileSize 200 fileCount 20

 

note.gif

Noteblank.gif Logsize divided by file count is the size of a single log file. The optimal value of this is 10 MB. By default, the command picks up the value of file count so that the file size is 10MB. If you are configuring the file count, there can be performance impact because of this change.

 
Related Commands

Command
Description

trace disable

Disables tracing.

trace enable

Enables tracing.

trace level

Sets the trace level.