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

# Command Guide

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/02/12    |

## Overview

This page provides a quick-reference table of all AIDC-CLI commands and their subcommands. Click any command name for detailed documentation.

***

## Command Map

```
aidc-cli
├── license                          # License management (no license required)
│   ├── active -k <key>              # Activate license
│   └── show [-j]                    # Show license info
│
├── init                             # Initialization & configuration
│   ├── inventory                    # Render CSV to node inventory
│   ├── common-get / common-set      # AIDC common config
│   ├── clear-report                 # Clear task reports
│   ├── bmc-get / bmc-set            # BMC config
│   ├── pkg-get / pkg-set            # Package config
│   ├── syscfg-get / syscfg-set      # System config
│   ├── syscfg-ntp-set               # NTP server config
│   ├── dhcp-get / dhcp-set          # DHCP config
│   ├── dhcp-validate                # Validate CSV vs DHCP
│   ├── image-discovery / image-list # Deploy image mgmt
│   ├── image-active / image-download / image-downloadable
│   ├── group-get / group-set        # Node group config
│   ├── slurm-get / slurm-set        # Slurm config
│   ├── mariadb-get / mariadb-set    # MariaDB config
│   ├── container-get / container-set# Container config
│   ├── k8s-get / k8s-set            # Kubernetes config
│   ├── swraid-get / swraid-set      # SW RAID config
│   ├── lvm-get / lvm-set            # LVM config
│   ├── ufm-get / ufm-set            # UFM config
│   ├── nmx-get / nmx-set / nmx-reset# NMX config
│   ├── eth-get / eth-set            # Ethernet config
│   ├── bond-get / bond-set          # Bonding config
│   ├── ib-get / ib-set              # InfiniBand config
│   ├── nvos-get / nvos-set          # NVOS config
│   └── link-type-get / link-type-set# Link type config
│
├── bmc                              # BMC/IPMI operations
│   ├── bmc-ver                      # Get BMC version
│   ├── pxe-boot                     # Set boot from PXE
│   ├── init-pwd                     # Initialize BMC password
│   ├── change-pwd                   # Change BMC password
│   ├── bmc-net                      # Configure BMC network
│   ├── bmc-ntp                      # Configure NTP on BMC
│   ├── power-reset / power-on / power-off
│   ├── cold-reset                   # Cold reset BMC
│   └── reset-default                # Reset BMC to defaults
│
├── deploy                           # OS deployment
│   ├── install                      # Install OS via PXE
│   ├── dhcp-enabled / dhcp-disabled # DHCP service control
│   ├── image-download               # Download ISO
│   ├── access-key [-f]              # Setup SSH key
│   └── proxy-enabled                # Enable proxy
│
├── network                          # Network configuration
│   ├── eth-cfg                      # Ethernet config
│   ├── eth-bond                     # Ethernet bonding
│   ├── ib-cfg                       # InfiniBand config
│   ├── nvos-cfg                     # NVOS Ethernet config
│   ├── link-type                    # NIC link type config
│   └── dpu-mode [-m nic|dpu]        # DPU mode switching
│
├── chknet                           # Network validation
│   ├── pxe [-o]                     # PXE network check
│   ├── bmc [-o]                     # BMC network check
│   ├── ib [-o] [-f host|device]     # InfiniBand check
│   └── eth-map [-o]                 # Ethernet port mapping
│
├── hwsensor                         # Hardware sensor monitoring
│   ├── temperature --interval <min> # Temperature (IPMI)
│   ├── power --interval <min>       # Power (IPMI)
│   ├── temperature-redfish          # Temperature (Redfish)
│   ├── power-redfish                # Power (Redfish)
│   ├── fan-redfish                  # Fan (Redfish)
│   └── all-redfish                  # All sensors (Redfish)
│
├── hwspec                           # Hardware spec validation
│   ├── all-spec -m <tool|redfish>   # All hardware
│   ├── baseboard-spec               # Baseboard
│   ├── cpu-spec / memory-spec       # CPU / Memory
│   ├── disk-spec / nic-spec         # Disk / NIC
│   ├── pike-spec / gpu-spec         # Pike / GPU
│   ├── pcie-spec / psu-spec         # PCIe / PSU
│
├── chkfw                            # Firmware validation
│   ├── all-version                  # All firmware
│   ├── bmc-version / bios-version   # BMC / BIOS
│   ├── raid-version                 # RAID
│   └── infiniband-version           # InfiniBand
│
├── fwupdate                         # Firmware update
│   ├── bios-tool / bios-redfish-x86 / bios-redfish-arm
│   ├── bmc-tool / bmc-redfish-local / bmc-redfish-remote
│   ├── mlnx-nic / mlnx-dpu         # Mellanox NIC/DPU
│   └── nvme                         # NVMe firmware
│
├── pkg                              # Package management
│   ├── extra-pkg                    # Install/remove packages
│   └── nvlink-sw                    # NVLink switch OS
│
├── driver                           # Driver installation
│   ├── mlnx-ofed                    # Mellanox OFED
│   ├── doca-host-nic                # DOCA NIC driver
│   ├── doca-host-dpu                # DOCA DPU driver
│   └── nv-gpu                       # NVIDIA GPU driver
│
├── syscfg                           # System configuration
│   ├── basic-all                    # All basic configs
│   ├── sshd / sshkey / hosts / ethers / limits / sysctl / lmodpath
│   ├── repo-rhel / repo-debian      # Repository config
│   ├── ntp / timezone-get / timezone-set
│   ├── subscription register/unregister/status
│   ├── sw-raid                      # Software RAID
│   └── disk-clean -m <mode>         # Disk cleanup
│
├── security                         # Security configuration
│   ├── firewall-enable / firewall-disable
│   ├── firewall-add-rule / firewall-remove-rule
│   ├── firewall-list-rule
│   ├── selinux-enable               # Enable SELinux (reboot)
│   └── selinux-disable              # Disable SELinux (reboot)
│
├── slurm                            # Slurm workload manager
│   ├── setup-cluster                # Full cluster setup
│   └── slurmd -c <nodes>            # Add compute nodes
│
├── database                         # Database management
│   └── maria-galera                 # MariaDB Galera cluster
│
├── sysinfo [--stdout]               # System information report
│
├── ufm                              # UFM management
│   └── deploy [-n iface] [-p path]  # Deploy UFM standalone
│
├── container                        # Container management
│   ├── docker [-m image] [-n count] # Docker host
│   └── podman [-m image] [-n count] # Podman host
│
├── kubernetes                       # Kubernetes
│   └── k8s-native                   # Native K8s cluster
│
├── nmx                              # NMX-M management
│   └── deploy -W <pw> -E <pw> -V <pw> [-S]
│
└── weka                             # WEKA storage
    └── deploy -I <iso-file>         # Deploy WEKA
```

***

## Detailed Documentation

Each command has its own documentation page with full descriptions, flag details, and usage examples:

|  #  | Command      | Page                                                                            |
| :-: | ------------ | ------------------------------------------------------------------------------- |
|  1  | `license`    | [License Management](/guide/v1.4.0/cli/commandreference/license.md)             |
|  2  | `init`       | [Initialization](/guide/v1.4.0/cli/commandreference/init.md)                    |
|  3  | `bmc`        | [BMC Operations](/guide/v1.4.0/cli/commandreference/bmc.md)                     |
|  4  | `deploy`     | [OS Deployment](/guide/v1.4.0/cli/commandreference/deploy.md)                   |
|  5  | `network`    | [Network Configuration](/guide/v1.4.0/cli/commandreference/network.md)          |
|  6  | `chknet`     | [Network Validation](/guide/v1.4.0/cli/commandreference/networkvalidation.md)   |
|  7  | `hwsensor`   | [Hardware Sensor](/guide/v1.4.0/cli/commandreference/hardwaresensor.md)         |
|  8  | `hwspec`     | [Hardware Specification](/guide/v1.4.0/cli/commandreference/hardwarespec.md)    |
|  9  | `chkfw`      | [Firmware Validation](/guide/v1.4.0/cli/commandreference/firmwarevalidation.md) |
|  10 | `fwupdate`   | [Firmware Update](/guide/v1.4.0/cli/commandreference/firmwareupdate.md)         |
|  11 | `pkg`        | [Package Management](/guide/v1.4.0/cli/commandreference/package.md)             |
|  12 | `driver`     | [Driver Installation](/guide/v1.4.0/cli/commandreference/driver.md)             |
|  13 | `syscfg`     | [System Configuration](/guide/v1.4.0/cli/commandreference/sysconfig.md)         |
|  14 | `security`   | [Security Settings](/guide/v1.4.0/cli/commandreference/security.md)             |
|  15 | `slurm`      | [Slurm Workload Manager](/guide/v1.4.0/cli/commandreference/slurm.md)           |
|  16 | `database`   | [Database Management](/guide/v1.4.0/cli/commandreference/database.md)           |
|  17 | `sysinfo`    | [System Information](/guide/v1.4.0/cli/commandreference/sysinfo.md)             |
|  18 | `ufm`        | [UFM Management](/guide/v1.4.0/cli/commandreference/ufm.md)                     |
|  19 | `container`  | [Container Management](/guide/v1.4.0/cli/commandreference/container.md)         |
|  20 | `kubernetes` | [Kubernetes Cluster](/guide/v1.4.0/cli/commandreference/kubernetes.md)          |
|  21 | `nmx`        | [NMX Management](/guide/v1.4.0/cli/commandreference/nmx.md)                     |
|  22 | `weka`       | [WEKA Storage](/guide/v1.4.0/cli/commandreference/weka.md)                      |
