Page tree

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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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

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.

Finally, 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 at

$ onos

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: 

onos> help onos
onos:add-flows                  Installs a flow rules                                                                                                                                                                                           
onos:add-host-intent            Installs host-to-host connectivity intent                                                                                                                                                                       
onos:add-multi-to-single-intent Installs point-to-point connectivity intent                                                                                                                                                                     
onos:add-node                   Adds a new controller cluster node
onos:add-optical-intent         Installs optical connectivity intent 

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>.

onos> help onos:add-flows

	    Installs a flow rules

        onos:add-flows [options] flowPerDevice numOfRuns 

                Number of flows to add per device
                Number of iterations
                Display this help message
        -j, --json
                Output JSON

Appendix A provides a listing of the currently available CLI commands. 


Previous : Interacting with ONOS
Next : The ONOS Web GUI


  • No labels