AccCheckDefsAPI: Bereichsbezogen

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 9 Minuten Lesedauer

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

    Diese Skripteinbindung erfordert die Store-Anwendung Framework Agent Client Collector (sn_agent) und wird im Namespace sn_agent bereitgestellt. Diese Skripteinbindung erfordert die Rolle agent_client_collector_admin. Weitere Informationen finden Sie unter Agent Client Collector.

    Diese Skripteinbindung verfügt nicht über einen Konstruktor zum Erstellen einer Instanz. Rufen Sie jede Methode mit der statischen Klasse AccCheckDefsAPI im folgenden Format auf:

    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 von Prüfungsdefinitionen ab
    • Aktualisieren Sie Prüfungen und Prüfungsparameter

    AccCheckDefsAPI – getCheck(String checkDefId, Boolean 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.
    withParams 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“: Prüfparameterdetails zurückgeben.
    • „falsch“: Gibt keine Prüfparameterdetails zurück.

    Standardwert: False
    Tabelle : 2. Ergebnisse
    Eigenschaften Beschreibung
    Scheck 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
}
    check.background Kennzeichnung, die angibt, ob es sich bei dieser Prüfungsdefinition um eine Hintergrundprüfung handelt. Bei einer Hintergrundprüfung startet der Agent die Ausführung von und wartet nicht, bis die Ausführung 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 Für diese Prüfungsdefinition angegebene Gruppe.

    Datentyp: Zeichenfolge
    check.check_type Typ des Schecks
    Mögliche Werte:
    • Ereignisse: Ergebnisse von Check werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    check.command Befehl, den der Agent Client Collector ausführt.

    Datentyp: Zeichenfolge
    check.error Meldung, wenn ein Fehler auftritt. Andernfalls NULL.

    Datentyp: Zeichenfolge
    check.name Name des Schecks

    Datentyp: Zeichenfolge
    check.params Liste der Parameterdefinitionen, die der Prüfungsdefinition zugeordnet sind. Diese Ergebnisse werden nur eingeschlossen, wenn der Parameter withParams auf „wahr“ festgelegt ist.
    "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
    überprü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 „Definitionen für sichere Parameter prüfen“ [sn_agent_check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    check.plugins Liste der Agent Client Collector Plugins, die dieser Prüfung zugeordnet sind.

    Datentyp: Array
    check.proxy_valid Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie als Proxy festgelegt ist.
    Gültige Werte:
    • wahr: Diese Prüfungsdefinitionsrichtlinie ist als Proxy festgelegt.
    • „falsch“: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy konfiguriert.

    Datentyp: Boolesch
    check.secure_params Liste der diesem Scheck zugewiesenen. Diese Ergebnisse werden nur eingeschlossen, wenn der Parameter withParams auf „wahr“ festgelegt ist.
    "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.
    • „false“: 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 Überprüfungsbefehl/das Überprüfungsskript gesendet wird.

    Datentyp: Zahl
    check.secure_params.sys_id Sys_id des sicheren Parameters, der in der Tabelle „Definitionen sicherer Parameter prü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(String encodedQuery, Anzahlbegrenzung, Boolescher Wert mitParams)

    Ruft eine Liste von Prüfungsdefinitionen mit Details ab.

    Siehe auch Prüfungen und Richtlinien.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    encodedQuery Zeichenfolge Eine codierte Abfragezeichenfolge zum Filtern der Ergebnisliste der Prüfungsdefinitionen. Verwenden Sie NULL für eine ungefilterte Liste von Prüfungsdefinitionen im System.
    limit Nummer Begrenzt die Anzahl der zurückgegebenen Datensätze. Legen Sie den Wert auf null fest, um den Standardwert zu verwenden.

    Standard: 20.000
    withParams 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“: Prüfparameterdetails zurückgeben.
    • „falsch“: Gibt keine Prüfparameterdetails zurück.

    Standardwert: False
    Tabelle : 4. Ergebnisse
    Eigenschaften Beschreibung
    Prüfungsdefinitionen Liste der Prüfungsdefinitionen 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 es sich bei dieser Prüfungsdefinition um eine Hintergrundprüfung handelt. Bei einer Hintergrundprüfung startet der Agent die Ausführung von und wartet nicht, bis die Ausführung 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 Für diese Prüfungsdefinition angegebene Gruppe.

    Datentyp: Zeichenfolge
    check_type Typ des Schecks
    Mögliche Werte:
    • Ereignisse: Ergebnisse von Check werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.

    Datentyp: Zeichenfolge
    command Befehl, den der Agent Client Collector ausführt.

    Datentyp: Zeichenfolge
    name Name des Schecks

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

    Datentyp: Array
    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
    params.default_value Gibt den Standardwert für diesen Prüfparameter an.

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

    Datentyp: Boolesch
    params.name Name des Prüfparameters.

    Datentyp: Zeichenfolge
    params.sys_id Sys_id des Prüfparameters, der in der Tabelle „Definitionen für sichere Parameter prüfen“ [sn_agent_check_param_def] aufgeführt ist.

    Datentyp: Zeichenfolge
    Plugins Liste der Agent Client Collector Plugins, die dieser Prüfung zugeordnet sind.

    Datentyp: Array
    proxy_valid Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie als Proxy festgelegt ist.
    Gültige Werte:
    • wahr: Diese Prüfungsdefinitionsrichtlinie ist als Proxy festgelegt.
    • „falsch“: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy konfiguriert.

    Datentyp: Boolesch
    Secure_params Liste der diesem Scheck zugewiesenen. Diese Ergebnisse werden nur eingeschlossen, wenn der Parameter withParams auf „wahr“ festgelegt ist.
    "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.
    • „false“: 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 Überprüfungsbefehl/das Überprüfungsskript gesendet wird.

    Datentyp: Zahl
    Secure_params.sys_id Sys_id des sicheren Parameters, der in der Tabelle „Definitionen sicherer Parameter prü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 mit 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(String 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.
    updateJson Objekt Zuordnung der Prüfungsdefinitionsfelder, die auf ihre neuen Werte aktualisiert werden sollen. Eine umfassende Liste der Felder und Typen von Prüfungsdefinitionen finden Sie im Datenwörterbuch.
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "name": "String",
 "plugins": [Array],
 "proxy_valid": Boolean,
 "timeout": Number
}
    updateJson.active Nummer Gibt an, ob diese Prüfungsdefinition aktiv ist.
    Gültige Werte:
    • 0: Diese Prüfungsdefinition ist inaktiv.
    • 1: Diese Prüfungsdefinition ist aktiv.
    updateJson.background Boolean Kennzeichnung, die angibt, ob es sich bei dieser Prüfungsdefinition um eine Hintergrundprüfung handelt. Bei einer Hintergrundprüfung startet der Agent die Ausführung von und wartet nicht, bis die Ausführung 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 Für diese Prüfungsdefinition angegebene Gruppe.
    updateJson.check_type Zeichenfolge Typ des Schecks
    Mögliche Werte:
    • Ereignisse: Ergebnisse von Check werden in ein Ereignismanagement-Ereignis umgewandelt.
    • Metriken: Werte aus dem Prüfungsergebnis werden in Metriken umgewandelt.
    updateJson.command Zeichenfolge Befehl, den der Agent Client Collector ausführt.
    updateJson.name Zeichenfolge Name des Schecks
    updateJson.plugins Array Liste von Agent Client Collector Plugins sind mit dieser Prüfung verknüpft.
    updateJson.proxy_valid Boolean

    Kennzeichnung, die angibt, ob die Prüfungsdefinitionsrichtlinie als Proxy festgelegt ist.

    Gültige Werte:
    • wahr: Diese Prüfungsdefinitionsrichtlinie ist als Proxy festgelegt.
    • „falsch“: Diese Prüfungsdefinitionsrichtlinie ist nicht als Proxy konfiguriert.
    updateJson.timeout Nummer Zeitüberschreitung in Sekunden.
    Tabelle : 6. Ergebnisse
    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(String 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.
    updateJson Objekt Zuordnung der Prüfparameterfelder, die auf ihre neuen Werte aktualisiert werden sollen. Eine umfassende Liste der Felder und Typen von „Definition sicherer Parameter überprüfen“ finden Sie im Datenwörterbuch.
    {
 "active": Boolean,
 "default_value": "String",
 "mandatory": Boolean,
 "name": "String"
}
    updateJson.active 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.
    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.
    updateJson.name Zeichenfolge Name des Prüfparameters.
    Tabelle : 8. Ergebnisse
    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(String checkDefSecureParamId, Object updateJson)

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

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    checkDefSecureParamId Zeichenfolge Sys_id des sicheren Parameters, der in der Tabelle „Definitionen sicherer Parameter prüfen“ [sn_agent_check_secure_param_def] aufgeführt ist.
    updateJson Objekt Zuordnung der sicheren Parameterfelder, die auf ihre neuen Werte aktualisiert werden sollen. Eine umfassende Liste der Felder und Typen von „Definition sicherer Parameter überprüfen“ finden Sie im Datenwörterbuch.
    {
 "active": Boolean,
 "name": "String",
 "order": Number
}
    updateJson.active Boolean

    Kennzeichnung, die angibt, ob der sichere Parameter aktiv ist.

    Gültige Werte:
    • wahr: Der sichere Parameter ist aktiv.
    • „false“: Der sichere Parameter ist inaktiv.
    updateJson.name Zeichenfolge Name des sicheren Parameters.
    updateJson.order Nummer Reihenfolge, in der der Parameter an den Überprüfungsbefehl/das Überprüfungsskript gesendet wird.
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Keine Fehlermeldung, wenn nicht erfolgreich.

    Das folgende Beispiel zeigt, wie die Überprüfung eines sicheren Parameters aktiviert wird.

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