| commit | 8108a39c112a27e79df6ffdc69ca9836930f17c3 | [log] [tgz] |
|---|---|---|
| author | Gunnar Mills <gmills@us.ibm.com> | Mon Nov 20 15:38:37 2017 -0600 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Mon Nov 20 20:50:57 2017 -0600 |
| tree | 3b658b882297205948d5ef5143d363e9d2bc9364 | |
| parent | f25a52cec15a817f9bf9952e359554d4f3b3fe5e [diff] |
Fix POST curl examples in rest-api.md The POST curl example calls in rest-api.md used the old /org/openbmc, update to /xyz/openbmc_project/. Change-Id: Ib67827e94b1b47a5ab6bd0ed4107e78e73f88b48 Signed-off-by: Gunnar Mills <gmills@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.md: 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
dbus-interfaces.md: Reference for APIs exposed to D-Bus
kernel-development.md: Reference for common kernel development tasks
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