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 2 Next »

The following are the list of ONOS CLI commands. As the ONOS CLI builds upon Karaf's CLI, this list is not comprehensive to the full set of commands available in the CLI. Please refer to the karaf commands documentation for further information.


help onos

Shows summary of all commands and their descriptions.

help <command>

Provides detailed help on a command.

summary [-j|--json]

Provides summary about ONOS and the state of the network model.


nodes [-j|--json]

Lists cluster nodes, their state and address information.


Lists each node with the devices that it is master for.

Basic Network Elements

devices [-j|--json]

Lists all network infrastructure devices and their attributes.

device-remove <device-id>

Administratively removes a network infrastructure device. This is primarily intended to remove devices that are off-line or are being decommissioned. Removing a device that is presently on-line and still connected to the controller may result in the device being re-discovered by the controller.

device-role <device-id> <node-id> {master|standby|none}

Administratively forces a mastership role change for a given device.

ports [-j|--json] [<device-id>]

Lists all ports, or all ports of the specified infrastructure device.

links [-j|--json] [<device-id>]

Lists all infrastructure links and their types. If a device ID is specified, it lists only those links leading directly to/from that device.

hosts [-j|--json] [<device-id>]

Lists all end-station hosts. If a device ID is specified, it lists only those hosts that are connected to the edge ports of that device - directly or indirectly.


Lists all devices with their current master and standby nodes, the latter in preference order for failover.

Topology & Paths

topology [-j|--json]

Lists the overview of the the current topology.

clusters [-j|--json]

Lists all SCC (strongly connected component) clusters of the current topology.

cluster [-j|--json] <cluster-id>

Lists the summary of the specified topology cluster.

cluster-devices [-j|--json] <cluster-id>

Lists the infrastructure devices of the specified topology cluster.

cluster-links [-j|--json] <cluster-id>

Lists the infrastructure links of the specified topology cluster.

paths [-j|--json] <src-element-id> <dst-element-id>

Lists all the shortest paths between the specified network elements; end-station hosts or infrastructure devices.

Flow Rules

flows [-j|--json] [<device-id>]

Lists all flow rules or only those deployed on the specified infrastructure device.

remove-flow [<flow-id>]

Removes the specified flow rule by its ID.


intents [-j|--json]

Lists all top-level intents and their state.

remove-intent <intent-id>

Removes the specified top-level intent by its ID.

add-host-intent <host-id> <host-id>

Adds a host-to-host bidirectional connectivity intent.


wipe-out please

Removes all infrastructure devices, links, end-station hosts and intents.


Halts ONOS. When running under Linux upstart, this will merely restart the ONOS instance.

Features & Bundles


Lists all currently available features; the ones currently installed are marked.

feature:install <feature>

Installs the specified feature.

feature:uninstall <feature>

Uninstall the specified feature.


Lists all ‘user-space’ bundles; those with run-level higher than 50.

bundle:update -f <bundle>

Updates the specified bundle to reload it from disk.


  • No labels