Chapter . Preface

This preface includes the following topics:

Purpose of This Manual

This document describes the BEA Manager Agent Connection for M3 and TUXEDO and gives instructions for using the Agent Connection with BEA M3 or TUXEDO applications.

Who Should Read This Manual

This document is intended for system administrators, network administrators, and developers interested in managing M3 or TUXEDO applications using enterprise system management tools. This document is intended for reference purposes only.

How This Manual Is Organized

This manual is organized as follows:

Chapter 1, "Overview" - Describes what the Agent Connection software is and how it can facilitate M3 or TUXEDO resource management. Explains the benefits of integrating M3 or TUXEDO applications into a network management platform. Provides an overview of the Simple Network Management Protocol (SNMP), and the TUXEDO Management Information Base (TMIB) for SNMP. Compares the standard TUXEDO MIB to the TUXEDO MIB for SNMP. Suggests next steps to take to get started using the Agent Connection.
Chapter 2, "Setting Up the Agents" - Provides instructions for setting up and configuring the agents on the managed nodes. Explains how to start and stop the SNMP agents on UNIX and Windows platforms. Describes how the TUXEDO SNMP agent functions on TUXEDO master and non-master nodes.
Chapter 3, "Integrating Agent Connection with a Management System" - Provides instructions for setting up and configuring the Agent Connection software on the management system, including how to integrate M3 and TUXEDO event notifications into your management platform or Tivoli TME platform.
Chapter 4, "TUXEDO Core MIB" - Details the basic groups, objects, and attributes of those objects that form a BEA TUXEDO application, and are defined in the Core Management Information Base (MIB). The Core MIB is the main information repository to control the operation and configuration of a BEA TUXEDO application via these basic objects.
Chapter 5, "BEA Domain List" - Describes the BEA domain list. The domain list is a MIB group that represents information about the M3 or TUXEDO domain the agent is monitoring, as specified at startup.
Chapter 6, "M3 MIB Groups" - Describes the MIB groups and member objects that are specific to M3 applications. Also, lists the M3 specific objects included as a part of the TUXEDO Core MIB.
Chapter 7, "Access Control List MIB" - Describes the access control list (ACL) MIB groups. An ACL is a list that specifies who and what is authorized to access TUXEDO system objects.
Chapter 8, "Workstation MIB" - Describes the workstation MIB groups. The Workstation MIB specifies the information required to control access to a TUXEDO application from multiple workstations. The Workstation MIB specifies information about workstation listeners (WSL) and workstation handlers (WSH).
Chapter 9, "Application Queue MIB" - Describes the Application Queue MIB groups. The Application Queue MIB provides the administrative environment required to manage and control access to application queues, and defines the structure of the application queues.
Chapter 10, "Event Broker MIB" - Describes the Event Broker MIB. The Event Broker MIB defines the characteristics by which an application (clients or services) can subscribe to be notified of TUXEDO run-time system events. (To enable both system event and application event notification, you must first define the system event broker and the application event broker in the TUXEDO Core MIB.)
Chapter 11, "TUXEDO Traps MIB" - Describes the TUXEDO Event Traps MIB. The TUXEDO SNMP agent on the master node subscribes to all system events and generates a corresponding SNMP trap notification whenever certain types of events occur-mostly failures that a system operator should know about. The Event Traps MIB defines all the traps which will be generated and the objects which are passed in the variable bindings for these traps. This chapter describes the cause and recommended action for each of these events.

How to Use This Manual

This manual is designed primarily as an online, hypertext guide. If you are reading this as a paper publication, note that to get full use from this guide you should install and access it as an online document via a Web browser that supports HTML 3.0. (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 online version of this document, open the following HTML file in a Web browser:

$installation_dir/docs/mgr/20/agcon/index.htm

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

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 The Manual Displayed in a Web Browser

How to Print

You can print a hardcopy version of the BEA Manager Agent Connection for M3 and TUXEDO Systems Reference Manual, a chapter at a time, from the Web browser. Before you print, make sure that the chapter or appendix you want to print 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 what file you are about to print.)

How to Print the Complete Book

A PDF version of the Agent Connection for M3 and TUXEDO Systems Reference Manual is available in the following location:

YourDrive:\docs\mgr\20\pdf\agcon.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

Throughout this manual, the following formatting conventions are used to specify data entry words, screen and menu options, and various symbols.


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.

Contact Information

The following sections provide information about how to obtain support for the documentation and software.

Documentation Support

If you have questions or comments on the documentation, you can contact the BEA Information Engineering Group by e-mail at docsupport@beasys.com. (For information about how to contact Customer Support, refer to the following section.)

Customer Support

If you have any questions about this version of the BEA Manager Agent Connection software, or if you have problems installing and running the software, contact BEA Customer Support through BEA WebSupport at www.beasys.com. You can also contact Customer Support by using the contact information provided on the Customer Support Card, which is included in the product package.

When contacting Customer Support, be prepared to provide the following information:

Your name, e-mail address, phone number, and fax number
Your company name and company address
Your machine type and authorization codes
The name and version of the product you are using
A description of the problem and the content of pertinent error messages