python-openstackclient/doc/source/command-objects/aggregate.rst
zhiyong.dai 75f2875a6e Add ":option: " in the help message
This patch mainly adds  ":option:` `" in several help messages in the doc.
This modification will create one link which helps the readers find the relative
option quickly and conveniently in website.

Change-Id: Ia047e15c3b2064e4822ee7df7922d4774d862602
2017-01-03 12:13:10 +08:00

3.4 KiB

aggregate

Host aggregates provide a mechanism to group hosts according to certain criteria.

Compute v2

aggregate add host

Add host to aggregate

aggregate add host

openstack aggregate add host
    <aggregate>
    <host>




Aggregate (name or ID)




Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>`

aggregate create

Create a new aggregate

aggregate create

openstack aggregate create
    [--zone <availability-zone>]
    [--property <key=value> [...] ]
    <name>

--zone <availability-zone>

Availability zone name

--property <key=value>

Property to add to this aggregate (repeat option to set multiple properties)

New aggregate name

aggregate delete

Delete existing aggregate(s)

aggregate delete

openstack aggregate delete
    <aggregate> [<aggregate> ...]




Aggregate(s) to delete (name or ID)

aggregate list

List all aggregates

aggregate list

openstack aggregate list
    [--long]

--long

List additional fields in output

aggregate remove host

Remove host from aggregate

aggregate remove host

openstack aggregate remove host
    <aggregate>
    <host>




Aggregate (name or ID)




Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`

aggregate set

Set aggregate properties

aggregate set

openstack aggregate set
    [--name <new-name>]
    [--zone <availability-zone>]
    [--property <key=value> [...] ]
    [--no-property]
    <aggregate>

--name <name>

Set aggregate name

--zone <availability-zone>

Set availability zone name

--property <key=value>

Property to set on \<aggregate\> <aggregate_set-aggregate> (repeat option to set multiple properties)

--no-property

Remove all properties from \<aggregate\> <aggregate_set-aggregate> (specify both --property and --no-property to overwrite the current properties)

Aggregate to modify (name or ID)

aggregate show

Display aggregate details

aggregate show

openstack aggregate show
    <aggregate>




Aggregate to display (name or ID)

aggregate unset

Unset aggregate properties

aggregate unset

openstack aggregate unset
    [--property <key> [...] ]
    <aggregate>

--property <key>

Property to remove from \<aggregate\> <aggregate_unset-aggregate> (repeat option to remove multiple properties)

Aggregate to modify (name or ID)