nicira-ext: New action "exit".
[cascardo/ovs.git] / 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 \fBmod\-port \fIswitch\fR \fInetdev\fR \fIaction\fR
70 Modify characteristics of an interface monitored by \fIswitch\fR.  
71 \fInetdev\fR can be referred to by its OpenFlow assigned port number or 
72 the device name, e.g. \fBeth0\fR.  The \fIaction\fR may be any one of the
73 following:
74 .
75 .RS
76 .IP \fBup\fR
77 Enables the interface.  This is equivalent to ``ifconfig up'' on a Unix
78 system.
79 .
80 .IP \fBdown\fR
81 Disables the interface.  This is equivalent to ``ifconfig down'' on a Unix
82 system.
83 .
84 .IP \fBflood\fR
85 When a \fIflood\fR action is specified, traffic will be sent out this
86 interface.  This is the default posture for monitored ports.
87 .
88 .IP \fBnoflood\fR
89 When a \fIflood\fR action is specified, traffic will not be sent out 
90 this interface.  This is primarily useful to prevent loops when a
91 spanning tree protocol is not in use.
92 .
93 .RE
94 .
95 .IP "\fBget\-frags \fIswitch\fR"
96 Prints \fIswitch\fR's fragment handling mode.  See \fBset\-frags\fR,
97 below, for a description of each fragment handling mode.
98 .IP
99 The \fBshow\fR command also prints the fragment handling mode among
100 its other output.
101 .
102 .IP "\fBset\-frags \fIswitch frag_mode\fR"
103 Configures \fIswitch\fR's treatment of IPv4 and IPv6 fragments.  The
104 choices for \fIfrag_mode\fR are:
105 .RS
106 .IP "\fBnormal\fR"
107 Fragments pass through the flow table like non-fragmented packets.
108 The TCP ports, UDP ports, and ICMP type and code fields are always set
109 to 0, even for fragments where that information would otherwise be
110 available (fragments with offset 0).  This is the default fragment
111 handling mode for an OpenFlow switch.
112 .IP "\fBdrop\fR"
113 Fragments are dropped without passing through the flow table.
114 .IP "\fBreassemble\fR"
115 The switch reassembles fragments into full IP packets before passing
116 them through the flow table.  Open vSwitch does not implement this
117 fragment handling mode.
118 .IP "\fBnx\-match\fR"
119 Fragments pass through the flow table like non-fragmented packets.
120 The TCP ports, UDP ports, and ICMP type and code fields are available
121 for matching for fragments with offset 0, and set to 0 in fragments
122 with nonzero offset.  This mode is a Nicira extension.
123 .RE
124 .IP
125 See the description of \fBip_frag\fR, below, for a way to match on
126 whether a packet is a fragment and on its fragment offset.
127 .
128 .TP
129 \fBdump\-flows \fIswitch \fR[\fIflows\fR]
130 Prints to the console all flow entries in \fIswitch\fR's
131 tables that match \fIflows\fR.  If \fIflows\fR is omitted, all flows
132 in the switch are retrieved.  See \fBFlow Syntax\fR, below, for the
133 syntax of \fIflows\fR.  The output format is described in 
134 \fBTable Entry Output\fR.
135 .
136 .TP
137 \fBdump\-aggregate \fIswitch \fR[\fIflows\fR]
138 Prints to the console aggregate statistics for flows in 
139 \fIswitch\fR's tables that match \fIflows\fR.  If \fIflows\fR is omitted, 
140 the statistics are aggregated across all flows in the switch's flow
141 tables.  See \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
142 The output format is descrbed in \fBTable Entry Output\fR.
143 .
144 .IP "\fBqueue\-stats \fIswitch \fR[\fIport \fR[\fIqueue\fR]]"
145 Prints to the console statistics for the specified \fIqueue\fR on
146 \fIport\fR within \fIswitch\fR.  Either of \fIport\fR or \fIqueue\fR
147 or both may be omitted (or equivalently specified as \fBALL\fR).  If
148 both are omitted, statistics are printed for all queues on all ports.
149 If only \fIqueue\fR is omitted, then statistics are printed for all
150 queues on \fIport\fR; if only \fIport\fR is omitted, then statistics
151 are printed for \fIqueue\fR on every port where it exists.
152 .
153 .SS "OpenFlow Switch Flow Table Commands"
154 .
155 These commands manage the flow table in an OpenFlow switch.  In each
156 case, \fIflow\fR specifies a flow entry in the format described in
157 \fBFlow Syntax\fR, below, and \fIfile\fR is a text file that contains
158 zero or more flows in the same syntax, one per line.
159 .
160 .IP "\fBadd\-flow \fIswitch flow\fR"
161 .IQ "\fBadd\-flow \fIswitch \fB\- < \fIfile\fR"
162 .IQ "\fBadd\-flows \fIswitch file\fR"
163 Add each flow entry to \fIswitch\fR's tables.
164 .
165 .IP "[\fB\-\-strict\fR] \fBmod\-flows \fIswitch flow\fR"
166 .IQ "[\fB\-\-strict\fR] \fBmod\-flows \fIswitch \fB\- < \fIfile\fR"
167 Modify the actions in entries from \fIswitch\fR's tables that match
168 the specified flows.  With \fB\-\-strict\fR, wildcards are not treated
169 as active for matching purposes.
170 .
171 .IP "\fBdel\-flows \fIswitch\fR"
172 .IQ "[\fB\-\-strict\fR] \fBdel\-flows \fIswitch \fR[\fIflow\fR]"
173 .IQ "[\fB\-\-strict\fR] \fBdel\-flows \fIswitch \fB\- < \fIfile\fR"
174 Deletes entries from \fIswitch\fR's flow table.  With only a
175 \fIswitch\fR argument, deletes all flows.  Otherwise, deletes flow
176 entries that match the specified flows.  With \fB\-\-strict\fR,
177 wildcards are not treated as active for matching purposes.
178 .
179 .IP "[\fB\-\-readd\fR] \fBreplace\-flows \fIswitch file\fR"
180 Reads flow entries from \fIfile\fR (or \fBstdin\fR if \fIfile\fR is
181 \fB\-\fR) and queries the flow table from \fIswitch\fR.  Then it fixes
182 up any differences, adding flows from \fIflow\fR that are missing on
183 \fIswitch\fR, deleting flows from \fIswitch\fR that are not in
184 \fIfile\fR, and updating flows in \fIswitch\fR whose actions, cookie,
185 or timeouts differ in \fIfile\fR.
186 .
187 .IP
188 With \fB\-\-readd\fR, \fBovs\-ofctl\fR adds all the flows from
189 \fIfile\fR, even those that exist with the same actions, cookie, and
190 timeout in \fIswitch\fR.  This resets all the flow packet and byte
191 counters to 0, which can be useful for debugging.
192 .
193 .IP "\fBdiff\-flows \fIsource1 source2\fR"
194 Reads flow entries from \fIsource1\fR and \fIsource2\fR and prints the
195 differences.  A flow that is in \fIsource1\fR but not in \fIsource2\fR
196 is printed preceded by a \fB\-\fR, and a flow that is in \fIsource2\fR
197 but not in \fIsource1\fR is printed preceded by a \fB+\fR.  If a flow
198 exists in both \fIsource1\fR and \fIsource2\fR with different actions,
199 cookie, or timeouts, then both versions are printed preceded by
200 \fB\-\fR and \fB+\fR, respectively.
201 .IP
202 \fIsource1\fR and \fIsource2\fR may each name a file or a switch.  If
203 a name begins with \fB/\fR or \fB.\fR, then it is considered to be a
204 file name.  A name that contains \fB:\fR is considered to be a switch.
205 Otherwise, it is a file if a file by that name exists, a switch if
206 not.
207 .IP
208 For this command, an exit status of 0 means that no differences were
209 found, 1 means that an error occurred, and 2 means that some
210 differences were found.
211 .
212 .SS "OpenFlow Switch Monitoring Commands"
213 .
214 .IP "\fBsnoop \fIswitch\fR"
215 Connects to \fIswitch\fR and prints to the console all OpenFlow
216 messages received.  Unlike other \fBovs\-ofctl\fR commands, if
217 \fIswitch\fR is the name of a bridge, then the \fBsnoop\fR command
218 connects to a Unix domain socket named
219 \fB@RUNDIR@/\fIbridge\fB.snoop\fR.  \fBovs\-vswitchd\fR listens on
220 such a socket for each bridge and sends to it all of the OpenFlow
221 messages sent to or received from its configured OpenFlow controller.
222 Thus, this command can be used to view OpenFlow protocol activity
223 between a switch and its controller.
224 .IP
225 When a switch has more than one controller configured, only the
226 traffic to and from a single controller is output.  If none of the
227 controllers is configured as a master or a slave (using a Nicira
228 extension to OpenFlow), then a controller is chosen arbitrarily among
229 them.  If there is a master controller, it is chosen; otherwise, if
230 there are any controllers that are not masters or slaves, one is
231 chosen arbitrarily; otherwise, a slave controller is chosen
232 arbitrarily.  This choice is made once at connection time and does not
233 change as controllers reconfigure their roles.
234 .IP
235 If a switch has no controller configured, or if
236 the configured controller is disconnected, no traffic is sent, so
237 monitoring will not show any traffic.
238 .
239 .IP "\fBmonitor \fIswitch\fR [\fImiss-len\fR]"
240 Connects to \fIswitch\fR and prints to the console all OpenFlow
241 messages received.  Usually, \fIswitch\fR should specify the name of a
242 bridge in the \fBovs\-vswitchd\fR database.
243 .IP
244 If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set
245 configuration'' message at connection setup time that requests
246 \fImiss-len\fR bytes of each packet that misses the flow table.  Open vSwitch
247 does not send these and other asynchronous messages to an
248 \fBovs\-ofctl monitor\fR client connection unless a nonzero value is
249 specified on this argument.  (Thus, if \fImiss\-len\fR is not
250 specified, very little traffic will ordinarily be printed.)
251 .IP
252 This command may be useful for debugging switch or controller
253 implementations.
254 .
255 .SS "OpenFlow Switch and Controller Commands"
256 .
257 The following commands, like those in the previous section, may be
258 applied to OpenFlow switches, using any of the connection methods
259 described in that section.  Unlike those commands, these may also be
260 applied to OpenFlow controllers.
261 .
262 .TP
263 \fBprobe \fItarget\fR
264 Sends a single OpenFlow echo-request message to \fItarget\fR and waits
265 for the response.  With the \fB\-t\fR or \fB\-\-timeout\fR option, this
266 command can test whether an OpenFlow switch or controller is up and
267 running.
268 .
269 .TP
270 \fBping \fItarget \fR[\fIn\fR]
271 Sends a series of 10 echo request packets to \fItarget\fR and times
272 each reply.  The echo request packets consist of an OpenFlow header
273 plus \fIn\fR bytes (default: 64) of randomly generated payload.  This
274 measures the latency of individual requests.
275 .
276 .TP
277 \fBbenchmark \fItarget n count\fR
278 Sends \fIcount\fR echo request packets that each consist of an
279 OpenFlow header plus \fIn\fR bytes of payload and waits for each
280 response.  Reports the total time required.  This is a measure of the
281 maximum bandwidth to \fItarget\fR for round-trips of \fIn\fR-byte
282 messages.
283 .
284 .SS "Flow Syntax"
285 .PP
286 Some \fBovs\-ofctl\fR commands accept an argument that describes a flow or
287 flows.  Such flow descriptions comprise a series
288 \fIfield\fB=\fIvalue\fR assignments, separated by commas or white
289 space.  (Embedding spaces into a flow description normally requires
290 quoting to prevent the shell from breaking the description into
291 multiple arguments.)
292 .PP
293 Flow descriptions should be in \fBnormal form\fR.  This means that a
294 flow may only specify a value for an L3 field if it also specifies a
295 particular L2 protocol, and that a flow may only specify an L4 field
296 if it also specifies particular L2 and L3 protocol types.  For
297 example, if the L2 protocol type \fBdl_type\fR is wildcarded, then L3
298 fields \fBnw_src\fR, \fBnw_dst\fR, and \fBnw_proto\fR must also be
299 wildcarded.  Similarly, if \fBdl_type\fR or \fBnw_proto\fR (the L3
300 protocol type) is wildcarded, so must be \fBtp_dst\fR and
301 \fBtp_src\fR, which are L4 fields.  \fBovs\-ofctl\fR will warn about
302 flows not in normal form.
303 .PP
304 The following field assignments describe how a flow matches a packet.
305 If any of these assignments is omitted from the flow syntax, the field
306 is treated as a wildcard; thus, if all of them are omitted, the
307 resulting flow matches all packets.  The string \fB*\fR or \fBANY\fR
308 may be specified to explicitly mark any of these fields as a wildcard.  
309 (\fB*\fR should be quoted to protect it from shell expansion.)
310 .
311 .IP \fBin_port=\fIport_no\fR
312 Matches OpenFlow port \fIport_no\fR.  Ports are numbered as
313 displayed by \fBovs\-ofctl show\fR.
314 .IP
315 (The \fBresubmit\fR action can search OpenFlow flow tables with
316 arbitrary \fBin_port\fR values, so flows that match port numbers that
317 do not exist from an OpenFlow perspective can still potentially be
318 matched.)
319 .
320 .IP \fBdl_vlan=\fIvlan\fR
321 Matches IEEE 802.1q Virtual LAN tag \fIvlan\fR.  Specify \fB0xffff\fR
322 as \fIvlan\fR to match packets that are not tagged with a Virtual LAN;
323 otherwise, specify a number between 0 and 4095, inclusive, as the
324 12-bit VLAN ID to match.
325 .
326 .IP \fBdl_vlan_pcp=\fIpriority\fR
327 Matches IEEE 802.1q Priority Code Point (PCP) \fIpriority\fR, which is
328 specified as a value between 0 and 7, inclusive.  A higher value
329 indicates a higher frame priority level.
330 .
331 .IP \fBdl_src=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
332 .IQ \fBdl_dst=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
333 Matches an Ethernet source (or destination) address specified as 6
334 pairs of hexadecimal digits delimited by colons
335 (e.g. \fB00:0A:E4:25:6B:B0\fR).
336 .
337 .IP \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
338 Matches an Ethernet destination address specified as 6 pairs of
339 hexadecimal digits delimited by colons (e.g. \fB00:0A:E4:25:6B:B0\fR),
340 with a wildcard mask following the slash.  Only
341 the following masks are allowed:
342 .RS
343 .IP \fB01:00:00:00:00:00\fR
344 Match only the multicast bit.  Thus,
345 \fBdl_dst=01:00:00:00:00:00/01:00:00:00:00:00\fR matches all multicast
346 (including broadcast) Ethernet packets, and
347 \fBdl_dst=00:00:00:00:00:00/01:00:00:00:00:00\fR matches all unicast
348 Ethernet packets.
349 .IP \fBfe:ff:ff:ff:ff:ff\fR
350 Match all bits except the multicast bit.  This is probably not useful.
351 .IP \fBff:ff:ff:ff:ff:ff\fR
352 Exact match (equivalent to omitting the mask).
353 .IP \fB00:00:00:00:00:00\fR
354 Wildcard all bits (equivalent to \fBdl_dst=*\fR.)
355 .RE
356 .
357 .IP \fBdl_type=\fIethertype\fR
358 Matches Ethernet protocol type \fIethertype\fR, which is specified as an
359 integer between 0 and 65535, inclusive, either in decimal or as a 
360 hexadecimal number prefixed by \fB0x\fR (e.g. \fB0x0806\fR to match ARP 
361 packets).
362 .
363 .IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
364 .IQ \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
365 When \fBdl_type\fR is 0x0800 (possibly via shorthand, e.g. \fBip\fR
366 or \fBtcp\fR), matches IPv4 source (or destination) address \fIip\fR,
367 which may be specified as an IP address or host name
368 (e.g. \fB192.168.1.1\fR or \fBwww.example.com\fR).  The optional
369 \fInetmask\fR allows restricting a match to an IPv4 address prefix.
370 The netmask may be specified as a dotted quad
371 (e.g. \fB192.168.1.0/255.255.255.0\fR) or as a CIDR block
372 (e.g. \fB192.168.1.0/24\fR).
373 .IP
374 When \fBdl_type=0x0806\fR or \fBarp\fR is specified, matches the
375 \fBar_spa\fR or \fBar_tpa\fR field, respectively, in ARP packets for
376 IPv4 and Ethernet.
377 .IP
378 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800
379 or 0x0806, the values of \fBnw_src\fR and \fBnw_dst\fR are ignored
380 (see \fBFlow Syntax\fR above).
381 .
382 .IP \fBnw_proto=\fIproto\fR
383 When \fBip\fR or \fBdl_type=0x0800\fR is specified, matches IP
384 protocol type \fIproto\fR, which is specified as a decimal number
385 between 0 and 255, inclusive (e.g. 1 to match ICMP packets or 6 to match
386 TCP packets).
387 .IP
388 When \fBipv6\fR or \fBdl_type=0x86dd\fR is specified, matches IPv6
389 header type \fIproto\fR, which is specified as a decimal number between
390 0 and 255, inclusive (e.g. 58 to match ICMPv6 packets or 6 to match
391 TCP).  The header type is the terminal header as described in the
392 \fBDESIGN\fR document.
393 .IP
394 When \fBarp\fR or \fBdl_type=0x0806\fR is specified, matches the lower
395 8 bits of the ARP opcode.  ARP opcodes greater than 255 are treated as
396 0.
397 .IP
398 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800,
399 0x0806, or 0x86dd, the value of \fBnw_proto\fR is ignored (see \fBFlow
400 Syntax\fR above).
401 .
402 .IP \fBnw_tos=\fItos\fR
403 Matches IP ToS/DSCP or IPv6 traffic class field \fItos\fR, which is
404 specified as a decimal number between 0 and 255, inclusive.  Note that
405 the two lower reserved bits are ignored for matching purposes.
406 .IP
407 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800,
408 0x0806, or 0x86dd, the value of \fBnw_tos\fR is ignored (see \fBFlow
409 Syntax\fR above).
410 .
411 .IP \fBtp_src=\fIport\fR
412 .IQ \fBtp_dst=\fIport\fR
413 When \fBdl_type\fR and \fBnw_proto\fR specify TCP or UDP, \fBtp_src\fR
414 and \fBtp_dst\fR match the UDP or TCP source or destination port
415 \fIport\fR, respectively. which is specified as a decimal number
416 between 0 and 65535, inclusive (e.g. 80 to match packets originating
417 from a HTTP server).
418 .IP
419 When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
420 these settings are ignored (see \fBFlow Syntax\fR above).
421 .
422 .IP \fBicmp_type=\fItype\fR
423 .IQ \fBicmp_code=\fIcode\fR
424 When \fBdl_type\fR and \fBnw_proto\fR specify ICMP or ICMPv6, \fItype\fR
425 matches the ICMP type and \fIcode\fR matches the ICMP code.  Each is
426 specified as a decimal number between 0 and 255, inclusive.
427 .IP
428 When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
429 these settings are ignored (see \fBFlow Syntax\fR above).
430 .
431 .IP \fBtable=\fInumber\fR
432 If specified, limits the flow manipulation and flow dump commands to
433 only apply to the table with the given \fInumber\fR.
434 \fInumber\fR is a number between 0 and 254, inclusive.
435 .
436 Behavior varies if \fBtable\fR is not specified.  For flow table
437 modification commands without \fB\-\-strict\fR, the switch will choose
438 the table for these commands to operate on.  For flow table
439 modification commands with \fB\-\-strict\fR, the command will operate
440 on any single matching flow in any table; it will do nothing if there
441 are matches in more than one table.  The \fBdump-flows\fR and
442 \fBdump-aggregate\fR commands will gather statistics about flows from
443 all tables.
444 .IP
445 When this field is specified in \fBadd-flow\fR, \fBadd-flows\fR,
446 \fBmod-flows\fR and \fBdel-flows\fR commands, it activates a Nicira
447 extension to OpenFlow, which as of this writing is only known to be
448 implemented by Open vSwitch.
449 .
450 .PP
451 The following shorthand notations are also available:
452 .
453 .IP \fBip\fR
454 Same as \fBdl_type=0x0800\fR.
455 .
456 .IP \fBicmp\fR
457 Same as \fBdl_type=0x0800,nw_proto=1\fR.
458 .
459 .IP \fBtcp\fR
460 Same as \fBdl_type=0x0800,nw_proto=6\fR.
461 .
462 .IP \fBudp\fR
463 Same as \fBdl_type=0x0800,nw_proto=17\fR.
464 .
465 .IP \fBarp\fR
466 Same as \fBdl_type=0x0806\fR.
467 .
468 .PP
469 The following field assignments require support for the NXM (Nicira
470 Extended Match) extension to OpenFlow.  When one of these is specified,
471 \fBovs\-ofctl\fR will automatically attempt to negotiate use of this
472 extension.  If the switch does not support NXM, then \fBovs\-ofctl\fR
473 will report a fatal error.
474 .
475 .IP \fBvlan_tci=\fItci\fR[\fB/\fImask\fR]
476 Matches modified VLAN TCI \fItci\fR.  If \fImask\fR is omitted,
477 \fItci\fR is the exact VLAN TCI to match; if \fImask\fR is specified,
478 then a 1-bit in \fItci\fR indicates that the corresponding bit in
479 \fItci\fR must match exactly, and a 0-bit wildcards that bit.  Both
480 \fItci\fR and \fImask\fR are 16-bit values that are decimal by
481 default; use a \fB0x\fR prefix to specify them in hexadecimal.
482 .
483 .IP
484 The value that \fBvlan_tci\fR matches against is 0 for a packet that
485 has no 802.1Q header.  Otherwise, it is the TCI value from the 802.1Q
486 header with the CFI bit (with value \fB0x1000\fR) forced to 1.
487 .IP
488 Examples:
489 .RS
490 .IP \fBvlan_tci=0\fR
491 Match only packets without an 802.1Q header.
492 .IP \fBvlan_tci=0xf123\fR
493 Match packets tagged with priority 7 in VLAN 0x123.
494 .IP \fBvlan_tci=0x1123/0x1fff\fR
495 Match packets tagged with VLAN 0x123 (and any priority).
496 .IP \fBvlan_tci=0x5000/0xf000\fR
497 Match packets tagged with priority 2 (in any VLAN).
498 .IP \fBvlan_tci=0/0xfff\fR
499 Match packets with no 802.1Q header or tagged with VLAN 0 (and any
500 priority).
501 .IP \fBvlan_tci=0x5000/0xe000\fR
502 Match packets with no 802.1Q header or tagged with priority 2 (in any
503 VLAN).
504 .IP \fBvlan_tci=0/0xefff\fR
505 Match packets with no 802.1Q header or tagged with VLAN 0 and priority
506 0.
507 .RE
508 .IP
509 Some of these matching possibilities can also be achieved with
510 \fBdl_vlan\fR and \fBdl_vlan_pcp\fR.
511 .
512 .IP \fBip_frag=\fIfrag_type\fR
513 When \fBdl_type\fR specifies IP or IPv6, \fIfrag_type\fR
514 specifies what kind of IP fragments or non-fragments to match.  The
515 following values of \fIfrag_type\fR are supported:
516 .RS
517 .IP "\fBno\fR"
518 Matches only non-fragmented packets.
519 .IP "\fByes\fR"
520 Matches all fragments.
521 .IP "\fBfirst\fR"
522 Matches only fragments with offset 0.
523 .IP "\fBlater\fR"
524 Matches only fragments with nonzero offset.
525 .IP "\fBnot_later\fR"
526 Matches non-fragmented packets and fragments with zero offset.
527 .RE
528 .IP
529 The \fBip_frag\fR match type is likely to be most useful in
530 \fBnx\-match\fR mode.  See the description of the \fBset\-frags\fR
531 command, above, for more details.
532 .
533 .IP \fBarp_sha=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
534 .IQ \fBarp_tha=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
535 When \fBdl_type\fR specifies ARP, \fBarp_sha\fR and \fBarp_tha\fR match
536 the source and target hardware address, respectively.  An address is
537 specified as 6 pairs of hexadecimal digits delimited by colons.
538 .
539 .IP \fBipv6_src=\fIipv6\fR[\fB/\fInetmask\fR]
540 .IQ \fBipv6_dst=\fIipv6\fR[\fB/\fInetmask\fR]
541 When \fBdl_type\fR is 0x86dd (possibly via shorthand, e.g., \fBipv6\fR
542 or \fBtcp6\fR), matches IPv6 source (or destination) address \fIipv6\fR,
543 which may be specified as defined in RFC 2373.  The preferred format is 
544 \fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fB:\fIx\fR, where
545 \fIx\fR are the hexadecimal values of the eight 16-bit pieces of the
546 address.  A single instance of \fB::\fR may be used to indicate multiple
547 groups of 16-bits of zeros.  The optional \fInetmask\fR allows
548 restricting a match to an IPv6 address prefix.  A netmask is specified
549 as a CIDR block (e.g. \fB2001:db8:3c4d:1::/64\fR).
550 .
551 .IP \fBnd_target=\fIipv6\fR
552 When \fBdl_type\fR, \fBnw_proto\fR, and \fBicmp_type\fR specify
553 IPv6 Neighbor Discovery (ICMPv6 type 135 or 136), matches the target address
554 \fIipv6\fR.  \fIipv6\fR is in the same format described earlier for the
555 \fBipv6_src\fR and \fBipv6_dst\fR fields.
556 .
557 .IP \fBnd_sll=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
558 When \fBdl_type\fR, \fBnw_proto\fR, and \fBicmp_type\fR specify IPv6
559 Neighbor Solicitation (ICMPv6 type 135), matches the source link\-layer
560 address option.  An address is specified as 6 pairs of hexadecimal
561 digits delimited by colons.
562 .
563 .IP \fBnd_tll=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
564 When \fBdl_type\fR, \fBnw_proto\fR, and \fBicmp_type\fR specify IPv6
565 Neighbor Advertisement (ICMPv6 type 136), matches the target link\-layer
566 address option.  An address is specified as 6 pairs of hexadecimal
567 digits delimited by colons.
568 .
569 .IP \fBtun_id=\fItunnel-id\fR[\fB/\fImask\fR]
570 Matches tunnel identifier \fItunnel-id\fR.  Only packets that arrive
571 over a tunnel that carries a key (e.g. GRE with the RFC 2890 key
572 extension) will have a nonzero tunnel ID.  If \fImask\fR is omitted,
573 \fItunnel-id\fR is the exact tunnel ID to match; if \fImask\fR is
574 specified, then a 1-bit in \fImask\fR indicates that the corresponding
575 bit in \fItunnel-id\fR must match exactly, and a 0-bit wildcards that
576 bit.
577 .IP
578 In an attempt to be compatible with more switches, \fBovs\-ofctl\fR will
579 prefer to use the ``tunnel ID from cookie'' Nicira extension to NXM.
580 The use of this extension comes with three caveats: the top 32 bits of
581 the \fBcookie\fR (see below) are used for \fItunnel-id\fR and thus
582 unavailable for other use, specifying \fBtun_id\fR on \fBdump\-flows\fR
583 or \fBdump\-aggregate\fR has no effect, and \fImask\fR is not supported.
584 If any of these caveats apply, \fBovs-ofctl\fR will use NXM.
585 .
586 .IP "\fBreg\fIidx\fB=\fIvalue\fR[\fB/\fImask\fR]"
587 Matches \fIvalue\fR either exactly or with optional \fImask\fR in
588 register number \fIidx\fR.  The valid range of \fIidx\fR depends on
589 the switch.  \fIvalue\fR and \fImask\fR are 32-bit integers, by
590 default in decimal (use a \fB0x\fR prefix to specify hexadecimal).
591 Arbitrary \fImask\fR values are allowed: a 1-bit in \fImask\fR
592 indicates that the corresponding bit in \fIvalue\fR must match
593 exactly, and a 0-bit wildcards that bit.
594 .IP
595 When a packet enters an OpenFlow switch, all of the registers are set
596 to 0.  Only explicit Nicira extension actions change register values.
597 .
598 .PP
599 Defining IPv6 flows (those with \fBdl_type\fR equal to 0x86dd) requires
600 support for NXM.  The following shorthand notations are available for
601 IPv6-related flows:
602 .
603 .IP \fBipv6\fR
604 Same as \fBdl_type=0x86dd\fR.
605 .
606 .IP \fBtcp6\fR
607 Same as \fBdl_type=0x86dd,nw_proto=6\fR.
608 .
609 .IP \fBudp6\fR
610 Same as \fBdl_type=0x86dd,nw_proto=17\fR.
611 .
612 .IP \fBicmp6\fR
613 Same as \fBdl_type=0x86dd,nw_proto=58\fR.
614 .
615 .PP
616 Finally, field assignments to \fBduration\fR, \fBn_packets\fR, or
617 \fBn_bytes\fR are ignored to allow output from the \fBdump\-flows\fR
618 command to be used as input for other commands that parse flows.
619 .
620 .PP
621 The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands
622 require an additional field, which must be the final field specified:
623 .
624 .IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR
625 Specifies a comma-separated list of actions to take on a packet when the 
626 flow entry matches.  If no \fItarget\fR is specified, then packets
627 matching the flow are dropped.  The \fItarget\fR may be a decimal port 
628 number designating the physical port on which to output the packet, or one 
629 of the following keywords:
630 .
631 .RS
632 .IP \fBoutput\fR:\fIport\fR
633 .IQ \fBoutput\fR:\fIsrc\fB[\fIstart\fB..\fIend\fB]
634 Outputs the packet. If \fIport\fR is an OpenFlow port number, outputs directly
635 to it.  Otherwise, outputs to the OpenFlow port number read from \fIsrc\fR
636 which must be an NXM field as described above.  Outputting to an NXM field is
637 an OpenFlow extension which is not supported by standard OpenFlow switches.
638 .IP
639 Example: \fBoutput:NXM_NX_REG0[16..31]\fR outputs to the OpenFlow port number
640 written in the upper half of register 0.
641 .
642 .IP \fBenqueue\fR:\fIport\fB:\fIqueue\fR
643 Enqueues the packet on the specified \fIqueue\fR within port
644 \fIport\fR.  The number of supported queues depends on the switch;
645 some OpenFlow implementations do not support queuing at all.
646 .
647 .IP \fBnormal\fR
648 Subjects the packet to the device's normal L2/L3 processing.  (This
649 action is not implemented by all OpenFlow switches.)
650 .
651 .IP \fBflood\fR
652 Outputs the packet on all switch physical ports other than the port on
653 which it was received and any ports on which flooding is disabled
654 (typically, these would be ports disabled by the IEEE 802.1D spanning
655 tree protocol).
656 .
657 .IP \fBall\fR
658 Outputs the packet on all switch physical ports other than the port on
659 which it was received.
660 .
661 .IP \fBcontroller\fR:\fImax_len\fR
662 Sends the packet to the OpenFlow controller as a ``packet in''
663 message.  If \fImax_len\fR is a number, then it specifies the maximum
664 number of bytes that should be sent.  If \fImax_len\fR is \fBALL\fR or
665 omitted, then the entire packet is sent.
666 .
667 .IP \fBlocal\fR
668 Outputs the packet on the ``local port,'' which corresponds to the
669 network device that has the same name as the bridge.
670 .
671 .IP \fBin_port\fR
672 Outputs the packet on the port from which it was received.
673 .
674 .IP \fBdrop\fR
675 Discards the packet, so no further processing or forwarding takes place.
676 If a drop action is used, no other actions may be specified.
677 .
678 .IP \fBmod_vlan_vid\fR:\fIvlan_vid\fR
679 Modifies the VLAN id on a packet.  The VLAN tag is added or modified 
680 as necessary to match the value specified.  If the VLAN tag is added,
681 a priority of zero is used (see the \fBmod_vlan_pcp\fR action to set
682 this).
683 .
684 .IP \fBmod_vlan_pcp\fR:\fIvlan_pcp\fR
685 Modifies the VLAN priority on a packet.  The VLAN tag is added or modified 
686 as necessary to match the value specified.  Valid values are between 0
687 (lowest) and 7 (highest).  If the VLAN tag is added, a vid of zero is used 
688 (see the \fBmod_vlan_vid\fR action to set this).
689 .
690 .IP \fBstrip_vlan\fR
691 Strips the VLAN tag from a packet if it is present.
692 .
693 .IP \fBmod_dl_src\fB:\fImac\fR
694 Sets the source Ethernet address to \fImac\fR.
695 .
696 .IP \fBmod_dl_dst\fB:\fImac\fR
697 Sets the destination Ethernet address to \fImac\fR.
698 .
699 .IP \fBmod_nw_src\fB:\fIip\fR
700 Sets the IPv4 source address to \fIip\fR.
701 .
702 .IP \fBmod_nw_dst\fB:\fIip\fR
703 Sets the IPv4 destination address to \fIip\fR.
704 .
705 .IP \fBmod_tp_src\fB:\fIport\fR
706 Sets the TCP or UDP source port to \fIport\fR.
707 .
708 .IP \fBmod_tp_dst\fB:\fIport\fR
709 Sets the TCP or UDP destination port to \fIport\fR.
710 .
711 .IP \fBmod_nw_tos\fB:\fItos\fR
712 Sets the IP ToS/DSCP field to \fItos\fR.  Valid values are between 0 and
713 255, inclusive.  Note that the two lower reserved bits are never
714 modified.
715 .
716 .RE
717 .IP
718 The following actions are Nicira vendor extensions that, as of this writing, are
719 only known to be implemented by Open vSwitch:
720 .
721 .RS
722 .
723 .IP \fBresubmit\fB:\fIport\fR
724 .IQ \fBresubmit\fB(\fR[\fIport\fR]\fB,\fR[\fItable\fR]\fB)
725 Re-searches this OpenFlow flow table (or the table whose number is
726 specified by \fItable\fR) with the \fBin_port\fR field replaced by
727 \fIport\fR (if \fIport\fR is specified) and executes the actions
728 found, if any, in addition to any other actions in this flow entry.
729 .IP
730 Recursive \fBresubmit\fR actions are obeyed up to an
731 implementation-defined maximum depth.  Open vSwitch 1.0.1 and earlier
732 did not support recursion; Open vSwitch before 1.2.90 did not support
733 \fItable\fR.
734 .
735 .IP \fBset_tunnel\fB:\fIid\fR
736 .IQ \fBset_tunnel64\fB:\fIid\fR
737 If outputting to a port that encapsulates the packet in a tunnel and
738 supports an identifier (such as GRE), sets the identifier to \fIid\fR.
739 If the \fBset_tunnel\fR form is used and \fIid\fR fits in 32 bits,
740 then this uses an action extension that is supported by Open vSwitch
741 1.0 and later.  Otherwise, if \fIid\fR is a 64-bit value, it requires
742 Open vSwitch 1.1 or later.
743 .
744 .IP \fBset_queue\fB:\fIqueue\fR
745 Sets the queue that should be used to \fIqueue\fR when packets are
746 output.  The number of supported queues depends on the switch; some
747 OpenFlow implementations do not support queuing at all.
748 .
749 .IP \fBpop_queue\fR
750 Restores the queue to the value it was before any \fBset_queue\fR
751 actions were applied.
752 .
753 .IP \fBnote:\fR[\fIhh\fR]...
754 Does nothing at all.  Any number of bytes represented as hex digits
755 \fIhh\fR may be included.  Pairs of hex digits may be separated by
756 periods for readability.
757 .
758 .IP "\fBmove:\fIsrc\fB[\fIstart\fB..\fIend\fB]\->\fIdst\fB[\fIstart\fB..\fIend\fB]\fR"
759 Copies the named bits from field \fIsrc\fR to field \fIdst\fR.
760 \fIsrc\fR and \fIdst\fR must be NXM field names as defined in
761 \fBnicira\-ext.h\fR, e.g. \fBNXM_OF_UDP_SRC\fR or \fBNXM_NX_REG0\fR.
762 Each \fIstart\fR and \fIend\fR pair, which are inclusive, must specify
763 the same number of bits and must fit within its respective field.
764 Shorthands for \fB[\fIstart\fB..\fIend\fB]\fR exist: use
765 \fB[\fIbit\fB]\fR to specify a single bit or \fB[]\fR to specify an
766 entire field.
767 .IP
768 Examples: \fBmove:NXM_NX_REG0[0..5]\->NXM_NX_REG1[26..31]\fR copies the
769 six bits numbered 0 through 5, inclusive, in register 0 into bits 26
770 through 31, inclusive;
771 \fBmove:NXM_NX_REG0[0..15]\->NXM_OF_VLAN_TCI[]\fR copies the least
772 significant 16 bits of register 0 into the VLAN TCI field.
773 .
774 .IP "\fBload:\fIvalue\fB\->\fIdst\fB[\fIstart\fB..\fIend\fB]"
775 Writes \fIvalue\fR to bits \fIstart\fR through \fIend\fR, inclusive,
776 in field \fIdst\fR.
777 .IP
778 Example: \fBload:55\->NXM_NX_REG2[0..5]\fR loads value 55 (bit pattern
779 \fB110111\fR) into bits 0 through 5, inclusive, in register 2.
780 .
781 .IP "\fBmultipath(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIn_links\fB, \fIarg\fB, \fIdst\fB[\fIstart\fB..\fIend\fB])\fR"
782 Hashes \fIfields\fR using \fIbasis\fR as a universal hash parameter,
783 then the applies multipath link selection \fIalgorithm\fR (with
784 parameter \fIarg\fR) to choose one of \fIn_links\fR output links
785 numbered 0 through \fIn_links\fR minus 1, and stores the link into
786 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as
787 described above.
788 .IP
789 Currently, \fIfields\fR must be either \fBeth_src\fR or
790 \fBsymmetric_l4\fR and \fIalgorithm\fR must be one of \fBmodulo_n\fR,
791 \fBhash_threshold\fR, \fBhrw\fR, and \fBiter_hash\fR.  Only
792 the \fBiter_hash\fR algorithm uses \fIarg\fR.
793 .IP
794 Refer to \fBnicira\-ext.h\fR for more details.
795 .
796 .IP "\fBautopath(\fIid\fB, \fIdst\fB[\fIstart\fB..\fIend\fB])\fR"
797 Given \fIid\fR, chooses an OpenFlow port and populates it in
798 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as
799 described above.
800 .IP
801 Currently, \fIid\fR should be the OpenFlow port number of an interface on the
802 bridge.  If it isn't then \fIdst\fB[\fIstart\fB..\fIend\fB]\fR will be
803 populated with the OpenFlow port "none".  If \fIid\fR is a member of a bond,
804 the normal bond selection logic will be used to choose the destination port.
805 Otherwise, the register will be populated with \fIid\fR itself.
806 .IP
807 Refer to \fBnicira\-ext.h\fR for more details.
808 .
809 .IP "\fBbundle(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIslave_type\fB, slaves:[\fIs1\fB, \fIs2\fB, ...])\fR"
810 Hashes \fIfields\fR using \fIbasis\fR as a universal hash parameter, then
811 applies the bundle link selection \fIalgorithm\fR to choose one of the listed
812 slaves represented as \fIslave_type\fR.  Currently the only supported
813 \fIslave_type\fR is \fBofport\fR.  Thus, each \fIs1\fR through \fIsN\fR should
814 be an OpenFlow port number. Outputs to the selected slave.
815 .IP
816 Currently, \fIfields\fR must be either \fBeth_src\fR or \fBsymmetric_l4\fR and
817 \fIalgorithm\fR must be one of \fBhrw\fR and \fBactive_backup\fR.
818 .IP
819 Example: \fBbundle(eth_src,0,hrw,ofport,slaves:4,8)\fR uses an Ethernet source
820 hash with basis 0, to select between OpenFlow ports 4 and 8 using the Highest
821 Random Weight algorithm.
822 .IP
823 Refer to \fBnicira\-ext.h\fR for more details.
824 .
825 .IP "\fBbundle_load(\fIfields\fB, \fIbasis\fB, \fIalgorithm\fB, \fIslave_type\fB, \fIdst\fB[\fIstart\fB..\fIend\fB], slaves:[\fIs1\fB, \fIs2\fB, ...])\fR"
826 Has the same behavior as the \fBbundle\fR action, with one exception.  Instead
827 of outputting to the selected slave, it writes its selection to
828 \fIdst\fB[\fIstart\fB..\fIend\fB]\fR, which must be an NXM field as described
829 above.
830 .IP
831 Example: \fBbundle_load(eth_src, 0, hrw, ofport, NXM_NX_REG0[],
832 slaves:4, 8)\fR uses an Ethernet source hash with basis 0, to select
833 between OpenFlow ports 4 and 8 using the Highest Random Weight
834 algorithm, and writes the selection to \fBNXM_NX_REG0[]\fR.
835 .IP
836 Refer to \fBnicira\-ext.h\fR for more details.
837 .
838 .IP "\fBlearn(\fIargument\fR[\fB,\fIargument\fR]...\fB)\fR"
839 This action adds or modifies a flow in an OpenFlow table, similar to
840 \fBovs\-ofctl \-\-strict mod\-flows\fR.  The arguments specify the
841 flow's match fields, actions, and other properties, as follows.  At
842 least one match criterion and one action argument should ordinarily be
843 specified.
844 .RS
845 .IP \fBidle_timeout=\fIseconds\fR
846 .IQ \fBhard_timeout=\fIseconds\fR
847 .IQ \fBpriority=\fIvalue\fR
848 These key-value pairs have the same meaning as in the usual
849 \fBovs\-ofctl\fR flow syntax.
850 .
851 .IP \fBtable=\fInumber\fR
852 The table in which the new flow should be inserted.  Specify a decimal
853 number between 0 and 254.  The default, if \fBtable\fR is unspecified,
854 is table 1.
855 .
856 .IP \fIfield\fB=\fIvalue\fR
857 .IQ \fIfield\fB[\fIstart\fB..\fIend\fB]=\fIsrc\fB[\fIstart\fB..\fIend\fB]\fR
858 .IQ \fIfield\fB[\fIstart\fB..\fIend\fB]\fR
859 Adds a match criterion to the new flow.
860 .IP
861 The first form specifies that \fIfield\fR must match the literal
862 \fIvalue\fR, e.g. \fBdl_type=0x0800\fR.  All of the fields and values
863 for \fBovs\-ofctl\fR flow syntax are available with their usual
864 meanings.
865 .IP
866 The second form specifies that \fIfield\fB[\fIstart\fB..\fIend\fB]\fR
867 in the new flow must match \fIsrc\fB[\fIstart\fB..\fIend\fB]\fR taken
868 from the flow currently being processed.
869 .IP
870 The third form is a shorthand for the second form.  It specifies that
871 \fIfield\fB[\fIstart\fB..\fIend\fB]\fR in the new flow must match
872 \fIfield\fB[\fIstart\fB..\fIend\fB]\fR taken from the flow currently
873 being processed.
874 .
875 .IP \fBload:\fIvalue\fB\->\fIdst\fB[\fIstart\fB..\fIend\fB]
876 .IQ \fBload:\fIsrc\fB[\fIstart\fB..\fIend\fB]\->\fIdst\fB[\fIstart\fB..\fIend\fB]
877 .
878 Adds a \fBload\fR action to the new flow.
879 .IP
880 The first form loads the literal \fIvalue\fR into bits \fIstart\fR
881 through \fIend\fR, inclusive, in field \fIdst\fR.  Its syntax is the
882 same as the \fBload\fR action described earlier in this section.
883 .IP
884 The second form loads \fIsrc\fB[\fIstart\fB..\fIend\fB]\fR, a value
885 from the flow currently being processed, into bits \fIstart\fR
886 through \fIend\fR, inclusive, in field \fIdst\fR.
887 .
888 .IP \fBoutput:\fIfield\fB[\fIstart\fB..\fIend\fB]\fR
889 Add an \fBoutput\fR action to the new flow's actions, that outputs to
890 the OpenFlow port taken from \fIfield\fB[\fIstart\fB..\fIend\fB]\fR,
891 which must be an NXM field as described above.
892 .RE
893 .IP
894 For best performance, segregate learned flows into a table (using
895 \fBtable=\fInumber\fR) that is not used for any other flows except
896 possibly for a lowest-priority ``catch-all'' flow, that is, a flow
897 with no match criteria.  (This is why the default \fBtable\fR is 1, to
898 keep the learned flows separate from the primary flow table 0.)
899 .RE
900 .
901 .IP "\fBexit\fR"
902 This action causes Open vSwitch to immediately halt execution of further
903 actions.  Those actions which have already been executed are unaffected.  Any
904 further actions, including those which may be in other tables, or different
905 levels of the \fBresubmit\fR call stack, are ignored.
906 .
907 .PP
908 The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands
909 support an additional optional field:
910 .
911 .IP \fBcookie=\fIvalue\fR
912 .
913 A cookie is an opaque identifier that can be associated with the flow.
914 \fIvalue\fR can be any 64-bit number and need not be unique among
915 flows.  If this field is omitted, these commands set a default cookie
916 value of 0.
917 .
918 .PP
919 The following additional field sets the priority for flows added by
920 the \fBadd\-flow\fR and \fBadd\-flows\fR commands.  For
921 \fBmod\-flows\fR and \fBdel\-flows\fR when \fB\-\-strict\fR is
922 specified, priority must match along with the rest of the flow
923 specification.  Other commands do not allow priority to be specified.
924 .
925 .IP \fBpriority=\fIvalue\fR
926 The priority at which a wildcarded entry will match in comparison to
927 others.  \fIvalue\fR is a number between 0 and 65535, inclusive.  A higher 
928 \fIvalue\fR will match before a lower one.  An exact-match entry will always 
929 have priority over an entry containing wildcards, so it has an implicit 
930 priority value of 65535.  When adding a flow, if the field is not specified, 
931 the flow's priority will default to 32768.
932 .
933 .PP
934 The \fBadd\-flow\fR and \fBadd\-flows\fR commands support additional
935 optional fields:
936 .
937 .TP
938 \fBidle_timeout=\fIseconds\fR
939 Causes the flow to expire after the given number of seconds of
940 inactivity.  A value of 0 (the default) prevents a flow from expiring due to
941 inactivity.
942 .
943 .IP \fBhard_timeout=\fIseconds\fR
944 Causes the flow to expire after the given number of seconds,
945 regardless of activity.  A value of 0 (the default) gives the flow no
946 hard expiration deadline.
947 .
948 .PP
949 The \fBdump\-flows\fR, \fBdump\-aggregate\fR, \fBdel\-flow\fR 
950 and \fBdel\-flows\fR commands support one additional optional field:
951 .
952 .TP
953 \fBout_port=\fIport\fR
954 If set, a matching flow must include an output action to \fIport\fR.
955 .
956 .SS "Table Entry Output"
957 .
958 The \fBdump\-tables\fR and \fBdump\-aggregate\fR commands print information 
959 about the entries in a datapath's tables.  Each line of output is a 
960 unique flow entry, which begins with some common information:
961 .
962 .IP \fBduration\fR
963 The number of seconds the entry has been in the table.
964 .
965 .IP \fBtable_id\fR
966 The table that contains the flow.  When a packet arrives, the switch 
967 begins searching for an entry at the lowest numbered table.  Tables are 
968 numbered as shown by the \fBdump\-tables\fR command.
969 .
970 .IP \fBpriority\fR
971 The priority of the entry in relation to other entries within the same
972 table.  A higher value will match before a lower one.
973 .
974 .IP \fBn_packets\fR
975 The number of packets that have matched the entry.
976 .
977 .IP \fBn_bytes\fR
978 The total number of bytes from packets that have matched the entry.
979 .
980 .PP
981 The rest of the line consists of a description of the flow entry as 
982 described in \fBFlow Syntax\fR, above.
983 .
984 .
985 .SH OPTIONS
986 .TP
987 \fB\-\-strict\fR
988 Uses strict matching when running flow modification commands.
989 .
990 .IP "\fB\-F \fIformat\fR"
991 .IQ "\fB\-\-flow\-format=\fIformat\fR"
992 \fBovs\-ofctl\fR supports the following flow formats, in order of
993 increasing capability:
994 .RS
995 .IP "\fBopenflow10\fR"
996 This is the standard OpenFlow 1.0 flow format.  It should be supported
997 by all OpenFlow switches.
998 .
999 .IP "\fBnxm\fR (Nicira Extended Match)"
1000 This Nicira extension to OpenFlow is flexible and extensible.  It
1001 supports all of the Nicira flow extensions, such as \fBtun_id\fR and
1002 registers.
1003 .RE
1004 .IP
1005 Usually, \fBovs\-ofctl\fR picks the correct format automatically.  For
1006 commands that modify the flow table, \fBovs\-ofctl\fR by default uses
1007 the most widely supported flow format that supports the flows being
1008 added.  For commands that query the flow table, \fBovs\-ofctl\fR by
1009 default queries and uses the most advanced format supported by the
1010 switch.
1011 .IP
1012 This option, where \fIformat\fR is one of the formats listed in the
1013 above table, overrides \fBovs\-ofctl\fR's default choice of flow
1014 format.  If a command cannot work as requested using the requested
1015 flow format, \fBovs\-ofctl\fR will report a fatal error.
1016 .
1017 .IP "\fB\-m\fR"
1018 .IQ "\fB\-\-more\fR"
1019 Increases the verbosity of OpenFlow messages printed and logged by
1020 \fBovs\-ofctl\fR commands.  Specify this option more than once to
1021 increase verbosity further.
1022 .SS "Public Key Infrastructure Options"
1023 .so lib/ssl.man
1024 .so lib/vlog.man
1025 .so lib/common.man
1026 .
1027 .SH EXAMPLES
1028 .
1029 The following examples assume that \fBovs\-vswitchd\fR has a bridge
1030 named \fBbr0\fR configured.
1031 .
1032 .TP
1033 \fBovs\-ofctl dump\-tables br0\fR
1034 Prints out the switch's table stats.  (This is more interesting after
1035 some traffic has passed through.)
1036 .
1037 .TP
1038 \fBovs\-ofctl dump\-flows br0\fR
1039 Prints the flow entries in the switch.
1040 .
1041 .SH "SEE ALSO"
1042 .
1043 .BR ovs\-appctl (8),
1044 .BR ovs\-controller (8),
1045 .BR ovs\-vswitchd (8)