---
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


---

# AgentNowHandler - com escopo

# AgentNowHandler - com escopo {#ariaid-title1}

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

A inclusão de script AgentNowHandler fornece métodos que permitem a execução de definições de verificação sob demanda, verificando o status de execuções sob demanda e execuções de verificação de teste e para interromper verificações em segundo plano que foram executadas sob demanda.

Esta inclusão de script requer a aplicação da loja Agent Client Collector Framework (sn_agent) e é fornecida no namespace `sn_agent`. Para obter mais informações, consulte [Agent Client Collector](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).

Para a solução REST API, consulte [Agent Client Collector API](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-api "A API Agent Client Collector fornece endpoints para gerenciar ações em agentes disponíveis e gerenciar políticas.").

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

Cria uma instância AgentNowHandler.
{#AgentNowHnl-AgentNowHandler__table_ohr_4qd_bpb__entry__3}

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

{#AgentNowHnl-AgentNowHandler__table_ohr_4qd_bpb}  
O exemplo a seguir mostra como inicializar o AgentNowHandler.

    var handler = new sn_agent.AgentNowHandler();

## AgentNowHandler - getRequestStatus(String requestId) {#ariaid-title3}

Obtém o status da solicitação com o ID fornecido.
{#AgentNowHnl-getRequestStatus_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| requestId | Cadeia de caracteres | Um ID de solicitação de verificação gerado pela chamada do método runCheckForCis(). |
[Tabela 2. Parâmetros]

{#AgentNowHnl-getRequestStatus_S__table_zk2_2g2_z4b} {#AgentNowHnl-getRequestStatus_S__table_al2_2g2_z4b__entry__2}

| Propriedades | Descrição |
|-|-|
| Objeto | Status da solicitação e qualquer mensagem de erro aplicável. |
| status | Status da solicitação. Valores possíveis: * Done -- Verificação bem-sucedida. * falha -- Falha na verificação. Consulte a mensagem de erro para obter detalhes. * mid_flow -- A saída da solicitação está sendo processada pelo MID Server. * processando -- A verificação está em andamento. * timeout -- O processamento da verificação excedeu o limite de tempo definido no método runCheckForCis(). {#AgentNowHnl-getRequestStatus_S__ul_edm_1rr_5qb} Tipo de dados: cadeia de caracteres |
| erro_msg | Mensagem de erro, se houver. Valores possíveis: * Nenhum agente encontrado para ICs relevantes. * Nenhuma solicitação de verificação em segundo plano com o ID fornecido. * Nenhuma solicitação com o ID fornecido. * Nenhum resultado de testes com o ID fornecido. * Tempo limite da solicitação. {#AgentNowHnl-getRequestStatus_S__ul_qcf_zcq_5qb} Tipo de dados: cadeia de caracteres |
[Tabela 3. Retorna]

{#AgentNowHnl-getRequestStatus_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como obter o status de uma solicitação.

    var handler = new sn_agent.AgentNowHandler();
    var check = {checkDefId: "158279505372b30034b8ddeeff7b1270"};
    var computerGr = new GlideRecord("cmdb_ci_computer");
    computerGr.query();
    var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

    var reqStatusJson = handler.getRequestStatus(requestId);
    gs.info(JSON.stringify(reqStatusJson));

## AgentNowHandler - getTestResultStatus(String testResultId) {#ariaid-title4}

Obtém o status de verificação do resultado de teste fornecido.
{#AgentNowHnl-getTestResultStatus_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| testResultId | Cadeia de caracteres | Um ID de resultado de testes gerado pela criação de uma solicitação de verificação de teste. |
[Tabela 4. Parâmetros]

{#AgentNowHnl-getTestResultStatus_S__table_zk2_2g2_z4b} {#AgentNowHnl-getTestResultStatus_S__table_al2_2g2_z4b__entry__2}

| Propriedades | Descrição |
|-|-|
| status | Status dos resultados de testes. Valores possíveis: * 0: Pendente * 1: Em andamento * 2: Concluído * 3: Nenhum resultado de teste com o ID fornecido {#AgentNowHnl-getTestResultStatus_S__ul_yyq_4bq_5qb} Tipo de dados: cadeia de caracteres |
| saída | Saída que descreve o status. Tipo de dados: cadeia de caracteres |
[Tabela 5. Retorna]

{#AgentNowHnl-getTestResultStatus_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como obter o status do resultado de uma solicitação de verificação de teste concluída.

    var testCheckStatusJson = handler.getTestResultStatus("testResultId");
    gs.info(JSON.stringify(testCheckStatusJson));

## AgentNowHandler - runCheckForCis(objeto cis, verificação de objeto, prioridade de número, tempo limite de número) {#ariaid-title5}

Executa uma verificação em relação ao item de configuração fornecido.
{#AgentNowHnl-runCheckForCis_O_O_N_N__table_zk2_2g2_z4b__entry__3}{#AgentNowHnl-runCheckForCis_O_O_N_N__agntNowHlr-parm-ph-chkparms}

| Nome | Tipo | Descrição |
|-|-|-|
| cis | [GlideRecord](https://servicenow-prod.fluidtopics.net/FBR_zQLvGAsgQtw7~4MAGA#c_GlideRecordScopedAPI "A API GlideRecord com escopo é usada para operações de banco de dados.") | GlideRecord de qualquer tabela do CMDB (qualquer aplicação, host ou agente) em que a verificação esteja funcionando. |
| verificação | Objeto | ID de verificação e parâmetros de verificação opcionais. { "checkDefId": "String", "params": {Object} } |
| check.checkDefId | Cadeia de caracteres | Sys_id de uma definição de verificação na tabela Definições de verificação \[sn_agent_check_def\]. |
| check.parâmetros | Objeto | Opcional. Mapa de nomes e valores de parâmetro. Essas configurações podem ser usadas para substituir os registros de parâmetro da definição de verificação e seus valores especificados. "params": { "<parameter name>": "String" } {#AgentNowHnl-runCheckForCis_O_O_N_N__agntNowHlr-parm-cd-chkparms} |
| prioridade | Número | Prioridade da solicitação a ser definida na fila do ECC. Valores possíveis: * 0: interativo * 1: agilizado * 2: padrão {#AgentNowHnl-runCheckForCis_O_O_N_N__ul_bkf_hnq_wqb} |
| tempo limite | Número | Valor do tempo limite da solicitação em segundos. |
[Tabela 6. Parâmetros]

{#AgentNowHnl-runCheckForCis_O_O_N_N__table_zk2_2g2_z4b} {#AgentNowHnl-runCheckForCis_O_O_N_N__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id da solicitação de verificação em segundo plano gerada. |
[Tabela 7. Retorna]

{#AgentNowHnl-runCheckForCis_O_O_N_N__table_al2_2g2_z4b}  
O exemplo a seguir mostra como executar uma verificação em segundo plano e obter seu ID de solicitação.

    var handler = new sn_agent.AgentNowHandler();
    var check = {checkDefId: "028fcd5067c80010b7b72dbd2685ef4f"};
    var computerGr = new GlideRecord("cmdb_ci_computer");
    computerGr.query();
    var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

    gs.info(requestId);

Saída:

    b9cf14aedb5e30106f4810284b961990

## AgentNowHandler - stopBackgroundCheck(String requestId) {#ariaid-title6}

Interrompe uma verificação em segundo plano.
Para iniciar uma verificação em segundo plano, use o método runCheckForCis().
{#AgentNowHnl-stopBackgroundCheck_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| requestId | Cadeia de caracteres | O ID de uma solicitação de verificação em segundo plano gerada pela chamada do método runCheckForCis(). |
[Tabela 8. Parâmetros]

{#AgentNowHnl-stopBackgroundCheck_S__table_zk2_2g2_z4b} {#AgentNowHnl-stopBackgroundCheck_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Retorna]

{#AgentNowHnl-stopBackgroundCheck_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como interromper a execução de uma verificação em segundo plano.

    handler.stopBackgroundCheck(backRequestId);