meta data for this page
This is an old revision of the document!
Redfish API Specification
Used Versions
- Redfish Scalable Platforms Management API Specification 1.1.0 (http://redfish.dmtf.org/schemas/DSP0266_1.1.html)
- JSON Schema, Core Definitions and Terminology, Draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04)
- JSON Schema, Interactive and Non-Interactive Validation (https://tools.ietf.org/html/draft-fge-json-schema-validation-00)
- OData Version 4.0. Part 1: Protocol, Plus Errata 03 (http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html)
- OData Version 4.0. Part 2: URL Conventions, Plus Errata 03 (http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html)
- OData Version 4.0. Part 3: Common Schema Definition Language (CSDL), Plus Errata 03 (http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part3-csdl.html)
- OData Version 4.0: Core Vocabulary, Plus Errata 02 (http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/vocabularies/Org.OData.Core.V1.xml)
- OData Version 4.0: Measures Vocabulary, Plus Errata 02 (http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/vocabularies/Org.OData.Measures.V1.xml)
- OData JSON Format Version 4.0 Plus Errata 03 (http://docs.oasis-open.org/odata/odata-json-format/v4.0/odata-json-format-v4.0.html)
- Simple Service Discovery Protocol/1.0, Draft 3 (https://tools.ietf.org/html/draft-cai-ssdp-v1-03)
- Hypertext Transfer Protocol (HTTP/1.1)
API Mapping (main components)
RECS|Box Component | Redfish API Resource | Redfish Schema | Notes |
---|---|---|---|
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) | 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 |