SMS_ComponentSummarizer Server WMI Class

The SMS_ComponentSummarizer Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a component summarizer that reports on the health of individual Configuration Manager components.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.

Syntax

Class SMS_ComponentSummarizer : SMS_BaseClass  
{  
      UInt32 AvailabilityState;  
      String ComponentName;  
      String ComponentType;  
      UInt32 Errors;  
      UInt32 HeartbeatInterval;  
      UInt32 Infos;  
      DateTime LastContacted;  
      DateTime LastHeartbeat;  
      DateTime LastStarted;  
      String MachineName;  
      DateTime NextScheduledTime;  
      String SiteCode;  
      UInt32 State;  
      UInt32 Status;  
      String TallyInterval;  
      UInt32 Type;  
      UInt32 Warnings;  
};  

Methods

The following table lists the methods in SMS_ComponentSummarizer.

Method	Description
DeleteStatistics Method in Class SMS_ComponentSummarizer	Deletes statistics reported by the component summarizer.

Properties

AvailabilityState
Data type: UInt32

Access type: Read

Qualifiers: None

Availability state of the component. The default value is 0.

ComponentName
Data type: String

Access type: Read

Qualifiers: [key, SizeLimit("40")]

Name of the Configuration Manager component.

ComponentType
Data type: String

Access type: Read

Qualifiers: None

The component type.

Errors
Data type: UInt32

Access type: Read

Qualifiers: None

Count of all error status messages reported by the component during the tally interval.

HeartbeatInterval
Data type: UInt32

Access type: Read

Qualifiers: [key]

The heartbeat interval.

Infos
Data type: UInt32

Access type: Read

Qualifiers: None

Count of all informational status messages reported by the component during the tally interval.

LastContacted
Data type: DateTime

Access type: Read

Qualifiers: None

Date and time of when a status message was last received from the component. The time zone is based on the time zone of the site specified in the SiteCode property.

LastHeartbeat
Data type: DateTime

Access type: Read

Qualifiers: None

Date and time of the last heartbeat.

LastStarted
Data type: DateTime

Access type: Read

Qualifiers: None

Date and time when the component last started. The time zone is based on the time zone of the site specified in the SiteCode property.

MachineName
Data type: String

Access type: Read

Qualifiers: [key]

Name of the computer on which the component is installed. Some components might run on computers other than the site server.

NextScheduledTime
Data type: DateTime

Access type: Read

Qualifiers: None

Date and time when the component is next scheduled to start, if the component runs according to a schedule. The time zone is based on the time zone of the SiteCode property.

SiteCode
Data type: String

Access type: Read

Qualifiers: [key, SizeLimit("3")]

Site code of the Configuration Manager site to which the component is related.

State
Data type: UInt32

Access type: Read

Qualifiers: None

State of the component. Possible values are:

Value	State
0	STOPPED
1	STARTED
2	PAUSED
3	INSTALLING
4	RE_INSTALLING
5	DE_INSTALLING

Status
Data type: UInt32

Access type: Read

Qualifiers: None

Status value indicating the health of the component. Possible values are:

Value	Status
GREEN(0)	OK. There are no warning or error messages.
YELLOW(1)	Warning. Warning messages were generated, but not error messages.
RED(2)	Critical. There are error messages.

TallyInterval
Data type: String

Access type: Read

Qualifiers: [key]

Interval or time period for which the statistics apply. You must specify a tally interval in the WHERE clause to query instances of this class. The statistics are reset to zero each time the schedule elapses. To use this property, see How to Read The Tally Intervals For a Configuration Manager Site.

Type
Data type: UInt32

Access type: Read

Qualifiers: None

Type of component, for example, one that autostarts (runs continuously). Possible values are:

Value	Type
0	AUTOSTARTING
1	SCHEDULED
2	MANUAL

Warnings
Data type: UInt32

Access type: Read

Qualifiers: None

Count of all warning status messages reported by the component during the tally interval.

Remarks

Class qualifiers for this class include:

• Read (read-only)

  For more information about both the class qualifiers and the property qualifiers included in the Properties section, see Configuration Manager Class and Property Qualifiers.

  This class reports on component health by counting the error, warning, and informational status messages that are produced by each component. It provides a high-level view of the health of server components at a given site. An instance of this class is created for each server component running in the site.

  Queries must include a TallyInterval value.

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.