fergalmoran/DnsServer
1
0
Fork 0
mirror of https://github.com/fergalmoran/DnsServer.git synced 2026-03-16 18:39:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated api docs.

Browse Source
This commit is contained in:
Shreyas Zare
2021-09-18 18:05:32 +05:30
parent 81e712d00d
commit a2b9fb82ec
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
APIDOCS.md
View File

@@ -2875,6 +2875,9 @@ RESPONSE:
"leaseTimeHours": 0,
"leaseTimeMinutes": 0,
"offerDelayTime": 0,
"pingCheckEnabled": false,
"pingCheckTimeout": 1000,
"pingCheckRetries": 2,
"domainName": "local",
"dnsTtl": 900,
"serverAddress": "192.168.1.1",
@@ -2942,6 +2945,9 @@ WHERE:
- `leaseTimeHours` (optional): The lease time in number of hours.
- `leaseTimeMinutes` (optional): The lease time in number of minutes.
- `offerDelayTime` (optional): The time duration in milli seconds that the DHCP server delays sending an DHCPOFFER message.
- `pingCheckEnabled` (optional): Set this option to `true` to allow the DHCP server to find out if an IP address is already in use to prevent IP address conflict when some of the devices on the network have manually configured IP addresses.
- `pingCheckTimeout` (optional): The timeout interval to wait for an ping reply.
- `pingCheckRetries` (optional): The maximum number of ping requests to try.
- `domainName` (optional): The domain name to be used by this network. The DHCP server automatically adds forward and reverse DNS entries for each IP address allocations when domain name is configured.
- `dnsTtl` (optional): The TTL value used for forward and reverse DNS records.
- `serverAddress` (optional): The bootstrap TFTP server IP address to be used by the clients. If not specified, the DHCP server's IP address is used.
@@ -3023,6 +3029,26 @@ RESPONSE:
}
```
### Remove DHCP Lease
Removes a dynamic or reserved lease allocation. This API must be used carefully to make sure that there is no IP address conflict caused by removing a lease.
URL:
`http://localhost:5380/api/removeDhcpLease?token=x&name=Default&hardwareAddress=00:00:00:00:00:00`
WHERE:
- `token`: The session token generated by the `login` call.
- `name`: The name of the DHCP scope.
- `hardwareAddress`: The MAC address of the device bearing the dynamic/reserved lease.
RESPONSE:
```
{
"response": {},
"status": "ok"
}
```
### Convert To Reserved Lease
Converts a dynamic lease to reserved lease.