SMS_Collection server WMI class
The SMS_Collection WMI class is an SMS Provider server class in Configuration Manager. It represents a collection of resources related logically by rules along with collection information.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Syntax
Class SMS_Collection : SMS_BaseClass
{
String CollectionID;
SMS_CollectionRule CollectionRules[];
UInt32 CollectionType;
SInt32 CollectionVariablesCount;
String Comment;
UInt32 CurrentStatus;
Uint32 FullEvaluationRunTime;
Uint32 FullEvaluationMemberChanges;
DateTime FullEvaluationMemberChangeTime;
DateTime FullEvaluationLastRefreshTime;
DateTime FullEvaluationNextRefreshTime;
Boolean HasProvisionedMember;
SInt32 IncludeExcludeCollectionsCount;
Uint32 IncrementalEvaluationRunTime;
Uint32 IncrementalEvaluationMemberChanges;
DateTime IncrementalEvaluationMemberChangeTime;
DateTime IncrementalEvaluationLastRefreshTime;
Boolean IsBuiltIn;
Boolean IsReferenceCollection;
UInt8 ISVData[];
UInt32 ISVDataSize;
String ISVString;
DateTime LastChangeTime;
DateTime LastMemberChangeTime;
DateTime LastRefreshTime;
String LimitToCollectionID;
String LimitToCollectionName;
SInt32 LocalMemberCount;
String MemberClassName;
SInt32 MemberCount;
UInt32 MonitoringFlags;
String Name;
Boolean OwnedByThisSite;
SInt32 PowerConfigsCount;
SMS_ScheduleToken RefreshSchedule[];
UInt32 RefreshType;
Boolean ReplicateToSubSites;
SInt32 ServiceWindowsCount;
Boolean UseCluster;
};
Methods
The following methods are available in the SMS_Collection class:
- AddMembershipRule method: Adds one new rule to the
CollectionRulesproperty ofSMS_Collection. - AddMembershipRules method: Adds multiple new rules to the
CollectionRulesproperty ofSMS_Collection. - ApproveClients method: Approves specified client computers to join the site.
- BlockClients method: Blocks specified client computers from communicating with the site.
- ChangeOwnership method: Changes ownership of machines to a device owner.
- ClearDeploymentLocksForCollection method: Clears deployment locks for a selected collection.
- ClearDeviceCategory method: Clears a category from a set of devices.
- ClearLastNBSAdvForCollection method: Clears the last PXE deployment for a selected collection.
- ClearLastNBSAdvForMachines method: Clears the last PXE deployment for selected client computers.
- ClientEditions method: Retrieves a list of client editions.
- CreateCCR method: Creates a client configuration request (CCR) for a particular resource.
- CreateCCRs method: Generates client configuration requests (CCRs) for the computers in the collection.
- DeleteAllMembers method: Deletes all members, that is, resources and discovery data, for the collection.
- DeleteMembershipRule method: Deletes a membership rule from the collection.
- DeleteMembershipRules method: Deletes multiple membership rules from the collection.
- FindResourceSite method: Gets site code information for a computer from the site database.
- FindMachineSite method: Gets site code information for resources from the site database.
- GetDependency method: Starting in version 2010, get the collection relationship info which the input collection depends on.
- GetDependent method: Starting in version 2010, get the collection relationship info which depends on the input collection.
- GetNumResults method: Gets a count of all members in a collection, excluding subcollections.
- GenerateCCRByName method: Generates a client configuration request by computer name.
- GetTotalNumResults method: Gets a count of all members in a collection, including subcollections.
- ReassignClientsToSite method: Reassigns the site for the clients in the list.
- RequestRefresh method: Triggers a re-evaluation of collection membership by the Configuration Manager collection evaluator component.
- SetDeviceCategory method: Assigns a category to a set of devices.
- SetMemberOrder method: Sets the order of the members of a collection.
- UpdateVisibilityInEPDashBoard method: Show this collection in the endpoint protection dashboard.
- VerifyNoCircularDependencies method: Verifies that no circular dependencies are formed if one collection is the parent of another.
Properties
CollectionID
Data type: String
Access type: Read-only
Qualifiers: [key, read]
The unique autogenerated ID for this collection that contains eight characters.
The format of the collection ID is the site code that created the collection followed by a five-digit hexadecimal serial number, for example, JAX0002C. The default Configuration Manager collections use the prefix SMS, for example, SMS00001.
CollectionRules
Data type: SMS_CollectionRule array
Access type: Read/Write
Qualifiers: [lazy]
SMS_CollectionRule server WMI class objects defining the membership criteria for the collection.
CollectionType
Data type: UInt32
Access type: Read-only
Qualifiers: [read, enumeration]
The type of the collection. When creating or modifying collections, the collection type must be the same for all included, excluded, and limited collections. Mismatched collection types aren't allowed.
| Value | Collection type |
|---|---|
0 |
Other |
1 |
User |
2 |
Device |
CollectionVariablesCount
Data type: SInt32
Access type: Read-only
Qualifiers: [read]
Count of collection variables.
Comment
Data type: String
Access type: Read/Write
Qualifiers: None
General comment or note that documents the collection.
CurrentStatus
Data type: UInt32
Access type: Read-only
Qualifiers: [read, enumeration]
Current status of the collection. Possible values are:
| Value | Current status |
|---|---|
0 |
None |
1 |
Ready |
2 |
Refreshing |
3 |
Saving |
4 |
Evaluating |
5 |
Awaiting refresh |
6 |
Deleting |
7 |
Appending member |
8 |
Querying |
FullEvaluationRunTime
Data type: Uint32
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the full evaluation run time in seconds.
FullEvaluationMemberChanges
Data type: Uint32
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the number of member changes from full evaluation.
FullEvaluationMemberChangeTime
Data type: Datetime
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the last time that membership changed from full evaluation.
FullEvaluationLastRefreshTime
Data type: Datetime
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the full evaluation last refresh time.
FullEvaluationNextRefreshTime
Data type: Datetime
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the full evaluation next refresh time.
HasProvisionedMember
Data type: Boolean
Access type: Read-only
Qualifiers: [read]
true if this collection has provisioned members.
IncludeExcludeCollectionsCount
Data type: SInt32
Access type: Read-only
Qualifiers: [read]
Count of collections that are included and excluded with this one.
IncrementalEvaluationRunTime
Data type: Uint32
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the incremental evaluation run time in seconds.
IncrementalEvaluationMemberChanges
Data type: Uint32
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the number of member changes from incremental evaluation.
IncrementalEvaluationMemberChangeTime
Data type: Datetime
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the last time that membership changed from incremental evaluation.
IncrementalEvaluationLastRefreshTime
Data type: Datetime
Access type: Read-only
Qualifiers: [read]
Starting in version 2010, the incremental evaluation last refresh time.
IsBuiltIn
Data type: Boolean
Access type: Read-Only
Qualifiers: [read]
When this value is true, the collection is built in. For example, All Systems.
IsReferenceCollection
Data type: Boolean
Access type: Read-only
Qualifiers: [read]
When this value is true, the collection isn't limited by another collection.
ISVData
Data type: UInt8[]
Access type: Read/Write
Qualifiers: [large, lazy]
A data space for partner extensibility.
ISVDataSize
Data type: UInt32
Access type: Read/Write
Qualifiers: [lazy]
The ISVData size.
ISVString
Data type: String
Access type: Read/Write
Qualifiers: none
A string for partner extensibility.
LastChangeTime
Data type: DateTime
Access type: Read/Write
Qualifiers: None
Date and time of when the collection was last altered in any way.
LastMemberChangeTime
Data type: DateTime
Access type: Read/Write
Qualifiers: None
Date and time of when the collection membership was last altered.
LastRefreshTime
Data type: DateTime
Access type: Read/Write
Qualifiers: None
Date and time of when the collection membership was last refreshed.
LimitToCollectionID
Data type: String
Access type: Read/Write
Qualifiers: None
The ID of the limiting collection.
LimitToCollectionName
Data type: DateTime
Access type: Read/Write
Qualifiers: None
The name of the limiting collection.
LocalMemberCount
Data type: SInt32
Access type: Read-only
Qualifiers: [read]
Count of members visible at the local site.
MemberClassName
Data type: String
Access type: Read-only
Qualifiers: [read]
The name of the class that contains the members of this collection. Configuration Manager doesn't store collection members in SMS_Collection. The site dynamically generates the member class name, and is derived from SMS_CM_RES_COLL_CollectionID server WMI class.
MemberCount
Data type: SInt32
Access type: Read-only
Qualifiers: [read]
The count of the collection members.
MonitoringFlags
Data type: UInt32
Access type: Read-only
Qualifiers: [read]
Enables the collection for certain kinds of monitoring.
Name
Data type: String
Access type: Read/Write
Qualifiers: [Not_null]
The name of the collection. This value represents the collection in the Configuration Manager console and should be unique.
OwnedByThisSite
Data type: Boolean
Access type: Read/Write
Qualifier: None
true if the collection originated at the local Configuration Manager site. The default value is false.
PowerConfigsCount
Data type: SInt32
Access type: Read-only
Qualifier: [read]
A count of the power configurations.
RefreshSchedule
Data type: SMS_ScheduleToken array
Access type: Read/Write
Qualifiers: [max(15), lazy]
SMS_ScheduleToken server WMI class objects indicating an update or refresh schedule for the collection. The site only updates collection membership if your application specifies a schedule or calls the RequestRefresh method in the SMS_Collection class. For the collection evaluator to use the schedule, set the RefreshType property to periodic (2).
RefreshType
Data type: UInt32
Access type: Read/Write
Qualifiers: [lazy, enumeration]
This value indicates how Configuration Manager refreshes the collection. The default value is manual (1). Possible values:
| Value | Refresh type |
|---|---|
1 |
Manual |
2 |
Periodic |
4 |
Constant update |
To base the refresh on the schedule specified in RefreshSchedule, set this property to periodic (2). If you set this property to manual (1), manually update the collection with the RequestRefresh method.
ReplicateToSubSites
This property isn't implemented.
ServiceWindowsCount
Data type: SInt32
Access type: Read-only
Qualifiers: [read]
Count of maintenance windows for this collection.
UseCluster
Data type: Boolean
Access type: Read-only
Qualifiers: [read]
Specifies that this collection is a server group.
Remarks
Class qualifiers for this class include:
- Secured
For more information about both the class qualifiers and the property qualifiers included in the properties section, see Configuration Manager class and property qualifiers.
Collection information represented by this class includes the refresh schedule and the members, represented by SMS_CM_RES_COLL_CollectionID server WMI class objects. Your application can use a collection to target resources for software distribution.
When you run a query against a dynamic collection represented by SMS_Collection, make sure that the SMS Provider is loaded or that another method or query has already run.
The application should use the SMS_Collection methods to add, update, or delete membership rules defined by the CollectionRules property. This property isn't retrieved when your application enumerates SMS_Collection. To obtain the collection rules for a collection, your application must use IWbemServices::GetObject or SWbemServices::Get. For more information, see Configuration Manager context qualifiers.
Requirements
Runtime requirements
For more information, see Configuration Manager server runtime requirements.
Development requirements
For more information, see Configuration Manager server development requirements.
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for