search_dhcp_leases
Search and filter DHCP leases by state, hostname, MAC address, or interface to locate active, expired, or released client assignments and troubleshoot network addressing.
Instructions
Search DHCP leases with advanced filtering
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search_dhcp_leases"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| state | No | Filter by lease state. Values: 'active' (current leases), 'expired' (past leases), 'released' (client-released). Default: 'active' | active |
| sort_by | No | Field to sort by (starts, ends, hostname, ip, mac) | starts |
| hostname | No | Filter by hostname (supports partial matching) | |
| interface | No | Filter by interface | |
| page_size | No | Number of results per page | |
| mac_address | No | Filter by specific MAC address | |
| search_term | No | General search (hostname, IP, MAC) — client-side filter applied after pagination |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||