From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/aggregate.rst | 186 +++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) create mode 100644 doc/source/cli/command-objects/aggregate.rst (limited to 'doc/source/cli/command-objects/aggregate.rst') diff --git a/doc/source/cli/command-objects/aggregate.rst b/doc/source/cli/command-objects/aggregate.rst new file mode 100644 index 00000000..2029a6c8 --- /dev/null +++ b/doc/source/cli/command-objects/aggregate.rst @@ -0,0 +1,186 @@ +========= +aggregate +========= + +Host aggregates provide a mechanism to group hosts according to certain +criteria. + +Compute v2 + +aggregate add host +------------------ + +Add host to aggregate + +.. program:: aggregate add host +.. code:: bash + + openstack aggregate add host + + + +.. _aggregate_add_host-aggregate: +.. describe:: + + Aggregate (name or ID) + +.. _aggregate_add_host-host: +.. describe:: + + Host to add to :ref:`\ ` + +aggregate create +---------------- + +Create a new aggregate + +.. program:: aggregate create +.. code:: bash + + openstack aggregate create + [--zone ] + [--property [...] ] + + +.. option:: --zone + + Availability zone name + +.. option:: --property + + Property to add to this aggregate (repeat option to set multiple properties) + +.. _aggregate_create-name: +.. describe:: + + New aggregate name + +aggregate delete +---------------- + +Delete existing aggregate(s) + +.. program:: aggregate delete +.. code:: bash + + openstack aggregate delete + [ ...] + +.. _aggregate_delete-aggregate: +.. describe:: + + Aggregate(s) to delete (name or ID) + +aggregate list +-------------- + +List all aggregates + +.. program:: aggregate list +.. code:: bash + + openstack aggregate list + [--long] + +.. option:: --long + + List additional fields in output + +aggregate remove host +--------------------- + +Remove host from aggregate + +.. program:: aggregate remove host +.. code:: bash + + openstack aggregate remove host + + + +.. _aggregate_remove_host-aggregate: +.. describe:: + + Aggregate (name or ID) + +.. _aggregate_remove_host-host: +.. describe:: + + Host to remove from :ref:`\ ` + +aggregate set +------------- + +Set aggregate properties + +.. program:: aggregate set +.. code:: bash + + openstack aggregate set + [--name ] + [--zone ] + [--property [...] ] + [--no-property] + + +.. option:: --name + + Set aggregate name + +.. option:: --zone + + Set availability zone name + +.. option:: --property + + Property to set on :ref:`\ ` + (repeat option to set multiple properties) + +.. option:: --no-property + + Remove all properties from :ref:`\ ` + (specify both :option:`--property` and :option:`--no-property` to + overwrite the current properties) + +.. _aggregate_set-aggregate: +.. describe:: + + Aggregate to modify (name or ID) + +aggregate show +-------------- + +Display aggregate details + +.. program:: aggregate show +.. code:: bash + + openstack aggregate show + + +.. _aggregate_show-aggregate: +.. describe:: + + Aggregate to display (name or ID) + +aggregate unset +--------------- + +Unset aggregate properties + +.. program:: aggregate unset +.. code-block:: bash + + openstack aggregate unset + [--property [...] ] + + +.. option:: --property + + Property to remove from :ref:`\ ` + (repeat option to remove multiple properties) + +.. _aggregate_unset-aggregate: +.. describe:: + + Aggregate to modify (name or ID) -- cgit v1.2.1