1. Manuals
  2. Brands
  3. Dialogic Manuals
  4. Computer Hardware
  5. DSI M3UA
  6. Programmer's manual

Dialogic DSI M3UA Programmer's Manual

Protocol stacks
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
®
Dialogic
DSI Protocol Stacks
M3UA Programmer's Manual
March 2017
U02STN
www.dialogic.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the DSI M3UA and is the answer not in the manual?

Questions and answers

Related Manuals for Dialogic DSI M3UA

Summary of Contents for Dialogic DSI M3UA

  • Page 1 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual March 2017 U02STN www.dialogic.com...
  • Page 2 3300 Boulevard de la Côte-Vertu, Suite 112, Montreal, Quebec, Canada H4R 1P8. 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.
  • Page 3 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Revision History Issue Date Description 24-Mar-17 Route status message updates, load share update addition of message 0x62b6 M3U_MSG_R_SERV_ASSOC_LIST Update to M3U_MSG_R_ROUTE_STATUS 16-Dec-14 Addition of new measurements messages: 0x62b2 M3U_MSG_R_GL_STATS Read global traffic statistics...

  • Page 4: Table Of Contents

    Contents Contents Introduction ......................7 Feature Overview ........................7 Related Documentation ......................8 Abbreviations ......................... 8 General Description ..................... 9 Module Overview ........................9 2.1.1 ASP and IPSP Operation ....................9 Module Configuration ......................9 System Activation ........................9 Throughput Monitoring ......................10 2.4.1 Read current rate and read peak rate.
  • Page 5 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.2.13 ASP DOWN Indication ....................40 6.2.14 ASP DOWN Confirmation ................... 41 6.2.15 ASP ACT Indication ....................42 6.2.16 ASP ACT Confirmation ....................44 6.2.17 ASP INACT Indication ....................46 6.2.18...
  • Page 6 Contents Figures Figure 1: Connecting via SGs ......................15 Figure 2: Connecting to Peer Applications without Signaling Gateways ..........17 Figure 3: Message Sequence for a single SG and ASP connection............115 Tables Table 1. Primitives from M3UA to SCTP ................... 20 Table 2.

  • Page 7: Introduction

    Introduction ® The Dialogic DSI M3UA module is a software implementation of the IETF SIGTRAN, SS7 MTP3 User Adaptation Layer (M3UA). This Programmer's Manual is intended for users choosing to develop their own application programs that will interface with and use the functionality provided by the M3UA module.

  • Page 8: Related Documentation

    DSI SS7 Programmer's Manual for SIGTRAN Host Software ® Dialogic DSI SCTP Programmer's Manual ® Dialogic DSI Software Environment Programmer's Manual Enabling Dual-Chassis Fault Tolerance with Dialogic® SIGTRAN Protocols Abbreviations Abbreviation Description Application Server Application Server Process IETF The Internet Engineering Task Force...

  • Page 9: General Description

    The M3UA module interfaces with SCTP using the User Primitives defined in © the Dialogic DSI SCTP Programmer's Manual. 2.1.1 ASP and IPSP Operation When used as part of an ASP or IPSP, M3UA offers a primitive interface to its Users identical to that of MTP3.

  • Page 10: Throughput Monitoring

    Section 2: General Description 3. Send an ASP UP Request to the peer SGP or IPSP 4. Wait for an ASP UP Acknowledgement or retransmit the ASP UP request (ASP UP is indicated to Layer Management with the M3U_MSG_ASP_UP_CON or M3U_MSG_ASP_UP_IND message). 5.

  • Page 11: Read Current Rate And Read Peak Rate

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Description Throughput TDM Link Associations Equivalents* In kilobits per second SS7SBHSTM3UAU 312kb/s SS7SBHSTM3UAT 616kb/s SS7SBHSTM3UAS 1,232kb/s SS7SBHSTM3UAR 2,464kb/s SS7SBHSTM3UAL 4,920kb/s SS7SBHSTM3UAK 9,832kb/s SS7SBHSTM3UAJ 19,664kb/s SS7SBHSTM3UAM 29,496kb/s SS7SBHSTM3UAN 39,328kb/s SS7SBHSTM3UAP 58,984kb/s...

  • Page 12: Load Sharing

    2. Select an SCTP Stream in the Association using the lowest bits in the SLS. Dual Resilient Systems Details of how to configure and use M3UA as part of a Dual Resilient system ® may be found in [6] Enabling Dual-Chassis Fault Tolerance with Dialogic SIGTRAN Protocols, available from the Dialogic Web Site.

  • Page 13: Configuration Model

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Configuration Model This section describes the configurable entities supported by the M3UA module. This description is intended to assist the user in understanding the operation of the module. It is not necessary to acquire detailed knowledge of these entities in order to use the module.

  • Page 14: Server

    Section 3: Configuration Model Server A Server is a logical entity which controls the routing of SS7 traffic, between a Signaling Gateway and an SS7 Point Code, or for IPSPs, between two different SS7 Point Codes. Once M3UA peers have established communication by sending and receiving UP requests, Application End Points and Signaling Gateways indicate they are ready to send and receive SS7 Data traffic by sending and receiving ACTIVE requests.

  • Page 15: System Configuration

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Signaling Gateway DPC 6379 M3UA Application Host DPC 10653 DPC 1523 Signaling Gateway DPC 1524 Figure 1: Connecting via SGs This example requires the following M3UA configuration: 3.6.1 System Configuration ...

  • Page 16: Route Configuration

    Section 3: Configuration Model  Add Signaling Gateway relationship #2 to Association #4 to using M3U_MSG_ADD_SERV_ASSOC If The Signaling Gateway Expects a Routing Context then this is specified at this point. If not then set the option to say no routing context is being used. 3.6.4 Route Configuration ...

  • Page 17: System Configuration

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Peer Application DPC 378 M3UA Application Host Peer Application DPC 12874 Figure 2: Connecting to Peer Applications without Signaling Gateways This example requires the following M3UA configuration: Note: There is no Route Configuration required.
  • Page 18 Section 3: Configuration Model  Add RAS relationship #2 to Association #3 using M3U_MSG_ADD_SERV_ASSOC  Add RAS relationship #2 to Association #4 using M3U_MSG_ADD_SERV_ASSOC If the Application Server expects a Routing Context then this is specified at this point. If not then set the option to say no routing context is being used.

  • Page 19: Interface To System Services

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Interface to system services System Functions In addition to the primitive interface and the management interface to the M3UA module (which is described in Section 6: Message Reference), the module requires a few basic system services to be supplied by the underlying operating system.

  • Page 20: External Message Definitions: Sctp

    Section 5: External Message Definitions: SCTP External Message Definitions: SCTP The Dialogic® DSI M3UA module is intended to interface to the Dialogic® DSI SCTP module. However it can interface with any other implementation of SCTP which satisfies the SCTP / User interface defined in the SCTP Programmer’s Manual.

  • Page 21: Message Reference

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Message Reference User Interface The interface to the user application is a superset of messages defined for the MTP3 User interface. These use information in the MTP Routing Label to route messages.

  • Page 22: Api_Msg_Rx_Ind

    Section 6: Message Reference 6.1.2 API_MSG_RX_IND Synopsis Message issued to the User Part by M3UA to indicate reception of a Message Signal Unit. Message Format Message Header Field Name Meaning type API_MSG_RX_IND (0x8f01) MTP label format M3UA (las_mod_id) User Part module id rsp_req hclass status...

  • Page 23: Mtp_Msg_Pause

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.1.3 MTP_MSG_PAUSE Synopsis Message issued to the User Part by M3UA to indicate the total inability of providing MTP service to the specified destination. Message Format Message Header Field Name...

  • Page 24: Mtp_Msg_Resume

    Section 6: Message Reference 6.1.4 MTP_MSG_RESUME Synopsis Message issued to the User Part by M3UA to indicate to the user the ability of providing MTP service to the specified destination. Message Format Message Header Field Name Meaning type MTP_MSG_RESUME (0x8404) User Part Reference M3UA (las_mod_id) User Part module id...

  • Page 25: Mtp_Msg_Status

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.1.5 MTP_MSG_STATUS Synopsis Message issued to the User Part by M3UA to indicate to the user the partial inability of providing MTP service to the specified destination. Message Format Message Header...

  • Page 26: Management Interface

    Section 6: Message Reference Value Description Unknown Unequipped User Inaccessible User Management Interface All primitives at the M3UA / management interface are passed by sending messages between the modules. Primitives generated by the M3UA module are sent to the management module specified in the M3U_MSG_CONFIG message.

  • Page 27: Asp Down Request

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters Options Option Description M3UOP_ASP_UP_AUTO Request M3UA to automatically bring up the ASP and generate ASPSM UP messages 6.2.2 ASP DOWN Request Synopsis Sent by Layer Management to start ASP DOWN procedures.

  • Page 28: Asp Act Request

    Section 6: Message Reference 6.2.3 ASP ACT Request Synopsis Sent by Layer Management to initiate AS Activation procedures for a specific association. Once the ASP is active traffic can be sent across it. Message Format Message Header Field Name Meaning type M3U_MSG_ASP_ACT_REQ (0x72da) Association ID...
  • Page 29 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 options Option Value Description ASP_ACT_REQ_OPT_AUTO 0x01 Request M3UA to automatically maintain the ASP in state ACTIVE ASP_ACT_REQ_OPT_SERV_ID 0x02 Use num_serv_id and serv_id list. (alternative is num_rc and route_ctxt list) tr_mode Traffic mode in which the AS will attempt to activate.

  • Page 30: Asp Inact Request

    Section 6: Message Reference 6.2.4 ASP INACT Request Synopsis Sent by Layer Management to initiate AS Deactivation Procedures for a specific association. Once the ASP is INACTIVE it can no longer carry User Data. Message Format Message Header Field Name Meaning type M3U_MSG_ASP_INACT_REQ (0x72dd)
  • Page 31 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 options Option Value Description ASP_INACT_REQ_OPT_AUTO 0x01 Request M3UA to automatically maintain the ASP in state INACTIVE ASP_INACT_REQ_OPT_SERV_ID 0x02 Use num_serv_id and serv_id list. (alternative is num_rc and route_ctxt list) num_serv_id...

  • Page 32: Ss7 Signaling Network Management Event Request

    Section 6: Message Reference 6.2.5 SS7 Signaling Network Management Event Request Synopsis This message is used to request the transmission of an M3UA signaling network management message, DAVA, DUNA, DAUD or DRST. Note: M3UA will automatically generate DAUD messages therefore it is not expected this message will be needed on an ASP system.
  • Page 33 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters Event type Indicates the type of the event to send to the peer. Mnemonic Value Description M3U_SSNM_EVT_DUNA Destination Unavailable M3U_SSNM_EVT_DAVA Destination Available M3U_SSNM_EVT_DAUD Destination State Audit M3U_SSNM_EVT_DRST Destination Restricted Options Optional parameters present bitmask (see below).

  • Page 34: Ss7 Network Congestion State

    Section 6: Message Reference 6.2.6 SS7 Network Congestion State Synopsis This message causes M3UA to generate an SS7 network congestion state message. Message Format Message Header Field Name Meaning type M3U_MSG_SSNM_SCON (0xc2e6) Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error...
  • Page 35 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters options Options as follows: Value Description M3U_SSNM_OPT_SERV_ID_PRES Server ID present M3U_SSNM_OPT_CONG_PRES Congestion parameter present M3U_SSNM_OPT_CPC_PRES Concerned point codes present M3U_SSNM_OPT_ASS_ID_PRES Association ID present serv_id Server ID affected. net_ctxt Network Context the affected Point Codes belong to.

  • Page 36: Activate Association

    Section 6: Message Reference 6.2.7 Activate Association Synopsis Sent to the M3UA module to activate an SCTP association to a peer. Message Format Message Header Field Name Meaning type M3U_MSG_ACT_ASSOC (0x72ce) Association ID Originating module M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error...

  • Page 37: Deactivate Association

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.2.8 Deactivate Association Synopsis Sent to the M3UA module to deactivate an association. Message Format Message Header Field Name Meaning type M3U_MSG_DEACT_ASSOC (0x72cf) Association ID Originating module M3UA Module rsp_req...

  • Page 38: M3U_Msg_Activate Request

    Section 6: Message Reference 6.2.9 M3U_MSG_ACTIVATE Request Synopsis One shot message to activate an Association, bring the ASP UP across the Association and activate the AS across the Association. This command will also set the ASP and AS AUTO Activate options causing the ASP and AS to return to an Active state following network failures.

  • Page 39: Asp Up Indication

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.2.11 ASP UP Indication Synopsis Indicates that the peer ASP specified by the association id is UP. Message Format Message Header Field Name Meaning type M3U_MSG_ASP_UP_IND (0x02d5) Association ID M3UA Module...

  • Page 40: Asp Down Indication

    Section 6: Message Reference Description Sent by the M3UA module to indicate the peer ASP has confirmed the local M3UA has change to the UP State. If the status field is non-zero then the ASP UP Request has been rejected by the peer or T(ack) has expired. Parameters Association ID The logical ID of the concerned Association.

  • Page 41: Asp Down Confirmation

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.2.14 ASP DOWN Confirmation Synopsis Peer ASP has confirmed the local M3UA is now DOWN. Message Format Message Header Field Name Meaning type M3U_MSG_ASP_DOWN_CON (0x02d9) Association ID M3UA Module Management Module...

  • Page 42: Asp Act Indication

    Section 6: Message Reference 6.2.15 ASP ACT Indication Synopsis This message indicates a peer has asked for an ASP to become active and that the ASP is now available to send and receive Data for an AS Message Format Message Header Field Name Meaning type...
  • Page 43 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 flags Mnemonic Value Description M3UA_IND_FLAGS_RAS 0x0001 Remote server is RAS when set (or RSG if clear) M3UA_IND_FLAGS_RC_VALID 0x0002 route_ctxt is valid when set net_ctxt Network Context for the LAS-Server Relationship. Identifies the LAS.

  • Page 44: Asp Act Confirmation

    Section 6: Message Reference 6.2.16 ASP ACT Confirmation Synopsis This message indicates the peer has responded to our request for the Application server process to be made active. Message Format Message Header Field Name Meaning type M3U_MSG_ASP_ACT_CON (0x02dc) Association ID M3UA Module Management Module rsp_req...
  • Page 45 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 M3U_TRAFFIC_BROADCAST 0x0004 Broadcast flags Mnemonic Value Description M3UA_IND_FLAGS_RAS 0x0001 Remote server is RAS when set (or RSG if clear) M3UA_IND_FLAGS_RC_VALID 0x0002 route_ctxt is valid when set net_ctxt Network Context for the LAS-Server Relationship. Identifies the LAS.

  • Page 46: Asp Inact Indication

    Section 6: Message Reference 6.2.17 ASP INACT Indication Synopsis This message indicates the peer has asked for an Application Server process to be made inactive. Message Format Message Header Field Name Meaning type M3U_MSG_ASP_INACT_IND (0x02de) Association ID M3UA Module Management Module rsp_req hclass status...

  • Page 47: Asp Inact Confirmation

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 serv_ref Identifier of the remote server in the LAS-Server relationship (or zero). route_ctxt Routing context used for this LAS-Server relationship. 6.2.18 ASP INACT Confirmation Synopsis This message indicates the peer has responded to the request for the Application Server process to be made inactive.

  • Page 48: As Act Indication

    Section 6: Message Reference flags Mnemonic Value Description M3UA_IND_FLAGS_RAS 0x0001 Remote server is RAS when set (or RSG if clear) M3UA_IND_FLAGS_RC_VALID 0x0002 route_ctxt is valid when set net_ctxt Network Context for the LAS-Server Relationship. Identifies the LAS. serv_ref Identifier of the remote server in the LAS-Server relationship (or zero). route_ctxt Routing context used for this LAS-Server relationship.
  • Page 49 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters serv_id The logical ID of the LAS-Server Relationship. status Indicates the current status of the server with respect to the number of ASPs currently active within the server. Value...

  • Page 50: As Inact Indication

    Section 6: Message Reference 6.2.20 AS INACT Indication Synopsis This message indicates an Application server has become inactive. Message Format Message Header Field Name Meaning Type M3U_MSG_AS_INACT_IND (0x02e1) serv_id M3UA Module Management Module rsp_req Hclass Status Non zero on error err_info Parameter Area Offset...

  • Page 51: Association Status Indication

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.2.21 Association Status Indication Synopsis Indicates the status of an Association has changed. Message Format Message Header Field Name Meaning Type M3U_MSG_ASS_STATUS_IND (0x02e2) Association ID M3UA Module Management Module rsp_req...

  • Page 52: Route Status Indication

    Section 6: Message Reference 6.2.22 Route Status Indication Synopsis Indicates the status/congestion level of a Route has changed. Message Format Message Header Field Name Meaning type M3U_MSG_ROUTE_STATUS_IND (0x02e3) Route ID M3UA Module Management Module rsp_req hclass status Route status (see below) err_info Parameter Area Offset...
  • Page 53 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 point_code Destination Point Code of the route. label_fmt Point code format. Mnemonic Value Description M3U_ITU_14 ITU-14 M3U_ANSI_24 ANSI M3U_ITU_24 ITU-24 M3U_ITU_16 Japan cong_level This field is set to the current congestion level in the range 0 to 3, where 0 means no congestion and 3 means maximum congestion.

  • Page 54: Routing Key Registration Indication

    Section 6: Message Reference 6.2.23 Routing Key Registration Indication Synopsis This message indicates an attempt to register a routing key has been made to a peer and the resultant routing context is indicated (if successful) Message Format Message Header Field Name Meaning type M3U_MSG_RK_REG_IND (0x02b0)

  • Page 55: Rk Deregistration Indication

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.2.24 RK Deregistration Indication Synopsis This message indicates an attempt to deregister a routing key has been made to a peer for the routing context as indicated. Message Format Message Header...
  • Page 56 Section 6: Message Reference serv_id The logical ID of the LAS-Server Relationship that the Routing Key belongs to net_ctxt Network Context for the LAS-Server Relationship. Identifies the LAS. route_ctxt The Routing Context being deregistered...

  • Page 57: Non-Primitive Interface

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Non-primitive Interface In addition to protocol primitives defined for the M3UA to User Part interface and the M3UA to Layer Management interface, the M3UA module supports a non-primitive interface for configuration and management.

  • Page 58: Configure M3Ua Module

    Section 6: Message Reference 6.3.1 Configure M3UA Module Synopsis Sent to the M3UA module to configure global parameters. Message Format Message Header Field Name Meaning type M3U_MSG_CONFIG (0x72c0) Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error err_info Parameter Area...
  • Page 59 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Maximum number of Servers the module will be required to handle. max_routes Maximum number of Routes the module will be required to handle. max_throughput Maximum throughput required. Set to zero to allocate the full licensed amount.

  • Page 60: Configure M3Ua Association

    Section 6: Message Reference 6.3.2 Configure M3UA Association Synopsis Sent to the M3UA module to configure an Association. Message Format Message Header Field Name Meaning type M3U_MSG_CNF_ASSOC (0x72c1) Association ID Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error...
  • Page 61 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters options Options for the association. Mnemonic Value Description M3UOP_ASSOC_SGP_TO_ASP 0x0001 Association is on a SGP connect to an ASP M3UOP_ASSOC_ASP_TO_SGP 0x0002 Association is on an ASP connected to an SGP...

  • Page 62: Configure Las-Server Relationship

    Section 6: Message Reference 6.3.3 Configure LAS-Server Relationship Synopsis Sent to the M3UA module to configure a new relationship between a Local AS and a remote server entity Message Format Message Header Field Name Meaning type M3U_MSG_CNF_SERVER (0x72c2) serv_id Management Entity M3UA Module rsp_req Used to request a confirmation...
  • Page 63 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters options Options for the server. Mnemonic Value Description M3UOP_SERVER_PEER_AS 0x0001 The peer is an Application Server (default is Signaling Gateway) M3UOP_SERVER_HOST_AS 0x0002 The local host is an Application Server...
  • Page 64 Section 6: Message Reference num_asp Number of ASPs the AS must be simultaneously registered as Active on for normal operation. If the number of ASPs falls below this number M3UA will Notify other ASPs with the expectation an INACTIVE ASP may then choose to become ACTIVE.

  • Page 65: Configure M3Ua Route

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.4 Configure M3UA Route Synopsis Sent to the M3UA module to configure a Destination Point Code that messages will be routed to. Message Format Message Header Field Name Meaning type...

  • Page 66: Configure Network Context

    Section 6: Message Reference Destination point code associated with the route. net_ctxt Network Context for the DPC. Identifies the LAS and its routing table. 6.3.5 Configure Network Context Synopsis Declares a new Network Context with Point Code format and Options. A NC is required for each Local AS.
  • Page 67 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 M3U_ITU_14 0x0000 ITU-14 M3U_ANSI_24 0x0001 ANSI M3U_ITU_24 0x0002 ITU-24 M3U_ITU_16 0x0003 Japan Options Mnemonic Value Description M3U_NC_OPT_SLS_ROTATION 0x0001 Enable SLS bit rotation M3U_NC_OPT_SLS_ROT8 0x0002 Enable 8-bit rotation (ANSI only) when...

  • Page 68: Configure Routing Key

    Section 6: Message Reference 6.3.6 Configure Routing Key Synopsis Sent to M3UA to configure a new routing key (RK) for use with the LAS- Server relationship (serv_id) specified Message Format Message Header Field Name Meaning type M3U_MSG_CNF_RK (0x72fe) serv_id Management Entity M3UA Module rsp_req Used to request a confirmation...
  • Page 69 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters options Options bits defining parameters supplied in the message: Option Description M3UOP_RK_OPC_PRES (0x0001) The optional OPC parameter is present M3UOP_RK_CICS_PRES (0x0002) The optional CICs range is present (The OPC option must also be set for this option) M3UOP_RK_SI_PRES (0x0004) The Service Indicator parameter is present.

  • Page 70: Add Server To An Association

    Section 6: Message Reference 6.3.7 Add Server to an Association Synopsis Associates a LAS-Server relationship with an Association. Message Format Message Header Field Name Meaning type M3U_MSG_ADD_SERV_ASSOC (0x72c5) Association ID Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error...
  • Page 71 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 options Mnemonic Value Description M3UOP_SERV_ASSOC_NO_RC 0x0001 No Routing Context is configured for use for this AS on this Association. M3UOP_SERV_ASSOC_FORCE_NO_RC 0x0002 No Routing Context is configured for this AS on this Association and any Routing Context included in the ASP_ACT_REQ should be ignored.

  • Page 72: Add Route To A Server

    Section 6: Message Reference 6.3.8 Add Route to a Server. Synopsis Identify an SG that a previously configured Route may use to forward messages. Message Format Message Header Field Name Meaning type M3U_MSG_ADD_ROUTE_SERV (0x72c6) serv_id Management Entity M3UA Module rsp_req Used to request a confirmation hclass status...

  • Page 73: Map Network Context To Network Appearance

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.9 Map Network Context to Network Appearance Synopsis Create a mapping between Network Context and M3UA Network Appearance. Message Format Message Header Field Name Meaning type M3U_MSG_MAP_NA (0x72c7) Association ID...

  • Page 74: M3Ua Timer Configuration Message

    Section 6: Message Reference 6.3.10 M3UA Timer Configuration Message Synopsis This message is used to configure the M3UA timer values to values other than their default values. The new timer values take effect when the timer is next started. Message Format Message Header Field Name Meaning...

  • Page 75: Remove M3Ua Association

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Daud_cong The Daud_cong timer is used in the same way as the Daud timer above, except it has a shorter duration and is used when a destination is congested (i.e. following the reception of SCON).

  • Page 76: Remove Las-Server Relationship

    Section 6: Message Reference 6.3.12 Remove LAS-Server Relationship Synopsis Sent to the M3UA module to remove the configuration of a LAS-Server relationship. Message Format Message Header Field Name Meaning type M3U_MSG_REM_SERVER (0x72c9) serv_id Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error...

  • Page 77: Remove Network Context

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.14 Remove Network Context Synopsis Sent to the M3UA module to request the removal of a Network Context and its associated Point Code format. Message Format Message Header Field Name...

  • Page 78: Remove Server From An Association

    Section 6: Message Reference 6.3.16 Remove Server from an Association Synopsis Request to remove a Server from an Association. Message Format Message Header Field Name Meaning type M3U_MSG_REM_SERV_ASSOC (0x72cb) Association ID Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Non zero on error...

  • Page 79: Remove Route From A Server

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.17 Remove Route from a Server Synopsis Sent to the M3UA module to remove an SG from a Route. Message Format Message Header Field Name Meaning type M3U_MSG_REM_ROUTE_SERV (0x72cc) serv_id...

  • Page 80: Remove Network Context To Network Appearance Mapping

    Section 6: Message Reference 6.3.18 Remove Network Context to Network Appearance Mapping Synopsis Used to remove the mapping between a Network Context and Network Appearance used on a particular link. Message Format Message Header Field Name Meaning type M3U_MSG_UNMAP_NA (0x72cd) Association ID Management Entity M3UA Module...

  • Page 81: Read Global Traffic Statistics

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.19 Read Global Traffic Statistics Synopsis Retrieve global high level traffic measurements for the M3UA module. Message Format Message Header Field Name Meaning type M3U_MSG_R_GL_STATS (0x62b2) Sending module_id M3UA Module...

  • Page 82: Read Association Traffic Statistics

    Section 6: Message Reference 6.3.20 Read Association Traffic Statistics Synopsis Retrieve per-association high level M3UA traffic measurements. Message Format Message Header Field Name Meaning type M3U_MSG_R_LK_STATS (0x62b3) Association ID Sending module_id M3UA Module rsp_req Used to request a confirmation status Set to 0 to read stats Set to 1 to read and reset stats Parameter Area...

  • Page 83: Read Global Peak Usage Statistics

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 oos_count Number of times this association has gone out of service (no ASP Active). oos_duration Total time period (in 100ms intervals) this association has been out of service. 6.3.21 Read Global Peak Usage Statistics Synopsis Retrieve global peak usage measurements for the M3UA module.
  • Page 84 Section 6: Message Reference rxoct_5min, rxoct_1hour, rxoct_1day Peak number of data packet octets received in a 10 second period over the previous 5 minutes, 1 hour or 1 day respectively. rxmsu_5min, rxmsu_1hour, rxmsu_1day Peak number of data packets received in a 10 second period over the previous 5 minutes, 1 hour or 1 day respectively.

  • Page 85: Read Association Peak Usage Statistics

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.22 Read Association Peak Usage Statistics Synopsis Retrieve peak usage measurements for the specified association. Message Format Message Header Field Name Meaning type M3U_MSG_R_LK_PEAK_USAGE (0x62b5) Association ID Sending module_id M3UA Module...
  • Page 86 Section 6: Message Reference Peak number of data packet octets transmitted in a 10 second period over the previous 5 minutes, 1 hour or 1 day respectively. txmsu_5min, txmsu_1hour, txmsu_1day Peak number of data packets transmitted in a 10 second period over the previous 5 minutes, 1 hour or 1 day respectively.

  • Page 87: Read Association Statistics

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.23 Read Association Statistics Synopsis Retrieve the statistics kept on a per association basis. Message Format Message Header Field Name Meaning type M3U_MSG_R_ASSOC_STATS (0x62d0) Association ID Management Entity M3UA Module...
  • Page 88 Section 6: Message Reference Parameter Area Offset Size Name asp_dn_rx asp_dn_ack_rx asp_ac_rx asp_ac_ack_rx asp_ia_rx asp_ia_ack_rx error_rx notify_rx duna_rx dava_rx daud_rx scon_rx dupu_rx drst_rx beat_rx beat_act_rx period beat_failure Description Allows the user to retrieve statistics on the traffic carried on a per association basis.
  • Page 89 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 asp_ia_tx Number of ASP INACTIVE messages transmitted through this association. asp_ia_ack_tx Number of ASP INACTIVE ACK messages transmitted through this association. error_tx Number of ERROR messages transmitted through this association.
  • Page 90 Section 6: Message Reference asp_ia_rx Number of ASP INACTIVE messages received through this association. asp_ia_ack_rx Number of ASP INACTIVE ACK messages received through this association. error_rx Number of ERROR messages received through this association. notify_rx Number of NOTIFY messages received through this association. duna_rx Number of DUNA messages received through this association.

  • Page 91: Read Server Statistics

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.24 Read Server Statistics Synopsis Retrieve the statistics kept for a specific Server. Message Format Message Header Field Name Meaning type M3U_MSG_R_SERVER_STATS (0x62d1) serv_id Management Entity M3UA Module rsp_req Used to request a confirmation...

  • Page 92: Read Route Statistics

    Section 6: Message Reference 6.3.25 Read Route Statistics Synopsis Retrieve the statistics kept for a specific Route. Message Format Message Header Field Name Meaning type M3U_MSG_R_ROUTE_STATS (0x62d2) Route ID Management Entity M3UA Module rsp_req Used to request a confirmation hclass status Set to 1 to reset stats err_info...

  • Page 93: Trace Mask Configuration Request

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.26 Trace Mask Configuration Request Synopsis Configure M3UA to trace the specified messages and events. Message Format Message Header Field Name Meaning type M3U_MSG_TRACE_MASK (0x52d3) Management Entity M3UA Module rsp_req...
  • Page 94 Section 6: Message Reference M3U_EVTO_ASS_STATUS_IND Association status indication M3U_EVTO_ROUTE_STATUS_IND Route status indication M3U_EVTO_RSP_STATUS_IND RSP status indication M3U_EVTO_LIC_STATUS_IND License indication M3U_EVTO_SNMP_DSA DSA SNMP indication Reserved Should be set to zero M3U_EVTO_SS7_RX_IND SS7 Data Transfer Indication M3U_EVTO_MTP_PAUSE SS7 Point code unavailable M3U_EVTO_MTP_RESUME SS7 Point code available M3U_EVTO_MTP_STATUS SS7 point code status...
  • Page 95 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 M3U_EVTI_CONG_STATUS SCTP congestion status change M3U_EVTI_DATA_IND SCTP data transfer indication...

  • Page 96: M3Ua Application Server Process Status

    Section 6: Message Reference 6.3.27 M3UA Application Server Process Status Synopsis Returns the current status of the specified ASP / SGP. Message Format Message Header Field Name Meaning type M3U_MSG_R_RSP_STATUS (0x62e8) Association ID User module M3UA Module rsp_req Used to request a confirmation hclass status Status...

  • Page 97: M3Ua Server Status

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.28 M3UA Server Status Synopsis Returns the status of the specified RAS or SG relationship. Includes overall status and status on a specific ASP or SGP. Message Format Message Header...
  • Page 98 Section 6: Message Reference M3U_STATE_RS_AVAILABLE 0x02 The server is currently available M3U_STATE_RS_AVAILABLE_INSUFF_RSP 0x03 The server is available but has an insufficient number of RSPs active. ass_id Association ID status is requested for. ass_status Status of server with respect to a specific association ID. Mnemonic Value Description...

  • Page 99: M3Ua Route Status

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.29 M3UA Route Status Synopsis Returns the current overall status of the specified route. Message Format Message Header Field Name Meaning type M3U_MSG_R_ROUTE_STATUS (0x62ea) Route ID User module M3UA Module...
  • Page 100 Section 6: Message Reference label_fmt Point code Value Description format.Mnemonic M3U_ITU_14 0x0000 ITU-14 M3U_ANSI_24 0x0001 ANSI M3U_ITU_24 0x0002 ITU-24 M3U_ITU_16 0x0003 Japan cong_level This field is set to the current congestion level in the range 0 to 3, where 0 means no congestion and 3 means maximum congestion.

  • Page 101: Read Las-Server Association List

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 6.3.30 Read LAS-Server Association List Synopsis Retrieve the list of Associations configured for a specific LAS-Server relationship. Message Format Message Header Field Name Meaning type M3U_MSG_R_SERV_ASSOC_LIST (0x62b6) serv_id Management Entity...

  • Page 102: M3Ua Error Indication

    Section 6: Message Reference 6.3.31 M3UA Error Indication Synopsis Message used by M3UA to indicate a software error or protocol event to management. Message Format Message Header Field Name Meaning type M3U_MSG_M3U_ERROR (0x02ef) error_id M3UA Module Management Module rsp_req hclass status error_type err_info...
  • Page 103 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 error_type Error type defined as: Error type Value Description M3Ue_BAD_STATE A message has been received by an RSP/server that is invalid for its current state M3Ue_CONFIG The action cannot be performed with the current configuration.
  • Page 104 Section 6: Message Reference Error Error Id Instance err_val1 err_val2 Description type Association ID Association ASP ACTIVE ACK (0x1e) state or ASP INACTIVE ACK received from peer in invalid state Server state = Server state = 0 Server in SPMC is (0x21) (unconfigured) unconfigured...
  • Page 105 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Error Error Id Instance err_val1 err_val2 Description type Association ID REG_RSP Error returned in (0xd) status value response to RK Register request Association ID Routing context Message received (0xe) with invalid routing...

  • Page 106: M3Ua Event Indication

    Section 6: Message Reference 6.3.32 M3UA Event Indication Synopsis Signals an internal event warning to management. Message Format Message Header Field Name Meaning type M3U_MSG_M3U_EVENT (0x02ee) event_id M3UA Module Management Module rsp_req hclass status event_type err_info Parameter Area Offset Size Name instance err_val1...
  • Page 107 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 evt_val1 Event value depending on event_id. evt_val2 Event value depending on event_id. Event Event Id Instance evt_val1 evt_val2 Description type Assoc ID 2 (0x2) TLV type TLV length Invalid TLV for ASPSM...
  • Page 108 Section 6: Message Reference Event Event Id Instance evt_val1 evt_val2 Description type Assoc ID TLV type TLV length Invalid TLV in M3UA (0x1d) data Assoc ID TLV type TLV length Missing TLV in M3UA (0x1e) data Assoc ID TLV type TLV length Invalid Traffic Mode TLV (0x1f)
  • Page 109 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Event Event Id Instance evt_val1 evt_val2 Description type Assoc ID TLV type TLV length Duplicate NA TLV in (0x3c) SSNM congestion Assoc ID TLV type TLV length Duplicate affected point...
  • Page 110 Section 6: Message Reference Event Event Id Instance evt_val1 evt_val2 Description type Assoc ID ASPTM active received (0x58) whilst ASP down Assoc ID ASPTM received in (0x59) incorrect ASP state Assoc ID M3UA data message (0x5a) received in invalid state Assoc ID No default NA for SSNM (0x5b)

  • Page 111: M3Ua Notify Indication

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Event Event Id Instance evt_val1 evt_val2 Description type Assoc ID TLV type TLV length Missing routing context (0x71) TLV in DEREG_RSP Assoc ID M3UA MGMT MGMT Error message Error code...
  • Page 112 Section 6: Message Reference Message Header Management Module rsp_req hclass status err_info Parameter Area Offset Size Name options status_type status_info asp_id num_rc Routing contexts Description The management module on an ASP host should decode the notify messages to track the current state of the peer server and react to state changes as required.

  • Page 113: M3Ua Audit Destination Indication

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Other Value Description Insufficient ASP Resources Active in AS Alternate ASP Active num_rc Number of routing contexts affected. Asp_id Optional identifier of the ASP causing the notify to be issued.

  • Page 114: Mtp Update Level 4 Request

    Section 6: Message Reference The Network Context of the Point Codes to audit. num_pc Number of Point Codes to audit. Array of point codes requiring an audit. serv_id Logical id of the remote server requesting audit 6.3.35 MTP Update Level 4 Request Synopsis: Message sent to M3UA to request a broadcast of current route status to all (local) user parts for a specified destination.

  • Page 115: Example Message Sequence

    ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Example Message Sequence User Application Management M3UA M3UA Management User Application M3U_CONFIG CNF_ASSOC CNF_SERVER ADD_SERV_ASSOC ACT_ASSOC M3U_CONFIG CNF_ASSOC CNF_SERVER ADD_SERV_ASSOC ACT_ASSOC SCTP association initiated from ASS_STATUS_IND ASS_STATUS_IND ASP to SGW...

  • Page 116: Appendix A. Message Types

    Appendix A: Message Types Appendix A. Message Types Message Type Table The following table lists, by message type, the messages described in this manual. Message Mnemonic Description Type 0x02b0 M3U_MSG_RK_REG_IND Routing Key registration indication 0x02b1 M3U_MSG_RK_DEREG_IND Routing Key deregistration indication 0x02d5 M3U_MSG_ASP_UP_IND ASPUP indication...
  • Page 117 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Message Mnemonic Description Type 0x72c4 M3U_MSG_CNF_NC Configure a Network Context 0x72c5 M3U_MSG_ADD_SERV_ASSOC Add a server to the list of those available via the server process 0x72c6 M3U_MSG_ADD_ROUTE_SERV Add a route to the list of those available via the server...

  • Page 118: Appendix B. Additional Services

    Appendix B: Additional Services Appendix B. Additional Services This appendix contains information about Licensing Services. Licensing B.1.1 Request Licensing State Synopsis: Sent by Layer Management to request the current license state. Message Format: Message Header Field Name Meaning type MGT_MSG_R_LIC_STATUS (0x6f22) Layer Management M3UA Module rsp_req...
  • Page 119 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Parameters The version parameters and licensed protocol parameters should be set by the user. The rest of the parameters are set by the module in the reply. Version Set to 0.

  • Page 120: License Event Indication

    Appendix B: Additional Services B.1.2 License Event Indication Synopsis: Sent from M3UA to Layer Management to indicate a license related event. In the case of throughput, it indicates throughput congestion onset, abatement, or the beginning of enforcement. Message Format: Message Header Field Name Meaning type...
  • Page 121 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 CONGESTION ENFORCEMENT Throughput Alarm Event indication Value Type Alarm Inactive Alarm Active...

  • Page 122: Request Throughput Statistics

    Appendix B: Additional Services B.1.3 Request Throughput Statistics Synopsis: Sent by Layer Management to request the current throughput statistics. Message Format: Message Header Field Name Meaning type MGT_MSG_R_THR_STATS (0x6f21) Layer Management M3UA Module rsp_req Set appropriate response required bit hclass status Non zero to reset err_info...
  • Page 123 ® Dialogic DSI Protocol Stacks M3UA Programmer's Manual Issue 11 Amount of counted data - measured in Kbytes - received by the module from the network since the last statistics reset. TX Data Amount of counted data - measured in Kbytes - sent by the User module since the last statistics reset.

  • Page 124: Throughput Alarm Set

    Appendix B: Additional Services B.1.4 Throughput Alarm Set Synopsis: Sent by Layer Management to set the throughput alarm thresholds. Message Format: Message Header Field Name Meaning type MGT_MSG_SET_THR_ALARM (0x5f27) Layer Management M3UA Module rsp_req Set appropriate response required bit hclass status Non zero to reset err_info...

Table of Contents