Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-VpnConnection

Set-VpnConnection

ps_vpnconnection_v1.0.0.cdxml

Synopsis

Changes the configuration settings of an existing VPN connection profile.

Syntax

Set-VpnConnection [-RememberCredential] [-UseWinlogonCredential] [-EapConfigXmlStream] [-Name] [-ServerAddress] [-TunnelType] [-EncryptionLevel] [-AuthenticationMethod] [-SplitTunneling] [-AllUserConnection] [-L2tpPsk] [-AsJob] [-CimSession] [-DnsSuffix] [-Force] [-IdleDisconnectSeconds] [-MachineCertificateEKUFilter] [-MachineCertificateIssuerFilter] [-PassThru] [-ServerList] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-VpnConnection [-RememberCredential] [-PlugInApplicationID] [-Name] [-ServerAddress] [-ThirdPartyVpn] [-SplitTunneling] [-AsJob] [-CimSession] [-CustomConfiguration] [-DnsSuffix] [-Force] [-IdleDisconnectSeconds] [-PassThru] [-ServerList] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed 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 <SwitchParameter>

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

Aliases

None

Required?

false

Position

8

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AuthenticationMethod <String[]>

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

Aliases

None

Required?

false

Position

6

Default value

MSChapv2

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CustomConfiguration <XmlDocument>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DnsSuffix <String>

Specifies the DNS suffix of the VPN connection.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EapConfigXmlStream <XmlDocument>

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

Aliases

None

Required?

false

Position

12

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EncryptionLevel <String>

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

Aliases

None

Required?

false

Position

5

Default value

Required

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IdleDisconnectSeconds <UInt32>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-L2tpPsk <String>

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

Aliases

None

Required?

false

Position

9

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MachineCertificateEKUFilter <String[]>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MachineCertificateIssuerFilter <X509Certificate2>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the VPN connection profile.

Aliases

ConnectionName

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PlugInApplicationID <String>

Specifies the identifier for a third party application.

Aliases

None

Required?

false

Position

11

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-RememberCredential <Boolean>

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

Aliases

None

Required?

false

Position

10

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ServerAddress <String>

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.

Aliases

ServerName,DefaultServer

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ServerList <CimInstance[]>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-SplitTunneling <Boolean>

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.

Aliases

None

Required?

false

Position

7

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThirdPartyVpn <SwitchParameter>

Indicates that the cmdlet runs for a third party profile.

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TunnelType <String>

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

Aliases

None

Required?

false

Position

4

Default value

Automatic

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-UseWinlogonCredential <Boolean>

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.

Aliases

None

Required?

false

Position

11

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#VpnConnection

Notes

None

Examples

Example 1: Configure a single VPN connection

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.

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



Example 2: Configure a VPN connection with several settings

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.

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

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

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.

This command stores the result of the New-EapConfiguration cmdlet 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

Online Version
Add-VpnConnection
Get-VpnConnection
Remove-VpnConnection