Date: Fri, 29 Mar 2024 00:00:33 +0000 (UTC) Message-ID: <806005684.917.1711670433208@ip-10-30-146-46.us-west-2.compute.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_916_1154029740.1711670433206" ------=_Part_916_1154029740.1711670433206 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
DESCRIPTION
on=
os:add-flows
In=
stalls a number of test flow rules -&nbs=
p;for testing only
SYNTAX
on=
os:add-flows [options] flowPerDevice numOfRuns
ARGUMENTS
=
flowPerDevice
&n=
bsp; Number of flows&nbs=
p;to add per device
=
numOfRuns
&n=
bsp; Number of iteration=
s
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:add-host-intent
In=
stalls host-to-host connectivity intent
SYNTAX
on=
os:add-host-intent [options] one two
ARGUMENTS
=
one
&n=
bsp; One host ID
=
two
&n=
bsp; Another host ID
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--ipDst
&n=
bsp; Destination IP Pref=
ix
=
-k, --key
&n=
bsp; Intent Key
=
-b, --bandwidth
&n=
bsp; Bandwidth
=
-t, --ethType
&n=
bsp; Ethernet Type
=
-d, --ethDst
&n=
bsp; Destination MAC Add=
ress
=
--setEthSrc
&n=
bsp; Rewrite Source MAC&=
nbsp;Address
=
-s, --ethSrc
&n=
bsp; Source MAC Address<=
br>
=
--setEthDst
&n=
bsp; Rewrite Destination =
;MAC Address
=
--tcpSrc
&n=
bsp; Source TCP Port
=
-l, --lambda
&n=
bsp; Lambda
=
--ipProto
&n=
bsp; IP Protocol
=
-p, --priority
&n=
bsp; Priority
&n=
bsp; (defaults to 100)
=
--tcpDst
&n=
bsp; Destination TCP Por=
t
=
--ipSrc
&n=
bsp; Source IP Prefix
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:add-mpls-intent
In=
stalls mpls connectivity intent
SYNTAX
on=
os:add-mpls-intent [options] ingressDevice egressDevice =
;
ARGUMENTS
=
ingressDevice
&n=
bsp; Ingress Device/Port =
;Description
=
egressDevice
&n=
bsp; Egress Device/Port =
Description
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--ipDst
&n=
bsp; Destination IP Pref=
ix
=
-k, --key
&n=
bsp; Intent Key
=
-b, --bandwidth
&n=
bsp; Bandwidth
=
-t, --ethType
&n=
bsp; Ethernet Type
=
-d, --ethDst
&n=
bsp; Destination MAC Add=
ress
=
--setEthSrc
&n=
bsp; Rewrite Source MAC&=
nbsp;Address
=
-s, --ethSrc
&n=
bsp; Source MAC Address<=
br>
=
--setEthDst
&n=
bsp; Rewrite Destination =
;MAC Address
=
--tcpSrc
&n=
bsp; Source TCP Port
=
-l, --lambda
&n=
bsp; Lambda
=
--ingressLabel
&n=
bsp; Ingress Mpls label<=
br>
&n=
bsp; (defaults to )
=
--egressLabel
&n=
bsp; Egress Mpls label
&n=
bsp; (defaults to )
=
--ipProto
&n=
bsp; IP Protocol
=
-p, --priority
&n=
bsp; Priority
&n=
bsp; (defaults to 100)
=
--tcpDst
&n=
bsp; Destination TCP Por=
t
=
--ipSrc
&n=
bsp; Source IP Prefix
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:add-multi-to-single-intent
In=
stalls point-to-point connectivity intent
SYNTAX
on=
os:add-multi-to-single-intent [options] ingressDevices egres=
sDevice
ARGUMENTS
=
ingressDevices egressDevice
&n=
bsp; ingressDevice/Port..ingressDe=
vice/Port egressDevice/Port
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--ipDst
&n=
bsp; Destination IP Pref=
ix
=
-k, --key
&n=
bsp; Intent Key
=
-b, --bandwidth
&n=
bsp; Bandwidth
=
-t, --ethType
&n=
bsp; Ethernet Type
=
-d, --ethDst
&n=
bsp; Destination MAC Add=
ress
=
--setEthSrc
&n=
bsp; Rewrite Source MAC&=
nbsp;Address
=
-s, --ethSrc
&n=
bsp; Source MAC Address<=
br>
=
--setEthDst
&n=
bsp; Rewrite Destination =
;MAC Address
=
--tcpSrc
&n=
bsp; Source TCP Port
=
-l, --lambda
&n=
bsp; Lambda
=
--ipProto
&n=
bsp; IP Protocol
=
-p, --priority
&n=
bsp; Priority
&n=
bsp; (defaults to 100)
=
--tcpDst
&n=
bsp; Destination TCP Por=
t
=
--ipSrc
&n=
bsp; Source IP Prefix
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:add-optical-intent
In=
stalls optical connectivity intent
SYNTAX
on=
os:add-optical-intent [options] ingressDevice egressDevice&n=
bsp;
ARGUMENTS
=
ingressDevice
&n=
bsp; Ingress Device/Port =
;Description
=
egressDevice
&n=
bsp; Egress Device/Port =
Description
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--ipDst
&n=
bsp; Destination IP Pref=
ix
=
-k, --key
&n=
bsp; Intent Key
=
-b, --bandwidth
&n=
bsp; Bandwidth
=
-t, --ethType
&n=
bsp; Ethernet Type
=
-d, --ethDst
&n=
bsp; Destination MAC Add=
ress
=
--setEthSrc
&n=
bsp; Rewrite Source MAC&=
nbsp;Address
=
-s, --ethSrc
&n=
bsp; Source MAC Address<=
br>
=
--setEthDst
&n=
bsp; Rewrite Destination =
;MAC Address
=
--tcpSrc
&n=
bsp; Source TCP Port
=
-l, --lambda
&n=
bsp; Lambda
=
--ipProto
&n=
bsp; IP Protocol
=
-p, --priority
&n=
bsp; Priority
&n=
bsp; (defaults to 100)
=
--tcpDst
&n=
bsp; Destination TCP Por=
t
=
--ipSrc
&n=
bsp; Source IP Prefix
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:add-point-intent
In=
stalls point-to-point connectivity intent
SYNTAX
on=
os:add-point-intent [options] ingressDevice egressDevice&nbs=
p;
ARGUMENTS
=
ingressDevice
&n=
bsp; Ingress Device/Port =
;Description
=
egressDevice
&n=
bsp; Egress Device/Port =
Description
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--ipDst
&n=
bsp; Destination IP Pref=
ix
=
-k, --key
&n=
bsp; Intent Key
=
-b, --bandwidth
&n=
bsp; Bandwidth
=
-t, --ethType
&n=
bsp; Ethernet Type
=
-d, --ethDst
&n=
bsp; Destination MAC Add=
ress
=
--setEthSrc
&n=
bsp; Rewrite Source MAC&=
nbsp;Address
=
-s, --ethSrc
&n=
bsp; Source MAC Address<=
br>
=
--setEthDst
&n=
bsp; Rewrite Destination =
;MAC Address
=
--tcpSrc
&n=
bsp; Source TCP Port
=
-l, --lambda
&n=
bsp; Lambda
=
--ipProto
&n=
bsp; IP Protocol
=
-p, --priority
&n=
bsp; Priority
&n=
bsp; (defaults to 100)
=
--tcpDst
&n=
bsp; Destination TCP Por=
t
=
--ipSrc
&n=
bsp; Source IP Prefix
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:add-single-to-multi-intent
In=
stalls connectivity intent between a single i=
ngress device and multiple egress devices
SYNTAX
on=
os:add-single-to-multi-intent [options] ingressDevice egress=
Devices
ARGUMENTS
=
ingressDevice egressDevices
&n=
bsp; ingressDevice/Port egres=
sDevice/Port...egressDevice/Port
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--ipDst
&n=
bsp; Destination IP Pref=
ix
=
-k, --key
&n=
bsp; Intent Key
=
-b, --bandwidth
&n=
bsp; Bandwidth
=
-t, --ethType
&n=
bsp; Ethernet Type
=
-d, --ethDst
&n=
bsp; Destination MAC Add=
ress
=
--setEthSrc
&n=
bsp; Rewrite Source MAC&=
nbsp;Address
=
-s, --ethSrc
&n=
bsp; Source MAC Address<=
br>
=
--setEthDst
&n=
bsp; Rewrite Destination =
;MAC Address
=
--tcpSrc
&n=
bsp; Source TCP Port
=
-l, --lambda
&n=
bsp; Lambda
=
--ipProto
&n=
bsp; IP Protocol
=
-p, --priority
&n=
bsp; Priority
&n=
bsp; (defaults to 100)
=
--tcpDst
&n=
bsp; Destination TCP Por=
t
=
--ipSrc
&n=
bsp; Source IP Prefix
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:address-bindings
Li=
sts all configured address port bindings.
SYNTAX
on=
os:address-bindings [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:app
Ma=
nages application inventory
SYNTAX
on=
os:app [options] command name
ARGUMENTS
=
command
&n=
bsp; Command name (activ=
ate|deactivate|uninstall)
=
name
&n=
bsp; Application name
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:app-ids
Li=
sts application ID information
SYNTAX
on=
os:app-ids [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:apps
Li=
sts application information
SYNTAX
on=
os:apps [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:balance-masters
Fo=
rces device mastership rebalancing
SYNTAX
on=
os:balance-masters [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:cfg
Ma=
nages component configuration
SYNTAX
on=
os:cfg [options] [command] [component] [name] [val=
ue]
ARGUMENTS
=
command
&n=
bsp; Command name (activ=
ate|deactivate|uninstall)
=
component
&n=
bsp; Component name
=
name
&n=
bsp; Property name
=
value
&n=
bsp; Property value
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:cluster-devices
Li=
sts devices of the specified topology cluster=
in the current topology
SYNTAX
on=
os:cluster-devices [options] id
ARGUMENTS
=
id
&n=
bsp; Cluster ID
OPTIONS
=
-r, --recompute
&n=
bsp; Trigger topology re=
-computation
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:cluster-links
Li=
sts links of the specified topology cluster&n=
bsp;in the current topology
SYNTAX
on=
os:cluster-links [options] id
ARGUMENTS
=
id
&n=
bsp; Cluster ID
OPTIONS
=
-r, --recompute
&n=
bsp; Trigger topology re=
-computation
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:clusters
Li=
sts all clusters in the current topology
SYNTAX
on=
os:clusters [options]
OPTIONS
=
-r, --recompute
&n=
bsp; Trigger topology re=
-computation
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:cycle-intents
In=
stalls random intents to test throughput
SYNTAX
on=
os:cycle-intents [options] ingressDevice egressDevice n=
umberOfIntents [keyOffset]
ARGUMENTS
=
ingressDevice
&n=
bsp; Ingress Device/Port =
;Description
=
egressDevice
&n=
bsp; Egress Device/Port =
Description
=
numberOfIntents
&n=
bsp; Number of intents&n=
bsp;to install/withdraw
=
keyOffset
&n=
bsp; Starting point for&=
nbsp;first key (default: 1)
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:device-remove
Re=
moves an infrastructure device
SYNTAX
on=
os:device-remove [options] uri
ARGUMENTS
=
uri
&n=
bsp; Device ID
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:device-role
Se=
ts role of the controller node for the&n=
bsp;given infrastructure device
SYNTAX
on=
os:device-role [options] uri node role
ARGUMENTS
=
uri
&n=
bsp; Device ID
=
node
&n=
bsp; Node ID
=
role
&n=
bsp; Mastership role
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:devices
Li=
sts all infrastructure devices
SYNTAX
on=
os:devices [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:flows
Li=
sts all currently-known flows.
SYNTAX
on=
os:flows [options] [state] [uri]
ARGUMENTS
=
state
&n=
bsp; Flow Rule state
=
uri
&n=
bsp; Device ID
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:get-stats
Fe=
tches stats for a connection point
SYNTAX
on=
os:get-stats [options] connectPoint
ARGUMENTS
=
connectPoint
&n=
bsp; Device/Port Description<=
br>
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:groups
Li=
sts all groups in the system
SYNTAX
on=
os:groups [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:host-remove
Re=
moves an end-station host
SYNTAX
on=
os:host-remove [options] id
ARGUMENTS
=
id
&n=
bsp; Host ID
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:hosts
Li=
sts all currently-known hosts.
SYNTAX
on=
os:hosts [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:intents
Li=
sts the inventory of intents and their s=
tates
SYNTAX
on=
os:intents [options]
OPTIONS
=
-i, --installable
&n=
bsp; Output Installable =
Intents
=
-j, --json
&n=
bsp; Output JSON
=
-s, --summary
&n=
bsp; Intents summary
=
--help
&n=
bsp; Display this help&n=
bsp;message
=
-p, --pending
&n=
bsp; Show inforamtion ab=
out pending intents
DESCRIPTION
on=
os:leaders
Fi=
nds the leader for particular topic.
SYNTAX
on=
os:leaders [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:links
Li=
sts all infrastructure links
SYNTAX
on=
os:links [options] [uri]
ARGUMENTS
=
uri
&n=
bsp; Device ID
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:masters
Li=
sts device mastership information
SYNTAX
on=
os:masters [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:metrics
Pr=
ints metrics in the system
SYNTAX
on=
os:metrics [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:nodes
Li=
sts all controller cluster nodes
SYNTAX
on=
os:nodes [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:partitions
Li=
sts information about partitions in the syste=
m
SYNTAX
on=
os:partitions [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:paths
Li=
sts all shortest-paths paths between the spec=
ified source and destination devices
SYNTAX
on=
os:paths [options] src dst
ARGUMENTS
=
src
&n=
bsp; Source device ID
=
dst
&n=
bsp; Destination device =
ID
OPTIONS
=
-r, --recompute
&n=
bsp; Trigger topology re=
-computation
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:ports
Li=
sts all ports or all ports of a dev=
ice
SYNTAX
on=
os:ports [options] [uri]
ARGUMENTS
=
uri
&n=
bsp; Device ID
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
-d, --disabled
&n=
bsp; Show only disabled&=
nbsp;ports
=
-e, --enabled
&n=
bsp; Show only enabled&n=
bsp;ports
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:push-random-intents
In=
stalls random intents to test throughput
SYNTAX
on=
os:push-random-intents [options] count
ARGUMENTS
=
count
&n=
bsp; Number of intents&n=
bsp;to push
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:push-test-intents
In=
stalls random intents to test throughput
SYNTAX
on=
os:push-test-intents [options] ingressDevice egressDevice&nb=
sp;numberOfIntents [keyOffset]
ARGUMENTS
=
ingressDevice
&n=
bsp; Ingress Device/Port =
;Description
=
egressDevice
&n=
bsp; Egress Device/Port =
Description
=
numberOfIntents
&n=
bsp; Number of intents&n=
bsp;to install/withdraw
=
keyOffset
&n=
bsp; Starting point for&=
nbsp;first key (default: 1)
OPTIONS
=
-i, --install
&n=
bsp; Install intents
=
-j, --json
&n=
bsp; Output JSON
=
-w, --withdraw
&n=
bsp; Withdraw intents
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:remove-intent
Re=
moves the specified intent
SYNTAX
on=
os:remove-intent [options] app id
ARGUMENTS
=
app
&n=
bsp; Application ID
=
id
&n=
bsp; Intent ID
OPTIONS
=
-p, --purge
&n=
bsp; Purge the intent&nb=
sp;from the store after removal
=
-j, --json
&n=
bsp; Output JSON
=
-s, --sync
&n=
bsp; Waits for the =
removal before returning
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:resource-allocations
Li=
sts allocations by link
SYNTAX
on=
os:resource-allocations [options] [srcString] [dstString]&nb=
sp;
ARGUMENTS
=
srcString
&n=
bsp; Link source
=
dstString
&n=
bsp; Link destination
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:resource-available
Li=
sts available resources by link
SYNTAX
on=
os:resource-available [options] [srcString] [dstString] =
;
ARGUMENTS
=
srcString
&n=
bsp; Link source
=
dstString
&n=
bsp; Link destination
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:roles
Li=
sts mastership roles of nodes for each d=
evice.
SYNTAX
on=
os:roles [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:summary
Pr=
ovides summary of ONOS model
SYNTAX
on=
os:summary [options]
OPTIONS
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:topology
Li=
sts summary of the current topology
SYNTAX
on=
os:topology [options]
OPTIONS
=
-r, --recompute
&n=
bsp; Trigger topology re=
-computation
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message
DESCRIPTION
on=
os:wipe-out
Wi=
pes-out the entire network information base, =
i.e. devices, links, hosts
SYNTAX
on=
os:wipe-out [options] [please]
ARGUMENTS
=
please
&n=
bsp; Confirmation phrase
OPTIONS
=
-r, --recompute
&n=
bsp; Trigger topology re=
-computation
=
-j, --json
&n=
bsp; Output JSON
=
--help
&n=
bsp; Display this help&n=
bsp;message