Set-SCCustomResource

Sets the properties of a custom resource.

Description

The Set-SCCustomResource cmdlet sets the properties of a custom resource. A custom resource is a folder-based library object in System Center Virtual Machine Manager (VMM). The resource is declared at the folder level, and the contents of the folder is unknown to VMM. 

To add a custom resource to the library, create a folder with a .CR extension, place content in the folder, and then use the VMM console to drag the folder to a VMM library share. VMM discovers and imports the folder into the library as a custom resource.

For more information about Set-SCCustomResource, type: "Get-Help Set-SCCustomResource -online".

Parameters

CustomResource

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies a custom resource object.

Description

Required? false
Accept Pipeline Input? false
Position? named
States a description for the specified object.

Enabled

Required? false
Accept Pipeline Input? false
Position? named
Enables an object when set to $True, or disables an object when set to $False. For example, if you want to upgrade software on a virtual machine template, you can disable the template object in the VMM library to temporarily prevent users from using that object.

FamilyName

Required? false
Accept Pipeline Input? false
Position? named
Specifies a family name for a physical resource in the VMM library. This value is used in conjunction with Release, Namespace, and Type to establish equivalency among library resources.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

Name

Required? false
Accept Pipeline Input? false
Position? named
Specifies the name of a VMM object.

Owner

Required? false
Accept Pipeline Input? false
Position? named
Specifies the owner of a VMM object in the form of a valid domain user account.

Example format: -Owner "Contoso\ReneeLo"
Example format: -Owner "ReneeLo@Contoso"

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Release

Required? false
Accept Pipeline Input? false
Position? named
Specifies a string that describes the release of a library resource. VMM automatically creates a release value for every resource imported into the library. After the resource has been imported, the string can be customized.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

SharePath

Required? false
Accept Pipeline Input? false
Position? named
Specifies a path to a valid library share on an existing library server that uses a Universal Naming Convention (UNC) path. 

Example format: –SharePath "\\LibServer01\LibShare"

UserRole

Required? false
Accept Pipeline Input? false
Position? named
Specifies a user role object.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named
Specifies a VMM server object.

CustomResources

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies an array of custom resource objects.

FamilyName

Required? false
Accept Pipeline Input? false
Position? named
Specifies a family name for a physical resource in the VMM library. This value is used in conjunction with Release, Namespace, and Type to establish equivalency among library resources.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Release

Required? false
Accept Pipeline Input? false
Position? named
Specifies a string that describes the release of a library resource. VMM automatically creates a release value for every resource imported into the library. After the resource has been imported, the string can be customized.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VMMServer

Required? false
Accept Pipeline Input? false
Position? named
Specifies a VMM server object.

Examples

1: Change the description and release of a custom resource.
PS C:\> $CR = Get-SCCustomResource -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq “Folder.CR” -and $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com” }
PS C:\> Set-SCCustomResource -CustomResource $CR -Release "v1.1" -Description “My LOB Application version 1.1 Install Package” 
The first command gets the custom resource object named Folder.CR on LibraryServer01 from the VMM library on VMMServer01 and then stores the object in the $CR variable.

The second command changes the values for the Release and Description properties of the custom resource object stored in $CR,.

See Also