Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Start-CMClientSettingDeployment

Updated: September 1, 2013

Applies To: System Center 2012 Configuration Manager SP1

Start-CMClientSettingDeployment

Deploys client settings to devices in a collection.

Syntax

Parameter Set: SearchByClientSettingId_CollectionId
Start-CMClientSettingDeployment -ClientSettingId <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingId_CollectionName
Start-CMClientSettingDeployment -ClientSettingId <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingId_CollectionValue
Start-CMClientSettingDeployment -ClientSettingId <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingName_CollectionId
Start-CMClientSettingDeployment -ClientSettingName <String> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingName_CollectionName
Start-CMClientSettingDeployment -ClientSettingName <String> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingName_CollectionValue
Start-CMClientSettingDeployment -ClientSettingName <String> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingValue_CollectionId
Start-CMClientSettingDeployment -ClientSetting <IResultObject> -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingValue_CollectionName
Start-CMClientSettingDeployment -ClientSetting <IResultObject> -CollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByClientSettingValue_CollectionValue
Start-CMClientSettingDeployment -ClientSetting <IResultObject> -Collection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

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

Parameters

-ClientSetting<IResultObject>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ClientSettingId<String>

Specifies the ID of a client setting object.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ClientSettingName<String>

Specifies the name of a client setting object.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Collection<IResultObject>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CollectionId<String>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CollectionName<String>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

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: Deploy a client setting object by using its ID to a named collection

This command starts deployment of the client setting object that has the ID CSI1023 for the collection named General Computer Collection.


PS C:\> Start-CMClientSettingDeployment -ClientSettingId "CSI1023" -CollectionName "General Computer Collection"

Example 2: Deploy a client setting object by using a variable

This example starts deployment of client settings for a 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.


PS C:\> $CSID = Get-CMClientSetting -Id "CSI1023"PS C:\>Start-CMClientSettingDeployment -ClientSetting $CSID -CollectionName "General Computer Collection"

Related topics

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.