Edit

Share via


Set-CMStatusSummarizer

Modifies settings of a Configuration Manager status summarizer.

Syntax

SetComponentStatusSummarizer (Default)

Set-CMStatusSummarizer
    [-ComponentStatusSummarizer]
    [-EnableStatusSummarizer <Boolean>]
    [-PassThru]
    [-ReplicateToParentSite <Boolean>]
    [-ReplicationPriority <ReplicationPriorityType>]
    [-SiteCode <String>]
    [-TimeThreshold <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetAppDeploymentSummarizer

Set-CMStatusSummarizer
    [-ApplicationDeploymentSummarizer]
    [-Days <Int32>]
    [-Hours <Int32>]
    [-Minutes <Int32>]
    [-PassThru]
    [-SiteCode <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetAppStatisticsSummarizer

Set-CMStatusSummarizer
    [-ApplicationStatisticSummarizer]
    [-Days <Int32>]
    [-Hours <Int32>]
    [-Minutes <Int32>]
    [-PassThru]
    [-SiteCode <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetSiteSystemStatusSummarizer

Set-CMStatusSummarizer
    [-CriticalSizeKB <Int32>]
    [-EnableStatusSummarizer <Boolean>]
    [-PassThru]
    [-ReplicateToParentSite <Boolean>]
    [-ReplicationPriority <ReplicationPriorityType>]
    [-Schedule <IResultObject>]
    [-SiteCode <String>]
    [-SiteSystemStatusSummarizer]
    [-WarningSizeKB <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMStatusSummarizer cmdlet modifies settings of a status summarizer. The Configuration Manager status summarizers apply to the areas of application deployment, application statistics, component status, and site system status.

Note

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

Examples

Example 1: Modify a status summarizer

PS XYZ:\> Set-CMStatusSummarizer -ApplicationDeploymentSummarizer -SiteCode "ContosoSite"

This command configures the status summarizer for the Contoso site to return application deployment statistics.

Parameters

-ApplicationDeploymentSummarizer

Indicates that the summarizer is an application deployment status summarizer.

Parameter properties

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

Parameter sets

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

-ApplicationStatisticSummarizer

Indicates that the summarizer is an application statistic status summarizer.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ApplicationStatisticsSummarizer

Parameter sets

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

-ComponentStatusSummarizer

Indicates that the summarizer is a component status summarizer.

Parameter properties

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

Parameter sets

SetComponentStatusSummarizer
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

-CriticalSizeKB

Specifies the threshold, in kilobytes, of free space for a Critical message. This parameter applies to site system status summarizers.

Parameter properties

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

Parameter sets

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

-Days

The Set-CMStatusSummarizer cmdlet modifies settings of a status summarizer. The Configuration Manager status summarizers apply to the areas of application deployment, application statistics, component status, and site system status.

Note

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DayInterval

Parameter sets

SetAppDeploymentSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetAppStatisticsSummarizer
Position:Named
Mandatory:False
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

-EnableStatusSummarizer

Indicates whether to enable Configuration Manager to summarize status messages for the site. This parameter applies to component status summarizers and site system status summarizers.

Parameter properties

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

Parameter sets

SetComponentStatusSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetSiteSystemStatusSummarizer
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

-Hours

The Set-CMStatusSummarizer cmdlet modifies settings of a status summarizer. The Configuration Manager status summarizers apply to the areas of application deployment, application statistics, component status, and site system status.

Note

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:HourInterval

Parameter sets

SetAppDeploymentSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetAppStatisticsSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Minutes

The Set-CMStatusSummarizer cmdlet modifies settings of a status summarizer. The Configuration Manager status summarizers apply to the areas of application deployment, application statistics, component status, and site system status.

Note

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MinuteInterval

Parameter sets

SetAppDeploymentSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetAppStatisticsSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

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

-ReplicateToParentSite

Indicates whether to pass summarization data from this site to its parent site. This parameter applies to component status summarizers and site system status summarizers. If you specify a value of $True for this parameter, specify a priority by using the ReplicationPriority parameter and a threshold period by using the ThresholdPeriod parameter.

Parameter properties

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

Parameter sets

SetComponentStatusSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetSiteSystemStatusSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationPriority

Specifies the priority of replication to the parent site. The acceptable values for this parameter are: Low, Normal, and High. Specify this parameter if you specify $True for the ReplicateToParentSite parameter.

Parameter properties

Type:ReplicationPriorityType
Default value:None
Accepted values:Low, Normal, High
Supports wildcards:False
DontShow:False

Parameter sets

SetComponentStatusSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetSiteSystemStatusSummarizer
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Schedule

Specifies a schedule object that determines how often to summarize site system status. To obtain a schedule object, use the New-CMSchedule cmdlet.

Parameter properties

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

Parameter sets

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

-SiteCode

Specifies the site code for a Configuration Manager site.

Parameter properties

Type:String
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

-SiteSystemStatusSummarizer

Indicates that the summarizer is a site system status summarizer.

Parameter properties

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

Parameter sets

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

-TimeThreshold

The Set-CMStatusSummarizer cmdlet modifies settings of a status summarizer. The Configuration Manager status summarizers apply to the areas of application deployment, application statistics, component status, and site system status.

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
Accepted values:Since 0:00:00, Since 4:00:00, Since 8:00:00, Since 12:00:00, Since 16:00:00, Since 20:00:00, Since Sunday, Since Monday, Since Tuesday, Since Wednesday, Since Thursday, Since Friday, Since Saturday, Since 15th of the Month, Since 1st of the Month, Since Site Installation
Supports wildcards:False
DontShow:False
Aliases:ThresholdPeriod

Parameter sets

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

-WarningSizeKB

Specifies the threshold, in kilobytes, of free space for a Warning message. This parameter applies to site system status summarizers.

Parameter properties

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

Parameter sets

SetSiteSystemStatusSummarizer
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

None