Table Of Contents ADVENTNET SNMP UTILITIES... 4 QUICK TOUR... 5

Transcription

1

2 Table Of Contents ADVENTNET SNMP UTILITIES... 4 QUICK TOUR... 5 About AdventNet SNMP Utilities... 6 Contacting AdventNet... 7 Other AdventNet Products... 9 SNMP and MIB Basics SNMP Overview...12 Versions of SNMP...16 SNMPv3 Overview...18 MIB Overview...21 RELEASE NOTES Release Features Third Party Software Package Structure INSTALLATION GUIDE System Requirements Installation and Setup License Manager GETTING STARTED Using Launcher Launcher UI...39 Configuring and Running Applications...41 Viewing Logs...45 Using Applications Using Applets Update Manager MIBBROWSER Starting Up Invoking Application...55 Invoking Applet...56 Configuration Setting Common Parameters...59 Setting MIB Parameters...64 MIB OPERATIONS Loading MIBs...66 Unloading MIBs...71 Parsing MIBs...72 AdventNet, Inc. 1

3 SNMP OPERATIONS SNMP GET...75 SNMP GETNEXT...77 SNMP WALK...78 SNMP GETBULK...79 SNMP SET...80 TABLE HANDLING Retrieving Table Data...83 Adding Rows...87 Deleting Rows...89 Graphs Line Graph...91 Bar Graph...94 Trap Handling Internationalization Debugging and Decoding Error Messages TRAP VIEWER Viewing Traps Viewing INFORMS Trap Mailer Parsing Traps Creating Parser Files Editing Parser Files PROXY FORWARDER CONFIGURATOR Agent Configuration User Configuration VACM Configuration PROXY FORWARDER I18N EDITOR SNMP DECODER SASERVER-WEBSERVER EXAMPLES Setting Up the Environment SNMP GET SNMP GETNEXT SNMP GETBULK SNMP SET Send v1 Traps AdventNet, Inc. 2

4 Send Notifications Send Inform Request Receive Inform Request Trap Receiver FAQS General MibBrowser Trap Viewer SAS and Web Server KNOWN ISSUES AND LIMITATIONS APPENDIX Using Help How to Use This Help Conventions Used Parsing MIBs Parsing Levels Checks for Various Parsing Levels Checks in Detail AdventNet, Inc. 3

5 AdventNet SNMP Utilities The AdventNet SNMP Utilities is a SNMP network management utility consist of set of cross-platform applications and applets for web based network management. These utilities can be used for device, element, application, and system management. These tools can communicate and interact with any SNMP-enabled device. Quick Tour Release Notes Installation Guide Getting Started MibBrowser Trap Viewer Proxy Forwarder Configurator Proxy Forwarder I18N Editor SNMP Decoder SAServer-WebServer Examples FAQs Known Issues and Limitations Appendix AdventNet, Inc. 4

6 Quick Tour About AdventNet SNMP Utilities Contacting AdventNet SNMP and MIB Basics This section lists the various features of the product which makes the AdventNet SNMP Utilities the most comprehensive package in the field of SNMP-based network management. It also gives you an overview of the basic concepts of SNMP and MIBs. AdventNet, Inc. 5

7 About AdventNet SNMP Utilities AdventNet SNMP Utilities is a set of cross-platform applications and applets for SNMP and web based network management. These utilities can be used for device, element, application, and system management. The following tools can communicate and interact with any SNMP-enabled device. MibBrowser - used to view and operate on data available through a (UDP/TCP) SNMP agent on a managed device. Trap Viewer - used to parse and view the received traps. Proxy Forwarder Configuration tool - tool for configuring USM user tables and VACM entries for SNMPv3 agent. Proxy Forwarder - used to translate SNMPv3 request for SNMPv1 and v2c agents. i18neditor - used for internationalization. SNMP Decoder - used to view the decoded output of the debug information. WebServer and SAS Server - facilitates the use of SNMP management applets. These tools can be used to manage SNMPv1, SNMPv2c, and SNMPv3 agents (i.e. the tools are multi-lingual) and talk to managed devices using any of the three versions of the SNMP protocols at the same time. MibBrowser and TrapViewer are available both as applications and applets. While the applications can be used as standalone executables, the applets can be remotely accessed via a web browser with the Java plug-in in any Java enabled web browser. The AdventNet SNMP utilities comes integrated with a web server to facilitate this. The SNMP Utilities supports All the three versions of the SNMP specification i.e. v1 (RFC1157), v2c (RFC1901,RFC2578), and v3 (RFC3411, RFC3412) USM (User based Security Model - RFC3414) and VACM (View based Access Control Model - RFC3415) definitions for SNMPv3 MIB definitions as defined in SMIv1 (RFC1155) and SMIv2 (RFC3418) formats Communication between applets and managed devices (through SNMP Applet Server) where direct communication is prohibited due to applet security policies Ability to plot real time graphs Viewer for large SNMP Tables, with sorting, graphing, etc. AdventNet, Inc. 6

8 Contacting AdventNet AdventNet, the Internet Management Infrastructure Company is the leading provider of open, scalable, extensible, and cross-platform management solutions for managing the Internet and e- commerce infrastructure. AdventNet's solutions ranges in scope from optical and core internetworking management systems, Cable Modem, DSL, Storage, Security Management to E-Commerce application management. In each of these fast-growing markets, AdventNet is the leading provider of technology. AdventNet is eager to hear your comments, feedback, and suggestions that would help improve our products. We give you the contact information of our Corporate Headquarters,Sales, and Technical support teams. We also provide the link to subscribe to the Java network management mailing list. During the evaluation phase, AdventNet provides support "at no cost". This support includes access to our product specialists for problem resolution, clarifications in documentation, and technical guidance. Feel free to send in your queries. We guarantee to respond as quickly as possible to make your evaluation a success. Corporate Headquarters Web Site AdventNet Headquarters AdventNet Development Centre AdventNet, Inc Franklin Dr, Suite 115 Pleasanton, CA USA Phone : Fax : [email protected] AdventNet Development Centre (I) Pvt. Ltd. Sree Narayana Complex 11 Sarathy Nagar Velachery, Chennai INDIA Phone : [email protected] Sales For sales and product licensing inquiries, please use the contact information available in the following URL. You can also contact the AdventNet Headquarters at: Phone: Fax: or send to [email protected]. Technical Support For support and bug-report, please mail to [email protected]. For those with support contracts, AdventNet provides priority support through with a reply usually within 24 hours. Please provide the following information while sending support mails. Release version of the product (AdventNet SNMP Utilities) Operating System and version JDK / JRE version AdventNet, Inc. 7

9 Browser and Browser versions. Stack traces, if any Debug messages or hex dumps, if any Log Files (if any) CLASSPATH environment variable, if applicable Any other related information This helps us provide faster responses to your query. Feedback We welcome your feedback that will help us improve the Product and provide future enhancements. Send your feedback to: AdventNet, Inc. 8

10 Other AdventNet Products AdventNet provides a comprehensive range of network management products that can address all the network and system management needs of your organization. The following is our comprehensive portfolio of development tools. Visit our Web site for all the latest information on our products. Few of them mentioned below. EMS, NMS, Provisioning, and OSS Systems : AdventNet Web NMS is the industry-leading network management model / framework for building custom OEM software such as Element, Network and Systems Management (EMS / NMS) applications. Networking equipment vendors and other management solution providers can rely on AdventNet Web NMS for building OEM software for network management such as EMS and NMS. Management APIs : AdventNet SNMP API is an industry leading development environment for building cross platform, Java and Web based management applications, applets and mediation frameworks. The product can be used to build system management, application management, and network management applications and applets. It includes class libraries and Java Beans for Java SNMP development, as well as a complete MIB Browser for interacting with SNMP enabled devices. AdventNet TL1 API comprises of a set of Java libraries for developers seeking to leverage the power of Java and other Internet technologies in quickly delivering Java and Web-based solutions for managing TL1 devices. It provides a good base to build network management products and solutions for TL1 device management. AdventNet CLI API consists of low-level, high-level, and distributed APIs. The low-level API consists of Java classes that implement the core CLI functionality including the communication framework enabling the user to access the CLI API. The high-level APIs make the development of network management applications easier using the CLI libraries, where as the distributed functionality is carried out by RMI API. AdventNet Agent Java/JMX Edition is a rapid prototyping and development tool for building agents based on Java Management Extensions - JMX framework with multiprotocol access to common management instrumentation, including SNMP, HTML, RMI, HTTP, CORBA, and TL1. You just have to instrument once to access any protocol. AdventNet Agent toolkit - C Edition is a rapid prototyping and development tool for building ANSI C,C++ based agents, best suited for device and System Management. The run-time agent is very modular, portable, and customizable. The toolkit provides multiple protocol (SNMP, HTTP, TL1 and other protocol) access to common instrumentation, called Multi-Protocol Agent (MPA). Simulating Networks and Systems : AdventNet Simulation Toolkit is a comprehensive set of tools for creating a simulated environment. It not only supports setting up a simulated agent but also simulating an entire network in Windows, Linux, and Solaris. Enterprise Management Products : AdventNet ManageEngine Applications Manager is an enterprise-ready and affordable applications management software which facilitates application server monitoring, database monitoring, server monitoring, website monitoring, service management, and custom application monitoring. AdventNet, Inc. 9

11 AdventNet ManageEngine OpManager is a complete network monitoring software that offers combined WAN, Server, Applications monitoring with integrated help desk, asset management & WAN traffic analysis functionality. OpManager automates several network monitoring tasks and removes the complexity associated with network management. AdventNet ManageEngine NetFlow Analyzer is a web-based bandwidth monitoring tool that uses Cisco NetFlow & Cisco NBAR data exported from routing devices, to analyze network traffic and report on bandwidth usage across the network. AdventNet ManageEngine OpUtils is a comprehensive set of 45+ unique system and network monitoring tools. This web-based software helps network engineers monitor, diagnose and troubleshoot their IT resources. Software Testing Applications : AdventNet QEngine is a complete automated web testing tool for functional testing, performance testing, load testing, web services testing and regression testing of web applications and web services. It helps application development teams to produce quality software by test automation. AdventNet, Inc. 10

12 SNMP and MIB Basics SNMP Overview Versions of SNMP SNMPv3 Overview MIB Overview This section gives an overview of SNMP and MIB basics. More Information If you would like to learn more about the network management or SNMP, we would recommend you taking a look at the following sites for more information. SNMP FAQ available at Network management available at AdventNet, Inc. 11

13 SNMP Overview A network provides ease of communication between computers. To use networks effectively, we need a set of rules by which all the networks should abide. The set of rules is called protocols. Simple Network Management Protocol (SNMP) is one among the various protocols that defines messages related to network management. In simple terms, SNMP is a primary protocol, used in the transfer of network management information between two or more network entities or nodes. Let us get to know more about SNMP and its features in the following sections. Need for SNMP Evolution Advantages Features Basic Operations Need for SNMP Network Management is all about keeping the network up and running, monitoring, and controlling network devices using conventional network technology. Local management and remote management are the two ways of managing a device connected to a network. Local management demands for a human manager where the managed object is situated. When the network devices are more and the network is widespread, management becomes tedious and impossible. Therefore, there arises the need to manage the network remotely. This is enhanced by SNMP. Using SNMP, one workstation running one or more management software applications can monitor management information collected by thousands of network devices. This information is used to establish the functioning of the network and also to identify the problems in the network. Evolution The ARPANET was the first research network sponsored by the United States Department of Defense (DOD), which connected many universities and government installations using leased telephone lines. When satellite and radio networks were added, trouble brewed and to resolve it, TCP/IP came into existence. This facilitated the connection of multiple networks in a seamless way. On Jan , TCP/IP became the only official protocol used by the DOD that marked a decline of the ARPANET. It was then Internet came into existence. Sometime in the mid-1980s, the growth of Internet was rapid, but there were no standardized network management models. Later, the three models were formulated: the High-Level Entity Management System (HEMS); the Common Management Information Protocol (CMIP) proposed by the Open Systems Interconnection (OSI), a group of International Standards Organization (ISO); and the Simple Gateway Monitoring Protocol (SGMP). CMIP over TCP was formed by the ISO as the actual network management protocol to be used for the Internet. In February 1988, the then Internet Architecture Board (IAB) convened an ad hoc committee to determine which of the three models should be used. It was then decided that CMOT would be a natural choice. The SGMP was the short-term solution before CMOT was distributed. For an effective transition of systems from SGMP to CMOT, a common network management framework had to be developed that would be used by both the models. This framework was named the Simple Network Management Protocol (SNMP). In April 1989, SNMP was promoted and given a recommended status as the de facto TCP/IP network management framework by the IAB. By then, there were problems between CMOT and SNMP, which led to their independent developments. In AdventNet, Inc. 12

14 May 1990, on reaching a consensus, IAB promoted SNMP as the standard network management protocol and a framework recommended for use on Internet and on all TCP/IP networks. Advantages As the name goes, the protocol is quite simple because it is easy to understand and the agent requires only minimal software. It is this simplicity that serves as a key reason for its widespread acceptance, besides being the chief Internet standard for network management. Implementing SNMP management in a networked device is far more straightforward than most other approaches to network management. Some of the benefits you derive on using SNMP are as follows. Standardized protocol: SNMP is the standard network management protocol for TCP/IP networks. Internet Protocols are open, nonproprietary standards developed through voluntary efforts by the Internet community, so is the SNMP that is actively maintained and all future enhancements to SNMP are based on existing protocol standards. Universal acceptance: All major vendors support SNMP. All SNMP-managed devices use the same type of management interface to support a common set of network management information. Portability: SNMP is independent of operating system and programming language. The functional design of SNMP is also portable and it defines a core set of operations that must function identically in all devices that support SNMP. Lightweight: SNMP facilitates the addition of management capability to a device without impacting the operation of the device or its performance. SNMP management may be added to a network device with very little increase in workload and demand on system resources. Extendibility: SNMP is a core set of operations that remain the same on all managed devices. SNMP has the capability of supporting any type of information on any type of device that may be part of any type of computer network. Widely deployed: SNMP is one of the most popular protocols in the protocol suite that every vendor is aware of. This popularity serves as one dominant factor for its wide deployment by the vendors. Features The three major components of the SNMP that form an integral part of its foundation are the network device, the agent and the manager. The figure below depicts the relationship between them. Network device: A network device or the Managed Object is a part of the network that requires some form of monitoring and management. Agent: An agent is a mediator between the manager and the device. The agent resides inside the network device. It collects the management information from the device and makes it available to the manager. It is to be understood that an agent is a program that resides in the device and is not a separate entity. A typical agent Implements full SNMP protocol. Stores and retrieves management information as defined in the MIB. Collects and maintains information about its local environment. Signals an event to the manager. Acts as a proxy for some non-snmp manageable network node. Manager: A manager or management system is a separate entity that manages the agents from a remote place. This is typically a computer that is used to run one or more network management AdventNet, Inc. 13

15 systems. Consider an organization having its branches in different geographical locations. Administration of all the computers present in different localities would be difficult. When the System Administrator s computer is installed with the manager and all other systems and devices across all the offices are installed with the agent, management becomes easier. The administrator has to just query the agent through its manger to know the functioning of the device. A typical manager Implements the network management system. Implements full SNMP protocol. Queries agents, gets responses from agents, sets variables in agents, and acknowledges asynchronous events from agents. Communication Between the Manager and Agent: The communication between the manager and the agent in the network is enabled by means of Protocol Data Units (PDUs). These PDUs allow the manager to interact with the agent in the device. The extent of management possible depends on the data available to the manager from the agent. Before data can be transported across the network, it must be passed down the network mass and encapsulated. PDUs are encapsulated in the User Datagram Protocol (UDP). UDP is a connectionless transport protocol included in the TCP/IP suite and described in RFC 768. The SNMP network management is composed of three parts to which both the management applications and agents conform. They are: The protocol, which defines the functioning of the basic operations of SNMP and the format of the messages exchanged by management systems and agents. Structure of Management Information (SMI), which is a set of rules used to specify the format for defining managed objects or the devices that are accessed using SNMP. Management Information Base (MIB) is a collection of definitions, which define the properties of the managed object or the device. The MIB modules and the SMI are expressed using a text-based data description notation called as Abstract Syntax Notation One (ASN.1), which is an unambiguous description of data in an ASCII text format. The MIB data is conveyed across a network using SNMP messages, which are encoded using Basic Encoding Rules (BER). They are similar to SMI, but the messages are encoded in a binary format. Both the ASN.1 and BER are essential for the implementation of SNMP. Basic Operations SNMP is a request-and-response protocol. The basic SNMP operations performed are categorized as follows. Retrieving data Altering variables Receiving unsolicited messages Retrieving data: The manager sends a request to an agent to retrieve data by performing the following operations. GET: The GET operation is a request sent by the manager to the managed object. It is performed to retrieve one or more values from the managed objects. GETNEXT: This operation is similar to the GET operation. The significant difference is that the GETNEXT operation retrieves the value of the next OID in the tree. GETBULK: The GETBULK operation is used to retrieve voluminous data from large table. AdventNet, Inc. 14

16 Altering variables: At times, the manager might want to change the value of a variable. SET: This operation is used by the managers to modify the value of the network device. Receiving unsolicited messages: The agent, when faced by problems in the transmission of message, responds to the manager by sending unsolicited messages by using the TRAP operation. AdventNet, Inc. 15

17 Versions of SNMP Internet Engineering Task Force (IETF) publishes documents that are called Requests For Comments (RFCs). These documents specify standards, operational practices, opinions, humor, etc. for the Internet protocol suite. The different versions of SNMP are the SNMPv1, SNMPv2c, and SNMPv3. The following is a snippet of each version and it is followed by a detailed comparative overview of the versions. SNMPv1: This is the first version of the protocol, which is defined in RFCs 1155 and SNMPv2c: This is the revised protocol, which includes enhancements of SNMPv1 in the areas of protocol packet types, transport mappings, MIB structure elements but using the existing SNMPv1 administration structure ("community based" and hence SNMPv2c). It is defined in RFC 1901, RFC 1905, RFC 1906, RFC2578. SNMPv3: SNMPv3 defines the secure version of the SNMP. SNMPv3 also facilitates remote configuration of the SNMP entities. It is defined by RFC 1905, RFC 1906, RFC 3411, RFC 3412, RFC 3414, RFC The AdventNet SNMP Utilities distribution supports all the three versions of the SNMP. The communication and MIB portions of the AdventNet SNMP Utilities conform to the following Internet RFC specifications. SNMPv1 - RFC1155 and RFC1157 SNMPv2c - RFC1901,RFC1907, RFC2578 SNMPv3 - RFC3411 and RFC3412 SNMPv3 USM - RFC3414 SNMPv3 VACM - RFC3415 Overview of SNMP Versions SNMPv1 was the standard version of SNMP. The SNMPv2 was created as an update of SNMPv1 with several features. The key enhancements of SNMPv2 are focused on the SMI, Manager-tomanager capability, and protocol operations. The SNMPv2c combined the community-based approach of SNMPv1 with the protocol operation of SNMPv2 and omitted all SNMPv2 security features. One notable deficiency in SNMP was the difficulty in monitoring networks, as opposed to nodes on networks. A substantial functional enhancement to SNMP was achieved by the definition of a set of standardized management objects referred to as the Remote Network Monitoring MIB (RMON MIB) objects. Another major deficiency in SNMP was the complete lack of security facilities. The development of SNMPv3 was based on the security issues. SNMPv3 defines two security-related capabilities, namely USM and VACM. SNMPv1 and SNMPv2c SNMPv2c provides several advantages over SNMPv1. SNMPv2c has expanded data types of 64-bit counter. It calls for improved efficiency and performance by introducing the GETBULK operation. Confirmed event notification is sought by the introduction of the Inform operator. Enhanced error handling approach, improved sets, and a fine tuned Data Definition Language are some of the advantages of SNMPv2c over the SNMPv1. AdventNet, Inc. 16

18 SNMPv1 and SNMPv3 The SNMPv1 framework distinguishes between application entities and protocol entities. In SNMPv3, these are renamed as applications and engines respectively. The SNMPv1 framework also introduces the concept of an authentication service supporting one or more authentication schemes. In SNMPv3, the concept of an authentication service is expanded to include other services, such as privacy. The SNMPv1 framework introduces access control based on a concept called an SNMP MIB view. The SNMPv3 framework specifies a fundamentally similar concept called view-based access control. SNMPv1, SNMPv2c, and SNMPv3 Both the versions v1 and v2c lack the following security-related features. Authentication Privacy Authorization and access control Remote configuration and administration capabilities SNMPv3 was formed mainly to address the deficiencies related to security and administration. AdventNet, Inc. 17

19 SNMPv3 Overview Due to lack of security with the use of SNMP, network administrators were using other means, such as telnet for configuration, accounting, and fault management. SNMPv3 addresses issues related to the large-scale deployment of SNMP, accounting, and fault management. Currently, SNMP is predominantly used for monitoring and performance management. SNMPv3 defines a secure version of SNMP and also facilitates remote configuration of the SNMP entities. Primary Goals of SNMPv3 1. To verify that each received SNMP message has not been modified during its transmission through the network. 2. To verify the identity of the user on whose behalf a received message claims to have been generated. 3. To detect received messages that contain management information, whose time of generation was not recent. 4. To assure that the contents of each received message are protected from disclosure. Comparative Overview of SNMPv3 with SNMPv1 and SNMPv2c SNMPv1 and SNMPv2c have a wide deployment base covering the following. A platform-independent data definition syntax - A subset of ASN.1 A platform-independent data transfer notation - BER Communication between the peer entities - SNMP communication protocol with message formats, message types, etc. o Message contains the SNMP version o Message contains the community string which is used to provide some security Guidelines for definition of management data - SMI Management data definition repository - The MIB files SNMPv3 provides a secure environment for the management of systems covering the following. Identification of SNMP entities to facilitate communication only between known SNMP entities - Each SNMP entity has an identifier called the SNMPEngineID, and SNMP communication is possible only if an SNMP entity knows the identity of its peer. Traps and Notifications are exceptions to this rule. Support for security models - A security model may define the security policy within an administrative domain or an intranet. SNMPv3 contains the specifications for USM. Definition of security goals where the goals of message authentication service include protection against the following. o Modification of Information - Protection against some unauthorized SNMP entity altering in-transit messages generated by an authorized principal. o Masquerade - Protection against attempting management operations not authorized for some principal by assuming the identity of another principal that has the appropriate authorizations. o Message Stream Modification - Protection against messages getting maliciously reordered, delayed, or replayed to effect unauthorized management operations. o Disclosure - Protection against eavesdropping on the exchanges between SNMP engines. AdventNet, Inc. 18

20 Specification for USM - USM consists of the general definition of the following communication mechanisms available. o Communication without authentication and privacy (NoAuthNoPriv). o Communication with authentication and without privacy (AuthNoPriv). o Communication with authentication and privacy (AuthPriv). Definition of different authentication and privacy protocols - Currently, the MD5 and SHA authentication protocols and the CBC_DES and CFB_AES_128 privacy protocols are supported in the USM. Definition of a discovery procedure - To find the SNMPEngineID of an SNMP entity for a given transport address and transport endpoint address. Definition of the time synchronization procedure - To facilitate authenticated communication between the SNMP entities. Definition of the SNMP framework MIB - To facilitate remote configuration and administration of the SNMP entity. Definition of the USM MIBs - To facilitate remote configuration and administration of the security module. Definition of the VACM MIBs - To facilitate remote configuration and administration of the access control module. The SNMPv3 focuses on two main aspects, namely security and administration. The security aspect is addressed by offering both strong authentication and data encryption for privacy. The administration aspect is focused on two parts, namely notification originators and proxy forwarders. SNMPv3 defines two security-related capabilities, namely the USM and VACM. USM provides authentication and privacy (encryption) functions and operates at the message level. VACM determines whether a given principal is allowed access to a particular MIB object to perform specific functions and operates at the PDU level. SNMPv3 Message Format The SNMPv3 message consists of the following fields. 1. msgversion - This field contains the SNMP message version. A value 0 is an SNMPv1 message, 1 is an SNMPv2c message, 2 is an SNMPv2 message, and 3 is an SNMPv3 message. The value of message version is used to choose between the different message processing models (SNMPv1, SNMPv2c, or SNMPv3) available in the SNMP engine/entity. The following fields are part of the SNMPv3 message and are not available in the SNMPv1 or SNMPv2c message. 2. msgid - This field contains the SNMP message identifier. This is the unique ID associated with the message. The msgid field is different from the reqid field available in the PDU. It is possible that a received PDU that is part of a message cannot be decoded due to security parameters between the SNMP entities. The msgid is used to relate the request with a response during a transaction. 3. msgmaxsize - This field gives the maximum size of the message which the requesting SNMP entity can accept. 4. msgflags - This field contains the message security level. The bit 0 of msgflags indicates whether a message is authenticated. The bit 1 indicates whether a message uses privacy. The bit 2 indicates whether a report PDU is expected for the message (in case the message is dropped or a response cannot be generated). 5. msgsecuritymodel - This field indicates the security model used to generate the message. It has a value of 3 when USM is used. 6. msgengineid - This field has the SNMPEngineID of the authoritative SNMP entity involved in the transaction. When a request PDU is generated from an SNMP engine, the remote peer (agent for Get request and manager for Trap request) is the authoritative SNMP entity. AdventNet, Inc. 19

21 7. msgengineboots - This field indicates the number of times the authoritative SNMP entity has booted. This field is used in authenticated message to validate the timeliness of a message. 8. msgenginetime - This field indicates the time since the authoritative SNMP entity has been rebooted. This field is used in authenticated messages to validate the timeliness of a message. 9. msgusername - This field contains the principal who originated the request. The fields msgusername and the msgengineid are used to locate the security data associated with the message from the USM database. This security data is used to authenticate and process the message. 10. msgsecurityparams - This field contains the security parameters that are security model dependent. It contains the authentication parameters and the privacy parameters for USM. For an AuthPriv message, the authentication parameter has the digest computed for the message using the authentication protocol applicable for the USM entry and the privacy parameter has the salt generated, while encrypting the message using the privacy protocol applicable to the USM entry. 11. contextengineid - Within an administrative domain, the contextengineid uniquely identifies an SNMP entity that may realize an instance of a context with a particular contextname. 12. contextname - A contextname is used to name a context. Each contextname must be unique within an SNMP entity. 13. pdu - The SNMP PDU (Protocol Data Unit) is used for communication between the SNMP entities. PDU encapsulates the SNMP request ID, error status, variable bindings, and so on. There are different types of PDUs, such as GetRequest-PDU, GetNextRequest-PDU, GetBulkRequest-PDU, Response-PDU, SetRequest-PDU, Trap-PDU, InformRequest-PDU, SNMPv2-Trap-PDU, and Report-PDU. The exact format of the PDU depends on the type of the PDU. AdventNet, Inc. 20

22 MIB Overview Management Information Bases (MIBs) are a collection of objects or definitions that define the properties of the managed objects. To enable the SNMP manager or management application to operate intelligently on the data available on the managed device, the manager needs to know the names and types of objects in the device. This is made possible by the MIB modules, which are specified in the MIB files usually provided with managed devices. It should be understood that MIB is only an abstraction of data and not a physical database or a physically executable object. The following sections are dealt with in detail in this topic. Evolution Object Identifiers MIB Objects Object Identifiers with Instance Indexes SMI Evolution IAB recommended a two-pronged strategy for the development of Internet network management standards. The SNMP was used in the short run and the use of OSI network management framework was examined in the long run. On this basis, two documents were created, which defined the SMI and MIB. The documents were framed to be compatible with both the SNMP and OSI network management framework. In the short run, this strategy proved successful. However, the report of the Second Ad Hoc Network Management Review Group stated that the SNMP and OSI framework did not fulfill the exact requirements. Therefore, both were suspended which in due course led to the drafting of MIB II. MIB-I was the first version issued as RFC1156. MIB-II is a super set of MIB-I with some additional objects and groups and is defined in RFC1213. Object Identifiers The SNMP manager or the management application uses a well-defined naming syntax to specify the variables to the SNMP agent. Object names in this syntax are called Object Identifiers (Object IDs or OIDs). OIDs are series of numbers that uniquely identify an object to an SNMP agent. OIDs are arranged in a hierarchical, inverted tree structure. The OID tree begins with the root and expands into branches. Each point in the OID tree is called a node and each node will have one or more branches, or will terminate with a leaf node. The format of OID is a sequence of numbers with dots in between. There are two roots for Object Identifiers, namely iso and ccit. iso starts with.1 and ccit starts with.0. Most Object Identifiers start with , where 1=iso, 3=org, 6= dod, 1 = internet. The internet subtree branches into mgmt and private. To understand the concept of relative and absolute Object Identifiers, let us consider the AdventNet Object Identifier It specifies the path from the root of the tree. The root does not have a name or a number but the initial 1 in this OID is directly below root. This is called an absolute OID. However, a path to the variable may be specified relative to some node in the OID tree. For example, specifies the syscontact object in the system group, relative to the internet ( ) node in the OID tree. This is called a relative OID. AdventNet, Inc. 21

23 MIB Objects The internet subtree branches into mgmt and private. All the standard MIBs are under mgmt, while the private MIBs are under the private.enterprises subtree. The standard MIBs are those that have been approved by the IAB. Equipment and software vendors define the private MIBs unilaterally. A branch within the private.enterprises subtree is allocated to each vendor who registers for an enterprise Object Identifier. The distinction between the standard and private MIBs is based on how the variables are defined. The best example of a standard MIB is the RFC1213-MIB (also known as MIB-II). It is a MIB module which is typically supported by all SNMP agents on TCP/IP-enabled devices or systems. This MIB file contains a description of the object hierarchy on the managed device, as well as the Object ID, syntax, and access privileges for each variable in the MIB. To know more on RFC, visit One key aspect of MIBs is that, only the types of objects on the managed device are specified by the MIB and not the specific objects (or instances). For example, ifinoctets in RFC 1213-MIB specifies a type of object, for number of input octets on an interface, but the specific objects or instances of that type are specified as ifinoctets.1, ifinoctets.2, etc., depending on the number of interfaces. When specifying an object to the SNMP agent, a proper Object ID, which includes the instance, needs to be used by the manager. When not properly specified, the agent responds with a "No such variable" error. Object Identifier with Instance Indexes To obtain values of objects from the agent, you need to specify the instance of the object. Appending an instance index to the object identifier specifies the instance of an object. For example, the last 0 in:.iso.3.dod.1.mgmt.mib.1.sysuptime.0 is the instance index. An instance index of "0" (zero) specifies the first instance, "1" specifies the second instance, and so on. Since sysuptime is a scalar object, it has only one instance. Therefore, an instance index of zero is always specified when retrieving the value of a scalar object. An instance index higher than 0 can only be used in the case of columnar objects (in table), which can have multiple instances. SMI Structure of Management Information (SMI) is a set of rules used to specify the format for defining managed objects. SMI describes the MIB naming tree that is used to identify managed objects and defines the branch of the MIB tree where SNMP managed objects reside. The SMI does not define a managed object but describes a format for defining a managed object. The two versions of SMI are SMIv1 and SMIv2. SMIv1 is defined by RFC1155, RFC1212, and RFC1215 and the SMIv2 is defined by RFC1902, RFC1903, and RFC1904. SMIv1 is a backward compatible update of SMIv1. This means that it is possible to convert an SMIv2 MIB to SMIv1 except for objects whose data type is Counter64. But when it comes to converting SMIv1 to SMIv2, there is no mechanical way of doing it because there is more information in the SMIv2 than in SMIv1. Also, the SMIv2 format contains constructs to define requirement specifications and implementation specifications, which do not form a part of the SMIv1. AdventNet, Inc. 22

24 Release Notes Note: This section is useful for the existing users who are migrating to AdventNet SNMP Utilities 5. New users of AdventNet SNMP Utilities can skip this section. Release Features Third Party Software Package Structure This section gives the details of the features and bug fixes available with the product starting with the previous releases of the product till the current release. It also lists the various third-party software that are bundled with this product and other software to be used with the product and the directories and files that are distributed with AdventNet SNMP Utilities. AdventNet, Inc. 23

25 Release Features New Features in Release 5.0 New Features in Release 4.0 New Features in Release 3.3 New Features in Release 3.0 New Features in Release MibBrowser supports TCP and UDP network protocol for communication. MibBrowser can perform SNMP operations on multi protocol agents like UDP and TCP agents. 2. MibBrowser supports CFB-AES-128 along with CBC-DES privprotocol. 3. TrapViewer invoked from MibBrowser supports v3 INFORM request/response. 4. Mail Alert feature is supported in Trap Viewer, which is used to send mails for critical traps and can be configured to certain matching criteria also. 5. Improved and enhanced MibBrowser UI tool. 6. SnmpWalk can be performed from the toolbar. 7. Displayarea of the mibbrowser now can render the output in html table format. 8. Feature to enable and disable authentication of v3 traps and community name has been provided in the TrapViewer. 9. Privprotocl CFB-AES-128 and CBC-DES is supported in ProxyForwarderConfigurator/ProxyForwarder. 10. IPv6 support in MibBrowser at protocol level. In addition to the above new features, following enhancements are added to this release. Enhancements Done 1. TrapParser Viewer, option to unload the loaded trap parser files is provided. 2. By default maximum message size of a v3 packet was set to 8192 and this is changed to Provision to perform snmp operations by right clicking the mibtree / node is provided. 4. Multivarbind tab is shown in the default mibbrowser to perform multivarbind requests. 5. Persistence of EngineBoot of MibBrowser / Manager in Manager.config file which is used for V3 INFORM communication. 6. Size of the build reduced by 40 %(windows version). 7. Internationalization is supported in trap massages in the Trap Viewer. Bug Fixes : 1. MibSettings gets loaded from the MibSettings.config file if present. And in case not available, MibBrowser will get the default values from the DefaultSettings.config 2. When an invalid port number is specified, proper error message will be displayed and the LineGraph will not be invoked. 3. When 'ShowPolledValues' in LineGraph is selected, the graph was tending to zero. This is fixed. AdventNet, Inc. 24

26 4. When 'Show Absolute Counters' is selected in linegraph the values in the tooltip was showing only the recent values. This is fixed. 5. There was a problem of LineGraph going over the scale. This is fixed. 6. The 'Error' which appear in error dialog was not localized. 7. The "X-axis Scale" text field is disabled at the starup of Line Graph 8. The value box will not be shown when the cursor is moved out of LineGraph. 9. Fix for invoking the table graph from SnmpTable of MibBrowser applet 10. Fix for invoking the bar graph from SnmpTable of MibBrowser applet. 11. Fix provided to display the first column when the table contains two non-accessible indices in the MibBrowser. 12. Fixed the issue in incrementing the EngineTime insync with the agent. 13. If the syntax of a node is OBJECT IDENTIFIER and if its DEFVAL clause contains the value 'zerodotzero', then the MIB tree is incomplete. This issue has been fixed. 14. The MIB loading performance has been improved especially in case of MIB files which is larger in size. 15. Fix for loading the mib where the root mib and its imported mibs are from space seperated directory from MibBrowserUI. 16. ArrayIndexOutOfBoundsException when invoking the modify option of the TrapParser of Parser Editor is fixed. 17. ArrayIndexOutOfBoundsException when invoking the delete option of the TrapParser of Parser Editor is fixed. 18. NullPointerException on clicking the Refresh button after selecting the indexeditor is fixed. New Features in Release 4.0 Robust MIBs package SNMP Decoder MibBrowser enhancements Trap Viewer enhancements In addition to the above major features, the following enhancements are added to this release. Enhancements Done 1. End Of MibView error is shown while performing GETBULK request in SnmpTablePanel. 2. Support for plotting of values for Counter64 in LineGraph bean has been provided. 3. Now it is Possible to enable/disable error messages in the LineGraphBean. 4. In TrapViewer, the source field in trap details now shows the agent address if specified. TrapViewer shows the number of traps and inform requests received. Also, feature for logging traps has been provided. 5. Complete broadcast feature has been provided, in MibBrowser. 6. Proper error message is given, if the table row object contains the ACCESS values other than 'not-accessible'. 7. Various parsing levels, such as LENIENT, NORMAL, SERIOUS, CRITICAL, and User Defined are provided to load the MIB file. 8. Facility to copy rows in SNMP table of MibBrowser has been provided. 9. Option to load MIBs from configuration files has been included. AdventNet, Inc. 25

27 Bug Fixes 1. ContextName was not taken while plotting graph using the graph icon from MibBrowser. This has been fixed. 2. In the OID definitions like {1 3 6} where the first suboid is a number, the module will not get resolved. This bug has been fixed. 3. In the OID definitions like {iso org(3) dod(6) 1 mgmt(2)...} where a number occur as a subid in the middle of namenumber suboid, NullPointerException is thrown. This bug has been fixed. 4. In the TRAP-TYPE Construct, the ENTERPRISE field containing the OID value is not allowed. This bug has been fixed. 5. In database mode, importing TCs are not handled. This bug has been fixed. 6. While loading MIB in the database mode, if the IMPORTS section in the MIB contains the imported elements which are not used, then ArrayIndexOutOfBounds Exception was thrown. This bug has been fixed. 7. While loading some of the MIBs, the nodes were found to be missing in the MibTree. This problem is fixed now. 8. The FileNotFoundException thrown while loading the mib file which contains multiple modules and is placed in the space separated path, is fixed. 9. For the OBJECT-IDENTITY macro, the reference was same as the description. This bug has been fixed. 10. In the OBJECT IDENTIFIER definition, if the suboid is a number, a temporary label is created using this suboid. If two nodes are defined in such a way that their second sub-oid (which is a number) is same, then the temporary label created is overwritten and only one of the node exist in the OID list. This bug has been fixed. 11. For the index nodes with syntax OCTET-STRING and OBJECT IDENTIFIER, the length value has to be prepended, unless it is defined IMPLIED. But if the OCTET STRING has a SIZE clause, the size can be taken as the length value and the length need not be prepended before the instance value. This condition is now handled. 12. When the DateAndTime value is given in the invalid format, it was throwing IncompatibleClassChangeError instead of giving proper error messages. This bug has been fixed. 13. If the OBJECTS clause is not present in the NOTIFICATION-TYPE macro while loading MIBs using Compiled MIBs option, the description value is displayed as empty string. This bug has been fixed. New Features in Release Internationalization support is added in the MibBrowser and Launcher. 2. While parsing the MIB files, the MACRO DEFINITION in the MIB file is ignored. 3. While parsing the MIB files, appropriate error messages are provided in case of exception. 4. In the SnmpTable panel of MibBrowser, option has been provided in settings panel for changing the table OID which will avoid instantiating multiple tables from MibBrowser. 5. Support for external indices is provided in SnmpTablePanel for SMIv1 MIBs. 6. MibBrowser Applet's File Dialog Box (SAS File Dialog) has been greatly enhanced like JFileChooser and file filtering options are provided. 7. In the MibBrowser's MibTree, buttons are provided for expanding and collapsing the tree. 8. In the MibBrowser, MibNode description is enhanced to have more information about MibNode. 9. Database Support for loading MIBs in MibBrowser. 10. Support for saving SNMPv3 security parameters information in a database for MibBrowser. AdventNet, Inc. 26

28 11. The MIBs loaded previously will be stored and updated in the Recently Loaded MIBs list in the MibBrowser Settings at every startup for MibBrowser. 12. Last five MIBs that has been loaded in the MibBrowser will be updated in File menu with Mib Module Name as menu item. 13. Load All Mibs menu item has been added in the File menu to load all the MIBs that has been previously loaded listed in the Recently Loaded Mibs list in the MibBrowser Settings. Incase, if the Updated List has some Mibs updated, then Load All Mibs will load that MIBs only. 14. In the SnmpTable Panel bean, support for displaying SNMP table columns not implemented by the agent is added. 15. SNMP Decoder utility for decoding v3 PDU HEX dumps in the Debug window of the MibBrowser. 16. Trap Viewer also supports filtering of traps based on OID value pair and Agent port pair. 17. Trap table in the Trap Viewer support supports sorting of traps. 18. Enhanced UI for HTML MibBrowser. 19. I18N Editor for editing EnglishToNative.properties file in Internationalization. 20. Loading of All MIBs from a specified directory in MibBrowser. New Features in Release 3.0 MibBrowser 1. Allows to load and view multiple MIB modules. 2. Allows to traverse the MIB tree to look at the definitions for each node of the MIB tree. 3. Allows to perform SNMP operations such as GET, GETNEXT, GETBULK and SET. 4. Ability to view multiple real-time graphs of data on the managed device as it changes over time. 5. Enables viewing SNMP tables. 6. Find option to search a mib node from the MibBrowser MibTree. 7. SNMPDecoder utility for decoding v1 and v2c PDU HEX dumps in the Debug window of the MibBrowser. 8. Logging option which can log MibBrowser result display, Debug messages and SNMPDecoder messages. 9. Print option to print the SNMP operations results, debug messages, SNMP Decoder messages. 10. MibBrowser Load Mib dialog provides an option to load compiled mibs. 11. SetValues, ContentName, ContextID TextFields are provided in ComboBoxes to reuse the recently used values. Trap Viewer 1. Allows to parse and view the received traps. 2. TrapParser is available in TrapViewer to load and edit the parser files. 3. TrapParserCustomizer to edit the trap parser file. 4. Delete option to delete the trap messages from the TrapViewer. 5. TrapViewer bean's activity is shown with a LED panel and status panel. 6. TrapViewer supports listening on multiple ports for receiving traps. 7. TrapViewer provides Delete option to delete the traps listed in TrapViewer. 8. Right click the column header to get the option. 9. TrapParser supports loading traps to the parser from loaded MIBs. AdventNet, Inc. 27

29 Third Party Software The following third-party tools are bundled with the AdventNet SNMP Utilities. Package Name Version Link Tomcat Web Server JimiProClasses.zip JRE Mail.jar activation.jar The following third-party tools may be needed to work with certain modules of the product. These tools are not bundled with the product. To use SNMPv3 privacy functions, one of the following products has to be used. Cryptix 3.x.x security package available at JCE 1.2 (Java Cryptography Extension) framework available at However, JCE comes bundled since JRE 1.4 and above and also available part of jre (JRE1.5) which is packaged with this product. For database support, the appropriate jars (for example, mysql_comp.jar) are required to connect and query the database. AdventNet, Inc. 28

30 Package Structure The directory structure and the files under the <AdventNet/SNMPUtilities> distribution are provided below. All the files are extracted under <AdventNet/SNMPUtilities> directory. The following image displays the package structure of AdventNet SNMP Utilities. Windows (Click the desired folder to see its contents) Linux Directory bin classes conf examples help images jars Contents of the Directory Decoder.bat - invokes SNMP Decoder. i18neditor.bat - invokes i18neditor. MibBrowser.bat - invokes MibBrowser application. ProxyForwarder.bat - invokes ProxyForwarder. ProxyForwarderEntry.bat - invokes Proxy Forwarder Configurator. SAServer-WebServer.bat - starts the servers. TrapViewer.bat - invokes TrapViewer. UniqueID.exe - contains executable to generate a unique id based on the mac address. Contains class files related to AdventNet SNMP Utilities. Contains the config files and the Tools.properties file. Contains examples files. Contains the complete help files. Contains the images related to SNMP Utilities. Contains the Jar files used in AdventNet SNMP Utilities. AdventNetUpdateManagerInstaller.jar - Contains all classes required to invoke the Update Manager. MibBrowser.jar - used for running both MibBrowser Applet and MibBrowser application. AdventNet, Inc. 29

31 Directory jre logs MibBrowser mibs ProxyForwarder SASusers template tomcat TrapViewer WEB-INF COPYRIGHT index.html LICENSE_AGREEMENT README.html SnmpUtilities.bat/sh Contents of the Directory Contains JRE 1.5 files which can be used to run the applications from Launcher. Contains the output logs of the applications invoked from snmputilities. Contains the MibBrowser application/applet related files. Contains standard MIB files. Contains the ProxyForwarder application class files. This directory allows to perform file operations for the applets while using SAS. Contains the template file used in HTML MibBrowser. Contains the Tomcat web server related files. Contains files related to Trap Viewer. Contains compiled classes of jsp for invoking HTML MibBrowser. Copyright file. Applet startup file. License Agreement file. Readme file. Invokes the launcher. AdventNet, Inc. 30

32 Installation Guide System Requirements Installation and Setup License Manager This section explains the system requirements to work with AdventNet SNMP Utilities and installing and setting up in different platforms, such as Windows, Linux, and Solaris. AdventNet, Inc. 31

33 System Requirements Hardware Minimum 233 MHz Pentium Processor Memory: Minimum 64MB RAM Disk Space:Minimum 70 MB Software JRE - JRE 1.5 is bundled with the SNMP Utilities package. It is bundled with the EXE for windows and ZIP for Linux and Solaris. Java enabled web browser (Firefox 2.x / IE 6.x) with Sun's Java Plug-in, to test/view applets within a web browser developed using SNMP Utilities. The Java Plug-in is also part of the jre1.5 which is bundled with the SNMP Utilities. The JRE 1.5 that is bundled with the SNMP Utilities package is sufficient to work on the Utilities. The following requirements are optional. Any database and the corresponding JDBC driver for the database support. For security and privacy features of SNMPv3, any one of the following products has to be downloaded and used: o Cryptix 3.x.x security package available at o JCE 1.2 (Java Cryptography Extension) Framework available from However, Sun JCE comes bundled since JRE 1.4 and higher. AdventNet, Inc. 32

34 Installation and Setup The AdventNet SNMP Utilities is distributed in two formats. self-extracting EXE format with an Installshield program for installation (for Windows 95/98/2000/NT/XP, Windows Vista). Zip file distribution (only for Solaris/Linux). To Install If the downloaded file is in EXE format, run the EXE file to start the installation process and follow the instructions. If the downloaded file is in zip format, extract the files using the unzip utility. Invoking the Launcher To invoke launcher and to work further with the tools that are bundled with the SNMP Utilities, follow the instructions below. Windows: Click on Start--Programs-->AdventNet SNMP Utilities-->AdventNet SNMP Utilities. UNIX: Run the SnmpUtilities.sh file in the <AdventNet/SNMPUtilities> folder to invoke the Launcher. Invoking Launcher the first time after installation displays the License Manager. Refer License Manager for more information. AdventNet, Inc. 33

35 License Manager The main purpose of License Manager is to validate the License file. The License Manager is integrated with all AdventNet products. This Manager is executed only once, that is, when the user runs any of the AdventNet's products for the first time. There are two types of License policies for AdventNet's products. Evaluation User License Policy Registered User License Policy Both of the above types are validated by the License Manager. AdventNet provides an evaluation (trial) period of 7 days for SNMP Utilities 5. AdventNet will provide a Registered user License file after you purchase the product. To avail any technical support or help with evaluation, user has to fill out the form from our web site: To get the registered user file you must contact our sales team at [email protected]. Procedure for Licensing After installing the product, you need to provide the required licensing information for starting the product. The License Agreement will be invoked when you start the Launcher. If you agree and proceed to the next screen, Licensee User dialog will be displayed. Need to select one of the License User type ( Evaluation User / Registered User ) before proceeding to the next. Evaluation User : If you select the Evaluation User, and on clicking the Finish button will start the product as a Evaluation User mode for a period of 7 days and the product will expire after the evaluation period. AdventNet, Inc. 34

36 Registered User : If you select the Registered User, Licensee details screen will be shown. And here you need to supply the registered license file which you obtained from AdventNet. Locate the license file by clicking the Browse button and click the Next button. The next screen displays the list of users who can use the license. AdventNet, Inc. 35

37 Select the username and proceed. The License Manager starts product immediately. Upgrade License Policy from Evaluation User to Registered User Start the SNMP Utilities Launcher by running the SnmpUtilities.bat/sh file present under the <SNMPUtilities> directory. Select Help-->Register from the menu. The License Manager screen pops up. Use the above procedure to upgrade. AdventNet, Inc. 36

38 Getting Started Using Launcher Using Applications Using Applets Update Manager This section explains how to work with the product using the Launcher that is bundled with the SNMP Utilities product. It gives a detailed overview on its UI, functionality and configuration. It also explains the usage of applications and applets that are bundled with the product. AdventNet, Inc. 37

39 Using Launcher Launcher UI Configuring and Running Applications Viewing Logs This section gives you an overview of the UI of the Launcher. It also explains how to configure and run applications using Launcher. AdventNet, Inc. 38

40 Launcher UI The AdventNet SNMP utilities launcher provides a single UI from which the various tools can be invoked. The image below depicts the UI of the Launcher. The SNMP utilities launcher can be toggled to the toolbar view by clicking the View-->Tool Bar menu from the menu on top. The toolbar view has the General and Applications tabs. The general frame has the general options such as the Settings, Update Manager, Support, logs, help and Exit. Apart from these there is also, Normal View - The launcher can be toggled back to the normal view by clicking this icon. Help - This will lead you to the help documentation of the SNMP Utilities. Exit - Clicking this will close the Launcher. The Applications frame comprises of the icons to run the tools provided with the SNMP Utilities package. The image below shows the Toolbar view with the Applications tab enabled. AdventNet, Inc. 39

41 MibBrowser - Invokes the MibBrowser. TrapViewer - Invokes the TrapViewer. ProxyForwarderConfig - Invokes the ProxyForwarderConfiguration tool. ProxyForwarder - Invokes ProxyForwarder which used to translate SNMPv3 request for SNMPv1 and V2c agents. I18N Editor - Invokes the I18N resource file editor. SNMP Decoder - Invokes the SNMP Decoder. SAServer-WebServer - Starts the SAServer and the WebServer. SNMP Applets - Invokes the html file that has the links to all the applications that is bundled with the SNMP Utilities package. AdventNet, Inc. 40

42 Configuring and Running Applications The Launcher can be configured to add new applications into it. Now let us get to know how we can add a new application to the Launcher. The eight major application or tools available by default on the Launcher is the MibBrowser, TrapViewer, ProxyForwarderConfig, ProxyForwarder, SNMP Decoder, i18n Editor, SAServer- WebServer and SNMPApplets. Apart from these, if you need to add any other new application, open the launcher_conf.txt file in the <conf> directory in the utilities package. You can view the configuration of the applications that are present in the Launcher by default. You can add your application similar to the one in the conf file. For instance, the configuration of the MibBrowser application is given below: <application> <property name="appname" value="mibbrowser"/> <property name="apptype" value="java"/> <property name="classpath" value="./mibbrowser;./jars/apiutils.jar;./jars/adventnetsnmp.jar;./jars/adventnetlogging.jar;./jars/adventnetcclxmlparser.jar;./jars/adventnetutils.jar;./jars/adventnetcclutils.jar;./jars/adventnetlogging.jar;./jars/adventnetsnmputilitiessplash.jar;./classes;./jars/mibbrowser.jar"/> <property name="classname" value="mibbrowserapplication"/> <property name="appimage" value="./images/mibbrowser.jpg"/> <property name="description" value="mibbrowser is used to view and operate on data available through an SNMP agent on a managed device"/> <property name="interfacefile" value="mibbrowsercustomizer"/> </application>.... Similarly, you can add your desired application to the Launcher. Configuring an Application Settings for a tool or application can be done by Selecting Options > Settings menu item from the Launcher menu bar. Ctrl + S. Clicking on the Settings icon on the toolbar Right-clicking the application icon on the launcher and select Settings. On performing any of the above, a Java Environment settings dialog box pops up. This can be used to set the various path and classpath variables needed to use the applications. Any new classpath settings, modification of the existing environment variables can also be done. The Settings panel comprises of the left and right frame. The left frame has the General Settings option and the Applications Folder. The General settings is used to set the global settings which will be used throughout the AdventNet SNMP Utilities package. The image shows the General settings options. AdventNet, Inc. 41

43 The following environment settings can be set using the settings option in the launcher: Browser path - path for the web browser. The web browser is used for loading the applets and for viewing the help files. To set the path, click on the browse button and select the corresponding executable for the browser. (eg. c:\program Files\MozillaFirefox\firefox.exeor usr/bin/firefox ). Please note that the complete file name has to be given, not just the path where the executable lies. JAVA HOME - sets the JAVA_HOME environment variable. This is used for running the applications in the AdventNet SNMP utilities package. By default it uses the JRE bundled with the product. The user can set it for any java version (i.e JDK 1.3 and above). If the field is left blank it will take the default option (JRE - 1.5). In case of using jre 1.3 or 1.4, additional classpath pertaining to xml parsing (like xalan.jar, crimson.jar, jaxp.jar ) should be set in general settings level or each applications level for smooth working of the applications. In case of default jre (jre1.5, additional jars for parsing xml files are not required as it will be taken care by the jre1.5 itself ). JAVA Classpath - the classpath settings necessary for running the application is set here. By default the necessary classpaths are already set. Additional classpath can be added to the existing list. Please note that the classpath settings takes precedence in the order in which they are listed. The Applications folder in the settings panel displays all the applications that are part of the AdventNet SNMP Utilities package. Any property specific to the application can be set by selecting the corresponding application. For eg the MibBrowser specific properties such as protocol, Mib file name etc can be set by selecting the MibBrowser folder. The right frame is depicted as two tabbed. One is the Settings tab and the other is the Options tab. The settings tab corresponding to each application displays the class path settings specific to the application. Any new classpath settings can be added using this option. The image below shows the Settings tab being invoked for the MibBrowser Application. AdventNet, Inc. 42

44 The Options tab corresponding to each application displays the options available for that particular application that you select in the left frame under the Applications Folder. The image below depicts the options available for the MibBrowser. AdventNet, Inc. 43

45 Running the Application The various ways of running or invoking an application is listed below: Selecting the Options-->Run from the menu bar Ctrl + R Double-clicking the respective icon on the top panel Right-clicking the icon and opting for Run AdventNet, Inc. 44

46 Viewing Logs On invoking an application, a tab panel containing an error text area is created for the same in the bottom panel. When an error or an exception occurs for that application, it is displayed on this error text area which is simultaneously logged into a log file. The log file name is same as the application's name. To view the list of the Logs created and their contents perform any of the following, Choose Log Option from the Options Menu bar. Click on the Logs icon on the tool bar Right click the desired application's icon and select Logs Ctrl + L The image below depict the Log dialog that pop ups when you perform any of the above listed options. Note that, in the above depicted image there is the MibBrowser0.log. This actually denotes the log of the MibBrowser.log in the current session. when you quit from the launcher session, the contents of the MibBrowser0.log file gets appended to MibBrowser.log The three buttons available in the LogInfo dialog are View Log, Refresh and Cancel. View Log - Select any of the log file that is listed in the dialog and click this button to view the contents of the log file. Refresh - Clicking this would refresh the dialog and include the newly created log files. Cancel - Clicking on Cancel will let you quit from the LogInfo dialog box. AdventNet, Inc. 45

47 Using Applications The following applications form part of the AdventNet SNMP Utilities product. All these applications can be invoked from the Launcher. MibBrowser: AdventNet MibBrowser is a tool that can be used for browsing MIBs and other SNMP-related functions. MibBrowser can also be used to view and operate on data available through an SNMP agent on a managed device. SNMP Decoder: The SNMP Decoder tool is used to view the decoded output of the debug information. Trap Viewer: The Trap viewer application is used for receiving and viewing traps in a specified port. The received traps are parsed in a trap parser and then displayed in the Trap viewer. Option for sending details of the received traps trough based on the specified recipients. Proxy Forwarder Configuration: This tool is used for configuring agents, USM (User Security Model) user tables and the VACM (View based Access Control Model) entries for making a SNMPv3 query. i18neditor: The I18N Editor is the tool used for internationalization. SAS Server-Web Server: The Web Server is used for loading the Java applets that are distributed as part of the product. Java applets run in Web browsers, and these browsers often place restrictions on the capabilities of the applets, sometimes for valid security reasons. SNMP Applet Server (SAS) is used to facilitate communication between applets and managed devices where direct communication is prohibited due to applet security policies. Proxy Forwarder: The Proxy Forwarder application is used to translate SNMPv3 request for SNMPv1/v2c agents. The Proxy Forwarder is a multilingual application which forwards a SNMPv3 requests to any of the SNMPv1/v2c agents configured and gives back the response. Multiple SNMPv3 mangers can talk to multiple SNMPv1/v2c agents through the Proxy forwarder. SNMP Applets: This invokes the html file that has the links to all the applications that is bundled with the SNMP Utilities package. AdventNet, Inc. 46

48 Using Applets The AdventNet SNMP Utilities comes packaged with several applets and a HTML MibBrowser which can be used in a WebBrowser to query SNMP devices and applications. But, in order to run the applets, you should start the WebServer and the SAS. The SAS facilitates communication between the applets and any managed device, overcoming the security restrictions placed on the applet. The following steps would guide you in using the applets: 1. Invoke the Launcher. To know more about invoking the launcher follow the link to Using Launcher 2. Click on the SAServer-WebServer icon on the launcher, or any other method to invoke it as detailed in Using Launcher. This would start both the WebServer and the SAS. The WebServer is started on port 8282 and the SAS is started on any available port. 3. The SAS port information is written to the file SASPort.html file. Let's assume the WebServer and SAS are running on the localhost. Type the following URL on the browser, 4. This loads a file which contains links to the MibBrowser applets, Trap Browser applet and the HTML MibBrowser and HTTP MibBrowser. To use the MibBrowser applet in WebBrowser, click on the "MibBrowser" or the "HttpMibBrowser" link. When the applet is loaded in your browser, you can use it to query any SNMP device on the network. 5. Similarly to use the Trap Browser applet, click on the "TrapViewer" link. When the applet is loaded in your browser, you can configure it to receive trap from any SNMP device on the network. AdventNet, Inc. 47

49 Update Manager AdventNet periodically provides Service Packs which provide new features (requested by the customers), fixes for certain bugs and document updates in the form of HTML files. Service Packs can be downloaded from the web site, and updated into SNMP Utilities using the Update Manager tool. During the installation of a patch, the corresponding files related to bug fixes are updated in the product installation directory. It also gives the information of the current version of the patch installed. Every version of the patch includes the bug fixes of the previous patch version. The Update Manager can be invoked by choosing Update Manager from the Options menu in the Launcher. When you start the Update Manager, all the Service Packs that are already installed are listed and it provides the options to install, uninstall and view the details of any Service Pack installed. The main features of the Update Manager are as follows. Install/uninstall the patch Viewing Details of a Service Pack Warning: Ensure that no application is running when applying the Service Pack. This prevents any files used by the application from being over-written. AdventNet, Inc. 48

50 Install/Uninstall the Patch The steps to install the patch: 1. Click the Install button. 2. Specify the location of the patch file (.ppm) or choose the same using the Browse option. The Readme button gets enabled once the file is chosen. You can click the Readme button to display the README file of the Service Pack. 3. Click Finish to install the patch. If you want to uninstall a patch, invoke the License Manager, select the patch to be uninstalled from the list of patches and click the Uninstall button. Click Finish to uninstall the patch. AdventNet, Inc. 49

51 Viewing Details of a Service Pack The steps to view the details of a Service Pack are as follows. 1. Start Update manager. Select the patch whose details are to be viewed. Click the Details button to get the details dialog. It has the two tabs: General and Readme. 2. The details such as the Service Pack Name, Description, Size, Time of installation, and the list of files that are updated are shown in the General tab while the README file is shown in the Readme tab. AdventNet, Inc. 50

52 MibBrowser AdventNet MibBrowser is a complete SNMP MibBrowser that enables loading, browsing, and searching MIBs, walking the MIB tree, and performing all other SNMP-related functions. MibBrowser also enables viewing and operating the data available through an SNMP agent in a managed device. Features of AdventNet MibBrowser 1. MibBrowser supports UDP/TCP communication with respective agents. This can be achieved by enabling the UDP/TCP option through the settings menu of Launcher before starting the MibBrowser. 2. Enables saving of MibBrowser settings. 3. Provides the capability to load and view MIB modules in a MIB tree. 4. SNMP operations like GET and GETNEXT can be performed by right clicking each node of the MIB tree. Definition of each node for a particular object can also be viewed. 5. Enables to perform the basic SNMP operations, such as GET, GETNEXT, GETBULK, and SET. 6. Display the output of any snmp operations in a tabular fashion with oid and value as columns. 7. Supports multi-varbind requests. 8. Enables real-time plotting of SNMP data in a graph. Line graph and bar graph are the two types of graphs that are currently supported. 9. Provides a user-friendly view of SNMP table data. The table data can be viewed in a separate window called SNMP Table UI. 10. Enables to view the incoming traps using Trap Viewer. It also allows parsing of traps. 11. Supports internationalization. This feature deploys the applications and applets developed using the AdventNet SNMP Utilities in various languages without altering the code. 12. Enables loading of MIBs at startup. Selecting UDP / TCP protocol options for MibBrowser Selecting the UDP / TCP Protocols for MibBrowser application is based on the type of the snmp agent ( either a UDP / TCP agent ) which MibBrowser communicates. And this can be done by Select the MibBrowser application icon from the Launcher and then Selecting Options -> Settings menu item from the Launcher menu bar, and selecting the Optios tab. Ctrl + S to open the Settings and then selecting the Options tab. Clicking on the Settings icon on the toolbar and then selecting the Options tab Right-clicking the application icon on the launcher and select Settings and then navigate to Options tab. And from the Options tab, either UDP / TCP protocol can be selected. UDP protocol is selected as default. Image below depicts the Protocol options available for MibBrowser application. AdventNet, Inc. 51

53 Note: UDP / TCP Protocol can be selected only for the MibBrowser application which is invoked from the AdventNet SNMPUtilities Launcher and this is not available for the MibBrowser invoked from Applet. Enabling TCP protocol and invoking the MibBrowser will try to communicate with the TCP snmp agent with default host as localhost and the default port as 161. If the TCP snmp agent is up and running in the localhost and listening on the port 161, then it will establish TCP connection with the agent. And if the agent is not running, then MibBrowser will try to cmmunicate with the TCP snmp agent on the localhost with port 161 and a message "Unable to establish TCP communication with localhost:161" will be logged in the MibBrowser log. If the TCP snmp agent host is not the localhost and the port is not 161, then this can be specified in the Host / Port textfield of the MibBrowser and on performing SnmpOperations, MibBrowser will trying to establish TCP connection with the desiered host and port and communicate it with the agent. How Does AdventNet MibBrowser Look Like?\ AdventNet, Inc. 52

54 The image above depicts the primary window of AdventNet MibBrowser. It consists of a menu bar, toolbar, left frame, and a right frame. The menu bar displays a list of commands to perform various operations. The toolbar displays buttons with images that act as shortcuts to the menu options. The left frame holds the MIB tree. A MIB tree is a structure that displays all the loaded MIBs. The MIB tree enables to traverse the tree, view the loaded MIBs, and the definition of each node. The right frame contains text fields to specify the basic parameters, such as host, community, and so on. It also contains a result display area to display the results in a tabular fashions. There are three ways in which the primary window of the MibBrowser can be displayed. They are the Result Display, MIB Description, and Multi-Varbind. To change the display, click View-->Display and select the desired view. By default, the MIB Description display is visible in the MibBrowser. AdventNet, Inc. 53

55 Starting Up Invoking Application Invoking Applet MibBrowser can be invoked as a standalone application or as an applet. The differences in using the MibBrowser as an application and as an applet are highlighted in relevant areas throughout this section. AdventNet, Inc. 54

56 Invoking Application Invoking MibBrowser as an application would enable you to use it as a standalone application. Follow these steps to invoke the application. Windows: You can invoke MibBrowser using the Launcher. Launcher can be invoked by selecting Start-->Programs-->AdventNet SNMP Utilities-->AdventNet SNMP Utilities. Alternatively, you can invoke Launcher by running the SnmpUtilities.bat file in the <AdventNet/SNMPUtilities> folder. In the Launcher window, double-click the MibBrowser icon to run MibBrowser. To directly invoke MibBrowser, select Start-->Programs-->AdventNet SNMP Utilities -->MibBrowser. Alternatively, you can run the MibBrowser.bat file in the <AdventNet/SNMPUtilities/bin> directory to invoke MibBrowser. Unix: Run the SnmpUtilities.sh file present in the <AdventNet/SNMPUtilities> folder to display the AdventNet SNMP Utilities Launcher window. In the Launcher window, double-click the MibBrowser icon to run MibBrowser. AdventNet, Inc. 55

57 Invoking Applet MibBrowser can be run as an applet and it can be viewed in a Java-enabled Web browser. To invoke MibBrowser applet, perform the following steps. Windows You can invoke MibBrowser applet using SNMP Utilities Launcher. 1. SNMP Utilities Launcher can be invoked by selecting Start-->Programs-->AdventNet SNMP Utilities-->AdventNet SNMP Utilities. Alternatively, you can invoke Launcher by running the SnmpUtilities.bat file in the <AdventNet/SNMPUtilities> folder. 2. In the Launcher window, double-click the SAServer-WebServer icon to start the WebServer and SAS. 3. An applet-based MibBrowser can be viewed only when the Web browser is enabled with the Java plug-in. If you do not have the Java plug-in, you can download it from the following link. The plug-in is loaded only once and installed in the system. If you need to view the debugs, you need to configure the plug-in Control Panel to enable the Show Console option. 4. Now open the browser and type in the following URL. Unix To invoke MibBrowser applet using SNMP Utilities Launcher: 1. Invoke Launcher by running the SnmpUtilities.sh file in the <AdventNet/SNMPUtilities> folder. 2. In the Launcher window, double-click the SAServer-WebServer icon to start the WebServer and SAS. 3. An applet-based MibBrowser can be viewed only when the Web browser is enabled with the Java plug-in. If you do not have the Java plug-in, you can download it from the following link. The plug-in is loaded only once and installed in the system. If you need to view the debugs, you need to configure the plug-in Control Panel to enable the Show Console option. 4. Now open the browser and type in the following URL. This invokes the MibBrowser applet and the communication is based on SAS. The Java console is shown if you had configured in the plug-in control panel. Note: While invoking the MibBrowser using an applet, the following points are to be taken into consideration. Ensure that you start the WebServer and SAS before invoking the applet. SAS is essential to enable the communication across the network. You cannot invoke MibBrowser by opening MibBrowser.html or HttpMibBrowser.html using the File-->Open menu option in the Web browser. AdventNet, Inc. 56

58 Note: One problem that you could face is, the Web browser could give "remote machine timed out" error. The reason is that the Web browser settings could have the proxy connections enabled. Some proxy servers cannot resolve to the local host. To solve this problem, either give the host name of the machine instead of the localhost or disable the proxy settings in the browser settings. Opting "Direct connection to the Internet" can also help you overcome this problem. MibBrowser applet using HTTP Another way of establishing SNMP communication through applets is facilitated by using HTTP. Although TCP/IP connection is more efficient than the HTTP, the HTTP access is best used when you need to communicate with a network that has firewall restrictions. To invoke the applet using HTTP: 1. In the Launcher window, double-click the SAServer-WebServer icon to start the WebServer and SAS. 2. An applet-based MibBrowser can be viewed only with the Java-enabled Web browser. If you do not have the Java plug-in, you can download it from the following link. 3. The plug-in is loaded only once and installed in the system. If you need to view the debugs, you need to configure the plug in Control Panel to enable the Show Console option. 4. Open the Web browser and type in the following URL. This invokes the MibBrowser applet using HTTP. Note that MibBrowser loaded in this case does not use SAS for communication. AdventNet, Inc. 57

59 Configuration Setting Common Parameters Setting MIB Parameters AdventNet MibBrowser can be used to view and operate on the data available through an SNMP agent. MibBrowser can be configured in tune with performing the SNMP operations. To configure the MibBrowser, click the MibBrowser Settings button from the menu. You can also use the shortcut key combination Alt + S. or select Edit-->Settings The MibBrowser Settings dialog box is displayed. It has the following two tabs. General Mib Settings AdventNet, Inc. 58

60 Setting Common Parameters AdventNet SNMP Utilities 5 :: Help Documentation The parameters, such as host, port, and community, can be set in the MibBrowser's main window. Applications use the host name or the IP address of the device to communicate with the agent of the device in a particular port number.this remote port number is either a UDP port 161 or a TCP port 161 which is based on the Protocol options selected in the MibBrowser options. By default, all the SNMP request messages are received in this port. SNMP mandates that the SNMP agents should accept request messages only if the community string in the message matches its community name. Therefore, the management application should always communicate with the agents along with the associated community name. The default SNMP community names are "public" for read-only (GET) operations and "private" for read-write (SET) operations. The management applications should have provision to include the community names in their request messages. Community strings are used to authenticate SNMP PDUs. Since SNMP packets are usually sent using UDP packets, there is no connection established as in the case of TCP/IP packets. Therefore, when a UDP packet is sent to the agent, the agent validates the packet. It accepts and sends a response if the community string of the PDU is equal to that set on the agent, or else drops the packet. The agent does not change the community name after communicating. Applications typically communicate with the SNMP agents by specifying the community name of the agent. The default community string is "public" and the default Write Community string is null. When Write Community is null, community itself is used for SET operations. Therefore, applications should explicitly set the Write Community, before they can use it for SET operations. The other parameters are set in the General tab of the MibBrowser Settings frame. The general settings include the basic protocol options related to SNMP, the display options, and a section for encoding field. The image depicted below shows the General tab of the MibBrowser Settings dialog box. AdventNet, Inc. 59

61 The various protocol-related options to SNMP are listed in the table below. Options Default Values Other Options SNMP Version v1 v2c or v3 Timeout 5 sec any user-defined value Retries 0 any user-defined value Encoding ISO8859_1 any encoding scheme that supports text format Max Repetitions 50 any user-defined value Non Repeaters 0 any user-defined value Note: Timeout is the time interval that an application waits for a response message from an agent before timing out. Retries is the number of times a request is sent when a timeout occurs. If the retry value is 0, the request is re-transmitted on timeout. The Max-repetitions and Non-repeaters options are enabled only when the SNMP version is set to either v2c or v3. This is because, the GETBULK operation is available only in v2c and v3. A GETBULK request is performed by giving an OID along with two other parameters, Max Repetitions value and Non Repeaters value. Encoding, in general, means, modifying information into the required transmission format. Computers around the world store information using a variety of encoding schemes. AdventNet MibBrowser support the ISO8859_1, which means ISO 8859_1, Latin alphabet No.1. There are various other encoding schemes that support various text formats. You can use the encoding scheme that best suits your requirement while performing SNMP operations. To view the encoding scheme that is supported by Java Development Kit, see: The Validate Broadcast Address check box enables you to check the validity of the broadcast address provided. You need to provide the Netmask address to validate the broadcast address. A Netmask is a string of 0's and 1's that hides the network part of the IP address and allows only the host ID to remain. In the v3 Options section, Context Name and the ContextID are to be provided as additional parameters for an SNMPv3 request. An SNMP context name is a collection of management information accessible by an SNMP entity. An item of management information may exist in more than one context. An SNMP entity potentially has access to many contexts. In other words, if a management information has been defined under certain context by an SNMPv3 entity, any management application can access that information by giving that context name. The ContextID uniquely identifies an SNMP entity that may recognize an instance of a context with a particular context name within an administrative domain. Below image depicts the typical v3 user entries added into a v3 settings. AdventNet, Inc. 60

62 Note: In case of TCP communication, V3 settings contains USM user entries from different TCP snmp agent, then on selecting each USM user entry, MibBrowesr will try to establish TCP connection with the appropriate TCP snmp agent based on the selected entry. The next section is the v3settings section. The following are the security-related parameters for accessing the SNMPv3 agents. You can add, modify, and delete users by clicking the Add, Modify, Delete buttons. AdventNet, Inc. 61

63 Options Default Values Other Options User name null any user-defined value Security level noauth nopriv Auth nopriv and Auth Priv Authentication Protocol MD5 (if authentication is chosen in security level) SHA Privacy Protocol CBC-DES (if privacy is chosen in security level) CFB-AES-128 Authentication password any user defined value - Privacy password any user defined value - Entity Remote ( snmp agent ) Local ( to configure Manager to authenticate V3 Informs ). Target host localhost any host with SNMPV3 agent or proxy agent Target port 161 any user-defined port If the security level is "NoAuthNoPriv", no additional parameters are required. If the security level is "AuthNoPriv", the parameters AuthProtocol and AuthPassword are set. If the user security level is "AuthPriv", the privacy password needs to be set in addition to the other parameters. The v3settings section has an option for storing the v3 table entries. The v3 table entries can be stored in: A serialized file A database Storing Table Entries in a Serialized File To enable serialization of v3 table entries, select the Save v3 Settings to File option. If this option is selected, the user information is stored in the serialized files namely UserEntry.ser and EngineEntry.ser. When MibBrowser is invoked the next time, the serialized files are de-serialized and the v3 table is updated. The advantage of storing table entries in serialized files is that the operation is faster. Note: UserEntry.ser and EngineEntry.ser file which was used in the previous AdventNet SNMPUtilities 4 release is not compatible with this release. And hence the older files cannot be used. Storing Table Entries in a Database To store v3 table entries in a database, select the Save v3 Settings to Database option. To use this, the database connection has to be established. Clicking the "Database Settings" button displays the Database Parameters dialog box. The image of the dialog box that appears is given below. AdventNet, Inc. 62

64 Enter the necessary database parameters in this dialog box, and click the OK button. If the database connection is established successfully, all the user information entered is saved in the database. When the MibBrowser is invoked the next time, v3 details are restored and the v3 table is updated. The advantages of storing v3 table entries in a database are: Scalability - Any number of entries can be maintained in the database. Accessibility - All the authenticated users of the database can access the entries. The last section is the field entry section in which the corresponding fields in the v3 table are displayed for data entry. The various buttons available in the field entry section are Add, Modify, and Delete. To add an entry, enter the required parameters in the respective fields and click the Add Entry button. Based on the parameters and the security level, Discovery and Time Synchronization are done and USM Table is updated and listed in the v3 table. To modify an entry, select the entry in the v3 table, modify the required fields, and click the Modify button. Time Synchronization is done and the USM table is updated and listed in the v3 table. Note: The NoAuthNoPriv entry cannot be modified. Only the password fields in the AuthNoPriv entry and AuthPriv entry can be modified. To delete an entry in the v3 table, select the entry in the v3 table and click the Delete button. The entry is removed from the USM table. Note: The settings are saved only on exiting the MibBrowser application and not every time the settings are modified. The 'Save v3 Settings to File' option is enabled only in the MibBrowser application and not in the MibBrowser applet because of certain security restrictions in applets. The Restore Defaults button is used to reset the default parameters. AdventNet, Inc. 63

65 Setting MIB Parameters The Mib Settings tab is used to load MIBs in MibBrowser. The image below displays the Mib Settings tab. The first section gives the MIB loading options. Refer Loading MIBs and Unloading MIBs for more details. The next section displays the various parsing levels. Refer Parsing MIBs for more information. AdventNet, Inc. 64

66 MIB Operations Loading MIBs Unloading MIBs Parsing MIBs The basic MIB operations are loading, unloading, and parsing MIB files. A MIB file can be loaded directly, or from compiled files or from a database. AdventNet, Inc. 65

67 Loading MIBs Follow the steps given below to load a MIB file. 1. Click the Load MIB Module button or select File-->Load MIB from the menu. Alternatively, you can use the shortcut combination Ctrl + O. This displays the Load a Mib File dialog box as shown below. 2. In the Load a Mib File dialog box, select the MIB file from the mibs folder. Note: If MibBrowser is used as an applet, the URL should be relative to the Web server path. If MibBrowser is used as an application, the specified URL can be absolute or relative. When you use the MibBrowser applet, it is not possible to read a file on some host that is not the applet's host because of the browser security. In the MibBrowser applet, remote browsing of MIB file is supported through SAS. There are other options for loading the MIB file. Click the Recent tab to load the recently loaded MIB files. The Recent section of the Load a MIB File dialog box is shown below. AdventNet, Inc. 66

68 Select the check box next to the MIB that is to be loaded and click Open to load the MIB file. MIBs can also be loaded from configuration files using the Load MIB from File option in the File menu. A sample configuration file is provided below. mibs\rfc1213-mib RFC1213-MIB mibs\application-mib APPLICATION-MIB mibs\mymib.txt ATM-MIB This file should contain the path of the MIB file to be loaded and the name of the MIB module, both separated by a pipe symbol. Here the path of the MIB file should be relative with respect to the <AdventNet/SNMP Utilities> directory. The absolute path can also be provided in case of MibBrowser application. Note: The Load All MIBs option in the File menu loads all the recently loaded MIBs. Let us have a detailed overview on the various options available in the MIB Settings section of the Load a MIB File dialog box. AdventNet, Inc. 67

69 MIB Loading Options The various options available for loading MIBs are: Load MIBs directly Load MIBs from compiled files Load MIBs from a database The following image depicts the Mib Settings tab in the Load MIB dialog box. Load MIBs Directly The MIB file is usually read and parsed into MIB modules and displayed in the MIB tree. In this case, when you load a MIB file, it is parsed and then loaded. This is time consuming because parsing is done every time a MIB file is loaded. Load MIBs from Compiled Files The next option is loading of the MIB files as compiled files. The main advantage here is that the loading time is reduced. This ultimately leads to the improvement in performance. To store the MIB information in a formatted structure, the following two new file types are made available. cmi - This file type contains MIB information, such as MibNode, MibModule, naming hierarchy, etc. cds - This file type contains the description and reference of the MIB nodes. When the option Load MIBs from Compiled File is selected, the MibBrowser loads the MIB from the cmi and cds files. If these files are not present, MibBrowser parses the MIB file, writes the output in the cmi and cds files, and loads the MIB file. For example, if you load the RFC1213-MIB, the MIB file is parsed and stored in the compiled MIB files as RFC1213-MIB.cmi and RFC1213-MIB.cds provided RFC1213-MIB is the module name of the RFC1213-MIB file. When this MIB file is loaded again, the MIB is loaded from the cmi and cds files and no parsing is done. The advantage of using this option is, we need not parse the MIB each time we load, thus optimizing the load time and improving the performance. While loading the compiled MIBs, you need to load only the cmi file. The cmi file has a reference to the cds files. Therefore, the cds file need not be loaded directly. Note: Any changes made to the MIB file after it has been loaded as a compiled MIB file are not reflected when it is loaded again. You have to remove the existing cmi and cds files and load the MIB again to view the latest changes. To overcome this, select the option" Overwrite existing Compiled MIB Files". If this option is set to true, the cmi and cds files are created each time the MIB is loaded. However, enabling this option is recommended only if you have changed the contents of the MIB file. Otherwise, this serves as a redundant option and increases the load time of the MIBs. Note: In applets, the option of loading MIBs from compiled files has restricted usage. This is because of certain restrictions in file creation. That is, the cmi and cds files cannot be created while loading the MIB file. However, we can load the previously created compiled files by selecting the Load MIBs from compiled File option. Therefore, when no cmi and cds files exist for loading the MIB file, you can select the "Load MIBs directly" option. To convert the normal MIB files to the cmi and cds format, the MibToCMI utility can be used. This class is available in the AdventNetSnmp.jar present in the <AdventNet/SNMPUtilities/jars> directory. To use the utility, set the CLASSPATH to the AdventNetSnmp.jar file and give the following command. java com.adventnet.snmp.utils.mibtocmi directory name or file, another directory or file AdventNet, Inc. 68

70 The conversion can be done for individual files or for an entire directory of MIB files. If the utility is used across directories, the existing cmi and cds files should first be deleted from the directory. Loading MIBs from a Database The third option is loading of the MIB files from a database. The MIB files can be stored in any RDBMS such as MySQL or Oracle. Applications can load these MIB files directly from the database. This feature is particularly useful when the MIB files to be loaded are more in number. The MibBrowser uses JDBC (Java Database Connectivity) for the database support. Applications should use a valid JDBC driver of the respective databases to enable the database support. Selecting the option Load MIBs from Database enables the text fields in the JDBCParams section. On initializing the necessary database parameters in this section, the database support can be provided for loading MIBs. The required JDBCParams are as follows. Drivername - name of the database driver. URL - URL pointing to the database filename. UserName - name of the user. Password - password for the user. After selecting this loading option, select the required MIB file to be loaded from the Open tab of the Load a MIB File dialog box. If the selected MIB file is already present in the database, the MIB file is read, parsed, and loaded from the database. If the MIB file does not exist in the database, MibBrowser parses the MIB file, writes the output to the database, and then loads the MIB file. Note: The recently loaded MIBs can be loaded automatically at startup by selecting the option, 'Load recently loaded Mibs at startup'. Instructions for Using MySql Database for Loading MIBs Having tested the loading of MIB files from the MySQL database, we understand that the following database parameters have to be configured in the application. driver name - org.gjt.mm.mysql.driver url - JDBC: mysql://<machine name>/<database name> username - a valid user name password - password for the above user The jar file mysql_comp.jar has to be included in the CLASSPATH. If the jar is not in the CLASSPATH, the following exception is thrown. Java.lang.ClassNotFoundException:org.gjt.mm.mysql.Driver Instructions for Using Oracle Database for Loading MIBs The loading of MIB files from the Oracle database has also been tested. The following database parameters are to be configured in the application. driver name - org.jdbc.driver.oracledriver url - jdbc:oracle:thin:@<machine name>:1521:<database name> username - a valid user name password - password for the user AdventNet, Inc. 69

71 The oracle driver has to be included in the CLASSPATH. If the jar is not present in the CLASSPATH, the following exception is thrown. Java.lang.ClassNotFoundException:oracle.jdbc.driver.OracleDriver For other databases, use the equivalent parameters. A few MIB files are provided in the mibs directory, i.e., RFC1213-MIB, RFC1271-RMON, RFC1155- SMI, RMON2-MIB, TOKEN-RING-RMON-MIB, and RFC1315-FRAME. It may be convenient to copy your MIB module files that are to be loaded into the "mibs" directory. Note: Apparently, MIBs are always parsed before loading when the following operations are performed. Loading MIBs directly Loading MIB from Compiled File for the first time Selecting the "Overwrite existing compiled MIB files" option Loading MIB from database for the first time AdventNet, Inc. 70

72 Unloading MIBs The next basic MIB operation is unloading. To unload the MIB, select the node of the MIB tree and click the Unload MIB Module button or select File-->UnLoad MIB from the menu. Alternatively, you can press the Delete key. Performing any of the above prompts you for a confirmation. The following image depicts the confirmation dialog box. Selecting 'Yes' unloads the MIB module. If no module is selected in the MIB tree, all the loaded MIB modules are unloaded. The Load All MIBs option in the menu bar would load all the previously loaded MIBs and Unload All MIBs would unload all the loaded MIBs in the MIB tree. AdventNet, Inc. 71

73 Parsing MIBs MibBrowser enables you to parse the given MIB file and check for the macro constructs. It allows different levels of parsing and the parsing is done as per the standard definition of the macros. The parsing levels can be set in the MibBrowser Settings dialog box. The following table describes the different levels of parsing that can be set and their corresponding checks. S. No Level of Parsing 1 Lenient No Checks Checks 2 Normal Default checks 3 Serious 4 Critical Most checks throw exceptions on first misbehavior All possible checks throw exceptions on first misbehavior Description This level accepts all types of MIB files. For example, it allows both SMIv1 and v2. This level is the default level conforming to the obsolete standards, such as RFC 1902, RFC 1903, etc. Most MIBs follow the obsolete standard. This level strictly follows the current standard. It accepts the constructs with interoperability and implementation problems. This level completely follows the SMIv1 and v2 standards. However, it does not accept the backward compatibility constructs, constructs with interoperability and implementation problems, etc. Applications, while loading MIB files, perform the following operations. Parsing and validating the syntax of the MIB module Constructing the MIB module into the tree structure While performing the parsing and validation of the MIB files, if the MIB modules fail to conform to the SMI standards, the loading will not be not done. However, the application requirements might mandate the loading of the non-standard files. On the other hand, some applications might require a stricter check on the compliance to the standards. The parsing and validating the syntax of the MIB file can be made configurable to suit the application requirements. MibBrowser handles this by providing parsing levels which facilitate to select the level of parsing required by the applications. In addition to the above four parsing levels, MibBrowser supports another level, which is user-defined. In case of user-defined level, you can define your own parsing level with the required checks at run time. Note: It is recommended to use the higher parsing level (SERIOUS, CRITICAL) for validating the MIB file and not for loading the MIB file in the application. It affects the performance of the application while loading the MIB files, because it takes considerable amount of time and resources, such as memory, CPU usage, etc. User-Defined Parsing Level In addition to the four parsing levels, you also have another level, which is user-defined to define your own parsing levels at run time. To add a user-defined parsing level, select the User-Defined option and click the Add button in the User-Defined Levels section. This displays the Customized Level dialog box. Double-click the Levels folder to display a list of all the checks as shown below. AdventNet, Inc. 72

74 By default, all the checks are included. Provide a name for the level in the Level Name text field. To add or remove checks from the level, select or deselect the checks and click OK. Note that if you select (or deselect) a parent check, all its child checks are also selected (or deselected). Click OK to add this level to the user-defined level list. The level of the parser has to be set in the MibParser before loading a MIB. This level, once set, is used for subsequent MIBs loaded. If the level needs to be modified for the next set of MIBs loaded, it has to be set again in the MIB Parser. In the Mib Settings tab of the MibBrowser Settings dialog box, select the required Parsing level, and click Apply. The MIB file can contain one or more MIB modules. MibBrowser loads all the dependency files to resolve the MIB module. If the dependency file is not present, the IMPORTS failed error is thrown. The parsing level can be set for the dependency file by selecting the Import File option and choosing Parsing Levels. AdventNet, Inc. 73

75 SNMP Operations SNMP GET SNMP GETNEXT SNMP WALK SNMP GETBULK SNMP SET MibBrowser allows the user to perform the typical SNMP operations. The operations are categorized as: Retrieving Data - GET, GETNEXT, WALK, GETBULK Altering Variables - SET Receiving Unsolicited Messages - Traps and INFORMS To perform any basic operation as categorized above, it is essential to specify the Object ID, the instance, host name, port and the community string. Changes can also be made to the parameters in the MibBrowser Settings dialog box. To get a vivid outlook on the MibBrowser settings, refer the Configuration topic. Specifying the Index To specify an object to an SNMP agent, both the Object ID (which defines the type of object) and the instance (the specific object of the given type) need to be provided. From the MIB you can get the Object ID, to which an instance needs to be added to completely identify the object of interest. For non-tabular or scalar objects, the instance is 0. For example sysdescr is a scalar object under the system group in RFC1213-MIB and it should be specified as sysdescr.0 in Object ID field of MibBrowser. In MibBrowser, this need not be specified if the MIB is loaded. i.e. RFC1213-MIB. MibBrowser adds it to the selected node while performing the GET operation. For tabular objects, the instance is defined in the MIB as index, and it is a sequence of one or more objects. For example, ifinoctets of iftable defined in RFC1213-mib, the index is ifindex (INTEGER) and may be specified as ifinoctets.1 provided that there exists a row with index 1 in the querying agent. Another example tcpconnstate of tcpconntable under tcp group of RFC1213-MIB. The indexes of the tcpconntable are tcpconnlocaladdress (IpAddress), tcpconnlocalport (INTEGER), tcpconnremaddress (IpAddress), tcpconnremport (INTEGER) and may be specified as tcpconnstate provided that there exists a row with Index in the querying agent where represents the value of the first index tcpconnlocaladdress (IpAddress), 1192 represents the value of the second index tcpconnlocalport (INTEGER), represents the value of the third index tcpconnremaddress (IpAddress) 80 represents the value of the fourth index tcpconnremport (INTEGER). To get the information about the MIB Node in the MIB Tree, click the Description icon or choose View -->Description menu item or use a shortcut of Alt + R. This gives a list of all the vital characteristics of the node such as the Node, OID, Path, MibModule, Syntax, Status, etc. AdventNet, Inc. 74

76 SNMP GET The GET operation is performed to get one or more values from the managed objects. Follow the steps to perform this operation. 1. Load the MIB file. The loading of MIBs and the options available has been dealt with in detail in the Loading and Unloading MIBs section. 2. Select the desired node in the MIB tree. 3. Click the "Get SNMP Variable" icon on the toolbar or select Operations-->Get from the menu bar. Alternatively, you can use the shortcut key combination Ctrl + G. This operation gets all objects under the selected MIB object, or the specific object if the MIB node and instance are specified. Note: If the selected node in the MIB tree has child nodes or columnar nodes, GET operation is performed as an SNMP walk. i.e. the values for all the nodes under that sub-tree are retrieved. In case, if the MIB is not loaded in the MibBrowser, the exact numbered OID with full instance (for example for sysuptime) should be specified and the GET operation should be performed. Performing a Multi-Varbind Request To perform the Multi-Varbind request, follow the steps given below. 1. Make the Multi-Varbind display visible in the MibBrowser. This can be made visible by selecting the Multi-Varbind Tab or View-->Display-->Multi-Varbind from the menu. 2. Select the leaf node and append the instance by clicking the Add button. It will add the OID given in the Object Identifier field and the value given in the SetValue field both separated with a colon to the list. If value is not given in the SetValue field, NULL value is appended. Similarly, you can add as many number of OIDs and values as required. Note: Make sure you select the Multi-var check box before doing an SNMP operation for multiple varbind SNMP request. Otherwise, it does a request for the OID in the Object Identifier field. 3. To delete the varbind(s) from the list, select the varbind(s) from the list and click the Delete button. 4. To edit the varbind, select a varbind and click the Edit button. It shows an OID and the value of the varbind in the text fields to edit. Edit it and click the OK button to modify the OID and value or click the Cancel button to restore the old values. Note: When the request is sent under Multi-varbind mode, it goes as a single PDU irrespective of the number of OIDs added. Note: If you want to communicate with a v3 agent, you have to select the v3 option in the MibBrowser Settings dialog box and also make sure that the v3 parameters are set. Then perform the above steps for each of the operations. AdventNet, Inc. 75

77 Finding MIB Nodes You can find a specific node in the MIB tree using the Find dialog box. This is invoked by selecting Edit-->Find Node from the menu. Use the Find in All option in the Find dialog box to find a node in all the loaded MIB modules. AdventNet, Inc. 76

78 SNMP GETNEXT This operation is similar to the SNMP GET operation, but retrieves the value of the next OID in the tree. This operation is used for traversing the MIB tree. To perform this operation follow the steps 1 and 2 as in SNMP GET. Then proceed with the following step Click the "Get Next SNMP Variable" button on the toolbar or select Operations-->GetNext from the menu bar. Alternatively, you can use the shortcut key combination Ctrl + N. This operation will get the next object after the specified object, or the specific object instance, if a MIB node is specified. The instance may or may not be specified. You can also perform a multivarbind GETNEXT request. AdventNet, Inc. 77

79 SNMP WALK A SNMP WALK operation is nothing but SNMP GET performed on a selected mib node in the MIB tree which has child nodes or column nodes and perorm the OID walk through the child nodes or column nodes. If the selected node is a scalar node it performs a normal SNMP GET operation on that particular node. For example If the OID selected in the MIB tree is system of RFC1213-MIB, and on performing the SNMP WALK will walk through the child nodes of the system node until reaches the subtree node. If the SNMP WALK operations is performed on a scalar OID then, it returns the single variable value. If the OID is tabular it returns the all row values present in the corresponding OID. SNMPWALK operation is performed in all the SNMP version V1,V2c & V3. To perform this operation, follow the steps 1 and 2 as in SNMP GET Then proceed with the below step. Click the "Snmp Walk data variable " button or icon on the toolbar or choose Operation-- >SnmpWalk from the menu bar. Alternatively, you can use the shortcut key combination Ctrl + W. AdventNet, Inc. 78

80 SNMP GETBULK To retrieve voluminous data from a large table, the GETBULK operation is performed. A GETBULK request is performed by giving an OID along with two other parameters, namely a Max-Repetitions value and a Non-Repeaters value. The GETBULK operation is performed only on SNMPv2c and SNMPv3. To perform this operation, follow the steps 1 and 2 as in SNMP GET and continue with the following step 3 through step Configure the MibBrowser to either SNMPv2c or SNMPv3 as desired. This can be done using either the Edit-->Settings option in the menu bar or the MibBrowser Settings icon on the toolbar. You can also use the shortcut key combination Alt + S. For more details on settings, refer to the Configuration section. 4. Under the same MibBrowser Settings panel, the Max-Repetitions field and the Non-Repeaters field are enabled. The Max-Repetitions value specifies the number of lexicographic successors to be returned for the remaining variables in the variable-bindings list. The default value in this field is 50. The Non-Repeaters value specifies the number of variables in the variable-bindings list for which a single lexicographic successor is to be returned. The default value in this field is 0. Specify the values for these two parameters if you need to and then proceed with the operation. 5. Click the "Get Bulk SNMP data" button or icon on the toolbar or choose Operation-- >GetBulk from the menu bar. Alternatively, you can use the shortcut key combination Ctrl + B. This will get a sequence of Next Objects immediately after the specified object. The number of Object instances returned is equal to the Max-Repetitions field. AdventNet, Inc. 79

81 SNMP SET Most network devices have a default value maintained by the agent. Sometimes applications modify the data for one or more MIB variables, thereby using the SNMP SET operation. The following steps will guide you to understand how you can perform the SET operation. 1. Load the MIB file. The loading of MIBs and the options available have been dealt with in detail in the MIB Operations section. 2. Select the desired node in the MIB Tree to which value has to be set. The SET operation can be performed only on the node that has read-write access. 3. Set the value in the Set Value field. 4. Click the "Set SNMP Variable" icon on the toolbar or select the Operations-->Set from the menu bar. You can also use the shortcut key combination Ctrl + W. Performing a Multi-Variable SET Operation To perform the multiple variable SNMP SET request, follow the steps given below. 1. Make the Multi-Varbind display visible in the MibBrowser. This can be made visible by selecting the Multi-Varbind Tab or View-->Display-->Multi-Varbind from the menu. 2. Select the nodes in the MIB tree for which the SET operation is to be performed and specify the value to be set for it in the SetValue field. 3. Append the instance by clicking the Add button. This adds the OID given in the Object Identifier field and the value given in the SetValue field, both separated by a colon, to the list. Similarly, you can add as many number of OIDs and values as required. Note: Ensure that the OID and the value that are given in the text fields are correct before you add them to the list. 4. Enable the "Multi-Var" check box present at the bottom and click the Set SNMP Variable button on the toolbar. The SET operation is performed on all the nodes added in the multivarbind list. 5. To delete the varbind(s) from the list, select the varbind(s) from the list and click the Delete button. 6. To edit the varbind, select a varbind and click the Edit button. It will show an OID and the value of the varbind in the text fields to edit. Edit it and click the OK button to modify the OID and value or click the Cancel button to restore the old values. Note: When the request is sent under Multi-varbind mode, it goes as a single PDU and not as broken PDUs (irrespective of number of OIDs added). If you want to communicate with a v3 agent, you have to choose Version3, from the list box in the MibBrowser Settings dialog box and also make sure that the v3 parameters are set. Then perform the above steps for each of the operation. To perform a SET operation for Octet String Type in hex format enter the bytes in hex format with each bytes separated by a colon and the entire string within single quotes. For example to give 0xff0a3212 enter 'ff:0a:32:12' in the Set Value field. Note: You can find a specific node in the MIB tree using the Find dialog box. This is invoked by selecting Edit-->Find Node from the menu. If you want to find a node in all the loaded MIB modules, select Find in All option. AdventNet, Inc. 80

82 The various values that have to be specified in the Set Value field with respect to the SYNTAX of the Object are given below. Base Datatypes/ TCs INTEGER/ Integer32 Value How to Set the Value Value in HexaDecimal Value in Binary 100 '64'h ' 'b Unsigned '64'h ' 'b OCTET STRING adventnet OBJECT IDENTIFIER NULL Counter/ Counter or '64'h ' 'b Counter '64'h Gauge/ Gauge32 BITS STRING BITS {zero(0), one(1), two(2), three(3), four(4), five(5) } 100 '64'h ' 'b / one three five / one 3 five '54'h/'54'H or 54h/54H '50'h'/'50'H or '5'h/'50'H ' 'b / '010101'b b / b Comments For the binary and hex formats, the value should be given within single quotes and should end with b/b and h /H respectively. Note: Binary and Hex values are always unsigned. It accepts all string values. It accepts all complete OIDs. if the OID doesn't start with a dot, the standard prefix " " will be added. It creates the SnmpNull object irrelevant to the input you give. It accepts all the string values. The trailing zeros can be omitted. E.g., '50'h the trailing can be used as '5'h TIMETICKS 100 '64'h ' 'b / IpAddress hostname NetworkAddress / hostname OPAQUE '64'h It accepts all string values given. DateAndTime TAddress MacAddress , 13:53:32.3, -7:0 or , 13:53: / 161 '07:cb:09:15:0d:35: 20:03:2d:07:00' or '07:cb:09:15:0d:35: 20:03' f1:f2:f3:f4:f5:f6 The value should be 8 or 11 bytes. '07:cb:09:15:0d:35:20:03:2d:07:00' (within single quotes)/ ,13:53:32.3,-7:0 (11 bytes length) or '07:cb:09:15:0d:35:20:03' / ,13:53:32.3 (8 bytes length) The value should be 6 bytes The ipaddress and port are separated by a slash. The value should be 6 bytes. Here each octet in hex format is separated by colon (:) AdventNet, Inc. 81

83 Table Handling Retrieving Table Data Adding Rows Deleting Rows AdventNet MibBrowser enables you to view the SNMP Table data in a separate window called the SNMP Table Panel. The table has a very user-friendly profile. The SNMP Table panel has various options using which you can add and delete rows, view graphs and use index editor. AdventNet, Inc. 82

84 Retrieving Table Data The data in the table can be retrieved with ease. The following steps gives you an insight into how to open the Data Table panel and work on it using the various options. 1. Specify the proper agent host name or IP address in the Host field of MibBrowser. 2. Load the MIB file in MibBrowser. To know more on Loading the MIB file, refer the Loading and Unloading MIBs section. 3. Specify a valid OID or select the OID by traversing through the Mib Tree. The OID should be a valid table OID. 4. Click the View SNMP data table button on the toolbar or choose View-->Snmp Table from the menu. You can also use the shortcut key combination Alt+T. 5. This would invoke the SNMP Table of the specified table OID. The figure below depicts the SNMP Table panel. Click the Start button at the bottom of the SNMP Table panel. The retrieval of data begins and the columnar objects are obtained and displayed in the table. 6. Click the StartPolling button to start the polling of the table. The polling interval is based on the Polling Interval value set using the Settings option. 7. Click the StopPolling button to stop the polling. 8. When you don't use the polling option, click the Refresh button to refresh the table. 9. The SNMP Table panel might retrieve more data so that the frame depicting the columnar objects would run to pages. When you need to navigate through the pages (rows), use the Next and Prev button. AdventNet, Inc. 83

85 10. The Page option at the bottom of the panel is used to specify how the table retrieval needs to be done. If the option is origin, the table is retrieved from the origin. If the option is index, the user can set an index value from which the table can be retrieved. 11. The host name as specified in MibBrowser will be displayed in the Host field. The page number and the number of rows in that page are displayed next to it. 12. It is possible to configure the SNMP Table panel. Click the 'Settings' button. This displays a dialog box with various options to configure the Table panel. The image below depicts the SNMP Table Settings panel. The various options available are listed below. PollingInterval - This specifies the time interval between each retrieval of data. The default value is 5 secs. Page Size (Rows) - The number of rows to be retrieved is set here. The default value is 50. No Of Column View - This specifies the number of columns to be displayed in the SNMP Table panel. The default is 5. Split Columns - When the size of the PDU exceeds the limit, the agent sends the error message "Too Big PDU Error". This field serves as an option for splitting the PDU. By default, the PDU is split into half. If the number of varbinds is set by the user, then multiple request with PDU containing number of varbinds set is sent. No of Columns/Request - This field is enabled on selecting the Split Columns check box. You can specify the number for splitting of columns. Port - This field specifies the port to which the request is made. Table OID - The table OID is specified here. AdventNet, Inc. 84

86 Community - The string that authenticates SNMP PDUs is specified here. The default value is public. Write Community - The string that authenticates SNMP PDUs while setting values is specified here. The default value is public. Max-Repetitions - This value specifies the number of lexicographic successors to be returned for the remaining variables in the variable-bindings list. The default value is 5. This is enabled only when the Retrieval Mode option is set to GetBulk. SnmpVersion - This gives the option to switch to any of the three versions of SNMP - v1, v2c, and v3. Graph Type - This gives the option to switch between Line Graph and Bar Graph. Retrieval Mode - By default, GETNEXT is enabled. The GETBULK option is enabled only on selecting v2c or v If you need to view the graph, click the Graph button. The section on Graphs gives you more details on the MibBrowser Graph component. 14. You can also add and delete rows in the table and a detailed explanation has been given in the next two sections. 15. In a table, if one of the index columns is an external index, i.e., the index value is shared by some other table, then the table is called an Augmented table. Augmented table comes into picture when there is a one-to-one dependency between rows of two tables. This situation might arise when a particular MIB imports another MIB and shares a single table. For example, ifxtable defined in IF-MIB is an augmented table, which has an external index ifindex augmented from iftable. Clicking the 'Augmented Table' button shows the columns of the table which augments the index from the original table. 16. Click the Index Editor button to edit the index and view the rows from corresponding index. 17. To make changes to a particular column values, right-click the columns. The various options available are: view column node details - This option gives the MibNode Information of the selected column. edit the header name for selected column - This invokes a dialog box in which you can change the header for the selected column. The image below is a screen shot of the dialog box. view graph for selected cell(s) - This option invokes the graph. It is possible to view the graphical representation for more than one cell by multiple selection of desired cells. add a new row to the table - This option is the same as the Add option available in the Table panel. A detailed overview on adding a row is given in the Adding a row section. AdventNet, Inc. 85

87 delete the selected rows from - This option is the same as the Delete option available in the Table panel. A detailed overview on deleting a row is given in the Deleting a row section. view the not-accessible index - A request cannot be sent to an index that is not accessible. In the table, the not-accessible index is not visible. Selecting this option would enable you to view the not-accessible index values. Note: Right-click the cell(s) to display the options Copy, Select All, and Clear Selection. However, these options are not available in case of applets. AdventNet, Inc. 86

88 Adding Rows To add a new row to an SNMP table from the manager, the table should be an SMIv1 table with entrystatus defined or an SMIv2 table with rowstatus defined. SMIv1 Tables with entrystatus Column The entrystatus column is used to manage the creation and deletion of conceptual rows in SMIv1 tables. This represents the status of a table entry. The status column can have the following. 'valid(1)' - indicates that the row exists and is available for use. 'createrequest(2)' - supplied by the manager wishing to create a row. 'undercreation(3)' - indicates that the row is created. 'invalid(4)' - supplied by the manager wishing to invalidate the corresponding entry. If a manager wishes to add a row, the status column should be set to createrequest(2). Immediately after the creation, the agent sets this object to undercreation(3). The entry remains in the undercreation(3) state until it is configured. Then its value is set to valid(1). If the status remains undercreation(3) for an abnormally long period, the agent sets the status to invalid(4). SMIv2 Tables with rowstatus Column In SMIv2 tables, the rowstatus column is used to manage the creation and deletion of conceptual rows. This column has six defined values as follows. active(1) - indicates that the conceptual row with all columns is available for use by the managed device. notinservice(2) - indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device. notready(3) - indicates that the conceptual row exists in the agent, one or more required columns in the row are not instantiated. createandgo(4) - supplied by a manager wishing to create a new instance of a conceptual row and make it available for use. createandwait(5) - supplied by a manager wishing to create a new instance of a conceptual row but not making it available for use. destroy(6) - supplied by a manager wishing to delete all the instances associated with an existing conceptual row. An existing conceptual row can be in any one of the three states, 'notready', 'notinservice', or 'active'. If the manager wishes to add a row in a single shot with values for all the columns, the status column should be given as 'createandgo(4)'. After the creation of a row, its value is set to active(1). If a row has to be created with values for only some columns, the status column should be 'createandwait(5)'. Also, this row with partially filled columns has the status 'notready(3)'. The entry remains in this state until the values for all the columns are set. After all the values are set, the agent changes this value to active(1). For SMIv2 tables, a new row can be added in three ways. CreateAndWait CreateAndGo using Multiple-Variable Set CreateAndGo using SNMP table UI AdventNet, Inc. 87

89 CreateAndWait In this method, you should SET the RowStatus with value "CreateAndWait" and SET each column one by one. Finally, SET the RowStatus to "Active". Each SET method can be performed either using MibBrowser or through command line application. CreateAndGo Using Multiple-Variable Set Instead of using multiple SET methods to create a new row, you can use Multiple-variable SET method to create a new row in a single SET method. For this, all the columns with their value should be given and RowStatus should be CreateAndGo. Multiple-variable SET can be done using the command line application. CreateAndGo Using SNMP Table A new row for a table can also be created using SNMP table User Interface. The following image displays the SNMP Table dialog box. Right-click any of the columns to display a context-sensitive menu. Select "add a new row to the table" to invoke the following dialog box. The user has to fill in all the information and click the OK button. AdventNet, Inc. 88

90 Deleting Rows To delete a row from an SNMP table from the manager, the table should be an SMIv1 table with entrystatus defined or an SMIv2 table with RowStatus defined. Using the SNMP table User Interface, you can delete a row from the table. Refer the following image for more information. AdventNet, Inc. 89

91 Graphs Line Graph Bar Graph One of the vital features of the AdventNet MibBrowser is the Graphs. The graphs depict the real-time plotting of the SNMP data. Currently, two types of graphs are supported - line graph and bar graph. The SNMP data to be polled should be of integer or unsigned integer data type. Typically, the values that are plotted will be of type Counter, Gauge, or Timeticks. AdventNet, Inc. 90

92 Line Graph The Line graph depicts the real-time plotting of the SNMP data. Follow the steps below to invoke a line graph. 1. Specify the proper agent host name or IP address in the Host field of MibBrowser. 2. Load the MIB file in MibBrowser. To know more on loading MIBs and other features associated with it, refer to the Loading MIBs section. 3. Specify a valid variable. The variable must be an integer or unsigned integer (Counter, Gauge, Timeticks). This variable can be entered directly in the variable field or it can be chosen by browsing through the MIB tree. 4. Click the 'View real-time graph' button in the toolbar or select View-->Line Graph from the menu. You can also use the shortcut key combination Alt+L. By default, the line graph is invoked. 5. The updated Line graph shows the results of periodically polling the agent for the specified OID. The image below depicts a Line Graph invoked from MibBrowser. AdventNet, Inc. 91

93 When you move the cursor over the graph, a box containing the current time and values is displayed. The various options available in the Line graph are tabulated below. Option Polling Interval Average over Interval X-axis Scale Show Absolute Time Max Poll Duration Show Polled Values Log FileName Log Polled Values Show Absolute Counters Disable Error Dialog Restart Stop Close Description This specifies the polling interval time. The default value is 5 secs. You can change the interval time as desired. By default, the graph shows the actual values of a variable for different hosts. In other words, the values of the specified OID are plotted for different hosts for the given polling interval. Selecting this option, the average of the values at a given polling interval are taken for plotting the graph. This specifies the X-axis scale. The minimum value is 300 secs and this is the default value. Changing this would alter the X-axis scale of the table. This option is enabled only on clicking 'Show Polled values' option. By default, the time is depicted in the graphs only as seconds. Selecting this option would give you the time in hours:secs. This option is used to view all the polled values in a particular time period. It is enabled only on clicking 'Show polled values' option. The default value is 3600 secs. This option is used to display all the polled values in a particular period of time. By default, this option is disabled. Only on selecting this option, the Max Poll Duration option is enabled. The filename for the log file can be set here. By default, the log filename is graph.txt. If "Log Polled Values" is selected, all the polled values are logged in this file. This option is not enabled when the MibBrowser runs as an applet because of security restrictions. Selecting this option would log the polled values. This would enable the option Log FileName. By default, the graph plots only the difference between the two Counter values. On selecting this, the plotting of the absolute value is performed. Selecting this option would stop displaying the error messages that pop up when a request times out. The Restart button is used to restart the polling. The Stop button is used to stop the polling. The Close button is used to close the graph window. Another way of invoking a graph is through the Table options. For a detailed overview on Table Handling and invoking a graph from the table window, refer to the Table Handling section. MibBrowser can plot multiple graphs showing values for different variables from different hosts. The image below shows the plotting of multiple graphs and with the option 'Show Absolute Counters' enabled. AdventNet, Inc. 92

94 AdventNet, Inc. 93

95 Bar Graph The Bar graph depicts the real-time plotting of the SNMP data. Follow the steps below to invoke a bar graph from the MibBrowser, which is similar to invoking a Line graph. 1. Specify the proper agent host name or IP address in the host field of the MibBrowser. 2. Load the MIB file in MibBrowser. To know more on loading MIBs and other features associated with it, refer the MIB Operations section. 3. Specify a valid variable. The variable must be an integer or unsigned integer (Counter, Gauge, TimeTicks). This variable can be entered directly in the variable field or it can be chosen by browsing through the MIB tree. 4. Select the View-->Bar Graph from the menu bar. You can also use the shortcut key combination Alt + B. 5. The updated Bar graph shows the results of periodically polling the agent for the specified OID. Note: The Bar graph does not have an option for plotting multiple variables in the graph. Therefore, in case of a columnar OID, you need to append the instance of the index in order to enable the plotting of Bar graph. For example, to plot a bar graph for the values of the first row of the columnar OID ifoperstatus (iftable), you need to first select the node ifoperstatus. Then, in the Object ID text field, append ".1" with the OID and select View-->Bar Graph from the menu. This plots the value of the first row of the column ifoperstatus. The image below depicts a Bar graph invoked from MibBrowser. AdventNet, Inc. 94

96 The various options available in the Bar Graph are tabulated below. Option Polling Interval Average over Interval Range Show Absolute Time Restart Stop Close Description This specifies the polling interval time. The default value is 5 secs. You can change the interval time as desired. By default, the graph shows the actual values of a variable for different hosts. In other words, the values of the specified OID are plotted for different hosts for the given polling interval. Selecting this option, the average of the values at a given polling interval is taken for plotting the graph. Altering the range would change the X-axis scale of the table. The default value is 300 secs. The other options are 600 secs and 1000 secs. By default, the time is depicted in the graphs only as seconds. Selecting this option would give you the time in hours:mins:secs. The Restart button is used to restart the polling. The Stop button is used to stop the polling. The Close button is used to close the Bar graph window. AdventNet, Inc. 95

97 Trap Handling The agent, when faced by some problem or error in the transmission of message, responds to the manager by sending unsolicited messages called traps. Traps are unsolicited messages sent from an SNMP agent to one or more SNMP Management applications. It is an asynchronous notification sent by the agent to the manager about some event occurrence in the device. In order to receive and view the incoming traps to the specified port, MibBrowser has Trap Viewer. To know more about viewing and parsing traps, refer Trap Viewer. AdventNet, Inc. 96

98 Internationalization AdventNet MibBrowser supports Internationalization. This allows using the MibBrowser application and applet in various languages without changing the source code. Localized content can be added easily and the same executable can be run worldwide. All the textual elements such as GUI component labels, and messages can be made suitable to the locale (combination of specific language and country) of the user. The following are the steps involved in enabling the Internationalization support to AdventNet MibBrowser. 1. The MibBrowser.properties file available in the <MibBrowser> directory is to be used as the template file. This file contains the English strings of all the GUI labels and the messages. 2. The MibBrowser.properties file has to be copied to the specified locale file. For example, to display the MibBrowser in French language, the MibBrowser.properties file is to be copied as MibBrowser_fr_FR.properties file. The language and the country are to be represented by the standard two-letter codes (fr - French and FR - France). If the specified locale file is not present in the specified directory, the default properties file MibBrowser.properties is searched and loaded. 3. The developer has to write the equivalent strings of the chosen language and country in this file. This will enable the MibBrowser to print the user-written strings instead of English strings. For all the strings for which corresponding locale-specific strings are not given, English strings are used. Note: The format given in the MibBrowser.properties file should not be altered. The English strings are provided with the "escape" sequence characters. For example, the string "Save MibBrowser Results As..." is provided as "Save\ MibBrowser\ Results\ As... ". However, the equivalent strings (of the chosen language) need not have the "escape" sequence included. For example, the equivalent string for "Save\ MibBrowser\ Results\ As... ". can be given as "my own language equivalent of the same text". Editing the properties file can be done using I18N Editor that is bundled with SNMP Utilities. Refer the section I18N Editor for more information on this tool. 4. Before instantiating MibBrowser, the locale and the font supported for the specified locale should be set. The locale and the font can be set in the Settings panel of Launcher, For example, to set the internationalization for the French language, open the Settings panel, select MibBrowser from the left pane and Options tab on the right pane. Then select the Language as 'fr(french)' and Country as 'FR(France)' from the list boxes. You can select the required font from the Font, Font size, and Font Style list boxes. The properties file should also be edited with proper French words and copied as MibBrowser_fr_FR.properties. The path of the property file can be specified in the Property File Path section. Note: TrapViewer can display the localized trap message in the message field of the trap. AdventNet, Inc. 97

99 Debugging and Decoding The MibBrowser application provides facility to view the debug output of the SNMP operations. The Debug window is used to show the PDU that is sent from the manager and the response PDU that is got from the agent. Invoking the Debug Window 1. Click the Debug icon in the toolbar or select View-->Debug from the menu bar. You can also use the shortcut key combination Alt + D. This would invoke the Debug window. 2. As long as this Debug window is opened, debugging is turned on and the debugging output is displayed. When this window is closed, debugging is turned off. The image below depicts a Debug window. 3. The three icons in the debug window provide the following function. Save MibBrowser Debug Results - Saves the debug information to a file. Print MibBrowser Debug Results - Prints the debug information to a file. Snmp Decoder - Switches over to the Decoder window. The Clear button clears the debug information and the Close button closes the Debug window., AdventNet, Inc. 98

100 Invoking the Decoder Window 1. To switch over from the Debug window to the Decoder window, click the Decoder icon. The Decoder icon toggles to a Debug button. 2. The three icons in the Debug window provide the following functions. Save MibBrowser Decoder Results - Saves the debug information to a file. Print MibBrowser Decoder Results - Prints the debug information to a file. Debug - Switches over to the Debug window. Note: The Save and Print options are available only when the MibBrowser is invoked as an application and not as an applet because of security restrictions. Performing the Decoding Operation The Snmp Decoder is used to decode the SNMP debug messages. The figure below depicts the SNMP Decoder. To decode the debug information, select the PDU in the debug window and click the Snmp Decoder icon. This will switch over to the decoder window. Now, the selected debug information is available in the "Hex PDU" text area. Click the Decode button to decode the information. The decoded message is displayed in the bottom panel of the Decoder window. If the debug message was stored in a file, the decoding can be done by loading the file. This can be done by clicking the Browse button in the Debug frame. You can also enter the URL in the File URL AdventNet, Inc. 99

101 text field and press the 'Enter' key. However, saving and loading of debug information files is done only in applications and not in applets. Note: You can select the entire PDU debug message displayed in the Debug window with all the strings and click the Decoder button to display the selected information in the Hex PDU text area. You can also save the debug message in the Debug window and load it in the Decoder window. The decoder will decode all the PDU dumps leaving the informative strings. The limitation in this is that the two continuous PDUs should have a string delimiter as a new line in between them. A sample PDU is depicted below c a e 30 0c b Packet from: :161 RequestID: 3 Received Time: Fri Jun 15 09:21:24:000 IST 2007 DATA: 30 2e c a b b 41 4e 4e 41 4e 4b 41 The highlighted strings will be the delimiter between the two continuous PDU dumps. In case there is no string delimiter as above, only the first PDU is decoded. You can also save the decoded information using the Save button. The Save button in the Debug view saves the debug information. AdventNet, Inc. 100

102 Error Messages The following is the list of MibBrowser related Error Messages and the different scenarios at which they will be displayed: S.No. Error Message When it is displayed 1 No ObjectID Specified. If OID is not specified before making a request. 2 No Host Specified. If HostName is not specified before making a query. 3 Host Name Should Be Entered. If SnmpTable is started without specifying the hostname. 4 Invalid OID Format If the OID specified is not a valid one Before making any query Invalid OID Format exception is thrown. It should be either Integer type or String type. It will be thrown during instantiating Line/Bar Graph, SnmpTable and for operations, such as GET, GETNEXT, GETBULK, SET, etc. 5 Invalid Table OID If SnmpTable is started, after specifying an invalid OID in the OID Textfield. 6 Table OID should be specified Snmptable started without specifying any Table OID Error Loading MIB: xyz If invalid file is loaded in the LoadMibDialog TextField 7 java.io.filenotfoundexception: for loading MIBSFile. Could not Open stream for But in the description TextField home/../adventnet/snmpv3/mibs/xyz.parser of MibBrowser the message thrown is, "Loading Mibs: xyz" 8 RequestFailed: Error: Request TimedOut To LocalHost The error message is thrown when doing the operations such as GET, GETNEXT, and SET and for creating SnmpTable, LineGraph or BarGraph window. 1. If the agent does not implement the OID that is queried. 2. If the agent queried is not present in the network. 3. If the port no. set is not valid for the agent queried. 4. If the Community&Write Community specified are not right. 5. If the OID queried doesn't contain any data. 6. If for v3 agents Security parameters are not set. AdventNet, Inc. 101

103 S.No. Error Message When it is displayed The error message is thrown when doing set operation 1.If, the OID is not instrumented by the agent for which it is setting value. 2.If the agent queried is not present in the network. 9 3.If the WriteCommunity RequestFailed: Get Response PDU received from specified is not right one If the Syntax of the value you Error Indication In Response: There is no such variable are setting is not as that name in this mib. required by the OID. ErrIndex: The same Exception is also thrown when ploting Graph for a leafnode is not instrumented by the agent for which it is setting value. And also when querying for data in an SnmpTable 1. If data is not available RequestFailed: Get Response PDU received from Error Indication In Response: A not writable error occurred. ErrIndex: 1 ErrorSending Set Request : com.adventnet.snmp.beans.dataexception: Error: OID not a leafnode. Error sending set request: com.adventnet.snmp.beans: DataException: Error: Creating Variable 13 LineGraphBean Error: can not plot string value Root LineGraphBean Error: can not plot these values : value...: value...: value Error: com.adventnet.snmp.beans.dataexception: InvalidTable OID:(oid choosen) ErrorSendingPDU: Failed to Authenticate the Security Parameters, for user SnmpEngineEntry not found for address( hostname) port(portno.) 17 LineGraphBeanError: cannot plot string value xyz. If the leafnode or OID for which you are setting value, has no read/write access. The Error Message is thrown during set operation, if the OID selected is not a leaf node. If setting value for a columnnode of a table does not have rowstatus. The exception is thrown when plotting Graph for a leafnode, 1. If value of OID selected is not of Integer/TimeTicks/ type. While plotting Line/Bar Graph, if the OID/LeafNode selected has syntax PhysAddress, NetworkAddress, IP Address, OBJECT IDENTIFIER, If SnmpTable is started, with OID which is not a Table OID. The exception is thrown while creating SnmpTable, 1.If the hostname specified, is of different version than v3 which is set in settings table. 2. If the OID/LeafNode chosen for plotting Graph is of String Type. AdventNet, Inc. 102

104 S.No. Error Message When it is displayed 18 Discovery failed for address (hostname) port (portno.) If wrong port number is set in the MibSettings panel. 19 Time Sync Failed for user (user name) Error in Getting DataBase Connection:Please check the jdbc parameters: com.adventnet.snmp.beans.mibexception: java.lang.classnot FoundException: Error in Getting DataBase Connection:Please check the jdbc parameters: java.lang.classnotfoundexception: (DriverName set) 22 Please enter the UserName 23 Sent request to hostname:port no. Request Failed :SNMPv3 Error in Response. usmstatsunknownusernames( ) Counter value = 2HostName 24 Enter the FileName of MibModule Error Loading MIB:(filename) java io FileNotFoundException: Couldn't open stream for filename.cmi Error Loading MIB:(filename with full path from home dir).cds com.adventnet.snmp.mibs.mibexception:the.cds file could not be loaded. Error Sending PDU: Failed to Authenticate the Security Parameters for user authuser USMUserEntry not found for this user. TimeSynchronizationFailure could have occurred. Error in (get/getnext/getbulk)request to hostname:port no. Failed to Authenticate the Security Parameters for user authuser USMUserEntry not found for Address hostname: 161 Error in get request from < hostname >: 161 Unable to encode PDU. Error in get request from < hostname >: 161 Failed to authenticate the security parameters for user privuser authkey length has to be 20. If wrong username/user password/priv password/ TargetHost/SecurityLevel is set in the MibSettings panel If DriverName/URL/User Name/Password has been set wrong when loading MIBs from database If the mysql.jar class is not present in the classes directory. If the Username is not set for the v3 User. If Security parameters are set after setting the version v3 for a v1/v2 agent and request is made. While loading the MIBs file if OK button is clicked without selecting any file in "LoadMibDialog". If any file chosen from outside the MIBs directory. When a.cds file is loaded. If ContextName/ContextEngineID is not set before making query for SnmpTable.(Database Mode) If ContextName/ContextEngineID is not set before making get/getnext/getbulk request get Request for a v3 User(Database mode) AuthProtocol: MD5 Context Name, ContextEngineID are not specified. Same exception is thrown for getnext, getbulk & set operation also.(for AuthProtocol MD5&SHA) get Request for a v3 User(Database mode) AuthProtocol: SHA Context Name, ContextEngineID are not specified. AdventNet, Inc. 103

105 S.No. Error Message When it is displayed If IfTable OID is chosen for 31 can not plot the chosen variable: plotting Graph. iso.org.dod.internet.mgmt.mib2.interfaces.iftable The Error will be thrown if the OID chosen is not a leaf OID sent get request to tonyjpaul:161 Request Failed: SNMPv3 Error in Respopnse: usm Stats Not InTimeWindows( ) CounterValue =13 tonyjpaul sent getbulk request to localhost:161 Request Failed: Get Response PDU recieved from Error Indication in response : This is a end of MIB View. ObjectID: NULLOBJECT:NULL Error Sending set Request: com.adventnet.snmp.beans.dataexception: Error: Mib node unavailable for OID. sent get request to < hostname >:161 Request Failed: Get Response PDU received from Error Indication in response : There is no such instance in this MIB. ObjectID: NULLOBJECT:NULL sent get request to <hostname>:161 Request Failed: Get Response PDU received from Error Indication in response : A no creation error occurred. Errindex:1 sent get request to <hostname>:161 No data available in this subtree Error in getting Database Connection. Please check the jdbc Parameters: com.adventnet.snmp.mibs.mibexception: java.sql.sql Exception: No suitable Driver. Error in Getting DataBase Connection:Please check the jdbc Parameters: java.sql.sqlexception: No suitable Driver. Error in Getting DataBase Connection:Please check the jdbc Parameters: java.sql.sqlexception: Can not Connect to MYSQL sever on smplinux:3306. Is there a mysl server is During getrequest for a v3 user Context Name, ContextEngineID not specified. Same Error Message is Thrown for other operations like getnext, getbulk, set If getbulk Operation is done for "org".(setting version v2/v3 for a v1 host) if the OID/LeafNode selected is the last node of the mib. The same Exception will be thrown for operations like getnext, getbulk also. Setting value for an OID which is not having any leafnode. Now it's thrown if we are choosing any OID from "enterprises". Get Operation on sysservices node for a v3 agent. This Error is thrown if the leafnode sysservices is not implemented by the agent. During set operation on iproutedest which has readwrite access & syntax of datatype:ip Address for a v3 user. As values can't be set if the column is not of Row-Status type. When doing a get request for a v2 agent at OID "transmission"( ) Exception is thrown when no data is available for that particular instance of OID. Error is thrown when connecting to the database for an agent of any version, if the DriverName set is not correct. This error is thrown when the URL set is not a valid URL for connecting to database.(mysql- >msql) This error is thrown when the URL set is not a valid URL for connecting to AdventNet, Inc. 104

106 S.No. Error Message When it is displayed running in the machine/port you are trying to connect to? (java.net.unknownhostexception) database.(snmplinux- >smplinux) 41 This error is thrown when the Error in Getting DataBase Connection:Please check the jdbc URL set is not a valid URL for Parameters: java.sql.sqlexception: General error: connecting to database.(test- Unknown database "<tst>" >tst) sent set request to <hostname>:161 Request Failed: SNMPv3 Error in Response : usmstatsnotintimewindows( )counter value = 75 <hostname> sent get request to <hostname>:161 Request Failed: Get Response PDU received from Error Indication in response : There is no such object in this MIB. ObjectID: NULLOBJECT:NULL Error thrown if the request is made after a certain interval of time.. This OID is not instrumented for the agent you are querying for or no data is available in this OID. AdventNet, Inc. 105

107 Trap Viewer Viewing Traps Viewing INFORMS Trap Mailer Parsing Traps Creating Parser Files Editing Parser Files In order to receive and view the incoming traps to the specified port, MibBrowser has Trap Viewer. Trap Viewer is a graphical tool to view the traps received from one or more SNMP agents. Trap Viewer can listen to one or more port at a time and the traps can be sent from any host. Trap Viewer can receive and display V2c/V3 INFORM messages. By default, the INFORM messages are sent to the port 162 of the SNMP entity. AdventNet, Inc. 106

108 Viewing Traps To open Trap Viewer, click the Trap Viewer icon on the toolbar or select View-->Trap Viewer from the MibBrowser menu. You can also use the shortcut key combination Alt + P. You can also invoke the Trap Viewer from Launcher. The image depicted below is a screen shot of Trap Viewer. Trap Viewer has a table that depicts the trap information and the text fields where the values for common parameters are entered. There are other options, such as Start, Stop, Trap Details, Delete Trap, and ParserEditor. Note: TrapViewer is capable of displaying the latest traps in the list. In case, user wanted to track more than traps, user has to click Enable Logging option. Then all the traps are logged in to the text file and these traps can be viewed using any text reader. Trapcounter will show actual trap count received by Trap viewer. Follow these steps to know more about the available options. 1. The value in the Port text field is set to162 by default. Enter the desired port in this field. 2. The default value of the Community field is public. Set the community of the incoming traps as desired. 3. Click the Add button to add the Port and Community list to the Trap list. This is visible in the TrapList list box. 4. The Port and Community list can be deleted by clicking the Del button. 5. Click the Load button to load the trap parser file. 6. In order to receive the traps now, click the Start button. Trap Viewer begins to receive traps from the specified port and community. 7. The traps when received are listed in the trap table. The trap table has the following five columns. o The Class column defines the severity of the trap. AdventNet, Inc. 107

109 o The Type column defines the type of the trap or the inform request. o The Source column represents the IP address of the source from where the traps were sent. o The Date column shows the date and time when the trap was received. o The Message column has the VarBind list of the trap, if any. 8. The status of the trap is displayed in the status pane at the bottom of the dialog box. Moreover, the Trap count and the inform count is displayed in the status pane. 9. To log the received traps, select the Enable Logging check box. The Log format can be either Text or XML, the default being text. All the incoming traps are logged to a file in the selected format. The name of the log file is TrapLog.txt / TrapLog.xml. 10. To mail the received traps to the configured addresses, select the Enable Mailing check box. Refer to the topic Trap Mailer for more details. 11. The details of the traps can be viewed by clicking the Trap Details button. You can also rightclick the trap in the trap table and select 'View Trap Details'. The image below is the screen shot of the Trap details. The various details available in the Trap Details frame are listed in the table below. Trap Details TimeStamp Enterprise Generic Type Description This field shows the value stored in the MIB-II sysuptime variable converted into hours, minutes and seconds. It is a 32-bit unsigned value indicating the number of centiseconds that have elapsed since the (re)start of the SNMP agent and the sending of the trap. This field shows the OID of the management enterprise that defines the trap message. The value is represented as an OBJECT IDENTIFIER value and has a variable length. This field shows the value based on the type of trap. The value is AdventNet, Inc. 108

110 Trap Details Specific Type Message Severity Entity RemotePort Community Node TimeReceived HelpURL Description categorized and numbered 0 to 6. They are 0-coldStart,1-warmStart, 2- linkdown, 3-linkUp, 4-authenticationFailure, and 5-egpNeighborLoss. The trap type value 6 is identified as an enterprise-specific value. This field can have values from 0 to The specific trap type indicates the specific trap as defined in an enterprise-specific MIB. If the Generic Type value is 6, this field shows a value greater than 0. If the Generic Type value is a value other than 6, then the field shows a value 0. This is a text field. By default, this field always contains the Varbinds in the Trap PDU. This can be replaced with the text. This field shows the severity or the intensity of the trap. It could be 0- None, 1-All, 2-Critical, 3-Major, 4-Minor, 5-warning, 6-Clear, and 7-Info. This field contains the source IP address from which the Trap was sent. This field reveals the port from which the Trap was sent by the originator. This field contains the Community string. Source This field contains the date and time when the trap was received. The URL shown here gives more details of the received trap. By default, the URL is <generic-type value> - <specific-type value>.html 12. You can stop listening to the port by clicking the Stop button. 13. When you need to delete a trap, select the trap and click the Delete Trap button. You can also right-click the trap in the trap table and select 'Delete the Selected Rows'. 14. Another option in Trap Viewer is the ParserEditor. Trap Viewer can filter the incoming traps according to certain criterion called the Parser Criteria. The configuration of the criterion is made possible by using the ParserEditor. A detailed overview has been given in the Parsing Traps section. AdventNet, Inc. 109

111 Viewing INFORMS TrapViewer is capable of receiving SNMP V2c/V3 Traps and INFORMS. Following steps to be performed to receive a SNMP V2c/V3 INFORMS in the TrapViewer. Inorder to send a V3 INFORM request from a agent entity, it requires the user credentials about the manager entity and the INFORM request will perform a discovery and timesync with the manager entity and then it issues the INFORM request. To perform discovery and timesynchronous operation with the Manager, it should have the USMUser credentials in it. User credentials can be added in the manager MibBrowser using the existing SnmpParameter panel by selecting the Entity as Local which represents the Manager entry and used for INFORM. Below image shows the SnmpParameter panel with user information and the Entity as "Local" representing the Manager entry. And below image depicts the list of userentries pertaining to the manager in the MibBrowser settings. AdventNet, Inc. 110

112 Below image depicts the MibBrowser after selecting the Manager user entry in the MibBrowser settings. If you select a Manager userentry, you cannot perform any snmpoperation. And hence the snmp operations menu and toolbars are disabled. Once the manager entry is added in the mibbrowser, say if you add the following user entry host : localhost ( Only localhost is allowed and other hosts are not allowed ). port : 8003 username : privuser SecurityLevel : Auth,Priv AuthProtocol : MD5 AuthPassword : authuser PrivProtocol : CBC-DES PrivPassword :privuser contextname : priv Entity : Local ( It should be local - Inorder to receive INFORMS ). Then you can use the sendinform.class example application which is part of the product. Refer to the same from AdventNet/SNMPUtilities/examples directory. Usage looks like Usage: sendinform [-d Debug][-v version(v2,v3)] [-c community] [-p port] [-u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-n contextname] [-i contextid ] [ -pp priv_protocol (AES/DES) ] [-m MIB_file] host TimeTicksvalue trapoid [OID value]... java sendinform -d -v v3 -p u privuser -a MD5 -w authuser -s privuser -n priv -pp DES -m../mibs/rfc1213-mib manager_host It initiates the discovery and timesync operations and then issues the V3 INFORM request. AdventNet, Inc. 111

113 NOTE : Inorder to have the Engine Boots count incremented for the manager, on every startup of the MibBrowser Engine Boots count is incremented and maintained in the Manager.config file present under the conf directory. This will work only for MibBrowser application and not for applets. Above said is all applicable for both UDP / TCP based MibBrowser / TrapViewer to receive v3 INFORM. Similarly, V2c INFORMS can also be sent using the sendinform.class file. java sendinform -d -v v2 -c public -p 8003 localhost Below image depicts the list of V3 / V2c INFORMs received in the TrapViewer. AdventNet, Inc. 112

114 Trap Mailer Trap Mailer helps you to mail the received traps to the configured addresses. To configure the trap mailing option, please follow the steps given below: Step 1: Configure the Mail addresses 1. From the Trap Viewer, click Configure Mail to open the Mail Configuration Wizard. 2. Specify the following and click Configure: i. Subject: Subject of the mail ii. From: From address of the mail iii. To: To address of the mail. You can specify all the to addresses as comma separated. iv. MailServer: Name of the mail server v. Suppress KeyWord: This is an optional field. Specify the key words (as comma separated), for which mails should not be sent. In other words, no mails will be sent if the received trap messages that contains the key words specified here. vi. Mail/Hr: Number of mails to be sent in one hour. Traps received exceeding this number will not be mailed, but will be logged if the logging option is enabled in the Trap Viewer. The values specified here will be written on to an XML file. When you click the Configure Mail button from the Trap Viewer again, the values will be retrieved from the XML and will be shown here. Step 2: Select the Enable Mailing check box. Selecting this option will enable the Trap Viewer to send the received traps by mail to the configured addresses. Note: Configuring the mail addresses alone will not send any mails. Only if the Enable Mail option is selected, mails will be sent. AdventNet, Inc. 113

115 Parsing Traps The Trap Parser editor is a tool to create a Trap Parser file. Trap Viewer parses the file created using the Trap Parser editor, with the help of the TrapParserBean, to match each incoming traps with certain criterion. Trap Parsers are required to translate or parse traps into understandable information because traps typically contain cryptic information which is not easily understandable to the users. The Trap Parser editor: configures Trap Parser files. parses the traps into an understandable format. Invoking the Trap Parser To invoke the Trap Parser editor, click the Parser Editor button in Trap Viewer UI. You can create a new Parser file from an existing Parser file or a MIB file. You also have an option to create a parser file from scratch using the Create Custom Parser File option. The image below depicts the first screen of the Trap Parser editor. Load Trap Parsers and MIB Files The next screen of the Trap Parser editor has the options for loading Trap Parser files. The Save option is not enabled when MibBrowser is used as an applet because of the security restrictions. There is also an option for loading MIB files that contain trap definitions. The image below shows the loading and saving options of the Trap Parser editor. AdventNet, Inc. 114

116 Match Criteria Each incoming trap has to essentially possess the Parser match criteria to be shown in the trap table. In the General tab of the next screen, you can enter any number of Parser match criteria into a single parser file with a different parser name. Trap Viewer looks for a match criterion sequentially. Once a criterion is matched for a trap, further checking of match criteria is skipped, and an event is fired to display the corresponding trap entry in the trap table. While listening to traps, only one parser file can be loaded by Trap Viewer. A parser file can have any number of match criteria. Trap Viewer checks all the criteria in a Trap Parser file sequentially until one criterion matches. The image below depicts the General tab of the Trap Parser editor. AdventNet, Inc. 115

117 The various match criteria are tabulated below. These are mandatory parameters. Match Criteria Generic Type Specific Type Enterprise OID Description Each trap has a generic type number. The Generic types are 0-coldStart, 1- warmstart, 2-linkDown, 3-linkUp, 4-authenticationFailure, 5- egpneighborloss, and 6-enterpriseSpecific. The number is to be specified for the Trap Parser. The trap is parsed only when the criteria matches. The only exception is that, a trap is parsed even when the generic field is left blank or a negative value is entered in the field. This field can have an integer value from 0 to If this field is to be matched, the Generic Type must always be enterprise specific. This is the SNMP enterprise identifier in the trap, which is used for unique identification of traps for a particular application. If you specify the OID in this field, the parser is applied only if the trap enterprise field begins with the enterprise field that you have specified. The only exception is that even when the enterprise field is left blank, the trap is allowed to be parsed. If you had loaded a MIB file or a parser file in the previous screen, the corresponding trap parsers are listed in the Parser List section. You can add, modify, or delete these parsers to create your parser file. For SNMPv2c traps, select the v2c option button and provide the SystemUpTime and the trap OID of the incoming trap that is to be parsed. For SNMPv2 traps, the various match criteria are tabulated below. Match Criteria SnmpTrapOID Description This is the OID that identifies the incoming trap specifies coldstart trap specifies warmstart trap specifies linkdown trap AdventNet, Inc. 116

118 Match Criteria SystemUpTime Description specifies linkup trap specifies authenticationfailure trap This is the up time value of the incoming trap. Traps are received only for the specified system up time value. This is optional. OID and Value In the OID tab, you can specify the multiple values in the OID and Value text fields to match. The Trap PDU should match all the OID:Value pairs to conform to this criterion. This criterion extends the matching criterion. The following image depicts the OID tab of the Trap Parser editor. Agent and Port In the Agent tab, the trap is sent by an agent, specified in the Agent and Port text fields. If the value of Port is 0, the source can send the trap from any port. The incoming trap must match any of the criteria in the Agent and Port text fields. The following image shows the Agent tab of the Trap Parser editor. Note: In case of TrapViewer invoked from the Applet, then the Agent address should be a IpAddress as it cannot perform a dnslookup based on the hostname specified. Specifying a hostname will give a "Unknown Host" error. AdventNet, Inc. 117

119 OutPut Event Parameters For each matching criterion, a trap name is given. The fields in the event details are configured in the Output Event section. Once the trap is matched by the criteria, the trap is added to the Trap Table. The Output Event parameters are shown as the Trap Details, which gives more specific information on the trap. By default, some of the field of the Output Event parameters are filled by a variable called parser variables usually starting with a "$". These variables substitute specific characteristics of the parser in the Trap Details. The following image shows the various Output Event parameters. AdventNet, Inc. 118

120 Each parser variable and its corresponding characteristics are tabulated below. Variables $Community $Source $Enterprise $Agent $SpecificType $GenericType $Uptime $* Characteristics This token is replaced by the community string of the received trap. This token is replaced by the source name/address of the received trap. This token is replaced by the enterprise ID of the received trap. This token is replaced by the agent address of the received trap. This token is replaced by the specific type of the received trap. This token is replaced by the generic type of the received trap. This token is replaced by the up time value in the received trap. This token is replaced by all the variable bindings of the received trap, including the OID and values of each variable binding. This token is replaced by all the SNMP variable values in the variable bindings of the received trap. This token is replaced by the (N-1)th SNMP variable value in the variable bindings of the received trap. This token is replaced by all the OID values in the variable bindings of the received trap. This token is replaced by the (N-1)th OID value in the variable bindings of the received trap. Note: Newly added trapparser entry will be taken effect only after all the fields under the General, OID, Agent, Output Event tabs are configured and then perform "Add" operation. And then on clicking the Next button, will list the newly added parser details along with the existing parser in a Jtable list. See below image for more details. AdventNet, Inc. 119

121 Creating Parser Files A parser file can be created using the Trap Parser editor. Let us now create a Parser file using the Trap Parser editor. Refer the Parsing Traps section for invoking Trap Parser and understanding the various parameters available under the Match Criteria. 1. Click the ParserEditor button in the Trap Viewer to invoke Trap Parser. 2. In General tab, enter the values for the Match Criteria parameters as follows. Generic Type: linkup Specific Type: 0 (because it is a Generic Trap) Enterprise OID: Note: For SNMPv2 traps, select the v2c option button and give the up time value (optional) and the trap OID of the incoming trap. 3. Select the OID tab and enter the following value. OID/Value (VarBinds): xyz 4. Select the Output Event tab. The values depicted for the parameters by default are listed below. Severity: "-" HelpURL: "$GenericType-$SpecificType.html" Message: "$*" AdventNet, Inc. 120

122 Change the values to: 1. Severity: Major 2. Message: This is a Message 5. Click the Severity Color button to change the color in which the trap is visible in the trap table. 6. Enter the trap name in the Trap Parser Name field in the Match Criteria section and click the Add button to add the Trap Parser to the Parser list. 7. Add more Match Criteria for the incoming traps and click the Save button to save the current parser criteria. Save the file with the name "test". The Parser filename is displayed in the Parser File text field. 8. Close the Trap Parser editor. When you need to modify the added Trap Parser, make the changes in the Match Criteria and OutPut Event Parameters, and click the Modify button. It is essential to save the parser file again to effect the changes. The created Parser file can also be edited manually. Refer Editing Parser File for more details. Filtering Traps Let us have an overview on filtering of the traps. Follow the steps to perform trap filtering. 1. Click the Load button in the Trap Parser editor to load the Trap Parser file. 2. Now, send a trap from the examples directory (sendtrap or sendv2trap) of the AdventNet SNMP Utilities package. Refer Examples for the usage of the applications. On receiving the trap, the trap is parsed and checked if it matches the criteria specified in the 'test' parser file. This trap is received because it conforms to the match criteria. Adding Trap Definition from Any MIB file to a Parser File To add a trap definition from any MIB file to a parser file, select the MIB file by clicking the Load button. The parameters are displayed automatically with their respective definitions in the Match Criteria and Output Event parameters sections. AdventNet, Inc. 121

123 Editing Parser Files The Parser file created by Trap Parser editor can also be edited using any text editor. When the Parser file is opened in any text editor, the contents of the Parser file would look like this. { #Fri Jul 06 09:54:01 IST 2007 SystemUpTime = name = parser SnmpTrapOID = custommatchdefn = color = helpdefn = ST = 0 agentaddressdefn = version = v2 textdefn = $* GT = -1 enterprise = severity = 0 } The content of the parser file reveals the various vital parameters of Trap Parser. The table below lists the various parameters and the ways to configure them. Parameter SystemUpTime SnmpTrapOID version custommatchdefn color severity helpdefn GT Configuration This is the up time of the agent when the trap is sent. This is the OID that identifies the trap. This is the SNMP trap version. This has the OID:Value pair as the match criteria. Example: \:abcd; \acme "\" is required before ":" for every OID value pair and each pair is separated by a ";" This depicts the color of the trap entry in the trap table. The value of the color ranges from -1 to This field shows the severity or the intensity of the trap. This severity determines how a fault is affected by this event. The type of this filed is an integer ranging from 0 to 7. 0 denotes none / -- 1 denotes All 2 denotes Critical 3 denotes Major 4 denotes Minor 5 denotes Warning 6 denotes Clear 7 denotes Info By default, 0 is assigned. The URL of the document associated with the trap is specified here. By default, it is <generic-type value>-<specific-type value>.html This depicts the Generic Type trap and the value ranges from 0 to 6. 0 denotes coldstart. 1 denotes warmstart. 2 denotes linkdown. 3 denotes linkup. AdventNet, Inc. 122

124 Parameter Configuration 4 denotes authenticationfailure. 5 denotes egpneighborloss. 6 denotes enterprise-specific. ST This is the Specific Type trap. The value can range from 0 to This will contain the agent:port pair, as the match criteria. Example: \:0; :0 agentaddressdefn "\" is required before ":" for every agent port pair and each pair is separated by a ";" enterprise This is the enterprise OID of the trap. textdefn This is the message text for this event in the ListTraps and logs. name The name of the parser is given here. AdventNet, Inc. 123

125 Proxy Forwarder Configurator The Proxy Forwarder Configuration tool is used to store the details on the agents, users and the Vacm details. It has a powerful and intuitive user interface which makes the task of making a SNMPv3 query much easier. The application supports the User Based Security Model (USM) and the View Based Access Control Method (VACM) of the SNMPv3. The Proxy Forwarder Configuration tool comes with powerful wizards which allows to configure the necessary information needed before making a SNMPv3 request. The different tables that can be configured using the Proxy Forwarder Configuration tool are AgentRoutingTable, USMUserTable and Vacm tables. The VacmTables can be skipped if the user need not require the access verifications to be done. The configurations must then be stored in a file. This can be done through the SaveConfig button provided in the tool. The data is stored in a serialized file, the name which the user has chosen. Configuration information can also be loaded from a previously saved file. This can be done with the LoadConfig button provided. The configurations have to be explicitly saved by the user. Otherwise the application does not save them. This section gives an overview of the Proxy Forwarder Configuration and various other wizards. Follow the links below to get a detailed overview on each of the sections. Agent Configuration - allows to configure various agent hosts to be queried. User Configuration - allows to configure various security levels for the users. VACM Configuration - allows to configure the VACM details. The wizard also has a table view in which the VACM details can be configured in the corresponding tables. AdventNet, Inc. 124

126 Agent Configuration The Agent Configuration wizard is the default screen when the Proxy Config tool is launched. The following entries can be configured in this wizard. contextid - the config tool identifies each remote agent (v1/v2c) with a contextid. This is specified here. version - the version of the remote agent v1, or v2c. community - the target SNMP agent's community. remote host - the target SNMP agent's host name. port - the target SNMP agent's port number. After completing the entries, selecting the "Add Entry" button adds the entries into the table. Multiple agents can be added similarly. AdventNet, Inc. 125

127 User Configuration The User configuration wizard is used for configuring the users. Users with different security levels can be configured using this wizard. The following are the details that needs to be entered: User Name - enter the user name here. Security Level - security level of the user, classified in the following ways o noauthnopriv o AuthnoPriv o AuthPriv Auth Protocol (MD5, SHA) - choose the Authentication protocol here. Priv Protocol - by default CBC-DES. Auth Password - the authentication password is entered here. Priv Password - the privacy password is entered here. After completing the entries, selecting the "Add Entry" button adds the entries into the table. Multiple users can be added similarly. AdventNet, Inc. 126

128 VACM Configuration The Vacm configuration wizard is used for configuring the various Vacm details needed for the v3 request. The Vacm details can also be configured as various tables. Selecting "Table View" button toggles the wizard to the Vacm Tables screen. Advanced users can use the tables to configure the necessary details. The "Wizard view" button can be used to toggle to the wizard screen. The following entries can be configured in the wizard. User Name: the V3 user name. If the user name is already configured in the User configuration wizard it lists the available users. Context Name: the context name for the v3 request is specified here. Access rights: the tabs Read, Write, Notify is used to specify the access rights for the particular context. The view name and the sub-tree OID needs to be entered. Selecting the OID button launches the MibBrowser through which the OID value can be set. The "Advanced" buttons are used to set some advanced Vacm configurations. See the relevant Vacm table section for the details. After completing the entries, selecting the "Add" button adds the entries into the corresponding table. An overview of the various tables under VACM Configuration are listed below: Vacm Context Table Vacm Group Table Vacm Access Table Vacm Family Table AdventNet, Inc. 127

129 Vacm Context Table This table lists the various locally defined contexts by context name. Vacm Group Table This table is used to provide information on various groups, their security names and the allowed security levels. A group defines the access rights given to the security names which belong to that group. Various group names with differing access levels can be defined in the Group Table. Currently the application supports only the USM model and by default it is specified. AdventNet, Inc. 128

130 Vacm Access Table This table lists the access rights and restrictions of the various groups. The access control is provided on the following basis: For a particular context - identified by the context name to a group - identified by the group name has access using a specific security model and the security level The group's access rights are given by read - for retrival operations - get, getnext and getbulk. write - for write operations - set notify - for notification operations - trap In the table above the context name has to be entered in the "Prefix" field. Depending on the selection in the "Match" field (either exact or prefix) the context name can be entered in full or partially (prefix only). Vacm Family Table This table lists the Mib View and the sub tree for which the user or the group has access. Users can specify the view name and the OID for the sub tree. The "mask" field is used to control which elements of the OID subtree should be regarded as relevant when determining which view an OID is in. Normally, the whole of the OID should be included, so you'll need a mask with as many bits set as there are OID elements. Thus, ".1" (the whole dod tree) has one element, so the mask has one bit set - i.e. '80' (in hex). ".iso.org.dod.internet.mgmt.mib-2" has six elements, so six bits set ('fc'). If there are more than eight elements, you specify the longer masks as single octet values, separated by dots (e.g. 'ff.c0' for 10 bits) AdventNet, Inc. 129

131 AdventNet, Inc. 130

132 Proxy Forwarder The Proxy Forwarder application is used to translate SNMPV3 request for SNMPv1/v2c agents. The Proxy Forwarder is a multilingual application which forwards SNMPv3 requests to any of the SNMPv1/v2c agents configured and gives back the response. Multiple SNMPv3 mangers can talk to multiple SNMPv1/v2c agents through the Proxy Forwarder. The user should first use the Proxy Forwarder Configuration tool to configure the different tables: AgentConfigurationTable USMUserTable and Vacm tables Then the ProxyForwarder application can be started. The mandatory parameters are the port at which the ProxyForwarder should be started and the serialized configuration file The ProxyForwarder application takes the configurations from this specified file and initializes the proxy application. An option is provided while starting the ProxyForwarding application to specify if Vacm should be used for access verifications. By default the access verifications are skipped. AdventNet, Inc. 131

133 I18N Editor The I18N Editor is the tool used for internationalization. For editing the EnglishToNative.properties file, you are recommended to use the I18NEditor. The editor can be invoked from the Launcher. On invoking, the editor opens the default directory in the file chooser, to open a text or properties file. On opening the file, the editor displays a table to list the properties. The table contains two columns viz. Property Key and Property Value. The customizing text needs to be filled in the Property Value column. New properties can be added and existing properties can be deleted. The UI of the I18N Editor is depicted below. Menu Options The File menu has three menu items viz. Open, Save and Exit. Open and Save menu items are for the files. Only text and properties files can be opened. Exit menu item will exit the application. The Edit menu has four menu items viz. Find, Add, Delete, and Edit in Editor. These menu items are for manipulating the properties in the file. The View menu has two menu items viz. Prominent Entries, and All Entries. These menu items are for displaying the entries of the properties in the editor's display table. AdventNet, Inc. 132

134 SNMP Decoder SNMP Decoder provides facility to view the decoded output of the debug information. The top pane, the Debug pane, is used to display the PDU that is sent from the manager and the response PDU that is got from the agent. The Decoder pane at the bottom is used to decode the debug messages. The image below depicts the SNMP Decoder window. To decode the debug information, copy the PDU into the debug pane and click the Decode button to decode the information. The decoded message is displayed in the bottom panel of the Decoder. You can also select the debug information to perform selective decoding. If the debug message is stored in a file, the decoding can be done by loading the file. Loading a file can be done by selecting File-->Open from the menu. You can also save and print the debug information by using the File menu. The Save option saves the debug information to a file. To decode the information, click the Decode button at the bottom of the tool. The Find option in the File menu is used to find specific strings in the debug and decoder panes. Select the appropriate panes before using the edit operations. The Clear button clears the debug information and the Close button closes the Debug pane. The decoder will decode all the PDU dumps leaving the informative strings. The limitation in this is that the two continuous PDUs should have a string delimiter in a new line in between them. AdventNet, Inc. 133

135 A sample PDU is depicted below c a e 30 0c b Packet from: :161 RequestID: 3 Received Time: Thu Jul 05 19:10:39:988 IST 2007 DATA: 30 2e c a b b 41 4e 4e 41 4e 4b 41 The highlighted strings will be the delimiter between the two continuous PDU dumps. In case there is no string delimiter as above, only the first PDU is decoded. Following is another format for specifying the SNMP packet c69 63a e 300c b Packet from: :161 RequestID: 3 Received Time: Thu Jul 05 19:10:39:988 IST 2007 DATA: 302e c69 63a b b41 4e4e 414e 4b41 AdventNet, Inc. 134

136 SAServer-WebServer The Web Server and the SNMP Applet Server (SAS) facilitates in loading the applets that are distributed as part of the AdventNet SNMP Utilities package. While any web server (like apache) can be used for loading the applets, the SAS server is required for the communications across the network. The SAS server is used for by-passing the security restrictions of the browsers. Java applets run in Web browsers, and these browsers often place restrictions on the capabilities of the applets, sometimes for valid security reasons. For example, currently, an applet in many browsers cannot communicate directly with any host on the network, except the web server from which the applet was downloaded. For applets, the AdventNet SNMP utilities package provides special support to get around the security restriction above. AdventNet provides a Java program for the web server called the SNMP Applet Server (SAS) that allows the applet to send and receive SNMP packets from any managed devices accessible from the applet host. For detailed instructions on invoking MibBrowser applet, refer the Invoking Applet section. AdventNet, Inc. 135

137 Examples Setting Up the Environment SNMP GET SNMP GETNEXT SNMP GETBULK SNMP SET Send v1 Traps Send Notifications Send Inform Request Receive Inform Request Trap Receiver This section details about the various example applications that are bundled with AdventNet SNMP Utilities package and the instructions on setting up the environment to use them. AdventNet, Inc. 136

138 Setting Up the Environment This section gives an overview of the usage of the various command line tools and the issues associated with running network management applets. You can use the applications, such as snmpget, snmpgetnext, etc. available with this package to query information from the SNMP agents. All the applications that are used to query an agent have identical syntax. These examples can also be used as tools to perform some simple SNMP management operations on remote agents. The product distribution includes various example applications in the <examples/applications> directory of the package. Detailed usage instructions on the examples provided in the AdventNet SNMP Utilities package are explained in the subsequent sections. You can use these applications to manage devices and applications easily. As a general rule, all the command line tools gives help information when we type: java <command-name> For example, to get help information on the command snmpgetnext, just type: java snmpgetnext All the example applications can be executed by setting the proper environment variables (setenv.sh or setenv.bat). Note: You must have successfully installed the AdventNet SNMP Utilities product and completed the Installation and Setup procedure. It is very important that you complete the setup procedure before you begin to use the example tools and applications. AdventNet, Inc. 137

139 SNMP GET The snmpget example is used to query SNMP information in a remote host in which the agent runs. The following command can be used to perform an SNMP query. java snmpget localhost The above command performs a GET operation on the SNMP agent running on localhost to get the value of the variable 1.1 (sysdescr) and display the results. Depending on whether the localhost has an SNMP agent installed, you get sysdescr or time out message. It takes several seconds for either result. By default, it uses the UDP port 161, SNMP version 1, and the community name public. Other options, such as timeout, retries, setting the debug on, etc. can also be set in the command line. For example we can give the following command for a v2c request in the port (8001) with community name private. java snmpget -v v2 -c private -p 8001 localhost Note that the given OID does not start with a dot (.). OIDs not starting with a dot are prefixed by Therefore, the entire OID of becomes We can also give the entire OID for the request. The OID can also be given in the String format instead of the numeric format if we load the corresponding MIB file. For example, java snmpget -m../mibs/rfc1213-mib localhost sysdescr.0 java snmpget -m../mibs/rfc1213-mib localhost.iso.org.dod.internet.mgmt.mib-2.system.sysdescr.0 We can also make multiple OID queries in a single request as follows. java snmpget localhost To query an SNMPv3 agent running on a system v3agenthost, listening for SNMPv3 requests on port v3port, we need to know the users configured on the agent and their security configuration. Let us assume that the following USM configuration exist for v3agenthost. S.No. UserName SecurityLevel authprotocol authpassword privprotocol privpassword 1 initial NoAuthNoPriv none none none none 2 initial_a AuthNoPriv MD5/SHA initialpass none none 3 initial_ap AuthPriv MD5/SHA initialpass DES/AES initialpass Let us look at how this SNMPv3 agent can be queried using the snmpget application available with this package. To query the same information with this SNMPv3 agent without using authentication and privacy (NoAuthNoPriv profile), use the following command. java snmpget -v v3 -p v3port -u initial v3agenthost To query using authentication and no privacy (AuthNoPriv profile), the following command is used. java snmpget -v v3 -p v3port -u initial_a -a MD5 -w initialpass v3agenthost AdventNet, Inc. 138

140 To query using authentication and privacy (AuthPriv profile), use the following command. java snmpget -v v3 -p v3port -u initial_ap -a MD5 -w initialpass -s initialpass v3agenthost One of the common errors that are made during the snmpget request is to query the agent without giving the instance value of the object. To specify an object to an SNMP agent, both the Object ID (which defines the type of object) and the instance (the specific object of the given type) need to be provided. For non-tabular or scalar objects, this is simply an instance of 0 (e.g. sysdescr.0). For example, if we make the following request without giving the instance value, java snmpget localhost 1.1 we get the following error: Request failed or timed out. Error Indication in response: There is no such variable name in this MIB. Errindex: 1 Therefore, we need to make sure that we completely specify the OID plus instance as follows. Usage java snmpget localhost The usage of the snmpget is provided below. The "-d" option enables the debug and prints the packet dumps. The "host" and the "OID" arguments are mandatory and the rest are optional. java snmpget [-v version(v1,v2,v3)] [-m MIB_files] [-c community] [-p port] [-t timeout] [-r retries] [-u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-n contextname] [-i contextid] [-d debug] [ -pp priv_protocol (DES/AES) ] host OID [OID]... Options [-d] - Debug output. By default, off.me [-v] version (v1/v2/v3) - Version to use v1, v2 or v3. Default value is v1. [-c] community - community string used only for v1 and v2 and not for v3. [-p] port - Remote port number. By default, 161. [-t] port - Timeout specified in milliseconds. [-r] port - Number of retries for snmp get request. [-u] user - The v3 principal/username. Mandatory. Supplied only for v3 operation.. [-a] authprotocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Supplied only for v3 operations. [-w] authpassword - The authentication password. Supplied only for v3 operations. [-s] privpassword - The privacy protocol password. Must be accomspanied with authpassword and authprotocol fields. Supplied only for v3 traps. [-n] contextname - The contextname to be used for the v3 operations. [-i] contextid - The contextname to be used for the v3 operations. [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is given. host - Remote host (agent). Mandatory. OID - Object Identifier. Mandatory. AdventNet, Inc. 139

141 SNMP GETNEXT The snmpgetnext example is similar to the snmpget example, except that GETNEXT retrieves the value of the next OID in the tree. For example: java snmpgetnext localhost The above command performs a GETNEXT operation with the SNMP agent running on localhost to get the value of the variable 1.2. (sysobject ID) and display the results. Depending on whether the localhost has an SNMP agent installed, you get the next OID sysobjectid or time out message. It takes several seconds for either result. Note that it does not return the value of 1.1 but 1.2, the OID next to 1.1. All the remaining options such as making multiple OID requests, specifying versions, etc., are applicable to this utility also. Refer SNMP GET for details. Also, providing the instance value as part of the OID is not mandatory. The snmpgetnext always returns the next OID in the MIB tree regardless of whether we specify the particular instance of OID. Therefore, the following command is equally valid. Usage java snmpgetnext localhost 1.1 The usage of the snmpgetnext is provided below. The "-d" option enables the debug and prints the packet dumps. The "host" and the "OID" arguments are mandatory and the rest are optional. java snmpgetnext [-v version(v1,v2,v3)] [-m MIB_files] [-c community] [-p port] [-t timeout] [-r retries] [- u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-n contextname] [-i contextid] [-d debug ] [ -pp priv_protocol (DES/AES) ] host OID [OID]... Options [-d] - Debug output. By default, off.me [-v] version (v1/v2/v3) - Version to use v1, v2 or v3. Default value is v1. [-c] community - community string used only for v1 and v2 and not for v3. [-p] port - Remote port number. By default, 161. [-t] timeout - Timeout specified in milliseconds. [-r] retries - Number of retries for snmp get request. [-u] user - The v3 principal/username. Mandatory. Supplied only for v3 operation.. [-a] authprotocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Supplied only for v3 operations. [-w] authpassword - The authentication password. Supplied only for v3 operations. [-s] privpassword - The privacy protocol password. Must be accomspanied with authpassword and authprotocol fields. Supplied only for v3 traps. [-n] contextname - The contextname to be used for the v3 operations. [-i] contextid - The contextname to be used for the v3 operations. [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is given. host - Remote host (agent). Mandatory. OID - Object Identifier. Mandatory. AdventNet, Inc. 140

142 SNMP GETBULK The snmpgetbulk performs an SNMP GETBULK operation on a remote agent. The syntax and the command line arguments are similar to the snmpget and the snmpgetnext with two additional parameters specific to GETBULK operation namely Nonrepeaters and Max-repetitions. The GETBULK operation can be used only for v2c and v3 versions. For example, the following command works only if the agent version is v2c or v3. java snmpgetbulk localhost 1.1 The above command performs a GETBULK operation with the SNMP agent running on localhost to get the value of all the variables under the subtree 1.1. and display the results. Depending on whether the localhost has an SNMP agent installed, you get OIDs based on the Max-repetitions value, Nonrepeaters value, and the OID or time out message. All the remaining options such as making multiple OID requests, specifying versions, etc., are applicable to this utility also. Refer SNMP GET for details. Usage The usage of the snmpgetbulk is provided below. The "-d" option enables the debug and prints the packet dumps. The "host" and the "OID" arguments are mandatory and the rest are optional. java snmpgetbulk [-v version(v2,v3)] [-m MIB_files] [-c community] [-p port] [-t timeout] [-r retries] [-d debug] [-nr non-repeaters] [-mr max-repetitions] [-u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-n contextname] [-i contextid] [ -pp priv_protocol (DES/AES) ] host OID [OID]... Options given. [-d] - Debug output. By default, off.me [-v] version (v1/v2/v3) - Version to use v1, v2 or v3. Default value is v1. [-c] community - community string used only for v1 and v2 and not for v3. [-p] port - Remote port number. By default, 161. [-t] timeout - Timeout specified in milliseconds. [-r] retries - Number of retries for snmp get request. [-nr] non-repeters - Non-repeaters value, used for v2 or v3 getbulk operations. [-mr] max-repetetions - Max-repeaters value, used for v2 or v3 getbulk operations. [-u] user - The v3 principal/username. Mandatory. Supplied only for v3 operation.. [-a] authprotocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Supplied only for v3 operations. [-w] authpassword - The authentication password. Supplied only for v3 operations. [-s] privpassword - The privacy protocol password. Must be accomspanied with authpassword and authprotocol fields. Supplied only for v3 traps. [-n] contextname - The contextname to be used for the v3 operations. [-i] contextid - The contextname to be used for the v3 operations. [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is host - Remote host (agent). Mandatory. OID - Object Identifier. Mandatory. AdventNet, Inc. 141

143 SNMP SET The snmpset example allows the management application or the manager to SET the value of an attribute of a managed object in the agent. To perform the SET operation in a remote host in which the agent resides, we need to specify the OID, the data type and the value to be set. In this example, the datatype is taken from the MIB file. For example: java snmpset -m../../mibs/rfc1213-mib localhost testing The above command performs a SET operation with the SNMP agent running on localhost to set the value of the variable 1.5. (sysname) to "testing". The above command results in an SNMP SET operation to the localhost on the syscontact OID. Depending on whether the localhost has an SNMP agent installed, you get syscontact or time out message. It takes several seconds for either result. To check the new value, you can perform an snmpget and see the new value being retrieved. To perform the SET operation, loading the MIB file is a must because the type of the object is retrieved from the MIB file. If the MIB file is not available, we must give the type of the OID. We have provided another example for performing the SET operation without loading the MIB file. We need to have write permission to set the value for the managed object. Otherwise, the following error occurs (if the version is v1). Request failed or timed out. Error Indication in response: There is no such variable name in this MIB. Errindex: 1 If the version is v2c, the following error message appears. Usage Request failed or timed out. Error Indication in response: A no creation error occurred. Errindex: 1 The usage of the snmpset utility is provided below. The "-d" option enables the debug and prints the packet dumps. The "mib files" "host" "OID" and the "value" arguments are mandatory and the rest are optional. java snmpset [-v version(v1,v2,v3)] [-c community] [-p port] [-t timeout] [-r retries] [-u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-d debug] [-n contextname ] [ -i contextid ] [ -pp priv_protocol (AES/DES) ] -m MIB_files host OID value [OID value]... Options [-d] - Debug output. By default, off.me [-v] version (v1/v2/v3) - Version to use v1, v2 or v3. Default value is v1. [-c] community - community string used only for v1 and v2 and not for v3. [-p] port - Remote port number. By default, 161. [-t] timeout - Timeout specified in milliseconds. [-r] retries - Number of retries for snmp get request. [-u] user - The v3 principal/username. Mandatory. Supplied only for v3 operation.. [-a] authprotocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Supplied only for v3 operations. [-w] authpassword - The authentication password. Supplied only for v3 operations. AdventNet, Inc. 142

144 [-s] privpassword - The privacy protocol password. Must be accomspanied with authpassword and authprotocol fields. Supplied only for v3 traps. [-n] contextname - The contextname to be used for the v3 operations. [-i] contextid - The contextname to be used for the v3 operations. [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is given. host - Remote host (agent). Mandatory. OID - Object Identifier. Mandatory. Value - Value to set. AdventNet, Inc. 143

145 Send v1 Traps Traps are unsolicited messages sent by the agent to the management applications to report the conditions of the managed node. The sendtrap example can be used to send v1 traps. To send the v1 trap message, you need to provide the following values. remotehost - the manager station to which the trap message is sent. enterprise - the enterprise OID (sysobjectid for generic traps). agent-addr - the agent address from which the trap is generated. generic trap - the code for generic trap type. specific-trap - the code for specific trap type. timeticks - the time elapsed between the last initialization of the network and the generation of the trap. MIB file, OID, and value - values for building the varbinds. Trap messages not containing any varbinds do not need OID and value. The following commands generate a simple v1 trap. java sendtrap -m../../mibs/rfc1213-mib remotehost localhost java sendtrap -m../../mibs/rfc1213-mib remotehost localhost testing The above command sends a trap, generated by the agent residing in the localhost, to the manager station in the remotehost. A trap receiver program in the manager station can receive and display the traps. By default, the traps are sent to the port 162 of the manager station. Usage The usage of the sendtrap utility is provided below. The "host", "enterprise", "agent-addr", "generictrap", "specific-trap" and "timeticks" arguments are mandatory and the rest are optional. java sendtrap [-d] [-c community] [-p port] [-m MIB_files] host enterprise agent-addr generic-trap specific-trap timeticks [OID value]... Options [-d] - Debug output. By default, off.me [-c] community - community string. [-p] port - Remote port number. By default, 162. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is given. host - Remote host (agent). Mandatory. enterprise - enterprise oid agent-addr - Agent address generic-trap - Generic Trap Type specific-trap - Specific Trap Type. ( Enterprise specific ). timeticks - The value of object sysuptime when the event occurred. Mandatory. OID - Object Identifier. Mandatory. value - The object instance value to be set. Mandatory. AdventNet, Inc. 144

146 Send Notifications Traps are unsolicited messages sent by the agent to the management stations to report the conditions of the managed node. The sendv2trap example can be used to send v2c and v3 traps. SNMP v2c/v3 traps are also called as notifications. SNMP v2 notification is different from the v1 traps with much simplification. To send the v2c notification, you need to provide the following values. remotehost - the manager station to which the trap message is sent. timeticks - the time elapsed between the last initialization of the network and the generation of the trap. trapoid - the trap OID. MIB file, OID, and value - values for building the varbinds. Trap messages not containing any varbinds do not need OID and value. The following commands generate a simple v2c notification. java sendv2trap -m../mibs/rfc1213-mib remotehost java sendv2trap -p m../mibs/rfc1213-mib remotehost test The above command sends a trap to the manager station in the remotehost. A trap receiver program in the manager station can receive and display the traps. By default, the traps are sent to the port 162 of the manager station. Usage The usage of the sendv2trap utility is provided below. The "MIB_files", "host", "TimeTicksValue", and "trapoid" arguments are mandatory and the rest are optional. java sendv2trap [-d Debug][-v version(v2,v3)] [-c community] [-p port] [-e engineid( /0x )] [-u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-i contextname] [-g agent-address] [ -pp priv_protocol (DES/AES) ] [-m MIB_file] host TimeTicksvalue trapoid [OID value]... Options [-d] - Debug output. By default, off.me [-v] version (v2/v3) - Version to use v2 or v3. Based on this, v2 or v3 traps will be sent. If not specified v2c notification will be sent. [-c] community - community string used only for v2 and not for v3. [-p] port - Remote port number. By default, 162. [-e] engineid - Engine ID of agent. Supplied only for v3 traps. [-u] user - The v3 principal/username. Mandatory. Supplied only for v3 traps. [-a] authprotocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Supplied only for v3 traps. [-w] authpassword - The authentication password. Supplied only for v3 traps. [-s] privpassword - The privacy protocol password. Must be accomspanied with authpassword and authprotocol fields. Supplied only for v3 traps. [-i] contextname - The contextname to be used for the v3 PDU. Supplied only for v3 traps. [-g] agent-address - The Agent Address [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is given. AdventNet, Inc. 145

147 timeticks - The value of object sysuptime when the event occurred. Mandatory. OID-value - Object Identifier. Mandatory. host - Remote host (agent). Mandatory. OID - Object Identifier. Mandatory. value - The object instance value to be set. Mandatory. AdventNet, Inc. 146

148 Send Inform Request The sendinform example is used to send v2c and v3 inform requests. The inform requests can be sent from a manager to another manager. To send the v2c/v3 inform request, you need to provide the following values. remotehost - the manager station to which the trap message is sent. timeticks - the time elapsed between the last initialization of the network and the generation of the trap. trapoid - the trap OID. MIB file, OID, and value - values for building the varbinds. The following commands generate a simple v2c/v3 inform request. java sendinform -m../mibs/rfc1213-mib remotehost java sendinform -p m../mibs/rfc1213-mib remotehost test The above command sends an inform message to the manager application in the remote host. A trap receiver program in the manager station can receive and display the inform message. By default, the inform requests are sent to the port 162 of the manager station. Usage The usage of the sendinform utility is provided below. The "MIB_files", "host", "TimeTicksValue", and "trapoid" arguments are mandatory and the rest are optional. Usage: java sendinform [-d Debug][-v version(v2,v3)] [-c community] [-p port] [-u user] [-a auth_protocol(md5/sha)] [-w auth_password] [-s priv_password] [-n contextname] [-i contextid ] [ -pp priv_protocol (AES/DES) ] [-m MIB_file] host TimeTicksvalue trapoid [OID value]... Options [-d] - Debug output. By default, off.me [-v] version (v2/v3) - Version to use v2 or v3. Based on this, v2 or v3 traps will be sent. If not specified it will send the v2 inform. [-c] community - community string used only for v2 and not for v3. [-p] port - Remote port number. By default, 162. [-u] user - The v3 principal/username. Mandatory. Supplied only for v3 traps. [-a] auth_protocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Supplied only for v3 traps. [-w] auth_password - The authentication password. Supplied only for v3 traps. [-s] priv_password - The privacy protocol password. Must be accomspanied with authpassword and authprotocol fields. Supplied only for v3 traps. [-n] contextname - The contextname to be used for the v3 PDU. Supplied only for v3 traps. [-i] contextid - The contextid to be used for the v3 PDU. Supplied only for v3 traps. [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. [-m] MIB_file - Mib file to resolve the oid and this is mandatory if the OID-value is given. host - Remote host (agent). Mandatory. TimeTicksvalue - The value of object sysuptime when the event occurred. Mandatory. trapoid - Object Identifier. Mandatory. AdventNet, Inc. 147

149 OID - Object Identifier. Mandatory. value - The object instance value to be set. Mandatory. Refer to the ViewingInforms to know more about receiving v2c/ v3 informs in TrapViewer tool. AdventNet, Inc. 148

150 Receive Inform Request The snmpinformreq_receiver example can be used to receive inform requests and print the incoming PDUs. It also prints loaded trap names and their description while receiving the inform requests. The inform requests can be sent from a manager to another manager. A trap receiver program in the manager station can receive and display INFORM messages. By default the INFORM requests are sent to the port 162 of the manager station. In some operating systems, such as Unix, some ports are accessible only for users with root privileges. The following error occurs, if the port is not accessible. Error: com.adventnet.snmp.snmp2.snmpexception: java.net.bindexception:permission denied In such cases, you can specify the port in which the INFORM can be received as follows. Usage java snmpinformreq_receiver -p 8001 java snmpinformreq_receiver [-m MIB_files] [-c community] [-p port] [-d] [-u user] [-e engineid( /0x )] [-a authprotocol(md5/sha)] [-w auth_password] [-s priv_password] [-n contextname] [-i contextid] [ -pp priv_protocol (DES/AES) ] Options [-d] - Debug output. By default, off. Optional. [-p] port - Remote port number. By default, 162. Mandatory. [-u] user- User name. Mandatory in case of any v3 user types. [-e] engineid - Engine ID. Mandatory in case of v3 inform. [-a] authprotocol - authprotocol (MD5/SHA). Mandatory if authpassword is specified. Mandatory in case of v3 inform. [-w] authpassword - The authentication password. Optional. Mandatory in case of v3 auth or authpriv inform. [-s] privpassword - The privacy protocol password. Must be accompanied with authpassword and authprotocol fields. Mandatory in case of v3 authpriv informs. [-n] contextname - The contextname to be used for the v3 PDU. Supplied only for v3 traps. [-pp] priv_protocol (DES / AES) - The privacy Protocol. Must be accompanied with authpassword, authprotocol and privpassword field.supplied only for v3 traps. Note: If neither of -a, -w, -s are used, the security level is NO_AUTH, NO_PRIV. If -a, and -w are used, the security level is AUTH, NO_PRIV. If -a, -w, and -s are used, the security level is AUTH, PRIV. Example Command java snmpinformreq_receiver -p u inform_test -e 1234 Refer to the ViewingInforms to know more about receiving v2c/ v3 informs in TrapViewer tool. AdventNet, Inc. 149

151 Trap Receiver Traps are unsolicited messages sent by the agent to the management applications to report the conditions of the managed node. The trapreceiver example can be used to receive the traps sent by the agents. The general usage of the trapreceiver is java trapreceiver [-m MIB_files] [-c community] [-p port] [-u user] [-e engineid( /0x )] [-a authprotocol(md5/sha)] [-w auth_password] [-s priv_password] [-d] [-n contextname] [-i contextid] [ -pp priv_protocol(aes/des) ] For example: java trapreceiver The above command waits for the trap in the port 162, the default port for receiving traps, and prints the received traps. In some operating systems, such as Unix, some ports are accessible only for users with root privileges. The following error occurs, if the port is not accessible. Error: com.adventnet.snmp.snmp2.snmpexception: java.net.bindexception:permission denied In such cases, you can specify the port in which the trap can be received as follows. java trapreceiver -p 8001 Here, the traps are received in the port For example, the following v1 trap: java sendtrap -p m../mibs/rfc1213-mib remotehost localhost testing gives the following output in the trapreceiver demon. Got a trap from: xx.xx.xx.xx SNMP Trap PDU SNMP Version: Version 1 Remote Host: xx.xx.xx.xx Remote Port: 1430 Community: public Request ID: 0 Timeout: 0 Retries: 0 Enterprise: Trap Type: 0 Specific Type: 6 UpTime: 1000 Error Status: no error SNMP PDU Variable Bindings: Object ID: STRING: testing The output of the trapreceiver is different if we send a v2c trap. java sendv2trap -p m../mibs/rfc1213-mib remotehost 5000 AdventNet, Inc. 150

152 test Output of the trapreceiver is: Got a trap from: SNMP V2 Trap PDU SNMP Version: Version 2C Remote Host: Remote Port: 1436 Community: public Request ID: 2 Timeout: 0 Retries: 0 Error Status: no error SNMP PDU Variable Bindings: Object ID: TIMETICKS: 0 hours, 0 minutes, 50 seconds. Object ID: OBJID: Object ID: STRING: test While sending the v3 traps with user credentials and these traps should be authenticated, then the trapreceiver should be started with the usercredentials as shown below. java trapreceiver -d -m../mibs/rfc1213-mib -p u privuser -e 0x a MD5 -w privuser -s privuser -n priv -pp DES java sendv2trap -d -v v3 -p e 0x u privuser -a MD5 -w privuser -s privuser -i priv -pp DES -m../mibs/rfc1213-mib localhost Got a trap from: MP V2 Trap PDU SNMP Version: 3 Remote Host: Remote Port: Community: null Request ID: 1 Timeout: 0 Retries: 0 Error Status: no error SNMP PDU Variable Bindings: Object ID:.iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.0 TIMETICKS: 0 hours, 0 minutes, 10 seconds. Object ID:.iso.org.dod.internet OBJID:.iso.org.dod.internet.mgmt.mib-2.system.sysObjectID.0 AdventNet, Inc. 151

153 FAQs This section contains FAQs related to SNMP Utilities. General contains General FAQs pertaining to AdventNet SNMP Utilities. MibBrowser contains FAQs pertaining to MibBrowser Application that is packaged along with the AdventNet SNMP Utilities. Trap Viewer contains FAQs pertaining to Trap Viewer Application that is packaged along with the AdventNet SNMP Utilities. SAS and Web Server contains FAQs pertaining to SNMP Applet server and the Web Server that comes as part of the AdventNet SNMP Utilities. It also covers SAS package. AdventNet, Inc. 152

154 General 1. What is "security properties not found. using defaults." message? 2. When I try and encrypt a PDU I get a java no class def exception for the class java.security.cipher class. What does it indicate? 3. Sometimes I am not able to use the launcher. When I try to start the application nothing happens. What should I do? 4. Suppose a response comes back in 4.9 seconds on an SNMP timeout of 5 seconds. However, the CPU being very busy causes a delay of 0.2 seconds before picking up the response from the incoming buffer. In this case, would the response be used or would a timeout situation occur? 1. What is "security properties not found. using defaults." message? The security classes depend on the existence of a file java.security which is present under JAVA_HOME/lib/security directory. On installing cryptix package, cryptix is added as a security provider in this file. If the JAVA_HOME is wrong for any reason and the initialization routines do not find this file, then you will receive this message. Fix the JAVA_HOME environment variable to fix this. 2. When I try and encrypt a PDU I get a java no class def exception for the class java.security.cipher class. What does it indicate? This package uses the cryptix product. The cryptix package depends on jdk1.3 Java Cryptography extensions early access release. Therefore, to use the cryptix package and privacy modules, you need to compile the cryptix distribution of java security classes which is a part of the cryptix source distribution. These particular classes belong to java.security package and are not part of the Sun's jdk distribution. 3. Sometimes I am not able to use the launcher. When I try to start the application nothing happens. What should I do? The environment variables set in the launcher is not taking effect. Delete the launcher.config file and restart the launcher. The default settings will be used by launcher and all the applications will run properly. 4. Suppose a response comes back in 4.9 seconds on an SNMP timeout of 5 seconds. However, the CPU being very busy causes a delay of 0.2 seconds before picking up the response from the incoming buffer. In this case, would the response be used or would a timeout situation occur? In this case, a timeout situation occurs. AdventNet, Inc. 153

155 MibBrowser 1. How do I give Hex strings for SET values in MibBrowser? 2. How do I give Hex values in the ContextEngineID or in the ContextName text fields? 3. What are the units for timeout and retry values? 4. How do I set values for the table variables? 5. If I load the MibBrowser applet, I get the error "Error Sending PDUSecurity Exception connecting to remote host" in the browser. Why is this so? 6. I do not get the "NO HOST Specified" error. What should I do? 7. How can I load multiple MIB files in MibBrowser? 8. When I ask for 10 rows in an SNMP table, the GETBULK returns only 6 rows and the last attribute of the sixth row is null. The sixth row seems to be truncated. What should I do? 9. Is MibBrowser supports TCP? How can I communicate with a TCP agent using MibBrowser? 10. I got "Unable to establish Tcp Connection with localhost:161". What should I do? 1. How do I give Hex strings for SET values in MibBrowser? The SnmpString class accepts Hex strings in a certain format. Any string that starts and ends with a single quote(') is interpreted as an Hex string. The individual bytes should be separated using a colon(:). For example, if you need to enter 0x2a304cab, it should be supplied as '2a:30:4c:ab'. 2. How do I give Hex values in the ContextEngineID or in the ContextName text fields? The Hex values should start with a 0x or 0X. Therefore, if you set a value for contextid or contextname, it should be 0xHHHHHH. 3. What are the units for timeout and retry values? Both the timeout and retry values should be given in seconds. If you give the timeout value in milliseconds, it takes much time to get timed out. For example, a value of 1000 waits for 1000 seconds. 4. How do I set values for the table variables? To create a new row in a table: Define a column with SYNTAX RowStatus, and the definition for the table should have RowStatus object defined. Select the Table node from the tree and the Table button from the toolbar to display the corresponding table. Right-click on the table header where the name of the column is displayed. It displays a menu with the following options. o View Graph for Selected Rows o Add a New Row to the Table o Delete the Selected Rows from the Table Select Add a New Row to the Table. It displays a window for entering the values of the table. AdventNet, Inc. 154

156 The value for the column with RowStatus syntax should be 4 for creating a new row. Click OK after entering all the values. If RowStatus is not present in the table definition, you can only modify the existing row by doubleclicking the corresponding cell in the table. 5. If I load the MibBrowser applet, I get the error "Error Sending PDUSecurity Exception connecting to remote host" in the browser. Why is this so? Applets are not allowed to talk to any host apart from the Web server from which they were downloaded. Make sure that SAS is also running along with the Web server. 6. I do not get the "NO HOST Specified" error. What should I do? Before making any request, the host name or the IP address of the machine in which the agent is running should be specified in the "Host" text field of MibBrowser. 7. How can I load multiple MIB files in MibBrowser? To load multiple MIBs, files should be separated by a blank space and be given within double quotes. For example, java MibBrowserApplication -m "mibs/rfc1213-mib mibs/rfc1271-mib mibs/rfc1155-mib" -h localhost -c public. If you use MibBrowser.sh, edit the file accordingly. 8. When I ask for 10 rows in an SNMP table, the GETBULK returns only 6 rows and the last attribute of the sixth row is null. The sixth row seems to be truncated. What should I do? The number of rows you get back may be limited by the PDU size permitted by your agent, manager, or transport. 9. Is MibBrowser supports TCP? How can I communicate with a TCP agent using MibBrowser? Yes. From AdventNet SNMPUtilities 5 Release, MibBrowser supports communicating TCP in addition to UDP protocol with snmp agent. To communicate with a TCP agent, MibBrowser should be configured before invoking from the launcher using the MibBrowser settings of Launcher. And select the Options tab and choose the TCP Protocol. And then start the MibBrowser to communicate with TCP agent. 10. I got "Unable to establish Tcp Connection with localhost:161". What should I do? In general after enabling the TCP protocol of MibBrowser settings, and invoking the MibBrowser application in TCP mode, MibBrowser will try to communicate with the TCP agent running in the localhost and with the port 161. If there is no such TCP agent running in the localhost :161 then "Unable to establish Tcp Connection with localhost:161" will be printed in the logs. In that case, change the host and port of a valid TCP agent in the MibBrowser and try communicating with it. AdventNet, Inc. 155

157 Trap Viewer 1. When I start the Trap Browser I am getting the " net bind exception ". What should I do? By default the trap browser starts in the port 162. If the port is reserved or if the port is already used by some application this error will occur. You can restart the trap browser by giving the port no of any unused port. AdventNet, Inc. 156

158 SAS and Web Server 1. Will AdventNet's SAS work under Apache as the web server or will it run under the AdventNet Web Server only? Will the AdventNet Web Server run under Linux PC? 2. Why do I get a Security Exception while loading a MIB in MibBrowser applet locally using Netscape Web Browser? 3. After starting the Web Server / SAS Server I try to connect through the browser by giving the URL as I am getting " remote machine timed out " error. But I can see the web server running at port Will AdventNet's SAS work under Apache as the web server or will it run under the AdventNet Web Server only? Will the AdventNet Web Server run under Linux PC? The AdventNet SAS server can run under any Web Server and not restricted to AdventNet Web server alone. The Web Server that is bundled along with the product is platform independent and can run under any platform. 2. Why do I get a Security Exception while loading a MIB in MibBrowser applet locally using Netscape Web Browser? Netscape 4.x doesn't allow classes loaded from the local system to access the disk unless they are signed. However if you relax permissions it would help. Add this line to your prefs.js in Netscape users directory if you wish to use from local system. user_pref("signed.applets.low_security_for_local_classes", true); The other option is to put the classes in a jar file and sign them. 3. After starting the Web Server/SAS Server I try to connect through the browser by giving the URL as I am getting "remote machine timed out" error. But I can see the web server running at port If the web browser settings has the proxy connections enabled this error can occur, because some proxy servers cannot resolve to the localhost. You can give the host name of the machine instead of localhost or you can disable the proxy settings in the browser. AdventNet, Inc. 157

159 Known Issues and Limitations Known Issues The following are some of the known issues with this product at the time of release. Please check the known issues page on the AdventNet web site, for any updates to this list of known issues. 1. UserEntry.ser generated using the previous version of SnmpUtilities 4 or lower / Snmp API cannot be loaded into this Snmp Utilities5. 2. Latest traps will be maintained in the trapviewer. If the traplogging is enabled, all the traps after enabling the logging will be saved. But GUI will show only the latest traps. If the trap logging is not enabled traps are not logged. 3. While adding a snmpv3 user entry without the context name and perform a snmp operations It gives a general failure error in the description. And on subsequent snmp operation will popup a message that "Unable to establish tcp connection with the host <hostname>:port. And then to proceed further you should have to stop the existing operation from the mibbrowser to perform subsequent operation. 4. Standalone trapviewer do not have TCP support. 5. The ProxyForwarder application provided does not forward to v3 agents. It can only forward requests to v1/v2 agents. 6. In the SnmpTable dialog of the MibBrowser, if we try to view a table with some in-accessible columns. There is a mismatch in the columns while trying to do set and view graph for such tables. 7. The default agent in the Agent Routing Table in the V3 Agent Configuration tool will not be enabled automatically. After making the entry you have to click on some other row or cell to activate it. 8. In the MibBrowser, the graph button in the SnmpTable dialog does not take the column name of the last selected column. 9. In the MibBrowser, BarGraph will not plot multiple values at a time. 10. Since multiple roots are shown in the MibTree now, get and getnext operation from the MibBrowser after selecting the module name will fail now. You have to select the mib node. 11. In Windows, when the MibBrowser Application's help menu is invoked, the help files will not be displayed if the Netscape browser is already open. So if you have any web browser already opened while using the MibBrowser application, please close that and invoke the help menu again. 12. Features like database support for loading MIBs, storing v3 security parameters etc., are not available with HTTPMibBrowser. 13. In SNMP Decoder, decoding of authpriv packet dumps cannot be done. 14. After starting the SAServer from the Launcher, if the launcher is quit by executing Ctrl+C, sometimes only the SAS gets killed and the web-server continues to run in port After this, it not possible to start the SAServer again as it gives "Address already in use error". The running web-server can be killed only by using task manager or by rebooting the machine. Limitations 1. Trapviewer cannot able to authenticate the startup v3 traps sent by agent, as the user credentials for the agent is not present in the manager before agent startup. 2. TCP packets ( traps / snmp operations packet ) has the size restriction similar to udp packets of size Generally TCP has no size restriction. AdventNet, Inc. 158

160 3. Usability issues with editing a new parser file through TrapParser. User has to specify the filename in the Parser TextField or FileChooser dialog TextField. 4. In the MibBrowser Application OID's added to the MibBrowser multi-varbind list must have the index specified. 5. Browse option provided in Load MIB dialog of the MibBrowser applet will not work for HTTP protocol. Please enter the URL in the text field to load the MIB(s) from the server or from the jar file if available. 6. Loading compiled mibs in MibBrowser Applet requires the the mibs to be available in compiled mibs formatt for loading. 7. Loading of MIB files from the signed jars is not supported. 8. The standalone TrapViewer invoked from Launcher cannot receive SNMPv3 auth,priv traps. AdventNet, Inc. 159

161 Appendix Using the Help Manual How to Use this Help Conventions Used Parsing MIBs The help documentation for AdventNet SNMP Utilities is provided as a set of HTML files, which can be viewed in standard web browsers. This section describes briefly about the usage of the help manual of AdventNet SNMP Utilities. AdventNet, Inc. 160

162 Using Help How to Use This Help The help documentation for AdventNet SNMP Utilities is provided as a set of HTML files, which can be viewed in standard Web browsers. The help manual comes with a table of contents, index, and a full-text search feature. This section describes briefly about the usage of the help manual of AdventNet SNMP Utilities. The manual is displayed in two panes, the left pane and the right pane. Left Pane The left pane of the help documentation includes the following tabs. This displays the books and pages that represent the categories of information in the help manual. When a closed book is clicked, it opens to display its content. When an open book is clicked, it closes. When the pages are clicked, the corresponding content is opened in the right pane of the browser. Right Pane The right pane displays the actual content of the selected page. The content to be displayed in the right can be selected by navigating the books of the left pane. The help manual also includes the Back and Forward buttons for navigation. The button is used to go to the next page and the is used to go to the previous page. AdventNet, Inc. 161

163 Conventions Used The AdventNet SNMP Utilities documentation is organized as a series of books displayed in the left side pane. Each book has one or more topics. Following are the conventions used in this help documentation. The page associated with each book lists all the topics in it. The image indicates the SNMPv2c/SNMPv3 features of AdventNet SNMP Utilities. The image indicates the SNMPv3 features of AdventNet SNMP Utilities. AdventNet, Inc. 162

164 Parsing MIBs Parsing Levels Checks for Various Parsing Levels Checks in Detail This section explains the parsing and validating the syntax of the MIB module and constructing the MIB module into the tree structure. A detailed description of the different levels of parsing that can be set and their corresponding checks are also discussed in this section. AdventNet, Inc. 163

165 Parsing Levels Applications, while loading MIB files, perform the following operations. Parsing and validating the syntax of the MIB module Constructing the MIB module into the tree structure While performing the parsing and validation of the MIB files, if the MIB modules fail to conform to the SMI standards the loading will not be not done. However, the application requirements might mandate the loading of the non-standard files. On the other hand, some applications might require a stricter check on the compliance to the standards. The parsing and validating the syntax of the MIB file can be made configurable to suit the application requirements. AdventNet SNMP Utilities handles this by providing the following set of parsing levels which facilitates to select the level of parsing required by the applications. Lenient Normal Serious Critical In addition to the above four parsing levels, SNMP Utilities supports another level, which is userdefined. In case of user-defined level, you can define your own parsing level with the required checks at runtime. Note: It is recommended to use the higher parsing level (SERIOUS, CRITICAL) for validating the MIB file and not for loading the MIB file in the application. It affects the performance of the application while loading the MIB files, because it takes considerable amount of time and resources, such as memory, CPU usage etc. Constructing the MIB Module into the Tree Structure If parsing is completed successfully, the SNMP Utilities resolves the parent and child nodes in the current module. If there are any unresolved nodes, it tries to load from the imported module that is defined in the IMPORTS section. If the unresolved object is not present even in the imported module, unresolved TC construct {objectname1, objectname2,...} exception is thrown. Note: If the parsing level is NORMAL, SERIOUS, or CRITICAL, and if the MIB file contains errors, then the compiled files (cmi and cds files) or the serialized files (ser files) will not be created. AdventNet, Inc. 164

166 Checks for Various Parsing Levels The following tables describes the different levels of parsing that can be set and their corresponding checks. S. No Level of Parsing 1 Lenient 2 Normal 3 Serious 4 Critical Checks No Checks Default checks Serious Checks Critical Checks Description This level accepts all types of MIB files. For example, it allows both SMIv1 and v2. This level is the default level conforming to the obsolete standards, such as RFC 1902, RFC 1903, etc. Most MIBs follow the obsolete standard. This level strictly follows the current standard. It accepts the constructs with interoperability and implementation problems. This level completely follows the SMIv1 and v2 standards. However, it does not accept the backward compatibility constructs, constructs with interoperability and implementation problems, etc. Normal Parsing Level When the parsing level is normal (default parsing level), the following checks are included. OBJECT_IDENTIFIER_CONSTRUCT CHECK_DEFAULT Serious Parsing Level When the parsing level is serious, the following checks are done in addition to Normal checks. IMPORTS_CONSTRUCT MODULE_IDENTITY_CONSTRUCT OBJECT_TYPE_CONSTRUCT TRAP_TYPE_CONSTRUCT NOTIFICATION_TYPE_CONSTRUCT TEXTUAL_CONVENTION_CONSTRUCT Critical Parsing Level When the parsing level is critical, the following checks are done in addition to Serious checks. AGENT_CAPABILITIES_CONSTRUCT OBJECT_GROUP_CONSTRUCT MODULE_COMPLIANCE_CONSTRUCT CHECK_IDENTIFIERS CHECK_MISCELLANEOUS When the parsing level is Lenient, none of the above checks are done. Besides the above mentioned parsing levels, you can choose your own parsing level with the required checks. There are some rules that a MIB file should follow, without which the MIB tree is not formed properly. When the parser encounters such violations, MibException is thrown. AdventNet, Inc. 165

167 The OID construct should contain atleast two suboids. The second and its subsequent suboids should be number or namenumber to identify their ancestors and their position in the MIB tree. In the OBJECT_IDENTIFIER construct, if the first suboid is a number, it should be 0. 1, or 2. If the suboid is a name Number, it should be ccit(0), iso(1), or joint-iso-ccit(2). The label of the last suboid should be same as the descriptor. The maximum value of the sub-identifier cannot exceed The table entry should be defined as a child of the corresponding table object. The module name of the MIB file should start with uppercase letter. The TC name should not start with lowercase letter. Therefore, the following checks are done even when the parsing level is set to lenient. These checks are termed as "Very Critical Checks" and are done irrespective of the parsing level. CHECK_ATLEAST_TWO_SUBOID CHECK_SECOND_SUBOID CHECK_FIRST_SUBOID CHECK_LAST_SUBOID CHECK_LONG_SUBOID CHECK_TABLE_OBJECT VALIDATE_MODULE_NAME VALIDATE_TC_NAME AdventNet, Inc. 166

168 Checks in Detail The checks are based on the Imports, macro constructs, and some miscellaneous specifications of the MIB file. All the checks are grouped with the parent checks. The parent checks are: OBJECT_IDENTIFIER_CONSTRUCT CHECK_DEFAULT IMPORTS_CONSTRUCT MODULE_IDENTITY_CONSTRUCT OBJECT_TYPE_CONSTRUCT TRAP_TYPE_CONSTRUCT NOTIFICATION_TYPE_CONSTRUCT TEXTUAL_CONVENTION_CONSTRUCT AGENT_CAPABILITIES_CONSTRUCT OBJECT_GROUP_CONSTRUCT MODULE_COMPLIANCE_CONSTRUCT CHECK_IDENTIFIERS CHECK_DEFVAL CHECK_TABLE_CONSTRUCT CHECK_SYNTAX CHECK_ACCESS CHECK_MISCELLANEOUS Normal Checks OBJECT_IDENTIFIER_CONSTRUCT CHECK_DEFAULT Serious Checks IMPORTS_CONSTRUCT MODULE_IDENTITY_CONSTRUCT OBJECT_TYPE_CONSTRUCT TRAP_TYPE_CONSTRUCT NOTIFICATION_TYPE_CONSTRUCT TEXTUAL_CONVENTION_CONSTRUCT Critical Checks AGENT_CAPABILITIES_CONSTRUCT OBJECT_GROUP_CONSTRUCT MODULE_COMPLIANCE_CONSTRUCT CHECK_IDENTIFIERS CHECK_MISCELLANEOUS AdventNet, Inc. 167

169 Normal Checks OBJECT_IDENTIFIER_CONSTRUCT In the OID construct the second suboid should be a CHECK_SECOND_SUBOID name or namenumber. The OBJECT IDENTIFIERS should have atleast two CHECK_ATLEAST_TWO_SUBOID sub-identifiers. In the OBJECT IDENTIFIER construct, the first subidentifier should be any one of the following. CHECK_FIRST_SUBOID CHECK_LAST_SUBOID CHECK_LONG_UBOID Value Name 0 ccitt 1 iso 2 joint-iso-ccitt In the OID construct, the label of the last sub-oid should be same as the descriptor. In the OID construct, the numbered suboid value should not exceed CHECK_RESERVED_WORDS CHECK_DEFAULT The following are reserved keywords which must not be used as descriptors or module names: ABSENT ACCESS AGENT- CAPABILITIES ANY APPLICATION AUGMENTS BEGIN BIT BITS BOOLEAN BY CHOICE COMPONENT COMPONENTS CONTACT-INFO CREATION- REQUIRES Counter32 Counter64 DEFAULT DEFINED DEFINITIONS DEFVAL DESCRIPTION DISPLAY- HINT END ENUMERATED ENTERPRISE EXPLICIT EXPORTS EXTERNAL FALSE FROM GROUP Gauge32 IDENTIFIER IMPLICIT IMPLIED IMPORTS INCLUDES INDEX INTEGER Integer32 IpAddress LAST-UPDATED MANDATORY- GROUPS MAX MAX-ACCESS MIN MIN-ACCESS MINUS-INFINITY MODULE MODULE-COMPLIANCE MODULE-IDENTITY NOTIFICATION-GROUP NOTIFICATION-TYPE NOTIFICATIONS NULL OBJECT OBJECT-GROUP OBJECT- IDENTITY OBJECT-TYPE OBJECTS OCTET OF OPTIONAL ORGANIZATION Opaque PLUS- INFINITY PRESENT PRIVATE PRODUCT-RELEASE REAL REFERENCE REVISION SEQUENCE SET SIZE STATUS STRING SUPPORTS SYNTAX TAGS TEXTUAL-CONVENTION AdventNet, Inc. 168

170 CHECK_DEFAULT CHECK_PROPER_FIELDS CHECK_MULTIPLE_OCCURRENCE_OF_NODE VALIDATE_TC_NAME CHECK_MULTIPLE_OCCURRENCE_OF_ENUM_LABEL CHECK_ROW_OBJID CHECK_TABLE_OBJECT VALIDATE_MODULE_NAME TRAP-TYPE TRUE TimeTicks UNITS UNIVERSAL Unsigned32 VARIABLES VARIATION WITH WRITE-SYNTAX In the SEQUENCE construct, each sequence member should be separated by a comma and there should not be a comma at the end of last sequence member. In the GROUPS construct, the SYNTAX, WRITE-SYNTAX, MIN- ACCESS clauses are not allowed. The descriptor should be unique and mnemonic. The identifier for the TEXTUAL- CONVENTION should start with uppercase letter. The labels used in the enumeration list should be unique. The table entry must present immediately beneath the corresponding table object. i.e., The table entry object should be the child of the table object with sub identifier as "1". The table entry should be defined as a child of the corresponding table object. An ASN.1 module name should begin with an upper-case letter and continues with zero or more letters, digits, or hyphens, except that a hyphen can not be the last character, nor can there be two consecutive hyphens. Serious Checks IMPORTS_CONSTRUCT The following must not be included in an IMPORTS statement. 1. Named types defined by ASN.1 namely CHECK_INVALID_IMPORTS_VALUES INTEGER, OCTET STRING, OBJECT IDENTIFIER, SEQUENCE, SEQUENCE OF. 2. The BITS construct. CHECK_EXPORT_CONSTRUCT CHECK_CONSTRUCT_IN_IMPORTS The EXPORTS statement is not allowed in an SMIv2 MIB. All the items defined in a module is automatically imported. If any of the following datatypes and macros are defined in this document, they must be imported using the IMPORTS statement. Counter32, Counter64, Gauge32, Integer32, IpAddress, MODULE-IDENTITY, NOTIFICATION- TYPE, Opaque, OBJECT-TYPE, OBJECT-IDENTITY, TimeTicks, Unsigned32 AdventNet, Inc. 169

171 INVALID_IMPORTS_IN_V2 IMPORTS_CONSTRUCT In an SMIv2 MIB, if the IMPORTS section contains RFC1155-SMI, it should be replaced by SNMPv2-SMI. MODULE_IDENTITY_CONSTRUCT There must be only one MODULE-IDENTITY CHECK_MODULE_IDENTITY_INVOCATION macro defined in the MIB. The MODULE-IDENTITY macro must be CHECK_MODULE_IDENTITY_OCCURRENCE defined immediately after the IMPORTS section. The REVISION clause should be defined in REVERSE_CHRONOLOGICAL_ORDER the revers chronological order. i.e. the latest revision should occur first. The UTCTime format is YYMMDDHHMMZ or YYYYMMDDHHMMZ. It should contain 11 or 13 characters. CHECK_UTC_TIME CHECK_LUPDATED_REVISION_UTC_TIME where YY - last two digits of year (only years between ) YYYY - last four digits of the year (any year) MM - month (01 through 12) DD - day of month (01 through 31) HH - hours (00 through 23) MM - minutes (00 through 59) Z - denotes GMT (the ASCII character Z) For example, " Z" and " Z" represent 8:15pm GMT on 19 February Years after 1999 must use the four digit year format. Years may use the two or four digit format." The UTC Time value mentioned in the LAST- UPDATED field should be same as the UTC Time value in the first of the REVISION field. OBJECT_TYPE_CONSTRUCT The following are the checks that fall under OBJECT_TYPE_CONSTRUCT. CHECK_DEFVAL, CHECK_TABLE_CONSTRUCT, OBJECT_TYPE_CONSTRUCT CHECK_SYNTAX, CHECK_ACCESS, CHECK_STATUS These are parent checks, which in turn include many checks. TRAP_TYPE_CONSTRUCT The trap number should range between CHECK_TRAP_NUMBER If the trap is generic, the trap number should be CHECK_GENERIC_TRAP_NUMBER between 0 to 6. If the enterprise value is other than snmp, the value CHECK_ENTERPRISE_VALUE should be registered under enterprise OID ( ). NOTIFICATION_TYPE_CONSTRUCT For the NOTIFICATION-TYPE macro, the objects CHECK_NT_OBJECTS_ACCESS should not have an MAX-ACCESS value of 'notaccessible'. AdventNet, Inc. 170

172 TEXTUAL_CONVENTION_CONSTRUCT The DISPLAY-HINT clause must not be present if the Textual Convention is defined with any of the following syntax. CHECK_OCCURRENCE_OF_DISPLAY_HINT OBJECT IDENTIFIER, IpAddress, Counter32, Counter64 or any enumerated syntax (BITS or INTEGER). The standard format for DISPLAY-HINT is as follows. INTEGER Format: <intdisplayhint> = "d" ["-" number] <singlechar> <singlechar> = o x b CHECK_DISPLAY_HINT_FORMAT CHECK_TC_AS_SYNTAX OCTET STRING Format: <octetdisplayhint> = <octdisplayspec> <octdisplayspec> = number <displayformat> [<sepchar>] "*" number <displayformat> [<sepchar> [<reptermchar>]] <displayformat> = "d" "b" "o" "x" number - unsigned integer <sepchar> - separator character, any character except "*" and decimal digit <reptermchar> - repeat terminator character: any character other than "*" and decimal digit. The SYNTAX clause of a Textual Convention can not refer to a previously defined Textual Convention. The syntax could be any one of the following SNMP datatypes with possible sub-typing: INTEGER, OCTET STRING, OBJECT IDENTIFIER, Integer32, IpAddress, Counter32, Gauge32, Unsigned32, TimeTicks, Opaque, and Counter64. Critical Checks AGENT_CAPABILITIES_CONSTRUCT The CREATION-REQUIRES clause must not be present unless the object named in CHECK_CREATION_REQUIRES the correspondings VARIATION clause is a conceptual row. All objects which are named in the CHECK_ACCESS_FOR_CREATION_REQUIRES CREATION-REQUIRES clause must have an access level of "read-create". OBJECT_GROUP_CONSTRUCT The objects defined in the OBJECT-GROUP macro CHECK_OBJECTS_IN_THIS_MODULE should be defined in the same module where this OBJECT-GROUP is defined. The MAX-ACCESS value of the objects defined in the OBJECTS clause must be one of the following. accessible-for-notify CHECK_OBJECTS_ACCESS read-only read-write read-create AdventNet, Inc. 171

173 CHECK_INVALID_OBJECTS OBJECT_GROUP_CONSTRUCT The objects defined in the OBJECTS clause should not start with upper case. MODULE_COMPLIANCE_CONSTRUCT A MIN-ACCESS clause should not be present for CHECK_MIN_ACCESS_CONSTRUCT 1. columnar objects 2. objects with syntax as Counter32 or Counter64. A group named in a GROUP clause must not be the CHECK_MANDATORY_GROUPS one defined in the corresponding MANDATORY- GROUPS clause. The access value specified in the MIN-ACCESS CHECK_MIN_MAX_ACCESS clause must not be greater than is specified in the MAX-ACCESS clause of the OBJECT-TYPE macro. In the MODULE-COMPLIANCE construct, if the CHECK_OBJECTS_IN_MC MODULE clause doesn't contain any modulename, the objects should be defined in this module. CHECK_IDENTIFIERS The hyphen are not allowed for an ASN.1 identifier (except for use by information CHECK_HYPHEN_IN_IDENTIFIERS modules converted from SMIv1 which did allow hyphens). The descriptor should not exceed 64 CHECK_NO_OF_CHARACTERS_EXCEEDS_64 characters in length. The descriptor should not exceed 32 CHECK_NO_OF_CHARACTERS_EXCEEDS_32 characters in length. The convention for the naming of the table object is: 1. The table name should start with lowercase letter and it should ends with "Table". 2. The SEQUENCE object name should be same as the table name except, the initial lower case letter should be converted into upper case letter. The word "Table" should be CHECK_TABLE_NAMING_CONVENTION replaced with the word "Entry". 3. The table entry name should be same as the SEQUENCE name but the initial upper case letter should be converted into lower case letter. For example, table name: iftable SEQUENCE name: IfEntry entry name : ifentry CHECK_LC_NAME The descriptors/identifiers for the following macros should not start with upper case letter. OBJECT-TYPE, NOTIFICATION-TYPE, NOTIFICATION-GROUP, OBJECT-GROUP, MODULE-COMPLIANCE, AGENT- CAPABILITIES TRAP-TYPE, OBJECT- IDENTITY, MODULE-IDENTITY AdventNet, Inc. 172

174 CHECK_ENUM_LABEL CHECK_TC_CASE VALIDATE_SEQUENCE_NAME CHECK_IDENTIFIERS The labels used in the enumeration list should not start with upper case or number and it should not contain hyphen. The descriptor for the TEXTUAL- CONVENTION should not consist of all upper case letters. The descriptor for the SEQUENCE construct should start with upper case. CHECK_DEFVAL The binary value should contains zeros and ones. The value should contain eight digits and CHECK_BINARY_DEFVAL should be enclosed within single quotes and should end with 'b 'or 'B'. The hex defval should contain even number of CHECK_HEX_DEFVAL digits. The value should be enclosed in single quotes and should end with 'h' or 'H'. The DEFVAL clause should not be present for CHECK_DEFVAL_FOR_COUNTER_SYNTAX the nodes whith syntax Counter/Counter32 and Counter64. For the nodes with syntax as OBJECT- CHECK_OID_OIDY_DEFVAL IDENTIFIER, the value of the DEFVAL clause should be an OBJECT-IDENTITY macro. For the nodes with syntax as OBJECT IDENTIFIER, the DEFVAL clause value should be: 1. defined in this module or imported from CHECK_INVALID_OID_DEFVAL any other MIB module. 2. expressed as a single ASN.1 identifier, and not as a collection of subidentifiers. VALIDATE_DEFVAL The value of the DEFVAL clause must correspond to the SYNTAX clause for the object. Also, the default value should not contradict the range/values specified in syntax for a particular variable. CHECK_TABLE_CONSTRUCT The number of nodes defined in the SEQUENCE construct should be same as the number of nodes actually defined. CHECK_SEQUENCE_CONSTRUCT Also the syntax defined in the SEQUENCE construct should not contradict with the syntax in the node definition. The index nodes cannot have the syntax CHECK_INDEX_NODE_SYNTAX Counter/Counter32 and Counter64. The node entry defined in the AUGMENTS clause should not contains CHECK_RECURSIVE_AUGMENTS_CONSTRUCT AUGMENTS clause. CHECK_COLUMNAR_NODES The SEQUENCE construct should contain atleast a single node which is not auxillary. AdventNet, Inc. 173

175 CHECK_TABLE_CONSTRUCT The index node should not repeat in the CHECK_OCCURRENCE_OF_INDEX_NODE same INDEX clause. Atleast a single node in the SEQUENCE CHECK_OCCURRENCE_OF_ROWSTATUS_NODE construct should have RowStatus as syntax. In the INDEX clause, the IMPLIED CHECK_OCCURENCE_OF_IMPLIED_NODE keyword should be present only for the last node. In the INDEX clause, the IMPLIED keyword should be present only for the CHECK_IMPLIED_NODE_TYPE node with syntax as OCTET STRING with variable length or OBJECT- IDENTIFIER. The node present in the AUGMENTS CHECK_ENTRY_IN_AUGMENTS_CONSTRUCT construct should be a table entry. The subtyping information should not be CHECK_SEQUENCE_WITH_SUBTYPE present for the nodes present in the SEQUENCE construct. CHECK_FOR_SCALAR_INDEX The index node must not be scalar. The usage of the following named SMI types in the INDEX clause is allowed only in SMIv1 MIB. INTEGER OCTET STRING CHECK_INDEX_VALUE OBJECT IDENTIFIER NetworkAddress IpAddress These index values are not supported in SMIv2. CHECK_BITS_VALUE CHECK_ENUM_IN_INTEGER32 CHECK_INVALID_V2_SYNTAX CHECK_SYNTAX The BITS value should be contiguous starting from 0 and if not contiguous, the next bit value should be multiple of eight (for e.g. 0,1,2,3,8,9,.). Although there is no SMI-specified limitation on the number of enumerations there may be implementation and interoperability limitations for sizes in excess of 128 bits. The enumerated value should not be present for the Integer32 type. For any object with an integer-valued SYNTAX clause, in which the corresponding INTEGER does not have a range restriction the object MUST have the value of the SYNTAX clause changed to Integer32, or have an appropriate range specified. If any object has a SYNTAX clause value of Counter, the object MUST have the value of its SYNTAX clause changed to Counter32. If any object has a SYNTAX clause value of Gauge, the object MUST have the value of its SYNTAX clause changed to Gauge32, or Unsigned32 where AdventNet, Inc. 174

176 CHECK_NETWORK_ADDRESS CHECK_FOR_SIZE_CLAUSE_IN_OCTET_STRING CHECK_ZERO_IN_ENUM CHECK_FOR_SIZE_CLAUSE_IN_INTEGER CHECK_RANGE_INTERSECTION CHECK_RANGE_DUPLICATION CHECK_SUBTYPING_FOR_SYNTAX CHECK_SIZE_FOR_OCTET_STRING CHECK_NEGATIVE_VALUE_IN_SIZE CHECK_MAX_MIN_RANGE CHECK_OPAQUE_SYNTAX appropriate. The syntax "NetworkAddress" should not be used in an SMIv2-MIB. If the OCTET STRING syntax contains subtyping information, the SIZE clause must be present. The enumerated value start at 1 and must be numbered continuously. If the syntax of the objects defined in the INDEX clause is enumerated Integer, the zero should not be used as an enumerated value. The SIZE clause should not be present for the INTEGER and Integer32 syntax. In case of multiple ranges, the range values should not overlap. The range definition ( ) is invalid. The range values should be unique. The range values should not duplicate. In the range definition ( ). The value '150' is defined twice. The sub-typing information should not be present for the following syntax. OBJECT IDENTIFIER, IpAddress, Counter32, Counter64 and TimeTicks. The size of the OCTET STRING should not exceed The negative values should not be used in the range definition. The keyword MAX and MIN should not be used in the range definitions. The Opaque type is provided solely for backward-compatibility, and shall not be used for newly-defined object types. CHECK_ACCESS If the syntax of the node is Counter/Counter32 or Counter64, the CHECK_ACCESS_FOR_COUNTER_SYNTAX access value should be either 'read-only' or 'accessible-for-notify'. If the syntax of the node is RowStatus, CHECK_ROWSTATUS_ACCESS the access value should be read-create. In a conceptual row, if any of the node has read-create as its access value, no CHECK_ACCESS_FOR_COLUMNAR_NODES other node in the same row can have the access value as read-write. The SMIv1 access value "notimplemented" should not be used in an CHECK_ACCESS_VALUE SMIv2 module. The access value for the table and table CHECK_ACCESS_IN_TABLE_AND_ENTRY_NODE entry should be 'not-accessible'. The access value for the index nodes CHECK_INDEX_NODE_ACCESS should be 'not-accessible'. AdventNet, Inc. 175

177 CHECK_STATUS CHECK_STATUS The STATUS values for the SMIv2 MIB modules are current deprecated obsolete. CHECK_MISCELLANEOUS The object identifier value should not be placed between the module name and the "DEFINITIONS" keyword." CHECK_OID_BETN_MODNAME_DEFINITIONS TEST-MIB { iso org(3) dod(6) internet(1) private(4) enterprises(1) 2186} DEFINITIONS ::= BEGIN This is invalid. The ASN comments (--) should not be CHECK_COMMENTS_IN_TEXT present inside the quoted String. The SMIV1 keyword ACCESS should not be CHECK_ACCESS_KEYWORD used in an SMIv2 MIB. It should be replaced by MAX-ACCESS. The conceptual row should contain no more CHECK_NUMBER_OF_COLUMNAR_NODES than approximately 20 objects. The DEFVAL value should be present within CHECK_BRACES_IN_DEFVAL the braces. The value in the DEFVAL field should not be CHECK_EMPTY_DEFVAL empty. The SMIv1 macros must not be used in CHECK_FOR_SMIV1_CONSTRUCT SMIv2 information modules. AdventNet, Inc. 176