Edit

Get-CMUserCollection

  • Reference
Module:
ConfigurationManager

Get one or more user collections.

Syntax

Get-CMUserCollection
   [-Name <String>]
   [<CommonParameters>]
Get-CMUserCollection
   -Id <String>
   [<CommonParameters>]
Get-CMUserCollection
   -DistributionPointGroupName <String>
   [<CommonParameters>]
Get-CMUserCollection
   -DistributionPointGroupId <String>
   [<CommonParameters>]
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.

Type:IResultObject
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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}.

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

-DistributionPointGroupName

Specify the name of a distribution point group that's associated with this collection.

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

-Id

Specify the ID of the user collection to get. This value is the CollectionID property, for example, XYZ00013 or SMS00002.

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

-Name

Specify the name of the user collection to get.

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

Inputs

None

Outputs

System.Object

Notes

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