Export-IpamSubnet

Export-IpamSubnet

Exports the IP address subnets of an address family on the computer that runs IPAM.

構文

Parameter Set: ExportSubnet1
Export-IpamSubnet -AddressFamily <AddressFamily> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-NetworkType <VirtualizationType> ] [-PassThru] [-Path <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

詳細説明

The Export-IpamSubnet cmdlet exports all of the IP address subnets of an address family on the computer that runs IP Address Management (IPAM). The output is a comma-separated value (.csv) file, or an array of Windows PowerShell objects, or both. Use this cmdlet to export non-virtualized and virtualized address subnets.

You must specify either the Path parameter or the PassThru parameter. The object array returned when using the PassThru parameter can be pipelined for additional filtering. The Force parameter can be used to overwrite an existing .csv file with the same name as specified in the Path parameter.

Unlike the localized object export from a computer running the IPAM client user interface (UI), the field header names and the enum value names of IP address subnet objects exported by Windows PowerShell have English names and are not localized in the language used by the server. The field header names follow the Windows PowerShell property naming conventions.

The cmdlet outputs the date and time values of the exported objects in the localized format of the computer that runs IPAM, and not in UTC.

パラメーター

-AddressFamily<AddressFamily>

Specifies an address family of IP address range objects to retrieve. このパラメーターに対して使用できる値:

-- IPv4
-- IPv6

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

-NetworkType<VirtualizationType>

Specifies the type of network for the given IP subnet. このパラメーターに対して使用できる値:

-- Provider
-- Customer
-- NonVirtualized

If the value of the AddressSpace parameter is Default, then this parameter can take the value Provider or NonVirtualized. If the value of the AddressSpace 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 AddressSpace 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.

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-Path<String>

Specifies the fully qualified path and name of the file to create. Use this parameter to export all IP address subnet objects to a .csv file format.

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Subnet

  Represents a set of IP subnets in IPAM datastore.

例

Example 1: Export all IPv4 address subnets

This command exports all of the IPv4 address subnets that belong to the default address space to the file Subnets_v4.csv.

PS C:\> Export-IpamSubnet -AddressFamily IPv4 -AddressSpace Default -Path "C:\Subnets_v4.csv"

Example 2: Export all IPv6 address subnets

This command exports all IPv6 address ranges to the file Ranges_v6.csv, and overwrites the file if it already exists.

PS C:\> Export-IpamRange -AddressFamily IPv6 -Path "C:\Ranges_v6.csv" -Force

Example 3: Export all IPv4 address subnets for an address space

This command exports all IPv4 address subnets of network type Provider that belong to the ContosoDataCenter address space. The cmdlet writes the output to the file Subnets_v4.csv.

PS C:\> Export-IpamSubnet -AddressFamily IPv4 -AddressSpace ContosoDataCenter -NetworkType Provider -Path "C:\Subnets_v4.csv"

関連トピック

Export-IpamSubnet

Get-IpamSubnet

Import-IpamSubnet

Remove-IpamSubnet

Set-IpamSubnet