IBM Cloud Docs
Renaming a block volume

Renaming a block volume

Renaming volumes help to improve organization, clarity, and accessibility, contributing to more efficient and effective management. You can rename a block storage volume in the UI, from the CLI, using the API or Terraform.

Renaming block volume in the UI

To manage your Block storage volumes, you can use the IBM Cloud console.

Renaming a volume from list view page

To rename a volume, complete the following steps.

  1. Go to the list of all Block storage volumes.

  2. Locate the volume and click the options icon at the end of the volume row to open a list of options.

  3. From the options menu, click Rename volume.

  4. Provide a valid volume name.

    Valid volume names can include a combination of lowercase alpha-numeric characters (a-z, 0-9) and the hyphen (-), up to 63 characters. Volume names must begin with a lowercase letter. It must not begin with a hypen or a number nor end with a hyphen. For example, if you create two volumes with the same name in the same deployment, an error "volume name exists" is displayed.

  5. Click Rename.

Renaming block volume from the CLI

To manage your Block storage volumes, you can use the volume-update command to rename the volumes.

Specify the volume ID, and new name of the volume along with the endpoint when running the following command for updating the name of a volume.

ibmcloud software-defined-storage volume-update --volume-id VOLUME-ID --name NAME --url string

See the following example.

ibmcloud sds volume-update --volume-id r134-601e431b-22ab-47a1-b0c1-411049b432a0 --name new-vol --url $sds_endpoint
...

Volume_ID     r134-601e431b-22ab-47a1-b0c1-411049b432a0
Volume_Name   new-vol
Status        available
Bandwidth     19
Capacity_GB   10
Created       2025-02-27T10:14:42.000Z
IOPS          150
Hosts         -

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.

You can also use the alias sds as an alternative to software-defined-storage and volu as an alternative to volume-update for the CLI actions.

Renaming block volume with the API

Make a PATCH /volumes/{id} request to update or rename a volume.

PATCH operation to change more than one parameter value in the same command is not supported.

curl -X PATCH $sds_endpoint/volumes/r134-601e431b-22ab-47a1-b0c1-411049b432a0\
    -H 'accept: application/json'\
    -H "Authorization: Bearer $IAM_TOKEN"\
    -H 'IBM-API-Version: 2025-02-01'\
    --data '{
        "name": "sds-vol-updated"
    }'

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.

A successful response looks like this:

{
  "id": "r134-601e431b-22ab-47a1-b0c1-411049b432a0",
  "name": "vol-renamed",
  "capacity": 10,
  "iops": 150,
  "status": "available",
  "created_at": "2025-02-27T10:14:42Z",
  "status_reasons": [],
  "bandwidth": 19,
  "resource_type": "volume",
  "href": "$sds_endpoint/volumes/r134-601e431b-22ab-47a1-b0c1-411049b432a0"
}

Renaming block volume using Terraform

To rename the volume, do the following steps:

  1. Open your main.tf file and modify the name value in the ibm_sds_volume resource.

  2. After editing and saving the file, run terraform plan and terraform apply to apply your changes.

You can modify only one parameter value at a time.