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
This commit is contained in:
Rui Chen 2016-02-25 15:28:53 +08:00
parent 277c16c8b7
commit b733ecf3dd
5 changed files with 89 additions and 2 deletions

View File

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

View File

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

View File

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

View File

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

View File

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