Start-CMApplicationDeployment
Start-CMApplicationDeployment
Starts an application deployment in Configuration Manager.
Syntax
Parameter Set: SearchByNameMandatory
Start-CMApplicationDeployment -CollectionName <String> -Name <String[]> [-AppRequiresApproval <Boolean> ] [-AvaliableDate <DateTime> ] [-AvaliableTime <DateTime> ] [-Comment <String> ] [-DeadlineDate <DateTime> ] [-DeadlineTime <DateTime> ] [-DeployAction <DeployActionType> {Install | Uninstall} ] [-DeployPurpose <DeployPurposeType> {Available | Required} ] [-EnableMomAlert <Boolean> ] [-FailParameterValue <Int32> ] [-OverrideServiceWindow <Boolean> ] [-PersistOnWriteFilterDevice <Boolean> ] [-PostponeDate <DateTime> ] [-PostponeTime <DateTime> ] [-PreDeploy <Boolean> ] [-RaiseMomAlertsOnFailure <Boolean> ] [-RebootOutsideServiceWindow <Boolean> ] [-SendWakeUpPacket <Boolean> ] [-SuccessParameterValue <Int32> ] [-TimeBaseOn <TimeType> {LocalTime | UTC} ] [-UseMeteredNetwork <Boolean> ] [-UserNotification <UserNotificationType> {DisplayAll | DisplaySoftwareCenterOnly | HideAll} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Start-CMApplicationDeployment -CollectionName <String> -Id <String[]> [-AppRequiresApproval <Boolean> ] [-AvaliableDate <DateTime> ] [-AvaliableTime <DateTime> ] [-Comment <String> ] [-DeadlineDate <DateTime> ] [-DeadlineTime <DateTime> ] [-DeployAction <DeployActionType> {Install | Uninstall} ] [-DeployPurpose <DeployPurposeType> {Available | Required} ] [-EnableMomAlert <Boolean> ] [-FailParameterValue <Int32> ] [-OverrideServiceWindow <Boolean> ] [-PersistOnWriteFilterDevice <Boolean> ] [-PostponeDate <DateTime> ] [-PostponeTime <DateTime> ] [-PreDeploy <Boolean> ] [-RaiseMomAlertsOnFailure <Boolean> ] [-RebootOutsideServiceWindow <Boolean> ] [-SendWakeUpPacket <Boolean> ] [-SuccessParameterValue <Int32> ] [-TimeBaseOn <TimeType> {LocalTime | UTC} ] [-UseMeteredNetwork <Boolean> ] [-UserNotification <UserNotificationType> {DisplayAll | DisplaySoftwareCenterOnly | HideAll} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Start-CMApplicationDeployment -CollectionName <String> -InputObject <IResultObject> [-AppRequiresApproval <Boolean> ] [-AvaliableDate <DateTime> ] [-AvaliableTime <DateTime> ] [-Comment <String> ] [-DeadlineDate <DateTime> ] [-DeadlineTime <DateTime> ] [-DeployAction <DeployActionType> {Install | Uninstall} ] [-DeployPurpose <DeployPurposeType> {Available | Required} ] [-EnableMomAlert <Boolean> ] [-FailParameterValue <Int32> ] [-OverrideServiceWindow <Boolean> ] [-PersistOnWriteFilterDevice <Boolean> ] [-PostponeDate <DateTime> ] [-PostponeTime <DateTime> ] [-PreDeploy <Boolean> ] [-RaiseMomAlertsOnFailure <Boolean> ] [-RebootOutsideServiceWindow <Boolean> ] [-SendWakeUpPacket <Boolean> ] [-SuccessParameterValue <Int32> ] [-TimeBaseOn <TimeType> {LocalTime | UTC} ] [-UseMeteredNetwork <Boolean> ] [-UserNotification <UserNotificationType> {DisplayAll | DisplaySoftwareCenterOnly | HideAll} ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-CMApplicationDeployment cmdlet starts an application deployment.
Parameters
-AppRequiresApproval<Boolean>
Indicates whether an application requires administrator approval before installation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AvaliableDate<DateTime>
Specifies a date when the application becomes available.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AvaliableTime<DateTime>
Specifies a time when the application becomes available.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CollectionName<String>
Specifies a target collection to deploy this application.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Comment<String>
Specifies a comment for the application.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeadlineDate<DateTime>
Specifies a day by which to install an application. Autoinstall performs the installation if the application is not installed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeadlineTime<DateTime>
Specifies a time by which to install an application. Autoinstall performs the installation if the application is not installed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeployAction<DeployActionType>
Specifies an action for a deployment. Valid values are:
-- Install. Install the application.
-- Uninstall. Uninstall the application.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeployPurpose<DeployPurposeType>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableMomAlert<Boolean>
Indicates whether to enable Operations Manager maintenance mode.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-FailParameterValue<Int32>
Specifies a value that generates a deployment alert when exceeded.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Id<String[]>
Specifies an array of IDs.
Aliases |
CIId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies an application deployment object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names for the application deployment.
Aliases |
LocalizedDisplayName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OverrideServiceWindow<Boolean>
Indicates whether an application installation occurs outside of a maintenance window.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PersistOnWriteFilterDevice<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PostponeDate<DateTime>
Specifies a date after which to create an alert.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PostponeTime<DateTime>
Specifies a time after which to create an alert.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PreDeploy<Boolean>
Indicates whether to copy software to a device before installation. To use this parameter, set the DeployPurpose parameter to Required.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RaiseMomAlertsOnFailure<Boolean>
Indicates whether to raise Operations Manager alerts when a failure occurs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RebootOutsideServiceWindow<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SendWakeUpPacket<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SuccessParameterValue<Int32>
Specifies a value that the threshold must exceed before an alert is created.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TimeBaseOn<TimeType>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UseMeteredNetwork<Boolean>
Indicates whether clients can download content over metered Internet connections after the installation deadline. Clients may incur additional costs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserNotification<UserNotificationType>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Start application deployment
This command starts an application deployment named 7zip.
PS C:\> 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 DisplaySoftwareCenterOnly