In this section:
- To create ACL for ICMP, refer to Configuring Path Check Support Using ICMP Ping.
- To configure static routes, refer to Configuring Path Check Support Using ICMP Ping.
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
To update the Path Check Profile, you must:
- Disable the profile
- Apply updates
- Enable the profile
Changes will take effect when the profile has been re-enabled.
Note
The SBC determines the SRS reachability through the SIP ARS status. You must configure the Path Check Profile to determine the reachability of the SRS peers and treat a failure response, such as 501, as an 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> 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:
Path Check Profile Parameter
Parameter | Length/Range | Description |
|---|---|---|
| 1-23 |
|
| 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:
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. |
| 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 Note
This feature applies to the SBC Cloud Native edition (CNe) only. Modified: for 12.1.1 |
| N/A | The ping protocol type used.
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. |
| 1-10 | The number of consecutive successful responses to occur before removing the endpoints from the Blacklist. (default = 6) |
replyTimeout | 1-300 | The time interval (in seconds) to elapse, after which the ICMP PING request times out. (default = 1) NOTE: This parameter applies when |
| 1-10 | The number of consecutive timeouts to occur before adding the endpoints to the Blacklist. (default = 6) |
| 1-600 | Specifies interval (in seconds) in which the PING request will be sent out to the endpoints. (default = 60) |
transportPreference | N/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:
Defaults by preference:
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 the "defaultSigZone" zone using IP address "10.20.120.21" for the default address context.
% 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 []
To enable the InActivityMonitoringTimer:
% set profiles services pathCheckProfile PUBS_PCP InActivityMonitoringTimer 5
To disable the InActivityMonitoringTimer:
% delete profiles services pathCheckProfile PUBS_PCP InActivityMonitoringTimer 5
Overview
Content Tools