Host Aggregates

Host Aggregates

Host aggregates can be regarded as a mechanism to further partition an availability zone; while availability zones are visible to users, host aggregates are only visible to administrators. Host aggregates started out as a way to use Xen hypervisor resource pools, but have been generalized to provide a mechanism to allow administrators to assign key-value pairs to groups of machines. Each node can have multiple aggregates, each aggregate can have multiple key-value pairs, and the same key-value pair can be assigned to multiple aggregates. This information can be used in the scheduler to enable advanced scheduling, to set up Xen hypervisor resource pools or to define logical groups for migration. For more information, including an example of associating a group of hosts to a flavor, see Host aggregates and availability zones.

Availability Zones (AZs)

Availability Zones are the end-user visible logical abstraction for partitioning a cloud without knowing the physical infrastructure. That abstraction doesn’t come up in Nova with an actual database model since the availability zone is actually a specific metadata information attached to an aggregate. Adding that specific metadata to an aggregate makes the aggregate visible from an end-user perspective and consequently allows to schedule upon a specific set of hosts (the ones belonging to the aggregate).

That said, there are a few rules to know that diverge from an API perspective between aggregates and availability zones:

  • one host can be in multiple aggregates, but it can only be in one availability zone
  • by default a host is part of a default availability zone even if it doesn’t belong to an aggregate (the configuration option is named default_availability_zone)


That last rule can be very error-prone. Since the user can see the list of availability zones, they have no way to know whether the default availability zone name (currently nova) is provided because an host belongs to an aggregate whose AZ metadata key is set to nova, or because there is at least one host not belonging to any aggregate. Consequently, it is highly recommended for users to never ever ask for booting an instance by specifying an explicit AZ named nova and for operators to never set the AZ metadata for an aggregate to nova. That leads to some problems due to the fact that the instance AZ information is explicitly attached to nova which could break further move operations when either the host is moved to another aggregate or when the user would like to migrate the instance.


Availability zone name must NOT contain ‘:’ since it is used by admin users to specify hosts where instances are launched in server creation. See Select hosts where instances are launched for more detail.

There is a nice educational video about availability zones from the Rocky summit which can be found here:


The OSAPI Admin API is extended to support the following operations:

  • Aggregates
    • list aggregates: returns a list of all the host-aggregates
    • create aggregate: creates an aggregate, takes a friendly name, etc. returns an id
    • show aggregate: shows the details of an aggregate (id, name, availability_zone, hosts and metadata)
    • update aggregate: updates the name and availability zone of an aggregate
    • set metadata: sets the metadata on an aggregate to the values supplied
    • delete aggregate: deletes an aggregate, it fails if the aggregate is not empty
    • add host: adds a host to the aggregate
    • remove host: removes a host from the aggregate
  • Hosts
    • list all hosts by service
      • It has been deprecated since microversion 2.43. Use list hypervisors instead.
    • start host maintenance (or evacuate-host): disallow a host to serve API requests and migrate instances to other hosts of the aggregate
      • It has been deprecated since microversion 2.43. Use disable service instead.
    • stop host maintenance (or rebalance-host): put the host back into operational mode, migrating instances back onto that host
      • It has been deprecated since microversion 2.43. Use enable service instead.
  • Hypervisors
    • list hypervisors: list hypervisors with hypervisor hostname
  • Compute services
    • enable service
    • disable service

Using the Nova CLI

Using the nova command you can create, delete and manage aggregates. The following section outlines the list of available commands.


* aggregate-list                                                    Print a list of all aggregates.
* aggregate-create         <name> [<availability_zone>]             Create a new aggregate with the specified details.
* aggregate-delete         <aggregate>                              Delete the aggregate by its ID or name.
* aggregate-show           <aggregate>                              Show details of the aggregate specified by its ID or name.
* aggregate-add-host       <aggregate> <host>                       Add the host to the aggregate specified by its ID or name.
* aggregate-remove-host    <aggregate> <host>                       Remove the specified host from the aggregate specified by its ID or name.
* aggregate-set-metadata   <aggregate> <key=value> [<key=value> ...]
                                                                    Update the metadata associated with the aggregate specified by its ID or name.
* aggregate-update         [--name <name>] [--availability-zone <availability-zone>] <aggregate>
                                                                    Update the aggregate's name or availability zone.

* host-list                                                         List all hosts by service.
* hypervisor-list          [--matching <hostname>] [--marker <marker>] [--limit <limit>]
                                                                    List hypervisors.

* host-update              [--status <enable|disable>] [--maintenance <enable|disable>] <hostname>
                                                                    Put/resume host into/from maintenance.
* service-enable           <id>                                     Enable the service.
* service-disable          [--reason <reason>] <id>                 Disable the service.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.