Get-SCCustomProperty
Gets a custom property definition from the VMM database.
Syntax
Get-SCCustomProperty
[-VMMServer <ServerConnection>]
[-ID <Guid>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCCustomProperty
[-VMMServer <ServerConnection>]
-Name <String>
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCCustomProperty
[-VMMServer <ServerConnection>]
-Member <CustomPropertyObjectType>
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Description
The Get-SCCustomProperty cmdlet gets a custom property definition from the Virtual Machine Manager (VMM) database.
Examples
Example 1: Get a custom property by its name
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> $CustomPropThe 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.
Example 2: Get all custom properties for a specific member type
PS C:\> Get-SCCustomProperty -Member "VM"This command returns all custom properties that contain VM as a member.
Parameters
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Member
Specifies an object that is part of a group. The acceptable values for this parameter are:
- VM
- Template
- VMHost
- HostCluster
- VMHostGroup
- ServiceTemplate
- ServiceInstance
- ComputerTier
- Cloud
- ProtectionUnit
| Type: | CustomPropertyObjectType |
| Accepted values: | VM, Template, VMHost, HostCluster, VMHostGroup, ServiceTemplate, ServiceInstance, ComputerTier, Cloud, ProtectionUnit |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of a VMM object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
| Type: | UserRole |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |