From 2d965ffea7b5fd2428d7f529ff98559c0213a444 Mon Sep 17 00:00:00 2001 From: Michael Steenbeek <42928941+MichaelDeciso@users.noreply.github.com> Date: Fri, 15 Mar 2019 14:52:11 +0100 Subject: [PATCH] Add section about DHCP relaying (#160) --- source/manual/dhcp.rst | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/source/manual/dhcp.rst b/source/manual/dhcp.rst index 56f9db9c..b58b84df 100644 --- a/source/manual/dhcp.rst +++ b/source/manual/dhcp.rst @@ -14,13 +14,13 @@ DHCPv4 settings can be found at :menuselection:`Services --> DHCPv4`. DHCPv6 set The DHCPv4 submenu further consists of: * An entry per interface of general settings, like a toggle to enable/disable DHCPv4 for this interface, DHCP range, DNS servers… -* **Relay**: DHCP requests can be "forwarded" to another server. This is called relaying. +* **Relay**: DHCP requests can be “forwarded” to a DHCP server on another interface. This is called relaying. * **Leases**: Shows all IP addresses that are handed out to clients (can be filtered to only show active and static leases). * **Log File**: Shows the log file of the DHCPv4 server. The DHCPv6 submenu further consists of: -* **Relay**: DHCP requests can be "forwarded" to another server. This is called relaying. +* **Relay**: DHCP requests can be “forwarded” to a DHCP server on another interface. This is called relaying. * **Leases**: Shows all IP addresses that are handed out to clients (can be filtered to only show active and static leases). ------------ @@ -33,11 +33,36 @@ the third group can also be another number, and there are also other ranges avai described in `RFC 1918 `_.) The LAN IP of the OPNsense device that serves DHCP to the LAN should fall in the same DHCP IP range. Typically, it gets -the address ending in .1 (so 192.168.1.1) in this example. +the address ending in .1 (so 192.168.1.1 in this example). To set the LAN IP, go to :menuselection:`Interfaces --> [LAN]`, set “IPv4 Configuration Type” to “Static”, and under “Static IPv4 configuration”, set “IPv4 address” to ``192.168.1.1`` and the subnet dropdown to “24”. Then click Save. -To set the DHCP settings, go to :menuselection:`Services --> DHCPv4 --> [LAN]`. Under “Gateway”, put ``192.168.1.1``. Under range, +To set the DHCP settings, go to :menuselection:`Services --> DHCPv4 --> [LAN]`. Under “Gateway”, put ``192.168.1.1``. Under range, put ``192.168.1.100`` as the start address and ``192.168.1.200`` as the end address. Then click Save. After saving, -click the “Apply Settings” button. \ No newline at end of file +click the “Apply Settings” button. + +------------- +DHCP relaying +------------- + +DHCP relaying is the forwarding of DHCP requests received on one interface to the DHCP server on another. DHCP +relaying is available for both DHCPv4 and DHCPv6. The DHCPv4 settings can be found at +:menuselection:`Services --> DHCPv4 --> Relay`. The DHCPv6 settings can be found at +:menuselection:`Services --> DHCPv6 --> Relay`. + +When setting up DHCP relaying (both DHCPv4 and DHCPv6 relaying have the same settings), the following options are +available: + ++-----------------------+----------------------------------------------------------------------------------------------+ +| Setting | Explanation | ++=======================+==============================================================================================+ +| Enable | | ++-----------------------+----------------------------------------------------------------------------------------------+ +| Interface(s) | Which interfaces to apply relaying to. Only interfaces with an IP can be selected. | ++-----------------------+----------------------------------------------------------------------------------------------+ +| Append circuit ID and | If this is checked, the DHCP relay will append the circuit ID (interface number) and the | +| agent ID to requests | agent ID to the DHCP request. | ++-----------------------+----------------------------------------------------------------------------------------------+ +| Destination servers | A comma separated list of IPs to which the requests should be forwarded. | ++-----------------------+----------------------------------------------------------------------------------------------+