CLI Tools

The command-line tools leverage the REST API and provide the following operations:

command	functions
iotlab-auth	configure account credentials
iotlab-experiment	start, stop, query experiments
iotlab-node	start, stop, reset nodes
iotlab-profile	manage nodes configurations

Commands are self-documented, and usually have sub-commands which are also self-documented. Use e.g. iotlab-node --help or iotlab-profile add --help.

| CLI Tools Installation | CLI Tools Examples | CLI Tools Authentication |

Synopsis

iotlab-auth

usage: iotlab-auth [-h] -u USERNAME [-p PASSWORD]

iotlab-auth command-line store your credentials.
It creates a file .iotlabrc in your home directory
with username and password options.

optional arguments:
  -h, --help            show this help message and exit
  -u USERNAME, --user USERNAME
  -p PASSWORD, --password PASSWORD

iotlab-experiment

usage: iotlab-experiment [-h] [-u USERNAME] [-p PASSWORD] [-v]
                      {submit,stop,get,load,info,wait} ...

iotlab-experiment command-line manage experiments on testbed.

positional arguments:
  {submit,stop,get,load,info,wait}
    submit              submit user experiment
    stop                stop user experiment
    get                 get user's experiment
    load                load and submit user experiment
    info                resources description list
    wait                wait user experiment started

optional arguments:
  -h, --help            show this help message and exit
  -u USERNAME, --user USERNAME
  -p PASSWORD, --password PASSWORD
  -v, --version         show program's version number and exit

iotlab-node

usage: iotlab-node [-h] [-u USERNAME] [-p PASSWORD] [-i EXPERIMENT_ID]
                [-l COMMAND_LIST] [-b]
                (--start | --stop | --reset | --update PATH_FILE)

optional arguments:
  -h, --help            show this help message and exit
  -u USERNAME, --user USERNAME
  -p PASSWORD, --password PASSWORD
  -i EXPERIMENT_ID, --id EXPERIMENT_ID
                        experiment id submission
  -l COMMAND_LIST, --list COMMAND_LIST
                        nodes list
  -b, --battery         battery mode for start command (dc mode by default)
  --start               start command
  --stop                stop command
  --reset               reset command
  --update PATH_FILE    firmware path file

iotlab-profile

usage: iotlab-profile [-h] [-u USERNAME] [-p PASSWORD]
                   {addwsn430,addm3,del,get,load} ...

iotlab-profile command-line manage profiles experimentation :
store you favourite resources configuration with combination
of a power supply mode and an automatic measure configuration
(e.g. consumption, radio, ...)

positional arguments:
  {addwsn430,addm3,del,get,load}
    addwsn430           add wsn430 user profile
    addm3               add m3 user profile
    del                 delete user profile
    get                 get user's profile
    load                load user profile

optional arguments:
  -h, --help            show this help message and exit
  -u USERNAME, --user USERNAME
  -p PASSWORD, --password PASSWORD