Export (0) Print
Expand All
Expand Minimize

Get-IpamCustomFieldAssociation

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-IpamCustomFieldAssociation

Gets associations between two custom fields defined in IPAM.

Syntax

Parameter Set: ByName
Get-IpamCustomFieldAssociation [[-CustomFieldOne] <String> ] [[-CustomFieldTwo] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed 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 Set-IpamCustomFieldAssociation cmdlet to modify associations. Use the Remove-IpamCustomFieldAssociation cmdlet to remove associations.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CustomFieldTwo<String>

Specifies a custom field.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Get all custom field associations in IPAM

This command gets all the associations of custom fields specified 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}

Example 2: Get associations for two custom fields

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


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

CustomFieldTwo : ServiceInstance

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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft