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

Detaillierte Beschreibung

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.

Parameter

-AddCustomConfiguration<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-AddressSpace<String[]>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-AsJob

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-AssetTag<String>

Specifies the asset tag associated with the IP address.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-AssignmentDate<DateTime>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-AssignmentType<AddressAssignment>

Specifies how IPAM assigns the addresses. The default value is Static. Die folgenden Werte für diesen Parameter sind zulässig:

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-CimSession<CimSession[]>

Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliasse	Session
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ClientId<String>

Specifies the ID of the IPAM client.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-Description<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-DeviceName<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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. Die folgenden Werte für diesen Parameter sind zulässig:

-- VM
-- Host

The default value is Host.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ForwardLookupPrimaryServer<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ForwardLookupZone<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-Iaid<UInt32>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-InputObject<CimInstance[]>

Gibt die Eingabe für dieses Cmdlet an. Sie können diesen Parameter verwenden oder die Eingabe über die Pipeline an dieses Cmdlet übergeben.

Aliasse	Keiner
Erforderlich?	true
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByValue)
Platzhalterzeichen akzeptieren?	false

-IpAddress<IPAddress[]>

Specifies an array of IP addresses.

Aliasse	Keiner
Erforderlich?	true
Position?	2
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-MacAddress<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	MB
Erforderlich?	false
Position?	3
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-NetworkType<VirtualizationType[]>

Specifies the network type of the address. Die folgenden Werte für diesen Parameter sind zulässig:

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-NewAddressSpace<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-NewIPAddress<IPAddress>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-Owner<String>

Specifies the name of the owner of the IP addresses.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-RemoveCustomConfiguration<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ReservationDescription<String>

Specifies a description for the DCHP reservation.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ReservationType<DhcpReservationType>

Specifies the protocols supported by the reservation. You must specify a value for this parameter if you specify the ReservationServer parameter. Die folgenden Werte für diesen Parameter sind zulässig:

-- DHCP
-- BootPr
-- DHCP and BootPr

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ReverseLookupPrimaryServer<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ReverseLookupZone<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-SerialNumber<String>

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

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	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.

Aliasse	SI
Erforderlich?	false
Position?	4
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ThrottleLimit<Int32>

Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0 eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Confirm

Sie werden vor dem Ausführen des Cmdlets zur Bestätigung aufgefordert.

Erforderlich?	false
Position?	named
Standardwert	falsch
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?	false
Position?	named
Standardwert	falsch
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

• IpamAddress

  Represents an IP Address on the IPAM server.

Beispiele

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

Verwandte Themen

Get-IpamAddress

Add-IpamAddress

Remove-IpamAddress

Import-IpamAddress

Export-IpamAddress