os_pool – Add/Delete a pool in the load balancing service from OpenStack Cloud

New in version 2.7.

Synopsis

  • Add or Remove a pool from the OpenStack load-balancer service.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
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.
availability_zone
-
Ignored. Present for backwards compatibility
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.
interface
string
added in 2.3
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
lb_algorithm
-
    Choices:
  • LEAST_CONNECTIONS
  • ROUND_ROBIN ←
  • SOURCE_IP
The load balancing algorithm for the pool.
listener
-
The name or id of the listener that this pool belongs to. Either loadbalancer or listener must be specified for pool creation.
loadbalancer
-
The name or id of the load balancer that this pool belongs to. Either loadbalancer or listener must be specified for pool creation.
name
- / required
Name that has to be given to the pool
protocol
-
    Choices:
  • HTTP ←
  • HTTPS
  • PROXY
  • TCP
  • UDP
The protocol for the pool.
region_name
string
Name of the region.
state
-
    Choices:
  • present ←
  • absent
Should the resource be present or absent.
timeout
integer
Default:
180
The amount of time the module should wait for the pool to get into ACTIVE state.
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 ←
If the module should wait for the pool to be ACTIVE.

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 pool, wait for the pool to be active.
- os_pool:
    cloud: mycloud
    endpoint_type: admin
    state: present
    name: test-pool
    loadbalancer: test-loadbalancer
    protocol: HTTP
    lb_algorithm: ROUND_ROBIN

# Delete a pool
- os_pool:
    cloud: mycloud
    endpoint_type: admin
    state: absent
    name: test-pool

Return Values

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

Key Returned Description
id
string
 On success when state is 'present'
The pool UUID.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037c69
listener
complex
 On success when state is 'present'
Dictionary describing the pool.
  description
string
The pool description.

Sample:
description
  id
string
Unique UUID.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037c69
  is_admin_state_up
boolean
The administrative state of the pool.

Sample:
True
  lb_algorithm
string
The load balancing algorithm for the pool.

Sample:
ROUND_ROBIN
  listener_id
string
The listener ID the pool belongs to.

Sample:
956aa716-9c2f-11e8-83b3-44a8422643a4
  listeners
list
A list of listener IDs.

Sample:
[{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
  loadbalancer_id
string
The load balancer ID the pool belongs to. This field is set when the pool doesn't belong to any listener in the load balancer.

Sample:
7c4be3f8-9c2f-11e8-83b3-44a8422643a4
  loadbalancers
list
A list of load balancer IDs.

Sample:
[{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
  members
list
A list of member IDs.

Sample:
[{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}]
  name
string
Name given to the pool.

Sample:
test
  operating_status
string
The operating status of the pool.

Sample:
ONLINE
  protocol
string
The protocol for the pool.

Sample:
HTTP
  provisioning_status
string
The provisioning status of the pool.

Sample:
ACTIVE


Status

Authors

  • Lingxian Kong (@lingxiankong)

Hint

If you notice any issues in this documentation you can edit this document to improve it.