summaryrefslogtreecommitdiff
path: root/docs/configuration/service/dhcp-relay.rst
diff options
context:
space:
mode:
authorThomas Jensen <thomas@uctrl.net>2022-03-07 20:09:25 +0100
committerGitHub <noreply@github.com>2022-03-07 20:09:25 +0100
commita98cb8bec90c1568d71af91eb4e373e2bcccd8aa (patch)
treeccef65dc9eb2addcaef842f76951f8e2d5784424 /docs/configuration/service/dhcp-relay.rst
parenta6d5adfc57cf20868747cfd6a21be8b15d010247 (diff)
downloadvyos-documentation-a98cb8bec90c1568d71af91eb4e373e2bcccd8aa.tar.gz
vyos-documentation-a98cb8bec90c1568d71af91eb4e373e2bcccd8aa.zip
Update dhcp-relay.rst (#729)
* Update dhcp-relay.rst Include info that all participating interfaces must be defined; https://forum.vyos.io/t/dhcp-relay-uplink-interface/8542 * Update dhcp-relay.rst Fix lines too long.
Diffstat (limited to 'docs/configuration/service/dhcp-relay.rst')
-rw-r--r--docs/configuration/service/dhcp-relay.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/configuration/service/dhcp-relay.rst b/docs/configuration/service/dhcp-relay.rst
index c0394dff..5ce22edb 100644
--- a/docs/configuration/service/dhcp-relay.rst
+++ b/docs/configuration/service/dhcp-relay.rst
@@ -8,7 +8,8 @@ If you want your router to forward DHCP requests to an external DHCP server
you can configure the system to act as a DHCP relay agent. The DHCP relay
agent works with IPv4 and IPv6 addresses.
-All interfaces used for the DHCP relay must be configured.
+All interfaces used for the DHCP relay must be configured. This includes the
+uplink to the DHCP server.
**********
IPv4 relay
@@ -19,7 +20,8 @@ Configuration
.. cfgcmd:: set service dhcp-relay interface <interface>
- Enable the DHCP relay service on the given interface.
+ Interfaces that participate in the DHCP relay process, including the uplink
+ to the DHCP server.
.. cfgcmd:: set service dhcp-relay server <server>
@@ -67,9 +69,9 @@ Example
=======
* Listen for DHCP requests on interface ``eth1``.
-* DHCP server is located at IPv4 address 10.0.1.4.
+* DHCP server is located at IPv4 address 10.0.1.4 on ``eth2``.
* Router receives DHCP client requests on ``eth1`` and relays them to the server
- at 10.0.1.4.
+ at 10.0.1.4 on ``eth2``.
.. figure:: /_static/images/service_dhcp-relay01.png
:scale: 80 %
@@ -83,6 +85,7 @@ The generated configuration will look like:
show service dhcp-relay
interface eth1
+ interface eth2
server 10.0.1.4
relay-options {
relay-agents-packets discard