Wonderware Operations Integration SNMP OI Server 1.1 (Series-G1.2) UserGuide
2016 Schneider Electric Software, LLC. All rights reserved.No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by anymeans, electronic, mechanical, photocopying, recording, or otherwise, without the prior writtenpermission of Schneider Electric Software, LLC. No liability is assumed with respect to the use of theinformation contained herein.Although precaution has been taken in the preparation of this documentation, Schneider ElectricSoftware, LLC assumes no responsibility for errors or omissions. The information in this documentationis subject to change without notice and does not represent a commitment on the part of SchneiderElectric Software, LLC. The software described in this documentation is furnished under a licenseagreement. This software may be used or copied only in accordance with the terms of such licenseagreement.ArchestrA, Avantis, DYNSIM, eDNA, EYESIM, Foxboro, Foxboro Evo, I/A Series, InBatch, InduSoft,InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, Schneider Electric,SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software, VISUAL FLARE, WindowMaker,WindowViewer, and Wonderware are trademarks of Schneider Electric SE, its subsidiaries, andaffiliated companies. An extensive listing of Schneider Electric Software, LLC trademarks can be foundat: marks/. All other brands may be trademarks oftheir respective owners.Schneider Electric Software, LLC26561 Rancho Parkway SouthLake Forest, CA 92630 U.S.A.(949) lication date: 9/12/2016
Contact UsContact Schneider Electric Software Technical SupportAvantis Technical SupportListing of regional and local country contacts: ntis/Technical support: http://softwaresupport.schneider-electric.com/For Avantis.PRO, Avantis Approvals, Avantis.DSS, and Condition Manager: Email: [email protected] Phone (8:30 a.m. to 5:00 p.m. Monday to Friday, Eastern Time):oToll-Free U.S. and Canada: 1-888-262-7111oToll-Free EMEA: 1-800-4670-6466oDirect dial: 1-905-632-0635For Avantis.XA: Email: [email protected] Phone (8:30 a.m. to 5:00 p.m. Monday to Friday, Eastern Time):oToll-Free U.S. and Canada: 1-800-991-8000oToll-Free EMEA: 1-800-4670-6466oDirect dial: 1-905-632-4122SimSci Technical SupportListing of regional and local country contacts: sci/Technical support: http://softwaresupport.schneider-electric.com/ Phone (USA 8:00 a.m. to 5:00 p.m. Central Time)o Toll-Free U.S. and Canada: 1-800-746-7241Email U.S. and Canada: [email protected] Technical SupportListing of regional and local country contacts: /Technical support: http://softwaresupport.schneider-electric.com/ Priority email for Customer FIRST Members: [email protected] Email for customers without a support agreement: [email protected] PhoneoToll-Free North America and Latin America: 1-800-966-3371oDirect dial: 1-949-639-8500InStep Technical SupportContact page: http://www.instepsoftware.com/contact-us
Technical support: https://support.instepsoftware.com/ Email: [email protected] Phone (USA 8:00 a.m. to 5:00 p.m. Central Time)o1-312-894-7870Schneider Electric – Smart Water Software Technical Support Help desk email: [email protected] Help desk telephone hotline: 45 88 30 20 77 (09:00 to 16:00 Monday to Thursday, Friday 09:00 to15:00, Central European Time)Contact Schneider Electric Software Learning ServicesContact Software Learning Services for assistance regarding classes, schedule, offerings, frequentlyasked questions, tuition, policies, and more. Email: [email protected] Toll-Free U.S. and Canada: 1-866-998-7246 Direct: 1-949-639-8508 Fax: 1-949-639-1847
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideContentsChapter 1 Getting Started with the SNMP OI Server . 7About the SNMP OI Server .7Determining the Hierarchical Structure .7Working with a Basic Hierarchy .8Configuring More than One Channel Selector .8Building the Hierarchical Structure in the SMC .8Chapter 2 Configuring the SNMP OI Server . 11Setting Up an SNMP OI Server for the First Time .11Adding and Configuring Channel Selector Objects .11Adding and Configuring Device Selector Objects .14Device Group Definitions .16Device Item Definitions .17Configuring SNMP Redundancy .18Chapter 3 SNMP OI Server References . 19Supported Software Environments and Devices .19Station Parameters .19I/O Address Syntax .20Data Types.21Using Traps .21Common SNMP Item References.22Configuring an SNMP Agent in Windows .23Chapter 4 Troubleshooting the SNMP OI Server . 29Checking Status Codes .29Status Codes.305
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideC HAPTER 1Getting Started with the SNMP OI ServerThis document describes the technical specifications and configuration options for the Wonderware Operations Integration - Supervisory Simple Network Management Protocol (SNMP) Server.In This ChapterAbout the SNMP OI Server .7Determining the Hierarchical Structure .7About the SNMP OI ServerUse the Wonderware SNMP OI Server to monitor and manage devices on IP networks. Using theSNMP OI Server, you can add and configure channels and the devices to be monitored and managedusing your choice of Management Information Base (MIB) browser.Note: This OI Server is hosted by the OI Server Manager, a Microsoft Management Console (MMC)snap-in, which is a part of the ArchestrA System Management Console (SMC) suite of utilities. Manyhigh-level functions and user-interface elements of the OI Server Manager are universal to all OIServers, and only the documentation for the OI Server Manager contains descriptions of thoseuniversal functions/UI elements. Therefore, reading the documentation for both the MMC and the OIServer Manager is critical to understanding this user’s guide. To read the documentation about theMMC and OI Server Manager, right-click the OI Server Manager icon and select the Help menu. Boththe MMC Help and the OI Server Manager Help are displayed.An SNMP agent must be installed and configured on each device managed by the SNMP OI server.For information about installing and configuring an SNMP in Windows, see Configuring an SNMPAgent in Windows on page 23.Determining the Hierarchical StructureDetermine the hierarchical structure of the networked devices environment to which you plan toconnect. The SNMP OI Server is configured in a two-tier hierarchy, with Channel Selector connectionparent objects and associated Device Selector connection child objects.Note: This device hierarchy is different and separate from the hierarchical namespace containingObject Identifiers and associated variables visible and manageable through a Management InformationBase (MIB) browser.7
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User Guide Getting Started with the SNMP OI ServerWorking with a Basic HierarchyYou can create more than one Channel Selector object, but a basic configuration calls for a singleChannel Selector object with child Device Selector objects representing individual devices. This typicalconfiguration is common for the following reasons: Traps are received from the port specified in the Channel Selector settings, with port 162 as thedefault. To receive traps correctly, only one Channel Selector can be bound to the specified port. Ifmultiple channel selectors share the same port, only one of them will receive traps. In real world applications, traps are sent to port 162 by default when using SNMP Windows Agentsor devices (PLCs routers, printers etc. that support SNMP) . You can specify any valid port, butin most cases when talking to real devices with SNMP, the port 162 is used. Hence, the defaultvalue for the TRAP port has been configured to 162.However, in some cases you can change the default trap port that the device or machine can sendtraps to. The same conditions, guidelines, and recommendations apply if you want to clone multipleinstances of the SNMP OI server on the same machine. Traps will function only in the first runningversion of any SNMP servers. Any subsequent instances of the SNMP server will not receive anytrap packets.Configuring More than One Channel SelectorUse the Channel Selector for the Trap Port setting, but also to set the number of SimultaneousRequests you want to make to your managed devices. With multiple simultaneous requests configured, tests have shown an improvement in throughputand performance. Even without multiple simultaneous requests, using the default setting (1), a new thread is createdfor each new Channel Selector. Multiple threads instead of single one, will also improveperformance.If you observe performance issues in your SNMP configuration, we recommend the followinghierarchy:1. Create one Channel Selector for the devices from which you want to receive wants traps.2. Create additional Channel Selectors to improve performance of the OI server and to usesimultaneous connections for devices from which you don't want to receive traps, but from whichyou want to process values for greater numbers of OIDs.Note: A limitation of multiple Channel Selectors or a channel selector with enabled simultaneousrequests is that these configurations will show higher memory and CPU usage by the OI server.Building the Hierarchical Structure in the SMCTo build the hierarchical structure1. Configure the new SNMP OI Server.a. In the console tree, right-click Configuration and then click Add ChannelSelectorConnection.8
Getting Started with the SNMP OI Server Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User Guideb. Edit the object name to appropriately describe components of your specific hardwareenvironment. If you do not rename the object at this time, a numeric sequencing system isapplied. You can rename the hierarchy entry later.2. Right-click the New ChannelSelector 000 object you created in the tree and then click AddDeviceSelector Connection to create a Device Selector object.3. Optionally create device groups for each logical end-point object.Important: When the OI Server or any of its configuration views are selected and you open multipleinstances of the OI Server Manager, the OI Server Manager places the configuration views from thesubsequent instances of the same OI Server into read-only mode. Access to the second instance ofthe OI Server resumes after the first one has been deselected or closed. Likewise, access to the OIServer configuration will be unlocked for the next instance in this order.9
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideC HAPTER 2Configuring the SNMP OI ServerIn This ChapterSetting Up an SNMP OI Server for the First Time .11Adding and Configuring Channel Selector Objects .11Adding and Configuring Device Selector Objects .14Device Group Definitions .16Device Item Definitions.17Configuring SNMP Redundancy .18Setting Up an SNMP OI Server for the First TimeIf you are setting up an OI Server for the first time, perform the following tasks in the order listed:1. Locate the OI Server in the System Management Console (SMC). In the OI Server Manager tree,under the Local node, the OI Server base instance name is OI.SNMPDIR.1.2. Configure the global parameters. See "Configuring Global Parameters" in the OI Server Managerhelp.3. Add one or more channel selector connections. See Adding and Configuring Channel SelectorObjects on page 11.4. Add one or more device selector connections. See Adding and Configuring Device SelectorObjects on page 14.5. Add one more device groups. See Device Group Definitions on page 16.6. Add device items. See Device Item Definitions on page 17.7. Activate the OI Server. See "Activating/Deactivating the OI Server" in the OI Server Manager help.8. Troubleshoot any problems.Note: (Optional) You can also use any commercially available MIB browser to find the OIDs to use asitem references on the OI Server.Adding and Configuring Channel Selector ObjectsThe server-specific configuration portion of the SNMP OI Server hierarchy tree under the OI ServerManager starts at the Channel Selector object. This object lets you set server parameters forcommunication with agents (devices) in the hierarchy tree.See Determining the Hierarchical Structure on page 7 for more information about setting up yourdevice hierarchy.11
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideConfiguring the SNMP OI ServerTo add a Channel Selector object to your SNMP hierarchy1. In the console tree, right-click Configuration and then click Add Channel Selector Connection.The "New ChannelSelector 000" object appears in the hierarchy.Edit the object name to appropriately describe components of your specific hardware environment.If you do not rename the object at this time, a numeric sequencing system is applied. You canrename the hierarchy entry later.2. Specify the Trap UDP Port. The default is 162.3. Click Advanced. The Advanced settings dialog appears.The SNMP OI server will function with the advanced settings defaults. It is unnecessary to changethe default settings to complete your SNMP OI server connectivity. .o12The following parameters are configurable in the SNMP OI server:ParameterDefaultDescriptionTimeout: Start message1000 msSpecify the timeout for the message start.
Configuring the SNMP OI ServerWonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideProtocol: Retries1Enter value to specify the number ofattempts to execute the samecommunication before considering acommunication error for this command.Simultaneous Requests: Maximum1Specify the maximum number of requeststhat can be sent simultaneously to allconnected devices.If you plan to listen to traps sent bydifferent devices (which are configured asdevice selector stations), leave themaximum and minimum at 1.Simultaneous Requests: Maximum perstation1Specify the maximum number of requeststhat may be sent simultaneously to a singledevice.If you do not plan to listen to traps sent bydifferent devices, you can set maximumand minimum values higher than 1.oThe following parameters are not applicable in the SNMP OI server, or are pre-set and are notconfigurable in the SNMP OI server. Descriptions are provided here for information purposes:ParameterDescriptionTimeout: End messageReserved. Do not modify.Timeout: Interval between charSpecifies the timeout between each character.Timeout: Wait CTSSpecifies the timeout for the Clear to Send wait.Handshake: Control RTSSpecifies whether to use the Request to Send control.Handshake: Verify CTSSpecifies whether to use the Clear to Send verificationtype.Disable DTRWhen disabled, no DTR signal is sent before starting acommunication.Enable IRAvailable only on Windows Embedded target systems.Enables use of Infrared interface (COM2 port) ratherthan a standard serial port to communicate withdevices.Protocol: StationUsed to specify a slave address where required.Buffers length: Tx BufferReserves memory for data transmission to the SNMPdevices.Reserved. Do not modify.Buffers length: Rx BufferReserves memory for data received from the SNMPdevices.Reserved. Do not modify.Tx Buffer reserves the memory for data transmission to the SNMP devices.Rx Buffer reserves the memory for data received from the SNMP devices13
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideConfiguring the SNMP OI ServerAdding and Configuring Device Selector ObjectsThe SNMP OI Server can connect to different Windows agents, PLCs, and other data sources. Theseconnections are modeled in the hierarchy by means of Device Selector objects, each of which modelsthe end-point of the communications path.From the ChannelSelector branch of the OI Server hierarchy, create the new DeviceSelector object.To add a Device Selector connection to your SNMP hierarchy1. In the console tree, right-click the ChannelSelector object, and then click Add DeviceSelectorConnection. The New DeviceSelector 000 object and associated Parameters configurationview appear2. Rename the object as needed to reflect the connection.3. Configure the Station.The Station field cannot be empty. It uses the following syntax: IP Address : Port : SNMP Version : ReadCommunity : WriteCommunity .The IP address is required. Other syntax elements are optional.ParameterDefault Value DescriptionIP AddressnoneThe IP network address of the targetdevice where the agent is configured.Required.Port161The port number used by the driverfor performing GET and SEToperations to the OIDs.Optional. If not specified, the defaultvalue is used.Version141The version of SNMP used. Possiblevalues are 1 and 2, for SNMPversions 1 and 2, respectively.
Configuring the SNMP OI ServerWonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideOptional. If not specified, the defaultvalue is used.Read CommunitypublicThe read community name.Case sensitive.Optional. If not specified, the defaultvalue is used.Write CommunitypublicThe write and read community name.Case sensitive.Optional. If not specified, the defaultvalue is used.Communities configured in the SMC must match the communities configured in the SNMP agent.Typically, the PLC will have the settings. Refer to your PLC documentation for SNMP configurationin the specific PLC. For more information, see Station Parameters (on page 19).4. Configure Device Groups and Device Items.Connection Tips1. The minimum entry parameter is the IP Address . If only IP address is specified, the otherparameters will use the following default values: IP Address :161:1:Public:Public. You mustensure these parameters match the device that you are connecting to.2. The connection port specified for regular connection to SNMP devices is different than the trap portused. The typical port for read/write operations is 161.15
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideConfiguring the SNMP OI ServerDevice Group DefinitionsUse the Device Groups dialog box, which appears by clicking the Device Groups tab in the DeviceSelector configuration editor to create, add, delete, and define device groups. You can also configuredefault update intervals for the objects and edit update intervals in this dialog box.Note: When you select another part of the OI Server tree hierarchy, you are prompted to save themodifications to the configuration set.To create or add device groups1. Right-click in the Device Groups box and click Add.2. Enter a unique name up to 32 characters long for the device group.To delete device groups Right-click on the device group to be deleted from the list and select Delete.To edit device groups Use the Edit option from the Device Groups tab only for configuring the OI Server’s unsolicitedmessage handling.To configure default update intervals To configure a default update interval for the object, right-click in the Device Groups box and thenclick Config Default Update Interval.To edit update intervals To edit the update interval for an object, double-click its value in the Update Interval column andmake the edits.or16
Configuring the SNMP OI Server Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideRight-click its value in the Update Interval column and then click Modify Update Interval.The update interval is the frequency, in milliseconds, that the SNMP OI Server acquires data fromthe topics associated with that device group.Different topics can be polled at different rates from a PLC by defining multiple device groupnames for the same PLC and setting a different update interval for each device group.Device Item DefinitionsDevice item configuration is optional, but is strongly recommended.You may want to use the Device Item Definition table to create more user friendly names byassociating the OID with an alias or name similar to its definition as seen in the MIB file. Once thedevice items are so configured, you can browse by name or by item reference.After you configure item names, the SNMP OI Server can perform GET and SET operations. Itemnames and references must follow these syntax guidelines: The Name is the SNMP property or object name, or a user-defined alias. The Item Reference must be the full OID, all decimals and digits. When using the OID as the item reference, the Item Reference must start with a decimal point,same as the OID. Alternatively, the Item Reference can incorporate the datatype as a prefix with the full OID.Use datatype :OID in the Item Reference in order to use device item names in reads/writes. Most operations with SNMP devices are read operations. The datatype :OID syntax isrequired to perform write/SET operations to an item.17
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideConfiguring the SNMP OI ServerIn the illustration, two item references are configured with this syntax, sysName and sysLocation.These items permit read/write access. The datatype prefix allows writes to the item name.For more information, see Common SNMP Item References and Data Types. You can specify a trap using the following syntax: TRAP : TRAPTYPE .the TrapType can be a type of trap like COLDSTART or an OID when it is an Enterprise type trap.The illustration shows a device item trap named "COLDSTART" with an itemreference "TRAP:COLDSTART".In this example, you could provide an OID in place of the type of trap, suchas: TRAP:.220.127.116.11.18.104.22.168.5.4.For more information, see Using Traps on page 21.To create or add device items1. Right-click in the Device Items box and click Add.2. In the Name column, type a unique item name. The maximum is 32 characters. For example,"snmpInTraps.0."3. Double-click the line in the Item Reference column and enter the correlated item reference for thename you created. For SNMP, this is the OID.To rename device items Right-click the device item to be renamed and click Rename. Make the changes.To delete device items Right-click the device item to be deleted from the list and click Delete.To clear all device items Right-click in the Device Items box and click Clear All. All the device items listed are cleared afteryou confirm their deletion.NOTE: You can import a .csv file containing your item definitions to help streamline configuration. See"Exporting and Importing CSV Files" in the Wonderware Operations Integration - OI Server Manager(G-1 Series) Help.Configuring SNMP RedundancyThe Wonderware Operations Integration Server Manager supports device redundancy. However,setting up redundant devices in the SNMP hierarchy is not recommended.18 Redundancy is not supported for traps. The redundant device requires a Ping Item, which for SNMP is a specific OID.
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideC HAPTER 3SNMP OI Server ReferencesIn This ChapterSupported Software Environments and Devices .19Station Parameters.19I/O Address Syntax .20Using Traps .21Common SNMP Item References .22Configuring an SNMP Agent in Windows.23Supported Software Environments and DevicesThe SNMP OI Server supports SNMP protocol versions 1 and 2c, and all SNMP-enabled devices.Station ParametersMany PLCs support SNMP version 1. By default the Read and Read/Write communities are public, asshown in the following parameters table. You can use this configuration if you want to test if your PLCor device supports SNMP. If it doesn't work, contact your device manufacturer. For a sample list ofPLCs that support SNMP, see Supported Software Environments and Devices on page 19.The Station field in the Device Selector parameters window cannot be empty. It uses the followingsyntax: IP Address : Port : SNMP Version : ReadCommunity : WriteCommunity ParameterDefault ValueDescriptionIP AddressnoneThe IP network address of the agentconfigured.Required.Port161The port number used by the driver forperforming GET and SET operations to theOIDs.Optional. If not specified, the default valueis used.Version1The version of SNMP used. Possible valuesare 1 and 2, for SNMP versions 1 and 2,respectively.Optional. If not specified, the default valueis used.19
Wonderware Operations Integration - SNMP OI Server 1.1 (Series-G1.2) User GuideRead CommunitypublicSNMP OI Server ReferencesThe read community name.Case sensitive.Optional. If not specified, the default valueis used.Write CommunitypublicThe write and read community name.Case sensitive.Optional. If not specified, the default valueis used.If an IP address is not specified, an error will be returned during run time.Following are examples of valid stations: 22.214.171.124 126.96.36.199:161 188.8.131.52:161:1 184.108.40.206:161:2:public:privateNote: The minimum required parameter in the Station field is the IP address. If only IP address isspecified, the other parameters will use the following default values: However, we recommendspecifying all parameters as in the example 220.127.116.11:161:2:public:private.Communities configured in the SMC must be identical to the communities configured in the SNMPagent. Typically, the PLC will have the settings. Refer to your PLC documentation for SNMPconfiguration in the specific PLC.I/O Address SyntaxOID AddressBoth Wonderware Application Server and Wonderware InTouch HMI can read and write to items indevices using either a reference name or the item's OID. Specify the address of the OID (used for GETand SET operations) with the following syntax:Datatype:OID OID is the object identifier of the variable (when performing GET and SET operations). Thisparameter is required. The Datatype parameter is required for SET (write) actions to the OIDs, but is optional for GET(read) actions.Examples of valid addresses when performing GET and SET operations: OCTETSTRING:.18.104.22.168.22.214.171.124.0In this example, you can use OCTETSTRING:.126.96.36.199.188.8.131.52.0 or .184.108.40.206.220.127.116.11.0 whenperforming GET ope
Sep 12, 2016 · An SNMP agent must be installed and configured on each device managed by the SNMP OI server. For information about installing and configuring an SNMP in Windows, see Configuring an SNMP Agent in Windows on page 23. Determining the Hierarchical Structure Determine the hierarchical structure