Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-CMSoftwareUpdatePhase
- Module:
- ConfigurationManager Module
Use this cmdlet to create a deployment phase for software update.
Syntax
SearchByCollection
New-CMSoftwareUpdatePhase
[-Collection] <IResultObject>
-PhaseName <String>
[-AlertDelta <Int32>]
[-AlertThresholdPercentage <Int32>]
[-AlertUnit <TimeUnitType>]
[-AllowMeteredConnection <Boolean>]
[-AllowSystemRestart <Boolean>]
[-AllowWumuFallback <Boolean>]
[-BeginCondition <BeginConditionType>]
[-CriteriaOption <CriteriaType>]
[-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>]
[-DeadlineUnit <TimeUnitType>]
[-DeadlineValue <Int32>]
[-DisableScomAlert <Boolean>]
[-EnableAlert <Boolean>]
[-EnableWakeOnLan <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-InstallationChoice <InstallationChoiceType>]
[-PhaseDescription <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>]
SearchByCollectionId
New-CMSoftwareUpdatePhase
[-CollectionId] <String>
-PhaseName <String>
[-AlertDelta <Int32>]
[-AlertThresholdPercentage <Int32>]
[-AlertUnit <TimeUnitType>]
[-AllowMeteredConnection <Boolean>]
[-AllowSystemRestart <Boolean>]
[-AllowWumuFallback <Boolean>]
[-BeginCondition <BeginConditionType>]
[-CriteriaOption <CriteriaType>]
[-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>]
[-DeadlineUnit <TimeUnitType>]
[-DeadlineValue <Int32>]
[-DisableScomAlert <Boolean>]
[-EnableAlert <Boolean>]
[-EnableWakeOnLan <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-InstallationChoice <InstallationChoiceType>]
[-PhaseDescription <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>]
SearchByCollectionName
New-CMSoftwareUpdatePhase
[-CollectionName] <String>
-PhaseName <String>
[-AlertDelta <Int32>]
[-AlertThresholdPercentage <Int32>]
[-AlertUnit <TimeUnitType>]
[-AllowMeteredConnection <Boolean>]
[-AllowSystemRestart <Boolean>]
[-AllowWumuFallback <Boolean>]
[-BeginCondition <BeginConditionType>]
[-CriteriaOption <CriteriaType>]
[-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>]
[-DeadlineUnit <TimeUnitType>]
[-DeadlineValue <Int32>]
[-DisableScomAlert <Boolean>]
[-EnableAlert <Boolean>]
[-EnableWakeOnLan <Boolean>]
[-GenerateScomAlertOnFailure <Boolean>]
[-InstallationChoice <InstallationChoiceType>]
[-PhaseDescription <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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AlertUnit
Specify the type of period. Use this parameter with AlertDelta.
Parameter properties
| Type: | TimeUnitType |
| Default value: | None |
| Accepted values: | Hours, Days, Weeks, Months |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | BeginConditionType |
| Default value: | None |
| Accepted values: | AfterPeriod, Manually |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Collection
Specify an object for the target collection.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionId
Specify the target collection by ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionName
Specify the target collection by name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-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.
Parameter properties
| Type: | CriteriaType |
| Default value: | None |
| Accepted values: | Compliance, Number |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CriteriaValue
This integer value depends upon the value that you specify for CriteriaOption:
Compliance: Specify the percentageNumber: Specify the number of devices
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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).
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeadlineUnit
Specify the type of deadline period. Use this parameter with DeadlineValue.
Parameter properties
| Type: | TimeUnitType |
| Default value: | None |
| Accepted values: | Hours, Days, Weeks, Months |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior. It's not recommended. You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | InstallationChoiceType |
| Default value: | None |
| Accepted values: | AsSoonAsPossible, AfterPeriod |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PhaseDescription
Specify a description for the phase.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PhaseName
Specify a name for the description.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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 messagesOnlySuccessAndErrorMessages: Only success and error messagesOnlyErrorMessages: Only error messages
Parameter properties
| Type: | VerbosityLevelType |
| Default value: | None |
| Accepted values: | AllMessages, OnlySuccessAndErrorMessages, OnlyErrorMessages |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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).
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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 notificationsDisplaySoftwareCenterOnly: Display in Software Center, and only show notifications for computer restartsHideAll: Hide in Software Center and all notifications
Parameter properties
| Type: | UserNotificationType |
| Default value: | None |
| Accepted values: | DisplayAll, DisplaySoftwareCenterOnly, HideAll |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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
None
Outputs
Microsoft.ConfigurationManager.PhasedDeploymentModel.Phase
Feedback
Was this page helpful?