Smart Composer機能で使用するコマンドの詳細

Cosminexus アプリケーションサーバ V8　リファレンスコマンド編

Smart Composer機能で使用するコマンドの入力形式，機能などを次に示します。

コマンドの格納先

Smart Composer機能で使用するコマンドは，次のディレクトリに格納されています。

Windowsの場合
<Cosminexusのインストールディレクトリ>\manager\bin\
UNIXの場合
/opt/Cosminexus/manager/bin/

共通引数

各コマンドには，次の引数を共通引数として指定します。共通引数は，.cmxrc（クライアント設定プロパティファイル）またはcmxclient.properties（クライアント共通設定ファイル）で，指定を省略したときのデフォルト値を設定できます。.cmxrcファイルおよびcmxclient.propertiesファイルについては，マニュアル「Cosminexus アプリケーションサーバリファレンス定義編(サーバ定義)」のcmxrc（クライアント設定プロパティファイル）およびcmxclient.properties（クライアント共通設定プロパティファイル）の説明を参照してください。

形式

コマンド名称 [-m <ホスト名>[:<ポート番号>]] 
             [-u <管理ユーザID>] [-p <管理ユーザパスワード>]
             [-wait | -nowait] [-verbose | -noverbose]

説明

-m <ホスト名>[:<ポート番号>]

Management Serverのホスト名とポート番号を指定します。

<ホスト名>
ドット記法でのIPアドレス指定（xxx.xxx.xxx.xxx），または名前解決できるホスト名で指定します。なお，xxxには0～255の整数を指定します。
<ポート番号>
Management Serverの設定に従います。デフォルト値は28080です。

-u <管理ユーザID>: Management Serverのセットアップで設定した，Management Serverの管理ユーザIDを指定します。Management Serverのセットアップについては，マニュアル「Cosminexus アプリケーションサーバシステム構築・運用ガイド」を参照してください。管理ユーザアカウントの省略機能が有効の場合，管理ユーザIDを指定しても無効となります。管理ユーザアカウントの省略機能については，マニュアル「Cosminexus アプリケーションサーバシステム構築・運用ガイド」の管理ユーザアカウントの設定を省略する場合に関する説明を参照してください。

-p <管理ユーザパスワード>: Management Serverのセットアップで設定した，Management Serverの管理ユーザパスワードを指定します。Management Serverのセットアップについては，マニュアル「Cosminexus アプリケーションサーバシステム構築・運用ガイド」を参照してください。管理ユーザアカウントの省略機能が有効の場合，管理ユーザパスワードを指定しても無効となります。管理ユーザアカウントの省略機能については，マニュアル「Cosminexus アプリケーションサーバシステム構築・運用ガイド」の管理ユーザアカウントの設定を省略する場合に関する説明を参照してください。

-wait | -nowait: コマンド実行時に，すでに実行しているコマンドとの排他が必要な場合，処理できるようになるまで待つか（-wait），待たずにエラーリターンするか（-nowait）のどちらかを指定します。詳細は，「8.2　コマンドを同時に複数実行した場合の排他制御」を参照してください。

-verbose | -noverbose: コマンドの実行結果の詳細を出力するか（-verbose），出力しないか（-noverbose）のどらかを指定します。

共通引数は，コマンドによって指定が有効になる場合と，無効になる場合があります。コマンドに無効な引数を指定した場合，その引数は無視されます。共通引数の指定について，コマンドごとに次の表に示します。

表8-8　共通引数の指定の可否

コマンド名称	共通引数
コマンド名称	-m	-u	-p	-wait -nowait	-verbose -noverbose
cmx_admin_passwd	○	○	○	×	×
cmx_build_model	○	○	○	○	×
cmx_build_system	○	○	○	○	○
cmx_change_model	○	○	○	○	×
cmx_delete_system	○	○	○	○	○
cmx_export_model	○	○	○	×	×
cmx_list_model	○	○	○	×	×
cmx_list_status	○	○	○	×	×
cmx_resume_lb	○	○	○	○	○
cmx_scaleout_host	○	○	○	○	○
cmx_start_target	○	○	○	○	○
cmx_stop_target	○	○	○	○	○
cmx_test_lb	○	○	○	○	○
cmx_trans_param	×	×	×	×	×

（凡例）: ○：有効です。; ×：無効です。指定した場合，無視されます。

注: 互換用のコマンドはすべての共通引数の指定が有効です。互換用のコマンドについては，「8.1.3　旧バージョンとの互換用のコマンドの一覧」を参照してください。

終了コード

Smart Composer機能で使用するコマンドは，次の範囲で戻り値を返します。

表8-9　Smart Composer機能で使用するコマンドの戻り値

戻り値	意味
0	コマンドの処理が正常終了しました。
1～63	コマンドの処理で軽微な障害が発生しました。
64～127	コマンドの処理が異常終了しました。

＜この節の構成＞: cmx_add_serverref（論理ユーザサーバの追加）（互換用）; cmx_admin_passwd（Management Serverの管理ユーザアカウントの設定）; cmx_build_model（Webシステムの情報モデルの生成）; cmx_build_system（Webシステムの構築）; cmx_change_model（Webシステムの情報モデルの変更）; cmx_define_application（J2EEアプリケーションとWebシステムの関連づけ）（互換用）; cmx_define_resource（リソースとWebシステムの関連づけ）（互換用）; cmx_delete_serverref（論理ユーザサーバの削除）（互換用）; cmx_delete_system（Webシステムの削除）; cmx_deploy_application（J2EEアプリケーションのデプロイ）（互換用）; cmx_deploy_resource（リソースのデプロイ）（互換用）; cmx_export_model（簡易構築定義ファイルの出力）; cmx_list_model（Webシステムの情報モデルの取得）; cmx_list_status（サービスユニット状況の表示）; cmx_register_application（J2EEアプリケーションの登録）（互換用）; cmx_register_resource（リソースの登録）（互換用）; cmx_resume_lb（負荷分散機の設定再開始）; cmx_scaleout_host（Webシステムの情報モデルの変更）; cmx_start_application（J2EEアプリケーションの開始）（互換用）; cmx_start_resource（リソースの開始）（互換用）; cmx_start_target（Webシステムまたはサービスユニットの開始）; cmx_stop_application（J2EEアプリケーションの停止）（互換用）; cmx_stop_resource（リソースの停止）（互換用）; cmx_stop_target（Webシステムまたはサービスユニットの停止）; cmx_test_lb（負荷分散機との接続テスト）; cmx_trans_param（抽象パラメタの展開）; cmx_undefine_application（J2EEアプリケーションとWebシステムの関連づけ解除）（互換用）; cmx_undefine_resource（リソースとWebシステムの関連づけ解除）（互換用）; cmx_undeploy_application（J2EEアプリケーションのアンデプロイ）（互換用）; cmx_undeploy_resource（リソースのアンデプロイ）（互換用）; cmx_unregister_application（J2EEアプリケーションの削除）（互換用）; cmx_unregister_resource（リソースの削除）（互換用）

8.3 Smart Composer機能で使用するコマンドの詳細

8.3　Smart Composer機能で使用するコマンドの詳細