diff options
| author | Nicolas Fort <nicolasfort1988@gmail.com> | 2023-02-06 12:08:32 -0300 |
|---|---|---|
| committer | Nicolas Fort <nicolasfort1988@gmail.com> | 2023-02-06 12:08:32 -0300 |
| commit | 86422eef63496e7bf659bbccf81014bc424961e9 (patch) | |
| tree | 5085c74c0157e81a979d9e3f693dfdbc321c994b /docs/configuration/service/dhcp-relay.rst | |
| parent | d39ce49e2f54b99433c5c661fc1cb6efbbe6c930 (diff) | |
| download | vyos-documentation-86422eef63496e7bf659bbccf81014bc424961e9.tar.gz vyos-documentation-86422eef63496e7bf659bbccf81014bc424961e9.zip | |
T2408: dhcp relay interface: add docs for new listen-interface and upstream-interface commands
Diffstat (limited to 'docs/configuration/service/dhcp-relay.rst')
| -rw-r--r-- | docs/configuration/service/dhcp-relay.rst | 33 |
1 files changed, 29 insertions, 4 deletions
diff --git a/docs/configuration/service/dhcp-relay.rst b/docs/configuration/service/dhcp-relay.rst index a93c1046..43abf254 100644 --- a/docs/configuration/service/dhcp-relay.rst +++ b/docs/configuration/service/dhcp-relay.rst @@ -20,8 +20,20 @@ Configuration .. cfgcmd:: set service dhcp-relay interface <interface> - Interfaces that participate in the DHCP relay process, including the uplink - to the DHCP server. + Interfaces that participate in the DHCP relay process. If this command is + used, at least two entries of it are required: one for the interface that + captures the dhcp-requests, and one for the interface to forward such + requests. A warning message will be shown if this command is used, since + new implementations should use ``listen-interface`` and + ``upstream-interface``. + +.. cfgcmd:: set service dhcp-relay listen-interface <interface> + + Interface for DHCP Relay Agent to listen for requests. + +.. cfgcmd:: set service dhcp-relay upstream-interface <interface> + + Interface for DHCP Relay Agent to forward requests out. .. cfgcmd:: set service dhcp-relay server <server> @@ -70,8 +82,8 @@ Example * Listen for DHCP requests on interface ``eth1``. * 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 on ``eth2``. +* Router receives DHCP client requests on ``eth1`` and relays them to the + server at 10.0.1.4 on ``eth2``. .. figure:: /_static/images/service_dhcp-relay01.png :scale: 80 % @@ -84,6 +96,19 @@ The generated configuration will look like: .. code-block:: none show service dhcp-relay + listen-interface eth1 + upstrem-interface eth2 + server 10.0.1.4 + relay-options { + relay-agents-packets discard + } + +Also, for backwards compatibility this configuration, which uses generic +interface definition, is still valid: + +.. code-block:: none + + show service dhcp-relay interface eth1 interface eth2 server 10.0.1.4 |