f5networks.f5_modules.bigip_snat_pool – Manage SNAT pools on a BIG-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_snat_pool
.
New in version 1.0.0: of f5networks.f5_modules
Parameters¶
Notes¶
Note
When the
bigip_snat_pool
object is removed, it also removes any associatedbigip_snat_translation
objects.This is a BIG-IP behavior not module behavior, and it only occurs when the
bigip_snat_translation
objects are also not referenced by anotherbigip_snat_pool
.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: Add the SNAT pool 'my-snat-pool'
bigip_snat_pool:
name: my-snat-pool
state: present
members:
- 10.10.10.10
- 20.20.20.20
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Change the SNAT pool's members to a single member
bigip_snat_pool:
name: my-snat-pool
state: present
member: 30.30.30.30
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove the SNAT pool 'my-snat-pool'
bigip_snat_pool:
name: johnd
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add the SNAT pool 'my-snat-pool' with a description
bigip_snat_pool:
name: my-snat-pool
state: present
members:
- 10.10.10.10
- 20.20.20.20
description: A SNAT pool description
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
members
list
/ elements=string
|
changed and success |
List of members that are part of the SNAT pool.
Sample:
['10.10.10.10']
|
Authors¶
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)