Welcome to the ONOS Documentation Library! This page links to the most up-to date documentation for ONOS.
The ONOS Guides provide comprehensive information, and are divided into several categories. It is highly recommended that you work through the Tutorials before taking a look at the ONOS guides to get the most out of the information here.
Additionally, we provide Javadocs for the ONOS APIs of the latest stable release, and a list of FAQs.
There are a few conventions that we use throughout these docs.
Unix shell commands begin with '$' or for superuser, '#' :
$ sudo -s # id uid=0(root) gid=0(root) groups=0(root) |
ONOS CLI commands begin with 'onos>' :
onos> summary |
monospace
font, e.g. ls
or topology.
Further conventions, if any, are described where relevant.