effectivelywild.technitium_dns.technitium_dns_set_app_config module – Set app configuration on Technitium DNS server

Note

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

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

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Saves the provided DNS application config into the dnsApp.config file in the application folder.

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

any / required

The configuration data to save

Can be a string, dict, or list that will be converted to the appropriate format

name

string / required

The name of the app to set the config for

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_get_app_config

Get app configuration

effectivelywild.technitium_dns.technitium_dns_list_apps

List all installed apps

Examples

- name: Set configuration for Split Horizon app
  technitium_dns_set_app_config:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Split Horizon"
    config: '{"networks": ["192.168.1.0/24"], "servers": ["10.0.0.1"]}'
  register: result

- name: Set configuration using a dict
  technitium_dns_set_app_config:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Geo Continent"
    config:
      maxmind_db_path: "/opt/maxmind/GeoLite2-Country.mmdb"
      default_continent: "NA"

- name: Set Query Logs configuration
  technitium_dns_set_app_config:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Query Logs (Sqlite)"
    config:
      enableLogging: true
      maxLogDays: 30
      maxLogRecords: 10000

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

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human-readable message about the operation

Returned: always

Sample: "Configuration for app 'Split Horizon' set successfully"

Authors

  • Frank Muise (@effectivelywild)