Microsoft IpamServer reference: Gets IP addresses from IPAM. 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-IpamAddress. 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 IP address categories. If you specify this parameter, you must specify the *AddressFamily* parameter. The acceptable values for this parameter are: - Public - Private
-AddressFamily (required)
Specifies an array of address families of IP addresses. The acceptable values for this parameter are: - IPv4 - IPv6
-AddressSpace
Specifies an array of names of address spaces. If you do not specify this parameter, the cmdlet gets the addresses for all address spaces in IPAM. If you specify this parameter, you must specify the *AddressFamily* parameter.
-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.
-IpAddress (required)
Specifies an array of IP addresses.
-ManagedByService
Specifies an array of names of the services that manage the IP addresses. The values that you specify for this parameter must exist in the set of values that you defined for the ManagedByService custom field in IPAM. You can use the Add-IpamCustomValue to add a value to the ManagedByService custom field in IPAM. You can use the Remove-IpamCustomValue to remove a value from the ManagedByService custom field in IPAM.
-MappingToBlock (required)
Specifies an IP block. The cmdlet gets the addresses that belong to the IP block.
-MappingToRange (required)
Specifies an IP address range. The cmdlet gets the addresses that belong to the IP range.
-MappingToSubnet (required)
Specifies an IP subnet. The cmdlet gets the addresses that belong to the IP subnet.
-NetworkType
Specifies the network type of the address. The acceptable values for this parameter are: - Provider - Customer - NonVirtualized The default value is NonVirtualized. If you specify Default for the *AddressSpace* parameter, the valid values for this parameter are Provider and NonVirtualized. If you specify a provider type of address space for the *AddressSpace* parameter, you must specify Provider for this parameter. If you specify a customer type of address space for the *AddressSpace* parameter, you must specify Customer for this parameter.
-ServiceInstance
Specifies an array of instances of the services that manage the IP addresses. Specify the instances of the service that you specified for the *ManagedByService* parameter. The value that you specify for this parameter must exist in the set of values that you defined for the ServiceInstance custom field in IPAM.
-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 addresses that do not belong to any address families of IP addresses in IPAM.
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.
Examples
Example 1: Get all private physical IPv4 addresses
This command gets all private physical IPv4 addresses in IPAM. Because the command specifies the Default address space, the command gets provider or non-virtualized IP addresses from all address spaces in IPAM. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.