Start-CMApplicationDeployment
Starts an application deployment in Configuration Manager.
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>]
The Start-CMApplicationDeployment cmdlet starts an application deployment.
Specifies whether an application requires administrator approval prior to installation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
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 |
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 |
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 |
Specifies a comment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
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 |
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 |
Specifies an action for a deployment. The values for this parameter 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 |
Specifies a deployment purpose. The values for this parameter 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 |
Specifies 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 |
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 |
Specifies an array of IDs.
Aliases |
CIId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies an application deployment object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies an array of names.
Aliases |
LocalizedDisplayName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies 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 |
Specifies 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 |
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 |
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 |
Specifies whether to copy software to a device prior to 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 |
Specifies 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 |
Specifies whether a client can reboot outside of a maintenance window.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies whether to send wake-up packets.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
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 |
Specifies whether to use UTC time or local time zone.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies 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 |
Specifies user notification types. The values for this parameter 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 |
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
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 |
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).
The input type is the type of the objects that you can pipe to the cmdlet.
The output type is the type of the objects that the cmdlet emits.
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