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.

MIDServerManage - MIDServerManage()

Creates an instance of MIDServerManage.

Table 1. Parameters
Name Type Description
None

MIDServerManage - grab_logs(String agentName, String logs)

Gets the logs for the specified MID server.

Table 2. Parameters
Name Type Description
agentName String The MID server name
logs String The type of log to get (Optional)
Table 3. Returns
Type Description
String The log message

Example

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.

Table 4. Parameters
Name Type Description
agentName String The MID server name
Table 5. Returns
Type Description
void

Example

var msm = new MIDServerManage();
msm.restart('serv1');

MIDServerManage - stop(String agentName)

Stops the specified MID server.

Table 6. Parameters
Name Type Description
agentName String The MID server name
Table 7. Returns
Type Description
void

Example

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.

Table 8. Parameters
Name Type Description
agentName String The MID server name
cmd String The value of the probe source field
name String The name of the probe
Table 9. Returns
Type Description
void

Example

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.

Table 10. Parameters
NameTypeDescription
agentName String The MID server name
probeId String The ID of the probe to send
topic String The information for the topic field
ename String The name for the probe
source String The information for the source field
Table 11. Returns
Type Description
Object The probe for the specified MID server

Example

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.

Table 12. Parameters
Name Type Description
agentName String The MID server name
Table 13. Returns
Type Description
void

Example

var msm = new MIDServerManage();
msm.upgrade('serv1');