Remove-IpamRange
Removes a range of IP addresses from an IPAM server configuration.
Syntax
Remove-IpamRange
[-StartIPAddress] <IPAddress[]>
[-EndIPAddress] <IPAddress[]>
[-ManagedByService <String[]>]
[-ServiceInstance <String[]>]
[-NetworkType <VirtualizationType[]>]
[-AddressSpace <String[]>]
[-DeleteMappedAddresses]
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-IpamRange
-InputObject <CimInstance[]>
[-DeleteMappedAddresses]
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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.
Examples
Example 1: Remove an IP address range
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"): YThis 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.
Example 2: Remove an IP address range and 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"):YThis command removes an IP address range and the corresponding mapped IP addresses.
Example 3: Remove an IP address range for an address space
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"): YThis command removes the customer IP addresses range by using the StartIPAddress and EndIPAddress parameters in the customer address space named Contoso
Parameters
-AddressSpace
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AsJob
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.
| 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-CimSession or Get-CimSession 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 |
-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 |
-DeleteMappedAddresses
Indicates that the cmdlet deletes the IP addresses that map to an IP range, rather than retain them.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndIPAddress
Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the range to remove.
| Type: | IPAddress[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ManagedByService
Specifies an array of services that manage the range to remove.
| Type: | String[] |
| Aliases: | MB |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NetworkType
Specifies an array 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.
| Type: | VirtualizationType[] |
| Accepted values: | NonVirtualized, Provider, Customer |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-ServiceInstance
Specifies an array of service instances that manage the address ranges to remove.
| Type: | String[] |
| Aliases: | SI |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StartIPAddress
Specifies an array of IP addresses. For this parameter, the addresses represent the low end of the range to remove.
| Type: | IPAddress[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| 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 |
Outputs
CimInstance[]
This cmdlet returns an object that represents IP address range objects deleted from IPAM.