Status Classes
The status classes allow access to the SMS status system. You can use these classes to create and view status messages and to view status summarizers. The status system indicates the health of an SMS site and the progress of certain actions, such as software distribution. The status system includes two groups of classes:
- Status summarizer classes
- Status reporting classes
For more information on how the SMS status system works, see Using Status Messages, Using Summarizers to Determine the Health of a Site, and the SMS Administrator's Guide.
Status Summarizer Classes
Status summarizer classes summarize the status message data. Most of the summarizers create two views of the messages — a site view and a site hierarchy view. There are three main types of summarized data:
- Advertisement status. These summarizers track the progress of advertised programs as they are advertised and run on the client computers.
- Package status. These summarizers track the progress of packages as they are moved to their assigned distribution points.
- Site status. These summarizers group summaries of two kinds of data:
- Software component health
- Physical system health
Component and advertisement status summaries count the different types of messages generated by components and advertisements. As one way to monitor the health of the system, the user can set system thresholds for specific message types. If messages of a certain type exceed the threshold within a specific time period, it causes the health indicator of the status summary to change.
Site system and package status summaries track the state changes instead of counting the error messages. For example, site system status summaries react to changes in free disk space on a site system. If the free space falls below the threshold you set, the site system's status summary health indicator changes. The package status summaries track such things as how many clients have installed each package.
All the summaries except site system are event-driven summaries. They respond in real time to changes taking place in SMS. Only the site system status summary polls for its information, according to a schedule you can set.
For more information on how to use the summarizer classes, see Using Summarizers to Determine the Health of a Site.
The following is a table of the status summarizer classes.
| Class | Description |
|---|---|
| SMS_AdvertisementStatusRootSummarizer | Tracks the progress of each advertisement as it is advertised and run on the client computers. The reported progress is for all sites in the site hierarchy. |
| SMS_AdvertisementStatusSummarizer | Tracks the progress of each advertisement as it is advertised and run on the client computers. The reported progress is for an individual site. |
| SMS_ComponentSummarizer | Reports on the health of individual software components by tallying the error, warning, and informational status messages produced by each component. |
| SMS_PackageStatusDetailSummarizer | Tracks the progress of each package as it updates its distribution points. The reported progress is for an individual site. |
| SMS_PackageStatusDistPointsSummarizer | Reports the current state of each package as it updates its distribution points. The state is for an individual site. |
| SMS_PackageStatusRootSummarizer | Tracks the progress of each package as it updates its distribution points. The reported progress is for all sites in the site hierarchy. |
| SMS_SiteDetailSummarizer | Provides per site status of components based on message counts and free space. |
| SMS_SiteSystemSummarizer | Provides per site status of SMS roles, such as client access points, the server running Microsoft® SQL Server™, and the site server. The status is based on physical thresholds. |
| SMS_SummarizerRootStatus | Provides the overall status of the site hierarchy. The status is based on component counts and thresholds. |
| SMS_SummarizerSiteStatus | Provides the overall status of an individual site. The status is based on component counts and thresholds. |
| SMS_SummarizerStatus | Describes the registered summarizers, but does not itself describe any summary data. |
Status Reporting Classes
You use the status reporting classes to create your own status messages and to read SMS component status messages. Only SMS component status messages are used by the summarizer classes to determine the current state of sites and SMS components. For more information on how to use status messages, see Using Status Messages.
The following is a table of the status reporting classes.
| Class | Description |
|---|---|
| SMS_StatMsgAttributes | Represents attributes that provide additional information about the event on which the status message is reporting. |
| SMS_StatMsgInsStrings | Represents details to be inserted into a status message that contains insertion points. |
| SMS_StatMsgModuleNames | Associates a ModuleName value with a message DLL. The message DLL contains the message text. |
| SMS_StatusMessage | Represents individual status messages generated by the SMS server to provide information about a variety of events, including process completion, errors, conditions, and user actions. |