Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date:...

16

Transcript of Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date:...

Page 1: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

AdventNet

Release 6

Phone: +1-925-924-9500

Fax: +1-925-924-9600

E-mail:[email protected]

AdventNet, Inc.

5645 Gibraltar Drive

Pleasanton, CA 94588 USA

© 1999 - 2003 AdventNet Inc.All Rights Reserved.

Agent Toolkit C Edition

Quick Tour

Page 2: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 1

Table Of Contents

QUICK TOUR ............................................................................................................ 2

About Agent Toolkit C Edition ............................................................................................ 3 Agent Toolkit C Edition: Experience................................................................................... 6 Agent Toolkit C Edition: Architecture................................................................................ 10 What Is New in This Release ........................................................................................... 12 Related AdventNet Products............................................................................................ 13 Contacting AdventNet ...................................................................................................... 14

Page 3: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 2

Quick Tour This section gives you an introduction about AdventNet Agent Toolkit C Edition 6 and the architecture used in the toolkit. It lists all the new features introduced in this release. It also provides the list of other products developed in AdventNet and also provides information for contacting AdventNet.

• About Agent Toolkit C Edition

• Agent Toolkit C Edition: Experience

• Agent Toolkit C Edition: Architecture

• What Is New in This Release

• AdventNet's Related Products

• Contacting AdventNet

Page 4: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 3

About Agent Toolkit C Edition

• Introduction

• Overview

• Key Features

• Benefits

• Developer Tools

• Supported Standards

Introduction AdventNet Agent Toolkit C Edition is a rapid prototyping and development tool for building SNMP, TL1, and CLI agents in strict ANSI C language. The Agent Toolkit primarily focuses on System Management and Device Management and hence the run-time agent is very modular, portable, and customizable. The toolkit supports the development of standalone SNMP, TL1, and CLI agents. In addition to this, the toolkit supports multiple protocols (SNMP, TL1, CLI, HTTP, and other protocols) access to common instrumentation, called Multi-Protocol Agent. Overview AdventNet Agent Toolkit C Edition, a comprehensive suite of Java-based cross-platform development and test tools, makes the agent development simpler. It greatly reduces the time-to-market of the product. The agent source files provide the protocol-specific functionality to the agent and can be used across many platforms. The agent source files are already ported and well tested in Embedded Operating Systems, such as VxWorks, QNX Nutrino, Windows CE, OSE and other operating systems, such as Windows 95,98,2000, and NT, Solaris, Linux, Unix, Free BSD, Net BSD, HP-Unix, and OS-2. The agent source files can also be ported to other new OSs very easily, thus addressing the needs of fast paced environment for developing device/system management agents. Key Features

• Support for Standalone SNMP, TL1, and CLI Agents.

• Support for Multi-Protocol Agent which provides common instrumentation for SNMP, TL1, CLI, and HTTP.

• SNMP agents provide complete support to SNMP v1, v2c, and v3 Protocols.

• Agent source code is very modular, that is, it provides option to include/exclude the necessary modules during compilation. For example, the macro SNMPV3 is used to either include or exclude SNMPv3 module.

• TL1 agent conforms to Bellcore GR 831, 815, 833, and TR 835 standards. Also Provisioning Messages from GR199 have been implemented.

• Gateway NE support in TL1 Agent

• HTTP 1.1 and SSL support in HTTP Adapter

• CLI agent supports telnet server and command line features, such as command history , command line completion, etc.

• Support to generate API documents for agent source files and generated code.

Page 5: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 4

• Persistence storage support using database and text file

• Low Memory footprint

• Support for Master and sub-agent architecture using proxy feature

• Multi-thread support

• Support for Timer Service and Monitor Service

Benefits

Cross-Platform As a pure Java product, Agent Toolkit C Edition supports Solaris, Windows NT/2000, Linux, IBM AIX, HP-UX, and any operating system that supports Java. Multiple Protocol Support It supports SNMP, TL1, and CLI through standalone SNMP, TL1, and CLI agents. In addition to this, the toolkit supports multiple protocol (SNMP, TL1, CLI, HTTP, and other protocols) access to common instrumentation, called Multi-Protocol Agent. Development and Test Tools Agent Toolkit C Edition has a comprehensive set of easy-to-use command line and UI-based agent development tools, such as (editors, compilers, and browsers) for easy and fast development and testing of agents. Thus, we capture the complete user experience tools for "Define, Develop, Compile, Run, and Test". Time to Market Easy-to-use development environment and powerful visualization tools simplify development process. Tangible improvements in development time and cost can be achieved by leveraging the core capabilities of the Agent Toolkit. Reduced Cost of Development The Run-time C agent significantly reduces your development costs, in terms of project costs and personnel for your product.

Developer Tools Agent Toolkit C Edition assists the complete Agent development life cycle from design and development to testing by providing Compilers to Managers. A few of them are listed below:

Operation Tools

Editor Tools MIB Editor, TL1 Message Builder, and CLI Editor for creating the inputs required for developing an Agent (MIB,TCS, and CCS files)

Compiler Tools Agent Compiler for generating strict ANSI-C code for building SNMP, HTTP, CLI, and TL1 Agents

Management Tools MIB Browser, TL1CraftInterface, and CLI Browser for testing the Agents developed

Page 6: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 5

Supported Standards

Protocol Type Supported Standards

SNMP RFC 1155, RFC 1157, RFC 1215, RFC 1213, RFC 1901, RFC 1907, RFC 2571, RFC 2572, RFC 2573, RFC 2574, RFC 2575, RFC 2576

TL1 GR 831, GR 815, TR 835, GR 199

CLI RFC 854, RFC 855

HTTP RFC 1945, RFC 2068

Page 7: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 6

Agent Toolkit C Edition: Experience

• Six Easy Steps for Agent Development

• Developing SNMP Agent

• Developing TL1 Agent

• Developing CLI Agent

• Developing Multi-Protocol Agent

Six Easy Steps for Agent Development AdventNet Agent Toolkit C Edition offers a comprehensive development environment for developing and deploying embedded agents. This section explains how the complete product life cycle needs can be met. They are captured in the six easy steps as outlined below: Step 1: Defining the Input for an Agent: MIB/TCS/CCS Step 2: Generating code for the input Step 3: Instrumenting the code for the desired function Step 4: Compiling the generated source files Step 5: Testing the developed Agent Step 6: Packaging and Deploying the Agent

Page 8: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 7

Step 1: Defining the Input for an Agent The first step toward Agent development is the definition of the input. This input is framed based on the operations that can be performed and the attributes of the managed application. Hence for defining the input, it is required to identify the various operations and attributes that need to be managed in the application. The input can be in the form of MIB definition, TCS ( TL1 command set ) file, or a CCS (CLI command set ) file. Step 2: Generating Code for the Input. Agent Compiler is a tool which converts the input files into (MIB, TCS, or CCS ) to a C code. In the generated code, you can see handler methods generated. Based on the settings provided by you while creating the project in Agent Compiler, and the type of input given, the Agent Compiler generates the code. Step 3: Instrumenting the Code for the Desired Function Instrumenting or editing the generated code for a desired result is the major step that should be done in the developed Agent. To explain the concept of instrumentation, let us consider that a System Administrator is remotely managing a mail server. For this requirement (keeping track of the mails), if he had defined a MIB variable as noOfMailsInQ, then the getNoOfMailsInQ() and setNoOfMailsInQ() methods get generated for that MIB. He just has to fill in the code for getting the number of mails in the queue, so that whenever a request is made from the manager to the Agent, the Agent will execute this method to return the value. Step 4: Compiling the Generated Source Files The code generated using the Agent Compiler should be compiled with the classes used by instrumentation in the class path environment. The Agent Compiler allows to compile the generated Agent by providing extensive environment/compiler options. User may not wish to develop the complete Agent at a single stretch and may go in for a phase-by-phase approach. In each phase they may wish to instrument/develop Agent for portion of their MIB/TCS/CCS files. This is supported in the Agent Compiler, where the user can generate the Agent and later regenerate for extra variables, in which case the newly generated code gets automatically merged with the already generated code, providing comprehensive code merging support. Step 5: Testing the Agent Developed The generated Agent can be started in the Agent Compiler tool itself. The tool provides Start/Stop Agent options, thus providing the testing environment in the same tool. From the Agent Compiler tool, you can launch the manager/client applications (from right side bottom of the tool). These manager applications (browsers), namely MIB Browser (SNMP manager), TL1CraftInterface (TL1 manager), CLI Browser (CLI manager), and Web Browser (HTML client) can be used to test the various agents. Step 6 - Packaging and Deploying the Agent The next step would be packaging and deploying the Agent. Now that the agent is ready, the user can package and deploy the agent in their target environment. Developing SNMP Agent The Standalone SNMP Agents (SSA) confirms to the SNMP and is purely SNMP specific. It supports SNMPv1/v2c/v3 versions and the proxy feature. Steps involved in creating a Standalone SNMP Agent are as follows:

Page 9: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 8

1. Create a MIB using MIB Editor 2. In the Agent Compiler, create a Standalone SNMP project 3. Load the MIB 4. Generate, Instrument, and Compile the source code

The created agent can be tested using MIB Browser, which is a tool used for querying the agent for information regarding the managed device. Developing TL1 Agent The Standalone TL1 Agents (STA) confirms to the TL1 (Transaction Language 1) protocol and is purely TL1 specific. Steps involved in creating a Standalone TL1 Agent are as follows:

1. Create a TCS (TL1 Command Set) file using TL1 Message Builder. 2. In the Agent Compiler, create a Standalone TL1 Project. 3. Load the TCS file. 4. Generate, Instrument, and Compile the source code.

The agent can be tested using TL1CraftInterface, which is a tool used for querying the agent for information regarding the managed device. Developing CLI Agent There are no standards as such for defining commands in a CLI Command Set (CCS) file. Steps involved in creating a Standalone CLI Agent are as follows:

1. Create a CCS using CLI Editor. 2. In the Agent Compiler, create a Standalone CLI Project. 3. Load the CCS file. 4. Generate, Instrument, and Compile the source code.

Page 10: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 9

The agent can be tested using CLI Browser, which is a tool used for querying the agent for information regarding the managed device. Developing Multi-Protocol Agent The Multi-protocol Agent (MPA) provides SNMP, TL1, CLI, and HTTP support to the agent and allows you to add other protocols in the framework very easily. Steps involved in creating a Standalone CLI Agent are as follows:

1. Create a MIB using MIB Editor. 2. In the Agent Compiler, create a Multi-Protocol Project. 3. Load the MIB. The Agent Compiler creates the corresponding TCS, CCS, and data set files

corresponding to the other protocols. 4. Generate, Instrument, and Compile the source code.

The agent can be tested using MIB Browser, TL1CraftInterface, CLI Browser, and Web Browser. Based on the nature of the query, the corresponding adapter is chosen by the agent to interact with the manager/browser.

Page 11: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 10

Agent Toolkit C Edition: Architecture This chapter explains the Agent Toolkit C Edition's architecture. Agent is a management software module which will respond to the management station for performing management operations. It is also capable of triggering notification for fault or events which need management station's attention. Generally agent will be embedded/implemented in devices or applications which need management capability. The agent and the manager will transact management protocol-specific operations over the communication protocol. The main modules of the architecture are as follows:

• Session

• Protocol Engine

• Instrumentation Code This architecture is common to all types of agents (Standalone SNMP/TL1/CLI and Multi-protocol agent). The session and protocol engine modules of a particular management protocol would be common to all devices/applications, only the instrumentation module will vary according to the managed device/application's requirements. The following image is the overall Agent Toolkit C Edition's architecture:

Session The communication between a Manager and an Agent takes place through this module. It provides framework to plug in other communication protocols. By default, TCP/IP, UDP/IP, and RS232 serial support are provided. Protocol Engine This is the core part of the agent. It mainly contains message processing sub-system which is responsible for parsing and formatting management protocol-specific messages. It also has other sub-system for security and services (for example, timer service).

Page 12: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 11

Instrumentation Code The instrumentation files are the generated stub files for given input files (MIB/TCS/CCS). User or application/device-specific instrumentation can be done on these files. For a much detailed, protocol-specific architecture, please refer to the topics, Standalone SNMP Agent Architecture, Standalone TL1 Agent Architecture, Standalone CLI Agent Architecture, and Multi-Protocol Agent Architecture.

Page 13: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 12

What Is New in This Release Release 6.0.1 This section explains the key features included in AdventNet Agent Toolkit C Edition 6.0.1.

• TL1 Message Document Generation: The TL1 Message Document generation feature enables the generation of HTML Documents for the TL1 messages supported by the NE. This can be used as a user manual that gives all the necessary information about the messages including the message format, the sample input and response message for each message.

Release 6.0.0 This section explains the key features included in AdventNet Agent Toolkit C Edition 6.0.0.

• Standalone CLI Agent support: CLI Agent support allows user to develop cisco like command line interface for managing device or applications with rich set of command line features. It can be connected via TCP/IP, Telnet or RS 232 serial port communication interfaces.

• Tools, such as CLI Editor and CLI Browser have been bundled with the toolkit.

• CLI adapter support in Multi-protocol agent.

• Co-existence, Notification, and Target MIB Implementation in SNMP Agent. The SNMP Agent can now support co-existence, notification, and target MIB implementation as defined in the following RFC standards:

o RFC 2676: Co-existence support o RFC 2573: Notification Implementation o RFC 2573: Target MIB Implementation o Telnet support: The telnet support provided in TL1 Agent has command line features, such

as command completion, editing, and command syntax display. o Enhanced TL1 Message Builder and TL1CraftInterface tools for TL1 Agent. o HTTP 1.1 and SSL support in HTTP Adapter: o HTTP 1.1 support as per RFC 2068 standard. o SSL (Secure Sockets Layer) protocol is for authenticated and encrypted communication

between clients and servers.

Page 14: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 13

Related 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. AdventNet Web NMS is an open, massively scalable, carrier-grade management infrastructure platform built for the Internet age. It provides out-of-the-box application functions with tremendous flexibility to customize various domain-specific needs. AdventNet SNMP API is the industry's most popular Java based implementation of the Simple Network Management Protocol (SNMP). With the most complete standards support, it is available for SNMPv1, SNMPv2c and SNMPv3. AdventNet SNMP API includes complete MIB support, SNMP components for Enterprise Java Beans (EJB) based J2EE application servers, CORBA IDL support for gateway to CORBA based applications, database support for handling large scale server based applications, numerous optimizations to handle MIB tables and getting bulk data efficiently, a pluggable transport layer for running SNMP over UDP, TCP, HTTP and serial-link and other transport protocols. AdventNet TL1 API provides a feature-rich, cross-platform API to communicate with TL1 Network Elements and extract the management information which can be used by a variety of applications. AdventNet TL1 API is designed to build scalable server-based applications. It provides the capability to define a TL1 message set through a graphical TL1 Message Builder, which generates an XML file describing the message set. The API can load this message set, and thus provide the capability to handle a wide variety of TL1 message formats and syntax. AdventNet CLI API is a set of Java libraries for network management developers seeking to leverage the power of Java and other Internet technologies in quickly delivering Java and web-based solutions for managing Command Line Interface (CLI) based devices. 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. AdventNet Agent Tester is a cross-platform, comprehensive, customizable, extensible, and interventionless automated testing tool that enables testing of Agents built on SNMP. It automates the functional testing of your Agent where the valid, invalid, and inopportune behavior can be tested.

Page 15: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 14

Contacting AdventNet AdventNet, the Internet Management Infrastructure Company™ is the market leader in providing open, scalable, extensible, and cross-platform management solutions for managing the Internet and e-commerce infrastructure. AdventNet is eager to hear your comments, feedback, and suggestions which will help in improving our products. We give you the contact information to our Corporate Headquarters, sales, and technical support teams in addition to the link to subscribe to the Java network management mailing list. AdventNet Corporate Headquarters 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 from Optical and core internet working 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. Contact information

Web Site http://www.adventnet.com

AdventNet Headquarters

AdventNet, Inc. 5645 Gibraltar Drive Pleasanton, CA 94588 USA Phone : +1-925-924-9500 Fax : +1-925-924-9600 Email: [email protected]

AdventNet India Development Center

AdventNet Development Center (I) Private Limited 11 Sarathy Nagar Vijayanagar Velachery, Chennai 600 042 INDIA Phone : +91-44-22431115 Fax : +91-44-22435327 Email: [email protected]

Sales For sales and product licensing inquiries, please use the following contact information table: http://www.adventnet.com/contact.html You can also send e-mail to [email protected]. at the AdventNet headquarters main switchboard below:

Phone: +1-925-924-9500 and ask for Sales Fax: +1-925-924-9600 Technical Support For support and bug report, please send e-mail to - [email protected].

For those with support contracts, AdventNet provides priority support via e-mail with a reply usually provided within 24 hours. During the evaluation phase, AdventNet provides "no fees" support. This support includes e-mail access to our product specialists for problem resolution, clarifications in documentation, and technical guidance. Feel free to send your queries. We promise to respond as quickly as possible to make your evaluation a success.

Page 16: Quick Tour - WebNMS · Title: Quick Tour Author: AdventNet Inc. Subject: Quick Tour Created Date: 11/22/2003 3:46:01 PM

Quick Tour

AdventNet Inc. 15

Please provide the following information while sending support mails:

• Release version of the product - AdventNet Agent Toolkit C Edition Release 6

• Operating System and version

• JDK version

• C Compiler used

• Stack traces, if any

• Debug messages or hex dumps, if any

• CLASSPATH environment variable, if applicable

• Details of the service pack/patch applied, if any and any other information. This will help us to provide faster responses to your query. Feedback We welcome your feedback that will help us improve the APIs and provide future enhancements. Send your Feedback to [email protected].