libcloud.loadbalancer.drivers.rackspace.RackspaceLBDriver : API documentation

Method	__init__
Method	list_protocols	Return a list of supported protocols.
Method	ex_list_protocols_with_default_ports
Method	list_balancers	No summary
Method	create_balancer	Create a new load balancer instance
Method	ex_create_balancer	Creates a new load balancer instance
Method	destroy_balancer	Destroy a load balancer
Method	ex_destroy_balancers	Destroys a list of Balancers (the API supports up to 10).
Method	get_balancer	Return a `LoadBalancer` object.
Method	balancer_attach_member	Attach a member to balancer
Method	ex_balancer_attach_members	Attaches a list of members to a load balancer.
Method	balancer_detach_member	Detach member from balancer
Method	ex_balancer_detach_members	Detaches a list of members from a balancer (the API supports up to 10). This method blocks until the detach request has been processed and the balancer is in a RUNNING state again.
Method	ex_balancer_detach_members_no_poll	Detaches a list of members from a balancer (the API supports up to 10). This method returns immediately.
Method	balancer_list_members	Return list of members attached to balancer
Method	update_balancer	Sets the name, algorithm, protocol, or port on a load balancer.
Method	ex_update_balancer_no_poll	Undocumented
Method	ex_balancer_update_member	No summary
Method	ex_balancer_update_member_no_poll	Updates a Member's extra attributes for a Balancer. The attribute can include 'weight' or 'condition'. This method returns immediately.
Method	ex_list_algorithm_names	Lists algorithms supported by the API. Returned as strings because this list may change in the future.
Method	ex_get_balancer_error_page	Undocumented
Method	ex_balancer_access_list	Undocumented
Method	ex_update_balancer_health_monitor	Sets a Balancer's health monitor. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_update_balancer_health_monitor_no_poll	Sets a Balancer's health monitor. This method returns immediately.
Method	ex_disable_balancer_health_monitor	Disables a Balancer's health monitor. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.
Method	ex_disable_balancer_health_monitor_no_poll	Disables a Balancer's health monitor. This method returns immediately.
Method	ex_update_balancer_connection_throttle	Updates a Balancer's connection throttle. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_update_balancer_connection_throttle_no_poll	Sets a Balancer's connection throttle. This method returns immediately.
Method	ex_disable_balancer_connection_throttle	Disables a Balancer's connection throttle. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.
Method	ex_disable_balancer_connection_throttle_no_poll	Disables a Balancer's connection throttle. This method returns immediately.
Method	ex_enable_balancer_connection_logging	Enables connection logging for a Balancer. This method blocks until the enable request has been processed and the balancer is in a RUNNING state again.
Method	ex_enable_balancer_connection_logging_no_poll	Enables connection logging for a Balancer. This method returns immediately.
Method	ex_disable_balancer_connection_logging	Disables connection logging for a Balancer. This method blocks until the enable request has been processed and the balancer is in a RUNNING state again.
Method	ex_disable_balancer_connection_logging_no_poll	Disables connection logging for a Balancer. This method returns immediately.
Method	ex_enable_balancer_session_persistence	Enables session persistence for a Balancer by setting the persistence type to 'HTTP_COOKIE'. This method blocks until the enable request has been processed and the balancer is in a RUNNING state again.
Method	ex_enable_balancer_session_persistence_no_poll	Enables session persistence for a Balancer by setting the persistence type to 'HTTP_COOKIE'. This method returns immediately.
Method	ex_disable_balancer_session_persistence	Disables session persistence for a Balancer. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.
Method	ex_disable_balancer_session_persistence_no_poll	Disables session persistence for a Balancer. This method returns immediately.
Method	ex_update_balancer_error_page	Updates a Balancer's custom error page. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_update_balancer_error_page_no_poll	Updates a Balancer's custom error page. This method returns immediately.
Method	ex_disable_balancer_custom_error_page	No summary
Method	ex_disable_balancer_custom_error_page_no_poll	Disables a Balancer's custom error page, returning its error page to the Rackspace-provided default. This method returns immediately.
Method	ex_create_balancer_access_rule	Adds an access rule to a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_create_balancer_access_rule_no_poll	Adds an access rule to a Balancer's access list. This method returns immediately.
Method	ex_create_balancer_access_rules	Adds a list of access rules to a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_create_balancer_access_rules_no_poll	Adds a list of access rules to a Balancer's access list. This method returns immediately.
Method	ex_destroy_balancer_access_rule	Removes an access rule from a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_destroy_balancer_access_rule_no_poll	Removes an access rule from a Balancer's access list. This method returns immediately.
Method	ex_destroy_balancer_access_rules	Removes a list of access rules from a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.
Method	ex_destroy_balancer_access_rules_no_poll	Removes a list of access rules from a Balancer's access list. This method returns immediately.
Method	_ex_connection_class_kwargs	Return extra connection keyword arguments which are passed to the Connection class constructor.
Method	_member_attributes	Undocumented
Method	_get_updated_balancer	No summary
Method	_find_matching_rule	No summary
Method	_to_protocols	Undocumented
Method	_to_protocols_with_default_ports	Undocumented
Method	_to_balancers	Undocumented
Method	_to_balancer	Undocumented
Method	_to_members	Undocumented
Method	_to_member	Undocumented
Method	_protocol_to_value	Undocumented
Method	_kwargs_to_mutable_attrs	Undocumented
Method	_kwargs_to_mutable_member_attrs	Undocumented
Method	_to_health_monitor	Undocumented
Method	_to_connection_throttle	Undocumented
Method	_to_access_rule	Undocumented
Method	_to_access_rule_type	Undocumented
Method	_iso_to_datetime	Undocumented

Inherited from Driver:

Method	balancer_attach_compute_node	Attach a compute node as a member to the load balancer.
Method	list_supported_algorithms	Return algorithms supported by this driver.
Method	_value_to_algorithm	Return `LBAlgorithm` based on the value.
Method	_algorithm_to_value	Return value based in the algorithm (`LBAlgorithm`).

Inherited from OpenStackDriverMixin:

Method

openstack_connection_kwargs

Undocumented

Parameters	key	API key or username to used (type: str)
	secret	Secret password to be used (type: str)
	secure	Weither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
	host	Override hostname used for connections. (type: str)
	port	Override port used for connections. (type: int)
	api_version	Optional API version. Only used by drivers which support multiple API versions. (type: str)

Return extra connection keyword arguments which are passed to the Connection class constructor.

Return a list of supported protocols.

Returns A list of protocols with default ports included. (type: list of tuples of protocols (str) with default ports (int).)

Parameters ex_member_address Optional IP address of the attachment member. If provided, only the load balancers which have this member attached will be returned. (type: str)

Create a new load balancer instance

Parameters	name	Name of the new load balancer (required) (type: `str`)
	members	`list` of`Member`s to attach to balancer
	protocol	Loadbalancer protocol, defaults to http.
	port	Port the load balancer should listen on, defaults to 80 (type: `str`)
	algorithm	Load balancing algorithm, defaults to LBAlgorithm.ROUND_ROBIN (type: `LBAlgorithm`)

Creates a new load balancer instance

Parameters	name	Name of the new load balancer (required) (type: `str`)
	members	`list` of`Member`s to attach to balancer
	protocol	Loadbalancer protocol, defaults to http.
	port	Port the load balancer should listen on, defaults to 80 (type: `str`)
	algorithm	Load balancing algorithm, defaults to LBAlgorithm.ROUND_ROBIN (type: `LBAlgorithm`)
	vip	Virtual ip type of PUBLIC, SERVICENET, or ID of a virtual ip (type: `str`)

Destroy a load balancer

Returns bool True if the destroy was successful, otherwise False

Destroys a list of Balancers (the API supports up to 10).

Parameters	balancers	A list of Balancers to destroy. (type: `list`)
Returns	Returns whether the destroy request was accepted. (type: `bool`)

Return a LoadBalancer object.

Parameters	balancer_id	id of a load balancer you want to fetch (type: `str`)
Returns	`LoadBalancer`

Attach a member to balancer

Parameters member Member to join to the balancer (type: Member @return {Member} Member after joining the balancer.)

Attaches a list of members to a load balancer.

Parameters	balancer	The Balancer to which members will be attached. (type: `Balancer`)
	members	A list of Members to attach. (type: `list`)

Detach member from balancer

Returns bool True if member detach was successful, otherwise False

Detaches a list of members from a balancer (the API supports up to 10). This method blocks until the detach request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	The Balancer to detach members from. (type: `Balancer`)
	members	A list of Members to detach. (type: `list`)
Returns	Updated Balancer. (type: `Balancer`)

Detaches a list of members from a balancer (the API supports up to 10). This method returns immediately.

Parameters	balancer	The Balancer to detach members from. (type: `Balancer`)
	members	A list of Members to detach. (type: `list`)
Returns	Returns whether the detach request was accepted. (type: `bool`)

Return list of members attached to balancer

Returns list of Members

Sets the name, algorithm, protocol, or port on a load balancer.

Parameters	name	New load balancer name
	algorithm	New load balancer algorithm
	protocol	New load balancer protocol
	port	New load balancer port

Updates a Member's extra attributes for a Balancer. The attributes can include 'weight' or 'condition'. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to update the member on. (type: `Balancer`)
	**kwargs	New attributes. Should contain either 'weight' or 'condition'. 'condition' can be set to 'ENABLED', 'DISABLED'. or 'DRAINING'. 'weight' can be set to a positive integer between 1 and 100, with a higher weight indicating that the node will receive more traffic (assuming the Balancer is using a weighted algorithm). (type: `dict`)
Returns	Updated Member. (type: `Member`)

Updates a Member's extra attributes for a Balancer. The attribute can include 'weight' or 'condition'. This method returns immediately.

Parameters	balancer	Balancer to update the member on. (type: `Balancer`)
	**kwargs	New attributes. Should contain either 'weight' or 'condition'. 'condition' can be set to 'ENABLED', 'DISABLED'. or 'DRAINING'. 'weight' can be set to a positive integer between 1 and 100, with a higher weight indicating that the node will receive more traffic (assuming the Balancer is using a weighted algorithm). (type: `dict`)
Returns	Returns whether the update request was accepted. (type: `bool`)

Lists algorithms supported by the API. Returned as strings because this list may change in the future.

Updating a balancer's attributes puts a balancer into 'PENDING_UPDATE' status. Wait until the balancer is back in 'ACTIVE' status and then return the individual balancer details call.

Sets a Balancer's health monitor. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to update. (type: `Balancer`)
	health_monitor	Health Monitor for the balancer. (type: `RackspaceHealthMonitor`)
Returns	Updated Balancer. (type: `Balancer`)

Sets a Balancer's health monitor. This method returns immediately.

Parameters	balancer	Balancer to update health monitor on. (type: `Balancer`)
	health_monitor	Health Monitor for the balancer. (type: `RackspaceHealthMonitor`)
Returns	Returns whether the update request was accepted. (type: `bool`)

Disables a Balancer's health monitor. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to disable health monitor on. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Disables a Balancer's health monitor. This method returns immediately.

Parameters	balancer	Balancer to disable health monitor on. (type: `Balancer`)
Returns	Returns whether the disable request was accepted. (type: `bool`)

Updates a Balancer's connection throttle. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to update connection throttle on. (type: `Balancer`)
	connection_throttle	Connection Throttle for the balancer. (type: `RackspaceConnectionThrottle`)
Returns	Updated Balancer. (type: `Balancer`)

Sets a Balancer's connection throttle. This method returns immediately.

Parameters	balancer	Balancer to update connection throttle on. (type: `Balancer`)
	connection_throttle	Connection Throttle for the balancer. (type: `RackspaceConnectionThrottle`)
Returns	Returns whether the update request was accepted. (type: `bool`)

Disables a Balancer's connection throttle. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to disable connection throttle on. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Disables a Balancer's connection throttle. This method returns immediately.

Parameters	balancer	Balancer to disable connection throttle on. (type: `Balancer`)
Returns	Returns whether the disable request was accepted. (type: `bool`)

Enables connection logging for a Balancer. This method blocks until the enable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to enable connection logging on. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Enables connection logging for a Balancer. This method returns immediately.

Parameters	balancer	Balancer to enable connection logging on. (type: `Balancer`)
Returns	Returns whether the enable request was accepted. (type: `bool`)

Disables connection logging for a Balancer. This method blocks until the enable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to disable connection logging on. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Disables connection logging for a Balancer. This method returns immediately.

Parameters	balancer	Balancer to disable connection logging on. (type: `Balancer`)
Returns	Returns whether the disable request was accepted. (type: `bool`)

Enables session persistence for a Balancer by setting the persistence type to 'HTTP_COOKIE'. This method blocks until the enable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to enable session persistence on. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Enables session persistence for a Balancer by setting the persistence type to 'HTTP_COOKIE'. This method returns immediately.

Parameters	balancer	Balancer to enable session persistence on. (type: `Balancer`)
Returns	Returns whether the enable request was accepted. (type: `bool`)

Disables session persistence for a Balancer. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to disable session persistence on. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Disables session persistence for a Balancer. This method returns immediately.

Parameters	balancer	Balancer to disable session persistence for. (type: `Balancer`)
Returns	Returns whether the disable request was accepted. (type: `bool`)

Updates a Balancer's custom error page. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to update the custom error page for. (type: `Balancer`)
	page_content	HTML content for the custom error page. (type: `string`)
Returns	Updated Balancer. (type: `Balancer`)

Updates a Balancer's custom error page. This method returns immediately.

Parameters	balancer	Balancer to update the custom error page for. (type: `Balancer`)
	page_content	HTML content for the custom error page. (type: `string`)
Returns	Returns whether the update request was accepted. (type: `bool`)

Disables a Balancer's custom error page, returning its error page to the Rackspace-provided default. This method blocks until the disable request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to disable the custom error page for. (type: `Balancer`)
Returns	Updated Balancer. (type: `Balancer`)

Disables a Balancer's custom error page, returning its error page to the Rackspace-provided default. This method returns immediately.

Parameters	balancer	Balancer to disable the custom error page for. (type: `Balancer`)
Returns	Returns whether the disable request was accepted. (type: `bool`)

Adds an access rule to a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to create the access rule for. (type: `Balancer`)
	rule	Access Rule to add to the balancer. (type: `RackspaceAccessRule`)
Returns	The created access rule. (type: `RackspaceAccessRule`)

Adds an access rule to a Balancer's access list. This method returns immediately.

Parameters	balancer	Balancer to create the access rule for. (type: `Balancer`)
	rule	Access Rule to add to the balancer. (type: `RackspaceAccessRule`)
Returns	Returns whether the create request was accepted. (type: `bool`)

Adds a list of access rules to a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to create the access rule for. (type: `Balancer`)
	rules	List of `RackspaceAccessRule` to add to the balancer. (type: `list`)
Returns	The created access rules. (type: `RackspaceAccessRule`)

LB API does not return the ID for the newly created rules, so we have to search the list to find the rule with a matching rule type and address to return an object with the right identifier.it. The API enforces rule type and address uniqueness.

Adds a list of access rules to a Balancer's access list. This method returns immediately.

Parameters	balancer	Balancer to create the access rule for. (type: `Balancer`)
	rules	List of `RackspaceAccessRule` to add to the balancer. (type: `list`)
Returns	Returns whether the create request was accepted. (type: `bool`)

Removes an access rule from a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to remove the access rule from. (type: `Balancer`)
	rule	Access Rule to remove from the balancer. (type: `RackspaceAccessRule`)
Returns	Updated Balancer. (type: `Balancer`)

Removes an access rule from a Balancer's access list. This method returns immediately.

Parameters	balancer	Balancer to remove the access rule from. (type: `Balancer`)
	rule	Access Rule to remove from the balancer. (type: `RackspaceAccessRule`)
Returns	Returns whether the destroy request was accepted. (type: `bool`)

Removes a list of access rules from a Balancer's access list. This method blocks until the update request has been processed and the balancer is in a RUNNING state again.

Parameters	balancer	Balancer to remove the access rules from. (type: `Balancer`)
	rules	List of `RackspaceAccessRule` objects to remove from the balancer. (type: `list`)
Returns	Updated Balancer. (type: `Balancer`)

Removes a list of access rules from a Balancer's access list. This method returns immediately.

Parameters	balancer	Balancer to remove the access rules from. (type: `Balancer`)
	rules	List of `RackspaceAccessRule` objects to remove from the balancer. (type: `list`)
Returns	Returns whether the destroy request was accepted. (type: `bool`)

l.l.d.r.RackspaceLBDriver(Driver, OpenStackDriverMixin) : class documentation