--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # AccAgentsAPI: Bereichsbezogen # AccAgentsAPI: Bereichsbezogen {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 9 Minuten Lesedauer Mit der Skripteinbindung AccAgentsAPI können Sie Verwaltungsaktionen für verfügbare Service Desk-Mitarbeiter ausführen. Diese Skripteinbindung erfordert die Store-Anwendung Framework Agent Client Collector (sn_agent) und wird im Namespace `sn_agent` bereitgestellt. Weitere Informationen finden Sie unter [Agent Client Collector](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Informationen zur REST-API-Lösung finden Sie unter [Agent Client Collector API](https://servicenow-prod.fluidtopics.net/cJjDnd2cBThck5ShtcSWYw#agnt_clnt_cll-api "Die Agent Client Collector API bietet Endpunkte zum Verwalten von Aktionen für verfügbare Agents und zum Verwalten von Richtlinien."). Diese Skripteinbindung stellt Methoden bereit, die Folgendes ermöglichen: * Umfangreiche Informationen von einem oder mehreren Service Desk-Mitarbeitern abrufen. * Senden einer Anforderung, um ein Agent-Protokoll abzurufen und Informationen über den Fortschritt der Anforderung abzurufen. * Datenerfassung wird gestartet oder gestoppt. * Ein Agent wird neu gestartet. * Discovery wird auf einem 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 AccAgentsAPIinitialisiert wird. var agentsApi = new sn_agent.AccAgentsAPI(); ## AccAgentsAPI -- checkGrabLogRequestProgress(String requestId) {#ariaid-title3} Überprüft den Status einer Erfassungsprotokollanforderung. Führen Sie die Methode [„submitGrabLogRequest()](https://servicenow-prod.fluidtopics.net/zrSS52RFFYdo_JyjolCBIA#AccA-submitGrabLogRequest_S "Fordert das Protokoll eines angegebenen Agent mit dem Status „Aktiv“/„Aktiv“ an.") " aus, um eine Anforderungs-ID zu erhalten. {#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 „Agent Client Collector-Anforderungen" \[sn_agent_request\]. | [Tabelle : 2. Parameter] {#AccA-checkGrabLogRequestProgress_S__table_zk2_2g2_z4b} {#AccA-checkGrabLogRequestProgress_S__table_al2_2g2_z4b__entry__2} | Eigenschaften | Beschreibung | |-|-| | \ | JSON-Objekt, das den Status der Erfassungsprotokollanforderung enthält. { "status": Number, "output": "String" } | | status | Zahl, die den Status der Anforderung zum Abrufen des Protokolls angibt. Mögliche Werte: * 0: Anforderung zum Abrufen des Protokolls ist abgeschlossen. * 1: Protokollanforderung in Bearbeitung. * 2: Zeitüberschreitung bei der Anforderung zum Abrufen des Protokolls. * 3: Die Anforderung zum Abrufen des Protokolls weist einen Fehler auf. * 4: Die Anforderung für das Abrufprotokoll wurde nicht gefunden. {#AccA-checkGrabLogRequestProgress_S__ul_orq_4qr_bpb} | | Ausgabe | Informationen, die den Status beschreiben. | [Tabelle : 3. Ergebnisse] {#AccA-checkGrabLogRequestProgress_S__table_al2_2g2_z4b} Das folgende Beispiel zeigt, wie eine Anforderungs-ID verwendet wird, um den Status einer Erfassungsprotokollanforderung abzurufen. var agentsApi = new sn_agent.AccAgentsAPI(); var logRequestStatus = agentsApi.checkGrabLogRequestProgress(""); 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 Agent ab. So rufen Sie eine Liste der Agent-IDs ab: * Führen Sie die Methode getAgentsList() aus. * Überprüfen Sie die Spalte „Agent ID" in der Tabelle „Agent Client Collectors" \[sn_agent_cmdb_ci_agent\]. * Führen Sie die [Agent Client Collector GET list](https://servicenow-prod.fluidtopics.net/cJjDnd2cBThck5ShtcSWYw#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.") REST API aus. {#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 Agents, der in der Spalte „Agent ID" der Tabelle „Agent Client Collectors" \[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 | |-|-| | \ | Objekt mit erweiterten Informationen zum Service Desk-Mitarbeiter. { "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 Agent wie übermittelt. Datentyp: Zeichenfolge | | agent.data_collection | Die Datenerfassung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind. Mögliche Werte: * 0: Ein -- Prüfungen werden wie geplant ausgeführt. * 1: Aus (manuell) -- Prüfungen wurden manuell deaktiviert. * 2: Aus (auto) -- Prüfungen wurden aufgrund der hohen CPU-Auslastung durch automatisch deaktiviert {#AccA-getAgent_S__ul_w4n_53p_bpb} Datentyp: Zahl | | agent.ip_address | IP-Adresse des Agents. Datentyp: Zeichenfolge | | agent.is_duplicate | Kennzeichnung, die angibt, ob dieser Agent ein Duplikat eines anderen ist. Auf einem bestimmten Host darf nur ein einzelner Agent vorhanden sein. Mögliche Werte: * „wahr": Der Agent hat denselben Host wie ein aktiver Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat * „false": Dieser Service Desk-Mitarbeiter weist keine Duplikate im Status „Aktiv"/„Aktiv" auf. {#AccA-getAgent_S__ul_b34_ffl_bpb} Datentyp: Boolesch | | agent.is_restart_enabled | Kennzeichnung, die angibt, ob der Neustart aktiviert ist. Agent-Neustart ist nicht konfigurierbar. Sie hängt vom Betriebssystem und von der Version des Betriebssystems ab, auf dem der Agent ausgeführt wird. Mögliche Werte: * true: Neustart ist für diesen Agent aktiviert. * „falsch": Neustart ist für diesen Agent deaktiviert. {#AccA-getAgent_S__ul_bvp_dfl_bpb} Datentyp: Boolesch | | agent.name | Der Name des Außendienstmitarbeiters. Datentyp: Zeichenfolge | | agent.number_of_running_checks | Die Anzahl der vom Agent geplanten Prüfungen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind. Datentyp: Zahl | | 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 Keepalive-Nachricht erhalten. * 2: Ausgefallen -- Der Service Desk-Mitarbeiter hat seit langer Zeit keine Keepalive-Nachricht erhalten. * 3: Wird neu gestartet -- Der Agent wird neu gestartet. {#AccA-getAgent_S__ul_adg_ffp_bpb} Datentyp: Zahl | | agent.up_since | UTC-Zeit seit Änderung des Status des Service Desk-Mitarbeiters. Der Wert wird im [GlideDateTime](https://servicenow-prod.fluidtopics.net/u_rnp1jEndqk~Xtn_6vx_Q#c_GlideDateTimeScoped "Die bereichsbezogene GlideDateTime -Klasse bietet Methoden zum Ausführen von Vorgängen für GlideDateTime-Objekte.") -Format angegeben. Datentyp: Zeichenfolge | | agent.version | Version von Agent Client Collector, die der Agent ausführt. Datentyp: Zeichenfolge | [Tabelle : 5. Ergebnisse] {#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(""); 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 Sie alle Agent-Details abrufen. var agentsApi = new sn_agent.AccAgentsAPI(); var agentInfo = agentsAPI.getAgent(""); gs.info(JSON.stringify(agentInfo, null, 2)); Ausgabe: { "error": null, "agent": { "name": "win2016-dc-64bit", "status": 0, "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(String encodedQuery, Anzahlbegrenzung) {#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=xanadu&pubname=xanadu-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 undefiniert 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 von JSON-Objekten mit erweiterten Agent-Informationen. [ { "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" } ] | | agent_id | ID des Agent wie übermittelt. Datentyp: Zeichenfolge | | data_collection | Die Datenerfassung gibt an, ob geplante Prüfungen ausgeführt werden sollen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind. Mögliche Werte: * 0: Ein -- Prüfungen werden wie geplant ausgeführt. * 1: Aus (manuell) -- Prüfungen wurden manuell deaktiviert. * 2: Aus (auto) -- Prüfungen wurden aufgrund der hohen CPU-Auslastung durch automatisch deaktiviert {#AccA-getAgentsList_S_N__ul_w4n_53p_bpb} Datentyp: Zahl | | ip_address | IP-Adresse des Agents. Datentyp: Zeichenfolge | | is_duplicate | Kennzeichnung, die angibt, ob dieser Agent ein Duplikat eines anderen ist. Auf einem bestimmten Host darf nur ein einzelner Agent vorhanden sein. Mögliche Werte: * „wahr": Der Agent hat denselben Host wie ein aktiver Agent mit einer anderen Agent-ID. Deaktivieren oder deinstallieren Sie das Duplikat * „false": Dieser Service Desk-Mitarbeiter weist keine Duplikate im Status „Aktiv"/„Aktiv" auf. {#AccA-getAgentsList_S_N__ul_b34_ffl_bpb} Datentyp: Boolesch | | is_restart_enabled | Kennzeichnung, die angibt, ob der Neustart aktiviert ist. Agent-Neustart ist nicht konfigurierbar. Sie hängt vom Betriebssystem und von der Version des Betriebssystems ab, auf dem der Agent ausgeführt wird. Mögliche Werte: * true: Neustart ist für diesen Agent aktiviert. * „falsch": Neustart ist für diesen Agent deaktiviert. {#AccA-getAgentsList_S_N__ul_bvp_dfl_bpb} Datentyp: Boolesch | | name | Der Name des Außendienstmitarbeiters. Datentyp: Zeichenfolge | | number_of_running_checks | Die Anzahl der vom Agent geplanten Prüfungen. Diese Prüfungen sind Teil der Richtlinien, die für diesen Agent geplant sind. Datentyp: Zahl | | status | Status des Service Desk-Mitarbeiters. Mögliche Werte: * 0: Aktiv/Aktiv: Der Agent ist aktiv. * 1: Warnung -- Der Service Desk-Mitarbeiter hat in den letzten Minuten keine Keepalive-Nachricht erhalten. * 2: Ausgefallen -- Der Service Desk-Mitarbeiter hat seit langer Zeit keine Keepalive-Nachricht erhalten. * 3: Wird neu gestartet -- Der Agent wird neu gestartet. {#AccA-getAgentsList_S_N__ul_adg_ffp_bpb} Datentyp: Zahl | | up_since | UTC-Zeit seit Änderung des Status des Service Desk-Mitarbeiters. Der Wert wird im [GlideDateTime](https://servicenow-prod.fluidtopics.net/u_rnp1jEndqk~Xtn_6vx_Q#c_GlideDateTimeScoped "Die bereichsbezogene GlideDateTime -Klasse bietet Methoden zum Ausführen von Vorgängen für GlideDateTime-Objekte.") -Format angegeben. Datentyp: Zeichenfolge | | Version | Version von Agent Client Collector, die der Agent ausführt. Datentyp: Zeichenfolge | [Tabelle : 7. Ergebnisse] {#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 Service Desk-Mitarbeiter 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 alle Mitarbeiter im System aufgelistet werden. In diesem Beispiel wird 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 die bereitgestellten Ergebnisse iteriert werden, 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 -- neustartAgent(Zeichenfolge agentID) {#ariaid-title6} Startet einen angegebenen Agent mit dem Status „Aktiv"/„Aktiv" neu. Wenn Agent Client Collector Leistungsprobleme auftreten, können Sie den Agent neu starten. Der manuelle Neustart wird in den folgenden Umgebungen unterstützt: * Linux-basierte Agents mit `systemd` * Windows-Agents {#AccA-restartAgent_S__ul_zzv_z4q_dpb} So rufen Sie eine Liste der Agent-IDs ab: * Führen Sie die Methode getAgentsList() aus. * Überprüfen Sie die Spalte „Agent ID" in der Tabelle „Agent Client Collectors" \[sn_agent_cmdb_ci_agent\]. * Führen Sie die [Agent Client Collector GET list](https://servicenow-prod.fluidtopics.net/cJjDnd2cBThck5ShtcSWYw#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.") REST API aus. {#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 Agents, der in der Spalte „Agent ID" der Tabelle „Agent Client Collectors" \[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. Ausgabe] {#AccA-restartAgent_S__table_al2_2g2_z4b} Das folgende Beispiel zeigt, wie Sie einen Agent neu starten. var agentsApi = new sn_agent.AccAgentsAPI(); var err = agentsApi.restartAgent(""); if (!gs.nil(err)) gs.error(err); ## AccAgentsAPI -- runDiscovery(Zeichenfolge -- agentID) {#ariaid-title7} Führt eine Discovery-Prüfung durch, um CIs zu finden, die sich auf einen Agent beziehen. Der angegebene Agent muss sich im Status „Aktiv"/„Aktiv" befinden. So rufen Sie eine Liste der Agent-IDs ab: * Führen Sie die Methode getAgentsList() aus. * Überprüfen Sie die Spalte „Agent ID" in der Tabelle „Agent Client Collectors" \[sn_agent_cmdb_ci_agent\]. * Führen Sie die [Agent Client Collector GET list](https://servicenow-prod.fluidtopics.net/cJjDnd2cBThck5ShtcSWYw#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.") REST API aus. {#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 Agents, der in der Spalte „Agent ID" der Tabelle „Agent Client Collectors" \[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: `Service Desk-Mitarbeiter mit ID:`\ Ist nicht in Betrieb: kein ausgelöster Fehler . | [Tabelle : 11. Ausgabe] {#AccA-runDiscovery_S__table_al2_2g2_z4b} Das folgende Beispiel zeigt, wie Discovery für einen Agent mit dem Status „Aktiv"/„Aktiv" ausgeführt wird. var agentsApi = new sn_agent.AccAgentsAPI(); var err = agentsApi.runDiscovery(""); if (!gs.nil(err)) gs.error(err); ## AccAgentsAPI -- setDataCollectionStatus(String agentID, boolescher Status) {#ariaid-title8} Legen Sie den angegebenen Datensammlungsstatus (wahr/falsch, falls aktiviert oder nicht) für einen bestimmten Agent fest. So rufen Sie eine Liste der Agent-IDs ab: * Führen Sie die Methode getAgentsList() aus. * Überprüfen Sie die Spalte „Agent ID" in der Tabelle „Agent Client Collectors" \[sn_agent_cmdb_ci_agent\]. * Führen Sie die [Agent Client Collector GET list](https://servicenow-prod.fluidtopics.net/cJjDnd2cBThck5ShtcSWYw#agnt_clnt_cll-GET-list "Ruft eine Liste von Service Desk-Mitarbeitern mit zugehörigen Informationen ab.") REST API aus. {#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 Agents, der in der Spalte „Agent ID" der Tabelle „Agent Client Collectors" \[sn_agent_cmdb_ci_agent\] aufgeführt ist. | | status | Boolean | Kennzeichnung, die angibt, ob die Datenerfassung für den Agent aktiviert ist. Gültige Werte: * true: Aktiviert die Datenerfassung für diesen Agent. * „falsch": Deaktiviert die Datenerfassung für diesen Agent. {#AccA-setDataCollectionStatus_S_B__ul_iv2_jcz_bpb} Standardwert: true | [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: `Service Desk-Mitarbeiter mit ID:`\ Ist nicht in Betrieb: kein ausgelöster Fehler . | [Tabelle : 13. Ergebnisse] {#AccA-setDataCollectionStatus_S_B__table_al2_2g2_z4b} Das folgende Beispiel zeigt, wie die Agent-Datenerfassung aktiviert wird. var agentsApi = new sn_agent.AccAgentsAPI(); var err = agentsApi.setDataCollectionStatus("", true); if (!gs.nil(err)) gs.error(err); Das folgende Beispiel zeigt, wie die Agent-Datenerfassung deaktiviert wird. var agentsApi = new sn_agent.AccAgentsAPI(); var err = agentsApi.setDataCollectionStatus("", false); if (!gs.nil(err)) gs.error(err); ## AccAgentsAPI --submitGrabLogRequest(String agentId) {#ariaid-title9} Fordert das Protokoll eines angegebenen Agent mit dem Status „Aktiv"/„Aktiv" an. Hinweis: Um das Protokoll abzurufen und seinen Fortschritt zu überprüfen, übergeben Sie die zurückgegebene Anforderungs-ID an die Methode checkGrabLogRequestProgress(). {#AccA-submitGrabLogRequest_S__table_zk2_2g2_z4b__entry__3}{#AccA-submitGrabLogRequest_S__accAgents-parm-desc-agentID} | Name | Typ | Beschreibung | |-|-|-| | agentID | Zeichenfolge | Eindeutige ID eines Agents, der in der Spalte „Agent ID" der Tabelle „Agent Client Collectors" \[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 | |-|-| | \ | JSON-Objekt, das die Anforderungs-ID und etwaige 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 „Agent Client Collector-Anforderungen" \[sn_agent_request\]. Sie können diese ID verwenden, um den Status der Anforderung mit GET /agents/{request_id}/ abzurufen. Datentyp: Zeichenfolge | [Tabelle : 15. Ergebnisse] {#AccA-submitGrabLogRequest_S__table_al2_2g2_z4b} Das folgende Beispiel zeigt, wie Sie eine Protokollanforderungs-ID abrufen. var agentsApi = new sn_agent.AccAgentsAPI(); var submittedRequest = agentsApi.submitGrabLogRequest(""); if (!gs.nil(submittedRequest.error)) gs.error(submittedRequest.error); else gs.info("Request ID: " + submittedRequest.request_id); Ausgabe: Request ID: