/
SNMP Connector

SNMP Connector

Owned by Giovanni Casagrande
Last updated: Apr 07, 2025 by Ricky Villa

Connector overview

The SNMP connector cannot be used on devices where the file system is not accessible to load MIB files (F200, NeXio)

The SNMP Connector enables seamless integration with SNMP-enabled network devices. Key capabilities include:

  • Support for SNMP v2c and v3 (v1 is not supported)

  • Authentication via community strings or user-based security model

  • Bidirectional communication for monitoring and control

Agent Connectivity

To access a remote SNMP agent, the connector uses the snmp URI scheme. It supports both UDP and TCP/IP connectivity, with TCP/IP being the default. The snmpProtocol tag can be used to change the transport protocol.

Security

The connector supports two modes of security:

  1. Community-based authentication (SNMPv2c)

  2. User-based Security Model (USM) for SNMPv3

Management Information Base (MIB)

The connector can load MIB module definitions from disk into a MIB database. The snmpMibsUri tag specifies the directory to search for MIB files. The MIB is used to map SNMP object identifiers (OIDs) to their corresponding types.

Current Points

SNMP proxy points are configured using the snmpCur tag, which maps to the OID for the point in the MIB.

Writable Points

SNMP proxy points can be configured to write to remote agent points using the snmpWrite tag, with the MIB providing the necessary type information.

History

History synchronization is not supported by SNMP. You will need to use history collection to store history.

How to use SNMP

To configure the SNMP connector, follow the below steps.

  • Enable the SNMP extension.

  • Get MIB files from the hardware vendor, access your device filesystem and paste them in any subfolder of your project; the default path would be:
    \FIN Framework 5.1.7.89\var\proj\projectName\data\mibs\default

  • Restart the service, from the App menu go to DB Builder > Connectors > Snmp

  • Select “Add” to get to the configuration menu; please note UI is partially broken, so some fields will require a further manual edit.

image-20250406-084132.png

Tag

Accepted values

Notes

Tag

Accepted values

Notes

dis

 

String type, connector name

snmpSecurityLevel

authPriv
authNoPriv
noAuthNoPriv

authPriv: Indicates both user authentication and privacy (encryption) for the mesages.
authNoPriv: Indicates user authentication but no privacy for the messages.
noAuthNoPriv: Indicates no user authentication or privacy for the messages.

Only needed if snmpVersion: 3

snmpCommunity

 

String type, only needed if snmpVersion: 2

snmpVersion

2c
3

2c: SNMPv2C - Community-based authentication
3: SNMPv3 - User-based security model (USM)

uri

snmp://agent.com:161

Port can be omitted, default is 161

snmpAuthProtocol

MD5
SHA

Only needed if snmpVersion: 3 and snmpSecurityLevel: authPriv or authNoPriv

snmpMibsUri

data/mibs/default/

Can be any folder under the project folder

snmpProtocol

tcp
udp

If not set, default is tcp

snmpPrivProtocol

DES
AES

Only needed if snmpVersion: 3 and snmpSecurityLevel: authPriv

  • Once created, click on the Property editor (the “i” icon under the Essentials header) to fix any tag, remove unneeded ones, or add more (i.e. username and password)

  • Ping the connector to ensure its status changes to “connected”

  • In the left menu, expand the Snmp connector, expand once again the newly created connector, click on “Discover” to see all available points according to the MIB file(s) you provided

  • Drag and drop the points to any equip, or make the equip the current context and click on “Add”

Configuration examples

  • SNMPv2c - Community string authentication

    • snmpCommunity: SNMP community name

  • SNMPv3 - no authentication, no privacy/encryption

    • snmpSecurityLevel: noAuthNoPriv

  • SNMPv3 - authentication, no privacy/encryption

    • snmpSecurityLevel: authNoPriv

    • snmpAuthProtocol: Authentication protocol (MD5/SHA)

    • username: Username for authentication

    • password: Password for authentication

  • SNMPv3 - authentication and privacy/encryption

    • snmpSecurityLevel: authPriv

    • snmpAuthProtocol: Authentication protocol (MD5/SHA)

    • snmpPrivProtocol: Privacy protocol (DES/AES)

    • username: Username for authentication and privacy

    • password: Password for authentication and privacy. If you have different passwords for auth and priv, set the password field to <auth-password><space><priv-password>

Error messages

List of all supported tags

Tag

Description

Tag

Description

actorTimeout

Timeout for messages send to the connector's actor thread

connErr

Error message associated when connStatus indicates an error condition

connLinger

Linger timeout used to keep a connector open

connOpenRetryFreq

Duration used for connector open retries

connPingFreq

Duration used to configure the auto-ping feature on a given connector

connState

Current connection state of a connector as one of the predefined strings

connStatus

Current status of a connector as one of the predefined strings

connTuningRef

Reference to a tuning configuration defined by a connTuning rec

dis

Display name for an entity

disabled

Indicates the entity is in a disabled state

id

Defines the unique identifier of an entity in system using a ref value type

password

Manages password which is hashed/stored to the password store

snmpAuthProtocol

If the snmpSecurityLevel indicates that authentication is required, then this is the digest algorithm to use

snmpCommunity

If the snmpVersion is 2c, then this is the name of the SNMP community to use when messaging with the remote agent

snmpMibsUri

Applied to snmpConn to define the collection of MIB files to load

snmpPrivProtocol

If the snmpSecurityLevel indicates that message privacy is required, then this is the encryption algorithm to use

snmpProtocol

Applied to snmpConn to indicate the network protocol to use for communicating with a remote agent

snmpSecurityLevel

If the snmpVersion is 3, then this is the security level to use for messaging with the remote agent

snmpVersion

Applied to snmpConn to indicate the SNMP protocol version to use for messaging with the remote agent

uri

Universal resource identifier

username

Username for an authentication account