summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/aggregate.rst
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2014-11-17 17:52:37 -0600
committerDean Troyer <dtroyer@gmail.com>2014-11-19 14:47:53 -0600
commit9eb30efbf3ee9105520e857fbd16363523ae44ee (patch)
tree3209e9a17ba3344ad35353e41f1bbb0c60fe6f6a /doc/source/command-objects/aggregate.rst
parent254910d3ce34c954551a0827aa8727d6367f48f3 (diff)
downloadpython-openstackclient-9eb30efbf3ee9105520e857fbd16363523ae44ee.tar.gz
Command object docs: aggregate, console *, keypair
aggregate console log console url keypair Change-Id: Iec9b8404ed5febd061a5dfd674b76aaa8aba67bc
Diffstat (limited to 'doc/source/command-objects/aggregate.rst')
-rw-r--r--doc/source/command-objects/aggregate.rst150
1 files changed, 150 insertions, 0 deletions
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>
+ <host>
+
+.. _aggregate_add_host-aggregate:
+.. describe:: <aggregate>
+
+ Aggregate (name or ID)
+
+.. describe:: <host>
+
+ Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>`
+
+aggregate create
+----------------
+
+Create a new aggregate
+
+.. program aggregate create
+.. code:: bash
+
+ os aggregate create
+ [--zone <availability-zone>]
+ [--property <key=value>]
+ <name>
+
+.. option:: --zone <availability-zone>
+
+ Availability zone name
+
+.. option:: --property <key=value>
+
+ Property to add to this aggregate (repeat option to set multiple properties)
+
+.. describe:: <name>
+
+ New aggregate name
+
+aggregate delete
+----------------
+
+Delete an existing aggregate
+
+.. program aggregate delete
+.. code:: bash
+
+ os aggregate delete
+ <aggregate>
+
+.. describe:: <aggregate>
+
+ 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>
+ <host>
+
+.. _aggregate_remove_host-aggregate:
+.. describe:: <aggregate>
+
+ Aggregate (name or ID)
+
+.. option:: <host>
+
+ Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`
+
+aggregate set
+-------------
+
+Set aggregate properties
+
+.. program aggregate set
+.. code:: bash
+
+ os aggregate set
+ [--name <new-name>]
+ [--zone <availability-zone>]
+ [--property <key=value>]
+ <aggregate>
+
+.. option:: --name <name>
+
+ Set aggregate name
+
+.. option:: --zone <availability-zone>
+
+ Set availability zone name
+
+.. option:: --property <key=value>
+
+ Property to set on :ref:`\<aggregate\> <aggregate_set-aggregate>`
+ (repeat option to set multiple properties)
+
+.. _aggregate_set-aggregate:
+.. describe:: <aggregate>
+
+ Aggregate to modify (name or ID)
+
+aggregate show
+--------------
+
+Show a specific aggregate
+
+.. program aggregate show
+.. code:: bash
+
+ os aggregate show
+ <aggregate>
+
+.. describe:: <aggregate>
+
+ Aggregate to show (name or ID)