Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
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 CLICLI
To access the CLI directly from a target machine, refer to these instructions.
If you're deploying ONOS from a management machineFor local installations of ONOS, the ONOS CLI can be accessed with 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 the a remote running ONOS instance (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.Note, in the case that karaf clean was used to start the CLI, exiting the CLI will cause the ONOS instance to terminate.
ONOS Commands
ONOS supplies a set of its own commands. help onos lists the available commands:
...
| Info |
|---|
Appendix A provides a listing of the currently available CLI commands. |
Bundle Management
Karaf's CLI commands are useful for managing the bundles (modules) that comprise the running ONOS instance. For example, list can be used to show all loaded modules:
| 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> |
| Info |
|---|
Appendix C provides a listing of the available ONOS bundles for the stable release. |
...
Previous : Interacting with ONOS
Next : The ONOS Web GUI
...