Set-IpamRange

Set-IpamRange

Modifies an existing IP address range.

Syntax

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

Detaillierte Beschreibung

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

Parameter

-AddCustomConfiguration<String>

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

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

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

-AssignmentDate<DateTime>

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

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

-AssignmentType<AddressAssignment>

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

-ConnectionSpecificDnsSuffix<String>

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

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

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

-Description<String>

Specifies a description for the range to modify.

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

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

-DnsSuffix<String[]>

Specifies an array of suffixes.

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

-EndIPAddress<IPAddress[]>

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

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

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

-ManagedByService<String[]>

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

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

-NetworkType<VirtualizationType[]>

Specifies an array of network types for the addresses to modify. Die folgenden Werte für diesen Parameter sind zulässig:

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

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

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

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

-NewManagedByService<String>

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

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

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

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

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

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

-Owner<String>

Specifies the name of an owner for an address range.

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

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

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

-ServiceInstance<String[]>

Specifies an array of service instances that manage the address ranges to modify.

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

-StartIPAddress<IPAddress[]>

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

Aliasse	Keiner
Erforderlich?	true
Position?	2
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

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

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

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

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

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

• CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range

  Modified IP address range object.

Beispiele

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

Verwandte Themen

Add-IpamRange

Export-IpamRange

Get-IpamRange

Import-IpamRange

Remove-IpamRange