AmphoraClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
amphora_failover
(**func_kwargs)[source]¶Failover an amphora.
Parameters: | amphora_id – The ID of the amphora to failover. |
---|---|
Raises: |
|
Returns: | None |
base_uri
= '/v2.0/octavia/{object}'¶get_amphora_stats
(**func_kwargs)[source]¶Get amphora statistics.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An amphora statistics object. |
list_amphorae
(**func_kwargs)[source]¶Get a list of amphora objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of amphora objects. |
list_root_tag
= 'amphorae'¶root_tag
= 'amphora'¶show_amphora
(**func_kwargs)[source]¶Get amphora details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An amphora object. |
stats_root_tag
= 'amphora_stats'¶update_amphora_config
(**func_kwargs)[source]¶Update the amphora agent configuration.
Parameters: | amphora_id – The ID of the amphora to update. |
---|---|
Raises: |
|
Returns: | None |
AvailabilityZoneCapabilitiesClient
(*args, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
list_availability_zone_capabilities
(**func_kwargs)[source]¶Get a list of provider availability zone capability objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of availability zone capability objects. |
list_root_tag
= 'availability_zone_capabilities'¶AvailabilityZoneClient
(*args, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
cleanup_an_availability_zone
(availability_zone_name)[source]¶Delete an availability zone for tempest cleanup.
We cannot use the cleanup_availability_zone method as availability zones do not have a provisioning_status.
Parameters: | availability_zone_name – The availability zone name to delete. |
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
create_availability_zone
(**func_kwargs)[source]¶Create an availability zone.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An availability zone object. |
delete_availability_zone
(**func_kwargs)[source]¶Delete an availability zone.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_availability_zones
(**func_kwargs)[source]¶Get a list of availability zone objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of availability zone objects. |
list_root_tag
= 'availability_zones'¶resource_path
= 'availabilityzones'¶root_tag
= 'availability_zone'¶show_availability_zone
(**func_kwargs)[source]¶Get the availability zone details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An availability zone object. |
update_availability_zone
(**func_kwargs)[source]¶Update an availability zone.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An availability zone object. |
AvailabilityZoneProfileClient
(*args, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
cleanup_availability_zone_profile
(availability_zone_profile_id)[source]¶Delete an availability zone profile for tempest cleanup.
We cannot use the cleanup_availability_zone_profile method as availability zone profiles do not have a provisioning_status.
Parameters: | availability_zone_profile_id – The availability zone profile ID to delete. |
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
create_availability_zone_profile
(**func_kwargs)[source]¶Create an availability zone profile.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An availability zone profile object. |
delete_availability_zone_profile
(**func_kwargs)[source]¶Delete an availability zone profile.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_availability_zone_profiles
(**func_kwargs)[source]¶Get a list of availability zone profile objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of availability zone profile objects. |
list_root_tag
= 'availability_zone_profiles'¶resource_path
= 'availabilityzoneprofiles'¶root_tag
= 'availability_zone_profile'¶show_availability_zone_profile
(**func_kwargs)[source]¶Get the availability zone profile details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An availability zone profile object. |
update_availability_zone_profile
(**func_kwargs)[source]¶Update an availability zone profile.
Parameters: |
|
---|---|
Raises: |
|
Returns: | An availability zone profile object. |
BaseLBaaSClient
(auth_provider, service, region, **kwargs)[source]¶Bases: tempest.lib.common.rest_client.RestClient
base_uri
= '/v2.0/lbaas/{object}'¶get_max_api_version
()[source]¶Get the maximum version available on the API endpoint.
Returns: | Maximum version string available on the endpoint. |
---|
is_resource_deleted
(id)[source]¶Check if the object is deleted.
Parameters: | id – The object ID to check. |
---|---|
Returns: | boolean state representing the object’s deleted state |
is_version_supported
(api_version, version)[source]¶Check if a version is supported by the API.
Parameters: |
|
---|---|
Returns: | boolean if the version is supported. |
list_root_tag
= None¶root_tag
= None¶FlavorCapabilitiesClient
(*args, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
list_flavor_capabilities
(**func_kwargs)[source]¶Get a list of provider flavor capability objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of flavor capability objects. |
list_root_tag
= 'flavor_capabilities'¶FlavorClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
cleanup_a_flavor
(flavor_id)[source]¶Delete a flavor for tempest cleanup.
We cannot use the cleanup_flavor method as flavors do not have a provisioning_status.
Parameters: | flavor_id – The flavor ID to delete. |
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
create_flavor
(**func_kwargs)[source]¶Create a flavor.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A flavor object. |
delete_flavor
(**func_kwargs)[source]¶Delete a flavor.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_flavors
(**func_kwargs)[source]¶Get a list of flavor objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of flavor objects. |
list_root_tag
= 'flavors'¶root_tag
= 'flavor'¶show_flavor
(**func_kwargs)[source]¶Get the flavor details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A flavor object. |
update_flavor
(**func_kwargs)[source]¶Update a flavor.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A flavor object. |
FlavorProfileClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
cleanup_flavor_profile
(flavorprofile_id)[source]¶Delete a flavor profile for tempest cleanup.
We cannot use the cleanup_flavorprofile method as flavor profiles do not have a provisioning_status.
Parameters: | flavorprofile_id – The flavor profile ID to delete. |
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
create_flavor_profile
(**func_kwargs)[source]¶Create a flavor profile.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A flavor profile object. |
delete_flavor_profile
(**func_kwargs)[source]¶Delete a flavor profile.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_flavor_profiles
(**func_kwargs)[source]¶Get a list of flavor profile objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of flavor profile objects. |
list_root_tag
= 'flavorprofiles'¶root_tag
= 'flavorprofile'¶show_flavor_profile
(**func_kwargs)[source]¶Get the flavor profile details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A flavor profile object. |
update_flavor_profile
(**func_kwargs)[source]¶Update a flavor profile.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A flavor profile object. |
HealthMonitorClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_healthmonitor
(**func_kwargs)[source]¶Create a healthmonitor.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A healthmonitor object. |
delete_healthmonitor
(**func_kwargs)[source]¶Delete a healthmonitor.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_healthmonitors
(**func_kwargs)[source]¶Get a list of healthmonitor objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of healthmonitor objects. |
list_root_tag
= 'healthmonitors'¶resource_name
= 'healthmonitor'¶root_tag
= 'healthmonitor'¶show_healthmonitor
(**func_kwargs)[source]¶Get healthmonitor details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A healthmonitor object. |
update_healthmonitor
(**func_kwargs)[source]¶Update a healthmonitor.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A healthmonitor object. |
L7PolicyClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_l7policy
(**func_kwargs)[source]¶Create a l7policy.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A l7policy object. |
delete_l7policy
(**func_kwargs)[source]¶Delete a l7policy.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_l7policies
(**func_kwargs)[source]¶Get a list of l7policy objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of l7policy objects. |
list_root_tag
= 'l7policies'¶resource_name
= 'l7policy'¶root_tag
= 'l7policy'¶show_l7policy
(**func_kwargs)[source]¶Get l7policy details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A l7policy object. |
update_l7policy
(**func_kwargs)[source]¶Update a l7policy.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A l7policy object. |
L7RuleClient
(*args, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_l7rule
(**func_kwargs)[source]¶Create a l7rule.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A l7rule object. |
delete_l7rule
(**func_kwargs)[source]¶Delete a l7rule.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
is_resource_deleted
(id)[source]¶Check if the object is deleted.
Parameters: | id – The object ID to check. |
---|---|
Returns: | boolean state representing the object’s deleted state |
list_l7rules
(**func_kwargs)[source]¶Get a list of l7rule objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of l7rule objects. |
list_root_tag
= 'rules'¶resource_name
= 'l7rule'¶root_tag
= 'rule'¶show_l7rule
(**func_kwargs)[source]¶Get l7rule details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A l7rule object. |
update_l7rule
(**func_kwargs)[source]¶Update a l7rule.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A l7rule object. |
ListenerClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_listener
(**func_kwargs)[source]¶Create a listener.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A listener object. |
delete_listener
(**func_kwargs)[source]¶Delete a listener.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
get_listener_stats
(**func_kwargs)[source]¶Get listener statistics.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A listener statistics object. |
list_listeners
(**func_kwargs)[source]¶Get a list of listener objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of listener objects. |
list_root_tag
= 'listeners'¶root_tag
= 'listener'¶show_listener
(**func_kwargs)[source]¶Get listener details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A listener object. |
update_listener
(**func_kwargs)[source]¶Update a listener.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A listener object. |
LoadbalancerClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_loadbalancer
(**func_kwargs)[source]¶Create a loadbalancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer object. |
delete_loadbalancer
(**func_kwargs)[source]¶Delete a loadbalancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
failover_loadbalancer
(**func_kwargs)[source]¶Failover a loadbalancer.
Parameters: | lb_id – The loadbalancer ID to query. |
---|---|
Raises: |
|
Returns: | None |
get_loadbalancer_stats
(**func_kwargs)[source]¶Get loadbalancer statistics.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer statistics object. |
get_loadbalancer_status
(**func_kwargs)[source]¶Get a loadbalancer status tree.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer statuses object. |
list_loadbalancers
(**func_kwargs)[source]¶Get a list of loadbalancer objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of loadbalancer objects. |
list_root_tag
= 'loadbalancers'¶root_tag
= 'loadbalancer'¶show_loadbalancer
(**func_kwargs)[source]¶Get loadbalancer details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer object. |
update_loadbalancer
(**func_kwargs)[source]¶Update a loadbalancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer object. |
MemberClient
(*args, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_member
(**func_kwargs)[source]¶Create a member.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A member object. |
delete_member
(**func_kwargs)[source]¶Delete a member.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
is_resource_deleted
(id)[source]¶Check if the object is deleted.
Parameters: | id – The object ID to check. |
---|---|
Returns: | boolean state representing the object’s deleted state |
list_members
(**func_kwargs)[source]¶Get a list of member objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of member objects. |
list_root_tag
= 'members'¶root_tag
= 'member'¶show_member
(**func_kwargs)[source]¶Get member details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A member object. |
update_member
(**func_kwargs)[source]¶Update a member.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A member object. |
update_members
(**func_kwargs)[source]¶Batch update all members on a pool.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A member object. |
PoolClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_pool
(**func_kwargs)[source]¶Create a pool.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A pool object. |
delete_pool
(**func_kwargs)[source]¶Delete a pool.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
list_pools
(**func_kwargs)[source]¶Get a list of pool objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of pool objects. |
list_root_tag
= 'pools'¶resource_name
= 'pool'¶root_tag
= 'pool'¶show_pool
(**func_kwargs)[source]¶Get pool details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A pool object. |
update_pool
(**func_kwargs)[source]¶Update a pool.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A pool object. |
ProviderClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
list_providers
(**func_kwargs)[source]¶Get a list of provider objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of provider objects. |
list_root_tag
= 'providers'¶LoadbalancerClient
(auth_provider, service, region, **kwargs)[source]¶Bases: octavia_tempest_plugin.services.load_balancer.v2.base_client.BaseLBaaSClient
create_loadbalancer
(**func_kwargs)[source]¶Create a loadbalancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer object. |
delete_loadbalancer
(**func_kwargs)[source]¶Delete a loadbalancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
failover_loadbalancer
(**func_kwargs)[source]¶Failover a loadbalancer.
Parameters: | lb_id – The loadbalancer ID to query. |
---|---|
Raises: |
|
Returns: | None |
get_loadbalancer_stats
(**func_kwargs)[source]¶Get loadbalancer statistics.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer statistics object. |
get_loadbalancer_status
(**func_kwargs)[source]¶Get a loadbalancer status tree.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer statuses object. |
list_loadbalancers
(**func_kwargs)[source]¶Get a list of loadbalancer objects.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of loadbalancer objects. |
list_root_tag
= 'loadbalancers'¶root_tag
= 'loadbalancer'¶show_loadbalancer
(**func_kwargs)[source]¶Get loadbalancer details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer object. |
update_loadbalancer
(**func_kwargs)[source]¶Update a loadbalancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A loadbalancer object. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.