Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

MIDServerManage- Global

The MIDServerManage script include provides methods that allow you to manage a MID Server by sending messages to start, stop, upgrade, get logs, send test probes, and send system messages.

Use in server scripts to send messages to a MID Server.

Parent Topic:Server API reference

MIDServerManage - MIDServerManage()

Creates an instance of MIDServerManage.

NameTypeDescription
None  

MIDServerManage - grab_logs(String agentName, String logs)

Gets the logs for the specified MID server.

NameTypeDescription
agentNameStringThe MID server name
logsStringThe type of log to get (Optional)
TypeDescription
StringThe log message
var msm = new MIDServerManage();
msm.grab_logs('serv1');

Output: Background message, type:info, message: Grabbing MID Server Logs

MIDServerManage - restart(String agentName)

Restarts the specified MID server.

NameTypeDescription
agentNameStringThe MID server name
TypeDescription
void 
var msm = new MIDServerManage();
msm.restart('serv1');

MIDServerManage - stop(String agentName)

Stops the specified MID server.

NameTypeDescription
agentNameStringThe MID server name
TypeDescription
void 
var msm = new MIDServerManage();
msm.stop('serv1');

MIDServerManage - system_msg(String agentName, String cmd, String name)

Creates a system message for the specified MID server.

NameTypeDescription
agentNameStringThe MID server name
cmdStringThe value of the probe source field
nameStringThe name of the probe
TypeDescription
void 
var msm = new MIDServerManage();
msm.test_probe('mid.server.serv1', 'command', 'probe_id');

MIDServerManage - text_probe(String agentName, String probeID, String topic, String ename, String source)

Sends a test probe for the specified MID server.

NameTypeDescription
agentNameStringThe MID server name
probeIdStringThe ID of the probe to send
topicStringThe information for the topic field
enameStringThe name for the probe
sourceStringThe information for the source field
TypeDescription
ObjectThe probe for the specified MID server
var msm = new MIDServerManage();
msm.test_probe('mid.server.serv1', 'probe_id', 'topic text', 'name', 'source text');

MIDServerManage - upgrade(String agentName)

Upgrades the specified MID server.

NameTypeDescription
agentNameStringThe MID server name
TypeDescription
void 
var msm = new MIDServerManage();
msm.upgrade('serv1');