[Top] [Prev] [Next] [Bottom]

Preface

Site/SunNet/Domain Manager™ 2.3 is comprised of software that contains services to help manage elements of a network. It provides a common platform for network management functions. It includes a Manager/Agent Services library to assist in monitoring various aspects of a network.

Who Should Read This Book

Part I of this manual describes the Manager Services library and the Application Programmer's Interface (API) that allows a programmer to use the services to request and receive reports from remote network agents. The primary audience is system designers and engineers who need to write new manager applications. Readers should be familiar with the overall Site/SunNet/Domain Manager architecture before writing a manager application. The introductory chapter of the Administration Guide as well as Part II of this manual should be understood to gain a view of the world from both a user's and an agent's perspective. It is also helpful to first build a simple agent for a "hands-on" understanding of the control flow between manager and agent.

Part II of this manual is intended for those C programmers and engineers who want to extend Site/SunNet/Domain Manager to manage resources not supported with the agents supplied in this product. Prospective agent writers should familiarize themselves with the Console

How This Book Is Organized

This manual is divided into three parts: Part I "Writing Management Applications" includes the first nine chapters. Part II "Writing Agents" includes Chapters 10 through 14. Part III "Man Page Summaries" lists, with brief descriptions, the on-line man pages available for utilities, routines, and file formats for manager writers and for agent writers.

Part I--Writing Management Applications

Part I contains the following chapters:

Chapter 1, "Overview of Writing Management Applications ," provides a quick overview of the Manager/Agent Services library.

Chapter 2, "Registering for Data, Event, and Trap Reports ," describes the methods used to register your manager application to receive data and event reports.

Chapter 3, "Getting Data, Event, and Trap Reports ," suggests the algorithms to follow when getting data and event reports.

Chapter 4, "Requesting Data and Event Reports ," shows how an application asks for data and event reports. It also shows how to kill an existing request.

Chapter 5, "Setting Attribute Values ," discusses how to set attribute values.

Chapter 6, "Handling Error Reports ," details the procedures for handling error reports.

Chapter 7, "Unregistering the Application ," discusses how to unregister your application from the various data and event forwarding services.

Chapter 8, "Using the Database API Functions ," describes how to use the database API functions.

Chapter 9, "Miscellaneous Topics ," lists many issues related to writing manager applications not covered in earlier chapters.

Part II--Writing Agents

Part II contains the following chapters:

Chapter 10, "Overview of Writing Agents ," provides a high-level overview of the agent writing process.

Chapter 11, "Writing an Agent Schema ," presents the schema, the agent-specific portion of the Management Database.

Chapter 12, "Procedure for Writing an Agent ," details the set of steps involved in developing agent code.

Chapter 13, "Testing and Integration ," discusses how to test your agent and integrate it with this product.

Chapter 14, "Converting an Existing Application to an Agent ," offers an example of converting an existing application into an agent.

Part III--Man Page Summaries

Part III provides lists of available on-line man pages that describe each function in the Manager and Agent Services libraries. These lists, which include brief descriptions of each man page, are divided into the following appendices:

Appendix A, "Man Page Summary for Writers of Manager Applications ," lists man pages for utilities, routines, and file formats for reference when writing manager software.

Appendix B, "Man Page Summary for Writers of Agent Software ," lists man pages for utilities, routines, and file formats for reference when writing agent software.

Compatibility

See the Site/SunNet/Domain Manager 2.3 Release Notes that accompanies this product for definitive compatibility information.

Conventions Used in This Book

This section describes the conventions used in this book.

Compatibility-Related Conventions

All procedures and other information in this book applies to both the Solaris™ 2.x and 1.x operating environments, unless the text explicitly states otherwise.

Command Line Examples

All command line examples in this guide use the C-shell environment. If you use either the Bourne or Korn shells, refer to sh (1) and ksh(1) man pages for command equivalents to the C-shell.

What Typographic Changes and Symbols Mean

Table P-1 , "Typographic Conventions ," describes the type changes and symbols used in this book.
Typographic Conventions
Typeface or Symbol
 		Meaning
Example

AaBbCc123  

The names of commands, files, and directories; on-screen computer output  

Edit your .login file.

Use ls -a to list all files.

system% You have mail.

 

AaBbCc123  

What you type, contrasted with on-screen computer output  

 system% su

Password:

 

<AaBbCc123>  

Command-line placeholder:

replace with a real name or value  

To delete a file, type rm <filename>.  

AaBbCc123  

Book titles, new words or terms, or words to be emphasized  

These are called class options.

You must be root to do this.  

Code samples are included in boxes and may display the following:

%  

UNIX C shell prompt  

system%  

$  

UNIX Bourne and Korn shell prompt  

UNIX Bourne and Korn shell prompt  

#  

Superuser prompt, all shells  

Superuser prompt, all shells  



[Top] [Prev] [Next] [Bottom]

Copyright 1996 Sun Microsystems, Inc., 2550 Garcia Ave., Mtn. View, CA 94043-1100 USA. All Rights Reserved