Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

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

Add_workflow_for_techpubs
AUTH1UserResourceIdentifier{userKey=8a00a0c87e188912017e4c24a00e0016, userName='null'}
JIRAIDAUTHSBX-129977
REV5UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cd5909df, userName='null'}
REV6UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cd5909df, userName='null'}
REV3UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cdec0ad4, userName='null'}
REV1UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26ca3103e5, userName='null'}
REV2UserResourceIdentifier{userKey=8a00a02355cd1c2f0155cd26cd3d099d, userName='null'}



Panel

In this section:

Table of Contents
maxLevel4



Info
iconfalse

Related articles:



Info



The Path Check Profile specifies Profile specifies the conditions that constitute a connectivity failure and, 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.

Info
titleNote

After updating a To update the Path Check Profile, you must disable and re-enable :

  1. Disable the profile
  2. Apply updates
  3. Enable the profile 

Changes will take effect when the profile has been re-enabled for the change to take effect.

Include Page
_SRS_Reachability
_SRS_Reachability

Include Page
_Path_Check_Profile_vs_ARS_Profile
_Path_Check_Profile_vs_ARS_Profile

Command Syntax

Code Block
languagenone
% set profiles services pathCheckProfile <profile name> 
	failureResponseCodes <400-699 | all |all4xx | all5xx | all6xx>
 	InActivityMonitoringTimer <0-600>
	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:

Caption
0Table
1Path Check Profile Parameter


 – code, or separating

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
  • separate 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.

InActivityMonitoringTimer

0 - 600

The interval timer parameter stops the endpoint's OPTION ping for a duration configured under this field when there is SIP traffic from the endpoint. If the timer is set to 0, the OPTiON ping won't be paused for that Path Check Profile. If the interval has a non-zero value, the SBC CNe checks the activity status after the expiry of the interval period.

The recommended value is 4 to 5 times the sendInterval parameter value.

Include Page
_CNe only
_CNe only

Available_since
TypeAvailable Since
Release12.1.1


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 the 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).

Include Page
_Controlling transport protocols for SIP
_Controlling transport protocols for SIP



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 the "defaultSigZone" zone for default address context using IP address "10.20.120.21" for the default address context.

Code Block
languagenone
% 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:

Code Block
languagenone
% set profiles services pathCheckProfile PCP_1 failureResponseCodes 404


To set multiple failureResponseCodes values:

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


To delete a single failureResponseCodes value:

Code Block
languagenone
% delete profiles services pathCheckProfile PCP_1 failureResponseCodes all6xx


To delete all failureResponseCodes values:

Code Block
languagenone
% delete profiles services pathCheckProfile <pathCheckProfile_name> failureResponseCodes []


To enable the InActivityMonitoringTimer:

Code Block
% set profiles services pathCheckProfile PUBS_PCP InActivityMonitoringTimer
pagebreak
5


To disable the InActivityMonitoringTimer:

Code Block
% delete profiles services pathCheckProfile PUBS_PCP InActivityMonitoringTimer 5