| 23 | | |
| 24 | | == exec == |
| 25 | | |
| 26 | | {{{ |
| 27 | | user@console: omf help exec |
| 28 | | |
| 29 | | OMF Experiment Controller 5.4 (git 9ac2ff9) |
| 30 | | |
| 31 | | Execute an experiment script |
| 32 | | |
| 33 | | Usage: exec [OPTIONS] ExperimentName [-- EXP_OPTIONS] |
| 34 | | |
| 35 | | ExperimentName is the filename of the experiment script |
| 36 | | [EXP_OPTIONS] are any options defined in the experiment script |
| 37 | | [OPTIONS] are any of the following: |
| 38 | | |
| 39 | | -a, --allow-missing Continue experiment even if some nodes did not check in |
| 40 | | -C, --configfile FILE File containing local configuration parameters |
| 41 | | -c, --config NAME Configuration section from the config file ('default' if omitted) |
| 42 | | -d, --debug Operate in debug mode |
| 43 | | -i, --interactive Run the experiment controller in interactive mode |
| 44 | | -l, --libraries LIST Comma separated list of libraries to load (defaults to [system:exp:stdlib,system:exp:eventlib]) |
| 45 | | --log FILE File containing logging configuration information |
| 46 | | -m, --message MESSAGE Message to add to experiment trace |
| 47 | | -n, --just-print Print the commands that would be executed, but do not execute them |
| 48 | | -p, --print URI Print to the console the content of the experiment resource URI |
| 49 | | -o, --output-result FILE File to write final state information to |
| 50 | | -e, --experiment-id EXPID Set the ID for this experiment, instead of the default standard ID |
| 51 | | -O, --output-app Display STDOUT & STDERR output from the executed applications |
| 52 | | -r, --reset If set, then reset (reboot) the nodes before the experiment |
| 53 | | -S, --slice NAME Name of the Slice where this EC should operate |
| 54 | | -s, --shutdown If set, then shut down resources at the end of an experiment |
| 55 | | -t, --tags TAGS Comma separated list of tags to add to experiment trace |
| 56 | | --oml-uri URI The URI to the OML server for this experiment |
| 57 | | -x, --extra-libs LIST Comma separated list of libraries to load in addition to [system:exp:stdlib,system:exp:eventlib] |
| 58 | | --slave-mode EXPID Run in slave mode in disconnected experiment, EXPID is the exp. ID |
| 59 | | --slave-mode-resource NAME When in slave mode, NAME is the HRN of the resource for this EC |
| 60 | | -h, --help Show this message |
| 61 | | -v, --version Show the version |
| 62 | | }}} |
| 63 | | |
| 64 | | == load == |
| 65 | | |
| 66 | | {{{ |
| 67 | | user@console:omf help load |
| 68 | | Install a given disk image on the nodes in a testbed |
| 69 | | Usage: |
| 70 | | omf-5.4 load [-h] [-i IMAGE_PATH] [-o TIMEOUT] [-t TOPOLOGY] [-c AGGREGATE] |
| 71 | | |
| 72 | | With: |
| 73 | | -h, --help print this help message |
| 74 | | -c, --config AGGREGATE use testbed AGGREGATE |
| 75 | | -t, --topology TOPOLOGY a valid topology file or description (defaults to 'system:topo:all') |
| 76 | | (if a file 'TOPOLOGY' doesn't exist, interpret it as a comma-separated list of nodes) |
| 77 | | -i, --image IMAGE disk image to load |
| 78 | | (default is 'baseline.ndz', the latest stable baseline image) |
| 79 | | -o, --timeout TIMEOUT a duration (in sec.) after which imageNodes should stop waiting for |
| 80 | | nodes that have not finished their image installation |
| 81 | | (default is 800 sec, i.e. 13min 20sec) |
| 82 | | --outpath PATH Path where the resulting Topologies should be saved |
| 83 | | (default is '/tmp') |
| 84 | | --outprefix PREFIX Prefix to use for naming the resulting Topologies |
| 85 | | (default is your experiment ID) |
| 86 | | |
| 87 | | Some Examples: |
| 88 | | omf-5.4 load |
| 89 | | omf-5.4 load -t system:topo:all -i baseline-2.4.ndz |
| 90 | | omf-5.4 load -t omf.nicta.node1 -i wireless-2.6.ndz |
| 91 | | omf-5.4 load -t omf.nicta.node1,omf.nicta.node2 -i baseline.ndz -o 400 |
| 92 | | omf-5.4 load -t system:topo:circle -i my_Own_Image.ndz |
| 93 | | omf-5.4 load -t my_Own_Topology -i baseline-2.2.ndz -t 600 -c grid |
| 94 | | omf-5.4 load -t my_Own_Topology --outpath ./ --outprefix my_Own_Prefix |
| 95 | | }}} |
| 96 | | |
| 97 | | == save == |
| 98 | | |
| 99 | | {{{ |
| 100 | | omf-5.4 help save |
| 101 | | Save a disk image from a given node into an archive file |
| 102 | | Usage: |
| 103 | | omf-5.4 save -n NODE [-h] [-c AGGREGATE] |
| 104 | | |
| 105 | | With: |
| 106 | | -h, --help print this help message |
| 107 | | -n, --node NODE a valid description of a single node |
| 108 | | (no default here, you have to enter a node!) |
| 109 | | |
| 110 | | Some Examples: |
| 111 | | omf-5.4 save -n omf.nicta.node1 |
| 112 | | omf-5.4 save -n omf.nicta.node3 -c grid |
| 113 | | }}} |
| 114 | | |
| 115 | | == tell == |
| 116 | | |
| 117 | | {{{ |
| 118 | | user@console:omf help tell |
| 119 | | Switch ON/OFF and reboot the nodes in a testbed |
| 120 | | Usage: |
| 121 | | omf-5.4 tell -a ACTION [-h] [-t TOPOLOGY] [-c AGGREGATE] |
| 122 | | |
| 123 | | With: |
| 124 | | -h, --help print this help message |
| 125 | | |
| 126 | | -a, --action ACTION specify an action |
| 127 | | ACTION: |
| 128 | | on turn node(s) ON |
| 129 | | offs turn node(s) OFF (soft) |
| 130 | | offh turn node(s) OFF (hard) |
| 131 | | reboot reboots node(s) (soft) |
| 132 | | reset resets node(s) (hard) |
| 133 | | |
| 134 | | -c, --config AGGREGATE use testbed AGGREGATE |
| 135 | | -t, --topology TOPOLOGY a valid topology file or description (defaults to 'system:topo:all') |
| 136 | | |
| 137 | | Some Examples: |
| 138 | | omf-5.4 tell -a reset |
| 139 | | omf-5.4 tell -a on -t system:topo:all -c grid |
| 140 | | omf-5.4 tell -a reboot -t omf.nicta.node1 |
| 141 | | omf-5.4 tell -a offs -t omf.nicta.node1,omf.nicta.node2 -c sb1 |
| 142 | | omf-5.4 tell -a offh -t system:topo:all |
| 143 | | omf-5.4 tell -a reset -t topo_grid_active |
| 144 | | }}} |
| 145 | | |
| 146 | | == stat == |
| 147 | | |
| 148 | | {{{ |
| 149 | | user@console:omf-5.4 help stat |
| 150 | | Returns the status of the nodes in a testbed |
| 151 | | Usage: |
| 152 | | omf-5.4 stat [-h] [-s] [-t TOPOLOGY] [-c AGGREGATE] |
| 153 | | |
| 154 | | With: |
| 155 | | -h, --help print this help message |
| 156 | | -s, --summary print a summary of the node status for the testbed |
| 157 | | -c, --config AGGREGATE use testbed AGGREGATE |
| 158 | | -t, --topology TOPOLOGY a valid topology file or description (defaults to 'system:topo:all') |
| 159 | | |
| 160 | | Some Examples: |
| 161 | | omf-5.4 stat |
| 162 | | omf-5.4 stat -s |
| 163 | | omf-5.4 stat -t omf.nicta.node1,omf.nicta.node2 -c sb1 |
| 164 | | omf-5.4 stat -t system:topo:all -c grid |
| 165 | | }}} |
| 166 | | |
| 167 | | For example: |
| 168 | | {{{ |
| 169 | | user@console.outdoor:~# omf stat |
| 170 | | |
| 171 | | INFO NodeHandler: OMF Experiment Controller 5.4 (git 6d34264) |
| 172 | | INFO NodeHandler: Slice ID: default_slice (default) |
| 173 | | INFO NodeHandler: Experiment ID: default_slice-2012-10-14t14.42.15-04.00 |
| 174 | | INFO NodeHandler: Message authentication is disabled |
| 175 | | INFO Experiment: load system:exp:stdlib |
| 176 | | INFO property.resetDelay: value = 210 (Fixnum) |
| 177 | | INFO property.resetTries: value = 1 (Fixnum) |
| 178 | | INFO Experiment: load system:exp:eventlib |
| 179 | | INFO Experiment: load system:exp:stat |
| 180 | | INFO Topology: Loading topology ''. |
| 181 | | INFO property.nodes: value = "system:topo:all" (String) |
| 182 | | INFO property.summary: value = false (FalseClass) |
| 183 | | INFO Topology: Loading topology 'system:topo:all'. |
| 184 | | Talking to the CMC service, please wait |
| 185 | | ----------------------------------------------- |
| 186 | | Domain: outdoor.orbit-lab.org |
| 187 | | Node: node3-6.outdoor.orbit-lab.org State: NOT REGISTERED |
| 188 | | Node: node3-3.outdoor.orbit-lab.org State: POWEROFF |
| 189 | | Node: node2-10.outdoor.orbit-lab.org State: POWEROFF |
| 190 | | Node: node1-10.outdoor.orbit-lab.org State: POWEROFF |
| 191 | | Node: node1-8.outdoor.orbit-lab.org State: POWERON |
| 192 | | Node: node1-6.outdoor.orbit-lab.org State: POWERON |
| 193 | | Node: node3-2.outdoor.orbit-lab.org State: POWEROFF |
| 194 | | Node: node3-1.outdoor.orbit-lab.org State: POWEROFF |
| 195 | | Node: node1-3.outdoor.orbit-lab.org State: POWERON |
| 196 | | Node: node3-5.outdoor.orbit-lab.org State: POWEROFF |
| 197 | | Node: node2-5.outdoor.orbit-lab.org State: NOT REGISTERED |
| 198 | | Node: node1-2.outdoor.orbit-lab.org State: POWERON |
| 199 | | ----------------------------------------------- |
| 200 | | INFO Experiment: Switching ON resources which are OFF |
| 201 | | INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks. |
| 202 | | INFO NodeHandler: |
| 203 | | INFO NodeHandler: Shutting down experiment, please wait... |
| 204 | | INFO NodeHandler: |
| 205 | | INFO run: Experiment default_slice-2012-10-14t14.42.15-04.00 finished after 0:6 |
| 206 | | }}} |
