Last updated on: 2024-04-01 03:24:20.
bigip_firewall_address_list – Manage address lists on BIG-IP AFM¶
New in version 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 | Choices/Defaults | Configuration | Comments | |
---|---|---|---|---|
address_lists
list
/ elements=string
|
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
partition argument will automatically be prepended to the short name. |
|||
address_ranges
list
/ elements=string
|
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,
2.2.2.2-1.1.1 . would become 1.1.1.1-2.2.2.2 . |
|||
addresses
list
/ elements=string
|
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
address_ranges and address_lists respectively.This list can also include networks that have CIDR notation.
|
|||
description
string
|
Description of the address list.
|
|||
fqdns
list
/ elements=string
|
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
bigip_command or from the GUI of the BIG-IP. If using bigip_command , you can do this with tmsh modify security firewall global-fqdn-policy FOO where FOO is a DNS resolver configured at tmsh create net dns-resolver FOO . |
|||
geo_locations
list
/ elements=dictionary
|
List of geolocations specified by their
country and region . |
|||
country
string
/ required
|
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
US instead of United States .Valid country codes can be found here https://countrycode.org/.
|
|||
region
string
|
Region name of the country to use.
|
|||
name
string
/ required
|
Specifies the name of the address list.
|
|||
partition
string
|
Default: "Common"
|
Device partition to manage resources on.
|
||
provider
dictionary
added in 1.0.0 |
A dict object containing connection details.
|
|||
auth_provider
string
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|||
no_f5_teem
boolean
|
|
If
yes , TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable
F5_TELEMETRY_OFF .Previously used variable
F5_TEEM is deprecated as its name was confusing. |
||
password
string
/ required
|
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
F5_PASSWORD .aliases: pass, pwd |
|||
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER . |
|||
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
||
timeout
integer
|
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.
|
|||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
||
user
string
/ required
|
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
F5_USER . |
|||
validate_certs
boolean
|
|
If
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
F5_VALIDATE_CERTS . |
||
state
string
|
|
When
present , ensures the address list and entries exists.When
absent , ensures the address list is removed. |
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¶
The following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
address_lists
list
|
changed |
The new list of address list names applied to the address list.
Sample:
['/Common/list1', '/Common/list2']
|
|
address_ranges
list
|
changed |
The new list of address ranges applied to the address list.
Sample:
['1.1.1.1-2.2.2.2', '3.3.3.3-4.4.4.4']
|
|
addresses
list
|
changed |
The new list of addresses applied to the address list.
Sample:
['1.1.1.1', '2.2.2.2']
|
|
description
string
|
changed |
The new description of the address list.
Sample:
My address list
|
|
fqdns
list
|
changed |
The new list of FQDN names applied to the address list.
Sample:
['google.com', 'mit.edu']
|
|
geo_locations
complex
|
changed |
The new list of geolocations applied to the address list.
|
|
country
string
|
changed |
Country of the geolocation.
Sample:
US
|
|
region
string
|
changed |
Region of the geolocation.
Sample:
California
|