cisco-inventory
- PATCH /cisco-inventory/bios
Patch Cisco BIOS attributes
Holds the BMC lock, patches the given BIOS attributes on the Cisco CIMC and returns the resulting pending attributes; a graceful restart applies them.
- Request JSON Object:
attributes (object) – (required)
bmc_ip (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
409 Conflict – BMC operation locked
502 Bad Gateway – BIOS patch or pending read on the BMC failed
- Response JSON Object:
message (string)
pending_attributes (object)
status (string)
- POST /cisco-inventory/bios
Get Cisco BIOS settings
Returns the current BIOS attributes and their options read from the Cisco CIMC.
- Request JSON Object:
bmc_ip (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
502 Bad Gateway – Reading BIOS settings from the BMC failed
- Response JSON Object:
bios_options[].allowed_values[] (string)
bios_options[].attribute_name (string)
bios_options[].current_value (string)
bios_options[].description (string)
bios_options[].key (string)
bios_settings (object)
- POST /cisco-inventory/bios/pending
Get pending Cisco BIOS attributes
Returns the BIOS attributes staged on the Cisco CIMC that apply on the next restart.
- Request JSON Object:
bmc_ip (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
502 Bad Gateway – Reading pending attributes from the BMC failed
- Response JSON Object:
pending_attributes (object)
status (string)
- POST /cisco-inventory/bios/restart
Gracefully restart a Cisco server
Triggers a graceful restart through the Cisco CIMC so pending BIOS settings are applied.
- Request JSON Object:
bmc_ip (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
502 Bad Gateway – Restart on the BMC failed
- Response JSON Object:
message (string)
status (string)
- POST /cisco-inventory/collect
Collect Cisco hardware inventory
Reads the Cisco CIMC inventory over Redfish, persists it as the node’s hardware inventory and returns it; credentials fall back to the stored BMC record when omitted.
- Request JSON Object:
bmc_ip (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
502 Bad Gateway – Inventory collection from the BMC failed
- Response JSON Object:
bios_options[].allowed_values[] (string)
bios_options[].attribute_name (string)
bios_options[].current_value (string)
bios_options[].description (string)
bios_options[].key (string)
bios_settings (object)
bmc.firmware_version (string)
bmc.ip (string)
bmc.last_reset (string)
bmc.model (string)
bmc.uuid (string)
cpu.count (integer)
cpu.max_speed_mhz (integer)
cpu.model (string)
cpu.total_cores (integer)
cpu.total_threads (integer)
memory.modules[].manufacturer (string)
memory.modules[].size_mib (integer)
memory.modules[].slot (string)
memory.modules[].speed_mhz (integer)
memory.modules[].type (string)
memory.total_gib (integer)
memory.total_mib (integer)
nics[].link (string)
nics[].mac (string)
nics[].name (string)
nics[].speed_mbps (integer)
processors[].cores (integer)
processors[].id (string)
processors[].manufacturer (string)
processors[].max_speed_mhz (integer)
processors[].model (string)
processors[].threads (integer)
storage[].controller (string)
storage[].device_path (string) – not exposed by Redfish; left empty
storage[].health (string)
storage[].interface (string) – SATA | SAS | NVMe | PCIe
storage[].model (string)
storage[].name (string)
storage[].rotational (integer) – 1 for HDD, 0 otherwise
storage[].serial (string)
storage[].size_bytes (integer)
storage[].size_gb (integer)
storage[].type (string) – SSD | HDD | NVMe
system.bios_version (string)
system.health (string)
system.manufacturer (string)
system.model (string)
system.power_state (string)
system.serial (string)
system.uuid (string)
- POST /cisco-inventory/firmware/complete
Mark a Cisco HUU firmware update complete
Records the HUU update for the BMC as completed by the user, since CIMC requires console interaction.
- Request JSON Object:
bmc_ip (string)
iso_filename (string)
iso_password (string)
iso_url (string)
iso_username (string)
password (string)
username (string)
- Status Codes:
200 OK – message, bmc_ip and phase
400 Bad Request – Invalid request
- POST /cisco-inventory/firmware/eject
Eject Cisco virtual media
Ejects the virtual media from the Cisco CIMC and clears the tracked firmware update state.
- Request JSON Object:
bmc_ip (string)
iso_filename (string)
iso_password (string)
iso_url (string)
iso_username (string)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
- Response JSON Object:
message (string)
- GET /cisco-inventory/firmware/files
List Cisco HUU ISOs
Lists the .iso files in the Cisco ISO directory; an absent directory yields an empty list.
- Status Codes:
200 OK – OK
500 Internal Server Error – Listing the ISO directory failed
- Response JSON Object:
files[] (string)
- POST /cisco-inventory/firmware/start
Start a Cisco HUU firmware update
Holds the BMC lock and, in the background, mounts the HUU ISO and reboots the server into it; returns 202 and progress is read from firmware/status.
- Request JSON Object:
bmc_ip (string)
iso_filename (string)
iso_password (string)
iso_url (string)
iso_username (string)
password (string)
username (string)
- Status Codes:
202 Accepted – Accepted
400 Bad Request – Invalid request, missing bmc_ip or iso_url, or unusable ISO URL
404 Not Found – BMC credentials not found
409 Conflict – Update already in progress or BMC operation locked
- Response JSON Object:
bmc_ip (string)
message (string)
- POST /cisco-inventory/firmware/status
Get Cisco HUU firmware update status
Returns the tracked HUU update phase for the BMC, cross-checked against the virtual media state read from the Cisco CIMC.
- Request JSON Object:
bmc_ip (string)
iso_filename (string)
iso_password (string)
iso_url (string)
iso_username (string)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
- Response JSON Object:
bmc_ip (string)
iso_url (string)
message (string)
phase (string)
started_at (string)
steps[] (string)
- POST /cisco-inventory/firmware/upload
Upload a Cisco HUU ISO
Saves an uploaded .iso file to the Cisco ISO directory and returns the URL to use when starting an HUU update.
- Status Codes:
200 OK – OK
400 Bad Request – No file provided or file is not an .iso
500 Internal Server Error – Storage directory or file save failed
- Response JSON Object:
filename (string)
note (string)
url (string)
- POST /cisco-inventory/iso/mount
Mount the reveal ISO on a Cisco server
Allocates a reveal IP, stamps and publishes the reveal ISO, mounts it as virtual media on the Cisco CIMC and boots the server from it with a one-time CD override.
- Request JSON Object:
bmc_ip (string) – (required)
control_node_ip (string) – (required)
iso_file (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – OK
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
409 Conflict – BMC operation locked
502 Bad Gateway – Reveal refused, or ISO prepare, publish, mount or boot failed
- Response JSON Object:
error (string)
message (string)
status (string)
steps[] (string)
- POST /cisco-inventory/power
Get Cisco power state
Returns the server power state and the reset actions the Cisco CIMC allows.
- Request JSON Object:
bmc_ip (string) – (required)
password (string)
username (string)
- Status Codes:
200 OK – power_state and available_actions
400 Bad Request – Invalid request
404 Not Found – BMC credentials not found
502 Bad Gateway – Reading power state from the BMC failed
- POST /cisco-inventory/power/action
Run a Cisco power action
Holds the BMC lock and sends the requested power action to the Cisco CIMC.
- Status Codes:
200 OK – status and message
400 Bad Request – Invalid request or missing action
404 Not Found – BMC credentials not found
409 Conflict – BMC operation locked
502 Bad Gateway – Power action on the BMC failed
- GET /cisco-inventory/power/sse
Stream Cisco power state
Server-sent event stream that polls the Cisco CIMC 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:
200 OK – SSE stream of power_state events
500 Internal Server Error – SSE client could not be registered