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

# NMX Management

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

## Table of Contents

* [1. Overview](#overview)
* [2. Subcommands](#subcommands)
* [3. Usage Examples](#usage-examples)
* [4. Related Commands](#related-commands)

***

## 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`
* SSH access to the nodes — [`aidc-cli deploy install`](/guide/latest/cli/commandreference/deploy.md) sets this up during OS deployment; for nodes that already have an OS, run [`aidc-cli deploy access-key`](/guide/latest/cli/commandreference/deploy.md) or fill the `password` column in `aidc.csv`
* [`aidc-cli init nmx-set`](/guide/latest/cli/commandreference/init.md#management-service-configuration) — save the NMX VM configuration

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

The `nmx` command deploys NVIDIA NMX-M (Network Management Experience) for advanced network infrastructure management and monitoring.

This module is the **execution layer** for NMX deployment. VM definitions, host OS mappings, and other topology settings are prepared earlier with `aidc-cli init nmx-set`.

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

***

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

### 2.1 `deploy` — Deploy NMX-M

Deploys the NMX-M management platform with required password configurations.

```bash
aidc-cli nmx deploy -W <rw-password> -E <ro-password> -V <vm-password> [-S]
```

| Flag                | Short | Required | Description                        |
| ------------------- | :---: | :------: | ---------------------------------- |
| `--rw-password`     |  `-W` |     ✅    | Read-write user password (Kong RW) |
| `--ro-password`     |  `-E` |     ✅    | Read-only user password (Kong RO)  |
| `--vm-password`     |  `-V` |     ✅    | Virtual machine password           |
| `--skip-pre-checks` |  `-S` |     ❌    | Skip pre-deployment checks         |

{% hint style="warning" %}
All three password flags are **required**. The deployment will fail if any is missing.
{% endhint %}

{% hint style="info" %}
`aidc-cli nmx deploy` does not replace `aidc-cli init nmx-set`. The normal workflow is to define the NMX VM layout first with `init nmx-set`, then run `nmx deploy` with the required runtime passwords.
{% endhint %}

***

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

```bash
# Configure and deploy NMX-M
aidc-cli init nmx-set
aidc-cli nmx deploy -V "!QAZ1qaz@nmx" -E "nmx123456" -W "nmx123456"

# Deploy with skip pre-checks
aidc-cli nmx deploy -W "rw-pass" -E "ro-pass" -V "vm-pass" -S
```

{% hint style="info" %}
Refer to the "NMX" section in the `init` documentation and ensure the system meets the specifications defined in init before execution.
{% endhint %}

***

## Related Commands <a href="#related-commands" id="related-commands"></a>

| Command                  | Purpose                          |
| ------------------------ | -------------------------------- |
| `init nmx-get/set/reset` | View/set/reset NMX configuration |