Changes between Version 12 and Version 13 of FeddCommands

Timestamp:

Jul 27, 2009 2:46:24 PM (15 years ago)

Author:

faber

Comment:

Add new commands

FeddCommands

@@ -77 +77 @@
 }}}
 
-where operation is one of '''create, terminate, info, vtopo, vis, info, split, or access''' and the parameters are described below.
+where operation is one of '''create, terminate, info, vtopo, vis, multiinfo, multistatus, spewlog, image, ns_image, split, or access''' and the parameters are described below.
 
 All commands take the following parameters:
@@ -115 +115 @@
 }}}
 
-The results are the local name of the experiment and its fedid printed to standard output.  If ''--experiment_file'' is given an X.509 certificate and private key are saved to the given file that can be used as a capability to access the experiment state.
+The results are the local name of the experiment and its fedid printed to standard output.  If ''--experiment_file'' is given an X.509 certificate and private key are saved to the given file that can be used as a capability to access the experiment state.  When the '''create''' command terminates the experiment is being created.  Use the '''info''' or '''spewlog''' command to see when the experiment has been fully created.
 
 The commands to access data about an experiment or to terminate it all take only two non-generic options:
@@ -124 +124 @@
   The local name of the experiment to terminate.  Only the experiment creator can use this for access.
 
-The informational commands are '''vtopo''', '''vis''', and '''info'''.  '''Vtopo''' and '''vis''' are equivalent to the analogous Emulab XMLRPC commands, and `fedd_client.py` prints thier results in raw XML.  '''Info''' provides more information about the experiment, and it is printed as a python hash.  These are primarily used for debugging rather than operations.
+The informational commands are '''vtopo''', '''vis''', and '''info'''.  '''Vtopo''' and '''vis''' are equivalent to the analogous Emulab XMLRPC commands, and `fedd_client.py` prints thier results in raw XML.  '''Info''' provides general access to information about an experiment's state.  It takes an additonal parameter to control the data output:
+
+ '''--data ='''''data_element''::
+  The data to output. May be specified more than once.
+
+The valid choices for '''--data''' are:
+ '''federant'''::
+  All information about the various federants.  The XML format is available in the [source:fedd/trunk/wsdl/fedd_types.xsd data description]
+ '''id'''::
+  The local name and fedid of the experiment
+ '''status'''::
+  The current status of the experiment.  One of '''active''', '''starting''', or '''failed'''
+ '''log'''::
+  The current experiment allocation log (may be incomplete for experiments still '''starting''')
+ '''access'''::
+  The X.509 credentials used to access the experiment.  Note that this is only available to those who already have access to the experiment, but that can be passed along to others to grant them access.
+ '''vis'''::
+  visualization XML as above.  (In fact '''vis''' is an alias for this.)
+ '''vtopo'''::
+  topology information as above. ('''vtopo''' is an alias for this.)
 
 The '''image''', '''ns_image''' and '''status''' commands are more useful to users.  The first two create simple image files from either an existing federated experiment or from the experiment description.  '''image''' takes the same parameters as '''vtopo''', '''vis''', and '''info''' as well as:
@@ -144 +163 @@
  '''active'''::
  The experiment exists
- '''inactive'''::
- The experiment is not swapped in, or the user does not have the right to acces it
- '''swapping'''::
- The experiment is swapping in.
- '''unknown'''::
- The experiment state could not be determined
-
-The '''terminate''' command stops a federated experiment and removes the access granted from the federants.
+ '''starting'''::
+ The experiment is being created.
+ '''failed'''::
+ The experiment could not be started.  This state allows users to retrieve logs and federant information from failed experiments.  Once information is retrieved, this experiment should be terminated.
+
+The '''multiinfo''' command takes the '''--data''' options that '''info''' takes, and returns the specified information for all experiments that the user has access to, separated by three dashes for each experiment.
+
+The '''multistatus''' command returns the following information for each experiment that the user can access.  Each experiment's information is on a single line, separated by colons.  The information is the experiment's human-readable name, the experiment's fedid as a hex string, the experiment's status, the master testbed for the experiment, and the project name on that master testbed.
+
+The '''spewlog''' command waits for a given experiment to go into either '''active''' or '''failed''' state and incrementally outputs the allocation log as it is generated at the fedd.  In addition to the ususal information parameters it takes a '''--logfile='''''file'' parameter that specifies where to put the log file, and a '''--update='''''secs'' parameter that specifies how often to poll for log updates (default 10 seconds).  When '''spewlog''' completes, it outputs the status of the experiment into the log file and terminates.
+
+
+The '''terminate''' command stops a federated experiment and removes the access granted from the federants.  It takes a '''--force''' parameter that terminates experiments that are either starting or in an unusual state.
 
 The '''split''' and  '''access''' commands are really only for developers.  They are not described here, but