Share via

Remove-SCCustomProperty

  • Reference
Module:
VirtualMachineManager

Removes a custom property definition from the VMM database.

Syntax

Remove-SCCustomProperty
      -CustomProperty <CustomProperty>
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCCustomProperty cmdlet removes a custom property definition from the Virtual Machine Manager (VMM) database.

Examples

Example 1: Remove a custom property definition

PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Remove-SCCustomProperty -CustomProperty $CustomProp

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

The second command removes the custom property object stored in $CustomProp.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-CustomProperty

Specifies a custom property object.

Type:CustomProperty
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This lets you audit of PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

Notes

  • Requires a VMM custom property object, which can be retrieved by using the Get-SCCustomProperty cmdlet.