opentelekomcloud / opentelekomcloud.cloud / 0.6.0 / module / lb_listener Add/Delete listener for load balancer from OpenTelekomCloud | "added in version" 0.0.3 of opentelekomcloud.cloud" Authors: Anton Sidelnikov (@anton-sidelnikov)opentelekomcloud.cloud.lb_listener (0.6.0) — module
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.6.0
collections: - name: opentelekomcloud.cloud version: 0.6.0
Add or Remove listener for Enhanced Load Balancer from the OTC load-balancer service(ELB).
# Create a lb listener. - opentelekomcloud.cloud.lb_listener: state: present protocol_port: 80 protocol: TCP loadbalancer_id: "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_id: "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_id: "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
auth: description: - Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default I(password) plugin, this would contain I(auth_url), I(username), I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name) or I(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. type: dict name: description: - Name that has to be given to the listener required: true type: str wait: default: true description: - Should ansible wait until the requested resource is complete. type: bool cloud: description: - Named cloud or cloud config to operate against. If I(cloud) is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is provided or if OpenStack OS_* environment variables are present. If I(cloud) is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. type: raw state: choices: - present - absent default: present description: - Should the resource be present or absent. type: str ca_cert: aliases: - cacert description: - A path to a CA Cert bundle that can be used as part of verifying SSL API requests. type: str timeout: default: 180 description: - How long should ansible wait for the requested resource. type: int protocol: choices: - tcp - http - udp - terminated_https description: - Specifies the load balancer protocol. type: str auth_type: description: - 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 I(auth) parameter should be updated accordingly. type: str interface: aliases: - endpoint_type choices: - admin - internal - public default: public description: - Endpoint URL type to fetch from the service catalog. type: str client_key: aliases: - key description: - A path to a client key to use as part of the SSL transaction. type: str api_timeout: description: - 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. type: int client_cert: aliases: - cert description: - A path to a client certificate to use as part of the SSL transaction. type: str description: description: - Provides supplementary information about the listener. type: str region_name: description: - Name of the region. type: str default_pool: description: - Specifies the ID or Name of the associated backend server group. type: str http2_enable: default: false description: - Specifies whether to use HTTP/2 (valid only for terminated_https). type: bool loadbalancer: description: - Specifies the associated load balancer. type: str protocol_port: description: - Specifies the port used by the load balancer. type: int admin_state_up: description: - Specifies the administrative status of the listener. type: bool validate_certs: aliases: - verify default: false description: - Whether or not SSL API requests should be verified. - Before Ansible 2.3 this defaulted to C(yes). type: bool connection_limit: default: -1 description: - Specifies the maximum number of connections (from -1 to 2147483647). type: int sni_container_refs: default: [] description: - Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener (only for terminated_https). elements: str type: list tls_ciphers_policy: default: tls-1-0 description: - Specifies the security policy used by the listener (only for terminated_https). (server certificates with a domain name) used by the listener. type: str default_tls_container_ref: default: null description: - Specifies the ID of the server certificate used by the listener (only for terminated_https). type: str client_ca_tls_container_ref: default: null description: - Specifies the ID of the CA certificate used by the listener (only for terminated_https). type: str
lb_listener: contains: admin_state_up: description: Specifies the administrative status of the listener. type: bool connection_limit: description: Specifies the maximum number of connections. type: int created_at: description: Specifies the time when the listener was created. type: str default_pool_id: description: Specifies the ID of the associated backend server group. type: str description: description: Provides supplementary information about the listener. type: str id: description: Specifies the listener ID. sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 type: str loadbalancers: description: Specifies the ID of the associated load balancer. type: list name: description: Specifies the listener name. sample: elb_test type: str protocol: description: Specifies the load balancer protocol. sample: TCP type: str protocol_port: description: Specifies the port used by the load balancer. sample: '80' type: int tags: description: Tags the listener. type: str updated_at: description: Specifies the time when the listener was updated. type: str description: Specifies the listener. returned: On Success. type: complex