Share via

New-SCCustomProperty

  • Reference
Module:
VirtualMachineManager

Creates a custom property definition in the VMM database.

Syntax

New-SCCustomProperty
   [-Name] <String>
   [-Description <String>]
   -AddMember <CustomPropertyObjectType[]>
   [-VMMServer <ServerConnection>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The New-SCCustomProperty cmdlet creates a custom property definition in the Virtual Machine Manager (VMM) database.

You can create a custom property for the following object types:

  • VM
  • Template
  • VMHost
  • HostCluster
  • VMHostGroup
  • ServiceTemplate
  • ServiceInstance
  • ComputerTier
  • Cloud

Examples

Example 1: Create a custom property

PS C:\> $CustomProp = New-SCCustomProperty -Name "Cost Center" -AddMember "VM"
PS C:\> $CustomProp

The first command creates a custom property object named Cost Center with VM as a member 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.

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.

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

-Description

Specifies a description for the custom property definition.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of a VMM object.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

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

Type:SwitchParameter
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