Edit

Share via


Invoke-CMDeploymentSummarization

Runs a Configuration Manager deployment summarization.

Syntax

SearchByCollectionIdMandatory (Default)

Invoke-CMDeploymentSummarization
    -CollectionId <String>
    [-SoftwareName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByCollectionNameMandatory

Invoke-CMDeploymentSummarization
    -CollectionName <String>
    [-SoftwareName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory

Invoke-CMDeploymentSummarization
    -DeploymentId <String>
    [-SoftwareName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByValueMandatory

Invoke-CMDeploymentSummarization
    -InputObject <IResultObject>
    [-SoftwareName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Invoke-CMDeploymentSummarization cmdlet runs a Configuration Manager deployment summarization as soon as possible. Summarization compiles information about current deployment of software from the Configuration Manager site database. By default, Configuration Manager runs this summarization every four hours. If you use this cmdlet to create the summarization immediately, it does not interfere with the regular schedule of creating the current summarization.

You can specify a deployment summarization by ID or by collection or you can specify a deployment summarization object.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Invoke a deployment summarization

PS XYZ:\>Invoke-CMDeploymentSummarization -CollectionName "CMWest"

This command runs a deployment summarization for the collection named CMWest.

Parameters

-CollectionId

The Invoke-CMDeploymentSummarization cmdlet runs a Configuration Manager deployment summarization as soon as possible. Summarization compiles information about current deployment of software from the Configuration Manager site database. By default, Configuration Manager runs this summarization every four hours. If you use this cmdlet to create the summarization immediately, it does not interfere with the regular schedule of creating the current summarization.

You can specify a deployment summarization by ID or by collection or you can specify a deployment summarization object.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SearchByCollectionIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionName

Specifies a name of a collection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SearchByCollectionNameMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeploymentId

Specifies an ID of a deployment.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SearchByIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

-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

-InputObject

Specifies a deployment summarization object.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Collection, DeploymentSummary

Parameter sets

SearchByValueMandatory
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareName

The Invoke-CMDeploymentSummarization cmdlet runs a Configuration Manager deployment summarization as soon as possible. Summarization compiles information about current deployment of software from the Configuration Manager site database. By default, Configuration Manager runs this summarization every four hours. If you use this cmdlet to create the summarization immediately, it does not interfere with the regular schedule of creating the current summarization.

You can specify a deployment summarization by ID or by collection or you can specify a deployment summarization object.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
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

System.Object