Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-CMApplicationGroupDeployment
- Module:
- ConfigurationManager Module
Create a deployment for an application group.
Syntax
SearchByValueMandatory (Default)
New-CMApplicationGroupDeployment
[-InputObject] <IResultObject>
[-DeadlineDateTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-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>]
SearchByIdMandatory
New-CMApplicationGroupDeployment
[-Id] <Int32>
[-DeadlineDateTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-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>]
SearchByNameMandatory
New-CMApplicationGroupDeployment
[-Name] <String>
[-DeadlineDateTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-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 -DistributeContent
Parameters
-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 |
| Aliases: | SupersedenceDeadlineDateTime |
Parameter sets
-DeployAction
Specify whether this deployment is to install or uninstall the app group.
Parameter properties
| Type: | DeployActionType |
| Default value: | None |
| Accepted values: | Install, Uninstall |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeployPurpose
Specify whether this deployment is available for users to install, or it's required to install at the deadline.
Parameter properties
| Type: | DeployPurposeType |
| Default value: | None |
| Accepted values: | Available, Required |
| 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
-DistributeCollectionName
The site distributes content to the distribution point groups that are associated with this collection name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DistributionPointGroupName
The site distributes content to this distribution point group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DistributionPointName
The site distributes content to this distribution point.
Parameter properties
| Type: | String |
| 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
-GenerateScomAlertOnFailure
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 |
| Aliases: | RaiseMomAlertsOnFailure |
Parameter sets
-Id
Specify the ID of the application group to deploy.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CIId, CI_ID, ApplicationGroupId |
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 |
Parameter sets
-Name
Specify a name for this app group deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | LocalizedDisplayName, ApplicationGroupName |
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
-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
-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
-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.
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
-UseMeteredNetwork
Indicates whether to allow clients on a metered internet connection to download content after the installation deadline, which might incur additional costs.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| 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
Notes
This cmdlet returns the SMS_ApplicationGroupAssignment WMI class object.
Related Links
Feedback
Was this page helpful?