API over the barbican service.
octavia_dashboard.api.rest.barbican.
SSLCertificates
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for working with SSL certificate containers.
get
(request, *args, **kw)[source]¶List certificate containers.
The listing result is an object with property “items”.
url_regex
= ‘barbican/certificates/$’¶API over the neutron LBaaS v2 service.
octavia_dashboard.api.rest.lbaasv2.
HealthMonitor
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for retrieving a single health monitor.
delete
(request, *args, **kw)[source]¶Delete a specific health monitor.
http://localhost/api/lbaas/healthmonitors/cc758c90-3d98-4ea1-af44-aab405c9c915
url_regex
= ‘lbaas/healthmonitors/(?P<health_monitor_id>[^/]+)/$’¶octavia_dashboard.api.rest.lbaasv2.
HealthMonitors
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for load balancer pool health monitors.
get
(request, *args, **kw)[source]¶List of health monitors for the current project.
The listing result is an object with property “items”.
url_regex
= ‘lbaas/healthmonitors/$’¶octavia_dashboard.api.rest.lbaasv2.
Listener
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for retrieving, updating, and deleting a single listener.
delete
(request, *args, **kw)[source]¶Delete a specific listener.
http://localhost/api/lbaas/listeners/cc758c90-3d98-4ea1-af44-aab405c9c915
get
(request, *args, **kw)[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/lbaas/listeners/cc758c90-3d98-4ea1-af44-aab405c9c915
url_regex
= ‘lbaas/listeners/(?P<listener_id>[^/]+)/$’¶octavia_dashboard.api.rest.lbaasv2.
Listeners
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for load balancer listeners.
get
(request, *args, **kw)[source]¶List of listeners for the current project.
The listing result is an object with property “items”.
post
(request, *args, **kw)[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
= ‘lbaas/listeners/$’¶octavia_dashboard.api.rest.lbaasv2.
LoadBalancer
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for retrieving, updating, and deleting a single load balancer.
delete
(request, *args, **kw)[source]¶Delete a specific load balancer.
http://localhost/api/lbaas/loadbalancers/cc758c90-3d98-4ea1-af44-aab405c9c915
get
(request, *args, **kw)[source]¶Get a specific load balancer.
http://localhost/api/lbaas/loadbalancers/cc758c90-3d98-4ea1-af44-aab405c9c915
url_regex
= ‘lbaas/loadbalancers/(?P<loadbalancer_id>[^/]+)/$’¶octavia_dashboard.api.rest.lbaasv2.
LoadBalancers
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for load balancers.
get
(request, *args, **kw)[source]¶List load balancers for current project.
The listing result is an object with property “items”.
post
(request, *args, **kw)[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
= ‘lbaas/loadbalancers/$’¶octavia_dashboard.api.rest.lbaasv2.
Member
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for retrieving a single member.
url_regex
= ‘lbaas/pools/(?P<pool_id>[^/]+)/members/(?P<member_id>[^/]+)/$’¶octavia_dashboard.api.rest.lbaasv2.
Members
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for load balancer members.
get
(request, *args, **kw)[source]¶List of members for the current project.
The listing result is an object with property “items”.
url_regex
= ‘lbaas/pools/(?P<pool_id>[^/]+)/members/$’¶octavia_dashboard.api.rest.lbaasv2.
Pool
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for retrieving a single pool.
delete
(request, *args, **kw)[source]¶Delete a specific pool.
http://localhost/api/lbaas/pools/cc758c90-3d98-4ea1-af44-aab405c9c915
get
(request, *args, **kw)[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/lbaas/pools/cc758c90-3d98-4ea1-af44-aab405c9c915
url_regex
= ‘lbaas/pools/(?P<pool_id>[^/]+)/$’¶octavia_dashboard.api.rest.lbaasv2.
Pools
(**kwargs)[source]¶Bases: django.views.generic.base.View
API for load balancer pools.
get
(request, *args, **kw)[source]¶List of pools for the current project.
The listing result is an object with property “items”.
post
(request, *args, **kw)[source]¶Create a new pool.
Creates a new pool as well as other optional resources such as members and health monitor.
url_regex
= ‘lbaas/pools/$’¶octavia_dashboard.api.rest.lbaasv2.
add_floating_ip_info
(request, loadbalancers)[source]¶Add floating IP address info to each load balancer.
octavia_dashboard.api.rest.lbaasv2.
create_health_monitor
(request, **kwargs)[source]¶Create a new health monitor for a pool.
octavia_dashboard.api.rest.lbaasv2.
create_listener
(request, **kwargs)[source]¶Create a new listener.
octavia_dashboard.api.rest.lbaasv2.
get_members_to_add_remove
(request_member_data, existing_members)[source]¶octavia_dashboard.api.rest.lbaasv2.
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: |
|
---|
octavia_dashboard.api.rest.lbaasv2.
remove_member
(request, **kwargs)[source]¶Remove a member from the pool.
octavia_dashboard.api.rest.lbaasv2.
update_loadbalancer
(request, **kwargs)[source]¶Update a load balancer.
octavia_dashboard.api.rest.lbaasv2.
update_member_list
(request, **kwargs)[source]¶Update the list of members by adding or removing the necessary members.
This package holds the REST API that supports the Octavia 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.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.