# octavia.api.v2.controllers package

## Submodules

## octavia.api.v2.controllers.amphora module

class AmphoraController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:amphora:'
  delete(id)

    Deletes an amphora.

  get_all(fields=None)

    Gets all amphorae.

  get_one(id, fields=None)

    Gets a single amphora’s details.

class AmphoraStatsController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:amphora:'
  get()

class AmphoraUpdateController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:amphora:'
  put()

    Update amphora agent configuration

class FailoverController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:amphora:'
  put()

    Fails over an amphora

## octavia.api.v2.controllers.availability_zone_profiles module

class AvailabilityZoneProfileController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:availability-zone-profile:'
  delete(availability_zone_profile_id)

    Deletes an Availability Zone Profile

  get_all(fields=None)

    Lists all Availability Zone Profiles.

  get_one(id, fields=None)

    Gets an Availability Zone Profile’s detail.

  post(availability_zone_profile_)

    Creates an Availability Zone Profile.

  put(id, availability_zone_profile_)

    Updates an Availability Zone Profile.

## octavia.api.v2.controllers.availability_zones module

class AvailabilityZonesController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:availability-zone:'
  delete(availability_zone_name)

    Deletes an Availability Zone

  get_all(fields=None)

    Lists all Availability Zones.

  get_one(name, fields=None)

    Gets an Availability Zone’s detail.

  post(availability_zone_)

    Creates an Availability Zone.

  put(name, availability_zone_)

## octavia.api.v2.controllers.base module

class BaseController(*args, **kwargs)

  Bases: `RestController`

  RBAC_TYPE = None

## octavia.api.v2.controllers.flavor_profiles module

class FlavorProfileController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:flavor-profile:'
  delete(flavor_profile_id)

    Deletes a Flavor Profile

  get_all(fields=None)

    Lists all flavor profiles.

  get_one(id, fields=None)

    Gets a flavor profile’s detail.

  post(flavor_profile_)

    Creates a flavor Profile.

  put(id, flavor_profile_)

    Updates a flavor Profile.

## octavia.api.v2.controllers.flavors module

class FlavorsController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:flavor:'
  delete(flavor_id)

    Deletes a Flavor

  get_all(fields=None)

    Lists all flavors.

  get_one(id, fields=None)

    Gets a flavor’s detail.

  post(flavor_)

    Creates a flavor.

  put(id, flavor_)

## octavia.api.v2.controllers.health_monitor module

class HealthMonitorController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:healthmonitor:'
  delete(id)

    Deletes a health monitor.

  get_all(project_id=None, fields=None)

    Gets all health monitors.

  get_one(id, fields=None)

    Gets a single healthmonitor’s details.

  post(health_monitor_)

    Creates a health monitor on a pool.

  put(id, health_monitor_)

    Updates a health monitor.

## octavia.api.v2.controllers.l7policy module

class L7PolicyController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:l7policy:'
  delete(id)

    Deletes a l7policy.

  get(id, fields=None)

    Gets a single l7policy’s details.

  get_all(project_id=None, fields=None)

    Lists all l7policies of a listener.

  post(l7policy_)

    Creates a l7policy on a listener.

  put(id, l7policy_)

    Updates a l7policy.

## octavia.api.v2.controllers.l7rule module

class L7RuleController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:l7rule:'
  delete(id)

    Deletes a l7rule.

  get(id, fields=None)

    Gets a single l7rule’s details.

  get_all(fields=None)

    Lists all l7rules of a l7policy.

  post(rule_)

    Creates a l7rule on an l7policy.

  put(id, l7rule_)

    Updates a l7rule.

## octavia.api.v2.controllers.listener module

class ListenersController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:listener:'
  delete(id)

    Deletes a listener from a load balancer.

  get_all(project_id=None, fields=None)

    Lists all listeners.

  get_one(id, fields=None)

    Gets a single listener’s details.

  post(listener_)

    Creates a listener on a load balancer.

  put(id, listener_: ListenerRootPUT)

    Updates a listener on a load balancer.

class StatisticsController(*args, **kwargs)

  Bases: `BaseController`, `StatsMixin`

  RBAC_TYPE = 'os_load-balancer_api:listener:'
  get()

## octavia.api.v2.controllers.load_balancer module

class FailoverController(*args, **kwargs)

  Bases: `LoadBalancersController`

  put(**kwargs)

    Fails over a loadbalancer

class LoadBalancersController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:loadbalancer:'
  delete(id, cascade=False)

    Deletes a load balancer.

  get_all(project_id=None, fields=None)

    Lists all load balancers.

  get_one(id, fields=None)

    Gets a single load balancer’s details.

  post(load_balancer: LoadBalancerRootPOST)

    Creates a load balancer.

  put(id, load_balancer)

    Updates a load balancer.

class StatisticsController(*args, **kwargs)

  Bases: `BaseController`, `StatsMixin`

  RBAC_TYPE = 'os_load-balancer_api:loadbalancer:'
  get()

class StatusController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:loadbalancer:'
  get()

## octavia.api.v2.controllers.member module

class MemberController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:member:'
  delete(id)

    Deletes a pool member.

  get(id, fields=None)

    Gets a single pool member’s details.

  get_all(fields=None)

    Lists all pool members of a pool.

  post(member_)

    Creates a pool member on a pool.

  put(id, member_)

    Updates a pool member.

class MembersController(*args, **kwargs)

  Bases: `MemberController`

  put(additive_only=False, members_=None)

    Updates all members.

## octavia.api.v2.controllers.pool module

class PoolsController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:pool:'
  delete(id)

    Deletes a pool from a load balancer.

  get(id, fields=None)

    Gets a pool’s details.

  get_all(project_id=None, fields=None)

    Lists all pools.

  post(pool_)

    Creates a pool on a load balancer or listener.

    Note that this can optionally take a listener_id with which the pool should be associated as the listener’s default_pool. If specified, the pool creation will fail if the listener specified already has a default_pool.

  put(id, pool_)

    Updates a pool on a load balancer.

## octavia.api.v2.controllers.provider module

class AvailabilityZoneCapabilitiesController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:provider-availability-zone:'
  get_all(fields=None)

class FlavorCapabilitiesController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:provider-flavor:'
  get_all(fields=None)

class ProviderController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:provider:'
  get_all(fields=None)

    List enabled provider drivers and their descriptions.

## octavia.api.v2.controllers.quotas module

class QuotasController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:quota:'
  delete(project_id)

    Reset a project’s quotas to the default values.

  get(project_id)

    Get a single project’s quota details.

  get_all(project_id=None)

    List all non-default quotas.

  put(project_id, quotas)

    Update any or all quotas for a project.

class QuotasDefaultController(*args, **kwargs)

  Bases: `BaseController`

  RBAC_TYPE = 'os_load-balancer_api:quota:'
  get()

    Get a project’s default quota details.

## Module contents

class BaseV2Controller(*args, **kwargs)

  Bases: `BaseController`

  get()
  healthmonitors = None
  l7policies = None
  listeners = None
  loadbalancers = None
  pools = None
  quotas = None

class OctaviaV2Controller(*args, **kwargs)

  Bases: `BaseController`

  amphorae = None
  get()

class V2Controller(*args, **kwargs)

  Bases: `BaseV2Controller`

  lbaas = None

this page last updated: 2025-04-03 17:35:57

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