Changes between Initial Version and Version 1 of Documentation/OMFCommandReference


Ignore:
Timestamp:
07/24/19 15:14:02 (9 months ago)
Author:
jkol
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/OMFCommandReference

    v1 v1  
     1
     2== OMF Command Reference
     3
     4=== omf
     5Run a command on the testbed(s).
     6
     7Usage:
     8  {{{omf  [COMMAND] [ARGUMENTS]}}}
     9
     10Available COMMANDs:
     11{{{
     12help      Print this help message or a specify command usage
     13exec      Execute an experiment script
     14load      Load a disk image on a given set of nodes
     15save      Save a disk image from a given node into a file
     16tell      Switch a given set of nodes ON/OFF or reboot them
     17stat      Returns the status of a given set of nodes
     18}}}
     19
     20To get more help on individual commands: {{{omf [COMMAND] -h}}}
     21
     22Examples:
     23  Return usage/help for the 'exec' command.
     24    {{{omf exec -h}}}
     25
     26  Return usage/help for the 'load' command.
     27    {{{omf load -h}}}
     28
     29
     30=== omf stat
     31Returns the status of the nodes in a testbed.
     32
     33Usage:
     34  {{{omf stat [-h] -t TOPOLOGY [-h] [-s] [-c AGGREGATE]}}}
     35
     36Arguments:
     37{{{
     38-h, --help                 print this help message
     39-t, --topology TOPOLOGY    a valid topology file or description (MANDATORY)
     40-s, --summary              print a summary of the node status for the testbed
     41-c, --config AGGREGATE     use testbed AGGREGATE
     42}}}
     43
     44Examples:
     45  {{{omf stat -t all}}}
     46
     47  {{{omf stat -t node1-1.grid.orbit-lab.org}}}
     48
     49  {{{omf stat -t [1..2,1..2]}}}
     50
     51  {{{omf stat -t system:topo:all -c grid}}}
     52
     53=== omf tell
     54Switch ON/OFF and reboot the nodes in a testbed.
     55
     56Usage:
     57  {{{omf tell [-h] -t TOPOLOGY -a ACTION [-c AGGREGATE]}}}
     58
     59Arguments:
     60{{{
     61-h, --help                 print this help message
     62-a, --action ACTION        specify an ACTION:
     63                           on          turn node(s) ON
     64                           offs        turn node(s) OFF (soft)
     65                           offh        turn node(s) OFF (hard)
     66                           reboot      reboots node(s) (soft)
     67                           reset       resets node(s) (hard)
     68-t, --topology TOPOLOGY    a valid topology file or description (MANDATORY)
     69-c, --config AGGREGATE     use testbed AGGREGATE
     70}}}
     71
     72Examples:
     73  {{{omf tell -a reset -t node1-1.grid.orbit-lab.org}}}
     74
     75  {{{omf tell -a on -t system:topo:all -c grid}}}
     76
     77  {{{omf tell -a reboot -t node1-1}}}
     78
     79  {{{omf tell -a offh -t [1..2,1..5]}}}
     80
     81  {{{omf tell -a offh -t system:topo:all}}}
     82
     83  {{{omf tell -a reset -t system:topo:imaged}}}
     84
     85=== omf load
     86Install a given disk image on the nodes in a testbed.
     87
     88Usage:
     89  {{{omf load [-h] -t TOPOLOGY [-i IMAGE_PATH] [-o TIMEOUT] [-c AGGREGATE]}}}
     90
     91Arguments:
     92{{{
     93-h, --help                 print this help message
     94-t, --topology TOPOLOGY    a valid topology file or description (MANDATORY)
     95                           (if a file 'TOPOLOGY' doesn't exist, interpret it as a
     96                           comma-separated list of nodes)
     97-i, --image IMAGE          disk image to load
     98                           (default is 'baseline.ndz', the latest stable baseline image)
     99-c, --config AGGREGATE     use testbed AGGREGATE
     100-o, --timeout TIMEOUT      a duration (in sec.) after which imageNodes should stop waiting for
     101                           nodes that have not finished their image installation
     102                           (default is 800 sec, i.e. 13min 20sec)
     103-r, --resize SIZE          Resizes the first partition to SIZE GB or to maximum size if SIZE=0 or
     104                           leave x percent of free space if SIZE=x%
     105  --outpath PATH           Path where the resulting Topologies should be saved
     106                           (default is '/tmp')
     107  --outprefix PREFIX       Prefix to use for naming the resulting Topologies
     108                           (default is your experiment ID)
     109}}}
     110
     111Examples:
     112  {{{omf load -t all}}}
     113
     114  {{{omf load -t system:topo:all -i baseline-2.4.ndz}}}
     115
     116  {{{omf load -t node1-1 -i wireless-2.6.ndz}}}
     117
     118  {{{omf load -t [1..10,1..5] -i baseline.ndz -o 400}}}
     119
     120  {{{omf load -t system:topo:circle -i my_Own_Image.ndz}}}
     121
     122  {{{omf load -t my_Own_Topology -i baseline-2.2.ndz -t 600 -c grid}}}
     123
     124  {{{omf load -t my_Own_Topology --outpath ./ --outprefix my_Own_Prefix}}}
     125
     126
     127=== omf save
     128Save a disk image from a given node into an archive file.
     129
     130Usage:
     131  {{{omf save -n NODE [-h] [-c AGGREGATE]}}}
     132
     133
     134Arguments:
     135{{{
     136-h, --help           print this help message
     137-n, --node NODE      a valid description of a single node (MANDATORY)
     138                     (no default here, you have to enter a node!)
     139-r, --resize SIZE    Resizes the first partition to SIZE GB or to maximum size if SIZE=0 or
     140                     leave x percent of free space if SIZE=x%
     141}}}
     142
     143Examples:
     144  {{{omf save -n node5-3.grid.orbit-lab.org}}}
     145
     146  {{{omf save -n node1-1.sb2.orbit-lab.org}}}
     147
     148=== omf exec
     149Execute an experiment script.
     150
     151Usage:
     152  {{{exec [OPTIONS] ExperimentName [-- EXP_OPTIONS]}}}
     153
     154!ExperimentName is the filename of the experiment script
     155
     156[EXP_OPTIONS] are any options defined in the experiment script
     157
     158[OPTIONS] are any of the following:
     159{{{
     160-a, --allow-missing              Continue experiment even if some nodes did not check in
     161-c, --config NAME                Configuration section from the config file ('default' if omitted)
     162-C, --configfile FILE            File containing local configuration parameters
     163-d, --debug                      Operate in debug mode
     164-i, --interactive                Run the experiment controller in interactive mode
     165-l, --libraries LIST             Comma separated list of libraries to load (defaults to [system:exp:stdlib,system:exp:eventlib,system:exp:winlib])
     166--log FILE                       File containing logging configuration information
     167-m, --message MESSAGE            Message to add to experiment trace
     168-n, --just-print                 Print the commands that would be executed, but do not execute them
     169-N, --no-am                      Don't use the Aggregate Manager (AM)
     170-p, --print URI                  Print the contents of the experiment script
     171-o, --output-result FILE         File to write final state information to
     172-e, --experiment-id EXPID        Set the ID for this experiment, instead of the default standard ID
     173-O, --output-app                 Display STDOUT & STDERR output from the executed applications
     174-r, --reset                      If set, then reset (reboot) the nodes before the experiment
     175-s, --shutdown                   If set, then shut down resources at the end of an experiment
     176-S, --slice NAME                 Name of the Slice where this EC should operate
     177-t, --tags TAGS                  Comma separated list of tags to add to experiment trace
     178--oml-uri URI                    The URI to the OML server for this experiment
     179-x, --extra-libs LIST            Comma separated list of libraries to load in addition to [system:exp:stdlib,system:exp:eventlib,system:exp:winlib]
     180--slave-mode EXPID               Run in slave mode in disconnected experiment, EXPID is the exp. ID
     181--slave-mode-resource NAME       When in slave mode, NAME is the HRN of the resource for this EC
     182-h, --help                       Show this message
     183-v, --version                    Show the version
     184}}}