Get-CMUserCollection
Get-CMUserCollection
Gets one or more user collections in the Configuration Manager hierarchy.
Syntax
Parameter Set: SearchByDPGroupId
Get-CMUserCollection -DistributionPointGroupId <String> [ <CommonParameters>]
Parameter Set: SearchByDPGroupName
Get-CMUserCollection -DistributionPointGroupName <String> [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Get-CMUserCollection -CollectionId <String> [ <CommonParameters>]
Parameter Set: SearchByName
Get-CMUserCollection [-Name <String> ] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Get-CMUserCollection -DistributionPointGroup <IResultObject> [ <CommonParameters>]
Detailed Description
The Get-CMUserCollection cmdlet retrieves collections that contain users in Microsoft System Center 2012 SP1 Configuration Manager. For more information about collections, see Introduction to Collections in Configuration Manager (https://go.microsoft.com/fwlink/p/?LinkID=259433) on TechNet.
Parameters
-CollectionId<String>
Specifies the ID of the user collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroup<IResultObject>
Specifies an object that represents a distribution point group that is associated with the user collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroupId<String>
Specifies the ID of a distribution point group that is associated with the user collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroupName<String>
Specifies the name of a distribution point group that is associated with the user collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the user collections. If a specific collection is not specified, all user collections in the hierarchy are returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get a user collection
This command gets the user collection that has the ID 9990000D.
PS C:\> Get-CMUserCollection -CollectionId "9990000D"