octavia.api.v1.controllers package¶

Submodules¶

octavia.api.v1.controllers.base module¶

class BaseController[source]¶

Bases: pecan.rest.RestController

octavia.api.v1.controllers.health_monitor module¶

class HealthMonitorController(load_balancer_id, pool_id, listener_id=None)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete()[source]¶

Deletes a health monitor.

get_all()[source]¶

Gets a single health monitor’s details.

post(health_monitor)[source]¶

Creates a health monitor on a pool.

put(health_monitor)[source]¶

Updates a health monitor.

Updates a health monitor on a pool if it exists. Only one health monitor is allowed per pool so there is no need for a health monitor id.

octavia.api.v1.controllers.l7policy module¶

class L7PolicyController(load_balancer_id, listener_id)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(id)[source]¶

Deletes a l7policy.

get(id)[source]¶

Gets a single l7policy’s details.

get_all()[source]¶

Lists all l7policies of a listener.

post(l7policy)[source]¶

Creates a l7policy on a listener.

put(id, l7policy)[source]¶

Updates a l7policy.

octavia.api.v1.controllers.l7rule module¶

class L7RuleController(load_balancer_id, listener_id, l7policy_id)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(id)[source]¶

Deletes a l7rule.

get(id)[source]¶

Gets a single l7rule’s details.

get_all()[source]¶

Lists all l7rules of a l7policy.

post(l7rule)[source]¶

Creates a l7rule on an l7policy.

put(id, l7rule)[source]¶

Updates a l7rule.

octavia.api.v1.controllers.listener module¶

class ListenersController(load_balancer_id)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(id)[source]¶

Deletes a listener from a load balancer.

get_all()[source]¶

Lists all listeners on a load balancer.

get_one(id)[source]¶

Gets a single listener’s details.

post(listener)[source]¶

Creates a listener on a load balancer.

put(id, listener)[source]¶

Updates a listener on a load balancer.

octavia.api.v1.controllers.listener_statistics module¶

class ListenerStatisticsController(listener_id)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController, octavia.common.stats.StatsMixin

get_all()[source]¶

Gets a single listener’s statistics details.

octavia.api.v1.controllers.load_balancer module¶

class LBCascadeDeleteController(lb_id)[source]¶

Bases: octavia.api.v1.controllers.load_balancer.LoadBalancersController

delete()[source]¶

Deletes a load balancer.

class LoadBalancersController[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(id)[source]¶

Deletes a load balancer.

get_all(tenant_id=None, project_id=None)[source]¶

Lists all load balancers.

get_one(id)[source]¶

Gets a single load balancer’s details.

post(load_balancer)[source]¶

Creates a load balancer.

put(id, load_balancer)[source]¶

Updates a load balancer.

octavia.api.v1.controllers.load_balancer_statistics module¶

class LoadBalancerStatisticsController(loadbalancer_id)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController, octavia.common.stats.StatsMixin

get()[source]¶

Gets a single loadbalancer’s statistics details.

octavia.api.v1.controllers.member module¶

class MembersController(load_balancer_id, pool_id, listener_id=None)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(id)[source]¶

Deletes a pool member.

get(id)[source]¶

Gets a single pool member’s details.

get_all()[source]¶

Lists all pool members of a pool.

post(member)[source]¶

Creates a pool member on a pool.

put(id, member)[source]¶

Updates a pool member.

octavia.api.v1.controllers.pool module¶

class PoolsController(load_balancer_id, listener_id=None)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(id)[source]¶

Deletes a pool from a load balancer.

get(id)[source]¶

Gets a pool’s details.

get_all(listener_id=None)[source]¶

Lists all pools on a listener or loadbalancer.

post(pool)[source]¶

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)[source]¶

Updates a pool on a load balancer.

octavia.api.v1.controllers.quotas module¶

class QuotasController[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

delete(project_id)[source]¶

Reset a project’s quotas to the default values.

get(project_id)[source]¶

Get a single project’s quota details.

get_all()[source]¶

List all non-default quotas.

put(project_id, quotas)[source]¶

Update any or all quotas for a project.

class QuotasDefaultController(project_id)[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

get()[source]¶

Get a project’s default quota details.

Module contents¶

class V1Controller[source]¶

Bases: octavia.api.v1.controllers.base.BaseController

get()[source]¶

loadbalancers = None¶

quotas = None¶