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-IpamRange

Remove-IpamRange

ipamrange.cdxml

Synopsis

Removes a range of IP addresses from an IPAM server configuration.

Syntax

Remove-IpamRange [-StartIPAddress] [-EndIPAddress] [-AddressSpace] [-AsJob] [-CimSession] [-DeleteMappedAddresses] [-Force] [-ManagedByService] [-NetworkType] [-PassThru] [-ServiceInstance] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-IpamRange [-AsJob] [-CimSession] [-DeleteMappedAddresses] [-Force] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-IpamRange cmdlet removes a given range of IP addresses from an IP Address Management (IPAM) server configuration. You can choose to delete the addresses that map to this range or to retain them.

Parameters

-AddressSpace <String[]>

Specifies an array of the IP address ranges to delete. If you do not specify a value, the cmdlet removes data for all NonVirtualized, Provider and Customer address spaces in IPAM.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-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

-DeleteMappedAddresses <SwitchParameter>

Indicates that the cmdlet deletes the IP addresses that map to an IP range, rather than retain them.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EndIPAddress <IPAddress[]>

Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the range to remove.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-ManagedByService <String[]>

Specifies an array of services that manage the range to remove.

Aliases

MB

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NetworkType <VirtualizationType[]>

Specifies an array of of network types for the addresses to remove. The acceptable values for this parameter are:  -- Provider -- Customer -- NonVirtualized If you do not specify a value, the cmdlet deletes all matching IP address ranges of network type Provider, Customer, and NonVirtualized.

Aliases

None

Required?

false

Position

named

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

-ServiceInstance <String[]>

Specifies an array of service instances that manage the address ranges to remove.

Aliases

SI

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-StartIPAddress <IPAddress[]>

Specifies an array of IP addresses. For this parameter, the addresses represent the low end of the range to remove.

Aliases

None

Required?

true

Position

2

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


Return Type

CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range[]

Notes

None

Examples

Example 1: Remove an IP address range

This command removes an IP address range without deleting the mapped IP addresses. The mapped addresses are marked as unmapped and moved to unmapped address space.

PS C:\> Get-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254|Remove-IpamRange
Confirm

This will permanently delete the given IP Range from IPAM. Do you want to continue?

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y

Example 2: Remove an IP address range and mapped IP addresses

This command removes an IP address range and the corresponding mapped IP addresses.

PS C:\>Get-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254|Remove-IpamRange -DeleteMappedAddresses
Confirm

Deleting the range with start IP address 10.12.3.1 and end IP address 10.12.3.254 managed by localhost instance of IPAM. Any addresses mapped to this range will be deleted. Do you want to continue?

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):Y

Example 3: Remove an IP address range for an address space

This command removes the customer IP addresses range by using the StartIPAddress and EndIPAddress parameters in the customer address space named Contoso

PS C:\>Get-IpamRange -StartIPAddress 10.20.4.1 -EndIPAddress 10.20.4.99 -ManagedByService IPAM -ServiceInstance Localhost -Customer -CustomerAddressSpace Contoso | Remove-IpamRange -DeleteMappedAddresses
Confirm

This will permanently delete the given IP Range from IPAM. Do you want to continue?

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y

Online Version
Add-IpamRange
Export-IpamRange
Get-IpamRange
Import-IpamRange
Set-IpamRange