effectivelywild.technitium_dns.technitium_dns_add_allowed_zone module – Add a domain to the allowed zones

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

New in effectivelywild.technitium_dns 0.7.0

Synopsis

  • Add a domain name to the allowed zones.

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

domain

string / required

The domain name to add to the allowed zones

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_list_allowed_zones

List allowed zones

effectivelywild.technitium_dns.technitium_dns_delete_allowed_zone

Delete a domain from the allowed zones

effectivelywild.technitium_dns.technitium_dns_flush_allowed_zone

Flush all allowed zones

effectivelywild.technitium_dns.technitium_dns_add_blocked_zone

Add a domain to the blocked zones

Examples

- name: Add a domain to allowed zones
  technitium_dns_add_allowed_zone:
    api_url: "http://localhost"
    api_token: "myapitoken"
    domain: "example.com"

- name: Add multiple domains to allowed zones
  technitium_dns_add_allowed_zone:
    api_url: "http://localhost"
    api_token: "myapitoken"
    domain: "{{ item }}"
  loop:
    - "trusted1.com"
    - "trusted2.com"
    - "trusted3.com"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

Complete raw API response from Technitium DNS

Returned: always

response

dictionary

The core data payload from the API

Returned: always

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module added the domain to allowed zones

Returned: always

Sample: true

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human-readable message describing the result

Returned: always

Sample: "Domain 'example.com' added to allowed zones."

Authors

  • Frank Muise (@effectivelywild)