summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-02-18 06:25:10 +0000
committerGerrit Code Review <review@openstack.org>2017-02-18 06:25:10 +0000
commit1b4605e4add3823f293d3ad063359787a469c52e (patch)
tree54ff0d5b58419b06feb807bed9511512a273ca67 /doc
parentc88975136d675c947167533191b75c849cd0a1b5 (diff)
parent55195cec46fadd88f6151783b1e17557d5e94940 (diff)
downloadpython-openstackclient-1b4605e4add3823f293d3ad063359787a469c52e.tar.gz
Merge "Add "volume host failover" command"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/command-objects/volume-host.rst26
-rw-r--r--doc/source/commands.rst1
2 files changed, 25 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
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index ece0b6e2..ece9b34e 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -239,6 +239,7 @@ Those actions with an opposite action are noted in parens if applicable.
* ``create`` (``delete``) - create a new occurrence of the specified object
* ``delete`` (``create``) - delete specific occurrences of the specified objects
* ``expand`` (``shrink``) - increase the capacity of a cluster
+* ``failover`` - failover volume host to different backend
* ``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