Set-CMApplication
Configure the properties of an application.
Syntax
Set-CMApplication
[-AddAppCatalog <AppDisplayInfo[]>]
[-AddAppCategory <IResultObject[]>]
[-AddOwner <String[]>]
[-AddSupportContact <String[]>]
[-AddUserCategory <IResultObject[]>]
[-AppCategory <String[]>]
[-ApplyToLanguageById <Int32>]
[-AutoInstall <Boolean>]
[-CleanAppCategory]
[-CleanUserCategory]
[-ClearAppCatalog]
[-ClearOwner]
[-ClearSupportContact]
[-DefaultLanguageId <Int32>]
[-Description <String>]
[-DisplaySupersedenceInApplicationCatalog <Boolean>]
[-DistributionPointSetting <DistributionPointSettingType>]
[-DistributionPriority <DistributionPriorityType>]
[-IconLocationFile <String>]
[-InputObject] <IResultObject>
[-IsFeatured <Boolean>]
[-Keyword <String[]>]
[-LinkText <String>]
[-LocalizedApplicationName <String>]
[-LocalizedDescription <String>]
[-NewName <String>]
[-OptionalReference <String>]
[-Owner <String>]
[-PassThru]
[-PrivacyUrl <String>]
[-Publisher <String>]
[-ReleaseDate <DateTime>]
[-RemoveAppCatalog <Int32[]>]
[-RemoveAppCategoryName <String[]>]
[-RemoveOwner <String[]>]
[-RemoveSupportContact <String[]>]
[-RemoveUserCategoryName <String[]>]
[-SendToProtectedDistributionPoint <Boolean>]
[-SoftwareVersion <String>]
[-SupportContact <String>]
[-UserCategory <String[]>]
[-UserDocumentation <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMApplication
[-AddAppCatalog <AppDisplayInfo[]>]
[-AddAppCategory <IResultObject[]>]
[-AddOwner <String[]>]
[-AddSupportContact <String[]>]
[-AddUserCategory <IResultObject[]>]
[-AppCategory <String[]>]
[-ApplyToLanguageById <Int32>]
[-AutoInstall <Boolean>]
[-CleanAppCategory]
[-CleanUserCategory]
[-ClearAppCatalog]
[-ClearOwner]
[-ClearSupportContact]
[-DefaultLanguageId <Int32>]
[-Description <String>]
[-DisplaySupersedenceInApplicationCatalog <Boolean>]
[-DistributionPointSetting <DistributionPointSettingType>]
[-DistributionPriority <DistributionPriorityType>]
[-IconLocationFile <String>]
[-Id] <Int32>
[-IsFeatured <Boolean>]
[-Keyword <String[]>]
[-LinkText <String>]
[-LocalizedApplicationName <String>]
[-LocalizedDescription <String>]
[-NewName <String>]
[-OptionalReference <String>]
[-Owner <String>]
[-PassThru]
[-PrivacyUrl <String>]
[-Publisher <String>]
[-ReleaseDate <DateTime>]
[-RemoveAppCatalog <Int32[]>]
[-RemoveAppCategoryName <String[]>]
[-RemoveOwner <String[]>]
[-RemoveSupportContact <String[]>]
[-RemoveUserCategoryName <String[]>]
[-SendToProtectedDistributionPoint <Boolean>]
[-SoftwareVersion <String>]
[-SupportContact <String>]
[-UserCategory <String[]>]
[-UserDocumentation <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMApplication
[-AddAppCatalog <AppDisplayInfo[]>]
[-AddAppCategory <IResultObject[]>]
[-AddOwner <String[]>]
[-AddSupportContact <String[]>]
[-AddUserCategory <IResultObject[]>]
[-AppCategory <String[]>]
[-ApplyToLanguageById <Int32>]
[-AutoInstall <Boolean>]
[-CleanAppCategory]
[-CleanUserCategory]
[-ClearAppCatalog]
[-ClearOwner]
[-ClearSupportContact]
[-DefaultLanguageId <Int32>]
[-Description <String>]
[-DisplaySupersedenceInApplicationCatalog <Boolean>]
[-DistributionPointSetting <DistributionPointSettingType>]
[-DistributionPriority <DistributionPriorityType>]
[-IconLocationFile <String>]
[-IsFeatured <Boolean>]
[-Keyword <String[]>]
[-LinkText <String>]
[-LocalizedApplicationName <String>]
[-LocalizedDescription <String>]
-ModelName <String>
[-NewName <String>]
[-OptionalReference <String>]
[-Owner <String>]
[-PassThru]
[-PrivacyUrl <String>]
[-Publisher <String>]
[-ReleaseDate <DateTime>]
[-RemoveAppCatalog <Int32[]>]
[-RemoveAppCategoryName <String[]>]
[-RemoveOwner <String[]>]
[-RemoveSupportContact <String[]>]
[-RemoveUserCategoryName <String[]>]
[-SendToProtectedDistributionPoint <Boolean>]
[-SoftwareVersion <String>]
[-SupportContact <String>]
[-UserCategory <String[]>]
[-UserDocumentation <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMApplication
[-AddAppCatalog <AppDisplayInfo[]>]
[-AddAppCategory <IResultObject[]>]
[-AddOwner <String[]>]
[-AddSupportContact <String[]>]
[-AddUserCategory <IResultObject[]>]
[-AppCategory <String[]>]
[-ApplyToLanguageById <Int32>]
[-AutoInstall <Boolean>]
[-CleanAppCategory]
[-CleanUserCategory]
[-ClearAppCatalog]
[-ClearOwner]
[-ClearSupportContact]
[-DefaultLanguageId <Int32>]
[-Description <String>]
[-DisplaySupersedenceInApplicationCatalog <Boolean>]
[-DistributionPointSetting <DistributionPointSettingType>]
[-DistributionPriority <DistributionPriorityType>]
[-IconLocationFile <String>]
[-IsFeatured <Boolean>]
[-Keyword <String[]>]
[-LinkText <String>]
[-LocalizedApplicationName <String>]
[-LocalizedDescription <String>]
[-Name] <String>
[-NewName <String>]
[-OptionalReference <String>]
[-Owner <String>]
[-PassThru]
[-PrivacyUrl <String>]
[-Publisher <String>]
[-ReleaseDate <DateTime>]
[-RemoveAppCatalog <Int32[]>]
[-RemoveAppCategoryName <String[]>]
[-RemoveOwner <String[]>]
[-RemoveSupportContact <String[]>]
[-RemoveUserCategoryName <String[]>]
[-SendToProtectedDistributionPoint <Boolean>]
[-SoftwareVersion <String>]
[-SupportContact <String>]
[-UserCategory <String[]>]
[-UserDocumentation <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use the Set-CMApplication cmdlet to configure the settings of an application.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
Examples
Example 1: Reconfigure the properties of an application
The first command gets the application object named Application01. The next two commands use the Get-CMCategory cmdlet to get objects for a user and administrator category. The Set-CMApplication cmdlet then sets the specified properties on Applicaton01.
$app = Get-CMApplication -Name "Application01"
$userCat = Get-CMCategory -Name "Test Applications" -CategoryType CatalogCategories
$adminCat = Get-CMCategory -Name "Testing" -CategoryType AppCategories
Set-CMApplication -InputObject $app -NewName "Application01_New" -Description "Application updated" -Publisher "Test group" -SoftwareVersion "1.0.0.1" -OptionalReference "Reference" -ReleaseDate 2/24/2016 -AutoInstall $True -Owner "jqpublic" -SupportContact "jqpublic" -LocalizedApplicationName "Localized Application01" -UserDocumentation "https://contoso.com/content" -LinkText "For more info" -LocalizedDescription "Localized Application New" -Keyword "Application" -PrivacyUrl "https://contoso.com/privacy" -IsFeatured $True -IconLocationFile "C:\Users\art\icon.png" -DistributionPriority Medium -SendToProtectedDistributionPoint $True -DistributionPointSetting NoDownload -AddUserCategory $userCat -AddAppCategory $adminCat
Parameters
-AddAppCatalog
Use this parameter to specify a Software Center entry for a specific language. This entry can include all of the localized information about the app:
- Description
- IconLocationFile
- Keyword
- LinkText
- PrivacyUrl
- Title
- UserDocumentation
To get this object, use the New-CMApplicationDisplayInfo cmdlet.
Type: | AppDisplayInfo[] |
Aliases: | AppCatalogs |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AddAppCategory
Specify one or more administrative category objects to help you filter and find the app in the console. To get these objects, use the Get-CMCategory cmdlet. These categories are of type AppCategories.
To add categories to help users filter and find applications in Software Center, use the AddUserCategory parameter.
Type: | IResultObject[] |
Aliases: | AddAppCategories |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AddOwner
Specify one or more administrative users who are responsible for this app.
Type: | String[] |
Aliases: | AddOwners |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AddSupportContact
Specify one or more administrative users that end users can contact for help with this application.
Type: | String[] |
Aliases: | AddSupportContacts |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AddUserCategory
Specify one or more user category objects to help you filter and find the app group in the console. To get these objects, use the Get-CMCategory cmdlet. These categories are of type CatalogCategories.
To add categories to help users filter and find applications in Software Center, use the AddAppCategory parameter.
Type: | IResultObject[] |
Aliases: | AddUserCategories |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AppCategory
This parameter is deprecated, use -AddAppCategory.
Type: | String[] |
Aliases: | AppCategories |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ApplyToLanguageById
For settings that display in Software Center, use this parameter to specify the language ID for the settings.
This ID is the decimal equivalent of the Windows language ID. For example, 1033
is 0x0409
for English (United States), and 2108
is 0x083C
for Irish (Ireland). For more information, see [MS-LCID]: Windows Language Code Identifier (LCID) Reference.
For example, to add a localized app name for Irish (Ireland):
-ApplyToLanguageById 2108 -LocalizedName "Fáilte romhat"
Type: | Int32 |
Aliases: | ApplySettingToSpecificLanguage |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AutoInstall
Set this parameter to $true to allow the app to be installed from the Install Application task sequence step without being deployed.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CleanAppCategory
Add this parameter to remove all administrative categories. To remove a single category, use the RemoveAppCategory parameter.
Type: | SwitchParameter |
Aliases: | CleanAppCategories |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CleanUserCategory
Add this parameter to remove all user categories. To remove a single category, use the RemoveUserCategory parameter.
Type: | SwitchParameter |
Aliases: | CleanUserCategories |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClearAppCatalog
Add this parameter to remove all localized Software Center entries. To remove a single entry, use the RemoveAppCatalog parameter.
Type: | SwitchParameter |
Aliases: | ClearAppCatalogs, CleanAppCatalog, CleanAppCatalogs |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClearOwner
Add this parameter to remove all owners. To remove a single owner, use the RemoveOwner parameter.
Type: | SwitchParameter |
Aliases: | CleanOwners |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClearSupportContact
Add this parameter to remove all support contacts. To remove a single contact, use the RemoveSupportContact parameter.
Type: | SwitchParameter |
Aliases: | CleanSupportContacts |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultLanguageId
Specify the language ID for the default Software Center language.
This ID is the decimal equivalent of the Windows language ID. For example, 1033
is 0x0409
for English (United States), and 2108
is 0x083C
for Irish (Ireland). For more information, see [MS-LCID]: Windows Language Code Identifier (LCID) Reference.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specify an optional administrator comment for the app. The maximum length is 2048 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplaySupersedenceInApplicationCatalog
While the application catalog is no longer supported, you can still use this parameter to allow users to see in Software Center deployments for this application and all applications that it supersedes.
Type: | Boolean |
Aliases: | DisplaySupersedencesInApplicationCatalog |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DistributionPointSetting
Specify the prestaged distribution point settings:
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.
Type: | DistributionPointSettingType |
Accepted values: | AutoDownload, DeltaCopy, NoDownload |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DistributionPriority
Specify the order in which the site sends the content to other sites and the distribution points in this site.
The site sends high priority content before content with medium or low priority. Content with equal priority are sent in the order in which they're created.
Type: | DistributionPriorityType |
Accepted values: | High, Medium, Low |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IconLocationFile
Specify the path to the file that contains the icon for this app. Icons can have pixel dimensions of up to 512x512. The file can be of the following image and icon file types:
- DLL
- EXE
- JPG
- ICO
- PNG
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
Specify the ID of the app to configure. This value is the same as the CI_ID, for example 1025866
.
Type: | Int32 |
Aliases: | CIId, CI_ID |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specify an app object to configure. To get this object, use the Get-CMApplication cmdlet.
Type: | IResultObject |
Aliases: | Application |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IsFeatured
Set this parameter to $true to display this application as a featured app and highlight it in the Company Portal.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Keyword
Specify a list of keywords in the selected language. These keywords help Software Center users search for the app group.
Tip
To add multiple keywords, use CultureInfo.CurrentCulture.TextInfo.ListSeparator as the delimiter.
Type: | String[] |
Aliases: | Keywords |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LinkText
When you use the UserDocumentation parameter, use this parameter to show a string in place of "Additional information" in Software Center. The maximum length is 128 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LocalizedApplicationName
Specify the app name in the selected language. This name appears in Software Center.
A name is required for each language that you add.
The maximum length is 256 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LocalizedDescription
Specify a description for this app in the selected language. The maximum length is 2048 characters.
Type: | String |
Aliases: | LocalizedApplicationDescription |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ModelName
Specify the application model identifier of the app to configure. This value is also known as the CI Unique ID. For example, ScopeId_0D7D8B60-F2F9-484A-B9F3-4A8B68D14D59/ApplicationGroup_047fbf05-55f4-42ab-9581-e63fd0337fed
.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specify the name of the app to configure.
Type: | String |
Aliases: | LocalizedDisplayName, ApplicationName |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NewName
Use this parameter to rename the app. The maximum length is 256 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OptionalReference
Specify an optional string to help you find the app in the console. The maximum length is 256 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Owner
Specify an administrative user who's responsible for this app.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivacyUrl
Specify a website address to the privacy statement for the app. The format needs to be a valid URL, for example https://contoso.com/privacy
. The maximum length of the entire string is 128 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Publisher
Specify optional vendor information for this app. The maximum length is 256 characters.
Type: | String |
Aliases: | Manufacturer |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReleaseDate
Specify a date object for when this app was released. To get this object, use the Get-Date built-in cmdlet.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveAppCatalog
Specify an array of language IDs to remove the associated Software Center entries. To remove all entries, use the ClearAppCatalog parameter.
This ID is the decimal equivalent of the Windows language ID. For example, 1033
is 0x0409
for English (United States), and 2108
is 0x083C
for Irish (Ireland). For more information, see [MS-LCID]: Windows Language Code Identifier (LCID) Reference.
For example, to remove the localized Software Center entry for Irish (Ireland):
-RemoveAppCatalog 2108
Type: | Int32[] |
Aliases: | RemoveAppCatalogsByLanguageId |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveAppCategoryName
Specify an array of administrative category names to remove. To remove all administrative categories, use the CleanAppCategory parameter.
Type: | String[] |
Aliases: | RemoveAppCategoryNames |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveOwner
Specify an array of owners to remove. To remove all owners, use the ClearOwner parameter.
Type: | String[] |
Aliases: | RemoveOwners |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveSupportContact
Specify an array of support contacts to remove. To remove all support contacts, use the ClearSupportContact parameter.
Type: | String[] |
Aliases: | RemoveSupportContacts |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveUserCategoryName
Specify an array of user category names to remove. To remove all user categories, use the CleanUserCategory parameter.
Type: | String[] |
Aliases: | RemoveUserCategoryNames |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SendToProtectedDistributionPoint
Indicates whether to copy this application to protected distribution points.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SoftwareVersion
Specify an optional version string for the app. The maximum length is 64 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SupportContact
Specify an administrative user that end users can contact for help with this application.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserCategory
This parameter is deprecated, use -AddUserCategory.
Type: | String[] |
Aliases: | UserCategories |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserDocumentation
Specify the location of a file from which Software Center users can get more information about this app. This location is a website address, or a network path and file name. Make sure that users have access to this location.
The maximum length of the entire string is 256 characters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject
Notes
For more information on this return object and its properties, see SMS_Application server WMI class.