installUtility 指令

使用 installUtility 指令尋找和取得目錄型儲存庫、「Liberty 資產儲存庫服務」實例,或 Liberty Repository 中之資產的相關資訊,並安裝這些資產。

資產來源

installUtility 指令可存取下列儲存庫中的資產:
  • Liberty Repository,這是一個可透過網際網路存取且由 IBM® 管理的公用儲存庫。如需相關資訊,請參閱Liberty Repository
  • Liberty 資產儲存庫服務,這是一個開放程式碼服務,可用來建立內部部署的儲存庫,以便在企業防火牆保護下從遠端存取它。 如需相關資訊,請參閱 GitHub 上的 WASdev/tool.lars 儲存庫
  • 本端目錄型儲存庫,若要建立它,請使用 installUtility download 動作或是下載 wlp-featureRepo-<version>.zip 檔,其中含有所有適用的特性和附加程式。如需相關資訊,請參閱使用 installUtility 指令來下載資產

您可以直接從壓縮儲存庫(例如 wlp-featureRepo-<version>.zip),使用 installUtility 指令來處理目錄型儲存庫資產,而不需將保存檔解壓縮。如需 wlp-featureRepo-<version>.zip 檔的相關資訊,請參閱使用 installUtility 指令來下載資產

語法

指令語法如下:

installUtility action [options]
action 可以採用下列其中一值:
download
從儲存庫下載資產。
find
在適用於您配置的儲存庫中尋找資產,或檢視有關資產的詳細資訊。
install
將資產或企業子系統保存檔 (ESA) 安裝到執行時期,或是部署伺服器套件,並安裝套件中的必要特性。
testConnection
測試儲存庫連線。
uninstall
指定特性的簡稱或符號名稱,來解除安裝該特性。您可以指定多項特性,並以空格區隔。
註: 在您解除安裝特性之前,請確定所有伺服器程序都已停止。
viewSettings
檢視用來配置儲存庫或 Proxy 的範本,或檢視和驗證所配置之儲存庫或 Proxy 的設定。
help
顯示指定動作的說明資訊。

選項

installUtility download 指令的可用選項如下:
--acceptLicense
接受授權合約。
--viewLicenseAgreement
檢視授權合約。
--viewLicenseInfo
檢視授權合約。
--location=directoryPath
指定所下載資產的目的地目錄。這個選項是必要的。
--overwrite
當您下載至本端目錄時,這個選項可用來改寫現有的檔案。如果沒有使用這個選項,則預設行為是忽略所有現有的檔案。
--verbose
這個選項用來在下載期間顯示其他資訊。
name
指定資產 ID 以下載下列一或多個資產,多個資產 ID 之間請以空格區隔:
  • 特性
  • 附加程式
  • 開放程式碼整合
  • 範例

installUtility find 指令的可用選項如下:
--from
指定單一目錄型儲存庫,以作為 installUtility 指令的資產來源。

目錄型儲存庫可以是未壓縮的資料夾或已壓縮的保存檔。

如果要在多個目錄型儲存庫中搜尋資產,您必須在 repositories.properties 檔中配置儲存庫。如需相關資訊,請參閱為 installUtility 指令配置儲存庫和 Proxy 設定

--showDescriptions
顯示搜尋找到的每一項特性的說明。
--type=[feature|sample|opensource|addon|all*]
搜尋指定類型的資產。
--name
搜尋具有指定 searchString 的資產名稱。
--verbose
在動作執行期間,可使用這個選項來顯示任何可用的其他資訊。
searchString
尋找適用於您配置的資產。如果您沒有指定搜尋字串,指令會搜尋所有適用的資產。

installUtility install 指令的可用選項如下:
--to=install_option
install_option 選項可採用下列其中一值:
  • usr:特性會安裝成使用者特性。這是預設值。
  • extension:特性的安裝位置。您可以將特性安裝在任何已配置的產品延伸位置。
--from
指定單一目錄型儲存庫,以作為 installUtility 指令的資產來源。

目錄型儲存庫可以是未壓縮的資料夾或已壓縮的保存檔。

如果要從多個目錄型儲存庫安裝資產,您必須在 repositories.properties 檔中配置儲存庫。如需相關資訊,請參閱為 installUtility 指令配置儲存庫和 Proxy 設定

--acceptLicense
指出是否接受授權條款和條件。
--viewLicenseAgreement
檢視授權合約。
--viewLicenseInfo
檢視授權資訊。
--verbose
在動作執行期間,可使用這個選項來顯示任何可用的其他資訊。
name
指定您想安裝的一或多個資產。指定資產的方式如下:
資產 ID
您可以指定資產 ID,來安裝下列一或多個資產,多個資產 ID 之間請以空格區隔:
  • 特性
  • 附加程式
  • 開放程式碼整合
  • 範例
伺服器名稱
您可以指定伺服器名稱,根據相同 Liberty 環境中的現有伺服器來安裝特性。指令會安裝該伺服器 server.xml 檔中所定義且尚未安裝在 Liberty 環境中的任何適用特性。
伺服器套件
您可以使用 server package --include=usr 指令,來指定您已建立的伺服器套件。伺服器套件會部署,並從儲存庫安裝 server.xml 檔中所定義的必要特性。
server.xml
如果要根據伺服器配置檔來安裝特性,您可以指定任何本端 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
這個選項用來在解除安裝期間顯示其他資訊。
name
指定一或多個要解除安裝的特性,並以空格來區隔多個名稱。您可以指定下列選項:
  • 子系統保存檔(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 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
下列範例用來安裝伺服器套件 .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 使用者已取消該動作。
[17.0.0.3 以及更新版本]36 [17.0.0.3 以及更新版本]使用者特性安裝架構對指定的延伸無效:--to=core。

指示主題類型的圖示 參照主題

檔名:rwlp_command_installutility.html