COMMAND EVERYTHING.

Rename-IpamCustomField

Renames a custom field in IPAM.

Networking / Security · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft IpamServer reference: Renames a custom field 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.

Rename-IpamCustomField [-Name] <String> [-newName] <String> [-PassThru] [-Force] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Rename-IpamCustomField. 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

-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.
-Force: Forces the command to run without asking for user confirmation.
-Name (required): Specifies the name of a custom field.
-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.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.
-newName (required): Specifies a new name for the custom field.

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.

Examples

Example 1: Rename a user defined custom field

Rename-IpamCustomField -Name "Building" -newName "Building_Main" -PassThru

This command renames the user-defined custom field named Building to Building_Main. 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.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/IpamServer/Rename-IpamCustomField.md

https://learn.microsoft.com/powershell/module/ipamserver/rename-ipamcustomfield?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC