summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-10-30 09:31:40 +0100
committerGitHub <noreply@github.com>2020-10-30 09:31:40 +0100
commitcdb3bceacdb664b8a8e40f8881273d68ba030e2c (patch)
tree3e27faf749fbaf9df68af79cf70a3e330a13b2f0
parent5b2cde1eaa46968a32e1c84bc9dd4b239b0020b6 (diff)
parentbf45f93b030284029014cba99b722253a29ccd6b (diff)
downloadvyos-documentation-cdb3bceacdb664b8a8e40f8881273d68ba030e2c.tar.gz
vyos-documentation-cdb3bceacdb664b8a8e40f8881273d68ba030e2c.zip
Merge pull request #356 from currite/openvpn-troubleshooting
openvpn: add troubleshooting subsection
-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..c6934335 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.
+
+.. 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