lb_listener

updated: None

lb_listener

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.lb_listener.

New in version 0.0.3: of opentelekomcloud.cloud

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 Choices/Defaults Comments
admin_state_up
boolean
    Choices:
  • no
  • yes
Specifies the administrative status of the listener.
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, 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.
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.
ca_cert
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_ca_tls_container_ref
string
Specifies the ID of the CA certificate used by the listener (only for terminated_https).
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
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.
connection_limit
integer
Default:
-1
Specifies the maximum number of connections (from -1 to 2147483647).
default_pool
string
Specifies the ID or Name of the associated backend server group.
default_tls_container_ref
string
Specifies the ID of the server certificate used by the listener (only for terminated_https).
description
string
Provides supplementary information about the listener.
http2_enable
boolean
    Choices:
  • no ←
  • yes
Specifies whether to use HTTP/2 (valid only for terminated_https).
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
loadbalancer
string
Specifies the associated load balancer by ID or Name.
name
string / required
Name that has to be given to the listener
protocol
string
    Choices:
  • tcp
  • http
  • udp
  • terminated_https
Specifies the load balancer protocol.
protocol_port
integer
Specifies the port used by the load balancer.
region_name
string
Name of the region.
sni_container_refs
list / elements=string
Default:
[]
Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener (only for terminated_https).
state
string
    Choices:
  • present ←
  • absent
Should the resource be present or absent.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
tls_ciphers_policy
string
Default:
"tls-1-0"
Specifies the security policy used by the listener (only for terminated_https). (server certificates with a domain name) used by the listener.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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 Returned Description
lb_listener
complex
On Success.
Specifies the listener.
 
admin_state_up
boolean
success
Specifies the administrative status of the listener.
 
connection_limit
integer
success
Specifies the maximum number of connections.
 
created_at
string
success
Specifies the time when the listener was created.
 
default_pool_id
string
success
Specifies the ID of the associated backend server group.
 
description
string
success
Provides supplementary information about the listener.
 
id
string
success
Specifies the listener ID.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037c69
 
loadbalancers
list / elements=string
success
Specifies the ID of the associated load balancer.
 
name
string
success
Specifies the listener name.

Sample:
elb_test
 
protocol
string
success
Specifies the load balancer protocol.

Sample:
TCP
 
protocol_port
integer
success
Specifies the port used by the load balancer.

Sample:
80
 
tags
string
success
Tags the listener.
 
updated_at
string
success
Specifies the time when the listener was updated.


Authors

  • Anton Sidelnikov (@anton-sidelnikov)

updated: None