指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

若要為此 ACL 啟用的端點的名稱或 ID。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--name

ACL 的名稱。

-q

不要顯示日或更新提示的訊息。

--subnet

此 ACL 允許的 IP 或 CIDR 區塊。 該值必須完全包含於以下 CIDR 範圍內：10.0.0.0/8、161.26.0.0/16、166.8.0.0/14、172.16.0.0/12。

範例

建立存取控制清單 (ACL)

ibmcloud sat acl create --name NAME --subnet SUBNET --connector-id ID

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

若要為此 ACL 啟用的端點的名稱或 ID。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

將一個或多個已啟用的終端點新增至 ACL

ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT --connector-id ID

範例

顯示說明

ibmcloud sat acl endpoint help

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出某個存取控制清單 (ACL) 所有已啟用的端點

ibmcloud sat acl endpoint ls --acl-id ID --connector-id ID

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

若要為此 ACL 停用的端點的名稱或 ID。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

從存取控制清單 (ACL) 中移除一個或多個已啟用的端點

ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT --connector-id ID

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

檢視 ACL 的詳細資訊

ibmcloud sat acl get --acl-id ID --connector-id ID

範例

顯示說明

ibmcloud sat acl help

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出「Satellite」連接器或位置的所有存取控制清單 (ACL)

ibmcloud sat acl ls --connector-id ID

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

刪除 ACL

ibmcloud sat acl rm --acl-id ID --connector-id ID

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

--subnet

此 ACL 允許的 IP 或 CIDR 區塊。 該值必須完全包含於以下 CIDR 範圍內：10.0.0.0/8、161.26.0.0/16、166.8.0.0/14、172.16.0.0/12。

範例

將一個或多個子網新增至 ACL

ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET --connector-id ID

範例

顯示說明

ibmcloud sat acl subnet help

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

--subnet

此 ACL 允許的 IP 或 CIDR 區塊。 該值必須完全包含於以下 CIDR 範圍內：10.0.0.0/8、161.26.0.0/16、166.8.0.0/14、172.16.0.0/12。

範例

從 ACL 中移除一個或多個子網

ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET --connector-id ID

指令選項

--acl-id

指定ACL的ID。 若要列出所有 ACL，請執行 ibmcloud sat acl ls。

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--name

ACL 的新名稱。

-q

不要顯示日或更新提示的訊息。

範例

更新 ACL 的名稱

ibmcloud sat acl update --acl-id ID --name NAME --connector-id ID

指令選項

--platform

該平台為Satellite連接器代理程式。 欲了解更多信息Docker，請參閱文檔https://ibm.biz/satconagent可用選項：windows、docker

-q

不要顯示日或更新提示的訊息。

範例

取得適用於特定平台的 Satellite 連接器代理程式

ibmcloud sat agent attach --platform PLATFORM

範例

顯示說明

ibmcloud sat agent help

指令選項

--connector-id

Satellite 連接器的 ID。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出「Satellite」連接器的所有代理程式

ibmcloud sat agent ls --connector-id ID

指令選項

-c, --cluster

指定叢集名稱或 ID。 要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得已註冊叢集的詳細資訊

ibmcloud sat cluster get --cluster CLUSTER

範例

顯示說明

ibmcloud sat cluster help

指令選項

--filter

依叢集 ID 過濾已登錄的叢集。

--limit

限制所傳回的叢集數目。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您在 IBM Cloud 帳戶中所有已註冊的叢集

ibmcloud sat cluster ls

指令選項

--name

指定您要登錄的叢集名稱

-q

不要顯示日或更新提示的訊息。

--silent

無聲自動。 在輸出中只傳回登錄指令。

範例

取得一則 kubectl 指令，用以將您的叢集註冊至 Satellite 配置中

ibmcloud sat cluster register --name NAME

指令選項

-c, --cluster

指定叢集名稱或 ID。 要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

範例

移除叢集註冊

ibmcloud sat cluster unregister --cluster CLUSTER

指令選項

--data-location

指定 IBM 區域以儲存 Satellite 配置資料。 策略：直接上傳。

--name

提供 Satellite 配置的名稱。

--provider

指出 Satellite 配置的遠端 GitOps 提供者。 此提供者儲存 Kubernetes 資源定義。 策略：GitOps。 容許值 :github、gitlab

-q

不要顯示日或更新提示的訊息。

範例

建立一組設定，以指定您希望在 Satellite 工作負載中的叢集中部署哪些 Kubernetes 資源

ibmcloud sat config create --name NAME --data-location LOCATION

指令選項

--config

指定 Satellite 配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat config ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得「Satellite」設定的詳細資訊，例如與該設定相關聯的版本或訂閱

ibmcloud sat config get --config CONFIG

範例

顯示說明

ibmcloud sat config help

指令選項

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您在 IBM Cloud 帳戶中的所有「Satellite」設定

ibmcloud sat config ls

指令選項

--config

指定 Satellite 配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat config ls。

--name

提供 Satellite 配置的新名稱。

-q

不要顯示日或更新提示的訊息。

範例

重新命名一個「Satellite」設定檔

ibmcloud sat config rename --config CONFIG --name NAME

指令選項

--config

指定 Satellite 配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat config ls。

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

範例

移除 Satellite 的設定

ibmcloud sat config rm --config CONFIG

指令選項

--config

指定 Satellite 配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat config ls。

--description

新增 Satellite 配置版本的說明。

--file-format

指出配置版本的檔案格式。 可用的選項 :yaml

--name

提供 Satellite 配置版本的名稱。

-q

不要顯示日或更新提示的訊息。

--read-config

指定配置版本檔案的檔案路徑。

範例

建立一個配置版本，以更新您在 Satellite 工作負載中的現有 Kubernetes 資源

ibmcloud sat config version create \
  --config CONFIG \
  --file-format FORMAT \
  --name NAME \
  --read-config CONFIG

指令選項

--config

指定 Satellite 配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat config ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--save-config

下載配置版本並將其儲存至暫存檔中。

--version

指定 Satellite 配置版本的名稱或 ID。 若要在您的設定中列出版本，請執行 ibmcloud sat config get --config <configuration_name_or_ID>``。

範例

取得 Satellite 配置版本的詳細資訊

ibmcloud sat config version get --config CONFIG --version VERSION

範例

顯示說明

ibmcloud sat config version help

指令選項

--config

指定 Satellite 配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat config ls。

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

--version

指出 Satellite 配置版本的名稱或 ID。 若要列出版本，請執行 ibmcloud sat config get --config <configuration_name_or_ID>。

範例

移除 Satellite 的配置版本

ibmcloud sat config version rm --config CONFIG --version VERSION

指令選項

--name

Satellite 連接器的名稱。

-q

不要顯示日或更新提示的訊息。

--region

用來管理 Satellite 連接器的 IBM Cloud 區域。

範例

建立「Satellite」連接器

ibmcloud sat connector create --name NAME --region REGION

指令選項

--connector-id

Satellite 連接器的 ID。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

檢視「Satellite」連接器的詳細資訊

ibmcloud sat connector get --connector-id ID

範例

顯示說明

ibmcloud sat connector help

指令選項

--after

在指定游標後顯示 Satellite 連接器。

--first

檢視下一個 Satellite連接器，直到第一個連接器的數量。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

在您的 IBM Cloud 帳戶中檢視 Satellite 連接器

ibmcloud sat connector ls

指令選項

--connector-id

Satellite 連接器的 ID。

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

範例

刪除「Satellite」連接器

ibmcloud sat connector rm --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls``。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得端點的驗證設定

ibmcloud sat endpoint authn get --endpoint ENDPOINT --connector-id ID

範例

顯示說明

ibmcloud sat endpoint authn help

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--dest-ca-cert-file

用來驗證目的地伺服器憑證的授信 CA 憑證或鏈結。 例如 myCA.pem。

--dest-cert-file

用於向目標伺服器進行身份驗證的客戶端憑證。 例如 myCert.pem。

--dest-key-file

用來加密用戶端憑證的用戶端私密金鑰。 例如 myKey.pem。

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls``。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

--source-ca-cert-file

當 source-tls-mode 是相互時，用來驗證來源用戶端憑證的授信 CA 憑證或鏈結。 例如 myCA.pem。

--source-cert-file

要呈現給來源用戶端的伺服器憑證。 例如 myCert.pem。

--source-key-file

用來加密伺服器憑證的伺服器私密金鑰。 例如 myKey.pem。

範例

將現有的驗證憑證替換為新的憑證

ibmcloud sat endpoint authn rotate --endpoint ENDPOINT --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--dest-ca-cert-file

用來驗證目的地伺服器憑證的授信 CA 憑證或鏈結。 例如 myCA.pem。

--dest-cert-file

用於向目標伺服器進行身份驗證的客戶端憑證。 例如 myCert.pem。

--dest-key-file

用來加密用戶端憑證的用戶端私密金鑰。 例如 myKey.pem。

--dest-tls-mode

目的地 TLS 模式。 接受的值：simple,mutual,none

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls``。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

--source-ca-cert-file

當 source-tls-mode 是相互時，用來驗證來源用戶端憑證的授信 CA 憑證或鏈結。 例如 myCA.pem。

--source-cert-file

要呈現給來源用戶端的伺服器憑證。 例如 myCert.pem。

--source-key-file

用來加密伺服器憑證的伺服器私密金鑰。 例如 myKey.pem。

--source-tls-mode

來源：TLS 模式。 接受值: simple、mutual

範例

為端點設定驗證設定

ibmcloud sat endpoint authn set --endpoint ENDPOINT --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--dest-hostname

指出您要連接之目的地的完整網域名稱 (FQDN) 或外部可存取 IP 位址。 對於 cloud 端點，此值必須解析為公網 IP 位址，或可透過 IBM Cloud 存取的私有 IP 位址（例如私有雲服務端點）。 對於 location 端點，此值必須可從控制平面主機解析，且從控制平面主機可存取該端點；若為 Satellite 位置，則需從控制平面主機可存取該端點；若為 Satellite 連接器，則需從代理程式運行位置可存取該端點。

--dest-port

提供目的地資源接聽送入要求的埠。 請確定埠與目的地通訊協定相符。

--dest-protocol

指定目的地的通訊協定。 如果未指定此選項，則會從來源通訊協定繼承目的地通訊協定。 接受值: TCP、TLS

--dest-type

請指定目標資源的執行位置，可選擇位於 IBM Cloud （cloud ）或您的 Satellite 位置（location ）。可用選項：location、cloud

--idle-timeout-seconds

指定目的地作用中連線的逾時間隔 (以秒為單位)。 請確定您的逾時與目的地服務及通訊協定 keep-alive 設定相容。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--name

提供端點的名稱。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--sni

若您指定了 tls 或 https 來源協定，且希望在 TLS 握手過程中加入獨立的主機名稱，請指定伺服器名稱指標。

--source-protocol

提供來源用來連接目的地資源的通訊協定。 參見 http://ibm.biz/endpoint-protocols。 可用選項：TCP、TLS、HTTP、HTTPS、HTTP-tunnel

範例

建立端點

ibmcloud sat endpoint create \
  --dest-hostname HOSTNAME \
  --dest-port PORT \
  --dest-type TYPE \
  --name NAME \
  --source-protocol PROTOCOL \
  --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``。

-f

強制執行指令，而不出現使用者提示。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

停用一個端點

ibmcloud sat endpoint disable --endpoint ENDPOINT --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``。

-f

強制執行指令，而不出現使用者提示。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

啟用一個端點

ibmcloud sat endpoint enable --endpoint ENDPOINT --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

檢視端點的詳細資訊

ibmcloud sat endpoint get --endpoint ENDPOINT --connector-id ID

範例

顯示說明

ibmcloud sat endpoint help

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出 Satellite 位置中的所有端點

ibmcloud sat endpoint ls --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

刪除一個終點

ibmcloud sat endpoint rm --endpoint ENDPOINT --connector-id ID

指令選項

--connector-id

Satellite 連接器的 ID。 若要尋找連接器 ID，請執行 ibmcloud sat connector ls。

--dest-hostname

指出您要連接之目的地的完整網域名稱 (FQDN) 或外部可存取 IP 位址。 對於 cloud 端點，此值必須解析為公網 IP 位址，或可透過 IBM Cloud 存取的私有 IP 位址（例如私有雲服務端點）。 對於 location 端點，此值必須可從控制平面主機解析，且從控制平面主機可存取該端點；若為 Satellite 位置，則需從控制平面主機可存取該端點；若為 Satellite 連接器，則需從代理程式運行位置可存取該端點。

--dest-port

提供目的地資源接聽送入要求的埠。 請確定埠與目的地通訊協定相符。

--dest-protocol

指定目的地的通訊協定。 如果未指定此選項，則會從來源通訊協定繼承目的地通訊協定。 接受值: TCP、TLS

--endpoint

指定端點的名稱或 ID。 若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``。

--idle-timeout-seconds

指定目的地作用中連線的逾時間隔 (以秒為單位)。 請確定您的逾時與目的地服務及通訊協定 keep-alive 設定相容。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--name

提供端點的新名稱。

-q

不要顯示日或更新提示的訊息。

--sni

若您指定了 tls 或 https 來源協定，且希望在 TLS 握手過程中加入獨立的主機名稱，請指定伺服器名稱指標。

--source-protocol

提供來源用來連接目的地資源的通訊協定。 參見 http://ibm.biz/endpoint-protocols。 有效值：TCP、TLS、HTTP、HTTPS、HTTP-tunnel

範例

更新端點

ibmcloud sat endpoint update --endpoint ENDPOINT --connector-id ID

範例

顯示說明

ibmcloud sat experimental endpoint help

範例

顯示說明

ibmcloud sat experimental help

指令選項

-c, --cluster

請指定叢集名稱或 ID。 要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。

-g, --group

指定 Satellite 叢集群組的名稱或 ID。 若要列出可用的叢集群組，請執行 ibmcloud sat group ls。

-q

不要顯示日或更新提示的訊息。

範例

將叢集新增至您的叢集群組

ibmcloud sat group attach --cluster CLUSTER --group GROUP

指令選項

-c, --cluster

指定要新增至叢集群組的叢集名稱或 ID。 要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。

--name

提供 Satellite 叢集群組的名稱。

-q

不要顯示日或更新提示的訊息。

範例

建立叢集群組

ibmcloud sat group create --name NAME

指令選項

-c, --cluster

請指定叢集名稱或 ID。 若要列出您所屬叢集群組中的叢集，請執行 ibmcloud sat group get --group <cluster_group_name_or_ID>。

-f

強制執行指令，而不出現使用者提示。

-g, --group

指定 Satellite 叢集群組的名稱或 ID。 若要列出可用的叢集群組，請執行 ibmcloud sat group ls。

-q

不要顯示日或更新提示的訊息。

範例

從您的 Satellite 叢集群組中移除一個或多個叢集，並刪除由該群組的訂閱所管理的 Kubernetes 資源

ibmcloud sat group detach --cluster CLUSTER --group GROUP

指令選項

-g, --group

指定 Satellite 叢集群組的名稱或 ID。 要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得 Satellite 叢集群組的詳細資訊

ibmcloud sat group get --group GROUP

範例

顯示說明

ibmcloud sat group help

指令選項

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您在 IBM Cloud 帳戶中的所有 Satellite 叢集群組

ibmcloud sat group ls

指令選項

-f

強制執行指令，而不出現使用者提示。

-g, --group

指定 Satellite 叢集群組的名稱或 ID。 若要列出可用的叢集群組，請執行 ibmcloud sat group ls。

-q

不要顯示日或更新提示的訊息。

範例

移除一個「Satellite」叢集群組，此操作會讓叢集取消訂閱，並刪除由該群組訂閱所管理的 Kubernetes 資源

ibmcloud sat group rm --group GROUP

指令選項

--cluster

要指派主機之叢集的名稱或 ID。 若要列出可用的叢集，請執行 ibmcloud sat cluster ls``。 如果沒有提供叢集，則主機會自動指派給 Satellite 控制平面。

--host

要指派的主機名稱或 ID。 若要根據標籤自動指派主機，請不要包含此選項。 要取得主機識別碼，請執行 ibmcloud sat host ls --location <location_ID_or_name>。

--host-label, --hl

請以鍵值對的形式輸入任何標籤，用以識別要指派給您的 Satellite 控制平面或 Red Hat OpenShift 叢集的主機。 第一個具有此標籤且未經指派的主機將會自動指派給控制平面或叢集。 若要查詢可用的主機標籤，請執行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-p, --worker-pool

叢集中要指派主機的目標工作者儲存區名稱或 ID。 如果未指定任何工作者儲存區，則會將主機指派給預設工作者儲存區。

-q

不要顯示日或更新提示的訊息。

--zone

要指派主機的目標區域名稱或 ID。 若要查找可用的區域，請執行 ibmcloud sat location get --location <location_name_or_ID> ，並查看 Host Zones 欄位。

範例

將主機指派至 Satellite 位置控制平面或叢集

ibmcloud sat host assign --location LOCATION

指令選項

--host-label, --hl

請以鍵值對的形式輸入任何標籤，用以識別要指派給您的 Satellite 控制平面或 Red Hat OpenShift 叢集的主機。 第一個具有此標籤且未經指派的主機將會自動指派給控制平面或叢集。 若要查詢可用的主機標籤，請執行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。

--host-link-agent-endpoint

鏈結代理程式用來連接鏈結通道伺服器的端點。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--operating-system

要連接至位置之主機的作業系統。 若要連接 RHCOS 主機，您的位置必須已啟用 RHCOS。 接受值: RHEL、RHCOS

-q

不要顯示日或更新提示的訊息。

--reset-key

重設控制平面用來連接及指派位置中主機的按鍵。 請參閱 https://ibm.biz/reset-key。

範例

建立並下載一個腳本，您可以在您的主機上執行該腳本，將其連結至您的位置

ibmcloud sat host attach --location LOCATION

指令選項

--host

Satellite 主機 ID。 要查詢主機 ID，請執行 ibmcloud sat host ls <location_ID_or_name>。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

檢視 Satellite 主機的詳細資訊

ibmcloud sat host get --host HOST --location LOCATION

範例

顯示說明

ibmcloud sat host help

指令選項

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出所有連接到 Satellite 位置的主機，包括已指派至叢集或控制平面中的主機

ibmcloud sat host ls --location LOCATION

指令選項

-f

強制執行指令，而不出現使用者提示。

--host

要移除的主機的名稱或 ID。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

從「Satellite」位置中移除主機

ibmcloud sat host rm --host HOST --location LOCATION

指令選項

--host

要指派的主機名稱或 ID。 若要根據標籤自動指派主機，請不要包含此選項。

--host-label, --hl

請以鍵值對的形式輸入任何標籤，用以識別要指派給您的 Satellite 控制平面或 Red Hat OpenShift 叢集的主機。 第一個具有此標籤且未經指派的主機將會自動指派給控制平面或叢集。 若要查詢可用的主機標籤，請執行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

--zone

要與主機關聯的區域名稱或 ID。 您無法變更指派給資源（例如：叢集）的主機區域。 您必須先取消指派它們。 要列出可用的區域，請執行 ibmcloud sat location get --location <ID>。

範例

更新主機資訊，例如區域和標籤

ibmcloud sat host update --host HOST --location LOCATION

範例

顯示說明

ibmcloud sat key help

指令選項

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您在 IBM Cloud 帳戶中的所有「Satellite」設定金鑰

ibmcloud sat key ls

指令選項

-f

強制執行指令，而不出現使用者提示。

--key

Satellite 配置金鑰的名稱或 ID。

-q

不要顯示日或更新提示的訊息。

範例

移除 Satellite 的設定金鑰

ibmcloud sat key rm --key KEY

指令選項

-f

強制執行指令，而不出現使用者提示。

--name

新 Satellite 配置金鑰的名稱。

-q

不要顯示日或更新提示的訊息。

範例

產生一個新金鑰，供受管叢集用於連線至 Satellite Config

ibmcloud sat key rotate --name NAME

指令選項

--capability

Satellite定位的能力。

--coreos-enabled

針對 Satellite 位置啟用 Red Hat CoreOS 特性。 這個動作無法復原。 請參閱 https://ibm.biz/infra-os。

--cos-bucket

指定 IBM Cloud Object Storage 儲存區的名稱，以儲存 Satellite 位置控制平面資料。 否則，會為您建立新的儲存區。

--description

輸入 Satellite 位置的說明。

--ha-zone

指定位置的區域。 為了確保高可用性，請為您的位置指定 3 個區域，例如：--ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME。 區域名稱必須與您計劃在其中建立主機之基礎架構提供者中對應區域的名稱完全相符。

--managed-from

選取要從中管理 Satellite 位置的 IBM Cloud 區域。 請選擇靠近內部部署資料中心的區域以提升效能。 參見 https://ibm.biz/sat-region。

--name

指定 Satellite 位置的名稱。 地點名稱必須以字母開頭，可包含字母、數字、句點 (.) 及連字號 (-)，且長度不得超過 36 個字元。 即使刪除其他位置，也不要重複使用名稱。

--physical-address

Satellite位置的實體位址。

--pod-network-interface-selection

選取內部 Pod 網路的節點網路介面的方法。 此選項僅在您同時啟用 Red Hat CoreOS 並設定 --coreos-enabled 選項時，方可使用。 若要直接提供 URL 或 IP 位址，請指定 can-reach=<url> 或 can-reach=<ip_address>。 若要選擇網路介面，請指定 interface=<network_interface>。

--pod-subnet

指定自訂子網路 CIDR 為 POD 提供專用 IP 位址。 此選項僅在您啟用 Red Hat CoreOS 並搭配 --coreos-enabled 選項時才會生效。 子網必須為 /23 或更大。 請參閱 https://ibm.biz/sat-location-create。 預設值：' 172.16.0.0/16

--provider

指出要用於 Satellite 位置的基礎架構提供者。 若要啟用此選項，則必須同時啟用「--provider-credential」選項。 接受值: aws、azure、gcp、vmware

--provider-credential

指定本端機器上 JSON 檔案的路徑，該檔案具有 Satellite 位置的基礎架構提供者認證。 認證格式特定於提供者。 請參閱 http://ibm.biz/sat-infra-creds。

--provider-region

在基礎架構提供者中，指定您計劃為 Satellite 位置建立主機的地區。 若要啟用此選項，則必須同時啟用「--provider」選項。

-q

不要顯示日或更新提示的訊息。

--service-subnet

指定自訂子網路 CIDR 為服務提供專用 IP 位址。 此選項僅在您啟用 Red Hat CoreOS 並搭配 --coreos-enabled 選項時才會生效。 子網必須為 /24 或更大。 請參閱 https://ibm.biz/sat-location-create。 預設值： 172.20.0.0/16

範例

建立衛星位置

ibmcloud sat location create --managed-from REGION --name NAME

指令選項

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--subdomain

指定子網域名稱。 若要列出現有的子網域，請執行 ibmcloud sat location dns ls --location <ID>。

範例

檢視位於 Satellite 下的已註冊子網域詳細資訊

ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN

範例

顯示說明

ibmcloud sat location dns help

指令選項

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出位於 Satellite 下的已註冊子網域

ibmcloud sat location dns ls --location LOCATION

指令選項

--ip

請為每個控制平面主機指定 IP 位址，格式為 --ip x.x.x.1 --ip x.x.x.2 --ip x.x.x.3。 對於多區域叢集，每個區域中使用一個 IP 位址。 要找出 IP 位址，請執行 ibmcloud sat host ls --location <location_ID_or_name> ，並在標示為 infrastructure`` 的主機中尋找 Worker IP 。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

在 Satellite 位置中，為指派給控制平面（control plane）的主機設定子網域

ibmcloud sat location dns register --ip IP --location LOCATION

指令選項

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

查看 Satellite 分店的詳細資訊

ibmcloud sat location get --location LOCATION

範例

顯示說明

ibmcloud sat location help

指令選項

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

在您的 IBM Cloud 帳戶中列出所有「Satellite」據點

ibmcloud sat location ls

指令選項

-f

強制執行指令，而不出現使用者提示。

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

-q

不要顯示日或更新提示的訊息。

範例

刪除地點

ibmcloud sat location rm --location LOCATION

指令選項

--description

請為「Satellite」地點輸入新的描述。 說明的長度限制為 400 位元組。

--location-id

Satellite 位置的 ID。 要找出位置識別碼，請執行 ibmcloud sat location ls。

--name

請為「Satellite」位置指定一個新名稱。 地點名稱必須以字母開頭，可包含字母、數字、句點 (.) 及連字號 (-)，且長度不得超過 36 個字元。 請勿重複使用名稱，包括已刪除位置的名稱。

-q

不要顯示日或更新提示的訊息。

範例

更新「Satellite」地點的名稱或描述

ibmcloud sat location update --location-id ID

指令選項

-q

不要顯示日或更新提示的訊息。

範例

檢視當前使用者的訊息

ibmcloud sat messages

指令選項

--history

資源的歷程 ID。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--resource

指定 Kubernetes 資源 ID。 若要查找 Kubernetes 的相關資源，請執行 ibmcloud sat resource ls。

--save-data

下載 Kubernetes 資源定義並將其儲存到暫存檔中。

範例

檢視由 Satellite 配置所管理的 Kubernetes 資源的詳細資訊

ibmcloud sat resource get --resource RESOURCE

範例

顯示說明

ibmcloud sat resource help

指令選項

--limit

指定要傳回的歷程項目數上限。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--resource

Kubernetes 資源 ID。

範例

取得 Kubernetes 資源的歷史紀錄

ibmcloud sat resource history get --resource RESOURCE

範例

顯示說明

ibmcloud sat resource history help

指令選項

-c, --cluster

指定 Kubernetes 資源執行所在之已登錄叢集的名稱或 ID。 若要查找已註冊的叢集，請執行 ibmcloud sat cluster ls。

--limit

指定搜尋要傳回的資源項目數上限。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--search

指出字串以過濾 Kubernetes 資源的搜尋結果，例如：Pod 或名稱空間名稱。

--subscription

指定 Satellite 訂閱 ID 或名稱。 若要查找訂閱項目，請執行 ibmcloud sat cluster ls。

範例

搜尋由 Kubernetes 管理的資源 Satellite

ibmcloud sat resource ls --cluster CLUSTER

範例

顯示說明

ibmcloud sat service help

指令選項

--location

Satellite 位置的名稱或 ID。 若要查詢位置 ID 或名稱，請執行指令 ibmcloud sat location ls``。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您所在位置的所有 Satellite 服務叢集，以便檢視相關詳細資訊，例如請求的主機資源

ibmcloud sat service ls --location LOCATION

指令選項

--all

停用儲存體配置之所有 Satellite 儲存體指派的自動修補程式。

--assignment

Satellite 儲存體指派的 ID。 若要列出配置的可用儲存體指派，請執行 ibmcloud sat storage assignment ls --config CONFIG。

--config

Satellite 儲存體配置的名稱或 ID。 若要列出可用的儲存配置，請執行 ibmcloud sat storage config ls。

-q

不要顯示日或更新提示的訊息。

範例

停用「Satellite」儲存分配的自動修補程式

ibmcloud sat storage assignment autopatch disable --config CONFIG --all

指令選項

--all

針對儲存體配置的所有 Satellite 儲存體指派啟用自動修補程式。

--assignment

Satellite 儲存體指派的 ID。 若要列出配置的可用儲存體指派，請執行 ibmcloud sat storage assignment ls --config CONFIG。

--config

Satellite 儲存體配置的名稱或 ID。 若要列出可用的儲存配置，請執行 ibmcloud sat storage config ls。

-q

不要顯示日或更新提示的訊息。

範例

為 Satellite 儲存區指派啟用自動修補程式

ibmcloud sat storage assignment autopatch enable --config CONFIG --all

範例

顯示說明

ibmcloud sat storage assignment autopatch help

指令選項

-c, --cluster

指定要指派的 Satellite 叢集 ID。 要查詢叢集 ID，請執行 ibmcloud oc cluster ls --provider satellite。

--config

指定指派的 Satellite 儲存體配置。若要尋找配置，請執行 ibmcloud sat storage config ls。

-g, --group

指定用於指派的叢集群組。 若要找出叢集群組，請執行 ibmcloud sat group ls。

--name

提供 Satellite 儲存體指派的名稱。

-q

不要顯示日或更新提示的訊息。

--service-cluster-id

指定指派的服務叢集 ID。 若要找出服務叢集 ID，請執行 ibmcloud sat service ls --location <location>。

範例

建立一項指派，將您的儲存配置部署至您位於 Satellite 位置的叢集

ibmcloud sat storage assignment create --config CONFIG --cluster CLUSTER

指令選項

--assignment

指定 Satellite 儲存體指派的 ID。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得 Satellite 儲存指派項目的詳細資訊

ibmcloud sat storage assignment get --assignment ASSIGNMENT

範例

顯示說明

ibmcloud sat storage assignment help

指令選項

-c, --cluster

指定指派的 Satellite 叢集 ID。 要取得叢集 ID，請執行 ibmcloud oc cluster ls --provider satellite。

--config

指定 Satellite 儲存體配置的名稱或 ID。 若要列出可用的儲存配置，請執行 ibmcloud sat storage config ls。

--location

指定 Satellite 位置的名稱。 若要列出可用的位置，請執行 ibmcloud sat location ls。 服務管理者無法使用此選項。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--service-cluster-id

指定指派的服務叢集 ID。 若要找出服務叢集 ID，請執行 ibmcloud sat service ls --location <location>。

範例

列出您在 IBM Cloud 帳戶中的 Satellite 儲存空間分配

ibmcloud sat storage assignment ls --cluster CLUSTER

指令選項

--assignment

指定 Satellite 儲存體指派的 ID。 要列出可用的任務，請執行 ibmcloud sat storage assignment ls。

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

範例

將儲存配置變更套用至相關的指派

ibmcloud sat storage assignment patch --assignment ASSIGNMENT

指令選項

--assignment

指定 Satellite 儲存體指派的 ID。 若要查找作業，請執行 ibmcloud sat storage assignment ls。

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

範例

移除 Satellite 儲存空間的指派

ibmcloud sat storage assignment rm --assignment ASSIGNMENT

指令選項

--assignment

指定 Satellite 儲存體指派的 ID。

-f

強制執行指令，而不出現使用者提示。

-g, --group

指定要指派的新叢集群組。 要列出可用的群組，請執行 ibmcloud sat group ls。

--name

提供 Satellite 儲存體指派的新名稱。

-q

不要顯示日或更新提示的訊息。

範例

更新 Satellite 儲存空間的指派

ibmcloud sat storage assignment update --assignment ASSIGNMENT

指令選項

--config-name

指定自訂儲存類別的儲存體配置名稱。 若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。

--name

提供自訂儲存類別的名稱。

-p, --param

請為儲存類別參數指定一組 key=value。 若要查看儲存範本中的儲存類別參數，請執行 ibmcloud sat storage template get。

-q

不要顯示日或更新提示的訊息。

範例

建立自訂的 Satellite 儲存類別

ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM

指令選項

--class

指定 Satellite 儲存類別的名稱。

--config

指定 Satellite 儲存體配置的名稱或 ID。 若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得 Satellite 儲存類別的詳細資訊

ibmcloud sat storage config class get --class CLASS --config CONFIG

範例

顯示說明

ibmcloud sat storage config class help

指令選項

--config

指定 Satellite 儲存體配置的名稱或 ID。 若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--show-params

包括此選項可列出所有儲存類別參數詳細資料。

範例

列出 Satellite 儲存體配置中的儲存類別。

ibmcloud sat storage config class ls --config CONFIG

指令選項

--location

輸入儲存體配置的位置 ID 或名稱。 若要查詢可用的地點，請執行 ibmcloud sat location ls。

--name

指定儲存體配置的名稱。

-p, --param

請為設定參數指定一組 key=value。 若要檢視儲存範本中的設定參數，請執行 ibmcloud sat storage template get。

-q

不要顯示日或更新提示的訊息。

--template-name

指定 Satellite 儲存體配置範本名稱。 若要列出可用的儲存配置範本，請執行 ibmcloud sat storage template ls。

--template-version

指定 Satellite 儲存體配置範本版本。 如果您不包含此選項，則會使用預設版本。 若要列出可用的儲存配置範本，請執行 ibmcloud sat storage template ls。

範例

建立一個「Satellite」儲存配置，以便在您的叢集中安裝儲存驅動程式

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME

指令選項

--config

指定 Satellite 儲存體配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat storage config ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

取得 Satellite 儲存配置的詳細資訊

ibmcloud sat storage config get --config CONFIG

範例

顯示說明

ibmcloud sat storage config help

指令選項

--location

指定包含您要列出之配置的位置 ID 或名稱。 若要查詢可用的地點，請執行 ibmcloud sat location ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您在 IBM Cloud 帳戶中的 Satellite 儲存空間配置

ibmcloud sat storage config ls

範例

顯示說明

ibmcloud sat storage config param help

指令選項

--apply

將最新的 Satellite 儲存體配置版本套用至配置的所有指派。 若要列出某個設定的指派項目，請執行 ibmcloud sat storage assignment ls --config CONFIG。

--config

指定儲存體配置的名稱或 ID。 若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。

-f

強制執行指令，而不出現使用者提示。

-p, --param

請為設定參數指定一組 key=value。 若要檢視儲存範本中的設定參數，請執行 ibmcloud sat storage template get。

-q

不要顯示日或更新提示的訊息。

範例

設定 Satellite 儲存配置的配置與機密參數

ibmcloud sat storage config param set --config CONFIG --param PARAM

指令選項

--config

指定 Satellite 儲存體配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat storage config ls。

-f

強制執行指令，而不出現使用者提示。

--include-assignments

若要將儲存配置的指派更新至最新配置版本，請勾選此選項。

-q

不要顯示日或更新提示的訊息。

範例

將最新的修補程式更新套用至 Satellite 儲存配置

ibmcloud sat storage config patch --config CONFIG

指令選項

--config

指定 Satellite 儲存體配置的名稱或 ID。 若要列出可用的設定，請執行 ibmcloud sat storage config ls。

-f

強制執行指令，而不出現使用者提示。

--include-assignments

包括此選項可移除儲存體配置以及任何相關聯的指派。

-q

不要顯示日或更新提示的訊息。

範例

移除 Satellite 儲存配置

ibmcloud sat storage config rm --config CONFIG

範例

顯示說明

ibmcloud sat storage help

指令選項

--name

指定儲存體範本名稱。 若要列出可用的儲存範本，請執行 ibmcloud sat storage template ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--version

指定儲存體範本版本。 若要列出可用的儲存範本，請執行 ibmcloud sat storage template ls。

範例

取得 Satellite 儲存體範本的詳細資料

ibmcloud sat storage template get --name NAME --version VERSION

範例

顯示說明

ibmcloud sat storage template help

指令選項

-q

不要顯示日或更新提示的訊息。

範例

列出可用的 Satellite 儲存範本

ibmcloud sat storage template ls

指令選項

--auth-required

提供連接遠端儲存庫所需的鑑別密碼。 如需詳細資料，請參閱 https://ibm.biz/sat-config-private-repo。 策略：GitOps。

--config

指定要用於訂閱的配置名稱。 若要查看可用的設定，請執行 ibmcloud sat config ls。

-g, --group

指定叢集群組的名稱或 ID，以訂閱您的配置。 若要查詢可用的叢集群組，請執行 ibmcloud sat group ls。

--gitref

指定要用於 Satellite 訂閱的 GitRef。 策略：GitOps。

--gitref-type

指出要用於 Satellite 訂閱的 GitRef 類型。 策略：GitOps。 容許值 :branch、commit、tag、release

--name

輸入訂閱的名稱。

--path

提供遠端儲存庫中儲存庫檔案或發行資產的路徑，以用於 Satellite 訂閱。 策略：GitOps。

-q

不要顯示日或更新提示的訊息。

--repository

指定要用於訂閱的遠端儲存庫 URL。 策略：GitOps。

--version

指出要用於訂閱之現有配置版本的名稱或 ID。 若要查詢版本，請執行 ibmcloud sat config get --config <configuration_name_or_ID>。 策略：直接上傳。

範例

為叢集建立 Satellite 訂閱

ibmcloud sat subscription create \
  --config CONFIG \
  --group GROUP \
  --name NAME \
  --auth-required \
  --gitref GITREF \
  --gitref-type TYPE \
  --path PATH \
  --repository REPOSITORY

指令選項

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

--subscription

請輸入「Satellite」訂閱的名稱或 ID。 若要查找訂閱項目，請執行 ibmcloud sat subscription ls。

範例

取得關於「Satellite」訂閱服務的詳細資訊

ibmcloud sat subscription get --subscription SUBSCRIPTION

範例

顯示說明

ibmcloud sat subscription help

範例

顯示說明

ibmcloud sat subscription identity help

指令選項

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

--subscription

指定 Satellite 訂閱的名稱或 ID。 要列出訂閱項目，請執行 ibmcloud sat subscription ls``。

範例

更新 Satellite 訂閱，以便使用您的身分來管理資源

ibmcloud sat subscription identity set --subscription SUBSCRIPTION

指令選項

-c, --cluster

指定 Satellite 叢集名稱或 ID。 若要查找已註冊的叢集，請執行 ibmcloud sat cluster ls。

--output

以提供的格式列印指令輸出。 接受值: json

-q

不要顯示日或更新提示的訊息。

範例

列出您在 IBM Cloud 帳戶中的所有「Satellite」訂閱

ibmcloud sat subscription ls

指令選項

-f

強制執行指令，而不出現使用者提示。

-q

不要顯示日或更新提示的訊息。

--subscription

提供 Satellite 訂閱的名稱或 ID。 要列出訂閱項目，請執行 ibmcloud sat subscription ls``。

範例

取消「Satellite」訂閱

ibmcloud sat subscription rm --subscription SUBSCRIPTION

指令選項

--auth-required

提供連接遠端儲存庫所需的鑑別密碼。 策略：GitOps。

-f

強制執行指令，而不出現使用者提示。

-g, --group

指定新的叢集群組以訂閱您的配置。

--gitref

指定要用於 Satellite 訂閱的 GitRef。 策略：GitOps。

--gitref-type

指出要用於此 Satellite 訂閱的 GitRef 類型。 策略：GitOps。 容許值 :branch、commit、tag、release

--name

提供 Satellite 訂閱的新名稱。

--path

指出遠端儲存庫中要用於 Satellite 訂閱的儲存庫檔案或發行資產的路徑。 策略：GitOps。

-q

不要顯示日或更新提示的訊息。

--repository

提供要用於 Satellite 訂閱的遠端儲存庫 URL。 策略：GitOps。

--subscription

指定 Satellite 訂閱的名稱或 ID。 要列出訂閱項目，請執行 ibmcloud sat subscription ls``。

--version

指出用於 Satellite 訂閱的現有配置版本。 策略：直接上傳。

範例

更新 Satellite 訂閱

ibmcloud sat subscription update \
  --subscription SUBSCRIPTION \
  --auth-required \
  --gitref GITREF \
  --gitref-type TYPE \
  --path PATH \
  --repository REPOSITORY