effectivelywild.technitium_dns.technitium_dns_add_reserved_lease module – Add a reserved 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_add_reserved_lease.

New in effectivelywild.technitium_dns 0.6.0

Synopsis

  • Add a reserved lease entry to a specified 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

comments

string

Comments for the reserved lease entry

hardwareAddress

string / required

The MAC address of the client (format can be colon or hyphen separated)

hostName

string

The hostname of the client to override

ipAddress

string / required

The reserved IP address for the client

name

string / required

The name of the DHCP scope to add the reserved lease to

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_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

effectivelywild.technitium_dns.technitium_dns_remove_dhcp_lease

Remove a DHCP lease

Examples

- name: Add a reserved DHCP lease
  technitium_dns_add_reserved_lease:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Default"
    hardwareAddress: "00:11:22:33:44:55"
    ipAddress: "192.168.1.100"

- name: Add reserved lease with hostname and comments
  technitium_dns_add_reserved_lease:
    api_url: "http://localhost"
    api_token: "myapitoken"
    name: "Default"
    hardwareAddress: "00-AA-BB-CC-DD-EE"
    ipAddress: "192.168.1.200"
    hostName: "server1.local"
    comments: "Production web server"

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

Returned: always

Sample: {}

status

string

API response status

Returned: always

Sample: "ok"

changed

boolean

Whether the module made changes to add the reserved lease

Returned: always

Sample: true

failed

boolean

Whether the module failed to add the reserved lease

Returned: always

Sample: false

msg

string

Human-readable message describing the result

Returned: always

Sample: "Reserved lease for MAC '00:11:22:33:44:55' added to scope 'Default'."

Authors

  • Frank Muise (@effectivelywild)