effectivelywild.technitium_dns.technitium_dns_check_for_update module – Check for available updates

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

New in effectivelywild.technitium_dns 0.5.0

Synopsis

  • Check if a software update is available.

  • Returns update information including current version, available version, and download links.

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_sessions

List active user sessions from Technitium DNS server

Examples

- name: Check for updates on Technitium DNS server
  technitium_dns_check_for_update:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: update_result

- debug:
    var: update_result.update_info

- name: Display update availability
  debug:
    msg: "Update available: {{ update_result.update_info.updateAvailable }}"
  when: update_result.update_info.updateAvailable is defined

- name: Show current and available versions
  debug:
    msg: "Current: {{ update_result.update_info.currentVersion }}, Available: {{ update_result.update_info.updateVersion }}"
  when: update_result.update_info.updateAvailable

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 check operations)

Returned: always

Sample: false

failed

boolean

Whether the module failed

Returned: always

Sample: false

update_info

dictionary

Update information from the Technitium DNS server

Returned: always

string

Link to the change log

Returned: when update is available

Sample: "https://github.com/TechnitiumSoftware/DnsServer/blob/master/CHANGELOG.md"

currentVersion

string

Current version of the DNS server

Returned: always

Sample: "8.1.4"

string

Direct download link for the update

Returned: when update is available and link is provided

Sample: "https://download.technitium.com/dns/DnsServerSetup.zip"

string

Link to update instructions

Returned: when update is available

Sample: "https://blog.technitium.com/2017/11/running-dns-server-on-ubuntu-linux.html"

updateAvailable

boolean

Whether an update is available

Returned: always

Sample: true

updateMessage

string

Detailed message about the update

Returned: when update is available

Sample: "Follow the instructions from the link below to update the DNS server to the latest version."

updateTitle

string

Title of the update notification

Returned: when update is available

Sample: "New Update Available!"

updateVersion

string

Version number of the available update

Returned: always

Sample: "9.0"

Authors

  • Frank Muise (@effectivelywild)