parameter | required | default | choices | comments |
---|---|---|---|---|
description (added in 2.3) |
no |
Specifies descriptive text that identifies the pool.
|
||
host |
no |
Pool member IP.
aliases: address
|
||
lb_method (added in 1.3) |
no |
|
Load balancing method. When creating a new pool, if this value is not specified, the default of
round-robin will be used. |
|
monitor_type (added in 1.3) |
no |
|
Monitor rule type when
monitors > 1. |
|
monitors (added in 1.3) |
no |
Monitor template name list. If the partition is not provided as part of the monitor name, then the
partition option will be used instead. |
||
name |
yes |
Pool name
aliases: pool
|
||
password |
yes |
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable
F5_PASSWORD is set. |
||
port |
no |
Pool member port.
|
||
quorum (added in 1.3) |
no |
Monitor quorum value when
monitor_type is m_of_n . |
||
reselect_tries (added in 2.2) |
no |
Sets the number of times the system tries to contact a pool member after a passive failure.
|
||
server |
yes |
The BIG-IP host. This option can be omitted if the environment variable
F5_SERVER is set. |
||
server_port (added in 2.2) |
no | 443 |
The BIG-IP server port. This option can be omitted if the environment variable
F5_SERVER_PORT is set. |
|
service_down_action (added in 1.3) |
no |
|
Sets the action to take when node goes down in pool.
|
|
slow_ramp_time (added in 1.3) |
no |
Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected up pool members.
|
||
user |
yes |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable
F5_USER is set. |
||
validate_certs (added in 2.0) |
no | True |
|
If
no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set. |
- name: Create pool bigip_pool: server: "lb.mydomain.com" user: "admin" password: "secret" state: "present" name: "my-pool" partition: "Common" lb_method: "least_connection_member" slow_ramp_time: 120 delegate_to: localhost - name: Modify load balancer method bigip_pool: server: "lb.mydomain.com" user: "admin" password: "secret" state: "present" name: "my-pool" partition: "Common" lb_method: "round_robin" delegate_to: localhost - name: Add pool member bigip_pool: server: "lb.mydomain.com" user: "admin" password: "secret" state: "present" name: "my-pool" partition: "Common" host: "{{ ansible_default_ipv4['address'] }}" port: 80 delegate_to: localhost - name: Remove pool member from pool bigip_pool: server: "lb.mydomain.com" user: "admin" password: "secret" state: "absent" name: "my-pool" partition: "Common" host: "{{ ansible_default_ipv4['address'] }}" port: 80 delegate_to: localhost - name: Delete pool bigip_pool: server: "lb.mydomain.com" user: "admin" password: "secret" state: "absent" name: "my-pool" partition: "Common" delegate_to: localhost
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
description |
Description set on the pool.
|
changed | string | Pool of web servers |
host |
IP of pool member included in pool.
|
changed | string | 10.10.10.10 |
lb_method |
The LB method set for the pool.
|
changed | string | round-robin |
monitor_type |
The contact that was set on the datacenter.
|
changed | string | admin@root.local |
monitors |
Monitors set on the pool.
|
changed | list | ['/Common/http', '/Common/gateway_icmp'] |
port |
Port of pool member included in pool.
|
changed | int | 80 |
quorum |
The quorum that was set on the pool
|
changed | int | 2 |
reselect_tries |
The new value that is set for the number of tries to contact member
|
changed | int | 10 |
service_down_action |
Service down action that is set on the pool.
|
changed | string | reset |
slow_ramp_time |
The new value that is set for the slow ramp-up time.
|
changed | int | 500 |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.