---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# AgentNow-Handler -- Umfang

# AgentNow-Handler -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die AgentNow-Handler 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 CollectorFramework (sn_Agent) Store-Anwendung und wird in bereitgestellt `sn_Agent `Namespace. Weitere Informationen finden Sie unter [Agent-Clientsammler](https://www.servicenow.com/docs/access?context=acc-landing-page&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).

Informationen zur REST-API-Lösung finden Sie unter [Agent-Clientsammler-API](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-api "Die Agent-Clientsammler Die API stellt Endpunkte zur Verwaltung von Aktionen für verfügbare Agenten und zur Verwaltung von Richtlinien bereit.").

## AgentNowHandler -- AgentNowHandler() {#ariaid-title2}

Erstellt eine AgentNowHandler-Instanz.
{#AgentNowHnl-AgentNowHandler__table_ohr_4qd_bpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#AgentNowHnl-AgentNowHandler__table_ohr_4qd_bpb}  
Das folgende Beispiel zeigt, wie initialisiert wird AgentNow-Handler .

    var handler = new sn_agent.AgentNowHandler();

## AgentNow Handler -- getRequestStatus(Zeichenfolge requestId) {#ariaid-title3}

Ruft den Status der Anforderung mit der angegebenen ID ab.
{#AgentNowHnl-getRequestStatus_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| requestId | Zeichenfolge | Eine Prüfanforderungs-ID, die durch Aufrufen von generiert wurde Ausführen von PrüfForCis() Methode. |
[Tabelle : 2. Parameter]

{#AgentNowHnl-getRequestStatus_S__table_zk2_2g2_z4b} {#AgentNowHnl-getRequestStatus_S__table_al2_2g2_z4b__entry__2}

| Eigenschaften | Beschreibung |
|-|-|
| Objekt | Status der Anforderung und jede zutreffende Fehlermeldung. |
| Status | Anforderungsstatus. Mögliche Werte: * Fertig: Prüfung ist erfolgreich. * Fehler: Prüfung ist fehlgeschlagen. Details finden Sie in der Fehlermeldung. * Mid_Flow: Anforderungsausgabe wird vom MID-Server verarbeitet. * Verarbeitung: Prüfung wird ausgeführt. * Zeitüberschreitung: Überprüfen Sie, ob die Verarbeitung die in festgelegte Zeitgrenze überschritten hat Ausführen von PrüfForCis() Methode. {#AgentNowHnl-getRequestStatus_S__ul_edm_1rr_5qb} 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. {#AgentNowHnl-getRequestStatus_S__ul_qcf_zcq_5qb} Datentyp: Zeichenfolge |
[Tabelle : 3. Rückgaben]

{#AgentNowHnl-getRequestStatus_S__table_al2_2g2_z4b}  
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) {#ariaid-title4}

Ruft den Testprüfungsstatus des angegebenen Testergebnisses ab.
{#AgentNowHnl-getTestResultStatus_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| TestResultId | Zeichenfolge | Eine Testergebnis-ID, die durch Erstellen einer Testprüfungsanforderung generiert wurde. |
[Tabelle : 4. Parameter]

{#AgentNowHnl-getTestResultStatus_S__table_zk2_2g2_z4b} {#AgentNowHnl-getTestResultStatus_S__table_al2_2g2_z4b__entry__2}

| Eigenschaften | Beschreibung |
|-|-|
| Status | Status der Testergebnisse. Mögliche Werte: * 0: Ausstehend * 1: In Bearbeitung * 2: Abgeschlossen * 3: Kein Testergebnis mit angegebener ID {#AgentNowHnl-getTestResultStatus_S__ul_yyq_4bq_5qb} Datentyp: Zeichenfolge |
| Ausgabe | Ausgabe, die den Status beschreibt. Datentyp: Zeichenfolge |
[Tabelle : 5. Rückgaben]

{#AgentNowHnl-getTestResultStatus_S__table_al2_2g2_z4b}  
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) {#ariaid-title5}

Führt eine Prüfung für das angegebene Konfigurationselement aus.
{#AgentNowHnl-runCheckForCis_O_O_N_N__table_zk2_2g2_z4b__entry__3}{#AgentNowHnl-runCheckForCis_O_O_N_N__agntNowHlr-parm-ph-chkparms}

| Name | Typ | Beschreibung |
|-|-|-|
| CIs | [GlideRecord](https://servicenow-prod.fluidtopics.net/pr75jggqt1vPfwd6tbA7gQ#c_GlideRecordScopedAPI "Der Umfang ist festgelegt GlideRecord API wird für Datenbankvorgänge verwendet.") | GlideRecord einer beliebigen CMDB-Tabelle (beliebige Anwendungen, Hosts oder Agenten), 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.Parameters | 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" } {#AgentNowHnl-runCheckForCis_O_O_N_N__agntNowHlr-parm-cd-chkparms} |
| Priorität | Nummer | Priorität der Anforderung, die in der ECC-Warteschlange festgelegt werden soll. Mögliche Werte: * 0: Interaktiv * 1: Beschleunigt * 2: Standard {#AgentNowHnl-runCheckForCis_O_O_N_N__ul_bkf_hnq_wqb} |
| Zeitüberschreitung | Nummer | Wert der Zeitüberschreitung für die Anforderung in Sekunden. |
[Tabelle : 6. Parameter]

{#AgentNowHnl-runCheckForCis_O_O_N_N__table_zk2_2g2_z4b} {#AgentNowHnl-runCheckForCis_O_O_N_N__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | SYS_ID der generierten Hintergrundprüfungsanforderung. |
[Tabelle : 7. Rückgaben]

{#AgentNowHnl-runCheckForCis_O_O_N_N__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Hintergrundprüfung ausgeführt und die zugehörige 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

## AgentNow Handler -- stopBackgroundCheck(Zeichenfolge requestId) {#ariaid-title6}

Stoppt eine Hintergrundprüfung.
Verwenden Sie zum Starten einer Hintergrundprüfung Ausführen von PrüfForCis() Methode.
{#AgentNowHnl-stopBackgroundCheck_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| requestId | Zeichenfolge | Die ID einer Hintergrundprüfungsanforderung, die durch Aufrufen von generiert wurde Ausführen von PrüfForCis() Methode. |
[Tabelle : 8. Parameter]

{#AgentNowHnl-stopBackgroundCheck_S__table_zk2_2g2_z4b} {#AgentNowHnl-stopBackgroundCheck_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Rückgaben]

{#AgentNowHnl-stopBackgroundCheck_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie die Ausführung einer Hintergrundprüfung gestoppt wird.

    handler.stopBackgroundCheck(backRequestId);


