Changeset 34495 for branches/eam_branches/ipp-20120905/Ohana/src/opihi

Timestamp:

Oct 2, 2012, 2:27:15 PM (14 years ago)

Author:

eugene

Message:

update controller doc

File:

• branches/eam_branches/ipp-20120905/Ohana/src/opihi/doc/pantasks.controller.txt (modified) (1 diff)

branches/eam_branches/ipp-20120905/Ohana/src/opihi/doc/pantasks.controller.txt

@@ -129 +129 @@
 
 * machines : list the status of the hosts by unique machine name.
-  This command is one of the few which interact with a single 
+  This command is one of the few which work with the multiple
+  connections to a single named machine as the same connection.  The
+  command lists the number of connections to the give machine, the
+  number of jobs currently running on that host, and the number of
+  jobs running on another host which requested the given host. 
 
+* parameters : set several pcontrol internal parameters.  this
+  function lets the user interact with the pcontrol shell and set some
+  internal state variables. The 3 currently allowed options are:
 
-Note that 
+  * parameters connect_time (time) : set the maximum time a pclient is
+    kept alive before pcontrol attempts to reset the connection (time
+    in seconds?)
+  * parameters wanthost_wait (time) : set the amount of time pcontrol
+    will wait before sending a job to a host other than the desired
+    host (time in seconds)
+  * parameters unwanted_host_jobs (Njobs) : set the number of jobs
+    allowed to run which desire a specific host.  this parameters
+    prevents pcontrol from overloading some specific machine due to
+    I/O operations when the process operation is elsewhere.
 
+ * output : print the bufers which carry the controller output.  when
+   pcontrol starts up, the output can be redirected to a file.  if it
+   is not redirected, it is stored by pantasks.  the buffer is not
+   normally dumped in a regular fashion, and can fill the pantasks
+   memory usage.  this command dumps the output to pantasks, and can
+   also flush the buffer (if the "flush" option is given).
+
+ * run : set the run level for the controller.  the command is of the
+   form "run (level)".  pcontrol may be in one of 4 run levels: 
+   * all : all normal pcontrol ops (this is aslo set with no optional
+           argument to the run command).
+   * reap : keep the machines running (maintain comms and turn on/off
+            as needed) and harvest results from jobs, but do not spawn
+            new jobs.
+   * hosts : manage the machines, but do not manage jobs (spawn or
+             harvest).
+   * none  : stop all pcontrol processing
+
+ * status : report the current status of the controller: list all
+   known jobs and all known hosts, giving their status.
+
+ * stop : stop all pcontrol processing (equivalent to "run none")
+
+ * verbose : turn on verbose mode for pcontrol (output to pcontrol.log
+   or use "controller output").
+
+ * version : print version info for pcontrol
+
+ * pulse : in non-threaded pcontrol mode (deprecated), set the
+   readline timeout.
+  
 
 [1] : note that the command 'controller status' includes the job and