Set-IpamAddress

Set-IpamAddress

Modifies an IP address in IPAM.

構文

Parameter Set: ByAddress
Set-IpamAddress [-IpAddress] <IPAddress[]> [[-ManagedByService] <String[]> ] [[-ServiceInstance] <String[]> ] [-AddCustomConfiguration <String> ] [-AddressSpace <String[]> ] [-AsJob] [-AssetTag <String> ] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ClientId <String> ] [-Description <String> ] [-DeviceName <String> ] [-DeviceType <String> ] [-Duid <String> ] [-ExpiryDate <DateTime> ] [-ForwardLookupPrimaryServer <String> ] [-ForwardLookupZone <String> ] [-Iaid <UInt32> ] [-IpAddressState <String> ] [-MacAddress <String> ] [-NetworkType <VirtualizationType[]> ] [-NewAddressSpace <String> ] [-NewIPAddress <IPAddress> ] [-NewManagedByService <String> ] [-NewNetworkType <VirtualizationType> ] [-NewServiceInstance <String> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-ReservationDescription <String> ] [-ReservationName <String> ] [-ReservationServer <String> ] [-ReservationType <DhcpReservationType> ] [-ReverseLookupPrimaryServer <String> ] [-ReverseLookupZone <String> ] [-SerialNumber <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-IpamAddress -InputObject <CimInstance[]> [-AddCustomConfiguration <String> ] [-AsJob] [-AssetTag <String> ] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ClientId <String> ] [-Description <String> ] [-DeviceName <String> ] [-DeviceType <String> ] [-Duid <String> ] [-ExpiryDate <DateTime> ] [-ForwardLookupPrimaryServer <String> ] [-ForwardLookupZone <String> ] [-Iaid <UInt32> ] [-IpAddressState <String> ] [-MacAddress <String> ] [-NewAddressSpace <String> ] [-NewIPAddress <IPAddress> ] [-NewManagedByService <String> ] [-NewNetworkType <VirtualizationType> ] [-NewServiceInstance <String> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-ReservationDescription <String> ] [-ReservationName <String> ] [-ReservationServer <String> ] [-ReservationType <DhcpReservationType> ] [-ReverseLookupPrimaryServer <String> ] [-ReverseLookupZone <String> ] [-SerialNumber <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-IpamAddress cmdlet modifies an IP address in IP Address Management (IPAM). Specify the IP addresses to modify or use the InputObject parameter to specify an IpamAddress object to modify.

You can use the cmdlet to associate the Dynamic Host Configuration Protocol (DHCP) reservation properties with the IP address. The cmdlet does not create a reservation on the DCHP server. You can use Windows PowerShell for DHCP Server to create a reservation on the DCHP server.

パラメーター

-AddCustomConfiguration<String>

Specifies semi-colon separated name/value pairs of custom metadata. The cmdlet adds the custom configuration metadata to the IP addresses.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-AddressSpace<String[]>

Specifies the address space that is associated with the IP address. The default value is Default.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-AsJob

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-AssetTag<String>

Specifies the asset tag associated with the IP address.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-AssignmentDate<DateTime>

Specifies the date on which you assigned the IP address to a device.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-AssignmentType<AddressAssignment>

Specifies how IPAM assigns the addresses. The default value is Static. このパラメーターに対して使用できる値:

-- Static
-- Dynamic
-- Auto
-- VIP
-- Reserved

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-CimSession<CimSession[]>

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

エイリアス	Session
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ClientId<String>

Specifies the ID of the IPAM client.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-Description<String>

Specifies a description of the IP address assignment for a device.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-DeviceName<String>

Specifies the name of the device to which you assigned the address.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-DeviceType<String>

Specifies the type of device to which you assigned the address. Specify a value that exists in the built-in custom field DeviceType. このパラメーターに対して使用できる値:

-- VM
-- Host

The default value is Host.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-Duid<String>

Specifies the DHCP device unique identifier (DUID) for the client. Clients use the DUID to get an IP address from a DHCPv6 server.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ExpiryDate<DateTime>

Specifies an expiry date for the address. IPAM alerts the administrator when the IP address expires. IPAM does not reclaim expired addresses automatically.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ForwardLookupPrimaryServer<String>

Specifies the name of the DNS server that IPAM uses to resolve host names to IP addresses.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ForwardLookupZone<String>

Specifies the name of the forward look up zone that contains mapping of host names to IP addresses.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-Iaid<UInt32>

Specifies the identity association ID (IAID) of an IPv6 address.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-InputObject<CimInstance[]>

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

エイリアス	なし
必須?	true
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-IpAddress<IPAddress[]>

Specifies an array of IP addresses.

エイリアス	なし
必須?	true
位置は?	2
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-IpAddressState<String>

Specifies the usage state of the IP address. By default, the cmdlet sets the address as In-Use.

You can specify a valid custom value for this parameter. Use the Add-IpamCustomValue cmdlet to add a custom value to a custom field in IPAM.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-MacAddress<String>

Specifies the media access control (MAC) address of the device to which the address is assigned.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ManagedByService<String[]>

Specifies the name of the service that manages the IP address. The value that you specify for this parameter must exist in the set of values that you defined for the ManagedByService custom field in IPAM.

You can use the Add-IpamCustomValue cmdlet to add a value to the ManagedByService custom field in IPAM. You can use the Remove-IpamCustomValue cmdlet to remove a value from the ManagedByService custom field in IPAM.

エイリアス	MB
必須?	false
位置は?	3
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-NetworkType<VirtualizationType[]>

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

-- Provider
-- Customer
-- NonVirtualized

The default value is NonVirtualized.

If you specify Default for the AddressSpace parameter, the valid values for this parameter are Provider and NonVirtualized. If you specify a provider type of address space for the AddressSpace parameter, you must specify Provider for this parameter. If you specify a customer type of address space for the AddressSpace parameter, you must specify Customer for this parameter.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-NewAddressSpace<String>

Specifies the name of the new address space for the IP addresses.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-NewIPAddress<IPAddress>

Specifies an IP address. The cmdlet assigns the new IP address to the IP addresses.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-NewManagedByService<String>

Specifies a new value for the service that manages the IP addresses. The value that you specify for this parameter must exist in the set of values that you defined for the MangedByService custom field in IPAM.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-NewNetworkType<VirtualizationType>

Specifies a new value for network type for the IP addresses. You can change the network type from NonVirtualized to Provider, and from Provider to NonVirtualized. You cannot be change the network type from NonVirtualized or Provider to Customer.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-NewServiceInstance<String>

Specifies a new value for the instance of the service that manages the IP addresses. The value that you specify for this parameter must exist in the set of values that you defined for the ServiceInstance custom field in IPAM.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-Owner<String>

Specifies the name of the owner of the IP addresses.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-PassThru

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

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RemoveCustomConfiguration<String>

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

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ReservationDescription<String>

Specifies a description for the DCHP reservation.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ReservationName<String>

Specifies the name of the reservation on the DHCP server for the device. You must specify a value for this parameter if you specify the ReservationServer parameter.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ReservationServer<String>

Specifies the DHCP server on which the reservation is assigned. The cmdlet stores the reservation data in IPAM. The cmdlet does not create a reservation on the DHCP server.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ReservationType<DhcpReservationType>

Specifies the protocols supported by the reservation. You must specify a value for this parameter if you specify the ReservationServer parameter. このパラメーターに対して使用できる値:

-- DHCP
-- BootPr
-- DHCP and BootPr

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ReverseLookupPrimaryServer<String>

Specifies the DNS server that IPAM uses to resolve IP addresses to host names.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ReverseLookupZone<String>

Specifies the reverse lookup zone that contains mapping from IP addresses to fully qualified domain names (FQDN).

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-SerialNumber<String>

Specifies the serial number of the device to which you assigned the address.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ServiceInstance<String[]>

Specifies an array of instances of the services that manage the IP addresses. Specify the instances of the services that you specified for the ManagedByService parameter. If you specify this parameter, you must specify the IpAddress parameter. The value that you specify for this parameter must exist in the set of values that you defined for the ServiceInstance parameter.

エイリアス	SI
必須?	false
位置は?	4
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ThrottleLimit<Int32>

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

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Confirm

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

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

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

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

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

入力

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

出力

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

• IpamAddress

  Represents an IP Address on the IPAM server.

例

Example 1: Reassign an IP address

This command gets an IpamAddress object that contains the IP address 172.16.10.10 that is managed by IPAM. The command passes the IpamAddress object to the Set-IpamAddress cmdlet by using the pipeline operator. The Set-IpamAddress cmdlet changes the service that manages the IP address to VMM, and changes the instance of the service that manages the IP address to vmm1.contoso.com. The command assigns the address to the VM device type.

PS C:\> Get-IpamAddress -IpAddress 172.16.10.10 | Set-IpamAddress -NewManagedByService "VMM" -NewServiceInstance "vmm1.contoso.com" -DeviceType "VM" -PassThru

Example 2: Add custom metadata to an IP address

This command adds custom metadata to the IP address 172.16.10.10. The command adds the value Main to the custom field named ADSite.

PS C:\> Get-IpamAddress -IpAddress 172.16.10.10 | Set-IpamAddress -AddCustomConfiguration "ADSite=Main"

Example 3: Convert the network type of an IP address from non-virtualized to provider

This command converts the network type of the IP address 172.16.10.10 from non-virtualized to provider. The command assigns the provider address to the default provider address space.

PS C:\> Set-IpamAddress -IpAddress 172.16.10.10 -AddressSpace "Default" -NetworkType NonVirtualized -NewNetworkType Provider

Example 4: Convert the network type of an IP address from provider to non-virtualized

This command converts the network type of the IP address 172.16.10.10 from provider to non-virtualized. By default, the command assigns the non-virtualized address to the Default address space. The command passes the output to the Format-List cmdlet by using the pipeline operator, and formats the output as a table. For more information, type Get-Help Format-List.

PS C:\> Set-IpamAddress -IpAddress 172.16.10.10 -NetworkType Provider -NewNetworkType NonVirtualized -PassThru | Format-List IpAddress, NetworkType, ProviderAddressSpace, CustomerAddressSpace

Example 5: Assign an IP address to a new address space

This command converts the network type of the IP address 172.16.10.10 from non-virtualized to provider. The command assigns the IP address to the provider address space named MainDataCenter. The command passes the output to the Format-List cmdlet by using the pipeline operator, and formats the output as a table.

PS C:\> Set-IpamAddress -IpAddress 172.16.10.10 -NetworkType NonVirtualized -NewNetworkType Provider -NewAddressSpace MainDataCenter -PassThru | Format-List IpAddress, NetworkType, ProviderAddressSpace, CustomerAddressSpace

関連トピック

Get-IpamAddress

Add-IpamAddress

Remove-IpamAddress

Import-IpamAddress

Export-IpamAddress