Set-Ipam Range

Syntax

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

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

Description

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

Examples

Example 1: Modify an existing IP address range

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

Overlapping      : False

NetworkID        : 10.12.0.0/16

StartAddress     : 10.12.1.1

EndAddress       : 10.12.1.254

ManagedByService : VMM

ServiceInstance  : vmm1.contoso.com

NetworkType      : NonVirtualized

Owner            :

This command modifies an existing IP address range that is currently managed by IPAM, to be managed by Virtual Machine Manager (VMM).

The command includes the PassThru parameter, so it displays results to the console.

Example 2: Add custom metadata to an IP address range

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

Overlapping         : False

StartAddress        : 10.12.1.1

EndAddress          : 10.12.1.254

ManagedByService    : VMM

ServiceInstance     : vmm1.contoso.com

CustomConfiguration : ADSite= ContosoCorporate;

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

The command includes the PassThru parameter, so it displays results to the console.

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

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

Overlapping      : False

NetworkID        : 10.12.0.0/16

StartAddress     : 10.12.3.1

EndAddress       : 10.12.3.254

ManagedByService : IPAM

ServiceInstance  : Localhost

NetworkType      : Provider

Owner            :

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

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

Overlapping      : False

NetworkID        : 10.12.0.0/16

StartAddress     : 10.12.3.1

EndAddress       : 10.12.3.254

ManagedByService : IPAM

ServiceInstance  : Localhost

NetworkType      : NonVirtualized

Owner            :

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

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
Overlapping       : False

NetworkID         : 10.12.0.0/16

StartAddress      : 10.12.3.1

EndAddress        : 10.12.3.254

ManagedByService  : IPAM

ServiceInstance   : Localhost

NetworkType       : Provider

ProviderAddressSpace : ContosoDataCenter

CustomerAddressSpace :

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.

Required Parameters

Optional Parameters

Outputs

CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range

This cmdlet returns an object that contains the modified IP address range.

Related Links

• Add-IpamRange
• Export-IpamRange
• Get-IpamRange
• Import-IpamRange
• Remove-IpamRange