---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# MIDServerManage - Global

# MIDServerManage - Global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

A inclusão de script MIDServerManage fornece métodos que permitem gerenciar um MID Server enviando mensagens para iniciar, parar, fazer upgrade, obter logs, enviar probes de teste e enviar mensagens do sistema.

Use em scripts de servidor para enviar mensagens para um MID Server.

## MIDServerManage - MIDServerManage() {#ariaid-title2}

Cria uma instância de MIDServerManage.
{#r_MSMG-MIDServerManage__table_cbx_cdm_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

{#r_MSMG-MIDServerManage__table_cbx_cdm_zt}

## MIDServerManage - Grab_logs (cadeia de caracteres agentName, cadeia de caracteres logs) {#ariaid-title3}

Obtém os logs do MID Server especificado.
{#r_MSMG-grab_logs_S_S__table_kmm_g2m_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentName | Cadeia de caracteres | O nome do MID server |
| logs | Cadeia de caracteres | O tipo de log a ser obtido (opcional) |
[Tabela 2. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | A mensagem de log |
[Tabela 3. Retorna]

{#r_MSMG-grab_logs_S_S__table_lmm_g2m_zt}  

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

Saída: mensagem em segundo plano, tipo:info, mensagem: capturando logs do MID Server

## MIDServerManage - restart(cadeia de caracteres agentName) {#ariaid-title4}

Reinicia o MID Server especificado.
{#r_MSMG-restart_S__table_vqq_scm_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentName | Cadeia de caracteres | O nome do MID Server |
[Tabela 4. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 5. Retorna]

{#r_MSMG-restart_S__table_wqq_scm_zt}  

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

## MIDServerManage - stop(cadeia de caracteres agentName) {#ariaid-title5}

Interrompe o MID Server especificado.
{#r_MSMG-stop_S__table_hx3_mdm_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentName | Cadeia de caracteres | O nome do MID Server |
[Tabela 6. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 7. Retorna]

{#r_MSMG-stop_S__table_ix3_mdm_zt}  

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

## MIDServerManage - system_msg (cadeia de caracteres agentName, cadeia de caracteres cmd, cadeia de caracteres name) {#ariaid-title6}

Cria uma mensagem do sistema para o MID Server especificado.
{#r_MSMG-system_msg_S_S_S__table_dwf_tfm_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentName | Cadeia de caracteres | O nome do MID Server |
| cmd | Cadeia de caracteres | O valor do campo de origem da probe |
| nome | Cadeia de caracteres | O nome da probe |
[Tabela 8. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 9. Retorna]

{#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 (cadeia de caracteres agentName, cadeia de caracteres probeID, tópico de cadeia de caracteres, ename de cadeia de caracteres, origem de cadeia de caracteres) {#ariaid-title7}

Envia uma probe de teste para o MID Server especificado.
{#r_MSMG-text_probe_S_S_S_S_S__table_qby_y2m_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentName | Cadeia de caracteres | O nome do MID Server |
| probeId | Cadeia de caracteres | O ID da probe a ser enviada |
| tópico | Cadeia de caracteres | As informações do campo de tópico |
| ename | Cadeia de caracteres | O nome da probe |
| origem | Cadeia de caracteres | As informações do campo de origem |
[Tabela 10. Parâmetros]

{#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}

| Tipo | Descrição |
|-|-|
| Objeto | A probe do MID Server especificado |
[Tabela 11. Retorna]

{#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(cadeia de caracteres agentName) {#ariaid-title8}

Faz upgrade do MID Server especificado.
{#r_MSMG-upgrade_S__table_hnr_wdm_zt__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentName | Cadeia de caracteres | O nome do MID Server |
[Tabela 12. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 13. Retorna]

{#r_MSMG-upgrade_S__table_inr_wdm_zt}  

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