Configures failure
handling behavior in the event of a failure with the HSS peer service. It also
defines the action on various error codes on the Diameter interface
during authentication or session activities.
Privilege
Security Administrator, Administrator
Mode
Exec > Global Configuration
> Context Configuration > HSS Peer Service Configuration
configure > context context_name > hss-peer-service service_name
Entering the above
command sequence results in the following prompt:
[context_name]host_name(config-hss-peer-service)#
Syntax
failure-handling { authentication-information-request | check-identity-request| notify-request | purge-ue-request | update-location-request } { diameter-result-code start_error_code [ to end_error_code ] | request-timeout } action { continue | retry-and-terminate | terminate }
no failure-handling { authentication-information-request | check-identity-request | notify-request | purge-ue-request | update-location-request } diameter-result-code start_error_code [ to end_error_code ]
default failure-handling { authentication-information-request | check-identity-request | notify-request | purge-ue-request | update-location-request } request-timeout
no
Removes the preconfigured
failure handling procedures for calls in an HSS peer service.
default
Sets the default action
for failure handling procedure for calls in an HSS peer service.
For default actions
on Diameter result/error codes see the Usage section below.
authentication-information-request
Configures the MME-HSS
service to handle the failures in an Auth-Information-Request message.
Configures the SGSN-HSS
service to handle the failures in an Auth-Information-Request message.
check-identity-request
Configures the MME-HSS
service to handle the failures in a Check-Identity-Information-Request
message.
Configures the SGSN-HSS
service to handle the failures in a Check-Identity-Information-Request
message.
notify-request
Configures the MME-HSS
service to handle the failures in a Notify-Request message.
This
option is not supported on SGSN.
purge-ue-request
Configures the MME-HSS
service to handle the failures in a Purge-UE-Request message.
Configures the SGSN-HSS
service to handle the failures in a Purge-UE-Request message.
update-location-request
Configures the HSS
peer service to handle the failures in an Update-Location-Request message.
diameter-result-code start_error_code [to end_error_code ]
Configures the HSS
peer service to handle the failures for various request message
having specific single or range of Diameter result codes in a request
message.
start_error_code specifies
an individual error code for Diameter protocol as an integer from
3000 through 5999. This will be the starting of code if
a range of error codes is specified with the optional keyword to end_error_code .
to end_error_code is
used to specify a range of error codes to handle by this command. end_error_code specifies
the end error code for Diameter protocol as an integer from 3000
through 5999.
request-timeout
Configures the HSS
peer service to handle the failures for various request messages
if response to that message is not received before timeout duration
exhausted.
action { continue | retry-and-terminate | terminate }
Specifies the action
to be taken on failure of any message as a policy for failure handling.
-
continue : This
option works differently for each system.
For the SGSN: On
receipt of any error for MICR session request, the SGSN
allows the HSS peer service to continue with the session procedure
without any interruption. For all other request/message
types, the SGSN behaves as it would if configured for the retry-and-terminate option.
For
the MME: The MME does not support this option and if continue is
included in the command, the MME behaves as it would if
configured for the retry-and-terminate option.
For 12.0 and
earlier releases the continue option
in failure handling on
SGSN for IMEI procedures has the same behavior as that of the retry-and-terminate option.
![](https://www.cisco.com/content/dam/en/us/td/i/templates/note.gif) Important |
For releases after
14.0, the continue option
for IMEI procedure on
SGSN can be configured in case of timeout and error responses
requests from HSS so that the requests will be re-tried
on a second peer (if configured) and the call
is continued. The configuration of continue option
for IMEI procedure is as follows:
|
configure
context <name>
hss-peer-service <name>
failure-handling check-identity-request request-timeout action continue
failure-handling check-identity-request diameter-result-code <range1> to <range2> action continue
failure-handling check-identity-request diameter-result-code <range1> action continue
exit
exit
exit
-
retry-and-terminate : On
receipt of any error, once the configured condition (either
the request timeout or receipt of the specified result code) occurs, the
system retries sending the request (AIR/ULR/NOR/PUR/MICR) to
another peer that is configured in the same endpoint. If
no response is received for AIR or ULR from the second peer, then
the system allows the HSS peer service to terminate the session.
-
terminate : On
receipt of any error, once the configured condition (either
the request timeout or receipt of the specified result code) is
met, the system allows the HSS peer service to immediately
terminate the session (AIR/ULR/MICR) without
any further action.
Usage Guidelines
Use this command to
configure the failure handling behavior in the event of a communication
failure with the HSS peer service.
The following are the
default actions for Diameter result codes:
-
For all protocol error
codes 3000 to 3999, the default action is terminate. For
all transient error codes 4000, 4001, 4004 to
4180, and 4182 to 4999, the default action is continue.
-
For transient error
codes 4002, 4003, and 4181, the default
action is retry.
-
For error code 4001, the
default action is terminate.
-
For permanent error
codes 5000 to 5999, the default action is terminate
Example
The following command
will allow HSS peer service to continue if any failure in Auth-Information-Request
message occurred with Diameter error code 3050 :failure-handling authentication-information-request diameter-result-code 3050 action continue