Edit

Get-CMClientSetting

  • Reference
Module:
ConfigurationManager

Gets client settings.

Syntax

Get-CMClientSetting
   [-Name <String>]
   [-Raw]
   [-Setting <SettingType>]
   [-SettingType <Types>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMClientSetting
   -Id <String>
   [-Raw]
   [-Setting <SettingType>]
   [-SettingType <Types>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

The Get-CMClientSetting cmdlet gets a customized collection of client settings.

For more information about client settings, see About Client Settings in Configuration Manager.

Note

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

Examples

Example 1: Get a collection of customized client settings that is specified by its name

PS XYZ:\> Get-CMClientSetting -Name "Windows 8 Client Computers Settings"
AgentConfigurations: {}
AssignmentCount:     0
CreatedBy:           Contoso\DChew
DateCreated:         8/04/2012 4:40:03 PM
DateModified:        8/04/2012 4:40:03 PM
Description:         Windows 8 Client Computers Settings
Enabled:             False
FeatureType:         1
Flags:               0
LastModifiedBy:      Contoso\DChew
Name:                Win08ClientSettings
Priority:            0
SecuredScopeNames:   {Default}
Settings ID:         16777220
Type:                1
UniqueID:            {0CCA6700-AE5E-4949-8FBC-AA6719775CC3}

This command gets client settings that have the specified name.

Parameters

-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

-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

-Id

Specifies an array of identifiers for one or more collections of client settings.

Type:String
Aliases:SettingsId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies a name for customized client settings.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Raw

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Setting

Specifies an array of setting types for one or more collections of client settings.

Valid values are:

  • BackgroundIntelligentTransfer
  • ClientPolicy
  • Cloud
  • ComplianceSettings
  • ComputerAgent
  • ComputerRestart
  • EndpointProtection
  • HardwareInventory
  • MeteredNetwork
  • MobileDevice
  • NetworkAccessProtection
  • PowerManagement
  • RemoteTools
  • SoftwareDeployment
  • SoftwareInventory
  • SoftwareMetering
  • SoftwareUpdates
  • StateMessaging
  • UserAndDeviceAffinity
Type:SettingType
Accepted values:BackgroundIntelligentTransfer, Cloud, ClientCache, ClientPolicy, ComplianceSettings, ComputerAgent, ComputerRestart, DeliveryOptimization, EndpointProtection, HardwareInventory, MeteredNetwork, MobileDevice, NetworkAccessProtection, PowerManagement, RemoteTools, SoftwareCenter, SoftwareDeployment, SoftwareInventory, SoftwareMetering, SoftwareUpdates, StateMessaging, UserAndDeviceAffinity, WindowsAnalytics
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SettingType

Type:Types
Aliases:Type
Accepted values:Default, Device, User
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject[]

IResultObject

IResultObject

Dictionary<string, object>