Documentation updated with admin-port info
This commit is contained in:
parent
1e14a17e39
commit
8efe4605bc
|
@ -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>
|
||||
|
|
|
@ -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
|
|||
</td>
|
||||
</tr>
|
||||
|
||||
<tr >
|
||||
<td valign=top >
|
||||
<tt>mmsbox-admin-port</tt>
|
||||
</td>
|
||||
<td valign=top >
|
||||
Integer
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
<i>VAS GW</i>
|
||||
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
Optional port where <tt>mmsbox</tt> listens for administrative
|
||||
commands (see <a href="#mmsbox_admin">below</a>).
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr >
|
||||
<td valign=top >
|
||||
<tt>admin-port-ssl</tt>
|
||||
</td>
|
||||
<td valign=top >
|
||||
Boolean
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
<i>VAS GW</i>
|
||||
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
Whether admin port (above) is SSLed.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr >
|
||||
<td valign=top >
|
||||
<tt>admin-allow-ip</tt>
|
||||
</td>
|
||||
<td valign=top >
|
||||
string
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
<i>VAS GW</i>
|
||||
|
||||
</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).
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr >
|
||||
<td valign=top >
|
||||
<tt>admin-deny-ip</tt>
|
||||
</td>
|
||||
<td valign=top >
|
||||
string
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
<i>VAS GW</i>
|
||||
|
||||
</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).
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr >
|
||||
<td valign=top >
|
||||
<tt>admin-password</tt>
|
||||
</td>
|
||||
<td valign=top >
|
||||
string
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
<i>VAS GW</i>
|
||||
|
||||
</td>
|
||||
|
||||
<td valign=top >
|
||||
Authentication password for admin port
|
||||
</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>
|
||||
|
||||
<mmsbox>
|
||||
<mmsc id="eaif" type="EAIF">
|
||||
<port>8190</port>
|
||||
<group>eaif</group>
|
||||
<throughput>0.0000</throughput>
|
||||
<re-route>false</re-route>
|
||||
<reroute-mmsc>N/A</reroute-mmsc>
|
||||
<stats>
|
||||
<uptime>23 secs</uptime>
|
||||
<last-pdu>n/a</last-pdu>
|
||||
<mt><pdus>0</pdus><errors>0</errors></mt>
|
||||
<mo><pdus>0</pdus><errors>0</errors></mo>
|
||||
</stats>
|
||||
</mmsc>
|
||||
<mmsc id="mail" type="MM4">
|
||||
<port>n/a</port>
|
||||
<group>mail</group>
|
||||
<throughput>0.0000</throughput>
|
||||
<re-route>false</re-route>
|
||||
<reroute-mmsc>N/A</reroute-mmsc>
|
||||
<stats>
|
||||
<uptime>23 secs</uptime>
|
||||
<last-pdu>n/a</last-pdu>
|
||||
<mt><pdus>0</pdus><errors>0</errors></mt>
|
||||
<mo><pdus>0</pdus><errors>0</errors></mo>
|
||||
</stats>
|
||||
</mmsc>
|
||||
<mmsc id="http" type="HTTP">
|
||||
<port>9001</port>
|
||||
<group>http</group>
|
||||
<throughput>0.0000</throughput>
|
||||
<re-route>true</re-route>
|
||||
<reroute-mmsc>local</reroute-mmsc>
|
||||
<stats>
|
||||
<uptime>23 secs</uptime>
|
||||
<last-pdu>n/a</last-pdu>
|
||||
<mt><pdus>0</pdus><errors>0</errors></mt>
|
||||
<mo><pdus>0</pdus><errors>0</errors></mo>
|
||||
</stats>
|
||||
</mmsc>
|
||||
<mmsc id="local" type="SOAP">
|
||||
<port>12345</port>
|
||||
<group>local</group>
|
||||
<throughput>0.0000</throughput>
|
||||
<re-route>false</re-route>
|
||||
<reroute-mmsc>N/A</reroute-mmsc>
|
||||
<stats>
|
||||
<uptime>23 secs</uptime>
|
||||
<last-pdu>n/a</last-pdu>
|
||||
<mt><pdus>0</pdus><errors>0</errors></mt>
|
||||
<mo><pdus>0</pdus><errors>0</errors></mo>
|
||||
</stats>
|
||||
</mmsc>
|
||||
</mmsbox>
|
||||
</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>
|
||||
<Start-Mmsc><Error><i>error message</i></Error></Start-Mmsc>
|
||||
</pre>
|
||||
|
||||
For the <tt>stop</tt> command the result is of the form:
|
||||
<pre>
|
||||
<Stop-Mmsc><Success/></Stop-Mmsc>
|
||||
</pre>
|
||||
|
||||
or
|
||||
<pre>
|
||||
<Stop-Mmsc><Failed/></Stop-Mmsc>
|
||||
</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
|
||||
|
|
|
@ -1108,6 +1108,8 @@ static void append_mmsc_status(Octstr *rbody, MmscGrp *m, List *warnings)
|
|||
typ = "MM1";
|
||||
else if (m->type == CUSTOM_MMSC)
|
||||
typ = "CUSTOM";
|
||||
else if (m->type == HTTP_MMSC)
|
||||
typ = "HTTP";
|
||||
else
|
||||
typ = "none";
|
||||
|
||||
|
|
Loading…
Reference in New Issue