Dump Service

DumpService

DumpService APIs are used to dump and download debug information.

URI: /redfish/v1/Oem/Supermicro/DumpService

Method: GET

Response: 200

{

"@odata.type": "#DumpService.v1_0_0.DumpService",

"@odata.id": "/redfish/v1/Oem/Supermicro/DumpService",

"Id": "DumpService",

"Name": "Dump Service",

"Description": "Dump Service",

"Dumps": {

"@odata.id": "/redfish/v1/Oem/Supermicro/DumpService/Dumps"

},

"VideoCapture": {

"CaptureVideoEnabled": false,

"RecordPeriod": "POSTEnd"

},

"CrashScreenCapture": {

"OSCrashDetectionEnabled": false

},

"Actions": {

"Oem": {},

"#OemDumpService.Collect": {

"target":"/redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect",

"@Redfish.ActionInfo":"/redfish/v1/Oem/Supermicro/DumpService/CollectActionInfo"

}

},

"@odata.etag": "\"f225dfabefafd7ab551b9635e9308968\""

}

HostCrashDumps

When the host crash dump is created, you can download it from HostCrashDumpURI.

URI: /redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump

Method: GET

Response: 200

{

"@odata.type": "#Dump.v1_1_0.Dump",

"@odata.id": "/redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump",

"Id": "HostCrashDump",

"Description": "Host dump",

"Size": 49139,

"Reason": "Host failure",

"Actions": {

"Oem": {

},

"#SmcDump.Download": {

"target": "/redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump/Actions/SmcDump.Download"

}

},

"@odata.etag": "\"ae12d4647e32eb925f33eac0c038604b\""

}

Downloading Crash Dump

URI: /redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump/Actions/SmcDump.Download

Method: POST

Response: 200

Filename: CDump.txt

Payload:

{

}

Create ScreenCapture

URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "ScreenCapture", "ActionType": "Create" }

Download ScreenCapture

URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "ScreenCapture", "ActionType": "Download" }

Download VideoCapture

URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "VideoCapture", "ActionType": "Download" }

Download CrashScreenCapture

URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "CrashScreenCapture", "ActionType": "Download" }

Download SDOReport

Step 1:

URI: /redfish/v1/Systems/1

Method: PATCH

Response: 200

Payload:

{

"Boot" :

{

"BootSourceOverrideEnabled": "Once",

"BootSourceOverrideMode": "UEFI",

"BootSourceOverrideTarget" : "Diags"

}

}

To trigger SDO test in next system boot

Step 2:

URI: /redfish/v1/Systems/1/Actions/ComputerSystem.Reset

Method: POST

Response: 200

Payload:

{ "ResetType" : "PowerCycle" }

Reboot the system. It automatically goes into SDO. The time of the generated report depends on the system. After SDO generates the report, system will automatically reboot.

Step 3:

URI:/redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "SDOReport", "ActionType": "Download" }