Try SpotterManage Windows Server DHCP Leases
Authors: Joe Zollo (@joezollo)
Install with ansible-galaxy collection install community.windows:==2.2.0
collections:
- name: community.windows
version: 2.2.0Manage Windows Server DHCP Leases (IPv4 Only)
Adds, Removes and Modifies DHCP Leases and Reservations
Task should be delegated to a Windows DHCP Server
- name: Ensure DHCP reservation exists
community.windows.win_dhcp_lease:
type: reservation
ip: 192.168.100.205
scope_id: 192.168.100.0
mac: 00:B1:8A:D1:5A:1F
dns_hostname: "{{ ansible_inventory }}"
description: Testing Server
- name: Ensure DHCP lease or reservation does not exist
community.windows.win_dhcp_lease:
mac: 00:B1:8A:D1:5A:1F
state: absent
- name: Ensure DHCP lease or reservation does not exist
community.windows.win_dhcp_lease:
ip: 192.168.100.205
state: absent
- name: Convert DHCP lease to reservation & update description
community.windows.win_dhcp_lease:
type: reservation
ip: 192.168.100.205
description: Testing Server
- name: Convert DHCP reservation to lease
community.windows.win_dhcp_lease:
type: lease
ip: 192.168.100.205
ip:
description:
- The IPv4 address of the client server/computer.
- This is a required parameter, if l(mac) is not set.
- Can be used to identify an existing lease/reservation, instead of l(mac).
required: false
type: str
mac:
description:
- Specifies the client identifier to be set on the IPv4 address.
- This is a required parameter, if l(ip) is not set.
- Windows clients use the MAC address as the client ID.
- Linux and other operating systems can use other types of identifiers.
- Can be used to identify an existing lease/reservation, instead of l(ip).
type: str
type:
choices:
- reservation
- lease
default: reservation
description:
- The type of DHCP address.
- Leases expire as defined by l(duration).
- When l(duration) is not specified, the server default is used.
- Reservations are permanent.
type: str
state:
choices:
- present
- absent
default: present
description:
- Specifies the desired state of the DHCP lease or reservation.
type: str
duration:
description:
- Specifies the duration of the DHCP lease in days.
- The duration value only applies to l(type=lease).
- Defaults to the duration specified by the DHCP server configuration.
- Only applicable to l(type=lease).
type: int
scope_id:
description:
- Specifies the scope identifier as defined by the DHCP server.
- This is a required parameter, if l(state=present) and the reservation or lease doesn't
already exist. Not required if updating an existing lease or reservation.
type: str
description:
description:
- Specifies the description for reservation being created.
- Only applicable to l(type=reservation).
type: str
dns_regtype:
choices:
- aptr
- a
- noreg
default: aptr
description:
- Indicates the type of DNS record to be registered by the DHCP. server service for
this lease.
- l(a) results in an A record being registered.
- l(aptr) results in both A and PTR records to be registered.
- l(noreg) results in no DNS records being registered.
type: str
dns_hostname:
description:
- Specifies the DNS hostname of the client for which the IP address lease is to be
added.
type: str
reservation_name:
description:
- Specifies the name of the reservation being created.
- Only applicable to l(type=reservation).
type: str
lease:
description: New/Updated DHCP object parameters
returned: When l(state=present)
sample:
address_state: InactiveReservation
client_id: 0a-0b-0c-04-05-aa
description: Really Fancy
ip_address: 172.16.98.230
name: null
scope_id: 172.16.98.0
type: dict