neutron_lbaas_dashboard.api.rest package¶

Submodules¶

neutron_lbaas_dashboard.api.rest.barbican module¶

API over the barbican service.

class neutron_lbaas_dashboard.api.rest.barbican.SSLCertificates(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for working with SSL certificate containers.

get(request)[source]¶

List certificate containers.

The listing result is an object with property “items”.

url_regex = 'barbican/certificates/$'¶

class neutron_lbaas_dashboard.api.rest.barbican.Secrets(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for working with secrets.

get(request)[source]¶

List secrets.

The listing result is an object with property “items”.

url_regex = 'barbican/secrets/$'¶

neutron_lbaas_dashboard.api.rest.barbican.barbicanclient(request)[source]¶

neutron_lbaas_dashboard.api.rest.nlbaasv2 module¶

API over the neutron LBaaS v2 service.

class neutron_lbaas_dashboard.api.rest.nlbaasv2.HealthMonitor(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for retrieving a single health monitor.

delete(request, healthmonitor_id)[source]¶

Delete a specific health monitor.

http://localhost/api/nlbaas/healthmonitors/cc758c90-3d98-4ea1-af44-aab405c9c915

get(request, healthmonitor_id)[source]¶

Get a specific health monitor.

put(request, healthmonitor_id)[source]¶

Edit a health monitor.

url_regex = 'nlbaas/healthmonitors/(?P<healthmonitor_id>[^/]+)/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.HealthMonitors(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for load balancer pool health monitors.

post(request)[source]¶

Create a new health monitor.

url_regex = 'nlbaas/healthmonitors/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.Listener(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for retrieving, updating, and deleting a single listener.

delete(request, listener_id)[source]¶

Delete a specific listener.

http://localhost/api/nlbaas/listeners/cc758c90-3d98-4ea1-af44-aab405c9c915

get(request, listener_id)[source]¶

Get a specific listener.

If the param ‘includeChildResources’ is passed in as a truthy value, the details of all resources that exist under the listener will be returned along with the listener details.

http://localhost/api/nlbaas/listeners/cc758c90-3d98-4ea1-af44-aab405c9c915

put(request, listener_id)[source]¶

Edit a listener as well as any resources below it.

url_regex = 'nlbaas/listeners/(?P<listener_id>[^/]+)/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.Listeners(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for load balancer listeners.

get(request)[source]¶

List of listeners for the current project.

The listing result is an object with property “items”.

post(request)[source]¶

Create a new listener.

Creates a new listener as well as other optional resources such as a pool, members, and health monitor.

url_regex = 'nlbaas/listeners/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.LoadBalancer(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for retrieving, updating, and deleting a single load balancer.

delete(request, loadbalancer_id)[source]¶

Delete a specific load balancer.

http://localhost/api/nlbaas/loadbalancers/cc758c90-3d98-4ea1-af44-aab405c9c915

get(request, loadbalancer_id)[source]¶

Get a specific load balancer.

http://localhost/api/nlbaas/loadbalancers/cc758c90-3d98-4ea1-af44-aab405c9c915

put(request, loadbalancer_id)[source]¶

Edit a load balancer.

url_regex = 'nlbaas/loadbalancers/(?P<loadbalancer_id>[^/]+)/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.LoadBalancerStatusTree(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for retrieving the resource status tree for a single load balancer.

get(request, loadbalancer_id)[source]¶

Get the status tree for a specific load balancer.

http://localhost/api/nlbaas/loadbalancers/cc758c90-3d98-4ea1-af44-aab405c9c915/statuses

url_regex = 'nlbaas/loadbalancers/(?P<loadbalancer_id>[^/]+)/statuses/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.LoadBalancers(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for load balancers.

get(request)[source]¶

List load balancers for current project.

The listing result is an object with property “items”.

post(request)[source]¶

Create a new load balancer.

Creates a new load balancer as well as other optional resources such as a listener, pool, monitor, etc.

url_regex = 'nlbaas/loadbalancers/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.Member(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for retrieving a single member.

get(request, member_id, pool_id)[source]¶

Get a specific member belonging to a specific pool.

put(request, member_id, pool_id)[source]¶

Edit a pool member.

url_regex = 'nlbaas/pools/(?P<pool_id>[^/]+)/members/(?P<member_id>[^/]+)/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.Members(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for load balancer members.

get(request, pool_id)[source]¶

List of members for the current project.

The listing result is an object with property “items”.

put(request, pool_id)[source]¶

Update the list of members for the current project.

url_regex = 'nlbaas/pools/(?P<pool_id>[^/]+)/members/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.Pool(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for retrieving a single pool.

delete(request, pool_id)[source]¶

Delete a specific pool.

http://localhost/api/nlbaas/pools/cc758c90-3d98-4ea1-af44-aab405c9c915

get(request, pool_id)[source]¶

Get a specific pool.

If the param ‘includeChildResources’ is passed in as a truthy value, the details of all resources that exist under the pool will be returned along with the pool details.

http://localhost/api/nlbaas/pools/cc758c90-3d98-4ea1-af44-aab405c9c915

put(request, pool_id)[source]¶

Edit a listener as well as any resources below it.

url_regex = 'nlbaas/pools/(?P<pool_id>[^/]+)/$'¶

class neutron_lbaas_dashboard.api.rest.nlbaasv2.Pools(**kwargs)[source]¶

Bases: django.views.generic.base.View

API for load balancer pools.

post(request)[source]¶

Create a new pool.

Creates a new pool as well as other optional resources such as members and health monitor.

url_regex = 'nlbaas/pools/$'¶

neutron_lbaas_dashboard.api.rest.nlbaasv2.add_floating_ip_info(request, loadbalancers)[source]¶

Add floating IP address info to each load balancer.

neutron_lbaas_dashboard.api.rest.nlbaasv2.add_member(request, **kwargs)[source]¶

Add a member to a pool.

neutron_lbaas_dashboard.api.rest.nlbaasv2.create_health_monitor(request, **kwargs)[source]¶

Create a new health monitor for a pool.

neutron_lbaas_dashboard.api.rest.nlbaasv2.create_listener(request, **kwargs)[source]¶

Create a new listener.

neutron_lbaas_dashboard.api.rest.nlbaasv2.create_loadbalancer(request)[source]¶

neutron_lbaas_dashboard.api.rest.nlbaasv2.create_pool(request, **kwargs)[source]¶

Create a new pool.

neutron_lbaas_dashboard.api.rest.nlbaasv2.get_members_to_add_remove(request_member_data, existing_members)[source]¶

neutron_lbaas_dashboard.api.rest.nlbaasv2.poll_loadbalancer_status(request, loadbalancer_id, callback, from_state='PENDING_UPDATE', to_state='ACTIVE', callback_kwargs=None)[source]¶

Poll for the status of the load balancer.

Polls for the status of the load balancer and calls a function when the status changes to a specified state.

Parameters

• request – django request object

• loadbalancer_id – id of the load balancer to poll

• callback – function to call when polling is complete

• from_state – initial expected state of the load balancer

• to_state – state to check for

• callback_kwargs – kwargs to pass into the callback function

neutron_lbaas_dashboard.api.rest.nlbaasv2.remove_member(request, **kwargs)[source]¶

Remove a member from the pool.

neutron_lbaas_dashboard.api.rest.nlbaasv2.update_listener(request, **kwargs)[source]¶

Update a listener.

neutron_lbaas_dashboard.api.rest.nlbaasv2.update_loadbalancer(request, **kwargs)[source]¶

Update a load balancer.

neutron_lbaas_dashboard.api.rest.nlbaasv2.update_member_list(request, **kwargs)[source]¶

Update the list of members by adding or removing the necessary members.

neutron_lbaas_dashboard.api.rest.nlbaasv2.update_monitor(request, **kwargs)[source]¶

Update a health monitor.

neutron_lbaas_dashboard.api.rest.nlbaasv2.update_pool(request, **kwargs)[source]¶

Update a pool.

Module contents¶

This package holds the REST API that supports the LBaaS v2 dashboard Javascript code.

It is not intended to be used outside of Horizon, and makes no promises of stability or fitness for purpose outside of that scope.

It does not promise to adhere to the general OpenStack API Guidelines set out in https://wiki.openstack.org/wiki/APIChangeGuidelines.