LogRecord class

Article
05/31/2018

The LogRecord class represents a log entry in the BMC system event log (SEL).

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

[Dynamic, Provider("IPMIPrv"), UUID("{5efd8f2b-e1c7-46c1-a5cc-3aa70779c862}"), AMENDMENT]
class LogRecord : CIM_LogRecord
{
  string   Caption;
  string   Description;
  string   ElementName;
  string   LogCreationClassName;
  string   LogName;
  string   CreationClassName;
  string   RecordID;
  datetime MessageTimestamp;
  string   RecordFormat;
  string   RecordData;
  string   DataFormat;
};

Members

The LogRecord class has these types of members:

Properties

Properties

The LogRecord class has these properties.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

This property is inherited from CIM_LogRecord.

DataFormat

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_LogRecord.RecordFormat")

Note

This property is deprecated. Instead, we recommend that you use the RecordFormat property.

A description of this data structure.

This property is inherited from CIM_LogRecord.

Description

Data type: string
Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information.

Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.

This property is inherited from CIM_ManagedElement.

LogCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_MessageLog.CreationClassName"), MaxLen (256)

The scoping Log's CreationClassName.

This property is inherited from CIM_LogRecord.

LogName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_MessageLog.Name"), MaxLen (256)

The scoping Log's Name.

This property is inherited from CIM_LogRecord.

MessageTimestamp

Data type: datetime
Access type: Read-only
Qualifiers: Key

A LogRecord's Key structure includes a timestamp for the entry.

This property is inherited from CIM_LogRecord.

RecordData

Data type: string
Access type: Read-only
Qualifiers: Experimental, ModelCorrespondence ("CIM_LogRecord.RecordFormat")

A string containing LogRecord data.

If the corresponding RecordFormat property is <empty>, or cannot be parsed according to the recommended format, RecordData should be interpreted as a free-form string. If the RecordFormat property contains parseable format information (as recommended in the RecordFormat Description qualifier), the RecordData string SHOULD be parsed in accordance with this format. In this case, RecordData SHOULD begin with the delimiter character and this character SHOULD be used to separate substrings in the manner described. The RecordData string can then be parsed by the data consumer and appropriately typed.

This property is inherited from CIM_LogRecord.

RecordFormat

Data type: string
Access type: Read-only
Qualifiers: Experimental, ModelCorrespondence ("CIM_LogRecord.RecordData")

A string describing the data structure of the information in the property, RecordData. If the RecordFormat string is <empty>, RecordData should be interpreted as a free-form string.

To describe the data structure of RecordData, the RecordFormat string should be constructed as follows:

- The first character is a delimiter character and is used to parse the remainder of the string into sub-strings.

- Each sub-string is separated by the delimiter character and should be in the form of a CIM property declaration (i.e., datatype and property name). This set of declarations may be used to interpret the similarly delimited RecordData property.

For example, using a '*' delimiter, RecordFormat = "*string ThisDay*uint32 ThisYear*datetime SomeTime"

may be used to interpret: RecordData = "*This is Friday*2002*20020807141000.000000-300".

This property is inherited from CIM_LogRecord.

RecordID

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

RecordID, with the MessageTimestamp property, serve to uniquely identify the LogRecord within a MessageLog. Note that this property is different than the RecordNumber parameters of the MessageLog methods. The latter are ordinal values only, useful to track position when iterating through a Log. On the other hand, RecordID is truly an identifier for an instance of LogRecord. It may be set to the record's ordinal position, but this is not required.

This property is inherited from CIM_LogRecord.

Remarks

The following example shows the relationship between RecordFormat and RecordData for a system event LogRecord instance and an operating system shutdown event LogRecord instance.

System SEL Event

The RecordFormat string is "*string CIM_Sensor.DeviceID*uint8[2] IPMI_RecordID*uint8 IPMI_RecordType*uint8[4] IPMI_Timestamp*uint8[2] IPMI_GeneratorID*uint8 IPMI_EvMRev*uint8 IPMI_SensorType*uint8 IPMI_SensorNumber*boolean IPMI_AssertionEvent*uint8 IPMI_EventType*uint8 IPMI_EventData1*uint8 IPMI_EventData2*uint8 IPMI_EventData3*".

The RecordData string is "*SEL(114.0.32)*01 00*02*0F AC C1 49*20 00*04*10*72*true*6F*02*FF*FF*".

RecordFormat	RecordData	Meaning
string CIM_Sensor.DeviceID*	SEL(114.0.32)	The ID of the sensor device that generated this event is 114.0.32.
*uint8[2] IPMI_RecordID	01 00	The ID of this SEL Record is 1.
*uint8 IPMI_RecordType	02	The record type of this event is "System Event Log".
*uint8[4] IPMI_Timestamp	0F AC C1 49	The event timestamp is 3/19/2009 2:21:03 AM.
*uint8[2] IPMI_GeneratorID	20 00	The ID is an I2C Slave Address, 0x20. This event message was received through the system interface, primary IPMB, or was internally generated by the BMC. The IPMB device LUN is 0x0.
*uint8 IPMI_EvMRev	04	Event Message format version is IPMI v1.5/v2.0.
*uint8 IPMI_SensorType	10	The SensorType code that generated this event is 10,Event Logging Disabled.
*uint8 IPMI_SensorNumber	72	The number of the sensor that generated this event is 114.
*boolean IPMI_AssertionEvent	true	This is an assertion event.
*uint8 IPMI_EventType	6F	The event type of this event is a sensor-specific. The sensor class is discrete.
*uint8 IPMI_EventData1	02	Event request message data.
*uint8 IPMI_EventData2	FF	Event request message data.
*uint8 IPMI_EventData3	FF	Event request message data.

Operating system shutdown SEL event

The RecordFormat string is "*uint8[2] IPMI_RecordID*uint8 IPMI_RecordType*uint8[4] IPMI_Timestamp*uint8[3] IPMI_ManufacturerID*uint8[6] IPMI_OEMDefinedData*".

The RecordData string is "*03 00*DD*7B FE C4 49*37 01 00*00 00 00 00 C0 00".

RecordFormat	RecordData	Meaning
*uint8[2] IPMI_RecordID	03 00	The ID of this SEL Record is 3.
*uint8 IPMI_RecordType	DD	The record type of this event is "Timestamped OEM SEL" record.
*uint8[4] IPMI_Timestamp	7B FE C4 49	The event timestamp is 3/21/2009 2:49:31 PM
*uint8[3] IPMI_ManufacturerID	37 01 00	The manufacturer ID is 311, which is the IANA enterprise number for Microsoft.
*uint8[6] IPMI_OEMDefinedData	00 00 00 00 C0 00	The OEM defined data is a Windows Shutdown Reason: C0000000.

Requirements


Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\hardware
MOF	IpmiPrv.mof
DLL	IpmiPrv.dll

Share via

LogRecord class

Syntax

Members

Properties

Remarks

System SEL Event

Operating system shutdown SEL event

Requirements

See also

Additional resources