openstack.cloud.lb_pool module – Manage load-balancer pool in a OpenStack cloud.
Note
This module is part of the openstack.cloud collection (version 2.2.0).
You might already have this collection installed if you are using the ansible
package.
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 openstack.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.lb_pool
.
Synopsis
Add, update or remove load-balancer pool from OpenStack cloud.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
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, user_domain_name or 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. |
|
A human-readable description for the load-balancer pool. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
The load balancing algorithm for the pool. For example, lb_algorithm could be Default: |
|
The name or id of the listener that this pool belongs to. Either listener or loadbalancer must be specified for pool creation. This attribute cannot be updated. |
|
The name or id of the load balancer that this pool belongs to. Either listener or loadbalancer must be specified for pool creation. This attribute cannot be updated. |
|
Name that has to be given to the pool. This attribute cannot be updated. |
|
The protocol for the pool. For example, protocol could be This attribute cannot be updated. Default: |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
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_USERNAME
may 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
- name: Create a load-balander pool
openstack.cloud.lb_pool:
cloud: mycloud
lb_algorithm: ROUND_ROBIN
loadbalancer: test-loadbalancer
name: test-pool
protocol: HTTP
state: present
- name: Delete a load-balander pool
openstack.cloud.lb_pool:
cloud: mycloud
name: test-pool
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the load-balancer pool. Returned: On success when state is |
|
List of ALPN protocols. Returned: success |
|
Timestamp when the pool was created. Returned: success |
|
The pool description. Returned: success |
|
Health Monitor ID. Returned: success |
|
Unique UUID. Returned: success |
|
The administrative state of the pool. Returned: success |
|
The load balancing algorithm for the pool. Returned: success |
|
The listener ID the pool belongs to. Returned: success |
|
A list of listener IDs. Returned: success |
|
The load balancer ID the pool belongs to. This field is set when the pool does not belong to any listener in the load balancer. Returned: success |
|
A list of load balancer IDs. Returned: success |
|
A list of member IDs. Returned: success |
|
Name given to the pool. Returned: success |
|
The operating status of the pool. Returned: success |
|
The ID of the project. Returned: success |
|
The protocol for the pool. Returned: success |
|
The provisioning status of the pool. Returned: success |
|
A JSON object specifying the session persistence for the pool. Returned: success |
|
A list of associated tags. Returned: success |
|
Stores a string of cipher strings in OpenSSL format. Returned: success |
|
Use TLS for connections to backend member servers. Returned: success |
|
A list of TLS protocol versions to be used in by the pool. Returned: success |
|
Timestamp when the pool was updated. Returned: success |