PowerShell/Docs/disconnect-vpn.md

67 lines
1.5 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*disconnect-vpn.ps1*
================
2022-11-17 19:46:02 +01:00
This PowerShell script disconnects the active VPN connection.
2023-07-29 10:04:38 +02:00
Parameters
----------
2022-11-17 19:46:02 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./disconnect-vpn.ps1 [<CommonParameters>]
2022-11-17 19:46:02 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2022-11-17 19:46:02 +01:00
```powershell
2023-08-06 21:36:33 +02:00
PS> ./disconnect-vpn.ps1
Disconnected now.
2022-11-17 19:46:02 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2023-07-29 10:04:38 +02:00
Related Links
-------------
2022-11-17 19:46:02 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Disconnects the VPN
.DESCRIPTION
This PowerShell script disconnects the active VPN connection.
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./disconnect-vpn.ps1
Disconnected now.
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
$Connections = (Get-VPNConnection)
foreach($Connection in $Connections) {
if ($Connection.ConnectionStatus -ne "Connected") { continue }
"Disconnecting $($Connection.Name)..."
& rasdial.exe "$($Connection.Name)" /DISCONNECT
if ($lastExitCode -ne "0") { throw "Disconnect failed with exit code $lastExitCode" }
"Disconnected now."
exit 0 # success
}
throw "No VPN connection found."
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-08-06 21:36:33 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of disconnect-vpn.ps1 as of 08/06/2023 21:36:07)*