The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Cisco Unified Border Element Out-of-dialog (OOD) Options Ping feature provides a keepalive mechanism at the SIP level between any number of destinations.
Your software release may not support all the features documented in this module. For the latest caveats and feature information, see Bug Search Tool and the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the feature information table.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.
The following are required for OOD Options ping to function. If any are missing, the Out-of-dialog (OOD) Options ping will not be sent and the dial peer is reset to the default active state.
The Cisco Unified Border Element OOD Options ping feature can only be configured at the VoIP Dial-peer level.
All dial peers start in an active (not busied out) state on a router boot or reboot.
If a dial-peer has both an outbound proxy and a session target configured, the OOD options ping is sent to the outbound proxy address first.
Though multiple dial-peers may point to the same SIP server IP address, an independent OOD options ping is sent for each dial-peer.
If a SIP server is configured as a DNS hostname, OOD Options pings are sent to all the returned addresses until a response is received.
Configuration for Cisco Unified Border Element OOD and TDM Gateway OOD are different, but can co-exist.
The Out-of-dialog (OOD) Options Ping feature provides a keepalive mechanism at the SIP level between any number of destinations. A generic heartbeat mechanism allows Cisco Unified Border Element to monitor the status of SIP servers or endpoints and provide the option of busying-out a dial-peer upon total heartbeat failure. When a monitored endpoint heartbeat fails, the dial-peer is busied out. If an alternate dial-peer is configured for the same destination pattern, the call is failed over to the next preferred dial peer, or else the on call is rejected with an error cause code.
The table below describes error codes option ping responses considered unsuccessful and the dial-peer is busied out for following scenarios:
Error Code |
Description |
---|---|
503 |
service unavailable |
505 |
sip version not supported |
no response |
i.e. request timeout |
All other error codes, including 400 are considered a valid response and the dial peer is not busied out.
Note | The purpose of this feature is to determine if the SIP session protocol on the endpoint is UP and available to handle calls. It may not handle OPTIONS message but as long as the SIP protocol is available, it should be able to handle calls. |
When a dial-peer is busied out, Cisco Unified Border Element continues the heartbeat mechanism and the dial-peer is set to active upon receipt of a response.
1.
enable
2.
configure
terminal
3.
dial-peer
voice
tag
voip
4.
voice-class
sip
options-keepalive
{up-interval
seconds |
down-interval
seconds |
retry
retries}
5.
exit
The following commands can help troubleshoot the OOD Options Ping feature:
debug ccsip all --shows all Session Initiation Protocol (SIP)-related debugging.
show dial-peer voice x --shows configuration of keepalive information.
Device# show dial-peer voice | in options voice class sip options-keepalive up-interval 60 down-interval 30 retry 5 voice class sip options-keepalive dial-peer action = active
Device# show dial-peer voice summary AD PRE PASS TAG TYPE MIN OPER PREFIX DEST-PATTERN KEEPALIVE 111 voip up up 0 syst active 9 voip up down 0 syst busy-out
The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.
Feature Name |
Releases |
Feature Information |
---|---|---|
Out-of-dialog OPTIONS Ping to Monitor Dial-peers to Specified SIP Servers and Endpoints |
15.0(1)M 12.4(22)YB |
This feature provides a keepalive mechanism at the SIP level between any number of destinations. The generic heartbeat mechanism allows Cisco UBE to monitor the status of SIP servers or endpoints and provide the option of busying-out associated dial-peer upon total heartbeat failure. In Cisco IOS Release 15.0(1)M, this feature was implemented on the Cisco Unified Border Element. The following command was introduced: voice-class sip options-keepalive |
Out-of-dialog OPTIONS Ping to Monitor Dial-peers to Specified SIP Servers and Endpoints |
Cisco IOS XE Release 3.1S |
This feature provides a keepalive mechanism at the SIP level between any number of destinations. The generic heartbeat mechanism allows Cisco UBE to monitor the status of SIP servers or endpoints and provide the option of busying-out associated dial-peer upon total heartbeat failure. In Cisco IOS XE Release 3.1S, this feature was implemented on the Cisco Unified Border Element (Enterprise). The following command was introduced: voice-class sip options-keepalive |