AgentNowHandler - スコープ指定

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：5分

    • AgentNowHandler スクリプトインクルードは、チェック定義をオンデマンドで実行し、オンデマンド実行とテストチェック実行のステータスをチェックし、オンデマンドで実行されたバックグラウンドチェックを停止するためのメソッドを提供します。

    このスクリプトインクルードには エージェントクライアントコレクター Framework (sn_agent) ストアアプリケーションが必要であり、 sn_agent 名前空間内で提供されます。詳細については、「 エージェントクライアントコレクター」を参照してください。

    REST API ソリューションについては、「 エージェントクライアントコレクター API」を参照してください。

    AgentNowHandler:AgentNowHandler()

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

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

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

    var handler = new sn_agent.AgentNowHandler();

    AgentNowHandler:getRequestStatus(文字列 requestId)

    指定された ID で要求のステータスを取得します。

    表 : 2. パラメーター
    名前 タイプ 説明
    requestId 文字列 runCheckForCis() メソッドを呼び出して生成されたチェック要求 ID。
    表 : 3. 返される内容
    プロパティ 説明
    オブジェクト 要求のステータスと該当するエラーメッセージ。
    status 要求ステータス。
    可能な値：
    • done:チェックに成功しました。
    • failure:チェックに失敗しました。詳細については、エラーメッセージを参照してください。
    • mid_flow:要求の出力は MID サーバーによって処理されています。
    • 処理中:チェックが進行中です。
    • timeout – チェック処理が runCheckForCis() メソッドで設定された時間制限を超えました。

    データタイプ：文字列
    err_msg エラーメッセージ (存在する場合)。
    可能な値：
    • 関連する CI のエージェントが見つかりません。
    • 指定された ID の経歴チェック要求はありません。
    • 指定された ID の要求はありません。
    • 指定された ID のテスト結果はありません。
    • 要求タイムアウト。

    データタイプ：文字列

    次の例は、要求のステータスを取得する方法を示しています。

    var handler = new sn_agent.AgentNowHandler();
var check = {checkDefId: "158279505372b30034b8ddeeff7b1270"};
var computerGr = new GlideRecord("cmdb_ci_computer");
computerGr.query();
var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

var reqStatusJson = handler.getRequestStatus(requestId);
gs.info(JSON.stringify(reqStatusJson));

    AgentNowHandler - getTestResultStatus(文字列 testResultId)

    指定されたテスト結果のテストチェックステータスを取得します。

    表 : 4. パラメーター
    名前 タイプ 説明
    testResultId 文字列 テストチェック要求を作成することで生成されたテスト結果 ID。
    表 : 5. 返される内容
    プロパティ 説明
    status テスト結果のステータス。
    可能な値：
    • 0：処理待ち
    • 1:進行中
    • 2:完了
    • 3:指定された ID のテスト結果はありません

    データタイプ：文字列
    出力 ステータスを説明する出力。

    データタイプ：文字列

    次の例は、完了したテストチェック要求の結果ステータスを取得する方法を示しています。

    var testCheckStatusJson = handler.getTestResultStatus("testResultId");
gs.info(JSON.stringify(testCheckStatusJson));

    AgentNowHandler - runCheckForCis(Object cis, Object check, Number priority, Number timeout)

    指定された構成アイテムに対してチェックを実行します。

    表 : 6. パラメーター
    名前 タイプ 説明
    cis GlideRecord チェックが機能している任意の CMDB テーブル (任意のアプリケーション、ホスト、またはエージェント) の GlideRecord。
    チェック オブジェクト チェック ID とオプションのチェックパラメーター。 
    "check": {
  "checkDefId": "String",
  "params": {Object}
}
    check.checkDefId 文字列 チェック定義 [sn_agent_check_def] テーブルのチェック定義のSys_id。
    check.params オブジェクト オプション。パラメーターの名前と値のマップ。これらの設定を使用して、チェック定義のパラメーターレコードとその指定された値を上書きできます。 
    "params": {
  "<parameter name>": "String"
}
    priority 数値 ECC キューに設定する要求の優先度。
    可能な値：
    • 0:インタラクティブ
    • 1:迅速化済み
    • 2:標準
    timeout 数値 要求のタイムアウト値 (秒単位)。
    表 : 7. 返される内容
    タイプ 説明
    文字列 生成された経歴チェック要求のSys_id。

    次の例は、バックグラウンドチェックを実行してその要求 ID を取得する方法を示しています。

    var handler = new sn_agent.AgentNowHandler();
var check = {checkDefId: "028fcd5067c80010b7b72dbd2685ef4f"};
var computerGr = new GlideRecord("cmdb_ci_computer");
computerGr.query();
var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

gs.info(requestId);

    出力：

    b9cf14aedb5e30106f4810284b961990

    AgentNowHandler - stopBackgroundCheck(文字列 requestId)

    経歴チェックを停止します。

    バックグラウンドチェックを開始するには、 runCheckForCis() メソッドを使用します。

    表 : 8. パラメーター
    名前 タイプ 説明
    requestId 文字列 runCheckForCis() メソッドを呼び出して生成された経歴チェック要求の ID。
    表 : 9. 返される内容
    タイプ 説明
    なし

    次の例は、経歴チェックの実行を停止する方法を示しています。

    handler.stopBackgroundCheck(backRequestId);