W3cubDocs

/Ansible

bigip_snat_pool - Manage SNAT pools on a BIG-IP.

New in version 2.3.

Synopsis

Manage SNAT pools on a BIG-IP.

Requirements (on host that executes module)

  • f5-sdk

Options

parameter required default choices comments
append
 no
  • True
  • False
When yes, will only add members to the SNAT pool. When no, will replace the existing member list with the provided member list.
members
 no None
List of members to put in the SNAT pool. When a state of present is provided, this parameter is required. Otherwise, it is optional.
aliases: member
name
 yes
The name of the SNAT pool.
password
 yes
The password for the user account used to connect to the BIG-IP.
server
 yes
The BIG-IP host.
server_port
(added in 2.2)
 no 443
The BIG-IP server port.
state
 no present
  • present
  • absent
Whether the SNAT pool should exist or not.
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: Add the SNAT pool 'my-snat-pool'
  bigip_snat_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my-snat-pool"
      state: "present"
      members:
          - 10.10.10.10
          - 20.20.20.20
  delegate_to: localhost

- name: Change the SNAT pool's members to a single member
  bigip_snat_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my-snat-pool"
      state: "present"
      member: "30.30.30.30"
  delegate_to: localhost

- name: Append a new list of members to the existing pool
  bigip_snat_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "my-snat-pool"
      state: "present"
      members:
          - 10.10.10.10
          - 20.20.20.20
  delegate_to: localhost

- name: Remove the SNAT pool 'my-snat-pool'
  bigip_snat_pool:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      name: "johnd"
      state: "absent"
  delegate_to: localhost

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name description returned type sample
members ['List of members that are part of the SNAT pool.'] changed and success list ['10.10.10.10']

Notes

Note

Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk

Note

Requires the netaddr Python package on the host. This is as easy as pip install netaddr

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_snat_pool_module.html