Set-SCApplicationPackage

Set-SCApplicationPackage

Modifies the properties of an application package.

Syntax

Parameter Set: Default
Set-SCApplicationPackage [-ApplicationPackage] <ApplicationPackage[]> [-Description <String> ] [-Enabled <Boolean> ] [-EncryptionKey <PSCredential> ] [-FamilyName <String> ] [-JobVariable <String> ] [-Name <String> ] [-Owner <String> ] [-PROTipID <Guid> ] [-Release <String> ] [-RunAsynchronously] [-SharePath <String> ] [-UserRole <UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: EquivalencySet
Set-SCApplicationPackage [-ApplicationPackage] <ApplicationPackage[]> -FamilyName <String> -Release <String> -SetAsEquivalent [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

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

Parameters

-ApplicationPackage<ApplicationPackage[]>

Specifies an application package object.

-Description<String>

States a description for the specified object.

-Enabled<Boolean>

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<PSCredential>

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<String>

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<String>

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

-Name<String>

Specifies the name of a VMM object.

-Owner<String>

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<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-Release<String>

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

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

-SetAsEquivalent

-SharePath<String>

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<UserRole>

Specifies a user role object.

-VMMServer<ServerConnection>

Specifies a VMM server object.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• ApplicationPackage

Examples

1: Update the description for an application package.

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.

PS C:\> $AppPackage = Get-SCApplicationPackage -Name "WebApp01.zip"
PS C:\> Set-SCApplicationPackage -ApplicationPackage $AppPackage -Description "Web application to install on a service."

Related topics

Get-SCApplicationPackage

Remove-SCApplicationPackage