Get-​Ipam​Custom​Field​Association

Gets associations between two custom fields defined in IPAM.

Syntax

Get-IpamCustomFieldAssociation
   [[-CustomFieldOne] <String>]
   [[-CustomFieldTwo] <String>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

Description

The Get-IpamCustomFieldAssociation cmdlet gets associations between two custom fields defined in IP Address Management (IPAM). You can specify the custom fields by using the CustomFieldOne and CustomFieldTwo parameters. If you specify only one of these parameters, the cmdlet gets all associations that include the field that you specify. Associations are not directional, so you can use either parameter for either field. If you do not specify either parameter, the cmdlet gets all the associations.

Use the Add-IpamCustomFieldAssociation cmdlet to create associations. Use the Remove-IpamCustomFieldAssociation cmdlet to remove associations. Use the Set-IpamCustomFieldAssociation cmdlet to modify associations.

Examples

Example 1: Get all custom field associations in IPAM

PS C:\> Get-IpamCustomFieldAssociation
CustomFieldOne   : Region

CustomFieldTwo   : Site

AssociationValue : {Region03,Site09, Region03,Site10, Region03,Site11, Region03,Site12}

CustomFieldOne   : ManagedByService

CustomFieldTwo   : ServiceInstance

AssociationValue : {IPAM,Localhost, MS DHCP,dhcp1.contoso.com}
CustomFieldOne   : VmmLogicalNetwork

CustomFieldTwo   : NetworkSite

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

This command gets all the associations of custom fields specified in IPAM.

Example 2: Get associations for two custom fields

PS C:\> Get-IpamCustomFieldAssociation -CustomFieldOne "ManagedByService" -CustomFieldTwo "ServiceInstance"
CustomFieldOne   : ManagedByService

CustomFieldTwo   : ServiceInstance

AssociationValue : {IPAM:Localhost, MS DHCP:dhcp1.contoso.com}

This command gets the associations between two custom fields, ManagedByService and ServiceInstance.

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

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-CustomFieldOne

Specifies a custom field.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-CustomFieldTwo

Specifies a custom field.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False