effectivelywild.technitium_dns.technitium_dns_delete_user module – Delete a user account from Technitium DNS server

Note

This module is part of the effectivelywild.technitium_dns collection (version 0.4.0).

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

New in effectivelywild.technitium_dns 0.4.0

Synopsis

  • Delete a user account from Technitium DNS server using its API.

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

username

string / required

The username for the user account to delete

validate_certs

boolean

Whether to validate SSL certificates when making API requests

Choices:

  • false

  • true ← (default)

See Also

See also

effectivelywild.technitium_dns.technitium_dns_create_user

Create a user account in Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_list_users

List all users from Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_set_user_details

Set user account details on Technitium DNS server

effectivelywild.technitium_dns.technitium_dns_get_user_details

Get user account details from Technitium DNS server

Examples

- name: Delete a user account
  technitium_dns_delete_user:
    api_url: "http://localhost"
    api_token: "myapitoken"
    username: "testuser"

- name: Delete user in check mode
  technitium_dns_delete_user:
    api_url: "http://localhost"
    api_token: "myapitoken"
    username: "testuser"
  check_mode: true

Return Values

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

Key

Description

api_response

dictionary

Complete raw API response from Technitium DNS

Returned: always

response

dictionary

The core data payload from the API (empty for delete operations)

Returned: always

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to delete the user

Returned: always

Sample: true

failed

boolean

Whether the module failed to complete the user deletion

Returned: always

Sample: false

msg

string

Human-readable message describing the user deletion result

Returned: always

Sample: "User 'testuser' deleted."

Authors

  • Frank Muise (@effectivelywild)