CheckInstanceTestBuilder – Scoped

Die CheckInstanceTestBuilder -Skripteinbindung ermöglicht die Erstellung von Testprüfungsanforderungen für Prüfungsinstanzen.

Diese Skripteinbindung erfordert die Store-Anwendung Agent Client Collector Framework (sn_agent) und wird im sn_agent- Namespace bereitgestellt. Weitere Informationen finden Sie unter Agent Client Collector.

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

Diese API enthält Methoden, die Folgendes ermöglichen:

• Legen Sie die Prüfungsinstanz auf Test 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 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 Testergebnis-Datensatz-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 Sie 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 – withCheckId(String checkId)

Legt die sys_id der Prüfungsdefinition auf Test 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 Sie eine Testüberprüfung 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 Generatorinstanz, für die die Methode aufgerufen wurde.

Das folgende Beispiel zeigt, wie eine Testprüfungsanforderung mit 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 – withCredentialsAliasId(String credentialsAliasId)

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

Hinweis:

Dadurch werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.

Tabelle : 8. Parameter

Name	Typ	Beschreibung
AnmeldeinformationenAliasId	Zeichenfolge	Sys_id eines Anmeldeinformationsalias-Datensatzes.

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:

Dadurch werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.

Tabelle : 10. Parameter

Name	Typ	Beschreibung
credentialsAliasName	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:

Dadurch werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.

Tabelle : 12. Parameter

Name	Typ	Beschreibung
credentialsId	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 Testüberprü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 zufällig ausgewählt.

Hinweis:

Dadurch werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName vorgenommen wurden.

Tabelle : 14. Parameter

Name	Typ	Beschreibung
AnmeldeinformationenName	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 Agent fest, um den Test auszuführen. Nur zulässig, wenn die getestete Prüfungsinstanz und die Richtlinie 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);