Get-CMUserCollection
Get one or more user collections.
Syntax
ByName (Default)
Get-CMUserCollection
[-Name <String>]
[<CommonParameters>]
ById
Get-CMUserCollection
-Id <String>
[<CommonParameters>]
ByDPGroupName
Get-CMUserCollection
-DistributionPointGroupName <String>
[<CommonParameters>]
ByDPGroupId
Get-CMUserCollection
-DistributionPointGroupId <String>
[<CommonParameters>]
ByDPGroup
Get-CMUserCollection
-DistributionPointGroup <IResultObject>
[<CommonParameters>]
Description
Use this cmdlet to get one or more user collections. To get either device or user collections, use the Get-CMCollection cmdlet. For more information about collections, see Introduction to Collections in Configuration Manager.
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 a user collection
This command gets the default user collection All Users with ID SMS00002.
Get-CMUserCollection -CollectionId "SMS00002"
Parameters
-DistributionPointGroup
Specify a distribution point group object that's associated with this collection. To get this object, use the Get-CMDistributionPointGroup cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByDPGroup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DistributionPointGroupId
Specify the GUID for a distribution point group that's associated with this collection. This value is the GroupID property, which is a standard GUID surrounded by curly brackets, for example, {537e6303-69eb-4104-bf7b-7baf43ce2352}.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByDPGroupId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DistributionPointGroupName
Specify the name of a distribution point group that's associated with this collection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByDPGroupName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specify the ID of the user collection to get. This value is the CollectionID property, for example, XYZ00013 or SMS00002.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CollectionId |
Parameter sets
ById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specify the name of the user collection to get.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| 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.
Inputs
None
Outputs
System.Object
Notes
For more information on this return object and its properties, see SMS_Collection server WMI class.