AgentNowHandler – Scoped

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 2 Minuten Lesedauer

    • Die AgentNowHandler-Skripteinbindung ermöglicht die Ausführung von Prüfungsdefinitionen bei Bedarf, die Überprüfung des Status von Ausführungen bei Bedarf und Testprüfungsausführungen und das Stoppen von Hintergrundprüfungen, die bei Bedarf ausgeführt wurden.

    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.

    AgentNowHandler – AgentNowHandler()

    Erstellt eine AgentNowHandler-Instanz.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie AgentNowHandlerinitialisiert wird.

    var handler = new sn_agent.AgentNowHandler();

    AgentNowHandler – getRequestStatus(String requestId)

    Ruft den Status der Anforderung mit der angegebenen ID ab.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    requestId Zeichenfolge Eine Prüfungsanforderungs-ID, die durch Aufrufen der runCheckForCis()- Methode generiert wird.
    Tabelle : 3. Ergebnisse
    Eigenschaften Beschreibung
    Objekt Status der Anforderung und alle zutreffenden Fehlermeldungen.
    status Anforderungsstatus.
    Mögliche Werte:
    • fertig – Prüfung ist erfolgreich.
    • failure – Prüfung ist fehlgeschlagen. Weitere Informationen finden Sie in der Fehlermeldung.
    • mid_flow – Anforderungsausgabe wird vom MID-Server verarbeitet.
    • wird verarbeitet – Prüfung wird ausgeführt.
    • Zeitüberschreitung – Scheckverarbeitung hat das in der runCheckForCis()- Methode festgelegte Zeitlimit überschritten.

    Datentyp: Zeichenfolge
    err_msg Fehlermeldung, falls vorhanden.
    Mögliche Werte:
    • Keine Agents für relevante CIs gefunden.
    • Keine Anforderung zur Hintergrundprüfung mit der angegebenen ID.
    • Keine Anforderung mit der angegebenen ID.
    • Kein Testergebnis mit angegebener ID.
    • Anforderungszeitüberschreitung.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie der Status einer Anforderung abgerufen wird.

    var handler = new sn_agent.AgentNowHandler();
var check = {checkDefId: "158279505372b30034b8ddeeff7b1270"};
var computerGr = new GlideRecord("cmdb_ci_computer");
computerGr.query();
var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

var reqStatusJson = handler.getRequestStatus(requestId);
gs.info(JSON.stringify(reqStatusJson));

    AgentNowHandler – getTestResultStatus(String testResultId)

    Ruft den Testprüfungsstatus des angegebenen Testergebnisses ab.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    testResultId Zeichenfolge Eine Testergebnis-ID, die durch Erstellen einer Testüberprüfungsanforderung generiert wird.
    Tabelle : 5. Ergebnisse
    Eigenschaften Beschreibung
    status Status der Testergebnisse.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: In Bearbeitung
    • 2: Abgeschlossen
    • 3: Kein Testergebnis mit angegebener ID

    Datentyp: Zeichenfolge
    Ausgabe Ausgabe, die den Status beschreibt.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie der Ergebnisstatus einer abgeschlossenen Testprüfungsanforderung abgerufen wird.

    var testCheckStatusJson = handler.getTestResultStatus("testResultId");
gs.info(JSON.stringify(testCheckStatusJson));

    AgentNowHandler – runCheckForCis(Object cis, Object check, Number priority, Number timeout)

    Führt eine Prüfung für das angegebene Konfigurationselement durch.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    CIs GlideRecord GlideRecord einer CMDB-Tabelle (Anwendung, Host oder Agent), für die die Prüfung ausgeführt wird.
    überprüfen Objekt Enthält die Prüfungs-ID und optionale Prüfungsparameter. 
    {
  "checkDefId": "String",
  "params": Object
}
    check.checkDefId Zeichenfolge Sys_id einer Prüfungsdefinition in der Tabelle „Prüfungsdefinitionen“ [sn_agent_check_def].
    check.params Objekt Optional. Zuordnung der Parameternamen und -werte. Diese Einstellungen können verwendet werden, um die Parameterdatensätze der Prüfungsdefinition und ihre angegebenen Werte zu überschreiben. 
    "params": {
  "<parameter name>": "String"
}
    Priorität Nummer Priorität der Anforderung, die in der ECC-Warteschlange festgelegt werden soll.
    Mögliche Werte:
    • 0: interaktiv
    • 1: beschleunigt
    • 2: Standard
    Zeitüberschreitung Nummer Wert der Zeitüberschreitung für die Anforderung in Sekunden.
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Sys_id der generierten Anforderung zur Hintergrundprüfung.

    Das folgende Beispiel zeigt, wie eine Hintergrundprüfung ausgeführt wird und die Anforderungs-ID abgerufen wird.

    var handler = new sn_agent.AgentNowHandler();
var check = {checkDefId: "028fcd5067c80010b7b72dbd2685ef4f"};
var computerGr = new GlideRecord("cmdb_ci_computer");
computerGr.query();
var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

gs.info(requestId);

    Ausgabe:

    b9cf14aedb5e30106f4810284b961990

    AgentNowHandler – stopBackgroundCheck(String requestId)

    Stoppt eine Hintergrundprüfung.

    Um eine Hintergrundprüfung zu starten, verwenden Sie die Methode runCheckForCis().

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    requestId Zeichenfolge Die ID einer Hintergrundüberprüfungsanforderung, die durch Aufrufen der runCheckForCis()- Methode generiert wird.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie die Ausführung einer Hintergrundprüfung anhalten.

    handler.stopBackgroundCheck(backRequestId);