Class AMT_EventLogEntry

Used in features: Event Manager & User Notification
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.16.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0
CIM_ManagedElement
   extended by CIM_RecordForLog
      extended by CIM_LogEntry
         extended by AMT_EventLogEntry


class AMT_EventLogEntry
extends CIM_LogEntry

General Information:
The LogRecord object can describe the definitional format for entries in a MessageLog, or can be used to instantiate the actual records in the Log. The latter approach provides a great deal more semantic definition and management control over the individual entries in a MessageLog, than do the record manipulation methods of the Log class. It is recommended that the data in individual Log entries be modeled using subclasses of LogRecord, to avoid the creation of LogRecords with one property (such as RecordData) without semantics. Definitional formats for LogRecords could be specified by establishing a naming convention for the RecordID and Message Timestamp key properties.

Product Specific Usage:
 Use of this class was deprecated In Intel AMT Release 3.2. It was deleted starting in Release 6.0 and restored in 6.1.
The class is still deprecated.


Qualifiers:
-------------
Version=3.0.0
Deprecated={AMT_MessageLog}


Supported Fields Summary
 datetime CreationTimeStamp
A LogEntry may include a timestamp for the entry.
 string RecordID
RecordID may be used to provide a representation of log entry ordering or pointers/handles for log entries.
 string LogName
The containing Log's Name . . .
 string InstanceID Key
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class . . .
 string ElementName
A user-friendly name for the object . . .
 string RecordFormat
A string describing the data structure of the information in the property, RecordData . . .
 string RecordData
A string containing LogRecord data . . .
 uint8 DeviceAddress
The SMBus address of the physical sensor device that implements the logical sensor.
 uint8 EventSensorType
The value to be set into the alert's Event Sensor Type field (see [PET] for definitions.)
 uint8 EventType
The value to be set into the alert's Event Type field (see [PET] for definitions.)
 uint8 EventOffset
The value to be set into the alert's Event Offset field (see [PET] for definitions.)
 uint8 EventSourceType
The value to be set into the alert's Event Source Type field (see [PET] for definitions.)
 uint8 EventSeverity
This field can be used to fill in the Event Severity field in a PET alert . . .
 uint8 SensorNumber
The value to be set into the alert's Sensor Number field (see [PET] for definitions.)
 uint8 Entity
The value to be set into the alert's Entity field (see [PET] for definitions.)
 uint8 EntityInstance
The value to be set into the alert's Entity Instance field (see [PET] for definitions.)
 uint8[8] EventData
Describes optional event data sent in the PET packet . . .

Methods Summary
  Get(Instance)
Gets the representation of the instance
  Pull(EnumerationContext, MaxElements)
Pulls instances of this class, following an Enumerate operation
  Enumerate()
Enumerates the instances of this class
  Release(EnumerationContext)
Releases an enumeration context

Field Detail

CreationTimeStamp

public datetime CreationTimeStamp
General Information:
A LogEntry may include a timestamp for the entry.

Product Specific Usage:
Additional Notes:
1) In Intel AMT Release 5.0 and earlier releases 'CreationTimeStamp' is set to "Invalid Time" string if the creation timestamp is invalid. in Intel AMT Release 5.1 and later releases 'CreationTimeStamp' is set to NULL if it's invalid.
2) In Intel AMT Release 5.0 and earlier releases 'datetime' format is simple string. In Intel AMT Release 5.1 and later releases 'datetime' format is as defined in DSP0230 'DMTF WS-CIM Mapping Specification'.


RecordID

public string RecordID
General Information:
RecordID may be used to provide a representation of log entry ordering or pointers/handles for log entries.

Qualifiers:
-------------
MaxLen=10


LogName

public string LogName
General Information:
The containing Log's Name. This property is available for backwards continuity with CIM_LogRecord.

Qualifiers:
-------------
MaxLen=28


InstanceID Key

public string InstanceID
General Information:
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=50


ElementName

public string ElementName
General Information:
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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

Qualifiers:
-------------
MaxLen=28


RecordFormat

public string RecordFormat
General Information:
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".

Qualifiers:
-------------
ModelCorrespondence={CIM_RecordForLog.RecordData}
MaxLen=35


RecordData

public string RecordData
General Information:
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.

Qualifiers:
-------------
ModelCorrespondence={CIM_RecordForLog.RecordFormat}
MaxLen=256


DeviceAddress

public uint8 DeviceAddress
General Information:
The SMBus address of the physical sensor device that implements the logical sensor.


EventSensorType

public uint8 EventSensorType
General Information:
The value to be set into the alert's Event Sensor Type field (see [PET] for definitions.)


EventType

public uint8 EventType
General Information:
The value to be set into the alert's Event Type field (see [PET] for definitions.)


EventOffset

public uint8 EventOffset
General Information:
The value to be set into the alert's Event Offset field (see [PET] for definitions.)


EventSourceType

public uint8 EventSourceType
General Information:
The value to be set into the alert's Event Source Type field (see [PET] for definitions.)


EventSeverity

public uint8 EventSeverity
General Information:
This field can be used to fill in the Event Severity field in a PET alert. The severity values are based on the 'DMI' severity values used for the generic sensor event/reading type code.

Qualifiers:
-------------
ValueMap={0, 1, 2, 4, 8, 16, 32}
Values={unspecified, Monitor, Information, OK, Non-critical condition, Critical condition, Non-recoverable condition}


SensorNumber

public uint8 SensorNumber
General Information:
The value to be set into the alert's Sensor Number field (see [PET] for definitions.)


Entity

public uint8 Entity
General Information:
The value to be set into the alert's Entity field (see [PET] for definitions.)


EntityInstance

public uint8 EntityInstance
General Information:
The value to be set into the alert's Entity Instance field (see [PET] for definitions.)


EventData

public uint8[8] EventData
General Information:
Describes optional event data sent in the PET packet. The values are defined in the ASF specification [ASF].


Method Detail

Get

public  Get([OUT]AMT_EventLogEntry Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_EVENT_MANAGER_REALM, ADMIN_SECURITY_EVENT_LOG_READER_REALM, ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets the representation of the instance

Product Specific Usage:
Additional Notes:
1) In Intel AMT Release 4.0 and earlier releases 'datetime' format is simple string. In Intel AMT Release 5.1 and later releases 'datetime' format is as defined in DSP0230 'DMTF WS-CIM Mapping Specification'.

Pull

public  Pull([IN]String EnumerationContext, [IN]String MaxElements)
Permission Information:
All users permitted to use method, only instances to whom the user has permissions will be returned

General Information:
Pulls instances of this class, following an Enumerate operation

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

Release

public  Release([IN]String EnumerationContext)
Permission Information:
All users permitted to use method

General Information:
Releases an enumeration context

Copyright © 2006-2022, Intel Corporation. All rights reserved.