meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
documentation:redfish_api [2017/03/30 06:26] – [API Mapping (main components)] bildocumentation:redfish_api [2017/10/13 09:29] (current) – removed vor
Line 1: Line 1:
-====== 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 ^ 
-| Root | ServiceRoot | [[http://redfish.dmtf.org/schemas/ServiceRoot.v1_1_1.json|ServiceRoot.v1_1_1]] |  | 
-| Enclosure | Chassis (ChassisType = Enclosure) | [[http://redfish.dmtf.org/schemas/Chassis.v1_4_0.json|Chassis.v1_4_0]] |  | 
-| Baseboard-Blade | Chassis (ChassisType = Blade) | [[http://redfish.dmtf.org/schemas/Chassis.v1_4_0.json|Chassis.v1_4_0]] | Dual-LP-Basebords are treated as one Blade | 
-| Extension-Blade | Chassis (ChassisType = Expansion) | [[http://redfish.dmtf.org/schemas/Chassis.v1_4_0.json|Chassis.v1_4_0]] | expands the (COM-Express) Baseboard-Blade | 
-| PCIe Card | PCIeDevice | [[http://redfish.dmtf.org/schemas/PCIeDevice.v1_0_1.json|PCIeDevice.v1_0_1]] | any PCIe Card in an Extension-Blade | 
-| Compute Node | ComputerSystem (SystemType = Physical) | [[http://redfish.dmtf.org/schemas/ComputerSystem.v1_3_0.json|ComputerSystem.v1_3_0]] | COM-Express, Apalis and Jetson Modules | 
-| 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/en/architecture-and-technology/rack-scale-design/psme-api-specification.html|Intel RSD PSME API]] or [[https://github.com/01org/intelRSD/blob/master/PSME/application-ref/include/psme/rest-ref/metadata/xml/EthernetSwitch.xml|GitHub]] | currently not in official Redfish API | 
-| PCIe Switch | PCIeSwitch v0.9.0 (work in progress) | [[http://www.dmtf.org/sites/default/files/standards/documents/DSP8010_WIP_2016.0.9a.zip|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) | [[http://www.intel.com/content/www/us/en/architecture-and-technology/rack-scale-design/psme-api-specification.html|Intel RSD PSME API]] or [[https://github.com/01org/intelRSD/blob/master/PSME/application-ref/include/psme/rest-ref/metadata/xml/ComposedNode.xml|GitHub]] | to be checked if it really fits our needs | 
- 
-===== API Definition ===== 
- 
-  * [[documentation:redfish_api:protocol_version|Protocol version]] 
-  * [[documentation:redfish_api:service_root|Service Root]] 
-    * [[documentation:redfish_api:account_service|Account Service]] 
-    * [[documentation:redfish_api:session_service|Session Service]] 
-    * [[documentation:redfish_api:manager_collection|Manager Collection]] 
-    * [[documentation:redfish_api:chassis_collection|Chassis Collection]] 
-    * [[documentation:redfish_api:system_collection|System Collection]] 
-    * [[documentation:redfish_api:ethernet_switch_collection|Ethernet Switch Collection]] 
-    * [[documentation:redfish_api:pcie_switch_collection|PCIe Switch Collection]] 
-    * [[documentation:redfish_api:composed_node_collection|Composed Node Collection]] 
- 
- 
-