...
Table of Contents | ||
---|---|---|
|
Help
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.
Cluster
nodes [-j|--json]
Lists cluster nodes, their state and address information.
masters
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.
roles
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
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.
Reset
wipe-out please
Removes all infrastructure devices, links, end-station hosts and intents.
halt
Halts ONOS. When running under Linux upstart, this will merely restart the ONOS instance.
Features & Bundles
feature:list
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.
bundle:list
Lists all ‘user-space’ bundles; those with run-level higher than 50.
bundle:update -f <bundle>
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
-j, --json
Output JSON
--help
Display this help message
add-host-intent
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 )
-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 Address
--tcpDst
Destination TCP Port
--ipDst
Destination IP Address
--help
Display this help message
add-multi-to-single-intent
DESCRIPTION
onos:add-multi-to-single-intent
Installs point-to-point connectivity intent
SYNTAX
onos:add-multi-to-single-intent [options] ingressDevices
ARGUMENTS
ingressDevices
Ingress Device/Port Description
OPTIONS
-j, --json
Output JSON
-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 Address
--tcpDst
Destination TCP Port
--ipDst
Destination IP Address
--help
Display this help message
add-optical-intent
DESCRIPTION
onos:add-optical-intent
Installs optical connectivity intent
SYNTAX
onos:add-optical-intent [options] ingressDevice egressDevice
ARGUMENTS
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
OPTIONS
-j, --json
Output JSON
-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 Address
--tcpDst
Destination TCP Port
--ipDst
Destination IP Address
--help
Display this help message
add-point-intent
DESCRIPTION
onos:add-point-intent
Installs point-to-point connectivity intent
SYNTAX
onos:add-point-intent [options] ingressDevice egressDevice
ARGUMENTS
ingressDevice
Ingress Device/Port Description
egressDevice
Egress Device/Port Description
OPTIONS
-j, --json
Output JSON
-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 Address
--tcpDst
Destination TCP Port
--ipDst
Destination IP Address
--help
Display this help message
add-single-to-multi-intent
DESCRIPTION
onos:add-single-to-multi-intent
Installs connectivity intent between multiple egress devices and a single ingress device
SYNTAX
onos:add-single-to-multi-intent [options] egressDevices ingressDevice
ARGUMENTS
egressDevices ingressDevice
egress Device/Port...egress Device/Port ingressDevice/port
OPTIONS
-j, --json
Output JSON
-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 Address
--tcpDst
Destination TCP Port
--ipDst
Destination IP Address
--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
apps
DESCRIPTION
onos:apps
Lists application ID 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
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
-j, --json
Output JSON
--help
Display this help message
device-remove
DESCRIPTION
onos:device-remove
Removes an infrastructure device
SYNTAX
onos:device-remove [options] uri
ARGUMENTS
uri
Device ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
device-role
DESCRIPTION
onos:device-role
Sets role of the controller node for the given infrastructure device
SYNTAX
onos:device-role [options] uri node role
ARGUMENTS
uri
Device ID
node
Node ID
role
Mastership role
OPTIONS
-j, --json
Output JSON
--help
Display this help message
devices
DESCRIPTION
onos:devices
Lists all infrastructure devices
SYNTAX
onos:devices [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
flows
DESCRIPTION
onos:flows
Lists all currently-known flows.
SYNTAX
onos:flows [options] [state] [uri]
ARGUMENTS
state
Flow Rule state
uri
Device ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
get-stats
DESCRIPTION
onos:get-stats
Fetches stats for a connection point
SYNTAX
onos:get-stats [options] connectPoint
ARGUMENTS
connectPoint
Device/Port Description
OPTIONS
-j, --json
Output JSON
--help
Display this help message
host-remove
DESCRIPTION
onos:host-remove
Removes an end-station host
SYNTAX
onos:host-remove [options] id
ARGUMENTS
id
Host ID
OPTIONS
-j, --json
Output JSON
--help
Display this help message
hosts
DESCRIPTION
onos:hosts
Lists all currently-known hosts.
SYNTAX
onos:hosts [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
intents
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
leaders
DESCRIPTION
onos:leaders
Finds the leader for particular topic.
SYNTAX
onos:leaders [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
links
DESCRIPTION
onos:links
Lists all infrastructure links
SYNTAX
onos:links [options] [uri]
ARGUMENTS
uri
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:metrics
Prints metrics in the system
SYNTAX
onos:metrics [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
nodes
DESCRIPTION
onos:nodes
Lists all controller cluster nodes
SYNTAX
onos:nodes [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
paths
DESCRIPTION
onos:paths
Lists all shortest-paths paths between the specified source and destination devices
SYNTAX
onos:paths [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:ports
Lists all ports or all ports of a device
SYNTAX
onos:ports [options] [uri]
ARGUMENTS
uri
Device ID
OPTIONS
-j, --json
Output JSON
-d, --disabled
Show only disabled ports
-e, --enabled
Show only enabled ports
--help
Display this help message
push-random-intents
DESCRIPTION
onos:push-random-intents
Installs random intents to test throughput
SYNTAX
onos:push-random-intents [options] count
ARGUMENTS
count
Number of intents to push
OPTIONS
-j, --json
Output JSON
--help
Display this help message
push-test-intents
DESCRIPTION
onos:push-test-intents
Installs random intents to test throughput
SYNTAX
onos:push-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 IDs
OPTIONS
-i, --install
Install intents
-j, --json
Output JSON
-w, --withdraw
Withdraw intents
--help
Display this help message
remove-intent
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
resource-allocations
DESCRIPTION
onos:resource-allocations
Lists allocations by link
SYNTAX
onos:resource-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:resource-available
Lists available resources by link
SYNTAX
onos: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: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:summary
Provides summary of ONOS model
SYNTAX
onos:summary [options]
OPTIONS
-j, --json
Output JSON
--help
Display this help message
...
...
...