esi-snmp

esi-snmp offers basic snmp functionality. Reading snmp data from a source is possible via snmpget. - OIDs have to be specified manually via custom table. - The library relies on an external snmpget.exe application, for development net-snmp was used.

Changes

version date description

0.1.0

2019-05-15

Initial release

Dependencies

library version inmation core library

esi-string

1.0.3

yes

esi-io-objects-mass

0.1.3

yes

Documentation

RUN()

This method can be run in a Generic or Action item. The result will be a json document with the snmpget result. The following steps will execute:

  1. Read connection parameters

  2. Read tag configuration

  3. For each enabled tab, call snmpget

  4. Create holder items below parent of this object.

  5. Set holder item values

The following custom properties need to be created for the generic item:

Property Meaning

SNMP Address

IP address of the SNMP agent

SNMP User

set security name (e.g. bert)

SNMP Protocol

set authentication protocol (MD5

SNMP Password

set authentication protocol pass phrase

SNMP Version

specifies SNMP version to use (1

The custom table OIDs needs to be created, with the following columns

Column Meaning

name

the symbolic name that will be used as inmation tagname

oid

OID of the SNMP value to read (example: 1.3.6.1.4.1.24681.1.2.1.0)

enable

(true/false), if set to false the the object will not be requested

Usage:

local snmp = require 'esi-snmp'
return snmp:RUN()