BS ISO/IEC 30115:2018
$215.11
Information technology. Redfish scalable platforms management API specification
Published By | Publication Date | Number of Pages |
BSI | 2018 | 102 |
The scope of this specification is to define the protocols, data model, and behaviors, as well as other architectural components needed for an inter-operable, cross-vendor, remote and out-of-band capable interface that meets the expectations of Cloud and Web-based IT professionals for scalable platform management. While large scale systems are the primary focus, the specifications are also capable of being used for more traditional system platform management implementations.
The specifications define elements that are mandatory for all Redfish implementations as well as optional elements that can be chosen by system vendor or manufacturer. The specifications also define points at which OEM (system vendor) -specific extensions can be provided by a given implementation.
The specifications set normative requirements for Redfish Services and associated materials, such as Redfish Schema files. In general, the specifications do not set requirements for Redfish clients, but will indicate what a Redfish client should do in order to access and utilize a Redfish Service successfully and effectively.
The specifications do not set requirements that particular hardware or firmware must be used to implement the Redfish interfaces and functions.
PDF Catalog
PDF Pages | PDF Title |
---|---|
2 | undefined |
6 | Blank Page |
11 | 1. Abstract 2. Normative references |
12 | 3. Terms and definitions |
15 | 4. Symbols and abbreviated terms 5. Overview |
16 | 5.1. Scope 5.2. Goals |
17 | 5.3. Design tenets 5.4. Limitations |
18 | 5.5. Additional design background and rationale 5.5.1. REST-based 5.5.2. Follow OData conventions |
19 | 5.5.3. Model-oriented 5.5.4. Separation of protocol from data model 5.5.5. Hypermedia API service endpoint 5.6. Service elements 5.6.1. Synchronous and asynchronous operation support |
20 | 5.6.2. Eventing mechanism 5.6.3. Actions 5.6.4. Service entry point discovery |
21 | 5.6.5. Remote access support 5.7. Security 6. Protocol details |
22 | 6.1. Use of HTTP 6.1.1. URIs |
23 | 6.1.2. HTTP methods |
24 | 6.1.3. HTTP redirect 6.1.4. Media types 6.1.5. ETags |
25 | 6.2. Protocol version |
26 | 6.3. Redfish-defined URIs and relative URI rules |
27 | 6.4. Requests 6.4.1. Request headers |
29 | 6.4.2. Read requests (GET) |
30 | 6.4.2.1. Service root request 6.4.2.2. Metadata document request 6.4.2.3. OData service document request 6.4.2.4. Resource retrieval requests 6.4.2.4.1. Query parameters |
31 | 6.4.2.4.2. Retrieving Resource Collections 6.4.3. HEAD |
32 | 6.4.4. Data modification requests 6.4.4.1. Update (PATCH) 6.4.4.2. Replace (PUT) |
33 | 6.4.4.3. Create (POST) 6.4.4.4. Delete (DELETE) |
34 | 6.4.4.5. Actions (POST) |
35 | 6.5. Responses |
36 | 6.5.1. Response headers |
38 | 6.5.1.1. Link header 6.5.2. Status codes |
41 | 6.5.3. Metadata responses 6.5.3.1. Service metadata 6.5.3.1.1. Referencing other schemas |
42 | 6.5.3.1.2. Referencing OEM extensions 6.5.3.1.3. Annotations |
43 | 6.5.3.2. OData Service Document |
44 | 6.5.4. Resource responses 6.5.4.1. Context property |
45 | 6.5.4.1.1. Select list 6.5.4.2. Resource identifier property 6.5.4.3. Type property |
46 | 6.5.4.4. ETag property 6.5.4.5. Primitive properties 6.5.4.5.1. DateTime values |
47 | 6.5.4.6. Structured properties 6.5.4.7. Actions property 6.5.4.7.1. Action representation |
48 | 6.5.4.7.2. Allowable values 6.5.4.8. Links property 6.5.4.8.1. Reference to a single related resource |
49 | 6.5.4.8.2. Array of references to related resources 6.5.4.9. OEM property 6.5.4.10. Partial resource results 6.5.4.11. Extended information |
50 | 6.5.4.11.1. Extended object information 6.5.4.11.2. Extended property information |
51 | 6.5.4.12. Additional annotations |
52 | 6.5.5. Resource Collection responses 6.5.5.1. Context property 6.5.5.2. Count property 6.5.5.3. Members property |
53 | 6.5.5.4. NextLink property and partial results 6.5.5.5. Additional annotations 6.5.6. Error responses |
55 | 6.5.6.1. Message object |
56 | 7. Data model and Schema 7.1. Schema repository 7.1.1. Programmatic access to schema files |
57 | 7.2. Type identifiers 7.2.1. Type identifiers in JSON 7.3. Common naming conventions |
58 | 7.4. Localization considerations 7.5. Schema definition 7.5.1. Common annotations 7.5.1.1. Description |
59 | 7.5.1.2. Long description 7.5.2. Schema documents 7.5.2.1. Schema Modification Rules 7.5.2.2. Schema Version Requirements 7.5.2.3. Referencing other schemas |
60 | 7.5.2.4. Namespace definitions |
61 | 7.5.3. Resource type definitions 7.5.4. Resource properties |
62 | 7.5.4.1. Property types 7.5.4.1.1. Primitive types 7.5.4.1.2. Structured types |
63 | 7.5.4.1.3. Enums 7.5.4.1.4. Collections |
64 | 7.5.4.2. Additional properties 7.5.4.3. Non-nullable properties 7.5.4.4. Read-only properties 7.5.4.5. Required properties |
65 | 7.5.4.6. Required properties on create 7.5.4.7. Units of measure 7.5.5. Reference properties |
66 | 7.5.5.1. Contained resources |
67 | 7.5.5.2. Expanded references 7.5.5.3. Expanded resources 7.5.6. Resource actions |
68 | 7.5.7. Resource extensibility 7.5.7.1. Oem property |
69 | 7.5.7.2. Oem property format and content |
70 | 7.5.7.3. Oem property naming 7.5.8. Oem property examples |
71 | 7.5.8.1. Custom actions |
72 | 7.5.8.2. Custom annotations 7.6. Common Redfish resource properties 7.6.1. Id 7.6.2. Name |
73 | 7.6.3. Description 7.6.4. Status 7.6.5. Links 7.6.6. Members 7.6.7. RelatedItem 7.6.8. Actions 7.6.9. OEM |
74 | 7.7. Redfish resources 7.7.1. Current configuration 7.7.2. Settings 7.7.3. Services |
75 | 7.7.4. Registry 7.8. Special resource situations 7.8.1. Absent resources 7.8.2. Schema variations |
76 | 8. Service details 8.1. Eventing |
77 | 8.1.1. Event message subscription 8.1.2. Event message objects |
78 | 8.1.3. Subscription cleanup 8.2. Asynchronous operations |
79 | 8.3. Resource tree stability |
80 | 8.4. Discovery 8.4.1. UPnP compatibility 8.4.2. USN format 8.4.3. M-SEARCH response |
81 | 8.4.4. Notify, alive, and shutdown messages 9. Security 9.1. Protocols 9.1.1. TLS 9.1.2. Cipher suites |
82 | 9.1.3. Certificates 9.2. Authentication 9.2.1. HTTP header security |
83 | 9.2.1.1. HTTP redirect 9.2.2. Extended error handling 9.2.3. HTTP header authentication 9.2.3.1. BASIC authentication 9.2.3.2. Request/Message level authentication 9.2.4. Session Management 9.2.4.1. Session lifecycle management • A Redfish Service shall provide login sessions compliant with this specification. |
84 | 9.2.4.3. Session login |
85 | 9.2.4.4. X-Auth-Token HTTP header 9.2.4.5. Session lifetime 9.2.4.6. Session termination or logout |
86 | 9.2.5. AccountService 9.2.6. Async tasks 9.2.7. Event subscriptions 9.2.8. Privilege model/Authorization |
87 | 9.2.9. Redfish Service Operation to Privilege Mapping 9.2.9.1. Why specify Operation to Privilege Mapping |
88 | 9.2.9.2. Representing Operation to Privilege Mappings 9.2.9.3. OperationMap Syntax |
89 | 9.2.9.4. Mapping Overrides Syntax |
90 | 9.2.9.5. Property Override Example |
91 | 9.2.9.6. Subordinate Override |
92 | 9.2.9.7. ResourceURI Override |
94 | 9.2.9.8. Privilege AND and OR Syntax |
95 | 10. Redfish Host Interface 11. Redfish Composability 11.1. Composition Requests 11.1.1. Specific Composition |
96 | 12. ANNEX A (informative) 12.1. Change log |