ofp-util: Allow decoding of Open Flow 1.2 Packet In Messages
[openvswitch] / utilities / ovs-ofctl.8.in
1 .\" -*- nroff -*-
2 .de IQ
3 .  br
4 .  ns
5 .  IP "\\$1"
6 ..
7 .TH ovs\-ofctl 8 "January 2011" "Open vSwitch" "Open vSwitch Manual"
8 .ds PN ovs\-ofctl
9 .
10 .SH NAME
11 ovs\-ofctl \- administer OpenFlow switches
12 .
13 .SH SYNOPSIS
14 .B ovs\-ofctl
15 [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
16 .
17 .SH DESCRIPTION
18 The
19 .B ovs\-ofctl
20 program is a command line tool for monitoring and administering
21 OpenFlow switches.  It can also show the current state of an OpenFlow
22 switch, including features, configuration, and table entries.
23 .
24 .SS "OpenFlow Switch Management Commands"
25 .PP
26 These commands allow \fBovs\-ofctl\fR to monitor and administer an OpenFlow
27 switch.  It is able to show the current state of a switch, including
28 features, configuration, and table entries.
29 .PP
30 Most of these commands take an argument that specifies the method for
31 connecting to an OpenFlow switch.  The following connection methods
32 are supported:
33 .
34 .RS
35 .so lib/vconn-active.man
36 .
37 .IP "\fIfile\fR"
38 This is short for \fBunix:\fIfile\fR, as long as \fIfile\fR does not
39 contain a colon.
40 .
41 .IP \fIbridge\fR
42 This is short for \fBunix:@RUNDIR@/\fIbridge\fB.mgmt\fR, as long as
43 \fIbridge\fR does not contain a colon.
44 .
45 .IP [\fItype\fB@\fR]\fIdp\fR
46 Attempts to look up the bridge associated with \fIdp\fR and open as
47 above.  If \fItype\fR is given, it specifies the datapath provider of
48 \fIdp\fR, otherwise the default provider \fBsystem\fR is assumed.
49 .RE
50 .
51 .TP
52 \fBshow \fIswitch\fR
53 Prints to the console information on \fIswitch\fR, including
54 information on its flow tables and ports.
55 .
56 .TP
57 \fBdump\-tables \fIswitch\fR
58 Prints to the console statistics for each of the flow tables used by
59 \fIswitch\fR.
60 .
61 .TP
62 \fBdump\-ports \fIswitch\fR [\fInetdev\fR]
63 Prints to the console statistics for network devices associated with 
64 \fIswitch\fR.  If \fInetdev\fR is specified, only the statistics
65 associated with that device will be printed.  \fInetdev\fR can be an
66 OpenFlow assigned port number or device name, e.g. \fBeth0\fR.
67 .
68 .TP
69 \fBdump\-ports\-desc \fIswitch\fR
70 Prints to the console detailed information about network devices
71 associated with \fIswitch\fR (version 1.7 or later).  This is a subset
72 of the information provided by the \fBshow\fR command.
73 .
74 .TP
75 \fBmod\-port \fIswitch\fR \fInetdev\fR \fIaction\fR
76 Modify characteristics of an interface monitored by \fIswitch\fR.  
77 \fInetdev\fR can be referred to by its OpenFlow assigned port number or 
78 the device name, e.g. \fBeth0\fR.  The \fIaction\fR may be any one of the
79 following:
80 .
81 .RS
82 .IQ \fBup\fR
83 .IQ \fBdown\fR
84 Enable or disable the interface.  This is equivalent to \fBifconfig
85 up\fR or \fBifconfig down\fR on a Unix system.
86 .
87 .IP \fBstp\fR
88 .IQ \fBno\-stp\fR
89 Enable or disable 802.1D spanning tree protocol (STP) on the
90 interface.  OpenFlow implementations that don't support STP will
91 refuse to enable it.
92 .
93 .IP \fBreceive\fR
94 .IQ \fBno\-receive\fR
95 .IQ \fBreceive\-stp\fR
96 .IQ \fBno\-receive\-stp\fR
97 Enable or disable OpenFlow processing of packets received on this
98 interface.  When packet processing is disabled, packets will be
99 dropped instead of being processed through the OpenFlow table.  The
100 \fBreceive\fR or \fBno\-receive\fR setting applies to all packets
101 except 802.1D spanning tree packets, which are separately controlled
102 by \fBreceive\-stp\fR or \fBno\-receive\-stp\fR.
103 .
104 .IP \fBforward\fR
105 .IQ \fBno\-forward\fR
106 Allow or disallow forwarding of traffic to this interface.  By
107 default, forwarding is enabled.
108 .
109 .IP \fBflood\fR
110 .IQ \fBno\-flood\fR
111 Controls whether an OpenFlow \fBflood\fR action will send traffic out
112 this interface.  By default, flooding is enabled.  Disabling flooding
113 is primarily useful to prevent loops when a spanning tree protocol is
114 not in use.
115 .
116 .IP \fBpacket\-in\fR
117 .IQ \fBno\-packet\-in\fR
118 Controls whether packets received on this interface that do not match
119 a flow table entry generate a ``packet in'' message to the OpenFlow
120 controller.  By default, ``packet in'' messages are enabled.
121 .RE
122 .IP
123 The \fBshow\fR command displays (among other information) the
124 configuration that \fBmod\-port\fR changes.
125 .
126 .IP "\fBget\-frags \fIswitch\fR"
127 Prints \fIswitch\fR's fragment handling mode.  See \fBset\-frags\fR,
128 below, for a description of each fragment handling mode.
129 .IP
130 The \fBshow\fR command also prints the fragment handling mode among
131 its other output.
132 .
133 .IP "\fBset\-frags \fIswitch frag_mode\fR"
134 Configures \fIswitch\fR's treatment of IPv4 and IPv6 fragments.  The
135 choices for \fIfrag_mode\fR are:
136 .RS
137 .IP "\fBnormal\fR"
138 Fragments pass through the flow table like non-fragmented packets.
139 The TCP ports, UDP ports, and ICMP type and code fields are always set
140 to 0, even for fragments where that information would otherwise be
141 available (fragments with offset 0).  This is the default fragment
142 handling mode for an OpenFlow switch.
143 .IP "\fBdrop\fR"
144 Fragments are dropped without passing through the flow table.
145 .IP "\fBreassemble\fR"
146 The switch reassembles fragments into full IP packets before passing
147 them through the flow table.  Open vSwitch does not implement this
148 fragment handling mode.
149 .IP "\fBnx\-match\fR"
150 Fragments pass through the flow table like non-fragmented packets.
151 The TCP ports, UDP ports, and ICMP type and code fields are available
152 for matching for fragments with offset 0, and set to 0 in fragments
153 with nonzero offset.  This mode is a Nicira extension.
154 .RE
155 .IP
156 See the description of \fBip_frag\fR, below, for a way to match on
157 whether a packet is a fragment and on its fragment offset.
158 .
159 .TP
160 \fBdump\-flows \fIswitch \fR[\fIflows\fR]
161 Prints to the console all flow entries in \fIswitch\fR's
162 tables that match \fIflows\fR.  If \fIflows\fR is omitted, all flows
163 in the switch are retrieved.  See \fBFlow Syntax\fR, below, for the
164 syntax of \fIflows\fR.  The output format is described in
165 \fBTable Entry Output\fR.
166 .
167 .IP
168 By default, \fBovs\-ofctl\fR prints flow entries in the same order
169 that the switch sends them, which is unlikely to be intuitive or
170 consistent.  See the description of \fB\-\-sort\fR and \fB\-\-rsort\fR,
171 under \fBOPTIONS\fR below, to influence the display order.
172 .
173 .TP
174 \fBdump\-aggregate \fIswitch \fR[\fIflows\fR]
175 Prints to the console aggregate statistics for flows in
176 \fIswitch\fR's tables that match \fIflows\fR.  If \fIflows\fR is omitted, 
177 the statistics are aggregated across all flows in the switch's flow
178 tables.  See \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
179 The output format is described in \fBTable Entry Output\fR.
180 .
181 .IP "\fBqueue\-stats \fIswitch \fR[\fIport \fR[\fIqueue\fR]]"
182 Prints to the console statistics for the specified \fIqueue\fR on
183 \fIport\fR within \fIswitch\fR.  Either of \fIport\fR or \fIqueue\fR
184 or both may be omitted (or equivalently specified as \fBALL\fR).  If
185 both are omitted, statistics are printed for all queues on all ports.
186 If only \fIqueue\fR is omitted, then statistics are printed for all
187 queues on \fIport\fR; if only \fIport\fR is omitted, then statistics
188 are printed for \fIqueue\fR on every port where it exists.
189 .
190 .SS "OpenFlow Switch Flow Table Commands"
191 .
192 These commands manage the flow table in an OpenFlow switch.  In each
193 case, \fIflow\fR specifies a flow entry in the format described in
194 \fBFlow Syntax\fR, below, and \fIfile\fR is a text file that contains
195 zero or more flows in the same syntax, one per line.
196 .
197 .IP "\fBadd\-flow \fIswitch flow\fR"
198 .IQ "\fBadd\-flow \fIswitch \fB\- < \fIfile\fR"
199 .IQ "\fBadd\-flows \fIswitch file\fR"
200 Add each flow entry to \fIswitch\fR's tables.
201 .
202 .IP "[\fB\-\-strict\fR] \fBmod\-flows \fIswitch flow\fR"
203 .IQ "[\fB\-\-strict\fR] \fBmod\-flows \fIswitch \fB\- < \fIfile\fR"
204 Modify the actions in entries from \fIswitch\fR's tables that match
205 the specified flows.  With \fB\-\-strict\fR, wildcards are not treated
206 as active for matching purposes.
207 .
208 .IP "\fBdel\-flows \fIswitch\fR"
209 .IQ "[\fB\-\-strict\fR] \fBdel\-flows \fIswitch \fR[\fIflow\fR]"
210 .IQ "[\fB\-\-strict\fR] \fBdel\-flows \fIswitch \fB\- < \fIfile\fR"
211 Deletes entries from \fIswitch\fR's flow table.  With only a
212 \fIswitch\fR argument, deletes all flows.  Otherwise, deletes flow
213 entries that match the specified flows.  With \fB\-\-strict\fR,
214 wildcards are not treated as active for matching purposes.
215 .
216 .IP "[\fB\-\-readd\fR] \fBreplace\-flows \fIswitch file\fR"
217 Reads flow entries from \fIfile\fR (or \fBstdin\fR if \fIfile\fR is
218 \fB\-\fR) and queries the flow table from \fIswitch\fR.  Then it fixes
219 up any differences, adding flows from \fIflow\fR that are missing on
220 \fIswitch\fR, deleting flows from \fIswitch\fR that are not in
221 \fIfile\fR, and updating flows in \fIswitch\fR whose actions, cookie,
222 or timeouts differ in \fIfile\fR.
223 .
224 .IP
225 With \fB\-\-readd\fR, \fBovs\-ofctl\fR adds all the flows from
226 \fIfile\fR, even those that exist with the same actions, cookie, and
227 timeout in \fIswitch\fR.  This resets all the flow packet and byte
228 counters to 0, which can be useful for debugging.
229 .
230 .IP "\fBdiff\-flows \fIsource1 source2\fR"
231 Reads flow entries from \fIsource1\fR and \fIsource2\fR and prints the
232 differences.  A flow that is in \fIsource1\fR but not in \fIsource2\fR
233 is printed preceded by a \fB\-\fR, and a flow that is in \fIsource2\fR
234 but not in \fIsource1\fR is printed preceded by a \fB+\fR.  If a flow
235 exists in both \fIsource1\fR and \fIsource2\fR with different actions,
236 cookie, or timeouts, then both versions are printed preceded by
237 \fB\-\fR and \fB+\fR, respectively.
238 .IP
239 \fIsource1\fR and \fIsource2\fR may each name a file or a switch.  If
240 a name begins with \fB/\fR or \fB.\fR, then it is considered to be a
241 file name.  A name that contains \fB:\fR is considered to be a switch.
242 Otherwise, it is a file if a file by that name exists, a switch if
243 not.
244 .IP
245 For this command, an exit status of 0 means that no differences were
246 found, 1 means that an error occurred, and 2 means that some
247 differences were found.
248 .
249 .IP "\fBpacket\-out \fIswitch in_port actions packet\fR..."
250 Connects to \fIswitch\fR and instructs it to execute the OpenFlow
251 \fIactions\fR on each \fIpacket\fR.  For the purpose of executing the
252 actions, the packets are considered to have arrived on \fIin_port\fR,
253 which may be an OpenFlow assigned port number, an OpenFlow port name
254 (e.g. \fBeth0\fR), the keyword \fBlocal\fR for the OpenFlow ``local''
255 port \fBOFPP_LOCAL\fR, or the keyword \fBnone\fR to indicate that the
256 packet was generated by the switch itself.
257 .
258 .SS "OpenFlow Switch Monitoring Commands"
259 .
260 .IP "\fBsnoop \fIswitch\fR"
261 Connects to \fIswitch\fR and prints to the console all OpenFlow
262 messages received.  Unlike other \fBovs\-ofctl\fR commands, if
263 \fIswitch\fR is the name of a bridge, then the \fBsnoop\fR command
264 connects to a Unix domain socket named
265 \fB@RUNDIR@/\fIbridge\fB.snoop\fR.  \fBovs\-vswitchd\fR listens on
266 such a socket for each bridge and sends to it all of the OpenFlow
267 messages sent to or received from its configured OpenFlow controller.
268 Thus, this command can be used to view OpenFlow protocol activity
269 between a switch and its controller.
270 .IP
271 When a switch has more than one controller configured, only the
272 traffic to and from a single controller is output.  If none of the
273 controllers is configured as a master or a slave (using a Nicira
274 extension to OpenFlow), then a controller is chosen arbitrarily among
275 them.  If there is a master controller, it is chosen; otherwise, if
276 there are any controllers that are not masters or slaves, one is
277 chosen arbitrarily; otherwise, a slave controller is chosen
278 arbitrarily.  This choice is made once at connection time and does not
279 change as controllers reconfigure their roles.
280 .IP
281 If a switch has no controller configured, or if
282 the configured controller is disconnected, no traffic is sent, so
283 monitoring will not show any traffic.
284 .
285 .IP "\fBmonitor \fIswitch\fR [\fImiss-len\fR] [\fBinvalid_ttl\fR] [\fBwatch:\fR[\fIspec\fR...]]"
286 Connects to \fIswitch\fR and prints to the console all OpenFlow
287 messages received.  Usually, \fIswitch\fR should specify the name of a
288 bridge in the \fBovs\-vswitchd\fR database.
289 .IP
290 If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set
291 configuration'' message at connection setup time that requests
292 \fImiss-len\fR bytes of each packet that misses the flow table.  Open vSwitch
293 does not send these and other asynchronous messages to an
294 \fBovs\-ofctl monitor\fR client connection unless a nonzero value is
295 specified on this argument.  (Thus, if \fImiss\-len\fR is not
296 specified, very little traffic will ordinarily be printed.)
297 .IP
298 If \fBinvalid_ttl\fR is passed, \fBovs\-ofctl\fR sends an OpenFlow ``set
299 configuration'' message at connection setup time that requests
300 \fBINVALID_TTL_TO_CONTROLLER\fR, so that \fBovs\-ofctl monitor\fR can
301 receive ``packet-in'' messages when TTL reaches zero on \fBdec_ttl\fR action.
302 .IP
303 \fBwatch:\fR[\fB\fIspec\fR...] causes \fBovs\-ofctl\fR to send a
304 ``monitor request'' Nicira extension message to the switch at
305 connection setup time.  This message causes the switch to send
306 information about flow table changes as they occur.  The following
307 comma-separated \fIspec\fR syntax is available:
308 .RS
309 .IP "\fB!initial\fR"
310 Do not report the switch's initial flow table contents.
311 .IP "\fB!add\fR"
312 Do not report newly added flows.
313 .IP "\fB!delete\fR"
314 Do not report deleted flows.
315 .IP "\fB!modify\fR"
316 Do not report modifications to existing flows.
317 .IP "\fB!own\fR"
318 Abbreviate changes made to the flow table by \fBovs\-ofctl\fR's own
319 connection to the switch.  (These could only occur using the
320 \fBofctl/send\fR command described below under \fBRUNTIME MANAGEMENT
321 COMMANDS\fR.)
322 .IP "\fB!actions\fR"
323 Do not report actions as part of flow updates.
324 .IP "\fBtable=\fInumber\fR"
325 Limits the monitoring to the table with the given \fInumber\fR between
326 0 and 254.  By default, all tables are monitored.
327 .IP "\fBout_port=\fIport\fR"
328 If set, only flows that output to \fIport\fR are monitored.
329 .IP "\fIfield\fB=\fIvalue\fR"
330 Monitors only flows that have \fIfield\fR specified as the given
331 \fIvalue\fR.  Any syntax valid for matching on \fBdump\-flows\fR may
332 be used.
333 .RE
334 .IP
335 This command may be useful for debugging switch or controller
336 implementations.  With \fBwatch:\fR, it is particularly useful for
337 observing how a controller updates flow tables.
338 .
339 .SS "OpenFlow Switch and Controller Commands"
340 .
341 The following commands, like those in the previous section, may be
342 applied to OpenFlow switches, using any of the connection methods
343 described in that section.  Unlike those commands, these may also be
344 applied to OpenFlow controllers.
345 .
346 .TP
347 \fBprobe \fItarget\fR
348 Sends a single OpenFlow echo-request message to \fItarget\fR and waits
349 for the response.  With the \fB\-t\fR or \fB\-\-timeout\fR option, this
350 command can test whether an OpenFlow switch or controller is up and
351 running.
352 .
353 .TP
354 \fBping \fItarget \fR[\fIn\fR]
355 Sends a series of 10 echo request packets to \fItarget\fR and times
356 each reply.  The echo request packets consist of an OpenFlow header
357 plus \fIn\fR bytes (default: 64) of randomly generated payload.  This
358 measures the latency of individual requests.
359 .
360 .TP
361 \fBbenchmark \fItarget n count\fR
362 Sends \fIcount\fR echo request packets that each consist of an
363 OpenFlow header plus \fIn\fR bytes of payload and waits for each
364 response.  Reports the total time required.  This is a measure of the
365 maximum bandwidth to \fItarget\fR for round-trips of \fIn\fR-byte
366 messages.
367 .
368 .SS "Flow Syntax"
369 .PP
370 Some \fBovs\-ofctl\fR commands accept an argument that describes a flow or
371 flows.  Such flow descriptions comprise a series
372 \fIfield\fB=\fIvalue\fR assignments, separated by commas or white
373 space.  (Embedding spaces into a flow description normally requires
374 quoting to prevent the shell from breaking the description into
375 multiple arguments.)
376 .PP
377 Flow descriptions should be in \fBnormal form\fR.  This means that a
378 flow may only specify a value for an L3 field if it also specifies a
379 particular L2 protocol, and that a flow may only specify an L4 field
380 if it also specifies particular L2 and L3 protocol types.  For
381 example, if the L2 protocol type \fBdl_type\fR is wildcarded, then L3
382 fields \fBnw_src\fR, \fBnw_dst\fR, and \fBnw_proto\fR must also be
383 wildcarded.  Similarly, if \fBdl_type\fR or \fBnw_proto\fR (the L3
384 protocol type) is wildcarded, so must be \fBtp_dst\fR and
385 \fBtp_src\fR, which are L4 fields.  \fBovs\-ofctl\fR will warn about
386 flows not in normal form.
387 .PP
388 The following field assignments describe how a flow matches a packet.
389 If any of these assignments is omitted from the flow syntax, the field
390 is treated as a wildcard; thus, if all of them are omitted, the
391 resulting flow matches all packets.  The string \fB*\fR or \fBANY\fR
392 may be specified to explicitly mark any of these fields as a wildcard.  
393 (\fB*\fR should be quoted to protect it from shell expansion.)
394 .
395 .IP \fBin_port=\fIport_no\fR
396 Matches OpenFlow port \fIport_no\fR.  Ports are numbered as
397 displayed by \fBovs\-ofctl show\fR.
398 .IP
399 (The \fBresubmit\fR action can search OpenFlow flow tables with
400 arbitrary \fBin_port\fR values, so flows that match port numbers that
401 do not exist from an OpenFlow perspective can still potentially be
402 matched.)
403 .
404 .IP \fBdl_vlan=\fIvlan\fR
405 Matches IEEE 802.1q Virtual LAN tag \fIvlan\fR.  Specify \fB0xffff\fR
406 as \fIvlan\fR to match packets that are not tagged with a Virtual LAN;
407 otherwise, specify a number between 0 and 4095, inclusive, as the
408 12-bit VLAN ID to match.
409 .
410 .IP \fBdl_vlan_pcp=\fIpriority\fR
411 Matches IEEE 802.1q Priority Code Point (PCP) \fIpriority\fR, which is
412 specified as a value between 0 and 7, inclusive.  A higher value
413 indicates a higher frame priority level.
414 .
415 .IP \fBdl_src=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
416 .IQ \fBdl_dst=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
417 Matches an Ethernet source (or destination) address specified as 6
418 pairs of hexadecimal digits delimited by colons
419 (e.g. \fB00:0A:E4:25:6B:B0\fR).
420 .
421 .IP \fBdl_src=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB/\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
422 .IQ \fBdl_dst=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB/\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
423 Matches an Ethernet destination address specified as 6 pairs of
424 hexadecimal digits delimited by colons (e.g. \fB00:0A:E4:25:6B:B0\fR),
425 with a wildcard mask following the slash. Open vSwitch 1.8 and later
426 support arbitrary masks for source and/or destination. Earlier
427 versions only support masking the destination with the following masks:
428 .RS
429 .IP \fB01:00:00:00:00:00\fR
430 Match only the multicast bit.  Thus,
431 \fBdl_dst=01:00:00:00:00:00/01:00:00:00:00:00\fR matches all multicast
432 (including broadcast) Ethernet packets, and
433 \fBdl_dst=00:00:00:00:00:00/01:00:00:00:00:00\fR matches all unicast
434 Ethernet packets.
435 .IP \fBfe:ff:ff:ff:ff:ff\fR
436 Match all bits except the multicast bit.  This is probably not useful.
437 .IP \fBff:ff:ff:ff:ff:ff\fR
438 Exact match (equivalent to omitting the mask).
439 .IP \fB00:00:00:00:00:00\fR
440 Wildcard all bits (equivalent to \fBdl_dst=*\fR.)
441 .RE
442 .
443 .IP \fBdl_type=\fIethertype\fR
444 Matches Ethernet protocol type \fIethertype\fR, which is specified as an
445 integer between 0 and 65535, inclusive, either in decimal or as a 
446 hexadecimal number prefixed by \fB0x\fR (e.g. \fB0x0806\fR to match ARP 
447 packets).
448 .
449 .IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
450 .IQ \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
451 When \fBdl_type\fR is 0x0800 (possibly via shorthand, e.g. \fBip\fR
452 or \fBtcp\fR), matches IPv4 source (or destination) address \fIip\fR,
453 which may be specified as an IP address or host name
454 (e.g. \fB192.168.1.1\fR or \fBwww.example.com\fR).  The optional
455 \fInetmask\fR allows restricting a match to an IPv4 address prefix.
456 The netmask may be specified as a dotted quad
457 (e.g. \fB192.168.1.0/255.255.255.0\fR) or as a CIDR block
458 (e.g. \fB192.168.1.0/24\fR).  Open vSwitch 1.8 and later support
459 arbitrary dotted quad masks; earlier versions support only CIDR masks,
460 that is, the dotted quads that are equivalent to some CIDR block.
461 .IP
462 When \fBdl_type=0x0806\fR or \fBarp\fR is specified, matches the
463 \fBar_spa\fR or \fBar_tpa\fR field, respectively, in ARP packets for
464 IPv4 and Ethernet.
465 .IP
466 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800
467 or 0x0806, the values of \fBnw_src\fR and \fBnw_dst\fR are ignored
468 (see \fBFlow Syntax\fR above).
469 .
470 .IP \fBnw_proto=\fIproto\fR
471 When \fBip\fR or \fBdl_type=0x0800\fR is specified, matches IP
472 protocol type \fIproto\fR, which is specified as a decimal number
473 between 0 and 255, inclusive (e.g. 1 to match ICMP packets or 6 to match
474 TCP packets).
475 .IP
476 When \fBipv6\fR or \fBdl_type=0x86dd\fR is specified, matches IPv6
477 header type \fIproto\fR, which is specified as a decimal number between
478 0 and 255, inclusive (e.g. 58 to match ICMPv6 packets or 6 to match
479 TCP).  The header type is the terminal header as described in the
480 \fBDESIGN\fR document.
481 .IP
482 When \fBarp\fR or \fBdl_type=0x0806\fR is specified, matches the lower
483 8 bits of the ARP opcode.  ARP opcodes greater than 255 are treated as
484 0.
485 .IP
486 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800,
487 0x0806, or 0x86dd, the value of \fBnw_proto\fR is ignored (see \fBFlow
488 Syntax\fR above).
489 .
490 .IP \fBnw_tos=\fItos\fR
491 Matches IP ToS/DSCP or IPv6 traffic class field \fItos\fR, which is
492 specified as a decimal number between 0 and 255, inclusive.  Note that
493 the two lower reserved bits are ignored for matching purposes.
494 .IP
495 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800 or
496 0x86dd, the value of \fBnw_tos\fR is ignored (see \fBFlow Syntax\fR
497 above).
498 .
499 .IP \fBnw_ecn=\fIecn\fR
500 Matches \fIecn\fR bits in IP ToS or IPv6 traffic class fields, which is
501 specified as a decimal number between 0 and 3, inclusive.
502 .IP
503 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800 or
504 0x86dd, the value of \fBnw_ecn\fR is ignored (see \fBFlow Syntax\fR
505 above).
506 .
507 .IP \fBnw_ttl=\fIttl\fR
508 Matches IP TTL or IPv6 hop limit value \fIttl\fR, which is
509 specified as a decimal number between 0 and 255, inclusive.
510 .IP
511 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800 or
512 0x86dd, the value of \fBnw_ttl\fR is ignored (see \fBFlow Syntax\fR
513 above).
514 .IP
515 .
516 .IP \fBtp_src=\fIport\fR
517 .IQ \fBtp_dst=\fIport\fR
518 When \fBdl_type\fR and \fBnw_proto\fR specify TCP or UDP, \fBtp_src\fR
519 and \fBtp_dst\fR match the UDP or TCP source or destination port
520 \fIport\fR, respectively, which is specified as a decimal number
521 between 0 and 65535, inclusive (e.g. 80 to match packets originating
522 from a HTTP server).
523 .IP
524 When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
525 these settings are ignored (see \fBFlow Syntax\fR above).
526 .
527 .IP \fBtp_src=\fIport\fB/\fImask\fR
528 .IQ \fBtp_dst=\fIport\fB/\fImask\fR
529 Bitwise match on TCP (or UDP) source or destination port,
530 respectively.  The \fIport\fR and \fImask\fR are 16-bit numbers
531 written in decimal or in hexadecimal prefixed by \fB0x\fR.  Each 1-bit
532 in \fImask\fR requires that the corresponding bit in \fIport\fR must
533 match.  Each 0-bit in \fImask\fR causes the corresponding bit to be
534 ignored.
535 .IP
536 Bitwise matches on transport ports are rarely useful in isolation, but
537 a group of them can be used to reduce the number of flows required to
538 match on a range of transport ports.  For example, suppose that the
539 goal is to match TCP source ports 1000 to 1999, inclusive.  One way is
540 to insert 1000 flows, each of which matches on a single source port.
541 Another way is to look at the binary representations of 1000 and 1999,
542 as follows:
543 .br
544 .B "01111101000"
545 .br
546 .B "11111001111"
547 .br
548 and then to transform those into a series of bitwise matches that
549 accomplish the same results:
550 .br
551 .B "01111101xxx"
552 .br
553 .B "0111111xxxx"
554 .br
555 .B "10xxxxxxxxx"
556 .br
557 .B "110xxxxxxxx"
558 .br
559 .B "1110xxxxxxx"
560 .br
561 .B "11110xxxxxx"
562 .br
563 .B "1111100xxxx"
564 .br
565 which become the following when written in the syntax required by
566 \fBovs\-ofctl\fR:
567 .br
568 .B "tcp,tp_src=0x03e8/0xfff8"
569 .br
570 .B "tcp,tp_src=0x03f0/0xfff0"
571 .br
572 .B "tcp,tp_src=0x0400/0xfe00"
573 .br
574 .B "tcp,tp_src=0x0600/0xff00"
575 .br
576 .B "tcp,tp_src=0x0700/0xff80"
577 .br
578 .B "tcp,tp_src=0x0780/0xffc0"
579 .br
580 .B "tcp,tp_src=0x07c0/0xfff0"
581 .IP
582 Only Open vSwitch 1.6 and later supports bitwise matching on transport
583 ports.
584 .IP
585 Like the exact-match forms of \fBtp_src\fR and \fBtp_dst\fR described
586 above, the bitwise match forms apply only when \fBdl_type\fR and
587 \fBnw_proto\fR specify TCP or UDP.
588 .
589 .IP \fBicmp_type=\fItype\fR
590 .IQ \fBicmp_code=\fIcode\fR
591 When \fBdl_type\fR and \fBnw_proto\fR specify ICMP or ICMPv6, \fItype\fR
592 matches the ICMP type and \fIcode\fR matches the ICMP code.  Each is
593 specified as a decimal number between 0 and 255, inclusive.
594 .IP
595 When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
596 these settings are ignored (see \fBFlow Syntax\fR above).
597 .
598 .IP \fBtable=\fInumber\fR
599 If specified, limits the flow manipulation and flow dump commands to
600 only apply to the table with the given \fInumber\fR between 0 and 254.
601 .
602 Behavior varies if \fBtable\fR is not specified (equivalent to
603 specifying 255 as \fInumber\fR).  For flow table
604 modification commands without \fB\-\-strict\fR, the switch will choose
605 the table for these commands to operate on.  For flow table
606 modification commands with \fB\-\-strict\fR, the command will operate
607 on any single matching flow in any table; it will do nothing if there
608 are matches in more than one table.  The \fBdump-flows\fR and
609 \fBdump-aggregate\fR commands will gather statistics about flows from
610 all tables.
611 .IP
612 When this field is specified in \fBadd-flow\fR, \fBadd-flows\fR,
613 \fBmod-flows\fR and \fBdel-flows\fR commands, it activates a Nicira
614 extension to OpenFlow, which as of this writing is only known to be
615 implemented by Open vSwitch.
616 .
617 .PP
618 The following shorthand notations are also available:
619 .
620 .IP \fBip\fR
621 Same as \fBdl_type=0x0800\fR.
622 .
623 .IP \fBicmp\fR
624 Same as \fBdl_type=0x0800,nw_proto=1\fR.
625 .
626 .IP \fBtcp\fR
627 Same as \fBdl_type=0x0800,nw_proto=6\fR.
628 .
629 .IP \fBudp\fR
630 Same as \fBdl_type=0x0800,nw_proto=17\fR.
631 .
632 .IP \fBarp\fR
633 Same as \fBdl_type=0x0806\fR.
634 .
635 .PP
636 The following field assignments require support for the NXM (Nicira
637 Extended Match) extension to OpenFlow.  When one of these is specified,
638 \fBovs\-ofctl\fR will automatically attempt to negotiate use of this
639 extension.  If the switch does not support NXM, then \fBovs\-ofctl\fR
640 will report a fatal error.
641 .
642 .IP \fBvlan_tci=\fItci\fR[\fB/\fImask\fR]
643 Matches modified VLAN TCI \fItci\fR.  If \fImask\fR is omitted,
644 \fItci\fR is the exact VLAN TCI to match; if \fImask\fR is specified,
645 then a 1-bit in \fImask\fR indicates that the corresponding bit in
646 \fItci\fR must match exactly, and a 0-bit wildcards that bit.  Both
647 \fItci\fR and \fImask\fR are 16-bit values that are decimal by
648 default; use a \fB0x\fR prefix to specify them in hexadecimal.
649 .
650 .IP
651 The value that \fBvlan_tci\fR matches against is 0 for a packet that
652 has no 802.1Q header.  Otherwise, it is the TCI value from the 802.1Q
653 header with the CFI bit (with value \fB0x1000\fR) forced to 1.
654 .IP
655 Examples:
656 .RS
657 .IP \fBvlan_tci=0\fR
658 Match only packets without an 802.1Q header.
659 .IP \fBvlan_tci=0xf123\fR
660 Match packets tagged with priority 7 in VLAN 0x123.
661 .IP \fBvlan_tci=0x1123/0x1fff\fR
662 Match packets tagged with VLAN 0x123 (and any priority).
663 .IP \fBvlan_tci=0x5000/0xf000\fR
664 Match packets tagged with priority 2 (in any VLAN).
665 .IP \fBvlan_tci=0/0xfff\fR
666 Match packets with no 802.1Q header or tagged with VLAN 0 (and any
667 priority).
668 .IP \fBvlan_tci=0x5000/0xe000\fR
669 Match packets with no 802.1Q header or tagged with priority 2 (in any
670 VLAN).
671 .IP \fBvlan_tci=0/0xefff\fR
672 Match packets with no 802.1Q header or tagged with VLAN 0 and priority
673 0.
674 .RE
675 .IP
676 Some of these matching possibilities can also be achieved with
677 \fBdl_vlan\fR and \fBdl_vlan_pcp\fR.
678 .
679 .IP \fBip_frag=\fIfrag_type\fR
680 When \fBdl_type\fR specifies IP or IPv6, \fIfrag_type\fR
681 specifies what kind of IP fragments or non-fragments to match.  The
682 following values of \fIfrag_type\fR are supported:
683 .RS
684 .IP "\fBno\fR"
685 Matches only non-fragmented packets.
686 .IP "\fByes\fR"
687 Matches all fragments.
688 .IP "\fBfirst\fR"
689 Matches only fragments with offset 0.
690 .IP "\fBlater\fR"
691 Matches only fragments with nonzero offset.
692 .IP "\fBnot_later\fR"
693 Matches non-fragmented packets and fragments with zero offset.
694 .RE
695 .IP
696 The \fBip_frag\fR match type is likely to be most useful in
697 \fBnx\-match\fR mode.  See the description of the \fBset\-frags\fR
698 command, above, for more details.
699 .
700 .IP \fBarp_sha=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
701 .IQ \fBarp_tha=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
702 When \fBdl_type\fR specifies ARP, \fBarp_sha\fR and \fBarp_tha\fR match
703 the source and target hardware address, respectively.  An address is
704 specified as 6 pairs of hexadecimal digits delimited by colons.
705 .
706 .IP \fBipv6_src=\fIipv6\fR[\fB/\fInetmask\fR]
707 .IQ \fBipv6_dst=\fIipv6\fR[\fB/\fInetmask\fR]
708 When \fBdl_type\fR is 0x86dd (possibly via shorthand, e.g., \fBipv6\fR
709 or \fBtcp6\fR), matches IPv6 source (or destination) address \fIipv6\fR,
710 which may be specified as defined in RFC 2373.  The preferred format is 
711 \fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fR, where
712 \fIx\fR are the hexadecimal values of the eight 16-bit pieces of the
713 address.  A single instance of \fB::\fR may be used to indicate multiple
714 groups of 16-bits of zeros.  The optional \fInetmask\fR allows
715 restricting a match to an IPv6 address prefix.  A netmask is specified
716 as an IPv6 address (e.g. \fB2001:db8:3c4d:1::/ffff:ffff:ffff:ffff::\fR)
717 or a CIDR block (e.g. \fB2001:db8:3c4d:1::/64\fR).  Open vSwitch 1.8
718 and later support arbitrary masks; earlier versions support only CIDR
719 masks, that is, CIDR block and IPv6 addresses that are equivalent to
720 CIDR blocks.
721 .
722 .IP \fBipv6_label=\fIlabel\fR
723 When \fBdl_type\fR is 0x86dd (possibly via shorthand, e.g., \fBipv6\fR
724 or \fBtcp6\fR), matches IPv6 flow label \fIlabel\fR.
725 .
726 .IP \fBnd_target=\fIipv6\fR[\fB/\fInetmask\fR]
727 When \fBdl_type\fR, \fBnw_proto\fR, and \fBicmp_type\fR specify
728 IPv6 Neighbor Discovery (ICMPv6 type 135 or 136), matches the target address
729 \fIipv6\fR.  \fIipv6\fR is in the same format described earlier for the
730 \fBipv6_src\fR and \fBipv6_dst\fR fields.
731 .
732 .IP \fBnd_sll=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
733 When \fBdl_type\fR, \fBnw_proto\fR, and \fBicmp_type\fR specify IPv6
734 Neighbor Solicitation (ICMPv6 type 135), matches the source link\-layer
735 address option.  An address is specified as 6 pairs of hexadecimal
736 digits delimited by colons.
737 .
738 .IP \fBnd_tll=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
739 When \fBdl_type\fR, \fBnw_proto\fR, and \fBicmp_type\fR specify IPv6
740 Neighbor Advertisement (ICMPv6 type 136), matches the target link\-layer
741 address option.  An address is specified as 6 pairs of hexadecimal
742 digits delimited by colons.
743 .
744 .IP \fBtun_id=\fItunnel-id\fR[\fB/\fImask\fR]
745 Matches tunnel identifier \fItunnel-id\fR.  Only packets that arrive
746 over a tunnel that carries a key (e.g. GRE with the RFC 2890 key
747 extension and a nonzero key value) will have a nonzero tunnel ID.
748 If \fImask\fR is omitted, \fItunnel-id\fR is the exact tunnel ID to match;
749 if \fImask\fR is specified, then a 1-bit in \fImask\fR indicates that the
750 corresponding bit in \fItunnel-id\fR must match exactly, and a 0-bit
751 wildcards that bit.
752 .
753 .IP "\fBreg\fIidx\fB=\fIvalue\fR[\fB/\fImask\fR]"
754 Matches \fIvalue\fR either exactly or with optional \fImask\fR in
755 register number \fIidx\fR.  The valid range of \fIidx\fR depends on
756 the switch.  \fIvalue\fR and \fImask\fR are 32-bit integers, by
757 default in decimal (use a \fB0x\fR prefix to specify hexadecimal).
758 Arbitrary \fImask\fR values are allowed: a 1-bit in \fImask\fR
759 indicates that the corresponding bit in \fIvalue\fR must match
760 exactly, and a 0-bit wildcards that bit.
761 .IP
762 When a packet enters an OpenFlow switch, all of the registers are set
763 to 0.  Only explicit Nicira extension actions change register values.
764 .
765 .PP
766 Defining IPv6 flows (those with \fBdl_type\fR equal to 0x86dd) requires
767 support for NXM.  The following shorthand notations are available for
768 IPv6-related flows:
769 .
770 .IP \fBipv6\fR
771 Same as \fBdl_type=0x86dd\fR.
772 .
773 .IP \fBtcp6\fR
774 Same as \fBdl_type=0x86dd,nw_proto=6\fR.
775 .
776 .IP \fBudp6\fR
777 Same as \fBdl_type=0x86dd,nw_proto=17\fR.
778 .
779 .IP \fBicmp6\fR
780 Same as \fBdl_type=0x86dd,nw_proto=58\fR.
781 .
782 .PP
783 Finally, field assignments to \fBduration\fR, \fBn_packets\fR, or
784 \fBn_bytes\fR are ignored to allow output from the \fBdump\-flows\fR
785 command to be used as input for other commands that parse flows.
786 .
787 .PP
788 The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands
789 require an additional field, which must be the final field specified:
790 .
791 .IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR
792 Specifies a comma-separated list of actions to take on a packet when the 
793 flow entry matches.  If no \fItarget\fR is specified, then packets
794 matching the flow are dropped.  The \fItarget\fR may be a decimal port 
795 number designating the physical port on which to output the packet, or one 
796 of the following keywords:
797 .
798 .RS
799 .IP \fBoutput\fR:\fIport\fR
800 .IQ \fBoutput\fR:\fIsrc\fB[\fIstart\fB..\fIend\fB]
801 Outputs the packet. If \fIport\fR is an OpenFlow port number, outputs directly
802 to it.  Otherwise, outputs to the OpenFlow port number read from \fIsrc\fR
803 which must be an NXM field as described above.  Outputting to an NXM field is
804 an OpenFlow extension which is not supported by standard OpenFlow switches.
805 .IP
806 Example: \fBoutput:NXM_NX_REG0[16..31]\fR outputs to the OpenFlow port number
807 written in the upper half of register 0.
808 .
809 .IP \fBenqueue\fR:\fIport\fB:\fIqueue\fR
810 Enqueues the packet on the specified \fIqueue\fR within port
811 \fIport\fR.  The number of supported queues depends on the switch;
812 some OpenFlow implementations do not support queuing at all.
813 .
814 .IP \fBnormal\fR
815 Subjects the packet to the device's normal L2/L3 processing.  (This
816 action is not implemented by all OpenFlow switches.)
817 .
818 .IP \fBflood\fR
819 Outputs the packet on all switch physical ports other than the port on
820 which it was received and any ports on which flooding is disabled
821 (typically, these would be ports disabled by the IEEE 802.1D spanning
822 tree protocol).
823 .
824 .IP \fBall\fR
825 Outputs the packet on all switch physical ports other than the port on
826 which it was received.
827 .
828 .IP \fBcontroller(\fIkey\fB=\fIvalue\fR...\fB)
829 Sends the packet to the OpenFlow controller as a ``packet in''
830 message.  The supported key-value pairs are:
831 .RS
832 .IP "\fBmax_len=\fInbytes\fR"
833 Limit to \fInbytes\fR the number of bytes of the packet to send to
834 the controller.  By default the entire packet is sent.
835 .IP "\fBreason=\fIreason\fR"
836 Specify \fIreason\fR as the reason for sending the message in the
837 ``packet in'' message.  The supported reasons are \fBaction\fR (the
838 default), \fBno_match\fR, and \fBinvalid_ttl\fR.
839 .IP "\fBid=\fIcontroller-id\fR"
840 Specify \fIcontroller-id\fR, a 16-bit integer, as the connection ID of
841 the OpenFlow controller or controllers to which the ``packet in''
842 message should be sent.  The default is zero.  Zero is also the
843 default connection ID for each controller connection, and a given
844 controller connection will only have a nonzero connection ID if its
845 controller uses the \fBNXT_SET_CONTROLLER_ID\fR Nicira extension to
846 OpenFlow.
847 .RE
848 Any \fIreason\fR other than \fBaction\fR and any nonzero
849 \fIcontroller-id\fR uses a Nicira vendor extension that, as of this
850 writing, is only known to be implemented by Open vSwitch (version 1.6
851 or later).
852 .
853 .IP \fBcontroller\fR
854 .IQ \fBcontroller\fR[\fB:\fInbytes\fR]
855 Shorthand for \fBcontroller()\fR or
856 \fBcontroller(max_len=\fInbytes\fB)\fR, respectively.
857 .
858 .IP \fBlocal\fR
859 Outputs the packet on the ``local port,'' which corresponds to the
860 network device that has the same name as the bridge.
861 .
862 .IP \fBin_port\fR
863 Outputs the packet on the port from which it was received.
864 .
865 .IP \fBdrop\fR
866 Discards the packet, so no further processing or forwarding takes place.
867 If a drop action is used, no other actions may be specified.
868 .
869 .IP \fBmod_vlan_vid\fR:\fIvlan_vid\fR
870 Modifies the VLAN id on a packet.  The VLAN tag is added or modified 
871 as necessary to match the value specified.  If the VLAN tag is added,
872 a priority of zero is used (see the \fBmod_vlan_pcp\fR action to set
873 this).
874 .
875 .IP \fBmod_vlan_pcp\fR:\fIvlan_pcp\fR
876 Modifies the VLAN priority on a packet.  The VLAN tag is added or modified 
877 as necessary to match the value specified.  Valid values are between 0
878 (lowest) and 7 (highest).  If the VLAN tag is added, a vid of zero is used 
879 (see the \fBmod_vlan_vid\fR action to set this).
880 .
881 .IP \fBstrip_vlan\fR
882 Strips the VLAN tag from a packet if it is present.
883 .
884 .IP \fBmod_dl_src\fB:\fImac\fR
885 Sets the source Ethernet address to \fImac\fR.
886 .
887 .IP \fBmod_dl_dst\fB:\fImac\fR
888 Sets the destination Ethernet address to \fImac\fR.
889 .
890 .IP \fBmod_nw_src\fB:\fIip\fR
891 Sets the IPv4 source address to \fIip\fR.
892 .
893 .IP \fBmod_nw_dst\fB:\fIip\fR
894 Sets the IPv4 destination address to \fIip\fR.
895 .
896 .IP \fBmod_tp_src\fB:\fIport\fR
897 Sets the TCP or UDP source port to \fIport\fR.
898 .
899 .IP \fBmod_tp_dst\fB:\fIport\fR
900 Sets the TCP or UDP destination port to \fIport\fR.
901 .
902 .IP \fBmod_nw_tos\fB:\fItos\fR
903 Sets the IPv4 ToS/DSCP field to \fItos\fR.  Valid values are between 0 and
904 255, inclusive.  Note that the two lower reserved bits are never
905 modified.
906 .
907 .RE
908 .IP
909 The following actions are Nicira vendor extensions that, as of this writing, are
910 only known to be implemented by Open vSwitch:
911 .
912 .RS
913 .
914 .IP \fBresubmit\fB:\fIport\fR
915 .IQ \fBresubmit\fB(\fR[\fIport\fR]\fB,\fR[\fItable\fR]\fB)
916 Re-searches this OpenFlow flow table (or the table whose number is
917 specified by \fItable\fR) with the \fBin_port\fR field replaced by
918 \fIport\fR (if \fIport\fR is specified) and executes the actions
919 found, if any, in addition to any other actions in this flow entry.
920 .IP
921 Recursive \fBresubmit\fR actions are obeyed up to an
922 implementation-defined maximum depth.  Open vSwitch 1.0.1 and earlier
923 did not support recursion; Open vSwitch before 1.2.90 did not support
924 \fItable\fR.
925 .
926 .IP \fBset_tunnel\fB:\fIid\fR
927 .IQ \fBset_tunnel64\fB:\fIid\fR
928 If outputting to a port that encapsulates the packet in a tunnel and
929 supports an identifier (such as GRE), sets the identifier to \fIid\fR.
930 If the \fBset_tunnel\fR form is used and \fIid\fR fits in 32 bits,
931 then this uses an action extension that is supported by Open vSwitch
932 1.0 and later.  Otherwise, if \fIid\fR is a 64-bit value, it requires
933 Open vSwitch 1.1 or later.
934 .
935 .IP \fBset_queue\fB:\fIqueue\fR
936 Sets the queue that should be used to \fIqueue\fR when packets are
937 output.  The number of supported queues depends on the switch; some
938 OpenFlow implementations do not support queuing at all.
939 .
940 .IP \fBpop_queue\fR
941 Restores the queue to the value it was before any \fBset_queue\fR
942 actions were applied.
943 .
944 .IP \fBdec_ttl\fR
945 Decrement TTL of IPv4 packet or hop limit of IPv6 packet.  If the
946 TTL or hop limit is initially zero, no decrement occurs.  Instead,
947 a ``packet-in'' message with reason code \fBOFPR_INVALID_TTL\fR is
948 sent to each connected controller that has enabled receiving them,
949 if any.  Processing the current set of actions then stops.
950 However, if the current set of actions was reached through
951 ``resubmit'' then remaining actions in outer levels resume
952 processing.
953 .
954 .IP \fBnote:\fR[\fIhh\fR]...
955 Does nothing at all.  Any number of bytes represented as hex digits
956 \fIhh\fR may be included.  Pairs of hex digits may be separated by
957 periods for readability.
958 The \fBnote\fR action's format doesn't include an exact length for its
959 payload, so the provided bytes will be padded on the right by enough
960 bytes with value 0 to make the total number 6 more than a multiple of
961 8.
962 .
963 .IP "\fBmove:\fIsrc\fB[\fIstart\fB..\fIend\fB]\->\fIdst\fB[\fIstart\fB..\fIend\fB]\fR"
964 Copies the named bits from field \fIsrc\fR to field \fIdst\fR.
965 \fIsrc\fR and \fIdst\fR must be NXM field names as defined in
966 \fBnicira\-ext.h\fR, e.g. \fBNXM_OF_UDP_SRC\fR or \fBNXM_NX_REG0\fR.
967 Each \fIstart\fR and \fIend\fR pair, which are inclusive, must specify
968 the same number of bits and must fit within its respective field.
969 Shorthands for \fB[\fIstart\fB..\fIend\fB]\fR exist: use
970 \fB[\fIbit\fB]\fR to specify a single bit or \fB[]\fR to specify an
971 entire field.
972 .IP
973 Examples: \fBmove:NXM_NX_REG0[0..5]\->NXM_NX_REG1[26..31]\fR copies the
974 six bits numbered 0 through 5, inclusive, in register 0 into bits 26
975 through 31, inclusive;
976 \fBmove:NXM_NX_REG0[0..15]\->NXM_OF_VLAN_TCI[]\fR copies the least
977 significant 16 bits of register 0 into the VLAN TCI field.
978 .
979 .IP "\fBload:\fIvalue\fB\->\fIdst\fB[\fIstart\fB..\fIend\fB]"
980 Writes \fIvalue\fR to bits \fIstart\fR through \fIend\fR, inclusive,
981 in field \fIdst\fR.
982 .IP
983 Example: \fBload:55\->NXM_NX_REG2[0..5]\fR loads value 55 (bit pattern
984 \fB110111\fR) into bits 0 through 5, inclusive, in register 2.
985 .
986 .IP "\fBmultipath(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIn_links\fB, \fIarg\fB, \fIdst\fB[\fIstart\fB..\fIend\fB])\fR"
987 Hashes \fIfields\fR using \fIbasis\fR as a universal hash parameter,
988 then the applies multipath link selection \fIalgorithm\fR (with
989 parameter \fIarg\fR) to choose one of \fIn_links\fR output links
990 numbered 0 through \fIn_links\fR minus 1, and stores the link into
991 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as
992 described above.
993 .IP
994 Currently, \fIfields\fR must be either \fBeth_src\fR or
995 \fBsymmetric_l4\fR and \fIalgorithm\fR must be one of \fBmodulo_n\fR,
996 \fBhash_threshold\fR, \fBhrw\fR, and \fBiter_hash\fR.  Only
997 the \fBiter_hash\fR algorithm uses \fIarg\fR.
998 .IP
999 Refer to \fBnicira\-ext.h\fR for more details.
1000 .
1001 .IP "\fBautopath(\fIid\fB, \fIdst\fB[\fIstart\fB..\fIend\fB])\fR"
1002 Given \fIid\fR, chooses an OpenFlow port and populates it in
1003 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as
1004 described above.
1005 .IP
1006 Currently, \fIid\fR should be the OpenFlow port number of an interface on the
1007 bridge.  If it isn't then \fIdst\fB[\fIstart\fB..\fIend\fB]\fR will be
1008 populated with the OpenFlow port "none".  If \fIid\fR is a member of a bond,
1009 the normal bond selection logic will be used to choose the destination port.
1010 Otherwise, the register will be populated with \fIid\fR itself.
1011 .IP
1012 Refer to \fBnicira\-ext.h\fR for more details.
1013 .
1014 .IP "\fBbundle(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIslave_type\fB, slaves:[\fIs1\fB, \fIs2\fB, ...])\fR"
1015 Hashes \fIfields\fR using \fIbasis\fR as a universal hash parameter, then
1016 applies the bundle link selection \fIalgorithm\fR to choose one of the listed
1017 slaves represented as \fIslave_type\fR.  Currently the only supported
1018 \fIslave_type\fR is \fBofport\fR.  Thus, each \fIs1\fR through \fIsN\fR should
1019 be an OpenFlow port number. Outputs to the selected slave.
1020 .IP
1021 Currently, \fIfields\fR must be either \fBeth_src\fR or \fBsymmetric_l4\fR and
1022 \fIalgorithm\fR must be one of \fBhrw\fR and \fBactive_backup\fR.
1023 .IP
1024 Example: \fBbundle(eth_src,0,hrw,ofport,slaves:4,8)\fR uses an Ethernet source
1025 hash with basis 0, to select between OpenFlow ports 4 and 8 using the Highest
1026 Random Weight algorithm.
1027 .IP
1028 Refer to \fBnicira\-ext.h\fR for more details.
1029 .
1030 .IP "\fBbundle_load(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIslave_type\fB, \fIdst\fB[\fIstart\fB..\fIend\fB], slaves:[\fIs1\fB, \fIs2\fB, ...])\fR"
1031 Has the same behavior as the \fBbundle\fR action, with one exception.  Instead
1032 of outputting to the selected slave, it writes its selection to
1033 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as described
1034 above.
1035 .IP
1036 Example: \fBbundle_load(eth_src, 0, hrw, ofport, NXM_NX_REG0[],
1037 slaves:4, 8)\fR uses an Ethernet source hash with basis 0, to select
1038 between OpenFlow ports 4 and 8 using the Highest Random Weight
1039 algorithm, and writes the selection to \fBNXM_NX_REG0[]\fR.
1040 .IP
1041 Refer to \fBnicira\-ext.h\fR for more details.
1042 .
1043 .IP "\fBlearn(\fIargument\fR[\fB,\fIargument\fR]...\fB)\fR"
1044 This action adds or modifies a flow in an OpenFlow table, similar to
1045 \fBovs\-ofctl \-\-strict mod\-flows\fR.  The arguments specify the
1046 flow's match fields, actions, and other properties, as follows.  At
1047 least one match criterion and one action argument should ordinarily be
1048 specified.
1049 .RS
1050 .IP \fBidle_timeout=\fIseconds\fR
1051 .IQ \fBhard_timeout=\fIseconds\fR
1052 .IQ \fBpriority=\fIvalue\fR
1053 These key-value pairs have the same meaning as in the usual
1054 \fBovs\-ofctl\fR flow syntax.
1055 .
1056 .IP \fBfin_idle_timeout=\fIseconds\fR
1057 .IQ \fBfin_hard_timeout=\fIseconds\fR
1058 Adds a \fBfin_timeout\fR action with the specified arguments to the
1059 new flow.  This feature was added in Open vSwitch 1.5.90.
1060 .
1061 .IP \fBtable=\fInumber\fR
1062 The table in which the new flow should be inserted.  Specify a decimal
1063 number between 0 and 254.  The default, if \fBtable\fR is unspecified,
1064 is table 1.
1065 .
1066 .IP \fIfield\fB=\fIvalue\fR
1067 .IQ \fIfield\fB[\fIstart\fB..\fIend\fB]=\fIsrc\fB[\fIstart\fB..\fIend\fB]\fR
1068 .IQ \fIfield\fB[\fIstart\fB..\fIend\fB]\fR
1069 Adds a match criterion to the new flow.
1070 .IP
1071 The first form specifies that \fIfield\fR must match the literal
1072 \fIvalue\fR, e.g. \fBdl_type=0x0800\fR.  All of the fields and values
1073 for \fBovs\-ofctl\fR flow syntax are available with their usual
1074 meanings.
1075 .IP
1076 The second form specifies that \fIfield\fB[\fIstart\fB..\fIend\fB]\fR
1077 in the new flow must match \fIsrc\fB[\fIstart\fB..\fIend\fB]\fR taken
1078 from the flow currently being processed.
1079 .IP
1080 The third form is a shorthand for the second form.  It specifies that
1081 \fIfield\fB[\fIstart\fB..\fIend\fB]\fR in the new flow must match
1082 \fIfield\fB[\fIstart\fB..\fIend\fB]\fR taken from the flow currently
1083 being processed.
1084 .
1085 .IP \fBload:\fIvalue\fB\->\fIdst\fB[\fIstart\fB..\fIend\fB]
1086 .IQ \fBload:\fIsrc\fB[\fIstart\fB..\fIend\fB]\->\fIdst\fB[\fIstart\fB..\fIend\fB]
1087 .
1088 Adds a \fBload\fR action to the new flow.
1089 .IP
1090 The first form loads the literal \fIvalue\fR into bits \fIstart\fR
1091 through \fIend\fR, inclusive, in field \fIdst\fR.  Its syntax is the
1092 same as the \fBload\fR action described earlier in this section.
1093 .IP
1094 The second form loads \fIsrc\fB[\fIstart\fB..\fIend\fB]\fR, a value
1095 from the flow currently being processed, into bits \fIstart\fR
1096 through \fIend\fR, inclusive, in field \fIdst\fR.
1097 .
1098 .IP \fBoutput:\fIfield\fB[\fIstart\fB..\fIend\fB]\fR
1099 Add an \fBoutput\fR action to the new flow's actions, that outputs to
1100 the OpenFlow port taken from \fIfield\fB[\fIstart\fB..\fIend\fB]\fR,
1101 which must be an NXM field as described above.
1102 .RE
1103 .IP
1104 For best performance, segregate learned flows into a table (using
1105 \fBtable=\fInumber\fR) that is not used for any other flows except
1106 possibly for a lowest-priority ``catch-all'' flow, that is, a flow
1107 with no match criteria.  (This is why the default \fBtable\fR is 1, to
1108 keep the learned flows separate from the primary flow table 0.)
1109 .RE
1110 .
1111 .IP "\fBfin_timeout(\fIargument\fR[\fB,\fIargument\fR]\fB)"
1112 This action changes the idle timeout or hard timeout, or both, of this
1113 OpenFlow rule when the rule matches a TCP packet with the FIN or RST
1114 flag.  When such a packet is observed, the action reduces the rule's
1115 timeouts to those specified on the action.  If the rule's existing
1116 timeout is already shorter than the one that the action specifies,
1117 then that timeout is unaffected.
1118 .IP
1119 \fIargument\fR takes the following forms:
1120 .RS
1121 .IP "\fBidle_timeout=\fIseconds\fR"
1122 Causes the flow to expire after the given number of seconds of
1123 inactivity.
1124 .
1125 .IP "\fBhard_timeout=\fIseconds\fR"
1126 Causes the flow to expire after the given number of seconds,
1127 regardless of activity.  (\fIseconds\fR specifies time since the
1128 flow's creation, not since the receipt of the FIN or RST.)
1129 .RE
1130 .IP
1131 This action was added in Open vSwitch 1.5.90.
1132 .IP "\fBexit\fR"
1133 This action causes Open vSwitch to immediately halt execution of further
1134 actions.  Those actions which have already been executed are unaffected.  Any
1135 further actions, including those which may be in other tables, or different
1136 levels of the \fBresubmit\fR call stack, are ignored.
1137 .
1138 .PP
1139 An opaque identifier called a cookie can be used as a handle to identify
1140 a set of flows:
1141 .
1142 .IP \fBcookie=\fIvalue\fR
1143 .
1144 A cookie can be associated with a flow using the \fBadd\-flow\fR,
1145 \fBadd\-flows\fR, and \fBmod\-flows\fR commands.  \fIvalue\fR can be any
1146 64-bit number and need not be unique among flows.  If this field is
1147 omitted, a default cookie value of 0 is used.
1148 .
1149 .IP \fBcookie=\fIvalue\fR\fB/\fImask\fR
1150 .
1151 When using NXM, the cookie can be used as a handle for querying,
1152 modifying, and deleting flows.  \fIvalue\fR and \fImask\fR may be
1153 supplied for the \fBdel\-flows\fR, \fBmod\-flows\fR, \fBdump\-flows\fR, and
1154 \fBdump\-aggregate\fR commands to limit matching cookies.  A 1-bit in
1155 \fImask\fR indicates that the corresponding bit in \fIcookie\fR must
1156 match exactly, and a 0-bit wildcards that bit.  A mask of \-1 may be used
1157 to exactly match a cookie.
1158 .IP
1159 The \fBmod\-flows\fR command can update the cookies of flows that
1160 match a cookie by specifying the \fIcookie\fR field twice (once with a
1161 mask for matching and once without to indicate the new value):
1162 .RS
1163 .IP "\fBovs\-ofctl mod\-flows br0 cookie=1,actions=normal\fR"
1164 Change all flows' cookies to 1 and change their actions to \fBnormal\fR.
1165 .IP "\fBovs\-ofctl mod\-flows br0 cookie=1/\-1,cookie=2,actions=normal\fR"
1166 Update cookies with a value of 1 to 2 and change their actions to
1167 \fBnormal\fR.
1168 .RE
1169 .IP
1170 The ability to match on cookies was added in Open vSwitch 1.5.0.
1171 .
1172 .PP
1173 The following additional field sets the priority for flows added by
1174 the \fBadd\-flow\fR and \fBadd\-flows\fR commands.  For
1175 \fBmod\-flows\fR and \fBdel\-flows\fR when \fB\-\-strict\fR is
1176 specified, priority must match along with the rest of the flow
1177 specification.  For \fBmod-flows\fR without \fB\-\-strict\fR,
1178 priority is only significant if the command creates a new flow, that
1179 is, non-strict \fBmod\-flows\fR does not match on priority and will
1180 not change the priority of existing flows.  Other commands do not
1181 allow priority to be specified.
1182 .
1183 .IP \fBpriority=\fIvalue\fR
1184 The priority at which a wildcarded entry will match in comparison to
1185 others.  \fIvalue\fR is a number between 0 and 65535, inclusive.  A higher 
1186 \fIvalue\fR will match before a lower one.  An exact-match entry will always 
1187 have priority over an entry containing wildcards, so it has an implicit 
1188 priority value of 65535.  When adding a flow, if the field is not specified, 
1189 the flow's priority will default to 32768.
1190 .IP
1191 OpenFlow leaves behavior undefined when two or more flows with the
1192 same priority can match a single packet.  Some users expect
1193 ``sensible'' behavior, such as more specific flows taking precedence
1194 over less specific flows, but OpenFlow does not specify this and Open
1195 vSwitch does not implement it.  Users should therefore take care to
1196 use priorities to ensure the behavior that they expect.
1197 .
1198 .PP
1199 The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands
1200 support the following additional options.  These options affect only
1201 new flows.  Thus, for \fBadd\-flow\fR and \fBadd\-flows\fR, these
1202 options are always significant, but for \fBmod\-flows\fR they are
1203 significant only if the command creates a new flow, that is, their
1204 values do not update or affect existing flows.
1205 .
1206 .IP "\fBidle_timeout=\fIseconds\fR"
1207 Causes the flow to expire after the given number of seconds of
1208 inactivity.  A value of 0 (the default) prevents a flow from expiring
1209 due to inactivity.
1210 .
1211 .IP \fBhard_timeout=\fIseconds\fR
1212 Causes the flow to expire after the given number of seconds,
1213 regardless of activity.  A value of 0 (the default) gives the flow no
1214 hard expiration deadline.
1215 .
1216 .IP "\fBsend_flow_rem\fR"
1217 Marks the flow with a flag that causes the switch to generate a ``flow
1218 removed'' message and send it to interested controllers when the flow
1219 later expires or is removed.
1220 .
1221 .IP "\fBcheck_overlap\fR"
1222 Forces the switch to check that the flow match does not overlap that
1223 of any different flow with the same priority in the same table.  (This
1224 check is expensive so it is best to avoid it.)
1225 .
1226 .PP
1227 The \fBdump\-flows\fR, \fBdump\-aggregate\fR, \fBdel\-flow\fR 
1228 and \fBdel\-flows\fR commands support one additional optional field:
1229 .
1230 .TP
1231 \fBout_port=\fIport\fR
1232 If set, a matching flow must include an output action to \fIport\fR.
1233 .
1234 .SS "Table Entry Output"
1235 .
1236 The \fBdump\-tables\fR and \fBdump\-aggregate\fR commands print information 
1237 about the entries in a datapath's tables.  Each line of output is a 
1238 flow entry as described in \fBFlow Syntax\fR, above, plus some
1239 additional fields:
1240 .
1241 .IP \fBduration=\fIsecs\fR
1242 The time, in seconds, that the entry has been in the table.
1243 \fIsecs\fR includes as much precision as the switch provides, possibly
1244 to nanosecond resolution.
1245 .
1246 .IP \fBn_packets\fR
1247 The number of packets that have matched the entry.
1248 .
1249 .IP \fBn_bytes\fR
1250 The total number of bytes from packets that have matched the entry.
1251 .
1252 .PP
1253 The following additional fields are included only if the switch is
1254 Open vSwitch 1.6 or later and the NXM flow format is used to dump the
1255 flow (see the description of the \fB\-\-flow-format\fR option below).
1256 The values of these additional fields are approximations only and in
1257 particular \fBidle_age\fR will sometimes become nonzero even for busy
1258 flows.
1259 .
1260 .IP \fBhard_age=\fIsecs\fR
1261 The integer number of seconds since the flow was added or modified.
1262 \fBhard_age\fR is displayed only if it differs from the integer part
1263 of \fBduration\fR.  (This is separate from \fBduration\fR because
1264 \fBmod\-flows\fR restarts the \fBhard_timeout\fR timer without zeroing
1265 \fBduration\fR.)
1266 .
1267 .IP \fBidle_age=\fIsecs\fR
1268 The integer number of seconds that have passed without any packets
1269 passing through the flow.
1270 .
1271 .SH OPTIONS
1272 .TP
1273 \fB\-\-strict\fR
1274 Uses strict matching when running flow modification commands.
1275 .
1276 .IP "\fB\-F \fIformat\fR[\fB,\fIformat\fR...]"
1277 .IQ "\fB\-\-flow\-format=\fIformat\fR[\fB,\fIformat\fR...]"
1278 \fBovs\-ofctl\fR supports the following individual flow formats, any
1279 number of which may be listed as \fIformat\fR:
1280 .RS
1281 .IP "\fBOpenFlow10\-table_id\fR"
1282 This is the standard OpenFlow 1.0 flow format.  All OpenFlow switches
1283 and all versions of Open vSwitch support this flow format.
1284 .
1285 .IP "\fBOpenFlow10+table_id\fR"
1286 This is the standard OpenFlow 1.0 flow format plus a Nicira extension
1287 that allows \fBovs\-ofctl\fR to specify the flow table in which a
1288 particular flow should be placed.  Open vSwitch 1.2 and later supports
1289 this flow format.
1290 .
1291 .IP "\fBNXM\-table_id\fR (Nicira Extended Match)"
1292 This Nicira extension to OpenFlow is flexible and extensible.  It
1293 supports all of the Nicira flow extensions, such as \fBtun_id\fR and
1294 registers.  Open vSwitch 1.1 and later supports this flow format.
1295 .
1296 .IP "\fBNXM+table_id\fR (Nicira Extended Match)"
1297 This combines Nicira Extended match with the ability to place a flow
1298 in a specific table.  Open vSwitch 1.2 and later supports this flow
1299 format.
1300 .RE
1301 .
1302 .IP
1303 \fBovs\-ofctl\fR also supports the following abbreviations for
1304 collections of flow formats:
1305 .RS
1306 .IP "\fBany\fR"
1307 Any supported flow format.
1308 .IP "\fBOpenFlow10\fR"
1309 \fBOpenFlow10\-table_id\fR or \fBOpenFlow10+table_id\fR.
1310 .IP "\fBNXM\fR"
1311 \fBNXM\-table_id\fR or \fBNXM+table_id\fR.
1312 .RE
1313 .
1314 .IP
1315 For commands that modify the flow table, \fBovs\-ofctl\fR by default
1316 negotiates the most widely supported flow format that supports the
1317 flows being added.  For commands that query the flow table,
1318 \fBovs\-ofctl\fR by default uses the most advanced format supported by
1319 the switch.
1320 .IP
1321 This option, where \fIformat\fR is a comma-separated list of one or
1322 more of the formats listed above, limits \fBovs\-ofctl\fR's choice of
1323 flow format.  If a command cannot work as requested using one of the
1324 specified flow formats, \fBovs\-ofctl\fR will report a fatal error.
1325 .
1326 .IP "\fB\-P \fIformat\fR"
1327 .IQ "\fB\-\-packet\-in\-format=\fIformat\fR"
1328 \fBovs\-ofctl\fR supports the following packet_in formats, in order of
1329 increasing capability:
1330 .RS
1331 .IP "\fBopenflow10\fR"
1332 This is the standard OpenFlow 1.0 packet in format. It should be supported by
1333 all OpenFlow switches.
1334 .
1335 .IP "\fBnxm\fR (Nicira Extended Match)"
1336 This packet_in format includes flow metadata encoded using the NXM format.
1337 .
1338 .RE
1339 .IP
1340 Usually, \fBovs\-ofctl\fR prefers the \fBnxm\fR packet_in format, but will
1341 allow the switch to choose its default if \fBnxm\fR is unsupported.  When
1342 \fIformat\fR is one of the formats listed in the above table, \fBovs\-ofctl\fR
1343 will insist on the selected format.  If the switch does not support the
1344 requested format, \fBovs\-ofctl\fR will report a fatal error.  This option only
1345 affects the \fBmonitor\fR command.
1346 .
1347 .IP "\fB\-\-timestamp\fR"
1348 Print a timestamp before each received packet.  This option only
1349 affects the \fBmonitor\fR and \fBsnoop\fR commands.
1350 .
1351 .IP "\fB\-m\fR"
1352 .IQ "\fB\-\-more\fR"
1353 Increases the verbosity of OpenFlow messages printed and logged by
1354 \fBovs\-ofctl\fR commands.  Specify this option more than once to
1355 increase verbosity further.
1356 .
1357 .IP \fB\-\-sort\fR[\fB=\fIfield\fR]
1358 .IQ \fB\-\-rsort\fR[\fB=\fIfield\fR]
1359 Display output sorted by flow \fIfield\fR in ascending
1360 (\fB\-\-sort\fR) or descending (\fB\-\-rsort\fR) order, where
1361 \fIfield\fR is any of the fields that are allowed for matching or
1362 \fBpriority\fR to sort by priority.  When \fIfield\fR is omitted, the
1363 output is sorted by priority.  Specify these options multiple times to
1364 sort by multiple fields.
1365 .IP
1366 Any given flow will not necessarily specify a value for a given
1367 field.  This requires special treatement:
1368 .RS
1369 .IP \(bu
1370 A flow that does not specify any part of a field that is used for sorting is
1371 sorted after all the flows that do specify the field.  For example,
1372 \fB\-\-sort=tcp_src\fR will sort all the flows that specify a TCP
1373 source port in ascending order, followed by the flows that do not
1374 specify a TCP source port at all.  
1375 .IP \(bu
1376 A flow that only specifies some bits in a field is sorted as if the
1377 wildcarded bits were zero.  For example, \fB\-\-sort=nw_src\fR would
1378 sort a flow that specifies \fBnw_src=192.168.0.0/24\fR the same as
1379 \fBnw_src=192.168.0.0\fR.
1380 .RE
1381 .IP
1382 These options currently affect only \fBdump\-flows\fR output.
1383 .
1384 .ds DD \
1385 \fBovs\-ofctl\fR detaches only when executing the \fBmonitor\fR or \
1386 \fBsnoop\fR commands.
1387 .so lib/daemon.man
1388 .SS "Public Key Infrastructure Options"
1389 .so lib/ssl.man
1390 .so lib/vlog.man
1391 .so lib/common.man
1392 .
1393 .SH "RUNTIME MANAGEMENT COMMANDS"
1394 \fBovs\-appctl\fR(8) can send commands to a running \fBovs\-ofctl\fR
1395 process.  The supported commands are listed below.
1396 .
1397 .IP "\fBexit\fR"
1398 Causes \fBovs\-ofctl\fR to gracefully terminate.  This command applies
1399 only when executing the \fBmonitor\fR or \fBsnoop\fR commands.
1400 .
1401 .IP "\fBofctl/set\-output\-file \fIfile\fR"
1402 Causes all subsequent output to go to \fIfile\fR instead of stderr.
1403 This command applies only when executing the \fBmonitor\fR or
1404 \fBsnoop\fR commands.
1405 .
1406 .IP "\fBofctl/send \fIofmsg\fR..."
1407 Sends each \fIofmsg\fR, specified as a sequence of hex digits that
1408 express an OpenFlow message, on the OpenFlow connection.  This command
1409 is useful only when executing the \fBmonitor\fR command.
1410 .
1411 .IP "\fBofctl/barrier\fR"
1412 Sends an OpenFlow barrier request on the OpenFlow connection and waits
1413 for a reply.  This command is useful only for the \fBmonitor\fR
1414 command.
1415 .
1416 .SH EXAMPLES
1417 .
1418 The following examples assume that \fBovs\-vswitchd\fR has a bridge
1419 named \fBbr0\fR configured.
1420 .
1421 .TP
1422 \fBovs\-ofctl dump\-tables br0\fR
1423 Prints out the switch's table stats.  (This is more interesting after
1424 some traffic has passed through.)
1425 .
1426 .TP
1427 \fBovs\-ofctl dump\-flows br0\fR
1428 Prints the flow entries in the switch.
1429 .
1430 .SH "SEE ALSO"
1431 .
1432 .BR ovs\-appctl (8),
1433 .BR ovs\-controller (8),
1434 .BR ovs\-vswitchd (8)