openstack.network.v2.load_balancer¶
The LoadBalancer Class¶
The LoadBalancer
class inherits from Resource
.
-
class
openstack.network.v2.load_balancer.
LoadBalancer
(attrs=None, loaded=False)¶ Construct a Resource to interact with a service’s REST API.
The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See
Resource.new()
andResource.existing()
.Parameters: - attrs (dict) – The attributes to set when constructing this Resource.
- loaded (bool) –
True
if this Resource exists on the server,False
if it does not.
-
admin_state_up
= None¶ The administrative state of the load balancer, which is up
True
or downFalse
. Type: bool
-
description
= None¶ Description for the load balancer.
-
listener_ids
= None¶ List of listeners associated with this load balancer. Type: list of dicts which contain the listener IDs
-
name
= None¶ Name of the load balancer
-
operating_status
= None¶ Status of load_balancer operating, e.g. ONLINE, OFFLINE.
-
project_id
= None¶ The ID of the project this load balancer is associated with.
-
provider
= None¶ The name of the provider.
-
provisioning_status
= None¶ Status of load balancer provisioning, e.g. ACTIVE, INACTIVE.
-
vip_address
= None¶ The IP address of the VIP.
-
vip_port_id
= None¶ The ID of the port for the VIP.
-
vip_subnet_id
= None¶ The ID of the subnet on which to allocate the VIP address.