DSP 0266 Redfish Scalable Platforms Management API Specification Document Number: DSP0266 Date: 2015-04-21 Version: 0.96.0 Redfish Scalable Platforms Management API 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 all of its members. Because this document is a Work in Progress, it may still change, perhaps profoundly. This document is available for public review and comment until the stated expiration date. It expires on: 2015-08-24 Provide any comments through the DMTF Feedback Portal: http://www.dmtf.org/standards/feedback Document Type: Specification Document Status: Work in Progress Document Language: en-US Version 0.96.0 Work in Progress – Not a DMTF Standard – DMTF Confidential 1 DSP 0266 Redfish Scalable Platforms Management API Specification Copyright Notice Copyright © 2014-2015 Distributed Management Task Force, Inc. (DMTF). All rights reserved. DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted. Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party’s reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations. For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/policies/disclosures.php. Version 0.96.0 Work in Progress – Not a DMTF Standard – DMTF Confidential 2 DSP 0266 Redfish Scalable Platforms Management API Specification CONTENTS 1. Scope 2. Normative References 3. Terms and Definitions 4. Symbols and Abbreviated Terms 5. Overview 5.1. Principal Goals & Scope 5.1.1. REST based 5.1.2. Follow OData Conventions 5.1.3. Model Oriented 5.1.4. Separation of Protocol from Data Model 5.1.5. Hypermedia API Service Endpoint 5.1.6. Scope 5.1.7. Limitations 5.2. Service Elements 5.2.1. Synchronous and Asynchronous Operation Support 5.2.2. Eventing Mechanism 5.2.3. Actions 5.2.4. Service Entry Point Discovery 5.2.5. Remote Access Support 5.3. Security 6. Protocol Details 6.1. Use of HTTP 6.1.1. URIs 6.1.2. HTTP Methods 6.1.3. HTTP Redirect 6.1.4. Media Types 6.1.5. ETags 6.2. Protocol Version 6.3. Requests 6.3.1. Request Headers 6.3.2. Read Requests (GET) 6.3.2.1. Service Root Request 6.3.2.2. Metadata Document Request 6.3.2.3. OData Service Document Request 6.3.2.4. Resource Retrieval Requests 6.3.2.4.1. Query Parameters 6.3.2.4.2. Retrieving Collections 6.3.3. HEAD 6.3.4. Data Modification Requests 6.3.4.1. Update (PATCH) 6.3.4.2. Replace (PUT) 6.3.4.3. Create (POST) 6.3.4.4. Delete (DELETE) 6.3.4.5. Actions (POST) 6.4. Responses 6.4.1. Response Headers 6.4.2. Status Codes 6.4.3. Metadata Responses 6.4.3.1. Service Metadata 6.4.3.1.1. Referencing OEM Extensions 6.4.3.1.2. Annotations 6.4.3.2. OData Service Document 6.4.4. Resource Responses 6.4.4.1. Context Property 6.4.4.1.1. Select List 6.4.4.2. Resource Identifier Property 6.4.4.3. Type Property Version 0.96.0 Work in Progress – Not a DMTF Standard – DMTF Confidential 3 DSP 0266 Redfish Scalable Platforms Management API Specification 6.4.4.4. ETag Property 6.4.4.5. Primitive Properties 6.4.4.5.1. DateTime Values 6.4.4.6. Structured Properties 6.4.4.7. Collection Properties 6.4.4.8. Actions Property 6.4.4.8.1. Action Representation 6.4.4.8.2. Allowable Values 6.4.4.9. Links Property 6.4.4.9.1. Reference to a Single Related Resource 6.4.4.9.2. Array of References to Related Resources 6.4.4.10. OEM Property 6.4.4.11. Extended Information 6.4.4.11.1. Extended Object Information 6.4.4.11.2. Extended Property Information 6.4.4.12. Additional Annotations 6.4.5. Resource Collections 6.4.5.1. Context Property 6.4.5.2. Resource Count Property 6.4.5.3. Resource Members Property 6.4.5.4. Partial Results 6.4.5.5. Additional Annotations 6.4.6. Error Responses 6.4.6.1. Extended Information Object 7. Data Model & Schema 7.1. Type Identifiers 7.1.1. Type Identifiers in JSON 7.2. Common Naming Conventions 7.3. Localization Considerations 7.4. Schema Definition 7.4.1. Common Annotations 7.4.1.1. Description 7.4.1.2. Long Description 7.4.2. Schema Documents 7.4.2.1. Referencing other Schemas 7.4.2.2. Namespace Definitions 7.4.3. Resource Type Definitions 7.4.4. Resource Properties 7.4.4.1. Property Types 7.4.4.1.1. Primitive Types 7.4.4.1.2. Structured Types 7.4.4.1.3. Enums 7.4.4.1.4. Collections 7.4.4.2. Non-Nullable properties 7.4.4.3. Read-only properties 7.4.4.4. Required Properties 7.4.4.5. Units of Measure 7.4.4.6. Language-Dependent Property Values 7.4.5. Reference Properties 7.4.5.1. Expanded References 7.4.5.2. Expanded Resources 7.4.6. Resource Actions 7.4.7. Resource Extensibility 7.4.7.1. Property Extensions 7.4.7.2. Custom Actions 7.4.7.3. Custom Annotations 7.5. Common Redfish Resource Properties 7.5.1. Id Version 0.96.0 Work in Progress – Not a DMTF Standard – DMTF Confidential 4 DSP 0266 Redfish Scalable Platforms Management API Specification 7.5.2. Name 7.5.3. Description 7.5.4. Modified 7.5.5. Status 7.5.6. Links 7.5.7. Actions 7.5.8. OEM 7.5.9. Settings 7.5.10. SettingsResult 7.6. Redfish Resources 7.6.1. Current Configuration 7.6.2. Settings 7.6.3. Services 7.6.4. Registry 7.7. Special Resource Situations 7.7.1. Absent Resources 7.7.2. Schema Variations 8. Service Details 8.1. Eventing 8.1.1. Event Message Subscription 8.1.2. Event Message Objects 8.1.3. Subscription Cleanup 8.2. Asynchronous Operations 8.3. Resource Tree Stability 8.4. Discovery 8.4.1. UPnP Compatibility 8.4.2. USN Format 8.4.3. M-SEARCH Response 8.4.4. Notify, Alive, and Shutdown messages 9. Security 9.1. Goals 9.2. Protocols 9.2.1. Discovery 9.2.2. Transport 9.2.2.1. TLS 9.2.2.2. Cipher suites 9.2.2.3. Certificates 9.3. Sensitive Data 9.4. Authentication 9.4.1. HTTP Header Security 9.4.1.1. HTTP Redirect 9.4.2. Extended Error Handling 9.4.3. HTTP Header Authentication 9.4.3.1. BASIC authentication 9.4.3.2. Digest authentication 9.4.3.3. Negotiate 9.4.3.4. Request / Message Level Authentication 9.4.3.5. Certificate based authentication? 9.4.4. Session Management 9.4.4.1. Session Lifecycle Management 9.4.4.2. Login Sessions 9.4.4.3. Login 9.4.4.4. Logout 9.4.4.5. X-Auth-Token HTTP Header 9.4.5. AccountService 9.4.6. Async Tasks 9.4.7. Event Subscriptions 9.4.8. Privilege Model / Authorization Version 0.96.0 Work in Progress – Not a DMTF Standard – DMTF Confidential 5 DSP 0266 Redfish Scalable Platforms Management API Specification 9.4.8.1. Profiles and Roles 9.4.9. Role Based Privilege 9.5. Data Model Validation 9.5.1. Schema 9.6. Logging 9.6.1. Required data for security log entries 9.6.2. Completeness of Logging 9.6.3. Content of Audit Logs 10. ANNEX A (informative) 10.1. Change Log Foreword The Redfish Scalable Platform Management API ("Redfish") was prepared by the Scalable Platforms Management Forum of the DMTF. DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. For information about the DMTF, see http://www.dmtf.org. Acknowledgments The DMTF acknowledges the following individuals for their contributions to this document: Jeff Autor - Hewlett-Packard Company David Brockhaus - Emerson Network Power Richard Brunner - VMware Inc.