Remove-SCCustomPropertyValue

Removes the value from a custom property.

Description

The Remove-SCCustomPropertyValue cmdlet removes the value from a custom property.

For more information about Remove-SCCustomPropertyValue, type: "Get-Help Get-SCCustomPropertyValue -online".

Parameters

CustomPropertyValue

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a custom property value object.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

JobGroup

Required? true
Accept Pipeline Input? false
Position? named 
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

CustomProperty

Required? false
Accept Pipeline Input? true (ByValue,ByPropertyName)
Position? named 
Specifies a custom property object.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Examples

1: Remove a custom property value from a virtual machine. 
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> $CustomPropValue = Get-SCCustomPropertyValue -InputObject $VM -CustomProperty $CustomProp
PS C:\> Remove-SCCustomPropertyValue -CustomPropertyValue $CustomPropValue

The first command gets the virtual machine object named VM01 and stores the object in the $VM variable.

The second command gets the custom property object named Cost Center and stores the object in the $CustomProp variable.

The third command retrieves the value for the custom property stored in $CustomProp (Cost Center) for the virtual machine stored in $VM (VM01) and stores the value in the $CustomPropValue variable.

The last command removes the custom property value stored in $CustomPropValue.

See Also