AgentNowHandler - Dans le champ d’application

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

    • L’include de script AgentNowHandler fournit des méthodes qui permettent d’exécuter des définitions de vérification sur demande, de vérifier l’état des exécutions sur demande et des exécutions de vérification de test, et d’arrêter les vérifications d’arrière-plan qui ont été exécutées sur demande.

    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 . Pour plus d’informations, consultez Agent Client Collector.

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

    AgentNowHandler : AgentNowHandler()

    Crée une instance AgentNowHandler.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun

    L’exemple suivant montre comment initialiser AgentNowHandler.

    var handler = new sn_agent.AgentNowHandler();

    AgentNowHandler : getRequestStatus(String requestId)

    Obtient l’état de la demande avec l’ID donné.

    Tableau 2. Paramètres
    Nom Type Description
    requestId Chaîne ID de demande de vérification généré par l’appel de la méthode runCheckForCis().
    Tableau 3. Renvoie
    Propriétés Description
    Objet État de la demande et tout message d’erreur applicable.
    statut État de la demande.
    Valeurs possibles :
    • Terminé : la vérification a réussi.
    • échec : la vérification a échoué. Voir le message d’erreur pour plus de détails.
    • mid_flow : la sortie de la demande est gérée par le MID Server.
    • Traitement : la vérification est en cours.
    • timeout : vérifiez que le traitement a dépassé la limite de temps définie dans la méthode runCheckForCis().

    Type de données : chaîne
    err_msg Message d’erreur le cas échéant.
    Valeurs possibles :
    • Aucun agent trouvé pour les CI appropriés.
    • Aucune demande de vérification des antécédents avec l’ID fourni.
    • Aucune demande avec l’ID fourni.
    • Aucun résultat de test avec l’ID fourni.
    • Délai d’expiration de la demande.

    Type de données : chaîne

    L’exemple suivant montre comment obtenir l’état d’une demande.

    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)

    Obtient l’état de vérification du test du résultat du test donné.

    Tableau 4. Paramètres
    Nom Type Description
    testResultId (en anglais seulement) Chaîne ID de résultat de test généré par la création d’une demande de contrôle de test.
    Tableau 5. Renvoie
    Propriétés Description
    statut État des résultats des tests.
    Valeurs possibles :
    • 0 : en attente
    • 1 : En cours
    • 2 : Terminé
    • 3 : Aucun résultat de test avec l’ID fourni

    Type de données : chaîne
    sortie Sortie décrivant l’état.

    Type de données : chaîne

    L’exemple suivant montre comment obtenir l’état du résultat d’une demande de vérification de test terminée.

    var testCheckStatusJson = handler.getTestResultStatus("testResultId");
gs.info(JSON.stringify(testCheckStatusJson));

    AgentNowHandler : runCheckForCis(CI d’objet, vérification de l’objet, priorité du numéro, délai d’expiration du numéro)

    Exécute une vérification par rapport à l’élément de configuration donné.

    Tableau 6. Paramètres
    Nom Type Description
    CI GlideRecord GlideRecord de n’importe quelle table CMDB (n’importe quelle application, hôte ou agent) sur laquelle la vérification travaille.
    vérifier Objet ID de vérification et paramètres de vérification facultatifs. 
    {
  "checkDefId": "String",
  "params": {Object}
}
    check.checkDefId Chaîne Sys_id d’une définition de vérification dans la table Définitions de vérification [sn_agent_check_def].
    paramètres.vérification Objet Facultatif. Carte des noms et des valeurs des paramètres. Ces paramètres peuvent être utilisés pour remplacer les enregistrements de paramètres de la définition de contrôle et ses valeurs spécifiées. 
    "params": {
  "<parameter name>": "String"
}
    Priorité Numéro Priorité de la demande à définir sur la file d’attente ECC.
    Valeurs possibles :
    • 0 : interactif
    • 1 : Accéléré
    • 2 : standard
    timeout Numéro Valeur du délai d’expiration de la demande, en secondes.
    Tableau 7. Renvoie
    Type Description
    Chaîne Sys_id de la demande de vérification des antécédents générée.

    L’exemple suivant montre comment exécuter une vérification des antécédents et obtenir son ID de demande.

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

    Sortie :

    b9cf14aedb5e30106f4810284b961990

    AgentNowHandler : stopBackgroundCheck(String requestId)

    Arrête une vérification des antécédents.

    Pour lancer une vérification des antécédents, utilisez la méthode runCheckForCis().

    Tableau 8. Paramètres
    Nom Type Description
    requestId Chaîne ID d’une demande de vérification des antécédents générée par l’appel de la méthode runCheckForCis().
    Tableau 9. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment arrêter l’exécution d’une vérification des antécédents.

    handler.stopBackgroundCheck(backRequestId);