指令格式

如果要執行指令，請開啟指令行視窗，然後指定指令及其參數。在某些情況下，您必須為指令傳遞具有相關資訊的 JSON 字串。

指令具有下列格式：

udclient [global-args...] [global-flags...] <command> [args...]

註：您必須在一行中輸入 CLI 指令。

註： CLI 指令及參數區分大小寫。

註：使用 CLI 指令時所需的權限與使用 Web 介面時所需的權限相同。如需權限的相關資訊，請參閱角色及許可權。

傳遞參數

大部分指令都需要一個以上的參數。參數可以變更伺服器解譯指令的方式。

例如，如果不將任何參數傳遞至 getResources 指令（必要的廣域參數除外），則伺服器將列出最上層資源：

udclient -weburl http://ucdserver.example.com:8080 
  -username admin 
  -password admin 
  getResources

不過，如果在 parent 參數中傳遞資源的路徑或 ID，則該指令會傳回該資源下面的資源，如下列範例中所示：

udclient -weburl http://ucdserver.example.com:8080
  -username admin
  -password admin
  getResources
  -parent "/My Agents"

傳遞 JSON 字串

部分指令需要 JSON 字串或檔案，而不需要參數，或者除了參數之外，還需要 JSON 字串或檔案。

例如，createApplication 指令會建立應用程式。如果要使用此指令，您必須傳遞用於指定新應用程式之名稱、說明及部分內容的有效 JSON 字串。此指令的 JSON 字串必須遵循下列範本：

{
  "description": "Description",
  "enforceCompleteSnapshots": "Specify true to require 
     an explicit version for each component",
  "name": "Application name or ID",
  "notificationScheme": "Notification scheme"
}

註：如果要查看指令所需的 JSON 範本，請使用 -t 參數來執行該指令，如下列範例中所示：

udclient -weburl http://ucdserver.example.com:8080
  -username admin
  -password admin
  createApplication
  -t

此範本也列在指令的參考資訊中；請參閱 createApplication。

例如，下列 JSON 字串代表名為 My Application 的應用程式：

{
  "description": "My new application",
  "enforceCompleteSnapshots": "false",
  "name": "My Application",
  "notificationScheme": "Default Notification Scheme"
}

如果要傳遞此 JSON 字串，請將該字串儲存至檔案，並將該檔案傳遞至指令。例如，如果將該字串儲存至名為 newApplication.json 的檔案，則該指令將類似於下列範例：

udclient -weburl http://ucdserver.example.com:8080
  -username admin
  -password admin
  createApplication
  newApplication.json

註：您傳遞至該指令的字串必須是有效的 JSON 字串。

廣域參數及旗標

下表列出指令的廣域參數。這些廣域參數在程式碼範例中作為 [global-args...] 列出。

表 1. 廣域參數
引數	說明
-authtoken 和 --authtoken	選用。可以使用 DS_AUTH_TOKEN 環境變數進行設定。由伺服器產生的鑑別記號（鑑別記號）。需要鑑別記號或使用者名稱及密碼。
-password 和 --password	選用。可以使用 DS_PASSWORD 環境變數進行設定。用於向伺服器進行鑑別的密碼。需要鑑別記號或使用者名稱及密碼。
-proxyHost 和 --proxyHost	選用。可以使用 proxyHost 環境變數進行設定。要使用的 Proxy（例如，代理程式中繼）的主機名稱，而不是與伺服器的直接連線。
-proxyPassword 和 --proxyPassword	選用。可以使用 proxyPassword 環境變數進行設定。用於向 Proxy 進行鑑別的密碼。
-proxyPort 和 --proxyPort	選用。可以使用 proxyPort 環境變數進行設定。如果指定了 Proxy 主機名稱，則這是要使用的 Proxy 埠。
-proxyUser 和 --proxyUser	選用。可以使用 proxyUser 環境變數進行設定。用於向 Proxy 進行鑑別的使用者名稱。
-username 和 --username	選用。可以使用 DS_USERNAME 環境變數進行設定。用於向伺服器進行鑑別的使用者名稱。需要鑑別記號或使用者名稱及密碼。
-weburl 和 --weburl	必要項目。可以使用 DS_WEB_URL 環境變數進行設定。IBM UrbanCode Deploy 伺服器的基本 URL。例如，http://ds.example.com:8585。

下表顯示了廣域旗標。這些廣域旗標在程式碼範例中作為 [global-flags...] 列出。

表 2. 廣域旗標
旗標	說明
-t 和 --getTemplate	顯示指令的 JSON 範本，而不執行指令。如果提供了檔案引數，則會將範本輸出至指定的檔案。
-h 和 --help	列印指令的完整描述及說明，而不執行指令。
-v 和 --verbose	列印額外資訊。

在指令行中指定物件（例如，應用程式、元件、代理程式及資源）時，您可以使用物件的名稱或物件 ID。物件的 ID 是您在 IBM UrbanCode Deploy 中檢查該物件時所顯示之 URL 的一部分。例如，如果瀏覽特定的元件，並且 URL 是 https://ucdeploy.example.com:8443/#component/2f153e93-00c3-44ef-a7fd-87e544e698d4，則元件的 ID 是 2f153e93-00c3-44ef-a7fd-87e544e698d4。

這個範例顯示 getResources 指令：

udclient -weburl http://localhost:8080 -username admin -password admin getResources

意見