ISO/IEC 30115:2018
Information technology - Redfish scalable platforms management API specification
ISO/IEC 30115:2018:
The Redfish Scalable Platforms Management API ("Redfish") is a new specification that uses RESTful interface semantics to access data defined in model format to perform out-of-band systems management. It is suitable for a wide range of servers, from stand-alone servers to rack mount and bladed environments but scales equally well for large scale cloud environments.
There are several out-of-band systems management standards (defacto and de jour) available in the industry. They all either vary widely in implementation, were developed for single server embedded environments or have their roots in antiquated software modeling constructs. There is no single industry standard that is simple to use, based on emerging programming standards, embedded friendly and capable of meeting large scale data center & cloud needs.
The electronic version of this International Standard can be downloaded from the ISO/IEC Information Technology Task Force (ITTF) website.
| Get this standard | Prices exclude GST | |
|---|---|---|
| PDF ( Single user document) |
$118.26 NZD
|
|
| HardCopy |
$152.17 NZD
|
|
| Networkable PDF |
Price varies
|
1. Abstract
2. Normative references
3. Terms and definitions
4. Symbols and abbreviated terms
5. Overview
5.1. Scope
5.2. Goals
5.3. Design tenets
5.4. Limitations
5.5. Additional design background and rationale
5.5.1. REST-based
5.5.2. Follow OData conventions
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
5.6.2. Eventing mechanism
5.6.3. Actions
5.6.4. Service entry point discovery
5.6.5. Remote access support
5.7. 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. Redfish-defined URIs and relative URI rules
6.4. Requests
6.4.1. Request headers
6.4.2. Read requests (GET)
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
6.4.2.4.2. Retrieving Resource Collections
6.4.3. HEAD
6.4.4. Data modification requests
6.4.4.1. Update (PATCH)
6.4.4.2. Replace (PUT)
6.4.4.3. Create (POST)
6.4.4.4. Delete (DELETE)
6.4.4.5. Actions (POST)
6.5. Responses
6.5.1. Response headers
6.5.1.1. Link header
6.5.2. Status codes
6.5.3. Metadata responses
6.5.3.1. Service metadata
6.5.3.1.1. Referencing other schemas
6.5.3.1.2. Referencing OEM extensions
6.5.3.1.3. Annotations
6.5.3.2. OData Service Document
6.5.4. Resource responses
6.5.4.1. Context property
6.5.4.1.1. Select list
6.5.4.2. Resource identifier property
6.5.4.3. Type property
6.5.4.4. ETag property
6.5.4.5. Primitive properties
6.5.4.5.1. DateTime values
6.5.4.6. Structured properties
6.5.4.7. Actions property
6.5.4.7.1. Action representation
6.5.4.7.2. Allowable values
6.5.4.8. Links property
6.5.4.8.1. Reference to a single related resource
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
6.5.4.11.1. Extended object information
6.5.4.11.2. Extended property information
6.5.4.12. Additional annotations
6.5.5. Resource Collection responses
6.5.5.1. Context property
6.5.5.2. Count property
6.5.5.3. Members property
6.5.5.4. NextLink property and partial results
6.5.5.5. Additional annotations
6.5.6. Error responses
6.5.6.1. Message object
7. Data model and Schema
7.1. Schema repository
7.1.1. Programmatic access to schema files
7.2. Type identifiers
7.2.1. Type identifiers in JSON
7.3. Common naming conventions
7.4. Localization considerations
7.5. Schema definition
7.5.1. Common annotations
7.5.1.1. Description
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
7.5.2.4. Namespace definitions
7.5.3. Resource type definitions
7.5.4. Resource properties
7.5.4.1. Property types
7.5.4.1.1. Primitive types
7.5.4.1.2. Structured types
7.5.4.1.3. Enums
7.5.4.1.4. Collections
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
7.5.4.6. Required properties on create
7.5.4.7. Units of measure
7.5.5. Reference properties
7.5.5.1. Contained resources
7.5.5.2. Expanded references
7.5.5.3. Expanded resources
7.5.6. Resource actions
7.5.7. Resource extensibility
7.5.7.1. Oem property
7.5.7.2. Oem property format and content
7.5.7.3. Oem property naming
7.5.8. Oem property examples
7.5.8.1. Custom actions
7.5.8.2. Custom annotations
7.6. Common Redfish resource properties
7.6.1. Id
7.6.2. Name
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
7.7. Redfish resources
7.7.1. Current configuration
7.7.2. Settings
7.7.3. Services
7.7.4. Registry
7.8. Special resource situations
7.8.1. Absent resources
7.8.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. Protocols
9.1.1. TLS
9.1.2. Cipher suites
9.1.3. Certificates
9.2. Authentication
9.2.1. HTTP header security
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.
9.2.4.3. Session login
9.2.4.4. X-Auth-Token HTTP header
9.2.4.5. Session lifetime
9.2.4.6. Session termination or logout
9.2.5. AccountService
9.2.6. Async tasks
9.2.7. Event subscriptions
9.2.8. Privilege model/Authorization
9.2.9. Redfish Service Operation to Privilege Mapping
9.2.9.1. Why specify Operation to Privilege Mapping
9.2.9.2. Representing Operation to Privilege Mappings
9.2.9.3. OperationMap Syntax
9.2.9.4. Mapping Overrides Syntax
9.2.9.5. Property Override Example
9.2.9.6. Subordinate Override
9.2.9.7. ResourceURI Override
9.2.9.8. Privilege AND and OR Syntax
10. Redfish Host Interface
11. Redfish Composability
11.1. Composition Requests
11.1.1. Specific Composition
12. ANNEX A (informative)
12.1. Change log
Blank Page
Blank Page
Keep me up-to-date
Register to receive notifications when updates are made to this standard.
Related Information
Similar Standards
-
AS/NZS 3802:1997
Data elements and interchange formats - Information interchange - Representation of dates and times
-
AS/NZS 5121:2015
Information technology - Vocabulary - Learning, education and training -
AS/NZS 5813.1:2012
Information technology equipment - Energy performance of computers - Part 1: Methods of measurement of energy performance -
AS/NZS 5813.2:2012
Information technology equipment - Energy performance of computers - Part 2: Minimum energy performance standards (MEPS) for computers
1. Abstract
2. Normative references
3. Terms and definitions
4. Symbols and abbreviated terms
5. Overview
5.1. Scope
5.2. Goals
5.3. Design tenets
5.4. Limitations
5.5. Additional design background and rationale
5.5.1. REST-based
5.5.2. Follow OData conventions
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
5.6.2. Eventing mechanism
5.6.3. Actions
5.6.4. Service entry point discovery
5.6.5. Remote access support
5.7. 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. Redfish-defined URIs and relative URI rules
6.4. Requests
6.4.1. Request headers
6.4.2. Read requests (GET)
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
6.4.2.4.2. Retrieving Resource Collections
6.4.3. HEAD
6.4.4. Data modification requests
6.4.4.1. Update (PATCH)
6.4.4.2. Replace (PUT)
6.4.4.3. Create (POST)
6.4.4.4. Delete (DELETE)
6.4.4.5. Actions (POST)
6.5. Responses
6.5.1. Response headers
6.5.1.1. Link header
6.5.2. Status codes
6.5.3. Metadata responses
6.5.3.1. Service metadata
6.5.3.1.1. Referencing other schemas
6.5.3.1.2. Referencing OEM extensions
6.5.3.1.3. Annotations
6.5.3.2. OData Service Document
6.5.4. Resource responses
6.5.4.1. Context property
6.5.4.1.1. Select list
6.5.4.2. Resource identifier property
6.5.4.3. Type property
6.5.4.4. ETag property
6.5.4.5. Primitive properties
6.5.4.5.1. DateTime values
6.5.4.6. Structured properties
6.5.4.7. Actions property
6.5.4.7.1. Action representation
6.5.4.7.2. Allowable values
6.5.4.8. Links property
6.5.4.8.1. Reference to a single related resource
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
6.5.4.11.1. Extended object information
6.5.4.11.2. Extended property information
6.5.4.12. Additional annotations
6.5.5. Resource Collection responses
6.5.5.1. Context property
6.5.5.2. Count property
6.5.5.3. Members property
6.5.5.4. NextLink property and partial results
6.5.5.5. Additional annotations
6.5.6. Error responses
6.5.6.1. Message object
7. Data model and Schema
7.1. Schema repository
7.1.1. Programmatic access to schema files
7.2. Type identifiers
7.2.1. Type identifiers in JSON
7.3. Common naming conventions
7.4. Localization considerations
7.5. Schema definition
7.5.1. Common annotations
7.5.1.1. Description
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
7.5.2.4. Namespace definitions
7.5.3. Resource type definitions
7.5.4. Resource properties
7.5.4.1. Property types
7.5.4.1.1. Primitive types
7.5.4.1.2. Structured types
7.5.4.1.3. Enums
7.5.4.1.4. Collections
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
7.5.4.6. Required properties on create
7.5.4.7. Units of measure
7.5.5. Reference properties
7.5.5.1. Contained resources
7.5.5.2. Expanded references
7.5.5.3. Expanded resources
7.5.6. Resource actions
7.5.7. Resource extensibility
7.5.7.1. Oem property
7.5.7.2. Oem property format and content
7.5.7.3. Oem property naming
7.5.8. Oem property examples
7.5.8.1. Custom actions
7.5.8.2. Custom annotations
7.6. Common Redfish resource properties
7.6.1. Id
7.6.2. Name
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
7.7. Redfish resources
7.7.1. Current configuration
7.7.2. Settings
7.7.3. Services
7.7.4. Registry
7.8. Special resource situations
7.8.1. Absent resources
7.8.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. Protocols
9.1.1. TLS
9.1.2. Cipher suites
9.1.3. Certificates
9.2. Authentication
9.2.1. HTTP header security
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.
9.2.4.3. Session login
9.2.4.4. X-Auth-Token HTTP header
9.2.4.5. Session lifetime
9.2.4.6. Session termination or logout
9.2.5. AccountService
9.2.6. Async tasks
9.2.7. Event subscriptions
9.2.8. Privilege model/Authorization
9.2.9. Redfish Service Operation to Privilege Mapping
9.2.9.1. Why specify Operation to Privilege Mapping
9.2.9.2. Representing Operation to Privilege Mappings
9.2.9.3. OperationMap Syntax
9.2.9.4. Mapping Overrides Syntax
9.2.9.5. Property Override Example
9.2.9.6. Subordinate Override
9.2.9.7. ResourceURI Override
9.2.9.8. Privilege AND and OR Syntax
10. Redfish Host Interface
11. Redfish Composability
11.1. Composition Requests
11.1.1. Specific Composition
12. ANNEX A (informative)
12.1. Change log
Blank Page
Blank Page