Remove method of the PS_VpnConnectionRoute class

Removes a route from the routes to be plumbed for a VPN profile.

Syntax

uint32 Remove(
  [in]  string        ConnectionName,
  [in]  string        DestinationPrefix,
  [in]  boolean       AllUserConnection,
  [in]  boolean       PassThru,
  [out] MSFT_NetRoute cmdletOutput
);

Parameters

ConnectionName [in]

The name of the VPN connection profile to modify.

DestinationPrefix [in]

The destination prefix of the route.

AllUserConnection [in]

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

PassThru [in]

true to return the MSFT_NetRoute object; otherwise, false.

cmdletOutput [out]

When this method returns, contains the MSFT_NetRoute object. The destination prefix and metric field are populated.

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_VpnConnectionRoute