...
The ONOS CLI is an extension of Karaf's CLI. As a result, it is capable of leveraging features such as programmatic extensibility, the ability to load and unload bundles (among others), and SSH access.
Accessing the CLI
For local installations of ONOS, the ONOS CLI can be accessed with the command karaf clean
. For remote installations, e.g. ONOS instances deployed with onos-package
and onos-install
, the onos
command can be used to attach to running instance from the shell of the target machine.
CLI
To access the CLI directly from a target machine, refer to these instructions.
If you're deploying ONOS from a management machineFinally, as describe in Installing and Running ONOS, the onos
command can be used to attach to a remote ONOS instance directly from the local machine (i.e. without logging in first). For example, to access the CLI of an ONOS instance running on a target machine at 192.168.56.30:
Code Block | ||
---|---|---|
| ||
$ onos 192.168.56.30 |
Both Ctrl-D and logout
exits the CLI.
...
ONOS
...
ONOS Commands
ONOS supplies a set of its own commands.help onos
lists the available commands:
...
Code Block | ||
---|---|---|
| ||
onos> list START LEVEL 100 , List Threshold: 50 ID | State | Lvl | Version | Name ------------------------------------------------------------------------------ 37 | Active | 80 | 0.0.0 | samples 41 | Active | 80 | 2.6 | Commons Lang 42 | Active | 80 | 3.3.2 | Apache Commons Lang ... 156 | Active | 80 | 1.1.0.SNAPSHOT | onos-core-common 157 | Active | 80 | 1.1.0.SNAPSHOT | onos-core-dist 158 | Active | 80 | 1.1.0.SNAPSHOT | onos-core-serializers 159 | Active | 80 | 1.1.0.SNAPSHOT | onlab-netty 168 | Active | 80 | 1.1.0.SNAPSHOT | onos-app-proxyarp onos> |
Modules can also be loaded/unloaded from the CLI. For example, to unload the proxy ARP application above:
Code Block | ||
---|---|---|
| ||
onos> feature:uninstall onos-app-proxyarp |
And to load it in:
Code Block | ||
---|---|---|
| ||
onos> feature:install onos-app-proxyarp |
Info |
---|
Appendix C provides a listing of the available ONOS bundles for the stable release. |
...