f5networks.f5_modules.bigip_gtm_pool_member module – Manage GTM pool member settings
Note
This module is part of the f5networks.f5_modules collection (version 1.31.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_pool_member
.
New in f5networks.f5_modules 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 |
Comments |
---|---|
List of GTM pool member definitions to be created, modified, or removed. When using The module will 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. |
|
The description of the pool member. |
|
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. |
|
Whether or not the bits limit is enabled. Choices:
|
|
Specifies the maximum allowable data throughput rate for the member, in bits per second. |
|
Whether or not the current connections limit is enabled. Choices:
|
|
Specifies the maximum number of concurrent connections, combined, for all of the members. |
|
Whether or not the packets limit is enabled. Choices:
|
|
Specifies the maximum allowable data transfer rate for the member, in packets per second. |
|
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. |
|
Specifies the monitor assigned to this pool member. Pool members only support a single monitor. If the If this parameter is not specified when creating a new pool member, the default of To remove the monitor from the pool member, use the value |
|
Device partition to manage resources on. Default: |
|
Specifies the weight of the pool member for load balancing purposes. |
|
Specifies the GTM server which contains the |
|
Pool member state. When Choices:
|
|
Specifies the name of the GTM virtual server which is assigned to the specified |
|
The description of the pool member. |
|
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. |
|
Whether or not the bits limit is enabled. Choices:
|
|
Specifies the maximum allowable data throughput rate for the member, in bits per second. |
|
Whether or not the current connections limit is enabled. Choices:
|
|
Specifies the maximum number of concurrent connections, combined, for all of the members. |
|
Whether or not the packets limit is enabled. Choices:
|
|
Specifies the maximum allowable data transfer rate for the member, in packets per second. |
|
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. |
|
Specifies the monitor assigned to this pool member. Pool members only support a single monitor. If the If this parameter is not specified when creating a new pool member, the default of To remove the monitor from the pool member, use the value |
|
Device partition to manage resources on. Default: |
|
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, |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the weight of the pool member for load balancing purposes. |
|
Removes members not defined in the This operation is all or none, meaning it will stop if there are some pool members that cannot be removed. Choices:
|
|
Specifies the GTM server which contains the |
|
Pool member state. When Choices:
|
|
The type of GTM pool that the member is in. Choices:
|
|
Specifies the name of the GTM virtual server which is assigned to the specified |
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
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Whether the bits limit is enabled. Returned: changed Sample: |
|
The new bits_enabled limit. Returned: changed Sample: |
|
Whether the connections limit is enabled. Returned: changed Sample: |
|
The new connections_limit limit. Returned: changed Sample: |
|
The new description of the member. Returned: changed Sample: |
|
Whether the pool member is disabled or not. Returned: changed Sample: |
|
Whether the pool member is enabled or not. Returned: changed Sample: |
|
The new order in which the member appears in the pool. Returned: changed Sample: |
|
The new monitor assigned to the pool member. Returned: changed Sample: |
|
Whether the packets limit is enabled. Returned: changed Sample: |
|
The new packets_limit limit. Returned: changed Sample: |
|
The new weight of the member for load balancing. Returned: changed Sample: |
|
Purges all non-aggregate pool members from device Returned: changed Sample: |