<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Transitional//EN">
<HTML>
<HEAD>
  <!--
    *************************************************************************************
    * Copyright (c) 2005 VERITAS Software Corporation. All rights reserved. *

      For third-party license citations, please see the bottom of this file.
    *************************************************************************************
  -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="TEMPLATEBASE" content="vx_vxhelp_2005c">
<meta name="LASTUPDATED" content="06/17/05 10:11:47">
<meta name="PRODUCTNAME" content="VERITAS Software Documentation">
<meta name="FILENAME" content="services_app_agents.fm">
     
<title>Required Attributes</title>

</HEAD>

<BODY bgcolor="#FFFFFF" link="#000066" vlink="#0000ff" marginheight="0" topmargin="0">
<basefont=1>

<a name="290422"></a>

<div align="left">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
 <tr>
   <td height="2" border="0" cellspacing="0" cellpadding="0" colspan="2" bgcolor="#000000">
   </td>
 </tr>
 <tr>
   <td height="15" width="50%" border="0" cellspacing="0" cellpadding="0" bgcolor="#cccccc">
    <img src="images/vxsymbol.gif" height="20" width="31" border="0" cellspacing="0" cellpadding="0" align="left">
     
     
   </td>
   <td align="right" width="50%" bgcolor="#cccccc">

<!-- Header Breadcrumbs -->
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&lt;&nbsp;<a href="services_app_agents_vcs232_215587.html" title="Previous - State Definitions">Previous</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="services_app_agents_vcs234_115869.html" title="Next - Sample Configurations">Next</a>
&nbsp;&gt;&nbsp;&nbsp;</font>
   </td>
 </tr>

 <tr>
  <td bgcolor="#CCCCCC" colspan="2" height="15" align="right">
  <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Product:  
<a href="vcs_splashpage_docCD_vcs1_103036.vxhd" title="Cluster Server Guides title page ">Cluster Server Guides</a>
  &nbsp;&nbsp;
  </font>
  </td>
 </tr>
 <tr>
  <td bgcolor="#CCCCCC" colspan="2" height="15" align="right">
  <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Manual:  
<a href="vcs_bundled_agents_titlepage_docCD_vcs186_73700.vxhd" title="Cluster Server 4.1 Bundled Agents Reference Guide title page ">Cluster Server 4.1 Bundled Agents Reference Guide</a>
  &nbsp;&nbsp;
  </font>
  </td>
 </tr>


</table>
</div>

<div align="left">
 <table border="0" width="100%" bgcolor="#FFFFFF">
  <tr>
   <td width="100%" valign="top" bgcolor="#FFFFFF">

<!-- Start Main Topic Content -->
        <a name="startcontent"></a>
	
<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="290422"></a> Required Attributes</font>
</h2>

        
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377856"></a>
<Table width="100%" border="1" cellpadding="2" cellspacing="0" >
<tr valign="top"><td><b><a name="377860"></a>Required Attribute</b>
</td>
<td><b><a name="377862"></a>Description, Type and Dimension, Default, and Example</b>
</td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377864"></a>StartProgram</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377866"></a>The executable, created locally on each node, which starts the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377873"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104638">scalar</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377874"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;/usr/sbin/sample_app&nbsp;start&quot;</font></font>
</li>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377876"></a>StopProgram</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377878"></a>The executable, created locally on each node, that stops the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377885"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104638">scalar</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377886"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;/usr/sbin/sample_app&nbsp;stop&quot;</font></font>
</li>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377888"></a>At least one of the following attributes:</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377892"></a><a href="services_app_agents_vcs233_290422.html#378015">MonitorProcesses</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377896"></a><a href="services_app_agents_vcs233_290422.html#378029">MonitorProgram</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377900"></a><a href="services_app_agents_vcs233_290422.html#378044">PidFiles</a></font>
</li>
</ul></td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377905"></a>See <a href="services_app_agents_vcs233_290422.html#218368">Optional Attributes</a>.</font>
</p>
</td>
</tr>

</table>


<Table width="100%" border="0" cellpadding="1" cellspacing="0">
<tr><td>
</Table></font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="218368"></a>Optional Attributes</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="377993"></a>
<Table width="100%" border="1" cellpadding="2" cellspacing="0" >
<tr valign="top"><td><b><a name="377997"></a>Optional Attribute</b>
</td>
<td><b><a name="377999"></a>Description, Type and Dimension, Default, and Example</b>
</td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378001"></a>CleanProgram</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378003"></a>The executable, created locally on each node, which forcibly stops the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces. </font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378010"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104638">scalar</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378011"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;/usr/sbin/sample_app&nbsp;force&nbsp;stop&quot;</font></font>
</li>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="378012"></a>
</font>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378015"></a>MonitorProcesses</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378017"></a>A list of processes that you want monitored and cleaned. Each process name is the name of an executable. Qualify the executable name with its complete path if the path starts the executable.</font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378018"></a>The process name must be the full command line argument displayed by the <font face="Courier New, Courier, sansserif, sans serif" size="2">ps -u &lt;user&gt; -o args | more</font> command for the process.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378025"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104642">vector</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378026"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">{&nbsp;&quot;</font><font face="Courier New, Courier, sansserif, sans serif" size="2">sample_app_process</font><font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;&nbsp;}</font></font>
</li>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378029"></a>MonitorProgram</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378031"></a>The executable, created locally on each node, which monitors the application. Specify the complete path of the executable. Applicable command-line arguments follow the name of the executable and are separated by spaces.</font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378032"></a>MonitorProgram can return the following VCSAgResState values: <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">OFFLINE</font> value is 100<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">; ONLINE</font> values range from 101 to 110 (depending on the confidence level); 110 equals confidence level of 100%. Any other value = <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">UNKNOWN</font>. </font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378039"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104638">scalar</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378040"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;/usr/sbin/sample_app_monitor&nbsp;all&quot;</font></font>
</li>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="378041"></a>
</font>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378044"></a>PidFiles</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378046"></a>A list of PID files that contain the process ID (PID) of the processes that you want monitored and cleaned. These files are application-generated files. Each PID file contains one monitored PID. Specify the complete path of each PID file in the list. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378047"></a>The process ID can change when the process restarts. If the application takes time to update the PID file, the agent's monitor script may return an incorrect result. If this occurs, increase the ToleranceLimit in the resource definition.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378054"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104642">vector</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378055"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;/etc/sample/sample_app.pid&quot;</font></font>
</li>
</ul><ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378056"></a></font>
</li>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378058"></a>User</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378060"></a>The user ID for running 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.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378067"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104586">string</a>-<a href="intro_agents_vcs195_104530.html#104638">scalar</a></font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="378068"></a>Default: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;root&quot;</font></font>
</li>
</ul></td>
</tr>

</table>


<Table width="100%" border="0" cellpadding="1" cellspacing="0">
<tr><td>
</Table></font>
</p>


<!-- End Main Topic Content -->

   </td>
  </tr>
 </table>
</div>

<div>
<table border="0" cellspacing="0" cellpadding="0" width="100%">
 <tr>
  <td height="18" border="0" cellspacing="0" cellpadding="0" colspan="2" bgcolor="#FFFFFF">
  </td>
 </tr>
  <td align="left"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&nbsp;&#94;&nbsp;<a href="services_app_agents_vcs233_290422.html" title="Required Attributes">Return to Top</a></font>

  </td>
  <td align="right"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&lt;&nbsp;<a href="services_app_agents_vcs232_215587.html" title="Previous - State Definitions">Previous</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="services_app_agents_vcs234_115869.html" title="Next - Sample Configurations">Next</a>
&nbsp;&gt;&nbsp;&nbsp;</font>
  </td>
 <tr>
   <td height="9" border="0" cellspacing="0" cellpadding="0" colspan="2" bgcolor="#FFFFFF">
   </td>
 </tr>

<!-- Footer Breadcrumbs -->
<tr>
<td bgcolor="#FFFFFF" colspan="2" height="15" align="right">
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Product:  
<a href="vcs_splashpage_docCD_vcs1_103036.vxhd" title="Cluster Server Guides title page ">Cluster Server Guides</a>&nbsp;&nbsp;</font></td>
</tr>

<tr>
<td bgcolor="#FFFFFF" colspan="2" height="15" align="right">
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Manual:  
<a href="vcs_bundled_agents_titlepage_docCD_vcs186_73700.vxhd" title="Cluster Server 4.1 Bundled Agents Reference Guide title page ">Cluster Server 4.1 Bundled Agents Reference Guide</a>&nbsp;&nbsp;</font></td>
</tr>


 <tr>
  <td colspan="2" align="left"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" color="#000000" align="right" size="-2">
<em>VERITAS Software Corporation
</em></font><br>

<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">www.veritas.com</font><br>
  </td>
 </tr>
</table>
</div>

</BODY>
  <!--
    *************************************************************************************
    * Copyright (c) 2005 VERITAS Software Corporation. All rights reserved. *

    VERITAS, VERITAS SOFTWARE, the VERITAS Logo, and VERITAS Software Documentation 
    are trademarks or registered trademarks of VERITAS Software Corporation 
    or its affiliates in the U.S. and other countries. Other names may be 
    trademarks of their respective owners. 

    Apache Jakarta Lucene:
    Apache Software License
    Version 1.1

    Copyright (c) 2000 The Apache Software Foundation. All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, 
    are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice, this 
    list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright notice, this 
    list of conditions and the following disclaimer in the documentation and/or other 
    materials provided with the distribution.

    3. The end-user documentation included with the redistribution, if any, must include 
    the following acknowledgment: "This product includes software developed by the Apache 
    Software Foundation (http://www.apache.org/)." Alternately, this acknowledgment may 
    appear in the software itself, if and wherever such third-party acknowledgments 
    normally appear.

    4. The names "Apache" and "Apache Software Foundation" must not be used to endorse or 
    promote products derived from this software without prior written permission. For 
    written permission, please contact apache@apache.org.

    5. Products derived from this software may not be called "Apache", nor may "Apache" 
    appear in their name, without prior written permission of the Apache Software Foundation.

    THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, 
    BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 
    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION 
    OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 
    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    This software consists of voluntary contributions made by many individuals on behalf 
    of the Apache Software Foundation. For more information on the Apache Software Foundation, 
    please see <http://www.apache.org/>. Portions of this software are based upon public domain 
    software originally written at the National Center for Supercomputing Applications, University 
    of Illinois, Urbana-Champaign.
    
    This product includes WebWindow Software developed by Horst Heistermann.
    *************************************************************************************
  -->
</HTML>
