Set-SCApplicationPackage

Modifies the properties of an application package.

Description

The Set-SCApplicationPackage modifies the properties of an application package stored in the VMM library.

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

Parameters

ApplicationPackage

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies an application package 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.

EncryptionKey

Required? false
Accept Pipeline Input? false
Position? named
Specifies credentials to be used as an encryption key when you add a Hyper-V host located in a perimeter network to VMM. 

Example format: -SecurityFile "C:\SecurityFile.txt" -EncryptionKey $Key

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.

ApplicationPackages

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies an array of application package 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: Update the description for an application package.
PS C:\> $AppPackage = Get-SCApplicationPackage -Name "WebApp01.zip"
PS C:\> Set-SCApplicationPackage -ApplicationPackage $AppPackage -Description "Web application to install on a service."
The first command gets the application package object named WebApp01.zip and stores the object in the $AppPackage variable.

The second command updates the description for WebApp01.zip.

See Also