effectivelywild.technitium_dns.technitium_dns_update_dnskey_ttl module – Update DNSKEY TTL for a DNSSEC-signed zone

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

New in effectivelywild.technitium_dns 0.3.0

Synopsis

  • Updates the TTL value for DNSKEY resource record set in a DNSSEC-signed zone.

  • The value can be updated only when all the DNSKEYs are in ready or active state.

  • The zone must already be signed with DNSSEC.

Parameters

Parameter

Comments

api_port

integer

Port for the Technitium DNS API. Defaults to 5380

Default: 5380

api_token

string / required

API token for authentication

api_url

string / required

Base URL for the Technitium DNS API

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

ttl

integer / required

The TTL value for the DNSKEY resource record set in seconds

validate_certs

boolean

Whether to validate SSL certificates when making API requests.

Choices:

  • false

  • true ← (default)

zone

string / required

The name of the primary zone to update DNSKEY TTL for

See Also

See also

effectivelywild.technitium_dns.technitium_dns_get_dnssec_properties

Get DNSSEC properties for a zone

effectivelywild.technitium_dns.technitium_dns_update_private_key

Update DNSSEC private key properties

Examples

- name: Update DNSKEY TTL to 86400 seconds (24 hours)
  technitium_dns_update_dnskey_ttl:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    ttl: 86400

- name: Update DNSKEY TTL to 3600 seconds (1 hour)
  technitium_dns_update_dnskey_ttl:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    ttl: 3600

- name: Update DNSKEY TTL on a specific cluster node
  technitium_dns_update_dnskey_ttl:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    ttl: 86400
    node: "node1.cluster.example.com"

Return Values

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

Key

Description

api_response

dictionary

Full API response from Technitium DNS server

Returned: always

Sample: {"status": "ok"}

changed

boolean

Whether the module made changes

Returned: always

Sample: true

dnskey_ttl

integer

The updated DNSKEY TTL value

Returned: success

Sample: 86400

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human readable message describing the result

Returned: always

Sample: "DNSKEY TTL updated successfully for zone 'example.com' to 86400 seconds"

Authors

  • Frank Muise (@effectivelywild)