diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 16:02:31 -0600 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-05 07:09:05 -0600 |
| commit | c6266b5ab22b911ae7e0ca5077d0c04a23dabca9 (patch) | |
| tree | 8e2f4ff670b4b272184ecc877cd9838b5ad4873b /doc/source/cli/command-objects/host.rst | |
| parent | da56b8f4cf15cc5a77249b680dd0c4d05137be9a (diff) | |
| download | python-openstackclient-c6266b5ab22b911ae7e0ca5077d0c04a23dabca9.tar.gz | |
compute: autogenerate docs
$namespace = openstack.compute.v2
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
Many of these were already being generated. Some were missing a few
sub-subcommands, so those are added.
Change-Id: I1aa4b2655bafd2f6a5d83b658742f65d180eb128
Diffstat (limited to 'doc/source/cli/command-objects/host.rst')
| -rw-r--r-- | doc/source/cli/command-objects/host.rst | 66 |
1 files changed, 2 insertions, 64 deletions
diff --git a/doc/source/cli/command-objects/host.rst b/doc/source/cli/command-objects/host.rst index cbf34398..acd5a287 100644 --- a/doc/source/cli/command-objects/host.rst +++ b/doc/source/cli/command-objects/host.rst @@ -6,67 +6,5 @@ Compute v2 The physical computer running a hypervisor. -host list ---------- - -List hosts - -.. program:: host list -.. code:: bash - - openstack host list - [--zone <availability-zone>] - -.. option:: --zone <availability-zone> - - Only return hosts in the availability zone - -host set --------- - -Set host properties - -.. program:: host set -.. code:: bash - - openstack host set - [--enable | --disable] - [--enable-maintenance | --disable-maintenance] - <host> - -.. _host-set: -.. option:: --enable - - Enable the host - -.. option:: --disable - - Disable the host - -.. _maintenance-set: -.. option:: --enable-maintenance - - Enable maintenance mode for the host - -.. option:: --disable-maintenance - - Disable maintenance mode for the host - -.. describe:: <host> - - Host to modify (name only) - -host show ---------- - -Display host details - -.. program:: host show -.. code:: bash - - openstack host show - <host> - -.. describe:: <host> - - Name of host +.. autoprogram-cliff:: openstack.compute.v2 + :command: host * |