Diameter Tasks - Messages

This document describes the Diameter Tasks used to send and wait for Diameter messages.


DiameterSendRequestTask

Task to send a generic Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Command Code Diameter command code.
Application Id Application Id for the message.
Session Id Optional session id for the message.
AVP List Additional AVPs to be included in answer message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterWaitForRequestTask

Task to wait for a diameter request message. The task will block until a specified request message is received. If Command Code is specified, messages received with non expected command codes, will be answered with a 3001 (COMMAND_UNSUPPORTED) answer message.

The received message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Wait for Command Code Command code to wait for. Specify -1 to wait for any message.

DiameterSendAnswerTask

Task to send answer message to server. The task will send an answer message based on previously received request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Result Code Diameter result code.
AVP List Additional AVPs to be included in answer message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

The generated answer message will have mandatory AVPs generated, depending on the answer Message type. By default the following AVPs will always be added:

For other AVPs generated see the table below.

AVP Description CEA Rf ACA Rx AAA Rx RAA Rx STA Rx ASA
Session-Id Automatically generated, based on request x x x x x
Host-IP-Address Host parameter in DiameterServerInitTask x
Vendor-Id Vendor Id parameter in DiameterServerInitTask x
Product-Name Product Name parameter in DiameterServerInitTask x
Accounting-Record-Number Based on request x
Auth-Application-Id Based on application/interface x

DiameterSendRfACRTask

Task to send an Rf ACR (Accounting-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Accounting Record Type Defines the record type: START, INTERIM, STOP or EVENT.
Accounting Record Number Defines the accounting record number.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendRxAARTask

Task to send an Rx AAR (AA-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendRxRARTask

Task to send an Rx RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Specific Action Specific action id.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendRxSTRTask

Task to send an Rx STR (Session-Termination-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Termination Cause Termination cause id.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendRxASRTask

Task to send an Rx ASR (Abort-Session-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Abort-Cause Abort cause id.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendGxCCRTask

Task to send an Gx RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

CC Request Type Defines the request type: INITIAL_REQUEST, UPDATE_REQUEST, TERMINATION_REQUEST or EVENT_REQUEST.
CC Request Number Defines the request number.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendGxRARTask

Task to send an Gx RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Re-Auth Request Type Defines the request type: AUTHORIZE_ONLY or AUTHORIZE_AUTHENTICATE.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendGyCCRTask

Task to send an Gy RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Service Context Id Defines the Service-Context-Id AVP.
CC Request Type Defines the request type: INITIAL_REQUEST, UPDATE_REQUEST, TERMINATION_REQUEST or EVENT_REQUEST.
CC Request Number Defines the request number.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendGyRARTask

Task to send an Gy RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Re-Auth Request Type Defines the request type: AUTHORIZE_ONLY or AUTHORIZE_AUTHENTICATE.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendSdCCRTask

Task to send an Sd RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Session ID Session Id. Leave empty for default session handling.
CC Request Type Defines the request type: INITIAL_REQUEST, UPDATE_REQUEST, TERMINATION_REQUEST or EVENT_REQUEST.
CC Request Number Defines the request number.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendSdRARTask

Task to send an Sd RAR (Re-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Session ID Session Id. Leave empty for default session handling.
Re-Auth Request Type Defines the request type: AUTHORIZE_ONLY or AUTHORIZE_AUTHENTICATE.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendSdTSRTask

Task to send an Sd TSR (TDF-Session-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Session ID Session Id. Leave empty for default session handling.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendShUDRTask

Task to send an Sh UDR (User-Data-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

User Identity Used to generate User-Identity AVP. Public Identity or MSISDN (if MSISDN parameter selected).
Data Reference Used to generate Data-Reference AVP. Numeric value or symbolic name.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendShPURTask

Task to send an Sh PUR (Profile-Update-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

User Identity Used to generate User-Identity AVP. Public Identity or MSISDN (if MSISDN parameter selected).
Data Reference Used to generate Data-Reference AVP. Numeric value or symbolic name.
User Data Sh-Data XML. Used to generate User-Data AVP.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendShSNRTask

Task to send an Sh SNR (Subscribe-Notifications-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

User Identity Used to generate User-Identity AVP. Public Identity or MSISDN (if MSISDN parameter selected).
Subscription Request Type Subscribe or Unsubscribe. Used to generate Subs-Req-Type AVP.
Data Reference Used to generate Data-Reference AVP. Numeric value or symbolic name.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendShPNRTask

Task to send an Sh PNR (Push-Notification-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

User Identity Used to generate User-Identity AVP. Public Identity or MSISDN (if MSISDN parameter selected).
User Data Sh-Data XML. Used to generate User-Data AVP.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendZhMARTask

Task to send an Zh MAR (Multimedia-Auth-Request) Diameter request message.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

User Name Private Identity. Used to generate User-Name AVP.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendZxMARTask

Task to send an Zx MAR (Multimedia-Auth-Request) Diameter request message. Equivalent to Zx-AuthData request.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

Authentication Scheme Digest or SSO. Used to generate SIP-Authentication-Scheme AVP.
Public Identity Public Identity. Used to generate Public-Identity AVP.
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendS6aTask

Task to send S6a/S6a Diameter request messages. The following commands can be sent: ULR, CLR, AIR, IDR, DSR, PUR, RSR or NOR.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

S6b Command S6b command to send (ULR, CLR, AIR, IDR, DSR, PUR, RSR or NOR).
User Name User-Name AVP(User IMSI).
Cancellation Type Cancellation-Type AVP (only used for CLR command).
Visited PLMN Id Visited-PLMN-Id AVP (only used for AIR command).
DSR Flags DSR-Flags AVP (only used for DSR command).
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added:


DiameterSendS6bTask

Task to send an S6b Diameter request message. The following commands can be sent: DER, AAR, STR, ASR or RAR.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

S6b Command S6b command to send (DER, AAR, STR, ASR or RAR).
EAP Payload EAP-Payload AVP (only used for DER command).
Auth Request Type Auth-Request-Type AVP (only used for DER and AAR command).
Re-Auth Request Type Re-Auth-Request-Type AVP (only used for RAR command).
Termination Cause Termination-Cause AVP (only used for STR command).
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added (if mandatory for the specified command):


DiameterSendSWmTask

Task to send an SWm Diameter request message. The following commands can be sent: DER, AAR, STR, ASR or RAR.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

SWm Command SWm command to send (DER, AAR, STR, ASR or RAR).
EAP Payload EAP-Payload AVP (only used for DER command).
Auth Request Type Auth-Request-Type AVP (only used for DER and AAR command).
Re-Auth Request Type Re-Auth-Request-Type AVP (only used for RAR command).
Termination Cause Termination-Cause AVP (only used for STR command).
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added (if mandatory for the specified command):


DiameterSendSWxTask

Task to send an SWx Diameter request message. The following commands can be sent: MAR, PPR, SAR or RTR.

The received answer message will be saved in text format, to allow validation and/or extract of information from the message using any standard utility tasks.

Parameters

SWx Command SWx command to send (MAR, PPR, SAR or RTR).
User Name User-Name AVP value.
Server Assignment Type Server-Assignment-Type AVP (only used for SAR command).
Re-Auth Request Type Re-Auth-Request-Type AVP (only used for RAR command).
Termination Cause Termination-Cause AVP (only used for STR command).
AVP List Additional AVPs to be included in message. See Specifying AVPs for details on how to specify AVPs.

Generated Mandatory AVPs

By default the following AVPs will always be added (if mandatory for the specified command):