The nodes
Generated from the committed OpenAPI document, bmcd 2.28.0. Do not edit this file: just refresh-api rewrites it.
POST /api/bmc/node-to-msd
Expose a node's storage as a mass-storage device
Legacy form: GET /api/bmc?opt=set&type=node_to_msd with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
Request body (application/json)
| field |
type |
required |
description |
node |
string |
no |
1-4 |
Request body (application/x-www-form-urlencoded)
| field |
type |
required |
description |
node |
string |
no |
1-4 |
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
GET /api/bmc/nodes
Node names, module names and power-on times
Legacy form: GET /api/bmc?opt=get&type=node_info with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — array of NodeInfo |
The result. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
200 body (application/json) (each element): NodeInfo
| field |
type |
required |
description |
module_name |
string or null |
no |
|
name |
string or null |
no |
|
power_on_time |
integer or null |
no |
|
uart_baud |
integer or null |
no |
|
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
GET /api/bmc/power
Which nodes are powered
Legacy form: GET /api/bmc?opt=get&type=power with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — array of NodePower |
The result. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
200 body (application/json) (each element): NodePower
| field |
type |
required |
description |
node1 |
string |
yes |
|
node2 |
string |
yes |
|
node3 |
string |
yes |
|
node4 |
string |
yes |
|
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
POST /api/bmc/power
Power nodes on or off
Legacy form: GET /api/bmc?opt=set&type=power with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
Request body (application/json)
| field |
type |
required |
description |
node1 |
string |
no |
0 or 1 |
node2 |
string |
no |
0 or 1 |
node3 |
string |
no |
0 or 1 |
node4 |
string |
no |
0 or 1 |
Request body (application/x-www-form-urlencoded)
| field |
type |
required |
description |
node1 |
string |
no |
0 or 1 |
node2 |
string |
no |
0 or 1 |
node3 |
string |
no |
0 or 1 |
node4 |
string |
no |
0 or 1 |
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
POST /api/bmc/reset
Restart one node
Legacy form: GET /api/bmc?opt=set&type=reset with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
Request body (application/json)
| field |
type |
required |
description |
node |
string |
no |
1-4 |
Request body (application/x-www-form-urlencoded)
| field |
type |
required |
description |
node |
string |
no |
1-4 |
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
GET /api/bmc/usb
The USB bus: which node holds it, in which mode
Legacy form: GET /api/bmc?opt=get&type=usb with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — array of UsbState |
The result. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
200 body (application/json) (each element): UsbState
| field |
type |
required |
description |
bus_type |
string |
yes |
What the hardware is: which of the board's USB controllers is in play. |
mode |
UsbMode |
yes |
Host, Device or Flash. |
node |
string |
yes |
The node, as a display string such as Node 1. |
route |
UsbRoute |
yes |
Where the bus is routed: the alternative port, the BMC, or a node. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
POST /api/bmc/usb
Route the USB bus to a node, in a mode
Legacy form: GET /api/bmc?opt=set&type=usb with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
Request body (application/json)
| field |
type |
required |
description |
mode |
string |
no |
0 host, 1 device, 2 flash |
node |
string |
no |
1-4: which node the bus is routed to |
Request body (application/x-www-form-urlencoded)
| field |
type |
required |
description |
mode |
string |
no |
0 host, 1 device, 2 flash |
node |
string |
no |
1-4: which node the bus is routed to |
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
POST /api/bmc/usb-boot
Hold a node's usbboot pin for the next power-on
Legacy form: GET /api/bmc?opt=set&type=usb_boot with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
Request body (application/json)
| field |
type |
required |
description |
node |
string |
no |
1-4 |
Request body (application/x-www-form-urlencoded)
| field |
type |
required |
description |
node |
string |
no |
1-4 |
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
POST /api/bmc/usb-boot/clear
Release the usbboot pin
Legacy form: GET /api/bmc?opt=set&type=clear_usb_boot with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
default body (application/problem+json): Problem
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|