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

# Image Management

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/01/26    |

## 1. Feature Overview

![Image Management Overview](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/image-management-overview.png)

The Image Management page allows you to manage operating system image files (ISO files) in the system. Through this page, you can:

* View all operating system image files in the system
* Check the download status of each image file
* Download new image files to the system
* Search for specific operating system image files
* Select multiple image files for batch download

### Common Use Cases

**View Available Image Files**

* When you need to install an operating system on a computer, you can check here to see which image files are available
* The system clearly displays whether each image file has been downloaded

**Download New Image Files**

* If you need a specific operating system image file that is not yet in the system
* You can select that image file and click the download button
* The system will download it in the background, so you don't need to wait

**Find Specific Image Files**

* When there are many image files, you can use the search function to quickly find the files you need
* For example, searching for "Ubuntu" will find all Ubuntu-related image files

**Batch Download Multiple Image Files**

* If you need to download multiple image files simultaneously
* You can select multiple at once and download them together
* This saves you time from downloading them one by one

***

## 2. How to Access the Image Management Page

### Steps to Open the Page

![Image Management Route](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/image-management-route.png)

1. After logging into the system, you will see a menu bar on the left side of the screen
2. Find the "Deploy" menu item
3. Click "Deploy" to expand the submenu
4. In the submenu, click "Image Management"
5. The screen will switch to the Image Management page

### Important Notes

* You must log in to the system before using this feature
* Your account needs to have image management permissions
* Downloading image files requires an internet connection
* Ensure the system has sufficient storage space to store image files

***

## 3. Page Interface Description

When you open the Image Management page, you will see the following areas:

### Top of the Page

![Top Feature](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/top-feature.png)

**Title Bar**

* The left side displays "Image List" with an icon
* The right side has a "Download" button (blue)

**Search Bar**

* Below the title bar is a search box
* You can enter keywords here to find image files
* For example, entering "Ubuntu" will find all Ubuntu-related image files

### Image File List

![Image File List](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/image-file-list.png)

The list divides image files into five groups, each representing a different download status. The system displays them in the following fixed order:

| Status           | Indicator                                                                                                         | Description                                                             | Selectable                          |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------- |
| **Downloaded**   | ![Downloaded](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/downloaded-icon.png)     | Image files that have been downloaded successfully and are ready to use | Auto-selected, cannot be deselected |
| **In Progress**  | ![in progress](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/in-progress-icon.png)   | Image files currently being downloaded in the background                | No, wait for completion             |
| **Queued**       | ![Queued](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/queued-icon.png)             | Image files waiting in the download queue to be processed in order      | No, wait for completion             |
| **Failed**       | ![Failed](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/failed-icon.png)             | Image files that failed to download                                     | Yes, can reselect and retry         |
| **Undownloaded** | ![Undownloaded](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/undownloaded-icon.png) | Image files that have not been downloaded yet                           | Yes, can select for download        |

### Information Displayed in the List

Each image file displays the following information:

![Checkbox](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/checkbox.png)

**Selection Checkbox**

* The leftmost part of the list has a checkbox that can be checked or unchecked
* Downloaded files are automatically checked and cannot be unchecked
* Files being downloaded or queued cannot be checked
* Failed or undownloaded files can be freely checked

**Operating System Icon and Name**

* Displays the operating system logo (such as the Ubuntu icon)
* Next to it displays the image file name (such as "ubuntu-22.04")

**Status**

* Uses color labels to display the current status
* Downloaded: Green (Downloaded)
* In Progress: Blue (In Progress)
* Queued: Yellow (Queued)
* Failed: Red (Failed)
* Undownloaded: Gray (Undownloaded)

**Architecture**

* Displays the processor type this image file is compatible with
* For example: x86\_64 (64-bit computer), ARM64 (ARM processor)

**Version**

* Displays the operating system version number
* For example: 22.04, 8.6, etc.

**Update Date**

* Displays when this image file was last updated
* Format: Year-Month-Day

### Group "Select All" Feature

Each group's title bar has a "Select All" button on the right side (oval-shaped with shadow):

![Select All](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/select-all.png)

* **Groups with Select All button**: Failed, Undownloaded
  * Clicking it will select all image files in that group at once
  * Clicking again will deselect all selections
* **Groups without Select All button**: Downloaded, In Progress, Queued
  * Because these files cannot be selected or are already automatically selected, the Select All button is not displayed

### Page Right Side Options Settings

On the right edge of the page, you will see an "Options" button. Clicking it will open a settings panel that allows you to customize how the list is displayed.

![Option](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/imageManagement/option.png)

#### Fields (Column Display Settings)

This area lets you choose which information columns to display in the list:

**Available Columns**:

* **Name**: Image file name
* **Status**: Download status label
* **Image**: Operating system icon
* **Type**: Image file type
* **Architecture**: Processor architecture (such as x86\_64)
* **Version**: Operating system version number
* **Description**: Image file description
* **Created Date**: Image file creation time
* **Updated Date**: Image file last update time

**How to Use**:

* Checked columns will be displayed in the list
* Unchecked columns will be hidden
* You can show or hide specific columns based on your needs to make the list more concise or more detailed

#### Row Groupings (Data Grouping)

This area shows the column currently used for grouping:

**Default Grouping**:

* The system uses "Status" for grouping by default
* This is why the list displays files grouped by Downloaded, In Progress, Queued, Failed, and Undownloaded status

**Adjust Grouping**:

* To remove grouping, click the "×" button next to the grouping column
* After removing grouping, all image files will be displayed in a single list without separate groups
* You can also drag other columns from the list above to here to create different grouping methods

***

## 4. Operation Instructions

### Operation 1: View Image File List

**Steps**:

1. Enter the Image Management page
2. Wait for the page to finish loading

**You Will See**:

* All image files displayed in five groups by status
* The group order is fixed: Downloaded → In Progress → Queued → Failed → Undownloaded
* Each group displays how many image files it contains
* Downloaded image files will be automatically selected (checkboxes are checked)

***

### Operation 2: Search for Specific Image Files

**Scenario**: When there are many image files, you want to quickly find a specific file

**Steps**:

1. Enter keywords in the search box at the top of the page
   * For example, enter "ubuntu"
2. The system will immediately display matching results

**Search Tips**:

* You can search by image file name (such as "ubuntu")
* You can search by version number (such as "22.04")
* You can search by architecture (such as "x86\_64")
* You can enter multiple keywords at once (separated by spaces), for example, "ubuntu 22" will find image files containing both words

**Clear Search**:

* Delete the text in the search box, and the list will display all image files

***

### Operation 3: Select a Single Image File

**Scenario**: You want to download a specific image file

**Steps**:

1. Find the image file you need in the list
2. Check the status of that image file:
   * If the status is "Undownloaded" or "Failed": Click the checkbox on the left to select it
   * If the status is "Downloaded": The file is automatically selected and cannot be deselected
   * If the status is "In Progress" or "Queued": Cannot be selected (need to wait for download to complete)
3. After selection, a checkmark appears in the box

**Tip**:

* When you move your mouse over a checkbox that cannot be selected, it will display the reason
* For example, "Cannot select: Image file download is in progress"

***

### Operation 4: Use Select All Feature

**Scenario**: You want to select all image files in a group at once

**Steps**:

1. Find the group you want to operate on (for example, the "Undownloaded" group)
2. Check if there is a "Select All" button on the right side of the group title bar
3. Click the "Select All" button
4. All selectable image files in that group will be selected
5. Click the "Select All" button again to deselect all in that group

**Note**:

* Only the "Failed" and "Undownloaded" groups have a Select All button
* The "Downloaded", "In Progress", and "Queued" groups do not have a Select All button because files cannot be freely selected

***

### Operation 5: Download Selected Image Files

**Scenario**: You have already selected the image files you want to download

**Steps**:

1. Confirm that you have selected the image files you need (checkboxes are checked)
2. Click the "Download" button in the upper right corner of the page (blue button)
3. The system will display the message: "Image file download will be completed in the background, please check status later"
4. You can continue using other features without waiting

**Download Progress**:

* After the download starts, the image file status will change to "Queued" or "In Progress"
* You can see the current download status in the list
* After the download is complete, the status will automatically change to "Downloaded"
* If the download fails, the status will change to "Failed", and you can download it again

**Important Reminder**:

* The "Download" button can only be clicked when you have selected image files
* If no image files are selected, the button will be grayed out (not clickable)

***

### Operation 6: Combine Search and Download

**Scenario**: You want to search for specific image files and download them

**Steps**:

1. Enter keywords in the search box (for example, "centos 7")
2. The list will only display image files that match the criteria
3. Select the image files you need from the search results
4. Click the "Download" button
5. Even if you clear the search criteria, your selected image files will remain selected

***

### Operation 7: Check Download Status

**Scenario**: You want to confirm whether image files have finished downloading

**Method 1: Stay on the Page and Observe**

* The status of downloading image files will update in real-time
* From "Queued" → "In Progress" → "Downloaded"

**Method 2: Refresh the Page**

* If you leave the page and return later
* The system will load the latest status information

**Handling Download Failures**:

* If an image file fails to download, the status will display as "Failed"
* That file will move to the "Failed" group (red indicator)
* You can reselect that file and try downloading again

***

### Operation 8: Customize Column Display

**Scenario**: You want to adjust which information columns are displayed in the list to make the screen more concise or more detailed

**Steps**:

1. Click the "Options" button on the right side of the page
2. The settings panel will slide out from the right
3. In the "Fields" area, you will see all available columns
4. Check the columns you want to display
5. Uncheck the columns you want to hide
6. The list will update immediately, showing only the columns you selected

**Usage Recommendations**:

* If you only care about basic information, you can display only "Name", "Status", and "Version"
* If you need detailed information, you can display all columns
* Your adjusted settings will be saved and remembered the next time you open the page

***

### Operation 9: Adjust Data Grouping

**Scenario**: You want to change how the list is grouped, or remove grouping

**Remove Status Grouping**:

1. Click the "Options" button on the right side of the page
2. In the "Row Groupings" area, you will see "Status"
3. Click the "×" button next to "Status"
4. The list will remove grouping and display as a complete single list
5. All image files will be sorted in default order, no longer grouped by status

**Re-enable Grouping**:

1. If you want to restore grouping after removing it, you can refresh the page
2. Or drag the "Status" column from above to the "Row Groupings" area

**Note**:

* After removing grouping, the "Select All" button will disappear because there is no longer a group concept
* The grouping feature helps you quickly understand the number of image files in different statuses

***

## 5. Frequently Asked Questions

### Question 1: What if I can't find an image file?

**Checklist**:

* Confirm that the keywords entered are spelled correctly
* Try entering only part of the name, for example, just enter "ubuntu" instead of the full filename
* The system search is case-insensitive, "Ubuntu" and "ubuntu" have the same effect
* Clear the search box to confirm that the image file actually exists in the list

***

### Question 2: The download button cannot be clicked (displays gray)

**Possible Cause**:

* You have not selected any image files
* Solution: Select at least one image file with "Undownloaded" or "Failed" status

***

### Question 3: Some image files cannot be selected

**Explanation**: This is normal. Image files with the following statuses cannot be selected:

* **Downloaded**: These files are already available, automatically selected by the system
* **In Progress**: Currently downloading, please wait for completion
* **Queued**: Waiting in the download queue, please be patient

Only image files with "Undownloaded" and "Failed" status can be freely selected.

***

### Question 4: How do I know when an image file has finished downloading?

**Method**:

1. Stay on the page and observe status changes
2. The status will change from "Queued" to "In Progress", and finally to "Downloaded"
3. "Downloaded" image files will move to the "Downloaded" group (green indicator with checkmark)
4. After the download is complete, that image file can be used for system deployment

***

### Question 5: Can I download multiple image files at the same time?

**Answer**: Yes. You can:

1. Select multiple image files with "Undownloaded" or "Failed" status
2. Click the "Download" button once
3. The system will add these image files to the download queue
4. The system will download these files in order

***

### Question 6: What should I do if a download fails?

**Steps to Handle**:

1. Check if the network connection is normal
2. Confirm that the system has sufficient storage space
3. Find the failed image file (in the "Failed" group, red indicator)
4. Reselect that image file
5. Click the "Download" button again to try re-downloading

If failures persist, please contact the system administrator.

***

## 6. Important Notes

### Preparation Before Downloading

**Confirm Network Connection**

* Downloading image files requires a stable internet connection
* Image files are usually large, it is recommended to use a wired network or stable Wi-Fi

**Confirm Storage Space**

* Each image file may require several GB of space
* Please confirm that the system has sufficient storage space before downloading
* If space is insufficient, the download may fail

### Usage Recommendations

**Make Good Use of the Search Function**

* When there are many image files, using search can save time
* You can enter multiple keywords simultaneously to narrow the search range

**Benefits of Batch Download**

* Selecting multiple image files at once can save operation time
* The system will automatically manage the download order
* You don't need to click download for each one individually

**Pay Attention to Download Status**

* Regularly check the download status of image files
* If you find files with "Failed" status, re-download them as soon as possible
* Ensure that the image files you need are all in "Downloaded" status

### Permission-Related

**Need Appropriate Permissions**

* Your account must have image management permissions to use this feature
* If you cannot access this page, please contact the system administrator

***

## 7. Getting Help

If you encounter problems while using the Image Management feature:

1. First check the "Frequently Asked Questions" section of this manual
2. Confirm whether your operation steps are correct
3. If the problem still exists, please contact the system administrator
4. Provide detailed information about the problem:
   * What operation you are performing
   * What error message appears
   * Whether the problem can be reproduced

***
