Commit e4cc5c3d authored by Timothy Stack's avatar Timothy Stack
Browse files

Add some documentation for the experiment.metadata and

experiment.nsfile methods.  Prune some more fields out of the metadata
return value.
parent c6f63151
...@@ -1382,7 +1382,18 @@ class experiment: ...@@ -1382,7 +1382,18 @@ class experiment:
"keyhash", "keyhash",
"eventkey", "eventkey",
"sim_reswap_count", "sim_reswap_count",
"elab_in_elab" "elab_in_elab",
"locpiper_port",
"locpiper_pid",
"usemodelnet",
"priority",
"modelnet_edges",
"modelnet_cores",
"elabinelab_nosetup",
"event_sched_pid",
"wa_bw_solverweight",
"wa_plr_solverweight",
"wa_delay_solverweight",
]) ])
vue = DBQueryFatal("SELECT name,value FROM virt_user_environment " vue = DBQueryFatal("SELECT name,value FROM virt_user_environment "
......
...@@ -630,6 +630,53 @@ experiments. ...@@ -630,6 +630,53 @@ experiments.
</tr> </tr>
</table> </table>
<br>
<li><tt><b>metadata</b></tt>: Get any metadata associated with the given
experiment. The return value is a hashtable containing fields such as the
experiment's description and creation date.
<br>
<br>
The required arguments are:<br><br>
<table cellpadding=2>
<tr>
<th>Name</th><th>Type</th><th>Description</th>
</tr>
<tr></tr>
<tr>
<td><tt>proj</tt></td>
<td>string</td>
<td>The Emulab project ID of the experiment</td>
</tr>
<tr>
<td><tt>exp</tt></td>
<td>string</td>
<td>The Emulab experiment ID</td>
</tr>
</table>
<br>
<li><tt><b>nsfile</b></tt>: Get the NS file associated with the given
experiment.
<br>
<br>
The required arguments are:<br><br>
<table cellpadding=2>
<tr>
<th>Name</th><th>Type</th><th>Description</th>
</tr>
<tr></tr>
<tr>
<td><tt>proj</tt></td>
<td>string</td>
<td>The Emulab project ID of the experiment</td>
</tr>
<tr>
<td><tt>exp</tt></td>
<td>string</td>
<td>The Emulab experiment ID</td>
</tr>
</table>
<br> <br>
<li><tt><b>swapexp</b></tt>: Swap an experiment in or out. The experiment <li><tt><b>swapexp</b></tt>: Swap an experiment in or out. The experiment
must, of course, be in the proper state for requested operation. must, of course, be in the proper state for requested operation.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment