Changes between Version 35 and Version 36 of FeddCommands
- Timestamp:
- Jun 12, 2014 2:53:31 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
FeddCommands
v35 v36 20 20 '''--logfile='''''filename'':: 21 21 Redirect log output to ''filename'' rather than the default standard output 22 22 23 == Command Line == 23 24 … … 31 32 32 33 '''--cert='''''filename'':: 33 Certificate from which to derive the user's [FeddAbout#GlobalIdentifiers:Fedids fedid]. By default the contents of `.ssl/ emulab.pem` in the user's home directory is used.34 Certificate from which to derive the user's [FeddAbout#GlobalIdentifiers:Fedids fedid]. By default the contents of `.ssl/fedid.pem` or `.ssl/emulab.pem` in the user's home directory is used. `fedid.pem` is preferred. 34 35 '''--debug''':: 35 36 Produce additional debugging output. … … 53 54 `fedd_create.py` takes the following arguments: 54 55 55 '''--active='''''testbedname'''::56 Tell the experiment controller that ''testbedname'' prefers to initiate connections from its portal nodes57 56 '''--experiment_cert='''''filename'':: 58 57 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 below, but is an output parameter here. 59 58 '''--experiment_name='''''exp_name'':: 60 59 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. 60 '''--delegate''':: 61 Delegate the rights of the user to the experiment fedid created by the experiment controller. This is the default, and only developers or serious power users will want anything else. The '''--no-delegate''' option turns it off. 61 62 '''--file='''''filename'':: 62 63 File containing the [FeddAbout#ExperimentDescriptions experiment description]. 63 '''-- project='''''export_project''::64 The local project to export from the master testbed.64 '''--gen_cert''':: 65 If this is specified, the fedd_create.py code generates the experiment certificate. One can use this if there is any reason to doubt the experiment controller's fedid creation algorithm. 65 66 '''--map='''''spec'':: 66 67 Map a testbed identifier in the experiment description into a URI for its access controller. Format for ''spec'' is testbed_id:access_uri. For example, '''--map=deter:http://localhost:11123''' will try to install nodes in the experiment description with a label of "deter" on to the controller at !http://localhost:11123 . A node label is usually set with the {{{tb-set-node-testbed}}} command in the description. 67 68 '''--master='''''master_testbed'':: 68 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. 69 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. '''Deprecated''' in favor of explicit service requests. 70 '''--project='''''export_project'':: 71 The local project to export from the master testbed. '''Deprecated''' in favor of explicit service requests. 69 72 '''--service='''''spec'':: 70 73 Add the given [FeddAbout#ExperimentServices service] to the experiment being created. This parameter may be specified multiple times. ''Spec'' has the format: … … 74 77 Names are specified in the [FeddAbout#ExperimentServices discussion of services in the overview]. 75 78 79 These lines can also be specified in the experiment description file as comments prefixed with the tag '''SERVICE:''' 80 76 81 === fedd_ftopo.py === 77 82 … … 87 92 The output has the format: 88 93 {{{ 89 element_name:physical_name:testbed 90 }}} 94 element_name:physical_name:status:supported_ops:testbed 95 }}} 96 97 The fields are: 98 99 * The node name from the experiment layout file 100 * The local names that the individual testbed has given to the node. These are testbed dependent. If there is more than one name assigned by the testbed, they will be comma-separated. 101 * The status of the individual node 102 * Operations allowed on the node 103 * The testbed name on which the node is instantiated 104 91 105 92 106 === fedd_image.py === … … 94 108 `fedd_image.py` creates visualizations of federated experiments at a box and lines level, showing the interconnections between elements. The visualizations can be generated from an active federated experiment, a [FeddPluginArchitecture#TopologyDescriptionLanguage topdl] description, or an ns2 description. `fedd-image.py` calls out to graphviz's `neato` program to draw the graphs, so it or a compatible program must be available. 95 109 96 Internally, the various representations are converted to topdl and from there into the `neato` specification. An active experiment's topdl description must be pulled fr mo tehexperiment controller it was created on and a local ns2 description must be translated by a fedd into topdl. Topdl descriptions can be drawn without contacting a fedd.110 Internally, the various representations are converted to topdl and from there into the `neato` specification. An active experiment's topdl description must be pulled from the experiment controller it was created on and a local ns2 description must be translated by a fedd into topdl. Topdl descriptions can be drawn without contacting a fedd. 97 111 98 112 `fedd_image.py` takes the following arguments in addition to the standard ones: … … 106 120 '''--format='''''fmt'':: 107 121 The image format to use. Valid choices are '''jpg''', '''png''', '''svg''', and '''dot'''. '''dot''' is graphviz input. 122 '''--group='''''attribute'':: 123 Group nodes by an attribute attached to them and outline them in the output. This may be given more than once. 108 124 '''--labels''':: 109 125 Include node names and IP address information in the image. This is the default. … … 114 130 '''--pixels='''''pix'':: 115 131 Output an image that is ''pix'' pixels, square. 116 '''--group='''''attribute''::117 Group nodes by an attribute attached to them and outline them in the output. This may be given more than once.118 132 '''--program='''''path'':: 119 133 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. … … 127 141 '''id''':: 128 142 The local name and [FeddAbout#GlobalIdentifiers:Fedids fedid] of this experiment. Just the fedid is returned, not a certificate representing it, or its key. 129 '''embedding'''::130 A raw format of the information returned by [FeddCommands#fedd_ftopo.py]. Unless you're debugging `fedd_ftopo.py` we suggest that program.131 143 '''experimentdescription''':: 132 144 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. … … 175 187 === fedd_new.py === 176 188 177 This command creates an experiment but does not attach any resources to it. This is currently not very useful, but will become useful in the future.It takes the standard arguments and:189 This command creates an experiment but does not attach any resources to it. This function is also carried out by [FeddCommands#fedd_create.py fedd_create.py] before it attaches resources to the experiment. For most users that command is more useful. It takes the standard arguments and: 178 190 179 191 '''--experiment_cert='''''filename'':: … … 181 193 '''--experiment_name='''''exp_name'':: 182 194 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. 195 '''--gen_cert''':: 196 If this is specified, the fedd_new.py code generates the experiment certificate. One can use this if there is any reason to doubt the experiment controller's fedid creation algorithm. 183 197 184 198 === fedd_ns2topdl.py === … … 187 201 188 202 '''--file='''''filename'':: 189 File containing the [FeddAbout#ExperimentDescriptions experiment description].203 File containing the ns2 [FeddAbout#ExperimentDescriptions experiment description]. 190 204 '''--output='''''file'':: 191 205 A file to store the result. … … 197 211 It takes the standard parameters and: 198 212 199 '''--experiment_cert='''''filename''::213 '''--experiment_cert='''''filename'':: 200 214 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. 201 215 '''--experiment_name='''''name'':: … … 210 224 Deallocate resources from an experiment and remove the experiment structures from the experiment controller. It takes the standard arguments and: 211 225 212 '''--experiment_cert='''''filename''::226 '''--experiment_cert='''''filename'':: 213 227 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. 214 228 '''--experiment_name='''''name'':: … … 219 233 A file to store the log in rather than printing to the standard output. 220 234 '''--print_log''':: 221 Print a log of the experiment controllers actions. 235 Print a log of the experiment controllers actions. This causes fedd_terminate.py to act as a [FeddCommands#fedd_spewlog.py feddd_sppewlog.py] for termination. 222 236 223 237 === fedd_client.py === … … 243 257 244 258 There are several utilities used in the process of setting up a new controller on a DETER-style testbed. These generate [FeddDatabases federation databases] from the main testbed database. 259 260 The [FeddCommands#fedid.py fedid.py] command can also be useful in configuration. It is described with other general command line utilities. 245 261 246 262 === access_exp_access_db.py === … … 434 450 435 451 452 453
