openstack.network.v2.load_balancer¶
The LoadBalancer Class¶
The LoadBalancer class inherits from Resource.
-
class
openstack.network.v2.load_balancer.LoadBalancer(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().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._connectionin Resource code should protect itself with a check for None.
-
description¶ Description for the load balancer.
-
is_admin_state_up¶ The administrative state of the load balancer, which is up
Trueor downFalse. Type: bool
-
listener_ids¶ List of listeners associated with this load balancer. Type: list of dicts which contain the listener IDs
-
name¶ Name of the load balancer
-
operating_status¶ Status of load_balancer operating, e.g. ONLINE, OFFLINE.
-
pool_ids¶ List of pools associated with this load balancer. Type: list of dicts which contain the pool IDs
-
project_id¶ The ID of the project this load balancer is associated with.
-
provider¶ The name of the provider.
-
provisioning_status¶ Status of load balancer provisioning, e.g. ACTIVE, INACTIVE.
-
vip_address¶ The IP address of the VIP.
-
vip_port_id¶ The ID of the port for the VIP.
-
vip_subnet_id¶ The ID of the subnet on which to allocate the VIP address.