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

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Agent-Clientsammler-API

# Agent-Clientsammler-API {#ariaid-title1}

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

Die Agent-Clientsammler Die API stellt Endpunkte zur Verwaltung von Aktionen für verfügbare Agenten und zur Verwaltung von Richtlinien bereit.
Diese API erfordert Agent Client CollectorFramework (sn_Agent) Store-Anwendung und wird in bereitgestellt `sn_Agent `Namespace. Die Endpunkte in dieser API erfordern die Rolle „agent_client_collector_admin". Weitere Informationen finden Sie unter [Agent-Clientsammler](https://www.servicenow.com/docs/access?context=acc-landing-page&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).

Agenten-Management-Endpunkte
:
    * Rufen Sie umfassende Informationen zu einem oder mehreren Service Desk-Mitarbeitern ab. Diese Endpunkte sind auch für Anwender mit der Rolle „agent_client_collector_user" zugänglich.
      * [RUFEN SIE /Agents/{Agent_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-agent_id "Ruft die Informationen eines angegebenen Agenten ab.")
      * [RUFEN SIE /Agents/list AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.")
      {#agnt_clnt_cll-api__ul_tsy_mkq_dpb}
    * Senden Sie eine Anforderung, um ein Agent-Protokoll abzurufen und Informationen zum Anforderungsfortschritt abzurufen.
      * [RUFEN SIE /Agents/{Agent_ID}/log AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-log "Fordert das Protokoll eines angegebenen Agenten mit Status „aktiv“/„aktiv“ an.")
      * [RUFEN SIE /Agents/log/{Request_ID}/ AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-log-request_id "Überprüft den Status einer Anforderung zum Abrufen eines Protokolls.")
      {#agnt_clnt_cll-api__ul_rpm_4kq_dpb}
    * Deaktivieren oder aktivieren Sie die Agent-Datensammlung.
      * [/Agents/{Agent_ID}/Data/off ABRUFEN](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-data-off "Deaktiviert die Datensammlung für einen angegebenen Agent im Status „aktiv“/„aktiv“.")
      * [RUFEN SIE /Agents/{Agent_ID}/Data/on AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-data-on "Aktiviert die Datensammlung für einen angegebenen Agent im Status „aktiv“/„aktiv“.")
      {#agnt_clnt_cll-api__ul_z43_gkq_dpb}
    * Starten Sie einen Service Desk-Mitarbeiter mit neu [/Agents/{Agent_ID}/restart ABRUFEN](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-restart "Startet einen angegebenen Agent mit dem Status „aktiv“/„aktiv“ neu.").
    * Führen Sie die Discovery für einen Agenten mit aus [RUFT /Agents/{Agent_ID}/Discovery AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-discovery "Führt eine Discovery-Prüfung aus, um CIs zu finden, die sich auf einen Service Desk-Mitarbeiter beziehen. Der angegebene Agent muss sich im Status „aktiv“/„aktiv“ befinden.").

    {#agnt_clnt_cll-api__ul_mlz_ckq_dpb}

    Informationen zum Ausführen ähnlicher Aufgaben in einer Skripteinbindung finden Sie unter [AccAgentsAPI](https://developer.servicenow.com/go_to_api.do?ID=AccAgentsAPIAPIScoped&v=utah).

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. Ruft eine Liste von Richtlinien und Details mit ab [RUFT /Agents/policies/list AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policies-list "Ruft eine Liste von Richtlinien ab, die sich im Status „veröffentlicht“ oder „unveröffentlicht“ befinden."). Dieser Endpunkt erfordert die Rolle „agent_client_collector_user".
       * Um eine Richtlinie im Status „Entwurf" zu aktualisieren, verwenden Sie die sys_IDs, die aus der Richtlinienliste in den Update-Endpunkten abgerufen wurden.
       * Um eine Richtlinie im Status „veröffentlicht" oder „veröffentlicht\*" zu aktualisieren, rufen Sie eine bearbeitbare Sandbox-Kopie mit ab [RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-sbox-fr "Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit."). Verwenden Sie die sys_IDs aus dieser Antwort, um Eigenschaften mit einem Update-Endpunkt zu ändern.
       {#agnt_clnt_cll-api__ul_mtj_whk_fpb}
    2. Ändern Sie Richtliniendetails mithilfe eines Update-Endpunkts.
       * [VERÖFFENTLICHEN SIE /Agents/Update/Policy/{Policy_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-policy "Aktualisiert eine Sandbox-Kopie einer Richtlinie.")
       * [VERÖFFENTLICHEN SIE /Agents/Update/Check/{Check_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check-id "Aktualisiert eine ausgewählte Richtlinienprüfung.")
       * [VERÖFFENTLICHEN SIE /Agents/Update/Check_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_param "Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.")
       * [VERÖFFENTLICHEN SIE /Agents/Update/Check_Secure_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_secure "Aktualisiert einen ausgewählten sicheren Parameter für die Richtlinienprüfung.")
       {#agnt_clnt_cll-api__ul_mp4_xjk_fpb}
    3. Veröffentlichen Sie die Richtlinie mit [RUFEN SIE /Agents/Policy/published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-publish "Veröffentlicht einen Richtlinienentwurf.").
    {#agnt_clnt_cll-api__ol_rmk_chk_fpb}
:   Nach der Veröffentlichung wird die Richtlinie aktiv. Diese API enthält auch Endpunkte zum Aktivieren oder Deaktivieren einer veröffentlichten Richtlinie:

    * [RUFEN SIE /Agents/Policy/activate/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-act "Aktiviert eine veröffentlichte Richtlinie.")
    * [RUFEN SIE /Agents/Policy/deactivate/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-deact "Deaktiviert eine veröffentlichte Richtlinie.")
    {#agnt_clnt_cll-api__ul_glm_flk_fpb}

## Agent-Clientsammler -- GET /Agents/{Agent_ID} {#ariaid-title2}

Ruft die Informationen eines angegebenen Agenten ab.

### URL-Format

/api/sn_Agent/Agents/{Agent_ID}

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-agent_id__entry__2}

| Name | Beschreibung |
|-|-|
| agent_id | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#agnt_clnt_cll-GET-agent_id__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#agnt_clnt_cll-GET-agent_id__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-agent_id__entry__14}{#agnt_clnt_cll-GET-agent_id__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 4. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-agent_id__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-agent_id__entry__22}{#agnt_clnt_cll-GET-agent_id__entry-200-status-code}{#agnt_clnt_cll-GET-agent_id__agntCC-desc-403-user}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 403 | Der Anwender verfügt nicht über die Rolle „agent_client_collector_user". |
| 404 | Agent mit angegebener ID nicht gefunden. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-agent_id__entry__30}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-version-entry}

| Name | Beschreibung |
|-|-|
| \<Array\> | Array von JSON-Objekten mit erweiterten Agent-Informationen. { "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" } |
| agent_id | ID des Service Desk-Mitarbeiters wie übermittelt. Datentyp: Zeichenfolge |
| Data_Collection | Die Datensammlung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für die Ausführung dieses Service Desk-Mitarbeiters 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 eines hohen CPU-Auslastens durch automatisch deaktiviert {#agnt_clnt_cll-GET-agent_id__ul_w4n_53p_bpb} Datentyp: Zahl |
| ip_address | Agent-IP-Adresse. Datentyp: Zeichenfolge |
| Ist_Duplikat | Kennzeichnung, die angibt, ob dieser Agent ein Duplikat eines anderen ist. Auf einem bestimmten Host darf nur ein einzelner Agent vorhanden sein. Mögliche Werte: * Wahr: Der Agent hat denselben Host wie ein aktiver/aktiver Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat * Falsch: Dieser Agent hat keine Duplikate im Status „aktiv"/„aktiv". {#agnt_clnt_cll-GET-agent_id__ul_b34_ffl_bpb} Datentyp: Boolescher Wert |
| Ist_restart_enabled | Kennzeichnung, die angibt, ob der Neustart aktiviert ist. Neustart des Service Desk-Mitarbeiters ist nicht konfigurierbar. Dies hängt vom Betriebssystem und der Version des Betriebssystems ab, auf dem der Agent ausgeführt wird. Mögliche Werte: * Wahr: Neustart ist für diesen Agent aktiviert. * Falsch: Neustart ist für diesen Agent deaktiviert. {#agnt_clnt_cll-GET-agent_id__ul_bvp_dfl_bpb} Datentyp: Boolescher Wert |
| name | Name des Service Desk-Mitarbeiters. 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 die Ausführung dieses Service Desk-Mitarbeiters geplant sind. Datentyp: Zahl |
| Status | Status des Service Desk-Mitarbeiters. Mögliche Werte: * 0: Aktiv/aktiv: Der Agent ist aktiv. * 1: Warnung: Der Service Desk-Mitarbeiter hat in den letzten Minuten keine Keep-alive-Nachricht erhalten. * 2: Ausgefallen: Der Service Desk-Mitarbeiter hat seit langer Zeit keine Keep-alive-Nachricht erhalten. * 3: Wird neu gestartet: Der Agent wird neu gestartet. {#agnt_clnt_cll-GET-agent_id__ul_adg_ffp_bpb} Datentyp: Zahl |
| Up_seit | UTC-Zeit, seit der Status des Service Desk-Mitarbeiters „aktiv"/„aktiv" wurde. Der Wert ist in [GlideDateTime](https://servicenow-prod.fluidtopics.net/3E4k~hw2Yf_nMTVTCjn4Xw#c_GlideDateTimeScoped "Der Umfang ist festgelegt GlideDateTime Die Klasse stellt Methoden zum Ausführen von Vorgängen für GlideDateTime-Objekte bereit.")Format. Datentyp: Zeichenfolge |
| Version | Version von Agent Client CollectorDer Agent wird ausgefü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-Clientsammler -- RUFT /Agents/{Agent_ID}/Data/off ab {#ariaid-title3}

Deaktiviert die Datensammlung für einen angegebenen Agent im Status „aktiv"/„aktiv".
Um zu bestimmen, ob die Datensammlung eines Service Desk-Mitarbeiters aktiviert oder deaktiviert ist, führen Sie aus RUFEN SIE /Agents/{Agent_ID} AB Endpunkt.

### URL-Format {#agnt_clnt_cll-GET-data-off__section_bbq_zyc_z4b}

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-data-off__section_cbq_zyc_z4b}

{#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| agent_id | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfad-Parameter]

{#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 8. Abfrageparameter]

{#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b}

### Header {#agnt_clnt_cll-GET-data-off__section_gbq_zyc_z4b}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-off__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 10. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

{#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b}

### Statuscodes {#agnt_clnt_cll-GET-data-off__section_jbq_zyc_z4b}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-off__entry-200-status-code}{#agnt_clnt_cll-GET-data-off__agntCC-desc-403-admin}

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

{#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-data-off__section_nwl_zyc_z4b}

{#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b}  

### Curl-Anforderung {#agnt_clnt_cll-GET-data-off__example_nbq_zyc_z4b}

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

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

Ausgabe:

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

## Agent-Clientsammler -- RUFT /Agents/{Agent_ID}/Data/on ab {#ariaid-title4}

Aktiviert die Datensammlung für einen angegebenen Agent im Status „aktiv"/„aktiv".
Um zu bestimmen, ob die Datensammlung eines Service Desk-Mitarbeiters aktiviert oder deaktiviert ist, führen Sie aus RUFEN SIE /Agents/{Agent_ID} AB Endpunkt.

### URL-Format {#agnt_clnt_cll-GET-data-on__section_dwl_zyc_z4b}

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-data-on__section_ewl_zyc_z4b}

{#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| agent_id | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt. Datentyp: Zeichenfolge |
[Tabelle : 13. Pfad-Parameter]

{#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 14. Abfrageparameter]

{#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 15. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b}

### Header {#agnt_clnt_cll-GET-data-on__section_iwl_zyc_z4b}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-on__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 16. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Antwort-Header]

{#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b}

### Statuscodes {#agnt_clnt_cll-GET-data-on__section_lwl_zyc_z4b}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-on__entry-200-status-code}{#agnt_clnt_cll-GET-data-on__agntCC-desc-403-admin}

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

{#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-data-on__section_nwl_zyc_z4b}

{#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b}  

### Curl-Anforderung {#agnt_clnt_cll-GET-data-on__example_pwl_zyc_z4b}

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

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

Ausgabe:

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

## Agent-Clientsammler -- RUFT /Agents/{Agent_ID}/Discovery AB {#ariaid-title5}

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

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-discovery__section_ewl_zyc_z4b}

{#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| agent_id | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt. Datentyp: Zeichenfolge |
[Tabelle : 19. Pfad-Parameter]

{#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 20. Abfrageparameter]

{#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 21. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b}

### Header {#agnt_clnt_cll-GET-discovery__section_iwl_zyc_z4b}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-discovery__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 22. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 23. Antwort-Header]

{#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b}

### Statuscodes {#agnt_clnt_cll-GET-discovery__section_lwl_zyc_z4b}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-discovery__entry-200-status-code}{#agnt_clnt_cll-GET-discovery__agntCC-desc-403-admin}

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

{#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-discovery__section_nwl_zyc_z4b}

{#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b}  

### Curl-Anforderung

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

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

Ausgabe:

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

## Agent-Clientsammler -- GET /Agents/Check_defs/{Check_def_ID} {#ariaid-title6}

Ruft eine angegebene Prüfungsdefinition mit Details ab.

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-check_defs-id__entry__2}

| 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 : 25. Pfad-Parameter]

{#agnt_clnt_cll-GET-check_defs-id__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 26. Abfrageparameter]

{#agnt_clnt_cll-GET-check_defs-id__entry__10}

| Name | Beschreibung |
|-|-|
| X-include-Check-Parameters | Kennzeichnung, die angibt, ob vorhandene Prüfparameterdetails zurückgegeben werden. Informationen für jeden Standard- und sicheren Prüfparameter sind in einem JSON-Objekt enthalten. Gültige Werte: * Wahr: Details zum Prüfparameter zurückgeben. * Falsch: Prüfparameterdetails nicht zurückgeben. {#agnt_clnt_cll-GET-check_defs-id__ul_pv3_gqc_wqb} Datentyp: Boolescher Wert Standard: Falsch |
[Tabelle : 27. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-check_defs-id__entry__14}{#agnt_clnt_cll-GET-check_defs-id__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 28. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-check_defs-id__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 29. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-check_defs-id__entry__22}{#agnt_clnt_cll-GET-check_defs-id__entry-200-status-code}

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

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-check_defs-id__entry__28}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-timeout-desc-ph}

| Eigenschaften | Beschreibung |
|-|-|
| Überprüfen | Details der angegebenen Prüfungsdefinition. { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "error": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } |
| Hintergrund | Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Agent startet und nicht wartet, bis sie abgeschlossen ist. Gültige Werte: * Wahr: Diese Prüfungsdefinition ist eine Hintergrundprüfung. * Falsch: Diese Prüfungsdefinition ist keine Hintergrundprüfung. {#agnt_clnt_cll-GET-check_defs-id__ul_ypb_5ps_5qb} Datentyp: Boolescher Wert |
| Check_Group | Gruppe, die für diese Prüfungsdefinition angegeben ist. Datentyp: Zeichenfolge |
| Check_type | Typ der Prüfung. Mögliche Werte: * Ereignisse: Prüfergebnisse werden in ein Ereignismanagement-Ereignis umgewandelt. * Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt. {#agnt_clnt_cll-GET-check_defs-id__ul_gtr_kfb_wqb} Datentyp: Zeichenfolge |
| command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Datentyp: Zeichenfolge |
| Fehler | Meldung, wenn ein Fehler vorliegt. Andernfalls Null. Datentyp: Zeichenfolge |
| name | Name der Prüfung. Datentyp: Zeichenfolge |
| params | Liste der Parameterdefinitionen, die der Prüfungsdefinition zugeordnet sind. Diese Ergebnisse werden nur berücksichtigt, wenn withParamsParameter ist auf „wahr" festgelegt. "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-code} Datentyp: Array |
| Parameter.aktiv | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Der Prüfparameter ist aktiv. * Falsch: Der Prüfparameter ist inaktiv. {#agnt_clnt_cll-GET-check_defs-id__ul_pnb_jyc_wqb} Datentyp: Boolescher Wert |
| params.default_value | Gibt den Standardwert für diesen Prüfparameter an. Datentyp: Zeichenfolge |
| Parameter.obligatorisch | Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist. Gültige Werte: * Wahr: Der Prüfparameter ist erforderlich. * Falsch: Der Prüfparameter ist optional. {#agnt_clnt_cll-GET-check_defs-id__ul_wtg_2zc_wqb} Datentyp: Boolescher Wert |
| params.name | Name des Prüfparameters. Datentyp: Zeichenfolge |
| Params.sys_ID | SYS_ID des Prüfparameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen" \[sn_agent_check_param_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| Plugins | Liste von [Agent Client CollectorPlugins](https://www.servicenow.com/docs/access?context=acc-assets&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US)Dieser Prüfung zugeordnet. Datentyp: Array |
| Proxy_valid | Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie so festgelegt ist, dass sie als Proxy funktioniert. Gültige Werte: * Wahr: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy funktioniert. * Falsch: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt. {#agnt_clnt_cll-GET-check_defs-id__ul_wbf_qps_5qb} Datentyp: Boolescher Wert |
| Secure_params | Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse werden nur berücksichtigt, wenn withParamsParameter ist auf „wahr" festgelegt. "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-code} Datentyp: Array |
| Secure_params.Active | Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist. Gültige Werte: * Wahr: Der sichere Parameter ist aktiv. * Falsch: Der sichere Parameter ist inaktiv. {#agnt_clnt_cll-GET-check_defs-id__ul_g1b_3vc_wqb} Datentyp: Boolescher Wert |
| secure_params.name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| Secure_params.order | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zahl |
| Secure_params.sys_ID | SYS_ID des sicheren Parameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen" \[sn_agent_check_secure_param_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| Zeitüberschreitung | Zeitüberschreitung in Sekunden. Datentyp: Zahl |
[ ]

### Curl-Anforderung

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

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

Ausgabe:

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

## Agent-Clientsammler -- GET /Agents/Check_defs/list {#ariaid-title7}

Ruft eine Liste von Prüfungsdefinitionen mit Details ab.

### URL-Format

/api/sn_Agent/Agents/Check_defs/list

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-check_defs-list__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 31. Pfad-Parameter]

{#agnt_clnt_cll-GET-check_defs-list__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 32. Abfrageparameter]

{#agnt_clnt_cll-GET-check_defs-list__entry__10}

| Name | Beschreibung |
|-|-|
| X-Enc-Abfrage | Ein [Codierte Abfragezeichenfolge](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US)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-Parameters | Kennzeichnung, die angibt, ob vorhandene Prüfparameterdetails zurückgegeben werden. Informationen für jeden Standard- und sicheren Prüfparameter sind in einem JSON-Objekt enthalten. Gültige Werte: * Wahr: Details zum Prüfparameter zurückgeben. * Falsch: Prüfparameterdetails nicht zurückgeben. {#agnt_clnt_cll-GET-check_defs-list__ul_pv3_gqc_wqb} Datentyp: Boolescher Wert Standard: Falsch |
| X-Limit | Begrenzt die Anzahl der zurückgegebenen Datensätze. Auf Null festlegen, um den Standardwert zu verwenden. Datentyp: Zahl Standard: 20.000 |
[Tabelle : 33. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-check_defs-list__entry__18}{#agnt_clnt_cll-GET-check_defs-list__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 34. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 35. Antwort-Header]

{#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb}

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-check_defs-list__entry__26}{#agnt_clnt_cll-GET-check_defs-list__entry-200-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
[Tabelle : 36. Statuscodes]

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-check_defs-list__entry__30}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-timeout-desc-ph}

| Name | Beschreibung |
|-|-|
| Definitionen überprüfen | Liste der Prüfungsdefinition und -Details, die als JSON-Objekte bereitgestellt werden. [ { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } ] Datentyp: Array |
| Hintergrund | Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Agent startet und nicht wartet, bis sie abgeschlossen ist. Gültige Werte: * Wahr: Diese Prüfungsdefinition ist eine Hintergrundprüfung. * Falsch: Diese Prüfungsdefinition ist keine Hintergrundprüfung. {#agnt_clnt_cll-GET-check_defs-list__ul_ypb_5ps_5qb} Datentyp: Boolescher Wert |
| Check_Group | Gruppe, die für diese Prüfungsdefinition angegeben ist. Datentyp: Zeichenfolge |
| Check_type | Typ der Prüfung. Mögliche Werte: * Ereignisse: Prüfergebnisse werden in ein Ereignismanagement-Ereignis umgewandelt. * Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt. {#agnt_clnt_cll-GET-check_defs-list__ul_gtr_kfb_wqb} Datentyp: Zeichenfolge |
| command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Datentyp: Zeichenfolge |
| name | Name der Prüfung. Datentyp: Zeichenfolge |
| params | Liste der Parameterdefinitionen, die der Prüfungsdefinition zugeordnet sind. Diese Ergebnisse werden nur berücksichtigt, wenn withParamsParameter ist auf „wahr" festgelegt. "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-code} Datentyp: Array |
| Parameter.aktiv | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Der Prüfparameter ist aktiv. * Falsch: Der Prüfparameter ist inaktiv. {#agnt_clnt_cll-GET-check_defs-list__ul_pnb_jyc_wqb} Datentyp: Boolescher Wert |
| params.default_value | Gibt den Standardwert für diesen Prüfparameter an. Datentyp: Zeichenfolge |
| Parameter.obligatorisch | Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist. Gültige Werte: * Wahr: Der Prüfparameter ist erforderlich. * Falsch: Der Prüfparameter ist optional. {#agnt_clnt_cll-GET-check_defs-list__ul_wtg_2zc_wqb} Datentyp: Boolescher Wert |
| params.name | Name des Prüfparameters. Datentyp: Zeichenfolge |
| Params.sys_ID | SYS_ID des Prüfparameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen" \[sn_agent_check_param_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| Plugins | Liste von [Agent Client CollectorPlugins](https://www.servicenow.com/docs/access?context=acc-assets&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US)Dieser Prüfung zugeordnet. Datentyp: Array |
| Proxy_valid | Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie so festgelegt ist, dass sie als Proxy funktioniert. Gültige Werte: * Wahr: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy funktioniert. * Falsch: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt. {#agnt_clnt_cll-GET-check_defs-list__ul_wbf_qps_5qb} Datentyp: Boolescher Wert |
| Secure_params | Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse werden nur berücksichtigt, wenn withParamsParameter ist auf „wahr" festgelegt. "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-code} Datentyp: Array |
| Secure_params.Active | Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist. Gültige Werte: * Wahr: Der sichere Parameter ist aktiv. * Falsch: Der sichere Parameter ist inaktiv. {#agnt_clnt_cll-GET-check_defs-list__ul_g1b_3vc_wqb} Datentyp: Boolescher Wert |
| secure_params.name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| Secure_params.order | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zahl |
| Secure_params.sys_ID | SYS_ID des sicheren Parameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen" \[sn_agent_check_secure_param_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| Zeitüberschreitung | Zeitüberschreitung in Sekunden. Datentyp: Zahl |
[ ]

### Curl-Anforderung

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

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

Ausgabe:

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

## Agent-Clientsammler -- GET /Agents/exec/background/stop/{Request_ID} {#ariaid-title8}

Stoppt eine Hintergrundprüfung.
Verwenden Sie zum Starten einer Hintergrundprüfung VERÖFFENTLICHEN SIE /Agents/Check_defs/{Check_def_ID}/Run API.

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__2}

| Name | Beschreibung |
|-|-|
| request_id | Die ID einer Hintergrundprüfungsanforderung, die durch Ausführen von generiert wurde VERÖFFENTLICHEN SIE /Agents/Check_defs/{Check_def_ID}/Run API. |
[Tabelle : 37. Pfad-Parameter]

{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 38. Abfrageparameter]

{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 39. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__14}{#agnt_clnt_cll-GET-exec-bkgrd-stop__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 40. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 41. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__22}{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry-200-status-code}

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

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__28}

| Name | Beschreibung |
|-|-|
| Keine |   |
[ ]

### Curl-Anforderung

Das folgende Beispiel zeigt, wie eine Hintergrundprüfung gestoppt 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-Clientsammler -- GET /Agents/exec/Run/{Request_ID} {#ariaid-title9}

Ruft den Status der Anforderung mit der angegebenen ID ab.

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| request_id | Die ID einer Hintergrundprüfungsanforderung, die durch Ausführen von generiert wurde VERÖFFENTLICHEN SIE /Agents/Check_defs/{Check_def_ID}/Run API. |
[Tabelle : 43. Pfad-Parameter]

{#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb} {#agnt_clnt_cll-GET-exec-run__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 44. Abfrageparameter]

{#agnt_clnt_cll-GET-exec-run__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 45. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-exec-run__entry__14}{#agnt_clnt_cll-GET-exec-run__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 46. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-exec-run__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 47. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb__entry__2}{#agnt_clnt_cll-GET-exec-run__entry-200-status-code}

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

{#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-exec-run__entry__36}

| Name | Beschreibung |
|-|-|
| Status | Anforderungsstatus. Mögliche Werte: * Fertig: Prüfung ist erfolgreich. * Fehler: Prüfung ist fehlgeschlagen. Details finden Sie in der Fehlermeldung. * Mid_Flow: Anforderungsausgabe wird vom MID-Server verarbeitet. * Verarbeitung: Prüfung wird ausgeführt. * Zeitüberschreitung: Überprüfen Sie, ob die Verarbeitung die in festgelegte Zeitgrenze überschritten hat Ausführen von PrüfForCis() Methode. {#agnt_clnt_cll-GET-exec-run__ul_edm_1rr_5qb} Datentyp: Zeichenfolge |
| err_msg | Fehlermeldung, falls vorhanden. Mögliche Werte: * Keine Service Desk-Mitarbeiter für relevante CIs gefunden. * Keine Hintergrundprüfungsanforderung mit angegebener ID. * Keine Anforderung mit angegebener ID. * Kein Testergebnis mit angegebener ID. * Zeitüberschreitung bei Anforderung. {#agnt_clnt_cll-GET-exec-run__ul_qcf_zcq_5qb} 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-Clientsammler -- GET /Agents/exec/Test/{Test_result_ID} {#ariaid-title10}

Ruft den Testprüfungsstatus des angegebenen Testergebnisses ab.

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-exec-test-result__entry__2}

| Name | Beschreibung |
|-|-|
| Test_result_ID | Eine Testergebnis-ID, die durch Erstellen einer Testprüfungsanforderung generiert wurde. |
[Tabelle : 49. Pfad-Parameter]

{#agnt_clnt_cll-GET-exec-test-result__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 50. Abfrageparameter]

{#agnt_clnt_cll-GET-exec-test-result__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 51. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-exec-test-result__entry__14}{#agnt_clnt_cll-GET-exec-test-result__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 52. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-exec-test-result__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 53. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-exec-test-result__entry__22}{#agnt_clnt_cll-GET-exec-test-result__entry-200-status-code}

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

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-exec-test-result__entry__34}

| Eigenschaften | Beschreibung |
|-|-|
| Status | Status der Testergebnisse. Mögliche Werte: * 0: Ausstehend * 1: In Bearbeitung * 2: Abgeschlossen * 3: Kein Testergebnis mit angegebener ID {#agnt_clnt_cll-GET-exec-test-result__ul_yyq_4bq_5qb} 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-Clientsammler -- GET /Agents/list {#ariaid-title11}

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

### URL-Format

/api/sn_Agent/Agents/list

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-list__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 55. Pfad-Parameter]

{#agnt_clnt_cll-GET-list__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 56. Abfrageparameter]

{#agnt_clnt_cll-GET-list__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 57. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-list__entry__14}{#agnt_clnt_cll-GET-list__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| X-Enc-Abfrage | Codierte Abfrage in der Tabelle „Agenten-Client-Sammler" \[sn_agent_cmdb_ci_agent\] im Standard-Glide-Format. Siehe [Codierte Abfragezeichenfolgen](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). |
| X-Limit | Beschränkt die Ergebnisse auf eine maximale Anzahl von Service Desk-Mitarbeitern. Verwenden Sie null oder nicht definiert für beide, wenn sie nicht erforderlich sind.Standard/Max.: 20.000 Datentyp: Zahl |
[Tabelle : 58. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-list__entry__22}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 59. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-list__table_vxl_353_dpb__entry__2}{#agnt_clnt_cll-GET-list__entry-200-status-code}{#agnt_clnt_cll-GET-list__agntCC-desc-403-user}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 403 | Der Anwender verfügt nicht über die Rolle „agent_client_collector_user". |
[Tabelle : 60. Statuscodes]

{#agnt_clnt_cll-GET-list__table_vxl_353_dpb}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-list__entry__32}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-version-entry}

| Eigenschaft | Beschreibung |
|-|-|
| \<Array\> | Array von JSON-Objekten mit erweiterten Agent-Informationen. [ { "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" } ] |
| agent_id | ID des Service Desk-Mitarbeiters wie übermittelt. Datentyp: Zeichenfolge |
| Data_Collection | Die Datensammlung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für die Ausführung dieses Service Desk-Mitarbeiters 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 eines hohen CPU-Auslastens durch automatisch deaktiviert {#agnt_clnt_cll-GET-list__ul_w4n_53p_bpb} Datentyp: Zahl |
| ip_address | Agent-IP-Adresse. Datentyp: Zeichenfolge |
| Ist_Duplikat | Kennzeichnung, die angibt, ob dieser Agent ein Duplikat eines anderen ist. Auf einem bestimmten Host darf nur ein einzelner Agent vorhanden sein. Mögliche Werte: * Wahr: Der Agent hat denselben Host wie ein aktiver/aktiver Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat * Falsch: Dieser Agent hat keine Duplikate im Status „aktiv"/„aktiv". {#agnt_clnt_cll-GET-list__ul_b34_ffl_bpb} Datentyp: Boolescher Wert |
| Ist_restart_enabled | Kennzeichnung, die angibt, ob der Neustart aktiviert ist. Neustart des Service Desk-Mitarbeiters ist nicht konfigurierbar. Dies hängt vom Betriebssystem und der Version des Betriebssystems ab, auf dem der Agent ausgeführt wird. Mögliche Werte: * Wahr: Neustart ist für diesen Agent aktiviert. * Falsch: Neustart ist für diesen Agent deaktiviert. {#agnt_clnt_cll-GET-list__ul_bvp_dfl_bpb} Datentyp: Boolescher Wert |
| name | Name des Service Desk-Mitarbeiters. 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 die Ausführung dieses Service Desk-Mitarbeiters geplant sind. Datentyp: Zahl |
| Status | Status des Service Desk-Mitarbeiters. Mögliche Werte: * 0: Aktiv/aktiv: Der Agent ist aktiv. * 1: Warnung: Der Service Desk-Mitarbeiter hat in den letzten Minuten keine Keep-alive-Nachricht erhalten. * 2: Ausgefallen: Der Service Desk-Mitarbeiter hat seit langer Zeit keine Keep-alive-Nachricht erhalten. * 3: Wird neu gestartet: Der Agent wird neu gestartet. {#agnt_clnt_cll-GET-list__ul_adg_ffp_bpb} Datentyp: Zahl |
| Up_seit | UTC-Zeit, seit der Status des Service Desk-Mitarbeiters „aktiv"/„aktiv" wurde. Der Wert ist in [GlideDateTime](https://servicenow-prod.fluidtopics.net/3E4k~hw2Yf_nMTVTCjn4Xw#c_GlideDateTimeScoped "Der Umfang ist festgelegt GlideDateTime Die Klasse stellt Methoden zum Ausführen von Vorgängen für GlideDateTime-Objekte bereit.")Format. Datentyp: Zeichenfolge |
| Version | Version von Agent Client CollectorDer Agent wird ausgeführt. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Das folgende Beispiel zeigt, wie Ergebnisse nach Abfrage und Nummer eingeschränkt werden. Die Abfrage gibt alle Agenten 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 {#agnt_clnt_cll-GET-list__example_es5_ycj_dpb}

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

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

## Agent-Clientsammler -- RUFT /Agents/{Agent_ID}/log AB {#ariaid-title12}

Fordert das Protokoll eines angegebenen Agenten mit Status „aktiv"/„aktiv" an.
Hinweis:  
Um das Protokoll abzurufen und seinen Fortschritt zu überprüfen, übergeben Sie die an zurückgegebene Anforderungs-ID RUFEN SIE /Agents/log/{Request_ID}/ AB Endpunkt.

### URL-Format {#agnt_clnt_cll-GET-log__section_kpf_zyc_z4b}

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-log__section_ewl_zyc_z4b}

{#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| agent_id | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt. Datentyp: Zeichenfolge |
[Tabelle : 61. Pfad-Parameter]

{#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 62. Abfrageparameter]

{#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 63. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b}

### Header {#agnt_clnt_cll-GET-log__section_iwl_zyc_z4b}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-log__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 64. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 65. Antwort-Header]

{#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b}

### Statuscodes {#agnt_clnt_cll-GET-log__section_lwl_zyc_z4b}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log__entry-200-status-code}{#agnt_clnt_cll-GET-log__agntCC-desc-403-admin}

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

{#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-log__section_upf_zyc_z4b}

{#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| request_id | SYS_ID einer Anforderung in der Tabelle „Agenten-Client-Sammleranforderungen" \[sn_Agent_Request\]. Sie können diese ID verwenden, um das Protokoll abzurufen und seinen Fortschritt mit zu überprüfen RUFEN SIE /Agents/log/{Request_ID}/ AB Endpunkt. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b}  

### Curl-Anforderung

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

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

Ausgabe:

    "request_id": "<sys_id>"

## Agent-Clientsammler -- GET /Agents/log/{Request_ID}/ {#ariaid-title13}

Überprüft den Status einer Anforderung zum Abrufen eines Protokolls.
Erkennt Änderungen in der Protokollabrufanforderung, die mit gesendet wurde RUFT /api/sn_Agent/Agents/{Agent_ID}/log AB .

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-log-request_id__entry__2}

| Name | Beschreibung |
|-|-|
| request_id | SYS_ID einer Anforderung in der Tabelle „Agenten-Client-Sammleranforderungen" \[sn_Agent_Request\]. Führen Sie für die Anforderungs-ID aus RUFT /api/sn_Agent/Agents/{Agent_ID}/log AB . Datentyp: Zeichenfolge |
[Tabelle : 67. Pfad-Parameter]

{#agnt_clnt_cll-GET-log-request_id__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 68. Abfrageparameter]

{#agnt_clnt_cll-GET-log-request_id__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 69. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-log-request_id__entry__14}{#agnt_clnt_cll-GET-log-request_id__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 70. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-log-request_id__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 71. Antwort-Header]

### Statuscodes {#agnt_clnt_cll-GET-log-request_id__section_lwl_zyc_z4b}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log-request_id__agntCC-desc-403-admin}

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

{#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-log-request_id__entry__36}

| Eigenschaften | Beschreibung |
|-|-|
| Ausgabe | Informationen, die den Status beschreiben. |
[ ]

### Curl-Anforderung

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

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

Ausgabe:

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

## Agent-Clientsammler -- GET /Agents/policies/list {#ariaid-title14}

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

### URL-Format

/api/sn_Agent/Agents/policies/list

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-GET-policies-list__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 73. Pfad-Parameter]

{#agnt_clnt_cll-GET-policies-list__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 74. Abfrageparameter]

{#agnt_clnt_cll-GET-policies-list__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 75. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb__entry__2}{#agnt_clnt_cll-GET-policies-list__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| X-Enc-Abfrage | Optional. Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe [Codierte Abfragezeichenfolgen](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). |
| X-include-Check-Parameters | Optional. Kennzeichnung, die angibt, ob Prüfinstanzen und ihre Parameter in den Ergebnissen zurückgegeben werden sollen. Gültige Werte: * Wahr: Schließt Prüfinstanzen und ihre Parameter in die Ergebnisse ein. * Falsch: Prüfinstanzen und ihre Parameter nicht in die Ergebnisse einschließen. {#agnt_clnt_cll-GET-policies-list__ul_xmj_pyw_dpb} Standard: Falsch Datentyp: Boolescher Wert |
| X-include-Checks-and-Service Desk-Mitarbeiter | Optional. Kennzeichnung, die angibt, ob Prüfinstanzen und -Agenten in die Ergebnisse einbezogen werden sollen. Gültige Werte: * Wahr: Schließt Prüfinstanzen und -Agenten in die Ergebnisse ein. * Falsch: Keine Prüfungen und Service Desk-Mitarbeiter in die Ergebnisse einschließen. {#agnt_clnt_cll-GET-policies-list__ul_asz_gvw_dpb} Standard: Falsch Datentyp: Boolescher Wert |
[Tabelle : 76. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb} {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 77. Antwort-Header]

{#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb}

### Statuscodes {#agnt_clnt_cll-GET-policies-list__section_bbd_scx_dpb}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policies-list__entry-200-status-code}{#agnt_clnt_cll-GET-policies-list__agntCC-desc-403-user}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 403 | Der Anwender verfügt nicht über die Rolle „agent_client_collector_user". |
[Tabelle : 78. Statuscodes]

{#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-policies-list__entry__34}{#agnt_clnt_cll-GET-policies-list__agntCC-ph-rb-checks-sbox}

| Eigenschaft | Beschreibung |
|-|-|
| Richtlinien | Liste der abgerufenen Richtlinien. Schließt Prüfungen und Service Desk-Mitarbeiter in den Ergebnissen ein, wenn sie mithilfe bestimmter Anforderungsheader abgefragt werden. Informationen zu Richtlinien finden Sie unter [Standardprüfungen und -Richtlinien](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US). { "policies": [ { "active": Boolean, "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } ] } Datentyp: Array |
| Richtlinien.aktiv | Kennzeichnung, die angibt, ob die Richtlinie aktiv ist. Gültige Werte: * Wahr: Richtlinie ist aktiv. * Falsch: Richtlinie ist nicht aktiv. {#agnt_clnt_cll-GET-policies-list__ul_qr2_g3x_dpb} Datentyp: Boolescher Wert |
| Policys.Agent_IDs | Eindeutige ID eines Service Desk-Mitarbeiters. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Checks-And-AgentsHeader-Parameter ist auf „wahr" festgelegt. Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID in aus [RUFEN SIE /Agents/{Agent_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-agent_id "Ruft die Informationen eines angegebenen Agenten ab.")Endpunkt. Datentyp: Zeichenfolge Tabelle: In der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler" \[sn_agent_cmdb_ci_agent\]. |
| policies.checks | Liste der Objekte, die Prüfungen definieren, die in der Tabelle „Prüfinstanzen" \[sn_Agent_Check\] aufgeführt sind. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Checks-And-AgentsOder X-Include-Check-ParamsHeader-Parameter ist auf „wahr" festgelegt. Datentyp: Array von Objekten "checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ] {#agnt_clnt_cll-GET-policies-list__agntCC-code-rb-checks-sbox} Tabelle: |
| policies.checks.active | Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist. Gültige Werte: * Wahr: Richtlinienprüfung ist aktiv. * Falsch: Richtlinienprüfung ist inaktiv. {#agnt_clnt_cll-GET-policies-list__ul_j2p_sdt_2pb} Datentyp: Boolescher Wert |
| policies.checks.auto_generate | Kennzeichnung, die angibt, ob der Befehl automatisch mit generiert werden soll command_prefixWert. Gültige Werte: * Wahr: Füllen Sie automatisch aus commandEigenschaft mit aktiven Parameterwerten. * Falsch: Befehl wird nicht automatisch generiert. {#agnt_clnt_cll-GET-policies-list__ul_myc_x2t_2pb} Datentyp: Boolescher Wert |
| policies.checks.check_type | Prüftyp, der die Überwachungsoption angibt. Mögliche Werte: * Discovery: Überprüfen Sie, ob CIs im Zusammenhang mit dem Agent gefunden werden. * Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt. * Metriken: Die Werte aus dem Prüfergebnis werden in Metriken umgewandelt. {#agnt_clnt_cll-GET-policies-list__ul_pgd_42t_2pb} Datentyp: Zeichenfolge |
| policies.checks.command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Parameter aus einer Vorlage oder einem überwachten CI. Hinweis: Wenn auto_generateIst „wahr", wird diese Eigenschaft automatisch mit dem Präfix und den Kennzeichnungen der aktiven Parameter ausgefüllt, die in aufgeführt sind parametersObjekt. Datentyp: Zeichenfolge |
| policies.checks.command_prefix | Wenn auto_generateEigenschaft ist „wahr". Dieser Befehl wird für die automatische Generierung verwendet. Das Präfix besteht aus einem beliebigen Teil des Befehls, der statisch ist (sich nicht ändert), z. B. dem Skriptnamen. Datentyp: Zeichenfolge |
| policies.checks.event_status_change_threshold | Anzahl der aufeinanderfolgenden Male, die der Antwortstatus eines Schecks erfolgen muss, bevor ein neues Ereignis gesendet wird. Gibt Null zurück, wenn nicht festgelegt. Wenn dieser Wert beispielsweise 3 ist, generiert eine Prüfung, deren Antwortstatus sich von OK in Fehler ändert, ein neues Ereignis mit einem Fehlerstatus nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung. Datentyp: Zahl |
| policies.checks.event_status_repair_threshold | Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus eines Schecks verbessern muss, um das vorherige Ereignis zu schließen. Gibt Null zurück, wenn nicht festgelegt. Wenn dieser Wert beispielsweise 3 ist, schließt eine Prüfung, deren Antwortstatus von „Fehler" in „OK" geändert wird, das vorherige Ereignis und generiert ein neues Ereignis mit dem Status „OK" nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung. Datentyp: Zahl |
| policies.checks.interval | Wartezeit in Sekunden zwischen Prüfungsausführungen. Beispiel: Ein Wert von 60 bedeutet, dass die Prüfung alle 60 Sekunden ausgeführt wird. Datentyp: Zahl |
| policies.checks.name | Name der Prüfung. Datentyp: Zeichenfolge |
| policies.checks.sys_id | SYS_ID der Prüfung. Datentyp: Zeichenfolge Tabelle: Instanzen überprüfen \[sn_Agent_Check\] |
| policies.checks.timeout | Zeit in Sekunden, nach der die Prüfungsausführung angehalten wird, wenn keine Ausgabe zurückgegeben wird. Beispiel: Ein Wert von 60 bedeutet, dass die Ausführung der Prüfung angehalten wird, wenn die Ausführung 60 Sekunden lang keinen Wert zurückgibt. Datentyp: Zeichenfolge |
| Policies.cred_alias | Anmeldeinformationsname. Datentyp: Zeichenfolge Tabelle: Anmeldeinformationen \[Discovery_credentials\] |
| Policies.credential_alias | SYS_ID des Anmeldeinformationsalias. Datentyp: Zeichenfolge Tabelle: Aliasse für Verbindungen und Anmeldeinformationen \[sys_alias\] |
| Richtlinien.Filter | Filter, der die Prüfungen der Richtlinie einschränkt, um nur die angegebenen Kriterien zu überwachen. Datentyp: Zeichenfolge |
| policies.interval | Wartezeit in Sekunden zwischen Richtlinienprüfungen. Beispiel: Ein Wert von 60 bedeutet, dass die Prüfung alle 60 Sekunden ausgeführt wird. Hinweis: Der Wert von checks.intervalEigenschaft überschreibt den in diesem Feld konfigurierten Wert. Datentyp: Zahl |
| Policies.monitoring_ci_Group | Name von [CMDB-Gruppen](https://www.servicenow.com/docs/access?context=cmdb-groups&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)Ist der Richtlinie zugeordnet. Dieses Feld wird nur angewendet, wenn der Wert von monitored_ci_type_group Eigenschaft ist „wahr". Datentyp: Zeichenfolge Tabelle: CMDB-Gruppen \[cmdb_Group\] |
| Policies.monitoring_ci_script | Skript für die Überwachung von CIs. Dieses Feld wird nur angewendet, wenn der Wert von policies.monitored_ci_type_scriptEigenschaft ist „wahr". Datentyp: Zeichenfolge |
| policies.monitored_ci_type_filter | Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in aufgeführt tableEigenschaft. Gültige Werte: * Wahr: Das Filtern nach Prüfungsgruppe ist aktiviert. * Falsch: Das Filtern nach Prüfungsgruppe ist deaktiviert. {#agnt_clnt_cll-GET-policies-list__ul_tvm_fvt_2pb} Datentyp: Boolescher Wert |
| policies.monitored_ci_type_group | Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist. Gültige Werte: * Wahr: CMDB-Gruppentyp ist aktiviert. * Falsch: CMDB-Gruppentyp ist deaktiviert. {#agnt_clnt_cll-GET-policies-list__ul_jrc_fvt_2pb} Datentyp: Boolescher Wert |
| policies.monitored_ci_type_script | Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist. Gültige Werte: * Wahr: Skript für die Überwachung von CIs ist aktiviert. * Falsch: Skript für die Überwachung von CIs ist deaktiviert. {#agnt_clnt_cll-GET-policies-list__ul_bs4_3wt_2pb} Datentyp: Boolescher Wert |
| policies.name | Name der Richtlinie Datentyp: Zeichenfolge |
| Policys.published_Status | Gibt an, ob die Richtlinie veröffentlicht wird. Mögliche Werte: * Entwurf: Richtlinie wurde nicht veröffentlicht und kann mit den Update-Endpunkten bearbeitet werden. * Veröffentlicht: Richtlinie wird veröffentlicht. Der Entwurf (Sandbox-Kopie) und die veröffentlichte Kopie sind identisch. * Veröffentlicht\*: Richtlinie wird veröffentlicht, aber die Entwurfskopie (Sandbox-Ansicht) weist Änderungen auf, die in der veröffentlichten Kopie nicht gefunden wurden. {#agnt_clnt_cll-GET-policies-list__ul_d3k_qzm_fpb} Datentyp: Zeichenfolge |
| Policys.sys_ID | SYS_ID der Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinien \[sn_Agent_Policy\] |
| Policys.sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung der Richtlinie. Datentyp: Zeichenfolge |
| Richtlinien.Tabelle | Überwachtes CI-Typfeld in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filterIst „wahr". Datentyp: Zeichenfolge |
| Richtlinien.Parameter | Liste von Objekten mit Informationen zu Prüfparametern. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr" festgelegt. Datentyp: Array von Objekten "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] Tabelle: Parameter überprüfen \[sn_agent_check_param\] |
| policies.params.active | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Prüfparameter ist aktiv. * Falsch: Prüfparameter ist inaktiv. {#agnt_clnt_cll-GET-policies-list__ul_u2x_5fv_2pb} Datentyp: Boolescher Wert |
| Richtlinien.Parameter.Kennzeichnung | Parameterkennzeichnung, die während des Prüfaufrufs verwendet werden soll. Datentyp: Zeichenfolge |
| Richtlinien.Parameter.obligatorisch | Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist. Gültige Werte: * Wahr: Diese Prüfung ist obligatorisch. * Falsch: Diese Prüfung ist optional. {#agnt_clnt_cll-GET-policies-list__ul_flq_qkv_2pb} Datentyp: Boolescher Wert |
| policies.params.name | Name des Parameters. Datentyp: Zeichenfolge |
| Richtlinien.Parameter.sys_ID | SYS_ID des Parameters. Datentyp: Zeichenfolge Tabelle: Parameter überprüfen \[sn_agent_check_param\] |
| Richtlinien.Parameter.Wert | Wert des Parameters. Datentyp: Zeichenfolge |
| Richtlinien.Parameter.Wert_erforderlich | Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind. Gültige Werte: * Wahr: Die Werteigenschaft ist erforderlich. * Falsch: Die Werteigenschaft ist null oder nicht erforderlich. {#agnt_clnt_cll-GET-policies-list__ul_ug3_3jv_2pb} Datentyp: Boolescher Wert |
| policies.secure_params | Liste von Objekten, die Informationen zu sicheren Parametern für die Prüfung enthalten. Weitere Informationen finden Sie unter [Erstellen Sie einen sicheren Parameter für eine Prüfung](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US). Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr" festgelegt. Datentyp: Array von Objekten "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] Tabelle: Sichere Parameter überprüfen \[sn_agent_check_secure_param\] |
| policies.secure_params.active | Kennzeichnung, die angibt, ob der Parameter „sichere Prüfung" aktiv ist. Gültige Werte: * Wahr: Der Parameter „sichere Prüfung" ist aktiv. * Falsch: Der Parameter „sichere Prüfung" ist inaktiv. {#agnt_clnt_cll-GET-policies-list__ul_xwy_vfv_2pb} Datentyp: Boolescher Wert |
| policies.secure_params.name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| policies.secure_params.order | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zahl |
| policies.secure_params.sys_id | SYS_ID des Datensatzes. Datentyp: Zeichenfolge Tabelle: Sicheren Parameter \[sn_agent_check_secure_param\] überprüfen |
[Tabelle : 79. Objekt]

### Curl-Anforderung {#agnt_clnt_cll-GET-policies-list__example_dy2_wbx_dpb}

Das folgende Beispiel zeigt, wie Ergebnisse nach Abfrage und Nummer eingeschränkt werden. Die Abfrage gibt alle aktiven Richtlinien und die ID des zugehörigen Agenten 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-Clientsammler -- GET /Agents/Policy/activate/{Policy_ID} {#ariaid-title15}

Aktiviert eine veröffentlichte Richtlinie.
Verwenden Sie für eine Liste der veröffentlichten Richtlinien [RUFT /Agents/policies/list AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policies-list "Ruft eine Liste von Richtlinien ab, die sich im Status „veröffentlicht“ oder „unveröffentlicht“ befinden."). Dieser Endpunkt unterstützt nur sys_IDs, in denen der Wert der Richtlinie gilt publish_statusEigenschaft ist `Veröffentlicht `Oder `Veröffentlicht* `.

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-policy-act__section_g4n_tcx_dpb}

{#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-act__agntCC-entry-parm-policyID-pub}

| Name | Beschreibung |
|-|-|
| policy_id | SYS_ID der veröffentlichten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinien \[sn_Agent_Policy\] |
[Tabelle : 80. Pfad-Parameter]

{#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 81. Abfrageparameter]

{#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 82. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb}

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-act__entry__14}{#agnt_clnt_cll-GET-policy-act__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 83. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-policy-act__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 84. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-act__entry-200-status-code}{#agnt_clnt_cll-GET-policy-act__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-act__entry-500-status-code}

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

{#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb__entry__2}

| Header | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb}  

### 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-Clientsammler -- GET /Agents/Policy/deactivate/{Policy_ID} {#ariaid-title16}

Deaktiviert eine veröffentlichte Richtlinie.
Verwenden Sie für eine Liste der veröffentlichten Richtlinien [RUFT /Agents/policies/list AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policies-list "Ruft eine Liste von Richtlinien ab, die sich im Status „veröffentlicht“ oder „unveröffentlicht“ befinden."). Dieser Endpunkt unterstützt nur sys_IDs, in denen der Wert der Richtlinie gilt publish_statusEigenschaft ist `Veröffentlicht `Oder `Veröffentlicht* `.

### URL-Format {#agnt_clnt_cll-GET-policy-deact__section_f4n_tcx_dpb}

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-policy-deact__section_g4n_tcx_dpb}

{#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-deact__agntCC-entry-parm-policyID-pub}

| Name | Beschreibung |
|-|-|
| policy_id | SYS_ID der veröffentlichten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinien \[sn_Agent_Policy\] |
[Tabelle : 86. Pfad-Parameter]

{#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb} {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 87. Abfrageparameter]

{#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 88. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb}

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb__entry__2}{#agnt_clnt_cll-GET-policy-deact__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 89. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 90. Antwort-Header]

{#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb}

### Statuscodes {#agnt_clnt_cll-GET-policy-deact__section_n4n_tcx_dpb}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-deact__entry-200-status-code}{#agnt_clnt_cll-GET-policy-deact__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-deact__entry-500-status-code}

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

{#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-policy-deact__section_znm_1mq_fpb}

{#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb__entry__2}

| Header | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb}  

### Curl-Anforderung {#agnt_clnt_cll-GET-policy-deact__example_bgj_chs_2pb}

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-Clientsammler -- GET /Agents/Policy/published/{Policy_ID} {#ariaid-title17}

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

* [VERÖFFENTLICHEN SIE /Agents/Update/Policy/{Policy_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-policy "Aktualisiert eine Sandbox-Kopie einer Richtlinie.")
* [VERÖFFENTLICHEN SIE /Agents/Update/Check/{Check_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check-id "Aktualisiert eine ausgewählte Richtlinienprüfung.")
* [VERÖFFENTLICHEN SIE /Agents/Update/Check_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_param "Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.")
* [VERÖFFENTLICHEN SIE /Agents/Update/Check_Secure_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_secure "Aktualisiert einen ausgewählten sicheren Parameter für die Richtlinienprüfung.")
{#agnt_clnt_cll-GET-policy-publish__ul_p14_jbh_fpb}

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-policy-publish__section_g4n_tcx_dpb}

{#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| policy_id | SYS_ID einer Richtlinie in der Tabelle „Richtlinien" \[sn_Agent_Policy\], die sich im Status „Entwurf" oder einer Sandbox-Kopie befindet. * Verwenden Sie für eine Liste von Richtlinien und Details, einschließlich Veröffentlichungsstatus [RUFT /Agents/policies/list AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policies-list "Ruft eine Liste von Richtlinien ab, die sich im Status „veröffentlicht“ oder „unveröffentlicht“ befinden."). * Verwenden Sie zum Abrufen der Sandbox-Kopie einer Richtlinie [RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-sbox-fr "Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit."). {#agnt_clnt_cll-GET-policy-publish__ul_icv_npn_fpb} Datentyp: Zeichenfolge |
[Tabelle : 92. Pfad-Parameter]

{#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 93. Abfrageparameter]

{#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 94. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb}

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-publish__entry__14}{#agnt_clnt_cll-GET-policy-publish__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 95. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-policy-publish__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 96. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-publish__entry-200-status-code}{#agnt_clnt_cll-GET-policy-publish__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-publish__entry-500-status-code}

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

{#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-policy-publish__section_m1q_bmq_fpb}

{#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb__entry__2}

| Header | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb}  

### 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-Clientsammler -- RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} ab {#ariaid-title18}

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

* [VERÖFFENTLICHEN SIE /Agents/Update/Policy/{Policy_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-policy "Aktualisiert eine Sandbox-Kopie einer Richtlinie.")
* [VERÖFFENTLICHEN SIE /Agents/Update/Check/{Check_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check-id "Aktualisiert eine ausgewählte Richtlinienprüfung.")
* [VERÖFFENTLICHEN SIE /Agents/Update/Check_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_param "Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.")
* [VERÖFFENTLICHEN SIE /Agents/Update/Check_Secure_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_secure "Aktualisiert einen ausgewählten sicheren Parameter für die Richtlinienprüfung.")
{#agnt_clnt_cll-GET-policy-sbox-fr__ul_p14_jbh_fpb}

Verwenden Sie für eine Liste der veröffentlichten Richtlinien [RUFT /Agents/policies/list AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policies-list "Ruft eine Liste von Richtlinien ab, die sich im Status „veröffentlicht“ oder „unveröffentlicht“ befinden."). Dieser Endpunkt unterstützt nur sys_IDs, in denen der Wert der Richtlinie gilt publish_statusEigenschaft ist `Veröffentlicht `Oder `Veröffentlicht* `.

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-policy-sbox-fr__section_g4n_tcx_dpb}

{#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-entry-parm-policyID-pub}

| Name | Beschreibung |
|-|-|
| policy_id | SYS_ID der veröffentlichten Richtlinie. Datentyp: Zeichenfolge Tabelle: Richtlinien \[sn_Agent_Policy\] |
[Tabelle : 98. Pfad-Parameter]

{#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 99. Abfrageparameter]

{#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 100. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb}

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-sbox-fr__entry__14}{#agnt_clnt_cll-GET-policy-sbox-fr__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 101. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-policy-sbox-fr__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 102. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-200-status-code}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-500-status-code}

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

{#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-GET-policy-sbox-fr__entry__32}

| Eigenschaft | Beschreibung |
|-|-|
| \<Object\> | Erweiterte Details der Sandbox-Kopie, die der Richtlinie zugeordnet ist. Informationen zu Richtlinien finden Sie unter [Standardprüfungen und -Richtlinien](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US). { "active": Boolean" "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } |
| aktiv | Kennzeichnung, die angibt, ob die Richtlinie aktiv ist. Gültige Werte: * Wahr: Richtlinie ist aktiv. * Falsch: Richtlinie ist nicht aktiv. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_qr2_g3x_dpb} Datentyp: Boolescher Wert |
| agent_ids | Eindeutige ID eines Service Desk-Mitarbeiters. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Checks-And-AgentsHeader-Parameter ist auf „wahr" festgelegt. Um erweiterte Informationen zu einem Service Desk-Mitarbeiter zu erhalten, führen Sie die ID in aus [RUFEN SIE /Agents/{Agent_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-agent_id "Ruft die Informationen eines angegebenen Agenten ab.")Endpunkt. Datentyp: Zeichenfolge Tabelle: In der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler" \[sn_agent_cmdb_ci_agent\]. |
| Prüfungen | Liste der Objekte, die Prüfungen definieren, die in der Tabelle „Prüfinstanzen" \[sn_Agent_Check\] aufgeführt sind. "checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ] Datentyp: Array |
| Prüfungen.aktiv | Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist. Gültige Werte: * Wahr: Richtlinienprüfung ist aktiv. * Falsch: Richtlinienprüfung ist inaktiv. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_j2p_sdt_2pb} Datentyp: Boolescher Wert |
| checks.auto_generate | Kennzeichnung, die angibt, ob der Befehl automatisch mit generiert werden soll command_prefixWert. Gültige Werte: * Wahr: Füllen Sie automatisch aus commandEigenschaft mit aktiven Parameterwerten. * Falsch: Befehl wird nicht automatisch generiert. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_myc_x2t_2pb} Datentyp: Boolescher Wert |
| checks.check_type | Prüftyp, der die Überwachungsoption angibt. Mögliche Werte: * Discovery: Überprüfen Sie, ob CIs im Zusammenhang mit dem Agent gefunden werden. * Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt. * Metriken: Die Werte aus dem Prüfergebnis werden in Metriken umgewandelt. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_pgd_42t_2pb} Datentyp: Zeichenfolge |
| checks.command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Parameter aus einer Vorlage oder einem überwachten CI. Hinweis: Wenn auto_generateIst „wahr", wird diese Eigenschaft automatisch mit dem Präfix und den Kennzeichnungen der aktiven Parameter ausgefüllt, die in aufgeführt sind parametersObjekt. Datentyp: Zeichenfolge |
| checks.command_prefix | Wenn auto_generateEigenschaft ist „wahr". Dieser Befehl wird für die automatische Generierung verwendet. Das Präfix besteht aus einem beliebigen Teil des Befehls, der statisch ist (sich nicht ändert), z. B. dem Skriptnamen. Datentyp: Zeichenfolge |
| checks.event_status_change_threshold | Anzahl der aufeinanderfolgenden Male, die der Antwortstatus eines Schecks erfolgen muss, bevor ein neues Ereignis gesendet wird. Gibt Null zurück, wenn nicht festgelegt. Wenn dieser Wert beispielsweise 3 ist, generiert eine Prüfung, deren Antwortstatus sich von OK in Fehler ändert, ein neues Ereignis mit einem Fehlerstatus nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung. Datentyp: Zahl |
| checks.event_status_repair_threshold | Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus eines Schecks verbessern muss, um das vorherige Ereignis zu schließen. Gibt Null zurück, wenn nicht festgelegt. Wenn dieser Wert beispielsweise 3 ist, schließt eine Prüfung, deren Antwortstatus von „Fehler" in „OK" geändert wird, das vorherige Ereignis und generiert ein neues Ereignis mit dem Status „OK" nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung. Datentyp: Zahl |
| checks.interval | Wartezeit in Sekunden zwischen Prüfungsausführungen. Beispiel: Ein Wert von 60 bedeutet, dass die Prüfung alle 60 Sekunden ausgeführt wird. Datentyp: Zahl |
| checks.name | Name der Prüfung. Datentyp: Zeichenfolge |
| Checks.sys_ID | SYS_ID der Prüfung. Die [VERÖFFENTLICHEN SIE /Agents/Update/Check/{Check_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check-id "Aktualisiert eine ausgewählte Richtlinienprüfung.")Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren. Datentyp: Zeichenfolge Tabelle: Instanzen überprüfen \[sn_Agent_Check\] |
| Prüfungen.Zeitüberschreitung | Zeit in Sekunden, nach der die Prüfungsausführung angehalten wird, wenn keine Ausgabe zurückgegeben wird. Beispiel: Ein Wert von 60 bedeutet, dass die Ausführung der Prüfung angehalten wird, wenn die Ausführung 60 Sekunden lang keinen Wert zurückgibt. Datentyp: Zeichenfolge |
| Cred_alias | Anmeldeinformationsname. Datentyp: Zeichenfolge Tabelle: Anmeldeinformationen \[Discovery_credentials\] |
| credential_alias | SYS_ID des Anmeldeinformationsalias. Datentyp: Zeichenfolge Tabelle: Aliasse für Verbindungen und Anmeldeinformationen \[sys_alias\] |
| Filter | Filter, der die Prüfungen der Richtlinie einschränkt, um nur die angegebenen Kriterien zu überwachen. Datentyp: Zeichenfolge |
| interval | Wartezeit in Sekunden zwischen Richtlinienprüfungen. Beispiel: Ein Wert von 60 bedeutet, dass die Prüfung alle 60 Sekunden ausgeführt wird. Hinweis: Der Wert von checks.intervalEigenschaft überschreibt den in diesem Feld konfigurierten Wert. Datentyp: Zahl |
| Überwachte_ci_Gruppe | Name von [CMDB-Gruppen](https://www.servicenow.com/docs/access?context=cmdb-groups&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)Ist der Richtlinie zugeordnet. Dieses Feld wird nur angewendet, wenn der Wert von monitored_ci_type_group Eigenschaft ist „wahr". Datentyp: Zeichenfolge Tabelle: CMDB-Gruppen \[cmdb_Group\] |
| Überwachtes_ci_Skript | Skript für die Überwachung von CIs. Dieses Feld wird nur angewendet, wenn der Wert von policies.monitored_ci_type_scriptEigenschaft ist „wahr". Datentyp: Zeichenfolge |
| monitored_ci_type_filter | Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in aufgeführt tableEigenschaft. Gültige Werte: * Wahr: Das Filtern nach Prüfungsgruppe ist aktiviert. * Falsch: Das Filtern nach Prüfungsgruppe ist deaktiviert. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_tvm_fvt_2pb} Datentyp: Boolescher Wert |
| monitored_ci_type_group | Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist. Gültige Werte: * Wahr: CMDB-Gruppentyp ist aktiviert. * Falsch: CMDB-Gruppentyp ist deaktiviert. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_jrc_fvt_2pb} Datentyp: Boolescher Wert |
| monitored_ci_type_script | Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist. Gültige Werte: * Wahr: Skript für die Überwachung von CIs ist aktiviert. * Falsch: Skript für die Überwachung von CIs ist deaktiviert. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_bs4_3wt_2pb} Datentyp: Boolescher Wert |
| name | Name der Richtlinie Datentyp: Zeichenfolge |
| Publish_Status | Gibt an, ob die Richtlinie veröffentlicht wird. Mögliche Werte: * Entwurf: Richtlinie wurde nicht veröffentlicht und kann mit den Update-Endpunkten bearbeitet werden. * Veröffentlicht: Richtlinie wird veröffentlicht. Der Entwurf (Sandbox-Kopie) und die veröffentlichte Kopie sind identisch. * Veröffentlicht\*: Richtlinie wird veröffentlicht, aber die Entwurfskopie (Sandbox-Ansicht) weist Änderungen auf, die in der veröffentlichten Kopie nicht gefunden wurden. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_d3k_qzm_fpb} Datentyp: Zeichenfolge |
| params | Liste von Objekten mit Informationen zu Prüfparametern. Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr" festgelegt. Datentyp: Array von Objekten "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] Tabelle: Parameter überprüfen \[sn_agent_check_param\] |
| Parameter.aktiv | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Prüfparameter ist aktiv. * Falsch: Prüfparameter ist inaktiv. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_u2x_5fv_2pb} Datentyp: Boolescher Wert |
| Parameter.Flag | Parameterkennzeichnung, die während des Prüfaufrufs verwendet werden soll. Datentyp: Zeichenfolge |
| Parameter.obligatorisch | Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist. Gültige Werte: * Wahr: Diese Prüfung ist obligatorisch. * Falsch: Diese Prüfung ist optional. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_flq_qkv_2pb} Datentyp: Boolescher Wert |
| params.name | Name des Parameters. Datentyp: Zeichenfolge |
| Params.sys_ID | SYS_ID des Parameters, der in der Tabelle „Prüfparameter" \[sn_agent_check_param\] aufgeführt ist. Die [VERÖFFENTLICHEN SIE /Agents/Update/Check_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_param "Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.")Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren. Datentyp: Zeichenfolge |
| Parameter.Wert | Wert des Parameters. Datentyp: Zeichenfolge |
| Params.value_required | Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind. Gültige Werte: * Wahr: Die Werteigenschaft ist erforderlich. * Falsch: Die Werteigenschaft ist null oder nicht erforderlich. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_ug3_3jv_2pb} Datentyp: Boolescher Wert |
| Secure_params | Liste von Objekten, die Informationen zu sicheren Parametern für die Prüfung enthalten. Weitere Informationen finden Sie unter [Erstellen Sie einen sicheren Parameter für eine Prüfung](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US). Diese Ergebnisse werden nur angezeigt, wenn X-Include-Check-ParamsHeader-Parameter ist auf „wahr" festgelegt. Datentyp: Array von Objekten "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] Tabelle: Sichere Parameter überprüfen \[sn_agent_check_secure_param\] |
| Secure_params.Active | Kennzeichnung, die angibt, ob der Parameter „sichere Prüfung" aktiv ist. Gültige Werte: * Wahr: Der Parameter „sichere Prüfung" ist aktiv. * Falsch: Der Parameter „sichere Prüfung" ist inaktiv. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_xwy_vfv_2pb} Datentyp: Boolescher Wert |
| secure_params.name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| Secure_params.order | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zahl |
| Secure_params.sys_ID | SYS_ID des Datensatzes. Die [VERÖFFENTLICHEN SIE /Agents/Update/Check_Secure_param/{param_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-check_secure "Aktualisiert einen ausgewählten sicheren Parameter für die Richtlinienprüfung.")Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren. Datentyp: Zeichenfolge Tabelle: Sicheren Parameter \[sn_agent_check_secure_param\] überprüfen |
| sys_id | SYS_ID der Richtlinie. Die [VERÖFFENTLICHEN SIE /Agents/Update/Policy/{Policy_ID}](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-POST-update-policy "Aktualisiert eine Sandbox-Kopie einer Richtlinie.")Endpunkt verwendet diesen Wert, um die Sandbox-Kopie zu aktualisieren. Datentyp: Zeichenfolge Tabelle: Richtlinien \[sn_Agent_Policy\] |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung der Richtlinie. Datentyp: Zeichenfolge |
| table | Überwachtes CI-Typfeld in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filterIst „wahr". Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Im Folgenden wird gezeigt, wie Informationen zur Richtlinie für Docker-Container-Metriken abgerufen werden.

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

Ausgabe:

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

## Agent-Clientsammler -- GET /Agents/{Agent_ID}/restart {#ariaid-title19}

Startet einen angegebenen Agent mit dem Status „aktiv"/„aktiv" neu.
Wenn Agent Client CollectorLeistungsprobleme treten auf. Sie können den Service Desk-Mitarbeiter neu starten. Manueller Neustart wird in den folgenden Umgebungen unterstützt:

* Linux-basierte Agenten verwenden `System-ID `
* Windows-Agenten
{#agnt_clnt_cll-GET-restart__ul_zzv_z4q_dpb}

### URL-Format {#agnt_clnt_cll-GET-restart__section_nf5_zyc_z4b}

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-GET-restart__section_ewl_zyc_z4b}

{#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb__entry__2}

| Name | Beschreibung |
|-|-|
| agent_id | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. Um eine Liste von Service Desk-Mitarbeiter-IDs und anderen Details zu erhalten, führen Sie aus RUFEN SIE /Agents/list AB Endpunkt. Datentyp: Zeichenfolge |
[Tabelle : 104. Pfad-Parameter]

{#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 105. Abfrageparameter]

{#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 106. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b}

### Header {#agnt_clnt_cll-GET-restart__section_iwl_zyc_z4b}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-restart__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 107. Anforderungskopfzeilen.]

{#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 108. Antwort-Header]

{#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b}

### Statuscodes {#agnt_clnt_cll-GET-restart__section_lwl_zyc_z4b}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-restart__entry-200-status-code}{#agnt_clnt_cll-GET-restart__agntCC-desc-403-admin}

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

{#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-GET-restart__section_nwl_zyc_z4b}

{#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b}  

### Curl-Anforderung {#agnt_clnt_cll-GET-restart__example_zf5_zyc_z4b}

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-Clientsammler -- POSTEN /Agents/Check_defs/{Check_def_ID}/Run {#ariaid-title20}

Führt eine Prüfung für das angegebene Konfigurationselement aus.
Um eine Hintergrundprüfung anzuhalten, verwenden Sie die Anforderungs-ID, die in angegeben ist RUFT /Agents/exec/background/stop/{Request_ID} AB API.

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-POST-check-def-run__entry__2}

| Name | Beschreibung |
|-|-|
| Check_def_ID | SYS_ID einer Prüfungsdefinition in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\]. |
[Tabelle : 110. Pfad-Parameter]

{#agnt_clnt_cll-POST-check-def-run__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 111. Abfrageparameter]

{#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| params | Zuordnung von Parameternamen und -Werten. Diese Einstellungen können verwendet werden, um die Parameterdatensätze der Prüfungsdefinition und ihre angegebenen Werte zu überschreiben. "params": { "<parameter name>": "String" } Datentyp: Objekt |
| Priorität | Priorität der Anforderung, die in der ECC-Warteschlange festgelegt werden soll. Mögliche Werte: * 0: Interaktiv * 1: Beschleunigt * 2: Standard {#agnt_clnt_cll-POST-check-def-run__ul_bkf_hnq_wqb} Datentyp: Zahl |
| query | Codierte Abfrage zum Abrufen des GlideRecord aus der in angegebenen Tabelle tableEigenschaft. Datentyp: Zeichenfolge |
| table | Name der Tabelle „cmdb_ci" für diese Hintergrundprüfung. Datentyp: Zeichenfolge |
| Zeitüberschreitung | Wert der Zeitüberschreitung für die Anforderung in Sekunden. Datentyp: Zahl |
[Tabelle : 112. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb}

### Header {#agnt_clnt_cll-POST-check-def-run__section_dvh_5gq_wqb}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 113. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 114. Antwort-Header]

{#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb}

### Statuscodes {#agnt_clnt_cll-POST-check-def-run__section_gvh_5gq_wqb}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__entry-200-status-code}

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

{#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-POST-check-def-run__section_ivh_5gq_wqb}

{#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| requestId | SYS_ID der generierten Hintergrundprüfungsanforderung. |
[ ]

{#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb}  

### Curl-Anforderung {#agnt_clnt_cll-POST-check-def-run__example_kvh_5gq_wqb}

Das folgende Beispiel zeigt, wie eine Hintergrundprüfung ausgeführt und die zugehörige 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-Clientsammler -- POST /Agents/Check_defs/{Check_def_ID}/Test {#ariaid-title21}

Aktiviert das Erstellen von Testprüfungsanforderungen für Prüfungsdefinitionen.
Verwenden Sie diese API für die folgenden Aufgaben:

* Legen Sie die zu testende Prüfungsdefinition fest
* Legen Sie das Konfigurationselement fest, für das der Test ausgeführt werden soll

{#agnt_clnt_cll-POST-check-def-test__ul_tdb_gpk_5qb}Sie können auch einen der folgenden Bezeichner angeben, die während des Tests verwendet werden sollen:

<!-- -->

* Sys_ID der Anmeldeinformationen
* ID des Anmeldeinformationsalias
* Anmeldeinformationsname
{#agnt_clnt_cll-POST-check-def-test__ul_tft_qwk_5qb}

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-POST-check-def-test__entry__2}

| Name | Beschreibung |
|-|-|
| Check_def_ID | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. |
[Tabelle : 116. Pfad-Parameter]

{#agnt_clnt_cll-POST-check-def-test__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 117. Abfrageparameter]

{#agnt_clnt_cll-POST-check-def-test__entry__10}

| Name | Beschreibung |
|-|-|
| ci_id | SYS_ID eines CMDB-Konfigurationselements. |
| credentials_id | SYS_ID eines Anmeldeinformationsdatensatzes. |
| Anmeldeinformationen_Name | Name des Anmeldeinformationsdatensatzes. |
| Anmeldeinformationen_Alias_ID | SYS_ID eines Anmeldeinformationsalias-Datensatzes. |
| Anmeldeinformationen_Alias_Name | Name eines Anmeldeinformationsalias. |
[Tabelle : 118. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-check-def-test__entry__22}{#agnt_clnt_cll-POST-check-def-test__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 119. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-check-def-test__entry__26}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 120. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-check-def-test__entry__30}{#agnt_clnt_cll-POST-check-def-test__entry-200-status-code}

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

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-POST-check-def-test__section_d5l_yrv_wqb}

{#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| result_id | SYS_ID des Testergebnisdatensatzes. |
[ ]

{#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb}

## Agent-Clientsammler -- POST /Agents/Check_instances/{Check_instance_ID}/Test {#ariaid-title22}

Aktiviert das Erstellen von Testprüfungsanforderungen für Prüfinstanzen.
Verwenden Sie diese API für die folgenden Aufgaben:

* Legen Sie die zu testende Prüfungsinstanz fest
* Legen Sie das Konfigurationselement fest, für das der Test ausgeführt werden soll

{#agnt_clnt_cll-POST-check-inst-test__ul_tdb_gpk_5qb}Sie können auch einen der folgenden Bezeichner angeben, die während des Tests verwendet werden sollen:

<!-- -->

* Sys_ID der Anmeldeinformationen
* ID des Anmeldeinformationsalias
* Anmeldeinformationsname
{#agnt_clnt_cll-POST-check-inst-test__ul_tft_qwk_5qb}

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-POST-check-inst-test__entry__2}

| Name | Beschreibung |
|-|-|
| Check_instance_ID | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. |
[Tabelle : 122. Pfad-Parameter]

{#agnt_clnt_cll-POST-check-inst-test__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 123. Abfrageparameter]

{#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| ci_id | SYS_ID eines CMDB-Konfigurationselements. |
| credentials_id | SYS_ID eines Anmeldeinformationsdatensatzes. |
| Anmeldeinformationen_Name | Name des Anmeldeinformationsdatensatzes. |
| Anmeldeinformationen_Alias_ID | SYS_ID eines Anmeldeinformationsalias-Datensatzes. |
| Anmeldeinformationen_Alias_Name | Name eines Anmeldeinformationsalias. |
| Proxy_Agent_ID | Eindeutige ID eines Agenten-Proxys zum Ausführen dieser Prüfung. Dieser Wert wird in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt. |
[Tabelle : 124. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb}

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-check-inst-test__entry__24}{#agnt_clnt_cll-POST-check-inst-test__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 125. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-check-inst-test__entry__28}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 126. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb__entry__2}{#agnt_clnt_cll-POST-check-inst-test__entry-200-status-code}

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

{#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-POST-check-inst-test__entry__38}

| Name | Beschreibung |
|-|-|
| result_id | SYS_ID des Testergebnisdatensatzes. |
[ ]

## Agent-Clientsammler -- POSTEN SIE /Agents/Update/Check/{Check_ID} {#ariaid-title23}

Aktualisiert eine ausgewählte Richtlinienprüfung.
Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie [RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-sbox-fr "Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit.").

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-POST-update-check-id__section_vvx_g2z_2pb}

{#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Check_ID | SYS_ID einer Richtlinienüberprüfungs-Sandbox-Kopie in der Tabelle „Instanzen überprüfen" \[sn_Agent_Check\]. Datentyp: Zeichenfolge |
[Tabelle : 128. Pfad-Parameter]

{#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 129. Abfrageparameter]

{#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob die Richtlinienprüfung aktiv ist. Gültige Werte: * Wahr: Richtlinienprüfung ist aktiv. * Falsch: Richtlinienprüfung ist inaktiv. {#agnt_clnt_cll-POST-update-check-id__ul_j2p_sdt_2pb} Datentyp: Boolescher Wert |
| automatisch_generieren | Kennzeichnung, die angibt, ob der Befehl automatisch mit generiert werden soll command_prefixWert. Gültige Werte: * Wahr: Füllen Sie automatisch aus commandEigenschaft mit aktiven Parameterwerten. * Falsch: Befehl wird nicht automatisch generiert. {#agnt_clnt_cll-POST-update-check-id__ul_myc_x2t_2pb} Datentyp: Boolescher Wert |
| Check_type | Prüftyp, der die Überwachungsoption angibt. Mögliche Werte: * Discovery: Überprüfen Sie, ob CIs im Zusammenhang mit dem Agent gefunden werden. * Ereignisse: Das Ergebnis der Prüfung wird in ein Ereignismanagement-Ereignis umgewandelt. * Metriken: Die Werte aus dem Prüfergebnis werden in Metriken umgewandelt. {#agnt_clnt_cll-POST-update-check-id__ul_pgd_42t_2pb} Datentyp: Zeichenfolge |
| command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Parameter aus einer Vorlage oder einem überwachten CI. Hinweis: Wenn auto_generateIst „wahr", wird diese Eigenschaft automatisch mit dem Präfix und den Kennzeichnungen der aktiven Parameter ausgefüllt, die in aufgeführt sind parametersObjekt. Datentyp: Zeichenfolge |
| Command_prefix | Wenn auto_generateEigenschaft ist „wahr". Dieser Befehl wird für die automatische Generierung verwendet. Das Präfix besteht aus einem beliebigen Teil des Befehls, der statisch ist (sich nicht ändert), z. B. dem Skriptnamen. Datentyp: Zeichenfolge |
| event_status_change_threshold | Anzahl der aufeinanderfolgenden Male, die der Antwortstatus eines Schecks erfolgen muss, bevor ein neues Ereignis gesendet wird. Gibt Null zurück, wenn nicht festgelegt. Wenn dieser Wert beispielsweise 3 ist, generiert eine Prüfung, deren Antwortstatus sich von OK in Fehler ändert, ein neues Ereignis mit einem Fehlerstatus nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung. Datentyp: Zahl |
| event_status_repair_threshold | Anzahl der aufeinanderfolgenden Male, die sich der Antwortstatus eines Schecks verbessern muss, um das vorherige Ereignis zu schließen. Gibt Null zurück, wenn nicht festgelegt. Wenn dieser Wert beispielsweise 3 ist, schließt eine Prüfung, deren Antwortstatus von „Fehler" in „OK" geändert wird, das vorherige Ereignis und generiert ein neues Ereignis mit dem Status „OK" nach dem dritten aufeinanderfolgenden Auftreten der Statusänderung. Datentyp: Zahl |
| interval | Wartezeit in Sekunden zwischen Prüfungsausführungen. Beispiel: Ein Wert von 60 bedeutet, dass die Prüfung alle 60 Sekunden ausgeführt wird. Datentyp: Zahl |
| name | Name der Prüfung. Datentyp: Zeichenfolge |
| Zeitüberschreitung | Zeit in Sekunden, nach der die Prüfungsausführung angehalten wird, wenn keine Ausgabe zurückgegeben wird. Beispiel: Ein Wert von 60 bedeutet, dass die Ausführung der Prüfung angehalten wird, wenn die Ausführung 60 Sekunden lang keinen Wert zurückgibt. Datentyp: Zeichenfolge |
[Tabelle : 130. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb}

### Header {#agnt_clnt_cll-POST-update-check-id__section_yvx_g2z_2pb}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 131. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 132. Antwort-Header]

{#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb}

### Statuscodes {#agnt_clnt_cll-POST-update-check-id__section_bwx_g2z_2pb}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__entry-200-status-code}{#agnt_clnt_cll-POST-update-check-id__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check-id__entry-500-status-code}

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

{#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-POST-update-check-id__section_dwx_g2z_2pb}

{#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb}  

### Curl-Anforderung {#agnt_clnt_cll-POST-update-check-id__example_fwx_g2z_2pb}

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

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

Ausgabe:

    {
      "message": "Operation was successful"
    }

## Agent-Clientsammler -- POST /Agents/Update/Check_def_params/{check_def_param_id} {#ariaid-title24}

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

{#agnt_clnt_cll-POST-up-check-def-p__entry__2}

| Name | Beschreibung |
|-|-|
| check_def_param_id | SYS_ID des Prüfparameters. Datentyp: Zeichenfolge Tabelle: Parameterdefinitionen überprüfen \[sn_agent_check_param_def\] |
[Tabelle : 134. Pfad-Parameter]

{#agnt_clnt_cll-POST-up-check-def-p__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 135. Abfrageparameter]

{#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Der Prüfparameter ist aktiv. * Falsch: Der Prüfparameter ist inaktiv. {#agnt_clnt_cll-POST-up-check-def-p__ul_pnb_jyc_wqb} Datentyp: Boolescher Wert |
| default_value | Gibt den Standardwert für diesen Prüfparameter an. Datentyp: Zeichenfolge |
| Obligatorisch | Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist. Gültige Werte: * Wahr: Der Prüfparameter ist erforderlich. * Falsch: Der Prüfparameter ist optional. {#agnt_clnt_cll-POST-up-check-def-p__ul_wtg_2zc_wqb} Datentyp: Boolescher Wert |
| name | Name des Prüfparameters. Datentyp: Zeichenfolge |
[Tabelle : 136. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb}  
Hinweis:  
Im Datenwörterbuch finden Sie eine umfassende Liste der Prüfungsdefinitionsfelder und -Typen.

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-up-check-def-p__entry__20}{#agnt_clnt_cll-POST-up-check-def-p__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 137. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-up-check-def-p__entry__24}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 138. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-p__entry-200-status-code}

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

{#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine | Erfolgs- oder Fehlermeldung. |
[ ]

{#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb}  

### 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-Clientsammler -- POSTEN SIE /Agents/Update/check_def_secure_params/{check_def_secure_param_id} {#ariaid-title25}

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

### URL-Format

/api/sn_Agent/Agents/Update/check_def_secure_params/{check_def_secure_param_id}

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-POST-up-check-def-sp__entry__2}

| Name | Beschreibung |
|-|-|
| check_def_secure_param_id | SYS_ID des sicheren Parameters. Datentyp: Zeichenfolge Tabelle: Sichere Parameterdefinitionen \[sn_agent_check_secure_param_def\] überprüfen |
[Tabelle : 140. Pfad-Parameter]

{#agnt_clnt_cll-POST-up-check-def-sp__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 141. Abfrageparameter]

{#agnt_clnt_cll-POST-up-check-def-sp__entry__10}

| Name | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist. Gültige Werte: * Wahr: Der sichere Parameter ist aktiv. * Falsch: Der sichere Parameter ist inaktiv. {#agnt_clnt_cll-POST-up-check-def-sp__ul_g1b_3vc_wqb} Datentyp: Boolescher Wert |
| name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| Reihenfolge | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zeichenfolge |
[Tabelle : 142. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-up-check-def-sp__entry__18}{#agnt_clnt_cll-POST-up-check-def-sp__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 143. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-up-check-def-sp__entry__22}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 144. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-sp__entry-200-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 404 | Der Parameter für die Prüfung „sicher" wurde mit angegebener sys_ID nicht gefunden. |
| 500 | Fehler beim Aktualisieren des Parameters „sichere Prüfung". |
[Tabelle : 145. Statuscodes]

{#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb}

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine | Erfolgs- oder Fehlermeldung. |
[ ]

{#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb}  

### Curl-Anforderung

Das folgende Beispiel zeigt, wie Sie einen Parameter für die Prüfung auf Sicherheit aktivieren.

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

Ausgabe:

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

## Agent-Clientsammler -- POST /Agents/Update/Check_defs/{Check_def_ID} {#ariaid-title26}

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

{#agnt_clnt_cll-POST-up-check-def-cd__entry__2}

| 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 : 146. Pfad-Parameter]

{#agnt_clnt_cll-POST-up-check-def-cd__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 147. Abfrageparameter]

{#agnt_clnt_cll-POST-up-check-def-cd__entry__10}

| 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. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gdc_4wj_wqb} Datentyp: Zahl |
| Hintergrund | Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Agent startet und nicht wartet, bis sie abgeschlossen ist. Gültige Werte: * Wahr: Diese Prüfungsdefinition ist eine Hintergrundprüfung. * Falsch: Diese Prüfungsdefinition ist keine Hintergrundprüfung. {#agnt_clnt_cll-POST-up-check-def-cd__ul_ypb_5ps_5qb} Datentyp: Boolescher Wert |
| Check_Group | Gruppe, die für diese Prüfungsdefinition angegeben ist. |
| Check_type | Typ der Prüfung. Mögliche Werte: * Ereignisse: Prüfergebnisse werden in ein Ereignismanagement-Ereignis umgewandelt. * Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gtr_kfb_wqb} Datentyp: Zeichenfolge |
| command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Datentyp: Zeichenfolge |
| name | Name der Prüfung. Datentyp: Zeichenfolge |
| params | Zuordnung von Parameternamen und -Werten. Diese Einstellungen können verwendet werden, um die Parameterdatensätze der Prüfungsdefinition und ihre angegebenen Werte zu überschreiben. "params": { "<parameter name>": "String" } Datentyp: Objekt |
| Plugins | Liste von [Agent Client Collector Plugins](https://www.servicenow.com/docs/access?context=acc-assets&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US) Dieser Prüfung zugeordnet. Datentyp: Array |
| Proxy_valid | Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie so festgelegt ist, dass sie als Proxy funktioniert. Gültige Werte: * Wahr: Diese Prüfungsdefinitionsrichtlinie ist so festgelegt, dass sie als Proxy funktioniert. * Falsch: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy festgelegt. {#agnt_clnt_cll-POST-up-check-def-cd__ul_wbf_qps_5qb} Datentyp: Boolescher Wert |
| query | Codierte Abfrage zum Abrufen des GlideRecord aus der in angegebenen Tabelle tableEigenschaft. Datentyp: Zeichenfolge |
| table | Name der Tabelle „cmdb_ci" für diese Prüfung. Datentyp: Zeichenfolge |
| Zeitüberschreitung | Zeitüberschreitung in Sekunden. Datentyp: Zahl |
[Tabelle : 148. Anforderungstext-Parameter (JSON)]

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

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-up-check-def-cd__entry__36}{#agnt_clnt_cll-POST-up-check-def-cd__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 149. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-up-check-def-cd__entry__40}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 150. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-up-check-def-cd__entry__44}{#agnt_clnt_cll-POST-up-check-def-cd__entry-200-status-code}

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

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-POST-up-check-def-cd__entry__52}

| 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-Clientsammler -- POST /Agents/Update/Check_param/{param_ID} {#ariaid-title27}

Aktualisiert einen ausgewählten Richtlinienprüfungsparameter.
Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie [RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-sbox-fr "Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit.").

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-POST-update-check_param__section_dvh_g2z_2pb}

{#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Parameter_ID | SYS_ID der Sandbox-Kopie des Richtlinienprüfungsparameters. Datentyp: Zeichenfolge Tabelle: Parameter überprüfen \[sn_agent_check_param\] |
[Tabelle : 152. Pfad-Parameter]

{#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 153. Abfrageparameter]

{#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Prüfparameter ist aktiv. * Falsch: Prüfparameter ist inaktiv. {#agnt_clnt_cll-POST-update-check_param__ul_u2x_5fv_2pb} Datentyp: Boolescher Wert |
| kennzeichnen |   |
| Obligatorisch | Kennzeichnung, die angibt, ob diese Prüfung obligatorisch ist. Gültige Werte: * Wahr: Diese Prüfung ist obligatorisch. * Falsch: Diese Prüfung ist optional. {#agnt_clnt_cll-POST-update-check_param__ul_flq_qkv_2pb} Datentyp: Boolescher Wert |
| name | Name des Parameters. Datentyp: Zeichenfolge |
| Wert | Wert des Parameters. Datentyp: Zeichenfolge |
| Wert_erforderlich | Kennzeichnung, die angibt, ob die von der Werteigenschaft bereitgestellten Informationen erforderlich sind. Gültige Werte: * Wahr: Die Werteigenschaft ist erforderlich. * Falsch: Die Werteigenschaft ist null oder nicht erforderlich. {#agnt_clnt_cll-POST-update-check_param__ul_ug3_3jv_2pb} Datentyp: Boolescher Wert |
[Tabelle : 154. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb}

### Header {#agnt_clnt_cll-POST-update-check_param__section_gvh_g2z_2pb}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 155. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 156. Antwort-Header]

{#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb}

### Statuscodes {#agnt_clnt_cll-POST-update-check_param__section_jvh_g2z_2pb}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_param__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_param__entry-500-status-code}

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

{#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-POST-update-check_param__section_lvh_g2z_2pb}

{#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb}  

### Curl-Anforderung {#agnt_clnt_cll-POST-update-check_param__example_nvh_g2z_2pb}

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-Clientsammler -- POSTEN SIE /Agents/Update/Check_Secure_param/{param_ID} {#ariaid-title28}

Aktualisiert einen ausgewählten sicheren Parameter für die Richtlinienprüfung.
Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie [RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-sbox-fr "Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit.").

### URL-Format

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

### Unterstützte Anforderungsparameter {#agnt_clnt_cll-POST-update-check_secure__section_dzx_f2z_2pb}

{#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Parameter_ID | SYS_ID der Richtlinienprüfung -- sichere Parameter-Sandbox-Kopie. Datentyp: Zeichenfolge Tabelle: Sicheren Parameter \[sn_agent_check_secure_param\] überprüfen |
[Tabelle : 158. Pfad-Parameter]

{#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 159. Abfrageparameter]

{#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| aktiv | Kennzeichnung, die angibt, ob der Parameter „sichere Prüfung" aktiv ist. Gültige Werte: * Wahr: Der Parameter „sichere Prüfung" ist aktiv. * Falsch: Der Parameter „sichere Prüfung" ist inaktiv. {#agnt_clnt_cll-POST-update-check_secure__ul_xwy_vfv_2pb} Datentyp: Boolescher Wert |
| name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| Reihenfolge | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zahl |
[Tabelle : 160. Anforderungstext-Parameter (JSON)]

{#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb}

### Header {#agnt_clnt_cll-POST-update-check_secure__section_gzx_f2z_2pb}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 161. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 162. Antwort-Header]

{#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb}

### Statuscodes {#agnt_clnt_cll-POST-update-check_secure__section_jzx_f2z_2pb}

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_secure__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_secure__entry-500-status-code}

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

{#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb}

### Antworttext-Parameter (JSON) {#agnt_clnt_cll-POST-update-check_secure__section_lzx_f2z_2pb}

{#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

{#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb}  

### Curl-Anforderung {#agnt_clnt_cll-POST-update-check_secure__example_nzx_f2z_2pb}

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

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

Ausgabe:

    {
      "message": "Operation was successful"
    }

## Agent-Clientsammler -- POSTEN SIE /Agents/Update/Policy/{Policy_ID} {#ariaid-title29}

Aktualisiert eine Sandbox-Kopie einer Richtlinie.
Um die Eigenschaften einer Richtlinien-Sandbox-Kopie abzurufen, verwenden Sie [RUFT /Agents/Policy/Sandbox_from_published/{Policy_ID} AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-policy-sbox-fr "Ruft die Sandbox-Kopie einer veröffentlichten Richtlinie ab und stellt Richtliniendetails bereit.").

### URL-Format

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

### Unterstützte Anforderungsparameter

{#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb__entry__2}

| Name | Beschreibung |
|-|-|
| policy_id | SYS_ID einer Richtlinien-Sandbox-Kopie. Datentyp: Zeichenfolge Tabelle: Richtlinien \[sn_Agent_Policy\] |
[Tabelle : 164. Pfad-Parameter]

{#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-policy__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 165. Abfrageparameter]

{#agnt_clnt_cll-POST-update-policy__entry__10}

| Name | Beschreibung |
|-|-|
| Cred_alias | Anmeldeinformationsname. Datentyp: Zeichenfolge Tabelle: Anmeldeinformationen \[Discovery_credentials\] |
| credential_alias | SYS_ID des Anmeldeinformationsalias. Datentyp: Zeichenfolge Tabelle: Aliasse für Verbindungen und Anmeldeinformationen \[sys_alias\] |
| Filter | Filter, der die Prüfungen der Richtlinie einschränkt, um nur die angegebenen Kriterien zu überwachen. Datentyp: Zeichenfolge |
| interval | Wartezeit in Sekunden zwischen Richtlinienprüfungen. Beispiel: Ein Wert von 60 bedeutet, dass die Prüfung alle 60 Sekunden ausgeführt wird. Hinweis: Der Wert von checks.intervalEigenschaft überschreibt den in diesem Feld konfigurierten Wert. Datentyp: Zahl |
| Überwachte_ci_Gruppe | Name von [CMDB-Gruppen](https://www.servicenow.com/docs/access?context=cmdb-groups&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)Ist der Richtlinie zugeordnet. Dieses Feld wird nur angewendet, wenn der Wert von monitored_ci_type_group Eigenschaft ist „wahr". Datentyp: Zeichenfolge Tabelle: CMDB-Gruppen \[cmdb_Group\] |
| Überwachtes_ci_Skript | Skript für die Überwachung von CIs. Dieses Feld wird nur angewendet, wenn der Wert von policies.monitored_ci_type_scriptEigenschaft ist „wahr". Datentyp: Zeichenfolge |
| monitored_ci_type_filter | Kennzeichnung, die angibt, ob die Filterung nach CI-Typ aktiviert ist. Der CI-Typ wird in aufgeführt tableEigenschaft. Gültige Werte: * Wahr: Das Filtern nach Prüfungsgruppe ist aktiviert. * Falsch: Das Filtern nach Prüfungsgruppe ist deaktiviert. {#agnt_clnt_cll-POST-update-policy__ul_tvm_fvt_2pb} Datentyp: Boolescher Wert |
| monitored_ci_type_group | Kennzeichnung, die angibt, ob die Überwachung nach CMDB-Gruppentyp aktiviert ist. Gültige Werte: * Wahr: CMDB-Gruppentyp ist aktiviert. * Falsch: CMDB-Gruppentyp ist deaktiviert. {#agnt_clnt_cll-POST-update-policy__ul_jrc_fvt_2pb} Datentyp: Boolescher Wert |
| monitored_ci_type_script | Kennzeichnung, die angibt, ob das Skript für die Überwachung von CIs aktiviert ist. Gültige Werte: * Wahr: Skript für die Überwachung von CIs ist aktiviert. * Falsch: Skript für die Überwachung von CIs ist deaktiviert. {#agnt_clnt_cll-POST-update-policy__ul_bs4_3wt_2pb} Datentyp: Boolescher Wert |
| name | Name der Richtlinie Datentyp: Zeichenfolge |
| table | Überwachtes CI-Typfeld in der Richtlinie. Dieses Feld wird nur angewendet, wenn monitored_ci_type_filterIst „wahr". Datentyp: Zeichenfolge |
[Tabelle : 166. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-policy__entry__34}{#agnt_clnt_cll-POST-update-policy__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 167. Anforderungskopfzeilen.]

{#agnt_clnt_cll-POST-update-policy__entry__38}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 168. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#agnt_clnt_cll-POST-update-policy__entry__42}{#agnt_clnt_cll-POST-update-policy__entry-200-status-code}{#agnt_clnt_cll-POST-update-policy__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-policy__entry-500-status-code}

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

### Antworttext-Parameter (JSON)

{#agnt_clnt_cll-POST-update-policy__entry__52}

| Name | Beschreibung |
|-|-|
| Nachricht | Nachricht mit Erfolgs- oder Fehlerergebnissen des Vorgangs. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

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

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

Ausgabe:

    {
      "message": "Operation was successful"
    }


