SMS_StatusMessage Server WMI Class

  • Article

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

The SMS_StatusMessage Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents individual status messages generated by Configuration Manager to provide information about a variety of events, including process completion, errors, conditions, and user actions.

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

Class SMS_StatusMessage : SMS_BaseClass
{
      String Component;
      String MachineName;
      UInt32 MessageID;
      UInt32 MessageType;
      String ModuleName;
      UInt32 PerClient;
      UInt32 ProcessID;
      UInt32 RecordID;
      UInt32 ReportFunction;
      UInt32 Severity;
      String SiteCode;
      UInt32 SuccessfulTransaction;
      UInt32 ThreadID;
      DateTime Time;
      String TopLevelSiteCode;
      UInt32 Transaction;
      UInt32 Win32Error;
};

Methods

The following table lists the methods in SMS_StatusMessage.

Method Description

DeleteByID Method in Class SMS_StatusMessage

Deletes a group of up to 256 status messages.

DeleteByQuery Method in Class SMS_StatusMessage

Deletes a group of status messages specified by a WMI query language SELECT statement.

RaiseErrorStatusMsg Method in Class SMS_StatusMessage

Creates an error status message.

RaiseInformationalStatusMsg Method in Class SMS_StatusMessage

Creates an informational status message.

RaiseRawStatusMsg Method in Class SMS_StatusMessage

Creates a status message from an external message DLL.

RaiseWarningStatusMsg Method in Class SMS_StatusMessage

Creates a warning status message.

Properties

  • Component
    Data type: String

    Access type: Read/Write

    Qualifiers: [ResID(115), ResDLL("SMS_RSTT.dll")]

    Name of the component that created the message. For user-defined messages, this name comes from the ApplicationName context qualifier that you must set before calling a raise status message method.

  • MachineName
    Data type: String

    Access type: Read/Write

    Qualifiers: [ResID(114), ResDLL("SMS_RSTT.dll")]

    Name of the computer that created the message. For user-defined messages, this name comes from the MachineName context qualifier that you must set before calling a raise status message method.

  • MessageType
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(109), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("MessageType")]

    Type of message. Possible values are:

    256

    Milestone. Use this type at the end of an operation to indicate the operation's success or failure. If the operation was successful, use the Milestone type in an informational message. If the operation failed, use a milestone message type in a warning or error message.

    512

    Detail. Use this type to illustrate the steps in a complex operation. Often, detail messages are meaningful only within the context of the sequence of status messages representing a complex operation.

    768

    Audit. Use this type for informational messages that provides a trail of actions taken by the Configuration Manager administrator. An audit message also depicts an operation that results in objects being added, modified, or deleted. You do not need to create audit messages; the provider automatically generates these messages for you.

    1024

    NTEvent.

  • ModuleName
    Data type: String

    Access type: Read/Write

    Qualifiers: [ResID(102), ResDLL("SMS_RSTT.dll")]

    The DLL that is associated with the status message. This is not the name of the DLL itself, but a display string corresponding to the ModuleName property value defined in the SMS_StatMsgModuleNames Server WMI Class class. You use the ModuleName value to get the DLL name.

  • PerClient
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(108), ResDLL("SMS_RSTT.dll")]

    Value indicating whether the status message was generated by a client component. Possible values are listed below. Messages generated on a per-client basis tend to be quite numerous. Thus, this property provides an easy way to filter them out.

    0

    false

    2

    true

  • ProcessID
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(116), ResDLL("SMS_RSTT.dll")]

    ID of the process that created the message.

  • RecordID
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [key, ResID(101), ResDLL("SMS_RSTT.dll")]

    Unique ID of the status message.

  • ReportFunction
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(105), ResDLL("SMS_RSTT.dll")]

    Report function. Possible values are:

    0

    Report

    16

    BeginTransaction

    32

    CommitSuccessfulTransaction

    48

    CommitFailedTransaction

    64

    RollbackTransaction

    80

    ReportEX

  • Severity
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(103), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("Severity")]

    Type of status message. Possible values are:

    0x40000000 (1073741824)

    Informational

    0x80000000 (2147483648)

    Warning

    0xC0000000

    (3221225472)

    Error

  • SiteCode
    Data type: String

    Access type: Read/Write

    Qualifiers: [SizeLimit("3"), ResID(112), ResDLL("SMS_RSTT.dll")]

    Site code of the site that created the message.

  • SuccessfulTransaction
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(106), ResDLL("SMS_RSTT.dll")]

    Value indicating the transaction status. Possible values are:

    0

    Failed

    8

    Successful

  • ThreadID
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(117), ResDLL("SMS_RSTT.dll")]

    ID of the thread that created the message.

  • Time
    Data type: DateTime

    Access type: Read/Write

    Qualifiers: [ResID(111), ResDLL("SMS_RSTT.dll")]

    Date and time, in Universal Coordinated Time (UTC), when the status message was created.

  • TopLevelSiteCode
    Data type: String

    Access type: Read/Write

    Qualifiers: [SizeLimit("3"), ResID(113), ResDLL("SMS_RSTT.dll")]

    Site code of top site to which the message can be replicated.

  • Transaction
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(107), ResDLL("SMS_RSTT.dll")]

    Value indicating whether transactions are enabled. Possible values are:

    0

    False

    4

    True

  • Win32Error
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(110), ResDLL("SMS_RSTT.dll")]

    Win32 error code associated with the status message.

Remarks

Class qualifiers for this class include:

  • Read (read-only)

  • Secured

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

You can this class to generate user-defined status messages.

Note

Use the SMS_StatMsg Server WMI Class for a high-performance version of this class.

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.

See Also

Concepts

Status Server WMI Classes
SMS_StatMsg Server WMI Class