The Get-VpnConnection PowerShell command is a powerful tool used to manage virtual private networks (VPNs) on Windows computers. It can be used to view, create, and delete VPN connections, as well as to configure and manage existing ones. With the Get-VpnConnection command, you can easily manage your VPN connections from the command line, without having to use the graphical user interface (GUI).
Syntax
The syntax for the Get-VpnConnection command is as follows:
Get-VpnConnection [-Name] <String> [-AllUserConnection] [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-ThrottleLimit <Int32>] [-AsJob] [-AuthenticationMethod <AuthenticationMethod[]>] [-ConnectionStatus <VpnConnectionStatus[]>] [-PassThru] [-ServerAddress <String[]>] [ <CommonParameters>]
Parameters
The Get-VpnConnection command has the following parameters:
| Parameter | Description |
|---|---|
| Name | The name of the VPN connection. |
| AllUserConnection | Specifies that all user connections should be retrieved. |
| CimSession | Specifies the CIM session to use. |
| ComputerName | Specifies the name of the computer to use. |
| ThrottleLimit | Specifies the maximum number of concurrent operations that can be established to run the cmdlet. |
| AsJob | Runs the cmdlet as a background job. |
| AuthenticationMethod | Specifies the authentication method used for the VPN connection. |
| ConnectionStatus | Specifies the status of the VPN connection. |
| PassThru | Specifies that the output should be returned. |
| ServerAddress | Specifies the address of the VPN server. |
Inputs
The Get-VpnConnection command does not accept any input.
Outputs
The Get-VpnConnection command returns a VpnConnection object.
Examples
The following example shows how to use the Get-VpnConnection command to view all user connections:
Get-VpnConnection -AllUserConnection
The following example shows how to use the Get-VpnConnection command to view the status of a specific VPN connection:
Get-VpnConnection -Name “MyVPN” -ConnectionStatus
Tips
Here are some tips for using the Get-VpnConnection command:
- Use the Name parameter to specify the name of the VPN connection.
- Use the AllUserConnection parameter to view all user connections.
- Use the CimSession parameter to specify the CIM session to use.
- Use the ComputerName parameter to specify the name of the computer to use.
- Use the ThrottleLimit parameter to specify the maximum number of concurrent operations that can be established to run the cmdlet.
- Use the AsJob parameter to run the cmdlet as a background job.
- Use the AuthenticationMethod parameter to specify the authentication method used for the VPN connection.
- Use the ConnectionStatus parameter to specify the status of the VPN connection.
- Use the PassThru parameter to specify that the output should be returned.
- Use the ServerAddress parameter to specify the address of the VPN server.
Conclusion
The Get-VpnConnection command is a powerful tool for managing VPN connections on Windows computers. It can be used to view, create, and delete VPN connections, as well as to configure and manage existing ones. With the Get-VpnConnection command, you can easily manage your VPN connections from the command line, without having to use the graphical user interface (GUI).