Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft IpamServer reference: Modifies address spaces in IPAM. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-IpamAddressSpace. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / IpamServer · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AddCustomConfiguration
Specifies semi-colon separated name/value pairs. This parameter specifies custom metadata that are associated with the address space.
-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.
-AssociatedProviderAddressSpace
Specifies the provider address space that is associated with the customer address space. Customer address spaces in IPAM belong to a single provider address space.
-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.
-Confirm
Prompts you for confirmation before running the cmdlet.
-Description
Specifies a description of the address space.
-InputObject (required)
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
-IsolationMethod
Specifies the network virtualization mechanism for the address space. The acceptable values for this parameter are: - NVGRE - IPRewrite
-Name (required)
Specifies an array of names of the address spaces. The cmdlet modifies the address spaces.
-NewName
Specifies a new name for the address space.
-Owner
Specifies the owner of the address space.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-RemoveCustomConfiguration
Specifies a semi-colon separated string of custom field names. The cmdlet removes the custom field names from the address spaces.
-Tenant
Specifies the tenant ID, as a string, that is associated with the customer address space. You must specify a tenant ID that is associated with the virtual machine network that you specify for the *VmNetwork* parameter.
-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.
-VmNetwork
Specifies the name of the virtual machine network for the customer address space. You must specify a virtual network that is associated with the tenant that you specify for the *Tenant* parameter.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the IpamServer module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
This command renames the address space named OneDataCenter to MainDataCenter. The command includes the *PassThru* parameter, so it displays results to the console. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.