Get-CMCollectionSetting
Get the settings for a collection.
Syntax
ByValue (Default)
Get-CMCollectionSetting
-InputObject <IResultObject>
[-CollectionType <CollectionType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
ById
Get-CMCollectionSetting
-CollectionId <String>
[-CollectionType <CollectionType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
ByName
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CollectionName
Specify the name of the collection to get its settings.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CollectionType
Filter the type of collection to get.
Parameter properties
| Type: | CollectionType |
| Default value: | None |
| Accepted values: | User, Device |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Collection |
Parameter sets
ByValue
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.