installUtility 命令

使用 installUtility 命令可查找基于目录的存储库， Liberty Asset Repository Service 实例或 Liberty Repository中的资产，获取这些资产的相关信息并进行安装。

资产源

installUtility 命令可访问以下存储库中的资产：
  • Liberty Repository是可通过因特网访问的公共 IBM®托管的存储库。 有关更多信息，请参阅 Liberty Repository。
  • 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]
action 可以采用下列其中一个值：
download
从存储库下载资产。
find
在适用于您的配置的存储库中查找资产或查看有关资产的详细信息。
install
将资产或企业子系统归档 (ESA) 文件安装至运行时，或部署服务器软件包并安装该软件包的必需功能部件。
testConnection
测试存储库连接。
uninstall
通过指定功能部件短名称或功能部件符号名称来卸载功能部件。 可指定多个功能部件，多项之间以空格分隔。
注: 请确保在卸载功能部件之前停止所有服务器进程。
viewSettings
查看用于配置存储库或代理的模板，或查看并验证所配置存储库或代理的设置。
帮助
显示有关所指定操作的帮助信息。

选项

以下选项对 installUtility download 命令可用：
--acceptLicense
接受许可协议。
系统不会提示用户接受许可证，并且从 Liberty Repository安装 Liberty 功能部件时不需要 --acceptLicense 选项。 但是，在进行以下操作时，系统仍会提示用户接受许可证或者仍需要 --acceptLicense 选项：
  1. 将包含许可证的用户功能部件安装至任何 Liberty 安装
  2. 将 WebSphere® Application Server Network Deployment Liberty 的 Liberty 功能部件安装到 WebSphere Application Server Liberty (ILAN) 安装
--viewLicenseAgreement
查看许可协议。
--viewLicenseInfo
查看许可协议。
- -location=directoryPath
对所下载资产指定目标目录。 此选项为必需。
--overwrite
此选项用于在下载到本地目录时覆盖现有的文件。 未指定此选项的缺省行为是忽略全部现有文件。
--verbose
使用此选项以在下载期间显示附加信息。
名称
指定资产标识以下载下列其中一个或多个资产（使用空格分隔多个资产标识）：
  • 功能部件
  • 附加组件
  • 开放式源代码集成
  • 样本

以下选项对 installUtility find 命令可用：
--from=基于目录的存储库
对 installUtility 命令指定单个基于目录的存储库作为资产源。

基于目录的存储库可以是未压缩的文件夹，也可以是压缩归档文件。

要在多个基于目录的存储库中搜索资产，必须在 repositories.properties 文件中配置这些存储库。 有关更多信息，请参阅 为 installUtility 命令配置存储库和代理设置。

--showDescriptions
显示通过搜索找到的每个功能部件的描述。
--type=[feature|sample|opensource|addon|all*]
搜索指定类型的资产。
--name
搜索资产名称以查找指定 searchString。
--verbose
使用此选项以在操作运行时显示所有可用附加信息。
searchString
查找适用于您的配置的资产。 如果未指定搜索字符串，那么该命令搜索所有适用资产。

以下选项对 installUtility install 命令可用：
--to=安装选项
install_option 选项可采用下列其中一个值：
  • usr：此功能部件作为用户功能部件安装。 此值是缺省值。
  • extension：要安装功能部件的位置。 可以将该功能部件安装到所配置的任何产品扩展位置。
--from=基于目录的存储库
对 installUtility 命令指定单个基于目录的存储库作为资产源。

基于目录的存储库可以是未压缩的文件夹，也可以是压缩归档文件。

要从多个基于目录的存储库安装资产，必须在 repositories.properties 文件中配置这些存储库。 有关更多信息，请参阅 为 installUtility 命令配置存储库和代理设置。

--acceptLicense
指示是否接受许可条款和条件。
--viewLicenseAgreement
查看许可协议。
--viewLicenseInfo
查看许可证信息。
--verbose
使用此选项以在操作运行时显示所有可用附加信息。
名称
指定您要安装的一个或多个资产。 可采用下列方式指定资产：
资产标识
可指定资产标识以安装下列其中一个或多个资产（使用空格分隔多个资产标识）：
  • 功能部件
  • 附加组件
  • 开放式源代码集成
  • 样本
服务器名称
可根据同一 Liberty 环境中的现有服务器（通过指定服务器名称）安装功能部件。 此命令安装该服务器的 server.xml 文件中定义的 Liberty 环境中尚未安装的所有适用功能部件。
服务器软件包
可使用 server package --include=usr 命令指定您创建的服务器软件包。 服务器软件包部署及 server.xml 文件中定义的必需功能部件是从存储库安装的。
server.xml file
要根据服务器配置文件安装功能部件，可指定指向任何本地 server.xml 文件的路径，例如，C:\localDir\server.xml。 此命令安装 server.xml 文件中定义的 Liberty 环境中尚未安装的所有适用功能部件。
.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。 许可证文件、校验和文件、本地化文件及其他子系统内容将解压至子系统清单中定义的位置。

以下选项可用于 installUtility testConnection 命令:
repoName
指定要测试的存储库的名称。 如果未指定，那么将测试 repositories.properties 文件中指定的所有存储库。

以下选项可用于 installUtility uninstall 命令:
--force
卸载所指定功能部件而不理会其他已安装功能部件是否具有依赖项。
注: 卸载其他已安装功能部件所需的功能部件可能会导致这些功能部件停止工作，并可能导致服务器无法正常运行。
--noPrompts
卸载功能部件而不提示。 缺省值为 false。
--verbose
使用此选项以在卸载期间显示附加信息。
名称
指定要卸载的一个或多个功能部件（多个名称之间用空格分隔）。 可指定以下选项：
  • 子系统归档（ESA 文件）的短名称，例如，adminCenter-1.0。
  • 子系统归档（ESA 文件）的符号名称，例如，com.ibm.websphere.appserver.adminCenter-1.0。

通过为功能部件名加上后跟冒号的扩展名前缀（例如，usr:webCacheMonitor-1.0），可卸载用户功能部件和产品扩展。


以下选项可用于 installUtility viewSettings 命令:
--viewValidationMessages
使用此选项显示通过验证所配置 repositories.properties 文件生成的详细信息。 每个消息包含错误代码、发现错误的位置的行号及错误原因。

用法示例

使用以下示例以显示 install 操作的帮助信息：
installUtility help install
使用以下示例来安装用户功能部件：
installUtility install my_feature --to=usr
使用以下示例将用户功能部件安装至 my_extension 产品扩展位置：
installUtility install my_feature --to=my_extension
使用以下示例来安装多个功能部件：
installUtility install feature1 feature2 feature3
使用以下示例来安装样本：
installUtility install JDBCSample
使用以下示例从一个基于本地目录的存储库安装功能部件捆绑软件附加组件：
installUtility install ndMemberBundlelibertyCoreBundle --from=c:\download\wlp-featureRepo-16.0.0.2
使用以下示例从一个基于目录的压缩存储库归档安装功能部件捆绑包附加组件：
installUtility install ndMemberBundlelibertyCoreBundle --from=c:\download\wlp-featureRepo-16.0.0.2.zip
使用以下示例来安装服务器：
installUtility install myServer
使用以下示例来安装服务器软件包压缩 .jar 文件：
installUtility install c:\temp\myServer.jar
使用以下示例来安装本地 .esa 文件：
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
使用以下示例来测试与 Liberty Repository的连接:
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

返回码

表 1. 返回码和说明
返回码 说明
0 此命令成功完成请求的操作。
20 一个或多个自变量无效。
21 由于下列一种或多种情况而发生了运行时异常：
  • 安装 .esa 子系统归档文件时发生了运行时异常。
  • 许可证未接受或未被认可。
  • .esa 子系统归档文件未正确解压缩。
22 要安装的功能部件已存在。
23 由于以下一个或多个原因，功能部件定义无效：
  • 功能部件不具有有效清单文件。
  • 在此 Liberty 环境中，不支持功能部件的该版本。
  • 包含功能部件文件的 .zip 或 .jar 文件不存在。
24 .esa 子系统归档文件缺少内容。
25 要安装的文件已存在。
26 该产品不是核心产品，且找不到产品扩展文件。
27 该产品不是核心产品，且未在 ${wlp.install.dir}/etc/extensions/extension_name.properties 文件中定义产品扩展。
28 找不到产品扩展中功能部件的清单文件。
29 针对当前产品，此功能部件无效。
30 repositories.properties 文件未通过验证。
33 与存储库的连接失败。
34 未找到该存储库名称。 所提供存储库名称在配置文件中不存在。
35 用户已取消此操作。
36 用户功能部件安装对于所指定的扩展 --to=core 而言无效。