NAME
Set-VpnConnection
SYNOPSIS
Changes the configuration settings of an existing VPN connection profile.
SYNTAX
Set-VpnConnection [[-RememberCredential] ] [[-UseWinlogonCredential] ] [[-EapConfigXmlStream]
] [-Name] [[-ServerAddress] ] [[-TunnelType] {Pptp | L2tp | Sstp | Ikev2 |
Automatic}] [[-EncryptionLevel] {NoEncryption | Optional | Required | Maximum | Custom}] [[-AuthenticationMethod]
{Pap | Chap | MSChapv2 | Eap | MachineCertificate}] [[-SplitTunneling] ] [[-AllUserConnection]]
[[-L2tpPsk] ] [-CimSession ] [-DnsSuffix ] [-Force] [-IdleDisconnectSeconds
] [-MachineCertificateEKUFilter ] [-MachineCertificateIssuerFilter ]
[-PassThru] [-ServerList ] [-ThrottleLimit ] [-Confirm] [-WhatIf] []
Set-VpnConnection [[-RememberCredential] ] [[-PlugInApplicationID] ] [-Name]
[[-ServerAddress] ] [[-ThirdPartyVpn]] [[-SplitTunneling] ] [-CimSession ]
[-CustomConfiguration ] [-DnsSuffix ] [-Force] [-IdleDisconnectSeconds ] [-PassThru]
[-ServerList ] [-ThrottleLimit ] [-Confirm] [-WhatIf] []
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.
PARAMETERS
-AllUserConnection []
Indicates that the VPN connection specified is in the global phone book.
Required? false
Position? 8
Default value none
Accept pipeline input? True (ByPropertyName)
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
Required? false
Position? 6
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-CustomConfiguration []
Specifies an XML document that allows vendors to specify custom configuration information.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DnsSuffix []
Specifies the DNS suffix of the VPN connection.
Required? false
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.
Required? false
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
-- Maximum
Required? false
Position? 5
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IdleDisconnectSeconds []
Specifies the time, in seconds, before closing an idle connection.
Required? false
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.
Required? false
Position? 9
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.
Required? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name
Specifies the name of the VPN connection profile.
Required? true
Position? 2
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PlugInApplicationID []
Specifies the identifier for a third party application.
Required? false
Position? 11
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.
Required? false
Position? 10
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.
Required? false
Position? 3
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.
Required? false
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.
Required? false
Position? 7
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThirdPartyVpn []
Indicates that the cmdlet runs for a third party profile.
Required? false
Position? 4
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 PowerShellr 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.
Required? false
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
Required? false
Position? 4
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.
Required? false
Position? 11
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm []
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf []
Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
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.
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.
RELATED LINKS
Add-VpnConnection
Get-VpnConnection
Remove-VpnConnection