SNMP Interface to the PI System

SNMP Interface to the PI System Version 1.3.0.4 Rev C How to Contact Us Phone (510) 297-5800 (510) 297-5828 (main number) (technical support) Fax (510) 357-8136 E-mail techsupport@osisoft.com World Wide Web http://www.osisoft.com Mail OSIsoft P.O Box 727 San Leandro, CA 94577-0427 USA OSI Software, Ltd P O Box 8256 Symonds Street Auckland 1035 New Zealand OSI Software GmbH Hauptstrae 30 D-63674 Altenstadt Deutschland OSI Software, Asia Pte Ltd 152 Beach Road #09-06 Gateway East Singapore, 189721 Unpublished – rights reserved under the copyright laws of the United States RESTRICTED RIGHTS LEGEND Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 Trademark statement—PI is a registered trademark of OSIsoft, Inc Microsoft Windows, Microsoft Windows for Workgroups, and Microsoft NT are registered trademarks of Microsoft Corporation Solaris is a registered trademark of Sun Microsystems HP-UX is a registered trademark of Hewlett Packard Corp IBM AIX RS/6000 is a registered trademark of the IBM Corporation DUX, DEC Cisco is a registered trademark of Cisco Systems, Inc VAX and DEC Alpha are registered trademarks of the Digital Equipment Corporation pjb1666063951.doc  2000-2005 OSIsoft, Inc All rights reserved 777 Davis Street, Suite 250, San Leandro, CA 94577 Table of Contents Introduction Reference Manuals Supported Features .2 Diagram of Hardware Connection Principles of Operation PI-SNMP’s Role in SNMP Networks .5 PI-SNMP Internal Operation PI-SNMP User Operation Summary PI Data Input and Output .6 Installation Checklist Interface Installation .9 PI-Interface Configuration Utility Interface Directories .9 The PIHOME Directory Tree Interface Installation Directory 10 Interface Installation Procedure 10 Naming Conventions and Requirements .10 Installing the Interface as a Windows Service .11 Installing the Interface Service with PI-Interface Configuration Utility 11 Installing the Interface Service Manually 13 Digital States 15 PointSource 17 Interface Point Configuration 19 Point Attributes .19 Tag 19 PointSource 19 PointType 19 Location1 20 SNMP Interface to the PI System iii Location2 20 Location3 21 Location4 22 Location5 23 InstrumentTag 23 ExDesc .23 Scan 28 Shutdown 28 SourceTag 29 Conversion 29 Performance Point Configuration .31 Configuring Performance Points with PI-ICU 31 Configuring Performance Points Manually 32 I/O Rate Point Configuration 33 Monitoring I/O Rates on the Interface Node .33 Configuring I/O Rate Points with PI-ICU .33 Configuring I/O Rate Points Manually 35 Configuring the I/O Rate Point on the PI Server .35 Configuration on the Interface Node 35 Startup Command File 37 Using PI-ICU to Maintain Startup Command File .37 Command-line Parameters 41 Sample pisnmp.bat File 45 pisnmp.ini File Obsolete 46 Interface Node Clock 47 Security 49 Starting / Stopping the Interface 51 Using the PI-ICU 51 Not Using the PI-ICU 51 Buffering 53 Configuring Buffering with PI-ICU 53 Configuring Buffering Manually 56 Example piclient.ini File 58 SNMP Interface to the PI System iv Appendix A: Error and Informational Messages .59 Message Logs 59 Messages .59 Location5 60 System Errors and PI Errors 61 Common Problems 61 Unexpected Value 61 PI-SNMP Startup 62 Point Loading 62 No New Value 63 Value of 64 I/O Timeout .64 Bad Input 64 Configure 65 Missed Scans 65 Appendix B: snmpget 67 Appendix C: OID Examples 69 Appendix D: Basic SNMP for PI Users .71 Appendix E: Tutorial on Using PI-SNMP with Routers .75 Appendix F: PI-SNMP Technical Details .81 Appendix G: ifAlias Support 83 Appendix H: Known Issues 87 Appendix I: Acknowledgments 89 Revision History .91 SNMP Interface to the PI System v Introduction OSIsoft’s PI-SNMP data collection interface program gathers information from SNMPenabled devices residing in a TCP/IP network The operation of PI-SNMP requires that these devices be able to send and receive messages via the SNMP protocol In particular, they must have an SNMP Agent that supports SNMPv1, SNMPv2c, or SNMPv3 Because RMON (Remote Monitoring) is a specific application of the SNMP protocol, PI-SNMP supports the retrieval of RMON values PI-SNMP Basic (a limited version of the full PI-SNMP program) is also available from OSIsoft PI-SNMP Basic has the following limitations:  it gets data for up to 32 PI points  only one copy of the program may be running at a time  it runs only on a machine that is also running the PI Server  it sends data only to this PI Server machine In addition, the filename of PI-SNMP Basic is pisnmp_basic.exe (versus pisnmp.exe for the full version) The following table summarizes the differences between the full and basic versions of PI-SNMP PI-SNMP PI-SNMP Basic Maximum point count Point count of PI Server 32 Availability Available for purchase Installed as part of PI Server 3.3 and higher Can run on a PI Interface node Yes No Must run on a PI Server node No Yes Must send data to the PI Server node on which it runs No Yes Number of copies that can run simultaneously Unlimited Filename pisnmp.exe pisnmp_basic.exe PI-SNMP runs on a Microsoft Windows NT (version 4.0 or higher), Windows 2000, Windows XP, or Windows Server 2003 computers Unless otherwise noted, the remainder of this document uses the term “Windows” to refer to all four PI-SNMP requires PI-SDK version 1.2.0 Build 180 (or higher) The flow of data for the Interface is bi-directional Specifically, PI-SNMP retrieves values from SNMP devices (i.e., PI input points) as well as sets values on SNMP devices (i.e., PI output points) SNMP Interface to the PI System PI-SNMP does not require any special hardware A standard network interface card on the Windows machine is sufficient In order to utilize PI-SNMP effectively, the user should be familiar with both basic SNMP and PI technologies For example, for SNMP, the user should be familiar with the terms Management Information Base (MIB), Object Identifier (OID), and community string Users who are not familiar with SNMP should consult Appendices B and C of this document On the PI side, the user should be adept at creating and editing PI points Also, the user needs to know the differences between time-based and event based data collection in PI Reference Manuals OSIsoft  UniInt End User Document  PI Server manuals  PI-API Installation Instructions  PI-API manual  PI-ICU User Manual Supported Features Feature Support Part Number PI-IN-OS-SNMP-NTI Platforms Windows (NT4, 2000, XP) (Intel) APS Connector Currently Available No Point Builder Utility Yes ICU Control Yes PI Point Types PI 3.x (float16 / float32 / float64 / int16 / int32 / digital / string) Sub-second Timestamps Yes Sub-second Scan Classes Yes Automatically Incorporates PI Point Attribute Changes Yes Exception Reporting Yes Outputs from PI Yes Inputs to PI: Scan-based / Unsolicited / Event Tags Scan-based / Event Tags Maximum Point Count Point Count of PI Server (full version only) Uses PI-SDK Yes PINet to PI 3.x String Support Not applicable SNMP Interface to the PI System Feature Support * Source of Timestamps PI Server machine History Recovery No Failover No * UniInt-based Yes Vendor Software Required on PI Interface Node No * Vendor Software Required on Foreign Device Yes Vendor Hardware Required No * Additional PI Software Included with Interface Yes * Device Point Types Integers and octet strings * See paragraphs below for further explanation Source of Timestamps The clock on the computer running the PI Server provides the source of timestamps for the values sent by PI-SNMP The Interface writes a timestamp that reflects the time at which it receives data from the SNMP devices UniInt-based UniInt stands for Universal Interface UniInt is not a separate product or file; it is an OSIsoft-developed template used by developers, and is integrated into many interfaces, such as the PI-SNMP Interface The purpose of UniInt is to keep a consistent feature set and behavior across as many OSIsoft-developed interfaces as possible UniInt also allows for the very rapid development of new interfaces In any UniInt-based interface, the Interface uses some of the UniInt-supplied configuration parameters and some interface-specific parameters UniInt is constantly being upgraded with new options and features The UniInt End User Document is a supplement to this manual Vendor Software Required on Foreign Device In order for PI-SNMP to retrieve data from the foreign device, the device must be running an SNMP Agent Devices such as network routers and switches typically come with SNMP Agents by default Other network-enabled devices such as workstations, servers, and printers may also have SNMP Agents built-in Alternatively, third-parties may supply SNMP Agents for these devices Additional PI Software OSIsoft strongly recommends the use of the PI SNMP Tag Builder plug-in for PI SMT to assist with the tag building process This software is available from the OSIsoft Technical Support site at http://techsupport.osisoft.com/ For further details, consult the plug-in documentation SNMP Interface to the PI System Introduction Device Point Types PI-SNMP supports the retrieval of integer and string data PI-SNMP can also retrieve MAC addresses and IP addresses from SNMP Agents Diagram of Hardware Connection Principles of Operation PI-SNMP’s Role in SNMP Networks In SNMP terminology, the PI-SNMP data collector behaves like an SNMP Manager It retrieves information from network devices via the SNMP Agent running on these devices PI Server PI-SNMP SNMP Agent router SNMP Agent server SNMP Agent switch However, PI-SNMP is not a complete SNMP Manager It cannot receive data via traps sent by SNMP Agents Thus, PI-SNMP’s primary purpose is to gather statistics and data not to control or configure network nodes PI-SNMP Internal Operation When the Interface starts up, it retrieves from the PI Server a set of points that have the same point source as that specified in the Interface’s startup command file The Interface then begins loading its points It first checks the point’s Location1 attribute to make sure that it matches the value of the "-id" startup command parameter It then looks in  the Extended Descriptor attribute for the OID (Object Identifier) specification;  the Extended Descriptor attribute for the community string information if the data is to be read from an SNMPv1 or SNMPv2c agent; or  the Extended Descriptor attribute for a username, authentication password, and privacy password if the data is to be read from an SNMPv3 agent;  the Instrument Tag attribute for the hostname/IP address of the SNMP Agent;  the Location2 attribute to determine whether to retrieve a value from the SNMP Agent or to set a value on the SNMP Agent SNMP Interface to the PI System What is a COUNTER Value? Some OID values are given in terms of a COUNTER A COUNTER is an unsigned 32bit integer ranging from to 4,294,967,295 When a COUNTER value reaches the maximum, it rolls over to In particular,  interfaces.ifTable.ifEntry.ifInOctets  interfaces.ifTable.ifEntry.ifOutOctets are both COUNTERs Therefore, if PI-SNMP stores the raw values for these OIDs, such values will be continuously increasing numbers up to the maximum A graphical trend of these numbers probably will not be meaningful Alternatively, you can configure PI-SNMP to store COUNTER values per unit time If Location2 is set to 1, PI-SNMP will store the difference between two successive readings divided by the scan time For example, scanned value = 2000 previous value = 200 scan time = minute stored value = (2000 – 200)/60 = 30 A graphical trend of such values will be more meaningful because it provides the number of octets transferred per second What is SNMPv3? SNMPv3 was drafted in response to the perceived security deficiencies of earlier SNMP specifications SNMPv3 adds authentication and privacy enhancements to the existing SNMP standard SNMPv3 uses a user-based security model instead of community strings, and SNMPv3 messages can be securely signed and encrypted using authentication and privacy passwords SNMP Interface to the PI System 73 Appendix E: Tutorial on Using PI-SNMP with Routers PI-SNMP is ideally suited for monitoring the performance of network routers By definition, a router is a device that connects two or more data networks and routes traffic among them Example cases Consider an organization with three departments: Sales, Accounting, and Engineering Each department’s computers are on its own separate network In addition, the company itself has a connection to the Internet via its ISP (Internet Service Provider) So, its network diagram may look like the following: Sales router ISP Accounting Engineering A typical provisioning of the interfaces on the router may be: Interface Description Speed Connection to Ethernet0 10 Mbps Sales Ethernet1 10 Mbps Accounting FastEthernet 100 Mbps Engineering Serial1/0 512 Kbps ISP Ethernet0 That is, Serial1/0 router Ethernet1 FastEthernet Another example is the case of the Internet Service Provider itself It too has a router, which directs traffic from an Internet backbone to its many customers: Customer1 SNMP Interface to the PI System 75 Internet router backbone Customer2 Customer3 A typical router provisioning may be: Interface Description Speed Connection to ATM2/0.1 512 Kbps Customer1 ATM2/0.2 384 Kbps Customer2 ATM2/0.3 384 Kbps Customer3 Serial2 1.544 Mbps Internet backbone That is, ATM2/0.1 Serial2 router ATM2/0.2 ATM2/0.3 A final example is the operation of the PI Universal Data Server/Data Archive receiving data from different areas of a plant, each with its own PI data collection interface program: PI-Foxboro PI Server router PI-Honeywell PI-Yokogawa SNMP Interface to the PI System 76 A typical router provisioning may be: Interface Description Speed Connection to Ethernet1 10 Mbps Foxboro area of the plant Ethernet2 10 Mbps Honeywell area of the plant Ethernet3 10 Mbps Yokogawa area of the plant Ethernet0 10 Mbps PI Server area of the plant That is, Ethernet1 Ethernet0 router Ethernet2 Ethernet3 SNMP and Interfaces Under SNMP, the interfaces in a router are indexed by an Object Identifier (OID) called ifIndex This index is a positive integer, and allows you to reference and correlate other interface OID variables (e.g., interface speed) The SNMP Agent on the router automatically assigns the value of ifIndex Examples of interface descriptions (interfaces.ifTable.ifEntry.ifDescr) and speeds (interfaces.ifTable.ifEntry.ifSpeed) in our first example are: ifIndex OID variable OID value OID=interfaces.ifTable.ifEntry.ifDescr.3 Serial1/0 OID=interfaces.ifTable.ifEntry.ifDescr.4 Ethernet0 OID=interfaces.ifTable.ifEntry.ifDescr.5 Ethernet1 100 OID=interfaces.ifTable.ifEntry.ifDescr.100 FastEthernet OID=interfaces.ifTable.ifEntry.ifSpeed.3 512,000 OID=interfaces.ifTable.ifEntry.ifSpeed.4 10,000,000 OID=interfaces.ifTable.ifEntry.ifSpeed.5 10,000,000 100 OID=interfaces.ifTable.ifEntry.ifSpeed.100 100,000,000 SNMP Interface to the PI System 77 Appendix E: Tutorial on Using PI-SNMP with Routers For the example ISP: ifIndex OID variable OID value 101 OID=interfaces.ifTable.ifEntry.ifDescr.101 ATM2/0.1 102 OID=interfaces.ifTable.ifEntry.ifDescr.102 ATM2/0.2 103 OID=interfaces.ifTable.ifEntry.ifDescr.103 ATM2/0.3 200 OID=interfaces.ifTable.ifEntry.ifDescr.200 Serial2 101 OID=interfaces.ifTable.ifEntry.ifSpeed.101 512,000 102 OID=interfaces.ifTable.ifEntry.ifSpeed.102 384,000 103 OID=interfaces.ifTable.ifEntry.ifSpeed.103 384,000 200 OID=interfaces.ifTable.ifEntry.ifSpeed.200 1,544,000 For PI Server receiving data, examples may be: ifIndex OID variable OID value OID=interfaces.ifTable.ifEntry.ifDescr.1 Ethernet0 OID=interfaces.ifTable.ifEntry.ifDescr.2 Ethernet1 OID=interfaces.ifTable.ifEntry.ifDescr.3 Ethernet2 OID=interfaces.ifTable.ifEntry.ifDescr.4 Ethernet3 OID=interfaces.ifTable.ifEntry.ifSpeed.1 10,000,000 OID=interfaces.ifTable.ifEntry.ifSpeed.2 10,000,000 OID=interfaces.ifTable.ifEntry.ifSpeed.3 10,000,000 OID=interfaces.ifTable.ifEntry.ifSpeed.4 10,000,000 Be aware that the value of ifIndex does not have to start at 1, and that these indices are not necessarily consecutive Also, note that the value for the OID variable interfaces.ifTable.ifEntry.ifSpeed.X, where X is an ifIndex value, reflects engineering units of bits per second Traffic monitoring In order to determine the amount of traffic traversing on a router’s particular interface (i.e., for ifIndex=X), you should look at the values for the following OID variables:  interfaces.ifTable.ifEntry.ifEntry.ifInOctets.X  interfaces.ifTable.ifEntry.ifEntry.ifOutOctets.X SNMP defines the former as the total number of octets (a group of bits) received on the interface, including framing characters The latter OID variable represents the total number of octets transmitted on the particular interface, including framing characters 78 For the given examples: Sales ifInOctets.4 ifOutOctets.4 router Customer1 router ifInOctets.101 ifOutOctets.101 PI-Foxboro router ifInOctets.2 ifOutOctets.2 These OID variables indicate the total number of octets received/transmitted However, you may be interested in the per unit time versions of these variables That is, you may want to know  the number of octets per second received on the interface  the number of octets per second transmitted on the interface PI-SNMP performs such a measurement for you if you configure a PI point with Location2 set to (Please see the main section of this manual for details.) So, for the three example scenarios cited above, you can use PI-SNMP to monitor the amount of traffic for each interface provisioned on the router Consequently, you can determine which department (e.g., Sales, Accounting, or Engineering), which customer (Customer1, Customer2, or Customer3), or which area of the plant (Foxboro, Honeywell, or Yokogawa) is utilizing the most bandwidth PI SNMP Tag Builder Plug-in for PI SMT 3.x As mentioned previously, the interfaces that are provisioned on a router are indexed by the ifIndex variable Correlating this interface index number (e.g., 4) to an interface description (e.g., Ethernet0) and other interface OID variables is often difficult For this reason, OSIsoft provides the PI SNMP Tag Builder plug-in for PI SMT 3.x Consult the plug-in documentation for details SNMP Interface to the PI System 79 Appendix F: PI-SNMP Technical Details Message Size For PI tags whose Location3 field is zero, PI-SNMP does not group multiple requests for information into a single SNMP GetRequest message In other words, the PDU (Protocol Data Unit) that PI-SNMP sends to a network device contains a GetRequest for only a single OID The size of such a message is of the order of 80 octets The size of a GetResponse PDU from the network device depends on the OID value requested, and can vary greatly For example, the value for system.sysDescr.0 returned by the network device may be a descriptor such as: IOS (tm) 3600 Software (C3660-DS-M), Version 12.0(5)T1, RELEASE SOFTWARE (fc1) Copyright (c) 1986-1999 by cisco Systems, Inc Compiled Thu 19-Aug-99 18:15 by cmong The above returned value by itself consists of 213 octets With the addition of the various headers (SNMP, UDP, IP), the size of the complete message is about 280 octets When PI-SNMP retrieves numeric values, the size of the returned message is also about 80 octets For comparison, a single PING message from a Windows machine contains about 64 octets Supported MIBs The current version of PI-SNMP supports textual OIDs for the following branches of the MIB-II (.1.3.6.1.2.1) tree:  system (1)  interfaces (2)  ip (4)  icmp (5)  tcp (6)  udp (7)  transmission (10)  snmp (11)  rmon (16) For example, the user may specify either system.sysUptime.0 or 1.3.6.1.2.1.1.3.0 in the Extended Descriptor field of the PI tag configuration However, OIDs from other branches of the MIB-II tree need to be configured with numeric values In particular, vendor specific OIDs (those which begin with SNMP Interface to the PI System 81 1.3.6.1.4.1) need to be specified in their numeric form When in doubt about the validity of a textual OID within PI-SNMP, use the snmpget program to confirm SNMP Interface to the PI System 82 Appendix G: ifAlias Support Re-assignment of Indices When a router reboots, the SNMP agent on this router often assigns a different index number to a particular instance of one of its interfaces For example, an interface named Serial1/0.1 has an ifIndex value of 25 Thus, the OID variable interfaces.ifTable.ifEntry.ifInOctets.25 represents the number of inbound octets received on this Serial1/0.1 interface Accordingly, you may have a PI tag called tag1 configured with an extended descriptor such as: OID_I=ifInOctets.25 After a router reboot, the Serial1/0.1 interface may be assigned an ifIndex of 31 Therefore, the number of inbound octets received on the interface is now given by the OID interfaces.ifTable.ifEntry.ifInOctets.31 However, the tag tag1 is still configured with an extended descriptor containing the ifIndex of 25 As a result, tag1 is no longer is collecting data for Serial1/0.1 In addition, you yourself may have difficulty realizing that the ifIndex for Serial1/0.1 has changed from 25 to 31 Non-volatile Feature of ifAlias RFC 2233 specifies that if an SNMP agent supports the ifAlias OID variable, then its value must not change during a router reboot: the ifAlias name is non-volatile, and thus an interface must retain its assigned ifAlias value across reboots, even if an agent chooses a new ifIndex value for the interface Thus, if your router supports ifAlias, you can configure PI-SNMP so that it will collect correct data even after a router reboot To find out whether your router supports ifAlias, run a command such as the following: C:> snmpwalk -M \mibs 10.8.10.1 public 1.3.6.1.2.1.31.1.1.1.18 For the above commands, use the IP address of your router and the correct community string If the above command results in items similar to ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias.1 = to ISP ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias.2 = to LAN ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias.3 = remote office then your router supports ifAlias If the results not contain ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias then your router doses not support ifAlias SNMP Interface to the PI System 83 Data Collection Based on ifAlias To collect data based on ifAlias, you specify in the Extended Descriptor OID_I=ifInOctets (to retrieve inbound traffic values) or OID_I=ifOutOctets (outbound traffic) You not specify the interface index number You must also specify the value of the ifAlias for the particular interface The keyword is IFALIAS For the above example ifAlias values, to collect inbound traffic values for the network interface that represents “to LAN”, put OID_I=ifInOctets; IFALIAS="to LAN" into the Extended Descriptor of a PI tag such as tag1 (Note that you must use double quotes because of the space between “to” and “LAN”.) During data retrieval for tag1, PI-SNMP obtains all the ifAlias names from the router It then matches the IFALIAS value of tag1 with these ifAlias names to determine the interface index number In this example, the interface number is PI-SNMP then internally constructs the OID interfaces.ifTable.ifEntry.ifInOctets.2 and sends the appropriate request to the router If the router reboots and the SNMP agent reassigns interface indices such that ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias.1 = remote office ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias.2 = to ISP ifMIB.ifMIBObjects.ifXTable.ifXEntry.ifAlias.3 = to LAN PI-SNMP still reads correct values for tag1 because it will now internally construct the OID interfaces.ifTable.ifEntry.ifInOctets.3 in order to get the data from the router Configuration To configure PI-SNMP to use ifAlias based data collection, specify –device= on the startup command file, with the value of this parameter being the IP address or name of the router For example, pisnmp –ps=$ -id=1 –host=localhost:5450 –device=10.8.10.1 … PI-SNMP needs to retrieve the various ifAlias names at startup Thus, it needs the community string of the router You specify this community string via the pisnmp.pwd file For example, host=10.8.10.1; CS=public; community string for 10.8.10.1 Limitations Because you need to specify a particular router (via device=) at PI-SNMP startup, this configuration limits data collection to a single device Also, for simplicity, PI-SNMP groups all tags into sets, regardless of the value of Location3 Finally, the specified router must also support the OID system.sysUptime.0 If this OID is not supported, PI-SNMP exits SNMP Interface to the PI System 84 Summary Run one of the following to determine whether your router supports ifAlias: snmpwalk -M \mibs 10.8.10.1 public 1.3.6.1.2.1.31.1.1.1.18 snmpwalk -M /mibs 10.8.10.1 public 1.3.6.1.2.1.31.1.1.1.18 Configure PI tags with Extended Descriptors containing OID_I=ifInOctets; IFALIAS="ifAlias_name_of_the_interface" or OID_I=ifOutOctets; IFALIAS="ifAlias_name_of_the_interface" The former specifies data collection for inbound traffic while the latter outbound traffic Note that you not specify the interface index number Specify the router by adding –device= to the startup command line For example, pisnmp –ps=$ -id=1 –host=localhost:5450 –device=10.8.10.1 … The Extended Descriptor need not contain the host= specification because all data comes from the router specified by –device= on the startup command line The Extended Descriptor need not contain the CS= specification because PI-SNMP uses the community string in the pisnmp.pwd file So, you need to configure this file accordingly PI-SNMP groups all tags into sets, regardless of the value of Location3 The router must support the OID system.sysUptime.0 Otherwise, PI-SNMP exits You may still specify non-interfaces tags For example, you can configure a tag with an Extended Descriptor OID=system.sysUptime.0; to retrieve the uptime of the router SNMP Interface to the PI System 85 Appendix H: Known Issues Restart of SNMP Agent When an SNMP Agent restarts (e.g., after a reboot of the network device), it generally resets all COUNTER variables to zero Such a restart will result in a subsequent value for PI tags configured as time-normalized values (i.e., with Location2=1) not being correct Consider the following example for PI_tag1, which is configured for the OID interfaces.ifTable.ifEntry.ifInOctets.1: During the case of a normal operation (i.e., no SNMP Agent restart), if PI-SNMP is configured for minute scan intervals on the hour (-f=00:05:00,00:00:00) and the OID values on the network device and scan times are: 08:00:00 (a scan time for PI-SNMP) OID value = 400,000 (value x) 08:02:59 (not a scan time for PI-SNMP) OID value = 500,000 (value y) 08:05:00 OID value = 600,000 (value z) The number of octets received during the above 5-minute time interval is 200,000 (z -x) Thus, the time-normalized value—and that which is stored in PI_tag1—is 666.67 (200,000/300) octets/second If an SNMP Agent were to restart between PI-SNMP scans: 08:00:00 (a scan time for PI-SNMP) OID value = 400,000 08:03:00 (SNMP Agent restart, and not a scan time for PI-SNMP) OID value = because of an SNMP Agent restart 08:05:00 (a scan time for PI-SNMP) OID value = 100,000 For this situation, PI-SNMP determines that the number of octets received during this 5-minute interval is 4,294,667,296 (100,000 - 400,000 = –300,000, or Hexadecimal FFFB6C20; for an unsigned value, this is 4,294,667,296.) Meanwhile, because of the possibility of the above situation, the user should configure a tag that records system.sysUptime.0 for each of the network devices that are providing data to PI-SNMP In this manner, the user will know the approximate time at which the SNMP Agent restarted If a user knows beforehand that an SNMP Agent will restart (for example, because of the need to reboot a router), he should first stop the PI-SNMP program He can then rerun PI-SNMP after the restart of the SNMP Agent SNMP Interface to the PI System 87 Appendix I: Acknowledgments Portions of this program utilize the work of Carnegie Mellon University and the University of California Copyright 1989, 1991, 1992 by Carnegie Mellon University Derivative Work Copyright 1996, 1998, 1999, 2000 The Regents of the University of California All Rights Reserved CMU AND THE REGENTS OF THE UNIVERSITY OF CALIFORNIA DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS IN NO EVENT SHALL CMU OR THE REGENTS OF THE UNIVERSITY OF CALIFORNIA BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM THE LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE Portions of this program are Copyright (c) 1998-2004 The OpenSSL Project All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution All advertising materials mentioning features or use of this software must display the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)" The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products derived from this software without prior written permission For written permission, please contact openssl-core@openssl.org Products derived from this software may not be called "OpenSSL" nor may “OpenSSL" appear in their names without prior written permission of the OpenSSL Project Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)" SNMP Interface to the PI System 89 THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED IN NO EVENT SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution All advertising materials mentioning features or use of this software must display the following acknowledgement: "This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)" The word 'cryptographic' can be left out if the routines from the library being used are not cryptographic related :-) If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement: "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" SNMP Interface to the PI System 90 Revision History Date Author Comments 8-Sep-2003 E Tam Interface v1.2.0.0; used skeleton v1.12 3-Oct-03 Chrys Fixed some typos 25-Oct-2003 E Tam change version to be v1.2.0.2 14-May-2004 T Johnson SNMPv3 support 25-Oct-04 T Johnson New command line parameters, new ICU control, pisnmputil replaced with SMT 3.x plug-in, acknowledgments 08-Nov-2004 E Tam SNMP SETs (PI outputs) and –out startup parameter 18-Nov-2004 E Tam Updated ICU control screenshot (-out parameter) 10-Jan-05 T Johnson Version 1.3.0.4 15-Feb-05 T Johnson Rev B: Revised SMT3 Tag Builder info 16-Feb-05 Chrys Version 1.3.0.4 Rev C: changed note that tag builder is part of interface install; made minor format changes; moved common problems into error section; fixed section breaks 18-Feb-05 MPK Fixed sample pisnmp.bat file to correct placement of quotes around the /stopstat=”Intf Shut” parameter SNMP Interface to the PI System 91 ... C:pipcinterfaces snmp pisnmp.exe C:pipcinterfaces snmp pisnmp.pdb C:pipcinterfaces snmp pisnmp.pwd C:pipcinterfaces snmp snmpget.bat.new C:pipcinterfaces snmp snmpget.exe C:pipcinterfaces snmp snmpwalk.bat.new... result: C:pipcinterfaces snmp mibs*.txt C:pipcinterfaces snmp libsnmp.dll C:pipcinterfaces snmp pi_ pisnmp.doc C:pipcinterfaces snmp pi_ pisnmp_x.x.x.x.txt C:pipcinterfaces snmp pisnmp.bat.new... result: C:pipcinterfaces snmp_ basic pi_ pisnmp.doc C:pipcinterfaces snmp_ basic pi_ pisnmp_x.x.x.x.txt C:pipcinterfaces snmp_ basicpisnmp_basic.bat.new C:pipcinterfaces snmp_ basicpisnmp_basic.exe