summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/aggregate.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/aggregate.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
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 <doug@doughellmann.com>
Diffstat (limited to 'doc/source/command-objects/aggregate.rst')
-rw-r--r--doc/source/command-objects/aggregate.rst186
1 files changed, 0 insertions, 186 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst
deleted file mode 100644
index 2029a6c8..00000000
--- a/doc/source/command-objects/aggregate.rst
+++ /dev/null
@@ -1,186 +0,0 @@
-=========
-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>
- <host>
-
-.. _aggregate_add_host-aggregate:
-.. describe:: <aggregate>
-
- Aggregate (name or ID)
-
-.. _aggregate_add_host-host:
-.. describe:: <host>
-
- Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>`
-
-aggregate create
-----------------
-
-Create a new aggregate
-
-.. program:: aggregate create
-.. code:: bash
-
- openstack 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)
-
-.. _aggregate_create-name:
-.. describe:: <name>
-
- New aggregate name
-
-aggregate delete
-----------------
-
-Delete existing aggregate(s)
-
-.. program:: aggregate delete
-.. code:: bash
-
- openstack aggregate delete
- <aggregate> [<aggregate> ...]
-
-.. _aggregate_delete-aggregate:
-.. describe:: <aggregate>
-
- 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>
- <host>
-
-.. _aggregate_remove_host-aggregate:
-.. describe:: <aggregate>
-
- Aggregate (name or ID)
-
-.. _aggregate_remove_host-host:
-.. describe:: <host>
-
- Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`
-
-aggregate set
--------------
-
-Set aggregate properties
-
-.. program:: aggregate set
-.. code:: bash
-
- openstack aggregate set
- [--name <new-name>]
- [--zone <availability-zone>]
- [--property <key=value> [...] ]
- [--no-property]
- <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)
-
-.. option:: --no-property
-
- Remove all properties from :ref:`\<aggregate\> <aggregate_set-aggregate>`
- (specify both :option:`--property` and :option:`--no-property` to
- overwrite the current properties)
-
-.. _aggregate_set-aggregate:
-.. describe:: <aggregate>
-
- Aggregate to modify (name or ID)
-
-aggregate show
---------------
-
-Display aggregate details
-
-.. program:: aggregate show
-.. code:: bash
-
- openstack aggregate show
- <aggregate>
-
-.. _aggregate_show-aggregate:
-.. describe:: <aggregate>
-
- Aggregate to display (name or ID)
-
-aggregate unset
----------------
-
-Unset aggregate properties
-
-.. program:: aggregate unset
-.. code-block:: bash
-
- openstack aggregate unset
- [--property <key> [...] ]
- <aggregate>
-
-.. option:: --property <key>
-
- Property to remove from :ref:`\<aggregate\> <aggregate_unset-aggregate>`
- (repeat option to remove multiple properties)
-
-.. _aggregate_unset-aggregate:
-.. describe:: <aggregate>
-
- Aggregate to modify (name or ID)