# openstack.compute.v2.aggregate

## The Aggregate Class

The `Aggregate` class inherits from `Resource`.

class openstack.compute.v2.aggregate.Aggregate(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resource_key = 'aggregate'

    Singular form of key for resource.

  resources_key = 'aggregates'

    Plural form of key for resource.

  base_path = '/os-aggregates'

    The base part of the URI for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  availability_zone

    Availability zone of aggregate

  created_at

    The date and time when the resource was created.

  deleted_at

    The date and time when the resource was deleted.

  is_deleted

    Deleted?

  name

    Name of aggregate

  hosts

    Hosts

  metadata

    Metadata

  updated_at

    The date and time when the resource was updated

  uuid

    UUID

  add_host(session, host)

    Adds a host to an aggregate.

  remove_host(session, host)

    Removes a host from an aggregate.

  set_metadata(session, metadata)

    Creates or replaces metadata for an aggregate.

  precache_images(session, images)

    Requests image pre-caching

this page last updated: 2026-01-16 23:06:19

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