Edit

Share via

New-CMPackageDeployment

Module:
ConfigurationManager Module

Deploy a legacy package to a collection.

Syntax

DeployStandardProgramByPackageValue (Default) 

New-CMPackageDeployment
    [-Package] <IResultObject>
    -ProgramName <String>
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-DeployPurpose <DeployPurposeType>]
    [-FastNetworkOption <FastNetworkOptionType>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-RunFromSoftwareCenter <Boolean>]
    [-Schedule <IResultObject[]>]
    [-ScheduleEvent <ScheduleEventType>]
    [-SendWakeupPacket <Boolean>]
    [-SlowNetworkOption <SlowNetworkOptionType>]
    [-SoftwareInstallation <Boolean>]
    [-StandardProgram]
    [-SystemRestart <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployStandardProgramByPackageName 

New-CMPackageDeployment
    -PackageName <String>
    -ProgramName <String>
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-DeployPurpose <DeployPurposeType>]
    [-FastNetworkOption <FastNetworkOptionType>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-RunFromSoftwareCenter <Boolean>]
    [-Schedule <IResultObject[]>]
    [-ScheduleEvent <ScheduleEventType>]
    [-SendWakeupPacket <Boolean>]
    [-SlowNetworkOption <SlowNetworkOptionType>]
    [-SoftwareInstallation <Boolean>]
    [-StandardProgram]
    [-SystemRestart <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployStandardProgramByPackageId 

New-CMPackageDeployment
    -PackageId <String>
    -ProgramName <String>
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-DeployPurpose <DeployPurposeType>]
    [-FastNetworkOption <FastNetworkOptionType>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-RunFromSoftwareCenter <Boolean>]
    [-Schedule <IResultObject[]>]
    [-ScheduleEvent <ScheduleEventType>]
    [-SendWakeupPacket <Boolean>]
    [-SlowNetworkOption <SlowNetworkOptionType>]
    [-SoftwareInstallation <Boolean>]
    [-StandardProgram]
    [-SystemRestart <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployStandardProgramByProgramValue 

New-CMPackageDeployment
    [-Program] <IResultObject>
    [-AllowFallback <Boolean>]
    [-AllowSharedContent <Boolean>]
    [-DeployPurpose <DeployPurposeType>]
    [-FastNetworkOption <FastNetworkOptionType>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-RerunBehavior <RerunBehaviorType>]
    [-RunFromSoftwareCenter <Boolean>]
    [-Schedule <IResultObject[]>]
    [-ScheduleEvent <ScheduleEventType>]
    [-SendWakeupPacket <Boolean>]
    [-SlowNetworkOption <SlowNetworkOptionType>]
    [-SoftwareInstallation <Boolean>]
    [-StandardProgram]
    [-SystemRestart <Boolean>]
    [-UseUtcForAvailableSchedule <Boolean>]
    [-UseUtcForExpireSchedule <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployDeviceProgramByPackageName 

New-CMPackageDeployment
    -PackageName <String>
    -ProgramName <String>
    [-DeployPurpose <DeployPurposeType>]
    [-DeviceProgram]
    [-RecurUnit <RecurUnitType>]
    [-RecurValue <Int32>]
    [-Rerun <Boolean>]
    [-UseUtc <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployDeviceProgramByPackageId 

New-CMPackageDeployment
    -PackageId <String>
    -ProgramName <String>
    [-DeployPurpose <DeployPurposeType>]
    [-DeviceProgram]
    [-RecurUnit <RecurUnitType>]
    [-RecurValue <Int32>]
    [-Rerun <Boolean>]
    [-UseUtc <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployDeviceProgramByPackageValue 

New-CMPackageDeployment
    [-Package] <IResultObject>
    -ProgramName <String>
    [-DeployPurpose <DeployPurposeType>]
    [-DeviceProgram]
    [-RecurUnit <RecurUnitType>]
    [-RecurValue <Int32>]
    [-Rerun <Boolean>]
    [-UseUtc <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeployDeviceProgramByProgramValue 

New-CMPackageDeployment
    [-Program] <IResultObject>
    [-DeployPurpose <DeployPurposeType>]
    [-DeviceProgram]
    [-RecurUnit <RecurUnitType>]
    [-RecurValue <Int32>]
    [-Rerun <Boolean>]
    [-SendWakeupPacket <Boolean>]
    [-UseUtc <Boolean>]
    [-DistributeCollectionName <String>]
    [-DistributeContent]
    [-DistributionPointGroupName <String>]
    [-DistributionPointName <String>]
    [-AvailableDateTime <DateTime>]
    [-Comment <String>]
    [-DeadlineDateTime <DateTime>]
    [-UseMeteredNetwork <Boolean>]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to deploy a package to resources in a collection. You can specify the collection by ID, name, or pass an object.

For other deployment settings that you can't configure with this cmdlet, use Set-CMPackageDeployment.

For more information, see Packages and programs in Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Deploy a package by ID

This command creates a deployment of the package with ID XYZ00001 to the collection with ID XYZ0003F.

$pkgId = "XYZ00001"
$collId = "XYZ0003F"
New-CMPackageDeployment -StandardProgram -PackageId $pkgId -ProgramName "ScanState" -CollectionID $collId -Comment "Use USMT to scan for data" -DeployPurpose Available

Example 2: Deploy a package as required with a deadline

The first command sets a variable for a deadline to 10 days from now at 8:00 PM. The second command creates a schedule object based on that deadline that recurs daily. The third command creates the package deployment with that schedule.

[datetime]$DeadlineTime = (Get-Date -Hour 20 -Minute 0 -Second 0).AddDays(10)

$NewScheduleDeadline = New-CMSchedule -Start $DeadlineTime -Nonrecurring

$pkgId = "XYZ00001"
$progName = "Run"
$collId = "XYZ0003F"

New-CMPackageDeployment -StandardProgram -PackageId $pkgId -ProgramName $progName -DeployPurpose Required -CollectionId $collId -FastNetworkOption DownloadContentFromDistributionPointAndRunLocally -SlowNetworkOption DownloadContentFromDistributionPointAndLocally -RerunBehavior RerunIfFailedPreviousAttempt -Schedule $NewScheduleDeadline

Parameters

-AllowFallback

Allow clients to use distribution points from the default site boundary group.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowSharedContent

Allow clients to use distribution points from a neighbor boundary group.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailableDateTime

Specify when this deployment is available.

Use -DeadlineDateTime to specify when the deployment expires, and -Schedule to specify the deployment assignment, or deadline.

To get a DateTime object, use the Get-Date cmdlet.

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

-Collection

Specify a collection object as the target for this package deployment. To get this object, use the Get-CMCollection cmdlet.

Parameter properties

Type:IResultObject
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

-CollectionId

Specify a collection ID as the target for this package deployment.

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

-CollectionName

Specify a collection name as the target for this package deployment.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
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

-Comment

Specify an optional comment for this package deployment.

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

Add this parameter to prompt for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
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

-DeadlineDateTime

Use this parameter to specify when the deployment expires.

Use -AvailableDateTime to specify when the deployment is available, and -Schedule to specify the deployment assignment, or deadline.

To get a DateTime object, use the Get-Date cmdlet.

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

-DeployPurpose

Specify whether this deployment is available for users to install, or it's required to install at the deadline.

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

-DeviceProgram

If the program for the package that you're deploying is a device-type program, specify this parameter.

Otherwise, use the StandardProgram parameter. The standard program type is for computers with the Configuration Manager client.

Parameter properties

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

Parameter sets

DeployDeviceProgramByPackageName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByProgramValue
Position:Named
Mandatory:True
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

-DistributeCollectionName

The site distributes content to the distribution point groups that are associated with this collection name.

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

-DistributeContent

Add this parameter to distribute the package content when you create this deployment. Clients can't install the package until you distribute content to distribution points that the clients can access.

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

-DistributionPointGroupName

The site distributes content to this distribution point group.

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

-DistributionPointName

The site distributes content to this distribution point.

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

-FastNetworkOption

Specify the behavior when the client uses a distribution point from the current boundary group:

  • Run program from distribution point
  • Download content from distribution point and run locally

If you don't specify this parameter, it uses DownloadContentFromDistributionPointAndRunLocally by default. This option is more secure, because the client validates the content hash before it runs the program.

Parameter properties

Type:FastNetworkOptionType
Default value:None
Accepted values:RunProgramFromDistributionPoint, DownloadContentFromDistributionPointAndRunLocally
Supports wildcards:False
DontShow:False

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
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

-Package

Specify a package object with the program to deploy. To get this object, use the Get-CMPackage cmdlet.

Parameter properties

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

Parameter sets

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

-PackageId

Specify the ID of the package with the program to deploy. This ID is a standard package ID, for example XYZ007E3.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PackageName

Specify the name of the package with the program to deploy.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PersistOnWriteFilterDevice

Configure how the client handles the write filter on Windows Embedded devices.

  • $true: Commit changes at the deadline or during a maintenance window. A restart is required.
  • $false: Apply content on the overlay and commit later.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Program

Specify a program object to deploy. To get this object, use the Get-CMProgram cmdlet.

Parameter properties

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

Parameter sets

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

-ProgramName

Specify the name of the program in the package to deploy.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:StandardProgramName, DeviceProgramName

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecurUnit

Specify a unit for a recurring deployment. Use the RecurValue parameter to specify the value for this unit.

Parameter properties

Type:RecurUnitType
Default value:None
Accepted values:Minutes, Hours, Days
Supports wildcards:False
DontShow:False

Parameter sets

DeployDeviceProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecurValue

Specify how often the deployment recurs.

This parameter depends on the unit type specified in the RecurUnit parameter:

  • Hours: This value can be between 1 and 23
  • Days: Between 1 and 31
  • Minutes: Between 1 and 59

Parameter properties

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

Parameter sets

DeployDeviceProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Rerun

Indicate whether the deployment reruns:

  • $True: The deployment runs again for clients as specified in the RerunBehavior parameter. This value is the default.
  • $False: The deployment doesn't run again.

Parameter properties

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

Parameter sets

DeployDeviceProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RerunBehavior

Specify whether the program reruns on a computer.

  • NeverRerunDeployedProgram: Doesn't rerun, even if the deployment failed or files changed.
  • AlwaysRerunProgram: Rerun as scheduled, even if the deployment succeeded. You can use this value for recurring deployments. This value is the default.
  • RerunIfFailedPreviousAttempt: Rerun as scheduled, if the deployment failed on the previous attempt.
  • RerunIfSucceededOnPreviousAttempt: Rerun only if the previous attempt succeeded.

Parameter properties

Type:RerunBehaviorType
Default value:None
Accepted values:NeverRerunDeployedProgram, AlwaysRerunProgram, RerunIfFailedPreviousAttempt, RerunIfSucceededOnPreviousAttempt
Supports wildcards:False
DontShow:False

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunFromSoftwareCenter

Allow users to run the program independently of assignments.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Schedule

Use this parameter to specify the deployment assignment, or deadline.

Use -AvailableDateTime to specify when the deployment is available, and -DeadlineDateTime to specify when the deployment expires.

Specify an array of schedule objects. A schedule object defines the mandatory assignment schedule for a deployment. To create a schedule object, use the New-CMSchedule cmdlet.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScheduleEvent

Specify the event type that determines when the package deployment runs.

Parameter properties

Type:ScheduleEventType
Default value:None
Accepted values:AsSoonAsPossible, LogOn, LogOff
Supports wildcards:False
DontShow:False

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
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 doesn't wake computers from sleep. For computers to wake, first configure Wake On LAN.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SlowNetworkOption

Specify the behavior when the client uses a distribution point from a neighbor boundary group or the default site boundary group:

  • Do not run program
  • Download content from distribution point and run locally
  • Run program from distribution point

If you don't specify this parameter, it uses DoNotRunProgram by default.

Parameter properties

Type:SlowNetworkOptionType
Default value:None
Accepted values:DoNotRunProgram, DownloadContentFromDistributionPointAndLocally, RunProgramFromDistributionPoint
Supports wildcards:False
DontShow:False

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareInstallation

When the installation deadline is reached, set this parameter to $true to allow the package to install outside the maintenance window.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StandardProgram

Use this parameter for standard program types. This type is for computers with the Configuration Manager client.

If the program for the package that you're deploying is a device-type program, use the DeviceProgram parameter.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SystemRestart

When the installation deadline is reached, set this parameter to $true to allow system restart if necessary outside the maintenance window.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseMeteredNetwork

Indicates whether to allow clients on a metered internet connection to download content after the installation deadline, which might incur more cost.

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

-UseUtc

Indicates whether clients use Coordinated Universal Time (UTC) to determine the availability of a program. UTC time makes the deployment available at the same time for all computers. If you don't specify this parameter, or set it to $false, the client uses its local time.

Parameter properties

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

Parameter sets

DeployDeviceProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployDeviceProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseUtcForAvailableSchedule

Indicates whether clients use Coordinated Universal Time (UTC) to determine the availability of a program. UTC time makes the deployment available at the same time for all computers. If you don't specify this parameter, or set it to $false, the client uses its local time.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseUtcForExpireSchedule

Indicates whether clients use Coordinated Universal Time (UTC) to determine when a program is expired. UTC time expires the deployment at the same time for all computers. If you don't specify this parameter, or set it to $false, the client uses its local time.

Parameter properties

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

Parameter sets

DeployStandardProgramByPackageValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByPackageId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
DeployStandardProgramByProgramValue
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 isn't run.

Parameter properties

Type:SwitchParameter
Default value:None
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