effectivelywild.technitium_dns.technitium_dns_delete_dhcp_scope module – Delete a DHCP scope

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

New in effectivelywild.technitium_dns 0.6.0

Synopsis 

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 DHCP scope to delete
validate_certs boolean	Whether to validate SSL certificates when making API requests Choices: `false` `true` ← (default)

- name: Delete a DHCP scope
  technitium_dns_delete_dhcp_scope:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "TestScope"

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 DHCP scope Returned: always Sample: `true`
failed boolean	Whether the module failed to complete the DHCP scope deletion Returned: always Sample: `false`
msg string	Human-readable message describing the DHCP scope deletion result Returned: always Sample: `"DHCP scope 'TestScope' deleted."`