| commit | d2431e9337eeec6870a46ad4cc6c81a219a53981 | [log] [tgz] |
|---|---|---|
| author | George Keishing <gkeishin@in.ibm.com> | Wed Jan 17 09:28:20 2018 -0600 |
| committer | George Keishing <gkeishin@in.ibm.com> | Mon Jan 22 22:54:21 2018 -0600 |
| tree | 9b066f821fe87ea22cb9fa7cf26c594428761e8d | |
| parent | 7b31010eb7e92b24dfca79f53944a99a5a3f4d97 [diff] |
Update REST-cheatsheet.md documentation
Added:
- New line to be uniform.
- Reboot host command.
- Clear gard records.
Change-Id: I736daf8552f532b35d4d60d190dd9a7eb5632133
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