From 36adc975316b8511c53c813b7542196e3d2779a8 Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Mon, 23 Jan 2023 17:45:20 +0100
Subject: op-mode: T4952: improve interface completion helper CLI experience

There are currently two ways to generate the interface name completion helper
list (we use openvpn in this example)

- <script> ${vyos_completion_dir}/list_interfaces.py --type openvpn</script>
- <path>interfaces openvpn</path>

The first one using <script> tends to be rather slow as there is a Python
interpreter startup involved (expensive). The latter simply calls a C program
which is executed rather fast and gives the same result.

We can simply replace the first call with the second one to make the CLI
feel faster.
---
 op-mode-definitions/generate-openvpn-config-client.xml.in | 2 +-
 op-mode-definitions/generate-wireguard.xml.in             | 2 +-
 op-mode-definitions/ipv6-route.xml.in                     | 2 +-
 op-mode-definitions/openvpn.xml.in                        | 4 ++--
 op-mode-definitions/show-arp.xml.in                       | 2 +-
 op-mode-definitions/show-bridge.xml.in                    | 2 +-
 op-mode-definitions/show-interfaces-wireguard.xml.in      | 2 +-
 op-mode-definitions/show-interfaces-wireless.xml.in       | 2 +-
 op-mode-definitions/show-ip.xml.in                        | 2 +-
 op-mode-definitions/show-protocols.xml.in                 | 2 +-
 op-mode-definitions/wireless.xml.in                       | 2 +-
 11 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'op-mode-definitions')

diff --git a/op-mode-definitions/generate-openvpn-config-client.xml.in b/op-mode-definitions/generate-openvpn-config-client.xml.in
index 4f9f31bfe..baec0842b 100644
--- a/op-mode-definitions/generate-openvpn-config-client.xml.in
+++ b/op-mode-definitions/generate-openvpn-config-client.xml.in
@@ -16,7 +16,7 @@
                 <properties>
                   <help>Local interface used for connection</help>
                   <completionHelp>
-                    <script>${vyos_completion_dir}/list_interfaces.py --type openvpn</script>
+                    <path>interfaces openvpn</path>
                   </completionHelp>
                 </properties>
                 <children>
diff --git a/op-mode-definitions/generate-wireguard.xml.in b/op-mode-definitions/generate-wireguard.xml.in
index 0ef983cd2..6c01619be 100644
--- a/op-mode-definitions/generate-wireguard.xml.in
+++ b/op-mode-definitions/generate-wireguard.xml.in
@@ -19,7 +19,7 @@
                 <properties>
                   <help>Local interface used for connection</help>
                   <completionHelp>
-                    <script>${vyos_completion_dir}/list_interfaces.py --type wireguard</script>
+                    <path>interfaces wireguard</path>
                   </completionHelp>
                 </properties>
                 <children>
diff --git a/op-mode-definitions/ipv6-route.xml.in b/op-mode-definitions/ipv6-route.xml.in
index d75caf308..46e416a8a 100644
--- a/op-mode-definitions/ipv6-route.xml.in
+++ b/op-mode-definitions/ipv6-route.xml.in
@@ -26,7 +26,7 @@
                 <properties>
                   <help>Show IPv6 neighbor table for specified interface</help>
                   <completionHelp>
-                    <script>${vyos_completion_dir}/list_interfaces.py -b</script>
+                    <script>${vyos_completion_dir}/list_interfaces.py --broadcast</script>
                   </completionHelp>
                 </properties>
                 <command>${vyos_op_scripts_dir}/neighbor.py show --family inet6 --interface "$5"</command>
diff --git a/op-mode-definitions/openvpn.xml.in b/op-mode-definitions/openvpn.xml.in
index b2763da81..0a2657398 100644
--- a/op-mode-definitions/openvpn.xml.in
+++ b/op-mode-definitions/openvpn.xml.in
@@ -20,7 +20,7 @@
             <properties>
               <help>Reset OpenVPN process on interface</help>
               <completionHelp>
-                <script>sudo ${vyos_completion_dir}/list_interfaces.py --type openvpn</script>
+                <path>interfaces openvpn</path>
               </completionHelp>
             </properties>
             <command>sudo ${vyos_op_scripts_dir}/openvpn.py reset --interface $4</command>
@@ -51,7 +51,7 @@
             <properties>
               <help>Show OpenVPN interface information</help>
               <completionHelp>
-                <script>sudo ${vyos_completion_dir}/list_interfaces.py --type openvpn</script>
+                <path>interfaces openvpn</path>
               </completionHelp>
             </properties>
             <command>${vyos_op_scripts_dir}/interfaces.py show --intf_name=$4</command>
diff --git a/op-mode-definitions/show-arp.xml.in b/op-mode-definitions/show-arp.xml.in
index 8662549fc..3680c20c6 100644
--- a/op-mode-definitions/show-arp.xml.in
+++ b/op-mode-definitions/show-arp.xml.in
@@ -12,7 +12,7 @@
             <properties>
               <help>Show Address Resolution Protocol (ARP) cache for specified interface</help>
               <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py -b</script>
+                <script>${vyos_completion_dir}/list_interfaces.py --broadcast</script>
               </completionHelp>
             </properties>
             <command>${vyos_op_scripts_dir}/neighbor.py show --family inet --interface "$4"</command>
diff --git a/op-mode-definitions/show-bridge.xml.in b/op-mode-definitions/show-bridge.xml.in
index dd2a28931..e7a646fdc 100644
--- a/op-mode-definitions/show-bridge.xml.in
+++ b/op-mode-definitions/show-bridge.xml.in
@@ -25,7 +25,7 @@
         <properties>
           <help>Show bridge information for a given bridge interface</help>
           <completionHelp>
-            <script>${vyos_completion_dir}/list_interfaces.py --type bridge</script>
+            <path>interfaces bridge</path>
           </completionHelp>
         </properties>
         <command>bridge -c link show | grep "master $3"</command>
diff --git a/op-mode-definitions/show-interfaces-wireguard.xml.in b/op-mode-definitions/show-interfaces-wireguard.xml.in
index eba8de568..75b0cc88e 100644
--- a/op-mode-definitions/show-interfaces-wireguard.xml.in
+++ b/op-mode-definitions/show-interfaces-wireguard.xml.in
@@ -8,7 +8,7 @@
             <properties>
               <help>Show specified WireGuard interface information</help>
               <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py --type wireguard</script>
+                <path>interfaces wireguard</path>
               </completionHelp>
             </properties>
 	        <command>${vyos_op_scripts_dir}/interfaces.py show --intf_name="$4" --intf_type=wireguard</command>
diff --git a/op-mode-definitions/show-interfaces-wireless.xml.in b/op-mode-definitions/show-interfaces-wireless.xml.in
index b0a272225..cdd591f82 100644
--- a/op-mode-definitions/show-interfaces-wireless.xml.in
+++ b/op-mode-definitions/show-interfaces-wireless.xml.in
@@ -28,7 +28,7 @@
             <properties>
               <help>Show specified wireless interface information</help>
               <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py --type wireless</script>
+                <path>interfaces wireless</path>
               </completionHelp>
             </properties>
             <command>${vyos_op_scripts_dir}/interfaces.py show --intf_name="$4" --intf_type=wireless</command>
diff --git a/op-mode-definitions/show-ip.xml.in b/op-mode-definitions/show-ip.xml.in
index 0751c50cb..a710e33d2 100644
--- a/op-mode-definitions/show-ip.xml.in
+++ b/op-mode-definitions/show-ip.xml.in
@@ -17,7 +17,7 @@
                 <properties>
                   <help>Show IPv4 neighbor table for specified interface</help>
                   <completionHelp>
-                    <script>${vyos_completion_dir}/list_interfaces.py -b</script>
+                    <script>${vyos_completion_dir}/list_interfaces.py --broadcast</script>
                   </completionHelp>
                 </properties>
                 <command>${vyos_op_scripts_dir}/neighbor.py show --family inet --interface "$5"</command>
diff --git a/op-mode-definitions/show-protocols.xml.in b/op-mode-definitions/show-protocols.xml.in
index 698001b76..27146f90d 100644
--- a/op-mode-definitions/show-protocols.xml.in
+++ b/op-mode-definitions/show-protocols.xml.in
@@ -22,7 +22,7 @@
                     <properties>
                       <help>Show Address Resolution Protocol (ARP) cache for specified interface</help>
                       <completionHelp>
-                        <script>${vyos_completion_dir}/list_interfaces.py -b</script>
+                        <script>${vyos_completion_dir}/list_interfaces.py --broadcast</script>
                       </completionHelp>
                     </properties>
                     <command>/usr/sbin/arp -e -n -i "$6"</command>
diff --git a/op-mode-definitions/wireless.xml.in b/op-mode-definitions/wireless.xml.in
index 5d9db1544..f8e53ad21 100644
--- a/op-mode-definitions/wireless.xml.in
+++ b/op-mode-definitions/wireless.xml.in
@@ -21,7 +21,7 @@
             <properties>
               <help>Clear interface information for a given wireless interface</help>
               <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py --type wireless</script>
+                <path>interfaces wireless</path>
               </completionHelp>
             </properties>
             <children>
-- 
cgit v1.2.3