Get-Ipam Address

Syntax

Get-IpamAddress
   [-IpAddress] <IPAddress[]>
   [-ManagedByService <String[]>]
   [-ServiceInstance <String[]>]
   [-NetworkType <VirtualizationType[]>]
   [-AddressSpace <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-IpamAddress
   -AddressFamily <AddressFamily[]>
   [-AddressCategory <AddressCategory[]>]
   [-ManagedByService <String[]>]
   [-ServiceInstance <String[]>]
   [-NetworkType <VirtualizationType[]>]
   [-AddressSpace <String[]>]
   [-Unmapped]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-IpamAddress
   -MappingToBlock <CimInstance>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-IpamAddress
   -MappingToSubnet <CimInstance>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Get-IpamAddress
   -MappingToRange <CimInstance>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-IpamAddress cmdlet gets IP addresses from IP Address Management (IPAM). Specify the IpAddress parameter to retrieve an IP address. Specify the AddressFamily parameter to retrieve a set of IP addresses for address families. You can also get addresses that belong to a range, a subnet, or an address block.

Examples

Example 1: Get all private physical IPv4 addresses

PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressCategory Private -AddressSpace "Default"

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.

Example 2: Get private IPv4 addresses for provider networks

PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressCategory Private -NetworkType Provider

This command gets all private IPv4 addresses for provider networks. Because the command does not specify the AddressSpace parameter, the command gets addresses that belong to all address spaces in IPAM.

Example 3: Get private IPv4 addresses from the default address space

PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressCategory Private -NetworkType Provider -AddressSpace "Default"

This command gets all private IPv4 addresses for provider networks. Because the command specifies the Default address space, the command gets IP addresses from all address spaces configured in IPAM.

Example 4: Get private IPv4 addresses for customer networks

PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressCategory Private -NetworkType Customer

This command gets all private IPv4 addresses for customer networks. Because the command does not specify the AddressSpace parameter, the command gets addresses that belong to all address spaces configured in IPAM.

Example 5: Get private IPv4 addresses for customer networks from an address space

PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressCategory Private -NetworkType Customer -AddressSpace "ContosoAddSpace01"

This command gets all private IPv4 addresses for customer networks that belong to the address space named ContosoAddSpace01.

Example 6: Get physical IP addresses from all address spaces

PS C:\> Get-IpamAddress -IpAddress 10.12.1.1, 10.12.3.1

This command gets the physical IP addresses 10.12.1.1 and 10.12.3.1. Because the command does not specify the AddressSpace parameter, the command gets IP addresses from all address spaces which match the IP address 10.12.1.1 and 10.12.3.1.

Example 7: Get duplicate addresses in an address space

PS C:\> Get-IpamAddress -AddressFamily IPv4 -AddressSpace Default | Where-Object {$_.duplicate -eq $true} | Format-List IPAddress, NetworkType, ManagedByService, ServiceInstance, ProviderAddressSpace
IpAddress            : 172.16.10.16

NetworkType          : Provider

ManagedByService     : VMM

ServiceInstance      : vmm1.contoso.com

ProviderAddressSpace : Default
IpAddress            : 172.16.10.16

NetworkType          : Provider

Duplicate            : True

ManagedByService     : IPAM

ServiceInstance      : Localhost

ProviderAddressSpace : Default

This command gets all duplicate IPv4 addresses in the default provider address space. The Default address space is the address space to which the IPAM entity belongs. The command returns two addresses that have the IP address 172.16.10.16. One address is managed by IPAM and the other address is managed by vmmblue_1. The IPAM server marks both these addresses as duplicate. The command uses the Format-List cmdlet to display the output in the form of a table. For more information, type Get-Help Format-Table .

Example 8: Get IP addresses that map to a subnet

PS C:\> $ContosoPhysicalSubnet = Get-IpamSubnet -NetworkId "10.12.0.0/16"
PS C:\> Get-IpamAddress -MappingToSubnet $ContosoPhysicalSubnet

This example gets all IP addresses that map to a subnet. Because the network type of the subnet is non-virtualized, the result contains only physical addresses and the fabric addresses from the default address space which belong to the subnet.

The first command uses the Get-IpamSubnet cmdlet to get the IpamSubnet object that contain subnets configured in IPAM for the network that has the ID 10.12.0.0/16. The command stores the object in the $ContosoPhysicalSubnet variable.

The second command gets all the IP addresses that belong to the IP subnet stored in the $ContosoPhysicalSubnet variable.

Example 9: Get all IP address that map to a an IP range

PS C:\> $Range = Get-IpamRange -StartIPAddress 10.12.1.1 -EndIPAddress 10.12.1.254
PS C:\> Get-IpamAddress -MappingToRange $Range

This example gets all IP addresses that belong to a range of IP addresses.

The first command uses the Get-IpamRange cmdlet to get an IpamRange object that contains an IP range configured in IPAM. The command stores the object in the $Range variable.

The second command gets all the IP addresses that belong to the range stored in the $Range variable.

Required Parameters

Optional Parameters

Outputs

IpamAddress[]

This cmdlet returns an object that represents a set of IP addresses on the IPAM server.

Related Links

• Set-IpamAddress
• Add-IpamAddress
• Remove-IpamAddress
• Import-IpamAddress
• Export-IpamAddress
• Add-IpamCustomValue
• Remove-IpamCustomValue
• Get-IpamSubnet
• Get-IpamRange