| commit | 3c864e924343a396dcad498b2b1dc96435674b07 | [log] [tgz] |
|---|---|---|
| author | Matt Spinler <spinler@us.ibm.com> | Fri Jan 25 16:18:49 2019 -0600 |
| committer | Matt Spinler <spinler@us.ibm.com> | Mon Jan 28 13:39:32 2019 -0600 |
| tree | 9131dda49b74186628850aaed25498fe177a7b4b | |
| parent | a493305a34257aadd30a261d42996563ba9669aa [diff] |
Update REST doc for bmcweb authentication The bmcweb REST server requires passing in either the user name and password or the authentication token on the REST operations that can do modifications. Change-Id: Ibac6f6b4f4f7c504dda4f8a364b071e4b1970458 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