effectivelywild.technitium_dns.technitium_dns_delete_log module – Delete a log file

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

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Permanently delete a log file from disk.

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

log

string / required

The fileName of the log file to delete (as returned by technitium_dns_list_logs)

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_logs

List all log files

effectivelywild.technitium_dns.technitium_dns_delete_all_logs

Delete all log files

Examples

- name: Delete a specific log file
  technitium_dns_delete_log:
    api_url: "http://localhost"
    api_token: "myapitoken"
    log: "2020-09-19"
  register: result

- name: Delete multiple old log files
  technitium_dns_delete_log:
    api_url: "http://localhost"
    api_token: "myapitoken"
    log: "{{ item }}"
  loop:
    - "2020-09-10"
    - "2020-09-11"
    - "2020-09-12"

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: "Log file '2020-09-19' deleted successfully"

Authors

  • Frank Muise (@effectivelywild)