Remove method of the PS_VpnIPAddressRange class

This cmdlet removes an existing IPv4 address range from the pool for IP address assignment

Syntax

uint32 Remove(
  [in]  string            IPAddress,
  [in]  string            ComputerName,
  [in]  boolean           PassThru,
  [in]  boolean           Force,
  [in]  string            RoutingDomain,
  [out] VpnIPAddressRange cmdletOutput
);

Parameters

IPAddress [in]

Indicates the Start IP address of the range that has to be deleted

ComputerName [in]

IPv4/IPv6 address or hostname of the machine on which the VPN server machine specific tasks should be executed

PassThru [in]

Returns an object, viz. the IPv4 address range that was deleted. By default this cmdlet does not generate any output

Force [in]

The cmdlet ensures that there is at least one address range always present by disallowing deletion of the last address range. This poses a problem where there is only one range to start with and a user needs to replace that range with a new one. The Force parameter is used to override the normal behavior and allow deletion of the last address range so that a new range can be added later.

RoutingDomain [in]

The name of the routing domain of the IP address range.

Windows Server 2012: This parameter was changed from RoutingDomainName in Windows Server 2012 R2.

cmdletOutput [out]

Start and end IP address of the range that was deleted

Requirements

See also

PS_VpnIPAddressRange