Set-IpamAddressSpace

Set-IpamAddressSpace

Modifies address spaces in IPAM.

構文

Parameter Set: ByName
Set-IpamAddressSpace [-Name] <String[]> [-AddCustomConfiguration <String> ] [-AsJob] [-AssociatedProviderAddressSpace <String> ] [-CimSession <CimSession[]> ] [-Description <String> ] [-IsolationMethod <String> ] [-NewName <String> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-Tenant <String> ] [-ThrottleLimit <Int32> ] [-VmNetwork <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-IpamAddressSpace -InputObject <CimInstance[]> [-AddCustomConfiguration <String> ] [-AsJob] [-AssociatedProviderAddressSpace <String> ] [-CimSession <CimSession[]> ] [-Description <String> ] [-IsolationMethod <String> ] [-NewName <String> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-Tenant <String> ] [-ThrottleLimit <Int32> ] [-VmNetwork <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-IpamAddressSpace cmdlet modifies address spaces in IP Address Management (IPAM). Specify the address spaces to modify, or use the InputObject parameter to specify an IpamAddressSpace object to modify. You must specify at least one optional parameter in addition to the Name parameter or InputObject parameter.

パラメーター

-AddCustomConfiguration<String>

Specifies semi-colon separated name/value pairs. This parameter specifies custom metadata that are associated with the address space.

-AsJob

-AssociatedProviderAddressSpace<String>

Specifies the provider address space that is associated with the customer address space. Customer address spaces in IPAM belong to a single provider address space.

-CimSession<CimSession[]>

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

-Description<String>

Specifies a description of the address space.

-InputObject<CimInstance[]>

このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。

-IsolationMethod<String>

Specifies the network virtualization mechanism for the address space. このパラメーターに対して使用できる値:

-- NVGRE
-- IPRewrite

-Name<String[]>

Specifies an array of names of the address spaces. The cmdlet modifies the address spaces.

-NewName<String>

Specifies a new name for the address space.

-Owner<String>

Specifies the owner of the address space.

-PassThru

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

-RemoveCustomConfiguration<String>

Specifies a semi-colon separated string of custom field names. The cmdlet removes the custom field names from the address spaces.

-Tenant<String>

Specifies the tenant ID, as a string, that is associated with the customer address space. You must specify a tenant ID that is associated with the virtual machine network that you specify for the VmNetwork parameter.

-ThrottleLimit<Int32>

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

-VmNetwork<String>

Specifies the name of the virtual machine network for the customer address space. You must specify a virtual network that is associated with the tenant that you specify for the Tenant parameter.

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

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

入力

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

出力

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

• IpamAddressSpace

  An object that represents an address space in IPAM.

例

Example 1: Rename an address space

This command renames the address space named OneDataCenter to MainDataCenter.

PS C:\> Set-IpamAddressSpace -Name "OneDataCenter" -NewName "MainDataCenter" -PassThru

Example 2: Change the provider address space for a customer address space

This command changes the provider address space that is associated with a customer address space. The command uses the Get-IpamAddressSpace cmdlet to get an IpamAddressSpace object that contains the customer address space named WoodgroveAddSpace. The command passes the object to the Set-IpamAddressSpace cmdlet by using the pipeline operator. The command sets the provider address space named MainDataCenter for the customer address space stored in the IpamAddressSpace object.

PS C:\> Get-IpamAddressSpace -Name "WoodgroveAddSpace" | Set-IpamAddressSpace -AssociatedProviderAddressSpace "MainDataCenter" -PassThru

関連トピック

Get-IpamAddressSpace

Add-IpamAddressSpace

Remove-IpamAddressSpace