Skip to main content

POST – Collect BMC Service Data

Use the POST method to collect BMC service Data.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/Oem/Lenovo/ServiceData/Actions/LenovoServiceData.ExportFFDCData

Request body​

FieldTypeDescription

InitializationNeeded

Boolean

Required.

Username

String

The username for export URI.

Password

String

The password for export URI.

ExportURI

String

Download FFDC directly to this URI.

DataCollectionType

String

Required. “Mini-log”.

Response​

None

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example is POST body:

{
    "InitializationNeeded" : true,
    “DataCollectionType” : “Mini-log”
}

This action returns a task on success. The following example JSON response is returned:

{
    "Description": "This resource represents a task for a Redfish implementation.",
    "Id": "c7bc86f4-c241-4632-a58a-d83e94e5aecd",
    "HidePayload": true,
    "@odata.type": "#Task.v1_6_1.Task",
    "@odata.id": "/redfish/v1/TaskService/Tasks/c7bc86f4-c241-4632-a58a-d83e94e5aecd",
    "@odata.context": "/redfish/v1/$metadata#Task.Task",
    "TaskState": "New",
    "Messages": [],
    "@odata.etag": "\"1709638475733\"",
    "Name": "Task c7bc86f4-c241-4632-a58a-d83e94e5aecd",
    "TaskMonitor": "/redfish/v1/TaskService/20d4a06c-1d5b-467a-9513-0d511b7c6068",
    "StartTime": "2024-03-05T19:34:35+08:00"
}

This task will continue to monitor the progress of Diagnostic Data generation. User can get the progress, task state, and more detailed information by accessing the URI indicated in the returned property “TaskMonitor”. The following example JSON response is returned:

{
    "Description": "This resource represents a task for a Redfish implementation.",
    "StartTime": "2024-03-05T19:34:35+08:00",
    "HidePayload": true,
    "@odata.type": "#Task.v1_6_1.Task",
    "TaskStatus": "OK",
    "@odata.context": "/redfish/v1/$metadata#Task.Task",
    "TaskState": "Completed",
    "Name": "Task c7bc86f4-c241-4632-a58a-d83e94e5aecd",
    "@odata.id": "/redfish/v1/TaskService/Tasks/c7bc86f4-c241-4632-a58a-d83e94e5aecd",
    "Messages": [],
    "Id": "c7bc86f4-c241-4632-a58a-d83e94e5aecd",
    "@odata.etag": "\"1709638540645\"",
    "EndTime": "2024-03-05T19:35:40+08:00",
    "TaskMonitor": "/redfish/v1/TaskService/20d4a06c-1d5b-467a-9513-0d511b7c6068",
    "Oem": {
        "Lenovo": {
            "@odata.type": "#LenovoTask.v1_0_0.LenovoTaskProperties",
            "FFDCForDownloading": {
                "Path": "/imm_dump/FFDC/7D8TCTO1WW_7D8T123456_xcc_mini-log_20240305-193437.zip"
            }
        }
    }
}

In this example, the service Data can be download by https://<BMC_IPADDR>/imm_dump/FFDC/7D8TCTO1WW_7D8T123456_xcc_mini-log_20240305-193437.zip with Redfish X-Auth-Token.