python-openstackclient/doc/source/command-objects/volume.rst

volume

Block Storage v1, v2

volume create

Create new volume

volume create

os volume create
    --size <size>
    [--snapshot <snapshot>]
    [--description <description>]
    [--type <volume-type>]
    [--user <user>]
    [--project <project>]
    [--availability-zone <availability-zone>]
    [--image <image>]
    [--source <volume>]
    [--property <key=value> [...] ]
    <name>

--size <size> (required)

New volume size in GB

--snapshot <snapshot>

Use <snapshot> as source of new volume

--description <description>

New volume description

--type <volume-type>

Use <volume-type> as the new volume type

--user <user>

Specify an alternate user (name or ID)

--project <project>

Specify an alternate project (name or ID)

--availability-zone <availability-zone>

Create new volume in <availability-zone>

--image <image>

Use <image> as source of new volume (name or ID)

--source <source>

Volume to clone (name or ID)

--property <key=value>

Set a property on this volume (repeat option to set multiple properties)

<name>

New volume name

The --project and --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)

volume delete

os volume delete
    [--force]
     <volume> [<volume> ...]

--force

Attempt forced removal of volume(s), regardless of state (defaults to False)

<volume>

Volume(s) to delete (name or ID)

volume list

List volumes

volume list

os volume list
    [--all-projects]
    [--project <project> [--project-domain <project-domain>]]
    [--user <user> [--user-domain <user-domain>]]
    [--name <name>]
    [--status <status>]
    [--long]

--project <project>

Filter results by project (name or ID) (admin only)

Volume version 2 only

--project-domain <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

--user <user>

Filter results by user (name or ID) (admin only)

Volume version 2 only

--user-domain <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

--name <name>

Filter results by volume name

--status <status>

Filter results by status

--all-projects

Include all projects (admin only)

--long

List additional fields in output

volume set

Set volume properties

volume set

os volume set
    [--name <name>]
    [--description <description>]
    [--size <size>]
    [--property <key=value> [...] ]
    [--image-property <key=value> [...] ]
    <volume>

--name <name>

New volume name

--description <description>

New volume description

--size <size>

Extend volume size in GB

--property <key=value>

Property to add or modify for this volume (repeat option to set multiple properties)

--image-property <key=value>

To add or modify image properties for this volume. (repeat option to set multiple image properties)

Volume version 2 only

<volume>

Volume to modify (name or ID)

volume show

Show volume details

volume show

os volume show
    <volume>

<volume>

Volume to display (name or ID)

volume unset

Unset volume properties

volume unset

os volume unset
    [--property <key>]
    <volume>

--property <key>

Property to remove from volume (repeat option to remove multiple properties)

<volume>

Volume to modify (name or ID)