meta data for this page
This is an old revision of the document!
Redfish API Specification
Referenced Versions
- DMTF Redfish Scalable Platforms Management API Specification 1.1.0
- DMTF Redfish Schema Version 2016.3
All other referred versions, such as JSON, ODATA and SSDP, are corresponding to the normative references of the Redfish Scalable Platforms Management API Specification of the version noted above.
API Mapping (main components)
RECS|Box Component | Redfish API Resource | Redfish Schema | Notes |
---|---|---|---|
Root | ServiceRoot | ServiceRoot.v1_1_1 | |
Enclosure | Chassis (ChassisType = Enclosure) | Chassis.v1_4_0 | |
Baseboard-Blade | Chassis (ChassisType = Blade) | Chassis.v1_4_0 | Dual-LP-Basebords are treated as one Blade |
Extension-Blade | Chassis (ChassisType = Expansion) | Chassis.v1_4_0 | expands the (COM-Express) Baseboard-Blade |
PCIe Card | PCIeDevice | PCIeDevice.v1_0_1 | any PCIe Card in an Extension-Blade |
Compute Node | ComputerSystem (SystemType = Physical) | ComputerSystem.v1_3_0 | COM-Express, Apalis and Jetson Modules |
Local Storage | SimpleStorage | SimpleStorage.v1_1_1 | e.g. M.2 SATA SSD @ COM Express Node or eMMC @ Apalis-/Jetson Module |
Storage Extension | Storage | Storage.v1_1_1 | PCIe attached Storage |
Ethernet Switch | EthernetSwitch from Intel PSME REST API (Apache 2.0 License) | Intel RSD PSME API or GitHub | currently not in official Redfish API |
PCIe Switch | PCIeSwitch v0.9.0 (work in progress) | Redfish PCIe and FW Update Schemas (ZIP file) | maybe treated transparently not officially released yet (work in progress) |
Crosspoint Switch | maybe treated transparently | ||
Composed Node | ComposedNode from Intel PSME REST API (Apache 2.0 License) | Intel RSD PSME API or GitHub | to be checked if it really fits our needs |
Endpoint Definition
URI | Resource | Description |
---|---|---|
/redfish | Provides the protocol version | |
/redfish/v1 | ServiceRoot | Root Redfish service |
/redfish/v1/$metadata | Metadata document, describes the resources available at the root, and references additional metadata documents | |
/redfish/v1/odata | OData service document, provides a standard format for enumerating the resources exposed by the service | |
/redfish/v1/AccountService | AccountService | Resource for managing accounts |
/redfish/v1/SessionService | SessionService | Resource for managing sessions |
/redfish/v1/Managers | ManagerCollection | A Collection of Manager resource instances |
/redfish/v1/Chassis | ChassisCollection | A Collection of Chassis resource instances |
/redfish/v1/Systems | ComputerSystemCollection | A Collection of ComputerSystem resource instances |
/redfish/v1/EthernetSwitches | EthernetSwitchCollection | A Collection of EthernetSwitch resource instances |