mi_xmlrpc_ng Module

Ovidiu Sas

   <osas@voipembedded.com>

Edited by

Ovidiu Sas

   Copyright © 2013 VoIP Embedded, Inc.
   Revision History
   Revision $Rev$ $Date$
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. External Libraries or Applications
              1.2.2. OpenSIPS Modules

        1.3. Exported Parameters

              1.3.1. http_root(string)
              1.3.2. format_version(integer)
              1.3.3. trace_destination (string)
              1.3.4. trace_bwlist (string)

        1.4. Exported Functions
        1.5. Known issues
        1.6. Example

   List of Examples

   1.1. Set http_root parameter
   1.2. Set format_version parameter
   1.3. Set trace_destination parameter
   1.4. Set trace_destination parameter
   1.5. XMLRPC request

Chapter 1. Admin Guide

1.1. Overview

   This module implements a xmlrpc server that handles xmlrpc
   requests and generates xmlrpc responses. When a xmlrpc message
   is received a default method is executed.

   At first, it looks up the MI command. If found it parses the
   called procedure's parameters into a MI tree and the command is
   executed. A MI reply tree is returned that is formatted back in
   xmlrpc. The response is built in two ways - like a string that
   contains the MI tree nodes information (name, values and
   attributes) or like an array whose elements are consisted of
   each MI tree node stored information.

1.2. Dependencies

1.2.1. External Libraries or Applications

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

1.2.2. OpenSIPS Modules

   The following modules must be loaded before this module:
     * httpd module.

1.3. Exported Parameters

1.3.1. http_root(string)

   Specifies the root path for xmlrpc requests:
   http://[opensips_IP]:[opensips_httpd_port]/[http_root]

   The default value is "RPC2".

   Example 1.1. Set http_root parameter
...
modparam("mi_xmlrpc_ng", "http_root", "opensips_mi_xmlrpc")
...

1.3.2. format_version(integer)

   Specifies which formatting to be used for the output generated
   by the module. The value of 2 will generate a response broken
   in many tags which doesn't require string parsing, only xml
   parsing, this is the newer version. The other accepted value is
   1 which will generate a long simple sting response, this is the
   older vesion.

   The default value is 2.

   Example 1.2. Set format_version parameter
...
modparam("mi_xmlrpc_ng", "format_version", 1)
...

1.3.3. 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.3. Set trace_destination parameter
...
modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport
=tcp;version=3")

modparam("mi_xmlrpc_ng", "trace_destination", "hep_dest")
...

1.3.4. 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.4. Set trace_destination parameter
...
## blacklist ps and which mi commands
## all the other commands shall be traced
modparam("mi_xmlrpc_ng", "trace_bwlist", "b: ps, which")
...
## allow only sip_trace mi command
## all the other commands will not be traced
modparam("mi_xmlrpc_ng", "trace_bwlist", "w: sip_trace")
...

1.4. Exported Functions

   No function exported to be used from configuration file.

1.5. Known issues

   Commands with large responses (like ul_dump) will fail if the
   configured size of the httpd buffer is to small (or if there
   isn't enough pkg memory configured).

   Future realeases of the httpd and mi_xmlrpc_ng modules will
   address this issue.

1.6. Example

   This is an example showing the xmlrpc format for the
   “get_statistics net: uri:” MI commad: response.

   Example 1.5. XMLRPC request

POST /xmlrpc HTTP/1.0
Host: my.host.com
User-Agent: My xmlrpc UA
Content-Type: text/xml
Content-Length: 216

<?xml version='1.0'?>
<methodCall>
        <methodName>get_statistics</methodName>
        <params>
                <param>
                        <value><string>net:</string></value>
                </param>
                <param>
                        <value><string>uri:</string></value>
                </param>
        </params>
</methodCall>


HTTP/1.0 200 OK
Content-Length: 236
Content-Type: text/xml; charset=utf-8
Date: Mon, 8 Mar 2013 12:00:00 GMT

<?xml version="1.0" encoding="UTF-8"?><methodResponse><params><param><va
lue><string>
:: net:waiting_udp = 0
:: net:waiting_tcp = 0
:: uri:positive checks = 0
:: uri:negative_checks = 0
</string></value></param></params></methodResponse>
