---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# MIDServerManage - Global

# MIDServerManage - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

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() {#ariaid-title2}

Creates an instance of MIDServerManage.
{#r_MSMG-MIDServerManage__table_cbx_cdm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#r_MSMG-MIDServerManage__table_cbx_cdm_zt}

## MIDServerManage - grab_logs(String agentName, String logs) {#ariaid-title3}

Gets the logs for the specified MID server.
{#r_MSMG-grab_logs_S_S__table_kmm_g2m_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| agentName | String | The MID server name |
| logs | String | The type of log to get (Optional) |
[Table 2. Parameters]

{#r_MSMG-grab_logs_S_S__table_kmm_g2m_zt} {#r_MSMG-grab_logs_S_S__table_lmm_g2m_zt__entry__2}

| Type | Description |
|-|-|
| String | The log message |
[Table 3. Returns]

{#r_MSMG-grab_logs_S_S__table_lmm_g2m_zt}  

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

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

## MIDServerManage - restart(String agentName) {#ariaid-title4}

Restarts the specified MID server.
{#r_MSMG-restart_S__table_vqq_scm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| agentName | String | The MID server name |
[Table 4. Parameters]

{#r_MSMG-restart_S__table_vqq_scm_zt} {#r_MSMG-restart_S__table_wqq_scm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 5. Returns]

{#r_MSMG-restart_S__table_wqq_scm_zt}  

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

## MIDServerManage - stop(String agentName) {#ariaid-title5}

Stops the specified MID server.
{#r_MSMG-stop_S__table_hx3_mdm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| agentName | String | The MID server name |
[Table 6. Parameters]

{#r_MSMG-stop_S__table_hx3_mdm_zt} {#r_MSMG-stop_S__table_ix3_mdm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 7. Returns]

{#r_MSMG-stop_S__table_ix3_mdm_zt}  

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

## MIDServerManage - system_msg(String agentName, String cmd, String name) {#ariaid-title6}

Creates a system message for the specified MID server.
{#r_MSMG-system_msg_S_S_S__table_dwf_tfm_zt__entry__3}

| 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 8. Parameters]

{#r_MSMG-system_msg_S_S_S__table_dwf_tfm_zt} {#r_MSMG-system_msg_S_S_S__table_ewf_tfm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 9. Returns]

{#r_MSMG-system_msg_S_S_S__table_ewf_tfm_zt}  

    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) {#ariaid-title7}

Sends a test probe for the specified MID server.
{#r_MSMG-text_probe_S_S_S_S_S__table_qby_y2m_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| 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 10. Parameters]

{#r_MSMG-text_probe_S_S_S_S_S__table_qby_y2m_zt} {#r_MSMG-text_probe_S_S_S_S_S__table_rby_y2m_zt__entry__2}

| Type | Description |
|-|-|
| Object | The probe for the specified MID server |
[Table 11. Returns]

{#r_MSMG-text_probe_S_S_S_S_S__table_rby_y2m_zt}  

    var msm = new MIDServerManage();
    msm.test_probe('mid.server.serv1', 'probe_id', 'topic text', 'name', 'source text');

## MIDServerManage - upgrade(String agentName) {#ariaid-title8}

Upgrades the specified MID server.
{#r_MSMG-upgrade_S__table_hnr_wdm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| agentName | String | The MID server name |
[Table 12. Parameters]

{#r_MSMG-upgrade_S__table_hnr_wdm_zt} {#r_MSMG-upgrade_S__table_inr_wdm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 13. Returns]

{#r_MSMG-upgrade_S__table_inr_wdm_zt}  

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