<div class="sright">
  <div class="sub-content-head">
    Maui Scheduler  </div>
  <div id="sub-content-rpt" class="sub-content-rpt" >
 <div class="tab-container docs" id="tab-container">
<div class="topNav">

<div class="docsSearch">
</div>

<div class="navIcons topIcons">
<a href="index.php"><img src="/resources/docs/images/home.png" title="Home" alt="Home" border="0"></a>
<a href="13.0rmandinterfaces.php"><img src="/resources/docs/images/upArrow.png" title="Up" alt="Up" border="0"></a>
<a href="13.1rmoverview.php"><img src="/resources/docs/images/prevArrow.png" title="Previous" alt="Previous" border="0"></a>
<a href="13.3rmextensions.php"><img src="/resources/docs/images/nextArrow.png" title="Next" alt="Next" border="0"></a>
</div>

<h1>13.2 Resource Manager Configuration</h1>

<h2>13.2.1 Configurable Resource Manager Attributes</h2>

<p> The scheduler's resource manager interface(s) are defined using the <a href="a.fparameters.php#rmcfg">RMCFG</a> parameter. This parameter allows specification of key aspects of the interface as shown in the table below.
<p>
<table border="2">
<tr>
<td><b>Attribute</b>
<td><b>Format</b>
<td><b>Default</b>
<td><b>Description</b>
<td><b>Example</b>

<tr>
<td><b>ASYNCJOBSTART</b>
<td>&lt;BOOLEAN&gt;
<td><b>FALSE</b>
<td>Enables Maui to start jobs asynchronously. <b>NOTE</b>: Only
enabled for PBS.
<td><tt>RMCFG[pbs] ASYNCJOBSTART=TRUE</p>

<tr>
<td><b>AUTHTYPE</b>
<td>one of  <b>CHECKSUM</b>, <b>PKI</b>, or <b>SECUREPORT</b>
<td><b>CHECKSUM</b>
<td>specifies the security protocol to be used in scheduler-resource manager communication. <b>NOTE</b>: Only valid with WIKI based interfaces.
<td><tt>RMCFG[base] AUTHTYPE=CHECKSUM</tt> <p>(The scheduler will require a secret key based checksum associated with each resource manager message)</p>

<tr>
<td><b>CONFIGFILE</b>
<td>&lt;STRING&gt;
<td><b>N/A</b>
<td>specifies the resource manager specific configuration file which must be used to enable correct API communication. <b>NOTE</b>: Only valid with LL based interfaces.
<td><tt>RMCFG[base] TYPE=LL CONFIGFILE=/home/loadl/loadl_config</tt> <p>(The scheduler will utilize the specified file when establishing the resource manager/scheduler interface connection)</p>

<tr>
<td><b>EPORT</b>
<td>&lt;INTEGER&gt;</b>
<td><b>N/A</b>
<td>specifies the event port to use to receive resource manager based scheduling events.
<td><tt>RMCFG[base] EPORT=15017</tt> <p>(The scheduler will look for scheduling events from the resource manager host at port 15017)</p>

<tr>
<td><b>MINETIME</b>
<td>&lt;INTEGER&gt;</b>
<td><b>1</b>
<td>specifies the minimum time in seconds between processing subsequent scheduling events.
<td><tt>RMCFG[base] MINETIME=5</tt> <p>(The scheduler will batch-process scheduling events which occur less than 5 seconds apart.)</p>

<tr>
<td><a name="nmport"></a>
<b>NMPORT</b></td>
<td>&lt;INTEGER&gt;</td>
<td>(any valid port number)</td>
<td>specifies a non-default RM node manager through which extended node attribute information may be obtained</td>
<td><tt>RMCFG[base] NMPORT=13001</tt>
<p>(The scheduler will contact the node manager located on each compute node at port 13001)</p>
</td>

<tr>
<td><a name="port"></a><b>PORT</b>
<td>&lt;INTEGER&gt;
<td>0
<td>specifies the port on which the scheduler should contact the associated resource manager. The value '0' specifies that the resource manager default port should be used.
<td><tt>RMCFG[base] TYPE=PBS HOST=cws PORT=20001</tt> <br>
(The scheduler will attempt to contact the PBS server daemon on host cws, port 20001)

<tr>
<td><a name="server"></a><b>SERVER</b>
<td>&lt;URL&gt;
<td>N/A
<td>specifies the resource management service to use. If not specified, the scheduler will locate the resource manager via built-in defaults or, if available, with an information service. <b>NOTE</b>: only available in Maui 3.2.7 and higher.
<td><tt>RMCFG[base] server=ll://supercluster.org:9705</tt><br>
<p>(The scheduler will attempt to utilize the Loadleveler scheduling API at the specified location.)</p>

<tr>
<td><b>SUBMITCMD</b>
<td>&lt;STRING&gt;</b>
<td><b>N/A</b>
<td>specifies the full pathname to the resource manager job submission client.
<td><tt>RMCFG[base] SUBMITCMD=/usr/local/bin/qsub</tt> <p>(The scheduler will use the specified submit command when launching jobs.)</p>

<tr>
<td><a name="timeout"></a><b>TIMEOUT</b>
<td>&lt;INTEGER&gt;
<td>15
<td>time (in seconds) the scheduler will wait for a response from the resource manager.
<td><tt>RMCFG[base] TIMEOUT=30</tt>
      <p>(The scheduler will wait 30 seconds to receive a response from the resource manager
 before timing out and giving up. The scheduler will try again on the next iteration.)</p>

<tr>
<td><a name="type"></a><b>TYPE</b>
<td>&lt;RMTYPE&gt;[:&lt;RMSUBTYPE&gt;] where &lt;RMTYPE&gt; is one of the following:
<b>LL</b>, <b>LSF</b>, <b>PBS</b>, <b>RMS</b>, <b>SGE</b>, <b>SSS</b>, or <b>WIKI</b> and the optional &lt;RMSUBTYPE&gt; value is one of <b>RMS</b>
<td>PBS
<td>specifies type of resource manager to be contacted by the scheduler. NOTE: for <b>TYPE</b> <b>WIKI</b>, <b>AUTHTYPE</b> must be set to <b>CHECKSUM</b> The &lt;RMSUBTYPE&gt; option is currently only used to support Compaq's RMS resource manager in conjunction with PBS. In this case, the value <tt>PBS:RMS</tt> should be specified. <b>NOTE</b>: deprecated in Maui 3.2.7 and higher - use <b>server</b> attribute.
<td><tt>RMCFG[clusterA] TYPE=PBS HOST=clusterA PORT=15003</tt> <br>
<tt>RMCFG[clusterB] TYPE=PBS HOST=clusterB PORT=15005</tt> <br>
      <p>(The scheduler will interface to two different PBS resource managers, one
located on server clusterA at port 15003 and one located on server clusterB at port 15004)</p>
</table>

<h4>13.2.2.2 Resource Manager Configuration Details</h4>

<p> As with all scheduler parameters, <b>RMCFG</b> follows the syntax described within the <a href="3.4configure.php">Parameters Overview</a>.

<h3>Resource Manager Types</h3>

<p> The parameter <b>RMCFG</b> allows the scheduler to interface to multiple types of resource managers using the <b>TYPE</b> or <b>SERVER</b> attributes. Specifying these attributes, any of the resource managers listed below may be supported. To further assist in configuration, <i>Integration Guides</i> are provided for <a href="pbsintegration.php">PBS</a>, <a href="sgeintegration.php">SGE</a>, and <a href="llintegration.php">Loadleveler</a> systems.<p>

<table border="2">
<tr>
<td><b>TYPE</b>
<td><b>Resource Managers</b>
<td><b>Details</b>

<tr>
<td>LL
<td>Loadleveler version 2.x and 3.x
<td>N/A

<tr>
<td>LSF
<td>Platform's Load Sharing Facility, version 5.1 and higher
<td>N/A

<tr>
<td>PBS
<td>OpenPBS (all versions), TORQUE (all versions), PBSPro (all versions)
<td>N/A

<tr>
<td>RMS
<td>RMS (for Quadrics based systems)
<td>for development use only - not production quality

<tr>
<td>SGE
<td>Sun Grid Engine version 5.3 and higher
<td>N/A

<tr>
<td>SSS
<td>Scalable Systems Software Project version 0.5 and 2.0 and higher
<td>N/A

<tr>
<td>WIKI
<td><a href="wiki">Wiki</a> interface specification version 1.0 and higher
<td>used for LRM, YRM, ClubMASK, BProc, and others

</table>

<h3>Resource Manager Name</h3>

<p> Maui can support more than one resource manager simultaneously. Consequently, the <b>RMCFG</b> parameter takes an index value, i.e., <tt>RMCFG[clusterA] TYPE=PBS</tt>. This index value essentially <i>names</i> the resource manager (as done by the deprecated parameter <b>RMNAME</b>. The resource manager name is used by the scheduler in diagnostic displays, logging, and in reporting resource consumption to the allocation manager. For most environments, the selection of the resource manager <i>name</i> can be arbitrary.

<h3>Resource Manager Location</h3>

<p> The <b>HOST</b>, <b>PORT</b>, and <b>SERVER</b> attributes can be used to specify how the resource manager should be contacted. For many resource managers (i.e., OpenPBS, PBSPro, Loadleveler, SGE, LSF, etc) the interface correctly establishes contact using default values. These parameters need only to be specified for resource managers such as the WIKI interface (which do not include defaults) or with resources managers which can be configured to run at non-standard locations (such as PBS). In all other cases, the resource manager is automatically located.

<h3>Other Attribute</h3>

<p> The maximum amount of time Maui will wait on a resource
manager call can be controlled by the <b><a href="a.fparameters.php#rmcfg">TIMEOUT</a></b>
parameter which defaults to 30 seconds. Only rarely will this parameter
need to be changed. The <b>AUTHTYPE</b> attribute allows specification of how
security over the scheduler/resource manager interface is to be handled.
Currently, only the WIKI interface is affected by this parameter.
<p> Another <b>RMCFG</b> attribute is <b><a href="a.fparameters.php#rmcfg">CONFIGFILE</a></b>,
which specifies the location of the resource manager's primary config file
and is used when detailed resource manager information not available via
the scheduling interface is required. It is currently only used with
the Loadleveler interface and needs to only be specified when using Maui
grid-scheduling capabilities.
<p> Finally, the <a href="a.fparameters.php#rmcfg">NMPORT</a> attribute
allows specification of the resource manager's node manager port and is
only required when this port has been set to a non-default value.
It is currently only used within PBS to allow MOM specific information
to be gathered and utilized by Maui.

<h2>13.1.2 Scheduler/Resource Manager Interactions</h2>
<p> In the simplest configuration, Maui interacts with
the resource manager using the four primary functions listed below:
<p><b>GETJOBINFO</b>
<p> Collect detailed state and requirement information
about idle, running, and recently completed jobs.
<p><b>GETNODEINFO</b>
<p> Collect detailed state information about idle, busy,
and defined nodes.
<p><b>STARTJOB</b>
<p> Immediately start a specific job on a particular
set of nodes.
<p><b>CANCELJOB</b>
<p> Immediately cancel a specific job regardless of job
state.
<p> Using these four simple commands, Maui enables nearly
its entire suite of scheduling functions. More detailed information
about resource manager specific requirements and semantics for each of
these commands can be found in the specific resource manager overviews.
(LL, PBS, or <a href="wiki">WIKI</a>).
<p> In addition to these base commands, other commands
are required to support advanced features such a dynamic job support, suspend/resume,
gang scheduling, and scheduler initiated checkpoint restart. More
information about these commands will be forthcoming.
<p> Information on creation a new scheduler resource
manager interface can be found in the <a href="13.4addingrminterfaces.php">Adding New Resource Manager Interfaces</a> section.</p>

<div class="navIcons bottomIcons">
<a href="index.php"><img src="/resources/docs/images/home.png" title="Home" alt="Home" border="0"></a>
<a href="13.0rmandinterfaces.php"><img src="/resources/docs/images/upArrow.png" title="Up" alt="Up" border="0"></a>
<a href="13.1rmoverview.php"><img src="/resources/docs/images/prevArrow.png" title="Previous" alt="Previous" border="0"></a>
<a href="13.3rmextensions.php"><img src="/resources/docs/images/nextArrow.png" title="Next" alt="Next" border="0"></a>
</div>

 </div>
 </div>
  </div>
  <div class="sub-content-btm"></div>
</div>
</div>