New-CMApplicationGroupDeployment
Create a deployment for an application group.
Syntax
New-CMApplicationGroupDeployment
[-DeadlineDateTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-InputObject] <IResultObject>
[-OverrideServiceWindow <Boolean>]
[-RebootOutsideServiceWindow <Boolean>]
[-TimeBaseOn <TimeType>]
[-UserNotification <UserNotificationType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-Comment <String>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-CMApplicationGroupDeployment
[-DeadlineDateTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-Id] <Int32>
[-OverrideServiceWindow <Boolean>]
[-RebootOutsideServiceWindow <Boolean>]
[-TimeBaseOn <TimeType>]
[-UserNotification <UserNotificationType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-Comment <String>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-CMApplicationGroupDeployment
[-DeadlineDateTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-Name] <String>
[-OverrideServiceWindow <Boolean>]
[-RebootOutsideServiceWindow <Boolean>]
[-TimeBaseOn <TimeType>]
[-UserNotification <UserNotificationType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-Comment <String>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create a deployment for 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.
Before you can deploy an app group, you need to create it. Then you can deploy it to a user or device collection as a single deployment.
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"
$distributionPointName = "dp1.contoso.com"
New-CMApplicationGroupDeployment -Id 16777536 -Collection $collection -DistributionPointName $distributionPointName -DistributeContentParameters
-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 |
| Aliases: | SupersedenceDeadlineDateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeployAction
Specify whether this deployment is to install or uninstall the app group.
| Type: | DeployActionType |
| Accepted values: | Install, Uninstall |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeployPurpose
Specify whether this deployment is available for users to install, or it's required to install at the deadline.
| Type: | DeployPurposeType |
| Accepted values: | Available, Required |
| 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 |
-DistributeCollectionName
The site distributes content to the distribution point groups that are associated with this collection name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DistributeContent
Add this parameter to distribute the app group content when you create this deployment. Clients can't install the applications until you distribute content to distribution points that the clients can access.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DistributionPointGroupName
The site distributes content to this distribution point group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DistributionPointName
The site distributes content to this distribution point.
| Type: | String |
| 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 |
-GenerateScomAlertOnFailure
Set this parameter to $true to generate a System Center Operations Manager alert when the deployment fails.
| Type: | Boolean |
| Aliases: | RaiseMomAlertsOnFailure |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specify the ID of the application group to deploy.
| Type: | Int32 |
| Aliases: | CIId, CI_ID, ApplicationGroupId |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| 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 |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specify a name for this app group deployment.
| Type: | String |
| Aliases: | LocalizedDisplayName, ApplicationGroupName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-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 |
-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 |
-SendWakeupPacket
Indicates whether to send a wake-up packet to computers before the deployment begins. If this value is $True, Configuration Manager wakes a computer from sleep. If this value is $False, it doesn't wake computers from sleep. For computers to wake, first configure Wake On LAN.
| 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 |
-UseMeteredNetwork
Indicates whether to allow clients on a metered internet connection to download content after the installation deadline, which might incur additional costs.
| Type: | Boolean |
| 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 notificationsDisplaySoftwareCenterOnly: 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
Notes
This cmdlet returns the SMS_ApplicationGroupAssignment WMI class object.
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for