Edit

Share via

New-CMSoftwareUpdatePhase

  • Reference
Module:
ConfigurationManager

Use this cmdlet to create a deployment phase for software update.

Syntax

New-CMSoftwareUpdatePhase
   [-AlertDelta <Int32>]
   [-AlertThresholdPercentage <Int32>]
   [-AlertUnit <TimeUnitType>]
   [-AllowMeteredConnection <Boolean>]
   [-AllowSystemRestart <Boolean>]
   [-AllowWumuFallback <Boolean>]
   [-BeginCondition <BeginConditionType>]
   [-Collection] <IResultObject>
   [-CriteriaOption <CriteriaType>]
   [-CriteriaValue <Int32>]
   [-DaysAfterPreviousPhaseSuccess <Int32>]
   [-DeadlineUnit <TimeUnitType>]
   [-DeadlineValue <Int32>]
   [-DisableScomAlert <Boolean>]
   [-EnableAlert <Boolean>]
   [-EnableWakeOnLan <Boolean>]
   [-GenerateScomAlertOnFailure <Boolean>]
   [-InstallationChoice <InstallationChoiceType>]
   [-PhaseDescription <String>]
   -PhaseName <String>
   [-RequirePostRebootFullScan <Boolean>]
   [-ServerRestartSuppression <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-StateMessageVerbosity <VerbosityLevelType>]
   [-ThrottlingDays <Int32>]
   [-UseNeighborDP <Boolean>]
   [-UserNotificationOption <UserNotificationType>]
   [-UseSiteDefaultDP <Boolean>]
   [-WorkstationRestartSuppression <Boolean>]
   [-WriteFilterCommit <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMSoftwareUpdatePhase
   [-AlertDelta <Int32>]
   [-AlertThresholdPercentage <Int32>]
   [-AlertUnit <TimeUnitType>]
   [-AllowMeteredConnection <Boolean>]
   [-AllowSystemRestart <Boolean>]
   [-AllowWumuFallback <Boolean>]
   [-BeginCondition <BeginConditionType>]
   [-CollectionId] <String>
   [-CriteriaOption <CriteriaType>]
   [-CriteriaValue <Int32>]
   [-DaysAfterPreviousPhaseSuccess <Int32>]
   [-DeadlineUnit <TimeUnitType>]
   [-DeadlineValue <Int32>]
   [-DisableScomAlert <Boolean>]
   [-EnableAlert <Boolean>]
   [-EnableWakeOnLan <Boolean>]
   [-GenerateScomAlertOnFailure <Boolean>]
   [-InstallationChoice <InstallationChoiceType>]
   [-PhaseDescription <String>]
   -PhaseName <String>
   [-RequirePostRebootFullScan <Boolean>]
   [-ServerRestartSuppression <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-StateMessageVerbosity <VerbosityLevelType>]
   [-ThrottlingDays <Int32>]
   [-UseNeighborDP <Boolean>]
   [-UserNotificationOption <UserNotificationType>]
   [-UseSiteDefaultDP <Boolean>]
   [-WorkstationRestartSuppression <Boolean>]
   [-WriteFilterCommit <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMSoftwareUpdatePhase
   [-AlertDelta <Int32>]
   [-AlertThresholdPercentage <Int32>]
   [-AlertUnit <TimeUnitType>]
   [-AllowMeteredConnection <Boolean>]
   [-AllowSystemRestart <Boolean>]
   [-AllowWumuFallback <Boolean>]
   [-BeginCondition <BeginConditionType>]
   [-CollectionName] <String>
   [-CriteriaOption <CriteriaType>]
   [-CriteriaValue <Int32>]
   [-DaysAfterPreviousPhaseSuccess <Int32>]
   [-DeadlineUnit <TimeUnitType>]
   [-DeadlineValue <Int32>]
   [-DisableScomAlert <Boolean>]
   [-EnableAlert <Boolean>]
   [-EnableWakeOnLan <Boolean>]
   [-GenerateScomAlertOnFailure <Boolean>]
   [-InstallationChoice <InstallationChoiceType>]
   [-PhaseDescription <String>]
   -PhaseName <String>
   [-RequirePostRebootFullScan <Boolean>]
   [-ServerRestartSuppression <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-StateMessageVerbosity <VerbosityLevelType>]
   [-ThrottlingDays <Int32>]
   [-UseNeighborDP <Boolean>]
   [-UserNotificationOption <UserNotificationType>]
   [-UseSiteDefaultDP <Boolean>]
   [-WorkstationRestartSuppression <Boolean>]
   [-WriteFilterCommit <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to create a deployment phase for software update.

Examples

Example 1: Create a software update phase

This example creates a software update phase named MySUPhase for the collection named MyCollection that will only display in Software Center.

New-CMSoftwareUpdatePhase `
 -CollectionName "MyCollection" `
 -PhaseName "MySUPhase" `
 -UserNotificationOption DisplaySoftwareCenterOnly

Parameters

-AlertDelta

This parameter is the same as the following setting on the Alerts page of the Add Phase Wizard in the console: Offset from the deadline time. Specify an integer value for the offset, and then specify the period type with the AlertUnit parameter.

To set this value, you have to use the EnableAlert parameter.

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

-AlertThresholdPercentage

This parameter is the same as the following setting on the Alerts page of the Add Phase Wizard in the console: Client compliance is below the following (percent). Specify an integer value for the percentage. To set this value, you have to use the EnableAlert parameter.

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

-AlertUnit

Specify the type of period. Use this parameter with AlertDelta.

Type:TimeUnitType
Accepted values:Hours, Days, Weeks, Months
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowMeteredConnection

This parameter is the same as the following setting on the Download Settings page of the Add Phase Wizard in the console: Allow clients on a metered internet connection to download content after the installation deadline, which might incur additional costs.

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

-AllowSystemRestart

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: System restart (if required to complete installation). This setting applies when the installation deadline is reached, to allow this activity to be performed outside the maintenance window.

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

-AllowWumuFallback

This parameter is the same as the following setting on the Download Settings page of the Add Phase Wizard in the console: If software updates are not available on distribution point in current, neighbor or site boundary groups, download content from Microsoft Updates.

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

-BeginCondition

Specify an option for beginning this phase of deployment after success of the previous phase:

  • AfterPeriod: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Automatically begin this phase after a deferral period (in days). If you specify this value, use DaysAfterPreviousPhaseSuccess to configure the period of time.

  • Manually: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Manually begin this phase of deployment.

Type:BeginConditionType
Accepted values:AfterPeriod, Manually
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Collection

Specify an object for the target collection.

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

-CollectionId

Specify the target collection by ID.

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

-CollectionName

Specify the target collection by name.

Type:String
Position:0
Default value:None
Required:True
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CriteriaOption

Specify an option to choose the criteria for success of the previous phase:

  • Compliance: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Deployment success percentage. Specify the percentage value with the CriteriaValue parameter.

  • Number: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Number of devices successfully deployed. Specify the number of devices with the CriteriaValue parameter.

Type:CriteriaType
Accepted values:Compliance, Number
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CriteriaValue

This integer value depends upon the value that you specify for CriteriaOption:

  • Compliance: Specify the percentage

  • Number: Specify the number of devices

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

-DaysAfterPreviousPhaseSuccess

Specify an integer value for the number of days after success of the previous phase to begin this phase. This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Automatically begin this phase after a deferral period (in days).

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

-DeadlineUnit

Specify the type of deadline period. Use this parameter with DeadlineValue.

Type:TimeUnitType
Accepted values:Hours, Days, Weeks, Months
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeadlineValue

This parameter is only used if you specify AfterPeriod with the InstallationChoice parameter.

Specify an integer value for the period of time for the deadline. Use the DeadlineUnit parameter to specify the type of period: Hours, Days, Weeks, Months. This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Installation is required after this period of time.

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

-DisableScomAlert

This parameter is the same as the following setting on the Alerts page of the Add Phase Wizard in the console: Disable Operations Manager alerts while software updates run.

Type:Boolean
Position:Named
Default value:None
Required:False
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

-EnableAlert

This parameter is the same as the following setting on the Alerts page of the Add Phase Wizard in the console: Generate an alert when the following conditions are met. When you set this parameter to $true, also set the following parameters:

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

-EnableWakeOnLan

This parameter is the same as the following setting on the Deployment Settings page of the Add Phase Wizard in the console: Use Wake-on-LAN to wake up clients for required deployments.

Type:Boolean
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. It's 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

-GenerateScomAlertOnFailure

This parameter is the same as the following setting on the Alerts page of the Add Phase Wizard in the console: Generate Operations Manager alert when a software update installation fails.

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

-InstallationChoice

Specify an option for the behavior relative to when the software is made available:

  • AsSoonAsPossible: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Installation is required as soon as possible.

  • AfterPeriod: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Installation is required after this period of time. If you specify this value, use DeadlineUnit and DeadlineValue to configure the period of time.

Type:InstallationChoiceType
Accepted values:AsSoonAsPossible, AfterPeriod
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PhaseDescription

Specify a description for the phase.

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

-PhaseName

Specify a name for the description.

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

-RequirePostRebootFullScan

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: If any update in this deployment requires a system restart, run updates deployment evaluation cycle after restart.

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

-ServerRestartSuppression

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console. Suppress the system restart on the following devices: Servers.

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

-SoftwareInstallation

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: Software Installation. This setting applies when the installation deadline is reached, to allow this activity to be performed outside the maintenance window.

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

-StateMessageVerbosity

This parameter is the same as the following setting on the Deployment Settings page of the Add Phase Wizard in the console: State message detail level with the following values:

  • AllMessages: All messages
  • OnlySuccessAndErrorMessages: Only success and error messages
  • OnlyErrorMessages: Only error messages
Type:VerbosityLevelType
Accepted values:AllMessages, OnlySuccessAndErrorMessages, OnlyErrorMessages
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottlingDays

Specify an integer value for the number of days to gradually make this software available. This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Gradually make this software available over this period of time (in days).

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

-UseNeighborDP

This parameter is the same as the following setting on the Download Settings page of the Add Phase Wizard in the console: Select the deployment option to use when a client uses a distribution point from a neighbor boundary group or the default site boundary group. Specify the following values:

  • $true: Download software updates from distribution point and install
  • $false: Do not install software updates
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserNotificationOption

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: Specify user experience setting for this deployment with the following values:

  • DisplayAll: Display in Software Center and show all notifications
  • DisplaySoftwareCenterOnly: Display in Software Center, and only show notifications for computer restarts
  • HideAll: Hide in Software Center and all notifications
Type:UserNotificationType
Accepted values:DisplayAll, DisplaySoftwareCenterOnly, HideAll
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseSiteDefaultDP

This parameter is the same as the following setting on the Download Settings page of the Add Phase Wizard in the console: When software updates are not available on any distribution points in current or neighbor boundary group, client can download and install software updates from distribution points in site default boundary group. Specify the following values:

  • $true: Download and install software updates from the distribution points in site default boundary group
  • $false: Do not install software updates
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 doesn't run.

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

-WorkstationRestartSuppression

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console. Suppress the system restart on the following devices: Workstations.

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

-WriteFilterCommit

This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: Commit changes at deadline or during a maintenance window (requires restart). This setting applies to write filter handling for Windows Embedded devices.

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

Inputs

None

Outputs

Microsoft.ConfigurationManager.PhasedDeploymentModel.Phase