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