Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-CMClientSetting
- Module:
- ConfigurationManager Module
Gets client settings.
Syntax
SearchByName (Default)
Get-CMClientSetting
[-Name <String>]
[-Raw]
[-Setting <SettingType>]
[-SettingType <Types>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByIdMandatory
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Id
Specifies an array of identifiers for one or more collections of client settings.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SettingsId |
Parameter sets
-Name
Specifies a name for customized client settings.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-Raw
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
Parameter properties
| Type: | SettingType |
| Default value: | None |
| 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 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SettingType
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.
Parameter properties
| Type: | Types |
| Default value: | None |
| Accepted values: | Default, Device, User |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Type |
Parameter sets
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
None
Outputs
IResultObject
IResultObject
IResultObject
Dictionary<string, object>
Related Links
- About Client Settings in Configuration Manager
- New-CMClientSetting
- Remove-CMClientSetting
- Set-CMClientSettingBackgroundIntelligentTransfer
- Set-CMClientSettingClientCache
- Set-CMClientSettingClientPolicy
- Set-CMClientSettingCloudService
- Set-CMClientSettingComplianceSetting
- Set-CMClientSettingComputerAgent
- Set-CMClientSettingComputerRestart
- Set-CMClientSettingDeliveryOptimization
- Set-CMClientSettingEndpointProtection
- Set-CMClientSettingEnrollment
- Set-CMClientSettingGeneral
- Set-CMClientSettingHardwareInventory
- Set-CMClientSettingMeteredInternetConnection
- Set-CMClientSettingPowerManagement
- Set-CMClientSettingRemoteTool
- Set-CMClientSettingSoftwareCenter
- Set-CMClientSettingSoftwareDeployment
- Set-CMClientSettingSoftwareInventory
- Set-CMClientSettingSoftwareMetering
- Set-CMClientSettingSoftwareUpdate
- Set-CMClientSettingStateMessaging
- Set-CMClientSettingUserAndDeviceAffinity
Feedback
Was this page helpful?