Every operation¶
Generated from the committed OpenAPI document, bmcd 2.28.0. Do not edit this file: just refresh-api rewrites it.
One row per operation. The prose about what this API is — the two spellings, what the document describes, authentication — is on The API.
| operation | method | path | group |
|---|---|---|---|
| Firmware, daemon, kernel and board identity | GET |
/api/bmc/about |
The board |
| Everything configured on this board, as one document | GET |
/api/bmc/config |
The board |
| Apply an exported configuration; reports per field | POST |
/api/bmc/config |
The board |
| The board's own condition: uptime, load, memory, NAND, clock | GET |
/api/bmc/health |
The board |
| The board's name, live and after the next boot | GET |
/api/bmc/hostname |
The board |
| Rename the board; the metrics instance label changes with it | POST |
/api/bmc/hostname |
The board |
| Storage and interfaces, as the Overview page reads them | GET |
/api/bmc/info |
The board |
| Reboot the BMC; the compute modules keep running | POST |
/api/bmc/reboot |
The board |
| Restart the daemon | POST |
/api/bmc/reload |
The board |
| Expose a node's storage as a mass-storage device | POST |
/api/bmc/node-to-msd |
The nodes |
| Node names, module names and power-on times | GET |
/api/bmc/nodes |
The nodes |
| Which nodes are powered | GET |
/api/bmc/power |
The nodes |
| Power nodes on or off | POST |
/api/bmc/power |
The nodes |
| Restart one node | POST |
/api/bmc/reset |
The nodes |
| The USB bus: which node holds it, in which mode | GET |
/api/bmc/usb |
The nodes |
| Route the USB bus to a node, in a mode | POST |
/api/bmc/usb |
The nodes |
| Hold a node's usbboot pin for the next power-on | POST |
/api/bmc/usb-boot |
The nodes |
| Release the usbboot pin | POST |
/api/bmc/usb-boot/clear |
The nodes |
Every enabled source's candidates; refresh=1 re-polls behind the answer |
GET |
/api/bmc/firmware/available |
Firmware |
| Whether a newer release exists, per channel | GET |
/api/bmc/firmware/check |
Firmware |
| Stage a version from a source for the next boot | POST |
/api/bmc/firmware/install |
Firmware |
| The A/B slots: running, rollback, what is staged, the last promotion | GET |
/api/bmc/firmware/slots |
Firmware |
| Where the board looks for firmware | GET |
/api/bmc/firmware/sources |
Firmware |
| Replace the firmware sources | POST |
/api/bmc/firmware/sources |
Firmware |
| SD card capacity and use | GET |
/api/bmc/sdcard |
Storage |
| Format the SD card | POST |
/api/bmc/sdcard/format |
Storage |
| Interfaces and switch ports | GET |
/api/bmc/network |
Network and time |
| Reset the network configuration | POST |
/api/bmc/network/reset |
Network and time |
| Time sources and the clock's state | GET |
/api/bmc/ntp |
Network and time |
| Replace the time sources and reload chrony | POST |
/api/bmc/ntp |
Network and time |
| Cooling devices with their setpoints | GET |
/api/bmc/cooling |
Cooling and thermals |
| Set a cooling device's step | POST |
/api/bmc/cooling |
Cooling and thermals |
| Temperature sensors with their trip points, and the fan's step | GET |
/api/bmc/thermal |
Cooling and thermals |