Set-CMPackageDeployment

Module:

ConfigurationManager

Changes values that define how Configuration Manager deploys a software package.

Syntax

Set-CMPackageDeployment
   [-AllowFallback <Boolean>]
   [-AllowSharedContent <Boolean>]
   [-Comment <String>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-DeploymentExpireDateTime <DateTime>]
   [-EnableExpireSchedule <Boolean>]
   [-FastNetworkOption <FastNetworkOptionType>]
   -InputObject <IResultObject>
   [-PersistOnWriteFilterDevice <Boolean>]
   [-RerunBehavior <RerunBehaviorType>]
   [-RunFromSoftwareCenter <Boolean>]
   [-Schedule <IResultObject[]>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-SendWakeupPacket <Boolean>]
   [-SlowNetworkOption <SlowNetworkOptionType>]
   [-SoftwareInstallation <Boolean>]
   -StandardProgramName <String>
   [-SystemRestart <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMPackageDeployment
   [-AllowFallback <Boolean>]
   [-AllowSharedContent <Boolean>]
   [-Comment <String>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-DeploymentExpireDateTime <DateTime>]
   [-EnableExpireSchedule <Boolean>]
   [-FastNetworkOption <FastNetworkOptionType>]
   -PackageName <String>
   [-PersistOnWriteFilterDevice <Boolean>]
   [-RerunBehavior <RerunBehaviorType>]
   [-RunFromSoftwareCenter <Boolean>]
   [-Schedule <IResultObject[]>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-SendWakeupPacket <Boolean>]
   [-SlowNetworkOption <SlowNetworkOptionType>]
   [-SoftwareInstallation <Boolean>]
   -StandardProgramName <String>
   [-SystemRestart <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMPackageDeployment
   [-AllowFallback <Boolean>]
   [-AllowSharedContent <Boolean>]
   [-Comment <String>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-DeploymentExpireDateTime <DateTime>]
   [-EnableExpireSchedule <Boolean>]
   [-FastNetworkOption <FastNetworkOptionType>]
   -PackageId <String>
   [-PersistOnWriteFilterDevice <Boolean>]
   [-RerunBehavior <RerunBehaviorType>]
   [-RunFromSoftwareCenter <Boolean>]
   [-Schedule <IResultObject[]>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-SendWakeupPacket <Boolean>]
   [-SlowNetworkOption <SlowNetworkOptionType>]
   [-SoftwareInstallation <Boolean>]
   -StandardProgramName <String>
   [-SystemRestart <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMPackageDeployment
   [-Comment <String>]
   [-DeploymentStartDateTime <DateTime>]
   -DeviceProgramName <String>
   -PackageName <String>
   [-RecurUnit <RecurUnitType>]
   [-RecurValue <Int32>]
   [-Rerun <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UseRecurrencePattern <Boolean>]
   [-UseUtc <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMPackageDeployment
   [-Comment <String>]
   [-DeploymentStartDateTime <DateTime>]
   -DeviceProgramName <String>
   -PackageId <String>
   [-RecurUnit <RecurUnitType>]
   [-RecurValue <Int32>]
   [-Rerun <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UseRecurrencePattern <Boolean>]
   [-UseUtc <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMPackageDeployment
   [-Comment <String>]
   [-DeploymentStartDateTime <DateTime>]
   -DeviceProgramName <String>
   -InputObject <IResultObject>
   [-RecurUnit <RecurUnitType>]
   [-RecurValue <Int32>]
   [-Rerun <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UseRecurrencePattern <Boolean>]
   [-UseUtc <Boolean>]
   [-PassThru]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMPackageDeployment cmdlet changes values that define how Configuration Manager deploys a software package. A deployment includes a collection of devices or users, a package to deploy, and either a device program name or a standard program name. To specify which deployment to modify, specify the collection name, package, and program name. You can specify the package by name or ID, or you can use the Get-CMPackage cmdlet to get a package object.

Note

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

Examples

Example 1: Set recurrence properties

PS XYZ:\> Set-CMPackageDeployment -CollectionName "All Systems" -DeviceProgramName "DPM" -PackageName "User State Migration Tool for Windows 8" -RecurUnit Hours -RecurValue 7 -UseRecurrencePattern $True

This command makes changes to the deployment specified by the collection named All Systems, the device program named DPM, and the package named User State Migration Tool for Windows 8. The command sets the UseRecurrencePattern parameter to a value of $True. The command specifies a recur unit of Hours and a recur value of seven. Therefore, the deployment recurs every seven hours.

Example 2: Set availability day and time

PS XYZ:\> Set-CMPackageDeployment -CollectionName "All Systems" -PackageName "User State Migration Tool for Windows 8" -StandardProgramName "SPM" -DeploymentAvailableDay 2012/10/18 -DeploymentAvailableTime 15:41 -UseUtcForAvailableSchedule $False

This command makes changes to the deployment specified by the collection named All Systems, the package named User State Migration Tool for Windows 8, and the standard program named SPM. The command specifies a day and time when the deployment becomes available. The command also specifies that the deployment does not use UTC for the availability schedule. The schedule refers to the local time zone.

Parameters

-AllowFallback

{{ Fill AllowFallback Description }}

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowSharedContent

Indicates whether clients use shared content. If this value is $True, clients attempt to download content from other clients that downloaded that content. If this value is $False, clients do not attempt to download from other clients.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Collection

Specifies the user collection.

Type:	IResultObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CollectionId

Specifies the ID of a device or user collection.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CollectionName

Specifies the ID of a device or user collection.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Comment

Specifies a comment for the deployment.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeploymentAvailableDateTime

Specifies, as a DateTime object, the date and time that the deployment becomes available. To obtain a DateTime object, use the Get-Date cmdlet.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeploymentExpireDateTime

Specifies, as a DateTime object, the date and time that the deployment expires. To obtain a DateTime object, use the Get-Date cmdlet.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeploymentStartDateTime

Specifies, as a DateTime object, the date and time that the deployment starts. To obtain a DateTime object, use the Get-Date cmdlet.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceProgramName

Specifies the name of a device program.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableExpireSchedule

Indicates whether to enable the schedule to expire the deployment.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FastNetworkOption

Specifies client behavior on a fast network. The acceptable values for this parameter are:

• DownloadContentFromDistributionPointAndRunLocally
• RunProgramFromDistributionPoint

Type:	FastNetworkOptionType
Accepted values:	RunProgramFromDistributionPoint, DownloadContentFromDistributionPointAndRunLocally
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specifies a package object.

Type:	IResultObject
Aliases:	Package, DeploymentSummary, Advertisement
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PackageId

Specifies the ID of a package.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PackageName

Specifies the name of a package.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Returns the current working object. By default, this cmdlet does not generate any output.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PersistOnWriteFilterDevice

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.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RecurUnit

Specifies a unit for a recurring deployment. The acceptable values for this parameter are:

• Days
• Hours
• Minutes

Type:	RecurUnitType
Accepted values:	Minutes, Hours, Days
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RecurValue

Specifies how often a deployment recurs. This parameter depends on the unit type specified in the RecurUnit parameter. This value can be between 1 and 23 if the unit is Hours, between 1 and 31 if the unit is Days, or between 1 and 59 if the unit is Minutes.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Rerun

Indicates whether the deployment reruns. If this value is $True, the deployment runs again for clients as specified in the RerunBehavior parameter. If this value is $False, the deployment does not run again.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RerunBehavior

Specifies how a deployment reruns on a client. The acceptable values for this parameter are:

• AlwaysRerunProgram. Rerun as scheduled, even if the deployment succeeded. You can use this value for recurring deployments.
• NeverRerunDeployedProgram. Does not rerun, even if the deployment failed or files changed.
• RerunIfFailedPreviousAttempt. Rerun, as scheduled, if the deployment failed on the previous attempt.
• RerunIfSucceededOnpreviousAttempt. Rerun only if the previous attempt succeeded. You can use this value for updates that depend on the previous update.

Type:	RerunBehaviorType
Accepted values:	NeverRerunDeployedProgram, AlwaysRerunProgram, RerunIfFailedPreviousAttempt, RerunIfSucceededOnPreviousAttempt
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RunFromSoftwareCenter

Indicates whether to run from software center.

Type:	Boolean
Aliases:	AllowUsersRunIndependently
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Schedule

Specifies a CMSchedule object. The schedule specifies when the maintenance window occurs. To create a CMSchedule object, use the New-CMSchedule cmdlet.

Type:	IResultObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ScheduleEvent

Specifies an array of schedule event types. The acceptable values for this parameter are:

• AsSoonAsPossible
• LogOff
• LogOn
• SendWakeUpPacket

Type:	ScheduleEventType[]
Accepted values:	AsSoonAsPossible, LogOn, LogOff
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SlowNetworkOption

Specifies how Configuration Manager deploys this package in a slow network. The acceptable values for this parameter are:

• DoNotRunProgram
• DownloadContentFromDistributionPointAndLocally
• RunProgramFromDistributionPoint

Type:	SlowNetworkOptionType
Accepted values:	DoNotRunProgram, DownloadContentFromDistributionPointAndLocally, RunProgramFromDistributionPoint
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SoftwareInstallation

Indicates whether to install the deployed software outside of maintenance windows. A maintenance window is a specified period of time used for computer maintenance and updates. If this value is $True, the Configuration Manager installs software according to schedule, even if the schedule falls outside a maintenance window. If this value is $False, Configuration Manager does not install deployed software outside any windows, but waits for a maintenance window.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StandardProgramName

Specifies a standard program name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SystemRestart

Indicates whether a system restarts outside a maintenance window. A maintenance 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 maintenance windows. If this value is $False, the computer does not restart outside a maintenance window.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseMeteredNetwork

{{ Fill UseMeteredNetwork Description }}

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseRecurrencePattern

Indicates whether to use a recurrence pattern.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseUtc

Indicates whether to use Coordinated Universal Time (UTC), also known as Greenwich Mean Time. If this value is $True, Configuration Manager uses UTC for this deployment. If this value is $False, Configuration Manager uses local time.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseUtcForAvailableSchedule

Indicates whether to use UTC for available schedule. If this value is $True, Configuration Manager uses UTC. If this value is $False, Configuration Manager uses local time.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseUtcForExpireSchedule

Indicates whether to use UTC for expire schedule. If this value is $True, Configuration Manager uses UTC. If this value is $False, Configuration Manager uses local time.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Related Links

• New-CMPackageDeployment
• Get-CMPackageDeployment
• Get-CMPackageDeploymentStatus
• Remove-CMPackageDeployment
• Get-CMPackage