Modifies the properties of an infrastructure server in the IPAM server inventory.
Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft IpamServer reference: Modifies the properties of an infrastructure server in the IPAM server inventory. 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-IpamServerInventory. 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 custom configuration to add to the server inventory.
-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.
-Description
Specifies a description for the server.
-Force
Forces the command to run without asking for user confirmation.
-ManageabilityStatus
Specifies the manageability status of a server. The acceptable values for this parameter are: - Unspecified - Managed - Unmanaged If you specify a value of Managed for this parameter, IPAM gathers data from the server.
-Name (required)
Specifies the FQDN of the infrastructure server to modify.
-NewName
Specifies the new name or FQDN of an infrastructure server. IPAM tries to resolve the name to an IP address and reports an error if it cannot resolve the name.
-Owner
Specifies the owner of the Dynamic Host Configuration Protocol (DHCP) server.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-RemoveCustomConfiguration
Specifies the metadata fields to modify. List the metadata as a series of custom field names, separated by semicolons (;).
-ServerType
Specifies an array of server roles that are present on the server. The acceptable values for this parameter are: - DHCP - DC - DNS - NPS
-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.
-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 modifies the properties of an infrastructure server named Dhcp01, and makes it manageable by IPAM. 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.