vrf: T2450: provide full protocol support in XML and Python with new CLI

9 files changed, 184 insertions, 362 deletions

diff --git a/interface-definitions/include/static-route-blackhole.xml.i b/interface-definitions/include/static-route-blackhole.xml.i
new file mode 100644
index 000000000..c880ee778
--- /dev/null
+++ b/interface-definitions/include/static-route-blackhole.xml.i
@@ -0,0 +1,10 @@
+<!-- included start from static-route-blackhole.xml.i -->

+<node name="blackhole">

+  <properties>

+    <help>Silently discard packets when matched</help>

+  </properties>

+  <children>

+    #include <include/static-route-distance.xml.i>

+  </children>

+</node>

+<!-- included end -->

diff --git a/interface-definitions/include/static-route-disable.xml.i b/interface-definitions/include/static-route-disable.xml.i
deleted file mode 100644
index 100ca3cbf..000000000
--- a/interface-definitions/include/static-route-disable.xml.i
+++ /dev/null
@@ -1,8 +0,0 @@
-<!-- included start from static-route-disable.xml.i.xml.i -->
-<leafNode name="disable">
-  <properties>
-    <help>Disable interface static route</help>
-    <valueless/>
-  </properties>
-</leafNode>
-<!-- included end -->
diff --git a/interface-definitions/include/static-route-next-hop-interface.xml.i b/interface-definitions/include/static-route-next-hop-interface.xml.i
new file mode 100644
index 000000000..01c253597
--- /dev/null
+++ b/interface-definitions/include/static-route-next-hop-interface.xml.i
@@ -0,0 +1,17 @@
+<!-- included start from static-route-next-hop-interface.xml.i -->
+<leafNode name="interface">
+  <properties>
+    <help>Gateway interface name</help>
+    <completionHelp>
+      <script>${vyos_completion_dir}/list_interfaces.py</script>
+    </completionHelp>
+    <valueHelp>
+      <format>txt</format>
+      <description>Gateway interface name</description>
+    </valueHelp>
+    <constraint>
+      <regex>^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$</regex>
+    </constraint>
+  </properties>
+</leafNode>
+<!-- included end -->
diff --git a/interface-definitions/include/static-route-next-hop-vrf.xml.i b/interface-definitions/include/static-route-next-hop-vrf.xml.i
index c90140856..ae2515a12 100644
--- a/interface-definitions/include/static-route-next-hop-vrf.xml.i
+++ b/interface-definitions/include/static-route-next-hop-vrf.xml.i
@@ -1,16 +1,18 @@
 <!-- included start from static-route-next-hop-vrf.xml.i -->
-<leafNode name="next-hop-vrf">
+<leafNode name="vrf">
   <properties>
     <help>VRF to leak route</help>
+    <completionHelp>
+      <list>default</list>
+      <path>vrf name</path>
+    </completionHelp>
     <valueHelp>
       <format>txt</format>
       <description>Name of VRF to leak to</description>
     </valueHelp>
-    <completionHelp>
-      <path>protocols vrf</path>
-    </completionHelp>
     <constraint>
-      <regex>^[a-zA-Z0-9\-_]{1,100}$</regex>
+      <regex>^(default)$</regex>
+      <validator name="vrf-name"/>
     </constraint>
   </properties>
 </leafNode>
diff --git a/interface-definitions/include/static-route.xml.i b/interface-definitions/include/static-route.xml.i
new file mode 100644
index 000000000..9ab3926da
--- /dev/null
+++ b/interface-definitions/include/static-route.xml.i
@@ -0,0 +1,63 @@
+<!-- included start from static-route.xml.i -->

+<tagNode name="route">

+  <properties>

+    <help>VRF static IPv4 route</help>

+    <valueHelp>

+      <format>ipv4net</format>

+      <description>VRF static IPv4 route</description>

+    </valueHelp>

+    <constraint>

+      <validator name="ipv4-prefix"/>

+    </constraint>

+  </properties>

+  <children>

+    <node name="blackhole">

+      <properties>

+        <help>Silently discard pkts when matched</help>

+      </properties>

+      <children>

+        #include <include/static-route-distance.xml.i>

+      </children>

+    </node>

+    <tagNode name="interface">

+      <properties>

+        <help>Next-hop IPv4 router interface</help>

+        <completionHelp>

+          <script>${vyos_completion_dir}/list_interfaces.py</script>

+        </completionHelp>

+        <valueHelp>

+          <format>txt</format>

+          <description>Gateway interface name</description>

+        </valueHelp>

+        <constraint>

+          <regex>^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$</regex>

+        </constraint>

+      </properties>

+      <children>

+        #include <include/generic-disable-node.xml.i>

+        #include <include/static-route-distance.xml.i>

+        #include <include/static-route-next-hop-vrf.xml.i>

+      </children>

+    </tagNode>

+    <tagNode name="next-hop">

+      <properties>

+        <help>Next-hop IPv4 router address</help>

+        <valueHelp>

+          <format>ipv4</format>

+          <description>Next-hop router address</description>

+        </valueHelp>

+        <constraint>

+          <validator name="ipv4-address"/>

+        </constraint>

+      </properties>

+      <children>

+        #include <include/generic-disable-node.xml.i>

+        #include <include/static-route-distance.xml.i>

+        #include <include/static-route-next-hop-interface.xml.i>

+        #include <include/static-route-next-hop-vrf.xml.i>

+      </children>

+    </tagNode>

+  </children>

+</tagNode>

+<!-- included end -->

+

diff --git a/interface-definitions/include/static-route6.xml.i b/interface-definitions/include/static-route6.xml.i
new file mode 100644
index 000000000..d484b285c
--- /dev/null
+++ b/interface-definitions/include/static-route6.xml.i
@@ -0,0 +1,63 @@
+<!-- included start from static-route6.xml.i -->

+<tagNode name="route6">

+  <properties>

+    <help>VRF static IPv6 route</help>

+    <valueHelp>

+      <format>ipv6net</format>

+      <description>VRF static IPv6 route</description>

+    </valueHelp>

+    <constraint>

+      <validator name="ipv6-prefix"/>

+    </constraint>

+  </properties>

+  <children>

+    <node name="blackhole">

+      <properties>

+        <help>Silently discard pkts when matched</help>

+      </properties>

+      <children>

+        #include <include/static-route-distance.xml.i>

+      </children>

+    </node>

+    <tagNode name="interface">

+      <properties>

+        <help>IPv6 gateway interface name</help>

+        <completionHelp>

+          <script>${vyos_completion_dir}/list_interfaces.py</script>

+        </completionHelp>

+        <valueHelp>

+          <format>txt</format>

+          <description>Gateway interface name</description>

+        </valueHelp>

+        <constraint>

+          <regex>^(br|bond|dum|en|eth|gnv|peth|tun|vti|vxlan|wg|wlan)[0-9]+|lo$</regex>

+        </constraint>

+      </properties>

+      <children>

+        #include <include/generic-disable-node.xml.i>

+        #include <include/static-route-distance.xml.i>

+        #include <include/static-route-next-hop-vrf.xml.i>

+      </children>

+    </tagNode>

+    <tagNode name="next-hop">

+      <properties>

+        <help>IPv6 gateway address</help>

+        <valueHelp>

+          <format>ipv6</format>

+          <description>Next-hop IPv6 router</description>

+        </valueHelp>

+        <constraint>

+          <validator name="ipv6-address"/>

+        </constraint>

+      </properties>

+      <children>

+        #include <include/generic-disable-node.xml.i>

+        #include <include/static-route-distance.xml.i>

+        #include <include/static-route-next-hop-interface.xml.i>

+        #include <include/static-route-next-hop-vrf.xml.i>

+      </children>

+    </tagNode>

+  </children>

+</tagNode>

+<!-- included end -->

+

diff --git a/interface-definitions/protocols-static.xml.in b/interface-definitions/protocols-static.xml.in
index 2a9f7014f..3ad6434db 100644
--- a/interface-definitions/protocols-static.xml.in
+++ b/interface-definitions/protocols-static.xml.in
@@ -28,11 +28,11 @@
                   </completionHelp>
                 </properties>
                 <children>
-                  #include <include/static-route-disable.xml.i>
+                  #include <include/generic-disable-node.xml.i>
                   #include <include/static-route-distance.xml.i>
                   #include <include/static-route-next-hop-vrf.xml.i>
                 </children>
-              </tagNode> 
+              </tagNode>
             </children>
           </tagNode>
           <tagNode name="interface-route6">
@@ -55,10 +55,10 @@
                   </completionHelp>
                 </properties>
                 <children>
-                  #include <include/static-route-disable.xml.i>
+                  #include <include/generic-disable-node.xml.i>
                   #include <include/static-route-distance.xml.i>
                 </children>
-              </tagNode> 
+              </tagNode>
             </children>
           </tagNode>
           #include <include/static-route-map.xml.i>
@@ -118,7 +118,7 @@
                   </constraint>
                 </properties>
                 <children>
-                  #include <include/static-route-disable.xml.i>
+                  #include <include/generic-disable-node.xml.i>
                   #include <include/static-route-distance.xml.i>
                   <leafNode name="next-hop-interface">
                     <properties>
@@ -169,7 +169,7 @@
                   </constraint>
                 </properties>
                 <children>
-                  #include <include/static-route-disable.xml.i>
+                  #include <include/generic-disable-node.xml.i>
                   #include <include/static-route-distance.xml.i>
                   <leafNode name="interface">
                     <properties>
@@ -220,10 +220,10 @@
                       </completionHelp>
                     </properties>
                     <children>
-                      #include <include/static-route-disable.xml.i>
+                      #include <include/generic-disable-node.xml.i>
                       #include <include/static-route-distance.xml.i>
                     </children>
-                  </tagNode> 
+                  </tagNode>
                 </children>
               </tagNode>
               <tagNode name="interface-route6">
@@ -246,10 +246,10 @@
                       </completionHelp>
                     </properties>
                     <children>
-                      #include <include/static-route-disable.xml.i>
+                      #include <include/generic-disable-node.xml.i>
                       #include <include/static-route-distance.xml.i>
                     </children>
-                  </tagNode> 
+                  </tagNode>
                 </children>
               </tagNode>
               <tagNode name="route">
@@ -296,7 +296,7 @@
                       </constraint>
                     </properties>
                     <children>
-                      #include <include/static-route-disable.xml.i>
+                      #include <include/generic-disable-node.xml.i>
                       #include <include/static-route-distance.xml.i>
                       <leafNode name="next-hop-interface">
                         <properties>
@@ -347,7 +347,7 @@
                       </constraint>
                     </properties>
                     <children>
-                      #include <include/static-route-disable.xml.i>
+                      #include <include/generic-disable-node.xml.i>
                       #include <include/static-route-distance.xml.i>
                     </children>
                   </tagNode>
diff --git a/interface-definitions/protocols-vrf.xml.in b/interface-definitions/protocols-vrf.xml.in
index d58f85b02..81942d124 100644
--- a/interface-definitions/protocols-vrf.xml.in
+++ b/interface-definitions/protocols-vrf.xml.in
@@ -1,18 +1,21 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Protocol VRF configuration -->
 <interfaceDefinition>
   <node name="protocols">
     <children>
-       <tagNode name="nvrf" owner="${vyos_conf_scripts_dir}/vrf.py">
+       <tagNode name="vrf" owner="${vyos_conf_scripts_dir}/protocols_vrf.py">
         <properties>
           <help>Name of VRF to add route for</help>
+          <completionHelp>
+            <path>vrf name</path>
+          </completionHelp>
           <valueHelp>
             <format>txt</format>
-            <description>Name of VRF to add route for</description>
+            <description>VRF instance name</description>
           </valueHelp>
-          <completionHelp>
-            <path>protocols vrf</path>
-          </completionHelp>
+          <constraint>
+            <validator name="vrf-name"/>
+          </constraint>
+          <constraintErrorMessage>VRF instance name must be 15 characters or less and can not\nbe named as regular network interfaces.\n</constraintErrorMessage>
         </properties>
         <children>
           <node name="static">
@@ -20,336 +23,8 @@
               <help>Static route parameters</help>
             </properties>
             <children>
-              <tagNode name="interface-route">
-                <properties>
-                  <help>Interface based static route</help>
-                  <valueHelp>
-                    <format>ipv4net</format>
-                    <description>Interface based static route</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="ipv4-prefix"/>
-                  </constraint>
-                </properties>
-                <children>
-                  <tagNode name="next-hop-interface">
-                    <properties>
-                      <help>Next-hop interface [REQUIRED]</help>
-                      <completionHelp>
-                        <script>${vyos_completion_dir}/list_interfaces.py</script>
-                      </completionHelp>
-                    </properties>
-                    <children>
-                      <leafNode name="disable">
-                        <properties>
-                          <help>Disable IPv4 interface static route</help>
-                          <valueless/>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="distance">
-                        <properties>
-                          <help>Distance for this route</help>
-                          <valueHelp>
-                            <format>u32:1-255</format>
-                            <description>Distance for this route</description>
-                          </valueHelp>
-                          <constraint>
-                            <validator name="numeric" argument="--range 1-255"/>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="next-hop-vrf">
-                        <properties>
-                          <help>VRF to leak route</help>
-                          <valueHelp>
-                            <format>txt</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <valueHelp>
-                            <format>default</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <completionHelp>
-                            <list>default</list>
-                            <path>protocols vrf</path>
-                          </completionHelp>
-                          <constraint>
-                            <regex>^[a-zA-Z0-9\-_]{1,100}$</regex>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </tagNode> 
-                </children>
-              </tagNode>
-              <tagNode name="interface-route6">
-                <properties>
-                  <help>Interface based IPv6 static route</help>
-                  <valueHelp>
-                    <format>ipv6net</format>
-                    <description>Interface based IPv6 static route</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="ipv6-prefix"/>
-                  </constraint>
-                </properties>
-                <children>
-                  <tagNode name="next-hop-interface">
-                    <properties>
-                      <help>Next-hop interface [REQUIRED]</help>
-                      <completionHelp>
-                        <script>${vyos_completion_dir}/list_interfaces.py</script>
-                      </completionHelp>
-                    </properties>
-                    <children>
-                      <leafNode name="disable">
-                        <properties>
-                          <help>Disable IPv6 interface static route</help>
-                          <valueless/>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="distance">
-                        <properties>
-                          <help>Distance for this route</help>
-                          <valueHelp>
-                            <format>u32:1-255</format>
-                            <description>Distance for this route</description>
-                          </valueHelp>
-                          <constraint>
-                            <validator name="numeric" argument="--range 1-255"/>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="next-hop-vrf">
-                        <properties>
-                          <help>VRF to leak route</help>
-                          <valueHelp>
-                            <format>txt</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <valueHelp>
-                            <format>default</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <completionHelp>
-                            <list>default</list>
-                            <path>protocols vrf</path>
-                          </completionHelp>
-                          <constraint>
-                            <regex>^[a-zA-Z0-9\-_]{1,100}$</regex>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </tagNode> 
-                </children>
-              </tagNode>
-              <tagNode name="route">
-                <properties>
-                  <help>VRF static IPv4 route</help>
-                  <valueHelp>
-                    <format>ipv4net</format>
-                    <description>VRF static IPv4 route</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="ipv4-prefix"/>
-                  </constraint>
-                </properties>
-                <children>
-                  <node name="blackhole">
-                    <properties>
-                      <help>Silently discard pkts when matched</help>
-                    </properties>
-                    <children>
-                      <leafNode name="distance">
-                        <properties>
-                          <help>Distance value for this route</help>
-                          <valueHelp>
-                            <format>u32:1-255</format>
-                            <description>Distance for this route</description>
-                          </valueHelp>
-                          <constraint>
-                            <validator name="numeric" argument="--range 1-255"/>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </node>
-                  <leafNode name="dhcp-interface">
-                    <properties>
-                      <help>DHCP interface that supplies the next-hop IP address for this static route</help>
-                      <completionHelp>
-                        <script>${vyos_completion_dir}/list_interfaces.py</script>
-                      </completionHelp>
-                      <valueHelp>
-                        <format>txt</format>
-                        <description>DHCP interface</description>
-                      </valueHelp>
-                    </properties>
-                  </leafNode>
-                  <tagNode name="next-hop">
-                    <properties>
-                      <help>Next-hop router</help>
-                      <valueHelp>
-                        <format>ipv4</format>
-                        <description>Next-hop router</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="ipv4-address"/>
-                      </constraint>
-                    </properties>
-                    <children>
-                      <leafNode name="disable">
-                        <properties>
-                          <help>Disable IPv4 interface static route</help>
-                          <valueless/>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="distance">
-                        <properties>
-                          <help>Distance for this route</help>
-                          <valueHelp>
-                            <format>u32:1-255</format>
-                            <description>Distance for this route</description>
-                          </valueHelp>
-                          <constraint>
-                            <validator name="numeric" argument="--range 1-255"/>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="next-hop-interface">
-                        <properties>
-                          <help>IPv4 gateway interface name</help>
-                          <completionHelp>
-                            <script>${vyos_completion_dir}/list_interfaces.py</script>
-                          </completionHelp>
-                          <valueHelp>
-                            <format>txt</format>
-                            <description>IPv4 gateway interface name</description>
-                          </valueHelp>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="next-hop-vrf">
-                        <properties>
-                          <help>VRF to leak route</help>
-                          <valueHelp>
-                            <format>txt</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <valueHelp>
-                            <format>default</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <completionHelp>
-                            <list>default</list>
-                            <path>protocols vrf</path>
-                          </completionHelp>
-                          <constraint>
-                            <regex>^[a-zA-Z0-9\-_]{1,100}$</regex>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </tagNode>
-                </children>
-              </tagNode>
-              <tagNode name="route6">
-                <properties>
-                  <help>VRF static IPv6 route</help>
-                  <valueHelp>
-                    <format>ipv6net</format>
-                    <description>VRF static IPv6 route</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="ipv6-prefix"/>
-                  </constraint>
-                </properties>
-                <children>
-                  <node name="blackhole">
-                    <properties>
-                      <help>Silently discard pkts when matched</help>
-                    </properties>
-                    <children>
-                      <leafNode name="distance">
-                        <properties>
-                          <help>Distance value for this route</help>
-                          <valueHelp>
-                            <format>u32:1-255</format>
-                            <description>Distance for this route</description>
-                          </valueHelp>
-                          <constraint>
-                            <validator name="numeric" argument="--range 1-255"/>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </node>
-                  <tagNode name="next-hop">
-                    <properties>
-                      <help>Next-hop IPv6 router [REQUIRED]</help>
-                      <valueHelp>
-                        <format>ipv6</format>
-                        <description>Next-hop IPv6 router [REQUIRED]</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="ipv6-address"/>
-                      </constraint>
-                    </properties>
-                    <children>
-                      <leafNode name="disable">
-                        <properties>
-                          <help>Disable IPv6 interface static route</help>
-                          <valueless/>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="distance">
-                        <properties>
-                          <help>Distance for this route</help>
-                          <valueHelp>
-                            <format>u32:1-255</format>
-                            <description>Distance for this route</description>
-                          </valueHelp>
-                          <constraint>
-                            <validator name="numeric" argument="--range 1-255"/>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="interface">
-                        <properties>
-                          <help>IPv6 gateway interface name</help>
-                          <completionHelp>
-                            <script>${vyos_completion_dir}/list_interfaces.py</script>
-                          </completionHelp>
-                          <valueHelp>
-                            <format>txt</format>
-                            <description>IPv6 gateway interface name</description>
-                          </valueHelp>
-                        </properties>
-                      </leafNode>
-                      <leafNode name="next-hop-vrf">
-                        <properties>
-                          <help>VRF to leak route</help>
-                          <valueHelp>
-                            <format>txt</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <valueHelp>
-                            <format>default</format>
-                            <description>Name of VRF to leak to</description>
-                          </valueHelp>
-                          <completionHelp>
-                            <list>default</list>
-                            <path>protocols vrf</path>
-                          </completionHelp>
-                          <constraint>
-                            <regex>^[a-zA-Z0-9\-_]{1,100}$</regex>
-                          </constraint>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </tagNode>
-                </children>
-              </tagNode>
+              #include <include/static-route.xml.i>
+              #include <include/static-route6.xml.i>
             </children>
           </node>
         </children>
diff --git a/interface-definitions/vrf.xml.in b/interface-definitions/vrf.xml.in
index 81c89d94b..eca9e75a7 100644
--- a/interface-definitions/vrf.xml.in
+++ b/interface-definitions/vrf.xml.in
@@ -21,7 +21,7 @@
           </constraint>
           <constraintErrorMessage>VRF instance name must be 15 characters or less and can not\nbe named as regular network interfaces.\n</constraintErrorMessage>
           <valueHelp>
-            <format>name</format>
+            <format>txt</format>
             <description>Instance name</description>
           </valueHelp>
         </properties>