ctmholdque  [-h] [-CTMDomain <CTMドメイン名称>] [-CTMID <CTM識別子>]
            [-CTMMyHost <ホスト名称またはIPアドレス>]
            {-CTMQueue <スケジュールキュー登録名称> | -CTMQueueALL}
            [[-CTMRequestLeave] [-CTMTimeOut <タイムアウト値>]
             | [-CTMChangeServer]]
            [-CTMForce]

スケジュールキューを閉塞します。

スケジュールキューを閉塞すると，それ以降のリクエストとスケジュールキュー内のリクエストはエラーになります。ただし，-CTMRequestLeaveオプションを指定した場合，スケジュールキュー内のリクエストは閉塞状態でもJ2EEアプリケーションで処理されます。

また，-CTMChangeServerオプションを指定して閉塞した場合，オンライン状態でJ2EEアプリケーションを入れ替えられます。

-h

コマンドの使用方法が表示されます。

-CTMDomain <CTMドメイン名称>

スケジュールキューを閉塞するCTMデーモンのCTMドメイン名称を1〜31文字の英数字，またはアンダースコア（_）で指定します。"CTM"または"ctm"で始まる文字列は指定しないでください。省略した場合は"CTMDOMAIN"が設定されます。

-CTMID <CTM識別子>

スケジュールキューを閉塞するCTMデーモンのCTM識別子を1〜31文字の英数字，ピリオド（.），またはアンダースコア（_）で指定します。"CTM"または"ctm"で始まるCTM識別子は指定しないでください。ピリオド（.）は，IPアドレスを指定する場合だけ使用できます。省略した場合は，IPアドレスでCTM識別子が設定されます。

例えば，ホストのIPアドレスが"172.17.112.43"のとき，"172.17.112.43"という文字列がCTM識別子となります。

-CTMMyHost <ホスト名称またはIPアドレス>

マルチホームまたはIPアドレスを引き継ぐ系切り替え環境でCTMが使用するホスト名称またはIPアドレスを指定します。値は1〜64文字の文字列で指定します。省略した場合は，hostnameコマンドで取得されるホスト名称が設定されます。

-CTMQueue <スケジュールキュー登録名称>

閉塞するスケジュールキューの登録名称を1〜63文字の英数字，またはアンダースコア（_）で指定します。

バッチアプリケーションを実行するシステムでは，スケジュールキューの登録名称としてスケジュールグループ名を指定してください。

-CTMQueueALL

すべてのスケジュールキューを一括して閉塞します。このとき，閉塞済みのスケジュールキューも含まれます。

-CTMRequestLeave

スケジュールキュー閉塞時に，スケジュールキューに滞留しているリクエストを破棄しないでスケジュールキューを閉塞します。破棄しなかったリクエストは，J2EEアプリケーションで処理されます。

ctmholdqueコマンドは滞留しているすべてのリクエストが取り出されるのを，-CTMTimeOutオプションの指定値まで待ち合わせます。リクエストの待ち合わせ中にctmrlesqueコマンドによって閉塞解除された場合は，リクエストの受け付けを可能にして，ctmholdqueコマンドは正常終了します。

-CTMTimeOut <タイムアウト値>

スケジュールキューの閉塞処理の待ち時間（単位：秒）を0〜2147483647の整数で指定します。"0"を指定した場合，無限に待ち続けます。省略した場合は"180"(秒)が設定されます。

-CTMChangeServer

スケジュールキューからJ2EEアプリケーションへのリクエストのスケジュールを閉塞します。このとき，EJBクライアントからのリクエストをキューイングできます。また，スケジュールキューに滞留しているリクエストは，ctmrlesqueコマンドによって閉塞解除されるまで保持されます。ただし，CTMデーモンを停止する場合には，スケジュールキューに滞留しているリクエストを破棄して停止処理を続行します。

-CTMChangeServerオプションでスケジュールキューを閉塞した場合，リクエストのキューイングおよび滞留しているリクエストを保持するため，オンライン状態でJ2EEアプリケーションを入れ替えられます。なお，同じCTMドメイン内にスケジュール可能なJ2EEアプリケーションが存在する場合には，負荷が掛かっていないJ2EEアプリケーションに対応するスケジュールキューにスケジュールします。

-CTMChangeServerオプションは，-CTMRequestLeaveオプションおよび-CTMTimeOutオプションと同時に指定できません。

J2EEサーバが異常終了したときのリクエスト保持機能（ctmstart -CTMQueueDeleteWait）と併用した場合，J2EEサーバが異常終了したあとにctmholdque -CTMChangeServerは実行できません。

-CTMForce

スケジュールキュー閉塞時に，CTMデーモンに通信を行わないでスケジュールキューを高速に閉塞します。その際，滞留しているリクエストは一定時間後に破棄されます。ただし，同時に-CTMRequestLeaveオプションを指定すると，滞留しているリクエストは破棄されません。また，同時に-CTMChangeServerオプションを指定した場合，-CTMChangeServerオプションは無視されます。

0：

正常終了しました。

1：

コマンド処理中にエラーが発生したため，異常終了しました。出力されるメッセージに従って対策したあと，再度コマンドを実行してください。

2：

指定されたスケジュールキューはすでに閉塞しています。なお，この戻り値は-CTMQueueオプションを指定した場合だけ返却されます。