effectivelywild.technitium_dns.technitium_dns_delete_private_key module – Delete DNSSEC private key from a 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_delete_private_key.

New in effectivelywild.technitium_dns 0.3.0

Synopsis

  • Deletes a private key that has state set as Generated from a DNSSEC signed zone.

  • Private keys with any other state cannot be deleted.

  • 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

key_tag

integer / required

The key tag of the private key to be deleted

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 name of the primary zone to delete the private key from

See Also

See also

effectivelywild.technitium_dns.technitium_dns_add_private_key

Add DNSSEC private key to a zone

effectivelywild.technitium_dns.technitium_dns_update_private_key

Update DNSSEC private key in a zone

effectivelywild.technitium_dns.technitium_dns_get_dnssec_properties

Get DNSSEC properties for a zone

Examples

- name: Delete private key with key tag 12345
  technitium_dns_delete_private_key:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    key_tag: 12345

- name: Delete private key from HTTPS API
  technitium_dns_delete_private_key:
    api_url: "https://dns.example.com"
    api_token: "myapitoken"
    zone: "example.com"
    key_tag: 54321
    validate_certs: true

- name: Delete private key on a specific cluster node
  technitium_dns_delete_private_key:
    api_url: "http://localhost"
    api_token: "myapitoken"
    zone: "example.com"
    key_tag: 12345
    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

msg

string

Human readable message describing the result

Returned: always

Sample: "Private key with tag 12345 deleted successfully from zone 'example.com'"

Authors

  • Frank Muise (@effectivelywild)