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


---

# AccAgentsAPI -- Umfang

# AccAgentsAPI -- Umfang {#ariaid-title1}

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

Die AccAgentsAPI Mithilfe der Skripteinbindung können Sie Verwaltungsaktionen für verfügbare Service Desk-Mitarbeiter ausführen.

Diese Skripteinbindung erfordert Agent Client CollectorFramework (sn_Agent) Store-Anwendung und wird in bereitgestellt `sn_Agent `Namespace. Weitere Informationen finden Sie unter [Agent-Clientsammler](https://www.servicenow.com/docs/access?context=acc-landing-page&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).

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

* Umfassende Informationen zu einem oder mehreren Service Desk-Mitarbeitern werden abgerufen.
* Senden einer Anforderung zum Abrufen eines Agent-Protokolls und Abrufen von Informationen zum Anforderungsfortschritt.
* Datensammlung wird gestartet oder gestoppt.
* Agent wird neu gestartet.
* Discovery wird für einen Agent ausgeführt.

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

Erstellt eine AccAgentsAPI-Instanz.
{#AccA-AccAgentsAPI__table_ohr_4qd_bpb__entry__3}

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

{#AccA-AccAgentsAPI__table_ohr_4qd_bpb}  
Das folgende Beispiel zeigt, wie initialisiert wird AccAgentsAPI .

    var agentsApi = new sn_agent.AccAgentsAPI();

## AccAgentsAPI -- checkGrabLogRequestProgress(Zeichenfolge requestId) {#ariaid-title3}

Überprüft den Status einer Anforderung zum Abrufen eines Protokolls.
Führen Sie aus [SubmitGrabLogRequest()](https://servicenow-prod.fluidtopics.net/m_z57ySPQlU8b811ZAspdA#AccA-submitGrabLogRequest_S "Fordert das Protokoll eines angegebenen Agenten mit Status „aktiv“/„aktiv“ an.")Methode zum Abrufen einer Anforderungs-ID.
{#AccA-checkGrabLogRequestProgress_S__table_zk2_2g2_z4b__entry__3}{#AccA-checkGrabLogRequestProgress_S__accAgents-parm-desc-requestID}

| Name | Typ | Beschreibung |
|-|-|-|
| requestId | Zeichenfolge | SYS_ID einer Anforderung in der Tabelle „Agenten-Client-Sammleranforderungen" \[sn_Agent_Request\]. |
[Tabelle : 2. Parameter]

{#AccA-checkGrabLogRequestProgress_S__table_zk2_2g2_z4b} {#AccA-checkGrabLogRequestProgress_S__table_al2_2g2_z4b__entry__2}

| Eigenschaften | Beschreibung |
|-|-|
| \<Object\> | JSON-Objekt, das den Status der Anforderung zum Abrufen des Protokolls enthält. { "status": Number, "output": "String" } |
| Status | Nummer, die den Status der Anforderung zum Abrufen des Protokolls angibt. Mögliche Werte: * 0: Anforderung zum Abrufen des Protokolls ist abgeschlossen. * 1: Anforderung zum Abrufen des Protokolls wird ausgeführt. * 2: Zeitüberschreitung bei Anforderung zum Abrufen des Protokolls. * 3: Anforderung zum Abrufen des Protokolls weist einen Fehler auf. * 4: Anforderung zum Abrufen des Protokolls wurde nicht gefunden. {#AccA-checkGrabLogRequestProgress_S__ul_orq_4qr_bpb} |
| Ausgabe | Informationen, die den Status beschreiben. |
[Tabelle : 3. Rückgaben]

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

    var agentsApi = new sn_agent.AccAgentsAPI();
    var logRequestStatus = agentsApi.checkGrabLogRequestProgress("<request_ID>");

    gs.info(JSON.stringify(logRequestStatus, null, 2));

Ausgabe:

    {
      "status": 2,
      "output": "Grab Log Request Timed Out"
    }

## AccAgentsAPI -- getAgent(String AGENTID) {#ariaid-title4}

Ruft die Informationen eines angegebenen Agenten ab.
So rufen Sie eine Liste von Service Desk-Mitarbeiter-IDs ab:

* Führen Sie aus GetAgentsList() Methode.
* Überprüfen Sie die Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler" \[sn_agent_cmdb_ci_agent\].
* Führen Sie aus [Agent-Clientsammler RUFT die Liste AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.")REST-API.
{#AccA-getAgent_S__ul_yqc_3kj_z4b}
{#AccA-getAgent_S__table_zk2_2g2_z4b__entry__3}{#AccA-getAgent_S__accAgents-parm-desc-agentID}

| Name | Typ | Beschreibung |
|-|-|-|
| AGENTID | Zeichenfolge | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. |
[Tabelle : 4. Parameter]

{#AccA-getAgent_S__table_zk2_2g2_z4b} {#AccA-getAgent_S__table_al2_2g2_z4b__entry__2}{#AccA-getAgent_S__accAgents-rtrns-error}

| Eigenschaften | Beschreibung |
|-|-|
| \<Object\> | Objekt mit erweiterten Service Desk-Mitarbeiter-Informationen. { "error": String, "agent": Object } |
| Fehler | Fehlermeldung. Null, wenn kein Fehler vorliegt. Datentyp: Zeichenfolge |
| Service Desk-Mitarbeiter | "agent": { "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.Agent_ID | ID des Service Desk-Mitarbeiters wie übermittelt. Datentyp: Zeichenfolge |
| Agent.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 {#AccA-getAgent_S__ul_w4n_53p_bpb} Datentyp: Zahl |
| Agent.ip_address | Agent-IP-Adresse. Datentyp: Zeichenfolge |
| Agent.is_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". {#AccA-getAgent_S__ul_b34_ffl_bpb} Datentyp: Boolescher Wert |
| Agent.is_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. {#AccA-getAgent_S__ul_bvp_dfl_bpb} Datentyp: Boolescher Wert |
| agent.name | Name des Service Desk-Mitarbeiters. Datentyp: Zeichenfolge |
| agent.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 |
| Agent.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. {#AccA-getAgent_S__ul_adg_ffp_bpb} Datentyp: Zahl |
| Agent.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 |
| Agent.Version | Version von Agent Client CollectorDer Agent wird ausgeführt. Datentyp: Zeichenfolge |
[Tabelle : 5. Rückgaben]

{#AccA-getAgent_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie der Status eines Service Desk-Mitarbeiters angezeigt wird.

    var agentsApi = new sn_agent.AccAgentsAPI();
    var agentInfo = agentsAPI.getAgent("<agent_ID>");

    if (!gs.nil(agentInfo.error))
    	gs.error(agentInfo.error);
    else
    	gs.info("agent status: " + agentInfo.agent.status);

Ausgabe:

    agent status: 2

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

    var agentsApi = new sn_agent.AccAgentsAPI();
    var agentInfo = agentsAPI.getAgent("<agent_ID>");

    gs.info(JSON.stringify(agentInfo, null, 2));

Ausgabe:

    {
      "error": null,
      "agent": {
        "name": "win2016-dc-64bit",
        "status": 0,
        "agent_id": "<agent_ID>",
        "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"
      }
    }

## AccAgentsAPI -- getAgentsList (Zeichenfolge encodedQuery, Nummernlimit) {#ariaid-title5}

Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.
{#AccA-getAgentsList_S_N__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| encodedQuery | Zeichenfolge | 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). |
| limit | Nummer | Optional. 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 |
[Tabelle : 6. Parameter]

{#AccA-getAgentsList_S_N__table_zk2_2g2_z4b} {#AccA-getAgentsList_S_N__table_al2_2g2_z4b__entry__2}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-id-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-dataCollect-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-ip-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-dup-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-restart-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-name-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-numChecks-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-status-entry}{#AccA-getAgentsList_S_N__accAgents-parm-agent-obj-up-entry}{#AccA-getAgentsList_S_N__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 {#AccA-getAgentsList_S_N__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". {#AccA-getAgentsList_S_N__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. {#AccA-getAgentsList_S_N__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. {#AccA-getAgentsList_S_N__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 |
[Tabelle : 7. Rückgaben]

{#AccA-getAgentsList_S_N__table_al2_2g2_z4b}  
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.

    var agentsApi = new sn_agent.AccAgentsAPI();
    var agentList = agentsApi.getAgentsList("agent_extended_info.status!=2", 2);

    gs.info(JSON.stringify(agentList, null, 2));

Ausgabe:

    [
      {
        "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"
      }
    ]

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.

    var agentsApi = new sn_agent.AccAgentsAPI();
    var agentList = agentsApi.getAgentsList(null, 0);

    gs.info(JSON.stringify(agentList, null, 2));

Das folgende Beispiel zeigt, wie über die bereitgestellten Ergebnisse iteriert wird, und zeigt jede Agent-ID an.

    var agentsApi = new sn_agent.AccAgentsAPI();

    var agentsList = agentsApi.getAgentsList(null, 0);
    for (var i = 0; i < agentsList.length; i++)
       gs.info("agent with id: " + agentsList[i].agent_id);

Ausgabe:

    sn_agent: agent with id: 000a00e0aa1aa3a4
    sn_agent: agent with id: 000a00e1aa1aa3a4
    sn_agent: agent with id: 000a00e2aa1aa3a4

## AccAgentsAPI -- restartAgent(Zeichenfolge AGENTID) {#ariaid-title6}

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
{#AccA-restartAgent_S__ul_zzv_z4q_dpb}  
So rufen Sie eine Liste von Service Desk-Mitarbeiter-IDs ab:

* Führen Sie aus GetAgentsList() Methode.
* Überprüfen Sie die Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler" \[sn_agent_cmdb_ci_agent\].
* Führen Sie aus [Agent-Clientsammler RUFT die Liste AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.")REST-API.
{#AccA-restartAgent_S__ul_yqc_3kj_z4b}
{#AccA-restartAgent_S__table_zk2_2g2_z4b__entry__3}{#AccA-restartAgent_S__accAgents-parm-desc-agentID}

| Name | Typ | Beschreibung |
|-|-|-|
| AGENTID | Zeichenfolge | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. |
[Tabelle : 8. Parameter]

{#AccA-restartAgent_S__table_zk2_2g2_z4b} {#AccA-restartAgent_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Fehlermeldung, falls zutreffend, andernfalls Null. |
[Tabelle : 9. Rückgaben]

{#AccA-restartAgent_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie ein Agent neu gestartet wird.

    var agentsApi = new sn_agent.AccAgentsAPI();

    var err = agentsApi.restartAgent("<agent_ID>");
    if (!gs.nil(err))
    	gs.error(err);

## AccAgentsAPI -- runDiscovery(String AGENTID) {#ariaid-title7}

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.
So rufen Sie eine Liste von Service Desk-Mitarbeiter-IDs ab:

* Führen Sie aus GetAgentsList() Methode.
* Überprüfen Sie die Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler" \[sn_agent_cmdb_ci_agent\].
* Führen Sie aus [Agent-Clientsammler RUFT die Liste AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.")REST-API.
{#AccA-runDiscovery_S__ul_yqc_3kj_z4b}
{#AccA-runDiscovery_S__table_zk2_2g2_z4b__entry__3}{#AccA-runDiscovery_S__accAgents-parm-desc-agentID}

| Name | Typ | Beschreibung |
|-|-|-|
| AGENTID | Zeichenfolge | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. |
[Tabelle : 10. Parameter]

{#AccA-runDiscovery_S__table_zk2_2g2_z4b} {#AccA-runDiscovery_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Fehlermeldung, falls zutreffend, andernfalls Null. Beispiel: `Agent mit ID: <agentID> ist nicht aktiv: Kein Fehler ausgelöst `. |
[Tabelle : 11. Rückgaben]

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

    var agentsApi = new sn_agent.AccAgentsAPI();

    var err = agentsApi.runDiscovery("<agent_ID>");

    if (!gs.nil(err))
    	gs.error(err);

## AccAgentsAPI -- setDataCollectionStatus (Zeichenfolge AGENTID, boolescher Status) {#ariaid-title8}

Legen Sie den angegebenen Datensammlungsstatus (wahr/falsch, wenn aktiviert oder nicht) für einen angegebenen Service Desk-Mitarbeiter fest.
So rufen Sie eine Liste von Service Desk-Mitarbeiter-IDs ab:

* Führen Sie aus GetAgentsList() Methode.
* Überprüfen Sie die Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler" \[sn_agent_cmdb_ci_agent\].
* Führen Sie aus [Agent-Clientsammler RUFT die Liste AB](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.")REST-API.
{#AccA-setDataCollectionStatus_S_B__ul_yqc_3kj_z4b}
{#AccA-setDataCollectionStatus_S_B__table_zk2_2g2_z4b__entry__3}{#AccA-setDataCollectionStatus_S_B__accAgents-parm-desc-agentID}

| Name | Typ | Beschreibung |
|-|-|-|
| AGENTID | Zeichenfolge | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. |
| Status | Boolean | Kennzeichnung, die angibt, ob die Datensammlung für den Service Desk-Mitarbeiter aktiviert ist. Gültige Werte: * Wahr: Aktiviert die Datensammlung für diesen Agent. * Falsch: Deaktiviert die Datensammlung für diesen Agent. {#AccA-setDataCollectionStatus_S_B__ul_iv2_jcz_bpb} Standard: Wahr |
[Tabelle : 12. Parameter]

{#AccA-setDataCollectionStatus_S_B__table_zk2_2g2_z4b} {#AccA-setDataCollectionStatus_S_B__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Fehlermeldung, falls zutreffend, andernfalls Null. Beispiel: `Agent mit ID: <agentID> ist nicht aktiv: Kein Fehler ausgelöst `. |
[Tabelle : 13. Rückgaben]

{#AccA-setDataCollectionStatus_S_B__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie die Datensammlung für Service Desk-Mitarbeiter aktiviert wird.

    var agentsApi = new sn_agent.AccAgentsAPI();
    var err = agentsApi.setDataCollectionStatus("<agentID>", true);
    if (!gs.nil(err))
       gs.error(err);

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

    var agentsApi = new sn_agent.AccAgentsAPI();
    var err = agentsApi.setDataCollectionStatus("<agentID>", false);
    if (!gs.nil(err))
       gs.error(err);

## AccAgentsAPI -- submitGrabLogRequest(Zeichenfolge AGENTID) {#ariaid-title9}

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 CheckGrabLogRequestProgress() Methode.
{#AccA-submitGrabLogRequest_S__table_zk2_2g2_z4b__entry__3}{#AccA-submitGrabLogRequest_S__accAgents-parm-desc-agentID}

| Name | Typ | Beschreibung |
|-|-|-|
| AGENTID | Zeichenfolge | Eindeutige ID eines Agenten, der in der Spalte „Agenten-ID" der Tabelle „Agenten-Clientsammler \[sn_agent_cmdb_ci_agent\]" aufgeführt ist. |
[Tabelle : 14. Parameter]

{#AccA-submitGrabLogRequest_S__table_zk2_2g2_z4b} {#AccA-submitGrabLogRequest_S__table_al2_2g2_z4b__entry__2}

| Eigenschaften | Beschreibung |
|-|-|
| \<Object\> | JSON-Objekt, das die Anforderungs-ID und alle Fehlerinformationen enthält. { "error": "String", "request_id": "String" } |
| Fehler | Fehlermeldung. Null, wenn kein Fehler vorliegt. Datentyp: Zeichenfolge |
| request_id | SYS_ID einer Anforderung in der Tabelle „Agenten-Client-Sammleranforderungen" \[sn_Agent_Request\]. Sie können diese ID verwenden, um den Status der Anforderung mit abzurufen /Agents/{Request_ID}/ ABRUFEN . Datentyp: Zeichenfolge |
[Tabelle : 15. Rückgaben]

{#AccA-submitGrabLogRequest_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Protokollanforderungs-ID abgerufen wird.

    var agentsApi = new sn_agent.AccAgentsAPI();
    var submittedRequest = agentsApi.submitGrabLogRequest("<agentID>");

    if (!gs.nil(submittedRequest.error))
       gs.error(submittedRequest.error);
    else
       gs.info("Request ID: " + submittedRequest.request_id);

Ausgabe:

    Request ID: <sys_id>


