LoadbalancerClient
(auth_provider, service, region, **kwargs)[source]¶Bases: tempest.lib.common.rest_client.RestClient
create_loadbalancer
(admin_state_up=None, description=None, flavor=None, listeners=None, name=None, project_id=None, provider=None, vip_address=None, vip_network_id=None, vip_port_id=None, vip_qos_policy_id=None, vip_subnet_id=None, return_object_only=True)[source]¶Create a load balancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
create_loadbalancer_dict
(lb_dict, return_object_only=True)[source]¶Create a load balancer using a dictionary.
Example lb_dict:
lb_dict = {'loadbalancer': {
'vip_network_id': 'd0be73da-921a-4e03-9c49-f13f18f7e39f',
'name': 'TEMPEST_TEST_LB',
'description': 'LB for Tempest tests'}
}
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
delete_loadbalancer
(lb_id, cascade=False, ignore_errors=False)[source]¶Delete a load balancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
failover_loadbalancer
(lb_id)[source]¶Failover a load balancer.
Parameters: | lb_id – The load balancer ID to query. |
---|---|
Raises: |
|
Returns: | None |
get_loadbalancer_stats
(lb_id, query_params=None, return_object_only=True)[source]¶Get load balancer statistics.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer statistics object. |
get_loadbalancer_status
(lb_id, query_params=None, return_object_only=True)[source]¶Get a load balancer status tree.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer statuses object. |
list_loadbalancers
(query_params=None, return_object_only=True)[source]¶Get a list of load balancers.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of load balancers object. |
show_loadbalancer
(lb_id, query_params=None, return_object_only=True)[source]¶Get load balancer details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
update_loadbalancer
(lb_id, admin_state_up=None, description=None, name=None, vip_qos_policy_id=None, return_object_only=True)[source]¶Update a load balancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
update_loadbalancer_dict
(lb_id, lb_dict, return_object_only=True)[source]¶Update a load balancer using a dictionary.
Example lb_dict:
lb_dict = {'loadbalancer': {'name': 'TEMPEST_TEST_LB_UPDATED'} }
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
LoadbalancerClient
(auth_provider, service, region, **kwargs)[source]¶Bases: tempest.lib.common.rest_client.RestClient
create_loadbalancer
(admin_state_up=None, description=None, flavor=None, listeners=None, name=None, project_id=None, provider=None, vip_address=None, vip_network_id=None, vip_port_id=None, vip_qos_policy_id=None, vip_subnet_id=None, return_object_only=True)[source]¶Create a load balancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
create_loadbalancer_dict
(lb_dict, return_object_only=True)[source]¶Create a load balancer using a dictionary.
Example lb_dict:
lb_dict = {'loadbalancer': {
'vip_network_id': 'd0be73da-921a-4e03-9c49-f13f18f7e39f',
'name': 'TEMPEST_TEST_LB',
'description': 'LB for Tempest tests'}
}
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
delete_loadbalancer
(lb_id, cascade=False, ignore_errors=False)[source]¶Delete a load balancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | None if ignore_errors is True, the response status code if not. |
failover_loadbalancer
(lb_id)[source]¶Failover a load balancer.
Parameters: | lb_id – The load balancer ID to query. |
---|---|
Raises: |
|
Returns: | None |
get_loadbalancer_stats
(lb_id, query_params=None, return_object_only=True)[source]¶Get load balancer statistics.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer statistics object. |
get_loadbalancer_status
(lb_id, query_params=None, return_object_only=True)[source]¶Get a load balancer status tree.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer statuses object. |
list_loadbalancers
(query_params=None, return_object_only=True)[source]¶Get a list of load balancers.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A list of load balancers object. |
show_loadbalancer
(lb_id, query_params=None, return_object_only=True)[source]¶Get load balancer details.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
update_loadbalancer
(lb_id, admin_state_up=None, description=None, name=None, vip_qos_policy_id=None, return_object_only=True)[source]¶Update a load balancer.
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
update_loadbalancer_dict
(lb_id, lb_dict, return_object_only=True)[source]¶Update a load balancer using a dictionary.
Example lb_dict:
lb_dict = {'loadbalancer': {'name': 'TEMPEST_TEST_LB_UPDATED'} }
Parameters: |
|
---|---|
Raises: |
|
Returns: | A load balancer object. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.