effectivelywild.technitium_dns.technitium_dns_flush_cache module – Flush the entire DNS cache

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

New in effectivelywild.technitium_dns 0.8.0

Synopsis

  • Clear all cached DNS records.

  • This is a destructive operation that affects all cached entries.

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)

See Also

See also

effectivelywild.technitium_dns.technitium_dns_list_cache

List cached DNS zones and records

effectivelywild.technitium_dns.technitium_dns_delete_cache

Delete a specific cached zone

Examples

- name: Flush entire DNS cache
  technitium_dns_flush_cache:
    api_url: "http://localhost"
    api_token: "myapitoken"
  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

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human-readable message about the operation

Returned: always

Sample: "DNS cache flushed successfully"

Authors

  • Frank Muise (@effectivelywild)