CheckDefinitionTestBuilder - スコープ指定

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

    • CheckDefinitionTestBuilder スクリプトインクルードを使用すると、チェック定義でテストチェック要求を構築できます。

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

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

    この API には、以下を可能にするメソッドが含まれています。
    • テストするチェック定義を設定
    • テストを実行するための構成アイテムを設定
    テスト中に使用する次のいずれかの識別子を指定することもできます。
    • 資格情報 sys_id
    • 資格情報エイリアス ID
    • 資格情報名

    CheckDefinitionTestBuilder - CheckDefinitionTestBuilder()

    CheckDefinitionTestBuilder インスタンスを作成します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし

    次の例は、CheckDefinitionTestBuilderを初期化する方法を示しています。

    var builder = new sn_agent.CheckDefinitionTestBuilder();

    CheckDefinitionTestBuilder - build()

    引数を設定してテストチェック要求を構築します。

    表 : 2. パラメーター
    名前 タイプ 説明
    なし
    表 : 3. 返される内容
    プロパティ 説明
    オブジェクト テスト結果レコード ID とエラーの 2 つの属性を持つ JSON オブジェクト。ビルドが成功した場合、テスト結果 ID が返され、エラーは null です。ビルド中にエラーが発生した場合、テスト結果 ID は null になり、エラーが表示されます。

    次の例は、テストチェック要求の構築方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();

var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();

if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCheckId(文字列 checkId)

    テストするチェック定義の sys_id を設定します。

    表 : 4. パラメーター
    名前 タイプ 説明
    checkId 文字列 チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。
    表 : 5. 返される内容
    タイプ 説明
    CheckDefinitionTestBuilder メソッドが呼び出された対象のビルダーインスタンス。

    次の例は、テストチェックの作成方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCiId(文字列 ciId)

    テストを実行する対象の構成アイテムの sys_id を設定します。

    表 : 6. パラメーター
    名前 タイプ 説明
    ciId 文字列 CMDB 構成アイテムの sys_id
    表 : 7. 返される内容
    タイプ 説明
    CheckDefinitionTestBuilder メソッドが呼び出された対象のビルダーインスタンス。

    次の例は、テストチェック要求の作成方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsAliasId(文字列 credentialsAliasId)

    テスト中に使用する資格情報エイリアスの sys_id を設定します。

    注:
    これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出すことによって行われた以前の割り当てがすべて削除されます。
    表 : 8. パラメーター
    名前 タイプ 説明
    credentialsAliasId 文字列 資格情報レコードの sys_id。
    表 : 9. 返される内容
    タイプ 説明
    CheckDefinitionTestBuilder メソッドが呼び出された対象のビルダーインスタンス。

    次の例は、テストチェックを作成して資格情報エイリアス ID を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credAlias = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsAliasName(文字列 credentialsAliasName)

    テスト中に使用する資格情報エイリアス名を設定します。指定された値が複数の資格情報エイリアスレコードの名前と一致する場合、そのうちの 1 つがランダムに選択されます。

    注:
    これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出すことによって行われた以前の割り当てがすべて削除されます。
    表 : 10. パラメーター
    名前 タイプ 説明
    credentialsAliasName 文字列 資格情報エイリアスの名前。
    表 : 11. 返される内容
    タイプ 説明
    CheckDefinitionTestBuilder メソッドが呼び出された対象のビルダーインスタンス。

    次の例は、テストチェックを作成して資格情報エイリアス名を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credentialsAliasName = "credentialsAliasName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsId(文字列 credentialsId)

    テスト中に使用する資格情報の sys_id を設定します。

    注:
    これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出すことによって行われた以前の割り当てがすべて削除されます。
    表 : 12. パラメーター
    名前 タイプ 説明
    credentialsId 文字列 資格情報レコードの sys_id。
    表 : 13. 返される内容
    タイプ 説明
    CheckDefinitionTestBuilder メソッドが呼び出された対象のビルダーインスタンス。

    次の例は、テストチェックを作成して資格情報 ID を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credID = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsName(文字列 credentialsName)

    テスト中に使用する資格情報名を設定します。指定された値が複数の資格情報レコードの名前である場合、そのうちの 1 つがランダムに選択されます。

    注:
    これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出すことによって行われた以前の割り当てがすべて削除されます。
    表 : 14. パラメーター
    名前 タイプ 説明
    credentialsName 文字列 資格情報レコードの名前。
    表 : 15. 返される内容
    タイプ 説明
    CheckDefinitionTestBuilder メソッドが呼び出された対象のビルダーインスタンス。

    次の例は、テストチェックを作成して資格情報名を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credname = "credentialsName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);