Cisco Unified SIP Proxy Configuration Commands
Last Updated: April 8, 2019
call-rate-limit
To set the maximum call rate that the Cisco Unified SIP Proxy can handle, use the call-rate-limit command in Cisco Unified SIP Proxy configuration mode. To set the limit back to the default for standard or Lite Mode, use the no form of this command.
call-rate-limit limit
no call-rate-limit
Syntax Description
limit |
Specifies the maximum call rate. |
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
Cisco Unified SIP Proxy Version
|
|
8.5.2 |
This command was introduced. |
Usage Guidelines
Use this command to set the maximum call rate. The system drops all calls that exceed this limit.
Examples
The following example sets the maximum call rate to 50 calls per second:
se-10-0-0-0(cusp-config)> call-rate-limit 50
The following example returns the limit back to the default:
se-10-0-0-0(cusp-config)> no call-rate-limit
clear
To clear out the outstanding committable configuration commands in the candidate configuration, use the clear command in Cisco Unified SIP Proxy configuration mode. There is not a no form of this command.
clear
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
After using this command, the candidate configuration is the same as the active configuration.
Examples
The following example clears the candidate configuration:
se-10-0-0-0(cusp-config)> clear
Related Commands
|
|
show configuration candidate |
Displays the running configuration of the Cisco Unified SIP Proxy if the uncommitted configuration command values were to be committed. |
commit
To enable Cisco Unified SIP Proxy policy, SIP server group, route group, route table, and other committable configuration changes to take effect, use the commit command in Cisco Unified SIP Proxy configuration mode.
commit
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
Unlike typical Cisco IOS software commands, many of the Cisco Unified SIP Proxy commands require that you use the commit command for the configuration changes to take effect. The Cisco Unified SIP Proxy uses the concept of the candidate configuration and the active configuration. Before the commit command is entered, the configuration changes are included in the candidate configuration. After the commit command is entered, the configuration changes become part of the active configuration.
The commands in the following configuration modes require that you issue the commit command for the configuration changes to take effect:
- Policy lookup
- Policy normalization
- Policy time
- Route group
- Route table
- Server group sip (selected commands only)
Note Any configuration changes you enter before the commit command do not appear if you enter the show configuration active command, however they will appear if you enter the show configuration candidate command. When you use the commit command, then any configuration changes made since the last time you used the commit command appear in the show configuration active command output.
Commands in the following configuration modes do not require that you use the commit command for the commands to take effect:
- Accounting
- SIP network
- SIP commands in CUSP configuration mode
- Trigger
These commands are only a subset of the commands that do not need to be committed. Noncommittable commands are verified and immediately applied to the active configuration. The commit command has no effect on these commands.
When exiting Cisco Unified SIP Proxy configuration mode, the system will prompt you to commit the configuration changes if you have not done so already. You can commit the changes before exiting Cisco Unified SIP Proxy configuration mode, or you can simply exit the configuration mode without committing the changes. All committable commands that have not been committed are discarded.
Examples
The following example configures a time policy and issues the commit command so the configuration changes can take effect:
se-10-0-0-0(cusp-config)> policy time tp1
se-10-0-0-0(cusp-config-time)> sequence 1
se-10-0-0-0(cusp-config-time-seq)> start-time 14:15:20 jan 01 2008
se-10-0-0-0(cusp-config-time-seq)> end-time 12:00:00 dec 01 2008
se-10-0-0-0(cusp-config-time-seq)> month jan - feb, may, oct - dec
se-10-0-0-0(cusp-config-time-seq)> exit
se-10-0-0-0(cusp-config-time)> exit
se-10-0-0-0(cusp-config)> commit
Related Commands
|
|
show configuration active |
Displays the active Cisco Unified SIP Proxy configuration. |
show configuration candidate |
Displays the candidate Cisco Unified SIP Proxy configuration. |
end
To exit out of a Cisco Unified SIP Proxy configuration or EXEC mode and return to module EXEC mode, use the end command.
end
Syntax Description
This command has no arguments or keywords.
Command Modes
All Cisco Unified SIP Proxy configuration submodes
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
When exiting from Cisco Unified SIP Proxy configuration mode, the system prompts you for confirmation on whether to commit the existing active configuration if there are any outstanding uncommitted commands. If you exit without committing the commands, any outstanding committable commands will be cleared.
Examples
The following example exits Cisco Unified SIP Proxy EXEC mode and enters module EXEC mode:
The following example exits Cisco Unified SIP Proxy configuration mode, commits the uncommitted commands, and enters Cisco Unified SIP Proxy EXEC mode:
se-10-0-0-0(cusp-config)> end
Commit before exiting? (yes/no/cancel) [cancel]:y
Building CUSP configuration...
Related Commands
|
|
configure |
Enters Cisco Unified SIP Proxy configuration mode. |
exit |
Exits out of a Cisco Unified SIP Proxy configuration or EXEC mode and returns to the higher mode. |
exit
To exit out of a Cisco Unified SIP Proxy configuration or EXEC mode and return to the higher mode, use the exit command.
exit
Syntax Description
This command has no arguments or keywords.
Command Modes
All Cisco Unified SIP Proxy configuration submodes
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
When exiting from Cisco Unified SIP Proxy configuration mode, the system prompts you to confirm whether to commit the existing active configuration if there are any outstanding uncommitted commands. If you exit without committing the commands, any outstanding committable commands are cleared.
Examples
The following example exits Cisco Unified SIP Proxy EXEC mode and enters module EXEC mode:
The following example exits Cisco Unified SIP Proxy configuration mode, commits the uncommitted commands, and enters Cisco Unified SIP Proxy EXEC mode:
se-10-0-0-0(cusp-config)> exit
Commit before exiting? (yes/no/cancel) [cancel]:y
Building CUSP configuration...
Related Commands
|
|
configure |
Enters Cisco Unified SIP Proxy configuration mode. |
end |
Exits out of a Cisco Unified SIP Proxy configuration or EXEC mode and returns to EXEC mode. |
lite-mode
To delete the record-route configurations and to change the license limits, use the lite-mode command.
lite-mode
Syntax Description
This command has no arguments or keywords.
Command Modes
All Cisco Unified SIP Proxy configuration submodes
Command History
Cisco Unified SIP Proxy Version
|
|
8.5 |
This command was introduced. |
Examples
The following example describes how to turn on lite mode:
se-10-0-0-0(cusp-config)> lite-mode
load
To load sample template configuration files to the Cisco Unified SIP Proxy, use the load command in Cisco Unified SIP Proxy EXEC configuration mode. There is not a no form of this command.
load { ftp-url | pfs-url | tftp-url }
Syntax Description
ftp-url |
Specifies the FTP URL of the sample template configuration files to be loaded. |
pfs-url |
Specifies the Public File System (PFS) URL that the active configuration will either 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 of the sample template configuration files to be loaded. |
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
The default configuration gets automatically loaded during the initialization process. You can load sample template configuration files after the system is initialized, after the default configurations are loaded onto the system.
Note This command loads the configuration commands listed in the specified file. If an noncommittable command in the file is dependent on a set of committable commands in the file, the file must also list the commit command before the noncommittable command.
Examples
The following example loads a sample template configuration file named XXXXX:
se-10-0-0-0# load-config XXXXX
Related Commands
|
|
show configuration active |
Displays the active Cisco Unified SIP Proxy configuration. |
show configuration active
To display the active Cisco Unified SIP Proxy configuration, except for route tables and routes, use the show configuration active command in Cisco Unified SIP Proxy EXEC mode and Cisco Unified SIP Proxy configuration mode.
show configuration active
Command with optional keywords for showing specific configuration contexts:
show configuration active accounting
show configuration active policy
show configuration active policy lookup
show configuration active policy normalization
show configuration active policy time
show configuration active route group
show configuration active route table
show configuration active server-group radius
show configuration active server-group sip
show configuration active server-group sip group
show configuration active server-group sip ping-options
show configuration active sip
show configuration active sip ip-address queue
show configuration active sip listen
show configuration active sip network
show configuration active sip record-route
show configuration active sip tls
show configuration active trigger
show configuration active trigger pre-normalization
show configuration active trigger post-normalization
show configuration active trigger routing
show configuration active verbose
Syntax Description
All keywords |
(Optional) You can enter a keyword representing a specific configuration context to display just the active configuration for that context. |
verbose |
(Optional) Shows the route tables and routes. |
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
8.5 |
This command was updated. |
Usage Guidelines
Use this command to display all committable commands that were committed and all noncommittable commands. You can display the complete active configuration or just display the active configuration for a specific configuration context.
Unless you add the verbose argument, the system does not display the route tables or routes.
Examples
The following example displays the full Cisco Unified SIP Proxy active configuration:
se-10.0.0.0(cusp)> show configuration active
Building CUSP configuration...
server-group sip global-load-balance request-uri
server-group sip retry-after 0
server-group sip element-retries udp 3
server-group sip element-retries tls 1
server-group sip element-retries tcp 1
no non-invite-provisional
retransmit-count invite-server-transaction 9
retransmit-count invite-client-transaction 5
retransmit-count non-invite-client-transaction 9
retransmit-timer clientIn 64000
retransmit-timer serverIn 64000
retransmit-timer TU2 32000
retransmit-timer TU1 5000
sip tcp connection-timeout 240
sip tcp max-connections 256
sip overload reject retry-after 0
no server-group sip global-ping
The following example displays the active configuration for the RADIUS accounting context only:
se-10.0.0.0(cusp)> show configuration active accounting
Building CUSP configuration...
The following example displays the active configuration for the SIP listen network context only:
se-192-168-20-42(cusp)> show configuration active sip listen
Building CUSP configuration...
sip ip-address listen external udp 192.168.20.42 5061
sip ip-address listen internal udp 192.168.20.42 5060
The following example displays the active configuration for the SIP network context only:
se-10.0.0.0(cusp)> show configuration active sip network
Building CUSP configuration...
sip ip-address network external standard
sip ip-address network internal standard
The following example displays the active configuration for the trigger condition context only:
se-10.0.0.0(cusp)> show configuration active trigger condition
Building CUSP configuration...
trigger condition default-condition
trigger condition mid-dialog
trigger condition radius-interim
The following example displays the active configuration for the trigger condition prenormalization context only:
se-192-168-20-42(cusp)> show configuration active trigger pre-normalization
Building CUSP configuration...
trigger pre-normalization sequence 1 policy norm2 condition default-condition
The following example displays the active configuration for the server group SIP group context only:
se-192-168-20-42(cusp)> show configuration active server-group sip group
Building CUSP configuration...
server-group sip group sg1.cisco.com external
element ip-address 192.168.1.47 5060 udp q-value 0.5 weight 0
element ip-address 192.168.1.47 5061 udp q-value 0.7 weight 0
failover-resp-codes 500, 503, 506
The following example displays the active configuration for the policy normalization context only:
se-192-168-20-42(cusp)> show configuration active policy normalization
Building CUSP configuration...
policy normalization norm2
header add SUPPORTED sequence 1 first 100rel
header update REQUIRE first path
header update SUBJECT first Hello
The following example displays the active configuration for the policy lookup context only:
se-192-168-20-42(cusp)> show configuration active policy lookup
Building CUSP configuration...
sequence 1 to-lnx header ruri uri-component user
sequence 2 to-sun header ruri uri-component user
policy lookup mid-dialog-policy
sequence 1 mid-table header ruri uri-component uri
Related Commands
|
|
show configuration candidate |
Displays the running configuration of the Cisco Unified SIP Proxy if the uncommitted configuration command values were to be committed. |
show configuration factory-default |
Displays the factory default configuration. |
show configuration candidate
To display the running configuration of the Cisco Unified SIP Proxy if the uncommitted configuration command values are committed, use the show configuration candidate command in Cisco Unified SIP Proxy manager mode or Cisco Unified SIP Proxy configuration mode.
show configuration candidate
Command with optional keywords for showing specific configuration contexts:
show configuration candidate accounting
show configuration candidate policy lookup
show configuration candidate policy normalization
show configuration candidate policy time
show configuration candidate route group
show configuration candidate route table
show configuration candidate server-group radius
show configuration candidate server-group sip
show configuration candidate server-group sip group
show configuration candidate server-group sip ping-options
show configuration candidate sip listen
show configuration candidate sip network
show configuration candidate sip record-route
show configuration candidate trigger condition
show configuration candidate trigger pre-normalization
show configuration candidate trigger post-normalization
show configuration candidate trigger routing
show configuration candidate verbose
Syntax Description
All keywords |
(Optional) You can enter a keyword representing a specific configuration context to display just the uncommitted configuration for that context. |
verbose |
(Optional) Shows the route tables and routes. |
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
8.5 |
This command was updated. |
Usage Guidelines
Use this command to show what the active configuration is if you enter the commit command. This display shows the active configuration plus all the changes since the last time the commit command was entered.
Unless you add the verbose argument, the system does not display the route tables or routes.
Examples
The following example displays what the full Cisco Unified SIP Proxy running configuration is if the commit command was entered:
se-10.0.0.0(cusp)> show configuration candidate
Building CUSP configuration...
server-group sip element-retries udp 3
server-group sip element-retries tls 1
server-group sip element-retries tcp 1
server-group sip global-load-balance request-uri
server-group sip retry-after 0
sip overload reject retry-after 0
sip tcp connection-timeout 240
sip tcp max-connections 256
no server-group sip global-ping
The following example displays the uncommitted configuration for the RADIUS accounting context only:
se-10.0.0.0(cusp)> show configuration candidate accounting
Building CUSP configuration...
Related Commands
|
|
commit |
Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect. |
show configuration active |
Displays the active Cisco Unified SIP Proxy configuration. |
show configuration factory-default |
Displays the factory default configuration. |
show configuration factory-default
To display the factory default configuration, use the show configuration factory-default command in Cisco Unified SIP Proxy EXEC mode.
show configuration factory-default
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
Use this command to display the Cisco Unified SIP Proxy factory default configuration. If the system is reset to the factory default, this is the configuration that is stored on the system.
Examples
The following example displays the factory default configuration:
se-10.0.0.0(cusp)> show configuration factory-default
Building CUSP configuration...
server-group sip global-load-balance call-id
server-group sip retry-after 0
server-group sip element-retries tcp 1
server-group sip element-retries udp 3
server-group sip element-retries tls 1
sip tcp connection-timeout 240
sip tcp max-connections 256
no server-group sip global-ping
Related Commands
|
|
show configuration active |
Displays the active Cisco Unified SIP Proxy configuration. |
show configuration candidate |
Displays the running configuration of the Cisco Unified SIP Proxy if the uncommitted configuration command values are committed. |
show sip
To display SIP log files, use the show sip command in Cisco Unified SIP Proxy EXEC mode.
show sip { message | peg-counting } log [ options ]
Syntax Description
message |
Displays the SIP message log. |
peg-counting |
Displays the SIP peg-counting log. |
options |
Options for displaying the log file:
- Display a given number of lines from the end of the log.
- Send the output to another command.
- Display the most recent entries in the log and keep updating them.
|
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
Cisco Unified SIP Proxy Version
|
|
1.0 |
This command was introduced. |
Usage Guidelines
The SIP message log file rotates every 10 MB or every night and is located at pfs://cusp/log/sipmsg. The SIP peg-counting log file rotates every 10 MB or every night also and is located at pfs://cusp/log/pegcount.
Examples
The following example shows sample output from the show sip message log command:
se-10.0.0.0(cusp)> show sip message log
Request received at Wed, 19 Nov 2008 21:01:25,081 GMT on 192.168.20.101 on port 6060 from the Remote IP 192.168.20.25 on port 6080
INVITE sip:735551212@192.1.1.75:6061 SIP/2.0
Via: SIP/2.0/UDP 192.168.20.5:6080;branch=z9hG4bK-1-0
To: sut <sip:735551212@192.1.1.75:6061>
From: sipp <sip:sipp@192.168.20.5:6080>;user=phone;vnd.pimg.port=1;tag=1
Contact: sip:sipp@192.168.20.5:6080
Call-ID:1-7675@192.168.20.5
P-Asserted-Identity: <sip:alice@home1.net>
Subject: Performance Test
Content-Type: application/sdp
o=user1 53655765 2353687637 IN IP4 192.168.20.5
The following example shows sample output from the show sip peg-counting log command:
se-10.0.0.0(cusp)> show sip peg-counting log
Delta In Delta Out Delta In Delta Out Total In Total Out Total In Total Out
Message Initial Initial Retrans Retrans Initial Initial Retrans Retrans
SUBSCRIBE 0 0 0 0 0 0 0 0