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

Class AMT_AuditLog

Used in features: Audit Log
Compatible with the following Intel AMT Releases: 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 AMT_AuditLog


class AMT_AuditLog
 extends CIM_Log


General Information:
Represents an Audit 
Log

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









  
  

    Supported Fields 
      Summary

  

     uint16 
      
    OverwritePolicy 
      
OverwritePolicy is an integer enumeration that indicates 
      whether the log, represented by the CIM_Log subclasses, can overwrite its 
      entries.Unknown (0) indicates the log's overwrite policy is unknown . . 
      .

  

     uint64 
      
    CurrentNumberOfRecords 
      
Current number of records in the Log.

  

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

  

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

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states 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 . . .

  

     uint32 
      
    PercentageFree 
      
Indicates the percentage of free space in the storage dedicated 
      to the audit log.

  

     string 
      
    Name Key  


  

     datetime 
      
    TimeOfLastRecord 
      
Time stamp of the most recent entry in the log if such an entry 
      exists.

  

     uint32 
      
    AuditState 
State of 
      log . . .

  

     uint16 
      
    MaxAllowedAuditors 
      
Maximum number of auditors allowed

  

     uint8 
      
    StoragePolicy 
      
AuditLog storage policy . . .

  

     uint8 
      
    MinDaysToKeep 
      
Minimum number of days to keep records in the AuditLog . . 
    .




  
  

    Methods Summary

  

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

  

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

  

     uint32
    ReadRecords(StartIndex, 
      TotalRecordCount, RecordsReturned, EventRecords) 
Returns a list 
      of consecutive audit log records in chronological order: The first record 
      in the returned array is the oldest record stored in the log . . .

  

     uint32
    SetAuditLock(LockTimeoutInSeconds, Flag, 
      Handle) 
This method is used by an auditor to stop the system 
      from logging any records while exporting and clearing the log . . .

  

     uint32
    ExportAuditLogSignature(SigningMechanism, 
      TotalRecordCount, StartLogTime, EndLogTime, GenerationTime, UUID, FQDN, 
      SignatureMechanism, Signature, LengthOfCertificates, Certificates) 
      
Returns the audit log signature and log related information.

  

     uint32
    SetSigningKeyMaterial(SigningMechanismType, 
      SigningKey, LengthOfCertificates, Certificates) 
Sets the key 
      and certificates needed for the signing of the audit log . . .

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    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


OverwritePolicy 
public uint16 OverwritePolicy



  
General Information:
OverwritePolicy is an integer enumeration 
  that indicates whether the log, represented by the CIM_Log subclasses, can 
  overwrite its entries.Unknown (0) indicates the log's overwrite policy is 
  unknown. 
Wraps when Full (2) indicates that the log overwrites its entries 
  with new entries when the log has reached its maximum capacity. 
Never 
  Overwrites (7) indicates that the log never overwrites its entries by the new 
  entries.

Product Specific Usage:
Value of 32768 means 
  "Parital (restricted) rollover" - only old events (under certain threshold, 
  which can be set using SetStoragePolicy) will be overwritten. 
This is a 
  read-only property.

Qualifiers:
-------------
ValueMap={0, 
  2, 7, .., 32768..65535}
Values={Unknown, Wraps When Full, Never Overwrites, 
  DMTF Reserved, Vendor Reserved}


  

  





CurrentNumberOfRecords 
public uint64 CurrentNumberOfRecords



  
General Information:
Current number of records in the 
  Log.

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


  

  





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.

  

  





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


  

  





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.

Product Specific Usage:
Additional Notes: 
1) 
  Value 6 ("Enabled but Offline") can be recieved also if the Audit Log is in 
  locked state.

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}


  

  





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}


  

  





PercentageFree 
public uint32 PercentageFree



  
General Information:
Indicates the percentage of free space in 
  the storage dedicated to the audit 
  log.

Qualifiers:
-------------
Required
MinValue=0
MaxValue=100


  

  





Name Key 
public string Name



  
General 
  Information:


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


  

  





TimeOfLastRecord 
public datetime TimeOfLastRecord



  
General Information:
Time stamp of the most recent entry in the 
  log if such an entry exists.

Product Specific 
  Usage:
Additional Notes: 
1) If the log is empty, 'TimeOfLastRecord' 
  will be set to 0. 
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'.

  

  





AuditState 
public uint32 AuditState



  
General Information:
State of log. A bitwise combination of one 
  or more of: 0x00 (Enabled), 0x01 (Disabled), 0x02 (Locked), 0x04 (Almost Full 
  - The storage area dedicated for the audit log reached 85% full, and 
  non-critical events will not be logged.), 0x08 (Full - The storage area 
  dedicated for the audit log is completely full; no events will be logged and 
  critical events in policy will not be executed.), 0x10 (No Key - No key and 
  certificate were set for the signing of the audit log. Feature cannot be 
  enabled).

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


  

  





MaxAllowedAuditors 
public uint16 MaxAllowedAuditors



  
General Information:
Maximum number of auditors 
  allowed

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


  

  





StoragePolicy 
public uint8 StoragePolicy



  
General Information:
AuditLog storage policy. The available 
  policies are: "NO_ROLL_OVER" - No roll-over in storage. Old events will not be 
  overwritten. "ROLL_OVER" - Full rollover. Any old record will be overwritten. 
  "RESTRICTED_ROLL_OVER" - Parital (restricted) rollover. Only old events (under 
  certain threshold, which can be set using SetStoragePolicy) will be 
  overwritten. If not specified default is "ROLL_OVER" unless FW was upgraded 
  from AMT 5.0 and then "NO_ROLL_OVER" will be used as 
  default.

Product Specific Usage:
Additional Notes: 
1) 
  'StoragePolicy' is only supported in Intel AMT Release 5.1 and later 
  releases.

Qualifiers:
-------------
ValueMap={0, 1, 
  2}
Values={NO_ROLL_OVER, ROLL_OVER, RESTRICTED_ROLL_OVER}


  

  





MinDaysToKeep 
public uint8 MinDaysToKeep



  
General Information:
Minimum number of days to keep records in 
  the AuditLog. Relevant only if "storagePolicy" is set to 
  "RESTRICTED_ROLL_OVER".

Product Specific Usage:
This property 
  will accept values between 1 and 100. If a valuse out of the range is 
  specified, wxf:InvalidRepresentation fault will be returned with InvalidValues 
  detail. 

Additional Notes: 
1) 'MinDaysToKeep' is only supported in 
  Intel AMT Release 5.1 and later releases.

  

  






  
  

    Method 
Detail


ClearLog
public uint32 ClearLog()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AUDIT_LOG_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:
Additional Notes: 
1) 
  The routine may only be called when the audit log service is in a locked 
  state. If it is called 
when the audit log service is not in a locked 
  state, the routine will return "Not permitted" error 
code 
2) The 
  available return values are: 
0 - Completed with no errors 
0x8002 - Not 
  ready 
0x8010 - Not permitted 
0x8026 - Flash write limit exceeded 
  



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}






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



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AUDIT_LOG_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 info: 
1) The supported RequestedState are 2 
  (Enabled), 3 (Disabled) 
2) AMT doesn't support the TimeoutPeriod parameter 
  (only value 0 is valid). 
3) The available return values are: 
0 - 
  Completed with no errors 
0x8002 - Not ready 
0x8010 - Not permitted 
  
0x8026 - Flash write limit exceeded 
  



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







ReadRecords
public uint32 ReadRecords([IN]uint32 StartIndex, [OUT]uint32 TotalRecordCount, [OUT]uint32 RecordsReturned, [OUT]string EventRecords[120])



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_GENERAL_INFO_REALM, 
  ADMIN_SECURITY_AUDIT_LOG_REALM

General Information:
Returns a 
  list of consecutive audit log records in chronological order: 

  The first record in the returned array is the oldest record stored in the log. The record 
  entries are returned as an array of base64Binary elements.

  Each record holds 
  the following information:

  uint16 AuditAppID - A unique ID for each auditable 
  application.

  uint16 EventID - ID of an event of the application.

  uint8 InitiatorType - 0 (HTTP Digest username), 1 (Kerberos SID), 2 (Local), 3 (KVM).
 
  InitiatorData - See below for details. 

  uint32 TimeStamp - Time when the event occurred in seconds since 1.1.1970.

  uint8 MCLocationType - 0 (IPv4 Address), 1 (IPv6 Address), 2 (None).

  uint8 NetAddressLength - Length of the NetAddress field. 

  Array of uint8 NetAddress - ASCII representation of the network address of 
  management console or Local Host IP (e.g., 127.0.0.1). Note: In Intel AMT 
  Release 4.0, IP address representation includes null-terminator and 
  NetAddressLength includes the null terminator. 

  uint8 ExtendedDataLength - Length of event specific data.

  Array of uint8 ExtendedData - Event specific data. 


  The InitiatorData field may hold different data types according 
  to the InitiatorType field.


  For HTTP digest initiator:

  
  uint8 UsernameLength - the username's length not including a NULL terminator

  Array of uint8 of size UsernameLength - the username, without a NULL terminator

  

  For Kerberos user:

   uint32 UserInDomain

    uint8 DomainLength

  Array of uint8 of size DomainLength - the domain's name


 There is no InitiatorData for local or KVM users.

 
 
 
Qualifiers:
-------------
ValueMap={0, 1, 2, 
  35}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_NOT_READY, 
  PT_STATUS_INVALID_INDEX}


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

  

    
StartIndex 
    
General Information:
Identifies the position of the first 
    record to retrieve. An index of 1 indicates the first record in the 
    log.

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


    
TotalRecordCount 
    
General Information:
The total number of records in the 
    log.

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


    
RecordsReturned 
    
General Information:
The number of records returned + content 
    of 10 records from the start index. 
    

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


    
EventRecords 
    
General Information:
Notice: the values of this array are 
    actually base64 encoded values. A list of event 
    records.

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







SetAuditLock
public uint32 SetAuditLock([IN]uint32 LockTimeoutInSeconds, [IN]uint32 Flag, [IN][OUT]uint32 Handle)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AUDIT_LOG_REALM

General Information:
This 
  method is used by an auditor to stop the system from logging any records while 
  exporting and clearing the log. It performs lock, unlock or allows 
  unprovisioning of the system. When the audit log is locked, no events are 
  written into the log. Any events marked in the policy as critical will not be 
  executed. If the log is locked and another lock is requested with the same 
  handle, so the timeout will be renewed with the new 
  LockTimeoutInSeconds.

Qualifiers:
-------------
ValueMap={0, 
  1, 2, 16, 36, 2053}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_NOT_READY, PT_STATUS_NOT_PERMITTED, PT_STATUS_INVALID_PARAMETER, 
  PT_STATUS_INVALID_HANDLE}


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

  

    
LockTimeoutInSeconds 
    
General Information:
The maximum number of seconds that the 
    audit log will be locked in case for some reason the auditor fails to unlock 
    the log. Max value is 5 minutes. This parameter is required when the flag 
    parameter has a value of AUDIT_LOG_LOCK, or UNPROVISIONING_LOCK. This 
    parameter is not required and is ignored when AUDIT_LOG_UNLOCK flag is 
    used.

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


    
Flag 
    
General Information:
Defines the locking 
    action.

Qualifiers:
-------------
Required
IN
valueMap={0, 
    1, 2}
values={AUDIT_LOG_LOCK, UNPROVISIONING_LOCK, 
    AUDIT_LOG_UNLOCK}


    
Handle 
    
General Information:
A handle is received when locking the 
    log. As long as the log is locked, lock and unlock requests can be performed 
    only by using the same handle. If the log is not locked so Handle-IN is not 
    required and is ignored. Handle-OUT is not supplied when SetAuditLock failed 
    to lock the audit log or when unlock is 
    preformed.

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







ExportAuditLogSignature
public uint32 ExportAuditLogSignature([IN]uint32 SigningMechanism, [OUT]uint32 TotalRecordCount, [OUT]datetime StartLogTime, [OUT]datetime EndLogTime, [OUT]datetime GenerationTime, [OUT]string UUID[], [OUT]string FQDN, [OUT]uint32 SignatureMechanism, [OUT]uint8 Signature[1024], [OUT]uint16 LengthOfCertificates[], [OUT]uint8 Certificates[4100])



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AUDIT_LOG_REALM

General Information:
Returns 
  the audit log signature and log related information.

Product 
  Specific Usage:
Additional Notes: 
1) 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'.

Qualifiers:
-------------
ValueMap={0, 1, 
  2, 16}
Values={PT_STATUS_SUCCESS, PT_INTERNAL_ERROR, PT_STATUS_NOT_READY, 
  PT_STATUS_NOT_PERMITTED}


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

  

    
SigningMechanism 
    
General Information:
Signing 
    Mechanism

Qualifiers:
-------------
Required
IN
ValueMap={0, 
    1, 2, 3..65535}
values={RSA_SHA1, RSA_SHA256, RSA_SHA384, 
    Reserved}  Note: SHA1 is no longer available starting from Intel CSME 18.0.


    
TotalRecordCount 
    
General Information:
The total number of event records in the 
    event log.

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


    
StartLogTime 
    
General Information:
Time stamp of the first 
    record.

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


    
EndLogTime 
    
General Information:
Time stamp of the last 
    record.

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


    
GenerationTime 
    
General Information:
Time stamp indicating when was the 
    signature 
    generated.

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


    
UUID 
    
General Information:
UUID of the current system for 
    identifying it in the audit 
    repository.

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


    
FQDN 
    
General Information:
FQDN of the 
    system.

Qualifiers:
-------------
OUT
MaxLen=256


    
SignatureMechanism 
    
General Information:
Signature 
    mechanism.

Qualifiers:
-------------
OUT
ValueMap={0, 
    1, 2, 3..65535}
values={RSA_SHA1, RSA_SHA256, RSA_SHA384, 
    Reserved}


    
Signature 
    
General Information:
The audit log signature, 1024 bytes 
    long.

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


    
LengthOfCertificates 
    
General Information:
An array specifying the length of each 
    certificate.

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


    
Certificates 
    
General Information:
The certificates, cascaded into one 
    stream.

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







SetSigningKeyMaterial
public uint32 SetSigningKeyMaterial([IN]uint32 SigningMechanismType, [IN]uint8 SigningKey[], [IN]uint16 LengthOfCertificates[], [IN]uint8 Certificates[4100])



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AUDIT_LOG_REALM

General Information:
Sets the 
  key and certificates needed for the signing of the audit log. This method must 
  be called before enabling the audit 
  log.

Qualifiers:
-------------
ValueMap={0, 1, 2, 36, 38, 
  2062, 2063, 2064, 2066}
Values={PT_STATUS_SUCCESS, 
  PT_STATUS_INTERNAL_ERROR, PT_STATUS_NOT_READY, PT_STATUS_INVALID_PARAMETER, 
  PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED, PT_STATUS_INVALID_KEY, 
  PT_STATUS_INVALID_CERT, PT_STATUS_CERT_KEY_NOT_MATCH, 
  PT_STATUS_UNSUPPORTED}


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

  

    
SigningMechanismType 
    
General Information:
Audit data signing mechanism 
    type.

Qualifiers:
-------------
Required
IN
valueMap={0, 
    1, 2, 3..65535}
values={RSA_SHA1, RSA_SHA256, RSA_SHA384, 
    Reserved} Note: SHA1 is no longer available starting from Intel CSME 18.0.


    
SigningKey 
    
General Information:
Key pair (RSA 2048 bit 
    modulus).

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


    
LengthOfCertificates 
    
General Information:
An array specifying the length of each 
    certificate.

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


    
Certificates 
    
General Information:
Up to 5 certificates cascaded into one 
    stream (with a total length of 4100 
    bytes).

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







Put
public  Put([IN]AMT_AuditLog Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AUDIT_LOG_REALM

General Information:
Changes 
  properties of the selected instance

Product Specific 
  Usage:
'Put' will set only 'StoragePolicy' and 'MinDaysToKeep' 
  properties. All other properties are ignored. 
If 'StoragePolicy' is set to 
  'RESTRICTED_ROLL_OVER', then 'MinDaysToKeep' must also be stated in the 'Put' 
  request. 
Otherwise, if 'StoragePolicy' is set to a value other then 
  'RESTRICTED_ROLL_OVER', 'MinDaysToKeep' will be ignored. 

Additonal 
  Notes: 
1) 'Put' is only supported in Intel AMT Release 5.1 and later 
  releases.





Get
public  Get([OUT]AMT_AuditLog Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_GENERAL_INFO_REALM, 
  ADMIN_SECURITY_AUDIT_LOG_REALM

General Information:
Gets the 
  representation of the instance

Product Specific Usage:
In 
  Intel AMT Release 5.1 and later releases, 'MinDaysToKeep' property will be 
  returned iff 'StoragePolicy' is set to 'RESTRICTED_ROLL_OVER'. 
Otherwise, 
  if 'StoragePolicy' is set to a value other then ''RESTRICTED_ROLL_OVER', 
  'MinDaystoKeep' property will not be included in the response.





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.