f5networks.f5_modules.bigip_device_dns module – Manage DNS settings on a BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.27.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_device_dns.

New in f5networks.f5_modules 1.0.0

Synopsis

  • Manage the DNS settings on a BIG-IP device.

Parameters

Parameter

Comments

cache

string

Specifies whether the system caches DNS lookups or performs the operation each time a lookup is needed. Note this applies only to Access Policy Manager (APM) features, such as ACLs, web application rewrites, and authentication.

Choices:

  • "enabled"

  • "disabled"

  • "enable"

  • "disable"

ip_version

integer

Specifies whether the DNS specifies IP addresses using IPv4 or IPv6.

Choices:

  • 4

  • 6

name_servers

list / elements=string

A list of name servers the system uses to validate DNS lookups

provider

dictionary

added in f5networks.f5_modules 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.

Choices:

  • false ← (default)

  • true

password

aliases: pass, pwd

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.

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

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

Choices:

  • false

  • true ← (default)

list / elements=string

A list of domains the system searches for local domain lookups, to resolve local host names.

state

string

The state of the variable on the system. When present, guarantees an existing variable is set to value.

Choices:

  • "absent"

  • "present" ← (default)

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: Set the DNS settings on the BIG-IP
  bigip_device_dns:
    name_servers:
      - 208.67.222.222
      - 208.67.220.220
    search:
      - localdomain
      - lab.local
    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

cache

string

The new value of the DNS caching.

Returned: changed

Sample: "enabled"

ip_version

integer

IP version that was set, DNS will specify IP addresses in this version.

Returned: changed

Sample: 4

name_servers

list / elements=string

List of name servers that were set.

Returned: changed

Sample: ["192.0.2.10", "172.17.12.10"]

list / elements=string

List of search domains that were set.

Returned: changed

Sample: ["192.0.2.10", "172.17.12.10"]

warnings

list / elements=string

The list of warnings (if any) generated by module based on arguments

Returned: always

Sample: ["...", "..."]

Authors

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)