Remove-NBIPAMAddress
Since
v1.0.4
SYNOPSIS
Deletes one or more IP addresses from Netbox.
SYNTAX
Single (Default)
Remove-NBIPAMAddress -Id <UInt64> [-Force] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Bulk
Remove-NBIPAMAddress -InputObject <PSObject> [-BatchSize <Int32>] [-Force] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Deletes IP addresses from Netbox IPAM module. Supports both single IP address deletion with the Id parameter and bulk deletion via pipeline input.
For bulk operations, use the -BatchSize parameter to control how many IP addresses are deleted per API request. Each object must have an Id property.
EXAMPLES
EXAMPLE 1
Remove-NBIPAMAddress -Id 123 -Force
Deletes IP address with ID 123 without confirmation.
EXAMPLE 2
Get-NBIPAMAddress -Status "deprecated" | Remove-NBIPAMAddress -Force
Bulk delete all deprecated IP addresses.
EXAMPLE 3
$ipsToDelete = @(
[PSCustomObject]@{Id = 100}
[PSCustomObject]@{Id = 101}
[PSCustomObject]@{Id = 102}
)
$ipsToDelete | Remove-NBIPAMAddress -BatchSize 50 -Force
Bulk delete multiple IP addresses.
PARAMETERS
-Id
The database ID(s) of the IP address(es) to delete. Required for single mode.
```yaml Type: UInt64 Parameter Sets: Single Aliases:
Required: True Position: Named Default value: 0 Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-InputObject
Pipeline input for bulk operations. Each object MUST have an Id property.
```yaml Type: PSObject Parameter Sets: Bulk Aliases:
Required: True Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ```
-BatchSize
Number of IP addresses to delete per API request in bulk mode. Default: 50, Range: 1-1000
```yaml Type: Int32 Parameter Sets: Bulk Aliases:
Required: False Position: Named Default value: 100 Accept pipeline input: False Accept wildcard characters: False ```
-Force
Skip confirmation prompts.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Raw
{{ Fill Raw Description }}
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Confirm
Prompts you for confirmation before running the cmdlet.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-ProgressAction
{{ Fill ProgressAction Description }}
```yaml Type: ActionPreference Parameter Sets: (All) Aliases: proga
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.Void
NOTES
AddedInVersion: v1.0.4