effectivelywild.technitium_dns.technitium_dns_uninstall_app module – Uninstall an app

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

New in effectivelywild.technitium_dns 0.9.0

Synopsis

  • Uninstall an app from the DNS server.

  • This does not remove any APP records that were using this DNS application.

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

name

string / required

The name of the app to uninstall

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)

See Also

Examples

- name: Uninstall Wild IP app
  technitium_dns_uninstall_app:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Wild IP"
  register: result

- name: Uninstall app on a specific cluster node
  technitium_dns_uninstall_app:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Geo Continent"
    node: "node1.cluster.example.com"

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

Returned: always

Sample: true

failed

boolean

Whether the module failed

Returned: always

Sample: false

msg

string

Human-readable message about the operation

Returned: always

Sample: "App 'Wild IP' uninstalled successfully"

Authors

  • Frank Muise (@effectivelywild)