f5networks.f5_modules.bigip_dns_zone module – Manage DNS zones on BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.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_dns_zone
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage DNS zones on BIG-IP. The zones managed here are primarily used for configuring DNS Express on a BIG-IP. This module does not configure zones that are found in BIG-IP ZoneRunner.
Parameters
Parameter |
Comments |
---|---|
DNS express related settings. |
|
Specifies the IP addresses from which the system accepts NOTIFY messages for this DNS Express zone. |
|
Specifies the current status of the DNS Express zone. Choices:
|
|
Specifies the action the system takes when a NOTIFY message is received for this DNS Express zone. If a TSIG key is configured for the zone, the signature is only validated for When When When Choices:
|
|
Specifies whether this DNS Express zone is a DNS response policy zone (RPZ). Choices:
|
|
Specifies the back-end authoritative DNS server from which the BIG-IP system receives AXFR zone transfers for the DNS Express zone. |
|
Specifies whether the system verifies the identity of the authoritative nameserver that sends updated information for this DNS Express zone. Choices:
|
|
Specifies the name of the DNS zone. The name must begin with a letter and contain only letters, numbers, and the underscore character. |
|
Specifies the DNS nameservers to which the system sends NOTIFY messages. |
|
Device partition to manage resources on. Default: |
|
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 TSIG key the system uses to authenticate the back-end DNS authoritative server that sends AXFR zone transfers to the BIG-IP system. |
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 zone for DNS express
bigip_dns_zone:
name: zone.foo.com
dns_express:
enabled: true
server: dns-lab
allow_notify_from:
- 192.168.39.10
notify_action: consume
verify_tsig: false
response_policy: false
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Disable DNS express zone, change server, and modify notify_action to bypass
bigip_dns_zone:
name: zone.foo.com
dns_express:
enabled: false
server: foo1.server.com
allow_notify_from:
- 192.168.39.10
notify_action: bypass
verify_tsig: false
response_policy: false
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add nameservers
bigip_dns_zone:
name: zone.foo.com
nameservers:
- foo1.nameserver.com
- foo2.nameserver.com
- foo3.nameserver.com
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove nameserver
bigip_dns_zone:
name: zone.foo.com
nameservers:
- foo1.nameserver.com
- foo2.nameserver.com
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove all nameservers
bigip_dns_zone:
name: zone.foo.com
nameservers: none
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add tsig_server_key
bigip_dns_zone:
name: zone.foo.com
tsig_server_key: key1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove tsig_server_key
bigip_dns_zone:
name: zone.foo.com
tsig_server_key: none
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove zone
bigip_dns_zone:
name: zone.foo.com
state: absent
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 |
---|---|
The new DNS Express Allow NOTIFY From value. Returned: changed Sample: |
|
Whether the zone is enabled or not. Returned: changed Sample: |
|
The new DNS Express Server value. Returned: changed Sample: |
|
The new Zone Transfer Clients Nameservers value. Returned: changed Sample: |
|
The new DNS Express Notify Action value. Returned: changed Sample: |
|
The new DNS Express Response Policy value. Returned: changed Sample: |
|
The new TSIG Server Key value. Returned: changed Sample: |
|
The new DNS Express Verify Notify TSIG value. Returned: changed Sample: |