T1843: run interface-definitions though GCC preprocessor

A lot of XML code is duplicated (VLAN, interface address) for instance. Such
XML definitions should be moved to feature.xml.i files and then just pulled in
via GCC preprocessor #include definition in e.g. bond or ethernet definitions.

This will give us the ability to single-source repeating node definitions as:
* Interface Address
* Interface Description
* Interface Disable
* VLAN (both vif-s and vif-c)

The .in suffix of the interface-definitions is a marker that those files are
input files to the GCC preprocessor. They will be rendered into proper XML
files in the build directory.

Some node definitions have been reworder to remove escaped double quote
occurances which would have been warned about by the GCC preprocessor.

1 files changed, 378 insertions, 0 deletions

diff --git a/interface-definitions/ipoe-server.xml.in b/interface-definitions/ipoe-server.xml.in
new file mode 100644
index 000000000..5fee02614
--- /dev/null
+++ b/interface-definitions/ipoe-server.xml.in
@@ -0,0 +1,378 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="service">
+    <children>
+      <node name="ipoe-server" owner="${vyos_conf_scripts_dir}/ipoe_server.py">
+        <properties>
+          <help>Internet Protocol over Ethernet (IPoE) Server</help>
+          <priority>900</priority>
+        </properties>
+        <children>
+          <tagNode name="interface">
+            <properties>
+              <help>Network interface to server IPoE</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py</script>
+              </completionHelp>
+            </properties>
+            <children>
+              <leafNode name="network-mode">
+                <properties>
+                  <help>Network Layer IPoE serves on</help>
+                  <completionHelp>
+                    <list>L2 L3</list>
+                  </completionHelp>
+                  <constraint>
+                    <regex>^(L2|L3)</regex>
+                  </constraint>
+                  <valueHelp>
+                    <format>L2</format>
+                    <description>client share the same subnet</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>L3</format>
+                    <description>clients are behind this router</description>
+                  </valueHelp>
+                </properties>
+              </leafNode>
+              <leafNode name="network">
+                <properties>
+                  <help>Enables clients to share the same network or each client has its own vlan</help>
+                  <completionHelp>
+                    <list>shared vlan</list>
+                  </completionHelp>
+                  <constraint>
+                    <regex>^(shared|vlan)</regex>
+                  </constraint>
+                  <valueHelp>
+                    <format>shared</format>
+                    <description>Multiple clients share the same network</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>vlan</format>
+                    <description>One VLAN per client</description>
+                  </valueHelp>
+                </properties>
+              </leafNode>
+              <leafNode name="client-subnet">
+                <properties>
+                  <help>Client address pool</help>
+                  <valueHelp>
+                    <format>ipv4net</format>
+                    <description>IPv4 address and prefix length</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="ipv4-prefix"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <node name="external-dhcp">
+                <properties>
+                  <help>DHCP requests will be forwarded</help>
+                </properties>
+                <children>
+                  <leafNode name="dhcp-relay">
+                    <properties>
+                      <help>DHCP Server the request will be redirected to.</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>IPv4 address of the DHCP Server</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="giaddr">
+                    <properties>
+                      <help>address of the relay agent (Relay Agent IP Address)</help>
+                    </properties>
+                  </leafNode>
+                </children>
+              </node>
+              <leafNode name="vlan-id">
+                <properties>
+                  <help>VLAN monitor for the automatic creation of vlans (user per vlan)</help>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-4096"/>
+                  </constraint>
+                  <constraintErrorMessage>VLAN ID needs to be between 1 and 4096</constraintErrorMessage>
+                  <multi/>
+                </properties>
+              </leafNode>
+              <leafNode name="vlan-range">
+                <properties>
+                  <help>VLAN monitor for the automatic creation of vlans (user per vlan)</help>
+                  <constraint>
+                    <regex>(409[0-6]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{0,2})-(409[0-6]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{0,2})</regex>
+                  </constraint>
+                  <multi/>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+          <node name="dns-server">
+            <properties>
+              <help>DNS servers offered via internal DHCP</help>
+            </properties>
+            <children>
+              <leafNode name="server-1">
+                <properties>
+                  <help>IP address of the primary DNS server</help>
+                  <constraint>
+                    <validator name="ipv4-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="server-2">
+                <properties>
+                  <help>IP address of the secondary DNS server</help>
+                  <constraint>
+                    <validator name="ipv4-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+          <node name="dnsv6-server">
+            <properties>
+              <help>DNSv6 servers offered via internal DHCPv6</help>
+            </properties>
+            <children>
+              <leafNode name="server-1">
+                <properties>
+                  <help>IP address of the primary DNS server</help>
+                  <constraint>
+                    <validator name="ipv6-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="server-2">
+                <properties>
+                  <help>IP address of the secondary DNS server</help>
+                  <constraint>
+                    <validator name="ipv6-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="server-3">
+                <properties>
+                  <help>IP address of the tertiary DNS server</help>
+                  <constraint>
+                    <validator name="ipv6-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+          <node name="client-ipv6-pool">
+            <properties>
+              <help>Pool of client IPv6 addresses</help>
+            </properties>
+            <children>
+              <leafNode name="prefix">
+                <properties>
+                  <help>Format: ipv6prefix/mask,prefix_len (e.g.: fc00:0:1::/48,64 - divides prefix into /64 subnets for clients)</help>
+                  <multi/>
+                </properties>
+              </leafNode>
+              <leafNode name="delegate-prefix">
+                <properties>
+                  <help>Format: ipv6prefix/mask,prefix_len (delegates prefix  to clients via DHCPv6 prefix delegation</help>
+                  <multi/>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+          <node name="authentication">
+            <properties>
+              <help>Client authentication methods</help>
+            </properties>
+            <children>
+              <leafNode name="mode">
+                <properties>
+                  <help>Authetication mode</help>
+                  <completionHelp>
+                    <list>local radius noauth</list>
+                  </completionHelp>
+                  <constraint>
+                    <regex>^(local|radius|noauth)</regex>
+                  </constraint>
+                  <valueHelp>
+                    <format>local</format>
+                    <description>Authentication based on local definition</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>radius</format>
+                    <description>Authentication based on a RADIUS server</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>noauth</format>
+                    <description>Authentication disabled</description>
+                  </valueHelp>
+                </properties>
+              </leafNode>
+              <tagNode name="interface">
+                <properties>
+                  <help>Network interface the client mac will appear on</help>
+                  <completionHelp>
+                    <script>${vyos_completion_dir}/list_interfaces.py</script>
+                  </completionHelp>
+                </properties>
+                <children>
+                  <tagNode name="mac-address">
+                    <properties>
+                      <help>Client mac address allowed to receive an IP address</help>
+                      <valueHelp>
+                        <format>h:h:h:h:h:h</format>
+                        <description>Hardware (MAC) address</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="mac-address"/>
+                      </constraint>
+                    </properties>
+                    <children>
+                      <node name="rate-limit">
+                        <properties>
+                          <help>Upload/Download speed limits</help>
+                        </properties>
+                        <children>
+                          <leafNode name="upload">
+                            <properties>
+                              <help>Upload bandwidth limit in kbits/sec</help>
+                              <constraint>
+                                <validator name="numeric" argument="--range 1-65535"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                          <leafNode name="download">
+                            <properties>
+                              <help>Download bandwidth limit in kbits/sec</help>
+                              <constraint>
+                                <validator name="numeric" argument="--range 1-65535"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                        </children>
+                      </node>
+                      <leafNode name="vlan-id">
+                        <properties>
+                          <help>VLAN-ID of the client network</help>
+                          <constraint>
+                            <validator name="numeric" argument="--range 1-4096"/>
+                          </constraint>
+                          <constraintErrorMessage>VLAN ID needs to be between 1 and 4096</constraintErrorMessage>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </tagNode>
+                </children>
+              </tagNode>
+              <tagNode name="radius-server">
+                <properties>
+                  <help>IP address of RADIUS server</help>
+                  <valueHelp>
+                    <format>ipv4</format>
+                    <description>IP address of RADIUS server</description>
+                  </valueHelp>
+                </properties>
+                <children>
+                  <leafNode name="secret">
+                    <properties>
+                      <help>Key for accessing the specified server</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="req-limit">
+                    <properties>
+                      <help>Maximum number of simultaneous requests to server (default: unlimited)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="fail-time">
+                    <properties>
+                      <help>If server does not respond, mark it unavailable for this time (seconds)</help>
+                    </properties>
+                  </leafNode>
+                </children>
+              </tagNode>
+              <node name="radius-settings">
+                <properties>
+                  <help>RADIUS settings</help>
+                </properties>
+                <children>
+                  <leafNode name="timeout">
+                    <properties>
+                      <help>Timeout to wait response from server (seconds)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="acct-timeout">
+                    <properties>
+                      <help>Timeout to wait reply for Interim-Update packets. (default 3 seconds)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="max-try">
+                    <properties>
+                      <help>Maximum number of tries to send Access-Request/Accounting-Request queries</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nas-identifier">
+                    <properties>
+                      <help>Value to send to RADIUS server in NAS-Identifier attribute and to be matched in DM/CoA requests.</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nas-ip-address">
+                    <properties>
+                      <help>Value to send to RADIUS server in NAS-IP-Address attribute and to be matched in DM/CoA requests. Also DM/CoA server will bind to that address.</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>IPv4 address of the DAE Server</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="ipv4-address"/>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  <node name="dae-server">
+                    <properties>
+                      <help>IPv4 address and port to bind Dynamic Authorization Extension server (DM/CoA)</help>
+                    </properties>
+                    <children>
+                      <leafNode name="ip-address">
+                        <properties>
+                          <help>IP address for Dynamic Authorization Extension server (DM/CoA)</help>
+                          <valueHelp>
+                            <format>ipv4</format>
+                            <description>IPv4 address of the DAE Server</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="ipv4-address"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="port">
+                        <properties>
+                          <help>Port for Dynamic Authorization Extension server (DM/CoA)</help>
+                          <valueHelp>
+                            <format>1-65535</format>
+                            <description>port number</description>
+                          </valueHelp>
+                          <constraint>
+                            <validator name="numeric" argument="--range 1-65535"/>
+                          </constraint>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="secret">
+                        <properties>
+                          <help>Secret for Dynamic Authorization Extension server (DM/CoA)</help>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </node>
+                </children>
+              </node>
+            </children>
+          </node>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>