Add-IpamRange

Add-IpamRange

Adds an IP address range to the configuration of an IPAM server.

Syntax

Parameter Set: AddRange0
Add-IpamRange [-NetworkId] <String> [[-StartIPAddress] <IPAddress> ] [[-EndIPAddress] <IPAddress> ] [-AddressSpace <String> ] [-AsJob] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ConnectionSpecificDnsSuffix <String> ] [-CreateSubnetIfNotFound] [-CustomConfiguration <String> ] [-Description <String> ] [-DnsServer <IPAddress[]> ] [-DnsSuffix <String[]> ] [-Gateway <String[]> ] [-ManagedByService <String> ] [-NetworkType <VirtualizationType> ] [-Owner <String> ] [-PassThru] [-ReservedAddress <String[]> ] [-ServiceInstance <String> ] [-ThrottleLimit <Int32> ] [-UtilizationCalculation <UtilizationCalculation> ] [-UtilizedAddresses <Double> ] [-VIP <String[]> ] [-WinsServer <IPAddress[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-IpamRange cmdlet adds an IP address range to the configuration of an IP Address Management (IPAM) server. Use this cmdlet to add a Non-Virtualized, Provider, or a Customer IP address range in IPAM. If the network type is Provider or NonVirtualized, the range will be added to default address space if you do not specify an address space. If the network type is Customer, you must specify an address space.

Parameters

-AddressSpace<String>

Specifies an address space to which this IP address range belongs. An address space contains IP subnets, IP ranges, and IP addresses. If you do not specify this parameter, the default address space is assumed. The default address space is the Provider address space.

Aliases	none
Required?	false
Position?	named
Default Value	Default
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AssignmentDate<DateTime>

Specifies a date on which to assign addresses in this range.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AssignmentType<AddressAssignment>

Specifies how IPAM assigns the addresses. The acceptable values for this parameter are:

-- Static
-- Dynamic
-- Auto
-- VIP
-- Reserved

Aliases	none
Required?	false
Position?	named
Default Value	Static
Accept Pipeline Input?	True (ByPropertyName)
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

-ConnectionSpecificDnsSuffix<String>

Specifies the connection-specific DNS suffix to associate with this range.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CreateSubnetIfNotFound

Indicates that the cmdlet creates a parent subnet for this range of addresses. If you specify this parameter, the cmdlet automatically creates a parent subnet for this range, if no parent subnet exists.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CustomConfiguration<String>

Specifies semicolon-separated name/value pairs. This parameter specifies custom metadata that is associated with the address space.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Description<String>

Specifies a description for the range.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DnsServer<IPAddress[]>

Specifies an array of DNS servers to associate with this range. Specify the names of the DNS servers in the order of preference, highest to lowest.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DnsSuffix<String[]>

Specifies an array of search suffixes to associate with the given range.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EndIPAddress<IPAddress>

Specifies an IP address. For this parameter, the address represents the high end of the range to add.

Aliases	none
Required?	false
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Gateway<String[]>

Specifies an array of gateway servers, imported from a DHCP Scope, to associate with a range in IPAM. Specify the names of the gateway servers in the order of preference, highest to lowest. The format for specification is <ipaddress>\<metric>. To specify the Automatic metric, use the format <Ipaddress>\Automatic.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ManagedByService<String>

Specifies the value of the managing service of the IP address ranges being added.

Aliases	MB
Required?	false
Position?	named
Default Value	IPAM
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NetworkId<String>

Specifies the network and the prefix for the given range. Specify the network ID in Classless Interdomain Routing (CIDR) notation in the format Network/Prefix.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NetworkType<VirtualizationType>

Specifies an array of network types for the addresses to be added. The acceptable values for this parameter are:

-- Provider
-- Customer
-- NonVirtualized

If the value of the AddressSpace parameter is Default, then this parameter can take the value Provider or NonVirtualized. If the value of the AddressSpace parameter is Provider, then the value of this parameter, if specified, must be Provider. Specifying any other value for this parameter will result in an error. Similarly, if the value of the AddressSpace parameter is Customer, then the value of this parameter, if specified, must be Customer. Specifying any other value for this parameter will result in an error.

If you do not specify this parameter, network type defaults to NonVirtualized.

Aliases	none
Required?	false
Position?	named
Default Value	NonVirtualized
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Owner<String>

Specifies the name of an owner for an address range.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PassThru

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

-ReservedAddress<String[]>

Specifies the reserved addresses in the range. Specify the reserved addresses as a list, in descending order of precedence.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ServiceInstance<String>

Specifies the service instance that manages the address ranges to add. The value specified for this field should be present in the set of values defined for the ServiceInstance custom field in IPAM. The cmdlet will report an error if this is not found to be a valid value for the ServiceInstance custom field. The user can edit the associated custom field to add or delete values.

Aliases	SI
Required?	false
Position?	named
Default Value	Localhost
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-StartIPAddress<IPAddress>

Specifies an IP address. For this parameter, the address represents the low end of the range to add.

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

-UtilizationCalculation<UtilizationCalculation>

Specifies the utilization information type that will be automatically calculated by IPAM or specified by the user.

Aliases	none
Required?	false
Position?	named
Default Value	Automatic
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UtilizedAddresses<Double>

Specifies the number of addresses to utilize from the pool of IP addresses.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VIP<String[]>

Specifies an array of virtual IP addresses that are usually set aside for load balancers. Specify the VIPs as a list, in descending order of precedence.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-WinsServer<IPAddress[]>

Specifies an array of Windows Internet Name Service (WINS) servers to associate with this range. Specify the WINS servers in decreasing order of precedence.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

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.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

• CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range

  IP address range object added to IPAM data store.

Examples

Example 1: Add an IP address range

This command adds an IP address range that is managed by the current instance of IPAM server. This range is added to the default address space.

PS C:\> Add-IpamRange -NetworkId 10.13.0.0/16 -PassThru

Example 2: Add an IP address range by using a network ID

This command adds an IP address range with network id 172.16.10.0/24. IPAM does not allow creation of a range for which a corresponding subnet does not exist.

PS C:\> Add-IpamRange -NetworkId 172.16.10.0/24

Example 3: Add an IP address range by using a network ID and create a subnet

This command adds an IP address range with network id 172.16.10.0/24. The command uses the CreateSubnetIfNotFound to automatically create the corresponding subnet, and adds WINS and Gateway servers to the range. Gateway servers are specified in the format <IP Address>/<Metric>.

PS C:\> Add-IpamRange -NetworkId 172.16.10.0/24 -CreateSubnetIfNotFound -WinsServer 10.10.1.1, 10.10.1.2 -Gateway "10.10.5.1/Automatic","10.10.5.2/4"|Format-List Overlapping, NetworkID, StartAddress,EndAddress, ManagedByService, ServiceInstance, WinsServers, Gateway

Example 4: Add a provider IP address range to an existing IPAM configuration

This command adds a provider IP address range that is managed by current instance of IPAM. The range will be added to default address space.

PS C:\> Add-IpamRange -NetworkId 172.16.19.0/24 -StartIPAddress 172.16.19.10 -EndIPAddress 172.16.19.110 -NetworkType Provider -CreateSubnetIfNotFound -PassThru

Example 5: Add a range of provider IP addresses

This command adds a provider IP range 172.16.19.0/24 with start and end IP addresses 172.16.19.10 and 172.16.19.110. The command adds the range to a provider address space named ContosoDataCenter. Since this range is in a different address space, IPAM will not mark it as overlapping.

PS C:\> Add-IpamRange -NetworkId 172.16.19.0/24 -StartIPAddress 172.16.19.10 -EndIPAddress 172.16.19.110 -NetworkType Provider -AddressSpace ContosoDataCenter -PassThru -CreateSubnetIfNotFound

Related topics

Export-IpamRange

Get-IpamRange

Import-IpamRange

Remove-IpamRange

Set-IpamRange