> For the complete documentation index, see [llms.txt](https://asus-isg-aidc.gitbook.io/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://asus-isg-aidc.gitbook.io/guide/latest/portal/firmwareintroduction/firmwareoverview.md).

# Firmware Overview

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/05/04    |

## Feature Description

Firmware Overview is the dashboard page of firmware management, providing a real-time summary of the entire system's firmware update status. Here you can quickly grasp the overall update progress of devices, task execution status, and failure reasons that require attention.

![FirmwareOverview](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/firmwareManagement/overview.png)

***

## Page Structure

The page is divided into two main sections:

* **Left side**: Device Information
* **Right side**: Update Task Information

The last data update time is displayed at the top of the page (format: `HH:mm:ss`).

![FirmwareOverview](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/firmwareManagement/overview-features.png)

***

## Left Side: Device Information

### Warning Alert Banner

If there are currently tasks in "Failed" or "Timeout" status, a warning banner will be displayed at the top of the page, indicating the number of tasks that require attention.

### Update Method Distribution

Shows which update methods devices are currently using, divided into two types:

| Type          | Description                                      |
| ------------- | ------------------------------------------------ |
| OS / Tool     | Firmware update through operating system tools   |
| BMC / Redfish | Firmware update through BMC or Redfish interface |

The number of corresponding devices is displayed next to each method.

### Firmware Type Distribution

Shows device count statistics for each firmware type, including:

* **BIOS** (Purple)
* **BMC** (Yellow)
* **NIC** (Blue)
* **NVMe** (Brown)

### Currently Updating Devices List

Lists devices currently undergoing firmware updates, with each record containing:

* Hostname
* Component
* Method
* Type

### All Devices List

Shows basic status of all devices in the system, including:

* Hostname
* OS Status
* BMC Status
* Last Check Time

***

## Right Side: Update Task Information

### Date Range Filter

You can set start and end dates to filter task statistics to a specified time range.

* Click the date input box and use the calendar picker to select dates
* To clear the filter, click the **✕** icon next to the input box

### Task Status Distribution Chart

Shows the proportion of tasks in each status using a horizontal bar chart, with colors representing:

| Color  | Status      | Description |
| ------ | ----------- | ----------- |
| Blue   | In Progress | Running     |
| Green  | Completed   | Completed   |
| Red    | Failed      | Failed      |
| Orange | Timeout     | Timeout     |

Below the bar chart, the number and percentage of tasks for each status are displayed. When the count is greater than 0, clicking the corresponding status block redirects to Update History to view the matching task list.

### Failure Reason Analysis

This section groups by firmware type and lists all failure reasons to help you diagnose issues.

Each failure record includes:

* Failure reason icon and description text
* Number of occurrences and percentage (visualized with horizontal bars)
* List of affected devices (click **Expand ›** arrow to collapse/expand)

> **Recurring Failure Alert**: If devices appear repeatedly across failure records, a pulsing warning indicator is shown in the card header. Expanding it reveals the recurring devices and how many times they appeared.

### Empty States

| Situation                         | Display Content            |
| --------------------------------- | -------------------------- |
| No devices are currently updating | `No active updates`        |
| No failure records are available  | `No failure records found` |
| No device data is available       | `No devices found`         |

### Failure Reason Classification Description

The system automatically categorizes failure reasons based on execution step content. The following are trigger conditions for each category:

| Failure Reason            | Trigger Condition                                                     |
| ------------------------- | --------------------------------------------------------------------- |
| Node Unreachable          | Node reports UNREACHABLE status                                       |
| Reboot Failed             | Execution step contains "reboot"                                      |
| File Transfer Failed      | Execution step contains "copy file" or "copy script"                  |
| Cleanup Failed            | Execution step contains "clean up"                                    |
| Config Backup Failed      | Execution step contains "preserve config"                             |
| Update Execution Failed   | Execution step contains "update target" or "execute update"           |
| MST Initialization Failed | Execution step contains "start mst"                                   |
| Verification Failed       | Execution step contains "display result", "verification", or "verify" |
| Other                     | Does not meet any of the above conditions                             |

***

## Status Indicator Description

| Indicator         | Description                      |
| ----------------- | -------------------------------- |
| Green dot         | Device online                    |
| Gray dot          | Device offline or unknown status |
| Blue animated dot | Device updating                  |

***

## Usage Recommendations

1. Check Firmware Overview at the beginning of each workday to understand the overall status
2. If warning banners appear, prioritize going to the Update History page to view failed tasks
3. Use date range filtering effectively to compare update effectiveness across different periods
4. Regularly check "Failure Reason Analysis" to identify recurring problem devices