Remove method of the PS_VpnConnection class

  • Article

Removes virtual private network (VPN) connection profiles from the Connection Manager phone book.

Syntax

static uint32 Remove(
  [in]  string          Name[],
  [in]  boolean         Force,
  [in]  boolean         PassThru,
  [in]  boolean         AllUserConnection,
  [out] VpnCommonConfig cmdletOutput[]
);

Parameters

Name [in]

The names of the VPN connection profiles to remove.

Force [in]

True to force the removal of the VPN connection profile from the phone book; otherwise, false.

PassThru [in]

True to return the VpnConnection object that contains the VPN configuration settings; otherwise, false.

AllUserConnection [in]

True if the VPN connection profile is for all users; false if it is for a single user.

cmdletOutput [out]

When this method returns, contains the VpnConnection object.

Requirements
Minimum supported client
 Windows 8
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\RemoteAccess\Client
MOF
VPNClientPSProvider.mof
DLL
VPNClientPSProvider.dll

See also

PS_VpnConnection