Get-CMClientSetting
Get-CMClientSetting
Gets client settings.
Syntax
Parameter Set: SearchByName
Get-CMClientSetting [-Name <String> ] [-SecuredScopeNames <String> ] [-Setting {BackgroundIntelligentTransfer | ClientPolicy | Cloud | ComplianceSettings | ComputerAgent | ComputerRestart | EndpointProtection | HardwareInventory | MeteredNetwork | MobileDevice | NetworkAccessProtection | PowerManagement | RemoteTools | SoftwareDeployment | SoftwareInventory | SoftwareMetering | SoftwareUpdates | StateMessaging | UserAndDeviceAffinity}[] ] [-Type <Types> {Default | Device | User} ] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Get-CMClientSetting -Id <String[]> [-SecuredScopeNames <String> ] [-Setting {BackgroundIntelligentTransfer | ClientPolicy | Cloud | ComplianceSettings | ComputerAgent | ComputerRestart | EndpointProtection | HardwareInventory | MeteredNetwork | MobileDevice | NetworkAccessProtection | PowerManagement | RemoteTools | SoftwareDeployment | SoftwareInventory | SoftwareMetering | SoftwareUpdates | StateMessaging | UserAndDeviceAffinity}[] ] [-Type <Types> {Default | Device | User} ] [ <CommonParameters>]
Detailed 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 (https://go.microsoft.com/fwlink/?LinkId=266226) on TechNet.
Parameters
-Id<String[]>
Specifies an array of identifiers for one or more collections of client settings.
Aliases |
SettingsId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name for customized client settings.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SecuredScopeNames<String>
Specifies the name of security scopes. A security scope can be Default or the name of a custom-created security scope.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Setting<SettingType[]>
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
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Type<Types>
Specifies the type of customized settings. Valid values are 1 (device) or 2 (user).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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: Get a collection of customized client settings that is specified by its name
This command gets client settings that have the specified name.
PS C:\> Get-CMClientSetting -Name "Windows 8 Client Computers Settings"