python-openstackclient/doc/source/command-objects/host.rst
Kevin_Zheng 847da51dea change os in command example to openstack(2)
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00

73 lines
990 B
ReStructuredText

====
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