f5networks.f5_modules.bigip_dns_resolver module – Manage DNS resolvers on a BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.19.0).

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_dns_resolver.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manage DNS resolvers on a BIG-IP system.

Parameters

Parameter

Comments

answer_default_zones

boolean

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 the system passes along the DNS queries for the default zones.

Choices:

  • no

  • yes

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

Device partition to manage resources on.

Default: “Common”

provider

dictionary

added in 1.0.0 of f5networks.f5_modules

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.

Choices:

  • no ← (default)

  • yes

password

aliases: pass, pwd

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.

server

string / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • rest ← (default)

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

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.

Choices:

  • no

  • yes ← (default)

randomize_query_case

boolean

When yes, specifies 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.

Choices:

  • no

  • yes

route_domain

integer

Specifies the route domain the resolver uses for outbound traffic.

state

string

When present, ensures the resource exists.

When absent, ensures the resource is removed.

Choices:

  • present ← (default)

  • absent

use_ipv4

boolean

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.

Choices:

  • no

  • yes

use_ipv6

boolean

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.

Choices:

  • no

  • yes

use_tcp

boolean

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.

Choices:

  • no

  • yes

use_udp

boolean

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.

Choices:

  • no

  • yes

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 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

Description

answer_default_zones

boolean

The new Answer Default Zones setting.

Returned: changed

Sample: true

cache_size

integer

The new cache size of the resource.

Returned: changed

Sample: 50000

randomize_query_case

boolean

The new Randomize Query Character Case setting.

Returned: changed

Sample: false

route_domain

string

The new route domain of the resource.

Returned: changed

Sample: “/Common/0”

use_ipv4

boolean

The new Use IPv4 setting.

Returned: changed

Sample: true

use_ipv6

boolean

The new Use IPv6 setting.

Returned: changed

Sample: false

use_tcp

boolean

The new Use TCP setting.

Returned: changed

Sample: false

use_udp

boolean

The new Use UDP setting.

Returned: changed

Sample: true

Authors

  • Tim Rupp (@caphrim007)