bigip_gtm_wide_ip – Manages F5 BIG-IP GTM wide ip¶
Parameters¶
Notes¶
Note
Support for TMOS versions below v12.x has been deprecated for this module, and will be removed in Ansible 2.12.
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 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
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
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
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
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
pools:
- name: pool1
ratio: 100
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:
Status¶
This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
This module is maintained by an Ansible Partner. [certified]
Authors¶
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.