| commit | 9e99e773efb22e946edd5c7127735ce11e3e4ce8 | [log] [tgz] |
|---|---|---|
| author | Adriana Kobylak <anoo@us.ibm.com> | Fri Mar 16 14:03:57 2018 -0500 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Wed Apr 11 13:37:12 2018 +0000 |
| tree | 74f8dc82ff82ef5ce67591426678a93429bdd5c9 | |
| parent | f62262b3fc6ff552b649a7fcf3825d4830ecbedb [diff] |
rest-api.md: Add upload return codes With change https://gerrit.openbmc-project.xyz/#/c/9594/ the upload method now returns the version id of the uploaded file or error. Update the documentation with the possible return information. Change-Id: I76429bac378b58fd08e4fe5030b89e57f743fb1a Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.
rest-api.md: Introduction to using the OpenBMC REST API
console.md: Using the host console
host-management.md: Performing host management tasks with OpenBMC
code-update: Updating OpenBMC and host platform firmware
These documents contain details on developing OpenBMC code itself
cheatsheet.md: Quick reference for some common development tasks
contributing.md: Guidelines for contributing to OpenBMC
kernel-development.md: Reference for common kernel development tasks
REST-cheatsheet.md: Quick reference for some common curl commands usage.
The OpenBMC project's aim is to create a highly extensible framework for BMC software and implement for data-center computer systems.
We have a few high-level objectives:
The OpenBMC framework must be extensible, easy to learn, and usable in a variety of programming languages.
Provide a REST API for external management, and allow for "pluggable" interfaces for other types of management interactions.
Provide a remote host console, accessible over the network
Persist network configuration settable from REST interface and host
Provide a robust solution for RTC management, exposed to the host.
Compatible with host firmware implementations for basic IPMI communication between host and BMC
Provide a flexible and hierarchical inventory tracking component
Maintain a sensor database and track thresholds