- Using Cisco Unified SIP Proxy Software
- Cisco Unified SIP Proxy Module EXEC Commands
- Cisco Unified SIP Proxy EXEC Commands
- Cisco Unified SIP Proxy Configuration Commands
- Cisco Unified SIP Proxy SIP Commands
- Cisco Unified SIP Proxy SIP Server Commands
- Cisco Unified SIP Proxy Radius Server Commands
- Cisco Unified SIP Proxy Trigger Commands
- Cisco Unified SIP Proxy Route Commands
- Cisco Unified SIP Proxy Policy Commands
- Cisco Unified SIP Proxy Accounting Commands
- Cisco Unified SIP Proxy Security Commands
- Module Commands for Cisco Unified SIP Proxy
Cisco Unified SIP Proxy Route Commands
–
key route-uri target-destination
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
Specifies the route table name as configured using the route table command. |
|
Specifies the file you are loading the route information from. The file path must start with pfs:/cusp/routes/. |
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
Usage Guidelines
– In Cisco Unified SIP Proxy Release 1.1.x, a route table can consist of either routes loaded from a file using this command or routes configured using the route table submode commands, but a route table cannot be mixed with routes loaded from a file and configured on the system.
– In Cisco Unified SIP Proxy Release 8.5 and later versions, after you use this command, you are put into route submode. Therefore, after you load routes from the file, you can make further changes to the route table. You can now have a route table that consists of both routes loaded from a file and routes configured on the system.
– In Cisco Unified SIP Proxy Release 1.1.x, the file that you uploaded must remain in that location or else the system will lose the route configuration upon reboot.
– In Cisco Unified SIP Proxy Release 8.5 and later versions, you do not need to keep the file in that location.
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:
The following example deletes the route table:
Related Commands
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.
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
The following example deletes the route table:
Related Commands
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.
Syntax Description
Specifies the name of the SIP network associated with this route (previously configured using the sip network command). |
Command Default
Command Modes
Route table configuration (cusp-config-rt)
Command History
|
|
|
|---|---|
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:
The following example removes the lookup key from the route table:
Related CommandsTBD
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
Syntax Description
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. |
|
Command Default
Command Modes
Route table configuration (cusp-config-rt)
Command History
|
|
|
|---|---|
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:
The following example removes the lookup key from the route table:
Related Commands
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.
no key key policy route-policy
Syntax Description
Command Default
Command Modes
Route table configuration (cusp-config-rt)
Command History
|
|
|
|---|---|
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:
The following example removes the lookup key from the route table:
Related Commands
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
Command Default
Command Modes
Route table configuration (cusp-config-rt)
Command History
|
|
|
|---|---|
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:
The following example removes the lookup key from the route table:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy route table configuration (cusp-config-rt)
Command History
|
|
|
|---|---|
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:
The following example removes the lookup key from the route table:
Related Commands
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
Command Default
Command Modes
Route table configuration (cusp-config-rt)
Command History
|
|
|
|---|---|
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:
The following example removes the lookup key from the route table:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
The following example creates a route group using weight-based routing:
The following example creates a route group using both time-based and weight-based routing:
The following example deletes a route group:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy route group configuration (cusp-config-rg)
Command History
|
|
|
|---|---|
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:
The following example removes a route-URI element from a route group:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy route group configuration (cusp-config-rg)
Command History
|
|
|
|---|---|
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:
The following example removes a route-URI element from a route group:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy route group configuration (cusp-config-rg)
Command History
|
|
|
|---|---|
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:
The following example removes a target destination element from a route group:
Related Commands
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 ]
Syntax Description
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
Command Modes
Element configuration (cusp-config-rg-element)
Command History
|
|
|
|---|---|
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:
The following example adds response codes to a route-URI element in a route group:
The following example removes the failover codes from the route-URI element:
Related CommandsTBD
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.
Syntax Description
Command Default
Command Modes
Element configuration (cusp-config-rg-element)
Command History
|
|
|
|---|---|
Examples
The following example configures a time policy for a route-URI element:
The following example removes the time policy from the element route-URI:
Related CommandsTBD
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.
Syntax Description
Command Default
Command Modes
Element configuration (cusp-config-rg-element)
Command History
|
|
|
|---|---|
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:
The following example removes the weight value from the element route-URI:
Feedback