octavia.api.v2.controllers package¶

Submodules¶

octavia.api.v2.controllers.amphora module¶

class AmphoraController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:amphora:'¶

delete(id)[source]¶

Deletes an amphora.

get_all(fields=None)[source]¶

Gets all amphorae.

get_one(id, fields=None)[source]¶

Gets a single amphora’s details.

class AmphoraStatsController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:amphora:'¶

get()[source]¶

class AmphoraUpdateController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:amphora:'¶

put()[source]¶

Update amphora agent configuration

class FailoverController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:amphora:'¶

put()[source]¶

Fails over an amphora

octavia.api.v2.controllers.availability_zone_profiles module¶

class AvailabilityZoneProfileController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:availability-zone-profile:'¶

delete(availability_zone_profile_id)[source]¶

Deletes an Availability Zone Profile

get_all(fields=None)[source]¶

Lists all Availability Zone Profiles.

get_one(id, fields=None)[source]¶

Gets an Availability Zone Profile’s detail.

post(availability_zone_profile_)[source]¶

Creates an Availability Zone Profile.

put(id, availability_zone_profile_)[source]¶

Updates an Availability Zone Profile.

octavia.api.v2.controllers.availability_zones module¶

class AvailabilityZonesController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:availability-zone:'¶

delete(availability_zone_name)[source]¶

Deletes an Availability Zone

get_all(fields=None)[source]¶

Lists all Availability Zones.

get_one(name, fields=None)[source]¶

Gets an Availability Zone’s detail.

post(availability_zone_)[source]¶

Creates an Availability Zone.

put(name, availability_zone_)[source]¶

octavia.api.v2.controllers.base module¶

class BaseController(*args, **kwargs)[source]¶

Bases: pecan.rest.RestController

RBAC_TYPE = None¶

octavia.api.v2.controllers.flavor_profiles module¶

class FlavorProfileController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:flavor-profile:'¶

delete(flavor_profile_id)[source]¶

Deletes a Flavor Profile

get_all(fields=None)[source]¶

Lists all flavor profiles.

get_one(id, fields=None)[source]¶

Gets a flavor profile’s detail.

post(flavor_profile_)[source]¶

Creates a flavor Profile.

put(id, flavor_profile_)[source]¶

Updates a flavor Profile.

octavia.api.v2.controllers.flavors module¶

class FlavorsController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:flavor:'¶

delete(flavor_id)[source]¶

Deletes a Flavor

get_all(fields=None)[source]¶

Lists all flavors.

get_one(id, fields=None)[source]¶

Gets a flavor’s detail.

post(flavor_)[source]¶

Creates a flavor.

put(id, flavor_)[source]¶

octavia.api.v2.controllers.health_monitor module¶

class HealthMonitorController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:healthmonitor:'¶

delete(id)[source]¶

Deletes a health monitor.

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

Gets all health monitors.

get_one(id, fields=None)[source]¶

Gets a single healthmonitor’s details.

post(health_monitor_)[source]¶

Creates a health monitor on a pool.

put(id, health_monitor_)[source]¶

Updates a health monitor.

octavia.api.v2.controllers.l7policy module¶

class L7PolicyController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:l7policy:'¶

delete(id)[source]¶

Deletes a l7policy.

get(id, fields=None)[source]¶

Gets a single l7policy’s details.

get_all(project_id=None, fields=None)[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.v2.controllers.l7rule module¶

class L7RuleController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:l7rule:'¶

delete(id)[source]¶

Deletes a l7rule.

get(id, fields=None)[source]¶

Gets a single l7rule’s details.

get_all(fields=None)[source]¶

Lists all l7rules of a l7policy.

post(rule_)[source]¶

Creates a l7rule on an l7policy.

put(id, l7rule_)[source]¶

Updates a l7rule.

octavia.api.v2.controllers.listener module¶

class ListenersController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:listener:'¶

delete(id)[source]¶

Deletes a listener from a load balancer.

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

Lists all listeners.

get_one(id, fields=None)[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.

class StatisticsController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:listener:'¶

get()[source]¶

octavia.api.v2.controllers.load_balancer module¶

class FailoverController(*args, **kwargs)[source]¶

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

put(**kwargs)[source]¶

Fails over a loadbalancer

class LoadBalancersController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:loadbalancer:'¶

delete(id, cascade=False)[source]¶

Deletes a load balancer.

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

Lists all load balancers.

get_one(id, fields=None)[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.

class StatisticsController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:loadbalancer:'¶

get()[source]¶

class StatusController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:loadbalancer:'¶

get()[source]¶

octavia.api.v2.controllers.member module¶

class MemberController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:member:'¶

delete(id)[source]¶

Deletes a pool member.

get(id, fields=None)[source]¶

Gets a single pool member’s details.

get_all(fields=None)[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.

class MembersController(*args, **kwargs)[source]¶

Bases: octavia.api.v2.controllers.member.MemberController

put(additive_only=False, members_=None)[source]¶

Updates all members.

octavia.api.v2.controllers.pool module¶

class PoolsController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:pool:'¶

delete(id)[source]¶

Deletes a pool from a load balancer.

get(id, fields=None)[source]¶

Gets a pool’s details.

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

Lists all pools.

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.v2.controllers.provider module¶

class AvailabilityZoneCapabilitiesController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:provider-availability-zone:'¶

get_all(fields=None)[source]¶

class FlavorCapabilitiesController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:provider-flavor:'¶

get_all(fields=None)[source]¶

class ProviderController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:provider:'¶

get_all(fields=None)[source]¶

List enabled provider drivers and their descriptions.

octavia.api.v2.controllers.quotas module¶

class QuotasController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:quota:'¶

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(project_id=None)[source]¶

List all non-default quotas.

put(project_id, quotas)[source]¶

Update any or all quotas for a project.

class QuotasDefaultController(*args, **kwargs)[source]¶

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

RBAC_TYPE = 'os_load-balancer_api:quota:'¶

get()[source]¶

Get a project’s default quota details.

Module contents¶

class BaseV2Controller(*args, **kwargs)[source]¶

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

get()[source]¶

healthmonitors = None¶

l7policies = None¶

listeners = None¶

loadbalancers = None¶

pools = None¶

quotas = None¶

class OctaviaV2Controller(*args, **kwargs)[source]¶

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

amphorae = None¶

get()[source]¶

class V2Controller(*args, **kwargs)[source]¶

Bases: octavia.api.v2.controllers.BaseV2Controller

lbaas = None¶