f5networks.f5_modules.bigip_profile_dns module – Manage DNS profiles 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_profile_dns
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage DNS profiles on a BIG-IP. There are many DNS profiles options, each with their own adjustments to the standard
dns
profile. Users of this module should be aware that many of the configurable options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.
Parameters
Parameter |
Comments |
---|---|
Specifies the user-created cache the system uses to cache DNS responses. When you select a cache for the system to use, you must also set |
|
Specifies whether the system caches DNS responses. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. When When Choices:
|
|
Specifies whether the DNS Express engine is enabled. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The DNS Express engine receives zone transfers from the authoritative DNS server for the zone. If the Choices:
|
|
Specifies whether the DNS firewall is enabled. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies whether the system signs responses with DNSSEC keys and replies to DNSSEC specific queries (for example, DNSKEY query type). When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies whether the system uses Global Traffic Manager (now BIG-IP DNS) to manage the response. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies whether the system answers zone transfer requests for a DNS zone created on the system. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The When the When the Choices:
|
|
Specifies the name of the DNS profile. |
|
Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied |
|
Device partition to manage resources on. Default: |
|
Specifies whether to process client-side DNS packets with Recursion Desired set in the header. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. If set to Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
When When Choices:
|
|
Specifies the action to take when a query does not match a Wide IP or a DNS Express Zone. When When When When When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies whether the system forwards non-wide IP queries to the local BIND server on the BIG-IP system. For best performance, disable this setting when using a DNS cache. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
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 DNS profile
bigip_profile_dns:
name: foo
enable_dns_express: false
enable_dnssec: false
enable_gtm: false
process_recursion_desired: false
use_local_bind: false
enable_dns_firewall: true
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 |
---|---|
Name of the cache used by DNS. Returned: changed Sample: |
|
Whether DNS caching is enabled or not. Returned: changed Sample: |
|
Whether DNS Express is enabled on the resource or not. Returned: changed Sample: |
|
Whether DNS firewall capability is enabled or not. Returned: changed Sample: |
|
Whether DNSSEC is enabled on the resource or not. Returned: changed Sample: |
|
Whether GTM is used to manage the resource or not. Returned: changed Sample: |
|
Whether zone transfer are enabled on the resource or not. Returned: changed Sample: |
|
Whether client-side DNS packets are processed with Recursion Desired set. Returned: changed Sample: |
|
What to do with unhandled queries Returned: changed Sample: |
|
Whether non-wide IP queries are forwarded to the local BIND server or not. Returned: changed Sample: |