diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/volume.rst | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst new file mode 100644 index 00000000..2eec2d7b --- /dev/null +++ b/doc/source/command-objects/volume.rst @@ -0,0 +1,189 @@ +====== +volume +====== + +Volume v1 + +volume create +------------- + +Create new volume + +.. program:: volume create +.. code:: bash + + os volume create + --size <size> + [--snapshot-id <snapshot-id>] + [--description <description>] + [--type <volume-type>] + [--user <user>] + [--project <project>] + [--availability-zone <availability-zone>] + [--image <image>] + [--source <volume>] + [--property <key=value> [...] ] + <name> + +.. option:: --size <size> (required) + + New volume size in GB + +.. option:: --snapshot-id <snapshot-id> + + Use <snapshot-id> as source of new volume + +.. option:: --description <description> + + New volume description + +.. option:: --type <volume-type> + + Use <volume-type> as the new volume type + +.. option:: --user <user> + + Specify an alternate user (name or ID) + +.. option:: --project <project> + + Specify an alternate project (name or ID) + +.. option:: --availability-zone <availability-zone> + + Create new volume in <availability-zone> + +.. option:: --image <image> + + Use <image> as source of new volume (name or ID) + +.. option:: --source <source> + + Volume to clone (name or ID) + +.. option:: --property <key=value> + + Set a property on this volume (repeat option to set multiple properties) + +.. describe:: <name> + + New 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] + <volume> [<volume> ...] + +.. option:: --force + + Attempt forced removal of volume(s), regardless of state (defaults to False) + +.. describe:: <volume> + + Volume(s) to delete (name or ID) + +volume list +----------- + +List volumes + +.. program:: volume list +.. code:: bash + + os volume list + [--status <status>] + [--name <name>] + [--all-projects] + [--long] + +.. option:: --status <status> + + Filter results by status + +.. option:: --name <name> + + Filter results by name + +.. option:: --all-projects + + Include all projects (admin only) + +.. option:: --long + + List additional fields in output + +volume set +---------- + +Set volume properties + +.. program:: volume set +.. code:: bash + + os volume set + [--name <name>] + [--description <description>] + [--property <key=value> [...] ] + <volume> + +.. option:: --name <name> + + New volume name + +.. option:: --description <description> + + New volume description + +.. option:: --property <key=value> + + Property to add or modify for this volume (repeat option to set multiple properties) + +.. describe:: <volume> + + Volume to modify (name or ID) + +volume show +----------- + +Show volume details + +.. program:: volume show +.. code:: bash + + os volume show + <volume> + +.. describe:: <volume> + + Volume to display (name or ID) + +volume unset +------------ + +Unset volume properties + +.. program:: volume unset +.. code:: bash + + os volume unset + [--property <key>] + <volume> + +.. option:: --property <key> + + Property to remove from volume (repeat option to remove multiple properties) + +.. describe:: <volume> + + Volume to modify (name or ID) |
