f5networks.f5_modules.bigip_gtm_pool – Manages F5 BIG-IP GTM pools

Note

This plugin is part of the f5networks.f5_modules collection (version 1.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_pool.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

Manages F5 BIG-IP GTM (now BIG-IP DNS) pools.

Parameters

Parameter		Choices/Defaults	Comments
alternate_lb_method string		Choices: 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 the system tries if the `preferred_lb_method` is unsuccessful in picking a pool.
availability_requirements dictionary			If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available.
	at_least integer		Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a `type` of `at_least` is used. This parameter will be ignored if a type of either `all` or `require` is used.
	number_of_probers integer		Specifies the number of probers that should be used when running probes. When creating a new virtual server, if this parameter is specified, the `number_of_probes` parameter must also be specified. The value of this parameter should always be higher than, or equal to, the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used.
	number_of_probes integer		Specifies the minimum number of probes that must succeed for this server to be declared up. When creating a new virtual server, if this parameter is specified, the `number_of_probers` parameter must also be specified. The value of this parameter should always be lower than, or equal to, the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used.
	type string / required	Choices: all at_least require	Monitor rule type when `monitors` is specified. When creating a new pool, if this value is not specified, the default of 'all' will be used.
fallback_ip string			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 string		Choices: 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 none	The load balancing mode the system tries if both the `preferred_lb_method` and `alternate_lb_method`s are unsuccessful in picking a pool.
max_answers_returned integer			Specifies the maximum number of available virtual servers the system lists in a response. The maximum is 500.
members list / elements=dictionary			Members to assign to the pool. The order of the members in this list is the order they will be listed in the pool.
	server string / required		Name of the server which the pool member is a part of.
	virtual_server string / required		Name of the virtual server, associated with the server, the pool member is a part of.
monitors list / elements=string			Specifies the health monitors the system currently uses to monitor this resource. When `availability_requirements.type` is `require`, you may only have a single monitor in the `monitors` list.
name string / required			Name of the GTM pool.
partition string		Default: "Common"	Device partition to manage resources on.
preferred_lb_method string		Choices: 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 the system tries first.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	Choices: no ← yes	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	timeout integer		Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
	transport string	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`.
	validate_certs boolean	Choices: no yes ←	If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
state string		Choices: present ← absent enabled disabled	Pool state. When `present`, ensures the pool is created and enabled. When `absent`, ensures the pool is removed from the system. When `enabled` or `disabled`, ensures the pool is enabled or disabled (respectively) on the remote device.
ttl integer			Specifies the number of seconds the IP address, once found, is valid.
type string / required		Choices: a aaaa cname mx naptr srv	The type of GTM pool you want to create.

Notes

Note

For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

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

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

Return Values

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

Key		Returned	Description
alternate_lb_method string		changed	New alternate load balancing method for the pool. Sample: drop-packet
fallback_ip string		changed	New fallback IP used when load balacing using the `fallback_ip` method. Sample: 10.10.10.10
fallback_lb_method string		changed	New fallback load balancing method for the pool. Sample: fewest-hops
max_answers_returned integer		changed	The new Maximum Answers Returned value. Sample: 25
members complex		changed	List of members in the pool.
	server string	changed	The name of the server portion of the member.
	virtual_server string	changed	The name of the virtual server portion of the member.
monitors list / elements=string		changed	The new list of monitors for the resource. Sample: ['/Common/monitor1', '/Common/monitor2']
preferred_lb_method string		changed	New preferred load balancing method for the pool. Sample: topology

Authors

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_pool_module.html

Docs

Docs4dev

Title here