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.
openstack.load_balancer.v2._proxy.
Proxy
(*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: |
|
---|---|
Returns: |
|
find_load_balancer
(name_or_id, ignore_missing=True)¶Find a single load balancer
Parameters: |
|
---|---|
Returns: |
|
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 |
get_load_balancer_statistics
(name_or_id)¶Get the load balancer statistics
Parameters: | name_or_id – The name or ID of a load balancer |
---|---|
Returns: | One
LoadBalancerStats |
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: |
|
---|---|
Returns: | The updated load_balancer |
Return type: |
failover_load_balancer
(name_or_id, **attrs)¶Failover a load balancer
Parameters: | name_or_id – The name or ID of a load balancer |
---|---|
Returns: | None |
openstack.load_balancer.v2._proxy.
Proxy
(*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: |
|
---|---|
Returns: |
|
find_listener
(name_or_id, ignore_missing=True)¶Find a single listener
Parameters: |
|
---|---|
Returns: | One |
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. |
get_listener_statistics
(listener)¶Get the listener statistics
Parameters: | listener – The value can be the ID of a listener or a
Listener
instance. |
---|---|
Returns: | One
ListenerStats |
Raises: | ResourceNotFound
when no resource can be found. |
openstack.load_balancer.v2._proxy.
Proxy
(*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: |
|
---|---|
Returns: |
|
find_pool
(name_or_id, ignore_missing=True)¶Find a single pool
Parameters: |
|
---|---|
Returns: |
|
pools
(**query)¶Retrieve a generator of pools
Returns: | A generator of Pool instances |
---|
openstack.load_balancer.v2._proxy.
Proxy
(*args, **kwargs)create_member
(pool, **attrs)¶Create a new member from attributes
Parameters: | |
---|---|
Returns: | The results of member creation |
Return type: |
delete_member
(member, pool, ignore_missing=True)¶Delete a member
Parameters: |
|
---|---|
Returns: |
|
find_member
(name_or_id, pool, ignore_missing=True)¶Find a single member
Parameters: |
|
---|---|
Returns: | One |
get_member
(member, pool)¶Get a single member
Parameters: | |
---|---|
Returns: | One |
Raises: |
|
members
(pool, **query)¶Return a generator of members
Parameters: |
|
---|---|
Returns: | A generator of member objects |
Return type: |
update_member
(member, pool, **attrs)¶Update a member
Parameters: | |
---|---|
Returns: | The updated member |
Return type: |
openstack.load_balancer.v2._proxy.
Proxy
(*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: |
|
---|---|
Returns: |
|
find_health_monitor
(name_or_id, ignore_missing=True)¶Find a single health monitor
Parameters: |
|
---|---|
Returns: | The
|
Raises: |
|
Raises: |
|
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 |
update_health_monitor
(healthmonitor, **attrs)¶Update a health monitor
Parameters: |
|
---|---|
Returns: | The updated health monitor |
Return type: |
|
openstack.load_balancer.v2._proxy.
Proxy
(*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: |
|
---|---|
Returns: |
|
find_l7_policy
(name_or_id, ignore_missing=True)¶Find a single l7policy
Parameters: |
|
---|---|
Returns: | One |
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. |
openstack.load_balancer.v2._proxy.
Proxy
(*args, **kwargs)create_l7_rule
(l7_policy, **attrs)¶Create a new l7rule from attributes
Parameters: | |
---|---|
Returns: | The results of l7rule creation |
Return type: |
delete_l7_rule
(l7rule, l7_policy, ignore_missing=True)¶Delete a l7rule
Parameters: |
|
---|---|
Returns: |
|
find_l7_rule
(name_or_id, l7_policy, ignore_missing=True)¶Find a single l7rule
Parameters: |
|
---|---|
Returns: | One |
get_l7_rule
(l7rule, l7_policy)¶Get a single l7rule
Parameters: | |
---|---|
Returns: | One |
Raises: |
|
l7_rules
(l7_policy, **query)¶Return a generator of l7rules
Parameters: |
|
---|---|
Returns: | A generator of l7rule objects |
Return type: |
update_l7_rule
(l7rule, l7_policy, **attrs)¶Update a l7rule
Parameters: | |
---|---|
Returns: | The updated l7rule |
Return type: |
openstack.load_balancer.v2._proxy.
Proxy
(*args, **kwargs)providers
(**query)¶Retrieve a generator of providers
Returns: | A generator of providers instances |
---|
provider_flavor_capabilities
(provider, **query)¶Retrieve a generator of provider flavor capabilities
Returns: | A generator of provider flavor capabilities instances |
---|
openstack.load_balancer.v2._proxy.
Proxy
(*args, **kwargs)create_flavor_profile
(**attrs)¶Create a new flavor profile from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a FlavorProfile ,
comprised of the properties on the
FlavorProfile class. |
---|---|
Returns: | The results of profile creation creation |
Return type: |
FlavorProfile |
get_flavor_profile
(*attrs)¶Get a flavor profile
Parameters: | flavor_profile – The value can be the name of a flavor profile
or
FlavorProfile instance. |
---|---|
Returns: | One
FlavorProfile |
flavor_profiles
(**query)¶Retrieve a generator of flavor profiles
Returns: | A generator of flavor profiles instances |
---|
delete_flavor_profile
(flavor_profile, ignore_missing=True)¶Delete a flavor profile
Parameters: |
|
---|---|
Returns: |
|
find_flavor_profile
(name_or_id, ignore_missing=True)¶Find a single flavor profile
Parameters: |
|
---|---|
Returns: |
|
update_flavor_profile
(flavor_profile, **attrs)¶Update a flavor profile
Parameters: |
|
---|---|
Returns: | The updated flavor profile |
Return type: |
|
openstack.load_balancer.v2._proxy.
Proxy
(*args, **kwargs)create_flavor
(**attrs)¶Create a new flavor from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Flavor , comprised of the properties on the
Flavorclass. |
---|---|
Returns: | The results of flavor creation creation |
Return type: | Flavor |
get_flavor
(*attrs)¶Get a flavor
Parameters: | flavor – The value can be the name of a flavor
or Flavor instance. |
---|---|
Returns: | One
Flavor |
flavors
(**query)¶Retrieve a generator of flavors
Returns: | A generator of flavor instances |
---|
delete_flavor
(flavor, ignore_missing=True)¶Delete a flavor
Parameters: |
|
---|---|
Returns: |
|
find_flavor
(name_or_id, ignore_missing=True)¶Find a single flavor
Parameters: |
|
---|---|
Returns: |
|
openstack.load_balancer.v2._proxy.
Proxy
(*args, **kwargs)amphorae
(**query)¶Retrieve a generator of amphorae
Returns: | A generator of amphora instances |
---|
get_amphora
(*attrs)¶Get a amphora
Parameters: | amphora – The value can be the ID of an amphora
or Amphora instance. |
---|---|
Returns: | One
Amphora |
find_amphora
(amphora_id, ignore_missing=True)¶Find a single amphora
Parameters: |
|
---|---|
Returns: |
|
configure_amphora
(amphora_id, **attrs)¶Update the configuration of an amphora agent
Parameters: | amphora_id – The ID of an amphora |
---|---|
Returns: | None |
failover_amphora
(amphora_id, **attrs)¶Failover an amphora
Parameters: | amphora_id – The ID of an amphora |
---|---|
Returns: | None |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.