Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
| HTML |
|---|
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 |
...
<a href="http://karaf.apache.org/manual/latest/commands/commands.html">karaf commands documentation</a> for further information. |
| Table of Contents | ||||
|---|---|---|---|---|
|
add-flows
DESCRIPTION
onos:add-flows
Installs a flow rules Installs a number of test flow rules - for testing only
SYNTAX
onos:add-flows [options] flowPerDevice numOfRuns
ARGUMENTS
flowPerDevice
Number of flows to add per device
numOfRuns
Number of iterations
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
DESCRIPTION
onos:add-host-intent
Installs host-to-host connectivity intent
SYNTAX
onos:add-host-intent [options] one two
ARGUMENTS
one
One host ID
two
Another host ID
OPTIONS
-j, --json
Output JSON
-b, --bandwidth
Bandwidth
(defaults to )ipDst
Destination IP Prefix
-tk, --ethTypekey
Ethernet Type Intent Key
(defaults to )
-b, --bandwidth
Bandwidth
-t, --ethType
Ethernet Type
-d, --ethDst
Destination MAC Address
--setEthSrc
Rewrite Source MAC Address
-s, --ethSrc
Source MAC Address
--setEthDst
Rewrite Destination MAC Address
--tcpSrc
Source TCP Port
-l, --lambda
Lambda
--ipProto
IP Protocol
--ipSrc
Source IP Addressp, --priority
Priority
(defaults to 100)
--tcpDst
Destination TCP Port
--ipDstipSrc
Destination IP Address Source IP Prefix
--help
Display this help message
add-
...
mpls-intent
DESCRIPTION
onos:add-multi-to-singlempls-intent
Installs point-to-point connectivity intent
Installs mpls connectivity intent
SYNTAX
onos:add-multi-tompls-single-intent [options] ingressDevices ingressDevice egressDevice
ARGUMENTS
ingressDevices ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
OPTIONS
-j, --json
Output JSON
--ipDst
Destination IP Prefix
-k, --key
Intent Key
-b, --bandwidth
Bandwidth
(defaults to )
-t, --ethType
Ethernet Type
(defaults to )
-d, --ethDst
Destination MAC Address
--setEthSrc
Rewrite Source MAC Address
-s, --ethSrc
Source MAC Address
--setEthDst
Rewrite Destination MAC Address
--tcpSrc
Source TCP Port
-l, --lambda
Lambda
--ipProtoingressLabel
IP Protocol
--ipSrc
Source IP Address Ingress Mpls label
(defaults to )
--egressLabel
Egress Mpls label
(defaults to )
--ipProto
IP Protocol
-p, --priority
Priority
(defaults to 100)
--tcpDst
Destination TCP Port
--ipDstipSrc
Destination IP Address Source IP Prefix
--help
Display this help message
add-multi-to-
...
single-intent
DESCRIPTION
onos:add-multi-to-opticalsingle-intent
Installs optical connectivity intent Installs point-to-point connectivity intent
SYNTAX
onos:add-multi-to-opticalsingle-intent [options] ingressDevice egressDevice ingressDevices egressDevice
ARGUMENTS
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description ingressDevices egressDevice
ingressDevice/Port..ingressDevice/Port egressDevice/Port
OPTIONS
-j, --json
Output JSON
--ipDst
Destination IP Prefix
-k, --key
Intent Key
-b, --bandwidth
Bandwidth
(defaults to )
-t, --ethType
Ethernet Type
(defaults to )
-d, --ethDst
Destination MAC Address
--setEthSrc
Rewrite Source MAC Address
-s, --ethSrc
Source MAC Address
--setEthDst
Rewrite Destination MAC Address
--tcpSrc
Source TCP Port
-l, --lambda
Lambda
--ipProto
IP Protocol
--ipSrc
Source IP Addressp, --priority
Priority
(defaults to 100)
--tcpDst
Destination TCP Port
--ipDstipSrc
Destination IP Address Source IP Prefix
--help
Display this help message
add-
...
optical-intent
DESCRIPTION
onos:add-pointoptical-intent
Installs point-to-point connectivity intent Installs optical connectivity intent
SYNTAX
onos:add-pointoptical-intent [options] ingressDevice egressDevice
ARGUMENTS
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
OPTIONS
-j, --json
Output JSON
--ipDst
Destination IP Prefix
-bk, --bandwidth
Bandwidth
(defaults to )key
Intent Key
-tb, --ethType
Ethernet Type
(defaults to )
bandwidth
Bandwidth
-t, --ethType
Ethernet Type
-d, --ethDst
Destination MAC Address
--setEthSrc
Rewrite Source MAC Address
-s, --ethSrc
Source MAC Address
--setEthDst
Rewrite Destination MAC Address
--tcpSrc
Source TCP Port
-l, --lambda
Lambda
--ipProto
IP Protocol
--ipSrc
Source IP Addressp, --priority
Priority
(defaults to 100)
--tcpDst
Destination TCP Port
--ipDstipSrc
Destination IP Address Source IP Prefix
--help
Display this help message
add-
...
point-intent
DESCRIPTION
onos:add-singlepoint-intent
Installs point-to-multi-intent
Installs connectivity intent between multiple egress devices and a single ingress devicepoint connectivity intent
SYNTAX
onos:add-single-to-multi-intent [point-intent [options] egressDevices ingressDevice ingressDevice egressDevice
ARGUMENTS
egressDevices ingressDevice ingressDevice
egress Device/Port...egress Device/Port ingressDevice/port Ingress Device/Port Description
egressDevice
Egress Device/Port Description
OPTIONS
-j, --json
Output JSON
--ipDst
Destination IP Prefix
-k, --key
Intent Key
-b, --bandwidth
Bandwidth
(defaults to )
-t, --ethType
Ethernet Type
(defaults to )
-d, --ethDst
Destination MAC Address
--setEthSrc
Rewrite Source MAC Address
-s, --ethSrc
Source MAC Address
--setEthDst
Rewrite Destination MAC Address
--tcpSrc
Source TCP Port
-l, --lambda
Lambda
--ipProto
IP Protocol
--ipSrc
Source IP Addressp, --priority
Priority
(defaults to 100)
--tcpDst
Destination TCP Port
--ipDstipSrc
Destination IP Address Source IP Prefix
--help
Display this help message
...
add-single-to-multi-intent
DESCRIPTION
onos:address-bindings
Lists all configured address port bindings.add-single-to-multi-intent
Installs connectivity intent between a single ingress device and multiple egress devices
SYNTAX
onos:address-bindings add-single-to-multi-intent [options] ingressDevice egressDevices
ARGUMENTS
ingressDevice egressDevices
ingressDevice/Port egressDevice/Port...egressDevice/Port
OPTIONS
-j, --json
Output JSON
--ipDst
Destination IP Prefix
-k, --key
Intent Key
-b, --bandwidth
Bandwidth
-t, --ethType
Ethernet Type
-d, --ethDst
Destination MAC Address
--setEthSrc
Rewrite Source MAC Address
-s, --ethSrc
Source MAC Address
--setEthDst
Rewrite Destination MAC Address
--tcpSrc
Source TCP Port
-l, --lambda
Lambda
--ipProto
IP Protocol
-p, --priority
Priority
(defaults to 100)
--tcpDst
Destination TCP Port
--ipSrc
Source IP Prefix
--help
Display this help message
address-bindings
DESCRIPTION
onos:address-bindings
Lists all configured address port bindings.
SYNTAX
onos:address-bindings [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
app
DESCRIPTION
onos:app
Manages application inventory
SYNTAX
onos:app [options] command name
ARGUMENTS
command
Command name (activate|deactivate|uninstall)
name
Application name
OPTIONS
-j, --json
Output JSON
--help
Display this help message
app-ids
DESCRIPTION
onos:app-ids
Lists application ID information
SYNTAX
onos:app-ids [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
apps
DESCRIPTION
onos:apps
Lists application information
SYNTAX
onos:apps [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
balance-masters
DESCRIPTION
onos:balance-masters
Forces device mastership rebalancing
SYNTAX
onos:balance-masters [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
cfg
DESCRIPTION
onos:cfg
Manages component configuration
SYNTAX
onos:cfg [options] [command] [component] [name] [value]
ARGUMENTS
command
Command name (activate|deactivate|uninstall)
component
Component name
name
Property name
value
Property value
OPTIONS
-j, --json
Output JSON
--help
Display this help message
cluster-devices
DESCRIPTION
onos:cluster-devices
Lists devices of the specified topology cluster in the current topology
SYNTAX
onos:cluster-devices [options] id
ARGUMENTS
id
Cluster ID
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
cluster-links
DESCRIPTION
onos:cluster-links
Lists links of the specified topology cluster in the current topology
SYNTAX
onos:cluster-links [options] id
ARGUMENTS
id
Cluster ID
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
clusters
DESCRIPTION
onos:clusters
Lists all clusters in the current topology
SYNTAX
onos:clusters [options]
OPTIONS
-r, --recompute
Trigger topology re-computation
-OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
cycle-intents
DESCRIPTION
onos:appscycle-intents
Lists application ID information Installs random intents to test throughput
SYNTAX
onos:apps cycle-intents [options] ingressDevice egressDevice numberOfIntents [keyOffset]
OPTIONSARGUMENTS
-j, --json
Output JSON
--help
Display this help message
balance-masters
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
numberOfIntents
Number of intents to install/withdraw
keyOffset
Starting point for first key (default: 1) DESCRIPTION
onos:balance-masters
Forces device mastership rebalancing
SYNTAX
onos:balance-masters [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
device-
...
remove
DESCRIPTION
onos:clusterdevice-devicesremove
Lists devices of the specified topology cluster in the current topology Removes an infrastructure device
SYNTAX
onos:clusterdevice-devices remove [options] [id] uri
ARGUMENTS
id uri
Cluster ID Device ID
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
...
device-
...
role
DESCRIPTION
onos:clusterdevice-linksrole
Lists links of the specified topology cluster in the current topology Sets role of the controller node for the given infrastructure device
SYNTAX
onos:clusterdevice-links role [options] id uri node role
ARGUMENTS
id uri
Cluster ID Device ID
OPTIONS
-r, --recompute
Trigger topology re-computation node
Node ID
role
Mastership role
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
devices
DESCRIPTION
onos:clustersdevices
Lists all clusters in the current topology Lists all infrastructure devices
SYNTAX
onos:clusters [options]
OPTIONS
-r, --recompute
Trigger topology re-computationdevices [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
flows
DESCRIPTION
onos:device-remove
Removes an infrastructure deviceflows
Lists all currently-known flows.
SYNTAX
onos:device-remove flows [options] uri [state] [uri]
ARGUMENTS
state
Flow Rule state
uri
Device ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
get-
...
stats
DESCRIPTION
onos:deviceget-rolestats
Sets role of the controller node for the given infrastructure device Fetches stats for a connection point
SYNTAX
onos:deviceget-role stats [options] uri node role connectPoint
ARGUMENTS
uri connectPoint
Device ID Device/Port Description
node
Node ID
role
Mastership role
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
groups
DESCRIPTION
onos:devicesgroups
Lists all infrastructure devices Lists all groups in the system
SYNTAX
onos:devices groups [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
host-remove
DESCRIPTION
onos:flowshost-remove
Lists all currently Removes an end-known flows.station host
SYNTAX
onos:flows host-remove [options] [state] [uri] id
ARGUMENTS
state
Flow Rule state
uri id
Device ID Host ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
hosts
DESCRIPTION
onos:get-stats
Fetches stats for a connection point
hosts
Lists all currently-known hosts.
SYNTAX
onos:get-stats hosts [options] connectPoint
ARGUMENTS
connectPoint
Device/Port Description
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
intents
DESCRIPTION
onos:host-remove
Removes an end-station hostintents
Lists the inventory of intents and their states
SYNTAX
onos:host-remove intents [options] id
ARGUMENTS
id
Host ID
OPTIONS
OPTIONS
-i, --installable
Output Installable Intents
-j, --json
Output JSON
-s, --summary
Intents summary
--help
Display this help message
...
-p, --pending
Show inforamtion about pending intents
leaders
DESCRIPTION
onos:hostsleaders
Lists all currently-known hosts Finds the leader for particular topic.
SYNTAX
onos:hosts leaders [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
links
DESCRIPTION
onos:intentslinks
Lists the inventory of intents and their states Lists all infrastructure links
SYNTAX
onos:intents links [options] [uri]
OPTIONSARGUMENTS
-i, --installable
Output Installable Intents uri
Device ID
OPTIONS
-j, --json
Output JSON
-s, --summary
Intents summary
--help
Display this help message
...
masters
DESCRIPTION
onos:leadersmasters
Finds the leader for particular topic. Lists device mastership information
SYNTAX
onos:leaders masters [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
metrics
DESCRIPTION
onos:linksmetrics
Lists all infrastructure links Prints metrics in the system
SYNTAX
onos:links [options] [uri]
ARGUMENTS
uri
Device IDmetrics [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
nodes
DESCRIPTION
onos:mastersnodes
Lists device mastership information Lists all controller cluster nodes
SYNTAX
onos:masters nodes [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
partitions
DESCRIPTION
onos:metricspartitions
Prints metrics in the system Lists information about partitions in the system
SYNTAX
onos:metrics partitions [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
paths
DESCRIPTION
onos:nodespaths
Lists all controller cluster nodes Lists all shortest-paths paths between the specified source and destination devices
SYNTAX
onos:nodes [options]
OPTIONSpaths [options] src dst
ARGUMENTS
src
Source device ID
dst
Destination device ID
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
...
ports
DESCRIPTION
onos:pathsports
Lists all shortest-paths paths between the specified source and destination devices Lists all ports or all ports of a device
SYNTAX
onos:paths ports [options] [uri] src dst
ARGUMENTS
src uri
Source device ID Device ID
dst
Destination device ID
OPTIONSOPTIONS
-j, --json
Output JSON
-rd, --recomputedisabled
Trigger topology re-computation Show only disabled ports
-je, --jsonenabled
Output JSON Show only enabled ports
--help
Display this help message
...
push-random-intents
DESCRIPTION
onos:ports
Lists all ports or all ports of a devicepush-random-intents
Installs random intents to test throughput
SYNTAX
onos:ports push-random-intents [options] [uri] count
ARGUMENTS
uri count
Device ID Number of intents to push
OPTIONS
-j, --json
Output JSON
-d, --disabled
Show only disabled ports
-e, --enabled
Show only enabled ports
Output JSON
--help
Display this help message
push-
...
test-intents
DESCRIPTION
onos:push-randomtest-intents
Installs random intents to test throughput
SYNTAX
onos:push-randomtest-intents [options] count ingressDevice egressDevice numberOfIntents [keyOffset]
ARGUMENTS
count
Number of intents to push
OPTIONS ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
numberOfIntents
Number of intents to install/withdraw
keyOffset
Starting point for first key (default: 1)
OPTIONS
-i, --install
Install intents
-j, --json
Output JSON
-w, --withdraw
Withdraw intents
--help
Display this help message
...
remove-
...
intent
DESCRIPTION
onos:pushremove-test-intentsintent
Installs random intents to test throughput Removes the specified intent
SYNTAX
onos:pushremove-test-intents [options] ingressDevice egressDevice Intents per appId [apps] [appIdBase]
ARGUMENTS
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
Intents per appId
Number of intents per appId
apps
Number of appIds
appIdBase
Base Value for Application IDsintent [options] app id
ARGUMENTS
app
Application ID
id
Intent ID
OPTIONS
-ip, --installpurge
Install intents Purge the intent from the store after removal
-j, --json
Output JSON
-ws, --withdrawsync
Withdraw intents Waits for the removal before returning
--help
Display this help message
...
resource-
...
allocations
DESCRIPTION
onos:removeresource-intentallocations
Removes the specified intent Lists allocations by link
SYNTAX
onos:removeresource-intent allocations [options] id ] [srcString] [dstString]
ARGUMENTS
srcString
Link source
id dstString
Intent ID Link destination
OPTIONS
-j, --json
Output JSON
--help
Display this help message
resource-
...
available
DESCRIPTION
onos:resource-allocationsavailable
Lists allocations by link Lists available resources by link
SYNTAX
onos:resource-allocations available [options] [srcString] [dstString]
ARGUMENTS
srcString
Link source
dstString
Link destination
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
roles
DESCRIPTION
onos:roles
Lists mastership roles of nodes for each device.
SYNTAX
onos:roles [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
summary
DESCRIPTION
onos:resource-availablesummary
Lists available resources by link Provides summary of ONOS model
SYNTAX
onos:resource-available summary [options] [srcString] [dstString]
ARGUMENTS
srcString
Link source
dstString
Link destination
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
topology
DESCRIPTION
onos:rolestopology
Lists mastership roles of nodes for each device. Lists summary of the current topology
SYNTAX
onos:roles topology [options]
OPTIONS
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
...
wipe-out
DESCRIPTION
onos:summary
Provides summary of ONOS modelwipe-out
Wipes-out the entire network information base, i.e. devices, links, hosts
SYNTAX
onos:summary wipe-out [options] [please]
ARGUMENTS
please
Confirmation phrase
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
...