Set-ASProperty

AdminStudio 2021 R2 SP1 | 22.01 | AdminStudio PowerShell Cmdlets

Edition:Powershell cmdlets are enabled with AdminStudio Enterprise Edition and with Workflow Manager.

You can use the Set-ASProperty cmdlet to set the application model properties of a package. You can use new -SystemConnectionName switch to set the property value of the distribution system for a package. The property name is obtained from the Property_PluginId table for the corresponding distribution system. The property value should be the display text that is displayed in the AdminStudio user interface.

• Example
• Parameters
• Available Application Properties
• Available Deployment Type Properties

Note:Starting in AdminStudio 2021 R2, Set-ASDistributionProperty is obsolete and Set-ASProperty should used instead.

Example

To set application model properties using the Set-ASProperty cmdlet, use the following syntax:

Set-ASProperty -PackageID n -SystemConnectionName "Connection Name" -PropertyName "Name"-PropertyValue "Value"

where:

• Name—Name of application model property.
• Value—Value of application model property.
• n—Package ID number.
• Connection Name—Name of the Distribution Connection.

For example, you would use the following code to set the PrestagedDPSetting property to ManualCopy:

Set-ASDistributionProperty -PackageId 10 -SystemConnectionName 'Altiris' -PropertyName 'PackageName' -PropertyValue 'PackageABC' 

Set-ASProperty -PropertyName "PrestagedDPSetting" -PropertyValue "ManualCopy" -PackageID 1

To set multiple properties simultaneously, you should create a PowerShell script file containing multiple Set-ASProperty cmdlets, such as:

Set-ASProperty -PropertyName "PrestagedDPSetting" -PropertyValue "ManualCopy" -PackageID 1

Set-ASProperty -PropertyName "AutoInstall"        -PropertyValue "True"       -PackageID 1

Set-ASProperty -PropertyName "RunAs32"            -PropertyValue "False"      -PackageID 1

Parameters

The Set-ASProperty cmdlet includes the following parameters:

Set-ASProperty Parameters

Parameter

Description

PropertyName

Use to specify the name of the application model property that you want to set.

Note:The name of the property is fetched from the Property_PluginId table for the corresponding distribution system to set properties related to other Distribution System except ConfigMgr.

PropertyValue

Use to specify the value of the application model property that you want to set.

SystemConnectionName

Use to specify a named connection to a deployment system. For more information, see Creating Multiple Named Connections to Distribution Systems.

Available Application Properties

The following application properties that appear on the Application View can also be set using the Set‑ASProperty cmdlet:

• General Information Tab
• App Portal Information Tab

General Information Tab

The following application properties can be set using the Set-ASProperty cmdlet. These properties are also displayed on the General Information tab of the Application Catalog Application View.

Application View / General Information Tab Properties

Name Displayed in Application Catalog

Property Name

Possible Values

Administrator comments

Description

Any string value

Manufacturer

Publisher

Any string value

Install from Install Application task sequence

AutoInstall

True

False

Distribution priority

DistributionPriority

High

Medium

Low

Distribute to preferred DP

PreferredDistribute

True

False

Prestaged DP settings

PrestagedDPSetting

Auto

OnlyContentChange

ManualCopy

Display supersedes information to user

DisplaySupersedes

True

False

Distribution point groups

DistributionPointGroups

Any string value

Localized description

LocalizedDescription

Any string value

User documentation

UserDocumentation

Any string value

Icon file

Icon

Name of .ico file

Classification

Classification

Unknown

Desktop

Server

Flexera Identifier

FID

Flexera ID not found

Not connected to Flexera Service Gateway

Multiple applications detected

Error while fetching Flexera ID

Not synchronized with FlexNet Manager Platform

App Portal Information Tab

The following application properties can be set using the Set-ASProperty cmdlet. These properties are also displayed on the App Portal Information tab of the Application Catalog Application View.

Application View / General Information Tab Properties

Name Displayed in Application Catalog

Property Name

Possible Values

Categories

Categories

String value of path to existing category. For example:

Set-ASProperty -PackageID 1 ‑PropertyName "Categories" ‑PropertyValue "HR/Office/Excel 2007"

Set-ASProperty -PackageID 1 ‑PropertyName "Categories" ‑PropertyValue "HR/Office/Excel 2007,IT/Software/Excel"

Multiple categories can be set by separating them by a comma.

Important:Categories must already exist in App Portal. If you attempt to use Set-ASProperty to assign an application to a non-existent category, the cmdlet will fail.

Keywords

Keywords

Single or comma-delimited list of keywords. For example:

Set-ASProperty -PackageID 1 ‑PropertyName "Keywords" ‑PropertyValue "Admin"

Set-ASProperty -PackageID 1 ‑PropertyName "Keywords" ‑PropertyValue "Admin,IT,HR"

Note:When using the Set-ASProperty cmdlet to assign keywords to an application, follow these rules:

• Until you create a keyword using either the Add-ASKeywords cmdlet or the Edit Keywords dialog box, you cannot use the Set-ASProperty cmdlet to assign it to an application. If you attempt to do so, an error will be returned.
• If you attempt to assign multiple keywords (in a comma-delimited list) to an application, if one of them has not yet been created, the cmdlet will fail and no keywords will be assigned.
• If you attempt to assign a duplicate keyword to an application using the Set-ASProperty cmdlet, the cmdlet will fail.
• Do not use the single-quote character ( ' ) in a keyword.

Available Deployment Type Properties

The following deployment type properties that appear on the Home Deployment Type View can also be set using the Set-ASProperty cmdlet.

• Package Information Tab
• Deployment Data Tab

Package Information Tab

The following deployment type properties can be set using the Set-ASProperty cmdlet. These properties are also displayed on the Package Information tab of the Application Catalog Home Deployment Type View.

Home Deployment Type View / Package Information Tab Properties

Name Displayed in Application Catalog

Property Name

Possible Values

Manufacturer

Manufacturer

Any string value

Administrator Comments

AdministratorComments

Any string value

Original File

OriginalMsiFileName

Any string value

Original name of package

SoftwareProductName

Any string value

If package name was modified, the modified name is stored in this property

DisplayedProductName

Any string value

Deployment Data Tab

In Application Catalog, deployment type properties are displayed on the Deployment Data tab of the Application Catalog Home Deployment Type View on the following subtabs:

• Content Subtab
• Programs Subtab
• User Experience Subtab

Content Subtab

The following properties, which are displayed on the Content subtab of the Deployment Type tab, can be set using the Set-ASProperty cmdlet of the AdminStudio PowerShell Cmdlets.

Note:Class can be of ASCMMSIContent, ASCMScriptContent, or ASCMAppvContent.

Home Deployment Type View / Content Subtab

Name Displayed in Application Catalog

Property Name

Possible Values

Use fallback source location for content

FallbackToUnprotectedDP

True

False

Content location

Location

Any string value

Deployment option when client is on fast (LAN) network

Note:App-V packages only.

OnFastNetwork

Download

DownloadContentForStreaming

Deployment option when client is on slow network

OnSlowNetwork

DoNothing

Download

DownloadContentForStreaming

Note:The DownloadContentForStreaming option only applies to App-V packages.

Enable peer-to-peer content distribution

Note:App-V packages only.

PeerCache

True

False

Allow client to share content on same subnet

Note:MSI and EXE packages only.

PeerCache

True

False

Persist content in the client cache

PinOnClient

True

False

Load content to App-V cache

Note:App-V packages only.

RequireLoad

True

False

Uninstall content settings

UnInstallContentSettings

SameAsInstall

NoneRequired

Different

Uninstall content location

UnInstallContentLocation

Any String Value (based on Uninstall Content settings)

Programs Subtab

The following properties, which are displayed on the Programs subtab of the Deployment Type tab, can be set using the Set-ASProperty cmdlet of the AdminStudio PowerShell Cmdlets.

Note:Class can be of ASCMMsiInstaller or ASCMScriptInstaller.

Note:This subtab is only visible for MSI and EXE (script installer only) packages.

Home Deployment Type View / Programs Subtab

Name Displayed in Application Catalog

Property Name

Possible Values

Install command line

InstallCommandLine

Any string value

Install folder

InstallFolder

Any string value

Uninstall command line

UninstallCommandLine

Any string value

Uninstall folder

UninstallFolder

Any string value

Run installation as 32-bit process on 64-bit client

RunAs32

True

False

Installation source management product code

SourceUpdateProductCode

Any valid GUID

Repair command line

RepairCommandLine

Any String Value

Repair folder

RepairFolder

Any String Value

User Experience Subtab

The following properties, which are displayed on the User Experience subtab of the Deployment Type tab, can be set using the Set-ASProperty cmdlet of the AdminStudio PowerShell Cmdlets.

Note:Class can be of ASCMMsiUserExperience or ASCMScriptUserExperience.

Note:This subtab is only visible for MSI and EXE (script installer only) packages.

Home Deployment Type View / User Experience Subtab

Name Displayed in Application Catalog

Property Name

Possible Values

Installation behavior

InstallBehaviour

User

System

Any

Logon requirement

LogonRequirement

True

Null

False

Installation program visibility

ProgramVisibility

Maximized

Normal

Minimized

Hidden

Enforce specific behavior

EnforceBehaviour

BasedOnExitCode

NoAction

ProgramReboot

ForceReboot

Maximum allowed run time (min)

MaxExecuteTime

Any integer value

Estimated installation time (min)

ExecuteTime

Any integer value

Provision this application for all users on the device

ProvisionForAllUsers

True

False

Return Values

One of the following values is returned:

• True—Property value was successfully set.
• False—Property value was not set.

See Also

Get-ASProperty

Set-ASDistributionProperty

Get-ASDistributionProperty