summaryrefslogtreecommitdiff
path: root/docs/vpn/openvpn.rst
diff options
context:
space:
mode:
authorcurrite <sll@disroot.org>2020-10-28 20:57:10 +0100
committercurrite <sll@disroot.org>2020-10-28 20:57:10 +0100
commitd8cae2006095d55bcd7e4e1fcecf325da30f8420 (patch)
treeaa0744e631b6e0dea4b75f84a9fe6c261fbb0717 /docs/vpn/openvpn.rst
parentd590dc5b3e3c1131e0ed754f35e92b0771d6eec3 (diff)
downloadvyos-documentation-d8cae2006095d55bcd7e4e1fcecf325da30f8420.tar.gz
vyos-documentation-d8cae2006095d55bcd7e4e1fcecf325da30f8420.zip
openvpn: add troubleshooting subsection
Diffstat (limited to 'docs/vpn/openvpn.rst')
-rw-r--r--docs/vpn/openvpn.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/vpn/openvpn.rst b/docs/vpn/openvpn.rst
index fd6a3a71..b9f5433b 100644
--- a/docs/vpn/openvpn.rst
+++ b/docs/vpn/openvpn.rst
@@ -542,4 +542,43 @@ Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file.
quotes. This is done through a hack on our config generator. You can pass
quotes using the ``&quot;`` statement.
+
+Troubleshooting
+===============
+
+VyOS provides some operational commands on OpenVPN.
+
+Check status
+------------
+
+The following commands let you check tunnel status.
+
+.. opcmd:: show openvpn client
+
+ Use this command to check the tunnel status for OpenVPN client interfaces.
+
+.. opcmd:: show openvpn server
+
+ Use this command to check the tunnel status for OpenVPN server interfaces.
+
+.. opcmd:: show openvpn site-to-site
+
+ Use this command to check the tunnel status for OpenVPN site-to-site interfaces.
+
+
+Reset OpenVPN
+-------------
+
+The following commands let you reset OpenVPN for a specific client or interface.
+
+.. opcmd:: reset openvpn client <text>
+
+ Use this command to reset specified OpenVPN client.
+
+.. opcmd:: reset openvpn interface <interface>
+
+ Uset this command to reset the OpenVPN process on a specific interface.
+
+
+
.. include:: ../common-references.rst