Set-IpamCustomFieldAssociation

  • Reference
Module:
IpamServer

Modifies associations of values for custom fields defined in IPAM.

Syntax

Set-IpamCustomFieldAssociation
   [-CustomFieldOne] <String>
   [-CustomFieldTwo] <String>
   [-AddAssociationValue <String[]>]
   [-RemoveAssociationValue <String[]>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-IpamCustomFieldAssociation cmdlet modifies association of values for between two custom fields defined in IP Address Management (IPAM). Specify the custom fields by using the CustomFieldOne and CustomFieldTwo parameters. Specify the values to add or remove as an array of pairs of values in the format CustomFieldValue01,CustomFieldValue02.

The cmdlet removes values specified by the RemoveAssociationValue parameter, and then adds values specified by the AddAssociationValue parameter. If you attempt to remove values that do not exist, the cmdlet returns an error, and does not make any changes.

Use the Get-IpamCustomFieldAssociation cmdlet to see existing associations. Use the Add-IpamCustomFieldAssociation cmdlet to create associations. Use the Remove-IpamCustomFieldAssociation cmdlet to remove associations.

Examples

Example 1: Modify an association

PS C:\> Set-IpamCustomFieldAssociation -CustomFieldOne "VmmLogicalNetwork" -CustomFieldTwo "NetworkSite" -AddAssociateValue "Storage:Site03" -RemoveAssociationValue "Public:Site03" -PassThru
CustomFieldOne   : VmmLogicalNetwork

CustomFieldTwo   : NetworkSite

AssociationValue : {Storage:Site01, Storage:Site03, Storage:Site02}

This command modifies an existing association between two custom fields, VmmLogicalNetwork and NetworkSite. The command specifies values to add and remove. The command includes the PassThru parameter, so it displays results to the console.

Parameters

-AddAssociationValue

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.

The cmdlet adds the specified pairs.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CustomFieldOne

Specifies a custom field. This field corresponds to the first value in a pair specified by using the AddAssociationValue or RemoveAssociationValue parameter.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-CustomFieldTwo

Specifies a custom field. This field corresponds to the second value in a pair specified by using the AddAssociationValue or RemoveAssociationValue parameter.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveAssociationValue

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.

The cmdlet removes the specified pairs. If you specify a pair that does not exist, the cmdlet returns an error.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IpamCustomFieldAssociation

An object that represents an association between values of one custom field and values of another custom field.