bigip_dns_resolver – Manage DNS resolvers on a BIG-IP

New in version 2.8.

Synopsis

  • Manage DNS resolver on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
answer_default_zones
boolean
    Choices:
  • no
  • yes
Specifies whether the system answers DNS queries for the default zones localhost, reverse 127.0.0.1 and ::1, and AS112.
When creating a new resolver, if this parameter is not specified, the default is no, meaning that the system passes along the DNS queries for the default zones.
cache_size
integer
Specifies the size of the internal DNS resolver cache.
When creating a new resolver, if this parameter is not specified, the default is 5767168 bytes.
After the cache reaches this size, when new or refreshed content arrives, the system removes expired and older content and caches the new or updated content.
name
string / required
Specifies the name of the DNS resolver.
partition
string
Default:
"Common"
Device partition to manage resources on.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
provider
dictionary
added in 2.5
A dict object containing connection details.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP 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.
ssh_keyfile
path
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
timeout
integer
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.
transport
string
    Choices:
  • cli
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
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 F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
randomize_query_case
boolean
    Choices:
  • no
  • yes
When yes, specifies that the internal DNS resolver randomizes character case in domain name queries issued to the root DNS servers.
When creating a new resolver, if this parameter is not specified, the default is yes.
route_domain
integer
Specifies the route domain the resolver uses for outbound traffic.
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
added in 2.2
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
state
string
    Choices:
  • present ←
  • absent
When present, ensures that the resource exists.
When absent, ensures the resource is removed.
use_ipv4
boolean
    Choices:
  • no
  • yes
Specifies whether the system can use IPv4 to query backend nameservers.
An IPv4 Self IP and default route must be available for these queries to work successfully.
When creating a new resolver, if this parameter is not specified, the default is yes.
use_ipv6
boolean
    Choices:
  • no
  • yes
Specifies whether the system can use IPv6 to query backend nameservers.
An IPv6 Self IP and default route must be available for these queries to work successfully.
When creating a new resolver, if this parameter is not specified, the default is yes.
use_tcp
boolean
    Choices:
  • no
  • yes
Specifies whether the system answers and issues TCP-formatted queries.
When creating a new resolver, if this parameter is not specified, the default is yes.
use_udp
boolean
    Choices:
  • no
  • yes
Specifies whether the system answers and issues UDP-formatted queries.
When creating a new resolver, if this parameter is not specified, the default is yes.
user
string / required
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 F5_USER.
validate_certs
boolean
added in 2.0
    Choices:
  • no
  • yes ←
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.

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 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 a simple DNS responder for OCSP stapling
  bigip_dns_resolver:
    name: resolver1
    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 Returned Description
answer_default_zones
boolean
changed
The new Answer Default Zones setting.

Sample:
True
cache_size
integer
changed
The new cache size of the resource.

Sample:
50000
randomize_query_case
boolean
changed
The new Randomize Query Character Case setting.

route_domain
string
changed
The new route domain of the resource.

Sample:
/Common/0
use_ipv4
boolean
changed
The new Use IPv4 setting.

Sample:
True
use_ipv6
boolean
changed
The new Use IPv6 setting.

use_tcp
boolean
changed
The new Use TCP setting.

use_udp
boolean
changed
The new Use UDP setting.

Sample:
True


Status

Authors

  • Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.