Export (0) Print
Expand All
Expand Minimize

Get-IpamAddressSpace

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-IpamAddressSpace

Gets address spaces in IPAM.

Syntax

Parameter Set: ByMapping
Get-IpamAddressSpace -MappingToProviderAddressSpace <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByName
Get-IpamAddressSpace [[-Name] <String[]> ] [[-Type] <AddressSpaceType[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-IpamAddressSpace cmdlet gets address spaces in IP Address Management (IPAM). You can specify the MappingToProviderAddressSpace parameter to get all customer address spaces that belong to a provider address group. Customer address spaces in IPAM belong to a single provider address space. You can use the Name parameter to get address spaces that match the address space names that you specify. You can use the Type parameter to gets address spaces that match the types of address spaces that you specify. You can use wildcards for the Name parameter. Use wildcards to gets all address spaces that have a specified prefix or suffix. If you do not specify any parameters, the cmdlet gets all address spaces in IPAM.

Parameters

-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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MappingToProviderAddressSpace<String[]>

Specifies an array of names of provider address spaces. The cmdlet gets all customer address spaces which belong to the provider address spaces.


Aliases

PA

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of the address spaces. The cmdlet gets all address spaces that match the names that you specify.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Type<AddressSpaceType[]>

Specifies an array of address space types. The acceptable values for this parameter are: 

-- ProviderAddressSpace
-- CustomerAddressSpace


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • IpamAddressSpace



    Address space information, including the type of address space (CustomerAddressSpace or ProviderAddressSpace).



Examples

Example 1: Get all address spaces

This command gets all address spaces in IPAM.


PS C:\> Get-IpamAddressSpace

Example 2: Get an address space

This command gets the address space named ContosoMusic.


PS C:\> Get-IpamAddressSpace -Name "ContosoMusic"
Name                           : ContosoMusic

Type : CustomerAddressSpace

Owner :

Description : Music Mp3

AssociatedProviderAddressSpace : MainDatacenter

Tenant : 4001

VMNetwork : ContosoMusic_Network

IsolationMethod : NVGRE

Ipv4PercentageUtilized : 62.0805369127517

Ipv6PercentageUtilized : 0

CustomConfiguration :

Example 3: Retrieve all customer address spaces that map to a provider address space

This command gets all customer address spaces that belong to the provider address space named MainDataCenter.


PS C:\> Get-IpamAddressSpace -MappingToProviderAddressSpace "MainDataCenter"
Name                           : TreyResearch

Type : CustomerAddressSpace

Owner :

Description : A research and design company

AssociatedProviderAddressSpace : MainDatacenter

Tenant : 1001

VMNetwork : Trey Research_Network

IsolationMethod : NVGRE

Ipv4PercentageUtilized : 15.1515151515152

Ipv6PercentageUtilized : 0

CustomConfiguration :
Name : ContosoMusic

Type : CustomerAddressSpace

Owner :

Description : Music Mp3

AssociatedProviderAddressSpace : MainDatacenter

Tenant : 4001

VMNetwork : ContosoTunes_Network

IsolationMethod : NVGRE

Ipv4PercentageUtilized : 62.0805369127517

Ipv6PercentageUtilized : 0

CustomConfiguration :

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft