hwelte
/
mbuni
1
0
Fork 0
Code Releases Activity

Documentation updated with admin-port info

Browse Source
master
bagyenda 12 years ago
parent 1e14a17e39
commit 8efe4605bc
3 changed files with 226 additions and 3 deletions
Show Stats Download Patch File Download Diff File

2
mbuni/ChangeLog
Unescape View File

@ -1,3 +1,5 @@
2011-03-28 P. A. Bagyenda <bagyenda@dsmagic.com>
* Updated doc to include mmsbox admin interface info
2011-03-24 P. A. Bagyenda <bagyenda@dsmagic.com>
* Rolled MM1 MM7 module into main MMSBox code
2011-01-28 P. A. Bagyenda <bagyenda@dsmagic.com>

223
mbuni/doc/userguide.shtml
Unescape View File

@ -67,13 +67,15 @@ This document describes the installation and usage of the MMS Gateway.
</UL>
</LI>
<LI><A HREF="#mmsvas_conf">MMS VAS Gateway-specific Configuration</A><UL>
<LI><A HREF="#mmsvas_conf">MMS VAS Gateway-specific Configuration</A>
<UL>
<LI><A HREF="#mmsc_vasp">MMSC Connection Configuration</A></LI>
<LI><A HREF="#sendmms">SendMMS User Configuration</A></LI>
<LI><A HREF="#mms_service">MMS Service Configuration</A></LI>
</UL>
</LI>
<LI><A HREF="#mmsbox_admin">Using the VAS Gateway Administration Interface</a></LI>
<LI><A HREF="#builtin">Built-in Billing, Resolver and Detokenizer Modules</a></LI>
</UL></LI>
<LI><A HREF="#Section_.1.4">Chapter 4: Gateway Architecture</A><UL>
<LI><A HREF="#mmsc_arch">MMSC Architecture</A><UL>
@ -1921,8 +1923,225 @@ Boolean
&nbsp; &nbsp;</td>
</tr>
<tr >
<td valign=top >
<tt>mmsbox-admin-port</tt>
&nbsp; &nbsp;</td>
<td valign=top >
Integer
&nbsp; &nbsp;</td>
<td valign=top >
<i>VAS GW</i>
&nbsp; &nbsp;
</td>
<td valign=top >
Optional port where <tt>mmsbox</tt> listens for administrative
commands (see <a href="#mmsbox_admin">below</a>).
&nbsp; &nbsp;</td>
</tr>
<tr >
<td valign=top >
<tt>admin-port-ssl</tt>
&nbsp; &nbsp;</td>
<td valign=top >
Boolean
&nbsp; &nbsp;</td>
<td valign=top >
<i>VAS GW</i>
&nbsp; &nbsp;
</td>
<td valign=top >
Whether admin port (above) is SSLed.
&nbsp; &nbsp;</td>
</tr>
<tr >
<td valign=top >
<tt>admin-allow-ip</tt>
&nbsp; &nbsp;</td>
<td valign=top >
string
&nbsp; &nbsp;</td>
<td valign=top >
<i>VAS GW</i>
&nbsp; &nbsp;
</td>
<td valign=top >
If set, admin requests will only be allowed if originated by one of
the IP addresses listed here (semi-colon separated list).
&nbsp; &nbsp;</td>
</tr>
<tr >
<td valign=top >
<tt>admin-deny-ip</tt>
&nbsp; &nbsp;</td>
<td valign=top >
string
&nbsp; &nbsp;</td>
<td valign=top >
<i>VAS GW</i>
&nbsp; &nbsp;
</td>
<td valign=top >
If set, admin requests will <b>not</b> be allowed if originated by one of
the IP addresses listed here (semi-colon separated list).
&nbsp; &nbsp;</td>
</tr>
<tr >
<td valign=top >
<tt>admin-password</tt>
&nbsp; &nbsp;</td>
<td valign=top >
string
&nbsp; &nbsp;</td>
<td valign=top >
<i>VAS GW</i>
&nbsp; &nbsp;
</td>
<td valign=top >
Authentication password for admin port
&nbsp; &nbsp;</td>
</tr>
</table>
<br>
<a name="mmsbox_admin"></a><h4>Using the VAS Gateway Administration
Interface</h4>
Mbuni VAS Gateway provides an administration interface (HTTP-based)
to view the status of MMSC connections, start or stop all or a
specific MMSC connection. (This is especially useful if the
configurations are being loaded dynamically using a configurations module.) To use the interface, you load a
URL of the form:
<p>
<tt>http://<i>server_ip</i>:<i>server_admin_port</i>/<i>command_uri</i>?password=<i>admin_password</i>?mmsc-id=<i>mmsc</i></tt>
</p>
If <tt>admin-port-ssl</tt> was set to <tt>yes</tt> then you must
use <tt>https://</tt>. The <tt>server_admin_port</tt> and <tt>admin_password</tt> should be given
as specified in the configuration file. Supported <tt>command_uri</tt>
values are:
<dl>
<dt>stop</dt> <dd>To stop a specific MMSC link, specified using
the <tt>mmsc-id</tt> CGI parameter.This means no MT MMS will be
routed out via this connection until it is started again. The provided ID must match
the ID of one of the <tt>mmsc</tt> groups defined in the
configuration file. If <tt>mmsc-id</tt> is not provided, all
defined MMSC connections are stopped. </dd>
<dt>start</dt> <dd>To start a specific MMSC link, specified using
the <tt>mmsc-id</tt> CGI parameter. The provided ID must match
the ID of one of the <tt>mmsc</tt> groups defined in the
configuration file. If <tt>mmsc-id</tt> is not provided, all
defined MMSC connections are started. </dd>
<dt>status</dt> <dd>To retrieve the status of a specific MMSC link, specified using
the <tt>mmsc-id</tt> CGI parameter. The provided ID must match
the ID of one of the <tt>mmsc</tt> groups defined in the
configuration file. If <tt>mmsc-id</tt> is not provided, all
defined MMSC connections' status is reported. </dd>
</dl>
The response in each case is XML-formatted. For the <tt>status</tt>
command, the result is the following form:
<pre>
&lt;mmsbox&gt;
&lt;mmsc id=&quot;eaif&quot; type=&quot;EAIF&quot;&gt;
&lt;port&gt;8190&lt;/port&gt;
&lt;group&gt;eaif&lt;/group&gt;
&lt;throughput&gt;0.0000&lt;/throughput&gt;
&lt;re-route&gt;false&lt;/re-route&gt;
&lt;reroute-mmsc&gt;N/A&lt;/reroute-mmsc&gt;
&lt;stats&gt;
&lt;uptime&gt;23 secs&lt;/uptime&gt;
&lt;last-pdu&gt;n/a&lt;/last-pdu&gt;
&lt;mt&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mt&gt;
&lt;mo&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mo&gt;
&lt;/stats&gt;
&lt;/mmsc&gt;
&lt;mmsc id=&quot;mail&quot; type=&quot;MM4&quot;&gt;
&lt;port&gt;n/a&lt;/port&gt;
&lt;group&gt;mail&lt;/group&gt;
&lt;throughput&gt;0.0000&lt;/throughput&gt;
&lt;re-route&gt;false&lt;/re-route&gt;
&lt;reroute-mmsc&gt;N/A&lt;/reroute-mmsc&gt;
&lt;stats&gt;
&lt;uptime&gt;23 secs&lt;/uptime&gt;
&lt;last-pdu&gt;n/a&lt;/last-pdu&gt;
&lt;mt&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mt&gt;
&lt;mo&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mo&gt;
&lt;/stats&gt;
&lt;/mmsc&gt;
&lt;mmsc id=&quot;http&quot; type=&quot;HTTP&quot;&gt;
&lt;port&gt;9001&lt;/port&gt;
&lt;group&gt;http&lt;/group&gt;
&lt;throughput&gt;0.0000&lt;/throughput&gt;
&lt;re-route&gt;true&lt;/re-route&gt;
&lt;reroute-mmsc&gt;local&lt;/reroute-mmsc&gt;
&lt;stats&gt;
&lt;uptime&gt;23 secs&lt;/uptime&gt;
&lt;last-pdu&gt;n/a&lt;/last-pdu&gt;
&lt;mt&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mt&gt;
&lt;mo&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mo&gt;
&lt;/stats&gt;
&lt;/mmsc&gt;
&lt;mmsc id=&quot;local&quot; type=&quot;SOAP&quot;&gt;
&lt;port&gt;12345&lt;/port&gt;
&lt;group&gt;local&lt;/group&gt;
&lt;throughput&gt;0.0000&lt;/throughput&gt;
&lt;re-route&gt;false&lt;/re-route&gt;
&lt;reroute-mmsc&gt;N/A&lt;/reroute-mmsc&gt;
&lt;stats&gt;
&lt;uptime&gt;23 secs&lt;/uptime&gt;
&lt;last-pdu&gt;n/a&lt;/last-pdu&gt;
&lt;mt&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mt&gt;
&lt;mo&gt;&lt;pdus&gt;0&lt;/pdus&gt;&lt;errors&gt;0&lt;/errors&gt;&lt;/mo&gt;
&lt;/stats&gt;
&lt;/mmsc&gt;
&lt;/mmsbox&gt;
</pre>
The information includes basic MMSC configuration data, connection
uptime, time of last received PDU, received and sent PDUs, errors.
For the <tt>start</tt>
command, the response is the same as that for <tt>status</tt> if the
command succeeds, otherwise the result is of the form:
<pre>
&lt;Start-Mmsc&gt;&lt;Error&gt;<i>error message</i>&lt;/Error&gt;&lt;/Start-Mmsc&gt;
</pre>
For the <tt>stop</tt> command the result is of the form:
<pre>
&lt;Stop-Mmsc&gt;&lt;Success/&gt;&lt;/Stop-Mmsc&gt;
</pre>
or
<pre>
&lt;Stop-Mmsc&gt;&lt;Failed/&gt;&lt;/Stop-Mmsc&gt;
</pre>
depending on whether the command succeeded or failed.
<a name="builtin"></a><h4>Built-in billing, resolver and detokenizer
modules</h4>
Mbuni supports one type of built-in modules: Shell script

4
mbuni/mmsbox/mmsbox_cfg.c
Unescape View File

@ -1108,7 +1108,9 @@ static void append_mmsc_status(Octstr *rbody, MmscGrp *m, List *warnings)
typ = "MM1";
else if (m->type == CUSTOM_MMSC)
typ = "CUSTOM";
else
else if (m->type == HTTP_MMSC)
typ = "HTTP";
else
typ = "none";
if (m->last_pdu > 0) {

Write Preview
Loading…
Cancel
Save