Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-CMApplicationGroupDeployment
- Module:
- ConfigurationManager Module
Configure the deployment of an application group.
Syntax
SetByValueMandatory (Default)
Set-CMApplicationGroupDeployment
-InputObject <IResultObject>
[-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>]
SetByIdMandatory
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>]
SetByNameMandatory
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApplicationGroupName
Specify the name of the app group to configure.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Collection
Specify a collection object as the target for this app group deployment. To get this object, use the Get-CMCollection cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionId
Specify a collection ID as the target for this app group deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionName
Specify a collection name as the target for this app group deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-Comment
Specify an optional comment for the app group deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-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.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisableWildcardHandling
This 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
-EnableMomAlert
Set this parameter to $true to enable System Center Operations Manager maintenance mode for this deployment.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ForceWildcardHandling
This 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
-InputObject
Specify an object for the app group. To get this object, use the Get-CMApplicationGroup cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ApplicationGroup, DeploymentSummary, ApplicationGroupAssignment |
Parameter sets
-OverrideServiceWindow
Set this parameter to $true to install the app group outside a maintenance window.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RaiseMomAlertsOnFailure
Set this parameter to $true to generate a System Center Operations Manager alert when the deployment fails.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RebootOutsideServiceWindow
Set this parameter to $true to allow the device to restart outside a maintenance window.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TimeBaseOn
Specify which time zone to use:
LocalTime: Use the local time of the device.UTC: Use Coordinated Universal Time (UTC).
Parameter properties
| Type: | TimeType |
| Default value: | None |
| Accepted values: | LocalTime, Utc |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserNotification
Use this parameter to specify the user experience for this deployment:
DisplayAll: Display in Software Center and show all notificationsDisplaySoftwareCenterOnly: Display in Software Center, and only show notifications of computer restarts.HideAll: Hide in Software Center and all notifications
Parameter properties
| Type: | UserNotificationType |
| Default value: | None |
| Accepted values: | DisplayAll, DisplaySoftwareCenterOnly, HideAll |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows 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
CommonParameters
This 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
IResultObject
IResultObject
Notes
This cmdlet returns the SMS_ApplicationGroupAssignment WMI class object.
Related Links
Feedback
Was this page helpful?