Adds an association between values for custom fields that are defined in IPAM.
Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft IpamServer reference: Adds an association between values for custom fields that are defined 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 Add-IpamCustomFieldAssociation. 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.
-AssociationValue (required)
Specifies an array of value pairs. Each pair, a string, includes two values that are separated by a colon (:). The first value in a pair corresponds to the custom field that is specified by the *CustomFieldOne* parameter. The second value corresponds to the custom field that is specified by the *CustomFieldTwo* parameter.
-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.
-CustomFieldOne (required)
Specifies a custom field. This field corresponds to the first value in a pair that is specified through the *AssociationValue* parameter.
-CustomFieldTwo (required)
Specifies a custom field. This field corresponds to the second value in a pair that is specified through the *AssociationValue* parameter.
-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.
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: Create a custom association between two fields
This command adds an association between values of two custom fields, VmmLogicalNetwork and NetworkSite. The command specifies three pairs of values. 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.