Start-CMClientSettingDeployment

  • Reference
Module:
ConfigurationManager

(Deprecated) Deploys client settings to devices in a collection.

Syntax

Start-CMClientSettingDeployment
     -ClientSettingName <String>
     -Collection <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSetting <IResultObject>
     -CollectionId <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSetting <IResultObject>
     -CollectionName <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSetting <IResultObject>
     -Collection <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSettingId <String>
     -CollectionId <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSettingId <String>
     -CollectionName <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSettingId <String>
     -Collection <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMClientSettingDeployment
     -ClientSettingName <String>
     -CollectionId <String>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
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.

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

-ClientSettingId

Specifies the ID of a client setting object.

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

-ClientSettingName

Specifies the name of a client setting object.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object