From d7c8bb88e4a117d8ab6a53c3a7d14cc7a4105eda Mon Sep 17 00:00:00 2001
From: Huanxuan Ao <huanxuan.ao@easystack.cn>
Date: Sat, 1 Oct 2016 18:38:29 +0800
Subject: Add "volume migrate" command

Add "volume migrate" command in volume v1 and v2
to support migrating volume to a new host

Change-Id: Ie4e6037171a31a872006a13f9fd1e15eaa627c26
Implements: bp cinder-command-support
---
 doc/source/command-objects/volume.rst | 42 +++++++++++++++++++++++++++++++++++
 doc/source/commands.rst               |  4 ++--
 2 files changed, 44 insertions(+), 2 deletions(-)

(limited to 'doc/source')

diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst
index 8f123361..703a5c76 100644
--- a/doc/source/command-objects/volume.rst
+++ b/doc/source/command-objects/volume.rst
@@ -197,6 +197,48 @@ List volumes
 
     *Volume version 2 only*
 
+volume migrate
+--------------
+
+Migrate volume to a new host
+
+.. program:: volume migrate
+.. code:: bash
+
+    os volume migrate
+        --host <host>
+        [--force-host-copy]
+        [--lock-volume | --unlock-volume]
+        <volume>
+
+.. option:: --host <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>
+
+    Volume to migrate (name or ID)
+
 volume set
 ----------
 
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index de473a06..072767a4 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -230,8 +230,8 @@ Those actions with an opposite action are noted in parens if applicable.
 * ``issue`` (``revoke``) - issue a token
 * ``list`` - display summary information about multiple objects
 * ``lock`` (``unlock``) - lock one or more servers so that non-admin user won't be able to execute actions
-* ``migrate`` - move a server to a different host; ``--live`` performs a
-  live migration if possible
+* ``migrate`` - move a server or a volume to a different host; ``--live`` performs a
+  live server migration if possible
 * ``pause`` (``unpause``) - stop one or more servers and leave them in memory
 * ``reboot`` - forcibly reboot a server
 * ``rebuild`` - rebuild a server using (most of) the same arguments as in the original create
-- 
cgit v1.2.1