Cisco UBE Support for Configuring Error Response Code in OPTIONS Ping

Available Languages

Download Options

  • PDF     (77.3 KB)
    View with Adobe Reader on a variety of devices
Updated:October 29, 2010

Bias-Free Language

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.

Cisco Unified Border Element Support for Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure

Table Of Contents

Cisco Unified Border Element Support for Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure

Prerequisites

Restrictions

Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure at the Global Level

Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure at the Dial Peer Level

Troubleshooting Tips


Cisco Unified Border Element Support for Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure

Cisco Unified Border Element (Cisco UBE) provides an option to configure the error response code when a dial peer is busied out because of an Out-of-Dialog OPTIONS ping failure.

The OPTIONS ping mechanism monitors the status of a remote Session Initiation Protocol (SIP) server, proxy or endpoints. Cisco UBE monitors these endpoints periodically. When there is no response from these monitored endpoints, the configured dial peer is busied out. If the dial-peer endpoint is busied out due to an OPTIONS ping failure, the call is passed on to the next dial-peer endpoint if an alternate dial peer is configured for the same destination. Otherwise the error response 404 is sent. This feature provides the option of configuring the error response code to reroute the call. Therefore when a dial peer is busied out due to the OPTIONS ping failure, the SIP error code configured in the inbound dial-peer is sent as a response.

To configure the SIP error code response, perform the following tasks:

•Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure at the Global Level (required)

•Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure at the Dial Peer Level (required)

•Troubleshooting Tips

Prerequisites

•The Cisco UBE Out-of-Dialog (OOD) OPTIONS Ping for Specified SIP Servers or Endpoints feature should be configured before configuring this error response code for a ping OPTIONS failure.

Cisco Unified Border Element

•Cisco IOS Release 15.1(1)T 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.

Restrictions

The error code configuration will not have any effect if it is configured on the outbound dial peer.

Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure at the Global Level

Table 1 describes the SIP error codes.

Table 1 SIP Error Codes 

Error Code Number
Description

400

Bad Request

401

Unauthorized

402

Payment Required

403

Forbidden

404

Not Found

408

Request Timed Out

416

Unsupported URI

480

Temporarily Unavailable

482

Loop Detected

484

Address Incomplete

486

Busy Here

487

Request Terminated

488

Not Acceptable Here

500-599

SIP 5xx—Server/Service Failure

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

600-699

SIP 6xx—Global Failure


To configure the error response code for the OPTIONS ping failure to support the Cisco Unified Border Element at the global level, perform the steps in this section.

SUMMARY STEPS

1. enable

2. configure terminal

3. voice service voip

4. sip

5. error-code-override options-keepalive failure sip-status-code-number

6. end

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 

voice service voip

Example:

Router(config)# voice service voip

Enters voice service configuration mode.

Step 4 

sip

Example:

Router(conf-voi-serv)# sip

Enters voice service SIP configuration mode.

Step 5 

error-code-override options-keepalive failure sip-status-code-number

Example:

Router(conf-serv-sip)# error-code-override options-keepalive failure 402

Configures the specified SIP error code number.

•sip-status-code-number —SIP status code to be sent for an options keepalive failure. Range: 400 to 699. Default: 503.

•Table 1 provides more details about these error codes.

Step 6 

end

Example:

Router(conf-serv-sip)# end

Exits voice service SIP configuration mode and returns to privileged EXEC mode.

Configuring an Error Response Code upon an Out-of-Dialog OPTIONS Ping Failure at the Dial Peer Level

To configure the error response code for the OPTIONS ping failure to support the Cisco Unified Border Element at the dial-peer level, perform the steps in this section.

SUMMARY STEPS

1. enable

2. configure terminal

3. dial-peer voice voice-dial-peer-tag voip

4. voice-class sip error-code-override options-keepalive failure {sip-status-code-number | system}

5. end

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 voice-dial-peer-tag voip

Example:

Router(config)# dial-peer voice 234 voip

Enters dial peer voice configuration mode.

Step 4 

voice-class sip error-code-error-override options-keepalive failure {sip-status-code-number | system}

Example:

Router(config-dial-peer)# voice-class sip error-code-override options-keepalive failure 500

Configures the specified SIP error code number.

•sip-status-code-number —SIP status code to be sent for an options keepalive failure. Range: 400 to 699. Default: 503.

•Table 1 provides more details about these error codes.

Note If the system keyword is configured, the global level configuration will override the dial-peer configuration.

Step 5 

end

Example:

Router(config-dial-peer)# end

Exits dial peer voice configuration mode and returns to privileged EXEC mode.

Troubleshooting Tips

The following debug commands display any error that occurs with the error code response:

•debug ccsip messages—shows SIP messages. 

Router# debug ccsip messages


SIP Call messages tracing is enabled

•debug ccsip all—shows all SIP-related debugging. 

Router# debug ccsip all


This may severely impact system performance. Continue? [confirm]

All SIP Call tracing is enabled

Was this Document Helpful?

FeedbackFeedback

Contact Cisco