cmx_stop_target（Webシステムまたはサービスユニットの停止）
形式
-
Webシステムを停止する場合
cmx_stop_target [共通引数] [-s <Webシステム名>] [-unit <サービスユニット名>] -mode { ALL|HOLD } -
Webシステムに関連づいていない論理サーバを含むシステムを停止する場合
cmx_stop_target [共通引数] -ns [-normal]
機能
-
Webシステムを停止する場合
指定されたモードに応じて，停止対象のサービスユニットの状態を停止状態または閉塞状態にします。停止状態とは，サービスユニット中の全論理サーバが停止済みで，負荷分散機からのリクエスト振り分けが抑止されている状態です。また，閉塞状態とは，サービスユニット中のWebサーバが計画停止済み（ほかの論理サーバは稼働中）で，負荷分散機からのリクエスト振り分けが抑止されている状態です。
コマンドのオプションで，サービスユニットが指定されていれば特定のサービスユニットが，省略されていればWebシステム中の全サービスユニットが停止の対象となります。
なお，このコマンドでは，実行中のクライアントからのリクエストを中断させないために，Webサーバは計画停止させます。
サービスユニットの状態は，cmx_list_statusコマンドで参照できます。サービスユニットの状態の種類，およびサービスユニットの状態の参照方法については，「cmx_list_status」を参照してください。
-
Webシステムに関連づいていない論理サーバを含むシステムを停止する場合
開始対象のシステムに含まれるすべての論理サーバを停止します。すでに停止中の論理サーバは，引き続き停止状態が保たれます。
運用管理ポータルで論理サーバの起動順序を設定している場合は，その順序の逆順に従って停止されます。また，Webサーバは計画停止します。計画停止とは，現在受け付けているすべてのリクエストの処理終了を待って論理サーバを停止させることです。Webサーバの計画停止をしたくない場合は-normalオプションを指定します。
Webシステムに関連づいていない論理サーバの状態は，cmx_list_statusコマンドに-nsオプションを指定することで参照できます。論理サーバの状態の種類，および論理サーバの状態の参照方法については，「cmx_list_status」を参照してください。
引数
- -s <Webシステム名>
-
Webシステム名を指定します。
このオプションを省略した場合は，.cmxrcファイルまたはcmxclient.propertiesファイルのcmx.websystem.nameキーで設定した値が仮定されます。なお，.cmxrcファイルおよびcmxclient.propertiesファイルのcmx.websystem.nameキーを省略している場合に，このオプションを省略してコマンドを実行したときは，エラーになります。
- -unit <サービスユニット名>
-
サービスユニット名を指定します。
- -mode { ALL | HOLD }
-
停止モードを指定します。
-
ALL
稼働状態，準備状態，閉塞状態を停止状態に引き下げます。
-
HOLD
稼働状態，準備状態を閉塞状態に引き下げます。
停止状態のサービスユニットを閉塞状態に引き上げることはできません。
-
- -ns
-
Webシステムに関連づいていない論理サーバを含むシステムを停止する場合に指定します。
- -normal
-
Webサーバの計画停止をしたくない場合に指定します。このオプションを指定しないでコマンドを実行すると，Webサーバは計画停止します。
入力例
cmx_stop_target -s sample-system -unit unit1 -mode ALL
戻り値
- 0：
-
正常終了しました。
- 1：
-
警告終了しました。
- 64：
-
異常終了しました。
注意事項
-
-unitオプションでCTM用または統合ネーミングスケジューラサーバ用のサービスユニットを指定する場合に，-modeオプションにHOLDを指定したときはエラーになります。-unitオプションを省略している場合に，-modeオプションにHOLDを指定した場合，Webシステム中のCTM用および統合ネーミングスケジューラサーバ用のサービスユニットは，稼働状態のままで変更されません。
-
停止対象のサービスユニットに論理ユーザサーバが含まれている場合に，-modeオプションにHOLDを指定したときは，サービスユニットは閉塞状態となりますが，論理ユーザサーバが停止されません。また，停止対象のサービスユニットに論理ユーザサーバが含まれている場合に，-modeオプションにALLを指定したときは，論理ユーザサーバが停止されます。論理ユーザサーバの停止に失敗した場合は，サービスユニットの停止も失敗したとみなされます。この場合，-unitオプションを指定したコマンドは異常終了し，-unitオプションを省略したコマンドは警告終了します。
-
複数のJ2EEサーバを配置したCTM用のサービスユニットを停止する場合，一部のJ2EEサーバで停止処理を失敗しても，すべてのJ2EEサーバに対して停止処理を実行します。この場合，コマンドは異常終了します。
-
サービスユニットを一括停止すると，停止対象のサービスユニットを負荷分散機から切り離し，実行中のリクエストを処理したあとに，サービスユニット内のすべての論理サーバを停止します。論理サーバは，論理サーバごとに設定した起動順序の降順に従って停止されます。
一括停止の場合，停止対象のシステムによって，論理サーバの停止に失敗したときの動作が異なります。
-
Webシステムの場合
論理Webサーバの停止に失敗すると，一括停止処理を中断します。そのほかの論理サーバの停止に失敗しても処理を続行します。
-
Webシステムに関連づいていない論理サーバを含むシステムの場合
論理サーバの停止に失敗しても処理を続行します。論理Webサーバの停止に失敗すると，リクエストの受け付けは継続されます。この場合，一括停止時に-modeオプションを指定して，停止対象のシステムをいったん閉塞状態にしてから，停止状態にします。
-