# openstack.network.v2.subnet_pool

## The SubnetPool Class

The `SubnetPool` class inherits from `Resource`.

class openstack.network.v2.subnet_pool.SubnetPool(_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 = 'subnetpool'

    Singular form of key for resource.

  resources_key = 'subnetpools'

    Plural form of key for resource.

  base_path = '/subnetpools'

    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_commit = True

    Allow update operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  address_scope_id

    The ID of the address scope associated with the subnet pool.

  created_at

    Timestamp when the subnet pool was created.

  default_prefix_length

    The length of the prefix to allocate when the cidr or prefixlen attributes are omitted when creating a subnet. Type: int

  default_quota

    A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. For IPv4 subnet pools, default_quota is measured in units of /32. For IPv6 subnet pools, default_quota is measured units of /64. All projects that use the subnet pool have the same prefix quota applied. Type: int

  description

    The subnet pool description.

  ip_version

    Read-only. The IP address family of the list of prefixes. Type: int

  is_default

    Whether or not this is the default subnet pool. Type: bool

  is_shared

    Indicates whether this subnet pool is shared across all projects. Type: bool

  maximum_prefix_length

    The maximum prefix length that can be allocated from the subnet pool. Type: int

  minimum_prefix_length

    The minimum prefix length that can be allocated from the subnet pool. Type: int

  name

    The subnet pool name.

  project_id

    The ID of the project that owns the subnet pool.

  tenant_id

    Tenant_id (deprecated attribute).

  prefixes

    A list of subnet prefixes that are assigned to the subnet pool. The adjacent prefixes are merged and treated as a single prefix. Type: list

  revision_number

    Revision number of the subnet pool. Type: int

  updated_at

    Timestamp when the subnet pool was last updated.

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.