---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# AgentNowHandler - スコープ指定

# AgentNowHandler - スコープ指定 {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

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

このスクリプトインクルードには エージェントクライアントコレクター Framework (sn_agent) ストアアプリケーションが必要であり、 `sn_agent` 名前空間内で提供されます。詳細については、「 [エージェントクライアントコレクター](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。

REST API ソリューションについては、「 [エージェントクライアントコレクター API](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-api "Agent Client Collector API は、利用可能なエージェントのアクションと管理ポリシーを管理するためのエンドポイントを提供します。")」を参照してください。

## AgentNowHandler：AgentNowHandler() {#ariaid-title2}

AgentNowHandler インスタンスを作成します。
{#AgentNowHnl-AgentNowHandler__table_ohr_4qd_bpb__entry__3}

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

{#AgentNowHnl-AgentNowHandler__table_ohr_4qd_bpb}  
次の例は、AgentNowHandler を初期化する方法を示しています。

    var handler = new sn_agent.AgentNowHandler();

## AgentNowHandler - getRequestStatus(文字列 requestId) {#ariaid-title3}

指定された ID の要求のステータスを取得します。
{#AgentNowHnl-getRequestStatus_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| requestId | 文字列 | runCheckForCis() メソッドの呼び出しによって生成されるチェック要求 ID。 |
[表 : 2. パラメーター]

{#AgentNowHnl-getRequestStatus_S__table_zk2_2g2_z4b} {#AgentNowHnl-getRequestStatus_S__table_al2_2g2_z4b__entry__2}

| プロパティ | 説明 |
|-|-|
| オブジェクト | 要求のステータスと該当するエラーメッセージ。 |
| status | 要求ステータス。 可能な値： * done - チェックに成功しました。 * failure -- チェックに失敗しました。詳細はエラーメッセージを参照してください。 * mid_flow -- 要求の出力は MID サーバーによって処理されています。 * processing -- チェックが進行中です。 * timeout -- チェックの処理が runCheckForCis() メソッドで設定された時間制限を超えました。 {#AgentNowHnl-getRequestStatus_S__ul_edm_1rr_5qb} データタイプ：文字列 |
| err_msg | エラーメッセージ (存在する場合)。 可能な値： * 関連する CI のエージェントが見つかりません。 * 指定された ID のバックグラウンドチェック要求はありません。 * 指定された ID の要求はありません。 * 指定された ID のテスト結果はありません。 * 要求タイムアウト。 {#AgentNowHnl-getRequestStatus_S__ul_qcf_zcq_5qb} データタイプ：文字列 |
[表 : 3. 返される内容]

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

    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) {#ariaid-title4}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| testResultId | 文字列 | テストチェック要求の作成によって生成されるテスト結果 ID。 |
[表 : 4. パラメーター]

{#AgentNowHnl-getTestResultStatus_S__table_zk2_2g2_z4b} {#AgentNowHnl-getTestResultStatus_S__table_al2_2g2_z4b__entry__2}

| プロパティ | 説明 |
|-|-|
| status | テスト結果のステータス。 可能な値： * 0：処理待ち * 1：処理中 * 2：完了 * 3：指定された ID のテスト結果なし {#AgentNowHnl-getTestResultStatus_S__ul_yyq_4bq_5qb} データタイプ：文字列 |
| output | ステータスを説明する出力。 データタイプ：文字列 |
[表 : 5. 返される内容]

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

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

## AgentNowHandler - runCheckForCis(オブジェクト cis, オブジェクト check, 数値 priority, 数値 timeout) {#ariaid-title5}

指定された構成アイテムに対してチェックを実行します。
{#AgentNowHnl-runCheckForCis_O_O_N_N__table_zk2_2g2_z4b__entry__3}{#AgentNowHnl-runCheckForCis_O_O_N_N__agntNowHlr-parm-ph-chkparms}

| 名前 | タイプ | 説明 |
|-|-|-|
| CI | [GlideRecord](https://servicenow-prod.fluidtopics.net/DKnkjnu3r0c8j~e5s2NNhg#c_GlideRecordScopedAPI "スコープ付き GlideRecord API はデータベース操作に使用されます。") | チェック対象となる CMDB テーブル (任意のアプリケーション、ホスト、またはエージェント) の GlideRecord。 |
| check | オブジェクト | チェック ID とオプションのチェックパラメーター。 { "checkDefId": "String", "params": {Object} } |
| check.checkDefId | 文字列 | チェック定義 \[sn_agent_check_def\] テーブルのチェック定義の sys_id。 |
| check.params | オブジェクト | オプション。パラメーターの名前と値のマップ。これらの設定を使用して、チェック定義のパラメーターレコードとその指定された値を上書きできます。 "params": { "<parameter name>": "String" } {#AgentNowHnl-runCheckForCis_O_O_N_N__agntNowHlr-parm-cd-chkparms} |
| priority | 番号 | ECC キューに設定される要求の優先度。 可能な値： * 0：インタラクティブ * 1：迅速化済み * 2：標準 {#AgentNowHnl-runCheckForCis_O_O_N_N__ul_bkf_hnq_wqb} |
| timeout | 番号 | 要求のタイムアウト値 (秒)。 |
[表 : 6. パラメーター]

{#AgentNowHnl-runCheckForCis_O_O_N_N__table_zk2_2g2_z4b} {#AgentNowHnl-runCheckForCis_O_O_N_N__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 生成されたバックグラウンドチェック要求の sys_id。 |
[表 : 7. 返される内容]

{#AgentNowHnl-runCheckForCis_O_O_N_N__table_al2_2g2_z4b}  
次の例は、バックグラウンドチェックを実行してその要求 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) {#ariaid-title6}

バックグラウンドチェックを停止します。
バックグラウンドチェックを開始するには、runCheckForCis() メソッドを使用します。
{#AgentNowHnl-stopBackgroundCheck_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| requestId | 文字列 | runCheckForCis() メソッドの呼び出しによって生成されるバックグラウンドチェック要求の ID。 |
[表 : 8. パラメーター]

{#AgentNowHnl-stopBackgroundCheck_S__table_zk2_2g2_z4b} {#AgentNowHnl-stopBackgroundCheck_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 9. 返される内容]

{#AgentNowHnl-stopBackgroundCheck_S__table_al2_2g2_z4b}  
次の例は、バックグラウンドチェックの実行を停止する方法を示しています。

    handler.stopBackgroundCheck(backRequestId);