Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Start-CMClientSettingDeployment
- Module:
- ConfigurationManager Module
(Deprecated) Deploys client settings to devices in a collection.
Syntax
SearchByClientSettingName_CollectionValue (Default)
Start-CMClientSettingDeployment
-ClientSettingName <String>
-Collection <IResultObject>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingValue_CollectionId
Start-CMClientSettingDeployment
-ClientSetting <IResultObject>
-CollectionId <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingValue_CollectionName
Start-CMClientSettingDeployment
-ClientSetting <IResultObject>
-CollectionName <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingValue_CollectionValue
Start-CMClientSettingDeployment
-ClientSetting <IResultObject>
-Collection <IResultObject>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingId_CollectionId
Start-CMClientSettingDeployment
-ClientSettingId <String>
-CollectionId <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingId_CollectionName
Start-CMClientSettingDeployment
-ClientSettingId <String>
-CollectionName <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingId_CollectionValue
Start-CMClientSettingDeployment
-ClientSettingId <String>
-Collection <IResultObject>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingName_CollectionId
Start-CMClientSettingDeployment
-ClientSettingName <String>
-CollectionId <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByClientSettingName_CollectionName
Start-CMClientSettingDeployment
-ClientSettingName <String>
-CollectionName <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Start-CMClientSettingDeployment cmdlet deploys client settings to devices in a Configuration Manager collection. Specify the client setting object by using its name or ID, or you can use the Get-CMClientSetting cmdlet to get a client setting object. Specify the collection to apply the settings to by using its name or ID, or you can use the Get-CMDeviceCollection cmdlet to get a device collection.
For more information about client settings, see About Client Settings in Configuration Manager.
Important
Starting in version 2107, this cmdlet is deprecated and may be removed in a future release. Instead use the New-CMClientSettingDeployment cmdlet.
Examples
Example 1: Deploy a client setting object by using its ID to a named collection
PS XYZ:\> Start-CMClientSettingDeployment -ClientSettingId "CSI1023" -CollectionName "General Computer Collection"
This command starts deployment of the client setting object that has the ID CSI1023 for the collection named General Computer Collection.
Example 2: Deploy a client setting object by using a variable
PS XYZ:\> $CSID = Get-CMClientSetting -Id "CSI1023"
PS XYZ:\> Start-CMClientSettingDeployment -ClientSetting $CSID -CollectionName "General Computer Collection"
The first command gets a client setting object that has the ID CSI1023, and saves it in the $CSID variable.
The second command starts deployment of the client setting object in the $CSID variable to the collection named General Computer Collection.
Parameters
-ClientSetting
Specifies a client setting object. To obtain a client setting object, use the Get-CMClientSetting cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ClientSettingId
Specifies the ID of a client setting object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ClientSettingName
Specifies the name of a client setting object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Collection
Specifies a Configuration Manager collection object. To obtain a collection object, use the Get-CMDeviceCollection cmdlet. Configuration Manager applies the client settings to the members of this collection.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionId
Specifies the ID of a Configuration Manager collection. Configuration Manager applies the client settings to the members of this collection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionName
Specifies the name of a Configuration Manager collection. Configuration Manager applies the client settings to the members of this collection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-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
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object
Related Links
Feedback
Was this page helpful?