Windows PowerShell command on Get-command Remove-VpnConnection

NAME

Remove-VpnConnection

SYNOPSIS

Removes specified VPN connection profiles.

SYNTAX

Remove-VpnConnection [-Name] [-AllUserConnection] [-CimSession ] [-Force] [-PassThru]

[-ThrottleLimit ] [-Confirm] [-WhatIf] []

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 []

Indicates that the VPN connection is removed from the global phone book. Required? false Position? named 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

-Force []

Forces the removal of the VPN profile from the phone book. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Name

Specifies the name of the VPN connection profile. Required? true Position? 2 Default value none

Accept pipeline input? True (ByValue, 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

-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

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

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

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.

Example 2: Remove multiple VPN connections

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