VERITAS Cluster Server 3.5 Bundled Agents: Reference Guide

VERITAS Cluster Server 3.
5 Bundled Agents
Reference Guide
HP-UX
October 2002 N09207G
Disclaimer The information contained in this publication is subject to change without notice. VERITAS Software Corporation makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and tness for a particular purpose. VERITAS Software Corporation shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual. Copyright Copyright 1998-2002 VERITAS Software Corporation. All Rights Reserved. VERITAS, VERITAS SOFTWARE, the VERITAS logo and all other VERITAS product names and slogans are trademarks or registered trademarks of VERITAS Software Corporation in the USA and/or other countries. Other product names and/or slogans mentioned herein may be trademarks or registered trademarks of their respective companies. VERITAS Software Corporation 350 Ellis Street Mountain View, CA 94043 Phone 6505278000 Fax 650527-2908 www.veritas.com
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii VCS Enterprise and Storage Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Resources and Their Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Modifying Agents and Their Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Categories of Bundled Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Basic Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Application Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 VCS Infrastructure and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Chapter 2. VCS Bundled Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Application Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Sample 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Sample 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 DiskGroup Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Setting the noautoimport Flag for a Disk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
iii
Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 ElifNone Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 FileNone Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 FileOnOff Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 FileOnOnly Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 IP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Sample 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Sample 2: NetMask in decimal (base 10) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Sample 3: NetMask in hexadecimal (base 16) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 IPMultiNIC Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Sample Configuration, IPMultiNIC and MultiNICA . . . . . . . . . . . . . . . . . . . . . . . . . 20 LVMCombo Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 LVMLogicalVolume Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 LVMVolumeGroup Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
iv VERITAS Cluster Server Bundled Agents Reference Guide, 3.5
Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Mount Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 MultiNICA Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Notes about Using MultiNICA Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Sample Configuration: MultiNICA and IPMultiNIC . . . . . . . . . . . . . . . . . . . . . . . . . 31 NFS Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 NIC Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Requirements for NIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 NotifierMngr Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Phantom Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Sample 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Sample 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Process Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Sample 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Sample 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Proxy Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Contents v
Sample 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Sample 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Sample 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 ServiceGroupHB Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Share Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Volume Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 VRTSWebApp Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
vi
VERITAS Cluster Server Bundled Agents Reference Guide, 3.5
Preface
This document provides reference for the VCS agents bundled with the VCS software. For information on purchasing VCS agents or other VERITAS products, contact your VERITAS sales representative: U.S. and Canadian Customers: 1-800-327-2232 International Customers: +1 (407) 531-7501 or consult the Web (http://www.veritas.com) for the VERITAS sales ofce in your area. Email: sales.mail@veritas.com
VCS Enterprise and Storage Agents

VCS enterprise and storage agents are not included with the VCS software, but are sold separately. Contact your VERITAS sales representative for details on these agents or additional agents under development:
N N N N
Informix NetBackup Oracle Sybase
vii
Technical Support
Technical Support
U.S. and Canada: call 1-800-342-0652. Europe, the Middle East, or Asia: visit the Technical Support Web site at http://support.veritas.com for a list of each countrys contact information. Software updates, TechNotes, product alerts, and hardware compatibility lists are also available from http://support.veritas.com. To learn more about VERITAS and what we offer, visit http://www.veritas.com.
Conventions
Typeface/Font courier courier (bold) italic italic Symbol # Usage Computer output, command references in text User input and commands, keywords in grammar syntax New terms, book titles, emphasis Variables Usage UNIX superuser prompt (for all shells)
viii
Introduction
Bundled agents are VCS processes that manage resources of predened resource types according to commands received from the VCS engine, HAD. These agents are a part of VCS, and are installed when VCS is installed. A system has one agent per resource type that monitors all resources of that type; for example, a single IP agent manages all IP resources. When the agent starts, it obtains the necessary conguration information from VCS. The agent then periodically monitors the resources, and updates VCS with the resource status. Agents typically: Bring resources online. Take resources ofine. Monitor resources and report state changes to VCS. Note Refer to the VERITAS Cluster Server 3.5 Users Guide for general information on VCS agents.
Resources and Their Attributes

Resources are the key parts of a system and are known by their type, such as a disk, a volume, or an IP address. VCS includes a set of resource types, which are dened in the types.cf le by a collection of attributes. Each type has a corresponding agent that is designed to control the resource. The VCS conguration le, main.cf, contains the values for the resource attributes and has an include directive to the types.cf le. An attributes given value congures the resource to function in a specic way. By modifying the value of a resource attribute, you can change the way the VCS agent manages the resource. For example, the IP agent monitors an IP address resource. The specic address to be monitored is identied by the attribute Address whose value is the specic IP address.
Modifying Agents and Their Resources
Modifying Agents and Their Resources

Use Cluster Manager (Java Console), Cluster Manager (Web Console), or the VCS command line to dynamically modify the conguration of the resources managed by an agent. See the VERITAS Cluster Server 3.5 Users Guide for instructions on how to complete these tasks. VCS enables you to edit the main.cf le directly. To implement these changes, make sure to restart VCS.
Categories of Bundled Agents

VCS enables you to use bundled agents for networking, basic storage, application control, and VCS infrastructure and support functions:
Networking
N N N N
IP IPMultiNIC MultiNICA NIC
Basic Storage
N N N N N N N N
DiskGroup LVMCombo LVMLogicalVolume LVMVolumeGroup Mount NFS Share Volume
Application Control
N N
Application Process
VCS Infrastructure and Support

N N N N N N N N N
NotierMngr Phantom Proxy ServiceGroupHB VRTSWebApp ElifNone FileNone FileOnOff FileOnOnly
Chapter 1, Introduction
VCS Bundled Agents
The tables in this chapter provide information on resource types, entry points (see below), state denitions, and modiable attributes for VCS bundled agents. The tables indicate which attributes are required and which are optional. The resource type as it is dened in the types.cf le is included along with a sample of the conguration in the main.cf le. An entry point is a plug-in that is called when an event occurs within the VCS agent. The VCS engine uses entry points to manipulate resources. In addition to the online, ofine, and monitor entry points, the clean entry point applies to most agents and is called automatically by the framework when all ongoing actions associated with a resource must be terminated and the resource must be taken ofine (perhaps forcibly). Refer to the VERITAS Cluster Server 3.5 Agent Developers Guide for more information on entry points and the VCS agent framework. Refer to the VERITAS Cluster Server 3.5 Users Guide for more information on VCS attributes.
Application Agent
Application Agent
Description Brings applications online, takes them ofine, and monitors their status. Enables you to specify different executables for the online, ofine, and monitor routines. (An application has an executable to start it and an executable to stop it.) The executables must exist locally on each node. By default, an application runs in the context of root. Specify the user name to run an application in a user context. The agent starts and stops the application with user-specied programs. Monitor the application in the following ways: N Use the monitor program N Specify a list of processes to be monitored N Specify a list of process ID les to be monitored N All or some of the above Entry Points N OnlineRuns the StartProgram with the specied parameters in the specied user context. N OfineRuns the StopProgram with the specied parameters in the specied user context. N MonitorIf MonitorProgram is specied, the agent executes the user-dened MonitorProgram in the user-specied context. If PidFiles is specied, the routine veries that the process ID found in each listed le is running. If MonitorProcesses is specied, the routine veries that each listed process is running in the user-specied context. MonitorProgram must return ONLINE to employ any other monitoring method. Any one, two, or three of these attributes can be used to monitor the application. If any one process specied in either PidFiles or MonitorProcesses is determined not to be running, the monitor returns OFFLINE. N CleanKills processes specied in PidFiles or MonitorProcesses. Ensures that only those processes (specied in MonitorProcesses) running with the user ID specied in the User attribute are killed. If the CleanProgram is dened, the agent executes the CleanProgram. State Denitions
ONLINEIndicates that all processes specied in PidFiles and MonitorProcesses are running and that the MonitorProgram returns ONLINE. OFFLINEIndicates
that at least one process specied in PidFiles or MonitorProcesses is not running, or that the MonitorProgram returns OFFLINE.
UNKNOWNIndicates
that the applications state is indeterminable.
Application Agent
Required Attributes
Type and Dimension string-scalar
Denition
StartProgram
The executable, created locally on each node, that starts the application. Specify the complete path of the executable. Command-line arguments (if applicable) follow the name of the executable, separated by spaces. The executable, created locally on each node, that stops the application. Specify the complete path of the executable. Command-line arguments (if applicable) follow the name of the executable, separated by spaces. see below
StopProgram
string-scalar
At least one of the following attributes: N MonitorProcesses N MonitorProgram N PIDFiles See descriptions under Optional Attributes. Optional Attributes
see below
Denition
CleanProgram
The executable, created locally on each node, that forcibly stops the application. Specify the complete path of the executable. Command-line arguments (if applicable) follow the name of the executable, separated by spaces. A list of processes to be monitored and cleaned. Each process name is the name of an executable. Qualify the executable name with its complete path if the path is used to start the executable. The process name must be the full command line argument displayed by the ps -u <user> -o args | more command for the process.
MonitorProcesses
string-vector
MonitorProgram
string-scalar
The executable, created locally on each node, that will monitor the application. Specify the complete path of the executable. Command-line arguments (if applicable) follow the name of the executable, separated by spaces. MonitorProgram can return the following VCSAgResState values: OFFLINE values is 100; ONLINE values are from 101 to 110 (depending on the condence level); 110 equals condence level of 100%. Any other value = UNKNOWN.
Chapter 2, VCS Bundled Agents
Application Agent
PidFiles
string-vector
A list of pid les that contain the process ID of the processes to be monitored and cleaned. These les are application-generated les. Each PID le contains one PID which will be monitored. Specify the complete path of each pid le in the list. The process ID can change when the process restarts. If the application takes time to update the pid le, the agents monitor script may return an incorrect result. If this occurs, increase the ToleranceLimit in the resource denition.
User
string-scalar
The user whose ID is used to run StartProgram, StopProgram, MonitorProgram, and CleanProgram. The processes specied in the MonitorProcesses list must run in the context of the specied user. Monitor checks the processes to make sure they run in this context. Default is "root".
Type Denition
type Application ( static str ArgList[] = { User, StartProgram, StopProgram, CleanProgram, MonitorProgram, PidFiles, MonitorProcesses } str User = root str StartProgram str StopProgram str CleanProgram str MonitorProgram str PidFiles[] str MonitorProcesses[] )
Application Agent
Sample Congurations
Sample 1 In this example, the executable samba is congured as StartProgram and StopProgram, with start and stop specied as command-line arguments respectively. The agent is congured to monitor two processes: a process specied by the pid smbd.pid, and the process nmbd.
Application samba_app ( User = "root" StartProgram = "/usr/sbin/samba start" StopProgram = "/usr/sbin/samba stop" PidFiles = { "/var/lock/samba/smbd.pid" } MonitorProcesses = { "nmbd" } )
Sample 2 In this example, no user is specied; as a result, the conguration uses the root user. The executable samba starts and stops the application, with start and stop as the command-line arguments respectively. The executable sambaMonitor monitors the application and uses all as its command-line argument. The agent monitors the smbd and nmbd processes.
Application samba_app2 ( StartProgram = "/usr/sbin/samba start" StopProgram = "/usr/sbin/samba stop" CleanProgram = "/usr/sbin/samba force stop" MonitorProgram = "/usr/local/bin/sambaMonitor all" MonitorProcesses = { "smbd", "nmbd" } )
Application Agent
Error Messages
Message None of the parameters (MonitorProgram, PidFiles, MonitorProcesses) are specied to monitor the application. Program <MonitorProgram/CleanProgram> does not exist. VCSAgExec() failed, could not execute program (MonitorProgram/CleanProgram). Tag B Description / Recommended Action Specify at least one parameter to monitor the resource.
Check if the specied MonitorProgram/CleanProgram exists. Check if the user specied has permission to execute MonitorProgram/CleanProgram. Check if the user specied has permission to execute MonitorProgram/CleanProgram. Check if the user specied exists on the local system. Could not allocate memory to monitor/clean the resource. StartProgram is not specied to bring the resource online. StopProgram is not specied to take the resource ofine. Check if the StartProgram/StopProgram exists and is in executable mode.
Abnormal termination of program (MonitorProgram/CleanProgram).
Error while getting information about user.
Memory allocation failed.
No start program dened.
No stop program dened.
Program (StartProgram/StopProgram) does not exist or is not executable.
10
DiskGroup Agent
DiskGroup Agent
Description Brings online, takes ofine, and monitors a VERITAS Volume Manager (VxVM) disk group. This agent uses VxVM commands. N OnlineImports the disk group using the vxdg command. N OfineDeports the disk group using the vxdg command. N MonitorDetermines if the disk group is online or ofine using the vxdg command. N CleanIndicates a condition exists that requires administrator intervention. State Denitions
ONLINEIndicates OFFLINEIndicates
Entry Points
that the disk group is imported. that the disk group is not imported.
that a problem exists either with the conguration or the ability to determine the status of the resource. Required Attribute Type and Dimension string-scalar Denition
UNKNOWNIndicates
DiskGroup
Name of the disk group congured with VERITAS Volume Manager. For example, diskgroup1.
Optional Attributes
Denition
StartVolumes
If value is 1, the DiskGroup online script starts all volumes belonging to that disk group after importing the group. Default is 1.
StopVolumes
string-scalar
If value is 1, the DiskGroup offline script stops all volumes belonging to that disk group before deporting the group. Default is 1.
11
DiskGroup Agent
Setting the noautoimport Flag for a Disk Group

VCS requires that the noautoimport ag of an imported disk group be explicitly set to true. This enables VCS to control the importation and deportation of disk groups as needed when bringing disk groups online and taking them ofine. Note If you enable a disk group congured as a DiskGroup resource that does not have the noautoimport ag set to true, VCS forcibly deports the disk group and reimports it with the noautoimport ag set to true. This may disrupt applications running on the disk group. To check the status of the noautoimport ag for an imported disk group, type:
# vxprint -l disk_group | grep noautoimport
If the output from this command is blank, the noautoimport ag is set to false and VCS lacks the necessary control. To explicitly set the noautoimport ag to true, deport the disk group and import it with the -t option as follows: Deport the disk group:
# vxdg deport disk_group
Import the disk group, specifying the noautoimport ag be set to true to ensure the disk group is not automatically imported:
# vxdg -t import disk_group
Type Denition
type DiskGroup ( static int OnlineRetryLimit = 1 str DiskGroup NameRule = resource.DiskGroup static str ArgList[] = { DiskGroup, StartVolumes, StopVolumes, MonitorOnly } str StartVolumes = 1 str StopVolumes = 1 static int NumThreads = 1 )
Sample Conguration
DiskGroup dg1 ( DiskGroup = testdg_1 )
12
ElifNone Agent
ElifNone Agent
Description Entry Point Monitors a le. MonitorChecks if the specied le exists. If it does, the agent reports as OFFLINE. If it does not, the agent reports as ONLINE. Type and Dimension string-scalar Description
Required Attribute
PathName
Species the complete pathname, starting with the slash (/) preceding the le name.
Type Denition
type ElifNone ( static str ArgList[] = { PathName } static int OfflineMonitorInterval = 60 NameRule = resource.PathName static str Operations = None str PathName )
Sample Conguration
ElifNOne tmp_file01 ( PathName = "/tmp/file01" )
13
FileNone Agent
FileNone Agent
Description Entry Point Monitors a le. MonitorChecks if the specied le exists. If it does, the agent reports as ONLINE. If it does not, the agent reports as OFFLINE. Type and Dimension string-scalar Description
Required Attribute
PathName
Type Denition
type FileNone ( static str ArgList[] = { PathName } static int OfflineMonitorInterval = 60 NameRule = resource.PathName static str Operations = None str PathName )
Sample Conguration
FileNone tmp_file01 ( PathName = "/tmp/file01" )
14
FileOnOff Agent
FileOnOff Agent
Description Entry Points Creates, removes, and monitors les. N OnlineCreates an empty le with the specied name (if one does not already exist). N OfineRemoves the specied le. N MonitorChecks if the specied le exists. If it does, the agent reports as ONLINE. If it does not, the agent reports as OFFLINE. Required Attribute Type and Dimension string-scalar Description
PathName
Type Denition
type FileOnOff ( static str ArgList[] = { PathName } NameRule = resource.PathName str PathName )
Sample Conguration
FileOnOff tmp_file01 ( PathName = "/tmp/file01" )
15
FileOnOnly Agent
FileOnOnly Agent
Description Entry Points Creates and monitors les. N OnlineCreates an empty le with the specied name (if one does not already exist). N MonitorChecks if the specied le exists. If it does, the agent reports as ONLINE. If it does not, the agent reports as OFFLINE. Required Attribute Type and Dimension string-scalar Description
PathName
Type Denition
type FileOnOnly ( static str ArgList[] = { PathName } NameRule = resource.PathName static str Operations = OnOnly str PathName )
Sample Conguration
FileOnOnly tmp_file02 ( PathName = "/tmp/file02" )
16
IP Agent
IP Agent
Description Manages the process of conguring a virtual IP address and its subnet mask on an interface. The interface must be plumbed with a physical (or administrative) base IP address before a virtual IP address can be assigned. The virtual IP address must not be one currently in use. N OnlineChecks if the IP address is in use by another system. Uses the ifconfig command to set the IP address on a unique alias on the interface. N OfineBrings down the IP address associated with the specied interface. Uses the ifconfig command to set the interface alias to 0.0.0.0 and the state to down. N MonitorMonitors the interface to test if the IP address associated with the interface is alive. Required Attributes Type and Dimension string-scalar Description
Entry Points
Address
Virtual IP address associated with the interface. (The virtual IP address is different from the base and administrative IP addresses of the interface.) For example, "172.29.9.24".
Device
string-scalar
Name of the NIC device associated with the IP address. Contains the device name without an alias. For example, lan0.
Optional Attributes
Type and Dimension integer-scalar
Denition
ArpDelay
Number of seconds to sleep between conguring an interface and sending out a broadcast to inform routers about this IP address. Default is 1.
IfcongTwice
integer-scalar
Causes an IP address to be congured twice using an ifconfig up-down-up sequence. Increases the probability of gratuitous ARP requests (generated by ifconfig up) to reach clients. Default is 0.
NetMask
string-scalar
Netmask associated with the IP address of the resource. The value of the netmask may be specied in decimal (base 10) or hexadecimal (base 16). Default is "255.0.0.0" (if the ifconfig command is executed without a netmask argument). Note VERITAS recommends that you specify a netmask for each virtual interface.
17
IP Agent
Options
string-scalar
Options for the ifconfig command. For example, "broadcast 10.182.15.255".
Type Denition
type IP ( static str ArgList[] = { Device, Address, NetMask, Options, ArpDelay, IfconfigTwice } NameRule = IP_ + resource.Address str Device str Address str NetMask str Options int ArpDelay = 1 int IfconfigTwice = 0 )
Sample Congurations
Sample 1
IP IP_192_203_47_61 ( Device = lan0 Address = "192.203.47.61" )
Sample 2: NetMask in decimal (base 10)

IP IP_192_203_47_61 ( Device = lan0 Address = "192.203.47.61" NetMask = "255.255.248.0" )
Sample 3: NetMask in hexadecimal (base 16)

IP IP_192_203_47_61 ( Device = lan0 Address = "192.203.47.61" NetMask = "0xfffff800" )
18
IPMultiNIC Agent
IPMultiNIC Agent
Description Monitors the virtual (logical) IP address congured as an alias on one interface of a MultiNICA resource. If the interface faults, the agent works with the MultiNICA resource to fail over the virtual address to a backup interface. If multiple service groups have IPMultiNICs associated with the same MultiNICA resource, only one group will have the MultiNICA resource. The other groups will have Proxy resources pointing to it. N OnlineCongures a virtual IP address on one interface of the MultiNICA resource. N OfineRemoves a virtual IP address from one interface of the MultiNICA resource. N MonitorChecks if the virtual IP address is congured on one interface of the MultiNICA resource. State Denitions
Entry Points
that the specied IP address is assigned to the device. that the specied IP address is not assigned to the device. that the resource is congured inaccurately in the main.cf. Description
UNKNOWNIndicates
Required Attributes
Type and Dimension string-scalar string-scalar
Address MultiNICResName
Virtual IP address assigned to the active NIC. Name of associated MultiNICA resource that determines the active NIC. Description
Optional Attributes
IfcongTwice
Causes an IP address to be congured twice using an ifconfig up-down-up sequence. Increases the probability of gratuitous ARP requests (generated by ifconfig up) to reach clients. Default is 0.
NetMask
string-scalar
Netmask for the virtual IP address. The value of the netmask may be specied in decimal (base 10) or hexadecimal (base 16). Default is "255.0.0.0" (if the ifconfig command is executed without a netmask argument). Note VERITAS recommends that you specify a netmask for each virtual interface.
Options
string-scalar
19
IPMultiNIC Agent
Type Denition
type IPMultiNIC ( static str ArgList[] = { "MultiNICResName:Device", Address, NetMask, Options, "MultiNICResName:Probed", MultiNICResName, IfconfigTwice } static int MonitorTimeOut = 120 NameRule = IPMultiNIC_ + resource.Address str Address str NetMask str Options str MultiNICResName int IfconfigTwice = 0 )
Sample Conguration, IPMultiNIC and MultiNICA

For details on the following example, refer to Sample Conguration: MultiNICA and IPMultiNIC on page 31.
group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICA mnic ( Device@sysa = { lan0 = "166.98.16.103", lan3 = "166.98.16.103" } Device@sysb = { lan0 = "166.98.16.104", lan3 = "166.98.16.104" } NetMask = "255.255.255.0" Options = "arp" RouteOptions@sysa = "default 166.98.16.103 0" RouteOptions@sysb = "default 166.98.16.104 0" NetWorkHosts = { "166.11.20.31", "182.1.21.5" } ) IPMultiNIC ip1 ( Address = "166.98.14.78" NetMask = "255.255.255.0" MultiNICResName = mnic Options = "arp" ) ip1 requires mnic
group grp2 ( SystemList = { sysa, sysb }

20 VERITAS Cluster Server Bundled Agents Reference Guide, 3.5
IPMultiNIC Agent
AutoStartList = { sysa } ) IPMultiNIC ip2 ( Address = "166.98.14.79" NetMask = "255.255.255.0" MultiNICResName = mnic Options = "arp" ) Proxy proxy ( TargetResName = mnic ) ip2 requires proxy
21
LVMCombo Agent
LVMCombo Agent
Description Denes the logical volumes and volume groups associated with an application. Use LVMCombo as an alternative to LVMLogicalVolume and LVMVolumeGroup when dening logical volumes and volume groups. LVMCombo is similar to LVMLogicalVolume and LVMVolumeGroup, but does not enable LVM conguration information to be backed up every time resources are brought online or taken ofine. N OnlineActivates the volume group and any of the logical volumes that are not available. The volume group must be imported by each system in the cluster, but not activated by each system. This agent does not import volume groups because of the way LVM stores conguration information. Use the HP-UX SAM tool to import a volume group. (For more information on SAM, refer to the HP manual HP-UX System Administration Tasks.) N OfineDeactivates the volume group, but does not deactivate the logical volumes. The logical volumes are automatically deactivated when the volume group is deactivated. N MonitorIf the volume group and all of the logical volumes are available, the resource is ONLINE. Otherwise, the resource is OFFLINE. The monitor entry point does not perform any I/O on disk. If a disk that makes up a logical volume is powered off, the agent will not be aware of this situation until the logical volume is marked unavailable. This may occur if the le system or the application using the logical volume attempts an I/O operation and fails. LVM can then set the logical volume as unavailable. Required Attributes Type and Dimension string-vector string-scalar Description
Entry Points
LogicalVolume VolumeGroup
List of logical volumes in a volume group. Name of a volume group.
22
LVMCombo Agent
Type Denition
type LVMCombo ( static str ArgList[] = { VolumeGroup, LogicalVolumes } NameRule = resource.VolumeGroup str VolumeGroup str LogicalVolumes[] )
Sample Conguration
LVMCombo dg1 ( VolumeGroup = dg1 LogicalVolumes = { lvol1, lvol2 } )
23
LVMLogicalVolume Agent
LVMLogicalVolume Agent
Description Brings online, takes ofine, and monitors Logical Volume Manager (LVM) logical volumes. N OnlineActivates the logical volume with the lvchange command. N OfineDeactivates the logical volume with the lvchange command. N MonitorDetermines if the logical volume is accessible by performing read I/O on the raw logical volume. Required Attributes Type and Dimension string-scalar string-scalar Description
Entry Points
LogicalVolume VolumeGroup
Name of the logical volume. Name of the volume group containing the logical volume.
Type Denition
type LVMLogicalVolume ( static str ArgList[] = { LogicalVolume, VolumeGroup } NameRule = resource.VolumeGroup + "_" + resource.LogicalVolume str LogicalVolume str VolumeGroup )
Sample Conguration
LVMLogicalVolume sharedg_lvol1 ( LogicalVolume = lvol1 VolumeGroup = sharedg )
24
LVMVolumeGroup Agent
LVMVolumeGroup Agent
Description Activates, deactivates, and monitors Logical Volume Manager (LVM) volume groups. N OnlineActivates a volume group with the vgchange command. The Volume Group must be imported by each system in the cluster, but not activated by each system. LVMCombo does not import volume groups because of the way LVM stores conguration information. Use the HP-UX SAM tool to import a volume group. (For more information on SAM, refer to the HP manual HP-UX System Administration Tasks.) N OfineDeactivates a volume group with the vgchange command. N MonitorUses the vgdisplay command to determine if the volume group is available. Required Attribute Type and Dimension string-scalar Description
Entry Points
VolumeGroup
Name of the volume group congured with LVM.
Type Denition
type LVMVolumeGroup ( static str ArgList[] = { VolumeGroup } NameRule = resource.VolumeGroup str VolumeGroup )
Sample Conguration
LVMVolumeGroup sharedg ( VolumeGroup = sharedg )
25
Mount Agent
Mount Agent
Description Entry Points Brings online, takes ofine, and monitors a le system mount point. N OnlineMounts a block device on the directory. If the mount process fails, the agent attempts to run the fsck command on the raw device to remount the block device. N OfineUnmounts the le system. N MonitorDetermines if the le system is mounted. Checks mount status using the stat and statvfs commands. N CleanSee description on page 5. State Denitions
ONLINEIndicates
that the block device is mounted on the specied mount point. that a problem exists with the conguration.
OFFLINEIndicates that the block device is not mounted on the specied mount point. UNKNOWNIndicates
Required Attributes
Type and Dimension string-scalar string-scalar
Description
BlockDevice FsckOpt
Device for mount point. Options for fsck command. "-y" or "-n" must be included as arguments to fsck; otherwise, the resource cannot come online. VxFS le systems will perform a log replay before a full fsck operation (enabled by "-y") takes place. Refer to the manual page on the fsck command for more information. Type of le system. Does not support NFS mounts; supports local mounts only. For example, vxfs or hfs.
FSType
string-scalar
MountPoint Optional Attributes
string-scalar Type and Dimension string-scalar integer-scalar
Directory for mount point. Description
MountOpt SnapUmount
Options for mount command. If set to 1, this attribute automatically unmounts VxFS snapshots when the le system is unmounted. Default is 0 (No).
26
Mount Agent
Type Denition
type Mount ( static str ArgList[] = { MountPoint, BlockDevice, FSType, MountOpt, FsckOpt, SnapUmount } NameRule = resource.MountPoint str MountPoint str BlockDevice str FSType str MountOpt str FsckOpt int SnapUmount = 0 )
Sample Conguration
Mount export1 ( MountPoint = "/export1" BlockDevice = "/dev/sharedg/lvol1" FsckOpt = "-y" FSType = "vxfs" MountOpt = "ro" )
27
MultiNICA Agent
MultiNICA Agent
Description Represents a set of network interfaces, and provides failover capabilities between them. Each interface in a MultiNICA resource has a base IP address, which can be the same or different. The MultiNICA agent congures one interface at a time. If the agent does not detect activity on the congured interface, it congures a new interface and migrates IP aliases to it. If an interface is associated with a MultiNICA resource, the interface should not be associated with any other MultiNICA or NIC resource. If the same set of interfaces must be a part of multiple service groups, congure: N A MultiNICA resource in one of the service groups. N Proxy resources that point to the MultiNIC resource in the other service groups. Entry Point N MonitorChecks for activity on a congured interface by sampling input packets received on that interface. If monitor does not detect activity, it forces activity by sending out a broadcast ping. If monitor detects a failure, it migrates to the next interface. Type and Dimension string-association string-vector Description
Required Attributes
Device NetworkHosts
List of interfaces and their base IP addresses. List of hosts on the network that are pinged to determine if the network connection is alive. Enter the IP address of the host (instead of the HostName) to prevent the monitor from timing out (DNS causes the ping to hang). For example, NetworkHosts = { "166.93.2.1", "166.97.1.2" }.
Optional Attributes
Description
ArpDelay
Number of seconds to sleep between conguring an interface and sending out a broadcast to inform routers about the base IP address. Default is 1.
28
MultiNICA Agent
Handshake-Interval
integer-scalar
Computes the maximum number of attempts the agent makes either to ping a host (listed in the NetworkHosts attribute) when it fails over to a new NIC, or to ping the default broadcast address (depending on the attribute congured) when it fails over to a new NIC. Each attempt, which includes a ve second sleep interval, may take about 10 seconds. A value of 90 does not indicate that failover will take 90 seconds. To prevent spurious failovers, the agent must try to contact a host on the network several times before marking a NIC as faulted. The lowest value that can be set for this attribute is 50, or ve attempts. Increased values result in longer failover times, whether between the NICs or from system to system in the case of faulted NICs.
IfcongTwice
integer-scalar
Causes an IP address to be congured twice, using an ifconfig up-down-up sequence. Increases the probability of gratuitous ARP requests (caused by ifconfig up) to reach clients. Default is 0.
NetMask
string-scalar
Netmask for the base IP address. The value of NetMask may be specied in decimal (base 10) or hexadecimal (base 16). Default is "255.0.0.0" (if the ifconfig command is executed without a netmask argument). Note VERITAS recommends that you specify a netmask for each virtual interface.
Options
string-scalar
RouteOptions
string-scalar
String to add a route when conguring an interface. Use only when conguring the local host as the default gateway. The string contains arguments to the route command. No routes are added if this string is set to NULL.
29
MultiNICA Agent
Notes about Using MultiNICA Agent

N
If all NICs congured in the Device attribute are down, the MultiNICA agent faults the resource after a two to three minute interval. This delay occurs because the MultiNICA agent tests the failed NIC several times before marking the resource OFFLINE. Messages recorded in the engine log during failover provide a detailed description of the events that take place. (The engine log is located in /var/VRTSvcs/log/engine_A.log.) The MultiNICA agent supports only one active NIC on one IP subnet; the agent does not work with multiple active NICs on the same subnet. The primary NIC must be congured before VCS is started. Use the ifconfig(1M) command to congure it manually, or edit the default les provided by the system to automatically congure the NIC at boot time.
N N
Type Denition
type MultiNICA ( static str ArgList[] = { Device, NetMask, ArpDelay, Options, RouteOptions, MonitorOnly, IfconfigTwice, HandshakeInterval, NetworkHosts } static int OfflineMonitorInterval = 60 static str Operations = None static int MonitorTimeout = 300 NameRule = MultiNICA_ + group.Name str Device{} str NetMask int ArpDelay = 1 str Options str RouteOptions int IfconfigTwice = 0 int HandshakeInterval = 90 str NetworkHosts[] )
30
MultiNICA Agent
Sample Conguration: MultiNICA and IPMultiNIC

In the following example, two machines, sysa and sysb, each have a pair of network interfaces, lan0 and lan3. The two interfaces, lan0 and lan3, have the same base, or physical, IP address. However, the addresses on different hosts can differ. Note the lines beginning Device@sysa and Device@sysb; the use of different physical addresses shows how to localize an attribute for a particular host. The MultiNICA resource fails over only the physical IP address to the backup NIC during a failure. The logical IP addresses are congured by the IPMultiNIC agent. The resources ip1 and ip2, shown in the following example, have the Address attribute which contains the logical IP address. If a NIC fails on sysa, the physical IP address and the two logical IP addresses fails over from lan0 to lan3. If lan3 fails, the address fails back to lan0 if lan0 is reconnected. However, if both the NICs on sysa are disconnected, the MultiNICA and IPMultiNIC resources work in tandem to fault the group on sysa. The entire group now fails over to sysb. If you have more than one group using the MultiNICA resource, the second group can use a Proxy resource to point to the MultiNICA resource in the rst group. This prevents redundant monitoring of the NICs on the same system. The IPMultiNIC resource is always made dependent on the MultiNICA resource. See IPMultiNIC Agent on page 19.
group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICA mnic ( Device@sysa = { lan0 = "166.98.16.103", lan3 = "166.98.16.103" } Device@sysb = { lan0 = "166.98.16.104", lan3 = "166.98.16.104" } NetMask = "255.255.255.0" Options = "arp" RouteOptions@sysa = "default 166.98.16.103 0" RouteOptions@sysb = "default 166.98.16.104 0" NetWorkHosts = { "166.11.20.31", "182.1.21.5" } ) IPMultiNIC ip1 ( Address = "166.98.14.78" NetMask = "255.255.255.0" MultiNICResName = mnic Options = "arp" ) ip1 requires mnic
31
MultiNICA Agent
group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNIC ip2 ( Address = "166.98.14.79" NetMask = "255.255.255.0" MultiNICResName = mnic Options = "arp" ) Proxy proxy ( TargetResName = mnic ) ip2 requires proxy
32
NFS Agent
NFS Agent
Description Starts and monitors the nfsd, rpc.mountd, rpc.lockd, and rpc.statd processes required by all exported NFS le systems. Supports NFS versions 2 and 3. N OnlineChecks if nfsd, rpc.mountd, rpc.lockd, and rpc.statd processes are running. If they are not running, the agent starts the processes and exits. N MonitorMonitors versions 2 and 3 of the nfsd process, versions 1, 2, and 3 of the rpc.mountd process, versions 1, 3, and 4 of the rpc.lockd process, and version 1 of the rpc.statd process. Monitors TCP and UDP versions of the processes by sending RPC (Remote Procedure Call) calls clnt_create and clnt_call to the RPC server. If calls succeed, the resource is reported ONLINE. N CleanKills all NFS-related processes (mentioned in the Online entry point description) and restarts them. Optional Attributes Type and Dimension integer-scalar Denition
Entry Points
Nservers
Species the number of concurrent NFS requests the server can handle. Default is 4.
Protocol
string-scalar
Selects the transport on which NFS service runs. Use the following options: N All (start NFS service over both UDP and TCP) N UDP (start NFS service over only UDP) N TCP (start NFS service over only TCP) Note The TCP option is not supported in this release. Use the UDP or All option instead.
33
NFS Agent
Type Denition
type NFS ( int Nservers = 4 NameRule = "NFS_" + group.Name + "_" + resource.Nservers static str ArgList[] = { Nservers, Protocol} static str Operations = OnOnly static int RestartLimit = 1 str Protocol = all )
Sample Conguration
NFS NFS_groupx ( Nservers = 8 Protocol = udp )
34
NIC Agent
NIC Agent
Description Monitors the congured NIC. If a network link fails, or if a problem arises with the device card, the resource is marked OFFLINE. The NIC listed in the Device attribute must have an administration IP address, which is the default IP address assigned to the physical interface of a host on a network. This agent does not congure network routes or administration IP addresses. N MonitorTests the network card and network link. Pings the hosts listed in the NetworkHosts attribute. If monitor successfully pings at least one host in the list, the resource is marked ONLINE.
Entry Point
State Denitions
that the NIC is working. that the NIC has failed.
UNKNOWNIndicates that the device is not congured or is congured incorrectly.
Required Attributes
Denition
Device
Name of the NIC. For example, lan0.
NetworkHosts
string-vector
List of hosts on the network. The agent pings the hosts to determine if the network connection is alive. Enter the IP address of the host instead of the HostName to prevent the monitor from timing out (DNS problems cause the ping to hang). For example, 166.96.15.22.
Optional Attribute
Denition
NetworkType
Type of network. VCS currently only supports Ethernet (ether).
35
NIC Agent
Requirements for NIC

Verify that each NIC has the correct administrative IP address and subnet mask. Verify that each NIC does not have built-in failover support. If it does, disable it. (If necessary, refer to the NIC documentation.)
Type Denition
type NIC ( static str ArgList[] = { Device, NetworkType, NetworkHosts } NameRule = group.Name + "_" + resource.Device static int OfflineMonitorInterval = 60 static str Operations = None str Device str NetworkType str NetworkHosts[] )
Sample Conguration
NIC groupx_lan0 ( Device = lan0 NetworkHosts = { "166.11.20.31", "182.1.21.5" } )
36
NotifierMngr Agent
NotierMngr Agent
Description Starts, stops, and monitors a notier process, making it highly available. The notier process manages the reception of messages from VCS and GCM and the delivery of those messages to SNMP consoles and SMTP servers. See the VERITAS Cluster Server Users Guide for a description of types of events that generate notication. See the notifier(1) manual page to congure notication from the command line. Note The attributes of the NotierMngr agent cannot be dynamically changed using the hares -modify command. Changes made using this command are effective after notier is restarted. Entry Points N OnlineStarts the notier process with its required arguments. N OfineVCS sends a SIGABORT. If the process does not exit within one second, VCS sends a SIGKILL. N MonitorMonitors the notier process. N CleanSends SIGKILL. State Denitions
that the Notier process is running. that the Notier process is not running. that the user did not specify the required attribute for the
UNKNOWNIndicates
resource. Required Attributes Type and Dimension stringassociation Description
SnmpConsoles
Species the machine name of the SNMP manager and the severity level of the messages to be delivered to the SNMP manager. The severity levels of messages are Information, Warning, Error, and SevereError. Specifying a given severity level for messages generates delivery of all messages of equal or higher severity. For example, "172.29.10.89" = Error, "172.29.10.56" = Information Note SnmpConsoles is a required attribute if SmtpServer is not specied; otherwise, SnmpConsoles is an optional attribute. The user can specify both SnmpConsoles and SmtpServer if necessary.
SmtpServer
string-scalar
Species the machine name of the SMTP server. Note SmtpServer is a required attribute if SnmpConsoles is not specied; otherwise, SmtpServer is an optional attribute. The user can specify both SmtpServer and SnmpConsoles if necessary.
37
NotifierMngr Agent
Optional Attributes
Description
MessagesQueue
Size of the VCS engines message queue. Default is 30.
NotierListeningPort
integer-scalar
Any valid TCP/IP port numbers that are not used. Default is 14144.
SnmpdTrapPort
integer-scalar
Port to which SNMP traps are sent. The value specied for this attribute is used for all consoles if more than one SNMP console is specied. Default is 162.
SnmpCommunity
string-scalar
Species the community ID for the SNMP manager. Default is "public".
SmtpRecipients
stringassociation
Species the email address to which information is sent and the severity level of the messages to be received. The severity levels of messages are Information, Warning, Error, and SevereError. Specifying a given severity level for messages indicates that all messages of equal or higher severity are received. For example, "james@veritas.com" = SevereError, "admin@veritas.com" = Warning Note SmtpRecipients is a required attribute if SmtpServer is specied.
EngineListeningPort
integer-scalar
Change this attribute if the VCS engine is listening on a port other than its default port. Default is 14141.
38
NotifierMngr Agent
Type Denition
type NotifierMngr ( static int RestartLimit = 3 static str ArgList [] = { EngineListeningPort, MessagesQueue, NotifierListeningPort, SnmpdTrapPort, SnmpCommunity, SnmpConsoles, SmtpServer, SmtpRecipients } NameRule = resource.PathName int EngineListeningPort = 14141 int MessagesQueue = 30 int NotifierListeningPort = 14144 int SnmpdTrapPort = 162 str SnmpCommunity = "public" str SnmpConsoles{} str SmtpServer str SmtpRecipients{} )
Sample Conguration
In the following conguration, the NotierMngr agent is congured to run with two resource groups, NicGrp and Grp1. NicGrp contains the NIC resource and a Phantom resource that enables VCS to determine the online and ofine status of the group. (See Phantom Agent on page 41 for more information on verifying the status of groups that only contain OnOnly or Persistent resources (such as the NIC resource). NicGrp must be enabled to run as a parallel group on both systems. Grp1 contains the NotierMngr resource (ntfr) and a Proxy resource (nicproxy), congured for the NIC resource in the rst group. In this example, NotierMngr has a dependency on the Proxy resource. Note Only one instance of the notier process can run in a cluster; the process cannot run in a parallel group. The NotierMngr resource sets up notication for all events to the SnmpConsole (snmpserv). In this example, only messages of SevereError level are sent to the SmptServer (smtp.your_company.com), and the recipient (vcsadmin@your_company.com).
39
NotifierMngr Agent
system north system south group NicGrp ( SystemList = { north, south} AutoStartList = { north } Parallel = 1 ) Phantom my_phantom ( ) NIC NicGrp_en0 ( Enabled = 1 Device = en0 NetworkType = ether )
group Grp1 ( SystemList = { north, south } AutoStartList = { north } ) Proxy nicproxy( TargetResName = "NicGrp_en0" ) NotifierMngr ntfr ( SnmpConsoles = { snmpserv = Information } SmtpServer = "smtp.your_company.com" SmtpRecipients = { "vcsadmin@your_company.com" = SevereError } ) ntfr requires nicproxy
// resource dependency tree // // group Grp1 // { // NotifierMngr ntfr // { // Proxy nicproxy // } // }

Phantom Agent
Phantom Agent
Description Enables VCS to determine the status of service groups that do not include OnOff resources (resources that VCS can start and stop as required) by providing a dummy resource that can be brought online and taken ofine. VCS cannot assess the status of service groups that only contain None (Persistent) and OnOnly resources because the state of these resources is not considered in the process of determining whether a group is online. Include the Phantom resource in service groups that do not have OnOff resources. Service groups that do not include OnOff resources as members are not brought online, even if their member resources are brought online. Refer to the VERITAS Cluster Server User's Guide for information on resource categories. Entry Point N MonitorDetermines status based on the status of its service group.
Type Denition
type Phantom ( static str ArgList[] = { Dummy } NameRule = Phantom_ + group.Name str Dummy )
Note The Dummy attribute is for VCS use only and is not congurable.
Sample Congurations
Sample 1
Phantom ( )
41
Phantom Agent
Sample 2 The following example shows a complete conguration le (main.cf), in which the FileNone resource and the Phantom resource are in the same group.
include "types.cf" cluster PhantomCluster system sysa system sysb group phantomgroup ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) FileNone my_file_none (PathName = "/tmp/file_none" ) Phantom my_phantom ( ) // resource dependency tree // // group maingroup // { // Phantom my_Phantom // FileNone my_file_none // }
42
Process Agent
Process Agent
Description Entry Points Starts, stops, and monitors a process specied by the user. N OnlineStarts the process with optional arguments. N OfineTerminates the process with a SIGTERM. If the process does not exit, VCS sends a SIGKILL. N MonitorChecks to see if the process is alive by scanning the process table for the name of the executable pathname and argument list. The procfs interface limits the match to the initial 80 characters. Required Attribute Type and Dimension string-scalar Description
PathName
Denes complete pathname to access an executable program; the path includes the program name. If a process is controlled by a script, the PathName denes the complete path to the shell. Pathname must not exceed 80 characters.
Optional Attribute
Description
Arguments
Passes arguments to the process. If a process is controlled by a script, the script is passed as an argument. Multiple arguments must be separated by a single space. A string cannot accommodate more than one space between arguments, nor allow for leading or trailing whitespace characters. Arguments must not exceed 80 characters (total).
Type Denition
type Process ( static str ArgList[] = { PathName, Arguments } NameRule = resource.PathName str PathName str Arguments )
43
Process Agent
Sample Congurations
Sample 1
Process usr_lib_sendmail ( PathName = "/usr/lib/sendmail" Arguments = "bd q1h" )
Sample 2
include "types.cf" cluster ProcessCluster ( . . . group ProcessGroup ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) Process Process1 ( PathName = "/usr/local/bin/myprog" Arguments = "arg1 arg2" ) Process Process2 ( PathName = "/bin/csh" Arguments = "/tmp/funscript/myscript" ) // resource dependency tree // // group ProcessGroup // { // Process Process1 // Process Process2 // }
44
Proxy Agent
Proxy Agent
Description Mirrors the state of another resource on a local or remote system. Provides a means to specify and modify one resource and have it reected by its proxies. N MonitorDetermines status based on the target resource status. Type and Dimension string-scalar Description
Entry Point Required Attribute
TargetResName
Name of the target resource whose status is mirrored by Proxy resource. The target resource must be in a different resource group from the Proxy resource. Description
Optional Attribute
TargetSysName
Mirror the status of the TargetResName on system specied by the TargetSysName variable. If this attribute is not specied, the Proxy resource assumes the system is local.
Type Denition
type proxy ( static str ArgList[] = { TargetResName, TargetSysname, "TargetResName:Probed", TargetResName:State } NameRule = Proxy_ + resource.TargetResName static int OfflineMonitorInterval = 60 static str Operations = None str TargetResName str TargetSysName )
45
Proxy Agent
Sample Congurations
Sample 1
// Proxy resource to mirror the state of the resource // tmp_VRTSvcs_file1 on the local system. Proxy proxy1 ( TargetResName = "tmp_VRTSvcs_file1" )
Sample 2
// Proxy resource to mirror the state of the resource // tmp_VRTSvcs_file1 on sys1. Proxy proxy1( TargetResName = "tmp_VRTSvcs_file1" TargetSysName = "sys1" )
Sample 3
// // // // Proxy agent to mirror the state of the resource mnic on the local system; note that target resource is in grp1, proxy in grp2; a target resource and its proxy cannot be in the same group.
group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICA mnic ( Device@sysa = { lan0 = "166.98.16.103",lan3 = "166.98.16.103" } Device@sysb = { lan0 = "166.98.16.104",lan3 = "166.98.16.104" } NetMask = "255.255.255.0" Options = "arp" RouteOptions@sysa = "default 166.98.16.103 0" RouteOptions@sysb = "default 166.98.16.104 0" NetWorkHosts = { "166.11.20.31", "182.1.21.5" } ) IPMultiNIC ip1 ( Address = "166.98.14.78" NetMask = "255.255.255.0" MultiNICResName = mnic Options = "arp"
Proxy Agent
) ip1 requires mnic group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNIC ip2 ( Address = "166.98.14.79" NetMask = "255.255.255.0" MultiNICResName = mnic Options = "arp" ) Proxy proxy ( TargetResName = mnic ) ip2 requires proxy
47
ServiceGroupHB Agent
Description Starts, stops, and monitors disk-based heartbeats associated with service groups. See the VERITAS Cluster Server 3.5 Users Guide for details. The heartbeat region resides on a block device (typically a logical volume) and consists of 128 blocks starting on the specied block number (see Disks attribute). The local system, via the ServiceGroupHB agent, tries to obtain ownership of the available disks as specied by the Disks attribute. The system gains ownership of a device when it determines that the device is available and not owned by another system. When the systems disk ownership meets the requirement of the AllOrNone attribute, the agent brings the resource online and monitors the resource. If disk ownership falls below the AllOrNone requirement, VCS tries to fail over the group to another system. Entry Points N OnlineBrings resource online after ownership of the required number of disks or block devices is obtained. N OfineTakes resource ofine after relinquishing ownership of previously acquired disks. N CleanTakes resource ofine and relinquishes ownership of previously acquired disks. N OpenCreates logical disk objects based on Disks attribute at VCS startup. N CloseAt VCS shutdown, deletes the logical disk objects created by Open. N MonitorPeriodically checks if local system has ownership of required number of disks. Required Attributes Type and Dimension string-vector Description
Disks
Species, in paired values, the block device (typically a logical volume) and the starting block location to use for the heartbeat. For example, if the block device /dev/vg01/lvol_hb is used for the heartbeat region, and the starting block is 16, the paired set of values is /dev/vg01/lvol_hb, 16. A block device partition containing one or more heartbeat regions cannot be used for any other purpose. If the same device is used for more than one heartbeat region, starting block numbers must be at least 64K (128 disk blocks) apart.
AllOrNone
boolean-scalar
Species number of block devices for which ownership is required to bring the resource online: N all available devices (AllOrNone = 1) N a simple majority of available devices (AllOrNone = 0) Default is 1.
48
Type Denition
type ServiceGroupHB ( static str ArgList[] = { Disks, AllOrNone } static int OnlineRetryLimit = 5 NameRule = "" str Disks[] boolean AllOrNone = 1 )
Sample Conguration
In this example, the volumes /dev/vg01/hb_vol1, /dev/vg01/hb_vol2, and /dev/vg01/hb_vol3 have service group heartbeat regions beginning at block 64 for service group groupz. The device /dev/vg01/hb_vol1 has a second heartbeat region beginning at block 192 for service group groupy. The AllOrNone attribute is set to 0 for sghb1, specifying that the service group can come online with ownership of two disks.
. system sysa . system sysb . . . group groupz ( . . ) ServiceGroupHB sghb1 ( Disks = { /dev/vg01/hb_vol1, 64, /dev/vg01/hb_vol2, 64, /dev/vg01/hb_vol3, 64 } AllorNone = 0 ) Mount exp1 MountPoint = "/soup" BlockDevice = "/dev/vg01/vol4" FSType = ufs MountOpt = rw ) group groupy ( .
Chapter 2, VCS Bundled Agents 49
. ) . ServiceGroupHB sghb2 ( Disks = { /dev/vg01/hb_vol1, 192 } ) Mount exp2 MountPoint = "/nuts" BlockDevice = "/dev/vg01/lvol5" FSType = ufs MountOpt = rw ) . exp1 requires sghb1 exp2 requires sghb2 // resource dependency tree // // // group groupz // { // Mount exp1 // { // ServiceGroupHB sghb1 // } // } // group groupy // { // Mount exp2 // { // ServiceGroupHB sghb2 // } // }
50
Share Agent
Share Agent
Description Shares, unshares, and monitors a single local resource for exporting an NFS le system to be mounted by remote systems. N OnlineShares an NFS le system. N OfineUnshares an NFS le system. N MonitorReads /etc/xtab le and looks for an entry for the le system specied by PathName. If the entry exists, monitor returns ONLINE. Required Attribute Type and Dimension string-scalar Type and Dimension string-scalar Description
Entry Points
PathName Optional Attribute
Pathname of the le system to be shared. Description
Options
Options for the exportfs command.
Type Denition
type Share ( static str ArgList[] = { PathName, Options } NameRule = nfs + resource.PathName str PathName str Options )
Sample Conguration
Share nfsshare1x ( PathName = "/share1x" )
51
Volume Agent
Volume Agent
Description Brings online, takes ofine, and monitors a VERITAS Volume Manager (VxVM) volume. N OnlineStarts the volume using the vxrecover command. N OfineStops the volume using the vxvol command. N MonitorDetermines if the volume is online or ofine by reading a block from the raw device interface to the volume. N CleanSee description on page 5. Required Attributes Type and Dimension string-scalar Description
Entry Points
DiskGroup
Name of the disk group which contains the volume. For example, DG1.
Volume
string-scalar
Name of the volume. For example, DG1Vol1.
Type Denition
type Volume ( static str ArgList[] = { Volume, DiskGroup } NameRule = resource.DiskGroup + "_" + resource.Volume str Volume str DiskGroup static int NumThreads = 1 )
Sample Conguration
Volume sharedg_vol3 ( Volume = vol3 DiskGroup = sharedg )
52
VRTSWebApp Agent
VRTSWebApp Agent
Description Brings Web applications online, takes them ofine, and monitors their status. The application is a Java Web application conforming to the Servlet Specication 2.2 and runs inside of the Java Web server installed as a part of the VRTSweb package. This agent is used to monitor the Web Consoles of various VERITAS products, such as VCS, GCM, and VVR. OnlineStarts the Web application with the specied parameters. If the Web server is not already running, it will rst start the server. OfineRemoves the Web application from the Web server. If no other Web application is running, it shuts down the Web server. MonitorChecks if the specied Web application is currently running inside the Web server. If the application is running, monitor reports ONLINE. If the application is not running, monitor reports OFFLINE. CleanRemoves the Web application from the Web server. If no other Web application is running, it shuts down the Web server. Required Attributes Type and Dimension Description
Entry Points
AppName
string-scalar
Name of the application as it appears in the Web server. For example, for GCM, use "gcm"; for VCS, use "vcs". Access the applications at: http://hostname:8181/gcm or http://localhost:8181/vcs.
InstallDir
string-scalar
Path to the Web application installation. The Web application must be installed as a .war le with the same name as the AppName parameter; the "vcs" application must be installed as vcs.war. This attribute should point to the directory that contains this .war le. For example, if AppName is "vcs" and InstallDir is "/opt/VRTSweb/VERITAS", the agent constructs the path for the Web application as /opt/VRTSweb/VERITAS/vcs.war.
TimeForOnline
integer-scalar
The time the Web application takes to start after it is loaded into the Web server. This parameter is returned as the exit value of the online script, which inform VCS of the time it needs to wait before calling monitor on the Web application resource. This attribute is typically at least ve seconds.
53
VRTSWebApp Agent
Type Denition
type VRTSWebApp ( static str ArgList[] = { AppName, InstallDir,TimeForOnline } NameRule = VRTSWebApp + "_Web_Application" str AppName str InstallDir int TimeForOnline static int NumThreads = 1 )
Sample Conguration
VRTSWebApp VCSweb ( AppName = "vcs" InstallDir = "/opt/VRTSweb/VERITAS" TimeForOnline = 5 )
54
Index
A Agents Application 6 bundled 1 defining 1 DiskGroup 11 ElifNone 13 enterprise vii FileNone 14 FileOnOff 15 FileOnOnly 16 IP 17 IPMultiNIC 19 LVMCombo 22 LVMLogicalVolume 24 LVMVolumeGroup 25 Mount 26 MultiNICA 28 NFS 33 NIC 35 NotifierMngr 37 Phantom 41 Process 43 Proxy 45 ServiceGroupHB 48 Share 51 Volume 52 VRTSWebApp 53 Application agent 6 Applications managing 6 Attributes modifying 1 B Bundled agents categories of 2 defining 1 C Cluster Manager (Java Console) modifying attributes 2 Cluster Manager (Web Console) modifying attributes 2 monitoring 53 Commands exportfs 51 fsck 26 hares -modify 37 ifconfig 17, 18, 19, 29, 30 lvchange 24 mount 26 noautoimport 12 stat 26 statvfs 26 vgchange 25 vgdisplay 25 vxdg 11 vxrecover 52 vxvol 52 Configuration files main.cf 1, 5, 19, 42 modifying 2 types.cf 1, 5 D Disk groups managing 11 DiskGroup agent 11 Disks heartbeat 48 E ElifNone agent 13 Enterprise agents vii Entry points defining 5
55
F File systems mount point 26 NFS sharing 51 types 26 FileNone agent 14 FileOnOff agent 15 FileOnOnly agent 16 Files monitoring 13, 14, 15, 16 H Heartbeat disk regions 48 I IP address base 28 configuring 17, 19 IP agent 17 IPMultiNIC agent 19 L LVMCombo agent 22 LVMLogicalVolume agent 24 LVMVolumeGroup agent 25 M main.cf 1, 5, 19, 42 Mount agent 26 MultiNICA agent 28 N NFS agent 33 NIC agent 35 Notifier process W T S P
managing 37 NotifierMngr agent 37 Phantom agent 41 Process agent 43 Proxy agent 45 R Resource types relation to agents 1 Resources description of 1 relation to entry points 5 ServiceGroupHB agent 48 Share agent 51 SMTP servers receiving messages 37 SNMP consoles receiving messages 37 types.cf 1, 5 V Volume agent 52 Volume Manager (VxVM) managing a disk group 11 VRTSWebApp agent 53 Web Consoles monitoring 53
56

VERITAS Cluster Server 3.5 Bundled Agents: Reference Guide

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

VERITAS Cluster Server 3.5 Bundled Agents: Reference Guide

Hochgeladen von

Copyright:

Verfügbare Formate

VERITAS Cluster Server 3.

October 2002 N09207G

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

VCS Enterprise and Storage Agents

Informix NetBackup Oracle Sybase

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Resources and Their Attributes

Modifying Agents and Their Resources

Modifying Agents and Their Resources

Categories of Bundled Agents

IP IPMultiNIC MultiNICA NIC

DiskGroup LVMCombo LVMLogicalVolume LVMVolumeGroup Mount NFS Share Volume

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Categories of Bundled Agents

VCS Infrastructure and Support

NotierMngr Phantom Proxy ServiceGroupHB VRTSWebApp ElifNone FileNone FileOnOff FileOnOnly

Categories of Bundled Agents

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

VCS Bundled Agents

that the applications state is indeterminable.

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Type and Dimension string-scalar

Type and Dimension string-scalar

Chapter 2, VCS Bundled Agents

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Chapter 2, VCS Bundled Agents

Abnormal termination of program (MonitorProgram/CleanProgram).

Error while getting information about user.

Memory allocation failed.

No start program dened.

No stop program dened.

Program (StartProgram/StopProgram) does not exist or is not executable.

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Type and Dimension string-scalar

Chapter 2, VCS Bundled Agents

Setting the noautoimport Flag for a Disk Group

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Chapter 2, VCS Bundled Agents

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Chapter 2, VCS Bundled Agents

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Type and Dimension integer-scalar

Chapter 2, VCS Bundled Agents

Options for the ifconfig command. For example, "broadcast 10.182.15.255".

Sample 2: NetMask in decimal (base 10)

Sample 3: NetMask in hexadecimal (base 16)

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Type and Dimension string-scalar string-scalar

Type and Dimension integer-scalar

Options for the ifconfig command. For example, "broadcast 10.182.15.255".

Chapter 2, VCS Bundled Agents

Sample Conguration, IPMultiNIC and MultiNICA

group grp2 ( SystemList = { sysa, sysb }

Chapter 2, VCS Bundled Agents

List of logical volumes in a volume group. Name of a volume group.

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Chapter 2, VCS Bundled Agents

VERITAS Cluster Server Bundled Agents Reference Guide, 3.5

Name of the volume group congured with LVM.

Chapter 2, VCS Bundled Agents

Type and Dimension string-scalar string-scalar

MountPoint Optional Attributes