<!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:48">
<meta name="PRODUCTNAME" content="VERITAS Software Documentation">
<meta name="FILENAME" content="infra_support_agents.fm">
     
<title>VRTSWebApp Agent</title>

</HEAD>

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

<a name="132146"></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="infra_support_agents_vcs256_214520.html" title="Previous - Sample Configuration">Previous</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">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>
	
<h1><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="+1" color="#000000"><a name="132146"></a>VRTSWebApp Agent</font>
</h1>
 
  
  
  

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="252445"></a>Brings Web applications online, takes them offline, and monitors their status. The application is a Java Web application conforming to the Servlet Specification 2.3/JSP Specification 1.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 and VVR.</font>
</p>




<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="252446"></a>Entry Points</font>
</h2>
 
<p>
<ul type="disc"><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="252526"></a>Online---Starts the Web application with the specified parameters. If the Web server is not already running, it first starts the server.</font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="252527"></a>Offline---Removes the Web application from the Web server. If no other Web application is running, it shuts down the Web server.</font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="252528"></a>Monitor---Checks if the specified Web application is currently running inside the Web server. If the application is running, monitor reports <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">ONLINE</font>. If the application is not running, monitor reports <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">OFFLINE</font>.</font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="252509"></a>Clean---Removes the Web application from the Web server. If no other Web application is running, it shuts down the Web server.</font>
</li>
</ul>
</p>



<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="403505"></a>State Definitions</font>
</h2>
 
<p>
<ul type="disc"><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="403528"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">ONLINE</font>---Indicates that the Web application is running.</font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="403553"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">OFFLINE</font>---Indicates that the Web application is not running.</font>
</li>
<li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="403530"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">UNKNOWN</font>---Indicates that the agent could not determine the state of the resource or that the resource attributes are invalid.</font>
</li>
</ul>
</p>



<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="365994"></a>Type Definition</font>
</h2>
 
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="365995"></a>type&nbsp;VRTSWebApp&nbsp;(
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="365996"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;static&nbsp;str&nbsp;ArgList[]&nbsp;=&nbsp;{&nbsp;AppName,&nbsp;InstallDir,&nbsp;TimeForOnline&nbsp;}
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="365997"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;str&nbsp;AppName
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="365998"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;str&nbsp;InstallDir
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="365999"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;TimeForOnline
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="366000"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;static&nbsp;int&nbsp;NumThreads&nbsp;=&nbsp;1
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="366001"></a>)
</font>



<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="252450"></a>Required Attributes</font>
</h2>
 
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405201"></a>
<Table width="100%" border="1" cellpadding="2" cellspacing="0" >
<tr valign="top"><td><b><a name="405213"></a>Required Attribute</b>
</td>
<td><b><a name="405215"></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="405217"></a>AppName</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405219"></a>Name of the application as it appears in the Web server.</font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405220"></a>Access the applications at: <font face="Courier New, Courier, sansserif, sans serif" size="2">http://localhost:8181/vcs</font>.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405227"></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="405228"></a>Example: For VCS, use <font face="Courier New, Courier, sansserif, sans serif" size="2">vcs</font>.</font>
</li>
</ul></td>
</tr>
<tr valign="top"><td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405230"></a>InstallDir</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405232"></a>Path to the Web application installation. The Web application must be installed as a <font face="Courier New, Courier, sansserif, sans serif" size="2">.war</font> file with the same name as the AppName parameter; the <font face="Courier New, Courier, sansserif, sans serif" size="2">vcs</font> application must be installed as <font face="Courier New, Courier, sansserif, sans serif" size="2">vcs.war</font>. This attribute should point to the directory that contains this <font face="Courier New, Courier, sansserif, sans serif" size="2">.war</font> file.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405239"></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="405240"></a>Example: If AppName is <font face="Courier New, Courier, sansserif, sans serif" size="2">vcs</font> and InstallDir is <font face="Courier New, Courier, sansserif, sans serif" size="2">/opt/VRTSweb/VERITAS</font>, the agent constructs the path for the Web application as: <font face="Courier New, Courier, sansserif, sans serif" size="2">&quot;/opt/VRTSweb/VERITAS/vcs.war&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="405242"></a>TimeForOnline</font>
</p>
</td>
<td><p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405244"></a>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.</font>
</p>
<ul compact><li><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="405251"></a>Type and dimension: <a href="intro_agents_vcs195_104530.html#104607">integer</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="405252"></a>Example: <font face="Courier New, Courier, sansserif, sans serif" size="2">5</font></font>
</li>
</ul></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="132197"></a>Sample Configuration</font>
</h2>
 
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="132198"></a>VRTSWebApp&nbsp;VCSweb&nbsp;(
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="132199"></a>&nbsp;&nbsp;AppName&nbsp;=&nbsp;&quot;vcs&quot;
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="132200"></a>&nbsp;&nbsp;InstallDir&nbsp;=&nbsp;&quot;/opt/VRTSweb/VERITAS&quot;
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="132201"></a>&nbsp;&nbsp;TimeForOnline&nbsp;=&nbsp;5
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="201331"></a>&nbsp;&nbsp;)
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="403606"></a>
</font>

<!-- 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="infra_support_agents_vcs257_132146.html" title="VRTSWebApp Agent">Return to Top</a></font>

  </td>
  <td align="right"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&lt;&nbsp;<a href="infra_support_agents_vcs256_214520.html" title="Previous - Sample Configuration">Previous</a>&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>
