Edit

Get-CMDeviceCollection

  • Reference
Module:
ConfigurationManager

Get one or more device collections.

Syntax

Get-CMDeviceCollection
   [-Name <String>]
   [<CommonParameters>]
Get-CMDeviceCollection
   -Id <String>
   [<CommonParameters>]
Get-CMDeviceCollection
   -DistributionPointGroupName <String>
   [<CommonParameters>]
Get-CMDeviceCollection
   -DistributionPointGroupId <String>
   [<CommonParameters>]
Get-CMDeviceCollection
   -DistributionPointGroup <IResultObject>
   [<CommonParameters>]

Description

Use this cmdlet to get one or more device collections. To get either user or device 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 device collection by using an ID

This command gets the default device collection All Systems with ID SMS00001.

Get-CMDeviceCollection -CollectionId "SM00001"

Example 2: Get all device collections associated with a distribution point group

This example gets all device collections associated with the distribution point group named dpg1.

Get-CMDeviceCollection -DistributionPointGroupName "dpg1"

When you distribute content to these collections, the site automatically distributes to all current members of this distribution point group. For more information, see Manage distribution point groups.

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 device collection to get. This value is the CollectionID property, for example, XYZ00012 or SMS00001.

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 device 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.