releaseSiteDeviceDhcpLeases
POST https://{{host}}/api/v1/sites/:site_id/devices/:device_id/release_dhcp_leases
Releases active leases from DHCP server.
The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.
Notes:
1. valid combinations for Junos: [portid, macs+network], for SSR: [portid, macs+network, portid+macs, portid+network, network]
2. if network or portid is specified and macs is empty, it means all clients under network or portid
Parameters
| Name | Type | Description |
|---|---|---|
network | string | (Optional) The network for the leases IPs to be released |
port_id | string | (Optional) The nework interface on which to release the current DHCP release |
macs | list | A list of client macs to be released |
subscribe to Device Command outputs
{
"subscribe": "/sites/:site_id/devices/:device_id/cmd"
}
Request Body
{"port_id"=>"ge-0/0/1", "macs"=>["90ec77aabbcc", "90ec77aabbdd"], "network"=>"guest"}
RESPONSES
status: OK
{"session":"session_id"}