ansible / ansible.builtin / v2.4.6.0-1 / module / bigip_gtm_pool Manages F5 BIG-IP GTM pools. | "added in version" 2.4 of ansible.builtin" Authors: Tim Rupp (@caphrim007) preview | supported by communityansible.builtin.bigip_gtm_pool (v2.4.6.0-1) — module
pip
Install with pip install ansible==2.4.6.0.post1
Manages F5 BIG-IP GTM pools.
- 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
name: description: - Name of the GTM pool. required: true type: choices: - a - aaaa - cname - mx - naptr - srv description: - 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. state: choices: - present - absent - enabled - disabled description: - Pool member state. When C(present), ensures that the pool is created and enabled. When C(absent), ensures that the pool is removed from the system. When C(enabled) or C(disabled), ensures that the pool is enabled or disabled (respectively) on the remote device. required: true provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str password: aliases: - pass - pwd description: - The password for the user account used to connect to the BIG-IP. - You may omit this option by setting the environment variable C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int ssh_keyfile: description: - Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for I(cli) transports. - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE). type: path timeout: description: - 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. type: int transport: choices: - cli - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - 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 C(F5_USER). required: true type: str validate_certs: default: true description: - If C(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 C(F5_VALIDATE_CERTS). type: bool type: dict version_added: '2.5' version_added_collection: f5networks.f5_modules fallback_ip: description: - 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 C(fallback_ip) load balancing method. fallback_lb_method: 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 description: - The load balancing mode that the system tries if both the C(preferred_lb_method) and C(alternate_lb_method)s are unsuccessful in picking a pool. alternate_lb_method: 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 description: - The load balancing mode that the system tries if the C(preferred_lb_method) is unsuccessful in picking a pool. preferred_lb_method: 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 description: - The load balancing mode that the system tries first.
alternate_lb_method: description: New alternate load balancing method for the pool. returned: changed sample: drop-packet type: string fallback_ip: description: New fallback IP used when load balacing using the C(fallback_ip) method. returned: changed sample: 10.10.10.10 type: string fallback_lb_method: description: New fallback load balancing method for the pool. returned: changed sample: fewest-hops type: string preferred_lb_method: description: New preferred load balancing method for the pool. returned: changed sample: topology type: string