megarac-inventory

POST /megarac-inventory/bios

Get MegaRAC BIOS settings

Returns the curated MegaRAC BIOS toggles with their current values and allowable options.

Request JSON Object:
  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
POST /megarac-inventory/bios/patch

Stage MegaRAC BIOS changes

Holds the BMC lock and stages the given BIOS toggle changes on the MegaRAC BMC; they apply on the next restart.

Request JSON Object:
  • attributes (object) – (required)

  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
POST /megarac-inventory/bios/pending

Get pending MegaRAC BIOS changes

Returns the BIOS toggle changes staged on the MegaRAC BMC but not yet applied.

Request JSON Object:
  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
POST /megarac-inventory/bios/restart

Gracefully restart a MegaRAC server

Triggers a graceful restart through the MegaRAC BMC so staged BIOS changes apply.

Request JSON Object:
  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
Response JSON Object:
  • message (string)

  • status (string)

POST /megarac-inventory/collect

Collect MegaRAC hardware inventory

Reads the BMC and system summary from the MegaRAC BMC over Redfish; credentials fall back to the stored BMC record when omitted.

Request JSON Object:
  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
Response JSON Object:
  • bmc.firmware_version (string)

  • bmc.ip (string)

  • bmc.model (string)

  • bmc.uuid (string)

  • system.bios_version (string)

  • system.health (string)

  • system.manufacturer (string)

  • system.model (string)

  • system.power_state (string)

  • system.serial (string)

  • system.uuid (string)

POST /megarac-inventory/firmware

Get MegaRAC firmware inventory

Returns the live BMC and BIOS firmware versions read from the MegaRAC BMC.

Request JSON Object:
  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
POST /megarac-inventory/firmware/flash

Flash MegaRAC firmware

Holds the BMC lock, ensures the BMC preserves its configuration, stages the uploaded image over HTTPS and starts a Redfish SimpleUpdate; returns the task ID to follow on update-task/sse.

Request JSON Object:
  • bmc_ip (string) – (required)

  • control_node_ip (string)

  • filename (string) – (required)

  • password (string)

  • username (string)

Status Codes:
GET /megarac-inventory/firmware/list

List MegaRAC firmware images

Lists the uploaded MegaRAC firmware images with size and modification time; an unreadable directory yields an empty list.

Status Codes:
POST /megarac-inventory/firmware/upload

Upload a MegaRAC firmware image

Saves an uploaded MegaRAC firmware image (.ima, .bin or .rom) to the firmware staging directory for a later flash.

Status Codes:
POST /megarac-inventory/iso/mount

Mount the reveal ISO on a MegaRAC server

Allocates a reveal IP, stamps the reveal ISO, stages it for HTTPS serving, mounts it as virtual media on the MegaRAC BMC and boots the server from it.

Request JSON Object:
  • bmc_ip (string) – (required)

  • control_node_ip (string) – (required)

  • iso_file (string) – (required)

  • password (string)

  • username (string)

Status Codes:
Response JSON Object:
  • error (string)

  • message (string)

  • status (string)

  • steps[] (string)

POST /megarac-inventory/power

Get MegaRAC power state

Returns the server power state and reset actions; when the BMC advertises none, the default reset action set is returned.

Request JSON Object:
  • bmc_ip (string) – (required)

  • password (string)

  • username (string)

Status Codes:
POST /megarac-inventory/power/action

Run a MegaRAC power action

Holds the BMC lock and sends the requested power action to the MegaRAC BMC.

Status Codes:
GET /megarac-inventory/power/sse

Stream MegaRAC power state

Server-sent event stream that polls the MegaRAC power state every 3 seconds and broadcasts changes; credentials fall back to the stored BMC record when omitted.

Query Parameters:
  • bmc_ip (string) – BMC IP address

  • username (string) – BMC username

  • password (string) – BMC password

Status Codes:
GET /megarac-inventory/update-task/sse

Stream MegaRAC firmware task progress

Server-sent event stream of Redfish firmware task progress for one BMC task; credentials fall back to the stored BMC record when omitted.

Query Parameters:
  • bmc_ip (string) – BMC IP address

  • task_id (string) – Redfish task ID

  • username (string) – BMC username

  • password (string) – BMC password

Status Codes: