SNMP integration

In BigPanda, create an Open Integration Manager integration.

Copy the app key from the integration page.

If the legacy BigPanda Agent is installed on the host and you no longer need it, remove it. From version 1.0.1, both can run on the same host.

On Debian-based hosts:

sudo apt remove bigpanda-agent

On RPM-based hosts:

sudo yum remove bigpanda-agent

Run the install script.

curl -fsSL https://bigpandaio.jfrog.io/artifactory/int-archive/bigpanda-forager/install.sh | sudo sh

The script also handles later upgrades and downgrades. On RPM-based hosts, you can install a pinned version with your package manager instead, for example sudo yum install bigpanda-forager-1.0.2-1.

Confirm the installed version.

bigpanda-forager --version

The output shows the version and a commit hash, for example bigpanda-forager 1.0.0 (cba6a8e).

Open /etc/bigpanda/forager/forager.yaml and add an snmp section.

snmp:
  listen: 0.0.0.0:162
  communities: ["<community_string>"]
  cloud_url: https://api.bigpanda.io
  cloud_token: <org_token>
  v3_users:
    - username: <v3_username>
      auth_protocol: SHA
      auth_passphrase: <auth_passphrase>
      priv_protocol: AES
      priv_passphrase: <priv_passphrase>

In the same file, point the collector at the rules file with a top-level rules_file key.

rules_file: /etc/bigpanda/forager/rules.yaml

Open /etc/bigpanda/forager/rules.yaml and add an snmp_rules entry with the integration app key.

snmp_rules:
  - app_key: <app_key>
    priority: 10

A rule with no match block applies to every trap.

Restart the On-Prem Event Collector.

sudo systemctl restart bigpanda-forager

Upload the MIB file as raw bytes.

curl -X POST "https://api.bigpanda.io/v1/mibs" \
  -H "Authorization: Bearer <user_api_key>" \
  -H 'Content-Type: application/octet-stream' \
  -H 'X-Filename: <mib_file_name>' \
  --data-binary @<mib_file_name>

The response returns 202 and a job ID.

Poll the job until state is succeeded or partial.

curl -s "https://api.bigpanda.io/v1/mibs/jobs/<job_id>" \
  -H "Authorization: Bearer <user_api_key>"

If missingModules lists any modules, upload those MIB files the same way.

Confirm the module compiled.

curl -s "https://api.bigpanda.io/v1/mibs" \
  -H "Authorization: Bearer <user_api_key>"

Find your module by originalFilename and check that compileState is compiled.

Draft configurations for every notification in the module. Send "persist": false first to preview the drafts without saving them.

curl -X POST "https://api.bigpanda.io/v1/trap-configs/scaffold" \
  -H "Authorization: Bearer <user_api_key>" \
  -H 'Content-Type: application/json' \
  -d '{"mib": "<module_name>"}'

Review each draft. Drafts marked needsReview contain inferred values.

Set app_key to your integration's app key on each configuration to keep.

Enable each configuration to keep.

curl -X PATCH "https://api.bigpanda.io/v1/trap-configs/<config_id>" \
  -H "Authorization: Bearer <user_api_key>" \
  -H 'Content-Type: application/json' \
  -d '{"enabled": true}'

BigPanda validates the whole configuration before it saves the change, so a draft with an invalid spec can't be enabled.

Point one device at the collector host on port 162, and trigger a configured trap.

Open the integration in BigPanda and confirm the alert appears.

In BigPanda, go to the Integrations tab and select the integration from the list.

At the top of the integration details, click the Active/Inactive toggle next to the integration name.

On the collector host, remove the snmp_rules entry with the integration's app key from /etc/bigpanda/forager/rules.yaml.

Restart the On-Prem Event Collector.

sudo systemctl restart bigpanda-forager

In BigPanda, go to the Integrations tab and select the integration from the list.

In the integration details, click the trash icon, then confirm that you want to delete the integration. The integration is removed immediately.