lb_pool

updated: None

lb_pool

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_pool.

New in version 0.0.4: of opentelekomcloud.cloud

Synopsis

  • Add or Remove a backend server group 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 backend server group.
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_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.
description
string
Provides supplementary information about the backend server group.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
lb_algorithm
string
    Choices:
  • round_robin
  • least_connections
  • source_ip
Specifies the load balancing algorithm of the backend server group.
listener
string
Specifies the ID or Name of the listener associated with the backend server group.
loadbalancer
string
Specifies the ID or Name of the load balancer associated with the backend server group.
name
string / required
Specifies the backend server group name.
protocol
string
    Choices:
  • tcp
  • http
  • udp
  • terminated_https
Specifies the protocol that the backend server group uses to receive requests. Should be same as load balancer listener protocol
region_name
string
Name of the region.
session_persistence
dictionary
Specifies the sticky session timeout duration in minutes.
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.
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 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
lb_pool
complex
On Success.
Specifies the pool.
 
admin_state_up
boolean
success
Specifies the administrative status of the backend server group.
 
description
string
success
Provides supplementary information about the backend server group.
 
healthmonitor_id
string
success
Specifies the ID of the health check configured for the backend server group.
 
id
string
success
Specifies the ID of the backend server group.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037c69
 
lb_algorithm
string
success
Specifies the load balancing algorithm of the backend server group.

Sample:
ROUND_ROBIN
 
listeners
list / elements=string
success
Lists the IDs of listeners associated with the backend server group.
 
loadbalancers
list / elements=string
success
Lists the IDs of load balancers associated with the backend server group.
 
members
list / elements=string
success
Lists the IDs of backend servers in the backend server group.
 
name
string
success
Specifies the backend server group name.

Sample:
servers_test
 
protocol
string
success
Specifies the protocol that the backend server group uses to receive requests.

Sample:
TCP
 
session_persistence
string
success
Specifies whether to enable the sticky session feature.


Authors

  • Anton Sidelnikov (@anton-sidelnikov)

updated: None