meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
documentation:redfish_api [2017/03/24 11:01] – created [API Mapping] bil | documentation:redfish_api [2017/04/25 07:08] – bil | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Redfish API Specification ====== | ====== Redfish API Specification ====== | ||
- | ===== Used Versions ===== | + | ===== Referenced |
- | * Redfish Scalable Platforms Management API Specification | + | |
- | * JSON Schema, Core Definitions and Terminology, | + | * DMTF Redfish Scalable Platforms Management API Specification [[http:// |
- | * JSON Schema, Interactive and Non-Interactive Validation ([[https://tools.ietf.org/html/draft-fge-json-schema-validation-00]]) | + | * DMTF Redfish |
- | * 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]]) | + | * SINA Swordfish |
- | * OData Version 4.0. Part 2: URL Conventions, | + | |
- | * OData Version 4.0. Part 3: Common Schema Definition Language | + | All other referred versions, such as JSON, ODATA and SSDP, are corresponding to the [[http://redfish.dmtf.org/ |
- | * 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]]) | + | ===== API Mapping (main components) ===== |
- | * 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) | + | |
- | | + | ^ RECS%%|%%Box Component ^ Redfish API Resource ^ Redfish Schema ^ Notes ^ |
- | * Hypertext Transfer Protocol (HTTP/1.1) | + | | Root | ServiceRoot | [[http:// |
+ | | Enclosure | Chassis | ||
+ | | Baseboard-Blade | Chassis (ChassisType = Blade) | [[http://redfish.dmtf.org/schemas/ | ||
+ | | Extension-Blade | Chassis (ChassisType = Expansion) | [[http:// | ||
+ | | PCIe Card | PCIeDevice | [[http:// | ||
+ | | Compute Node | ComputerSystem | ||
+ | | Local Storage | SimpleStorage | [[http://redfish.dmtf.org/schemas/v1/SimpleStorage.v1_1_1.json|SimpleStorage.v1_1_1]] | e.g. M.2 SATA SSD @ COM Express Node \\ or eMMC @ Apalis-/Jetson Module | | ||
+ | | Storage Extension | Storage | [[http://redfish.dmtf.org/schemas/Storage.v1_1_1.json|Storage.v1_1_1]] | PCIe attached Storage | | ||
+ | | Ethernet Switch | EthernetSwitch from Intel PSME REST API (Apache 2.0 License) | [[http://www.intel.com/content/www/us/ | ||
+ | | PCIe Switch | PCIeSwitch v0.9.0 (work in progress) | [[http://www.dmtf.org/sites/default/files/standards/ | ||
+ | | Crosspoint Switch | | | maybe treated transparently | | ||
+ | | Composed Node | ComposedNode from Intel PSME REST API (Apache 2.0 License) | [[http://www.intel.com/content/www/ | ||
+ | |||
+ | ===== Endpoint Definition ===== | ||
+ | |||
+ | ^ URI ^ Resource ^ Description ^ | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | | [[documentation: | ||
+ | |||
+ | ===== Schema Definitions ===== | ||
+ | |||
+ | <WRAP group>< | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | </WRAP> | ||
+ | <WRAP quarter column> | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | </ | ||
+ | <WRAP quarter column> | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | </ | ||
+ | <WRAP quarter column> | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | * [[documentation: | ||
+ | </ | ||
+ | </ | ||
- | ===== API Mapping ===== | ||
- | ^ RECS|Box Component ^ Redfish API Resource ^ | ||
- | | Enclosure | Chassis (ChassisType = Enclosure) | | ||
- | | Baseboard-Blade | Chassis (ChassisType = Blade) | | ||
- | | Extension-Blade | Chassis (ChassisType = ?) | | ||
- | | Compute Node | | | ||