Load Balancer v2 API

updated: 2020-04-17 12:00

Load Balancer v2 API¶

The LoadBalancer Class¶

The load_balancer high-level interface is available through the load_balancer member of a Connection object. The load_balancer member will only be added if the service is detected.

Load Balancer Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)¶

create_load_balancer(**attrs)¶

Create a new load balancer from attributes

Parameters:	attrs (dict) – Keyword arguments which will be used to create a `LoadBalancer`, comprised of the properties on the LoadBalancer class.
Returns:	The results of load balancer creation
Return type:	`LoadBalancer`

delete_load_balancer(load_balancer, ignore_missing=True, cascade=False)¶

Delete a load balancer

Parameters:

Parameters:	load_balancer – The load_balancer can be either the name or a `LoadBalancer` instance ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the load balancer does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent load balancer. cascade (bool) – If true will delete all child objects of the load balancer.
Returns:	`None`

load_balancer – The load_balancer can be either the name or a LoadBalancer instance
ignore_missing (bool) – When set to False ResourceNotFound will be raised when the load balancer does not exist. When set to True, no exception will be set when attempting to delete a nonexistent load balancer.
cascade (bool) – If true will delete all child objects of the load balancer.

Returns:

None

find_load_balancer(name_or_id, ignore_missing=True)¶

Find a single load balancer

Parameters:	name_or_id – The name or ID of a load balancer ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the load balancer does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent load balancer.
Returns:	`None`

get_load_balancer(*attrs)¶

Get a load balancer

Parameters:	load_balancer – The value can be the name of a load balancer or `LoadBalancer` instance.
Returns:	One `LoadBalancer`

load_balancers(**query)¶

Retrieve a generator of load balancers

Returns:	A generator of load balancer instances

update_load_balancer(load_balancer, **attrs)¶

Update a load balancer

Parameters:	load_balancer – The load_balancer can be either the name or a `LoadBalancer` instance attrs (dict) – The attributes to update on the load balancer represented by `load_balancer`.
Returns:	The updated load_balancer
Return type:	`LoadBalancer`

Listener Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)

create_listener(**attrs)¶

Create a new listener from attributes

Parameters:	attrs (dict) – Keyword arguments which will be used to create a `Listener`, comprised of the properties on the Listener class.
Returns:	The results of listener creation
Return type:	`Listener`

delete_listener(listener, ignore_missing=True)¶

Delete a listener

Parameters:	listener – The value can be either the ID of a listner or a `Listener` instance. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the listner does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent listener.
Returns:	`None`

find_listener(name_or_id, ignore_missing=True)¶

Find a single listener

Parameters:	name_or_id – The name or ID of a listener. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the resource does not exist. When set to `True`, None will be returned when attempting to find a nonexistent resource.
Returns:	One `Listener` or None

get_listener(listener)¶

Get a single listener

Parameters:	listener – The value can be the ID of a listener or a `Listener` instance.
Returns:	One `Listener`
Raises:	`ResourceNotFound` when no resource can be found.

listeners(**query)¶

Return a generator of listeners

Parameters:	query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
Returns:	A generator of listener objects
Return type:	`Listener`

update_listener(listener, **attrs)¶

Update a listener

Parameters:	listener – Either the id of a listener or a `Listener` instance. attrs (dict) – The attributes to update on the listener represented by `listener`.
Returns:	The updated listener
Return type:	`Listener`

Pool Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)

create_pool(**attrs)¶

Create a new pool from attributes

Parameters:	attrs (dict) – Keyword arguments which will be used to create a `Pool`, comprised of the properties on the Pool class.
Returns:	The results of Pool creation
Return type:	`Pool`

delete_pool(pool, ignore_missing=True)¶

Delete a pool

Parameters:	pool – The pool is a `Pool` instance ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the pool does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent pool.
Returns:	`None`

find_pool(name_or_id, ignore_missing=True)¶

Find a single pool

Parameters:	name_or_id – The name or ID of a pool ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the pool does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent pool.
Returns:	`None`

get_pool(*attrs)¶

Get a pool

Parameters:	pool – Value is `Pool` instance.
Returns:	One `Pool`

pools(**query)¶

Retrieve a generator of pools

Returns:	A generator of Pool instances

update_pool(pool, **attrs)¶

Update a pool

Parameters:	pool – Either the id of a pool or a `Pool` instance. attrs (dict) – The attributes to update on the pool represented by `pool`.
Returns:	The updated pool
Return type:	`Pool`

Member Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)

create_member(pool, **attrs)¶

Create a new member from attributes

Parameters:	pool – The pool can be either the ID of a pool or a `Pool` instance that the member will be created in. attrs (dict) – Keyword arguments which will be used to create a `Member`, comprised of the properties on the Member class.
Returns:	The results of member creation
Return type:	`Member`

delete_member(member, pool, ignore_missing=True)¶

Delete a member

Parameters:	member – The member can be either the ID of a member or a `Member` instance. pool – The pool can be either the ID of a pool or a `Pool` instance that the member belongs to. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the member does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent member.
Returns:	`None`

find_member(name_or_id, pool, ignore_missing=True)¶

Find a single member

Parameters:	name_or_id (str) – The name or ID of a member. pool – The pool can be either the ID of a pool or a `Pool` instance that the member belongs to. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the resource does not exist. When set to `True`, None will be returned when attempting to find a nonexistent resource.
Returns:	One `Member` or None

get_member(member, pool)¶

Get a single member

Parameters:	member – The member can be the ID of a member or a `Member` instance. pool – The pool can be either the ID of a pool or a `Pool` instance that the member belongs to.
Returns:	One `Member`
Raises:	`ResourceNotFound` when no resource can be found.

members(pool, **query)¶

Return a generator of members

Parameters:	pool – The pool can be either the ID of a pool or a `Pool` instance that the member belongs to. query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
Returns:	A generator of member objects
Return type:	`Member`

update_member(member, pool, **attrs)¶

Update a member

Parameters:	member – Either the ID of a member or a `Member` instance. pool – The pool can be either the ID of a pool or a `Pool` instance that the member belongs to. attrs (dict) – The attributes to update on the member represented by `member`.
Returns:	The updated member
Return type:	`Member`

Health Monitor Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)

create_health_monitor(**attrs)¶

Create a new health monitor from attributes

Parameters:	attrs (dict) – Keyword arguments which will be used to create a `HealthMonitor`, comprised of the properties on the HealthMonitor class.
Returns:	The results of HealthMonitor creation
Return type:	`HealthMonitor`

delete_health_monitor(healthmonitor, ignore_missing=True)¶

Delete a health monitor

Parameters:	healthmonitor – The healthmonitor can be either the ID of the health monitor or a `HealthMonitor` instance ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the healthmonitor does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent healthmonitor.
Returns:	`None`

find_health_monitor(name_or_id, ignore_missing=True)¶

Find a single health monitor

Parameters:	name_or_id – The name or ID of a health monitor ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the health monitor does not exist. When set to `True`, no exception will be set when attempting to find a nonexistent health monitor.
Returns:	The `openstack.load_balancer.v2.healthmonitor.HealthMonitor` object matching the given name or id or None if nothing matches.
Raises:	`openstack.exceptions.DuplicateResource` if more than one resource is found for this request.
Raises:	`openstack.exceptions.ResourceNotFound` if nothing is found and ignore_missing is `False`.

get_health_monitor(healthmonitor)¶

Get a health monitor

Parameters:	healthmonitor – The value can be the ID of a health monitor or `HealthMonitor` instance.
Returns:	One health monitor
Return type:	`HealthMonitor`

health_monitors(**query)¶

Retrieve a generator of health monitors

Parameters: query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are: ‘name’, ‘created_at’, ‘updated_at’, ‘delay’, ‘expected_codes’, ‘http_method’, ‘max_retries’, ‘max_retries_down’, ‘pool_id’, ‘provisioning_status’, ‘operating_status’, ‘timeout’, ‘project_id’, ‘type’, ‘url_path’, ‘is_admin_state_up’.

Returns: A generator of health monitor instances

Parameters:	query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are: ‘name’, ‘created_at’, ‘updated_at’, ‘delay’, ‘expected_codes’, ‘http_method’, ‘max_retries’, ‘max_retries_down’, ‘pool_id’, ‘provisioning_status’, ‘operating_status’, ‘timeout’, ‘project_id’, ‘type’, ‘url_path’, ‘is_admin_state_up’.
Returns:	A generator of health monitor instances

update_health_monitor(healthmonitor, **attrs)¶

Update a health monitor

Parameters:	healthmonitor – The healthmonitor can be either the ID of the health monitor or a `HealthMonitor` instance attrs (dict) – The attributes to update on the health monitor represented by `healthmonitor`.
Returns:	The updated health monitor
Return type:	`HealthMonitor`

L7 Policy Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)

create_l7_policy(**attrs)¶

Create a new l7policy from attributes

Parameters:	attrs (dict) – Keyword arguments which will be used to create a `L7Policy`, comprised of the properties on the L7Policy class.
Returns:	The results of l7policy creation
Return type:	`L7Policy`

delete_l7_policy(l7_policy, ignore_missing=True)¶

Delete a l7policy

Parameters:	l7_policy – The value can be either the ID of a l7policy or a `L7Policy` instance. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the l7policy does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent l7policy.
Returns:	`None`

find_l7_policy(name_or_id, ignore_missing=True)¶

Find a single l7policy

Parameters:	name_or_id – The name or ID of a l7policy. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the resource does not exist. When set to `True`, None will be returned when attempting to find a nonexistent resource.
Returns:	One `L7Policy` or None

get_l7_policy(l7_policy)¶

Get a single l7policy

Parameters:	l7_policy – The value can be the ID of a l7policy or a `L7Policy` instance.
Returns:	One `L7Policy`
Raises:	`ResourceNotFound` when no resource can be found.

l7_policies(**query)¶

Return a generator of l7policies

Parameters:	query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
Returns:	A generator of l7policy objects
Return type:	`L7Policy`

update_l7_policy(l7_policy, **attrs)¶

Update a l7policy

Parameters:	l7_policy – Either the id of a l7policy or a `L7Policy` instance. attrs (dict) – The attributes to update on the l7policy represented by `l7policy`.
Returns:	The updated l7policy
Return type:	`L7Policy`

L7 Rule Operations¶

class openstack.load_balancer.v2._proxy.Proxy(session=None, task_manager=None, *args, **kwargs)

create_l7_rule(l7_policy, **attrs)¶

Create a new l7rule from attributes

Parameters:	l7_policy – The l7_policy can be either the ID of a l7policy or `L7Policy` instance that the l7rule will be created in. attrs (dict) – Keyword arguments which will be used to create a `L7Rule`, comprised of the properties on the L7Rule class.
Returns:	The results of l7rule creation
Return type:	`L7Rule`

delete_l7_rule(l7rule, l7_policy, ignore_missing=True)¶

Delete a l7rule

Parameters:

Parameters:	l7rule – The l7rule can be either the ID of a l7rule or a `L7Rule` instance. l7_policy – The l7_policy can be either the ID of a l7policy or `L7Policy` instance that the l7rule belongs to. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the l7rule does not exist. When set to `True`, no exception will be set when attempting to delete a nonexistent l7rule.
Returns:	`None`

l7rule – The l7rule can be either the ID of a l7rule or a L7Rule instance.
l7_policy – The l7_policy can be either the ID of a l7policy or L7Policy instance that the l7rule belongs to.
ignore_missing (bool) – When set to False ResourceNotFound will be raised when the l7rule does not exist. When set to True, no exception will be set when attempting to delete a nonexistent l7rule.

Returns:

None

find_l7_rule(name_or_id, l7_policy, ignore_missing=True)¶

Find a single l7rule

Parameters:	name_or_id (str) – The name or ID of a l7rule. l7_policy – The l7_policy can be either the ID of a l7policy or `L7Policy` instance that the l7rule belongs to. ignore_missing (bool) – When set to `False` `ResourceNotFound` will be raised when the resource does not exist. When set to `True`, None will be returned when attempting to find a nonexistent resource.
Returns:	One `L7Rule` or None

get_l7_rule(l7rule, l7_policy)¶

Get a single l7rule

Parameters:	l7rule – The l7rule can be the ID of a l7rule or a `L7Rule` instance. l7_policy – The l7_policy can be either the ID of a l7policy or `L7Policy` instance that the l7rule belongs to.
Returns:	One `L7Rule`
Raises:	`ResourceNotFound` when no resource can be found.

l7_rules(l7_policy, **query)¶

Return a generator of l7rules

Parameters:	l7_policy – The l7_policy can be either the ID of a l7_policy or `L7Policy` instance that the l7rule belongs to. query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
Returns:	A generator of l7rule objects
Return type:	`L7Rule`

update_l7_rule(l7rule, l7_policy, **attrs)¶

Update a l7rule

Parameters:	l7rule – Either the ID of a l7rule or a `L7Rule` instance. l7_policy – The l7_policy can be either the ID of a l7policy or `L7Policy` instance that the l7rule belongs to. attrs (dict) – The attributes to update on the l7rule represented by `l7rule`.
Returns:	The updated l7rule
Return type:	`L7Rule`

updated: 2020-04-17 12:00

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.