summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/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/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/host.rst')
-rw-r--r--doc/source/cli/command-objects/host.rst72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/host.rst b/doc/source/cli/command-objects/host.rst
new file mode 100644
index 00000000..cbf34398
--- /dev/null
+++ b/doc/source/cli/command-objects/host.rst
@@ -0,0 +1,72 @@
+====
+host
+====
+
+Compute v2
+
+The physical computer running a hypervisor.
+
+host list
+---------
+
+List hosts
+
+.. program:: host list
+.. code:: bash
+
+ openstack host list
+ [--zone <availability-zone>]
+
+.. option:: --zone <availability-zone>
+
+ Only return hosts in the availability zone
+
+host set
+--------
+
+Set host properties
+
+.. program:: host set
+.. code:: bash
+
+ openstack host set
+ [--enable | --disable]
+ [--enable-maintenance | --disable-maintenance]
+ <host>
+
+.. _host-set:
+.. option:: --enable
+
+ Enable the host
+
+.. option:: --disable
+
+ Disable the host
+
+.. _maintenance-set:
+.. option:: --enable-maintenance
+
+ Enable maintenance mode for the host
+
+.. option:: --disable-maintenance
+
+ Disable maintenance mode for the host
+
+.. describe:: <host>
+
+ Host to modify (name only)
+
+host show
+---------
+
+Display host details
+
+.. program:: host show
+.. code:: bash
+
+ openstack host show
+ <host>
+
+.. describe:: <host>
+
+ Name of host