Add-IpamBlock

Add-IpamBlock

Adds an IP address block to IPAM.

Syntax

Parameter Set: AddIpamBlock0
Add-IpamBlock [-NetworkId] <String> [[-StartIPAddress] <IPAddress> ] [[-EndIPAddress] <IPAddress> ] [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-LastAssignedDate <DateTime> ] [-Owner <String> ] [-PassThru] [-Rir <String> ] [-RirReceivedDate <DateTime> ] [-ThrottleLimit <Int32> ] [-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

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

-Description<String>

Specifies a description for the address block.

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

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

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

-Owner<String>

Specifies the owner of the IP address block.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-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

-RirReceivedDate<DateTime>

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

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

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

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

Related topics

Get-IpamBlock

Set-IpamBlock

Remove-IpamBlock