This section introduces the primary user interfaces offered by ONOS.
Overview
There are several ways that an operator can interact with ONOS:
- CLI : Akin to a UNIX shell, this is the primary administrative interface to a running ONOS instance.
- GUI : A visualization of ONOS's network view.
- REST API : A RESTful interface to the administrative interface used by the CLI.
CLI
The ONOS CLI is an extension of Karaf's CLI. As a result, it is capable of leveraging features such as the ability to load and unload ONOS modules (among others), and SSH access.
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.