SNMP Node Configuration Guide

The SNMP Node enables Rayven to receive data from external devices via the Simple Network Management Protocol (SNMP). It is commonly used for polling or receiving telemetry from networked devices such as routers, switches, industrial controllers

What It Does

This node queries SNMP-compatible devices using Object Identifiers (OIDs) and maps the returned values into structured JSON fields. It supports basic SNMP GET operations and can be configured to regularly poll devices for specific values.


How to Use

Prerequisites

  • Target device must support SNMP and have it enabled.

  • The Rayven platform or relay must be able to reach the SNMP device (typically via port 161).

  • You must know the Object IDs (OIDs) that you wish to query.

Rayven Workflow Implementation

  1. In the Workflow Builder, go to the Inputs panel.

  2. Drag the SNMP node to the canvas.

  3. Double-click the node to open the configuration.

  4. Define each OID and assign a corresponding output key.

  5. Configure payload format and optional filters.

  6. Save and activate the node.


⚙️ Configuration Fields

Field Requirement Description
Node Name* Required Name for this node. Appears in the workflow editor.
Payload Format* Required Format for the output data. Currently supports: JSON
Object ID* Required The SNMP OID to query from the target device. This identifies the specific parameter to retrieve.
Output JSON Key* Required Name for the JSON field where the OID's value will be stored.
Trigger Using Filter Optional Optionally filter execution by device or label.
Logical Operand Optional Choose how multiple filters are evaluated: AND or OR.
Select Data Source Filter Optional Choose device labels to limit this node’s execution scope.
 

You may configure multiple Object ID / Output Key pairs for a single SNMP node.


 Example

Query SNMP data for CPU and memory usage:

Field Value
Object ID (1) .1.3.6.1.4.1.2021.11.9.0
Output JSON Key cpu_user
Object ID (2) .1.3.6.1.4.1.2021.4.6.0
Output JSON Key memory_free
 

Output:

 
{
"cpu_user": "7",
"memory_free": "312832"
}

 Best Practices

  • Confirm SNMP is enabled and accessible on the target device.

  • Use standard tools (e.g., snmpwalk, snmpget) to test OIDs before adding them to the node.

  • Name JSON keys meaningfully for clarity downstream.

  • Combine with Data Summary or Rule Builder nodes for processing or alerting.

  • Avoid querying too frequently to prevent overloading the device or the network.


 Use Cases

  • Monitor network infrastructure (switches, routers, firewalls).

  • Retrieve health metrics from industrial PLCs or edge devices.

  • Poll UPS systems or environmental sensors (e.g., temperature, humidity).

  • Track device uptime or interface statistics.


 FAQ

Q: Can I use this node for SNMP traps?

No. This node is for SNMP polling (GET) only. For trap support, use a custom integration or request enhancement.

Q: Does this node support SNMP v2 or v3?

Current implementation is based on SNMP v2c. For SNMP v3 (secure SNMP), contact support for roadmap confirmation.

Q: Can I combine multiple OIDs in a single request?

Yes. You can configure multiple Object ID / Output Key pairs in one SNMP node.