| commit | 7273007d5bf677d9a17624d208095929082adc31 | [log] [tgz] |
|---|---|---|
| author | Matt Spinler <spinler@us.ibm.com> | Fri Feb 01 09:42:10 2019 -0600 |
| committer | Matt Spinler <spinler@us.ibm.com> | Fri Feb 01 15:17:09 2019 -0600 |
| tree | a5294d3e8a97338bf893e33c0f419cf6469d7913 | |
| parent | 3c864e924343a396dcad498b2b1dc96435674b07 [diff] |
Update rest-api.md for bmcweb Point at REST-cheatsheet.md for details on how to authenticate. Remove the now unecessary cjar and ContentType arguments. Change-Id: I0b6024e98719dd610e0d85d6d05067c0aa0c21ec Signed-off-by: Matt Spinler <spinler@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