- 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
- 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-503
- server-group sip ping-options
- method (SIP server group ping-options)
- ping-type
- timeout
- show status server-group sip
Cisco Unified SIP Proxy SIP Server 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)
– lb-type
– method (SIP server group ping-options)
– timeout
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
Command Default
UDP is the default transport, and the default number of retries for UDP is 2.
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
The following example sets the retry value for UDP to the default value:
Related Commands
|
|
|
|---|---|
Configures the load balance value for all SIP server groups. |
|
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
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
The following example configures the load balancing algorithm for all global SIP server groups to be based on request URI:
The following example configures the load balancing algorithm for all global SIP server groups to the default value (request URI):
Related Commands
|
|
|
|---|---|
Configures the number of retries for a SIP server group element. |
|
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.
no server-group sip global-ping
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
Related Commands
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
Command Default
Command Modes
SIP server group configuration (cusp-config-sg)
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 creates an element to the server group with a q-value of 1.0 and a weight of 0 (the default value):
The following example creates an element to the server group using TCP with a q-value of 0.5 and a weight of 0:
The following example removes the element from the server group:
Related Commands
|
|
|
|---|---|
Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect. |
|
Creates a reference element for a SIP server group and determines its characteristics. |
|
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
Command Default
Command Modes
SIP server group configuration (cusp-config-sg)
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 the server group element to the group with a q-value of 1.0 and a weight of 0 (the default):
The following example adds the server group element to the group with a q-value of 0.5 and a weight of 0:
The following example removes the element from the server group:
Related Commands
|
|
|
|---|---|
Enables configuration changes for selected Cisco Unified SIP Proxy commands to take effect. |
|
Creates an IP element for a SIP server group and determines its characteristics. |
|
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 ]
Syntax Description
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
Command Modes
SIP server group configuration (cusp-config-sg)
Command History
|
|
|
|---|---|
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:
The following example configures the failover response code so that only 500 and 503 responses trigger failover to the next server group element:
The following example configures the failover response code so that no response codes trigger failover to the next server group element:
Related Commands
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
Command Default
Command Modes
SIP server group configuration (cusp-config-sg)
Command History
|
|
|
|---|---|
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:
The following example configures the load balancing algorithm for a SIP server group to request URI:
The following example configures the load balancing type for a SIP server group to weight-based routing:
The following example restores the load balancing type to the default value (global):
Related Commands
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.
Syntax Description
Command Default
Command Modes
SIP server group configuration (cusp-config-sg)
Command History
|
|
|
|---|---|
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:
The following example disables pinging on a server group:
Related Commands
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
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
|
|
|
|---|---|
Examples
The following example configures the retry timeout value for all SIP server groups to 6,000 milliseconds:
The following example returns the retry timeout value to 0 (the default):
Related Commands
|
|
|
|---|---|
Configures the number of retries for a SIP server group element. |
|
Configures the load balance value for all SIP server groups. |
|
server-group sip ping-503
To enable the use of ping-503 option to check whether the SIP application service in the remote server element is running or not, use the server-group sip ping-503 command in Cisco Unified SIP Proxy configuration mode. Cisco Unified SIP Proxy can identify the type of response from the remote server element and decrement the retry count if the response is 503. To restore the SIP ping 503 option to the default value, use the no form of this command.
Syntax Description
Command Default
Response 503 from any elements is treated as a successful response.
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to identify whether the sip element is down or not. If the server-group sip ping-503 command is not configured, the 503 response is treated as successful response. If this command is configured, Cisco Unified SIP Proxy considers the 503 response as remote element down. Ping 503 mode must first exist before you can use the no command.
Examples
The following example enables the server group sip ping 503 command:
Related Commands
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
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
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:
The following example sets all the ping options for the SIP server group named “internal” to the default values:
Related Commands
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.
Syntax Description
The request method for the SIP pings. The default value is OPTIONS. |
Command Default
Command Modes
SIP server group ping-options configuration (cusp-config-ping)
Command History
|
|
|
|---|---|
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):
The following example configures the SIP server group ping option method to PING:
The following example restores the SIP server group ping option method to the default value:
Related Commands
|
|
|
|---|---|
Configures the ping type and interval for a SIP server group. |
|
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 } interval_1 interval _ 2
Syntax Description
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
|
|
|
|---|---|
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:
The following example configures proactive pinging for the server group with a ping interval of 2,000 milliseconds:
The following example configures adaptive pinging for the server group with a ping interval of 2,000 milliseconds for down elements and 1,000 milliseconds for up elements:
The following example restores the default ping type values to the server group (reactive with an interval of 5,000 milliseconds:
Related Commands
|
|
|
|---|---|
Creates an IP element for a SIP server group and determines its characteristics. |
|
Configures the load balancing type for a single 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.
Syntax Description
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
Command Modes
Cisco Unified SIP Proxy SIP server group ping-options configuration (cusp-config-ping)
Command History
|
|
|
|---|---|
Examples
The following example configures the ping timeout interval for a SIP server group to 500 milliseconds:
The following example configures the ping timeout interval for a SIP server group to 1000 milliseconds:
The following example restores the ping timeout interval for a SIP server to the default value:
Related Commands
|
|
|
|---|---|
Configures the request method for the SIP server group pings. |
|
Configures the ping type and interval for a 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
(Optional) Displays the status of a single SIP server group. |
Command Modes
Cisco Unified SIP Proxy EXEC (cusp)
Command History
|
|
|
|---|---|
Examples
The following example shows sample output from the show status server-group sip command:
Table 1 describes the significant fields shown in the display.
Related Commands
|
|
|
|---|---|
Displays the status of all RADIUS server groups or a single RADIUS server group. |
Feedback