CFG_GetAuditLogRecords

CFG_GetAuditLogRecords returns the current set of records in the AMT Audit Log database. If the full set of records cannot fit under the AMTHI HECI’s TxBuffer size, it will return as many full records as it can; additional calls can then be made with different values in the StartIndex parameter in order to retrieve the rest of the records.

Records may have different lengths, so the contents of the RecordsBuffer should be processed one by one according to the Audit Log record structure header.

CFG_ GetAuditLogRecords Request

typedef struct

{

    PTHI_MESSAGE_HEADER     Header;

    UINT32                  StartIndex;

} CFG_GetAuditLogRecords_Request;

 

Field

Description

Header.Version

Major and minor interface version.

Header.Reserved

0000h

Header.Command

04000087h

Header.Length

Message Length, excluding the message header.

StartIndex

The index of the first log entry in the set you want to retrieve. Should be called with “1” in the first call. Additional calls should then be made whenever there are records remaining that were not retrieved; in each of these calls, StartIndex should be increased according to the number of records received.

CFG_ GetAuditLogRecords Response

typedef struct

{

    PTHI_MESSAGE_HEADER           Header;

    AMT_STATUS                    Status;

    UINT32                        TotalRecordsCount;

    UINT32                        ReturnedRecordsCount;

    UINT8                         RecordsBuffer[0];

} CFG_GetAuditLogRecords_Response;

 

Field

Description

Header.Version

Major and minor interface version.

Header.Reserved

0000h

Header.Command

04800087h

Header.Length

Message Length, excluding the message header.

Status

A status code returned in a response message that indicates whether the operation specified in the corresponding request message succeeded or failed. If the operation failed, this code indicates the specific reason for failure.

TotalRecordsCount

Total number of individual records currently found in the AMT Audit Log

ReturnedRecordsCount

The number of records returned in this response

RecordsBufferBytesCount

The size (in bytes) of the records buffer returned in the next field

RecordsBuffer

The buffer that holds the records returned in this response. Each record starts with a uint16 “length” field that contains the length of the rest of the record. See Reading the Audit Log for information on reading the record buffer.

 

CFG_ GetAuditLogRecords Status Codes

Status

Description

AMT_STATUS_SUCCESS

Request succeeded.

AMT_STATUS_INTERNAL_ERROR

An internal error in the Intel AMT device has occurred.

AMT_STATUS_INVALID_INDEX

An invalid StartIndex parameter was provided (either 0 or larger than the total number of records).

 

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