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:
parent
277c16c8b7
commit
b733ecf3dd
17
doc/source/command-objects/command.rst
Normal file
17
doc/source/command-objects/command.rst
Normal 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
|
@ -16,3 +16,12 @@ show different configurations.
|
|||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
os configuration show
|
os configuration show
|
||||||
|
[--mask | --unmask]
|
||||||
|
|
||||||
|
.. option:: --mask
|
||||||
|
|
||||||
|
Attempt to mask passwords (default)
|
||||||
|
|
||||||
|
.. option:: --unmask
|
||||||
|
|
||||||
|
Show password in clear text
|
||||||
|
37
doc/source/command-objects/host.rst
Normal file
37
doc/source/command-objects/host.rst
Normal 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
|
22
doc/source/command-objects/module.rst
Normal file
22
doc/source/command-objects/module.rst
Normal 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
|
@ -74,6 +74,8 @@ referring to both Compute and Volume quotas.
|
|||||||
* ``aggregate``: (**Compute**) a grouping of servers
|
* ``aggregate``: (**Compute**) a grouping of servers
|
||||||
* ``backup``: (**Volume**) a volume copy
|
* ``backup``: (**Volume**) a volume copy
|
||||||
* ``catalog``: (**Identity**) service catalog
|
* ``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 log``: (**Compute**) server console text dump
|
||||||
* ``console url``: (**Compute**) server remote console URL
|
* ``console url``: (**Compute**) server remote console URL
|
||||||
* ``consumer``: (**Identity**) OAuth-based delegatee
|
* ``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
|
* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities
|
||||||
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
|
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
|
||||||
* ``group``: (**Identity**) a grouping of users
|
* ``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``: (**Compute**) the virtual machine manager
|
||||||
* ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes
|
* ``hypervisor stats``: (**Compute**) hypervisor statistics over all compute nodes
|
||||||
* ``identity provider``: (**Identity**) a source of users and authentication
|
* ``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
|
* ``keypair``: (**Compute**) an SSH public key
|
||||||
* ``limits``: (**Compute**, **Volume**) resource usage limits
|
* ``limits``: (**Compute**, **Volume**) resource usage limits
|
||||||
* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
|
* ``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
|
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
|
||||||
* ``object``: (**Object Storage**) a single file in the Object Storage
|
* ``object``: (**Object Storage**) a single file in the Object Storage
|
||||||
* ``policy``: (**Identity**) determines authorization
|
* ``policy``: (**Identity**) determines authorization
|
||||||
|
Loading…
Reference in New Issue
Block a user