# octavia.api.drivers package

## Subpackages

- octavia.api.drivers.amphora_driver package
  - Subpackages
    - octavia.api.drivers.amphora_driver.v1 package
      - Submodules
      - octavia.api.drivers.amphora_driver.v1.driver module
      - Module contents
    - octavia.api.drivers.amphora_driver.v2 package
      - Submodules
      - octavia.api.drivers.amphora_driver.v2.driver module
      - Module contents
  - Submodules
  - octavia.api.drivers.amphora_driver.availability_zone_schema module
  - octavia.api.drivers.amphora_driver.flavor_schema module
  - Module contents
- octavia.api.drivers.driver_agent package
  - Submodules
  - octavia.api.drivers.driver_agent.driver_get module
  - octavia.api.drivers.driver_agent.driver_listener module
  - octavia.api.drivers.driver_agent.driver_updater module
  - Module contents
- octavia.api.drivers.noop_driver package
  - Submodules
  - octavia.api.drivers.noop_driver.agent module
  - octavia.api.drivers.noop_driver.driver module
  - Module contents

## Submodules

## octavia.api.drivers.data_models module

class `BaseDataModel`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.data_models.BaseDataModel`

class `HealthMonitor`(admin_state_up=Unset, delay=Unset, expected_codes=Unset, healthmonitor_id=Unset, http_method=Unset, max_retries=Unset, max_retries_down=Unset, name=Unset, pool_id=Unset, timeout=Unset, type=Unset, url_path=Unset, http_version=Unset, domain_name=Unset, project_id=Unset)

  Bases: `octavia_lib.api.drivers.data_models.HealthMonitor`

class `L7Policy`(action=Unset, admin_state_up=Unset, description=Unset, l7policy_id=Unset, listener_id=Unset, name=Unset, position=Unset, redirect_pool_id=Unset, redirect_url=Unset, rules=Unset, redirect_prefix=Unset, redirect_http_code=Unset, project_id=Unset)

  Bases: `octavia_lib.api.drivers.data_models.L7Policy`

class `L7Rule`(admin_state_up=Unset, compare_type=Unset, invert=Unset, key=Unset, l7policy_id=Unset, l7rule_id=Unset, type=Unset, value=Unset, project_id=Unset)

  Bases: `octavia_lib.api.drivers.data_models.L7Rule`

class `Listener`(admin_state_up=Unset, connection_limit=Unset, default_pool=Unset, default_pool_id=Unset, default_tls_container_ref=Unset, default_tls_container_data=Unset, description=Unset, insert_headers=Unset, l7policies=Unset, listener_id=Unset, loadbalancer_id=Unset, name=Unset, protocol=Unset, protocol_port=Unset, sni_container_refs=Unset, sni_container_data=Unset, timeout_client_data=Unset, timeout_member_connect=Unset, timeout_member_data=Unset, timeout_tcp_inspect=Unset, client_ca_tls_container_ref=Unset, client_ca_tls_container_data=Unset, client_authentication=Unset, client_crl_container_ref=Unset, client_crl_container_data=Unset, project_id=Unset, allowed_cidrs=Unset, tls_versions=Unset, tls_ciphers=Unset)

  Bases: `octavia_lib.api.drivers.data_models.Listener`

class `LoadBalancer`(admin_state_up=Unset, description=Unset, flavor=Unset, listeners=Unset, loadbalancer_id=Unset, name=Unset, pools=Unset, project_id=Unset, vip_address=Unset, vip_network_id=Unset, vip_port_id=Unset, vip_subnet_id=Unset, vip_qos_policy_id=Unset, additional_vips=Unset, availability_zone=Unset)

  Bases: `octavia_lib.api.drivers.data_models.LoadBalancer`

class `Member`(address=Unset, admin_state_up=Unset, member_id=Unset, monitor_address=Unset, monitor_port=Unset, name=Unset, pool_id=Unset, protocol_port=Unset, subnet_id=Unset, weight=Unset, backup=Unset, project_id=Unset)

  Bases: `octavia_lib.api.drivers.data_models.Member`

class `Pool`(admin_state_up=Unset, description=Unset, healthmonitor=Unset, lb_algorithm=Unset, loadbalancer_id=Unset, members=Unset, name=Unset, pool_id=Unset, listener_id=Unset, protocol=Unset, session_persistence=Unset, tls_container_ref=Unset, tls_container_data=Unset, ca_tls_container_ref=Unset, ca_tls_container_data=Unset, crl_container_ref=Unset, crl_container_data=Unset, tls_enabled=Unset, project_id=Unset, tls_versions=Unset, tls_ciphers=Unset)

  Bases: `octavia_lib.api.drivers.data_models.Pool`

class `UnsetType`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.data_models.UnsetType`

class `VIP`(vip_address=Unset, vip_network_id=Unset, vip_port_id=Unset, vip_subnet_id=Unset, vip_qos_policy_id=Unset)

  Bases: `octavia_lib.api.drivers.data_models.VIP`

## octavia.api.drivers.driver_factory module

`get_driver`(provider)

## octavia.api.drivers.driver_lib module

class `DriverLibrary`(status_socket='/var/run/octavia/status.sock', stats_socket='/var/run/octavia/stats.sock', get_socket='/var/run/octavia/get.sock', **kwargs)

  Bases: `octavia_lib.api.drivers.driver_lib.DriverLibrary`

## octavia.api.drivers.exceptions module

exception `DriverError`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.exceptions.DriverError`

exception `NotImplementedError`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.exceptions.NotImplementedError`

exception `UnsupportedOptionError`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.exceptions.UnsupportedOptionError`

exception `UpdateStatisticsError`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.exceptions.UpdateStatisticsError`

exception `UpdateStatusError`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.exceptions.UpdateStatusError`

## octavia.api.drivers.provider_base module

class `ProviderDriver`(*args, **kwargs)

  Bases: `octavia_lib.api.drivers.provider_base.ProviderDriver`

## octavia.api.drivers.utils module

`call_provider`(provider, driver_method, *args, **kwargs)

  Wrap calls to the provider driver to handle driver errors.

  This allows Octavia to return user friendly errors when a provider driver has an issue.

  Parameters: | driver_method – Method in the driver to call.

  Raises:

  - ProviderDriverError – Catch all driver error.
  - ProviderNotImplementedError – The driver doesn’t support this action.
  - ProviderUnsupportedOptionError – The driver doesn’t support a provided option.

`db_HM_to_provider_HM`(db_hm)

`db_l7policies_to_provider_l7policies`(db_l7policies)

`db_l7policy_to_provider_l7policy`(db_l7policy)

`db_l7rule_to_provider_l7rule`(db_l7rule)

`db_l7rules_to_provider_l7rules`(db_l7rules)

`db_listener_to_provider_listener`(db_listener, for_delete=False)

`db_listeners_to_provider_dicts_list_of_dicts`(db_listeners, for_delete=False)

`db_listeners_to_provider_listeners`(db_listeners, for_delete=False)

`db_loadbalancer_to_provider_loadbalancer`(db_loadbalancer, for_delete=False)

`db_member_to_provider_member`(db_member)

`db_members_to_provider_members`(db_members)

`db_pool_to_provider_pool`(db_pool, for_delete=False)

`db_pools_to_provider_pools`(db_pools, for_delete=False)

`hm_dict_to_provider_dict`(hm_dict)

`l7policy_dict_to_provider_dict`(l7policy_dict)

`l7rule_dict_to_provider_dict`(l7rule_dict)

`lb_dict_to_provider_dict`(lb_dict, vip=None, db_pools=None, db_listeners=None, for_delete=False)

`listener_dict_to_provider_dict`(listener_dict, for_delete=False)

`member_dict_to_provider_dict`(member_dict)

`pool_dict_to_provider_dict`(pool_dict, for_delete=False)

`provider_vip_dict_to_vip_obj`(vip_dictionary)

`vip_dict_to_provider_dict`(vip_dict)

## Module contents

this page last updated: 2020-04-10 18:17:54

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug questions?