Edit

Share via


Start-CMApplicationDeployment

(Deprecated) Starts an application deployment in Configuration Manager.

Syntax

SearchByValueMandatory (Default)

Start-CMApplicationDeployment
    [-InputObject] <IResultObject>
    -CollectionName <String>
    [-ApprovalRequired <Boolean>]
    [-AvailableDate <DateTime>]
    [-AvailableDateTime <DateTime>]
    [-AvailableTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDate <DateTime>]
    [-DeadlineDateTime <DateTime>]
    [-DeadlineTime <DateTime>]
    [-DeployAction <DeployActionType>]
    [-DeployPurpose <DeployPurposeType>]
    [-EnableMomAlert <Boolean>]
    [-FailParameterValue <Int32>]
    [-GenerateScomAlertOnFailure <Boolean>]
    [-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>]

SearchByIdMandatory

Start-CMApplicationDeployment
    [-Id] <Int32>
    -CollectionName <String>
    [-ApprovalRequired <Boolean>]
    [-AvailableDate <DateTime>]
    [-AvailableDateTime <DateTime>]
    [-AvailableTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDate <DateTime>]
    [-DeadlineDateTime <DateTime>]
    [-DeadlineTime <DateTime>]
    [-DeployAction <DeployActionType>]
    [-DeployPurpose <DeployPurposeType>]
    [-EnableMomAlert <Boolean>]
    [-FailParameterValue <Int32>]
    [-GenerateScomAlertOnFailure <Boolean>]
    [-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>]

SearchByNameMandatory

Start-CMApplicationDeployment
    [-Name] <String>
    -CollectionName <String>
    [-ApprovalRequired <Boolean>]
    [-AvailableDate <DateTime>]
    [-AvailableDateTime <DateTime>]
    [-AvailableTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDate <DateTime>]
    [-DeadlineDateTime <DateTime>]
    [-DeadlineTime <DateTime>]
    [-DeployAction <DeployActionType>]
    [-DeployPurpose <DeployPurposeType>]
    [-EnableMomAlert <Boolean>]
    [-FailParameterValue <Int32>]
    [-GenerateScomAlertOnFailure <Boolean>]
    [-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 DisplaySoftwareCenterOnly

This command starts an application deployment named 7zip.

Parameters

-ApprovalRequired

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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppRequiresApproval

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailableDate

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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AvailiableDate

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailableDateTime

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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailableTime

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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AvailiableTime

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionName

Specifies a target collection to deploy this application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Comment

Specifies a comment for the application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeadlineDate

Specifies a day by which to install an application. Autoinstall performs the installation if the application is not installed.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeadlineDateTime

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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeadlineTime

Specifies a time by which to install an application. Autoinstall performs the installation if the application is not installed.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeployAction

Specifies an action for a deployment. Valid values are:

  • Install. Install the application.

  • Uninstall. Uninstall the application.

Parameter properties

Type:DeployActionType
Default value:None
Accepted values:Install, Uninstall
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:DeployPurposeType
Default value:None
Accepted values:Available, Required
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableMomAlert

Indicates whether to enable Operations Manager maintenance mode.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FailParameterValue

Specifies a value that generates a deployment alert when exceeded.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GenerateScomAlertOnFailure

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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RaiseMomAlertsOnFailure

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies an array of IDs.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CIId, CI_ID

Parameter sets

SearchByIdMandatory
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies an application deployment object.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SearchByValueMandatory
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies an array of names for the application deployment.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LocalizedDisplayName

Parameter sets

SearchByNameMandatory
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OverrideServiceWindow

Indicates whether an application installation occurs outside of a maintenance window.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PostponeDate

Specifies a date after which to create an alert.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PostponeDateTime

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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PostponeTime

Specifies a time after which to create an alert.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PreDeploy

Indicates whether to copy software to a device before installation. To use this parameter, set the DeployPurpose parameter to Required.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SuccessParameterValue

Specifies a value that the threshold must exceed before an alert is created.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:TimeType
Default value:None
Accepted values:LocalTime, Utc
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UpdateSupersedence

{{ Fill UpdateSupersedence Description }}

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseMeteredNetwork

Indicates whether clients can download content over metered Internet connections after the installation deadline. Clients may incur additional costs.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UserNotificationType
Default value:None
Accepted values:DisplayAll, DisplaySoftwareCenterOnly, HideAll
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

System.Object