Set-VpnConnection

Changes the configuration settings of an existing VPN connection profile.

Syntax

Set-VpnConnection
   [-Name] <String>
   [[-UseWinlogonCredential] <Boolean>]
   [[-EapConfigXmlStream] <XmlDocument>]
   [[-ServerAddress] <String>]
   [[-TunnelType] <String>]
   [[-EncryptionLevel] <String>]
   [[-AuthenticationMethod] <String[]>]
   [[-SplitTunneling] <Boolean>]
   [-AllUserConnection]
   [[-L2tpPsk] <String>]
   [[-RememberCredential] <Boolean>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-DnsSuffix <String>]
   [-Force]
   [-IdleDisconnectSeconds <UInt32>]
   [-MachineCertificateEKUFilter <String[]>]
   [-MachineCertificateIssuerFilter <X509Certificate2>]
   [-PassThru]
   [-ServerList <CimInstance[]>]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [<CommonParameters>]
Set-VpnConnection
   [-Name] <String>
   [[-PlugInApplicationID] <String>]
   [[-ServerAddress] <String>]
   [-ThirdPartyVpn]
   [[-SplitTunneling] <Boolean>]
   [[-RememberCredential] <Boolean>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-CustomConfiguration <XmlDocument>]
   [-DnsSuffix <String>]
   [-Force]
   [-IdleDisconnectSeconds <UInt32>]
   [-PassThru]
   [-ServerList <CimInstance[]>]
   [-ThrottleLimit <Int32>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-VpnConnection cmdlet changes the configuration settings of an existing VPN connection profile. If the VPN profile specified does not exist, you see an error. If errors occur when you modify the VPN profile, the cmdlet returns the error information.

Examples

Example 1: Configure a single VPN connection

PS C:\> Set-VpnConnection -Name "Test1" -ServerAddress "10.1.1.2" -PassThru
Name                  : Test1

ServerAddress         : 10.1.1.2

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 configures the VPN connection named Test1 to connect to the server with an IP address of 10.1.1.2. By specifying the PassThru parameter, you can see the configuration of the VPN connection object.

Example 2: Configure a VPN connection with several settings

PS C:\>Set-VpnConnection -Name "Test3" -AllUserConnection -TunnelType "L2tp" -EncryptionLevel "Optional" -AuthenticationMethod Pap -SplitTunneling $False -RememberCredential $False -PassThru
WARNING: The currently selected encryption level requires EAP or MS-CHAPv2 logon security methods. Data encryption will not occur for Pap or Chap.
Name                  : Test3

ServerAddress         : 10.1.1.1

AllUserConnection     : True

Guid                  : {76746D4E-D72A-467D-A11F-3D4D9075F50D}

TunnelType            : L2tp

AuthenticationMethod  : {Pap}

EncryptionLevel       : Optional

L2tpIPsecAuth         : Certificate

UseWinlogonCredential : False

EapConfigXmlStream    :

ConnectionStatus      : Disconnected

NapState              : NotConnected

RememberCredential    : False

SplitTunneling        : False

This command configures the VPN connection named Test3 and located in the global phone book as follows:

  • The connection is configured to use L2tp as the tunnel type, as specified by the TunnelType parameter
  • The tunnel is using optional encryption, as specified by the EncryptionLevel parameter
  • The authentication method used by the connection is PAP, as specified by the AuthenticationMethod parameter
  • Split tunneling is turned off, as specified by the SplitTunneling parameter, and the value of $False
  • Credential caching is turned off, as specified by the RememberCredential parameter and the value of $False

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

Example 3: Configure a VPN connection to use a custom EAP configuration

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

This command configures the VPN connection named Test4 in the global phone book to use the custom EAP configuration by: 

-- Specifying the *AuthenticationMethod* parameter with the value EAP
-- Specifying the *EapConfigXmlStream* parameter with the value of the *EapConfigXmlStream* method of the previously created variable.By specifying the *PassThru* parameter, you can see the configuration of the VPN connection object.
PS C:\>Set-VpnConnection -Name "Test4" -AllUserConnection -AuthenticationMethod Eap -EapConfigXmlStream $A.EapConfigXmlStream -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 set of commands first creates a custom EAP configuration, and then configures a VPN connection from the global phone book to use the new custom EAP configuration.

For more information about custom EAP creation, see the New-EapConfiguration cmdlet.

Required Parameters

-Name

Specifies the name of the VPN connection profile.

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

Optional Parameters

-AllUserConnection

Indicates that the VPN connection specified is in the global phone book.

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

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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
  • EAP
Type:String[]
Parameter Sets:Pap, Chap, MSChapv2, Eap, MachineCertificate
Position:5
Default value:None
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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

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

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-CustomConfiguration

Specifies an XML document that allows vendors to specify custom configuration information.

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

Specifies the DNS suffix of the VPN connection.

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

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

Type:XmlDocument
Position:11
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
  • Maximum
Type:String
Parameter Sets:NoEncryption, Optional, Required, Maximum, Custom
Position:4
Default value:None
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
-IdleDisconnectSeconds

Specifies the time, in seconds, before closing an idle connection.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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:8
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MachineCertificateEKUFilter

Specifies an array of enhanced key usage (EKU) filters for Internet Key Exchange version 2 (IKEv2) machine certificate selection.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MachineCertificateIssuerFilter

Specifies the X509 certificate of the issuer filter for IKEv2 machine certificate selection.

Type:X509Certificate2
Position:Named
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
-PlugInApplicationID

Specifies the identifier for a third party application.

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

Indicates that the credentials supplied at the time of first successful connection is stored in the cache, if set to $True.

Type:Boolean
Position:9
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 fully qualified domain name (FQDN), an IPv4 address, or an IPv6 address.

Type:String
Aliases:ServerName, DefaultServer
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerList

Specifies an array of VPN servers. The VPN client can connect to these servers.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SplitTunneling

Indicates whether the cmdlet enables split tunneling for the VPN connection profile. When you enable split tunneling, traffic to destinations outside the intranet does not flow through the VPN tunnel. Specify a value of $True to enable split tunneling.

Type:Boolean
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ThirdPartyVpn

Indicates that the cmdlet runs for a third party profile.

Type:SwitchParameter
Position:3
Default value:None
Accept pipeline input:False
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
  • Automatic
Type:String
Parameter Sets:Pptp, L2tp, Sstp, Ikev2, Automatic
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-UseWinlogonCredential

Indicates whether to use Windows logon credentials. Specify a value of $True to use MSCHAPv2 or EAP-MSCHAPv2 as the authentication method and use Windows logon credentials automatically when connecting with the VPN connection profile.

Type:Boolean
Position:10
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
Aliases:wi
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.

This cmdlet returns a VpnConnection object that contains the VPN connection configuration settings.