python-openstackclient/doc/source/command-objects/aggregate.rst
Kevin_Zheng 9663424c74 change os in command example to openstack
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00

3.2 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>

Host to add to \<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)

<name>

New aggregate name

aggregate delete

Delete existing aggregate(s)

aggregate delete

openstack aggregate delete
    <aggregate> [<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>

Host to remove from \<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>

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)