COMMAND EVERYTHING.
Adds an IP address range to the configuration of an IPAM server.
Microsoft IpamServer reference: Adds an IP address range to the configuration of an IPAM server. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Add-IpamRange. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Windows / IpamServer · Windows Server 2025 documentation; feature/module prerequisites apply
-AddressSpace- 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 used. The default address space is the Provider address space.
-AsJob- 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.
-AssignmentDate- Specifies a date on which to assign addresses in this range.
-AssignmentType- Specifies how IPAM assigns the addresses. The acceptable values for this parameter are: - Static - Dynamic - Auto - VIP - Reserved
-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.
-Confirm- Prompts you for confirmation before running the cmdlet.
-ConnectionSpecificDnsSuffix- Specifies the connection-specific DNS suffix to associate with this range.
-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.
-CustomConfiguration- Specifies semicolon-separated name/value pairs. This parameter specifies custom metadata that is associated with the address space.
-Description- Specifies a description for the range.
-DnsServer- 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.
-DnsSuffix- Specifies an array of search suffixes to associate with the given range.
-EndIPAddress- Specifies an IP address. For this parameter, the address represents the high end of the range to add.
-Gateway- 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 \\\\. To specify the Automatic metric, use the format \\Automatic.
-ManagedByService- Specifies the value of the managing service of the IP address ranges being added.
-NetworkId (required)- 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.
-NetworkType- 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 use 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.
-Owner- Specifies the name of an owner for an address range.
-PassThru- Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-ReservedAddress- Specifies the reserved addresses in the range. Specify the reserved addresses as a list, in descending order of precedence.
-ServiceInstance- 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.
-StartIPAddress- Specifies an IP address. For this parameter, the address represents the low end of the range to add.
-ThrottleLimit- 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.
-UtilizationCalculation- Specifies the utilization information type that will be automatically calculated by IPAM or specified by the user.
-UtilizedAddresses- Specifies the number of addresses to utilize from the pool of IP addresses.
-VIP- 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.
-WhatIf- Shows what would happen if the cmdlet runs. The cmdlet is not run.
-WinsServer- Specifies an array of Windows Internet Name Service (WINS) servers to associate with this range. Specify the WINS servers in decreasing order of precedence.
Windows with the IpamServer module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.