libcloud.loadbalancer package¶
Subpackages¶
- libcloud.loadbalancer.drivers package
- Submodules
- libcloud.loadbalancer.drivers.alb module
ApplicationLBDriver
ApplicationLBDriver.connectionCls
ApplicationLBDriver.create_balancer()
ApplicationLBDriver.ex_create_balancer()
ApplicationLBDriver.ex_create_listener()
ApplicationLBDriver.ex_create_listener_rule()
ApplicationLBDriver.ex_create_target_group()
ApplicationLBDriver.ex_get_listener()
ApplicationLBDriver.ex_get_rule()
ApplicationLBDriver.ex_get_target_group()
ApplicationLBDriver.ex_register_targets()
ApplicationLBDriver.get_balancer()
ApplicationLBDriver.list_balancers()
ApplicationLBDriver.list_protocols()
ApplicationLBDriver.name
ApplicationLBDriver.signature_version
ApplicationLBDriver.website
- libcloud.loadbalancer.drivers.brightbox module
BrightboxLBDriver
BrightboxLBDriver.LB_STATE_MAP
BrightboxLBDriver.balancer_attach_compute_node()
BrightboxLBDriver.balancer_attach_member()
BrightboxLBDriver.balancer_detach_member()
BrightboxLBDriver.balancer_list_members()
BrightboxLBDriver.connectionCls
BrightboxLBDriver.create_balancer()
BrightboxLBDriver.destroy_balancer()
BrightboxLBDriver.get_balancer()
BrightboxLBDriver.list_balancers()
BrightboxLBDriver.list_protocols()
BrightboxLBDriver.name
BrightboxLBDriver.website
- libcloud.loadbalancer.drivers.cloudstack module
CloudStackLBDriver
CloudStackLBDriver.LB_STATE_MAP
CloudStackLBDriver.api_name
CloudStackLBDriver.balancer_attach_member()
CloudStackLBDriver.balancer_detach_member()
CloudStackLBDriver.balancer_list_members()
CloudStackLBDriver.create_balancer()
CloudStackLBDriver.destroy_balancer()
CloudStackLBDriver.get_balancer()
CloudStackLBDriver.list_balancers()
CloudStackLBDriver.list_protocols()
CloudStackLBDriver.name
CloudStackLBDriver.type
CloudStackLBDriver.website
- libcloud.loadbalancer.drivers.dimensiondata module
DimensionDataLBDriver
DimensionDataLBDriver.api_version
DimensionDataLBDriver.balancer_attach_member()
DimensionDataLBDriver.balancer_detach_member()
DimensionDataLBDriver.balancer_list_members()
DimensionDataLBDriver.connectionCls
DimensionDataLBDriver.create_balancer()
DimensionDataLBDriver.destroy_balancer()
DimensionDataLBDriver.ex_create_node()
DimensionDataLBDriver.ex_create_pool()
DimensionDataLBDriver.ex_create_pool_member()
DimensionDataLBDriver.ex_create_virtual_listener()
DimensionDataLBDriver.ex_destroy_node()
DimensionDataLBDriver.ex_destroy_pool()
DimensionDataLBDriver.ex_destroy_pool_member()
DimensionDataLBDriver.ex_get_current_network_domain()
DimensionDataLBDriver.ex_get_default_health_monitors()
DimensionDataLBDriver.ex_get_default_irules()
DimensionDataLBDriver.ex_get_default_persistence_profiles()
DimensionDataLBDriver.ex_get_node()
DimensionDataLBDriver.ex_get_nodes()
DimensionDataLBDriver.ex_get_pool()
DimensionDataLBDriver.ex_get_pool_member()
DimensionDataLBDriver.ex_get_pool_members()
DimensionDataLBDriver.ex_get_pools()
DimensionDataLBDriver.ex_set_current_network_domain()
DimensionDataLBDriver.ex_set_node_state()
DimensionDataLBDriver.ex_set_pool_member_state()
DimensionDataLBDriver.ex_update_node()
DimensionDataLBDriver.ex_update_pool()
DimensionDataLBDriver.ex_wait_for_state()
DimensionDataLBDriver.get_balancer()
DimensionDataLBDriver.list_balancers()
DimensionDataLBDriver.list_protocols()
DimensionDataLBDriver.name
DimensionDataLBDriver.network_domain_id
DimensionDataLBDriver.selected_region
DimensionDataLBDriver.type
DimensionDataLBDriver.website
- libcloud.loadbalancer.drivers.elb module
ElasticLBDriver
ElasticLBDriver.balancer_attach_compute_node()
ElasticLBDriver.balancer_detach_member()
ElasticLBDriver.balancer_list_members()
ElasticLBDriver.connectionCls
ElasticLBDriver.create_balancer()
ElasticLBDriver.destroy_balancer()
ElasticLBDriver.ex_create_balancer_listeners()
ElasticLBDriver.ex_create_balancer_policy()
ElasticLBDriver.ex_delete_balancer_policy()
ElasticLBDriver.ex_list_balancer_policies()
ElasticLBDriver.ex_list_balancer_policy_types()
ElasticLBDriver.ex_set_balancer_policies_backend_server()
ElasticLBDriver.ex_set_balancer_policies_listener()
ElasticLBDriver.get_balancer()
ElasticLBDriver.list_balancers()
ElasticLBDriver.list_protocols()
ElasticLBDriver.name
ElasticLBDriver.signature_version
ElasticLBDriver.website
- libcloud.loadbalancer.drivers.gce module
GCELBDriver
GCELBDriver.apiname
GCELBDriver.balancer_attach_compute_node()
GCELBDriver.balancer_attach_member()
GCELBDriver.balancer_detach_member()
GCELBDriver.balancer_list_members()
GCELBDriver.connectionCls
GCELBDriver.create_balancer()
GCELBDriver.destroy_balancer()
GCELBDriver.ex_balancer_attach_healthcheck()
GCELBDriver.ex_balancer_detach_healthcheck()
GCELBDriver.ex_balancer_list_healthchecks()
GCELBDriver.ex_create_healthcheck()
GCELBDriver.ex_list_healthchecks()
GCELBDriver.get_balancer()
GCELBDriver.list_balancers()
GCELBDriver.list_protocols()
GCELBDriver.name
GCELBDriver.website
- libcloud.loadbalancer.drivers.ninefold module
- libcloud.loadbalancer.drivers.nttcis module
NttCisLBDriver
NttCisLBDriver.api_version
NttCisLBDriver.balancer_attach_member()
NttCisLBDriver.balancer_detach_member()
NttCisLBDriver.balancer_list_members()
NttCisLBDriver.connectionCls
NttCisLBDriver.create_balancer()
NttCisLBDriver.destroy_balancer()
NttCisLBDriver.ex_create_node()
NttCisLBDriver.ex_create_pool()
NttCisLBDriver.ex_create_pool_member()
NttCisLBDriver.ex_create_ssl_offload_profile()
NttCisLBDriver.ex_create_virtual_listener()
NttCisLBDriver.ex_delete_ssl_certificate_chain()
NttCisLBDriver.ex_delete_ssl_domain_certificate()
NttCisLBDriver.ex_delete_ssl_offload_profile()
NttCisLBDriver.ex_destroy_node()
NttCisLBDriver.ex_destroy_pool()
NttCisLBDriver.ex_destroy_pool_member()
NttCisLBDriver.ex_edit_ssl_offload_profile()
NttCisLBDriver.ex_get_current_network_domain()
NttCisLBDriver.ex_get_default_health_monitors()
NttCisLBDriver.ex_get_default_irules()
NttCisLBDriver.ex_get_default_persistence_profiles()
NttCisLBDriver.ex_get_node()
NttCisLBDriver.ex_get_nodes()
NttCisLBDriver.ex_get_pool()
NttCisLBDriver.ex_get_pool_member()
NttCisLBDriver.ex_get_pool_members()
NttCisLBDriver.ex_get_pools()
NttCisLBDriver.ex_get_ssl_certificate_chain()
NttCisLBDriver.ex_get_ssl_domain_cert()
NttCisLBDriver.ex_get_ssl_offload_profile()
NttCisLBDriver.ex_import_ssl_cert_chain()
NttCisLBDriver.ex_import_ssl_domain_certificate()
NttCisLBDriver.ex_list_ssl_certificate_chains()
NttCisLBDriver.ex_list_ssl_domain_certs()
NttCisLBDriver.ex_list_ssl_offload_profiles()
NttCisLBDriver.ex_set_current_network_domain()
NttCisLBDriver.ex_set_node_state()
NttCisLBDriver.ex_set_pool_member_state()
NttCisLBDriver.ex_update_listener()
NttCisLBDriver.ex_update_node()
NttCisLBDriver.ex_update_pool()
NttCisLBDriver.ex_wait_for_state()
NttCisLBDriver.get_balancer()
NttCisLBDriver.list_balancers()
NttCisLBDriver.list_protocols()
NttCisLBDriver.name
NttCisLBDriver.selected_region
NttCisLBDriver.type
NttCisLBDriver.website
- libcloud.loadbalancer.drivers.rackspace module
RackspaceAccessRule
RackspaceAccessRuleType
RackspaceConnection
RackspaceConnection.auth_url
RackspaceConnection.cache_busting
RackspaceConnection.encode_data()
RackspaceConnection.get_poll_request_kwargs()
RackspaceConnection.has_completed()
RackspaceConnection.poll_interval
RackspaceConnection.request()
RackspaceConnection.responseCls
RackspaceConnection.timeout
RackspaceConnectionThrottle
RackspaceHTTPHealthMonitor
RackspaceHealthMonitor
RackspaceLBDriver
RackspaceLBDriver.CONDITION_LB_MEMBER_MAP
RackspaceLBDriver.LB_MEMBER_CONDITION_MAP
RackspaceLBDriver.LB_STATE_MAP
RackspaceLBDriver.api_name
RackspaceLBDriver.balancer_attach_member()
RackspaceLBDriver.balancer_detach_member()
RackspaceLBDriver.balancer_list_members()
RackspaceLBDriver.connectionCls
RackspaceLBDriver.create_balancer()
RackspaceLBDriver.destroy_balancer()
RackspaceLBDriver.ex_balancer_access_list()
RackspaceLBDriver.ex_balancer_attach_members()
RackspaceLBDriver.ex_balancer_detach_members()
RackspaceLBDriver.ex_balancer_detach_members_no_poll()
RackspaceLBDriver.ex_balancer_update_member()
RackspaceLBDriver.ex_balancer_update_member_no_poll()
RackspaceLBDriver.ex_create_balancer()
RackspaceLBDriver.ex_create_balancer_access_rule()
RackspaceLBDriver.ex_create_balancer_access_rule_no_poll()
RackspaceLBDriver.ex_create_balancer_access_rules()
RackspaceLBDriver.ex_create_balancer_access_rules_no_poll()
RackspaceLBDriver.ex_destroy_balancer_access_rule()
RackspaceLBDriver.ex_destroy_balancer_access_rule_no_poll()
RackspaceLBDriver.ex_destroy_balancer_access_rules()
RackspaceLBDriver.ex_destroy_balancer_access_rules_no_poll()
RackspaceLBDriver.ex_destroy_balancers()
RackspaceLBDriver.ex_disable_balancer_connection_logging()
RackspaceLBDriver.ex_disable_balancer_connection_logging_no_poll()
RackspaceLBDriver.ex_disable_balancer_connection_throttle()
RackspaceLBDriver.ex_disable_balancer_connection_throttle_no_poll()
RackspaceLBDriver.ex_disable_balancer_custom_error_page()
RackspaceLBDriver.ex_disable_balancer_custom_error_page_no_poll()
RackspaceLBDriver.ex_disable_balancer_health_monitor()
RackspaceLBDriver.ex_disable_balancer_health_monitor_no_poll()
RackspaceLBDriver.ex_disable_balancer_session_persistence()
RackspaceLBDriver.ex_disable_balancer_session_persistence_no_poll()
RackspaceLBDriver.ex_enable_balancer_connection_logging()
RackspaceLBDriver.ex_enable_balancer_connection_logging_no_poll()
RackspaceLBDriver.ex_enable_balancer_session_persistence()
RackspaceLBDriver.ex_enable_balancer_session_persistence_no_poll()
RackspaceLBDriver.ex_get_balancer_error_page()
RackspaceLBDriver.ex_list_algorithm_names()
RackspaceLBDriver.ex_list_current_usage()
RackspaceLBDriver.ex_list_protocols_with_default_ports()
RackspaceLBDriver.ex_update_balancer_connection_throttle()
RackspaceLBDriver.ex_update_balancer_connection_throttle_no_poll()
RackspaceLBDriver.ex_update_balancer_error_page()
RackspaceLBDriver.ex_update_balancer_error_page_no_poll()
RackspaceLBDriver.ex_update_balancer_health_monitor()
RackspaceLBDriver.ex_update_balancer_health_monitor_no_poll()
RackspaceLBDriver.ex_update_balancer_no_poll()
RackspaceLBDriver.get_balancer()
RackspaceLBDriver.list_balancers()
RackspaceLBDriver.list_protocols()
RackspaceLBDriver.list_regions()
RackspaceLBDriver.name
RackspaceLBDriver.update_balancer()
RackspaceLBDriver.website
RackspaceResponse
- libcloud.loadbalancer.drivers.slb module
SLBDriver
SLBDriver.balancer_attach_compute_node()
SLBDriver.balancer_attach_member()
SLBDriver.balancer_detach_member()
SLBDriver.balancer_list_members()
SLBDriver.connectionCls
SLBDriver.create_balancer()
SLBDriver.destroy_balancer()
SLBDriver.ex_create_listener()
SLBDriver.ex_delete_certificate()
SLBDriver.ex_get_balancer_attribute()
SLBDriver.ex_list_certificates()
SLBDriver.ex_list_listeners()
SLBDriver.ex_set_certificate_name()
SLBDriver.ex_start_listener()
SLBDriver.ex_stop_listener()
SLBDriver.ex_upload_certificate()
SLBDriver.get_balancer()
SLBDriver.list_balancers()
SLBDriver.list_protocols()
SLBDriver.name
SLBDriver.namespace
SLBDriver.path
SLBDriver.website
- Module contents
Submodules¶
libcloud.loadbalancer.base module¶
- class libcloud.loadbalancer.base.Algorithm[source]¶
Bases:
object
Represents a load balancing algorithm.
- LEAST_CONNECTIONS = 2¶
- LEAST_CONNECTIONS_MEMBER = 7¶
- LEAST_CONNECTIONS_NODE = 8¶
- OBSERVED_MEMBER = 9¶
- OBSERVED_NODE = 10¶
- PERSISTENT_IP = 6¶
- PREDICTIVE_MEMBER = 11¶
- PREDICTIVE_NODE = 12¶
- RANDOM = 0¶
- ROUND_ROBIN = 1¶
- SHORTEST_RESPONSE = 5¶
- WEIGHTED_LEAST_CONNECTIONS = 4¶
- WEIGHTED_ROUND_ROBIN = 3¶
- class libcloud.loadbalancer.base.Driver(key, secret=None, secure=True, host=None, port=None, **kwargs)[source]¶
Bases:
BaseDriver
A base Driver class to derive from
This class is always subclassed by a specific driver.
- Parameters:
key (
str
) – API key or username to be used (required)secret (
str
) – Secret password to be used (required)secure (
bool
) – Whether to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default.host (
str
) – Override hostname used for connections.port (
int
) – Override port used for connections.api_version (
str
) – Optional API version. Only used by drivers which support multiple API versions.region (
str
) – Optional driver region. Only used by drivers which support multiple regions.
- Return type:
None
- balancer_attach_compute_node(balancer, node)[source]¶
Attach a compute node as a member to the load balancer.
- Parameters:
balancer (
LoadBalancer
) – LoadBalancer which should be usednode (
Node
) – Node to join to the balancer
- Returns:
Member after joining the balancer.
- Return type:
- balancer_attach_member(balancer, member)[source]¶
Attach a member to balancer
- Parameters:
balancer (
LoadBalancer
) – LoadBalancer which should be usedmember (
Member
) – Member to join to the balancer
- Returns:
Member after joining the balancer.
- Return type:
- balancer_detach_member(balancer, member)[source]¶
Detach member from balancer
- Parameters:
balancer (
LoadBalancer
) – LoadBalancer which should be usedmember (
Member
) – Member which should be used
- Returns:
True
if member detach was successful, otherwiseFalse
.- Return type:
bool
- balancer_list_members(balancer)[source]¶
Return list of members attached to balancer
- Parameters:
balancer (
LoadBalancer
) – LoadBalancer which should be used- Return type:
list
ofMember
- connectionCls¶
alias of
ConnectionKey
- create_balancer(name, port, protocol, algorithm, members)[source]¶
Create a new load balancer instance
- Parameters:
name (
str
) – Name of the new load balancer (required)port (
str
) – Port the load balancer should listen on, defaults to 80protocol (
str
) – Loadbalancer protocol, defaults to http.members (
list
ofMember
) – list of Members to attach to balanceralgorithm (
Algorithm
) – Load balancing algorithm, defaults to ROUND_ROBIN.
- Return type:
- destroy_balancer(balancer)[source]¶
Destroy a load balancer
- Parameters:
balancer (
LoadBalancer
) – LoadBalancer which should be used- Returns:
True
if the destroy was successful, otherwiseFalse
.- Return type:
bool
- get_balancer(balancer_id)[source]¶
Return a
LoadBalancer
object.- Parameters:
balancer_id (
str
) – id of a load balancer you want to fetch- Return type:
- list_balancers()[source]¶
List all loadbalancers
- Return type:
list
ofLoadBalancer
- list_supported_algorithms()[source]¶
Return algorithms supported by this driver.
- Return type:
list
ofstr
- name = None¶
- update_balancer(balancer, **kwargs)[source]¶
Sets the name, algorithm, protocol, or port on a load balancer.
- Parameters:
balancer (
LoadBalancer
) – LoadBalancer which should be usedname (
str
) – New load balancer namealgorithm (
Algorithm
) – New load balancer algorithmprotocol (
str
) – New load balancer protocolport (
int
) – New load balancer port
- Return type:
- website = None¶
- class libcloud.loadbalancer.base.LoadBalancer(id, name, state, ip, port, driver, extra=None)[source]¶
Bases:
object
Provide a common interface for handling Load Balancers.
- Parameters:
id (
str
) – Load balancer ID.name (
str
) – Load balancer name.state (
libcloud.loadbalancer.types.State
) – State this loadbalancer is in.ip (
str
) – IP address of this loadbalancer.port (
int
) – Port of this loadbalancer.driver (
Driver
) – Driver this loadbalancer belongs to.extra (
dict
) – Provider specific attributes. (optional)
- class libcloud.loadbalancer.base.Member(id, ip, port, balancer=None, extra=None)[source]¶
Bases:
object
Represents a load balancer member.
- Parameters:
id (
str
) – Member ID.ip – IP address of this member.
ip –
str
port – Port of this member
port –
str
balancer – Balancer this member is attached to. (optional)
balancer –
LoadBalancer
extra (
dict
) – Provider specific attributes.
libcloud.loadbalancer.providers module¶
- class libcloud.loadbalancer.providers.Provider[source]¶
Bases:
object
Defines for each of the supported providers
Non-Dummy drivers are sorted in alphabetical order. Please preserve this ordering when adding new drivers.
- Variables:
ALIYUN_SLB – Aliyun SLB loadbalancer driver
- ALB = 'alb'¶
- ALIYUN_SLB = 'aliyun_slb'¶
- BRIGHTBOX = 'brightbox'¶
- CLOUDSTACK = 'cloudstack'¶
- DIMENSIONDATA = 'dimensiondata'¶
- ELB = 'elb'¶
- GCE = 'gce'¶
- NINEFOLD = 'ninefold'¶
- NTTCIS = 'nttcis'¶
- RACKSPACE = 'rackspace'¶
- RACKSPACE_UK = 'rackspace_uk'¶
- RACKSPACE_US = 'rackspace_us'¶
libcloud.loadbalancer.types module¶
- exception libcloud.loadbalancer.types.LibcloudLBError(value: str, driver: BaseDriver = None)[source]¶
Bases:
LibcloudError
- exception libcloud.loadbalancer.types.LibcloudLBImmutableError(value: str, driver: BaseDriver = None)[source]¶
Bases:
LibcloudLBError
- class libcloud.loadbalancer.types.Provider[source]¶
Bases:
object
Defines for each of the supported providers
Non-Dummy drivers are sorted in alphabetical order. Please preserve this ordering when adding new drivers.
- Variables:
ALIYUN_SLB – Aliyun SLB loadbalancer driver
- ALB = 'alb'¶
- ALIYUN_SLB = 'aliyun_slb'¶
- BRIGHTBOX = 'brightbox'¶
- CLOUDSTACK = 'cloudstack'¶
- DIMENSIONDATA = 'dimensiondata'¶
- ELB = 'elb'¶
- GCE = 'gce'¶
- NINEFOLD = 'ninefold'¶
- NTTCIS = 'nttcis'¶
- RACKSPACE = 'rackspace'¶
- RACKSPACE_UK = 'rackspace_uk'¶
- RACKSPACE_US = 'rackspace_us'¶
Module contents¶
Module for working with Load Balancers