summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/volume.rst
diff options
context:
space:
mode:
authorwuyuting <wytdahu@gmail.com>2016-06-05 22:55:43 -0400
committerRui Chen <chenrui.momo@gmail.com>2016-07-27 11:30:52 +0800
commit954c28dfa21be76b0522af051d71fb9470877a1a (patch)
treee39e3e3eeb5722a85259a72566987a8b876a10ed /doc/source/command-objects/volume.rst
parent7a667d700f97dda386c3db3bffc8138182fbeccb (diff)
downloadpython-openstackclient-954c28dfa21be76b0522af051d71fb9470877a1a.tar.gz
Add support for deleting volumes with associated snapshots
OSC doesn't support deleting volumes with associated snapshots. This patch provides support for deleting volumes with associated snapshots by adding an optional argument. Change-Id: I7e74f251574993ff13a38e508fd2f9debeda8d0a Closes-Bug: #1589332 Co-Authored-By: Rui Chen <chenrui.momo@gmail.com>
Diffstat (limited to 'doc/source/command-objects/volume.rst')
-rw-r--r--doc/source/command-objects/volume.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst
index a51d1117..021518be 100644
--- a/doc/source/command-objects/volume.rst
+++ b/doc/source/command-objects/volume.rst
@@ -88,13 +88,19 @@ Delete volume(s)
.. code:: bash
os volume delete
- [--force]
+ [--force | --purge]
<volume> [<volume> ...]
.. 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>