f5networks.f5_modules.bigip_snat_pool module – Manage SNAT pools on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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 f5networks.f5_modules 1.0.0
Synopsis
Manage SNAT pools on a BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
An optional description of the SNAT pool. |
|
List of members to put in the SNAT pool. When The members can be either IP addresses or names of the SNAT translation objects. |
|
The name of the SNAT pool. |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Whether the SNAT pool should exist or not. Choices:
|
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 |
Description |
---|---|
List of members that are part of the SNAT pool. Returned: changed and success Sample: |