ByCloud Docs
GuidesCLIAPISDK

Update volume

bycloud block-storage volumes update --volume_id <volume_id> [flags]

Update a volume's name, description, or metadata

Options

--volume_id

stringrequired

Volume ID

--output

(-o)

stringoptional

Output format: text, json, or yaml

Values: "text", "json", "yaml"

Default: "text"

Body Options

--description

stringoptional

--metadata

objectoptional

--name

stringoptional

Command

bycloud block-storage volumes update \
  --volume_id "abc-123"

Output

ID            550e8400-e29b-41d4-a716-446655440000
CRN           crn:spo1:storage:volume:550e8400-e29b-41d4-a716-446655440000
NAME          data-volume-01
DESCRIPTION   Primary data volume
STATUS        available
SIZE          100
VOLUME_TYPE   ssd
BOOTABLE      false
ENCRYPTED     false
MULTIATTACH   false
SOURCE_VOLID  550e8400-e29b-41d4-a716-446655440000
SNAPSHOT_ID   550e8400-e29b-41d4-a716-446655440000
IMAGE_ID      550e8400-e29b-41d4-a716-446655440000
ATTACHMENTS
  [0]
    ID            550e8400-e29b-41d4-a716-446655440000
    INSTANCE_ID   550e8400-e29b-41d4-a716-446655440001
    DEVICE        /dev/vdb
    ATTACHED_AT   2024-01-15T10:30:00Z
  [1]
    ID            550e8400-e29b-41d4-a716-446655440000
    INSTANCE_ID   550e8400-e29b-41d4-a716-446655440001
    DEVICE        /dev/vdb
    ATTACHED_AT   2024-01-15T10:30:00Z
METADATA
  ENVIRONMENT   production
  TEAM          backend
PROJECT_ID    550e8400-e29b-41d4-a716-446655440000
USER_ID       550e8400-e29b-41d4-a716-446655440000
CREATED_AT    2024-01-15T10:30:00Z
UPDATED_AT    2024-01-15T10:30:00Z