Edit

Get-CMCollectionSetting

  • Reference
Module:
ConfigurationManager

Get the settings for a collection.

Syntax

Get-CMCollectionSetting
   [-CollectionType <CollectionType>]
   -InputObject <IResultObject>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMCollectionSetting
   -CollectionId <String>
   [-CollectionType <CollectionType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMCollectionSetting
   -CollectionName <String>
   [-CollectionType <CollectionType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to get the settings for a collection. These settings include properties for device variables, power management, and maintenance windows. In most instances, use the dedicated cmdlets for these properties, for example:

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 settings for a collection by using the pipeline

This command gets the collection object with the ID of XYZ00014 and uses the pipeline operator to pass the object to Get-CMCollectionSetting, which gets the device collection settings for the collection object.

Get-CMCollection -Id XYZ00014 | Get-CMCollectionSetting -CollectionType Device

Example 2: Get the settings for a collection by name

This command gets the collection settings for the device collection named Devicecol1.

Get-CMCollectionSetting -CollectionName "Devicecol1"

Parameters

-CollectionId

Specify the ID of the collection to get its settings. This value is the CollectionID property, for example, XYZ00012.

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

-CollectionName

Specify the name of the collection to get its settings.

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

-CollectionType

Filter the type of collection to get.

Type:CollectionType
Accepted values:User, Device
Position:Named
Default value:None
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

-InputObject

Specify a collection object to get its settings. To get this object, use one of the following cmdlets:

You can also use the pipeline operator (|) to pass a collection object to Get-CMCollectionMemeber on the command line.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object