Skip to main content

GET – Service for BMC Platform event logs

Use the GET method to retrieve properties in Platform log service resource for a server.

Request URL​

Note
This resource is not available on Lenovo Purley-based systems. If you are looking for platform log service on Lenovo Purley systems, please refer to 13.1.3.
GET https://<BMC_IPADDR>/redfish/v1/Systems/1/LogServices/PlatformLog

Request body​

None

Response body​

FieldTypeDescription

Id

String

Uniquely identifies the resource within the collection of the log services resource. Always set to “PlatformLog”.

Name

String

The name of the resource or array element.

DateTimeLocalOffset

String

The UTC offset that the current DateTime property value contains in the "+HH:MM" format.

MaxNumberOfRecords

Number

The maximum number of log entries this service can have. Always set to 1024.

DateTime

String

The current DateTime (with offset) for the log service, used to set or read time.

OverWritePolicy

String

The overwrite policy for this service that takes place when the log is full. Always set to “WrapsWhenFull” – When full, new entries to the Log will overwrite previous entries.

ServiceEnabled

Boolean

Indicate whether this service is enabled.

LogEntryType

String

“Multiple”

Entries

Object

References to the log entry collection.

Actions

Object

The available actions for this resource.

 

#LogService.ClearLog

Object

This action is used to clear all standard log entries.

Description

String

This resource is used to represent a log service for a Redfish implementation.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "DateTimeLocalOffset": "+00:00",
    "Id": "PlatformLog",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/PlatformLog",
    "ServiceEnabled": true,
    "LogEntryType": "Multiple",
    "Name": "LogService",
    "Entries": {
        "@odata.id": "/redfish/v1/Systems/1/LogServices/PlatformLog/Entries"
    },
    "MaxNumberOfRecords": 1024,
    "DateTime": "2020-06-03T06:35:36+00:00",
    "@odata.type": "#LogService.v1_1_3.LogService",
    "OverWritePolicy": "WrapsWhenFull",
    "Oem": {
        "Lenovo": {
            "HiddenFirstSeqNum": 1,
            "LastSeqNum": 316,
            "@odata.type": "#LenovoLogService.v1_0_0.LenovoLogServiceProperties",
            "FirstSeqNum": 5,
            "VMMoveCategory": [
                {
                    "VMMoveCategoryName": "RAS event VM movement support",
                    "VMMoveCategoryBit": 0,
                    "VMMoveCategoryType": "VMEFlag"
                }
            ],
            "HiddenLastSeqNum": 7,
            "SupportedCategories": 3087007930,
            "DesiredCategories": 2147483684
        }
    },
    "@odata.etag": "\"93a07843ee0d2d2672f4c\"",
    "Actions": {
        "Oem": {
            "#LenovoLogService.GetLogEntriesBySequenceNumber": {
                "title": "GetLogEntriesBySequenceNumber",
                "target": "/redfish/v1/Systems/1/LogServices/PlatformLog/Actions/Oem/LenovoLogService.GetLogEntriesBySequenceNumber"
            }
        },
        "#LogService.ClearLog": {
            "title": "ClearLog",
            "target": "/redfish/v1/Systems/1/LogServices/PlatformLog/Actions/LogService.ClearLog"
        }
    },
    "Description": "This resource is used to represent a log service for a Redfish implementation."
}