Get-IpamRange

Get-IpamRange

Gets a set of IP address ranges from an IPAM server.

구문

Parameter Set: ByAF
Get-IpamRange -AddressFamily <AddressFamily[]> [-AddressCategory <AddressCategory[]> ] [-AddressSpace <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ManagedByService <String[]> ] [-NetworkType <VirtualizationType[]> ] [-ServiceInstance <String[]> ] [-ThrottleLimit <Int32> ] [-Unmapped] [ <CommonParameters>]

Parameter Set: ByBlock
Get-IpamRange -MappingToBlock <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByID
Get-IpamRange -EndIPAddress <IPAddress[]> -StartIPAddress <IPAddress[]> [-AddressSpace <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ManagedByService <String[]> ] [-NetworkType <VirtualizationType[]> ] [-ServiceInstance <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: BySubnet
Get-IpamRange -MappingToSubnet <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

자세한 설명

The Get-IpamRange cmdlet gets a set of IP address ranges from IP Address Management (IPAM). Use this cmdlet to get IP address ranges of a particular address family or to get a particular range based on starting and ending IP addresses. The cmdlet includes parameter sets to get all ranges that map to a given IP address block or a subnet.

매개 변수

-AddressCategory<AddressCategory[]>

Specifies an array of address families of IP addresses. 이 매개 변수에 허용되는 값은 다음과 같습니다.

-- IPv4
-- IPv6

별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-AddressFamily<AddressFamily[]>

Specifies an array of address families of IP address range objects to get. 이 매개 변수에 허용되는 값은 다음과 같습니다.

-- IPv4
-- IPv6

별칭

없음

필수 여부

true

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-AddressSpace<String[]>

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.

별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-AsJob

별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

-CimSession<CimSession[]>

원격 세션에서 또는 원격 컴퓨터에서 cmdlet을 실행합니다. New-CimSession 또는 Get-CimSession cmdlet의 출력과 같은 컴퓨터 이름이나 세션 개체를 입력합니다. 기본값은 로컬 컴퓨터의 현재 세션입니다.

별칭

Session

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

-EndIPAddress<IPAddress[]>

Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the ranges to get.

별칭

없음

필수 여부

true

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-ManagedByService<String[]>

Specifies an array of services that manage the range to get.

별칭

MB

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-MappingToBlock<CimInstance>

Specifies the ranges that map to an address block.

별칭

없음

필수 여부

true

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByValue)

와일드카드 문자 허용 여부

false

-MappingToSubnet<CimInstance>

Specifies an IP range that maps to a subnet.

별칭

없음

필수 여부

true

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByValue)

와일드카드 문자 허용 여부

false

-NetworkType<VirtualizationType[]>

Specifies an array of network types for the addresses to be retrieved. 이 매개 변수에 허용되는 값은 다음과 같습니다.

-- 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 a NetworkType but do not specify an AddressSpace, the cmdlet returns all IP address ranges of the given network type.

별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-ServiceInstance<String[]>

Specifies an array of service instances that manage the address ranges to get.

별칭

SI

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-StartIPAddress<IPAddress[]>

Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the ranges to get.

별칭

없음

필수 여부

true

위치

named

기본값

없음

파이프라인 입력 적용 여부

True (ByPropertyName)

와일드카드 문자 허용 여부

false

-ThrottleLimit<Int32>

이 cmdlet을 실행하도록 설정할 수 있는 최대 동시 작업 수를 지정합니다. 이 매개 변수가 생략되거나 값 0이 입력되면 Windows PowerShell®은 컴퓨터에서 실행 중인 CIM cmdlet의 수에 따라 cmdlet에 대한 최적의 제한 한도를 계산합니다. 제한 한도는 현재 cmdlet에만 적용되며 세션이나 컴퓨터에는 적용되지 않습니다.

별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

-Unmapped

Indicates that the cmdlet gets the unmapped ranges.

별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

<CommonParameters>

이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216).

입력

입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.

출력

출력 유형은 cmdlet이 내보내는 개체의 유형입니다.

  • CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range

    An array of IP address ranges that are present in IPAM datastore.

예제

Example 1: Get all IPv4 address ranges

This command gets all private physical IPv4 address ranges, either provider or non virtualized.

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

Example 2: Get all IPv4 ranges for a network type

This command gets all private IPv4 ranges of network type provider that belong to any provider address space.

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

Example 3: Get all IPv4 ranges in the default address space for a provider network type

This command gets all private IPv4 ranges of network type provider that belong to the default address space.

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

Example 4: Get all IPv4 ranges for a customer network type

This command gets all private IPv4 ranges of network type customer, and stores the result in the variable named $PrivateCustomerRanges.

PS C:\> $PrivateCustomerRanges=Get-IpamRange -AddressFamily IPv4 -AddressCategory Private -NetworkType Customer

Example 5: Get all IPv4 ranges for a network type and address space

This command gets all private IPv4 addresses that are of network type Customer that belong to the Contoso customer address space.

PS C:\> $privateCustomerRanges = Get-IpamRange -AddressFamily IPv4 -AddressCategory Private -NetworkType Customer -AddressSpace Contoso

Example 6: Get all IPv4 ranges between two addresses

This command gets the details of a given IP address range, and stores the result in the variable named $Range.

PS C:\> $Range= Get-IpamRange -StartIPAddress 10.12.1.1 -EndIPAddress 10.12.1.254 -ManagedByService IPAM -ServiceInstance localhost

Example 7: Get all overlapping ranges

This command gets all overlapping ranges from the default address space. Both Provider and NonVirtualized ranges can exist in the default address space. In IPAM, IP ranges are marked overlapping if they belong to same address space and their start and end IP addresses overlap.

PS C:\> Get-IpamRange -AddressFamily IPv4 -AddressCategory Private -AddressSpace Default| where {$Overlapping -eq $True}

Example 8: Get all IPv4 ranges for a subnet

This example gets all IP ranges which map to a given subnet. Since the network type of the subnet here is non-virtualized, the results contain only the physical addresses and the fabric addresses from the default address space that maps to this subnet.

The first command uses the Get-IpamSubnet cmdlet to get a subnet, and stores the result in the variable named $ContosoPhysicalSubnet.

The second command gets the IP address ranges and stores the result in the $AddressMappingToSubnet variable.

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

관련 항목

Add-IpamRange

Export-IpamRange

Import-IpamRange

Remove-IpamRange

Set-IpamRange