Changes between Version 19 and Version 20 of FeddCommands

Timestamp:

Jun 6, 2010 9:07:50 AM (14 years ago)

Author:

faber

Comment:

--

FeddCommands

@@ -178 +178 @@
  A `neato` compatible program to draw the graph.  This may be helpful if graphviz is installed in a non-standard place or with a non-standard name.
 
+=== fedd_info.py ===
+
+This program provides various information about running (or failed) federated experiments.  Many of the types of data it can return are accessible in more user-friendly ways by other commands.  It is largely used for debugging.
+
+The data types accessible are:
+
+  '''id'''::
+  The local name and [FeddAbout#GlobalIdentifiers:Fedids fedid] of this experiment.  Just the fedid is returned, not a certificate representing it, or its key.
+  '''embedding'''::
+  A raw format of the information returned by [FeddCommands#fedd_ftopo.py].  Unless you're debugging `fedd_ftopo.py` we suggest that program.
+  '''experimentdescription'''::
+  A [FeddPluginArchitecture#TopologyDescriptionLanguage topdl] description of the global virtual topology of this experiment.  Portal nodes and other elements that are transparent to the experiment (and potentially unknown to the experiment controller) are omitted.
+ '''log'''::
+ The experiment controller log from the experiment's creation or failed creation attempt.
+ '''status'''::
+ The experiment status.  See below for details.
+ '''vtopo'''::
+ '''vis'''::
+ Emulab compatible descriptions of the virtual topology and visualization of the experiment.  These are used to debug these compatibility interfaces.
+
+An experiment's status can be one of the following values:
+
+ '''active'''::
+ The experiment has resources allocated to it and has been successfully configured.
+ '''empty'''::
+ The experiment exists, but no attempt has been made to attach resources to it.
+ '''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.
+ '''starting'''::
+ The experiment is having resources allocated and elements configured.
+ '''terminating'''::
+ The experiment is being terminated.
+
+`fedd_info.py` takes the standard arguments and:
+
+ '''--experiment_cert='''''filename''::
+  The ''filename'' must contain a certificate valid for the experiment's fedid.  If so it is used to authenticate access to the experiment.  A password may be required if one has been added to the private key.
+ '''--experiment_name='''''name''::
+  The local name of the experiment to query.  Only the experiment creator can use this for access.
+ '''--data='''''sel''::
+  Print the data given by ''sel'', which can be any of the values above.  The '''--data''' argument may be specified multiple times.
+
+=== fedd_multiinfo.py ===
 
 == Fedd_client.py ==