Edit

Share via

Get-IpamAddressSpace

Module:
IpamServer Module

Gets address spaces in IPAM.

Syntax

ByName 

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

ByMapping 

Get-IpamAddressSpace
    -MappingToProviderAddressSpace <String[]>
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

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.

Examples

Example 1: Get all address spaces

PS C:\> Get-IpamAddressSpace

This command gets all address spaces in IPAM.

Example 2: Get an address space

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            :

This command gets the address space named ContosoMusic.

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

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            :

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

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MappingToProviderAddressSpace

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PA

Parameter sets

ByMapping
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

Specifies an array of address space types.

The acceptable values for this parameter are:

  • ProviderAddressSpace
  • CustomerAddressSpace

Parameter properties

Type:

AddressSpaceType[]

Default value:None
Accepted values:ProviderAddressSpace, CustomerAddressSpace
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

IpamAddressSpace

This cmdlet returns an object that represents address space information, including the type of address space which can be CustomerAddressSpace or ProviderAddressSpace.