You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.8.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.

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.12.0

• python >= 3.6

Parameters

Parameter	Comments
api_timeout integer	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.
auth dictionary	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.
auth_type string	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.
availability_zone string	Ignored. Present for backwards compatibility
ca_cert aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
cloud raw	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.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: admin internal public ← (default)
loadbalancer string / required	The name or id of the load balancer that this listener belongs to.
name string / required	Name that has to be given to the listener
protocol string	The protocol for the listener. Choices: HTTP ← (default) HTTPS TCP TERMINATED_HTTPS UDP SCTP
protocol_port integer	The protocol port number for the listener. Default: 80
region_name string	Name of the region.
state string	Should the resource be present or absent. Choices: present ← (default) absent
timeout integer	The amount of time the module should wait for the load balancer to get into ACTIVE state. Default: 180
timeout_client_data integer	Client inactivity timeout in milliseconds. Default: 50000
timeout_member_data integer	Member inactivity timeout in milliseconds. Default: 50000
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: no yes
wait boolean	If the module should wait for the load balancer to be ACTIVE. Choices: no yes ← (default)

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

# 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
id string	The listener UUID. Returned: On success when state is ‘present’ Sample: “39007a7e-ee4f-4d13-8283-b4da2e037c69”
listener complex	Dictionary describing the listener. Returned: On success when state is ‘present’
description string	The listener description. Returned: success Sample: “description”
id string	Unique UUID. Returned: success Sample: “39007a7e-ee4f-4d13-8283-b4da2e037c69”
is_admin_state_up boolean	The administrative state of the listener. Returned: success Sample: true
load_balancer_id string	The load balancer UUID this listener belongs to. Returned: success Sample: “b32eef7e-d2a6-4ea4-a301-60a873f89b3b”
loadbalancers list / elements=string	A list of load balancer IDs.. Returned: success Sample: [{“id”: “b32eef7e-d2a6-4ea4-a301-60a873f89b3b”}]
name string	Name given to the listener. Returned: success Sample: “test”
operating_status string	The operating status of the listener. Returned: success Sample: “ONLINE”
protocol string	The protocol for the listener. Returned: success Sample: “HTTP”
protocol_port integer	The protocol port number for the listener. Returned: success Sample: 80
provisioning_status string	The provisioning status of the listener. Returned: success Sample: “ACTIVE”
timeout_client_data integer	Client inactivity timeout in milliseconds. Returned: success Sample: 50000
timeout_member_data integer	Member inactivity timeout in milliseconds. Returned: success Sample: 50000

Authors

• OpenStack Ansible SIG

Collection links

Issue Tracker Repository (Sources)