From b733ecf3ddc06ee1d75f570dddc4d81f71a8d1bf Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Thu, 25 Feb 2016 15:28:53 +0800 Subject: 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 --- doc/source/command-objects/command.rst | 17 +++++++++++++ doc/source/command-objects/configuration.rst | 9 +++++++ doc/source/command-objects/host.rst | 37 ++++++++++++++++++++++++++++ doc/source/command-objects/module.rst | 22 +++++++++++++++++ 4 files changed, 85 insertions(+) create mode 100644 doc/source/command-objects/command.rst create mode 100644 doc/source/command-objects/host.rst create mode 100644 doc/source/command-objects/module.rst (limited to 'doc/source/command-objects') 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 ] + +.. option:: --zone + + Only return hosts in the availability zone + +host show +--------- + +Display host details + +.. program:: host show +.. code:: bash + + os host show + + +.. describe:: + + 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 -- cgit v1.2.1