Edit

Remove-VpnIPAddressRange

  • Reference
Module:
RemoteAccess

Removes an existing IPv4 address range from the pool for IP address assignment.

Syntax

Remove-VpnIPAddressRange
      [-IPAddress] <String>
      [-ComputerName <String>]
      [-PassThru]
      [-Force]
      [[-RoutingDomain] <String>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-VpnIPAddressRange cmdlet removes an existing IPv4 address range from the pool for IP address assignment. This cmdlet is only applicable if the IPv4 address assignment is happening from statically configured IP address pools.

Examples

EXAMPLE 1

PS C:\>Remove-VpnIPAddressRange -IPAddress 30.1.1.10 -Passthru
StartIPAddress                           EndIPAddress 
--------------                           ------------ 
30.1.1.10                                30.1.1.30

This example removes the IP address range 30.1.1.10 (the starting IP address) through 30.1.1.30 (the ending IP address) from the IPv4 address pool for assignment to VPN clients. Only the starting IP address needs to be specified. This cmdlet automatically determines which IP address range that the starting IP corresponds.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the VPN server computer specific tasks should be run.

Type:String
Aliases:Cn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Overrides the normal behavior and allows deletion of the last address range, so that a new range can be added later.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IPAddress

Specifies the starting IP address of the range that has to be deleted.

Type:String
Aliases:StartIPAddress
Position:1
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoutingDomain

Specifies an ID, as a string, for a routing domain. The ID of a routing domain is a user-defined alphanumeric string.

Type:String
Aliases:RoutingDomainName
Position:3
Default value:None
Required:False
Accept pipeline input:True
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 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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

String[]

CimInstance

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.

The VpnIPAddressRange object consists of the following properties:

-- The starting IPv4 address of the range that was deleted.

-- The ending IPv4 address of the range that was deleted.