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

admin_state_up

boolean

Specifies the administrative status of the listener.

Choices:

  • false

  • true

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

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_ca_tls_container_ref

string

Specifies the ID of the CA certificate used by the listener (only for terminated_https).

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

any

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

Specifies the maximum number of connections (from -1 to 2147483647).

Default: -1

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

Specifies whether to use HTTP/2 (valid only for terminated_https).

Choices:

  • false ← (default)

  • true

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

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

Specifies the load balancer protocol.

Choices:

  • "tcp"

  • "http"

  • "udp"

  • "terminated_https"

protocol_port

integer

Specifies the port used by the load balancer.

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "ERROR"

  • "WARN" ← (default)

  • "INFO"

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

sni_container_refs

list / elements=string

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener (only for terminated_https).

Default: []

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

tls_ciphers_policy

string

Specifies the security policy used by the listener (only for terminated_https). (server certificates with a domain name) used by the listener.

Default: "tls-1-0"

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (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 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

lb_listener

complex

Specifies the listener.

Returned: On Success.

admin_state_up

boolean

Specifies the administrative status of the listener.

Returned: success

connection_limit

integer

Specifies the maximum number of connections.

Returned: success

created_at

string

Specifies the time when the listener was created.

Returned: success

default_pool_id

string

Specifies the ID of the associated backend server group.

Returned: success

description

string

Provides supplementary information about the listener.

Returned: success

id

string

Specifies the listener ID.

Returned: success

Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"

loadbalancers

list / elements=string

Specifies the ID of the associated load balancer.

Returned: success

name

string

Specifies the listener name.

Returned: success

Sample: "elb_test"

protocol

string

Specifies the load balancer protocol.

Returned: success

Sample: "TCP"

protocol_port

integer

Specifies the port used by the load balancer.

Returned: success

Sample: 80

tags

string

Tags the listener.

Returned: success

updated_at

string

Specifies the time when the listener was updated.

Returned: success

Authors

  • Anton Sidelnikov (@anton-sidelnikov)