Availability: Since 4.2.1
pathCheckProfile entity specifies the conditions that constitute a connectivity failure, and in the event of such a failure, the conditions that constitute a connectivity recovery. See Path Check Support using SIP OPTIONS Ping for details.
After updating a Path Check Profile, you must disable and re-enable the profile for the change to take effect.
% set profiles services pathCheckProfile <profile name>
failureResponseCodes <400-699 | all |all4xx | all5xx | all6xx>
transportPreference <preference1 | preference2 | preference3 | preference4>
The Path Check Profile Parameters are defined below:
Table : Path Check Profile Parameter
<profile name> – The name of the Path Check Profile.
|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
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.
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 SIP ARS Profile (CLI).
The ping protocol type used.
The number of consecutive successful responses to occur before removing the endpoints from the Blacklist. (default = 6)
The number of consecutive timeouts to occur before adding the endpoints to the Blacklist. (default = 6)
Specifies interval (in seconds) in which the PING request will be sent out to the endpoints. (default = 60)
Transport preference for sending OPTIONS method.
preference1 – Default value is
preference2 – Default value is
preference3 – Default value is
preference4 – Default value is
Ensure SIP Sig Port
transportProtocolsAllowed setting is configured to support the chosen transport preference (see zone sipSigPort (CLI) page)
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
% set addressContext default zone defaultSigZone ipPeer
PEER-1 ipAddress 10.20.120.21 pathCheck profile PCP-1
% show addressContext default zone defaultSigZone ipPeer
To configure a single
failureResponseCodes value for a Path Check Profile:
% set profiles services pathCheckProfile PCP_1 failureResponseCodes 404
To set multiple
% set profiles services pathCheckProfile PCP_1 failureResponseCodes [ 404 503 all6xx ]
To delete a single
% delete profiles services pathCheckProfile PCP_1 failureResponseCodes all6xx
To delete all
% delete profiles services pathCheckProfile <pathCheckProfile_name> failureResponseCodes