summaryrefslogtreecommitdiff
path: root/doc/source
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
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')
-rw-r--r--doc/source/command-objects/command.rst17
-rw-r--r--doc/source/command-objects/configuration.rst9
-rw-r--r--doc/source/command-objects/host.rst37
-rw-r--r--doc/source/command-objects/module.rst22
-rw-r--r--doc/source/commands.rst6
5 files changed, 89 insertions, 2 deletions
diff --git a/doc/source/command-objects/command.rst b/doc/source/command-objects/command.rst
new file mode 100644
index 00000000..ac4f8514
--- /dev/null
+++ b/doc/source/command-objects/command.rst
@@ -0,0 +1,17 @@
+=======
+command
+=======
+
+Internal
+
+Installed commands in the OSC process.
+
+command list
+------------
+
+List recognized commands by group
+
+.. program:: command list
+.. code:: bash
+
+ os command list
diff --git a/doc/source/command-objects/configuration.rst b/doc/source/command-objects/configuration.rst
index 0ee8bd63..7bf054c0 100644
--- a/doc/source/command-objects/configuration.rst
+++ b/doc/source/command-objects/configuration.rst
@@ -16,3 +16,12 @@ show different configurations.
.. code:: bash
os configuration show
+ [--mask | --unmask]
+
+.. option:: --mask
+
+ Attempt to mask passwords (default)
+
+.. option:: --unmask
+
+ Show password in clear text
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
diff --git a/doc/source/command-objects/module.rst b/doc/source/command-objects/module.rst
new file mode 100644
index 00000000..c3bc1372
--- /dev/null
+++ b/doc/source/command-objects/module.rst
@@ -0,0 +1,22 @@
+======
+module
+======
+
+Internal
+
+Installed Python modules in the OSC process.
+
+module list
+-----------
+
+List module versions
+
+.. program:: module list
+.. code:: bash
+
+ os module list
+ [--all]
+
+.. option:: --all
+
+ Show all modules that have version information
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 2195720f..5678e5d1 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -74,6 +74,8 @@ referring to both Compute and Volume quotas.
* ``aggregate``: (**Compute**) a grouping of servers
* ``backup``: (**Volume**) a volume copy
* ``catalog``: (**Identity**) service catalog
+* ``command``: (**Internal**) installed commands in the OSC process
+* ``configuration``: (**Internal**) openstack client configuration
* ``console log``: (**Compute**) server console text dump
* ``console url``: (**Compute**) server remote console URL
* ``consumer``: (**Identity**) OAuth-based delegatee
@@ -86,7 +88,7 @@ referring to both Compute and Volume quotas.
* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
* ``group``: (**Identity**) a grouping of users
-* ``host``: Compute - the physical computer running a hypervisor
+* ``host``: (**Compute**) - the physical computer running a hypervisor
* ``hypervisor``: (**Compute**) the virtual machine manager
* ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes
* ``identity provider``: (**Identity**) a source of users and authentication
@@ -97,7 +99,7 @@ referring to both Compute and Volume quotas.
* ``keypair``: (**Compute**) an SSH public key
* ``limits``: (**Compute**, **Volume**) resource usage limits
* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
-* ``module``: internal - installed Python modules in the OSC process
+* ``module``: (**Internal**) - installed Python modules in the OSC process
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
* ``object``: (**Object Storage**) a single file in the Object Storage
* ``policy``: (**Identity**) determines authorization