# octavia.api.drivers package

## Subpackages

- octavia.api.drivers.amphora_driver package
  - Subpackages
    - 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
    - `process_get()`
  - octavia.api.drivers.driver_agent.driver_listener module
    - `ForkingUDSServer`
    - `GetRequestHandler`
      - `GetRequestHandler.handle()`
    - `StatsRequestHandler`
      - `StatsRequestHandler.handle()`
    - `StatusRequestHandler`
      - `StatusRequestHandler.handle()`
    - `get_listener()`
    - `stats_listener()`
    - `status_listener()`
  - octavia.api.drivers.driver_agent.driver_updater module
    - `DriverUpdater`
      - `DriverUpdater.update_listener_statistics()`
      - `DriverUpdater.update_loadbalancer_status()`
  - Module contents
- octavia.api.drivers.noop_driver package
  - Submodules
  - octavia.api.drivers.noop_driver.agent module
    - `noop_provider_agent()`
  - octavia.api.drivers.noop_driver.driver module
    - `NoopManager`
      - `NoopManager.create_vip_port()`
      - `NoopManager.get_supported_availability_zone_metadata()`
      - `NoopManager.get_supported_flavor_metadata()`
      - `NoopManager.health_monitor_create()`
      - `NoopManager.health_monitor_delete()`
      - `NoopManager.health_monitor_update()`
      - `NoopManager.l7policy_create()`
      - `NoopManager.l7policy_delete()`
      - `NoopManager.l7policy_update()`
      - `NoopManager.l7rule_create()`
      - `NoopManager.l7rule_delete()`
      - `NoopManager.l7rule_update()`
      - `NoopManager.listener_create()`
      - `NoopManager.listener_delete()`
      - `NoopManager.listener_update()`
      - `NoopManager.loadbalancer_create()`
      - `NoopManager.loadbalancer_delete()`
      - `NoopManager.loadbalancer_failover()`
      - `NoopManager.loadbalancer_update()`
      - `NoopManager.member_batch_update()`
      - `NoopManager.member_create()`
      - `NoopManager.member_delete()`
      - `NoopManager.member_update()`
      - `NoopManager.pool_create()`
      - `NoopManager.pool_delete()`
      - `NoopManager.pool_update()`
      - `NoopManager.validate_availability_zone()`
      - `NoopManager.validate_flavor()`
    - `NoopProviderDriver`
      - `NoopProviderDriver.create_vip_port()`
      - `NoopProviderDriver.get_supported_availability_zone_metadata()`
      - `NoopProviderDriver.get_supported_flavor_metadata()`
      - `NoopProviderDriver.health_monitor_create()`
      - `NoopProviderDriver.health_monitor_delete()`
      - `NoopProviderDriver.health_monitor_update()`
      - `NoopProviderDriver.l7policy_create()`
      - `NoopProviderDriver.l7policy_delete()`
      - `NoopProviderDriver.l7policy_update()`
      - `NoopProviderDriver.l7rule_create()`
      - `NoopProviderDriver.l7rule_delete()`
      - `NoopProviderDriver.l7rule_update()`
      - `NoopProviderDriver.listener_create()`
      - `NoopProviderDriver.listener_delete()`
      - `NoopProviderDriver.listener_update()`
      - `NoopProviderDriver.loadbalancer_create()`
      - `NoopProviderDriver.loadbalancer_delete()`
      - `NoopProviderDriver.loadbalancer_failover()`
      - `NoopProviderDriver.loadbalancer_update()`
      - `NoopProviderDriver.member_batch_update()`
      - `NoopProviderDriver.member_create()`
      - `NoopProviderDriver.member_delete()`
      - `NoopProviderDriver.member_update()`
      - `NoopProviderDriver.pool_create()`
      - `NoopProviderDriver.pool_delete()`
      - `NoopProviderDriver.pool_update()`
      - `NoopProviderDriver.validate_availability_zone()`
      - `NoopProviderDriver.validate_flavor()`
  - Module contents

## Submodules

## octavia.api.drivers.driver_factory module

get_driver(provider)

get_providers()

remove_providers(providers)

## octavia.api.drivers.utils module

additional_vip_dict_to_provider_dict(vip_dict)

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_additional_vips_to_provider_vips(db_add_vips)

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, add_vips=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_additional_vip_dict_to_additional_vip_obj(vip_dictionary)

provider_vip_dict_to_vip_obj(vip_dictionary)

vip_dict_to_provider_dict(vip_dict)

## Module contents

this page last updated: 2026-03-10 18:02:42

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