This section describes ONOS's Karaf-based CLI.
Overview
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 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 remote running instance. For example, to access the CLI of an ONOS instance running at 192.168.56.30:
$ 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:
onos> help onos COMMANDS 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 DESCRIPTION onos:add-flows Installs a flow rules SYNTAX onos:add-flows [options] flowPerDevice numOfRuns ARGUMENTS flowPerDevice Number of flows to add per device numOfRuns Number of iterations OPTIONS --help 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