> 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/cli/commandreference/hardwareinventory.md).

# Hardware Inventory

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/07/06    |

## Table of Contents

* [1. Overview](#overview)
* [2. Subcommands](#subcommands)
* [3. Common Flags](#common-flags)
* [4. Usage Examples](#usage-examples)

***

## 1. Overview <a href="#overview" id="overview"></a>

{% hint style="warning" %}
**⚠️ Prerequisite: `aidc-cli init` required first**

This command depends on settings saved by [`aidc-cli init`](/guide/latest/cli/commandreference/init.md). Before running it, make sure you have completed:

* [`aidc-cli init inventory`](/guide/latest/cli/commandreference/init.md#inventory) — render the node inventory from `aidc.csv`
* [`aidc-cli init bmc-set`](/guide/latest/cli/commandreference/init.md#bmc-configuration) — save the BMC credentials

For the full setup sequence, see the [Getting Started](/guide/latest/cli/gettingstarted.md) guide.
{% endhint %}

The `hwinv` command collects raw BMC Redfish hardware inventory data from target nodes.

```bash
aidc-cli hwinv <subcommand> [flags]
```

***

## 2. Subcommands <a href="#subcommands" id="subcommands"></a>

| Subcommand | Aliases          | Description                             |
| ---------- | ---------------- | --------------------------------------- |
| `all`      | —                | Collect the full raw hardware inventory |
| `system`   | `baseboard`      | Collect system and baseboard inventory  |
| `cpu`      | —                | Collect CPU inventory                   |
| `memory`   | —                | Collect memory inventory                |
| `storage`  | `disk`           | Collect storage inventory               |
| `bmc-net`  | `nic`, `network` | Collect BMC network adapter inventory   |
| `pcie`     | —                | Collect PCIe inventory                  |
| `psu`      | —                | Collect power supply inventory          |

{% hint style="info" %}
Aliases are interchangeable with their primary subcommands. For example, `aidc-cli hwinv system` and `aidc-cli hwinv baseboard` trigger the same inventory view.
{% endhint %}

***

## 3. Common Flags <a href="#common-flags" id="common-flags"></a>

All `hwinv` subcommands support the following flag:

| Flag       | Short | Required | Description                                                                                    |
| ---------- | :---: | :------: | ---------------------------------------------------------------------------------------------- |
| `--stdout` |   —   |     ❌    | Output the raw hardware inventory JSON to stdout instead of only saving the generated artifact |

***

## 4. Usage Examples <a href="#usage-examples" id="usage-examples"></a>

```bash
# Collect the full hardware inventory
aidc-cli hwinv all

# Collect system and baseboard inventory
aidc-cli hwinv system

# Collect storage inventory as JSON
aidc-cli hwinv storage --stdout

# Collect BMC network adapter inventory for selected nodes only
aidc-cli hwinv bmc-net -l node01,node02

# Use an alias to collect the same system inventory view
aidc-cli hwinv baseboard --stdout
```