Get-SCCustomProperty
Get-SCCustomProperty
Gets a custom property definition from the VMM database.
Syntax
Parameter Set: ID
Get-SCCustomProperty [-ID <Guid> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: Member
Get-SCCustomProperty -Member <CustomPropertyObjectType> {VM | VMHost | Template | ServiceTemplate | ServiceInstance | Cloud | VMHostGroup | HostCluster | ComputerTier} [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: Name
Get-SCCustomProperty -Name <String> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCCustomProperty cmdlet gets a custom property definition from the Virtual Machine Manager (VMM) database.
Parameters
-ID<Guid>
Specifies the numerical identifier (as a globally unique identifier, or GUID) for a specific object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Member<CustomPropertyObjectType>
Specifies an object that is part of a group.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 a custom property by its name.
The first command gets the custom property object named Cost Center and stores the object in the $CustomProp variable.
The second command displays the properties of the custom property object stored in $CustomProp to the user.
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> $CustomProp
2: Get all custom properties for a specific member type.
This command returns all custom properties that contain VM as a member.
PS C:\> Get-SCCustomProperty -Member "VM"