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 | ||||
|---|---|---|---|---|
|
...
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-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-
...
mpls-intent
DESCRIPTION
onos:add-multimpls-to-single-intent
Installs point-to-point connectivity intent Installs mpls connectivity intent
SYNTAX
onos:add-multimpls-to-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
-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-
...
point-
...
intent
DESCRIPTION
onos:add-singlepoint-intent
Installs point-to-multi-intentpoint connectivity intent
Installs connectivity intent between multiple egress devices and a single ingress device
SYNTAX
onos:add-singlepoint-to-multi-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
--helpipDst
Display this help message
apps
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 DESCRIPTION
onos:apps
Lists application ID information
SYNTAX
onos:apps [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
cluster-
...
devices
DESCRIPTION
onos:balancecluster-mastersdevices
Forces device mastership rebalancing Lists devices of the specified topology cluster in the current topology
SYNTAX
onos:balancecluster-masters 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-deviceslinks
Lists devices of the specified topology cluster in the current topology Lists links of the specified topology cluster in the current topology
SYNTAX
onos:cluster-devices links [options] [id] id
ARGUMENTS
id
Cluster ID
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
...
clusters
DESCRIPTION
onos:cluster-linksclusters
Lists links of the specified topology cluster in the current topology Lists all clusters in the current topology
SYNTAX
onos:cluster-links [options] id
ARGUMENTS
id
Cluster IDclusters [options]
OPTIONS
-r, --recompute
Trigger topology re-computation
-j, --json
Output JSON
--help
Display this help message
...
cycle-intents
DESCRIPTION
onos:clusterscycle-intents
Lists all clusters in the current topology Installs random intents to test throughput
SYNTAX
onos:clusters [options]
OPTIONS
-r, --recompute
Trigger topology re-computationcycle-intents [options] ingressDevice egressDevice numberOfIntents [keyOffset]
ARGUMENTS
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
-j, --json
Output JSON
--help
Display this help message
...
DESCRIPTION
onos:get-stats
Fetches stats for a connection point
SYNTAX
onos:get-stats [options] connectPoint
ARGUMENTS
connectPoint
Device/Port Description
Device/Port Description
OPTIONS
-j, --json
Output JSON
--help
Display this help message
groups
DESCRIPTION
onos:groups
Lists all groups in the system
SYNTAX
onos:groups [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
DESCRIPTION
onos:intents
Lists the inventory of intents and their states
SYNTAX
onos:intents [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:leaders
Finds the leader for particular topic.
SYNTAX
onos:leaders [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
DESCRIPTION
onos:links
Lists all infrastructure links
SYNTAX
onos:links [options] [uri]
ARGUMENTS
uri
Device ID
Device ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
masters
DESCRIPTION
onos:masters
Lists device mastership information
SYNTAX
onos:masters [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
metrics
DESCRIPTION
onos:mastersmetrics
Lists device mastership information Prints metrics in the system
SYNTAX
onos:masters metrics [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
nodes
DESCRIPTION
onos:metricsnodes
Prints metrics in the system Lists all controller cluster nodes
SYNTAX
onos:metrics nodes [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
partitions
DESCRIPTION
onos:nodespartitions
Lists all controller cluster nodes Lists information about partitions in the system
SYNTAX
onos:nodes partitions [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
DESCRIPTION
onos:push-test-intents
Installs random intents to test throughput
SYNTAX
onos:push-test-intents [options] ingressDevice egressDevice Intents per appId ingressDevice egressDevice numberOfIntents [appskeyOffset] [appIdBase]
ARGUMENTS
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
Intents per appId numberOfIntents
Number of intents per appId Number of intents to install/withdraw
apps
Number of appIds
appIdBase
Base Value for Application IDs 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
Withdraw intents DESCRIPTION
onos:remove-intent
Removes the specified intent
SYNTAX
onos:remove-intent [options] id
ARGUMENTS
id
Intent ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
remove-
...
intent
DESCRIPTION
onos:resourceremove-allocationsintent
Lists allocations by link Removes the specified intent
SYNTAX
onos:resourceremove-allocations intent [options] [srcString] [dstString] app id
ARGUMENTS
srcString app
Link source Application ID
dstString id
Link destination Intent ID
OPTIONS
-p, --purge
Purge the intent from the store after removal
-j, --json
Output JSON
-s, --jsonsync
Output JSON Waits for the removal before returning
--help
Display this help message
resource-
...
allocations
DESCRIPTION
onos:resource-availableallocations
Lists available resources by link Lists allocations by link
SYNTAX
onos:resource-available allocations [options] [srcString] [dstString]
ARGUMENTS
srcString
Link source
dstString
Link destination
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
resource-available
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
resource-available
Lists available resources by link DESCRIPTION
onos:summary
Provides summary of ONOS model
SYNTAX
onos:summary resource-available [options] [srcString] [dstString]
ARGUMENTS
srcString
Link source
dstString
Link destination
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
roles
DESCRIPTION
onos:tablet-leaderroles
Prints the current leader of a tablet Lists mastership roles of nodes for each device.
SYNTAX
onos:tablet-leader roles [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
summary
DESCRIPTION
onos:tablet-membersummary
Lists all member nodes Provides summary of ONOS model
SYNTAX
onos:tablet-member summary [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...