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 命令行界面入门指南》。

该插件兼容运行于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- IBM Cloud 平台上 IBM Storage Ceph as a Service CLI 的 OpenAPI 定义。

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 的指南，请参阅配置命令。

要提供的参数：

该卷的容量（以千兆字节为单位）。
- 旗帜：--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

要提供的参数：

音量标识符。
- 旗帜：--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

要提供的参数：

音量标识符。
- 旗帜：--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

要提供的参数：

音量标识符。
- 旗帜：--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

要提供的参数：

页面上要返回的资源数量。缺省值为 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

要提供的参数：

在客户环境中配置的主机NVMe Qualified Name（NQN）。最大支持长度为223字节。
- 旗帜：--nqn NQN
新主持人的名字。请确保新名称是唯一的。
- 旗帜：--name NAME
如果您没有为新主机指定名称，系统将随机生成一个由多个单词组成的名称。
新主机的 PSK。传输层安全（TLS）预共享密钥密码套件（ 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

要提供的参数：

您想查看其详细信息的主持人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

要提供的参数：

每页要返回的资源数量。
- 旗帜：--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

要提供的参数：

您想要更新其详细信息的主持人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

要提供的参数：

指定要查看其详细信息的主机 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

要提供的参数：

您想查看其详细信息的主持人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

要提供的参数：

您想查看其详细信息的主持人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

要提供的参数：

您想查看其详细信息的主持人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

要提供的参数：

您想查看其详细信息的主持人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

要提供的参数：

您想查看其详细信息的主持人ID
- 旗帜：--host-id HOST-ID
URL 格式的API端点。
- 旗帜：--url string

对象存储器

`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

要提供的参数：

设置服务实例的访问密钥。
- 旗帜：--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

要提供的参数：

设置服务实例的访问密钥。
- 旗帜：--access-key ACCESS-KEY
URL 格式的API端点。
- 旗帜：--url string

`ibmcloud sds creds`

使用此命令检索特定存储帐户的凭据。

ibmcloud sds creds --url string

creds 的别名：crl

示例命令：

ibmcloud sds creds \
    --url $sds_endpoint

要提供的参数：

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

要提供的参数：

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

要提供的参数：

包含 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

要提供的参数：

包含 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

要提供的参数：

申请中使用的证书类型。允许的值包括：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

要提供的参数：

申请中使用的证书类型。允许的值包括：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

要提供的参数：

需要创建新快照的块卷 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

要提供的参数：

要检索详细信息的快照标识符。
- 旗帜：--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

要提供的参数：

以下参数为可选参数。

指定结果页面的起始资源 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

要提供的参数：

(必填）要更新的快照的唯一标识符。
- 旗帜：--snap-id
指定需要更新的快照名称。
- 旗帜：--name
提供用于更新快照的 JSON 合并补丁内容。可以是直接在命令中输入的 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

要提供的参数：

强制执行该命令
- 标志：-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

要提供的参数：

强制执行该命令
- 标志：-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，获取更多有关可运行命令的信息。