Get-SCCustomPropertyValue
Get-SCCustomPropertyValue
Gets a custom property value object.
Syntax
Parameter Set: All
Get-SCCustomPropertyValue -All [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: Filter
Get-SCCustomPropertyValue -CustomProperty <CustomProperty> -InputObject <ClientObject> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCCustomPropertyValue cmdlet gets a custom property value object.
Parameters
-All
Retrieves a full list of all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CustomProperty<CustomProperty>
Specifies a custom property object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.
Examples
1: Get 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 retrieves the value for the custom property stored in $CustomProp (Cost Center) for the virtual machine stored in $VM (VM01).
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Get-SCCustomPropertyValue -InputObject $VM -CustomProperty $CustomProp