Set-IpamAddress

Set-IpamAddress

Modifies an IP address in IPAM.

Syntax

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

Detailed Description

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.

Parameters

-AddCustomConfiguration<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AddressSpace<String[]>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AssetTag<String>

Specifies the asset tag associated with the IP address.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AssignmentDate<DateTime>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AssignmentType<AddressAssignment>

Specifies how IPAM assigns the addresses. The default value is Static. The acceptable values for this parameter are:

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ClientId<String>

Specifies the ID of the IPAM client.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Description<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DeviceName<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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. The acceptable values for this parameter are:

-- VM
-- Host

The default value is Host.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ForwardLookupPrimaryServer<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ForwardLookupZone<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Iaid<UInt32>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-IpAddress<IPAddress[]>

Specifies an array of IP addresses.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MacAddress<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	MB
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NetworkType<VirtualizationType[]>

Specifies the network type of the address. The acceptable values for this parameter are:

-- 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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NewAddressSpace<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-NewIPAddress<IPAddress>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Owner<String>

Specifies the name of the owner of the IP addresses.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RemoveCustomConfiguration<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ReservationDescription<String>

Specifies a description for the DCHP reservation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ReservationType<DhcpReservationType>

Specifies the protocols supported by the reservation. You must specify a value for this parameter if you specify the ReservationServer parameter. The acceptable values for this parameter are:

-- DHCP
-- BootPr
-- DHCP and BootPr

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ReverseLookupPrimaryServer<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ReverseLookupZone<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SerialNumber<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	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.

Aliases	SI
Required?	false
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• IpamAddress

  Represents an IP Address on the IPAM server.

Examples

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

Related topics

Get-IpamAddress

Add-IpamAddress

Remove-IpamAddress

Import-IpamAddress

Export-IpamAddress