Get-IpamCustomFieldAssociation
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
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
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"
Related topics
Add-IpamCustomFieldAssociation