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
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)¶create_load_balancer
(**attrs)¶Create a new load balancer from attributes
attrs (dict) – Keyword arguments which will be used to create
a LoadBalancer
,
comprised of the properties on the
LoadBalancer class.
The results of load balancer creation
delete_load_balancer
(load_balancer, ignore_missing=True, cascade=False)¶Delete a load balancer
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.
None
find_load_balancer
(name_or_id, ignore_missing=True)¶Find a single load balancer
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.
None
get_load_balancer
(*attrs)¶Get a load balancer
load_balancer – The value can be the name of a load balancer
or LoadBalancer
instance.
One
LoadBalancer
get_load_balancer_statistics
(name_or_id)¶Get the load balancer statistics
name_or_id – The name or ID of a load balancer
One
LoadBalancerStats
load_balancers
(**query)¶Retrieve a generator of load balancers
A generator of load balancer instances
update_load_balancer
(load_balancer, **attrs)¶Update a load balancer
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
.
The updated load_balancer
failover_load_balancer
(name_or_id, **attrs)¶Failover a load balancer
name_or_id – The name or ID of a load balancer
None
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_listener
(**attrs)¶Create a new listener from attributes
delete_listener
(listener, ignore_missing=True)¶Delete a listener
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.
None
find_listener
(name_or_id, ignore_missing=True)¶Find a single listener
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.
One Listener
or None
get_listener
(listener)¶Get a single listener
get_listener_statistics
(listener)¶Get the listener statistics
listener – The value can be the ID of a listener or a
Listener
instance.
One
ListenerStats
ResourceNotFound
when no resource can be found.
listeners
(**query)¶Return a generator of listeners
query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
A generator of listener objects
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_pool
(**attrs)¶Create a new pool from attributes
attrs (dict) – Keyword arguments which will be used to create
a Pool
,
comprised of the properties on the
Pool class.
The results of Pool creation
delete_pool
(pool, ignore_missing=True)¶Delete a pool
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.
None
find_pool
(name_or_id, ignore_missing=True)¶Find a single pool
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.
None
pools
(**query)¶Retrieve a generator of pools
A generator of Pool instances
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_member
(pool, **attrs)¶Create a new member from attributes
delete_member
(member, pool, ignore_missing=True)¶Delete a member
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.
None
find_member
(name_or_id, pool, ignore_missing=True)¶Find a single member
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.
One Member
or None
get_member
(member, pool)¶Get a single member
members
(pool, **query)¶Return a generator of members
update_member
(member, pool, **attrs)¶Update a member
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_health_monitor
(**attrs)¶Create a new health monitor from attributes
attrs (dict) – Keyword arguments which will be used to create
a HealthMonitor
,
comprised of the properties on the
HealthMonitor class.
The results of HealthMonitor creation
HealthMonitor
delete_health_monitor
(healthmonitor, ignore_missing=True)¶Delete a health monitor
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.
None
find_health_monitor
(name_or_id, ignore_missing=True)¶Find a single health monitor
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.
The
openstack.load_balancer.v2.healthmonitor.HealthMonitor
object matching the given name or id or None if nothing matches.
openstack.exceptions.DuplicateResource
if more
than one resource is found for this request.
openstack.exceptions.ResourceNotFound
if nothing
is found and ignore_missing is False
.
get_health_monitor
(healthmonitor)¶Get a health monitor
healthmonitor – The value can be the ID of a health monitor or
HealthMonitor
instance.
One health monitor
HealthMonitor
health_monitors
(**query)¶Retrieve a generator of health monitors
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’.
A generator of health monitor instances
update_health_monitor
(healthmonitor, **attrs)¶Update a health monitor
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
.
The updated health monitor
HealthMonitor
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_l7_policy
(**attrs)¶Create a new l7policy from attributes
delete_l7_policy
(l7_policy, ignore_missing=True)¶Delete a l7policy
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.
None
find_l7_policy
(name_or_id, ignore_missing=True)¶Find a single l7policy
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.
One L7Policy
or None
get_l7_policy
(l7_policy)¶Get a single l7policy
l7_policies
(**query)¶Return a generator of l7policies
query (dict) – Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
A generator of l7policy objects
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_l7_rule
(l7_policy, **attrs)¶Create a new l7rule from attributes
The results of l7rule creation
delete_l7_rule
(l7rule, l7_policy, ignore_missing=True)¶Delete a l7rule
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.
None
find_l7_rule
(name_or_id, l7_policy, ignore_missing=True)¶Find a single l7rule
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.
One L7Rule
or None
get_l7_rule
(l7rule, l7_policy)¶Get a single l7rule
l7_rules
(l7_policy, **query)¶Return a generator of l7rules
update_l7_rule
(l7rule, l7_policy, **attrs)¶Update a l7rule
The updated l7rule
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)providers
(**query)¶Retrieve a generator of providers
A generator of providers instances
provider_flavor_capabilities
(provider, **query)¶Retrieve a generator of provider flavor capabilities
A generator of provider flavor capabilities instances
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_flavor_profile
(**attrs)¶Create a new flavor profile from attributes
attrs (dict) – Keyword arguments which will be used to create
a FlavorProfile
,
comprised of the properties on the
FlavorProfile class.
The results of profile creation creation
FlavorProfile
get_flavor_profile
(*attrs)¶Get a flavor profile
flavor_profile – The value can be the name of a flavor profile
or
FlavorProfile
instance.
One
FlavorProfile
flavor_profiles
(**query)¶Retrieve a generator of flavor profiles
A generator of flavor profiles instances
delete_flavor_profile
(flavor_profile, ignore_missing=True)¶Delete a flavor profile
flavor_profile – The flavor_profile can be either the name or a
FlavorProfile
instance
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when
the flavor profile does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent flavor profile.
None
find_flavor_profile
(name_or_id, ignore_missing=True)¶Find a single flavor profile
name_or_id – The name or ID of a flavor profile
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised
when the flavor profile does not exist.
When set to True
, no exception will be set when attempting
to delete a nonexistent flavor profile.
None
update_flavor_profile
(flavor_profile, **attrs)¶Update a flavor profile
flavor_profile – The flavor_profile can be either the name or a
FlavorProfile
instance
attrs (dict) – The attributes to update on the flavor profile
represented by flavor_profile
.
The updated flavor profile
FlavorProfile
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_flavor
(**attrs)¶Create a new flavor from attributes
attrs (dict) – Keyword arguments which will be used to create
a Flavor
, comprised of the properties on the
Flavorclass.
The results of flavor creation creation
get_flavor
(*attrs)¶Get a flavor
flavors
(**query)¶Retrieve a generator of flavors
A generator of flavor instances
delete_flavor
(flavor, ignore_missing=True)¶Delete a flavor
flavor – The flavorcan be either the name or a
Flavor
instance
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when
the flavor does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent flavor.
None
find_flavor
(name_or_id, ignore_missing=True)¶Find a single flavor
name_or_id – The name or ID of a flavor
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised
when the flavor does not exist.
When set to True
, no exception will be set when attempting
to delete a nonexistent flavor.
None
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)update_quota
(quota, **attrs)¶Update a quota
delete_quota
(quota, ignore_missing=True)¶Delete a quota (i.e. reset to the default quota)
quota – The value can be either the ID of a quota or a
Quota
instance. The ID of a quota is the same as the
project ID for the quota.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when quota does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent quota.
None
quotas
(**query)¶Return a generator of quotas
query (dict) – Optional query parameters to be sent to limit the resources being returned. Currently no query parameter is supported.
A generator of quota objects
get_quota
(quota)¶Get a quota
get_quota_default
()¶Get a default quota
One QuotaDefault
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)amphorae
(**query)¶Retrieve a generator of amphorae
A generator of amphora instances
get_amphora
(*attrs)¶Get a amphora
find_amphora
(amphora_id, ignore_missing=True)¶Find a single amphora
amphora_id – The ID of a amphora
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised
when the amphora does not exist.
When set to True
, no exception will be set when attempting
to find a nonexistent amphora.
None
configure_amphora
(amphora_id, **attrs)¶Update the configuration of an amphora agent
amphora_id – The ID of an amphora
None
failover_amphora
(amphora_id, **attrs)¶Failover an amphora
amphora_id – The ID of an amphora
None
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_availability_zone_profile
(**attrs)¶Create a new availability zone profile from attributes
attrs (dict) – Keyword arguments which will be used to create
a AvailabilityZoneProfile
,
comprised of the properties on the
AvailabilityZoneProfile class.
The results of profile creation creation
AvailabilityZoneProfile
get_availability_zone_profile
(*attrs)¶Get an availability zone profile
availability_zone_profile – The value can be the name of an
availability_zone profile
or
AvailabilityZoneProfile
instance.
availability_zone_profiles
(**query)¶Retrieve a generator of availability zone profiles
A generator of availability zone profiles instances
delete_availability_zone_profile
(availability_zone_profile, ignore_missing=True)¶Delete an availability zone profile
availability_zone_profile – The availability_zone_profile can be
either the name or a
AvailabilityZoneProfile
instance
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when
the availability zone profile does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent availability zone profile.
None
find_availability_zone_profile
(name_or_id, ignore_missing=True)¶Find a single availability zone profile
name_or_id – The name or ID of a availability zone profile
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised
when the availability zone profile does not exist.
When set to True
, no exception will be set when attempting
to delete a nonexistent availability zone profile.
None
update_availability_zone_profile
(availability_zone_profile, **attrs)¶Update an availability zone profile
availability_zone_profile – The availability_zone_profile can be
either the name or a
AvailabilityZoneProfile
instance
attrs (dict) – The attributes to update on the availability_zone
profile represented by
availability_zone_profile
.
The updated availability zone profile
AvailabilityZoneProfile
openstack.load_balancer.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_availability_zone
(**attrs)¶Create a new availability zone from attributes
attrs (dict) – Keyword arguments which will be used to create
a AvailabilityZone
, comprised of
the properties on the AvailabilityZoneclass.
The results of availability_zone creation creation
get_availability_zone
(*attrs)¶Get an availability zone
availability_zone – The value can be the name of a
availability_zone or
AvailabilityZone
instance.
One
AvailabilityZone
availability_zones
(**query)¶Retrieve a generator of availability zones
A generator of availability zone instances
delete_availability_zone
(availability_zone, ignore_missing=True)¶Delete an availability_zone
availability_zone – The availability_zone can be either the name
or a
AvailabilityZone
instance
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when
the availability zone does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent availability zone.
None
find_availability_zone
(name_or_id, ignore_missing=True)¶Find a single availability zone
name_or_id – The name or ID of a availability zone
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised
when the availability zone does not exist.
When set to True
, no exception will be set when attempting
to delete a nonexistent availability zone.
None
update_availability_zone
(availability_zone, **attrs)¶Update an availability zone
availability_zone – The availability_zone can be either the name
or a
AvailabilityZone
instance
attrs (dict) – The attributes to update on the availability_zone
represented by availability_zone
.
The updated availability_zone
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.