opentelekomcloud / opentelekomcloud.cloud / 0.6.0 / module / lb_pool Add/Delete backend server group for load balancer from OpenTelekomCloud | "added in version" 0.0.4 of opentelekomcloud.cloud" Authors: Anton Sidelnikov (@anton-sidelnikov)opentelekomcloud.cloud.lb_pool (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 a backend server group for Enhanced Load Balancer from the OTC load-balancer service(ELB).
# Create a lb server group. - opentelekomcloud.cloud.lb_pool: state: present name: pool-test protocol: tcp lb_algorithm: round_robin listener: "5896b6f1-698f-4a81-989e-978b3f045643" loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253"
# Create a lb server group with session_persistence. - opentelekomcloud.cloud.lb_pool: state: present name: pool-test protocol: tcp lb_algorithm: round_robin listener: "5896b6f1-698f-4a81-989e-978b3f045643" loadbalancer: "0416b6f1-877f-4a51-987e-978b3f084253" session_persistence: - type: http_cookie - persistence_timeout: 60
# Delete a load balancer(and all its related resources) - opentelekomcloud.cloud.lb_pool: state: absent name: pool-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: - Specifies the backend server group name. 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 listener: description: - Specifies the ID or Name of the listener associated with the backend server group. type: str protocol: choices: - tcp - http - udp - terminated_https description: - Specifies the protocol that the backend server group uses to receive requests. Should be same as load balancer listener 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 backend server group. type: str region_name: description: - Name of the region. type: str lb_algorithm: choices: - round_robin - least_connections - source_ip description: - Specifies the load balancing algorithm of the backend server group. type: str loadbalancer: description: - Specifies the ID or Name of the load balancer associated with the backend server group. type: str admin_state_up: default: true description: - Specifies the administrative status of the backend server group. 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 session_persistence: description: - Specifies the sticky session timeout duration in minutes. type: dict
lb_pool: contains: admin_state_up: description: Specifies the administrative status of the backend server group. type: bool description: description: Provides supplementary information about the backend server group. type: str healthmonitor_id: description: Specifies the ID of the health check configured for the backend server group. type: str id: description: Specifies the ID of the backend server group. sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 type: str lb_algorithm: description: Specifies the load balancing algorithm of the backend server group. sample: ROUND_ROBIN type: str listeners: description: Lists the IDs of listeners associated with the backend server group. type: list loadbalancers: description: Lists the IDs of load balancers associated with the backend server group. type: list members: description: Lists the IDs of backend servers in the backend server group. type: list name: description: Specifies the backend server group name. sample: servers_test type: str protocol: description: Specifies the protocol that the backend server group uses to receive requests. sample: TCP type: str session_persistence: description: Specifies whether to enable the sticky session feature. type: str description: Specifies the pool. returned: On Success. type: complex