Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft IpamServer reference: Adds a subnet to 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 Add-IpamSubnet. 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
-AddressSpace
Specifies an address space to which this IP address subnet belongs. If you do not specify an address space, the cmdlet retrieves data for all address spaces configured in IPAM.
-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.
-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.
-CustomConfiguration
Specifies semicolon-separated (;) name/value pairs. This parameter specifies custom metadata that is associated with the address space.
-Description
Specifies a description of the subnet.
-Name (required)
Specifies a name for the subnet.
-NetworkId (required)
Specifies the network and the prefix for the given subnet. Specify the network ID in Classless Interdomain Routing (CIDR) notation in the format Network/Prefix.
-NetworkSite
Specifies a network site that is associated with a logical network and forms an abstraction of the physical network. A logical network can contain many network sites. This property is inherited by all ranges and addresses associated with the given subnet.
-NetworkType
Specifies an array of network types for the addresses to add. The acceptable values for this parameter are: - Provider - Customer - NonVirtualized If the value of the *AddressSpace* parameter is Default, then this parameter can take the value Provider or NonVirtualized. If the value of the *AddressSpace* parameter is Provider, then the value of this parameter, if specified, must be Provider. Specifying any other value for this parameter will result in an error. Similarly, if the value of the *AddressSpace* parameter is Customer, then the value of this parameter, if specified, must be Customer. Specifying any other value for this parameter will result in an error. If you do not specify this parameter, the network type defaults to NonVirtualized.
-Owner
Specifies the name of an owner for the subnet.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-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.
-VirtualSubnetId
Specifies a virtual subnet ID. When you use network virtualization, this property, along with Customer address and Provider address is used to route packets to a particular customer virtual machine.
-VlanId
Specifies an array of unique identifiers for virtual local area networks (VLAN).
-VmmLogicalNetwork
Specifies the abstraction of a physical network that describes a particular function in your environment such as backend or frontend.
-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 adds an IPv4 subnet named Contoso_2 to the network ID 10.12.0.0/16 and associates it with VLAN 13,10. 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.