AccCheckDefsAPI : inclus dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 12 minutes de lecture

    • L’include de script AccCheckDefsAPI permet de gérer les définitions de vérification et les paramètres associés.

    Cet include de script nécessite l’application Agent Client Collector de stockage Framework (sn_agent) et est fourni dans l’espace de noms sn_agent . Cet include de script nécessite le rôle agent_client_collector_admin. Pour plus d’informations, consultez Agent Client Collector.

    Cet include de script n’a pas de constructeur pour la création d’une instance. Appelez chaque méthode à l’aide de la classe statique AccCheckDefsAPI au format suivant :

    sn_agent. AccCheckDefsAPI.<method>

    Pour la solution d’API REST, consultez l’API Agent Client Collector.

    Cet include de script fournit des méthodes qui activent les éléments suivants :
    • Obtenir une définition de vérification spécifiée
    • Obtenir une liste des définitions de vérification
    • Mettre à jour les vérifications et vérifier les paramètres

    AccCheckDefsAPI : getCheck(String checkDefId, Boolean withParams)

    Obtient une définition de vérification spécifiée avec des détails.

    Tableau 1. Paramètres
    Nom Type Description
    checkDefId (en anglais seulement) Chaîne Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].
    withParams Booléen Marqueur indiquant si les détails des paramètres de vérification existants sont renvoyés. Les informations relatives à chaque paramètre de contrôle standard et sécurisé sont incluses dans un objet JSON.
    Valeurs valides :
    • true : renvoie les détails des paramètres de vérification.
    • faux : ne renvoie pas les détails des paramètres de vérification.

    Valeur par défaut : false
    Tableau 2. Renvoie
    Propriétés Description
    vérifier Détails de la définition de contrôle spécifiée.
    "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
}
    vérifier.arrière-plan Marqueur indiquant si cette définition de vérification est une vérification d’antécédents. Une vérification des antécédents est une vérification que l’agent commence à exécuter sans attendre qu’elle se termine.
    Valeurs valides :
    • true : cette définition de vérification est une vérification d’arrière-plan.
    • false : cette définition de vérification n’est pas une vérification des antécédents.

    Type de données : booléennes
    check.check_group Groupe spécifié pour cette définition de vérification.

    Type de données : chaîne
    check.check_type Type de vérification.
    Valeurs possibles :
    • Événements : vérifiez que les résultats sont transformés en événement de gestion des événements.
    • Mesures : les valeurs du résultat de vérification sont transformées en mesures.

    Type de données : chaîne
    vérifier.commande Commande exécutée Agent Client Collector .

    Type de données : chaîne
    vérifier.erreur Message en cas d’erreur. Null dans le cas contraire.

    Type de données : chaîne
    check.name Nom du chèque.

    Type de données : chaîne
    paramètres.vérification Liste des définitions de paramètres associées à la définition de vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Type de données : tableau
    check.params.active Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • true : le paramètre de vérification est actif.
    • false : le paramètre check est inactif.

    Type de données : booléennes
    check.params.default_value Spécifie la valeur par défaut de ce paramètre de vérification.

    Type de données : chaîne
    vérifier.params.obligatoire Marqueur indiquant si le paramètre de vérification est requis.
    Valeurs valides :
    • true : le paramètre check est requis.
    • false : le paramètre check est facultatif.

    Type de données : booléennes
    check.params.name Nom du paramètre de vérification.

    Type de données : chaîne
    check.params.sys_id Sys_id du paramètre de vérification répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_param_def].

    Type de données : chaîne
    vérifier.modules d’extension Liste des Agent Client Collector modules d’extension associés à cette vérification.

    Type de données : tableau
    check.proxy_valid Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner en tant que proxy.
    Valeurs valides :
    • true : cette politique de définition de vérification est définie pour fonctionner en tant que proxy.
    • false : cette politique de définition de vérification n’est pas définie pour fonctionner en tant que proxy.

    Type de données : booléennes
    check.secure_params Liste des éléments affectés à ce chèque. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Type de données : tableau
    check.secure_params.active Marqueur indiquant si le paramètre sécurisé est actif.
    Valeurs valides :
    • true : le paramètre sécurisé est actif.
    • faux : le paramètre sécurisé est inactif.

    Type de données : booléennes
    check.secure_params.name Nom du paramètre sécurisé.

    Type de données : chaîne
    check.secure_params.commande Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre
    check.secure_params.sys_id Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_secure_param_def].

    Type de données : chaîne
    check.sys_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].

    Type de données : chaîne
    vérifier.délai d’expiration Délai en secondes.

    Type de données : nombre

    L’exemple suivant montre comment obtenir des informations pour une définition de vérification spécifiée.

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

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

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

    Sortie :

    {
  "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, Number limit, Boolean withParams)

    Obtient une liste de définitions de vérification avec des détails.

    Voir aussi Vérifications et stratégies.

    Tableau 3. Paramètres
    Nom Type Description
    encodedQuery Chaîne Chaîne de requête codée pour filtrer la liste des résultats de la définition de contrôle. Utilisez null pour obtenir une liste non filtrée des définitions de vérification dans le système.
    limite Numéro Limite le nombre d’enregistrements renvoyés. Définissez la valeur sur null pour utiliser la valeur par défaut.

    Par défaut : 20 000
    withParams Booléen Marqueur indiquant si les détails des paramètres de vérification existants sont renvoyés. Les informations relatives à chaque paramètre de contrôle standard et sécurisé sont incluses dans un objet JSON.
    Valeurs valides :
    • true : renvoie les détails des paramètres de vérification.
    • faux : ne renvoie pas les détails des paramètres de vérification.

    Valeur par défaut : false
    Tableau 4. Renvoie
    Propriétés Description
    Définitions des vérifications Liste des définitions et détails de vérification fournis en tant qu’objets 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
  }
]

    Type de données : tableau
    arrière-plan Marqueur indiquant si cette définition de vérification est une vérification d’antécédents. Une vérification des antécédents est une vérification que l’agent commence à exécuter sans attendre qu’elle se termine.
    Valeurs valides :
    • true : cette définition de vérification est une vérification d’arrière-plan.
    • false : cette définition de vérification n’est pas une vérification des antécédents.

    Type de données : booléennes
    check_group Groupe spécifié pour cette définition de vérification.

    Type de données : chaîne
    check_type Type de vérification.
    Valeurs possibles :
    • Événements : vérifiez que les résultats sont transformés en événement de gestion des événements.
    • Mesures : les valeurs du résultat de vérification sont transformées en mesures.

    Type de données : chaîne
    commande Commande exécutée Agent Client Collector .

    Type de données : chaîne
    nom Nom du chèque.

    Type de données : chaîne
    paramètres Liste des définitions de paramètres associées à la définition de vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Type de données : tableau
    params.active Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • true : le paramètre de vérification est actif.
    • false : le paramètre check est inactif.

    Type de données : booléennes
    params.default_value Spécifie la valeur par défaut de ce paramètre de vérification.

    Type de données : chaîne
    params.mandatory Marqueur indiquant si le paramètre de vérification est requis.
    Valeurs valides :
    • true : le paramètre check est requis.
    • false : le paramètre check est facultatif.

    Type de données : booléennes
    params.name Nom du paramètre de vérification.

    Type de données : chaîne
    params.sys_id Sys_id du paramètre de vérification répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_param_def].

    Type de données : chaîne
    modules d'extension Liste des Agent Client Collector modules d’extension associés à cette vérification.

    Type de données : tableau
    proxy_valid Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner en tant que proxy.
    Valeurs valides :
    • true : cette politique de définition de vérification est définie pour fonctionner en tant que proxy.
    • false : cette politique de définition de vérification n’est pas définie pour fonctionner en tant que proxy.

    Type de données : booléennes
    secure_params Liste des éléments affectés à ce chèque. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Type de données : tableau
    secure_params.active Marqueur indiquant si le paramètre sécurisé est actif.
    Valeurs valides :
    • true : le paramètre sécurisé est actif.
    • faux : le paramètre sécurisé est inactif.

    Type de données : booléennes
    secure_params.name Nom du paramètre sécurisé.

    Type de données : chaîne
    secure_params.commande Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre
    secure_params.sys_id Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_secure_param_def].

    Type de données : chaîne
    sys_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].

    Type de données : chaîne
    timeout Délai en secondes.

    Type de données : nombre

    L’exemple suivant montre comment récupérer une liste de deux définitions de vérification avec des valeurs de paramètres.

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

    Sortie :

    [
  {
    "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(String checkDefId, Object updateJson)

    Permet de changer une ou plusieurs valeurs de champ d’une définition de contrôle spécifiée.

    Voir aussi Vérifications et stratégies.

    Tableau 5. Paramètres
    Nom Type Description
    checkDefId (en anglais seulement) Chaîne Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].
    updateJson Objet Carte des champs de définition de vérification à mettre à jour vers leurs nouvelles valeurs. Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de vérification de définition.
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "name": "String",
 "plugins": [Array],
 "proxy_valid": Boolean,
 "timeout": Number
}
    updateJson.active Numéro Indique si cette définition de vérification est active.
    Valeurs valides :
    • 0 : cette définition de vérification est inactive.
    • 1 : cette définition de vérification est active.
    updateJson.background Booléen Marqueur indiquant si cette définition de vérification est une vérification d’antécédents. Une vérification des antécédents est une vérification que l’agent commence à exécuter sans attendre qu’elle se termine.
    Valeurs valides :
    • true : cette définition de vérification est une vérification d’arrière-plan.
    • false : cette définition de vérification n’est pas une vérification des antécédents.
    updateJson.check_group Chaîne Groupe spécifié pour cette définition de vérification.
    updateJson.check_type Chaîne Type de vérification.
    Valeurs possibles :
    • Événements : vérifiez que les résultats sont transformés en événement de gestion des événements.
    • Mesures : les valeurs du résultat de vérification sont transformées en mesures.
    updateJson.command Chaîne Commande exécutée Agent Client Collector .
    updateJson.name Chaîne Nom du chèque.
    updateJson.plugins Tableau Liste des Agent Client Collector modules d'extension associé à cette vérification.
    updateJson.proxy_valid Booléen

    Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner en tant que proxy.

    Valeurs valides :
    • true : cette politique de définition de vérification est définie pour fonctionner en tant que proxy.
    • false : cette politique de définition de vérification n’est pas définie pour fonctionner en tant que proxy.
    updateJson.timeout Numéro Délai en secondes.
    Tableau 6. Renvoie
    Type Description
    Aucun Message d’erreur en cas d’échec.

    L’exemple suivant montre comment désactiver une définition de vérification.

    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(String checkDefParamId, Object updateJson)

    Permet de modifier une ou plusieurs valeurs de champ d’un paramètre de vérification spécifié.

    Tableau 7. Paramètres
    Nom Type Description
    checkDefParamId (en anglais seulement) Chaîne Sys_id du paramètre de vérification répertorié dans la table Définitions des paramètres de vérification [sn_agent_check_param_def].
    updateJson Objet Carte des champs de paramètres de vérification à mettre à jour vers leurs nouvelles valeurs. Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de définition Check Secure Parameter.
    {
 "active": Boolean,
 "default_value": "String",
 "mandatory": Boolean,
 "name": "String"
}
    updateJson.active Booléen

    Marqueur indiquant si le paramètre de vérification est actif.

    Valeurs valides :
    • true : le paramètre de vérification est actif.
    • false : le paramètre check est inactif.
    updateJson.default_value Chaîne Spécifie la valeur par défaut de ce paramètre de vérification.
    updateJson.mandatory Booléen

    Marqueur indiquant si le paramètre de vérification est requis.

    Valeurs valides :
    • true : le paramètre check est requis.
    • false : le paramètre check est facultatif.
    updateJson.name Chaîne Nom du paramètre de vérification.
    Tableau 8. Renvoie
    Type Description
    Aucun Message d’erreur en cas d’échec.

    L’exemple suivant montre comment activer un paramètre de vérification.

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

    AccCheckDefsAPI : updateCheckSecureParam(String, checkDefSecureParamId, Object updateJson)

    Permet de changer une ou plusieurs valeurs de champ d’un paramètre de sécurité de vérification spécifié.

    Tableau 9. Paramètres
    Nom Type Description
    checkDefSecureParamId Chaîne Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_secure_param_def].
    updateJson Objet Carte des champs de paramètres de sécurité de vérification à mettre à jour vers leurs nouvelles valeurs. Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de définition Check Secure Parameter.
    {
 "active": Boolean,
 "name": "String",
 "order": Number
}
    updateJson.active Booléen

    Marqueur indiquant si le paramètre sécurisé est actif.

    Valeurs valides :
    • true : le paramètre sécurisé est actif.
    • faux : le paramètre sécurisé est inactif.
    updateJson.name Chaîne Nom du paramètre sécurisé.
    updateJson.order Numéro Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.
    Tableau 10. Renvoie
    Type Description
    Aucun Message d’erreur en cas d’échec.

    L’exemple suivant montre comment activer un paramètre de sécurité de contrôle.

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