Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-IpamCustomFieldAssociation

Add-IpamCustomFieldAssociation

ipamcustomfieldassociation.cdxml

Synopsis

Adds an association between values for custom fields that are defined in IPAM.

Syntax

Add-IpamCustomFieldAssociation [-CustomFieldOne] [-CustomFieldTwo] [-AssociationValue] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-IpamCustomFieldAssociation cmdlet adds an association between values for two custom fields that are defined in IP Address Management (IPAM). Specify the custom fields by using the CustomFieldOne and CustomFieldTwo parameters. Specify the associations as an array of pairs of values in the format CustomFieldValue01:CustomFieldValue02.

Use the Get-IpamCustomFieldAssociation cmdlet to see existing associations. Use the Set-IpamCustomFieldAssociation cmdlet to modify associations. Use the Remove-IpamCustomFieldAssociation cmdlet to remove associations.

Parameters

-AsJob <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AssociationValue <String[]>

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.

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CustomFieldOne <String>

Specifies a custom field. This field corresponds to the first value in a pair that is specified through the AssociationValue parameter.

Aliases

CustomField1

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-CustomFieldTwo <String>

Specifies a custom field. This field corresponds to the second value in a pair that is specified through the AssociationValue parameter.

Aliases

CustomField2

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

IpamCustomFieldAssociation

Notes

None

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.

PS C:\> Add-IpamCustomFieldAssociation  -CustomFieldOne "VmmLogicalNetwork" -CustomFieldTwo "NetworkSite" -AssociationValue "Storage:Site01","Storage:Site02","Public:Site03" -PassThru
CustomFieldOne   : VmmLogicalNetwork

CustomFieldTwo   : NetworkSite

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

Online Version
Get-IpamCustomFieldAssociation
Set-IpamCustomFieldAssociation
Remove-IpamCustomFieldAssociation