bigip_gtm_pool - Manages F5 BIG-IP GTM pools
New in version 2.4.
Synopsis
- Manages F5 BIG-IP GTM pools.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.9
- netaddr
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
alternate_lb_method |
|
The load balancing mode that the system tries if the
preferred_lb_method is unsuccessful in picking a pool.
|
|
fallback_ip |
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 |
|
The load balancing mode that the system tries if both the
preferred_lb_method and
alternate_lb_method s are unsuccessful in picking a pool.
|
|
name
required
|
Name of the GTM pool.
|
||
partition
(added in 2.5)
|
Default:
Common
|
Device partition to manage resources on.
|
|
password
required
|
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.
aliases: pass, pwd |
||
preferred_lb_method |
|
The load balancing mode that the system tries first.
|
|
provider
(added in 2.5)
|
Default:
None
|
A dict object containing connection details.
|
|
ssh_keyfile |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for
cli transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead.
|
||
timeout | Default:
10
|
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.
|
|
server
required
|
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set.
|
||
user
required
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set.
|
||
server_port | Default:
443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set.
|
|
password
required
|
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.
aliases: pass, pwd |
||
validate_certs |
|
If
no , SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable
F5_VALIDATE_CERTS is set.
|
|
transport
required
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
server
required
|
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set.
|
||
server_port
(added in 2.2)
|
Default:
443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set.
|
|
state |
|
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 |
|
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
required
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set.
|
||
validate_certs
(added in 2.0)
|
|
If
no , SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable
F5_VALIDATE_CERTS is set.
|
Notes
Note
- Requires the netaddr Python package on the host. This is as easy as pip install netaddr.
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
.
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, 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
|
preferred_lb_method
string
|
changed |
New preferred load balancing method for the pool.
Sample:
topology
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Tim Rupp (@caphrim007)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_gtm_pool_module.html