opn_list_dhcp_leases
Retrieve current DHCPv4 leases from the ISC DHCP server, including IP address, MAC address, and hostname for each active lease.
Instructions
List current DHCPv4 leases from the ISC DHCP server (legacy).
Use this when the OPNsense instance uses the ISC DHCP plugin (os-isc-dhcp). ISC DHCP is legacy and being phased out — most 26.x instances use dnsmasq or Kea. Use opn_scan_config first to check which DHCP backend is active. Returns: dict with DHCP lease entries including address, mac, and hostname fields.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||