OpenBMC 使用指南

简介：
《OpenBMC使用指南》旨在为初学者及开发者提供关于OpenBMC项目的入门指导与操作手册，涵盖安装、配置和维护等方面的知识。 ### OpenBMC 使用说明 #### 一、OpenBMC REST API 概览 OpenBMC 是一个开源项目，旨在为现代服务器提供完整的可扩展固件解决方案。其主要管理接口是REST API，允许远程管理和监控服务器硬件。 ##### 1.1 认证 使用 REST 接口前需进行认证。OpenBMC 支持基于令牌的认证方式： 1. **获取令牌**：通过 `POST` 请求向 `login` 端点发送用户名和密码以获得身份验证令牌。 ```bash $ export bmc=xx.xx.xx.xx $ export token=`curl -k -H Content-Type: application/json -X POST https://${bmc}/login -d {username:root, password:0penBmc} | grep token | awk {print $2} | tr -d \n ``` 2. **设置认证头**：在获取令牌后，需将令牌添加到后续所有 REST 请求的头部。 ```bash $ curl -k -H X-Auth-Token: ${token} https://${bmc}/xyz/openbmc_project... ``` ##### 1.2 HTTP GET 操作及 URL 结构 OpenBMC REST API 的 URL 结构遵循一定约定，便于查询和操作资源。 1. **查询对象属性**：对指定对象发起 `GET` 请求以获取其所有属性。 ```bash $ curl -k -H X-Auth-Token: ${token} https://${bmc}/xyz/openbmc_project/inventory/system ``` 2. **查询单一属性**：使用路径结构 `attr` 获取特定属性的值。 ```bash $ curl -k -H X-Auth-Token: ${token} https://${bmc}/xyz/openbmc_project/inventory/system/attr/Cached ``` 3. **列出子对象**：URL 路径末尾带有斜杠时，响应将返回该 URL 下的所有子对象列表。 ```bash $ curl -k -H X-Auth-Token: ${token} https://${bmc}/xyz/openbmc_project/ ``` #### 二、OpenBMC 主机管理接口 通过 REST 接口，管理员可以监控和控制服务器的关键组件如 CPU、内存及存储设备等。这些功能包括远程重启、关机以及电源状态查询。 #### 三、连接主机 UART 控制台 OpenBMC 支持通过 UART 连接到主机的控制台。该基础设施允许多个客户端同时访问同一主机的 UART 端口，有助于维护和调试工作。从主机发送的数据会广播给所有已连接的客户端；而任何客户端输入数据会被转发至主机。 ##### 连接步骤 1. **建立连接**：使用支持工具（如终端仿真器）与 OpenBMC 的 UART 服务建立连接。 2. **数据交互**：成功建立连接后，可以进行双向通信。 #### 四、OpenBMC 更新机制 更新系统固件和软件包时，管理员可通过 REST API 或其他管理工具下载并应用新的版本。在执行此操作前，请确保新版本的兼容性和稳定性，并遵循官方文档指示。 总结而言，通过REST API 可以获取系统状态及执行高级操作如重启、关机等。此外，UART 控制台连接功能使得远程调试和故障排除更加方便快捷；更新机制则保证系统的长期稳定性和安全性。