From: Marcin Siodelski <marcin@isc.org>
Date: Tue, 17 Oct 2017 09:45:44 +0000 (+0200)
Subject: [5376] Documented how to override dhcp-server-identifier option.
X-Git-Tag: trac5266_base~3^2~3^2~1
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=673861c246c04d7ffdd88855c6e749c976d12d26;p=thirdparty%2Fkea.git

[5376] Documented how to override dhcp-server-identifier option.
---

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index 8b8db50dec..9996ae474d 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -1328,9 +1328,11 @@ This rather belong to the DDNS configuration
 <row><entry>dhcp-lease-time</entry><entry>51</entry><entry>uint32</entry><entry>false</entry><entry>true</entry></row>
 -->
 <row><entry>dhcp-option-overload</entry><entry>52</entry><entry>uint8</entry><entry>false</entry><entry>false</entry></row>
-<!-- Message Type, Server Identifier and Parameter Request List should not be configured by a user.
+<!-- Message Type  should not be configured by a user.
 <row><entry>dhcp-message-type</entry><entry>53</entry><entry>uint8</entry><entry>false</entry><entry>false</entry></row>
+-->
 <row><entry>dhcp-server-identifier</entry><entry>54</entry><entry>ipv4-address</entry><entry>false</entry><entry>true</entry></row>
+<!-- Parameter Request List should not be configured by a user.
 <row><entry>dhcp-parameter-request-list</entry><entry>55</entry><entry>uint8</entry><entry>true</entry><entry>true</entry></row>
 -->
 <row><entry>dhcp-message</entry><entry>56</entry><entry>string</entry><entry>false</entry><entry>false</entry></row>
@@ -3847,11 +3849,39 @@ i.e. it will assign increasing integer values starting from 1.</para>
         received. A single server instance will use multiple server identifiers
         if it is receiving queries on multiple interfaces.
       </para>
+
       <para>
-        Currently there is no mechanism to override the default server identifiers
-        by an administrator. In the future, the configuration mechanism will be used
-        to specify the custom server identifier.
+        It is possible to override default server identifier values by specifying
+        "dhcp-server-identifier" option. This option can be specified at any
+        configuration level, but it is recommended to only specify this option on
+        global, shared network or subnet level. Specifying this option on a class
+        or host reservation level will work only in cases when the specified
+        server identifier is an IP address assigned to one of the interfaces on
+        which the server is listening to DHCP queries. Otherwise, the server
+        will drop the messages with these server identifiers. The server will
+        accept messages including server identifiers specified on the global,
+        shared network and subnet level, even if they point to IP addresses not
+        assigned to any interfaces, on which the server is listening to the
+        DHCP queries.
       </para>
+
+      <para>
+        The following example demonstrates how to override server identifier for
+        a subnet:
+<screen>
+"subnet4": [
+    {
+        "subnet": "192.0.2.0/24",
+        "option-data": [
+            {
+                "name": "dhcp-server-identifier",
+                "data": "10.2.5.76"
+            }
+        ],
+        ...
+    }
+]</screen>
+</para>
     </section>
 
     <section id="dhcp4-subnet-selection">