opentelekomcloud.cloud.lb_listener module -- Add/Delete listener 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_listener
.
New in opentelekomcloud.cloud 0.0.3
Synopsis¶
Add or Remove listener 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 listener. 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. |
|
Specifies the ID of the CA certificate used by the listener (only for terminated_https). |
|
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. |
|
Specifies the maximum number of connections (from -1 to 2147483647). Default: |
|
Specifies the ID or Name of the associated backend server group. |
|
Specifies the ID of the server certificate used by the listener (only for terminated_https). |
|
Provides supplementary information about the listener. |
|
Specifies whether to use HTTP/2 (valid only for terminated_https). Choices:
|
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Specifies the associated load balancer by ID or Name. |
|
Name that has to be given to the listener |
|
Specifies the load balancer protocol. Choices:
|
|
Specifies the port used by the load balancer. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener (only for terminated_https). Default: |
|
Should the resource be present or absent. Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
Specifies the security policy used by the listener (only for terminated_https). (server certificates with a domain name) used by the listener. 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¶
# Create a lb listener.
- opentelekomcloud.cloud.lb_listener:
state: present
protocol_port: 80
protocol: TCP
loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253"
name: listener-test
admin_state_up: true
# Create a HTTPS lb listener.
- opentelekomcloud.cloud.lb_listener:
state: present
protocol_port: 443
protocol: terminated_https
default_tls_container_ref: "02dcd56799e045bf8b131533cc911dd6"
loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253"
name: listener-test
admin_state_up: true
# Create a HTTPS lb listener with the SNI feature.
- opentelekomcloud.cloud.lb_listener:
state: present
protocol_port: 443
protocol: terminated_https
default_tls_container_ref: "02dcd56799e045bf8b131533cc911dd6"
loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253"
name: listener-test
admin_state_up: true
sni_container_refs: ["e15d1b5000474adca383c3cd9ddc06d4", "5882325fd6dd4b95a88d33238d293a0f"]
# Delete a load balancer(and all its related resources)
- opentelekomcloud.cloud.lb_listener:
state: absent
name: listener-test
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Specifies the listener. Returned: On Success. |
|
Specifies the administrative status of the listener. Returned: success |
|
Specifies the maximum number of connections. Returned: success |
|
Specifies the time when the listener was created. Returned: success |
|
Specifies the ID of the associated backend server group. Returned: success |
|
Provides supplementary information about the listener. Returned: success |
|
Specifies the listener ID. Returned: success Sample: |
|
Specifies the ID of the associated load balancer. Returned: success |
|
Specifies the listener name. Returned: success Sample: |
|
Specifies the load balancer protocol. Returned: success Sample: |
|
Specifies the port used by the load balancer. Returned: success Sample: |
|
Tags the listener. Returned: success |
|
Specifies the time when the listener was updated. Returned: success |