Introduction

The Redfish Scalable Platforms Management API ("Redfish") uses RESTful interface semantics to access data defined in a model format to perform systems management. It is suitable for a wide range of servers, from stand-alone to rack mount, blade, and even cloud environments.

As a management standard, Redfish uses data model representation inside of a hypermedia RESTful interface. Being based on REST makes it easier to use and implement than many other solutions. Since it is model-oriented, it is capable of expressing the relationships between components in modern systems as well as the semantics of the services and components within them. It is also easily extensible. By using a hypermedia approach to REST, Redfish can express a large variety of systems from multiple vendors. Utilizing JSON (JavaScript Object Notation) data format, which is in plain text, allows many types of parameters to be available such that it enables scalability, human readability, and flexibility for most programming environments by easily interpreting payload.

The model is displayed in terms of an interoperable OData Schema with the payload of the messages being expressed in JSON following OData JSON conventions. The schema (available in both XML and JSON formats) includes annotations to facilitate the automatic translation of the schema to JSON Schema. The ability to externally host the schema definition of the resources in a machine-readable format allows the metadata to be associated with the data without encumbering Redfish services with the metadata, thus enabling more advanced client scenarios as found in many data centers and cloud environments.

Supermicro enables Redfish feature sets on Intel-based X10 and AMD-based H11 and later-generation platforms. These features are covered under SFT-OOB-LIC and SFT-DCMS-SINGLE licenses.

This document provides you with an overview of Restful API services and describes how to receive Redfish API responses directly from a Supermicro BMC (Baseboard Management Controller).