CheckInstanceTestBuilder – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 4 Minuten Lesedauer

    • Die CheckInstanceTestBuilder Die Skripteinbindung bietet Methoden, mit denen Testprüfungsanforderungen für Prüfinstanzen erstellt werden können.

    Diese Skripteinbindung erfordert Agent Client Collector Framework (sn_Agent) speichert die Anwendung und wird in bereitgestellt sn_Agent Namespace. Weitere Informationen finden Sie unter Agent Client Collector .

    Informationen zur REST API-Lösung finden Sie unter Agent Client Collector-API .

    Diese Skripteinbindung stellt Methoden bereit, die Folgendes ermöglichen:
    • Legen Sie die Prüfinstanz zum Testen fest
    • Legen Sie das Konfigurationselement fest, für das der Test ausgeführt werden soll
    Sie können auch einen der folgenden Bezeichner angeben, die während des Tests verwendet werden sollen:
    • Sys_ID der Anmeldeinformationen
    • Alias-ID für Anmeldeinformationen
    • Anmeldeinformationsname

    CheckInstanceTestBuilder – CheckInstanceTestBuilder()

    Erstellt eine CheckInstanceTestBuilder-Instanz.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie initialisieren CheckInstanceTestBuilder .

    var builder = new sn_agent.CheckInstanceTestBuilder();

    CheckInstanceTestBuilder – Build()

    Erstellt die Testprüfungsanforderung mit den festgelegten Argumenten.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 3. Rückgaben
    Eigenschaften Beschreibung
    Objekt JSON-Objekt mit zwei Attributen – der Testergebnisdatensatz-ID und einem Fehler. Wenn der Build erfolgreich ist, wird die Testergebnis-ID zurückgegeben, und der Fehler ist null. Wenn während des Builds ein Fehler auftritt, ist die Testergebnis-ID null, und der Fehler wird angezeigt.

    Das folgende Beispiel zeigt, wie eine Testprüfungsanforderung erstellt wird:

    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(Zeichenfolge checkId)

    Legt die sys_ID der zu testenden Prüfungsdefinition fest.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    CheckId Zeichenfolge SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie eine Testprüfung erstellt wird.

    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 (Zeichenfolge ciId)

    Legt die sys_ID des Konfigurationselements fest, für das der Test ausgeführt werden soll.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    ciId Zeichenfolge SYS_ID eines CMDB-Konfigurationselements.
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfungsanforderung mit erstellen

    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)

    Legt die sys_ID des Anmeldeinformationsalias fest, der während des Tests verwendet werden soll.

    Hinweis:
    Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.
    Tabelle : 8. Parameter
    Name Typ Beschreibung
    AnmeldeinformationsAliasId Zeichenfolge SYS_ID eines Datensatzes für Anmeldeinformationen-Alias.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und die Alias-ID für Anmeldeinformationen festlegen.

    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(String credentialsAliasName)

    Legt den Aliasnamen für Anmeldeinformationen fest, der während des Tests verwendet werden soll. Wenn der angegebene Wert mit dem Namen mehrerer Aliasse-Datensätze für Anmeldeinformationen übereinstimmt, wird einer davon zufällig ausgewählt.

    Hinweis:
    Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    AnmeldeinformationAliasName Zeichenfolge Name eines Anmeldeinformationsalias.
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und den Aliasnamen für Anmeldeinformationen festlegen.

    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(String credentialsId)

    Legt die sys_ID der Anmeldeinformationen fest, die während des Tests verwendet werden soll.

    Hinweis:
    Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.
    Tabelle : 12. Parameter
    Name Typ Beschreibung
    AnmeldeinformationenId Zeichenfolge SYS_ID eines Anmeldeinformationsdatensatzes.
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und die Anmeldeinformations-ID festlegen.

    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)

    Legt den Anmeldeinformationsnamen fest, der während des Tests verwendet werden soll. Wenn der angegebene Wert der Name mehrerer Anmeldeinformationsdatensätze ist, wird einer davon zufällig ausgewählt.

    Hinweis:
    Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.
    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Anmeldeinformationsname Zeichenfolge Name des Anmeldeinformationsdatensatzes.
    Tabelle : 15. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und den Anmeldeinformationsnamen festlegen.

    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)

    Legt den Service Desk-Mitarbeiter für die Ausführung des Tests fest. Nur zulässig, wenn die getestete Prüfungsinstanz und -Richtlinie ein Proxy sind.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    agentId Zeichenfolge Eindeutige ID eines Agent-Proxys zum Ausführen dieser Prüfung. Dieser Wert wird in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt.
    Tabelle : 17. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Generatorinstanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und die Proxy-Agent-ID festlegen.

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