effectivelywild.technitium_dns.technitium_dns_delete_cache module – Delete a cached DNS

Note

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

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

New in effectivelywild.technitium_dns 0.8.0

Synopsis

  • Delete cached DNS records for a specific domain.

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

domain

string / required

The domain name to delete cached records for.

validate_certs

boolean

Whether to validate SSL certificates when making API requests.

Choices:

  • false

  • true ← (default)

See Also

Examples

- name: Delete cached records for google.com
  technitium_dns_delete_cache:
    api_url: "http://localhost"
    api_token: "myapitoken"
    domain: "google.com"
  register: result

- name: Delete cached records for subdomain
  technitium_dns_delete_cache:
    api_url: "http://localhost"
    api_token: "myapitoken"
    domain: "www.example.com"
  register: result

Return Values

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

Key

Description

changed

boolean

Whether the module made changes

Returned: always

Sample: true

domain

string

The domain that was deleted from cache

Returned: always

Sample: "google.com"

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human-readable message about the operation

Returned: always

Sample: "Cached zone 'google.com' deleted successfully"

Authors

  • Frank Muise (@effectivelywild)