ansible / ansible.builtin / v2.4.6.0-1 / module / bigip_snat_pool Manage SNAT pools on a BIG-IP. | "added in version" 2.3 of ansible.builtin" Authors: Tim Rupp (@caphrim007) preview | supported by communityansible.builtin.bigip_snat_pool (v2.4.6.0-1) — module
pip
Install with pip install ansible==2.4.6.0.post1
Manage SNAT pools on a BIG-IP.
- 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
name: description: The name of the SNAT pool. required: true state: choices: - present - absent default: present description: - Whether the SNAT pool should exist or not. required: false append: choices: - true - false default: false description: - When C(yes), will only add members to the SNAT pool. When C(no), will replace the existing member list with the provided member list. members: aliases: - member default: None description: - List of members to put in the SNAT pool. When a C(state) of present is provided, this parameter is required. Otherwise, it is optional. required: false provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str password: aliases: - pass - pwd description: - The password for the user account used to connect to the BIG-IP. - You may omit this option by setting the environment variable C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int ssh_keyfile: description: - Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for I(cli) transports. - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE). type: path timeout: description: - 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. type: int transport: choices: - cli - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - The username to connect to the BIG-IP with. This user must have administrative privileges on the device. - You may omit this option by setting the environment variable C(F5_USER). required: true type: str validate_certs: default: true description: - If C(no), SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS). type: bool type: dict version_added: '2.5' version_added_collection: f5networks.f5_modules
members: description: - List of members that are part of the SNAT pool. returned: changed and success sample: '[''10.10.10.10'']' type: list