Add-VpnConnection

Adds a VPN connection to the Connection Manager phone book.

Syntax

Add-VpnConnection
   [-RememberCredential]
   [-UseWinlogonCredential]
   [[-EapConfigXmlStream] <XmlDocument>]
   [-Name] <String>
   [-ServerAddress] <String>
   [[-TunnelType] <String>]
   [[-EncryptionLevel] <String>]
   [[-AuthenticationMethod] <String[]>]
   [-SplitTunneling]
   [-AllUserConnection]
   [[-L2tpPsk] <String>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Force]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-Confirm]
   [-WhatIf]

Description

The Add-VpnConnection cmdlet adds a VPN connection with the specified parameters to the Connection Manager phone book. If errors occur when you create the VPN profile, the error information is returned.

Examples

EXAMPLExample 1: Add a VPN connectionxample: Add a VPN connection

PS C:\> Add-VpnConnection -Name "Test1" -ServerAddress "10.1.1.1" -PassThru
Name                  : Test1
ServerAddress         : 10.1.1.1
AllUserConnection     : False 
Guid                  : {4B308E9B-C225-42CB-8158-307193429591}
TunnelType            : Automatic
AuthenticationMethod  : {MsChapv2}
EncryptionLevel       : Required 
L2tpIPsecAuth         : Certificate
UseWinlogonCredential : False
EapConfigXmlStream    : 
ConnectionStatus      : Disconnected
NapState              : NotConnected 
RememberCredential    : False 
SplitTunneling        : False

This command adds a VPN connection named Test1 to the server with an IP address 10.1.1.1. By specifying the Passthru parameter, you can see the configuration of the VPN connection object.

Example 2: Add a VPN connection with an alternate authentication method

PS C:\>Add-VpnConnection -Name "Test3" -ServerAddress "10.1.1.1" -TunnelType Pptp -EncryptionLevel Required -AuthenticationMethod MSChapv2 -UseWinlogonCredential -SplitTunneling -AllUserConnection  -RememberCredential -PassThru

Name                  : Test3 
ServerAddress         : 10.1.1.1 
AllUserConnection     : True 
Guid                  : {76746D4E-D72A-467D-A11F-3D4D9075F50D} 
TunnelType            : Pptp 
AuthenticationMethod  : {MsChapv2} 
EncryptionLevel       : Required 
L2tpIPsecAuth         : 
UseWinlogonCredential : True 
EapConfigXmlStream    : 
ConnectionStatus      : Disconnected 
NapState              : NotConnected 
RememberCredential    : True 
SplitTunneling        : True

This command adds a VPN connection named Test3 to the server with an IP address 10.1.1.1. This connection uses the MSCHAPv2 authentication method, as specified by the AuthenticationMethod parameter. Additional parameters specify that the connection:

  • Uses the Windows logon credentials (the UseWinlogonCredential parameter)
  • Uses split tunneling (the SplitTunneling parameter)
  • Is stored in the global phone book (the AllUserConnection parameter) -- Caches the credentials used for the first successful connection (the RememberCredential parameter)

By specifying the Passthru parameter, you can see the configuration of the VPN connection object.

EXAMPLE 3

PS C:\>Add-VpnConnection -Name "Test4" -ServerAddress "10.1.1.1" -TunnelType L2tp -EncryptionLevel Required -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -L2tpPsk "password" -Force -RememberCredential -PassThru

Name                  : Test4 
ServerAddress         : 10.1.1.1 
AllUserConnection     : True 
Guid                  : {1D423FF3-E3D4-404A-B052-DB9130656D29} 
TunnelType            : L2tp 
AuthenticationMethod  : {Eap} 
EncryptionLevel       : Required 
L2tpIPsecAuth         : Psk 
UseWinlogonCredential : False 
EapConfigXmlStream    : #document 
ConnectionStatus      : Disconnected 
NapState              : NotConnected 
RememberCredential    : True 
SplitTunneling        : True

This command adds a VPN connection named Test4 to the server with an IP address of 10.1.1.1. This connection uses the default EAP authentication method, as specified by the AuthenticationMethod parameter. The pre-shared key for the connection, password, is specified by the L2tpPsk parameter Additional parameters specify that the connection:

  • Uses split tunneling (the SplitTunneling parameter)
  • Is stored in the global phone book (the AllUserConnection parameter)
  • Caches the credentials used for the first successful connection (the RememberCredential parameter)

By specifying the Passthru parameter, you can see the configuration of the VPN connection object.

EXAMPLE 4

This command stores the result of the New-EapConfiguration cmdlet into the variable named $a.
PS C:\>$a = New-EapConfiguration



This command adds a new VPN connection named Test5 to the server with an IP address of 10.1.1.1. This connection is configured to use the custom EAP authentication method specifying the **EapConfigXmlStream** parameter, and using the **EapConfigXmlStream** method of the $a variable created earlier. Additional parameters specify that the connection: 

-- Uses split tunneling (the **SplitTunneling** parameter) 
-- Is stored in the global phone book (the **AllUserConnection** parameter)  
-- Caches the credentials used for the first successful connection (the **RememberCredential** parameter)By specifying the **Passthru** parameter, you can see the configuration of the VPN connection object.
PS C:\>Add-VpnConnection -Name "Test5" -ServerAddress "10.1.1.1" -TunnelType L2tp -EncryptionLevel Required -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $a.EapConfigXmlStream -PassThru

Name                  : Test5 
ServerAddress         : 10.1.1.1 
AllUserConnection     : True 
Guid                  : {CF9F624F-D7DF-48BA-BD4B-D4E34AE05148} 
TunnelType            : L2tp 
AuthenticationMethod  : {Eap} 
EncryptionLevel       : Required 
L2tpIPsecAuth         : Certificate 
UseWinlogonCredential : False 
EapConfigXmlStream    : #document 
ConnectionStatus      : Disconnected 
NapState              : NotConnected 
RememberCredential    : True 
SplitTunneling        : True

This set of commands adds a VPN connection using a custom EAP authentication method. For more information about custom EAP authentication methods, see the New-EapConfiguration cmdlet.

Required Parameters

-Name

Specifies the name of this VPN connection profile.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerAddress

Specifies the address of the remote VPN server to which the client connects. You can specify the address as a URL, an IPv4 address, or an IPv6 address.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AllUserConnection

Indicates that the VPN connection is added to the global phone book entries.

Type:SwitchParameter
Position:8
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AuthenticationMethod

Specifies the authentication method to use for the VPN connection. The acceptable values for this parameter are:PAP, CHAP, MSCHAPv2, or EAP.

Type:String[]
Position:6
Default value:MSChapv2
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-EapConfigXmlStream

Specifies the contents of the EAP XML configuration file, which includes the EAP method identifier (ID).

Type:XmlDocument
Position:12
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EncryptionLevel

Specifies the encryption level for the VPN connection. The acceptable values for this parameter are:NoEncryption, Optional, Required and Maximum.

Type:String
Position:5
Default value:Required
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Force

Indicates that the pre-shared key (PSK) value is supplied over an insecure channel, if L2TP is used,

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-L2tpPsk

Specifies the value of the PSK to be used for L2TP authentication. If this parameter is not specified, a certificate is used for L2TP.

Type:String
Position:9
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RememberCredential

Indicates that the credentials supplied at the time of first successful connection are stored in the cache.

Type:SwitchParameter
Position:10
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SplitTunneling

Indicates that split tunneling is enabled for this VPN connection profile. If you do not specify this parameter, split tunneling is disabled.

Type:SwitchParameter
Position:7
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TunnelType

Specifies the type of tunnel used for the VPN connection. The acceptable values for this parameter are:PPTP, L2TP, SSTP, IKEv2, or Automatic.

Type:String
Position:4
Default value:Automatic
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-UseWinlogonCredential

Indicates that MSCHAPv2 is used as the authentication method, and that Windows logon credentials are used automatically when connecting with this VPN connection profile.

Type:SwitchParameter
Position:11
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Management.Infrastructure.CimInstance#VpnConnection

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

The VpnConnection object contains the VpnConnection configuration settings.