Get-CMCollectionEvaluationStatus
Get the status of collection evaluation.
Syntax
ByName (Default)
Get-CMCollectionEvaluationStatus
[[-Name] <String>]
-EvaluationTypeOption <EvaluationType>
[-IsMemberChanged <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
ById
Get-CMCollectionEvaluationStatus
[-Id] <String>
-EvaluationTypeOption <EvaluationType>
[-IsMemberChanged <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
ByValue
Get-CMCollectionEvaluationStatus
[-InputObject] <IResultObject>
-EvaluationTypeOption <EvaluationType>
[-IsMemberChanged <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
Description
Get the status of collection evaluation. For more information, see How to view collection evaluation.
Tip
The collection evaluation process happens on primary sites, not on the central administration site (CAS). Use this cmdlet when connected to a primary site.
Examples
Example 1: Show status for collections with long full evaluation
This example first uses Get-CMCollectionEvaluationStatus to get the status of full evaluation for all collections. It then uses the Where-Object cmdlet to filter the results to the collections where the full evaluation time was greater than five seconds (5000 milliseconds).
Get-CMCollectionEvaluationStatus -EvaluationTypeOption Full | Where-Object Length -gt 5000
Example 2: Show summary of full evaluation on built-in collections that recently changed
This example first uses the Get-CMCollection cmdlet to get all collections whose name starts with All. The results of this query will include all built-in collections such as All Systems and All Users. It then passes those results to the Get-CMCollectionEvaluationStatus cmdlet to get their full evaluation status, only if they had any recent member changes. It then uses the Select-Object cmdlet to only display the name of the collection, how many milliseconds full evaluation took, and how many members changed. By default, the output displays as a table.
Get-CMCollection -Name "All*" | Get-CMCollectionEvaluationStatus -EvaluationTypeOption Full -IsMemberChanged $True | Select-Object CollectionName, Length, MemberChanges
Parameters
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EvaluationTypeOption
Specify the type of evaluation for which to get the status, either Full or Incremental. For more information, see Collection evaluation in Configuration Manager.
Parameter properties
| Type: | EvaluationType |
| Default value: | None |
| Accepted values: | Full, Incremental |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specify the ID of a collection to query. For example, "SMS00002".
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CollectionId |
Parameter sets
ById
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specify a collection object to query. To get this object, use the Get-CMCollection cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Collection |
Parameter sets
ByValue
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsMemberChanged
Set this parameter to $true to filter the results to collections whose membership recently changed. In other words, where the MemberChanges attribute isn't 0.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specify the name of a collection to query. For example, "All Users".
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CollectionName |
Parameter sets
ByName
| Position: | 0 |
| 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
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject
IResultObject
IResultObject
IResultObject
Related Links
- Get-CMCollectionFullEvaluationStatus
- Get-CMCollectionIncrementalEvaluationStatus
- Get-CMCollectionInfoFromEvaluationQueue
- Get-CMCollectionInfoFromFullEvaluationQueue
- Get-CMCollectionInfoFromIncrementalEvaluationQueue
- Get-CMCollectionInfoFromManualEvaluationQueue
- Get-CMCollectionInfoFromNewEvaluationQueue
- How to view collection evaluation
- Collection evaluation in Configuration Manager