一般 IBM Cloud CLI (ibmcloud)指令

IBM Cloud® 指令行介面提供一組按命名空間分類的指令，供使用者與 IBM Cloud 互動。

IBM Cloud CLI 支援下列指令，包括其名稱、參數、選項、先決條件、說明和範例。

全球先決條件

每個指令的先決條件說明在執行指令前需要進行哪些動作。 先決條件可包括下列一個或多個動作：

端點
使用 ibmcloud api 指令 設定 API 端點。
登入
使用 ibmcloud login 指令 登入。 如果您使用聯合 ID 登入，請使用 --sso 選項以一次性密碼進行驗證。 或者，使用 --apikey 選項透過 API 金鑰進行鑑別。
目標
使用 ibmcloud target 指令 設定或檢視目標帳戶或區域。

廣域選項

下列選項適用於 IBM Cloud CLI 中的大多數命令。 若要檢查特定指令是否有選項，請在指令中使用 -h, --help 選項。

--output FORMAT

指定輸出格式。 只支援 JSON。

範例

以 JSON 格式列印可用的資源群組：

ibmcloud resource groups --output json

-q, --quiet

抑制詳細訊息。 如果指定 -q, --quiet ，則不會顯示 Getting information from... as ... 等提示訊息。

範例

在靜音模式下列印可用的資源群組：

ibmcloud resource groups -q

ibmcloud help

顯示 IBM Cloud CLI 之第一層內建指令及所支援名稱空間的一般說明，或特定內建指令或名稱空間的說明。

ibmcloud help [COMMAND|NAMESPACE]

必要條件

無。

指令選項

COMMAND|NAMESPACE
顯示其說明的指令或名稱空間。 如果未指定，則會顯示 IBM Cloud CLI 的一般說明。 選用。

範例

顯示 IBM Cloud CLI 的一般說明：

ibmcloud help

顯示 dev 指令的說明：

ibmcloud help dev

ibmcloud 協助

別名： ai

向使用 watsonx 的 AI 助理提問。 如需有關功能和限制的詳細資訊，請參閱 Getting help from the AI assistant。

ibmcloud assist "MY_QUERY"

AI 助理產生的內容可能包含錯誤或不正確。

必要條件

  • 使用 ibmcloud login 指令來登入。 如果您使用聯合 ID 登入，請使用 --sso 選項以一次性密碼進行驗證，或使用 --apikey 選項以 API 金鑰進行驗證。

指令選項

無。

範例

ibmcloud assist "How do I update the CLI?"

如果您在查詢中使用引號或感嘆號，請務必使用 \ 刪除每個字元。 如需詳細資訊，請參閱 IBM Cloud CLI 中使用字串的引號。

ibmcloud 版本

別名： v

列印 IBM Cloud CLI 的版本。

ibmcloud version

必要條件

無。

指令選項

無。

範例

列印 IBM Cloud CLI 的版本：

ibmcloud version

ibmcloud api

設定或檢視 IBM Cloud API 端點。

ibmcloud api [API_ENDPOINT] [--unset] [--skip-ssl-validation] [--vpc]

必要條件

無。

指令選項

API_ENDPOINT
設為目標的 API 端點，例如 https://cloud.ibm.com。 如果未同時指定 API_ENDPOINT 及 --unset 選項，則會顯示現行 API 端點。 選用。
--skip-ssl-validation
略過 HTTP 要求的 SSL 驗證。 不建議使用這個選項。
--vpc
為私有 API 端點使用 VPC 連線。 如需更多關於設定將 VPC 連線用於私有 API 端點的資訊，請參閱 設定私有端點閘道(使用 VPC 必須)。
--unset
移除 API 端點設定。

範例

將 API 端點設定為 cloud.ibm.com：

ibmcloud api cloud.ibm.com

將 API 端點設定為 cloud.ibm.com 並略過 SSL 驗證。

ibmcloud api https://cloud.ibm.com --skip-ssl-validation

檢視現行 API 端點：

ibmcloud api

移除 API 端點：

ibmcloud api --unset

ibmcloud config

將預設值寫入配置檔。

ibmcloud config --http-timeout TIMEOUT_IN_SECONDS | --trace (true|false|path/to/file) |
         --color (true|false) | --locale (LOCALE|CLEAR) | --check-version (true|false)

必要條件

無。

指令選項

--check-version
啟用或停用 CLI 版本檢查。 有效值為 true 或 false。
--color
啟用或停用彩色輸出。 依預設會停用這個選項。 有效值為 true 或 false。
--http-timeout
用於 HTTP 要求的逾時值（以秒為單位）。 預設值為 60 秒。
--locale
設定預設語言環境。 如果未指定任何值，則會刪除先前的語言環境。
--sso-otp
設定單一登入 (SSO) 一次性密碼 (OTP) 擷取的樣式。 預設值為 manual，需要使用者互動。 auto 設定會自動啟動預設瀏覽器，並接受標記。
--alpha-commands
按字母順序排序未分類的指令
--trace
追蹤對終端機或指定檔案的 HTTP 要求。 有效值為 true 或 false。

您一次只能指定其中一個選項。

範例

將 HTTP 請求超時設定為 30 秒：

ibmcloud config --http-timeout 30

啟用 HTTP 要求的追蹤輸出：

ibmcloud config --trace true

追蹤對 /home/usera/my_trace 檔案的 HTTP 要求：

ibmcloud config --trace /home/usera/my_trace

停用彩色輸出：

ibmcloud config --color false

將語言環境設定為 zh_Hans：

ibmcloud config --locale zh_Hans

清除語言環境設定：

ibmcloud config --locale CLEAR

啟用自動 SSO 一次性密碼接受功能：

ibmcloud config --sso-otp auto

啟用按字母順序排序未分類指令的功能

ibmcloud config --alpha-commands true

ibmcloud login

登入 IBM Cloud CLI：

ibmcloud login [-a API_ENDPOINT] [--sso] [-u USERNAME] [-p PASSWORD] [--apikey KEY | @KEY_FILE] [--cr-token (TOKEN | @CR_TOKEN_FILE) | --vpc-cri] [--profile PROFILE_ID | PROFILE_NAME | PROFILE_CRN] [-c (ACCOUNT_ID | ACCOUNT_OWNER_USER_ID) | --no-account] [--accept] [-g (RESOURCE_GROUP_NAME | RESOURCE_GROUP_ID)] [-r REGION | --no-region] [--vpc]

必要條件

無。

指令選項

-a API_ENDPOINT
API 端點。 例如，cloud.ibm.com。 或者，使用 private.cloud.ibm.com 透過私人端點登入。 使用此旗標可將 API 端點儲存到組態檔案中。
--sso
指定此選項，以使用聯合 ID 登入。 使用此選項，會提示您向單一登入提供者進行鑑別，並輸入一次性密碼進行登入。
-u 使用者名稱
使用者名稱。 選用。
-p password
使用者密碼。 選用。
--apikey API_KEY 或 @API_KEY_FILE_PATH
API 金鑰內容，或透過 @ 符號指出的 API 金鑰檔案的路徑
--cr-token TOKEN 或 @CR_TOKEN_FILE_PATH
計算資源標記內容或 @ 符號指示的計算資源標記檔案路徑。 如果提供，則必須同時提供或設定 --profile 標誌，或 IBMCLOUD_CR_PROFILE 環境變數。
--vpc-cri
以 VPC VSI 計算資源身分登入。 如需詳細資訊，請參閱 以虛擬伺服器 Instance 運算資源身分登入。
--profile PROFILE_ID、PROFILE_NAME 或 PROFILE_CRN
當您取得 IAM 存取標記時，會使用連結的可信 IAM 設定檔的名稱、ID 或 CRN。 如果提供，則必須同時提供或設定 --cr-token 標誌、IBMCLOUD_CR_TOKEN 環境變數或 --vpc-cri 標誌。 如果您以 VPC VSI 計算資源進行驗證，則只支援指定受信任的設定檔 CRN 或 ID。
-c ACCOUNT_ID
目標帳戶的 ID。 此選項與 --no-account 選項是排他的。
--no-account
強制以不使用帳戶的方式登入。 不建議使用這個選項，它與 -c 選項不能同時使用。
--accept
接受加入目標帳戶的邀請。 提供的帳戶必須是有效的帳戶 ID。
-g RESOURCE_GROUP
目標資源群組的名稱或 ID。 選用。
-r REGION
目標區域的名稱。 例如，us-south 或 eu-gb。
--no-region
強制以不將地區設為目標的方式登入。
--skip-ssl-validation
略過 HTTP 要求的 SSL 驗證。 不建議使用這個選項。
--vpc
為私有 API 端點使用 VPC 連線。 如需使用私有 API 端點的 VPC 連線登入的詳細資訊，請參閱 使用私有端點登入 CLI。 如需設定 VPC 連線以使用私有 API 端點的相關資訊，請參閱 設定私有端點閘道（VPC 使用時必須使用）。

範例

以互動方式登入：

ibmcloud login

登入私人端點：

ibmcloud login -a private.cloud.ibm.com

支援兩個區域：us-south 和 us-east。

使用 VPC 登入私人端點：

ibmcloud login -a private.cloud.ibm.com --vpc

使用使用者名稱和密碼登入，並設定目標帳戶：

ibmcloud login -u username -p password -c MyAccountID

使用聯合 ID 登入，並設定目標帳戶：

ibmcloud login --sso -c MyAccountID

使用具有相關聯帳戶的 API 金鑰：

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

使用沒有相關聯帳戶的 API 金鑰：

ibmcloud login --apikey api-key-string -c MyAccountID

ibmcloud login --apikey @fileName -c MyAccountID

如果 API 金鑰具有相關聯的帳戶，則不支援切換至另一個帳戶。

使用聯合 ID，以特定使用者身分登入：

ibmcloud login --sso

然後，CLI 會提供一個 URL 鏈結，並提示您輸入密碼：

Get One Time Code from https://identity-1.us-south.iam.cloud.ibm.com/identity/passcode to proceed.
Open the URL in the default browser? [Y/n] >

在瀏覽器中開啟鏈結以取得密碼。 在主控台輸入密碼以登入。

除了使用 CLI 提供的 URL 連結外，您也可以啟動 IBM Cloud 主控台並登入。 在 IBM Cloud 控制台中，到 Avatar圖示 Avatar 圖標 > 登入 CLI 和 API。 複製 IBM Cloud CLI 密碼指令並輸入。 使用此方法以您的 Google 帳戶登入 IBMid，或者如果您將您的雲端帳戶連接到 IBM Cloud App ID 範例。

以與受信任設定檔相連的 IBM Kubernetes Service Compute Resource 的身份登入：

ibmcloud login --cr-token token-string --profile trusted_profile_name_id_or_crn

ibmcloud login --cr-token @filename --profile trusted_profile_name_id_or_crn

IBMCLOUD_CR_TOKEN=@filename ibmcloud login --profile trusted_profile_name_id_or_crn

IBMCLOUD_CR_TOKEN=@filename IBMCLOUD_CR_PROFILE=trusted_profile_name_id_or_crn ibmcloud login

有關以 IBM Kubernetes Service 計算資源登入的詳細資訊，請參閱 使用計算資源代用幣登入。

使用在實體配置過程中連結的預設受信任設定檔，以 VPC VSI Compute Resource 的身份登入：

ibmcloud login --vpc-cri

以連結至指定受信任設定檔的 VPC VSI 運算資源登入：

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

如需更多關於以 VPC VSI 運算資源登入的資訊，請參閱 以虛擬伺服器 Instance 運算資源身分登入。

接受邀請加入新帳戶：

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

登出 CLI：

ibmcloud logout

必要條件

無。

ibmcloud regions

檢視 IBM Cloud 上所有地區的資訊：

ibmcloud regions

必要條件

使用 ibmcloud api 指令來設定 API 端點。

ibmcloud target

設定或檢視目標帳戶或區域：

ibmcloud target [-r REGION_NAME | --unset-region] [-c ACCOUNT_ID] [-g RESOURCE_GROUP | --unset-resource-group]

必要條件

  • 使用 ibmcloud api 指令來設定 API 端點。
  • 使用 ibmcloud login 指令來登入。 如果您使用聯合 ID 登入，請使用 --sso 選項以一次性密碼進行驗證，或使用 --apikey 選項以 API 金鑰進行驗證。

指令選項

-c ACCOUNT_ID
目標帳戶的 ID。 選用。
-r REGION
目標地區的名稱，例如 us-south 或 eu-gb。 選用。
-g RESOURCE_GROUP
目標資源群組的名稱。 選用。
--unset-region
清除已設定目標的地區。
--unset-resource-group
清除已設定目標的資源群組。

如果沒有指定任何選項，則會顯示目前的帳戶和區域。

範例

設定目前的帳戶：

ibmcloud target -c MyAccountID

切換至新的地區：

ibmcloud target -r eu-gb

查看當前帳戶和區域：

ibmcloud target

ibmcloud update

將 CLI 更新到最新版本：

ibmcloud update [-f]

必要條件

無。

指令選項

-f
強制執行更新，而不進行確認。 需要 root 專用權。

一般標準基礎架構服務指令

請在 IBM Cloud CLI 中使用標準基礎架構指令，以配置及管理基礎架構服務。

執行 ibmcloud sl 指令，以查看可用的指令清單：

USAGE:
   ibmcloud sl command [arguments...] [options...]

COMMANDS:
   block           Classic infrastructure Block Storage
   call-api        Call arbitrary API endpoints
   file            Classic infrastructure File Storage
   dns             Classic infrastructure Domain Name System
   globalip        Classic infrastructure Global IP addresses
   hardware        Classic infrastructure hardware servers
   image           Classic infrastructure Compute images
   ipsec           Classic infrastructure IPSEC VPN
   order           Classic infrastructure Orders
   placement-group Classic infrastructure Placement Group
   security        Classic infrastructure SSH Keys and SSL Certificates
   securitygroup   Classic infrastructure network security groups
   subnet          Classic infrastructure Network subnets
   ticket          Classic infrastructure Manage Tickets
   user            Classic infrastructure Manage Users
   vlan            Classic infrastructure Network VLANs
   vs              Classic infrastructure Virtual Servers
   help            Print command usage message

若要檢視指令的說明資訊，請執行下列指令：

ibmcloud sl [command] -h

如需各命令的詳細資訊，請參閱本文件中的相關參考主題。

自 CLI ibmcloud sl init 版開始，無法再使用 0.14 指令。 若要安裝最新 CLI 版本，請參閱安裝獨立式 IBM Cloud CLI。

ibmcloud sl help

檢視用來操作標準基礎架構環境之所有指令的說明資訊：

ibmcloud sl help