summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/host.rst
diff options
context:
space:
mode:
authorRui Chen <chenrui.momo@gmail.com>2016-02-25 15:28:53 +0800
committerRui Chen <chenrui.momo@gmail.com>2016-02-26 15:20:44 +0800
commitb733ecf3ddc06ee1d75f570dddc4d81f71a8d1bf (patch)
treea7e8437a04c194eeae65b0ccad869866f8bf9731 /doc/source/command-objects/host.rst
parent277c16c8b74efc258c02b73ffff1c6d4fb616d0f (diff)
downloadpython-openstackclient-b733ecf3ddc06ee1d75f570dddc4d81f71a8d1bf.tar.gz
Add missing command/configuration object
Add missing 'command' and 'configuration' object into command object list, add command, module, host commands describe in command-objects, and add 'mask' and 'unmask' options in configuration command details, fix some format issues by the way. Change-Id: Iea80c7b1e413e02e49b9090b9d3cb9c59aab4c38
Diffstat (limited to 'doc/source/command-objects/host.rst')
-rw-r--r--doc/source/command-objects/host.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst
new file mode 100644
index 00000000..680efcc2
--- /dev/null
+++ b/doc/source/command-objects/host.rst
@@ -0,0 +1,37 @@
+====
+host
+====
+
+Compute v2
+
+The physical computer running a hypervisor.
+
+host list
+---------
+
+List all hosts
+
+.. program:: host list
+.. code:: bash
+
+ os host list
+ [--zone <availability-zone>]
+
+.. option:: --zone <availability-zone>
+
+ Only return hosts in the availability zone
+
+host show
+---------
+
+Display host details
+
+.. program:: host show
+.. code:: bash
+
+ os host show
+ <host>
+
+.. describe:: <host>
+
+ Name of host