effectivelywild.technitium_dns.technitium_dns_set_cluster_options module – Set DNS cluster options

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

New in effectivelywild.technitium_dns 1.0.0

Synopsis

• Configure cluster options to be used by all Secondary nodes.

• This call can only be made at the Primary node.

• Options control heartbeat and configuration sync intervals.

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
config_refresh_interval_seconds integer	The interval in seconds for refreshing configuration from the Primary node. Valid range is 30-3600 seconds.
config_retry_interval_seconds integer	The interval in seconds for retrying configuration refresh in case of failure. Valid range is 30-3600 seconds.
heartbeat_refresh_interval_seconds integer	The interval in seconds for refreshing the state of all nodes in the cluster. Valid range is 10-300 seconds.
heartbeat_retry_interval_seconds integer	The interval in seconds for retrying state refresh for all nodes in case of failure. Valid range is 10-300 seconds.
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 the Primary node.

• All intervals are in seconds.

See Also

See also

effectivelywild.technitium_dns.technitium_dns_get_cluster_state

Get cluster state and current options

effectivelywild.technitium_dns.technitium_dns_init_cluster

Initialize a new cluster

Examples

- name: Set cluster heartbeat intervals
  effectivelywild.technitium_dns.technitium_dns_set_cluster_options:
    api_url: "http://localhost"
    api_token: "myapitoken"
    heartbeat_refresh_interval_seconds: 60
    heartbeat_retry_interval_seconds: 15
  register: result

- name: Set cluster config sync intervals
  effectivelywild.technitium_dns.technitium_dns_set_cluster_options:
    api_url: "http://localhost"
    api_token: "myapitoken"
    config_refresh_interval_seconds: 1800
    config_retry_interval_seconds: 120

- name: Set all cluster options
  effectivelywild.technitium_dns.technitium_dns_set_cluster_options:
    api_url: "http://localhost"
    api_token: "myapitoken"
    heartbeat_refresh_interval_seconds: 45
    heartbeat_retry_interval_seconds: 10
    config_refresh_interval_seconds: 600
    config_retry_interval_seconds: 90

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	Complete cluster state after setting options Returned: always
clusterDomain string	The cluster domain name Returned: always Sample: "example.com"
clusterInitialized boolean	Whether the cluster is initialized Returned: always Sample: true
clusterNodes list / elements=dictionary	List of nodes in the cluster Returned: always
configRefreshIntervalSeconds integer	Interval in seconds for config refresh Returned: always Sample: 600
configRetryIntervalSeconds integer	Interval in seconds for config retry Returned: always Sample: 90
dnsServerDomain string	The DNS server domain name Returned: always Sample: "server1.example.com"
heartbeatRefreshIntervalSeconds integer	Interval in seconds for heartbeat refresh Returned: always Sample: 45
heartbeatRetryIntervalSeconds integer	Interval in seconds for heartbeat retry Returned: always Sample: 10
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: "Cluster options updated successfully"

Authors

• Frank Muise (@effectivelywild)

Collection links

• Issue Tracker
• Repository (Sources)