Parameter |
Choices/Defaults |
Comments |
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
|
The load balancing mode that the system tries if the preferred_lb_method is unsuccessful in picking a pool.
|
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.
|
|
type
|
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.
|
|
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 type of at_least is used.
This parameter will be ignored if a type of either all or require is used.
|
|
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 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.
|
|
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 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.
|
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
|
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 that the system tries if both the preferred_lb_method and alternate_lb_method s are unsuccessful in picking a pool.
|
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 availability_requirements.type is require , you may only have a single monitor in the monitors list.
|
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 F5_PASSWORD .
aliases: pass, pwd
|
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
|
The load balancing mode that the system tries first.
|
provider
(added in 2.5) |
Default:
None
|
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 F5_PASSWORD .
aliases: pass, pwd
|
|
server
required |
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
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 F5_USER .
|
|
validate_certs
bool |
|
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 .
|
|
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.
|
|
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 ANSIBLE_NET_SSH_KEYFILE .
|
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
server
required |
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
server_port
(added in 2.2) |
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
state
|
Choices:
present ←
- absent
- enabled
- disabled
|
Pool 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
|
Choices:
- 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
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
bool
(added in 2.0) |
|
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 .
|