Cisco Unified SIP Proxy Command Reference Version 1.1.3
Cisco Unified SIP Proxy Commands
Downloads: This chapterpdf (PDF - 1.68MB) The complete bookPDF (PDF - 5.86MB) | Feedback

Cisco Unified SIP Proxy Commands

Table Of Contents

Cisco Unified SIP Proxy Commands

cusp

shutdown graceful

ip route

configure

copy configuration active

rollback

rollback factory-default

show license

show routes table

show status queue

show status sip

show trace options

trace disable

trace enable

trace level

clear

commit

end

exit

load

show configuration active

show configuration candidate

show configuration factory-default

show sip

sip network

allow-connections

header-hide

non-invite-provisional

retransmit-count (SIP network)

retransmit-timer (SIP network)

sip listen

sip record-route

sip max-forwards

sip header-compaction

sip overload redirect

sip overload reject

sip tcp connection-timeout

sip tcp max-connections

sip queue

drop-policy

low-threshold

size

thread-count

sip dns-srv

enable (SIP DNS server)

use-naptr

sip alias

sip logging

sip peg-counting

sip privacy trusted-destination

sip privacy trusted-source

sip privacy service

sip tls

sip tls trusted-peer

route recursion

server-group sip element-retries

server-group sip global-load-balance

server-group sip global-ping

server-group sip group

element ip-address (SIP server group )

element reference

failover-resp-code

lb-type

ping (SIP server group)

server-group sip retry-after

server-group sip ping-options

method (SIP server group ping-options)

ping-type

timeout

show status server-group sip

server-group radius group

element ip-address (RADIUS server group)

retransmit-count (RADIUS server goup)

retransmit-timeout (RADIUS server group)

show status server-group radius

trigger condition

trigger post-normalization

trigger pre-normalization

trigger routing

sequence (trigger)

header (trigger sequence)

in-network

local-ip

local-port

message

method (trigger sequence)

mid-dialog

out-network

protocol

proxy-route header-param

proxy-route uri-component

proxy-route uri-param

remote-ip

remote-port

request-uri uri-component

request-uri uri-param

response-code

time

user-agent-hdr

route table file

route table

key default-sip

key group

key policy

key response

key route-uri target-destination

key target-destination

route group

element route-uri

element route-uri target-destination

element target-destination

failover-codes

time-policy (element)

weight

policy time

sequence (policy time)

end-time

month

start-time

day-of-month

day-of-week

time (policy time sequence)

policy lookup

sequence field

rule

key-modifier

sequence header uri-component

policy normalization

header-param add

header-param remove

header-param update

header add

header remove

header update

sip-to-tel

sip-to-tel request-uri

tel-to-sip

tel-to-sip request-uri

uri-component update header

uri-component update request-uri

uri-param add

uri-param add request-uri

uri-param remove

uri-param remove request-uri

uri-param update

uri-param update request-uri

accounting

client-side

enable (accounting)

event

header (accounting)

server-side

crypto key certreq

crypto key label default

crypto key delete

crypto key generate

show crypto key


Cisco Unified SIP Proxy Commands


First Published: February 6, 2009
Last Updated: May 19, 2009

Service Module EXEC Commands

cusp

shutdown graceful

ip route

Cisco Unified SIP Proxy Root Commands

EXEC Commands

configure

copy configuration active

rollback

rollback factory-default

show license

show routes table

show status queue

show status sip

show trace options

trace disable

trace enable

trace level

Configuration Commands

clear

commit

end

exit

load

show configuration active

show configuration candidate

show configuration factory-default

show sip

Cisco Unified SIP Proxy SIP Commands

sip network

allow-connections

header-hide

non-invite-provisional

retransmit-count (SIP network)

retransmit-timer (SIP network)

sip listen

sip record-route

sip max-forwards

sip header-compaction

sip overload redirect

sip overload reject

sip tcp connection-timeout

sip tcp max-connections

sip queue

drop-policy

low-threshold

size

thread-count

sip dns-srv

enable (SIP DNS server)

use-naptr

sip alias

sip logging

sip peg-counting

sip privacy trusted-destination

sip privacy trusted-source

sip privacy service

sip tls

sip tls trusted-peer

route recursion

SIP Server Group Commands

server-group sip element-retries

server-group sip global-load-balance

server-group sip global-ping

server-group sip group

element ip-address (SIP server group )

element reference

failover-resp-code

lb-type

ping (SIP server group)

server-group sip retry-after

server-group sip ping-options

method (SIP server group ping-options)

ping-type

timeout

show status server-group sip

RADIUS Server Group Commands

server-group radius group

element ip-address (RADIUS server group)

retransmit-count (RADIUS server goup)

retransmit-timeout (RADIUS server group)

show status server-group radius

Trigger Commands

trigger condition

trigger post-normalization

trigger pre-normalization

trigger routing

sequence (trigger)

header (trigger sequence)

in-network

local-ip

local-port

message

method (trigger sequence)

mid-dialog

out-network

protocol

proxy-route header-param

proxy-route uri-component

proxy-route uri-param

remote-ip

remote-port

request-uri uri-component

request-uri uri-param

response-code

time

user-agent-hdr

Route Commands

route table file

route table

key default-sip

key group

key policy

key response

key route-uri target-destination

key target-destination

route group

element route-uri

element route-uri target-destination

element target-destination

failover-codes

time-policy (element)

weight

Policy Commands

policy time

sequence (policy time)

end-time

month

start-time

day-of-month

day-of-week

time (policy time sequence)

policy lookup

sequence field

rule

key-modifier

sequence header uri-component

policy normalization

header-param add

header-param remove

header-param update

header add

header remove

header update

sip-to-tel

sip-to-tel request-uri

tel-to-sip

tel-to-sip request-uri

uri-component update header

uri-component update request-uri

uri-param add

uri-param add request-uri

uri-param remove

uri-param remove request-uri

uri-param update

uri-param update request-uri

Accounting Commands

accounting

client-side

enable (accounting)

event

header (accounting)

server-side

Security Commands

crypto key certreq

crypto key label default

crypto key delete

crypto key generate

show crypto key

cusp

To enter Cisco Unified SIP Proxy EXEC mode, use the cusp command in network module EXEC mode. To exit Cisco Unified SIP Proxy management mode, use the exit command.

cusp

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Network module EXEC (>)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example accesses the Cisco Unified SIP Proxy network module and enters Cisco Unified SIP Proxy management mode:

Router# service-module integrated-service-engine 1/0 session

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

Related Commands

Command
Description

configure

Enters Cisco Unified SIP Proxy configuration mode.

exit

Exits out of a Cisco Unified SIP Proxy configuration or management mode and reutrns to the higher mode.


shutdown graceful

To perform a graceful shutdown of the Cisco Unified SIP Proxy network module, use the shutdown graceful command in network module EXEC mode.

shutdown graceful [timeout]

Syntax Description

timeout

(Optional) Specifies the timeout value for the Cisco Unified SIP Proxy network module. The valid range is 10 to 180 seconds. The default is 32 seconds.


Command Default

The default timeout value is 32 seconds.

Command Modes

Network module EXEC (>)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The timeout value specifies how long the Cisco Unified SIP Proxy waits for pending tasks to complete before exiting.

Examples

The following example executes a graceful shutdown of the Cisco Unified SIP Proxy network module, specifying a timeout value of 120 seconds:

se-10-0-0-0# shutdown graceful 120

Related Commands

Command
Description

reload

Restarts the Cisco Unified SIP Proxy system after the shutdown command has been used and activates the uploaded file information after the restore command has been used.


ip route

To establish static routes to Cisco Unified SIP Proxy's virtual interfaces and other routers, use the ip route command in network module configuration mode.

ip route destination-ip destination-mask {gigabitethernet | ip-address}

Syntax Description

destination-ip

Destination network address.

destination-mask

Destination network address mask.

gigabitethernet

Virtual interface to which to route.

ip-address

Forwarding router's address.


Command Default

No static routes are established.

Command Modes

Network module configuration (config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The last argument specifies the forwarding address which is either the virtual interface to route to or the forwarding router's address.

Examples

The following example establishes a static route to Cisco Unified SIP Proxy's Gigabit Ethernet interface 0.2:

se-10-0-0-0(config)# ip route 10.10.10.2 255.255.255.0 GigabitEthernet0.2

The following example establishes a static route to the router whose IP address is 10.10.20.2:

se-10-0-0-0(config)# ip route 10.10.10.2 255.255.255.0 10.10.20.2

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, type end.

Examples

The following example accesses the Cisco Unified SIP Proxy network 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-0-0-0> cusp
se-10-0-0-0(cusp)> configure
se-10-0-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 {ftp-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 {ftp-url | pfs-url | tftp-url} configuration active

Syntax Description

ftp-url

Specifies the FTP URL that the active configuration will be copied to, or the FTP 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 {ftp-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 ftp://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 ftp://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 network 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 network 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 network module is rebooted:

se-10-0-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 network 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 network 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 dispaly the factory-default configuration that is effective after the network module is rebooted.

Examples

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

se-10-0-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 network module.

show configuration factory-default

Displays the factory-default Cisco Unified SIP Proxy configuration.


show license

To display the license SKU that were entered upon initial installation, and the number of calls per second (CPS) allowed by that license, use the show license command in Cisco Unified SIP Proxy EXEC mode.

show license

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 that the license FL-CUSP-10 allows 10 CPS:

se-192-168-20-51(cusp)> show license

Installed license: FL-CUSP-10 (10 CPS)
Exceeding this limit will result in dropped calls.

show routes table

To display the configured Cisco Unified SIP Proxy routes, 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-10.0.0.0(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

Table 3 describes the significant fields shown in the display.

Table 3 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-10.0.0.0(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
Active Threads for TCP/TLS Writer: 0

Table 4 describes the significant fields shown in the display.

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

If trace is enabled, this command displays the trace level configured.

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 th e 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.

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

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

Syntax Description

category

Log messages from the category-name subsystem only.

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


Usage Guidelines

When trace is enabled using the trace enable command, the trace level must be set. In 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 can be used to only log messages from a particular subsystem. The only category available currently is root. The trace level setting is "short-lived," in that when the trace gets enabled it uses the system default setting including trace level=warn.

Examples

The following example enables trace:

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

Related Commands

Command
Description

show trace options

Displays whether trace is enabled or disabled.

trace disable

Disables tracing.

trace enable

Enables tracing.


clear

To clear out the outstanding committable configuration commands in the candidate configuration, use the clear command in Cisco Unified SIP Proxy EXEC mode. There is no no form of this command.

clear

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

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

Command
Description

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

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

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

Command
Description

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 management mode and return to EXEC mode, use the end command.

end

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

All Cisco Unified SIP Proxy configuration submodes

Command History

Cisco Unified SIP Proxy Version
Modification

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 management mode and enters global EXEC mode:

se-10-0-0-0(cusp)> end
se-10-0-0-0> 

The following example exits Cisco Unified SIP Proxy configuration mode, commits the uncommitted commands, and enters Cisco Unified SIP Proxy management mode:

se-10-0-0-0(cusp-config)> end

Commit before exiting? (yes/no/cancel) [cancel]:y
Building CUSP configuration...
[OK]

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

Related Commands

Command
Description

configure

Enters Cisco Unified SIP Proxy configuration mode.

exit

Exits out of a Cisco Unified SIP Proxy configuration or management mode and reutrns to the higher mode.


exit

To exit out of a Cisco Unified SIP Proxy configuration or management mode and reutrn to the higher mode, use the exit command.

exit

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

All Cisco Unified SIP Proxy configuration submodes

Command History

Cisco Unified SIP Proxy Version
Modification

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 management mode and enters global EXEC mode:

se-10-0-0-0(cusp)> exit
se-10-0-0-0> 

The following example exits Cisco Unified SIP Proxy configuration mode, commits the uncommitted commands, and enters Cisco Unified SIP Proxy management mode:

se-10-0-0-0(cusp-config)> exit

Commit before exiting? (yes/no/cancel) [cancel]:y
Building CUSP configuration...
[OK]

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

Related Commands

Command
Description

configure

Enters Cisco Unified SIP Proxy configuration mode.

end

Exits out of a Cisco Unified SIP Proxy configuration or management mode and returns to EXEC 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 no 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 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

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 uncommitable 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 uncommiitable command.


Examples

The following example loads a sample template configuration file named XXXXX:

se-10-0-0-0# load-config XXXXX

Related Commands

Command
Description

show configuration active

Displays the active Cisco Unified SIP Proxy configuration.


show configuration active

To display the active Cisco SIP Unified SIP Proxy configuration, 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 servergr-oup 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

Syntax Description

All keywords

(Optional) You can enter a keyword representing a specific configuration context to display just the active configuration for that context.


Command Modes

Cisco Unified SIP Proxy EXEC (cusp)
Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


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.

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 
sip dns-srv
 enable
 use-naptr
 end dns!
!
no sip header-compaction 
no sip logging 
!
sip max-forwards 70
sip network a1 standard 
 no non-invite-provisional
 allow-connections
 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 T4 5000
 retransmit-timer T2 4000
 retransmit-timer T1 500
 retransmit-timer TU2 32000
 retransmit-timer TU1 5000
 end network
!
no sip peg-counting 

sip tcp connection-timeout 240 
sip tcp max-connections 256 
!
sip overload reject retry-after 0 
!
accounting
 no enable 
 no client-side 
 no server-side 
 end accounting
!
policy lookup p1
 end policy
!
no server-group sip global-ping 
!
end

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...
!
accounting
 enable 
 client-side 
 server-side 
 end accounting

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
 allow connections
 end network
!
sip ip-address network internal standard
 allow connections
 end network

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 
 sequence 1
  in-network internal
  end sequence
 end trigger condition
!
trigger condition mid-dialog 
 sequence 1
  message request
  route-uri-user rr
  end sequence
 end trigger condition
!
trigger condition radius-interim 
 sequence 1
  message response
  method UPDATE
  end sequence
 end trigger condition

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
 lbtype global
 ping
 end server-group


The following example displays the active configuration for thepolicy 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
 end policy

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...
!
policy lookup lnx-policy
 sequence 1 to-lnx header ruri uri-component user
  rule prefix
  end sequence
 sequence 2 to-sun header ruri uri-component user
  rule exact
  end sequence
 end policy
!
policy lookup mid-dialog-policy
 sequence 1 mid-table header ruri uri-component uri
  rule exact
  end sequence
 end policy
se-192-168-20-42(cusp)>

Related Commands

Command
Description

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

Syntax Description

All keywords

(Optional) You can enter a keyword representing a specific configuration context to display just the uncomitted configuration for that context.


Command Modes

Cisco Unified SIP Proxy EXEC (cusp)
Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


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.

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
!
no sip 100-response 
no sip dns srv-records 
no sip header-compaction 
no sip logging 
!
sip max-forwards 70
sip network a1 standard 
allow-connections
end network
!
sip overload reject retry-after 0 
!
no sip peg-counting 
!
sip tcp connection-timeout 240 
sip tcp max-connections 256 
!
accounting
no enable 
no client-side 
no server-side 
end accounting
!
policy lookup p1
end policy
!
no server-group sip global-ping 
!
end

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...
!
accounting
 enable 
 client-side 
 server-side 
 end accounting

Related Commands

Command
Description

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
Modification

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 dns-srv
 no enable
 use-naptr
 end dns
!
no sip header-compaction 
no sip logging 
!
sip max-forwards 70
!
no sip peg-counting
!
sip privacy service
sip queue message
 drop-policy head
 low-threshold 80
 size 2000
 thread-count 20
 end queue
!
sip queue radius
 drop-policy head
 low-threshold 80
 size 2000
 thread-count 20
 end queue
!
sip queue request
 drop-policy head
 low-threshold 80
 size 2000
 thread-count 20
 end queue
!
sip queue response
 drop-policy head
 low-threshold 80
 size 2000
 thread-count 20
 end queue
!
sip queue st-callback
 drop-policy head
 low-threshold 80
 size 2000
 thread-count 10
 end queue
!
sip queue timer
 drop-policy none
 low-threshold 80
 size 2500
 thread-count 8
 end queue
!
sip queue xcl
 drop-policy head
 low-threshold 80
 size 2000
 thread-count 2
 end queue
!
route recursion
!
sip tcp connection-timeout 240 
sip tcp max-connections 256 
!
no sip tls
!
accounting
 no enable 
 no client-side 
 no server-side 
 end accounting
!
no server-group sip global-ping 
!
end

Related Commands

Command
Description

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
Modification

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
Max-Forwards: 70
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
CSeq: 1 INVITE
Content-Length:135
P-Asserted-Identity: <sip:alice@home1.net>
Cisco-Guid: 1234567890
Subject: Performance Test
Content-Type: application/sdp

v=0
o=user1 53655765 2353687637 IN IP4 192.168.20.5
s=-
c=IN IP4 192.168.20.5
t=0 0
m=audio 6070 RTP/AVP 0
a=rtpmap:0 PCMU/8000

MESSAGE COMPLETE

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
INVITE           0          0         0          0         0          0        0         0
ACK              0          0         0          0         0          0        0         0
CANCEL           0          0         0          0         0          0        0         0
BYE              0          0         0          0         0          0        0         0
OPTIONS          0          0         0          0         0          0        0         0
REGISTER         0          0         0          0         0          0        0         0
SUBSCRIBE        0          0         0          0         0          0        0         0
NOTIFY           0          0         0          0         0          0        0         0
PRACK            0          0         0          0         0          0        0         0
REFER            0          0         0          0         0          0        0         0
UPDATE           0          0         0          0         0          0        0         0
PUBLISH          0          0         0          0         0          0        0         0
INFO             0          0         0          0         0          0        0         0
100              0          0         0          0         0          0        0         0
180              0          0         0          0         0          0        0         0
181              0          0         0          0         0          0        0         0
182              0          0         0          0         0          0        0         0
183              0          0         0          0         0          0        0         0
200              0          0         0          0         0          0        0         0
202              0          0         0          0         0          0        0         0
300              0          0         0          0         0          0        0         0
301              0          0         0          0         0          0        0         0
302              0          0         0          0         0          0        0         0
305              0          0         0          0         0          0        0         0
380              0          0         0          0         0          0        0         0
400              0          0         0          0         0          0        0         0
401              0          0         0          0         0          0        0         0
402              0          0         0          0         0          0        0         0
403              0          0         0          0         0          0        0         0
404              0          0         0          0         0          0        0         0
405              0          0         0          0         0          0        0         0
406              0          0         0          0         0          0        0         0
407              0          0         0          0         0          0        0         0

sip network

To create a logical SIP network and to enter SIP network configuration mode, use the sip network command in Cisco Unified SIP Proxy configuration mode. There is no no form of this command.

sip network network [icmp | nat | noicmp | standard]

Syntax Description

network

Specifies the name of the SIP network interface.

standard

(Optional) Configures the network interface to use standard SIP. The network has full UDP support. The network interface supports ICMP and different sockets can be used for each endpoint. This is the default setting.

nat

(Optional) Configures the network interface to use Network Address Translation (NAT).

icmp

(Optional) Configures the network interface to use Internet Control Message Protocol (ICMP).

noicmp

(Optional) Specifies that the network interface does not use a separate socket for each endpoint. With this configuration, no ICMP errors are supported.


Command Default

Standard

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The type of socket used for the network interface has different characteristics:

Standard

The network interface has full UDP support.

The network interface supports ICMP.

Different sockets can be used for each endpoint.

ICMP

The network interface supports ICMP.

No ICMP

No ICMP errors are supported.

The network does not use a separate socket for each endpoint.

NAT

The network interface supports NAT.


Caution After a SIP network is created, it cannot be removed.

Examples

The following example configures a standard network and enters SIP network configuration mode:

se-10-0-0-0(cusp-config)> sip network internal
se-10-0-0-0(cusp-config-network)> 

The following example configures a SIP network to support ICMP:

se-10-0-0-0(cusp-config)> sip network external icmp

The following example configures the SIP network interface so that ICMP errors are not supported:

se-10-0-0-0(cusp-config)> sip network external noicmp

Related Commands

Command
Description

allow-connections

Configures the SIP network to allow TCP/TLS client connections.

header-hide

Configures the SIP network to mask the header.

non-invite-provisional

Enables the sending of 100 responses to non-INVITE requests,

retransmit-count

Configures the retransmit count for a SIP network.

retransmit-timer

Configures the retransmit-timer value for a SIP network.

show configuration active sip network

Displays the configured SIP network.


allow-connections

To configure the SIP network to allow TCP/TLS client connections, use the allow-connections command in Cisco Unified SIP Proxy SIP network configuration mode. To prevent the SIP network from allowing TCP/TLS connections, use the no form of this command.

allow-connections

no allow-connections

Syntax Description

This command has no arguments or keywords.

Command Default

TCP/TLS client connections on the SIP network are enabled by default.

Command Modes

Cisco Unified SIP Proxy SIP network configuration (cusp-config-network)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example allows TCP/TLS connections on a standard SIP network named "internal":

se-10-0-0-0(cusp-config)> sip network internal standard
se-10-0-0-0(cusp-config-network)> allow-connections

The following example disables TCP/TLS connections on a standard SIP network named "internal":

se-10-0-0-0(cusp-config)> sip network internal standard
se-10-0-0-0(cusp-config-network)> no allow-connections

Related Commands

Command
Description

header-hide

Configures the SIP network to mask the header.

non-invite-provisional

Enables the sending of 100 responses to non-INVITE requests,

retransmit-count

Configures the retransmit count for a SIP network.

retransmit-timer

Configures the retransmit-timer value for a SIP network.

sip network

Creates a logical SIP network and enters SIP network configuration mode.


header-hide

To configure the SIP network to mask the header value, use the header-hide command in Cisco Unified SIP Proxy SIP network configuration mode. To configure the SIP network to not mask the header value, use the no form of this command.

header-hide header-name

no header-hide header-name

Syntax Description

header-name

Specifies the header name that is masked for the network.


Command Modes

Cisco Unified SIP Proxy SIP network configuration (cusp-config-network)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Command Default

The header value is not masked.

Usage Guidelines

The only valid header name in Cisco Unified SIP Proxy version 1.0 is via.

Examples

The following example configures the SIP network to mask the Via header:

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> header-hide via

The following example configures the SIP network to not mask the Via header:

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> no header-hide via

Related Commands

Command
Description

non-invite-provisional

Enables the sending of 100 responses to non-INVITE requests,

retransmit-count

Configures the retransmit count for a SIP network.

retransmit-timer

Configures the retransmit-timer value for a SIP network.

sip network

Creates a logical SIP network and enters SIP network configuration mode


non-invite-provisional

To enable the sending of 100 responses to nonINVITE requests, use the non-invite-provisional command in Cisco Unified SIP Proxy SIP network configuration mode. To disable the sending of 100 responses to non-INVITE requests, use the no form of this command.

non-invite-provisional {TU3-timer-value}

no non-invite-provisional

Syntax Description

TU3-timer-value

Specifies the TU3 timer to be used.


Command Default

The sending of 100 responses to non-INVITE requests is disabled.

Command Modes

Cisco Unified SIP Proxy SIP network configuration (cusp-config-network)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure SIP networks with TU3 transmission type only. If you enable the sending of 100 responses to nonINVITE requests, you must specify a TU3 timer.

Examples

The following example enables the sending of 100 responses to non-INVITE requests, and sets the TU3 timer value to 200:

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> non-invite-provisional 200

The following example disables the sending of 100 responses to non-INVITE requests

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> no non-invite-provisional

Related CommandsTBD

Command
Description

allow-connections

Configures the SIP network to allow TCP/TLS client connections.

header-hide

Configures the SIP network to mask the header.

retransmit-count

Configures the retransmit count for a SIP network.

retransmit-timer

Configures the retransmit-timer value for a SIP network.

sip network

Creates a logical SIP network and enters SIP network configuration mode


retransmit-count (SIP network)

To configure the retransmission count for a SIP network, use the retransmit-count command in Cisco Unified SIP Proxy SIP network configuration mode. To restore the default retransmit count value, use the no or default form of this command.

retransmit-count {invite-client-transaction | invite-server-transaction | non-invite-client-transaction} count_value

no retransmit-count {invite-client-transaction | invite-server-transaction | non-invite-client-transaction}

default retransmit-count {invite-client-transaction | invite-server-transaction | non-invite-client-transaction}

Syntax Description

invite-client-transaction

Specifies the retransmit count for the INVITE request. The default is 5.

invite-server-transaction

Specifies the retransmit counts for final responses of INVITE requests. The default is 9.

non-invite-client-transaction

Specifies the retransmit count for requests other than INVITE. The default is 9.

count_value

Specifies the retransmission count value. The valid range is from 0 to 127. The default depends on the retransmit count selected.


Command Default

The default value for each retransmit count type is as follows:

invite-client-transaction—5

invite-server-transaction—9

non-invite-client-transaction—9

Command Modes

Cisco Unified SIP Proxy SIP network configuration (cusp-config-network)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The retransmission count values specify the maximum number of allowable SIP retransmissions. The value of a specific count can be set different for different networks if a network has different transmission latency characteristics. For more information about retransmission counts using SIP, see RFC 3261.

Examples

The following example configures the invite-client retransmit count to 5:

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> retransmit-count invite-client-transaction 5

The following example configures the client retransmit count to 18:

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> retransmit-count non-invite-client-transaction 18

The following example restores the default value of the invite-client count.

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> no retransmit-count invite-client-transaction

Related Commands

Command
Description

allow-connections

Configures the SIP network to allow TCP/TLS client connections.

header-hide

Configures the SIP network to mask the header.

non-invite-provisional

Enables the sending of 100 responses to nonINVITE requests.

retransmit-timer

Configures the retransmit-timer value for a SIP network.

sip network

Creates a logical SIP network and enters SIP network configuration mode.


retransmit-timer (SIP network)

To configure the SIP retransmission timer values for a SIP network, use the retransmit-timer command in Cisco Unified SIP Proxy SIP network configuration mode. To change a retransmission timer value back to the default value, use the no or default forms of this command.

retransmit-timer {T1 | T2 | T4 | serverTn | clientTn | TU1 | TU2 } timer_value

no retransmit-timer {T1 | T2 | T4 | serverTn | clientTn | TU1 | TU2 }

default retransmit-timer {T1 | T2 | T4 | serverTn | clientTn | TU1 | TU2}

Syntax Description

T1

Sets the initial request retransmission interval. The default is 500 milliseconds.

T2

Sets the maximum request retransmission value. The default is 4,000 milliseconds.

T4

Sets the amount of time a NONINVITE client transaction or INVITE server transaction remains active after completion to handle request or response retransmissions. The default is 5,000 milliseconds.

serverTn

Sets the maximum lifetime of a server transaction. The default is 64,000 milliseconds.

clientTn

Sets the maximum lifetime of a client transaction. The default is 64,000 milliseconds.

TU1

Sets the amount of time an INVITE transaction remains active after completion with a 2xx response to handle response retransmissions. The default is 5,000 milliseconds.

TU2

Sets the amount of time the server waits for a provisional or final response for an INVITE client transaction or NONINVITE server transaction after which the transaction is considered timed out. The default is 32,000 milliseconds.

timer_value

Specifies the retransmission timer value. The valid range is 1 to 100,000 milliseconds. The default value depends on the retransmission timer selected.


Command Default

The default value for each retransmit timer is as follows:

T1—500 milliseconds

T2—4,000 milliseconds

T4—5,000 milliseconds

serverTn—64,000 milliseconds

clientTn—64,000 milliseconds

TU1—5,000 milliseconds

TU2—32,000 milliseconds

Command Modes

Cisco Unified SIP Proxy SIP network configuration (cusp-config-network)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The retransmission timer values define the duration of SIP retransmissions. The value of a specific timer can be set differently for different networks if a network has different transmission latency characteristics. For more information about retransmission timers using SIP, see RFC 3261.

Examples

The following example configures the T1 retransmission timer to 1,000 milliseconds.

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> retransmit-timer T1 1000

The following example restores the default value of the TU1 retransmission timer.

se-10-0-0-0(cusp-config)> sip network external standard
se-10-0-0-0(cusp-config-network)> no retransmit-timer TU1

Related Commands

Command
Description

allow-connections

Configures the SIP network to allow TCP/TLS client connections.

header-hide

Configures the SIP network to mask the header.

non-invite-provisional

Enables the sending of 100 responses to non-INVITE requests.

retransmit-count

Configures the retransmit count for a SIP network.

sip network

Creates a logical SIP network and enters SIP network configuration mode.


sip listen

To create a listener that listens for SIP traffic on a specific SIP network, host and port, use the sip listen command in Cisco Unified SIP Proxy configuration mode. To remove the listener from the SIP network, use the no form of this command.

sip listen network_name {tcp | tls | udp} ip_address port

no sip listen network_name {tcp | tls | udp} ip_address port

Syntax Description

network_name

Specifies the SIP network name.

tcp

Specifies that TCP is used as the transport protocol of the listener.

tls

Specifies that TLS is used as the transport protocol of the listener.

udp

Specifies that UDP is used as the transport protocol of the listener. This is the default.

ip_address

The interface IP address that accepts incoming requests.

port

The port the server listens on for incoming messages. The valid range is from 1024 to 65535. The default value is 5060.


Command Default

The listener on the SIP network is not enabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

A listener is an interface, port, and transport tuple that the server listens on for incoming packets. Multiple listeners can be configured for a single server; however, at least one must be established for the server to accept SIP traffic. A network can have multiple listeners. You do not have to disable listeners on the network when you make configuration changes to the network.


Caution You cannot run TCP and TLS listeners on the same port.


Caution Do not enable the sip listen command until you complete all of the other configuration tasks. After you enable the command, the system starts receiving incoming requests from the specified SIP network.

Examples

The following example configures the listener on a SIP network named "external" that uses the TCP:

se-10-0-0-0(cusp-config)> sip listen external tcp 10.2.3.4 5060

The following example configures the listener on a SIP network named "internal" that uses the UDP:

se-10-0-0-0(cusp-config)> sip listen internal udp 192.168.1.3 5061

The following example disables a listener on a SIP network:

se-10-0-0-0(cusp-config)> no sip listen external tcp 10.2.3.4 5060

Related Commands

Command
Description

sip network

Creates a logical SIP network and enters SIP network configuration mode.


sip record-route

To enable record-routing for a SIP network, use the sip record-route command in Cisco Unified SIP Proxy configuration mode. To disable record-routing for a SIP network, use the no form of this command.

sip record-route network_name {tcp | tls | udp} ip_address [port]

no sip record-route network_name

Syntax Description

network_name

Specifies the SIP network name (as configured using the sip network command) that is logically associated with a Record-Route configuration.

tcp

Specifies that TCP populates the Record-Route header field.

tls

Specifies that TLS populates the Record-Route header field.

udp

Specifies that UDP populates the Record-Route header field. This is the default.

ip_address

Specifies the interface hostname or IP address that populates the Record-Route header field.

port

(Optional) Specifies the port that populates the Record-Route header field. If not specified, 5060 is populated. The valid range is from 1024 to 65535.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Record-routing ensures that all SIP messages within a dialog traverse the same route. The SIP Record-Route header field contains configurable interface, port, and transport values, which forces messages to pass through the desired SIP entity. The Record-Route feature is critical for directing messages to a load balancer that is managing SIP traffic for a group of servers.

Examples

The following example enables record-routing for a SIP network named "internal":

se-10-0-0-0(cusp-config)> sip record-route internal udp cusp1.example.com

The following example enables record-routing for a SIP network named "external":

se-10-0-0-0(cusp-config)> sip record-route external tcp 192.168.1.3 5061

The following example disables record-routing for a SIP network named "external":

se-10-0-0-0(cusp-config)> no sip record-route external

Related Commands

Command
Description

show configuration active sip record-route

Displays SIP record-route configuration.


sip max-forwards

To configure the value of the SIP Max-Forwards header field, use the sip max-forwards command in Cisco Unified SIP Proxy configuration mode. To remove the value from the SIP Max-Forwards header field and restore the default value, use the no form of this command.

sip max-forwards max_forward_value

no sip max-forwards max_forward_value

Syntax Description

max_forward_value

Specifies the value of the Max-Forwards header field. The allowed values are 0 to 255. The default value is 70.


Command Default

70

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The Max-Forwards header field of a SIP request specifies the maximum number of times the request can be forwarded to another server. Each time a request is received by a server, this value is decremented by one. (If the request does not have a Max-Forwards header, one is added.) When the value reaches zero, the server responds with a 483 (Too Many Hops) response and terminates the transaction.

You can use the Max-Forwards header field to detect forwarding loops within a network.


Note We recommend that you set this command to a value greater than or equal to 10, and less than or equal to 100.


Examples

The following example configures the value of the SIP Max-Forwards header field to 100:

se-10-0-0-0(cusp-config)> sip max-forwards 100

Related Commands

Command
Description

sip network

Creates a logical SIP network and enters SIP network configuration mode.


sip header-compaction

To enable SIP header compaction, use the sip header-compaction command in Cisco Unified SIP Proxy configuration mode. To disable SIP header compaction, use the no form of this command.

sip header-compaction

no sip header-compaction

Syntax Description

This command has no arguments or keywords.

Command Default

SIP header compaction is disabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When enabled, compact header forms are used for the following SIP headers:

Call-ID

Contact

Content-Encoding

Content-Length

Content-Type

From

Subject

To

Via

When header compaction is disabled, complete SIP headers are used in all outgoing messages, regardless of the header format.

Examples

The following example enables SIP header compaction:

se-10-0-0-0(cusp-config)> sip header-compaction

The following example disables SIP header compaction:

se-10-0-0-0(cusp-config)> no sip header-compaction

Related Commands

Command
Description

sip network

Creates a logical SIP network and enters SIP network configuration mode.


sip overload redirect

To configure the server to send a 300 (Redirect) response when the server is overloaded, use the sip overload redirect command in Cisco Unified SIP Proxy configuration mode. To disable the server from sending a redirect response when the server is overloaded, use the no from of this command.

sip overload redirect redirect_ip [port redirect_port] [transport {tcp | tls | udp}]

no sip overload redirect redirect_ip [port redirect_port] [transport {tcp | tls | udp}]

Syntax Description

redirect_ip

The redirect interface host name or IP address sent in the SIP Contact header field. Subsequent requests will be redirected to the server at this address.

port redirect_port

(Optional) The port of the redirect host. The valid range is from 1024 to 65535. The default is 5060.

transport

(Optional) The transport protocol used by the redirect host.

tcp

Uses TCP as the transport.

tls

Uses TLS as the transport.

udp

Uses UDP as the transport. UDP is the default value if a transport protocol is not chosen.


Command Default

The default port is 5060, and the default transport protocol is UDP.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command configures the behavior of the server when it is overloaded. There are two behavior modes: reject and redirect. Use the sip overload redirect command to configure redirect mode and the sip overload reject command to configure reject mode. Only one mode can be configured at a time.

If reject mode is configured, the proxy rejects messages and responds with a 503 (Server Unavailable) response when overloaded.

If redirect mode is cconfigured, the proxy redirects messages and responds with a 300 (Redirect) response when overloaded.

Examples

The following example configures the server to send a 300 (Redirect) response when the server is overloaded:

se-10-0-0-0(cusp-config)> sip overload redirect 192.168.20.5 transport udp

The following example disables the server from sending a 300 (Redirect) response when the server is overloaded:

se-10-0-0-0(cusp-config)> no sip overload redirect 192.168.20.5

Related Commands

Command
Description

sip overload reject

Configures the server to send a 503 (Server Unavailable) response when the server is overloaded.


sip overload reject

To configure the server to send a 503 (Server Unavailable) response when the server is overloaded, use the sip overload reject command in Cisco Unified SIP Proxy configuration mode. To disable the server from sending a reject response when the server is overloaded, use the no from of this command.

sip overload reject [retry-after retry_after_time]

no sip overload reject [retry-after retry_after_time]

Syntax Description

retry-after retry_after_time

(Optional) The number of seconds sent in the SIP Retry-After header field of the 503 (Server Unavailable) response, which indicates when the sender can attempt the transaction again. If not specified, the 503 (Server Unavailable) response does not contain a Retry-After header field. The minimum value allowed is 0. The default value is 0.


Command Default

The default value is 0.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command configures the behavior of the server when it is overloaded. There are two behavior modes: reject and redirect. Use the sip overload redirect command to configure redirect mode and the sip overload reject command to configure reject mode. Only one mode can be configured at a time.

If reject mode is configured, the proxy rejects messages and responds with a 503 (Server Unavailable) response when overloaded.

If redirect mode is cconfigured, the proxy redirects messages and responds with a 300 (Redirect) response when overloaded.

Examples

The following example configures the server to send a 503 (Server Unavailable) response when the server is overloaded:

se-10-0-0-0(cusp-config)> sip overload-reject

The following example configures the server to send a 503 (Server Unavailable) response when the server is overloaded and sets the retry-after-time to 60 seconds:

se-10-0-0-0(cusp-config)> sip overload-reject 60

The following example disables the server from sending a 503 (Server Unavailable) response when the server is overloaded:

se-10-0-0-0(cusp-config)> no sip overload-reject

Related Commands

Command
Description

sip overload redirect

Configures the server to send a 300 (Redirect) response when the server is overloaded.


sip tcp connection-timeout

To configure the time in minutes that the server keeps the SIP TCP connections open, use the sip tcp connection-timeout command in Cisco Unified SIP Proxy configuration mode. To reset the system to the default value, use the no form of this command.

sip tcp connection-timeout timeout_value

no sip tcp connection-timeout timeout_value

Syntax Description

timeout_value

Specifies the time, in minutes, before an idle TCP/TLS connection is gracefully closed. The accepted values start at 0. The default value is 240.


Command Default

240 minutes

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the SIP TCP connection timeout value to 120 minutes:

se-10-0-0-0(cusp-config)> sip tcp connection-timeout 120

Related Commands

Command
Description

sip tcp max-connections

Configures the maximum number of TCP/TLS connections.


sip tcp max-connections

To configure the maximum number of TCP/TLS connections, use the sip tcp max-connections command in Cisco Unified SIP Proxy configuration mode. To reset the system to the default value, use the no form of this command.

sip tcp max-connections value

no sip tcp max-connections value

Syntax Description

value

Maximum number of TCP/TLS connections allowed. The default is 256 and the minimum is 1.


Command Default

The maximum number of TCP/TLS connections allowed is 256.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When the maximum number of TCP/TLS connections is reached, passive (incoming) connections are not accepted, and additional active (outgoing) connections can be made.

Examples

The following example configures the maximum number of TCP/TLS connections to 512:

se-10-0-0-0(cusp-config)> sip tcp max-connections 512

Related Commands

Command
Description

sip tcp connection-timeout

Configures the time in minutes that the server keeps the SIP TCP connections open.


sip queue

To configure the properties of a SIP queue and enter SIP queue configuration mode, use the sip queue command in Cisco Unified SIP Proxy configuration mode. To set all the properties in the SIP queue configuration submode back to the default, use the no or default forms of this command.

sip queue {message | request | st-callback | ct-callbackresponse | timer | xcl | radius}

no sip queue {message | request | st-callback | ct-callbackresponse | timer | xcl | radius}

default sip queue {message | request | st-callback | ct-callbackresponse | timer | xcl | radius}

Syntax Description

message

Enters SIP queue configuration mode to configure the properties of the message queue. The message queue manages incoming SIP messages received from the transport layer.

request

Enters SIP queue configuration mode to configure the properties of the request queue. The request queue manages incoming SIP requests that cannot be immediately processed by the server.

st-callback

Enters SIP queue configuration mode to configure the properties of the st-callback queue. The st-callback queue manages ACK and CANCEL callbacks to server transactions.

ct-callbackresponse

Enters SIP queue configuration mode to configure the properties of the ct-callback queue. The ct-callbackresponse queue manages callbacks to client transmissions.

timer

Enters SIP queue configuration mode to configure the properties of the timer queue. The timer queue manages SIP timer events.

xcl

Enters SIP queue configuration mode to configure the properties of the XCL queue. The xcl queue manages XCL requests.

radius

Enters SIP queue configuration mode to configure the properties of the RADIUS queue. The radius queue manages RADIUS accounting requests.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The SIP queues are created by the proxy during runtime. The queue gets created by the proxy with the default values as the service gets activated. The command fails if the queue does not yet exist. To verify what SIP queues have been created, use the show status queue command.

Examples

The following example enters SIP queue configuration mode to configure the timer queue:

se-10-0-0-0(cusp-config)> sip queue timer
se-10-0-0-0(cusp-config-queue)> 

The following example enters SIP queue configuration mode to configure the st-callback queue:

se-10-0-0-0(cusp-config)> sip queue st-callback
se-10-0-0-0(cusp-config-queue)> 

The following example sets all the SIP RADIUS queue parameters back to their default values:

se-10-0-0-0(cusp-config)> no sip queue radius

Related Commands

Command
Description

drop-policy

Configures the drop policy for a SIP queue.

low-threshold

Configures the low-water-mark for a SIP queue.

show status queue

Displays the statistics for active SIP queues.

size

Configures the maximum number of messages that can be held by a specified queue.

thread-count

Configures the thread count for a specific SIP queue.


drop-policy

To configure the drop policy for a SIP queue, use the drop-policy command in Cisco Unified SIP Proxy SIP queue configuration mode. To remove the configured drop policy and return to the default value, use the no or default form of this command.

drop-policy {head | tail | none}

no drop-policy {head | tail | none}

default drop-policy {head | tail | none}

Syntax Description

head

Instructs the transport layer to drop the oldest events from the head of the queue when the maximum queue size is reached. This is the default value.

tail

Instructs the transport layer to drop the newest events from the tail of the queue when the maximum queue size is reached.

none

Instructs the transport layer to ignore the maximum queue size limit and store all events.


Command Default

The head drop policy is used.

Command Modes

Cisco Unified SIP Proxy SIP queue configuration (cusp-config-queue)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the drop policy in the SIP message queue to the head setting:

se-10-0-0-0(cusp-config)> sip queue message
se-10-0-0-0(cusp-config-queue)> drop-policy head

The following example configures the drop policy in the SIP st-callback queue to the tail setting:

se-10-0-0-0(cusp-config)> sip queue st-callback
se-10-0-0-0(cusp-config-queue)> drop-policy tail

The following example configures the drop policy in the radius queue to the unbounded setting:

se-10-0-0-0(cusp-config)> sip queue radius
se-10-0-0-0(cusp-config-queue)> drop-policy none

The following example returns the drop-policy for the RADIUS queue to the default value:

se-10-0-0-0(cusp-config)> sip queue radius
se-10-0-0-0(cusp-config-queue)> no drop-policy

Related Commands

Command
Description

low-threshold

Configures the low-water-mark for a SIP queue.

sip queue

Creates a SIP queue and enters SIP queue configuration mode.

size

Configures the maximum number of messages that can be held by a specified queue.

thread-count

Configures the thread count for a specific SIP queue.


low-threshold

To configure the low-water-mark for a SIP queue, use the low-threshold command in Cisco Unified SIP Proxy SIP queue configuration mode. To remove the low-water-mark value from the SIP queue and return to the default value, use the no or default form of this command.

low-threshold low-water-mark

no low-threshold

default low-threshold

Syntax Description

low-water-mark

Specifies the percentage of the maximum queue size. The valid range is from 1 to 100. The default is 80 percent.


Command Default

80 percent

Command Modes

Cisco Unified SIP Proxy SIP queue configuration (cusp-config-queue)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The low-water mark value specifies the capacity at which the server is no longer considered overloaded, and starts accepting new events.

Examples

The following example configures the low-water mark for the SIP message queue to 100 percent:

se-10-0-0-0(cusp-config)> sip queue message
se-10-0-0-0(cusp-config-queue)> low-threshold 100

The following example configures the low-water mark for the RADIUS queue to 50 percent:

se-10-0-0-0(cusp-config)> sip queue radius
se-10-0-0-0(cusp-config-queue)> low-threshold 50

The following example returns the low-water mark for the ct-callback queue to the default value:

se-10-0-0-0(cusp-config)> sip queue ct-callback
se-10-0-0-0(cusp-config-queue)> no low-threshold

Related Commands

Command
Description

drop-policy

Configures the drop policy for a SIP queue.

sip queue

Creates a SIP queue and enters SIP queue configuration mode.

size

Configures the maximum number of messages that can be held by a specified queue.

thread-count

Configures the thread count for a specific SIP queue.


size

To configure the maximum number of messages that can be held by a specified queue, use the size command in Cisco Unified SIP Proxy SIP queue configuration mode. To remove the configured SIP queue size and return to the default value, use the no or default form of this command.

size queue-size

no size queue-size

default size queue-size

Syntax Description

queue-size

The maximum number of messages that can be held by the specified queue. The valid range is from 10 to 50,000. The default is 2,000.


Command Default

2,000

Command Modes

Cisco Unified SIP Proxy SIP queue configuration (cusp-config-queue)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Caution Setting this parameter to a large value must be carefully evaluated because the memory consumed is directly proportional to this queue size.

Examples

The following example configures the message queue size to 10,000:

se-10-0-0-0(cusp-config)> sip queue message
se-10-0-0-0(cusp-config-queue)> size 10000

The following example configures the radius queue size to 5,000:

se-10-0-0-0(cusp-config)> sip queue radius
se-10-0-0-0(cusp-config-queue)> size 5000

The following example returns the radius queue size to the default value:

se-10-0-0-0(cusp-config)> sip queue radius
se-10-0-0-0(cusp-config-queue)> no size 5000

Related Commands

Command
Description

drop-policy

Configures the drop policy for a SIP queue.

low-threshold

Configures the low-water-mark for a SIP queue.

sip queue

Creates a SIP queue and enters SIP queue configuration mode.

thread-count

Configures the thread count for a specific SIP queue.


thread-count

To configure the maximum number of threads allocated to a specified SIP queue, use the thread-count command in Cisco Unified SIP Proxy SIP queue configuration mode. To remove the thread count value from the SIP queue and return to the default value, use the no or default form of this command.

thread-count thread_count

no thread-count thread_count

default thread-count thread_count

Syntax Description

thread_count

The maximum number of threads allocated to the specified queue. The minimum value allowed is 1. The default is 20.


Command Default

20 threads are allocated to the SIP queue.

Command Modes

Cisco Unified SIP Proxy SIP queue configuration (cusp-config-queue)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the thread count for the SIP message queue to 40:

se-10-0-0-0(cusp-config)> sip queue message
se-10-0-0-0(cusp-config-queue)> thread-count 40

The following example returns the message queue thread count to the default value:

se-10-0-0-0(cusp-config)> sip queue message
se-10-0-0-0(cusp-config-queue)> no thread-count 40

Related Commands

Command
Description

drop-policy

Configures the drop policy for a SIP queue.

low-threshold

Configures the low-water-mark for a SIP queue.

sip queue

Creates a SIP queue and enters SIP queue configuration mode.


sip dns-srv

To configure SIP DNS SRV lookup commands and enter SIP DNS SRV configuration mode, use the sip dns-srv command in Cisco Unified SIP Proxy configuration mode. To return all of the DNS SRV configuration submode parameters to the default values, use the no form of this command.

sip dns-srv

no sip dns-srv

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When there is no server-group configured for a given hostname, the system first attempts the DSN resolution using /etc/hosts. If this fails, then the system uses DNS lookup. Commands in the SIP DNS SRV configuration submode configure the DNS NAPTR/SRV lookup related information.

Examples

The following example enters SIP DNS SRV configuration mode:

se-10-0-0-0(cusp-config)> sip dns-srv
se-10-0-0-0(cusp-config-dns)> 

Related CommandsTBD

Command
Description

enable (SIP DNS server)

Enables the use of DNS server NAPTR or SRV query records for doman name/IP address mapping.

sip network

Creates a logical SIP network and enters SIP network configuration mode.

use-naptr

Enables the use of DNS NAPTR for domain name/IP address mapping.


enable (SIP DNS server)

To enable the use of DNS server NAPTR or SRV query records for doman name/IP address mapping, use the enable command in SIP DNS server configuration mode. To disable the use of DNS server NAPTR or SRV query records, use the no form of this command.

enable

no enable

Syntax Descriptionno sip 100-response

This command has no arguments or keywords.

Command Default

Using DNS server SRV query records is disabled.

Command Modes

SIP DNS server configuration (cusp-config-dns)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When this command is disabled, the use of DNS servers NAPTR/SRV records is disabled and only simple naming resolution is performed using the operating system's DNS configuration. DNS SRV (RFC 3263) is used for Cisco Unified SIP Proxy load balancing.

Examples

The following example enables the use of DNS server SRV query records:

se-10-0-0-0(cusp-config)> sip dns-srv
se-10-0-0-0(cusp-config-dns)> enable

The following example disables the use of DNS server SRV query records:

se-10-0-0-0(cusp-config)> sip dns-srv
se-10-0-0-0(cusp-config-dns)> no enable

Related Commands

Command
Description

sip dns-srv

Enters SIP DNS SRV configuration mode.

sip network

Creates a logical SIP network and enters SIP network configuration mode.

use-naptr

Enables the use of DNS NAPTR for domain name/IP address mapping.


use-naptr

To enable the use of DNS NAPTR for hostname/IP address mapping, use the use-naptr command in SIP DNS server configuration mode. To disable the use of DNS NAPTR for domain name/IP address mapping, use the no form of this command.

use-naptr

no use-naptr

Syntax Descriptionno sip 100-response

This command has no arguments or keywords.

Command Default

The use of DNS NAPTR for domain name/IP address mapping is disabled.

Command Modes

SIP DNS server configuration mode (cusp-config-dns)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example enables the use of DNS NAPTR for hostname/IP address mapping:

se-10-0-0-0(cusp-config)> sip dns-srv
se-10-0-0-0(cusp-config-dns)> use-naptr

The following example disables the use of DNS NAPTR for hostname/IP address mapping:

se-10-0-0-0(cusp-config)> sip dns-srv
se-10-0-0-0(cusp-config-dns)> no use-naptr

Related CommandsBD

Command
Description

enable (SIP DNS server)

Enables the use of DNS server NAPTR or SRV query records for doman name/IP address mapping.

sip dns-srv

Enters SIP DNS SRV configuration mode.

sip network

Creates a logical SIP network and enters SIP network configuration mode.


sip alias

To configure the hostname of this instance, use the sip alias command in Cisco Unified SIP Proxy configuration mode. To remove the hostname from the DNS server list, use the no form of this command.

sip alias {hostname}

no sip alias {hostname}

Syntax Description

hostname

Specifies the globally reachable host name of the system and adds it to the server's hostname list.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example adds cusp.example.com to the hostname list:

se-10-0-0-0(cusp-config)> sip alias cusp.example.com

The following example removes cusp.example.com from the server's hostname list:

se-10-0-0-0(cusp-config)> no sip alias cusp.example.com

Related CommandsTBD

Command
Description

sip network

Creates a logical SIP network and enters SIP network configuration mode.


sip logging

To enable the logging of all incoming and outgoing SIP messages, use the sip logging command in Cisco Unified SIP Proxy configuration mode. To disable the logging of incoming and outgoing SIP messages, use the no form of this command.

sip logging

no sip logging

Syntax Description

This command has no arguments or keywords.

Command Default

SIP logging is disabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Turning on SIP logging has a significant performance impact on Cisco Unified SIP Proxy.

Examples

The following example enables the logging of all incoming and outgoing SIP messages:

se-10-0-0-0(cusp-config)> sip logging

The following example disables the logging of all incoming and outgoing SIP messages:

se-10-0-0-0(cusp-config)> no sip logging

Related Commands

Command
Description

sip network

Creates a logical SIP network and enters SIP network configuration mode.

sip queue

Creates a SIP queue and enters SIP queue configuration mode.


sip peg-counting

To enable SIP transaction peg counting for all incoming and outgoing SIP messages, use the sip peg-counting command in Cisco Unified SIP Proxy configuration mode. To disable SIP transaction peg counting, use the no form of this command.

sip peg-counting interval

no sip peg-counting

Syntax Description

interval

Peg count collection interval in seconds.


Command Default

SIP peg counting is disabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Enabling SIP peg counting has a noticeable performance impact on Cisco Unified SIP Proxy, although not as much of an impact as enabling SIP logging.

Examples

The following example enables SIP transaction peg counting every 60 seconds:

se-10-0-0-0(cusp-config)> sip peg-counting 60

The following example disables SIP transaction peg counting:

se-10-0-0-0(cusp-config)> no sip peg-counting

Related Commands

Command
Description

sip logging

Enables the logging of all incoming and outgoing SIP messages.


sip privacy trusted-destination

To configure where to assert the privacy, which determines if the requested privacy service can be provided or not, use the sip privacy trusted-destination command in Cisco Unified SIP Proxy configuration mode. To remove the assert privacy configuration, use the no form of the command.

sip privacy trusted-destination sequence sequence_number [condition condition]

no sip privacy trusted-destination sequence sequence_number [condition condition]

Syntax Description

sequence sequence_number

Specifies the sequence number that denotes the order of conditions to be checked.

condition condition

(Optional) Specifies the trigger condition name (configured with the trigger condition command) to which the privacy assertion support applies. If the condition keyword is not specified, then the privacy assertion is unconditional.


Command Default

All peers are untrusted.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure the conditions for trusted-peers for "id" privacy service. Cisco Unified SIP Proxy removes P-Asserted-Identity headers from the request if the request is from a untrusted peer; and it removes P-Asserted-Identity from the request if the request it to be sent to a untrusted peer. Privacy service is provided for Diversion headers as well, following draft-levi-sip-diversion-08.txt

Examples

The following example configures the destination as a trusted peer if the in-network condition is met:

se-10-0-0-0(cusp-config)> sip privacy trusted-destination sequence 1 condition in-network

The following example configures all destinations as untrusted unconditionally:

se-10-0-0-0(cusp-config)> no sip privacy trusted-destination sequence 1

Related Commands

Command
Description

sip privacy trusted-source

Configures where to assert the privacy, which determines if the requested privacy service can be provided or not.


sip privacy trusted-source

To configure where to assert the privacy, which determines if the requested privacy service can be provided or not, use the sip privacy trusted-source command in Cisco Unified SIP Proxy configuration mode. To remove the assert privacy configuration, use the no form of this command.

sip privacy trusted-source sequence sequence_number [condition condition]

no sip privacy trusted-source sequence sequence_number [condition condition]

Syntax Description

sequence sequence_number

Specifies the sequence number that denotes the order of conditions to be checked.

condition condition

(Optional) Specifies the trigger condition name (configured with the trigger condition command) to which the privacy assertion support applies. If the condition keyword is not specified, then the privacy assertion is unconditional.


Command Default

All peers are untrusted.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure the conditions for trusted-peers for "id" privacy service. CUSP removes P-Asserted-Identity headers from the request if the request is from a untrusted peer; and it removes P-Asserted-Identity from the request if the request it to be sent to a untrusted peer. Privacy service is provided for Diversion headers as well, following draft-levi-sip-diversion-08.txt

Examples

The following example configures all sources as trusted unconditionally and assigns the value to sequence 1:

se-10-0-0-0(cusp-config)> sip privacy trusted-source sequence 1

The following example configures all sources as untrusted unconditionally:

se-10-0-0-0(cusp-config)> no sip privacy trusted-source sequence 1

Related Commands

Command
Description

sip privacy trusted-destination

Configures where to assert the privacy, which determines if the requested privacy service can be provided or not.

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


sip privacy service

To enable SIP privacy service, use the sip privacy service command in Cisco Unified SIP Proxy configuration mode. To disable SIP privacy service, use the no form of this command.

sip privacy service

no sip privacy service

Syntax Description

This command has no arguments or keywords.

Command Default

SIP privacy service is enabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Since the Cisco Unified SIP Proxy implements "id" privacy (RFC 3325) only, if privacy values contain any one of "session", "user" or "header", and it also contains "critical", Cisco Unified SIP Proxy returns 500 response following RFC 3323 if the SIP privacy service is enabled.

Examples

The following example enables SIP privacy service:

se-10-0-0-0(cusp-config)> sip privacy service 

sip tls

To enable the use of SIP Transport Layer Security (TLS) connections with other SIP entities, providing secure communication over the Internet, use the sip tls command in Cisco Unified SIP Proxy configuration mode. To disable the SIP TLS transport, use the no form of this command.

sip tls

no sip tls

Syntax Description

This command has no arguments or keywords.

Command Default

SIP TLS is not enabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command before configuring a SIP listener that uses the TLS transport.

Use this command to enable the use of SIP TLS connections with any other SIP entities, providing secure communications over the network. By default, TLS connections are accepted from all requesting clients with whom the Cisco Unified SIP Proxy has a trusted certificate. This is useful only when data encryption is desired and trust relationships are not required.

TLS encryption requires the two participating parties to specify a keystore and a corresponding trust certificate. When TLS is enabled, the system reads the key store files. As a result, before enabling the sip tls command, the keystore must first be created using the cypto key generate command.

Cisco Unified SIP Proxy supports both one-way and two-way TLS.


Note If there are active SIP listeners with the TLS transport enabled, then this command cannot be disabled.


Examples

The following example enables the use of SIP TLS connections:

se-10-0-0-0(cusp-config)> sip tls

The following example disables the use of SIP TLS connections:

se-10-0-0-0(cusp-config)> no sip tls

Related Commands

Command
Description

crypto key generate

Generates a certificate-private key pair.

sip network

Creates a logical SIP network and enters SIP network configuration mode.

sip tls trusted-peer

Configures a SIP TLS trusted peer.


sip tls trusted-peer

To configure a SIP TLS trusted peer, use the sip tls trusted-peer command in Cisco Unified SIP Proxy configuration mode. To remove the SIP TLS trusted peer, use the no form of this command.

sip tls trusted-peer {peer's-hostname}

no sip tls trusted-peer {peer's-hostname}

Syntax Description

peer's-hostname

Specifies the peer's hostname.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The establishment of TLS connections fails unless the identity of the remote side matches the identifier of a configured trusted peer. If there are no trusted peers configured, the connection is accepted as long as the TLS handshake succeeds.

Examples

The following example configures example.com as a TLS trusted peer:

se-10-0-0-0(cusp-config)> sip tls trusted-peer example.com

The following example removes example.com as a TLS trusted peer:

se-10-0-0-0(cusp-config)> no sip tls trusted-peer example.com

Related CommandsTBD

Command
Description

sip-tls

Enable the use of SIP Transport Layer Security (TLS) connections with other SIP entities.


route recursion

To enable SIP route recursion system-wide for the Cisco Unified SIP Proxy when a redirect response is issued, use the route recursion command in Cisco Unified SIP Proxy configuration mode. To disable SIP route recursion, use the no form of this command.

route recursion

no route recursion

Syntax Description

This command has no arguments or keywords.

Command Default

Route recursion is enabled by default.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When the Cisco Unified SIP Proxy receives a redirect response (that is, any 3xx response), it can be configured to recursively perform its routing logic on the received Contacts. A received Contact is placed into the Request URI of the prenormalized incoming request, and the server's routing and postnormalization logic is executed based on the new destination. If multiple Contacts are received, they are processed sequentially based on their configured q-values. If more than one contacts have the same q-value, they are processed sequentially in order of the appearance.

Examples

The following example enables route recursion on the Cisco Unified SIP Proxy:

se-10-0-0-0(cusp-config)> route recursion

The following example disables route recursion on the Cisco Unified SIP Proxy:

se-10-0-0-0(cusp-config)> no route recursion

Related CommandsTBD

Command
Description

route group

Creates a route group and enters route group configuration mode.

route table

Creates a route table and enters route table configuration mode.


server-group sip element-retries

To configure the number of retries for group elements in all SIP server groups, use the server-group sip element retries command in Cisco Unified SIP Proxy configuration mode. To restore the default value, use the no form of this command.

server-group sip element retries {tcp | tls | udp} number-of-retries

no server-group sip element retries {tcp | tls | udp}

Syntax Description

tcp

Specifies TCP as the transport protocol of the listener.

tls

Specifies TLS as the transport protocol of the listener.

udp

Specifies UDP as the transport protocol of the listener. This is the default value.

number-of-retries

Maximum number of consecutive failed attempts to send a request to a server group element via the specified protocol before the element is considered down. A failed attempt can occur because of a timeout, ICMP error, or receipt of a failure response (configured via the failover-response command). The valid range is from 0 to 65535. The default number of retries for the transport protocols is 1 for TCP, 1 for TLS, and 3 for UDP.


Command Default

UDP is the default transport, and the default number of retries for UDP is 3.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure the maximum number of failed attempts to send a request to a server group element via the specified protocol before the element is considered down. A failed attempt can occur because of a timeout or network error.

This command is a global value, and applies to all SIP server group elements.

Examples

The following example sets the retry value for UDP to 5:

se-10-0-0-0(cusp-config)> server-group sip element-retries udp 5

The following example sets the retry value for UDP to the default value:

se-10-0-0-0(cusp-config)> no server-group sip element-retries udp

Related Commands

Command
Description

server-group sip global-load-balance

Configures the load balance value for all SIP server groups.

server-group sip global-ping

Enables global pinging for all SIP server groups.

server-group sip ping-options

Configures the ping options for the SIP server group.

server-group sip retry-after

Configures the failover response timeout value for the SIP server group.


server-group sip global-load-balance

To configure the load balancing algorithm for all SIP server groups, use the server-group sip global-local-balance command in Cisco Unified SIP Proxy configuration mode. To return the load balancing algorithm to the default value for all global SIP server groups, use the no form of this command.

server-group sip global-load-balance { call-id | highest-q | request-uri | to-uri | weight }

no server-group sip global-load-balance

Syntax Description

call-id

Specifies that a hash algorithm with Call-ID is performed to select an element.

highest-q

Specifies that the first element in the list of available elements with the same highest q-value is selected.

request-uri

Specifies that a hash algorithm with a request URI is performed to select an element. This is the default value.

to-uri

Specifies that a hash algorithm with a To header URI is performed to select an element.

weight

Specifies that the element is selected proportional to its weight relative to the weights of other elements of the same q-value. This value is only applicable if implementing weight-based routing.


Command Default

The request URI load balancing algorithm is used.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When a message is forwarded to a server group, the available element with the highest q-value is selected to handle the request. If more than one available element shares the same highest q-value, the load balancing algorithm selected determines which of these elements is the next hop.

When multiple elements are assigned the same highest q-value, the first element must reach its maximum load capacity before the next element in the list is utilized. Because of this cascading load balancing behavior, we recommend that the highest-q algorithm only be used when all server group elements have a different q-values.

If you use one of the hash algorithms (request-uri, call-id, or to-uri), although the hash algorithm is deterministic, the load is distributed over these elements based on the value of the key. If the element selected by the hash algorithm is a reference to another server group, the selection procedure is also recursively applied to that server group.


Note Use this command to determine the load-balancing algorithm for all SIP server groups. After you configure this command, you can change the load-balancing algorithm for a specific SIP server group using the lb-type command in SIP server group configuration mode.


Examples

The following example configures the load balancing algorithm for all global SIP server groups to be based on call-id:

se-10-0-0-0(cusp-config)> server-group sip global-load-balance call-id

The following example configures the load balancing algorithm for all global SIP server groups to be based on request URI:

se-10-0-0-0(cusp-config)> server-group sip global-load-balance request-uri

The following example configures the load balancing algorithm for all global SIP server groups to the default value (request URI):

se-10-0-0-0(cusp-config)> no server-group sip global-load-balance

Related Commands

Command
Description

server-group sip element-retries

Configures the number of retries for a SIP server group element.

server-group sip global-ping

Enables global pinging for all SIP server groups.

server-group sip ping-options

Configures the ping options for the SIP server group.

server-group sip retry-after

Configures the failover response timeout value for the SIP server group.


server-group sip global-ping

To enable global pinging for all SIP server groups, use the server-group sip global-ping command in Cisco Unified SIP Proxy configuration mode. To disable global pinging for all SIP server groups, use the no form of this command.

server-group sip global-ping

no server-group sip global-ping

Syntax Description

This command has no arguments or keywords.

Command Default

Global pinging for all SIP server groups is disabled.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to enable and disable the monitoring of the server group element status globally through the ping mechanism. Configure the ping options using the server-group sip ping-options command.

Examples

The following example enables global pinging for a SIP server group:

se-10-0-0-0(cusp-config)> server-group sip global-ping

Related Commands

Command
Description

server-group sip element-retries

Configures the number of retries for a SIP server group element.

server-group sip global-load-balance

Configures the load balance value for all SIP server groups.

server-group sip ping-options

Configures the ping options for the SIP server group.

server-group sip retry-after

Configures the failover response timeout value for the SIP server group.


server-group sip group

To configure a SIP server group and enter SIP server group configuration mode, use the server-group sip group command in Cisco Unified SIP Proxy configuration mode. To remove the SIP server group, use the no form of this command.

server-group sip group server-group-name network

no server-group sip group server-group-name network

Syntax Description

server-group-name

Specifies the SIP server group name.

network

Specifies the previously configured network interface to use for the SIP server group.


Command Default

No SIP server group is configured.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

You must configure the network specified by the network argument before using this command.


Note This command requires that you use the commit command for the configuration changes to take effect. You must use the commit command after the server group elements have been configured before the server group can become active.


Examples

The following example creates SIP server group "sg1" that will use the network named "internal" and enters server-group SIP configuration mode:

se-10-0-0-0(cusp-config)> server-group sip group sg1 network internal
se-10-0-0-0(cusp-config-sg)> 

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element ip-address (SIP server group)

Creates an IP element for a SIP server group and determines its characteristics.

element reference

Creates a reference element for a SIP server group and determines its characteristics.

failover-resp-code

Configures a failover response code for a SIP server group.

lb-type

Configures the load balancing type for a single SIP server group.

ping (SIP server group)

Enables pinging for the server group.

server-group sip element-retries

Configures the number of retries for a SIP server group element.

server-group sip global-load-balance

Configures the load balance value for all SIP server groups.

server-group sip global-ping

Enables global pinging for all SIP server groups.

server-group sip ping-options

Configures the ping options for the SIP server group.

server-group sip retry-after

Configures the failover response timeout value for the SIP server group.

show status server-group sip

Displays the status of all SIP server groups or a single SIP server group.


element ip-address (SIP server group )

To create an IP element for a SIP server group and determine its characteristics, use the element ip-address command in SIP server group configuration mode. To remove the IP element from a SIP server group, use the no form of this command.

element ip-address ipaddress port {udp | tcp | tls} [q-value q-value] [weight weight]

no element ip-address ipaddress port {udp | tcp | tls} [q-value q-value] [weight weight]

Syntax Description

ipaddress

Specifies the interface host name or IP address of the server group element.

port

Specifies the port used by the server group element. Valid values are from 1024 to 65535. The default is 5060.

udp

Specifies UDP as the transport type of the server group element. This is the default value.

tcp

Specifies TCP as the transport type of the server group element.

tls

Specifies TLS as the transport type of the server group element.

q-value q-value

(Optional) Specifies a real number that specifies the priority of the server group element with respect to others in the server group. Valid values are from 0.0 to 1.0. The default q-value is 1.0.

weight weight

(Optional) Specifies the percentage assigned to the IP element in the server group if implementing weight-based routing. The valid range is from 0 to 100. The default weight is 0.


Command Default

The SIP server group is not configured.

Command Modes

SIP server group configuration (cusp-config-sg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates an element to the server group with a q-value of 1.0 and a weight of 0 (the default value):

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> element ip-address 10.1.2.3 5060 udp

The following example creates an element to the server group using TCP with a q-value of 0.5 and a weight of 0:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> element ip-address 10.1.2.3 5060 tcp q-value 0.5

The following example removes the element from the server group:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> no element ip-address 10.1.2.3 5060 tcp

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element reference

Creates a reference element for a SIP server group and determines its characteristics.

server-group sip group

Configures a SIP server group.


element reference

To create a reference element for a SIP server group and determine its characteristics, use the element reference command in SIP server group configuration mode. To remove the reference element from a SIP server group, use the no form of this command.

element reference reference [q-value q-value] [weight weight]

no element reference reference

Syntax Description

reference

Specifies the name of an existing server group.

q-value q-value

(Optional) A real number that specifies the priority of the server group element with respect to others in the server group. Valid values are from 0.0 to 1.0. The default q-value is 1.0.

weight weight

(Optional) The percentage assigned to the reference element if implementing weight-based routing. The valid range is from 0 to 100. The default weight is 0.


Command Default

The reference element is not configured.

Command Modes

SIP server group configuration (cusp-config-sg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example adds the server group element to the group with a q-value of 1.0 and a weight of 0 (the default):

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> element reference sg2

The following example adds the server group element to the group with a q-value of 0.5 and a weight of 0:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> element reference sg3 q-value 0.5

The following example removes the element from the server group:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> no element reference sg2

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element ip-address (SIP server group)

Creates an IP element for a SIP server group and determines its characteristics.

server-group sip group

Configures a SIP server group.


failover-resp-code

To configure a failover response code for a SIP server group, use the failover-resp-code command in SIP server group configuration mode. To remove the failover response code, use the no form of this command.

failover-resp-code response-codes [- response-codes] [, response-codes]

no failover-resp-code

Syntax Description

response-codes

The response code(s) that indicates the next-hop server is unable to process the request. The valid values are numbers between 500 and 599.


Command Default

There is no response code which will trigger failover.

Command Modes

SIP server group configuration (cusp-config-sg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

To configure multiple failover response codes, separate the individual codes by a comma and indicate ranges with a dash. Commas and dashes must be followed by a space.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the failover response code so that any of the response codes 503, 505, 506, 507, 580 trigger failover to the next server group element:

se-10-0-0-0(cusp-config)> sip server-group sg1
se-10-0-0-0(cusp-config-sg)> failover-resp-code 503 , 505 - 507 , 580

The following example configures the failover response code so that only 500 and 503 responses trigger failover to the next server group element:

se-10-0-0-0(cusp-config)> sip server-group sg1
se-10-0-0-0(cusp-config-sg)> failover-resp-code 500, 503

The following example configures the failover response code so that no response codes trigger failover to the next server group element:

se-10-0-0-0(cusp-config)> sip server-group sg1
se-10-0-0-0(cusp-config-sg)> no failover-resp-code

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element ip-address (SIP server group)

Creates an IP element for a SIP server group and determines its characteristics.

element reference

Creates a reference element for a SIP server group and determines its characteristics.

lb-type

Configures the load balancing type for a single SIP server group.

ping (SIP server group)

Enables pinging for the server group.

server-group sip group

Configures a SIP server group.


lb-type

To configure the load balancing algorithm for the SIP server group, use the lb-type command in SIP server group configuration mode. To remove the load balancing algorithm from the SIP server group and restore the default value, use the no form of this command.

lb-type {global | highest-q | request-uri | call-id | to-uri | weight }

no lb-type {global | highest-q | request-uri | call-id | to-uri | weight }

Syntax Description

global

Applies the load balancing type set for all SIP server groups using the server-group sip global-load-balance command. This is the default value.

highest-q

Specifies that the first element in the list of available elements with the same highest q-value is selected.

request-uri

Specifies that the load balancing algorithm is based on the Request-URI header of the outgoing request.

call-id

Specifies that the load balancing algorithm is based on the Call-ID of the outgoing request.

to-uri

Specifies that the load balancing algorithm is based on the To-URI header of the outgoing request.

weight

Specifies that the element will be selected proportional to its weight relative to the weights of other elements of the same q-value. This value is only applicable if implementing weight-based routing.


Command Default

The global keyword is the default.

Command Modes

SIP server group configuration (cusp-config-sg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

When multiple elements are assigned the same highest q-value, the first element must reach its maximum load capacity before the next element in the list is utilized. Because of this cascading load balancing behavior, we recommend that the highest-q algorithm only be used when all server group elements have different q-values.

This command applies a load balance type to a single SIP server group only. To apply a load balance type to all SIP server groups, use the server-group sip global-load-balance command.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the load balancing type for a SIP server group to global:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> lb-type global

The following example configures the load balancing algorithm for a SIP server group to request URI:

se-10-0-0-0(cusp-config)> server-group sip sg2
se-10-0-0-0(cusp-config-sg)> lb-type request-uri

The following example configures the load balancing type for a SIP server group to weight-based routing:

se-10-0-0-0(cusp-config)> server-group sip sg3
se-10-0-0-0(cusp-config-sg)> lb-type weight

The following example restores the load balancing type to the default value (global):

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> no lb-type weight

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element ip-address (SIP server group)

Creates an IP element for a SIP server group and determines its characteristics.

element reference

Creates a reference element for a SIP server group and determines its characteristics.

failover-resp-code

Configures a failover response code for a SIP server group.

ping (SIP server group)

Enables pinging for the server group.

server-group sip group

Configures a SIP server group.

server-group sip global-load-balance

Configures the load balance value for all SIP server groups.


ping (SIP server group)

To enable pinging for the server group, use the ping command in SIP server group configuration mode. To disable pinging for the server group, use the no form of this command.

ping

no ping

Syntax Description

This command has no arguments or keywords.

Command Default

Pinging is enabled for the server group.

Command Modes

SIP server group configuration (cusp-config-sg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Even when pinging is enabled for a specific server group, the pinging will not start until the server-group sip global-ping command is enabled.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example enables pinging on a server group:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> ping

The following example disables pinging on a server group:

se-10-0-0-0(cusp-config)> server-group sip sg1
se-10-0-0-0(cusp-config-sg)> no ping

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element ip-address (SIP server group)

Creates an IP element for a SIP server group and determines its characteristics.

failover-resp-code

Configures a failover response code for a SIP server group.

lb-type

Configures the load balancing type for a single SIP server group.

server-group sip group

Configures a SIP server group.


server-group sip retry-after

To configure the failover response timeout value for all SIP server groups, use the server-group sip retry-after command in Cisco Unified SIP Proxy configuration mode. To return the failover response timeout value for all SIP server groups to the default value, use the no form of this command.

server-group sip retry-after retry-after-time

no server-group sip retry-after

Syntax Description

retry-after-time

Specifies the number of milliseconds from the time a failover response is received to the time the overloaded server group element can be used again when the response does not contain a Retry-After header field. If the response contains a Retry-After header field, the header field value is used. The minimum value is 0. The default is 0.


Command Default

The default is 0, meaning that a retry takes place without a timeout.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the retry timeout value for all SIP server groups to 6,000 milliseconds:

se-10-0-0-0(cusp-config)> server-group sip retry-after 6000

The following example returns the retry timeout value to 0 (the default):

se-10-0-0-0(cusp-config)> no server-group sip retry-after

Related Commands

Command
Description

server-group sip element-retries

Configures the number of retries for a SIP server group element.

server-group sip global-load-balance

Configures the load balance value for all SIP server groups.

server-group sip global-ping

Enables global pinging for all SIP server groups.

server-group sip ping-options

Configures the ping options for the SIP server group.


server-group sip ping-options

To configure the ping options for the SIP server group and enter SIP server group ping-options configuration mode, use the server-group sip ping-options command in Cisco Unified SIP Proxy configuration mode. To restore the ping options for the commands in the submode to the default values, use the no or default form of this command.

server-group sip ping-options network ip-address port

no server-group sip ping-options network

default server-group sip ping-options network

Syntax Description

network

Specifies the name of the network interface for this ping option.

ip-address

Specifies the interface host name or IP address that listens for responses to the SIP pings.

Note When a hostname is specified, the server performs a DNS lookup to confirm that the host can be resolved. It then uses the IP address when the configuration is saved. If a hostname cannot be resolved, an "IP Address validation failed" error is displayed.

port

The UDP port that listens for responses to the SIP pings. The valid range is from from 1024 to 65535. The default value is 4000.


Caution Be sure this port number is different from the port number specified for the server's listener.

Command Default

The ping options are not configured for a SIP network.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command is only relevant for server group elements with a transport type of UDP. Ping options must first exist before you can use the no command.

Examples

The following example configures ping options for the SIP server group named "internal" with IP address 10.2.3.4:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4 4000

The following example sets all the ping options for the SIP server group named "internal" to the default values:

se-10-0-0-0(cusp-config)> no server-group sip ping-options internal

Related Commands

Command
Description

server-group sip element-retries

Configures the number of retries for a SIP server group element.

server-group sip global-load-balance

Configures the load balance value for all SIP server groups.

server-group sip global-ping

Enables global pinging for all SIP server groups.

server-group sip retry-after

Configures the failover response timeout value for the SIP server group.


method (SIP server group ping-options)

To configure the request method for the SIP server group pings, use the method command in SIP server group ping-options configuration mode. To remove the request method for the SIP server group pings, use the no or default form of this command.

method ping-request-method

no method

default method

Syntax Description

ping-request-method-
name

The request method for the SIP pings. The default value is OPTIONS.


Command Default

The default ping request method name is OPTIONS.

Command Modes

SIP server group ping-options configuration (cusp-config-ping)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command only applies the ping option method for a single SIP server group. To apply global ping options for all SIP server groups, use the server-group sip global-ping-options command.

Examples

The following example configures the SIP server group ping option method to OPTIONS (the default):

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> method OPTIONS

The following example configures the SIP server group ping option method to PING:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> method PING

The following example restores the SIP server group ping option method to the default value:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> no method

Related Commands

Command
Description

ping-type

Configures the ping type and interval for a SIP server group.

server-group sip ping-options

Configures the ping options for the SIP server group.

timeout

Configures the ping timeout interval for a SIP server group.


ping-type

To configure the ping type and interval for a SIP server group, use the ping-type command in SIP server group ping-options configuration mode. To restore the default values, use the no or default forms of this command.

ping-type {proactive | reactive | adaptive} ping-interval [adaptive-ping-interval-for-up-element]

no ping-type

default ping-type

Syntax Description

proactive

Specifies that pinging is performed to both up and down elements, and both are pinged at the same interval.

reactive

Specifies that pinging is performed to only down elements. This is the default value.

adaptive

Specifies that pinging is performed to both up and down elements, and both are pinged at different intervals.

ping-interval

Specifies the consecutive ping interval in milliseconds. For adaptive pinging, this value configures the down element ping interval. The default value is 1,000 milliseconds.

adaptive-ping-interval-
for-up-element

(Required for adaptive pinging only) Specifies the consecutive ping interval for up elements.


Command Default

Reactive pinging is performed at intervals of 5,000 milliseconds.

Command Modes

SIP server group ping-options configuration (cusp-config-ping)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

To prevent pings from being sent out in bursts, elements are not pinged simultaneously; they are pinged at a specified interval. For example, suppose the ping interval is set to 50 milliseconds and there are three elements configured for a server group. A ping is sent to the first element. After 50 milliseconds, a ping is sent to the second element. Finally, after an additional 50 milliseconds, a ping is sent to the third element.

Examples

The following example configures reactive pinging for the server group with a ping interval of 1,000 milliseconds:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> ping-type reactive 1000

The following example configures proactive pinging for the server group with a ping interval of 2,000 milliseconds:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> ping-type proactive 2000

The following example configures adaptive pinging for the server group with a ping interval of 1,000 milliseconds for down elements and 2,000 milliseconds for up elements:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> ping-type adaptive 1000 2000

The following example restores the default ping type values to the server group (reactive with an interval of 1,000 milliseconds:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> no ping-type

Related Commands

Command
Description

element ip-address (SIP server group)

Creates an IP element for a SIP server group and determines its characteristics.

failover-resp-code

Configures a failover response code for a SIP server group.

lb-type

Configures the load balancing type for a single SIP server group.

ping (SIP server group)

Enables pinging for the server group.

server-group sip group

Configures a SIP server group.


timeout

To configure the ping timeout interval for a SIP server group, use the timeout command in Cisco Unified SIP Proxy SIP server group ping-options configuration mode. To remove the ping timeout interval from the SIP server group and return to the default value, use the no or default form of this command.

timeout ping-timeout

no timeout

default timeout

Syntax Description

ping-timeout

Specifies the maximum number of milliseconds between a ping and a response before the ping is considered unsuccessful. The minimum allowed value is 0. The default value is 500.


Command Default

500 milliseconds

Command Modes

Cisco Unified SIP Proxy SIP server group ping-options configuration (cusp-config-ping)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the ping timeout interval for a SIP server group to 500 milliseconds:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> timeout 500

The following example configures the ping timeout interval for a SIP server group to 1000 milliseconds:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> timeout 1000

The following example restores the ping timeout interval for a SIP server to the default value:

se-10-0-0-0(cusp-config)> server-group sip ping-options internal 10.2.3.4
se-10-0-0-0(cusp-config-ping)> no timeout

Related Commands

Command
Description

method (SIP server group ping-options)

Configures the request method for the SIP server group pings.

ping-type

Configures the ping type and interval for a SIP server group.

server-group sip ping-options

Configures the ping options for the SIP server group.


show status server-group sip

To display the status of all SIP server groups or a single SIP server group, use the show status server-group sip command in Cisco Unified SIP Proxy EXEC mode.

show status server-group sip [server-group-name]

Syntax Description

server-group-name

(Optional) Displays the status of a single SIP server group.


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 server-group sip command:

se-10.0.0.0(cusp)> show status server-group sip

Server-group: sg2.example.com
Address                Transport  Q-Value  Weight  Status
192.168.20.6:5061      udp        0.7      0       up
192.168.20.6:5062      udp        0.5      0       up

Server-group: sg1.example.com
Address                Transport  Q-Value  Weight  Status
192.168.1.47:5060      udp        0.5      0       up
192.168.20.6:31000     udp        1.0      0       up

Table 5 describes the significant fields shown in the display.

Table 5 show status server-group sip Field Descriptions 

Field
Description

Server-group

Displays a SIP server group.


Related Commands

Command
Description

show status serverg-roup radius

Displays the status of all RADIUS server groups or a single RADIUS server group.


server-group radius group

To configure a RADIUS server group and enter RADIUS server group configuration mode, use the server-group radius group command in Cisco Unified SIP Proxy configuration mode. To remove the RADIUS server group, use the no form of this command.

server-group radius group radius_server local-ipaddress

no server-group radius group radius_server local-ipaddress

Syntax Description

radius_server

Specifies one RADIUS server group name.

local-ipaddress

Specifies the local source IP address to use when the proxy server sends RADIUS messages to the RADIUS server. The local IP address cannot be modified after the group is configured.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command creates a RADIUS server group. The server can load balance accounting messages over the configured RADIUS servers. All accounting messages with the same Acct-Session-ID will go to the same RADIUS server.


Note You can configure only one RADIUS server group in Cisco Unified SIP Proxy 1.0.


Examples

The following example creates a RADIUS server group:

se-10-0-0-0(cusp-config)> server-group radius group radius_server 192.168.20.42
se-10-0-0-0(cusp-config-radius)> 

The following example removes a RADIUS server group and removes all server-group elements in it:

se-10-0-0-0(cusp-config)> no server-group radius group radius_server 192.168.20.42

Related Commands

Command
Description

element ip-address (RADIUS server group)

Creates an IP element for a RADIUS server group and determines its characteristics.

retransmit-timeout (RADIUS server group)

Configures the retransmit timeout value for the RADIUS server group.

show status server-group radius

Displays the status of all RADIUS server groups or a single RADIUS server group.


element ip-address (RADIUS server group)

To create an IP element for a RADIUS server group and determine its characteristics, use the element ip-address command in RADIUS server group configuration mode. To remove the IP element from the RADIUS server group, use the no form of this command.

element ip-address ip-address port shared-secret [q-value q-value]

no element ip-address ip-address port

Syntax Description

ip-address

Specifies the interface host name or IP address of the server group element.

port

Specifies the port used by the server group element. Valid values are from 1024 to 65535. The default port is 1813 for accounting and 1812 for authentication/authorization.

shared secret

Specifies the shared secret key between the proxy and the RADIUS server group element.

q-value q-value

(Optional) Specifies a real number that specifies the priority of the server group element relative to others in the server group. Valid values are from 0.0 to 1.0. The default is 1.0.


Command Default

The element for the RADIUS server group is not configured.

Command Modes

RADIUS server group configuration (cusp-config-radius)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example creates an IP element for a RADIUS server group:

se-10-0-0-0(cusp-config)> server-group radius group acct-group
se-10-0-0-0(cusp-config-radius)> element ip-address 10.1.2.3 1813 cusp-secret

The following example removes an IP element from a RADIUS server group:

se-10-0-0-0(cusp-config)> server-group radius group acct-group
se-10-0-0-0(cusp-config-radius)> no element ip-address 10.1.2.3 1813

Related Commands

Command
Description

retransmit-count (RADIUS server group)

Configures the retransmit count value for the RADIUS server group.

retransmit-timeout (RADIUS server group)

Configures the retransmit timeout value for the RADIUS server group.

server-group radius group

Configures a RADIUS server group and enters server group RADIUS configuration mode.


retransmit-count (RADIUS server goup)

To configure the retransmit count value for a RADIUS server group, use the retransmit-count command in Cisco Unified SIP Proxy RADIUS server group configuration mode. To restore the default value, use the no form of this command.

retransmit-count count

no retransmit-count

Syntax Description

count

Specifies the allowable number of retries of a RADIUS request to a RADIUS server. If no successful response is obtained from the RADIUS server after the maximum number of retries, the RADIUS server is marked as being out-of-service. The default value is 3.


Command Default

3 retries

Command Modes

Cisco Unified SIP Proxy RADIUS server group configuration (cusp-config-radius)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the retransmit-count value to 5:

se-10-0-0-0(cusp-config)> server-group radius group acct-group 192.168.20.42
se-10-0-0-0(cusp-config-radius)> retransmit-count 5

The following example restores the default retransmit-count value:

se-10-0-0-0(cusp-config)> server-group radius group acct-group 192.168.20.42
se-10-0-0-0(cusp-config-radius)> no retransmit-count

Related Commands

Command
Description

element ip-address (RADIUS server group)

Creates an IP element for a RADIUS server group and determines its characteristics.

retransmit-timeout(RADIUS server group)

Configures the retransmit timeout value for a RADIUS server group.

server-group radius group

Configures a RADIUS server group and enters server group RADIUS configuration mode.


retransmit-timeout (RADIUS server group)

To configure the retransmit timeout value for a RADIUS server group, use the retransmit-time command in Cisco Unified SIP Proxy RADIUS server group configuration mode. To restore the default retransmit timeout value, use the no or default form of this command.

retransmit-timeout timeout

no retransmit-timeout

Syntax Description

timeout

Specifies the maximum number of milliseconds allowed to wait for a response from a RADIUS server. If no response is received, the server will retry the request up to the retransmit-count value before it determines that the server is not available. The default value is 500.


Command Default

500 milliseconds

Command Modes

Cisco Unified SIP Proxy RADIUS server group configuration (cusp-config-radius)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the retransmit-timeout value to 1000:

se-10-0-0-0(cusp-config)> server-group radius group acct-group 192.168.20.42
se-10-0-0-0(cusp-config-radius)> retransmit-timeout 1000

The following example restores the default retransmit-timeout value:

se-10-0-0-0(cusp-config)> server-group radius group acct-group 192.168.20.42
se-10-0-0-0(cusp-config-radius)> no retransmit-timeout

Related Commands

Command
Description

element ip-address (RADIUS server group)

Creates an IP element for a RADIUS server group and determines its characteristics.

retransmit-count (RADIUS server group)

Configures the retransmit count value for a RADIUS server group.

server-group radius group

Configures a RADIUS server group and enters server group RADIUS configuration mode.


show status server-group radius

To display the status of all RADIUS server groups or a single RADIUS server group, use the show status server-group radius command in Cisco Unified SIP Proxy EXEC mode.

show status server-group radius [server-group-name]

Syntax Description

server-group-name

(Optional) Displays the status of a single RADIUS server group.


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 server-group radius command:

se-10.0.0.0(cusp)> show status server-group radius

Servergroup: radius_server
Address                Secret           Q-Value  Status
192.168.20.6:1813      cusp-secret      1.0      up
192.168.20.7:1813      cusp-secret      1.0      up

Table 6 describes the significant fields shown in the display.

Table 6 show status server-group radius Field Descriptions 

Field
Description

Servergroup

Displays the name of the RADIUS server group.

element

Displays element(s) that belong to the RADIUS server group.


Related Commands

Command
Description

show status server-group sip

Displays the status of all SIP server groups or a single SIP server group.


trigger condition

To create a trigger condition and enter Cisco Unified SIP Proxy trigger configuration mode, use the trigger condition command in Cisco Unified SIP Proxy configuration mode. To remove the trigger condition, use the no form of this command.

trigger condition trigger-condition-name

no trigger condition trigger-condition-name

Syntax Description

trigger-condition-name

Specifies the name of the trigger condition.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command configures a trigger condition. The trigger condition associates the trigger with the specific conditions that includes matching rules against certain headers or fields within a SIP message.

A trigger is a named condition that is evaluated as either true or false for each received request. If the condition is true, then preset behaviors are invoked.

To execute a module, the server:

1. Identifies appropriate triggers.

2. Orders the triggers by their sequence numbers.

3. Evaluates the named trigger condition for the request. If true, the next step is executed; otherwise, the next trigger is checked.

4. Determines the details of module execution from the parameters of the module trigger that corresponds to the matched trigger condition.

The trigger condition command provides a name for a trigger point, specifies a true-false test for the condition, and indicates its place in the set of triggers to evaluate. The types of conditions that can be evaluated as trigger points are:

Whether a message is a request or response

The type of request method

The response code (either an explicit code or a class of codes)

User agent header field value

Matching portions of a Request-URI

Matching portions of a Route header field

Matching IP addresses and ports

Configure these trigger points using the commands in trigger configuration mode.

The trigger condition command takes as input regular expressions for conditions that must be matched in order for the trigger to be fired. For more information on regular expressions, see http://java.sun.com/docs/books/tutorial/extra/regex/.


Note All trigger conditions support regular expressions except the MESSAGE field, which can either be "response" or "request" only.


Examples

The following example creates a new trigger condition t1 and enters trigger configuration mode, where the specific condition is configured:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> 

The following example deletes trigger condition t1:

se-10-0-0-0(cusp-config)> no trigger condition t1

Related Commands

Command
Description

header

Configures the trigger to fire when matching the regular expression for this header.

in-network

Configures the incoming network for a trigger condition for a server-side transaction.

local-ip

Assigns a local-listen IP address that accepts incoming requests to a trigger condition.

local-port

Assigns a local-listen port to a trigger condition.

message

Determines whether the trigger condition will fire based on whether the headers in the SIP message are request or response headers.

method (trigger sequence)

Configures a trigger condition in which the trigger is fired on the given SIP method name in the request.

mid-dialog

Configures the trigger to fire on mid-dialog responses.

out-network

Configures the outgoing network for a trigger condition for a client-side transaction.

protocol

Assigns a protocol to the trigger condition.

proxy-route header-param

Configures a trigger to fire when matching the regular expression for the specified header parameter.

proxy-route uri-component

Configures a trigger to fire when matching the regular expression for the specified URI component.

proxy-route uri-param

Configures a trigger to fire when matching the regular expression for the specified URI parameter.

remote-ip

Configures the remote IP network for a trigger condition.

remote-port

Configures the remote port for a trigger condition.

request-uri uri-param

Configures a trigger to fire when matching the regular expression for the specified URI parameter.

response-code

Configures a trigger condition to fire on a specific response.

time

Configures the trigger to fire if the specified time policy is met.


trigger post-normalization

To configure a postnormalization algorithm for outgoing SIP messages to a specific normalization policy, use the trigger post-normalization command in Cisco Unified SIP Proxy configuration mode. To remove the postnormalization policy algorithm from the normalization policy, use the no form of this command.

trigger post-normalization sequence sequence-number {by-pass | policy policy} [condition trigger-condition]

no trigger post-normalization sequence sequence-number policy policy [condition trigger-condition]

Syntax Description

sequence sequence-number

Specifies the sequence number.

by-pass

Specifies that routing is done directly using RFC 3263.

policy policy

Specifies the previously-defined policy name that the post-normalization algorithm will apply to. If by-pass is chosen, routing is done directly using RFC 3263.

condition trigger-condition

(Optional) Specifies the previously-defined trigger condition that the post-normalization algorithm will apply to.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to determine which normalization policies are invoked after routing policies are applied. Use the trigger pre-normalization command to determine which normalization policies are invoked before routing policies are applied.

Examples

The following example calls for policy p1 to be invoked unconditionally:

se-10-0-0-0(cusp-config)> trigger post-normalization sequence 10 policy p1

The following example calls for the by-pass policy to be invoked unconditionally:

se-10-0-0-0(cusp-config)> trigger post-normalization sequence 10 by-pass

The following example deletes the call to policy p1 for post-normalization:

se-10-0-0-0(cusp-config)> no trigger post-normalization sequence 10 policy p1

Related Commands

Command
Description

trigger pre-normalization

Configures a prenormalization algorithm for incoming SIP messages to a normalization policy.


trigger pre-normalization

To configure a prenormalization algorithm for incoming SIP messages to a normalization policy, use the trigger pre-normalization command in Cisco Unified SIP Proxy configuration mode. To remove the prenormalization policy algorithm from the normalization policy, use the no form of this command.

trigger pre-normalization sequence sequence-number {by-pass | policy policy} [condition trigger-condition]

no trigger pre-normalization sequence sequence-number {by-pass | policy policy} [condition trigger-condition]

Syntax Description

sequence sequence-number

Specifies the sequence number.

by-pass

Specifies that routing is done directly using RFC 3263.

policy policy

Specifies the previously-defined policy name that the pre-normalization algorithm will apply to. If by-pass is chosen, routing is done directly using RFC 3263.

condition trigger-condition

(Optional) Specifies the previously-defined trigger condition that the pre-normalization algorithm will apply to.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to determine which normalization policies are invoked before routing policies are applied. Use the trigger post-normalization command to determine which normalization policies are invoked after routing policies are applied.

Examples

The following example calls for policy p1 to be invoked unconditionally:

se-10-0-0-0(cusp-config)> trigger pre-normalization sequence 10 policy p1

The following example calls for the by-pass policy to be invoked unconditionally:

se-10-0-0-0(cusp-config)> trigger pre-normalization sequence 10 by-pass

The following example deletes the call to policy p1 for prenormalization:

se-10-0-0-0(cusp-config)> no trigger pre-normalization sequence 10 policy p1

Related Commands

Command
Description

trigger post-normalization

Configures a postnormalization algorithm for outgoing SIP messages to a specific normalization policy.


trigger routing

To associate a routing policy with a trigger condition, use the trigger routing command in Cisco Unified SIP Proxy configuration mode. To delete the association between the routing policy and the condition, use the no form of this command.

trigger routing sequence sequence-number {by-pass | policy policy} [condition trigger-condition]

no trigger routing sequence sequence-number {by-pass | policy policy} [condition trigger-condition]

Syntax Description

sequence sequence-number

Specifies the sequence number.

by-pass

Specifies that routing is done directly using RFC 3263.

policy policy

Specifies the previously-defined policy name to which the routing algorithm applies. If by-pass is chosen, routing is done directly using RFC 3263.

condition trigger-condition

(Optional) Specifies the previously-defined trigger condition to which the routing policy applies.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Routing triggers determine which of the configured routing policies is invoked for a received request. When a characteristic of the request matches the specified condition, the specified routing policy is invoked to determine the request's next hop.

Examples

The following example associates policy p1 with condition t1:

se-10-0-0-0(cusp-config)> trigger routing sequence 10 policy p1 condition t1

The following example associates the by-pass policy for condition mid-dialog :

se-10-0-0-0(cusp-config)> trigger routing sequence 10 by-pass condition mid-dialog

The following example deletes the association of the policy with the condition:

se-10-0-0-0(cusp-config)> no trigger routing sequence 10 sequence 10 policy p1

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


sequence (trigger)

To configure a sequence number for an existing trigger condition and enter trigger sequence configuration mode, use the sequence command in trigger configuration mode. To remove the sequence number from the trigger condition, use the no form of this command.

sequence sequence

no sequence sequence

Syntax Description

sequence

Integer that indicates the order in which triggers are evaluated.


Command Default

None

Command Modes

Trigger configuration (cusp-config-trigger)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

All trigger sequence configuration mode commands configure and conditions, that is, all conditions must be matched for a given trigger to fire. A list of trigger sequences is evaluated as a list of or conditions, so once one is matched those with later sequence numbers are ignored.

Examples

The following example assigns sequence number 1 to existing trigger condition t1:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> 

The following example removes sequence number 1 from existing trigger condition t1:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> no sequence 1

Related CommandsTBD

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


header (trigger sequence)

To configure the trigger to fire when matching the regular expression for this header, use the header command in trigger sequence configuration mode. To , use the no form of this command.

header header-name {first | last | all} header-value

no header header-name {first | last | all} header-value

Syntax Description

header-name

Specifies the name of the header.

first

Specifies to trigger on the first occurrence of this header.

last

Specifies to trigger on the last occurrence of this header.

all

Specifies to trigger on the all occurrences of this header.

header-value

Specifies the value of the header to trigger on.


Command Default

No trigger conditions are configured for this header.

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures this trigger to fire on the first occurrence of the header user@example.com:

se-10-0-0-0(cusp-config-trigger-seq)> header From first user@example.com 

The following example removes the trigger condition using mid-dialog:

se-10-0-0-0(cusp-config-trigger-seq)> no header

in-network

To configure the incoming network for a trigger condition for a server-side transaction, use the in-network command in trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

in-network network-name

no in-network

Syntax Description

network-name

Specifies the incoming network name for the trigger condition.


Command Default

The network name is not configured.

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Enter the value for this command as a regular expression.

Examples

The following example configures the in-network field for the network called "internal" for the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 22
se-10-0-0-0(cusp-config-trigger-seq)> in-network internal

The following example removes the in-network field from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 22
se-10-0-0-0(cusp-config-trigger-seq)> no in-network

Related Commands

Command
Description

out-network

Configures the outgoing network for a trigger condition for a client-side transaction.

sequence sequence-number

Specifies the sequence number.

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


local-ip

To configure a trigger condition in which the trigger is fired on the given local IP address, use the local-ip command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the local-ip address from the trigger condition, use the no form of this command.

local-ip local-listen-ip

no local-ip

Syntax Description

local-listen-ip

The interface IP address or hostname accepting incoming requests.


Command Default

The local IP address or hostname is not configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Enter the value for this commandas a regular expression.

Examples

The following example configures the local-listen IP address for the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 18
se-10-0-0-0(cusp-config-trigger-seq)> local-ip 10.1.1.1

The following example removes the local-listen IP address from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 18
se-10-0-0-0(cusp-config-trigger-seq)> no local-ip

Related Commands

Command
Description

local-port

Assigns a local-listen port to a trigger condition.

remote-ip

Configures the remote IP network for a trigger condition.

remote-port

Configures the remote port for a trigger condition.

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


local-port

To configure a trigger condition in which the trigger is fired on the given local-listen port, use the local-port command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the local-listen port from the trigger condition, use the no form of this command.

local-port local-listen-port

no local-port

Syntax Description

local-listen-port

Specifies the local-listen port number.


Command Default

The local-listen port is not assigned to the trigger condition.

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Enter the value of this command as a regular expression.

Examples

The following example configures the local-listen port for the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 19
se-10-0-0-0(cusp-config-trigger-seq)> local-port 5060

The following example removes the local-listen port from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 19
se-10-0-0-0(cusp-config-trigger-seq)> no local-port

Related Commands

Command
Description

local-ip

Assigns a local-listen IP address that accepts incoming requests to a trigger condition.

remote-ip

Configures the remote IP network for a trigger condition.

remote-port

Configures the remote port for a trigger condition.

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


message

To determine whether the trigger condition will fire based on whether the headers in the SIP message are request or response headers, use the message command in trigger sequence configuration mode. To remove the message trigger from the trigger condition, use the no form of this command.

message {request | response}

no message

Syntax Description

request

Specifies that the trigger condition will fire if the header in the SIP message is a request header.

response

Specifies that the trigger condition will fire if the header in the SIP message is a response header.


Command Default

No message is configured.

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command does not take a regular expression.

Examples

The following example configures the trigger to fire if the incoming message is a SIP request header:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> message request

The following example configures the trigger to fire if the incoming message is a SIP response header:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> message response

The following example removes the message field from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> no message

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


method (trigger sequence)

To configure a trigger condition in which the trigger is fired on the given SIP method name in the request, use the method command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

method method-name

no method

Syntax Description

method-name

Specifies the SIP method name in the request.


Command Default

No method name is configured.

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The value of this command cannot be entered as a regular expression.

Examples

The following example configures the method name for the trigger condition to INVITE:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 3 
se-10-0-0-0(cusp-config-trigger-seq)> method INVITE

The following example removes the method name from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 3
se-10-0-0-0(cusp-config-trigger-seq)> no method

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


mid-dialog

To configure the trigger to fire on mid-dialog responses, use the mid-dialog command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

mid-dialog

no mid-dialog

Syntax Description

This command has no arguments or keywords.

Command Default

Trigger does not fire on mid-dialog responses.

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger to fire on mid-dialog responses:

se-10-0-0-0(cusp-config-trigger-seq)> mid-dialog

The following example configures the trigger to not fire on mid-dialog responses:

se-10-0-0-0(cusp-config-trigger-seq)> no mid-dialog

out-network

To configure the outgoing network for a trigger condition for a client-side transaction, use the out-network command in trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

out-network network-name

no out-network

Syntax Description

network-name

Specifies the outgoing network for the trigger condition.


Command Default

None

Command Modes

Trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Enter the value for this commandas a regular expression.

Examples

The following example configures the out-network field for the network called "external" for the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 23
se-10-0-0-0(cusp-config-trigger-seq)> out-network external

The following example removes the out-network field from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 23
se-10-0-0-0(cusp-config-trigger-seq)> no out-network

Related Commands

Command
Description

in-network

Configures the incoming network for a trigger condition for a server-side transaction.

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


protocol

To configure a trigger condition in which the trigger is fired on the specific protocol name, use the protocol command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

protocol {tcp | tls | udp}

no protocol

Syntax Description

tcp

Sets TCP as the transport protocol for the trigger condition.

tls

Sets TLS as the transport protocol for the trigger condition.

udp

Sets UDP as the transport protocol for the trigger condition.


Command Default

The protocol is not configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger condition to use UDP as the transport protocol:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 24
se-10-0-0-0(cusp-config-trigger-seq)> protocol udp

The following example removes the transport protocol from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 24
se-10-0-0-0(cusp-config-trigger-seq)> no protocol

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


proxy-route header-param

To configure a trigger to fire when matching the regular expression for the specified header parameter, use the proxy-route header-param command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

proxy-route header-param header-param-name match-string

no proxy-route header-param header-param-name

Syntax Description

header-param-name

Specifies the name of the header parameter to match. This argument does not accept regular expressions.

match-string

Specifies the value that the header parameter must match.


Command Default

No header parameter is configured on the trigger condition.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger to fire when the header parameter service-ref equals abczyx123:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route header-param service-ref abczyx123

The following example removes the header parameter from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> no proxy-route header-param service-ref

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


proxy-route uri-component

To configure a trigger to fire when matching the regular expression for the specified URI component, use the proxy-route uri-component command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

proxy-route uri-component host host | port port | scheme scheme | uri uri | user user

no proxy-route uri-component host host | port port | scheme scheme | uri uri | user user

Syntax Description

host host

Specifies the value that the host URI component must match.

port port

Specifies the value that the port URI component must match.

scheme scheme

Specifies the value that the scheme URI component must match.

uri uri

Specifies the value that the URI URI component must match.

user user

Specifies the value that the user URI component must match.


Command Default

No URI component is configured on the trigger condition.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger to fire when the user component equals 949:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route uri-component user 949

The following example configures the trigger to fire when the scheme component equals sip:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route uri-component scheme sip 

The following example configures the trigger to fire when the host component equals 10.3.29.107:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route uri-component host  10.3.29.107

The following example configures the trigger to fire when the port component equals 5060:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route uri-component port 5060 

The following example configures the trigger to fire when the URI equals sip:9495550101@10.3.29.107:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route uri-component uri 
sip:9495550101@10.3.29.107

The following example removes the user URI component from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> no proxy-route uri-component user

proxy-route uri-param

To configure a trigger to fire when matching the regular expression for the specified URI parameter, use the proxy-route uri-param command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

proxy-route uri-param uri-param-name match-string

no proxy-route uri-param uri-param-name

Syntax Description

uri-param-name

Specifies the name of the URI parameter to match. This argument does not accept regular expressions.

match-string

Specifies the value that the parameter must match.


Command Default

No URI parameter is configured on the trigger condition.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger to fire when the URI parameter transport equals tcp:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> proxy-route uri-param transport tcp

The following example removes the user URI parameter from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> no proxy-route uri-param transport

remote-ip

To configure a trigger condition in which the trigger is fired on the specific remote IP address of the peer element, use the remote-ip command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the remote IP address from the trigger condition, use the no form of this command.

remote-ip remote-ip

no remote-ip [remote-ip]

Syntax Description

remote-ip

Specifies the remote IP address.


Command Default

The remote IP address is not configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the remote IP address for the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 20
se-10-0-0-0(cusp-config-trigger-seq)> remote-ip 10.1.1.2

The following example removes the remote IP address from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 sequence 20 
se-10-0-0-0(cusp-config-trigger)> sequence 20
se-10-0-0-0(cusp-config-trigger-seq)> no remote-ip

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


remote-port

To configure a trigger condition in which the trigger is fired on the specific remote port number of the peer element, use the remote-port command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the remote port from the trigger condition, use the no form of this command.

remote-port remote-port

no remote-port remote-port

Syntax Description

remote-port

Specifies the remote port number.


Command Default

The remote port number is not configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Enter the value of this command as a regular expression.

Examples

The following example configures the remote port for the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 21
se-10-0-0-0(cusp-config-trigger-seq)> remote-port 5060

The following example removes the remote port from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 21
se-10-0-0-0(cusp-config-trigger-seq)> no remote-port

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


request-uri uri-component

To configure a trigger to fire when matching the regular expression for the specified URI component, use the request-uri uri-component command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

request-uri uri-component host host | port port | scheme scheme | uri uri | user user

no request-uri uri-component host host | port port | scheme scheme | uri uri | user user

Syntax Description

host host

Specifies the value that the host URI component must match.

port port

Specifies the value that the port URI component must match.

scheme scheme

Specifies the value that the scheme URI component must match.

uri uri

Specifies the value that the URI URI component must match.

user user

Specifies the value that the user URI component must match.


Command Default

No URI component is configured on the trigger condition.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger to fire when the user component equals 949:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> request-uri uri-component user 949

The following example configures the trigger to fire when the scheme component equals sip:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> request-uri uri-component scheme sip 

The following example configures the trigger to fire when the host component equals 10.3.29.107:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> request-uri uri-component host  10.3.29.107

The following example configures the trigger to fire when the port component equals 5060:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> request-uri uri-component port 5060 

The following example configures the trigger to fire when the URI equals sip:9495550101@10.3.29.107:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> request-uri uri-component uri 
sip:9495550101@10.3.29.107

The following example removes the user URI component from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> no request-uri uri-component user

request-uri uri-param

To configure a trigger to fire when matching the regular expression for the specified URI parameter, use the request-uri uri-param command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

request-uri uri-param uri-param-name match-string

no request-uri uri-param uri-param-name

Syntax Description

uri-param-name

Specifies the name of the URI parameter to match. This argument does not accept regular expressions.

match-string

Specifies the value that the parameter must match.


Command Default

No URI parameter is configured on the trigger condition.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger to fire when the URI parameter transport equals tcp:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> request-uri uri-param transport tcp

The following example removes the user URI parameter from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> no request-uri uri-component transport

response-code

To configure a trigger condition to fire on a specific response, use the response-code command Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the response code from the trigger condition, use the no form of this command.

response-code code

no response-code code

Syntax Description

code

Specifies the SIP response code for the trigger condition. This can be a number, or it can be configured in the following format: N(/d){2}, where N is the number for the class response. For example, you would enter 2 for 2xx responses.


Command Default

No response code is configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the response code for a trigger condition to 408:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 4
se-10-0-0-0(cusp-config-trigger-seq)> response-code 408

The following example removes the response code from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 4
se-10-0-0-0(cusp-config-trigger-seq)> no response-code

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


time

To configure the trigger to fire if the specified time policy is met, use the time command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the time policy, use the no form of this command.

time policy

no time

Syntax Description

policy

Specifies the time policy previously configured using the policy time command.


Command Default

No time policy is configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures the trigger condition t1 to fire when the time policy fridays is met:

se-10-0-0-0(cusp-config)> trigger condition t1 
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> time fridays

The following example removes the the trigger condition using time policy:

se-10-0-0-0(cusp-config-rg)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 1
se-10-0-0-0(cusp-config-trigger-seq)> no time

Related CommandsTBD

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


user-agent-hdr

To configure a trigger condition to fire on the value of the User Agent header field, use the user-agent-hdr command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.

user agent-hdr user-agent-hdr-value

no user agent-hdr user-agent-hdr-value

Syntax Description

user-agent-hdr-value

Specifies the user-agent header field.


Command Default

The user-agent header field is not configured.

Command Modes

Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The value of this command is entered as a regular expression.

Examples

The following example configures the user agent header for a trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 26
se-10-0-0-0(cusp-config-trigger-seq)> user-agent-hdr Cisco SIPGateway/IOS-12.x

The following example removes the user agent header from the trigger condition:

se-10-0-0-0(cusp-config)> trigger condition t1
se-10-0-0-0(cusp-config-trigger)> sequence 26
se-10-0-0-0(cusp-config-trigger-seq)> no user-agent-hdr

Related Commands

Command
Description

trigger condition

Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode.


route table file

To load the routes for a route table from a file, use the route table file command in Cisco Unified SIP Proxy configuration mode. To delete the route table and the routes loaded from a file, use the no form of this command.

route table table_name file route-file

no route table table_name file route-file

Syntax Description

table_name

Specifies the route table name as configured using the route table command.

file route-file

Specifies the file you are loading the route information from. The file path must start with pfs:/cusp/routes/.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

A route table can consist of routes loaded from a file using this command, or routes configured using the route table submode commands, and a route table cannot be mixed with routes loaded from a file and configured on the system.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example loads routes from file routes.txt into route table t1:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> exit
se-10-0-0-0(cusp-config)> route table t1 file pfs:/cusp/routes/routes.txt

The following example deletes the route table:

se-10-0-0-0(cusp-config)> no route table t1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key group

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

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

Assigns a request-URI to a key in a routing table.

route table

Creates a route table and enters route table configuration mode.


route table

To create a route table and enter route table configuration mode, use the route table command in Cisco Unified SIP Proxy configuration mode. To delete the route table, use the no form of this command.

route table table_name

no route table table_name

Syntax Description

table_name

Specifies the name of the route table.


Command Default

A route table is not configured.

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

After you enter this command, you enter route table configuration mode. Use the commands in this configuration mode to configure the routes to be added to the route table. Lookups are performed on the route table keys that are specified using the key group, key target-destination, key response, and key route-uri target-destination commands. Keys with white space need to be specified using quotation marks.

A route table can consist of routes configured using the submode commands accessed using this command, or routes loaded from a file using the route table file command, however a route table cannot be mixed with routes configured on the system and loaded from a file.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following configures route table t1:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)>

The following example deletes the route table:

se-10-0-0-0(cusp-config)> no route table t1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key group

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

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 file

Loads the routes for a route table from a file.


key default-sip

To configure the message in the route table to be simply routed using RFC 3263, use the key default-sip command in route table configuration mode. To remove the key from the route table, use the no form of this command.

key key default-sip network

no key key default-sip

Syntax Description

key

Specifies the route table lookup key.

network

Specifies the name of the SIP network associated with this route (previously configured using the sip network command).


Command Default

None

Command Modes

Route table configuration (cusp-config-rt)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The lookup key represents the portion of the SIP message that is being matched, and must be unique to the routing table.

Examples

The following example configures the message in the route table to be routed using RFC 3263:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> key 973 default-sip external

The following example removes the lookup key from the route table:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> no key 973 default-sip

Related CommandsTBD

Command
Description

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.


key group

To assign a route group to a routing table and associate it with a lookup key number, use the key group command in route table configuration mode. To remove the route group assignment from the lookup key in the routing table, use the no form of this command.

key key group route-group name

no key key

Syntax Description

key

Specifies the route table lookup key. The lookup key represents the portion of the SIP message that is being matched, and must be unique to the routing table.

route-group name

Specifies the name of the route-group.


Command Default

None

Command Modes

Route table configuration (cusp-config-rt)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

You cannot assign a route group and a request URI (using the key target-destination command) to the same key number.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example assigns a previously-configured route group to a routing table and assigns it a key number:

se-10-0-0-0(cusp-config)> route group users
se-10-0-0-0(cusp-config-rg)> exit 
se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> key 973 group users

The following example removes the lookup key from the route table:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> no key 973

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key default-sip

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

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.


key policy

To assign a lookup policy to a key in a routing table, use the key policy command in route table configuration mode. To remove the route policy assignment from the key in the routing table, use the no form of this command.

key key policy route-policy

no key key policy route-policy

Syntax Description

key

Specifies the route table lookup key number. The lookup key represents the portion of the SIP message that is being matched, and must be unique to the routing table.

route-policy

Specifies the route lookup policy (configured with the policy lookup command) to be used in the routing table.


Command Default

None

Command Modes

Route table configuration (cusp-config-rt)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure a defined routing policy to advance to when route advance processing exhausts all specified next hop tuples. This command requires that the policy first be configured using the policy lookup command.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example assigns a previously-configured lookup policy to a routing table and assigns it a key number:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> exit 
se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> key 973 policy p1

The following example removes the lookup key from the route table:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> no key 973

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

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

policy lookup

Configures a lookup policy and enters lookup policy configuration mode.

route table

Creates a route table and enters route table configuration mode.


key response

To assign a response code to a lookup key in a routing table, use the key response command in route table configuration mode. To remove the response code assignment from the lookup key in the routing table, use the no form of this command.

key key response response-code

no key key [response response-code]

Syntax Description

key

Specifies the route table lookup key number. The lookup key represents the portion of the SIP message that is being matched, and must be unique to the routing table.

response-code

Specifies the response code as configured using the failover-resp-code command.


Command Default

None

Command Modes

Route table configuration (cusp-config-rt)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command requires that you configure the failover-resp-code command first.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example assigns a response code to a routing table and assigns it a key number:

se-10-0-0-0(cusp-config)> server-group sip t1
se-10-0-0-0(cusp-config-sg)> failover-resp-code 404
se-10-0-0-0(cusp-config-sg)> exit 
se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> key 973 response 404

The following example removes the lookup key from the route table:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> no key 973

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

failover-resp-code

Configures a failover response code for a SIP server group.

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


key route-uri target-destination

To assign a route-URI to a lookup key in a routing table and replace the target destination with the specified value in the outgoing SIP request, use the key route-uri target-destination command in Cisco Unified SIP Proxy route table configuration mode. To remove the route-URI assignment from the lookup key in the routing table, use the no form of this command.

key key route-uri route-uri target-destination target-destination network

no key key [route-uri route-uri target-destination target-destination network]

Syntax Description

key

Specifies the route table lookup key number. The lookup key represents the portion of the SIP message that is being matched, and must be unique to the routing table.

route-uri route-uri

Specifies the URI in the route header field to be assigned to the routing table.

target-destination target-destination

Specifies the host and port and transport of the request-URI. The format of this field is host:port:transport; port and transport are optional. .

network

Specifies the SIP network name as configured using the sip network command.


Command Default

None

Command Modes

Cisco Unified SIP Proxy route table configuration (cusp-config-rt)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The route-URI must be configured first using the element route-uri command.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example assigns a route-URI to a routing table and assigns it a key number:

se-10-0-0-0(cusp-config)> route group users
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0
se-10-0-0-0(cusp-config-rg)> exit 
se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> key 973 route-uri sip:external@example.com;lr 
target-destination 192.168.1.1:5060 external

The following example removes the lookup key from the route table:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> no key 973

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element route-uri

Adds a route-URI header and replaces it with a request URI header in a route group, and enters element configuration mode.

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

sip network

Creates a logical SIP network and enters SIP network configuration mode.


key target-destination

To replace a target destination with the specified value in an outgoing SIP request, use the key target-destination command in route table configuration mode. To remove the request-URI from the key in the routing table, use the no form of this command.

key key target-destination target-destination network

no key key [target-destination request-uri-host-port network]

Syntax Description

key

Specifies the route table lookup key number. The lookup key represents the portion of the SIP message that is being matched, and must be unique to the routing table.

target-destination

Specifies the host and port and transport of the request-URI to be assigned to the routing table. The format of this field is host:port:transport; port and transport are optional.

network

Specifies the SIP network name.


Command Default

None

Command Modes

Route table configuration (cusp-config-rt)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The request-URI must be configured first using the element target-destination command.

You cannot assign a request-URI and a route group (using the key group command) to the same key number.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example assigns a target destination to a routing table and assigns it a key number:

se-10-0-0-0(cusp-config)> route group users
se-10-0-0-0(cusp-config-rg)> element target-destination sip:external@example.com internal 
1.0
se-10-0-0-0(cusp-config-rg)> exit 
se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> key 973 target-destination hostnameB internal

The following example removes the lookup key from the route table:

se-10-0-0-0(cusp-config)> route table t1
se-10-0-0-0(cusp-config-rt)> no key 973

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

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.

route table

Creates a route table and enters route table configuration mode.


route group

To create a route group and enter route group configuration mode, use the route group command in Cisco Unified SIP Proxy configuration mode. To remove the route group, use the no form of this command.

route group route-group-name [time-policy] [weight]

no route group route-group-name

Syntax Description

route-group-name

Specifies the name of the route group.

time-policy

(Optional) Enables the time-based routing configurations configured with the policy time command that this route group will use if implementing time-based routing. This option is disabled by default.

weight

(Optional) Enables weight-based routing configurations for the route group. If selected, the route group uses weight as the algorithm to pick the next route. This option is disabled by default.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

This command configures a route group and its route group elements. A route group is a set of one or more route group elements or next-hop tuple configurations. Route groups allow specific sets of next-hop data tuples to be reused across multiple route configurations.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates a route group g1 and enters route group configuration mode:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> 

The following example creates a route group using weight-based routing:

se-10-0-0-0(cusp-config)> route group g1 weight 

The following example creates a route group using both time-based and weight-based routing:

se-10-0-0-0(cusp-config)> route group g1 time-policy weight 

The following example deletes a route group:

se-10-0-0-0(cusp-config)> no route group g1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element route-uri

Adds a route-URI element to a route group.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

policy time

Creates a time policy and enters time-policy configuration mode.

show routes table

Displays the configured Cisco Unified SIP Proxy routes.


element route-uri

To add a route-URI header and replace it with a request URI header in a route group, and to enter element configuration mode, use the element-route-uri command in Cisco Unified SIP Proxy route group configuration mode. To remove the route entry from the route group, use the no form of this command.

element route-uri route-uri network [q_value]

no element route-uri route-uri network

Syntax Description

route-uri route-uri

Specifies the Route-URI header.

request-uri request-uri

Specifies the Request-URI header that will replace the Route-URI header.

network

Specifies the SIP network configured with the sip network command.

q_value

(Optional) Represents a real number that specifies the priority of the server group element with respect to others in the server group. Valid values are from 0.0 to 1.0. The default is 1.0.


Command Default

The route-URI element is not configured.

Command Modes

Cisco Unified SIP Proxy route group configuration (cusp-config-rg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

More than one route-URI can be assigned to a given network.

For the weight option, each element in a server group is assigned a weight such that the element will receive a traffic load that is proportional to its weight relative to the weights of other elements of the same priority (q-value) in the server group.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example adds a route-URI element to a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com ;lr internal
se-10-0-0-0(cusp-config-rg-element)> 

The following example removes a route-URI element from a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> no element route-uri sip:external@example.com ;lr internal

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

failover-codes

Configures the failover codes for the request-URI element or route-URI element.

route group

Creates a route group and enters route group configuration mode.

time-policy (element)

Configures the time-policy used if implementing time-based routing.

weight

Configures the percentage assigned to the request-URI or route-URI in the route group if implementing weight-based routing.


element route-uri target-destination

To add a route-URI element to a route group and to enter element configuration mode, use the element-route-uri command in Cisco Unified SIP Proxy route group configuration mode. To remove the route entry from the route group, use the no form of this command.

element route-uri route-uri request-uri-host-port request-uri-host-port network [q_value]

no element route-uri route-uri network

Syntax Description

route

Specifies the Route-URI header.

request-uri-host-port

Specifies the Request-URI-host-port in the request. The format of this field is host:port; port is optional.

network

Specifies the SIP network configured with the sip network command.

q_value

(Optional) Represents a real number that specifies the priority of the server group element with respect to others in the server group. Valid values are from 0.0 to 1.0. The default is 1.0.


Command Default

The route-URI element is not configured.

Command Modes

Cisco Unified SIP Proxy route group configuration (cusp-config-rg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

More than one route-URI can be assigned to a given network.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example adds a route-URI element to a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com;lr 
request-uri-host-port 192.168.1.1:5060 internal
se-10-0-0-0(cusp-config-rg-element)> 

The following example removes a route-URI element from a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> no element route-uri sip:external@example.com;lr 
request-uri-host-port 192.168.1.1.:5060

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

failover-codes

Configures the failover codes for the request-URI element or route-URI element.

route group

Creates a route group and enters route group configuration mode.

sip network

Creates a logical SIP network and enters SIP network configuration mode.

time-policy (element)

Configures the time-policy used if implementing time-based routing.

weight

Configures the percentage assigned to the request-URI or route-URI in the route group if implementing weight-based routing.


element target-destination

To add a target destination element to a route group and to enter element configuration mode, use the element target-destination command in route group configuration mode. To remove the route entry from the route group, use the no form of this command.

element target-destination target-destination network [q_value]

no element target-destination target-destination

Syntax Description

target-destination

Specifies the next hop tuples based off the target-destination in the request. The format of this field is host:port; port is optional.

network

Specifies the SIP network configured with the sip network command.

q_value

(Optional) Represents a real number that specifies the priority of the server group element with respect to others in the server group. Valid values are from 0.0 to 1.0. The default is 1.0.


Command Default

The request-URI element is not configured.

Command Modes

Cisco Unified SIP Proxy route group configuration (cusp-config-rg)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example adds a target destination element to a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element target-destination hostnameB internal
se-10-0-0-0(cusp-config-rg-element)> 

The following example removes a target destination element from a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> no element target-destination hostnameB

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element route-uri

Adds a route-URI element to a route group.

failover-codes

Configures the failover codes for the request-URI element or route-URI element.

route group

Creates a route group and enters route group configuration mode.

sip network

Creates a logical SIP network and enters SIP network configuration mode.

time-policy (element)

Configures the time-policy used if implementing time-based routing.

weight

Configures the percentage assigned to the request-URI or route-URI in the route group if implementing weight-based routing.


failover-codes

To configure the failover codes for an element request-URI or element route-URI, use the failover-codes command in element request-URI or element route-URI configuration mode. To remove the failover code, use the no form of this command.

failover-codes codes [ - code] [ , continue]

no failover-codes

Syntax Description

codes

Specifies the SIP response codes, which are separated by a comma. A single white space must be entered before and after each comma and dash used to denote a multiple range.


Command Default

No failover codes are configured.

Command Modes

Element configuration (cusp-config-rg-element)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Route advance occurs if the proxy receives one of the specified response codes from the downstream element.

Examples

The following example adds response codes to a route-URI element in a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> failover-codes 502 , 503

The following example adds response codes to a route-URI element in a route group:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> failover-codes 502 , 504 - 508 , 588

The following example removes the failover codes from the route-URI element:

se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> no failover-codes

Related CommandsTBD

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element route-uri

Adds a route-URI element to a route group.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

route group

Creates a route group and enters route group configuration mode.

time-policy (element)

Configures the time-policy used if implementing time-based routing.

weight

Configures the percentage assigned to the request-URI in the route group if implementing weight-based routing.


time-policy (element)

To configure the time policy for an element request-URI or element route-URI, use the time-policy command in element request-URI or element route-URI configuration mode. To remove the time policy, use the no form of this command.

time-policy policy

no time-policy

Syntax Description

policy

Specifies the time policy previously configured using the policy time command if implementing time-based routing. This option is only valid if the time-policy option is specified in the route group command.


Command Default

None

Command Modes

Element configuration (cusp-config-rg-element)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Examples

The following example configures a time policy for a route-URI element:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> time-policy tp1

The following example removes the time policy from the element route-URI:

se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> no time-policy

Related CommandsTBD

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element route-uri

Adds a route-URI element to a route group.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

failover-codes

Configures the failover codes for the request-URI element or route-URI element.

route group

Creates a route group and enters route group configuration mode.

weight

Configures the percentage assigned to the request-URI in the route group if implementing weight-based routing.


weight

To configure the weight percentage assigned to a request-URI or route-URI if implementing weight-based routing, use the weight command in element configuration mode. To remove the weight, use the no form of this command.

weight weight

no weight

Syntax Description

weight

Specifies the percentage assigned to the request-URI or route-URI element in the route group if implementing weight-based routing. The valid range is from 0 to 100. If not configured, the default weight is 50. This option is only valid if the weight option is specified in the route group command.


Command Default

50

Command Modes

Element configuration (cusp-config-rg-element)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Each element in a route group is assigned a weight. Each element receives a traffic load that is proportional to its weight.

Examples

The following example configures the route-URI element to have a percentage-weight of 50 for weight-based routing:

se-10-0-0-0(cusp-config)> route group g1
se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> weight 50

The following example removes the weight value from the element route-URI:

se-10-0-0-0(cusp-config-rg)> element route-uri sip:external@example.com internal 1.0 
se-10-0-0-0(cusp-config-rg-element)> no weight

Related CommandsTBD

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

element route-uri

Adds a route-URI element to a route group.

element target-destination

Addds a target destination element to a route group and enters element configuration mode.

failover-codes

Configures the failover codes for the request-URI element or route-URI element.

route group

Creates a route group and enters route group configuration mode.

time-policy (element)

Configures the time-policy used if implementing time-based routing.


policy time

To create a time-of-day policy and to enter time-policy configuration mode, use the policy time command in Cisco Unified SIP Proxy configuration mode. To delete a time policy, use the no form of this command.

policy time time_policy_name

no policy time time_policy_name

Syntax Description

time_policy_name

Specifies the name assigned to the time policy.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The start- and end-time values are entered in RFC 2445 iCA1 COS DATE-TIME format.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates a time policy and enters time-policy configuration mode:

se-10-0-0-0(cusp-config)> policy time tp1 
se-10-0-0-0(cusp-config-time)> 

The following example deletes a time policy:

se-10-0-0-0(cusp-config)> no policy time tp1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

day-of-week

Configures the days in the week that apply in a time policy.

end-time

Configures the ending time of a time policy step.

month

Configures the months in the year that apply in a time policy.

sequence (policy time)

Configures a step for a time-of-day policy with starting and ending times, and enters sequence configuration submode.

start-time

Configures the starting time of a time policy step.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


sequence (policy time)

To configure a step for a time-of-day policy with starting and ending times, and to enter sequence configuration submode, use the sequence command in policy time configuration mode. To remove the step from the time policy, use the no form of this command.

sequence sequence

no sequence sequence

Syntax Description

sequence

Specifies the sequence number for the time policy.


Command Default

None

Command Modes

Policy time configuration (cusp-config-time)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates a time policy step and enters time-policy step configuration mode, where the start-time and end-time of the policy step is configured:

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

The following example removes a time policy step:

se-10-0-0-0(cusp-config)> policy time tp1 
se-10-0-0-0(cusp-config-time)> no sequence 1

Related CommandsTBD

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

day-of-week

Configures the days in the week that apply in a time policy.

end-time

Configures the ending time of a time policy step.

month

Configures the months in the year that apply in a time policy.

policy time

Configures a time policy and enters time policy configuration mode.

start-time

Configures the starting time of a time policy step.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


end-time

To configure the ending-time for a time policy step, use the end-time command in Cisco Unified SIP Proxy policy time sequence configuration mode. To remove the ending-time from the time-policy step, use the no form of this command.

end-time end-time

no end-time

Syntax Description

end-time

Specifies the end-time in the format "HH:MM:SS <month> <day> <year>.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy time sequence configuration (cusp-config-time-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The time policy step uses the local time zone. If the end-time is missing, then the policy step has no constraint on the end-time. If the end-time is not greater than the current time, an error is thrown.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates a time policy step which applies until 8/1/2008 at 12:00:

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)> end-time 12:00:00 August 01 2008

The following example removes the ending time from a time policy step:

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)> no end-time

Related CommandsTBD

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

day-of-week

Configures the days in the week that apply in a time policy.

month

Configures the months in the year that apply in a time policy.

policy time

Configures a time policy and enters time-policy configuration mode.

sequence (policy time)

Configures a step for a time-of-day policy with starting and ending times, and enters sequence configuration submode.

start-time

Configures the starting time of a time policy step.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


month

To configure the months in the year that a time policy step applies to, use the month command in policy time sequence configuration mode. To remove the month value assigned to the time policy step, use the no form of this command.

month begin month [- end-month] [ , ] (continue) [end-month]

no month begin month [- end-month] [ , ] (continue) [end-month]

Syntax Description

begin month

Specifies the first month for which the time policy step applies. Enter the value as the first 3 letters of the month.

end-month

(Optional) Specifies the last month for which the time policy step applies. Enter the value as the first 3 letters of the month.

You can specify additional optional parameters specifying additional ending months in multiple ranges. When entering multiple ranges, you use commas and dashes to denote these ranges. Enter a single white space before and after each comma and dash used to denote a multiple range.


Command Default

None

Command Modes

Policy time sequence configuration (cusp-config-time-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

If the last-month value is not entered, then the time policy only applies for the month specified with the first-month value.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the time policy step to be effective only in January.

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)> month jan

The following example configures the time policy step to be effective beginning in January and ending in June:

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)> month jan - jun

The following example configures the time policy step to be effective for January, February, May, October, November, and December:

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)> month jan - feb , may , oct - dec

The following example removes the month constraint from the time policy:

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)> no month

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

day-of-week

Configures the days in the week that apply in a time policy.

end-time

Configures the ending time of a time policy step.

policy time

Creates a time policy and enters time-policy configuration mode.

sequence (policy time)

Configures a step for a time-of-day policy with starting and ending times, and enters sequence configuration submode.

start-time

Configures the starting time of a time policy step.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


start-time

To configure the starting time for a time policy step, use the start-time command in Cisco Unified SIP Proxy policy time sequence configuration mode. To remove the starting time from the time-policy step, use the no form of this command.

start-time start-time

no start-time start-time

Syntax Description

start-time

Specifies the start-time in the format "HH:MM:SS <month> <day> <year>. "


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy time sequence configuration (cusp-config-time-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The time policy step uses the local time zone. If the start-time is missing, then the policy step has no constraint on the start-time.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates a time policy step which applies from 7/1/2008 at 14:15:20:

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 July 01 2008

The following example removes the start time from the time policy step:

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)> no start-time

Related CommandsTBD

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

day-of-week

Configures the days in the week that apply in a time policy.

end-time

Configures the ending time of a time policy step.

month

Configures the months in the year that apply in a time policy.

policy time

Creates a time policy and enters policy-time configuration mode.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


day-of-month

To configure the days in the month that a time policy step applies to, use the day-of-month command in policy time configuration mode. To disable the days-in-month value assigned to the time policy step, use the no form of this command.

day-of-month begin day [- end-day] [ , ] (continue) [end-day]

no day-of-month begin day [- end-day] [ , ] (continue) [end-day]

Syntax Description

begin-day

The first day in the month in which the time policy step applies.

end-day

(Optional) The last day in the month in which the time policy step applies.

You can specify additional optional parameters specifying additional beginning and ending days in a multiple range. When entering multiple ranges, use commas and dashes to denote these ranges. Enter a single white space before and after each comma and dash used to denote a multiple range.


Command Default

None

Command Modes

Policy time configuration (cusp-config-time)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures a time policy step in which the policy applies to the first day of the month:

se-10-0-0-0(cusp-config)> policy time tp1
se-10-0-0-0(cusp-config-time)> day-of-month 1

The following example configures a time policy step in which the policy applies on the 1st, 10th, 11th, 12th, 13th, 14th, 15th and 28th days of the month:

se-10-0-0-0(cusp-config)> policy time tp1
se-10-0-0-0(cusp-config-time)> day-of-month 1 , 10 - 15 , 28

The following example removes the day-of-month value from the time policy step:

se-10-0-0-0(cusp-config)> policy time tp1

se-10-0-0-0(cusp-config-time)> no day-of-month

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-week

Configures the days in the week that apply in a time policy.

end-time

Configures the ending time of a time policy step.

month

Configures the months in the year that apply in a time policy.

policy time

Creates a time policy and enters time-policy configuration mode.

sequence (policy time)

Configures a step for a time-of-day policy with starting and ending times, and enters sequence configuration submode.

start-time

Configures the starting time of a time policy step.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


day-of-week

To configure the days in the week that a time policy step applies to, use the day-of-week command in policy time configuration mode. To disable the day-of-week value assigned to the time policy step, use the no form of this command.

day-of-week begin day [- end-day] [ , ] (continue) [end-day]

no day-of-week begin day [- end-day] [ , ] (continue) [end-day]

Syntax Description

begin-day

Specifies the first day in the week for which the time policy step applies. The value is entered using the first three letters of the day.

end-day

(Optional) Specifies the last day in the week for which the time policy step applies. The value is entered using the first three letters of the day.

You can specify additional optional parameters specifying additional beginning and ending days in a multiple range. When entering multiple ranges, use commas and dashes to denote these ranges. A single white space must be entered before and after each comma and dash used to denote a multiple range.


Command Default

None

Command Modes

Policy time configuration (cusp-config-time)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures a time policy step in which the policy applies only to Monday in a given week:

se-10-0-0-0(cusp-config)> se-10-0-0-0(cusp-config)> policy time tp1
se-10-0-0-0(cusp-config-time)> day-of-week mon

The following example configures a time policy step in which the policy applies for Monday, Wednesday, Thursday, and Friday in a given week:

se-10-0-0-0(cusp-config)> policy time tp1
se-10-0-0-0(cusp-config-time)> day-of-week mon , wed - fri

The following example removes the day-of-week value from the time policy:

se-10-0-0-0(cusp-config)> policy time tp1
se-10-0-0-0(cusp-config-time)> no day-of-week

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

end-time

Configures the ending time of a time policy step.

month

Configures the months in the year that apply in a time policy.

policy time

Creates a time policy and enters time-policy configuration mode.

sequence (policy time)

Configures a step for a time-of-day policy with starting and ending times, and enters sequence configuration submode.

start-time

Configures the starting time of a time policy step.

time (policy time sequence)

Configures the times in the day that apply in a time policy.


time (policy time sequence)

To configure the times in the day that a time policy step applies to, use the time command in policy time sequence configuration mode. To disable the times-in-day value assigned to the time policy step, use the no form of this command.

time begin time [- end-time] [ , ] (continue) [end-time]

no time begin time [- end-time] [ , ] (continue) [end-time]

Syntax Description

begin-time

Specifies the start time of the policy (GMT). The time is entered in the format HH:MM:SS.

end-time

Specifies the end time of the policy (GMT). The time is entered in the format HH:MM:SS.

You can specify additional optional parameters specifying additional beginning and ending times in a multiple range. When entering multiple ranges, use commas and dashes to denote these ranges. A single white space must be entered before and after each comma and dash used to denote a multiple range.


Command Default

None.

Command Modes

Policy time sequence configuration (cusp-config-time-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The time values are entered in Greenwich Mean Time (GMT) format.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the times-in-day in a time policy to take effect from 9:00 a.m. to 5:00 p.m.

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)> time 09:00 - 17:00

The following example removes the times-in-day value from a time policy, making the time policy effective for the whole day:

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)> no time 09:00 - 17:00

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

day-of-month

Configures the days in the month that apply in a time policy.

day-of-week

Configures the days in the week that apply in a time policy.

end-time

Configures the ending time of a time policy step.

month

Configures the months in the year that apply in a time policy.

policy time

Creates a time policy and enters time-policy configuration mode.

sequence (policy time)

Configures a step for a time-of-day policy with starting and ending times, and enters sequence configuration submode.

start-time

Configures the starting time of a time policy step.


policy lookup

To configure a lookup policy for routing and enter policy lookup configuration mode, use the policy lookup command in Cisco Unified SIP Proxy configuration mode. To remove the field sequence characteristics from the lookup policy, use the no form of this command.

policy lookup policy-name

no policy lookup policy-name

Syntax Description

policy-name

Specifies the lookup policy name.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the field sequence characteristics for a lookup policy and enters lookup configuration mode:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> 

The following example removes a lookup policy:

se-10-0-0-0(cusp-config)> no policy lookup p1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key-modifier

Configures a key-modifier for a lookup policy.

rule

Configures a rule that determines the routing algorithm for the lookup policy.

sequence field

Configures the field sequence characteristics for a lookup policy.

sequence header uri-component

Configures the URI component sequence header characteristics for a lookup policy.


sequence field

To configure the field sequence characteristics for a lookup policy and enter sequence-field configuration mode, use the sequence field command in Cisco Unified SIP Proxy policy lookup configuration mode. To remove the field sequence characteristics from the lookup policy, use the no form of this command.

sequence sequence-number table-name field {in-network | local-ip-address | local-ip-port | remote-ip-address | remote-ip-port}

no sequence sequence-number

Syntax Description

sequence sequence-number

Specifies the sequence number for the lookup policy. This represents the order in which the lookup policies are executed.

table-name

Specifies a route table name configured with the route table command.

field

Specifies the field characteristic.

In-network: Incoming network name

Local-ip-address: Receiving local ip-address address

Local-ip-port: Receiving local ip-address address and port

Remote-ip-address: The ip-address address of the remote sender

Remote-ip-port: The ip-address address and port of the remote sender

in-network

Specifies the incoming SIP network name.

local-ip-address

Specifies the receiving local IP address of the incoming SIP network.

local-ip-port

Specifies the receiving local IP address and port.

remote-ip-address

Specifies the IP address of the remote sender.

remote-ip-port

Specifies the IP address and port of the remote sender.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy lookup configuration (cusp-config-lookup)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure a lookup policy with a route table and its lookup key using non-SIP header related information. This command launches a sequence-field configuration submode which configures key modifiers and rules for the lookup policy. If the commands in the submode are not configured, the proxy is configured with a default rule and no key modifiers.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the field sequence characteristics for a lookup policy and enters sequence-field configuration mode:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 field in-network
se-10-0-0-0(cusp-config-lookup-seq)> 

The following example removes the field sequence characteristics from a lookup policy:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> no sequence 8

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key-modifier

Configures a key-modifier for a lookup policy.

rule

Configures a rule that determines the routing algorithm for the lookup policy.


rule

To configure a rule that determines the routing algorithm for the lookup policy, use the rule command in Cisco Unified SIP Proxy policy lookup sequence field and sequence header configuration mode. To remove the rule from the lookup policy, use the no form of this command.

rule {exact | prefix | subdomain | subnet | fixed length} [case-insensitive]

no rule {exact | prefix | subdomain | subnet | fixed length} [case-insensitive]

Syntax Description

exact

Specifies that the lookup policy searches for the exact match of the key in the specified table

prefix

Specifies that the lookup policy searches for the longest prefix match.

subdomain

Specifies that the lookup policy searches for the longest subdomain of the keys in the table.

subnet

Specifies that the lookup policy searches for the longest IP addresses of the keys in the table.

fixed length

Specifies that a fixed number of characters from the key is looked up instead of the complete key.

case-insensitive

(Optional) If using subdomain matching, this option specifies that the matches are case-insensitive so that if a request contains a nonSIP request URI, the lookup does not fail. This setting might be necessary because domain name matching is normally case-sensitive.


Command Default

The exact routing algorithm is used.

Command Modes

Cisco Unified SIP Proxy policy lookup sequence field and sequence header configuration (cusp-config-lookup-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The following provides additional information about how the different algorithm rules work in a lookup policy:

exact

This lookup type is performed using a string matching rule. The lookup field must match the key in a route of the specified route table.

prefix

This lookup type performs a longest prefix match against the key in each route of a specified route table. This implies the following, for example:

If the part of the request being examined has a value of "5550100", and a route in the specified route table has a key of "555", there is a match. If there is another route in the same table with a key of "55501", this also matches, and is preferred, as it matches more digits of the key. Matching can be performed on both numbers and arbitrary strings.

subdomain

This lookup matches the host portion of the Request-URI (a fully-qualified domain name or IP address) against the key of each route in a specified route table.


Note Domain name matching is case-sensitive and the most specific match prevails, and IP address matching must be exact. If a request contains a nonSIP request URI, this lookup fails. To prevent this from happening, use the case-insensitive keyword option.


subnet mask

This lookup matches an IP address within a specified Request-URI field against the key in each route of a specified route table.

fixed

This lookup type attempts to find an exact match over the first n characters of the key in each route of a specified route table. For example:

Suppose the phone number within a Request-URI is being examined and has a value of 97395550100. If the number of characters that must match is configured to 3, a match would only take place if a route in the specified routing table has a key of 973. Matching can be performed on both numbers and arbitrary strings.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the lookup policy rule to search for the longest prefix match:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 field in-network
se-10-0-0-0(cusp-config-lookup-seq)> rule prefix

The following example configures the lookup policy rule to search for the longest subdomain of the keys, and to make the search case-insensitive:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 header request-uri
se-10-0-0-0(cusp-config-lookup-seq)> rule subdomain case-insensitive

The following example removes the lookup policy rule:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 field in-network
se-10-0-0-0(cusp-config-lookup-seq)> no rule

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key-modifier

Configures a key-modifier for a lookup policy.

policy lookup

Configures a lookup policy and enters lookup policy configuration mode.

sequence field

Configures the field sequence characteristics for a lookup policy.

sequence header uri-component

Configures the URI component sequence header characteristics for a lookup policy.


key-modifier

To configure a key-modifier for a lookup policy, use the key-modifier command in Cisco Unified SIP Proxy policy lookup sequence field and sequence header configuration mode. To remove the key-modifer from the lookup policy, use the no form of this command.

key-modifier sequence key-sequence-number {ignore-plus | tel | {regex {match | replace}}}

no key-modifier sequence key-sequence-number

Syntax Description

sequence key-sequence-number

Specifies the key sequence number.

ignore-plus

Specifies that a leading "+" in the value of thefied attribute is ignored.

tel

Specifies that all RFC 2806 separator characters are removed before 241

performing the lookup.

regex

Specifies the key modifier to replace the match string with the replacement string.

match

Specifies the key modifier to match the regular expression.

replace

Specifies the key modifier to replace the regular expression.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy lookup sequence field and sequence header configuration (cusp-config-lookup-seq)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

Use this command to configure special transformations that are applied to the value of the field-lookup attribute before the lookup is performed. Transformations are applied sequentially, in the order of the key-sequence-number. The outcome of the previous modifier is the input to the next.


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the key modifier to ignore the leading "+" in the value of the fied attribute:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 field in-network
se-10-0-0-0(cusp-config-lookup-seq)> key-modifier sequence 1 ignore-plus

The following example configures the key modifier to use the "tel" value:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 field in-network
se-10-0-0-0(cusp-config-lookup-seq)> key-modifier sequence 1 tel

The following example configures the key modifier to replace the match string with the replacement string:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 header request-uri
se-10-0-0-0(cusp-config-lookup-seq)> key-modifier sequence 1 regex replace

The following example removes the key-modifier value from the policy lookup sequence field:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 field in-network
se-10-0-0-0(cusp-config-lookup-seq)> no key-modifier sequence 1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

policy lookup

Configures a lookup policy and enters lookup policy configuration mode.

rule

Configures a rule that determines the routing algorithm for the lookup policy.

sequence field

Configures the field sequence characteristics for a lookup policy.

sequence header uri-component

Configures the URI component sequence header characteristics for a lookup policy.


sequence header uri-component

To configure the URI component sequence header characteristics for a lookup policy and enter sequence header configuration mode, use the sequence header uri-component command in Cisco Unified SIP Proxy policy lookup configuration mode. To remove the URI component sequence header characteristics from the lookup policy, use the no form of this command.

sequence sequence-number table-name header {diversion | from | p-asserted-identity | remote-party-id | request-uri} uri-component {host | host-port| param name | phone | uri | user}

no sequence sequence-number table-name header {diversion | from | p-asserted-identity | remote-party-id | request-uri} uri-component {host | host-port| param name | phone | uri | user}

Syntax Description

sequence sequence-number

Specifies the sequence number for the lookup policy. This represents the order in which the lookup policies are executed.

table-name

Specifies a route table name configured with the route table command.

header

Specifies the header for which the lookup policy is applicable.

diversion

Specifies the lookup policy to apply to the Diversion header.

from

Specifies the lookup policy to apply to the From header.

paid

Specifies the lookup policy to apply to the P-Asserted-Identity header.

rpid

Specifes the lookup policy to apply to the Remote-Party-Id header.

ruri

Specifies the lookup policy to apply to the Request-URI header.

uri-component

Specifies the URI component for which the policy is applicable.

domain

Specifies the lookup policy to apply to the domain URI component.

param name

Specifies the URI component parameter name.

phone

Specifies the lookup policy to apply to the phone URI component.

uri

Specifies the lookup policy to apply to the full URI.

user

Specifies the lookup policy to apply to the user URI component.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy lookup configuration (cusp-config-lookup)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures the URI component header sequence characteristics for a lookup policy and enters sequence-header configuration mode:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> sequence 8 t1 header request-uri uri-component user
se-10-0-0-0(cusp-config-lookup-seq)> 

The following example removes the header sequence characteristics from a lookup policy:

se-10-0-0-0(cusp-config)> policy lookup p1
se-10-0-0-0(cusp-config-lookup)> no sequence 8

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

key-modifier

Configures a key-modifier for a lookup policy.

rule

Configures a rule that determines the routing algorithm for the lookup policy.

sequence field

Configures the field sequence characteristics for a lookup policy.


policy normalization

To create a normalization policy and enter Cisco Unified SIP Proxy policy normalization configuration mode, use the policy normalization command in Cisco Unified SIP Proxy configuration mode. To delete a normalization policy, use the no form of this command.

policy normalization policy_name

no policy normalization policy_name

Syntax Description

policy_name

Specifies the name of the normalization policy.


Command Default

None

Command Modes

Cisco Unified SIP Proxy configuration (cusp-config)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines

The order of the normalization steps among different tokens is the following:

1. header (operation)

2. header-param

3. tel-to-sip

4. sip-to-tel

5. uri-component

6. uri-param

The order of the normalization steps with the same token is based on the operation and the order is the following:

1. remove

2. update

3. add


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example creates a normalization policy called p1 and enters policy-normalization configuration mode:

se-10-0-0-0(cusp-config)> policy normalization p1
se-10-0-0-0(cusp-config-norm)> 

The following example deletes a normalization policy:

se-10-0-0-0(cusp-config)> no policy normalization p1

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

header-param add

Configures a normalization policy step to add a header parameter.

header-param remove

Configures a normalization policy step to remove a header parameter.

header-param update

Configures a normalization policy step to update a header parameter.

header add

Configures a normalization policy step to add a header.

header remove

Configures a normalization policy step to remove a header.

header update

Configures a normalization policy step to update a header.

sip-to-tel

Configures a normalization policy step to convert a destination SIP URI to a TEL URI.

tel-to-sip

Configures a normalization policy step to convert a destination TEL URI to a SIP URI.

uri-component update header

Configures a normalization policy step to update a URI component field within a header of the source message.

uri-param add

Configures a normalization policy step to add a URI parameter field within a header of the source message.

uri-param remove

Configures a normalization policy step to remove a URI parameter field within a header of the source message.

uri-param update

Configures a normalization policy step to update a URI parameter field within a header of the source message.


header-param add

To configure a normalization policy step that adds a header parameter, use the header-param-add command in Cisco Unified SIP Proxy policy normalization configuration mode. To delete the step from the normalization policy, use the no form of this command.

header-param add header-name {first | last | all} header-param-name value

no header-param add header-name {first | last | all} header-param-name

Syntax Description

header-name

Specifies the SIP message header for which the normalization step is applicable. Examples include: From, To, Record-Route, Diversion, Request-URI, and P-Asserted-Identity.

first

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied only to the first occurrence.

last

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied only to the last occurrence.

all

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied to all occurrences.

header-param-name

Specifies the header parameter name.

value

Specifies the value to be added.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy normalization configuration (cusp-config-norm)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures a normalization step that adds a header parameter to the first occurrence of the Call-Info header where the header parameter "m" has a value of "XX":

se-10-0-0-0(cusp-config)> policy normalization p1
se-10-0-0-0(cusp-config-norm)> header-param-add Call-Info first m XX

The following example removes a normalization step that adds a header parameter:

se-10-0-0-0(cusp-config)> policy normalization p1
se-10-0-0-0(cusp-config-norm)> no header-param-add Call-Info first m 

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

header-param remove

Configures a normalization policy step to remove a header parameter.

header-param update

Configures a normalization policy step to update a header parameter.

policy normalization

Creates a normalization policy.


header-param remove

To configure a normalization policy step that removes a header parameter, use the header-param-remove command in Cisco Unified SIP Proxy policy normalization configuration mode. To delete the step from the normalization policy, use the no form of this command.

header-param remove header-name {first | last | all} header-param-name

no header-param remove header-name {first | last | all} header-param-name

Syntax Description

header-name

Specifies the SIP message header for which the normalization step is applicable. Examples include: From, To, Record-Route, Diversion, Request-URI, and P-Asserted-Identity.

first

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied only to the first occurrence.

last

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied only to the last occurrence.

all

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied to all occurrences.

header-param-name

Specifies the header parameter name.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy normalization configuration (cusp-config-norm)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures a normalization step that removes all occurrences of the "m" header parameter in the Call-Info header:

se-10-0-0-0(cusp-config)> policy normalization policy1
se-10-0-0-0(cusp-config-norm)> header-param-remove Call-Info all m

The following example removes a normalization step that removes a header parameter:

se-10-0-0-0(cusp-config)> policy normalization policy1
se-10-0-0-0(cusp-config-norm)> no header-param-remove From all tag

Related Commands

Command
Description

commit

Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect.

header-param add

Configures a normalization policy step to add a header parameter.

header-param update

Configures a normalization policy step to update a header parameter.

policy normalization

Creates a normalization policy.


header-param update

To configure a normalization policy step that updates a header parameter, use the header-param update command in Cisco Unified SIP Proxy policy normalization configuration mode. To delete the step from the normalization policy, use the no form of this command.

header-param update header-name {first | last | all} header-param-name { all | match-string} replace-string

no header-param update header-name {first | last | all} header-param-name

Syntax Description

header-name

Specifies the SIP message header for which the normalization step is applicable. Examples include: From, To, Record-Route, Diversion, Request-URI, and P-Asserted-Identity.

first

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied only to the first occurrence.

last

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied only to the last occurrence.

all

Specifies that if there are multiple occurrences of a given header parameter, this normalization step is applied to all occurrences.

header-param-name

Specifies the header parameter name.

match-string

Specifies the regular expression string in the header parameter that will be matched. If all is chosen, the full header is replaced.

replace-string

Specifies the regular expression string in the header parameter that will replace the matched string.


Command Default

None

Command Modes

Cisco Unified SIP Proxy policy normalization configuration (cusp-config-norm)

Command History

Cisco Unified SIP Proxy Version
Modification

1.0

This command was introduced.


Usage Guidelines


Note This command requires that you use the commit command for the configuration changes to take effect.


Examples

The following example configures a normalization step that updates a header parameter to all occurrences of the Call-Info header where the header parameter "m" has a value of "XX":

se-10-0-0-0(cusp-config)> policy normalization p1
se-10-0-0-0(cusp-config-norm)> header-param-update update Call-Info all m XX