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