Agent Client Collector-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 61 Minuten Lesedauer

    • Die Agent Client Collector Die API stellt Endpunkte zur Verwaltung von Aktionen für verfügbare Agents und zur Verwaltung von Richtlinien bereit.

    Diese API erfordert Agent Client Collector Framework (sn_Agent) speichert die Anwendung und wird in bereitgestellt sn_Agent Namespace. Die Endpunkte in dieser API erfordern die Rolle Agent_Client_Collector_admin. Weitere Informationen finden Sie unter Agent Client Collector .
    Agent-Management-Endpunkte

    Informationen zum Ausführen ähnlicher Aufgaben in einer Skripteinbindung finden Sie unter AccAgentsAPI .

    Richtlinienverwaltung und Workflow
    Verwenden Sie Richtlinien-Management-APIs, um Details anzuzeigen, eine Richtlinie zu aktivieren/deaktivieren, eine Richtlinie zu aktualisieren und eine Richtlinie zu veröffentlichen.
    So aktualisieren Sie eine Richtlinie:
    1. Ruft eine Liste von Richtlinien und Details mit ab RUFEN SIE /Agents/policies/list AB . Dieser Endpunkt erfordert die Rolle Agent_Client_Collector_user.
      • Um eine Richtlinie im Status Entwurf zu aktualisieren, verwenden Sie die sys_IDs, die aus der Richtlinienliste in den Update-Endpunkten abgerufen wurden.
      • Um eine Richtlinie im Status veröffentlicht oder veröffentlicht* zu aktualisieren, rufen Sie eine bearbeitbare Sandbox-Kopie mit ab RUFEN SIE /Agents/Policy/Sandbox_from_published/{Policy_ID} AB . Verwenden Sie die sys_IDs aus dieser Antwort, um Eigenschaften mit einem Update-Endpunkt zu ändern.
    2. Ändern Sie Richtliniendetails mithilfe eines Update-Endpunkts.
    3. Veröffentlichen Sie die Richtlinie mit RUFEN SIE /Agents/Policy/published/{Policy_ID} AB .
    Nach der Veröffentlichung wird die Richtlinie aktiv. Diese API enthält auch Endpunkte zum Aktivieren oder Deaktivieren einer veröffentlichten Richtlinie:

    Agent Client Collector – RUFT /Agents/{Agent_ID} AB

    Ruft die Informationen eines angegebenen Service Desk-Mitarbeiters ab.

    URL-Format

    /api/sn_Agent/Agents/{Agent_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Service Desk-Mitarbeiters, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt ist.

    Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_user“.
    404 Agent mit angegebener ID nicht gefunden.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    <Array> Array von JSON-Objekten mit erweiterten Agent-Informationen.
    {
   "agent_id": "String",
   "data_collection": Number,
   "ip_address": "String",
   "is_duplicate": Boolean,
   "is_restart_enabled": Boolean,
   "name": "String",
   "number_of_running_checks": Number,
   "status": Number,
   "up_since": "String",
   "version": "String"
}
    agent_id ID des Service Desk-Mitarbeiters wie übermittelt.

    Datentyp: Zeichenfolge
    Data_Collection Die Datensammlung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Service Desk-Mitarbeiter ausgeführt werden sollen.
    Mögliche Werte:
    • 0: Ein: Prüfungen werden wie geplant ausgeführt.
    • 1: Aus (manuell): Prüfungen wurden manuell deaktiviert.
    • 2: Aus (automatisch): Prüfungen wurden aufgrund eines hohen CPU-Verbrauchs durch automatisch deaktiviert

    Datentyp: Zahl
    ip_address Service Desk-Mitarbeiter-IP-Adresse.

    Datentyp: Zeichenfolge
    Ist_Duplikat

    Kennzeichnung, die angibt, ob dieser Service Desk-Mitarbeiter ein Duplikat eines anderen ist. Auf einem bestimmten Host darf nur ein einzelner Agent vorhanden sein.

    Mögliche Werte:
    • Wahr: Der Agent hat denselben Host wie ein aktiver/aktiver Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat
    • Falsch: Dieser Agent hat keine Duplikate im Status „aktiv“/„aktiv“.

    Datentyp: Boolesch
    Ist_restart_enabled

    Kennzeichnung, die angibt, ob der Neustart aktiviert ist. Neustart des Service Desk-Mitarbeiters ist nicht konfigurierbar. Dies hängt vom Betriebssystem und der Version des Betriebssystems ab, auf dem der Agent ausgeführt wird.

    Mögliche Werte:
    • Wahr: Neustart ist für diesen Agent aktiviert.
    • Falsch: Neustart ist für diesen Agent deaktiviert.

    Datentyp: Boolesch
    name Der Name des Außendienstmitarbeiters.

    Datentyp: Zeichenfolge
    Number_of_running_Checks Die Anzahl der Prüfungen, die der Service Desk-Mitarbeiter ausführen soll. Diese Prüfungen sind Teil der Richtlinien, die für diesen Service Desk-Mitarbeiter ausgeführt werden sollen.

    Datentyp: Zahl
    status Status des Service Desk-Mitarbeiters.
    Mögliche Werte:
    • 0: Aktiv/aktiv: Der Service Desk-Mitarbeiter ist aktiv.
    • 1: Warnung: Der Service Desk-Mitarbeiter hat in den letzten Minuten keine Keep-Alive-Nachricht erhalten.
    • 2: Ausgefallen: Der Service Desk-Mitarbeiter hat seit langer Zeit keine Keep-Alive-Nachricht erhalten.
    • 3: Wird neu gestartet: Der Service Desk-Mitarbeiter wird neu gestartet.

    Datentyp: Zahl
    Up_since UTC-Zeit, seit der Status des Service Desk-Mitarbeiters „aktiv“/„aktiv“ wurde. Der Wert ist in GlideDateTime Format.

    Datentyp: Zeichenfolge
    Version Version von Agent Client Collector Der Service Desk-Mitarbeiter wird ausgeführt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Agent-Details abgerufen werden.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "name": "WIN-V26KAP7PI2G",
  "status": 2,
  "agent_id": "074b14e2eb3ce9d4",
  "ip_address": "10.196.55.14",
  "number_of_running_checks": 11,
  "data_collection": 0,
  "is_restart_enabled": true,
  "is_duplicate": false,
  "up_since": "2021-03-31 12:02:17",
  "version": "2.3.0"
}

    Agent Client Collector – /Agents/{Agent_ID}/Data/off ABRUFEN

    Deaktiviert die Datensammlung für einen angegebenen Service Desk-Mitarbeiter im Status „aktiv“.

    Um festzustellen, ob die Datensammlung eines Service Desk-Mitarbeiters aktiviert oder deaktiviert ist, führen Sie aus RUFEN SIE /Agents/{Agent_ID} AB Endpunkt.

    URL-Format

    /api/sn_Agent/Agents/{Agent_ID}/Data/off

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Service Desk-Mitarbeiters, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt ist.

    Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Agent wurde nicht gefunden oder befindet sich nicht im Status „aktiv“/„aktiv“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Datensammlung für Service Desk-Mitarbeiter deaktiviert wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/off" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
"message": "Data Collection Disabled For Agent With ID: <agent_id>"
}

    Agent Client Collector – RUFT /Agents/{Agent_ID}/Data/on ab

    Aktiviert die Datensammlung für einen angegebenen Service Desk-Mitarbeiter im Status „aktiv“/„aktiv“.

    Um festzustellen, ob die Datensammlung eines Service Desk-Mitarbeiters aktiviert oder deaktiviert ist, führen Sie aus RUFEN SIE /Agents/{Agent_ID} AB Endpunkt.

    URL-Format

    /api/sn_Agent/Agents/{Agent_ID}/Data/on

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Service Desk-Mitarbeiters, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt ist.

    Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Agent wurde nicht gefunden oder befindet sich nicht im Status „aktiv“/„aktiv“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Datensammlung für Service Desk-Mitarbeiter aktiviert wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/on" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Data Collection Enabled For Agent With ID: <agent_id>"
}

    Agent Client Collector – RUFT /Agents/{Agent_ID}/Discovery AB

    Führt eine Discovery-Prüfung aus, um CIs zu finden, die sich auf einen Service Desk-Mitarbeiter beziehen. Der angegebene Agent muss sich im Status „aktiv“/„aktiv“ befinden.

    URL-Format

    /api/sn_Agent/Agents/{Agent_ID}/Discovery

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Service Desk-Mitarbeiters, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt ist.

    Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Agent wurde nicht gefunden oder befindet sich nicht im Status „aktiv“/„aktiv“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Discovery für einen Agent mit dem Status „aktiv“/„aktiv“ ausgeführt wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/discovery" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Running Discovery For Agent With ID: <agent_id>"
}

    Agent Client Collector – RUFT /Agents/Check_defs/{Check_def_ID} AB

    Ruft eine angegebene Prüfungsdefinition mit Details ab.

    URL-Format

    /api/sn_Agent/Agents/Check_defs/{Check_def_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    Check_def_ID SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    X-include-Check-Params Kennzeichnung, die angibt, ob vorhandene Prüfparameterdetails zurückgegeben werden. Informationen für jeden Standard- und sicheren Prüfparameter sind in einem JSON-Objekt enthalten.
    Gültige Werte:
    • True: Gibt Details zu Prüfparametern zurück.
    • Falsch: Prüfparameterdetails nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: False

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Die Prüfungsdefinition wurde mit der angegebenen sys_ID nicht gefunden.

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaften Beschreibung
    Überprüfen Details der angegebenen Prüfungsdefinition.
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "error": "String",
 "name": "String",
 "params": [Array],
 "plugins": [Array],
 "proxy_valid": Boolean,
 "secure_params": [Array],
 "sys_id": "String",
 "timeout": Number
}
    Hintergrund Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Service Desk-Mitarbeiter beginnt und nicht wartet, bis sie abgeschlossen ist.
    Gültige Werte:
    • Wahr: Diese Prüfungsdefinition ist eine Hintergrundprüfung.
    • Falsch: Diese Prüfungsdefinition ist keine Hintergrundprüfung.

    Datentyp: Boolesch
    Check_Group Gruppe, die für diese Prüfungsdefinition angegeben ist.

    Datentyp: Zeichenfolge
    Check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Überprüfen Sie, ob Ergebnisse in ein Ereignismanagement-Ereignis umgewandelt werden.
    • Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, dass Agent Client Collector Wird ausgeführt.

    Datentyp: Zeichenfolge
    Fehler Meldung, wenn ein Fehler vorliegt. Andernfalls Null.

    Datentyp: Zeichenfolge
    name Name der Prüfung.

    Datentyp: Zeichenfolge
    params Liste der Parameterdefinitionen, die der Prüfungsdefinition zugeordnet sind. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Datentyp: Array
    Parameter.aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • Wahr: Der Prüfparameter ist aktiv.
    • Falsch: Der Prüfparameter ist inaktiv.

    Datentyp: Boolesch
    params.default_value Gibt den Standardwert für diesen Prüfparameter an.

    Datentyp: Zeichenfolge
    Parameter.obligatorisch Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist.
    Gültige Werte:
    • Wahr: Der Prüfparameter ist erforderlich.
    • Falsch: Der Prüfparameter ist optional.

    Datentyp: Boolesch
    params.name Name des Prüfparameters.

    Datentyp: Zeichenfolge
    Params.sys_ID SYS_ID des Prüfparameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen“ [sn_Agent_Check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Plugins Liste von Agent Client Collector Plugins Dieser Prüfung zugeordnet.

    Datentyp: Array
    Proxy_valid Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie so festgelegt ist, dass sie als Proxy funktioniert.
    Gültige Werte:
    • Wahr: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy funktioniert.
    • Falsch: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt.

    Datentyp: Boolesch
    Secure_params Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Datentyp: Array
    Secure_params.Active Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.
    Gültige Werte:
    • Wahr: Der sichere Parameter ist aktiv.
    • Falsch: Der sichere Parameter ist inaktiv.

    Datentyp: Boolesch
    secure_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Secure_params.order Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_ID SYS_ID des sicheren Parameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen“ [sn_Agent_Check_Secure_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    sys_id SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Zeitüberschreitung Zeitüberschreitung in Sekunden.

    Datentyp: Zahl

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Informationen für eine angegebene Prüfungsdefinition abgerufen werden.

    curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/94436b237f705300f128134f8dfa91a4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "name": "app.apache.metrics-apache",
  "command": "metrics-apache-graphite.rb -p {{.labels.params_port}} --path {{.labels.params_path}} -h {{.labels.params_host}}",
  "plugins": [
    "monitoring-plugin-common"
  ],
  "timeout": 60,
  "proxy_valid": true,
  "background": false,
  "check_type": "Metrics",
  "check_group": "Apache",
  "sys_id": "94436b237f705300f128134f8dfa91a4",
  "params": [
    {
      "name": "port",
      "active": true,
      "mandatory": true,
      "default_value": "80",
      "sys_id": "58436b237f705300f128134f8dfa91a8"
    },
    {
      "name": "path",
      "active": true,
      "mandatory": true,
      "default_value": "/server-status?auto",
      "sys_id": "98436b237f705300f128134f8dfa91aa"
    },
    {
      "name": "scheme",
      "active": false,
      "mandatory": false,
      "default_value": null,
      "sys_id": "a4e57a96db3bbb4035305c55dc9619f6"
    },
    {
      "name": "host",
      "active": true,
      "mandatory": true,
      "default_value": "127.0.0.1",
      "sys_id": "d4436b237f705300f128134f8dfa91a6"
    },
    {
      "name": "ssl_secure_connection",
      "active": false,
      "mandatory": false,
      "default_value": null,
      "sys_id": "e3b272c4530100106ffeddeeff7b1275"
    }
  ],
  "secure_params": [
    {
      "name": "cred_user_name",
      "active": true,
      "order": 1,
      "sys_id": "2494cd6e53170010f42cddeeff7b1273"
    },
    {
      "name": "cred_password",
      "active": true,
      "order": 2,
      "sys_id": "35948d6e53170010f42cddeeff7b127f"
    }
  ]
}

    Agent Client Collector – RUFT /Agents/Check_defs/list AB

    Ruft eine Liste von Prüfungsdefinitionen mit Details ab.

    URL-Format

    /api/sn_Agent/Agents/Check_defs/list

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    X-Enc-Query Ein Codierte Abfragezeichenfolge Zum Filtern der Ergebnisliste der Prüfungsdefinition. Verwenden Sie null für eine ungefilterte Liste von Prüfungsdefinitionen im System.

    Datentyp: Zeichenfolge
    X-include-Check-Params Kennzeichnung, die angibt, ob vorhandene Prüfparameterdetails zurückgegeben werden. Informationen für jeden Standard- und sicheren Prüfparameter sind in einem JSON-Objekt enthalten.
    Gültige Werte:
    • True: Gibt Details zu Prüfparametern zurück.
    • Falsch: Prüfparameterdetails nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: False
    X-Limit Begrenzt die Anzahl der zurückgegebenen Datensätze. Legen Sie diese Option auf Null fest, um den Standardwert zu verwenden.

    Datentyp: Zahl

    Standard: 20.000

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 35. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Prüfungsdefinitionen Liste der Prüfungsdefinition und Details, die als JSON-Objekte bereitgestellt werden.
    [
 {
  "background": Boolean,
  "check_group": "String",
  "check_type": "String",
  "command": "String",
  "name": "String",
  "params": [Array],
  "plugins": [Array],
  "proxy_valid": Boolean,
  "secure_params": [Array],
  "sys_id": "String",
  "timeout": Number 
 }
]

    Datentyp: Array
    Hintergrund Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Service Desk-Mitarbeiter beginnt und nicht wartet, bis sie abgeschlossen ist.
    Gültige Werte:
    • Wahr: Diese Prüfungsdefinition ist eine Hintergrundprüfung.
    • Falsch: Diese Prüfungsdefinition ist keine Hintergrundprüfung.

    Datentyp: Boolesch
    Check_Group Gruppe, die für diese Prüfungsdefinition angegeben ist.

    Datentyp: Zeichenfolge
    Check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Überprüfen Sie, ob Ergebnisse in ein Ereignismanagement-Ereignis umgewandelt werden.
    • Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, dass Agent Client Collector Wird ausgeführt.

    Datentyp: Zeichenfolge
    name Name der Prüfung.

    Datentyp: Zeichenfolge
    params Liste der Parameterdefinitionen, die der Prüfungsdefinition zugeordnet sind. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Datentyp: Array
    Parameter.aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • Wahr: Der Prüfparameter ist aktiv.
    • Falsch: Der Prüfparameter ist inaktiv.

    Datentyp: Boolesch
    params.default_value Gibt den Standardwert für diesen Prüfparameter an.

    Datentyp: Zeichenfolge
    Parameter.obligatorisch Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist.
    Gültige Werte:
    • Wahr: Der Prüfparameter ist erforderlich.
    • Falsch: Der Prüfparameter ist optional.

    Datentyp: Boolesch
    params.name Name des Prüfparameters.

    Datentyp: Zeichenfolge
    Params.sys_ID SYS_ID des Prüfparameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen“ [sn_Agent_Check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Plugins Liste von Agent Client Collector Plugins Dieser Prüfung zugeordnet.

    Datentyp: Array
    Proxy_valid Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie so festgelegt ist, dass sie als Proxy funktioniert.
    Gültige Werte:
    • Wahr: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy funktioniert.
    • Falsch: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt.

    Datentyp: Boolesch
    Secure_params Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Datentyp: Array
    Secure_params.Active Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.
    Gültige Werte:
    • Wahr: Der sichere Parameter ist aktiv.
    • Falsch: Der sichere Parameter ist inaktiv.

    Datentyp: Boolesch
    secure_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Secure_params.order Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_ID SYS_ID des sicheren Parameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen“ [sn_Agent_Check_Secure_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    sys_id SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Zeitüberschreitung Zeitüberschreitung in Sekunden.

    Datentyp: Zahl

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Liste von zwei Prüfungsdefinitionen mit Parameterwerten abgerufen wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/list" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "check_definitions": [
    {
      "name": "checks_api_test",
      "command": "echo hello",
      "plugins": [],
      "timeout": 9,
      "proxy_valid": true,
      "background": false,
      "check_type": "TestCheck",
      "check_group": "computer",
      "sys_id": "7f1f9026dba530106f4810284b96194f",
      "params": [],
      "secure_params": [
        {
          "name": "check_api_test_check_secure_param2",
          "active": true,
          "order": 2,
          "sys_id": "2d30a066dba530106f4810284b9619c1"
        },
        {
          "name": "check_api_test_check_secure_param1",
          "active": true,
          "order": 100,
          "sys_id": "4c20a066dba530106f4810284b9619a8"
        }
      ]
    },
    {
      "name": "checks_api_test222",
      "command": "echo hello1212121",
      "plugins": [],
      "timeout": 60,
      "proxy_valid": true,
      "background": false,
      "check_type": "TestCheck",
      "check_group": "computer",
      "sys_id": "99e12466dba530106f4810284b961976",
      "params": [
        {
          "name": "check_api_test_check_param_222",
          "active": true,
          "mandatory": false,
          "default_value": "test_test_test",
          "sys_id": "44026466dba530106f4810284b9619b2"
        }
      ],
      "secure_params": []
    }
  ]
}

    Agent Client Collector – GET /Agents/exec/background/stop/{Request_ID}

    Stoppt eine Hintergrundprüfung.

    Um eine Hintergrundprüfung zu starten, verwenden Sie VERÖFFENTLICHEN SIE /Agents/Check_defs/{Check_def_ID}/Run API.

    URL-Format

    /api/sn_Agent/Agents/exec/background/stop/{Request_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 37. Pfadparameter
    Name Beschreibung
    request_id Die ID einer Hintergrundprüfungsanforderung, die durch Ausführen von generiert wurde VERÖFFENTLICHEN SIE /Agents/Check_defs/{Check_def_ID}/Run API.
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 39. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 40. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 41. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Die Anforderung mit der angegebenen ID wurde nicht gefunden.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Hintergrundprüfung angehalten wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/exec/background/stop/02359174db2a30108a0751f4f3961997" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector – GET /Agents/exec/Run/{Request_ID}

    Ruft den Status der Anforderung mit der angegebenen ID ab.

    URL-Format

    /api/sn_Agent/Agents/exec/Run/{Request_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 43. Pfadparameter
    Name Beschreibung
    request_id Die ID einer Hintergrundprüfungsanforderung, die durch Ausführen von generiert wurde VERÖFFENTLICHEN SIE /Agents/Check_defs/{Check_def_ID}/Run API.
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 46. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 47. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    202 Nachricht mit angegebener ID, die angibt, dass die Anforderung in Bearbeitung ist.
    400 Fehler in den im Anforderungstext angegebenen Argumenten.
    404 Die Anforderung mit der angegebenen ID wurde nicht gefunden.
    408 Ausführungszeitüberschreitung für die Anforderung mit der angegebenen ID.
    500 Fehler beim Überprüfen des Status oder der Anforderung mit der angegebenen ID.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    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

    cURL-Anforderung

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

    curl "https://instance.service-now.com/api/sn_agent/agents/exec/run/12fed13cdb2a30108a0751f4f3961981" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector – GET /Agents/exec/Test/{Test_result_ID}

    Ruft den Testprüfungsstatus des angegebenen Testergebnisses ab.

    URL-Format

    /api/sn_Agent/Agents/exec/Test/{Test_result_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 49. Pfadparameter
    Name Beschreibung
    Test_result_ID Eine Testergebnis-ID, die durch Erstellen einer Testprüfungsanforderung generiert wurde.
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 51. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 52. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 53. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    202 Nachricht mit angegebener ID, die angibt, dass die Anforderung in Bearbeitung ist.
    404 Die Anforderung mit der angegebenen ID wurde nicht gefunden.
    408 Ausführungszeitüberschreitung für die Anforderung mit der angegebenen ID.
    500 Fehler beim Überprüfen des Status der Anforderung mit der angegebenen ID.

    Parameter des Antwort-Haupttexts (JSON)

    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

    cURL-Anforderung

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

    curl "https://instance.service-now.com/api/sn_agent/agents/check_instances/99e12466dba530106f4810284b961976/test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector – GET /Agents/list

    Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.

    URL-Format

    /api/sn_Agent/Agents/list

    Unterstützte Anforderungsparameter

    Tabelle : 55. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 57. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 58. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    X-Enc-Query Codierte Abfrage in der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen .
    X-Limit Beschränkt die Ergebnisse auf eine maximale Anzahl von Service Desk-Mitarbeitern. Verwenden Sie null oder nicht definiert für beide, wenn sie nicht erforderlich sind.Standard/Max.: 20.000

    Datentyp: Zahl
    Tabelle : 59. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_user“.

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaft Beschreibung
    <Array> Array von JSON-Objekten mit erweiterten Agent-Informationen.
    [
 {
   "agent_id": "String",
   "data_collection": Number,
   "ip_address": "String",
   "is_duplicate": Boolean,
   "is_restart_enabled": Boolean,
   "name": "String",
   "number_of_running_checks": Number,
   "status": Number,
   "up_since": "String",
   "version": "String"
 }
]
    agent_id ID des Service Desk-Mitarbeiters wie übermittelt.

    Datentyp: Zeichenfolge
    Data_Collection Die Datensammlung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Service Desk-Mitarbeiter ausgeführt werden sollen.
    Mögliche Werte:
    • 0: Ein: Prüfungen werden wie geplant ausgeführt.
    • 1: Aus (manuell): Prüfungen wurden manuell deaktiviert.
    • 2: Aus (automatisch): Prüfungen wurden aufgrund eines hohen CPU-Verbrauchs durch automatisch deaktiviert

    Datentyp: Zahl
    ip_address Service Desk-Mitarbeiter-IP-Adresse.

    Datentyp: Zeichenfolge
    Ist_Duplikat

    Kennzeichnung, die angibt, ob dieser Service Desk-Mitarbeiter ein Duplikat eines anderen ist. Auf einem bestimmten Host darf nur ein einzelner Agent vorhanden sein.

    Mögliche Werte:
    • Wahr: Der Agent hat denselben Host wie ein aktiver/aktiver Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat
    • Falsch: Dieser Agent hat keine Duplikate im Status „aktiv“/„aktiv“.

    Datentyp: Boolesch
    Ist_restart_enabled

    Kennzeichnung, die angibt, ob der Neustart aktiviert ist. Neustart des Service Desk-Mitarbeiters ist nicht konfigurierbar. Dies hängt vom Betriebssystem und der Version des Betriebssystems ab, auf dem der Agent ausgeführt wird.

    Mögliche Werte:
    • Wahr: Neustart ist für diesen Agent aktiviert.
    • Falsch: Neustart ist für diesen Agent deaktiviert.

    Datentyp: Boolesch
    name Der Name des Außendienstmitarbeiters.

    Datentyp: Zeichenfolge
    Number_of_running_Checks Die Anzahl der Prüfungen, die der Service Desk-Mitarbeiter ausführen soll. Diese Prüfungen sind Teil der Richtlinien, die für diesen Service Desk-Mitarbeiter ausgeführt werden sollen.

    Datentyp: Zahl
    status Status des Service Desk-Mitarbeiters.
    Mögliche Werte:
    • 0: Aktiv/aktiv: Der Service Desk-Mitarbeiter ist aktiv.
    • 1: Warnung: Der Service Desk-Mitarbeiter hat in den letzten Minuten keine Keep-Alive-Nachricht erhalten.
    • 2: Ausgefallen: Der Service Desk-Mitarbeiter hat seit langer Zeit keine Keep-Alive-Nachricht erhalten.
    • 3: Wird neu gestartet: Der Service Desk-Mitarbeiter wird neu gestartet.

    Datentyp: Zahl
    Up_since UTC-Zeit, seit der Status des Service Desk-Mitarbeiters „aktiv“/„aktiv“ wurde. Der Wert ist in GlideDateTime Format.

    Datentyp: Zeichenfolge
    Version Version von Agent Client Collector Der Service Desk-Mitarbeiter wird ausgeführt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Ergebnisse nach Abfrage und Nummer eingeschränkt werden. Die Abfrage gibt alle Agents zurück, die sich nicht im Status „ausgefallen“ befinden, mit maximal zwei Ergebnissen.

    curl "https://instance.service-now.com/api/sn_agent/agents/list" \
--request GET \
--header "Accept:application/json" \
--header "X-Enc-Query: agent_extended_info.status!=2" \
--header "X-Limit: 2" \
--user 'username':'password'

    Ausgabe:

    {
   "agents": [
     {
       "name": "007-175",
       "status": 0,
        "agent_id": "007-175",
       "ip_address": "11.222.63.66",
        "number_of_running_checks": 0,
       "data_collection": 0,
       "is_restart_enabled": false,
       "is_duplicate": false,
       "up_since": "2021-03-24 14:36:45",
       "version": "2.4.0"
     },
     {
       "name": "win2016-dc-64bit",
       "status": 0,
       "agent_id": "007-64",
       "ip_address": "10.222.333.42",
       "number_of_running_checks": 1,
       "data_collection": 0,
       "is_restart_enabled": true,
       "is_duplicate": false,
       "up_since": "2021-03-24 11:04:38",
       "version": "2.4.0"
     }
   ]
}

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie jeden Service Desk-Mitarbeiter im System auflisten. In diesem Beispiel werden keine Abfrage und keine maximale Anzahl von Ergebnissen verwendet.

    curl "https://instance.service-now.com/api/sn_agent/agents/list" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector – RUFT /Agents/{Agent_ID}/log AB

    Fordert das Protokoll eines angegebenen Service Desk-Mitarbeiters mit Status „aktiv“/„aktiv“ an.

    Hinweis:
    Um das Protokoll abzurufen und seinen Fortschritt zu überprüfen, übergeben Sie die an zurückgegebene Anforderungs-ID RUFEN SIE /Agents/log/{Request_ID}/ AB Endpunkt.

    URL-Format

    /api/sn_Agent/Agents/{Agent_ID}/log

    Unterstützte Anforderungsparameter

    Tabelle : 61. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Service Desk-Mitarbeiters, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt ist.

    Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 63. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 64. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 65. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 66. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Agent wurde nicht gefunden oder befindet sich nicht im Status „aktiv“/„aktiv“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    request_id SYS_ID einer Anforderung in der Tabelle „Agent Client Collector-Anforderungen“ [sn_Agent_Request].

    Sie können diese ID verwenden, um das Protokoll abzurufen und seinen Fortschritt mit zu überprüfen RUFEN SIE /Agents/log/{Request_ID}/ AB Endpunkt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Protokollanforderungs-ID abgerufen wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/<sys_id>/log" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    "request_id": "<sys_id>"

    Agent Client Collector – GET /Agents/log/{Request_ID}/

    Überprüft den Status einer Anforderung zum Abrufen eines Protokolls.

    Erkennt Änderungen in der mit gesendeten Protokollabrufanforderung RUFEN SIE /api/sn_Agent/Agents/{Agent_ID}/log AB .

    URL-Format

    /api/sn_Agent/Agents/log/{Request_ID}/

    Unterstützte Anforderungsparameter

    Tabelle : 67. Pfadparameter
    Name Beschreibung
    request_id SYS_ID einer Anforderung in der Tabelle „Agent Client Collector-Anforderungen“ [sn_Agent_Request].

    Führen Sie für die Anforderungs-ID aus RUFEN SIE /api/sn_Agent/Agents/{Agent_ID}/log AB .

    Datentyp: Zeichenfolge
    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 70. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 71. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 72. Statuscodes
    Statuscode Beschreibung
    200 Anforderungsstatus ist „Fertig“, und das gefasste Protokoll ist bereit.
    202 Anforderung zum Abrufen des Protokolls mit angegebener ID wird noch ausgeführt.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Anforderung zum Abrufen des Protokolls mit angegebener ID nicht gefunden.
    408 Zeitüberschreitung bei Anforderung zum Abrufen des Protokolls.
    500 Bei der Anforderung zum Abrufen des Protokolls ist ein Fehler aufgetreten.

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaften Beschreibung
    Ausgabe Informationen, die den Status beschreiben.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie eine Anforderungs-ID verwenden, um den Status einer Anforderung zum Abrufen eines Abrufprotokolls abzurufen.

    curl "https://instance.service-now.com/api/sn_agent/agents/log/<request_ID>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "output": "SensuSnReadFile OK: {\"component\":\"agent\",\"level\":\"info\",\"msg\":\"Agent Protection: cpu of all checks: 0%\",\"time\":\"2021-04-05T00:21:41-07:00\"},...
}

    Agent Client Collector – GET /Agents/policies/list

    Ruft eine Liste von Richtlinien ab, die sich im Status „veröffentlicht“ oder „unveröffentlicht“ befinden.

    URL-Format

    /api/sn_Agent/Agents/policies/list

    Unterstützte Anforderungsparameter

    Tabelle : 73. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 74. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 75. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 76. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    X-Enc-Query Optional. Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen .
    X-include-Check-Params Optional. Kennzeichnung, die angibt, ob Prüfinstanzen und ihre Parameter in den Ergebnissen zurückgegeben werden sollen.
    Gültige Werte:
    • Wahr: Schließt Prüfinstanzen und ihre Parameter in die Ergebnisse ein.
    • Falsch: Prüfinstanzen und ihre Parameter nicht in die Ergebnisse aufnehmen.

    Standardwert: false

    Datentyp: Boolesch
    X-include-Checks-and-Service Desk-Mitarbeiter Optional. Kennzeichnung, die angibt, ob Prüfinstanzen und Service Desk-Mitarbeiter in die Ergebnisse einbezogen werden sollen.
    Gültige Werte:
    • Wahr: Schließt Prüfinstanzen und Service Desk-Mitarbeiter in die Ergebnisse ein.
    • Falsch: Nehmen Sie keine Prüfungen und Service Desk-Mitarbeiter in die Ergebnisse auf.

    Standardwert: false

    Datentyp: Boolesch
    Tabelle : 77. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 78. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_user“.

    Parameter des Antwort-Haupttexts (JSON)

    Tabelle : 79. Objekt
    Eigenschaft Beschreibung
    Richtlinien Liste der abgerufenen Richtlinien. Schließt Prüfungen und Service Desk-Mitarbeiter in Ergebnissen ein, wenn sie mithilfe bestimmter Anforderungsheader abgefragt werden. Informationen zu Richtlinien finden Sie unter Standardprüfungen und -Richtlinien .
    {
  "policies": [
    {
      "active": Boolean,
      "agent_ids": "String",
      "checks": [Array],
      "cred_alias": "String",
      "credential_alias": "String",
      "filter": "String",
      "interval": "Number",
      "monitored_ci_group": "String",
      "monitored_ci_script": "String",
      "monitored_ci_type_filter": Boolean,
      "monitored_ci_type_group": Boolean,
      "monitored_ci_type_script": "String",
      "name": "String",
      "params": [Array],
      "publish_status": "String",
      "secure_params": [Array],
      "sys_id": "String",
      "sys_updated_on": "String",
      "table": "String"
    }
  ]
}

    Datentyp: Array
    Richtlinien.aktiv Kennzeichnung, die angibt, ob die Richtlinie aktiv ist.
    Gültige Werte:
    • Wahr: Richtlinie ist aktiv.
    • Falsch: Richtlinie ist nicht aktiv.

    Datentyp: Boolesch
    Richtlinien.Agent_IDs Eindeutige ID eines Service Desk-Mitarbeiters. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Checks-And-AgentsHeader-Parameter ist auf „wahr“ festgelegt.

    Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID im aus RUFEN SIE /Agents/{Agent_ID} AB Endpunkt.

    Datentyp: Zeichenfolge

    Tabelle: In der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent].
    policies.checks Liste der Objekte, die Prüfungen definieren, die in der Tabelle „Prüfinstanzen“ [sn_Agent_Check] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Checks-And-AgentsOder X-Include-Check-ParamsHeader-Parameter ist auf „wahr“ festgelegt.

    Datentyp: Array von Objekten

    "checks": [
   {
     "active": Boolean,
     "auto_generate": Boolean,
     "check_type": "String"
     "command_prefix": "String",
     "command": "String",
     "event_status_change_threshold": Number,
     "event_status_repair_threshold": Number,
     "interval": Number,
     "name": "String",
     "sys_id": "String",
     "timeout": "String"
   }
]

    Tabelle:
    policies.checks.active Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist.
    Gültige Werte:
    • Wahr: Richtlinienprüfung ist aktiv.
    • Falsch: Richtlinienprüfung ist inaktiv.

    Datentyp: Boolesch
    policies.checks.auto_generate Kennzeichnung, die angibt, ob der Befehl automatisch mit generiert werden soll command_prefixWert.
    Gültige Werte:
    • Wahr: Füllen Sie automatisch aus commandEigenschaft mit aktiven Parameterwerten.
    • Falsch: Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    policies.checks.check_type Prüftyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Discovery: Überprüfen Sie, ob CIs im Zusammenhang mit dem Service Desk-Mitarbeiter gefunden werden.
    • Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Die Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    policies.checks.command Befehl, dass Agent Client Collector Wird ausgeführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generateIst „wahr“, wird diese Eigenschaft automatisch mit dem Präfix und den Kennzeichnungen der aktiven Parameter gefüllt, die in aufgeführt sind parametersObjekt.

    Datentyp: Zeichenfolge
    policies.checks.command_prefix Wenn auto_generateEigenschaft ist „wahr“. Dieser Befehl wird für die automatische Generierung verwendet. Das Präfix besteht aus einem beliebigen Teil des Befehls, der statisch ist (sich nicht ändert), z. B. der Skriptname.

    Datentyp: Zeichenfolge
    policies.checks.event_status_change_threshold Anzahl der aufeinanderfolgenden Male, die der Antwortstatus einer Prüfung erfolgen muss, bevor ein neues Ereignis gesendet wird. Gibt Null zurück, wenn nicht festgelegt.

    Wenn dieser Wert beispielsweise 3 ist, generiert eine Prüfung, deren Antwortstatus sich von OK in Fehler ändert, ein neues Ereignis mit einem Fehlerstatus nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung.

    Datentyp: Zahl
    policies.checks.event_status_repair_threshold Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus eines Schecks verbessern muss, um das vorherige Ereignis zu schließen. Gibt Null zurück, wenn nicht festgelegt.

    Wenn dieser Wert beispielsweise 3 ist, schließt eine Prüfung, deren Antwortstatus sich von Fehler in OK ändert, das vorherige Ereignis und generiert ein neues Ereignis mit dem Status OK nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung.

    Datentyp: Zahl
    policies.checks.interval Wartezeit in Sekunden zwischen Prüfungsausführungen. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.

    Datentyp: Zahl
    policies.checks.name Name der Prüfung.

    Datentyp: Zeichenfolge
    policies.checks.sys_id SYS_ID der Prüfung.

    Datentyp: Zeichenfolge

    Tabelle: Instanzen überprüfen [sn_Agent_Check]
    policies.checks.timeout Zeit in Sekunden, nach der die Prüfungsausführung beendet wird, wenn keine Ausgabe zurückgegeben wird. Ein Wert von 60 bedeutet beispielsweise, dass die Ausführung angehalten wird, wenn die Prüfungsausführung 60 Sekunden lang keinen Wert zurückgibt.

    Datentyp: Zeichenfolge
    Richtlinien.cred_alias Name der Anmeldeinformationen

    Datentyp: Zeichenfolge

    Tabelle: Anmeldeinformationen [Discovery_credentials]
    Richtlinien.credential_alias SYS_ID des Anmeldeinformationsalias.

    Datentyp: Zeichenfolge

    Tabelle: Aliasse für Verbindungen und Anmeldeinformationen [sys_alias]
    Richtlinien.Filter Filter, der die Prüfungen der Richtlinie so einschränkt, dass nur die angegebenen Kriterien überwacht werden.

    Datentyp: Zeichenfolge
    policies.interval Wartezeit in Sekunden zwischen Richtlinienprüfungen. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.
    Hinweis:
    Der Wert von checks.intervalEigenschaft überschreibt den in diesem Feld konfigurierten Wert.

    Datentyp: Zahl
    Richtlinien.überwachte_ci_Gruppe Name des CMDB-Gruppen Der Richtlinie zugeordnet.

    Dieses Feld wird nur angewendet, wenn der Wert von monitored_ci_type_group Eigenschaft ist „wahr“.

    Datentyp: Zeichenfolge

    Tabelle: CMDB-Gruppen [cmdb_Group]
    Richtlinien.überwachte_ci_Skript Skript zur Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert von policies.monitored_ci_type_scriptEigenschaft ist „wahr“.

    Datentyp: Zeichenfolge
    Richtlinien.überwachtes_ci_type_Filter Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in aufgeführt tableEigenschaft.
    Gültige Werte:
    • Wahr: Das Filtern nach Prüfungsgruppe ist aktiviert.
    • Falsch: Das Filtern nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    Policys.monitoring_ci_type_Group Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist.
    Gültige Werte:
    • Wahr: CMDB-Gruppentyp ist aktiviert.
    • Falsch: CMDB-Gruppentyp ist deaktiviert.

    Datentyp: Boolesch
    Richtlinien.überwachtes_ci_type_script Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.
    Gültige Werte:
    • Wahr: Skript für die Überwachung von CIs ist aktiviert.
    • Falsch: Skript für die Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    policies.name Name der Richtlinie

    Datentyp: Zeichenfolge
    Richtlinien.Publish_Status Gibt an, ob die Richtlinie veröffentlicht wird.
    Mögliche Werte:
    • Entwurf: Richtlinie wurde nicht veröffentlicht und kann mit den Update-Endpunkten bearbeitet werden.
    • Veröffentlicht: Richtlinie wird veröffentlicht. Der Entwurf (Sandbox-Kopie) und die veröffentlichte Kopie sind identisch.
    • Veröffentlicht*: Richtlinie wird veröffentlicht, aber die Entwurfskopie (Sandbox-Ansicht) weist Änderungen auf, die in der veröffentlichten Kopie nicht gefunden wurden.

    Datentyp: Zeichenfolge
    Richtlinien.sys_ID SYS_ID der Richtlinie.

    Datentyp: Zeichenfolge

    Tabelle: Richtlinien [sn_Agent_Policy]
    Policys.sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Richtlinie.

    Datentyp: Zeichenfolge
    Richtlinien.Tabelle Überwachtes CI-Typfeld in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filterIst „wahr“.

    Datentyp: Zeichenfolge
    Richtlinien.Parameter Liste von Objekten mit Informationen zu Prüfparametern. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr“ festgelegt.

    Datentyp: Array von Objekten

    "params": [
  {
    "active": Boolean,
    "flag": "String",
    "mandatory: Boolean,
    "name": "String",
    "sys_id": "String",
    "value": "String",
    "value_required": Boolean
  }
]

    Tabelle: Parameter überprüfen [sn_Agent_Check_param]
    policies.params.active Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • Wahr: Prüfparameter ist aktiv.
    • Falsch: Prüfparameter ist inaktiv.

    Datentyp: Boolesch
    Richtlinien.Parameter.Kennzeichnung Parameterkennzeichnung, die während des Aufrufs der Prüfung verwendet werden soll.

    Datentyp: Zeichenfolge
    Richtlinien.Parameter.obligatorisch Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist.
    Gültige Werte:
    • Wahr: Diese Prüfung ist obligatorisch.
    • Falsch: Diese Prüfung ist optional.

    Datentyp: Boolesch
    policies.params.name Name des Parameters.

    Datentyp: Zeichenfolge
    Richtlinien.Parameter.sys_ID SYS_ID des Parameters.

    Datentyp: Zeichenfolge

    Tabelle: Parameter überprüfen [sn_Agent_Check_param]
    Richtlinien.Parameter.Wert Wert des Parameters.

    Datentyp: Zeichenfolge
    Richtlinien.Parameter.Wert_erforderlich Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind.
    Gültige Werte:
    • Wahr: Die Werteigenschaft ist erforderlich.
    • Falsch: Die Werteigenschaft ist null oder nicht erforderlich.

    Datentyp: Boolesch
    policies.secure_params Liste von Objekten, die Informationen zu sicheren Parametern für Prüfungen enthalten. Weitere Informationen finden Sie unter Erstellen Sie einen sicheren Parameter für eine Prüfung . Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr“ festgelegt.

    Datentyp: Array von Objekten

    "secure_params": [
   {
     "active": Boolean,
     "name": "String",
     "order": Number,
     "sys_id": "String"
   }
]

    Tabelle: Sichere Parameter überprüfen [sn_Agent_Check_Secure_param]
    policies.secure_params.active Kennzeichnung, die angibt, ob der Parameter „sichere Prüfung“ aktiv ist.
    Gültige Werte:
    • Wahr: Der Parameter „sichere Prüfung“ ist aktiv.
    • Falsch: Der Parameter „sichere Prüfung“ ist inaktiv.

    Datentyp: Boolesch
    policies.secure_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    policies.secure_params.order Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.

    Datentyp: Zahl
    policies.secure_params.sys_id SYS_ID des Datensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Sicheren Parameter überprüfen [sn_Agent_Check_Secure_param]

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Ergebnisse nach Abfrage und Nummer eingeschränkt werden. Die Abfrage gibt alle aktiven Richtlinien und die ID des zugehörigen Service Desk-Mitarbeiters zurück.

    curl "https://instance.service-now.com/api/sn_agent/agents/policies/list" \
--request GET \
--header "Accept:application/json" \
--header 'X-Enc-Query: active=true ' \
--header 'X-Include-Checks-And-Agents: true' \
--user 'username' : 'password'

    Ausgabe:

    {
  "policies": [
    {
      "name": "Basic Discovery",
      "sys_id": "68bfd27c536113006dfeddeeff7b12be",
      "active": "true",
      "interval": "43200",
      "sys_updated_on": "2020-07-21 10:14:12",
      "monitored_ci_type_filter": "true",
      "filter": "discovery_source=AgentClientCollector^ORlast_discoveredRELATIVELT@dayofweek@ago@14",
      "table": "cmdb_ci_server",
      "monitored_ci_type_script": "false",
      "monitored_ci_script": "/*\n      Provide a script to get monitored CI type. ...",
      "monitored_ci_type_group": "false",
      "monitored_ci_group": "null// group name as seen in cmdb_group table",
      "cred_alias": "null// credential name as seen in discovery_credentials table",
      "credential_alias": "null// credential alias sys id as seen in sys_alias table",
      "publish_status": "Published",
      "checks": [
        {
          "name": "check-discovery-basic",
          "sys_id": "5b10c644c7e10010b9a4362c14c260aa",
          "active": "true",
          "command": "check_discover.rb",
          "command_prefix": "check_discover.rb",
          "auto_generate": "true",
          "timeout": "60",
          "interval": "43200",
          "event_status_change_threshold": null,
          "event_status_repair_threshold": null,
          "check_type": "Discovery"
        }
      ],
      "agent_ids": "b1faba21b066256f,a088b75b1b25b0a0"
    }
  ]
}

    Agent Client Collector – GET /Agents/Policy/activate/{Policy_ID}

    Aktiviert eine veröffentlichte Richtlinie.

    Für eine Liste der veröffentlichten Richtlinien verwenden Sie RUFEN SIE /Agents/policies/list AB . Dieser Endpunkt unterstützt nur sys_IDs, in denen der Wert der Richtlinie liegt publish_statusEigenschaft ist Veröffentlicht Oder Veröffentlicht* .

    URL-Format

    /api/sn_Agent/Agents/Policy/activate/{Policy_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 80. Pfadparameter
    Name Beschreibung
    policy_id SYS_ID der veröffentlichten Richtlinie.

    Datentyp: Zeichenfolge

    Tabelle: Richtlinien [sn_Agent_Policy]
    Tabelle : 81. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 82. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 83. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 84. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 85. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Header Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Richtlinie aktiviert wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – GET /Agents/Policy/deactivate/{Policy_ID}

    Deaktiviert eine veröffentlichte Richtlinie.

    Für eine Liste der veröffentlichten Richtlinien verwenden Sie RUFEN SIE /Agents/policies/list AB . Dieser Endpunkt unterstützt nur sys_IDs, in denen der Wert der Richtlinie liegt publish_statusEigenschaft ist Veröffentlicht Oder Veröffentlicht* .

    URL-Format

    /api/sn_Agent/Agents/Policy/activate/{Policy_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 86. Pfadparameter
    Name Beschreibung
    policy_id SYS_ID der veröffentlichten Richtlinie.

    Datentyp: Zeichenfolge

    Tabelle: Richtlinien [sn_Agent_Policy]
    Tabelle : 87. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 88. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 89. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 90. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 91. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Header Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie eine Richtlinie deaktivieren.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – GET /Agents/Policy/published/{Policy_ID}

    Veröffentlicht einen Richtlinienentwurf.

    Verwenden Sie einen der folgenden Endpunkte, um eine Entwurfs- oder Sandbox-Kopie vor der Veröffentlichung zu ändern:

    URL-Format

    /api/sn_Agent/Agents/Policy/published/{Policy_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 92. Pfadparameter
    Name Beschreibung
    policy_id SYS_ID einer Richtlinie in der Tabelle „Richtlinien“ [sn_Agent_Policy], die sich im Status „Entwurf“ oder einer Sandbox-Kopie befindet.

    Datentyp: Zeichenfolge
    Tabelle : 93. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 94. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 95. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 96. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 97. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Header Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Richtlinie veröffentlicht wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} ab

    Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit.

    Verwenden Sie die Sandbox-Kopie, um Aktualisierungen an einer Richtlinie vorzunehmen und zu veröffentlichen. Sie können die sys_IDs im Antworttext verwenden, um mit den folgenden Endpunkten zu arbeiten:

    Für eine Liste der veröffentlichten Richtlinien verwenden Sie RUFEN SIE /Agents/policies/list AB . Dieser Endpunkt unterstützt nur sys_IDs, in denen der Wert der Richtlinie liegt publish_statusEigenschaft ist Veröffentlicht Oder Veröffentlicht* .

    URL-Format

    /api/sn_Agent/Agents/Policy/Sandbox_from_published/{Policy_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 98. Pfadparameter
    Name Beschreibung
    policy_id SYS_ID der veröffentlichten Richtlinie.

    Datentyp: Zeichenfolge

    Tabelle: Richtlinien [sn_Agent_Policy]
    Tabelle : 99. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 100. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 101. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 102. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 103. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaft Beschreibung
    <Object> Erweiterte Details der Sandbox-Kopie, die der Richtlinie zugeordnet ist. Informationen zu Richtlinien finden Sie unter Standardprüfungen und -Richtlinien .
    {
  "active": Boolean"
  "agent_ids": "String",
  "checks": [Array],
  "cred_alias": "String",
  "credential_alias": "String",
  "filter": "String",
  "interval": "Number",
  "monitored_ci_group": "String",
  "monitored_ci_script": "String",
  "monitored_ci_type_filter": Boolean,
  "monitored_ci_type_group": Boolean,
  "monitored_ci_type_script": "String",
  "name": "String",
  "params": [Array],
  "publish_status": "String",
  "secure_params": [Array],
  "sys_id": "String",
  "sys_updated_on": "String",
  "table": "String"
}
    aktiv Kennzeichnung, die angibt, ob die Richtlinie aktiv ist.
    Gültige Werte:
    • Wahr: Richtlinie ist aktiv.
    • Falsch: Richtlinie ist nicht aktiv.

    Datentyp: Boolesch
    agent_ids Eindeutige ID eines Service Desk-Mitarbeiters. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Checks-And-AgentsHeader-Parameter ist auf „wahr“ festgelegt.

    Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID im aus RUFEN SIE /Agents/{Agent_ID} AB Endpunkt.

    Datentyp: Zeichenfolge

    Tabelle: In der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent].
    Prüfungen Liste der Objekte, die Prüfungen definieren, die in der Tabelle „Prüfinstanzen“ [sn_Agent_Check] aufgeführt sind. 
    "checks": [
   {
     "active": Boolean,
     "auto_generate": Boolean,
     "check_type": "String"
     "command_prefix": "String",
     "command": "String",
     "event_status_change_threshold": Number,
     "event_status_repair_threshold": Number,
     "interval": Number,
     "name": "String",
     "sys_id": "String",
     "timeout": "String"
   }
]

    Datentyp: Array
    Prüfungen.aktiv Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist.
    Gültige Werte:
    • Wahr: Richtlinienprüfung ist aktiv.
    • Falsch: Richtlinienprüfung ist inaktiv.

    Datentyp: Boolesch
    checks.auto_generate Kennzeichnung, die angibt, ob der Befehl automatisch mit generiert werden soll command_prefixWert.
    Gültige Werte:
    • Wahr: Füllen Sie automatisch aus commandEigenschaft mit aktiven Parameterwerten.
    • Falsch: Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    checks.check_type Prüftyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Discovery: Überprüfen Sie, ob CIs im Zusammenhang mit dem Service Desk-Mitarbeiter gefunden werden.
    • Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Die Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    checks.command Befehl, dass Agent Client Collector Wird ausgeführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generateIst „wahr“, wird diese Eigenschaft automatisch mit dem Präfix und den Kennzeichnungen der aktiven Parameter gefüllt, die in aufgeführt sind parametersObjekt.

    Datentyp: Zeichenfolge
    checks.command_prefix Wenn auto_generateEigenschaft ist „wahr“. Dieser Befehl wird für die automatische Generierung verwendet. Das Präfix besteht aus einem beliebigen Teil des Befehls, der statisch ist (sich nicht ändert), z. B. der Skriptname.

    Datentyp: Zeichenfolge
    Checks.event_Status_Change_threshold Anzahl der aufeinanderfolgenden Male, die der Antwortstatus einer Prüfung erfolgen muss, bevor ein neues Ereignis gesendet wird. Gibt Null zurück, wenn nicht festgelegt.

    Wenn dieser Wert beispielsweise 3 ist, generiert eine Prüfung, deren Antwortstatus sich von OK in Fehler ändert, ein neues Ereignis mit einem Fehlerstatus nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung.

    Datentyp: Zahl
    Checks.event_Status_Repair_threshold Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus eines Schecks verbessern muss, um das vorherige Ereignis zu schließen. Gibt Null zurück, wenn nicht festgelegt.

    Wenn dieser Wert beispielsweise 3 ist, schließt eine Prüfung, deren Antwortstatus sich von Fehler in OK ändert, das vorherige Ereignis und generiert ein neues Ereignis mit dem Status OK nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung.

    Datentyp: Zahl
    checks.interval Wartezeit in Sekunden zwischen Prüfungsausführungen. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.

    Datentyp: Zahl
    checks.name Name der Prüfung.

    Datentyp: Zeichenfolge
    Checks.sys_ID SYS_ID der Prüfung. Die VERÖFFENTLICHEN SIE /Agents/Update/Check/{Check_ID} Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge

    Tabelle: Instanzen überprüfen [sn_Agent_Check]
    Prüfungen.Zeitüberschreitung Zeit in Sekunden, nach der die Prüfungsausführung beendet wird, wenn keine Ausgabe zurückgegeben wird. Ein Wert von 60 bedeutet beispielsweise, dass die Ausführung angehalten wird, wenn die Prüfungsausführung 60 Sekunden lang keinen Wert zurückgibt.

    Datentyp: Zeichenfolge
    Cred_alias Name der Anmeldeinformationen

    Datentyp: Zeichenfolge

    Tabelle: Anmeldeinformationen [Discovery_credentials]
    credential_alias SYS_ID des Anmeldeinformationsalias.

    Datentyp: Zeichenfolge

    Tabelle: Aliasse für Verbindungen und Anmeldeinformationen [sys_alias]
    Filter Filter, der die Prüfungen der Richtlinie so einschränkt, dass nur die angegebenen Kriterien überwacht werden.

    Datentyp: Zeichenfolge
    interval Wartezeit in Sekunden zwischen Richtlinienprüfungen. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.
    Hinweis:
    Der Wert von checks.intervalEigenschaft überschreibt den in diesem Feld konfigurierten Wert.

    Datentyp: Zahl
    Überwachte_ci_Gruppe Name des CMDB-Gruppen Der Richtlinie zugeordnet.

    Dieses Feld wird nur angewendet, wenn der Wert von monitored_ci_type_group Eigenschaft ist „wahr“.

    Datentyp: Zeichenfolge

    Tabelle: CMDB-Gruppen [cmdb_Group]
    Überwachtes_ci_Skript Skript zur Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert von policies.monitored_ci_type_scriptEigenschaft ist „wahr“.

    Datentyp: Zeichenfolge
    Monitoring_ci_type_Filter Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in aufgeführt tableEigenschaft.
    Gültige Werte:
    • Wahr: Das Filtern nach Prüfungsgruppe ist aktiviert.
    • Falsch: Das Filtern nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    Monitoring_ci_type_Group Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist.
    Gültige Werte:
    • Wahr: CMDB-Gruppentyp ist aktiviert.
    • Falsch: CMDB-Gruppentyp ist deaktiviert.

    Datentyp: Boolesch
    Überwachtes_ci_type_script Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.
    Gültige Werte:
    • Wahr: Skript für die Überwachung von CIs ist aktiviert.
    • Falsch: Skript für die Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    name Name der Richtlinie

    Datentyp: Zeichenfolge
    Publish_Status Gibt an, ob die Richtlinie veröffentlicht wird.
    Mögliche Werte:
    • Entwurf: Richtlinie wurde nicht veröffentlicht und kann mit den Update-Endpunkten bearbeitet werden.
    • Veröffentlicht: Richtlinie wird veröffentlicht. Der Entwurf (Sandbox-Kopie) und die veröffentlichte Kopie sind identisch.
    • Veröffentlicht*: Richtlinie wird veröffentlicht, aber die Entwurfskopie (Sandbox-Ansicht) weist Änderungen auf, die in der veröffentlichten Kopie nicht gefunden wurden.

    Datentyp: Zeichenfolge
    params Liste von Objekten mit Informationen zu Prüfparametern. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr“ festgelegt.

    Datentyp: Array von Objekten

    "params": [
  {
    "active": Boolean,
    "flag": "String",
    "mandatory: Boolean,
    "name": "String",
    "sys_id": "String",
    "value": "String",
    "value_required": Boolean
  }
]

    Tabelle: Parameter überprüfen [sn_Agent_Check_param]
    Parameter.aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • Wahr: Prüfparameter ist aktiv.
    • Falsch: Prüfparameter ist inaktiv.

    Datentyp: Boolesch
    Parameter.Flag Parameterkennzeichnung, die während des Aufrufs der Prüfung verwendet werden soll.

    Datentyp: Zeichenfolge
    Parameter.obligatorisch Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist.
    Gültige Werte:
    • Wahr: Diese Prüfung ist obligatorisch.
    • Falsch: Diese Prüfung ist optional.

    Datentyp: Boolesch
    params.name Name des Parameters.

    Datentyp: Zeichenfolge
    Params.sys_ID SYS_ID des Parameters, der in der Tabelle „Prüfparameter“ [sn_Agent_Check_param] aufgeführt ist. Die VERÖFFENTLICHEN SIE /Agents/Update/Check_param/{param_ID} Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge
    Parameter.Wert Wert des Parameters.

    Datentyp: Zeichenfolge
    Params.value_required Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind.
    Gültige Werte:
    • Wahr: Die Werteigenschaft ist erforderlich.
    • Falsch: Die Werteigenschaft ist null oder nicht erforderlich.

    Datentyp: Boolesch
    Secure_params Liste von Objekten, die Informationen zu sicheren Parametern für Prüfungen enthalten. Weitere Informationen finden Sie unter Erstellen Sie einen sicheren Parameter für eine Prüfung . Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr“ festgelegt.

    Datentyp: Array von Objekten

    "secure_params": [
   {
     "active": Boolean,
     "name": "String",
     "order": Number,
     "sys_id": "String"
   }
]

    Tabelle: Sichere Parameter überprüfen [sn_Agent_Check_Secure_param]
    Secure_params.Active Kennzeichnung, die angibt, ob der Parameter „sichere Prüfung“ aktiv ist.
    Gültige Werte:
    • Wahr: Der Parameter „sichere Prüfung“ ist aktiv.
    • Falsch: Der Parameter „sichere Prüfung“ ist inaktiv.

    Datentyp: Boolesch
    secure_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Secure_params.order Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_ID SYS_ID des Datensatzes. Die VERÖFFENTLICHEN SIE /Agents/Update/Check_Secure_param/{param_ID} Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge

    Tabelle: Sicheren Parameter überprüfen [sn_Agent_Check_Secure_param]
    sys_id SYS_ID der Richtlinie. Die VERÖFFENTLICHEN SIE /Agents/Update/Policy/{Policy_ID} Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge

    Tabelle: Richtlinien [sn_Agent_Policy]
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Richtlinie.

    Datentyp: Zeichenfolge
    table Überwachtes CI-Typfeld in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filterIst „wahr“.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im Folgenden wird gezeigt, wie Informationen zur Richtlinie „Docker-Container-Metriken“ abgerufen werden.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/sandbox_from_published/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "name": "Docker Container Metrics",
  "sys_id": "b01e609a1b9fe4943e7f0b05464bcb91",
  "active": "false",
  "interval": "60",
  "sys_updated_on": "2021-04-05 19:52:28",
  "monitored_ci_type_filter": "true",
  "filter": "operational_status=1",
  "table": "cmdb_ci_docker_container",
  "monitored_ci_type_script": "false",
  "monitored_ci_script": "/*\n Provide a script to get monitored CI type.",
  "monitored_ci_type_group": "false",
  "monitored_ci_group": "null// group name as seen in cmdb_group table",
  "cred_alias": "null// credential name as seen in discovery_credentials table",
  "credential_alias": "null// credential alias sys id as seen in sys_alias table",
  "publish_status": "Published",
  "checks": [
    {
      "name": "container.docker.metrics-docker",
      "sys_id": "701e609a1b9fe4943e7f0b05464bcb94",
      "active": "true",
      "command": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}} -P -n -i",
      "command_prefix": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}}",
      "auto_generate": "true",
      "timeout": "60",
      "interval": "60",
      "event_status_change_threshold": null,
      "event_status_repair_threshold": null,
      "check_type": "Metrics",
      "params": [
        {
          "name": "scheme",
          "sys_id": "c11e609a1b9fe4943e7f0b05464bcb97",
          "value": null,
          "active": "false",
          "mandatory": "false",
          "value_required": "true",
          "flag": "-s"
        },
        ...
        {
          "name": "docker_host",
          "sys_id": "cd1e609a1b9fe4943e7f0b05464bcb97",
          "value": null,
          "active": "false",
          "mandatory": "false",
          "value_required": "true",
          "flag": "-H"
        }
      ],
      "secure_params": []
    }
  ]
}

    Agent Client Collector – /Agents/{Agent_ID} ABRUFEN/neu starten

    Startet einen angegebenen Agent mit Status „aktiv“/„aktiv“ neu.

    Wenn Agent Client Collector Leistungsprobleme treten auf. Sie können den Service Desk-Mitarbeiter neu starten. Manueller Neustart wird in den folgenden Umgebungen unterstützt:
    • Linux-basierte Agents mit System-ID
    • Windows-Agents

    URL-Format

    /api/sn_Agent/Agents/{Agent_ID}/restart

    Unterstützte Anforderungsparameter

    Tabelle : 104. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Service Desk-Mitarbeiters, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_Agent_cmdb_ci_Agent] aufgeführt ist.

    Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt.

    Datentyp: Zeichenfolge
    Tabelle : 105. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 106. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 107. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 108. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 109. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden, oder dieser Agent unterstützt einen Neustart nicht.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Service Desk-Mitarbeiter neu gestartet wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/restart" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Restarting Agent With ID: <agent_id>"
}

    Agent Client Collector – POST /Agents/Check_defs/{Check_def_ID}/Run

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

    Um eine Hintergrundprüfung anzuhalten, verwenden Sie die in angegebene Anforderungs-ID RUFEN SIE /Agents/exec/background/stop/{Request_ID} AB API.

    URL-Format

    /api/sn_Agent/Agents/Check_defs/{Check_def_ID}/Run

    Unterstützte Anforderungsparameter

    Tabelle : 110. Pfadparameter
    Name Beschreibung
    Check_def_ID SYS_ID einer Prüfungsdefinition in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def].
    Tabelle : 111. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 112. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    params 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"
}

    Datentyp: Objekt
    Priorität Priorität der Anforderung, die in der ECC-Warteschlange festgelegt werden soll.
    Mögliche Werte:
    • 0: Interaktiv
    • 1: Beschleunigt
    • 2: Standard

    Datentyp: Zahl
    query Codierte Abfrage zum Abrufen des GlideRecord aus der in angegebenen Tabelle tableEigenschaft.

    Datentyp: Zeichenfolge
    table Name der Tabelle „cmdb_ci“ für diese Hintergrundprüfung.

    Datentyp: Zeichenfolge
    Zeitüberschreitung Wert der Zeitüberschreitung für die Anforderung in Sekunden.

    Datentyp: Zahl

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 113. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 114. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 115. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ist ein Fehler in den im Anforderungstext angegebenen Argumenten.
    404 Die Prüfungsdefinition mit der angegebenen ID wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    requestId SYS_ID der generierten Hintergrundprüfungsanforderung.

    cURL-Anforderung

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

    curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/a90d3c361be1301060d2773ad54bcb6f/run" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"table\":\"sn_agent_check_def\"}" \
--user 'username':'password'

    Ausgabe:

    {
  "request_id": "278c0170db2a30108a0751f4f3961926"
}

    Agent Client Collector – POST /Agents/Check_defs/{Check_def_ID}/Test

    Aktiviert das Erstellen von Testprüfungsanforderungen für Prüfungsdefinitionen.

    Verwenden Sie diese API für die folgenden Aufgaben:
    • Legen Sie die Prüfungsdefinition 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

    URL-Format

    /api/sn_Agent/Agents/Check_defs/{Check_def_ID}/Test

    Unterstützte Anforderungsparameter

    Tabelle : 116. Pfadparameter
    Name Beschreibung
    Check_def_ID SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.
    Tabelle : 117. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 118. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    ci_id SYS_ID eines CMDB-Konfigurationselements.
    credentials_id SYS_ID eines Anmeldeinformationsdatensatzes.
    Anmeldeinformationen_Name Name des Anmeldeinformationsdatensatzes.
    Anmeldeinformationen_Alias_ID SYS_ID eines Datensatzes für Anmeldeinformationen-Alias.
    Anmeldeinformationen_Alias_Name Name eines Anmeldeinformationsalias.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 119. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 120. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 121. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    500 Fehler beim Erstellen der Testanforderung.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    result_id SYS_ID des Testergebnisdatensatzes.

    Agent Client Collector – POST /Agents/Check_instances/{Check_instance_ID}/Test

    Aktiviert das Erstellen von Testprüfungsanforderungen für Prüfungsinstanzen.

    Verwenden Sie diese API für die folgenden Aufgaben:
    • Legen Sie die Prüfinstanz zum Testen 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

    URL-Format

    /api/sn_Agent/Agents/Check_instances/{Check_instance_ID}/Test

    Unterstützte Anforderungsparameter

    Tabelle : 122. Pfadparameter
    Name Beschreibung
    Check_instance_ID SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.
    Tabelle : 123. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 124. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    ci_id SYS_ID eines CMDB-Konfigurationselements.
    credentials_id SYS_ID eines Anmeldeinformationsdatensatzes.
    Anmeldeinformationen_Name Name des Anmeldeinformationsdatensatzes.
    Anmeldeinformationen_Alias_ID SYS_ID eines Datensatzes für Anmeldeinformationen-Alias.
    Anmeldeinformationen_Alias_Name Name eines Anmeldeinformationsalias.
    Proxy_Agent_ID 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.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 125. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 126. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 127. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    500 Fehler beim Erstellen der Testanforderung.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    result_id SYS_ID des Testergebnisdatensatzes.

    Agent Client Collector – POST /Agents/Update/Check/{Check_ID}

    Aktualisiert eine ausgewählte Richtlinienprüfung.

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie RUFEN SIE /Agents/Policy/Sandbox_from_published/{Policy_ID} AB .

    URL-Format

    /api/sn_Agent/Agents/Update/Check/{Check_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 128. Pfadparameter
    Name Beschreibung
    Check_ID SYS_ID einer Sandbox-Kopie für Richtlinienprüfung in der Tabelle „Instanzen überprüfen“ [sn_Agent_Check].

    Datentyp: Zeichenfolge
    Tabelle : 129. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 130. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist.
    Gültige Werte:
    • Wahr: Richtlinienprüfung ist aktiv.
    • Falsch: Richtlinienprüfung ist inaktiv.

    Datentyp: Boolesch
    automatisch_generieren Kennzeichnung, die angibt, ob der Befehl automatisch mit generiert werden soll command_prefixWert.
    Gültige Werte:
    • Wahr: Füllen Sie automatisch aus commandEigenschaft mit aktiven Parameterwerten.
    • Falsch: Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    Check_type Prüftyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Discovery: Überprüfen Sie, ob CIs im Zusammenhang mit dem Service Desk-Mitarbeiter gefunden werden.
    • Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Die Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, dass Agent Client Collector Wird ausgeführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generateIst „wahr“, wird diese Eigenschaft automatisch mit dem Präfix und den Kennzeichnungen der aktiven Parameter gefüllt, die in aufgeführt sind parametersObjekt.

    Datentyp: Zeichenfolge
    Command_prefix Wenn auto_generateEigenschaft ist „wahr“. Dieser Befehl wird für die automatische Generierung verwendet. Das Präfix besteht aus einem beliebigen Teil des Befehls, der statisch ist (sich nicht ändert), z. B. der Skriptname.

    Datentyp: Zeichenfolge
    Event_Status_Change_threshold Anzahl der aufeinanderfolgenden Male, die der Antwortstatus einer Prüfung erfolgen muss, bevor ein neues Ereignis gesendet wird. Gibt Null zurück, wenn nicht festgelegt.

    Wenn dieser Wert beispielsweise 3 ist, generiert eine Prüfung, deren Antwortstatus sich von OK in Fehler ändert, ein neues Ereignis mit einem Fehlerstatus nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung.

    Datentyp: Zahl
    Event_Status_Repair_threshold Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus eines Schecks verbessern muss, um das vorherige Ereignis zu schließen. Gibt Null zurück, wenn nicht festgelegt.

    Wenn dieser Wert beispielsweise 3 ist, schließt eine Prüfung, deren Antwortstatus sich von Fehler in OK ändert, das vorherige Ereignis und generiert ein neues Ereignis mit dem Status OK nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung.

    Datentyp: Zahl
    interval Wartezeit in Sekunden zwischen Prüfungsausführungen. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.

    Datentyp: Zahl
    name Name der Prüfung.

    Datentyp: Zeichenfolge
    Zeitüberschreitung Zeit in Sekunden, nach der die Prüfungsausführung beendet wird, wenn keine Ausgabe zurückgegeben wird. Ein Wert von 60 bedeutet beispielsweise, dass die Ausführung angehalten wird, wenn die Prüfungsausführung 60 Sekunden lang keinen Wert zurückgibt.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 131. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 132. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 133. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie die Eigenschaften von Ereignis-Change und -Reparatur einer Richtlinienprüfung aktualisieren.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check/<check_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"event_status_change_threshold\" : \"2\",
    \"event_status_repair_threshold\" : \"1\"
}" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – POST /Agents/Update/Check_def_params/{Check_def_param_ID}

    Ermöglicht das Ändern eines oder mehrerer Feldwerte eines angegebenen Prüfparameters.

    URL-Format

    /api/sn_Agent/Agents/Update/Check_def_params/{Check_def_param_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 134. Pfadparameter
    Name Beschreibung
    Check_def_param_ID SYS_ID des Prüfparameters.

    Datentyp: Zeichenfolge

    Tabelle: Parameterdefinitionen überprüfen [sn_Agent_Check_param_def]
    Tabelle : 135. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 136. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • Wahr: Der Prüfparameter ist aktiv.
    • Falsch: Der Prüfparameter ist inaktiv.

    Datentyp: Boolesch
    default_value Gibt den Standardwert für diesen Prüfparameter an.

    Datentyp: Zeichenfolge
    Obligatorisch

    Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist.

    Gültige Werte:
    • Wahr: Der Prüfparameter ist erforderlich.
    • Falsch: Der Prüfparameter ist optional.

    Datentyp: Boolesch
    name Name des Prüfparameters.

    Datentyp: Zeichenfolge
    Hinweis:
    Im Datenwörterbuch finden Sie eine umfassende Liste der Prüfungsdefinitionsfelder und -Typen.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 137. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 138. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 139. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Der Prüfparameter wurde mit angegebener sys_ID nicht gefunden.
    500 Fehler beim Aktualisieren des Prüfparameters.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine Erfolgs- oder Fehlermeldung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Prüfparameter aktiviert wird.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_params/02d89bb01b307490f271ea42b24bcb63" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"true\"}" \
--user 'username':'password'

    Ausgabe:

    "message": "Check Definition Parameter Updated Successfully"

    Agent Client Collector – POST /Agents/Update/Check_def_Secure_params/{Check_def_Secure_param_ID}

    Ermöglicht das Ändern eines oder mehrerer Feldwerte eines angegebenen Prüfungsparameters.

    URL-Format

    /api/sn_Agent/Agents/Update/Check_def_Secure_params/{Check_def_Secure_param_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 140. Pfadparameter
    Name Beschreibung
    Check_def_Secure_param_ID SYS_ID des sicheren Parameters.

    Datentyp: Zeichenfolge

    Tabelle: Sichere Parameterdefinitionen überprüfen [sn_Agent_Check_Secure_param_def]
    Tabelle : 141. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 142. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.
    Gültige Werte:
    • Wahr: Der sichere Parameter ist aktiv.
    • Falsch: Der sichere Parameter ist inaktiv.

    Datentyp: Boolesch
    name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Bestellen Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 143. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 144. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 145. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Der Parameter für die Prüfung des sicheren Parameters wurde mit angegebener sys_ID nicht gefunden.
    500 Fehler beim Aktualisieren des Parameters „sicher prüfen“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine Erfolgs- oder Fehlermeldung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie einen Parameter für die Prüfung des sicheren Parameters aktivieren.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_secure_params/2d30a066dba530106f4810284b9619c1" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"true\"}" \
--user 'username':'password'

    Ausgabe:

    "message": "Check Definition Secure Parameter Updated Successfully"

    Agent Client Collector – POST /Agents/Update/Check_defs/{Check_def_ID}

    Ermöglicht das Ändern eines oder mehrerer Feldwerte einer angegebenen Prüfungsdefinition.

    URL-Format

    /api/sn_Agent/Agents/Update/Check_defs/{Check_def_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 146. Pfadparameter
    Name Beschreibung
    Check_def_ID SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 147. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 148. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    aktiv Gibt an, ob diese Prüfungsdefinition aktiv ist.
    Gültige Werte:
    • 0: Diese Prüfungsdefinition ist inaktiv.
    • 1: Diese Prüfungsdefinition ist aktiv.

    Datentyp: Zahl
    Hintergrund Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Service Desk-Mitarbeiter beginnt und nicht wartet, bis sie abgeschlossen ist.
    Gültige Werte:
    • Wahr: Diese Prüfungsdefinition ist eine Hintergrundprüfung.
    • Falsch: Diese Prüfungsdefinition ist keine Hintergrundprüfung.

    Datentyp: Boolesch
    Check_Group Gruppe, die für diese Prüfungsdefinition angegeben ist.
    Check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Überprüfen Sie, ob Ergebnisse in ein Ereignismanagement-Ereignis umgewandelt werden.
    • Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, dass Agent Client Collector Wird ausgeführt.

    Datentyp: Zeichenfolge
    name Name der Prüfung.

    Datentyp: Zeichenfolge
    params 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"
}

    Datentyp: Objekt
    Plugins Liste von Agent Client Collector Plugins Dieser Prüfung zugeordnet.

    Datentyp: Array
    Proxy_valid

    Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie so festgelegt ist, dass sie als Proxy funktioniert.

    Gültige Werte:
    • Wahr: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy funktioniert.
    • Falsch: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt.

    Datentyp: Boolesch
    query Codierte Abfrage zum Abrufen des GlideRecord aus der in angegebenen Tabelle tableEigenschaft.

    Datentyp: Zeichenfolge
    table Name der Tabelle „cmdb_ci“ für diese Prüfung.

    Datentyp: Zeichenfolge
    Zeitüberschreitung Zeitüberschreitung in Sekunden.

    Datentyp: Zahl
    Hinweis:
    Im Datenwörterbuch finden Sie eine umfassende Liste der Prüfungsdefinitionsfelder und -Typen.

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 149. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 150. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 151. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Die Prüfungsdefinition wurde mit der angegebenen sys_ID nicht gefunden.
    500 Fehler beim Aktualisieren der Prüfungsdefinition.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine Erfolgs- oder Fehlermeldung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie eine Prüfungsdefinition deaktivieren.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_defs/99e12466dba530106f4810284b961976" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"false\"}" \
--user 'username':'password'

    Ausgabe:

    "message": "Check Definition Updated Successfully"

    Agent Client Collector – POST /Agents/Update/Check_param/{param_ID}

    Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie RUFEN SIE /Agents/Policy/Sandbox_from_published/{Policy_ID} AB .

    URL-Format

    /api/sn_Agent/Agents/Update/Check_param/{param_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 152. Pfadparameter
    Name Beschreibung
    Parameter_ID SYS_ID der Sandbox-Kopie des Richtlinienprüfungsparameters.

    Datentyp: Zeichenfolge

    Tabelle: Parameter überprüfen [sn_Agent_Check_param]
    Tabelle : 153. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 154. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • Wahr: Prüfparameter ist aktiv.
    • Falsch: Prüfparameter ist inaktiv.

    Datentyp: Boolesch
    kennzeichnen
    Obligatorisch Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist.
    Gültige Werte:
    • Wahr: Diese Prüfung ist obligatorisch.
    • Falsch: Diese Prüfung ist optional.

    Datentyp: Boolesch
    name Name des Parameters.

    Datentyp: Zeichenfolge
    Wert Wert des Parameters.

    Datentyp: Zeichenfolge
    Wert_erforderlich Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind.
    Gültige Werte:
    • Wahr: Die Werteigenschaft ist erforderlich.
    • Falsch: Die Werteigenschaft ist null oder nicht erforderlich.

    Datentyp: Boolesch

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 155. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 156. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 157. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie mehrere Eigenschaften eines Richtlinienprüfungsparameters aktualisiert werden.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_param/<param_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"flag\" : \"-d\",
   \"mandatory\" : \"true\",
   \"name\" : \"scheme2\",
   \"value\" : \"120\",
   \"value_required\" : \"false\"
}" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – POST /Agents/Update/Check_Secure_param/{param_ID}

    Aktualisiert einen ausgewählten sicheren Parameter für die Richtlinienprüfung.

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie RUFEN SIE /Agents/Policy/Sandbox_from_published/{Policy_ID} AB .

    URL-Format

    /api/sn_Agent/Agents/Update/Check_Secure_param/{param_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 158. Pfadparameter
    Name Beschreibung
    Parameter_ID SYS_ID der Richtlinienprüfung – Sandbox-Kopie des sicheren Parameters.

    Datentyp: Zeichenfolge

    Tabelle: Sicheren Parameter überprüfen [sn_Agent_Check_Secure_param]
    Tabelle : 159. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 160. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Parameter „sichere Prüfung“ aktiv ist.
    Gültige Werte:
    • Wahr: Der Parameter „sichere Prüfung“ ist aktiv.
    • Falsch: Der Parameter „sichere Prüfung“ ist inaktiv.

    Datentyp: Boolesch
    name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Bestellen Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.

    Datentyp: Zahl

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 161. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 162. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 163. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Eigenschaften eines sicheren Parameters für die Richtlinienprüfung aktualisiert werden.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_secure_param/<param_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\" : \"new name\",
   \"order\" : \"2\"
}" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – POST /Agents/Update/Policy/{Policy_ID}

    Aktualisiert eine Sandbox-Kopie einer Richtlinie.

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie RUFEN SIE /Agents/Policy/Sandbox_from_published/{Policy_ID} AB .

    URL-Format

    /api/sn_Agent/Agents/Update/Policy/{Policy_ID}

    Unterstützte Anforderungsparameter

    Tabelle : 164. Pfadparameter
    Name Beschreibung
    policy_id SYS_ID einer Richtlinien-Sandbox-Kopie.

    Datentyp: Zeichenfolge

    Tabelle: Richtlinien [sn_Agent_Policy]
    Tabelle : 165. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 166. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Cred_alias Name der Anmeldeinformationen

    Datentyp: Zeichenfolge

    Tabelle: Anmeldeinformationen [Discovery_credentials]
    credential_alias SYS_ID des Anmeldeinformationsalias.

    Datentyp: Zeichenfolge

    Tabelle: Aliasse für Verbindungen und Anmeldeinformationen [sys_alias]
    Filter Filter, der die Prüfungen der Richtlinie so einschränkt, dass nur die angegebenen Kriterien überwacht werden.

    Datentyp: Zeichenfolge
    interval Wartezeit in Sekunden zwischen Richtlinienprüfungen. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.
    Hinweis:
    Der Wert von checks.intervalEigenschaft überschreibt den in diesem Feld konfigurierten Wert.

    Datentyp: Zahl
    Überwachte_ci_Gruppe Name des CMDB-Gruppen Der Richtlinie zugeordnet.

    Dieses Feld wird nur angewendet, wenn der Wert von monitored_ci_type_group Eigenschaft ist „wahr“.

    Datentyp: Zeichenfolge

    Tabelle: CMDB-Gruppen [cmdb_Group]
    Überwachtes_ci_Skript Skript zur Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert von policies.monitored_ci_type_scriptEigenschaft ist „wahr“.

    Datentyp: Zeichenfolge
    Monitoring_ci_type_Filter Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in aufgeführt tableEigenschaft.
    Gültige Werte:
    • Wahr: Das Filtern nach Prüfungsgruppe ist aktiviert.
    • Falsch: Das Filtern nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    Monitoring_ci_type_Group Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist.
    Gültige Werte:
    • Wahr: CMDB-Gruppentyp ist aktiviert.
    • Falsch: CMDB-Gruppentyp ist deaktiviert.

    Datentyp: Boolesch
    Überwachtes_ci_type_script Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.
    Gültige Werte:
    • Wahr: Skript für die Überwachung von CIs ist aktiviert.
    • Falsch: Skript für die Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    name Name der Richtlinie

    Datentyp: Zeichenfolge
    table Überwachtes CI-Typfeld in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filterIst „wahr“.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 167. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 168. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 169. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Anwender verfügt nicht über die Rolle „Agent_Client_Collector_admin“.
    404 Kein Datensatz mit der angegebenen sys_ID gefunden
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie der Name und die Filtereigenschaften/-Felder einer Richtlinie aktualisiert werden.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/policy/<policy_sys_id>" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\" : \"new policy name\",
  \"filter\" : \"operational_status=1\"
}" \
--user 'username':'password'

    Ausgabe:

    {
  "message": "Operation was successful"
}