Preface

Purpose of This Manual

The Agent Integrator Reference Manual provides reference information on the agents, utilities, configuration files, and MIBs shipped with the BEA Agent Integrator. Use this manual to understand how to configure and manage the Agent Integrator master agents.

Who Should Read This Manual

This reference manual is particularly helpful for network or system administrators responsible for administrating SNMP master agents and SMUX subagents.

How This Manual Is Organized

The Agent Integrator Reference Manual is organized as follows:

Chapter 1, "Agent Integrator Overview," explains the agent/manager model, the structure of the SNMP agent software, its components, and its directory structure.
Chapter 2, "Getting Started," describes the administrative and user tasks that need to be performed after software installation.
Chapter 3, "Using Multiple SNMP Agents," describes the use of the Agent Integrator to coordinate communication between an SNMP manager and multiple SNMP agents.
Chapter 4, "Using Agent Integrator for Polling," describes the rules used to offload threshold-checking from the manager to the Agent Integrator master agent.
Chapter 5, "Agent Integrator Commands," describes the syntax of the commands used to start or re-initialize the Agent Integrator.
Chapter 6, "Starting the Subagents," explains how to use the SNMP Multiplex (SMUX) subagents shipped with the Agent Integrator.
Chapter 7, "Configuration Files," describes the BEA Manager SNMP configuration files.
Chapter 8, "BEA SNMP Agent MIB," describes the MIB objects supported by the BEA agent MIB, which is defined in the file bea.asn1.
Appendix A, "SNMP Information," lists references and contacts for information concerning MIBs and the SNMP protocol.
"Glossary" contains a collection of acronyms and phrases used in discussing SNMP applications.

Online Document Considerations

This document, Agent Integrator Reference Manual, is designed primarily as an online, hypertext guide. To get full use of the information in this document you should install and access it as an online document via a Web browser that supports HTML 3.0. Netscape Navigator 2.02 or Microsoft Internet Explorer 3.0 or later are recommended. (Information on how to install the online documentation is available in the BEA Manager Installation Guide.)

Opening the Manual in a Web Browser

To access the interactive version of this document, open the following HTML file in a Web browser:

$RELEASE_ROOT/DOCS/MGR/20/INTEG/INDEX.HTM

Note: The online documentation requires a Web browser that supports HTML 3.0. Netscape Navigator 2.02 or Microsoft Internet Explorer 3.0 or later are recommended.

Figure 1 shows the online manual with the clickable navigation bar and table of contents.

Figure 1 Agent Integrator Reference Manual Displayed in Netscape Web Browser

Printing the Manual from a Web Browser

You can print a hardcopy version of this manual, one file at a time, from the Web browser. Before you print, make sure that the chapter or appendix you want is displayed and selected in your browser. (To select a file, click anywhere inside the frame you want to print. If your browser offers a Print Preview feature, you can use it to verify which file you are about to print.)

How to Print the Complete Book

A PDF version of the Agent Integrator Reference Manual is available in the following location:

YourDrive:\docs\mgr\20\pdf\integ.pdf

To print the documentation, open a PDF file in an Adobe Acrobat Reader and choose the file print option.

If you do not have a reader, you can download one from the Adobe Web site at http://www.adobe.com/.

Documentation Conventions

The following documentation conventions are used throughout this document.


Convention	Item
boldface text	Indicates terms defined in the glossary.
Ctrl+Tab	Indicates that you must press two or more keys sequentially.
italics	Indicates emphasis or book titles.
`monospace text`	Indicates code samples, commands and their options, data structures and their members, data types, directories, and file names and their extensions. Monospace text also indicates text that you must enter from the keyboard. Examples: `#include <iostream.h> void main ( ) the pointer psz` `chmod u+w *` `\tux\data\ap` `.doc` `tux.doc` `BITMAP` `float`
`monospace boldface text`	Identifies significant words in code. Example: `void` `commit` `( )`
`monospace italic text`	Identifies variables in code. Example: `String` `expr`
UPPERCASE TEXT	Indicates device names, environment variables, and logical operators. Examples: LPT1 SIGNON OR
`{ }`	Indicates a set of choices in a syntax line. The braces themselves should never be typed.
`[ ]`	Indicates optional items in a syntax line. The brackets themselves should never be typed. Example: `buildobjclient [-v] [-o name ] [-f` `file-list``]... [-l` `file-list``]...`
`\|`	Separates mutually exclusive choices in a syntax line. The symbol itself should never be typed.
`...`	Indicates one of the following in a command line: That an argument can be repeated several times in a command line That the statement omits additional optional arguments That you can enter additional parameters, values, or other information The ellipsis itself should never be typed. Example: `buildobjclient [-v] [-o name ] [-f` `file-list``]... [-l` `file-list``]...`
`. . .`	Indicates the omission of items from a code example or from a syntax line. The vertical ellipsis itself should never be typed.