Home

Issue 4 - Dialogic

1. DMR_EVENT_PEER_UN Peer_id EX_REALM DMR_EVENT_PEER_UN Peer_id EX_HOST DMR_EVENT_PEER_UN assoc_id EX_ASC_ID Decoding of message detected a problem Could not decode Peer name as part of Capability Exchange Could not decode Peer realm as part of Capability Exchange The identified network context ID is invalid Could not identify application based on an unknown application id N An error adding an application to a peer has occurred N o A dynamic connection request has been refused ND re The peers advertised realm name does not match that configured The peers advertised host name does not match that configured Unexpected association for peer N 67 Section 4 Message Reference 68 N al DMR_EVENT_PEER_CA P_EX_NO_COMMON_AP PS ye 9 DMR_EVENT_PEER_CA P_EX_NO_COMMON_SE CURITY N DMR_ERROR_PEER_CA P_EX_FAILED ND Co DMR_EVENT_PEER_DP R_RXED ND o DMR_EVENT_PEER_UN EX_APP_ID CO o DMR_EVENT_TRAN_RU N_OUT DMR_EVENT_SSN_BAD ID EN DMR_EVENT_SSN_INVA LID_ID S N DMR_EVENT_SSN_RUN _OUT al be DMR EVENT BEO BAD _PRIM_TYPE oa DMR_EVENT_REQ_MISS ING_PARAM DMR_EVENT_REQ_DMT R_REQ_FLAG A DMR_EVENT_REQ_BAD _DMTR_MSG peer_id peer_id peer_id Disconnecti on cause AVP value peer_id d session_id session_id session_id i M session_id S A capability exchange procedure failed due
2. Diameter Application Each Diameter Node optionally supports a number of Diameter Applications for which it can receive traffic These will be advertised during Capabilities Exchange Peer Connection A Peer connection encompasses the SCTP transport connection to a remote Peer and has a Peer State Machine instance supporting Capability exchange Watchdog Transaction buffering etc Realm Route A Realm Route defines a set of Diameter Messages for routing purposes The set is identified based on parameters including Destination Realm Destination Host and Application ID A realm route may have a number of Route Lists 3 2 3 3 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Route List This identifies a Peer Connection to which messages belonging to a Realm Route may be forwarded System Configuration The DSI Diameter Module can be configured as part of a complete signaling system using the s7_mat utility supplied as part of the Dialogic DSI Development Package This utility can generate the required configuration messages from an appropriate configuration file See Dialogic DSI Components Software Environment Programmer s Manual for further details on the s7_mgt utility and the configuration syntax used Configuration Sequence The following is the recommend configuration sequence for the module 1 Configure the main module settings This will configure the module and define the module ids for the inter
3. Route Tables Route Table Route Table Policy ID Route Key Route Key Destination Host Destination Host Destination Realm Destination Realm Application ID Application ID Figure 2 Route Table Structure For example if an application needs to route messages with Destination Realm Jupiter com via Peer Alpha but wishes to route messages for certain subscribers via Peer Beta in preference then this may be configured as follows 1 The user configures Peer 0 Peer Alpha 2 The user configures Peer 1 Peer Beta 3 The user configures Route 0 with Destination Realm Jupiter com This route has no policy_id 4 The user configures Route List 0 mapping Route 0 with Peer A 5 The user configures Route 1 with Destination Relam Jupiter com and Policy_id 1 6 The user configures Route List 1 mapping Route 1 with Peer B this will take the role of primary 7 The user configures Route List 2 mapping Route 1 with Peer A this will take the role of secondary This results in the configuration shown below 11 12 Section 2 General Description Route 0 Route 1 Realm Jupiter com Realm Jupiter com Figure 3 Example route configuration At run time the user application will determine which messages require special routing and will include the policy_id parameter set to the value 1 If the Destination Realm equals Jupiter com then DMR will match and select Route 1 and presuming i
4. 6 58 DMR_MSG_R_PEER_STATS Diameter Peer Statistics Synopsis Message used to query measurements for a specific Diameter Peer Format status 0 Leave stats unchanged 1 Reset stats after reading me n CH o n Description This message allows the user to query a specific peer to read measurements The counters can be reset or left unchanged depending on the setting of the status field The user should send the message with all fields set to zero Parameters period Period over which the measurements have been collected in multiples of 100ms Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Tx_octet Number of octets transmitted Rx_octet Number of octets received Tx_msg Number of messages transmitted Rx_msg Number of messages received Peer_error Number of errors associated with this peer including peer timeouts unexpected messages and remote disconnections Closed_cnt Count of state transitions to the CLOSED state Open_duration Duration within period the Peer has been in the OPEN state in multiples of 100ms 59 Section 4 Message Reference 4 4 7 60 DMR_MSG_R_APP_STATS Diameter Application Statistics Synopsis Message used to query measurements for a specific Diameter Application Format S Status 0 Leave stats unchanged 1 Reset stats after reading t err_info see Description This message allows the user to
5. Stack is given in the Diameter Functional API User Manual This section describes the raw message format used on the interface between DMR and the User Application as follows e DMR_MSG_SESSION_REQ Diameter Session Request e DMR_MSG_SESSION_IND Diameter Session Indication 4 2 1 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Session Control Primitives Parameter Area The parameter area of the DMR_MSG_SESSION_REQ and DMR_MSG_SESSION_IND messages both use a Name Length Data structure within the parameter area to allow for variable size parameters and extensibility The Name Length Data method is used by several other Dialogic DSI Stack Layers but the scheme used for DMR is different in that it always uses two bytes for the Parameter Name two bytes for the Parameter Length and two bytes for the terminator zero The parameter area for each message is constructed as a single byte Primitive Name followed by a list of parameters each in Name Length Data format followed by a two byte terminator Name set to zero indicating that there are no further parameters The following diagrams illustrate the parameter area coding Each parameter is formatted as follows 2 byte 2 byte Parameter length bytes 19 Section 4 Message Reference 4 2 2 Session Control Primitives Primitive Type The coding of the Primitive Type octet uses in the Session Control Primitives is shown in the following table DMR
6. also includes a Diameter Command Request e Continue Used to indicate a session is still open and also includes either a Diameter Command Request or Answer e Close Used to request a session is closed Typically also includes a Diameter Command Answer e P_Abort 25 Section 4 Message Reference 26 Used to indicate a session has been aborted for reason given in the Provider Reason parameter e Notify Used to notify the application of an issue with a previous Session Request indicated by the Notify Reason parameter Parameters The following table lists the parameters associates with each session indication primitive and shows whether the parameter is Mandatory M in which case the message will be discarded is the parameter is omitted or Optional O in which case the parameter is not considered essential Primitive D HIRE g 3 J 2 Parameter E amp 3 3 Network Context pm Diameter Message pm o o Provider Reason fo o M 2 Storage Message O 4 3 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Configuration Messages The Diameter Module DMR configuration is applied at system startup through the use of the following configuration messages Typically these messages are generated at startup time by the configuration utility s7_mgt which takes the configuration from the config txt file The commands used in config txt are documented
7. details the format of the following management request messages that can be used to interface with DMR for control purposes or to request status DMR_MSG_PEER_ACTIVATE Diameter Peer Activate Request DMR_MSG_PEER_DEACTIVATE Diameter Peer Deactivate Request DMR_MSG_S_TRACE_MASK Set Diameter Trace Masks DMR_MSG_R_NC_STATS Diameter NC Statistics DMR_MSG_R_PEER_STATE Read Peer State Request DMR_MSG_R_PEER_STATS Diameter Peer Statistics DMR_MSG_R_APP_STATS Diameter Application Statistics DMR_MSG_R_ROUTE_STATS Diameter Route Statistics DMR_MSG_R_RL_STATS Diameter Route List Statistics 49 Section 4 Message Reference 4 4 1 50 DMR_MSG_PEER_ACTIVATE Diameter Peer Activate Request Synopsis This primitive is used by management to request DMR to activate the connection to the identified peer Format CECR fee ST CIN as Tj TT seus C C TT T Description On receipt of this message DMR attempts to activate the specified Peer connection Receipt of a confirmation message does not imply the connection is available for use merely that DMR is attempting to bring the connection into service Peer availability is indicated through the DMR_MSG_PEER_STATE_IND message The user can determine the current state of a Peer connection on demand using the DMR_MSG_R_PEER_STATUS message 4 4 2 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_PEER_DEACTIVATE Diameter Peer Deactivate Requ
8. in the Software Environment Programmer s Manual When s7_mat is used for configuration the message definitions in this section are not needed by the user The configuration must start with the DMR_MSG_CONFIG module configuration message and then one or more DMR_MSG_NC_CFG messages to configure the Diameter Node s Each node will then have one or more Diameter Applications registered DMR_MSG_APP_CFG in addition to Diameter peers and Realm Routes The following configuration messages are documented in this section e DMR_MSG_CONFIG Diameter Configuration Message e DMR_MSG_NC_CFG Diameter NC Configuration e DMR_MSG_APP_CFG Diameter Application Configuration e DMR_MSG_PEER_CFG Diameter Peer Configuration e DMR_MSG_ROUTE_CFG Diameter Route Configuration e DMR_MSG_ROUTE_LIST_CFG Diameter Route List Configuration e DMR_MSG_APP_REM Diameter Application Removal e DMR_MSG_PEER_REM Diameter Peer Removal e DMR_MSG_ROUTE_REM Diameter Route Removal e DMR_MSG_ROUTE_LIST_REM Diameter Route List Removal e DMR_MSG_NC_REM Diameter NC Removal 27 Section 4 Message Reference 4 3 1 28 Configuration Parameter Format All configuration messages for DMR use a Name Length Data structure within the parameter area to allow for variable size parameters and extensibility The Name Length Data method is used by several other Dialogic DSI Stack Layers but the scheme used for DMR is different in that it always uses two bytes for t
9. messages received by DMR 3 DMR_MSG_PEER_ACTIVATE Trace peer activation requests received by DMR 4 DMR_MSG_PEER_DEACTIVATE Trace peer deactivation requests received by DMR 5 Reserved for future use Set to zero 6 DMR_MSG_APP_CFG Trace application configuration messages received by DMR 7 DMR_MSG_ROUTE_CFG Trace route configuration messages received by DMR 8 DMR_MSG_R_NC_STATS Trace read NC stats requests received by DMR 9 DMR_MSG_R_PEER_STATE Trace read peer state requests received by DMR 10 Reserved for future use Set to zero 11 DMR_MSG_ROUTE_LIST_CFG Trace route list configuration messages received by DMR 12 to 31 Reserved for future use and should be set to zero 4 4 4 Note Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_R_NC_STATS Diameter NC Statistics Synopsis Message used to query measurements for a specific Diameter Network Context Format status 0 Leave stats unchanged 1 Reset stats after reading TE a TT TT TT TT Cono Tj Ki err_info tran_alloc_count tran_dealloc_count Description This message allows the user to query the Network Context to determine its current usage of system resources The counters can be reset or left unchanged depending on the setting of the status field The user should send the message with all fields set to zero In this context a transaction is made up of a Diameter Request and a corresponding Diamet
10. now be resent For Session Indications this parameter may be present to indicate a message that should be stored by the user application for later resending This parameter takes the same format as the DMRPN_dmtr_msg parameter and therefore is also a well formed Diameter Message encoded compliant to RFC3588 starting with the Diameter Command Header and including all AVPs 22 4 2 4 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_SESSION_REQ Diameter Session Request Synopsis Message sent to the DMR module containing a Session Request Primitive Format S ds rsp_req hclass err_info geg Is Name fo Ji Session primitive ype octet Description This message is used by the User module to send session primitives to DMR All session primitives contain a Session ID which is encoded in the message header The Session ID is established by the module that generates the Open Primitive and used in all subsequent Session Primitives For an outgoing Session the Diameter User is responsible for generating a Session ID For an incoming Session DMR assigns the Session ID The following request primitive types are supported e Open Used to open a session The request will also typically include a Diameter Command Request specified in the Diameter Message parameter DMRPN_dmtr_msg If the command was previously stored and now needs to be resent then then command should be specifie
11. or logging protocol or operational events that have occurred Events generated include e Session Handling Event Indications e Indications of errors detected during processing of messages e Peer state changes See section 4 5 Event Indication Messages for further details Section 2 General Description 2 8 2 9 10 User Action The Diameter protocol requires careful interpretation of answer messages in conjunction with runtime and configuration parameters such as DirectDebitFailureHandling or CreditControlFailureHandling to determine the correct action required by the Diameter Client To aid compliance interoperability and to ease application development the DMR module has been implemented to perform this interpretation for the client where appropriate The client may then determine the required action by looking at the User Action parameter in the DMR_SESSION_IND message This is defined in Section 4 2 3 The User Action parameter is used in Credit Control applications including the 3GPP Ro Online Charging interface to indicate when service should be Granted or Denied when messages should be Stored or Deleted and when a service error indication has occurred It is used in Base Accounting applications including the 3GPP Rf Offline Charging interface to indicate when messages should be Stored or Deleted Policy Based Routing DMR routing procedures use a routing table which is configured at system start time and used at run t
12. query a specific application to read measurements The counters can be reset or left unchanged depending on the setting of the status field The user should send the message with all fields set to zero Parameters period Period over which the measurements have been collected in multiples of 100ms Tx_octet Number of octets transmitted Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Rx_octet Number of octets received Tx_msg Number of messages transmitted Rx_msg Number of messages received 61 Section 4 Message Reference 4 4 8 62 DMR_MSG_R_ROUTE_STATS Diameter Route Statistics Synopsis Message used to query measurements for a specific Diameter Route Format S Status 0 Leave stats unchanged 1 Reset stats after reading TT Tj TT TT TT T T me p S a err_info Description This message allows the user to query a specific Diameter route to read measurements The counters can be reset or left unchanged depending on the setting of the status field The user should send the message with all fields set to zero Parameters period Period over which the measurements have been collected in multiples of 100m5 Tx_octet Number of user provided octets transmitted over this route Tx_msg Number of user provided messages transmitted over this route Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Redirect Number of Diameter mes
13. the message based interface exposed by the Diameter Module and is described further in the Dialogic DSI Diameter Stack Diameter Functional API Manual Configuration DMR is configured using messages which define the module set up including configuration and management settings to be used The configuration model is discussed in further detail in section 3 and the messages used for configuration are defined in section 4 3 In most cases the user will not directly configure the module via these messages but will use the s7_mgt utility supplied in the DSI development package It is also possible for the user application to generate the configuration messages directly Message Tracing DMR provides tracing functionality to permit copies of messages sent or received by the module to be sent to a configurable trace module This readily permits analysis and diagnosis of systems The module can selectively trace different interfaces and message primitive types Further details of the message used to control the tracing can be found in section 4 4 3 Measurements DMR supports a message based statistics gathering mechanism A user application can send a message into the module for a configured Diameter Network context and the reply to the message will be populated with the relevant statistics such as session and transaction counts Event Reporting DMR generates message based event and error indications to the configured management module for
14. to no common applications A capability exchange procedure failed due to no common security A capability exchange procedure failed A DPR message has been received An unexpected Application Id has been received The system failed to allocate a new transaction resource An event has been received for a session id which is not in use An event has been received for a session id which is invalid The module has run out of session resources to allocate User request contained an unknown primitive type A mandatory parameter is missing from the request The Diameter request flag is set reset expected A problem was found parsing with the request values Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR EVENT REQ BAD nc_id application_id Session request APPID gt received for an unknown and unhandled application DMR EVENT REQ TOO Session_id len The SHORT DMR_SESSION_RE a Q message was too short DMR_EVENT_REQ_BAD session_id param_tag _PARAM DMR_EVENT_REQ BAD Session_id _FMT DMR_EVENT_REQ BAD session_id _TERM DMR_EVENT_REQ UNE Session_id X_PRIM al al a 9 A problem was found parsing the request format N The parameter was an invalid length oa 00 The terminating two bytes should have value zero Unexpected primitive type received for the session in use Request has no host or realm specified 9 a DMR_EVENT_REQ_NO_
15. CTP The Dialogic DSI SIGTRAN Stack SCTPN modules provide a message based interface and access to an SCTP network for message transport This is the interface over which the Diameter payload messages are sent or received encoded as SCTP messages Section 2 General Description Management DMR_MSG_SESSION_IND DMR_MSG_SESSION_REQ DMR_MSG_CONFIG DMR_MSG_NC_CFG DMR_MSG_APP_CFG DMR_MSG_PEER_CFG DMR_MSG_ROUTE_CFG DMR_MSG_ROUTE_LIST_CFG DMR_MSG_NC_REM DMR_MSG_APP_REM DMR_MSG_PEER_REM DMR_MSG_ROUTE_REM DMR_MSG_ROUTE_LIST_REM DMR_MSG_S_TRACE_MASK DMR_MSG_PEER_ACTIVATE DMR_MSG_PEER_DEACTIVATE DMR_MSG_R_NC_STATS DMR_MSG_R_PEER_STATS DMR_MSG_R_APP_STATS DMR_MSG_R_ROUTE_STATS DMR_MSG_R_RL_STATS DMR_MSG_R_PEER_STATE y DMR_MSG_R_MOD_STATS GEN_MSG_MOD_IDENT TIM MSG REGISTER Diameter q TIM_MSG_TICK DMR_MSG_EVENT_IND DMR_MSG_ERROR_IND A DMR_MSG_PEER_STATE_IND MNG_EVT_TRACE_IND MNG_EVT_SELTRACE_IND SCTP_MSG_RX_IND SCTP_MSG_RX_IND SCTP_MSG_STATUS_CHANGE SCTP_MSG_STATUS_CHANGE SCTP_MSG_NETWORK_STATUS SCTP_MSG_NETWORK_STATUS SCTP_MSG_CONG_STATUS SCTP_MSG_CONG_STATUS y Figure 1 Dialogic DSI Diameter Stack DMR Context Diagram 2 3 2 4 2 5 2 6 2 7 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Functional API The Dialogic DSI Diameter Stack is supplied with a supporting Diameter Functional API interface This interface provides a mechanism to access all aspects of
16. Configuration 0x7462 DMR_MSG_APP_CFG Application Configuration 0x7463 DMR_MSG_PEER_CFG Diameter Peer Configuration 0x7464 DMR_MSG_ROUTE_CFG Diameter Route Configuration 0x746f DMR_MSG_ROUTE_LIST_CFG Diameter Route List Configuration 0x7469 DMR_MSG_PEER_ACTIVATE Diameter Peer Activate Request 0x746a DMR_MSG_PEER_DEACTIVATE Diameter Peer Deactivate Request 0x846d DMR_MSG_SESSION_IND Diameter Session Indication Oxc46c DMR_MSG_SESSION_REQ Diameter Session Request 0x7477 DMR_MSG_APP_REM Diameter Application Removal 0x7478 DMR_MSG_PEER_REM Diameter Peer Removal 0x7479 DMR_MSG_ROUTE_REM Diameter Route Removal 0x747a DMR_MSG_ROUTE_LIST_REM Diameter Route List Removal 0x747b DMR_MSG_NC_REM Diameter Network Context Removal 17 Section 4 Message Reference 4 2 18 User Interface Messages Payload messages between DMR and the User Application are all exchanges in one of two message types a Session Request which is generated by the Application and sent to DMR and a Session Indication which is sent from DMR to the Application Typically the user does not deal directly with these messages at the raw message level but makes use of the Diameter Functional API to create a correctly formatted message or recover the parameters from a message Details of the Functional API for the Dialogic DSI Diameter
17. DMR to configure an entry in the Diameter Routing Table for a particular Network Context Format C CONOS ene ETE Description The Diameter Routing table allows the configuration of routing rules for use with Diameter Messages received from the User Application Selection of a Diameter Peer for message routing is based on network conditions and the following 1 Peer route Route selection is made based on a match of the Destination Host protocol parameter 2 Realm route Route selection is made based on a routing key match The routing key consists of the Destination Realm and Application ID protocol parameters the key also includes the user defined network context and routing policy key 3 Default route User defined default route per network context The message must contain either the DMRRT_OPT_DEFAULT run time option or one of the optional parameters DMRCN_DEST_HOST or DMRCN_DEST_REALM If the DMRCN_DEST_REALM parameter is present DURCN_DMTR_APP_ID and DMRCN_POLICY_ID may be used 39 Section 4 Message Reference 40 Parameters DMR_MSG_ROUTE_CFG 0x7464 Parameter Mandatory Default Value Optional DMRCN_DEST_HOST Peer based routing Diameter Destination DMRCN_DEST_REALM Realm based routing Diameter Destination DMRCN_DMTR_APP_ID Realm based routing Geet Application DMRCN_POLICY_ID Realm based routing User defined ROUTE_CFG DMRCN_ROUTE_CFG parameter TT Tan TT TT TT T op
18. Dialogic Dialogic DSI Diameter Stack DMR Programmer s Manual September 2013 www dialogic com Section 1 Introduction Copyright and Legal Notice Copyright 2012 2013 Dialogic Inc AII Rights Reserved You may not reproduce this document in whole or in part without permission in writing from Dialogic Inc at the address provided below All contents of this document are furnished for informational use only and are subject to change without notice and do not represent a commitment on the part of Dialogic Inc and its affiliates or subsidiaries Dialogic Reasonable effort is made to ensure the accuracy of the information contained in the document However Dialogic does not warrant the accuracy of this information and cannot accept responsibility for errors inaccuracies or omissions that may be contained in this document INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH DIALOGIC PRODUCTS NO LICENSE EXPRESS OR IMPLIED BY ESTOPPEL OR OTHERWISE TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT EXCEPT AS PROVIDED IN A SIGNED AGREEMENT BETWEEN YOU AND DIALOGIC DIALOGIC ASSUMES NO LIABILITY WHATSOEVER AND DIALOGIC DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY RELATING TO SALE AND OR USE OF DIALOGIC PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE MERCHANTABILITY OR INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHT OF A THIRD PARTY Dialogic products are not intended
19. Diameter Event Indication Synopsis Message sent by DMR to the management module to indicate a protocol related event has occurred Format hclass status Event Code see below Parameter Area Description Message used by DMR to indicate a Diameter protocol event has occurred Parameters Event Code The event code contained in the status field of the message indicates the type of event Possible values are listed in the following table that also lists the meaning of the id field Garam and param2 in each case Unused values are set to zero A ee DMR_EVENT_DECODE_ int_status A mandatory AVP is AVP_MISSING missing from a ES diameter message DMR_EVENT_DECODE_ int_status An inappropriate AVP AVP_DOESNT_BELONG has been detected m B whilst decoding 66 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_EVENT_DECODE_ DG AVP id An AVP has been AVP_MISFORMATTED decode with an invalid 8 format e g Bad length DMR EVENT DECODE nc_id AVP code bytes_proces A badly formatted AVP ERROR sed Diameter Message has been received Param2 indicates the offset of the error within the Diameter message DMR_EVENT_DECODE_ Session_id MSG_ERROR DMR_EVENT_DECODE_ peer_id PEER_NAME DMR_EVENT_DECODE_ peer_id PEER_REALM DMR_EVENT_NC_UNKN nc_id OWN DMR_EVENT_NC_UNKN app_id OWN_APP_ID DMR_EVENT_NC_APP_ D DMR_EVENT_PEER_ER Peer_id num_app ROR DMR_EVENT_PEER_RE peer_id FUSED
20. IGIN_HOST ORIGIN_HOST 0x07 0x07 Sting GEI enen DVRON NODE NAME 3 f oe sm Destination Realm Realm DMRCN_DEST_REALM DEST_REALM ood ood sting Event Sa ee EVENT_INFO a 0x0e Compound parameter See section 4 5 1 for details Error Information DMRCN_ERROR_INFO 0x0f Compound parameter See section 4 5 2 for details Array of app ids DMRCN_APP_IDS 0x10 Compound parameter See section 4 5 3 for details IP Address Ge DMRCN_IP_ADDR IP_ADDR ga ga See section 4 3 6 for details Policy ld ld ee POLICY_ID oaz ox 2 See section 4 3 7 for details section 4 See section 4 3 7 for details 7 for details Diameter Application E DMTR_APP_ID See section 4 3 7 for details 29 Section 4 Message Reference 4 3 3 30 DMR_MSG_CONFI1G Diameter Configuration Message Synopsis Message used to configure the Diameter module DMR for operation Format Message Header type DMR_MSG_CONFIG 0x7460 r Management Module Id t DMR_TASK_ID Parameter Area e Name CER Description This message is used to configure DMR for operation It should be the first message sent to DMR and any messages received before a valid configuration message will be discarded It should only be issued once The message parameters relate to the environment in which DMR is operating and the various capabilities which will be required of the module Parameters DMR_MSG_CONFIG 0x7460 Par
21. OPEN DMRSR_OPEN DMR CONTINUE DMRSR_CONTIINUE DMR CLOSE DMRSR_CLOSE DMR P ABORT DMRSR_P_ABORT DMR NOTIFY DMRSR_NOTIFY A typical User Initiated session will begin with Session Request containing an Open Primitive which includes the Diameter Command In the simplest case this will be ended by the reception of a Session Indication containing a Close Primitive which includes Answer to the Diameter Command If the Diameter module detects a failure case not initiated by the Peer then a Session Indication containing P Abort is generated 20 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 4 2 3 Session Control Primitives Parameters The following parameter names are defined for use in session primitive messages Parameter Mnemonic Value dec Network context DMRPN_nc ene L aeecze The coding for each parameter type is given in the following tables Parameter length Fixed set to 2 Parameter data Network Context Identifier Defaults to zero if not supplied Parameter name DMRPN_dmtr_msg Parameter length Variable There is no specific max size of this parameter but the complete message containing this parameter must fit within the 4200 octet message structure Parameter data A well formed Diameter Message encoded compliant to RFC3588 starting with the Diameter Command Header and including all AVPs Parameter length Fixed set to 2 Parameter data Provider abort reason Set to one of the followi
22. OR_PEER_NOT_IN USE DMR_ERROR_SSN_OOB EVE session_id NT DMR_ERROR_SSN_CREATION session_id _ FAILED int_status DMR_ERROR_SSN_ANS_TX_F session_id Int_status AILED DMR_ERROR_SSN_DESTRUC session_id int_status T_FAILED DMR_ERROR_SSN_UNEX_EVE session_id session_type NT DMR_ERROR_ROUTE_BAD P route_id d EER ID DMR_ERROR_UNEXP_EVENT nc_id Ki 1 2 3 10 11 12 13 14 20 0 Creation of a Peer could not be performed An event occurred for an unknown peer An event unexpectedly occurred for a peer not in use An event has occurred for a session id that is not in use or out of bounds A session could not be created An attempt to send Answer message has failed An attempt to close a session failed An event has been received which is unexpected for the session type Request processing failed due to an inappropriate peer_id An unexpected event was detected during session processing 71 Section 4 Message Reference 4 5 3 72 DMR_MSG_PEER_STATE_IND Peer Connection State Indication Synopsis Message issued by DMR to advise management of changes in state of the Peer connection Format rsp_req fo lena Parameters in Name Length Data format Set to zero indicating end of message Description This primitive is used by DMR to advise management of changes of state of the Peer Connection This message is intended for diagnostic and maintenance purpos
23. Section 3 Configuration Model 16 See DMR_MSG_ROUTE_CFG Diameter Route Configuration The equivalent s7_mgt command is DMRTI as defined in Software Environment Programmer s Manual Configure one or more Route Lists Uses previously configured Realm Routes and Peer Connections See DMR_MSG_ROUTE_LIST_CFG Diameter Route List Configuration The equivalent s7_mgt command is DMRLI as defined in the Software Environment Programmer s Manual Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 4 Message Reference 4 1 Message Type Summary The following table lists by message type the messages described in this manual Message Type Mnemonic Description 0x0465 DMR_MSG_EVENT_IND Diameter Event Indication 0x0466 DMR_MSG_ERROR_IND Diameter Error Indication 0x0468 DMR_MSG_PEER_STATE_IND Peer Connection State Indication 0x6467 DMR_MSG_S_TRACE_MASK Set Diameter Trace Masks 0x6470 DMR_MSG_R_PEER_STATE Read Peer State Request 0x646e DMR_MSG_R_NC_STATS Diameter NC Statistics 0x6473 DMR_MSG_R_PEER_STATS Diameter Peer Statistics 0x6474 DMR_MSG_R_APP_STATS Diameter Application Statistics 0x6475 DMR_MSG_R_ROUTE_STATS Diameter Route Statistics 0x6476 DMR_MSG_R_RL_STATS Diameter Route List Statistics 0x7460 DMR_MSG_CONFIG Diameter Configuration Message 0x7461 DMR_MSG_NC_CFG Diameter NC
24. Session_id DEST_AVP DMR_EVENT_REQ_NO_ Session_id RESULT_AVP DMR_EVENT_REQ_MISS Session_id ING_AVP DMR_EVENT_ROUTE_U Session_id nc_id NKNOWN DMR_EVENT_ROUTE_U rte_id session_id NAVAILABLE Request has no result or experimental result code specified 9 N A required AVP for message is missing An appropriate route could not be selected The Route selected is currently unavailable for routing N a 69 Section 4 Message Reference 4 5 2 70 DMR_MSG_ERROR_IND Diameter Error Indication Synopsis Message sent by DMR to the management module to indicate an exceptional or erroneous protocol event or implementation error has occurred Format hclass status error code see below Parameter Area Description This message used by DMR to convey the occurrence of an exceptional or erroneous protocol event or implementation error and to convey additional diagnostic information to facilitate investigation of the problem Parameters error code The error code contained in the status filed of the message indicates the type of error Possible values are listed in the following table that also lists the meaning of the id field param1 and param2 in each case Unused values are set to zero Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 el eer O owen serane ees DMR_ERROR_PEER_CREATIO peer_id int_status N_FAILED DMR_ERROR_PEER_UNKNWN peer _id _ERROR DMR_ERR
25. TF 8 String options Run time options for this NC None currently defined 4 3 5 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_APP_CFG Diameter Application Configuration Synopsis Message sent to DMR to configure a Diameter Application for a particular Network Context Format se TT Tr Description Hd CH o n e DMR allows Diameter Applications to be registered against a Network Context Once configured Peer Connections part of the same Network Context will advertise this Application during Capabilities Exchange and messages received for the application will be forwarded to the configured User module_id Parameters DMR_MSG_APP_CFG 0x7462 Parameter Mandatory Default Value Optional 35 Section 4 Message Reference 36 APP_CFG DMRCN_APP_CFG parameter over see TT TT 3 TT application ID The logical id for the application used in communication with DMR concerning this application This value is of local significance between DMR and local configuration and maintenance agents It is distinct and separate to the well known app_id value configured later in this message options Run time options for this application Reserved for future use and should be set to zero mod_id User module ID for this Application mod_inst User Instance for this Application This is of relevance to DMR User applications deployed on remote RSI Hosts nc_id The N
26. ameter Mandatory Default Value Optional Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 MOD_CONFIG DMRCN_MOD_CONFIG parameter Reserved set to zero maint_id Maintenance module ID This is the module to which event and error indications are sent trace_id Trace module ID This is the module to which any trace messages will be sent sctp_id SCTP module ID This is the module_id of the transport layer max_peers The maximum number of Diameter peers that the module is required to support This value is compared with any internal limits base_og_id The first session ID for outgoing sessions that the user wishes to be handled by DMR The subsequent nog_sessions 1 session IDs will also be handled by the module The user must ensure that the values used in the session ID field of all protocol messages pertaining to outgoing sessions lie within the correct range base_ic_id The first session ID for incoming sessions that the user wishes to be handled by DMR The subsequent nic_sessions 1 session IDs will also be handled by the module The Diameter Module allocates the session ID for each incoming session It uses values in the range nog_sessions The maximum number of simultaneous outgoing sessions that the module is required to support This value is compared with any internal limits 31 Section 4 Message Reference nic_sessions The maximum number of simultaneous incoming sessions th
27. at the module is required to support This value is compared with any internal limits max_throughput This parameter is reserved for future use and should be set to zero options Run time options field reserved for future use set to zero 32 4 3 4 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_NC_CFG Diameter NC Configuration Synopsis Message sent to DMR to configure a Diameter Network Context Format a Tar Description CD o r OU Oo The message allows the configuration of independent Diameter Network Contexts Each Network Context embodies a separate Diameter Node each of which can be independently configured allowing different behaviour and routing rules for the module Parameters DMR_MSG_NC_CFG 0x7461 Parameter Mandatory Default Value Optional 33 Section 4 Message Reference 34 DMRCN_NC_CFG parameter U TT CT nc_id The logical id for this Network Context for use in communication with local management and maintenance agents node_ name The user name value which should be used for Diameter protocol messages originated from this node Formatted as a UTF 8 String origin_host The origin_host value which should be used for Diameter protocol messages originated from this node Formatted as a UTF 8 String origin_realm The origin_realm value which should be used for Diameter protocol messages originated from this node Formatted as a U
28. cation All routes within the network context which define a Diameter Application Id as part of its configuration must be removed before attempting to remove an application which shares the same Diameter Application Id 4 3 10 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_PEER_REM Remove Diameter Peer Configuration Synopsis Message sent to DMR to remove a Diameter Peer connection for a particular Network Context Format Message Header fei TT as TT Tj TT 0 err_info len 0 Description The Diameter Module allows Peer Diameter nodes with which it expects to communicate to be statically configured and removed Peer nodes may be Diameter Agents Servers or Clients and may use dynamically or statically configured transport connections Each Peer Connection belongs to a pre configured Network Context All route list entries which reference a peer must be removed prior to removing the peer configuration 45 Section 4 Message Reference 4 3 11 46 DMR_MSG_ROUTE_REM Remove a Diameter Route Configuration Synopsis Message sent to DMR to remove an entry in the Diameter Routing Table for a particular Network Context Format CECR fees ST CIN as CIN C lt Tj TT TT e TT CIN Description The Diameter Routing table may be updated by issuing this message to remove a routing entry Once removed user messages will no longer be matched to this route The n
29. close down an SCTP association SCTP Abort association 0x728c Used by Diameter to initiate the abort of an SCTP association SCTP Data transfer request 0xc280 Used by Diameter to transmit a data packet over an association SCTP Status change 0x028d Indication from SCTP of a change in association status SCTP Data transfer indication 0x8281 Indication from SCTP of a received data packet SCTP Congestion status 0x028f Indication from SCTP of a change in the congestion status of the association SCTP Network status 0x028e Indication from SCTP of a change in status a network address within an association
30. d in the Storage Massage parameter DMRPN_storage_msg e Continue 23 Section 4 Message Reference Used to request a session is maintained and also send either a Diameter Command Request or Answer e Close Used to request a session is closed Typically also includes a Diameter Command Answer Parameter area contents The following table lists the parameters associates with each session request primitive and shows whether the parameter is Mandatory M in which case the message will be discarded is the parameter is omitted or Optional O in which case the parameter is not considered essential Diameter Message BERE Continue 2 Parameter Network Context o Diameter Message Mu M c o 9 O Routing Policy Key Storage Message 24 4 2 5 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_SESSION_IND Diameter Session Indication Synopsis Message sent issued by DMR to the DMR User containing a session indication primitive Format req eS hclass err_info Otse Is E N _ k e fr Session primitive type zg Description This message is used by the DMR to send session primitives to the DMR User All session primitives contain the Session ID of the session to which they belong It is encoded in the message header The following indication primitive types are supported e Open Used to indicate a session has been opened Typically the indication
31. e a Diameter Route List Configuration 47 4 3 13 DMR_MSG_NC_REM Remove Diameter Network Context Confioguration seeccerssrcs 48 4 4 Management Request Messages criada kaka Ml kk kh ZE yaya aa dana base k k n a kk WE kk a n EKE W KA k KE A K K a J KA k dee 49 4 4 1 DMR_MSG_PEER_ACTIVATE Diameter Peer Activate Request ococccccccoconcononcnnnncnnancnnnos 50 4 4 2 DMR_MSG_PEER_DEACTIVATE Diameter Peer Deactivate Reouest kk 51 4 4 3 DMR_MSG_S_TRACE_MASK Set Diameter Trace Masks 0occccccononcononconanconanconanconanconano 52 4 4 4 DMR_MSG_R_NC_STATS Diameter NC Statistics occccccccocccnnnnncnncnnnannnnnnnnnnncnnnannnnnnns 55 4 4 5 DMR_MSG_R_PEER_STATE Read Peer State Request cccocccccccnnoncnnoncnnancnnnncnnnncnnancnnnns 57 4 4 6 DMR_MSG_R_PEER_STATS Diameter Peer Statistics occcccccnnccncnnccnnonnnnnnnnnnncnnnannnnnnns 58 4 4 7 DMR_MSG_R_APP_STATS Diameter Application Statistics coooccococcononconnncnnnncnnnncnnnos 60 4 4 8 DMR_MSG_R_ROUTE_STATS Diameter Route Gtatietlce kk kk kk kk kk kk kk kk 62 4 4 9 DMR_MSG_R_RL_STATS Diameter Route List Statistics hA kh CWILL kk kk kk KRA 64 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 4 5 Event Indication Messages We d kaka ru dak l cas 65 4 5 1 DMR_MSG_EVENT_IND Diameter Event Indication 66 4 5 2 DMR_MSG_ERROR_IND Diameter Error Indication oococccconcncononconanconanconancnnancnnnncnn
32. e logical id of a preconfigured Network Context to which this Peer belongs asc_id The logical id of the transport connection used to communicate with this Peer Messages sent to and received from the Transport Module e g the SCTPN module must be configured to use this logical id host An ASCII or UTF 8 String identifying the expected host name AVP value for this Peer This can be used to correlate dynamically created transport connections with pre configured Peers or to validate statically configured transport addresses advertise the expected host name AVP value realm An ASCII or UTF 8 String identifying the expected realm name AVP value for this Peer This can be used to correlate dynamically created transport connections with pre configured Peers or to validate statically configured transport addresses advertise the expected realm name AVP value ip_addr The local IP addresses to be advertised to the Peer as part of the capabilities exchange Allows up to 4 IP addresses each 17 octets in length formatted as follows Octet Field Description 0 Format Set to value 1 indicating an Ipv4 address 1 4 Network address Octet 1 containing the most significant byte and octet 4 containing the least significant byte 5 17 Reserved Should be set to zero 4 3 7 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_ROUTE_CFG Diameter Route Configuration Synopsis Message sent to
33. e products systems and or releases Dialogic is not responsible for your decision to use open source in connection with Dialogic products including without limitation those referred to herein nor is Dialogic responsible for any present or future effects such usage might have including without limitation effects on your products your business or your intellectual property rights Publication Date September 2013 Document Reference U01DMR Revision History Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Issue Date Description 4 30 Sep 13 Addition of resource removal message definitions 3 22 Feb 13 Multiple updates including addition of new Notify Reason amp Abort Reason parameter values 2 04 Jan 13 Additional primitive types added to DMR Session Indications and Requests Additional statistics supported 1 31 Oct 12 Initial Release for use during Dialogic DSI Diameter Stack beta trial Note The current version of this guide can be found at http www dialogic com support helpweb signaling Section 1 Introduction Contents REVISION History ak l karak ke kin k ak kk kal ka kel k bk a k lk k r ar a a ke KEREN xx aia RENE ar a a an a a bu ERR raa a a 3 1 Introduction 22 ccccccceeseeeee aa HHHH HHHH dd 6 1 1 Aplica pe ar xc e Beya DOK KM 6 1 2 Related Docdu mentatiOf ege seess D xua Dek n xu a 6 2 Gene
34. ed by DMR 2 DMR_MSG_ERROR_IND Trace error indications issued by DMR 3 SCTP_MSG_ACTIVATE Trace SCTP activation requests issued by DMR 4 SCTP_MSG_SHUTDOWN Trace SCTP shutdown requests issued by DMR 5 SCTP_MSG_TX_REQ Trace SCTP transmit requests issued by DMR 7 to 31 Reserved for future use and should be set to zero Ip_mask The input event trace mask This is a 32 bit value with bits set to 1 to cause a trace message to be sent to the system trace module when DMR receives the associated protocol message Bit Message to be Traced Description 0 DMR_MSG_SESSION_REQ Trace session request primitives received by DMR 1 SCTP_MSG_RX_IND Trace SCTP receive indications received by DMR 2 SCTP_MSG_STATUS_ CHANGE Trace SCTP status messages received by DMR 3 SCTP_MSG_CONG_STATUS Trace SCTP congestion indications received by DMR 4 to 31 Reserved for future use and should be set to zero 53 Section 4 Message Reference 54 mngt_mask The management event trace mask This is a 32 bit value with bits set to 1 to cause a trace message to be sent to the system trace module when DMR receives the associated protocol message Bit Message to be Traced Description 0 DMR_MSG_S_TRACE_MASK Trace any set trace mask primitives received by DMR 1 DMR_MSG_NC_CFG Trace NC configuration messages received by DMR 2 DMR_MSG_PEER_CFG Trace peer configuration
35. er Answer A session is made up of one or more transactions between two peer entities Parameters ssn_alloc_count The number of session resources which have been allocated 55 Section 4 Message Reference Ssn_dealloc_count The number of session resources which have been de allocated Tran_alloc_count The number of transaction resources which have been allocated Tran_dealloc_count The number of transaction resources which have been de allocated 56 4 4 5 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_R_PEER_STATE Read Peer State Request Synopsis Message used to query the current Peer State Format LAA one see tame TT TT Tas n TT TT TT TT T dst Description This message allows the user to query the Peer State The user should allocate a message with sufficient space in the parameter area and DMR will fill in the parameter area in the response message Parameters availability Peer availability state Possible values are shown in the table below Value Mnemonic Description 0 DMR_PEER_STATE_UNKNOWN Entered Unknown State 1 DMR_PEER_STATE_CLOSED Entered CLOSED State 2 DMR_PEER_STATE_OPEN Entered OPEN State state_flags Additional state information related to the peer Bit 0 is set to 1 if a request to activate the peer has been made All other bits are reserved for future use and will be set to zero 57 Section 4 Message Reference 4 4
36. es and does not form part of the protocol specified primitives Parameters peer_state The new state of the Peer connection The following table shows the possible values and their meanings Value Mnemonic Description 0 DMR_PEER_STATE_UNKNOWN Entered Unknown State 1 DMR_PEER_STATE_CLOSED Entered CLOSED State 2 DMR_PEER_STATE_OPEN Entered OPEN State Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 APP_IDS An array of App Ids which are appropriate for this Indication DMRCN_APP_IDS parameter 73 Section 5 External Message Definitions 5 74 External Message Definitions The Dialogic DSI Diameter Stack is intended for use in conjunction with the Dialogic DSI SIGTRAN Stack SCTP Layer Specifically it is intended for use with the SCTPN binary which makes use of the Native SCTP stack within the host operating system It provides a DSI message based interface which is used by the DSI Diameter Stack for the purpose of controlling the SCTP associations and transferring date to the peer node Detail of the interface to the SCTPN binary is contained within the Dialogic DSI SCTP Programmer s Manual The following primitives are used by the DSI Diameter Stack Primitive Message Description Type SCTP Activate association 0x728a Used by Diameter to activate an SCTP association SCTP Shutdown association 0x728b Used by Diameter to gracefully
37. est Synopsis This primitive is used by management to request DMR to deactivate the specified peer connection Format CECR fe CIC CIN es CIN ECT Tj TT C C Ti TT Description On receipt of this message DMR attempts to deactivate the specified Peer connection 51 Section 4 Message Reference 4 4 3 52 DMR_MSG_S_TRACE_MASK Set Diameter Trace Masks Synopsis Message used by management to set the DMR trace masks Format Message Header Field Name type DMR_MSG_S_TRACE_MASK 0x6467 Sending module id S fe n CH oop pes Description The trace masks allow the user to request messages generated and received by the DMR module to be copied and traced to the trace module for diagnostic purposes Tracing can be turned on and off dynamically on a per primitive basis Tracing is controlled by three 32 bit masks output input and management and bits set to one in the mask cause messages of that type to be traced Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Parameters op_mask The output event trace mask This is a 32 bit value with bits set to 1 to cause a trace message to be sent to the trace module when DMR sends the associated protocol message Bit Message to be Traced Description 0 DMR_MSG_SESSION_IND Trace session indication primitives issued to user by DMR 1 DMR_MSG_EVENT_IND Trace event indication issu
38. etwork Context Id this application is being registered with vendor_id The Diameter Vendor ID AVP value for use in Diameter capability negotiation dmtr_app_id The Diameter Application ID AVP value for use in Diameter capability negotiation 4 3 6 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_PEER_CFG Diameter Peer Configuration Synopsis Message sent to DMR configure a Diameter Peer connection for a particular Network Context Format fC Hclass err_info Parameters in Name Length Data format Zo Set to zero indicating end of message Description The Diameter Module allows Peer Diameter nodes with which it expects to communicate to be statically configured Peer nodes may be Diameter Agents Servers or Clients and may use dynamically or statically configured transport connections Each Peer Connection belongs to a pre configured Network Context Parameters DMR_MSG_PEER_CFG 0x7463 Parameter Mandatory Default Value Optional 37 Section 4 Message Reference 38 PEER_CFG DMRCN_PEER_CFG parameter E E peer_id The logical id of this Peer used for control and communication of the Peer by local management and maintenance agents options Run time options for this Peer assigned according to the following table Bit Mnemonic Description 0 DMR_PEER_OPT_SERVER Set if the transport connection end point acts as the Server side nc_id Th
39. ext available route matching the routing parameters of the user message will be selected All route list entries which reference a route must be removed prior to removing the route configuration 4 3 12 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMR_MSG_ROUTE_LIST_REM Remove a Diameter Route List Configuration Synopsis Message sent to DMR to remove a single route list entry Each route list entry defines a mapping between a route and a peer for use in the Diameter Routing Table Format Message Header DMR_MSG_ROUTE_LIST_REM 0x747a C t CO CTN ST CI CO TT Tj TT C CAT Tj TT fen Description The Diameter Routing Table allows removal of Route List entries which associate a peer with a route The peer defined in the Route List is a candidate next hop destination for the route 47 Section 4 Message Reference 4 3 13 48 DMR_MSG_NC_REM Remove Diameter Network Context Configuration Synopsis Message sent to DMR to remove a Diameter Network Context configuration Format Deen JO weng CONS CAEN err_info Description DMR allows Diameter Network Contexts to be removed All resources currently configured within this network context such as Peers Routes Route Lists and Applications must be removed prior to removing the Network Context configuration 4 4 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Management Request Messages This section
40. faces it will use to communicate with other parts of the system It also allows module wide settings to be selected See DMR_MSG_CONFIG Diameter Configuration Message The message is generated by s7_mat if the command SNSLI defines one or more Diameter associations 2 Configure one or more Network Contexts At least one of these is required and additional Network Contexts are required to connect to each distinct network It defines settings that are specific to an individual network See DMR_MSG_NC_CFG Diameter NC Configuration The equivalent s7_mgt command is DMNCI as defined in the Software Environment Programmer s Manual 3 Configure each local application Defines the local application to be supported for the purposes of capability negotiation Also defines the mapping between the well known AVP values for applications and a local application identifier See DMR_MSG_APP_CFG Diameter Application Configuration The equivalent s7_mgt command is DMAPI as defined in the Software Environment Programmer s Manual 4 Configure one or more Peer Connections Defines a remote peer connection entity within a previously configured Network Context See DMR_MSG_PEER_CFG Diameter Peer Configuration The equivalent s7_mgt command is DMPRI as defined in the Software Environment Programmer s Manual 5 Configure one or more Routes Defines the destination host and destination realm and links them to a Realm route 15
41. for use in certain safety affecting situations Please see http www dialogic com company terms of use aspx for more details Due to differing national regulations and approval requirements certain Dialogic products may be suitable for use only in specific countries and thus may not function properly in other countries You are responsible for ensuring that your use of such products occurs only in the countries where such use is suitable For information on specific products contact Dialogic Inc at the address indicated below or on the web at www dialogic com It is possible that the use or implementation of any one of the concepts applications or ideas described in this document in marketing collateral produced by or on web pages maintained by Dialogic may infringe one or more patents or other intellectual property rights owned by third parties Dialogic does not provide any intellectual property licenses with the sale of Dialogic products other than a license to use such product in accordance with intellectual property owned or validly licensed by Dialogic and no such licenses are provided except pursuant to a signed agreement with Dialogic More detailed information about such intellectual property is available from Dialogic s legal department at 1504 McCarthy Boulevard Milpitas CA 95035 7405 USA Dialogic encourages all users of its products to procure all necessary intellectual property licenses required to implement any concepts or applicati
42. he Parameter Name two bytes for the Parameter Length and two bytes for the terminator zero The parameter area for each configuration message is constructed as a list of parameters each in Name Length Data format followed by a two byte terminator Name set to zero indicating that there are no further parameters For each message the first configuration parameter contains the main fixed length configuration parameters for the message The following diagrams illustrate the parameter area coding Main Configuration Additional Additional Additional Zero Parameter Parameter Parameter Parameter Each parameter is formatted as follows 2 byte 2 byte Parameter length bytes Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 4 3 2 Configuration Parameter Definitions Parameter Value Value Type decimal hex Module Configuration DMRCN_MOD_CONFIG 1 0x01 Compound parameter See section 4 3 3 for details Network context DMRCN_NC_CFG 2 0x02 Compound parameter See section 4 3 4 for details Peer Configuration DMRCN_PEER_CFG 3 0x03 Compound parameter See section 4 3 6 for details Application DMRCN_APP_CFG 4 0x04 Compound parameter Configuration See section 4 3 7 for details Route Configuration DMRCN_ROUTE_CFG 5 0x05 Compound parameter See section 4 3 7 for details Route List DMRCN_ROUTE_LIST_CFG 0x06 Compound parameter Configuration Geen section 4 3 8 for details Origination Host Origination Host DMRCN_OR
43. ime Route configuration and selection is made based on Diameter Host or Diameter Realm and Application Id as per the Diameter specifications The Diameter module extends this functionality to offer greater routing control to the User application by allowing messages for a particular destination to be routed differently under the run time control of the user For instance the user application may wish to route all messages for a particular set of subscribers or a particular command code via a different relay node for special processing Or while testing a new feature certain messages may require routing via a test system This is achieved by the use of the optional policy_id parameter when both configuring a route and sending DMR_SESSION_REQ messages DMR maintains routing tables which contain the configured routing rules All entries within a routing table must be distinct such that it is deterministic which route will be selected for a given Destination Host Destination Realm and Application Id The policy_id allows the creation of multiple routing tables for the same Diameter Node If a route configuration message has the policy_id parameter included then the route will be considered part of that specific routing table When a message is received by DSI Diameter for routing if the policy_id is present then route selection will first search the corresponding route table Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4
44. ion Control Primitives Parameters hLkh khkkhkk kkklkkkk kk kk kk kk kk aka kaka kk kak kk kak kk kk kk kk kk 21 4 2 4 DMR_MSG_SESSION_REQ Diameter Session Request MkK KAK G AVAWK A i a a kk kk kk kk kk kk k 23 4 2 5 DMR_MSG_SESSION_IND Diameter Session Indication ocoocccncncononconanconanconancnnnnnonano 25 4 3 Configuration MESSAGES rissin tini reg kal n a Eka al ENEE REENEN ke yA ye k ated sey kay ek k e ka k 27 4 3 1 Configuration Parameter FOrmat cccccececceceeceeeeeeeeeeteesteuseeeeteseteeseeeeeneteeauseteeneserenens 28 4 3 2 Configuration Parameter Definttions 29 4 3 3 DMR_MSG_CONFIG Diameter Configuration Message Mhk A_ k h kkkk kk kk kk kk kk kk kk kk kk kk kK AA 30 4 3 4 DMR_MSG_NC_CFG Diameter NC Confioguration kk kk kk kk kk kk kk kk K k KA 33 4 3 5 DMR_MSG_APP_CFG Diameter Application Configuration oococcccccccnconononononononenonananono 35 4 3 6 DMR_MSG_PEER_CFG Diameter Peer Configuration khkhkkk kh klklkkk kk kk kk kk kk kk kK KAR 37 4 3 7 DMR_MSG_ROUTE_CFG Diameter Route Conftouration 39 4 3 8 DMR_MSG_ROUTE_LIST_CFG Diameter Route List Confiouration 42 4 3 9 DMR_MSG_APP_REM Remove Diameter Application Configuration ocococococononononononono 44 4 3 10 DMR_MSG_PEER_REM Remove Diameter Peer Configuration 45 4 3 11 DMR_MSG_ROUTE_REM Remove a Diameter Route Confiouration eseeserrerrerrsrrre 46 4 3 12 DMR_MSG_ROUTE_LIST_REM Remov
45. ment capabilities to those offered for other SS7 and SIGTRAN protocol layers DMR uses the services provided by the SCTP layer of the Dialogic DSI SIGTRAN Stack for the transfer of messages between Diameter Peers Dialogic s Diameter Functional API is an API layer for use by the User Application allowing easy development of Diameter applications without being encumbered with complex encoding and decoding rules DMR is an event driven task that uses standard structured message types for communication with other layers of the protocol stack These messages are used to convey the protocol primitives between DMR and the User application and between DMR and SCTP This manual provides details of the interface to DMR It is intended for use during Configuration Operation and Maintenance of systems that use the DSI Diameter Stack Application Developers should refer instead to the Diameter Functional API Manual Applicability This manual is applicable to the following software Dialogic DSI Development Package for Solaris Release 5 4 0 or later Dialogic DSI Development Package for Linux Release 6 6 1 or later Related Documentation Current software and documentation supporting Dialogic DSI components is available at http www dialogic com support helpweb signaling The following User Documentation relates to the use of the Dialogic DSI Diameter Stack e Dialogic DSI Diameter Stack Diameter Functional API Manual e Dial
46. ng values DMRPA_REQUEST_TIME_OUT 1 DMRPA_GUARD_TIMER_TIMEOUT 2 DMRPA_UNKNOWN_SSN 3 DMRPA_FORMAT_ERR 4 DMRPA_INVALID_REQ 5 DMRPA_INVALID_COMMAND 6 DMRPA_ROUTE_UNKNOWN 7 DMRPA_ROUTE_UNAVAILABLE 8 DMRPA_RESOURCE_UNAVAILABLE 9 DMRPA_FAILURE_TO_SEND 10 21 Section 4 Message Reference DMRPN_routing_policy_key Parameter length Fixed set to 2 Parameter data The policy identifier to be used to route the Diameter message See section 2 9 Policy Based Routing Parameter length Fixed set to 2 Parameter data Reason for notice generation DMRNR_FORMAT_ERR 1 DMRNR_BAD_NC 2 DMRNR_INVALID_REQ 3 DMRNR_MISSING_PARAM 4 DMRNR_COMMAND_PRS_ERR 5 DMRNR_MISSING_AVP 6 DMRNR_PENDING_RSP 7 DMRNR_REQUEST_TIME_OUT 8 DMRNR_FAILURE_TO_SEND 9 DMRPN_user_action Parameter length Fixed set to 4 Parameter data User Action bit field DMRUA_FLAGS_GRANT 0x00000001 DMRUA_FLAGS_ DENY 0x00000002 DMRUA_FLAGS_STORE 0x00000004 DMRUA_FLAGS_SVC_ERROR 0x00000008 DMRUA_FLAGS_UNKNOWN 0x00000010 DMRUA_FLAGS_DELETE 0x00000020 Parameter name DMRPN_storage_msg Parameter length Variable There is no specific max size of this parameter but the complete message containing this parameter must fit within the 4200 octet message structure Parameter data For Session Requests this parameter is used in place of the DMRPN_dmtr_msg parameter to indicate a message that had previously been stored and should
47. ns 70 4 5 3 DMR_MSG_PEER_STATE_IND Peer Connection State Indication ococcccccncnnnnnncnnnnnnnos 72 5 External Message Definitions k Kk kK kK kllkdllkldlkkclkkkkkkkkkkkkkk kaka kk kk ER kaka kaka aa ak kanan u ua un au uan u naka aA 74 Figures Figure 1 Dialogic DSI Diameter Stack DMR Context Diagram k x k a kak 8 Figure 2 Route Table Structure A yA ceed cove E eld ue eege hated ele ee eel 11 Figure 3 Example route configuration ek kk keka keka keka keka keka kk ka keka keka K KEKE KE KAKE REKE KA KARA 12 Figure 25 Ro te Selerctiopckltmwe SSES a E ka E a a HE K ke xua KE k a KE K keke KEW Y 13 Section 1 Introduction 1 Introduction 1 1 1 2 The Dialogic DSI Diameter Stack is a software implementation of the IETF Diameter Base Protocol which is intended to facilitate development of user applications that interface to LTE and IMS networks for the implementation of services in the areas of Mobility Online Charging and Offline Charging The Dialogic DSI Diameter Stack includes a message based binary Diameter Module a Functional API Library and utility components and header files for use when developing a User Application Dialogic s Diameter Module DMR implements the Diameter Base Protocol offering a message based API to the User Application to control Diameter sessions DMR is a member of the family of Dialogic DSI Components and offers similar message based interfaces and manage
48. ogic DSI Components Software Environment Programmer s Manual e Dialogic DSI SIGTRAN Stack SCTP Programmer s Manual 2 2 1 2 2 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 General Description Feature Overview Features of the Dialogic DSI Diameter Stack include Implementation of Diameter Peer State Machine Transaction buffering and failover functionality Implementation of Session State Machines Implementation of Realm Routing Table Operation as Client or Server Functional API offering full encode decode of messages Customizable API supporting interface extension and modification User loadable Diameter definition dictionaries Module interfaces The following figure Figure 1 shows a Context Diagram for the Dialogic DSI Diameter Stack Diameter Module DMR showing the external interfaces to the module Each interface is message based and connects to one of the following entities Diameter User Typically using the Dialogic DSI Diameter Stack Functional API libraries which provide access to the user module to allow it to send and receive the Diameter primitive messages Management The module is configured using messages Messages are also used to send indications of relevant events to the configured management module so they can be handled or logged Timer The module derives timing signals from the timer module supplied as part of the Dialogic DSI Development Package S
49. ons and does not condone or encourage any intellectual property infringement and disclaims any responsibility related thereto These intellectual property licenses may differ from country to country and it is the responsibility of those who develop the concepts or applications to be aware of and comply with different national license requirements Dialogic Dialogic Pro Dialogic Blue Veraz Brooktrout Diva Diva ISDN Making Innovation Thrive Video is the New Voice VisionVideo Diastar Cantata TruFax SwitchKit SnowShore Eicon Eiconcard NMS Communications NMS stylized SIPcontrol Exnet EXS Vision PowerMedia PacketMedia BorderNet inCloud9 I Gate ControlSwitch NaturalAccess NaturalCallControl NaturalConference NaturalFax and Shiva among others as well as related logos are either registered trademarks or trademarks of Dialogic Inc and its affiliates or subsidiaries Dialogic s trademarks may be used publicly only with permission from Dialogic Such permission may only be granted by Dialogic s legal department at 1504 McCarthy Boulevard Milpitas CA 95035 7405 USA Any authorized use of Dialogic s trademarks will be subject to full respect of the trademark guidelines published by Dialogic from time to time and any use of Dialogic s trademarks requires proper acknowledgement The names of actual companies and products mentioned herein are the trademarks of their respective owners This document discusses one or more open sourc
50. ral Description KKK KEEN RE RE RE RE kk kaka kk kaka ka kanunu uan nau nana au ua un uu uu nuna uu nau u aku an 7 2 1 Feature Overview sconces b ba A an kk ihe aA A a ak tte 7 2 2 Module Interfaces as Na ary Way AWA Aa Ya A Wa Va Van VANA Aa NE Nan Na Va E ka Sek SER HER YERE ERO YE RE WERE YE TEN E ka UR 7 2 3 Segel E IR EE 9 2 4 elan i el SI A gt EE 9 2 5 MESA e 9 2 6 MEE ana x la Alka aa k k EEN EA EEN E ENEE a an kb onde xed ka NEEN NENNEN 9 2 7 Event Reporting PESIN MN eater Niele r gg a a a M 9 2 8 ES Si g CLON cocida 10 2 9 Policy Based ROUTING xw dry r EE r Ee ee Ee ee eege ege EYE YY VEYE W Y E ka eege 10 3 Configuration Model RR dika k Dl k a kara ya kan d ka ra a aka wi ku a EE w kk ka a lr ka a W a a a ua a dra EN k aa 14 3 1 Mod CiU yan yas kab kek kaka kab y k eka WA kay yab Wale kab Y EES SES ee 14 3 2 System Configura slol n DD r r r ra oped tana ning aro atar n aaa kaaa 15 3 3 Configuration SCQUCHCO we ae ev n ans 15 4 Message Reterence lias ka kk kak lki sla ka kak kl kak kk k kir ka ka l BE k balk ka k waa k k kk k xa a kl k n kar ka a 17 4 1 Message Typ S TA o ca 17 4 2 User Interface MESSAGES ii oa 18 4 2 1 Session Control Primitives Parameter Area 19 4 2 2 Session Control Primitives Primitive Type ahhLhhkh kkkk kk kk kk kk kaka kaka kaka aka aka aka aka kak 20 4 2 3 Sess
51. sages redirected to an alternative peer 63 Section 4 Message Reference 4 4 9 64 DMR_MSG_R_RL_STATS Diameter Route List Statistics Synopsis Message used to query measurements for a specific Diameter Route List entry Format status 0 Leave stats unchanged 1 Reset stats after reading Parameter Area err_info TERE SEN TT ZERER T TT asena TT Description This message allows the user to query a specific Diameter Route List entry to read measurements The counters can be reset or left unchanged depending on the setting of the status field The user should send the message with all fields set to zero Parameters period Period over which the measurements have been collected in multiples of 100ms Down_count Count of Route List state transitions to the DOWN state Up_duration Duration within period the Route List has been in the UP state in multiples of 100ms 4 5 Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 Event Indication Messages Event indication messages are the mechanism by which protocol and software error events are reported to management The following event indication messages generated by DMR are documented in this section e DMR_MSG_EVENT_IND Diameter Event Indication e DMR_MSG_ERROR_IND Diameter Error Indication e DMR_MSG_PEER_STATE_IND Peer Connection State Indication 65 Section 4 Message Reference 4 5 1 DMR_MSG_EVENT_IND
52. t is available Peer Beta Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 The general flow through route selection logic is shown below Route Selection DMR_SESSION_REQ Does request include Policy_ID No Select Correct Normal Routing Table Search for route based on Host Realm Application Was Route Found Return No Route Error Return Found Route Figure 4 Route Selection Flow Note Route Configuration and Selection Network Contexts Yes Select Correct Policy ID Routing Table Search for route based on Host Realm Application Was Route Found Yes Return Found Route operates independently for different 13 Section 3 Configuration Model 3 3 1 14 Configuration Model Module Configuration Diameter Module Diameter Node Diameter Application Diameter Application Peer Connection Peer Connection The module configuration consists of the following principal elements Diameter Module The DSI Diameter Module DMR receives configuration to control run time resource allocation and configure communication with supporting modules Diameter Node The module may simultaneously support several Diameter Nodes each of which is independently visible in the Diameter network s Each node has its own User Name Origin Realm Origin Host and Peer Connections
53. tatic configuration of Route Lists which associate a peer with a route The peer defined in the Route List is a candidate next hop destination for the route A route may be associated with multiple peers and a peer may be associated with multiple routes Parameters DMR_MSG_ROUTE_LIST_CFG 0x746f Parameter Mandatory Default Value Optional Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 ROUTE_CFG DMRCN_ROUTE_LIST_CFG parameter KAREK Ce TT TT z TT TT options Run time options Reserved for future use and should be set to zero Route_id The logical id of the route for which the peer_id will be associated peer_id The logical id of the peer which can be used as a next hop destination for the route_id 43 Section 4 Message Reference 4 3 9 44 DMR_MSG_APP_REM Remove Diameter Application Configuration Synopsis Message sent to DMR to remove a Diameter Application for a particular Network Context Format Message Header CIN ETT YEN CN IN 0 status err_info 0 len 0 Description DMR allows Diameter Applications to be removed from a Network Context Once removed Peer Connections part of the same Network Context will no longer advertise this Application during Capabilities Exchange and messages received for the application will be no longer be forwarded to the user All peers within the network context must be deactivated prior to removing an appli
54. tions Run time options for this Peer assigned according to the following table Bit Mnemonic Description 0 DMRRT_OPT_DEFAULT Designates this route as the Default Route for this Network Context A default route will be used if an attempt to route does not match a host based or realm based route 1 DMRRT_OPT_LOAD_SHARE Load share traffic between available peer connections based on NAI value nc_id The logical id of the Network Context for which this route applies DMRCN_DMTR_APP_ID The Diameter Application Identifier for which this route applies DMRCN_DMTR_APP_ID parameter Zal a dmtr_app_id Dialogic DSI Diameter Stack DMR Programmer s Manual Issue 4 DMRCN_POLICY_ID A user defined identifier providing a routing policy for the route The policy id is used to distinguish routes which otherwise share common routing parameters The value can be used in to control route selection on a per message basis DMRCN_POLICY_ID parameter 41 Section 4 Message Reference 4 3 8 42 DMR_MSG_ROUTE_LIST_CFG Diameter Route List Configuration Synopsis Message sent to DMR to configure a single route list entry Each route list entry defines a mapping between a route and a peer for use in the Diameter Routing Table Format rsp_req Status err_info Parameters in Name Length Data format Set to zero indicating end of message Description The Diameter Routing Table allows s

Issue 4 - Dialogic

Contents

Download Pdf Manuals

Related Search

Related Contents