AgentNowHandler – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer
  • Die AgentNowHandler Die Skripteinbindung stellt Methoden bereit, die 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 ermöglichen, die bei Bedarf ausgeführt wurden.

    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 .

    AgentNowHandler: AgentNowHandler()

    Erstellt eine AgentNowHandler-Instanz.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie initialisieren AgentNowHandler .

    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 Prüfanforderungs-ID, die durch Aufrufen von generiert wurde Ausführen von CheckForCis() Methode.
    Tabelle : 3. Rückgaben
    Eigenschaften Beschreibung
    Objekt Status der Anforderung und alle zutreffenden Fehlermeldungen.
    status Anforderungsstatus.
    Mögliche Werte:
    • Abgeschlossen: Prüfung ist erfolgreich.
    • Fehler: Prüfung ist fehlgeschlagen. Weitere Informationen finden Sie in der Fehlermeldung.
    • Mid_Flow: Die Anforderungsausgabe wird vom MID-Server verarbeitet.
    • Verarbeitung: Prüfung wird ausgeführt.
    • Zeitüberschreitung: Überprüfung, ob die in festgelegte Zeitgrenze für die Verarbeitung überschritten wurde Ausführen von CheckForCis() Methode.

    Datentyp: Zeichenfolge

    err_msg Fehlermeldung, falls vorhanden.
    Mögliche Werte:
    • Keine Service Desk-Mitarbeiter für relevante CIs gefunden.
    • Keine Hintergrundprüfungsanforderung mit angegebener ID.
    • Keine Anforderung mit angegebener ID.
    • Kein Testergebnis mit angegebener ID.
    • Zeitüberschreitung bei Anforderung.

    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(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 Testprüfungsanforderung generiert wurde.
    Tabelle : 5. Rückgaben
    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(Objekt-cis, Objektprüfung, Zahlenpriorität, Zahlenzeitüberschreitung)

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

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    cis GlideRecord GlideRecord einer beliebigen CMDB-Tabelle (beliebige Anwendungen, Hosts oder Agent), für die die Prüfung funktioniert.
    Überprüfen Objekt ID und optionale Prüfparameter überprüfen.
    "check": {
      "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 ihre angegebenen Werte zu überschreiben.
    "params": {
      "<parameter name>": "String"
    }
    Priorität Anzahl Priorität der Anforderung, die in der ECC-Warteschlange festgelegt werden soll.
    Mögliche Werte:
    • 0: Interaktiv
    • 1: Beschleunigt
    • 2: Standard
    Zeitüberschreitung Anzahl Wert der Zeitüberschreitung für die Anforderung in Sekunden.
    Tabelle : 7. Rückgaben
    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 Ausführen von CheckForCis() Methode.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    requestId Zeichenfolge Die ID einer Hintergrundprüfungsanforderung, die durch Aufruf von generiert wurde Ausführen von CheckForCis() Methode.
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie die Ausführung einer Hintergrundprüfung gestoppt wird.

    handler.stopBackgroundCheck(backRequestId);