Agent Client Collector-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 61 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 Agent Client Collector Framework (sn_agent) 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 Management-Endpunkte

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

    Richtlinienverwaltung und Workflow
    Verwenden Sie 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 eine Liste von Richtlinien und Details mit GET /agents/policies/list ab. Dieser Endpunkt erfordert die Rolle agent_client_collector_user.
      • Um eine Richtlinie im Status „Entwurf“ zu aktualisieren, verwenden Sie die sys_ids, die aus der Richtlinienliste in den Aktualisierungsendpunkten abgerufen wurden.
      • Um eine Richtlinie im Status „Veröffentlicht“ oder „Veröffentlicht*“ zu aktualisieren, rufen Sie eine bearbeitbare Sandbox-Kopie mit GET /agents/policy/sandbox_from_published/{policy_id} ab. Verwenden Sie die sys_ids aus dieser Antwort, um Eigenschaften mithilfe eines Aktualisierungsendpunkts zu ändern.
    2. Ändern Sie Richtliniendetails mithilfe eines Aktualisierungsendpunkts.
    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 Service Desk-Mitarbeiters ab.

    URL-Format

    /api/sn_agent/agents/{agent_id}

    Unterstützte Anforderungsparameter

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

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

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (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 Service Desk-Mitarbeiters 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 (automatisch) – Prüfungen wurden aufgrund des hohen CPU-Verbrauchs durch den automatisch deaktiviert

    Datentyp: Zahl
    ip_address Agent-IP-Adresse

    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:
    • true: Der Agent hat denselben Host wie ein Alive/Up-Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat
    • false: Dieser Agent hat keine Duplikate im Status „Alive/Up“.

    Datentyp: Boolesch
    is_restart_enabled

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

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

    Datentyp: Boolesch
    Name Der Name des Außendienstmitarbeiters.

    Datentyp: Zeichenfolge
    number_of_running_checks Die Anzahl der Prüfungen, die der Agent ausführen soll. 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/In Betrieb – Der Agent ist aktiv.
    • 1: Warnung – Der Agent hat in den letzten Minuten keine Keep-Alive-Nachricht erhalten.
    • 2: Ausgefallen – Der Agent hat seit längerer Zeit keine Keep-Alive-Nachricht erhalten.
    • 3: Wird neu gestartet – Der Agent wird neu gestartet.

    Datentyp: Zahl
    up_seit UTC-Zeit, seit der Status des Service Desk-Mitarbeiters aktiviert wurde. Der Wert liegt im GlideDateTime -Format vor.

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Details zu Service Desk-Mitarbeitern abgerufen werden.

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

    Ausgabe:

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

    Agent Client Collector – GET /agents/{agent_id}/data/off

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

    Um zu bestimmen, ob die Datenerfassung eines Agent ein- oder ausgeschaltet 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 Agent, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

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

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (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 nicht gefunden oder befindet sich nicht im Status „In Betrieb“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    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 „In Betrieb“.

    Um zu bestimmen, ob die Datenerfassung eines Agent ein- oder ausgeschaltet 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 Agent, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

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

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (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 nicht gefunden oder befindet sich nicht im Status „In Betrieb“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    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 Erkennungsprüfung aus, um CIs zu finden, die zu einem Agent gehören. Der angegebene Agent muss sich im Status „Alive/In Betrieb“ befinden.

    URL-Format

    /api/sn_agent/agents/{agent_id}/discovery

    Unterstützte Anforderungsparameter

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

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

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter (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 nicht gefunden oder befindet sich nicht im Status „In Betrieb“.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Erkennung für einen Agent mit dem Status „Alive/In Betrieb“ 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. Anforderungstextparameter (JSON)
    Name Beschreibung
    X-Include-Check-Parameter Kennzeichnung, die angibt, ob vorhandene Prüfparameterdetails zurückgegeben werden. Informationen für jeden standardmäßigen und sicheren Prüfparameter sind in einem JSON-Objekt enthalten.
    Gültige Werte:
    • true: Prüfparameterdetails zurückgeben.
    • false: Prüfparameterdetails nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: False

    Header

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

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

    Statuscodes

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

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

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaften Beschreibung
    überprüfen Details der angegebenen Prüfungsdefinition.
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "error": "String",
 "name": "String",
 "params": [Array],
 "plugins": [Array],
 "proxy_valid": Boolean,
 "secure_params": [Array],
 "sys_id": "String",
 "timeout": Number
}
    Hintergrund Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, bei der der Agent mit der Ausführung beginnt und nicht auf den Abschluss wartet.
    Gültige Werte:
    • true: Diese Prüfungsdefinition ist eine Hintergrundprüfung.
    • false: Diese Prüfungsdefinition ist keine Hintergrundprüfung.

    Datentyp: Boolesch
    check_group Für diese Prüfungsdefinition angegebene Gruppe.

    Datentyp: Zeichenfolge
    check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Die Ergebnisse der Prüfung werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

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

    Datentyp: Zeichenfolge
    Fehler Nachricht, wenn ein Fehler vorliegt. Andernfalls NULL.

    Datentyp: Zeichenfolge
    Name Name der Prüfung.

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

    Datentyp: Array
    params.aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • true: Der Prüfparameter ist aktiv.
    • false: 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:
    • true: Der Prüfparameter ist erforderlich.
    • false: Der Prüfparameter ist optional.

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

    Datentyp: Zeichenfolge
    params.sys_id Sys_id des Prüfungsparameters, der in der Tabelle „Sichere Parameterdefinitionen 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:
    • true: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy fungiert.
    • false: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt.

    Datentyp: Boolesch
    sichere_params Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse sind nur enthalten, wenn der Parameter withParams auf „true“ festgelegt ist.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Datentyp: Array
    sichere_params.aktiv Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.
    Gültige Werte:
    • true: Der sichere Parameter ist aktiv.
    • false: Der sichere Parameter ist inaktiv.

    Datentyp: Boolesch
    sichere_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    sichere_params.bestellung Reihenfolge, in der der Parameter an den Prüfbefehl/das Prüfskript gesendet wird.

    Datentyp: Zahl
    sichere_params.sys_id Sys_id des sicheren Parameters, der in der Tabelle „Sichere Parameterdefinitionen überprüfen“ [sn_agent_check_secure_param_def] aufgeführt ist.

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

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

    Datentyp: Zahl

    cURL-Anforderung

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

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

    Ausgabe:

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

    Agent Client Collector – 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. Anforderungstextparameter (JSON)
    Name Beschreibung
    X-Enc-Query Eine codierte Abfragezeichenfolge zum Filtern der Ergebnisliste der Prüfungsdefinition. Verwenden Sie NULL für eine ungefilterte Liste von Prüfungsdefinitionen im System.

    Datentyp: Zeichenfolge
    X-Include-Check-Parameter Kennzeichnung, die angibt, ob vorhandene Prüfparameterdetails zurückgegeben werden. Informationen für jeden standardmäßigen und sicheren Prüfparameter sind in einem JSON-Objekt enthalten.
    Gültige Werte:
    • true: Prüfparameterdetails zurückgeben.
    • false: Prüfparameterdetails nicht zurückgeben.

    Datentyp: Boolesch

    Standardwert: False
    X-Limit Beschränkt die Anzahl der zurückgegebenen Datensätze. Setzen Sie den Wert auf NULL, 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 diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, bei der der Agent mit der Ausführung beginnt und nicht auf den Abschluss wartet.
    Gültige Werte:
    • true: Diese Prüfungsdefinition ist eine Hintergrundprüfung.
    • false: Diese Prüfungsdefinition ist keine Hintergrundprüfung.

    Datentyp: Boolesch
    check_group Für diese Prüfungsdefinition angegebene Gruppe.

    Datentyp: Zeichenfolge
    check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Die Ergebnisse der Prüfung werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

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

    Datentyp: Zeichenfolge
    Name Name der Prüfung.

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

    Datentyp: Array
    params.aktiv Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist.
    Gültige Werte:
    • true: Der Prüfparameter ist aktiv.
    • false: 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:
    • true: Der Prüfparameter ist erforderlich.
    • false: Der Prüfparameter ist optional.

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

    Datentyp: Zeichenfolge
    params.sys_id Sys_id des Prüfungsparameters, der in der Tabelle „Sichere Parameterdefinitionen 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:
    • true: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy fungiert.
    • false: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt.

    Datentyp: Boolesch
    sichere_params Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse sind nur enthalten, wenn der Parameter withParams auf „true“ festgelegt ist.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Datentyp: Array
    sichere_params.aktiv Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.
    Gültige Werte:
    • true: Der sichere Parameter ist aktiv.
    • false: Der sichere Parameter ist inaktiv.

    Datentyp: Boolesch
    sichere_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    sichere_params.bestellung Reihenfolge, in der der Parameter an den Prüfbefehl/das Prüfskript gesendet wird.

    Datentyp: Zahl
    sichere_params.sys_id Sys_id des sicheren Parameters, der in der Tabelle „Sichere Parameterdefinitionen überprüfen“ [sn_agent_check_secure_param_def] aufgeführt ist.

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

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

    Datentyp: Zahl

    cURL-Anforderung

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

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

    Ausgabe:

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

    Agent Client Collector – GET /agents/exec/background/stop/{request_id}

    Stoppt eine Hintergrundprüfung.

    Um eine Hintergrundprüfung zu starten, verwenden Sie die POST-API /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. Anforderungstextparameter (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 eine Hintergrundprüfung angehalten wird.

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

    Agent Client Collector – GET /agents/exec/run/{request_id}

    Ruft den Status der Anforderung mit der angegebenen ID ab.

    URL-Format

    /api/sn_agent/agents/exec/run/{request_id}

    Unterstützte Anforderungsparameter

    Tabelle : 43. Pfadparameter
    Name Beschreibung
    request_id Die ID einer Hintergrundprüfungsanforderung, die durch Ausführen der POST-API /agents/check_defs/{check_def_id}/run generiert wurde.
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Anforderungstextparameter (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 ausgeführt wird.
    400 Fehler in den im Anforderungstext angegebenen Argumenten.
    404 Die Anforderung mit der angegebenen ID wurde nicht gefunden.
    408 Ausführungszeitüberschreitung für die Anforderung mit der angegebenen ID.
    500 Fehler beim Überprüfen des Status oder der Anforderung mit der angegebenen ID.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Anforderungsstatus.
    Mögliche Werte:
    • fertig – Prüfung ist erfolgreich.
    • failure – Prüfung ist fehlgeschlagen. Weitere Informationen finden Sie in der Fehlermeldung.
    • mid_flow – Anforderungsausgabe wird vom MID-Server verarbeitet.
    • wird verarbeitet – Prüfung wird ausgeführt.
    • Zeitüberschreitung – 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 der angegebenen ID.
    • Keine Anforderung mit der angegebenen ID.
    • Kein Testergebnis mit angegebener ID.
    • Anforderungszeitüberschreitung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

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

    Agent Client Collector – GET /agents/exec/test/{test_result_id}

    Ruft den Testprüfungsstatus des angegebenen Testergebnisses ab.

    URL-Format

    /api/sn_agent/agents/exec/test/{test_result_id}

    Unterstützte Anforderungsparameter

    Tabelle : 49. Pfadparameter
    Name Beschreibung
    test_result_id Eine Testergebnis-ID, die durch Erstellen einer Testüberprüfungsanforderung generiert wird.
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 51. Anforderungstextparameter (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 ausgeführt wird.
    404 Die Anforderung mit der angegebenen ID wurde nicht gefunden.
    408 Ausführungszeitüberschreitung für die Anforderung mit der angegebenen ID.
    500 Fehler beim Überprüfen des Status der Anforderung mit der angegebenen ID.

    Parameter des Antwort-Haupttexts (JSON)

    Eigenschaften Beschreibung
    status Status der Testergebnisse.
    Mögliche Werte:
    • 0: Ausstehend
    • 1: In Bearbeitung
    • 2: Abgeschlossen
    • 3: Kein Testergebnis mit angegebener ID

    Datentyp: Zeichenfolge
    Ausgabe Ausgabe, die den Status beschreibt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

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

    Agent Client Collector – GET /agents/list

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

    URL-Format

    /api/sn_agent/agents/list

    Unterstützte Anforderungsparameter

    Tabelle : 55. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 57. Anforderungstextparameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

    Datentyp: Zahl
    Tabelle : 59. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter 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 Service Desk-Mitarbeiters 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 (automatisch) – Prüfungen wurden aufgrund des hohen CPU-Verbrauchs durch den automatisch deaktiviert

    Datentyp: Zahl
    ip_address Agent-IP-Adresse

    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:
    • true: Der Agent hat denselben Host wie ein Alive/Up-Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat
    • false: Dieser Agent hat keine Duplikate im Status „Alive/Up“.

    Datentyp: Boolesch
    is_restart_enabled

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

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

    Datentyp: Boolesch
    Name Der Name des Außendienstmitarbeiters.

    Datentyp: Zeichenfolge
    number_of_running_checks Die Anzahl der Prüfungen, die der Agent ausführen soll. 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/In Betrieb – Der Agent ist aktiv.
    • 1: Warnung – Der Agent hat in den letzten Minuten keine Keep-Alive-Nachricht erhalten.
    • 2: Ausgefallen – Der Agent hat seit längerer Zeit keine Keep-Alive-Nachricht erhalten.
    • 3: Wird neu gestartet – Der Agent wird neu gestartet.

    Datentyp: Zahl
    up_seit UTC-Zeit, seit der Status des Service Desk-Mitarbeiters aktiviert wurde. Der Wert liegt im GlideDateTime -Format vor.

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

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

    Ausgabe:

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

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie alle Service Desk-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 „Alive/In Betrieb“ 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 Agent, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

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

    Datentyp: Zeichenfolge
    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 63. Anforderungstextparameter (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 nicht gefunden oder befindet sich nicht im Status „In Betrieb“.

    Parameter des Antwort-Haupttexts (JSON)

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

    Sie können diese ID verwenden, um das Protokoll abzurufen und seinen Fortschritt mit dem Endpunkt GET /agents/log/{request_id}/ zu überprüfen.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

    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 Grab-Protokollanforderung.

    Erkennt Änderungen in der Protokollabrufanforderung, die mit GET /api/sn_agent/agents/{agent_id}/log gesendet wird.

    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. Anforderungstextparameter (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 ist abgeschlossen, und das erfasste 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 Grab-Protokollanforderung mit angegebener ID nicht gefunden.
    408 Zeitüberschreitung bei Grab-Protokollanforderung.
    500 Bei der Grab-Protokollanforderung 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 Grab-Protokollanforderung 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. Anforderungstextparameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

    Tabelle : 76. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    X-Enc-Query Optional. Codierte Abfragezeichenfolge im Standard-Glide-Format. Weitere Informationen finden Sie unter 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: Bezieht Prüfungsinstanzen und ihre Parameter in die Ergebnisse ein.
    • false: Prüfinstanzen und deren Parameter nicht in die Ergebnisse einbeziehen.

    Standardwert: false

    Datentyp: Boolesch
    X – Prüfungen und Agents einbeziehen Optional. Kennzeichnung, die angibt, ob Prüfungsinstanzen und Agents in die Ergebnisse einbezogen werden sollen.
    Gültige Werte:
    • true: Bezieht Prüfungsinstanzen und Agents in die Ergebnisse ein.
    • false: Prüfungen und Agents 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. Schließt Prüfungen und Agenten in die Ergebnisse ein, wenn sie mit bestimmten Anforderungsheadern abgefragt werden. Weitere 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:
    • true: Richtlinie ist aktiv.
    • false: Richtlinie ist nicht aktiv.

    Datentyp: Boolesch
    richtlinien.agent_ids Eindeutige ID eines Agent, 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 „true“ 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 „true“ festgelegt ist.
    "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
    richtlinien.checks.active

    Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist.

    Gültige Werte:
    • true: Richtlinienprüfung ist aktiv.
    • false: Richtlinienprüfung ist inaktiv.

    Datentyp: Boolesch
    richtlinien.checks.auto_generate

    Kennzeichnung, die angibt, ob der Befehl automatisch mit dem Wert command_prefix generiert werden soll.

    Gültige Werte:
    • true: Füllt die Eigenschaft command automatisch mit aktiven Parameterwerten aus.
    • false: Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    richtlinien.checks.check_type Prüfungstyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Erkennung: Überprüfen Sie, ob mit dem Agent verbundene CIs erkannt werden.
    • Events: Das Ergebnis der Prüfung wird in ein Event Management-Event umgewandelt.
    • Metriken: Die Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    richtlinien.checks.command Befehl, den Agent Client Collector ausführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generate den Wert „true“ hat, 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.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
    richtlinien.checks.event_status_change_threshold Anzahl der aufeinanderfolgenden Male, die der Antwortstatus einer Prüfung auftreten muss, bevor ein neues Event gesendet wird. Gibt NULL zurück, wenn nicht festgelegt.

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

    Datentyp: Zahl
    richtlinien.checks.event_status_repair_threshold Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus einer Prüfung verbessern muss, bevor ein neues Event gesendet wird. Gibt NULL zurück, wenn nicht festgelegt.

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

    Datentyp: Zahl
    richtlinien.checks.interval Die Zeit in Sekunden, die zwischen Prüfungsausführungen gewartet werden soll. Ein Wert von 60 bedeutet beispielsweise, dass die Prüfung alle 60 Sekunden ausgeführt wird.

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

    Datentyp: Zeichenfolge
    richtlinien.checks.sys_id Sys_id der Prüfung, die in der Tabelle „Prüfungsinstanzen“ [sn_agent_check] aufgeführt ist.

    Datentyp: Zeichenfolge
    richtlinien.checks.timeout Die Zeit in Sekunden, nach der die Prüfungsausführung 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
    richtlinien.credential_alias Sys_id des Anmeldeinformationsalias in der Tabelle für 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 Die Zeit in Sekunden, die zwischen Richtlinienprüfungen gewartet werden soll. 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
    richtlinien.monitored_ci_group Name der CMDB-Gruppen, die der Richtlinie zugeordnet sind. Diese CMDB wird in der Tabelle „CMDB-Gruppen“ [cmdb_group] aufgeführt.

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

    Datentyp: Zeichenfolge
    richtlinien.monitored_ci_script Skript für die Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert der Eigenschaft policies.monitored_ci_type_script „ true“ ist.

    Datentyp: Zeichenfolge
    Policen.monitored_ci_type_filter

    Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in der Eigenschaft table aufgeführt.

    Gültige Werte:
    • true: Filtern nach Prüfungsgruppe ist aktiviert.
    • false: Filtern nach Prüfungsgruppe ist deaktiviert.

    Datentyp: Boolesch
    Richtlinien.monitored_ci_type_group

    Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist.

    Gültige Werte:
    • true: CMDB-Gruppentyp ist aktiviert.
    • false: CMDB-Gruppentyp ist deaktiviert.

    Datentyp: Boolesch
    Richtlinien.monitored_ci_type_script

    Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist.

    Gültige Werte:
    • true: Skript für die Überwachung von CIs ist aktiviert.
    • false: Skript für die Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    richtlinien.name Name der Richtlinie

    Datentyp: Zeichenfolge
    richtlinien.publish_status Gibt an, ob die Richtlinie veröffentlicht wurde.
    Mögliche Werte:
    • Entwurf: Richtlinie wurde nicht veröffentlicht und kann mit den Update-Endpunkten bearbeitet werden.
    • Veröffentlicht: Die Richtlinie wurde 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) weist Änderungen auf, die in der veröffentlichten Kopie nicht gefunden wurden.

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

    Datentyp: Zeichenfolge
    richtlinien.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 den Wert „true“ hat.

    Datentyp: Zeichenfolge
    Richtlinien.Parameter Liste von Objekten, die Informationen zu Prüfungsparametern enthalten, die in der Tabelle „Prüfungsparameter“ [sn_agent_check_param] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „true“ festgelegt ist.
    "params": [
   {
     "active": "Boolean",
     "flag": "String",
     "mandatory: "Boolean"
     "name": "String",
     "sys_id": "String",
     "value": "String",
     "value_required": "Boolean"
   }
]

    Datentyp: Array
    Richtlinien.Parameter.Aktiv

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

    Gültige Werte:
    • true: Überprüfen, ob der Parameter aktiv ist.
    • false: Überprüfen Sie, ob der Parameter inaktiv ist.

    Datentyp: Boolesch
    richtlinien.params.kennzeichen Parameterkennzeichnung, die beim Aufruf der Prüfung verwendet werden soll.

    Datentyp: Zeichenfolge
    richtlinien.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
    richtlinien.params.name Name des Parameters.

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

    Datentyp: Zeichenfolge
    Richtlinien.Parameter.Wert Wert des Parameters.

    Datentyp: Zeichenfolge
    richtlinien.params.value_required Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind.
    Gültige Werte:
    • true: Die Eigenschaft value ist erforderlich.
    • false: Die Werteigenschaft ist null oder nicht erforderlich.

    Datentyp: Boolesch
    richtlinien.secure_params

    Liste von Objekten, die Informationen zu sicheren Parametern enthalten, die in der Tabelle „Sichere Parameter prüfen“ [sn_agent_check_secure_param] aufgeführt sind. Weitere Informationen finden Sie unter Sichere Parameter für eine Prüfung erstellen. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „true“ festgelegt ist.

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

    Datentyp: Array
    richtlinien.secure_params.active

    Kennzeichnung, die angibt, ob der sichere Parameter zur Überprüfung aktiv ist.

    Gültige Werte:
    • true: Der sichere Parameter für die Prüfung ist aktiv.
    • false: Der sichere Parameter für die Prüfung ist inaktiv.

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

    Datentyp: Zeichenfolge
    richtlinien.secure_params.order Reihenfolge, in der der Parameter an den Prüfbefehl/das Prüfskript gesendet wird.

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die 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.

    Verwenden Sie für eine Liste der veröffentlichten Richtlinien GET /agents/policies/list. Dieser Endpunkt unterstützt nur sys_ids, in 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. Anforderungstextparameter (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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    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.

    Verwenden Sie für eine Liste der veröffentlichten Richtlinien GET /agents/policies/list. Dieser Endpunkt unterstützt nur sys_ids, in 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. Anforderungstextparameter (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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Richtlinie deaktiviert wird.

    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 einen Entwurf oder eine 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 eine Sandbox-Kopie.

    Datentyp: Zeichenfolge
    Tabelle : 93. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 94. Anforderungstextparameter (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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    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 Antwort-Haupttext verwenden, um mit den folgenden Endpunkten zu arbeiten:

    Verwenden Sie für eine Liste der veröffentlichten Richtlinien GET /agents/policies/list. Dieser Endpunkt unterstützt nur sys_ids, in 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. Anforderungstextparameter (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. Weitere 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:
    • true: Richtlinie ist aktiv.
    • false: Richtlinie ist nicht aktiv.

    Datentyp: Boolesch
    agent_ids Eindeutige ID eines Agent, 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 „true“ festgelegt ist.

    Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID im Endpunkt GET /agents/{agent_id} aus.
    Prüfungen 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:
    • true: Richtlinienprüfung ist aktiv.
    • false: Richtlinienprüfung ist inaktiv.

    Datentyp: Boolesch
    checks.auto_generate

    Kennzeichnung, die angibt, ob der Befehl automatisch mit dem Wert command_prefix generiert werden soll.

    Gültige Werte:
    • true: Füllt die Eigenschaft command automatisch mit aktiven Parameterwerten aus.
    • false: Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    checks.check_type Prüfungstyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Erkennung: Überprüfen Sie, ob mit dem Agent verbundene CIs erkannt werden.
    • Events: Das Ergebnis der Prüfung wird in ein Event Management-Event umgewandelt.
    • Metriken: Die Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    checks.command Befehl, den Agent Client Collector ausführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generate den Wert „true“ hat, 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 aufeinanderfolgenden Male, die der Antwortstatus einer Prüfung auftreten muss, bevor ein neues Event gesendet wird. Gibt NULL zurück, wenn nicht festgelegt.

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

    Datentyp: Zahl
    checks.event_status_repair_threshold Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus einer Prüfung verbessern muss, bevor ein neues Event gesendet wird. Gibt NULL zurück, wenn nicht festgelegt.

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

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

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

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

    Datentyp: Zeichenfolge
    checks.timeout Die Zeit in Sekunden, nach der die Prüfungsausführung 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 für 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 Die Zeit in Sekunden, die zwischen Richtlinienprüfungen gewartet werden soll. 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 wird in der Tabelle „CMDB-Gruppen“ [cmdb_group] aufgeführt.

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

    Datentyp: Zeichenfolge
    monitored_ci_script Skript für die Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert der Eigenschaft policies.monitored_ci_type_script „ true“ ist.

    Datentyp: Zeichenfolge
    monitored_ci_type_filter

    Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in der Eigenschaft table aufgeführt.

    Gültige Werte:
    • true: Filtern nach Prüfungsgruppe ist aktiviert.
    • false: Filtern 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:
    • true: CMDB-Gruppentyp ist aktiviert.
    • false: 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:
    • true: Skript für die Überwachung von CIs ist aktiviert.
    • false: Skript für die Überwachung von CIs ist deaktiviert.

    Datentyp: Boolesch
    Name Name der Richtlinie

    Datentyp: Zeichenfolge
    veröffentlichen_status Gibt an, ob die Richtlinie veröffentlicht wurde.
    Mögliche Werte:
    • Entwurf: Richtlinie wurde nicht veröffentlicht und kann mit den Update-Endpunkten bearbeitet werden.
    • Veröffentlicht: Die Richtlinie wurde 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) weist Änderungen auf, die in der veröffentlichten Kopie nicht gefunden wurden.

    Datentyp: Zeichenfolge
    params Liste von Objekten, die Informationen zu Prüfungsparametern enthalten, die in der Tabelle „Prüfungsparameter“ [sn_agent_check_param] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „true“ festgelegt ist.
    "params": [
   {
     "active": "Boolean",
     "flag": "String",
     "mandatory: "Boolean"
     "name": "String",
     "sys_id": "String",
     "value": "String",
     "value_required": "Boolean"
   }
]

    Datentyp: Array
    params.aktiv

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

    Gültige Werte:
    • true: Überprüfen, ob der Parameter aktiv ist.
    • false: Überprüfen Sie, ob der Parameter inaktiv ist.

    Datentyp: Boolesch
    params.kennzeichen Parameterkennzeichnung, die beim Aufruf 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üfungsparameter“ [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.value Wert des Parameters.

    Datentyp: Zeichenfolge
    params.value_required Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind.
    Gültige Werte:
    • true: Die Eigenschaft value ist erforderlich.
    • false: Die Werteigenschaft ist null oder nicht erforderlich.

    Datentyp: Boolesch
    sichere_params

    Liste von Objekten, die Informationen zu sicheren Parametern enthalten, die in der Tabelle „Sichere Parameter prüfen“ [sn_agent_check_secure_param] aufgeführt sind. Weitere Informationen finden Sie unter Sichere Parameter für eine Prüfung erstellen. Diese Ergebnisse werden nur angezeigt, wenn der Header-Parameter X-Include-Check-Params auf „true“ festgelegt ist.

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

    Datentyp: Array
    sichere_params.aktiv

    Kennzeichnung, die angibt, ob der sichere Parameter zur Überprüfung aktiv ist.

    Gültige Werte:
    • true: Der sichere Parameter für die Prüfung ist aktiv.
    • false: Der sichere Parameter für die Prüfung ist inaktiv.

    Datentyp: Boolesch
    sichere_params.name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    sichere_params.bestellung Reihenfolge, in der der Parameter an den Prüfbefehl/das Prüfskript gesendet wird.

    Datentyp: Zahl
    sichere_params.sys_id Sys_id des Datensatzes in der Tabelle „Sichere 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 den Wert „true“ hat.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im Folgenden wird gezeigt, wie Sie Informationen zur Richtlinie „Docker Container Metrics“ erhalten.

    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 „Alive/In Betrieb“ 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 Agent, der in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt ist.

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

    Datentyp: Zeichenfolge
    Tabelle : 105. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 106. Anforderungstextparameter (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 Kein Datensatz mit der angegebenen sys_id gefunden, oder dieser Agent unterstützt keinen Neustart.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Nachricht Nachricht mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Agent neu gestartet wird.

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

    Ausgabe:

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

    Agent Client Collector – POST /agents/check_defs/{check_def_id}/run

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

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

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

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

    Datentyp: Zahl
    query Codierte Abfrage zum Abrufen des GlideRecord aus der in 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 Das 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 Anforderung zur Hintergrundprüfung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Hintergrundprüfung ausgeführt wird und die Anforderungs-ID abgerufen wird.

    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 die Erstellung von Testprüfungsanforderungen für Prüfungsdefinitionen.

    Verwenden Sie diese API für die folgenden Aufgaben:
    • Legen Sie die Prüfungsdefinition auf Test fest
    • Legen Sie das Konfigurationselement fest, für das der Test ausgeführt werden soll
    Sie können auch einen der folgenden Bezeichner angeben, die während des Tests verwendet werden sollen:
    • Sys-ID der Anmeldeinformationen
    • Alias-ID für Anmeldeinformationen
    • Anmeldeinformationsname

    URL-Format

    /api/sn_agent/agents/check_defs/{check_def_id}/test

    Unterstützte Anforderungsparameter

    Tabelle : 116. Pfadparameter
    Name Beschreibung
    check_def_id Sys_id der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_agent_check_def] aufgeführt ist.
    Tabelle : 117. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 118. Anforderungstextparameter (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 Anmeldeinformationsalias-Datensatzes.
    credentials_alias_name Name eines Anmeldeinformationsalias.

    Header

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

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

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter 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 die Erstellung von Testprüfungsanforderungen für Prüfungsinstanzen.

    Verwenden Sie diese API für die folgenden Aufgaben:
    • Legen Sie die Prüfungsinstanz auf Test fest
    • Legen Sie das Konfigurationselement fest, für das der Test ausgeführt werden soll
    Sie können auch einen der folgenden Bezeichner angeben, die während des Tests verwendet werden sollen:
    • Sys-ID der Anmeldeinformationen
    • Alias-ID für Anmeldeinformationen
    • Anmeldeinformationsname

    URL-Format

    /api/sn_agent/agents/check_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. Anforderungstextparameter (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 Anmeldeinformationsalias-Datensatzes.
    credentials_alias_name Name eines Anmeldeinformationsalias.
    proxy_agent_id Eindeutige ID eines Agent-Proxys zum Ausführen dieser Prüfung. Dieser Wert wird in der Spalte „Agent-ID“ der Tabelle „Agent Client Collectors“ [sn_agent_cmdb_ci_agent] aufgeführt.

    Header

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

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

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter 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 Richtlinien-Sandbox-Kopie 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 Kopie einer Richtlinienprüfungs-Sandbox in der Tabelle „Prüfungsinstanzen“ [sn_agent_check].

    Datentyp: Zeichenfolge
    Tabelle : 129. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 130. Anforderungstextparameter (JSON)
    Name Beschreibung
    aktiv

    Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist.

    Gültige Werte:
    • true: Richtlinienprüfung ist aktiv.
    • false: Richtlinienprüfung ist inaktiv.

    Datentyp: Boolesch
    auto_generate

    Kennzeichnung, die angibt, ob der Befehl automatisch mit dem Wert command_prefix generiert werden soll.

    Gültige Werte:
    • true: Füllt die Eigenschaft command automatisch mit aktiven Parameterwerten aus.
    • false: Befehl wird nicht automatisch generiert.

    Datentyp: Boolesch
    check_type Prüfungstyp, der die Überwachungsoption angibt.
    Mögliche Werte:
    • Erkennung: Überprüfen Sie, ob mit dem Agent verbundene CIs erkannt werden.
    • Events: Das Ergebnis der Prüfung wird in ein Event Management-Event umgewandelt.
    • Metriken: Die Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, den Agent Client Collector ausführt. Parameter aus einer Vorlage oder einem überwachten CI.
    Hinweis:
    Wenn auto_generate den Wert „true“ hat, 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 aufeinanderfolgenden Male, die der Antwortstatus einer Prüfung auftreten muss, bevor ein neues Event gesendet wird. Gibt NULL zurück, wenn nicht festgelegt.

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

    Datentyp: Zahl
    event_status_repair_threshold Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus einer Prüfung verbessern muss, bevor ein neues Event gesendet wird. Gibt NULL zurück, wenn nicht festgelegt.

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

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

    Datentyp: Zahl
    Name Name der Prüfung.

    Datentyp: Zeichenfolge
    Zeitüberschreitung Die Zeit in Sekunden, nach der die Prüfungsausführung 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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie die Event-Change- und Reparatur-Eigenschaften einer Richtlinienprüfung aktualisiert werden.

    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üfungsparameters, der in der Tabelle „Prüfungsparameterdefinitionen“ [sn_agent_check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 135. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 136. Anforderungstextparameter (JSON)
    Name Beschreibung
    aktiv

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

    Gültige Werte:
    • true: Der Prüfparameter ist aktiv.
    • false: 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:
    • true: Der Prüfparameter ist erforderlich.
    • false: Der Prüfparameter ist optional.

    Datentyp: Boolesch
    Name Name des Prüfungsparameters.

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

    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 der angegebenen 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üfungsparameters.

    URL-Format

    /api/sn_agent/agents/update/check_def_secure_params/{check_def_secure_param_id}

    Unterstützte Anforderungsparameter

    Tabelle : 140. Pfadparameter
    Name Beschreibung
    check_def_secure_param_id Sys_id des sicheren Parameters, der in der Tabelle „Sichere Parameterdefinitionen überprüfen“ [sn_agent_check_secure_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Tabelle : 141. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 142. Anforderungstextparameter (JSON)
    Name Beschreibung
    aktiv

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

    Gültige Werte:
    • true: 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 Prüfbefehl/das Prüfskript 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 Überprüfungsparameter wurde mit der angegebenen sys_id nicht gefunden.
    500 Fehler beim Aktualisieren des sicheren Parameters für die Prüfung.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine Erfolgs- oder Fehlermeldung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein sicherer Parameter für die Prüfung 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. Anforderungstextparameter (JSON)
    Name Beschreibung
    aktiv Gibt an, ob diese Prüfungsdefinition aktiv ist.
    Gültige Werte:
    • 0: Diese Prüfungsdefinition ist inaktiv.
    • 1: Diese Prüfungsdefinition ist aktiv.

    Datentyp: Zahl
    Hintergrund Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, bei der der Agent mit der Ausführung beginnt und nicht auf den Abschluss wartet.
    Gültige Werte:
    • true: Diese Prüfungsdefinition ist eine Hintergrundprüfung.
    • false: Diese Prüfungsdefinition ist keine Hintergrundprüfung.

    Datentyp: Boolesch
    check_group Für diese Prüfungsdefinition angegebene Gruppe.
    check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Die Ergebnisse der Prüfung werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

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

    Datentyp: Zeichenfolge
    Name Name der Prüfung.

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

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

    Datentyp: Array
    proxy_valid

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

    Gültige Werte:
    • true: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy fungiert.
    • false: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt.

    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:
    Im Datenwörterbuch finden Sie eine umfassende Liste der Felder und Typen der Prüfungsdefinition.

    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 der angegebenen sys_id nicht gefunden.
    500 Fehler beim Aktualisieren der Prüfungsdefinition.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Keine Erfolgs- oder Fehlermeldung.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Prüfungsdefinition deaktiviert wird.

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

    Ausgabe:

    "message": "Check Definition Updated Successfully"

    Agent Client Collector – POST /agents/update/check_param/{param_id}

    Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie 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üfungsparameter“ [sn_agent_check_param].

    Datentyp: Zeichenfolge
    Tabelle : 153. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 154. Anforderungstextparameter (JSON)
    Name Beschreibung
    aktiv

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

    Gültige Werte:
    • true: Überprüfen, ob der Parameter aktiv ist.
    • false: Überprüfen Sie, ob der Parameter inaktiv ist.

    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:
    • true: Die Eigenschaft value ist erforderlich.
    • false: 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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

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

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie 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 für sichere Parameter der Richtlinienprüfung in der Tabelle „Sichere Parameter prüfen“ [sn_agent_check_secure_param].

    Datentyp: Zeichenfolge
    Tabelle : 159. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 160. Anforderungstextparameter (JSON)
    Name Beschreibung
    aktiv

    Kennzeichnung, die angibt, ob der sichere Parameter zur Überprüfung aktiv ist.

    Gültige Werte:
    • true: Der sichere Parameter für die Prüfung ist aktiv.
    • false: Der sichere Parameter für die Prüfung ist inaktiv.

    Datentyp: Boolesch
    Name Name des sicheren Parameters.

    Datentyp: Zeichenfolge
    Bestellen Reihenfolge, in der der Parameter an den Prüfbefehl/das Prüfskript 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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

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

    Ausgabe:

    {
  "message": "Operation was successful"
}

    Agent Client Collector – POST /agents/update/policy/{policy_id}

    Aktualisiert eine Sandbox-Kopie einer Richtlinie.

    Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie 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 Richtlinientabelle [sn_agent_policy].

    Datentyp: Zeichenfolge
    Tabelle : 165. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 166. Anforderungstextparameter (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 für 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 Die Zeit in Sekunden, die zwischen Richtlinienprüfungen gewartet werden soll. 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 wird in der Tabelle „CMDB-Gruppen“ [cmdb_group] aufgeführt.

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

    Datentyp: Zeichenfolge
    monitored_ci_script Skript für die Überwachung von CIs.

    Dieses Feld wird nur angewendet, wenn der Wert der Eigenschaft policies.monitored_ci_type_script „ true“ ist.

    Datentyp: Zeichenfolge
    monitored_ci_type_filter

    Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in der Eigenschaft table aufgeführt.

    Gültige Werte:
    • true: Filtern nach Prüfungsgruppe ist aktiviert.
    • false: Filtern 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:
    • true: CMDB-Gruppentyp ist aktiviert.
    • false: 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:
    • true: Skript für die Überwachung von CIs ist aktiviert.
    • false: Skript für die Ü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 den Wert „true“ hat.

    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 mit den Ergebnissen des Vorgangserfolgs oder -fehlers.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

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

    Ausgabe:

    {
  "message": "Operation was successful"
}