effectivelywild.technitium_dns.technitium_dns_delete_zone module – Delete 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_delete_zone.

New in effectivelywild.technitium_dns 0.1.0

Synopsis

  • Delete a DNS zone in Technitium DNS server using its API.

Parameters

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

See Also

Examples

- name: Delete a zone
  technitium_dns_delete_zone:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"

Return Values

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

domain

string

The domain name of the deleted zone

Returned: always

Sample: "demo.test.local"

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to delete the zone

Returned: always

Sample: true

failed

boolean

Whether the module failed to complete the zone deletion

Returned: always

Sample: false

msg

string

Human-readable message describing the zone deletion result

Returned: always

Sample: "Zone 'demo.test.local' deleted."

Authors

  • Frank Muise (@effectivelywild)