effectivelywild.technitium_dns.technitium_dns_list_logs module – List all log files 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_list_logs.

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Retrieve a list of all log files.

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 this API call is intended

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_delete_log

Delete a specific log file

effectivelywild.technitium_dns.technitium_dns_delete_all_logs

Delete all log files

effectivelywild.technitium_dns.technitium_dns_query_logs

Query logs to a specified DNS app

Examples

- name: List all log files from Technitium DNS
  technitium_dns_list_logs:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- debug:
    var: result.log_files

- name: Find logs from a specific date
  technitium_dns_list_logs:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: logs_result

- name: Display today's log
  debug:
    msg: "Log: {{ item.fileName }} ({{ item.size }})"
  loop: "{{ logs_result.log_files | selectattr('fileName', 'match', '2020-09-19') | list }}"

- name: List log files on a specific cluster node
  technitium_dns_list_logs:
    api_url: "http://localhost"
    api_token: "myapitoken"
    node: "node1.cluster.example.com"
  register: node_logs

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 (always false for list operations)

Returned: always

Sample: false

failed

boolean

Whether the module failed

Returned: always

Sample: false

log_files

list / elements=dictionary

List of log files from the Technitium DNS server

Returned: always

fileName

string

Name of the log file (typically YYYY-MM-DD format)

Returned: always

Sample: "2020-09-19"

size

string

Size of the log file with units

Returned: always

Sample: "8.14 KB"

Authors

  • Frank Muise (@effectivelywild)