# HSS Peer Service Configuration Mode Commands

The HSS Peer Service Configuration Mode is used to create and manage the Home Subscriber Server (HSS) Peer Service.

IMPORTANT:

The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).
auth-request

Configures the number of authentication vectors the MME/SGSN requests in an Authentication-Information-Request (AIR) message to the HSS for each UE requiring authentication.
Platform:

ASR 5000
Product:

MME, SGSN
Privilege:

Administrator
Syntax

    auth-request num-auth-vectors numdefault auth-request
    num-auth-vectors

num-auth-vectors num

Specifies the number of vectors the MME/SGSN is requesting from the HSS as an integer from 1 through 3. Default = 1
Usage:

Use this command to configure the number of authentication vectors the MME/SGSN requests in an Authentication-Information-Request (AIR) message to the HSS for each UE requiring authentication.

Receiving multiple vectors from the HSS for a given UE helps reduce the number of messages across the diameter connection plus provides the MME/SGSN with additional vectors for the UE in the event that the connection or the HSS id disabled.

To view the current number of requested vectors, execute the show hss-peer-service service name <name> command in the Exec mode.
Example:
The following command sets the number of requested vectors to 2:

    auth-request num-auth-vectors 2

diameter hss-dictionary

Specifies the Diameter Credit Control dictionary for the HSS peer service.
Platform:

ASR 5000
Product:

MME, SGSN
Privilege:

Administrator
Syntax

    diameter hss-dictionary { custom1 | standard | standard-r9 } [ eir-dictionary { custom1 | standard | standard-r9 } ]default diameter hss-dictionary

default

Sets the dictionary to default standard-r9 for HSS service.
custom1

Sets the Diameter dictionary to a customer-specific HSS Diameter dictionary. Default: Disabled
standard

Sets the Diameter dictionary to the standard HSS peer dictionary. Default: Disabled
standard-r9

Sets the Diameter dictionary to the standard HSS peer dictionary for release 9. Default: Enabled
eir-dictionary { custom1 | standard }

Specifies that an Equipment Identity Register (EIR) dictionary is to be used in conjunction with the HSS Diameter dictionary.

custom1: Sets the EIR Diameter dictionary to a customer-specific EIR Diameter dictionary.

standard: Sets the EIR Diameter dictionary to the standard HSS peer dictionary.

standard-r9: Sets the EIR Diameter dictionary to the standard HSS peer dictionary for release 9.
Usage:

Use this command to select the Diameter dictionary for the HSS peer service.
Example:
The following command sets the Diameter dictionary to IETF RFC 4006 specific:

    diameter hss-dictionary standard

diameter hss-endpoint

Associates a preconfigured Diameter origin endpoint with this HSS peer service.
Platform:

ASR 5000
Product:

MME, SGSN
Privilege:

Administrator
Syntax

    diameter hss-endpoint endpoint_name [ eir-endpoint eir_endpoint_name ]no diameter hss-endpoint

no

Removes previously associated Diameter origin endpoint from this HSS peer service.
endpoint_name

Identifies a preconfigured Diameter endpoint specific to the HSS interface. The endpoint must be present in all Diameter messages and is the endpoint that originates the diameter message.

endpoint_name is a preconfigured Diameter endpoint name expressed as an alphanumeric string of 1 through 63 characters.
eir-endpoint eir_endpoint_name

Identifies a preconfigured Diameter endpoint specific to the S13 or S13‘ Equipment Identity Register (EIR) interface. eir_endpoint_name must be an existing Diameter endpoint expressed as an alphanumeric string of 1 through 63 characters.
Usage:

Use this command to associated a Diameter origin endpoint to create a Diameter-based S6a or S6d (SGSN) interface association in this HSS peer service to provide AAA functionality to the EPS bearer context.

Optionally, use this command to associate a Diameter origin endpoint to create a Diameter-based S13 or S13‘ (SGSN) interface association in this HSS peer service to provide IMEI query capability between the MME and an EIR.

Refer to the Diameter Endpoint Configuration Mode Commands chapter for more information on Diameter endpoint configuration parameters.
Example:
The following command associates the preconfigured Diameter endpoint hss_1 with this HSS peer service for HSS interface support.

    diameter hss-endpoint hss_1

diameter suppress

Configures the MME to restrict the sending of the Notify-Request-Message to the HSS. By default, the Notify-Request-Message is sent to the HSS.
Platform:

ASR 5000
Product:

MME
Privilege:

Administrator
Syntax

    [ no ] diameter
    suppress notify-request

no

Sets the command to the default value where the Notify-Request-Message is sent to the HSS.
Usage:

Use this command to restrict the MME from sending the Notify-Request-Message to the HSS. This can be used to control whether handover to non-3GPP access can occur.
end

Exits the current configuration mode and returns to the Exec mode.
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    end

Usage:

Use this command to return to the Exec mode.
exit

Exits the current mode and returns to the parent configuration mode.
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    exit

Usage:

Use this command to return to the parent configuration mode.
failure-handling

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.
Platform:

ASR 5000
Product:

MME, SGSN
Privilege:

Security Administrator, Administrator
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: On receipt of any error, the system allows the HSS peer service to continue with the session procedure without any interruption.The continue option for IMEI procedure on SGSN:For IMEI procedure on SGSN, the continue option performs the same function as the retry-and-terminate option, this behaviour is changed for SGSN only. Configure the continue option 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 exitBy configuring the continue option as shown above, the timeout and error response requests will be re-tried on a second peer (if the second peer is configured) and the call procedure is continued.
- retry-and-terminate: On receipt of any error, the system instructs the HSS peer service to retry the procedure. The system will retry up to the configured number of attempts and terminate the session/procedure if it received a subsequent number of errors after retry attempts.
- terminate: The system allows the HSS peer service to terminate the session procedure without any retry attempt on the event of any failure.

Usage:

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 action 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

request timeout

Configures the application request timeout between the HSS peer service and HSS node. The MME/SGSN waits for this duration before retransmitting the request to corresponding HSS node.
Platform:

ASR 5000
Product:

MME, SGSN
Privilege:

Administrator
Syntax

    request timeout dur[ no | default ] request timeout

no

Disables the configured application request timeout value.
default

Sets the application request time out duration to default value of 300 seconds.
dur

Specifies the application request timeout duration (in seconds) as an integer from 1 through 300. The MME/SGSN will wait for this duration before retrying the request with corresponding HSS. Default: 300
Usage:

Use this command to set the waiting period for HSS peer service in seconds after which the request is deemed to have failed or system will resend the request.
Example:
The following example configures the application request timeout duration to 300 seconds:

    default request timeout