Bases: object
Converts a data model to a dictionary.
Bases: object
Bases: object
Get a health monitor object.
healthmonitor_id (UUID string) – The health monitor ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A HealthMonitor object or None if not found.
Get a L7 policy object.
l7policy_id (UUID string) – The L7 policy ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A L7Policy object or None if not found.
Get a L7 rule object.
l7rule_id (UUID string) – The L7 rule ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A L7Rule object or None if not found.
Get a listener object.
listener_id (UUID string) – The listener ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A Listener object or None if not found.
Get a load balancer object.
loadbalancer_id (UUID string) – The load balancer ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A LoadBalancer object or None if not found.
Get a member object.
member_id (UUID string) – The member ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A Member object or None if not found.
Get a pool object.
pool_id (UUID string) – The pool ID to lookup.
DriverAgentTimeout – The driver agent did not respond inside the timeout.
DriverError – An unexpected error occurred.
A Pool object or None if not found.
Update listener statistics.
statistics (dict) – Statistics for listeners: id (string): ID for listener. active_connections (int): Number of currently active connections. bytes_in (int): Total bytes received. bytes_out (int): Total bytes sent. request_errors (int): Total requests not fulfilled. total_connections (int): The total connections handled.
UpdateStatisticsError
None
Update load balancer status.
status (dict) – dictionary defining the provisioning status and operating status for load balancer objects, including pools, members, listeners, L7 policies, and L7 rules. iod (string): ID for the object. provisioning_status (string): Provisioning status for the object. operating_status (string): Operating status for the object.
UpdateStatusError
None
Bases: Exception
Exception raised when the driver agent cannot be reached.
Each exception will include a message field that describes the error. :param fault_string: String describing the fault. :type fault_string: string
Bases: Exception
Exception raised when the driver agent does not respond.
Raised when communication with the driver agent times out. Each exception will include a message field that describes the error. :param fault_string: String describing the fault. :type fault_string: string
Bases: Exception
Catch all exception that drivers can raise.
This exception includes two strings: The user fault string and the optional operator fault string. The user fault string, “user_fault_string”, will be provided to the API requester. The operator fault string, “operator_fault_string”, will be logged in the Octavia API log file for the operator to use when debugging.
user_fault_string (string) – String provided to the API requester.
operator_fault_string (string) – Optional string logged by the Octavia API for the operator to use when debugging.
Bases: Exception
Exception raised when the driver cannot find a resource.
This exception includes two strings: The user fault string and the optional operator fault string. The user fault string, “user_fault_string”, will be provided to the API requester. The operator fault string, “operator_fault_string”, will be logged in the Octavia API log file for the operator to use when debugging.
user_fault_string (string) – String provided to the API requester.
operator_fault_string (string) – Optional string logged by the Octavia API for the operator to use when debugging.
Bases: Exception
Exception raised when a driver does not implement an API function.
user_fault_string (string) – String provided to the API requester.
operator_fault_string (string) – Optional string logged by the Octavia API for the operator to use when debugging.
Bases: Exception
Exception raised when a driver does not support an option.
Provider drivers will validate that they can complete the request – that all options are supported by the driver. If the request fails validation, drivers will raise an UnsupportedOptionError exception. For example, if a driver does not support a flavor passed as an option to load balancer create(), the driver will raise an UnsupportedOptionError and include a message parameter providing an explanation of the failure.
user_fault_string (string) – String provided to the API requester.
operator_fault_string (string) – Optional string logged by the Octavia API for the operator to use when debugging.
Bases: Exception
Exception raised when a statistics update fails.
Each exception will include a message field that describes the error and references to the failed record if available. :param fault_string: String describing the fault. :type fault_string: string :param status_object: The object the fault occurred on. :type status_object: string :param status_object_id: The ID of the object that failed stats update. :type status_object_id: string :param status_record: The stats update record that caused the fault. :type status_record: string
Bases: Exception
Exception raised when a status update fails.
Each exception will include a message field that describes the error and references to the failed record if available. :param fault_string: String describing the fault. :type fault_string: string :param status_object: The object the fault occurred on. :type status_object: string :param status_object_id: The ID of the object that failed status update. :type status_object_id: string :param status_record: The status update record that caused the fault. :type status_record: string
Bases: object
Creates a port for a load balancer VIP.
If the driver supports creating VIP ports, the driver will create a VIP port with the primary VIP and all additional VIPs added to the port, and return the vip_dictionary populated with the vip_port_id and a list of vip_dictionaries populated with data from the additional VIPs (which are guaranteed to be in the same Network). This might look like: {‘port_id’: port_id, ‘subnet_id’: subnet_id_1, ‘ip_address’: ip1}, [{‘subnet_id’: subnet_id_2, ‘ip_address’: ip2}, {…}, {…}] If the driver does not support port creation, the driver will raise a NotImplementedError.
loadbalancer_id (string) – ID of loadbalancer.
project_id (string) – The project ID to create the VIP under.
vip_dictionary: The VIP dictionary.
additional_vip_dicts: A list of additional VIP dictionaries, with subnets guaranteed to be in the same network as the primary vip_dictionary.
VIP dictionary with vip_port_id + a list of additional VIP dictionaries (vip_dict, additional_vip_dicts).
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support creating VIP ports.
Returns a dict of supported availability zone metadata keys.
The returned dictionary will include key/value pairs, ‘name’ and ‘description.’
The availability zone metadata dictionary
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support AZs.
Returns a dict of flavor metadata keys supported by this driver.
The returned dictionary will include key/value pairs, ‘name’ and ‘description.’
The flavor metadata dictionary
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support flavors.
Creates a new health monitor.
healthmonitor (object) – The health monitor object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Deletes a healthmonitor_id.
healthmonitor (object) – The monitor to delete.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Updates a health monitor.
old_healthmonitor (object) – The baseline health monitor object.
new_healthmonitor (object) – The updated health monitor object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Creates a new L7 policy.
l7policy (object) – The L7 policy object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Deletes an L7 policy.
l7policy (object) – The L7 policy to delete.
Nothing if the delete request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Updates an L7 policy.
old_l7policy (object) – The baseline L7 policy object.
new_l7policy (object) – The updated L7 policy object.
Nothing if the update request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Creates a new L7 rule.
l7rule (object) – The L7 rule object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Deletes an L7 rule.
l7rule (object) – The L7 rule to delete.
Nothing if the delete request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Updates an L7 rule.
old_l7rule (object) – The baseline L7 rule object.
new_l7rule (object) – The updated L7 rule object.
Nothing if the update request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Creates a new listener.
listener (object) – The listener object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Deletes a listener.
listener (object) – The listener to delete.
Nothing if the delete request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Updates a listener.
old_listener (object) – The baseline listener object.
new_listener (object) – The updated listener object.
Nothing if the update request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Creates a new load balancer.
loadbalancer (object) – The load balancer object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support create.
UnsupportedOptionError – The driver does not support one of the configuration options.
Deletes a load balancer.
loadbalancer (object) – The load balancer to delete.
cascade (bool) – If True, deletes all child objects (listeners, pools, etc.) in addition to the load balancer.
Nothing if the delete request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Performs a fail over of a load balancer.
loadbalancer_id (string) – ID of the load balancer to failover.
Nothing if the failover request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError if driver does not support request.
Updates a load balancer.
old_loadbalancer (object) – The baseline load balancer object.
new_loadbalancer (object) – The updated load balancer object.
Nothing if the update request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support request.
UnsupportedOptionError – The driver does not support one of the configuration options.
Creates, updates, or deletes a set of pool members.
pool_id (string) – The id of the pool to update.
members (list) – List of member objects.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Creates a new member for a pool.
member (object) – The member object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Deletes a pool member.
member (object) – The member to delete.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Updates a pool member.
old_member (object) – The baseline member object.
new_member (object) – The updated member object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Creates a new pool.
pool (object) – The pool object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Deletes a pool and its members.
pool (object) – The pool to delete.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
Updates a pool.
pool (object) – The baseline pool object.
pool – The updated pool object.
Nothing if the create request was accepted.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – if driver does not support request.
UnsupportedOptionError – if driver does not support one of the configuration options.
Validates if driver can support the availability zone.
availability_zone_metadata (dict) – Dictionary with az metadata.
Nothing if the availability zone is valid and supported.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support availability zones.
UnsupportedOptionError – if driver does not support one of the configuration options.
Validates if driver can support the flavor.
flavor_metadata (dict) – Dictionary with flavor metadata.
Nothing if the flavor is valid and supported.
DriverError – An unexpected error occurred in the driver.
NotImplementedError – The driver does not support flavors.
UnsupportedOptionError – if driver does not support one of the configuration options.
octavia_lib.api.drivers.exceptions.NotFound – if the driver cannot find a resource.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.