IBM Storage Ceph as a Service CLI
IBM Storage Ceph as a Service 外掛程式擴充了 IBM Cloud 指令行介面 (CLI),讓您能夠執行指令,為服務執行各種作業,包括但不限於管理磁碟區、主機、對應、物件憑證和憑證。
必要條件
在使用 IBM Storage Ceph as a Service CLI 外掛程式之前,您必須先安裝 IBM Cloud CLI,登入 CLI,然後安裝 software-defined-storage CLI 外掛程式。 有關如何安裝 IBM Cloud CLI 的說明,請參閱《 IBM Cloud CLI 入門指南 》。
此外掛程式相容於搭載 64 位元處理器的 linux64、Windows® 及 macOS® 平台。
請使用 plugin install 指令安裝此外掛程式:
ibmcloud plugin install software-defined-storage
安裝完畢後,您可以執行「軟體定義儲存」外掛程式來驗證安裝是否成功,系統將顯示以下說明:
ibmcloud software-defined-storage --help
輸出內容列出了 USAGE 說明及受支援的指令。
更新外掛程式
請使用 plugin update 指令來更新外掛程式。
ibmcloud plugin update software-defined-storage
下載最新的外掛程式版本,並取代您目前的外掛程式服務指令。 如果沒有可用的新更新,則會顯示訊息 No updates are available。
當 IBM Cloud CLI 和外掛程式的更新可用時,您會收到命令列通知。 請務必更新您的 CLI,以便使用最新的指令。 您可以執行 ibmcloud plugin list 查看所有已安裝外掛程式的目前版本。
指令索引
每項操作均附有說明,內容包含其功能、使用方式,以及任何可選或必填的參數。 除非指定為選用參數,否則所有列出的參數都是必要參數。
CLI 外掛程式尚未支援軟體定義儲存的全套功能。
軟體定義儲存
software-defined-storage- 一個 OpenAPI 定義,用於 IBM Cloud 平台上的 IBM Storage Ceph as a Service CLI。
ibmcloud software-defined-storage [command] [options]
software-defined-storage 的別名:sds
Block Storage
ibmcloud sds volume-create
請使用此指令建立一個具有指定容量的全新磁區。
ibmcloud sds volume-create --capacity CAPACITY [--name NAME] [--source-snapshot (SOURCE-SNAPSHOT | @SOURCE-SNAPSHOT-FILE) | --source-snapshot-id SOURCE-SNAPSHOT-ID]
volume-create 的別名:volc
範例:建立新卷
ibmcloud sds volume-create \
--capacity 10 \
--name my-volume \
--url $sds_endpoint
範例:從快照還原卷
ibmcloud sds volume-create \
--name test-volume-restored \
--source-snapshot-id r134-eda57df4-41f2-48d8-812d-3d81955b6a1a \
--capacity 10 \
--url $sds_endpoint
從快照還原卷時,其容量必須等於或大於原始卷的容量。
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
該儲存裝置的容量(以吉字節為單位)。
- 旗幟
--capacity CAPACITY
- 旗幟
-
磁區的名稱。
- 旗幟
--name NAME
如果您未指定新卷的名稱,系統會生成一個由隨機選取的連字節清單組成的名稱。
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
-
此卷建立的來源快照。
- 旗幟
--source-snapshot
如果要從快照建立磁碟區,請使用此選項。
- 旗幟
-
資源的唯一快照識別碼。
- 旗幟
--source-snapshot-id
如果要從快照建立磁碟區,請使用此選項。
- 旗幟
ibmcloud sds volume
請使用此指令來檢視單一卷的詳細資訊。
ibmcloud sds volume --volume-id VOLUME-ID --url string
volume 的別名:vol
範例指令:
ibmcloud sds volume \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
卷標識符。
- 旗幟
--volume-id VOLUME-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds volume-update
請搭配「卷補丁」參數中提供的最新資訊,使用此指令來更新卷容量或卷名稱。
在指令中一次只能變更一個參數值。 不支援在同一個指令中進行多個變更。
ibmcloud sds volume-update --volume-id VOLUME-ID [--volume-patch VOLUME-PATCH | @VOLUME-PATCH-FILE] --url string
volume-update 的別名:volu
範例指令:
ibmcloud sds volume-update \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--capacity 38 \
--name my-volume-updated \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
卷標識符。
- 旗幟
--volume-id VOLUME-ID
- 旗幟
-
該儲存裝置的容量(以吉字節為單位)。
- 旗幟
--capacity CAPACITY
- 旗幟
-
磁區的名稱。
- 旗幟
--name NAME
- 旗幟
-
[可選的] JSON 物件,包含卷資訊,例如 JSON 檔案的路徑。
- 旗幟
--volume-patch VOLUME-PATCH
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds volume-delete
請使用此指令刪除單一磁區。
ibmcloud sds volume-delete --volume-id VOLUME-ID --url string
volume-delete 的別名:vold
範例指令:
ibmcloud sds volume-delete \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
卷標識符。
- 旗幟
--volume-id VOLUME-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds volumes
使用這個指令來列出所有磁區。
ibmcloud sds volumes --help [--limit LIMIT] [--name NAME] --url string
volumes 的別名:vols
範例指令:
ibmcloud sds volumes --help \
--limit 10 \
--name my-volume \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
一頁中要回傳的資源數量。 預設值是 1。 最大限值為 1000。
- 旗幟
--limit int
- 旗幟
-
從資源集合中依名稱篩選。 您可以指定 0 到 200 個字元的字串長度。
- 旗幟
--name string
- 旗幟
主機
ibmcloud sds host-create
請使用此指令來建立一個新主機。
ibmcloud sds host-create --name NAME --nqn NQN [--volume-mappings VOLUME-MAPPINGS | @VOLUME-MAPPINGS-FILE] --url string --psk string
host-create 的別名:hstc
範例指令:
ibmcloud sds host-create \
--name my-host \
--nqn nqn.2014-06.org:9345 \
--volume-mappings '[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}]' \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
客戶環境中配置的主機的 NVMe Qualified Name (NQN)。 最大支援長度為 223 位元組。
- 旗幟
--nqn NQN
- 旗幟
-
新主機的名稱。 請確保新名稱是唯一的。
- 旗幟
--name NAME
如果您未指定新主機的名稱,系統會生成一個由隨機選取的連字節清單組成的名稱。
- 旗幟
-
新主機的 PSK。 傳輸層安全性預共享金鑰加密套件( TLS-PSK)是一組基於預共享金鑰(PSK)提供安全通訊的加密協定。
- 旗幟
--psk string
- 旗幟
-
要對應到此主機的磁碟區的唯一識別碼。 必須為
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}]形式。- 旗幟
--volume-mappings VOLUME-MAPPINGS
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host
請使用此指令來擷取單一主機的詳細資訊。
ibmcloud sds host --host-id HOST-ID --url string
範例指令:
ibmcloud sds host \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds hosts
請使用此指令列出所有主機。
ibmcloud sds hosts [--limit LIMIT] --url string
hosts 的別名:hsts
範例指令:
ibmcloud sds hosts \
--limit 10 \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
每頁要回傳的資源數量。
- 旗幟
--limit LIMIT
- 旗幟
-
包含此選項可依名稱過濾資源集合。
- 旗幟
--name NAME
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-update
請使用此指令來更新主機。
ibmcloud sds host-update --host-id HOST-ID [--host-patch HOST-PATCH | @HOST-PATCH-FILE] --url string
host-update 的別名:hstu
範例指令:
ibmcloud sds host-update \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name my-host
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要更新其詳細資料的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
[可選]為
host_update指定 JSON 合併補丁內容。- 旗幟
--host-patch HOST-PATCH
- 旗幟
-
新主機的名稱。 請確保新名稱是唯一的。
- 旗幟
--name NAME
如果您沒有指定新主機的名稱,系統會產生一個由隨機選取的連字節清單組成的名稱。
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-mapping-create
請使用此指令將卷映射至主機。
ibmcloud sds host-mapping-create --host-id HOST-ID [--volume (VOLUME | @VOLUME-FILE) | --volume-id VOLUME-ID]
host-mapping-create 的別名:hstmc
範例指令:
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume '{"id": "r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39"}' \
--url $sds_endpoint
或者
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
指定您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
指定唯一的磁碟區識別碼。
- 旗幟
--volume-id VOLUME-ID
- 旗幟
-
要對應到此主機的磁碟區的唯一識別碼。 必須為
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}]形式。- 旗幟
--volume VOLUME-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-mappings
使用此指令可檢視某個主機的所有主機映射。
ibmcloud sds host-mappings --host-id HOST-ID
host-mappings 的別名:hstms
範例指令:
ibmcloud sds host-mappings \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-mapping
使用此指令可檢視某個主機的單一主機映射。
ibmcloud sds host-mapping --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
host-mapping 的別名:hstm
範例指令:
ibmcloud sds host-mapping \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
唯一的卷映射識別碼。 此 ID 可透過檢視您要針對其完成此作業的相關磁碟區或主機來找到。
- 旗幟
--volume-mapping-id VOLUME-MAPPING_ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-delete
請使用此指令刪除主機。
ibmcloud sds host-delete --host-id HOST-ID --url string
host-delete 的別名:hstd
範例指令:
ibmcloud sds host-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-mapping-delete
使用此指令可從主機中刪除單一卷映射。
ibmcloud sds host-mapping-delete --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
host-mapping-delete 的別名:hstmd
範例指令:
ibmcloud sds host-mapping-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
唯一的卷映射識別碼。 此 ID 可透過檢視您要針對其完成此作業的相關磁碟區或主機來找到。
- 旗幟
--volume-mapping-id VOLUME-MAPPING_ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds host-mapping-delete-all
使用此指令可刪除與某個主機相關的所有卷宗映射。
ibmcloud sds host-mapping-delete-all --host-id HOST-ID
host-vol-delete-all 的別名:hstmda
範例指令:
ibmcloud sds host-mapping-delete-all \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
您要檢視其詳細資訊的主機 ID
- 旗幟
--host-id HOST-ID
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
Object Storage
ibmcloud sds cred-create
請使用此指令來更新儲存帳戶的憑證,若憑證不存在,則可藉此建立。
ibmcloud sds cred-create --access-key ACCESS-KEY --url string
cred-create 的別名:crc
範例指令:
ibmcloud sds cred-create \
--access-key mytestkey
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
設定服務實例的存取金鑰。
- 旗幟
--access-key ACCESS-KEY
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds cred-delete
請使用此指令刪除服務憑證。
ibmcloud sds cred-delete --access-key ACCESS-KEY --url string
cred-delete 的別名:crd
範例指令:
ibmcloud sds cred-delete \
--access-key mytestkey
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
設定服務實例的存取金鑰。
- 旗幟
--access-key ACCESS-KEY
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds creds
請使用此指令來擷取特定儲存帳戶的憑證。
ibmcloud sds creds --url string
creds 的別名:crl
範例指令:
ibmcloud sds creds \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
- URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds cert-types
請使用此指令來檢視已設定的「SSL」憑證類型的清單。
ibmcloud sds cert-types --url string
cert-types 的別名:crtt
範例指令:
ibmcloud sds cert-types \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
- URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds cert-create
若尚未存在,請使用此指令建立新的「SSL」憑證。
ibmcloud sds cert-create --cert CERT --body BODY --url string
cert-create 的別名:crtc
範例指令:
ibmcloud sds cert-create \
--cert s3 \
--body tempdir/test-file.txt \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
包含 TLS 憑證的請求正文。 CLI 接受
.pem格式的證書檔案。- 旗幟
--body BODY
- 旗幟
-
在請求中使用的憑證類型。 可接受的值包括:s3。
- 旗幟
--cert CERT
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds cert-update
請使用此指令來更新現有的「SSL」憑證。
ibmcloud sds cert-update --cert CERT --body BODY --url string
cert-update 的別名:crtu
範例指令:
ibmcloud sds cert-update \
--cert s3 \
--body tempdir/test-file.pem \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
包含 TLS 憑證的請求正文。 CLI 接受
.pem格式的證書檔案。- 旗幟
--body BODY
- 旗幟
-
在請求中使用的憑證類型。 可接受的值包括:s3。
- 旗幟
--cert CERT
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds cert
請使用此指令查詢「SSL」憑證的到期日期與狀態。
ibmcloud sds cert --cert CERT --url string
範例指令:
ibmcloud sds cert \
--cert s3
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
在請求中使用的憑證類型。 可接受的值包括:s3。
- 旗幟
--cert CERT
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
ibmcloud sds cert-delete
請使用此指令刪除「SSL」憑證。
ibmcloud sds cert-delete --cert CERT --url string
cert-delete 的別名:crtd
範例指令:
ibmcloud sds cert-delete \
--cert s3
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
在請求中使用的憑證類型。 可接受的值包括:s3。
- 旗幟
--cert CERT
- 旗幟
-
URL 表單中的 API 端點。
- 旗幟
--url string
- 旗幟
快照指令
ibmcloud sds volume-snapshot-create
請使用此指令來建立卷的快照。
ibmcloud sds volume-snapshot-create [--source-volume (SOURCE-VOLUME | @SOURCE-VOLUME-FILE) | --source-volume-id SOURCE-VOLUME-ID] [--name NAME]
volume-snapshot-create 的別名:vsnapc
範例指令:
ic sds volume-snapshot-create --source-volume-id r134-87a59338-a801-4090-a657-72867fc9ba44
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
需要建立新快照的區塊磁碟區 ID。
- 旗幟
--source-volume-id
- 旗幟
-
快照的唯一名稱。 選用參數。
- 旗幟
--name
- 旗幟
ibmcloud sds volume-snapshot
請使用此指令來擷取單一快照的詳細資訊。
ibmcloud sds volume-snapshot --snap-id SNAP-ID
volume-snapshot 的別名:vsnap
範例指令:
ibmcloud sds volume-snapshot \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
- 您要擷取詳細資訊的快照識別碼。
- 旗幟
--snap-id
- 旗幟
ibmcloud sds volume-snapshots
請使用此指令列出所有快照。
ibmcloud sds volume-snapshots [--start START] [--limit LIMIT] [--name NAME] [--source-volume-id SOURCE-VOLUME-ID]
volume-snapshots 的別名:vsnaps
範例指令:
ibmcloud sds volume-snapshots \
--start r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--limit 20 \
--name my-host \
--source-volume-id exampleString \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
以下參數為可選項。
-
指定從哪個資源 ID 開始顯示結果頁面。 有助於在大型資料庫中進行分頁。
- 旗幟
--start
- 旗幟
-
設定每頁返回的最大資源(快照)數量。
- 旗幟
--limit
- 旗幟
-
過濾結果,只包含名稱符合所提供字串的快照。
- 旗幟
--name
- 旗幟
-
篩選結果,使其只包含屬於指定來源磁碟區 ID 的快照。
- 旗幟
source-volume-id
- 旗幟
-
列出磁碟區快照時,此選項會自動進行多次請求,以擷取並顯示所有結果頁面,因此您可以看到整個集合,而無需手動翻閱結果。
- 旗幟
all-pages
- 旗幟
ibmcloud sds volume-snapshot-update
請使用此指令來更新快照。
ibmcloud sds volume-snapshot-update --snap-id SNAP-ID [--snapshot-patch SNAPSHOT-PATCH | @SNAPSHOT-PATCH-FILE]
volume-snapshot-update 的別名:vsnapu
範例指令:
ibmcloud sds volume-snapshot-update \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name snap-2-updated \
--url $sds_endpoint
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
(必要)您要更新的快照的唯一識別碼。
- 旗幟
--snap-id
- 旗幟
-
指定需要更新的快照名稱。
- 旗幟
--name
- 旗幟
-
提供更新快照的 JSON Merge-Patch 內容。 這可以是直接在指令中的 JSON 字串,或是包含修補程式資料的 JSON 檔案路徑。 這可讓您更新快照的特定欄位。
- 旗幟
--snapshot-patch
- 旗幟
ibmcloud sds volume-snapshot-delete
請使用此指令刪除單一快照。
ibmcloud sds volume-snapshot-delete --snap-id SNAP-ID
volume-snapshot-delete 的別名:vsnapd
範例指令:
ibmcloud sds volume-snapshot-delete \
--snap-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
--url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
強制執行該指令
- 旗標:
-f、--force
- 旗標:
-
您要刪除的快照唯一識別碼。
- 旗幟
--snap-id
- 旗幟
ibmcloud sds volume-snapshots-delete
請使用此指令刪除某個卷的所有快照。
ibmcloud sds volume-snapshots-delete [--source-volume-id SOURCE-VOLUME-ID]
volume-snapshots-delete 的別名:vsnapsd
範例指令:
ibmcloud sds volume-snapshots-delete \
--source-volume-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
--url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK
$sds_endpoint 是一個環境變數,指向 IBM Storage Ceph as a Service 設定時提供給您的端點。 它以 URL 的形式存在。 例如,https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1。 您可以一次設定 URL,之後就不必為每個指令都加上。
有關如何設定 URL 的指引,請參閱 Config 命令。
要提供的參數:
-
強制執行該指令
- 旗標:
-f、--force
- 旗標:
-
篩選操作,使其只影響具有與指定標識符相符的
source_volume-id屬性的資源 (例如快照)。 用於針對特定磁碟區的所有快照。- 旗幟
--source-volume-id
- 旗幟
配置指令
Config 指令可用於控制或檢視全局選項的持續設定。
若要控制或檢視持久設定,請執行 ibmcloud sds config 指令以及全局選項,以列出、設定或取消設定值。
您可以設定 url 變數,使您在使用 sds 指令時,不需要使用 --url 標誌。
ibmcloud sds config
設定 url 選項的範例。
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
OK
範例說明如何在沒有設定組態的情況下使用該命令。
pc@mac ~ % ibmcloud sds volumes --url $endpoint
範例顯示如何在 url 已設定的情況下使用該命令。
pc@mac ~ % ibmcloud sds volumes
組態指令選項
-
get- 擷取選項目前設定的組態值。 -
list- 擷取所有目前設定的組態值。 -
set- 為某個選項設定配置值。 -
unset- 取消設定某個選項的配置值。
ibmcloud sds config get
請使用此指令來擷取特定選項的當前設定值。
當 Get 選項與 url 選項一起使用時,會擷取「url」選項目前設定的值。
ibmcloud sds config get url
請參閱範例輸出。
pc@mac ~ % ibmcloud sds config get url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config list
請使用此指令來擷取並檢視所有目前已設定的配置值。
ibmcloud sds config list
請參閱範例輸出。
pc@mac ~ % ibmcloud sds config list
url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config set
請使用此指令為特定選項設定新值。
ibmcloud sds config set [url]
當 set 選項與 url 選項一起使用時,'url' 選項的值會被設定。
請參閱 url 選項的範例。
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config unset
請使用此指令,以重設特定選項的當前設定值。
ibmcloud sds config unset [url]
當 unset 選項與 url 選項一起使用時,'url' 選項目前設定的值會被重設。
下一步
執行 ibmcloud sds --help,以取得更多關於您可以執行哪些指令的資訊。