Configure an existing application group.
Syntax SetByValue (Default)Set-CMApplicationGroup
[-InputObject] <IResultObject>
[-NewName <String>]
[-Description <String>]
[-Publisher <String>]
[-SoftwareVersion <String>]
[-OptionalReference <String>]
[-AddAppCategory <IResultObject[]>]
[-RemoveAppCategoryName <String[]>]
[-CleanAppCategory]
[-ReleaseDate <DateTime>]
[-AddOwner <String[]>]
[-RemoveOwner <String[]>]
[-ClearOwner]
[-AddSupportContact <String[]>]
[-RemoveSupportContact <String[]>]
[-ClearSupportContact]
[-AddAppCatalog <AppDisplayInfo[]>]
[-RemoveAppCatalog <Int32[]>]
[-ClearAppCatalog]
[-DefaultLanguageId <Int32>]
[-ApplyToLanguageById <Int32>]
[-LocalizedName <String>]
[-AddUserCategory <IResultObject[]>]
[-RemoveUserCategoryName <String[]>]
[-CleanUserCategory]
[-UserDocumentation <String>]
[-LinkText <String>]
[-PrivacyUrl <String>]
[-LocalizedDescription <String>]
[-Keyword <String[]>]
[-IconLocationFile <String>]
[-AddApplication <String[]>]
[-RemoveApplication <String[]>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetById
Set-CMApplicationGroup
[-Id] <Int32>
[-NewName <String>]
[-Description <String>]
[-Publisher <String>]
[-SoftwareVersion <String>]
[-OptionalReference <String>]
[-AddAppCategory <IResultObject[]>]
[-RemoveAppCategoryName <String[]>]
[-CleanAppCategory]
[-ReleaseDate <DateTime>]
[-AddOwner <String[]>]
[-RemoveOwner <String[]>]
[-ClearOwner]
[-AddSupportContact <String[]>]
[-RemoveSupportContact <String[]>]
[-ClearSupportContact]
[-AddAppCatalog <AppDisplayInfo[]>]
[-RemoveAppCatalog <Int32[]>]
[-ClearAppCatalog]
[-DefaultLanguageId <Int32>]
[-ApplyToLanguageById <Int32>]
[-LocalizedName <String>]
[-AddUserCategory <IResultObject[]>]
[-RemoveUserCategoryName <String[]>]
[-CleanUserCategory]
[-UserDocumentation <String>]
[-LinkText <String>]
[-PrivacyUrl <String>]
[-LocalizedDescription <String>]
[-Keyword <String[]>]
[-IconLocationFile <String>]
[-AddApplication <String[]>]
[-RemoveApplication <String[]>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByModelName
Set-CMApplicationGroup
-ModelName <String>
[-NewName <String>]
[-Description <String>]
[-Publisher <String>]
[-SoftwareVersion <String>]
[-OptionalReference <String>]
[-AddAppCategory <IResultObject[]>]
[-RemoveAppCategoryName <String[]>]
[-CleanAppCategory]
[-ReleaseDate <DateTime>]
[-AddOwner <String[]>]
[-RemoveOwner <String[]>]
[-ClearOwner]
[-AddSupportContact <String[]>]
[-RemoveSupportContact <String[]>]
[-ClearSupportContact]
[-AddAppCatalog <AppDisplayInfo[]>]
[-RemoveAppCatalog <Int32[]>]
[-ClearAppCatalog]
[-DefaultLanguageId <Int32>]
[-ApplyToLanguageById <Int32>]
[-LocalizedName <String>]
[-AddUserCategory <IResultObject[]>]
[-RemoveUserCategoryName <String[]>]
[-CleanUserCategory]
[-UserDocumentation <String>]
[-LinkText <String>]
[-PrivacyUrl <String>]
[-LocalizedDescription <String>]
[-Keyword <String[]>]
[-IconLocationFile <String>]
[-AddApplication <String[]>]
[-RemoveApplication <String[]>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByName
Set-CMApplicationGroup
[-Name] <String>
[-NewName <String>]
[-Description <String>]
[-Publisher <String>]
[-SoftwareVersion <String>]
[-OptionalReference <String>]
[-AddAppCategory <IResultObject[]>]
[-RemoveAppCategoryName <String[]>]
[-CleanAppCategory]
[-ReleaseDate <DateTime>]
[-AddOwner <String[]>]
[-RemoveOwner <String[]>]
[-ClearOwner]
[-AddSupportContact <String[]>]
[-RemoveSupportContact <String[]>]
[-ClearSupportContact]
[-AddAppCatalog <AppDisplayInfo[]>]
[-RemoveAppCatalog <Int32[]>]
[-ClearAppCatalog]
[-DefaultLanguageId <Int32>]
[-ApplyToLanguageById <Int32>]
[-LocalizedName <String>]
[-AddUserCategory <IResultObject[]>]
[-RemoveUserCategoryName <String[]>]
[-CleanUserCategory]
[-UserDocumentation <String>]
[-LinkText <String>]
[-PrivacyUrl <String>]
[-LocalizedDescription <String>]
[-Keyword <String[]>]
[-IconLocationFile <String>]
[-AddApplication <String[]>]
[-RemoveApplication <String[]>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use this cmdlet to configure the settings of an existing application group. Use an app group to deploy multiple applications to a collection as a single deployment. The metadata you specify about the app group is seen in Software Center as a single entity. You can order the apps in the group so that the client installs them in a specific order. For more information, see Create application groups.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
This example gets an object for the app group, and passes it to this cmdlet to rename it.
$appgroup = Get-CMApplicationGroup -Name "Central app"
Set-CMApplicationGroup -InputObject $appgroup -NewName "Contoso Central App"
Example 2: Add a localized name
This example configures the app group with a localized app name for the Irish language.
Set-CMApplicationGroup -Name "Contoso Welcome app" -ApplyToLanguageById 60 -LocalizedName "Fáilte romhat"
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 group:
To get this object, use the New-CMApplicationDisplayInfo cmdlet.
Parameter properties Type:AppDisplayInfo[]
Default value: None Supports wildcards: False DontShow: False Aliases: AppCatalogs Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -AddAppCategorySpecify one or more administrative 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 AppCategories.
To add categories to help users filter and find applications in Software Center, use the AddUserCategory parameter.
Parameter properties Type:IResultObject[]
Default value: None Supports wildcards: False DontShow: False Aliases: AddAppCategories Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -AddApplicationSpecify a string array of app names to add to the group. If you already have an app object from another cmdlet like Get-CMApplication, this value is the LocalizedDisplayName property. For example: $appList = @($app1.LocalizedDisplayName,$app2.LocalizedDisplayName)
String[]
Default value: None Supports wildcards: False DontShow: False Aliases: AddApplications Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -AddOwnerSpecify one or more administrative users who are responsible for this app group.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: AddOwners Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -AddSupportContactSpecify one or more administrative users that end users can contact for help with this application.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: AddSupportContacts Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -AddUserCategorySpecify 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.
Parameter properties Type:IResultObject[]
Default value: None Supports wildcards: False DontShow: False Aliases: AddUserCategories Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ApplyToLanguageByIdFor 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"
Add this parameter to remove all administrative categories. To remove a single category, use the RemoveAppCategory parameter.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: CleanAppCategories Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -CleanUserCategoryAdd this parameter to remove all user categories. To remove a single category, use the RemoveUserCategory parameter.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: CleanUserCategories Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ClearAppCatalogAdd this parameter to remove all localized Software Center entries. To remove a single entry, use the RemoveAppCatalog parameter.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: ClearAppCatalogs, CleanAppCatalog, CleanAppCatalogs Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ClearOwnerAdd this parameter to remove all owners. To remove a single owner, use the RemoveOwner parameter.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: CleanOwners Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ClearSupportContactAdd this parameter to remove all support contacts. To remove a single contact, use the RemoveSupportContact parameter.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: CleanSupportContacts Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ConfirmPrompts you for confirmation before running the cmdlet.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: cf Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -DefaultLanguageIdSpecify 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.
Specify an optional administrator comment for the app group. The maximum length is 2048 characters.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -DisableWildcardHandlingThis parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ForceWildcardHandlingThis parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -IconLocationFileSpecify the path to the file that contains the icon for this app group. Icons can have pixel dimensions of up to 512x512. The file can be of the following image and icon file types:
Specify the ID of the app group to configure. This value is the same as the CI_ID, for example 1025866
.
Specify an app group object to configure. To get this object, use the Get-CMApplicationGroup cmdlet.
Parameter properties Type: IResultObject Default value: None Supports wildcards: False DontShow: False Aliases: ApplicationGroup Parameter sets SetByValue Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False -KeywordSpecify 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.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: Keywords Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -LinkTextWhen 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.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -LocalizedDescriptionSpecify a description for this app group in the selected language. The maximum length is 2048 characters.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Aliases: LocalizedAppGroupDescription Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -LocalizedNameSpecify the app group 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.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Aliases: LocalizedAppGroupName Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ModelNameSpecify the application model identifier of the app group 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
.
Specify the name of the app group to configure.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Aliases: LocalizedDisplayName, ApplicationGroupName Parameter sets SetByName Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -NewNameUse this parameter to rename the app group. The maximum length is 256 characters.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -OptionalReferenceSpecify an optional string to help you find the app group in the console. The maximum length is 256 characters.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -PassThruAdd this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -PrivacyUrlSpecify a website address to the privacy statement for the app group. The format needs to be a valid URL, for example https://contoso.com/privacy
. The maximum length of the entire string is 128 characters.
Specify optional vendor information for this app group. The maximum length is 256 characters.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Aliases: Manufacturer Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -ReleaseDateSpecify a date object for when this app group was released. To get this object, use the Get-Date built-in cmdlet.
Parameter properties Type: DateTime Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveAppCatalogSpecify 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
Int32[]
Default value: None Supports wildcards: False DontShow: False Aliases: RemoveAppCatalogsByLanguageId Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveAppCategoryNameSpecify an array of administrative category names to remove. To remove all administrative categories, use the CleanAppCategory parameter.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: RemoveAppCategoryNames Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveApplicationSpecify an array of application names to remove from this group.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: RemoveApplications Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveOwnerSpecify an array of owners to remove. To remove all owners, use the ClearOwner parameter.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: RemoveOwners Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveSupportContactSpecify an array of support contacts to remove. To remove all support contacts, use the ClearSupportContact parameter.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: RemoveSupportContacts Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -RemoveUserCategoryNameSpecify an array of user category names to remove. To remove all user categories, use the CleanUserCategory parameter.
Parameter properties Type:String[]
Default value: None Supports wildcards: False DontShow: False Aliases: RemoveUserCategoryNames Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -SoftwareVersionSpecify an optional version string for the app group. The maximum length is 64 characters.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -UserDocumentationSpecify the location of a file from which Software Center users can get more information about this app group. 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.
Parameter properties Type: String Default value: None Supports wildcards: False DontShow: False Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False -WhatIfShows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False Aliases: wi Parameter sets (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False CommonParametersThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs Microsoft.ConfigurationManagement.ManagementProvider.IResultObject Outputs IResultObjectThis cmdlet returns the SMS_ApplicationGroup WMI class object.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4