SmartConnector SNMP Extension

SmartConnector SNMP Extension

User’s Manual

Installation and operation instructions. Version 1.1.2


1

SmartConnector SNMP Extension User’s Manual

Overview ........................................................................................................................................................... 2

Installation ......................................................................................................................................................... 3

SmartConnector.SnmpExtension Installation ............................................................................................. 3

SmartConnector.SnmpConfigurator operating .............................................................................................. 9

Main Window ............................................................................................................................................... 9

Manage list of Agents ............................................................................................................................. 13

SNMP Agent Configuration ................................................................................................................... 14

SNMP Agent requests ............................................................................................................................. 18

Saving Configuration File ....................................................................................................................... 21

SmartConnector.SnmpExtension deployment and configuration .............................................................. 22

SmartConnector portal. Initial Configuration .......................................................................................... 22

SmartConnector portal. Run Extension ..................................................................................................... 25

Acquiring data in SBO from EWS server ...................................................................................................... 27

Logging ............................................................................................................................................................ 31

Licensing ......................................................................................................................................................... 32

Software Requirements .................................................................................................................................. 33

Appendix 2. Troubleshooting ........................................................................................................................ 34

EWS Server is not started ........................................................................................................................... 34

Contacts ........................................................................................................................................................... 36


Overview 2

Overview

“SmartConnector.SnmpExtension” is middleware, that can be plugged into “Schneider-Electric

SmartConnector Framework” as an extension. “SNMP Extension” allows communicating between

SNMP agent and EWS server corresponding to user provided configuration. EWS server generate EBO

alarms when TRAP-messages received. This extension supports following versions of SNMP protocol: v1, v2

и v3.

The middleware “SmartConnector.SnmpExtension” includes “SNMP Manager Configurator” module,

which allows creating some configuration of “SNMP Manager” in order to receive required OID’s and

TRAP-messages. The main functionality of “SNMP Manager Configurator” is:

Discovering of SNMP agents in the LAN or manually adding it to created configuration;

SNMP v3 security settings provided;

Allowing SNMP v3 engine configuration;

Allow to users to choose required MIB entities for sending it to EWS server (objects, tables, TRAPS

etc.)

Vendors MIBs parsing;


Installation 3

Installation

SmartConnector OPC Classical Extension requires the .NET framework version

4.6.2. Required SmartConnector framework version provided in additional setup

information.

SmartConnector.SnmpExtension Installation

1. Run the “setup.exe” installer executable and confirm that you must run as an Administrator. You

will be presented with dialog in fig. 1.

Figure 1. Installer welcome dialog.

2. Click on button “Next”.


Installation 4

Figure 2. EULA.

3. Please read carefully end user license agreement and select “I Agree” item (fig. 2.1). Then press

“Next” button.


Installation 5

Figure 3. Installer note.

4. Installer notes (fig. 3), that SmartConnector framework must be installed first and that target

directory for extension will be SmartConnector framework installation directory. Press “Next”

button.

Installer notes (fig. 3), that SmartConnector framework must be installed first and

that target directory for extension will be SmartConnector framework installation

directory. In case of incorrect installing, please reinstall extension to correct path.


Installation 6

Figure 4. Select installation folder dialog.

5. Select the installation folder of SmartConnector framework.


Installation 7

Figure 5. Confirm installation dialog.

6. Confirm installation by clicking on “Next” button.


Installation 8

Figure 6. Installation complete dialog.

7. Finish the installation by clicking on “Close” button in installation complete dialog (fig. 6).


SmartConnector.SnmpConfigurator operating 9

SmartConnector.SnmpConfigurator operating

Main Window

After installation, you can run “SmartConnector.SnmpConfigurator” from “Windows Start Menu” -

folder “Comfortlab”, then click on “SmartConnector.SnmpConfigurator” shortcut (fig. 7).

Figure 7. Shortcut for SNMP configurator.

The goal of “SnmpConfigurator” application is creating configuration files, which contains a list of

required OIDs, IIDs, and Traps definitions. Values of this items will be forwarded to EWS server by

“SmartConnector” framework. One configuration file is created for one SNMP manager.



Figure 8. SnmpConfigurator main window.

On the top of window (fig. 8.1) you can configure SNMP v3 Authoritative engine , Trap users set

and specify SNMP manager local endpoint .

SNMP v3 Authoritative engine configuration allow to set manager Engine Id and specify users to

authenticate and decrypt received SNMP version 3 packets (fig. 9).



Figure 9. SNMP v3 Authoritative engine configuration.

You can add user by context menu of users table.

If you want to receive and decode SNMP v3 Trap, you need to configure trap users list (fig. 10). To

decode SNMPv3 traps for the User received from any agent, leave user Engine ID empty. To decode

SNMPv3 traps for the user received from specific Agent (more secure), populate User Engine Id with

the sending Agent’s Engine Id.

Figure 10. Trap Users.



SNMP manager local IP endpoint allow to specify required network interface and port, which listening

on trap and inform messages (fig. 11).

Figure 11. Local IP Endpoint.

Communication log allows the user to obtain full information about SNMP communication between

manager and agents (fig. 8.8). Request and response messages are shown in the log monitor. When

communication failed or response contains some error, a user can inspect this information by detailed

message window (fig. 12).

Figure 12. Logging.



Button for enabling notification monitor starts notification catcher (fig. 8.2). All received traps and

inform messages displays on log monitor.

Buttons on fig. 8.3 allow to create new, save current or open saved configuration.

List of configured Agents for communication presented on fig. 8.4 and 13. After clicking on Agent item,

configurator shows basic SNMP information on form right side: sysDescr, sysObjectId, sysContact,

sysName, sysLocation, loaded MIB files. It allows to checking that the device communicates properly.

If the device is offline the error message appears in “sysDescr” field.

Figure 13. Agents.

Manage list of Agents

You can add SNMP devices manually or by discovering. For manual adding press “+” button (fig. 8.7).

Figure 14. Adding SNMP device.



On displayed dialog (fig. 14) setting the IP address, TCP port, device name, Community, version is

required for v1 and v2. For version 3 additional security settings possible.

Each item in Agents list can be removed or edited with appropriate buttons (fig. 8.7).

Device discovery dialog can be called by button fig. 8.6. When the dialog is appearing the discovery

procedure initialized. After about 60 seconds result of discovering listed in “Discovered Agents” list.

By checking wanted items, you can add agents to the current configuration. For apply adding press “+”

button.

Figure 15. Discovering.

SNMP Agent Configuration

After required Agents list creation you need to configure each device. It means you need to specify

necessary OIDs, tables IIDs and traps which to be processed. Access to device configuration tool

possible to get by device context menu in Agents list.



Figure 16. Agent context menu.

Buttons on fig. 16.1 is a same as on fig. 8.7. For configuring device press “Configure Device…” (fig.

16.2). After that agent configuration dialog will appear (fig. 16).

Figure 16. Snmp Entity Configuration.

Consider the configuration of the example device Dlink DGS-1210-28P (IP:10.0.0.47). First we need to

add additional MIB files which contains necessary definitions for this device:

Go to the menu “File” -> “Load MIB…”. In Open dialog specify required MIB files and its

dependencies (section “IMPORTS” of file (fig. 17)).



Figure 17. MIB Dependencies.

Figure 18. Open dialog.

Press OPEN button. After parsing MIB files in MIB Definition Tree will appear new objects

corresponding to the Dlink switch (fig. 19).



Figure 19. MIB Tree.

In the next step we need to specify required objects for requests. Expand required node of MIB Tree

and drag and drop objects to “Required OIDs” table. If the required object has Usage attribute

equals Table, you can choose necessary IIDs by object context menu (fig. 20, 21).

Figure 20. Table definition.



Figure 21. Choosing IIDs.

If you don’t require any other objects for requests, press “V” button on Snmp Entity Configuration

Dialog (fig. 16). When least one object added to the configuration of OIDs or IIDs, the buttons

“Query Device Values…” and “Query Device Tables…” (fig. 16.3, 4) are enabled.

SNMP Agent requests

When configuration is complete, you can check it by performing requests. In SNMP Agent context

menu select “Query Device Values…” (fig. 16.3). After it response form will appear (fig. 22).



Figure 22. Responses.

If configuration is correct and device is online, the column “Value” has some IIDs values. In case of

failure you can inspect the issue by log monitor (fig. 12).

Also you can get whole IIDs values of required SNMP tables by pressing “Query Device Tables…” (fig.

16.4). Response form on fig. 23.



Figure 23. Table Response Form.

SNMP Set request also available. Press button “Set value…” in device context menu (fig. 16.5). Set

value dialog will appear. All values with “ReadWrite” credentials may be write by configurator.



Figure 24. Set values.

Saving Configuration File

When all required objects specified, you can save current configuration in file. Select menu “File” >

“Save…” or press “Save” button (fig. 8.3).


SmartConnector.SnmpExtension deployment and configuration 22

SmartConnector.SnmpExtension deployment and configuration

When the set of SNMP objects is determined and configuration file with objects list is created, we can

deploy SnmpExtension to SmartConnector framework.

SmartConnector portal. Initial Configuration

Type in browser address string http://localhost:8082 for accessing to the SmartConnector web portal.

The goal of SmartConnector.SnmpExtension installation is a deploying libraries to SmartConnector

framework. Now we are starting configuration of deployed extension:

1. In portal main menu select item “Configurations” -> “Processors”.

2. Click on button “Add New +” (fig 25.1)

Figure 25. Adding new extension.

3. In dialog page “Add processor configuration” pick a “SmartConnector.SnmpExtension” assembly

(fig. 26.2), then click on button “Next”.



Figure 26. Picking the assembly.

4. Assembly includes one public class – “SnmpProcessor”. It will create SNMP objects placeholders in

EWS server for data placement and initiate data exchange between SNMP manager and EWS server.

Please choose “SnmpProcessor” (fig. 27.1) and click on “Next” button (fig. 27.2).

Figure 27. Choosing a class.

5. The last step of adding class to SmartConnector framework is a setting the name and description.

Name must be meaningful.



Figure 28. Setting name and description.

6. After finishing the last step of processor configuration in the paragraph number 5, we must set

several configuration parameters of processor in “Detail” tab (fig. 29):

a. “Config File” location (fig. 29.2) means configuration file of

“SmartConnector.SnmpConfigurator”, which created in Saving Configuration File section.

b. “Update Rate” (fig. 29.4). It means a period of sending data to EWS server from SNMP

manager. It measures in milliseconds and can be set in [1000 - 200000] range.

c. “EWS Address” (fig. 29.3) – this property is should be set to the full address required to

access our EWS interface.

d. “Server Name” (fig. 29.5) – this property is just a friendly text name field to allow you to

easily identify the specific endpoint you are configured.

e. “User Name” and “Password” (29.6, 7) – these properties required to allow the EWS server

connection to be authenticated.



Figure 29. Setup processor additional configuration.

7. Click on “Save” button for finishing configuration.

8. “SnmpProcessor” is a long running processor and it must be run on start of SmartConnector

framework (fig. 30.2).

Figure 30. Update processor additional configuration.

SmartConnector portal. Run Extension



Before running any processors please add license for extension. Section Licensing

describes the process.

If configuration performed properly, then “Processor Configuration” page of SmartConnector portal

looks like in fig. 22.

Figure 31. Processor Configurations page.

For running extension press “ ” button on fig. 31.1 panel. After it the “ ” button change icon to “

”. Changing icon to “ ” again means that “SnmpProcessor” has completed its operations and

some error occurs (please follow instructions in Logging section for investigation).

If “SnmpProcessor” are operating properly, the run button (fig. 31.1) will remain in “ ” condition

until stopped manually by user.


Acquiring data in SBO from EWS server 27

Acquiring data in SBO from EWS server

For acquiring data from SNMP agent to SBO, create “EcoStruxure Web Service” interface (fig. 32).

Specify name and description. Click on “Next” button.

Figure 32. Creating EWS interface.

On connection information form specify EWS server host IP address (fig. 33.1). If the EWS server and

Enterprise Server located on the same PC, then IP will be 127.0.0.1 or localhost. Specify communication

port to “5305” value (fig. 32.2). EWS Path – “/SmartConnectorSnmpService” (fig. 33.3). Specify the User

Name – “admin” and New password – “Admin!23” (fig. 33.4). Click on “Create” button (fig. 33.5).



Figure 33. Specifying connection information for interface.

If connection between EWS server and “SmartConnector Snmp Service” interface established, then in

system tree pane object “Enterprise Server/Hardware/EcoStruxure Web Services/Smart Struxure Web

Service Snmp/Smart Connector Snmp Service” will appear (fig. 25). Right click on it and choose item

“Host EWS objects…”. Then choose target object in system tree and click “OK” button.



Figure 34. Hosting EWS objects.

After hosting EWS objects, in system tree pane under created interface “EcoStruxure Web Service

Snmp” node the “SmartConnector SNMP Service” folder will appear with SNMP objects (fig. 26). If

values updates and EWS State is “Good”, then communication between SBO Enterprise Server (or AS)

and SNMP manager established.



Figure 34. Acquiring data in SBO.


Logging 31

Logging

SmartConnector framework records all actions and exceptions info to log file (fig. 35). The default

location is “C:\Program Data\SmartConnector\*.log”.

Figure 35. Sample of SmartConnector framework logging.


Licensing 32

Licensing

After adding the extension assembly you must install the license file, which provided from seller (see

Contacts section). For installing license select “Setup” -> “Licenses” main menu item of

SmartConnector portal (fig. 36.1). Click on “Add” button and select license file in file open dialog.

Figure 36. Licensing.


Software Requirements 33

Software Requirements

SmartConnector.SnmpExtension and SmartConnector.SnmpConfigurator software tested on following

operation systems:

Windows 7 x64

Windows 10 x64

Windows Server 2008 x64

Windows Server 2012 x64

This software requires .NET framework 4.6.2.


Appendix 1. Troubleshooting 34

Appendix 1. Troubleshooting

EWS Server is not started

It may be occurring if this URL already registered in HTTP.SYS. In this case log file (Logging section)

looks like this one:

Fig. 34. EWS server starting issue log file.

To fix this issue please follow steps below:

1. Start the console with administrator permissions

2. Write following command (fig. 35.1)

Fig. 35. Command

3. In the result list find required URL (fig. 34 line 87)

4. Delete item (fig. 35.1) from list by the following command: netsh http delete urlacl url=http://*:5358/

5. Restart “OpcProcessor” by “SmartConnector” portal.


Appendix 1. Troubleshooting 35

Fig. 35. HTTP.SYS content


Contacts 36

Contacts

For any questions please mail to:

[email protected]

Documents

SmartConnector SNMP Extension