0% found this document useful (0 votes)
4K views

Hawk Install Configure

TIBCO software EMBEDDED or BUNDLES other TIBSOFTWARE SOLELY to ENABLE the FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALity) of the LICENSED TIBKO SOFTWEAR. TIB, TIBco, information bus, the power of now, TIBCO Adapter, TIBCool, TIBCO designer, tibico rendezvous,

Uploaded by

Ravindranadh Chowdary Nimmagadda
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
4K views

Hawk Install Configure

TIBCO software EMBEDDED or BUNDLES other TIBSOFTWARE SOLELY to ENABLE the FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALity) of the LICENSED TIBKO SOFTWEAR. TIB, TIBco, information bus, the power of now, TIBCO Adapter, TIBCool, TIBCO designer, tibico rendezvous,

Uploaded by

Ravindranadh Chowdary Nimmagadda
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 204

TIBCO Hawk™

Installation and Configuration


Software Release 4.2.1
April 2004
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE.
THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY
ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT,
THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING
DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE
TIBCO HAWK ADMINISTRATOR’S GUIDE). USE OF THIS DOCUMENT IS SUBJECT TO THOSE
TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE
OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright
laws and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
TIB, TIBCO, Information Bus, The Power of Now, TIBCO Adapter, TIBCO Hawk, TIBCO Designer,
TIBCO Rendezvous, TIBCO ActiveEnterprise and TIBCO Repository are either registered
trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.
EJB, J2EE, JMS and all Java-based trademarks and logos are trademarks or registered trademarks of
Sun Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of
their respective owners and are mentioned for identification purposes only.
This software may be available on multiple operating systems. However, not all operating system
platforms for a specific software version are released at the same time. Please see the readme.txt file
for the availability of this software version on a specific operating system platform.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
Copyright © 1999-2004 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
TIBCO Hawk Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Third Party Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi

Chapter 1 Overview of the TIBCO Hawk System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1


Components of the TIBCO Hawk System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2 Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3


Installer Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installation Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installing TIBCO Hawk over Previous Releases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Uninstalling TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Product Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Uninstallation Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Installation Registry and History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Microsoft Windows Platform Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
UNIX Platform Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Installation History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Specifying the JRE Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 3 Installing on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11


Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
User Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Disk Space and Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Installing TIBCO Hawk. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Installation Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

TIBCO Hawk Installation and Configuration


iv
| Contents
Typical and Custom Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Installation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Post-Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Reboot the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Verify the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Set Disk Counters (Windows 2000 and Windows XP Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Configure Windows Services Logon Account (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 4 Installing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23


Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Supported Operating Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Installer Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Disk Space and Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Default File Descriptor Setting (Solaris 2.6 and 2.7 Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Reconfigure Two-Button Mouse Devices (Solaris Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Set Environment Variable (Compaq Tru64 UNIX Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Installing TIBCO Hawk on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Installation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Typical and Custom Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Installation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Installing the TAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Post-Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Starting TIBCO Hawk Components Automatically at System Boot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Solaris Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
HP-UX Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
AIX Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
TRU64 Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
LINUX Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Chapter 5 Installing on OS/400 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39


Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Supported Operating Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Installing TIBCO Hawk on OS/400 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Post-Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Starting TIBCO Hawk Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Chapter 6 Configuring TIBCO Hawk Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45


Startup Scripts and Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
TIBCO Hawk Display Configuration File (hawkdisplay.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

TIBCO Hawk Installation and Configuration


Contents v
|
TIBCO Hawk Agent Configuration File (hawkagent.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
-M Self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
-M RuleBaseEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
-M AMIService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
-M LogService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
-M TIBProtocolAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
-M Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
-M LogfileMicroAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
TIBCO Hawk HMA Configuration File (hawkhma.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
TIBCO Hawk Event Service Configuration File (hawkevent.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Configuring the Event Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Creating a TIBCO Hawk Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Creating a TIBCO Rendezvous Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Default Session Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Setting up a TIBCO Rendezvous Daemon Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Chapter 7 Using the Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87


Configuration Utility Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Domain Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Rendezvous Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
HMA Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Java Runtime Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Configuration File Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Java Virtual Machine Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Character Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
TIBCO Hawk Display Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
TIBCO Hawk Agent Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Configuration Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
MicroAgent Plugins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Logfile Microagent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
AMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
AMI Rendezvous Session Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

TIBCO Hawk Installation and Configuration


vi
| Contents
TIBCO Hawk Event Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Logging File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Command-Line Executable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Disabling and Enabling the Event Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Configuring the Event Service in Windows XP and 2000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Chapter 8 Using TIBCO Hawk Across Nets or Subnets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113


Agents and the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Configuring for Network Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Configuring Hawk Rendezvous Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Setting up Network Communication on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Routing Daemon Configuration for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Setting Up Network Communication in Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Installing a Routing Daemon as a Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Starting the Routing Daemon Service Automatically in Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Making TIBCO Hawk Services Depend on the Routing Daemon Windows Service . . . . . . . . . . . . . . . . . . 118
Using the TIBCO Hawk Display over a Dial-up Network Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Establishing a Dial-up Connection in UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Establishing a Dial-up Connection in Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Chapter 9 TIBCO Hawk Sample Rulebases and Applications . . . . . . . . . . . . . . . . . . . . . . . . . 123


Using the Sample TIBCO Hawk Rulebases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Using the TIBCO Hawk Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
The Sample AMI API Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
TIBCO Hawk AMI C API Sample Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
TIBCO Hawk AMI C++ API Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
TIBCO Hawk AMI Java API Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Using the Sample Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Chapter 10 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Trusted Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Using both Trusted and TrustedWithDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
To Use the Trusted Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Access Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Trusted.txt and TrustedWithDomain File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Certified Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
TIBCO Rendezvous DataSecurity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

TIBCO Hawk Installation and Configuration


Contents vii
|
Access control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Configuring access control in rvacld for the Certificate Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Secure AMI Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Running with a localhost rvd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Certificate Authorities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Third-Party Certificate Authorities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Appendix A Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155


Migration Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Re-Linking C and C++ Applications to Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Changing the Codepage Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Using 3.x and 4.x Agents Together. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Migrating Rulebase Map from Previous JRE Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Using the Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Converting Commands from Previous Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Appendix B Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159


UNIX Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Windows Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Packet Fragmentation Errors with Multicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
String Variable Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
General Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Appendix C TIBCO Hawk Directories and Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167


TIBCO Hawk Directory Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Appendix D Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175


Example Certificate File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Appendix E Code Page Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177


Code Page Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

TIBCO Hawk Installation and Configuration


viii
| Contents

TIBCO Hawk Installation and Configuration


| ix

Figures

Figure 1 General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89


Figure 2 Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Figure 3 Display Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Figure 4 Agent Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Figure 5 Rulebase Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Figure 6 AMI Rendezvous Session Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Figure 7 Add AMI Rendezvous Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Figure 8 TIBCO Hawk Event Service Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Figure 9 Sample Routing Daemon Configuration for TIBCO Hawk Messaging . . . . . . . . . . . . . . . . . . . . . 115
Figure 10 The TIBCO Hawk Services in the Windows Registry Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Figure 11 Adding the rvrd Service Value to the Windows Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Figure 12 Certified Model Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Figure 13 AMI Communication Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

TIBCO Hawk Installation and Configuration


x
| Figures

TIBCO Hawk Installation and Configuration


| xi

Tables

Table 1 JRE Search Location on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8


Table 2 JRE Search Location on Solaris . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Table 3 JRE Search Location on HP-UX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Table 4 JRE Search Location on AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Table 5 JRE Search Location on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Table 6 Supported Windows Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Table 7 Supported UNIX Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 8 Required Disk Space in the Temp and Installation Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Table 9 Recommended JRE Versions and Download Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 10 UNIX Installation tar Package Filenames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Table 11 TIBCO Hawk Components, Startup Scripts, and Configuration Files . . . . . . . . . . . . . . . . . . . . . . 46
Table 12 hawkdisplay.cfg Functions and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 13 hawkagent.cfg Modules and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 14 -M Self Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 15 -M RuleBaseEngine Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 16 -M TIBProtocolAdapter Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 17 -M LogfileMicroAgent Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 18 hawkhma.cfg Functions and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 19 hawkevent.cfg Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Table 20 Access Control File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Table 21 TIBCO Hawk Files and Directories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Table 22 Code Page Identifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

TIBCO Hawk Installation and Configuration


xii
| Tables

TIBCO Hawk Installation and Configuration


| xiii

Preface

This software may be available on multiple operating systems. However, not


all operating system platforms for a specific software version are released at the
same time. Please see the readme.txt file for the availability of this software
version on a specific operating system platform.

This manual covers the installation of the TIBCO Hawk™ software on Microsoft
Windows 2000, Microsoft Windows XP, Solaris, HP-UX, AIX, Compaq TRU64
UNIX, Linux, and OS/400. Custom configuration is also covered in this manual.
This manual assumes you are familiar with TIBCO Rendezvous architecture and
the concepts of system monitoring.

Topics

• Related Documentation, page xiv


• How to Contact TIBCO Customer Support, page xvi

TIBCO Hawk Installation and Configuration


xiv
| Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Hawk Documentation


The following documents form the TIBCO Hawk documentation set:
• TIBCO Hawk Release Notes Contains late-breaking news and information, as
well as descriptions of new features, migration paths, and open and closed
issues.
• TIBCO Hawk Installation and Configuration Read this book first. It contains
step-by-step instructions for installing TIBCO Hawk software on various
operating system platforms. It also describes how to configure the software
for specific applications, once it is installed. An installation FAQ is included.
• TIBCO Hawk Administrator’s Guide This manual includes basic descriptions of
TIBCO Hawk concepts, instructions for using TIBCO Hawk Display,
monitoring strategies with examples, a comprehensive FAQ, and a glossary.
All books in the documentation set refer to features explained in this book.
• TIBCO Hawk Programmer’s Guide All programmers should read this manual.
It covers the AMI protocol, AMI messages, the AMI Workbench development
tool, and the TIBCO Hawk security framework and its classes. Programmers
should then refer to the appropriate language reference for the AMI API. The
TIBCO Hawk Application Management Interface (AMI) exposes internal
application methods to TIBCO Hawk.
• TIBCO Hawk AMI C Reference Contains detailed descriptions of each datatype
and function in the TIBCO Hawk C AMI API.
• TIBCO Hawk AMI C++ Reference Contains detailed descriptions of each
datatype and function in the TIBCO Hawk C++ AMI API.
• TIBCO Hawk AMI Java Reference Contains detailed descriptions of each class
and method in the TIBCO Hawk Java AMI API.
• TIBCO Hawk Console API Reference Contains detailed descriptions of each
class and method in the TIBCO Hawk Console API, a set of Java interfaces
that allow you to manage and interact with TIBCO Hawk agents and monitor
alerts generated by these agents.
• TIBCO Hawk Configuration Object API Reference Contains detailed descriptions
of each class and method in the TIBCO Hawk Configuration Object API.
• TIBCO Hawk Methods Reference A reference to the microagents and methods
used by a TIBCO Hawk Agent for system and application monitoring.

TIBCO Hawk Installation and Configuration


Preface xv
|

Other TIBCO Product Documentation


You may find it useful to read the documentation for the following TIBCO
products:
• TIBCO Rendezvous™ software: This is TIBCO’s real-time transport layer that
is used by TIBCO Hawk.
• TIBCO Adapter SDK™ software, including TIBCO AdapterAdministrator™
and TIBCO Repository™: These related products are used to manage TIBCO
ActiveEnterprise data and metadata.

Third Party Documentation


You may find the following third-party documentation useful.
• The Java Language Specification by Gosling, Joy, and Steele

TIBCO Hawk Installation and Configuration


xvi
| How to Contact TIBCO Customer Support

How to Contact TIBCO Customer Support

For comments or problems with this manual or the software it addresses, please
contact TIBCO Support Services as follows.
• For an overview of TIBCO Support Services, and information about getting
started with TIBCO Product Support, visit this site:
http://www.tibco.com/services/support/default.jsp
• If you already have a valid maintenance or support contract, visit this site:
http://support.tibco.com
Entry to this site requires a username and password. If you do not have a
username, you can request one.

TIBCO Hawk Installation and Configuration


|1

Chapter 1 Overview of the TIBCO Hawk System

This chapter gives a basic overview of the TIBCO Hawk monitoring system, its
components, and the components supported on the various platforms. Not all
components run on all platforms, so determine what is supported on your system
before beginning installation and configuration.
This book provides instructions for installing the TIBCO Hawk software on each
software platform, as well as how to configure the software for specific
applications after installation.

Topics

• Components of the TIBCO Hawk System, page 2

TIBCO Hawk Installation and Configuration


2
| Chapter 1 Overview of the TIBCO Hawk System

Components of the TIBCO Hawk System

The TIBCO Hawk monitoring system consists of the following main software
components.

TIBCO Hawk Agent


A TIBCO Hawk agent is an autonomous process that resides on each computer
and monitors systems and applications on that computer. Agents run
independently of the TIBCO Hawk Display.
Agents operate autonomously and are active whenever the operating system they
monitor is active. Agents use sets of rules, called rulebases, to configure system
management, status, and automation tasks.
A TIBCO Hawk agent must be installed on each computer you wish to monitor.

TIBCO Hawk Microagent


A TIBCO Hawk Microagent (HMA) is a partner process to the TIBCO Hawk agent
and provides the local agent with methods for monitoring the host operating
system.
Like the agent, a TIBCO Hawk Microagent is generally installed on each
computer you wish to monitor.

TIBCO Hawk Display Program


The TIBCO Hawk Display program is used by system administrators to view
network health and to create rulebases (sets of rules that automate monitoring
activities).
A TIBCO Hawk Display should be installed on any computers you wish to use for
monitoring the network or for building rulebases.

TIBCO Hawk Event Service


The TIBCO Hawk Event Service is a process that records TIBCO Hawk alerts and
changes in agent status. When communication with an agent is lost, the Event
Service can invoke a user-provided script. Alerts and notifications can be
recorded to log files or a database.
Typically, the TIBCO Hawk Event Service is installed on a minimal number of
computers in the network.

TIBCO Hawk Installation and Configuration


|3

Chapter 2 Installation Overview

This chapter provides an overview of the installer program.


Appendix C, TIBCO Hawk Directories and Files, contains a complete list of the files
and folders installed for the various platforms.

Installing TIBCO Hawk on Windows updates the system path to include TIBCO
Rendezvous 7.2. If you have TIBCO applications installed that use Java, and if
those applications are using the TIBCO Rendezvous bundled in TRA 5.1.x
(instead of a separately installed TIBCO Rendezvous), the applications will not be
able to start the TIBCO Rendezvous daemon, rvd.exe, after you install TIBCO
Hawk.
To allow the previous TIBCO applications to start rvd.exe again, remove the
TIBCO Rendezvous 7.2 directory from the system path (for example,
c:\tibco\tibrv\bin). This will not affect the operation of TIBCO Hawk.

TIBCO applications that use Java include TIBCO Adapter 4.x, TIBCO Designer
4.x, TIBCO BusinessWorks 5.x, TIBCO BusinessWorks 5.x, and others.

Topics

• Installer Overview, page 4


• Uninstalling TIBCO Hawk, page 5
• Installation Registry and History, page 6

TIBCO Hawk Installation and Configuration


4
| Chapter 2 Installation Overview

Installer Overview

Installation Directory
If this is the first TIBCO software product you are installing on the system, you
can specify the installation directory where TIBCO Hawk will be installed. On
Microsoft Windows, the default installation directory is C:\tibco\hawk. On
UNIX, the default installation directory is /opt/tibco.
If you already have a TIBCO 5.x product on your machine and you install TIBCO
Hawk, the installer will automatically select the TIBCO 5.x product installation
directory. You cannot choose a different location. If you wish to install TIBCO
Hawk in a different location, you must first completely uninstall all TIBCO 5.x
products from the machine.

install-path
The directory into which you install TIBCO Hawk is referred to in this
documentation as install-path.
For example, if you accept the default installation path on Windows, install-path is
C:\Tibco\hawk.

Installing TIBCO Hawk over Previous Releases


You do not need to uninstall the previous or current version of TIBCO Hawk on
the system before installing the new version. If the installer detects an existing
TIBCO Hawk version, it will ask you if you want to overwrite it or cancel the
installation.
All files originally installed by TIBCO Hawk are replaced with the new versions.
Files that you created are not removed or modified, even if they are in the same
directories as the original TIBCO Hawk files.
If any TIBCO Hawk files are locked (for example, if they are open or in use) when
you install the new version, the installer places them in a temporary location and
performs the actual overwrite the next time you reboot. See Uninstalling TIBCO
Hawk on page 5.

TIBCO Hawk Installation and Configuration


Uninstalling TIBCO Hawk 5
|

Uninstalling TIBCO Hawk

The uninstaller removes all files that were installed as a part of TIBCO Hawk
installation, even if those files were modified by the user or the application. Files
that were created by the user are not deleted or modified.

Make sure you have a backup of user-modified files before proceeding with the
uninstallation.

Product Dependencies
TIBCO Designer and TIBCO Runtime Agent (TRA) are dependent on TIBCO
Hawk being present on the machine. If you have TIBCO Designer or TRA
installed on your machine, you will need to uninstall them before uninstalling
TIBCO Hawk, in the following order:
1. Uninstall TIBCO Runtime Agent (tra-install-path\version\uninst) and any of its
product dependencies.
2. Uninstall TIBCO Hawk (hawk-install-path\hawk\uninst).
If you do not have TIBCO Designer or TRA installed on your machine, you can
uninstall TIBCO Hawk without prerequisite.

Uninstallation Instructions

Microsoft Windows
Uninstall the product(s) in the order shown above, using one of the following
methods:
• Click Start>Programs>TIBCO>TIBCO Runtime Agent>Uninstall.
• Use Add/Remove Programs from the Control Panel.
• Navigate to the _uninst directory located in each of the folders listed above
and invoke the Tibuninstall.exe program.

UNIX Systems
Uninstall the product(s) in the order shown above, by navigating to the _uninst
directory located in each directory shown and invoke the Tibuninstall.bin
program.

TIBCO Hawk Installation and Configuration


6
| Chapter 2 Installation Overview

Installation Registry and History

The installer maintains an installation registry consisting of two files with the
prefix vpd, which stands for Vital Product Database.
The location of the registry varies by platform. This section explains where the
registry files are located on each platform.

Do not edit, modify, move, rename, or delete any of the registry vpd files.

Microsoft Windows Platform Registry


On Microsoft Windows, the installation registry consists of the following files:
SystemDrive:\WINNT\vpd.properties
SystemDrive:\WINNT\vpd.properties.tibco.systemName

UNIX Platform Registry


If installation is performed by super-user (root), the installation registry is
maintained in the following locations:
• Solaris and HP-UX: in the root user’s home directory:
User_Home_Directory/vpd.properties
User_Home_Directory/vpd.properties.tibco.systemName

• Linux: in the /root directory:


/root/vpd.properties
/root/vpd.properties.tibco.systemName

• AIX: in the /usr/lib/objrepos directory:


/usr/lib/objrepos/vpd.properties
/usr/lib/objrepos/vpd.properties.tibco.systemName

If installation is performed by a regular user (non-root), the installation registry is


maintained in the following files in the user's home directory:
User_Home_Directory/vpd.properties
User_Home_Directory/vpd.properties.tibco.systemName

Installation History
The installer creates a file called TIBCOInstallationHistory.xml. Each time an
installation or uninstallation is performed, entries are appended to the file. The
installer uses the registry file during subsequent installations.

TIBCO Hawk Installation and Configuration


Installation Registry and History 7
|

The installation history file is created in the same directory as the installation
registry.

Specifying the JRE Location


This section explains how the installer uses JRE and how you can speed up
installation and reduce disk space requirements by using an existing JRE 1.3.1 on
your system.
The installer is Java-based. It is bundled with JRE 1.3.1. When you start
installation, the installer looks for an existing JRE 1.3.1 on the target system. If it
doesn’t find one, it extracts its own JRE into a temporary space and uses that JRE
to launch itself. It then copies the JRE into install-dir for use at uninstallation.
If the installer can use a JRE 1.3.1 already on the system, the installer loads and
completes more quickly and the product uses less disk space (because it doesn’t
need to extract and save its own JRE). It uses that same existing JRE for
uninstallation. If the JRE is removed at any time, you can run the uninstaller using
-is:javahome to point to a different JRE location.

How the Installer Searches for JRE


The installer searches for JRE 1.3.1 in a set of standard locations by default. These
standard locations are platform-specific and are listed in JRE Search Locations on
page 8.
The JRE search is very quick, but you can speed it up further by using one of the
following actions to specify the JAVA_HOME location before you launch the
installer:
• Set the environment variable JAVA_HOME or JDKHOME to the JRE home
directory. For example:
— Unix Bourne or Korn shell: JAVA_HOME=/opt/jre1.3.1; export
JAVA_HOME

— Unix C-shell: setenv JAVA_HOME /opt/jre1.3.1

— Microsoft Windows (setting JAVA_HOME in a command prompt will not


work): Choose Start-> Settings-> Control Panel-> System->
Environment-> System Variables or User Variables, then add a
JAVA_HOME variable and set its value.

• Include the command line option -is:javahome when launching the


installer. For example:
— Windows suite installer: <exe> -a -is:javahome C:\java\JRE\1.3.1

— Other installers: <exe_or_bin> -is:javahome /opt/jre1.3.1

TIBCO Hawk Installation and Configuration


8
| Chapter 2 Installation Overview

JRE Search Locations


The following tables list the search locations for the various supported platforms.

The installer searches for and uses only JRE 1.3.1. It will not use a different version
even if the other version exists on the system or is specified using an environment
variable or command-line option.

JRE Search Table 1 JRE Search Location on Windows


Location on
Windows Location Description
Environment (set in JAVA_HOME
JDKHOME
ControlPanel, not in
command prompt)

Registry \HKEY_LOCAL_MACHINE\SOFTWARE\
JavaSoft\Java Runtime Environment\
1.3\JavaHome \HKEY_LOCAL_MACHINE\SOFTWARE\
JavaSoft\ Java DevelopmentKit\1.3\JavaHome

Directory \Program Files\JavaSoft\JRE\1.3.1


\JavaSoft\JRE\1.3.1
\Java\JRE\1.3.1

JRE Search Table 2 JRE Search Location on Solaris


Location on
Solaris Location Description
Environment JAVA_HOME
JDKHOME

Path /usr/jre1.3.1
/usr/java1.3.1
/usr/jdk1.3.1
/opt/jre1.3.1
/opt/java1.3.1
/opt/jdk1.3.1

JRE Search Table 3 JRE Search Location on HP-UX


Location on
HP-UX Location Description
Environment JAVA_HOME
JDKHOME

Path /opt/java1.3
/opt/java1.3/jre

TIBCO Hawk Installation and Configuration


Installation Registry and History 9
|
JRE Search Table 4 JRE Search Location on AIX
Location on AIX
Location Description
Environment JAVA_HOME
JDKHOME

Path /usr/jdk_base
/usr/jdk_base
/usr/java131
/usr/java131

JRE Search Table 5 JRE Search Location on Linux


Location on
LINUX Location Description
Environment JAVA_HOME
JDKHOME

Path /usr/jre1.3
/usr/local/jre1.3
/opt/jre1.3
/opt/j2re1.3.1

TIBCO Hawk Installation and Configuration


10
| Chapter 2 Installation Overview

TIBCO Hawk Installation and Configuration


| 11

Chapter 3 Installing on Microsoft Windows

This chapter explains how to install and uninstall TIBCO Hawk on computers
running the Microsoft Windows 2000 or XP operating system. Information in this
chapter applies to all three platforms unless otherwise noted.

Topics

• Installation Prerequisites, page 12


• Installing TIBCO Hawk, page 15
• Post-Installation Tasks, page 18

TIBCO Hawk Installation and Configuration


12
| Chapter 3 Installing on Microsoft Windows

Installation Prerequisites

Read this section before you start installation.

Supported Operating Systems


The following tables lists the supported Windows platforms:

Table 6 Supported Windows Platforms

OS Hardware
Microsoft Windows 2000 with Intel Pentium
Service Pack 3 (build 2195)

Microsoft Windows XP (build 2600) Intel Pentium

Microsoft Windows 2003 Server Intel Pentium

User Privileges
You must have administrator privileges to install TIBCO Hawk. If you do not, the
installer will exit. You must then log out of the system and log in as a user with
administrator privileges.

Installing to a Networked Drive


If you intend to install the product onto a networked drive, you must have
permissions to write to that drive.
If you do not know how to do this, go to the machine so you can install locally, or
consult Microsoft Windows online help.

Installing on a Windows 2000 Terminal Server


A Windows 2000 terminal server has two modes: Execute and Install. The default
mode is Execute, which allows users to run applications.
To install TIBCO Hawk, it is recommended that the server be in Install mode and
that you have administrator privileges. If not, some Windows 2000 Terminal
Server features will not be available for TIBCO Hawk.

TIBCO Hawk Installation and Configuration


Installation Prerequisites 13
|

If you install in Execute mode, the installation registry is maintained in your user
home folder. If you install in the Install mode, the installation registry is
maintained in the SystemDrive:\WINNT\ folder.
Check your server mode by typing the following command:
C:\> change user /query

You can change the server mode to Install by typing the following command:
C:\> change user /install

Disk Space and Memory


This section lists the minimum free disk space and memory required for each
platform.
During installation, the entire package is extracted into a temporary directory,
typically one of the following:
• SystemDrive:\Temp
• SystemDrive:\Documents
• Settings\user_name\Local Settings\Temp

Before actually installing the files, the installer calculates the disk space that the
selected components will require in the installation directory. The installer will
proceed only if sufficient free disk space is available in the installation directory.
If some of the required disk space is taken by another process during installation,
the installer may fail and display a failure message.

Temp Directory
At least 152MB free space is required in the temp directory. To reduce this
amount, see Specifying the JRE Location on page 7.

Installation Directory
At least 35MB free space is required in the TIBCO Hawk installation directory. To
reduce this amount, see Specifying the JRE Location on page 7.

RAM
All platforms require at least 256 MB RAM.

TIBCO Hawk Installation and Configuration


14
| Chapter 3 Installing on Microsoft Windows

Software
The following software is required as indicated on the target machine.

TIBCO Software
TIBCO Rendezvous 6.9 or higher is required, with any available patches. The
TIBCO Hawk installation package includes TIBCO Rendezvous 7.2.
If you have already installed TIBCO Rendezvous software on a network-wide
basis, you will not need additional TIBCO Rendezvous licenses unless you will be
running TIBCO Rendezvous Routing Daemon (RVRD) processes on a particular
machine. In this case, you need a valid RVRD license in the tibrv.tkt file for that
machine.

JRE
TIBCO Hawk requires Java Runtime Environment (JRE) version 1.3.1, 1.3.1_01,
1.3.1_02, or 1.4.1, with any available patches, on the target machine. TIBCO Hawk
does not support Java 1.3.1_03.
The installer asks you during installation to verify that JRE is on the system. If it is
not, you must exit the installer, install JRE, then start TIBCO Hawk installation
again.

If a new version of JRE is installed after installing TIBCO Hawk software, you
must manually set the Java Home Directory value using the Advanced Settings
options of the TIBCO Hawk Configuration Utility. See Java Runtime
Configuration on page 95 for more information.

TIBCO Hawk Installation and Configuration


Installing TIBCO Hawk 15
|

Installing TIBCO Hawk

Before you begin installation, close all open programs. If any errors appear during
installation, consult Appendix B, Troubleshooting, page 159, for possible
solutions.

Installation Media
You can either download the TIBCO Hawk installation package or install the
components from a CD.

Typical and Custom Installation


During installation, you can choose a typical installation or a custom installation.
• A typical install has minimal prompts and installs standard components in
default locations.
• A custom install prompts you to choose which components of the product
suite to install and installs only those components.
The following sections discuss the different modes of installing TIBCO Hawk.

Installation Modes
The installer allows you to install in different modes. Each mode is supported on
all platforms.
• GUI mode allows you to select which components to install, where to install
them, and so on. GUI mode is the installer’s default mode.
• Console mode allows you to run the installer from the command line and
allows you to select which components to install. You can create a response
file or template file using console mode.
• Silent mode installs in console mode without prompting you for input. It
installs using either the default settings or a response file that was saved
during an earlier installation.
You can use any of the following options to install TIBCO Hawk:
• Install Using GUI, page 31
• Install Using Console, page 31
• Install in Silent Mode, page 31

TIBCO Hawk Installation and Configuration


16
| Chapter 3 Installing on Microsoft Windows

• Install and Generate a Response File, page 31


• Install and Generate a Template File, page 32
• Install Using a Response File, page 32
These options and the instructions for installing TIBCO Hawk are provided in the
following sections.

Install Using GUI


GUI mode performs the installation in an interactive graphical interface. The
installer prompts you for values specific to your environment.
To install, doubleclick the icon named TIB_hawk-suite_4.2.1_w32.exe.

Install Using Console


Console mode allows you to install the software from a Windows command
window. The installer prompts you for values. When installing in console mode
you move through the installation process as shown:
• Enter moves forward in the installer.
• 2 returns to the previous screen.
• 3 cancels the installer and exits the installation or uninstallation.
• 4 redisplays the current screen.
To install from a Windows command window, type:
TIB_hawk-suite_4.2.1_w32.exe -is:javaconsole -console

Install in Silent Mode


This mode installs TIBCO Hawk in a Windows command window without
prompting you for any information during installation. It installs TIBCO Hawk
using default values.
To install from a Windows command window, type:
TIB_hawk-suite_4.2.1_w32.exe -silent

Install and Generate a Response File


This installation is performed in a Windows command window. The installer
prompts you for information during installation and saves your answers in a
response file. The response file can be used during subsequent installations to
create another instance using the same values as the original installation, either
with or without prompting for changes.

TIBCO Hawk Installation and Configuration


Installing TIBCO Hawk 17
|

Instructions for using the response file during subsequent installations are given
in Install Using a Response File, below.
To install from a Windows command window, type the following (note there is no
space between -options and -record):
TIB_hawk-suite_4.2.1_w32.exe -is:javaconsole -console
-options-record responseFilepath

Install and Generate a Template File


This installation is performed in a Windows command window. The installer
generates a template file, similar to the response file described above except that
the values you enter during installation are not saved in the file. You can use a text
editor to add those values later, resulting in a response file that can be used in
subsequent installations.
To install from a Windows command window, type the following (note there is no
space between -options and -template):
TIB_hawk-suite_4.2.1_w32.exe -options-template templateFilepath

Install Using a Response File


This installation is performed in a Windows command window using a response
file or an edited template file. Instructions for creating a response file and a template
file are given above.
The response file can be used in silent mode or interactive mode.

Silent Mode In silent mode, you are not prompted during installation. TIBCO Hawk is
installed using the values in the response file.
To install from a Windows command window, type:
TIB_hawk-suite_4.2.1_w32.exe -silent -options responseFilepath

Interactive Mode In interactive mode, you are prompted for values during installation. The values
in the response file are presented as suggested defaults.
• To install from a Windows command window, type:
TIB_hawk-suite_4.2.1_w32.exe -options responseFilepath

TIBCO Hawk Installation and Configuration


18
| Chapter 3 Installing on Microsoft Windows

Post-Installation Tasks

After the installation program has finished, it automatically starts the TIBCO
Hawk configuration utility, described in Chapter 7, Using the Configuration
Utility.
Before using the configuration utility, perform the following post-installation
tasks as noted.

Reboot the System


If you upgraded to TIBCO Rendezvous 7.2.0 during installation, reboot the
system now.

Verify the Installation


To verify the installation, check that all directories and files have been added
correctly. For details, see Appendix C, TIBCO Hawk Directories and Files,
page 167.

Set Disk Counters (Windows 2000 and Windows XP Only)


In Windows 2000, the default is Physical Disk object turned on and the Logical
Disk object turned off. In addition, the logical disk information is in the MMC
under the storage section instead of in performance. As a result, the LogicalDisk
method is not available on Windows 2000 under the HMA performance
microagent.
However, the default Windows 2000 hawk rulebase has a rule that monitors
System Events, and a System Event is posted when the disk gets low. To obtain
this performance counter data for logical drives or storage volumes in Windows
2000:
1. Type diskperf -yv at a command prompt.
2. Press Enter.
3. Reboot the system.
For complete details, see Microsoft article Q253251.

TIBCO Hawk Installation and Configuration


Post-Installation Tasks 19
|

Configure Windows Services Logon Account (Optional)


The TIBCO Hawk software components (TIBCO Hawk agent, HMA, and TIBCO
Hawk Event Service) are installed as Windows services. Windows services run
independently of any logged-on user and, therefore, require a Windows user
account, under which the service can log on and run.
By default, the installation program configures the TIBCO Hawk Windows
services to use the built-in system account. This is the account used by the
majority of Windows services. If you don’t want to use the system account, you
must do the following:
a. Set up the Administrator User Account.
b. Give the Administrative User the "Log On as Service" Privilege.
c. Change the Logon Account for TIBCO Hawk Windows Services.
These instructions follow.

Task A Set up the Administrator User Account


You can use an existing user account or create a new one under which to run the
TIBCO Hawk services. If you want to use an existing account that doesn’t already
have administrator privileges, you must assign administrative privileges to it.
To set up the administrator account, do the following.
1. Choose Start>Programs>Administrative Tools>User Manager.
2. If you are adding administrator privileges to an existing account, skip to
step 3. If you are creating a new user to be the administrator, proceed as
follows:
a. Choose the User>New User menu item. You see the New User dialog.
b. Complete the New User dialog and click OK to return to the User
Manager window. (Refer to the Windows documentation for help on the
fields required by the New User dialog.)
3. In the lower half of the User Manager window, double-click the
Administrators group. You see the Local Group Properties dialog.
4. Click Add to access the Add Users and Groups dialog.
5. Select the desired user account and click Add. The selected user account
appears in the Add Names list in the lower half of the dialog.
6. Click OK to add the user to the group and return to the Group Properties
dialog. The user account is now in the Members list.
7. Click OK to return to the User Manager window.

TIBCO Hawk Installation and Configuration


20
| Chapter 3 Installing on Microsoft Windows

Task B Give the Administrative User the "Log On as Service" Privilege


If your administrator user account doesn’t already have the "Log on as a service"
right, give it this right as follows.
1. In the User Manager window, choose the menu item Policies>User Rights.
You see the User Rights Policy dialog.
2. In the User Rights Policy dialog do the following:
a. Click the Show Advanced User Rights check box.
b. From the drop-down list labeled Right, choose the line Log on as a
service.
c. Click Add. The Add Users and Groups dialog appears.
3. Navigate to the desired user name and select it, as follows:
a. In the List Names From list box, select your machine name, if it is not
selected.
b. In the Names box, select the Administrators group and click Members.
The Local Group Members box appears.
c. Select the desired user account and click Add.
The desired user account appears in the Add Names box at the bottom of the
Add Users and Groups dialog.
4. Click OK to grant the selected user the "Log on as a service" right and return
to the User Rights Policy dialog. The user account you selected now appears
in the Grant To box.
5. Click OK to return to the User Manager window, then choose User>Exit to
leave this window.

Task C Change the Logon Account for TIBCO Hawk Windows Services
Now you must change the logon account for the TIBCO Hawk Windows services
to the selected administrative user account, as follows.
1. Choose Start>Settings>Control Panel and double-click on the Services icon.
You see the Services dialog.
2. Select the desired TIBCO Hawk service from the list and click Startup. You see
the Service dialog.
3. In the Log On As panel, click This Account and enter the desired user account
and password.
4. Click OK to save your action and return to the Services dialog.
5. Repeat from step 2 for each TIBCO Hawk Windows service in the services list.

TIBCO Hawk Installation and Configuration


Post-Installation Tasks 21
|

6. You can now configure processes started by the TIBCO Hawk agent to run in
the foreground. This is optional; if you don’t want to do this, skip to step 7.
a. Select the TIBCO Hawk Agent service from the list and click Startup. You
see the Service dialog.
b. In the Log On As panel, click System Account and Allow Service to
Interact with Desktop enter the desired user account and password.
c. Click OK to save your action and return to the Services dialog.
7. Click Close to exit the Services dialog, then close the Control Panel window.

You must reboot the machine for the TIBCO Hawk service configuration
changes to take effect.

TIBCO Hawk Installation and Configuration


22
| Chapter 3 Installing on Microsoft Windows

TIBCO Hawk Installation and Configuration


| 23

Chapter 4 Installing on UNIX

This chapter explains how to install and uninstall the TIBCO Hawk monitoring
system on computers running the UNIX operating system.

Topics

• Installation Prerequisites, page 24


• Installing TIBCO Hawk on UNIX, page 29
• Installing the TAR File, page 33
• Post-Installation Tasks, page 34
• Starting TIBCO Hawk Components Automatically at System Boot, page 35

TIBCO Hawk Installation and Configuration


24
| Chapter 4 Installing on UNIX

Installation Prerequisites

Read this section before you start installation.

Supported Operating Systems


The following platforms are supported, with patches required as listed.
Make sure that all patches required by other TIBCO products or third-party
software (such as the JRE) are installed before installing TIBCO Hawk.

Table 7 Supported UNIX Platforms (Sheet 1 of 2)

OS Hardware Patches
Solaris 2.6 Sun SPARC None required for TIBCO Hawk.

Solaris 2.7 Sun SPARC (32- and 64-bit) None required for TIBCO Hawk.
Solaris 2.8 Intel (32-bit)
Solaris 2.9

HP-UX 11.x HPPA If using TIBCO Rendezvous: PHNE_26250, ARPA


patch PHNE_20436 (PHNE_17662), and streams
patch PHNE_20008 (PHNE_17794) are required.
For HP-UX 11.00 64 bit systems, HP-UX kernel
patch PHKL_27282 is required.

HP-UX 11.2 IA64 (Itanium) None required for TIBCO Hawk.

AIX 4.3 IBM RS/6000 Apply 5.0.0.4 xlC libraries as indicated by


AIX 5.1
APAR IY14529
AIX 5.2

LINUX 2.2 Intel x86 None required for TIBCO Hawk.


Requires kernel 2.2.14 or later and glibc 2.1 or later.

LINUX 2.4 Intel x86 None required for TIBCO Hawk.


LINUX AS 2.1 Requires kernel 2.4.7 or later and glibc 2.2.4 or later.
LINUX AS 3.0

TIBCO Hawk Installation and Configuration


Installation Prerequisites 25
|

Table 7 Supported UNIX Platforms (Sheet 2 of 2)

OS Hardware Patches (Cont’d)


TRU64 UNIX 4.0 HP Alpha None required for TIBCO Hawk.
TRU64 UNIX 5.x Note: CXXLIB631 Compaq C++ Run-Time Library
(including 5.1A) (libcxx) is required.

Installer Privileges
TIBCO Hawk can be installed by a regular (non-root) user or super-user (root).
If a non-root user installs TIBCO Hawk, change the permissions and ownership of
the tibhawkhma binary to root after installation, as shown:
#> chmod 4555 tibhawkhma
#> chown root:bin tibhawkhma

Different users can install the same product at different locations.


Product dependencies at install time are resolved at user level through the
installation registry maintained at user's home directory. See Installation Registry
and History on page 6 for more information.

TIBCO Hawk HMA Process Runs as root


The TIBCO Hawk HMA process must run as user root to operate correctly. The
installation program, accordingly, creates setuid permissions with root
ownership for the TIBCO Hawk HMA binary.
The HMA only reads system information and cannot perform any actions. It
cannot manipulate, modify, or stop processes.

Disk Space and Memory


During installation, the entire package is extracted into a temporary directory.
Before actually installing the files, the installer calculates the disk space that the
selected components will require in the installation directory. The installer will
proceed only if sufficient free disk space is available in the installation directory.
If some of the required disk space is taken by another process during installation,
the installer may fail and display a failure message.

If the required JRE version is already on your system, significantly less disk space
is required in the temp directory. See Specifying the JRE Location on page 7.

TIBCO Hawk Installation and Configuration


26
| Chapter 4 Installing on UNIX

If your system does not have sufficient free disk space in the temp directory listed
in the table below, you can use a different temp directory by including the
following option when starting the installer, where /new_tmp has sufficient free
disk space:
-is:tempdir /new_tmp

For example, on SUN SPARC Solaris, the command is:


TRA.5.0.0-suite_s4_58.bin -is:tempdir /new_tmp

Table 8 Required Disk Space in the Temp and Installation Directories

Installation
Operating System Temp Directory Free Space Directory
Free Space
Solaris (Sun SPARC and 15 MB in /var/tmp 177 MB
Intel)

HP-UX 85 MB in /var/tmp 635 MB

AIX 20 MB in /tmp 186 MB

LINUX 15 MB in /tmp 177 MB

TRU64 UNIX 65 MB in user’s home directory 177 MB

Home Directory
The user's home directory must at least have 500 KB of free disk space for the
installation registry. See Installation Registry and History on page 6.

RAM
All platforms require at least 256 MB RAM.

Software
The following software is required as indicated.

TIBCO Software
TIBCO Rendezvous 6.9 or higher is required, with any available patches.

TIBCO Hawk Installation and Configuration


Installation Prerequisites 27
|

If you have already installed TIBCO Rendezvous software on a network-wide


basis, you will not need additional TIBCO Rendezvous licenses unless you will be
running TIBCO Rendezvous Routing Daemon (RVRD) processes on a particular
machine. In this case, you need a valid RVRD license in the tibrv.tkt file for that
machine.

GUI Environment (optional)


If you are running the installer in GUI mode, a GUI environment such as CDE
(X Windows) is required. It is not required for a console or silent installation. Also
see DISPLAY Variable Error on page 160.

JRE
TIBCO Hawk requires Java Runtime Environment (JRE) version 1.3.1, 1.3.1_01,
1.3.1_02, or 1.4.1, with any available patches, on the target machine. TIBCO Hawk
does not support Java 1.3.1_03.
JRE is not included with the TIBCO Hawk installation package. The following
table lists web sites where you can download the recommended versions.

Table 9 Recommended JRE Versions and Download Sites

Platform Recommended JRE Download Site


JRE Version
Solarisa (Sun 1.3.1_02 http://java.sun.com/j2se/
SPARC)

Solaris (Intel) 1.3.1_02 http://java.sun.com/j2se/

HP-UX 1.3.1_02 http://www.hp.com/products1/unix/java/

AIX 1.3.1_02 plus JIT http://www.ibm.com/java/jdk/aix/supported/118ga/

LINUX 1.3.1_02 http://java.sun.com/j2se/

TRU64 UNIX 1.3.1_02 http://www.compaq.com/java/download/index.html

a. On Solaris 2.6 and 2.7, it is strongly recommended that the factory-installed JDK 1.1.3 or 1.1.6
(respectively) be removed before you install JRE 1.3.1 to avoid conflicts. To remove the JDK, run pkgrm
SUNWjvjit and pkgrm SUNWjvjrt.

TIBCO Hawk Installation and Configuration


28
| Chapter 4 Installing on UNIX

Default File Descriptor Setting (Solaris 2.6 and 2.7 Only)


Solaris 2.8 comes with a default file descriptor setting of 1024, which allows
efficient use of threads within the TIBCO Hawk agent. However, previous
releases of Solaris have a default file descriptor setting of 64. This should be
increased to at least 256, and ideally to 1024.
To increase the default file descriptor in Solaris releases prior to 2.8:
1. As the root user, navigate to /usr/bin/sh.
2. Run ulimit - n 256 (or whatever number is desired) to increase the setting.

Reconfigure Two-Button Mouse Devices (Solaris Only)


Solaris systems using a two-button mouse must be configured with the
three-button mouse setting. Configure the two-button mouse as follows:
1. Log in as superuser (root).
2. From the command-line prompt, enter kdmconfig and select Built in PS/2
[3 button mouse].

3. Reboot the system.

Set Environment Variable (Compaq Tru64 UNIX Only)


Installation on Compaq Tru64 UNIX requires a POSIX-compliant Bourne Shell.
Before you start TIBCO Hawk installation, set the BIN_SH environment variable
as follows:
BIN_SH=xpg4; export BIN_SH // Bourne shell
setenv BIN_SH xpg4 // C-shell

If BIN_SH is not set properly, the TIBCO Hawk installer will abort with the
following error:
^D@AA: is not an identifier.

TIBCO Hawk Installation and Configuration


Installing TIBCO Hawk on UNIX 29
|

Installing TIBCO Hawk on UNIX

Before you begin installation, close all open applications. If any errors appear
during installation, consult Appendix B, Troubleshooting, for possible solutions.
On HP-UX, if you are upgrading to TIBCO Rendezvous 7.2.0, stop all TIBCO
Rendezvous processes before installing TIBCO Hawk.

Installation Packages
The following table lists the platform-specific installation packages. Copy the
appropriate tar file from the download site or the CD and unpack it on your
system.

Table 10 UNIX Installation tar Package Filenames

OS tar Package Filename


Solaris 2.6 (Sun SPARC) TIB_hawk-suite_4.2.1_s4_56.tar

Solaris 2.7 (Sun SPARC) TIB_hawk-suite_4.2.1_s4_57.tar

Solaris 2.8 (Sun SPARC) TIB_hawk-suite_4.2.1_s4_58.tar

Solaris 2.9 (Sun SPARC) TIB_hawk-suite_4.2.1_s4_58.tar

Solaris 2.7 (Intel) TIB_hawk-suite_4.2.1_i86_57.tar

HP-UX 11.0, HP-UX 11i TIB_hawk-suite_4.2.1_h7_110.tar

HP-UX IA64 TIB_hawk-suite_4.2.1_h7_ia64.tar

AIX 4.3
TIB_hawk-suite_4.2.1_rs_43.tar
AIX 5.1

AIX 5.2

TRU64 UNIX 4.0


TIB_hawk-suite_4.2.1_alpha_40.tar
TRU64 UNIX 5.x (including 5.1A)

LINUX 2.2 TIB_hawk-suite_4.2.1_lnx86_20.tar

TIBCO Hawk Installation and Configuration


30
| Chapter 4 Installing on UNIX

Table 10 UNIX Installation tar Package Filenames

OS tar Package Filename


LINUX 2.4 TIB_hawk-suite_4.2.1_lnx86_24.tar

LINUX Advanced Server 2.1


LINUX Advanced Server 3.0

Typical and Custom Installation


During installation, you can choose a typical installation or a custom installation.
• A typical install has minimal prompts and installs standard components in
default locations.
• A custom install prompts you to choose which components of the product
suite to install and installs only those components.
The following sections discuss the different modes of installing TIBCO Hawk.

Installation Modes
The installer allows you to install in different modes. Each mode is supported on
all platforms.
• GUI mode allows you to select which components to install, where to install
them, and so on. GUI mode is the installer’s default mode.
• Console mode allows you to run the installer from the command line and
allows you to select which components to install. You can create a response
file or template file using console mode.
• Silent mode installs in console mode without prompting you for input. It
installs using either the default settings or a response file that was saved
during an earlier installation.
You can use any of the following options to install TIBCO Hawk:
• Install Using GUI, page 31
• Install Using Console, page 31
• Install in Silent Mode, page 31
• Install and Generate a Response File, page 31
• Install and Generate a Template File, page 32
• Install Using a Response File, page 32

TIBCO Hawk Installation and Configuration


Installing TIBCO Hawk on UNIX 31
|

These options and the instructions for installing TIBCO Hawk are provided in the
following sections. The following examples use the installation package for SUN
SPARC Solaris 2.6.

Install Using GUI


GUI mode performs the installation in an interactive graphical interface. The
installer prompts you for values specific to your environment.
To install, doubleclick the icon TIB_hawk-simple_4.2.1_s4_56.bin.

Install Using Console


Console mode allows you to install the software from a UNIX terminal window.
The installer prompts you for values. When installing in console mode you move
through the installation process as shown:
• Enter moves forward in the installer.
• 2 returns to the previous screen.
• 3 cancels the installer and exits the installation or uninstallation.
• 4 redisplays the current screen.
To install from a UNIX terminal window, type:
TIB_hawk-simple_4.2.1_s4_56.bin -is:javaconsole -console

Install in Silent Mode


This mode installs TIBCO Hawk in a UNIX terminal window without prompting
you for any information during installation. It installs TIBCO Hawk using default
values.
To install from a UNIX terminal window, type:
TIB_hawk-simple_4.2.1_s4_56.bin -silent

Install and Generate a Response File


This installation is performed in a UNIX terminal window. The installer prompts
you for information during installation and saves your answers in a response file.
The response file can be used during subsequent installations to create another
instance using the same values as the original installation, either with or without
prompting for changes.
Instructions for using the response file during subsequent installations are given
in Install Using a Response File, below.

TIBCO Hawk Installation and Configuration


32
| Chapter 4 Installing on UNIX

To install from a UNIX terminal window, type the following (note there is no
space between -options and -record):
TIB_hawk-simple_4.2.1_s4_56.bin -options-record responseFilepath

Install and Generate a Template File


This installation is performed in a UNIX terminal window. The installer generates
a template file, similar to the response file described above except that the values
you enter during installation are not saved in the file. You can use a text editor to
add those values later, resulting in a response file that can be used in subsequent
installations.
To install from a UNIX terminal window, type the following (note there is no
space between -options and -template):
TIB_hawk-simple_4.2.1_s4_56.bin -options-template templateFilepath

Install Using a Response File


This installation is performed in a UNIX terminal window using a response file or
an edited template file. Instructions for creating a response file and a template file are
given above.
The response file can be used in silent mode or interactive mode.

Silent Mode In silent mode, you are not prompted during installation. TIBCO Hawk is
installed using the values in the response file.
To install from a UNIX terminal window, type:
TIB_hawk-simple_4.2.1_s4_56.bin -silent -options responseFilepath

Interactive Mode In interactive mode, you are prompted for values during installation. The values
in the response file are presented as suggested defaults.
To install from a UNIX terminal window, type:
TIB_hawk-simple_4.2.1_s4_56.bin -options responseFilepath

TIBCO Hawk Installation and Configuration


Installing the TAR File 33
|

Installing the TAR File

A tar image is provided as an alternative method of installing TIBCO Hawk on


UNIX platforms. This installation should only be performed by advanced users.

When TIBCO Hawk is installed using this method, an entry for it is not placed in
the installation registry. Other TIBCO products (such as TIBCO Runtime Agent
5.x and TIBCO Administrator 5.x) that depend on Hawk 4.2.1 will not be able to
recognize or locate this TIBCO Hawk installation, and installation of those
products may fail.
To successfully install these TIBCO products on this machine, you must install the
TIBCO Hawk 4.2.1 Lite product (agent only) included with TRA 5.1.0 when you
install TRA 5.1.0. Subsequent TIBCO product installations will detect the presence
of TIBCO Hawk Lite and will complete successfully.

When you install TIBCO Hawk using this method, product documentation is not
installed on the system. You can view the documentation on the product CDROM
in the doc folder at root level or obtain it from the product download site.

The tar image is placed on your system when you unpack the tar file on your
system as described in Installation Packages on page 29.
The following procedure describes how to install TIBCO Hawk using the tar
image.
1. As root user, navigate to the directory that will be HAWK_ROOT.
2. Unpack the tar file in that directory. For example, the following command
unpacks the tar image for SUN SPARC Solaris 2.6:
#> tar -xvf download_directory/TIB_hawk_4.2.1_s4_56.tar

3. After installation, cd to hawkroot/bin and check that the tibhawkhma binary


is setuid and is owned by the root user, as shown:
#> ls -l tibhawkhma
#> -r-sr-xr-x 1 root bin 263320 Oct 30 17:03 tibhawkhma

If it is not, use the following commands to modify it:


#> chmod 4555 tibhawkhma
#> chown root:bin tibhawkhma

TIBCO Hawk Installation and Configuration


34
| Chapter 4 Installing on UNIX

Post-Installation Tasks

After installing TIBCO Hawk on UNIX, the root user must perform the following
post-installation tasks as noted.

Task A Verify the Installation


Check that all directories and files have been added correctly. For details, see
TIBCO Hawk Directories and Files, page 167.

Task B Modify Permission for tibhawkhma


Modify the permissions of the TIBCO Hawk HMA (tibhawkhma) as shown:
cd $TIBCO_HAWK_HOME/bin/tibhawkhma
chown root tibhawkhma
chmod g+s tibhawkhma

On the TRU64 UNIX platform, execute the following command before starting
any TIBCO Hawk component:
ln -s <RV_HOME>/libtibrvj.so <RV_HOME>/libtibrvj64.so

Where <RV_HOME> is your TIBCO Rendezvous installation directory.

TIBCO Hawk Installation and Configuration


Starting TIBCO Hawk Components Automatically at System Boot 35
|

Starting TIBCO Hawk Components Automatically at System Boot

The TIBCO Hawk agent and TIBCO Hawk HMA components can be configured
to start automatically during the system boot cycle. A sample autostart script,
Hawk2, is provided in the $HAWK_ROOT/samples/etc directory. It invokes the
starthma and startagent scripts during the boot cycle. You can modify this
script for your environment. It can be used on all supported UNIX platforms.
The following sections list the steps involved in starting TIBCO Hawk
components automatically at system boot. Refer to the correct section for your
operating system.
• Solaris Instructions on page 35
• HP-UX Instructions on page 36
• AIX Instructions on page 36
• TRU64 Instructions on page 37
• LINUX Instructions on page 37

Solaris Instructions
This section describes how to start TIBCO Hawk components automatically at
system boot on a SUN SPARC Solaris or Intel Solaris operating system.
1. Open the file $HAWK_ROOT/samples/etc/hawk2 in an editor and make the
following changes.
Edit the line: HAWK_ROOT=/usr/tibco/hawk to reflect your TIBCO Hawk
installation directory.
Edit the line: RV_ROOT=/usr/tibco/tibrv to reflect your TIBCO Rendezvous
installation directory.
Edit the line JRE_ROOT=usr/tibco/java to reflect your Java installation
directory.
2. Copy the hawk2 file as follows:
cp $HAWK_ROOT/samples/etc/hawk2 /etc/init.d/hawk2

3. Create a link as follows:


ln -s /etc/init.d/hawk2 /etc/rc2.d/S99hawk

TIBCO Hawk Installation and Configuration


36
| Chapter 4 Installing on UNIX

HP-UX Instructions
This section describes how to start TIBCO Hawk components automatically at
system boot on an HP operating system.
1. Open the file $HAWK_ROOT/samples/etc/hawk2 in an editor and make the
following changes.
Edit the line: HAWK_ROOT=/usr/tibco/hawk to reflect your TIBCO Hawk
installation directory.
Edit the line: RV_ROOT=/usr/tibco/tibrv to reflect your TIBCO
Rendezvous installation directory.
Edit the line JRE_ROOT= /usr/tibco/java to reflect your Java installation
directory.
2. Copy the hawk2 file as follows:
cp $HAWK_ROOT/samples/etc/hawk2 /etc/init.d/hawk2

3. Create a link as follows:


ln -s /etc/init.d/hawk2 /etc/rc2.d/Sxxxhawk

where xxx is an integer, dependent upon your system startup parameters.

AIX Instructions
This section describes how to start TIBCO Hawk components automatically at
system boot on an IBM operating system.
1. Open the file $HAWK_ROOT/samples/etc/hawk2 in an editor and make the
following changes.
Edit the line: HAWK_ROOT=/usr/tibco/hawk to reflect your TIBCO Hawk
installation directory.
Edit the line: RV_ROOT=/usr/tibco/tibrv to reflect your TIBCO
Rendezvous installation directory.
Edit the line JRE_ROOT= usr/tibco/java to reflect your Java installation
directory.
2. Add an entry to the /etc/inittab file as follows:
# hawk:2:once:<HAWK_ROOT>/samples/etc/hawk2 -start
>/dev/console 2>&1

TIBCO Hawk Installation and Configuration


Starting TIBCO Hawk Components Automatically at System Boot 37
|

TRU64 Instructions
This section describes how to start TIBCO Hawk components automatically at
system boot on a TRU64 operating system.
1. Open the file $HAWK_ROOT/samples/etc/hawk2 in an editor and make the
following changes.
Edit the line: HAWK_ROOT=/usr/tibco/hawk to reflect your TIBCO Hawk
installation directory.
Edit the line: RV_ROOT=/usr/tibco/tibrv to reflect your TIBCO
Rendezvous installation directory.
Edit the line JRE_ROOT= usr/tibco/java to reflect your Java installation
directory.
2. Copy the hawk2 file as follows:
cp $HAWK_ROOT/samples/etc/hawk2 /sbin/init.d/hawk2

3. Create a link as follows:


ln -s /sbin/init.d/hawk2 /sbin/rc2.d/Sxxhawk

where xx is an integer, dependent upon your system startup parameters

LINUX Instructions
This section describes how to start TIBCO Hawk components automatically at
system boot on a LINUX operating system.
1. Open the file $HAWK_ROOT/samples/etc/hawk2 in an editor and make the
following changes.
Edit the line: HAWK_ROOT=/usr/tibco/hawk to reflect your TIBCO Hawk
installation directory.
Edit the line: RV_ROOT=/usr/rv. to reflect your TIBCO Rendezvous
installation directory.
Edit the line JRE_ROOT= to reflect your Java installation directory.
2. Copy the hawk2 file as follows:
cp $HAWK_ROOT/samples/etc/hawk2 /etc/init.d/hawk2

3. Create a link as follows:


ln -s /etc/init.d/hawk2 /etc/rc2.d/S98hawk

TIBCO Hawk Installation and Configuration


38
| Chapter 4 Installing on UNIX

TIBCO Hawk Installation and Configuration


| 39

Chapter 5 Installing on OS/400

This chapter explains how to install the TIBCO Hawk monitoring system on
computers running the OS/400 operating system.

Topics

• Installation Prerequisites, page 40


• Installing TIBCO Hawk on OS/400, page 41
• Post-Installation Tasks, page 42
• Starting TIBCO Hawk Components, page 43

TIBCO Hawk Installation and Configuration


40
| Chapter 5 Installing on OS/400

Installation Prerequisites

Read this section before you start installation.

Supported Operating Systems


TIBCO Hawk supports OS/400 version V5R1M0 or higher

Software
The following software is required as indicated.

TIBCO Software
TIBCO Rendezvous 6.9 or higher is required, with any available patches.
If you have already installed TIBCO Rendezvous software on a network-wide
basis, you will not need additional TIBCO Rendezvous licenses unless you will be
running TIBCO Rendezvous Routing Daemon (RVRD) processes on a particular
machine. In this case, you need a valid RVRD license in the tibrv.tkt file for that
machine.

JRE
TIBCO Hawk requires Java Runtime Environment (JRE) version 1.3.1, 1.3.1_01,
1.3.1_02, or 1.4.1, with any available patches, on the target machine. TIBCO Hawk
does not support Java 1.3.1_03.
JRE is not included with the TIBCO Hawk installation package.

TIBCO Hawk Installation and Configuration


Installing TIBCO Hawk on OS/400 41
|

Installing TIBCO Hawk on OS/400

To install the software, follow these steps:


1. Login as QSCECOFR.
2. Create a library TIBHAWK and another library in which you will store the
installation SAVE files.
CRTLIB TIBHAWK

CRTLIB <libname>
3. Create SAVE files TIBHAWKSF and TIBHAWKSFL within the library <libname>.
Use the command CRTSAVF to do this.
4. Unzip the distribution archive on a Microsoft Windows system.
5. Copy the TIBHAWKSF and TIBHAWKSFL files from the Microsoft Windows
system to the SAVE files you created in step 2 on your OS/400 system. You
can use FTP or other mechanisms to do so.
6. Perform the installation using the command RSTOBJ as follows:
RSTOBJ OBJ(*ALL) SAVLIB(TIBHAWK) DEV(*SAVF)
SAVF(<libname>/TIBHAWKSF)

Where <libname> is the library where you created the SAVE files in step 2.
7. After RSTOBJ is complete, perform the following steps.
a. Create a directory for TIBCO Hawk in /usr (if it doesn't exist already).
CRTDIR ('/usr/tibco/hawk')

b. Restore the file containing the java files and the IFS file structure RST
DEV('/qsys.lib/<libname>.lib/TIBHAWKSFL.file')
OBJ(('/usr/tibco/hawk/*'))

This command restores TIBCO Hawk components to the directory


/usr/tibco/hawk in the Integrated File System.

TIBCO Hawk Installation and Configuration


42
| Chapter 5 Installing on OS/400

Post-Installation Tasks

After installing TIBCO Hawk on OS/400, the user must perform the following
post-installation tasks as noted.
1. To use TIBCO Hawk components, you must turn on multi-threading. To turn
on multi-threading, choose from one of these options:
— To run the components as jobs, enable the job descriptions for multiple
threads.
— To use qsh to run Hawk components you set the environment variable
QIBM_MULTI_THREADED to Y before you start qsh. If you do not set this
variable, the TIBCO Hawk components will not run reliably.
— To set the variable permanently, you can create a CL program that is run
when a user logs in, by setting INLPGM parameter in the user profile, that
sets the environment variable QIBM_MULTI_THREADED.
For example:
PGM /* start it */
ADDENVVAR ENVVAR(QIBM_MULTI_THREADED) VALUE(Y)
ENDPGM

If you do this manually when you log in, it persists until you log out.
2. When submitting jobs using SBMJOB, make sure that the ALWMLTTHD
parameter is set to (*YES)

TIBCO Hawk Installation and Configuration


Starting TIBCO Hawk Components 43
|

Starting TIBCO Hawk Components

• TIBCO Hawk Microagent


To start the TIBCO Hawk Microagent (HMA) from the command prompt use
the SBMJOB command.
For example, to start the TIBCO Hawk Microagent submit the job as follows:
SBMJOB CMD(CALL PGM(TIBHAWK/TIBHKHMA) PARM('-rvd_session' '7474'
'' 'tcp:7474')) JOBQ(QUSRNOMAX) MSGQ(*USRPRF) ALWMLTTHD(*YES)

If you are uncertain whether your job description has multi-threading enabled
set ALWMLTHTHD to *YES. Without multi-thread support set in the job
description, the sample program will not start.
• TIBCO Hawk Agent
You can start TIBCO Hawk Agent in the following ways:
— Start TIBCO Hawk Agent from the native system using the following
command:
call tibhawk/tibhawktmp

— Execute the startagent script from qshell. This script is located in the
$HAWK_ROOT/bin directory.

The default codepage use for reading output from the TIBCO Hawk methods
Custom::ExecuteForString and Custom::ExecuteForNumber is Cp037. You can
override this default value by This default can be overrided by specifying the
codepage in the Java property customMA.codepage.
For example, to change the code page to Cp500, add the following line
-DcustomMA.codepage="Cp500"

before specifying the classpath in the startagent script.

TIBCO Hawk Installation and Configuration


44
| Chapter 5 Installing on OS/400

TIBCO Hawk Installation and Configuration


| 45

Chapter 6 Configuring TIBCO Hawk Software

This chapter describes how to edit the configuration files for the TIBCO Hawk
Display, Agent, HMA and Event Service components on Microsoft Windows and
UNIX platforms. It also describes how to use the startup scripts, create a TIBCO
Hawk domain, and create a TIBCO Rendezvous session.
On Microsoft Windows platforms, you can alternatively use a GUI interface to
configure TIBCO Hawk General, Display, Agent, and Event Service components.
This is described in Chapter 7, Using the Configuration Utility.

Topics

• Startup Scripts and Configuration Files, page 46


• TIBCO Hawk Display Configuration File (hawkdisplay.cfg), page 48
• TIBCO Hawk Agent Configuration File (hawkagent.cfg), page 52
• TIBCO Hawk HMA Configuration File (hawkhma.cfg), page 64
• TIBCO Hawk Event Service Configuration File (hawkevent.cfg), page 67
• Creating a TIBCO Hawk Domain, page 83
• Creating a TIBCO Rendezvous Session, page 84

TIBCO Hawk Installation and Configuration


46
| Chapter 6 Configuring TIBCO Hawk Software

Startup Scripts and Configuration Files

Please read this chapter and determine your system’s particular configuration
and setup requirements before changing any values.
A set of startup scripts and configuration files is provided with the TIBCO Hawk
software. A startup script and default configuration file are supplied for each
component. The configuration files and options are described in the next sections.

Table 11 TIBCO Hawk Components, Startup Scripts, and Configuration Files

Described
Component Startup Script Configuration File
on Page
TIBCO Hawk Display startdisplay hawkdisplay.cfg 48

TIBCO Hawk Agent startagent hawkagent.cfg 52

TIBCO Hawk HMA starthma hawkhma.cfg 64

TIBCO Hawk Event startevent hawkevent.cfg 67


Service

Startup scripts and configuration files are located in <TIBCO Hawk installation
directory>/bin.

The startup scripts take a single command line option of -file, followed by the
filename of the absolute path to the .cfg file. You can create and name your own
configuration files, modelling them on the default supplied.
This chapter describes the command line options you can use in the configuration
files. If no command line options are specified, the startup scripts use the supplied
default values in the configuration files (as shipped) by default.

On UNIX, if the startagent script is run using arguments for a predefined file,
the script does not recognize special characters such as quotation marks ( " ).
Special characters must be escaped with a backslash ( \ ).

Replacing Relative Paths with Absolute Paths


As shipped, the configuration files use relative paths, where <TIBCO Hawk
installation directory> is the starting point (also known as the reference directory).
This ensures that the scripts will work as shipped. For example, the file
hawkagent.cfg has the following default value:
-M LogService
-log_dir ./log

TIBCO Hawk Installation and Configuration


Startup Scripts and Configuration Files 47
|

This instructs the system to create the log directory under <TIBCO Hawk installation
directory>. In other words, ./log expands to <TIBCO Hawk installation directory>/log.

After installation, when executing the scripts to start either the agent, TIBCO
Hawk Display or the HMA, you must customize the configuration files to specify
the absolute path to the .cfg file for your environment, as shown here:
startagent -file ./hawkagent.cfg

TIBCO Hawk Installation and Configuration


48
| Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk Display Configuration File (hawkdisplay.cfg)

The options in the hawkdisplay.cfg configuration file are used to configure the
following functions related to TIBCO Hawk Display. The functions and options
are described in the next sections.

Table 12 hawkdisplay.cfg Functions and Options


Function Options
TIBCO Hawk Domain -hawk_domain <TIBCO Hawk domain name>

TIBCO Rendezvous (RVD) -rvd_session <service> <network> <daemon>


Session

Character Encoding -character_encoding <character encoding string>

Logging Information -logdir <directory for display logs>


-logmaxsize <maximum size of single display log>

-logmaxnum <maximum number of display logs>

-log_format <Hawk or ActiveEnterprise format>

Display File -display_file <directory for display files>

Security Policy -security_policy <class implementing security>

Variables -variables <External variables property file>

TIBCO Hawk Domain


-hawk_domain <TIBCO Hawk domain name>
Separate domains create independent TIBCO Hawk systems. Agents and the
display must share the same Hawk Domain name in order to communicate. The
default is to monitor an entire network as one group. To use the default, omit the
-hawk_domain option. See Creating a TIBCO Hawk Domain, page 83, for more
details.

TIBCO Rendezvous (RVD) Session


-rvd_session <service> <network> <daemon>

TIBCO Hawk Installation and Configuration


TIBCO Hawk Display Configuration File (hawkdisplay.cfg) 49
|

Because the TIBCO Hawk software uses the functionality of the TIBCO
Rendezvous system, it must connect to a TIBCO Rendezvous daemon by creating
a session.
If TIBCO Rendezvous is only used on one network and no special TIBCO
Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session
default values. To use the default TIBCO Hawk session parameters, omit the
-rvd_session command-line options.

If you use this option, all three parameters must be present and separated by
white space. Use a semicolon (;) to indicate a null value, or use an empty string,
for example:
-rvd_session 7474 "" tcp:7474

See Creating a TIBCO Rendezvous Session, page 84, for more details.

Character Encoding
-character_encoding <character encoding string>
Specifies the character encoding to be used for strings sent over all TIBCO
Rendezvous transports.

Logging Information
-logdir <directory for display logs>
-logmaxsize <maximum size of single display log>

-logmaxnum <maximum number of display logs>


-log_format <Hawk or ActiveEnterprise format>
The TIBCO Hawk system creates rolling log files for display events
(display.log) in the directory named in the -log_dir option. When one file has
reached the size specified in the -logmaxsize option, it is closed and renamed,
and a new log file with the same name is started. When the number of log files
exceeds the number set in the -logmaxsize option, log entries roll over to reuse
the oldest log file.
By default, the unit of measure for -logmaxsize is kilobytes and the default size
is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M
specifies ten megabytes. Note that the maximum log file size is 2097151 kilobytes.
You can enter at minimum 5 and at maximum 999 as a value for -logmaxnum. If,
for example, you have configured a maximum of five log files, log files roll over
until there are five files (named file1, file2… file5). At this point, the next
rollover eliminates file5 and renames file4 to file5, thus maintaining a total
of five rollover files. The log thus retains the latest log information and discards
the oldest.

TIBCO Hawk Installation and Configuration


50
| Chapter 6 Configuring TIBCO Hawk Software

The -log_format option allow you to select the format of log file entries. Either
the existing Hawk format or the ActiveEnterprise format can be specified.

Display File
-display_file <display file path and name>
Specify the location of a display file to be loaded automatically. To use the default,
omit this option.

Security Policy
-security_policy <class implementing security>

Because security needs vary greatly, the TIBCO Hawk system provides a
mechanism by which you can develop your own security policy plug-in. To create
a security policy, you must write a Java class that implements a security policy
specific to your needs. For more information on creating a security policy class,
see the TIBCO Hawk Programmer’s Guide.
For more information on the Trusted and Certified security policies that come
with TIBCO Hawk software, see Chapter 10 on page 131.
Depending on your security needs, complete the -security_policy option as
follows.
• If you are not using a security policy, omit this option.
• To use a specific security policy, on each machine where you want to use the
policy, specify the name of the security policy class. Do not enter the file
extension. For example, if your Java class file is named
ASecurityPolicy.class you would specify ASecurityPolicy.

• To use the TIBCO Hawk Trusted Security Policy, use:


COM.TIBCO.hawk.security.trusted.Trusted

or
COM.TIBCO.hawk.security.trusted.TrustedWithDomain

• To use the TIBCO Hawk Certified Security Policy, use:


COM.TIBCO.hawk.security.certified.Certified

Variables
-variables <External variables property file>

Use the Variables option to specify a variables file. The variables file can pass data
to define external variables to be used in either host or tool menu commands.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Display Configuration File (hawkdisplay.cfg) 51
|

On UNIX systems, the env command outputs environment values in the correct
format. However, in Windows, the following restrictions apply to external
variables:
• The variables file to support External variables in the agent must conform to
the Java properties file format.
• Variables and variable names cannot include spaces or any of the following
characters: equals sign (=), period (.), or forward slash(\).
• Any special characters must be escaped to be evaluated properly.
For example, to use a variable for c:\tibco\hawk, you would specify in the file:
HAWK_ROOT=c:\\tibco\\hawk. Also, due to the Java file path separator format,
HAWK_ROOT=c:/tibco/hawk will also work properly on the Windows platform.

TIBCO Hawk Installation and Configuration


52
| Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk Agent Configuration File (hawkagent.cfg)

The options in the hawkagent.cfg configuration file relate to agent functionality.


The agent command line options are organized in a modular fashion. Each section
of the file begins with -M followed by the module name, such as -M Self. Within
each modular section are command line options relating to the function of the
module.
The command line options within each module of the TIBCO Hawk agent
configuration file are described in the next sections.

Table 13 hawkagent.cfg Modules and Options

Module Name Options Page


-M Self -cluster <cluster name> 54
-agent_name <agent name>

-agent_domain <agent domain name>

-hawk_domain <TIBCO Hawk domain name>


-rvd_session <service> <network> <daemon>

-character_encoding <character encoding string>


-hma_plugin_dir <directory>
-file <configuration file>

-M RuleBaseEngine -rulebases <rulebase> <rulebase> ... 56


-config_path <list of directories to use as configuration sources>
-auto_config_dir <directory to autoload rulebases at startup>

-repository_path <list of repositories to use as configuration sources>

-repository_cache_dir <repository cache directory>

-variables <property file>

-M AMIService -ami_rvd_session <service> <network> <daemon> 60


-ami_rvds_session <service> <network> <daemon>

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration File (hawkagent.cfg) 53
|

Table 13 hawkagent.cfg Modules and Options

Module Name (Cont’d) Options Page


-M LogService -log_dir <directory to store TIBCO Hawk logs> 61
-log_max_size <maximum size of one TIBCO Hawk log>

-log_max_num <maximum number of TIBCO Hawk logs>

-log_format <Hawk or ActiveEnterprise format>

-M TIBProtocolAdapter -interval <heartbeat interval in seconds> 62


-security_policy <class that implements security>

-M Repository -repository_name <repository name> 63


-repository_dir <repository directory>

-M LogfileMicroAgent -scan_rate <rate in seconds> 63


-block_size < size in kilobytes>
-eval_rate <rate in seconds>

TIBCO Hawk Installation and Configuration


54
| Chapter 6 Configuring TIBCO Hawk Software

-M Self
This module of the agent configuration file deals with the following command
line options which relate to the agent itself:

Table 14 -M Self Options

Option Description
-cluster <cluster name> The name of the container in which this agent will appear in the
display by default. The display will create the container if it does
not already exist. Allows for grouping of multiple agents.
The default name for the container is the IP subnet address. The
cluster name must be enclosed within quotes, if the name
contains spaces.

-agent_name <agent name> The agent name as it appears in the TIBCO Hawk Display. The
default name for the TIBCO Hawk agent is the host name of the
computer on which it is installed.
Each agent being managed must have a unique combination of
agent_name, agent_domain, and hawk_domain values.

To use the host name as the agent name, omit this option. To use a
different name, specify a name as desired.

-agent_domain <agent domain Sets the agent domain name. The default value is "none". Each
name> agent being managed must have a unique combination of
agent_name, agent_domain, and hawk_domain values.

An agent domain must be specified when two computers within


the same TIBCO Hawk domain have the same name but reside in
different network domains. For example, you might specify this
option as: -agent_domain pa.tibco.com.

-hawk_domain <TIBCO Hawk Sets the hawk domain name. The agents and the display must
domain name> have the same hawk domain value in order to communicate. Each
agent being managed must have a unique combination of
agent_name, agent_domain, and hawk_domain values.

Separate domains create independent TIBCO Hawk systems.


Agents and the display must share the same Hawk Domain name
in order to communicate. The default is to monitor an entire
network as one group. To use the default, omit the -hawk_domain
option. See Creating a TIBCO Hawk Domain, page 83, for more
details.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration File (hawkagent.cfg) 55
|

Table 14 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-rvd_session <service> Specifies the primary TIBCO Rendezvous transport used by the
<network> <daemon> agent. Because the TIBCO Hawk software uses the functionality
of the TIBCO Rendezvous system, it must connect to a TIBCO
Rendezvous daemon by creating a session.
If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, use the TIBCO
Rendezvous daemon session default values. To use the default
TIBCO Hawk session parameters, omit the -rvd_session
command-line options.
If you use this option, all three parameters must be present and
separated by white space. Use an empty string to indicate a null
value, for example:
-rvd _session 7474 "" tcp:7474

See Creating a TIBCO Rendezvous Session, page 84, for more


details.

-character_encoding Specifies the character encoding to be used for strings sent over
<character encoding string> all TIBCO Rendezvous transports.

-hma_plugin_dir <directory> Specifies the directory the TIBCO Hawk Agent should search
when loading microagent plug-ins.

-file <configuration file> Read more command line arguments from a config file. The
contents of the file have the same syntax and semantics as
command lines. Multiple lines are permitted. All characters from
# to the end of a line are treated as a comment. This option is not
allowed in a config file. You may supply no more than one -file
parameter.

TIBCO Hawk Installation and Configuration


56
| Chapter 6 Configuring TIBCO Hawk Software

-M RuleBaseEngine
This module of the agent configuration file deals with the following command
line options which relate to the rulebases used by this agent.

If you are using the rulebase map, you usually do not need to list any rulebases in
the -rulebases option. Using both a rulebase map and the -rulebases option
increases the complexity of managing your monitoring configuration.
The -rulebases option is provided to maintain backward compatibility with
previous versions of TIBCO Hawk that do not contain the rulebase map feature.

Three mutually-exclusive configuration modes are available for determining


which configuration objects to use. Combining these options to implement each
configuration mode is discussed in the following sections:
• Automatic Configuration Mode on page 57
• Manual Configuration Mode on page 58
• Repository Configuration Mode on page 59

Table 15 -M RuleBaseEngine Options

Option Description
-rulebases <rulebase> Typically used only if rulebase map is not being used
<rulebase> ...
If manual or repository configuration mode is used, specify a list of
rulebases to be loaded at startup.
If -rulebases option is used, you must omit the -auto_config_dir
option and use either manual configuration mode or repository
configuration mode options.

-config_path <list of If manual configuration mode is used, specify the path to be searched
directories to use as for configuration objects. The delimiter for path entries is a colon (:).
configuration sources> The default used if this option is omitted is the current working
directory.
If -config_path is used, omit the -auto_config_dir,
-repository_path, and -repository_cache_dir options.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration File (hawkagent.cfg) 57
|
Table 15 -M RuleBaseEngine Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-auto_config_dir If this option is present, the agent will run in automatic configuration
<directory to autoload rulebases mode.
at startup>
Specify the directory from which rulebase and schedule configuration
objects will be loaded at startup. The default directory, <TIBCO Hawk
installation directory>/autoconfig, is used if a value is omitted.

If you use automatic configuration, omit the following options:


-config_path, -repository_path, -repository_cache_dir,
-rulebases

-repository_path <list of If repository configuration mode is used, specify the path to be


repositories to use as searched for repositories. The delimiter for path entries is a colon (:).
configuration sources> The default used if this option is omitted is the current working
directory.
If -repository_path is used, omit the -auto_config_dir and
-config_path options.

-repository_cache_dir If repository configuration mode is used, all configuration objects


<repository cache directory> loaded from the repository may be cached in a local directory,
specified in this option. This cache is used in the event of a repository
failure, and also to minimize network traffic.
If -repository_cache_dir is used, omit the -auto_config_dir and
-config_path options.

-variables <property file> Use this option to specify a variables file. The variables file can pass
data to define external variables to be passed to rules for use in
rulebase configurations.

Automatic Configuration Mode


This section explains how you use the -M RuleBaseEngine options to implement
an Automatic Configuration mode. This is one of three mutually-exclusive modes
available for determining which configuration objects to use. The other two
modes are Manual Configuration and Repository Information, both of which are
types of manual configuration mode.
To use Automatic configuration, specify the -auto_config_dir option.
When Automatic Configuration mode is used, all load-by-reference rulebase
loading mechanisms are disabled. Therefore, you will omit the following options:
-rulebases

TIBCO Hawk Installation and Configuration


58
| Chapter 6 Configuring TIBCO Hawk Software

-config_path
-repository_path
-repository_cache_dir

In addition, the RuleBaseInclude feature, rulebase maps, and the


RuleBaseEngine:loadRuleBase() microagent method are not used. However,
the microagent method RuleBaseEngine:loadRuleBaseFromFile() is allowed.
See the TIBCO Hawk Administrator’s Guide and the TIBCO Hawk Methods Reference
for more on these features and microagent methods.
With automatic configuration, the agent will load the Schedule configuration file
and all rulebase configuration files from the automatic configuration directory at
startup. The only other mechanism by which an agent can load a rulebase after
this point is through invocation of RuleBaseEngine:loadRuleBaseFromFile()
using fully qualified filenames, or by using SendTo from the Display.
When a rulebase is sent to an agent via SendTo or Apply Changes from the
Display, the rulebase is stored in the autoconfiguration directory. When a rulebase
is removed from an agent via the Display, the rulebase is also removed from the
autoconfiguration directory. Use of the methods
RuleBaseEngine:loadRuleBaseFromFile() and
RuleBaseEngine:unloadRuleBase() do not affect the autoconfiguration
directory.

Manual Configuration Mode


This section explains how you use the -M RuleBaseEngine options to implement a
Manual Configuration mode. This is one of three mutually exclusive modes
available for determining which configuration objects to use. The other two
modes are Automatic Configuration and Repository Information. Manual
Configuration and Repository Information are both types of manual
configuration mode.
To use manual configuration, specify a configuration path and a list of rulebases,
using the -rulebases and -config_path options.

Use of -rulebases is optional. However, if no RuleBase Map is supplied by the


repository, the use of -rulebases is recommended.

When Manual Configuration mode is used, omit the following options:


-auto_config_dir
-repository_path
-repository_cache_dir

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration File (hawkagent.cfg) 59
|

When manual configuration is selected, the agent searches the Manual


Configuration Path for the Schedule file and the rulebase map file at startup. After
evaluating the rulebase map, the agent has a list of rulebase names. It searches for
these using the Manual Configuration Path.
Note that the loaded startup rulebases may have RuleBaseInclude lists that will
trigger further searches of the manual configuration path for additional rulebases.
Also at startup, the agent searches the path for any rulebases specified in the
Rulebases dialog and loads them.
Note that any rulebases loaded by the agent are not written to a local cache. There
is no notion of an autoconfiguration directory. The only rulebases an agent may
load at startup are those specified by the rulebase map, those listed in the
Rulebases dialog, and rulebases in any contained RuleBaseIncludes.
See the TIBCO Hawk Administrator’s Guide for more on these features. Note that
manual configuration mode is also known as Configuration Path mode.

Repository Configuration Mode


This section explains how you use the -M RuleBaseEngine options to implement a
Repository Configuration mode. This is one of three mutually-exclusive modes
available for determining which configuration objects to use. The other two
modes are Automatic Configuration and Manual Configuration. Manual
Configuration and Repository Information are both types of manual
configuration mode.
To use repository configuration, specify a repository path and a repository cache
directory, using the -repository_path and -repository_cache_dir options,
and a list of rulebases, using the -rulebases option.

Use of -rulebases is optional. However, if no RuleBase Map is supplied by the


repository, the use of -rulebases is recommended.

When Repository Configuration mode is used, omit the following options:


-config_path
-auto_config_dir

Repository mode is also a type of manual configuration mode and operates in a


similar way to Manual Configuration mode. Instead of a configuration path, you
specify a repository path. The agent communicates with a list of repositories in
this path to obtain all configuration objects (rulebases, schedules, and rulebase
maps). Repositories are kept on the network and can be accessed by multiple
agents. See the TIBCO Hawk Administrator’s Guide for an explanation of
repositories.

TIBCO Hawk Installation and Configuration


60
| Chapter 6 Configuring TIBCO Hawk Software

Unlike Manual Configuration Mode, with Repository mode all configuration


objects loaded from the Repository may be cached in a local directory, specified in
the -repository_cache_dir option. This cache is used in the event of a
repository failure, and also to minimize network traffic. Agents can determine if a
configuration object in their cache is identical to the one in the repository and will
load it directly from the cache or update it from the Repository as appropriate.

-M AMIService
This module of the agent configuration file deals with the following command
line options which relate to monitoring an AMI-instrumented application.
-ami_rvd_session <service> <network> <daemon>

-ami_rvds_session <service> <network> <daemon>

Applications instrumented with AMI must create and use a TIBCO Rendezvous
session to connect with a TIBCO Rendezvous daemon (rvd).
To monitor an AMI-instrumented application that uses the same session
parameters as those used in the Self section of the agent configuration file (the
primary session), omit the AMIService options.
To monitor AMI-instrumented applications that use different session parameters
than those used in the TIBCO Hawk configuration, you must create additional
AMI sessions.
You can specify a secure Rendezvous session that uses Rendezvous DataSecurity
along with digital certificates to guarantee the integrity and authenticity of the
messages sent to applications instrumented with AMI. To do this, use the
-ami_rvds_session option.

If you use these options, all three parameters must be present and separated by
white space. Use an empty string to indicate a null value, for example:
-ami_rvd _session 7474 "" tcp:7474

You can specify any number of additional TIBCO Rendezvous sessions for a
TIBCO Hawk agent to monitor. Applications using these sessions appear as
primary sessions in the TIBCO Hawk Display in the same list as managed
applications (and microagents). TIBCO Hawk agents can use rulebases that refer
to the applications, as long as those applications are running.
See Creating a TIBCO Rendezvous Session, page 84, for more on defining
sessions.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration File (hawkagent.cfg) 61
|

-M LogService
This module of the agent configuration file deals with the following command
line options which relate to log files used by this agent.
-log_dir <directory to store TIBCO Hawk logs>

-log_max_size <maximum size of one TIBCO Hawk log>

-log_max_num <maximum number of TIBCO Hawk logs>


-log_format <Hawk or ActiveEnterprise format>
The TIBCO Hawk system creates rolling log files for agent events (Hawk.log) in
the directory named in the -log_dir option. When one file has reached the size
specified in the -log_max_size option, it is closed and renamed, and a new log
file with the same name is started. When the number of log files exceeds the
number set in the -log_max_size option, log entries roll over to reuse the oldest
log file.
By default, the unit of measure for -logmaxsize is kilobytes and the default size
is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M
specifies ten megabytes.
If, for example, you have configured a maximum of five log files, log files roll over
until there are five files (named file1, file2… file5). At this point, the next
rollover eliminates file5 and renames file4 to file5, thus maintaining a total
of five rollover files. The log thus retains the latest log information and discards
the oldest.
The -log_format option allows you to select the format of log file entries. Either
the existing Hawk format or the Active Enterprise format can be specified.

TIBCO Hawk Installation and Configuration


62
| Chapter 6 Configuring TIBCO Hawk Software

-M TIBProtocolAdapter
This module of the agent configuration file deals with the following command
line options which relate to agent heartbeat and security used by this agent.

Table 16 -M TIBProtocolAdapter Options

Option Description
-interval The TIBCO Hawk agent heartbeat interval can be set on each computer
<heartbeat interval in where an agent is installed. The TIBCO Hawk Display uses this value to
seconds> determine when to mark an agent dead.
To use the default value of 30 seconds, omit this option. To use a different
value, enter a number of seconds, as desired.

-security_policy TIBCO Hawk provides a mechanism by which you can develop your own
<class that implements security policy plug-in. To create a security policy, you must write a Java class
security> that implements a security policy specific to your needs.
(For more information on creating a security policy class, see the TIBCO Hawk
Programmer’s Guide. For more information on the Trusted and Certified
security policies, see Chapter 10 on page 131.)
Depending on your security needs, complete this option as follows:
• If you are not using a security policy, omit this option.
• To use the TIBCO Hawk Trusted Security Policy, specify:
COM.TIBCO.hawk.security.trusted.Trusted

or
COM.TIBCO.hawk.security.trusted.TrustedWithDomain

• To use the TIBCO Hawk Certified Security Policy, specify:


COM.TIBCO.hawk.security.certified.Certified

To use a specific security policy, specify the name of the security policy class
on each machine where you want to use the policy. Ensure that this class file
is placed in <TIBCO Hawk installation directory>/Java. Do not enter the file
extension. For example, if your Java class file is named
ASecurityPolicy.class you would specify ASecurityPolicy.

Note: If your security policy class is not part of the default package (for
example, if you used the Java "package" directive in your code), you will
need to create the appropriate directory structure beneath <TIBCO Hawk
installation directory>/Java that corresponds to your package name and place
your class file in the appropriate location. For example, if your fully qualified
class name is com.mycorp.MySecurity, you will place MySecurity.class in
<TIBCO Hawk installation directory>/Java/com/mycorp.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration File (hawkagent.cfg) 63
|

-M Repository
This module of the agent configuration file deals with the following command
line options which relate only to agents used as repositories for the TIBCO Hawk
system.
-repository_name <repository name>

-repository_dir <repository directory>

If a TIBCO Hawk agent is to act as a repository for the TIBCO Hawk system, enter
a name (with no spaces or periods) for the repository and a path for storage of the
configuration object files. The default is <TIBCO Hawk installation
directory>/repository.

If this is not the case, omit these options.

-M LogfileMicroAgent
This module of the agent configuration file deals with the following command
line options which relate to agent heartbeat and security used by this agent.

Table 17 -M LogfileMicroAgent Options


Option Description
-scan_rate <rate in seconds> The TIBCO Hawk agent scan rate is the rate at which logfiles are
scanned. The default scan rate is 10 seconds. To use the default
value of 10 seconds, omit this option. To use a different value,
enter a number of seconds, as desired.

-block_size < size in kilobytes> The TIBCO Hawk agent block size is the maximum number of
kilobytes to read on each scan. The default value is 16 kilobytes. To
use the default value of 16 kilobytes, omit this option. To use a
different value, enter a number of seconds, as desired.

-eval_rate <rate in seconds> The TIBCO Hawk agent eval rate is the rate at which all the
logfiles being monitored are re-evaluated. The default eval rate is
300 seconds. To use the default value of 300 seconds, omit this
option. To use a different value, enter a number of seconds, as
desired.

TIBCO Hawk Installation and Configuration


64
| Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk HMA Configuration File (hawkhma.cfg)

The options in the hawkhma.cfg configuration file are used to configure


microagent-related functions:

Table 18 hawkhma.cfg Functions and Options

Function Options
TIBCO Rendezvous (RVD) -rvd_session <service> <network> <daemon>
Session

Logging Information -logdir <directory to store HMA logs>


-logmaxsize <maximum size of one HMA log>

-logmaxnum <maximum number of HMA logs>

-log_format <Hawk or ActiveEnterprise format>

Timeout -timeout <milliseconds>

Trace Level -tracelevel <desired trace level>

UNIX Signal Handling -ignore_sigint

-ignore_sigterm

-ignore_sigabrt

TIBCO Rendezvous (RVD) Session


-rvd_session <service> <network> <daemon>

Because the TIBCO Hawk software uses the functionality of the TIBCO
Rendezvous system, it must connect to a TIBCO Rendezvous daemon by creating
a session.
If TIBCO Rendezvous is only used on one network and no special TIBCO
Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session
default values. To use the default session parameters (specified in the Self module
of the agent configuration file), omit the -rvd_session command-line options.
If you use this option, all three parameters must be present and separated by
white space. Use an empty string to indicate a null value, for example:
-rvd _session 7474 "" tcp:7474

See Creating a TIBCO Rendezvous Session, page 84, for more details.

TIBCO Hawk Installation and Configuration


TIBCO Hawk HMA Configuration File (hawkhma.cfg) 65
|

Logging Information
-logdir <directory to store HMA logs>

-logmaxsize <maximum size of one HMA log>

-logmaxnum <maximum number of HMA logs>


-log_format <Hawk or ActiveEnterprise format>
The TIBCO Hawk system creates rolling log files for microagent events in the
directory named in the -logdir option. The HMA produces a log file for each of
its microagents and names them using the format hawk_<microagentname>.log, for
example, hawk_performance.log. When one file has reached the size specified in
the -logmaxsize option, it is closed and renamed, and a new log file with the
same name is started. When the number of log files exceeds the number set in the
-logmaxsize option, log entries roll over to reuse the oldest log file.

By default, the unit of measure for -logmaxsize is kilobytes and the default size
is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M
specifies ten megabytes.
If, for example, you have configured a maximum of five log files, log files roll over
until there are five files (named file1, file2… file5). At this point, the next
rollover eliminates file5 and renames file4 to file5, thus maintaining a total
of five rollover files. The log thus retains the latest log information and discards
the oldest.
The -log_format option allow you to select the format of log file entries. Either
the existing Hawk format or the Active Enterprise format can be specified.

Timeout
-timeout <milliseconds>
Specifies the amount of time the Hawk Agent should wait for HMA method
invocations to complete before timing them out. The default is 10000
milliseconds. Normally there is no need to change this value, however, on
machines under extreme stress where method invocations are timing out, this
new option allows the timeout value to be increased

Trace Level
-tracelevel <desired trace level>

TIBCO Hawk Installation and Configuration


66
| Chapter 6 Configuring TIBCO Hawk Software

Specifies the level of diagnostic trace output. You can choose -1 to enable all
tracing, 0 to enable no tracing, or calculate a desired trace level by adding together
values from the following table:

Value Purpose
1 enables information level trace messages

2 enables warning level trace messages

4 enables error level trace messages

8 enables debug level trace messages

16 enables AMI level trace messages

32 adds source filename and line numbers to all trace


messages

The default value for tracing is 7, or 1+2+4 (information, warning and error).

UNIX Signal Handling


-ignore_sigint

-ignore_sigterm

-ignore_sigabrt

These options specify that the TIBCO Hawk HMA should ignore the SIGINT,
SIGTERM, and SIGABRT signals, respectively. These options will cause the HMA
to set the disposition of the corresponding signal to SIG_IGN.
By default, the HMA installs a signal handler for these signals that performs a
graceful shutdown of the HMA in response to one of these signals. For most
circumstances, this is the desired behavior and these options would not be
specified.
These options can be used to configure the HMA not to shutdown or terminate in
response to any of these signals. For example, the HMA can be started as a
background process from a UNIX console with -ignore_sigint so that the HMA
will not be shutdown if Ctrl-C is entered from the console.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 67
|

TIBCO Hawk Event Service Configuration File (hawkevent.cfg)

The TIBCO Hawk Event Service has two main purposes: to record the activity of
TIBCO Hawk agents, and to detect and respond to agent termination.
The event service records:
• all alerts raised and cleared by TIBCO Hawk agents across the network, as
well as changes in an agent’s alert level (as would be shown by a color in the
TIBCO Hawk Display)
• all instances of agent activation and expiration
The event service also can call a script (using the -script option in the Event
Service configuration file) when the heartbeat of a TIBCO Hawk agent is lost (not
received for a specified length of time). This usually means that the agent process
has terminated or that network communication has been interrupted. This facility
could be used to send an e-mail or page, or to take some other automated action.
You will normally run the TIBCO Hawk Event Service on a single system in a
TIBCO Hawk managed network. Multiple instances can be run on separate
systems for fault tolerance.

Be careful not to confuse TIBCO Hawk Event Service data files (Event.dat) with
Event Service log files (Event.log).
• Event.dat data files contain the data produced by the Event Service.
• Event.log log files record the state of the Event Service itself.
The Event.log file is discussed in the TIBCO Hawk Administrator’s Guide.

Configuring the Event Service


The Event Service is configured through a command-line interface. The options
are described below.

Table 19 hawkevent.cfg Options

Option Description
-hawk_root The TIBCO Hawk root installation directory.

TIBCO Hawk Installation and Configuration


68
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 69
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


70
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 71
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


72
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 73
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


74
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 75
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


76
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 77
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


78
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 79
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


80
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-hawk_domain Sets the hawk domain name. The agents and the event service must
have the same hawk domain value in order to communicate.
The default is to monitor an entire network as one group. To use the
default, omit this option. See the TIBCO Hawk Installation and
Configuration Guide for more details.
Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event
Service.
If you use this option, the following three parameters must be present
and separated by white space:
-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example:


-rvd _session 7474 "" tcp:7474

The default session uses null values.


If TIBCO Rendezvous is only used on one network and no special
TIBCO Rendezvous sessions are needed, you can omit this parameter
to use the default TIBCO Rendezvous daemon session values. Those
values are specified in the Self module of the agent configuration file.
See the TIBCO Hawk Installation and Configuration Guide for more
details.

-ami_rvd_session Specifies the TIBCO Rendezvous rvd session used by the TIBCO Hawk
Event Service for AMI communications. If this options is used, all three
parameters must be present and separated by whitespace but any of
them may be an empty string to indicate a null value.
The default ami_rvd_session uses rvd_session values.

-character_encoding Specifies the character encoding to be used for strings sent over all
TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files
(event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5.
Values lower than the default number are ignored, and the default is
used instead.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration File (hawkevent.cfg) 81
|
Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-datamaxsize When one rolling data file has reached this size, it is closed and
renamed, and a new data file with the original name is started.
By default, the unit of measure for -datamaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes. Values lower than the
default size are ignored, and the default is used instead. You can,
however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type


VARCHAR(256) to be created as additional columns in the
HawkAlertClearInfo table. When the event service receives an
"onAlert" event that contains the specified properties, the
corresponding values are inserted into the database. For example, the
command
-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in


the HawkAlertClearInfo table.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2,
INFORMIX and SYBASE.

-JDBCdriverClassName Class name for the vendor's JDBC driver. For example,
com.microsoft.jdbc.sqlserver.SQLServerDriver.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection.

-JDBCuserName User name to connect to the database.

-log_format The format of log file entries. Valid values are default (Hawk format)
or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO


Hawk Event Service. To print all log messages to the screen, omit this
option.

TIBCO Hawk Installation and Configuration


82
| Chapter 6 Configuring TIBCO Hawk Software

Table 19 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)


-logmaxnum The maximum number of rolling log files to keep. When the number of
rolling log files exceeds this number, log entries roll over to reuse the
oldest log file. The default is 4. Values lower than the default number
are ignored, and the default is used instead.

-logmaxsize When one rolling log file has reached this size, it is closed and
renamed, and a new log file with the original name is started.
By default, the unit of measure for -logmaxsize is kilobytes and the
default size is 1024. To specify a value in megabytes, use the suffix m or
M. For example, 10M specifies ten megabytes.

-script The script to execute on lost agent heartbeat. Hawk passes the agent
hostname and IP address to the script to identify which agent died.

-file Reads more command line arguments from this file. The file has
exactly the same syntax and semantics as if it were a continuation of
the command line. If you supply -file, it must be the last parameter
on the command line. You may supply no more than one -file
parameter.

-help Prints a help message.

TIBCO Hawk Installation and Configuration


Creating a TIBCO Hawk Domain 83
|

Creating a TIBCO Hawk Domain

Create a TIBCO Hawk domain if you wish to isolate groups of TIBCO Hawk
agents into independent monitoring sets. Remember that each TIBCO Hawk
agent can belong to only one TIBCO Hawk domain and cannot communicate with
the TIBCO Hawk Display program on other domains.
The default is to monitor an entire network as one group. To use the default, omit
the -hawk_domain option.

Testing a Domain
To test the domain option, temporarily set the TIBCO Hawk domain on a single
system to a name such as test, then start (or restart) the TIBCO Hawk
Display. If you entered a unique domain name, you only one discovered host
should appear in the TIBCO Hawk Display main window. This shows that only
the local agent and the local TIBCO Hawk Display are using the test domain.
If the domain is as desired, you can now install it on the network systems where
you want to assign specific computers to that domain. All systems assigned to
that TIBCO Hawk domain appear on the Display as part of that domain.
When finished with testing, change back to the default domain and restart the
TIBCO Hawk Display to verify that it was correctly restored.

TIBCO Hawk Installation and Configuration


84
| Chapter 6 Configuring TIBCO Hawk Software

Creating a TIBCO Rendezvous Session

A TIBCO Rendezvous session is a direct conduit through which an application


and a TIBCO Rendezvous daemon communicate.
The following processes in the TIBCO Hawk system communicate with a TIBCO
Rendezvous daemon through sessions:
• TIBCO Hawk Agent
• TIBCO Hawk HMA
• TIBCO Hawk Display
• TIBCO Hawk Event Service

Default Session Values


If TIBCO Rendezvous is only used on one network and no special TIBCO
Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session
default values.
To use the default TIBCO Hawk session parameters with port 7474, omit the
-rvd_session command-line options.

If you use this option, all three parameters must be present and separated by
white space. Use an empty string to indicate a null value, for example:
-rvd _session 7474 "" tcp:7474

Setting up a TIBCO Rendezvous Daemon Session


This section provides a brief overview of session parameters used to set up a
TIBCO Rendezvous Daemon (RVD) session for TIBCO Hawk monitoring. For
more information on interacting with TIBCO Rendezvous daemons and sessions,
refer to the books TIBCO Rendezvous Concepts and the TIBCO Rendezvous
Administrator’s Guide.
• The Service parameter specifies which User Datagram Protocol (UDP) service
group the TIBCO Rendezvous daemon should use for session
communications. The default configuration uses the service port number
7474. A service can be specified either by its name or its port number.
• The Network parameter specifies what network to use for outbound session
communications when a computer is connected to more than one network. A
network can be specified by its name or by its IP address. This parameter is
also used to specify the multicast groups to use for communication.

TIBCO Hawk Installation and Configuration


Creating a TIBCO Rendezvous Session 85
|

• The Daemon parameter specifies which TIBCO Rendezvous daemon is to


handle communication for the session. A local daemon is specified by the
communications type (always tcp) and a socket number (e.g., 7474). The
default configuration uses the local daemon with the TCP socket number
7474.

Specify a remote daemon by inserting its host name or IP address between the
tcp entry and the port number of the daemon parameter, for example:
tcp:remote_computer:7800

TIBCO Hawk Installation and Configuration


86
| Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk Installation and Configuration


| 87

Chapter 7 Using the Configuration Utility

This chapter explains how to configure TIBCO Hawk using the Configuration
Utility GUI.

The Configuration Utility GUI interface is available only on Windows platforms.


For UNIX, all TIBCO Hawk configuration is done through the command line.
This is discussed in Chapter 6, Configuring TIBCO Hawk Software.

Topics

• Configuration Utility Overview, page 88


• General Configuration, page 89
• TIBCO Hawk Display Configuration, page 97
• TIBCO Hawk Agent Configuration, page 98
• TIBCO Hawk Event Service Configuration, page 107

TIBCO Hawk Installation and Configuration


88
| Chapter 7 Using the Configuration Utility

Configuration Utility Overview

When the TIBCO Hawk installation program is finished on Microsoft Windows, it


automatically starts the TIBCO Hawk configuration utility. The configuration
utility can also be run at any time by selecting Start > Programs > TIBCO Hawk
Software > Hawk Configuration.
The tabs in the configuration utility correspond to the four configuration files
described in Chapter 6, Configuring TIBCO Hawk Software.

TIBCO Hawk Installation and Configuration


General Configuration 89
|

General Configuration

The General tab contains basic TIBCO Hawk configuration items common to all
TIBCO Hawk components. When you start TIBCO Hawk, the fields in these
dialogs are populated with values appropriate for your configuration. In most
cases, you do not need to change those values.

Figure 1 General Configuration

TIBCO Hawk Installation and Configuration


90
| Chapter 7 Using the Configuration Utility

Domain Information
Separate domains create independent TIBCO Hawk systems. Each TIBCO Hawk
agent can belong to only one TIBCO Hawk domain and cannot communicate with
TIBCO Hawk Display programs monitoring on other domains. Use TIBCO Hawk
domains if you want to isolate groups of TIBCO Hawk agents into independent
monitoring sets.
Leave the Hawk Domain field blank to use the default domain.
To give the agent a domain name, enter the desired name in the Hawk Domain
field. Give this same name to all agents that you want to include in the domain,
when you configure them on the systems where they are installed. The domain
you enter here is used for both the TIBCO Hawk agent and for any instance of the
TIBCO Hawk Display program running on that system.

Rendezvous Session
Use this section to configure the TIBCO Rendezvous session. Because the TIBCO
Hawk software uses the functionality of the TIBCO Rendezvous system, it must
connect to a TIBCO Rendezvous daemon by creating a session.

Sessions
A TIBCO Rendezvous session is a direct conduit through which an application
and a TIBCO Rendezvous daemon communicate.
The following processes in the TIBCO Hawk system communicate with a TIBCO
Rendezvous daemon through sessions:
• TIBCO Hawk Agent
• TIBCO Hawk HMA
• TIBCO Hawk Display
• TIBCO Hawk Event Service

Setting up a TIBCO Rendezvous Daemon Session


This section provides a brief overview of session parameters used to set up a
TIBCO Rendezvous Daemon (RVD) session for TIBCO Hawk monitoring. For
more information on interacting with TIBCO Rendezvous daemons and sessions,
refer to the books TIBCO Rendezvous Concepts and the TIBCO Rendezvous
Administrator’s Guide.
• The Service parameter specifies which User Datagram Protocol (UDP) service
group the TIBCO Rendezvous daemon should use for session

TIBCO Hawk Installation and Configuration


General Configuration 91
|

communications. The default configuration uses the service port number


7474. A service can be specified either by its name or its port number.
• The Network parameter specifies what network to use for outbound session
communications when a computer is connected to more than one network. A
network can be specified by its name or by its IP address. This parameter is
also used to specify the multicast groups to use for communication.
• The Daemon parameter specifies which TIBCO Rendezvous daemon is to
handle communication for the session. A local daemon is specified by the
communications type (always tcp) and a socket number (e.g., 7474). The
default configuration uses the local daemon with the TCP socket number
7474.
Specify a remote daemon by inserting its host name or IP address between the
tcp entry and the port number of the daemon parameter, for example:
tcp:remote_computer:7800.

Security
Because security needs vary greatly, the TIBCO Hawk system provides a
mechanism by which you can develop your own security policy plug-in. To create
a security policy, you must write a Java class that implements a security policy
specific to your needs. For more information on creating a security policy class,
see the TIBCO Hawk Programmer’s Guide.
For more information on the Trusted and Certified security policies that come
with TIBCO Hawk software, see Chapter 10 on page 131.
Depending on your security needs, complete the Security Policy field as follows.
• If you are not using a security policy, leave the Security Policy Class field
blank.
• To use the TIBCO Hawk Trusted Security Policy, enter:
COM.TIBCO.hawk.security.trusted.Trusted

or
COM.TIBCO.hawk.security.trusted.TrustedWithDomain

• To use the TIBCO Hawk Certified Security Policy, enter:


COM.TIBCO.hawk.security.certified.Certified

• To use a specific security policy, on each machine where you want to use the
policy, enter the name of the security policy class. Ensure that this class file is
placed in <TIBCO Hawk installation directory>\Java. Do not enter the file

TIBCO Hawk Installation and Configuration


92
| Chapter 7 Using the Configuration Utility

extension. For example, if your Java class file is named


ASecurityPolicy.class you would enter ASecurityPolicy.

If your security policy class is not part of the default package (for example, if
you used the Java "package" directive in your code), you will need to create
the appropriate directory structure beneath <TIBCO Hawk installation
directory>\Java that corresponds to your package name and place your class
file in the appropriate location. For example, if your fully qualified class name
is com.mycorp.MySecurity, you will place MySecurity.class in <TIBCO
Hawk installation directory>\Java\com\mycorp.

Logging
The TIBCO Hawk system logs specific events as they occur. The events are
categorized as errors, warnings, or informational events. The logs provide a
detailed picture of the status and health of each of the TIBCO Hawk components
to aid in diagnosing problems.
The settings configured in the Logging panel control logging of the following
components:
• The TIBCO Hawk agent (Hawk.log).
• The TIBCO Hawk Display (Display.log).
• The TIBCO Hawk Event Service (Event.log).

Log to Windows Event Log


Enable this setting to log TIBCO Hawk events in the Application section of the
Windows Event Log.
These events can be viewed using the Windows Event Viewer. To access the
viewer, select Start>Programs>Administrative Tools>Event Viewer, then select
Log>Application from the Event Viewer menu to view Application events.
Events logged by the TIBCO Hawk system contain the component name (for
example, the TIBCO Hawk agent) under the Source column.

Log to Hawk Log Files


Enable this setting to log TIBCO Hawk events using a set of log files in the
directory you specify in the Log Files Directory field.
The TIBCO Hawk system creates rolling log files for each component; when one
file has reached the size specified in the Maximum Size of Log Files field, it is
closed and renamed, and a new log file with the same name is started. When the
number of log files exceeds the number set in the Maximum Number of Log Files

TIBCO Hawk Installation and Configuration


General Configuration 93
|

field, log entries roll over to reuse the oldest log file. If, for example, you have
configured a maximum of five log files, log files roll over until there are five files
(named file1, file2… file5). At this point, the next rollover eliminates file5
and renames file4 to file5, thus maintaining a total of five rollover files. The
log thus retains the latest log information and discards the oldest.
• Log Files Directory
Enter the name of the directory where the TIBCO Hawk system should place
its log files. The default value is <TIBCO Hawk installation directory>\Log.
• Maximum Number of Files
Enter the maximum number of rolling log files to create. You can enter at
minimum 5 and at maximum 999. The default value is 5.
• Maximum Size of Log File
In this edit field, enter the maximum log file size, in kilobytes. Enter only
digits. The default is 1024. Note that the maximum log file size is 2097151
kilobytes.

Log Message Format


This field allow you to select the format of log file entries. Either the existing
Hawk format (Default) or the ActiveEnterprise format (ae4) can be specified.

HMA Configuration

AMI Timeout
Specifies the amount of time the Hawk Agent should wait for HMA method
invocations to complete before timing them out. The default is 10000
milliseconds. Normally there is no need to change this value, however, on
machines under extreme stress where method invocations are timing out, this
option allows the timeout value to be increased.

Codepage
The Codepage configuration option indicates the desired character encoding to be
used by the HMA when converting multi-byte characters (MBCS) to UNICODE.
The default codepage identifier is 65001, which is the Microsoft Windows ID for
UTF-8, and which will work for all locales.
The only reason to change this value is for compatibility with other TIBCO
Rendezvous applications not using UTF-8. This value is specified using Microsoft
Windows code page values, as listed at the following URL:

TIBCO Hawk Installation and Configuration


94
| Chapter 7 Using the Configuration Utility

http://msdn.microsoft.com/library/default.asp?url=/library/en-u
s/intl/unicode_81rn.asp

If you change the Codepage value, you must also change the value of the
Character Encoding, page 95. For example, if you want to specify Latin-1 locales
(such as French), the Codepage value must be 1252 and the Character Encoding
value must be ISO-8859-1. See Code Page Identifiers on page 177 for the list of
code page identifiers.

Advanced Configuration
On the General configuration tab, click the Advanced button to access the
Advanced Configuration dialog.

Figure 2 Advanced Configuration

TIBCO Hawk Installation and Configuration


General Configuration 95
|

Java Runtime Configuration


The Java Runtime Configuration section of the window allows you to select a
specific JRE file to use and to specify the JVM executable. This is useful if there are
several JRE installations with different version levels, on your system.
If you install a new JRE after installing TIBCO Hawk, you must update the Java
Home Directory field. Type in the new JRE path or set it to blank, in which case it
is automatically updated.

Configuration File Options


This section allows you to specify configuration files (such as hawkagent.cfg).
When you specify a configuration file, the values in that file override the
corresponding values entered into the configuration utility.
For example, if an option in the configuration file you select is blank but a custom
value is specified for that option in the configuration utility, TIBCO Hawk will use
the default (blank) value for that option.

Java Virtual Machine Command Line Options


This section allows you to set the Java Virtual Machine command line options for
use by the TIBCO Hawk Display, Agent, and Event Service. If you have specific
applications that require a nonstandard configuration, such as a need for more
memory, use the Command Line Options fields to custom-configure the Java
environment.

Prevent an Agent For example, an agent can exit when a user logs off the desktop. To prevent the
from Exiting agent from exiting, add the -Xrs option to the agent's JVM command line (JRE
1.3.1 only).

Character Encoding
The Character Encoding configuration option indicates the desired character
encoding to be used by the Agent, Display, and Event Service. This is also the
encoding used for the character data that TIBCO Hawk transmits over TIBCO
Rendezvous.
The default setting of UTF-8 will work for all locales. The only reason to change
this setting is for compatibility with other TIBCO Rendezvous applications. If you
change this value, you must also change the Codepage value, which sets the
character encoding for the TIBCO Hawk HMA.

TIBCO Hawk Installation and Configuration


96
| Chapter 7 Using the Configuration Utility

Possible Character Encoding values are listed in Table 22, Code Page Identifiers,
on page 178.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Display Configuration 97
|

TIBCO Hawk Display Configuration

The Display tab allows you to specify a previously created layout to be loaded
automatically at startup and to specify a variables file.

Figure 3 Display Configuration

Display
Use the Display option to specify the previously created layout you want loaded
automatically at startup.

Variables
Use the Variables option to specify a variables file. The variables file can pass data
to define external variables to be used in either host or tool menu commands. The
format of the file is that used by the standard Java class java.util.Properties.
There is one line per variable where each line has the format variablename=value.

TIBCO Hawk Installation and Configuration


98
| Chapter 7 Using the Configuration Utility

TIBCO Hawk Agent Configuration

The Agent tab allows you to configure options specific to the TIBCO Hawk agent.

Figure 4 Agent Configuration Tab

Identification

Agent Name
The agent name appears in the TIBCO Hawk Display. The default name for the
TIBCO Hawk agent is the host name of the computer on which it is installed.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration 99
|

To use the host name as the agent name, leave the Agent Name field blank. To use
a different name, enter a name as desired.

Agent Domain
An agent domain must be specified when two computers within the same TIBCO
Hawk domain have the same name but reside in different network domains. To
specify an agent domain for a TIBCO Hawk agent, enter the desired domain in
the Agent Domain field, for example, pa.tibco.com.

Cluster
Enter the container name in which this agent is to appear in the TIBCO Hawk
Display. The default name for the container is the IP subnet address. The cluster
name must be enclosed within quotes, if the name contains spaces.

Configuration Modes
Use the options in this panel to set up what mode the agent is to use when it
searches for configuration objects. The default is to use Automatic configuration.
Automatic, Manual, and Repository configuration modes are mutually exclusive.
When the radio button for one of these modes is selected, the other options are
disabled.
The delimiter for path entries is a semicolon ( ; ).

If you are using the rulebase map, you usually do not need to list any rulebases in
the rulebase list dialog. Using both a rulebase map and the rulebase list dialog
increases the complexity of managing your monitoring configuration.
The rulebase list dialog (which corresponds to the UNIX or file config option
-rulebases) is provided to maintain backward compatibility with previous
versions of TIBCO Hawk that do not contain the rulebase map feature.

Automatic Configuration Mode


To use Automatic configuration, enable the Auto radio button. You can either use
the default auto configuration directory (<TIBCO Hawk installation
directory>\AutoConfig.) or specify another directory.

TIBCO Hawk Installation and Configuration


100
| Chapter 7 Using the Configuration Utility

When Automatic Configuration mode is enabled, all load-by-reference rulebase


loading mechanisms are disabled. Therefore, the Manual Configuration Path,
Repository Path, Repository Cache Directory, and the Rulebases button are not
enabled. In addition, the RuleBaseInclude feature, rulebase maps, and the
RuleBaseEngine:loadRuleBase() microagent method are not used. However,
the microagent method RuleBaseEngine:loadRuleBaseFromFile() is allowed.
See the TIBCO Hawk Administrator’s Guide and the TIBCO Hawk Methods Reference
for more on these features and microagent methods. See the TIBCO Hawk Console
API Reference for information on configuring microagent plug-ins.
With automatic configuration, the agent will load the Schedules configuration file
and all rulebase configuration files from the automatic configuration directory at
startup. The only other mechanism by which an agent can load a rulebase after
this point is through invocation of RuleBaseEngine:loadRuleBaseFromFile()
or via SendTo from the Display, using fully qualified filenames.
When a rulebase is sent to an agent via SendTo or Apply Changes from the
Display, the rulebase is stored in the autoconfiguration directory. When a rulebase
is removed from an agent via the Display, the rulebase is also removed from the
autoconfiguration directory. Use of the methods
RuleBaseEngine:loadRuleBaseFromFile() and
RuleBaseEngine:unloadRuleBase() do not affect the autoconfiguration
directory.

Manual Configuration Mode


When manual configuration is selected, at startup, the agent searches the Manual
Configuration Path for the Schedule file and the rulebase map file. After
evaluating the rulebase map, the agent has a list of rulebase names. It searches for
these using the Manual Configuration Path. Note that the loaded startup
rulebases may have RuleBaseInclude lists that will trigger further searches of
the manual configuration path for additional rulebases. Also at startup, the agent
searches the path for any rulebases specified in the Rulebases dialog and loads
them.
See the TIBCO Hawk Administrator’s Guide for more on these features. Note that
manual configuration mode is also known as Configuration Path mode.
Any rulebases loaded by the agent are not written to a local cache. There is no
notion of an autoconfiguration directory. The only rulebases an agent may load at
startup are the ones:
• specified by the rulebase map.
• listed in the Rulebases dialog.
• contained in any RuleBaseIncludes.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration 101
|

To set up manual configuration, you specify a configuration path to use, and a list
of rulebases, as follows.
1. Select the Manual radio button.
2. In the Manual Configuration Path field, specify a list of directories to be
searched by separating directory entries with semicolons. The default
directory is <TIBCO Hawk installation directory>\Config.
3. Click Rulebases to bring up the Rulebase Configuration dialog

Figure 5 Rulebase Configuration Dialog

4. Do either of the following until your list is as desired, then click OK:
— To add a rulebase to the list, click Add, enter a a rulebase filename, and click
OK.
— To remove a rulebase from the list, select it and click Delete.

Do not use a file extension when entering rulebase names. The .hrb extensions
are only used for rulebase files. See RuleBaseEngine:loadRuleBase() and
RuleBaseEngine:loadRuleBaseFromFile() for more information.

TIBCO Hawk Installation and Configuration


102
| Chapter 7 Using the Configuration Utility

Repository Configuration Mode


Repository mode is also a type of manual configuration mode and operates in a
similar way to Manual Configuration mode. Instead of a configuration path, you
specify a repository path. The agent communicates with a list of repositories in
this path to obtain all configuration objects (rulebases, schedules, and rulebase
maps). You can also specify a list of rule bases. Repositories are kept on the
network and can be accessed by multiple agents. See the TIBCO Hawk
Administrator’s Guide for an explanation of repositories.
Unlike Manual Configuration Mode, with Repository mode all configuration
objects loaded from the Repository may be cached in a local directory, specified in
the Repository Cache Directory field. This cache is used in the event of a
repository failure, and also to minimize network traffic. Agents can determine if a
configuration object in their cache is identical to the one in the repository and will
load it directly from the cache or update it from the Repository as appropriate.
To use repository mode, specify a path for the repository and a repository cache to
use in case the repository is off-line, and a list of rulebases, as follows.
1. Select the Repository radio button.
2. In the Repository Path field, specify the list of repositories to be searched. The
list should consist of the repository names separated by semicolons (;).
3. In the Repository Cache Directory field, specify a repository cache directory.
The default is <TIBCO Hawk installation directory>\cache.

Step 4 is optional. However, if no rulebase map is supplied by the repository,


this step is recommended.

4. Click Rulebases to bring up the Rulebase Configuration dialog (Figure 5). Do


either of the following until your list is as desired, then click OK:
— To add a rulebase to the list, click Add, enter a a rulebase filename, and click
OK.
— To remove a rulebase from the list, select it and click Delete.

Repository
If a TIBCO Hawk agent is to act as a repository for the TIBCO Hawk system, enter
a name (with no spaces or periods) for the repository and a path for storage of the
configuration object files. The default is <TIBCO Hawk installation
directory>\Repository.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration 103
|

MicroAgent Plugins
Use the Plugins Directory option to specify the directory that the TIBCO Hawk
Agent should search when loading microagent plugins.

Variables
Use the Variables option to specify a variables file. The variables file can pass data
to define external variables to be passed to rules for use in rulebase
configurations.

Logfile Microagent

Scan Rate (secs)


The rate at which the log file that is being monitored is scanned for new entries.
The default is 10 seconds.

Block Size (KB)


The size of the block that is read from the log file each time it is scanned. The
default is 16 KB.

Evaluation Rate (secs)


The rate at which all the logfiles being monitored by the agent are evaluated. The
default is 300 seconds.

Heartbeat
The TIBCO Hawk agent heartbeat interval can be set on each computer where an
agent is installed. The default heartbeat interval is 30 seconds. The TIBCO Hawk
Display uses this value to determine when to mark an agent dead.
To use the default value of 30 seconds, leave the value in the Interval field set to
30. To use a different value, enter a number of seconds, as desired.

AMI
Applications instrumented with AMI must create and use a TIBCO Rendezvous
session to connect with a TIBCO Rendezvous daemon (rvd).

TIBCO Hawk Installation and Configuration


104
| Chapter 7 Using the Configuration Utility

To monitor an AMI-instrumented application that uses the same session


parameters as those used in the TIBCO Hawk configuration, no additional action
is required.
To monitor AMI-instrumented applications that use different session parameters
than those used in the TIBCO Hawk configuration, you must create additional
AMI sessions as required. See the next section for details.

AMI Rendezvous Session Configuration


To monitor AMI-instrumented applications that use different session parameters
than those used in the TIBCO Hawk configuration, you must create additional
AMI sessions.
You can specify any number of additional TIBCO Rendezvous sessions for a
TIBCO Hawk agent to monitor. Applications using these sessions appear as
primary sessions in the TIBCO Hawk Display in the same list as managed
applications (and microagents). TIBCO Hawk agents can use rulebases that refer
to the applications, as long as those applications are running.
You can specify a secure Rendezvous session that uses Rendezvous DataSecurity
along with digital certificates to guarantee the integrity and authenticity of the
messages sent to applications instrumented with AMI. To do this, specify RVDS in
the AMI Rendezvous Session dialog (Figure 7). See Chapter 10 on page 131 for
details.
You can add, edit, and delete sessions using the AMI Rendezvous Session
Configuration dialog. The next section describes how to add a session. All
sessions in the list will be accessible to the TIBCO Hawk agent.

To Create an AMI Session


1. Click AMI Sessions, near the bottom of the Agent tab of the TIBCO Hawk
Configuration Utility. You see the AMI Rendezvous Session Configuration
Dialog. It lists any AMI Rendezvous sessions already created.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Agent Configuration 105
|

Figure 6 AMI Rendezvous Session Configuration

2. Do one of the following:


— To create a new session click Add. You see the Add AMI Rendezvous
Session dialog.
— To create a new session based on an existing one, highlight the desired
session and click Derive. You see the Add AMI Rendezvous Session dialog
(Figure 7), showing the values for the session you selected. Change the
Session Name and other values as required (see next steps).

Figure 7 Add AMI Rendezvous Session

3. Enter a Session Name and select a Session Type for the AMI session. Select
RVDS to specify a secure Rendezvous session that uses Rendezvous
DataSecurity along with digital certificates to guarantee the integrity and
authenticity of the messages sent to applications instrumented with AMI. (See
Chapter 10 on page 131 for details.)

TIBCO Hawk Installation and Configuration


106
| Chapter 7 Using the Configuration Utility

4. In the Session Parameters panel, enter values for Service, Network, and
Daemon. Use the same values as those used by the application to initialize its
TIBCO Rendezvous daemon session. To determine these values, check the
application’s configuration files or documentation. (Although AMI session
parameters are named differently from their non-AMI counterparts, the
arguments are the same and the resulting sessions are similar.)
The default values for an AMI session are RVD, with session parameters
specified as
— Service: 7474
— Network: ;
— Daemon: TCP: 7474
5. Click OK to close the AMI Session window and add the AMI session to the list
of sessions.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration 107
|

TIBCO Hawk Event Service Configuration

The Event Service tab allows you to configure options specific to the TIBCO
Hawk Event Service.
The TIBCO Hawk Event Service is a separate process that collects information
about TIBCO Hawk Agents. It performs the following functions:
• Logs the activity of TIBCO Hawk agents in the event.dat log file.
• Detects and responds to agent termination using a user-supplied command
line executable.
• Uses AMI instrumentation to asynchronously notify users of events on a
particular Hawk domain.
• Allows persistence of TIBCO Hawk Events using JDBC.
• Provides Event Service fault tolerance.
These functions are described in the TIBCO Hawk Administrator's Guide. The event
service AMI methods are described in the TIBCO Hawk Methods Reference.

Be careful not to confuse TIBCO Hawk Event Service data files (Event.dat) with
Event Service log files (Event.log).
• Event.dat data files contain the data produced by the Event Service.
• Event.log log files record the state of the Event Service itself.
The Event.log file is discussed in the TIBCO Hawk Administrator’s Guide.

Logging File
The event service records the following items:
• All alerts raised and cleared by TIBCO Hawk agents across the network, as
well as changes in an agent’s alert level (as would be shown by a color in the
TIBCO Hawk Display)
• All instances of agent activation and expiration
Some example event.dat log file service entries are shown below.
AGENT_ALIVE : agent={ host-name=asture, dns=none,
host-ip=160.101.26.108,
network-ip=160.101.26.0 }, alert-state=0, at Sat Dec 18 11:40:23
EST 1999

RULEBASE_ADDED : AgentID={ host-name=asture, dns=none,


host-ip=160.101.26.108, network-ip=160.101.26.0 },

TIBCO Hawk Installation and Configuration


108
| Chapter 7 Using the Configuration Utility

rulebase=HawkServices-WinNT, state=0, at Sat Dec 18 11:40:23 EST


1999

MICROAGENT_ADDED : AgentID={ host-name=asture, dns=none,


host-ip=160.101.26.108, network-ip=160.101.26.0 },
MicroAgentID=COM.TIBCO.hawk.microagent.SysInfo, at Sat Dec 18
11:40:23
EST 1999

AGENT_EXPIRED : agent={ host-name=ultrahawk1, dns=none,


host-ip=160.101.246.16, network-ip=160.101.246.0 }, at Sat Dec 18
11:50:05 EST 1999

ALERT_RECEIVED : alert={ agent={ host-name=puck, dns=nytek.com,


host-ip=160.101.110.110, network-ip=160.101.110.0 }, alert-id=950,
rulebase=Filesystem, alert-state=50, alert-text=Disk space on /opt
running low., time-received=Sat Dec 18 11:51:20 EST 1999 }, at Sat
Dec 18
11:51:20 EST 1999

ALERT_CLEARED : agent={ host-name=boxter, dns=none,


host-ip=160.101.246.18, network-ip=160.101.246.0 } alert-id=589,
reason=test evaluated to FALSE, at Sat Dec 18 11:48:18 EST 1999

RULEBASE_REMOVE : AgentID={ host-name=ultrahawk1, dns=none,


host-ip=160.101.246.16, network-ip=160.101.246.0 },
rulebase=Solaris2x,
at Sat Dec 18 11:50:05 EST 1999

MICROAGENT_REMOVE : AgentID={ host-name=ultrahawk1, dns=none,


host-ip=160.101.246.16, network-ip=160.101.246.0 },
MicroAgentID=COM.TIBCO.hawk.microagent.SysInfo, at Sat Dec 18
11:50:05
EST 1999

AGENT_REINITIALIZED : agent={ host-name=lexus, dns=nytek.com,


host-ip=160.101.110.169, network-ip=160.101.110.0 },
alert-state=50, at
Sat Dec 18 11:50:36 EST 1999

Command-Line Executable
The Event Service can call a command-line script or executable when the
heartbeat of a TIBCO Hawk agent is lost (not received for a specified length of
time). This usually means that the agent process has terminated or that network
communication has been interrupted. This facility could be used to send an e-mail
or page, or to take some other automated action.

Disabling and Enabling the Event Service


The Event Service is not enabled by default. You must manually enable it.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration 109
|
Enabling the To enable the TIBCO Hawk Event Service,
Event Service
1. Choose Start>Settings>Control Panel, then double-click on the Services icon.
2. Select TIBHawk Event in the list of services and click Startup.
3. In the Service window, click the Automatic radio button, then click OK. The
service is shown in the list as Automatic.
4. Click Start to start the Event Service. The service is shown in the list as
Started.

Disabling the To disable the TIBCO Hawk Event Service, disable the TIBCO Hawk Event
Event Service Service in the Windows Services control panel as follows:
1. Choose Start>Settings>Control Panel, then double-click on the Services icon.
2. Select TIBHawk Event in the list of services and click Startup.
3. In the Service window, click the Disabled radio button, then click OK. The
service is shown in the list as disabled.
4. If the service is already running, click Stop to stop it. The status in the list is
blank, indicating the service is stopped.

Configuring the Event Service in Windows XP and 2000


On the Event Service tab of the TIBCO Hawk Configuration Utility (Figure 8), you
configure how dead agents are handled and how Event Service data files are
managed.
After entering the appropriate data in this dialog, click OK to save the changes.
The new settings are immediately applied to the instance.

TIBCO Hawk Installation and Configuration


110
| Chapter 7 Using the Configuration Utility

Figure 8 TIBCO Hawk Event Service Dialog

Agent Dead Handling


You can write a script to be called when an agent does not respond for a specified
length of time. In the Script File field, specify the name of this script file. By
default, this field is blank and no script is called when the agent does not respond.
Two command-line arguments are sent to the script, in this order:
1. The name of the agent (by default, identical to the name of the computer on
which the agent is installed).
2. The IP address of the computer on which the agent is installed.

TIBCO Hawk Installation and Configuration


TIBCO Hawk Event Service Configuration 111
|

Event Data
Check the Enable Event Service Data Files box to enable logging. The TIBCO
Hawk Event Service writes to rolling data files in the same way that the standard
TIBCO Hawk logging system writes to rolling log files (see Logging, page 92).
As with TIBCO Hawk log files, you can set the following options:
• The directory in which to store data files. The default data file directory is
<TIBCO Hawk installation directory>\Data.

• The maximum number of data files to keep. The default is five.


• The maximum size of a data file. The default maximum is 1024 kilobytes.

AMI Rendezvous Session


Check Enable Dedicated AMI Session if your Event Service process needs to use a
dedicated Rendezvous session for AMI transport. When the session is enabled,
specify the following values. You can leave a parameter field empty (blank) to
indicate a null value.
• Service number
• Network
• TCP daemon
• For more information on these, see Rendezvous Session on page 90.

Separate instances of TIBCO Hawk must be running on at least two machines in


order to use fault tolerance. Fault tolerance must be enabled on each instance.

Database Configuration
Check the Enable Event Persistence box to enable event persistence.
When this feature is enabled, fill in the following fields:
• User Name: User name to connect to the database.
• Password: User password to connect to the database.
• Database Type: The database vendor. Select the appropriate vendor from the
dropdown menu.
• Database Connection: URL that identifies the database connection.
• JDBC Driver Class Name: Class name for the vendor's JDBC driver. For
example, com.microsoft.jdbc.sqlserver.SQLServerDriver.

TIBCO Hawk Installation and Configuration


112
| Chapter 7 Using the Configuration Utility

Fault Tolerance
Check the Enable Fault Tolerance box to enable fault tolerance on this instance.
This instance joins a fault tolerant group named
HawkEventService:hawkdomain, where hawkdomain is the value specified in the
General tab.

Weight
Assign the weight of this instance using a positive integer. The highest weight is 1,
meaning the instance outranks all others. When an instance fails, the next-highest
instance is activated.
Note the following considerations:
• Each TIBCO Hawk Event Service instance in the fault tolerance group must be
assigned a weight.
• Each weight must be a positive whole number, starting with 1.
• Each service should have a unique weight.
• The weights do not need to be consecutive.
• If two or more TIBCO Hawk Event Services have the same weight,
Rendezvous fault tolerance software assigns a rank to them but does not
update the Weight field in this dialog with the new value.

Defaults
This button clears all fields and returns them to their default values.

TIBCO Hawk Installation and Configuration


| 113

Chapter 8 Using TIBCO Hawk Across Nets or Subnets

This chapter explains how to configure TIBCO Hawk monitoring for use across
networks or subnets. It also explains how to access TIBCO Hawk monitoring
through a dial-up connection.

Topics

• Agents and the Network, page 114


• Configuring for Network Communication, page 115
• Setting up Network Communication on UNIX, page 117
• Setting Up Network Communication in Windows, page 118
• Using the TIBCO Hawk Display over a Dial-up Network Connection, page 121

TIBCO Hawk Installation and Configuration


114
| Chapter 8 Using TIBCO Hawk Across Nets or Subnets

Agents and the Network

The TIBCO Rendezvous messaging software that TIBCO Hawk uses operates
within either IP Broadcast or IP Multicast protocols. Network traffic for these
protocols is not generally routed openly between subnets or networks.
IP Multicast traffic can be passed through configuration of the network routers,
but IP Broadcast must use other means to reach other subnets. TIBCO
Rendezvous software uses a process known as a routing daemon (rvrd) to allow
TIBCO Rendezvous messages to transcend multiple networks.
If all TIBCO Hawk agents are installed on computers within one subnet, no
configuration changes are necessary, but if the TIBCO Hawk agents are installed
on computers in different subnets or networks, you must change their
configuration to allow them to communicate using the routing daemon, rvrd.

TIBCO Hawk Installation and Configuration


Configuring for Network Communication 115
|

Configuring for Network Communication

Figure 9 shows a sample routing daemon implementation where all TIBCO Hawk
messages are available throughout the network, and there is only one TIBCO
Hawk domain. Host B acts as the hub. All other rvd processes in each subnet will
obtain information from the other subnets through rvrd processes on host A, B or
C, as applicable.
On these machines, the rvrd process would replace the regular rvd process.
However, in addition to its routing functions, the rvrd will support the local
applications just as rvd would.

Figure 9 Sample Routing Daemon Configuration for TIBCO Hawk Messaging

Subnet 1 Subnet 2 Subnet 3

host
C
Router

host
A

host
B
(hub) neighbor
connection
Router

Configuring Hawk Rendezvous Subjects


When creating Rendezvous routing daemon (rvrd) routes between networks, you
must specify the Rendezvous message subject names that can be passed between
the networks. These are configured using the routing daemon's Browser
Configuration Interface. For details on using the Browser Administration
Interface and creating Rendezvous routes, see TIBCO Rendezvous Administration.
For TIBCO Hawk networks, the routed subjects can be used to control which
agents can be discovered by TIBCO Hawk Console instances located on different
parts of the network.

TIBCO Hawk Installation and Configuration


116
| Chapter 8 Using TIBCO Hawk Across Nets or Subnets

Full Visibility
The simplest TIBCO Hawk routing configuration is full visibility of all agents
from any TIBCO Hawk Console, anywhere on the network. In this case, the
subject configuration of the Rendezvous routing daemons is identical across all
routing daemons, as shown:
Import and Export: "_HAWK.>"

Isolated Spokes and DMZ networks


In many large enterprises, application groups may be allowed to discover Hawk
agents on their own networks, but not on networks outside their control.
However, a central hub network can be used to view all agents for the purposes of
Hawk alert management, centralized rulebase administration, and so on. In this
case, the routing daemons running on the spoke networks are configured to allow
traffic in only from the central hub network consoles. This is configured as shown,
with references to Figure 9:
On the spoke networks (Hosts A and C):
Import: "_HAWK.*.nl.pa.p1.console.>"
Export: "_HAWK.*.nl.pa.p1.agent.>"
Export: "_HAWK.*.nl.pa.p1.agent4.>"

On the central hub network (Host B):


Export: "_HAWK.*.nl.pa.p1.console.>"
Import: "_HAWK.*.nl.pa.p1.agent.>"
Import: "_HAWK.*.nl.pa.p1.agent4.>"

If a Hawk Repository is used, add the following to both sides:


Import and Export: "_HAWK.*.nl.repository.>"

The second subject segment, * , is the Hawk Domain parameter.


When used on DMZ networks, this subject configuration will prevent any of the
"inside" agents being discovered in the event a Hawk Console is launched from
the "outside."

TIBCO Hawk Installation and Configuration


Setting up Network Communication on UNIX 117
|

Setting up Network Communication on UNIX

When starting the rvrd process, use the -store <file name> argument, which is
specific to TIBCO Rendezvous, to store the parameters that configure rvrd. rvrd
reads this file when the process starts, and writes this file each time you change
the configuration using the browser administration interface. For details on using
the Browser Administration Interface, see TIBCO Rendezvous Administration.

A TIBCO Rendezvous license file is required to use TIBCO Hawk with rvrd.

Routing Daemon Configuration for UNIX


When any Rendezvous application starts, the libraries will cause a Rendezvous
daemon (rvd) process to start if one is not already running. Once the rvd process
is running, a Rendezvous routing daemon (rvrd) process cannot be started with
the same transport parameters. This can cause coordination issues in starting the
rvrd prior to any applications, and becomes a problem if the rvrd dies during
run time and an rvd is restarted in its place.
You can avoid these problems by creating a simple wrapper script to always start
the rvrd process in lieu of an rvd process. When the Rendezvous libraries search
the PATH for an executable named rvd, they will find the rvrd wrapper script
instead of the rvd process itself. This will always ensure that the rvrd process is
started or restarted properly.
To set up the script:
1. Move or rename the rvd binary from the rv_install_dir/bin directory.
2. Create a shell script named rvd that starts the rvrd process with the desired
command line arguments.
3. Place the rvd script in the rv_install_dir/bin directory of each machine where
an rvrd process is required to run.
For details on the routing daemon command line parameters, see TIBCO
Rendezvous Administration.

TIBCO Hawk Installation and Configuration


118
| Chapter 8 Using TIBCO Hawk Across Nets or Subnets

Setting Up Network Communication in Windows

Installing a Routing Daemon as a Windows Service


Because TIBCO Hawk processes are installed as Windows services, you must
install the TIBCO Rendezvous routing daemon as a Windows service and
configure the TIBCO Hawk services to depend on it. If this is not done, the TIBCO
Hawk services may start first, causing an rvd to launch and preventing the rvrd
from running.
To configure the appropriate command line parameters for the rvrd process and
install it as a Windows service, use the TIBCO Rendezvous Services
Configuration Program, rv_install_dir\bin\rvntscfg.exe. For further details on
this program and routing daemon command line parameters, see TIBCO
Rendezvous Administration.

Starting the Routing Daemon Service Automatically in Windows


Once you have configured the rvrd process as a Windows service, set it up to
start automatically when the operating system starts, as shown in the following
steps:
1. Choose Start > Settings > Control Panel > Services.
2. Select the service in the list of services.
3. Click Startup.
4. Click the Automatic radio button.
5. Click OK.

Making TIBCO Hawk Services Depend on the Routing Daemon Windows


Service
Once the rvrd service has been installed, add a DependOnService parameter in
the service registry to each of the installed TIBCO Hawk services (TIBHawkAgent,
TIBHawkHMA, and TIBHawkEvent), as shown in the following steps.

1. Log on with administrative privileges.


2. Run the Windows registry editor, regedt32, as follows:
a. Select Start > Run.
b. In the Run dialog that appears, enter regedt32 in the Open drop-down
list box and click OK.

TIBCO Hawk Installation and Configuration


Setting Up Network Communication in Windows 119
|

3. In the registry editor, navigate through the hierarchy to


HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\TIBHawkAgent

as shown in Figure 10.

Figure 10 The TIBCO Hawk Services in the Windows Registry Editor

4. Choose Edit > Add Value.


5. Add the DependOnService value to the Windows Registry.
.

TIBCO Hawk Installation and Configuration


120
| Chapter 8 Using TIBCO Hawk Across Nets or Subnets

6. In the Add Value window that appears, enter DependOnService in the Value
Name edit box.
7. Select a Data Type of REG_MULTI_SZ.
8. Click OK.
9. In the Multi-String Editor window that appears (as shown in Figure 11), enter
rvrd in the Data edit box and click OK.

Figure 11 Adding the rvrd Service Value to the Windows Registry

10. Repeat from step 3 for TIBHawkHma and TIBHawkEvent (if installed).
11. Exit regedt32.
12. Reboot your system.

TIBCO Hawk Installation and Configuration


Using the TIBCO Hawk Display over a Dial-up Network Connection 121
|

Using the TIBCO Hawk Display over a Dial-up Network Connection

The TIBCO Hawk system supports remote monitoring. If you are using a machine
that has dial-in access to your network, you can monitor your network remotely.
Standard connection techniques such as PPP and a simple configuration change
are all that are required. The dial-in computer must have an IP address on the
network, and should only run the TIBCO Hawk Display, and no other TIBCO
Hawk services (such as HMA, agent, or event service).
The remote host must already be running a correctly configured TIBCO
Rendezvous daemon. You cannot spawn a remote daemon. The easiest way to
achieve a dial-up connection is to choose a machine that already has a properly
configured TIBCO Hawk agent or TIBCO Hawk Display running.
This procedure can also be used for remote networks without an rvrd.

Establishing a Dial-up Connection in UNIX


To establish a dial-up connection using UNIX, supply the command-line option
-rvd_session to the startdisplay script:

startdisplay -rvd_session <service> <network> tcp:<internal rvd host>:<port>


For example:
startdisplay -rvd_session 7474 123.123.123
tcp:office_computer:7474

or
startdisplay -rvd_session 7474 123.123.123 tcp:123.123.123.12:7474

When the dial-up connection is established, restart the TIBCO Hawk Display.

Establishing a Dial-up Connection in Windows


By setting the TIBCO Hawk daemon parameter to point to a TIBCO Rendezvous
daemon on your network, you effectively make your TIBCO Hawk Display
appear to be located on that system.
1. From the offsite system, enter the Windows TIBCO Hawk Configuration
program.
2. Enter the remote computer’s name as part of the Daemon parameter, as
follows:
tcp:<internal rvd host>:<port>

TIBCO Hawk Installation and Configuration


122
| Chapter 8 Using TIBCO Hawk Across Nets or Subnets

where <internal rvd host> is any computer on the internal network which a
TIBCO Rendezvous daemon process is running. For example:
tcp:office_computer:7474

or
tcp:123.123.123.12:7474

3. When the dial-up connection is established, restart the TIBCO Hawk Display.

TIBCO Hawk Installation and Configuration


| 123

Chapter 9 TIBCO Hawk Sample Rulebases and


Applications

If, on UNIX, the TIBCO Hawk software is installed in any location other than the
default path of /usr/tibco/hawk, you must update all rules using the
logfile:onNewLine data source in the sample rulebases. For example,
HawkAgent-Unix (in the directory $HAWK_ROOT/samples) must be updated to
reflect the correct path to $HAWK_ROOT/log.

Topics

• Using the Sample TIBCO Hawk Rulebases, page 124


• Using the TIBCO Hawk Sample Applications, page 125
• The Sample AMI API Applications, page 127

TIBCO Hawk Installation and Configuration


124
| Chapter 9 TIBCO Hawk Sample Rulebases and Applications

Using the Sample TIBCO Hawk Rulebases

The TIBCO Hawk sample rulebases are installed in the directory


$HAWK_ROOT/samples/rulebases. To use any of these rulebases, follow the
instructions below:
1. In the TIBCO Hawk Display, right-click on the desired agent and select Get
Configuration>Rulebases from the menu.
The Rulebase List for Agent dialog displays.
2. Choose File>Load From File.
The Open dialog displays.
3. Navigate to the desired rulebase file and click Open.
— If a rulebase with this name is not already loaded, it is added to the
Rulebase List.
— If a rulebase with this name is loaded on the agent, a dialog displays your
options. Click OK to overwrite the existing rulebase, or Cancel to leave the
dialog.
4. To save changes to memory, click Apply Changes to Agent.
If you are using Automatic Configuration mode, the loaded rulebase is copied to
your auto-configuration directory and will be loaded at startup.

NoDataSource errors can result if any rules in the rulebase use data sources that
are unavailable on the agent where the rulebase is loaded. You cannot edit those
rules.

On UNIX, if the TIBCO Hawk software is not installed in the default location
(/usr/tibco/hawk), you must update all rules using the logfile:onNewLine
data source in the sample rulebases. For example, HawkAgent-Unix (in the
directory $HAWK_ROOT/samples) must be updated to reflect the correct path to
$HAWK_ROOT/log.

TIBCO Hawk Installation and Configuration


Using the TIBCO Hawk Sample Applications 125
|

Using the TIBCO Hawk Sample Applications

The TIBCO Hawk software distribution includes source code for sample
applications that demonstrate the use of the TIBCO Hawk Application
Management Interface (AMI). AMI is used to instrument applications so that
TIBCO Hawk agents can directly monitor them. AMI is a specification of TIBCO
Rendezvous messages that define the interactions that take place between a
TIBCO Hawk agent and an AMI application. Please refer to the TIBCO Hawk
Programmer's Guide for a complete description of AMI.

Using AMI Protocol Versus the AMI APIs


There are two ways to write an AMI application. You can use the TIBCO
Rendezvous APIs to directly implement the AMI protocol or you can use the
TIBCO Hawk AMI APIs which implement the AMI protocol for you.
Use of the TIBCO Hawk AMI APIs is recommended because they handle all the
TIBCO Rendezvous and AMI details for you, making programming AMI simpler
and more foolproof. Use of the APIs also ensures that your applications will be
compatible with future releases of TIBCO Hawk and AMI.

Configuring TIBCO Rendezvous Session Parameters


All the sample applications require TIBCO Rendezvous session parameters in
order for those applications to establish a TIBCO Rendezvous session with the
local TIBCO Hawk agent. These session parameters must match the primary
session parameters configured for the TIBCO Hawk agent or one of the AMI
sessions configured for the TIBCO Hawk agent.
The TIBCO Rendezvous session parameters are hard-wired into the code of these
sample applications. To change the session parameters you must edit the files and
change the values of the TIBCO Rendezvous session constant.
For information on configuring primary and AMI session parameters for a TIBCO
Hawk agent on the Windows platform, refer to Using TIBCO Hawk Across Nets
or Subnets, page 113. For UNIX, refer to Chapter 6, Configuring TIBCO Hawk
Software.

Sample AMI Application Names


These samples, like all AMI applications, have both a display name and an
internal name. The internal name is the name by which the TIBCO Hawk system
uniquely identifies this AMI application and distinguishes it from other AMI
applications. The display name is a user-friendly name that is used in the TIBCO
Hawk Display.

TIBCO Hawk Installation and Configuration


126
| Chapter 9 TIBCO Hawk Sample Rulebases and Applications

• To see the list of AMI application internal names for a particular TIBCO Hawk
agent, invoke its Self:getMicroAgentInfo method.
• To view the display name, right-click on the desired agent in TIBCO Hawk
Display, and select GetMicroAgents from the menu. The MicroAgents,
Methods, and Arguments dialog appears. When the sample applications are
successfully executed you should see their names appear on the associated
TIBCO Hawk agent.

TIBCO Rendezvous License Tickets and AMI


TIBCO Rendezvous software is licensed using license tickets, which are character
strings that encode licensing information. License tickets are stored in files such as
tibrv.tkt (for the TIBCO Rendezvous daemon and routing daemon). TIBCO Hawk
employs an embedded TIBCO Rendezvous license that allows the TIBCO Hawk
software to use the TIBCO Rendezvous solely in support of the TIBCO Hawk
product. A TIBCO Rendezvous license ticket is not required to run the TIBCO
Hawk product with the TIBCO Rendezvous daemon (rvd). The use of TIBCO
Hawk with the TIBCO Rendezvous routing daemon (rvrd), however, still requires
a valid TIBCO Rendezvous license ticket.
The AMI APIs allow applications to be AMI instrumented so that they use the
same embedded TIBCO Rendezvous license as the TIBCO Hawk product. This
license only allows the AMI instrumented application to use TIBCO Rendezvous
in support of the AMI communication with the TIBCO Hawk agent. Any other
use of TIBCO Rendezvous by the AMI application would require a valid TIBCO
Rendezvous license ticket.

TIBCO Hawk Installation and Configuration


The Sample AMI API Applications 127
|

The Sample AMI API Applications

The TIBCO Hawk AMI API sample applications can be found in the directory:
$HAWK_ROOT/samples/ami_api directory

This directory contains three sub-directories c, cpp, and java that contain sample
applications for the C, C++, and Java TIBCO Hawk AMI APIs, respectively. These
applications are discussed in the following sections.

TIBCO Hawk AMI C API Sample Applications


The TIBCO Hawk AMI C API sample directory contains four sample applications.
They have the following filenames and AMI application names, with the numbers
1-4 substituted for the x:
TIBCO Hawk AMI C API sample x:
— Filename: ami_samplex.c
— Display name: ami_samplex
— Internal name: COM.TIBCO.hawk.ami_api.c.ami_samplex
The four sample applications can be built by following the instructions in the
Makefile.sample file, which is also located in the sample directory.

• ami_sample1.c
This sample shows how to AMI instrument a non-Rendezvous application.
This method can be used with only a Hawk license. The AMI API does all the
Rendezvous work under the covers.
This method limits the number of dispatching threads to one thread. This is
the only thread which will call the user applications AMI API callback
functions. As a result, the users application can be single threaded. If the users
application is to be multi-threaded then the code in this sample would run on
a dedicated thread. The users application would be responsible for thread
safety regarding any of its own data structures.
• ami_sample2.c
This sample shows how to AMI instrument a Rendezvous application. The
users application creates a Rendezvous transport and queue and is
responsible for dispatching that queue.
The users application is free to be single or multiple threaded. The users
application is responsible for synchronizing access to user application data in
the multi-threaded case.

TIBCO Hawk Installation and Configuration


128
| Chapter 9 TIBCO Hawk Sample Rulebases and Applications

• ami_sample3.c
This sample is identical to ami_sample1.c except that it demonstrates how to
create methods that return tabular data.
• ami_sample4.c
This sample shows how to create an asynchronous AMI method for a
synchronous data source. This technique is used when synchronous data
needs to be polled at a certain rate, possibly calculations performed on the
data across samples, and the results returned at that rate or another rate. This
technique makes use of the auto-invoke feature of the AMI C API.

Executing Sample Programs


• To execute, for example, ami_samplex program, use the following command
line:
ami_samplex

Using Sample Applications on OS/400


The names of the TIBCO Hawk AMI C API sample programs have been truncated
to fit the OS/400 name limit. On OS/400, the sample programs have the following
names, with the numbers 1-4 substituted for the x:
ami_samplx.c

A sample CL program is provided to compile the sample programs. This sample


CL program is included with the HAWKAMI library in QCSRC. The sample CL
program assumes the source for the sample programs is present in
TIBHAWK/QCSRC.

To compile the sample programs, execute the following command:


CALL TIBHAWK/AMICMP AMI_SAMPL1

You can execute the TIBCO HAWK AMI C sample programs as a job or from qsh.
To submit a job, execute the following command:
SBMJOB CMD(CALL PGM(TIBHAWK/AMI_SAMPL1)) JOBQ(QUSRNOMAX)
MSGQ(*USRPRF) ALWMLTTHD(*YES)

TIBCO Hawk AMI C++ API Sample Application


The TIBCO Hawk AMI C++ API sample directory contains one sample
application, which has the following filename and AMI application names:
• AmiSample1.cpp

TIBCO Hawk Installation and Configuration


The Sample AMI API Applications 129
|

Filename: AmiSample1.cpp
Display name: AmiSample1
Internal name: COM.TIBCO.hawk.ami_api.cpp.AmiSample1
This sample creates an AMI session to support methods that demonstrate how
to:
— pass data to an instrumented application,
— receive data from an instrumented application,
— return tabular data,
— return data asynchronously, and
— shutdown an application.
The sample application can be built by following the instructions in the
Makefile.sample file, also located in the sample directory.

Executing the Sample Program


• To execute AmiSample1 program, use the following command line:
AmiSample1

TIBCO Hawk AMI Java API Sample Application


The TIBCO Hawk AMI Java API sample directory contains the following files:
• AmiSample.Java:a sample application designed to illustrate how to
instrument a Java application using the TIBCO Hawk AMI API for Java.
• Spot.java: a simple GUI application using TIBCO Hawk AMI API for Java.
• SpotAmi.java: AMI Java API instrumentation for the Spot application.
This sample demonstrates how an existing application, Spot.java, can be
instrumented with the AMI Java API.
The AMI sample spot.java has the following AMI application names:
• Display name: Spot
• Internal name: COM.TIBCO.hawk.ami_api.java.Spot

Executing the Sample Program


In order to compile and execute this sample, the following must be in your Java
CLASSPATH:

TIBCO Hawk Installation and Configuration


130
| Chapter 9 TIBCO Hawk Sample Rulebases and Applications

• ami.jar and utilities.jar from the TIBCO Hawk java directory


• tibrvj.jar from the TIBCO Rendezvous java directory

It is recommended that you use Java 1.3.1_02 or higher.

The Spot application is executed with the following command:


jre Spot -rvd_session <service> <network> <daemon>

Executing the Prebuilt Sample Program


A pre-built version of the Spot sample program, spot.jar, is supplied in the
directory <TIBCO Hawk installation directory>/lib. Start scripts are provided in the
directory <TIBCO Hawk installation directory>/samples/scripts.
To run this pre-built version do the following:
1. On the command line, set the following environment variables as appropriate
for your environment:
— HAWK_ROOT
— RV_ROOT
— JRE_ROOT

2. Run the appropriate start script in the directory:


<TIBCO Hawk installation directory>/samples/scripts
using the -rvd_session option:
run_spot -rvd_session <service> <network> <daemon>)

For example:
run_spot -rvd_session 7474 123.123.123 tcp:7474

Using the Sample Programs


Each sample program represents a separate application. Compile and link them
using your C/C++ development environment.
Do not use any class libraries (such as MFC) in your build; make the application a
console application only.

To Compile the Program Samples


See the TIBCO Hawk AMI C Reference and TIBCO Hawk AMI C++ Reference books
for information about compiling the program samples.

TIBCO Hawk Installation and Configuration


| 131

Chapter 10 Security

This chapter discusses the two security models supplied with the TIBCO Hawk
system. For details on creating a custom security model, refer to the TIBCO Hawk
Programmer’s Guide.

Topics

• Overview, page 132


• Trusted Model, page 133
• To Use the Trusted Model, page 135
• Certified Model, page 144
• Secure AMI Communication, page 150
• Certificate Authorities, page 153

TIBCO Hawk Installation and Configuration


132
| Chapter 10 Security

Overview

The TIBCO Hawk product supports a security mechanism which enables all
method invocation requests made of a TIBCO Hawk agent to be verified for
authenticity and integrity and then authorized (or not) based on the identity of
the user making the request.
The security implementation you choose will depend on your security
requirements for authorization, authentication, integrity and privacy. You can use
one of the security models provided with the TIBCO Hawk product (Trusted or
Certified), or develop a custom security model (as explained in the TIBCO Hawk
Programmer's Guide).
The definitions of security terms used in this manual are as follows:

Authentication
Authentication is the practice of determining that an entity (e.g. person, process,
etc.) is who they say they are.

Integrity
Data integrity is the ability to guarantee that the content of a message that is sent
from one party to another is received just as it was sent.

Authorization
Authorization is the practice of granting and denying privileges to users of a
service or resource. The ability to authorize a request requires two pieces of
information: the identity of the user and the nature of the request. The system can
then determine if the user has sufficient privileges for the request.

Privacy
Privacy is the ability to guarantee that the content of a message that is sent from
one party to another is hidden from other parties.

TIBCO Hawk Installation and Configuration


Trusted Model 133
|

Trusted Model

The Trusted model provides a simple yet effective mechanism for addressing
authorization concerns. It addresses security issues as follows:
• Authentication: the Trusted security model does not guarantee the
authenticity of the request.
• Integrity: the Trusted security model does not guarantee the integrity of the
request.
• Authorization: the Trusted security model guarantees that only authorized
users can perform restricted actions. See below.
• Privacy: the Trusted security model does not address the privacy of the
request. All requests are sent using plain text.

Authorization
The Trusted model uses an ASCII file as a simple yet effective entitlement server.
This has the benefit of being easily distributed to all nodes, making it a very
scalable mechanism. A scan of the ASCII file for information about the user
determines if the request will be granted.
Users are explicitly granted or denied access through the access control file. A
user who is not in this file is not allowed to perform any operations on the TIBCO
Hawk system. Access control information is in a plain ASCII file located in
<TIBCO Hawk installation directory>/security. See Access Control File, page 135, for
more details.

Logging
All trusted requests (both Trusted and TrustedWithDomain) can be logged to
rolling log files in a directory of your choice.
The current log file is named Trusted.log. When it reaches the maximum size
(size), it is closed and renamed Trusted1.log, and a new Trusted.log is
started. When the number of logs exceeds the maximum (n), log entries roll over
to reuse the oldest log file.
To activate logging, add the following line to the access control file:
<LogService> -log_dir <logDir> -log_max_size <size> -log_max_num <n>

TIBCO Hawk Installation and Configuration


134
| Chapter 10 Security

where:

Option Description
logDir The directory where the log file is saved.
Make sure this directory exists before you activate logging.

size The maximum size of the rolling log file in KB. The suffix m or M can
be used for indicating MB.

n The maximum number of rolling log files.

Example Log File Entries


This is an example log entry for an authorized request:
Tue Dec 31 11:14:13 EST 2002: Trusted operation:
userID=HAWK-TRUSTDMN\hawkuser, node=hawkuser-DT:none:default,
microagent=COM.TIBCO.hawk.microagent.SysInfo, method=
getOperatingSystem.

This is an example of an entry for an unauthorized request:


Tue Dec 31 11:19:54 EST 2002: Trusted operation: userID=
HAWK-TRUSTDMN\hawkuser, node=hawkuser-DT:none:default, microagent=
COM.TIBCO.hawk.microagent.Repository, method= getRBMap -
permission denied.

Using both Trusted and TrustedWithDomain


An agent using the Trusted or TrustedWithDomain security model allows users
with either Trusted or TrustedWithDomain to access the agent.
• To allow access to a user who starts Hawk Display (or the Console API
application) in Trusted security mode, the entry for <user> specified in the
agent’s Trusted.txt or TrustedWithDomain.txt should not include the
domain of the user who actually starts Hawk Display (or the Console API
application).
• To allow access to a user who starts Hawk Display in TrustedWithDomain
security mode, the entry for <user> specified in the agent’s Trusted.txt or
TrustedWithDomain.txt should include the domain of the user who actually
starts Hawk Display.

TIBCO Hawk Installation and Configuration


To Use the Trusted Model 135
|

To Use the Trusted Model

Two sample access control files are included with TIBCO Hawk.
• Trusted.txt can be used on UNIX or Windows. It is used when the
command line specifies Trusted.
• TrustedWithDomain.txt is for use on Windows only, and is used when the
command line specifies TrustedWithDomain.
The access control files, Trusted.txt and TrustedWithDomain.txt, are
described in the next section.
To use the Trusted model:
1. Create a directory called <TIBCO Hawk installation directory>/security/.
2. Modify the appropriate sample access control file, Trusted.txt or
TrustedWithDomain.txt, according to the requirements of your system.

3. Save the modified file in the directory you created, without changing the
filename. The program automatically searches for the access control file in this
directory.
4. Start the TIBCO Hawk agent and Display as follows:
— On UNIX, specify the following in the agent configuration file:
COM.TIBCO.hawk.security.trusted.Trusted

— On Windows, enter one of the following in the Security Policy Class dialog
of the Windows Configuration Utility:
COM.TIBCO.hawk.security.trusted.Trusted

or
COM.TIBCO.hawk.security.trusted.TrustedWithDomain

The Trusted model is now in effect. The security policy will stay in force as long as
the process is running.

Access Control File


To store access control information, the Trusted model uses an ASCII file. Two
sample access control files are included with TIBCO Hawk: Trusted.txt and
TrustedWithDomain.txt.

Sample access control files are shipped with the TIBCO Hawk software, in the
directory <TIBCO Hawk installation directory>/samples/security/.

TIBCO Hawk Installation and Configuration


136
| Chapter 10 Security

Trusted.txt
This access control file can be used with UNIX or with Windows 2000, or XP.
The user for authorization is the login ID of the TIBCO Hawk Display owner.

TrustedWithDomain.txt
This file can only be used with Windows 2000 or XP, and only when specified in
the command used to start TIBCO Hawk agent and Display, as in
-security_policy COM.TIBCO.hawk.security.trusted.TrustedWithDomain.

The user is the login ID and the domain where the user is logged on. For example,
for user1 in domainX, the user is <domainX>\user1.

Group Operations
A group operation effectively performs a method invocation simultaneously on
all of the specified target microagents. It is useful for affecting a group of
microagents in a single operation. There are two kinds of group operation:
network query and network action. See the TIBCO Hawk Administrator’s Guide for
more details.
Wildcard characters + and * affect permissions on group operations and
point-to-point invocations as shown in Access Control File Settings, page 137.
• Use + in node access to allow access to group operations.
• Use * in node access to allow access to point-to-point invocations.
• Use + in method access to allow access to all INFO and ACTION methods.
• Use * in method access to allow access.

Access Control File Conventions


The access control file uses the following conventions to grant or deny access.
• Explicit access for a particular resource implicitly denies access to all other
resources in the same class. The defined classes are nodes, microagents, and
methods.
• Explicit restriction for a particular resource implicitly allows access to all other
resources in the same class, provided they have been explicitly granted. The
defined classes are nodes, microagent, and methods.
• Permissions always default to the most restrictive case.

TIBCO Hawk Installation and Configuration


To Use the Trusted Model 137
|

File Settings for the Trusted Model


This table presents how individual restrictions and permissions are defined for
nodes, microagents, and methods. Individual node, microagent, and method
names can be specified. In addition, wildcard characters can be used as shown in
the table.
Each individual setting is represented by one line in the access control file.
Complex permissions and restrictions can be defined using sets of related lines.
For example, you can give a user access to all methods on a node in one line, then
in the following line, restrict that user’s access to one of those methods. See
Trusted.txt and TrustedWithDomain File Examples, page 140, for further details.
Permissions are granted to a user using the user name. Restrictions are defined by
prefixing a bang (!) character to the user name, as shown in the table.

Table 20 Access Control File Settings

Effect User Node Microagent Method


Full Access <user>

Grants full access to all methods on all microagents


on all nodes, including group operations.

Full Restriction !<user>

Denies access to all methods on all microagents on


all nodes, including group operations

Node Access: All Nodes <user> +

Grants point-to-point and group operation


invocation access to all methods on all microagents.

Node Access: All Nodes <user> *

Grants point-to-point invocation access to all


methods on all microagents.
Does not grant group operation invocation access.

Node Access: Named node <user> <node>

Grants invocation access to all methods on all


microagents on the named node.
You can add several lines for one user to provide
access to a set of nodes.

TIBCO Hawk Installation and Configuration


138
| Chapter 10 Security

Table 20 Access Control File Settings (Cont’d)

Effect (Cont’d) User Node Microagent Method


Node Restriction: All Nodes !<user> *

Denies point-to-point and group operation


invocation access to all methods on all microagents.

Node Restriction: All Nodes !<user> +

Denies group operation invocation access to all


methods on all microagents. (Does not deny
point-to-point operation invocations.)

Node Restriction: Named node !<user> <node>

Denies invocation access to all methods on all


microagents on the named node. You can add
several lines for one user to provide access to a set
of nodes.

Microagent Access <user> <node> <microagent>

Grants access to all methods on the specified


microagent.
Wildcard characters can be used in place of a
specific node name. See Node Access above.

Microagent Restriction !<user> <node> <microagent>

Denies access to all methods on the specified


microagent.
Wildcard characters can be used in the Node
columns. See Node Restriction above.

Method Access <user> <node> <microagent> +

Grants access to all ACTION and INFO methods on


the specified microagent (but not ACTIONINFO
methods).
Wildcard characters can be used in the Node and
Microagent columns.

TIBCO Hawk Installation and Configuration


To Use the Trusted Model 139
|

Table 20 Access Control File Settings (Cont’d)

Effect (Cont’d) User Node Microagent Method


Method Access <user> <node> <microagent> *

Grants access to all INFO methods on the specified


microagent (but not ACTION or ACTIONINFO
methods).
Wildcard characters can be used in the Node and
Microagent columns.

Method Access <user> <node> <microagent> <method>

Grants access to the specified method on the


specified microagent.
Wildcard characters can be used in the Node and
Microagent columns.

Method Restriction !<user> <node> <microagent> *

Denies access to all methods on the specified


microagent.
Wildcard characters can be used in the Node and
Microagent columns.

Method Restriction !<user> <node> <microagent> +

Denies access to all ACTION and ACTION_INFO


methods on the specified microagent.
Wildcard characters can be used in the Node and
Microagent columns.

Method Restriction !<user> <node> <microagent> <method>

Denies access to the specified method on the


specified microagent.
Wildcard characters can be used in the Node and
Microagent columns.

TIBCO Hawk Installation and Configuration


140
| Chapter 10 Security

Trusted.txt and TrustedWithDomain File Examples


The following example files demonstrates how a Trusted.txt and
TrustedWithDomain.txt access control file might be constructed. The
permissions and restrictions defined in this file are explained in the previous
section.

Explanation of Settings
The settings in the example files below provide access to the following users as
shown here:
• Grant user1 point-to-point access to all methods on all microagents, except:
— All ACTION methods on the Custom microagent on all nodes.
— The specified methods on the Repository microagent on all nodes.
— The specified methods on the RuleBaseEngine microagent on nodeA.
• Grant user2 point-to-point and group operation invocation access to all
methods on all microagents, except:
— All ACTION methods on the Custom microagent on all nodes.
— All ACTION methods on the Repository microagent on all nodes.
— All ACTION methods on the RuleBase microagent on all nodes.
• Grant user3 point-to-point and group operation invocation access to all
methods on all microagents on all nodes, except:
— group operation invocation access to all ACTION methods on the RuleBase
microagent.
• Grant user4 full access to all methods on all microagents on nodeB.
• Grant user5 point-to-point access to all INFO methods on all microagents on
all nodes.

Trusted.txt Example File

#
# This file is used by agent running with COM.TIBCO.hawk.security.trusted.Trusted
# security model.
#
#
# Explanation of Settings:
#
# Grant "user1" point-to-point access to all methods on all Microagents, EXCEPT
# - all ACTION methods on the Custom microagent on all nodes.
# - the specified methods on the Repository microagent on all nodes.
# - the specified methods on the RuleBaseEngine microagent on "nodeA".

TIBCO Hawk Installation and Configuration


To Use the Trusted Model 141
|
#
# Grant "user2" point-to-point and network access to all methods on all
# Microagents, EXCEPT
# - all ACTION methods on the Custom microagent on all nodes.
# - all ACTION methods on the Repository microagent on all nodes.
# - all ACTION methods on the RuleBase microagent on all nodes.
#
# Grant "user3" point-to-point and network access to all methods on all
# Microagents on all nodes, EXCEPT
# - network access to all ACTION methods on the RuleBase microagent.
#
# Grant "user4" full access to all methods on all microagents on nodeB.
#
# Grant "user5" point-to-point access to all INFO methods on all microagents
# on all nodes.
#
#
# Wildcard characters + and * usage:
#
# - Use + in node access for allowing access to group operations.
# - Use * in node access for allowing access to point-to-point invocations.
# - Use + in method access for allowing access to all INFO and ACTION methods.
# - Use * in method access for allowing access to all INFO methods only.
#
#
# File format:
#
# user node microagent method
# access access access
# & & &
# restrictions restrictions restrictions
#
user1 *
!user1 * COM.TIBCO.hawk.microagent.Custom +
!user1 * COM.TIBCO.hawk.microagent.Repository addRuleBase
!user1 * COM.TIBCO.hawk.microagent.Repository updateRuleBase
!user1 * COM.TIBCO.hawk.microagent.Repository deleteRuleBase
!user1 * COM.TIBCO.hawk.microagent.Repository setSchedules
!user1 * COM.TIBCO.hawk.microagent.Repository setRBMap
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine addRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine updateRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine deleteRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine unloadRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBaseFromFile
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setSchedules
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setRBMap

user2 + * +
!user2 * COM.TIBCO.hawk.microagent.Custom +
!user2 * COM.TIBCO.hawk.microagent.Repository +
!user2 * COM.TIBCO.hawk.microagent.RuleBaseEngine +

user3
!user3 + COM.TIBCO.hawk.microagent.RuleBaseEngine +

user4 nodeB

TIBCO Hawk Installation and Configuration


142
| Chapter 10 Security

user5 * * *

#
# To activate logging, uncomment the following:
# <LogService> -log_dir logDir -log_max_size size -log_max_num n
#
# where: logDir is the directory where the log file will be stored
# size is the maximum size of a rotating log file in KB.
# A suffix m or M can be used for indicating MB .
# n is the maximum number of rotating log files.

TrustedWithDomain.txt Example File

#
# This file is used by agent running with
# COM.TIBCO.hawk.security.trusted.TrustedWithDomain security model.
#
# To allow a user running with COM.TIBCO.hawk.security.trusted.TrustedWithDomain
# security model on Windows platform to access this agent, the user
# specified should include the domain of the user.
# For example, for user1 in domainX, the user should be specified as
# "domainX\user1".
#
# Note that agents using the TrustedWithDomain security model also allow
# users running with COM.TIBCO.hawk.security.trusted.Trusted security model
# to access this agent. For these users, the domain should not be
# included in the user.
#
#
# Explanation of Settings:
#
# Grant "user1" point-to-point access to all methods on all Microagents, EXCEPT
#- all ACTION methods on the Custom microagent on all nodes.
# - the specified methods on the Repository microagent on all nodes.
# - the specified methods on the RuleBaseEngine microagent on "nodeA".
#
# Grant "user2" point-to-point and network access to all methods on all
# Microagents, EXCEPT
#- all ACTION methods on the Custom microagent on all nodes.
#- all ACTION methods on the Repository microagent on all nodes.
#- all ACTION methods on the RuleBase microagent on all nodes.
#
# Grant "user3" point-to-point and network access to all methods on all
# Microagents on all nodes, EXCEPT
#- network access to all ACTION methods on the RuleBase microagent.
#
# Grant "user4" full access to all methods on all microagents on nodeB.
#
# Grant "user5" point-to-point access to all INFO methods on all microagents
# on all nodes.
#
#

TIBCO Hawk Installation and Configuration


To Use the Trusted Model 143
|
# Wildcard characters + and * usage:
#
# - Use + in node access for allowing access to group operations.
# - Use * in node access for allowing access to point-to-point invocations.
# - Use + in method access for allowing access to all INFO and ACTION methods.
# - Use * in method access for allowing access to all INFO methods only.
#
#
# File format:
#
# user node microagent method
# access access access
# & & &
# restrictions restrictions restrictions
#
user1 *
!user1 * COM.TIBCO.hawk.microagent.Custom +
!user1 * COM.TIBCO.hawk.microagent.Repository addRuleBase
!user1 * COM.TIBCO.hawk.microagent.Repository updateRuleBase
!user1 * COM.TIBCO.hawk.microagent.Repository deleteRuleBase
!user1 * COM.TIBCO.hawk.microagent.Repository setSchedules
!user1 * COM.TIBCO.hawk.microagent.Repository setRBMap
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine addRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine updateRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine deleteRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine unloadRuleBase
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBaseFromFile
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setSchedules
!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setRBMap

user2 + * +
!user2 * COM.TIBCO.hawk.microagent.Custom +
!user2 * COM.TIBCO.hawk.microagent.Repository +
!user2 * COM.TIBCO.hawk.microagent.RuleBaseEngine +

user3
!user3 + COM.TIBCO.hawk.microagent.RuleBaseEngine +

user4 nodeB

user5 * * *

#
# To activate logging, uncomment the following:
# <LogService> -log_dir logDir -log_max_size size -log_max_num n
#
# where: logDir is the directory where the log file will be stored
# size is the maximum size of a rotating log file in KB.
# A suffix m or M can be used for indicating MB .
# n is the maximum number of rotating log files.

TIBCO Hawk Installation and Configuration


144
| Chapter 10 Security

Certified Model

The certified model provides a high degree of security for the TIBCO Hawk
system.

Authentication
Authentication can be done via shared secret (e.g., password) or via certificates
and digital signatures.
The Certified model uses the decryption capability provided by TIBCO
Rendezvous DataSecurity to decrypt a file on disk containing the private key of
the principal after prompting the user for a password. It then uses the certificate
that was sent along with the message to verify the signature and identify the
sender enabling a decision to be reached regarding the processing of the request.

Integrity
Digital signature techniques can be used to apply a one-way hash algorithm on
the message and encrypt the hash value using a private key. This process, known
as signing, enables the holder of the corresponding certificate to verify the
integrity of the message. The sender will use the certificate that accompanied the
message to calculate the one-way hash value. Comparing with the signature can
verify the integrity of all messages. The use of the one-way hash algorithm is a
powerful tool for determining if a document has been tampered with.

Authorization
The Certified model uses the Certified.txt properties file to store
information about the TIBCO Rendezvous Access Control Daemon (rvacld) and
Hawk users and agents. Entitlements are handled by configuring the rvacld
daemon, which then functions as the entitlement server. A user or agent that is
not specified in the rvacld configuration referred to in the Certified.txt file is
not allowed to perform any operations on the TIBCO Hawk system.
The Certified.txt properties file must be formatted according to specifications
for J2SE 1.4 and above, available at
www.javasoft.com/j2se/1.3/docs/api/java/util/Properties.html.

Certificates
The Certified model can use either login/password authentication (default) or
certificates with corresponding private keys for each user of the TIBCO Hawk
system.

TIBCO Hawk Installation and Configuration


Certified Model 145
|

The encrypted certificate and private key must be in a X509 encoded PEM
formatted file in a directory called .hawk in the home directory of the owner of
the TIBCO Hawk Display process, in a file called username.key. The system will
look for this file in the user’s system and use it as the user’s certificate. Otherwise,
the system will assume that the user is authenticated by password only, and the
user will be prompted.

Note: You are responsible for obtaining, managing, maintaining, and


distributing certificates and private keys. There are several well-known third
party Certificate Authorities from which you can choose. It is also possible for
you to act as a trusted Certificate Authority by importing an external root
certificate. The procedure for importing an external root certificate and a list of
Certificate Authorities trusted by the TIBCO Hawk software are provided in the
section Certificate Authorities, page 153.

TIBCO Rendezvous DataSecurity


The Certificate model employs TIBCO Rendezvous DataSecurity Version 2.0 or
higher for addressing authentication and integrity concerns. It is your
responsibility to obtain and install the Rendezvous DataSecurity package prior to
using the Certified security model. As part of DataSecurity installation, you will
be prompted to add tibrvdsj.jar to your CLASSPATH. It is important that you
perform a complete and successful installation of the DataSecurity software
before attempting to use the product with TIBCO Hawk.

TIBCO Hawk Installation and Configuration


146
| Chapter 10 Security

Architecture
The architecture supporting the certified model is shown in Figure 12.

Figure 12 Certified Model Architecture


TIBCO Hawk Agent
AMI Application

Rendezvous
Encrypted DataSecurity
Certificate File
CA Root
TIBCO Rendezvous Certificate
DataSecurity

RVDS Key RVDS


Holder Context

Embedded Certificate
TIBCO Rendezvous Transport

Access control
To set access control using the Certified model you must first ensure that you
have a valid Certified.txt properties file, then configure the rvacld..

Creating the Certified.txt file


The Certified.txt properties file must contain the following information:
• certificates and/or passwords, or pointers to files containing the same
• rvacld parameters indicating the rv service, network, daemon, and acld
certification
• the Hawk agent
• the user(s)
Passwords and/or certificates may be included directly in the file, or may be put
in a separate file, as follows, for the password:
agent.key.passwd = somepassword

TIBCO Hawk Installation and Configuration


Certified Model 147
|

- or -
agent.key.passwd.file = mypasswordfile

and for the certificate:


agent.key = -----BEGIN CERTIFICATE-----\n \

#<certificate PEM text>

#(see Certificates, page 175)


-or-
#agent.key.file = agent.pem

Include information about the rvacld parameters as in the following sample:


rv.service =<servicename>
rv.network =<networkname>
rv.daemon =<rvdeamonname>
acld.name = HawkACL
#acld.cert = ....<certificate text, if used>
acld.cert.file = acld.cert

Include information about the agent as follows:


The agent's user name:
agent.user = hawkAgent

Specify the certificate that identified the agent:


#agent.key = ....
agent.key.file = agent.pem
agent.key.passwd = somepassword

Or, if the agent is only identified by a password, comment out the agent.key.* lines
and use on of these:
#agent.passwd = apassword
#agent.passwd.file = agent.pass

In addition to the above, each user has to be identified, but that doesn't happen
here. The username is taken from the system property named user.name. If
absent, the default value of anonymous is used.
If the user has a directory named .hawk in their home directory, then it is searched
for a file named username.key, and this is used as the user's certificate. Otherwise it
is assumed that the user is identified by a password only, and he/she is prompted
for this.
If the console cannot prompt the user (for example, if the security code is being
used in DAEMON mode), then the ~/.hawk directory is checked for a file named
username.pass, and the content of this file is used as the user's password.

Configuring access control in rvacld for the Certificate Model


To configure the rvacld, you will need to perform the following tasks:

TIBCO Hawk Installation and Configuration


148
| Chapter 10 Security

• create tag names


• create users and agent-users
• assign user permissions
• assign agent permissions

Creating tag names


Each microagent that will be invoked needs a corresponding set of tags with
names of the following form "hawk.<type>.<microagent name>". So for instance, the
Repository microagent would require the following tags:
hawk.ACTION_INFO.COM.TIBCO.hawk.microagent.Repository
hawk.INFO.COM.TIBCO.hawk.microagent.Repository
hawk.ACTION.COM.TIBCO.hawk.microagent.Repository

Creating Users
Create a user entry in the rvacld for each Hawk user that will be permissioned.
The TIBCO RVDS manuals give information about how to create users, and give
them certificates if desired.
Create a user for each agent, or set of agents that will be controlled. (You can have
all of your agents log in as the same "user" if you want, or assign a different "user"
for each agent.)

Assign user permissions


Each user that can perform an action should be given "rw" permission on the
corresponding tag.

Assign agent permissions


Each agent that can receive an action should be given "r" permission on the
corresponding tag.

To Use the Certified Model


In order to use the Certified model, you must first do the following:
• Obtain the required certificates. See Certificates, page 144, and Certificate
Authorities, page 153, for details.
• Define the properties file, certified.txt, and place it in the <TIBCO Hawk
installation directory>/security/ directory, which you must create.

• Install TIBCO Rendezvous DataSecurity software. See TIBCO Rendezvous


DataSecurity, page 145.

TIBCO Hawk Installation and Configuration


Certified Model 149
|

• Configure the acld daemon.


Once the access control file has been configured, you use the Certified model by
starting the TIBCO Hawk agent and Display as follows:
• On UNIX, specify the following in the agent configuration file:
-security_policy COM.TIBCO.hawk.security.certified.Certified

• On Windows, enter the following in the Security Policy Class dialog of the
Windows Configuration Utility:
COM.TIBCO.hawk.security.certified.Certified

The program will automatically search for the access control file in the <TIBCO
Hawk installation directory>/security directory. Note that you must create this
directory manually.
The security policy will stay in force as long as the process is running.

TIBCO Hawk Installation and Configuration


150
| Chapter 10 Security

Secure AMI Communication

The TIBCO Hawk agent supports secure AMI communication using TIBCO
Rendezvous DataSecurity. This enables the AMI applications to verify the
authenticity and integrity of all requests.
The TIBCO Hawk agent and HMA support an option to specify the use of TIBCO
Rendezvous DataSecurity for communicating with AMI applications
(-ami_rvds_session). This permits a single TIBCO Hawk agent and HMA to be
shipped regardless of security concerns. It is necessary for the TIBCO Hawk
agent, HMA, and AMI applications to distinguish between secure and non-secure
communication because TIBCO Rendezvous DataSecurity requires decryption of
all messages, even messages that are signed but NOT encrypted.
The architecture supporting secure AMI communication is shown in Figure 13.

Figure 13 AMI Communication Architecture


TIBCO Hawk TIBCO Hawk
Display Agent

Certificate agent
Encrypted
Certificate File
CA Root
Certificate
Certificate console
Trusted Users
File
RVDS Key RVDS
Holder Context

Embedded Certificate
TIBCO Rendezvous Transport

You are responsible for obtaining, managing, maintaining, and distributing


certificates and private keys. There are several well-known third party Certificate
Authorities from which you can choose. It is also possible for you to act as a
trusted Certificate Authority by importing an external root certificate. The
procedure for importing an external root certificate and a list of Certificate
Authorities trusted by the TIBCO Hawk software are provided in the section
Certificate Authorities, page 153.

TIBCO Hawk Installation and Configuration


Secure AMI Communication 151
|

The TIBCO Hawk agent supports a mechanism by which the TIBCO Hawk
administrator can import a certificate and private key for use by TIBCO
Rendezvous DataSecurity for AMI communication. The TIBCO Hawk agent will
look for the following file: <TIBCO Hawk installation directory>/security/
password.ami. This contains the password needed by the TIBCO Rendezvous
DataSecurity decryption facility to decrypt the file on disk containing the
certificate and private key. The encrypted certificate and private key must be in a
X509 encoded DER formatted file in the following location: <TIBCO Hawk
installation directory>/security/certificate.ami. The TIBCO Hawk agent will
pack all AMI messages using the private key. An AMI application will use the
certificate that accompanies the message to verify the authenticity and integrity of
the message.
Since the private key used to pack AMI messages is provided to the TIBCO Hawk
agent at run-time, it is also necessary to provide the corresponding certificate to
any AMI applications wishing to perform authorization. Applications should
look in the following location: <TIBCO Hawk installation directory>/security/
certificate.ami. Only requests that have been signed using the private key
associated with this certificate will be considered authorized.

Running with a localhost rvd


As a further precaution, AMI applications will be required to specify localhost
as part of the TIBCO Rendezvous daemon parameter in order to prevent remote
connections to its rvd daemon. Instructions to do this for UNIX and Windows
platforms are given below.

UNIX Procedure
1. Add a command to start the localhost rvd prior to starting any TIBCO Hawk
processes, as follows:
rvd -listen tcp:127.0.0.1:<daemon>

2. Modify hawkagent.cfg and hawkhma.cfg and, in the -rvd_session


parameter, specify the following:
tcp:127.0.0.1:<daemon>

Windows Procedure
Use rvntsreg.exe to install a localhost rvd as a Windows service. The procedure
is similar to that given in Setting Up Network Communication in Windows,
page 118. See that section for a fuller description.
1. Create an rvd service using rvntsreg.exe. See Installing a Routing Daemon
as a Windows Service, page 118, for details. Use the following parameters:

TIBCO Hawk Installation and Configuration


152
| Chapter 10 Security

-listen tcp:127.0.0.1:<daemon>

2. Make all TIBCO Hawk services dependent upon this new rvd service. See
Making TIBCO Hawk Services Depend on the Routing Daemon Windows
Service, page 118, for details.
3. In the Configuration Utility, modify the daemon parameter to the following:
tcp:127.0.0.1:<daemon>

TIBCO Hawk Installation and Configuration


Certificate Authorities 153
|

Certificate Authorities

Certificates issued by the third-party Certificate Authorities listed below are


trusted by the TIBCO Hawk agent and the Certified security model. You can also
use an external Root certificate, as explained next.

Importing an External Root Certificate


If you wish to obtain User certificates from a third-party not on the list below, or if
you want to act as your own certificate authority, then you must provide them
appropriate Root certificate for import into the model. Once the Root certificate is
imported by the model, it will trust the certificate authority associated with the
certificate.
To import an external Root certificate, place the certificate in the <TIBCO Hawk
installation directory>/security directory, in a file with the suffix .root.

Third-Party Certificate Authorities


The list below gives sources for User certificates that are trusted by the Certified
model.
• GTECyberTrustGlobalRoot
• GTECyberTrustRoot
• KeyWitnessGlobal2048Root
• MicrosoftRootAuthority
• MicrosoftRootSGCAuthority
• ThawtePersonalBasicCA
• ThawtePersonalFreemailCA
• ThawtePersonalPremiumCA
• ThawtePremiumServerCA
• ThawteServerCA
• ThawteTimestampingCA
• VeriSignClass1PrimaryCA20180518
• VeriSignClass1PrimaryCA20200107
• VeriSignClass2PrimaryCA20040107
• VeriSignClass2PrimaryCA20180518

TIBCO Hawk Installation and Configuration


154
| Chapter 10 Security

• VeriSignClass3PrimaryCA20040107
• VeriSignClass3PrimaryCA20180518
• VeriSignClass4PrimaryCA
• VeriSignCommercialSoftwarePublishersCA20040107
• VeriSignIndividualSoftwarePublishersCA20040107
• VeriSignTimeStampingCA

TIBCO Hawk Installation and Configuration


| 155

Appendix A Migration

This appendix discusses issues related to migration.

Topics

• Re-Linking C and C++ Applications to Libraries, page 156


• Changing the Codepage Setting, page 156
• Using 3.x and 4.x Agents Together, page 156
• Migrating Rulebase Map from Previous JRE Environments, page 156
• Using the Scheduler, page 157
• Converting Commands from Previous Releases, page 157

TIBCO Hawk Installation and Configuration


156
| Appendix A Migration

Migration Issues

The following considerations apply when migrating from a previous version of


TIBCO Hawk.

Re-Linking C and C++ Applications to Libraries


The AMI C and C++ libraries were renamed to eliminate a naming conflict with
OS libraries. After installing TIBCO Hawk, all AMI C or C++ applications must be
re-linked against the renamed libraries.

Changing the Codepage Setting


(Windows only)
The TIBCO Hawk installation program automatically retains your previous
configuration. If the previous version of TIBCO Hawk specified a codepage
setting for the HMA other than 65001 (Windows identifier for UTF-8), you will
need to manually change the codepage setting to 65001 after installing this
version. UTF-8 is now the default for all TIBCO Hawk components.

Using 3.x and 4.x Agents Together


You can include TIBCO Hawk 4.x and 3.x Agents in the same environment.
However, if you load the same rulebase on each agent, TIBCO Hawk Display will
show the rulebases as being different versions.

Migrating Rulebase Map from Previous JRE Environments


The OS name returned by the SysInfo::getOperatingSystem() depends on the
version of JRE being used. When using JRE 1.1, the OS name returned is ’Solaris’
and is ’SunOS’ when using JRE 1.2.2. This can become a problem when using
rulebase maps in a mixed environment of both JRE 1.1 and 1.2.
Therefore, any rulebase intended for all Solaris machines should be added to both
the ++Solaris group and the ++SunOS group in the map.

TIBCO Hawk Installation and Configuration


Migration Issues 157
|

Using the Scheduler


The Scheduler in TIBCO Hawk 4.1 uses 1-minute intervals instead of 15-minute
intervals, as were used in 4.0.x. TIBCO Hawk 4.0.x agents using schedules that are
sent to 4.1 will be converted to minutes instead of the 15-minute interval.
Likewise, TIBCO Hawk 4.1 schedules that are send to a 4.0.x agent will have the
minute converted to the nearest 15-minute interval.

Converting Commands from Previous Releases


Commands created prior to the TIBCO Hawk 4.1.0 will automatically be
converted when executed using the current release.
• If an agent command in a previous release has Append Agent Name checked,
the variable ${Internal.Agent Name} will be appended to the command.
• If an agent command in a previous release has Append Agent IP Address
checked, the variable ${Internal. Agent IP Address} will be appended to
the command.

TIBCO Hawk Installation and Configuration


158
| Appendix A Migration

TIBCO Hawk Installation and Configuration


| 159

Appendix B Troubleshooting

This appendix presents some common problems and error conditions


encountered during TIBCO Hawk installation and describes how to resolve them.

Topics

• UNIX Errors, page 160


• Windows Errors, page 162
• General Errors, page 163

TIBCO Hawk Installation and Configuration


160
| Appendix B Troubleshooting

UNIX Errors

This section lists possible installation errors on UNIX along with solutions.

DISPLAY Variable Error


(Only when installing in a GUI environment)
The installer on UNIX must open an additional window, generally for graphics. It
uses the DISPLAY environment variable to tell it on which computer to open the
window. If the environment variable is not set, the installer will either wait or
abort after displaying the following message:
InstallShield Wizard
Initializing InstallShield Wizard...
Preparing Java(tm) Virtual Machine...
...................................
...................................
........

The DISPLAY variable must be set to the IP address or name of the computer (on
which the installer graphics window are to be displayed), followed by a screen
address, which can be :0.0. For example:
# Bourne shell
DISPLAY=<ip_address>:0.0; export DISPLAY

# Korn shell
export DISPLAY=<ip_address>:0.0

# C-shell
setenv DISPLAY <ip_address>:0.0

For example, consider a scenario where you install TIBCO Hawk on a remote
HP-UX machine (named itaska). Because you have a Solaris machine (named
alaska) with a video card and monitor, you can run an X-window application on
it. So you decide to telnet to itaska from alaska.
When you telnet to itaska, you will not get access to itaska's monitor and will
be unable to display an X-window application. That is why you must set the
DISPLAY variable, which instructs the X-server to redirect all windows to the
computer set in the variable. Before doing so, the computer (specified in the
DISPLAY variable) must give permissions to share its monitor.

alaska> xhost + # give permission for all to its share monitor


alaska> telnet itaska
Welcome to HPUX itaska 11.00
User:
Password:
itaska> export DISPLAY=alaska:0.0 # set display on alaska
itaska> TIB_hawk-simple_4.2.1_s4_56.bin

TIBCO Hawk Installation and Configuration


UNIX Errors 161
|

PID Error (HP-UX 11.00 64 bit Platform Only)

The following error can occur only on HP-UX 11.00 64 bit systems. It does not
happen on an HP-UX 11.00 32 bit system or an HP-UX 11.11 (or 11.i) system.

Installation on a HP-UX 11.00 64 bit system may crash with the following error
message:
Pid nnn killed due to trashed stack.
Pid nnn was killed due to failure in writing the signal context.

If this error occurs, install HP-UX kernel patch PHKL_27282 and then install
TIBCO Hawk.

Assertion Failed Error (HP-UX Only)


When installing as root user on HP-UX, you may get the following error:
Assertion failed: so->so_hard_contents, file softobj.c, line 363

If this happens, reinstall TIBCO Hawk as non-root user.

SIGABRT Error (AIX 4.3 Only)


On the AIX 4.3 system, the TIBCO Hawk installer may produce the following
error message and create a core file. This happens after the Finish button is clicked
at the end of installation or if the installation is aborted.

SIGABRT received at d0103df4 in /usr/lib/libpthreads.a.


Writing stack trace to ... OK.

The installation however, completes successfully.


To avoid getting this error message during installation, apply 5.0.0.4 xlC libraries
as indicated by APAR IY14529 and proceed with the installation.

TIBCO Hawk Installation and Configuration


162
| Appendix B Troubleshooting

Windows Errors

This section lists possible installation errors on Windows along with solutions.

Packet Fragmentation Errors with Multicast


You may encounter packet fragmentation errors when using multicast on
Windows XP or Windows 2000. This is due to a known issue in Microsoft
Windows.
You may need to apply a Microsoft hot fix (this fix is not included in Windows
2000 SP3). Information about obtaining the fix is in Microsoft Knowledge Base
Article Q319627.

String Variable Error


In Windows, a command line has a limit of 1024 characters. The startup command
for TIBCO Hawk (which includes the installation path and a large number of
required jar files) may be longer than 1024 characters if TIBCO Hawk was
installed into a directory with a long installation pathname.
If the startup command is too long, the following error message appears when
you try to start TIBCO Hawk:
String variable is not large enough for string.
Check the string declarations.
Error 401

In this case, you must reinstall Hawk with a shorter installation path.

TIBCO Hawk Installation and Configuration


General Errors 163
|

General Errors

This section lists installation errors that can occur on both UNIX and Windows.

Cannot Initialize Display


TIBCO Hawk Display stops after the Initializing subscriptions screen and
displays the message Unable to Initialize TIBCO Hawk Display.
This is usually caused by missing files in the CLASSPATH. Check your CLASSPATH
environment variable and make sure it includes the file:
<TIBCO Rendezvous installation directory>/lib/tibrvj.jar

Specify only tibrvj.jar in your CLASSPATH.

TIBCO Hawk Service Failed to Install (Error 1057)


Either form of the following error message can be generated by the Windows
Service Manager:
Hawk agent service failed to install. Error code is 1057
Event Service Failed to Install. Status is 1057

This means that the user account specified for starting the TIBCO Hawk services
does not have sufficient privileges to start the services.
Because this error occurs during installation, you will not be able to change the
account used to start the services (the services will not appear in the list of
services in your Services control panel).
To resolve the situation, uninstall the TIBCO Hawk software, then install the
software again giving a valid account. To uninstall the software, select
Start>Programs>TIBCO Hawk Software>UnInstall.

No Administrator Privilege
During TIBCO Hawk installation on Windows, if you encounter the following
message:
Severe - You must have administrator privilege to install Hawk
Services.

You need to log back into the machine as a user with local administrator
privileges to correctly install TIBCO Hawk software.

TIBCO Hawk Installation and Configuration


164
| Appendix B Troubleshooting

Installation Problems (Error 1073)


If you encounter any of the following messages, you need to re-install TIBCO
Hawk:
• HMA Service failed to install. Error code is 1073
• Hawk Agent Service failed to install. Error code is 1073
• Event Service failed to install. Status is 1073

Service Not Started (Error 1069)


The system displays the following message:
Could not start the TIBCO Hawk service ... Error 1069: The
service did not start due to a logon failure."

This error indicates one of the following situations:


• An invalid account was specified.
• The account on which the TIBCO Hawk services are being run does not have
administrative privileges.
• The account on which the TIBCO Hawk services are being run does not have
"Log on as a service" privileges. Make sure the account has the correct
privileges.
• The wrong password was given for the account on which the TIBCO Hawk
services are being run.
See Installing on Microsoft Windows, page 11, for more information on these
settings.

TIBCO Hawk Services Fail to Start After Installation


After you have completed TIBCO Hawk installation on Windows, if none of the
TIBCO Hawk services will start, use the Event Viewer to check for error messages
related to the TIBCO Hawk services in the Application Log.
If any messages contain the text "... could not be spawned", make sure that
TIBCO Rendezvous is correctly installed, and that you rebooted the machine after
both the TIBCO Rendezvous and TIBCO Hawk installations. (After each new
installation or re-installation of TIBCO Rendezvous or TIBCO Hawk software on
Windows, you must reboot the machine before using the software.)

Internal Error 2140


The system displays the following message:
Error 2140: An internal Windows error occurred.

TIBCO Hawk Installation and Configuration


General Errors 165
|

This message probably means the services cannot find crucial TIBCO Rendezvous
files. Usually this is because one of two environment variables, CLASSPATH or
PATH, is set incorrectly.
To view and change environment variables:
1. Choose Start>Settings>Control Panel, double-click the System icon, and click
the Environment tab.
2. In System Variables, check that your CLASSPATH variable includes the file
<TIBCO Rendezvous installation directory>\lib\tibrvj.jar.

3. In System Variables, check that your PATH environment variable includes the
directory <TIBCO Rendezvous installation directory>\bin.
To change an environment variable:
1. Select the variable in the System Variables list.
2. Change the text in the edit box labeled Value.
3. Click Set.
If, after checking these variables, you still get the error, try removing all other files
from your CLASSPATH, so that it includes only the tibrvj.jar file (writing
down the names of the removed files is recommended, to make sure none are
omitted on re-installation). Reboot and try the services again. If this corrects the
error, re-add other files to the CLASSPATH one at a time, after the TIBCO
Rendezvous file.
You can also determine your CLASSPATH and PATH settings by opening a DOS
command-line window and typing echo %CLASSPATH% or echo %PATH%.
Because TIBCO Hawk is a Windows service, all changes made to the environment
and registry require that the Windows machine be rebooted for the changes to
propagate to the Windows Service.
If you have checked all of these possibilities, and you still get Error 2140, verify
that the Windows Service Pack 4 was reinstalled after any recent major changes
were made, before contacting TIBCO Hawk technical support.

TIBCO Hawk Installation and Configuration


166
| Appendix B Troubleshooting

TIBCO Hawk Installation and Configuration


| 167

Appendix C TIBCO Hawk Directories and Files

This appendix lists the files installed with TIBCO Hawk on Windows and UNIX
platforms.

Topics

• TIBCO Hawk Directory Structure, page 168

TIBCO Hawk Installation and Configuration


168
| Appendix C TIBCO Hawk Directories and Files

TIBCO Hawk Directory Structure

Table 21 explains the directory structure and general placement of files in the
TIBCO Hawk software installation subdirectories. The data directory is created
only if the TIBCO Hawk event service is installed, and files are placed in it only
when the event service is started.
.

Table 21 TIBCO Hawk Files and Directories

Directory Description Contents


<TIBCO Hawk The directory in which readme.txt
installation directory> TIBCO Hawk software is
installed. license.txt

autoconfig Used to store rulebase files <platform>.hrb


that will be loaded by the
TIBCO Hawk agent
automatically at startup.

bin Contains TIBCO Hawk hawkagent.cfg


executable files and hawkdisplay.cfg
starting scripts.
hawkevent.cfg
hawkhma.cfg

Additional files for UNIX, Linux, and OS/400


tibhawkhma
startagent
startdisplay
startevent
starthma

TIBCO Hawk Installation and Configuration


TIBCO Hawk Directory Structure 169
|

Table 21 TIBCO Hawk Files and Directories (Cont’d)

Directory Description Contents


bin Cont’d Additional files for Windows
EventLogClass.dll
tibhawkmsg.dll
tibhawkregistry.dll
tibhawkservice.dll
tibhawkconfig.exe
tibhawkdisplay.exe
tibhawkhma.exe
tibhawkagentnt.exe
tibhawkeventnt.exe
HawkRandomAccessFile.dll
HawkTrustedUserID.dll
killproc.exe
mfc42.dll
pdh.dll
psapi.dll
tibhawkami.dll
Uninst.dll

config Used to store rulebase files TibRendezvous.hrb


if using manual rulebase
configuration.

data Contains TIBCO Hawk Event.dat


event service data files. Event1.dat
Files are placed in this
.
directory only when the
event service is started. .
.

TIBCO Hawk Installation and Configuration


170
| Appendix C TIBCO Hawk Directories and Files

Table 21 TIBCO Hawk Files and Directories (Cont’d)

Directory Description Contents


include Contains all header files ami.h
required for sample AmiAsyncMethod.h
programs
amicpp.h
AmiList.h
AmiMethod.h
AmiParameter.h
AmiParameterIn.h
AmiParameterList.h
AmiParameterListIn.h
AmiParameterListOut.h
AmiParameterOut.h
AmiSession.h
AmiStatus.h
AmiSubscription.h
AmiSyncMethod.h

lib Contains TIBCO Hawk activation.jar


Java class.jar files. agent.jar
ami.jar
config.jar
console.jar
crimson.jar
display.jar
event.jar
jcchart.jar
jkitgo.jar
mail.jar
perltools.jar
publisher.jar
rvutils.jar
security.jar
spot.jar
talon.jar
util.jar
utilities.jar
workbench.jar

TIBCO Hawk Installation and Configuration


TIBCO Hawk Directory Structure 171
|

Table 21 TIBCO Hawk Files and Directories (Cont’d)

Directory Description Contents


Log Contains log files written Hawk.log
by TIBCO Hawk agents Display.log
and TIBCO Hawk Display.
HMA.log
Event.log

resource Contains files used by HawkGui.properties


TIBCO Hawk Display.

samples Contains sample ami_api


applications with AMI c
interfaces, sample
ami_sample1.c
rulebases, scripts, and
other files. ami_sample2.c
ami_sample3.c
MakeFile.sample
cpp
AmiAsample1.cpp
Makefile.sample
java
Spot.java
SpotAmi.Java

console_api
ConsoleApp.java
GroupOpSample.Java
TestConsole.java

ma_plugin
DemoMicroagent.java
DM1.java
DM2.java
DM1_Dynamic.java
DM2_Dynamic.java

TIBCO Hawk Installation and Configuration


172
| Appendix C TIBCO Hawk Directories and Files

Table 21 TIBCO Hawk Files and Directories (Cont’d)

Directory Description Contents


samples Cont’d Contains sample rbmap_api
applications with AMI RBMapCreateandSave.java
interfaces, sample
RBMapGetandSet.java
rulebases, scripts, and
other files. RBMapSampleConsole.java
RBMapSampleConstant.java

rulebases
AIX.hrb
HP-UX.hrb
HawkAgent-Unix.hrb
HawkWindowsEventLog.hrb
Linux2x.hrb
Sleep.hrb
Solaris2x.hrb
Spot.hrb
TibRendezvous.hrb
Tru64UNIX.hrb
Win2000.hrb
WinNT.hrb
WinNT_Server.hrb
WinXP.hrb
rbmap.hrm
schedules.hsf

schedule_api
ScheduleCreateAndSave.java
ScheduleGetandSet.java
ScheduleSampleConsole.java
ScheduleSampleConstant.java
ScheduleWithPeriodGroup.java

TIBCO Hawk Installation and Configuration


TIBCO Hawk Directory Structure 173
|

Table 21 TIBCO Hawk Files and Directories (Cont’d)

Directory Description Contents


samples Cont’d scripts
amiworkbench
run_spot

security
Certified.txt
Test.java
TestOperation.java
Trusted.txt
TrustedWithDomain.txt

Additional files on Windows


scripts
run_spot.bat
amiworkbench.bat

Additional files on UNIX


etc
hawk2
scripts
run_spot
amiworkbench

Files on OS/400
ami_api
c
ami_sample1.c
ami_sample2.c
java
AmiSample.java

TIBCO Hawk Installation and Configuration


174
| Appendix C TIBCO Hawk Directories and Files

TIBCO Hawk Installation and Configuration


| 175

Appendix D Certificates

This appendix describes certificates.

Topics

• Example Certificate File, page 176

TIBCO Hawk Installation and Configuration


176
| Appendix D Certificates

Example Certificate File

The certificate and private key for an agent can be included in the Certified.txt
file, or a pointer can be provided to a separate file containing this information.
PEM encoding is always used for certificates, so they look like text, as in the
following example.
Remove the # at the beginning of each line to uncomment the line.
#agent.key = -----BEGIN CERTIFICATE-----\n \
#MIIDGDCCAoGgAwIBAgIBAjANBgkqhkiG9w0BAQQFADBgMQswCQYDVQQGEwJVUzET\n \
#MBEGA1UECBMKTmV3IEZvb2JhcjEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0cyBQ\n \
#dHkgTHRkMRkwFwYDVQQDExBDQSBBZG1pbmlzdHJhdG9yMB4XDTAxMDcwMzE3MzQ0\n \
#NloXDTAyMDcwMzE3MzQ0NlowWjELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUt\n \
#U3RhdGUxITAfBgNVBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDETMBEGA1UE\n \
#AxMKSGF3ayBBZ2VudDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAsi0mvVAq\n \
#Ak/S6HN97GXU0ztJLxEmBkZuxde99H7cUJjAJyoENpgWb6ZIhbDSQSL6yMWY/B+Z\n \
#9SnLHs+f9n6qrAOn1Xlrvlne8UhnuBSZ3HL5OUWCjaHYijRmnK1FkFMsBJ1X23T5\n \
#kL2plTrEABQzQHX67lAmkbZ8tyanPP5teIkCAwEAAaOB5zCB5DAJBgNVHRMEAjAA\n \
#MCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAd\n \
#BgNVHQ4EFgQU1oO0yNN8Tpicz+4CaROknQV9Cj0wgYkGA1UdIwSBgTB/gBS6Jwjz\n \
#PR4x4/WgY/OV2+WmXLBQmqFkpGIwYDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCk5l\n \
#dyBGb29iYXIxITAfBgNVBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEZMBcG\n \
#A1UEAxMQQ0EgQWRtaW5pc3RyYXRvcoIBADANBgkqhkiG9w0BAQQFAAOBgQCd56Y6\n \
#eEgRuz1KfWBq25/MRhGxtWVJscuraOUUPFlcYeUlSpdRsxKBq9VgdHcAQgut5ZgJ\n \
#DM0oyg2lHcZAWAt9dIWtFqCg2p8mdIxMzi2pLC+eZEgx7t7NUwtQL6oRfZHSl7vD\n \
#uWfn6w4gFepY/ynaSiPDIlCr3Zbzjy7hNLZNag==\n \
#-----END CERTIFICATE-----\n \
#-----BEGIN RSA PRIVATE KEY-----\n \
#Proc-Type: 4,ENCRYPTED\n \
#DEK-Info: DES-EDE3-CBC,118CDC345C0DAB35\n \
# \n \
#QgGaqKReWk7xS9mEdDLjBQLXHI5MeSjtFMLtjp1xKlA8xdGsb44j4gY00UbFBTiO\n \
#fkGTutY6syjHiBxgF6svaPMgI793V7CZmkDNlDgvMUL4ZwEoL1fxtdWQ4S+OG9JV\n \
#WorTCMmIfeObrV8M2lArbBsDmYUEwBud4gSip4d3YxRqf0LiPAKTOjheVnPTolJ+\n \
#ogkcJTeE0WglsQJedHyL6cqrKMmMqlwrlRjjCnRy71KnvVafHGviLc41VkCX6maM\n \
#DdPeke+xTqMoXWIciil1R4UhupaRSQCs0UKa0szeX0mxThy/G28slDD1A6nha17I\n \
#Qwt925u6lEuCzwQSM3abjgI3EFjSZu5iYe51iMWJnWzn1cm+hVvb8hP6VDRyDNbY\n \
#iZHQjAsMvxXWj2oVf5+jRx33HUROB5JO2Elp8eeeU75yGC/1NIIIlUAqVWE8GyNh\n \
#yx9dRPOoJY5Q6ycS4iQvG3zn4WjIYSg/ZENW9AeWtDWsTAJAHdwYGdmQsO1q0uhk\n \
#XW/MGeOmDbumOJM2PO/85XNAhCkITkNOgH7OVTjJjfqucIybCUWUdBEXBeOelTXw\n \
#I+O1IYTM997d+ncH3fXqCDDBkfyXrzkveOxRZpu/Bgyd/tXQB41ARAqUZQjmxyOs\n \
#FgKryrqHmrShqvFntDH9Sqko5dRujJhftq6/QYsYlc+OgejNg/F4N4a+GkgW+wgg\n \
#WRk+WjPI365WrVlEW9ar/lhqqgHsk7bPKHk+SR+t+sbbMeFUKQd8ejg8wyPmjFO/\n \
#Ba8awLurCGq1VgrlqmlVlAKJpv38E597ahPcWA1qS5W/Llkpo8SsCg==\n \
#-----END RSA PRIVATE KEY-----\n

TIBCO Hawk Installation and Configuration


| 177

Appendix E Code Page Identifiers

This appendix lists code page identifiers that can be specified to indicate the
locale of the machine running the HMA.

Topics

• Code Page Identifiers, page 178

TIBCO Hawk Installation and Configuration


178
| Appendix E Code Page Identifiers

Code Page Identifiers

Code page identifiers are specified as a value in the Codepage field. See
Codepage on page 93 for details.

Table 22 Code Page Identifiers


Identifier Name
037 IBM EBCDIC - U.S./Canada

437 OEM - United States

500 IBM EBCDIC - International

708 Arabic - ASMO 708

709 Arabic - ASMO 449+, BCON V4

710 Arabic - Transparent Arabic

720 Arabic - Transparent ASMO

737 OEM - Greek (formerly 437G)

775 OEM - Baltic

850 OEM - Multilingual Latin I

852 OEM - Latin II

855 OEM - Cyrillic (primarily Russian)

857 OEM - Turkish

858 OEM - Multilingual Latin I + Euro symbol

860 OEM - Portuguese

861 OEM - Icelandic

862 OEM - Hebrew

863 OEM - Canadian-French

864 OEM - Arabic

TIBCO Hawk Installation and Configuration


Code Page Identifiers 179
|
Table 22 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)


865 OEM - Nordic

866 OEM - Russian

869 OEM - Modern Greek

870 IBM EBCDIC - Multilingual/ROECE (Latin-2)

874 ANSI/OEM - Thai (same as 28605, ISO 8859-15)

875 IBM EBCDIC - Modern Greek

932 ANSI/OEM - Japanese, Shift-JIS

936 ANSI/OEM - Simplified Chinese (PRC, Singapore)

949 ANSI/OEM - Korean (Unified Hangeul Code)

950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)

1026 IBM EBCDIC - Turkish (Latin-5)

1047 IBM EBCDIC - Latin 1/Open System

1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol)

1141 IBM EBCDIC - Germany (20273 + Euro symbol)

1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)

1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)

1144 IBM EBCDIC - Italy (20280 + Euro symbol)

1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)

1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol)

1147 IBM EBCDIC - France (20297 + Euro symbol)

1148 IBM EBCDIC - International (500 + Euro symbol)

1149 IBM EBCDIC - Icelandic (20871 + Euro symbol)

1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646)

TIBCO Hawk Installation and Configuration


180
| Appendix E Code Page Identifiers

Table 22 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)


1201 Unicode UCS-2 Big-Endian

1250 ANSI - Central European

1251 ANSI - Cyrillic

1252 ANSI - Latin I

1253 ANSI - Greek

1254 ANSI - Turkish

1255 ANSI - Hebrew

1256 ANSI - Arabic

1257 ANSI - Baltic

1258 ANSI/OEM - Vietnamese

1361 Korean (Johab)

10000 MAC - Roman

10001 MAC - Japanese

10002 MAC - Traditional Chinese (Big5)

10003 MAC - Korean

10004 MAC - Arabic

10005 MAC - Hebrew

10006 MAC - Greek I

10007 MAC - Cyrillic

10008 MAC - Simplified Chinese (GB 2312)

10010 MAC - Romania

10017 MAC - Ukraine

10021 MAC - Thai

TIBCO Hawk Installation and Configuration


Code Page Identifiers 181
|
Table 22 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)


10029 MAC - Latin II

10079 MAC - Icelandic

10081 MAC - Turkish

10082 MAC - Croatia

12000 Unicode UCS-4 Little-Endian

12001 Unicode UCS-4 Big-Endian

20000 CNS - Taiwan

20001 TCA - Taiwan

20002 Eten - Taiwan

20003 IBM5550 - Taiwan

20004 TeleText - Taiwan

20005 Wang - Taiwan

20105 IA5 IRV International Alphabet No. 5 (7-bit)

20106 IA5 German (7-bit)

20107 IA5 Swedish (7-bit)

20108 IA5 Norwegian (7-bit)

20127 US-ASCII (7-bit)

20261 T.61

20269 ISO 6937 Non-Spacing Accent

20273 IBM EBCDIC - Germany

20277 IBM EBCDIC - Denmark/Norway

20278 IBM EBCDIC - Finland/Sweden

20280 IBM EBCDIC - Italy

TIBCO Hawk Installation and Configuration


182
| Appendix E Code Page Identifiers

Table 22 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)


20284 IBM EBCDIC - Latin America/Spain

20285 IBM EBCDIC - United Kingdom

20290 IBM EBCDIC - Japanese Katakana Extended

20297 IBM EBCDIC - France

20420 IBM EBCDIC - Arabic

20423 IBM EBCDIC - Greek

20424 IBM EBCDIC - Hebrew

20833 IBM EBCDIC - Korean Extended

20838 IBM EBCDIC - Thai

20866 Russian - KOI8-R

20871 IBM EBCDIC - Icelandic

20880 IBM EBCDIC - Cyrillic (Russian)

20905 IBM EBCDIC - Turkish

20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)

20932 JIS X 0208-1990 & 0121-1990

20936 Simplified Chinese (GB2312)

21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian)

21027 Extended Alpha Lowercase

21866 Ukrainian (KOI8-U)

28591 ISO 8859-1 Latin I

28592 ISO 8859-2 Central Europe

28593 ISO 8859-3 Latin 3

28594 ISO 8859-4 Baltic

TIBCO Hawk Installation and Configuration


Code Page Identifiers 183
|
Table 22 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)


28595 ISO 8859-5 Cyrillic

28596 ISO 8859-6 Arabic

28597 ISO 8859-7 Greek

28598 ISO 8859-8 Hebrew

28599 ISO 8859-9 Latin 5

28605 ISO 8859-15 Latin 9

29001 Europa 3

38598 ISO 8859-8 Hebrew

50220 ISO 2022 Japanese with no halfwidth Katakana

50221 ISO 2022 Japanese with halfwidth Katakana

50222 ISO 2022 Japanese JIS X 0201-1989

50225 ISO 2022 Korean

50227 ISO 2022 Simplified Chinese

50229 ISO 2022 Traditional Chinese

50930 Japanese (Katakana) Extended

50931 US/Canada and Japanese

50933 Korean Extended and Korean

50935 Simplified Chinese Extended and Simplified Chinese

50936 Simplified Chinese

50937 US/Canada and Traditional Chinese

50939 Japanese (Latin) Extended and Japanese

51932 EUC - Japanese

51936 EUC - Simplified Chinese

TIBCO Hawk Installation and Configuration


184
| Appendix E Code Page Identifiers

Table 22 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)


51949 EUC - Korean

51950 EUC - Traditional Chinese

52936 HZ-GB2312 Simplified Chinese

54936 Windows XP: GB18030 Simplified Chinese (4 Byte)

57002 ISCII Devanagari

57003 ISCII Bengali

57004 ISCII Tamil

57005 ISCII Telugu

57006 ISCII Assamese

57007 ISCII Oriya

57008 ISCII Kannada

57009 ISCII Malayalam

57010 ISCII Gujarati

57011 ISCII Punjabi

65000 Unicode UTF-7

65001 Unicode UTF-8

TIBCO Hawk Installation and Configuration


| 185

Index

A the 117, 121


depend on the routing daemon service, Making
Adding AMI sessions 103 TIBCO Hawk services 118
Adding the rvrd service value to the Windows Designating a security policy 117, 121
registry 120 dial-up network connection, Using the TIBCO Hawk
agent heartbeat interval Display over a 117, 121
Setting 117, 121 Disk Space and Memory 13, 25, 40
agent name 117, 121
-ami_rva_session 103
-ami_rvd_session 103
automatically, Starting the routing daemon E
service 118
Example TIBCO Rendezvous routing daemon config-
uration for TIBCO Hawk messaging 115

C
-cluster 117, 121 H
configuration on Unix, Setting up the routing
daemon 121 heartbeat interval
configuration, Planning TIBCO Hawk 88 Setting 117, 121
Csh users 35 -host 117, 121
customer support xvi How the Installer Searches for JRE 7

D I
daemon configuration for TIBCO Hawk messaging, Install and Generate a Response File 16, 31
Example TIBCO Rendezvous routing 115 Install and Generate a Template File 17, 32
daemon configuration on Unix, Setting up the Install in Silent Mode 16, 31
routing 121 Install Using a Response File 17, 32
daemon service automatically, Starting the Install Using Console 16, 31
routing 118 Install Using GUI 16, 31
daemon service, Making TIBCO Hawk services Installation Directories 4
depend on the routing 118 Installation Directory 13
default container for the TIBCO Hawk Display 117, Installation Media 15, 29
121 Installation Options 15, 30
default TIBCO Hawk agent name (-host), Overriding Interactive Mode 17, 32

TIBCO Hawk Installation and Configuration


186
| Index
-interval 117, 121 saging, Example TIBCO Rendezvous 115
routing daemon configuration on Unix, Setting up
the 121
routing daemon service automatically, Starting
J the 118
routing daemon service, Making TIBCO Hawk ser-
JRE Search Locations 8 vices depend on the 118
-rva_session 103
-rvd_session 103
rvrd service value to the Windows registry, Adding
L the 120

license tickets 126

N security policy, designating 117, 121


security_policy 117, 121
network connection, Using the TIBCO Hawk Display service, Making TIBCO Hawk services depend on the
over a dial-up 117, 121 routing daemon 118
services depend on the routing daemon service, Mak-
ing TIBCO Hawk 118
services in the Windows registry editor, TIBCO
O Hawk 119
Setting the TIBCO Hawk agent heartbeat interval 117,
over a dial-up network connection, Using the TIBCO 121
Hawk Display 117, 121 setting the TIBCO Hawk agent heartbeat interval 121
Overriding the default TIBCO Hawk agent name 117, Setting up a TIBCO Rendezvous session 103
121 Setting up the routing daemon configuration on
Unix 121
Silent Mode 17, 32
Software 14, 26, 40
P Specifying the JRE Location 7
Starting the routing daemon service automatically 118
Planning TIBCO Hawk configuration 88 support, contacting xvi

R T
RAM 13, 26 technical support xvi
registry editor, TIBCO Hawk services in Windows 119 Temp Directory 13
registry, Adding the rvrd service value to TIBCO Hawk agent heartbeat interval (-interval),
Windows 120 Setting 117, 121
routing daemon configuration for TIBCO Hawk mes- TIBCO Hawk agent name (-host), Overriding the

TIBCO Hawk Installation and Configuration


Index 187
|
default 117, 121
TIBCO Hawk configuration, Planning 88
TIBCO Hawk Display over a dial-up network connec-
tion, Using the 117, 121
TIBCO Hawk services in the Windows registry
editor 119
TIBCO Rendezvous routing daemon configuration for
TIBCO Hawk messaging, Example 115
TIBCO Software 14, 26, 40
Trace level 65
tracing 66

U
UNIX installation 23
User Privileges 12, 24, 40
Using the TIBCO Hawk Display over a dial-up net-
work connection 117, 121

W
Windows registry editor, TIBCO Hawk services in
Windows 119
Windows registry, Adding the rvrd service value to
the registry 120

TIBCO Hawk Installation and Configuration


188
| Index

TIBCO Hawk Installation and Configuration

You might also like