Start-CMClientSettingDeployment

Deploys client settings to devices in a collection.

Syntax

Start-CMClientSettingDeployment
     -ClientSetting <IResultObject>
     -CollectionId <String>
     [-Confirm]
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [<CommonParameters>]
Start-CMClientSettingDeployment -ClientSetting  -CollectionName  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSetting  -Collection  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSettingId  -CollectionId  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSettingId  -Collection  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSettingId  -CollectionName  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSettingName  -Collection  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSettingName  -CollectionId  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []
Start-CMClientSettingDeployment -ClientSettingName  -CollectionName  [-Confirm]
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] []

Description

The Start-CMClientSettingDeployment cmdlet deploys client settings to devices in a Microsoft System Center 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 on TechNet.

Examples

Example 1: Deploy a client setting object by using its ID to a named collection

PS C:\> 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 C:\> $CSID = Get-CMClientSetting -Id "CSI1023"
PS C:\> 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.

Required Parameters

-ClientSetting

Specifies a client setting object. To obtain a client setting object, use the Get-CMClientSetting cmdlet.

Type:IResultObject
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-ClientSettingId

Specifies the ID of a client setting object.

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

Specifies the name of a client setting object.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:IResultObject
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-CollectionId

Specifies the ID of a Configuration Manager collection. Configuration Manager applies the client settings to the members of this collection.

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

Specifies the name of a Configuration Manager collection. Configuration Manager applies the client settings to the members of this collection.

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

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

Indicates that wildcard handling is disabled.

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

Indicates that wildcard handling is enabled.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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