The following is a comprehensive list of the ONOS test/development scripts, located in $ONOS_ROOT/tools/test/bin. The conventions followed here are:
...
Please refer to Development Environment Setup and Test Environment Setup Cells and ONOS test scripts for information about cells, OC
variables, and other conventions used here.
...
Table of Contents | ||
---|---|---|
|
Installation/configuration
onos-install [-f] [-n] [<node-ip>]
Installs ONOS bits on the designated cell machine.
...
- -f : forces an uninstall. Presently, install also includes onos-push-bits and onos-config within.
- -n : installation of onos.conf upstart configuration file will be suppressed and ONOS will not be started. Otherwise, if the option is not specified, ONOS will be ignited as a Linux daemon as the last step of the installation process.
onos-package -[TDR] | --[tar|deb|rpm]
Packages ONOS into different formats. Running the command without parameters has the same effect of running it with the --tar parameter.
options:
- -D, --deb : Creates a .deb ONOS package in /tmp
- -T, --tar : Creates a .tar.gz ONOS package in /tmp
- -R, --rpm : Creates a .rpm file in /tmp (this works just on centos/fedora/redhat like machines)
notes:
- --deb only works on Debian/Ubuntu.
- --rpm only works on on CentOS/Fedora/Redhat.
onos-uninstall [<node-ip>]
Uninstall ONOS from the designated cell machine, stopping it if needed.
...
- -h, --help : print usage
- <node-ip> : the hostname or IP address of the target machine. Incompatible with --cell
- --cell : execute on all machines in the current cell
onos-group [help | <command>]
Sends a command to all ONOS instances in the current cell. Currently supported commands are:
install [-f|-n], kill, patch-vm, push-keys, uninstall
These commands invoke the utility whose name is the command name prefixed with onos-, e.g. onos-install
for install.
options:
- <command> : A command to send to the instances.
- help : Displays this message and exits.
notes:
- Hitting <TAB> will display the options for onos-group.
- This is currently an initial cut, so commands that take inputs (e.g. push-keys) may not look streamlined.
Shell Aliases
The following are the aliases exported by the ONOS development environment bash_profile.
alias | command |
---|---|
mci | 'mvn clean install' |
mcis | 'mvn clean install -DskipTests -Dcheckstyle.skip -U -T 1C' |
mis | 'mvn install -DskipTests -Dcheckstyle.skip -U -T 1C' |
ob | 'onos-build' |
obi | 'onos-build -Dmaven.test.failure.ignore=true' |
obs | 'onos-build-selective' |
obd | 'onos-build-docs' |
op | 'onos-package' |
ot | 'onos-test' |
ol | 'onos-log' |
ow | 'onos-watch' |
oi | 'setPrimaryInstance' |
pub | 'onos-push-update-bundle' |
tl | '$ONOS_ROOT/tools/dev/bin/onos-local-log' |
tlo | 'tl | grep --colour=always -E -e "org.onlab|org.onosproject"' |
ll | 'less $KARAF_LOG' |
pp | 'python -m json.tool' |
docs | 'open $ONOS_ROOT/docs/target/site/apidocs/index.html' |
gui | 'onos-gui' |
sshctl | 'onos-ssh' |
sshnet | 'onos-ssh $OCN' |
...
Previous : Further Resources
Next : Appendix B : REST API
...