opentelekomcloud.cloud.lb_pool module -- Add/Delete backend server group for load balancer from OpenTelekomCloud¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.14.6).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install opentelekomcloud.cloud.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: opentelekomcloud.cloud.lb_pool.
New in opentelekomcloud.cloud 0.0.4
Synopsis¶
Add or Remove a backend server group for Enhanced Load Balancer from the OTC load-balancer service(ELB).
Requirements¶
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36.0
otcextensions
python >= 3.6
Parameters¶
Parameter |
Comments |
|---|---|
Specifies the administrative status of the backend server group. Choices:
|
|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
Provides supplementary information about the backend server group. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Specifies the load balancing algorithm of the backend server group. Choices:
|
|
Specifies the ID or Name of the listener associated with the backend server group. |
|
Specifies the ID or Name of the load balancer associated with the backend server group. |
|
Specifies the backend server group name. |
|
Specifies the protocol that the backend server group uses to receive requests. Should be same as load balancer listener protocol Choices:
|
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Specifies the sticky session timeout duration in minutes. |
|
Should the resource be present or absent. Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples¶
# Create a lb server group.
- opentelekomcloud.cloud.lb_pool:
state: present
name: pool-test
protocol: tcp
lb_algorithm: round_robin
listener: "5896b6f1-698f-4a81-989e-978b3f045643"
loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253"
# Create a lb server group with session_persistence.
- opentelekomcloud.cloud.lb_pool:
state: present
name: pool-test
protocol: tcp
lb_algorithm: round_robin
listener: "5896b6f1-698f-4a81-989e-978b3f045643"
loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253"
session_persistence:
- type: http_cookie
- persistence_timeout: 60
# Delete a load balancer(and all its related resources)
- opentelekomcloud.cloud.lb_pool:
state: absent
name: pool-test
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Specifies the pool. Returned: On Success. |
|
Specifies the administrative status of the backend server group. Returned: success |
|
Provides supplementary information about the backend server group. Returned: success |
|
Specifies the ID of the health check configured for the backend server group. Returned: success |
|
Specifies the ID of the backend server group. Returned: success Sample: |
|
Specifies the load balancing algorithm of the backend server group. Returned: success Sample: |
|
Lists the IDs of listeners associated with the backend server group. Returned: success |
|
Lists the IDs of load balancers associated with the backend server group. Returned: success |
|
Lists the IDs of backend servers in the backend server group. Returned: success |
|
Specifies the backend server group name. Returned: success Sample: |
|
Specifies the protocol that the backend server group uses to receive requests. Returned: success Sample: |
|
Specifies whether to enable the sticky session feature. Returned: success |