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[]>

원격 세션에서 또는 원격 컴퓨터에서 cmdlet을 실행합니다. New-CimSession 또는 Get-CimSession cmdlet의 출력과 같은 컴퓨터 이름이나 세션 개체를 입력합니다. 기본값은 로컬 컴퓨터의 현재 세션입니다.

별칭	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[]>

이 cmdlet에 대한 입력을 지정합니다. 이 매개 변수를 사용하거나 입력을 이 cmdlet으로 파이프할 수 있습니다.

별칭	없음
필수 여부	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

작업하고 있는 항목을 나타내는 개체를 반환합니다. 기본적으로 이 cmdlet은 출력을 생성하지 않습니다.

별칭	없음
필수 여부	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>

이 cmdlet을 실행하도록 설정할 수 있는 최대 동시 작업 수를 지정합니다. 이 매개 변수가 생략되거나 값 0이 입력되면 Windows PowerShell®은 컴퓨터에서 실행 중인 CIM cmdlet의 수에 따라 cmdlet에 대한 최적의 제한 한도를 계산합니다. 제한 한도는 현재 cmdlet에만 적용되며 세션이나 컴퓨터에는 적용되지 않습니다.

별칭	없음
필수 여부	false
위치	named
기본값	없음
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

-Confirm

cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.

필수 여부	false
위치	named
기본값	false
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

-WhatIf

cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.

필수 여부	false
위치	named
기본값	false
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

<CommonParameters>

이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216).

입력

입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.

출력

출력 유형은 cmdlet이 내보내는 개체의 유형입니다.

• 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