Last updated on: 2024-04-01 03:24:20.
bigip_gtm_pool_member – Manage GTM pool member settings¶
New in version 1.0.0.
Synopsis¶
- Manages a variety of settings on GTM (now BIG-IP DNS) pool members. The settings that can be adjusted with this module are much more broad that what can be done in the
bigip_gtm_pool
module. The pool module is intended to allow you to adjust the member order in the pool, not the various settings of the members. Thebigip_gtm_pool_member
module should be used to adjust all of the other settings.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments | ||
---|---|---|---|---|---|
aggregate
list
/ elements=dictionary
|
List of GTM pool member definitions to be created, modified, or removed.
When using
aggregates , if one of the aggregate definitions is invalid, the aggregate run will fail, indicating the error it last encountered.The module will
NOT rollback any changes it has made prior to encountering the error.The module also will not indicate what changes were made prior to failure, therefore we strongly advise you run the module in check mode to make basic validation, prior to module execution.
aliases: members |
||||
description
string
|
The description of the pool member.
|
||||
limits
dictionary
|
Specifies resource thresholds or limit requirements at the pool member level.
When you enable one or more limit settings, the system then uses that data to take members in and out of service.
You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load balancing traffic to another resource.
|
||||
bits_enabled
boolean
|
|
Whether or not the bits limit is enabled.
|
|||
bits_limit
integer
|
Specifies the maximum allowable data throughput rate for the member, in bits per second.
|
||||
connections_enabled
boolean
|
|
Whether or not the current connections limit is enabled.
|
|||
connections_limit
integer
|
Specifies the maximum number of concurrent connections, combined, for all of the members.
|
||||
packets_enabled
boolean
|
|
Whether or not the packets limit is enabled.
|
|||
packets_limit
integer
|
Specifies the maximum allowable data transfer rate for the member, in packets per second.
|
||||
member_order
integer
|
Specifies the order in which the member will appear in the pool.
The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method.
|
||||
monitor
string
|
Specifies the monitor assigned to this pool member.
Pool members only support a single monitor.
If the
port of the gtm_virtual_server is * , the accepted values of this parameter will be affected.If this parameter is not specified when creating a new pool member, the default of
default will be used.To remove the monitor from the pool member, use the value
none . |
||||
partition
string
|
Default: "Common"
|
Device partition to manage resources on.
|
|||
ratio
integer
|
Specifies the weight of the pool member for load balancing purposes.
|
||||
server_name
string
|
Specifies the GTM server which contains the
virtual_server . |
||||
state
string
|
|
Pool member state. When
present , ensures the pool member is created and enabled. When absent , ensures the pool member is removed from the system. When enabled or disabled , ensures the pool member is enabled or disabled (respectively) on the remote device. |
|||
virtual_server
string
|
Specifies the name of the GTM virtual server which is assigned to the specified
server . |
||||
description
string
|
The description of the pool member.
|
||||
limits
dictionary
|
Specifies resource thresholds or limit requirements at the pool member level.
When you enable one or more limit settings, the system then uses that data to take members in and out of service.
You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load balancing traffic to another resource.
|
||||
bits_enabled
boolean
|
|
Whether or not the bits limit is enabled.
|
|||
bits_limit
integer
|
Specifies the maximum allowable data throughput rate for the member, in bits per second.
|
||||
connections_enabled
boolean
|
|
Whether or not the current connections limit is enabled.
|
|||
connections_limit
integer
|
Specifies the maximum number of concurrent connections, combined, for all of the members.
|
||||
packets_enabled
boolean
|
|
Whether or not the packets limit is enabled.
|
|||
packets_limit
integer
|
Specifies the maximum allowable data transfer rate for the member, in packets per second.
|
||||
member_order
integer
|
Specifies the order in which the member will appear in the pool.
The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method.
|
||||
monitor
string
|
Specifies the monitor assigned to this pool member.
Pool members only support a single monitor.
If the
port of the gtm_virtual_server is * , the accepted values of this parameter will be affected.If this parameter is not specified when creating a new pool member, the default of
default will be used.To remove the monitor from the pool member, use the value
none . |
||||
partition
string
|
Default: "Common"
|
Device partition to manage resources on.
|
|||
pool
string
/ required
|
Name of the GTM pool.
For pools created on different partitions, you must specify partition of the pool in the full path format, for example,
/FooBar/pool_name . |
||||
provider
dictionary
added in 1.0.0 |
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
|
|
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 or the BIG-IQ.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||||
server
string
/ required
|
The BIG-IP host or the BIG-IQ 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
|
|
Configures the transport connection to use when connecting to the remote device.
|
|||
user
string
/ required
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable
F5_USER . |
||||
validate_certs
boolean
|
|
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 . |
|||
ratio
integer
|
Specifies the weight of the pool member for load balancing purposes.
|
||||
replace_all_with
boolean
|
|
Removes members not defined in the
aggregate parameter.This operation is all or none, meaning it will stop if there are some pool members that cannot be removed.
aliases: purge |
|||
server_name
string
|
Specifies the GTM server which contains the
virtual_server . |
||||
state
string
|
|
Pool member state. When
present , ensures the pool member is created and enabled. When absent , ensures the pool member is removed from the system. When enabled or disabled , ensures the pool member is enabled or disabled (respectively) on the remote device. |
|||
type
string
/ required
|
|
The type of GTM pool that the member is in.
|
|||
virtual_server
string
|
Specifies the name of the GTM virtual server which is assigned to the specified
server . |
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 member
bigip_gtm_pool_member:
pool: pool1
server_name: server1
virtual_server: vs1
type: a
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a GTM pool member different partition
bigip_gtm_pool_member:
server_name: /Common/foo_name
virtual_server: GTMVSName
type: a
pool: /FooBar/foo-pool
partition: Common
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add GTM pool members aggregate
bigip_gtm_pool_member:
pool: pool1
type: a
aggregate:
- server_name: server1
virtual_server: vs1
partition: Common
description: web server1
member_order: 0
- server_name: server2
virtual_server: vs2
partition: Common
description: web server2
member_order: 1
- server_name: server3
virtual_server: vs3
partition: Common
description: web server3
member_order: 2
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add GTM pool members aggregate, remove non aggregates
bigip_gtm_pool_member:
pool: pool1
type: a
aggregate:
- server_name: server1
virtual_server: vs1
partition: Common
description: web server1
member_order: 0
- server_name: server2
virtual_server: vs2
partition: Common
description: web server2
member_order: 1
- server_name: server3
virtual_server: vs3
partition: Common
description: web server3
member_order: 2
replace_all_with: true
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
bits_enabled
boolean
|
changed |
Whether the bits limit is enabled.
Sample:
True
|
bits_limit
integer
|
changed |
The new bits_enabled limit.
Sample:
100
|
connections_enabled
boolean
|
changed |
Whether the connections limit is enabled.
Sample:
True
|
connections_limit
integer
|
changed |
The new connections_limit limit.
Sample:
100
|
description
string
|
changed |
The new description of the member.
Sample:
My description
|
disabled
boolean
|
changed |
Whether the pool member is disabled or not.
Sample:
True
|
enabled
boolean
|
changed |
Whether the pool member is enabled or not.
Sample:
True
|
member_order
integer
|
changed |
The new order in which the member appears in the pool.
Sample:
2
|
monitor
string
|
changed |
The new monitor assigned to the pool member.
Sample:
/Common/monitor1
|
packets_enabled
boolean
|
changed |
Whether the packets limit is enabled.
Sample:
True
|
packets_limit
integer
|
changed |
The new packets_limit limit.
Sample:
100
|
ratio
integer
|
changed |
The new weight of the member for load balancing.
Sample:
10
|
replace_all_with
boolean
|
changed |
Purges all non-aggregate pool members from device
Sample:
True
|