In this section:

Related articles:



The Path Check Profile specifies the conditions that constitute a connectivity failure, and in the event of such a failure, the conditions that constitute a connectivity recovery. This section describes the CLI syntax, parameter descriptions and command examples. 

Refer to Path Check Support for additional feature details.

Note

After updating a Path Check Profile, you must disable and re-enable the profile for the change to take effect.


Note

From 6.2.0 release onward, the SBC determines the SRS reachability only through the SIP ARS status. The pathCheckProfile must be configured to determine the reachability of the SRS peers and treat failure response such as 501 as OPTIONS failure.


Note

Ribbon recommends to not configure Path Check Profile and SIP ARS Profile on the same peer to avoid unexpected results. As a general rule, the Path Check Profile is configured on the access leg where there is less traffic, and the ARS Profile is configured on the peer leg where there is continuous traffic. 

Command Syntax

% set profiles services pathCheckProfile <profile name> 
	failureResponseCodes <400-699 | all |all4xx | all5xx | all6xx>
	protocol <icmp | sipOptions>
	recoveryCount <1-10>
	replyTimeoutCount <1-10>
	sendInterval <1-600>
	transportPreference <preference1 | preference2 | preference3 | preference4>

Command Parameters

The Path Check Profile parameters are defined below:

Path Check Profile Parameter

Parameter

Length/Range

Description

pathCheckProfile

1-23

<profile name> – The name of the Path Check Profile.

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". Refer to SIP ARS Profile - CLI.

protocol

N/A

The ping protocol type used.

  • icmp – Internet Control Message Protocol (ICMP)
  • sipOptions (default)

NOTE: Create a user ACL for ICMP if there are more than 50 sessions to support.

NOTE: Configure static routes to reach the target IP from interface through which the ICMP pings are generated.

recoveryCount

1-10

The number of consecutive successful responses to occur before removing the endpoints from the Blacklist. (default = 6)

replyTimeout1-300

The time interval (in seconds) to elapse after which the ICMP PING request times out. (default = 1)

NOTE: This parameter applies when protocol = icmp.

replyTimeoutCount

1-10

The number of consecutive timeouts to occur before adding the endpoints to the Blacklist. (default = 6)

sendInterval

1-600

Specifies interval (in seconds) in which the PING request will be sent out to the endpoints. (default = 60)

transportPreferenceN/A

Transport preference for sending OPTIONS method.

Note: A good practice is to configure separate pathCheckProfiles for each transport type; each profile having only preference1 set. By assigning a pathcheck profile with a transport type matching an ipPeer's transport type, you will ensure that SBC will not send SIP OPTIONS ping over a protocol that a particular ipPeer does not support.

 Possible completions:

  • none
  • sctp
  • tcp
  • tls-tcp
  • udp

Defaults by preference:

  • preference1 – Default value is sip-udp
  • preference2 – Default value is sip-tcp
  • preference3 – Default value is tls-tcp
  • preference4 – Default value is sctp

Note: Ensure that the SIP Sig Port transportProtocolsAllowed setting is configured to support the chosen transport preference (refer to Zone - SIP Sig Port - CLI page).


To learn more about the various methods of controlling transport protocols for SIP signaling and how these work together, refer to Controlling SBC Core Transport Protocols for SIP Signaling.



Command Examples

This example creates a patch check profile named "PCP-1" with the default ping protocol type "sipOptions", a recovery count of "7" and a send interval of "120" seconds. The reply timeout count is left at the default of "6". Next, the PCP is assigned to "defaultSigZone" zone for default address context using IP address "10.20.120.21".

% set profiles services pathCheckProfile PCP-1 protocol 
	sipOptions recoveryCount 7 sendInterval 120 
% show profiles services pathCheckProfile PCP-1 
	protocol sipOptions; 
	sendInterval 120; 
	recoveryCount 7; 

% set addressContext default zone defaultSigZone ipPeer 
	PEER-1 ipAddress 10.20.120.21 pathCheck profile PCP-1 
	state enabled 
% show addressContext default zone defaultSigZone ipPeer 
	PEER-1 
	ipAddress 10.20.120.21; 
	pathCheck { 
		profile PCP-1; 
		state enabled; 
}


To configure a single failureResponseCodes value for a Path Check Profile:

% set profiles services pathCheckProfile PCP_1 failureResponseCodes 404


To set multiple failureResponseCodes values:

% set profiles services pathCheckProfile PCP_1 failureResponseCodes [ 404 503 all6xx ]


To delete a single failureResponseCodes value:

% delete profiles services pathCheckProfile PCP_1 failureResponseCodes all6xx


To delete all failureResponseCodes values:

% delete profiles services pathCheckProfile <pathCheckProfile_name> failureResponseCodes []

  • No labels