list_dhcp_leases
list_dhcp_leases
Section titled “list_dhcp_leases”List static DHCP reservations on the controller.
Side effects: None (read-only).
UniFi stores fixed leases on the user object with
use_fixedip=true. This returns just those entries with _id,
mac, name, hostname, fixed_ip, and network_id.
Example
Section titled “Example”list_dhcp_leases(controller="default")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
controller | string | no | ”default” | Name of the UniFi controller to target. Defaults to "default". |