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


---

# AccCheckDefsAPI -- Umfang

# AccCheckDefsAPI -- Umfang {#ariaid-title1}

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

Die AccCheckDefsAPI Die Skripteinbindung ermöglicht die Verwaltung von Prüfungsdefinitionen und zugehörigen Parametern.

Diese Skripteinbindung erfordert Agent Client CollectorFramework (sn_Agent) Store-Anwendung und wird in bereitgestellt `sn_Agent `Namespace. Diese Skripteinbindung erfordert 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).

Diese Skripteinbindung hat keinen Konstruktor zum Erstellen einer Instanz. Rufen Sie jede Methode mit auf AccCheckDefsAPI Statische Klasse im folgenden Format:

`sn_Agent.AccCheckDefsAPI.<method>`

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:

* Ruft eine angegebene Prüfungsdefinition ab
* Ruft eine Liste der Prüfungsdefinitionen ab
* Aktualisieren Sie Prüfungen und Prüfparameter
{#AccCheckDefsAPIAPIScoped__ul_rqf_bdx_5qb}

## AccCheckDefsAPI -- getCheck(Zeichenfolge checkDefId, boolescher Wert mit Parametern) {#ariaid-title2}

Ruft eine angegebene Prüfungsdefinition mit Details ab.
{#AccCkDf-getCheck_S_B__table_zk2_2g2_z4b__entry__3}{#AccCkDf-getCheck_S_B__accCheckDefs-parms-withParms-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| checkDefId | Zeichenfolge | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. |
| Mit Parametern | Boolean | 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. {#AccCkDf-getCheck_S_B__ul_pv3_gqc_wqb} Standard: Falsch |
[Tabelle : 1. Parameter]

{#AccCkDf-getCheck_S_B__table_zk2_2g2_z4b} {#AccCkDf-getCheck_S_B__table_al2_2g2_z4b__entry__2}{#AccCkDf-getCheck_S_B__accCkDf-background-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-chkGrp-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-chkTyp-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-command-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-name-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-active-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-default-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-mando-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-name-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-id-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-plugins-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-proxy-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-active-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-name-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-order-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-id-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-id-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-timeout-desc-ph}

| Eigenschaften | Beschreibung |
|-|-|
| Überprüfen | Details der angegebenen Prüfungsdefinition. "check ": { "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 } |
| Überprüfen.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. {#AccCkDf-getCheck_S_B__ul_ypb_5ps_5qb} Datentyp: Boolescher Wert |
| check.check_group | Gruppe, die für diese Prüfungsdefinition angegeben ist. Datentyp: Zeichenfolge |
| check.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. {#AccCkDf-getCheck_S_B__ul_gtr_kfb_wqb} Datentyp: Zeichenfolge |
| check.command | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. Datentyp: Zeichenfolge |
| Check.error | Meldung, wenn ein Fehler vorliegt. Andernfalls Null. Datentyp: Zeichenfolge |
| check.name | Name der Prüfung. Datentyp: Zeichenfolge |
| Check.Parameters | 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" } ] {#AccCkDf-getCheck_S_B__accCkDf-p-code} Datentyp: Array |
| check.params.active | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Der Prüfparameter ist aktiv. * Falsch: Der Prüfparameter ist inaktiv. {#AccCkDf-getCheck_S_B__ul_pnb_jyc_wqb} Datentyp: Boolescher Wert |
| check.params.default_value | Gibt den Standardwert für diesen Prüfparameter an. Datentyp: Zeichenfolge |
| Check.params.obligatorisch | Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist. Gültige Werte: * Wahr: Der Prüfparameter ist erforderlich. * Falsch: Der Prüfparameter ist optional. {#AccCkDf-getCheck_S_B__ul_wtg_2zc_wqb} Datentyp: Boolescher Wert |
| check.params.name | Name des Prüfparameters. Datentyp: Zeichenfolge |
| Check.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 |
| check.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 |
| check.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. {#AccCkDf-getCheck_S_B__ul_wbf_qps_5qb} Datentyp: Boolescher Wert |
| check.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" } ] {#AccCkDf-getCheck_S_B__accCkDf-sp-code} Datentyp: Array |
| check.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. {#AccCkDf-getCheck_S_B__ul_g1b_3vc_wqb} Datentyp: Boolescher Wert |
| check.secure_params.name | Name des sicheren Parameters. Datentyp: Zeichenfolge |
| check.secure_params.order | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. Datentyp: Zahl |
| check.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 |
| Check.sys_ID | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. Datentyp: Zeichenfolge |
| Check.Timeout | Zeitüberschreitung in Sekunden. Datentyp: Zahl |
[Tabelle : 2. Rückgaben]

{#AccCkDf-getCheck_S_B__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Informationen für eine angegebene Prüfungsdefinition abgerufen werden.

    var checkDefId = "94436b237f705300f128134f8dfa91a4";
    var withParams = true;

    var checkDef = sn_agent.AccCheckDefsAPI.getCheck(checkDefId, withParams);

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

Ausgabe:

    {
      "check": {
        "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"
          }
        ]
      },
      "error": null
    }

## AccCheckDefsAPI -- getChecksList(Zeichenfolge encodedQuery, Nummernlimit, boolescher Wert mit Parametern) {#ariaid-title3}

Ruft eine Liste von Prüfungsdefinitionen mit Details ab.
Siehe auch [Prüfungen und Richtlinien](https://www.servicenow.com/docs/access?context=checks-policies&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).
{#AccCkDf-getChecksList_S_N_B__table_zk2_2g2_z4b__entry__3}{#AccCkDf-getChecksList_S_N_B__accCheckDefs-parms-encQuery-desc}{#AccCkDf-getChecksList_S_N_B__accCheckDefs-parms-withParms-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| encodedQuery | Zeichenfolge | 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. |
| limit | Nummer | Begrenzt die Anzahl der zurückgegebenen Datensätze. Auf Null festlegen, um den Standardwert zu verwenden. Standard: 20.000 |
| Mit Parametern | Boolean | 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. {#AccCkDf-getChecksList_S_N_B__ul_pv3_gqc_wqb} Standard: Falsch |
[Tabelle : 3. Parameter]

{#AccCkDf-getChecksList_S_N_B__table_zk2_2g2_z4b} {#AccCkDf-getChecksList_S_N_B__table_al2_2g2_z4b__entry__2}{#AccCkDf-getChecksList_S_N_B__accCkDf-background-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-chkGrp-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-chkTyp-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-command-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-name-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-active-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-default-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-mando-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-name-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-id-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-plugins-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-proxy-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-active-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-name-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-order-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-id-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-id-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-timeout-desc-ph}

| Eigenschaften | 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. {#AccCkDf-getChecksList_S_N_B__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. {#AccCkDf-getChecksList_S_N_B__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" } ] {#AccCkDf-getChecksList_S_N_B__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. {#AccCkDf-getChecksList_S_N_B__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. {#AccCkDf-getChecksList_S_N_B__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. {#AccCkDf-getChecksList_S_N_B__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" } ] {#AccCkDf-getChecksList_S_N_B__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. {#AccCkDf-getChecksList_S_N_B__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 |
[Tabelle : 4. Rückgaben]

{#AccCkDf-getChecksList_S_N_B__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Liste von zwei Prüfungsdefinitionen mit Parameterwerten abgerufen wird.

    var encQuery = "nameSTARTSWITHchecks_";
    var limit = 2;
    var withParams = true;

    var checkDefs = sn_agent.AccCheckDefsAPI.getChecksList(encQuery, limit, withParams);

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

Ausgabe:

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

## AccCheckDefsAPI -- updateCheck(Zeichenfolge checkDefId, Object updateJson) {#ariaid-title4}

Ermöglicht das Ändern eines oder mehrerer Feldwerte einer angegebenen Prüfungsdefinition.
Siehe auch [Prüfungen und Richtlinien](https://www.servicenow.com/docs/access?context=checks-policies&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).
{#AccCkDf-updateCheck_S_O__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| checkDefId | Zeichenfolge | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. |
| UpdateJSON | Objekt | Zuordnung der Prüfungsdefinitionsfelder, die auf ihre neuen Werte aktualisiert werden sollen. Im Datenwörterbuch finden Sie eine umfassende Liste der Prüfungsdefinitionsfelder und -Typen. { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "name": "String", "plugins": [Array], "proxy_valid": Boolean, "timeout": Number } |
| UpdateJSON.aktiv | Nummer | Gibt an, ob diese Prüfungsdefinition aktiv ist. Gültige Werte: * 0: Diese Prüfungsdefinition ist inaktiv. * 1: Diese Prüfungsdefinition ist aktiv. {#AccCkDf-updateCheck_S_O__ul_gdc_4wj_wqb} |
| UpdateJson.Hintergrund | Boolean | 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. {#AccCkDf-updateCheck_S_O__ul_ypb_5ps_5qb} |
| updateJson.check_group | Zeichenfolge | Gruppe, die für diese Prüfungsdefinition angegeben ist. |
| updateJson.check_type | Zeichenfolge | 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. {#AccCkDf-updateCheck_S_O__ul_gtr_kfb_wqb} |
| updateJson.command | Zeichenfolge | Befehl, der verwendet wird Agent Client CollectorWird ausgeführt. |
| updateJson.name | Zeichenfolge | Name der Prüfung. |
| updateJson.plugins | Array | 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. |
| updateJson.proxy_valid | Boolean | 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. {#AccCkDf-updateCheck_S_O__ul_wbf_qps_5qb} |
| UpdateJson.Timeout | Nummer | Zeitüberschreitung in Sekunden. |
[Tabelle : 5. Parameter]

{#AccCkDf-updateCheck_S_O__table_zk2_2g2_z4b} {#AccCkDf-updateCheck_S_O__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine | Fehlermeldung, wenn nicht erfolgreich. |
[Tabelle : 6. Rückgaben]

{#AccCkDf-updateCheck_S_O__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Prüfungsdefinition deaktiviert wird.

    var checkJson = sn_agent.AccCheckDefsAPI.getCheck(activeCheckDefs[0].sys_id, true);
    if (!gs.nil(checkJson.error))
    	gs.error(checkJson.error);

    var updateJson = {active: "0"}; // deactivate the check definition
    sn_agent.AccCheckDefsAPI.updateCheck(checkJson.check.sys_id, updateJson);

## AccCheckDefsAPI -- updateCheckParam(Zeichenfolge checkDefParamId, Object updateJson) {#ariaid-title5}

Ermöglicht das Ändern eines oder mehrerer Feldwerte eines angegebenen Prüfparameters.
{#AccCkDf-updateCheckParam_S_O__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| CheckDefParamId | Zeichenfolge | SYS_ID des Prüfparameters, der in der Tabelle „Prüfparameterdefinitionen" \[sn_agent_check_param_def\] aufgeführt ist. |
| UpdateJSON | Objekt | Zuordnung der Prüfparameterfelder, die auf die neuen Werte aktualisiert werden sollen. Im Datenwörterbuch finden Sie eine umfassende Liste der Felder und Typen für sichere Parameterdefinition überprüfen. { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String" } |
| UpdateJSON.aktiv | Boolean | Kennzeichnung, die angibt, ob der Prüfparameter aktiv ist. Gültige Werte: * Wahr: Der Prüfparameter ist aktiv. * Falsch: Der Prüfparameter ist inaktiv. {#AccCkDf-updateCheckParam_S_O__ul_pnb_jyc_wqb} |
| updateJson.default_value | Zeichenfolge | Gibt den Standardwert für diesen Prüfparameter an. |
| UpdateJson.obligatorisch | Boolean | Kennzeichnung, die angibt, ob der Prüfparameter erforderlich ist. Gültige Werte: * Wahr: Der Prüfparameter ist erforderlich. * Falsch: Der Prüfparameter ist optional. {#AccCkDf-updateCheckParam_S_O__ul_wtg_2zc_wqb} |
| updateJson.name | Zeichenfolge | Name des Prüfparameters. |
[Tabelle : 7. Parameter]

{#AccCkDf-updateCheckParam_S_O__table_zk2_2g2_z4b} {#AccCkDf-updateCheckParam_S_O__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine | Fehlermeldung, wenn nicht erfolgreich. |
[Tabelle : 8. Rückgaben]

{#AccCkDf-updateCheckParam_S_O__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie ein Prüfparameter aktiviert wird.

    var checkParmSysId = "cd922ce6dba530106f4810284b961966";
    var updateJson = {"active": "true"};
    sn_agent.AccCheckDefsAPI.updateCheckSecureParam(checkParmSysId, updateJson);

## AccCheckDefsAPI -- updateCheckSecureParam(Zeichenfolge checkDefSecureParamId, Object updateJson) {#ariaid-title6}

Ermöglicht das Ändern eines oder mehrerer Feldwerte eines angegebenen Prüfungsparameters.
{#AccCkDf-updateCheckSecureParam_S_O__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| CheckDefSecureParamId | Zeichenfolge | SYS_ID des sicheren Parameters, der in der Tabelle „sichere Parameterdefinitionen überprüfen" \[sn_agent_check_secure_param_def\] aufgeführt ist. |
| UpdateJSON | Objekt | Zuordnung der Prüffelder für sichere Parameter, die auf die neuen Werte aktualisiert werden sollen. Im Datenwörterbuch finden Sie eine umfassende Liste der Felder und Typen für sichere Parameterdefinition überprüfen. { "active": Boolean, "name": "String", "order": Number } |
| UpdateJSON.aktiv | Boolean | Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist. Gültige Werte: * Wahr: Der sichere Parameter ist aktiv. * Falsch: Der sichere Parameter ist inaktiv. {#AccCkDf-updateCheckSecureParam_S_O__ul_g1b_3vc_wqb} |
| updateJson.name | Zeichenfolge | Name des sicheren Parameters. |
| UpdateJSON.Auftrag | Nummer | Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird. |
[Tabelle : 9. Parameter]

{#AccCkDf-updateCheckSecureParam_S_O__table_zk2_2g2_z4b} {#AccCkDf-updateCheckSecureParam_S_O__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine | Fehlermeldung, wenn nicht erfolgreich. |
[Tabelle : 10. Rückgaben]

{#AccCkDf-updateCheckSecureParam_S_O__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie einen Parameter für die Prüfung auf Sicherheit aktivieren.

    var checkSecParmSysId = "<sys_id>";
    var updateJson = {"active": "true"};
    sn_agent.AccCheckDefsAPI.updateCheckSecureParam(checkSecParmSysId, updateJson);


