bmcweb/docs/Redfish.md

1 # Redfish  chapter
3 bmcweb provides an implementation of the [Redfish][1] API. This document details
4 the Redfish schemas supported by bmcweb. This document also discusses some of
8 ## Redfish Schema
10 The redfish implementation shall pass the [Redfish Service Validator][2] with no
13 The following redfish schemas and fields are targeted for OpenBMC. This is a
16 The latest [Redfish schemas][3] are available from DMTF
28 ### /redfish/v1/
52 ### /redfish/v1/AccountService/
76 ### /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates
81 ### /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates/{Certificate}
101 ### /redfish/v1/AggregationService/
109 ### /redfish/v1/AggregationService/AggregationSources
116 ### /redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
123 ### /redfish/v1/AccountService/Accounts/
131 ### /redfish/v1/AccountService/Accounts/{ManagerAccountId}/
140 - `Locked@Redfish.AllowableValues`
147 ### /redfish/v1/AccountService/LDAP/Certificates/
155 ### /redfish/v1/AccountService/Roles/
164 ### /redfish/v1/AccountService/Roles/{RoleId}/
181 ### /redfish/v1/Cables/
189 ### /redfish/v1/Cables/{CableId}/
197 ### /redfish/v1/CertificateService/
205 ### /redfish/v1/CertificateService/CertificateLocations/
213 ### /redfish/v1/Chassis/
220 ### /redfish/v1/Chassis/{ChassisId}/
249 ### /redfish/v1/Chassis/{ChassisId}/Drive/
256 ### /redfish/v1/Chassis/{ChassisId}/Drive/{DriveId}/
265 ### /redfish/v1/Chassis/{ChassisId}/EnvironmentMetrics/
269 ### /redfish/v1/Chassis/{ChassisId}/Power/
278 ### /redfish/v1/Chassis/{ChassisId}/Sensors/
286 ### /redfish/v1/Chassis/{ChassisId}/Sensors/{Id}/
299 ### /redfish/v1/Chassis/{ChassisId}/Thermal/
307 ### /redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures/{SensorName}/
322 ### /redfish/v1/Chassis/{ChassisId}/Thermal#/Fans/{FanName}/
339 ### /redfish/v1/Chassis/{ChassisId}/Thermal#/Redundancy/{RedundancyName}/
350 ### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem
357 #### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/ThermalMetrics/
365 #### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans
373 #### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanName}/
386 ### /redfish/v1/Chassis/{ChassisId}/Power#/PowerControl/{ControlName}/
399 ### /redfish/v1/Chassis/{ChassisId}/Power#/Voltages/{VoltageName}/
415 ### /redfish/v1/Chassis/{ChassisId}/Power#/PowerSupplies/{PSUName}/
430 ### /redfish/v1/Chassis/{ChassisId}/Power#/Redundancy/{RedundancyName}/
441 #### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies
449 #### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}
465 ### /redfish/v1/EventService/
491 ### /redfish/v1/EventService/Subscriptions/
498 ### /redfish/v1/EventService/Subscriptions/{EventName}/
512 ### /redfish/v1/JsonSchemas/
520 ### /redfish/v1/JsonSchemas/{Id}/
531 ### /redfish/v1/Managers/
538 ### /redfish/v1/Managers/bmc/
574 ### /redfish/v1/Managers/bmc/EthernetInterfaces/
582 ### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/
612 ### /redfish/v1/Managers/bmc/LogServices/
621 `Event` type. This is the new Redfish-defined type.
626 The default implementation uses rsyslog to write Redfish events from the journal
628 files in /var/log/ and returns the appropriate Redfish EventLog Entries for
634 then be translated to Redfish EventLog Entries.
645 ### /redfish/v1/Managers/bmc/LogServices/RedfishLog/
656 ### /redfish/v1/Managers/bmc/LogServices/RedfishLog/Entries/{LogEntryId}/
664 ### /redfish/v1/Managers/bmc/ManagerDiagnosticData/
678 ### /redfish/v1/Managers/bmc/NetworkProtocol/
692 ### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/
700 ### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/
712 ### /redfish/v1/Managers/bmc/Truststore/Certificates/
719 ### /redfish/v1/Registries/
728 ### /redfish/v1/Registries/{MessageRegistryFileId}/
739 ### /redfish/v1/SessionService/
748 ### /redfish/v1/SessionService/Sessions/
756 ### /redfish/v1/SessionService/Sessions/{SessionId}/
765 ### /redfish/v1/Systems/
773 ### /redfish/v1/Systems/system/Bios/
783 ### /redfish/v1/Systems/system/
829 ### /redfish/v1/Systems/system/EthernetInterfaces/
837 ### /redfish/v1/Systems/system/FabricAdapters/
844 ### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/
857 ### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/Ports/
864 ### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/
872 ### /redfish/v1/Systems/system/LogServices/
881 ### /redfish/v1/Systems/system/LogServices/EventLog/
892 ### /redfish/v1/Systems/system/LogServices/EventLog/Entries/
900 ### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
912 ### /redfish/v1/Systems/system/LogServices/SEL/Entries/
921 ### /redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/
934 ### /redfish/v1/Systems/system/Memory/
941 ### /redfish/v1/Systems/system/Memory/{MemoryId}/
962 ### /redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/
969 ### /redfish/v1/Systems/system/PCIeDevices/
977 ### /redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/
995 ### /redfish/v1/Systems/system/Processors/
1003 ### /redfish/v1/Systems/system/Processors/{ProcessorId}/
1025 ### /redfish/v1/Systems/system/ResetActionInfo/
1033 ### /redfish/v1/Systems/system/Storage/
1040 ### /redfish/v1/Systems/system/Storage/{StorageId}/
1048 ### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
1057 ### /redfish/v1/TaskService/
1068 ### /redfish/v1/TaskService/Tasks/
1075 ### /redfish/v1/TelemetryService/
1087 ### /redfish/v1/TelemetryService/MetricReportDefinitions/
1094 ### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
1110 ### /redfish/v1/TelemetryService/MetricReports/
1117 ### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
1127 ### /redfish/v1/TelemetryService/Triggers/
1134 ### /redfish/v1/UpdateService/
1147 ### /redfish/v1/UpdateService/FirmwareInventory/
1155 ### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
1167 [1]: https://www.dmtf.org/standards/redfish
1168 [2]: https://github.com/DMTF/Redfish-Service-Validator
1169 [3]: https://redfish.dmtf.org/schemas/
1170 [4]: https://redfish.dmtf.org/schemas/v1/LogService.json
1172   https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md