VTYSH extensions. DHCP server and relay

Preliminary version.

02.08.2023

Changelog

02.08.2023 — Contents and Changelog pages have been added.

Debug / informational commands

** show dhcp ignore mac **
Show MAC addresses that will be ignored for DHCP requests. Command exists in enable mode.

** show dhcp nameservers **
Show configued DNS servers to be offered to clients. Command exists in enable mode.

** show dhcp gateways **
Show configured wateway list. Command exists in enable mode.

** show dhcp wins **
Show configured WINS list. Command exists in enable mode.

** show dhcp static assignment **
Show static assignments (pairs MAC-IP address) list. Command exists in enable mode.

** show dhcp static routes **
Show configured routes to be pushed to clients. Command exists in enable mode.

** show dhcp interface listen ** 
Show interface list where DHCP server is available. Command exists in enable mode.

** show dhcp leases **
Show current DHCP assignments. Command exists in enable mode.

Configuration commands

** start dhcp server **
Start built-in DHCP Server.

** no start dhcp server **
Stop built-in DHCP Server.

** start dhcp relay **
Start DHCP forwarder. DHCP requests will be forwarded to another DHCP server.

** no start dhcp relay **
Stop DHCP forwarder

** dhcp **
Enter DHCP server and relay configuration mode. Exists in configuration mode. All commands below are in DHCP mode.

** ignore requests from WORD **
Ignore DHCP requests From MAC address (e.g. 00:01:02:03:04:05).

** no ignore requests from WORD **
Remove MAC address (e.g. 00:01:02:03:04:05) from ignore list.

** gateway <A.B.C.D|X:X::X:X> **
Add IPv4 or IPv6 address to gateway list.

** no gateway <A.B.C.D|X:X::X:X> **
Remove IPv4 or IPv6 address from gateway list.

** nameserver <A.B.C.D|X:X::X:X> **
Add IPv4 or IPv6 address to nameserver list.

** no nameserver <A.B.C.D|X:X::X:X> **
Remove IPv4 or IPv6 address from nameserver list.

** wins <A.B.C.D|X:X::X:X> **
Add IPv4 or IPv6 address to WINS list.

** no wins <A.B.C.D|X:X::X:X> **
Remove IPv4 or IPv6 address from WINS list.

** assign <A.B.C.D|X:X::X:X> for WORD **
Offer static IPv4 or IPv6 address For MAC MAC-Address (e.g. 00:01:02:03:04:05). Add such record for further assigmnments.

** no assign <A.B.C.D|X:X::X:X> **
Remove IPv4 or IPv6 address from static assigmnment list.

** no static assign hw-address WORD **
Remove MAC-Address (e.g. 00:01:02:03:04:05) from static assigmnment list.

** push route <A.B.C.D/M|X:X::X:X/M> [via <A.B.C.D|X:X::X:X>] **
Add static route with IPv4 or IPv6 prefix and gateway to push list to clients.

** no push route <A.B.C.D/M|X:X::X:X/M> **
Remove static route from push list.

** lease time <default|max> (1-86400) **
Configure DHCP default and maximal lease time.

** no lease time <default|max> **
Reset DHCP Lease time (Default or Maximal) to defaults.

** relay add agent-id **
Add Agent ID to forwarding requests.

** no relay add agent-id **
Do not add Agent ID to forwarding requests.

** relay host <A.B.C.D|FQDN> **
Forward DHCP requests to host identified by IPv4 address or Fully Qualified Domain Name.

** no relay host **
Reset DHCP relay host. 

** relay interface outgoing IFNAME **
Use specified interface as outgoing for DHCP relayed requests (e.g. eth0) 

** no relay interface outgoing **
Reset settings for outgoing interface.

** relay interface incoming IFNAME **
Forward incoming DHCP requests on specified interface (e.g. eth0).

** no relay interface incoming IFNAME **
Reset incoming interface settings (e.g. eth0).

** <exit|quit|end> **
Exit current mode and down to previous mode Quit current mode and down to previous mode End current mode and down to previous mode.