BS ISO/IEC 30115-1:2022
$215.11
Information technology. Redfish scalable platforms management API specification – Redfish Specification v1.13.0
Published By | Publication Date | Number of Pages |
BSI | 2022 | 198 |
PDF Catalog
PDF Pages | PDF Title |
---|---|
2 | undefined |
15 | 1 Foreword {-} 1.1 Acknowledgments {-} |
17 | 2 Introduction {-} |
18 | 3 Scope |
19 | 4 Normative references |
21 | 5 Terms, definitions, symbols, and abbreviated terms 5.1 Hardware terms 5.1.1 baseboard management controller (BMC) 5.1.2 IPMI |
22 | 5.1.3 KVM-IP 5.1.4 NIC 5.1.5 PCI 5.1.6 PCIe 5.2 Web development terms 5.2.1 CORS 5.2.2 CRUD 5.2.3 CSRF 5.2.4 event 5.2.5 excerpt |
23 | 5.2.6 HTTP 5.2.7 HTTPS 5.2.8 hypermedia API 5.2.9 IP 5.2.10 JSON 5.2.11 member 5.2.12 message 5.2.13 OData 5.2.14 OData service document |
24 | 5.2.15 operation 5.2.16 parent resource 5.2.17 property 5.2.18 request 5.2.19 response 5.2.20 subscription 5.2.21 task 5.2.22 task monitor 5.2.23 TCP |
25 | 5.2.24 TLS 5.2.25 XSS 5.3 Redfish terms 5.3.1 collection 5.3.2 Redfish client 5.3.3 Redfish protocol 5.3.4 Redfish schema 5.3.5 Redfish service 5.3.6 resource |
26 | 5.3.7 resource collection 5.3.8 resource tree 5.3.9 resource type 5.3.10 service root 5.3.11 subordinate resource |
27 | 6 Typographical conventions |
28 | 7 Overview 7.1 Goals |
29 | 7.2 Design tenets 7.3 Limitations |
30 | 7.4 Additional design background and rationale 7.4.1 REST-based interface 7.4.2 Data-oriented 7.4.3 Separation of protocol from data model 7.4.4 Hypermedia API service root 7.4.5 OpenAPI v3.0 support |
31 | 7.4.6 OData conventions 7.5 Service elements 7.5.1 Synchronous and asynchronous operation support 7.5.2 Eventing mechanism |
32 | 7.5.3 Actions 7.5.4 Service discovery 7.5.5 Remote access support 7.6 Security |
33 | 8 Protocol details 8.1 Universal Resource Identifiers |
35 | 8.2 HTTP methods |
36 | 8.3 HTTP redirect 8.4 Media types 8.5 ETags |
37 | 8.6 Protocol version |
38 | 8.7 Redfish-defined URIs and relative reference rules |
40 | 9 Service requests 9.1 Request headers |
43 | 9.2 GET (read requests) 9.2.1 GET (read requests) overview 9.2.2 Resource collection requests |
44 | 9.2.3 Service root request 9.2.4 OData service and metadata document requests |
45 | 9.3 Query parameters 9.3.1 Query parameter overview |
47 | 9.3.2 The $expand query parameter |
49 | 9.3.3 The $select query parameter |
50 | 9.3.4 The $filter query parameter |
51 | 9.4 HEAD |
52 | 9.5 Data modification requests 9.5.1 Data modification requests overview 9.5.2 Modification success responses |
53 | 9.5.3 Modification error responses 9.6 PATCH (update) |
54 | 9.7 PATCH on array properties |
55 | 9.8 PUT (replace) 9.9 POST (create) |
56 | 9.10 DELETE (delete) 9.11 POST (action) |
58 | 9.12 Operation apply time |
61 | 9.13 Deep operations |
65 | 10 Service responses 10.1 Response headers |
67 | 10.2 Link header 10.3 Status codes |
70 | 10.4 OData metadata responses 10.4.1 OData metadata responses overview 10.4.2 OData $metadata |
71 | 10.4.2.1 Referencing other schemas 10.4.2.2 Referencing OEM extensions |
72 | 10.4.3 OData service document 10.5 Resource responses |
73 | 10.6 Error responses |
75 | 11 Data model 11.1 Resources 11.2 Resource types |
76 | 11.3 Resource collections 11.4 OEM resources |
77 | 11.5 Common data types 11.5.1 Primitive types 11.5.2 Empty string values |
78 | 11.5.3 GUID and UUID values 11.5.4 Date-Time values 11.5.5 Duration values |
79 | 11.5.6 Reference properties 11.5.7 Non-resource reference properties |
80 | 11.5.8 Array properties 11.5.9 Structured properties |
81 | 11.5.10 Message object 11.5.10.1 Overview |
82 | 11.5.10.2 MessageId format |
83 | 11.6 Properties 11.6.1 Properties overview 11.6.2 Resource identifier (@odata.id) property 11.6.3 Resource type (@odata.type) property |
84 | 11.6.4 Resource ETag (@odata.etag) property 11.6.5 Resource context (@odata.context) property |
85 | 11.6.6 Id 11.6.7 Name 11.6.8 Description 11.6.9 MemberId 11.6.10 Count ([email protected]) property |
86 | 11.6.11 Members 11.6.12 Next link ([email protected]) property 11.6.13 Links 11.6.13.1 Reference to a related resource |
87 | 11.6.13.2 References to multiple related resources 11.6.14 Actions property 11.6.14.1 Action representation |
88 | 11.6.14.2 Action responses 11.6.15 Oem |
89 | 11.6.16 Status 11.7 Naming conventions 11.7.1 Naming rules |
90 | 11.7.2 URI naming rules |
91 | 11.8 Extending standard resources 11.8.1 Extending standard resources overview 11.8.2 OEM property format and content 11.8.3 OEM-specified object naming |
92 | 11.8.4 OEM resource types 11.8.5 OEM registries |
93 | 11.8.6 OEM URIs 11.8.7 OEM property examples |
94 | 11.8.8 OEM actions |
95 | 11.9 Payload annotations 11.9.1 Payload annotations overview 11.9.2 Allowable values |
96 | 11.9.3 Extended information 11.9.3.1 Extended object information |
97 | 11.9.3.2 Extended property information 11.9.4 Action info annotation |
98 | 11.9.5 Settings and settings apply time annotations 11.9.6 Operation apply time and operation apply time support annotations 11.9.7 Maintenance window annotation |
99 | 11.9.8 Collection capabilities annotation |
101 | 11.9.9 Requested count and allow over-provisioning annotations 11.9.10 Zone affinity annotation |
102 | 11.9.11 Supported certificates annotation 11.9.12 Deprecated annotation 11.10 Settings resource |
105 | 11.11 Special resource situations 11.11.1 Overview 11.11.2 Absent resources 11.12 Registries |
106 | 11.13 Schema annotations 11.13.1 Schema annotations overview 11.13.2 Description annotation |
107 | 11.13.3 Long description annotation 11.13.4 Resource capabilities annotation 11.13.5 Resource URI patterns annotation |
108 | 11.13.6 Additional properties annotation |
109 | 11.13.7 Permissions annotation 11.13.8 Required annotation 11.13.9 Required on create annotation 11.13.10 Units of measure annotation 11.13.11 Expanded resource annotation |
110 | 11.13.12 Owning entity annotation 11.13.13 Deprecated annotation 11.14 Versioning |
111 | 11.15 Localization |
112 | 12 File naming and publication 12.1 Registry file naming 12.2 Profile file naming 12.3 Dictionary file naming 12.4 Localized file naming |
113 | 12.5 DMTF Redfish file repository |
115 | 13 Schema definition languages 13.1 OData Common Schema Definition Language 13.1.1 OData Common Schema Definition Language overview 13.1.2 File naming conventions for CSDL 13.1.3 Core CSDL files |
116 | 13.1.4 CSDL format 13.1.4.1 Referencing other CSDL files |
117 | 13.1.4.2 CSDL data services 13.1.5 Elements of CSDL namespaces |
118 | 13.1.5.1 Qualified names 13.1.5.2 Entity type and complex type elements |
119 | 13.1.5.3 Action element |
120 | 13.1.5.4 Action element for OEM actions 13.1.5.5 Action with a response body |
121 | 13.1.5.6 Property element |
122 | 13.1.5.7 Navigation property element 13.1.5.8 Enum type element |
123 | 13.1.5.9 Annotation element |
126 | 13.2 JSON Schema 13.2.1 JSON Schema overview 13.2.2 File naming conventions for JSON Schema 13.2.3 Core JSON Schema files |
127 | 13.2.4 JSON Schema format 13.2.5 JSON Schema definitions body 13.2.5.1 Resource definitions in JSON Schema |
128 | 13.2.5.2 Enumerations in JSON Schema |
129 | 13.2.5.3 Actions in JSON Schema |
130 | 13.2.5.4 OEM actions in JSON Schema |
131 | 13.2.5.5 Action with a response body |
132 | 13.2.6 JSON Schema terms |
133 | 13.3 OpenAPI 13.3.1 OpenAPI overview 13.3.2 File naming conventions for OpenAPI schema 13.3.3 Core OpenAPI schema files |
134 | 13.3.4 openapi.yaml |
136 | 13.3.5 OpenAPI file format 13.3.6 OpenAPI components body 13.3.6.1 Resource definitions in OpenAPI |
137 | 13.3.6.2 Enumerations in OpenAPI 13.3.6.3 Actions in OpenAPI |
139 | 13.3.6.4 OEM actions in OpenAPI 13.3.7 OpenAPI terms used by Redfish |
140 | 13.4 Schema modification rules |
142 | 14 Service details 14.1 Eventing 14.1.1 Eventing overview 14.1.2 POST to subscription collection |
143 | 14.1.3 Open an SSE connection |
144 | 14.1.4 EventType-based eventing 14.1.5 Subscribing to events |
145 | 14.1.6 Event formats |
146 | 14.1.7 OEM extensions 14.2 Asynchronous operations |
148 | 14.3 Resource tree stability 14.4 Discovery 14.4.1 Discovery overview |
149 | 14.4.2 UPnP compatibility 14.4.3 USN format 14.4.4 M-SEARCH response |
150 | 14.4.5 Notify, alive, and shutdown messages 14.5 Server-sent events 14.5.1 General |
151 | 14.5.2 Event service |
153 | 14.5.2.1 Event message SSE stream |
154 | 14.5.2.2 Metric report SSE stream |
155 | 14.6 Update service 14.6.1 Overview 14.6.2 Software update types 14.6.2.1 Simple updates 14.6.2.2 Multipart HTTP push updates |
158 | 15 Security details 15.1 Transport Layer Security (TLS) protocol 15.1.1 Transport Layer Security (TLS) protocol overview 15.1.2 Cipher suites |
159 | 15.1.3 Certificates 15.2 Sensitive data 15.3 Authentication 15.3.1 Authentication overview |
160 | 15.3.2 Authentication requirements 15.3.2.1 Resource and operation authentication requirements 15.3.2.2 HTTP header authentication requirements 15.3.2.3 Authentication failure requirements |
161 | 15.3.3 HTTP Basic authentication 15.3.4 Redfish session login authentication 15.3.4.1 Redfish login sessions |
162 | 15.3.4.2 Session login |
163 | 15.3.4.3 Session lifetime 15.3.4.4 Session termination or logout 15.4 Authorization 15.4.1 Authorization overview |
164 | 15.4.2 Privilege model 15.4.2.1 Roles |
165 | 15.4.2.2 Restricted roles and restricted privileges |
166 | 15.4.2.3 OEM privileges 15.4.3 Redfish service operation-to-privilege mapping 15.4.3.1 Why specify operation-to-privilege mapping? 15.4.3.2 Representing operation-to-privilege mappings |
167 | 15.4.3.3 Operation map syntax |
168 | 15.4.3.4 Mapping overrides syntax 15.4.3.5 Property override example |
169 | 15.4.3.6 Subordinate override |
170 | 15.4.3.7 Resource URI override |
171 | 15.4.3.8 Privilege AND and OR syntax |
172 | 15.5 Account service 15.5.1 Account service overview 15.5.2 Password management |
173 | 15.5.3 Password change required handling 15.6 Asynchronous tasks 15.7 Event subscriptions |
174 | 16 Redfish Host Interface |
175 | 17 Redfish composability |
176 | 17.1 Composition requests 17.1.1 Composition requests overview 17.1.2 Specific composition |
177 | 17.1.3 Constrained composition |
178 | 17.1.4 Expandable resources 17.2 Updating a composed resource |
179 | 18 Aggregation 18.1 Classes of aggregators 18.1.1 Implicit and complex aggregators |
180 | 18.1.2 Use cases 18.2 Aggregation service 18.2.1 Aggregation service overview 18.2.2 Aggregator requirements |
181 | 18.2.3 Aggregates 18.2.4 Aggregation sources and connection methods |
183 | 19 ANNEX A (informative) Change log |
196 | 20 Bibliography |