Agent Client Collector-API

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

    • Die Agent Client Collector API bietet Endpunkte zum Verwalten von Aktionen für verfügbare Agents und zum Verwalten von Richtlinien.

    Diese API erfordert die Store-Anwendung Framework (sn_agent) Agent Client Collector und wird im Namespace sn_agent bereitgestellt. Die Endpunkte in dieser API erfordern die Rolle agent_client_collector_admin. Weitere Informationen finden Sie unter Agent Client Collector.
    Agent-Verwaltungsendpunkte

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

    Richtlinienverwaltung und Workflow
    Verwenden Sie die Richtlinienverwaltungs-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. Rufen Sie mit GET /agents/policies/listeine Liste von Richtlinien und Details 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 mit GET /agents/policy/sandbox_from_published/{policy_id}eine bearbeitbare Sandbox-Kopie ab. Verwenden Sie die sys_ids aus dieser Antwort, um Eigenschaften mithilfe eines Update-Endpunkts zu ändern.
    2. Ändern Sie Richtliniendetails mit einem Update-Endpunkt.
    3. Veröffentlichen Sie die Richtlinie mit GET /agents/policy/publish/{policy_id}.
    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 – GET /agents/{agent_id}

    Ruft die Informationen eines angegebenen Agent ab.

    URL-Format

    /api/sn_agent/agents/{agent_id}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

    Um eine Liste der Agent-IDs und anderer Details zu erhalten, führen Sie den Endpunkt GET /agents/list aus.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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 Agent wie übermittelt.

    Datentyp: Zeichenfolge
    data_collection Die Datenerfassung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind.
    Mögliche Werte:
    • 0: Ein – Prüfungen werden wie geplant ausgeführt.
    • 1: Aus (manuell) – Prüfungen wurden manuell deaktiviert.
    • 2: Aus (auto) – Prüfungen wurden aufgrund der hohen CPU-Auslastung durch automatisch deaktiviert

    Datentyp: Zahl
    ip_address IP-Adresse des Agents.

    Datentyp: Zeichenfolge
    is_duplicate

    Kennzeichnung, die angibt, ob dieser Agent 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 Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat
    • „false“: Dieser Service Desk-Mitarbeiter weist keine Duplikate im Status „Aktiv“/„Aktiv“ auf.

    Datentyp: Boolesch
    is_restart_enabled

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

    Mögliche Werte:
    • true: 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 vom Agent geplanten Prüfungen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind.

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

    Datentyp: Zahl
    up_since UTC-Zeit seit Änderung des Status des Service Desk-Mitarbeiters. Der Wert wird im GlideDateTime -Format angegeben.

    Datentyp: Zeichenfolge
    Version Version von Agent Client Collector, die der Agent ausführt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie Details zu Service Desk-Mitarbeitern abrufen.

    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 – GET /agents/{agent_id}/data/off

    Deaktiviert die Datenerfassung für einen angegebenen Agent im Status „In Betrieb/Aktiv“.

    Um zu bestimmen, ob die Datenerfassung eines Agents aktiviert oder deaktiviert ist, führen Sie den Endpunkt GET /agents/{agent_id} aus.

    URL-Format

    /api/sn_agent/agents/{agent_id}/data/off

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

    Um eine Liste der Agent-IDs und anderer Details zu erhalten, führen Sie den Endpunkt GET /agents/list aus.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Agent-Datenerfassung 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: GET /agents/{agent_id}/data/on

    Aktiviert die Datenerfassung für einen angegebenen Agent im Status „Aktiv/aktiv“.

    Um zu bestimmen, ob die Datenerfassung eines Agents aktiviert oder deaktiviert ist, führen Sie den Endpunkt GET /agents/{agent_id} aus.

    URL-Format

    /api/sn_agent/agents/{agent_id}/data/on

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

    Um eine Liste der Agent-IDs und anderer Details zu erhalten, führen Sie den Endpunkt GET /agents/list aus.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Agent-Datenerfassung 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: GET /agents/{agent_id}/discovery

    Führt eine Discovery-Prüfung durch, um CIs zu finden, die sich auf einen Agent 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 Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

    Um eine Liste der Agent-IDs und anderer Details zu erhalten, führen Sie den Endpunkt GET /agents/list aus.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie 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 – GET /agents/check_defs/{check_def_id}

    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. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    X-Include-Check-Parameter 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:
    • „wahr“: Prüfparameterdetails zurückgeben.
    • „falsch“: Gibt keine Prüfparameterdetails zurück.

    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 HTTP-Antwortcodesder REST-API.

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

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaften Beschreibung
    Scheck 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 es sich bei dieser Prüfungsdefinition um eine Hintergrundprüfung handelt. Bei einer Hintergrundprüfung startet der Agent die Ausführung von und wartet nicht, bis die Ausführung 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 Für diese Prüfungsdefinition angegebene Gruppe.

    Datentyp: Zeichenfolge
    check_type Typ des Schecks
    Mögliche Werte:
    • Ereignisse: Ergebnisse von Check werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, den der Agent Client Collector ausführt.

    Datentyp: Zeichenfolge
    Fehler Meldung, wenn ein Fehler auftritt. Andernfalls NULL.

    Datentyp: Zeichenfolge
    name Name des Schecks

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

    Datentyp: Array
    params.active 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
    params.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 „Definitionen für sichere Parameter prüfen“ [sn_agent_check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Plugins Liste der Agent Client Collector Plugins, die dieser Prüfung zugeordnet sind.

    Datentyp: Array
    proxy_valid Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie als Proxy festgelegt ist.
    Gültige Werte:
    • wahr: Diese Prüfungsdefinitionsrichtlinie ist als Proxy festgelegt.
    • „falsch“: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy konfiguriert.

    Datentyp: Boolesch
    Secure_params Liste der diesem Scheck zugewiesenen. Diese Ergebnisse werden nur eingeschlossen, wenn der Parameter withParams auf „wahr“ festgelegt ist.
    "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.
    • „false“: 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 Überprüfungsbefehl/das Überprüfungsskript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_id Sys_id des sicheren Parameters, der in der Tabelle „Definitionen sicherer Parameter prü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: GET /agents/check_defs/list

    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. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    X-Enc-Abfrage Eine codierte Abfragezeichenfolge zum Filtern der Ergebnisliste der Prüfungsdefinitionen. Verwenden Sie NULL für eine ungefilterte Liste von Prüfungsdefinitionen im System.

    Datentyp: Zeichenfolge
    X-Include-Check-Parameter 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:
    • „wahr“: Prüfparameterdetails zurückgeben.
    • „falsch“: Gibt keine Prüfparameterdetails zurück.

    Datentyp: Boolesch

    Standardwert: False
    X-Limit Begrenzt die Anzahl der zurückgegebenen Datensätze. Legen Sie den Wert 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 HTTP-Antwortcodesder REST-API.

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

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Prüfungsdefinitionen Liste der Prüfungsdefinitionen 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 es sich bei dieser Prüfungsdefinition um eine Hintergrundprüfung handelt. Bei einer Hintergrundprüfung startet der Agent die Ausführung von und wartet nicht, bis die Ausführung 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 Für diese Prüfungsdefinition angegebene Gruppe.

    Datentyp: Zeichenfolge
    check_type Typ des Schecks
    Mögliche Werte:
    • Ereignisse: Ergebnisse von Check werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, den der Agent Client Collector ausführt.

    Datentyp: Zeichenfolge
    name Name des Schecks

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

    Datentyp: Array
    params.active 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
    params.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 „Definitionen für sichere Parameter prüfen“ [sn_agent_check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Plugins Liste der Agent Client Collector Plugins, die dieser Prüfung zugeordnet sind.

    Datentyp: Array
    proxy_valid Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie als Proxy festgelegt ist.
    Gültige Werte:
    • wahr: Diese Prüfungsdefinitionsrichtlinie ist als Proxy festgelegt.
    • „falsch“: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy konfiguriert.

    Datentyp: Boolesch
    Secure_params Liste der diesem Scheck zugewiesenen. Diese Ergebnisse werden nur eingeschlossen, wenn der Parameter withParams auf „wahr“ festgelegt ist.
    "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.
    • „false“: 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 Überprüfungsbefehl/das Überprüfungsskript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_id Sys_id des sicheren Parameters, der in der Tabelle „Definitionen sicherer Parameter prü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 mit 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 die API POST /agents/check_defs/{check_def_id}/run.

    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 der POST-API „/agents/check_defs/{check_def_id}/run“ generiert wurde.
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 39. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    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 Sie eine Hintergrundprüfung stoppen können.

    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 der POST-API „/agents/check_defs/{check_def_id}/run“ generiert wurde.
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    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ührungs-Timeout 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:
    • done – Prüfung war erfolgreich.
    • Fehler: Die Prüfung ist fehlgeschlagen. Details finden Sie in der Fehlermeldung.
    • mid_flow: Die Anforderungsausgabe wird vom MID-Server verarbeitet.
    • Verarbeitung – Prüfung wird ausgeführt.
    • Zeitüberschreitung: Die Scheckverarbeitung hat das in der runCheckForCis()- Methode festgelegte Zeitlimit überschritten.

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

    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 Testüberprüfungsanforderung generiert wird.
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 51. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

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

    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. Parameter des Anforderungstexts (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-Abfrage Codierte Abfrage 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 für beide „null“ oder „nicht definiert“, 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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 Agent wie übermittelt.

    Datentyp: Zeichenfolge
    data_collection Die Datenerfassung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind.
    Mögliche Werte:
    • 0: Ein – Prüfungen werden wie geplant ausgeführt.
    • 1: Aus (manuell) – Prüfungen wurden manuell deaktiviert.
    • 2: Aus (auto) – Prüfungen wurden aufgrund der hohen CPU-Auslastung durch automatisch deaktiviert

    Datentyp: Zahl
    ip_address IP-Adresse des Agents.

    Datentyp: Zeichenfolge
    is_duplicate

    Kennzeichnung, die angibt, ob dieser Agent 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 Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat
    • „false“: Dieser Service Desk-Mitarbeiter weist keine Duplikate im Status „Aktiv“/„Aktiv“ auf.

    Datentyp: Boolesch
    is_restart_enabled

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

    Mögliche Werte:
    • true: 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 vom Agent geplanten Prüfungen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind.

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

    Datentyp: Zahl
    up_since UTC-Zeit seit Änderung des Status des Service Desk-Mitarbeiters. Der Wert wird im GlideDateTime -Format angegeben.

    Datentyp: Zeichenfolge
    Version Version von Agent Client Collector, die der Agent ausführt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Ergebnisse nach Abfrage und Nummer eingeschränkt werden. Die Abfrage gibt alle Service Desk-Mitarbeiter 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 alle Mitarbeiter im System aufgelistet werden. In diesem Beispiel wird 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: GET /agents/{agent_id}/log

    Fordert das Protokoll eines angegebenen Agent mit dem Status „Aktiv“/„Aktiv“ an.

    Hinweis:
    Um das Protokoll abzurufen und seinen Fortschritt zu überprüfen, übergeben Sie die zurückgegebene Anforderungs-ID an den Endpunkt GET /agents/log/{request_id}/.

    URL-Format

    /api/sn_agent/agents/{agent_id}/log

    Unterstützte Anforderungsparameter

    Tabelle : 61. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

    Um eine Liste der Agent-IDs und anderer Details zu erhalten, führen Sie den Endpunkt GET /agents/list aus.

    Datentyp: Zeichenfolge
    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 63. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 66. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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 ihren Fortschritt mit dem Endpunkt GET /agents/log/{request_id}/ zu überprüfen.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie eine Protokollanforderungs-ID abrufen.

    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 Erfassungsprotokollanforderung.

    Erkennt Änderungen im Protokoll, das die mit GET /api/sn_agent/agents/{agent_id}/loggesendete Anforderung abruft.

    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 GET /api/sn_agent/agents/{agent_id}/log aus.

    Datentyp: Zeichenfolge
    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 72. Statuscodes
    Statuscode Beschreibung
    200 Der Anforderungsstatus lautet „Fertig“, und das abgerufene Protokoll ist bereit.
    202 Die Anforderung zum Abrufen des Protokolls mit der angegebenen ID wird noch ausgeführt.
    403 Der Benutzer verfügt nicht über die Rolle agent_client_collector_admin.
    404 Abrufprotokollanforderung mit angegebener ID nicht gefunden.
    408 Zeitüberschreitung bei der 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 eine Anforderungs-ID verwendet wird, um den Status einer Erfassungsprotokollanforderung 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 Entwurfsstatus „Veröffentlicht“ oder „Nicht verö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. Parameter des Anforderungstexts (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-Abfrage Optional. Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen.
    X-Include-Check-Parameter Optional. Kennzeichnung, die angibt, ob Prüfungsinstanzen und ihre Parameter in den Ergebnissen zurückgegeben werden sollen.
    Gültige Werte:
    • true: Schließt Prüfungsinstanzen und ihre Parameter in die Ergebnisse ein.
    • „falsch“: Prüfinstanzen und deren Parameter nicht in die Ergebnisse aufnehmen.

    Standardwert: false

    Datentyp: Boolesch
    X-Schecks-und-Service Desk-Mitarbeiter einbeziehen Optional. Kennzeichnung, die angibt, ob Prüfungsinstanzen und Service Desk-Mitarbeiter in die Ergebnisse aufgenommen werden sollen.
    Gültige Werte:
    • true: Schließt Prüfungsinstanzen und Service Desk-Mitarbeiter in die Ergebnisse ein.
    • false: Schecks und Service Desk-Mitarbeiter nicht in die Ergebnisse einbeziehen.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 78. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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. Beinhaltet Prüfungen und Service Desk-Mitarbeiter in Ergebnissen, wenn sie mit bestimmten Anforderungsheadern 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.
    • false: Richtlinie ist nicht aktiv.

    Datentyp: Boolesch
    richtlinien.agent_ids Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Checks-And-Agents auf „wahr“ festgelegt ist.

    Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID im Endpunkt GET /agents/{agent_id} aus.
    richtlinien.prüfungen Liste der Objekte, die Prüfungen definieren, die in der Tabelle „Prüfungsinstanzen“ [sn_agent_check] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Checks-And-Agents oder X-Include-Check-Params auf „wahr“ festgelegt ist.

    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"
   }
]
    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
    richtlinien.überprüfungen.auto_generate Kennzeichnung, die angibt, ob der Befehl mit dem Wert command_prefix automatisch generiert werden soll.
    Gültige Werte:
    • true: Eigenschaft command automatisch mit aktiven Parameterwerten ausfüllen.
    • false: Der Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    richtlinien.checks.check_type Prüfungstyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Discovery: Prüfung, die CIs im Zusammenhang mit dem Agent sucht.
    • Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Die Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    richtlinien.prüfungen.befehl Befehl, den der Agent Client Collector ausführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generate auf „wahr“ festgelegt ist, wird diese Eigenschaft automatisch mit dem Präfix und den Flags der aktiven Parameter ausgefüllt, die im Objekt parameters aufgeführt sind.

    Datentyp: Zeichenfolge
    richtlinien.prüfungen.command_prefix Wenn die Eigenschaft auto_generate auf „true“ festgelegt ist, wird dieser Befehl 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
    richtlinien.checks.event_status_change_threshold Anzahl der aufeinander folgenden Male, die der Antwortstatus eines Schecks eintreten 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 von OK in Fehler wechselt, nach dem dritten Auftreten der Statusänderung ein neues Ereignis mit dem Status Fehler.

    Datentyp: Zahl
    „policy.checks.event_status_repair_threshold“ Anzahl der aufeinander folgenden 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 Überprüfung, deren Antwortstatus von Fehler in OK wechselt, das vorherige Ereignis und generiert nach dem dritten Auftreten der Statusänderung in Folge ein neues Ereignis mit dem Status OK.

    Datentyp: Zahl
    richtlinien.prüfungen.intervall 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 des Schecks

    Datentyp: Zeichenfolge
    richtlinien.prüfungen.sys_id Sys_id des in der Tabelle „Prüfungsinstanzen“ [sn_agent_check] aufgeführten Schecks.

    Datentyp: Zeichenfolge
    richtlinien.prüfungen.timeout Zeit in Sekunden, nach der die Prüfung angehalten 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 in der Tabelle „Anmeldeinformationen“ [discovery_credentials] aufgeführt ist.

    Datentyp: Zeichenfolge
    policy.credential_alias Sys_id des Anmeldeinformationsalias in der Tabelle „Aliasse für Verbindungen und Anmeldeinformationen“ [sys_alias].

    Datentyp: Zeichenfolge
    richtlinien.filter Filter, der die Prüfungen der Richtlinie so einschränkt, dass nur die angegebenen Kriterien überwacht werden.

    Datentyp: Zeichenfolge
    richtlinien.intervall 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 der Eigenschaft checks.interval überschreibt den in diesem Feld konfigurierten Wert.

    Datentyp: Zahl
    policy.monitored_ci_group Name der CMDB-Gruppen, die der Richtlinie zugeordnet sind. Diese CMDB ist in der Tabelle „CMDB-Gruppen“ [cmdb_group] aufgeführt.

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

    Datentyp: Zeichenfolge
    policy.monitored_ci_script Skript zur Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert der Eigenschaft policies.monitored_ci_type_script wahr ist.

    Datentyp: Zeichenfolge
    policy.monitored_ci_type_filter Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ ist in der Eigenschaft table aufgeführt.
    Gültige Werte:
    • „wahr“: Die Filterung nach Prüfungsgruppe ist aktiviert.
    • „falsch“: Die Filterung nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    policy.monitored_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
    policy.monitored_ci_type_script Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.
    Gültige Werte:
    • „wahr“: Skript zur Überwachung von CIs ist aktiviert.
    • „falsch“: Skript zur Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    policies.name Name der Richtlinie

    Datentyp: Zeichenfolge
    policy.publish_status Gibt an, ob die Richtlinie veröffentlicht ist.
    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*: Die Richtlinie wurde veröffentlicht, aber die Entwurfskopie (Sandbox-Ansicht) enthält Änderungen, die nicht in der veröffentlichten Kopie gefunden wurden.

    Datentyp: Zeichenfolge
    richtlinien.sys_id Sys_id der Richtlinie, die in der Tabelle „Richtlinien“ [sn_agent_policy] aufgeführt ist.

    Datentyp: Zeichenfolge
    policy.sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Richtlinie.

    Datentyp: Zeichenfolge
    richtlinien.tabelle Feld „Überwachter CI-Typ“ in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filter auf „wahr“ festgelegt ist.

    Datentyp: Zeichenfolge
    richtlinien.parameter Liste von Objekten, die Informationen zu Prüfparametern enthalten, die in der Tabelle „Prüfparameter“ [sn_agent_check_param] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „wahr“ festgelegt ist.

    Datentyp: Array von Objekten

    "params": [
  {
    "active": Boolean,
    "flag": "String",
    "mandatory: Boolean,
    "name": "String",
    "sys_id": "String",
    "value": "String",
    "value_required": Boolean
  }
]
    policies.params.active Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • „wahr“: Überprüfen Sie, ob der Parameter aktiv ist.
    • „falsch“: Überprüfungsparameter ist inaktiv.

    Datentyp: Boolesch
    richtlinien.params.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:
    • „true“: Diese Prüfung ist obligatorisch.
    • false: Diese Prüfung ist optional.

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

    Datentyp: Zeichenfolge
    richtlinien.params.sys_id Sys_id des Parameters, der in der Tabelle „Prüfparameter“ [sn_agent_check_param] aufgeführt ist.

    Datentyp: Zeichenfolge
    richtlinien.parameter.wert Wert des Parameters.

    Datentyp: Zeichenfolge
    richtlinien.params.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
    policy.secure_params Liste von Objekten, die Informationen zur Überprüfung sicherer Parameter enthalten, die in der Tabelle „Sicherheitsparameter überprüfen“ [sn_agent_check_secure_param] aufgeführt sind. Weitere Informationen hierzu finden Sie unter Sichere Parameter für Prüfungen erstellen. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „wahr“ festgelegt ist.

    Datentyp: Array von Objekten

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

    Kennzeichnung, die angibt, ob die Überprüfung des sicheren Parameters aktiv ist.

    Gültige Werte:
    • wahr: Der sichere Parameter ist aktiv.
    • „falsch“: Der sichere Parameter für die Überprüfung ist inaktiv.

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

    Datentyp: Zeichenfolge
    policy.secure_params.order Reihenfolge, in der der Parameter an den Überprüfungsbefehl/das Überprüfungsskript gesendet wird.

    Datentyp: Zahl
    policy.secure_params.sys_id Sys_id des Datensatzes in der Tabelle „Sicheren Parameter prüfen“ [sn_agent_check_secure_param]

    Datentyp: Zeichenfolge

    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 Agent 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.

    Um eine Liste der veröffentlichten Richtlinien zu erhalten, verwenden Sie GET /agents/policies/list. Dieser Endpunkt unterstützt nur sys_ids, bei denen der Wert der Eigenschaft publish_status der Richtlinie „ Veröffentlicht “ oder „ Veröffentlicht*“ lautet.

    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, die in der Tabelle „Richtlinien“ [sn_agent_policy] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 81. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 82. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 85. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    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.

    Um eine Liste der veröffentlichten Richtlinien zu erhalten, verwenden Sie GET /agents/policies/list. Dieser Endpunkt unterstützt nur sys_ids, bei denen der Wert der Eigenschaft publish_status der Richtlinie „ Veröffentlicht “ oder „ Veröffentlicht*“ lautet.

    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, die in der Tabelle „Richtlinien“ [sn_agent_policy] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 87. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 88. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 91. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    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/publish/{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/publish/{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 befindet, oder einer Sandbox-Kopie.

    Datentyp: Zeichenfolge
    Tabelle : 93. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 94. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 97. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    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 – GET /agents/policy/sandbox_from_published/{policy_id}

    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 für die Arbeit mit den folgenden Endpunkten verwenden:

    Um eine Liste der veröffentlichten Richtlinien zu erhalten, verwenden Sie GET /agents/policies/list. Dieser Endpunkt unterstützt nur sys_ids, bei denen der Wert der Eigenschaft publish_status der Richtlinie „ Veröffentlicht “ oder „ Veröffentlicht*“ lautet.

    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, die in der Tabelle „Richtlinien“ [sn_agent_policy] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 99. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 100. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 103. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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.
    • false: Richtlinie ist nicht aktiv.

    Datentyp: Boolesch
    agent_ids Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Checks-And-Agents auf „wahr“ festgelegt ist.

    Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID im Endpunkt GET /agents/{agent_id} aus.
    Schecks Liste der Objekte, die Prüfungen definieren, die in der Tabelle „Prüfungsinstanzen“ [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
    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
    checks.auto_generate Kennzeichnung, die angibt, ob der Befehl mit dem Wert command_prefix automatisch generiert werden soll.
    Gültige Werte:
    • true: Eigenschaft command automatisch mit aktiven Parameterwerten ausfüllen.
    • false: Der Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    checks.check_type Prüfungstyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Discovery: Prüfung, die CIs im Zusammenhang mit dem Agent sucht.
    • Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Die Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    checks.command Befehl, den der Agent Client Collector ausführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generate auf „wahr“ festgelegt ist, wird diese Eigenschaft automatisch mit dem Präfix und den Flags der aktiven Parameter ausgefüllt, die im Objekt parameters aufgeführt sind.

    Datentyp: Zeichenfolge
    checks.command_prefix Wenn die Eigenschaft auto_generate auf „true“ festgelegt ist, wird dieser Befehl 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 aufeinander folgenden Male, die der Antwortstatus eines Schecks eintreten 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 von OK in Fehler wechselt, nach dem dritten Auftreten der Statusänderung ein neues Ereignis mit dem Status Fehler.

    Datentyp: Zahl
    checks.event_status_repair_threshold Anzahl der aufeinander folgenden 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 Überprüfung, deren Antwortstatus von Fehler in OK wechselt, das vorherige Ereignis und generiert nach dem dritten Auftreten der Statusänderung in Folge ein neues Ereignis mit dem Status OK.

    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 des Schecks

    Datentyp: Zeichenfolge
    checks.sys_id Sys_id des in der Tabelle „Prüfungsinstanzen“ [sn_agent_check] aufgeführten Schecks. Der POST-Endpunkt /agents/update/check/{check_id} verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge
    checks.timeout Zeit in Sekunden, nach der die Prüfung angehalten 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 in der Tabelle „Anmeldeinformationen“ [discovery_credentials] aufgeführt ist.

    Datentyp: Zeichenfolge
    credential_alias Sys_id des Anmeldeinformationsalias in der Tabelle „Aliasse für Verbindungen und Anmeldeinformationen“ [sys_alias].

    Datentyp: Zeichenfolge
    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 der Eigenschaft checks.interval überschreibt den in diesem Feld konfigurierten Wert.

    Datentyp: Zahl
    monitored_ci_group Name der CMDB-Gruppen, die der Richtlinie zugeordnet sind. Diese CMDB ist in der Tabelle „CMDB-Gruppen“ [cmdb_group] aufgeführt.

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

    Datentyp: Zeichenfolge
    monitored_ci_script Skript zur Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert der Eigenschaft policies.monitored_ci_type_script wahr ist.

    Datentyp: Zeichenfolge
    monitored_ci_type_filter Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ ist in der Eigenschaft table aufgeführt.
    Gültige Werte:
    • „wahr“: Die Filterung nach Prüfungsgruppe ist aktiviert.
    • „falsch“: Die Filterung nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    monitored_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
    monitored_ci_type_script Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.
    Gültige Werte:
    • „wahr“: Skript zur Überwachung von CIs ist aktiviert.
    • „falsch“: Skript zur Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    name Name der Richtlinie

    Datentyp: Zeichenfolge
    „publish_status“ Gibt an, ob die Richtlinie veröffentlicht ist.
    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*: Die Richtlinie wurde veröffentlicht, aber die Entwurfskopie (Sandbox-Ansicht) enthält Änderungen, die nicht in der veröffentlichten Kopie gefunden wurden.

    Datentyp: Zeichenfolge
    params Liste von Objekten, die Informationen zu Prüfparametern enthalten, die in der Tabelle „Prüfparameter“ [sn_agent_check_param] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „wahr“ festgelegt ist.

    Datentyp: Array von Objekten

    "params": [
  {
    "active": Boolean,
    "flag": "String",
    "mandatory: Boolean,
    "name": "String",
    "sys_id": "String",
    "value": "String",
    "value_required": Boolean
  }
]
    params.active Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • „wahr“: Überprüfen Sie, ob der Parameter aktiv ist.
    • „falsch“: Überprüfungsparameter ist inaktiv.

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

    Datentyp: Zeichenfolge
    params.obligatorisch Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist.
    Gültige Werte:
    • „true“: Diese Prüfung ist obligatorisch.
    • false: 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. Der POST-Endpunkt /agents/update/check_param/{param_id} verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge
    params.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 zur Überprüfung sicherer Parameter enthalten, die in der Tabelle „Sicherheitsparameter überprüfen“ [sn_agent_check_secure_param] aufgeführt sind. Weitere Informationen hierzu finden Sie unter Sichere Parameter für Prüfungen erstellen. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „wahr“ festgelegt ist.

    Datentyp: Array von Objekten

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

    Kennzeichnung, die angibt, ob die Überprüfung des sicheren Parameters aktiv ist.

    Gültige Werte:
    • wahr: Der sichere Parameter ist aktiv.
    • „falsch“: Der sichere Parameter für die Überprüfung ist inaktiv.

    Datentyp: Boolesch
    Secure_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Secure_params.order Reihenfolge, in der der Parameter an den Überprüfungsbefehl/das Überprüfungsskript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_id Sys_id des Datensatzes in der Tabelle „Sicheren Parameter prüfen“ [sn_agent_check_secure_param]. Der POST-Endpunkt /agents/update/check_secure_param/{param_id} verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge
    sys_id Sys_id der Richtlinie, die in der Tabelle „Richtlinien“ [sn_agent_policy] aufgeführt ist. Der POST-Endpunkt /agents/update/policy/{policy_id} verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren.

    Datentyp: Zeichenfolge
    sys_updated_on Datum und Uhrzeit der letzten Aktualisierung der Richtlinie.

    Datentyp: Zeichenfolge
    Tabelle Feld „Überwachter CI-Typ“ in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filter auf „wahr“ festgelegt ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

    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: GET /agents/{agent_id}/restart

    Startet einen angegebenen Agent mit dem Status „Aktiv“/„Aktiv“ neu.

    Wenn Agent Client Collector Leistungsprobleme auftreten, können Sie den Agent neu starten. Der manuelle Neustart wird in den folgenden Umgebungen unterstützt:
    • Linux-basierte Agents mit systemd
    • Windows-Agents

    URL-Format

    /api/sn_agent/agents/{agent_id}/restart

    Unterstützte Anforderungsparameter

    Tabelle : 104. Pfadparameter
    Name Beschreibung
    agent_id Eindeutige ID eines Agents, der in der Spalte „Agent ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

    Um eine Liste der Agent-IDs und anderer Details zu erhalten, führen Sie den Endpunkt GET /agents/list aus.

    Datentyp: Zeichenfolge
    Tabelle : 105. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 106. Parameter des Anforderungstexts (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 HTTP-Antwortcodesder REST-API.

    Tabelle : 109. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer verfügt nicht über die Rolle agent_client_collector_admin.
    404 Es wurde kein Datensatz mit der angegebenen sys_id gefunden, oder dieser Agent unterstützt keinen Neustart.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie einen Agent neu starten.

    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 Configuration Item durch.

    Um eine Hintergrundprüfung zu stoppen, verwenden Sie die Anforderungs-ID, die in der API GET /agents/exec/background/stop/{request_id} angegeben ist.

    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. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    params Zuordnung von Parameternamen und -werten. Diese Einstellungen können verwendet werden, um die Parameterdatensätze der Prüfungsdefinition und die angegebenen Werte zu überschreiben. 
    "params": {
  "<parameter name>": "String"
}

    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 der Eigenschaft table angegebenen Tabelle.

    Datentyp: Zeichenfolge
    Tabelle Name der cmdb_ci-Tabelle 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 HTTP-Antwortcodesder REST-API.

    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

    Ermöglicht 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 Configuration Item fest, für das der Test ausgeführt werden soll
    Sie können auch einen der folgenden Bezeichner für den Test angeben:
    • 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. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    ci_id Sys_id eines CMDB-Konfigurationselements.
    credentials_id Sys_id eines Anmeldeinformationsdatensatzes.
    „credentials_name“ Name des Anmeldeinformationsdatensatzes.
    „credentials_alias_id“ Sys_id eines Alias-Datensatzes für Anmeldeinformationen
    „credentials_alias_name“ Name des Alias für Anmeldeinformationen

    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 HTTP-Antwortcodesder REST-API.

    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

    Ermöglicht das Erstellen von Testprüfungsanforderungen auf Prüfungsinstanzen.

    Verwenden Sie diese API für die folgenden Aufgaben:
    • Legen Sie die Prüfinstanz auf „Test“ fest
    • Legen Sie das Configuration Item fest, für das der Test ausgeführt werden soll
    Sie können auch einen der folgenden Bezeichner für den Test angeben:
    • 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. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    ci_id Sys_id eines CMDB-Konfigurationselements.
    credentials_id Sys_id eines Anmeldeinformationsdatensatzes.
    „credentials_name“ Name des Anmeldeinformationsdatensatzes.
    „credentials_alias_id“ Sys_id eines Alias-Datensatzes für Anmeldeinformationen
    „credentials_alias_name“ Name des Alias für Anmeldeinformationen
    proxy_agent_id Eindeutige ID eines Agent-Proxy zum Ausführen dieser Prüfung. Dieser Wert ist 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 HTTP-Antwortcodesder REST-API.

    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 Kopie einer Richtlinien-Sandbox abzurufen, verwenden Sie GET /agents/policy/sandbox_from_published/{policy_id}.

    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 „Prüfungsinstanzen“ [sn_agent_check]

    Datentyp: Zeichenfolge
    Tabelle : 129. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 130. Parameter des Anforderungstexts (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
    auto_generate Kennzeichnung, die angibt, ob der Befehl mit dem Wert command_prefix automatisch generiert werden soll.
    Gültige Werte:
    • true: Eigenschaft command automatisch mit aktiven Parameterwerten ausfüllen.
    • false: Der Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    check_type Prüfungstyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Discovery: Prüfung, die CIs im Zusammenhang mit dem Agent sucht.
    • Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Die Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, den der Agent Client Collector ausführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generate auf „wahr“ festgelegt ist, wird diese Eigenschaft automatisch mit dem Präfix und den Flags der aktiven Parameter ausgefüllt, die im Objekt parameters aufgeführt sind.

    Datentyp: Zeichenfolge
    „command_prefix“ Wenn die Eigenschaft auto_generate auf „true“ festgelegt ist, wird dieser Befehl 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 aufeinander folgenden Male, die der Antwortstatus eines Schecks eintreten 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 von OK in Fehler wechselt, nach dem dritten Auftreten der Statusänderung ein neues Ereignis mit dem Status Fehler.

    Datentyp: Zahl
    event_status_repair_threshold Anzahl der aufeinander folgenden 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 Überprüfung, deren Antwortstatus von Fehler in OK wechselt, das vorherige Ereignis und generiert nach dem dritten Auftreten der Statusänderung in Folge ein neues Ereignis mit dem Status OK.

    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 des Schecks

    Datentyp: Zeichenfolge
    Zeitüberschreitung Zeit in Sekunden, nach der die Prüfung angehalten 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 133. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie die Eigenschaften für das 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, der in der Tabelle „Prüfparameterdefinitionen“ [sn_agent_check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 135. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 136. Parameter des Anforderungstexts (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:
    Eine umfassende Liste der Felder und Typen von Prüfungsdefinitionen finden Sie im Datenwörterbuch.

    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 HTTP-Antwortcodesder REST-API.

    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 sicheren Prüfparameters.

    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, der in der Tabelle „Definitionen sicherer Parameter prüfen“ [sn_agent_check_secure_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 141. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 142. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    aktiv

    Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.

    Gültige Werte:
    • wahr: Der sichere Parameter ist aktiv.
    • „false“: Der sichere Parameter ist inaktiv.

    Datentyp: Boolesch
    name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Bestellen Reihenfolge, in der der Parameter an den Überprüfungsbefehl/das Überprüfungsskript 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 145. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Der sichere Parameter zur Prüfung wurde mit angegebener sys_id nicht gefunden.
    500 Fehler beim Aktualisieren des sicheren Prüfparameters.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine Erfolgs- oder Fehlermeldung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Überprüfung eines sicheren Parameters aktiviert wird.

    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. Parameter des Anforderungstexts (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 es sich bei dieser Prüfungsdefinition um eine Hintergrundprüfung handelt. Bei einer Hintergrundprüfung startet der Agent die Ausführung von und wartet nicht, bis die Ausführung 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 Für diese Prüfungsdefinition angegebene Gruppe.
    check_type Typ des Schecks
    Mögliche Werte:
    • Ereignisse: Ergebnisse von Check werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, den der Agent Client Collector ausführt.

    Datentyp: Zeichenfolge
    name Name des Schecks

    Datentyp: Zeichenfolge
    params Zuordnung von Parameternamen und -werten. Diese Einstellungen können verwendet werden, um die Parameterdatensätze der Prüfungsdefinition und die angegebenen Werte zu überschreiben. 
    "params": {
  "<parameter name>": "String"
}

    Datentyp: Objekt
    Plugins Liste von Agent Client Collector Plugins sind mit dieser Prüfung verknüpft.

    Datentyp: Array
    proxy_valid

    Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie als Proxy festgelegt ist.

    Gültige Werte:
    • wahr: Diese Prüfungsdefinitionsrichtlinie ist als Proxy festgelegt.
    • „falsch“: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy konfiguriert.

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

    Datentyp: Zeichenfolge
    Tabelle Name der cmdb_ci-Tabelle für diese Prüfung.

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

    Datentyp: Zahl
    Hinweis:
    Eine umfassende Liste der Felder und Typen von Prüfungsdefinitionen finden Sie im Datenwörterbuch.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 151. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    404 Die Prüfungsdefinition wurde mit angegebener 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 Kopie einer Richtlinien-Sandbox abzurufen, verwenden Sie GET /agents/policy/sandbox_from_published/{policy_id}.

    URL-Format

    /api/sn_agent/agents/update/check_param/{param_id}

    Unterstützte Anforderungsparameter

    Tabelle : 152. Pfadparameter
    Name Beschreibung
    param_id Sys_id der Sandbox-Kopie des Richtlinienprüfungsparameters in der Tabelle „Prüfparameter“ [sn_agent_check_param].

    Datentyp: Zeichenfolge
    Tabelle : 153. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 154. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • „wahr“: Überprüfen Sie, ob der Parameter aktiv ist.
    • „falsch“: Überprüfungsparameter ist inaktiv.

    Datentyp: Boolesch
    kennzeichnen
    Obligatorisch Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist.
    Gültige Werte:
    • „true“: Diese Prüfung ist obligatorisch.
    • false: Diese Prüfung ist optional.

    Datentyp: Boolesch
    name Name des Parameters.

    Datentyp: Zeichenfolge
    Wert Wert des Parameters.

    Datentyp: Zeichenfolge
    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

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 157. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    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 der Richtlinienprüfung.

    Um die Eigenschaften einer Kopie einer Richtlinien-Sandbox abzurufen, verwenden Sie GET /agents/policy/sandbox_from_published/{policy_id}.

    URL-Format

    /api/sn_agent/agents/update/check_secure_param/{param_id}

    Unterstützte Anforderungsparameter

    Tabelle : 158. Pfadparameter
    Name Beschreibung
    param_id Sys_id der Sandbox-Kopie des sicheren Parameters für die Richtlinienprüfung in der Tabelle „Sicheren Parameter prüfen“ [sn_agent_check_secure_param].

    Datentyp: Zeichenfolge
    Tabelle : 159. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 160. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    aktiv

    Kennzeichnung, die angibt, ob die Überprüfung des sicheren Parameters aktiv ist.

    Gültige Werte:
    • wahr: Der sichere Parameter ist aktiv.
    • „falsch“: Der sichere Parameter für die Überprüfung ist inaktiv.

    Datentyp: Boolesch
    name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Bestellen Reihenfolge, in der der Parameter an den Überprüfungsbefehl/das Überprüfungsskript 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 163. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

    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 Kopie einer Richtlinien-Sandbox abzurufen, verwenden Sie GET /agents/policy/sandbox_from_published/{policy_id}.

    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 in der Tabelle „Richtlinien“ [sn_agent_policy].

    Datentyp: Zeichenfolge
    Tabelle : 165. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 166. Parameter des Anforderungstexts (JSON)
    Name Beschreibung
    CRED_alias Name, der in der Tabelle „Anmeldeinformationen“ [discovery_credentials] aufgeführt ist.

    Datentyp: Zeichenfolge
    credential_alias Sys_id des Anmeldeinformationsalias in der Tabelle „Aliasse für Verbindungen und Anmeldeinformationen“ [sys_alias].

    Datentyp: Zeichenfolge
    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 der Eigenschaft checks.interval überschreibt den in diesem Feld konfigurierten Wert.

    Datentyp: Zahl
    monitored_ci_group Name der CMDB-Gruppen, die der Richtlinie zugeordnet sind. Diese CMDB ist in der Tabelle „CMDB-Gruppen“ [cmdb_group] aufgeführt.

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

    Datentyp: Zeichenfolge
    monitored_ci_script Skript zur Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert der Eigenschaft policies.monitored_ci_type_script wahr ist.

    Datentyp: Zeichenfolge
    monitored_ci_type_filter Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ ist in der Eigenschaft table aufgeführt.
    Gültige Werte:
    • „wahr“: Die Filterung nach Prüfungsgruppe ist aktiviert.
    • „falsch“: Die Filterung nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    monitored_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
    monitored_ci_type_script Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.
    Gültige Werte:
    • „wahr“: Skript zur Überwachung von CIs ist aktiviert.
    • „falsch“: Skript zur Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    name Name der Richtlinie

    Datentyp: Zeichenfolge
    Tabelle Feld „Überwachter CI-Typ“ in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filter auf „wahr“ festgelegt ist.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 169. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Der Benutzer 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, die die Ergebnisse zu Erfolg oder Fehler für den Vorgang enthält.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie den Namen und die Filtereigenschaften/-felder einer Richtlinie aktualisieren.

    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"
}