effectivelywild.technitium_dns.technitium_dns_resync_zone module – Resync a Secondary or Stub zone

Note

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

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

New in effectivelywild.technitium_dns 0.4.0

Synopsis

  • Allows resyncing a Secondary or Stub zone using the Technitium DNS API.

  • This process will re-fetch all the records from the primary name server for the zone.

  • The zone will attempt to resync even if currently expired or has sync failures, as these may be resolved by the resync operation.

Parameters

Parameter

Comments

api_port

integer

Port for the Technitium DNS API. Defaults to 5380

Default: 5380

api_token

string / required

API token for authentication

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)

zone

string / required

The domain name of the zone to resync

Must be a Secondary or Stub zone

Zone will attempt to resync even if currently expired or has sync failures

See Also

See also

effectivelywild.technitium_dns.technitium_dns_create_zone

Create DNS zones

effectivelywild.technitium_dns.technitium_dns_get_zone_info

Get basic zone information

effectivelywild.technitium_dns.technitium_dns_get_zone_options

Get all configured zone options

Examples

- name: Resync a secondary zone
  technitium_dns_resync_zone:
    api_url: "http://localhost:5380"
    api_token: "{{ technitium_api_token }}"
    zone: "secondary.example.com"

- name: Resync a stub zone with custom API port
  technitium_dns_resync_zone:
    api_url: "http://dns.example.com"
    api_port: 5381
    api_token: "{{ technitium_api_token }}"
    zone: "stub.example.com"

- name: Check what would happen during resync (check mode)
  technitium_dns_resync_zone:
    api_url: "http://localhost:5380"
    api_token: "{{ technitium_api_token }}"
    zone: "secondary.example.com"
  check_mode: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

Complete raw API response from Technitium DNS

Returned: always

response

dictionary

The API response payload (empty dict for successful resync operations)

Returned: always

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

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 describing the result

Returned: always

Sample: "Zone 'secondary.example.com' resynced successfully."

Authors

  • Frank Muise (@effectivelywild)