summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/volume-host.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/volume-host.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/volume-host.rst')
-rw-r--r--doc/source/cli/command-objects/volume-host.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/volume-host.rst b/doc/source/cli/command-objects/volume-host.rst
new file mode 100644
index 00000000..1e513cb7
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-host.rst
@@ -0,0 +1,52 @@
+===========
+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
+---------------
+
+Set volume host properties
+
+.. program:: volume host set
+.. code:: bash
+
+ openstack volume host set
+ [--enable | --disable]
+ <host-name>
+
+.. option:: --enable
+
+ Thaw and enable the specified volume host.
+
+.. option:: --disable
+
+ Freeze and disable the specified volume host
+
+.. _volume_host_set-host-name:
+.. describe:: <host-name>
+
+ Name of volume host