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

# UFM Management

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

## Table of Contents

* [1. Overview](#overview)
* [2. Subcommands](#subcommands)
* [3. Deployment Overrides](#deployment-overrides)
* [4. Usage Examples](#usage-examples)
* [5. 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 ufm-set`](/guide/latest/cli/commandreference/init.md#management-service-configuration) — save the UFM configuration

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

The `ufm` command deploys NVIDIA Unified Fabric Manager (UFM) in standalone mode.

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

***

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

### 2.1 `deploy` — Deploy UFM

Deploys UFM by using the values stored in the current UFM configuration. You can override selected deployment values for a single run by using command-line flags.

```bash
aidc-cli ufm deploy [-n <interface>] [-p <licenses-path>]
```

| Flag              | Short | Required | Description                                            |
| ----------------- | :---: | :------: | ------------------------------------------------------ |
| `--interface`     |  `-n` |     ❌    | Override the UFM interface for this deployment run     |
| `--licenses-path` |  `-p` |     ❌    | Override the UFM licenses path for this deployment run |

***

## 3. Deployment Overrides <a href="#deployment-overrides" id="deployment-overrides"></a>

If an override flag is omitted, `aidc-cli ufm deploy` uses the value already stored in the UFM configuration.

| Setting           | Default Source               | Override Flag           |
| ----------------- | ---------------------------- | ----------------------- |
| UFM interface     | `init ufm-set` configuration | `--interface`, `-n`     |
| UFM licenses path | `init ufm-set` configuration | `--licenses-path`, `-p` |

{% hint style="info" %}
Use `aidc-cli init ufm-set` to define the default UFM deployment values, then use `aidc-cli ufm deploy` when you are ready to install UFM.
{% endhint %}

***

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

```bash
# Configure default UFM settings
aidc-cli init ufm-set -n ib0 -p /root/ufm_licenses

# Review the stored UFM configuration
aidc-cli init ufm-get

# Deploy UFM by using the stored configuration values
aidc-cli ufm deploy

# Override only the interface for a single deployment
aidc-cli ufm deploy -n ib1

# Override only the licenses path for a single deployment
aidc-cli ufm deploy -p /opt/ufm/licenses/

# Override both settings for a single deployment
aidc-cli ufm deploy -n ib0 -p /opt/ufm/licenses/
```

***

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

| Command          | Purpose                                            |
| ---------------- | -------------------------------------------------- |
| `init ufm-get`   | Review the current UFM configuration               |
| `init ufm-set`   | Set the default UFM deployment configuration       |
| `chknet ib`      | Validate InfiniBand connectivity before deployment |
| `network ib-cfg` | Configure InfiniBand interfaces                    |