> 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.3.0/guide/overview/service-catalog/nmx.md).

# NMX-M

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/01/30    |

## Service Introduction

**NMX-M** is a network monitoring management system deployed as virtual machines (VMs), providing comprehensive network monitoring, alerting, and reporting capabilities.

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

### Quick Summary

| Item                          | Details                                       |
| ----------------------------- | --------------------------------------------- |
| ⏱️ **Estimated Time**         | 30-60 minutes                                 |
| 💻 **Supported Platforms**    | Ubuntu 24.04 LTS (QEMU/KVM)                   |
| 🔧 **Minimum Nodes Required** | 1-3 physical nodes (hosting 3 VMs)            |
| 📦 **Included Components**    | NMX-M Master, NMX-M Workers, Monitoring Stack |

***

## Prerequisites

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

### Hardware Requirements (Physical Host)

| Resource               | Requirements                        |
| ---------------------- | ----------------------------------- |
| **Processor**          | 48 Cores (total across hosts)       |
| **Memory**             | 512 GB RAM (total across hosts)     |
| **Local disk storage** | 3TB NVMe storage (Enterprise grade) |
| **Hypervisor**         | QEMU/KVM with QCOW2 support         |

### Network Requirements

* ✅ All VMs must be reachable from each other
* ✅ Bridge interface configured on physical nodes
* ✅ Static IP addresses planned for all 3 VMs
* ✅ DNS server accessible

### Other Requirements

* ✅ Physical nodes have been provisioned and are in **Ready** state
* ✅ QCOW2 base image available at specified path
* ✅ Network bridges created on physical nodes

***

## Deployment Dialog Introduction

NMX-M deployment is divided into **4 steps**:

{% @mermaid/diagram content="flowchart LR
Step1\["Step 1: VM Network"]
Step2\["Step 2: Passwords"]
Step3\["Step 3: Node Mapping"]
Review\["Step 4: Review & Deploy"]

```
Step1 --> Step2
Step2 --> Step3
Step3 --> Review" %}
```

[Step 1: VM Network](#step-1-vm-network-configuration) | [Step 2: Passwords](#step-2-vm-password-configuration) | [Step 3: Node Mapping](#step-3-node-and-vm-mapping) | [Step 4: Review & Deploy](#step-4-review-and-deploy)

***

### Step 1: VM Network Configuration

👇NMX-M deploys **3 VMs** by default, each VM requires configuration:

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

| Parameter Name     | Type   | Description          |   Required  | Validation Rules              | Example                    |
| ------------------ | ------ | -------------------- | :---------: | ----------------------------- | -------------------------- |
| **Name**           | string | Virtual machine name | 🔴 Required | **Alphanumeric combination**  | `nmx-master-01`            |
| **IP Address**     | string | IP address           | 🔴 Required | **Valid IPv4 format**         | `192.168.1.100`            |
| **Mask**           | number | Subnet mask (CIDR)   | 🔴 Required | **Valid network mask (0-32)** | `24`                       |
| **Gateway**        | string | Gateway address      | 🔴 Required | **Valid IPv4 format**         | `192.168.1.1`              |
| **DNS**            | string | DNS server           | 🔴 Required | **Valid IPv4 format**         | `8.8.8.8`                  |
| **Role**           | string | VM role              | 🔴 Required | **master or worker**          | `master`                   |
| **QCOW Base Path** | string | QCOW image file path | 🔴 Required | **Valid file path on host**   | `/var/lib/libvirt/images/` |

{% hint style="warning" %}
**⚠️ Role Requirement**

At least one VM must have the **Master** role. The Master role is required for the NMX-M cluster to function properly.
{% endhint %}

{% hint style="info" %}
**💡 Common Field Feature**

To simplify filling, the system provides a "common" feature. After checking "common", the field value (Gateway, DNS, QCOW Base Path) will be automatically applied to all VMs.
{% endhint %}

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

***

### Step 2: VM Password Configuration

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

| Parameter Name  | Type   | Description                   |   Required  | Validation Rules        | Example           |
| --------------- | ------ | ----------------------------- | :---------: | ----------------------- | ----------------- |
| **VM Password** | string | Virtual machine root password | 🔴 Required | **Use strong password** | `VMRoot@2026!`    |
| **RO Password** | string | Read-only account password    | 🔴 Required | **Use strong password** | `ReadOnly@2026!`  |
| **RW Password** | string | Read-write account password   | 🔴 Required | **Use strong password** | `ReadWrite@2026!` |

{% hint style="warning" %}
**⚠️ Security Note**

Please save these passwords securely. They are required for accessing the VMs and NMX-M interface after deployment.
{% endhint %}

***

### Step 3: Node and VM Mapping

In this step, VMs need to be mapped to physical Nodes:

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

| Parameter Name | Type   | Description                     |   Required  | Validation Rules                | Example         |
| -------------- | ------ | ------------------------------- | :---------: | ------------------------------- | --------------- |
| **Node**       | string | Physical node selection         | 🔴 Required | **Must have libvirt installed** | `kvm-host-01`   |
| **VM**         | string | Corresponding VM (multi-select) | 🔴 Required | **Each VM mapped once**         | `nmx-master-01` |
| **Bridge**     | string | Network bridge name             | 🔴 Required | **Bridge must exist on node**   | `br0`           |

{% hint style="warning" %}
**⚠️ Mapping Rules**

* One Node can run multiple VMs, with a maximum of 3 Nodes
* Each VM can only be mapped to one Node
* Each VM must be paired with a Node
  {% endhint %}

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

#### Bridge Types

Ensure Bridge exists on the target Node before deployment

***

### Step 4: Review and Deploy

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

***

## Post-Deployment Status

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

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

### Deployment Verification

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

**1. Verify VMs are Running**

```bash
# On physical host
virsh list --all
```

✅ **Expected Result:** All 3 VMs show as `running`

**2. Check VM Connectivity**

```bash
ping <master_vm_ip>
ping <worker1_vm_ip>
ping <worker2_vm_ip>
```

✅ **Expected Result:** All VMs respond to ping

***

## Troubleshooting Checklist

| Check Item        | Command                     | Expected Result   |
| ----------------- | --------------------------- | ----------------- |
| libvirtd running? | `systemctl status libvirtd` | Active (running)  |
| Bridge exists?    | `brctl show`                | Bridge listed     |
| VMs running?      | `virsh list --all`          | All VMs running   |
| VMs reachable?    | `ping <vm_ip>`              | Response received |
| QCOW path exists? | `ls -la <qcow_path>`        | Path accessible   |
| Disk space?       | `df -h <qcow_path>`         | Sufficient space  |

***

## Frequently Asked Questions

### Q: Why deploy 3 VMs?

A: The majority of nodes must be operational for NMX-M to function. A three-node cluster can tolerate a one-node failure, but not a two-node failure.

### Q: What is QCOW Base Path?

A: The QCOW Base Path is the full file path on the target host that specifies both the directory and the QCOW2 file name of the NVIDIA NMX (NetQ) QCOW2 image to be used for deployment.

### Q: How to confirm if Bridge exists?

A: Run `brctl show` or `ip link show` on the target Node to confirm.

### Q: Can I deploy all VMs on a single physical node?

A: Yes, but for production environments, distributing VMs across multiple physical nodes is recommended for better fault tolerance.

***

## Related References

* [Service Catalog](/guide/v1.3.0/guide/overview/service-catalog.md)
* [Status Monitor User Guide](/guide/v1.3.0/guide/overview/status-monitor.md#nmx-m-status-card)


---

# 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/v1.3.0/guide/overview/service-catalog/nmx.md?ask=<question>&goal=<endgoal>
```

`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.