summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-10-30 09:31:51 +0100
committerGitHub <noreply@github.com>2020-10-30 09:31:51 +0100
commit8a54487119332946d900ed5240d1d87a8103e6a2 (patch)
tree24a86cc30055a0431c5440655769284cc5b94a30 /docs
parent56f028430031bdcb9a8598cb65a8c1745e02d47e (diff)
parent79b06761cf4e03c15f9618272949bf91a45ec8c9 (diff)
downloadvyos-documentation-8a54487119332946d900ed5240d1d87a8103e6a2.tar.gz
vyos-documentation-8a54487119332946d900ed5240d1d87a8103e6a2.zip
Merge pull request #357 from currite/crux-openvpn-troubleshooting
openvpn: add troubleshooting subsection
Diffstat (limited to 'docs')
-rw-r--r--docs/vpn/openvpn.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/vpn/openvpn.rst b/docs/vpn/openvpn.rst
index ce7dcc44..1462e202 100644
--- a/docs/vpn/openvpn.rst
+++ b/docs/vpn/openvpn.rst
@@ -427,3 +427,41 @@ options to OpenVPN.
Will add `persistent-key` at the end of the generated OpenVPN configuration.
Please use this only as last resort - things might break and OpenVPN won't start
if you pass invalid options/syntax.
+
+Troubleshooting
+===============
+
+VyOS provides some operational commands on OpenVPN.
+
+Check status
+------------
+
+The following commands let you check tunnel status.
+
+.. opcmd:: show openvpn client status
+
+ Use this command to check the tunnel status for OpenVPN client.
+
+.. opcmd:: show openvpn server status
+
+ Use this command to check the tunnel status for OpenVPN server.
+
+.. opcmd:: show openvpn site-to-site status
+
+ Use this command to check the tunnel status for OpenVPN site-to-site.
+
+
+Reset OpenVPN
+-------------
+
+The following commands let you reset OpenVPN.
+
+.. 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.
+
+