MI_DATAGRAM module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This is a module which provides a UNIX/UDP SOCKET transport layer implementation for the Management Interface.
DATAGRAM command syntax
Section titled “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}
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- No dependencies on other OpenSIPS modules.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- none
Exported Parameters
Section titled “Exported Parameters”socket_name (string)
Section titled “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.
...modparam("mi_datagram", "socket_name", "/tmp/opensips.sock")...modparam("mi_datagram", "socket_name", "udp:192.168.2.133:8080")...children_count (string)
Section titled “children_count (string)”The number of child processes to be created. Each child process will be a datagram server.
Default value is 1.
...modparam("mi_datagram", "children_count", 3)...unix_socket_mode (integer)
Section titled “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----).
...modparam("mi_datagram", "unix_socket_mode", 0600)...unix_socket_group (integer) unix_socket_group (string)
Section titled “unix_socket_group (integer) unix_socket_group (string)”Group to be used for creating the listening UNIX socket.
Default value is the inherited one.
...modparam("mi_datagram", "unix_socket_group", 0)modparam("mi_datagram", "unix_socket_group", "root")...unix_socket_user (integer) unix_socket_group (string)
Section titled “unix_socket_user (integer) unix_socket_group (string)”User to be used for creating the listening UNIX socket.
Default value is the inherited one.
...modparam("mi_datagram", "unix_socket_user", 0)modparam("mi_datagram", "unix_socket_user", "root")...socket_timeout (integer)
Section titled “socket_timeout (integer)”The reply will expire after trying to sent it for socket_timeout miliseconds.
Default value is 2000.
...modparam("mi_datagram", "socket_timeout", 2000)...reply_indent (string)
Section titled “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)”.
...modparam("mi_datagram", "reply_indent", " ")...Exported Functions
Section titled “Exported Functions”No function exported to be used from configuration file.
Example
Section titled “Example”This is an example showing the DATAGRAM format for the “get_statistics dialog: tm:” MI commad: response.
:get_statistics:\ndialog:\ntm:\nFrequently Asked Questions
Section titled “Frequently Asked Questions”Q: 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.
Q: Is there a limit in the datagram request’s size?
The maximum length of a datagram request or reply is 65457 bytes.
Q: Where can I find more about OpenSIPS?
Take a look at http://www.opensips.org/.
Q: 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 users@lists.opensips.org and e-mails regarding development versions should be sent to devel@lists.opensips.org.
If you want to keep the mail private, send it to users@lists.opensips.org.
Q: How can I report a bug?
Please follow the guidelines provided at: https://github.com/OpenSIPS/opensips/issues.
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 35 | 26 | 349 | 321 |
| 2. | Ancuta Onofrei | 28 | 2 | 2423 | 252 |
| 3. | Daniel-Constantin Mierla (@miconda) | 9 | 7 | 18 | 16 |
| 4. | Stefan Darius (@dariusstefan) | 8 | 4 | 277 | 29 |
| 5. | Henning Westerholt (@henningw) | 5 | 3 | 10 | 12 |
| 6. | Razvan Crainea (@razvancrainea) | 5 | 3 | 2 | 6 |
| 7. | Klaus Darilion | 3 | 1 | 4 | 4 |
| 8. | Konstantin Bokarius | 3 | 1 | 2 | 6 |
| 9. | Edson Gellert Schubert | 2 | 1 | 0 | 44 |
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Oct 2011 - Jun 2026 |
| 3. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jun 2007 - Dec 2012 |
| 4. | Henning Westerholt (@henningw) | Aug 2007 - Jul 2008 |
| 5. | Klaus Darilion | Jul 2008 - Jul 2008 |
| 6. | Daniel-Constantin Mierla (@miconda) | Mar 2008 - Mar 2008 |
| 7. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 8. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
| 9. | Ancuta Onofrei | Jun 2007 - Sep 2007 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Klaus Darilion, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Ancuta Onofrei.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0