tscholdra [-h] [-TSCDomain TSCドメイン名称] [-TSCID TSC識別子]
          {-TSCRootAcceptor TSCルートアクセプタ登録名称 |
           -TSCRootAcceptorALL}
          [-TSCMyHost ホスト名称またはIPアドレス]
          [[-TSCRequestLeave] [-TSCTimeOut タイムアウト値] |
          [-TSCForceSession]]
 

TSCルートアクセプタを閉塞します。このあと，リクエストにエラーが返るようになります。コマンド実行時に-TSCRequestLeaveオプションが指定されている場合，キューイング中のリクエストはサーバアプリケーションに振り分けられます。-TSCRequestLeaveオプションが指定されていない場合は，例外で返ります。

●-h

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

●-TSCDomain TSCドメイン名称

〜＜1〜31文字の英数字＞《TSCDOMAIN》

TSCルートアクセプタを閉塞するTSCデーモンのTSCドメイン名称を指定します。"TSC"または"tsc"で始まる文字列は指定しないでください。省略した場合は"TSCDOMAIN"が設定されます。

●-TSCID TSC識別子

〜＜1〜31文字の英数字，およびピリオド（.）＞《IPアドレス》

TSCルートアクセプタを閉塞するTSCデーモンのTSC識別子を指定します。"TSC"または"tsc"で始まるTSC識別子は指定しないでください。ピリオド（.）は，IPアドレスを指定する場合だけ使用できます。省略した場合は，IPアドレスでTSC識別子が設定されます。

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

●-TSCRootAcceptor TSCルートアクセプタ登録名称

〜＜1〜31文字の英数字＞

閉塞するTSCルートアクセプタ登録名称を指定します。

●-TSCRootAcceptorALL

すべてのTSCルートアクセプタを一括して閉塞します。このとき，閉塞済みのTSCルートアクセプタも含まれます。

●-TSCMyHost ホスト名称またはIPアドレス

〜＜1〜64文字の文字列＞《hostnameコマンドで取得されるホスト名称》

マルチホームドホスト環境でOTMが使用するホスト名称またはIPアドレスを指定します。省略した場合は，hostnameコマンドで取得されるホスト名称が設定されます。

●-TSCRequestLeave

TSCルートアクセプタ閉塞時に，スケジュール用キューにキューイング中のリクエストを破棄しないでTSCルートアクセプタを閉塞します。破棄しなかったリクエストはサーバアプリケーションが取り出します。

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

01-01以前のバージョンのTSCルートアクセプタに対して-TSCRequestLeaveオプションを指定した場合，-TSCRequestLeaveオプションは無視されて，滞留しているリクエストは破棄されます。

-TSCRequestLeaveオプションは，-TSCForceSessionオプションと同時に指定できません。

●-TSCTimeOut タイムアウト値

〜＜符号なし整数＞((0〜2147483647))《180》（単位：秒）

TSCルートアクセプタの閉塞処理の待ち時間を指定します。"0"を指定した場合，無限に待ち続けます。省略した場合は"180"が設定されます。

-TSCTimeOutオプションは，-TSCForceSessionオプションと同時に指定できません。

●-TSCForceSession

TSCルートアクセプタの閉塞と同時に，強制的にセションを閉塞します。-TSCForceSessionオプションを省略した場合は，開始しているセションは引き続き呼び出せますが，新規のセションは呼び出せません。

-TSCForceSessionオプションは，-TSCRequestLeaveオプションまたは-TSCTimeOutオプションと同時に指定できません。

このコマンドは次に示す戻り値をシェルに返してから，処理を終了します。

戻り値	意味
0	正常終了しました。
1	コマンド処理中にエラーが発生したために異常終了しました。 出力されたメッセージに従って対策したあと，再度，コマンドを実行してください。
2	指定されたTSCルートアクセプタはすでに閉塞しています。 この戻り値は-TSCRootAcceptorオプションを指定した場合だけ返されます。