installUtility コマンド
installUtility コマンドは、ディレクトリー・ベースのリポジトリー、Liberty Asset Repository Service のインスタンス、または Liberty リポジトリー 内にあるアセットの検索、その情報の取得、およびインストールを行うために使用します。
アセット・ソース
- Liberty リポジトリー。これは、インターネットを介してアクセス可能な、IBM® がホストする公開リポジトリーです。詳しくは、Liberty リポジトリーを参照してください。
- Liberty Asset Repository Service。これは、エンタープライズのファイアウォールの背後でリモート・アクセス可能なオンプレミス・リポジトリーを作成するために使用できる、オープン・ソースのサービスです。詳しくは、「GitHub の WASdev/tool.lars プロジェクト」を参照してください。
- ローカル・ディレクトリー・ベースのリポジトリー。これは、installUtility download アクションを使用して作成するか、または wlp-featureRepo-<version>.zipファイル (利用可能なすべてのフィーチャーおよびアドオンが含まれています) をダウンロードして作成します。詳しくは、『installUtility コマンドを使用したアセットのダウンロード』を参照してください。
installUtility コマンドを使用して、アーカイブを解凍することなく、wlp-featureRepo-<version>.zip などの圧縮されたリポジトリーから直接、ディレクトリー・ベースのリポジトリーのアセットを処理できます。wlp-featureRepo-<version>.zip ファイルについて詳しくは、installUtility コマンドを使用したアセットのダウンロードを参照してください。
構文
コマンド構文は次のようになります。
installUtility action [options]
- download
- リポジトリーから資産をダウンロードします。
- find
- ご使用の構成に適用可能な資産をリポジトリーで検索するか、資産に関する詳細情報を表示します。
- install
- アセットまたはエンタープライズ・サブシステム・アーカイブ (ESA) ファイルをランタイムにインストールするか、サーバー・パッケージをデプロイし、パッケージに必要なフィーチャーをインストールします。
- testConnection
- リポジトリー接続をテストします。
- uninstall
- フィーチャーのショート・ネームまたはフィーチャーのシンボル名のいずれかを指定して、フィーチャーをアンインストールします。スペースで区切って、複数のフィーチャーを指定できます。
- 注: フィーチャーをアンインストールする前には、必ず、すべてのサーバー・プロセスを停止してください。
- viewSettings
- リポジトリーまたはプロキシーを構成するためのテンプレートを表示するか、構成されているリポジトリーまたはプロキシーの設定を表示して検査します。
- help
- 指定したアクションのヘルプ情報を表示します。
オプション
- --acceptLicense
- ご使用条件を受諾します。
- --viewLicenseAgreement
- ご使用条件を表示します。
- --viewLicenseInfo
- ご使用条件を表示します。
- --location=directoryPath
- ダウンロードしたアセットの宛先ディレクトリーを指定します。このオプションは必須です。
- --overwrite
- このオプションは、ローカル・ディレクトリーにダウンロードするときに既存のファイルを上書きする場合に使用します。オプションを指定しなかった場合のデフォルト動作では、既存のすべてのファイルが無視されます。
- --verbose
- このオプションは、ダウンロード時に追加情報を表示する場合に使用します。
- name
- 以下の 1 つ以上のアセットをダウンロードするためのアセット ID を指定します。複数のアセット ID はスペースで区切ります。
- フィーチャー
- アドオン
- オープン・ソース統合
- サンプル
- --from
- installUtility コマンドのアセットのソースとして、単一のディレクトリー・ベースのリポジトリーを指定します。
ディレクトリー・ベースのリポジトリーは、圧縮されていないフォルダーでも、圧縮されたアーカイブ・ファイルでも構いません。
複数のディレクトリー・ベースのリポジトリーでアセットを検索する場合は、repositories.properties ファイルでそれらのリポジトリーを構成する必要があります。詳しくは、installUtility コマンドのリポジトリーおよびプロキシー設定の構成を参照してください。
- --showDescriptions
- 検索で見つかった各フィーチャーの説明を表示します。
- --type=[feature|sample|opensource|addon|all*]
- 指定したタイプの資産を検索します。
- --name
- 指定された searchString のアセット名を検索します。
- --verbose
- アクションの実行中に使用可能な追加情報を表示するには、このオプションを使用します。
- searchString
- ご使用の構成に適用可能な資産を検索します。検索ストリングを指定しなかった場合、コマンドはすべての該当するアセットを検索します。
- --to=install_option
- install_option オプションは、以下のいずれかの値を取ることができます。
- usr: フィーチャーはユーザー・フィーチャーとしてインストールされます。この値はデフォルト値です。
- extension: フィーチャーをインストールする場所。 構成済みの任意の製品拡張ロケーションにフィーチャーをインストールできます。
- --from
- installUtility コマンドのアセットのソースとして、単一のディレクトリー・ベースのリポジトリーを指定します。
ディレクトリー・ベースのリポジトリーは、圧縮されていないフォルダーでも、圧縮されたアーカイブ・ファイルでも構いません。
複数のディレクトリー・ベースのリポジトリーにあるアセットをインストールする場合は、repositories.properties ファイルでそれらのリポジトリーを構成する必要があります。詳しくは、installUtility コマンドのリポジトリーおよびプロキシー設定の構成を参照してください。
- --acceptLicense
- ライセンス条項に同意することを示します。
- --viewLicenseAgreement
- ご使用条件を表示します。
- --viewLicenseInfo
- ライセンス情報を表示します。
- --verbose
- アクションの実行中に使用可能な追加情報を表示するには、このオプションを使用します。
- name
- インストールする 1 つ以上のアセットを指定します。以下のようにアセットを指定できます。
- アセット ID
- 以下の 1 つ以上のアセットをインストールするためのアセット ID を指定できます。複数のアセット ID はスペースで区切ります。
- フィーチャー
- アドオン
- オープン・ソース統合
- サンプル
- サーバー名
- サーバー名を指定することで、同じ Liberty 環境内の既存サーバーに基づいて、フィーチャーをインストールできます。このコマンドは、そのサーバーの server.xml ファイルで定義されている該当するフィーチャーのうち、Liberty 環境にまだインストールされていないものをインストールします。
- サーバー・パッケージ
- server package --include=usr コマンドを使用して作成したサーバー・パッケージを指定することができます。サーバー・パッケージがデプロイされ、server.xml ファイルに定義されている必須フィーチャーがリポジトリーからインストールされます。
- server.xml ファイル
- サーバー構成ファイルに基づいてフィーチャーをインストールするために、ローカル server.xml ファイルのパスを指定できます (例えば、C:¥localDir¥server.xml)。このコマンドは、Liberty 環境にまだインストールされていない、server.xml ファイルに定義されている該当フィーチャーをインストールします。
- .esa ファイル
- ローカル・ファイル・システム上の .esa ファイルからフィーチャーをインストールします。このアクションでは、新規フィーチャー・マニフェストとして .esa ファイルからの OSGI-INF/SUBSYTEM.MF マニフェスト・ファイルを使用します。マニフェスト・ファイルは、フィーチャーの名前、コンテンツ、および依存関係を指定します。--to オプションを指定した場合、installUtility はマニフェスト・ファイルを ${wlp.user.dir}/extensions/lib/features ディレクトリー (製品拡張機能ディレクトリー) にコピーします。サブシステムのすべてのバンドルが ${wlp.user.dir}/extensions/lib ディレクトリーに抽出され、{bundle symbolic name}_{bundle version}.jar と名前変更されます。ライセンス・ファイル、チェックサム・ファイル、ローカライゼーション・ファイル、およびその他のサブシステム・コンテンツが、サブシステム・マニフェストで定義されたロケーションに抽出されます。
- repoName
- テストするリポジトリーの名前を指定します。指定しなかった場合、repositories.properties ファイルで指定されているすべてのリポジトリーがテストされます。
- --force
- インストールされている他のフィーチャーが指定フィーチャーに依存しているかどうかに関係なく、そのフィーチャーをアンインストールします。注: インストールされている他のフィーチャーによって必要とされているフィーチャーをアンインストールすると、それらのフィーチャーが動作を停止したり、サーバーが正しく実行されなくなったりする可能性があります。
- --noPrompts
- プロンプトを出さずにフィーチャーをアンインストールします。デフォルトは false です。
- --verbose
- このオプションは、アンインストール時に追加情報を表示する場合に使用します。
- name
- アンインストールする 1 つ以上のフィーチャーを指定します。複数の名前はスペースで区切ります。以下のオプションを指定できます。
- サブシステム・アーカイブ (ESA ファイル) のショート・ネーム。例: adminCenter-1.0
- サブシステム・アーカイブ (ESA ファイル) のシンボル名。例: com.ibm.websphere.appserver.adminCenter-1.0
フィーチャー名の前に拡張とコロンを付けて (usr:webCacheMonitor-1.0 など)、ユーザー・フィーチャーおよび製品拡張をアンインストールできます。
- --viewValidationMessages
- このオプションは、構成されている repositories.properties ファイルの検証からの詳細メッセージを表示する場合に使用します。各メッセージには、エラー・コード、エラーが見つかった行番号、およびエラーの原因が含まれます。
使用例
installUtility help install
installUtility install my_feature --to=usr
installUtility install my_feature --to=my_extension
installUtility install feature1 feature2 feature3
installUtility install mongoDBSample
installUtility install --from=c:¥download¥wlp-featureRepo-16.0.0.2
installUtility install --from=c:¥download¥wlp-featureRepo-16.0.0.2.zip
installUtility install myServer
installUtility install c:¥temp¥myServer.jar
installUtility install c:¥temp¥myFeature.esa
installUtility install c:¥temp¥myServer.zip
installUtility find searchString
installUtility find searchString --type=sample
installUtility find webCacheMonitor-1.0 --name --type=feature
installUtility find searchstring --showDescriptions
installUtility download feature_shortName --location=c:¥temp¥download --acceptLicense
installUtility testConnection default
installUtility uninstall adminCenter-1.0
installUtility uninstall usr:webCacheMonitor-1.0
installUtility uninstall feature1 feature2 feature3
installUtility uninstall --noPrompts feature1 feature2 feature3
戻りコード
戻りコード | 説明 |
---|---|
0 | コマンドは、要求された操作を正常に完了しました。 |
20 | 1 つ以上の引数が無効です。 |
21 | 次の 1 つ以上の条件のため、実行時例外が発生しました。
|
22 | インストール対象のフィーチャーが存在します。 |
23 | 次の 1 つ以上の理由により、フィーチャー定義が無効でした。
|
24 | .esa サブシステム・アーカイブ・ファイルにコンテンツが含まれていません。 |
25 | インストール対象のファイルが存在します。 |
26 | この製品はコア製品ではなく、製品拡張ファイルが見つかりません。 |
27 | この製品はコア製品ではなく、製品拡張が ${wlp.install.dir}/etc/extensions/extension_name.properties ファイルに定義されていません。 |
28 | 製品拡張内のフィーチャーのマニフェスト・ファイルが見つかりません。 |
29 | このフィーチャーは、現在の製品には無効です。 |
30 | repositories.properties ファイルが検証に失敗しました。 |
33 | リポジトリーへの接続が失敗しました。 |
34 | リポジトリー名が見つかりません。指定されたリポジトリー名が構成ファイルに存在しません。 |
35 | アクションはユーザーによってキャンセルされました。 |
![]() |
![]() |