New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
append |
no |
|
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. This option can be omitted if the environment variable F5_PASSWORD is set. | ||
server |
yes | The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set. | ||
server_port (added in 2.2) |
no | 443 | The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set. | |
state |
no | present |
|
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. This option can be omitted if the environment variable F5_USER is set. | ||
validate_certs (added in 2.0) |
no | True |
|
If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set. |
- 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
Common return values are documented here 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'] |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.