<!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:26">
<meta name="PRODUCTNAME" content="VERITAS Software Documentation">
<meta name="FILENAME" content="07_set_params.fm">
     
<title>Agent Attribute Definitions</title>

</HEAD>

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

<a name="1006790"></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="07_set_params_vcs159_1006645.html" title="Previous - Overriding Static Attributes">Previous</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="07_set_params_vcs161_1071741.html" title="Next - FaultOnMonitorTimeouts">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="adg_hpux41_titlepage_docCD_vcs95_73700.vxhd" title="Cluster Server 4.1 Agent Developer's Guide title page ">Cluster Server 4.1 Agent Developer's 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>
	
<h1><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="+1" color="#000000"><a name="1006790"></a>Agent Attribute Definitions</font>
</h1>
 
  
  
  

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998976"></a>Each agent attribute is listed and defined in the following sections.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="1071667"></a>ActionTimeout</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="1071668"></a>After the <font face="Courier New, Courier, sansserif, sans serif" size="2">hares&nbsp;-action</font> command has instructed the agent to perform a specified action, the action entry point has the time specified by the <font face="Courier New, Courier, sansserif, sans serif" size="2">ActionTimeout</font> attribute (scalar-integer) to perform the action. The value of <font face="Courier New, Courier, sansserif, sans serif" size="2">ActionTimeout</font> may be set for individual resources. The default is 40 seconds. The <font face="Courier New, Courier, sansserif, sans serif" size="2">ActionTimeout</font> attribute value can be overridden.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="998981"></a>AgentFile</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998983"></a>The default name of the agent file to be executed is:</font>
</p>

<blockquote>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998985"></a><font face="Courier New, Courier, sansserif, sans serif" size="2">$VCS_HOME/bin</font><font face="Courier New, Courier, sansserif, sans serif" size="2">/resource_type/resource_type</font><font face="Courier New, Courier, sansserif, sans serif" size="2">Agent.</font></font>
</blockquote>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="1004024"></a>The <font face="Courier New, Courier, sansserif, sans serif" size="2">AgentFile</font> attribute value cannot be overridden. </font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="998986"></a>AgentReplyTimeout</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998988"></a>The engine restarts the agent if it has not received the periodic heartbeat from the agent for the number of seconds specified by this attribute. The default value of 130 seconds works well for most configurations. Increase this value if the engine is restarting the agent. This may occur when the system is heavily loaded or if the number of resources exceeds three or four hundred. (See the command <font face="Courier New, Courier, sansserif, sans serif" size="2">haagent</font> <font face="Courier New, Courier, sansserif, sans serif" size="2">-display</font> in the chapter on administering VCS from the command line in the <font face="Courier New, Courier, sansserif, sans serif" size="2"><i>VERITAS Cluster Server User's Guide</i></font><em>.</em>) Note that the engine will also restart a crashed agent. The <font face="Courier New, Courier, sansserif, sans serif" size="2">AgentReplyTimeout</font> attribute value cannot be overridden.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="998989"></a>AgentStartTimeout</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998991"></a>After the engine has started the agent, this is the amount of time the engine waits for the initial agent &quot;handshake&quot; before attempting to restart. Default is 60 seconds. The <font face="Courier New, Courier, sansserif, sans serif" size="2">AgentStartTimeout</font> attribute value cannot be overridden.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="998993"></a>ArgList</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998995"></a>An ordered list of attributes whose values are passed to the <font face="Courier New, Courier, sansserif, sans serif" size="2">open</font>, <font face="Courier New, Courier, sansserif, sans serif" size="2">close</font>, <font face="Courier New, Courier, sansserif, sans serif" size="2">online</font>, <font face="Courier New, Courier, sansserif, sans serif" size="2">offline</font>, <font face="Courier New, Courier, sansserif, sans serif" size="2">monitor</font>, and <font face="Courier New, Courier, sansserif, sans serif" size="2">clean</font> entry points. Default is empty list. The <font face="Courier New, Courier, sansserif, sans serif" size="2">ArgList</font> attribute value cannot be overridden.</font>
</p>




<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000"><a name="998997"></a>ArgList Reference Attributes</font>
</h3>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="998999"></a>Reference attributes refer to attributes of a different resource. If the value of a resource attribute is defined as the name of another resource, the <font face="Courier New, Courier, sansserif, sans serif" size="2">ArgList</font> of the first resource can refer to an attribute of the second resource using the <font face="Courier New, Courier, sansserif, sans serif" size="2">:</font> operator.</font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="999000"></a>For example, if the resource <font face="Courier New, Courier, sansserif, sans serif" size="2">ArgList</font> resembles the following code sample (in which the value of <font face="Courier New, Courier, sansserif, sans serif" size="2">attr3</font> is the name of another resource), the entry points are passed the values of the <font face="Courier New, Courier, sansserif, sans serif" size="2">attr1</font>, <font face="Courier New, Courier, sansserif, sans serif" size="2">attr2</font> attributes of the first resource, and the value of the <font face="Courier New, Courier, sansserif, sans serif" size="2">attr_A</font> attribute of the second resource.</font>
</p>

<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="999001"></a>&nbsp;{&nbsp;attr1,&nbsp;attr2,&nbsp;attr3:attr_A&nbsp;}
</font>



<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="1071722"></a>AttrChangedTimeout</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="1071724"></a>Maximum time (in seconds) within which the <font face="Courier New, Courier, sansserif, sans serif" size="2">attr_changed</font> entry point must complete or else be terminated. Default is 60 seconds. The <font face="Courier New, Courier, sansserif, sans serif" size="2">AttrChangedTimeout</font> attribute value can be overridden.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="1071725"></a>CleanTimeout</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="1071727"></a>Maximum time (in seconds) within which the <font face="Courier New, Courier, sansserif, sans serif" size="2">clean</font> entry point must complete or else be terminated. Default is 60 seconds. The <font face="Courier New, Courier, sansserif, sans serif" size="2">CleanTimeout</font> attribute value can be overridden.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="1071728"></a>CloseTimeout</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="1071730"></a>Maximum time (in seconds) within which the <font face="Courier New, Courier, sansserif, sans serif" size="2">close</font> entry point must complete or else be terminated. Default is 60 seconds.The <font face="Courier New, Courier, sansserif, sans serif" size="2">CloseTimeout</font> attribute value can be overridden.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="1011450"></a>ComputeStats</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="1011451"></a>An attribute that indicates whether or not VCS is to keep track of monitor statistics for a given resource. A value of 1 indicates VCS is to keep track of the monitor time for the resource. A value of 0 indicates that VCS is not keep track of monitor statistics for a resource. See <a href="07_set_params_vcs163_999062.html#1002476">MonitorStatsParam</a>. The default is 0. </font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="999013"></a>ConfInterval</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="999015"></a>Specifies an interval in seconds. When a resource has remained online for the designated interval (all <font face="Courier New, Courier, sansserif, sans serif" size="2">monitor</font> invocations during the interval reported <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">ONLINE</font>), any earlier faults or restart attempts of that resource are ignored. This&nbsp;attribute is used with ToleranceLimit to allow the <font face="Courier New, Courier, sansserif, sans serif" size="2">monitor</font> entry point to report <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">OFFLINE</font> several times before the resource is declared <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">FAULTED</font>. If&nbsp;<font face="Courier New, Courier, sansserif, sans serif" size="2">monitor</font> reports <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">OFFLINE</font> more often than the number set in ToleranceLimit, the resource is declared <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">FAULTED</font>. However, if the resource remains online for the interval designated in ConfInterval, any earlier reports of <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">OFFLINE</font> are not counted against ToleranceLimit.</font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="999016"></a>The agent framework uses the values of MonitorInterval (MI), MonitorTimeout (MT), and ToleranceLimit (TL) to determine how low to set the value of ConfInterval. The agent framework ensures that ConfInterval (CI) cannot be less than that expressed by the following relationship:</font>
</p>

<blockquote>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="999017"></a>(MI + MT) * TL + MI + 10</font>
</blockquote>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="999018"></a>Lesser specified values of ConfInterval are ignored. For example, assume that the values are 60 for MI, 60 for MT, and 0 for TL. If you specify any value lower than 70 for CI, the agent framework ignores the specified value and sets the value to 70. However, you can successfully specify and set CI to any value over 70. </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="999019"></a>ConfInterval is also used with RestartLimit to prevent VCS from restarting the resource indefinitely. VCS attempts to restart the resource on the same system according to the number set in RestartLimit within ConfInterval before giving up and failing over. However, if the resource remains online for the interval designated in ConfInterval, earlier attempts to restart are not counted against RestartLimit. Default is 600 seconds. The <font face="Courier New, Courier, sansserif, sans serif" size="2">ConfInterval</font> attribute value can be overridden.</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="07_set_params_vcs160_1006790.html" title="Agent Attribute Definitions">Return to Top</a></font>

  </td>
  <td align="right"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&lt;&nbsp;<a href="07_set_params_vcs159_1006645.html" title="Previous - Overriding Static Attributes">Previous</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="07_set_params_vcs161_1071741.html" title="Next - FaultOnMonitorTimeouts">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="adg_hpux41_titlepage_docCD_vcs95_73700.vxhd" title="Cluster Server 4.1 Agent Developer's Guide title page ">Cluster Server 4.1 Agent Developer's 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>
