Contents

Configuring Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints
Finding Feature Information
Troubleshooting Tips
Feature Information for Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints

Configuring Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints

Last Updated: December 20, 2011

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:

Table 1

Error Codes that busyout the endpoint

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.

Before You Begin

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.
- Dial-peer should be in active state
- Session protocol must be configured for SIP
- Configure Session target or outbound proxy must be configured. If both are configured, outbound proxy has preference over session target.

Cisco Unified Border Element

Cisco IOS Release 15.0(1)M or a later release must be installed and running on your Cisco Unified Border Element.

Cisco Unified Border Element (Enterprise)

Cisco IOS XE Release 3.1S or a later release must be installed and running on your Cisco ASR 1000 Series Router

Note

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.

SUMMARY STEPS

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

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Router> enable	Enables privileged EXEC mode. Enter your password if prompted.
Step 2	configure terminal Example: Router# configure terminal	Enters global configuration mode.
Step 3	dial-peer voice tag voip Example: Router(config)# dial-peer voice 200 voip	Enters dial-peer configuration mode for the VoIP peer designated by tag.
Step 4	voice-class sip options-keepalive {up-interval seconds \| down-interval seconds \| retry retries} Example: Router(config-dial-peer)# voice-class sip options-keepalive up-interval 12 down-interval 65 retry 3	Monitors connectivity between endpoints. up-interval seconds -- Number of up-interval seconds allowed to pass before marking the UA as unavailable.The range is 5-1200. The default is 60. down-interval seconds -- Number of down-interval seconds allowed to pass before marking the UA as unavailable.The range is 5-1200. The default is 30. retry retries -- Number of retry attempts before marking the UA as unavailable. The range is 1 to 10. The default is 5 attempts.
Step 5	exit Example: Router(config-dial-peer)# exit	Exits the current mode.

Finding Feature Information
Troubleshooting Tips
Feature Information for Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest feature information and caveats, see 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 at the end of this document.

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.

Troubleshooting Tips

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.

Router# 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

show dial-peer voice summary --shows Active or Busyout dial-peer status.

Router# 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

Feature Information for Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints

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.

Feature History Table entry for the Cisco Unified Border Element.

Table 2

Feature Information for Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints

Feature Name

Releases

Feature Information

Out-of-dialog OPTIONS Ping to Monitor Dial-peers to Specified SIP Servers and Endpoints

15.0(1)M

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.

The following command was introduced: voice-class sip options-keepalive

Feature History Table entry for the Cisco Unified Border Element (Enterprise).

Table 3

Feature Information for Cisco UBE Out-of-dialog OPTIONS Ping for Specified SIP Servers or Endpoints

Feature Name

Releases

Feature Information

Out-of-dialog OPTIONS Ping to Monitor Dial-peers to Specified SIP Servers and Endpoints

Cisco IOS XE Release 3.1S

The following command was introduced: voice-class sip options-keepalive

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.