Changes between Version 1 and Version 2 of FeddCommands

Timestamp:

Dec 12, 2008 5:12:39 PM (16 years ago)

Author:

faber

Comment:

--

FeddCommands

@@ -96 +96 @@
 
 The '''create''' command takes the following additional parameters:
+ '''--experiment_cert='''''filename''
+  Store the certificate used to access the resulting experiment in ''filename''.  This certificate can be used as an input parameter to the terminate and informational commands beliw, but is an output parameter here.
  '''--experiment_name='''''exp_name''::
   Suggest ''exp_name'' to the `fedd` as a local identifier for the federated experiment.  The actual local name chosen will be returned from the command.
  '''-file='''''filename''::
-  File containing the [FeddExperiment experiment description].
+  File containing the [FeddAbout#ExperimentDescriptions experiment description].
  '''--project='''''export_project''::
   The local project to export from the master testbed.
+ '''--master='''''master_testbed''::
+  The master testbed.  This should correspond to one of the annotations used for testbed names in the experiment.  The `fedd` will use its [FeddDatabases#ExperimentNameMappingDB experiment name mapping DB] to resolve that name to a testbed.
  '''--sshKey='''''file''::
   Use the contents of ''file'' as the SSH key for service access in the experiment.  By default the contents of `.ssh/id_rsa.pub` is used.
- '''--master='''''master_testbed''::
-  The master testbed.  This should correspond to one of the annotations used for testbed names in the experiment.  The `fedd` will use its [FeddDatabases#ExperimentNameMappingDB experiment name mapping DB] to resolve that name to a testbed.
 
 An example of experiment creation is:
@@ -112 +114 @@
 $ fedd_client.py create --file=test_fedd.tcl --master=deter --project=emulab-ops --url=https://users.isi.deterlab.net:23234 --transport=xmlrpc
 }}}
+
+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 commands to access data about an experiment or to terminate it all take only two non-generic options:
+
+ '''--experiment_file='''''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 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 '''terminate''' command stops a federated experiment and removes the access granted from the federants.
+
+== User_to_project.py ==
+
+The `user_to_project.py` command exists to provide command line functionality that Emulab keeps in a web page.  It attaches a user to a project.  It is called by a `fedd` running on `boss` when a project is dynamically created.  Its default installation destination and the default value for the [experiment_control] parameter '''user_to_project''' both default to `/usr/local/bin/user_to_project.py`.  It is unlikely a user will ever need to run this command.