{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":1064,"path":"api-reference/server-api-reference/c_MIDServerManageAPI.md","title":"MIDServerManage - Global","bundle":null,"doc_type":null,"release":"australia","body":"\n# MIDServerManage- Global\n\nThe 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.\n\nUse in server scripts to send messages to a MID Server.\n\n**Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md)\n\n## MIDServerManage - MIDServerManage\\(\\)\n\nCreates an instance of MIDServerManage.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n## MIDServerManage - grab\\_logs\\(String agentName, String logs\\)\n\nGets the logs for the specified MID server.\n\n|Name|Type|Description|\n|----|----|-----------|\n|agentName|String|The MID server name|\n|logs|String|The type of log to get \\(Optional\\)|\n\n|Type|Description|\n|----|-----------|\n|String|The log message|\n\n```\nvar msm = new MIDServerManage();\nmsm.grab_logs('serv1');\n```\n\nOutput: Background message, type:info, message: Grabbing MID Server Logs\n\n## MIDServerManage - restart\\(String agentName\\)\n\nRestarts the specified MID server.\n\n|Name|Type|Description|\n|----|----|-----------|\n|agentName|String|The MID server name|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar msm = new MIDServerManage();\nmsm.restart('serv1');\n```\n\n## MIDServerManage - stop\\(String agentName\\)\n\nStops the specified MID server.\n\n|Name|Type|Description|\n|----|----|-----------|\n|agentName|String|The MID server name|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar msm = new MIDServerManage();\nmsm.stop('serv1');\n```\n\n## MIDServerManage - system\\_msg\\(String agentName, String cmd, String name\\)\n\nCreates a system message for the specified MID server.\n\n|Name|Type|Description|\n|----|----|-----------|\n|agentName|String|The MID server name|\n|cmd|String|The value of the probe source field|\n|name|String|The name of the probe|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar msm = new MIDServerManage();\nmsm.test_probe('mid.server.serv1', 'command', 'probe_id');\n```\n\n## MIDServerManage - text\\_probe\\(String agentName, String probeID, String topic, String ename, String source\\)\n\nSends a test probe for the specified MID server.\n\n|Name|Type|Description|\n|----|----|-----------|\n|agentName|String|The MID server name|\n|probeId|String|The ID of the probe to send|\n|topic|String|The information for the topic field|\n|ename|String|The name for the probe|\n|source|String|The information for the source field|\n\n|Type|Description|\n|----|-----------|\n|Object|The probe for the specified MID server|\n\n```\nvar msm = new MIDServerManage();\nmsm.test_probe('mid.server.serv1', 'probe_id', 'topic text', 'name', 'source text');\n```\n\n## MIDServerManage - upgrade\\(String agentName\\)\n\nUpgrades the specified MID server.\n\n|Name|Type|Description|\n|----|----|-----------|\n|agentName|String|The MID server name|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\n```\nvar msm = new MIDServerManage();\nmsm.upgrade('serv1');\n```\n\n"}}