Set-CMApplicationGroupDeployment

Module:

ConfigurationManager

Configure the deployment of an application group.

Syntax

Set-CMApplicationGroupDeployment
   [-Comment <String>]
   [-DeadlineDateTime <DateTime>]
   [-TimeBaseOn <TimeType>]
   -InputObject <IResultObject>
   [-AvailableDateTime <DateTime>]
   [-UserNotification <UserNotificationType>]
   [-EnableMomAlert <Boolean>]
   [-RaiseMomAlertsOnFailure <Boolean>]
   [-OverrideServiceWindow <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-RebootOutsideServiceWindow <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMApplicationGroupDeployment
   -ApplicationGroudId <String>
   [-Comment <String>]
   [-DeadlineDateTime <DateTime>]
   [-TimeBaseOn <TimeType>]
   [-AvailableDateTime <DateTime>]
   [-UserNotification <UserNotificationType>]
   [-EnableMomAlert <Boolean>]
   [-RaiseMomAlertsOnFailure <Boolean>]
   [-OverrideServiceWindow <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-RebootOutsideServiceWindow <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMApplicationGroupDeployment
   -ApplicationGroupName <String>
   [-Comment <String>]
   [-DeadlineDateTime <DateTime>]
   [-TimeBaseOn <TimeType>]
   [-AvailableDateTime <DateTime>]
   [-UserNotification <UserNotificationType>]
   [-EnableMomAlert <Boolean>]
   [-RaiseMomAlertsOnFailure <Boolean>]
   [-OverrideServiceWindow <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-RebootOutsideServiceWindow <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Configure the deployment of an application group. An app group contains multiple applications, and users see the group in Software Center as a single entity. 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.

Examples

Example 1

$collection = Get-CMCollection -Name "co1"

Set-CMApplicationGroupDeployment -ApplicationGroupName "appGroupTest" -Collection $collection -Comment "modify comment"

Parameters

-ApplicationGroudId

Specify the ID of the app group to configure.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ApplicationGroupName

Specify the name of the app group to configure.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AvailableDateTime

Specify a DateTime object for when this deployment is available. To get this object, use the Get-Date built-in cmdlet.

Use DeadlineDateTime to specify the deployment assignment, or deadline.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Collection

Specify a collection object as the target for this app group deployment. To get this object, use the Get-CMCollection cmdlet.

Type:	IResultObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CollectionId

Specify a collection ID as the target for this app group deployment.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CollectionName

Specify a collection name as the target for this app group deployment.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Comment

Specify an optional comment for the app group deployment.

Type:	String
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeadlineDateTime

Specify a DateTime object for when this deployment is assigned, also known as the deadline. To get this object, use the Get-Date built-in cmdlet.

Use -AvailableDateTime to specify when the deployment is available.

Type:	DateTime
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

-EnableMomAlert

Set this parameter to $true to enable System Center Operations Manager maintenance mode for this deployment.

Type:	Boolean
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

-InputObject

Specify an object for the app group. To get this object, use the Get-CMApplicationGroup cmdlet.

Type:	IResultObject
Aliases:	ApplicationGroup, DeploymentSummary, ApplicationGroupAssignment
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-OverrideServiceWindow

Set this parameter to $true to install the app group outside a maintenance window.

Type:	Boolean
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

-PersistOnWriteFilterDevice

Use this parameter to handle write filters for Windows Embedded devices. If you set it to $true, the device commits changes at the deadline or during a maintenance window. This action requires a restart. If you set it to $false, the device saves changes to the temporary overlay and commits them later.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RaiseMomAlertsOnFailure

Set this parameter to $true to generate a System Center Operations Manager alert when the deployment fails.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RebootOutsideServiceWindow

Set this parameter to $true to allow the device to restart outside a maintenance window.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeBaseOn

Specify which time zone to use:

• LocalTime: Use the local time of the device.
• UTC: Use Coordinated Universal Time (UTC).

Type:	TimeType
Accepted values:	LocalTime, Utc
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserNotification

Use this parameter to specify the user experience for this deployment:

• DisplayAll: Display in Software Center and show all notifications
• DisplaySoftwareCenterOnly: Display in Software Center, and only show notifications of computer restarts.
• HideAll: Hide in Software Center and all notifications

Type:	UserNotificationType
Accepted values:	DisplayAll, DisplaySoftwareCenterOnly, HideAll
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject

IResultObject

Notes

This cmdlet returns the SMS_ApplicationGroupAssignment WMI class object.

Related Links

• Get-CMApplicationGroupDeployment
• New-CMApplicationGroupDeployment
• Remove-CMApplicationGroupDeployment
• Get-CMApplicationGroup
• Create application groups