effectivelywild.technitium_dns.technitium_dns_update_private_key module – Update DNSSEC private key properties

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

New in effectivelywild.technitium_dns 0.3.0

Synopsis

  • Updates the properties of an existing DNSSEC private key in a zone.

  • The zone must already be signed with DNSSEC and the key must exist.

  • Currently supports updating the rollover days property.

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

key_tag

integer / required

The key tag of the private key to be updated

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

rollover_days

integer / required

The frequency in days that the DNS server must automatically rollover the private key

Valid range is 0-365 days where 0 disables rollover

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 containing the private key

See Also

See also

effectivelywild.technitium_dns.technitium_dns_add_private_key

Add DNSSEC private key to a zone

effectivelywild.technitium_dns.technitium_dns_get_dnssec_properties

Get DNSSEC properties for a zone

Examples

- name: Update private key rollover to 90 days
  technitium_dns_update_private_key:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    key_tag: 1234
    rollover_days: 90

- name: Disable automatic rollover for a key
  technitium_dns_update_private_key:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    key_tag: 5678
    rollover_days: 0

- name: Update private key on a specific cluster node
  technitium_dns_update_private_key:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    key_tag: 1234
    rollover_days: 120
    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

failed

boolean

Whether the module failed

Returned: always

Sample: false

key_info

dictionary

Information about the updated private key

Returned: success

Sample: {"keyTag": 1234, "rolloverDays": 90}

msg

string

Human readable message describing the result

Returned: always

Sample: "Private key 1234 updated successfully in zone 'example.com'"

Authors

  • Frank Muise (@effectivelywild)