Remove-Ipam Custom Value

Module:
ipamserver
Removes a custom value from IPAM.

Syntax 

Remove-IpamCustomValue
      [-Name] <String>
      [-Value] <String>
      [-Force]
      [-PassThru]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-IpamCustomValue cmdlet removes a set of values from a multivalued custom field. Specify the Name parameter and the Value parameter. If you specify values that do not exist in the custom field, the cmdlet removes the values that do exist and returns an error that specifies the values that it did not remove because the values do not exist. You cannot remove custom values that are assigned to IPAM objects. You cannot remove built-in values for built-in custom fields.

Examples

Example 1: Remove a value from a custom field 

PS C:\> Remove-IpamCustomValue -Name "Building" -Value "Main01"
Confirm

This command will permanently delete Custom Value Main01 of Custom Field Building from IPAM. Do you want to

continue?

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y

This command removes the value named Main01 from the custom field named Building.

Required Parameters

-Name

Specifies the name of a custom field. The cmdlet removes the value that you specify for the Value parameter from the custom field.

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

Specifies a set of values to remove from the custom field.

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

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
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

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

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

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False