PowerShell Logo Small

Get-VpnConnection



This is the built-in help made by Microsoft for the command 'Get-VpnConnection', in PowerShell version 4 - as retrieved from Windows version 'Microsoft Windows 8.1 Enterprise' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Retrieves the specified VPN connection profile information.

SYNTAX


Get-VpnConnection [[-Name] <String[]>] [-AllUserConnection] [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Get-VpnConnection cmdlet retrieves the specified VPN connection profile and its properties. If you do not specify a profile name, the cmdlet returns a list of all
VPN connections in the phone book.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=290779
Add-VpnConnection
Set-VpnConnection
Remove-VpnConnection
New-EapConfiguration

REMARKS

<

Examples


Example 1: Get all available VPN connections

PS C:\> Get-VpnConnection
Name : Test1
ServerAddress : 10.1.1.2
AllUserConnection : False
Guid : {65EA2A6D-60A5-49DA-AEDF-5542171D3794}
TunnelType : Automatic
AuthenticationMethod : {MsChapv2}
EncryptionLevel : Required
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream :
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : False
SplitTunneling : False
DnsSuffix :
IdleDisconnectSeconds : 0

Name : Test6
ServerAddress : 10.1.1.1
AllUserConnection : False
Guid : {03D226D4-3EBF-4B67-9618-4E310AD3FE87}
TunnelType : Ikev2
AuthenticationMethod : {MachineCertificate}
EncryptionLevel : Required
L2tpIPsecAuth :
UseWinlogonCredential : False
EapConfigXmlStream :
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : False
SplitTunneling : False
DnsSuffix :
IdleDisconnectSeconds : 0

Name : Test7
ServerAddress : Washington
AllUserConnection : False
Guid : {671F26F9-7C5C-44B2-8271-BD2005FCE702}
TunnelType : Automatic
AuthenticationMethod : {MsChapv2}
EncryptionLevel : Required
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream :
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : False
SplitTunneling : False
DnsSuffix :
IdleDisconnectSeconds : 0



This command returns a list of all available VPN connections in the user's local phone book.




Example 2: Get all available VPN connections from the global phonebook

PS C:\>Get-VpnConnection -AllUserConnection
Name : Test5
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {CF59A4C3-57DB-41FA-9793-D0C785756ABD}
TunnelType : L2tp
AuthenticationMethod : {Eap}
EncryptionLevel : Required
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream : #document
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : True
SplitTunneling : True
DnsSuffix :
IdleDisconnectSeconds : 0

Name : Test3
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {E37453AF-EE0B-4DD8-9AC0-30B262B0CA74}
TunnelType : L2tp
AuthenticationMethod : {Pap}
EncryptionLevel : Optional
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream :
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : False
SplitTunneling : False
DnsSuffix : washington.contoso.com
IdleDisconnectSeconds : 600

Name : Test4
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {C5D5579E-FF9D-4F31-ABE1-B26AB38107CD}
TunnelType : L2tp
AuthenticationMethod : {Eap}
EncryptionLevel : Required
L2tpIPsecAuth : Psk
UseWinlogonCredential : False
EapConfigXmlStream : #document
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : True
SplitTunneling : True
DnsSuffix :
IdleDisconnectSeconds : 0



This command retrieves all the available VPN connections from the global phone book.




Example 3: Get a specific VPN connection from the global phone book

PS C:\>Get-VpnConnection -Name "Test3" –AllUserConnection
Name : Test3
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {E37453AF-EE0B-4DD8-9AC0-30B262B0CA74}
TunnelType : L2tp
AuthenticationMethod : {Pap}
EncryptionLevel : Optional
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream :
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : False
SplitTunneling : False
DnsSuffix : washington.contoso.com
IdleDisconnectSeconds : 600



This command retrieves the VPN connection named Test3 from the global phone book.




Example 4: Get multiple VPN connections

PS C:\>Get-VpnConnection -Name "Test3", "Test4", "test5" –AllUserConnection
Name : Test3
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {E37453AF-EE0B-4DD8-9AC0-30B262B0CA74}
TunnelType : L2tp
AuthenticationMethod : {Pap}
EncryptionLevel : Optional
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream :
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : False
SplitTunneling : False
DnsSuffix : washington.contoso.com
IdleDisconnectSeconds : 600

Name : Test4
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {C5D5579E-FF9D-4F31-ABE1-B26AB38107CD}
TunnelType : L2tp
AuthenticationMethod : {Eap}
EncryptionLevel : Required
L2tpIPsecAuth : Psk
UseWinlogonCredential : False
EapConfigXmlStream : #document
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : True
SplitTunneling : True
DnsSuffix :
IdleDisconnectSeconds : 0

Name : test5
ServerAddress : 10.1.1.1
AllUserConnection : True
Guid : {CF59A4C3-57DB-41FA-9793-D0C785756ABD}
TunnelType : L2tp
AuthenticationMethod : {Eap}
EncryptionLevel : Required
L2tpIPsecAuth : Certificate
UseWinlogonCredential : False
EapConfigXmlStream : #document
ConnectionStatus : Disconnected
NapState : NotConnected
RememberCredential : True
SplitTunneling : True
DnsSuffix :
IdleDisconnectSeconds : 0



This command retrieves multiple specified VPN connections from the global phone book.