Merge pull request #2729 from c-po/rename-T5474

T5474: establish common file name pattern for XML conf mode commands

1 files changed, 456 insertions, 0 deletions

diff --git a/interface-definitions/service_dhcp-server.xml.in b/interface-definitions/service_dhcp-server.xml.in
new file mode 100644
index 000000000..e35d845f1
--- /dev/null
+++ b/interface-definitions/service_dhcp-server.xml.in
@@ -0,0 +1,456 @@
+<?xml version="1.0"?>
+<!-- DHCP server configuration -->
+<interfaceDefinition>
+  <node name="service">
+    <children>
+      <node name="dhcp-server" owner="${vyos_conf_scripts_dir}/service_dhcp-server.py">
+        <properties>
+          <help>Dynamic Host Configuration Protocol (DHCP) for DHCP server</help>
+          <priority>911</priority>
+        </properties>
+        <children>
+          #include <include/generic-disable-node.xml.i>
+          <leafNode name="dynamic-dns-update">
+            <properties>
+              <help>Dynamically update Domain Name System (RFC4702)</help>
+              <valueless/>
+            </properties>
+          </leafNode>
+          <node name="failover">
+            <properties>
+              <help>DHCP failover configuration</help>
+            </properties>
+            <children>
+              #include <include/source-address-ipv4.xml.i>
+              <leafNode name="remote">
+                <properties>
+                  <help>IPv4 remote address used for connectio</help>
+                  <valueHelp>
+                    <format>ipv4</format>
+                    <description>IPv4 address of failover peer</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ipv4-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="name">
+                <properties>
+                  <help>Peer name used to identify connection</help>
+                  <constraint>
+                    <regex>[-_a-zA-Z0-9.]+</regex>
+                  </constraint>
+                  <constraintErrorMessage>Invalid failover peer name. May only contain letters, numbers and .-_</constraintErrorMessage>
+                </properties>
+              </leafNode>
+              <leafNode name="status">
+                <properties>
+                  <help>Failover hierarchy</help>
+                  <completionHelp>
+                    <list>primary secondary</list>
+                  </completionHelp>
+                  <valueHelp>
+                    <format>primary</format>
+                    <description>Configure this server to be the primary node</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>secondary</format>
+                    <description>Configure this server to be the secondary node</description>
+                  </valueHelp>
+                  <constraint>
+                    <regex>(primary|secondary)</regex>
+                  </constraint>
+                  <constraintErrorMessage>Invalid DHCP failover peer status</constraintErrorMessage>
+                </properties>
+              </leafNode>
+              #include <include/pki/ca-certificate.xml.i>
+              #include <include/pki/certificate.xml.i>
+            </children>
+          </node>
+          <leafNode name="hostfile-update">
+            <properties>
+              <help>Updating /etc/hosts file (per client lease)</help>
+              <valueless/>
+            </properties>
+          </leafNode>
+          #include <include/listen-address-ipv4.xml.i>
+          <tagNode name="shared-network-name">
+            <properties>
+              <help>Name of DHCP shared network</help>
+              <constraint>
+                <regex>[-_a-zA-Z0-9.]+</regex>
+              </constraint>
+              <constraintErrorMessage>Invalid shared network name. May only contain letters, numbers and .-_</constraintErrorMessage>
+            </properties>
+            <children>
+              <leafNode name="authoritative">
+                <properties>
+                  <help>Option to make DHCP server authoritative for this physical network</help>
+                  <valueless/>
+                </properties>
+              </leafNode>
+              #include <include/dhcp/domain-name.xml.i>
+              #include <include/dhcp/domain-search.xml.i>
+              #include <include/dhcp/ntp-server.xml.i>
+              #include <include/generic-description.xml.i>
+              #include <include/generic-disable-node.xml.i>
+              #include <include/name-server-ipv4.xml.i>
+              <tagNode name="subnet">
+                <properties>
+                  <help>DHCP subnet for shared network</help>
+                  <valueHelp>
+                    <format>ipv4net</format>
+                    <description>IPv4 address and prefix length</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ipv4-prefix"/>
+                  </constraint>
+                  <constraintErrorMessage>Invalid IPv4 subnet definition</constraintErrorMessage>
+                </properties>
+                <children>
+                  <leafNode name="bootfile-name">
+                    <properties>
+                      <help>Bootstrap file name</help>
+                      <constraint>
+                        <regex>[[:ascii:]]{1,253}</regex>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="bootfile-server">
+                    <properties>
+                      <help>Server from which the initial boot file is to be loaded</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>Bootfile server IPv4 address</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>hostname</format>
+                        <description>Bootfile server FQDN</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                        <validator name="fqdn"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="bootfile-size">
+                    <properties>
+                      <help>Bootstrap file size</help>
+                      <valueHelp>
+                        <format>u32:1-16</format>
+                        <description>Bootstrap file size in 512 byte blocks</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-16"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  #include <include/dhcp/captive-portal.xml.i>
+                  <leafNode name="client-prefix-length">
+                    <properties>
+                      <help>Specifies the clients subnet mask as per RFC 950. If unset, subnet declaration is used.</help>
+                      <valueHelp>
+                        <format>u32:0-32</format>
+                        <description>DHCP client prefix length must be 0 to 32</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 0-32"/>
+                      </constraint>
+                      <constraintErrorMessage>DHCP client prefix length must be 0 to 32</constraintErrorMessage>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="default-router">
+                    <properties>
+                      <help>IP address of default router</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>Default router IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  #include <include/dhcp/domain-name.xml.i>
+                  #include <include/dhcp/domain-search.xml.i>
+                  #include <include/generic-description.xml.i>
+                  #include <include/name-server-ipv4.xml.i>
+                  <leafNode name="exclude">
+                    <properties>
+                      <help>IP address to exclude from DHCP lease range</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>IPv4 address to exclude from lease range</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="ip-forwarding">
+                    <properties>
+                      <help>Enable IP forwarding on client</help>
+                      <valueless/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="lease">
+                    <properties>
+                      <help>Lease timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32</format>
+                        <description>DHCP lease time in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 0-4294967295"/>
+                      </constraint>
+                      <constraintErrorMessage>DHCP lease time must be between 0 and 4294967295 (49 days)</constraintErrorMessage>
+                    </properties>
+                    <defaultValue>86400</defaultValue>
+                  </leafNode>
+                  #include <include/dhcp/ntp-server.xml.i>
+                  <leafNode name="pop-server">
+                    <properties>
+                      <help>IP address of POP3 server</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>POP3 server IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="server-identifier">
+                    <properties>
+                      <help>Address for DHCP server identifier</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>DHCP server identifier IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="smtp-server">
+                    <properties>
+                      <help>IP address of SMTP server</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>SMTP server IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <tagNode name="range">
+                    <properties>
+                      <help>DHCP lease range</help>
+                      <constraint>
+                        <regex>[-_a-zA-Z0-9.]+</regex>
+                      </constraint>
+                      <constraintErrorMessage>Invalid range name, may only be alphanumeric, dot and hyphen</constraintErrorMessage>
+                    </properties>
+                    <children>
+                      <leafNode name="start">
+                        <properties>
+                          <help>First IP address for DHCP lease range</help>
+                          <valueHelp>
+                            <format>ipv4</format>
+                            <description>IPv4 start address of pool</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv4-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="stop">
+                        <properties>
+                          <help>Last IP address for DHCP lease range</help>
+                          <valueHelp>
+                            <format>ipv4</format>
+                            <description>IPv4 end address of pool</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv4-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </tagNode>
+                  <tagNode name="static-mapping">
+                    <properties>
+                      <help>Hostname for static mapping reservation</help>
+                      <constraint>
+                        <validator name="fqdn"/>
+                      </constraint>
+                      <constraintErrorMessage>Invalid static mapping hostname</constraintErrorMessage>
+                    </properties>
+                    <children>
+                      #include <include/generic-disable-node.xml.i>
+                      <leafNode name="ip-address">
+                        <properties>
+                          <help>Fixed IP address of static mapping</help>
+                          <valueHelp>
+                            <format>ipv4</format>
+                            <description>IPv4 address used in static mapping</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv4-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                      #include <include/interface/mac.xml.i>
+                      #include <include/interface/duid.xml.i>
+                    </children>
+                  </tagNode>
+                  <tagNode name="static-route">
+                    <properties>
+                      <help>Classless static route destination subnet</help>
+                      <valueHelp>
+                        <format>ipv4net</format>
+                        <description>IPv4 address and prefix length</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-prefix"/>
+                      </constraint>
+                    </properties>
+                    <children>
+                      <leafNode name="next-hop">
+                        <properties>
+                          <help>IP address of router to be used to reach the destination subnet</help>
+                          <valueHelp>
+                            <format>ipv4</format>
+                            <description>IPv4 address of router</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ip-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </tagNode >
+                  <leafNode name="ipv6-only-preferred">
+                    <properties>
+                      <help>Disable IPv4 on IPv6 only hosts (RFC 8925)</help>
+                      <valueHelp>
+                        <format>u32</format>
+                        <description>Seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 0-4294967295"/>
+                      </constraint>
+                      <constraintErrorMessage>Seconds must be between 0 and 4294967295 (49 days)</constraintErrorMessage>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="tftp-server-name">
+                    <properties>
+                      <help>TFTP server name</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>TFTP server IPv4 address</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>hostname</format>
+                        <description>TFTP server FQDN</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                        <validator name="fqdn"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="time-offset">
+                    <properties>
+                      <help>Client subnet offset in seconds from Coordinated Universal Time (UTC)</help>
+                      <valueHelp>
+                        <format>[-]N</format>
+                        <description>Time offset (number, may be negative)</description>
+                      </valueHelp>
+                      <constraint>
+                        <regex>-?[0-9]+</regex>
+                      </constraint>
+                      <constraintErrorMessage>Invalid time offset value</constraintErrorMessage>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="time-server">
+                    <properties>
+                      <help>IP address of time server</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>Time server IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="time-zone">
+                    <properties>
+                      <help>Time zone to send to clients. Uses RFC4833 options 100 and 101</help>
+                      <completionHelp>
+                        <script>timedatectl list-timezones</script>
+                      </completionHelp>
+                      <constraint>
+                        <validator name="timezone" argument="--validate"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <node name="vendor-option">
+                    <properties>
+                      <help>Vendor Specific Options</help>
+                    </properties>
+                    <children>
+                      <node name="ubiquiti">
+                        <properties>
+                          <help>Ubiquiti specific parameters</help>
+                        </properties>
+                        <children>
+                          <leafNode name="unifi-controller">
+                            <properties>
+                              <help>Address of UniFi controller</help>
+                              <valueHelp>
+                                <format>ipv4</format>
+                                <description>IP address of UniFi controller</description>
+                              </valueHelp>
+                              <constraint>
+                                <validator name="ipv4-address"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                        </children>
+                      </node>
+                    </children>
+                  </node>
+                  <leafNode name="wins-server">
+                    <properties>
+                      <help>IP address for Windows Internet Name Service (WINS) server</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>WINS server IPv4 address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                      <multi/>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="wpad-url">
+                    <properties>
+                      <help>Web Proxy Autodiscovery (WPAD) URL</help>
+                    </properties>
+                  </leafNode>
+                </children>
+              </tagNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>