Set-IpamAddress

Windows Server 2012 R2 and Windows 8.1

Set-IpamAddress

Modifies an IP address in IPAM.

Sintaxis

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




Descripción detallada

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.

Parámetros

-AddCustomConfiguration<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-AddressSpace<String[]>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-AsJob

Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-AssetTag<String>

Specifies the asset tag associated with the IP address.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-AssignmentDate<DateTime>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-AssignmentType<AddressAssignment>

Specifies how IPAM assigns the addresses. The default value is Static. Los valores aceptables para este parámetro son los siguientes:

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.


Alias

Session

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-ClientId<String>

Specifies the ID of the IPAM client.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-Description<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-DeviceName<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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. Los valores aceptables para este parámetro son los siguientes:

-- VM
-- Host

The default value is Host.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-ForwardLookupPrimaryServer<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-ForwardLookupZone<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-Iaid<UInt32>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-InputObject<CimInstance[]>

Especifica la entrada para este cmdlet. Puede usar este parámetro o puede canalizar la entrada a este cmdlet.


Alias

ninguno

¿Requerido?

true

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByValue)

¿Aceptar caracteres comodín?

false

-IpAddress<IPAddress[]>

Specifies an array of IP addresses.


Alias

ninguno

¿Requerido?

true

¿Posición?

2

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-MacAddress<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

MB

¿Requerido?

false

¿Posición?

3

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-NetworkType<VirtualizationType[]>

Specifies the network type of the address. Los valores aceptables para este parámetro son los siguientes:

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-NewAddressSpace<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-NewIPAddress<IPAddress>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-Owner<String>

Specifies the name of the owner of the IP addresses.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-RemoveCustomConfiguration<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-ReservationDescription<String>

Specifies a description for the DCHP reservation.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-ReservationType<DhcpReservationType>

Specifies the protocols supported by the reservation. You must specify a value for this parameter if you specify the ReservationServer parameter. Los valores aceptables para este parámetro son los siguientes:

-- DHCP
-- BootPr
-- DHCP and BootPr


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-ReverseLookupPrimaryServer<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-ReverseLookupZone<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-SerialNumber<String>

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


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

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.


Alias

SI

¿Requerido?

false

¿Posición?

4

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByPropertyName)

¿Aceptar caracteres comodín?

false

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.


¿Requerido?

false

¿Posición?

named

Valor predeterminado

falso

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.


¿Requerido?

false

¿Posición?

named

Valor predeterminado

falso

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

  • IpamAddress



    Represents an IP Address on the IPAM server.



Ejemplos

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

Temas relacionados

Adiciones de comunidad

AGREGAR
Mostrar: