Sei sulla pagina 1di 106

VERITAS Cluster Server 4.

0
Bundled Agents Reference Guide
AIX

N10186J August 2004

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 fitness 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. VERITAS Legal Notice Copyright 1998-2004 VERITAS Software Corporation. All rights reserved. VERITAS, VERITAS Software, the VERITAS logo, VERITAS VERITAS Cluster Server, and all other VERITAS product names and slogans are trademarks or registered trademarks of VERITAS Software Corporation. VERITAS, the VERITAS Logo, and VERITAS Cluster Server Reg. U.S. Pat. & Tm. Off. 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 USA Phone 6505278000 Fax 6505272901 www.veritas.com Third-Party Copyrights
Apache License
Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work. "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

ii

VERITAS Cluster Server Bundled Agents Reference Guide

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

VERITAS Cluster Server Bundled Agents Reference Guide

iii

Data Encryption Standard (DES)


Support for data encryption in VCS is based on the MIT Data Encryption Standard (DES) under the following copyright: Copyright 1990 Dennis Ferguson. All rights reserved. Commercial use is permitted only if products that are derived from or include this software are made available for purchase and/or use in Canada. Otherwise, redistribution and use in source and binary forms are permitted. Copyright 1985, 1986, 1987, 1988, 1990 by the Massachusetts Institute of Technology. All rights reserved. Export of this software from the United States of America may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting. WITHIN THAT CONSTRAINT, permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of M.I.T. not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. M.I.T. makes no representations about the suitability of this software for any purpose. It is provided as is without express or implied warranty.

SNMP Software
SNMP support in VCS is based on CMU SNMP v2 under the following copyright: Copyright 1989, 1991, 1992 by Carnegie Mellon University All Rights Reserved Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of CMU not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

iv

VERITAS Cluster Server Bundled Agents Reference Guide

Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii How This Guide Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv VCS Enterprise Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Resources and Their Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Modifying Agents and Their Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Categories of Bundled Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Application Control Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Basic Storage Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Global Cluster Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Networking Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 VCS Infrastructure and Support Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Chapter 2. VCS Bundled Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Application Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
v

Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Application Agent Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 DiskGroup Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Setting the noautoimport Flag for a Disk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Info Entry Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 DNS Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Online Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Monitor Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Sample Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 ElifNone Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Entry Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

vi

VERITAS Cluster Server Bundled Agents Reference Guide

FileNone Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Entry Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 FileOnOff Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 FileOnOnly Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 IP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Optional Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 IPMultiNIC Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Contents vii

Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Optional Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Sample Configuration: IPMultiNIC and MultiNICA . . . . . . . . . . . . . . . . . . . . . . . . 27 IPMultiNICB Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Sample Configuration: MultiNICB and IPMultiNICB . . . . . . . . . . . . . . . . . . . . . . . . 30 LVMVG Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Notes on the LVMVG Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Mount Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Info Entry Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Listing File Systems in /etc/filesystems on AIX 5.1c . . . . . . . . . . . . . . . . . . . . . . . . 41
viii VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICA Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Sample Configuration: MultiNICA and IPMultiNIC . . . . . . . . . . . . . . . . . . . . . . . . . 45 MultiNICB Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Checklist for Using MultiNICB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Advantages of MultiNICB and IPMultiNICB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Limitations of MultiNICB and IPMultiNICB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 How MultiNICB Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Sample Configuration: MultiNICB and IPMultiNICB . . . . . . . . . . . . . . . . . . . . . . . . 54 NFS Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 NIC Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Contents ix

State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 NotifierMngr Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Optional Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Phantom Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Process Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Optional Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Proxy Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
x VERITAS Cluster Server Bundled Agents Reference Guide

Optional Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 ServiceGroupHB Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Share Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 State Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Required Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Optional Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Volume Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 VRTSWebApp Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Entry Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Required Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Contents xi

xii

VERITAS Cluster Server Bundled Agents Reference Guide

Preface
This guide provides reference information for the VCS agents bundled with VERITAS Cluster Server (VCS) software on the AIX operating system. The guide provides information on configuring and using bundled agents.

How This Guide Is Organized


Chapter 1, Introduction on page 1 introduces the bundled agents. Chapter 2, VCS Bundled Agents on page 5 describes each of the bundled agents.

xiii

Conventions

Conventions
Convention monospace Usage Used for path names, commands, output, directory and file names, functions, and parameters. Example Read tunables from the /etc/vx/tunefstab file. See the ls(1) manual page for more information. # ls pubs C:\> dir pubs Identifies book titles, new terms, emphasized text, and variables replaced with a name or value. Depicts GUI objects, such as fields, list boxes, menu selections, etc. Also depicts GUI commands. Indicates hypertext links. Unix superuser prompt (all shells). See the Users Guide for details. The variable system_name indicates the system on which to enter the command. Enter your password in the Password field. Press Return. See Getting Help on page xv. # cp /pubs/4.0/user_book /release_mgnt/4.0/archive

monospace (bold)
italic

Indicates user input.

bold

blue text #

xiv

VERITAS Cluster Server Bundled Agents Reference Guide

Getting Help

Getting Help
For technical assistance, visit http://support.veritas.com and select phone or email support. This site also provides access to resources such as TechNotes, product alerts, software downloads, hardware compatibility lists, and our customer email notification service. Use the Knowledge Base Search feature to access additional product information, including current and past releases of VERITAS documentation. Additional Resources For license information, software updates and sales contacts, visit https://my.veritas.com/productcenter/ContactVeritas.jsp. For information on purchasing product documentation, visit http://webstore.veritas.com.

Documentation Feedback
Your feedback on product documentation is important to us. Send suggestions for improvements and reports on errors or omissions to clusteringdocs@veritas.com. Include the title and part number of the document (located in the lower left corner of the title page), and chapter and section titles of the text on which you are reporting. Our goal is to ensure customer satisfaction by providing effective, quality documentation. For assistance with topics other than documentation, visit http://support.veritas.com.

VCS Enterprise Agents


VCS enterprise 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:

DB2 UDB NetBackup Oracle

Preface

xv

VCS Enterprise Agents

xvi

VERITAS Cluster Server Bundled Agents Reference Guide

Introduction

Bundled agents are VCS processes that manage resources of predefined 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 configuration information from VCS. The agent then periodically monitors the resources, and updates VCS with the resource status. Agents typically: Bring resources online. Take resources offline. Monitor resources and report state changes to VCS. Note Refer to the VERITAS Cluster Server 4.0 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 defined in the types.cf file by a collection of attributes. Each type has a corresponding agent that is designed to control the resource. The VCS configuration file, main.cf, contains the values for the resource attributes and has an include directive to the types.cf file. An attributes given value configures the resource to function in a specific 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, and you set the attribute Address to monitor the specific IP address.

Entry Points

Entry Points
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, offline, and monitor entry points, the clean entry point applies to many 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 offline (perhaps forcibly). Refer to the VERITAS Cluster Server Agent Developers Guide for more information on entry points and the VCS agent framework. Refer to the VERITAS Cluster Server Users Guide for more information on VCS attributes.

Modifying Agents and Their Resources


Use Cluster Manager (Java Console), Cluster Manager (Web Console), or the VCS command line to dynamically modify the configuration of the resources managed by an agent. See the VERITAS Cluster Server 4.0 Users Guide for instructions on how to complete these tasks. VCS enables you to edit the main.cf file 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:

Application Control Agents


Application Agent on page 6 Process Agent on page 67

Basic Storage Agents


DiskGroup Agent on page 11 LVMVG Agent on page 31 Mount Agent on page 38 NFS Agent on page 55 Share Agent on page 77 Volume Agent on page 79
VERITAS Cluster Server Bundled Agents Reference Guide

Categories of Bundled Agents

Global Cluster Support


DNS Agent on page 14 Wide Area Heartbeat While global clusters require the Wide Area Heartbeat agent, it is not a standard VCS agent for monitoring VCS resources. It is documented in the VCS Users Guide section on global clusters.

Networking Agents

IP Agent on page 22 IPMultiNIC Agent on page 25 IPMultiNICB Agent on page 28 MultiNICA Agent on page 43 MultiNICB Agent on page 47 NIC Agent on page 57

VCS Infrastructure and Support Agents


ElifNone Agent on page 18 FileNone Agent on page 19 FileOnOff Agent on page 20 FileOnOnly Agent on page 21 NotifierMngr Agent on page 60 Phantom Agent on page 65 Proxy Agent on page 70 ServiceGroupHB Agent on page 73 VRTSWebApp Agent on page 80

Chapter 1, Introduction

Categories of Bundled Agents

VERITAS Cluster Server Bundled Agents Reference Guide

VCS Bundled Agents


This chapter provides information on the VCS bundled agents. Described for each bundled agent are its resource types, entry points, state definitions, and modifiable attributes. The tables associated with bundled agents indicate required and optional attributes. Included are its resource type, defined in the types.cf file, and a sample configuration in the main.cf file.

Application Agent

Application Agent
Description
Brings applications online, takes them offline, and monitors their status. Enables you to specify different executables for the online, offline, 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-specified programs. You can monitor the application in the following ways:

Use the monitor program Specify a list of processes to be monitored Specify a list of process ID files to be monitored All or some of the above

Entry Points

OnlineRuns the StartProgram with the specified parameters in the specified user context. OfflineRuns the StopProgram with the specified parameters in the specified user context. MonitorIf MonitorProgram is specified, the agent executes the user-defined MonitorProgram in the user-specified context. If PidFiles is specified, the routine verifies that the process ID found in each listed file is running. If MonitorProcesses is specified, the routine verifies that each listed process is running in the user-specified 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 specified in either PidFiles or MonitorProcesses is determined not to be running, the monitor returns OFFLINE. CleanKills processes specified in PidFiles or MonitorProcesses. Ensures that only those processes (specified in MonitorProcesses) running with the user ID specified in the User attribute are killed. If the CleanProgram is defined, the agent executes the CleanProgram.

VERITAS Cluster Server Bundled Agents Reference Guide

Application Agent

State Definitions
ONLINEIndicates that all processes specified in PidFiles and MonitorProcesses are running and that the MonitorProgram returns ONLINE. OFFLINEIndicates

that at least one process specified in PidFiles or MonitorProcesses is not running, or that the MonitorProgram returns OFFLINE. that the applications state is indeterminable.

UNKNOWNIndicates

Required Attributes
Required Attributes Type and Dimension string-scalar Definition

StartProgram

The executable, created locally on each node, which 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, which 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 descriptions Optional Attributes on page 8.

StopProgram

string-scalar

At least one of the following attributes:


MonitorProcesses MonitorProgram PidFiles

See descriptions under Optional Attributes on page 8.

Chapter 2, VCS Bundled Agents

Application Agent

Optional Attributes
Optional Attributes CleanProgram Type and Dimension string-scalar Definition

The executable, created locally on each node, which 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, which monitors 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 confidence level), 110 equals confidence level of 100%. Any other value = UNKNOWN.

PidFiles

string-vector

A list of PID files that contain the process ID of the processes to be monitored and cleaned. These files are application-generated files. Each PID file contains one PID that is monitored. Specify the complete path of each PID file in the list. The process ID can change when the process restarts. If the application takes time to update the pid file, the agents monitor script may return an incorrect result. If this occurs, increase the ToleranceLimit in the resource definition.

User

string-scalar

The user whose id is used to run StartProgram, StopProgram, MonitorProgram, and CleanProgram. The processes specified in the MonitorProcesses list must run in the context of the specified user. Monitor checks the processes to make sure they run in this context. Default is "root".

VERITAS Cluster Server Bundled Agents Reference Guide

Application Agent

Type Definition
type Application ( static str ArgList[] = { User, StartProgram, StopProgram, CleanProgram, MonitorProgram, PidFiles, MonitorProcesses } str User str StartProgram str StopProgram str CleanProgram str MonitorProgram str PidFiles[] str MonitorProcesses[] )

Sample Configurations
Sample 1
In this example, the executable samba is configured as StartProgram and StopProgram, with start and stop specified as command-line arguments respectively. The agent is configured to monitor two processes: a process specified 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 specified, so the root user is used. The executable samba is used to start and stop 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. In addition, the processes smbd and nmbd are monitored.
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" } )
Chapter 2, VCS Bundled Agents 9

Application Agent

Application Agent Error Messages


Message File ${VCS_HOME}/bin/Application/ functions not found. Tag A Description Check if file ${VCS_HOME}/bin/Application/ functions exists and has proper permissions. Check if the specified user exists on the local systems. Check if the specified StartProgram exists and the user specified permission to execute it. No Start Program is specified in the resource definition and hence cannot bring the resource online. Nothing is specified to monitor the resource. Specify at least one parameter to monitor the resource.

User user does not exist.

Start Program does not exist or is not executable. No Start Program specified.

None of the parameters (MonitorProgram, PidFiles, MonitorProcesses) are specified to monitor the application. Monitor Program does not exist or is not executable.

Check if the specified MonitorProgram exists and the specified user has permission to execute it. Check if the specified StopProgram exists and the specified user has permission to execute it. No Stop Program is specified in the resource definition and hence cannot take the resource offline. Check if the specified CleanProgram exists and the specified user has permission to execute it.

Stop Program does not exist or is not executable.

No Stop Program specified.

Clean Program does not exist or is not executable.

10

VERITAS Cluster Server Bundled Agents Reference Guide

DiskGroup Agent

DiskGroup Agent
Description
Brings online, takes offline, and monitors a VERITAS Volume Manager (VxVM) disk group. This agent uses VxVM commands.

Entry Points

OnlineImports the disk group using the vxdg command. OfflineDeports the disk group using the vxdg command. MonitorDetermines if the disk group is online or offline using the vxdg command. If the disk group was imported with noautoimport=off, the group to which the disk group belongs is taken offline (assuming the group is not frozen). If the monitor hangs, no attempt takes place to take the disk group offline. The dependent groups can be taken offline (provided the disk group is functional) and the resnotoff trigger can be called.

CleanSee Entry Points on page 2 for more information on the Clean entry point. InfoThe DiskGroup info entry point gets information from the Volume Manager and displays the type and free size for the DiskGroup resource.

State Definitions
ONLINEIndicates OFFLINEIndicates

that the disk group is imported. that the disk group is not imported.

UNKNOWNIndicates that a problem exists either with the configuration or the ability

to determine the status of the resource.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

DiskGroup

Name of the disk group configured with VERITAS Volume Manager, for example: diskgroup1.

Chapter 2, VCS Bundled Agents

11

DiskGroup Agent

Optional Attributes
Optional Attributes Type and Dimension string-scalar Definition

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.

Setting the noautoimport Flag for a Disk Group


VCS requires that the noautoimport flag 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 offline. Note Be aware that when you enable a disk group configured as a DiskGroup resource that does not have the noautoimport flag set to true, VCS forcibly deports the disk group and reimports it with the noautoimport flag set to true. This may disrupt applications running on the disk group. To check the status of the noautoimport flag for an imported disk group, enter:
# vxprint -l disk_group | grep noautoimport

If the output from this command is blank, the noautoimport flag is set to false and VCS lacks the necessary control. To explicitly set the noautoimport flag to true, deport the disk group and import it with the -t option as follows: To deport the disk group, enter:
# vxdg deport disk_group

To import the disk group, specifying the noautoimport flag be set to true to ensure the disk group is not automatically imported, enter:
# vxdg -t import disk_group

12

VERITAS Cluster Server Bundled Agents Reference Guide

DiskGroup Agent

Info Entry Point


The following steps are necessary to initiate the info entry point by setting the InfoInterval timing to a value greater than 0, for example:
# haconf -makerw # hatype -modify DiskGroup InfoInterval 60

In this case, the info entry point executes every 60 seconds. The command to retrieve information about the DiskType and FreeSize of the DiskGroup resource is:
# hares -value diskgroupres ResourceInfo

Output includes the following information:


DiskType sliced FreeSize 35354136

Type Definition
type DiskGroup ( static int OnlineRetryLimit = 1 static str ArgList[] = { DiskGroup, StartVolumes, StopVolumes, MonitorOnly, MonitorReservation, tempUseFence} str DiskGroup str StartVolumes = 1 str StopVolumes = 1 static int NumThreads = 1 boolean MonitorReservation = 0 temp str tempUseFence = "INVALID" )

Sample Configuration
DiskGroup dg1 ( DiskGroup = testdg_1 )

Chapter 2, VCS Bundled Agents

13

DNS Agent

DNS Agent
If an application that is required to be available across the wide area is a server for an IP address, and if this application is failed over to another subnet, the IP address from the downed host cannot be effectively moved. A better solution is to update the canonical name mapping in the DNS name server with the hostname of the system where the application is now online.

Description
Updates the canonical name mapping in the domain name server when failing over applications across subnets (wide-area failover).

Entry Points

MonitorIf the online lock file exists, the monitor queries the name servers for the CNAME record for the Alias and reports back ONLINE if the response from at least one of the name servers contains the same canonical name associated with the alias as specified in the HostName attribute. If not, the monitor reports resource OFFLINE. OnlineQueries the authoritative name server of the domain for CNAME records. OfflineRemoves the online lock file created by the online function. OpenRemoves the online lock file if the online lock file exists, and the CNAME record on the name server does not contain the expected alias/canonical name mapping. CleanRemoves the online lock file, if present.

14

VERITAS Cluster Server Bundled Agents Reference Guide

DNS Agent

Required Attributes
Required Attributes Type and Dimension string-scalar Description

Domain

String representing the domain name, for example: veritas.com. String representing the alias to the canonical name, for example: www is the alias to the canonical name mtv.veritas.com in the earlier example. String representing canonical name of a system/IP address, for example: mtv.veritas.com, hro.veritas.com. Non-zero integer value representing the "Time To Live" value, in seconds, for the DNS entries in the zone being updated. Default is 1 day. The list of primary master name servers in the domain. This is optional if the primary master name server is listed in the zones NS record. If the primary master name server is a stealth server, the attribute must be defined. Note A stealth server is a name server that is authoritative for a zone, but is not listed in that zones NS records.

Alias

string-scalar

HostName

string-scalar

TTL

integer-scalar

StealthMasters

string-keylist

Online Query
If the canonical name in the response CNAME record does not match the one specified for the resource, online tries to update the CNAME record on all authoritative master name servers in its domain (those master name servers that can be reached and on which it has update permission). If the DNS update was successful or was not necessary on at least one of the name servers, the online function creates an online lock file. The monitor function checks for the existence of this file. The online lock file is not created if no name server in the domain could be updated. If the PrimaryMasters attribute is specified, Online tries to update the name servers specified in the PrimaryMasters attribute since the primary master is a stealth server which is not listed in the zone's NS record. In BIND 8, the primary master name server on receiving an update sends notification (NOTIFY) to all its slave servers asking them to pick up the update.

Chapter 2, VCS Bundled Agents

15

DNS Agent

Monitor Scenarios
Online lock file exists NO YES YES Expected CNAME RR N/A NO YES Monitor returns OFFLINE OFFLINE ONLINE

Note The DNS agent supports BIND version 8 and above.

Type Definition
type DNS ( static str ArgList[] = { Domain, Alias, HostName, TTL, StealthMasters} str Domain str Alias str HostName int TTL = 86400 // i.e: 1 day str StealthMasters[] )

Sample Scenario
As an example, consider the VERITAS corporate web server. A person using a web browser specifies the URL www.veritas.com to view the VERITAS web page (where www.veritas.com maps to the canonical name mtv.veritas.com, which is a host in Mountain View running the web server). The browser, in turn, retrieves the IP address for the web server by querying the domain name servers. If the web server for www.veritas.com is failed over from Mountain View to Heathrow, the domain name servers need to be updated with the new canonical name mapping so that clients (web browsers) are directed to Heathrow instead of Mountain View. In case of a failover, the DNS agent should update the name server to change the mapping of www.veritas.com, from mtv.veritas.com to the canonical name of the standby machine in Heathrow (e.g. hro.veritas.com).

16

VERITAS Cluster Server Bundled Agents Reference Guide

DNS Agent

Sample Configuration
Heres a sample configuration for DNS.
DNS www ( Domain = "example.com" Alias = www Hostname = wwwvirtual1

Bringing the "www" resource online updates the authoritative nameservers for domain "example.com" with the following CNAME record:
wwwCNAMEwwwvirtual1

Thus all DNS lookups for www.example.com are resolved to wwwvirtual1.example.com.

Chapter 2, VCS Bundled Agents

17

ElifNone Agent

ElifNone Agent
Description
Monitors a file.

Entry Point

MonitorChecks if the specified file exists. If it does, the agent reports as offline. If it does not, the agent reports as online.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

PathName

Specifies the complete pathname. Starts with the slash (/) that precedes the file name.

Type Definition
type ElifNone ( static str ArgList[] = { PathName } static int OfflineMonitorInterval = 60 static str Operations = None str PathName )

Sample Configuration
ElifNOne tmp_file01 ( PathName = "/tmp/file01" )

18

VERITAS Cluster Server Bundled Agents Reference Guide

FileNone Agent

FileNone Agent
Description
Monitors a file.

Entry Point

MonitorChecks if the specified file exists. If it does, the agent reports as online. If it does not, the agent reports as offline.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

PathName

Specifies the complete pathname. Starts with the slash (/) that precedes the file name.

Type Definition
type FileNone ( static int AutoStart = 1 static str ArgList[] = { PathName } static int OfflineMonitorInterval = 60 static str Operations = None str PathName )

Sample Configuration
FileNone tmp_file01 ( PathName = "/tmp/file01" )

Chapter 2, VCS Bundled Agents

19

FileOnOff Agent

FileOnOff Agent
Description
Creates, removes, and monitors files.

Entry Points

OnlineCreates an empty file with the specified name (if one does not already exist). OfflineRemoves the specified file. MonitorChecks if the specified file exists. If it does, the agent reports as online. If it does not, the agent reports as offline. CleanSee Entry Points on page 2 for more information on the Clean entry point.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

PathName

Specifies the complete pathname. Starts with the slash (/) that precedes the file name.

Type Definition
type FileOnOff ( str PathName static str ArgList[] = { PathName } )

Sample Configuration
FileOnOff tmp_file01 ( PathName = "/tmp/file01" )

20

VERITAS Cluster Server Bundled Agents Reference Guide

FileOnOnly Agent

FileOnOnly Agent
Description
Creates and monitors files.

Entry Points

OnlineCreates an empty file with the specified name (if one already does not exist). MonitorChecks if the specified file exists. If it does, the agent reports as online. If it does not, the agent reports as offline. CleanSee Entry Points on page 2 for more information on the Clean entry point.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

PathName

Specifies the complete pathname. Starts with the slash (/) that precedes the file name.

Type Definition
type FileOnOnly ( static str ArgList[] = { PathName } static str Operations = OnOnly str PathName )

Sample Configuration
FileOnOnly tmp_file02 ( PathName = "/tmp/file02" )

Chapter 2, VCS Bundled Agents

21

IP Agent

IP Agent
Description
Manages the configuration of a virtual IP address and its subnet mask on an interface. The virtual IP address must not be one currently in use. Use the IP Agent to support EtherChannel configurations. The virtual interface configured through EtherChannel should be used for the "Device" parameter. The NIC agent should also be used to monitor the status of the EtherChannel virtual interface.

Entry Points

OnlineChecks if the IP address is in use by another system. Uses ifconfig to set the IP address on a unique alias on the interface. OfflineBrings down the IP address associated with the specified interface. MonitorMonitors the interface to test if the IP address associated with the interface is in the UP state.

State Definitions
ONLINEIndicates that the device is up and the specified IP address is assigned to the

device.
OFFLINEIndicates

that the device is down or the specified IP address is not assigned

to the device.
UNKNOWNIndicates

that the device name or the IP address is not specified in the configuration file (main.cf).

22

VERITAS Cluster Server Bundled Agents Reference Guide

IP Agent

Required Attributes
Required Attributes Type and Dimension string-scalar Definition

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, for example: en0. Use ifconfig -a to display a list of NICs that are up and the IP addresses assigned to each NIC.

NetMask

string-scalar

The subnet mask associated with the IP address. The value of NetMask may be specified in decimal (base 10) or hexadecimal (base 16). For example: "255.255.255.0".

Optional Attribute
Optional Attribute Type and Dimension string-scalar Definition

Options

Options for the ifconfig command. For example: metric n mtu m.

Type Definition
type IP ( str Device str Address str NetMask str Options static str ArgList[] = { Device, Address, NetMask, Options } )

Chapter 2, VCS Bundled Agents

23

IP Agent

Sample Configurations
Sample 1: NetMask in decimal (base 10)
IP IP_192_203_47_61 ( Device = en0 Address = "192.203.47.61" NetMask = "255.255.248.0" )

Sample 2: NetMask in hexadecimal (base 16)


IP IP_192_203_47_61 ( Device = en0 Address = "192.203.47.61" NetMask = "0xfffff800" )

24

VERITAS Cluster Server Bundled Agents Reference Guide

IPMultiNIC Agent

IPMultiNIC Agent
Description
Manages and monitors a virtual (logical) IP address configured as an alias on one interface of a MultiNICA resource. This agent monitors the logical IP address. If the interface is faulted, the IPMultiNIC agent works with the MultiNICA resource to fail over to a backup interface. If multiple service groups have IPMultiNICs associated with the same MultiNICA resource, only one group has the MultiNICA resource. The other groups have Proxy resources pointing to it.

Entry Points

OnlineConfigures a virtual IP address on one interface of the MultiNICA resource. OfflineRemoves a virtual IP address from one interface of the MultiNICA resource. MonitorChecks if the virtual IP address is configured on one interface of the MultiNICA resource.

State Definitions
ONLINEIndicates OFFLINEIndicates

that the specified IP address is assigned to the device. that the specified IP address is not assigned to the device. that the IP address is not specified in the configuration file

UNKNOWNIndicates

(main.cf).

Chapter 2, VCS Bundled Agents

25

IPMultiNIC Agent

Required Attributes
Required Attributes Type and Dimension string-scalar Definition

Address

Virtual IP address assigned to the active NIC. For example: "172.29.9.100".

MultiNICAResName

string-scalar

Name of associated MultiNICA resource that determines the active NIC. For example: MultiNICA_grp1.

NetMask

string-scalar

Netmask for the virtual IP address. The value of NetMask may be specified in decimal (base 10) or hexadecimal (base 16).

Optional Attribute
Optional Attribute Type and Dimension string-scalar Definition

Options

The ifconfig options for the virtual IP address. For example: mtu m.

Type Definition
type IPMultiNIC ( static str ArgList[] = { "MultiNICAResName:Device", Address, NetMask, Options, "MultiNICAResName:Probed", MultiNICAResName } str Address str NetMask str Options str MultiNICAResName )

26

VERITAS Cluster Server Bundled Agents Reference Guide

IPMultiNIC Agent

Sample Configuration: IPMultiNIC and MultiNICA


For more information on this example, refer to Sample Configuration: MultiNICA and IPMultiNIC on page 45.
group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICA mnic ( Device@sysa = { en0 = "10.128.8.42", en1 = "10.128.8.42" } Device@sysb = { en0 = "10.128.8.43", en1 = "10.128.8.43" } NetMask = "255.255.255.0" Gateway = "10.128.1.1" BroadcastAddr = "10.128.8.255" ) IPMultiNIC ip1 ( Address = "10.128.10.14" NetMask = "255.255.255.0" MultiNICAResName = mnic ) ip1 requires mnic group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNIC ip2 ( Address = "10.128.9.4" NetMask = "255.255.255.0" MultiNICAResName = mnic Options = "mtu m" ) Proxy proxy ( TargetResName = mnic ) ip2 requires proxy

Chapter 2, VCS Bundled Agents

27

IPMultiNICB Agent

IPMultiNICB Agent
Description
Monitors a virtual (logical) IP address that is configured as an alias on one of the interfaces of a MultiNICB resource. The IPMultiNICB resource is configured as a failover service group that is dependent on the MultiNICB resource. If the physical interface where the logical IP address is configured is marked DOWN by the MultiNICB agent, the resource is reported OFFLINE. If multiple service groups have IPMultiNICB resources associated with the same MultiNICB resource, only one group has the MultiNICB resource. The other service groups have a Proxy resource pointing to that MultiNICB resource. The minimal configuration for this agent consists of the failover IP address, the subnet mask, and the name of the MultiNICB resource that it depends on. Refer to Sample Configuration: MultiNICB and IPMultiNICB on page 30 for an example of this type of configuration.

The haipswitch Utility


You can use the "/opt/VRTSvcs/bin/IPMultiNICB/haipswitch utility to switch IP addresses between MultiNICB interfaces on the same system. Running the utility with the -h flag gives an example of usage.

EtherChannel Support
Do not use IPMultiNICB with the EtherChannel. Instead, use the NIC and IP agents.

Entry Points

OpenData structures necessary for monitoring the network interfaces are created. OnlineIP address is brought online on the NIC recommended by the MultiNICB resource. MonitorChecks the existence of the IP address. If the address exists, queries the MultiNICB resource for status. The address is failed over to another NIC if necessary. OfflineIP address is de-configured. CleanIP address is de-configured. CloseData structures used by the monitor entry point are freed. Attr_ChangedUpdates the data structures used for monitoring the NICs.

28

VERITAS Cluster Server Bundled Agents Reference Guide

IPMultiNICB Agent

State Definitions
ONLINEIndicates OFFLINEThe

the IP address is available on a NIC defined as good by the MultiNICB resource. IP address is not available.

FAULTEDThe IP address could not be brought online, usually due to all NICs in the MultiNICB resource faulting. UNKNOWNIndicates

an unrecoverable error condition in the monitor entry point.

Required Attributes
Required Attributes Type and Dimension string Definition

Address

Defines the dotted decimal failover IP address. This IP address must be different than the base or test IP addresses in the MultiNICB resource. Note The IPMultiNICB agent automatically assigns the failover IP address. Do not configure this IP address before the IPMultiNICB agent goes online. If the IP address is already configured, the agent will return an error.

NetMask MultiNICBResName

string string

Defines the subnet mask for the failover IP address. Contains the name of the MultiNICB resource that the IPMultiNICB resource depends on.

Chapter 2, VCS Bundled Agents

29

IPMultiNICB Agent

Type Definition
type IPMultiNICB ( static int MonitorTimeout = 120 static int OfflineMonitorInterval = 60 static int MonitorInterval = 10 static str ArgList[] = { Address, NetMask, MultiNICBResName, "MultiNICBResName:Probed" } str Address str NetMask str MultiNICBResName )

Sample Configuration: MultiNICB and IPMultiNICB


group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICB MNICB_grp1 ( Device@sysa = { en0 = "10.128.8.42", en1 = "10.128.8.43" } Device@sysb = { en0 = "10.128.8.44", en1 = "10.128.8.45" } NetworkHosts = "10.128.8.10 10.128.8.45" LinkTestRatio = 1 ) IPMultiNICB ip1 ( Address = "10.128.10.14" Netmask = "255.255.255.0" MultiNICBResName = MNICB_grp1 ) ip1 requires MNICB_grp1 group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNICB ip2 ( Address = "10.128.10.15" Netmask = "255.255.255.0" MultiNICBResName = MNICB_grp1 ) Proxy MNICB_proxy ( TargetResName = MNICB_grp1 ) ip2 requires MNICB_proxy
30 VERITAS Cluster Server Bundled Agents Reference Guide

LVMVG Agent

LVMVG Agent
Description
Activates, deactivates, and monitors a Logical Volume Manager (LVM) volume group. The LVMVG agent ensures the ODM is in sync with any changes to the volume group since it was last imported on the system. Refer to Notes on the LVMVG Agent on page 34 for important information on this agent.

Entry Points

OnlineActivates the volume group. The Online entry point expects that the volume group is already imported on the system. If the volume group had been modified on a system where it was previously active, the Online entry point detects this. It then syncs up the ODM on the system where you want to bring the volume group resource online. OfflineDeactivates the volume group. MonitorDetermines the volume groups state (activated or deactivated) and availability for read/write operations. CleanSee Entry Points on page 2 for more information on the Clean entry point.

State Definitions
ONLINEIndicates OFFLINEIndicates

that the volume group is activated. that the volume group is deactivated.

Chapter 2, VCS Bundled Agents

31

LVMVG Agent

Required Attributes
Required Attributes Type and Dimension integer-scalar Definition

MajorNumber

Integer that represents the major number of the volume group. To ensure NFS functions properly, assign the same major number to the volume group on each system in the cluster. Name of the volume group configured with LVM. For example: testvg1.

VolumeGroup

string-scalar

Optional Attributes
Optional Attributes Type and Dimension string-scalar Definition

OwnerName

Attribute used to specify the volume owners name. Default is root. If set, the owners name is applied to the volume group and all of its logical volumes.

GroupName

string-scalar

Attribute used to specify the volumes group. Default is system. If set, the groupss name is applied to the volume group and all of its logical volumes.

Mode

string-scalar

Attribute used to specify permissions for a volume group and its logical volumes. Default is 640. If set, these permissions are applied to the volume group and all of its logical volumes.

ImportvgOpt

string-scalar

Attribute used to specify options for the importvg command. Default is n. This option indicates the volume group is not automatically activated when imported.

VaryonvgOpt

string-scalar

Attribute used to specify options for the varyonvg command. By default, this string is empty.

32

VERITAS Cluster Server Bundled Agents Reference Guide

LVMVG Agent

Optional Attributes

Type and Dimension integer-scalar

Definition

SyncODM

Integer that specifies whether or not the agent

ensures the ODM is in sync with any changes to the volume group. If set to 1, the agent ensures the ODM is in sync
with the changes to the volume group (if the volume group was modified on another system in the cluster). The sync operation occurs on the system where the agent brings the volume group online. If set to 0, the changes to the volume group are independent of the ODM. Default is 1.

Type Definition
type LVMVG ( static int NumThreads = 1 static str ArgList[] = { VolumeGroup, MajorNumber, OwnerName, GroupName, Mode, ImportvgOpt, VaryonvyOpt, SyncODM } str VolumeGroup int MajorNumber str OwnerName str GroupName str Mode str ImportvgOpt = n str VaryonvgOpt int SyncODM = 1 )

Chapter 2, VCS Bundled Agents

33

LVMVG Agent

Sample Configuration
system sysA system sysB system sysC group lvmgroup ( SystemList = { sysA, sysB } AutoStartList = { sysA } LVMVG lvmvg_vg1 ( VolumeGroup = vg1 MajorNumber = 50 ) LVMVG lvmvg_vg2 VolumeGroup = MajorNumber = ImportvgOpt = ) ( vg2 51 "f"

Notes on the LVMVG Agent


Volume Group Need To Be Imported
The LVMVG agent relies on the ODM to find out the names of the disk devices that a volume group is created on. Unless a volume group is imported on the system, the ODM on that system does not contain any information about that volume group. Therefore, you must import the volume group on all the systems in the groups SystemList for the LVMVG agent to function properly. For example, in the Sample Configuration on page 34, the volume groups (vg1 and vg2) must be imported on the specified systems (sysA and sysB).

Varyonvg Options
By default, the agent checks the state of the disk devices underneath the volume group. If the disk device is in a DEFINED state, the agent resets it to an AVAILABLE state. You can change this by using the VaryonvgOpt attribute.

34

VERITAS Cluster Server Bundled Agents Reference Guide

LVMVG Agent

You can have the agent not check for the state of the disk devices by setting VaryonvgOpt attribute in the main.cf file to a value of u. This option to the varyonvg command ensures that the disks underneath the volume group are not reserved when the volume group is activated. Note When you activate a volume group with the u option, ghost disks are not created. Therefore, you do not have to reset disks for these volume groups.

SyncODM Attribute
This sync happens only if this attribute is set to 1. The LVMVG agent ensures the ODM is in sync with any changes to the volume group since it was last imported on the system. The agent maintains a timestamp file, /var/VRTSvcs/log/tmp/volume_group_name.ts, which records the time when the volume group was last imported on the system. When the agent initially brings a volume group online, the agent exports and reimports the group while initializing the timestamp file for that group. During the export and reimport processes, the agent preserves the ownership and mode information for the volume group and all its logical volumes. The sync operation occurs when the timestamp value in the volume groups timestamp file is older than the timestamp value in the volume groups descriptor area. The timestamp value in the VGDA area of a volume group is updated after creating or deleting logical volumes, and adding or removing physical volumes.

Major Numbers
If a file system on a volume group is shared for NFS, make sure the volume group is imported with the same major number on all systems in the cluster. To view a list of available major numbers on the system, enter the lvlstmajor command. For example:
# lvlstmajor 49, 60 ...

To import volume group vg00 with major number 60, enter:


# importvg -V 60 -y vg00 hdisk3

To view the major number assigned to a volume group, use the ls command with the -l option. For example:
# ls -l /dev/vg00 crw-r----1 root system 60, 0 Apr 2 16:05 /dev/vg00

Chapter 2, VCS Bundled Agents

35

LVMVG Agent

Assign the same major number to the volume group on each system in the cluster. This automatically occurs if a volume group is imported on all systems in the cluster. Specify this major number in the MajorNumber attribute of the LVMVG configuration. Note Do not specify the V option in the ImportvgOpt attribute string, the agent automatically does this.

Autoactivate Options
Use the Concurrent Capable options for the importvg and mkvg commands with HACMP, which are not required for VCS. If an LVM volume group is placed under VCS control, the autoactivate options should be turned off. Do this using SMIT or through the command line. From SMIT, set the following field values when creating or altering the volume group:
Activate volume group AUTOMATICALLY at system restart? Create VG Concurrent Capable? Auto-varyon in Concurrent Mode? no no no

From the command line, to view the current value for these fields, use the lsattr command. For example:
# lsattr -El vg00 vgserial_id 0001632f00004c00000000ee092b3bd8 auto_on y conc_capable n conc_auto_on n timestamp 3ceff3390a8b1379 N/A N/A N/A N/A N/A False True True True True

From the command line, to change the value for these fields, use the chvg command. For example, to change the value of auto_on to "n": 1. Activate the volume group vg00 (if the volume group is not already activated):
# varyonvg vg00

2. Run the chvg command:


# chvg -a 'n' vg00

3. Verify the changes:


# lsattr -El vg00 vgserial_id 0001632f00004c00000000ee092b3bd8 N/A False auto_on n N/A True
36 VERITAS Cluster Server Bundled Agents Reference Guide

LVMVG Agent

conc_capable n conc_auto_on n timestamp 3ceff3390a8b1379

N/A True N/A True N/A True

The hadevice Utility


The LVMVG agent provides the hadevice utility to check the status of a disk device, reset a disk device to an AVAILABLE state, and break any SCSI reservations on a disk device. Its syntax is:
hadevice -c | -r | -b -p device_name

The three possible states of a disk device are: AVAILABLE, DEFINED AND RESERVED, and DEFINED AND NOT RESERVED. To check the state of a disk device, enter:
# hadevice -c device_name

The following commands locate and remove ghost disks for a disk device and break any SCSI reservation on the disk device. When the -p flag follows the -b flag, it breaks any previous SCSI reservation on the device. It then obtains and retains a new reservation on the device. To locate and remove ghost disks and break any SCSI reservations on the disk device, enter:
# hadevice -b device_name

To locate and remove ghost disks, break any SCSI reservations on the disk device, and obtain and retain a new reservation on the device, enter:
# hadevice -b -p device_name

To reset a disk device that is in a DEFINED state and put it into an AVAILABLE state, enter:
# hadevice -r device_name

Chapter 2, VCS Bundled Agents

37

Mount Agent

Mount Agent
Description
Brings online, takes offline, and monitors a file system mount point.

Entry Points

OnlineMounts a block device on the directory. If the mount process fails, the agent attempts to run fsck on the raw device to remount the block device. OfflineUnmounts the file system. MonitorDetermines if the file system is mounted. Checks mount status using the stat and statvfs commands. CleanSee Entry Points on page 2 for more information on the Clean entry point. InfoSee Info Entry Point on page 40 for more information.

State Definitions
ONLINEIndicates

that the block device is mounted on the specified mount point.

OFFLINEIndicates that the block device is not mounted on the specified mount point. UNKNOWNIndicates

that a problem exists with the configuration.

38

VERITAS Cluster Server Bundled Agents Reference Guide

Mount Agent

Required Attributes
Required Attributes Type and Dimension string-scalar string-scalar Definition

BlockDevice FsckOpt

Device for mount point. Options for fsck command. -y or -n must be included as arguments to fsck or the resource cannot come online. VxFS file systems 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. Note On AIX 5.1c systems, the fsck command cannot run on a file system unless an entry for that file system is added to /etc/filesystems. See Listing File Systems in /etc/filesystems on AIX 5.1c on page 41 for more information.

FSType MountPoint

string-scalar string-scalar

Type of file system, for example: jfs or vxfs. Directory for mount point.

Optional Attributes
Optional Attributes Type and Dimension string-scalar Definition

MountOpt

Options for mount command, for example: rw. Note Do not specify -o in the MountOpt field.

SnapUmount

boolean-scalar

If set to 1, this attribute automatically unmounts VxFS snapshots when the file system is unmounted. Default is 0.

Chapter 2, VCS Bundled Agents

39

Mount Agent

Info Entry Point


The Mount info entry point executes the command:
# df -h mount_point

The output displays Mount resource information:


Size Used Avail Use%

The following steps are necessary to initiate the info entry point by setting the InfoInterval timing to a value greater than 0, for example:
# haconf -makerw # hatype -modify Mount InfoInterval 60

In this case, the info entry point executes every 60 seconds. The command to retrieve information about the Mount resource is:
# hares -value mountres ResourceInfo

Output includes the following information:


Size 15G Used 5.7G Available 8.3G Used% 41%

Type Definition
type Mount ( str MountPoint str BlockDevice str FSType str MountOpt str FsckOpt int SnapUmount = 0 static str ArgList[] = { MountPoint, BlockDevice, FSType, MountOpt, FsckOpt, SnapUmount} )

40

VERITAS Cluster Server Bundled Agents Reference Guide

Mount Agent

Sample Configurations
Use the crfs and mkfs commands to create file systems. VCS supports the following configurations for the Mount agent:

LVM volume group with a JFS file system. VxVM volume with a VxFS file system.

Sample 1
In the following configuration, the mnt resource requires the vg00 resource.
LVMVG lvmvg_vg00 ( VolumeGroup = vg00 Disks = { "hdisk3" } Options = "u" ) Mount mnt ( MountPoint = "/lvm_testmnt" BlockDevice = "/dev/lv00" FSType = jfs ) mnt requires vg00

Sample 2
In the following configuration, vol0L is a volume in diskgrp testdg_1 created with VxVM.
Mount m0 ( MountPoint = "/tmp/m0" BlockDevice = "/dev/vx/dsk/testdg_1/vol0" FSType = vxfs )

Listing File Systems in /etc/filesystems on AIX 5.1c


The Mount agent uses the fsck command to repair a corrupted file system. In a cluster running AIX 5.1c, the fsck command requires the /etc/filesystems file on each system to contain entries for all VxFS and JFS file systems referenced by the BlockDevice attribute of the Mount agent. The fsck-V vfstype filesystemname command also does not work on AIX 5.1c systems without a corresponding entry for the file system in /etc/filesystems.
Chapter 2, VCS Bundled Agents 41

Mount Agent

The crfs command automatically adds an entry for a new file system to /etc/filesystems on the system it was created on. You must add entries to /etc/filesystems on all other systems in the cluster. The mkfs command does not add an entry for a new file system to /etc/filesystems. You must add entries to /etc/filesystems on all systems in the cluster.

Example 1
In this /etc/filesystems entry for a VxFS file system created on a VxVM volume, /mount_point is the mount point for the file system, /dev/vx/dsk/Diskgroup_name/Volume_name is the block device on which the file system is created, and vxfs is the file system type.
/etc/filesystems: /mount_point: dev = /dev/vx/dsk/Diskgroup_name/Volume_name vfs = vxfs mount = false check = false

Example 2
In this /etc/filesystems entry for a JFS file system created on an LVM logical volume, /mount_point2 is the mount point for the file system, /dev/LVMlogical_volume is the block device on which the file system is created, /dev/LVMlogical_volumelog is the log device for the file system automatically created by the crfs command, and jfs is the file system type.
/etc/filesystems: /mount_point2: dev = /dev/LVMlogical_volume vfs = jfs log = /dev/LVMlogical_volumelog mount = false check = false

42

VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICA Agent

MultiNICA Agent
Description
Represents a set of network interfaces, and provides failover capabilities between them. Each interface in a MultiNICA resource can have its own base IP address or all the interfaces can share a single base IP address. The MultiNICA agent configures and monitors one interface at a time. If the agent detects no activity on the configured interface, it configures a new interface and migrates IP aliases to it. If an interface is associated with a MultiNICA resource, it 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, first configure a MultiNICA resource in one of the service groups, and then configure Proxy resources that point to the MultiNICA resource in the other service groups.

Entry Points

OnlineNot applicable. OfflineNot applicable. MonitorChecks for activity on a configured interface by sampling input packets received on that interface. If it does not detect activity, it forces activity by sending out a broadcast ping. If it detects a failure, it migrates to the next interface. Note With AIX, systems do not respond to broadcast pings by default. The administrator must run "no -o bcastping=1" in order to enable response to broadcast pings.

Required Attributes
Required Attributes BroadcastAddr Device Gateway NetMask Type and Dimension string-scalar string-association string-scalar string-scalar Definition Broadcast address. For example: "10.192.15.255". List of interfaces and their base IP addresses. IP address for the default gateway. For example: "10.192.1.7". Netmask for the base IP address. The value of NetMask may be specified in decimal (base 10) or hexadecimal (base 16).

Chapter 2, VCS Bundled Agents

43

MultiNICA Agent

Optional Attributes
Optional Attributes Type and Dimension Handshake-Interval integer-scalar Definition

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 configured) when it fails over to a new NIC. To prevent spurious failovers, VERITAS recommends that the user enable the agent to try to contact a host on the network several times before marking a NIC as faulted. Increased values result in longer failover times, whether between the NICs or from system to system in the case of faulted NICs. The default is 1.

NetworkHosts

string-vector

List of hosts on the network that are pinged to determine if the network connection is alive. Enter the IP address of a host (instead of the HostName) to prevent the monitor from timing out (DNS causes the ping to hang). If this an unspecified attribute, the monitor tests the NIC by pinging the broadcast address on the NIC. If more than one network host is listed, the monitor returns online if at least one of the hosts is alive. For example: "166.93.2.1, 166.97.1.2".

Options

string-scalar

The ifconfig options for the base IP address. For example: mtu m.

PingOptimize

integer-scalar

Number of monitor cycles to detect if configured interface is inactive. A value of 1 optimizes broadcast pings and requires two monitor cycles. A value of 0 performs a broadcast ping each monitor cycle and detects the inactive interface within the cycle. Default is 1.

RouteOptions

string-scalar

String to add a route when configuring an interface. No routes are added if this string is set to NULL. For example: "-net 192.100.201.0 192.100.13.7".

Note 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.

44

VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICA Agent

Type Definition
type MultiNICA ( static str ArgList[] = { Device, NetMask, Gateway, BroadcastAddr, Options, RouteOptions, PingOptimize MonitorOnly, HandshakeInterval networkHosts } static int OfflineMonitorInterval = 60 static str Operations = None static int MonitorTimeout = 300 str Device{} str NetMask str Gateway str Options str RouteOptions int PingOptimize = 1 int HandshakeInterval = 10 str NetworkHosts[] )

Sample Configuration: MultiNICA and IPMultiNIC


In the following example, two machines, sysa and sysb, each have a pair of network interfaces, en0 and en1. The two interfaces, en0 and en1, 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 in the event of a failure. The logical IP addresses are configured by the IPMultiNIC agent. The resources ip1 and ip2, shown in the following example, have the Address attribute which contains the logical IP address. In the event of a NIC failure on sysa, the physical IP address and the two logical IP addresses fails over from en0 to en1. 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 first 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 25.

Chapter 2, VCS Bundled Agents

45

MultiNICA Agent

group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICA mnic ( Device@sysa = { en0 = "10.128.8.42", en1 = "10.128.8.42" } Device@sysb = { en0 = "10.128.8.43", en1 = "10.128.8.43" } NetMask = "255.255.255.0" Gateway = "10.128.1.1" BroadcastAddr = "10.128.25.255" Options = "mtu m" ) IPMultiNIC ip1 ( Address = "10.128.10.14" NetMask = "255.255.255.0" MultiNICAResName = mnic Options = "mtu m" ) ip1 requires mnic

group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNIC ip2 ( Address = "10.128.9.4" NetMask = "255.255.255.0" MultiNICAResName = mnic Options = "mtu m" ) Proxy proxy ( TargetResName = mnic ) ip2 requires proxy

46

VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICB Agent

MultiNICB Agent
Description
Monitors network interfaces and identifies the interface that the IPMultiNICB agent uses for failovers. Minimal configuration consists of defining a device and a test IP address. This test IP address is typically the address configured through the OS, usually through SMIT. If the LinkTestRatio is set to a number greater than zero (one is the default), a network host should be defined for the ping test. The MultiNICB agent allows IP addresses to failover between multiple NICs on the same system. Each interface is configured with a test IP address that the agent uses to verify the interfaces are functional. A failover IP address is managed by the IPMultiNICB agent. The IPMultiNICB agent brings the failover IP address online, and move it between the NICs defined in MultiNICB agent when NIC failures occur. The MultiNICB agent detects NIC failures in two ways: checking the link status by querying the driver and pinging a network host designated by the user.

EtherChannel Support
EtherChannel should not be used with the MultiNICB resource. Instead, use the NIC resource for monitoring an EtherChannel virtual interface.

haping Utility
The administrator can use the haping utility (/opt/VRTSvcs/bin/MultiNICB /haping)to test each NIC prior to configuring the MultiNICB resource. This utility takes the NIC interface as an argument, and can be used to perform a link test, broadcast ping, or ping a specific remote host. It is highly recommended that the administrator perform a test ping with the remote host prior to adding it to the NetworkHosts parameter. Some examples of the command syntax are as follows: Link test only on interface en0:
haping -l en0

Ping a remote host 10.10.10.10 from interface en0:


haping -g 10.10.10.10 en0

Chapter 2, VCS Bundled Agents

47

MultiNICB Agent

Configuration
Only a single MultiNICB resource can be configured per system. IPMultiNICB resources can be configured in Failover groups, and Proxy Resources used to create the dependency between the MultiNICB and IPMultiNICB resources. See section Sample Configuration: IPMultiNIC and MultiNICA on page 27 that illustrates this configuration. Note AIX systems do not respond to broadcast pings by default. You must run "no -o bcastping=1" in order to enable response to broadcast pings. The IP address for use by applications should be configured using the IPMultiNICB resource. The test IP addresses should not be used for application data. For more information on setting up MultiNICB, see Checklist for Using MultiNICB on page 51.

Entry Points

OpenData structures necessary for monitoring the network interfaces are created. CloseData structures used by the monitor entry point are freed. MonitorMonitor interface status through link test and ping. Attr_ChangedUpdate the data structures used for monitoring the NICs.

State Definitions
ONLINEIndicates OFFLINEIndicates FAULTEDAll

at least one NIC is online. all NICs configured for the resource are offline.

NICs configured for the resource have faulted. an unrecoverable error condition in the monitor entry point.

UNKNOWNIndicates

48

VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICB Agent

Required Attributes
Required Attributes Type and Dimension string-association Definition

Device

Lists the interfaces in order of preference for failover. A unique test IP address must be assigned to each interface. Use the AIX SMIT configuration tool to configure the test IP addresses to make them persistent across reboots. Note You also must manually configure the default IP route on each NIC in the MultiNICB resource.

NetworkHosts

string-vector

List of hosts on the network that are pinged to determine if the network connection is available. This must be an IP address, not a host name. If this attribute is not specified, the monitor tests the NIC by pinging the broadcast address on the NIC. If more than one network host is specified, monitor returns online if at least one host is reachable. Note You must set this attribute unless the LinkTestRatio is 0.

Chapter 2, VCS Bundled Agents

49

MultiNICB Agent

Optional Attributes
Optional Attributes Type and Dimension integer-scalar Definition

LinkTestRatio

Controls the frequency of the ping test in relation to the link test. The ping test may be run at a lesser frequency to reduce network traffic. If this attribute is set to 1, packets are sent during every monitor cycle. If this attribute is set to 0, packets are never sent during a monitor cycle. For other values greater than 1, packets are sent at a lower frequency. For example, if LinkTestRatio=2, then the packet send test only runs once for every two invocations of the monitor entry point. (In other words, packets would be sent out half as often than if LinkTestRatio was equal to one.) If the LinkTestRatio is set to a number greater than zero, you must specify a network host for the ping test. Default is 1.

NoBroadcast

integer-scalar

If set to 1, NoBroadcast prevents the agent from sending broadcast pings. ARP requests may still be generated. Note If no NetworkHosts are specified and NoBroadcast is set to 1, the agent cannot function properly. VERITAS does not recommend setting NoBroadcast to 1. Default is 0.

OfflineTestRepeatCount

integer-scalar

Number of times the test is repeated if the interface status changes from up to down. For every repetition of the test, the next NetworkHost is selected in round-robin manner. At the end of this process, broadcast is performed if NoBroadcast is set to 0. A greater value prevents spurious changes, but increases the response time. Default is 3.

OnlineTestRepeatCount

integer-scalar

Number of times the test is repeated if the interface changes from down to up. This helps prevent oscillations in the status of the interface. Default is 3.

50

VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICB Agent

Type Definition
type MultiNICB ( static int OfflineMonitorInterval = 60 static int MonitorInterval = 10 static str ArgList[] = { Device, NetworkHosts, LinkTestRatio, NoBroadcast, NetworkTimeout, OnlineTestRepeatCount, OfflineTestRepeatCount } static str Operations = None str Device{} str NetworkHosts[] = { "0.0.0.0" } int LinkTestRatio = 1 int NoBroadcast int NetworkTimeout = 100 int OnlineTestRepeatCount = 3 int OfflineTestRepeatCount = 3 )

Checklist for Using MultiNICB


Satisfy the following requirements for the MultiNICB agent to function properly. Refer to this list when setting up and troubleshooting this agent: Provide a unique MAC address for each interface. A MultiNICB resource controls all the interfaces on one IP subnet. All interfaces under the MultiNICB resource are plumbed at boot time. All interfaces under the MultiNICB resource are given test IP addresses at boot time. All test IP addresses for the MultiNICB resource belong to the same subnet. Test IP addresses must only be used by MultiNICB. All interfaces under the MultiNICB resource have the same default IP route configuration. Note Since the base IP addresses are not failed over, do not use them for administrative or application purposes. If NetworkHosts is specified, the hosts must be directly accessible on the LAN. If any network host is meant to respond to a broadcast ping, run no -o bcastping = 1.

Chapter 2, VCS Bundled Agents

51

MultiNICB Agent

Advantages of MultiNICB and IPMultiNICB

Faster failover: MultiNICB can detect an interface failure and migrate the IP addresses in a few seconds. The internal failover is many times faster than that of MultiNICA. Support for single and multiple interfaces: MultiNICB and IPMultiNICB can be used for single and multiple interfaces. This eliminates the need for separate pairs of NIC and IP, or MultiNICA and IPMultiNIC, for these interfaces. Simplified configuration: MultiNICB and IPMultiNICB simplify resource configuration in the main.cf because these agents do not configure or unconfigure the physical interfaces. The configuration does not contain IP addresses for the physical interfaces. Active/active configuration: MultiNICB and IPMultiNICB support active/active configuration for multiple interfaces on the same IP subnet. This means that all interfaces under a particular MultiNICB resource are always configured and have test IP addresses on them. This promotes speedy failover. Failback support: MultiNICB and IPMultiNICB support failback of IP addresses. If the original interface of an IP address is repaired, the IP address is failed back to the original interface. You can enable or disable failback for every MultiNICB resource. Support for manual switching: MultiNICB and IPMultiNICB support manual movement of IP addresses between working interfaces under the same MultiNICB resource. This can be performed without changing the VCS configuration or disabling resources.

Limitations of MultiNICB and IPMultiNICB

No support for active/passive configuration: MultiNICB and IPMultiNICB do not support active/passive configurations in which physical interfaces can be plumbed as needed by the agent. No plumbing of physical interfaces: MultiNICB and IPMultiNICB rely on system initialization scripts to plumb and configure all physical interfaces. When a MultiNICB resource is enabled, the agent expects all physical interfaces under the resource to be plumbed and configured with the test IP addresses. Need for test addresses: Unique and dedicated test IP addresses are required for every interface under the MultiNICB resource. These addresses cannot be used for any other purpose or by any applications other than the agent. Note Test IP addresses and the logical IP addresses do not have to be in the same IP subnet.

52

VERITAS Cluster Server Bundled Agents Reference Guide

MultiNICB Agent

A MultiNICB resource must represent all the interfaces of a single IP subnet: Group all interfaces of the same IP subnet under a single MultiNICB resource to enable MultiNICB and IPMultiNICB agents to function properly. A MultiNICB resource can only have an interface belonging to a single IP subnet under it.

How MultiNICB Works


MultiNICB and IPMultiNICB are written in C++. These agents make system calls to the kernel. They do not use external programs such as ifconfig. MultiNICB uses the following criteria to determine if an interface is working:

Interface status: The interface status as reported by driver of the interface (assuming the driver supports this feature). ICMP echo: ICMP echo request packets are sent to one of the network hosts (if specified). Otherwise, the agent uses ICMP broadcast and caches the sender of the first reply as a network host. While sending and receiving ICMP packets, the IP layer is completely bypassed.

Failover/Failback
During an interface failure, the MultiNICB agent fails over all logical IP addresses to a working interface under the same resource. The agent remembers the first physical interface from which an IP address was failed over. This physical interface becomes the original interface for the particular logical IP address. When the original interface is repaired, the logical IP address fails back to it.

Trigger Script
MultiNICB monitor entry point calls a VCS trigger in case of an interface going up or down. The following arguments are passed to the script:

MultiNICB resource name device whose status changed (for example, qfe0) device's previous status (0 for down, 1 for up) device's current status and monitor heartbeat

The agent also sends a notification (which may be received via SNMP or SMTP) to indicate that status of an interface changed. The notification is sent using "health of a cluster resource declined" and "health of a cluster resource improved" traps which are mentioned in the VCS User's Guide. A sample multinicb-aix-postchange trigger is provided with the agent. The user may customize this sample script as needed or write one from scratch.
Chapter 2, VCS Bundled Agents 53

MultiNICB Agent

The sample script does the following:

If interface changes status, it prints a message to the console, for example:


MultiNICB Agent Res. Name: Device en0 status changed from Down to Up.

Sample Configuration: MultiNICB and IPMultiNICB


group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICB MNICB_grp1 ( Device@sysa = { en0 = 10.128.8.42, en1 = 10.128.8.43 } Device@sysb = { en0 = 10.128.8.44, en1 = 10.128.8.45 } NetworkHosts = 10.128.8.10 10.128.8.45 LinkTestRatio = 1 ) IPMultiNICB ip1 ( Address = 10.128.10.14 Netmask = 255.255.255.0 MultiNICBResName = MNICB_grp1 ) ip1 requires MNICB_grp1 group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNICB ip2 ( Address = 10.128.10.15 Netmask = 255.255.255.0 MultiNICBResName = MNICB_grp1 ) Proxy MNICB_proxy ( TargetResName = MNICB_grp1 ) ip2 requires MNICB_proxy

54

VERITAS Cluster Server Bundled Agents Reference Guide

NFS Agent

NFS Agent
Description
Starts and monitors the nfsd, mountd, lockd, and statd subsystem processes required by all exported NFS file systems. The srcmstr daemon is the System Resource Controller (SRC). This agent send requests to the SRC to start and monitor these processes. Note Start the srcmstr daemon before using this agent.

Entry Points

OnlineChecks if nfsd, mountd, lockd, and statd are running. If they are not running, the agent starts the processes and exits. OfflineNot applicable. MonitorMonitors nfsd, mountd, lockd, and statd by checking whether or not the processes are active. CleanSee Entry Points on page 2 for more information on the Clean entry point.

State Definitions
ONLINEIndicates OFFLINEIndicates

that the NFS daemons are running properly. that the NFS daemons are not running properly. to determine the status of the NFS daemons.

UNKNOWNUnable

Required Attribute
Optional Attribute Type and Dimension integer-scalar Definition

Nservers

Specifies the number of concurrent NFS requests the server can handle. A zero value takes the default value from the SRC database. Default is 0.

Chapter 2, VCS Bundled Agents

55

NFS Agent

Type Definition
type NFS ( int Nservers = 0 static str ArgList[] = { Nservers } static str Operations = OnOnly static int RestartLimit = 1 )

Sample Configuration
NFS NFS_groupx_24 ( )

56

VERITAS Cluster Server Bundled Agents Reference Guide

NIC Agent

NIC Agent
Before using this agent: 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. Refer to the NIC documentation for more information.

Description
Monitors the configured NIC. If a network link fails, or if a problem arises with the adapter, the resource is marked OFFLINE. The NIC listed in the Device attribute must have an administrative IP address, which is the default IP address assigned to the physical interface of a host on a network. This agent does not configure network routes or an administration IP address. The NIC Agent can be used to support EtherChannel configurations. The virtual interface configured through EtherChannel should be used for the "Device" parameter. Use the IP agent to manage the IP address assigned to the EtherChannel virtual interface.

Entry Points

OnlineNot applicable. OfflineNot applicable. MonitorTests the network card and network link. Pings the network hosts or broadcast address of the interface to generate traffic on the network. Counts the number of packets passing through the device before and after the address is pinged. If the count decreases or remains the same, the resource is marked OFFLINE. Note With AIX, systems do not respond to broadcast pings by default. The administrator must run no -o bcastping=1 in order to enable response to broadcast pings.

State Definitions
ONLINEIndicates OFFLINEIndicates

that the NIC resource is online. that the NIC resource is offline. that the device is not configured or is configured incorrectly.

UNKNOWNIndicates

Chapter 2, VCS Bundled Agents

57

NIC Agent

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

Device

The name of the NIC to be monitored. Use SMIT to check all network adapters that are available for use. For example: en0 or en1.

Optional Attributes
Optional Attributes Type and Dimension string-vector Definition

NetworkHosts

List of hosts on the network.

If one host is specified, the monitor returns ONLINE when the host is reachable. If more than one host is specified, the monitor returns ONLINE when at least one of the hosts is reachable. If no hosts are specified, the monitor issues a broadcast ping and returns ONLINE when any host responds to the broadcast ping request.

Network Type PingOptimize

string-scalar integer-scalar

Reserved for future use. VCS ignores this value. Number of monitor cycles to detect if the configured interface is inactive. A value of 1 optimizes broadcast pings and requires two monitor cycles. A value of 0 performs a broadcast ping during each monitor cycle and detects the inactive interface within the cycle. Default is 1.

58

VERITAS Cluster Server Bundled Agents Reference Guide

NIC Agent

Type Definition
type NIC ( static str ArgList[] = { Device, NetworkType, PingOptimize, NetworkHosts} static int OfflineMonitorInterval = 60 static str Operations = None str Device str NetworkType str NetworkHosts[] int PingOptimize = 1 )

Sample Configurations
Sample 1: Without Network Hosts (Using Default Ping Mechanism)
NIC groupx_en0 ( Device = en0 PingOptimize = 1 )

Sample 2: With Network Hosts


NIC groupx_en0 ( Device = en0 NetworkHosts = { "10.182.1.1", "10.182.1.2" } )

Chapter 2, VCS Bundled Agents

59

NotifierMngr Agent

NotifierMngr Agent
Description
Starts, stops, and monitors a notifier process, making it highly available. The notifier 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 notification. See the notifier(1) man page to configure notification from the command line. Note The attributes of the NotifierMngr agent cannot be dynamically changed using the hares -modify command. Changes made using this command are effective after notifier is restarted.

Entry Points

OnlineStarts the notifier process with its required arguments. OfflineVCS sends a SIGABORT. If the process does not exit within one second, VCS sends a SIGKILL. MonitorMonitors the notifier process. CleanSends SIGKILL.

State Definitions
ONLINEIndicates OFFLINEIndicates

that the Notifier process is running. that the Notifier process is not running.

60

VERITAS Cluster Server Bundled Agents Reference Guide

NotifierMngr Agent

Required Attributes
Required Attributes Type and Dimension stringassociation Definition

SnmpConsoles

Specifies 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 (default), 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 specified. Otherwise, SnmpConsoles is an optional attribute. The user can specify both SnmpConsoles and SmtpServer if necessary.

SmtpServer

string-scalar

Specifies the machine name of the SMTP server. Note SmtpServer is a required attribute if SnmpConsoles is not specified. Otherwise, SmtpServer is an optional attribute. The user can specify both SmtpServer and SnmpConsoles if necessary.

Optional Attributes
Optional Attributes Type and Dimension integer-scalar Definition

MessagesQueue

Size of the VCS engines message queue. Default is 30.

NotifierListeningPort

integer-scalar

Any valid TCP/IP port numbers that are not used. Default is 14144.

SmtpFromPath

string

This attribute should be set to a valid email address, if a custom email address is desired for the FROM: field in the email sent by notifier.

Chapter 2, VCS Bundled Agents

61

NotifierMngr Agent

Optional Attributes

Type and Dimension stringassociation

Definition

SmtpRecipients

Specifies the email address where information is sent and the severity level of the messages received. The severity levels of messages are: Information, Warning (default), 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 specified.

SmtpReturnPath

string

This attribute should be set to a valid email address, if a custom email address is desired for the Return-Path: <> field in the email sent by notifier. Note If the mail server specified in SmtpServer does not support VRFY, then you need to set the SmtpVrfyOff to 1 in order for the SmtpReturnPath value to take effect.

SmtpServerTimeout

integer

This attribute represents the time in seconds notifier waits for a response from the mail server for the SMTP commands it has sent to the mail server. This value can be increased if it is noticed that the mail server is taking a longer duration to reply back to the SMTP commands sent by notifier. Default is 10.

SmtpServerVrfyOff

boolean

Setting this value to 1 results in notifier not sending a SMTP VRFY request to the mail server specified in SmtpServer attribute, while sending emails. Set this value to 1 if your mail server does not support SMTP VRFY command. Default is 0.

SnmpdTrapPort

integer-scalar

Port to which SNMP traps are sent. The value specified for this attribute is used for all consoles if more than one SNMP console is specified. Default is 162.

SnmpCommunity

string-scalar

Specifies the community ID for the SNMP manager. Default is "public".

62

VERITAS Cluster Server Bundled Agents Reference Guide

NotifierMngr Agent

Type Definition
type NotifierMngr ( static int RestartLimit = 3 static str ArgList[] = { EngineListeningPort, MessagesQueue, NotifierListeni ngPort, SnmpdTrapPort, SnmpCommunity, SnmpConsoles, SmtpServer, SmtpServerVrfyOff, S mtpServerTimeout, SmtpReturnPath, SmtpFromPath, SmtpRecipients } int EngineListeningPort = 14141 int MessagesQueue = 30 int NotifierListeningPort = 14144 int SnmpdTrapPort = 162 str SnmpCommunity = "public" str SnmpConsoles{} str SmtpServer boolean SmtpServerVrfyOff = 0 int SmtpServerTimeout = 10 str SmtpReturnPath str SmtpFromPath str SmtpRecipients{} )

Sample Configuration
In the following configuration, the NotifierMngr agent is configured 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 offline status of the group. See Phantom Agent on page 65 for more information on verifying the status of groups that only contain OnOnly or Persistent resourcessuch as the NIC resource. NicGrp must be enabled to run as a parallel group on both systems. Grp1 contains the NotifierMngr resource (ntfr) and a Proxy resource (nicproxy), configured for the NIC resource in the first group. In this example, NotifierMngr has a dependency on the Proxy resource. Note Only one instance of the notifier process can run in a cluster. The process cannot run in a parallel group. The NotifierMngr resource sets up notification 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):

Chapter 2, VCS Bundled Agents

63

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 ( PathName = "/opt/VRTSvcs/bin/notifier" 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 // } // }


64 VERITAS Cluster Server Bundled Agents Reference Guide

Phantom Agent

Phantom Agent
Description
Enables VCS to determine the status of parallel service groups that do not include OnOff resources (resources that VCS can start and stop as required). Without the "dummy" resource provided by this agent, VCS cannot assess the status of 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. Refer to the VERITAS Cluster Server Users Guide for information on categories of service groups and resources.

Entry Points

MonitorDetermines status based on the status of the group.

Type Definition
type Phantom ( static str ArgList[] = { Dummy } str Dummy )

Note The Dummy attribute is for VCS use only and is not configurable.

Sample Configurations
Sample 1
Phantom ( )

Chapter 2, VCS Bundled Agents

65

Phantom Agent

Sample 2
The following example shows a complete configuration file (main.cf), where 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 } Parallel = 1 ) FileNone my_file_none (PathName = "/tmp/file_none" ) Phantom my_phantom ( ) // resource dependency tree // // group maingroup // { // Phantom my_Phantom // FileNone my_file_none // }

66

VERITAS Cluster Server Bundled Agents Reference Guide

Process Agent

Process Agent
Description
Starts, stops, and monitors a process specified by the user.

Entry Points

OnlineStarts the process with optional arguments. OfflineTerminates the process with a SIGTERM. If the process does not exit, VCS sends a SIGKILL. MonitorChecks to see if the process is alive by scanning the process table for the name of the executable pathname and argument list. CleanSee Entry Points on page 2 for more information on the Clean entry point.

State Definitions
ONLINEIndicates OFFLINEIndicates

the specified process is running properly. the specified process is not running properly. the state of the process cannot be determined.

UNKNOWNIndicates

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

PathName

Defines complete pathname to access an executable program. This path includes the program name. If a process is controlled by a script, the PathName defines the complete path to the shell.

Chapter 2, VCS Bundled Agents

67

Process Agent

Optional Attribute
Optional Attribute Type and Dimension string-scalar Definition

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 Definition
type Process ( str PathName str Arguments static str ArgList[] = { PathName, Arguments } )

Sample Configurations
Sample 1
Processusr_lib_sendmail ( PathName = /usr/lib/sendmail Arguments = "bd q1h" )

Sample 2
include "types.cf" cluster ProcessCluster ( . . . group ProcessGroup ( SystemList = { sysa, sysb } AutoStartList = { sysa } )

68

VERITAS Cluster Server Bundled Agents Reference Guide

Process Agent

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 // }

Chapter 2, VCS Bundled Agents

69

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 reflected by its proxies.

Entry Points

OnlineNot applicable. OfflineNot applicable. MonitorDetermines status based on the target resource status.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

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.

Optional Attribute
Optional Attribute Type and Dimension string-scalar Definition

TargetSysName

Mirrors the status of the TargetResName on system specified by the TargetSysName variable. If attribute is not specified, Proxy resource assumes the system is local.

70

VERITAS Cluster Server Bundled Agents Reference Guide

Proxy Agent

Type Definition
type proxy ( static str ArgList[] = { TargetResName, TargetSysname, "TargetResName:Probed", TargetResName:State } static int OfflineMonitorInterval = 60 static str Operations = None str TargetResName str TargetSysName )

Sample Configurations
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.

Chapter 2, VCS Bundled Agents

71

Proxy Agent

group grp1 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) MultiNICA mnic ( Device@sysa = { en0 = "10.128.8.42", en1 = "10.128.8.42" } Device@sysb = { en0 = "10.128.8.43", en1 = "10.128.8.43" } NetMask = "255.255.255.0" NameServerAddr = "10.130.8.1" Gateway = "10.128.1.1" Domain = "veritas.com" BroadcastAddr = "10.128.25.255" Options = "mtu m" ) IPMultiNIC ip1 ( Address = "166.98.14.78" NetMask = "255.255.255.0" MultiNICAResName = mnic Options = "mtu m" ) ip1 requires mnic

group grp2 ( SystemList = { sysa, sysb } AutoStartList = { sysa } ) IPMultiNIC ip2 ( Address = "166.98.14.79" NetMask = "255.255.255.0" MultiNICAResName = mnic Options = "mtu m" ) Proxy proxy ( TargetResName = mnic ) ip2 requires proxy

72

VERITAS Cluster Server Bundled Agents Reference Guide

ServiceGroupHB Agent

ServiceGroupHB Agent
Description
Starts, stops, and monitors disk-based heartbeats associated with service groups. See the VERITAS Cluster Server Users Guide for details. The heartbeat region resides on a block device and consists of 128 blocks starting on the specified block number (see the Disks attribute). The local system, via the ServiceGroupHB agent, attempts to obtain ownership of the available disks as specified by the Disks attribute. The system gains ownership of a disk when it determines that the disk is available and not owned by another system. When the systems disk ownership meets the requirement of the AllOrNone attribute, it brings the resource online and monitors the resource. If disk ownership falls below the AllOrNone requirement, VCS attempts to fail over the group to another node.

Entry Points

OnlineCreates logical disk objects based on the Disks attribute at VCS startup. Brings resource online after ownership of the required number of disks is obtained. OfflineTakes resource offline after relinquishing ownership of previously acquired disks. Deletes the logical disk objects. CleanTakes resource offline and relinquishes ownership of previously acquired disks. MonitorPeriodically checks if local system has ownership of required number of disks.

Chapter 2, VCS Bundled Agents

73

ServiceGroupHB Agent

Required Attributes
Required Attributes Type and Dimension string-vector Definition

Disks

Specifies, in paired values, the disk and the starting block location to use for the heartbeat. Note that a block device partition is used for the disk heartbeating, for example: /dev/hdisk3. A block device partition containing one or more heartbeat regions cannot be used for any other purpose. If the same partition is used for more than one heartbeat region, starting block numbers must be at least 64K (128 disk blocks) apart.

AllOrNone

boolean-scalar

Specifies number of disks for which ownership is required to bring the resource online:

all available disks (AllOrNone = 1) a simple majority of available disks (AllOrNone = 0)

Default is 1.

Type Definition
type ServiceGroupHB ( static str ArgList[] = { Disks, AllOrNone } static int OnlineRetryLimit = 5 str Disks[] boolean AllOrNone = 1 )

74

VERITAS Cluster Server Bundled Agents Reference Guide

ServiceGroupHB Agent

Sample Configuration
In this example, the disks hdisk3 and hdisk4 have service group heartbeat regions beginning at block 64 for service group groupz. The disk hdisk3 has a second heartbeat region beginning at block 192 for service group groupz. The disk hdisk6 has a heartbeat region beginning at block 192 for service group group y. The AllOrNone attribute is set to 1 for sghb1, specifying that the service group can come online with ownership of two disks.
. system sysa . system sysb . . . group groupz ( . . ) ServiceGroupHB sghb1 ( Disks = { hdisk3, 64, hdisk3, 192, hdisk4, 64 } AllorNone = 1 ) FileOnOff file1 ( PathName = "/tmp/file01" )

group groupy ( . . ) . ServiceGroupHB sghb2 ( Disks = { hdisk6, 192 } ) FileOnOnly file2 ( PathName = "/tmp/file02" ) .

Chapter 2, VCS Bundled Agents

75

ServiceGroupHB Agent

file1 requires sghb1 file2 requires sghb2 // resource dependency tree // // // group groupz // { // FileOnOff file1 // { // ServiceGroupHB sghb1 // } // } // group groupy // { // FileOnOnly file2 // { // ServiceGroupHB sghb1 // } // }

76

VERITAS Cluster Server Bundled Agents Reference Guide

Share Agent

Share Agent
Before you use this agent verify that the files and directories to be shared are on shared disks.

Description
Enables clients to share file system directories from a cluster server. The directories to be shared are stored on shared disks. This agent ensures transparent access to file system directories during failover. The agent uses the exportfs command to share and unshare the file system.

Entry Points

OnlineExports (shares) a directory to the specified client. OfflineUnshares the exported directory from the client. MonitorVerifies that the shared directory is exported to the client. CleanSee Entry Points on page 2 for more information on the Clean entry point.

State Definitions
ONLINEIndicates OFFLINEIndicates

that specified directory is exported to the client. that the specified directory is not exported to the client.

UNKNOWNIndicates

that the agent could not determine the state of the resource or that the resource attributes are invalid.

Required Attribute
Required Attribute Type and Dimension string-scalar Definition

PathName

The path of the directory to export. For example: /usr/tom.

Chapter 2, VCS Bundled Agents

77

Share Agent

Optional Attribute
Optional Attribute Type and Dimension string-vector Definition

Options

The options for the exportfs command.

Type Definition
type Share ( str PathName str Options static str ArgList[] = { PathName, Options } )

Sample Configuration
Share share1 ( PathName = "/mnt1" Options = "rw=minnehaha,access=minnehaha,root=minnehaha" )

The options for the Share agent must be specific. In this configuration, root access is only given to the system minnehaha. By default, systems do not have root access to the exported directory /mnt1. Refer to the exportfs manual page for more information.

78

VERITAS Cluster Server Bundled Agents Reference Guide

Volume Agent

Volume Agent
Description
Brings online, takes offline, and monitors a VERITAS Volume Manager (VxVM) volume.

Entry Points

OnlineStarts the volume using the vxrecover command. OfflineStops the volume using the vxvol command. MonitorDetermines if the volume is online or offline by reading a block from the raw device interface to the volume. CleanSee Entry Points on page 2 for more information on the Clean entry point.

Required Attributes
Required Attributes Type and Dimension string-scalar Definition

DiskGroup

Name of the disk group which contains the volume, for example: DG1. Name of the volume, for example: DG1Vol1.

Volume

string-scalar

Type Definition
type Volume ( str Volume str DiskGroup static str ArgList[] = { Volume, DiskGroup } static int NumThreads = 1 )

Sample Configuration
Volume v0 ( Volume = vol0 DiskGroup = testdg_1 )
Chapter 2, VCS Bundled Agents 79

VRTSWebApp Agent

VRTSWebApp Agent
Description
Brings Web applications online, takes them offline, and monitors their status. The application is a Java Web application conforming to the Servlet Specification 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.

Entry Points

OnlineStarts the Web application with the specified parameters. If the Web server is not already running, it first starts the server. OfflineRemoves the Web application from the Web server. If no other Web application is running, it shuts down the Web server. MonitorChecks if the specified 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.

80

VERITAS Cluster Server Bundled Agents Reference Guide

VRTSWebApp Agent

Required Attributes
Required Attributes Type and Dimension Definition

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 file 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 file. 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 five seconds.

Type Definition
type VRTSWebApp ( static str ArgList[] = { AppName, InstallDir,TimeForOnline } str AppName str InstallDir int TimeForOnline static int NumThreads = 1 )

Chapter 2, VCS Bundled Agents

81

VRTSWebApp Agent

Sample Configuration
VRTSWebApp VCSweb ( AppName = "vcs" InstallDir = "/opt/VRTSweb/VERITAS" TimeForOnline = 5 )

82

VERITAS Cluster Server Bundled Agents Reference Guide

Index
A agents Application 6 bundled 1 defining 1 DiskGroup 11 DNS 14 ElifNone 18 FileNone 19 FileOnOff 20 FileOnOnly 21 IP 22 IPMultiNIC 25 IPMultiNICB 28 LVMVG 31 Mount 38 MultiNICA 43 MultiNICB 47 NFS 55 NIC 57 NotifierMngr 60 Phantom 65 Process 67 Proxy 70 ServiceGroupHB 73 Share 77 Volume 79 VRTSWebApp 80 Application agent description 6 entry points 6 error messages 10 optional attributes 8 required attributes 7 sample configurations 9 state definitions 7 type definition 9 application control agents Application 2, 6 Process 2, 67 applications, managing 6 attributes, modifying 1 B basic storage agents DiskGroup 2, 11 LVMVG 2, 31 Mount 2, 38 NFS 2, 55 Share 2, 77 Volume 2, 79 BIND 8 15 bundled agents categories 2 defining 1 C canonical name mapping 14 Cluster Manager (Java Console), modifying attributes 2 Cluster Manager (Web Console) modifying attributes 2 monitoring 80 CNAME record, canonical name 15 commands chvg 36 crfs 41, 42 exportfs 78 fsck 39, 41 hares -modify 60 ifconfig 44 importvg 36 lsattr 36 lvlstmajor 35 mkfs 41, 42 mkvg 36 83

stat 38 statvfs 38 vxdg 11 vxrecover 79 vxvol 79 comparing, MultiNICB and IPMultiNICB 52 concurrent capable options 36 configuration files main.cf 1, 5, 22, 25, 66 modifying 2 types.cf 1, 5 configurations MultiNICB agent 48 D DB2 UDB xv defining agents 1 entry points 2 descriptions Application agent 6 DiskGroup agent 11 DNS agent 14 ElifNone agent 18 FileNone agent 19 FileOnOff agent 20 FileOnOnly agent 21 IP agent 22 IPMultiNIC agent 25 IPMultiNICB agent 28 LVMVG agent 31 Mount agent 38 MultiNICA agent 43 MultiNICB agent 47 NFS agent 55 NIC agent 57 NotifierMngr agent 60 Phantom agent 65 Process agent 67 Proxy agent 70 ServiceGroupHB agent 73 Share agent 77 Volume agent 79 VRTSWebApp agent 80 directories, sharing 77 disk groups, managing 11 DiskGroup agent description 11 entry points 11 E

optional attributes 12 required attribute 11 setting noautoimport Flag 12 state definitions 11 type definition 13 DNS agent description 14 entry points 14 monitor scenarios 16 online query 15 required attributes 15 sample configuration 17 sample scenario 16 type definition 16 DNS lookups 17 ElifNone agent description 18 entry point 18 required attribute 18 type definition 18 entry points Application agent 6 defining 2 DiskGroup agent 11 DNS agent 14 ElifNone agent 18 FileNone agent 19 FileOnOff agent 20 FileOnOnly agent 21 IP agent 22 IPMultiNIC agent 25 IPMultiNICB agent 28 LVMVG agent 31 Mount agent 38 MultiNICA agent 43 MultiNICB agent 48 NFS agent 55 NIC agent 57 NotifierMngr agent 60 Phantom agent 65 Process agent 67 Proxy agent 70 ServiceGroupHB agent 73 share agent 77 Volume agent 79 VRTSWebApp agent 80 error messages, Application agent 10

84

VERITAS Cluster Server Bundled Agents Reference Guide

EtherChannel support 28 IP agent 22 MultiNICB agent 47 NIC agent 57 restrictions 47 F failback, MultiNICB agent 53 failover feature MultiNICB agent 47 failover IP address 47 failover, MultiNICB agent 53 file systems JFS 41, 42 listing 41 VxFS 41 FileNone agent description 19 entry point 19 required attribute 19 sample configuration 19 type definition 19 FileOnOff agent description 20 entry points 20 required attribute 20 sample configuration 20 type definition 20 FileOnOnly agent description 21 entry points 21 required attribute 21 sample configuration 21 type definition 21 functionality, MultiNICB agent 53 G Global cluster support agents DNS 3 Wide Area Heartbeat 3 Global Cluster support agents, DNS 14 H hadevice 37 haipswitch utility 28 haping utility, MultiNICB agent 47 heartbeats, disk region 73

I IP addresses base 43 configuring 22, 25 IPMultiNICB 48 virtual 22, 25 IP agent description 22 entry points 22 optional attribute 23 required attributes 23 sample configurations 24 state definitions 22 type definition 23 IPMultiNIC agent description 25 entry points 25 optional attribute 26 required attributes 26 state definitions 25 type definition 26 IPMultiNIC and MultiNICA, sample configuration 27, 45 IPMultiNICB agent advantages 52 description 28 entry points 28 EtherChannel support 28 haipswitch utility 28 limitations 52 required attributes 29 state definitions 29 type definition 30 IPMultiNICB and MultiNICB, sample configuration 30, 54 L listing file fystems 41 Logical Volume Manager (LVM), managing volume group 31 lookups, DNS 17 LVMVG agent 31 concurrent capable options 36 description 31 entry points 31 hadevice 37 major numbers 35

Index

85

notes 34 optional attributes 32 required attributes 32 sample configuration 34 state definitions 31 SyncODM 35 type definition 33 M main.cf 1, 5, 22, 25, 52, 66 major numbers, LVMVG agent 35 modifying, attributes 1 monitoring scenarios, DNS agent 16 Mount agent /etc/filesystem 41 AIX 5.1c systems 41 description 38 entry points 38 file system, example 42 file systems 41 info entry point 40 optional attributes 39 required attributes 39 sample configurations 41 state definitions 38 type definition 40 using the fsck command 41 mount points, managing 38 mountd, managing 55 MultiNICA agent description 43 entry points 43 optional attributes 44 required attributes 43 type definition 45 MultiNICA and IPMultiNIC, sample configuration 27, 45 MultiNICB agent advantages 52 checklist, usage 51 configuration 48 description 47 entry points 48 failover, MultiNICB agent 53 functionality 53 haping utility 47 limitations 52 optional attributes 50 required attributes 49

requirements 51 state definitions 48 trigger script 53 type definitions 51 MultiNICB and IPMultiNICB advantages 52 limitations 52 sample configuration 54 MultiNICB and IPMultiNICB, sample configuration 30 N NetBackup xv networking agents IP 3, 22 IPMultiNIC 3, 25 MultiNICA 3, 43 NIC 3, 57 NFS agent description 55 entry points 55 optional attributes 55 sample configuration 56 state definitions 55 type definition 56 nfsd, managing 55 NIC agent description 57 entry points 57 optional attributes 58 required attribute 58 sample configuration 59 state definitions 57 type definition 59 NIC, monitoring 57 noautoimport flag, setting 12 notifier process, managing 60 NotifierMngr agent description 60 entry points 60 optional attributes 61 required attributes 61 sample configuration 63 state definitions 60 type definition 63 O online queries, DNS agent 15 optional attributes Application agent 8 VERITAS Cluster Server Bundled Agents Reference Guide

86

DiskGroup agent 12 IP agent 23 IPMultiNIC agent 26 LVMVG agent 32 Mount agent 39 MultiNICA agent 44 MultiNICB agent 50 NFS agent 55 NIC agent 58 NotifierMngr agent 61 Process agent 68 Proxy agent 70 Share agent 78 Oracle xv P Phantom agent description 65 entry point 65 sample configurations 65, 66 type definitions 65 PidFiles 6, 8 PrimaryMasters attribute 15 Process agent 67 description 67 entry points 67 optional attribute 68 required attribute 67 sample configuration 68 sample configurations 68 state definitions 67 type definition 68 processes, managing 67 Proxy agent description 70 entry points 70 optional attribute 70 required attribute 70 sample configurations 71 type definition 71 R required attributes 79 Application agent 7 DiskGroup agent 11 DNS agent 15 ElifNone agent 18 FileNone agent 19 FileOnOff agent 20 FileOnOnly agent 21 Index

IP agent 23 IPMultiNIC agent 26 IPMultiNICB agent 29 LVMVG agent 32 Mount agent 39 MultiNICA agent 43 MultiNICB agent 49 NIC agent 58 NotifierMngr agent 61 Process agent 67 Proxy agent 70 ServiceGroupHB agent 74 Share agent 77 VRTSWebApp agent 81 resource types, agent relationship 1 resources description of 1 OnOff 65 relation to entry points 2 S sample configurations 13, 18, 82 Application agent 9 DNS agent 17 FileNone agent 19 FileOnOff agent 20 FileOnOnly agent 21 IP agent 24 IPMultiNIC and MultiNICA 27 LVMVG agent 34 Mount agent 41 MultiNICB and IPMultiNICB 30, 54 NFS agent 56 NIC agent 59 NotifierMngr agent 63 Phantom agent 65 Process agent 68 Proxy agent 71 ServiceGroupHB agent 75 Share agent 78 Volume agent 79 sample scenarios, DNS agent 16 ServiceGroupHB agent 73 description 73 entry points 73 required attribute 74 sample configuration 75 type definition 74

87

Share agent description 77 entry points 77 optional attribute 78 required attribute 77 sample configuration 78 state definitions 77 type definition 78 SMTP servers, receiving messages 60 SNMP consoles, receiving messages 60 state definitions Application agent 7 DiskGroup agent 11 IP agent 22 IPMultiNIC agent 25 IPMultiNICB agent 29 LVMVG agent 31 Mount agent 38 MultiNICB agent 48 NFS agent 55 NIC agent 57 NotifierMngr agent 60 Process agent 67 Share agent 77 SyncODM 35 T Technical assistance xv trigger script, MultiNICB agent 53 type definitions Application agent 9 DiskGroup agent 13 DNS agent 16 ElifNone agent 18 FileNone agent 19 FileOnOff agent 20 FileOnOnly agent 21 IP agent 23 IPMultiNIC agent 26 IPMultiNICB agent 30 LVMVG agent 33 Mount agent 40 MultiNICA agent 45 MultiNICB agent 51 NFS agent 56 NIC agent 59

NotifierMngr agent 63 Phantom agent 65 Process agent 68 Proxy agent 71 ServiceGroupHB agent 74 Share agent 78 Volume agent 79 VRTSWebApp agent 81 types.cf 1, 5 V VCS enterprise agents xv VCS infrastructure and support agents ElifNone 3, 18 FileNone 3, 19 FileOnOff 3, 20 FileOnOnly 3, 21 NotifierMngr 3, 60 Phantom 3, 65 Proxy 3, 70 ServiceGroupHB 3, 73 VRTSWebApp 3, 80 virtual interface 57 Volume agent description 79 entry points 79 required attributes 79 sample configuration 79 type definition 79 volume group, major numbers 35 Volume Manager (VxVM) managing a disk group 11 managing a volume 79 volumes LVM 42 LVM volume group 31 VxVM 42, 79 VRTSWebApp agent description 80 entry points 80 required attributes 81 sample configuration 13, 18, 82 type definition 81 W Web Consoles, monitoring 80

88

VERITAS Cluster Server Bundled Agents Reference Guide

89

90

VERITAS Cluster Server Bundled Agents Reference Guide

Potrebbero piacerti anche