Set-SCCustomProperty
Modifies the properties of a custom property.
Syntax
__AllParameterSets (Default)
Set-SCCustomProperty
-CustomProperty <CustomProperty>
[-VMMServer <ServerConnection>]
[-Name <String>]
[-Description <String>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
AddMembers
Set-SCCustomProperty
-CustomProperty <CustomProperty>
-AddMember <CustomPropertyObjectType[]>
[-VMMServer <ServerConnection>]
[-Name <String>]
[-Description <String>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
RemoveMembers
Set-SCCustomProperty
-CustomProperty <CustomProperty>
-RemoveMember <CustomPropertyObjectType[]>
[-VMMServer <ServerConnection>]
[-Name <String>]
[-Description <String>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
Description
The Set-SCCustomProperty cmdlet modifies the properties of a custom property. Properties that can be modified include the following:
- Description of the custom property
- Name of the custom property
- Add a member to the custom property
- Remove a member from the custom property
For information about creating a custom property, type Get-Help New-SCCustomProperty -Detailed.
Examples
Example 1: Add a member to a custom property
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Set-SCCustomProperty -CustomProperty $CustomProp -AddMember "VMHost"
The first command gets the custom property object named Cost Center and stores the object in the $CustomProp variable.
The second command adds the VMHost member to the custom property stored in $CustomProp.
Example 2: Remove a member from a custom property
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Set-SCCustomProperty -CustomProperty $CustomProp -RemoveMember "VM"
The first command gets the custom property object named Cost Center and stores the object in the $CustomProp variable.
The second command removes the VM member from the custom property object stored in $CustomProp.
Parameters
-AddMember
Specifies an array of members that this cmdlet adds to an object that has the concept of members, such as a group. For example, this cmdlet can add one or more Active Directory® Domain Services domain users or groups to a user role. Specify members in the following formats:
- Domain\User
- User
- User@Domain
- Domain\LabGroupAlias
- LabGroupAlias
The lab group alias is an Active Directory Domain Services security group, not an email alias.
Parameter properties
| Type: | CustomPropertyObjectType[] |
| Default value: | None |
| Accepted values: | VM, Template, VMHost, HostCluster, VMHostGroup, ServiceTemplate, ServiceInstance, ComputerTier, Cloud, ProtectionUnit |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AddMembers
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomProperty
Specifies a custom property object.
Parameter properties
| Type: | CustomProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
Specifies a description for the specified object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a VMM object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RemoveMember
Specifies an array of members that this cmdlet removes from a VMM object that has the concept of membership, such as a group. For example, this cmdlet can removes one or more Active Directory Domain Services domain users or groups from a user role. Specify members in the following formats:
- Domain\User
- User
- User@Domain
- Domain\LabGroupAlias
- LabGroupAlias
The lab group alias is an Active Directory Domain Services security group, not an email alias.
Parameter properties
| Type: | CustomPropertyObjectType[] |
| Default value: | None |
| Accepted values: | VM, Template, VMHost, HostCluster, VMHostGroup, ServiceTemplate, ServiceInstance, ComputerTier, Cloud, ProtectionUnit |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RemoveMembers
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies a VMM server object.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.