Documentation

bigip_gtm_pool - Manages F5 BIG-IP GTM pools.

New in version 2.4.

Synopsis

  • Manages F5 BIG-IP GTM pools.

Options

parameter required default choices comments
alternate_lb_method
no
  • round-robin
  • return-to-dns
  • none
  • ratio
  • topology
  • static-persistence
  • global-availability
  • virtual-server-capacity
  • packet-rate
  • drop-packet
  • fallback-ip
  • virtual-server-score
The load balancing mode that the system tries if the preferred_lb_method is unsuccessful in picking a pool.
fallback_ip
no
Specifies the IPv4, or IPv6 address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select the fallback_ip load balancing method.
fallback_lb_method
no
  • round-robin
  • return-to-dns
  • ratio
  • topology
  • static-persistence
  • global-availability
  • virtual-server-capacity
  • least-connections
  • lowest-round-trip-time
  • fewest-hops
  • packet-rate
  • cpu
  • completion-rate
  • quality-of-service
  • kilobytes-per-second
  • drop-packet
  • fallback-ip
  • virtual-server-score
The load balancing mode that the system tries if both the preferred_lb_method and alternate_lb_methods are unsuccessful in picking a pool.
name
yes
Name of the GTM pool.
password
yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
preferred_lb_method
no
  • round-robin
  • return-to-dns
  • ratio
  • topology
  • static-persistence
  • global-availability
  • virtual-server-capacity
  • least-connections
  • lowest-round-trip-time
  • fewest-hops
  • packet-rate
  • cpu
  • completion-rate
  • quality-of-service
  • kilobytes-per-second
  • drop-packet
  • fallback-ip
  • virtual-server-score
The load balancing mode that the system tries first.
server
yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
state
yes
  • present
  • absent
  • enabled
  • disabled
Pool member state. When present, ensures that the pool is created and enabled. When absent, ensures that the pool is removed from the system. When enabled or disabled, ensures that the pool is enabled or disabled (respectively) on the remote device.
type
no
  • a
  • aaaa
  • cname
  • mx
  • naptr
  • srv
The type of GTM pool that you want to create. On BIG-IP releases prior to version 12, this parameter is not required. On later versions of BIG-IP, this is a required parameter.
user
yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.

Examples

- name: Create a GTM pool
  bigip_gtm_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my_pool"
  delegate_to: localhost

- name: Disable pool
  bigip_gtm_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      state: "disabled"
      name: "my_pool"
  delegate_to: localhost

Return Values

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

name description returned type sample
alternate_lb_method
New alternate load balancing method for the pool.
changed string drop-packet
fallback_ip
New fallback IP used when load balacing using the fallback_ip method.
changed string 10.10.10.10
fallback_lb_method
New fallback load balancing method for the pool.
changed string fewest-hops
preferred_lb_method
New preferred load balancing method for the pool.
changed string topology


Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • Requires the netaddr Python package on the host. This is as easy as pip install netaddr.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.