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

Compute v2

aggregate add host

Add host to aggregate

openstack aggregate add host <aggregate> <host>

Aggregate (name or ID)


Host to add to <aggregate>

aggregate cache image

Request image caching for aggregate

openstack aggregate cache image <aggregate> <image> [<image> ...]

Aggregate (name or ID)


Image ID to request caching for aggregate (name or ID). May be specified multiple times.

aggregate create

Create a new aggregate

openstack aggregate create
    [--zone <availability-zone>]
    [--property <key=value>]
--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)

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

Aggregate(s) to delete (name or ID)

aggregate list

List all aggregates

openstack aggregate list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated


sort the column(s) in ascending order


sort the column(s) in descending order


List additional fields in output

aggregate remove host

Remove host from aggregate

openstack aggregate remove host <aggregate> <host>

Aggregate (name or ID)


Host to remove from <aggregate>

aggregate set

Set aggregate properties

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

Set aggregate name

--zone <availability-zone>

Set availability zone name

--property <key=value>

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


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


Aggregate to modify (name or ID)

aggregate show

Display aggregate details

openstack aggregate show <aggregate>

Aggregate to display (name or ID)

aggregate unset

Unset aggregate properties

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

Property to remove from aggregate (repeat option to remove multiple properties)


Aggregate to modify (name or ID)