List DHCP leases
list_dhcp_leasesList current DHCP leases from FortiGate appliances to verify active client IP assignments; filter by VDOM, interface, or hostname for targeted diagnostics.
Instructions
List current DHCP leases issued by the appliance.
Read filtered_out before concluding anything from a short list. Both
filters here drop rows without saying so otherwise, and an interface
name with a typo produces an empty list that looks exactly like an
appliance handing out no leases.
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": "list_dhcp_leases"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vdom | No | Virtual domain to read. Defaults to the one configured for this target. The `vdom` field in the response names the one actually read. | |
| limit | No | Maximum rows to return. Defaults to 200, capped at 1000. | |
| offset | No | Index to start from, for paging through a large table. | |
| target | No | Which FortiGate to query. Optional when only one is configured. | |
| interface | No | Keep only leases issued on this interface, matched exactly. | |
| hostname_contains | No | Case-insensitive substring filter on the hostname, falling back to the vendor class identifier when the client sent no name. A lease with neither is dropped by this filter. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||