AccCheckDefsAPI - Com escopo

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

    • . AccCheckDefsAPI a inclusão de script permite gerenciar definições de verificação e parâmetros associados.

    Esta inclusão de script requer Agent Client Collector Estrutura (sn_agent) armazena a aplicação e é fornecida no sn_agent namespace. Esta inclusão de script requer a função agent_client_collector_admin. Para obter mais informações, consulte Agent Client Collector .

    Esta inclusão de script não tem um construtor para criar uma instância. Chame cada método usando AccCheckDefsAPI classe estática no seguinte formato:

    sn_agent.AccCheckDefsAPI.<method>

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

    Esta inclusão de script fornece métodos que permitem o seguinte:
    • Obtenha uma definição de verificação especificada
    • Obtenha uma lista de definições de verificação
    • Atualizar verificações e parâmetros de verificação

    AccCheckDefsAPI - getCheck(cadeia de caracteres checkDefId, booliano com Params)

    Obtém uma definição de verificação especificada com detalhes.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    checkDefId Cadeia de caracteres Sys_id da definição de verificação listada na tabela Definições de verificação [sn_agent_check_def].
    ComParâms Booliano Sinalizador que indica se os detalhes do parâmetro de verificação existente são retornados. Cada parâmetro de verificação padrão e seguro são incluídas em um objeto JSON.
    Valores válidos:
    • Verdadeiro: Retorna detalhes do parâmetro de verificação.
    • Falso: Não retorna detalhes do parâmetro de verificação.

    Padrão: Falso
    Tabela 2. Retornos
    Propriedades Descrição
    verificar Detalhes da definição de verificação especificada.
    "check ": {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "error": "String",
 "name": "String",
 "params": [Array],
 "plugins": [Array],
 "proxy_valid": Boolean,
 "secure_params": [Array],
 "sys_id": "String",
 "timeout": Number
}
    check.background Sinalizador que indica se esta definição de verificação é uma verificação de histórico. Uma verificação em segundo plano é uma verificação da qual o agente inicia a execução e não espera a conclusão da execução.
    Valores válidos:
    • Verdadeiro: Esta definição de verificação é uma verificação de histórico.
    • Falso: Esta definição de verificação não é uma verificação de histórico.

    Tipo de dados: Booliano
    check.check_group Grupo especificado para esta definição de verificação.

    Tipo de dados: Cadeia de caracteres
    check.check_type Tipo de verificação.
    Valores possíveis:
    • Eventos - Os resultados da verificação são transformados em um evento de Gestão de eventos.
    • Valores do resultado da verificação são transformados em métricas.

    Tipo de dados: Cadeia de caracteres
    check.command Que o comando Agent Client Collector executa.

    Tipo de dados: Cadeia de caracteres
    check.error Mensagem se houver um erro. Caso contrário, nulo.

    Tipo de dados: Cadeia de caracteres
    check.name Nome da verificação.

    Tipo de dados: Cadeia de caracteres
    check.params Lista de definições de parâmetro associadas à definição de verificação. Esses resultados serão incluídos somente se withParamso parâmetro está definido como verdadeiro.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Tipo de dados: Matriz
    check.params.active Sinalizador que indica se o parâmetro de verificação está ativo.
    Valores válidos:
    • Verdadeiro: O parâmetro de verificação está ativo.
    • Falso: O parâmetro de verificação está inativo.

    Tipo de dados: Booliano
    check.params.default_value Especifica o valor padrão para este parâmetro de verificação.

    Tipo de dados: Cadeia de caracteres
    check.params.obrigatório Sinalizador que indica se o parâmetro de verificação é necessário.
    Valores válidos:
    • Verdadeiro: O parâmetro de verificação é obrigatório.
    • Falso: O parâmetro de verificação é opcional.

    Tipo de dados: Booliano
    check.params.name Nome do parâmetro de verificação.

    Tipo de dados: Cadeia de caracteres
    check.params.sys_id Sys_id do parâmetro de verificação listado na tabela Verificar definições de parâmetro seguro [sn_agent_check_param_def].

    Tipo de dados: Cadeia de caracteres
    check.plugins Lista de Agent Client Collector plug-ins associado a esta verificação.

    Tipo de dados: Matriz
    check.proxy_valid Sinalizador que indica se a política de definição de verificação está definida para funcionar como proxy.
    Valores válidos:
    • Verdadeiro: Esta política de definição de verificação está definida para funcionar como proxy.
    • Falso: Esta política de definição de verificação não está definida para funcionar como proxy.

    Tipo de dados: Booliano
    check.secure_params Lista de atribuídos a esta verificação. Esses resultados serão incluídos somente se withParamso parâmetro está definido como verdadeiro.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Tipo de dados: Matriz
    check.secure_params.active Sinalizador que indica se o parâmetro seguro está ativo.
    Valores válidos:
    • Verdadeiro: O parâmetro seguro está ativo.
    • Falso: O parâmetro seguro está inativo.

    Tipo de dados: Booliano
    check.secure_params.name Nome do parâmetro seguro.

    Tipo de dados: Cadeia de caracteres
    check.secure_params.order Ordem na qual o parâmetro é enviado para o comando/script de verificação.

    Tipo de dados: Número
    check.secure_params.sys_id Sys_id do parâmetro seguro listado na tabela Verificar definições de parâmetro seguro [sn_agent_check_secure_param_def].

    Tipo de dados: Cadeia de caracteres
    check.sys_id Sys_id da definição de verificação listada na tabela Definições de verificação [sn_agent_check_def].

    Tipo de dados: Cadeia de caracteres
    check.timeout Tempo limite em segundos.

    Tipo de dados: Número

    O exemplo a seguir mostra como obter informações para uma definição de verificação especificada.

    var checkDefId = "94436b237f705300f128134f8dfa91a4";
var withParams = true;

var checkDef = sn_agent.AccCheckDefsAPI.getCheck(checkDefId, withParams);

gs.info(JSON.stringify(checkDef, null, 2));

    Saída:

    {
  "check": {
    "name": "app.apache.metrics-apache",
    "command": "metrics-apache-graphite.rb -p {{.labels.params_port}} --path {{.labels.params_path}} -h {{.labels.params_host}}",
    "plugins": [
      "monitoring-plugin-common"
    ],
    "timeout": 60,
    "proxy_valid": true,
    "background": false,
    "check_type": "Metrics",
    "check_group": "Apache",
    "sys_id": "94436b237f705300f128134f8dfa91a4",
    "params": [
      {
        "name": "port",
        "active": true,
        "mandatory": true,
        "default_value": "80",
        "sys_id": "58436b237f705300f128134f8dfa91a8"
      },
      {
        "name": "path",
        "active": true,
        "mandatory": true,
        "default_value": "/server-status?auto",
        "sys_id": "98436b237f705300f128134f8dfa91aa"
      },
      {
        "name": "scheme",
        "active": false,
        "mandatory": false,
        "default_value": null,
        "sys_id": "a4e57a96db3bbb4035305c55dc9619f6"
      },
      {
        "name": "host",
        "active": true,
        "mandatory": true,
        "default_value": "127.0.0.1",
        "sys_id": "d4436b237f705300f128134f8dfa91a6"
      },
      {
        "name": "ssl_secure_connection",
        "active": false,
        "mandatory": false,
        "default_value": null,
        "sys_id": "e3b272c4530100106ffeddeeff7b1275"
      }
    ],
    "secure_params": [
      {
        "name": "cred_user_name",
        "active": true,
        "order": 1,
        "sys_id": "2494cd6e53170010f42cddeeff7b1273"
      },
      {
        "name": "cred_password",
        "active": true,
        "order": 2,
        "sys_id": "35948d6e53170010f42cddeeff7b127f"
      }
    ]
  },
  "error": null
}

    AccCheckDefsAPI - getChecksList(String encodedQuery, limite de número, booliano com Params)

    Obtém uma lista de definições de verificação com detalhes.

    Consulte também Verificações e políticas .

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    encodedQuery Cadeia de caracteres Um cadeia de caracteres de consulta codificada para filtrar a lista de resultados da definição de verificação. Use nulo para uma lista não filtrada de definições de verificação no sistema.
    limite Número Limita o número de registros retornados. Definido como nulo para usar o valor padrão.

    Padrão: 20 000
    ComParâms Booliano Sinalizador que indica se os detalhes do parâmetro de verificação existente são retornados. Cada parâmetro de verificação padrão e seguro são incluídas em um objeto JSON.
    Valores válidos:
    • Verdadeiro: Retorna detalhes do parâmetro de verificação.
    • Falso: Não retorna detalhes do parâmetro de verificação.

    Padrão: Falso
    Tabela 4. Retornos
    Propriedades Descrição
    verifique as definições Definição de verificação e detalhes fornecidos como objetos JSON.
    [
  {
    "background": Boolean,
    "check_group": "String",
    "check_type": "String",
    "command": "String",
    "name": "String",
    "params": [Array],
    "plugins": [Array],
    "proxy_valid": Boolean,
    "secure_params": [Array],
    "sys_id": "String",
    "timeout": Number
  }
]

    Tipo de dados: Matriz
    Plano de fundo Sinalizador que indica se esta definição de verificação é uma verificação de histórico. Uma verificação em segundo plano é uma verificação da qual o agente inicia a execução e não espera a conclusão da execução.
    Valores válidos:
    • Verdadeiro: Esta definição de verificação é uma verificação de histórico.
    • Falso: Esta definição de verificação não é uma verificação de histórico.

    Tipo de dados: Booliano
    check_group Grupo especificado para esta definição de verificação.

    Tipo de dados: Cadeia de caracteres
    check_type Tipo de verificação.
    Valores possíveis:
    • Eventos - Os resultados da verificação são transformados em um evento de Gestão de eventos.
    • Valores do resultado da verificação são transformados em métricas.

    Tipo de dados: Cadeia de caracteres
    comando Que o comando Agent Client Collector executa.

    Tipo de dados: Cadeia de caracteres
    nome Nome da verificação.

    Tipo de dados: Cadeia de caracteres
    parâms Lista de definições de parâmetro associadas à definição de verificação. Esses resultados serão incluídos somente se withParamso parâmetro está definido como verdadeiro.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Tipo de dados: Matriz
    parâmetros.ativos Sinalizador que indica se o parâmetro de verificação está ativo.
    Valores válidos:
    • Verdadeiro: O parâmetro de verificação está ativo.
    • Falso: O parâmetro de verificação está inativo.

    Tipo de dados: Booliano
    params.default_value Especifica o valor padrão para este parâmetro de verificação.

    Tipo de dados: Cadeia de caracteres
    parâmetros.obrigatórios Sinalizador que indica se o parâmetro de verificação é necessário.
    Valores válidos:
    • Verdadeiro: O parâmetro de verificação é obrigatório.
    • Falso: O parâmetro de verificação é opcional.

    Tipo de dados: Booliano
    params.name Nome do parâmetro de verificação.

    Tipo de dados: Cadeia de caracteres
    params.sys_id Sys_id do parâmetro de verificação listado na tabela Verificar definições de parâmetro seguro [sn_agent_check_param_def].

    Tipo de dados: Cadeia de caracteres
    plug-ins Lista de Agent Client Collector plug-ins associado a esta verificação.

    Tipo de dados: Matriz
    proxy_valid Sinalizador que indica se a política de definição de verificação está definida para funcionar como proxy.
    Valores válidos:
    • Verdadeiro: Esta política de definição de verificação está definida para funcionar como proxy.
    • Falso: Esta política de definição de verificação não está definida para funcionar como proxy.

    Tipo de dados: Booliano
    secure_params Lista de atribuídos a esta verificação. Esses resultados serão incluídos somente se withParamso parâmetro está definido como verdadeiro.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Tipo de dados: Matriz
    secure_params.active Sinalizador que indica se o parâmetro seguro está ativo.
    Valores válidos:
    • Verdadeiro: O parâmetro seguro está ativo.
    • Falso: O parâmetro seguro está inativo.

    Tipo de dados: Booliano
    secure_params.name Nome do parâmetro seguro.

    Tipo de dados: Cadeia de caracteres
    secure_params.order Ordem na qual o parâmetro é enviado para o comando/script de verificação.

    Tipo de dados: Número
    secure_params.sys_id Sys_id do parâmetro seguro listado na tabela Verificar definições de parâmetro seguro [sn_agent_check_secure_param_def].

    Tipo de dados: Cadeia de caracteres
    sys_id Sys_id da definição de verificação listada na tabela Definições de verificação [sn_agent_check_def].

    Tipo de dados: Cadeia de caracteres
    timeout Tempo limite em segundos.

    Tipo de dados: Número

    O exemplo a seguir mostra como recuperar uma lista de duas definições de verificação com valores de parâmetro.

    var encQuery = "nameSTARTSWITHchecks_";
var limit = 2;
var withParams = true;

var checkDefs = sn_agent.AccCheckDefsAPI.getChecksList(encQuery, limit, withParams);

gs.info(JSON.stringify(checkDefs, null, 2));

    Saída:

    [
  {
    "name": "checks_api_test",
    "command": "echo hello",
    "plugins": [],
    "timeout": 9,
    "proxy_valid": true,
    "background": false,
    "check_type": "TestCheck",
    "check_group": "computer",
    "sys_id": "7f1f9026dba530106f4810284b96194f",
    "params": [],
    "secure_params": [
      {
        "name": "check_api_test_check_secure_param2",
        "active": true,
        "order": 2,
        "sys_id": "2d30a066dba530106f4810284b9619c1"
      },
      {
        "name": "check_api_test_check_secure_param1",
        "active": true,
        "order": 100,
        "sys_id": "4c20a066dba530106f4810284b9619a8"
      }
    ]
  },
  {
    "name": "checks_api_test222",
    "command": "echo hello1212121",
    "plugins": [],
    "timeout": 60,
    "proxy_valid": true,
    "background": false,
    "check_type": "TestCheck",
    "check_group": "computer",
    "sys_id": "99e12466dba530106f4810284b961976",
    "params": [
      {
        "name": "check_api_test_check_param_222",
        "active": true,
        "mandatory": false,
        "default_value": "test_test_test",
        "sys_id": "44026466dba530106f4810284b9619b2"
      }
    ],
    "secure_params": []
  }
]

    AccCheckDefsAPI - updateCheck(cadeia de caracteres checkDefId, objeto updateJson)

    Permite alterar um ou mais valores de campo de uma definição de verificação especificada.

    Consulte também Verificações e políticas .

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    checkDefId Cadeia de caracteres Sys_id da definição de verificação listada na tabela Definições de verificação [sn_agent_check_def].
    UpdateJson Objeto Mapa de campos de definição de verificação a serem atualizados para seus novos valores. Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos de Definição de verificação.
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "name": "String",
 "plugins": [Array],
 "proxy_valid": Boolean,
 "timeout": Number
}
    UpdateJson.active Número Indica se esta definição de verificação está ativa.
    Valores válidos:
    • 0: Esta definição de verificação está inativa.
    • 1: Esta definição de verificação está ativa.
    UpdateJson.background Booliano Sinalizador que indica se esta definição de verificação é uma verificação de histórico. Uma verificação em segundo plano é uma verificação da qual o agente inicia a execução e não espera a conclusão da execução.
    Valores válidos:
    • Verdadeiro: Esta definição de verificação é uma verificação de histórico.
    • Falso: Esta definição de verificação não é uma verificação de histórico.
    updateJson.check_group Cadeia de caracteres Grupo especificado para esta definição de verificação.
    updateJson.check_type Cadeia de caracteres Tipo de verificação.
    Valores possíveis:
    • Eventos - Os resultados da verificação são transformados em um evento de Gestão de eventos.
    • Valores do resultado da verificação são transformados em métricas.
    updateJson.command Cadeia de caracteres Que o comando Agent Client Collector executa.
    updateJson.name Cadeia de caracteres Nome da verificação.
    updateJson.plugins Matriz Lista de Agent Client Collector plug-ins associado a esta verificação.
    updateJson.proxy_valid Booliano

    Sinalizador que indica se a política de definição de verificação está definida para funcionar como proxy.

    Valores válidos:
    • Verdadeiro: Esta política de definição de verificação está definida para funcionar como proxy.
    • Falso: Esta política de definição de verificação não está definida para funcionar como proxy.
    UpdateJson.timeout Número Tempo limite em segundos.
    Tabela 6. Retornos
    Tipo Descrição
    Nenhum(a) Mensagem de erro se malsucedido.

    O exemplo a seguir mostra como desativar uma definição de verificação.

    var checkJson = sn_agent.AccCheckDefsAPI.getCheck(activeCheckDefs[0].sys_id, true);
if (!gs.nil(checkJson.error))
	gs.error(checkJson.error);

var updateJson = {active: "0"}; // deactivate the check definition
sn_agent.AccCheckDefsAPI.updateCheck(checkJson.check.sys_id, updateJson);

    AccCheckDefsAPI - updateCheckParam(cadeia de caracteres checkDefParamId, Object updateJson)

    Permite alterar um ou mais valores de campo de um parâmetro de verificação especificado.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    VerqueDefParamId Cadeia de caracteres Sys_id do parâmetro de verificação listado na tabela Definições de parâmetro de verificação [sn_agent_check_param_def].
    UpdateJson Objeto Mapa de campos de parâmetro de verificação a serem atualizados para seus novos valores. Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos Verificar definição de parâmetro seguro.
    {
 "active": Boolean,
 "default_value": "String",
 "mandatory": Boolean,
 "name": "String"
}
    UpdateJson.active Booliano

    Sinalizador que indica se o parâmetro de verificação está ativo.

    Valores válidos:
    • Verdadeiro: O parâmetro de verificação está ativo.
    • Falso: O parâmetro de verificação está inativo.
    updateJson.default_value Cadeia de caracteres Especifica o valor padrão para este parâmetro de verificação.
    UpdateJson.mandatory Booliano

    Sinalizador que indica se o parâmetro de verificação é necessário.

    Valores válidos:
    • Verdadeiro: O parâmetro de verificação é obrigatório.
    • Falso: O parâmetro de verificação é opcional.
    updateJson.name Cadeia de caracteres Nome do parâmetro de verificação.
    Tabela 8. Retornos
    Tipo Descrição
    Nenhum(a) Mensagem de erro se malsucedido.

    O exemplo a seguir mostra como ativar um parâmetro de verificação.

    var checkParmSysId = "cd922ce6dba530106f4810284b961966";
var updateJson = {"active": "true"};
sn_agent.AccCheckDefsAPI.updateCheckSecureParam(checkParmSysId, updateJson);

    AccCheckDefsAPI - updateCheckSecureParam(cadeia de caracteres checkDefSecureParamId, Object updateJson)

    Permite alterar um ou mais valores de campo de um parâmetro seguro de verificação especificado.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    DeSecureParamId Cadeia de caracteres Sys_id do parâmetro seguro listado na tabela Verificar definições de parâmetro seguro [sn_agent_check_secure_param_def].
    UpdateJson Objeto Mapa de campos de parâmetro seguro de verificação a serem atualizados para seus novos valores. Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos Verificar definição de parâmetro seguro.
    {
 "active": Boolean,
 "name": "String",
 "order": Number
}
    UpdateJson.active Booliano

    Sinalizador que indica se o parâmetro seguro está ativo.

    Valores válidos:
    • Verdadeiro: O parâmetro seguro está ativo.
    • Falso: O parâmetro seguro está inativo.
    updateJson.name Cadeia de caracteres Nome do parâmetro seguro.
    UpdateJson.order Número Ordem na qual o parâmetro é enviado para o comando/script de verificação.
    Tabela 10. Retornos
    Tipo Descrição
    Nenhum(a) Mensagem de erro se malsucedido.

    O exemplo a seguir mostra como ativar um parâmetro de verificação segura.

    var checkSecParmSysId = "<sys_id>";
var updateJson = {"active": "true"};
sn_agent.AccCheckDefsAPI.updateCheckSecureParam(checkSecParmSysId, updateJson);