lbcli update volume

AI Tools

Updates volume properties.

Synopsis

This command is used to update the following properties of the volume: Name, ACL, IP-ACL, QoS policy, size, compression, labels, and name. Use only parameters that have to be updated. This is an async operation. The volume must be in Available state before applying this operation. During the update operation, and until all replicas of the volume are updated, the volume will appear in Updating state.

Update Volume Name

Each volume name must be unique within a given project. It is therefore not possible to create multiple volumes with the same name in the same project. The volume name can be modified using the update volume API with the --new-name flag.

Note

If you use the --new-name flag, it cannot be empty and can be up to 253 characters. The following are the allowed characters in volume name:

0–9
a–z
A–Z
. - _

lbcli update volume [options] [flags]

Examples:

lbcli update volume --uuid <uuid> --project-name=proj-a --acl label1,label2 --ip-acl 10.1.1.9,10.1.1.10 lbcli update volume --name <name> --project-name=proj-a --acl label1,label2 --ip-acl 10.1.1.9,10.1.1.10 lbcli update volume --name <name> --new-name <new-name> --project-name=proj-a lbcli -J $JWT update volume --project-name=proj-a --name volume_name --acl label1 lbcli -J $JWT update volume --project-name=proj-a --uuid <uuid> --compression true --qos-policy-uuid <qos-policy-uuid> lbcli -J $JWT update volume --project-name=proj-a --uuid <uuid> --size <smaller size than current> --force lbcli -J $JWT update volume --uuid <uuid> --project-name=proj-a --labels="new_key0=new_val0,new_key1=new_val1"

Flag	Short	Type	Description	Version
--help	-h	bool	Help for the update volume command.
--acl		stringSlice	The updated ACL assigned to the volume (optional).
--compression		string	The updated compression mode ('true'/'false') (optional).
--etag		string	An opaque identifier allowing a client to make conditional requests (optional).
--ip-acl		stringSlice	The updated IP Address ACL assigned to the volume (optional).
--labels		string	Update volume labels (optional). If labels are passed during volume update, the existing volume-labels are replaced with the new ones. Otherwise, the labels are untouched. The labels argument format is key0=val0,key1=val1,...keyN=valN, when the number of labels is limited to 16. Label-key and label-value length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9), hyphen (-), underscore (_), and period (.)
--name		string	Identify the volume to be updated by name (optional if using the uuid flag to identify the volume and required if UUID is not given).
--new-name		string	The new name to assign to the volume, used to change the volume's name (optional).	3.16.x and above
--qos-policy-uuid		string	The updated QoS policy UUID that will be assigned to the volume (optional).	(2.3.16 and above)
--qos-policy-name		string	The updated QoS policy name that will be assigned to the volume (optional).	(2.3.16 and above)
--size		string	Volume size in human-readable format (e.g., 3 GiB, 1024 MiB). Optional.
– project name		string	The project this volume belongs to (required; cannot be updated).	(2.1 and above)
--uuid		string	Volume UUID (required if name is not given). Cannot be updated.
--force		boolean	Force volume shrink. This must be set in order to intentionally shrink volume size (optional).	(3.01 and above)

Note

This is an async operation. The volume must be in Available state before applying this operation.

Note

Update/rollback/deletion of volumes can only be done on an active volume. See auto$ for additional information.

Last updated on

Was this page helpful?