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>]
Detailed Description
The Set-IpamRange cmdlet modifies an existing IP address range that an IP Address Management (IPAM) server manages.
Parameters
-AddCustomConfiguration<String>
Specifies semi-colon separated name/value pairs. This parameter specifies custom metadata that are associated with the address space.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
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 |
-AssignmentDate<DateTime>
Specifies the date on which to assign addresses in this range.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AssignmentType<AddressAssignment>
Specifies the address assignment type from this range. 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 |
-ConnectionSpecificDnsSuffix<String>
Specifies the connection-specific DNS suffix to associate with this range.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies a description for the range to modify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DnsSuffix<String[]>
Specifies an array of suffixes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EndIPAddress<IPAddress[]>
Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the range to modify.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
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 |
-ManagedByService<String[]>
Specifies an array of services that manage the range to modify.
Aliases |
MB |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NetworkType<VirtualizationType[]>
Specifies an array of network types for the addresses to modify. The acceptable values for this parameter are:
-- 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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewManagedByService<String>
Specifies the name of a new value of the ManagedByService property.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Owner<String>
Specifies the name of an owner for an address range.
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 list of custom metadata fields to remove from the range object. The list is a string of name-value pairs, separated by semicolons (;).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceInstance<String[]>
Specifies an array of service instances that manage the address ranges to modify.
Aliases |
SI |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-StartIPAddress<IPAddress[]>
Specifies an array of IP addresses. For this parameter, the addresses represent the low end of the range to modify.
Aliases |
none |
Required? |
true |
Position? |
2 |
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 |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range
Modified IP address range object.
Examples
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