From d8cae2006095d55bcd7e4e1fcecf325da30f8420 Mon Sep 17 00:00:00 2001 From: currite Date: Wed, 28 Oct 2020 20:57:10 +0100 Subject: openvpn: add troubleshooting subsection --- docs/vpn/openvpn.rst | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) 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 ``"`` 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 + + Use this command to reset specified OpenVPN client. + +.. opcmd:: reset openvpn interface + + Uset this command to reset the OpenVPN process on a specific interface. + + + .. include:: ../common-references.rst -- cgit v1.2.3 From bf45f93b030284029014cba99b722253a29ccd6b Mon Sep 17 00:00:00 2001 From: currite <53279076+currite@users.noreply.github.com> Date: Wed, 28 Oct 2020 21:25:01 +0100 Subject: Update openvpn.rst --- docs/vpn/openvpn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vpn/openvpn.rst b/docs/vpn/openvpn.rst index b9f5433b..c6934335 100644 --- a/docs/vpn/openvpn.rst +++ b/docs/vpn/openvpn.rst @@ -569,7 +569,7 @@ The following commands let you check tunnel status. Reset OpenVPN ------------- -The following commands let you reset OpenVPN for a specific client or interface. +The following commands let you reset OpenVPN. .. opcmd:: reset openvpn client -- cgit v1.2.3