Satellite 指令的 CLI 參考手冊

若要自動化建立與管理您的 Satellite 位置（包括位置、主機、叢集及端點的操作），請參閱這些 Satellite CLI 指令。

若要安裝 CLI，請參閱安裝 CLI。若要檢視所有 IBM Cloud Satellite 指令的高階地圖，請參閱 CLI 地圖。

必要條件

安裝 IBM Cloud CLI。
請執行以下指令，安裝 ks 外掛程式：
```
ibmcloud plugin install ks
```

ibmcloud sat 指令

下表列出 ibmcloud sat 指令群組。如需 CLI 中所有 ibmcloud sat 指令的完整清單，請參閱 CLI 對映。

ibmcloud sat CLI 指令群組
指揮組	說明
`ibmcloud sat connector`	建立、檢視及修改 Satellite 連接器。
`ibmcloud sat location`	建立、檢視和修改 Satellite 位置。
`ibmcloud sat endpoint`	檢視並管理 Satellite 端點。
`ibmcloud sat acl`	檢視及管理 Satellite 的存取控制清單（ACL）。
`ibmcloud sat agent`	附加或檢視「Satellite」連接器代理程式。
`ibmcloud sat host`	檢視及修改 Satellite 主機。
`ibmcloud sat cluster`	登錄及管理叢集，以與 Satellite 配置搭配使用。
`ibmcloud sat messages`	檢視現行使用者訊息。
`ibmcloud sat group`	檢視並管理 Satellite 叢集群組。叢集群組用於讓叢集訂閱 Kubernetes 資源的 Satellite 配置。
`ibmcloud sat key`	檢視及管理 Satellite 配置金鑰。
`ibmcloud sat config`	檢視並管理 Satellite 配置。
`ibmcloud sat resource`	搜尋並檢視 Satellite 配置所管理的 Kubernetes 資源。
`ibmcloud sat service`	檢視 Satellite 服務叢集。
`ibmcloud sat storage`	檢視並管理 Satellite 儲存體資源。
`ibmcloud sat subscription`	檢視並管理 Satellite 訂閱以在叢集中部署 Kubernetes 配置檔。

IBM Cloud SAT ACL 指令

檢視及管理 Satellite 的存取控制清單（ACL）。

`ibmcloud sat acl create`

建立 ACL。

ibmcloud sat acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 若要為此 ACL 啟用的端點的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--name NAME: ACL 的名稱。
-q: 不要顯示日或更新提示的訊息。
--subnet 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 --location LOCATION --connector-id CONNECTOR_ID --name NAME

`ibmcloud sat acl endpoint add`

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

ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 若要為此 ACL 啟用的端點的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat acl endpoint add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat acl endpoint ls`

列出 ACL 的所有啟用的端點。

ibmcloud sat acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 ACL 的所有啟用的端點。

ibmcloud sat acl endpoint ls \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat acl endpoint rm`

從 ACL 中刪除一個或多個已啟用的端點。

ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 若要為此 ACL 停用的端點的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

從 ACL 中刪除一個或多個已啟用的端點。

ibmcloud sat acl endpoint rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat acl get`

檢視 ACL 的詳細資訊。

ibmcloud sat acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視 ACL 的詳細資訊。

ibmcloud sat acl get --location LOCATION --connector-id CONNECTOR_ID --acl-id ACL_ID

`ibmcloud sat acl ls`

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

ibmcloud sat acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat acl ls --location LOCATION --connector-id CONNECTOR_ID --output json

`ibmcloud sat acl rm`

刪除ACL。

ibmcloud sat acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

刪除ACL。

ibmcloud sat acl rm --location LOCATION --connector-id CONNECTOR_ID --acl-id ACL_ID

`ibmcloud sat acl subnet add`

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

ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--subnet 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 \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat acl subnet rm`

從 ACL 中刪除一個或多個子網路。

ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--subnet 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 \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat acl update`

更新ACL的名稱。

ibmcloud sat acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--name NAME: ACL 的新名稱。
-q: 不要顯示日或更新提示的訊息。

範例

更新ACL的名稱。

ibmcloud sat acl update \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

ibmcloud SAT 代理程式指令

附加或檢視「Satellite」連接器代理程式。

`ibmcloud sat agent attach`

取得適用於特定平台的 Satellite 連接器代理程式。下載適用於 Windows 的 Agent .zip，或取得適用於 Docker 環境的文件連結。

ibmcloud sat agent attach --platform PLATFORM [-q]

指令選項

--platform PLATFORM: 該平台為Satellite連接器代理程式。欲了解更多信息Docker，請參閱文檔https://ibm.biz/satconagent可用選項：windows、docker
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat agent attach --platform PLATFORM -q

`ibmcloud sat agent ls`

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

ibmcloud sat agent ls --connector-id ID [--output OUTPUT] [-q]

指令選項

--connector-id ID: Satellite 連接器的 ID。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat agent ls --connector-id CONNECTOR_ID --output json -q

IBM Cloud SAT 叢集指令

登錄及管理叢集，以與 Satellite 配置搭配使用。

`ibmcloud sat cluster get`

虛擬私有雲經典基礎架構 Satellite

取得已登錄叢集的詳細資料。

ibmcloud sat cluster get --cluster CLUSTER [--output OUTPUT] [-q]

指令選項

--cluster CLUSTER, -c CLUSTER: 指定叢集名稱或 ID。若要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

取得已登錄叢集的詳細資料。

ibmcloud sat cluster get --cluster CLUSTER_NAME_OR_ID --output json -q

`ibmcloud sat cluster ls`

虛擬私有雲經典基礎架構 Satellite

列出 IBM Cloud 帳戶中所有已登錄的叢集。

ibmcloud sat cluster ls [--filter FILTER] [--limit LIMIT] [--output OUTPUT] [-q]

指令選項

--filter FILTER: 依叢集 ID 過濾已登錄的叢集。
--limit LIMIT: 限制所傳回的叢集數目。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 IBM Cloud 帳戶中所有已登錄的叢集。

ibmcloud sat cluster ls --filter FILTER --limit LIMIT --output json

`ibmcloud sat cluster register`

取得一個 kubectl 指令，用以將您的叢集註冊至 Satellite 配置中。登入叢集，並執行此指令以安裝 Satellite 配置代理程式。您在 Satellite 位置中執行的叢集會自動安裝此代理程式。

ibmcloud sat cluster register --name NAME [-q] [--silent]

指令選項

--name NAME: 指定您要登錄的叢集名稱
-q: 不要顯示日或更新提示的訊息。
--silent: 無聲自動。在輸出中只傳回登錄指令。

範例

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

ibmcloud sat cluster register --silent SILENT --name NAME -q

`ibmcloud sat cluster unregister`

移除叢集登錄。叢集不再訂閱 Satellite 配置，但叢集及其現有資源仍在執行中。

ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]

指令選項

--cluster CLUSTER, -c CLUSTER: 指定叢集名稱或 ID。若要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。

範例

移除叢集登錄。

ibmcloud sat cluster unregister --cluster CLUSTER_NAME_OR_ID -f -q

ibmcloud SAT 設定指令

檢視並管理 Satellite 配置。

`ibmcloud sat config create`

建立配置以指定要部署到 Satellite 工作量中叢集的 Kubernetes 資源。

ibmcloud sat config create --name NAME [-q] (--data-location LOCATION | --provider PROVIDER)

指令選項

--data-location LOCATION: 指定 IBM 區域以儲存 Satellite 配置資料。策略：直接上傳。
--name NAME: 提供 Satellite 配置的名稱。
--provider PROVIDER: 指出 Satellite 配置的遠端 GitOps 提供者。此提供者儲存 Kubernetes 資源定義。策略：GitOps。容許值 :github、gitlab
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat config create \
  --name NAME \
  --data-location LOCATION \
  --provider PROVIDER_ID

`ibmcloud sat config get`

取得 Satellite 配置的詳細資料，例如與配置相關聯的版本或訂閱。

ibmcloud sat config get --config CONFIG [--output OUTPUT] [-q]

指令選項

--config CONFIG: 指定 Satellite 配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat config ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat config get --config CONFIG --output json -q

`ibmcloud sat config ls`

列出 IBM Cloud 帳戶中的所有 Satellite 配置。

ibmcloud sat config ls [--output OUTPUT] [-q]

指令選項

--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 IBM Cloud 帳戶中的所有 Satellite 配置。

ibmcloud sat config ls --output json -q

`ibmcloud sat config rename`

重新命名 Satellite 配置。

ibmcloud sat config rename --config CONFIG --name NAME [-q]

指令選項

--config CONFIG: 指定 Satellite 配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat config ls。
--name NAME: 提供 Satellite 配置的新名稱。
-q: 不要顯示日或更新提示的訊息。

範例

重新命名 Satellite 配置。

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

`ibmcloud sat config rm`

移除 Satellite 配置。必須先移除所有相關聯的訂閱。已刪除所有版本。備份您要保留的任何資源定義。

ibmcloud sat config rm --config CONFIG [-f] [-q]

指令選項

--config CONFIG: 指定 Satellite 配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat config ls。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。

範例

移除 Satellite 配置。

ibmcloud sat config rm --config CONFIG -f -q

`ibmcloud sat config version create`

建立配置版本以更新 Satellite 工作量的現有 Kubernetes 資源。

ibmcloud sat config version create --config CONFIG --file-format FORMAT --name NAME --read-config CONFIG [--description DESCRIPTION] [-q]

指令選項

--config CONFIG: 指定 Satellite 配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat config ls。
--description DESCRIPTION: 新增 Satellite 配置版本的說明。
--file-format FORMAT: 指出配置版本的檔案格式。可用的選項 :yaml
--name NAME: 提供 Satellite 配置版本的名稱。
-q: 不要顯示日或更新提示的訊息。
--read-config CONFIG: 指定配置版本檔案的檔案路徑。

範例

建立配置版本以更新 Satellite 工作量的現有 Kubernetes 資源。

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

`ibmcloud sat config version get`

取得 Satellite 配置版本詳細資料。

ibmcloud sat config version get --config CONFIG --version VERSION [--output OUTPUT] [-q] [--save-config]

指令選項

--config CONFIG: 指定 Satellite 配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat config ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--save-config: 下載配置版本並將其儲存至暫存檔中。
--version VERSION: 指定 Satellite 配置版本的名稱或 ID。若要在設定檔中列出版本，請執行 ibmcloud sat config get --config <configuration_name_or_ID>。

範例

取得 Satellite 配置版本詳細資料。

ibmcloud sat config version get \
  --config CONFIG \
  --version VERSION \
  --save-config SAVE-CONFIG

`ibmcloud sat config version rm`

移除 Satellite 配置版本。

ibmcloud sat config version rm --config CONFIG --version VERSION [-f] [-q]

指令選項

--config CONFIG: 指定 Satellite 配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat config ls。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。
--version VERSION: 指出 Satellite 配置版本的名稱或 ID。若要列出版本，請執行 ibmcloud sat config get --config <configuration_name_or_ID>。

範例

移除 Satellite 配置版本。

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

ibmcloud SAT 連接器指令

建立、檢視及修改 Satellite 連接器。

`ibmcloud sat connector create`

建立 Satellite 連接器。

ibmcloud sat connector create --name NAME --region REGION [-q]

指令選項

--name NAME: Satellite 連接器的名稱。
-q: 不要顯示日或更新提示的訊息。
--region REGION: 用來管理 Satellite 連接器的 IBM Cloud 區域。

範例

建立 Satellite 連接器。

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

`ibmcloud sat connector get`

檢視 Satellite 連接器的詳細資料。

ibmcloud sat connector get --connector-id ID [--output OUTPUT] [-q]

指令選項

--connector-id ID: Satellite 連接器的 ID。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視 Satellite 連接器的詳細資料。

ibmcloud sat connector get --connector-id CONNECTOR_ID --output json -q

`ibmcloud sat connector ls`

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

ibmcloud sat connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]

指令選項

--after AFTER: 在指定游標後顯示 Satellite 連接器。
--first FIRST: 檢視下一個 Satellite連接器，直到第一個連接器的數量。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat connector ls --after AFTER --first FIRST --output json

`ibmcloud sat connector rm`

刪除 Satellite 連接器。

ibmcloud sat connector rm --connector-id ID [-f] [-q]

指令選項

--connector-id ID: Satellite 連接器的 ID。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。

範例

刪除 Satellite 連接器。

ibmcloud sat connector rm --connector-id CONNECTOR_ID -f -q

ibmcloud sat 端點指令

檢視並管理 Satellite 端點。

`ibmcloud sat endpoint authn get`

取得端點的身份驗證設定。

ibmcloud sat endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

取得端點的身份驗證設定。

ibmcloud sat endpoint authn get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint authn rotate`

將現有的身份驗證憑證替換為新的憑證。在請求流程中，共有兩個 TLS 連線。 source 選項是指來源與 Connector 服務之間進行的 TLS 握手程序。 destination 選項是指 Connector 服務與您的目的地或目標伺服器之間進行的 TLS 握手程序。您可以為其中一個或兩個連線提供憑證。僅會替換您指定的憑證。

ibmcloud sat endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--dest-ca-cert-file FILE: 用來驗證目的地伺服器憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--dest-cert-file FILE: 用於向目標伺服器進行身分驗證的客戶端憑證。例如 myCert.pem。
--dest-key-file FILE: 用來加密用戶端憑證的用戶端私密金鑰。例如 myKey.pem。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--source-ca-cert-file FILE: 當 source-tls-mode 是相互時，用來驗證來源用戶端憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--source-cert-file FILE: 要呈現給來源用戶端的伺服器憑證。例如 myCert.pem。
--source-key-file FILE: 用來加密伺服器憑證的伺服器私密金鑰。例如 myKey.pem。

範例

將現有的身份驗證憑證替換為新的憑證。

ibmcloud sat endpoint authn rotate \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint authn set`

設定端點的身份驗證設定。在請求流程中，共有兩個 TLS 連線。 source 選項是指來源與 Connector 服務之間進行的 TLS 握手程序。 destination 選項是指 Connector 服務與您的目的地或目標伺服器之間進行的 TLS 握手程序。您可以為其中一個或兩個連線提供憑證。未指定的設定會設為其預設值。

ibmcloud sat endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--dest-ca-cert-file FILE: 用來驗證目的地伺服器憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--dest-cert-file FILE: 用於向目標伺服器進行身分驗證的客戶端憑證。例如 myCert.pem。
--dest-key-file FILE: 用來加密用戶端憑證的用戶端私密金鑰。例如 myKey.pem。
--dest-tls-mode MODE: 目的地 TLS 模式。接受的值：simple,mutual,none
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--source-ca-cert-file FILE: 當 source-tls-mode 是相互時，用來驗證來源用戶端憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--source-cert-file FILE: 要呈現給來源用戶端的伺服器憑證。例如 myCert.pem。
--source-key-file FILE: 用來加密伺服器憑證的伺服器私密金鑰。例如 myKey.pem。
--source-tls-mode MODE: 來源：TLS 模式。接受值: simple、mutual

範例

設定端點的身份驗證設定。

ibmcloud sat endpoint authn set \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint create`

建立端點。

ibmcloud sat endpoint create --dest-hostname HOSTNAME --dest-port PORT --dest-type TYPE --name NAME --source-protocol PROTOCOL [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--output OUTPUT] [-q] [--sni SNI] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--dest-hostname HOSTNAME: 指出您要連接之目的地的完整網域名稱 (FQDN) 或外部可存取 IP 位址。對於 cloud 端點，此值必須解析為公網 IP 位址，或可透過 IBM Cloud 存取的私有 IP 位址（例如私有雲服務端點）。對於 location 端點，此值必須可從控制平面主機解析，且從該主機可存取該位置（ Satellite ）；若使用 Satellite Connector，則必須可從代理程式執行位置存取。
--dest-port PORT: 提供目的地資源接聽送入要求的埠。請確定埠與目的地通訊協定相符。
--dest-protocol PROTOCOL: 指定目的地的通訊協定。如果未指定此選項，則會從來源通訊協定繼承目的地通訊協定。接受值: TCP、TLS
--dest-type TYPE: 請指定目標資源的執行位置，可選擇位於 IBM Cloud （cloud ）或您的 Satellite 位置（location ）。可用選項：location、cloud
--idle-timeout-seconds SECONDS: 指定目的地作用中連線的逾時間隔 (以秒為單位)。請確定您的逾時與目的地服務及通訊協定 keep-alive 設定相容。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--name NAME: 提供端點的名稱。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--sni SNI: 若您指定了 tls 或 https 來源協定，且希望在 TLS 握手過程中加入獨立的主機名稱，請指定伺服器名稱指標。
--source-protocol PROTOCOL: 提供來源用來連接目的地資源的通訊協定。參見 http://ibm.biz/endpoint-protocols。可用選項：TCP、TLS、HTTP、HTTPS、HTTP-tunnel

範例

建立端點。

ibmcloud sat endpoint create \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --name NAME

`ibmcloud sat endpoint disable`

禁用端點。

ibmcloud sat endpoint disable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)。
-f: 強制執行指令，而不出現使用者提示。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

禁用端點。

ibmcloud sat endpoint disable \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint enable`

啟用端點。

ibmcloud sat endpoint enable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)。
-f: 強制執行指令，而不出現使用者提示。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

啟用端點。

ibmcloud sat endpoint enable \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint get`

檢視端點的詳細資料。

ibmcloud sat endpoint get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視端點的詳細資料。

ibmcloud sat endpoint get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint ls`

列出 Satellite 位置中的所有端點。

ibmcloud sat endpoint ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 Satellite 位置中的所有端點。

ibmcloud sat endpoint ls --location LOCATION --connector-id CONNECTOR_ID --output json

`ibmcloud sat endpoint rm`

刪除端點。

ibmcloud sat endpoint rm --endpoint ENDPOINT [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

刪除端點。

ibmcloud sat endpoint rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat endpoint update`

更新端點。僅更新您指定的選項。

ibmcloud sat endpoint update --endpoint ENDPOINT [--dest-hostname HOSTNAME] [--dest-port PORT] [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--name NAME] [-q] [--sni SNI] [--source-protocol PROTOCOL] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--dest-hostname HOSTNAME: 指出您要連接之目的地的完整網域名稱 (FQDN) 或外部可存取 IP 位址。對於 cloud 端點，此值必須解析為公網 IP 位址，或可透過 IBM Cloud 存取的私有 IP 位址（例如私有雲服務端點）。對於 location 端點，此值必須可從控制平面主機解析，且從該主機可存取該位置（ Satellite ）；若使用 Satellite Connector，則必須可從代理程式執行位置存取。
--dest-port PORT: 提供目的地資源接聽送入要求的埠。請確定埠與目的地通訊協定相符。
--dest-protocol PROTOCOL: 指定目的地的通訊協定。如果未指定此選項，則會從來源通訊協定繼承目的地通訊協定。接受值: TCP、TLS
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)。
--idle-timeout-seconds SECONDS: 指定目的地作用中連線的逾時間隔 (以秒為單位)。請確定您的逾時與目的地服務及通訊協定 keep-alive 設定相容。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--name NAME: 提供端點的新名稱。
-q: 不要顯示日或更新提示的訊息。
--sni SNI: 若您指定了 tls 或 https 來源協定，且希望在 TLS 握手過程中加入獨立的主機名稱，請指定伺服器名稱指標。
--source-protocol PROTOCOL: 提供來源用來連接目的地資源的通訊協定。參見 http://ibm.biz/endpoint-protocols。有效值：TCP、TLS、HTTP、HTTPS、HTTP-tunnel

範例

更新端點。

ibmcloud sat endpoint update \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

ibmcloud sat 實驗性指令

[有效期至 2024-11-25] 試試看新的指令。重要：此處列出的指令將於其說明中所載的[日期]後停止使用。

`ibmcloud sat experimental acl create`

[在 2024-10-01 上停用！使用 ibmcloud sat acl create 取代] 建立 ACL。

ibmcloud sat experimental acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 若要為此 ACL 啟用的端點的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--name NAME: ACL 的名稱。
-q: 不要顯示日或更新提示的訊息。
--subnet 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 experimental acl create \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --name NAME

`ibmcloud sat experimental acl endpoint add`

[在 2024-10-01 上停用！使用 ibmcloud sat acl endpoint add 取代] 將一個或多個啟用的端點加入 ACL。

ibmcloud sat experimental acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 若要為此 ACL 啟用的端點的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat experimental acl endpoint add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl endpoint ls`

[在 2024-10-01 上停用！使用 ibmcloud sat acl endpoint ls 取代] 列出 ACL 的所有啟用端點。

ibmcloud sat experimental acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 ACL 的所有啟用的端點。

ibmcloud sat experimental acl endpoint ls \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl endpoint rm`

[在 2024-10-01 上停用！使用 ibmcloud sat acl endpoint rm 取代] 從 ACL 移除一個或多個啟用的端點。

ibmcloud sat experimental acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 若要為此 ACL 停用的端點的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

從 ACL 中刪除一個或多個已啟用的端點。

ibmcloud sat experimental acl endpoint rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl get`

[在 2024-10-01 上停用！使用 ibmcloud sat acl get 取代] 檢視 ACL 的詳細資訊。

ibmcloud sat experimental acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視 ACL 的詳細資訊。

ibmcloud sat experimental acl get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl ls`

[在 2024-10-01 上停用！請改用 ibmcloud sat acl ls 取代] 列出 Satellite 連接器或位置的所有存取控制清單 (ACL)。

ibmcloud sat experimental acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat experimental acl ls \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --output json

`ibmcloud sat experimental acl rm`

[在 2024-10-01 上停用！使用 ibmcloud sat acl rm 取代] 刪除 ACL。

ibmcloud sat experimental acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

刪除ACL。

ibmcloud sat experimental acl rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl subnet add`

[在 2024-10-01 上停用！使用 ibmcloud sat acl subnet add 取代] 將一個或多個子網路加入 ACL。

ibmcloud sat experimental acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--subnet 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 experimental acl subnet add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl subnet rm`

[在 2024-10-01 上停用！使用 ibmcloud sat acl subnet rm 取代] 從 ACL 移除一個或多個子網路。

ibmcloud sat experimental acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--subnet 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 experimental acl subnet rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental acl update`

[在 2024-10-01 上停用！使用 ibmcloud sat acl update 取代] 更新 ACL 的名稱。

ibmcloud sat experimental acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)

指令選項

--acl-id ID: 指定ACL的ID。若要列出所有 ACL，請執行 ibmcloud sat acl ls。
--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--name NAME: ACL 的新名稱。
-q: 不要顯示日或更新提示的訊息。

範例

更新ACL的名稱。

ibmcloud sat experimental acl update \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

`ibmcloud sat experimental agent attach`

[在 2024-09-01 上停用！請改用 ibmcloud sat agent attach 而非] 取得適用於特定平台的 Satellite 連接器代理程式。下載適用於 Windows 的 Agent .zip，或取得適用於 Docker 環境的文件連結。

ibmcloud sat experimental agent attach --platform PLATFORM [-q]

指令選項

--platform PLATFORM: 該平台為Satellite連接器代理程式。欲了解更多信息Docker，請參閱文檔https://ibm.biz/satconagent可用選項：windows、docker
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat experimental agent attach --platform PLATFORM -q

`ibmcloud sat experimental agent ls`

[在 2024-09-01 上停用！請改用 ibmcloud sat agent ls 取代] 列出 Satellite 連接器的所有代理程式。

ibmcloud sat experimental agent ls --connector-id ID [--output OUTPUT] [-q]

指令選項

--connector-id ID: Satellite 連接器的 ID。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat experimental agent ls --connector-id CONNECTOR_ID --output json -q

`ibmcloud sat experimental connector create`

[在 2024-11-18 上停用！請改用 ibmcloud sat connector create 取代] 建立一個 Satellite 連接器。

ibmcloud sat experimental connector create --name NAME --region REGION [-q]

指令選項

--name NAME: Satellite 連接器的名稱。
-q: 不要顯示日或更新提示的訊息。
--region REGION: 用來管理 Satellite 連接器的 IBM Cloud 區域。

範例

建立 Satellite 連接器。

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

`ibmcloud sat experimental connector get`

[在 2024-11-18 上停用！請改用 ibmcloud sat connector get 取代] 檢視 Satellite 連接器的詳細資訊。

ibmcloud sat experimental connector get --connector-id ID [--output OUTPUT] [-q]

指令選項

--connector-id ID: Satellite 連接器的 ID。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視 Satellite 連接器的詳細資料。

ibmcloud sat experimental connector get --connector-id CONNECTOR_ID --output json -q

`ibmcloud sat experimental connector ls`

[在 2024-11-18 上停用！請改用 ibmcloud sat connector ls] 在您的 IBM Cloud 帳戶中查看 Satellite 連接器。

ibmcloud sat experimental connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]

指令選項

--after AFTER: 在指定游標後顯示 Satellite 連接器。
--first FIRST: 檢視下一個 Satellite連接器，直到第一個連接器的數量。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat experimental connector ls --after AFTER --first FIRST --output json

`ibmcloud sat experimental connector rm`

[在 2024-11-18 上停用！請改用 ibmcloud sat connector rm] 刪除 Satellite 連接器。

ibmcloud sat experimental connector rm --connector-id ID [-f] [-q]

指令選項

--connector-id ID: Satellite 連接器的 ID。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。

範例

刪除 Satellite 連接器。

ibmcloud sat experimental connector rm --connector-id CONNECTOR_ID -f -q

`ibmcloud sat experimental endpoint authn get`

[在 2024-10-01 上停用！使用 ibmcloud sat endpoint authn get 取代] 取得端點的驗證設定。

ibmcloud sat experimental endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

取得端點的身份驗證設定。

ibmcloud sat experimental endpoint authn get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat experimental endpoint authn rotate`

[在 2024-10-01 上停用！使用 ibmcloud sat endpoint authn rotate 取代] 使用新的認證憑證取代現有的認證憑證。在請求流程中，共有兩個 TLS 連線。 source 選項是指來源與 Connector 服務之間進行的 TLS 握手程序。 destination 選項是指 Connector 服務與您的目的地或目標伺服器之間進行的 TLS 握手程序。您可以為其中一個或兩個連線提供憑證。僅會替換您指定的憑證。

ibmcloud sat experimental endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--dest-ca-cert-file FILE: 用來驗證目的地伺服器憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--dest-cert-file FILE: 用於向目標伺服器進行身分驗證的客戶端憑證。例如 myCert.pem。
--dest-key-file FILE: 用來加密用戶端憑證的用戶端私密金鑰。例如 myKey.pem。
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--source-ca-cert-file FILE: 當 source-tls-mode 是相互時，用來驗證來源用戶端憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--source-cert-file FILE: 要呈現給來源用戶端的伺服器憑證。例如 myCert.pem。
--source-key-file FILE: 用來加密伺服器憑證的伺服器私密金鑰。例如 myKey.pem。

範例

將現有的身份驗證憑證替換為新的憑證。

ibmcloud sat experimental endpoint authn rotate \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat experimental endpoint authn set`

[在 2024-10-01 上停用！使用 ibmcloud sat endpoint authn set 取代] 設定端點的驗證設定。在請求流程中，共有兩個 TLS 連線。 source 選項是指來源與 Connector 服務之間進行的 TLS 握手程序。 destination 選項是指 Connector 服務與您的目的地或目標伺服器之間進行的 TLS 握手程序。您可以為其中一個或兩個連線提供憑證。未指定的設定會設為其預設值。

ibmcloud sat experimental endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)

指令選項

--connector-id ID: Satellite 連接器的 ID。若要尋找連接器 ID，請執行 ibmcloud sat connector ls。
--dest-ca-cert-file FILE: 用來驗證目的地伺服器憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--dest-cert-file FILE: 用於向目標伺服器進行身分驗證的客戶端憑證。例如 myCert.pem。
--dest-key-file FILE: 用來加密用戶端憑證的用戶端私密金鑰。例如 myKey.pem。
--dest-tls-mode MODE: 目的地 TLS 模式。接受的值：simple,mutual,none
--endpoint ENDPOINT: 指定端點的名稱或 ID。若要列出所有端點，請執行 ibmcloud sat endpoint ls。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--source-ca-cert-file FILE: 當 source-tls-mode 是相互時，用來驗證來源用戶端憑證的授信 CA 憑證或鏈結。例如 myCA.pem。
--source-cert-file FILE: 要呈現給來源用戶端的伺服器憑證。例如 myCert.pem。
--source-key-file FILE: 用來加密伺服器憑證的伺服器私密金鑰。例如 myKey.pem。
--source-tls-mode MODE: 來源：TLS 模式。接受值: simple、mutual

範例

設定端點的身份驗證設定。

ibmcloud sat experimental endpoint authn set \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

`ibmcloud sat experimental location update`

[在 2024-11-25 上停用！請改用 ibmcloud sat location update] 更新 Satellite 位置的名稱或說明。

ibmcloud sat experimental location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]

指令選項

--description DESCRIPTION: 請為「Satellite」地點輸入新的描述。說明的長度限制為 400 位元組。
--location-id ID: Satellite 位置的 ID。要查找位置 ID，請執行 ibmcloud sat location ls。
--name NAME: 請為「Satellite」位置指定一個新名稱。地點名稱必須以字母開頭，可包含字母、數字、句點 (.) 及連字號 (-)，且長度不得超過 36 個字元。請勿重複使用名稱，包括已刪除位置的名稱。
-q: 不要顯示日或更新提示的訊息。

範例

更新Satellite位置的名稱或描述。

ibmcloud sat experimental location update \
  --location-id LOCATION \
  --name NAME \
  --description IP_ADDRESS

ibmcloud SAT 群組指令

檢視並管理 Satellite 叢集群組。叢集群組用於讓叢集訂閱 Kubernetes 資源的 Satellite 配置。

`ibmcloud sat group attach`

將叢集新增至叢集群組。叢集可以在 Satellite 位置或 IBM Cloud 中執行。若要新增在 IBM Cloud 中執行的叢集，您必須先向 Satellite 配置登錄叢集。

ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-q]

指令選項

--cluster CLUSTER, -c CLUSTER: 請指定叢集名稱或 ID。若要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。
--group GROUP, -g GROUP: 指定 Satellite 叢集群組的名稱或 ID。若要列出可用的叢集群組，請執行 ibmcloud sat group ls``。
-q: 不要顯示日或更新提示的訊息。

範例

將叢集新增至叢集群組。

ibmcloud sat group attach --group GROUP --cluster CLUSTER_NAME_OR_ID -q

`ibmcloud sat group create`

建立叢集群組。然後，您可以為叢集群組訂閱 Satellite 配置。

ibmcloud sat group create --name NAME [--cluster CLUSTER ...] [-q]

指令選項

--cluster CLUSTER, -c CLUSTER: 指定要新增至叢集群組的叢集名稱或 ID。若要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。
--name NAME: 提供 Satellite 叢集群組的名稱。
-q: 不要顯示日或更新提示的訊息。

範例

建立叢集群組。

ibmcloud sat group create --name NAME --cluster CLUSTER_NAME_OR_ID -q

`ibmcloud sat group detach`

將一個以上的叢集從 Satellite 叢集群組中移除，並刪除群組的訂閱所管理的 Kubernetes 資源。

ibmcloud sat group detach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-f] [-q]

指令選項

--cluster CLUSTER, -c CLUSTER: 請指定叢集名稱或 ID。若要列出您所屬叢集群組中的叢集，請執行 ibmcloud sat group get --group <cluster_group_name_or_ID>。
-f: 強制執行指令，而不出現使用者提示。
--group GROUP, -g GROUP: 指定 Satellite 叢集群組的名稱或 ID。若要列出可用的叢集群組，請執行 ibmcloud sat group ls``。
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat group detach --group GROUP --cluster CLUSTER_NAME_OR_ID -f

`ibmcloud sat group get`

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

ibmcloud sat group get --group GROUP [--output OUTPUT] [-q]

指令選項

--group GROUP, -g GROUP: 指定 Satellite 叢集群組的名稱或 ID。若要列出已註冊的叢集，請執行 ibmcloud sat cluster ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat group get --group GROUP --output json -q

`ibmcloud sat group ls`

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

ibmcloud sat group ls [--output OUTPUT] [-q]

指令選項

--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat group ls --output json -q

`ibmcloud sat group rm`

移除 Satellite 叢集群組，這將取消訂閱叢集並刪除群組訂閱所管理的 Kubernetes 資源。

ibmcloud sat group rm --group GROUP [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
--group GROUP, -g GROUP: 指定 Satellite 叢集群組的名稱或 ID。若要列出可用的叢集群組，請執行 ibmcloud sat group ls``。
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat group rm --group GROUP -f -q

ibmcloud SAT 主機指令

檢視及修改 Satellite 主機。

`ibmcloud sat host assign`

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

ibmcloud sat host assign --location LOCATION [--cluster CLUSTER] [--host HOST] [--host-label LABEL ...] [-q] [--worker-pool POOL] [--zone ZONE]

指令選項

--cluster CLUSTER: 要指派主機之叢集的名稱或 ID。要列出可用的叢集，請執行 ibmcloud sat cluster ls。如果沒有提供叢集，則主機會自動指派給 Satellite 控制平面。
--host HOST: 要指派的主機名稱或 ID。若要根據標籤自動指派主機，請不要包含此選項。要取得主機 ID，請執行 ibmcloud sat host ls --location <location_ID_or_name>。
--host-label LABEL, --hl LABEL: 請以鍵值對的形式輸入任何標籤，用以識別要指派給您的 Satellite 控制平面或 Red Hat OpenShift 叢集的主機。第一個具有此標籤且未經指派的主機將會自動指派給控制平面或叢集。若要查詢可用的主機標籤，請執行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--worker-pool POOL, -p POOL: 叢集中要指派主機的目標工作者儲存區名稱或 ID。如果未指定任何工作者儲存區，則會將主機指派給預設工作者儲存區。
--zone ZONE: 要指派主機的目標區域名稱或 ID。若要查詢可用的區域，請執行 ibmcloud sat location get --location <location_name_or_ID> ，並查看 Host Zones 欄位。

範例

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

ibmcloud sat host assign \
  --location LOCATION \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME

`ibmcloud sat host attach`

建立並下載您可以在主機上執行的 Script，以將它們連接至您的位置。對於已啟用 RHCOS 的位置，Script 是 ignition 檔案。

ibmcloud sat host attach --location LOCATION [--host-label LABEL ...] [--host-link-agent-endpoint ENDPOINT] [--operating-system SYSTEM] [-q] [--reset-key]

指令選項

--host-label LABEL, --hl LABEL: 請以鍵值對的形式輸入任何標籤，用以識別要指派給您的 Satellite 控制平面或 Red Hat OpenShift 叢集的主機。第一個具有此標籤且未經指派的主機將會自動指派給控制平面或叢集。若要查詢可用的主機標籤，請執行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。
--host-link-agent-endpoint ENDPOINT: 鏈結代理程式用來連接鏈結通道伺服器的端點。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--operating-system SYSTEM: 要連接至位置之主機的作業系統。若要連接 RHCOS 主機，您的位置必須已啟用 RHCOS。接受值: RHEL、RHCOS
-q: 不要顯示日或更新提示的訊息。
--reset-key: 重設控制平面用來連接及指派位置中主機的按鍵。請參閱 https://ibm.biz/reset-key。

範例

建立並下載您可以在主機上執行的 Script，以將它們連接至您的位置。

ibmcloud sat host attach \
  --location LOCATION \
  --host-label HOSTNAME \
  --reset-key RESET-KEY

`ibmcloud sat host get`

檢視 Satellite 主機的詳細資料。

ibmcloud sat host get --host HOST --location LOCATION [--output OUTPUT] [-q]

指令選項

--host HOST: Satellite 主機 ID。要查詢主機 ID，請執行 ibmcloud sat host ls <location_ID_or_name>。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視 Satellite 主機的詳細資料。

ibmcloud sat host get --location LOCATION --host HOSTNAME --output json

`ibmcloud sat host ls`

列出連接至 Satellite 位置的所有主機，包括指派給叢集或控制層的主機。

ibmcloud sat host ls --location LOCATION [--output OUTPUT] [-q]

指令選項

--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出所有連接到「Satellite」位置的主機，包括已指派至叢集或控制點的主機。

ibmcloud sat host ls --location LOCATION --output json -q

`ibmcloud sat host rm`

從 Satellite 位置移除主機。

ibmcloud sat host rm --host HOST --location LOCATION [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
--host HOST: 要移除的主機的名稱或 ID。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

從 Satellite 位置移除主機。

ibmcloud sat host rm --location LOCATION --host HOSTNAME -f

`ibmcloud sat host update`

更新主機資訊，如區域及標籤。

ibmcloud sat host update --host HOST --location LOCATION [--host-label LABEL ...] [-q] [--zone ZONE]

指令選項

--host HOST: 要指派的主機名稱或 ID。若要根據標籤自動指派主機，請不要包含此選項。
--host-label LABEL, --hl LABEL: 請以鍵值對的形式輸入任何標籤，用以識別要指派給您的 Satellite 控制平面或 Red Hat OpenShift 叢集的主機。第一個具有此標籤且未經指派的主機將會自動指派給控制平面或叢集。若要查詢可用的主機標籤，請執行 ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。
--zone ZONE: 要與主機關聯的區域名稱或 ID。您無法變更指派給資源（例如：叢集）的主機區域。您必須先取消指派它們。若要列出可用的區域，請執行 ibmcloud sat location get --location <ID>。

範例

更新主機資訊，如區域及標籤。

ibmcloud sat host update --location LOCATION --host-label HOSTNAME --zone ZONE

IBM Cloud SAT 主要指令

檢視及管理 Satellite 配置金鑰。

`ibmcloud sat key ls`

列出 IBM Cloud 帳戶中的所有 Satellite 配置金鑰。

ibmcloud sat key ls [--output OUTPUT] [-q]

指令選項

--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 IBM Cloud 帳戶中的所有 Satellite 配置金鑰。

ibmcloud sat key ls --output json -q

`ibmcloud sat key rm`

移除 Satellite 配置金鑰。任何仍使用此金鑰的叢集都無法連接至 Satellite 配置。

ibmcloud sat key rm --key KEY [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
--key KEY: Satellite 配置金鑰的名稱或 ID。
-q: 不要顯示日或更新提示的訊息。

範例

移除 Satellite 配置金鑰。

ibmcloud sat key rm --key KEY -f -q

`ibmcloud sat key rotate`

產生新的金鑰，供受管理叢集用於連接至 Satellite 配置。

ibmcloud sat key rotate --name NAME [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
--name NAME: 新 Satellite 配置金鑰的名稱。
-q: 不要顯示日或更新提示的訊息。

範例

產生新的金鑰，供受管理叢集用於連接至 Satellite 配置。

ibmcloud sat key rotate --name NAME -f -q

ibmcloud SAT 位置指令

建立、檢視和修改 Satellite 位置。

`ibmcloud sat location create`

建立 Satellite 位置。 Satellite 位置代表您的基礎架構提供者中的環境。建立位置後，請使用 ibmcloud sat host attach 指令，將後端基礎架構環境中不同區域的主機附加至該位置。

ibmcloud sat location create --managed-from REGION --name NAME [--capability CAPABILITY ...] [--coreos-enabled] [--cos-bucket BUCKET] [--description DESCRIPTION] [--ha-zone ZONE ...] [--physical-address ADDRESS] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--provider PROVIDER] [--provider-credential CREDENTIAL] [--provider-region REGION] [-q] [--service-subnet SUBNET]

指令選項

--capability CAPABILITY: Satellite定位的能力。
--coreos-enabled: 針對 Satellite 位置啟用 Red Hat CoreOS 特性。這個動作無法復原。請參閱 https://ibm.biz/infra-os。
--cos-bucket BUCKET: 指定 IBM Cloud Object Storage 儲存區的名稱，以儲存 Satellite 位置控制平面資料。否則，會為您建立新的儲存區。
--description DESCRIPTION: 輸入 Satellite 位置的說明。
--ha-zone ZONE: 指定位置的區域。為了確保高可用性，請將您的位置設定為 3 個區域，格式如下：--ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME。區域名稱必須與您計劃在其中建立主機之基礎架構提供者中對應區域的名稱完全相符。
--managed-from REGION: 選取要從中管理 Satellite 位置的 IBM Cloud 區域。請選擇靠近內部部署資料中心的區域以提升效能。請參閱 https://ibm.biz/sat-region。
--name NAME: 指定 Satellite 位置的名稱。地點名稱必須以字母開頭，可包含字母、數字、句點 (.) 及連字號 (-)，且長度不得超過 36 個字元。即使刪除其他位置，也不要重複使用名稱。
--physical-address ADDRESS: Satellite位置的實體位址。
--pod-network-interface-selection SELECTION: 選取內部 Pod 網路的節點網路介面的方法。此選項僅在您同時啟用 Red Hat CoreOS 並設定 --coreos-enabled 選項時，方可使用。若要直接提供 URL 或 IP 位址，請指定 can-reach=<url> 或 can-reach=<ip_address>。若要選擇網路介面，請指定 interface=<network_interface>。
--pod-subnet SUBNET: 指定自訂子網路 CIDR 為 POD 提供專用 IP 位址。此選項僅在您啟用 Red Hat CoreOS 並搭配 --coreos-enabled 選項時才會生效。子網必須為 /23 或更大。請參閱 https://ibm.biz/sat-location-create。預設值：' 172.16.0.0/16
--provider PROVIDER: 指出要用於 Satellite 位置的基礎架構提供者。若您包含此選項，則必須同時包含 --provider-credential 選項。接受值: aws、azure、gcp、vmware
--provider-credential CREDENTIAL: 指定本端機器上 JSON 檔案的路徑，該檔案具有 Satellite 位置的基礎架構提供者認證。認證格式特定於提供者。請參閱 http://ibm.biz/sat-infra-creds。
--provider-region REGION: 在基礎架構提供者中，指定您計劃為 Satellite 位置建立主機的地區。若您包含此選項，則必須同時包含 --provider 選項。
-q: 不要顯示日或更新提示的訊息。
--service-subnet SUBNET: 指定自訂子網路 CIDR 為服務提供專用 IP 位址。此選項僅在您啟用 Red Hat CoreOS 並搭配 --coreos-enabled 選項時才會生效。子網必須為 /24 或更大。請參閱 https://ibm.biz/sat-location-create。預設值： 172.20.0.0/16

範例

建立 Satellite 位置。

ibmcloud sat location create \
  --pod-subnet SUBNET_CIDR \
  --service-subnet SUBNET_CIDR \
  --name NAME

`ibmcloud sat location dns get`

檢視 Satellite 位置中已登錄子網域的詳細資料。

ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN [--output OUTPUT] [-q]

指令選項

--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--subdomain SUBDOMAIN: 指定子網域名稱。若要列出現有的子網域，請執行 ibmcloud sat location dns ls --location <ID>。

範例

檢視 Satellite 位置中已登錄子網域的詳細資料。

ibmcloud sat location dns get --location LOCATION --subdomain DOMAIN --output json

`ibmcloud sat location dns ls`

列出 Satellite 位置中已登錄的子網域。

ibmcloud sat location dns ls --location LOCATION [--output OUTPUT] [-q]

指令選項

--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 Satellite 位置中已登錄的子網域。

ibmcloud sat location dns ls --location LOCATION --output json -q

`ibmcloud sat location dns register`

在 Satellite 位置中設定指派給控制平面之主機的子網域。

ibmcloud sat location dns register --ip IP [--ip IP ...] --location LOCATION [--output OUTPUT] [-q]

指令選項

--ip 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 LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

在 Satellite 位置中設定指派給控制平面之主機的子網域。

ibmcloud sat location dns register --location LOCATION --ip IP_ADDRESS --output json

`ibmcloud sat location get`

檢視 Satellite 位置的詳細資料。

ibmcloud sat location get --location LOCATION [--output OUTPUT] [-q]

指令選項

--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

檢視 Satellite 位置的詳細資料。

ibmcloud sat location get --location LOCATION --output json -q

`ibmcloud sat location ls`

列出 IBM Cloud 帳戶中的所有 Satellite 位置。

ibmcloud sat location ls [--output OUTPUT] [-q]

指令選項

--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 IBM Cloud 帳戶中的所有 Satellite 位置。

ibmcloud sat location ls --output json -q

`ibmcloud sat location rm`

刪除位置。在執行此指令之前，請先備份您的配置，並移除在該位置中執行的任何主機及叢集。當您刪除位置時，不會自動刪除基礎主機基礎架構。這個動作無法復原。

ibmcloud sat location rm --location LOCATION [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
-q: 不要顯示日或更新提示的訊息。

範例

刪除位置。

ibmcloud sat location rm --location LOCATION -f -q

`ibmcloud sat location update`

更新Satellite位置的名稱或描述。

ibmcloud sat location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]

指令選項

--description DESCRIPTION: 請為「Satellite」地點輸入新的描述。說明的長度限制為 400 位元組。
--location-id ID: Satellite 位置的 ID。要查找位置 ID，請執行 ibmcloud sat location ls。
--name NAME: 請為「Satellite」位置指定一個新名稱。地點名稱必須以字母開頭，可包含字母、數字、句點 (.) 及連字號 (-)，且長度不得超過 36 個字元。請勿重複使用名稱，包括已刪除位置的名稱。
-q: 不要顯示日或更新提示的訊息。

範例

更新Satellite位置的名稱或描述。

ibmcloud sat location update \
  --location-id LOCATION \
  --name NAME \
  --description IP_ADDRESS

ibmcloud SAT 訊息指令

檢視現行使用者訊息。

`ibmcloud sat messages`

檢視現行使用者訊息。

ibmcloud sat messages [-q]

指令選項

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

範例

檢視現行使用者訊息。

ibmcloud sat messages -q

IBM Cloud SAT 資源指令

搜尋並檢視 Satellite 配置所管理的 Kubernetes 資源。

`ibmcloud sat resource get`

檢視 Satellite 配置所管理 Kubernetes 資源的詳細資料。

ibmcloud sat resource get --resource RESOURCE [--history HISTORY] [--output OUTPUT] [-q] [--save-data]

指令選項

--history HISTORY: 資源的歷程 ID。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--resource RESOURCE: 指定 Kubernetes 資源 ID。若要查找「Kubernetes」相關資源，請執行 ibmcloud sat resource ls。
--save-data: 下載 Kubernetes 資源定義並將其儲存到暫存檔中。

範例

檢視 Satellite 配置所管理 Kubernetes 資源的詳細資料。

ibmcloud sat resource get \
  --resource RESOURCE \
  --history HISTORY \
  --save-data SAVE-DATA

`ibmcloud sat resource history get`

取得 Kubernetes 資源的歷程。

ibmcloud sat resource history get --resource RESOURCE [--limit LIMIT] [--output OUTPUT] [-q]

指令選項

--limit LIMIT: 指定要傳回的歷程項目數上限。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--resource RESOURCE: Kubernetes 資源 ID。

範例

取得 Kubernetes 資源的歷程。

ibmcloud sat resource history get --resource RESOURCE --limit LIMIT --output json

`ibmcloud sat resource ls`

搜尋由 Satellite 管理的 Kubernetes 資源。

ibmcloud sat resource ls [--limit LIMIT] [--output OUTPUT] [-q] [--search SEARCH] (--cluster CLUSTER | --subscription SUBSCRIPTION)

指令選項

--cluster CLUSTER, -c CLUSTER: 指定 Kubernetes 資源執行所在之已登錄叢集的名稱或 ID。若要查找已註冊的叢集，請執行 ibmcloud sat cluster ls。
--limit LIMIT: 指定搜尋要傳回的資源項目數上限。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--search SEARCH: 指出字串以過濾 Kubernetes 資源的搜尋結果，例如：Pod 或名稱空間名稱。
--subscription SUBSCRIPTION: 指定 Satellite 訂閱 ID 或名稱。若要查找訂閱項目，請執行 ibmcloud sat cluster ls。

範例

搜尋由 Satellite 管理的 Kubernetes 資源。

ibmcloud sat resource ls --search SEARCH --limit LIMIT --cluster CLUSTER_NAME_OR_ID

ibmcloud SAT 服務指令

檢視 Satellite 服務叢集。

`ibmcloud sat service ls`

列出您位置中的所有 Satellite 服務叢集以檢閱詳細資料，例如所要求的主機資源。

ibmcloud sat service ls --location LOCATION [--output OUTPUT] [-q]

指令選項

--location LOCATION: Satellite 位置的名稱或 ID。若要查詢位置 ID 或名稱，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出您位置中的所有 Satellite 服務叢集以檢閱詳細資料，例如所要求的主機資源。

ibmcloud sat service ls --location LOCATION --output json -q

IBM Cloud SAT 儲存指令

檢視並管理 Satellite 儲存體資源。

`ibmcloud sat storage assignment autopatch disable`

storage assignment autopatch disable 指令是測試版特性。

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

ibmcloud sat storage assignment autopatch disable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)

指令選項

--all: 停用儲存體配置之所有 Satellite 儲存體指派的自動修補程式。
--assignment ASSIGNMENT: Satellite 儲存體指派的 ID。若要列出配置的可用儲存體指派，請執行 ibmcloud sat storage assignment ls --config CONFIG。
--config CONFIG: Satellite 儲存體配置的名稱或 ID。若要列出可用的儲存配置，請執行 ibmcloud sat storage config ls。
-q: 不要顯示日或更新提示的訊息。

範例

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

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

`ibmcloud sat storage assignment autopatch enable`

storage assignment autopatch enable 指令是測試版特性。

為「Satellite」儲存分配啟用自動修補程式。

ibmcloud sat storage assignment autopatch enable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)

指令選項

--all: 針對儲存體配置的所有 Satellite 儲存體指派啟用自動修補程式。
--assignment ASSIGNMENT: Satellite 儲存體指派的 ID。若要列出配置的可用儲存體指派，請執行 ibmcloud sat storage assignment ls --config CONFIG。
--config CONFIG: Satellite 儲存體配置的名稱或 ID。若要列出可用的儲存配置，請執行 ibmcloud sat storage config ls。
-q: 不要顯示日或更新提示的訊息。

範例

為「Satellite」儲存分配啟用自動修補程式。

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

`ibmcloud sat storage assignment create`

建立指派以將儲存體配置部署至 Satellite 位置中的叢集。

ibmcloud sat storage assignment create --config CONFIG [--name NAME] [-q] (--cluster CLUSTER | --group GROUP | --service-cluster-id CLUSTER)

指令選項

--cluster CLUSTER, -c CLUSTER: 指定要指派的 Satellite 叢集 ID。要查詢叢集 ID，請執行 ibmcloud oc cluster ls --provider satellite。
--config CONFIG: 指定指派的 Satellite 儲存體配置。若要尋找配置，請執行 ibmcloud sat storage config ls。
--group GROUP, -g GROUP: 指定用於指派的叢集群組。若要找出叢集群組，請執行 ibmcloud sat group ls。
--name NAME: 提供 Satellite 儲存體指派的名稱。
-q: 不要顯示日或更新提示的訊息。
--service-cluster-id CLUSTER: 指定指派的服務叢集 ID。若要查詢服務叢集 ID，請執行 ibmcloud sat service ls --location <location>。

範例

建立指派以將儲存體配置部署至 Satellite 位置中的叢集。

ibmcloud sat storage assignment create \
  --name NAME \
  --group GROUP \
  --service-cluster-id CLUSTER_NAME_OR_ID

`ibmcloud sat storage assignment get`

取得 Satellite 儲存體指派的詳細資料。

ibmcloud sat storage assignment get --assignment ASSIGNMENT [--output OUTPUT] [-q]

指令選項

--assignment ASSIGNMENT: 指定 Satellite 儲存體指派的 ID。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

取得 Satellite 儲存體指派的詳細資料。

ibmcloud sat storage assignment get --assignment ASSIGNMENT --output json -q

`ibmcloud sat storage assignment ls`

列出 IBM Cloud 帳戶中的 Satellite 儲存體指派。

若要以服務管理員身分列出服務叢集的所有指派：ibmcloud sat storage assignment ls--service-cluster-id簇。

要列出作為位置管理員的服務群集的所有分配：ibmcloud sat storage assignment ls--location地點--service-cluster-id簇。

要列出某個配置的所有指派：ibmcloud sat storage assignment ls --config CONFIG。

ibmcloud sat storage assignment ls [--output OUTPUT] [-q] (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)

指令選項

--cluster CLUSTER, -c CLUSTER: 指定指派的 Satellite 叢集 ID。要取得叢集 ID，請執行 ibmcloud oc cluster ls --provider satellite。
--config CONFIG: 指定 Satellite 儲存體配置的名稱或 ID。若要列出可用的儲存配置，請執行 ibmcloud sat storage config ls。
--location LOCATION: 指定 Satellite 位置的名稱。若要列出可用的位置，請執行 ibmcloud sat location ls。服務管理者無法使用此選項。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--service-cluster-id CLUSTER: 指定指派的服務叢集 ID。若要查詢服務叢集 ID，請執行 ibmcloud sat service ls --location <location>。

範例

列出 IBM Cloud 帳戶中的 Satellite 儲存體指派。

ibmcloud sat storage assignment ls \
  --service-cluster-id CLUSTER_NAME_OR_ID \
  --cluster CLUSTER_NAME_OR_ID \
  --config CONFIG

`ibmcloud sat storage assignment patch`

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

ibmcloud sat storage assignment patch --assignment ASSIGNMENT [-f] [-q]

別名：ibmcloud sat upgrade

指令選項

--assignment ASSIGNMENT: 指定 Satellite 儲存體指派的 ID。若要列出可用的任務，請執行 ibmcloud sat storage assignment ls。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat storage assignment patch --assignment ASSIGNMENT -f -q

`ibmcloud sat storage assignment rm`

移除 Satellite 儲存體指派。 Kubernetes 資源已從 Satellite 位置的所有叢集中刪除，但配置會保留。

ibmcloud sat storage assignment rm --assignment ASSIGNMENT [-f] [-q]

指令選項

--assignment ASSIGNMENT: 指定 Satellite 儲存體指派的 ID。若要查找作業，請執行 ibmcloud sat storage assignment ls。
-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。

範例

移除 Satellite 儲存體指派。

ibmcloud sat storage assignment rm --assignment ASSIGNMENT -f -q

`ibmcloud sat storage assignment update`

更新 Satellite 儲存體指派。

ibmcloud sat storage assignment update --assignment ASSIGNMENT [-f] [--group GROUP ...] [--name NAME] [-q]

指令選項

--assignment ASSIGNMENT: 指定 Satellite 儲存體指派的 ID。
-f: 強制執行指令，而不出現使用者提示。
--group GROUP, -g GROUP: 指定要指派的新叢集群組。要列出可用的群組，請執行 ibmcloud sat group ls。
--name NAME: 提供 Satellite 儲存體指派的新名稱。
-q: 不要顯示日或更新提示的訊息。

範例

更新 Satellite 儲存體指派。

ibmcloud sat storage assignment update \
  --assignment ASSIGNMENT \
  --name NAME \
  --group GROUP

`ibmcloud sat storage config class add`

建立自訂 Satellite 儲存類別。

ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM [--param PARAM ...] [-q]

指令選項

--config-name NAME: 指定自訂儲存類別的儲存體配置名稱。若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。
--name NAME: 提供自訂儲存類別的名稱。
--param PARAM, -p PARAM: 請為儲存類別參數指定一組「key=value」對。若要查看儲存範本中的儲存類別參數，請執行 ibmcloud sat storage template get。
-q: 不要顯示日或更新提示的訊息。

範例

建立自訂 Satellite 儲存類別。

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

`ibmcloud sat storage config class get`

取得 Satellite 儲存類別的詳細資料。

ibmcloud sat storage config class get --class CLASS --config CONFIG [--output OUTPUT] [-q]

指令選項

--class CLASS: 指定 Satellite 儲存類別的名稱。
--config CONFIG: 指定 Satellite 儲存體配置的名稱或 ID。若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

取得 Satellite 儲存類別的詳細資料。

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

`ibmcloud sat storage config class ls`

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

ibmcloud sat storage config class ls --config CONFIG [--output OUTPUT] [-q] [--show-params]

指令選項

--config CONFIG: 指定 Satellite 儲存體配置的名稱或 ID。若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--show-params: 包括此選項可列出所有儲存類別參數詳細資料。

範例

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

ibmcloud sat storage config class ls \
  --config CONFIG \
  --show-params SHOW-PARAMS \
  --output json

`ibmcloud sat storage config create`

建立 Satellite 儲存體配置以在叢集中安裝儲存體驅動程式。

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME [--param PARAM ...] [-q] [--template-version VERSION]

指令選項

--location LOCATION: 輸入儲存體配置的位置 ID 或名稱。若要查詢可用的地點，請執行 ibmcloud sat location ls。
--name NAME: 指定儲存體配置的名稱。
--param PARAM, -p PARAM: 請為配置參數指定一組「key=value」對。若要檢視儲存範本中的設定參數，請執行 ibmcloud sat storage template get。
-q: 不要顯示日或更新提示的訊息。
--template-name NAME: 指定 Satellite 儲存體配置範本名稱。若要列出可用的儲存配置範本，請執行 ibmcloud sat storage template ls。
--template-version VERSION: 指定 Satellite 儲存體配置範本版本。如果您不包含此選項，則會使用預設版本。若要列出可用的儲存配置範本，請執行 ibmcloud sat storage template ls。

範例

建立 Satellite 儲存體配置以在叢集中安裝儲存體驅動程式。

ibmcloud sat storage config create \
  --name NAME \
  --template-name NAME \
  --template-version VERSION

`ibmcloud sat storage config get`

取得 Satellite 儲存體配置的詳細資料。

ibmcloud sat storage config get --config CONFIG [--output OUTPUT] [-q]

指令選項

--config CONFIG: 指定 Satellite 儲存體配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat storage config ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

取得 Satellite 儲存體配置的詳細資料。

ibmcloud sat storage config get --config CONFIG --output json -q

`ibmcloud sat storage config ls`

列出 IBM Cloud 帳戶中的 Satellite 儲存體配置。

ibmcloud sat storage config ls [--location LOCATION] [--output OUTPUT] [-q]

指令選項

--location LOCATION: 指定包含您要列出之配置的位置 ID 或名稱。若要查詢可用的地點，請執行 ibmcloud sat location ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 IBM Cloud 帳戶中的 Satellite 儲存體配置。

ibmcloud sat storage config ls --location LOCATION --output json -q

`ibmcloud sat storage config param set`

設定 Satellite 儲存體配置的配置及密碼參數。

ibmcloud sat storage config param set --config CONFIG --param PARAM [--param PARAM ...] [--apply] [-f] [-q]

指令選項

--apply: 將最新的 Satellite 儲存體配置版本套用至配置的所有指派。若要列出某個配置的指派項目，請執行 ibmcloud sat storage assignment ls --config CONFIG。
--config CONFIG: 指定儲存體配置的名稱或 ID。若要列出 Satellite 的儲存配置，請執行 ibmcloud sat storage config ls。
-f: 強制執行指令，而不出現使用者提示。
--param PARAM, -p PARAM: 請為配置參數指定一組「key=value」對。若要檢視儲存範本中的設定參數，請執行 ibmcloud sat storage template get。
-q: 不要顯示日或更新提示的訊息。

範例

設定 Satellite 儲存體配置的配置及密碼參數。

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

`ibmcloud sat storage config patch`

將最新的修補程式更新套用至 Satellite 儲存配置。修補程式更新項目包含相同主要版本內的漏洞補救及錯誤修正程式。

ibmcloud sat storage config patch --config CONFIG [-f] [--include-assignments] [-q]

別名：ibmcloud sat upgrade

指令選項

--config CONFIG: 指定 Satellite 儲存體配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat storage config ls。
-f: 強制執行指令，而不出現使用者提示。
--include-assignments: 若要將儲存配置的指派更新至最新配置版本，請勾選此選項。
-q: 不要顯示日或更新提示的訊息。

範例

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

ibmcloud sat storage config patch \
  --config CONFIG \
  --include-assignments INCLUDE-ASSIGNMENTS \
  -f

`ibmcloud sat storage config rm`

移除 Satellite 儲存體配置。

ibmcloud sat storage config rm --config CONFIG [-f] [--include-assignments] [-q]

指令選項

--config CONFIG: 指定 Satellite 儲存體配置的名稱或 ID。若要列出可用的設定，請執行 ibmcloud sat storage config ls。
-f: 強制執行指令，而不出現使用者提示。
--include-assignments: 包括此選項可移除儲存體配置以及任何相關聯的指派。
-q: 不要顯示日或更新提示的訊息。

範例

移除 Satellite 儲存體配置。

ibmcloud sat storage config rm \
  --config CONFIG \
  --include-assignments INCLUDE-ASSIGNMENTS \
  -f

`ibmcloud sat storage template get`

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

ibmcloud sat storage template get --name NAME --version VERSION [--output OUTPUT] [-q]

指令選項

--name NAME: 指定儲存體範本名稱。若要列出可用的儲存範本，請執行 ibmcloud sat storage template ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--version VERSION: 指定儲存體範本版本。若要列出可用的儲存範本，請執行 ibmcloud sat storage template ls。

範例

取得 Satellite 儲存範本的詳細資訊。

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

`ibmcloud sat storage template ls`

列出可用的 Satellite 儲存體範本。

ibmcloud sat storage template ls [-q]

指令選項

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

範例

列出可用的 Satellite 儲存體範本。

ibmcloud sat storage template ls -q

ibmcloud SAT 訂閱指令

檢視並管理 Satellite 訂閱以在叢集中部署 Kubernetes 配置檔。

`ibmcloud sat subscription create`

建立叢集的 Satellite 訂閱。建立訂閱之後，相關聯的 Satellite 配置版本會自動部署至已訂閱的叢集。

ibmcloud sat subscription create --config CONFIG --group GROUP [--group GROUP ...] --name NAME [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)

指令選項

--auth-required: 提供連接遠端儲存庫所需的鑑別密碼。如需詳細資料，請參閱 https://ibm.biz/sat-config-private-repo。策略：GitOps。
--config CONFIG: 指定要用於訂閱的配置名稱。若要查看可用的設定，請執行 ibmcloud sat config ls。
--gitref GITREF: 指定要用於 Satellite 訂閱的 GitRef。策略：GitOps。
--gitref-type TYPE: 指出要用於 Satellite 訂閱的 GitRef 類型。策略：GitOps。容許值 :branch、commit、tag、release
--group GROUP, -g GROUP: 指定叢集群組的名稱或 ID，以訂閱您的配置。若要查詢可用的叢集群組，請執行 ibmcloud sat group ls。
--name NAME: 輸入訂閱的名稱。
--path PATH: 提供遠端儲存庫中儲存庫檔案或發行資產的路徑，以用於 Satellite 訂閱。策略：GitOps。
-q: 不要顯示日或更新提示的訊息。
--repository REPOSITORY: 指定要用於訂閱的遠端儲存庫 URL。策略：GitOps。
--version VERSION: 指出要用於訂閱之現有配置版本的名稱或 ID。若要查詢版本，請執行 ibmcloud sat config get --config <configuration_name_or_ID>。策略：直接上傳。

範例

建立叢集的 Satellite 訂閱。

ibmcloud sat subscription create \
  --auth-required AUTH-REQUIRED \
  --name NAME \
  --group GROUP \
  --config CONFIG

`ibmcloud sat subscription get`

取得 Satellite 訂閱的詳細資訊。

ibmcloud sat subscription get --subscription SUBSCRIPTION [--output OUTPUT] [-q]

指令選項

--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。
--subscription SUBSCRIPTION: 請輸入「Satellite」訂閱的名稱或 ID。若要查找訂閱項目，請執行 ibmcloud sat subscription ls。

範例

取得 Satellite 訂閱的詳細資訊。

ibmcloud sat subscription get --subscription IP_ADDRESS --output json -q

`ibmcloud sat subscription identity set`

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

ibmcloud sat subscription identity set --subscription SUBSCRIPTION [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。
--subscription SUBSCRIPTION: 指定 Satellite 訂閱的名稱或 ID。若要列出訂閱項目，請執行 ibmcloud sat subscription ls。

範例

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

ibmcloud sat subscription identity set --subscription IP_ADDRESS -f -q

`ibmcloud sat subscription ls`

列出 IBM Cloud 帳戶中的所有 Satellite 訂閱。

ibmcloud sat subscription ls [--cluster CLUSTER] [--output OUTPUT] [-q]

指令選項

--cluster CLUSTER, -c CLUSTER: 指定 Satellite 叢集名稱或 ID。若要查找已註冊的叢集，請執行 ibmcloud sat cluster ls。
--output OUTPUT: 以提供的格式列印指令輸出。接受值: json
-q: 不要顯示日或更新提示的訊息。

範例

列出 IBM Cloud 帳戶中的所有 Satellite 訂閱。

ibmcloud sat subscription ls --cluster CLUSTER_NAME_OR_ID --output json -q

`ibmcloud sat subscription rm`

移除 Satellite 訂閱。 Kubernetes 資源不再部署至叢集。

ibmcloud sat subscription rm --subscription SUBSCRIPTION [-f] [-q]

指令選項

-f: 強制執行指令，而不出現使用者提示。
-q: 不要顯示日或更新提示的訊息。
--subscription SUBSCRIPTION: 提供 Satellite 訂閱的名稱或 ID。若要列出訂閱項目，請執行 ibmcloud sat subscription ls。

範例

移除 Satellite 訂閱。

ibmcloud sat subscription rm --subscription IP_ADDRESS -f -q

`ibmcloud sat subscription update`

更新 Satellite 訂閱。

ibmcloud sat subscription update --subscription SUBSCRIPTION [-f] [--group GROUP] [--name NAME] [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)

指令選項

--auth-required: 提供連接遠端儲存庫所需的鑑別密碼。策略：GitOps。
-f: 強制執行指令，而不出現使用者提示。
--gitref GITREF: 指定要用於 Satellite 訂閱的 GitRef。策略：GitOps。
--gitref-type TYPE: 指出要用於此 Satellite 訂閱的 GitRef 類型。策略：GitOps。容許值 :branch、commit、tag、release
--group GROUP, -g GROUP: 指定新的叢集群組以訂閱您的配置。
--name NAME: 提供 Satellite 訂閱的新名稱。
--path PATH: 指出遠端儲存庫中要用於 Satellite 訂閱的儲存庫檔案或發行資產的路徑。策略：GitOps。
-q: 不要顯示日或更新提示的訊息。
--repository REPOSITORY: 提供要用於 Satellite 訂閱的遠端儲存庫 URL。策略：GitOps。
--subscription SUBSCRIPTION: 指定 Satellite 訂閱的名稱或 ID。若要列出訂閱項目，請執行 ibmcloud sat subscription ls。
--version VERSION: 指出用於 Satellite 訂閱的現有配置版本。策略：直接上傳。

範例

更新 Satellite 訂閱。

ibmcloud sat subscription update \
  --auth-required AUTH-REQUIRED \
  --subscription IP_ADDRESS \
  --name NAME \
  --group GROUP