]> git.proxmox.com Git - mirror_ovs.git/blame - utilities/ovs-ofctl.8.in
classifier: Implement better classifier rule formatting.
[mirror_ovs.git] / utilities / ovs-ofctl.8.in
CommitLineData
a9b4a41a
BP
1.\" -*- nroff -*-
2.de IQ
3. br
4. ns
5. IP "\\$1"
6..
834377ea 7.TH ovs\-ofctl 8 "January 2010" "Open vSwitch" "Open vSwitch Manual"
064af421 8.ds PN ovs\-ofctl
a9b4a41a 9.
064af421
BP
10.SH NAME
11ovs\-ofctl \- administer OpenFlow switches
a9b4a41a 12.
064af421
BP
13.SH SYNOPSIS
14.B ovs\-ofctl
15[\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
a9b4a41a 16.
064af421
BP
17.SH DESCRIPTION
18The
19.B ovs\-ofctl
20program is a command line tool for monitoring and administering
21OpenFlow switches. It can also show the current state of an OpenFlow
22switch, including features, configuration, and table entries.
a9b4a41a 23.
064af421 24.SS "OpenFlow Switch Management Commands"
a9b4a41a 25.PP
064af421
BP
26These commands allow \fBovs\-ofctl\fR to monitor and administer an OpenFlow
27switch. It is able to show the current state of a switch, including
28features, configuration, and table entries.
a9b4a41a 29.PP
064af421
BP
30Most of these commands take an argument that specifies the method for
31connecting to an OpenFlow switch. The following connection methods
32are supported:
a9b4a41a 33.
064af421 34.RS
84ee7bcf
BP
35.so lib/vconn-active.man
36.
064af421
BP
37.IP "\fIfile\fR"
38This is short for \fBunix:\fIfile\fR, as long as \fIfile\fR does not
39contain a colon.
84ee7bcf 40.
1a6f1e2a
JG
41.IP \fIbridge\fR
42This 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
46Attempts to look up the bridge associated with \fIdp\fR and open as
47above. If \fItype\fR is given, it specifies the datapath provider of
48\fIdp\fR, otherwise the default provider \fBsystem\fR is assumed.
064af421 49.RE
a9b4a41a 50.
064af421
BP
51.TP
52\fBshow \fIswitch\fR
53Prints to the console information on \fIswitch\fR, including
54information on its flow tables and ports.
a9b4a41a 55.
064af421
BP
56.TP
57\fBstatus \fIswitch\fR [\fIkey\fR]
58Prints to the console a series of key-value pairs that report the
59status of \fIswitch\fR. If \fIkey\fR is specified, only the key-value
60pairs whose key names begin with \fIkey\fR are printed. If \fIkey\fR is
61omitted, all key-value pairs are printed.
a9b4a41a 62.
064af421 63.TP
4e312e69 64\fBdump\-tables \fIswitch\fR
064af421
BP
65Prints to the console statistics for each of the flow tables used by
66\fIswitch\fR.
a9b4a41a 67.
064af421 68.TP
4e312e69 69\fBdump\-ports \fIswitch\fR [\fInetdev\fR]
abaad8cf
JP
70Prints to the console statistics for network devices associated with
71\fIswitch\fR. If \fInetdev\fR is specified, only the statistics
72associated with that device will be printed. \fInetdev\fR can be an
73OpenFlow assigned port number or device name, e.g. \fBeth0\fR.
a9b4a41a 74.
064af421 75.TP
4e312e69 76\fBmod\-port \fIswitch\fR \fInetdev\fR \fIaction\fR
064af421
BP
77Modify characteristics of an interface monitored by \fIswitch\fR.
78\fInetdev\fR can be referred to by its OpenFlow assigned port number or
79the device name, e.g. \fBeth0\fR. The \fIaction\fR may be any one of the
80following:
a9b4a41a 81.
064af421
BP
82.RS
83.IP \fBup\fR
84Enables the interface. This is equivalent to ``ifconfig up'' on a Unix
85system.
a9b4a41a 86.
064af421
BP
87.IP \fBdown\fR
88Disables the interface. This is equivalent to ``ifconfig down'' on a Unix
89system.
a9b4a41a 90.
064af421
BP
91.IP \fBflood\fR
92When a \fIflood\fR action is specified, traffic will be sent out this
93interface. This is the default posture for monitored ports.
a9b4a41a 94.
064af421
BP
95.IP \fBnoflood\fR
96When a \fIflood\fR action is specified, traffic will not be sent out
97this interface. This is primarily useful to prevent loops when a
98spanning tree protocol is not in use.
a9b4a41a 99.
064af421 100.RE
a9b4a41a 101.
064af421 102.TP
4e312e69 103\fBdump\-flows \fIswitch \fR[\fIflows\fR]
064af421
BP
104Prints to the console all flow entries in \fIswitch\fR's
105tables that match \fIflows\fR. If \fIflows\fR is omitted, all flows
106in the switch are retrieved. See \fBFlow Syntax\fR, below, for the
107syntax of \fIflows\fR. The output format is described in
108\fBTable Entry Output\fR.
a9b4a41a 109.
064af421 110.TP
4e312e69 111\fBdump\-aggregate \fIswitch \fR[\fIflows\fR]
064af421
BP
112Prints to the console aggregate statistics for flows in
113\fIswitch\fR's tables that match \fIflows\fR. If \fIflows\fR is omitted,
114the statistics are aggregated across all flows in the switch's flow
115tables. See \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
116The output format is descrbed in \fBTable Entry Output\fR.
a9b4a41a 117.
d2805da2
BP
118.IP "\fBqueue\-stats \fIswitch \fR[\fIport \fR[\fIqueue\fR]]"
119Prints to the console statistics for the specified \fIqueue\fR on
120\fIport\fR within \fIswitch\fR. Either of \fIport\fR or \fIqueue\fR
121or both may be omitted (or equivalently specified as \fBALL\fR). If
122both are omitted, statistics are printed for all queues on all ports.
123If only \fIqueue\fR is omitted, then statistics are printed for all
124queues on \fIport\fR; if only \fIport\fR is omitted, then statistics
125are printed for \fIqueue\fR on every port where it exists.
126.
064af421 127.TP
4e312e69 128\fBadd\-flow \fIswitch flow\fR
064af421
BP
129Add the flow entry as described by \fIflow\fR to the \fIswitch\fR's
130tables. The flow entry is in the format described in \fBFlow Syntax\fR,
131below.
a9b4a41a 132.
064af421 133.TP
4e312e69 134\fBadd\-flows \fIswitch file\fR
064af421
BP
135Add flow entries as described in \fIfile\fR to \fIswitch\fR's
136tables. Each line in \fIfile\fR is a flow entry in the format
137described in \fBFlow Syntax\fR, below.
a9b4a41a 138.
064af421 139.TP
4e312e69 140\fBmod\-flows \fIswitch flow\fR
064af421 141Modify the actions in entries from the \fIswitch\fR's tables
4e312e69 142that match \fIflow\fR. When invoked with the \fB\-\-strict\fR option,
064af421
BP
143wildcards are not treated as active for matching purposes. See
144\fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
a9b4a41a 145.
064af421 146.TP
4e312e69 147\fBdel\-flows \fIswitch \fR[\fIflow\fR]
064af421 148Deletes entries from the \fIswitch\fR's tables that match
4e312e69 149\fIflow\fR. When invoked with the \fB\-\-strict\fR option, wildcards are
064af421 150not treated as active for matching purposes. If \fIflow\fR is
4e312e69 151omitted and the \fB\-\-strict\fR option is not used, all flows in the
064af421
BP
152switch's tables are removed. See \fBFlow Syntax\fR, below, for the
153syntax of \fIflows\fR.
a9b4a41a 154.
0caf6bde
BP
155.IP "\fBsnoop \fIswitch\fR"
156Connects to \fIswitch\fR and prints to the console all OpenFlow
157messages received. Unlike other \fBovs\-ofctl\fR commands, if
158\fIswitch\fR is the name of a bridge, then the \fBsnoop\fR command
159connects to a Unix domain socket named
160\fB@RUNDIR@/\fIbridge\fB.snoop\fR. \fBovs\-vswitchd\fR listens on
161such a socket for each bridge and sends to it all of the OpenFlow
162messages sent to or received from its configured OpenFlow controller.
163Thus, this command can be used to view OpenFlow protocol activity
164between a switch and its controller.
165.IP
166When a switch has more than one controller configured, only the
e2bfacb6
BP
167traffic to and from a single controller is output. If none of the
168controllers is configured as a master or a slave (using a Nicira
169extension to OpenFlow), then a controller is chosen arbitrarily among
170them. If there is a master controller, it is chosen; otherwise, if
171there are any controllers that are not masters or slaves, one is
172chosen arbitrarily; otherwise, a slave controller is chosen
173arbitrarily. This choice is made once at connection time and does not
174change as controllers reconfigure their roles.
175.IP
176If a switch has no controller configured, or if
0caf6bde
BP
177the configured controller is disconnected, no traffic is sent, so
178monitoring will not show any traffic.
179.
180.IQ "\fBmonitor \fIswitch\fR [\fImiss-len\fR]"
064af421
BP
181Connects to \fIswitch\fR and prints to the console all OpenFlow
182messages received. Usually, \fIswitch\fR should specify a connection
4e312e69 183named on \fBovs\-openflowd\fR(8)'s \fB\-l\fR or \fB\-\-listen\fR command line
064af421 184option.
a9b4a41a 185.IP
064af421
BP
186If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set
187configuration'' message at connection setup time that requests
0caf6bde
BP
188\fImiss-len\fR bytes of each packet that misses the flow table. Open vSwitch
189does not send these and other asynchronous messages to an
064af421 190\fBovs\-ofctl monitor\fR client connection unless a nonzero value is
0caf6bde
BP
191specified on this argument. (Thus, if \fImiss\-len\fR is not
192specified, very little traffic will ordinarily be printed.)
a9b4a41a 193.IP
064af421
BP
194This command may be useful for debugging switch or controller
195implementations.
a9b4a41a 196.
064af421 197.SS "OpenFlow Switch and Controller Commands"
a9b4a41a 198.
064af421
BP
199The following commands, like those in the previous section, may be
200applied to OpenFlow switches, using any of the connection methods
201described in that section. Unlike those commands, these may also be
202applied to OpenFlow controllers.
a9b4a41a 203.
064af421
BP
204.TP
205\fBprobe \fItarget\fR
206Sends a single OpenFlow echo-request message to \fItarget\fR and waits
4e312e69 207for the response. With the \fB\-t\fR or \fB\-\-timeout\fR option, this
064af421
BP
208command can test whether an OpenFlow switch or controller is up and
209running.
a9b4a41a 210.
064af421
BP
211.TP
212\fBping \fItarget \fR[\fIn\fR]
213Sends a series of 10 echo request packets to \fItarget\fR and times
214each reply. The echo request packets consist of an OpenFlow header
215plus \fIn\fR bytes (default: 64) of randomly generated payload. This
216measures the latency of individual requests.
a9b4a41a 217.
064af421
BP
218.TP
219\fBbenchmark \fItarget n count\fR
220Sends \fIcount\fR echo request packets that each consist of an
221OpenFlow header plus \fIn\fR bytes of payload and waits for each
222response. Reports the total time required. This is a measure of the
223maximum bandwidth to \fItarget\fR for round-trips of \fIn\fR-byte
224messages.
a9b4a41a 225.
064af421 226.SS "Flow Syntax"
a9b4a41a 227.PP
064af421
BP
228Some \fBovs\-ofctl\fR commands accept an argument that describes a flow or
229flows. Such flow descriptions comprise a series
230\fIfield\fB=\fIvalue\fR assignments, separated by commas or white
231space. (Embedding spaces into a flow description normally requires
232quoting to prevent the shell from breaking the description into
233multiple arguments.)
a9b4a41a 234.PP
0b3f2725
BP
235Flow descriptions should be in \fBnormal form\fR. This means that a
236flow may only specify a value for an L3 field if it also specifies a
237particular L2 protocol, and that a flow may only specify an L4 field
238if it also specifies particular L2 and L3 protocol types. For
239example, if the L2 protocol type \fBdl_type\fR is wildcarded, then L3
240fields \fBnw_src\fR, \fBnw_dst\fR, and \fBnw_proto\fR must also be
241wildcarded. Similarly, if \fBdl_type\fR or \fBnw_proto\fR (the L3
242protocol type) is wildcarded, so must be \fBtp_dst\fR and
243\fBtp_src\fR, which are L4 fields. \fBovs\-ofctl\fR will warn about
244flows not in normal form.
245.PP
064af421
BP
246The following field assignments describe how a flow matches a packet.
247If any of these assignments is omitted from the flow syntax, the field
248is treated as a wildcard; thus, if all of them are omitted, the
249resulting flow matches all packets. The string \fB*\fR or \fBANY\fR
250may be specified to explicitly mark any of these fields as a wildcard.
251(\fB*\fR should be quoted to protect it from shell expansion.)
a9b4a41a 252.
064af421
BP
253.IP \fBin_port=\fIport_no\fR
254Matches physical port \fIport_no\fR. Switch ports are numbered as
255displayed by \fBovs\-ofctl show\fR.
a9b4a41a 256.
064af421 257.IP \fBdl_vlan=\fIvlan\fR
f30f26be
JP
258Matches IEEE 802.1q Virtual LAN tag \fIvlan\fR. Specify \fB0xffff\fR
259as \fIvlan\fR to match packets that are not tagged with a Virtual LAN;
064af421
BP
260otherwise, specify a number between 0 and 4095, inclusive, as the
26112-bit VLAN ID to match.
a9b4a41a 262.
959a2ecd
JP
263.IP \fBdl_vlan_pcp=\fIpriority\fR
264Matches IEEE 802.1q Priority Code Point (PCP) \fIpriority\fR, which is
265specified as a value between 0 and 7, inclusive. A higher value
266indicates a higher frame priority level.
a9b4a41a 267.
ed951f15
BP
268.IP \fBdl_src=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
269.IQ \fBdl_dst=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
270Matches an Ethernet source (or destination) address specified as 6
271pairs of hexadecimal digits delimited by colons
272(e.g. \fB00:0A:E4:25:6B:B0\fR).
273.
064af421
BP
274.IP \fBdl_type=\fIethertype\fR
275Matches Ethernet protocol type \fIethertype\fR, which is specified as an
276integer between 0 and 65535, inclusive, either in decimal or as a
277hexadecimal number prefixed by \fB0x\fR (e.g. \fB0x0806\fR to match ARP
278packets).
a9b4a41a 279.
064af421 280.IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
ed951f15
BP
281.IQ \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
282When \fBdl_type\fR is 0x0800 (possibly via shorthand, e.g. \fBip\fR
283or \fBtcp\fR), matches IPv4 source (or destination) address \fIip\fR,
284which may be specified as an IP address or host name
285(e.g. \fB192.168.1.1\fR or \fBwww.example.com\fR). The optional
286\fInetmask\fR allows restricting a match to an IPv4 address prefix.
287The netmask may be specified as a dotted quad
288(e.g. \fB192.168.1.0/255.255.255.0\fR) or as a CIDR block
064af421 289(e.g. \fB192.168.1.0/24\fR).
ed951f15
BP
290.IP
291When \fBdl_type=0x0806\fR or \fBarp\fR is specified, matches the
292\fBar_spa\fR or \fBar_tpa\fR field, respectively, in ARP packets for
293IPv4 and Ethernet.
294.IP
295When \fBdl_type\fR is wildcarded or set to a value other than 0x0800
0b3f2725
BP
296or 0x0806, the values of \fBnw_src\fR and \fBnw_dst\fR are ignored
297(see \fBFlow Syntax\fR above).
a9b4a41a 298.
064af421 299.IP \fBnw_proto=\fIproto\fR
ed951f15
BP
300When \fBip\fR or \fBdl_type=0x0800\fR is specified, matches IP
301protocol type \fIproto\fR, which is specified as a decimal number
302between 0 and 255, inclusive (e.g. 6 to match TCP packets).
303.IP
304When \fBarp\fR or \fBdl_type=0x0806\fR is specified, matches the lower
3058 bits of the ARP opcode. ARP opcodes greater than 255 are treated as
3060.
307.IP
308When \fBdl_type\fR is wildcarded or set to a value other than 0x0800
0b3f2725
BP
309or 0x0806, the value of \fBnw_proto\fR is ignored (see \fBFlow
310Syntax\fR above).
a9b4a41a 311.
834377ea
JP
312.IP \fBnw_tos=\fItos\fR
313Matches IP ToS/DSCP field \fItos\fR, which is specified as a decimal
314number between 0 and 255, inclusive. Note that the two lower reserved
315bits are ignored for matching purposes.
ed951f15 316.IP
0b3f2725
BP
317The value of \fBnw_proto\fR is ignored unless \fBdl_type=0x0800\fR,
318\fBip\fR, \fBicmp\fR, \fBtcp\fR, or \fBudp\fR is also specified (see
319\fBFlow Syntax\fR above).
a9b4a41a 320.
064af421 321.IP \fBtp_src=\fIport\fR
ed951f15
BP
322.IQ \fBtp_dst=\fIport\fR
323When \fBdl_type\fR and \fBnw_proto\fR specify TCP or UDP, \fBtp_src\fR
324and \fBtp_dst\fR match the UDP or TCP source or destination port
325\fIport\fR, respectively. which is specified as a decimal number
326between 0 and 65535, inclusive (e.g. 80 to match packets originating
064af421 327from a HTTP server).
ed951f15
BP
328.IP
329When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
0b3f2725 330these settings are ignored (see \fBFlow Syntax\fR above).
a9b4a41a 331.
064af421 332.IP \fBicmp_type=\fItype\fR
ed951f15
BP
333.IQ \fBicmp_code=\fIcode\fR
334When \fBdl_type\fR and \fBnw_proto\fR specify ICMP, \fItype\fR matches
335the ICMP type and \fIcode\fR matches the ICMP code. Each is specified
336as a decimal number between 0 and 255, inclusive.
337.IP
338When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
0b3f2725 339these settings are ignored (see \fBFlow Syntax\fR above).
a9b4a41a 340.
064af421
BP
341.PP
342The following shorthand notations are also available:
a9b4a41a 343.
064af421
BP
344.IP \fBip\fR
345Same as \fBdl_type=0x0800\fR.
a9b4a41a 346.
064af421
BP
347.IP \fBicmp\fR
348Same as \fBdl_type=0x0800,nw_proto=1\fR.
a9b4a41a 349.
064af421
BP
350.IP \fBtcp\fR
351Same as \fBdl_type=0x0800,nw_proto=6\fR.
a9b4a41a 352.
064af421
BP
353.IP \fBudp\fR
354Same as \fBdl_type=0x0800,nw_proto=17\fR.
a9b4a41a 355.
064af421
BP
356.IP \fBarp\fR
357Same as \fBdl_type=0x0806\fR.
a9b4a41a 358.
064af421 359.PP
4e312e69 360The \fBadd\-flow\fR and \fBadd\-flows\fR commands require an additional
537eeb9c 361field, which must be the final field specified:
a9b4a41a 362.
064af421
BP
363.IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR
364Specifies a comma-separated list of actions to take on a packet when the
365flow entry matches. If no \fItarget\fR is specified, then packets
366matching the flow are dropped. The \fItarget\fR may be a decimal port
367number designating the physical port on which to output the packet, or one
368of the following keywords:
a9b4a41a 369.
064af421
BP
370.RS
371.IP \fBoutput\fR:\fIport\fR
372Outputs the packet on the port specified by \fIport\fR.
a9b4a41a 373.
5682f723
BP
374.IP \fBenqueue\fR:\fIport\fB:\fIqueue\fR
375Enqueues the packet on the specified \fIqueue\fR within port
376\fIport\fR. The number of supported queues depends on the switch;
377some OpenFlow implementations do not support queuing at all.
378.
064af421
BP
379.IP \fBnormal\fR
380Subjects the packet to the device's normal L2/L3 processing. (This
381action is not implemented by all OpenFlow switches.)
a9b4a41a 382.
064af421
BP
383.IP \fBflood\fR
384Outputs the packet on all switch physical ports other than the port on
385which it was received and any ports on which flooding is disabled
386(typically, these would be ports disabled by the IEEE 802.1D spanning
387tree protocol).
a9b4a41a 388.
064af421
BP
389.IP \fBall\fR
390Outputs the packet on all switch physical ports other than the port on
391which it was received.
a9b4a41a 392.
064af421
BP
393.IP \fBcontroller\fR:\fImax_len\fR
394Sends the packet to the OpenFlow controller as a ``packet in''
395message. If \fImax_len\fR is a number, then it specifies the maximum
396number of bytes that should be sent. If \fImax_len\fR is \fBALL\fR or
397omitted, then the entire packet is sent.
a9b4a41a 398.
064af421
BP
399.IP \fBlocal\fR
400Outputs the packet on the ``local port,'' which corresponds to the
401\fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in
8cd4882f 402\fBovs\-openflowd\fR(8) for information on the \fBof\fIn\fR network device).
a9b4a41a 403.
064af421
BP
404.IP \fBdrop\fR
405Discards the packet, so no further processing or forwarding takes place.
406If a drop action is used, no other actions may be specified.
a9b4a41a 407.
064af421
BP
408.IP \fBmod_vlan_vid\fR:\fIvlan_vid\fR
409Modifies the VLAN id on a packet. The VLAN tag is added or modified
410as necessary to match the value specified. If the VLAN tag is added,
411a priority of zero is used (see the \fBmod_vlan_pcp\fR action to set
412this).
a9b4a41a 413.
064af421
BP
414.IP \fBmod_vlan_pcp\fR:\fIvlan_pcp\fR
415Modifies the VLAN priority on a packet. The VLAN tag is added or modified
416as necessary to match the value specified. Valid values are between 0
417(lowest) and 7 (highest). If the VLAN tag is added, a vid of zero is used
418(see the \fBmod_vlan_vid\fR action to set this).
a9b4a41a 419.
064af421
BP
420.IP \fBstrip_vlan\fR
421Strips the VLAN tag from a packet if it is present.
a9b4a41a 422.
064af421
BP
423.IP \fBmod_dl_src\fB:\fImac\fR
424Sets the source Ethernet address to \fImac\fR.
a9b4a41a 425.
064af421
BP
426.IP \fBmod_dl_dst\fB:\fImac\fR
427Sets the destination Ethernet address to \fImac\fR.
a9b4a41a 428.
e423eca6
JP
429.IP \fBmod_nw_src\fB:\fIip\fR
430Sets the IPv4 source address to \fIip\fR.
a9b4a41a 431.
e423eca6
JP
432.IP \fBmod_nw_dst\fB:\fIip\fR
433Sets the IPv4 destination address to \fIip\fR.
a9b4a41a 434.
e423eca6
JP
435.IP \fBmod_tp_src\fB:\fIport\fR
436Sets the TCP or UDP source port to \fIport\fR.
a9b4a41a 437.
e423eca6
JP
438.IP \fBmod_tp_dst\fB:\fIport\fR
439Sets the TCP or UDP destination port to \fIport\fR.
a9b4a41a 440.
959a2ecd
JP
441.IP \fBmod_nw_tos\fB:\fItos\fR
442Sets the IP ToS/DSCP field to \fItos\fR. Valid values are between 0 and
443255, inclusive. Note that the two lower reserved bits are never
444modified.
a9b4a41a 445.
659586ef
JG
446.RE
447.IP
448The following actions are Nicira vendor extensions that, as of this writing, are
449only known to be implemented by Open vSwitch:
450.
451.RS
452.
3a2fe1f3
BP
453.IP \fBresubmit\fB:\fIport\fR
454Re-searches the OpenFlow flow table with the \fBin_port\fR field
455replaced by \fIport\fR and executes the actions found, if any, in
456addition to any other actions in this flow entry. Recursive
457\fBresubmit\fR actions are ignored.
659586ef
JG
458.
459.IP \fBset_tunnel\fB:\fIid\fR
460If outputting to a port that encapsulates the packet in a tunnel and supports
461an identifier (such as GRE), sets the identifier to \fBid\fR.
3a2fe1f3 462.
933df876
BP
463.IP \fBdrop_spoofed_arp\fR
464Stops processing further actions, if the packet being processed is an
465Ethernet+IPv4 ARP packet for which the source Ethernet address inside
466the ARP packet differs from the source Ethernet address in the
467Ethernet header.
468.
469This is useful because OpenFlow does not provide a way to match on the
470Ethernet addresses inside ARP packets, so there is no other way to
471drop spoofed ARPs other than sending every ARP packet to a controller.
eedc0097
JP
472.
473.IP \fBset_queue\fB:\fIqueue\fR
474Sets the queue that should be used to \fIqueue\fR when packets are
475output. The number of supported queues depends on the switch; some
476OpenFlow implementations do not support queuing at all.
477.
478.IP \fBpop_queue\fR
479Restores the queue to the value it was before any \fBset_queue\fR
480actions were applied.
481.
96fc46e8
BP
482.IP \fBnote:\fR[\fIhh\fR]...
483Does nothing at all. Any number of bytes represented as hex digits
484\fIhh\fR may be included. Pairs of hex digits may be separated by
485periods for readability.
064af421 486.RE
a9b4a41a 487.
064af421
BP
488.IP
489(The OpenFlow protocol supports other actions that \fBovs\-ofctl\fR does
490not yet expose to the user.)
a9b4a41a 491.
064af421 492.PP
8cce2125
JP
493The \fBadd\-flow\fR, \fBadd\-flows\fR, and \fBmod\-flows\fR commands
494support an additional optional field:
495.
496.IP \fBcookie=\fIvalue\fR
497.
498A cookie is an opaque identifier that can be associated with the flow.
499\fIvalue\fR can be any 64-bit number and need not be unique among
500flows.
501.
502.PP
4b6b46ce
BP
503The following additional field sets the priority for flows added by
504the \fBadd\-flow\fR and \fBadd\-flows\fR commands. For
505\fBmod\-flows\fR and \fBdel\-flows\fR when \fB\-\-strict\fR is
506specified, priority must match along with the rest of the flow
507specification. Other commands ignore the priority value.
a9b4a41a 508.
064af421
BP
509.IP \fBpriority=\fIvalue\fR
510The priority at which a wildcarded entry will match in comparison to
511others. \fIvalue\fR is a number between 0 and 65535, inclusive. A higher
512\fIvalue\fR will match before a lower one. An exact-match entry will always
513have priority over an entry containing wildcards, so it has an implicit
514priority value of 65535. When adding a flow, if the field is not specified,
515the flow's priority will default to 32768.
a9b4a41a 516.
064af421 517.PP
4e312e69 518The \fBadd\-flow\fR and \fBadd\-flows\fR commands support additional
064af421 519optional fields:
a9b4a41a 520.
064af421
BP
521.TP
522\fBidle_timeout=\fIseconds\fR
523Causes the flow to expire after the given number of seconds of
a1545337
BP
524inactivity. A value of 0 (the default) prevents a flow from expiring due to
525inactivity.
a9b4a41a 526.
064af421
BP
527.IP \fBhard_timeout=\fIseconds\fR
528Causes the flow to expire after the given number of seconds,
529regardless of activity. A value of 0 (the default) gives the flow no
530hard expiration deadline.
a9b4a41a 531.
064af421 532.PP
4e312e69
BP
533The \fBdump\-flows\fR, \fBdump\-aggregate\fR, \fBdel\-flow\fR
534and \fBdel\-flows\fR commands support one additional optional field:
a9b4a41a 535.
064af421
BP
536.TP
537\fBout_port=\fIport\fR
538If set, a matching flow must include an output action to \fIport\fR.
a9b4a41a 539.
064af421 540.PP
4e312e69 541The \fBdump\-flows\fR and \fBdump\-aggregate\fR commands support an
064af421 542additional optional field:
a9b4a41a 543.
064af421
BP
544.IP \fBtable=\fInumber\fR
545If specified, limits the flows about which statistics are gathered to
546those in the table with the given \fInumber\fR. Tables are numbered
4e312e69 547as shown by the \fBdump\-tables\fR command.
a9b4a41a 548.
064af421
BP
549If this field is not specified, or if \fInumber\fR is given as
550\fB255\fR, statistics are gathered about flows from all tables.
a9b4a41a 551.
064af421 552.SS "Table Entry Output"
a9b4a41a 553.
4e312e69 554The \fBdump\-tables\fR and \fBdump\-aggregate\fR commands print information
064af421
BP
555about the entries in a datapath's tables. Each line of output is a
556unique flow entry, which begins with some common information:
a9b4a41a 557.
064af421
BP
558.IP \fBduration\fR
559The number of seconds the entry has been in the table.
a9b4a41a 560.
064af421
BP
561.IP \fBtable_id\fR
562The table that contains the flow. When a packet arrives, the switch
563begins searching for an entry at the lowest numbered table. Tables are
4e312e69 564numbered as shown by the \fBdump\-tables\fR command.
a9b4a41a 565.
064af421
BP
566.IP \fBpriority\fR
567The priority of the entry in relation to other entries within the same
568table. A higher value will match before a lower one.
a9b4a41a 569.
064af421
BP
570.IP \fBn_packets\fR
571The number of packets that have matched the entry.
a9b4a41a 572.
064af421
BP
573.IP \fBn_bytes\fR
574The total number of bytes from packets that have matched the entry.
a9b4a41a 575.
064af421
BP
576.PP
577The rest of the line consists of a description of the flow entry as
578described in \fBFlow Syntax\fR, above.
a9b4a41a
BP
579.
580.
064af421
BP
581.SH OPTIONS
582.TP
4e312e69 583\fB\-\-strict\fR
064af421 584Uses strict matching when running flow modification commands.
a9b4a41a 585.
ac300505 586.SS "Public Key Infrastructure Options"
84ee7bcf 587.so lib/ssl.man
064af421
BP
588.so lib/vlog.man
589.so lib/common.man
a9b4a41a 590.
064af421 591.SH EXAMPLES
a9b4a41a 592.
064af421
BP
593The following examples assume that an OpenFlow switch on the local
594host has been configured to listen for management connections on a
595Unix domain socket named \fB@RUNDIR@/openflow.sock\fR, e.g. by
4e312e69 596specifying \fB\-\-listen=punix:@RUNDIR@/openflow.sock\fR on the
8cd4882f 597\fBovs\-openflowd\fR(8) command line.
a9b4a41a 598.
064af421 599.TP
4e312e69 600\fBovs\-ofctl dump\-tables unix:@RUNDIR@/openflow.sock\fR
064af421
BP
601Prints out the switch's table stats. (This is more interesting after
602some traffic has passed through.)
a9b4a41a 603.
064af421 604.TP
4e312e69 605\fBovs\-ofctl dump\-flows unix:@RUNDIR@/openflow.sock\fR
064af421 606Prints the flow entries in the switch.
a9b4a41a 607.
064af421 608.SH "SEE ALSO"
a9b4a41a 609.
064af421
BP
610.BR ovs\-appctl (8),
611.BR ovs\-controller (8),
612.BR ovs\-vswitchd (8)