External Interfaces
Learn how to interact with OpenBMC through its management interfaces.
What You’ll Learn
- IPMI protocol and OEM command implementation
- Redfish REST API, OEM extensions, and multi-BMC aggregation
- WebUI customization and branding
- Remote access via KVM, virtual media, and console
- SSH access and security hardening
Interface Overview
┌─────────────────────────────────────┐
│ Management Client │
└─────────────────────────────────────┘
│
┌────────────────────────────┼────────────────────────────┐
│ │ │
▼ ▼ ▼
┌───────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ IPMI │ │ Redfish │ │ WebUI │
│ (ipmitool) │ │ (REST API) │ │ (Browser) │
└───────────────┘ └─────────────────┘ └─────────────────┘
│ │ │
▼ ▼ ▼
┌────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ ipmid/netipmid│ │ bmcweb │ │ webui-vue │
└────────────────┘ └─────────────────┘ └─────────────────┘
│ │ │
└────────────────────────────┼────────────────────────────┘
│
▼
┌─────────────────────────────────────┐
│ D-Bus Services │
└─────────────────────────────────────┘
Guides in This Section
Management Protocols
| Guide |
Description |
Use Case |
| IPMI |
IPMI protocol, OEM commands |
Legacy management, scripting |
| Redfish |
REST API, modern management |
Cloud integration, automation |
| WebUI |
Browser-based management |
Human operators |
| Redfish Events & Telemetry |
SSE subscriptions, metric reports |
Monitoring, alerting |
| Redfish OEM Extensions |
Custom OEM resources and actions |
Vendor-specific features |
Remote Access
| Guide |
Description |
Use Case |
| KVM |
Remote keyboard/video/mouse |
OS installation, troubleshooting |
| Virtual Media |
Remote ISO/image mounting |
OS installation |
| Console |
Serial over LAN |
Boot monitoring, recovery |
Security
| Guide |
Description |
| SSH |
SSH access and hardening |
Which Interface to Use?
| Scenario |
Recommended Interface |
| Scripting / Automation |
Redfish (REST) |
| Legacy tools / ipmitool |
IPMI |
| Human operators |
WebUI |
| Cloud management platforms |
Redfish |
| Bulk operations |
Redfish with scripting |
Prerequisites
- Complete Core Services basics
- Understand D-Bus object model
- Working QEMU environment with network access
Table of contents