Lark Router 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:
If admin-port-ssl was set to yes then you must use https:// .
The server_admin_port and admin_password should be given as specified in the configuration file. component is either mmsbox for Carrier Gateway specific requests, or mmsc for VASP Gateway commands. Supported command_uri values are:
version To obtain the current Lark Router version, Queue module version (including backend DB version) and REDIS server version
uptime To obtain the uptime of a Lark Router component (days, hours, minutes, seconds since start)
queue To get or modify the running queue status. This takes a CGI parameter actionwhich if it is set to:
pause temporarily suspends processing of the bind queue,
resume, resumes processing of the queue
status returns the number of messages in the queue pending for the given bind. purge immediately expires all messages in queue destined to the supplied bind. Messages to purge can further by filtered/limited by sender (CGI parameter sender) and/or by sending time (parameters from-time for the starting time interval and/or to-time for the ending time interval, and/or sender bind ID (CGI parameter from-bind). All dates in ISO date/time format). Returns the number of queue messages purged.
If no action is provided, the response is always Queue: 0, a new line, followed by DBQueue: and four comma-separated numbers: Number of incoming messages in the queue, number of outgoing messages, number of sending threads that are idle, total number of sending threads.
To stop a specific MMSC link, specified using the mmsc-id 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 mmsc groups defined in the configuration file. If mmsc-id is not provided, all defined MMSC connections are stopped.
To start a specific MMSC link, specified using the mmsc-id CGI parameter. The provided ID must match the ID of one of the mmsc groups defined in the configuration file. If mmsc-id is not provided, all defined MMSC connections are started.
To retrieve the status of a specific MMSC link, specified using the mmsc-id CGI parameter. The provided ID must match the ID of one of the mmsc groups defined in the configuration file. If mmsc-id is not provided, all defined MMSC connections’ status is reported.
To reload the configuration data for a specific MMSC link, specified using the mmsc-id CGI parameter. The provided ID must match the ID of one of the mmsc groups defined in the configuration file. If mmsc-id is not provided, all defined MMSC connections’ in the config file are reloaded. The following configurations are not reloaded at runtime (i.e. require a restart to take effect):
Server listener ports (MM1, MM4, MM7, admin port)
Log files locations
Event counter intervals
Redis server host name and port
Server host name and host alias
Queue settings, including queue storage directory, queue module, etc.
Cache settings (folder, intervals, timeouts…
Pluggable modules and settings (billing module, resolver module, etc.)
Used to clear the in-memory and on-disk SMIL content cache. Only one CGI parameter action is expected and it must be set to purge. The optional CGI parameter maxage may also be provided; if so it must be set to a number, indicating the maximum age (in seconds since last access) of the cache entries to be deleted. In this case only cache entries that have not been accessed or updated in maxage seconds will be purged. Default is to purge all messages.
This is used to reload the main configuration parameters or obtain the current config parameters. It takes on parameter action which must be set to reload to cause a reload of the main configuration parameters, or get to obtain the current configurations for any group. If set to get, then you must supply CGI parameter group (which must be set to one of core, Lark Router, mms-vasp or mmsc) to specify which config group you wish to obtain, and, optionally, parameter id to specify the ID of the group config you wish to query. Note that this only applies to mmsc, mms-vasp groups. For instance to obtain the current configurations for the carrier bind soap1 you should supply group=mmsc&id=soap1 as parameters.
The response in each case is XML-formatted. For the status command, the result is the following form:
<mmsc id=”eaif” type=”EAIF”>
<mmsc id=”mail” type=”MM4″>
<mmsc id=”http” type=”HTTP”>
<mmsc id=”local” type=”SOAP”>
The information includes basic MMSC configuration data, connection uptime, time of last received PDU, received and sent PDUs, errors.
For the start command, the response is the same as that for status if the command succeeds, otherwise the result is of the form:
For the stop command the result is of the form:
depending on whether the command succeeded or failed.