Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-VpnIPAddressRange

Remove-VpnIPAddressRange

ps_vpnipaddressrange_v1.0.0.cdxml

Synopsis

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

Syntax

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

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

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

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IPAddress <String>

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

Aliases

StartIPAddress

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RoutingDomain <String>

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

Aliases

RoutingDomainName

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

System.String[]
Microsoft.Management.Infrastructure.CimInstance#VpnIPAddressRange

Notes

None

Examples

EXAMPLE 1

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.

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

Online Version
Add-VpnIPAddressRange