| commit | 2f2b14a3a7a9addd39378519202ab31408e173be | [log] [tgz] |
|---|---|---|
| author | George Keishing <gkeishin@in.ibm.com> | Mon Jan 29 02:28:15 2018 -0600 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Tue Feb 06 17:19:08 2018 +0000 |
| tree | 32d15a7d46ebba2791096f0735214ae7ef87f635 | |
| parent | cb44907730c61a280ff7d61d1bd42d0772bef6e1 [diff] |
Update REST-cheatsheet.md documentation Added: - Power supply redundancy setting read/write commands - Optimize GET commands. Change-Id: Iae73f5d5d75c45889d101f161253eab07a987ad2 Signed-off-by: George Keishing <gkeishin@in.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