summaryrefslogtreecommitdiff
path: root/op-mode-definitions/show-interfaces-wireguard.xml.in
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-09-07 11:26:42 +0200
committerChristian Poessinger <christian@poessinger.com>2021-09-07 11:48:14 +0200
commitff25cb35c93e464acb7c18d329323ba841311abe (patch)
tree65721a9d1883a3d2fc7b8a9054d11c7d10c6a8e9 /op-mode-definitions/show-interfaces-wireguard.xml.in
parentd9f20383323a9dbebcef4d4393f692dff716700c (diff)
downloadvyos-1x-ff25cb35c93e464acb7c18d329323ba841311abe.tar.gz
vyos-1x-ff25cb35c93e464acb7c18d329323ba841311abe.zip
op-mode: xml: improve "show interfaces <type>" help text
(cherry picked from commit bd2c79ebb8abbd844f4b0568110c7bcea0d8f4f1)
Diffstat (limited to 'op-mode-definitions/show-interfaces-wireguard.xml.in')
-rw-r--r--op-mode-definitions/show-interfaces-wireguard.xml.in66
1 files changed, 66 insertions, 0 deletions
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>