effectivelywild.technitium_dns.technitium_dns_get_zone_options module – Get DNS zone 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.

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

New in effectivelywild.technitium_dns 0.1.0

Synopsis

  • Retrieve zone-specific options.

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

includeAvailableCatalogZoneNames

boolean

Include list of available Catalog zone names on the DNS server.

Choices:

  • false ← (default)

  • true

includeAvailableTsigKeyNames

boolean

Include list of available TSIG key names on the DNS server.

Choices:

  • false ← (default)

  • true

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)

zone

string / required

The domain name of the zone to get options for.

See Also

See also

effectivelywild.technitium_dns.technitium_dns_create_zone

Creates DNS Zones

effectivelywild.technitium_dns.technitium_dns_zone

State-based management for DNS zones

effectivelywild.technitium_dns.technitium_dns_sign_zone

Sign a zone with DNSSEC

effectivelywild.technitium_dns.technitium_dns_set_zone_options

Set zone options

effectivelywild.technitium_dns.technitium_dns_enable_zone

Enable a zone

effectivelywild.technitium_dns.technitium_dns_disable_zone

Disable a zone

Examples

- name: Get options for example.com zone
  technitium_dns_get_zone_options:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    includeAvailableTsigKeyNames: true
  register: result

- debug:
    var: result.options

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

failed

boolean

Whether the module failed

Returned: always

Sample: false

options

dictionary

Zone options returned from API

Returned: always

availableCatalogZoneNames

list / elements=string

List of available catalog zone names (when includeAvailableCatalogZoneNames is true)

Returned: when requested

availableTsigKeyNames

list / elements=string

List of available TSIG key names (when includeAvailableTsigKeyNames is true)

Returned: when requested

catalog

string

Zone catalog information

Returned: always

disabled

boolean

Whether the zone is disabled

Returned: always

dnssecStatus

string

DNSSEC status of the zone

Returned: always

internal

boolean

Whether the zone is internal

Returned: always

name

string

Zone name

Returned: always

notify

string

Zone notification policy (e.g., ZoneNameServers)

Returned: always

notifyFailed

boolean

Whether zone notification failed

Returned: always

notifyFailedFor

list / elements=string

List of hosts for which notification failed

Returned: always

notifyNameServers

list / elements=string

List of name servers to notify

Returned: always

overrideCatalogNotify

boolean

Whether to override catalog notify settings

Returned: always

overrideCatalogQueryAccess

boolean

Whether to override catalog query access settings

Returned: always

overrideCatalogZoneTransfer

boolean

Whether to override catalog zone transfer settings

Returned: always

queryAccess

string

Query access policy (e.g., Allow, Deny)

Returned: always

queryAccessNetworkACL

list / elements=string

Network ACL for query access

Returned: always

type

string

Zone type (e.g., Primary, Secondary)

Returned: always

update

string

Zone update policy (e.g., UseSpecifiedNetworkACL)

Returned: always

updateNetworkACL

list / elements=string

Network ACL for zone updates

Returned: always

updateSecurityPolicies

list / elements=string

List of update security policies

Returned: always

allowedTypes

list / elements=string

List of allowed DNS record types

Returned: success

domain

string

Domain pattern for the policy

Returned: success

tsigKeyName

string

TSIG key name for the policy

Returned: success

zoneTransfer

string

Zone transfer policy (e.g., AllowOnlyZoneNameServers)

Returned: always

zoneTransferNetworkACL

list / elements=string

Network ACL for zone transfers

Returned: always

zoneTransferTsigKeyNames

list / elements=string

TSIG key names allowed for zone transfers

Returned: always

Authors

  • Frank Muise (@effectivelywild)