From 45d472c8782f927980044eaba0d49421e91fc0c8 Mon Sep 17 00:00:00 2001
From: sarthurdev <965089+sarthurdev@users.noreply.github.com>
Date: Sat, 13 Jan 2024 00:28:01 +0100
Subject: dhcpv6: T3316: Move options to separate node and extend scopes

* Also migrate `address-range` to `range` tag node for consistency with dhcpv4 server syntax
---
 interface-definitions/include/dhcp/option-v6.xml.i | 110 ++++++++++++++++
 interface-definitions/service_dhcpv6-server.xml.in | 143 ++++-----------------
 2 files changed, 133 insertions(+), 120 deletions(-)
 create mode 100644 interface-definitions/include/dhcp/option-v6.xml.i

(limited to 'interface-definitions')

diff --git a/interface-definitions/include/dhcp/option-v6.xml.i b/interface-definitions/include/dhcp/option-v6.xml.i
new file mode 100644
index 000000000..1df0c3934
--- /dev/null
+++ b/interface-definitions/include/dhcp/option-v6.xml.i
@@ -0,0 +1,110 @@
+<!-- include start from dhcp/option-v6.xml.i -->
+<node name="option">
+  <properties>
+    <help>DHCPv6 option</help>
+  </properties>
+  <children>
+    #include <include/dhcp/captive-portal.xml.i>
+    #include <include/dhcp/domain-search.xml.i>
+    #include <include/name-server-ipv6.xml.i>
+    <leafNode name="nis-domain">
+      <properties>
+        <help>NIS domain name for client to use</help>
+        <constraint>
+          #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
+        </constraint>
+        <constraintErrorMessage>Invalid NIS domain name</constraintErrorMessage>
+      </properties>
+    </leafNode>
+    <leafNode name="nis-server">
+      <properties>
+        <help>IPv6 address of a NIS Server</help>
+        <valueHelp>
+          <format>ipv6</format>
+          <description>IPv6 address of NIS server</description>
+        </valueHelp>
+        <constraint>
+          <validator name="ipv6-address"/>
+        </constraint>
+        <multi/>
+      </properties>
+    </leafNode>
+    <leafNode name="nisplus-domain">
+      <properties>
+        <help>NIS+ domain name for client to use</help>
+        <constraint>
+          #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
+        </constraint>
+        <constraintErrorMessage>Invalid NIS+ domain name. May only contain letters, numbers and .-_</constraintErrorMessage>
+      </properties>
+    </leafNode>
+    <leafNode name="nisplus-server">
+      <properties>
+        <help>IPv6 address of a NIS+ Server</help>
+        <valueHelp>
+          <format>ipv6</format>
+          <description>IPv6 address of NIS+ server</description>
+        </valueHelp>
+        <constraint>
+          <validator name="ipv6-address"/>
+        </constraint>
+        <multi/>
+      </properties>
+    </leafNode>
+    <leafNode name="sip-server">
+      <properties>
+        <help>IPv6 address of SIP server</help>
+        <valueHelp>
+          <format>ipv6</format>
+          <description>IPv6 address of SIP server</description>
+        </valueHelp>
+        <valueHelp>
+          <format>hostname</format>
+          <description>FQDN of SIP server</description>
+        </valueHelp>
+        <constraint>
+          <validator name="ipv6-address"/>
+          <validator name="fqdn"/>
+        </constraint>
+        <multi/>
+      </properties>
+    </leafNode>
+    <leafNode name="sntp-server">
+      <properties>
+        <help>IPv6 address of an SNTP server for client to use</help>
+        <constraint>
+          <validator name="ipv6-address"/>
+        </constraint>
+        <multi/>
+      </properties>
+    </leafNode>
+    <node name="vendor-option">
+      <properties>
+        <help>Vendor Specific Options</help>
+      </properties>
+      <children>
+        <node name="cisco">
+          <properties>
+            <help>Cisco specific parameters</help>
+          </properties>
+          <children>
+            <leafNode name="tftp-server">
+              <properties>
+                <help>TFTP server name</help>
+                <valueHelp>
+                  <format>ipv6</format>
+                  <description>TFTP server IPv6 address</description>
+                </valueHelp>
+                <constraint>
+                  <validator name="ipv6-address"/>
+                </constraint>
+                <multi/>
+              </properties>
+            </leafNode>
+          </children>
+        </node>
+      </children>
+    </node>
+  </children>
+</node>
+<!-- include end -->
diff --git a/interface-definitions/service_dhcpv6-server.xml.in b/interface-definitions/service_dhcpv6-server.xml.in
index 6934ceeec..4c1a28016 100644
--- a/interface-definitions/service_dhcpv6-server.xml.in
+++ b/interface-definitions/service_dhcpv6-server.xml.in
@@ -89,11 +89,17 @@
                   </constraint>
                 </properties>
                 <children>
-                  <node name="address-range">
+                  #include <include/dhcp/option-v6.xml.i>
+                  <tagNode name="range">
                     <properties>
                       <help>Parameters setting ranges for assigning IPv6 addresses</help>
+                      <constraint>
+                        #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
+                      </constraint>
+                      <constraintErrorMessage>Invalid range name, may only be alphanumeric, dot and hyphen</constraintErrorMessage>
                     </properties>
                     <children>
+                      #include <include/dhcp/option-v6.xml.i>
                       <leafNode name="prefix">
                         <properties>
                           <help>IPv6 prefix defining range of addresses to assign</help>
@@ -104,10 +110,9 @@
                           <constraint>
                             <validator name="ipv6-prefix"/>
                           </constraint>
-                          <multi/>
                         </properties>
                       </leafNode>
-                      <tagNode name="start">
+                      <leafNode name="start">
                         <properties>
                           <help>First in range of consecutive IPv6 addresses to assign</help>
                           <valueHelp>
@@ -118,25 +123,21 @@
                             <validator name="ipv6-address"/>
                           </constraint>
                         </properties>
-                        <children>
-                          <leafNode name="stop">
-                            <properties>
-                              <help>Last in range of consecutive IPv6 addresses</help>
-                              <valueHelp>
-                                <format>ipv6</format>
-                                <description>IPv6 address</description>
-                              </valueHelp>
-                              <constraint>
-                                <validator name="ipv6-address"/>
-                              </constraint>
-                            </properties>
-                          </leafNode>
-                        </children>
-                      </tagNode>
+                      </leafNode>
+                      <leafNode name="stop">
+                        <properties>
+                          <help>Last in range of consecutive IPv6 addresses</help>
+                          <valueHelp>
+                            <format>ipv6</format>
+                            <description>IPv6 address</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv6-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
                     </children>
-                  </node>
-                  #include <include/dhcp/captive-portal.xml.i>
-                  #include <include/dhcp/domain-search.xml.i>
+                  </tagNode>
                   <node name="lease-time">
                     <properties>
                       <help>Parameters relating to the lease time</help>
@@ -180,51 +181,6 @@
                       </leafNode>
                     </children>
                   </node>
-                  #include <include/name-server-ipv6.xml.i>
-                  <leafNode name="nis-domain">
-                    <properties>
-                      <help>NIS domain name for client to use</help>
-                      <constraint>
-                        #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
-                      </constraint>
-                      <constraintErrorMessage>Invalid NIS domain name</constraintErrorMessage>
-                    </properties>
-                  </leafNode>
-                  <leafNode name="nis-server">
-                    <properties>
-                      <help>IPv6 address of a NIS Server</help>
-                      <valueHelp>
-                        <format>ipv6</format>
-                        <description>IPv6 address of NIS server</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="ipv6-address"/>
-                      </constraint>
-                      <multi/>
-                    </properties>
-                  </leafNode>
-                  <leafNode name="nisplus-domain">
-                    <properties>
-                      <help>NIS+ domain name for client to use</help>
-                      <constraint>
-                        #include <include/constraint/alpha-numeric-hyphen-underscore-dot.xml.i>
-                      </constraint>
-                      <constraintErrorMessage>Invalid NIS+ domain name. May only contain letters, numbers and .-_</constraintErrorMessage>
-                    </properties>
-                  </leafNode>
-                  <leafNode name="nisplus-server">
-                    <properties>
-                      <help>IPv6 address of a NIS+ Server</help>
-                      <valueHelp>
-                        <format>ipv6</format>
-                        <description>IPv6 address of NIS+ server</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="ipv6-address"/>
-                      </constraint>
-                      <multi/>
-                    </properties>
-                  </leafNode>
                   <node name="prefix-delegation">
                     <properties>
                       <help>Parameters relating to IPv6 prefix delegation</help>
@@ -272,33 +228,6 @@
                       </tagNode>
                     </children>
                   </node>
-                  <leafNode name="sip-server">
-                    <properties>
-                      <help>IPv6 address of SIP server</help>
-                      <valueHelp>
-                        <format>ipv6</format>
-                        <description>IPv6 address of SIP server</description>
-                      </valueHelp>
-                      <valueHelp>
-                        <format>hostname</format>
-                        <description>FQDN of SIP server</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="ipv6-address"/>
-                        <validator name="fqdn"/>
-                      </constraint>
-                      <multi/>
-                    </properties>
-                  </leafNode>
-                  <leafNode name="sntp-server">
-                    <properties>
-                      <help>IPv6 address of an SNTP server for client to use</help>
-                      <constraint>
-                        <validator name="ipv6-address"/>
-                      </constraint>
-                      <multi/>
-                    </properties>
-                  </leafNode>
                   <tagNode name="static-mapping">
                     <properties>
                       <help>Hostname for static mapping reservation</help>
@@ -308,6 +237,7 @@
                       <constraintErrorMessage>Invalid static mapping hostname</constraintErrorMessage>
                     </properties>
                     <children>
+                      #include <include/dhcp/option-v6.xml.i>
                       #include <include/generic-disable-node.xml.i>
                       #include <include/interface/mac.xml.i>
                       #include <include/interface/duid.xml.i>
@@ -349,33 +279,6 @@
                       </constraint>
                     </properties>
                   </leafNode>
-                  <node name="vendor-option">
-                    <properties>
-                      <help>Vendor Specific Options</help>
-                    </properties>
-                    <children>
-                      <node name="cisco">
-                        <properties>
-                          <help>Cisco specific parameters</help>
-                        </properties>
-                        <children>
-                          <leafNode name="tftp-server">
-                            <properties>
-                              <help>TFTP server name</help>
-                              <valueHelp>
-                                <format>ipv6</format>
-                                <description>TFTP server IPv6 address</description>
-                              </valueHelp>
-                              <constraint>
-                                <validator name="ipv6-address"/>
-                              </constraint>
-                              <multi/>
-                            </properties>
-                          </leafNode>
-                        </children>
-                      </node>
-                    </children>
-                  </node>
                 </children>
               </tagNode>
             </children>
-- 
cgit v1.2.3