====== volume ====== Block Storage v1, v2 volume create ------------- Create new volume .. program:: volume create .. code:: bash os volume create [--size ] [--type ] [--image | --snapshot | --source | --source-replicated ] [--description ] [--user ] [--project ] [--availability-zone ] [--consistency-group ] [--property [...] ] [--hint [...] ] [--multi-attach] .. option:: --size Volume size in GB (Required unless --snapshot or --source or --source-replicated is specified) .. option:: --type Set the type of volume Select :option:`\` from the available types as shown by ``volume type list``. .. option:: --image Use :option:`\` as source of volume (name or ID) This is commonly used to create a boot volume for a server. .. option:: --snapshot Use :option:`\` as source of volume (name or ID) .. option:: --source Volume to clone (name or ID) .. option:: --source-replicated Replicated volume to clone (name or ID) .. option:: --description Volume description .. option:: --user Specify an alternate user (name or ID) .. option:: --project Specify an alternate project (name or ID) .. option:: --availability-zone Create volume in :option:`\` .. option:: --consistency-group Consistency group where the new volume belongs to .. option:: --property Set a property on this volume (repeat option to set multiple properties) .. option:: --hint Arbitrary scheduler hint key-value pairs to help boot an instance (repeat option to set multiple hints) .. option:: --multi-attach Allow volume to be attached more than once (default to False) .. _volume_create-name: .. describe:: Volume name The :option:`--project` and :option:`--user` options are typically only useful for admin users, but may be allowed for other users depending on the policy of the cloud and the roles granted to the user. volume delete ------------- Delete volume(s) .. program:: volume delete .. code:: bash os volume delete [--force | --purge] [ ...] .. option:: --force Attempt forced removal of volume(s), regardless of state (defaults to False) .. option:: --purge Remove any snapshots along with volume(s) (defaults to False) *Volume version 2 only* .. _volume_delete-volume: .. describe:: Volume(s) to delete (name or ID) volume list ----------- List volumes .. program:: volume list .. code:: bash os volume list [--project [--project-domain ]] [--user [--user-domain ]] [--name ] [--status ] [--all-projects] [--long] [--limit ] [--marker ] .. option:: --project Filter results by :option:`\` (name or ID) (admin only) *Volume version 2 only* .. option:: --project-domain Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. *Volume version 2 only* .. option:: --user Filter results by :option:`\` (name or ID) (admin only) *Volume version 2 only* .. option:: --user-domain Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. *Volume version 2 only* .. option:: --name Filter results by volume name .. option:: --status Filter results by status .. option:: --all-projects Include all projects (admin only) .. option:: --long List additional fields in output .. option:: --limit Maximum number of volumes to display .. option:: --marker The last volume ID of the previous page *Volume version 2 only* volume migrate -------------- Migrate volume to a new host .. program:: volume migrate .. code:: bash os volume migrate --host [--force-host-copy] [--lock-volume | --unlock-volume] .. option:: --host Destination host (takes the form: host@backend-name#pool) (required) .. option:: --force-host-copy Enable generic host-based force-migration, which bypasses driver optimizations .. option:: --lock-volume If specified, the volume state will be locked and will not allow a migration to be aborted (possibly by another operation) *Volume version 2 only* .. option:: --unlock-volume If specified, the volume state will not be locked and the a migration can be aborted (default) (possibly by another operation) *Volume version 2 only* .. _volume_migrate-volume: .. describe:: Volume to migrate (name or ID) volume set ---------- Set volume properties .. program:: volume set .. code:: bash os volume set [--name ] [--size ] [--description ] [--property [...] ] [--image-property [...] ] [--state ] [--bootable | --non-bootable] [--read-only | --read-write] .. option:: --name New volume name .. option:: --size Extend volume size in GB .. option:: --description New volume description .. option:: --property Set a property on this volume (repeat option to set multiple properties) .. option:: --bootable Mark volume as bootable .. option:: --non-bootable Mark volume as non-bootable .. option:: --read-only Set volume to read-only access mode .. option:: --read-write Set volume to read-write access mode .. option:: --image-property Set an image property on this volume (repeat option to set multiple image properties) Image properties are copied along with the image when creating a volume using :option:`--image`. Note that these properties are immutable on the image itself, this option updates the copy attached to this volume. *Volume version 2 only* .. option:: --state New volume state ("available", "error", "creating", "deleting", "in-use", "attaching", "detaching", "error_deleting" or "maintenance") (admin only) (This option simply changes the state of the volume in the database with no regard to actual status, exercise caution when using) *Volume version 2 only* .. _volume_set-volume: .. describe:: Volume to modify (name or ID) volume show ----------- Show volume details .. program:: volume show .. code:: bash os volume show .. _volume_show-volume: .. describe:: Volume to display (name or ID) volume unset ------------ Unset volume properties .. program:: volume unset .. code:: bash os volume unset [--property ] [--image-property ] .. option:: --property Remove a property from volume (repeat option to remove multiple properties) .. option:: --image-property Remove an image property from volume (repeat option to remove multiple image properties) *Volume version 2 only* .. _volume_unset-volume: .. describe:: Volume to modify (name or ID)