Set-SCCustomPropertyValue

Updates the value of a custom property.

Description

The Set-SCCustomPropertyValue cmdlet updates the value of a custom property.

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

Parameters

CustomProperty

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

InputObject

Required? true
Accept Pipeline Input? false
Position? named
Specifies the object that is assigned the property whose value you want to retrieve or change.

Value

Required? true
Accept Pipeline Input? false
Position? named
Specifies a string used to attribute an object or property.

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. 

CustomProperty

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

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. 

Value

Required? true
Accept Pipeline Input? false
Position? named
Specifies a string used to attribute an object or property.

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. 
Requires a VMM custom property object, which can be retrieved by usiong the Get-SCCustomProperty cmdlet.

Examples

1: Set the value for a custom property on a virtual machine.
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Set-SCCustomPropertyValue -InputObject $VM -CustomProperty $CustomProp -Value "123"
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 last command sets the value for the custom property stored in $CustomProp (Cost Center) for the virtual machine stored in $VM (VM01) to 123.

See Also