Sun Java System (GlassFish) Application Server には、asadmin というコマンド行管理ユーティリティーが含まれています。asadmin ユーティリティーを使用して、JBI コンポーネントの管理を含むアプリケーションサーバーのすべての管理タスクを実行できます。
asadmin ユーティリティーを使用する際のガイドラインは次のとおりです。
すべての asadmin コマンドおよびオプションでは、大文字と小文字が区別されます。
オプションの引数の前には単一のダッシュ (-) または二重ダッシュ (--) を付けます。二重ダッシュは長いオプション引数の指定に、単一のダッシュは短いオプション引数の指定に使用します。すべての引数に短いオプションがあるわけではありません。機能のオンとオフを切り替えるブール型のオプションを除き、ほとんどのオプションは引数値を必要とします。
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。
asadmin ユーティリティーは、対話型モードおよび非対話型モードで実行できます。対話型モードでは、プロンプトが表示され、ユーザーは入力を求められます。これがデフォルトのモードです。
コマンドの構文は次のとおりです。
asadmin command [-short_option] [short_option_argument]* [--long_option [long_option_argument]* [operand]* |
JBI コマンド名の構文は次のとおりです。
verb-jbi-noun |
例: start-jbi-component、deploy-jbi-service-assembly
この規則により、JBI コマンドとその他のアプリケーションサーバーコマンドを区別でき、また、その名前からコマンドの用途がわかるようになっています。
次のコマンドを発行すると、ヘルプを表示できます。
asadmin --help (全般的なヘルプを表示)
asadmin コマンド --help (指定したコマンドのヘルプを表示)
次の表に、JBI コンポーネントの管理に使用する JBI CLI コマンドとオプションを示します。これらの CLI コマンドの中には、Java CAPS をサポートするために追加されたオプションを持つものもあります。
コマンド名 |
オプションと値 |
オペランドと例 |
|
---|---|---|---|
install-jbi-component: サービスエンジンまたは結合コンポーネントを JBI 環境にインストールします。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
ファイルパスまたはコンポーネント名: コンポーネントの属性を格納するアーカイブファイル、またはドメインにあらかじめインストールされているコンポーネントの名前。 |
|
start-jbi-component: 指定されたターゲットでサービスエンジンまたは結合コンポーネントを起動します。ターゲットが指定されていない場合、組み込み DAS サーバー上のコンポーネントが起動されます。 |
|
コンポーネント名: 起動する結合コンポーネントまたはサービスエンジンの名前。 |
|
stop-jbi-component: 指定されたターゲットでサービスエンジンまたは結合コンポーネントを停止します。ターゲットが指定されていない場合、組み込み DAS サーバー上のコンポーネントが停止されます。 |
|
コンポーネント名: 停止する結合コンポーネントまたはサービスエンジンの名前。 |
|
shut-down-jbi-component: 指定されたターゲットでサービスエンジンまたは結合コンポーネントをシャットダウンします。ターゲットが指定されていない場合、組み込み DAS サーバー上のコンポーネントがシャットダウンされます。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
コンポーネント名: シャットダウンするコンポーネントの名前。 |
|
uninstall-jbi-component: 指定されたターゲットでサービスエンジンまたは結合コンポーネントをアンインストールします。ターゲットが指定されていない場合、組み込み DAS サーバーからコンポーネントがアンインストールされます。 |
|
コンポーネント名: アンインストールするコンポーネントの名前。 |
|
deploy-jbi-service-assembly: サービスアセンブリを JBI 環境に配備します。 ターゲットオプション (--target) は、Application Server Enterprise Edition でのみ使用します。 |
|
ファイルパスまたはサービスアセンブリ名: サービスアセンブリの属性を格納するアーカイブファイル、またはドメインにあらかじめ配備されているサービスアセンブリの名前。 |
|
start-jbi-service-assembly: 指定されたターゲットでサービスアセンブリを起動します。ターゲットが指定されていない場合、サーバーインスタンスに対してコマンドが実行されます。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
サービスアセンブリ名: 起動するサービスアセンブリの名前。 |
|
stop-jbi-service-assembly: 指定されたターゲットでサービスアセンブリを停止します。ターゲットが指定されていない場合、サーバーインスタンスに対してコマンドが実行されます。 |
|
サービスアセンブリ名: 停止するサービスアセンブリの名前。 |
|
shut-down-jbi-service-assembly: 指定されたターゲットでサービスアセンブリをシャットダウンします。ターゲットが指定されていない場合、サーバーインスタンスに対してコマンドが実行されます。 |
|
サービスアセンブリ名: シャットダウンするサービスアセンブリの名前。 |
|
undeploy-jbi-service-assembly: 指定されたターゲットでサービスアセンブリの配備を取り消します。ターゲットが指定されていない場合、サーバーインスタンスに対してコマンドが実行されます。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
サービスアセンブリ名: 配備を取り消すサービスアセンブリの名前。 |
|
install-jbi-shared-library: 共用ライブラリを JBI 環境にインストールします。 |
|
ファイルパス: 共用ライブラリを格納するアーカイブファイル。 |
|
uninstall-jbi-shared-library: 指定されたターゲットインスタンスまたはクラスタから共用ライブラリをアンインストールします。ターゲットが指定されていない場合、組み込み DAS サーバーから共用ライブラリがアンインストールされます。 |
|
共用ライブラリ名: アンインストールする共用ライブラリの名前。 |
|
list-jbi-service-engines: その JBI 環境にインストールされているサービスエンジンを一覧表示します。フィルタが指定されていない場合、インストールされているすべてのサービスエンジンが表示されます。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
なし。 |
|
list-jbi-binding-components: その JBI 環境にインストールされている結合コンポーネントを一覧表示します。フィルタが指定されていない場合、インストールされているすべての結合コンポーネントが表示されます。 |
|
なし。 |
|
list-jbi-shared-libraries: その JBI 環境にインストールされている共用ライブラリを一覧表示します。フィルタが指定されていない場合、インストールされているすべての共用ライブラリが表示されます。 |
|
なし。 |
|
list-jbi-service-assemblies: JBI 環境にインストールされているサービスアセンブリを一覧表示します。フィルタが指定されていない場合、インストールされているすべてのサービスアセンブリが表示されます。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
なし。 |
|
show-jbi-service-engine: 指定されたサービスエンジンの詳細情報を表示します。デフォルトでは、一般情報が表示されます。configuration、loggers、または descriptor オプションが指定されている場合は、追加の情報が表示されます。 |
|
サービスエンジンの名前。 例:show-jbi-service-engine sun-javaee-engine |
|
show-jbi-binding-component: 指定された結合コンポーネントの詳細情報を表示します。デフォルトでは、一般情報が表示されます。configuration、loggers、または descriptor オプションが指定されている場合は、追加の情報が表示されます。 |
|
結合コンポーネントの名前。 例:show-jbi-binding-component sun-http-binding |
|
show-jbi-shared-library: 指定された共用ライブラリの詳細情報を表示します。デフォルトでは、一般情報が表示されます。descriptor オプションが指定されている場合は、記述子情報が表示されます。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
共用ライブラリの名前。 例:show-jbi-shared-library cli_test_sns1 |
|
show-jbi-service-assembly: 指定されたサービスアセンブリの詳細情報を表示します。デフォルトでは、一般情報が表示されます。descriptor オプションが指定されている場合は、記述子情報が表示されます。 |
|
サービスアセンブリの名前。 例:show-jbi-service-assembly PingApp |
|
upgrade-jbi-component: 現在 JBI 環境にインストールされているサービスエンジンまたは結合コンポーネントをアップグレードします。 |
|
現在ドメインにインストールされているコンポーネントの名前。 例:upgrade-jbi-component --upgradefile=cli-test-engine4-1.jar cli_test_engine4 |
|
set-jbi-runtime-logger: JBI ランタイムのロガーのログレベルを設定します。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または設定するロガーの名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。引用符内の空白は文字とみなされます。 指定する値は、正当なロガーレベルを表すテキストでなければなりません。または、「DEFAULT」のテキストを指定できます。「DEFAULT」を使用すると、ロガーは初期状態にリセットされ、ロガーレベルは親から継承されます。 例:set-jbi-runtime-logger com.sun.jbi.messaging=WARNING |
|
set-jbi-component-logger: 指定されたコンポーネントのログレベルを設定します。 |
|
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または設定するロガーの名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。引用符内の空白は文字とみなされます。 指定する値は、正当なロガーレベルを表すテキストである必要があります。または、「DEFAULT」のテキストを指定できます。「DEFAULT」を使用すると、ロガーは初期状態にリセットされ、ロガーレベルは親から継承されます。 例:set-jbi-component-logger --component=sun-http-binding sun-http-binding.com.sun.jbi.httpsoapbc.HttpSoapBindingDeployer=INFO |
|
set-jbi-runtime-configuration: JBI ランタイム設定値を設定します。 |
|
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または設定する設定値の名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。 設定変数の正確な名前を指定します。ランタイム設定の名前と現在の値を表示するには、show-jbi-runtime-configuration コマンドを使用します。 例: set-jbi-runtime-configuration heartBeatInterval=6000 |
|
set-jbi-component-configuration: 指定されたコンポーネント名の結合コンポーネント設定値またはサービスエンジン設定値を設定します。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または設定する設定値の名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。 設定変数の正確な名前を指定します。コンポーネント設定の名前と現在の値を表示するには、show-jbi-binding-component または show-jbi-service-engine コマンドを --configuration オプションと一緒に使用します。 例:set-jbi-component-configuration OutboundThreads=5,ProxyPort=2345 |
|
update-jbi-application-configuration: 指定されたコンポーネントのアプリケーション設定を更新します。 |
|
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または更新するアプリケーション設定値の名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。 例: update-jbi-application-configuration --component=cli-config-binding --configname=testConfig ConfigData.properties |
|
update-jbi-application-variable: 指定されたコンポーネントのアプリケーション変数を更新します。アプリケーション変数は、「名前=型の値」の形式で設定します。型が指定されていない場合は、デフォルトの型である String が使用されます。有効な型は、String、Number、Boolean、および Password です。 変数を更新する場合、指定された変数の型が、その変数が作成されたときの型と一致していなければなりません。 |
|
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または更新するアプリケーション変数の名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白、または型を指定する大括弧が含まれる場合は、そのオペランドを二重引用符で囲みます。 指定された型は、create コマンドで指定した元の型と一致していなければなりません。 例: update-jbi-application-variable --component=cli-config-binding some-property-file.properties |
|
create-jbi-application-configuration: 指定されたコンポーネントのアプリケーション設定を作成します。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または作成するアプリケーション設定値の名前と値のペアが格納されたファイルの名前を指定します。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。 例: create-jbi-application-configuration --component=cli-config-binding --configname=testConfig ConfigData.properties |
|
create-jbi-application-variable: 指定されたコンポーネントのアプリケーション変数を作成します。アプリケーション変数は、「名前=[型]値」の形式で設定します。型が指定されていない場合は、デフォルトの型である String が使用されます。有効な型は、String、Number、Boolean、および Password です。 |
|
名前と値 (「名前=値」の形式) のペアをコンマで区切って指定するか、または更新するアプリケーション変数の名前と [型]値のペアが格納されたファイルの名前を指定します。オペランドに空白、または型を指定する大括弧が含まれる場合は、そのオペランドを二重引用符で囲みます。 例: create-jbi-application-variable --component=cli-config-binding some-property-file.properties |
|
delete-jbi-application-configuration: 指定されたコンポーネントのアプリケーション設定を削除します。 |
|
削除するアプリケーション設定の名前。 例: delete-jbi-application-configuration --component=cli-config-binding testConfig |
|
delete-jbi-application-variable: アプリケーション変数を削除します。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
削除する 1 つまたは複数のアプリケーション変数の名前。オペランドに空白が含まれる場合は、そのオペランドを二重引用符で囲みます。空白は文字とみなされます。 例:delete-jbi-application-variable --component cli-config-binding FirstName |
|
list-jbi-application-configurations: 指定されたコンポーネントの JBI アプリケーション設定を一覧表示します。 |
|
なし。 例:list-jbi-application-configurations --component=cli-config-binding |
|
list-jbi-application-variables: 指定されたコンポーネントの JBI アプリケーション変数を一覧表示します。 |
|
なし。 例:list-jbi-application-variables --component=cli-config-binding |
|
show-jbi-runtime-loggers: JBI 実行時ロガーを表示します。 |
オプションとその使用法の詳細については、JBI Command Options and Values Tableを参照してください。 |
なし。 例:show-jbi-runtime-loggers |
|
show-jbi-runtime-configuration: JBI ランタイム設定値を表示します。 |
|
なし。 例:show-jbi-runtime-configuration |
|
show-jbi-statistics: 指定されたオプション値を使用してフィルタリングした JBI 統計情報を表示します。コマンド行で複数のオプション値を指定して、複数の統計カテゴリを表示できます。 |
|
なし。 例:show-jbi-statistics --nmr |
次の表に、JBI コマンドオプションの説明を示します。
オプション |
値 |
説明 |
---|---|---|
共通オプション: これらのオプションは、ほとんどの JBI コンポーネント asadmin コマンドに共通します。 |
||
--echo | -e |
true | false |
true は、コマンド行で指定されたコマンドがシステム出力にエコーされることを示します。 |
--interactive| -I |
true | false |
true (デフォルト) は、必要なパスワードオプションのみの入力が求められることを示します。 |
--terse | -t |
true | false |
true は、出力が最小限の量に減らされることを示します。 |
--port | -p |
ポート番号 |
管理用の HTTP/S ポート。PE のデフォルトポートは 4848、EE のデフォルトポートは 4849 です。 |
--secure | -s |
true | false |
true は、ドメイン管理サーバーとの通信に SSL/TLS が使用されることを示します。 |
--host | -H |
localhost |
JBI アプリケーションが実行されているマシン名。デフォルト値は localhost です。 |
--user | -u |
管理ユーザー |
承認された、ドメイン管理サーバーの管理ユーザー名。 |
--passwordfile |
filename |
パスワードエントリが格納されているファイルの名前。 |
--target |
target name | [server]|domain |
ターゲットの名前。 |
--help |
コマンドのヘルプテキストを表示します。 |
|
専用オプション: これらのオプションは、特定の JBI コンポーネント asadmin コマンドでのみ使用されます。 |
||
--assemblyname |
サービスアセンブリ名 |
指定されたサービスアセンブリ名を持つサービスアセンブリユニットの一部として ASA が配備されているコンポーネントを一覧表示します。 |
--component |
コンポーネント名 |
参照されているコンポーネントの名前。 |
--componentname |
コンポーネント名 |
指定したコンポーネントで参照される共用ライブラリを一覧表示します。 |
--configuration |
true|[false] |
コンポーネントの設定値を表示します。 |
--descriptor |
true|[false] |
コンポーネントの XML 記述子を表示します。 |
--endpoint |
エンドポイント名 |
エンドポイントの統計情報を表示します。 |
--force| -F |
true|[false] |
true は、コンポーネントが強制的にシャットダウンされることを示します。 |
--framework |
true|[false] |
フレームワークの統計情報を表示します。 |
--keeparchive |
true|[false] |
true は、コンポーネントがドメイン内に保持されることを示します。 |
--libraryname |
共用ライブラリ名 |
指定された共用ライブラリを現在使用しているコンポーネントを一覧表示します。 |
--lifecyclestate |
shutdown|started|stopped |
コンポーネントのライフサイクル状態によって一覧をフィルタリングできます。 |
--loggers |
true|[false] |
コンポーネントのロガーおよびそのレベルを表示します。 |
--nmr |
true|[false] |
NMR (正規化メッセージルーター) の統計情報を表示します。 |
--serviceassembly |
サービスアセンブリ名 |
コンポーネントの統計情報を表示します。 |
--upgradefile |
[filepath] |
コンポーネントの更新に使用される新しいアーカイブファイルパスです。 |
--upload |
[true]|false |
true は、管理サーバーにファイルをアップロードすることを示します。インストール可能ファイルのファイルパスがサーバーマシンにマウントされている場合、または管理サーバーがローカルで実行されている場合は、upload オプションを false に設定します。 |
コマンド行から asadmin ユーティリティーを起動するには、install-dir /bin (install-dir はアプリケーションサーバーのインストールディレクトリ) ディレクトリに移動し、asadmin コマンドを入力します。
asadmin ユーティリティーツールを使用するための Windows 環境の設定方法については、「GlassFish クイックスタートガイド」 を参照してください。
asadmin ユーティリティーの使用の詳細については、「GlassFish JBICLI Project Plan」 および「JBI ADMIN CLI」 を参照してください。