Edit

Share via


Set-CMClientSettingSoftwareUpdate

Configure client settings for software updates.

Syntax

SetCustomSettingByName (Default)

Set-CMClientSettingSoftwareUpdate
    -Name <String>
    [-BatchingTimeout <Int32>]
    [-DeltaDownloadPort <Int32>]
    [-DeploymentEvaluationSchedule <IResultObject>]
    [-Enable <Boolean>]
    [-EnableDeltaDownload <Boolean>]
    [-EnableDynamicUpdate <Boolean>]
    [-EnableInstallation <Boolean>]
    [-EnableThirdPartyUpdates <Boolean>]
    [-EnableWsusCertPinning <Boolean>]
    [-EnforceMandatory <Boolean>]
    [-Office365ManagementType <Boolean>]
    [-ScanSchedule <IResultObject>]
    [-ThreadPriority <ThreadPriorityType>]
    [-TimeUnit <BatchingTimeoutType>]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetDefaultSetting

Set-CMClientSettingSoftwareUpdate
    [-BatchingTimeout <Int32>]
    [-DeltaDownloadPort <Int32>]
    [-DeploymentEvaluationSchedule <IResultObject>]
    [-Enable <Boolean>]
    [-EnableDeltaDownload <Boolean>]
    [-EnableDynamicUpdate <Boolean>]
    [-EnableInstallation <Boolean>]
    [-EnableThirdPartyUpdates <Boolean>]
    [-EnableWsusCertPinning <Boolean>]
    [-EnforceMandatory <Boolean>]
    [-Office365ManagementType <Boolean>]
    [-ScanSchedule <IResultObject>]
    [-ThreadPriority <ThreadPriorityType>]
    [-TimeUnit <BatchingTimeoutType>]
    [-DefaultSetting]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetCustomSettingByValue

Set-CMClientSettingSoftwareUpdate
    -InputObject <IResultObject>
    [-BatchingTimeout <Int32>]
    [-DeltaDownloadPort <Int32>]
    [-DeploymentEvaluationSchedule <IResultObject>]
    [-Enable <Boolean>]
    [-EnableDeltaDownload <Boolean>]
    [-EnableDynamicUpdate <Boolean>]
    [-EnableInstallation <Boolean>]
    [-EnableThirdPartyUpdates <Boolean>]
    [-EnableWsusCertPinning <Boolean>]
    [-EnforceMandatory <Boolean>]
    [-Office365ManagementType <Boolean>]
    [-ScanSchedule <IResultObject>]
    [-ThreadPriority <ThreadPriorityType>]
    [-TimeUnit <BatchingTimeoutType>]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to configure settings in the Software updates group of client settings. For more information, see About client settings: 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: Enable third-party updates in the default client settings

Set-CMClientSettingSoftwareUpdate -DefaultSetting -Enable $true -EnableThirdPartyUpdates $true

Example 2: Enable third-party updates in a custom device setting

$clientDeviceSettingName = "Dev device settings"
Set-CMClientSettingSoftwareUpdate -Name $clientDeviceSettingName -Enable $true -EnableThirdPartyUpdates $true

Example 3: Configure multiple settings

Set-CMClientSettingSoftwareUpdate -InputObject $testsetting -Enable $true -ScanSchedule $Sch1 -DeploymentEvaluationSchedule $Sch2 -BatchingTimeout 3 -TimeUnit Days -EnforceMandatory $true -Office365ManagementType $false -EnableThirdPartyUpdates $true -EnableDeltaDownload $true -EnableInstallation $true -ThreadPriority Normal -EnableDynamicUpdate $true

Parameters

-BatchingTimeout

Specify the period of time for which all pending deployments with a deadline in this time will also be installed. Use this parameter with the EnforceMandatory parameter. You can enter a value from 1 to 23 hours, and from 1 to 365 days. By default, this setting is configured for seven days. Use the TimeUnit parameter to specify hours or days.

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

-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

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

-DefaultSetting

Add this parameter to configure software update settings in the default client settings.

Parameter properties

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

Parameter sets

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

-DeltaDownloadPort

Use this parameter to configure the network port that clients use to receive requests for delta content. Use the EnableDeltaDownload parameter to enable the behavior. The default value is 8005.

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

-DeploymentEvaluationSchedule

Specify how often the software updates client agent reevaluates software updates for installation status on Configuration Manager client computers. To create a new schedule token, use the New-CMSchedule cmdlet.

Parameter properties

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

Parameter sets

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

-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

-Enable

Set this parameter to $true to enable software updates on clients.

Parameter properties

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

Parameter sets

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

-EnableDeltaDownload

Set this parameter to $true to allow clients to download delta content when available. To configure the network port, use the DeltaDownloadPort 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

-EnableDynamicUpdate

Applies to version 2010 and later. Set this parameter to $true to enable dynamic update for Windows 10 feature updates. Dynamic update installs language packs, features on demand, drivers, and cumulative updates during Windows setup. It directs the client to download these updates from the internet.

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

-EnableInstallation

Applies to version 2010 and later. Set this parameter to $true to enable installation of software updates in the "All deployments" maintenance window when the "Software Update" maintenance window is available.

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

-EnableThirdPartyUpdates

Set this parameter to $true to enable third-party 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

-EnableWsusCertPinning

Applies to version 2107 and later. Set this parameter to $true to enforce TLS certificate pinning for Windows Update client for detecting 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

-EnforceMandatory

When any software update deployment deadline is reached, install all other software update deployments with deadline coming within a specified period of time. Use the BatchingTimeout parameter to specify the period of 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

-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

-InputObject

This cmdlet adds the software update settings to the client settings object that you specify with this parameter. To get this object, use the Get-CMClientSetting cmdlet.

Parameter properties

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

Parameter sets

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

-Name

This cmdlet adds the software update settings to the client settings object that this parameter names.

Parameter properties

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

Parameter sets

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

-Office365ManagementType

Set this parameter to $true to enable management of the Microsoft 365 Apps client agent and installation settings.

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

-PassThru

Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.

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

-ScanSchedule

Specify how often the software updates client agent starts a compliance assessment scan. This scan determines the state for software updates on the client. To create a new schedule token, use the New-CMSchedule cmdlet.

Parameter properties

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

Parameter sets

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

-ThreadPriority

Applies to version 2010 and later. Specify a thread priority for Windows 10 feature updates.

  • Normal: Windows Setup uses more system resources and updates faster. It uses more processor time, so the total installation time is shorter, but the user's outage is longer. This value is the default.

  • Low: You can continue to work on the device while it downloads and updates in the background. The total installation time is longer, but the user's outage is shorter. You may need to increase the update max run time to avoid a time-out when you use this option.

Parameter properties

Type:ThreadPriorityType
Default value:None
Accepted values:Normal, Low
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

-TimeUnit

Use with the BatchingTimeout parameter to specify the period of time for which all pending deployments with a deadline in this time will also be installed.

Parameter properties

Type:BatchingTimeoutType
Default value:None
Accepted values:Days, Hours
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 isn't run.

Parameter properties

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

Parameter sets

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object