System Options elements

3.2.7.1 System Options elements

Table 3-7 describes the fields on the System Options page.

Table 3-7 System Options Elements

Field Description Data Input Notes

URI Local Number Enabled

Field	Description	Data Input Notes
URI Local Number Enabled	This only applies to the routing entity type IMPU; defines whether local numbers are considered valid addresses within a SIP or TEL URI. An address of this form is considered a local number if it does not start with the global number prefix character plus sign (+). If checked, both local and global numbers are valid addresses for IMPU decoded from diameter requests. If unchecked, only global numbers are valid addresses.	Format: check box Range: checked, unchecked Default: unchecked
ASCII Excluded Digits	List of ASCII characters to ignore while parsing digits from a raw AVP data field of AVP Type UTF8String. If an invalid character is entered, an error message appears.	Format: fields Range: ASCII-printable characters except the percent sign (%)
Exclude Space	Defines whether ASCII character space is ignored while parsing digits from a raw AVP data field of AVP Type UTF8String. If checked, ASCII character space is ignored. If not checked, ASCII character space is not ignored.	Format: check box Range: checked, unchecked Default: unchecked
TBCD Excluded Digits	Defines whether the associated character is ignored while parsing digits from a raw AVP data field of AVP Type OctetString encoded as a TBCD-string. If checked, character is ignored. If not checked, character is not ignored.	Format: check boxes Range: checked, unchecked for each option: *(0010), #(1011), a(1100), b(1101), c(1110) Default: all unchecked
Allow Subsequent RBAR Invocation	Enables the subsequent invocation of RBAR on a different DSR node in the network. If checked, this setting overrides the Allow Subsequent RBAR Invocation attribute in Destination.	Format: check box Range: checked, unchecked Default: unchecked
Remove Destination-Host	If checked, RBAR deletes any instance of Destination-Host AVPs in the message when performing Realm only resolution.	Format: check box Range: checked, unchecked Default: unchecked
Realm	Value to be placed in the Origin-Realm AVP of the Answer message generated by RBAR. A Realm must be paired with a Fully Qualified Domain Name. If entering a value for Realm, then a value for Fully Qualified Domain Name must also be entered; otherwise, an error message appears. If not configured, the local node Realm for the egress connection is used to populate Origin-Realm AVP.	Format: field Range: A valid Realm or FQDN. A label consists up to 63 characters and a Realm or FQDN up to 255 characters Default: none
Fully Qualified Domain Name	Value to be placed in the Origin-Host AVP of the Answer message generated by RBAR. A Fully Qualified Domain Name must be paired with a Realm. If entering a value for Fully Qualified Domain Name, then a value for Realm must also be entered; otherwise, an error message appears. If not configured, the local node FQDN for the egress connection is used to populate the Origin-Host AVP.
Resource Exhaustion Result-Code	Result-Code or Experimental-Result-Code value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted. If Vendor-Id is configured, this result-code value is encoded as Experimental-Result-Code AVP; otherwise the result-code is encoded as Result-Code AVP.	Format: field list Range: field: 1000–5999 list of available code values Default: 3004
Resource Exhaustion Error Message	Error-Message AVP value to be returned in an answer message when a message is not successfully routed because of internal resource being exhausted.	Format: Alphanumeric, underscore (_), and period (.) Range: 0–64 characters Default: RBAR Resource Exhausted
Resource Exhaustion Vendor-Id	Vendor-Id AVP value to be returned in an answer message when a message is not successfully routed because of internal resource being exhausted.	Format: field Range: 1–4294967295
Application Unavailable Action	Defines action to be taken when RBAR is not available to process messages If the `Default Route` option is selected, an entry must be provided for the Application Unavailable Route List.	Format: Options Range: Continue Routing Default Route Send Answer with Result-Code AVP Send Answer with Experimental-Result AVP Default: Continue Routing
Application Unavailable Route List	Defines where the requests are routed when RBAR is not available. Peer Routing Rules are bypassed. A route list must be entered if `Default Route` is selected as the Application Unavailable Action.	Format: list Range: Available route list entries
Application Unavailable Result-Code	Result-Code or Experimental-Result-Code value returned in an Answer message when a message is not successfully routed because RBAR is not available. If Vendor-Id is configured, this result-code value is encoded as Experimental-Result-Code AVP; otherwise, the result-code is encoded as Result-Code AVP. A code must be entered if either the `Send Answer with Result-Code AVP` or the `Send Answer with Experimental Result-Code AVP` option is selected as the Application Unavailable Action.	Format: field list Range: field: 1000–5999 list of available Code values Default: 3002
Application Unavailable Error Message	Error-Message AVP value to be returned in an Answer message when a message is not successfully routed because RBAR is not available. A message can be entered, if needed, when either the `Send Answer with Result-Code AVP` or the `Send Answer with Experimental Result-Code AVP` option is selected as the Application Unavailable Action.	Format: field Range: 0–64 characters Default: RBAR Unavailable
Application Unavailable Vendor-Id	Vendor-Id AVP value to be returned in an Answer message when a message is not successfully routed because RBAR is not available. A vendor-Id must be entered if the `Send Answer with Experimental Result-Code AVP` option is selected as the Application Unavailable Action.	Format: field Range: 1–4294967295 Default: none
Allow Longest Sub-Domain Match	This configuration is used for searching domain address. When checked, if an exact match is not found using the Domain Identifier component of the External identifier received in an ingress Diameter message, then RBAR continues the search looking for the longest matching sub-domain.	Format: check box Range: checked, unchecked Default: unchecked

This only applies to the routing entity type IMPU; defines whether local numbers are considered valid addresses within a SIP or TEL URI. An address of this form is considered a local number if it does not start with the global number prefix character plus sign (+).

If checked, both local and global numbers are valid addresses for IMPU decoded from diameter requests.

If unchecked, only global numbers are valid addresses.

Format: check box

Range: checked, unchecked

Default: unchecked

ASCII Excluded Digits

List of ASCII characters to ignore while parsing digits from a raw AVP data field of AVP Type UTF8String.

If an invalid character is entered, an error message appears.

Format: fields

Range: ASCII-printable characters except the percent sign (%)

Exclude Space

Defines whether ASCII character space is ignored while parsing digits from a raw AVP data field of AVP Type UTF8String.

If checked, ASCII character space is ignored.

If not checked, ASCII character space is not ignored.

Format: check box

Range: checked, unchecked

Default: unchecked

TBCD Excluded Digits

Defines whether the associated character is ignored while parsing digits from a raw AVP data field of AVP Type OctetString encoded as a TBCD-string.

If checked, character is ignored.

If not checked, character is not ignored.

Format: check boxes

Range: checked, unchecked for each option: *(0010), #(1011), a(1100), b(1101), c(1110)

Default: all unchecked

Allow Subsequent RBAR Invocation

Enables the subsequent invocation of RBAR on a different DSR node in the network.

If checked, this setting overrides the Allow Subsequent RBAR Invocation attribute in Destination.

Format: check box

Range: checked, unchecked

Default: unchecked

Remove Destination-Host

If checked, RBAR deletes any instance of Destination-Host AVPs in the message when performing Realm only resolution.

Format: check box

Range: checked, unchecked

Default: unchecked

Realm

Value to be placed in the Origin-Realm AVP of the Answer message generated by RBAR.

A Realm must be paired with a Fully Qualified Domain Name. If entering a value for Realm, then a value for Fully Qualified Domain Name must also be entered; otherwise, an error message appears.

If not configured, the local node Realm for the egress connection is used to populate Origin-Realm AVP.

Format: field

Range: A valid Realm or FQDN. A label consists up to 63 characters and a Realm or FQDN up to 255 characters

Default: none

Fully Qualified Domain Name

Value to be placed in the Origin-Host AVP of the Answer message generated by RBAR.

A Fully Qualified Domain Name must be paired with a Realm. If entering a value for Fully Qualified Domain Name, then a value for Realm must also be entered; otherwise, an error message appears.

If not configured, the local node FQDN for the egress connection is used to populate the Origin-Host AVP.

Resource Exhaustion Result-Code

Result-Code or Experimental-Result-Code value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted.

If Vendor-Id is configured, this result-code value is encoded as Experimental-Result-Code AVP; otherwise the result-code is encoded as Result-Code AVP.

Format:

field
list

Range:

field: 1000–5999
list of available code values

Default: 3004

Resource Exhaustion Error Message

Error-Message AVP value to be returned in an answer message when a message is not successfully routed because of internal resource being exhausted.

Format: Alphanumeric, underscore (_), and period (.)

Range: 0–64 characters

Default: RBAR Resource Exhausted

Resource Exhaustion Vendor-Id

Vendor-Id AVP value to be returned in an answer message when a message is not successfully routed because of internal resource being exhausted.

Format: field

Range: 1–4294967295

Application Unavailable Action

Defines action to be taken when RBAR is not available to process messages

If the Default Route option is selected, an entry must be provided for the Application Unavailable Route List.

Format: Options

Range:

Continue Routing
Default Route
Send Answer with Result-Code AVP
Send Answer with Experimental-Result AVP

Default: Continue Routing

Application Unavailable Route List

Defines where the requests are routed when RBAR is not available. Peer Routing Rules are bypassed.

A route list must be entered if Default Route is selected as the Application Unavailable Action.

Format: list

Range: Available route list entries

Application Unavailable Result-Code

Result-Code or Experimental-Result-Code value returned in an Answer message when a message is not successfully routed because RBAR is not available.

If Vendor-Id is configured, this result-code value is encoded as Experimental-Result-Code AVP; otherwise, the result-code is encoded as Result-Code AVP.

A code must be entered if either the Send Answer with Result-Code AVP or the Send Answer with Experimental Result-Code AVP option is selected as the Application Unavailable Action.

Format:

field
list

Range:

field: 1000–5999
list of available Code values

Default: 3002

Application Unavailable Error Message

Error-Message AVP value to be returned in an Answer message when a message is not successfully routed because RBAR is not available.

A message can be entered, if needed, when either the Send Answer with Result-Code AVP or the Send Answer with Experimental Result-Code AVP option is selected as the Application Unavailable Action.

Format: field

Range: 0–64 characters

Default: RBAR Unavailable

Application Unavailable Vendor-Id

Vendor-Id AVP value to be returned in an Answer message when a message is not successfully routed because RBAR is not available.

A vendor-Id must be entered if the Send Answer with Experimental Result-Code AVP option is selected as the Application Unavailable Action.

Format: field

Range: 1–4294967295

Default: none

Allow Longest Sub-Domain Match

This configuration is used for searching domain address. When checked, if an exact match is not found using the Domain Identifier component of the External identifier received in an ingress Diameter message, then RBAR continues the search looking for the longest matching sub-domain.

Format: check box

Range: checked, unchecked

Default: unchecked