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