Redfish Data Model for Gaudi 3
On this Page
Redfish Data Model for Gaudi 3¶
This document provides information of the Intel® Gaudi® 3 AI accelerator Redfish data model.
GET Operations¶
This section describes the Redfish GET operations.
OAM Assembly Information¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Chassis/system/Assembly/#Assemblies/<ID> |
Response Body:
{
"@odata.id":
"/redfish/v1/Chassis/System.Embedded.1/Assembly#/Assemblies/0",
"@odata.type": "#Assembly.v1_4_0.AssemblyData",
"BinaryDataURI": null,
"Description": "<OAM>",
"EngineeringChangeLevel": null,
"MemberId": "0",
"Model": "NA",
"Name": "<OAM_x>#FRU",
"SerialNumber": "AM27043696" //BoardSerialNumber
}
OAM Status¶
Processor Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID> |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/OAM_4",
"@odata.type": "#IntelProcessor",
"Assembly": {
"odata.id": "/redfish/v1/Chassis/chassis/Assembly"
},
"CacheMemory": {
"odata.id": "/redfish/v1/Systems/system/Processors/OAM_4/CacheMemory"
},
"Id": "OAM_4",
"Metrics": {
"odata.id": "/redfish/v1/Systems/system/Processors/OAM_4/ProcessorMetrics"
},
"Name": "Processor",
"Oem": {
"Intel": {
"VcorePG": "Normal",
"asc0HimonnHvmonP5V": "Normal",
"asc0Vmon1P0V85Pcie": "Normal",
"asc0Vmon2P1V2Pll": "Normal",
"asc0Vmon3P2V5Hbm": "Normal",
"asc0Vmon4Pvref": "Normal",
"asc0Vmon5NicVddL": "Normal",
"asc0Vmon6P12Vin": "Normal",
"asc0Vmon7D2dVdd": "Normal",
"asc0Vmon8P1V2": "Normal",
"asc0Vmon9P0V75Cvdd": "Normal",
"asc1Vmon1Detect00Out": "Normal",
"asc1Vmon1Detect01Out": "Normal",
"asc1Vmon1Detect10Out": "Normal",
"asc1Vmon1Detect11Out": "Normal",
"asc1Vmon1DetectXXOut": "Normal",
"asc1Vmon2Vdd1P2AO": "Normal",
"asc1Vmon3Vdd1P8AO": "Normal",
"asc1Vmon4_6V5": "Normal",
"asc1Vmon5P0V75Hbm": "Normal",
"asc1Vmon6NicVddH": "Normal",
"asc1Vmon7Vdd3P3": "Normal",
"asc1Vmon8_12V1": "Normal",
"asc1Vmon9_48V": "Normal",
"boardTempAlert": "Normal",
"c1CatFltN": "Normal",
"c1VRHot": "Normal",
"c2CatFltN": "Normal",
"c2VRHot": "Normal",
"c3CatFltN": "Normal",
"c3VRHot": "Normal",
"currentAlert": "Normal",
"d2dVddPG": "Normal",
"devicePDRRepositoryVersion": "1.1.0",
"die0HbmPanic": "Normal",
"die0Therm1": "Normal",
"die0Therm2": "Normal",
"die0ThermalWarnOut0L": "Normal",
"die0ThermalWarnOut1L": "Normal",
"die0VmonA": "Normal",
"die0VmonB": "Normal",
"die1HbmPanic": "Normal",
"die1Therm1": "Normal",
"die1Therm2": "Normal",
"die1ThermalWarnOut0L": "Normal",
"die1ThermalWarnOut1L": "Normal",
"die1VmonA": "Normal",
"die1VmonB": "Normal",
"efusePGn": "Normal",
"fwImageSource": "Primary",
"hostPWRGD": "Normal",
"key1Revocation": "Not revoked",
"key2Revocation": "Not revoked",
"key3Revocation": "Not revoked",
"key4Revocation": "Not revoked",
"key5Revocation": "Not revoked",
"memoryCleanup": "Completed Successfully",
"nicVddHPG": "Normal",
"nicVddLPG": "Normal",
"p1V2PG": "Normal",
"permanentSecured": "Not permanent",
"powerFault": "Normal",
"pwrgd1st": "Normal",
"registerWrite": "Power Cycle",
"spiWriteProtect": "Asserted",
"thermalAlert": "Normal"
}
},
"Ports": {
"odata.id": "/redfish/v1/Systems/system/Processors/OAM_4/Ports"
},
"ProcessorMemory": [
{
"IntegratedMemory": true,
"MemoryType": "SRAM"
}
],
"ProcessorType": "Accelerator",
"SerialNumber": "HL3090A0",
"Status": {
"Conditions": [
{
"Message": "The SRAM BIST run during last boot returned with the following
outcome %1. The following values are valid only in case
of failure: The number of failing controllers %2, Read
ID of the first SRAM BIST failing controller %3,
Fail mask of the first SRAM BIST failing controller %4,
Read ID of the second SRAM BIST failing controller %5,
Fail mask of the second SRAM BIST failing controller %6",
"MessageID": "SRAMBISTAlert",
"Resolution": "Open ticket to Intel.",
"Severity": "Warning",
"fieldVal": "All pass",
"normalVal": [
"0",
"1",
"Normal",
"Unknown"
]
}
],
"Health": "OK",
"State": "Enabled"
},
"SubProcessors": {
"odata.id": "/redfish/v1/Systems/system/Processors/OAM_4/SubProcessors"
},
"UUID": "55325739-3937-3133-3039-303300000000"
}
Processor Metrics Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/ProcessorMetrics |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/ProcessorMetrics",
"@odata.type": "#ProcessorMetrics.v1_6_4.ProcessorMetrics",
"BandwidthPercent": 0.0, //deviceUtilizationPercent
"Id": "<OAM_ID>",
"Name": "<OAM_ID>",
"Oem": {
"Intel": {
"Alert": {
"Checksum": {
"EEPROM": "Normal",
"PpBootPrimary": "Normal",
"PpBootSecondary": "Normal",
"PreBootPrimaryStatus": "Normal",
"PreBootSecondaryStatus": "Normal"
},
"D2D": {
"D2DCoreIndex": 0,
"D2DErrorCount": 0,
"D2DErrorState": "Normal",
"D2DMACIndex": 0
},
"PLL": {
"FirstPLLLockIndex": 0
},
"RMA": {
"D2DFatalReplay": "Normal",
"D2DFatalTraining": "Normal",
"SPIGWFatalReplay": "Normal"
},
"Security": {
"PermissionAccessError": "Normal"
},
"SecurityAgent": {
"LastPublicKeyRevoked": "Normal",
"Signature": "Normal",
"SVN": "Normal",
"Zephyr": "Normal"
},
"SecuritySPI": {
"LastPublicKeyRevoked": "Normal",
"RevokedPublicKey": "Normal",
"Signature": "Normal",
"SVN": "Normal"
},
"SPIGW": {
"SPIGWErrorCount": 0
},
"VoltageMonitor": {
"VoltageChannelIndex": 0,
"VoltageMonitorIndex": 0,
"VoltageState": "Normal"
},
"Watchdog": {
"Heartbeat": "Heartbeat present",
"HW": "Normal",
"TDR": "Normal"
}
},
"BootStage": "in Zephyr",
"ChipStatus": "Normal",
"ClockThrottlingCausedbyPower": "Normal",
"ClockThrottlingCausedbyThermal": "Normal",
"DeviceActivity": "Normal",
"DeviceActivityCounter": 19482,
"EmergencyBreak": "Normal",
"HBMThrottling": "Normal",
"HBMThrottlingDuration": 0,
"InternalInterconnectErrors": 0,
"LastClockThrottlingDuration": 0,
"LastPowerBreakDuration": 0,
"LastPowerReductionDuration": 150,
"PowerBreak": "Normal",
"PowerReduction": "Normal",
"PowerState": "P0",
"SERDESAvailability": "Available",
"TotalClockThrottlingDuration": 0
}
}
}
OAM Sensors¶
Standard Sensor Collection¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Chassis/<OAM_ID>/Sensors |
Response Body:
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>/Sensors",
"@odata.type": "#SensorCollection.SensorCollection",
"Description": "Collection of Sensors",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID>"
},
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID>"
},
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID>"
}
],
"Members@odata.count": 3,
"Name": "SensorCollection"
}
Standard Sensors¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID> |
Response Body:
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID>",
"@odata.type": "#Sensor.v1_7_0.Sensor",
"Name": "<Sensor_Name>",
"Id": "<Sensor_ID>",
"Description": "Instance of Sensor Id",
"ReadingType": "Temperature",
"ReadingUnits": "Cel",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"Reading": 39.0,
"PeakReading": 100,
"PhysicalContext": "Accelerator",
"Thresholds": {
"UpperCritical": {
"Reading": 100
},
"UpperCaution": {
"Reading": 80
},
"LowerCaution": {
"Reading": null
},
"LowerCritical": {
"Reading": null
}
}
}
Note
The response for non-threshold sensors does not contain Threshold complex property.
Processor Environment Metrics¶
The OAM sensor data is also modeled with the Oem Intel schema IntelEnvironmentMetrics which is part of standard DMTF schema EnvironmentMetrics.
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/EnvironmentMetrics |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/EnvironmentMetrics",
"@odata.type": "#EnvironmentMetrics.v1_3_0.EnvironmentMetrics",
"Description": "Represents EnvironmentMetrics of the Chassis",
"Id": "EnvironmentMetrics",
"Name": "EnvironmentMetrics",
"Oem": {
"Intel": {
"@odata.type": "#IntelEnvironmentMetrics.v1_0_0.IntelEnvironmentMetrics",
"PowerWatts": [
{
"DataSourceUri": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID1>",
"Reading": 0
},
{
"DataSourceUri": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID2>",
"Reading": 0
}
],
"TemperatureCelsius": [
{
"DataSourceUri": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID1>",
"Reading": 0
},
{
"DataSourceUri": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID2>",
"Reading": 0
}
],
"Voltages": [
{
"DataSourceUri": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID1>",
"Reading": 0
},
{
"DataSourceUri": "/redfish/v1/Chassis/<OAM_ID>/Sensors/<Sensor_ID2>",
"Reading": 0
}
]
}
}
}
OAM Ethernet Information and Ethernet Status¶
Port Collection¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports",
"@odata.type": "#PortCollection.PortCollection",
"Description": "Collection Of Port entities",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports/<Port_ID1>"
},
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports/<Port_ID2>"
},
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports/<Port_ID24>"
}
],
"Members@odata.count": 24, //Number of Links
"Name": "Port Collection"
}
Port Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports/<Port_ID> |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/<Systems_ID>/Processors/<OAM_ID>/Ports/<Port_ID>",
"@odata.type": "#Port.v1_11_0.Port",
"CurrentSpeedGbps": 0, //Link Speed
"Description": "Instance of Port for Processor Network Interface",
"Id": "<OAM_ID>",
"LinkNetworkTechnology": "Ethernet",
"MaxSpeedGbps": 0, //Max Port Speed
"Name": "Processor Network Interface Port View",
"PortId": "<ID>",
"Status": {
"Health": "OK",
"State": "Enabled",
"Oem": {
"Intel": {
"@odata.type": "#IntelPorts.v1_0_0.IntelPorts",
"ANLT": "?",
"BERCorrectable": 0,
"BERUncorrectable": 0,
"ExternalLinkStatus": "?",
"HighBER": 0,
"PCSStatus": "?",
"PHYStatus": "?",
"PortMAP": "?",
"ReInitializations": 0,
"SERPostFEC": 0,
"SERPreFEC": 0,
"StateToggle": 0
}
}
},
"Width": 0 //Number Of Lanes
}
OAM PCIe Information¶
PCIe Devices Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber> |
Note
Not modeled as per OCP Specification. OCP Specification requires correction.
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>",
"@odata.type": "#PCIeDevice.v1_13_0.PCIeDevice",
"Description": "Accelerator",
"DeviceType": "SingleFunction",
"FirmwareVersion": null, //PCIe FW Version
"Id": "<BusNumber-DeviceNumber>",
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>"
}
],
"Chassis@odata.count": 1
},
"Manufacturer": "Manufacturer",
"Name": "<Device_ID>",
"Oem": {
"Intel": {
"@odata.type": "#IntelPCIeDevice.v1_0_0.IntelPCIeDevice",
"HDRLog0": 0,
"HDRLog1": 0,
"HDRLog2": 0,
"HDRLog3": 0,
"ReplayBufferNumRollover": 0,
"RxMemoryReadCount": 0,
"RxMemoryWriteCount": 0,
"TxMemoryReadCount": 0,
"TxMemoryWriteCount": 0,
"MarginToolStatus": "InService",
"StateSensors": {
"PCIeReceiverStatus": "?",
"PCIeReplayTimerTimeoutStatus": "?",
"CompletionTimeoutStatus": "?",
"ECRCErrorStatus": "?",
"DLProtocolErorStatus": "?",
"SurpriseLinkDownErrorStatus": "?",
"FlowControlProtocolErrorStatus": "?",
"ReceiverOverFlowErrorStatus": "?",
"MalformedTLPErrorStatus": "?",
"UncorrectableInternalErrorStatus": ""
}
}
},
"PCIeErrors": {
"CorrectableErrorCount": 0,
"ReplayTimerTimeout": 0
},
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>/PCIeFunctions/<BusNumber-DeviceNumber-FunctionNumber>"
}
],
"PCIeInterface": {
"LaneInUse": 0, //CurrentPCIeLinkWidth
"MaxLanes": 0, //MaxPCIeLinkWidth
"MaxPCIeType": "Gen5", //MaxPCIeLinkSpeed
"PCIeType": "Gen5" //CurrentPCIeLinkSpeed
},
"Slot": {
"Lanes": 16,
"Location": {
"PartLocation": {
"LocationOrdinalValue": 27,
"LocationType": "Slot"
}
},
"PCIeType": "Gen5",
"SlotType": "FullLength"
},
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "PCIeAlert",
"Resolution": "To be filled by Intel",
"Severity": "?"
}
],
"Health": "OK",
"State": "Enabled"
}
}
PCIe Device Functions Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>/PCIeFunctions /<BusNumber-DeviceNumber-FunctionNumber> |
Note
Not modeled as per OCP Specification. OCP Specification requires correction.
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>/PCIeFunctions/<BusNumber-DeviceNumber-FunctionNumber>",
"@odata.type": "#PCIeFunction.v1_6_0.PCIeFunction",
"BusNumber": "x", //PCIe Bus Number
"Description": "OAM_ID",
"DeviceId": "0x00e6", //PCIe Device ID
"DeviceNumber": "x", //PCIe Device Number
"Enabled": true,
"FunctionId": 0,
"FunctionType": "Physical",
"Id": "<BusNumber-DeviceNumber-FunctionNumber>",
"Links": {
"PCIeDevice": {
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>"
}
},
"Name": "<OAM_ID>",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
},
"SubsystemId": "x", //PCIe Subsystem ID
"SubsystemVendorId": "x", //PCIe Subsystem Vendor ID
"VendorId": "x" //PCIe Vendor ID
}
OAM HBM¶
Memory Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Memory/<OAM_ID> |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Memory/<OAM_ID>",
"@odata.type": "#Memory.v1_17_1.Memory",
"CapacityMiB": 131072000000.0, //hbmUsedMemorySize
"Description": "<HBM_Info>",
"Id": "<OAM_ID>",
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>"
}
],
"Processors@odata.count": 1
},
"MemoryDeviceType": "HBM2E",
"Metrics": {
"@odata.id": "/redfish/v1/Systems/system/Memory/<OAM_ID>/MemoryMetrics"
},
"Name": "<HBM_Info>",
"OperatingSpeedMhz": 4800,
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "HBMMemoryAlert",
"Resolution": "To be filled by Intel",
"Severity": "?"
},
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "HBMCATTRIPAlert",
"Resolution": "To be filled by Intel",
"Severity": "?"
}
],
"Health": "OK",
"State": "Enabled"
}
}
Memory Metrics¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Memory/<OAM_ID>/MemoryMetrics |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Memory/<OAM_ID>/MemoryMetrics",
"@odata.type": "#MemoryMetrics.v1_7_2.MemoryMetrics",
"CapacityUtilizationPercent": 1.0, //hbmUtilizationPercent
"Description": "Metrics of the memory device",
"HealthData": {
"AlarmTrips": {
"AddressParityError": false, //Based on Fatal Parity Errors
"CorrectableECCError": false, //Based on Single/Double ECC Errors
"UncorrectableECCError": false //Based on Fatal ECC Errors
}
},
"Id": "<OAM_ID>",
"Name": "<OAM_ID> Metrics",
"Oem": {
"Intel": {
"@odata.type": "#IntelMemoryMetrics.v1_0_0.IntelMemoryMetrics",
"StateSensors": {
"fatalHBMecc": "Normal",
"fatalHBMparity": "Normal",
"hbmECC": "Normal",
"hbmInitialization": "No failure",
"hbmLaneRepair": "Normal",
"hbmMBISTFailCause": "1",
"hbmMBISTIndex": "Unknown",
"hbmMBISTUnrepairable": "1",
"hbmParity": "Normal",
"hbmRowReplacement": "Normal"
},
"banksWithHighReplacedRows": 0.0,
"banksWithLowReplacedRows": 0.0,
"banksWithNoReplacedRows": 0.0,
"banksWithPartialReplacedRows": 0.0,
"changeableRowReplacements": 0.0,
"hbm0GlobalECC": 0.0,
"hbm0LanesRepaired": 0.0,
"hbm1GlobalECC": 0.0,
"hbm1LanesRepaired": 0.0,
"hbm2GlobalECC": 0.0,
"hbm2LanesRepaired": 0.0,
"hbm3GlobalECC": 0.0,
"hbm3LanesRepaired": 0.0,
"hbm4GlobalECC": 0.0,
"hbm4LanesRepaired": 0.0,
"hbm5GlobalECC": 0.0,
"hbm5LanesRepaired": 0.0,
"hbm6GlobalECC": 0.0,
"hbm6LanesRepaired": 0.0,
"hbm7GlobalECC": 0.0,
"hbm7LanesRepaired": 0.0,
"hbmDoubleECCErrTotalCount": 0.0,
"hbmDoubleECCEventCount": 0.0,
"hbmFatalECCEventsCount": 0.0,
"hbmFatalParity": 0.0,
"hbmFreeMemorySize": 130400000000.0,
"hbmSingleECCBurstCount": 0.0,
"hbmSingleECCErrTotalCount": 0.0,
"hbmThrottling": "Normal",
"hbmThrottlingDuration": 0.0,
"hbmUsedMemorySize": 672000000.0,
"nonChangeableRowReplacements": 0.0
}
},
"OperatingSpeedMHz": 4800
}
OAM Core (TPC and MME)¶
Sub Processor Collection¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/SubProcessors |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/SubProcessors",
"@odata.type": "#ProcessorCollection.ProcessorCollection",
"Description": "Collection of Processors for this System",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/System.Embedded.1/Processors/<OAM_ID1>/Subprocessors"
},
{
"@odata.id": "/redfish/v1/Systems/System.Embedded.1/Processors/<OAM_ID2>/Subprocessors"
}
],
"Members@odata.count": 2,
"Name": "ProcessorsCollection"
}
Sub Processor Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/SubProcessors /{Core_ID} |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/SubProcessors/{Core_ID}",
"@odata.type": "#Processor.v1_18_0.Processor",
"Description": "Represents the properties of the processor core",
"Enabled": true,
"Id": "<Core_ID>",
"Name": "<Core_ID>",
"ProcessorType": "Core",
"MaxSpeedMHz": 0, //Max TPC Frequency or Max MME Frequency
"OperatingSpeedMHz": 0 //Current TPC Frequency or Current MME Frequency
}
OAM SRAM¶
Cache Memory Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory /<SRAM_ID> |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory/<SRAM_ID>",
"@odata.type": "#Memory.v1_17_1.Memory",
"Description": "<SRAM_Info>",
"Id": "<SRAM_ID>",
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>"
}
],
"Processors@odata.count": 1
},
"MemoryDeviceType": "SRAM",
"Metrics": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory/<SRAM_ID>/MemoryMetrics"
},
"Name": "<SRAM_Info>",
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "SRAMMemoryAlert",
"Resolution": "To be filled by Intel",
"Severity": "Fatal"
}
],
"Health": "OK",
"State": "Enabled"
}
}
Memory Metrics Instance¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory /<SRAM_ID>/MemoryMetrics |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory/<SRAM_ID>/MemoryMetrics",
"@odata.type": "#MemoryMetrics.v1_7_2.MemoryMetrics",
"Description": "Metrics of the memory device",
"HealthData": {
"AlarmTrips": {
"AddressParityError": false, //Based on Fatal Parity Errors
"CorrectableECCError": false, //Based on Single/Double ECC Errors
"UncorrectableECCError": false //Based on Fatal ECC Errors
}
},
"Id": "<SRAM_ID>",
"Name": "<SRAM_ID> Metrics",
"Oem": {
"Intel": {
"BISTControllerFailCount": 0,
"DoubleECCCount": 0,
"FatalECCCount": 0,
"FatalErrorEventCount": 0,
"FirstSRAMBISTFailControllerReadId": 0,
"SecondSRAMBISTFailControllerFailMask": 0,
"SecondSRAMBISTFailControllerReadId": 0,
"SingleECCCount": 0,
"TotalSingleECCErrorCount": 0,
"TotalDoubleECCErrorCount": 0,
"StateSensors": {
"FatalSRAMECC": "?",
"SRAMECC": "?",
"SRAMRepairFailure": "?"
}
}
}
}
OAM Alerts¶
Processor Alerts¶
This resource dynamically lists following alerts: FatalRMA, NIC, PLL Lock, D2D, SPIGW, Temperature, Voltage, Power, Security, WD, Checksum, FIT.
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/#Status/Conditions |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>",
"@odata.type": "#Processor.v1_18_0.Processor",
"Actions": {
"#Processor.Reset": {
"ResetType@Redfish.AllowableValues": [
"ForceRestart"
],
"target": "/redfish/v1/Systems/system/Processors/<OAM_ID>/Actions/Processor.Reset"
}
},
"Assembly": {
"@odata.id": "/redfish/v1/Chassis/system/Assembly"
},
"CacheMemory": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory"
},
"Description": "Represents the properties of the Accelerator attached to this System",
"Enabled": true,
"EnvironmentMetrics": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/EnvironmentMetrics"
},
"Id": "<OAM_ID>",
"Manufacturer": "Intel",
"Metrics": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/ProcessorMetrics"
},
"Name": "<OAM_ID>",
"Oem": {
"Intel": {
"@odata.type": "#IntelProcessor.v1_0_0.IntelProcessor",
"CPLDVersion": 0,
"CPLDVersionTimestamp": 0,
"CurrentPublicKeyHashIndex": 0,
"CurrentSVN": 0,
"DevicePDRRepositoryVersion": 196608,
"FWImageSource": "?",
"Key1Revocation": "?",
"Key2Revocation": "?",
"Key3Revocation": "?",
"Key4Revocation": "?",
"Key5Revocation": "?",
"KMDVersion": 17825792,
"ManagementFirmwareVersion": 671089152,
"MemoryCleanup": "?",
"MinimalSVN": 0,
"PermanentSecured": "?",
"RDMADriverVersion": 132352,
"SPIWriteProtect": "?"
}
},
"PartNumber": null,
"Ports": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/Ports"
},
"ProcessorId": {
"VendorId": "1DA3"
},
"ProcessorMemory": [
{
"IntegratedMemory": true,
"MemoryType": "HBM2E",
"SpeedMHz": 0 //Current HBM Frequency
},
{
"IntegratedMemory": true,
"MemoryType": "SRAM"
}
],
"ProcessorType": "Accelerator", //PackageType
"SerialNumber": "0383768B", //ASICSerialNumber
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "FatalRMA",
"Resolution": "To be filled by Intel",
"Severity": "Fatal"
}
],
"Health": "OK", //HealthState
"State": "Enabled"
},
"SubProcessors": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/SubProcessors"
},
"UUID": "TF8A77-07-06-02",
"Version": "R0C" //ASICRevision
}
SRAM Alerts¶
This resource dynamically lists following alerts: SRAM Memory, SRAM BIST.
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory/#Status /Conditions |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory/<SRAM_ID>",
"@odata.type": "#Memory.v1_17_1.Memory",
"Description": "<SRAM_Info>",
"Id": "<SRAM_ID>",
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>"
}
],
"Processors@odata.count": 1
},
"MemoryDeviceType": "Cache",
"Metrics": {
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>/CacheMemory/<SRAM_ID>/MemoryMetrics"
},
"Name": "<SRAM_Info>",
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "SRAMMemoryAlert",
"Resolution": "To be filled by Intel",
"Severity": "Fatal"
}
],
"Health": "OK",
"State": "Enabled"
}
}
HBM Alerts¶
This resource dynamically lists following alerts: HBM Memory, HBM CATTRIP, HBM MBIST Failure Index, HMB MBIST Failure Cause.
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/Memory/<OAM_ID>/#Status/Conditions |
Response Body:
{
"@odata.id": "/redfish/v1/Systems/system/Memory/<OAM_ID>",
"@odata.type": "#Memory.v1_17_1.Memory",
"Description": "<HBM_Info>",
"Id": "<OAM_ID>",
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/system/Processors/<OAM_ID>"
}
],
"Processors@odata.count": 1
},
"MemoryDeviceType": "HBM2E",
"Metrics": {
"@odata.id": "/redfish/v1/Systems/system/Memory/<OAM_ID>/MemoryMetrics"
},
"Name": "<HBM_Info>",
"OperatingSpeedMhz": 4800,
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "HBMMemoryAlert",
"Resolution": "To be filled by Intel",
"Severity": "?"
},
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "HBMCATTRIPAlert",
"Resolution": "To be filled by Intel",
"Severity": "?"
}
],
"Health": "OK",
"State": "Enabled"
}
}
PCIe Alerts¶
This resource dynamically lists the PCIe alerts.
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>/#Status/Conditions |
Note
Not modeled as per OCP Specification. OCP Specification requires correction.
Response Body:
{
"@odata.etag": "\"1715674633\"",
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>",
"@odata.type": "#PCIeDevice.v1_13_0.PCIeDevice",
"Description": "Accelerator",
"DeviceType": "SingleFunction",
"FirmwareVersion": null, //PCIe FW Version
"Id": "<OAM_ID>",
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/<OAM_ID>"
}
],
"Chassis@odata.count": 1
},
"Manufacturer": "Manufacturer",
"Name": "<Device_ID>",
"Oem": {
"Intel": {
"@odata.type": "#IntelPCIeDevice.v1_0_0.IntelPCIeDevice",
"HDRLog0": 0,
"HDRLog1": 0,
"HDRLog2": 0,
"HDRLog3": 0,
"ReplayBufferNumRollover": 0,
"ReplayRolloverCount": 0,
"RxMemoryRead": 0,
"RxMemoryWrite": 0,
"TxMemoryRead": 0,
"TxMemoryWrite": 0,
"MarginToolStatus": "InService"
}
},
"PCIeErrors": {
"CorrectableErrorCount": 0,
"ReplayTimerTimeout": 0
},
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices/<BusNumber-DeviceNumber>/PCIeFunctions/<BusNumber-DeviceNumber-FunctionNumber>"
}
],
"PCIeInterface": {
"LaneInUse": 0, //CurrentPCIeLinkWidth
"MaxLanes": 0, //MaxPCIeLinkWidth
"MaxPCIeType": "Gen5", //MaxPCIeLinkSpeed
"PCIeType": "Gen5" //CurrentPCIeLinkSpeed
},
"Slot": {
"Lanes": 16,
"Location": {
"PartLocation": {
"LocationOrdinalValue": 27,
"LocationType": "Slot"
}
},
"PCIeType": "Gen5",
"SlotType": "FullLength"
},
"Status": {
"Conditions": [
{
"Message": "To be filled by Intel",
"MessageArgs": [
""
],
"MessageId": "PCIeAlert",
"Resolution": "To be filled by Intel",
"Severity": "?"
}
],
"Health": "OK",
"State": "Enabled"
}
}
Intel Message Registry for Alerts¶
Response Body:
{
"@odata.type": "#MessageRegistry.v1_6_2.MessageRegistry",
"Description": "This registry defines the base messages for Redfish.",
"Id": "Intel.1.0.0",
"Language": "en",
"Messages": {
"ChecksumAlert": {
"Description": "Indicates that a checksum error was detected on a FW memory.",
"LongDescription": "This message shall indicate that an error was detected in a FW memory.",
"Message": "Checksum error detected in '%1' memory.",
"NumberOfArgs": 1,
"ParamTypes": [
"string"
],
"ArgDescriptions": [
"The device description where the error occurred."
],
"ArgLongDescriptions": [
"This argument shall contain a description of the device where the error occurred."
],
"Resolution": "To be filled by Intel",
"MessageSeverity": "Warning"
},
"D2DAlert": {
"Description": "Indicates that a Die to Die error was detected.",
"LongDescription": "This message shall indicate that an error in the Die to Die has occurred.",
"Message": "Error in Die2Die on Core '%1' in MAC '%2' error count is '%3' with state '%4'.",
"NumberOfArgs": 4,
"ParamTypes": [
"number",
"number",
"number",
"string"
],
"ArgDescriptions": [
"The device core where the error occurred.",
"The device MAC where the error occurred.",
"The device error count of the error on the device.",
"The device state when the error has occurred."
],
"ArgLongDescriptions": [
"This argument shall contain the number of the core where the error has occurred.",
"This argument shall contain the number of the MAC where the error has occurred.",
"This argument shall contain the number errors that have occurred.",
"This argument shall contain the state of the error that has occurred."
],
"MessageSeverity": "Warning"
},
"FatalRMAAlert": {
"Description": "Indicates that a fatal error has occurred that resulted in RMA of device.",
"LongDescription": "This message shall indicate that a fatal error has occurred in the device and RMA flag has been set.",
"Message": "The device has entered RMA mode because of a fatal error in '%1'.",
"NumberOfArgs": 1,
"ParamTypes": [
"string"
],
"ArgDescriptions": [
"The fatal error that has occurred that caused the RMA event."
],
"ArgLongDescriptions": [
"This argument shall contain a description of the RMA event that has led to set the RMA status of the device."
],
"Resolution": "Replace faulty unit.",
"MessageSeverity": "Critical"
},
"FITAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"HBMCATTRIPAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"HBMMemoryAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"NICAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"PCIeAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"PLLLockAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"PowerAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"PSIGWAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"SecurityAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"SRAMBISTAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"SRAMMemoryAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"TemperatureAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"VoltageAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
},
"WDAlert": {
"Description": "To be filled by Intel",
"LongDescription": "To be filled by Intel",
"Message": "To be filled by Intel",
"NumberOfArgs": 0,
"Resolution": "To be filled by Intel",
"Severity": "?"
}
},
"Name": "Intel Message Registry",
"OwningEntity": "Intel",
"RegistryPrefix": "Intel",
"RegistryVersion": "1.0.0"
}
UBB CPLD Faults¶
Format:
Parameter |
Value |
|---|---|
Operation type |
GET |
URI |
/redfish/v1/Chassis/UBB |
Response Body:
{
"@odata.id": "/redfish/v1/Chassis/UBB",
"@odata.type": "#Chassis.v1_22_0.Chassis",
"Actions": {
"#Chassis.Reset": {
"@Redfish.ActionInfo": "/redfish/v1/Chassis/UBB/ResetActionInfo",
"target": "/redfish/v1/Chassis/UBB/Actions/Chassis.Reset"
}
},
"ChassisType": "RackMount",
"Name": "Chassis Collection",
"Oem": {
"Intel": {
"AlertFaultCause1": {
"ASC0_HIMONN_HVMON_P54V_P12V_OK": false,
"ASC0_VMON1_P3V3_HTS_OAM_OK": false,
"ASC2_HIMONN_HVMON_P12V_STBY_OK": false,
"ASC2_VMON9_VCC54_OK": false,
"P3V3_HTS_OAM_PGD": false,
"P54V_P12V_PGD": false
},
"AlertFaultCause10": {
"M0_THERMTRIP_N": false,
"M1_THERMTRIP_N": false,
"M2_THERMTRIP_N": false,
"M3_THERMTRIP_N": false,
"M4_THERMTRIP_N": false,
"M5_THERMTRIP_N": false,
"M6_THERMTRIP_N": false,
"M7_THERMTRIP_N": false
},
"AlertFaultCause11": {
"M0_reg_request": false,
"M1_reg_request": false,
"M2_reg_request": false,
"M3_reg_request": false,
"M4_reg_request": false,
"M5_reg_request": false,
"M6_reg_request": false,
"M7_reg_request": false
},
"AlertFaultCause2": {
"ASC2_VMON1_PCIE_RT_0_3_1V2_OK": false,
"ASC2_VMON2_PCIE_RT_4_7_1V2_OK": false,
"ASC2_VMON3_P1V8_PCIE_RT_OK": false,
"PCIE_RT_1V2_PG_0_3": false,
"PCIE_RT_1V2_PG_4_7": false
},
"AlertFaultCause3": {
"ASC2_VMON5_P0V9_PCIE_Retimer_0_1_OK": false,
"ASC2_VMON6_P0V9_PCIE_Retimer_2_3_OK": false,
"ASC2_VMON7_P0V9_PCIE_Retimer_4_5_OK": false,
"ASC2_VMON8_P0V9_PCIE_Retimer_6_7_OK": false,
"PCIE0_1_0V9_PGD": false,
"PCIE2_3_0V9_PGD": false,
"PCIE4_5_0V9_PGD": false,
"PCIE6_7_0V9_PGD": false
},
"AlertFaultCause4": {
"ASC1_VMON5_P3V3_OSFP_OK": false,
"ASC1_VMON7_VDD2_5V_OSFP_OK": false,
"ASC1_VMON8_SD0_0V75_AVS_OK": false,
"ASC1_VMON9_SD1_0V75_AVS_OK": false,
"P3V3_OSFP_PG": false,
"SD0_PG": false,
"SD1_PG": false
},
"AlertFaultCause5": {
"ASC1_HIMONN_HVMON_SD2_0V75_AVS_OK": false,
"ASC1_VMON1_P1V8_SDRT_OK": false,
"ASC1_VMON2_P1V5_SDRT_OK": false,
"ASC1_VMON3_SD_0V9_OK": false,
"ASC1_VMON4_SD_0V75_OK": false,
"SD2_PG": false,
"SD_0V75_PG": false,
"SD_0V9_PG": false
},
"AlertFaultCause6": {
"ASC1_VMON6_P1V8_SD_CLK_OK": false,
"ASC2_VMON4_P3V3_BUFFER_OK": false,
"P3V3_BUFFER_PG": false
},
"AlertFaultCause7": {
"ASC0_VMON2_P54V_OAM0_OK": false,
"ASC0_VMON3_P54V_OAM1_OK": false,
"ASC0_VMON4_P54V_OAM2_OK": false,
"ASC0_VMON5_P54V_OAM3_OK": false,
"ASC0_VMON6_P54V_OAM4_OK": false,
"ASC0_VMON7_P54V_OAM5_OK": false,
"ASC0_VMON8_P54V_OAM6_OK": false,
"ASC0_VMON9_P54V_OAM7_OK": false
},
"AlertFaultCause8": {
"P12V_OAM0_PGD": false,
"P12V_OAM1_PGD": false,
"P12V_OAM2_PGD": false,
"P12V_OAM3_PGD": false,
"P12V_OAM4_PGD": false,
"P12V_OAM5_PGD": false,
"P12V_OAM6_PGD": false,
"P12V_OAM7_PGD": false
},
"AlertFaultCause9": {
"P3V3_HTS_OAM0_PGD": false,
"P3V3_HTS_OAM1_PGD": false,
"P3V3_HTS_OAM2_PGD": false,
"P3V3_HTS_OAM3_PGD": false,
"P3V3_HTS_OAM4_PGD": false,
"P3V3_HTS_OAM5_PGD": false,
"P3V3_HTS_OAM6_PGD": false,
"P3V3_HTS_OAM7_PGD": false
},
"FaultCause": {
"hib_request": false,
"power_fault": false,
"register_write": false
}
}
},
"PCIeDevices": {
"@odata.id": "/redfish/v1/Systems/system/PCIeDevices"
},
"Status": {
"Health": "OK",
"HealthRollup": "OK"
}
}
POST Operations¶
This section describes the Redfish POST operations.
OAM Reset¶
OAM reset action is modeled as per the standard DMTF Processor schema.
Format:
Parameter |
Value |
|---|---|
Operation type |
POST |
URI |
/redfish/v1/Systems/system/Processors<OAM_ID>/Actions/Processor.Reset |
Action Parameter¶
ResetType parameter is not a mandatory. Currently only one reset type is supported for this action by default:
{
ResetType: "ForceRestart"
}
Action Response¶
HTTP Status code is 204 and the response body is empty.
References¶
Resource |
DMTF Schema Link |
|---|---|
Assembly |
https://redfish.dmtf.org/schemas/v1/Assembly.v1_5_0.json#/definitions/Assembly |
Processor |
https://redfish.dmtf.org/schemas/v1/Processor.v1_19_0.json#/definition/Processor |
Sensors |
https://redfish.dmtf.org/schemas/v1/Sensor.v1_8_1.json#/definitions/Sensor |
Port |
|
PCIeDevice |
|
Memory |