Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Caption
0Table
1SIP ARS Profile Parameters
 

Parameter

Length/Range

Description

sipArsProfile

1-23

<profile name> – The name of the SIP Address Reachability Service profile.

blkListAlgRetryAfterType

N/A

Use to specify the SIP status code type which includes a 'Retry-After' value (currently, the only supported value is sip-503).

  • sip-503 – When a SIP 503 message is received with Retry-After field from downstream server, this option puts that server into blacklist to prevent new call requests (SIP INVITEs) from retransmitting, and starts a Recovery Algorithm to recover the server from blacklist after the duration specified in the Retry-After header contained in the received SIP 503 message.

blkListAlgTimeoutsDuration

1-3600

Duration (in seconds) in which the specified number of timeouts must occur. (default = 1).

blkListAlgTimeoutsNumTimeouts

1-3600

The number of timeout events for a single INVITE transaction (including any retransmissions) before black listing the address. (default = 1).

blkListAlgTimeoutsType

N/A

The timeout trigger type (currently, only sip-invite is available):

  • sip-invite – Use SIP INVITE messages as a timeout trigger.

blkListAlgorithms

N/A

Identifies blacklisting algorithm to use for this ARS Profile. Select one or both.

  • retryafter – Use the blkListAlgRetryAfterType (trigger) as the blacklisting criteria.
  • timeouts (default) – Use the timeout of the specified SIP message for blacklisting the server. The objects blkListAlgTimeoutsType, blkListAlgTimeoutsNumTimeouts, and blkListAlgTimeoutsDuration must also be specified.
failureResponseCodes

400-699, or
(all, all4xx, all5xx, all6xx)

Use this parameter to define one or more response codes to treat as failure responses. The options include the following:

  • 400-699 – Enter a single code, or enter multiple codes within square brackets and separating each entry with a space. For example, [409 505 699]
  • 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 codes
Info

When you use more than one value, enclose the values in square brackets [ ], separating each value with a space. Entering  a value without using brackets appends the value to the existing configuration.

Note

Ensure failureResponseCodes values for Path Check Profile and SIP ARS Profile within the same zone/trunk group use similar values to avoid unexpected behavior. For example, it is not advisable to set Path Check Profile failureResponseCode to "all" and SIP ARS Profile failureResponseCodes to "all4xx" and "all6xx". See Path Check Profile (CLI).

recoveryAlgProbeDuration

1-3600

Duration (in seconds) in which the specified number of responses must occur. (default = 1).

recoveryAlgProbeInterval

1-600

The probe interval value, in seconds. (default = 1).

recoveryAlgProbeMethod

N/A

Specifies the probe method (currently, only sip-options is available).

  • sip-options

recoveryAlgProbeNumResponses

1-32

The number of consecutive responses to occur before removing an entry from the black list. (default = 1).

recoveryAlgTimerDuration

1-3600

Duration (in seconds) that the IP address remains blacklisted. (default = 1).

recoveryAlgorithm

N/A

The recovery algorithm to use once the peer is blacklisted.

  • probe (default) – The ARS initiates an active "ping" to the blacklisted server until it gets a response. Once the number of consecutive responses are received as defined by the recoveryAlgProbeNumResponses parameter, the address is removed from the blacklist.
  • timer – The ARS removes the entry for the blacklist after a configured duration.

Command Examples

The following example configures a SIP ARS profile named "ARSPROFILE1" using the various objects and parameters.

...