effectivelywild.technitium_dns.technitium_dns_get_server_settings module – Get DNS server settings

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.

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

New in effectivelywild.technitium_dns 1.1.0

Synopsis

  • Retrieve all DNS server settings from Technitium DNS.

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_set_server_settings

Update DNS server settings

Examples

- name: Get all DNS server settings
  effectivelywild.technitium_dns.technitium_dns_get_server_settings:
    api_url: "http://localhost"
    api_token: "myapitoken"
  register: result

- name: Show resolver configuration
  debug:
    msg: "Resolvers: {{ result.settings.resolverConcurrency }} concurrent, timeout {{ result.settings.resolverTimeout }} ms"

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)

Returned: always

Sample: false

failed

boolean

Whether the module failed

Returned: always

Sample: false

settings

dictionary

Complete DNS server settings returned by the API

Returned: always

Authors

  • Frank Muise (@effectivelywild)