openstack.network.v2.pool

The Pool Class

The Pool class inherits from Resource.

class openstack.network.v2.pool.Pool(_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.

description

Description for the pool.

health_monitor_id

The ID of the associated health monitors.

health_monitor_ids

The ID of the associated health monitors (LBaaS v1).

health_monitor_status

The statuses of the associated health monitors.

is_admin_state_up

The administrative state of the pool, which is up True or down False. Type: bool

lb_algorithm

The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round-robin must be supported.

listener_ids

List of associated listeners. Type: list of dicts which contain the listener IDs

listener_id

ID of listener associated with this pool

load_balancer_ids

List of associated load balancers. Type: list of dicts which contain the load balancer IDs

load_balancer_id

ID of load balancer associated with this pool

member_ids

List of members that belong to the pool. Type: list of dicts which contain the member IDs

name

Pool name. Does not have to be unique.

project_id

The ID of the project this pool is associated with.

tenant_id

Tenant_id (deprecated attribute).

protocol

The protocol of the pool, which is TCP, HTTP, or HTTPS.

provider

The provider name of the load balancer service.

status

Human readable description of the status.

status_description

The status of the network.

subnet_id

The subnet on which the members of the pool will be located.

session_persistence

Session persistence algorithm that should be used (if any). Type: dict with keys ``type`` and ``cookie_name``

virtual_ip_id

The ID of the virtual IP (VIP) address.