effectivelywild.technitium_dns.technitium_dns_delete_user module – Delete a user account
Note
This module is part of the effectivelywild.technitium_dns collection (version 0.9.1).
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
Parameters
Parameter |
Comments |
|---|---|
Port for the Technitium DNS API. Defaults to 5380 Default: |
|
API token for authenticating with the Technitium DNS API |
|
Base URL for the Technitium DNS API |
|
The username for the user account to delete |
|
Whether to validate SSL certificates when making API requests Choices:
|
See Also
See also
- effectivelywild.technitium_dns.technitium_dns_create_user
Create a user account
- effectivelywild.technitium_dns.technitium_dns_list_users
List all users
- effectivelywild.technitium_dns.technitium_dns_set_user_details
Set user account details
- effectivelywild.technitium_dns.technitium_dns_get_user_details
Get user account details
Examples
- name: Delete a user account
technitium_dns_delete_user:
api_url: "http://localhost"
api_token: "myapitoken"
username: "testuser"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Complete raw API response from Technitium DNS Returned: always |
|
The core data payload from the API (empty for delete operations) Returned: always Sample: |
|
API response status Returned: always Sample: |
|
Whether the module made changes to delete the user Returned: always Sample: |
|
Whether the module failed to complete the user deletion Returned: always Sample: |
|
Human-readable message describing the user deletion result Returned: always Sample: |