From 0c7dcf9f450e81a1ee60aefd7aca20f10421147c Mon Sep 17 00:00:00 2001
From: Ginko <152240782+Giggum@users.noreply.github.com>
Date: Sat, 23 Mar 2024 12:35:33 -0400
Subject: T4389: extend DHCP server documentation on vendor options (#1339)
* T4389 added to dhcp-server documentation
* Correction IP address specifed in examples in previous PR
---
docs/configuration/service/dhcp-server.rst | 38 ++++++++++++++++++++++++++++--
1 file changed, 36 insertions(+), 2 deletions(-)
diff --git a/docs/configuration/service/dhcp-server.rst b/docs/configuration/service/dhcp-server.rst
index 6813d2c0..43b5d20c 100644
--- a/docs/configuration/service/dhcp-server.rst
+++ b/docs/configuration/service/dhcp-server.rst
@@ -49,10 +49,26 @@ Configuration
Inform client that the DNS server can be found at `
`.
This is the configuration parameter for the entire shared network definition.
- All subnets will inherit this configuration item if not specified locally.
-
+ All subnets will inherit this configuration item if not specified locally.
Multiple DNS servers can be defined.
+.. cfgcmd:: set service dhcp-server shared-network-name option
+ vendor-option
+
+ This configuration parameter lets you specify a vendor-option for the
+ entire shared network definition. All subnets will inherit this
+ configuration item if not specified locally. An example for Ubiquiti is
+ shown below:
+
+**Example:**
+
+Pass address of Unifi controller at ``172.16.100.1`` to all clients of ``NET1``
+
+.. code-block:: none
+
+ set service dhcp-server shared-network-name 'NET1' option vendor-option
+ ubiquiti '172.16.100.1'
+
.. cfgcmd:: set service dhcp-server listen-address
This configuration parameter lets the DHCP server to listen for DHCP
@@ -132,6 +148,24 @@ Individual Client Subnet
request where no full FQDN is passed. This option can be given multiple times
if you need multiple search domains (DHCP Option 119).
+.. cfgcmd:: set service dhcp-server shared-network-name subnet
+ option vendor-option
+
+ This configuration parameter lets you specify a vendor-option for the
+ subnet specified within the shared network definition. An example for
+ Ubiquiti is shown below:
+
+**Example:**
+
+Create ``172.18.201.0/24`` as a subnet within ``NET1`` and pass address of
+Unifi controller at ``172.16.100.1`` to clients of that subnet.
+
+.. code-block:: none
+
+ set service dhcp-server shared-network-name 'NET1' subnet
+ '172.18.201.0/24' option vendor-option ubiquiti '172.16.100.1'
+
+
Failover
--------
--
cgit v1.2.3