effectivelywild.technitium_dns.technitium_dns_delete_all_stats module – Delete all statistics from Technitium DNS server

Note

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

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

New in effectivelywild.technitium_dns 0.8.0

Synopsis

  • Permanently delete all hourly and daily stats files from disk.

  • Clears all statistics stored in memory.

  • This will clear all stats from the Dashboard.

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

node

string

The node domain name for which the stats data needs to be deleted

When unspecified, the current node is used

This parameter can be used only when Clustering is initialized

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_get_stats

Get DNS statistics from the dashboard

effectivelywild.technitium_dns.technitium_dns_get_top_stats

Get top statistics for specific stats type

Examples

- name: Delete all statistics from Technitium DNS
  technitium_dns_delete_all_stats:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- name: Delete all statistics from specific cluster node
  technitium_dns_delete_all_stats:
    api_url: "http://localhost"
    api_token: "myapitoken"
    node: "node1.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

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human-readable message about the operation

Returned: always

Sample: "All statistics deleted successfully"

Authors

  • Frank Muise (@effectivelywild)