Have questions? Stuck? Please check our FAQ for some common questions and answers.

This wiki documents the current development version of ONOS (master). Refer to the Wiki Archives for documentation for all previous versions of ONOS.

Skip to end of metadata
Go to start of metadata

This section describes ONOS's Karaf-based CLI.


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

To access the CLI directly from a target machine, refer to these instructions.

If you're deploying ONOS from a management machine, the onos command can be used to attach to a remote ONOS instance (i.e. without logging in first). For example, to access the CLI of an ONOS running on a target machine at


Both Ctrl-D and logout exits the CLI.

ONOS Commands

ONOS supplies a set of its own commands.help onos lists the available commands: 

The commands can be invoked as either onos:<command> or <command> by itself. Some of these commands have further descriptions that can be seen with help onos:<command>.


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:


Appendix C provides a listing of the available ONOS bundles for the stable release. 


Previous : Interacting with ONOS
Next : The ONOS Web GUI


  • No labels