AccCheckDefsAPI – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 9 Minuten Lesedauer

    • Die AccCheckDefsAPI Mithilfe der Skripteinbindung können Prüfungsdefinitionen und zugehörige Parameter verwaltet werden.

    Diese Skripteinbindung erfordert Agent Client Collector Framework (sn_Agent) speichert die Anwendung und wird in bereitgestellt sn_Agent Namespace. Diese Skripteinbindung erfordert die Rolle Agent_Client_Collector_admin. Weitere Informationen finden Sie unter Agent Client Collector .

    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 Client Collector-API .

    Diese Skripteinbindung stellt Methoden bereit, die Folgendes ermöglichen:
    • Ruft eine angegebene Prüfungsdefinition ab
    • Ruft eine Liste der Prüfungsdefinitionen ab
    • Aktualisieren Sie Prüfungen und Prüfparameter

    AccCheckDefsAPI – getCheck(Zeichenfolge checkDefId, Boolesch withParams)

    Ruft eine angegebene Prüfungsdefinition mit Details ab.

    Tabelle : 1. Parameter
    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:
    • True: Gibt Details zu Prüfparametern zurück.
    • Falsch: Prüfparameterdetails nicht zurückgeben.

    Standardwert: False
    Tabelle : 2. Rückgaben
    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 Service Desk-Mitarbeiter beginnt 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.

    Datentyp: Boolesch
    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: Überprüfen Sie, ob Ergebnisse in ein Ereignismanagement-Ereignis umgewandelt werden.
    • Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    check.command Befehl, dass Agent Client Collector Wird ausgeführt.

    Datentyp: Zeichenfolge
    Überprüfen.Fehler Meldung, wenn ein Fehler vorliegt. Andernfalls Null.

    Datentyp: Zeichenfolge
    check.name Name der Prüfung.

    Datentyp: Zeichenfolge
    Check.params Liste der Parameterdefinitionen, die der Prüfungsdefinition zugeordnet sind. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    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.

    Datentyp: Boolesch
    check.params.default_value Gibt den Standardwert für diesen Prüfparameter an.

    Datentyp: Zeichenfolge
    Prüfung.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.

    Datentyp: Boolesch
    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 Collector Plugins 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.

    Datentyp: Boolesch
    check.secure_params Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    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.

    Datentyp: Boolesch
    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

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

    Ruft eine Liste von Prüfungsdefinitionen mit Details ab.

    Siehe auch Prüfungen und Richtlinien .

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    encodedQuery Zeichenfolge Ein Codierte Abfragezeichenfolge Zum Filtern der Ergebnisliste der Prüfungsdefinition. Verwenden Sie null für eine ungefilterte Liste von Prüfungsdefinitionen im System.
    limit Anzahl Begrenzt die Anzahl der zurückgegebenen Datensätze. Legen Sie diese Option auf Null fest, 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:
    • True: Gibt Details zu Prüfparametern zurück.
    • Falsch: Prüfparameterdetails nicht zurückgeben.

    Standardwert: False
    Tabelle : 4. Rückgaben
    Eigenschaften Beschreibung
    Prüfungsdefinitionen 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 Service Desk-Mitarbeiter beginnt 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.

    Datentyp: Boolesch
    Check_Group Gruppe, die für diese Prüfungsdefinition angegeben ist.

    Datentyp: Zeichenfolge
    Check_type Typ der Prüfung.
    Mögliche Werte:
    • Ereignisse: Überprüfen Sie, ob Ergebnisse in ein Ereignismanagement-Ereignis umgewandelt werden.
    • Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, dass Agent Client Collector Wird 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 die withParamsParameter ist auf „wahr“ festgelegt.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    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.

    Datentyp: Boolesch
    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.

    Datentyp: Boolesch
    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 Collector Plugins 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.

    Datentyp: Boolesch
    Secure_params Liste der dieser Prüfung zugewiesenen. Diese Ergebnisse werden nur berücksichtigt, wenn die withParamsParameter ist auf „wahr“ festgelegt.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    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.

    Datentyp: Boolesch
    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

    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)

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

    Siehe auch Prüfungen und Richtlinien .

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    checkDefId Zeichenfolge SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen“ [sn_Agent_Check_def] aufgeführt ist.
    AktualisierenJSON Objekt Zuordnung der Prüfdefinitionsfelder, 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
}
    AktualisierungJson.aktiv Anzahl Gibt an, ob diese Prüfungsdefinition aktiv ist.
    Gültige Werte:
    • 0: Diese Prüfungsdefinition ist inaktiv.
    • 1: Diese Prüfungsdefinition ist aktiv.
    AktualisierungJson.Hintergrund Boolean Kennzeichnung, die angibt, ob diese Prüfungsdefinition eine Hintergrundprüfung ist. Eine Hintergrundprüfung ist eine Prüfung, deren Ausführung der Service Desk-Mitarbeiter beginnt 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.
    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: Überprüfen Sie, ob Ergebnisse in ein Ereignismanagement-Ereignis umgewandelt werden.
    • Metriken: Werte aus dem Prüfergebnis werden in Metriken umgewandelt.
    updateJson.command Zeichenfolge Befehl, dass Agent Client Collector Wird ausgeführt.
    updateJson.name Zeichenfolge Name der Prüfung.
    updateJson.plugins Array Liste von Agent Client Collector Plugins 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.
    UpdateJson.Timeout Anzahl Zeitüberschreitung in Sekunden.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine Fehlermeldung, wenn nicht erfolgreich.

    Das folgende Beispiel zeigt, wie Sie eine Prüfungsdefinition deaktivieren.

    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)

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

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    CheckDefParamId Zeichenfolge SYS_ID des Prüfparameters, der in der Tabelle „Prüfparameterdefinitionen“ [sn_Agent_Check_param_def] aufgeführt ist.
    AktualisierenJSON Objekt Zuordnung der Prüfparameterfelder, die auf ihre neuen Werte aktualisiert werden sollen. Im Datenwörterbuch finden Sie eine umfassende Liste der Felder und Typen der sicheren Parameterdefinition überprüfen.
    {
 "active": Boolean,
 "default_value": "String",
 "mandatory": Boolean,
 "name": "String"
}
    AktualisierungJson.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.
    updateJson.default_value Zeichenfolge Gibt den Standardwert für diesen Prüfparameter an.
    AktualisierungJson.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.
    updateJson.name Zeichenfolge Name des Prüfparameters.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Keine Fehlermeldung, wenn nicht erfolgreich.

    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)

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

    Tabelle : 9. Parameter
    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.
    AktualisierenJSON Objekt Zuordnung von Prüffeldern für sichere Parameter, die auf ihre neuen Werte aktualisiert werden sollen. Im Datenwörterbuch finden Sie eine umfassende Liste der Felder und Typen der sicheren Parameterdefinition überprüfen.
    {
 "active": Boolean,
 "name": "String",
 "order": Number
}
    AktualisierungJson.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.
    updateJson.name Zeichenfolge Name des sicheren Parameters.
    AktualisierungJson.Auftrag Anzahl Reihenfolge, in der der Parameter an den Prüfungsbefehl/das Skript gesendet wird.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Keine Fehlermeldung, wenn nicht erfolgreich.

    Das folgende Beispiel zeigt, wie Sie einen Parameter für die Prüfung des sicheren Parameters aktivieren.

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