> 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/lateset/cli.md). # CLI User Guide | Developer | Last modified | | --------- | ------------- | | AIDC Team | 2026/05/18 | ## 1. Overview AIDC-CLI (ASUS Infrastructure Deployment Center - Command Line Interface) is a command-line tool for infrastructure automation across deployment, validation, firmware, operating system configuration, storage, and workload services. ### 1.1 Key Capabilities | Category | Features | | -------------- | --------------------------------------------------------------------------------------------------------------------------- | | Infrastructure | BMC control, BIOS management, PXE-based OS deployment, DHCP management | | Network | Ethernet bonding, InfiniBand, NVOS, NIC link-type, DPU mode switching | | Hardware | Sensor monitoring, specification collection, raw inventory collection, health checks, firmware validation, firmware updates | | Drivers | NVIDIA GPU, Mellanox OFED, DOCA host packages | | System | System information, OS configuration inventory, NTP, timezone, SSH, repositories, firewall, SELinux, subscriptions | | Storage | Software RAID, LVM, disk cleanup, WEKA deployment | | Workloads | Slurm, MariaDB Galera, Docker, Podman, Native Kubernetes, UFM, NMX-M | | Baselines | SAT baseline creation and drift validation across hardware, firmware, and OS domains | ### 1.2 Architecture ![AIDC-CLI Architecture](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/cli/aidc-cli-module.png) ### 1.3 Command Structure ```bash aidc-cli [flags] ``` **Global Flags** | Flag | Short | Description | | ----------------- | :---: | ----------------------------------------- | | `--limit-hosts` | `-l` | Limit operations to specific hosts | | `--exclude-hosts` | `-e` | Exclude specific hosts from an operation | | `--task-id` | `-i` | Attach a task ID to the current operation | | `--version` | `-v` | Show version information | | `--help` | `-h` | Show help for the selected command | {% hint style="info" %} `aidc-cli -v` and `aidc-cli --version` are root-only forms. Do not combine the version flag with an additional command or argument. {% endhint %} *** ## 2. Typical Workflow ```mermaid flowchart LR S1["1. License
Activation"] S2["2. Init &
Inventory"] S3["3. BMC / BIOS
Preparation"] S4["4. OS
Deployment"] S5["5. Network &
Driver Setup"] S6["6. Service &
Storage Deployment"] S7["7. Validation,
Inventory, SAT"] S1 --> S2 --> S3 --> S4 --> S5 --> S6 --> S7 ``` | Step | Commands | Description | | :--: | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | 1 | `aidc-cli license active -k ` | Activate AIDC-CLI features | | 2 | `aidc-cli init common-set`, `aidc-cli init inventory` | Configure project settings and render node inventory | | 3 | `aidc-cli bmc init-pwd`, `aidc-cli bios get-cfg` | Prepare BMC access and inspect BIOS configuration | | 4 | `aidc-cli deploy install` | Install the target operating system | | 5 | `aidc-cli network eth-cfg`, `aidc-cli driver nv-gpu -f ` | Configure networking and install required drivers | | 6 | `aidc-cli slurm setup-cluster`, `aidc-cli weka server deploy -I ` | Deploy platform services and storage | | 7 | `aidc-cli chknet pxe`, `aidc-cli chkhw summary`, `aidc-cli osinfo summary`, `aidc-cli sat validate --baseline ` | Validate the deployed environment and compare against approved baselines | *** ## 3. Command Overview | # | Command | CLI Name | Description | | :-: | -------------------------------------------------------------------------------- | ------------ | ---------------------------------------------------------------------------- | | 1 | [License Management](/guide/lateset/cli/commandreference/license.md) | `license` | Activate and inspect license information | | 2 | [Initialization](/guide/lateset/cli/commandreference/init.md) | `init` | Configure inventory, common settings, service defaults, and environment data | | 3 | [BMC Operations](/guide/lateset/cli/commandreference/bmc.md) | `bmc` | Perform BMC power, password, network, and reset operations | | 4 | [BIOS Operations](/guide/lateset/cli/commandreference/bios.md) | `bios` | Read, change, restore, and reset BIOS settings | | 5 | [OS Deployment](/guide/lateset/cli/commandreference/deploy.md) | `deploy` | Install OS images, manage DHCP helpers, and prepare access keys | | 6 | [Network Configuration](/guide/lateset/cli/commandreference/network.md) | `network` | Configure Ethernet, bonding, InfiniBand, NVOS, and DPU modes | | 7 | [Network Validation](/guide/lateset/cli/commandreference/networkvalidation.md) | `chknet` | Validate PXE, BMC, InfiniBand, and Ethernet connectivity | | 8 | [Hardware Sensor](/guide/lateset/cli/commandreference/hardwaresensor.md) | `hwsensor` | Monitor temperature, power, fan, and aggregated sensor data | | 9 | [Hardware Specification](/guide/lateset/cli/commandreference/hardwarespec.md) | `hwspec` | Collect structured hardware specifications | | 10 | [Hardware Inventory](/guide/lateset/cli/commandreference/hardwareinventory.md) | `hwinv` | Collect raw BMC Redfish hardware inventory data | | 11 | [Hardware Health](/guide/lateset/cli/commandreference/hardwarehealth.md) | `chkhw` | Run in-band hardware health checks | | 12 | [Firmware Validation](/guide/lateset/cli/commandreference/firmwarevalidation.md) | `chkfw` | Check firmware versions across supported components | | 13 | [Firmware Update](/guide/lateset/cli/commandreference/firmwareupdate.md) | `fwupdate` | Update BIOS, BMC, Mellanox, and NVMe firmware | | 14 | [Package Management](/guide/lateset/cli/commandreference/package.md) | `pkg` | Install or update selected packages and NVLink switch software | | 15 | [Driver Installation](/guide/lateset/cli/commandreference/driver.md) | `driver` | Install Mellanox OFED, DOCA, and NVIDIA GPU drivers | | 16 | [System Configuration](/guide/lateset/cli/commandreference/sysconfig.md) | `syscfg` | Apply system-wide configuration settings | | 17 | [Security Settings](/guide/lateset/cli/commandreference/security.md) | `security` | Manage firewall and SELinux configuration | | 18 | [Slurm Workload Manager](/guide/lateset/cli/commandreference/slurm.md) | `slurm` | Deploy and expand Slurm clusters | | 19 | [Database Management](/guide/lateset/cli/commandreference/database.md) | `database` | Deploy MariaDB Galera clusters | | 20 | [System Information](/guide/lateset/cli/commandreference/sysinfo.md) | `sysinfo` | Collect system information reports | | 21 | [OS Configuration Inventory](/guide/lateset/cli/commandreference/osinfo.md) | `osinfo` | Collect OS configuration inventory in brief or summary view | | 22 | [UFM Management](/guide/lateset/cli/commandreference/ufm.md) | `ufm` | Deploy UFM in standalone mode | | 23 | [Container Management](/guide/lateset/cli/commandreference/container.md) | `container` | Deploy Docker or Podman container runtimes | | 24 | [Kubernetes Cluster](/guide/lateset/cli/commandreference/kubernetes.md) | `kubernetes` | Deploy native Kubernetes clusters | | 25 | [NMX Management](/guide/lateset/cli/commandreference/nmx.md) | `nmx` | Deploy NMX-M virtual machines | | 26 | [WEKA Storage](/guide/lateset/cli/commandreference/weka.md) | `weka` | Deploy WEKA servers and clients | | 27 | [SAT Baselines and Validation](/guide/lateset/cli/commandreference/sat.md) | `sat` | Create SAT baselines and validate drift across selected domains | *** ## 4. Quick Start Examples ```bash # Show version aidc-cli -v # Activate a license aidc-cli license active -k "XXXX-XXXX-XXXX-XXXX" # Render inventory from CSV definitions aidc-cli init inventory # Power on specific nodes aidc-cli bmc power-on -l node01,node02 # Collect raw hardware inventory as JSON aidc-cli hwinv all --stdout # Run a normalized hardware health summary aidc-cli chkhw summary # Create a SAT baseline aidc-cli sat baseline create --name golden-v1 ``` *** ## 5. Prerequisites | Requirement | Description | | ------------- | ---------------------------------------------------------------- | | License | A valid AIDC license activated through `aidc-cli license active` | | OS | A supported management-node operating system | | SSH | Passwordless SSH access from the management node to target nodes | | Node Database | CSV inventory data populated for the target environment | | Network | Reachability to target nodes and BMC interfaces | | DHCP | DHCP configured when PXE-based OS deployment is required | *** ## 6. Related Resources * [Portal User Guide](/guide/lateset/portal.md) * [Portal Installation & Setup](/guide/lateset/portal/installation.md) * [Marketplace Overview](/guide/lateset/portal/overview.md) *** ## 7. Getting Help ```bash # Main help aidc-cli --help # Command help aidc-cli --help # Subcommand help aidc-cli --help ``` For shell completion setup, see [Installation & Setup](/guide/lateset/cli/installation.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://asus-isg-aidc.gitbook.io/guide/lateset/cli.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.