Add-IpamAddress
Add-IpamAddress
Adds an IP address to IPAM.
構文
Parameter Set: AddAddress0
Add-IpamAddress [-IpAddress] <IPAddress> [[-ManagedByService] <String> ] [[-ServiceInstance] <String> ] [-AddressSpace <String> ] [-AsJob] [-AssetTag <String> ] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ClientId <String> ] [-CustomConfiguration <String> ] [-Description <String> ] [-DeviceName <String> ] [-DeviceType <String> ] [-Duid <String> ] [-ExpiryDate <DateTime> ] [-ForwardLookupPrimaryServer <String> ] [-ForwardLookupZone <String> ] [-Iaid <UInt32> ] [-IpAddressState <String> ] [-MacAddress <String> ] [-NetworkType <VirtualizationType> ] [-Owner <String> ] [-PassThru] [-ReservationDescription <String> ] [-ReservationName <String> ] [-ReservationServer <String> ] [-ReservationType <DhcpReservationType> ] [-ReverseLookupPrimaryServer <String> ] [-ReverseLookupZone <String> ] [-SerialNumber <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Add-IpamAddress cmdlet adds an IP address to IP Address Management (IPAM). 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 DHCP server. You can use Windows PowerShell for DHCP Server to create a reservation on the DHCP server.
パラメーター
-AddressSpace<String>
Specifies the address space that is associated with the IP address. The default value is Default.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
Default |
パイプライン入力を許可する |
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. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-AssignmentType<AddressAssignment>
Specifies how IPAM assigns this address. このパラメーターに対して使用できる値:
-- Static
-- Dynamic
-- Auto
-- VIP
-- Reserved
The default value is Static.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
Static |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ClientId<String>
Specifies the ID of the client.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-CustomConfiguration<String>
Specifies semicolon-separated name/value pairs. This parameter specifies custom metadata that is associated with the address.
エイリアス |
なし |
必須? |
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 DeviceType custom field. このパラメーターに対して使用できる値:
-- VM
-- Host
The default value is Host.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
Host |
パイプライン入力を許可する |
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 lookup zone that contains a mapping of host names to IP addresses.
エイリアス |
FwdLookupZone |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Iaid<UInt32>
Specifies the identity association ID (IAID) of an IPv6 address.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-IpAddress<IPAddress>
Specifies an IP address. The cmdlet adds the IP address to IPAM.
エイリアス |
なし |
必須? |
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.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
In-Use |
パイプライン入力を許可する |
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 |
既定値 |
IPAM |
パイプライン入力を許可する |
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 |
既定値 |
NonVirtualized |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Owner<String>
Specifies the name of the owner of the address.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-PassThru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ReservationDescription<String>
Specifies a description for the DHCP 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 that the reservation supports. 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 the mapping from IP addresses to fully qualified domain names (FQDNs).
エイリアス |
RevLookupZone |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-SerialNumber<String>
Specifies the serial number of the device that is associated with the IP address.
エイリアス |
SN |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ServiceInstance<String>
Specifies the instance of the service that manages the IP address. Specify the instance of the service that you specified for the ManagedByService parameter. 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.
エイリアス |
SI |
必須? |
false |
位置は? |
4 |
既定値 |
Localhost |
パイプライン入力を許可する |
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: Add a physical IP address to the IPAM server
This command adds the physical IP address 10.12.3.5 to the default address space that the current instance of the IPAM server manages. The command uses the following default values for the address:
-- ManagedByService parameter uses the default value IPAM
-- ServiceInstance parameter uses the default value Localhost
-- DeviceType parameter uses the default value Host
-- AssignmentType parameter uses the default value Static
PS C:\> Add-IpamAddress -IpAddress 10.12.3.5 -PassThru
Example 2: Assign a dynamic IP address to a virtual machine
This command assigns the IP address 10.12.4.8 to a virtual machine. The command specifies that the DHCP server named dhcp1.contoso.com manages the address. The command specifies that the address expires in two weeks, at which time you can reclaim it.
PS C:\> Add-IpamAddress -IpAddress 10.12.4.9 -ManagedByService "TSQA DHCP" -ServiceInstance "dhcp1.contoso.com" -AssignmentType Dynamic -DeviceType VM -ExpiryDate $TwoWeeksFromNow -PassThru
Example 3: Add a provider IP address to the IPAM server
This command adds the provider IP address 172.16.10.16 (which the current instance of IPAM manages) to the default address space.
PS C:\> Add-IpamAddress -NetworkType Provider -IpAddress 172.16.10.16 -PassThru
Example 4: Add a provider IP address that Virtual Machine Manager manages
This command adds a provider IP address that is managed by and belongs to the provider address space named Datacenter01. statically manages the address assignment. Because this address is in a different address space, IPAM does not mark it as a duplicate.
PS C:\> Add-IpamAddress -IpAddress 172.16.10.16 -AddressSpace "Datacenter01" -ManagedByService VMM -ServiceInstance "vmm1.contoso.com" -PassThru
Example 5: Add a customer IP address that a Virtual Machine Manager instance manages
This command adds a customer IP address that the instance vmm01.contoso.com manages. The address is added to the customer address space for the tenant named Datacenter01.
PS C:\> Add-IpamAddress -IpAddress 172.16.10.16 -Virtual -AddressSpace "Datacenter01" -ManagedByService VMM -ServiceInstance "vmm01.contoso.com" -DeviceType VM