Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated dhcp-server documentation for sagitta #1586

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 29 additions & 13 deletions docs/configuration/service/dhcp-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,28 +170,44 @@ Individual Client Subnet

Enable DHCP failover configuration for this address pool.

Failover
--------
High Availability
-----------------

VyOS provides High Availability support for DHCP server. DHCP High
Availability can act in two different modes:

* **Active-active**: both DHCP servers will respond to DHCP requests. If
``mode`` is not defined, this is the default behavior.

* **Active-passive**: only ``primary`` server will respond to DHCP requests.
If this server goes offline, then ``secondary`` server will take place.

DHCP High Availability must be configured explicitly by the following
statements on both servers:

.. cfgcmd:: set service dhcp-server high-availability mode [active-active
| active-passive]

VyOS provides support for DHCP failover. DHCP failover must be configured
explicitly by the following statements.
Define operation mode of High Availability feature. Default value if command
is not specified is `active-active`

.. cfgcmd:: set service dhcp-server failover source-address <address>
.. cfgcmd:: set service dhcp-server high-availability source-address <address>

Local IP `<address>` used when communicating to the failover peer.
Local IP `<address>` used when communicating to the HA peer.

.. cfgcmd:: set service dhcp-server failover remote <address>
.. cfgcmd:: set service dhcp-server high-availability remote <address>

Remote peer IP `<address>` of the second DHCP server in this failover
Remote peer IP `<address>` of the second DHCP server in this HA
cluster.

.. cfgcmd:: set service dhcp-server failover name <name>
.. cfgcmd:: set service dhcp-server high-availability name <name>

A generic `<name>` referencing this sync service.

.. note:: `<name>` must be identical on both sides!

.. cfgcmd:: set service dhcp-server failover status <primary | secondary>
.. cfgcmd:: set service dhcp-server high-availability status <primary
| secondary>

The primary and secondary statements determines whether the server is primary
or secondary.
Expand All @@ -200,12 +216,12 @@ explicitly by the following statements.
their lease tables in sync, they must be able to reach each other on TCP
port 647. If you have firewall rules in effect, adjust them accordingly.

.. hint:: The dialogue between failover partners is neither encrypted nor
.. hint:: The dialogue between HA partners is neither encrypted nor
authenticated. Since most DHCP servers exist within an organisation's own
secure Intranet, this would be an unnecessary overhead. However, if you
have DHCP failover peers whose communications traverse insecure networks,
have DHCP HA peers whose communications traverse insecure networks,
then we recommend that you consider the use of VPN tunneling between them
to ensure that the failover partnership is immune to disruption
to ensure that the HA partnership is immune to disruption
(accidental or otherwise) via third parties.

Static mappings
Expand Down