AccCheckDefsAPI - スコープ指定

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む22読むのに数分

    • AccCheckDefsAPI スクリプトインクルードを使用すると、チェック定義と関連パラメーターを管理できます。

    この API は、Agent Client Collector Framework (sn_agent) ストアアプリケーションを必要とし、sn_agent 名前空間内で提供されます。この API には agent_client_collector_admin ロールが必要です。詳細については、「 Agent Client Collector」を参照してください。

    この API にはインスタンスを作成するためのコンストラクタがありません。AccCheckDefsAPI 静的クラスを次の形式で使用して、各メソッドを呼び出します。

    sn_agent.AccCheckDefsAPI.<method>

    REST API ソリューションについては、「 Agent Client Collector API 」を参照してください。

    この API には、以下を可能にするメソッドが含まれています。
    • 指定されたチェック定義を取得
    • チェック定義のリストを取得
    • チェックとチェックパラメーターを更新

    AccCheckDefsAPI - getCheck(文字列 checkDefId, ブール withParams)

    詳細を含む指定されたチェック定義を取得します。

    表 : 1. パラメーター
    名前 タイプ 説明
    checkDefId 文字列 チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。
    withParams ブール 既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。
    有効な値：
    • true：チェックパラメーターの詳細を返します。
    • false：チェックパラメーターの詳細を返しません。

    デフォルト値：False
    表 : 2. 返される内容
    プロパティ 説明
    check 指定されたチェック定義の詳細。
    "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 このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するのを待機しないチェックです。
    有効な値：
    • true：このチェック定義はバックグラウンドチェックです。
    • false：このチェック定義はバックグラウンドチェックではありません。

    データタイプ：ブール
    check.check_group このチェック定義に指定されたグループ。

    データタイプ：文字列
    check.check_type チェックのタイプ。
    可能な値：
    • Events：チェック結果が Event Management イベントに変換されます。
    • Metrics：チェック結果からの値が測定基準に変換されます。

    データタイプ：文字列
    check.command Agent Client Collector が実行するコマンド。

    データタイプ：文字列
    check.error エラーがある場合のメッセージ。それ以外の場合は Null です。

    データタイプ：文字列
    check.name チェックの名前。

    データタイプ：文字列
    check.params チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    データタイプ：アレイ
    check.params.active チェックパラメーターがアクティブかどうかを示すフラグ。
    有効な値：
    • true：チェックパラメーターはアクティブです。
    • false：チェックパラメーターは非アクティブです。

    データタイプ：ブール
    check.params.default_value このチェックパラメーターのデフォルト値を指定します。

    データタイプ：文字列
    check.params.mandatory チェックパラメーターが必須かどうかを示すフラグ。
    有効な値：
    • true：チェックパラメーターは必須です。
    • false：チェックパラメーターはオプションです。

    データタイプ：ブール
    check.params.name チェックパラメーターの名前。

    データタイプ：文字列
    check.params.sys_id チェックセキュアパラメーター定義 [sn_agent_check_param_def] テーブルにリストされたチェックパラメーターの sys_id。

    データタイプ：文字列
    check.plugins このチェックに関連付けられた Agent Client Collector プラグイン のリスト。

    データタイプ：アレイ
    check.proxy_valid チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。
    有効な値：
    • true：このチェック定義ポリシーはプロキシとして機能するように設定されています。
    • false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。

    データタイプ：ブール
    check.secure_params このチェックにアサインされているリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    データタイプ：アレイ
    check.secure_params.active セキュアパラメーターがアクティブかどうかを示すフラグ。
    有効な値：
    • true：セキュアパラメーターはアクティブです。
    • false：セキュアパラメーターは非アクティブです。

    データタイプ：ブール
    check.secure_params.name セキュアパラメーターの名前。

    データタイプ：文字列
    check.secure_params.order パラメーターがチェックコマンド/スクリプトに送信される順序。

    データタイプ：数値
    check.secure_params.sys_id チェックセキュアなパラメーター定義 [sn_agent_check_secure_param_def] テーブルにリストされたセキュアパラメーターの sys_id。

    データタイプ：文字列
    check.sys_id チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。

    データタイプ：文字列
    check.timeout タイムアウト (秒)。

    データタイプ：数値

    次の例は、指定されたチェック定義の情報を取得する方法を示しています。

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

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

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

    出力:

    {
  "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(文字列 encodedQuery, 数値 limit, ブール withParams)

    詳細を含むチェック定義のリストを取得します。

    「チェックとポリシー」も参照してください。

    表 : 3. パラメーター
    名前 タイプ 説明
    encodedQuery 文字列 チェック定義結果リストをフィルタリングするための エンコードされたクエリ文字列 。システム内のチェック定義のフィルタリングされていないリストには null を使用します。
    limit 番号 返されるレコードの数を制限します。デフォルト値を使用するには、null に設定します。

    デフォルト：20,000
    withParams ブール 既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。
    有効な値：
    • true：チェックパラメーターの詳細を返します。
    • false：チェックパラメーターの詳細を返しません。

    デフォルト値：False
    表 : 4. 返される内容
    プロパティ 説明
    チェック定義 JSON オブジェクトとして指定されたチェック定義と詳細のリスト。
    [
  {
    "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
  }
]

    データタイプ：アレイ
    background このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するのを待機しないチェックです。
    有効な値：
    • true：このチェック定義はバックグラウンドチェックです。
    • false：このチェック定義はバックグラウンドチェックではありません。

    データタイプ：ブール
    check_group このチェック定義に指定されたグループ。

    データタイプ：文字列
    check_type チェックのタイプ。
    可能な値：
    • Events：チェック結果が Event Management イベントに変換されます。
    • Metrics：チェック結果からの値が測定基準に変換されます。

    データタイプ：文字列
    command Agent Client Collector が実行するコマンド。

    データタイプ：文字列
    name チェックの名前。

    データタイプ：文字列
    params チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    データタイプ：アレイ
    params.active チェックパラメーターがアクティブかどうかを示すフラグ。
    有効な値：
    • true：チェックパラメーターはアクティブです。
    • false：チェックパラメーターは非アクティブです。

    データタイプ：ブール
    params.default_value このチェックパラメーターのデフォルト値を指定します。

    データタイプ：文字列
    params.mandatory チェックパラメーターが必須かどうかを示すフラグ。
    有効な値：
    • true：チェックパラメーターは必須です。
    • false：チェックパラメーターはオプションです。

    データタイプ：ブール
    params.name チェックパラメーターの名前。

    データタイプ：文字列
    params.sys_id チェックセキュアパラメーター定義 [sn_agent_check_param_def] テーブルにリストされたチェックパラメーターの sys_id。

    データタイプ：文字列
    プラグイン このチェックに関連付けられた Agent Client Collector プラグイン のリスト。

    データタイプ：アレイ
    proxy_valid チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。
    有効な値：
    • true：このチェック定義ポリシーはプロキシとして機能するように設定されています。
    • false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。

    データタイプ：ブール
    secure_params このチェックにアサインされているリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    データタイプ：アレイ
    secure_params.active セキュアパラメーターがアクティブかどうかを示すフラグ。
    有効な値：
    • true：セキュアパラメーターはアクティブです。
    • false：セキュアパラメーターは非アクティブです。

    データタイプ：ブール
    secure_params.name セキュアパラメーターの名前。

    データタイプ：文字列
    secure_params.order パラメーターがチェックコマンド/スクリプトに送信される順序。

    データタイプ：数値
    secure_params.sys_id チェックセキュアなパラメーター定義 [sn_agent_check_secure_param_def] テーブルにリストされたセキュアパラメーターの sys_id。

    データタイプ：文字列
    sys_id チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。

    データタイプ：文字列
    timeout タイムアウト (秒)。

    データタイプ：数値

    次の例は、パラメーター値を持つ 2 つのチェック定義のリストを取得する方法を示しています。

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

    出力：

    [
  {
    "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(文字列 checkDefId, オブジェクト updateJson)

    指定されたチェック定義の 1 つ以上のフィールド値を変更できるようにします。

    「チェックとポリシー」も参照してください。

    表 : 5. パラメーター
    名前 タイプ 説明
    checkDefId 文字列 チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。
    updateJson オブジェクト 新しい値に更新されるチェック定義フィールドのマップ。チェック定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "name": "String",
 "plugins": [Array],
 "proxy_valid": Boolean,
 "timeout": Number
}
    updateJson.active 番号 このチェック定義がアクティブかどうかを示します。
    有効な値：
    • 0：このチェック定義は非アクティブです。
    • 1：このチェック定義はアクティブです。
    updateJson.background ブーリアン このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するのを待機しないチェックです。
    有効な値：
    • true：このチェック定義はバックグラウンドチェックです。
    • false：このチェック定義はバックグラウンドチェックではありません。
    updateJson.check_group 文字列 このチェック定義に指定されたグループ。
    updateJson.check_type 文字列 チェックのタイプ。
    可能な値：
    • Events：チェック結果が Event Management イベントに変換されます。
    • Metrics：チェック結果からの値が測定基準に変換されます。
    updateJson.command 文字列 Agent Client Collector が実行するコマンド。
    updateJson.name 文字列 チェックの名前。
    updateJson.plugins アレイ のリスト Agent Client Collector プラグイン このチェックに関連付けられています。
    updateJson.proxy_valid ブーリアン

    チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。

    有効な値：
    • true：このチェック定義ポリシーはプロキシとして機能するように設定されています。
    • false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。
    updateJson.timeout 番号 タイムアウト (秒)。
    表 : 6. 返される内容
    タイプ 説明
    なし 失敗した場合のエラーメッセージ。

    次の例は、チェック定義を無効にする方法を示しています。

    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(文字列 checkDefParamId, オブジェクト updateJson)

    指定されたチェックパラメーターの 1 つ以上のフィールド値を変更できるようにします。

    表 : 7. パラメーター
    名前 タイプ 説明
    checkDefParamId 文字列 チェックパラメーター定義 [sn_agent_check_param_def] テーブルにリストされたチェックパラメーターの sys_id。
    updateJson オブジェクト 新しい値に更新されるチェックパラメーターフィールドのマップ。チェックセキュアパラメーター定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。
    {
 "active": Boolean,
 "default_value": "String",
 "mandatory": Boolean,
 "name": "String"
}
    updateJson.active ブーリアン

    チェックパラメーターがアクティブかどうかを示すフラグ。

    有効な値：
    • true：チェックパラメーターはアクティブです。
    • false：チェックパラメーターは非アクティブです。
    updateJson.default_value 文字列 このチェックパラメーターのデフォルト値を指定します。
    updateJson.mandatory ブーリアン

    チェックパラメーターが必須かどうかを示すフラグ 。

    有効な値：
    • true：チェックパラメーターは必須です。
    • false：チェックパラメーターはオプションです。
    updateJson.name 文字列 チェックパラメーターの名前。
    表 : 8. 返される内容
    タイプ 説明
    なし 失敗した場合のエラーメッセージ。

    次の例は、チェックパラメーターを有効にする方法を示しています。

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

    AccCheckDefsAPI - updateCheckSecureParam(文字列 checkDefSecureParamId, オブジェクト updateJson)

    指定されたチェックセキュアパラメーターの 1 つ以上のフィールド値を変更できるようにします。

    表 : 9. パラメーター
    名前 タイプ 説明
    checkDefSecureParamId 文字列 チェックセキュアパラメーター定義 [sn_agent_check_secure_param_def] テーブルにリストされたセキュアパラメーターの sys_id。
    updateJson オブジェクト 新しい値に更新されるチェックセキュアパラメーターフィールドのマップ。チェックセキュアパラメーター定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。
    {
 "active": Boolean,
 "name": "String",
 "order": Number
}
    updateJson.active ブーリアン

    セキュアパラメーターがアクティブかどうかを示すフラグ。

    有効な値：
    • true：セキュアパラメーターはアクティブです。
    • false：セキュアパラメーターは非アクティブです。
    updateJson.name 文字列 セキュアパラメーターの名前。
    updateJson.order 番号 パラメーターがチェックコマンド/スクリプトに送信される順序。
    表 : 10. 返される内容
    タイプ 説明
    なし 失敗した場合のエラーメッセージ。

    次の例は、チェックセキュアパラメーターを有効にする方法を示しています。

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