f5networks.f5_modules.bigip_firewall_address_list module – Manage address lists on BIG-IP AFM
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_firewall_address_list
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages the AFM (Advanced Firewall Manager) address lists on a BIG-IP. This module can be used to add and remove address list entries.
Parameters
Parameter |
Comments |
---|---|
Simple list of existing address lists to add to this list. Address lists can be specified in either their fully qualified name (/Common/foo) or their short name (foo). If a short name is used, the |
|
A list of address ranges where the range starts with a port number, is followed by a dash (-), and then a second number. If the first address is greater than the second number, the numbers will be reversed so they are properly formatted. For example, |
|
Individual addresses you want to add to the list. These addresses differ from ranges and lists of lists, such as what can be used in This list can also include networks that have CIDR notation. |
|
Description of the address list. |
|
A list of fully qualified domain names (FQDNs). An FQDN has at least one decimal point in it, separating the host from the domain. To add FQDNs to a list requires that a global FQDN resolver is configured. This must be done using |
|
List of geolocations specified by their |
|
The country name or code of the geolocation to use. In addition to the country full names, you may also specify their abbreviated form, such as Valid country codes can be found here https://countrycode.org/. |
|
Region name of the country to use. |
|
Specifies the name of the address list. |
|
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:
|
|
When When Choices:
|
Notes
Note
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: Create an address list
bigip_firewall_address_list:
name: foo
addresses:
- 3.3.3.3
- 4.4.4.4
- 5.5.5.5
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new list of address list names applied to the address list. Returned: changed Sample: |
|
The new list of address ranges applied to the address list. Returned: changed Sample: |
|
The new list of addresses applied to the address list. Returned: changed Sample: |
|
The new description of the address list. Returned: changed Sample: |
|
The new list of FQDN names applied to the address list. Returned: changed Sample: |
|
The new list of geolocations applied to the address list. Returned: changed |
|
Country of the geolocation. Returned: changed Sample: |
|
Region of the geolocation. Returned: changed Sample: |