effectivelywild.technitium_dns.technitium_dns_remove_dhcp_lease module – Remove a DHCP lease

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

New in effectivelywild.technitium_dns 0.6.0

Synopsis

  • Remove a dynamic or reserved lease allocation from a DHCP scope.

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

clientIdentifier

string

The client identifier for the lease

Either hardwareAddress or clientIdentifier must be specified

hardwareAddress

string

The MAC address of the device bearing the lease

Either hardwareAddress or clientIdentifier must be specified

name

string / required

The name of the DHCP scope containing the lease

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_list_dhcp_leases

List all DHCP leases

effectivelywild.technitium_dns.technitium_dns_add_reserved_lease

Add a reserved DHCP lease to a scope

effectivelywild.technitium_dns.technitium_dns_remove_reserved_lease

Remove a reserved DHCP lease from a scope

effectivelywild.technitium_dns.technitium_dns_convert_to_reserved_lease

Convert a dynamic DHCP lease to a reserved lease

effectivelywild.technitium_dns.technitium_dns_convert_to_dynamic_lease

Convert a reserved DHCP lease to a dynamic lease

Examples

- name: Remove a DHCP lease by MAC address
  technitium_dns_remove_dhcp_lease:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Default"
    hardwareAddress: "00:11:22:33:44:55"

- name: Remove a DHCP lease by client identifier
  technitium_dns_remove_dhcp_lease:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Default"
    clientIdentifier: "1-001122334455"

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 remove operations)

Returned: always

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to remove the lease

Returned: always

Sample: true

failed

boolean

Whether the module failed to remove the lease

Returned: always

Sample: false

msg

string

Human-readable message describing the result

Returned: always

Sample: "DHCP lease for MAC '00:11:22:33:44:55' removed from scope 'Default'."

Authors

  • Frank Muise (@effectivelywild)