> 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.md).

# Firmware Management

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

## What is Firmware Management?

Firmware Management is a unified module for managing the firmware lifecycle, including firmware file management, task creation, execution tracking, and result analysis. It provides a consistent workflow to update multiple device types (BIOS, BMC, NIC, NVMe) in a safe and traceable way.

This module addresses three core questions:

* How firmware files are centrally managed and categorized
* How update tasks are created and delivered to the right devices
* How update outcomes are tracked and continuously improved

***

## Core Values

### 1. Centralized Operations

Manage firmware files, update tasks, and execution results in one workflow, reducing operational overhead.

### 2. Visibility and Traceability

From overview dashboards to task history, track progress, status, failures, and impacted devices in real time.

### 3. Safety and Risk Control

Only eligible devices can be selected, with validation and clear error feedback to reduce risky operations.

### 4. Flexibility and Extensibility

Support different update methods and parameters (for example remote URL and NVMe Device Range) for diverse scenarios.

***

## Main Features

![FirmwareSidemenu](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/firmwareManagement/fw-sidemenu.png)

### 1. Firmware Overview

* Monitor overall device and task health
* View task status distribution (In Progress, Completed, Failed, Timeout)
* Analyze failure reasons and impact scope

### 2. Firmware Update

* 3-step guided task creation: select type, select devices, select firmware
* Support multiple update methods
* Support NVMe device range configuration (Device Range, Exclude Device, multiple rows, live preview)

### 3. Firmware Repository

* Upload and manage firmware files
* Tag-based classification and quick search
* Create update tasks directly from repository items

### 4. Update History

* Review historical tasks and execution details
* Track per-device update outcomes
* Support auditing, troubleshooting, and optimization loops

***

## Quick Start

### Step 1: Confirm target and method

Choose firmware type (BIOS, BMC, NIC, NVMe) and the corresponding update method.

### Step 2: Prepare firmware files

Upload firmware files in Firmware Repository and add tags when needed for easier filtering.

### Step 3: Create an update task

Go to Firmware Update and complete:

* Select firmware type and method
* Select target devices
* Select firmware file or enter remote URL
* For NVMe, configure Device Range and Exclude Device, then verify the preview list
* Input fields automatically display `/dev/nvme` prefix; only enter numbers (e.g., `1` or `1~10`)

### Step 4: Track execution

After submission, monitor progress and outcomes in Update History and Overview.

### Step 5: Review and optimize

Use failure analysis to refine device conditions or update strategy before retrying.

***

## Documentation Navigation (Recommended Order)

1. [firmware-introduction.md](https://gitlab.com/AIDCTeam/gitbook-docs-portal/-/blob/main/projects/AIDC/guide/Portal/FirmwareManagement/firmware-introduction.md)
2. [firmware-overview.md](https://gitlab.com/AIDCTeam/gitbook-docs-portal/-/blob/main/projects/AIDC/guide/Portal/FirmwareManagement/firmware-overview.md)
3. [firmware-update.md](https://gitlab.com/AIDCTeam/gitbook-docs-portal/-/blob/main/projects/AIDC/guide/Portal/FirmwareManagement/firmware-update.md)
4. [firmware-repository.md](https://gitlab.com/AIDCTeam/gitbook-docs-portal/-/blob/main/projects/AIDC/guide/Portal/FirmwareManagement/firmware-repository.md)
5. [update-history.md](https://gitlab.com/AIDCTeam/gitbook-docs-portal/-/blob/main/projects/AIDC/guide/Portal/FirmwareManagement/update-history.md)
