7. Computer System
To get a ComputerSystem resource, perform a GET operation on the URI of the desired member of the ComputerSystemCollection resource. The following example shows a request to retrieve the ComputerSystem resource name.
7.1 Get Systems Info
curl -k 'https://<REDFISH-HOST>/redfish/v1/Systems' \
-H 'X-Auth-Token: <SESSION-TOKEN>' | python -m json.tool
The following example shows a response to the previous request:
{
"@odata.id": "/redfish/v1/Systems",
"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
],
"Members@odata.count": 1,
"Name": "Computer System Collection"
}
7.2 Get System Info
curl -k 'https://<REDFISH-HOST>/redfish/v1/Systems/1' \
-H 'X-Auth-Token: <SESSION-TOKEN>' | python -m json.tool
The following example shows a response to the previous request:
{
"@odata.id": "/redfish/v1/Systems/1",
"@odata.type": "#ComputerSystem.v1_22_0.ComputerSystem",
"Actions": {
"#ComputerSystem.Reset": {
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff",
"GracefulShutdown",
"ForceRestart"
],
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"
},
"Oem": {
"#Camera.Active": {
"ActiveType@Redfish.AllowableValues": [
"StartStream",
"StopStream"
],
"target": "/redfish/v1/Systems/1/Oem/Camera/Actions/Camera.Active "
}
}
},
"Description": "Web Front End node",
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
},
"VirtualMedia": {
"@odata.id": "/redfish/v1/Systems/1/VirtualMedia"
},
"HostName": "edge",
"Id": "1",
"LastResetTime": "2021-03-13T04:02:57+06:00",
"Manufacturer": "AVerMedia",
"Model": "NVIDIA Jetson",
"Name": "D135 NX",
"PartNumber": "224071-J23",
"PowerState": "On",
"Oem": {
"ERMI": {
"StreamState": "Off",
"DaemonVersion": "Unknown",
"DaemonIsOutdated": false
}
},
"SKU": "8675309",
"SerialNumber": "000001",
"FirmwareVersion": "0.0.1",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
},
"SubModel": "Orin Nano",
"SystemType": "Physical",
"CPU Architecture": "ARM",
"Operating System": "Ubuntu",
"SimpleStorage": {
"@odata.id": "/redfish/v1/Systems/1/SimpleStorage"
},
"UUID": "38947555-7742-3448-3784-823347823834"
}
The response contains information about the system the ComputerSystem resource represents. It's common to find information such as status, health, and FRU information about the system. Processor, memory, storage, and other components that comprise the system can be found in hyperlinks from the ComputerSystem resource. The response can also contain hyperlinks to more detailed configuration settings for the system, such as BIOS and UEFI Secure Boot settings.
The ComputerSystem section of the Redfish Resource and Schema Guide contains details for the properties that can be found in the ComputerSystem resource.
7.3 SimpleStorage API
Overview
The SimpleStorage resource in Redfish provides a simplified representation of storage devices attached to a system. It is primarily used for exposing information about controllers and directly-attached devices such as SSDs.
This implementation extends the SimpleStorage schema with an SSD Recovery capability. This feature allows administrators to restore an SSD to a predefined recovery state.
This functionality is optional and depends on hardware support. If supported, recovery operations can be triggered through a Redfish Action on the SimpleStorage resource.
API Endpoint
| Method | Endpoint | Description |
|---|---|---|
GET |
/redfish/v1/Systems/{SystemId}/SimpleStorage |
List all SimpleStorage resources associated with the system. |
GET |
/redfish/v1/Systems/{SystemId}/SimpleStorage/{Id} |
Retrieve details of a specific storage controller or device. |
POST |
/redfish/v1/Systems/{SystemId}/SimpleStorage/{Id}/Actions/Oem/SimpleStorage.Recovery |
Trigger SSD recovery operation for the specified storage device. |
SimpleStorage Collection
List all SimpleStorage resources associated with the system.
URI: /redfish/v1/Systems/{SystemId}/SimpleStorage
Method: GET
Response:
HTTP Status Code: 200 OK
The response body as below:
{
"@odata.id": "/redfish/v1/Systems/1/SimpleStorage",
"@odata.type": "#SimpleStorageCollection.SimpleStorageCollection",
"Name": "Simple Storage Collection",
"Members@odata.count": 1,
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1"
}
]
}
HTTP Status Code: 403 Forbidden
When the hardware does not support this functionality, the service will respond with HTTP status code 403 Forbidden.
SimpleStorage Instance
Retrieve details of a specific storage controller or device.
URI: /redfish/v1/Systems/{SystemId}/SimpleStorage/{Id}
Method: GET
Response:
HTTP Status Code: 200 OK
The response body as below:
{
"@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1",
"@odata.type": "#SimpleStorage.v1_5_0.SimpleStorage",
"Id": "1",
"Name": "Onboard Simple Storage",
"Description": "System board storage devices",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Devices": [
{
"Name": "NVMe SSD 1",
"Manufacturer": "Apacer",
"Status": {
"State": "Enabled",
"Health": "OK"
}
}
],
"Actions": {
"Oem": {
"#SimpleStorage.Recovery": {
"target": "/redfish/v1/Systems/1/SimpleStorage/1/Actions/Oem/SimpleStorage.Recovery",
"title": "Recovery",
}
}
}
}
HTTP Status Code: 403 Forbidden
When the hardware does not support this functionality, the service will respond with HTTP status code 403 Forbidden.
SSD Recovery
Trigger SSD recovery operation for the specified storage device.
URI: /redfish/v1/Systems/{SystemId}/SimpleStorage/{Id}/Actions/Oem/SimpleStorage.Recovery
Method: POST
Response:
HTTP Status Code: 204 No Content
If the operation is successful, a status code 204 No Content will be returned.
HTTP Status Code: 403 Forbidden
When the hardware does not support this functionality, the service will respond with HTTP status code 403 Forbidden.