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.
The command includes the PassThru parameter, so it displays results to the console.
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.
The command includes the PassThru parameter, so it displays results to the console.
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.
The command includes the PassThru parameter, so it displays results to the console.
Parameters
-AddCustomConfiguration
Specifies semi-colon (;) separated name/value pairs.
This parameter specifies custom metadata that are associated with the address space.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AddressSpace
Specifies an array of names of address spaces.
If you do not specify a value, the cmdlet modifies matching ranges from all address spaces.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Query (cdxml)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
You can continue to work in the session while the job completes.
To manage the job, use the *-Job cmdlets.
To get the job results, use the Receive-Job cmdlet.
For more information about Windows PowerShell background jobs, see about_Jobs.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AssignmentDate
Specifies the date on which to assign addresses in this range.
Parameter properties
Type:
DateTime
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AssignmentType
Specifies the address assignment type from this range.
The acceptable values for this parameter are:
Static
Dynamic
Auto
VIP
Reserved
Parameter properties
Type:
AddressAssignment
Default value:
None
Accepted values:
Static, Dynamic, Auto, VIP, Reserved
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-AssociatedReverseLookupZone
The Set-IpamRange cmdlet modifies an existing IP address range that an IP Address Management (IPAM) server manages.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-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.
Parameter properties
Type:
CimSession[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Session
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ConnectionSpecificDnsSuffix
Specifies the connection-specific DNS suffix to associate with this range.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Description
Specifies a description for the range to modify.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-DnsServer
Specifies an array of Domain Name System (DNS) servers to associate with this range.
Specify the names of the DNS servers in the order of preference, highest to lowest.
Parameter properties
Type:
IPAddress[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-DnsSuffix
Specifies an array of suffixes.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-EndIPAddress
Specifies an array of IP addresses.
For this parameter, the addresses represent the high end of the range to modify.
Parameter properties
Type:
IPAddress[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Query (cdxml)
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Gateway
Specifies an array of gateway servers, imported from a Dynamic Host Configuration Protocol (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.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-InputObject
Specifies the input to this cmdlet.
You can use this parameter, or you can pipe the input to this cmdlet.
Parameter properties
Type:
CimInstance[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
InputObject (cdxml)
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ManagedByService
Specifies an array of services that manage the range to modify.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
MB
Parameter sets
Query (cdxml)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NetworkType
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.
Parameter properties
Type:
VirtualizationType[]
Default value:
None
Accepted values:
NonVirtualized, Provider, Customer
Supports wildcards:
False
DontShow:
False
Parameter sets
Query (cdxml)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewAddressSpace
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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewEndIPAddress
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.
Parameter properties
Type:
IPAddress
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewManagedByService
Specifies the name of a new value of the ManagedByService property.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewNetworkId
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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewNetworkType
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.
Parameter properties
Type:
VirtualizationType
Default value:
None
Accepted values:
NonVirtualized, Provider
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewServiceInstance
Specifies the name of a new value of the service instance property.
Choose a new value compatible with the value of ManagedByService parameter.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NewStartIPAddress
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.
Parameter properties
Type:
IPAddress
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Owner
Specifies the name of an owner for an address range.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-PassThru
Returns an object representing the item with which you are working.
By default, this cmdlet does not generate any output.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RemoveCustomConfiguration
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 (;).
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ReservedAddress
Specifies an array of reserved addresses from the given range.
This list will overwrite the existing list of reserved addresses for the given range.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ServiceInstance
Specifies an array of service instances that manage the address ranges to modify.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
SI
Parameter sets
Query (cdxml)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-StartIPAddress
Specifies an array of IP addresses.
For this parameter, the addresses represent the low end of the range to modify.
Parameter properties
Type:
IPAddress[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Query (cdxml)
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ThrottleLimit
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.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-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.
Parameter properties
Type:
UtilizationCalculation
Default value:
None
Accepted values:
Auto, UserSpecified
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-UtilizedAddresses
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.
Parameter properties
Type:
Double
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-VIP
Specifies an array of virtual IP addresses, usually set aside for load balancers, from the range.
Specify the Virtual IPs (VIP) as a list, in descending order of precedence.
This list overwrites any existing VIPs specified for the given range.
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WinsServer
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.
Parameter properties
Type:
IPAddress[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
Outputs
CimInstance
This cmdlet returns an object that contains the modified IP address range.