openstack.cloud.lb_listener module – Add/Delete a listener for a load balancer from OpenStack Cloud
Note
This module is part of the openstack.cloud collection (version 1.10.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_listener.
Synopsis
Add or Remove a listener for a load balancer from the OpenStack load-balancer service.
Requirements
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36, < 0.99.0
python >= 3.6
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. |
|
Ignored. Present for backwards compatibility |
|
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. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
The name or id of the load balancer that this listener belongs to. |
|
Name that has to be given to the listener |
|
The protocol for the listener. Choices:
|
|
The protocol port number for the listener. 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:
|
|
The amount of time the module should wait for the load balancer to get into ACTIVE state. Default: |
|
Client inactivity timeout in milliseconds. Default: |
|
Member inactivity timeout in milliseconds. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
If the module should wait for the load balancer to be ACTIVE. 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 listener, wait for the loadbalancer to be active.
- openstack.cloud.lb_listener:
cloud: mycloud
endpoint_type: admin
state: present
name: test-listener
loadbalancer: test-loadbalancer
protocol: HTTP
protocol_port: 8080
# Create a listener, do not wait for the loadbalancer to be active.
- openstack.cloud.lb_listener:
cloud: mycloud
endpoint_type: admin
state: present
name: test-listener
loadbalancer: test-loadbalancer
protocol: HTTP
protocol_port: 8080
wait: no
# Delete a listener
- openstack.cloud.lb_listener:
cloud: mycloud
endpoint_type: admin
state: absent
name: test-listener
loadbalancer: test-loadbalancer
# Create a listener, increase timeouts for connection persistence (for SSH for example).
- openstack.cloud.lb_listener:
cloud: mycloud
endpoint_type: admin
state: present
name: test-listener
loadbalancer: test-loadbalancer
protocol: TCP
protocol_port: 22
timeout_client_data: 1800000
timeout_member_data: 1800000
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The listener UUID. Returned: On success when state is ‘present’ Sample: |
|
Dictionary describing the listener. Returned: On success when state is ‘present’ |
|
The listener description. Returned: success Sample: |
|
Unique UUID. Returned: success Sample: |
|
The administrative state of the listener. Returned: success Sample: |
|
The load balancer UUID this listener belongs to. Returned: success Sample: |
|
A list of load balancer IDs.. Returned: success Sample: |
|
Name given to the listener. Returned: success Sample: |
|
The operating status of the listener. Returned: success Sample: |
|
The protocol for the listener. Returned: success Sample: |
|
The protocol port number for the listener. Returned: success Sample: |
|
The provisioning status of the listener. Returned: success Sample: |
|
Client inactivity timeout in milliseconds. Returned: success Sample: |
|
Member inactivity timeout in milliseconds. Returned: success Sample: |