AgentNowHandler - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 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.

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

    AgentNowHandler - AgentNowHandler()

    Cria uma instância AgentNowHandler.

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

    O exemplo a seguir mostra como inicializar o AgentNowHandler.

    var handler = new sn_agent.AgentNowHandler();

    AgentNowHandler - getRequestStatus(String 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 pela chamada do método runCheckForCis().
    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:
    • 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().

    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.

    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(String testResultId)

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

    Tabela 4. Parâmetros
    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 5. Retornos
    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

    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(objeto cis, 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) em que a verificação esteja funcionando.
    verificação Objeto ID de verificação e 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.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"
}
    prioridade Número Prioridade da solicitação a ser definida na fila do ECC.
    Valores possíveis:
    • 0: interativo
    • 1: agilizado
    • 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 em segundo plano gerada.

    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)

    Interrompe uma verificação em segundo plano.

    Para iniciar uma verificação em segundo plano, use o método runCheckForCis().

    Tabela 8. Parâmetros
    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 9. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como interromper a execução de uma verificação em segundo plano.

    handler.stopBackgroundCheck(backRequestId);