CheckInstanceTestBuilder: Bereichsbezogen

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 4 Minuten Lesedauer

    • Die CheckInstanceTestBuilder -Skripteinbindung stellt Methoden bereit, die das Erstellen von Testprüfungsanforderungen für Prüfungsinstanzen ermöglichen.

    Diese Skripteinbindung erfordert die Store-Anwendung Framework Agent Client Collector (sn_agent) und wird im Namespace sn_agent bereitgestellt. 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 auf „Test“ fest
    • Legen Sie das Configuration Item fest, für das der Test ausgeführt werden soll
    Sie können auch einen der folgenden Bezeichner für den Test angeben:
    • 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 CheckInstanceTestBuilderinitialisiert wird.

    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. Ergebnisse
    Eigenschaften Beschreibung
    Objekt JSON-Objekt mit zwei Attributen – der Datensatz-ID des Testergebnisses 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 Testüberprü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(String checkId)

    Legt die sys_id der Prüfungsdefinition auf „test“ fest.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Prüf-ID 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 Builder-Instanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie einen Testcheck 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 - withCiId(String 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 Builder-Instanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie mit eine Testprüfungsanforderung 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 incidentalsAliasId)

    Legt die Anmeldeinformations-Alias-sys_id 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 durchgeführt wurden.
    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Anmeldeinformationsalias-ID Zeichenfolge Sys_id eines Alias-Datensatzes für Anmeldeinformationen
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Builder-Instanz, 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 incidentalsAliasName)

    Legt den Aliasnamen für Anmeldeinformationen fest, der während des Tests verwendet werden soll. Wenn der angegebene Wert mit dem Namen mehrerer Aliasse 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 durchgeführt wurden.
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    AnmeldeinformationenAliasName Zeichenfolge Name des Alias für Anmeldeinformationen
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Builder-Instanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und den Namen des Alias 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(Zeichenfolge-credentialsId)

    Legt die sys_id der Anmeldeinformationen fest, die während des Tests verwendet werden sollen.

    Hinweis:
    Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName durchgeführt wurden.
    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Anmeldeinformations-ID Zeichenfolge Sys_id eines Anmeldeinformationsdatensatzes.
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Builder-Instanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie einen Testcheck 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 incidentalname)

    Legt den Namen der Anmeldeinformationen fest, die während des Tests verwendet werden sollen. Wenn der angegebene Wert der Name mehrerer Datensätze mit Anmeldeinformationen 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 durchgeführt wurden.
    Tabelle : 14. Parameter
    Name Typ Beschreibung
    AnmeldeinformationenName Zeichenfolge Name des Anmeldeinformationsdatensatzes.
    Tabelle : 15. Ergebnisse
    Typ Beschreibung
    CheckInstanceTestBuilder Die Builder-Instanz, für die die Methode aufgerufen wurde.

    Das folgende Beispiel zeigt, wie Sie eine Testüberprüfung erstellen und den Namen der Anmeldeinformationen 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 Agent für die Ausführung des Tests fest. Nur zulässig, wenn die getestete Prüfinstanz und Richtlinie ein Proxy sind.

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

    Das folgende Beispiel zeigt, wie Sie eine Testüberprü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);