CheckDefinitionTestBuilder : inclus dans le périmètre

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 4 minutes de lecture

    • Le script include CheckDefinitionTestBuilder permet de générer des demandes de vérification de test sur des définitions de vérification.

    Ce script include requiert l’application Agent Client Collector de stockage Framework (sn_agent) et est fourni dans l’espace de noms sn_agent . Pour plus d’informations, référez-vous à Agent Client Collector.

    Pour la solution d’API REST, reportez-vous à l’API Agent Client Collector.

    Cette API inclut des méthodes qui activent les éléments suivants :
    • Définir la définition de la vérification à tester
    • Définissez l’élément de configuration sur lequel exécuter le test
    Vous pouvez également spécifier l’un des identificateurs suivants à utiliser pendant le test :
    • Informations d’identification sys_id
    • ID de l’alias d’informations d’identification
    • Nom des informations d'identification

    CheckDefinitionTestBuilder : CheckDefinitionTestBuilder()

    Crée une instance CheckDefinitionTestBuilder.

    Tableau 1. Paramètres
    Nom Type Description
    Néant

    L’exemple suivant montre comment initialiser CheckDefinitionTestBuilder.

    var builder = new sn_agent.CheckDefinitionTestBuilder();

    CheckDefinitionTestBuilder - build()

    Construit la demande de vérification de test avec les arguments définis.

    Tableau 2. Paramètres
    Nom Type Description
    Aucun
    Tableau 3. Renvoie
    Propriétés Description
    Objet Objet JSON avec deux attributs : l’ID d’enregistrement du résultat du test et une erreur. Si la version réussit, l’ID de résultat du test est renvoyé et l’erreur est nulle. Si une erreur se produit pendant la génération, l’ID de résultat du test est nul et l’erreur s’affiche.

    L’exemple suivant montre comment créer une demande de vérification de test :

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();

var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();

if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder : withCheckId(String checkId)

    Définit la sys_id de la définition de vérification à tester.

    Tableau 4. Paramètres
    Nom Type Description
    ID de vérification 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].
    Tableau 5. Renvoie
    Type Description
    VérifierDefinitionTestBuilder Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une vérification de test.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder : withCiId(String ciId)

    Définit la sys_id de l’élément de configuration pour exécuter le test.

    Tableau 6. Paramètres
    Nom Type Description
    ciId Chaîne Sys_id d’un élément de configuration CMDB.
    Tableau 7. Renvoie
    Type Description
    VérifierDefinitionTestBuilder Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une demande de vérification de test avec

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder : withCredentialsAliasId(String credentialsAliasId)

    Définit l’alias d’informations d’identification que sys_id utiliser pendant le test.

    Remarque :
    L’exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tableau 8. Paramètres
    Nom Type Description
    informations d’identification AliasId Chaîne Sys_id d’un enregistrement d’informations d’identification.
    Tableau 9. Renvoie
    Type Description
    VérifierDefinitionTestBuilder Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une vérification de test et définir l’ID de l’alias d’informations d’identification.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credAlias = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder : withCredentialsAliasName(String credentialsAliasName)

    Définit le nom de l’alias d’informations d’identification à utiliser pendant le test. Si la valeur donnée correspond au nom de plusieurs enregistrements d’alias d’informations d’identification, l’un d’eux est choisi au hasard.

    Remarque :
    L’exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tableau 10. Paramètres
    Nom Type Description
    informations d’identificationAliasName Chaîne Nom d’un alias d’informations d’identification.
    Tableau 11. Renvoie
    Type Description
    VérifierDefinitionTestBuilder Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une vérification de test et définir le nom de l’alias d’informations d’identification.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credentialsAliasName = "credentialsAliasName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder : withCredentialsId(String credentialsId)

    Définit les sys_id d’informations d’identification à utiliser pendant le test.

    Remarque :
    L’exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tableau 12. Paramètres
    Nom Type Description
    ID d’informations d’identification Chaîne Sys_id d’un enregistrement d’informations d’identification.
    Tableau 13. Renvoie
    Type Description
    VérifierDefinitionTestBuilder Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une vérification de test et définir l’ID des informations d’identification.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credID = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder : withCredentialsName(String credentialsName)

    Définit le nom des informations d’identification à utiliser pendant le test. Si la valeur donnée est le nom de plusieurs enregistrements d’informations d’identification, l’un d’eux est choisi de manière aléatoire.

    Remarque :
    L’exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tableau 14. Paramètres
    Nom Type Description
    informations d’identificationName Chaîne Nom de l’enregistrement des informations d’identification.
    Tableau 15. Renvoie
    Type Description
    VérifierDefinitionTestBuilder Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une vérification de test et définir le nom des informations d’identification.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credname = "credentialsName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);