effectivelywild.technitium_dns.technitium_dns_resync_cluster module – Manually trigger cluster configuration resync

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: effectivelywild.technitium_dns.technitium_dns_resync_cluster.

New in effectivelywild.technitium_dns 1.0.0

Synopsis

  • Manually trigger a complete configuration resync on a Secondary node.

  • When triggered, the Secondary node will sync the complete configuration from the Primary node.

  • This can only be called at a Secondary node.

Requirements

The below requirements are needed on the host that executes this module.

  • Technitium DNS Server v14.0 or later

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 only be used when clustering is initialized.

validate_certs

boolean

Whether to validate SSL certificates when making API requests.

Choices:

  • false

  • true ← (default)

Notes

Note

  • This operation requires Administration Modify permission.

  • This can only be run on a Secondary node.

  • The resync is triggered asynchronously and may take time to complete.

See Also

See also

effectivelywild.technitium_dns.technitium_dns_init_join_cluster

Join a cluster as Secondary

effectivelywild.technitium_dns.technitium_dns_get_cluster_state

Get cluster state information

Examples

- name: Manually resync cluster configuration
  effectivelywild.technitium_dns.technitium_dns_resync_cluster:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- name: Resync specific node
  effectivelywild.technitium_dns.technitium_dns_resync_cluster:
    api_url: "http://localhost"
    api_token: "myapitoken"
    node: "server2.example.com"

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 true when resync is triggered)

Returned: always

Sample: true

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Status message

Returned: always

Sample: "Cluster resync triggered successfully"

Authors

  • Frank Muise (@effectivelywild)