SNMP – Gateway Version 4
The following are step-by-step instructions for implementing SNMP using the Ethernet Gateway Version 4 (EG4). These instructions are intended for SNMP versions 1 and 2. The Version 4 Gateway does support version 3 SNMP. For details on version 3 implementation please contact [email protected].
Required Files and Tools
MIB Files: MIB files can be downloaded directly on the Gateway or from the links below
General MIB File (click to download)
MIB file for use with VIPs (Virtual IP addressing) (click to download)
iReasoning Browser: iREasoning MIB Browser is a utility that allows you to view MIB files.
Data Output from SNMP Gateways
Packet Power Gateways collect data from Packet Power wireless monitoring nodes and aggregate the data for transmission by SNMP, Modbus TCP/IP and directly to the Packet Power EMX monitoring portal. Note that the Gateway can support transmission of data via either SNMP or Modbus TCP/IP while simultaneously serving data to the EMX portal.
Requirements
- Download iREasoning MIB Browser (http://www.ireasoning.com/download.shtml)
- The Gateway is configured and communicating with the wireless nodes
- The Gateway has a license for SNMP
Accessing the Gateway Console
Make sure your Gateway is configured with an IP address and accessible on your network. The Gateway must be connected to a switch /router on an accessible network.
It may not be accessible directly through a PC Ethernet to Gateway connection. For Gateway network configuration instructions follow this link.
(1) Enter the IP address of the Gateway on any browser to access the Gateway Console
(2) Make sure SNMP is listed as a licensed feature. If not see the licensing section on how to add a license
(3) Make sure that the system is communicating properly with the monitoring nodes as indicated by a green status light
(4) Click the link under Wireless Mesh to see monitoring nodes that are currently communicating with the Gateway
(5) SNMP Data will be able to be viewed through the SNMP data link; this light will be green once the SNMP agent is enabled
HELPFUL LINKS:
Configuring Gateway network settings
Accessing the MIB files from Gateway Console
MIB files can be downloaded directly from the Gateway Console. There are two MIB files. The standard EG4 file is for use in standard SNMP applications. The VIP MIB file is used when using Virtual IP addresses for each monitoring node instead of the standard 16 digit GUID embedded in the OID.
If the link is not available on the console this may require that the Gateway firmware be upgraded to version 1.12 or higher.
DOWNLOADING THE STANDARD MIB FILE
On the Gateway console go to Data Destinations>SNMP on the left menu and then click on the standard MIB file.
DOWNLOADING THE MIB FILE FOR USE WITH VIRTUAL IP ADDRESSING
On the Gateway console go to Data Destinations>SNMP>Nodes on the left menu and then click to download the MIB file.
Accessing active OIDs
It is possible to download a CSV file that contains only the active data points being received by the Gateway in an SNMP compatible format.. This will vary as nodes are added and removed from the system. A CSV file of OIDs corresponding to the data points currently being received by the gateway. OID lists are used with systems utilizing explicit “tag lists” of monitoring points (e.g. KEPServer) or whenever you need SNMP access to a specific set of readings. To access the file go to the [Data Destinations] tab on the left menu and select [SNMP]. On the main screen select the button [Export OID List CSV]. This will download the OID
Viewing monitoring node readings on the Gateway Console
(1) Confirm that monitoring nodes are active and returning data to the Gateway by selecting the “Monitoring Data” tab; this will display all connected nodes
(2) Click on the “readings” icon to expose the real time readings for a specific monitoring node
Uploading an SNMP license to the Gateway
(1) To activate a product license, select the license file by clicking on the “choose file” button under “Select License File” in the “System” menu
(2) Click on the “Upload” button and point to the location of the license provided by Packet Power
A reboot of the device will be required to make the license effective. The reboot tab can be found under the “System” menu.
In the event that SNMP is not a licensed feature you will need to obtain a license from Packet Power [email protected].
Enabling and configuring the SNMP Agent
(1) Click on the SNMP tab under the Data Destinations tab
(2) Make sure SNMP is enabled in the check box
(3) Select the correct SNMP version. This guide is for SNMP V1 and V2; for SNMP V3 implementation see the SNMP 3 guide
(4) Set the Agent port to 161 or as needed
(5) The Community read string (used for authentication) should be “public”
(6) Click “Save” to save settings
(7) The SNMP status light in the left menu will be green indicating the onboard SNMP agent is active
Using the iReasoning MIB browser
Loading general MIB files on to the iReasoning browser
(1) Load the MIB for “General SNMP management” using the [Load MIBs] function under the [FILE] menu
(2) This is the “SNMPv2-MIB” file if using SNMP V2. For older SNMP versions use the appropriate MIB file supplied in the MIB directory.
This file will automatically be supplied with iReasoning in the “mibs” directory.
Loading Gateway and node MIB files on to the iReasoning browser
(1) Load the MIB for Gateway and monitoring nodes using the [Load MIBs] function under the [FILE] menu
(2) PACKETPOWER-EG4-MIB is for the Gateway and PACKETPOWER-NODE-MIB is for the monitoring nodes
Accessing MIB files on the iReasoning Browser
The SNMP management MIB can be found under the “mgmt.” file of the MIB tree
The Gateway MIB file can be found under the “eg4” directory under the “private” directory
The monitoring nodes MIB file can be found under the “monitoringNode” directory under the “private” directory
Accessing the Gateway using the iReasoning browser
(1) Enter the IP address of the Gateway in the address bar
(2) Click on the “Advanced” tab
(3) Make sure SNMP is configured for the same read community string (public)
(4) Confirm port is correct (161)
(5) Confirm that the SNMP version matches the settings used on the Gateway Console SNMP settings (i.e. SNMP version)
Leave “Write Community” blank
Confirming communication with the Gateway
(1) Click “Walk” on the Operations bar and then click “Go”; a table will be generated returning all MIBs
Note that Windows firewall may have to be turned “off” for proper communications
(2) Node “GUIDs” will be displayed in the table; these node IDs will correspond to the Node IDs on the Gateway Console
To see the data in a more structured format use “Table View”
Generating readings tables and nodes tables (Table View)
(1) (2) To get data in a more structured format select the “readingsTable” or “nodesTable” under the EG4 directory [private>packetPower]
(3) Right click and select “Table View”
(4) The table will appear in the right window
Node Tables / Node Map
(1) After performing a “TableView” on “Nodes Table” by selecting the “nodesTable” file, right click and select table view, it will reveal a listing of all nodes associated with the Gateway
(2) Node “GUIDs” will be displayed in the table
(3) These node IDs will correspond to the Node IDs on the Gateway Console accessed by selecting Data Destinations > SNMP > Nodes
Readings Table / Readings for all Nodes
(1) Performing a “TableView” on “Readings Table” by selecting the “readingsTable” file, right click and select [Table View] from the pop up menu, it will reveal a listing of all readings for all nodes associated with the Gateway
(2) Node IDs will correspond to the node readings on the Gateway Console accessed by selecting the Monitoring Data menu and highlighting the corresponding node
(3) Values from the Gateway Console will match those on the Readings Table
All readings share a common table until a virtual IP address can be defined per node allowing nodes to be segregated by IP address
Interpreting Readings Data from Table View
(1) The 16 digit node ID (GUID) that identifies each Packet Power device (node) is encoded within the OID
Clicking on a reading will allow you to associate it with a specific node ID via the OID
Any reading OID will always correspond to a specific channel for specific node (ie. energy on phase A for a particular node)
Virtual IP addressing / Assigning Virtual IPs to monitoring nodes
Monitoring nodes and the Gateway will show up under a single IP address. Many monitoring systems using SNMP require that each device / node have a unique IP address.
It is possible to assign a Virtual IP address to each monitoring node using the Gateway Console. This will segregate the nodes so they can be revealed individually.Assigning Virtual IPs to monitoring nodes
To apply a Virtual IP address to a specific node open the Gateway Console and select “SNMP” under the “Data Destinations” menu, then select the “Nodes” menu. This will expose all of the nodes for the Gateway
(1) Click on the “+” icon to reveal the Virtual IP addressing pop-up
(2) Select the Node to be addressed using the drop down “Node” menu (nodes are identified by their 16 digit GUID)
Enter a virtual IP address; this must be valid within the network its being used on
Click “Add” to save
Repeat for all nodes.
Viewing nodes by Virtual IP address on Gateway Console
(1) Each node will now have a VIP (virtual IP) as well as 16 digit GUID
(2) These can be found on the “Monitoring Data” tab of the Gateway Console or the “Node” tab under the “SNMP” tab in the “Data Destinations” menu
IPs will become visible at the same port as the Ethernet Gateway
The Gateway will have a unique IP and agent and each node will have a unique IP and agent
Viewing nodes by Virtual IP address on iReasoning Browser
(1) Enter VIP in the address tab
(2) Go to “SysDescr” file in the MIB tree (under the mgmt.>mib-2>system folders) and right click for a “Get”
(3) The monitoring node’s ID will be returned on the table to the right
(4) This corresponds with the VIP and GUID in the Gateway Console for the specific node
(1) and (2) Note that after a new IP address is entered it may be necessary to click on the “Advanced” tab and re-enter the properties of the SNMP agent for each unique IP address.
THIS IS ONLY WHEN USING the iReasoning browser tool to view different IP addresses.
Viewing node Readings by Virtual IP address on iReasoning Browser
(1) Using the same VIP for the particular node in the IP Address bar, highlight the “mnReadings” Table MIB under “monitoringNode” file.
Right click and select “Table View”; this will expose the readings table for the specific monitoring node in the table view
(2) These readings correspond to those on the Gateway Console; access the “Monitoring Data” menu and select the same node
Readings Definitions
mnChannel ID: Identical for all like monitoring devices
mnChannel Name: Describes the function of the channel, i.e., Energy for phase A
mnValue: Measurement value for the channel
mnUnits: Units of measurement, i.e., Watt hours
mnTime Stamp: Time when the value was received
mnTime Stamp: Time when the value was received in hex
mnIndex Value:
Turning Windows Firewall “off”
Windows Firewall will block the iReasoning MIB browser from accessing other IP addresses such as virtual IP addresses.
To disable the Firewall (Windows 10) select control panel > all control panel items > windows firewall and turn the firewall off for both public and private networks.
This does not have to be permanent – only during polling on this computer using iReasoning.