W3cubDocs

/Ansible

bigip_pool - Manages F5 BIG-IP LTM pools

Synopsis

Manages F5 BIG-IP LTM pools via iControl SOAP API

Requirements (on host that executes module)

  • bigsuds

Options

parameter required default choices comments
host
 no
Pool member IP
aliases: address
lb_method
(added in 1.3)
 no round_robin
  • round_robin
  • ratio_member
  • least_connection_member
  • observed_member
  • predictive_member
  • ratio_node_address
  • least_connection_node_address
  • fastest_node_address
  • observed_node_address
  • predictive_node_address
  • dynamic_ratio
  • fastest_app_response
  • least_sessions
  • dynamic_ratio_member
  • l3_addr
  • weighted_least_connection_member
  • weighted_least_connection_node_address
  • ratio_session
  • ratio_least_connection_member
  • ratio_least_connection_node_address
Load balancing method
monitor_type
(added in 1.3)
 no
  • and_list
  • m_of_n
Monitor rule type when monitors > 1
monitors
(added in 1.3)
 no
Monitor template name list. Always use the full path to the monitor.
name
 yes
Pool name
aliases: pool
partition
 no Common
Partition of pool/pool member
password
 yes
The password for the user account used to connect to the BIG-IP.
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.
server_port
(added in 2.2)
 no 443
The BIG-IP server port.
service_down_action
(added in 1.3)
 no
  • none
  • reset
  • drop
  • reselect
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
state
 no present
  • present
  • absent
Pool/pool member state
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
validate_certs
(added in 2.0)
 no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- 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"

- 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

- 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

- name: Delete pool
  bigip_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      state: "absent"
      name: "my-pool"
      partition: "Common"

Notes

Note

Requires BIG-IP software version >= 11

Note

F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)

Note

Best run as a local_action in your playbook

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/bigip_pool_module.html