Start-CMApplicationDeployment
(Deprecated) Starts an application deployment in Configuration Manager.
Syntax
Start-CMApplicationDeployment
[-ApprovalRequired <Boolean>]
[-AvailableDate <DateTime>]
[-AvailableDateTime <DateTime>]
[-AvailableTime <DateTime>]
-CollectionName <String>
[-Comment <String>]
[-DeadlineDate <DateTime>]
[-DeadlineDateTime <DateTime>]
[-DeadlineTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-FailParameterValue <Int32>]
[-GenerateScomAlertOnFailure <Boolean>]
[-InputObject] <IResultObject>
[-OverrideServiceWindow <Boolean>]
[-PassThru]
[-PersistOnWriteFilterDevice <Boolean>]
[-PostponeDate <DateTime>]
[-PostponeDateTime <DateTime>]
[-PostponeTime <DateTime>]
[-PreDeploy <Boolean>]
[-RebootOutsideServiceWindow <Boolean>]
[-SendWakeupPacket <Boolean>]
[-SuccessParameterValue <Int32>]
[-TimeBaseOn <TimeType>]
[-UpdateSupersedence <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-UserNotification <UserNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-CMApplicationDeployment
[-ApprovalRequired <Boolean>]
[-AvailableDate <DateTime>]
[-AvailableDateTime <DateTime>]
[-AvailableTime <DateTime>]
-CollectionName <String>
[-Comment <String>]
[-DeadlineDate <DateTime>]
[-DeadlineDateTime <DateTime>]
[-DeadlineTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-FailParameterValue <Int32>]
[-GenerateScomAlertOnFailure <Boolean>]
[-Id] <Int32>
[-OverrideServiceWindow <Boolean>]
[-PassThru]
[-PersistOnWriteFilterDevice <Boolean>]
[-PostponeDate <DateTime>]
[-PostponeDateTime <DateTime>]
[-PostponeTime <DateTime>]
[-PreDeploy <Boolean>]
[-RebootOutsideServiceWindow <Boolean>]
[-SendWakeupPacket <Boolean>]
[-SuccessParameterValue <Int32>]
[-TimeBaseOn <TimeType>]
[-UpdateSupersedence <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-UserNotification <UserNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-CMApplicationDeployment
[-ApprovalRequired <Boolean>]
[-AvailableDate <DateTime>]
[-AvailableDateTime <DateTime>]
[-AvailableTime <DateTime>]
-CollectionName <String>
[-Comment <String>]
[-DeadlineDate <DateTime>]
[-DeadlineDateTime <DateTime>]
[-DeadlineTime <DateTime>]
[-DeployAction <DeployActionType>]
[-DeployPurpose <DeployPurposeType>]
[-EnableMomAlert <Boolean>]
[-FailParameterValue <Int32>]
[-GenerateScomAlertOnFailure <Boolean>]
[-Name] <String>
[-OverrideServiceWindow <Boolean>]
[-PassThru]
[-PersistOnWriteFilterDevice <Boolean>]
[-PostponeDate <DateTime>]
[-PostponeDateTime <DateTime>]
[-PostponeTime <DateTime>]
[-PreDeploy <Boolean>]
[-RebootOutsideServiceWindow <Boolean>]
[-SendWakeupPacket <Boolean>]
[-SuccessParameterValue <Int32>]
[-TimeBaseOn <TimeType>]
[-UpdateSupersedence <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-UserNotification <UserNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Important
This cmdlet is deprecated. Use New-CMApplicationDeployment instead.
The Start-CMApplicationDeployment cmdlet starts an application 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: Start application deployment
PS XYZ:\> Start-CMApplicationDeployment -CollectionName "All Users" -Name "7zip" -AvaliableDate 2012/10/1 -AvaliableTime 12:45 -Comment "test" -DeadlineDate 2013/10/23 -DeadlineTime 21:12 -DeployAction Uninstall -EnableMomAlert $True -FailParameterValue 40 -OverrideServiceWindow $True -PersistOnWriteFilterDevice $False -PostponeDate 2014/2/8 -PostponeTime 11:11 -PreDeploy $True -RaiseMomAlertsOnFailure $True -RebootOutsideServiceWindow $True -SendWakeUpPacket $True -SuccessParameterValue 30 -UseMeteredNetwork $True -UserNotification DisplaySoftwareCenterOnlyThis command starts an application deployment named 7zip.
Parameters
-ApprovalRequired
| Type: | Boolean |
| Aliases: | AppRequiresApproval |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailableDate
| Type: | DateTime |
| Aliases: | AvailiableDate |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailableDateTime
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailableTime
| Type: | DateTime |
| Aliases: | AvailiableTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CollectionName
Specifies a target collection to deploy this application.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Comment
Specifies a comment for the application.
| 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadlineDate
Specifies a day by which to install an application. Autoinstall performs the installation if the application is not installed.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadlineDateTime
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadlineTime
Specifies a time by which to install an application. Autoinstall performs the installation if the application is not installed.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeployAction
Specifies an action for a deployment. Valid values are:
Install. Install the application.
Uninstall. Uninstall the application.
| Type: | DeployActionType |
| Accepted values: | Install, Uninstall |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeployPurpose
Specifies the purpose of the deployment.
Valid values are:
Available. If the target collection is a device collection, the application is available in the software center. If the target collection is a user collection, the application is available in the catalog web site.
Required. Installation occurs when the deadline passes.
| 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 |
-EnableMomAlert
Indicates whether to enable Operations Manager maintenance mode.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FailParameterValue
Specifies a value that generates a deployment alert when exceeded.
| Type: | Int32 |
| 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
| Type: | Boolean |
| Aliases: | RaiseMomAlertsOnFailure |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specifies an array of IDs.
| Type: | Int32 |
| Aliases: | CIId, CI_ID |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies an application deployment object.
| Type: | IResultObject |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies an array of names for the application deployment.
| Type: | String |
| Aliases: | LocalizedDisplayName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OverrideServiceWindow
Indicates whether an application installation occurs outside of 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
Indicates whether to commit changes on a Windows Embedded device at deadline or during a maintenance window. Otherwise, changes are written on the overlay and committed later.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PostponeDate
Specifies a date after which to create an alert.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PostponeDateTime
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PostponeTime
Specifies a time after which to create an alert.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PreDeploy
Indicates whether to copy software to a device before installation. To use this parameter, set the DeployPurpose parameter to Required.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RebootOutsideServiceWindow
Indicates whether a computer restarts outside a service window. A service window is a specified period of time used for computer maintenance and updates. If this value is $True, any required restart takes place without regard to service windows. If this value is $False, the computer does not restart outside a service 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 does not wake computers from sleep. For computers to wake, you must first configure Wake On LAN.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SuccessParameterValue
Specifies a value that the threshold must exceed before an alert is created.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeBaseOn
Specifies the time zone to use.
Valid values are:
- LocalTime. Use local time.
- UTC. Use Coordinated Universal Time (UTC), also known as Greenwich Mean Time.
| Type: | TimeType |
| Accepted values: | LocalTime, Utc |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateSupersedence
{{ Fill UpdateSupersedence Description }}
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseMeteredNetwork
Indicates whether clients can download content over metered Internet connections after the installation deadline. Clients may incur additional costs.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserNotification
Specifies user notification types.
Valid values are:
DisplayAll. Display in Software Center and show all notifications.
DisplaySoftwareCenterOnly. Display in Software Center and only show notifications for computer restarts.
HideAll. Do not display in Software Center and do not show 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.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