Remove-IpamAddress
Removes a set of addresses from IPAM.
Syntax
ByAddress
Remove-IpamAddress
[-IpAddress] <IPAddress[]>
[[-ManagedByService] <String[]>]
[[-ServiceInstance] <String[]>]
[-NetworkType <VirtualizationType[]>]
[-AddressSpace <String[]>]
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject (cdxml)
Remove-IpamAddress
-InputObject <CimInstance[]>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-IpamAddress cmdlet removes a set of addresses from IP Address Management (IPAM). The cmdlet removes the specified IP address records permanently from the IPAM database. Specify the IP addresses to remove or use the InputObject parameter to specify an IpamAddress object to remove.
The cmdlet does not remove any reservations on the Dynamic Host Configuration Protocol (DHCP) server or Domain Name System (DNS) records. You can use Windows PowerShell for DHCP Server to remove a reservation from the DHCP server. You can use Windows PowerShell for DNS to remove the DNS records associated with the IP addresses that you remove.
Examples
Example 1: Remove all IP addresses in range
PS C:\> $Range = Get-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254
PS C:\> Get-IpamAddress -MappingToRange $Range | Remove-IpamAddress
Confirm
Deleting the given IP Address from IPAM database. You will not be able to undo this action. Do you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):
This example removes all IP addresses in a range.
The first command uses the Get-IpamRange cmdlet to get an IpamRange object that contains the addresses that belong to a range of IP addresses. The command stores the object in the $Range variable.
The second command uses the Get-IpamAddress cmdlet to get an IpamAddress object that contains the IP addresses that map to the range stored in the $Range variable. The command passes the IpamAddress object to the Remove-IpamAddress cmdlet by using the pipeline operator. The command removes the addresses in the range stored in the $Range variable.
Example 2: Remove all expired physical addresses managed by IPAM
PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressCategory Private -ManagedByService IPAM | Where-Object {$_.ExpiryStatus -eq "Expired"} | Remove-IpamAddress
This command gets an IpamAddress object that contains the physical addresses managed by IPAM that have expired. The command passes the IpamAddress object to the Remove-IpamAddress cmdlet by using the pipeline operator. The Remove-IpamAddress cmdlet removes the IpamAddress object.
Example 3: Remove a customer IP address
PS C:\> Remove-IpamAddress -IpAddress 172.16.10.16 -AddressSpace "Default"
This command removes the customer IP address 172.16.10.16 from the default address space.
Example 4: Remove a provider IP address
PS C:\> Remove-IpamAddress -IpAddress 172.16.10.19 -AddressSpace "Default" -NetworkType Provider
This command removes the provider IP address 172.16.10.19 from the default address space.
Parameters
-AddressSpace
Specifies an array of address spaces. The cmdlet removes the addresses that belong to the address spaces that you specify. If you specify this parameter, you must specify the IpAddress parameter.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByAddress
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject (cdxml)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IpAddress
Specifies an array of IP addresses.
Parameter properties
| Type: | IPAddress[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByAddress
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ManagedByService
Specifies an array of services that manage the IP addresses that you specify in the IpAddress parameter. If you specify this parameter, you must specify the IpAddress parameter.
The values that you specify for this parameter must exist in the set of values that you defined for the ManagedByService custom field in IPAM.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | MB |
Parameter sets
ByAddress
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-NetworkType
Specifies the network type of the address. The acceptable values for this parameter are:
- Provider
- Customer
- NonVirtualized
The default value is NonVirtualized.
If you specify Default for the AddressSpace parameter, the valid values for this parameter are Provider and NonVirtualized. If you specify a provider type of address space for the AddressSpace parameter, you must specify Provider for this parameter. If you specify a customer type of address space for the AddressSpace parameter, you must specify Customer for this parameter.
Parameter properties
| Type: | VirtualizationType[] |
| Default value: | None |
| Accepted values: | NonVirtualized, Provider, Customer |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByAddress
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServiceInstance
Specifies an array of instances of the services that manage the IP addresses. Specify the instances of the services that you specified for the ManagedByService parameter. If you specify this parameter, you must specify the IpAddress parameter. The value that you specify for this parameter must exist in the set of values that you defined for the ServiceInstance custom field in IPAM.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SI |
Parameter sets
ByAddress
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
IpamAddress
This cmdlet returns an object that represents an IP address on the IPAM server.