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
 

Remove-VpnConnection

Remove-VpnConnection

ps_vpnconnection_v1.0.0.cdxml

Synopsis

Removes specified VPN connection profiles.

Syntax

Remove-VpnConnection [-Name] [-AllUserConnection] [-AsJob] [-CimSession] [-Force] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-VpnConnection cmdlet removes one or more specified VPN connection profiles. If errors occur when you remove the VPN profile, or if the specified VPN profile does not exist, the error information is returned.

Parameters

-AllUserConnection <SwitchParameter>

Indicates that the VPN connection is removed from the global phone book.

Aliases

None

Required?

false

Position

named

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

-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

-Force <SwitchParameter>

Forces the removal of the VPN profile from the phone book.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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 (ByValue, 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

-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

-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: Removing a single VPN connection

This command removes the VPN connection named Test1. The Force parameter suppresses warnings and non-terminating errors.

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

PS C:\> Remove-VpnConnection -Name "Test1" -Force -PassThru
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

Example 2: Removing multiple VPN connections

This command removes the VPN connections named Test3, Test4 and Test5. By specifying the AllUserConnection parameter, the connections are removed from the global phone book. The Force parameter suppresses warnings and non-terminating errors.

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

PS C:\>Remove-VpnConnection -Name "Test3",  "Test4",  "Test5" -AllUserConnection -Force -PassThru
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

Online Version
Add-VpnConnection
Get-VpnConnection
Set-VpnConnection
New-EapConfiguration