Set-CMApplicationDeployment

Set-CMApplicationDeployment

Modifies properties for an application deployment in Configuration Manager.

Syntax

Parameter Set: SetApplicationDeploymentByIdMandatory
Set-CMApplicationDeployment -ApplicationId <String> -CollectionName <String> [-AppRequiresApproval <Boolean> ] [-AvaliableDate <DateTime> ] [-AvaliableTime <DateTime> ] [-Comment <String> ] [-CreateAlertBaseOnPercentFailure <Boolean> ] [-CreateAlertBaseOnPercentSuccess <Boolean> ] [-DeadlineDate <DateTime> ] [-DeadlineTime <DateTime> ] [-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: SetApplicationDeploymentByNameMandatory
Set-CMApplicationDeployment -ApplicationName <String> -CollectionName <String> [-AppRequiresApproval <Boolean> ] [-AvaliableDate <DateTime> ] [-AvaliableTime <DateTime> ] [-Comment <String> ] [-CreateAlertBaseOnPercentFailure <Boolean> ] [-CreateAlertBaseOnPercentSuccess <Boolean> ] [-DeadlineDate <DateTime> ] [-DeadlineTime <DateTime> ] [-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: SetApplicationDeploymentByValueMandatory
Set-CMApplicationDeployment -Application <IResultObject> -CollectionName <String> [-AppRequiresApproval <Boolean> ] [-AvaliableDate <DateTime> ] [-AvaliableTime <DateTime> ] [-Comment <String> ] [-CreateAlertBaseOnPercentFailure <Boolean> ] [-CreateAlertBaseOnPercentSuccess <Boolean> ] [-DeadlineDate <DateTime> ] [-DeadlineTime <DateTime> ] [-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 Set-CMApplicationDeployment cmdlet modifies properties for an application deployment in Microsoft System Center 2012 SP1 Configuration Manager. An application deployment installs an application according to schedule for a several computers. Application deployments can also allow users to install at a time they choose.

To specify an application deployment to modify, specify the collection name and the application. You can specify an application by name or ID, or you can use the Get-CMApplication cmdlet to get an application to modify.

Parameters

-Application<IResultObject>

Specifies an application object. To obtain an application object, use the Get-CMApplication cmdlet.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ApplicationId<String>

Specifies the ID of an application.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ApplicationName<String>

Specifies the name of an application.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AppRequiresApproval<Boolean>

Indicates whether this application requires Administrator approval if the application is available to the user.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AvaliableDate<DateTime>

Specifies a date as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date. This is the date on which the deployment becomes available. If you specify a value for the DeployAvailableTime parameter in addition to this parameter, the cmdlet uses that value.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-AvaliableTime<DateTime>

Specifies a date as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. This is the date on which the deployment becomes available.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CollectionName<String>

Specifies the name of device collection or user collection.

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 deployment.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CreateAlertBaseOnPercentFailure<Boolean>

Indicates whether to create an alert for a percentage of the applications that fail to deploy. Enter the percentage value by using the FailParameterValue parameter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CreateAlertBaseOnPercentSuccess<Boolean>

Indicates whether to create an alert for a percentage of the applications that deploy successfully. Enter the percentage value by using the SuccessParameterValue parameter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DeadlineDate<DateTime>

Specifies a date as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. This is the deadline for deployment of the application. If the application has not deployed to a client by this date, Configuration Manager forces deployment. If you specify a value for the DeadlineTime parameter in addition to this parameter, the cmdlet uses that value.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DeadlineTime<DateTime>

Specifies a time as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. This is the deadline for deployment of the application. If the application has not deployed to a client by this time, Configuration Manager forces deployment.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EnableMomAlert<Boolean>

Indicates whether alerts from this cmdlet appear in System Center 2012 – Operations Manager.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FailParameterValue<Int32>

Specifies the percentage of failed application installation that causes an alert. Specify an integer from 1 through 100. You must also specify the CreatAlertBaseOnPercentFailure parameter as $True.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-OverrideServiceWindow<Boolean>

Indicates whether the deployment takes place even if scheduled outside of a service window. A service window is a specified period of time used for computer maintenance and updates. If this value is $True, Configuration Manager deploys the application even the scheduled time falls outside the service window. If this value is $False, Configuration Manager does not deploy the application outside the service window, but Configuration Manager waits until it can deploy in a service window.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PersistOnWriteFilterDevice<Boolean>

Indicates whether to enable write filters for embedded devices. For a value of $True, the device commits changes during a maintenance window. This action requires a restart. For a value of $False, the device saves changes in an overlay and commits them later.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PostponeDate<DateTime>

Specifies a date as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Configuration Manager generates a deployment alert after this length of time. If you specify a value for the PostponeTime parameter in addition to this parameter, the cmdlet uses that value.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PostponeTime<DateTime>

Specifies a time as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Configuration Manager generates a deployment alert after this length of time.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PreDeploy<Boolean>

Indicates whether to pre-deploy the application to the primary device of the user.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RaiseMomAlertsOnFailure<Boolean>

Indicates whether to create an Operations Manager alert if a client fails to install the application.

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 the percentage of successful application installation that causes an alert. Specify an integer from 0 through 99. You must also specify the CreatAlertBaseOnPercentSuccess parameter as $True.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-TimeBaseOn<TimeType>

Specifies which time zone to use. The acceptable values for this parameter 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 to allow clients to download content over a metered Internet connection after the deadline, which may incur additional expense.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UserNotification<UserNotificationType>

Specifies the type of notification for a client. Valid values are:

-- DisplayAll
-- DisplaySoftwareCenterOnly
-- HideAll

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: Modify availability and deadline for an application deployment

This command modifies an application deployment for an application named Track System 2011 for a collection named All Users. The command specifies the date and time when the application becomes available and the date and time of a deadline for deployment.

PS C:\> Set-CMApplicationDeployment -ApplicationName "Track System 2011" -CollectionName "All Users" -AvaliableDate 2012/10/21 -AvaliableTime 17:25 -DeadlineDate 2013/01/01 -DeadlineTime 13:10 

Related topics

Get-CMApplication

Start-CMApplicationDeployment

Start-CMApplicationDeploymentSimulation