Microsoft IpamServer reference: Gets a set of IP address ranges from 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 Get-IpamRange. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / IpamServer · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AddressCategory
Specifies an array of address families of IP addresses. The acceptable values for this parameter are: - IPv4 - IPv6
-AddressFamily (required)
Specifies an array of address families of IP address range objects that this cmdlet gets. The acceptable values for this parameter are: - IPv4 - IPv6
-AddressSpace
Specifies an array of address spaces of the IP address ranges to query. If you do not specify a value, the cmdlet gets data for all address spaces in IPAM.
-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.
-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.
-EndIPAddress (required)
Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the ranges to get.
-ManagedByService
Specifies an array of services that manage the range to get.
-MappingToBlock (required)
Specifies the ranges that map to an address block.
-MappingToSubnet (required)
Specifies an IP range that maps to a subnet.
-NetworkType
Specifies an array of network types for the addresses that this cmdlet gets. The acceptable values for this parameter are: - Provider -- Customer -- NonVirtualized If the value of the parameter is Default, then this parameter can take the value Provider or NonVirtualized. If the value of the 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 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 specify the *NetworkType* parameter but do not specify the *AddressType* parameter, the cmdlet returns all IP address ranges of the given network type.
-ServiceInstance
Specifies an array of service instances that manage the address ranges to get.
-StartIPAddress (required)
Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the ranges to get.
-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.
-Unmapped
Indicates that the cmdlet gets the unmapped ranges.
Prerequisites
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.
Security considerations
This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.
This command gets all private physical IPv4 address ranges, either provider or non virtualized. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.