Set-IpamRange

Set-IpamRange

Modifies an existing IP address range.

Sintaxis

Parameter Set: Query (cdxml)
Set-IpamRange [-StartIPAddress] <IPAddress[]> [-EndIPAddress] <IPAddress[]> [-AddCustomConfiguration <String> ] [-AddressSpace <String[]> ] [-AsJob] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ConnectionSpecificDnsSuffix <String> ] [-CreateSubnetIfNotFound] [-Description <String> ] [-DnsServer <IPAddress[]> ] [-DnsSuffix <String[]> ] [-Gateway <String[]> ] [-ManagedByService <String[]> ] [-NetworkType <VirtualizationType[]> ] [-NewAddressSpace <String> ] [-NewEndIPAddress <IPAddress> ] [-NewManagedByService <String> ] [-NewNetworkId <String> ] [-NewNetworkType <VirtualizationType> ] [-NewServiceInstance <String> ] [-NewStartIPAddress <IPAddress> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-ReservedAddress <String[]> ] [-ServiceInstance <String[]> ] [-ThrottleLimit <Int32> ] [-UtilizationCalculation <UtilizationCalculation> ] [-UtilizedAddresses <Double> ] [-VIP <String[]> ] [-WinsServer <IPAddress[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-IpamRange -InputObject <CimInstance[]> [-AddCustomConfiguration <String> ] [-AsJob] [-AssignmentDate <DateTime> ] [-AssignmentType <AddressAssignment> ] [-CimSession <CimSession[]> ] [-ConnectionSpecificDnsSuffix <String> ] [-CreateSubnetIfNotFound] [-Description <String> ] [-DnsServer <IPAddress[]> ] [-DnsSuffix <String[]> ] [-Gateway <String[]> ] [-NewAddressSpace <String> ] [-NewEndIPAddress <IPAddress> ] [-NewManagedByService <String> ] [-NewNetworkId <String> ] [-NewNetworkType <VirtualizationType> ] [-NewServiceInstance <String> ] [-NewStartIPAddress <IPAddress> ] [-Owner <String> ] [-PassThru] [-RemoveCustomConfiguration <String> ] [-ReservedAddress <String[]> ] [-ThrottleLimit <Int32> ] [-UtilizationCalculation <UtilizationCalculation> ] [-UtilizedAddresses <Double> ] [-VIP <String[]> ] [-WinsServer <IPAddress[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Descripción detallada

The Set-IpamRange cmdlet modifies an existing IP address range that an IP Address Management (IPAM) server manages.

Parámetros

-AddCustomConfiguration<String>

Specifies semi-colon separated name/value pairs. This parameter specifies custom metadata that are associated with the address space.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-AddressSpace<String[]>

Specifies an array of names of address spaces. If you do not specify a value, the cmdlet modifies matching ranges from all address spaces.

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

-AssignmentDate<DateTime>

Specifies the date on which to assign addresses in this range.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-AssignmentType<AddressAssignment>

Specifies the address assignment type from this range. 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

-ConnectionSpecificDnsSuffix<String>

Specifies the connection-specific DNS suffix to associate with this range.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-CreateSubnetIfNotFound

Indicates that the cmdlet creates a parent subnet for this range of addresses. If you specify this parameter, the cmdlet automatically creates a parent subnet for this range, if no parent subnet exists.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-Description<String>

Specifies a description for the range to modify.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-DnsServer<IPAddress[]>

Specifies an array of DNS servers to associate with this range. Specify the names of the DNS servers in the order of preference, highest to lowest.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-DnsSuffix<String[]>

Specifies an array of suffixes.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-EndIPAddress<IPAddress[]>

Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the range to modify.

Alias	ninguno
¿Requerido?	true
¿Posición?	3
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-Gateway<String[]>

Specifies an array of gateway servers, imported from a DHCP scope, to associate with a range in IPAM. Specify the names of the gateway servers in the order of preference, highest to lowest. The format for specification is <ipaddress>\<metric>. To specify Automatic metric, the format is <Ipaddress>\Automatic.

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

-ManagedByService<String[]>

Specifies an array of services that manage the range to modify.

Alias	MB
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-NetworkType<VirtualizationType[]>

Specifies an array of network types for the addresses to modify. Los valores aceptables para este parámetro son los siguientes:

-- Provider
-- Customer
-- NonVirtualized

If you do not specify a value, the cmdlet modifies all matching IP address ranges of network type Provider, Customer, and NonVirtualized.

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 a new address space for the IP address range. A range with network type NonVirtualized can only belong to Default address space. A range with network type Provider can belong to either the Default address space or a Provider address space. A range with network type Customer can only belong to a Customer address space.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-NewEndIPAddress<IPAddress>

Specifies a new IP address. For this parameter, the address represents the new high end of the range. An error occurs if the value is not compatible with the network ID and the starting IP address.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-NewManagedByService<String>

Specifies the name of a new value of the ManagedByService property.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-NewNetworkId<String>

Specifies the name of a new value of the NetworkId property. Choose a value compatible with the existing beginning and ending IP addresses for the range, or specify new values for starting and ending IP addresses.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-NewNetworkType<VirtualizationType>

Specifies the name of a new value of network type for this address. You can change the network type from NonVirtualized to Provider, or from Provider to NonVirtualized. However, you cannot convert 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 the name of a new value of the service instance property. Choose a new value compatible with the value of ManagedByService parameter.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-NewStartIPAddress<IPAddress>

Specifies a new IP address. For this parameter, the address represents the new low end of the range. An error occurs if the value is not compatible with the network ID and the ending IP address.

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 an owner for an address range.

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 list of custom metadata fields to remove from the range object. The list is a string of name-value pairs, separated by semicolons (;).

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-ReservedAddress<String[]>

Specifies an array of reserved addresses from the given range. This list will overwrite the existing list of reserved addresses for the given range.

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 service instances that manage the address ranges to modify.

Alias	SI
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-StartIPAddress<IPAddress[]>

Specifies an array of IP addresses. For this parameter, the addresses represent the low end of the range to modify.

Alias	ninguno
¿Requerido?	true
¿Posición?	2
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

-UtilizationCalculation<UtilizationCalculation>

Specifies whether the utilization information will be automatically calculated by IPAM or specified by the user. The utilization calculation provides a visual alert when the utilization level of IP addresses is greater than a threshold value.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-UtilizedAddresses<Double>

Specifies the number of addresses to utilize from the pool of IP addresses. Use this parameter when the utilization calculation is set to the value in UserSpecified.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-VIP<String[]>

Specifies an array of virtual IP addresses, usually set aside for load balancers, from the range. Specify the VIPs as a list, in descending order of precedence. This list overwrites any existing VIPs specified for the given range.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-WinsServer<IPAddress[]>

Specifies an array of Windows Internet Name Service (WINS) servers to associate with this range. Specify the WINS servers in decreasing order of precedence. This list overwrites any existing list of WINS servers.

Alias	ninguno
¿Requerido?	false
¿Posición?	named
Valor predeterminado	ninguno
¿Aceptar canalización?	True (ByPropertyName)
¿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 (https://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.

• CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range

  Modified IP address range object.

Ejemplos

Example 1: Modify an existing IP address range

This command modifies an existing IP address range that is currently managed by IPAM, to be managed by VMM.

PS C:\> Get-IpamRange -StartIPAddress 10.12.1.1 -EndIPAddress 10.12.1.254|Set-IpamRange -NewManagedByService VMM -NewServiceInstance vmm1.contoso.com -PassThru

Example 2: Add custom metadata to an IP address range

This command adds custom metadata to an IP range by using a custom field to identify the location.

PS C:\> Get-IpamRange -StartIPAddress 10.12.1.1 -EndIPAddress 10.12.1.254|Set-IpamRange -AddCustomConfiguration "ADSite=ContosoCorporate" -PassThru| Format-List Overlapping, StartAddress, EndAddress, ManagedByService, ServiceInstance, CustomConfiguration

Example 3: Modify the network type for an IP address range

This command modifies the network type of an IP address range from non-virtualized to provider. By default, the provider address range will be assigned to the default provider address space.

PS C:\> Set-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254 -ManagedByService IPAM -ServiceInstance localhost -AddressSpace Default -NetworkType NonVirtualized -NewNetworkType Provider -PassThru

Example 4: Modify the network type for an IP address range to its previous state

This command modifies the network type of an IP address range from provider to non-virtualized. The non-virtualized address range will be added to the default address space. You cannot specify the provider address space in this case.

PS C:\> Set-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254 -ManagedByService IPAM -ServiceInstance localhost -AddressSpace Default -NetworkType Provider -NewNetworkType NonVirtualized -PassThru

Example 5: Modify the network type for an IP address range and assign the IP addresses

This command modifies the network type of an IP address from non-virtualized to provider. The command assigns the IP address to the provider address space ContosoDataCenter.

PS C:\> Set-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254 -ManagedByService IPAM -ServiceInstance localhost -AddressSpace Default -NetworkType NonVirtualized -NewNetworkType Provider -NewAddressSpace ContosoDataCenter -PassThru | Format-List IpAddress, NetworkType, ProviderAddressSpace, CustomerAddressSpace

Temas relacionados

Add-IpamRange

Export-IpamRange

Get-IpamRange

Import-IpamRange

Remove-IpamRange