Export (0) Print
Expand All
Expand Minimize

Set-CMClientSetting

Updated: September 1, 2013

Applies To: System Center 2012 Configuration Manager SP1

Set-CMClientSetting

Changes client settings for Configuration Manager devices and users.

Syntax

Parameter Set: SetBackgroundIntelligentTransfterSettingsByName
Set-CMClientSetting -Name <String> [-EnableBITSMaxBandwidth <Boolean> ] [-EnableDownloadOffSchedule <Boolean> ] [-MaxBandwidthValidFrom <Int32> ] [-MaxBandwidthValidTo <Int32> ] [-MaxTransferRateOffSchedule <Int32> ] [-MaxTransferRateOnSchedule <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByName
Set-CMClientSetting -Name <String> [-Description <String> ] [-NewName <String> ] [-Priority <PriorityChangeType> {Decrease | Increase} ] [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetClientPolicySettingsByName
Set-CMClientSetting -Name <String> [-EnableUserPolicyOnInternet <Boolean> ] [-EnableUserPolicyPolling <Boolean> ] [-PolicyPollingInterval <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetCloudSettingsByName
Set-CMClientSetting -Name <String> [-AllowCloudDistributionPoint <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetComplianceSettingsByName
Set-CMClientSetting -Name <String> [-EnableComplianceEvaluation <Boolean> ] [-EnableUserDataAndProfile <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetComputerAgentSettingsByName
Set-CMClientSetting -Name <String> [-AddPortalToTrustedSiteList <Boolean> ] [-AllowPortalToHaveElevatedTrust <Boolean> ] [-BrandingTitle <String> ] [-DisplayNewProgramNotification <Boolean> ] [-EnableThirdPartyOrchestration <EnableThirdPartyOrchestrationType> {No | Yes} ] [-FinalReminderMinutesInterval <Int32> ] [-InitialReminderHoursInterval <Int32> ] [-InstallRestriction <InstallRestrictionType> {AllUsers | NoUsers | OnlyAdministrators | OnlyAdministratorsAndPrimaryUsers} ] [-InterimReminderHoursInterval <Int32> ] [-PortalUrl <String> ] [-PowerShellExecutionPolicy <PowerShellExecutionPolicyType> {AllSigned | Bypass | Restricted} ] [-SuspendBitLocker <SuspendBitLockerType> {Always | Never} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetComputerRestartSettingsByName
Set-CMClientSetting -Name <String> [-RebootLogoffNotificationCountdownDurationMinutes <Int32> ] [-RebootLogoffNotificationFinalWindowMinutes <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetEndpointProtectionSettingsByName
Set-CMClientSetting -Name <String> [-DisableFirstSignatureUpdate <Boolean> ] [-EnableEndpointProtection <Boolean> ] [-ForceRebootPeriod <Int32> ] [-InstallEndpointProtectionClient <Boolean> ] [-RemoveThirdParty <Boolean> ] [-SuppressReboot <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetHardwareInventorySettingsByName
Set-CMClientSetting -Name <String> [-EnableHardwareInventory <Boolean> ] [-InventoryReportId <String> ] [-InventorySchedule <IResultObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetMeteredNetworksSettingsByName
Set-CMClientSetting -Name <String> [-MeteredNetworkUsage <MeteredNetworkUsageType> {Allow | Block | Limit | None} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetMobileDeviceSettingsByName
Set-CMClientSetting -Name <String> [-DeviceEnrollmentProfileName <String> ] [-EnableDeviceEnrollment <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetNetworkAccessProtectionSettingsByName
Set-CMClientSetting -Name <String> [-EnableNetworkAccessProtection <Boolean> ] [-ForceScan <Boolean> ] [-NapEvaluationSchedule <IResultObject> ] [-UseUtcForEvaluationTime <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetPowerManagementSettingsByName
Set-CMClientSetting -Name <String> [-AllowUserToOptOutFromPowerPlan <Boolean> ] [-EnablePowerManagement <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetRemoteToolsSettingsByName
Set-CMClientSetting -Name <String> [-AccessLevel <AccessLevelType> {FullControl | NoAccess | ViewOnly} ] [-AllowClientChange <Boolean> ] [-AllowPermittedViewersToRemoteDesktop <Boolean> ] [-AllowRemoteControlOfUnattendedComputer <Boolean> ] [-AudibleSignal <AudibleSignalType> {PlayNoSound | PlaySoundAtBeginAndEnd | PlaySoundRepeatedly} ] [-FirewallExceptionProfile {Disabled | Domain | Private | Public}[] ] [-GrantRemoteControlPermissionToLocalAdministrator <Boolean> ] [-ManageRemoteDesktopSetting <Boolean> ] [-ManageSolicitedRemoteAssistance <Boolean> ] [-ManageUnsolicitedRemoteAssistance <Boolean> ] [-PermittedViewer <String[]> ] [-PromptUserForPermission <Boolean> ] [-RemoteAssistanceAccessLevel <RemoteAssistanceAccessLevelType> {FullControl | None | RemoteViewing} ] [-RequireAuthentication <Boolean> ] [-ShowNotificationIconOnTaskbar <Boolean> ] [-ShowSessionConnectionBar <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByName
Set-CMClientSetting -Name <String> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSoftwareDeploymentSettingsByName
Set-CMClientSetting -Name <String> [-EvaluationSchedule <IResultObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSoftwareInventorySettingsByName
Set-CMClientSetting -Name <String> [-EnableSoftwareInventory <Boolean> ] [-SoftwareInventoryFileDisplayName <String> ] [-SoftwareInventoryFileInventoriedName <String> ] [-SoftwareInventoryFileName <String> ] [-SoftwareInventorySchedule <IResultObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSoftwareMeteringSettingsByName
Set-CMClientSetting -Name <String> [-DataCollectionSchedule <IResultObject> ] [-EnableSoftwareMetering <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSoftwareUpdatesSettingsByName
Set-CMClientSetting -Name <String> [-BatchingTimeout <Int32> ] [-DeploymentEvaluationSchedule <IResultObject> ] [-EnableSoftwareUpdatesOnClient <Boolean> ] [-EnforceMandatory <Boolean> ] [-ScanSchedule <IResultObject> ] [-TimeUnit <BatchingTimeoutType> {Days | Hours} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetStateMessagingSettingsByName
Set-CMClientSetting -Name <String> [-StateMessagingReportingCycleMinutes <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetUserDeviceAffinitySettingsByName
Set-CMClientSetting -Name <String> [-AllowUserAffinity <Boolean> ] [-AutoApproveAffinity <Boolean> ] [-UserAffinityLogOnThresholdMinutes <Int32> ] [-UserAffinityUsageThresholdDays <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-CMClientSetting cmdlet changes client settings for Microsoft System Center 2012 Configuration Manager devices and users. System Center 2012 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 about client settings, see the About Client Settings in Configuration Manager topic in the TechNet library at http://go.microsoft.com/fwlink/?LinkId=266226.

Client settings for devices include the following categories:

-- Client Policy
-- Computer Agent
-- Computer Restart
-- System Center 2012 Endpoint Protection
-- Hardware Inventory
-- Metered Internet Connections
-- Network Access Protection (NAP)
-- Power Options
-- Remote Tools
-- Software Deployment
-- Software Inventory
-- Software Updates
-- User and Device Affinity

Client settings for users include the following categories:

-- Mobile Devices
-- User and Device Affinity

To modify a client setting, specify it by name.

Parameters

-AccessLevel<AccessLevelType>

Specifies a level of allowed remote control access. Valid values for this parameter are:

-- FullControl
-- NoAccess
-- None
-- ViewOnly


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AddPortalToTrustedSiteList<Boolean>

Specifies whether to add the default Application Catalog website to the Internet Explorer trusted sites zone.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowClientChange<Boolean>

Specifies whether users can change policy or notification settings in Software Center.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowCloudDistributionPoint<Boolean>

Specifies whether a device or user can access content from a cloud-based distribution point.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowPermittedViewersToRemoteDesktop<Boolean>

Specifies whether to allow members of the remote tools Permitted viewers list to initiate remote desktop connections from the Configuration Manager console.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowPortalToHaveElevatedTrust<Boolean>

Specifies whether to allow a portal to have elevated trust.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowRemoteControlOfUnattendedComputer<Boolean>

Specifies whether to allow remote control of a computer with no user logged onto that computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowUserAffinity<Boolean>

Specifies whether the client automatically configures user device affinity from usage data.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AllowUserToOptOutFromPowerPlan<Boolean>

Specifies whether to allow users to exclude a device from power management settings.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AudibleSignal<AudibleSignalType>

Specifies what kind of sound a client computer plays while under remote control. This setting does not apply to remote assistance. Valid values for this parameter are:

-- None
-- PlayNoSound
-- PlaySoundAtBeginAndEnd
-- PlaySoundRepeatedly


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AutoApproveAffinity<Boolean>

Specifies whether users can define their primary devices.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-BatchingTimeout<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-BrandingTitle<String>

Specifies a Configuration Manager branding title. This branding information helps users identify Configuration Manager as a trusted source.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DataCollectionSchedule<IResultObject>

Specifies a data collection schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeploymentEvaluationSchedule<IResultObject>

Specifies a deployment evaluation schedule as a schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for client settings.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceEnrollmentProfileName<String>

Specifies a name for an enrollment profile for mobile devices. That profile contains information about the certificate template to use during the enrollment process, the site that contains an enrollment point and enrollment proxy point, and the site that manages a device after enrollment.

In order to specify a profile, provide a value of $True for the EnableDeviceEnrollment parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DisableFirstSignatureUpdate<Boolean>

Specifies whether to disable the first signature update on client from a remote source.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DisplayNewProgramNotification<Boolean>

Specifies 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableBITSMaxBandwidth<Boolean>

Specifies whether to enable maximum bandwidth for Background Intelligent Transfer Service (BITS) background transfers.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableComplianceEvaluation<Boolean>

Specifies whether to enable compliance evaluation for this client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableDeviceEnrollment<Boolean>

Specifies whether to allow users to enroll mobile devices.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableDownloadOffSchedule<Boolean>

Specifies whether allow BITS downloads outside of a throttling window.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableEndpointProtection<Boolean>

Specifies whether to manage existing Endpoint Protection clients. Specify a value of $True if you already installed an Endpoint Protection client and want to manage it with Configuration Manager.

Specify a value of $True if you want to create a script to uninstall an existing antimalware solution, install the Endpoint Protection client, and deploy this script by using a Configuration Manager application or package.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableHardwareInventory<Boolean>

Specifies whether to enable hardware inventory for a client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableNetworkAccessProtection<Boolean>

Specifies whether to enable NAP for a client. NAP requires a System Health Validator point for the Configuration Manager site in order to enforce policies or restrict access.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnablePowerManagement<Boolean>

Specifies whether to enable power management for a client. When enabled, the power management client agent sends information about power capabilities and usage to Configuration Manager. You can apply power management plans from Configuration Manager to clients.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableSoftwareInventory<Boolean>

Indicates whether to enable software inventory for a client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableSoftwareMetering<Boolean>

Specifies whether to enable software metering for a client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableSoftwareUpdatesOnClient<Boolean>

Indicates whether to enable software updates for a client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableThirdPartyOrchestration<EnableThirdPartyOrchestrationType>

Specifies whether Software Updates and Software Distribution agents wait for third-party software to install updates and applications.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableUserDataAndProfile<Boolean>

Specifies whether to enable user data and profile settings.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableUserPolicyOnInternet<Boolean>

Specifies 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableUserPolicyPolling<Boolean>

Specifies whether, when Configuration Manager discovers a user, Configuration Manager clients on computers receive applications and programs targeted for that user.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnforceMandatory<Boolean>

Indicates whether to enforce all mandatory software update deployments that have deadlines within a specified period of time.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EvaluationSchedule<IResultObject>

Specifies an evaluation schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FinalReminderMinutesInterval<Int32>

Specifies an interval, in minutes, between the final warning of a required restart and the restart. Some software updates require a computer restart. The computer warns the user before the computer restarts.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FirewallExceptionProfile<FirewallExceptionProfileType[]>

Specifies a firewall exception profile. Valid values for this parameter are:

-- Disabled
-- Domain
-- Private
-- Public


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForceRebootPeriod<Int32>

Specifies a period, in hours, between forced computer restarts.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForceScan<Boolean>

Specifies whether to enable force scan.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-GrantRemoteControlPermissionToLocalAdministrator<Boolean>

Specifies whether local administrators on the server initiating a remote control connection can establish remote control sessions to this client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InitialReminderHoursInterval<Int32>

Specifies an interval, in hours, for the initial reminder.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InstallEndpointProtectionClient<Boolean>

Specifies whether to install and enable the Endpoint Protection client on this client if it is not already installed.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InstallRestriction<InstallRestrictionType>

Specifies which users can initiate an install. Valid values for this parameter are:

-- AllUsers
-- NoUsers
-- OnlyAdministrators
-- OnlyAdministratorsAndPrimaryUsers


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InterimReminderHoursInterval<Int32>

Specifies an interval, in hours, for an interim reminder.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InventoryReportId<String>

Specifies an inventory report ID.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InventorySchedule<IResultObject>

Specifies an inventory schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ManageRemoteDesktopSetting<Boolean>

Specifies whether to allow Configuration Manager to manage Remote Desktop sessions for computers.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ManageSolicitedRemoteAssistance<Boolean>

Specifies whether to allow Configuration Manager to manage solicited remote assistance sessions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ManageUnsolicitedRemoteAssistance<Boolean>

Specifies whether to allow Configuration Manager to manage unsolicited remote assistance sessions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MaxBandwidthValidFrom<Int32>

Specifies an integer value for maximum bandwidth valid from.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MaxBandwidthValidTo<Int32>

Specifies an integer value for maximum bandwidth valid to.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MaxTransferRateOffSchedule<Int32>

Specifies an integer value for maximum transfer rate off schedule.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MaxTransferRateOnSchedule<Int32>

Specifies an integer value for maximum transfer rate on schedule.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MeteredNetworkUsage<MeteredNetworkUsageType>

Specifies a type of metered network usage to allow. Valid values for this parameter are:

-- Allow
-- Block
-- Limit
-- None


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a name for a client setting.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NapEvaluationSchedule<IResultObject>

Specifies a NAP evaluation schedule as a schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewName<String>

Specifies a new name for a client setting.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PermittedViewer<String[]>

Specifies an array of names of users who can establish remote control sessions to a client computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PolicyPollingInterval<Int32>

Specifies how frequently, in minutes, client computers download client policy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PortalUrl<String>

Specifies a URL for a portal for a client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PowerShellExecutionPolicy<PowerShellExecutionPolicyType>

Specifies how Configuration Manager runs Windows PowerShell scripts on remote computers. Valid values for this parameter 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Priority<PriorityChangeType>

Specifies a priority change for a client setting. Valid values for this parameter are Decrease and Increase.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PromptUserForPermission<Boolean>

Specifies whether a client computer displays a message asking for user permission before it allows a remote control session.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RebootLogoffNotificationCountdownDurationMinutes<Int32>

Specifies a length of time, in minutes, for a logoff notification countdown.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RebootLogoffNotificationFinalWindowMinutes<Int32>

Specifies a length of time, in minutes, for a logoff final notification window.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RemoteAssistanceAccessLevel<RemoteAssistanceAccessLevelType>

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 for this parameter are:

-- FullControl
-- None
-- RemoteViewing


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RemoveThirdParty<Boolean>

Specifies whether to remove third party.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RequireAuthentication<Boolean>

Specifies whether to use network-level authentication to establish Remote Desktop connections to a client computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ScanSchedule<IResultObject>

Specifies a scan schedule as a schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecuredScopeNames<String>

Specifies a name of security scope for a client setting.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecurityScopeAction<SecurityScopeActionType>

Specifies a security scope action. Valid values for this parameter are AddMembership and RemoveMembership.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecurityScopeName<String>

Specifies a name for a security scope. Use this parameter along with the SecurityScopeAction parameter to change which scopes a client setting belongs to.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ShowNotificationIconOnTaskbar<Boolean>

Specifies whether to display an icon on the taskbar of a client computer to indicate an active remote control session.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ShowSessionConnectionBar<Boolean>

Specifies whether to display a high-visibility session connection bar on a client computer to indicate an active remote control session.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SoftwareInventoryFileDisplayName<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SoftwareInventoryFileInventoriedName<String>

Specifies an inventoried manufacturer or product name. During software inventory, Configuration Manager retrieves inventoried names from header information on client devices.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SoftwareInventoryFileName<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SoftwareInventorySchedule<IResultObject>

Specifies an inventory schedule as a schedule object. To obtain a schedule object, use the New-CMSchedule cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StateMessagingReportingCycleMinutes<Int32>

Specifies a length of time, in minutes, for a reporting cycle for state messaging.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SuppressReboot<Boolean>

Specifies whether to bypass a required computer restart after installing the Endpoint Protection client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SuspendBitLocker<SuspendBitLockerType>

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 for this parameter 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-TimeUnit<BatchingTimeoutType>

Specifies the unit for the value specified in the BatchingTimeout parameter. The acceptable values for this parameter are: Hours and Days.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserAffinityLogOnThresholdMinutes<Int32>

Specifies the number of minutes before Configuration Manager creates a user device affinity mapping.

For example, if you set the UserAffinityLogOnThresholdMinutes parameter to 60 minutes and the UserAffinityUsageThresholdDays parameter to 5 days, if a user uses a device for 60 minutes over a period of 5 days, Configuration Manager creates a user device affinity.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserAffinityUsageThresholdDays<Int32>

Specifies the number of days over which to measure the usage based affinity threshold.

For example, if you set the UserAffinityLogOnThresholdMinutes parameter to 60 minutes and the UserAffinityUsageThresholdDays parameter to 5 days, if a user uses a device for 60 minutes over a period of 5 days, Configuration Manager creates a user device affinity.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UseUtcForEvaluationTime<Boolean>

Specifies 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

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.


PS C:\> Set-CMClientSetting -Name "Client Settings Main" -Description "Client settings for TSQA office site." -NewName "Client Settings TSQA"

Example 2: Configure power management

This command allows users to opt out of power plans and disables power management for the clients with the setting named TSQA02.


PS C:\> Set-CMClientSetting -Name "TSQA02" -AllowUserToOptOutFromPowerPlan $True -EnablePowerManagement $False

Example 3: Set state messaging reporting cycle value

This command sets a state messaging reporting cycle value of 10 minutes.


PS C:\> Set-CMClientSetting -Name "TSQA02" -StateMessagingReportingCycleMinutes 10

Example 4: Configure user affinity

This command configures user affinity settings for a client setting named TSQA03. The command disables auto approval of affinity. The command sets the UserAffinityLogOnThresholdMinutes parameter to 2800 minutes and the UserAffinityUsageThresholdDays parameter to 20 days, so if a user uses a device for 2800 minutes over a period of 20 days, Configuration Manager creates a user device affinity.


PS C:\> Set-CMClientSetting -Name "TSQA03" -AutoApproveAffinity $False -UserAffinityLogOnThresholdMinutes 2800 -UserAffinityUsageThresholdDays 20

Example 5: Allow user affinity

This command changes the client setting named TSQA04 to have a client automatically configure user device affinity from usage data.


PS C:\> Set-CMClientSetting -Name "TSQA04" -AllowUserAffinity $True

Example 6: Set bandwidth for client

This command changes settings for the client settings object named TSQA05. The command enables maximum bandwidth for BITS transfers and enables off schedule downloads. The command also specifies values for maximum bandwidth value from and to and maximum transfer rate on schedule.


PS C:\> Set-CMClientSetting -Name "TSQA05" -EnableBITSMaxBandwidth $True EnableDownloadOffSchedule $True -MaxBandwidthValidFrom 8 -MaxBandwidthValidTo 15 -MaxTransferRateOnSchedule 1500

Example 7: Configure user policies on the Internet

This command changes settings for the client settings object named TSQA06. The command enables user policy on the Internet, enables user policy polling, and sets a policy polling interval.


PS C:\> Set-CMClientSetting -Name "TSQA06" -EnableUserPolicyOnInternet $True -EnableUserPolicyPolling $False -EnableUserPolicyOnInternet $True -PolicyPollingInterval 50

Example 8: Disable compliance evaluation

This command disables compliance evaluation for the setting named TSQA07.


PS C:\> Set-CMClientSetting -Name "TSQA07" -EnableComplianceEvaluation $False

Example 9: Set computer agent settings

This command changes settings for the client settings object named TSQA09. The command specifies a portal and adds that portal to the trusted site list and allows it to have elevated trust. The command specifies a branding title, Contoso IT. The command enables third party orchestration. The command sets final reminder and initial reminder intervals. The command also specifies that only administrators can install software, selects Bypass as the Windows PowerShell execution policy, and suspends a BitLocker PIN requirement.


PS C:\> Set-CMClientSetting -Name "TSQA09" -AddPortalToTrustedSiteList $True -AllowPortalToHaveElevatedTrust $True -BrandingTitle "Contoso IT" -EnableThirdPartyOrchestration Yes -FinalReminderMinutesInterval 52 -InitialReminderHoursInterval 6 -InstallRestriction OnlyAdministrators -PortalUrl "http://NewInstall.Contoso.com" -PowerShellExecutionPolicy Bypass -SuspendBitLocker Always

Example 10: Configure restart settings

This command sets restart logoff notification countdown duration and logoff notification final window duration for a client setting object named TSQA11.


PS C:\> Set-CMClientSetting -Name "TSQA11" -RebootLogoffNotificationCountdownDuration 12 -RebootLogoffNotificationFinalWindowMinutes 80

Example 11: Configure metered network usage

This command specifies the type of metered network usage for the client setting object named TSQA21 as Limit.


PS C:\> Set-CMClientSetting -Name "TSQA21" -MeteredNetworkUsage Limit

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft