From 9eb30efbf3ee9105520e857fbd16363523ae44ee Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Mon, 17 Nov 2014 17:52:37 -0600 Subject: Command object docs: aggregate, console *, keypair aggregate console log console url keypair Change-Id: Iec9b8404ed5febd061a5dfd674b76aaa8aba67bc --- doc/source/command-objects/aggregate.rst | 150 +++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 doc/source/command-objects/aggregate.rst (limited to 'doc/source/command-objects/aggregate.rst') diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst new file mode 100644 index 00000000..474d811f --- /dev/null +++ b/doc/source/command-objects/aggregate.rst @@ -0,0 +1,150 @@ +========= +aggregate +========= + +Server aggregates provide a mechanism to group servers according to certain +criteria. + +aggregate add host +------------------ + +Add host to aggregate + +.. program aggregate add host +.. code:: bash + + os aggregate add host + + + +.. _aggregate_add_host-aggregate: +.. describe:: + + Aggregate (name or ID) + +.. describe:: + + Host to add to :ref:`\ ` + +aggregate create +---------------- + +Create a new aggregate + +.. program aggregate create +.. code:: bash + + os aggregate create + [--zone ] + [--property ] + + +.. option:: --zone + + Availability zone name + +.. option:: --property + + Property to add to this aggregate (repeat option to set multiple properties) + +.. describe:: + + New aggregate name + +aggregate delete +---------------- + +Delete an existing aggregate + +.. program aggregate delete +.. code:: bash + + os aggregate delete + + +.. describe:: + + Aggregate to delete (name or ID) + +aggregate list +-------------- + +List all aggregates + +.. program aggregate list +.. code:: bash + + os aggregate list + [--long] + +.. option:: --long + + List additional fields in output + +aggregate remove host +--------------------- + +Remove host from aggregate + +.. program aggregate remove host +.. code:: bash + + os aggregate remove host + + + +.. _aggregate_remove_host-aggregate: +.. describe:: + + Aggregate (name or ID) + +.. option:: + + Host to remove from :ref:`\ ` + +aggregate set +------------- + +Set aggregate properties + +.. program aggregate set +.. code:: bash + + os aggregate set + [--name ] + [--zone ] + [--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) + +.. _aggregate_set-aggregate: +.. describe:: + + Aggregate to modify (name or ID) + +aggregate show +-------------- + +Show a specific aggregate + +.. program aggregate show +.. code:: bash + + os aggregate show + + +.. describe:: + + Aggregate to show (name or ID) -- cgit v1.2.1