PowerShell/docs/disconnect-vpn.md
2024-03-27 17:36:59 +01:00

67 lines
1.5 KiB
Markdown

Script: *disconnect-vpn.ps1*
========================
This PowerShell script disconnects the active VPN connection.
Parameters
----------
```powershell
PS> ./disconnect-vpn.ps1 [<CommonParameters>]
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./disconnect-vpn.ps1
Disconnected now.
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Disconnects the VPN
.DESCRIPTION
This PowerShell script disconnects the active VPN connection.
.EXAMPLE
PS> ./disconnect-vpn.ps1
Disconnected now.
.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
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of disconnect-vpn.ps1 as of 03/27/2024 17:36:26)*