Changes between Version 10 and Version 11 of FeddCommands

Timestamp:

Jul 1, 2009 4:29:54 PM (15 years ago)

Author:

faber

Comment:

Document image, ns_image and status

FeddCommands

@@ -126 +126 @@
 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 '''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:
+
+ '''--output='''''file''::
+ A file to store the image in.  The output format is determined by the file suffix.
+ '''--format='''''fmt''::
+ The image format to use.  Valid choices are '''jpg''', '''png''', '''svg''', and '''dot'''.  '''dot''' is graphviz input.
+ '''--labels'''::
+ Include node names and IP address information in the image.  This is the default.
+ '''---no-labels'''::
+  Omit node names and IP address information in the image.
+
+'''ns_image''' takes the same additional parameters as '''image''', but is takes '''create''' parameters instead.  It generates the image from the description rather than the existing experiment.  It does not create a federated experiment.
+
+The '''status''' command is a modified '''info''' command that prints a single word that describes the status of an experiment:
+ '''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.