bigip_gtm_pool_member – Manage GTM pool member settings
bigip_gtm_pool_member – Manage GTM pool member settings
New in version 2.6.
Synopsis
- Manages a variety of settings on GTM 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.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description - |
The description of the pool member. | ||
limits - |
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 the bits limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. | |
bits_limit - |
Specifies the maximum allowable data throughput rate, in bits per second, for the member. If the network traffic volume exceeds this limit, the system marks the member as unavailable. | ||
connections_enabled boolean |
|
Whether the current connections limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. | |
connections_limit - |
Specifies the maximum number of concurrent connections, combined, for all of the member. If the connections exceed this limit, the system marks the server as unavailable. | ||
packets_enabled boolean |
|
Whether the packets limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. | |
packets_limit - |
Specifies the maximum allowable data transfer rate, in packets per second, for the member. If the network traffic volume exceeds this limit, the system marks the member as unavailable. | ||
member_order - |
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. When creating a new member using this module, if the | ||
monitor - |
Specifies the monitor assigned to this pool member. Pool members only support a single monitor. If the When creating a new pool member, if this parameter is not specified, the default of To remove the monitor from the pool member, use the value For pool members created on different partitions, you can also specify the full path to the Common monitor. For example, | ||
partition - |
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
| ||
pool - / required |
Name of the GTM pool. | ||
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 | |
ratio - |
Specifies the weight of the pool member for load balancing purposes. | ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_name - / required |
Specifies the GTM server which contains the | ||
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 member state. When It is recommended that you use the Remember that the order of the members will be affected if you add or remove them using this method. To some extent, this can be controlled using the | |
type - / required |
|
The type of GTM pool that the member is in. | |
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 | |
virtual_server - / required |
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 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 ...
bigip_gtm_pool_member:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
param1 boolean |
changed |
The new param1 value of the resource.
Sample: True |
param2 string |
changed |
The new param2 value of the resource.
Sample: Foo is bar |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- 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_member_module.html