Docs4dev
Docs
ansible / 2.4 / bigip_device_dns_module.html

bigip_device_dns - Manage BIG-IP device DNS settings

New in version 2.2.

Synopsis

  • Manage BIG-IP device DNS settings

Requirements (on host that executes module)

  • f5-sdk

Options

parameter required default choices comments
cache
 no disable
  • enable
  • disable
Specifies whether the system caches DNS lookups or performs the operation each time a lookup is needed. Please note that this applies only to Access Policy Manager features, such as ACLs, web application rewrites, and authentication.
forwarders
 no
A list of BIND servers that the system can use to perform DNS lookups
ip_version
 no
  • 4
  • 6
Specifies whether the DNS specifies IP addresses using IPv4 or IPv6.
name_servers
 no
A list of name serverz that the system uses to validate DNS lookups
password
 yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
search
 no
A list of domains that the system searches for local domain lookups, to resolve local host names.
server
 yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
state
 no present
  • absent
  • present
The state of the variable on the system. When present, guarantees that an existing variable is set to value.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.

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
      state: present
      password: "secret"
      server: "lb.mydomain.com"
      user: "admin"
      validate_certs: "no"
  delegate_to: localhost

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
cache
The new value of the DNS caching
changed string enabled
forwarders
List of forwarders that were added or removed
changed list ['192.0.2.10', '172.17.12.10']
ip_version
IP version that was set that DNS will specify IP addresses in
changed int 4
name_servers
List of name servers that were added or removed
changed list ['192.0.2.10', '172.17.12.10']
search
List of search domains that were added or removed
changed list ['192.0.2.10', '172.17.12.10']

Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install requests

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigip_device_dns_module.html