effectivelywild.technitium_dns.technitium_dns_disable_zone module – Disable a DNS zone

Note

This module is part of the effectivelywild.technitium_dns collection (version 0.4.0).

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

To use it in a playbook, specify: effectivelywild.technitium_dns.technitium_dns_disable_zone.

New in effectivelywild.technitium_dns 0.1.0

Synopsis 

Disable a DNS zone, this will prevent the DNS server from responding to queries for this zone.

Parameter	Comments
api_port integer	Port for the Technitium DNS API. Defaults to 5380 Default: `5380`
api_token string / required	API token for authenticating with the Technitium DNS API
api_url string / required	Base URL for the Technitium DNS API
validate_certs boolean	Whether to validate SSL certificates when making API requests. Choices: `false` `true` ← (default)
zone string / required	The domain name of the zone to be disabled.

- name: Disable a zone
  technitium_dns_disable_zone:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"

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

Key	Description
api_response dictionary	Complete raw API response from Technitium DNS Returned: always
response dictionary	The core data payload from the API Returned: always Sample: `{}`
status string	API response status Returned: always Sample: `"ok"`
changed boolean	Whether the module made changes to disable the zone Returned: always Sample: `true`
failed boolean	Whether the module failed to disable the zone Returned: always Sample: `false`
msg string	Human-readable message describing the result of disabling the zone Returned: always Sample: `"Zone 'demo.test.local' disabled."`