effectivelywild.technitium_dns.technitium_dns_get_app_config module – Get app configuration

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

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Retrieve the DNS application config from the dnsApp.config file in the application folder.

  • Returns the configuration data or null if no configuration exists.

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

name

string / required

The name of the app to retrieve the config from

node

string

The node domain name for which this API call is intended

When unspecified, the current node is used

This parameter can be used only when Clustering is initialized

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_app_config

Set app configuration

effectivelywild.technitium_dns.technitium_dns_list_apps

List all installed apps

Examples

- name: Get configuration for Split Horizon app
  technitium_dns_get_app_config:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Split Horizon"
  register: result

- debug:
    var: result.config

- name: Check if app has configuration
  technitium_dns_get_app_config:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Geo Continent"
  register: app_config

- name: Display config if it exists
  debug:
    msg: "App configuration: {{ app_config.config }}"

- name: Get app config on a specific cluster node
  technitium_dns_get_app_config:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Split Horizon"
    node: "node1.cluster.example.com"
  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 (always false for get operations)

Returned: always

Sample: false

config

string

Configuration data from the dnsApp.config file, or null if no configuration exists

Returned: always

Sample: "{\"networks\": [\"192.168.1.0/24\"], \"servers\": [\"10.0.0.1\"]}"

failed

boolean

Whether the module failed

Returned: always

Sample: false

Authors

  • Frank Muise (@effectivelywild)