f5networks.f5_modules.bigip_gtm_wide_ip – Manages F5 BIG-IP GTM Wide IP¶
Note
This plugin is part of the f5networks.f5_modules collection (version 1.9.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_wide_ip
.
New in version 1.0.0: of f5networks.f5_modules
Parameters¶
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: Set lb method
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
type: a
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add iRules to the Wide IP
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
type: a
irules:
- irule1
- irule2
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove one iRule from the Virtual Server
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
type: a
irules:
- irule1
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove all iRules from the Virtual Server
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
type: a
irules: ""
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Assign a pool with ratio to the Wide IP
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
type: a
pools:
- name: pool1
ratio: 100
order: 2
- name: pool1
ratio: 100
order: 1
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Assign a pool with persistence to the Wide IP
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
type: a
pools:
- name: pool1
persistence: yes
persist_cidr_ipv4: 24
persist_cidr_ipv6: 120
persistence_ttl: 3500
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)