Skip to content

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"
    },
    "HostName": "edge",
    "HostingRoles": [
        "ApplicationServer"
    ],
    "Id": "1",
    "IndicatorLED": "Off",
    "LastResetTime": "2021-03-13T04:02:57+06:00",
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/1/LogServices"
    },
    "Manufacturer": "AVerMedia",
    "Model": "NVIDIA Jetson",
    "Name": "D135 NX",
    "PartNumber": "224071-J23",
    "PowerState": "On",
    "Oem": {
        "AVerMedia": {
            "StreamState": "Off"
        }
    },
    "SKU": "8675309",
    "SerialNumber": "000001",
    "FirmwareVersion": "0.0.1",
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "State": "Enabled"
    },
    "SubModel": "Orin Nano",
    "SystemType": "Physical",
    "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.

Next section