CheckInstanceTestBuilder : inclus dans le champ d’application

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

    • L’include de script CheckInstanceTestBuilder fournit des méthodes qui permettent de générer des demandes de vérification de test sur des instances de vérification.

    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.

    Cet include de script fournit des méthodes qui activent les éléments suivants :
    • Définir l’instance de vérification à tester
    • Définir 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

    CheckInstanceTestBuilder : CheckInstanceTestBuilder()

    Crée une instance CheckInstanceTestBuilder.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun

    L’exemple suivant montre comment initialiser CheckInstanceTestBuilder.

    var builder = new sn_agent.CheckInstanceTestBuilder();

    CheckInstanceTestBuilder : build()

    Génère la demande de contrôle 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 générer une demande de vérification de test :

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

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

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

    CheckInstanceTestBuilder : withCheckId(String checkId)

    Définit la sys_id de la définition de contrôle à tester.

    Tableau 4. Paramètres
    Nom Type Description
    checkId (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].
    Tableau 5. Renvoie
    Type Description
    CheckInstanceTestBuilder (en anglais seulement) 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.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckInstanceTestBuilder : withCiId(String ciId)

    Définit le sys_id de l’élément de configuration par rapport auquel 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
    CheckInstanceTestBuilder (en anglais seulement) Instance du générateur pour laquelle la méthode a été invoquée.

    L’exemple suivant montre comment créer une demande de contrôle de test avec

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

    CheckInstanceTestBuilder : withCredentialsAliasId(String credentialsAliasId)

    Définit l’alias d’informations d’identification 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
    ID d’alias des informations d’identification Chaîne Sys_id d’un enregistrement d’alias d’informations d’identification.
    Tableau 9. Renvoie
    Type Description
    CheckInstanceTestBuilder (en anglais seulement) 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.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckInstanceTestBuilder : withCredentialsAliasName(chaîne, informations d’identificationAliasName)

    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
    CheckInstanceTestBuilder (en anglais seulement) 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.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckInstanceTestBuilder : withCredentialsId (chaîne, 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
    CheckInstanceTestBuilder (en anglais seulement) 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.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckInstanceTestBuilder : 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 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 14. Paramètres
    Nom Type Description
    nom des informations d’identification Chaîne Nom de l’enregistrement des informations d’identification.
    Tableau 15. Renvoie
    Type Description
    CheckInstanceTestBuilder (en anglais seulement) 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.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckInstanceTestBuilder : withProxyAgentId(String agentId)

    Définit l’agent pour exécuter le test. Autorisé uniquement dans le cas où l’instance et la politique de vérification testées sont proxy.

    Tableau 16. Paramètres
    Nom Type Description
    ID de l’agent Chaîne ID unique d’un proxy d’agent pour exécuter cette vérification. Cette valeur est répertoriée dans la colonne ID d’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].
    Tableau 17. Renvoie
    Type Description
    CheckInstanceTestBuilder (en anglais seulement) 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’agent proxy.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var agentId = "<agentID>";
var builder = new sn_agent.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withAgentId(agentId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);