Introduction
This guide describes the steps to set up the NPM Collector using an OpsRamp ISO/OVA-based deployment.
Prerequisites
Before you begin, ensure that the following requirements are met:
- A virtual machine (VM) deployed using the OpsRamp ISO or OVA image.
- SSH access to the VM.
- Network connectivity from the VM to the OpsRamp cloud.
- An OpsRamp tenant account with administrative access.
Note
The opsramp-collector-start binary is pre-installed on ISO/OVA images. No separate download is required.Step 1: Get the activation token
- Log in to the OpsRamp portal.
- Navigate to Setup > Account > Collector Profiles.
- Click + Add.
- Enter a profile name.
- Copy the activation token displayed on the page.
Step 2: Install and register the gateway
- SSH into the VM.
- Run the following command:
sudo opsramp-collector-start install \
-u url.net \
-k <YOUR_ACTIVATION_TOKEN> \
-R us-central1-docker.pkg.dev \
-V 21.0.0 \
-t enable
| Flag | Description |
|---|
| `-u` | OpsRamp portal URL. |
| `-k` | Activation token obtained in Step 1. |
| `-R` | Docker registry used to pull images. |
| `-V` | Helm chart or gateway version. |
| `-t enable` | Enables third-party integrations (required for NPM). |
- Wait for 3 to 5 minutes for all pods to initialize.
Step 3: Verify gateway status
- On the VM, run:
sudo k3s kubectl get pods
- Verify that the following pods are in the Running state:
| Pod | Ready | Status |
|---|
| `nextgen-gw-0` | 3/3 | Running |
| `nextgen-gw-redis-master-0` | 1/1 | Running |
- In the portal, navigate to Setup > Account > Collector Profiles.
- Confirm that the gateway status is displayed as CONNECTED.
Step 4: Install NPM Collector integration
- In the portal, navigate to Setup > Account > Integrations.
- Click + Add on the Installed Integrations page.
- Search for NPM Collector and click Add.
- In the Configuration tab, click + Add.
- Provide the configuration details:
| Field | Value |
|---|
| Name | For example, `config-1`. |
| SFlow Port | 6343 |
| Netflow-v5 Port | 9996 |
| Netflow-v9 Port | 4729 |
| IPFIX Port | 4739 |
| Resources | Select network devices. |
- Click Add to save the configuration.
- Click Next to proceed to the Installation tab.
- Select the gateway with status CONNECTED.
- Click Finish.
Step 5: Verify NPM Collector deployment
- On the VM, run:
sudo k3s kubectl get pods | grep npm
- Verify that the
npm-collector-* pod is in the Running state with 2/2 containers ready.