From 3f2173873e0519ea253759e7e119b2bcaea596bb Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Mon, 13 Dec 2021 21:06:47 +0100
Subject: op-mode: xml: refactor "show ip(v6) route" to use #include building
 blocks

This change then adds supper to filter for given route types under a VRF
instance. You will have "show ip route bgp" in the global VRF and "show ip route
vrf red bgp" in the red VRF. Same commands apply to IPv6 routes.
---
 op-mode-definitions/include/show-route-bgp.xml.i   |   8 ++
 .../include/show-route-connected.xml.i             |   8 ++
 op-mode-definitions/include/show-route-isis.xml.i  |   8 ++
 .../include/show-route-kernel.xml.i                |   8 ++
 op-mode-definitions/include/show-route-ospf.xml.i  |   8 ++
 .../include/show-route-ospfv3.xml.i                |   8 ++
 op-mode-definitions/include/show-route-rip.xml.i   |   8 ++
 op-mode-definitions/include/show-route-ripng.xml.i |   8 ++
 .../include/show-route-static.xml.i                |   8 ++
 .../include/show-route-summary.xml.i               |   8 ++
 .../include/show-route-supernets-only.xml.i        |   8 ++
 op-mode-definitions/include/show-route-table.xml.i |  17 ++++
 op-mode-definitions/include/show-route-tag.xml.i   |  16 +++
 op-mode-definitions/show-ip-route.xml.in           | 109 +++++----------------
 op-mode-definitions/show-ipv6-route.xml.in         |  97 +++++-------------
 15 files changed, 172 insertions(+), 155 deletions(-)
 create mode 100644 op-mode-definitions/include/show-route-bgp.xml.i
 create mode 100644 op-mode-definitions/include/show-route-connected.xml.i
 create mode 100644 op-mode-definitions/include/show-route-isis.xml.i
 create mode 100644 op-mode-definitions/include/show-route-kernel.xml.i
 create mode 100644 op-mode-definitions/include/show-route-ospf.xml.i
 create mode 100644 op-mode-definitions/include/show-route-ospfv3.xml.i
 create mode 100644 op-mode-definitions/include/show-route-rip.xml.i
 create mode 100644 op-mode-definitions/include/show-route-ripng.xml.i
 create mode 100644 op-mode-definitions/include/show-route-static.xml.i
 create mode 100644 op-mode-definitions/include/show-route-summary.xml.i
 create mode 100644 op-mode-definitions/include/show-route-supernets-only.xml.i
 create mode 100644 op-mode-definitions/include/show-route-table.xml.i
 create mode 100644 op-mode-definitions/include/show-route-tag.xml.i

(limited to 'op-mode-definitions')

diff --git a/op-mode-definitions/include/show-route-bgp.xml.i b/op-mode-definitions/include/show-route-bgp.xml.i
new file mode 100644
index 000000000..5c26bf43f
--- /dev/null
+++ b/op-mode-definitions/include/show-route-bgp.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-bgp.xml.i -->
+<leafNode name="bgp">
+  <properties>
+    <help>Border Gateway Protocol (BGP)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-connected.xml.i b/op-mode-definitions/include/show-route-connected.xml.i
new file mode 100644
index 000000000..37364de64
--- /dev/null
+++ b/op-mode-definitions/include/show-route-connected.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-connected.xml.i -->
+<leafNode name="connected">
+  <properties>
+    <help>Connected routes (directly attached subnet or host)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-isis.xml.i b/op-mode-definitions/include/show-route-isis.xml.i
new file mode 100644
index 000000000..9ff2ccdc5
--- /dev/null
+++ b/op-mode-definitions/include/show-route-isis.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-isis.xml.i -->
+<leafNode name="isis">
+  <properties>
+    <help>Intermediate System to Intermediate System (IS-IS)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-kernel.xml.i b/op-mode-definitions/include/show-route-kernel.xml.i
new file mode 100644
index 000000000..8c5ac414e
--- /dev/null
+++ b/op-mode-definitions/include/show-route-kernel.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-kernel.xml.i -->
+<leafNode name="kernel">
+  <properties>
+    <help>Kernel routes (not installed via the zebra RIB)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-ospf.xml.i b/op-mode-definitions/include/show-route-ospf.xml.i
new file mode 100644
index 000000000..1122aaba5
--- /dev/null
+++ b/op-mode-definitions/include/show-route-ospf.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-ospf.xml.i -->
+<leafNode name="ospf">
+  <properties>
+    <help>Open Shortest Path First (OSPFv2)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-ospfv3.xml.i b/op-mode-definitions/include/show-route-ospfv3.xml.i
new file mode 100644
index 000000000..c7a11b7ba
--- /dev/null
+++ b/op-mode-definitions/include/show-route-ospfv3.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-ospfv3.xml.i -->
+<leafNode name="ospfv3">
+  <properties>
+    <help>Open Shortest Path First (IPv6) (OSPFv3)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-rip.xml.i b/op-mode-definitions/include/show-route-rip.xml.i
new file mode 100644
index 000000000..3c2fede28
--- /dev/null
+++ b/op-mode-definitions/include/show-route-rip.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-rip.xml.i -->
+<leafNode name="rip">
+  <properties>
+    <help>Routing Information Protocol (RIP)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-ripng.xml.i b/op-mode-definitions/include/show-route-ripng.xml.i
new file mode 100644
index 000000000..6e59cb054
--- /dev/null
+++ b/op-mode-definitions/include/show-route-ripng.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-ripng.xml.i -->
+<leafNode name="ripng">
+  <properties>
+    <help>Routing Information Protocol next-generation (IPv6) (RIPng)</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-static.xml.i b/op-mode-definitions/include/show-route-static.xml.i
new file mode 100644
index 000000000..c2e396763
--- /dev/null
+++ b/op-mode-definitions/include/show-route-static.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-static.xml.i -->
+<leafNode name="static">
+  <properties>
+    <help>Statically configured routes</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-summary.xml.i b/op-mode-definitions/include/show-route-summary.xml.i
new file mode 100644
index 000000000..471124562
--- /dev/null
+++ b/op-mode-definitions/include/show-route-summary.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-summary.xml.i -->
+<leafNode name="summary">
+  <properties>
+    <help>Summary of all routes</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-supernets-only.xml.i b/op-mode-definitions/include/show-route-supernets-only.xml.i
new file mode 100644
index 000000000..4d1e7c51f
--- /dev/null
+++ b/op-mode-definitions/include/show-route-supernets-only.xml.i
@@ -0,0 +1,8 @@
+<!-- included start from show-route-supernets-only.xml.i -->
+<leafNode name="supernets-only">
+  <properties>
+    <help>Show supernet entries only</help>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</leafNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-table.xml.i b/op-mode-definitions/include/show-route-table.xml.i
new file mode 100644
index 000000000..c3cf82a86
--- /dev/null
+++ b/op-mode-definitions/include/show-route-table.xml.i
@@ -0,0 +1,17 @@
+<!-- included start from show-route-table.xml.i -->
+<node name="table">
+  <properties>
+    <help>Table to display</help>
+  </properties>
+</node>
+<tagNode name="table">
+  <properties>
+    <help>The table number to display</help>
+    <completionHelp>
+      <list>all</list>
+      <path>protocols static table</path>
+    </completionHelp>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</tagNode>
+<!-- included end -->
diff --git a/op-mode-definitions/include/show-route-tag.xml.i b/op-mode-definitions/include/show-route-tag.xml.i
new file mode 100644
index 000000000..8bfa0ae4e
--- /dev/null
+++ b/op-mode-definitions/include/show-route-tag.xml.i
@@ -0,0 +1,16 @@
+<!-- included start from show-route-tag.xml.i -->
+<node name="tag">
+  <properties>
+    <help>Show only routes with tag</help>
+  </properties>
+</node>
+<tagNode name="tag">
+  <properties>
+    <help>Tag value</help>
+    <completionHelp>
+      <list>&lt;1-4294967295&gt;</list>
+    </completionHelp>
+  </properties>
+  <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+</tagNode>
+<!-- included end -->
diff --git a/op-mode-definitions/show-ip-route.xml.in b/op-mode-definitions/show-ip-route.xml.in
index fdbb6859d..1e906672d 100644
--- a/op-mode-definitions/show-ip-route.xml.in
+++ b/op-mode-definitions/show-ip-route.xml.in
@@ -13,12 +13,7 @@
             </properties>
             <command>vtysh -c "show ip route"</command>
             <children>
-              <leafNode name="bgp">
-                <properties>
-                  <help>Show IP BGP routes</help>
-                </properties>
-                <command>vtysh -c "show ip route bgp"</command>
-              </leafNode>
+              #include <include/show-route-bgp.xml.i>
               <node name="cache">
                 <properties>
                   <help>Show kernel route cache</help>
@@ -34,12 +29,7 @@
                 </properties>
                 <command>ip -s route list cache $5</command>
               </tagNode>
-              <leafNode name="connected">
-                <properties>
-                  <help>Show IP connected routes</help>
-                </properties>
-                <command>vtysh -c "show ip route connected"</command>
-              </leafNode>
+              #include <include/show-route-connected.xml.i>
               <node name="forward">
                 <properties>
                   <help>Show kernel route table</help>
@@ -55,76 +45,15 @@
                 </properties>
                 <command>ip -s route list $5</command>
               </tagNode>
-              <leafNode name="isis">
-                <properties>
-                  <help>Show IP IS-IS routes</help>
-                </properties>
-                <command>vtysh -c "show ip route isis"</command>
-              </leafNode>
-              <leafNode name="kernel">
-                <properties>
-                  <help>Show IP kernel routes</help>
-                </properties>
-                <command>vtysh -c "show ip route kernel"</command>
-              </leafNode>
-              <leafNode name="ospf">
-                <properties>
-                  <help>Show IP OSPF routes</help>
-                </properties>
-                <command>vtysh -c "show ip route ospf"</command>
-              </leafNode>
-              <leafNode name="rip">
-                <properties>
-                  <help>Show IP RIP routes</help>
-                </properties>
-                <command>vtysh -c "show ip route rip"</command>
-              </leafNode>
-              <leafNode name="static">
-                <properties>
-                  <help>Show IP static routes</help>
-                </properties>
-                <command>vtysh -c "show ip route static"</command>
-              </leafNode>
-              <leafNode name="summary">
-                <properties>
-                  <help>Show IP routes summary</help>
-                </properties>
-                <command>vtysh -c "show ip route summary"</command>
-              </leafNode>
-              <leafNode name="supernets-only">
-                <properties>
-                  <help>Show IP supernet routes</help>
-                </properties>
-                <command>vtysh -c "show ip route supernets-only"</command>
-              </leafNode>
-              <node name="table">
-                <properties>
-                  <help>Show IP routes in policy table</help>
-                </properties>
-              </node>
-              <tagNode name="table">
-                <properties>
-                  <help>Show IP routes in policy table</help>
-                  <completionHelp>
-                    <list>&lt;1-200&gt;</list>
-                  </completionHelp>
-                </properties>
-                <command>vtysh -c "show ip route table $5"</command>
-              </tagNode>
-              <node name="tag">
-                <properties>
-                  <help>Show only routes with tag</help>
-                </properties>
-              </node>
-              <tagNode name="tag">
-                <properties>
-                  <help>Tag value</help>
-                  <completionHelp>
-                    <list>&lt;1-4294967295&gt;</list>
-                  </completionHelp>
-                </properties>
-                <command>vtysh -c "show ip route tag $5"</command>
-              </tagNode>
+              #include <include/show-route-isis.xml.i>
+              #include <include/show-route-kernel.xml.i>
+              #include <include/show-route-ospf.xml.i>
+              #include <include/show-route-rip.xml.i>
+              #include <include/show-route-static.xml.i>
+              #include <include/show-route-summary.xml.i>
+              #include <include/show-route-supernets-only.xml.i>
+              #include <include/show-route-table.xml.i>
+              #include <include/show-route-tag.xml.i>
               <tagNode name="vrf">
                 <properties>
                   <help>Show IP routes in VRF</help>
@@ -133,7 +62,19 @@
                     <path>vrf name</path>
                   </completionHelp>
                 </properties>
-                <command>vtysh -c "show ip route vrf $5"</command>
+                <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+                <children>
+                  #include <include/show-route-bgp.xml.i>
+                  #include <include/show-route-connected.xml.i>
+                  #include <include/show-route-isis.xml.i>
+                  #include <include/show-route-kernel.xml.i>
+                  #include <include/show-route-ospf.xml.i>
+                  #include <include/show-route-rip.xml.i>
+                  #include <include/show-route-static.xml.i>
+                  #include <include/show-route-summary.xml.i>
+                  #include <include/show-route-supernets-only.xml.i>
+                  #include <include/show-route-tag.xml.i>
+                </children>
               </tagNode>
             </children>
           </node>
@@ -144,7 +85,7 @@
                 <list>&lt;x.x.x.x&gt; &lt;x.x.x.x/x&gt;</list>
               </completionHelp>
             </properties>
-            <command>vtysh -c "show ip route $4"</command>
+            <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
             <children>
               <leafNode name="longer-prefixes">
                 <properties>
diff --git a/op-mode-definitions/show-ipv6-route.xml.in b/op-mode-definitions/show-ipv6-route.xml.in
index 8624574ac..2c5024991 100644
--- a/op-mode-definitions/show-ipv6-route.xml.in
+++ b/op-mode-definitions/show-ipv6-route.xml.in
@@ -13,12 +13,7 @@
             </properties>
             <command>vtysh -c "show ipv6 route"</command>
             <children>
-              <node name="bgp">
-                <properties>
-                  <help>Show IPv6 BGP routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route bgp"</command>
-              </node>
+              #include <include/show-route-bgp.xml.i>
               <node name="cache">
                 <properties>
                   <help>Show kernel IPv6 route cache</help>
@@ -34,12 +29,7 @@
                 </properties>
                 <command>ip -s -f inet6 route list cache $5</command>
               </tagNode>
-              <node name="connected">
-                <properties>
-                  <help>Show IPv6 connected routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route connected"</command>
-              </node>
+              #include <include/show-route-connected.xml.i>
               <node name="forward">
                 <properties>
                   <help>Show kernel IPv6 route table</help>
@@ -55,71 +45,36 @@
                 </properties>
                 <command>ip -s -f inet6 route list $5</command>
               </tagNode>
-              <node name="isis">
-                <properties>
-                  <help>Show IPv6 IS-IS routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route isis"</command>
-              </node>
-              <node name="kernel">
-                <properties>
-                  <help>Show IPv6 Kernel routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route kernel"</command>
-              </node>
-              <node name="ospfv3">
-                <properties>
-                  <help>Show IPv6 OSPF routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route ospf6"</command>
-              </node>
-              <node name="ripng">
-                <properties>
-                  <help>Show IPv6 RIPNG routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route ripng"</command>
-              </node>
-              <node name="static">
-                <properties>
-                  <help>Show IPv6 static routes</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route static"</command>
-              </node>
-              <node name="summary">
-                <properties>
-                  <help>Show IPv6 routes summary</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route summary"</command>
-              </node>
-              <node name="table">
-                <properties>
-                  <help>Show IPv6 routes in policy tables</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route table all"</command>
-              </node>
-              <tagNode name="table">
-                <properties>
-                  <help>Show IPv6 routes in specific policy table</help>
-                  <completionHelp>
-                    <path>protocols static table</path>
-                  </completionHelp>
-                </properties>
-                <command>vtysh -c "show ipv6 route table $5"</command>
-              </tagNode>
-              <node name="vrf">
-                <properties>
-                  <help>Show IPv6 routes in VRFs</help>
-                </properties>
-                <command>vtysh -c "show ipv6 route vrf all"</command>
-              </node>
+              #include <include/show-route-isis.xml.i>
+              #include <include/show-route-kernel.xml.i>
+              #include <include/show-route-ospfv3.xml.i>
+              #include <include/show-route-ripng.xml.i>
+              #include <include/show-route-static.xml.i>
+              #include <include/show-route-summary.xml.i>
+              #include <include/show-route-table.xml.i>
+              #include <include/show-route-tag.xml.i>
               <tagNode name="vrf">
                 <properties>
-                  <help>Show IPv6 routes in specific VRF</help>
+                  <help>Show IPv6 routes in VRF</help>
                   <completionHelp>
+                    <list>all</list>
                     <path>vrf name</path>
                   </completionHelp>
                 </properties>
-                <command>vtysh -c "show ipv6 route vrf $5"</command>
+                <command>${vyos_op_scripts_dir}/vtysh_wrapper.sh $@</command>
+                <children>
+                  #include <include/show-route-bgp.xml.i>
+                  #include <include/show-route-connected.xml.i>
+                  #include <include/show-route-isis.xml.i>
+                  #include <include/show-route-kernel.xml.i>
+                  #include <include/show-route-ospfv3.xml.i>
+                  #include <include/show-route-ripng.xml.i>
+                  #include <include/show-route-static.xml.i>
+                  #include <include/show-route-summary.xml.i>
+                  #include <include/show-route-supernets-only.xml.i>
+                  #include <include/show-route-table.xml.i>
+                  #include <include/show-route-tag.xml.i>
+                </children>
               </tagNode>
             </children>
           </node>
-- 
cgit v1.2.3