/
mi_xmlrpc_ng_admin.xml
143 lines (129 loc) · 3.35 KB
/
mi_xmlrpc_ng_admin.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section>
<title>Overview</title>
<para>
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.
</para>
<para>
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.
</para>
</section>
<section>
<title>Dependencies</title>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before
running &osips; with this module loaded:
<itemizedlist>
<listitem>
<para><emphasis>libxml2</emphasis></para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>&osips; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para><emphasis>httpd</emphasis> module.</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Exported Parameters</title>
<section>
<title><varname>mi_xmlrpc_ng_root</varname>(string)</title>
<para>
Specifies the root path for xmlrpc requests:
http://[opensips_IP]:[opensips_httpd_port]/[mi_xmlrpc_ng_root]
</para>
<para>
<emphasis>The default value is "RPC2".</emphasis>
</para>
<example>
<title>Set <varname>mi_xmlrpc_ng_root</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_root", "opensips_mi_xmlrpc")
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Exported Functions</title>
<para>
No function exported to be used from configuration file.
</para>
</section>
<section>
<title>Known issues</title>
<para>
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).
</para>
<para>
Future realeases of the httpd and mi_xmlrpc_ng modules
will address this issue.
</para>
</section>
<section>
<title>Example</title>
<para>
This is an example showing the xmlrpc format for the
<quote>get_statistics net: uri:</quote> MI commad:
response.
</para>
<example>
<title>XMLRPC request</title>
<programlisting format="linespecific">
<![CDATA[
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><value><string>
:: net:waiting_udp = 0
:: net:waiting_tcp = 0
:: uri:positive checks = 0
:: uri:negative_checks = 0
</string></value></param></params></methodResponse>
]]>
</programlisting>
</example>
</section>
</chapter>