Get-IpamSubnet

Get-IpamSubnet

Gets a set of subnets from IPAM.

Syntax

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

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

Parameter Set: ById
Get-IpamSubnet -NetworkId <String[]> [-AddressSpace <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-NetworkType <VirtualizationType[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detaillierte Beschreibung

The Get-IpamSubnet cmdlet gets a set of IP subnets from IP Address Management (IPAM). By default, the cmdlet gets all IP addresses of a given address family from all address spaces configured in IPAM. Use the NetworkType and AddressSpace parameters to filter the result for Provider and Customer subnets, or NonVirtualized subnets.

This cmdlet also provides parameter sets to retrieve all subnets that map to a given IP address block.

Parameter

-AddressFamily<AddressFamily[]>

Specifies an address family of IP addresses.Die folgenden Werte für diesen Parameter sind zulässig:

-- IPv4
-- IPv6

Aliasse

Keiner

Erforderlich?

true

Position?

2

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

-AddressSpace<String[]>

Specifies an array of names of address spaces. If you not specify an address space, the cmdlet gets data for all address spaces configured in IPAM.

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

-AsJob

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-CimSession<CimSession[]>

Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliasse

Session

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-MappingToBlock<CimInstance>

Specifies the subnets that map to an address block.

Aliasse

Keiner

Erforderlich?

true

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByValue)

Platzhalterzeichen akzeptieren?

false

-NetworkId<String[]>

Specifies an array of networks and prefixes. Specify the network ID in Classless Interdomain Routing (CIDR) notation in the format Network/Prefix.

Aliasse

Keiner

Erforderlich?

true

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

-NetworkType<VirtualizationType[]>

Specifies the type of network for the given subnet. Die folgenden Werte für diesen Parameter sind zulässig:

-- 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 do not specify this parameter, the cmdlet returns all subnets that match the criteria, regardless of network type.

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

-ThrottleLimit<Int32>

Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0 eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Unmapped

Indicates that the cmdlet gets subnets that are not mapped to any IP address block.

Aliasse

Keiner

Erforderlich?

false

Position?

named

Standardwert

Keiner

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

  • IpamSubnet

Beispiele

Example 1 Get all overlapping subnets

This command gets all overlapping subnets in the default address space, including Provider and NonVirtualized subnets in the default address space.

PS C:\> Get-IpamSubnet -AddressFamily IPv4 -AddressSpace Default | where {$_.Overlapping -eq $false} 

Example 2: Get all non-virtualized subnets in a site

This command gets all non-virtualized subnets assigned to the site named Contoso AD-Site.

PS C:\> Get-IpamSubnet -AddressFamily IPv4 -NetworkType NonVirtualized|where {$_.CustomConfiguration -Like "*ADSite=Contoso*"}| Format-List Name, NetworkId, CustomConfiguration

Example 3: Get all IPv4 subnets

This command gets all provider IPv4 subnets in the default address space.

PS C:\> Get-IpamSubnet -AddressFamily IPv4 -NetworkType Provider -AddressSpace Default

Example 4: Get all unmapped non-virtualized subnets

This command gets all unmapped non-virtualized subnets in the default address space

PS C:\> Get-IpamSubnet -AddressFamily IPv4 -NetworkType NonVirtualized -Unmapped

Example 5: Get all subnets in a customer address space

This command gets all subnets that belong to the ContosoWest customer address space and a logical network.

PS C:\> Get-IpamSubnet -AddressFamily IPv4 -NetworkType Customer -AddressSpace ContosoWest|Where {$_.VmmLogicalNetwork -eq "Storage"}

Verwandte Themen

Add-IpamSubnet

Export-IpamSubnet

Import-IpamSubnet

Remove-IpamSubnet

Set-IpamSubnet