Edit

Get-CMClientSettingDeployment

  • Reference
Module:
ConfigurationManager

Get a deployment of a custom client settings object.

Syntax

Get-CMClientSettingDeployment
   -Name <String>
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMClientSettingDeployment
   -Id <String>
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMClientSettingDeployment
   -InputObject <IResultObject>
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Starting in version 2107, use this cmdlet to get a deployment of a custom client settings object. You can use this object with Remove-CMClientSettingDeployment.

For more information on client settings, see How to configure client settings.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Get the deployment of a client setting by name

This example first gets a client settings object by name, and then passes that object to Get-CMClientSettingDeployment to show details about the deployment.

$clientSetting =  Get-CMClientSetting -Name "Software Center customizations"
$clientSetting | Get-CMClientSettingDeployment

Parameters

-Collection

Specify a collection object to which the client settings object is deployed. To get this object, use the Get-CMCollection cmdlet.

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

-CollectionId

Specify the ID of a collection to which the client settings object is deployed. For example, XYZ00012.

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

-CollectionName

Specify the name of a collection to which the client settings object is deployed.

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

-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

-Id

Specify the ID of the client settings object that's deployed. The settings ID is an integer value, for example 47 or 16777225.

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

-InputObject

Specify a client settings object to get its deployments. To get this object, use the Get-CMClientSetting cmdlet.

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

-Name

Specify the name of the client settings object that's deployed.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject[]

IResultObject

Notes

For more information on this return object and its properties, see SMS_ClientSettingsAssignment server WMI class.