summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorzhiyong.dai <zhiyong.dai@easystack.cn>2016-12-14 21:14:17 +0800
committerzhiyong.dai <zhiyong.dai@easystack.cn>2016-11-21 22:56:41 +0800
commit55195cec46fadd88f6151783b1e17557d5e94940 (patch)
tree8dc3c0390d551c551f821d4c39e9d93f2c4abf28 /doc/source/command-objects
parent3816b4b90a84ed3917d07af4c95a46cce0519ea7 (diff)
downloadpython-openstackclient-55195cec46fadd88f6151783b1e17557d5e94940.tar.gz
Add "volume host failover" command
Add "volume host failover" command in volume v2 (v2 only). Change-Id: Ia39e6d20bf5c9d3096e46f3432804a240827548d Implements: bp cinder-command-support
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/volume-host.rst26
1 files changed, 24 insertions, 2 deletions
diff --git a/doc/source/command-objects/volume-host.rst b/doc/source/command-objects/volume-host.rst
index a225e53e..1e513cb7 100644
--- a/doc/source/command-objects/volume-host.rst
+++ b/doc/source/command-objects/volume-host.rst
@@ -4,6 +4,28 @@ volume host
Volume v2
+volume host failover
+--------------------
+
+Failover volume host to different backend
+
+.. program:: volume host failover
+.. code:: bash
+
+ openstack volume host failover
+ --volume-backend <backend-id>
+ <host-name>
+
+.. option:: --volume-backend <backend-id>
+
+ The ID of the volume backend replication
+ target where the host will failover to (required)
+
+.. _volume_host_failover-host-name:
+.. describe:: <host-name>
+
+ Name of volume host
+
volume host set
---------------
@@ -18,13 +40,13 @@ Set volume host properties
.. option:: --enable
- Thaw and enable the specified volume host
+ Thaw and enable the specified volume host.
.. option:: --disable
Freeze and disable the specified volume host
-.. _volume-host-set:
+.. _volume_host_set-host-name:
.. describe:: <host-name>
Name of volume host