summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects
diff options
context:
space:
mode:
authorSean McGinnis <sean.mcginnis@gmail.com>2018-04-04 14:56:27 -0500
committerSean McGinnis <sean.mcginnis@gmail.com>2018-10-26 12:02:58 -0500
commitf00ffebea61f94f2334d1c1578bc23986bbcf58c (patch)
treeac8c82b5d0aa18087cd4a6a1a5fa30eb2005f58b /doc/source/cli/command-objects
parent06263bd5852aad9cd03a76f50140fbbb2d0751ba (diff)
downloadpython-openstackclient-f00ffebea61f94f2334d1c1578bc23986bbcf58c.tar.gz
Remove invalid 'unlock-volume' migration arg
There is an optional flag that can be passed in to a volume migration to tell Cinder to 'lock' a volume so no other process can abort the migration. This is reflected correctly with the --lock-volume argument flag to `openstack volume migrate`, but there is another --unlock-volume flag that is shown in the help text for this command that does not do anything and is not used anywhere. Since there is no action to "unlock" a volume, this just causes confusion - including for Cinder developers that know this API. To avoid confusion, this invalid flag should just be removed from the command. Change-Id: I5f111ed58803a1bf5d34e828341d735099247108
Diffstat (limited to 'doc/source/cli/command-objects')
-rw-r--r--doc/source/cli/command-objects/volume.rst9
1 files changed, 1 insertions, 8 deletions
diff --git a/doc/source/cli/command-objects/volume.rst b/doc/source/cli/command-objects/volume.rst
index a06a5d40..fd704b04 100644
--- a/doc/source/cli/command-objects/volume.rst
+++ b/doc/source/cli/command-objects/volume.rst
@@ -226,7 +226,7 @@ Migrate volume to a new host
openstack volume migrate
--host <host>
[--force-host-copy]
- [--lock-volume | --unlock-volume]
+ [--lock-volume]
<volume>
.. option:: --host <host>
@@ -245,13 +245,6 @@ Migrate volume to a new host
*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>