Set-CMApplication

Set-CMApplication

Sets properties of an application in Configuration Manager.

Syntax

Parameter Set: SetById
Set-CMApplication -Id <String[]> [-AppCategories <String[]> ] [-AutoInstall <Boolean> ] [-Description <String> ] [-DistributionPointSetting <DistributionPointSettingType> {AutoDownload | DeltaCopy | NoDownload} ] [-DistributionPriority <DistributionPriorityType> {High | Low | Medium} ] [-IconLocationFile <String> ] [-IsFeatured <Boolean> ] [-Keyword <String> ] [-LinkText <String> ] [-LocalizedApplicationDescription <String> ] [-LocalizedApplicationName <String> ] [-NewName <String> ] [-OptionalReference <String> ] [-Owner <String> ] [-PrivacyUrl <String> ] [-Publisher <String> ] [-ReleaseDate <DateTime> ] [-SendToProtectedDistributionPoint <Boolean> ] [-SoftwareVersion <String> ] [-SupportContact <String> ] [-UserCategories <String[]> ] [-UserDocumentation <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByName
Set-CMApplication -Name <String[]> [-AppCategories <String[]> ] [-AutoInstall <Boolean> ] [-Description <String> ] [-DistributionPointSetting <DistributionPointSettingType> {AutoDownload | DeltaCopy | NoDownload} ] [-DistributionPriority <DistributionPriorityType> {High | Low | Medium} ] [-IconLocationFile <String> ] [-IsFeatured <Boolean> ] [-Keyword <String> ] [-LinkText <String> ] [-LocalizedApplicationDescription <String> ] [-LocalizedApplicationName <String> ] [-NewName <String> ] [-OptionalReference <String> ] [-Owner <String> ] [-PrivacyUrl <String> ] [-Publisher <String> ] [-ReleaseDate <DateTime> ] [-SendToProtectedDistributionPoint <Boolean> ] [-SoftwareVersion <String> ] [-SupportContact <String> ] [-UserCategories <String[]> ] [-UserDocumentation <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByValue
Set-CMApplication -InputObject <IResultObject> [-AppCategories <String[]> ] [-AutoInstall <Boolean> ] [-Description <String> ] [-DistributionPointSetting <DistributionPointSettingType> {AutoDownload | DeltaCopy | NoDownload} ] [-DistributionPriority <DistributionPriorityType> {High | Low | Medium} ] [-IconLocationFile <String> ] [-IsFeatured <Boolean> ] [-Keyword <String> ] [-LinkText <String> ] [-LocalizedApplicationDescription <String> ] [-LocalizedApplicationName <String> ] [-NewName <String> ] [-OptionalReference <String> ] [-Owner <String> ] [-PrivacyUrl <String> ] [-Publisher <String> ] [-ReleaseDate <DateTime> ] [-SendToProtectedDistributionPoint <Boolean> ] [-SoftwareVersion <String> ] [-SupportContact <String> ] [-UserCategories <String[]> ] [-UserDocumentation <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeById
Set-CMApplication -Id <String[]> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByName
Set-CMApplication -Name <String[]> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByValue
Set-CMApplication -InputObject <IResultObject> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CMApplication cmdlet sets properties of an application.

Parameters

-AppCategories<String[]>

Specifies, as a string array, categories that the application may belong to.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AutoInstall<Boolean>

Indicates whether the task sequence action can install the application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for the application.

Aliases

LocalizedDescription

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DistributionPointSetting<DistributionPointSettingType>

Specifies the pre-staged distribution point settings. The acceptable values for this parameter are:

-- AutoDownload. Automatically download content when packages are assigned to distribution points.
-- DeltaCopy. Download only content changes to distribution points.
-- NoDownload. Manually copy the content in this package to distribution points.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DistributionPriority<DistributionPriorityType>

Specifies the order in which packages are sent to other sites. Packages with a high priority are sent before packages with a low or medium priority. Packages with equal priority are sent in the order they are created.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IconLocationFile<String>

Specifies the location of the application icon file.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String[]>

Specifies an array of application IDs.

Aliases

CIId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

Specifies an application object. To obtain an application object, use the Get-CMApplication cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IsFeatured<Boolean>

Indicates whether the application is featured in Configuration Manager.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Keyword<String>

Specifies a key word for the application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LinkText<String>

Specifies a description that appears in the Application Catalog. The text accompanies the hyperlink to additional information or documentation about this application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LocalizedApplicationDescription<String>

Specifies the localized description string that appears in the client software center or catalog web site.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LocalizedApplicationName<String>

Specifies the localized name string that appears in the client software center or catalog web site.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names for the application.

Aliases

LocalizedDisplayName

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewName<String>

Specifies a new name for the application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-OptionalReference<String>

Specifies the optional reference information for this application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Owner<String>

Specifies one or more administrative users who are the owners of this application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PrivacyUrl<String>

Specifies the link, as a URL, to the privacy file location.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Publisher<String>

Specifies the name of a software publisher in Configuration Manager.

Aliases

Manufacturer

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReleaseDate<DateTime>

Specifies a release date of the application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecurityScopeAction<SecurityScopeActionType>

Specifies an action for a security scope. The acceptable values for this parameter are: AddMembership and RemoveMembership.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecurityScopeName<String>

Specifies the name of a security scope. A security scope name can be Default or the name of a custom security scope.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SendToProtectedDistributionPoint<Boolean>

Indicates whether to copy this application to protected distribution points.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SoftwareVersion<String>

Specifies a software version for an application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SupportContact<String>

Specifies one or more administrative users who are support contacts for this application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserCategories<String[]>

Specifies an array of categories for which software is a member. Use this parameter to identify a group, or category, of software, such as office productivity or graphics.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserDocumentation<String>

Specifies a hyperlink, in Uniform Resource Indicator (URI) format, to additional information for this application.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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

Examples

Example 1: Set an application

This example sets security scope action for an application.

PS C:\> Set-CMApplication -SecurityScopeAction AddMembership -SecurityScopeName "22" -Name "adw"

Export-CMApplication

Get-CMApplication

Import-CMApplication

New-CMApplication

Remove-CMApplication

Resume-CMApplication

Suspend-CMApplication