From ff25cb35c93e464acb7c18d329323ba841311abe Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Tue, 7 Sep 2021 11:26:42 +0200
Subject: op-mode: xml: improve "show interfaces <type>" help text

(cherry picked from commit bd2c79ebb8abbd844f4b0568110c7bcea0d8f4f1)
---
 op-mode-definitions/show-interfaces-bonding.xml.in |  4 +-
 op-mode-definitions/show-interfaces-bridge.xml.in  |  4 +-
 op-mode-definitions/show-interfaces-dummy.xml.in   |  4 +-
 .../show-interfaces-ethernet.xml.in                |  4 +-
 op-mode-definitions/show-interfaces-input.xml.in   |  4 +-
 op-mode-definitions/show-interfaces-l2tpv3.xml.in  |  2 +-
 .../show-interfaces-loopback.xml.in                |  4 +-
 op-mode-definitions/show-interfaces-pppoe.xml.in   |  2 +-
 .../show-interfaces-pseudo-ethernet.xml.in         |  4 +-
 op-mode-definitions/show-interfaces-tunnel.xml.in  |  4 +-
 op-mode-definitions/show-interfaces-vti.xml.in     |  4 +-
 op-mode-definitions/show-interfaces-vxlan.xml.in   |  2 +-
 .../show-interfaces-wireguard.xml.in               | 66 +++++++++++++++++
 .../show-interfaces-wireless.xml.in                | 82 ++++++++++++++++++++++
 op-mode-definitions/show-interfaces-wwan.xml.in    |  2 +-
 op-mode-definitions/wireguard.xml.in               | 53 --------------
 op-mode-definitions/wireless.xml.in                | 79 ---------------------
 17 files changed, 170 insertions(+), 154 deletions(-)
 create mode 100644 op-mode-definitions/show-interfaces-wireguard.xml.in
 create mode 100644 op-mode-definitions/show-interfaces-wireless.xml.in

(limited to 'op-mode-definitions')

diff --git a/op-mode-definitions/show-interfaces-bonding.xml.in b/op-mode-definitions/show-interfaces-bonding.xml.in
index c1c76b059..d4e737d5b 100644
--- a/op-mode-definitions/show-interfaces-bonding.xml.in
+++ b/op-mode-definitions/show-interfaces-bonding.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="bonding">
             <properties>
-              <help>Show bonding interface information</help>
+              <help>Show specified Bonding interface information</help>
               <completionHelp>
                 <path>interfaces bonding</path>
               </completionHelp>
@@ -46,7 +46,7 @@
           </tagNode>
           <node name="bonding">
             <properties>
-              <help>Show bonding interface information</help>
+              <help>Show Bonding interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=bonding --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-bridge.xml.in b/op-mode-definitions/show-interfaces-bridge.xml.in
index cc4b248b6..d4908b341 100644
--- a/op-mode-definitions/show-interfaces-bridge.xml.in
+++ b/op-mode-definitions/show-interfaces-bridge.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="bridge">
             <properties>
-              <help>Show bridge interface information</help>
+              <help>Show specified Bridge interface information</help>
               <completionHelp>
                 <path>interfaces bridge</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="bridge">
             <properties>
-              <help>Show bridge interface information</help>
+              <help>Show Bridge interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=bridge --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-dummy.xml.in b/op-mode-definitions/show-interfaces-dummy.xml.in
index 7c24c6921..52d2cc7ee 100644
--- a/op-mode-definitions/show-interfaces-dummy.xml.in
+++ b/op-mode-definitions/show-interfaces-dummy.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="dummy">
             <properties>
-              <help>Show dummy interface information</help>
+              <help>Show specified Dummy interface information</help>
               <completionHelp>
                 <path>interfaces dummy</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="dummy">
             <properties>
-              <help>Show dummy interface information</help>
+              <help>Show Dummy interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=dummy --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-ethernet.xml.in b/op-mode-definitions/show-interfaces-ethernet.xml.in
index df9e304a7..e414291d1 100644
--- a/op-mode-definitions/show-interfaces-ethernet.xml.in
+++ b/op-mode-definitions/show-interfaces-ethernet.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="ethernet">
             <properties>
-              <help>Show ethernet interface information</help>
+              <help>Show specified Ethernet interface information</help>
               <completionHelp>
                 <path>interfaces ethernet</path>
               </completionHelp>
@@ -72,7 +72,7 @@
           </tagNode>
           <node name="ethernet">
             <properties>
-              <help>Show ethernet interface information</help>
+              <help>Show Ethernet interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=ethernet --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-input.xml.in b/op-mode-definitions/show-interfaces-input.xml.in
index 15e8203e5..9ae3828c8 100644
--- a/op-mode-definitions/show-interfaces-input.xml.in
+++ b/op-mode-definitions/show-interfaces-input.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="input">
             <properties>
-              <help>Show input interface information</help>
+              <help>Show specified Input interface information</help>
               <completionHelp>
                 <path>interfaces input</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="input">
             <properties>
-              <help>Show input interface information</help>
+              <help>Show Input (ifb) interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=input --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-l2tpv3.xml.in b/op-mode-definitions/show-interfaces-l2tpv3.xml.in
index 60fee34a1..2a1d6a1c6 100644
--- a/op-mode-definitions/show-interfaces-l2tpv3.xml.in
+++ b/op-mode-definitions/show-interfaces-l2tpv3.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="l2tpv3">
             <properties>
-              <help>Show L2TPv3 interface information</help>
+              <help>Show specified L2TPv3 interface information</help>
               <completionHelp>
                 <path>interfaces l2tpv3</path>
               </completionHelp>
diff --git a/op-mode-definitions/show-interfaces-loopback.xml.in b/op-mode-definitions/show-interfaces-loopback.xml.in
index b30b57909..25a75ffff 100644
--- a/op-mode-definitions/show-interfaces-loopback.xml.in
+++ b/op-mode-definitions/show-interfaces-loopback.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="loopback">
             <properties>
-              <help>Show loopback interface information</help>
+              <help>Show specified Loopback interface information</help>
               <completionHelp>
                 <path>interfaces loopback</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="loopback">
             <properties>
-              <help>Show loopback interface information</help>
+              <help>Show Loopback interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=loopback --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-pppoe.xml.in b/op-mode-definitions/show-interfaces-pppoe.xml.in
index 18697a275..767836abf 100644
--- a/op-mode-definitions/show-interfaces-pppoe.xml.in
+++ b/op-mode-definitions/show-interfaces-pppoe.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="pppoe">
             <properties>
-              <help>Show PPPoE interface information</help>
+              <help>Show specified PPPoE interface information</help>
               <completionHelp>
                 <path>interfaces pppoe</path>
               </completionHelp>
diff --git a/op-mode-definitions/show-interfaces-pseudo-ethernet.xml.in b/op-mode-definitions/show-interfaces-pseudo-ethernet.xml.in
index 195944745..2ae4b5a9e 100644
--- a/op-mode-definitions/show-interfaces-pseudo-ethernet.xml.in
+++ b/op-mode-definitions/show-interfaces-pseudo-ethernet.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="pseudo-ethernet">
             <properties>
-              <help>Show pseudo-ethernet/MACvlan interface information</help>
+              <help>Show specified Pseudo-Ethernet/MACvlan interface information</help>
               <completionHelp>
                 <path>interfaces pseudo-ethernet</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="pseudo-ethernet">
             <properties>
-              <help>Show pseudo-ethernet/MACvlan interface information</help>
+              <help>Show Pseudo-Ethernet/MACvlan interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=pseudo-ethernet --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-tunnel.xml.in b/op-mode-definitions/show-interfaces-tunnel.xml.in
index 416de0299..51b25efd9 100644
--- a/op-mode-definitions/show-interfaces-tunnel.xml.in
+++ b/op-mode-definitions/show-interfaces-tunnel.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="tunnel">
             <properties>
-              <help>Show tunnel interface information</help>
+              <help>Show specified Tunnel interface information</help>
               <completionHelp>
                 <path>interfaces tunnel</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="tunnel">
             <properties>
-              <help>Show tunnel interface information</help>
+              <help>Show Tunnel interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=tunnel --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-vti.xml.in b/op-mode-definitions/show-interfaces-vti.xml.in
index f51be2d19..b436b8414 100644
--- a/op-mode-definitions/show-interfaces-vti.xml.in
+++ b/op-mode-definitions/show-interfaces-vti.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="vti">
             <properties>
-              <help>Show vti interface information</help>
+              <help>Show specified VTI interface information</help>
               <completionHelp>
                 <path>interfaces vti</path>
               </completionHelp>
@@ -23,7 +23,7 @@
           </tagNode>
           <node name="vti">
             <properties>
-              <help>Show vti interface information</help>
+              <help>Show VTI interface information</help>
             </properties>
             <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=vti --action=show-brief</command>
             <children>
diff --git a/op-mode-definitions/show-interfaces-vxlan.xml.in b/op-mode-definitions/show-interfaces-vxlan.xml.in
index 4e3cb93cd..1befd428c 100644
--- a/op-mode-definitions/show-interfaces-vxlan.xml.in
+++ b/op-mode-definitions/show-interfaces-vxlan.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="vxlan">
             <properties>
-              <help>Show VXLAN interface information</help>
+              <help>Show specified VXLAN interface information</help>
               <completionHelp>
                 <path>interfaces vxlan</path>
               </completionHelp>
diff --git a/op-mode-definitions/show-interfaces-wireguard.xml.in b/op-mode-definitions/show-interfaces-wireguard.xml.in
new file mode 100644
index 000000000..c9b754dcd
--- /dev/null
+++ b/op-mode-definitions/show-interfaces-wireguard.xml.in
@@ -0,0 +1,66 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="show">
+    <children>
+      <node name="interfaces">
+        <children>
+          <tagNode name="wireguard">
+            <properties>
+              <help>Show specified WireGuard interface information</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py --type wireguard</script>
+              </completionHelp>
+            </properties>
+	        <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4"</command>
+            <children>
+              <leafNode name="allowed-ips">
+                <properties>
+                  <help>Show all IP addresses allowed for the specified interface</help>
+                </properties>
+                <command>sudo wg show "$4" allowed-ips</command>
+              </leafNode>
+              <leafNode name="endpoints">
+                <properties>
+                  <help>Show all endpoints for the specified interface</help>
+                </properties>
+                <command>sudo wg show "$4" endpoints</command>
+              </leafNode>
+              <leafNode name="peers">
+                <properties>
+                  <help>Show all peer IDs for the specified interface</help>
+                </properties>
+                <command>sudo wg show "$4" peers</command>
+              </leafNode>
+              <leafNode name="public-key">
+                <properties>
+                  <help>Show interface public-key</help>
+                </properties>
+                <command>sudo wg show "$4" public-key</command>
+              </leafNode>
+              <leafNode name="summary">
+                <properties>
+                  <help>Shows current configuration and device information</help>
+                </properties>
+                <command>sudo wg show "$4"</command>
+              </leafNode>
+            </children>
+          </tagNode>
+          <node name="wireguard">
+            <properties>
+              <help>Show WireGuard interface information</help>
+            </properties>
+            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireguard --action=show-brief</command>
+            <children>
+              <leafNode name="detail">
+                <properties>
+                  <help>Show detailed Wireguard interface information</help>
+                </properties>
+                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireguard --action=show</command>
+              </leafNode>
+            </children>
+          </node>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/op-mode-definitions/show-interfaces-wireless.xml.in b/op-mode-definitions/show-interfaces-wireless.xml.in
new file mode 100644
index 000000000..4a37417aa
--- /dev/null
+++ b/op-mode-definitions/show-interfaces-wireless.xml.in
@@ -0,0 +1,82 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="show">
+    <children>
+      <node name="interfaces">
+        <children>
+          <node name="wireless">
+            <properties>
+              <help>Show Wireless (WLAN) interface information</help>
+            </properties>
+            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireless --action=show-brief</command>
+            <children>
+              <leafNode name="detail">
+                <properties>
+                  <help>Show detailed wireless interface information</help>
+                </properties>
+                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireless --action=show</command>
+              </leafNode>
+              <leafNode name="info">
+                <properties>
+                  <help>Show wireless interface configuration</help>
+                </properties>
+                <command>${vyos_op_scripts_dir}/show_wireless.py --brief</command>
+              </leafNode>
+            </children>
+          </node>
+          <tagNode name="wireless">
+            <properties>
+              <help>Show specified wireless interface information</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py --type wireless</script>
+              </completionHelp>
+            </properties>
+            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4"</command>
+            <children>
+              <leafNode name="brief">
+                <properties>
+                  <help>Show summary of the specified wireless interface information</help>
+                </properties>
+                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4" --action=show-brief</command>
+              </leafNode>
+              <node name="scan">
+                <properties>
+                  <help>Show summary of the specified wireless interface information</help>
+                </properties>
+                <command>sudo ${vyos_op_scripts_dir}/show_wireless.py --scan "$4"</command>
+                <children>
+                  <leafNode name="detail">
+                    <properties>
+                      <help>Show detailed scan results</help>
+                    </properties>
+                    <command>sudo /sbin/iw dev "$4" scan ap-force</command>
+                  </leafNode>
+                </children>
+              </node>
+              <leafNode name="stations">
+                <properties>
+                  <help>Show specified Wireless interface information</help>
+                </properties>
+                <command>${vyos_op_scripts_dir}/show_wireless.py --stations "$4"</command>
+              </leafNode>
+              <tagNode name="vif">
+                <properties>
+                  <help>Show specified virtual network interface (vif) information</help>
+                </properties>
+                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4.$6"</command>
+                <children>
+                  <leafNode name="brief">
+                    <properties>
+                      <help>Show summary of specified virtual network interface (vif) information</help>
+                    </properties>
+                    <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4.$6" --action=show-brief</command>
+                  </leafNode>
+                </children>
+              </tagNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/op-mode-definitions/show-interfaces-wwan.xml.in b/op-mode-definitions/show-interfaces-wwan.xml.in
index 7e5f49ba6..3cd29b38a 100644
--- a/op-mode-definitions/show-interfaces-wwan.xml.in
+++ b/op-mode-definitions/show-interfaces-wwan.xml.in
@@ -6,7 +6,7 @@
         <children>
           <tagNode name="wwan">
             <properties>
-              <help>Show Wireless Wire Area Network (WWAN) interface information</help>
+              <help>Show specified Wireless Wire Area Network (WWAN) interface information</help>
               <completionHelp>
                 <path>interfaces wwan</path>
                 <script>cd /sys/class/net; ls -d wwan*</script>
diff --git a/op-mode-definitions/wireguard.xml.in b/op-mode-definitions/wireguard.xml.in
index 22b08002d..e2bc8a590 100644
--- a/op-mode-definitions/wireguard.xml.in
+++ b/op-mode-definitions/wireguard.xml.in
@@ -116,59 +116,6 @@
           </node>
         </children>
       </node>
-      <node name="interfaces">
-        <children>
-          <tagNode name="wireguard">
-            <properties>
-              <help>show wireguard interface information</help>
-              <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py --type wireguard</script>
-              </completionHelp>
-            </properties>
-	        <command>sudo ${vyos_op_scripts_dir}/wireguard.py --showinterface "$4"</command>
-            <children>
-              <leafNode name="allowed-ips">
-                <properties>
-                  <help>show all allowed-ips for the specified interface</help>
-                </properties>
-                <command>sudo wg show "$4" allowed-ips</command>
-              </leafNode>
-              <leafNode name="endpoints">
-                <properties>
-                  <help>show all endpoints for the specified interface</help>
-                </properties>
-                <command>sudo wg show "$4" endpoints</command>
-              </leafNode>
-              <leafNode name="peers">
-                <properties>
-                  <help>show all peer IDs for the specified interface</help>
-                </properties>
-                <command>sudo wg show "$4" peers</command>
-              </leafNode>
-              <leafNode name="summary">
-                <properties>
-                  <help>Shows current configuration and device information</help>
-                </properties>
-                <command>sudo wg show "$4"</command>
-              </leafNode>
-            </children>
-          </tagNode>
-          <node name="wireguard">
-            <properties>
-              <help>Show wireguard interface information</help>
-            </properties>
-            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireguard --action=show-brief</command>
-            <children>
-              <leafNode name="detail">
-                <properties>
-                  <help>Show detailed wireguard interface information</help>
-                </properties>
-                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireguard --action=show</command>
-              </leafNode>
-            </children>
-          </node>
-        </children>
-      </node>
     </children>
   </node>
   <node name="delete">
diff --git a/op-mode-definitions/wireless.xml.in b/op-mode-definitions/wireless.xml.in
index a3a9d1f55..5d9db1544 100644
--- a/op-mode-definitions/wireless.xml.in
+++ b/op-mode-definitions/wireless.xml.in
@@ -37,83 +37,4 @@
       </node>
     </children>
   </node>
-  <node name="show">
-    <children>
-      <node name="interfaces">
-        <children>
-          <node name="wireless">
-            <properties>
-              <help>Show wireless interface information</help>
-            </properties>
-            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireless --action=show-brief</command>
-            <children>
-              <leafNode name="detail">
-                <properties>
-                  <help>Show detailed wireless interface information</help>
-                </properties>
-                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=wireless --action=show</command>
-              </leafNode>
-              <leafNode name="info">
-                <properties>
-                  <help>Show wireless interface configuration</help>
-                </properties>
-                <command>${vyos_op_scripts_dir}/show_wireless.py --brief</command>
-              </leafNode>
-            </children>
-          </node>
-          <tagNode name="wireless">
-            <properties>
-              <help>Show specified wireless interface information</help>
-              <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py --type wireless</script>
-              </completionHelp>
-            </properties>
-            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4"</command>
-            <children>
-              <leafNode name="brief">
-                <properties>
-                  <help>Show summary of the specified wireless interface information</help>
-                </properties>
-                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4" --action=show-brief</command>
-              </leafNode>
-              <node name="scan">
-                <properties>
-                  <help>Show summary of the specified wireless interface information</help>
-                </properties>
-                <command>sudo ${vyos_op_scripts_dir}/show_wireless.py --scan "$4"</command>
-                <children>
-                  <leafNode name="detail">
-                    <properties>
-                      <help>Show detailed scan results</help>
-                    </properties>
-                    <command>sudo /sbin/iw dev "$4" scan ap-force</command>
-                  </leafNode>
-                </children>
-              </node>
-              <leafNode name="stations">
-                <properties>
-                  <help>Show specified wireless interface information</help>
-                </properties>
-                <command>${vyos_op_scripts_dir}/show_wireless.py --stations "$4"</command>
-              </leafNode>
-              <tagNode name="vif">
-                <properties>
-                  <help>Show specified virtual network interface (vif) information</help>
-                </properties>
-                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4.$6"</command>
-                <children>
-                  <leafNode name="brief">
-                    <properties>
-                      <help>Show summary of specified virtual network interface (vif) information</help>
-                    </properties>
-                    <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4.$6" --action=show-brief</command>
-                  </leafNode>
-                </children>
-              </tagNode>
-            </children>
-          </tagNode>
-        </children>
-      </node>
-    </children>
-  </node>
 </interfaceDefinition>
-- 
cgit v1.2.3