dhcp: dhcpv6: T3316: Update documentation for inclusion of `subnet-id`

4 files changed, 21 insertions, 1 deletions

diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf
index a3a7f27e..20c8dd10 100644
--- a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf
+++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/dhcp-server.conf
@@ -10,4 +10,5 @@ set service dhcp-server listen-address '172.16.0.1'
 set service dhcp-server shared-network-name DHCPTun100 authoritative
 set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 option default-router '192.168.0.254'
 set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 range 0 start '192.168.0.30'
-set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 range 0 stop '192.168.0.30'
\ No newline at end of file
+set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 range 0 stop '192.168.0.30'
+set service dhcp-server shared-network-name DHCPTun100 subnet 192.168.0.0/24 subnet-id '1'
\ No newline at end of file
diff --git a/docs/configuration/service/dhcp-server.rst b/docs/configuration/service/dhcp-server.rst
index e20fc251..c51a0aff 100644
--- a/docs/configuration/service/dhcp-server.rst
+++ b/docs/configuration/service/dhcp-server.rst
@@ -71,6 +71,12 @@ Individual Client Subnet
    network.
 
 .. cfgcmd:: set service dhcp-server shared-network-name <name> subnet <subnet>
+   subnet-id <id>
+
+   This configuration parameter is required and must be unique to each subnet.
+   It is required to map subnets to lease file entries.
+
+.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet <subnet>
    option default-router <address>
 
    This is a configuration parameter for the `<subnet>`, saying that as part of
@@ -197,6 +203,7 @@ inside the subnet definition but can be outside of the range statement.
 
 .. code-block:: none
 
+  set service dhcp-server shared-network-name 'NET1' subnet 192.168.1.0/24 subnet-id 1
   set service dhcp-server shared-network-name 'NET1' subnet 192.168.1.0/24 static-mapping client1 ip-address 192.168.1.100
   set service dhcp-server shared-network-name 'NET1' subnet 192.168.1.0/24 static-mapping client1 mac-address aa:bb:11:22:33:00
 
@@ -210,6 +217,7 @@ The configuration will look as follows:
            ip-address 192.168.1.100
            mac-address aa:bb:11:22:33:00
        }
+       subnet-id 1
    }
 
 Options
@@ -377,6 +385,7 @@ Common configuration, valid for both primary and secondary node.
   set service dhcp-server shared-network-name NET-VYOS subnet 192.0.2.0/24 option domain-name 'vyos.net'
   set service dhcp-server shared-network-name NET-VYOS subnet 192.0.2.0/24 range 0 start '192.0.2.10'
   set service dhcp-server shared-network-name NET-VYOS subnet 192.0.2.0/24 range 0 stop '192.0.2.250'
+  set service dhcp-server shared-network-name NET-VYOS subnet 192.0.2.0/24 subnet-id '1'
 
 
 **Primary**
@@ -505,6 +514,12 @@ Configuration
    Clients receiving advertise messages from multiple servers choose the server
    with the highest preference value. The range for this value is ``0...255``.
 
+.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet <subnet>
+   subnet-id <id>
+
+   This configuration parameter is required and must be unique to each subnet.
+   It is required to map subnets to lease file entries.
+
 .. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet
    <prefix> lease-time {default | maximum | minimum}
 
@@ -581,6 +596,7 @@ server. The following example describes a common scenario.
 
   set service dhcpv6-server shared-network-name 'NET1' subnet 2001:db8::/64 address-range start 2001:db8::100 stop 2001:db8::199
   set service dhcpv6-server shared-network-name 'NET1' subnet 2001:db8::/64 name-server 2001:db8::ffff
+  set service dhcpv6-server shared-network-name 'NET1' subnet 2001:db8::/64 subnet-id 1
 
 The configuration will look as follows:
 
@@ -595,6 +611,7 @@ The configuration will look as follows:
                 }
              }
              name-server 2001:db8::ffff
+             subnet-id 1
           }
       }
 
diff --git a/docs/installation/install.rst b/docs/installation/install.rst
index bf0f11fe..17bccfbd 100644
--- a/docs/installation/install.rst
+++ b/docs/installation/install.rst
@@ -467,6 +467,7 @@ In this example we configured an existent VyOS as the DHCP server:
                start 192.168.1.70
                stop 192.168.1.100
            }
+           subnet-id 1
        }
    }
 
diff --git a/docs/quick-start.rst b/docs/quick-start.rst
index 44ff99ff..05e278ad 100644
--- a/docs/quick-start.rst
+++ b/docs/quick-start.rst
@@ -99,6 +99,7 @@ DNS server.
   set service dhcp-server shared-network-name LAN subnet 192.168.0.0/24 lease '86400'
   set service dhcp-server shared-network-name LAN subnet 192.168.0.0/24 range 0 start '192.168.0.9'
   set service dhcp-server shared-network-name LAN subnet 192.168.0.0/24 range 0 stop '192.168.0.254'
+  set service dhcp-server shared-network-name LAN subnet 192.168.0.0/24 subnet-id '1'
 
   set service dns forwarding cache-size '0'
   set service dns forwarding listen-address '192.168.0.1'