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
 

Add-IpamBlock

Add-IpamBlock

ipamblock.cdxml

Synopsis

Adds an IP address block to IPAM.

Syntax

Add-IpamBlock [-NetworkId] [-StartIPAddress] [-EndIPAddress] [-AsJob] [-CimSession] [-Description] [-LastAssignedDate] [-Owner] [-PassThru] [-Rir] [-RirReceivedDate] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-IpamBlock cmdlet adds an IP address block to IP Address Management (IPAM). Specify the network from which the IP address block is added by using the NetworkID parameter. If the address category of the block you add is public, you must specify the Rir parameter. The Rir parameter is optional for private address blocks.

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

-Description <String>

Specifies a description for the address block.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-EndIPAddress <IPAddress>

Specifies the end address for the IP address block. If you do not specify this parameter, the cmdlet uses the last IP address of the network that you specify for the NetworkId parameter. If you specify this parameter, you must specify the StartIPAddress parameter.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LastAssignedDate <DateTime>

Specifies the last date, as a DateTime object, on which the block was assigned to devices on a network. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NetworkId <String>

Specifies an IP network prefix, in Classless InterDomain Routing (CIDR) notation. This is the network from which the IP address block is added to the IPAM server.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Owner <String>

Specifies the owner of the IP address block.

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

-Rir <String>

Specifies the regional internet registry (RIR) for public addresses. RIR is a built-in custom field in the IPAM server that contains the following built-in values: -- AFRINIC -- APNIC -- ARIN -- LACNIC -- RIPE

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-RirReceivedDate <DateTime>

Specifies the date, as a DateTime object, when you obtained the public address block from the RIR.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-StartIPAddress <IPAddress>

Specifies the start address for the IP address block. If you do not specify this parameter, the cmdlet uses the first address of the network that you specify for the NetworkId parameter. If you specify this parameter, you must specify the EndIPAddress parameter.

Aliases

None

Required?

false

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


Notes

None

Examples

Example 1: Add an IPv4 private address block

This command adds an IPv4 private address block to the IPAM server. The command uses the first address and last address of the network that has the ID 10.0.0.0/8 for the start and end addresses of the block. The command includes the PassThru parameter, so it displays results to the console.

PS C:\> Add-IpamBlock -NetworkId "10.0.0.0/8" -Description "IP block for Contoso" -PassThru


Utilization        : Under

NetworkId          : 10.0.0.0/8

StartAddress       : 10.0.0.0

EndAddress         : 10.255.255.255

Rir                :

LastAssignedDate   :

TotalAddresses     : 16777216

AssignedAddresses  : 2440

UtilizedAddresses  : 732

PercentageUtilized : 30

AddressCategory    : Private

Owner              :

Description        : IP block for Contoso

RirReceivedDate    :

PercentageAssigned : 1.454353

Example 2: Add a public address block

This command adds a public address block to the IPAM server. You must specify the Rir parameter if the address category of the block you add is Public.

PS C:\>Add-IpamBlock -NetworkId "206.73.118.0/24" -Rir "APNIC" –PassThru


Utilization        : Under

NetworkId          : 206.73.118.0/24

StartAddress       : 206.73.118.0

EndAddress         : 206.73.118.255

Rir                : APNIC

LastAssignedDate   :

TotalAddresses     : 256

AssignedAddresses  : 0

UtilizedAddresses  : 0

PercentageUtilized : 0

AddressCategory    : Public

Owner              :

Description        :

RirReceivedDate    :

PercentageAssigned : 0

Example 3: Add an IPv6 address block

This command adds an IPv6 address block to the IPAM server.

PS C:\>Add-IpamBlock -NetworkId 2001:DB8:ff00::/120 -PassThru


Utilization        : Under

NetworkId          : 2001:db8:ff00::/120

StartAddress       : 2001:db8:ff00::

EndAddress         : 2001:db8:ff00::ff

Rir                :

LastAssignedDate   :

TotalAddresses     : 256

AssignedAddresses  : 0

UtilizedAddresses  : 0

PercentageUtilized : 0

AddressCategory    : Global

Owner              :

Description        :

RirReceivedDate    :

PercentageAssigned : 0

Online Version
Get-IpamBlock
Set-IpamBlock
Remove-IpamBlock