AgentNowHandler: Bereichsbezogen

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

    • Die AgentNowHandler-Skripteinbindung stellt Methoden bereit, die das Ausführen von Prüfungsdefinitionen bei Bedarf, das Überprüfen des Status von Ausführungen bei Bedarf und von Testprüfungen sowie das Stoppen von Hintergrundprüfungen ermöglichen, die bei Bedarf ausgeführt wurden.

    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.

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

    Ruft den Status der Anforderung mit der angegebenen ID ab.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    requestId Zeichenfolge Eine Scheckanforderungs-ID, die durch Aufrufen der runCheckForCis()- Methode generiert wird.
    Tabelle : 3. Ergebnisse
    Eigenschaften Beschreibung
    Objekt Status der Anforderung und zugehörige Fehlermeldung.
    status Anforderungsstatus.
    Mögliche Werte:
    • done – Prüfung war erfolgreich.
    • Fehler: Die Prüfung ist fehlgeschlagen. Details finden Sie in der Fehlermeldung.
    • mid_flow: Die Anforderungsausgabe wird vom MID-Server verarbeitet.
    • Verarbeitung – Prüfung wird ausgeführt.
    • Zeitüberschreitung: Die 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 angegebener ID.
    • Keine Anforderung mit angegebener ID.
    • Kein Testergebnis mit angegebener ID.
    • Zeitüberschreitung für Anforderung.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie den Status einer Anforderung abrufen.

    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(Zeichenfolge 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 Sie den Ergebnisstatus einer abgeschlossenen Testüberprüfungsanforderung abrufen.

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

    AgentNowHandler – runCheckForCis(Objekt-CIs, Objektprüfung, Nummernpriorität, Nummern-Timeout)

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

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    cis GlideRecord GlideRecord einer beliebigen CMDB-Tabelle (beliebige Anwendung, Host oder Agent), für die die Prüfung ausgeführt wird.
    Scheck Objekt Scheck-ID und optionale Prüfparameter. 
    {
  "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 von Parameternamen und -werten. Diese Einstellungen können verwendet werden, um die Parameterdatensätze der Prüfungsdefinition und die 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 Hintergrundprüfungsanforderung.

    Das folgende Beispiel zeigt, wie Sie eine Hintergrundprüfung ausführen und ihre Anforderungs-ID abrufen.

    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 (Zeichenfolge – requestId)

    Stoppt eine Hintergrundprüfung.

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

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

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

    handler.stopBackgroundCheck(backRequestId);