mi_datagram Module

Andreea-Ancuta Onofrei

Edited by

Andreea-Ancuta Onofrei

Revision History
Revision $Revision: 8740 $$Date$

Table of Contents

1. Admin Guide
1.1. Overview
1.2. DATAGRAM command syntax
1.3. Dependencies
1.3.1. OpenSIPS Modules
1.3.2. External Libraries or Applications
1.4. Exported Parameters
1.4.1. socket_name (string)
1.4.2. children_count (string)
1.4.3. unix_socket_mode (integer)
1.4.4. unix_socket_group (integer) unix_socket_group (string)
1.4.5. unix_socket_user (integer) unix_socket_group (string)
1.4.6. socket_timeout (integer)
1.4.7. reply_indent (string)
1.4.8. trace_destination (string)
1.4.9. trace_bwlist (string)
1.5. Exported Functions
1.6. Example
2. Frequently Asked Questions

List of Examples

1.1. Set socket_name parameter
1.2. Set children_count parameter
1.3. Set unix_socket_mode parameter
1.4. Set unix_socket_group parameter
1.5. Set unix_socket_user parameter
1.6. Set socket_timeout parameter
1.7. Set reply_indent parameter
1.8. Set trace_destination parameter
1.9. Set trace_destination parameter
1.10. DATAGRAM request

Chapter 1. Admin Guide

1.1. Overview

This is a module which provides a UNIX/UDP SOCKET transport layer implementation for the Management Interface.

1.2. DATAGRAM command syntax

The external commands issued via DATAGRAM interface must follow the following syntax:

  • request = first_line (argument '\n')*

  • first_line = ':'command_name':''\n'

  • argument = (arg_name '::' (arg_value)? ) | (arg_value)

  • arg_name = not-quoted_string

  • arg_value = not-quoted_string | '"' string '"'

  • not-quoted_string = string - {',",\n,\r}

1.3. Dependencies

1.3.1. OpenSIPS Modules

The following modules must be loaded before this module:

  • No dependencies on other OpenSIPS modules.

1.3.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

  • none

1.4. Exported Parameters

1.4.1. socket_name (string)

The name of a UNIX SOCKET or an IP address. The UNIX datagram or UDP socket will be created using this parameter in order to read the external commands. Both IPv4 and IPv6 are supported.

Default value is NONE.

Example 1.1. Set socket_name parameter

modparam("mi_datagram", "socket_name", "/tmp/opensips.sock")
modparam("mi_datagram", "socket_name", "udp:")

1.4.2. children_count (string)

The number of child processes to be created. Each child process will be a datagram server.

Default value is 1.

Example 1.2. Set children_count parameter

modparam("mi_datagram", "children_count", 3)

1.4.3. unix_socket_mode (integer)

Permission to be used for creating the listening UNIX datagram socket. Not necessary for a UDP socket. It follows the UNIX conventions.

Default value is 0660 (rw-rw----).

Example 1.3. Set unix_socket_mode parameter

modparam("mi_datagram", "unix_socket_mode", 0600)

1.4.4. unix_socket_group (integer) unix_socket_group (string)

Group to be used for creating the listening UNIX socket.

Default value is the inherited one.

Example 1.4. Set unix_socket_group parameter

modparam("mi_datagram", "unix_socket_group", 0)
modparam("mi_datagram", "unix_socket_group", "root")

1.4.5. unix_socket_user (integer) unix_socket_group (string)

User to be used for creating the listening UNIX socket.

Default value is the inherited one.

Example 1.5. Set unix_socket_user parameter

modparam("mi_datagram", "unix_socket_user", 0)
modparam("mi_datagram", "unix_socket_user", "root")

1.4.6. socket_timeout (integer)

The reply will expire after trying to sent it for socket_timeout milliseconds.

Default value is 2000.

Example 1.6. Set socket_timeout parameter

modparam("mi_datagram", "socket_timeout", 2000)

1.4.7. reply_indent (string)

Strings to be used for line indentation. As the MI data structure is tree oriendeted, the depth level will printed as indentation.

Default value is "\t" (TAB).

Example 1.7. Set reply_indent parameter

modparam("mi_datagram", "reply_indent", "    ")

1.4.8. trace_destination (string)

Trace destination as defined in the tracing module. Currently the only tracing module is proto_hep. This is where traced mi messages will go.

WARNING: A tracing module must be loaded in order for this parameter to work. (for example proto_hep).

Default value is none(not defined).

Example 1.8. Set trace_destination parameter

modparam("proto_hep", "trace_destination", "[hep_dest];transport=tcp;version=3")

modparam("mi_datagram", "trace_destination", "hep_dest")

1.4.9. trace_bwlist (string)

Filter traced mi commands based on a blacklist or a whitelist. trace_destination must be defined for this parameter to have any purpose. Whitelists can be defined using 'w' or 'W', blacklists using 'b' or 'B'. The type is separate by the actual blacklist by ':'. The mi commands in the list must be separated by ','.

Defining a blacklists means all the commands that are not blacklisted will be traced. Defining a whitelist means all the commands that are not whitelisted will not be traced. WARNING: One can't define both a whitelist and a blacklist. Only one of them is allowed. Defining the parameter a second time will just overwrite the first one.

WARNING: A tracing module must be loaded in order for this parameter to work. (for example proto_hep).

Default value is none(not defined).

Example 1.9. Set trace_destination parameter

## blacklist ps and which mi commands
## all the other commands shall be traced
modparam("mi_datagram", "trace_bwlist", "b: ps, which")
## allow only sip_trace mi command
## all the other commands will not be traced
modparam("mi_datagram", "trace_bwlist", "w: sip_trace")

1.5. Exported Functions

No function exported to be used from configuration file.

1.6. Example

This is an example showing the DATAGRAM format for the get_statistics dialog: tm: MI commad: response.

Example 1.10. DATAGRAM request


Chapter 2. Frequently Asked Questions


Both UNIX and UDP type of socket can be created simultaneusly?

This version supports only one kind of socket at a time. If there are more than one value set for socket_name the last one will take effect.


Is there a limit in the datagram request's size?

The maximum length of a datagram request or reply is 65457 bytes.


Where can I find more about OpenSIPS?

Take a look at http://www.opensips.org/.


Where can I post a question about this module?

First at all check if your question was already answered on one of our mailing lists:

E-mails regarding any stable OpenSIPS release should be sent to and e-mails regarding development versions should be sent to .

If you want to keep the mail private, send it to .


How can I report a bug?

Please follow the guidelines provided at: https://github.com/OpenSIPS/opensips/issues.