Edit

Share via


New-CMSoftwareUpdateAutoDeploymentRule

Create an automatic deployment rule (ADR) for software updates.

Syntax

NewByCollection (Default)

New-CMSoftwareUpdateAutoDeploymentRule
    -Collection <IResultObject>
    -Name <String>
    [-AddToExistingSoftwareUpdateGroup <Boolean>]
    [-AlertTime <Int32>]
    [-AlertTimeUnit <TimeUnitType>]
    [-AllowRestart <Boolean>]
    [-AllowSoftwareInstallationOutsideMaintenanceWindow <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-Architecture <ArchitectureType[]>]
    [-ArticleId <String[]>]
    [-AvailableImmediately <Boolean>]
    [-AvailableTime <Int32>]
    [-AvailableTimeUnit <TimeUnitType>]
    [-BulletinId <String[]>]
    [-CMTag <CMTagTypes[]>]
    [-ContentSize <String[]>]
    [-CustomSeverity <SeverityType[]>]
    [-DateReleasedOrRevised <DateReleasedOrRevisedType>]
    [-DeadlineImmediately <Boolean>]
    [-DeadlineTime <Int32>]
    [-DeadlineTimeUnit <TimeUnitType>]
    [-DeploymentPackage <IResultObject>]
    [-DeploymentPackageName <String>]
    [-DeploymentRing <DeploymentRing>]
    [-DeployWithoutLicense <Boolean>]
    [-Description <String>]
    [-DisableOperationManager <Boolean>]
    [-DownloadFromInternet <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-EnabledAfterCreate <Boolean>]
    [-GenerateFailureAlert <Boolean>]
    [-GenerateOperationManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-IsServicingPlan]
    [-Language <String[]>]
    [-LanguageSelection <String[]>]
    [-Location <String>]
    [-MicrosoftAsVendor <Boolean>]
    [-NoInstallOnRemote <Boolean>]
    [-NoInstallOnUnprotected <Boolean>]
    [-O365LanguageSelection <String[]>]
    [-Product <String[]>]
    [-Required <String[]>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RunType <RunType>]
    [-Schedule <IResultObject>]
    [-SendWakeupPacket <Boolean>]
    [-Severity <SeverityType[]>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SuccessPercentage <Int32>]
    [-Superseded <Boolean>]
    [-SuppressRestartServer <Boolean>]
    [-SuppressRestartWorkstation <Boolean>]
    [-Title <String[]>]
    [-UpdateClassification <String[]>]
    [-UpdateDeploymentWaitDay <Int32>]
    [-UpdateDescription <String[]>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-UseUtc <Boolean>]
    [-Vendor <String[]>]
    [-VerboseLevel <VerboseLevelType>]
    [-WriteFilterHandling <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByCollectionId

New-CMSoftwareUpdateAutoDeploymentRule
    -CollectionId <String>
    -Name <String>
    [-AddToExistingSoftwareUpdateGroup <Boolean>]
    [-AlertTime <Int32>]
    [-AlertTimeUnit <TimeUnitType>]
    [-AllowRestart <Boolean>]
    [-AllowSoftwareInstallationOutsideMaintenanceWindow <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-Architecture <ArchitectureType[]>]
    [-ArticleId <String[]>]
    [-AvailableImmediately <Boolean>]
    [-AvailableTime <Int32>]
    [-AvailableTimeUnit <TimeUnitType>]
    [-BulletinId <String[]>]
    [-CMTag <CMTagTypes[]>]
    [-ContentSize <String[]>]
    [-CustomSeverity <SeverityType[]>]
    [-DateReleasedOrRevised <DateReleasedOrRevisedType>]
    [-DeadlineImmediately <Boolean>]
    [-DeadlineTime <Int32>]
    [-DeadlineTimeUnit <TimeUnitType>]
    [-DeploymentPackage <IResultObject>]
    [-DeploymentPackageName <String>]
    [-DeploymentRing <DeploymentRing>]
    [-DeployWithoutLicense <Boolean>]
    [-Description <String>]
    [-DisableOperationManager <Boolean>]
    [-DownloadFromInternet <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-EnabledAfterCreate <Boolean>]
    [-GenerateFailureAlert <Boolean>]
    [-GenerateOperationManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-IsServicingPlan]
    [-Language <String[]>]
    [-LanguageSelection <String[]>]
    [-Location <String>]
    [-MicrosoftAsVendor <Boolean>]
    [-NoInstallOnRemote <Boolean>]
    [-NoInstallOnUnprotected <Boolean>]
    [-O365LanguageSelection <String[]>]
    [-Product <String[]>]
    [-Required <String[]>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RunType <RunType>]
    [-Schedule <IResultObject>]
    [-SendWakeupPacket <Boolean>]
    [-Severity <SeverityType[]>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SuccessPercentage <Int32>]
    [-Superseded <Boolean>]
    [-SuppressRestartServer <Boolean>]
    [-SuppressRestartWorkstation <Boolean>]
    [-Title <String[]>]
    [-UpdateClassification <String[]>]
    [-UpdateDeploymentWaitDay <Int32>]
    [-UpdateDescription <String[]>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-UseUtc <Boolean>]
    [-Vendor <String[]>]
    [-VerboseLevel <VerboseLevelType>]
    [-WriteFilterHandling <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByCollectionName

New-CMSoftwareUpdateAutoDeploymentRule
    -CollectionName <String>
    -Name <String>
    [-AddToExistingSoftwareUpdateGroup <Boolean>]
    [-AlertTime <Int32>]
    [-AlertTimeUnit <TimeUnitType>]
    [-AllowRestart <Boolean>]
    [-AllowSoftwareInstallationOutsideMaintenanceWindow <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-Architecture <ArchitectureType[]>]
    [-ArticleId <String[]>]
    [-AvailableImmediately <Boolean>]
    [-AvailableTime <Int32>]
    [-AvailableTimeUnit <TimeUnitType>]
    [-BulletinId <String[]>]
    [-CMTag <CMTagTypes[]>]
    [-ContentSize <String[]>]
    [-CustomSeverity <SeverityType[]>]
    [-DateReleasedOrRevised <DateReleasedOrRevisedType>]
    [-DeadlineImmediately <Boolean>]
    [-DeadlineTime <Int32>]
    [-DeadlineTimeUnit <TimeUnitType>]
    [-DeploymentPackage <IResultObject>]
    [-DeploymentPackageName <String>]
    [-DeploymentRing <DeploymentRing>]
    [-DeployWithoutLicense <Boolean>]
    [-Description <String>]
    [-DisableOperationManager <Boolean>]
    [-DownloadFromInternet <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-EnabledAfterCreate <Boolean>]
    [-GenerateFailureAlert <Boolean>]
    [-GenerateOperationManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-IsServicingPlan]
    [-Language <String[]>]
    [-LanguageSelection <String[]>]
    [-Location <String>]
    [-MicrosoftAsVendor <Boolean>]
    [-NoInstallOnRemote <Boolean>]
    [-NoInstallOnUnprotected <Boolean>]
    [-O365LanguageSelection <String[]>]
    [-Product <String[]>]
    [-Required <String[]>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RunType <RunType>]
    [-Schedule <IResultObject>]
    [-SendWakeupPacket <Boolean>]
    [-Severity <SeverityType[]>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SuccessPercentage <Int32>]
    [-Superseded <Boolean>]
    [-SuppressRestartServer <Boolean>]
    [-SuppressRestartWorkstation <Boolean>]
    [-Title <String[]>]
    [-UpdateClassification <String[]>]
    [-UpdateDeploymentWaitDay <Int32>]
    [-UpdateDescription <String[]>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-UseUtc <Boolean>]
    [-Vendor <String[]>]
    [-VerboseLevel <VerboseLevelType>]
    [-WriteFilterHandling <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-CMSoftwareUpdateAutoDeploymentRule cmdlet creates a automatic deployment rule (ADR) for software updates. When a rule runs, Configuration Manager adds updates that qualify for the rule to a software update group. The Configuration Manager server downloads content files and copies them to distribution points, and then updates client computers. For more information, see Automatically deploy software updates.

Note

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

Examples

Example 1: Create a basic ADR

This command creates a deployment rule named DeploymentRule07 for the collection named Desktops and the deployment package named Updates123. The rule deploys updates that have an article ID that contains 117.

New-CMSoftwareUpdateAutoDeploymentRule -CollectionName "Desktops" -DeploymentPackageName "Updates123" -Name "DeploymentRule07" -ArticleId "117"

Example 2: Create an ADR that uses a schedule and other properties

This example creates an automatic deployment rule that uses a defined schedule. The deployment occurs according to the schedule.

The first command creates a schedule for Wednesday, and stores the schedule object in the $Schedule variable. For more information, see New-CMSchedule.

The second command creates an automatic deployment rule for updates that uses the schedule object stored in the variable. This command specifies values for many parameters.

$Schedule = New-CMSchedule -DayOfWeek Wednesday

New-CMSoftwareUpdateAutoDeploymentRule -CollectionName "Laptops" -DeploymentPackageName "Updates235" -Name "DeploymentRule22" -AddToExistingSoftwareUpdateGroup $False -AlertTime 4 -AlertTimeUnit Weeks -AllowRestart $True -AllowSoftwareInstallationOutsideMaintenanceWindow $True -AllowUseMeteredNetwork $True -ArticleId "test" -AvailableImmediately $False -AvailableTime 5 -AvailableTimeUnit Months -CustomSeverity Critical -DateReleasedOrRevised Last1day -DeadlineImmediately $False -DeadlineTime $True -DeadlineTimeUnit Hours -DeployWithoutLicense $True -Description "Standard updates for our laptop systems." -DisableOperationManager $True -DownloadFromInternet $False -DownloadFromMicrosoftUpdate $True -EnabledAfterCreate $False -GenerateOperationManagerAlert $True -GenerateSuccessAlert $True -Location "\\k\aS_O15_Client_Dev_1" -NoInstallOnRemote $False -NoInstallOnUnprotected $True -RunType RunTheRuleOnSchedule -Schedule $Schedule -SendWakeUpPacket $True -SuccessPercent 99 -Superseded $True -SuppressRestartServer $True -SuppressRestartWorkstation $True -UpdateClassification "Critical Updates" -UseBranchCache $False -UserNotification DisplayAll -UseUtc $True -VerboseLevel AllMessages -WriteFilterHandling $True

Example 3: Create an ADR for multiple languages

This example creates an ADR that adds the Language criteria for three languages: English, Hungarian, and Chinese (Simplified, PRC). It also adds these languages for the Windows and Office 365 update binaries to download. This example rule is disabled by default.

New-CMSoftwareUpdateAutoDeploymentRule -Name "Multi-language ADR" -CollectionId "XYZ0003F" -Language "English","Hungarian","Chinese (Simplified, PRC)" -Enable $false -EnabledAfterCreate $false -RunType DoNotRunThisRuleAutomatically -LanguageSelection "English","Hungarian","Chinese (Simplified, PRC)" -O365LanguageSelection "English (United States)","Hungarian (Hungary)","Chinese (Simplified, PRC)"

Parameters

-AddToExistingSoftwareUpdateGroup

Indicates whether the rule adds to an existing software update group.

  • If this value is $True, each time the rule runs and finds new updates, it adds them to an existing update group.
  • If this value is $False, it creates a new update group.

Specify the existing update group or assign a name for the new update group by using the -DeploymentPackageName parameter.

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

-AlertTime

Specifies an integer offset from an update deployment deadline. The rule uses this value to specify when the rule generates alerts. Specify a time unit by using the -AlertTimeUnit parameter.

Parameter properties

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

Parameter sets

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

-AlertTimeUnit

Specifies a unit of time for the -AlertTime parameter.

Parameter properties

Type:TimeUnitType
Default value:None
Accepted values:Hours, Days, Weeks, Months
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

-AllowRestart

Indicates whether to allow a computer to restart if the update deployment takes place outside of a maintenance window. A maintenance window is a specified period of time used for computer maintenance and updates.

  • If this value is $True, Configuration Manager restarts the computer, if necessary, to complete the update.
  • If this value is $False, Configuration Manager doesn't restart the computer.

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

-AllowSoftwareInstallationOutsideMaintenanceWindow

Indicates whether the update deployment takes place even if scheduled outside of a maintenance window. A maintenance window is a specified period of time used for computer maintenance and updates.

  • If this value is $True, Configuration Manager deploys the update even the scheduled time falls outside the service window.
  • If this value is $False, Configuration Manager doesn't deploy the update outside the service window. It waits until it can deploy in a service window.

Parameter properties

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

Parameter sets

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

-AllowUseMeteredNetwork

Indicates whether to allow clients to download content over a metered internet connection after the deadline, which may incur additional expense.

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

-Architecture

Use this parameter to set the Architecture property filter on the Software Updates page of the ADR properties.

Parameter properties

Type:

ArchitectureType[]

Default value:None
Accepted values:Arm64, Itanium, X64, X86
Supports wildcards:False
DontShow:False
Aliases:Architectures

Parameter sets

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

-ArticleId

Specifies an array of criteria, as strings, for software updates. The rule adds software updates that have article IDs that meet specified criteria to the software update 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

-AvailableImmediately

Indicates whether this rule deploys updates as soon as the updates become available. If you select a value of $False, use the -AvailableTime and -AvailableTimeUnit parameters to specify how long after the rule runs to deploy the updates.

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

-AvailableTime

Specifies a period of time as an integer. Configuration Manager deploys the updates this long after the rule runs. Specify a time unit by using the -AvailableTimeUnit parameter.

Parameter properties

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

Parameter sets

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

-AvailableTimeUnit

Specifies a unit of time for the -AvailableTime parameter.

Parameter properties

Type:TimeUnitType
Default value:None
Accepted values:Hours, Days, Weeks, Months
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

-BulletinId

Specifies an array of criteria, as strings, for software updates. The rule adds software updates that have bulletin IDs that meet specified criteria to the software update 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

-CMTag

This property is reserved for future use.

Parameter properties

Type:

CMTagTypes[]

Default value:None
Accepted values:None, UUP
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 the automatic deployment rule.

Parameter properties

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

Parameter sets

NewByCollection
Position:Named
Mandatory:True
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 the automatic deployment rule.

Parameter properties

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

Parameter sets

NewByCollectionId
Position:Named
Mandatory:True
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 the automatic deployment rule.

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

Parameter sets

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

-ContentSize

Use this parameter to set the Content Size (KB) property filter on the Software Updates page of the ADR properties.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:ContentSizes

Parameter sets

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

-CustomSeverity

Specifies an array of custom severity types for software updates. The rule adds software updates that have custom severity levels that meet specified criteria to the software update group.

Parameter properties

Type:

SeverityType[]

Default value:None
Accepted values:None, Low, Moderate, Important, Critical
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

-DateReleasedOrRevised

Specifies a date released or revised for software updates. The rule adds software updates that have a date that meets specified criteria to the software update group.

Parameter properties

Type:DateReleasedOrRevisedType
Default value:None
Accepted values:Any, Last1Hour, LastHour, Last2Hours, Last3Hours, Last4Hours, Last8Hours, Last12Hours, Last16Hours, Last20Hours, Last1Day, LastDay, Last2Days, Last3Days, Last4Days, Last5Days, Last6Days, Last7Days, Last14Days, Last21Days, Last28Days, LastMonth, Last1Month, Last2Months, Last3Months, Last4Months, Last5Months, Last6Months, Last7Months, Last8Months, Last9Months, Last10Months, Last11Months, Last1Year, LastYear, Last12Months
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

-DeadlineImmediately

Indicates whether to impose the deadline as soon as the rule runs. If you specify a value of $False, use the -DeadlineTime and -DeadlineTimeUnit parameters to specify how long after the rule runs to set the deadline. After the deadline, Configuration Manager installs required updates.

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

-DeadlineTime

Specifies a period of time as an integer. The deadline for updates is this long after the rule runs. Specify a time unit by using the -DeadlineTimeUnit parameter.

Parameter properties

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

Parameter sets

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

-DeadlineTimeUnit

Specifies a unit of time for the -DeadlineTime parameter.

Parameter properties

Type:TimeUnitType
Default value:None
Accepted values:Hours, Days, Weeks, Months
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

-DeploymentPackage

Use this parameter to specify an object for the deployment package to use with this automatic deployment rule. To not require a package, set the value to $null.

Parameter properties

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

Parameter sets

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

-DeploymentPackageName

Specify the name of the deployment package to use with this automatic deployment rule. To not require a package, set the value to $null.

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

-DeploymentRing

The New-CMSoftwareUpdateAutoDeploymentRule cmdlet creates a automatic deployment rule (ADR) for software updates. When a rule runs, Configuration Manager adds updates that qualify for the rule to a software update group. The Configuration Manager server downloads content files and copies them to distribution points, and then updates client computers. For more information, see Automatically deploy software updates.

Note

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

Parameter properties

Type:DeploymentRing
Default value:None
Accepted values:CB, Release, BusinessMainstream, Cbb, Ltsb
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

-DeployWithoutLicense

Indicates whether the rule deploys updates without licenses.

  • If you specify a value of $True, Configuration Manager deploys all updates for this rule and approves any license agreements.
  • If this value is $False, Configuration Manager deploys only updates that don't include a license or for which the license agreement has been approved.

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

-Description

Specifies a description for the automatic deployment rule for software updates.

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

-DisableOperationManager

Indicates whether to disable System Center Operations Manager alerts during software updates.

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

-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

-DownloadFromInternet

Indicates whether computers download software updates from the internet. If you specify a value of $False, specify an alternative ___location where computers can download updates by using the -Location parameter.

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

-DownloadFromMicrosoftUpdate

Indicates whether computers download content from Microsoft Update if that content is unavailable on a preferred distribution point of remote distribution point.

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

-Enable

Specify whether the automatic deployment rule is enabled after you create it.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Enabled, EnableDeployment

Parameter sets

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

-EnabledAfterCreate

Indicates whether to enable software deployment for the associated software update group after this rule runs. If this value is $False, deploy the software update group manually.

Parameter properties

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

Parameter sets

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

-ForceWildcardHandling

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

Parameter properties

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

Parameter sets

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

-GenerateFailureAlert

If the rule fails, create a Configuration Manager alert.

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

-GenerateOperationManagerAlert

Indicates whether to generate Operations Manager alerts during a software update.

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

-GenerateSuccessAlert

Indicates whether to generate an alert for successful deployment.

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

-IsServicingPlan

The New-CMSoftwareUpdateAutoDeploymentRule cmdlet creates a automatic deployment rule (ADR) for software updates. When a rule runs, Configuration Manager adds updates that qualify for the rule to a software update group. The Configuration Manager server downloads content files and copies them to distribution points, and then updates client computers. For more information, see Automatically deploy software updates.

Note

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

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

-Language

Specify a string array of language criteria for software updates. The rule adds software updates that have languages that meet specified criteria to the software update group.

Use the format of the language as displayed in the console. For example:

  • English
  • Hungarian
  • Chinese (Simplified, PRC)

The format for the string array is: "English","Hungarian","Chinese (Simplified, PRC)"

Tip

If you run this cmdlet on a computer where Windows has a localized UI, the language names may be different. For example, the English version of Windows uses "Danish", but the Danish version of Windows uses "Dansk".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Languages, UpdateLocales, UpdateLocale

Parameter sets

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

-LanguageSelection

Specify a string array of languages. Clients download software updates available in the specified languages, and language-neutral updates.

Use the format of the language as displayed in the console. For example:

  • English
  • Hungarian
  • Chinese (Simplified, PRC)

The format for the string array is: "English","Hungarian","Chinese (Simplified, PRC)"

Tip

If you run this cmdlet on a computer where Windows has a localized UI, the language names may be different. For example, the English version of Windows uses "Danish", but the Danish version of Windows uses "Dansk".

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

-Location

Specifies a ___location in your network where computers can download software updates. In order to use this ___location, specify a value of $False for the -DownloadFromInternet parameter.

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

-MicrosoftAsVendor

Indicates whether the rule includes only updates that have Microsoft as the vendor.

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

-Name

Specifies a name for the automatic deployment rule for software updates.

Parameter properties

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

Parameter sets

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

-NoInstallOnRemote

Indicates whether to disallow installation of updates on remote systems.

  • If you specify a value of $True, if the client is within a slow or unreliable network boundary, or when the client uses a fallback source ___location for content, then Configuration Manager doesn't install software updates.
  • If you specify a value of $False, installation proceeds.

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

-NoInstallOnUnprotected

Indicates whether to disallow installation of updates on unprotected systems.

  • If you specify a value of $True, if software updates aren't available on any preferred distribution points, Configuration Manager doesn't download and install software updates.
  • If you specify a value of $False, installation proceeds.

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

-O365LanguageSelection

Use this parameter to set the Office 365 Client Update language selection. Specify a string array of languages. Clients download software updates available in the specified languages, and language-neutral updates.

Use the format of the language as displayed in the console for the Windows Update language selection. This format is the same as the with the LanguageSelection parameter. For example:

  • English
  • Hungarian
  • Chinese (Simplified, PRC)

The format for the string array is: "English","Hungarian","Chinese (Simplified, PRC)"

Tip

If you run this cmdlet on a computer where Windows has a localized UI, the language names may be different. For example, the English version of Windows uses "Danish", but the Danish version of Windows uses "Dansk".

You currently can't specify with this parameter all of the languages that are available in the Configuration Manager console. For example, you can't specify "Irish (Ireland)" or "Maltese (Malta)".

Starting in version 2103, you need to specify a language with a country/region name. This change aligns this parameter with the options in the Configuration Manager console. For example, -O365LanguageSelection "English (United States)"

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

-Product

Specifies an array of criteria, as strings, for software updates. The rule adds software updates for products that meet specified criteria to the software update group.

Starting in version 2107, when there are multiple products with the same name, it selects all of them.

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

-Required

Specifies an array of criteria, as strings, for software updates. The rule adds software updates identified by required that meet specified criteria to the software update 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

-RequirePostRebootFullScan

Use this parameter to set the following option on the User Experience page of the ADR deployment settings: 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
Aliases:RunEvaluationAfterRestart

Parameter sets

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

-RunType

Specify the recurring schedule for when the site evaluates the ADR.

If you specify RunTheRuleOnSchedule, specify a schedule by using the -Schedule parameter.

Parameter properties

Type:RunType
Default value:None
Accepted values:DoNotRunThisRuleAutomatically, RunTheRuleAfterAnySoftwareUpdatePointSynchronization, RunTheRuleOnSchedule
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

-Schedule

Specifies a schedule object for the deployment. To obtain a schedule object, use the New-CMSchedule cmdlet. Specify a schedule for this parameter if you specify a value of RunTheRuleOnSchedule for the -RunType parameter.

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

-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, you must first configure Wake On LAN.

Parameter properties

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

Parameter sets

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

-Severity

Specifies an array of severity levels for software updates. The rule adds software updates for specified severity types to the software update group.

Parameter properties

Type:

SeverityType[]

Default value:None
Accepted values:None, Low, Moderate, Important, Critical
Supports wildcards:False
DontShow:False
Aliases:Severities

Parameter sets

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

-SoftDeadlineEnabled

Use this parameter to set the following option on the Deployment Schedule page of the ADR deployment settings: Delay enforcement of this deployment according to user preferences, up to the grace period defined in client settings.

Parameter properties

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

Parameter sets

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

-SuccessPercentage

Specifies a percentage for client compliance as an integer from 0 to 99. If compliance falls below this percentage, Configuration Manager produces optional alerts.

Parameter properties

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

Parameter sets

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

-Superseded

Indicates whether the rule adds updates superseded by other updates.

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

-SuppressRestartServer

Indicates whether to suppress a required update for a server. Some software updates require a system restart to complete the installation process.

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

-SuppressRestartWorkstation

Indicates whether to suppress a required update for a workstation. Some software updates require a system restart to complete the installation process.

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

-Title

Specifies an array of criteria, as strings, for software updates. The rule adds software updates that have titles that meet specified criteria to the software update group.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Titles

Parameter sets

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

-UpdateClassification

Specifies an array of criteria, as strings, for software updates. The rule adds software updates that have update classifications that meet specified criteria to the software update group.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:UpdateClassifications

Parameter sets

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

-UpdateDeploymentWaitDay

The New-CMSoftwareUpdateAutoDeploymentRule cmdlet creates a automatic deployment rule (ADR) for software updates. When a rule runs, Configuration Manager adds updates that qualify for the rule to a software update group. The Configuration Manager server downloads content files and copies them to distribution points, and then updates client computers. For more information, see Automatically deploy software updates.

Note

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

Parameter properties

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

Parameter sets

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

-UpdateDescription

Specifies an array of criteria, as strings, for software updates. The rule adds software updates that have update descriptions that meet specified criteria to the software update 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

-UseBranchCache

Indicates whether to use Windows BranchCache for this update deployment. If you specify a value of $True, clients share content on the same subnet.

Parameter properties

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

Parameter sets

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

-UserNotification

Specifies the type of user notification.

  • DisplayAll: Display in Software Center and show all notifications.
  • DisplaySoftwareCenterOnly: Display in Software Center, and only show notifications of computer restarts.
  • HideAll: 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

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

-UseUtc

Indicates whether to use Coordinated Universal Time (UTC).

  • If this value is $True, Configuration Manager uses UTC for this deployment.
  • If this value is $False, Configuration Manager uses local time.

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

-Vendor

The New-CMSoftwareUpdateAutoDeploymentRule cmdlet creates a automatic deployment rule (ADR) for software updates. When a rule runs, Configuration Manager adds updates that qualify for the rule to a software update group. The Configuration Manager server downloads content files and copies them to distribution points, and then updates client computers. For more information, see Automatically deploy software updates.

Note

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Vendors

Parameter sets

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

-VerboseLevel

Specifies the level of detail you want clients to report for deployments that this rule creates.

Parameter properties

Type:VerboseLevelType
Default value:None
Accepted values:OnlyErrorMessages, OnlySuccessAndErrorMessages, AllMessages
Supports wildcards:False
DontShow:False

Parameter sets

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

-WhatIf

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

Parameter properties

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

Parameter sets

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

-WriteFilterHandling

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.

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

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

IResultObject

Notes

For more information on this return object and its properties, see SMS_AutoDeployment server WMI class.