NPM Collector Zero-Touch Onboarding

Introduction

The OpsRamp Collector Bootstrap Tool enables Zero-Touch Onboarding of the NextGen Gateway. It simplifies the registration process by allowing you to provide predefined discovery configurations through a YAML file.

For an overview of the feature, see Zero-Touch Onboarding.

Step 1: Download the Bootstrap Tool

Download and install the OpsRamp Collector Bootstrap Tool by following Install Gateway Using OpsRamp Bootstrap Tool.
See Download the Collector Bootstrap Tool for the opsramp-collector-start binary.

Step 2: Prepare the discovery YAML file

Prepare the discovery configuration YAML file based on your environment requirements. The following example shows a sample discover.yaml file for NPM.

apiVersion: v2
discovery:
  # Step 1: SNMP classic discovery onboards the flow exporters.
  - classicApp:
      - app: SNMP
        config:
          credential:
            credentialType: "SNMP"
            name: "SNMP Credentials"
            description: "SNMP Device Credentials"
            transportType: "HTTP"
            timeoutMs: 15000
            spSecure: false
            port: 161
            snmpVersion: "V2"
            community: "<community_string>"
          discoveryProfile:
            name: "<Profile_Name>"
            schedule:
              patternType: "HOURLY"
              pattern: "1"
              startTime: "1:00:00"
            config:
              deviceType: "SNMP Network Device"
              networkDepth: "1"
              discoveryType: "Iprange"
              credentials:
                - "<SNMP_credential_set_uniqueId>"
              ipRange: "<Exporter_IP_or_Range>"
              snmpEnabledDevice: true
              policy:
                action: "MANAGE DEVICE"
            scheduleNone: false
  # Step 2: NPM Collector SDK app.
  - sdkApp:
      - app: npm-collector
        version: <latest_version>
        configs:
          - config:
              name: "<collector_config_name>"
              config:
                sflow_port: <sflow_port>
                netflowv5_port: <netflowv5_port>
                netflowv9_port: <netflowv9_port>
                ipfix_port: <ipfix_port>

Step 3: Register the Gateway and apply the YAML

Get the activation token by following Step 1: Get the activation token in the NPM Collector Setup Guide.

Use the Bootstrap Tool to register the Gateway with the OpsRamp cloud and specify the YAML configuration file using the --config flag. To perform SNMP discovery and NPM Collector installation in a single step, run the following command:

opsramp-collector-start install --environment k8s --url <OpsRamp_Server_URL> --key <Gateway_Authentication_Token> -t enable --config discover.yaml

Running this Zero-Touch YAML performs SNMP discovery (walk) and NPM Collector installation in a single step.

Step 4: Install the NPM Collector integration

Navigate to Setup > Account > Integrations.
On the Installed Integrations page, click + Add.
Search for NPM Collector and click Add.
In the Configuration tab, click Edit for the configuration name added in the YAML.
Whitelist the resources.

Note

Port whitelisting must be performed manually. The Zero-Touch YAML does not handle port whitelisting. Ensure that the configured sFlow/NetFlow ports are whitelisted on the Gateway before running discovery.

See Zero-Touch Onboarding documentation for more details.