| User Data Repository Diameter User's Guide Release 12.4 E92984-01 |
|
 Previous |
 Next |
Table 3-29 describes the fields on the Routing Option Sets View, Edit, and Insert pages. Data input notes apply only to the Insert and Edit pages; the View page is read-only.
Table 3-29 Routing Option Sets Elements
| Field (* indicates required field) | Description | Data Input Notes |
|---|---|---|
| * Routing Options Set Name | Unique name of the Routing Option Set. | Case-sensitive string: alphanumeric and underscore (_); must contain at least one alpha and cannot begin with a digit. Range: 1 - 32 characters |
| * Maximum Per Message Forwarding Allowed | Maximum number of times an application is allowed to forward a request message. If the maximum per message forwarding allowed value is set to 1, the transaction lifetime field is disabled. If the maximum per message forwarding allowed value is greater than 1, the transaction lifetime field is enabled. |
Format: numeric Range: 1 - 5 Default: 1 |
| Transaction Lifetime | The total time diameter allows to forward a request, including initial and all subsequent routing attempts. This must be greater or equal to pending answer timer. |
Format: numeric Range: 100 - 540000 Default: 1000 |
| Pending Answer Timer | If the pending answer timer value is not selected, the egress peer node's associated pending answer timer, if it is defined, is used when processing transactions. A pending answer timer cannot be assigned to the default routing option set. |
Format: List Range: Default, configured Pending Answer Timers Default: Not Selected. |
| * Resource Exhausted Action | Action taken when a request cannot be processed due to an internal resource being exhausted. If set to abandon with no answer the, resource exhausted answer result code, resource exhausted error message, and resource exhausted vendor ID fields are disabled. If set to send answer the, resource exhausted answer result code, resource exhausted error message, and resource exhausted vendor ID fields are enabled. |
Format: List Range: Abandon with no Answer; Send Answer Default: Abandon with no Answer |
| Resource Exhausted Result-Code | Value to be placed in the result code AVP of the answer message. Answer result code value is required if action is send answer. If the resource exhausted action is set to abandon with no answer, the resource exhausted result code field is disabled. |
Format: options
Default: 3004_TOO_BUSY |
| Resource Exhausted Answer Error-Message | String to be placed in the error message AVP of the answer message for resource exhaustion. If the resource exhausted action is set to abandon with no answer, the resource exhausted error message is disabled. |
Format: text box Range: 0 - 64 characters Default: Null string, no Error-Message AVP in Answer message |
| Resource Exhausted Vendor-ID | Vendor ID value returned in an answer message when a message is not successfully routed due to resource exhausted vendor ID. If vendor ID is set to zero, then a result code AVP is sent. If vendor ID is greater than zero, then the grouped experimental result AVP is sent containing a vendor ID AVP (set to this value) and experimental result code set to the resource exhausted result code. If the resource exhausted action is set to abandon with no answer, the resource exhausted vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
| * No Peer Response Action | Action taken when the routing of a request is abandoned due to an answer timeout or transaction lifetime timeout. If the no peer response action is set to abandon with no answer, the no peer response answer result code, the no peer response error message, and the no peer response vendor ID fields are disabled. If the no peer response action is set to send answer, the no peer response answer result code, the no peer response error message, and the no peer response vendor ID fields are enabled. |
Format: List Range: Abandon with no Answer; Send Answer Default: Send Answer |
| No Peer Response Result-Code | Value to be placed in the result code AVP of the answer message. Answer result code value is required if action is send answer. If the no peer response action is set to abandon with no answer, the no peer response answer result code field is disabled. |
Format: options
Default: 3002_UNABLE_TO_DELIVER |
| No Peer Response Error-Message | String to be placed in the error message AVP of the answer message for no peer response. If the no peer response action is set to abandon with no answer, the no peer response answer error message field is disabled. |
Format: text box Range: 0 - 64 characters Default: Null string, no Error-Message AVP in Answer message |
| No Peer Response Vendor-ID | Vendor ID value returned in an answer message when a message is not successfully routed due to no peer response. When specified, the answer generated is an experimental result code grouped AVP with the specified vendor ID value placed in the vendor ID AVP. If the no peer response action is set to abandon with no answer, the no peer response answer vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
| * Connection Failure Action | Action taken when the routing of a request is abandoned when the last egress connection selection fails. If the connection failure action is set to abandon with no answer, the connection failure answer result code, the connection failure answer error message, and the connection failure vendor ID fields are disabled. If the connection failure action is set to send answer, the connection failure answer result code, the connection failure answer error message, and the connection failure vendor ID fields are enabled. |
Format: List Range: Abandon with no Answer; Send Answer Default: Send Answer |
| Connection Failure Result-Code | Value to be placed in the result code AVP of the answer message. Answer result code value is required if action is send answer. If the connection failure action is set to abandon with no answer, the connection failure answer result code field is disabled. |
Format: options
Default: 3002 UNABLE_TO_DELIVER |
| Connection Failure Answer Error-Message | String to be placed in the error message AVP of the answer message for connection failure. If the connection failure action is set to abandon with no answer, the connection failure answer error message field is disabled. |
Format: text box Range: 0 - 64 characters Default: Null string, no Error-Message AVP in Answer message |
| Connection Failure Vendor-ID | Vendor ID value returned in an answer message when a message is not successfully routed due to connection failure. When specified, the answer generated is an experimental result code grouped AVP with the specified vendor ID value placed in the vendor ID AVP. If the connection failure action is set to abandon with no answer, the connection failure vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
| * Connection Congestion Action | Action taken when the routing of a request is abandoned because the last connection evaluated is congested. If the connection congestion action is set to abandon with no answer, the connection congestion result code, the connection congestion answer error message, and the connection congestion vendor ID fields are disabled. If the connection congestion action is set to send answer, the connection congestion answer result code Value, the connection congestion answer error message, and the connection congestion vendor Id fields are enabled. |
Format: List Range: Abandon with no Answer; Send Answer Default: Send Answer |
| Connection Congestion Result-Code | Value to be placed in the result code AVP of the answer message when a message is not successfully routed due to connection congestion. Answer result code value is required if action is send answer. If the connection congestion action is set to abandon with no answer, the connection congestion result code field is disabled. |
Format: options
Default: 3002 UNABLE_TO_DELIVER |
| Connection Congestion Answer Error-Message | String to be placed in the error message AVP of the answer message for connection congestion. If the connection congestion action is set to abandon with no answer, the connection congestion answer error message field is disabled. |
Format: text box Range: 0 - 64 characters Default: Null string, no Error-Message AVP in Answer message |
| Connection Congestion Vendor-ID | Vendor ID value returned in an answer message when a message is not successfully routed due to connection congestion. When specified, the answer generated is an experimental result code grouped AVP with the specified vendor ID value placed in the vendor ID AVP. If the connection congestion action is set to abandon with no answer, the connection congestion vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
| * Destination-Realm Not Served Action | Action taken when routing of a request is abandoned due to destination realm implicit routing failure to find a (Realm/Application-ID) match in the realm route table for routing the transaction. If the destination realm not served action is set to abandon with no answer, the destination realm not served result code, destination realm not served error message, and destination realm not served vendor ID fields are disabled. If the destination realm not served action is set to send answer, the destination realm not served result code, destination realm not served error message, and destination realm not served vendor ID fields are enabled. |
Format: List Range: Send Answer, Abandon with no Answer Default: Send Answer |
| Destination-Realm Not Served Result-Code | Value to be placed in the result code AVP of the answer message. Answer result code value is required if action is send answer. If the destination realm not served action is set to abandon with no answer, the destination realm not served result code field is disabled. |
Format: options
Default: 3003 REALM_NOT_SERVED |
| Destination-Realm Not Served Error-Message | String to be placed in the error message AVP of the answer message for destination realm not served. If the destination realm not served action is set to abandon with no answer, destination realm not served error message field is disabled. |
Format: numeric Range: 0 - 64 characters Default: none |
| Destination-Realm Not Served Vendor-ID | Vendor ID value returned in an answer message when a message is not successfully routed due to destination realm not served. When specified, answer generated is experimental result code grouped AVP with vendor ID value specified placed in vendor ID AVP. If the destination realm not served action is set to abandon with no answer, destination realm not served vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
| * Peer Node Reported Congestion Action | Action taken when routing of a request is abandoned and the route evaluated is congested. If the peer node reported congestion action is set to abandon with no answer, the peer node reported congestion result code, the peer node reported congestion error message, and the peer node reported congestion vendor ID fields are disabled. If the peer node reported congestion action is set to send answer, the peer node reported congestion result code Value, the peer node reported congestion error message, and the peer node reported congestion vendor ID fields are enabled. |
Format: List Range: Send Answer, Abandon with No Answer Default: Send Answer |
| Peer Node Reported Congestion Result-Code | Value to be placed in the result code AVP of the answer message. Answer result code value is required if action is send answer. If the peer node reported congestion action is set to abandon with no answer, the peer node reported congestion result code field is disabled. |
Format: options
Default: 3002 UNABLE_TO_DELIVER |
| Peer Node Reported Congestion Answer Error-Message | String to be placed in the error message AVP of the answer message for peer node reported congestion. If the peer node reported congestion action is set to abandon with no answer, the peer node reported congestion error message field is disabled. |
Format: numeric Range: 1 - 64 characters Default: null string, no Error-Message AVP in Answer message |
| Peer Node Reported Congestion Vendor-ID | Vendor ID value returned in an answer message when a message is not successfully routed due to peer node reported congestion. When specified, answer generated is experimental result code grouped AVP with vendor ID value specified placed in vendor ID AVP. If the peer node reported congestion action is set to abandon with no answer, the peer node reported congestion vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
| * Nested ART/PRT Error Action | Action taken when routing of a request is abandoned due to a Nested Application Route Table/Peer Route Table (ART/PRT) search results in a loop or maximum search depth exceeded. If the nested ART/PRT error action is set to abandon with no answer the, nested ART/PRT error result code, nested ART/PRT error message, and nested ART/PRT error vendor ID fields are disabled. If the nested ART/PRT error action is set to send answer, the nested ART/PRT error result code Value, the nested ART/PRT error message, and the nested ART/PRT error vendor ID fields are enabled. |
Format: List Range: Send Answer, Abandon with No Answer Default: Send Answer |
| Nested ART/PRT Error Result Code | Value placed in the result code AVP of the answer message. Answer result code value is required if action is send answer. If the nested ART/PRT error action is set to abandon with no answer the, nested ART/PRT error result code field is disabled. |
Format: options
Default: 3002 UNABLE_TO_DELIVER |
| Nested ART/PRT Error Message | String to be placed in the error message AVP of the answer message for Nested Application route Table/Peer route Table (ART/PRT) Error. If the nested ART/PRT error action is set to abandon with no answer the, nested ART/PRT error message field is disabled. |
Format: numeric Range: 1 - 64 characters Default: null string, no Error-Message AVP in Answer message |
| Nested ART/PRT Error Vendor ID | Vendor ID value returned in an answer message when a message is not successfully routed due to nested ART/PRT error. When specified, answer generated is experimental result code grouped AVP with vendor ID value specified placed in vendor ID AVP If the nested ART/PRT error action is set to abandon with no answer the, nested ART/PRT error vendor ID field is disabled. |
Format: numeric Range: 1 - 4294967295 Default: none |
