Remove-IpamCustomFieldAssociation
Removes an association between two custom fields that are defined in IPAM.
Syntax
Default (Default)
Remove-IpamCustomFieldAssociation
[-CustomFieldOne] <String>
[-CustomFieldTwo] <String>
[-Force]
[-PassThru]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-IpamCustomFieldAssociation cmdlet removes an association between two custom fields that are defined in IP Address Management (IPAM). Specify the custom fields by using the CustomFieldOne and CustomFieldTwo parameters. The cmdlet does not find an association that contains both specified fields, it informs you of the error. The cmdlet does not delete the custom fields themselves.
Use the Get-IpamCustomFieldAssociation cmdlet to see existing associations. Use the Add-IpamCustomFieldAssociation cmdlet to create associations. Use the Set-IpamCustomFieldAssociation cmdlet to modify associations.
Examples
Example 1: Remove association between fields
The first command removes the association between the two custom fields, VmmLogicalNetwork and NetworkSite. The cmdlet prompts you before it removes associations.
PS C:\> Remove-IpamCustomFieldAssociation -CustomFieldOne "VmmLogicalNetwork" -CustomFieldTwo "NetworkSite"
Confirm
This will permanently delete the Custom Field Association between Custom Field VmmLogicalNetwork and
NetworkSite.Do you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
The second command uses the Get-IpamCustomFieldAssociation to get all associations. The associations that the first command removed do not appear.
PS C:\> Get-IpamCustomFieldAssociation
CustomFieldOne : Region
CustomFieldTwo : Site
AssociationValue : {Region01:Site09, Region01:Site10, Region01:Site11}
CustomFieldOne : ManagedByService
CustomFieldTwo : ServiceInstance
AssociationValue : {IPAM:Localhost, MS DHCP:dhcp1.contoso.com}
This example removes an association between fields, and then verifies the removal.
Example 2: Remove all associations for a field
The first command uses the **Get-IpamCustomFieldAssociation** cmdlet to get all the associations specified by the ManagedByService custom field, and then passes them to the current cmdlet by using the pipeline operator. The cmdlet prompts you for confirmation, and then removes all the associations.
PS C:\> Get-IpamCustomFieldAssociation -CustomFieldOne "ManagedByService" | Remove-IpamCustomFieldAssociation
Confirm
This will permanently delete the Custom Field Association between Custom Field ManagedByService and
ServiceInstance.Do you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
The second command uses the Get-IpamCustomFieldAssociation to get all associations. The associations that the first command removed do not appear.
PS C:\> Get-IpamCustomFieldAssociation
CustomFieldOne : Region
CustomFieldTwo : Site
AssociationValue : {Region01:Site09, Region01:Site10, Region01:Site11}
This example removes all associations for a specified field, and then verifies the removal.
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomFieldOne
Specifies a custom field. The cmdlet removes an association between this field and the field specified by the CustomFieldTwo parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-CustomFieldTwo
Specifies a custom field. The cmdlet removes an association between this field and the field specified by the CustomFieldOne parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.