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

Remove-IpamBlock

ipamblock.cdxml

Synopsis

Removes an address block from IPAM.

Syntax

Remove-IpamBlock [-AsJob] [-CimSession] [-DeleteAssociatedSubBlocks] [-Force] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-IpamBlock [-NetworkId] [-StartIPAddress] [-EndIPAddress] [-AsJob] [-CimSession] [-DeleteAssociatedSubBlocks] [-Force] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-IpamBlock cmdlet removes an IP address block from IP Address Management (IPAM). Specify an address block by using the StartIPAddress and EndIPAddress parameters, or use the InputObject parameter to specify the input to this cmdlet. You can specify the DeleteAssociatedSubBlocks parameter to remove all the child IP address ranges mapped to the address block. When you remove an address block, IPAM remaps all subnets and unmaps some subnets which it previously mapped to an address block.

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

-DeleteAssociatedSubBlocks <SwitchParameter>

Indicates that the cmdlet removes the child IP address ranges that belong to the address block.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EndIPAddress <IPAddress[]>

Specifies an array of end addresses for IP address blocks.

Aliases

None

Required?

true

Position

4

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

-NetworkId <String[]>

Specifies the IP network prefix, in Classless Interdomain Routing (CIDR) notation, for the network blocks to be deleted.

Aliases

None

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

-StartIPAddress <IPAddress[]>

Specifies an array of start addresses for IP address blocks.

Aliases

None

Required?

true

Position

3

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

IpamBlock

Notes

None

Examples

Example 1: Remove an IP address block

This command removes the IP address block from the network that has the ID 10.15.0.0/8/16. The command specifies the start and end addresses for the address block.

PS C:\> Get-IpamBlock -NetworkId "10.15.0.0/16" -StartIPAddress 10.15.0.0 -EndIPAddress 10.15.255.255 | Remove-IpamBlock
Confirm

Deleting IP address block with NetworkId 10.15.0.0/16 from IPAM. Deleting the block may move the currently mapped IP address ranges within this block to Unmapped address space.Do you want to continue?

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

Example 2: Remove all child IP address ranges that belong to an address block

This command removes all child IP address ranges that belong to the address block from the network that has the ID 10.0.0.0/8. The command specifies the start and end addresses for the address block.

PS C:\>Get-IpamBlock -NetworkId "10.0.0.0/8" -StartIPAddress 10.0.0.0 -EndIPAddress 10.255.255.255 | Remove-IpamBlock -DeleteAssociatedSubBlocks
Confirm

This will permanently delete the given IP Block with NetworkId 10.0.0.0/8 from IPAM. Deleting the block may move the currently mapped IP address ranges within this block to Unmapped address space. Any sub-blocks associated with the given block will also be deleted. Do you want to continue?

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

Online Version
Get-IpamBlock
Set-IpamBlock
Add-IpamBlock