Set-IpamBlock

Set-IpamBlock

Modifies an IP address block in IPAM.

構文

Parameter Set: ByKeySet
Set-IpamBlock [-NetworkId] <String[]> [-StartIPAddress] <IPAddress[]> [-EndIPAddress] <IPAddress[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-LastAssignedDate <DateTime> ] [-NewEndIpAddress <IPAddress> ] [-NewNetworkId <String> ] [-NewStartIpAddress <IPAddress> ] [-Owner <String> ] [-PassThru] [-Rir <String> ] [-RirReceivedDate <DateTime> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-IpamBlock -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-LastAssignedDate <DateTime> ] [-NewEndIpAddress <IPAddress> ] [-NewNetworkId <String> ] [-NewStartIpAddress <IPAddress> ] [-Owner <String> ] [-PassThru] [-Rir <String> ] [-RirReceivedDate <DateTime> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-IpamBlock cmdlet modifies an IP address block in IP Address Management (IPAM). Specify an address block by using the StartIPAddress and EndIPAddress parameters, or use the InputObject parameter to specify the input to this cmdlet.

If you specify the NewStartIpAddress, NewEndIpAddress, or NewNetworkId parameters, the cmdlet resets the utilization trend information for the address block.

パラメーター

-AsJob

-CimSession<CimSession[]>

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

-Description<String>

Specifies a description for the address block.

-EndIPAddress<IPAddress[]>

Specifies the end address of the IP address block. If you specify this parameter, you must specify the StartIPAddress parameter.

-InputObject<CimInstance[]>

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

-LastAssignedDate<DateTime>

Specifies the last date, as a DateTime object, on which the block was assigned to devices on a network. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.

-NetworkId<String[]>

Specifies the IP network prefix, in Classless Interdomain Routing (CIDR) notation, for the network block that you want modified.

-NewEndIpAddress<IPAddress>

Specifies a new value for the end IP address of the address block. Specify a value that is compatible with the values that you specify for the NewNetworkId and NewStartIPAddress parameters.

-NewNetworkId<String>

Specifies an IP network prefix, in Classless Interdomain Routing (CIDR) notation. This is the new value for the network from which the IP address block is added to IPAM.

Specify a value that is compatible with the values that you specify for the NewStartIPAddress and NewEndIpAddress parameters.

-NewStartIpAddress<IPAddress>

Specifies a new value for the start IP address of the address block. Specify a value that is compatible with the values that you specify for the NewNetworkId and NewEndIPAddress parameters.

-Owner<String>

Specifies the owner of the IP address block.

-PassThru

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

-Rir<String>

Specifies the regional internet registry (RIR) for public addresses. RIR is a built-in custom field in the IPAM server that contains the following built-in values:

-- AFRINIC
-- APNIC
-- ARIN
-- LACNIC
-- RIPE

-RirReceivedDate<DateTime>

Specifies the date, as a DateTime object, when you obtained the public address block from the RIR.

-StartIPAddress<IPAddress[]>

Specifies the start address for the IP address block. If you specify this parameter, you must specify the EndIPAddress parameter.

-ThrottleLimit<Int32>

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

-Confirm

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

-WhatIf

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

<CommonParameters>

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

入力

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

出力

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

• IpamBlock

  Represents an address block object in IPAM.

例

Example 1: Modify the description child IP address ranges

This example modifies the description of all child IP address ranges that belongs to an address block.

The first command gets an IpamBlock object that contains the IP address block from the network that has the ID 10.0.0.0/8. The command stores the IpamBlock object in the $Parent variable.

The second command gets all the child IP address ranges for the address block stored in the $Parent variable. The command passes the child IP address ranges to the Set-IpamBlock cmdlet by using the pipeline operator. The command modifies the description for the child IP address ranges.

PS C:\> $Parent = Get-IpamBlock -NetworkId "10.0.0.0/8" -StartIPAddress 10.0.0.0 -EndIPAddress 10.255.255.255PS C:\>Get-IpamBlock -MappingToParentBlock $Parent | Set-IpamBlock -Description "IP Blocks assigned to Site01" -PassThru

Example 2: Modify key properties of an address block

This command uses the Get-IpamBlock to gets the IP address block from the network that has the ID 10.11.0.0/16. The command specifies the start and end address of the address block. The command passes the address block to the Set-IpamBlock cmdlet by using the pipeline operator. The Set-IpamBlock cmdlet specifies new values for the network ID, start address and end address for the address block. Because the command modifies the network ID, start address, and end address of the address block, the command resets the utilization trend of the address block.

PS C:\> Get-IpamBlock -NetworkId "10.11.0.0/16" -StartIPAddress 10.11.0.0 -EndIPAddress 10.11.255.255 | Set-IpamBlock -NewNetworkId 10.13.0.0/16 -NewStartIPAddress 10.13.0.0 -NewEndIpAddress 10.13.255.255

関連トピック

Get-IpamBlock

Add-IpamBlock

Remove-IpamBlock