The Set-CMClientSetting cmdlet changes client settings for Configuration Manager devices and users. Configuration Manager provides default values for all client settings, but you can use this cmdlet to modify settings objects. Settings objects determine settings for individual clients. For more information, see About client settings.
Important
Starting in version 2010, this cmdlet is deprecated. Use one of the cmdlets specific to the client settings group, listed in the Related links.
To modify a client setting, specify it by name.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Rename a client setting
This command renames the client setting object. The new name is Client Settings TSQA. The command also adds a description for the client setting object.
This command configures user affinity settings for a client setting named TSQA03:
It disables auto approval of affinity.
It sets the UserAffinityLogOnThresholdMinutes parameter to 2800 minutes and the UserAffinityUsageThresholdDays parameter to 20 days. If a user uses a device for 2800 minutes over a period of 20 days, Configuration Manager creates a user device affinity.
This command changes settings for the client settings object named TSQA09:
Specifies a portal and adds that portal to the trusted site list and allows it to have elevated trust.
Specifies a branding title, Contoso IT.
Enables third party orchestration.
Sets final reminder and initial reminder intervals.
Specifies that only administrators can install software, selects Bypass as the Windows PowerShell execution policy, and suspends a BitLocker PIN requirement.
This command sets restart logoff notification countdown duration and logoff notification final window duration for a client setting object named TSQA11.
Indicates whether the client automatically configures user device affinity from usage data.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-BatchingTimeout
Specifies a timeout value, as an integer.
Specify a value of Hours or Days by using the TimeUnit parameter.
When an update deadline passes, Configuration Manager deploys all updates pending within this period.
Type:
Int32
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Bits
Type:
SwitchParameter
Aliases:
BitsSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-BrandingTitle
Specifies a Configuration Manager branding title.
This branding information helps users identify Configuration Manager as a trusted source.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ClientPolicy
Type:
SwitchParameter
Aliases:
ClientPolicySettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-CloudService
Type:
SwitchParameter
Aliases:
CloudServicesSettings, CloudServices
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-Compliance
Type:
SwitchParameter
Aliases:
ComplianceSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-ComputerAgent
Type:
SwitchParameter
Aliases:
ComputerAgentSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-ComputerRestart
Type:
SwitchParameter
Aliases:
ComputerRestartSettings
Position:
Named
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:
False
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DeploymentEvaluationSchedule
Specifies a deployment evaluation schedule as a schedule object.
To obtain a schedule object, use the New-CMSchedule cmdlet.
Type:
IResultObject
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Description
Specifies a description for client settings.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DisableFirstSignatureUpdate
Indicates whether to disable the first signature update on client from a remote source.
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
-DisplayNewProgramNotification
Indicates whether Configuration Manager shows the user notifications for software availability or software installations.
If this parameter has a value of $False, the user sees only restart notifications.
Specifies whether to enable maximum bandwidth for Background Intelligent Transfer Service (BITS) background transfers.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableComplianceEvaluation
Indicates whether to enable compliance evaluation for this client.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableDownloadOffSchedule
Specifies whether allow BITS downloads outside of a throttling window.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableThirdPartyOrchestration
Specifies whether Software Updates and Software Distribution agents wait for third-party software to install updates and applications.
Valid values are: Yes and No.
Type:
EnableThirdPartyOrchestrationType
Accepted values:
No, Yes
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableUserDataAndProfile
Indicates whether to enable user data and profile settings.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableUserPolicy
Type:
Boolean
Aliases:
EnableUserPolicyPolling
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableUserPolicyOnInternet
Indicates whether users receive a user policy when logged on to a computer on the Internet.
In order for users to receive user policy, you must enable user polling.
You can use the EnableUserPolicyPolling parameter to enable user polling.
An Internet-based management point must authenticate the user.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableUserPolicyOnTS
Use this parameter to enable or disable the client setting, Enable user policy for multiple user sessions.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableWakeupProxy
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EndpointProtection
Type:
SwitchParameter
Aliases:
EndpointProtectionSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-EnforceMandatory
Indicates whether to enforce all mandatory software update deployments that have deadlines within a specified period of time.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Enrollment
Type:
SwitchParameter
Aliases:
EnrollmentSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-EnrollmentProfileName
Type:
String
Aliases:
DeviceEnrollmentProfileName
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-FinalReminderMins
Type:
Int32
Aliases:
FinalReminderMinutesInterval
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-FirewallExceptionForWakeupProxy
Type:
WakeUpProxyFirewallExceptionTypes
Aliases:
WindowsFirewallExceptionsForWakeUpProxy
Accepted values:
None, Public, Private, Domain
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-FirewallExceptionProfile
Specifies a firewall exception profile.
Valid values are:
Disabled
Domain
Private
Public
Type:
FirewallExceptionProfileType[]
Accepted values:
Disabled, Public, Private, Domain
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ForceRebootHr
Type:
Int32
Aliases:
ForceRebootPeriod, ForceRebootHours
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ForceScan
Indicates whether to enable force scan.
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 (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
-GrantRemoteControlPermissionToLocalAdministrator
Indicates whether local administrators on the server initiating a remote control connection can establish remote control sessions to this client.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-HardwareInventory
Type:
SwitchParameter
Aliases:
HardwareInventorySettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-InitialReminderHours
Type:
Int32
Aliases:
InitialReminderHoursInterval
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-InstallEndpointProtectionClient
Indicates whether to install and enable the Endpoint Protection client on this client if it is not already installed.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-InstallRestriction
Specifies which users can initiate an install.
Valid values are:
Indicates whether to allow Configuration Manager to manage Remote Desktop sessions for computers.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ManageSolicitedRemoteAssistance
Indicates whether to allow Configuration Manager to manage solicited remote assistance sessions.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ManageUnsolicitedRemoteAssistance
Indicates whether to allow Configuration Manager to manage unsolicited remote assistance sessions.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MaxBandwidthBeginHr
Type:
Int32
Aliases:
MaxBandwidthValidFrom
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MaxBandwidthEndHr
Type:
Int32
Aliases:
MaxBandwidthValidTo
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MaxTransferRateOffSchedule
Specifies an integer value for maximum transfer rate off schedule.
Type:
Int32
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MaxTransferRateOnSchedule
Specifies an integer value for maximum transfer rate on schedule.
Type:
Int32
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MeteredNetwork
Type:
SwitchParameter
Aliases:
MeteredNetworkSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-MeteredNetworkUsage
Specifies a type of metered network usage to allow.
Valid values are:
Allow
Block
Limit
None
Type:
MeteredNetworkUsageType
Accepted values:
None, Allow, Limit, Block
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Name
Specifies a name for a client setting.
Type:
String
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-NetworkAccessProtection
Type:
SwitchParameter
Aliases:
NetworkAccessProtectionSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-NewName
Specifies a new name for a client setting.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-NoRebootEnforcement
Applies to version 2006 and later. Configure the client setting Configuration Manager can force a device to restart to prevent devices from automatically restarting when a deployment requires it. By default, Configuration Manager can still force devices to restart. For more information, see device restart notifications.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Type:
SwitchParameter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PermittedViewer
Specifies an array of names of users who can establish remote control sessions to a client computer.
Type:
String[]
Aliases:
PermittedViewers
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PolicyPollingMins
Type:
Int32
Aliases:
PolicyPollingInterval, PollingIntervalMins
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PortalUrl
Specifies a link, as a URL, for a portal for a client.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PowerManagement
Type:
SwitchParameter
Aliases:
PowerManagementSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-PowerShellExecutionPolicy
Specifies how Configuration Manager runs Windows PowerShell scripts on remote computers.
Valid values are
AllSigned
Bypass
Restricted
The default value is Restricted.
When you select Restricted, the Configuration Manager client uses the current Windows PowerShell configuration on the client computer, which determines whether unsigned scripts run.
Type:
PowerShellExecutionPolicyType
Accepted values:
AllSigned, Bypass, Restricted
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Priority
Specifies a priority change for a client setting.
Valid values are: Decrease and Increase.
Type:
PriorityChangeType
Accepted values:
Increase, Decrease
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PromptUserForPermission
Indicates whether a client computer displays a message asking for user permission before it allows a remote control session.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-RebootLogoffNotificationCountdownMins
Type:
Int32
Aliases:
RebootLogoffNotificationCountdownDurationMinutes
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-RebootLogoffNotificationFinalWindowMins
Type:
Int32
Aliases:
RebootLogoffNotificationFinalWindowMinutes
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-RemoteAssistanceAccessLevel
Specifies a level of access to assign to remote assistance sessions initiated in Configuration Manager.
A user at the client computer always grants permission for a remote assistance session to occur.
Valid values are:
FullControl
None
RemoteViewing
Type:
RemoteAssistanceAccessLevelType
Accepted values:
None, RemoteViewing, FullControl
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-RemoteControl
Type:
SwitchParameter
Aliases:
RemoteToolsSettings, RemoteTools
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-RemoveThirdParty
Indicates whether to remove third party.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ReplaceToastNotificationWithDialog
Specify whether to replace toast notifications with a more intrusive dialog window when a deployment requires a restart. It's an optional parameter and false by default.
Don't use this parameter. The application catalog is no longer supported.
Type:
ApplicationCatalogWebsitePointType
Accepted values:
Fqdn, AutoDetect, NetBios
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ShowNotificationIconOnTaskbar
Indicates whether to display an icon on the taskbar of a client computer to indicate an active remote control session.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ShowSessionConnectionBar
Indicates whether to display a high-visibility session connection bar on a client computer to specify an active remote control session.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareDeployment
Type:
SwitchParameter
Aliases:
SoftwareDeploymentSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareInventory
Type:
SwitchParameter
Aliases:
SoftwareInventorySettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareInventoryFileDisplayName
Specifies the display name to use in place of an inventoried name specified by the SoftwareInventoryFileInventoriedName parameter.
This parameter allows you to standardize inventory information for software names that differ in different file headers.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareInventoryFileInventoriedName
Specifies an inventoried manufacturer or product name.
During software inventory, Configuration Manager gets inventoried names from header information on client devices.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareInventoryFileName
Specifies a name for the file you want to collect during inventory.
You can use the wildcard (*) to represent any string of text and the question mark (?) to represent any single character.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareMetering
Type:
SwitchParameter
Aliases:
SoftwareMeteringSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-SoftwareUpdate
Type:
SwitchParameter
Aliases:
SoftwareUpdatesSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-StateMessage
Type:
SwitchParameter
Aliases:
StateMessageSettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-SuppressReboot
Indicates whether to bypass a required computer restart after installing the System Center 2016 Endpoint Protection client.
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SuspendBitLocker
Specifies whether to bypass a required BitLocker Drive Encryption PIN entry when a computer restarts after a software installation.
This setting applies only when Configuration Manager initiates a restart.
Valid values are:
Always.
Configuration Manager temporarily suspends the BitLocker requirement to enter a PIN.
Never.
Configuration Manager does not suspend the BitLocker requirement to enter a PIN on the next computer startup after it has installed software that requires a restart.
If you select Never, the software installation cannot finish until the user enters the PIN to complete the standard startup process.
Type:
SuspendBitLockerType
Accepted values:
Never, Always
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-TimeUnit
Specifies the unit for the value specified in the BatchingTimeout parameter.
Valid values are: Hours and Days.
Type:
BatchingTimeoutType
Accepted values:
Days, Hours
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-UsageThresholdDays
Type:
Int32
Aliases:
UserAffinityUsageThresholdDays
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-UseNewSoftwareCenter
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-UserDeviceAffinity
Type:
SwitchParameter
Aliases:
UserDeviceAffinitySettings
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-UseUtcForEvaluationTime
Indicates whether to use Coordinated Universal Time (UTC), also known as Greenwich Mean Time, to configure a recurring interval.
If you specify $False, Configuration Manager uses local time.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.