1 2 Document Identifier: DSP0218 3 Date: 2018-02-20 4 Version: 0.8.0a 5 Platform Level Data Model (PLDM) for Redfish 6 Device Enablement Specification Information for Work-in-Progress version: IMPORTANT: This document is not a standard. It does not necessarily reflect the views of the DMTF or its members. Because this document is a Work in Progress, this document may still change, perhaps profoundly and without notice. This document is available for public review and comment until superseded. Provide any comments through the DMTF Feedback Portal: http://www.dmtf.org/standards/feedback 7 Supersedes: 8 Document Class: Normative 9 Document Status: Work in Progress 10 Document Language: en-US PLDM for Redfish Device Enablement DSP0218 11 Copyright Notice 12 Copyright © 2018 Distributed Management Task Force, Inc. (DMTF). All rights reserved. 13 DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems 14 management and interoperability. Members and non-members may reproduce DMTF specifications and 15 documents, provided that correct attribution is given. As DMTF specifications may be revised from time to 16 time, the particular version and release date should always be noted. 17 Implementation of certain elements of this standard or proposed standard may be subject to third party 18 patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations 19 to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, 20 or identify any or all such third party patent right, owners or claimants, nor for any incomplete or 21 inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to 22 any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, 23 disclose, or identify any such third party patent rights, or for such party’s reliance on the standard or 24 incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any 25 party implementing such standard, whether such implementation is foreseeable or not, nor to any patent 26 owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is 27 withdrawn or modified after publication, and shall be indemnified and held harmless by any party 28 implementing the standard from any and all claims of infringement by a patent owner for such 29 implementations. 30 For information about patents held by third-parties which have notified the DMTF that, in their opinion, 31 such patent may relate to or impact implementations of DMTF standards, visit 32 http://www.dmtf.org/about/policies/disclosures.php. 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 2 Work in Progress 0.8.0a DSP0218 PLDM for Redfish Device Enablement 48 CONTENTS 49 Foreword ...................................................................................................................................................... 6 50 Introduction ................................................................................................................................................... 7 51 1 Scope .................................................................................................................................................... 8 52 2 Normative references ........................................................................................................................... 8 53 3 Terms and definitions .......................................................................................................................... 10 54 4 Symbols and abbreviated terms ......................................................................................................... 12 55 5 Conventions ........................................................................................................................................ 12 56 5.1 Reserved and Unassigned Values ........................................................................................... 12 57 5.2 Byte Ordering ........................................................................................................................... 12 58 5.3 PLDM for Redfish Device Enablement Data Types ................................................................. 12 59 6 PLDM for Redfish Device Enablement Version .................................................................................. 19 60 7 PLDM for Redfish Device Enablement Overview ............................................................................... 19 61 7.1 Redfish Provider Architecture Overview ................................................................................... 20 62 7.2 Redfish Device Enablement Concepts ..................................................................................... 21 63 7.3 Type Code ................................................................................................................................ 36 64 7.4 Error Completion Codes ........................................................................................................... 36 65 7.5 Timing Specification ................................................................................................................. 37 66 8 Binary Encoded JSON (BEJ) .............................................................................................................. 38 67 8.1 BEJ Design Principles .............................................................................................................. 38 68 8.2 SFLV Tuples ............................................................................................................................. 39 69 8.3 Deferred Binding of Data .......................................................................................................... 40 70 8.4 Example Encoding and Decoding ............................................................................................ 42 71 8.5 BEJ Locators ............................................................................................................................ 47 72 9 Operational Behaviors ........................................................................................................................ 48 73 9.1 Task Lifecycle ........................................................................................................................... 48 74 9.2 Event Lifecycle ......................................................................................................................... 56 75 10 PLDM Commands for Redfish Device Enablement ............................................................................ 58 76 11 PLDM for Redfish Device Enablement – Discovery and Schema Management Commands ............. 60 77 11.1 NegotiateRedfishParameters Command Format ..................................................................... 60 78 11.2 GetSchemaDictionary Command Format ................................................................................ 61 79 11.3 GetSchemaURI Command Format .......................................................................................... 61 80 11.4 GetSchemaInstanceETag Command Format .......................................................................... 62 81 12 PLDM for Redfish Device Enablement – Event Commands ............................................................... 62 82 12.1 QueryRedfishEvents Command Format .................................................................................. 62 83 12.2 RedfishEventComplete Command Format ............................................................................... 63 84 13 PLDM for Redfish Device Enablement – Redfish Task Commands ................................................... 63 85 13.1 RedfishTaskInit Command Format ........................................................................................... 63 86 13.2 RedfishCreate Command Format ............................................................................................ 64 87 13.3 RedfishRead Command Format ............................................................................................... 65 88 13.4 RedfishWrite Command Format ............................................................................................... 67 89 13.5 RedfishAction Command Format ............................................................................................. 67 90 13.6 RedfishDelete Command Format ............................................................................................. 68 91 13.7 RedfishHead Command Format ............................................................................................... 69 92 13.8 SupplyCustomRequestParameters .......................................................................................... 70 93 13.9 RetrieveCustomResponseParameters ..................................................................................... 71 94 13.10 RedfishTaskComplete .............................................................................................................. 72 95 13.11 RedfishTaskStatus ................................................................................................................... 72 96 13.12 RedfishTaskKill ......................................................................................................................... 73 97 13.13 RedfishTaskEnumerate ...........................................................................................................