SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class AMT_MessageLog

Used in features: Event Manager & User Notification
Compatible with the following Intel AMT Releases: 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Log
               extended by CIM_MessageLog
                  extended by AMT_MessageLog


class AMT_MessageLog
 extends CIM_MessageLog


General Information:
Extends MessageLog with multiple record 
fetching

Product Specific Usage:
This class implements an 
alternate method for accessing the event log. 
Client should read the record 
time parameter in order to determine which record is newer. 
In most 
implementations, log entries are stored backwards, i.e. the newest record is the 
first record and the oldest record is the last (index based). 

Records 
have no header and the record data is combined of 21 binary bytes which could be 
read as: 

struct { 
UINT32 TimeStamp; // little endian 
UINT8 
DeviceAddress; 
UINT8 EventSensorType; 
UINT8 EventType; 
UINT8 
EventOffset; 
UINT8 EventSourceType; 
UINT8 EventSeverity; 
UINT8 
SensorNumber; 
UINT8 Entity; 
UINT8 EntityInstance; 
UINT8 
EventData[8]; 

} EVENT_DATA; 



Qualifiers:
-------------
Version=6.0.0









  
  

    Supported Fields 
      Summary

  

     uint16 
      
    CharacterSet 
An 
      enumeration describing the character set used to record data in the 
      individual Log entries . . .

  

     boolean 
      
    IsFrozen 
Boolean 
      indicating that the Log is currently frozen and modifications are not 
      allowed.

  

     uint16 
      
    LastChange 
An 
      enumeration describing the last change to the MessageLog.

  

     uint8 
      
    PercentageNearFull 
      
If the OverwritePolicy is based on clearing records when the 
      Log is near full (value=3), this property defines the record capacity (in 
      percentage) that is considered to be 'near full'.

  

     uint16 
      
    OverwritePolicy 
      
An enumeration describing the behavior of the Log, when it 
      becomes full or near full . . .

  

     uint64 
      
    SizeOfRecordHeader 
      
The size of the header for the Log's individual entries, in 
      bytes, if record headers are defined . . .

  

     uint64 
      
    MaxRecordSize 
      
Maximum size, in bytes, to which an individual Log entry 
      (record) can grow - if the Capabilities array includes a value of 7 
      ("Variable Length Records Supported") . . .

  

     uint64 
      
    SizeOfHeader 
The 
      size of the Log header, in bytes, if one is present . . .

  

     uint64 
      
    MaxLogSize 
The 
      maximum size, in bytes, to which the Log can grow . . .

  

     uint16[4] 
      
    Capabilities 
An 
      array of integers indicating the Log capabilities . . .

  

     string 
      
    Name Key  
The inherited Name serves as part of the key (a 
      unique identifier) for the MessageLog instance.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     uint16 
      
    EnabledDefault 
      
An enumerated value indicating an administrator's default or 
      startup configuration for the Enabled State of an element . . .

  

     uint16 
      
    RequestedState 
      
RequestedState is an integer enumeration that indicates the 
      last requested or desired state for the element, irrespective of the 
      mechanism through which it was requested . . .

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states of an element . . .

  

     uint16 
      
    HealthState 
      
Indicates the current health of the element . . .

  

     string 
      
    Status 
A string 
      indicating the current status of the object . . .

  

     uint16[] 
      
    OperationalStatus 
      
Indicates the current statuses of the element . . .

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     uint64 
      
    MaxNumberOfRecords 
      
Maximum number of records that can be captured in the Log . . 
      .

  

     uint64 
      
    CurrentNumberOfRecords 
      
Current number of records in the Log.

  

     uint16 
      
    LogState 
LogState is 
      an integer enumeration that indicates the current state of a log 
      represented by CIM_Log subclasses . . .




  
  

    Methods Summary

  

     uint32
    CancelIteration(IterationIdentifier) 
      
Requests that an iteration of the Log, identified by the 
      IterationIdentifier input parameter, be stopped . . .

  

     uint32
    RequestStateChange(RequestedState, REF 
      Job, TimeoutPeriod) 
Requests that the state of the element be 
      changed to the value specified in the RequestedState parameter . . 
.

  

     uint32
    ClearLog() 
Requests 
      that the Log be cleared of all entries . . .

  

     uint32
    GetRecords(IterationIdentifier, 
      MaxReadRecords, NoMoreRecords, RecordArray) 
Retrieves multiple 
      records from event log

  

     uint32
    GetRecord(IterationIdentifier, 
      PositionToNext, RecordNumber, RecordData) 
Requests that the 
      record indicated by the IterationIdentifier be retrieved from the 
      MessageLog . . .

  

     uint32
    PositionAtRecord(IterationIdentifier, 
      MoveAbsolute, RecordNumber) 
Requests that the Log's iteration 
      identifier be advanced or retreated a specific number of records, or set 
      to the entry at a specified numeric location . . .

  

     uint32
    PositionToFirstRecord(IterationIdentifier) 
      
Requests that an iteration of the MessageLog be established and that 
      the iterator be set to the first entry in the Log . . .

  

     uint32
    FreezeLog(Freeze) 
      
Requests that the MessageLog be placed in a frozen state ("Freeze" 
      input parameter = TRUE) or 'unfrozen' (= FALSE) . . .

  

     
    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


CharacterSet 
public uint16 CharacterSet



  
General Information:
An enumeration describing the character set 
  used to record data in the individual Log entries. For example, the Log 
  records may contain ASCII data (value=2), or be raw octet strings 
  (value=10).

Qualifiers:
-------------
ValueMap={0, 1, 2, 
  3, 4, 5, 6, 7, 8, 9, 10, 11}
Values={Unknown, Other, ASCII, Unicode, 
  ISO2022, ISO8859, Extended UNIX Code, UTF-8, UCS-2, Bitmapped Data, 
  OctetString, Defined by Individual Records}


  

  





IsFrozen 
public boolean IsFrozen



  
General Information:
Boolean indicating that the Log is 
  currently frozen and modifications are not allowed.

  

  





LastChange 
public uint16 LastChange



  
General Information:
An enumeration describing the last change 
  to the MessageLog.

Qualifiers:
-------------
ValueMap={0, 
  1, 2, 3, 4}
Values={Unknown, Add, Delete, Modify, Log Cleared}


  

  





PercentageNearFull 
public uint8 PercentageNearFull



  
General Information:
If the OverwritePolicy is based on clearing 
  records when the Log is near full (value=3), this property defines the record 
  capacity (in percentage) that is considered to be 'near 
  full'.

Qualifiers:
-------------
Units=Percent
ModelCorrespondence={CIM_MessageLog.OverwritePolicy}


  

  





OverwritePolicy 
public uint16 OverwritePolicy



  
General Information:
An enumeration describing the behavior of 
  the Log, when it becomes full or near full. For example, the Log may wrap 
  (value=2) or may simply stop recording entries (value =7). 

Some of the 
  property's possible values need further explanation: 
3="Clear When Near 
  Full" indicates that all of the Log's entries will be deleted when a specified 
  record capacity is reached. The capacity is specified in percentage, using the 
  property, PercentageNearFull. 'Near Full' may be less than 100% if the Log 
  takes time to clear, and a position should always be available for new 
  records. 
4="Overwrite Outdated When Needed" describes that Log entries 
  (timestamped later than the date/time specified in the property, 
  TimeWhenOutdated) can be overwritten. 
5="Remove Outdated Records" 
  specifies that records (timestamped later than the date/time specified in the 
  property, TimeWhenOutdated) are logically and/or physically removed from the 
  Log. 
6="Overwrite Specific Records" indicates that specially flagged 
  records may be overwritten. This property only makes sense when the 
  Capabilities array includes a value of 10, "Can Flag Records for 
  Overwrite".

Qualifiers:
-------------
Override=OverwritePolicy
ValueMap={0, 
  1, 2, 3, 4, 5, 6, 7}
Values={Unknown, Other, Wraps When Full, Clear When 
  Near Full, Overwrite Outdated When Needed, Remove Outdated Records, Overwrite 
  Specific Records, Never 
  Overwrite}
ModelCorrespondence={CIM_MessageLog.OtherPolicyDescription, 
  CIM_MessageLog.TimeWhenOutdated, CIM_MessageLog.PercentageNearFull}


  

  





SizeOfRecordHeader 
public uint64 SizeOfRecordHeader



  
General Information:
The size of the header for the Log's 
  individual entries, in bytes, if record headers are defined. If there are no 
  record headers, then this property should be set to 0. Record headers may 
  include information such as the type of the Log entry, the date/time that the 
  entry was last updated, or a pointer to the start of optional data. Note that 
  this property defines the header size for individual records in the Log, while 
  the SizeOfHeader property describes the Log's overall header, typically 
  located at the start of the 
  MessageLog.

Qualifiers:
-------------
Units=Bytes


  

  





MaxRecordSize 
public uint64 MaxRecordSize



  
General Information:
Maximum size, in bytes, to which an 
  individual Log entry (record) can grow - if the Capabilities array includes a 
  value of 7 ("Variable Length Records Supported"). If the Capabilities array 
  does not include a 7, then the Log only supports fixed length entries. The 
  size of these entries is described by this 
  property.

Qualifiers:
-------------
Units=Bytes


  

  





SizeOfHeader 
public uint64 SizeOfHeader



  
General Information:
The size of the Log header, in bytes, if 
  one is present. If there is no Log header, then this property should be set to 
  0. Headers may include general information about the Log such as the current 
  number of records, time of last update, or a pointer to the location of the 
  first Log entry. Note that this property is NOT the size of the header for an 
  individual Log entry. The latter is described by the property, 
  SizeOfRecordHeader.

Qualifiers:
-------------
Units=Bytes


  

  





MaxLogSize 
public uint64 MaxLogSize



  
General Information:
The maximum size, in bytes, to which the 
  Log can grow. If there is no maximum, then MaxLogSize should be set to 
  0.

Qualifiers:
-------------
Units=Bytes


  

  





Capabilities 
public uint16[4] Capabilities



  
General Information:
An array of integers indicating the Log 
  capabilities. Information such as "Write Record Supported" (value= 2) or 
  "Variable Length Records Supported" (8) is specified in this 
  property.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8, 9, 10}
Values={Unknown, Other, Write Record Supported, 
  Delete Record Supported, Can Move Backward in Log, Freeze Log Supported, Clear 
  Log Supported, Supports Addressing by Ordinal Record Number, Variable Length 
  Records Supported, Variable Formats for Records, Can Flag Records for 
  Overwrite}
ArrayType=Indexed
ModelCorrespondence={CIM_MessageLog.CapabilitiesDescriptions}


  

  





Name Key 
public string Name



  
General Information:
The inherited Name serves as part of the 
  key (a unique identifier) for the MessageLog instance.

Product 
  Specific Usage:
In Intel AMT Release 6.0 and later releases value is 
  "Intel(r) AMT:MessageLog 
  1"

Qualifiers:
-------------
Key
Override=Name
MaxLen=256


  

  





CreationClassName Key 
public string CreationClassName



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

Product Specific 
  Usage:
In Intel AMT Release 6.0 and later releases value is 
  "AMT_MessageLog"

Qualifiers:
-------------
Key
MaxLen=256


  

  





EnabledDefault 
public uint16 EnabledDefault



  
General Information:
An enumerated value indicating an 
  administrator's default or startup configuration for the Enabled State of an 
  element. By default, the element is "Enabled" 
  (value=2).

Qualifiers:
-------------
Write
ValueMap={2, 
  3, 5, 6, 7, 9, .., 32768..65535}
Values={Enabled, Disabled, Not Applicable, 
  Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor 
  Reserved}


  

  





RequestedState 
public uint16 RequestedState



  
General Information:
RequestedState is an integer enumeration 
  that indicates the last requested or desired state for the element, 
  irrespective of the mechanism through which it was requested. The actual state 
  of the element is represented by EnabledState. This property is provided to 
  compare the last requested and current enabled or disabled states. Note that 
  when EnabledState is set to 5 ("Not Applicable"), then this property has no 
  meaning. Refer to the EnabledState property description for explanations of 
  the values in the RequestedState enumeration. 
"Unknown" (0) indicates the 
  last requested state for the element is unknown.
Note that the value "No 
  Change" (5) has been deprecated in lieu of indicating the last requested state 
  is "Unknown" (0). If the last requested or desired state is unknown, 
  RequestedState should have the value "Unknown" (0), but may have the value "No 
  Change" (5).Offline (6) indicates that the element has been requested to 
  transition to the Enabled but Offline EnabledState. 
It should be noted 
  that there are two new values in RequestedState that build on the statuses of 
  EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing 
  a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the 
  element is first "Disabled" and then "Enabled". The distinction between 
  requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests 
  an orderly transition to the Disabled state, and might involve removing power, 
  to completely erase any existing state. The Disabled state requests an 
  immediate disabling of the element, such that it will not execute or accept 
  any commands or processing requests. 

This property is set as the 
  result of a method invocation (such as Start or StopService on CIM_Service), 
  or can be overridden and defined as WRITEable in a subclass. The method 
  approach is considered superior to a WRITEable property, because it allows an 
  explicit invocation of the operation and the return of a result code. 
  

If knowledge of the last RequestedState is not supported for the 
  EnabledLogicalElement, the property shall be NULL or have the value 12 "Not 
  Applicable".

Qualifiers:
-------------
ValueMap={0, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled, 
  Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, 
  Reset, Not Applicable, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
EnabledState is an integer enumeration that 
  indicates the enabled and disabled states of an element. It can also indicate 
  the transitions between these requested states. For example, shutting down 
  (value=4) and starting (value=10) are transient states between enabled and 
  disabled. The following text briefly summarizes the various enabled and 
  disabled states: 
Enabled (2) indicates that the element is or could be 
  executing commands, will process any queued commands, and queues new requests. 
  
Disabled (3) indicates that the element will not execute commands and will 
  drop any new requests. 
Shutting Down (4) indicates that the element is in 
  the process of going to a Disabled state. 
Not Applicable (5) indicates the 
  element does not support being enabled or disabled. 
Enabled but Offline 
  (6) indicates that the element might be completing commands, and will drop any 
  new requests. 
Test (7) indicates that the element is in a test state. 
  
Deferred (8) indicates that the element might be completing commands, but 
  will queue any new requests. 
Quiesce (9) indicates that the element is 
  enabled but in a restricted mode.
Starting (10) indicates that the element 
  is in the process of going to an Enabled state. New requests are 
  queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, 
  Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In 
  Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  





HealthState 
public uint16 HealthState



  
General Information:
Indicates the current health of the 
  element. This attribute expresses the health of this element but not 
  necessarily that of its subcomponents. The possible values are 0 to 30, where 
  5 means the element is entirely healthy and 30 means the element is completely 
  non-functional. The following continuum is defined: 
"Non-recoverable 
  Error" (30) - The element has completely failed, and recovery is not possible. 
  All functionality provided by this element has been lost. 
"Critical 
  Failure" (25) - The element is non-functional and recovery might not be 
  possible. 
"Major Failure" (20) - The element is failing. It is possible 
  that some or all of the functionality of this component is degraded or not 
  working. 
"Minor Failure" (15) - All functionality is available but some 
  might be degraded. 
"Degraded/Warning" (10) - The element is in working 
  order and all functionality is provided. However, the element is not working 
  to the best of its abilities. For example, the element might not be operating 
  at optimal performance or it might be reporting recoverable errors. 
"OK" 
  (5) - The element is fully functional and is operating within normal 
  operational parameters and without error. 
"Unknown" (0) - The 
  implementation cannot report on HealthState at this time. 
DMTF has 
  reserved the unused portion of the continuum for additional HealthStates in 
  the future.

Qualifiers:
-------------
ValueMap={0, 5, 10, 
  15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning, 
  Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF 
  Reserved, Vendor Specific}


  

  





Status 
public string Status



  
General Information:
A string indicating the current status of 
  the object. Various operational and non-operational statuses are defined. This 
  property is deprecated in lieu of OperationalStatus, which includes the same 
  semantics in its enumeration. This change is made for 3 reasons: 
1) Status 
  is more correctly defined as an array. This definition overcomes the 
  limitation of describing status using a single value, when it is really a 
  multi-valued property (for example, an element might be OK AND Stopped. 
2) 
  A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 
  
3) The change to a uint16 data type was discussed when CIM V2.0 was 
  defined. However, existing V1.0 implementations used the string property and 
  did not want to modify their code. Therefore, Status was grandfathered into 
  the Schema. Use of the deprecated qualifier allows the maintenance of the 
  existing property, but also permits an improved definition using 
  OperationalStatus.

Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK, 
  Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, 
  NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10


  

  





OperationalStatus 
public uint16[] OperationalStatus



  
General Information:
Indicates the current statuses of the 
  element. Various operational statuses are defined. Many of the enumeration's 
  values are self-explanatory. However, a few are not and are described here in 
  more detail. 
"Stressed" indicates that the element is functioning, but 
  needs attention. Examples of "Stressed" states are overload, overheated, and 
  so on. 
"Predictive Failure" indicates that an element is functioning 
  nominally but predicting a failure in the near future. 
"In Service" 
  describes an element being configured, maintained, cleaned, or otherwise 
  administered. 
"No Contact" indicates that the monitoring system has 
  knowledge of this element, but has never been able to establish communications 
  with it. 
"Lost Communication" indicates that the ManagedSystem Element is 
  known to exist and has been contacted successfully in the past, but is 
  currently unreachable. 
"Stopped" and "Aborted" are similar, although the 
  former implies a clean and orderly stop, while the latter implies an abrupt 
  stop where the state and configuration of the element might need to be 
  updated. 
"Dormant" indicates that the element is inactive or quiesced. 
  
"Supporting Entity in Error" indicates that this element might be "OK" but 
  that another element, on which it is dependent, is in error. An example is a 
  network service or endpoint that cannot function due to lower-layer networking 
  problems. 
"Completed" indicates that the element has completed its 
  operation. This value should be combined with either OK, Error, or Degraded so 
  that a client can tell if the complete operation Completed with OK (passed), 
  Completed with Error (failed), or Completed with Degraded (the operation 
  finished, but it did not complete OK or did not report an error). 
"Power 
  Mode" indicates that the element has additional power model information 
  contained in the Associated PowerManagementService association. 
  
"Relocating" indicates the element is being 
  relocated.
OperationalStatus replaces the Status property on 
  ManagedSystemElement to provide a consistent approach to enumerations, to 
  address implementation needs for an array property, and to provide a migration 
  path from today's environment to the future. This change was not made earlier 
  because it required the deprecated qualifier. Due to the widespread use of the 
  existing Status property in management applications, it is strongly 
  recommended that providers or instrumentation provide both the Status and 
  OperationalStatus properties. Further, the first value of OperationalStatus 
  should contain the primary status for the element. When instrumented, Status 
  (because it is single-valued) should also provide the primary status of the 
  element.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 
  0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive 
  Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In 
  Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity 
  in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor 
  Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


  

  





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=256


  

  





MaxNumberOfRecords 
public uint64 MaxNumberOfRecords



  
General Information:
Maximum number of records that can be 
  captured in the Log. If undefined, a value of zero should be specified.

  

  





CurrentNumberOfRecords 
public uint64 CurrentNumberOfRecords



  
General Information:
Current number of records in the 
  Log.

Qualifiers:
-------------
Gauge


  

  





LogState 
public uint16 LogState



  
General Information:
LogState is an integer enumeration that 
  indicates the current state of a log represented by CIM_Log subclasses. 
  LogState is to be used in conjunction with the EnabledState property to fully 
  describe the current state of the log. The following text briefly summarizes 
  the various log states: 
Unknown (0) indicates the state of the log is 
  unknown. 
Normal (2) indicates that the log is or could be executing 
  logging commands, will process any queued log entries, and will queue new 
  logging requests. 
Erasing (3) indicates that the log is being erased. 
  
Not Applicable (4) indicates the log does not support representing a log 
  state.

Product Specific Usage:
Additional Notes: 
1) 
  'LogState' property is supported in Intel AMT Release 4.0 and later 
  releases.

Qualifiers:
-------------
ValueMap={0, 2, 3, 4, 
  .., 32768..65535}
Values={Unknown, Normal, Erasing, Not Applicable, DMTF 
  Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


  

  






  
  

    Method 
Detail


CancelIteration
public uint32 CancelIteration([IN]string IterationIdentifier)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Requests that an iteration of the Log, identified by the 
  IterationIdentifier input parameter, be stopped. The return value from 
  CancelIteration should be 0 if the request was successfully executed, 1 if the 
  request is not supported and some other value if an error occurred. In a 
  subclass, the set of possible return codes could be specified, using a 
  ValueMap qualifier on the method. The strings to which the ValueMap contents 
  are 'translated' may also be specified in the subclass as a Values array 
  qualifier.

Product Specific Usage:
In current implementation 
  this method doesn't have any affect. In order to get the events from the log 
  user should just call GetRecord or 
  GetRecords.

Parameters:
--------------

  

    
IterationIdentifier 
    
General Information:
An identifier for the 
    iterator.

Qualifiers:
-------------
IN







RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Requests that the state of the element be changed to the 
  value specified in the RequestedState parameter. When the requested state 
  change takes place, the EnabledState and RequestedState of the element will be 
  the same. Invoking the RequestStateChange method multiple times could result 
  in earlier requests being overwritten or lost. 
A return code of 0 shall 
  indicate the state change was successfully initiated. 
A return code of 3 
  shall indicate that the state transition cannot complete within the interval 
  specified by the TimeoutPeriod parameter. 
A return code of 4096 (0x1000) 
  shall indicate the state change was successfully initiated, a ConcreteJob has 
  been created, and its reference returned in the output parameter Job. Any 
  other return code indicates an error condition.

Product Specific 
  Usage:
Additional Notes: 
1) 'RequestStateChange' in Intel AMT 
  Release 3.2 is permitted only to 'ADMIN_SECURITY_EVENT_MANAGER_REALM'. 
2) 
  In current implementation this method isn't supported (user will always get 
  "Not Supported" as a return 
  status).

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 
  32768..65535}
Values={Completed with No Error, Not Supported, Unknown or 
  Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid 
  Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, 
  Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method 
  Reserved, Vendor 
  Specific}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


Parameters:
--------------

  

    
RequestedState 
    
General Information:
The state requested for the element. This 
    information will be placed into the RequestedState property of the instance 
    if the return code of the RequestStateChange method is 0 ('Completed with No 
    Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the 
    EnabledState and RequestedState properties for the detailed explanations of 
    the RequestedState 
    values.

Qualifiers:
-------------
IN
ValueMap={2, 3, 
    4, 6, 7, 8, 9, 10, 11, .., 32768..65535}
Values={Enabled, Disabled, Shut 
    Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved, Vendor 
    Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


    
Job 
    
General Information:
May contain a reference to the 
    ConcreteJob created to track the state transition initiated by the method 
    invocation.

Qualifiers:
-------------
IN=false
OUT


    
TimeoutPeriod 
    
General Information:
A timeout period that specifies the 
    maximum amount of time that the client expects the transition to the new 
    state to take. The interval format must be used to specify the 
    TimeoutPeriod. A value of 0 or a null parameter indicates that the client 
    has no time requirements for the transition. 
If this property does not 
    contain 0 or null and the implementation does not support this parameter, a 
    return code of 'Use Of Timeout Parameter Not Supported' shall be 
    returned.

Qualifiers:
-------------
IN







ClearLog
public uint32 ClearLog()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM

General 
  Information:
Requests that the Log be cleared of all entries. 
The 
  return value should be 0 if the request was successfully executed, 1 if the 
  request is not supported, and some other value, as indicated by the 
  ValueMap/Values qualifiers, if an error occurred.

Product Specific 
  Usage:
Since vendor reserved values start at 0x8000, any error status 
  values will be biased by 0x8000. The document Intel AMT WS-Management Flows 
  lists the possible Intel AMT error status values in the section Function 
  Return Values and 
  Errors.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6..0x0FFF, 0x1000..0x7FFF, 0x8000..}
Values={Completed with no error, 
  Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, 
  DMTF_Reserved, Method_Reserved, Vendor_Reserved}






GetRecords
public uint32 GetRecords([IN][OUT]string IterationIdentifier, [IN]uint32 MaxReadRecords, [OUT]boolean NoMoreRecords, [OUT]string RecordArray[400])



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Retrieves multiple records from event 
  log

Product Specific Usage:
Additional Notes: 
1) Return 
  value 'No record exists in log' (3) is supported in Intel AMT Release 4.0 and 
  later releases only. 
2) the IterationIdentifier input parameter is a 
  numeric value (starting at 1) which is the position of the first record in the 
  log that should be 
  extracted.

Qualifiers:
-------------
ValueMap={0, 1, 2, 
  3}
Values={Completed with No Error, Not Supported, Invalid record pointed, 
  No record exists in log}


Parameters:
--------------

  

    
IterationIdentifier 
    
General 
    Information:


Qualifiers:
-------------
Required
IN
OUT


    
MaxReadRecords 
    
General Information:
Maximum number of records to 
    read

Qualifiers:
-------------
Required
IN


    
NoMoreRecords 
    
General Information:
Indicates that there are no more records 
    to read

Qualifiers:
-------------
OUT


    
RecordArray 
    
General Information:
Array of records encoded as 
    Base64

Qualifiers:
-------------
OUT
EOBase64







GetRecord
public uint32 GetRecord([IN][OUT]string IterationIdentifier, [IN]boolean PositionToNext, [OUT]uint64 RecordNumber, [OUT]uint8 RecordData[])



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Requests that the record indicated by the 
  IterationIdentifier be retrieved from the MessageLog. After retrieval, the 
  IterationIdentifier may be advanced to the next record by setting the 
  PositionToNext input parameter to TRUE. Two output parameters are defined for 
  the method - RecordData which holds the contents of the Log entry (as an array 
  of bytes that can be recast to an appropriate format), and RecordNumber which 
  returns the current record number addressed via the Iteration Identifier. The 
  RecordNumber parameter is only defined/valid when the Capabilities array 
  indicates that ordinal record number addressing is supported (a value of 7). 
  

IterationIdentifier is defined as an Input/Output method parameter to 
  allow the Log to embed state information in the Identifier and potentially let 
  the identifier be maintained by the using application.

Product 
  Specific Usage:
IterationIdentifier is a numeric value which is the 
  position of the record in the log that should be extracted (starting at 
  1).

Qualifiers:
-------------
Override=GetRecord
ValueMap={0, 
  1, 2, 3}
Values={Completed with No Error, Not Supported, Invalid record 
  pointed, No record exists in 
  log}


Parameters:
--------------

  

    
IterationIdentifier 
    
General Information:
An identifier for the 
    iterator.

Qualifiers:
-------------
Required
IN
OUT


    
PositionToNext 
    
General Information:
Boolean indicating that the Iteration 
    Identifier should be advanced to the next record, after retrieving the 
    current Log entry.

Qualifiers:
-------------
IN


    
RecordNumber 
    
General Information:
The record 
    number.

Qualifiers:
-------------
Required
IN=false
OUT


    
RecordData 
    
General Information:
The record 
    data.

Qualifiers:
-------------
IN=false
OUT







PositionAtRecord
public uint32 PositionAtRecord([IN][OUT]string IterationIdentifier, [IN]boolean MoveAbsolute, [IN][OUT]sint64 RecordNumber)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Requests that the Log's iteration identifier be advanced 
  or retreated a specific number of records, or set to the entry at a specified 
  numeric location. These two different behaviors are accomplished using the 
  input parameters of the method. Advancing or retreating is achieved by setting 
  the MoveAbsolute boolean to FALSE, and then specifying the number of entries 
  to advance or retreat as positive or negative values in the RecordNumber 
  parameter. Moving to a specific record number is accomplished by setting the 
  MoveAbsolute input parameter to TRUE, and then placing the record number into 
  the RecordNumber parameter. This can only be done if the Capabilities array 
  includes a value of 7, "Supports Addressing by Ordinal Record Number". 
  

After the method completes and if ordinal record numbers are supported 
  (the Capabilities array includes a 7), the current record number is returned 
  in the RecordNumber output parameter. Otherwise, the value of the parameter is 
  undefined. 

IterationIdentifier is defined as an Input/Output method 
  parameter to allow the Log to embed state information in the Identifier and 
  potentially let the identifier be maintained by the using application. 
  

Note: In a subclass, the set of possible return codes could be 
  described using a ValueMap qualifier on the method. The strings to which the 
  ValueMap contents are 'translated' may also be specified in the subclass as a 
  Values array qualifier.

Product Specific Usage:
Additional 
  Notes: 
1) The Argument 'RecordNumber' of the 'PositionAtRecord' method is 
  of type 'sint32' in Intel AMT Release 3.2 and earlier releases. 
2) In 
  current implementation this method doesn't have any affect. In order to get 
  the events from the log user should just call GetRecord or 
  GetRecords.

Qualifiers:
-------------
Override=PositionAtRecord
ValueMap={0, 
  1, 2}
Values={Completed with No Error, Not Supported, Invalid record 
  pointed}


Parameters:
--------------

  

    
IterationIdentifier 
    
General Information:
An identifier for the 
    iterator.

Qualifiers:
-------------
Required
IN
OUT


    
MoveAbsolute 
    
General Information:
Advancing or retreating the 
    IterationIdentifier is achieved by setting the MoveAbsolute boolean to 
    FALSE, and specifying the number of entries to advance or retreat as 
    positive or negative values in the RecordNumber parameter. Moving to a 
    specific record number is accomplished by setting the MoveAbsolute parameter 
    to TRUE, and placing the record number into the RecordNumber 
    parameter.

Qualifiers:
-------------
Required
IN


    
RecordNumber 
    
General Information:
The relative or absolute record 
    number.

Qualifiers:
-------------
Required
IN
OUT







PositionToFirstRecord
public uint32 PositionToFirstRecord([OUT]string IterationIdentifier)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Requests that an iteration of the MessageLog be 
  established and that the iterator be set to the first entry in the Log. An 
  identifier for the iterator is returned as an output parameter of the method. 
  

Regarding iteration, you have 2 choices: 1) Embed iteration data in 
  the method call, and allow implementations to track/ store this data manually; 
  or, 2) Iterate using a separate object (for example, class ActiveIterator) as 
  an iteration agent. The first approach is used here for interoperability. The 
  second requires an instance of the Iterator object for EACH iteration in 
  progress. 2's functionality could be implemented underneath 
  1.

Product Specific Usage:
In current implementation this 
  method doesn't have any affect. In order to get the events from the log user 
  should just call GetRecord or 
  GetRecords.

Qualifiers:
-------------
Override=PositionToFirstRecord
ValueMap={0, 
  1, 2}
Values={Completed with No Error, Not Supported, No record 
  exists}


Parameters:
--------------

  

    
IterationIdentifier 
    
General Information:
An identifier for the 
    iterator.

Qualifiers:
-------------
IN=false
OUT







FreezeLog
public uint32 FreezeLog([IN]boolean Freeze)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Requests that the MessageLog be placed in a frozen state 
  ("Freeze" input parameter = TRUE) or 'unfrozen' (= FALSE). If frozen, 
  modifications to the Log will not be allowed. If successful, the Log's 
  IsFrozen boolean property will be updated to reflect the desired state. 
  

The method's return code should be 0 if the request was successfully 
  executed, 1 if the request is not supported and some other value if an error 
  occurred. If the request is not supported, check the Capabilities array that a 
  value of 5 ("Freeze Log Supported") is specified. 

Note: In a subclass, 
  the set of possible return codes could be described using a ValueMap qualifier 
  on the method. The strings to which the ValueMap contents are 'translated' may 
  also be specified in the subclass as a Values array 
  qualifier.

Product Specific Usage:
Any error status values 
  other then '0' will be biased by 0x8000. The document Intel AMT WS-Management 
  Flows lists the possible Intel AMT error status values in the section Function 
  Return Values and Errors. 

Additional Notes: 
1) 'FreezeLog' in 
  Intel AMT Release 3.2 is permitted only to 
  'ADMIN_SECURITY_EVENT_MANAGER_REALM'.

Qualifiers:
-------------
Override=FreezeLog


Parameters:
--------------

  

    
Freeze 
    
General Information:
If TRUE then freeze the log, if FALSE 
    'unfreeze' the 
    log.

Qualifiers:
-------------
Required
IN







Get
public  Get([OUT]AMT_MessageLog Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_EVENT_LOG_READER_REALM

General 
  Information:
Gets the representation of the instance





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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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