> 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/portal/overview/service-catalog/ufm.md).

# UFM Standalone

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/08/21    |

## Service Introduction

> **UFM (Unified Fabric Manager)** is NVIDIA's InfiniBand network management solution, providing network topology discovery, monitoring, troubleshooting, and management capabilities.
>
> UFM Features
>
> * **Topology Discovery**: Automatically discovers InfiniBand network devices
> * **Performance Monitoring**: Real-time monitoring of network traffic and latency
> * **Fault Diagnosis**: Quickly locates network issues
> * **Configuration Management**: Centralized switch configuration management

![](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/marketplace/service-catalog-ufm.png)

### Quick Summary

| Item                          | Details                                   |
| ----------------------------- | ----------------------------------------- |
| ⏱️ **Estimated Time**         | 10-20 minutes                             |
| 💻 **Supported Platforms**    | See the **Supported Platforms Matrix**    |
| 🔧 **Minimum Nodes Required** | 1 node (with InfiniBand HCA)              |
| 📦 **Included Components**    | UFM Server, UFM Web UI, IBDIAGNET, opensm |

***

## Prerequisites

Before starting the deployment, ensure the following requirements are met:

### Hardware Requirements

| Item        | Minimum Spec   | Recommended Spec         |
| ----------- | -------------- | ------------------------ |
| **CPU**     | 4 cores        | 8 cores                  |
| **Memory**  | 16 GB          | 32 GB                    |
| **Storage** | 100 GB         | 500 GB                   |
| **Network** | InfiniBand HCA | InfiniBand HCA (HDR/NDR) |

### Network Requirements

* ✅ InfiniBand HCA installed and functional
* ✅ InfiniBand subnet manager (OpenSM) accessible
* ✅ Required ports: `443` (Web UI), `8088` (REST API)

### Other Requirements

* ✅ Node has been provisioned and is in **Ready** state
* ✅ Valid UFM license file (`.lic`) ready
* ✅ InfiniBand drivers (MLNX\_OFED) installed

***

## Deployment Dialog Introduction

UFM Standalone deployment is divided into **2 steps**:

```mermaid
flowchart LR
    Step1["Step 1: Node & License Configuration"]
    Review["Step 2: Review and Deploy"]

    Step1 --> Review
```

[Step 1: Node & License Configuration](#step-1-node-selection-and-license-configuration) | [Step 2: Review and Deploy](#step-2-review-and-deploy)

***

### Step 1: Node Selection and License Configuration

![](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/marketplace/service-catalog-ufm-step1.png)

| Parameter Name        | Type   | Description                       |   Required  | Validation Rules               | Example              |
| --------------------- | ------ | --------------------------------- | :---------: | ------------------------------ | -------------------- |
| **License Path**      | file   | UFM license file path             | 🔴 Required | **Valid .lic file**            | `ufm_enterprise.lic` |
| **Network Interface** | string | InfiniBand network interface name | 🔴 Required | **Must be valid IB interface** | `ib0`                |
| **Node**              | string | Target node for UFM installation  | 🔴 Required | **Node with InfiniBand HCA**   | `ufm-server`         |

{% hint style="info" %}
**💡 How to find InfiniBand interface name**

Run `ibstat` or `ip link show` on the target node to list available InfiniBand interfaces. Common names are `ib0`, `ib1`, etc.
{% endhint %}

***

#### License Configuration

The license file must be copied to the AIDC VM file system at the configured license path.

**Install License**

1. Prepare the .lic license file.
2. Copy the license file to the AIDC VM file system at the configured license path.
3. Ensure the file name and permissions match the expected configuration.

{% hint style="warning" %}
**⚠️ License Validation**

Ensure the license file is valid and not expired. An invalid license will prevent deployment from completing successfully.
{% endhint %}

***

### Step 2: Review and Deploy

![](https://pub-f334ff01208c4e6195b80133ac6e6030.r2.dev/portal/marketplace/service-catalog-ufm-step2.png)

***

## Post-Deployment Status

After successful deployment, you can view in **Status Monitor**:

* Task status progress
* Execution status of each node
* Error logs (if any)

### Deployment Verification

After the deployment status shows **Completed**, perform the following checks:

**1. Access UFM Web UI**

```
https://<node_ip>:443
```

✅ **Expected Result:** UFM login page displayed

**2. Check UFM Service Status**

```bash
systemctl status ufm-enterprise
```

✅ **Expected Result:** Active (running)

**3. Verify Topology Discovery**

* Log in to Web UI with default credentials (check deployment logs)
* Navigate to **Topology** tab
* Verify InfiniBand switches and hosts are discovered

**4. Check InfiniBand Fabric Health**

```bash
ibstat
ibdiagnet
```

✅ **Expected Result:** No errors reported

***

### Initial Configuration

1. Log in to Web UI using default credentials
2. Complete the initial setup wizard
3. Configure email notifications (optional)
4. Start discovering network topology

***

{% hint style="info" %}
**💡 Tip**

If you encounter persistent errors, collect the following logs before contacting support:

* `/opt/ufm/files/log/ufm.log`
* `/var/log/opensm.log`
* `ibdiagnet` output
  {% endhint %}

***

## Troubleshooting Checklist

| Check Item              | Command                           | Expected Result        |
| ----------------------- | --------------------------------- | ---------------------- |
| UFM daemon running?     | `systemctl status ufm-enterprise` | Active (running)       |
| InfiniBand HCA present? | `lspci \| grep Mellanox`          | Device listed          |
| IB interface up?        | `ibstat`                          | State: Active          |
| Port 443 accessible?    | `curl -k https://localhost:443`   | Response received      |
| License valid?          | Check Web UI > Settings > License | License info displayed |
| Fabric discovered?      | Web UI > Topology                 | Devices listed         |

***

## Frequently Asked Questions

### Q: Can I deploy without a License?

A: The deployment requires a license file. You can use an Evaluation license for testing purposes, which provides full features for a limited time.

### Q: How to update the License?

A: Log in to UFM Web UI and upload a new license file on the **Settings > License** page.

### Q: Which InfiniBand versions are supported?

A: Supports mainstream specifications including FDR (56 Gbps), EDR (100 Gbps), HDR (200 Gbps), and NDR (400 Gbps).

### Q: How to add more nodes to UFM monitoring?

A: Once UFM is running, it will automatically discover all InfiniBand devices in the fabric. No manual configuration needed.

### Q: What if topology discovery shows no devices?

A: Verify InfiniBand fabric connectivity, ensure OpenSM is running, and check that all switches are powered on.

***

## Related References

* [Service Catalog](/guide/latest/portal/overview/service-catalog.md)
* [Status Monitor User Guide](/guide/latest/portal/overview/status-monitor.md#ufm-status-card)
* [NVIDIA UFM Official Documentation](https://docs.nvidia.com/networking/display/UFMEnterpriseUM)