PowerShell/Docs/check-vpn.md

69 lines
1.4 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*check-vpn.ps1*
================
2021-12-09 16:19:09 +01:00
2023-07-29 09:45:37 +02:00
This PowerShell script queries and prints the status of the VPN connection(s).
2021-12-09 16:19:09 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-12-09 16:19:09 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./check-vpn.ps1 [<CommonParameters>]
2021-12-09 16:19:09 +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
-------
2021-12-09 16:19:09 +01:00
```powershell
2023-07-29 09:45:37 +02:00
PS> ./check-vpn.ps1
✅ VPN to NASA L2TP is disconnected
2021-12-09 16:19:09 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-12-09 16:19:09 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-12-09 16:19:09 +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
2023-05-26 12:20:18 +02:00
Checks the VPN status
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-07-29 09:45:37 +02:00
This PowerShell script queries and prints the status of the VPN connection(s).
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-07-29 09:45:37 +02:00
PS> ./check-vpn.ps1
✅ VPN to NASA L2TP is disconnected
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
$NoVPN = $true
if ($IsLinux) {
# TODO
} else {
2023-05-26 12:20:18 +02:00
$Connections = Get-VPNConnection
2022-11-17 20:02:26 +01:00
foreach($Connection in $Connections) {
2023-07-29 09:45:37 +02:00
Write-Host "✅ VPN to $($Connection.Name) is $($Connection.ConnectionStatus.ToLower())"
2022-11-17 20:02:26 +01:00
$NoVPN = $false
}
}
2023-07-29 09:45:37 +02:00
if ($NoVPN) { Write-Host "⚠️ No VPN configured" }
2022-11-17 20:02:26 +01:00
exit 0 # success
} 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 check-vpn.ps1 as of 08/06/2023 21:36:06)*