AgentNowHandler - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura

    • . AgentNowHandler a inclusão de script 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 Agent Client Collector Estrutura (sn_agent) armazena a aplicação e é fornecida no sn_agent namespace. Para obter mais informações, consulte Agent Client Collector .

    Para obter a solução REST API, consulte API do Agent Client Collector .

    AgentNowHandler - AgentNowHandler()

    Cria uma instância do AgentNowHandler.

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

    O exemplo a seguir mostra como inicializar AgentNowHandler .

    var handler = new sn_agent.AgentNowHandler();

    AgentNowHandler - getRequestStatus(cadeia de caracteres requestId)

    Obtém o status da solicitação com o ID fornecido.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    requestId Cadeia de caracteres Um ID de solicitação de verificação gerado chamando o. RunCheckForCis() método.
    Tabela 3. Retornos
    Propriedades Descrição
    Objeto Status da solicitação e qualquer mensagem de erro aplicável.
    status Status da solicitação.
    Valores possíveis:
    • Concluído - A verificação foi bem-sucedida.
    • Falha - A verificação falhou. Consulte a mensagem de erro para obter detalhes.
    • Mid_flow - A saída da solicitação está sendo tratada pelo MID Server.
    • Processamento - A verificação está em andamento.
    • Tempo limite - Verifique se o processamento excedeu o limite de tempo definido em RunCheckForCis() método.

    Tipo de dados: Cadeia de caracteres
    err_msg Mensagem de erro, se houver.
    Valores possíveis:
    • Nenhum agente encontrado para ICs relevantes.
    • Nenhuma solicitação de verificação de histórico com o ID fornecido.
    • Nenhuma solicitação com o ID fornecido.
    • Nenhum resultado de teste com o ID fornecido.
    • Tempo limite da solicitação.

    Tipo de dados: Cadeia de caracteres

    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(cadeia de caracteres testResultId)

    Obtém o status de verificação de teste do resultado de teste fornecido.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    TestResultId Cadeia de caracteres Um ID de resultado de teste gerado pela criação de uma solicitação de verificação de teste.
    Tabela 5. Retornos
    Propriedades Descrição
    status Status dos resultados do teste.
    Valores possíveis:
    • 0: Pendente
    • 1: Em andamento
    • 2: Concluído
    • 3: Nenhum resultado de teste com o ID fornecido

    Tipo de dados: Cadeia de caracteres
    saída Saída que descreve o status.

    Tipo de dados: Cadeia de caracteres

    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 (ics de objeto, verificação de objeto, prioridade de número, tempo limite de número)

    Executa uma verificação em relação ao item de configuração fornecido.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    cis GlideRecord GlideRecord de qualquer tabela do CMDB (qualquer aplicação, host ou agente) na qual a verificação está trabalhando.
    verificar Objeto Verifique o ID e os parâmetros de verificação opcionais. 
    "check": {
  "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.params Objeto Opcional. Mapa de nomes e valores de parâmetros. 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"
}
    prioridade Número Prioridade da solicitação a ser definida na fila do ECC.
    Valores possíveis:
    • 0: interativo
    • 1: expedido
    • 2: padrão
    timeout Número Valor do tempo limite da solicitação em segundos.
    Tabela 7. Retornos
    Tipo Descrição
    Cadeia de caracteres Sys_id da solicitação de verificação de histórico gerada.

    O exemplo a seguir mostra como executar uma verificação de histórico 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(cadeia de caracteres requestId)

    Interrompe uma verificação de histórico.

    Para iniciar uma verificação de histórico, use RunCheckForCis() método.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    requestId Cadeia de caracteres O ID de uma solicitação de verificação de histórico gerada pela chamada de RunCheckForCis() método.
    Tabela 9. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como parar de executar uma verificação de histórico.

    handler.stopBackgroundCheck(backRequestId);