Service Profiles - SIP ARS Profile

Name

Specifies the name of the SIP ARS Profile.

Use this parameter to define one or more response codes to treat as failure responses. Include one or more of the following values, separating each entry with a comma:

- 400-699 - list codes individually

- all – include all response codes from 400-699

- all4xx – include all 4xx response codes

- all5xx – include all 5xx response codes

- all6xx – include all 6xx response.

Note: Ensure that Failure Response Codes values for a Path Check Profile and a SIP ARS Profile within the same zone/trunk group use similar values to avoid unexpected behavior. For example, it is not advisable to set the Path Check Profile Failure Response Codes to "all" and the SIP ARS Profile Failure Response Codes to "all4xx" and "all6xx."

Note: In the EMA UI, configure Failure Response Codes as comma separated values. In the CLI, Failure Response Code values are separated by spaces.

Blk List
Algorithms

Specifies the blacklisting algorithm to use for the ARS Profile. Any combination of algorithms can be specified for a profile. The options are:

• timeouts (default) - use the number of timeout responses to the specified SIP message type (Blk List Alg Timeouts Type) to trigger blacklisting the server. Blk List Alg Timeouts Type, Blk List Alg Timeouts Num Timeouts, and Blk List Alg Timeouts Duration must also be specified.

• retryafter - use to specify that when a message of the type specified by Blk List Alg Retry After Type is received with Retry-After field from a downstream server, this option puts that server into blacklist to prevent sending new call requests for the duration specified in the Retry-After header.
• noretryafter - use to trigger blacklisting when a peer endpoint sends SIP 503 responses without a Retry After header at a rate that exceeds a number defined by Blk List Alg No Retry After Num503 within the time interval defined by Blk List Alg No Retry After Duration.

Blk List Alg
Timeouts Type

Specifies the message type to use in conjunction with the timeouts blacklisting algorithm:
• SIP -invite—use SIP INVITE messages as a timeout trigger.

Blk List Alg Timeouts Duration

Specifies the duration (in seconds) in which the specified number of timeouts should occur. Must be 1-3600. SIP-INVITE timeout is the only event that is currently supported.

Use this parameter to specify the SIP request types to retry after blacklist algorithm.

The options include:

• sip-invite (default)
• sip-register
• sip-subscribe
• sip-notify
• sip-options
• sip-message
• sip-publish 
• sip-info
• sip-refer

Blk List Alg Retry After Type

Specifies the SIP status code which has a Retry After value:
• sip-503

Specifies the type of recovery algorithm for the endpoints blacklisted with timeouts algorithm.

• None - use the recovery algorithm specified in the ARS profile.
• Probe - use probe as recovery algorithm for the endpoints blacklisted with the timeouts algorithm.
• Timer - use timer as the recovery algorithm for the endpoints blacklisted with the timeouts algorithm.

Note: When the flag is set to None, the SBC continues with the default behavior which is specified by the Recovery Algorithm option.

Specifies the type of recovery algorithm for the endpoints blacklisted with the noretryafter algorithm.

• None - use the recovery algorithm specified in the ARS profile.
• Probe - use probe as the recovery algorithm for the endpoints blacklisted with the noretryafter algorithm.
• Timer - use timer as the recovery algorithm for the endpoints blacklisted with the noretryafter algorithm.
  
  

Note: When the flag is set to None, the SBC continues with the default behavior specified by the Recovery Algorithm option.

Use this parameter to control when to apply ARS screening to a mid-dialog request.

• Always - ARS is applied to all mid-dialog requests in a call.
• Never (default) - ARS is not applied to mid-dialog requests.
• Only If Not Black List Due to 503 - ARS is applied to mid-dialog requests unless blacklisting due to 503 is encountered.

Recovery
Algorithm

Specifies the type of recovery algorithm used after an IP address has been blacklisted:
• Probe (default) - the ARS initiates an active "ping" to the blacklisted server until it gets a response. Once a response is received, the address is removed from the blacklist. The Probe Method, Probe Interval, Probe Num Responses, and Probe Duration attributes for the recovery algorithm must also be specified.
• Timer - the ARS removes the blacklist entry after the configured Timer Duration.

Recovery Alg
Timer Duration

Specifies the duration (in seconds), for which the IP address will remain blacklisted when Timer is the recovery algorithm. Must be 1-3600.

Recovery Alg
Probe Method

Specifies the probe recovery algorithm (ping) method for blacklist recovery:
• SIP -options—use a SIP OPTIONS request

Recovery Alg
Probe Interval

Specifies the probe recovery algorithm interval (in seconds) for blacklist recovery. Must be 1 - 600 (default is 1).

Recovery Alg Probe Num Responses

Specifies the number of consecutive responses that must occur before removing an entry from the blacklist when Probe is the recovery algorithm. Must be 1 - 32 (default is 1).

Recovery Alg
Probe Duration

Specifies the probe recovery algorithm duration (in seconds) during which the specified number of probe responses must occur to remove the IP address from the blacklist. Must be 1-3600 (default is 1).