AccCheckDefsAPI - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 12 min. de leitura

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

    Esta inclusão de script requer a aplicação da loja Agent Client Collector Framework (sn_agent) e é fornecida no namespace sn_agent. 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 a classe estática AccCheckDefsAPI no seguinte formato:

    sn_agent.AccCheckDefsAPI.<method>

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

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

    AccCheckDefsAPI – getCheck(cadeia de caracteres checkDefId, booliano withParams)

    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].
    withParams Booliano Sinalizador que indica se os detalhes do parâmetro de verificação existente são retornados. As informações de 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
    verificação 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
}
    verificação.background Sinalizador que indica se esta definição de verificação é uma verificação em segundo plano. Uma verificação em segundo plano é uma verificação em que o agente inicia a execução e não espera que ele termine.
    Valores válidos:
    • verdadeiro: esta definição de verificação é uma verificação em segundo plano.
    • falso: esta definição de verificação não é uma verificação em segundo plano.

    Tipo de dados: booliano
    verificar.verificar_grupo Grupo especificado para esta definição de verificação.

    Tipo de dados: cadeia de caracteres
    verificação.verificação_tipo Tipo de verificação.
    Valores possíveis:
    • Eventos - os resultados da verificação são transformados em um evento de gestão de eventos.
    • Métricas – os valores do resultado da verificação são transformados em métricas.

    Tipo de dados: cadeia de caracteres
    cheque.comando Comando que o Agent Client Collector executa.

    Tipo de dados: cadeia de caracteres
    verificação.erro 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.parâmetros Lista de definições de parâmetro associadas à definição de verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver 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
    verificar.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 Definições de parâmetro seguro de verificação [sn_agent_check_param_def].

    Tipo de dados: cadeia de caracteres
    verificar.plug-ins Lista de Agent Client Collector plug-ins associados 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 um proxy.
    Valores válidos:
    • verdadeiro: esta política de definição de verificação está definida para funcionar como um proxy.
    • falso: esta política de definição de verificação não está definida para funcionar como um proxy.

    Tipo de dados: booliano
    check.secure_params Lista de atribuídos a esta verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver 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 de segurança está ativo.
    • falso: o parâmetro de segurança 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
    verificação.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 (cadeia de caracteres encodedQuery, Number Limit, Booliano withParams)

    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 Uma 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. Defina como nulo para usar o valor padrão.

    Padrão: 20.000
    withParams Booliano Sinalizador que indica se os detalhes do parâmetro de verificação existente são retornados. As informações de 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
    verificar definições Lista de 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 em segundo plano. Uma verificação em segundo plano é uma verificação em que o agente inicia a execução e não espera que ele termine.
    Valores válidos:
    • verdadeiro: esta definição de verificação é uma verificação em segundo plano.
    • falso: esta definição de verificação não é uma verificação em segundo plano.

    Tipo de dados: booliano
    verificar_grupo 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.
    • Métricas – os valores do resultado da verificação são transformados em métricas.

    Tipo de dados: cadeia de caracteres
    comando Comando que o 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 só serão incluídos se o parâmetro withParams estiver definido como verdadeiro.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Tipo de dados: matriz
    parâmetros.ativo 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
    parâmetros.valor_padrão Especifica o valor padrão para este parâmetro de verificação.

    Tipo de dados: cadeia de caracteres
    parâmetros.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
    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 Definições de parâmetro seguro de verificação [sn_agent_check_param_def].

    Tipo de dados: cadeia de caracteres
    plug-ins Lista de Agent Client Collector plug-ins associados 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 um proxy.
    Valores válidos:
    • verdadeiro: esta política de definição de verificação está definida para funcionar como um proxy.
    • falso: esta política de definição de verificação não está definida para funcionar como um proxy.

    Tipo de dados: booliano
    parâmetros_seguros Lista de atribuídos a esta verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver definido como verdadeiro.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Tipo de dados: matriz
    parâmetros_seguros.ativo Sinalizador que indica se o parâmetro seguro está ativo.
    Valores válidos:
    • verdadeiro: o parâmetro de segurança está ativo.
    • falso: o parâmetro de segurança está inativo.

    Tipo de dados: booliano
    params_seguros.nome Nome do parâmetro seguro.

    Tipo de dados: cadeia de caracteres
    parâmetros_seguros.ordem Ordem na qual o parâmetro é enviado para o comando/script de verificação.

    Tipo de dados: número
    parâmetros_seguros.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)

    Habilita a mudança de 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].
    atualizarJson Objeto Mapa de campos de definição de verificação a serem atualizados para os 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.ativo 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 em segundo plano. Uma verificação em segundo plano é uma verificação em que o agente inicia a execução e não espera que ele termine.
    Valores válidos:
    • verdadeiro: esta definição de verificação é uma verificação em segundo plano.
    • falso: esta definição de verificação não é uma verificação em segundo plano.
    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.
    • Métricas – os valores do resultado da verificação são transformados em métricas.
    updateJson.command Cadeia de caracteres Comando que o 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 um proxy.

    Valores válidos:
    • verdadeiro: esta política de definição de verificação está definida para funcionar como um proxy.
    • falso: esta política de definição de verificação não está definida para funcionar como um 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, objeto updateJson)

    Habilita a mudança de um ou mais valores de campo de um parâmetro de verificação especificado.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    checkDefParamId 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].
    atualizarJson Objeto Mapa de campos de parâmetro de verificação a serem atualizados para os novos valores. Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos de Verificar Definição de Parâmetro de Segurança.
    {
 "active": Boolean,
 "default_value": "String",
 "mandatory": Boolean,
 "name": "String"
}
    updateJson.ativo 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 é necessá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, objeto updateJson)

    Habilita a mudança de um ou mais valores de campo de um parâmetro de verificação seguro especificado.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    checkDefSecureParamId 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].
    atualizarJson Objeto Mapa de campos de parâmetro de verificação segura a serem atualizados para os novos valores. Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos de Verificar Definição de Parâmetro de Segurança.
    {
 "active": Boolean,
 "name": "String",
 "order": Number
}
    updateJson.ativo Booliano

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

    Valores válidos:
    • verdadeiro: o parâmetro de segurança está ativo.
    • falso: o parâmetro de segurança está inativo.
    updateJson.name Cadeia de caracteres Nome do parâmetro seguro.
    updateJson.ordem 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);