bigip_gtm_pool – Manages F5 BIG-IP GTM pools
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.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
alternate_lb_method - |
|
The load balancing mode that the system tries if the | |
availability_requirements - added in 2.6 |
Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available. | ||
at_least - |
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 This parameter will be ignored if a type of either | ||
number_of_probers - |
Specifies the number of probers that should be used when running probes. When creating a new virtual server, if this parameter is specified, then the The value of this parameter should always be higher than, or equal to, the value of This parameter is only relevant when a This parameter will be ignored if a type of either | ||
number_of_probes - |
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, then the The value of this parameter should always be lower than, or equal to, the value of This parameter is only relevant when a This parameter will be ignored if a type of either | ||
type - |
|
Monitor rule type when When creating a new pool, if this value is not specified, the default of 'all' will be used. | |
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_lb_method - |
|
The load balancing mode that the system tries if both the | |
members - added in 2.6 |
Members to assign to the pool. The order of the members in this list is the order that they will be listed in the pool. | ||
server - / required |
Name of the server which the pool member is a part of. | ||
virtual_server - / required |
Name of the virtual server, associated with the server, that the pool member is a part of. | ||
monitors - added in 2.6 |
Specifies the health monitors that the system currently uses to monitor this resource. When | ||
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 may omit this option by setting the environment variable
| ||
preferred_lb_method - |
|
The load balancing mode that the system tries first. | |
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
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. | |
transport - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / 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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state - |
|
Pool state. When | |
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 may omit this option by setting the environment variable | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
Notes
Note
- 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
. - 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 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:
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
Sample: 10.10.10.10 | |
fallback_lb_method string |
changed |
New fallback load balancing method for the pool.
Sample: fewest-hops | |
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 |
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 |
Status
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_gtm_pool_module.html