IBM CephaaS CLI

software-defined-storage

software-defined-storage - an OpenAPI definition for the IBM CephaaS CLI on the IBM Cloud platform.

ibmcloud software-defined-storage [command] [options]

Aliases of software-defined-storage: sds

Create volume

ibmcloud sds volume-create --capacity CAPACITY [--name NAME] --url string

Aliases of volume-create: volc

Example

ibmcloud sds volume-create \
    --capacity 10 \
    --name my-volume \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Capacity of the volume (in gigabytes).

  • Flag: --capacity CAPACITY

• Name of the volume.

  • Flag: --name NAME

  If you do not specify a name for the new volume, the system generates a name that is a hyphenated list of randomly selected words.

• API Endpoint in the URL form.

  • Flag: --url string

Retrieve a single volume details

ibmcloud sds volume --volume-id VOLUME-ID --url string

Aliases of volume: vol

Example command:

ibmcloud sds volume \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The volume identifier.

  • Flag: --volume-id VOLUME-ID

• API Endpoint in the URL form.

  • Flag: --url string

Update a volume

Use volume-update command along with the new information provided in volume patch parameter to update the volume capacity or the volume name.

You can change only one parameter value at a time in the command. More than one change in the same command is not supported.

ibmcloud sds volume-update --volume-id VOLUME-ID [--volume-patch VOLUME-PATCH | @VOLUME-PATCH-FILE] --url string

Aliases of volume-update: volu

Example command:

ibmcloud sds volume-update \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --capacity 38 \
    --name my-volume-updated \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The volume identifier.

  • Flag:--volume-id VOLUME-ID

• Capacity of the volume (in gigabytes).

  • Flag: --capacity CAPACITY

• Name of the volume.

  • Flag: --name NAME

• [Optional] JSON object that contains the volume information such as a path to a JSON file.

  • Flag: --volume-patch VOLUME-PATCH

• API Endpoint in the URL form.

  • Flag: --url string

Delete a single volume

ibmcloud sds volume-delete --volume-id VOLUME-ID --url string

Aliases of volume-delete: vold

Example command:

ibmcloud sds volume-delete \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The volume identifier.

  • Flag:--volume-id VOLUME-ID

• API Endpoint in the URL form.

  • Flag: --url string

List all volumes

ibmcloud sds volumes [--limit LIMIT] [--name NAME] --url string

Aliases of volumes: vols

Example command:

ibmcloud sds volumes \
    --limit 10 \
    --name my-volume \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The number of resources to return on a page. The default value is 1. The maximum limit value is 1000.

  • Flag: --limit int

• Filter by name from the resource collection. You can specify 0 to 200 characters in string length.

  • Flag: --name string

Create a new host

ibmcloud sds host-create --name NAME --nqn NQN [--volume-mappings VOLUME-MAPPINGS | @VOLUME-MAPPINGS-FILE] --url string

Aliases of host-create: hstc

Example command:

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

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• NVMe Qualified Name (NQN) of the host configured in the customer's environment. The maximum supported length is 223 bytes.

  • Flag: --nqn NQN

• Name for the new host. Ensure that the new name is unique.

  • Flag: --name NAME

  If you do not specify a name for the new host, the system generates a name that is a hyphenated list of randomly selected words.

• The unique identifier of the volume to be mapped to this host. Must be in the form [{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].

  • Flag: --volume-mappings VOLUME-MAPPINGS

• API Endpoint in the URL form.

  • Flag: --url string

Retrieve a single host

ibmcloud sds host --host-id HOST-ID --url string

Example command:

ibmcloud sds host \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to view

  • Flag: --host-id HOST-ID

• API Endpoint in the URL form.

  • Flag: --url string

List all hosts

ibmcloud sds hosts [--limit LIMIT] --url string

Aliases of hosts: hsts

Example command:

ibmcloud sds hosts \
    --limit 10 \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Number of resources to return on a page.

  • Flag: --limit LIMIT

• Including this option filters the collection of resources by name.

  • Flag: --name NAME

• API Endpoint in the URL form.

  • Flag: --url string

Update a host

ibmcloud sds host-update --host-id HOST-ID [--host-patch HOST-PATCH | @HOST-PATCH-FILE] --url string

Aliases of host-update: hstu

Example command:

ibmcloud sds host-update \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --name my-host
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to update

  • Flag: --host-id HOST-ID

• [Optional] Specify the JSON Merge-Patch content for host_update.

  • Flag: --host-patch HOST-PATCH

• Name for the new host. Ensure that the new name is unique.

  • Flag: --name NAME

  If you do not specify a name for the new host, the system generates a name that is a hyphenated list of randomly-selected words.

• API Endpoint in the URL form.

  • Flag: --url string

Map volume to a host

ibmcloud sds host-mapping-create --host-id HOST-ID [--volume (VOLUME | @VOLUME-FILE) | --volume-id VOLUME-ID]

Aliases of host-mapping-create: hstmc

Example command:

ibmcloud sds host-mapping-create \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume '{"id": "r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39"}' \
    --url $sds_endpoint

Or

ibmcloud sds host-mapping-create \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Specify the host ID whose details you want to view

  • Flag: --host-id HOST-ID

• Specify the unique volume identifier.

  • Flag: --volume-id VOLUME-ID

• The unique identifier of the volume to be mapped to this host. Must be in the form [{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].

  • Flag: --volume VOLUME-ID

• API Endpoint in the URL form.

  • Flag: --url string

View all host-mappings for a host

ibmcloud sds host-mappings --host-id HOST-ID

Aliases of host-mappings: hstms

Example command:

ibmcloud sds host-mappings \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to view

  • Flag: --host-id HOST-ID

• API Endpoint in the URL form.

  • Flag: --url string

View a single host mapping for a host

ibmcloud sds host-mapping --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID

Aliases of host-mapping: hstm

Example command:

ibmcloud sds host-mapping \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to view

  • Flag: --host-id HOST-ID

• Unique volume-mapping identifier. This ID can be found by viewing either the associated volume or host you'd like to complete this operation against.

  • Flag: --volume-mapping-id VOLUME-MAPPING_ID

• API Endpoint in the URL form.

  • Flag: --url string

Delete a host

ibmcloud sds host-delete --host-id HOST-ID --url string

Aliases of host-delete: hstd

Example command:

ibmcloud sds host-delete \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to view

  • Flag: --host-id HOST-ID

• API Endpoint in the URL form.

  • Flag: --url string

Delete a single volume mapping from a host

ibmcloud sds host-mapping-delete --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID

Aliases of host-mapping-delete: hstmd

Example command:

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

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to view

  • Flag: --host-id HOST-ID

• Unique volume-mapping identifier. This ID can be found by viewing either the associated volume or host you'd like to complete this operation against.

  • Flag: --volume-mapping-id VOLUME-MAPPING_ID

• API Endpoint in the URL form.

  • Flag: --url string

Delete all volume mappings associated with a host

ibmcloud sds host-mapping-delete-all --host-id HOST-ID

Aliases of host-vol-delete-all: hstmda

Example command:

ibmcloud sds host-mapping-delete-all \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Host ID whose details you want to view

  • Flag: --host-id HOST-ID

• API Endpoint in the URL form.

  • Flag: --url string

Create a service credential

Updates credentials for a storage account or creates them if they do not exist.

ibmcloud sds cred-create --access-key ACCESS-KEY --url string

Aliases of cred-create: crc

Example command:

ibmcloud sds cred-create \
    --access-key mytestkey
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Sets the access key for the service instance.

  • Flag: --access-key ACCESS-KEY

• API Endpoint in the URL form.

  • Flag: --url string

Delete a service credential

ibmcloud sds cred-delete --access-key ACCESS-KEY --url string

Aliases of cred-delete: crd

Example command:

ibmcloud sds cred-delete \
    --access-key mytestkey
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• Sets the access key for the service instance.

  • Flag: --access-key ACCESS-KEY

• API Endpoint in the URL form.

  • Flag: --url string

List service credential

Retrieves credentials for a specific storage account.

ibmcloud sds creds --url string

Aliases of creds: crl

Example command:

ibmcloud sds creds \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• API Endpoint in the URL form.
  • Flag: --url string

View certificate types

Retrieves the list of configured SSL Certificates.

ibmcloud sds cert-types --url string

Aliases of cert-types: crtt

Example command:

ibmcloud sds cert-types \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• API Endpoint in the URL form.
  • Flag: --url string

Create a certificate

Creates a new SSL Certificates if one does not exist.

ibmcloud sds cert-create --cert CERT --body BODY --url string

Aliases of cert-create: crtc

Example command:

ibmcloud sds cert-create \
    --cert s3 \
    --body tempdir/test-file.txt \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The request body that contains the TLS certificate. The CLI accepts certificate file in .pem format.

  • Flag: --body BODY

• The certificate type that is to be used in the request. Acceptable values include - s3.

  • Flag: --cert CERT

• API Endpoint in the URL form.

  • Flag: --url string

Update a certificate

Updates the existing SSL Certificate.

ibmcloud sds cert-update --cert CERT --body BODY --url string

Aliases of cert-update: crtu

Example command:

ibmcloud sds cert-update \
    --cert s3 \
    --body tempdir/test-file.pem \
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The request body that contains the TLS certificate. The CLI accepts certificate file in .pem format.

  • Flag: `--body BODY

• The certificate type that is to be used in the request. Acceptable values include - s3.

  • Flag: --cert CERT

• API Endpoint in the URL form.

  • Flag: --url string

Retrieve certificate details

Retrieves the SSL certificate expiration date and status.

ibmcloud sds cert --cert CERT --url string

Example command:

ibmcloud sds cert \
    --cert s3
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The certificate type that is to be used in the request. Acceptable values include - s3.

  • Flag: --cert CERT

• API Endpoint in the URL form.

  • Flag: --url string

Delete certificate

Deletes the SSL certificate.

ibmcloud sds cert-delete --cert CERT --url string

Aliases of cert-delete: crtd

Example command:

ibmcloud sds cert-delete \
    --cert s3
    --url $sds_endpoint

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM CephaaS was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

Parameters to provide:

• The certificate type that is to be used in the request. Acceptable values include - s3.

  • Flag: --cert CERT

• API Endpoint in the URL form.

  • Flag: --url string

Config command options

• get - Retrieves the currently set configured value of an option.

• list - Retrieves all the currently set configured values.

• set - Set a config value for an option.

• unset - Unset the config value of an option.

Retrieve configuration values

Use get option with config command to retrieve the currently set value for a specific option.

When Get option is used together with url option, the currently set value for the 'url' option is retrieved.

ibmcloud sds config get url

See example output.

pc@mac ~ % ibmcloud sds config get url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1

List all configuration values

Use List option with config command to retrieve and view all of the currently set configured values.

ibmcloud sds config list

See example output.

pc@mac ~ % ibmcloud sds config list
url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1

Set new config values

Use set option with config command to configure new values for a specific option.

ibmcloud sds config set [option]

When set option is used together with url option, the value for the 'url' option is set.

See example with url option.

pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
OK

Unset config values

Use unset option with config command to reset the current configured values for a specific option.

ibmcloud sds config unset [option]

When unset option is used together with url option, the currently configured value for the 'url' option is reset.

See example with url option.

ibmcloud sds config unset url

pc@mac ~ % ibmcloud sds config unset url
OK