New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
address_lists
|
|
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
|
|
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-as to be properly formatted. ie,
2.2.2.2-1.1.1. would become 1.1.1.1-2.2.2.2. |
|
addresses
|
|
Individual addresses that 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. |
|
description
|
|
Description of the address list
|
|
fqdns
|
|
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 be configured. At the moment, this must either be done via
bigip_command, or, in the GUI of BIG-IP. If using bigip_command, this can be done 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 of geolocations specified by their
country and region. |
|
country
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
|
|
Region name of the country to use.
|
|
name
required |
|
Specifies the name of the address list.
|
|
partition
|
Default:
Common
|
Device partition to manage resources on.
|
|
password
required |
|
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
|
provider
(added in 2.5) |
|
A dict object containing connection details.
|
|
ssh_keyfile
|
|
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
|
timeout
|
Default:
10
|
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.
|
|
server
required |
|
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
|
user
required |
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
|
server_port
|
Default:
443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
password
required |
|
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
|
validate_certs
|
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
server
required |
|
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
|
server_port
(added in 2.2) |
Default:
443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
state
|
|
When
present, ensures that the address list and entries exists.When
absent, ensures the address list is removed. |
|
user
required |
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
|
validate_certs
(added in 2.0) |
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
Note
- name: Create an address list
bigip_security_address_list:
name: foo
addresses:
- 3.3.3.3
- 4.4.4.4
- 5.5.5.5
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Common return values are documented here, 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 geo locations applied to the address list.
|
|
country
string
|
changed |
Country of the geo location.
Sample:
US
|
|
region
string
|
changed |
Region of the geo location.
Sample:
California
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.