effectivelywild.technitium_dns.technitium_dns_leave_cluster module – Leave a DNS cluster

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

New in effectivelywild.technitium_dns 1.0.0

Synopsis

  • Remove all cluster configuration from this Secondary node and leave the cluster gracefully.

  • There will be no data loss except for the cluster configuration.

  • 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

force_leave

boolean

Set to true to make this Secondary node leave the cluster without informing the Primary node.

Use this only when the Primary node is unreachable/decommissioned.

Choices:

  • false ← (default)

  • true

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 Delete permission.

  • Use force_leave only when the Primary node is unreachable/decommissioned.

  • This can only be run on a Secondary node, not on the Primary node.

See Also

See also

effectivelywild.technitium_dns.technitium_dns_init_join_cluster

Join a cluster as a Secondary node

effectivelywild.technitium_dns.technitium_dns_get_cluster_state

Get cluster state information

Examples

- name: Leave DNS cluster gracefully
  effectivelywild.technitium_dns.technitium_dns_leave_cluster:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- name: Display result
  debug:
    var: result.cluster_state

- name: Force leave cluster when Primary is unreachable
  effectivelywild.technitium_dns.technitium_dns_leave_cluster:
    api_url: "http://localhost"
    api_token: "myapitoken"
    force_leave: true
  register: result

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

cluster_state

dictionary

Cluster state after leaving

Returned: always

clusterInitialized

boolean

Whether the cluster is initialized (should be false after leaving)

Returned: always

Sample: false

dnsServerDomain

string

The DNS server domain name

Returned: always

Sample: "server2"

version

string

Technitium DNS Server version

Returned: always

Sample: "14.0"

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Status message

Returned: always

Sample: "Successfully left cluster"

Authors

  • Frank Muise (@effectivelywild)