Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Set-SCCustomPropertyValue

Updated: September 27, 2012

Applies To: System Center 2012 - Virtual Machine Manager

Set-SCCustomPropertyValue

Updates the value of a custom property.

Syntax

Parameter Set: InputObject
Set-SCCustomPropertyValue -CustomProperty <CustomProperty> -InputObject <ClientObject> -Value <String> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]

Parameter Set: JobGroup
Set-SCCustomPropertyValue -CustomProperty <CustomProperty> -JobGroup <Guid> -Value <String> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]




Detailed 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<CustomProperty>

Specifies a custom property object.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-InputObject<ClientObject>

Specifies the object that is assigned the property whose value you want to retrieve or change.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-JobGroup<Guid>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Value<String>

Specifies a string used to attribute an object or property.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

  • 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.

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.


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"

Related topics

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.