]> git.proxmox.com Git - mirror_ovs.git/blame - FAQ.md
nicira-ext: Fix typo in comment.
[mirror_ovs.git] / FAQ.md
CommitLineData
c483d489
BP
1Frequently Asked Questions
2==========================
3
542cc9bb
TG
4Open vSwitch <http://openvswitch.org>
5
3fc7dc18
JP
6General
7-------
8
542cc9bb 9### Q: What is Open vSwitch?
3fc7dc18
JP
10
11A: Open vSwitch is a production quality open source software switch
29089a54
RL
12 designed to be used as a vswitch in virtualized server
13 environments. A vswitch forwards traffic between different VMs on
14 the same physical host and also forwards traffic between VMs and
15 the physical network. Open vSwitch supports standard management
16 interfaces (e.g. sFlow, NetFlow, IPFIX, RSPAN, CLI), and is open to
17 programmatic extension and control using OpenFlow and the OVSDB
18 management protocol.
3fc7dc18
JP
19
20 Open vSwitch as designed to be compatible with modern switching
21 chipsets. This means that it can be ported to existing high-fanout
22 switches allowing the same flexible control of the physical
23 infrastructure as the virtual infrastructure. It also means that
24 Open vSwitch will be able to take advantage of on-NIC switching
25 chipsets as their functionality matures.
26
542cc9bb 27### Q: What virtualization platforms can use Open vSwitch?
3fc7dc18
JP
28
29A: Open vSwitch can currently run on any Linux-based virtualization
37418c86 30 platform (kernel 2.6.32 and newer), including: KVM, VirtualBox, Xen,
3fc7dc18
JP
31 Xen Cloud Platform, XenServer. As of Linux 3.3 it is part of the
32 mainline kernel. The bulk of the code is written in platform-
33 independent C and is easily ported to other environments. We welcome
34 inquires about integrating Open vSwitch with other virtualization
35 platforms.
36
542cc9bb 37### Q: How can I try Open vSwitch?
3fc7dc18 38
7b287e99
JP
39A: The Open vSwitch source code can be built on a Linux system. You can
40 build and experiment with Open vSwitch on any Linux machine.
41 Packages for various Linux distributions are available on many
42 platforms, including: Debian, Ubuntu, Fedora.
3fc7dc18
JP
43
44 You may also download and run a virtualization platform that already
7b287e99
JP
45 has Open vSwitch integrated. For example, download a recent ISO for
46 XenServer or Xen Cloud Platform. Be aware that the version
47 integrated with a particular platform may not be the most recent Open
48 vSwitch release.
49
542cc9bb 50### Q: Does Open vSwitch only work on Linux?
7b287e99
JP
51
52A: No, Open vSwitch has been ported to a number of different operating
53 systems and hardware platforms. Most of the development work occurs
54 on Linux, but the code should be portable to any POSIX system. We've
55 seen Open vSwitch ported to a number of different platforms,
56 including FreeBSD, Windows, and even non-POSIX embedded systems.
57
58 By definition, the Open vSwitch Linux kernel module only works on
59 Linux and will provide the highest performance. However, a userspace
60 datapath is available that should be very portable.
61
542cc9bb 62### Q: What's involved with porting Open vSwitch to a new platform or switching ASIC?
7b287e99 63
9feb1017 64A: The [PORTING.md] document describes how one would go about
542cc9bb 65 porting Open vSwitch to a new operating system or hardware platform.
3fc7dc18 66
542cc9bb 67### Q: Why would I use Open vSwitch instead of the Linux bridge?
3fc7dc18
JP
68
69A: Open vSwitch is specially designed to make it easier to manage VM
7b287e99 70 network configuration and monitor state spread across many physical
542cc9bb 71 hosts in dynamic virtualized environments. Please see
9feb1017
TG
72 [WHY-OVS.md] for a more detailed description of how Open vSwitch
73 relates to the Linux Bridge.
3fc7dc18 74
542cc9bb 75### Q: How is Open vSwitch related to distributed virtual switches like the VMware vNetwork distributed switch or the Cisco Nexus 1000V?
3fc7dc18
JP
76
77A: Distributed vswitch applications (e.g., VMware vNetwork distributed
78 switch, Cisco Nexus 1000V) provide a centralized way to configure and
79 monitor the network state of VMs that are spread across many physical
80 hosts. Open vSwitch is not a distributed vswitch itself, rather it
81 runs on each physical host and supports remote management in a way
82 that makes it easier for developers of virtualization/cloud
83 management platforms to offer distributed vswitch capabilities.
84
85 To aid in distribution, Open vSwitch provides two open protocols that
86 are specially designed for remote management in virtualized network
87 environments: OpenFlow, which exposes flow-based forwarding state,
88 and the OVSDB management protocol, which exposes switch port state.
89 In addition to the switch implementation itself, Open vSwitch
1d5aaa61
BP
90 includes tools (ovs-ofctl, ovs-vsctl) that developers can script and
91 extend to provide distributed vswitch capabilities that are closely
92 integrated with their virtualization management platform.
3fc7dc18 93
542cc9bb 94### Q: Why doesn't Open vSwitch support distribution?
3fc7dc18
JP
95
96A: Open vSwitch is intended to be a useful component for building
97 flexible network infrastructure. There are many different approaches
98 to distribution which balance trade-offs between simplicity,
99 scalability, hardware compatibility, convergence times, logical
100 forwarding model, etc. The goal of Open vSwitch is to be able to
101 support all as a primitive building block rather than choose a
102 particular point in the distributed design space.
103
542cc9bb 104### Q: How can I contribute to the Open vSwitch Community?
3fc7dc18
JP
105
106A: You can start by joining the mailing lists and helping to answer
7b287e99
JP
107 questions. You can also suggest improvements to documentation. If
108 you have a feature or bug you would like to work on, send a mail to
109 one of the mailing lists:
110
542cc9bb 111 http://openvswitch.org/mlists/
7b287e99 112
5fd5a65c 113### Q: Why can I no longer connect to my OpenFlow controller or OVSDB manager?
d4763d1d
JP
114
115A: Starting in OVS 2.4, we switched the default ports to the
116 IANA-specified port numbers for OpenFlow (6633->6653) and OVSDB
117 (6632->6640). We recommend using these port numbers, but if you
118 cannot, all the programs allow overriding the default port. See the
119 appropriate man page.
120
7b287e99 121
7b287e99
JP
122Releases
123--------
124
542cc9bb 125### Q: What does it mean for an Open vSwitch release to be LTS (long-term support)?
3fc7dc18 126
7b287e99
JP
127A: All official releases have been through a comprehensive testing
128 process and are suitable for production use. Planned releases will
129 occur several times a year. If a significant bug is identified in an
130 LTS release, we will provide an updated release that includes the
131 fix. Releases that are not LTS may not be fixed and may just be
132 supplanted by the next major release. The current LTS release is
49b507d9 133 2.3.x.
7b287e99 134
542cc9bb 135### Q: What Linux kernel versions does each Open vSwitch release work with?
314e60e1
BP
136
137A: The following table lists the Linux kernel versions against which the
138 given versions of the Open vSwitch kernel module will successfully
139 build. The Linux kernel versions are upstream kernel versions, so
a01b5c51
BP
140 Linux kernels modified from the upstream sources may not build in
141 some cases even if they are based on a supported version. This is
142 most notably true of Red Hat Enterprise Linux (RHEL) kernels, which
143 are extensively modified from upstream.
314e60e1 144
542cc9bb
TG
145| Open vSwitch | Linux kernel
146|:------------:|:-------------:
147| 1.4.x | 2.6.18 to 3.2
148| 1.5.x | 2.6.18 to 3.2
149| 1.6.x | 2.6.18 to 3.2
150| 1.7.x | 2.6.18 to 3.3
151| 1.8.x | 2.6.18 to 3.4
152| 1.9.x | 2.6.18 to 3.8
153| 1.10.x | 2.6.18 to 3.8
154| 1.11.x | 2.6.18 to 3.8
155| 2.0.x | 2.6.32 to 3.10
156| 2.1.x | 2.6.32 to 3.11
157| 2.3.x | 2.6.32 to 3.14
3afcde43 158| 2.4.x | 2.6.32 to 4.0
314e60e1
BP
159
160 Open vSwitch userspace should also work with the Linux kernel module
161 built into Linux 3.3 and later.
162
163 Open vSwitch userspace is not sensitive to the Linux kernel version.
37418c86 164 It should build against almost any kernel, certainly against 2.6.32
314e60e1
BP
165 and later.
166
542cc9bb 167### Q: I get an error like this when I configure Open vSwitch:
29089a54 168
a7ae9380
BP
169 configure: error: Linux kernel in <dir> is version <x>, but
170 version newer than <y> is not supported (please refer to the
171 FAQ for advice)
29089a54 172
a7ae9380 173 What should I do?
33cec590 174
fcc369bc
BP
175A: You have the following options:
176
177 - Use the Linux kernel module supplied with the kernel that you are
178 using. (See also the following FAQ.)
179
180 - If there is a newer released version of Open vSwitch, consider
181 building that one, because it may support the kernel that you are
182 building against. (To find out, consult the table in the
183 previous FAQ.)
184
185 - The Open vSwitch "master" branch may support the kernel that you
186 are using, so consider building the kernel module from "master".
187
188 All versions of Open vSwitch userspace are compatible with all
189 versions of the Open vSwitch kernel module, so you do not have to
190 use the kernel module from one source along with the userspace
191 programs from the same source.
33cec590 192
542cc9bb 193### Q: What features are not available in the Open vSwitch kernel datapath that ships as part of the upstream Linux kernel?
7b287e99 194
9c333bff
JG
195A: The kernel module in upstream Linux does not include support for
196 LISP. Work is in progress to add support for LISP to the upstream
197 Linux version of the Open vSwitch kernel module. For now, if you
198 need this feature, use the kernel module from the Open vSwitch
0a740f48
EJ
199 distribution instead of the upstream Linux kernel module.
200
9c333bff
JG
201 Certain features require kernel support to function or to have
202 reasonable performance. If the ovs-vswitchd log file indicates that
203 a feature is not supported, consider upgrading to a newer upstream
204 Linux release or using the kernel module paired with the userspace
205 distribution.
6302c641 206
542cc9bb 207### Q: Why do tunnels not work when using a kernel module other than the one packaged with Open vSwitch?
6814c630
JG
208
209A: Support for tunnels was added to the upstream Linux kernel module
210 after the rest of Open vSwitch. As a result, some kernels may contain
211 support for Open vSwitch but not tunnels. The minimum kernel version
212 that supports each tunnel protocol is:
213
542cc9bb
TG
214| Protocol | Linux Kernel
215|:--------:|:-------------:
216| GRE | 3.11
217| VXLAN | 3.12
4752cc0c 218| Geneve | 3.18
542cc9bb 219| LISP | <not upstream>
4237026e 220| STT | <not upstream>
6814c630
JG
221
222 If you are using a version of the kernel that is older than the one
223 listed above, it is still possible to use that tunnel protocol. However,
224 you must compile and install the kernel module included with the Open
225 vSwitch distribution rather than the one on your machine. If problems
226 persist after doing this, check to make sure that the module that is
227 loaded is the one you expect.
228
4752cc0c
JG
229### Q: Why are UDP tunnel checksums not computed for VXLAN or Geneve?
230
231A: Generating outer UDP checksums requires kernel support that was not
232 part of the initial implementation of these protocols. If using the
233 upstream Linux Open vSwitch module, you must use kernel 4.0 or
234 newer. The out-of-tree modules from Open vSwitch release 2.4 and later
235 support UDP checksums.
236
542cc9bb 237### Q: What features are not available when using the userspace datapath?
7b287e99 238
0a740f48 239A: Tunnel virtual ports are not supported, as described in the
7b287e99
JP
240 previous answer. It is also not possible to use queue-related
241 actions. On Linux kernels before 2.6.39, maximum-sized VLAN packets
242 may not be transmitted.
3fc7dc18 243
542cc9bb 244### Q: What Linux kernel versions does IPFIX flow monitoring work with?
a7ae9380 245
b809f733
BP
246A: IPFIX flow monitoring requires the Linux kernel module from Linux
247 3.10 or later, or the out-of-tree module from Open vSwitch version
248 1.10.90 or later.
a7ae9380 249
542cc9bb 250### Q: Should userspace or kernel be upgraded first to minimize downtime?
a7ae9380
BP
251
252 In general, the Open vSwitch userspace should be used with the
253 kernel version included in the same release or with the version
254 from upstream Linux. However, when upgrading between two releases
255 of Open vSwitch it is best to migrate userspace first to reduce
256 the possibility of incompatibilities.
257
542cc9bb 258### Q: What happened to the bridge compatibility feature?
900dc97c
BP
259
260A: Bridge compatibility was a feature of Open vSwitch 1.9 and earlier.
261 When it was enabled, Open vSwitch imitated the interface of the
262 Linux kernel "bridge" module. This allowed users to drop Open
263 vSwitch into environments designed to use the Linux kernel bridge
264 module without adapting the environment to use Open vSwitch.
265
266 Open vSwitch 1.10 and later do not support bridge compatibility.
267 The feature was dropped because version 1.10 adopted a new internal
268 architecture that made bridge compatibility difficult to maintain.
269 Now that many environments use OVS directly, it would be rarely
270 useful in any case.
271
272 To use bridge compatibility, install OVS 1.9 or earlier, including
273 the accompanying kernel modules (both the main and bridge
274 compatibility modules), following the instructions that come with
275 the release. Be sure to start the ovs-brcompatd daemon.
276
3fc7dc18 277
79aa9fd0
BP
278Terminology
279-----------
280
542cc9bb 281### Q: I thought Open vSwitch was a virtual Ethernet switch, but the documentation keeps talking about bridges. What's a bridge?
79aa9fd0
BP
282
283A: In networking, the terms "bridge" and "switch" are synonyms. Open
284 vSwitch implements an Ethernet switch, which means that it is also
285 an Ethernet bridge.
286
542cc9bb 287### Q: What's a VLAN?
79aa9fd0
BP
288
289A: See the "VLAN" section below.
290
291
717e7c8d
BP
292Basic Configuration
293-------------------
294
542cc9bb 295### Q: How do I configure a port as an access port?
717e7c8d
BP
296
297A: Add "tag=VLAN" to your "ovs-vsctl add-port" command. For example,
298 the following commands configure br0 with eth0 as a trunk port (the
299 default) and tap0 as an access port for VLAN 9:
300
301 ovs-vsctl add-br br0
302 ovs-vsctl add-port br0 eth0
303 ovs-vsctl add-port br0 tap0 tag=9
304
305 If you want to configure an already added port as an access port,
306 use "ovs-vsctl set", e.g.:
307
308 ovs-vsctl set port tap0 tag=9
309
542cc9bb 310### Q: How do I configure a port as a SPAN port, that is, enable mirroring of all traffic to that port?
717e7c8d
BP
311
312A: The following commands configure br0 with eth0 and tap0 as trunk
313 ports. All traffic coming in or going out on eth0 or tap0 is also
314 mirrored to tap1; any traffic arriving on tap1 is dropped:
315
316 ovs-vsctl add-br br0
317 ovs-vsctl add-port br0 eth0
318 ovs-vsctl add-port br0 tap0
319 ovs-vsctl add-port br0 tap1 \
320 -- --id=@p get port tap1 \
0dc8b8c2
YT
321 -- --id=@m create mirror name=m0 select-all=true output-port=@p \
322 -- set bridge br0 mirrors=@m
717e7c8d
BP
323
324 To later disable mirroring, run:
325
326 ovs-vsctl clear bridge br0 mirrors
327
542cc9bb 328### Q: Does Open vSwitch support configuring a port in promiscuous mode?
e253f732
BP
329
330A: Yes. How you configure it depends on what you mean by "promiscuous
331 mode":
332
542cc9bb
TG
333 - Conventionally, "promiscuous mode" is a feature of a network
334 interface card. Ordinarily, a NIC passes to the CPU only the
335 packets actually destined to its host machine. It discards
336 the rest to avoid wasting memory and CPU cycles. When
337 promiscuous mode is enabled, however, it passes every packet
338 to the CPU. On an old-style shared-media or hub-based
339 network, this allows the host to spy on all packets on the
340 network. But in the switched networks that are almost
341 everywhere these days, promiscuous mode doesn't have much
342 effect, because few packets not destined to a host are
343 delivered to the host's NIC.
344
345 This form of promiscuous mode is configured in the guest OS of
346 the VMs on your bridge, e.g. with "ifconfig".
347
348 - The VMware vSwitch uses a different definition of "promiscuous
349 mode". When you configure promiscuous mode on a VMware vNIC,
350 the vSwitch sends a copy of every packet received by the
351 vSwitch to that vNIC. That has a much bigger effect than just
352 enabling promiscuous mode in a guest OS. Rather than getting
353 a few stray packets for which the switch does not yet know the
354 correct destination, the vNIC gets every packet. The effect
355 is similar to replacing the vSwitch by a virtual hub.
356
357 This "promiscuous mode" is what switches normally call "port
358 mirroring" or "SPAN". For information on how to configure
359 SPAN, see "How do I configure a port as a SPAN port, that is,
360 enable mirroring of all traffic to that port?"
361
77c180ce
BM
362### Q: How do I configure a DPDK port as an access port?
363
364A: Firstly, you must have a DPDK-enabled version of Open vSwitch.
365
366 If your version is DPDK-enabled it will support the --dpdk
367 argument on the command line and will display lines with
368 "EAL:..." during startup when --dpdk is supplied.
369
370 Secondly, when adding a DPDK port, unlike a system port, the
371 type for the interface must be specified. For example;
372
373 ovs-vsctl add-br br0
374 ovs-vsctl add-port br0 dpdk0 -- set Interface dpdk0 type=dpdk
375
376 Finally, it is required that DPDK port names begin with 'dpdk'.
377
378 See [INSTALL.DPDK.md] for more information on enabling and using DPDK with
379 Open vSwitch.
380
542cc9bb 381### Q: How do I configure a VLAN as an RSPAN VLAN, that is, enable mirroring of all traffic to that VLAN?
717e7c8d
BP
382
383A: The following commands configure br0 with eth0 as a trunk port and
384 tap0 as an access port for VLAN 10. All traffic coming in or going
385 out on tap0, as well as traffic coming in or going out on eth0 in
386 VLAN 10, is also mirrored to VLAN 15 on eth0. The original tag for
387 VLAN 10, in cases where one is present, is dropped as part of
388 mirroring:
389
390 ovs-vsctl add-br br0
391 ovs-vsctl add-port br0 eth0
392 ovs-vsctl add-port br0 tap0 tag=10
393 ovs-vsctl \
0dc8b8c2 394 -- --id=@m create mirror name=m0 select-all=true select-vlan=10 \
717e7c8d 395 output-vlan=15 \
0dc8b8c2 396 -- set bridge br0 mirrors=@m
717e7c8d
BP
397
398 To later disable mirroring, run:
399
400 ovs-vsctl clear bridge br0 mirrors
401
402 Mirroring to a VLAN can disrupt a network that contains unmanaged
403 switches. See ovs-vswitchd.conf.db(5) for details. Mirroring to a
404 GRE tunnel has fewer caveats than mirroring to a VLAN and should
405 generally be preferred.
406
542cc9bb 407### Q: Can I mirror more than one input VLAN to an RSPAN VLAN?
717e7c8d
BP
408
409A: Yes, but mirroring to a VLAN strips the original VLAN tag in favor
410 of the specified output-vlan. This loss of information may make
411 the mirrored traffic too hard to interpret.
412
413 To mirror multiple VLANs, use the commands above, but specify a
414 comma-separated list of VLANs as the value for select-vlan. To
415 mirror every VLAN, use the commands above, but omit select-vlan and
416 its value entirely.
417
418 When a packet arrives on a VLAN that is used as a mirror output
419 VLAN, the mirror is disregarded. Instead, in standalone mode, OVS
420 floods the packet across all the ports for which the mirror output
421 VLAN is configured. (If an OpenFlow controller is in use, then it
422 can override this behavior through the flow table.) If OVS is used
423 as an intermediate switch, rather than an edge switch, this ensures
424 that the RSPAN traffic is distributed through the network.
425
426 Mirroring to a VLAN can disrupt a network that contains unmanaged
427 switches. See ovs-vswitchd.conf.db(5) for details. Mirroring to a
428 GRE tunnel has fewer caveats than mirroring to a VLAN and should
429 generally be preferred.
430
542cc9bb 431### Q: How do I configure mirroring of all traffic to a GRE tunnel?
717e7c8d
BP
432
433A: The following commands configure br0 with eth0 and tap0 as trunk
434 ports. All traffic coming in or going out on eth0 or tap0 is also
435 mirrored to gre0, a GRE tunnel to the remote host 192.168.1.10; any
436 traffic arriving on gre0 is dropped:
437
438 ovs-vsctl add-br br0
439 ovs-vsctl add-port br0 eth0
440 ovs-vsctl add-port br0 tap0
441 ovs-vsctl add-port br0 gre0 \
442 -- set interface gre0 type=gre options:remote_ip=192.168.1.10 \
443 -- --id=@p get port gre0 \
0dc8b8c2
YT
444 -- --id=@m create mirror name=m0 select-all=true output-port=@p \
445 -- set bridge br0 mirrors=@m
717e7c8d
BP
446
447 To later disable mirroring and destroy the GRE tunnel:
448
449 ovs-vsctl clear bridge br0 mirrors
450 ovs-vcstl del-port br0 gre0
451
542cc9bb 452### Q: Does Open vSwitch support ERSPAN?
717e7c8d
BP
453
454A: No. ERSPAN is an undocumented proprietary protocol. As an
455 alternative, Open vSwitch supports mirroring to a GRE tunnel (see
456 above).
457
542cc9bb 458### Q: How do I connect two bridges?
1ab9712b
BP
459
460A: First, why do you want to do this? Two connected bridges are not
461 much different from a single bridge, so you might as well just have
462 a single bridge with all your ports on it.
463
464 If you still want to connect two bridges, you can use a pair of
465 patch ports. The following example creates bridges br0 and br1,
466 adds eth0 and tap0 to br0, adds tap1 to br1, and then connects br0
467 and br1 with a pair of patch ports.
468
469 ovs-vsctl add-br br0
470 ovs-vsctl add-port br0 eth0
471 ovs-vsctl add-port br0 tap0
472 ovs-vsctl add-br br1
473 ovs-vsctl add-port br1 tap1
474 ovs-vsctl \
475 -- add-port br0 patch0 \
476 -- set interface patch0 type=patch options:peer=patch1 \
477 -- add-port br1 patch1 \
478 -- set interface patch1 type=patch options:peer=patch0
479
480 Bridges connected with patch ports are much like a single bridge.
481 For instance, if the example above also added eth1 to br1, and both
482 eth0 and eth1 happened to be connected to the same next-hop switch,
483 then you could loop your network just as you would if you added
484 eth0 and eth1 to the same bridge (see the "Configuration Problems"
485 section below for more information).
486
487 If you are using Open vSwitch 1.9 or an earlier version, then you
488 need to be using the kernel module bundled with Open vSwitch rather
489 than the one that is integrated into Linux 3.3 and later, because
490 Open vSwitch 1.9 and earlier versions need kernel support for patch
491 ports. This also means that in Open vSwitch 1.9 and earlier, patch
492 ports will not work with the userspace datapath, only with the
493 kernel module.
494
542cc9bb 495### Q: How do I configure a bridge without an OpenFlow local port? (Local port in the sense of OFPP_LOCAL)
5c9c1105
YT
496
497A: Open vSwitch does not support such a configuration.
498 Bridges always have their local ports.
499
1a274bfe
BP
500
501Implementation Details
502----------------------
503
542cc9bb 504### Q: I hear OVS has a couple of kinds of flows. Can you tell me about them?
a70fc0cf
JP
505
506A: Open vSwitch uses different kinds of flows for different purposes:
507
542cc9bb
TG
508 - OpenFlow flows are the most important kind of flow. OpenFlow
509 controllers use these flows to define a switch's policy.
510 OpenFlow flows support wildcards, priorities, and multiple
511 tables.
512
513 When in-band control is in use, Open vSwitch sets up a few
514 "hidden" flows, with priority higher than a controller or the
515 user can configure, that are not visible via OpenFlow. (See
516 the "Controller" section of the FAQ for more information
517 about hidden flows.)
518
519 - The Open vSwitch software switch implementation uses a second
520 kind of flow internally. These flows, called "datapath" or
521 "kernel" flows, do not support priorities and comprise only a
522 single table, which makes them suitable for caching. (Like
523 OpenFlow flows, datapath flows do support wildcarding, in Open
524 vSwitch 1.11 and later.) OpenFlow flows and datapath flows
525 also support different actions and number ports differently.
526
527 Datapath flows are an implementation detail that is subject to
528 change in future versions of Open vSwitch. Even with the
529 current version of Open vSwitch, hardware switch
530 implementations do not necessarily use this architecture.
a70fc0cf 531
1a274bfe
BP
532 Users and controllers directly control only the OpenFlow flow
533 table. Open vSwitch manages the datapath flow table itself, so
534 users should not normally be concerned with it.
535
542cc9bb 536### Q: Why are there so many different ways to dump flows?
1a274bfe
BP
537
538A: Open vSwitch has two kinds of flows (see the previous question), so
539 it has commands with different purposes for dumping each kind of
540 flow:
a70fc0cf 541
542cc9bb
TG
542 - `ovs-ofctl dump-flows <br>` dumps OpenFlow flows, excluding
543 hidden flows. This is the most commonly useful form of flow
544 dump. (Unlike the other commands, this should work with any
545 OpenFlow switch, not just Open vSwitch.)
a70fc0cf 546
542cc9bb
TG
547 - `ovs-appctl bridge/dump-flows <br>` dumps OpenFlow flows,
548 including hidden flows. This is occasionally useful for
549 troubleshooting suspected issues with in-band control.
a70fc0cf 550
542cc9bb
TG
551 - `ovs-dpctl dump-flows [dp]` dumps the datapath flow table
552 entries for a Linux kernel-based datapath. In Open vSwitch
553 1.10 and later, ovs-vswitchd merges multiple switches into a
554 single datapath, so it will show all the flows on all your
555 kernel-based switches. This command can occasionally be
556 useful for debugging.
a70fc0cf 557
542cc9bb
TG
558 - `ovs-appctl dpif/dump-flows <br>`, new in Open vSwitch 1.10,
559 dumps datapath flows for only the specified bridge, regardless
560 of the type.
a70fc0cf 561
542cc9bb 562### Q: How does multicast snooping works with VLANs?
c81f359b
FL
563
564A: Open vSwitch maintains snooping tables for each VLAN.
565
717e7c8d 566
bcb8bde4
JR
567Performance
568-----------
569
542cc9bb 570### Q: I just upgraded and I see a performance drop. Why?
bcb8bde4
JR
571
572A: The OVS kernel datapath may have been updated to a newer version than
573 the OVS userspace components. Sometimes new versions of OVS kernel
574 module add functionality that is backwards compatible with older
575 userspace components but may cause a drop in performance with them.
576 Especially, if a kernel module from OVS 2.1 or newer is paired with
577 OVS userspace 1.10 or older, there will be a performance drop for
578 TCP traffic.
579
580 Updating the OVS userspace components to the latest released
581 version should fix the performance degradation.
582
583 To get the best possible performance and functionality, it is
584 recommended to pair the same versions of the kernel module and OVS
585 userspace.
586
587
c483d489
BP
588Configuration Problems
589----------------------
590
542cc9bb 591### Q: I created a bridge and added my Ethernet port to it, using commands
c483d489
BP
592 like these:
593
594 ovs-vsctl add-br br0
595 ovs-vsctl add-port br0 eth0
596
597 and as soon as I ran the "add-port" command I lost all connectivity
598 through eth0. Help!
599
600A: A physical Ethernet device that is part of an Open vSwitch bridge
601 should not have an IP address. If one does, then that IP address
602 will not be fully functional.
603
604 You can restore functionality by moving the IP address to an Open
605 vSwitch "internal" device, such as the network device named after
606 the bridge itself. For example, assuming that eth0's IP address is
607 192.168.128.5, you could run the commands below to fix up the
608 situation:
609
610 ifconfig eth0 0.0.0.0
611 ifconfig br0 192.168.128.5
612
613 (If your only connection to the machine running OVS is through the
614 IP address in question, then you would want to run all of these
615 commands on a single command line, or put them into a script.) If
616 there were any additional routes assigned to eth0, then you would
617 also want to use commands to adjust these routes to go through br0.
618
619 If you use DHCP to obtain an IP address, then you should kill the
620 DHCP client that was listening on the physical Ethernet interface
621 (e.g. eth0) and start one listening on the internal interface
622 (e.g. br0). You might still need to manually clear the IP address
623 from the physical interface (e.g. with "ifconfig eth0 0.0.0.0").
624
625 There is no compelling reason why Open vSwitch must work this way.
626 However, this is the way that the Linux kernel bridge module has
627 always worked, so it's a model that those accustomed to Linux
628 bridging are already used to. Also, the model that most people
629 expect is not implementable without kernel changes on all the
630 versions of Linux that Open vSwitch supports.
631
632 By the way, this issue is not specific to physical Ethernet
c7b0cfd3 633 devices. It applies to all network devices except Open vSwitch
c483d489
BP
634 "internal" devices.
635
542cc9bb
TG
636### Q: I created a bridge and added a couple of Ethernet ports to it,
637### using commands like these:
c483d489
BP
638
639 ovs-vsctl add-br br0
640 ovs-vsctl add-port br0 eth0
641 ovs-vsctl add-port br0 eth1
642
643 and now my network seems to have melted: connectivity is unreliable
644 (even connectivity that doesn't go through Open vSwitch), all the
629a6b48
BP
645 LEDs on my physical switches are blinking, wireshark shows
646 duplicated packets, and CPU usage is very high.
c483d489
BP
647
648A: More than likely, you've looped your network. Probably, eth0 and
649 eth1 are connected to the same physical Ethernet switch. This
650 yields a scenario where OVS receives a broadcast packet on eth0 and
651 sends it out on eth1, then the physical switch connected to eth1
652 sends the packet back on eth0, and so on forever. More complicated
653 scenarios, involving a loop through multiple switches, are possible
654 too.
655
656 The solution depends on what you are trying to do:
657
542cc9bb
TG
658 - If you added eth0 and eth1 to get higher bandwidth or higher
659 reliability between OVS and your physical Ethernet switch,
660 use a bond. The following commands create br0 and then add
661 eth0 and eth1 as a bond:
c483d489 662
542cc9bb
TG
663 ovs-vsctl add-br br0
664 ovs-vsctl add-bond br0 bond0 eth0 eth1
c483d489 665
542cc9bb
TG
666 Bonds have tons of configuration options. Please read the
667 documentation on the Port table in ovs-vswitchd.conf.db(5)
668 for all the details.
c483d489 669
77c180ce
BM
670 Configuration for DPDK-enabled interfaces is slightly less
671 straightforward: see [INSTALL.DPDK.md].
672
542cc9bb
TG
673 - Perhaps you don't actually need eth0 and eth1 to be on the
674 same bridge. For example, if you simply want to be able to
675 connect each of them to virtual machines, then you can put
676 each of them on a bridge of its own:
c483d489 677
542cc9bb
TG
678 ovs-vsctl add-br br0
679 ovs-vsctl add-port br0 eth0
c483d489 680
542cc9bb
TG
681 ovs-vsctl add-br br1
682 ovs-vsctl add-port br1 eth1
c483d489 683
542cc9bb
TG
684 and then connect VMs to br0 and br1. (A potential
685 disadvantage is that traffic cannot directly pass between br0
686 and br1. Instead, it will go out eth0 and come back in eth1,
687 or vice versa.)
c483d489 688
542cc9bb
TG
689 - If you have a redundant or complex network topology and you
690 want to prevent loops, turn on spanning tree protocol (STP).
691 The following commands create br0, enable STP, and add eth0
692 and eth1 to the bridge. The order is important because you
693 don't want have to have a loop in your network even
694 transiently:
c483d489 695
542cc9bb
TG
696 ovs-vsctl add-br br0
697 ovs-vsctl set bridge br0 stp_enable=true
698 ovs-vsctl add-port br0 eth0
699 ovs-vsctl add-port br0 eth1
c483d489 700
542cc9bb
TG
701 The Open vSwitch implementation of STP is not well tested.
702 Please report any bugs you observe, but if you'd rather avoid
703 acting as a beta tester then another option might be your
704 best shot.
c483d489 705
542cc9bb 706### Q: I can't seem to use Open vSwitch in a wireless network.
c483d489
BP
707
708A: Wireless base stations generally only allow packets with the source
709 MAC address of NIC that completed the initial handshake.
710 Therefore, without MAC rewriting, only a single device can
711 communicate over a single wireless link.
712
713 This isn't specific to Open vSwitch, it's enforced by the access
714 point, so the same problems will show up with the Linux bridge or
715 any other way to do bridging.
716
542cc9bb 717### Q: I can't seem to add my PPP interface to an Open vSwitch bridge.
8748ec7b
BP
718
719A: PPP most commonly carries IP packets, but Open vSwitch works only
720 with Ethernet frames. The correct way to interface PPP to an
721 Ethernet network is usually to use routing instead of switching.
722
542cc9bb 723### Q: Is there any documentation on the database tables and fields?
5aa75474
BP
724
725A: Yes. ovs-vswitchd.conf.db(5) is a comprehensive reference.
726
542cc9bb 727### Q: When I run ovs-dpctl I no longer see the bridges I created. Instead,
acf60855
JP
728 I only see a datapath called "ovs-system". How can I see datapath
729 information about a particular bridge?
730
731A: In version 1.9.0, OVS switched to using a single datapath that is
732 shared by all bridges of that type. The "ovs-appctl dpif/*"
733 commands provide similar functionality that is scoped by the bridge.
734
542cc9bb 735### Q: I created a GRE port using ovs-vsctl so why can't I send traffic or
004a6249
JG
736 see the port in the datapath?
737
738A: On Linux kernels before 3.11, the OVS GRE module and Linux GRE module
739 cannot be loaded at the same time. It is likely that on your system the
740 Linux GRE module is already loaded and blocking OVS (to confirm, check
741 dmesg for errors regarding GRE registration). To fix this, unload all
742 GRE modules that appear in lsmod as well as the OVS kernel module. You
542cc9bb 743 can then reload the OVS module following the directions in
9feb1017 744 [INSTALL.md], which will ensure that dependencies are satisfied.
004a6249 745
542cc9bb 746### Q: Open vSwitch does not seem to obey my packet filter rules.
c6bbc394
YT
747
748A: It depends on mechanisms and configurations you want to use.
749
750 You cannot usefully use typical packet filters, like iptables, on
751 physical Ethernet ports that you add to an Open vSwitch bridge.
752 This is because Open vSwitch captures packets from the interface at
753 a layer lower below where typical packet-filter implementations
754 install their hooks. (This actually applies to any interface of
755 type "system" that you might add to an Open vSwitch bridge.)
756
757 You can usefully use typical packet filters on Open vSwitch
758 internal ports as they are mostly ordinary interfaces from the point
759 of view of packet filters.
760
761 For example, suppose you create a bridge br0 and add Ethernet port
762 eth0 to it. Then you can usefully add iptables rules to affect the
763 internal interface br0, but not the physical interface eth0. (br0
764 is also where you would add an IP address, as discussed elsewhere
765 in the FAQ.)
766
767 For simple filtering rules, it might be possible to achieve similar
768 results by installing appropriate OpenFlow flows instead.
769
770 If the use of a particular packet filter setup is essential, Open
771 vSwitch might not be the best choice for you. On Linux, you might
772 want to consider using the Linux Bridge. (This is the only choice if
773 you want to use ebtables rules.) On NetBSD, you might want to
774 consider using the bridge(4) with BRIDGE_IPF option.
775
542cc9bb 776### Q: It seems that Open vSwitch does nothing when I removed a port and
dd63a57e
YT
777 then immediately put it back. For example, consider that p1 is
778 a port of type=internal:
779
780 ovs-vsctl del-port br0 p1 -- \
781 add-port br0 p1 -- \
782 set interface p1 type=internal
783
784A: It's an expected behaviour.
785
7494dca8
YT
786 If del-port and add-port happen in a single OVSDB transaction as
787 your example, Open vSwitch always "skips" the intermediate steps.
dd63a57e
YT
788 Even if they are done in multiple transactions, it's still allowed
789 for Open vSwitch to skip the intermediate steps and just implement
790 the overall effect. In both cases, your example would be turned
791 into a no-op.
792
793 If you want to make Open vSwitch actually destroy and then re-create
794 the port for some side effects like resetting kernel setting for the
795 corresponding interface, you need to separate operations into multiple
796 OVSDB transactions and ensure that at least the first one does not have
797 --no-wait. In the following example, the first ovs-vsctl will block
798 until Open vSwitch reloads the new configuration and removes the port:
799
800 ovs-vsctl del-port br0 p1
801 ovs-vsctl add-port br0 p1 -- \
802 set interface p1 type=internal
c483d489 803
ed5c5110
BP
804### Q: I want to add thousands of ports to an Open vSwitch bridge, but
805 it takes too long (minutes or hours) to do it with ovs-vsctl. How
806 can I do it faster?
807
808A: If you add them one at a time with ovs-vsctl, it can take a long
809 time to add thousands of ports to an Open vSwitch bridge. This is
810 because every invocation of ovs-vsctl first reads the current
811 configuration from OVSDB. As the number of ports grows, this
812 starts to take an appreciable amount of time, and when it is
813 repeated thousands of times the total time becomes significant.
814
815 The solution is to add the ports in one invocation of ovs-vsctl (or
816 a small number of them). For example, using bash:
817
818 ovs-vsctl add-br br0
819 cmds=; for i in {1..5000}; do cmds+=" -- add-port br0 p$i"; done
820 ovs-vsctl $cmds
821
822 takes seconds, not minutes or hours, in the OVS sandbox environment.
823
bb50a697
BP
824### Q: I created a bridge named br0. My bridge shows up in "ovs-vsctl
825 show", but "ovs-ofctl show br0" just prints "br0 is not a bridge
826 or a socket".
827
828A: Open vSwitch wasn't able to create the bridge. Check the
829 ovs-vswitchd log for details (Debian and Red Hat packaging for Open
830 vSwitch put it in /var/log/openvswitch/ovs-vswitchd.log).
831
832 In general, the Open vSwitch database reflects the desired
833 configuration state. ovs-vswitchd monitors the database and, when
834 it changes, reconfigures the system to reflect the new desired
835 state. This normally happens very quickly. Thus, a discrepancy
836 between the database and the actual state indicates that
837 ovs-vswitchd could not implement the configuration, and so one
838 should check the log to find out why. (Another possible cause is
839 that ovs-vswitchd is not running. This will make "ovs-vsctl"
840 commands hang, if they change the configuration, unless one
841 specifies "--no-wait".)
842
843### Q: I have a bridge br0. I added a new port vif1.0, and it shows
844 up in "ovs-vsctl show", but "ovs-vsctl list port" says that it has
845 OpenFlow port ("ofport") -1, and "ovs-ofctl show br0" doesn't show
846 vif1.0 at all.
847
848A: Open vSwitch wasn't able to create the port. Check the
849 ovs-vswitchd log for details (Debian and Red Hat packaging for Open
850 vSwitch put it in /var/log/openvswitch/ovs-vswitchd.log). Please
851 see the previous question for more information.
852
853 You may want to upgrade to Open vSwitch 2.3 (or later), in which
854 ovs-vsctl will immediately report when there is an issue creating a
855 port.
856
1c98db0d
BP
857### Q: I created a tap device tap0, configured an IP address on it, and
858 added it to a bridge, like this:
859
860 tunctl -t tap0
861 ifconfig tap0 192.168.0.123
862 ovs-vsctl add-br br0
863 ovs-vsctl add-port br0 tap0
864
865 I expected that I could then use this IP address to contact other
866 hosts on the network, but it doesn't work. Why not?
867
868A: The short answer is that this is a misuse of a "tap" device. Use
869 an "internal" device implemented by Open vSwitch, which works
870 differently and is designed for this use. To solve this problem
871 with an internal device, instead run:
872
873 ovs-vsctl add-br br0
874 ovs-vsctl add-port br0 int0 -- set Interface int0 type=internal
875 ifconfig int0 192.168.0.123
876
877 Even more simply, you can take advantage of the internal port that
878 every bridge has under the name of the bridge:
879
880 ovs-vsctl add-br br0
881 ifconfig br0 192.168.0.123
882
883 In more detail, a "tap" device is an interface between the Linux
884 (or *BSD) network stack and a user program that opens it as a
885 socket. When the "tap" device transmits a packet, it appears in
886 the socket opened by the userspace program. Conversely, when the
887 userspace program writes to the "tap" socket, the kernel TCP/IP
888 stack processes the packet as if it had been received by the "tap"
889 device.
890
891 Consider the configuration above. Given this configuration, if you
892 "ping" an IP address in the 192.168.0.x subnet, the Linux kernel
893 routing stack will transmit an ARP on the tap0 device. Open
894 vSwitch userspace treats "tap" devices just like any other network
895 device; that is, it doesn't open them as "tap" sockets. That means
896 that the ARP packet will simply get dropped.
897
898 You might wonder why the Open vSwitch kernel module doesn't
899 intercept the ARP packet and bridge it. After all, Open vSwitch
900 intercepts packets on other devices. The answer is that Open
901 vSwitch only intercepts *received* packets, but this is a packet
902 being transmitted. The same thing happens for all other types of
903 network devices, except for Open vSwitch "internal" ports. If you,
904 for example, add a physical Ethernet port to an OVS bridge,
905 configure an IP address on a physical Ethernet port, and then issue
906 a "ping" to an address in that subnet, the same thing happens: an
907 ARP gets transmitted on the physical Ethernet port and Open vSwitch
908 never sees it. (You should not do that, as documented at the
909 beginning of this section.)
910
911 It can make sense to add a "tap" device to an Open vSwitch bridge,
912 if some userspace program (other than Open vSwitch) has opened the
913 tap socket. This is the case, for example, if the "tap" device was
914 created by KVM (or QEMU) to simulate a virtual NIC. In such a
915 case, when OVS bridges a packet to the "tap" device, the kernel
916 forwards that packet to KVM in userspace, which passes it along to
917 the VM, and in the other direction, when the VM sends a packet, KVM
918 writes it to the "tap" socket, which causes OVS to receive it and
919 bridge it to the other OVS ports. Please note that in such a case
920 no IP address is configured on the "tap" device (there is normally
921 an IP address configured in the virtual NIC inside the VM, but this
922 is not visible to the host Linux kernel or to Open vSwitch).
923
924 There is one special case in which Open vSwitch does directly read
925 and write "tap" sockets. This is an implementation detail of the
926 Open vSwitch userspace switch, which implements its "internal"
927 ports as Linux (or *BSD) "tap" sockets. In such a userspace
928 switch, OVS receives packets sent on the "tap" device used to
929 implement an "internal" port by reading the associated "tap"
930 socket, and bridges them to the rest of the switch. In the other
931 direction, OVS transmits packets bridged to the "internal" port by
932 writing them to the "tap" socket, causing them to be processed by
933 the kernel TCP/IP stack as if they had been received on the "tap"
934 device. Users should not need to be concerned with this
935 implementation detail.
936
937 Open vSwitch has a network device type called "tap". This is
938 intended only for implementing "internal" ports in the OVS
939 userspace switch and should not be used otherwise. In particular,
940 users should not configure KVM "tap" devices as type "tap" (use
941 type "system", the default, instead).
942
bb50a697 943
bceafb63
BP
944Quality of Service (QoS)
945------------------------
946
542cc9bb 947### Q: How do I configure Quality of Service (QoS)?
bceafb63
BP
948
949A: Suppose that you want to set up bridge br0 connected to physical
950 Ethernet port eth0 (a 1 Gbps device) and virtual machine interfaces
951 vif1.0 and vif2.0, and that you want to limit traffic from vif1.0
952 to eth0 to 10 Mbps and from vif2.0 to eth0 to 20 Mbps. Then, you
953 could configure the bridge this way:
954
955 ovs-vsctl -- \
956 add-br br0 -- \
0dc8b8c2
YT
957 add-port br0 eth0 -- \
958 add-port br0 vif1.0 -- set interface vif1.0 ofport_request=5 -- \
959 add-port br0 vif2.0 -- set interface vif2.0 ofport_request=6 -- \
960 set port eth0 qos=@newqos -- \
961 --id=@newqos create qos type=linux-htb \
bceafb63 962 other-config:max-rate=1000000000 \
0dc8b8c2
YT
963 queues:123=@vif10queue \
964 queues:234=@vif20queue -- \
bceafb63
BP
965 --id=@vif10queue create queue other-config:max-rate=10000000 -- \
966 --id=@vif20queue create queue other-config:max-rate=20000000
967
968 At this point, bridge br0 is configured with the ports and eth0 is
969 configured with the queues that you need for QoS, but nothing is
970 actually directing packets from vif1.0 or vif2.0 to the queues that
971 we have set up for them. That means that all of the packets to
972 eth0 are going to the "default queue", which is not what we want.
973
974 We use OpenFlow to direct packets from vif1.0 and vif2.0 to the
975 queues reserved for them:
976
977 ovs-ofctl add-flow br0 in_port=5,actions=set_queue:123,normal
978 ovs-ofctl add-flow br0 in_port=6,actions=set_queue:234,normal
979
980 Each of the above flows matches on the input port, sets up the
981 appropriate queue (123 for vif1.0, 234 for vif2.0), and then
982 executes the "normal" action, which performs the same switching
983 that Open vSwitch would have done without any OpenFlow flows being
984 present. (We know that vif1.0 and vif2.0 have OpenFlow port
985 numbers 5 and 6, respectively, because we set their ofport_request
986 columns above. If we had not done that, then we would have needed
987 to find out their port numbers before setting up these flows.)
988
989 Now traffic going from vif1.0 or vif2.0 to eth0 should be
990 rate-limited.
991
992 By the way, if you delete the bridge created by the above commands,
993 with:
994
995 ovs-vsctl del-br br0
996
997 then that will leave one unreferenced QoS record and two
998 unreferenced Queue records in the Open vSwich database. One way to
999 clear them out, assuming you don't have other QoS or Queue records
1000 that you want to keep, is:
1001
1002 ovs-vsctl -- --all destroy QoS -- --all destroy Queue
1003
7839bb41
BP
1004 If you do want to keep some QoS or Queue records, or the Open
1005 vSwitch you are using is older than version 1.8 (which added the
1006 --all option), then you will have to destroy QoS and Queue records
1007 individually.
1008
542cc9bb 1009### Q: I configured Quality of Service (QoS) in my OpenFlow network by
bceafb63
BP
1010 adding records to the QoS and Queue table, but the results aren't
1011 what I expect.
1012
1013A: Did you install OpenFlow flows that use your queues? This is the
1014 primary way to tell Open vSwitch which queues you want to use. If
1015 you don't do this, then the default queue will be used, which will
1016 probably not have the effect you want.
1017
1018 Refer to the previous question for an example.
1019
542cc9bb 1020### Q: I'd like to take advantage of some QoS feature that Open vSwitch
e6d29aa7
BP
1021 doesn't yet support. How do I do that?
1022
1023A: Open vSwitch does not implement QoS itself. Instead, it can
1024 configure some, but not all, of the QoS features built into the
1025 Linux kernel. If you need some QoS feature that OVS cannot
1026 configure itself, then the first step is to figure out whether
1027 Linux QoS supports that feature. If it does, then you can submit a
1028 patch to support Open vSwitch configuration for that feature, or
1029 you can use "tc" directly to configure the feature in Linux. (If
1030 Linux QoS doesn't support the feature you want, then first you have
1031 to add that support to Linux.)
1032
542cc9bb 1033### Q: I configured QoS, correctly, but my measurements show that it isn't
bceafb63
BP
1034 working as well as I expect.
1035
1036A: With the Linux kernel, the Open vSwitch implementation of QoS has
1037 two aspects:
1038
542cc9bb
TG
1039 - Open vSwitch configures a subset of Linux kernel QoS
1040 features, according to what is in OVSDB. It is possible that
1041 this code has bugs. If you believe that this is so, then you
1042 can configure the Linux traffic control (QoS) stack directly
1043 with the "tc" program. If you get better results that way,
1044 you can send a detailed bug report to bugs@openvswitch.org.
bceafb63 1045
542cc9bb
TG
1046 It is certain that Open vSwitch cannot configure every Linux
1047 kernel QoS feature. If you need some feature that OVS cannot
1048 configure, then you can also use "tc" directly (or add that
1049 feature to OVS).
bceafb63 1050
542cc9bb
TG
1051 - The Open vSwitch implementation of OpenFlow allows flows to
1052 be directed to particular queues. This is pretty simple and
1053 unlikely to have serious bugs at this point.
bceafb63
BP
1054
1055 However, most problems with QoS on Linux are not bugs in Open
1056 vSwitch at all. They tend to be either configuration errors
1057 (please see the earlier questions in this section) or issues with
1058 the traffic control (QoS) stack in Linux. The Open vSwitch
1059 developers are not experts on Linux traffic control. We suggest
1060 that, if you believe you are encountering a problem with Linux
1061 traffic control, that you consult the tc manpages (e.g. tc(8),
1062 tc-htb(8), tc-hfsc(8)), web resources (e.g. http://lartc.org/), or
1063 mailing lists (e.g. http://vger.kernel.org/vger-lists.html#netdev).
1064
542cc9bb 1065### Q: Does Open vSwitch support OpenFlow meters?
733fd270
BP
1066
1067A: Since version 2.0, Open vSwitch has OpenFlow protocol support for
1068 OpenFlow meters. There is no implementation of meters in the Open
1069 vSwitch software switch (neither the kernel-based nor userspace
1070 switches).
1071
bceafb63 1072
c483d489
BP
1073VLANs
1074-----
1075
542cc9bb 1076### Q: What's a VLAN?
14481051
BP
1077
1078A: At the simplest level, a VLAN (short for "virtual LAN") is a way to
1079 partition a single switch into multiple switches. Suppose, for
1080 example, that you have two groups of machines, group A and group B.
1081 You want the machines in group A to be able to talk to each other,
1082 and you want the machine in group B to be able to talk to each
1083 other, but you don't want the machines in group A to be able to
1084 talk to the machines in group B. You can do this with two
1085 switches, by plugging the machines in group A into one switch and
1086 the machines in group B into the other switch.
1087
1088 If you only have one switch, then you can use VLANs to do the same
1089 thing, by configuring the ports for machines in group A as VLAN
1090 "access ports" for one VLAN and the ports for group B as "access
1091 ports" for a different VLAN. The switch will only forward packets
1092 between ports that are assigned to the same VLAN, so this
1093 effectively subdivides your single switch into two independent
1094 switches, one for each group of machines.
1095
1096 So far we haven't said anything about VLAN headers. With access
1097 ports, like we've described so far, no VLAN header is present in
1098 the Ethernet frame. This means that the machines (or switches)
1099 connected to access ports need not be aware that VLANs are
1100 involved, just like in the case where we use two different physical
1101 switches.
1102
1103 Now suppose that you have a whole bunch of switches in your
1104 network, instead of just one, and that some machines in group A are
1105 connected directly to both switches 1 and 2. To allow these
1106 machines to talk to each other, you could add an access port for
1107 group A's VLAN to switch 1 and another to switch 2, and then
1108 connect an Ethernet cable between those ports. That works fine,
1109 but it doesn't scale well as the number of switches and the number
1110 of VLANs increases, because you use up a lot of valuable switch
1111 ports just connecting together your VLANs.
1112
1113 This is where VLAN headers come in. Instead of using one cable and
1114 two ports per VLAN to connect a pair of switches, we configure a
1115 port on each switch as a VLAN "trunk port". Packets sent and
1116 received on a trunk port carry a VLAN header that says what VLAN
1117 the packet belongs to, so that only two ports total are required to
1118 connect the switches, regardless of the number of VLANs in use.
1119 Normally, only switches (either physical or virtual) are connected
1120 to a trunk port, not individual hosts, because individual hosts
1121 don't expect to see a VLAN header in the traffic that they receive.
1122
1123 None of the above discussion says anything about particular VLAN
1124 numbers. This is because VLAN numbers are completely arbitrary.
1125 One must only ensure that a given VLAN is numbered consistently
1126 throughout a network and that different VLANs are given different
1127 numbers. (That said, VLAN 0 is usually synonymous with a packet
1128 that has no VLAN header, and VLAN 4095 is reserved.)
1129
542cc9bb 1130### Q: VLANs don't work.
c483d489
BP
1131
1132A: Many drivers in Linux kernels before version 3.3 had VLAN-related
1133 bugs. If you are having problems with VLANs that you suspect to be
1134 driver related, then you have several options:
1135
542cc9bb 1136 - Upgrade to Linux 3.3 or later.
c483d489 1137
542cc9bb
TG
1138 - Build and install a fixed version of the particular driver
1139 that is causing trouble, if one is available.
c483d489 1140
542cc9bb 1141 - Use a NIC whose driver does not have VLAN problems.
c483d489 1142
542cc9bb
TG
1143 - Use "VLAN splinters", a feature in Open vSwitch 1.4 and later
1144 that works around bugs in kernel drivers. To enable VLAN
1145 splinters on interface eth0, use the command:
c483d489 1146
542cc9bb 1147 ovs-vsctl set interface eth0 other-config:enable-vlan-splinters=true
c483d489 1148
542cc9bb
TG
1149 For VLAN splinters to be effective, Open vSwitch must know
1150 which VLANs are in use. See the "VLAN splinters" section in
1151 the Interface table in ovs-vswitchd.conf.db(5) for details on
1152 how Open vSwitch infers in-use VLANs.
c483d489 1153
542cc9bb
TG
1154 VLAN splinters increase memory use and reduce performance, so
1155 use them only if needed.
c483d489 1156
542cc9bb
TG
1157 - Apply the "vlan workaround" patch from the XenServer kernel
1158 patch queue, build Open vSwitch against this patched kernel,
1159 and then use ovs-vlan-bug-workaround(8) to enable the VLAN
1160 workaround for each interface whose driver is buggy.
c483d489 1161
542cc9bb
TG
1162 (This is a nontrivial exercise, so this option is included
1163 only for completeness.)
c483d489
BP
1164
1165 It is not always easy to tell whether a Linux kernel driver has
1166 buggy VLAN support. The ovs-vlan-test(8) and ovs-test(8) utilities
1167 can help you test. See their manpages for details. Of the two
1168 utilities, ovs-test(8) is newer and more thorough, but
1169 ovs-vlan-test(8) may be easier to use.
1170
542cc9bb 1171### Q: VLANs still don't work. I've tested the driver so I know that it's OK.
c483d489
BP
1172
1173A: Do you have VLANs enabled on the physical switch that OVS is
1174 attached to? Make sure that the port is configured to trunk the
1175 VLAN or VLANs that you are using with OVS.
1176
542cc9bb 1177### Q: Outgoing VLAN-tagged traffic goes through OVS to my physical switch
c483d489
BP
1178 and to its destination host, but OVS seems to drop incoming return
1179 traffic.
1180
1181A: It's possible that you have the VLAN configured on your physical
1182 switch as the "native" VLAN. In this mode, the switch treats
1183 incoming packets either tagged with the native VLAN or untagged as
1184 part of the native VLAN. It may also send outgoing packets in the
1185 native VLAN without a VLAN tag.
1186
1187 If this is the case, you have two choices:
1188
542cc9bb
TG
1189 - Change the physical switch port configuration to tag packets
1190 it forwards to OVS with the native VLAN instead of forwarding
1191 them untagged.
c483d489 1192
542cc9bb
TG
1193 - Change the OVS configuration for the physical port to a
1194 native VLAN mode. For example, the following sets up a
1195 bridge with port eth0 in "native-tagged" mode in VLAN 9:
c483d489 1196
542cc9bb
TG
1197 ovs-vsctl add-br br0
1198 ovs-vsctl add-port br0 eth0 tag=9 vlan_mode=native-tagged
c483d489 1199
542cc9bb
TG
1200 In this situation, "native-untagged" mode will probably work
1201 equally well. Refer to the documentation for the Port table
1202 in ovs-vswitchd.conf.db(5) for more information.
c483d489 1203
542cc9bb 1204### Q: I added a pair of VMs on different VLANs, like this:
8d45e938
BP
1205
1206 ovs-vsctl add-br br0
1207 ovs-vsctl add-port br0 eth0
1208 ovs-vsctl add-port br0 tap0 tag=9
1209 ovs-vsctl add-port br0 tap1 tag=10
1210
1211 but the VMs can't access each other, the external network, or the
1212 Internet.
1213
1214A: It is to be expected that the VMs can't access each other. VLANs
1215 are a means to partition a network. When you configured tap0 and
1216 tap1 as access ports for different VLANs, you indicated that they
1217 should be isolated from each other.
1218
1219 As for the external network and the Internet, it seems likely that
1220 the machines you are trying to access are not on VLAN 9 (or 10) and
1221 that the Internet is not available on VLAN 9 (or 10).
1222
542cc9bb 1223### Q: I added a pair of VMs on the same VLAN, like this:
3c8399a2
BP
1224
1225 ovs-vsctl add-br br0
1226 ovs-vsctl add-port br0 eth0
1227 ovs-vsctl add-port br0 tap0 tag=9
1228 ovs-vsctl add-port br0 tap1 tag=9
1229
1230 The VMs can access each other, but not the external network or the
1231 Internet.
1232
1233A: It seems likely that the machines you are trying to access in the
1234 external network are not on VLAN 9 and that the Internet is not
1235 available on VLAN 9. Also, ensure VLAN 9 is set up as an allowed
1236 trunk VLAN on the upstream switch port to which eth0 is connected.
1237
542cc9bb 1238### Q: Can I configure an IP address on a VLAN?
c483d489
BP
1239
1240A: Yes. Use an "internal port" configured as an access port. For
1241 example, the following configures IP address 192.168.0.7 on VLAN 9.
1242 That is, OVS will forward packets from eth0 to 192.168.0.7 only if
1243 they have an 802.1Q header with VLAN 9. Conversely, traffic
1244 forwarded from 192.168.0.7 to eth0 will be tagged with an 802.1Q
1245 header with VLAN 9:
1246
1247 ovs-vsctl add-br br0
1248 ovs-vsctl add-port br0 eth0
1249 ovs-vsctl add-port br0 vlan9 tag=9 -- set interface vlan9 type=internal
1250 ifconfig vlan9 192.168.0.7
1251
8dc54921
BP
1252 See also the following question.
1253
542cc9bb 1254### Q: I configured one IP address on VLAN 0 and another on VLAN 9, like
8dc54921
BP
1255 this:
1256
1257 ovs-vsctl add-br br0
1258 ovs-vsctl add-port br0 eth0
1259 ifconfig br0 192.168.0.5
1260 ovs-vsctl add-port br0 vlan9 tag=9 -- set interface vlan9 type=internal
1261 ifconfig vlan9 192.168.0.9
1262
1263 but other hosts that are only on VLAN 0 can reach the IP address
1264 configured on VLAN 9. What's going on?
1265
1266A: RFC 1122 section 3.3.4.2 "Multihoming Requirements" describes two
1267 approaches to IP address handling in Internet hosts:
1268
542cc9bb
TG
1269 - In the "Strong ES Model", where an ES is a host ("End
1270 System"), an IP address is primarily associated with a
1271 particular interface. The host discards packets that arrive
1272 on interface A if they are destined for an IP address that is
1273 configured on interface B. The host never sends packets from
1274 interface A using a source address configured on interface B.
1275
1276 - In the "Weak ES Model", an IP address is primarily associated
1277 with a host. The host accepts packets that arrive on any
1278 interface if they are destined for any of the host's IP
1279 addresses, even if the address is configured on some
1280 interface other than the one on which it arrived. The host
1281 does not restrict itself to sending packets from an IP
1282 address associated with the originating interface.
8dc54921
BP
1283
1284 Linux uses the weak ES model. That means that when packets
1285 destined to the VLAN 9 IP address arrive on eth0 and are bridged to
1286 br0, the kernel IP stack accepts them there for the VLAN 9 IP
1287 address, even though they were not received on vlan9, the network
1288 device for vlan9.
1289
1290 To simulate the strong ES model on Linux, one may add iptables rule
1291 to filter packets based on source and destination address and
1292 adjust ARP configuration with sysctls.
1293
1294 BSD uses the strong ES model.
1295
542cc9bb 1296### Q: My OpenFlow controller doesn't see the VLANs that I expect.
c483d489
BP
1297
1298A: The configuration for VLANs in the Open vSwitch database (e.g. via
1299 ovs-vsctl) only affects traffic that goes through Open vSwitch's
1300 implementation of the OpenFlow "normal switching" action. By
1301 default, when Open vSwitch isn't connected to a controller and
1302 nothing has been manually configured in the flow table, all traffic
1303 goes through the "normal switching" action. But, if you set up
1304 OpenFlow flows on your own, through a controller or using ovs-ofctl
1305 or through other means, then you have to implement VLAN handling
1306 yourself.
1307
1308 You can use "normal switching" as a component of your OpenFlow
1309 actions, e.g. by putting "normal" into the lists of actions on
1310 ovs-ofctl or by outputting to OFPP_NORMAL from an OpenFlow
241241f5
BP
1311 controller. In situations where this is not suitable, you can
1312 implement VLAN handling yourself, e.g.:
1313
542cc9bb
TG
1314 - If a packet comes in on an access port, and the flow table
1315 needs to send it out on a trunk port, then the flow can add
1316 the appropriate VLAN tag with the "mod_vlan_vid" action.
241241f5 1317
542cc9bb
TG
1318 - If a packet comes in on a trunk port, and the flow table
1319 needs to send it out on an access port, then the flow can
1320 strip the VLAN tag with the "strip_vlan" action.
c483d489 1321
542cc9bb 1322### Q: I configured ports on a bridge as access ports with different VLAN
f0a0c1a6
BP
1323 tags, like this:
1324
1325 ovs-vsctl add-br br0
d4763d1d 1326 ovs-vsctl set-controller br0 tcp:192.168.0.10:6653
f0a0c1a6
BP
1327 ovs-vsctl add-port br0 eth0
1328 ovs-vsctl add-port br0 tap0 tag=9
1329 ovs-vsctl add-port br0 tap1 tag=10
1330
1331 but the VMs running behind tap0 and tap1 can still communicate,
1332 that is, they are not isolated from each other even though they are
1333 on different VLANs.
1334
1335A: Do you have a controller configured on br0 (as the commands above
1336 do)? If so, then this is a variant on the previous question, "My
1337 OpenFlow controller doesn't see the VLANs that I expect," and you
1338 can refer to the answer there for more information.
1339
542cc9bb 1340### Q: How MAC learning works with VLANs?
f8003b53
YT
1341
1342A: Open vSwitch implements Independent VLAN Learning (IVL) for
1343 OFPP_NORMAL action. I.e. it logically has separate learning tables
1344 for each VLANs.
1345
c483d489 1346
0edbe3fb
KM
1347VXLANs
1348-----
1349
542cc9bb 1350### Q: What's a VXLAN?
0edbe3fb
KM
1351
1352A: VXLAN stands for Virtual eXtensible Local Area Network, and is a means
1353 to solve the scaling challenges of VLAN networks in a multi-tenant
1354 environment. VXLAN is an overlay network which transports an L2 network
1355 over an existing L3 network. For more information on VXLAN, please see
bedd6854 1356 RFC 7348:
0edbe3fb 1357
bedd6854 1358 http://tools.ietf.org/html/rfc7348
0edbe3fb 1359
542cc9bb 1360### Q: How much of the VXLAN protocol does Open vSwitch currently support?
0edbe3fb
KM
1361
1362A: Open vSwitch currently supports the framing format for packets on the
1363 wire. There is currently no support for the multicast aspects of VXLAN.
1364 To get around the lack of multicast support, it is possible to
1365 pre-provision MAC to IP address mappings either manually or from a
1366 controller.
1367
542cc9bb 1368### Q: What destination UDP port does the VXLAN implementation in Open vSwitch
0edbe3fb
KM
1369 use?
1370
1371A: By default, Open vSwitch will use the assigned IANA port for VXLAN, which
1372 is 4789. However, it is possible to configure the destination UDP port
1373 manually on a per-VXLAN tunnel basis. An example of this configuration is
1374 provided below.
1375
b770275d
RÃ…A
1376 ovs-vsctl add-br br0
1377 ovs-vsctl add-port br0 vxlan1 -- set interface vxlan1
0edbe3fb
KM
1378 type=vxlan options:remote_ip=192.168.1.2 options:key=flow
1379 options:dst_port=8472
1380
1381
0f5edef0
BP
1382Using OpenFlow (Manually or Via Controller)
1383-------------------------------------------
c483d489 1384
542cc9bb 1385### Q: What versions of OpenFlow does Open vSwitch support?
7b287e99 1386
c37c0382
AC
1387A: The following table lists the versions of OpenFlow supported by
1388 each version of Open vSwitch:
7b287e99 1389
42dccab5 1390 Open vSwitch OF1.0 OF1.1 OF1.2 OF1.3 OF1.4 OF1.5
542cc9bb 1391 ###============ ===== ===== ===== ===== ===== =====
42dccab5
BP
1392 1.9 and earlier yes --- --- --- --- ---
1393 1.10 yes --- [*] [*] --- ---
1394 1.11 yes --- [*] [*] --- ---
1395 2.0 yes [*] [*] [*] --- ---
1396 2.1 yes [*] [*] [*] --- ---
1397 2.2 yes [*] [*] [*] [%] [*]
1398 2.3 yes yes yes yes [*] [*]
8e70e196 1399
c37c0382 1400 [*] Supported, with one or more missing features.
aa233d57 1401 [%] Experimental, unsafe implementation.
8e70e196 1402
6dc53744
BP
1403 Open vSwitch 2.3 enables OpenFlow 1.0, 1.1, 1.2, and 1.3 by default
1404 in ovs-vswitchd. In Open vSwitch 1.10 through 2.2, OpenFlow 1.1,
aa233d57 1405 1.2, and 1.3 must be enabled manually in ovs-vswitchd. OpenFlow
42dccab5
BP
1406 1.4 and 1.5 are also supported, with missing features, in Open
1407 vSwitch 2.3 and later, but not enabled by default. In any case,
1408 the user may override the default:
75fa58f8 1409
542cc9bb 1410 - To enable OpenFlow 1.0, 1.1, 1.2, and 1.3 on bridge br0:
75fa58f8 1411
542cc9bb 1412 ovs-vsctl set bridge br0 protocols=OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13
6dc53744 1413
542cc9bb 1414 - To enable OpenFlow 1.0, 1.1, 1.2, 1.3, 1.4, and 1.5 on bridge br0:
aa233d57 1415
542cc9bb 1416 ovs-vsctl set bridge br0 protocols=OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13,OpenFlow14,OpenFlow15
aa233d57 1417
542cc9bb 1418 - To enable only OpenFlow 1.0 on bridge br0:
6dc53744 1419
542cc9bb 1420 ovs-vsctl set bridge br0 protocols=OpenFlow10
6dc53744
BP
1421
1422 All current versions of ovs-ofctl enable only OpenFlow 1.0 by
1423 default. Use the -O option to enable support for later versions of
1424 OpenFlow in ovs-ofctl. For example:
ac12b4cb
BP
1425
1426 ovs-ofctl -O OpenFlow13 dump-flows br0
1427
aa233d57
BP
1428 (Open vSwitch 2.2 had an experimental implementation of OpenFlow
1429 1.4 that could cause crashes. We don't recommend enabling it.)
ecb229be 1430
9feb1017 1431 [OPENFLOW-1.1+.md] in the Open vSwitch source tree tracks support for
42dccab5
BP
1432 OpenFlow 1.1 and later features. When support for OpenFlow 1.4 and
1433 1.5 is solidly implemented, Open vSwitch will enable those version
8c0de36e 1434 by default.
7b287e99 1435
542cc9bb 1436### Q: Does Open vSwitch support MPLS?
c78a9ead
BP
1437
1438A: Before version 1.11, Open vSwitch did not support MPLS. That is,
1439 these versions can match on MPLS Ethernet types, but they cannot
1440 match, push, or pop MPLS labels, nor can they look past MPLS labels
1441 into the encapsulated packet.
1442
1443 Open vSwitch versions 1.11, 2.0, and 2.1 have very minimal support
1444 for MPLS. With the userspace datapath only, these versions can
1445 match, push, or pop a single MPLS label, but they still cannot look
1446 past MPLS labels (even after popping them) into the encapsulated
7e6410d2
BP
1447 packet. Kernel datapath support is unchanged from earlier
1448 versions.
c78a9ead 1449
b6fe204d
BP
1450 Open vSwitch version 2.3 can match, push, or pop a single MPLS
1451 label and look past the MPLS label into the encapsulated packet.
1452 Both userspace and kernel datapaths will be supported, but MPLS
1453 processing always happens in userspace either way, so kernel
1454 datapath performance will be disappointing.
1455
1456 Open vSwitch version 2.4 can match, push, or pop up to 3 MPLS
1457 labels and look past the MPLS label into the encapsulated packet.
1458 It will have kernel support for MPLS, yielding improved
1459 performance.
c78a9ead 1460
542cc9bb 1461### Q: I'm getting "error type 45250 code 0". What's that?
c483d489
BP
1462
1463A: This is a Open vSwitch extension to OpenFlow error codes. Open
1464 vSwitch uses this extension when it must report an error to an
1465 OpenFlow controller but no standard OpenFlow error code is
1466 suitable.
1467
1468 Open vSwitch logs the errors that it sends to controllers, so the
1469 easiest thing to do is probably to look at the ovs-vswitchd log to
1470 find out what the error was.
1471
1472 If you want to dissect the extended error message yourself, the
1473 format is documented in include/openflow/nicira-ext.h in the Open
1474 vSwitch source distribution. The extended error codes are
1475 documented in lib/ofp-errors.h.
1476
1477Q1: Some of the traffic that I'd expect my OpenFlow controller to see
1478 doesn't actually appear through the OpenFlow connection, even
1479 though I know that it's going through.
1480Q2: Some of the OpenFlow flows that my controller sets up don't seem
1481 to apply to certain traffic, especially traffic between OVS and
1482 the controller itself.
1483
1484A: By default, Open vSwitch assumes that OpenFlow controllers are
1485 connected "in-band", that is, that the controllers are actually
1486 part of the network that is being controlled. In in-band mode,
1487 Open vSwitch sets up special "hidden" flows to make sure that
1488 traffic can make it back and forth between OVS and the controllers.
1489 These hidden flows are higher priority than any flows that can be
1490 set up through OpenFlow, and they are not visible through normal
1491 OpenFlow flow table dumps.
1492
1493 Usually, the hidden flows are desirable and helpful, but
1494 occasionally they can cause unexpected behavior. You can view the
1495 full OpenFlow flow table, including hidden flows, on bridge br0
1496 with the command:
1497
1498 ovs-appctl bridge/dump-flows br0
1499
1500 to help you debug. The hidden flows are those with priorities
1501 greater than 65535 (the maximum priority that can be set with
1502 OpenFlow).
1503
1504 The DESIGN file at the top level of the Open vSwitch source
1505 distribution describes the in-band model in detail.
1506
1507 If your controllers are not actually in-band (e.g. they are on
1508 localhost via 127.0.0.1, or on a separate network), then you should
1509 configure your controllers in "out-of-band" mode. If you have one
1510 controller on bridge br0, then you can configure out-of-band mode
1511 on it with:
1512
1513 ovs-vsctl set controller br0 connection-mode=out-of-band
1514
542cc9bb 1515### Q: I configured all my controllers for out-of-band control mode but
c483d489
BP
1516 "ovs-appctl bridge/dump-flows" still shows some hidden flows.
1517
1518A: You probably have a remote manager configured (e.g. with "ovs-vsctl
1519 set-manager"). By default, Open vSwitch assumes that managers need
1520 in-band rules set up on every bridge. You can disable these rules
1521 on bridge br0 with:
1522
1523 ovs-vsctl set bridge br0 other-config:disable-in-band=true
1524
1525 This actually disables in-band control entirely for the bridge, as
1526 if all the bridge's controllers were configured for out-of-band
1527 control.
1528
542cc9bb 1529### Q: My OpenFlow controller doesn't see the VLANs that I expect.
c483d489
BP
1530
1531A: See answer under "VLANs", above.
1532
542cc9bb 1533### Q: I ran "ovs-ofctl add-flow br0 nw_dst=192.168.0.1,actions=drop"
5cb2356b
BP
1534 but I got a funny message like this:
1535
1536 ofp_util|INFO|normalization changed ofp_match, details:
1537 ofp_util|INFO| pre: nw_dst=192.168.0.1
1538 ofp_util|INFO|post:
1539
1540 and when I ran "ovs-ofctl dump-flows br0" I saw that my nw_dst
1541 match had disappeared, so that the flow ends up matching every
1542 packet.
1543
1544A: The term "normalization" in the log message means that a flow
1545 cannot match on an L3 field without saying what L3 protocol is in
1546 use. The "ovs-ofctl" command above didn't specify an L3 protocol,
1547 so the L3 field match was dropped.
1548
1549 In this case, the L3 protocol could be IP or ARP. A correct
1550 command for each possibility is, respectively:
1551
1552 ovs-ofctl add-flow br0 ip,nw_dst=192.168.0.1,actions=drop
1553
1554 and
1555
1556 ovs-ofctl add-flow br0 arp,nw_dst=192.168.0.1,actions=drop
1557
1558 Similarly, a flow cannot match on an L4 field without saying what
1559 L4 protocol is in use. For example, the flow match "tp_src=1234"
1560 is, by itself, meaningless and will be ignored. Instead, to match
1561 TCP source port 1234, write "tcp,tp_src=1234", or to match UDP
1562 source port 1234, write "udp,tp_src=1234".
1563
542cc9bb 1564### Q: How can I figure out the OpenFlow port number for a given port?
c5b25863
BP
1565
1566A: The OFPT_FEATURES_REQUEST message requests an OpenFlow switch to
1567 respond with an OFPT_FEATURES_REPLY that, among other information,
1568 includes a mapping between OpenFlow port names and numbers. From a
1569 command prompt, "ovs-ofctl show br0" makes such a request and
1570 prints the response for switch br0.
1571
1572 The Interface table in the Open vSwitch database also maps OpenFlow
1573 port names to numbers. To print the OpenFlow port number
1574 associated with interface eth0, run:
1575
1576 ovs-vsctl get Interface eth0 ofport
1577
1578 You can print the entire mapping with:
1579
1580 ovs-vsctl -- --columns=name,ofport list Interface
1581
1582 but the output mixes together interfaces from all bridges in the
1583 database, so it may be confusing if more than one bridge exists.
1584
1585 In the Open vSwitch database, ofport value -1 means that the
1586 interface could not be created due to an error. (The Open vSwitch
1587 log should indicate the reason.) ofport value [] (the empty set)
1588 means that the interface hasn't been created yet. The latter is
1589 normally an intermittent condition (unless ovs-vswitchd is not
1590 running).
7b287e99 1591
542cc9bb 1592### Q: I added some flows with my controller or with ovs-ofctl, but when I
af1ac4b9
BP
1593 run "ovs-dpctl dump-flows" I don't see them.
1594
1595A: ovs-dpctl queries a kernel datapath, not an OpenFlow switch. It
1596 won't display the information that you want. You want to use
1597 "ovs-ofctl dump-flows" instead.
1598
542cc9bb 1599### Q: It looks like each of the interfaces in my bonded port shows up
15d63ed3
BP
1600 as an individual OpenFlow port. Is that right?
1601
1602A: Yes, Open vSwitch makes individual bond interfaces visible as
1603 OpenFlow ports, rather than the bond as a whole. The interfaces
1604 are treated together as a bond for only a few purposes:
1605
542cc9bb
TG
1606 - Sending a packet to the OFPP_NORMAL port. (When an OpenFlow
1607 controller is not configured, this happens implicitly to
1608 every packet.)
15d63ed3 1609
542cc9bb 1610 - Mirrors configured for output to a bonded port.
15d63ed3
BP
1611
1612 It would make a lot of sense for Open vSwitch to present a bond as
1613 a single OpenFlow port. If you want to contribute an
1614 implementation of such a feature, please bring it up on the Open
1615 vSwitch development mailing list at dev@openvswitch.org.
1616
542cc9bb 1617### Q: I have a sophisticated network setup involving Open vSwitch, VMs or
bb955418
BP
1618 multiple hosts, and other components. The behavior isn't what I
1619 expect. Help!
1620
1621A: To debug network behavior problems, trace the path of a packet,
1622 hop-by-hop, from its origin in one host to a remote host. If
1623 that's correct, then trace the path of the response packet back to
1624 the origin.
1625
1626 Usually a simple ICMP echo request and reply ("ping") packet is
1627 good enough. Start by initiating an ongoing "ping" from the origin
1628 host to a remote host. If you are tracking down a connectivity
1629 problem, the "ping" will not display any successful output, but
1630 packets are still being sent. (In this case the packets being sent
1631 are likely ARP rather than ICMP.)
1632
1633 Tools available for tracing include the following:
1634
542cc9bb
TG
1635 - "tcpdump" and "wireshark" for observing hops across network
1636 devices, such as Open vSwitch internal devices and physical
1637 wires.
bb955418 1638
542cc9bb
TG
1639 - "ovs-appctl dpif/dump-flows <br>" in Open vSwitch 1.10 and
1640 later or "ovs-dpctl dump-flows <br>" in earlier versions.
1641 These tools allow one to observe the actions being taken on
1642 packets in ongoing flows.
bb955418 1643
542cc9bb
TG
1644 See ovs-vswitchd(8) for "ovs-appctl dpif/dump-flows"
1645 documentation, ovs-dpctl(8) for "ovs-dpctl dump-flows"
1646 documentation, and "Why are there so many different ways to
1647 dump flows?" above for some background.
bb955418 1648
542cc9bb
TG
1649 - "ovs-appctl ofproto/trace" to observe the logic behind how
1650 ovs-vswitchd treats packets. See ovs-vswitchd(8) for
1651 documentation. You can out more details about a given flow
1652 that "ovs-dpctl dump-flows" displays, by cutting and pasting
1653 a flow from the output into an "ovs-appctl ofproto/trace"
1654 command.
bb955418 1655
542cc9bb
TG
1656 - SPAN, RSPAN, and ERSPAN features of physical switches, to
1657 observe what goes on at these physical hops.
bb955418
BP
1658
1659 Starting at the origin of a given packet, observe the packet at
1660 each hop in turn. For example, in one plausible scenario, you
1661 might:
1662
542cc9bb
TG
1663 1. "tcpdump" the "eth" interface through which an ARP egresses
1664 a VM, from inside the VM.
bb955418 1665
542cc9bb
TG
1666 2. "tcpdump" the "vif" or "tap" interface through which the ARP
1667 ingresses the host machine.
bb955418 1668
542cc9bb
TG
1669 3. Use "ovs-dpctl dump-flows" to spot the ARP flow and observe
1670 the host interface through which the ARP egresses the
1671 physical machine. You may need to use "ovs-dpctl show" to
1672 interpret the port numbers. If the output seems surprising,
1673 you can use "ovs-appctl ofproto/trace" to observe details of
1674 how ovs-vswitchd determined the actions in the "ovs-dpctl
1675 dump-flows" output.
bb955418 1676
542cc9bb
TG
1677 4. "tcpdump" the "eth" interface through which the ARP egresses
1678 the physical machine.
bb955418 1679
542cc9bb
TG
1680 5. "tcpdump" the "eth" interface through which the ARP
1681 ingresses the physical machine, at the remote host that
1682 receives the ARP.
bb955418 1683
542cc9bb
TG
1684 6. Use "ovs-dpctl dump-flows" to spot the ARP flow on the
1685 remote host that receives the ARP and observe the VM "vif"
1686 or "tap" interface to which the flow is directed. Again,
1687 "ovs-dpctl show" and "ovs-appctl ofproto/trace" might help.
bb955418 1688
542cc9bb
TG
1689 7. "tcpdump" the "vif" or "tap" interface to which the ARP is
1690 directed.
bb955418 1691
542cc9bb
TG
1692 8. "tcpdump" the "eth" interface through which the ARP
1693 ingresses a VM, from inside the VM.
bb955418
BP
1694
1695 It is likely that during one of these steps you will figure out the
1696 problem. If not, then follow the ARP reply back to the origin, in
1697 reverse.
1698
542cc9bb 1699### Q: How do I make a flow drop packets?
0f5edef0 1700
e5f1da19
BP
1701A: To drop a packet is to receive it without forwarding it. OpenFlow
1702 explicitly specifies forwarding actions. Thus, a flow with an
1703 empty set of actions does not forward packets anywhere, causing
1704 them to be dropped. You can specify an empty set of actions with
1705 "actions=" on the ovs-ofctl command line. For example:
0f5edef0
BP
1706
1707 ovs-ofctl add-flow br0 priority=65535,actions=
1708
1709 would cause every packet entering switch br0 to be dropped.
1710
1711 You can write "drop" explicitly if you like. The effect is the
1712 same. Thus, the following command also causes every packet
1713 entering switch br0 to be dropped:
1714
1715 ovs-ofctl add-flow br0 priority=65535,actions=drop
1716
e5f1da19
BP
1717 "drop" is not an action, either in OpenFlow or Open vSwitch.
1718 Rather, it is only a way to say that there are no actions.
1719
542cc9bb 1720### Q: I added a flow to send packets out the ingress port, like this:
2fafc091
BP
1721
1722 ovs-ofctl add-flow br0 in_port=2,actions=2
1723
1724 but OVS drops the packets instead.
1725
1726A: Yes, OpenFlow requires a switch to ignore attempts to send a packet
1727 out its ingress port. The rationale is that dropping these packets
1728 makes it harder to loop the network. Sometimes this behavior can
1729 even be convenient, e.g. it is often the desired behavior in a flow
1730 that forwards a packet to several ports ("floods" the packet).
1731
6620f928
JS
1732 Sometimes one really needs to send a packet out its ingress port
1733 ("hairpin"). In this case, output to OFPP_IN_PORT, which in
1734 ovs-ofctl syntax is expressed as just "in_port", e.g.:
2fafc091
BP
1735
1736 ovs-ofctl add-flow br0 in_port=2,actions=in_port
1737
1738 This also works in some circumstances where the flow doesn't match
1739 on the input port. For example, if you know that your switch has
1740 five ports numbered 2 through 6, then the following will send every
1741 received packet out every port, even its ingress port:
1742
1743 ovs-ofctl add-flow br0 actions=2,3,4,5,6,in_port
1744
1745 or, equivalently:
1746
1747 ovs-ofctl add-flow br0 actions=all,in_port
1748
1749 Sometimes, in complicated flow tables with multiple levels of
1750 "resubmit" actions, a flow needs to output to a particular port
1751 that may or may not be the ingress port. It's difficult to take
1752 advantage of OFPP_IN_PORT in this situation. To help, Open vSwitch
1753 provides, as an OpenFlow extension, the ability to modify the
1754 in_port field. Whatever value is currently in the in_port field is
1755 the port to which outputs will be dropped, as well as the
1756 destination for OFPP_IN_PORT. This means that the following will
1757 reliably output to port 2 or to ports 2 through 6, respectively:
1758
1759 ovs-ofctl add-flow br0 in_port=2,actions=load:0->NXM_OF_IN_PORT[],2
1760 ovs-ofctl add-flow br0 actions=load:0->NXM_OF_IN_PORT[],2,3,4,5,6
1761
1762 If the input port is important, then one may save and restore it on
1763 the stack:
1764
1765 ovs-ofctl add-flow br0 actions=push:NXM_OF_IN_PORT[],\
1766 load:0->NXM_OF_IN_PORT[],\
1767 2,3,4,5,6,\
1768 pop:NXM_OF_IN_PORT[]
1769
542cc9bb 1770### Q: My bridge br0 has host 192.168.0.1 on port 1 and host 192.168.0.2
d4ee72b4
BP
1771 on port 2. I set up flows to forward only traffic destined to the
1772 other host and drop other traffic, like this:
1773
1774 priority=5,in_port=1,ip,nw_dst=192.168.0.2,actions=2
1775 priority=5,in_port=2,ip,nw_dst=192.168.0.1,actions=1
1776 priority=0,actions=drop
1777
1778 But it doesn't work--I don't get any connectivity when I do this.
1779 Why?
1780
1781A: These flows drop the ARP packets that IP hosts use to establish IP
1782 connectivity over Ethernet. To solve the problem, add flows to
1783 allow ARP to pass between the hosts:
1784
1785 priority=5,in_port=1,arp,actions=2
1786 priority=5,in_port=2,arp,actions=1
1787
1788 This issue can manifest other ways, too. The following flows that
1789 match on Ethernet addresses instead of IP addresses will also drop
1790 ARP packets, because ARP requests are broadcast instead of being
1791 directed to a specific host:
1792
1793 priority=5,in_port=1,dl_dst=54:00:00:00:00:02,actions=2
1794 priority=5,in_port=2,dl_dst=54:00:00:00:00:01,actions=1
1795 priority=0,actions=drop
1796
1797 The solution already described above will also work in this case.
1798 It may be better to add flows to allow all multicast and broadcast
1799 traffic:
1800
1801 priority=5,in_port=1,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00,actions=2
1802 priority=5,in_port=2,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00,actions=1
0f5edef0 1803
542cc9bb 1804### Q: My bridge disconnects from my controller on add-port/del-port.
9a7a9154
YT
1805
1806A: Reconfiguring your bridge can change your bridge's datapath-id because
1807 Open vSwitch generates datapath-id from the MAC address of one of its ports.
1808 In that case, Open vSwitch disconnects from controllers because there's
1809 no graceful way to notify controllers about the change of datapath-id.
1810
1811 To avoid the behaviour, you can configure datapath-id manually.
1812
1813 ovs-vsctl set bridge br0 other-config:datapath-id=0123456789abcdef
1814
ae99ee45
BP
1815### Q: My controller is getting errors about "buffers". What's going on?
1816
1817A: When a switch sends a packet to an OpenFlow controller using a
1818 "packet-in" message, it can also keep a copy of that packet in a
1819 "buffer", identified by a 32-bit integer "buffer_id". There are
1820 two advantages to buffering. First, when the controller wants to
1821 tell the switch to do something with the buffered packet (with a
1822 "packet-out" OpenFlow request), it does not need to send another
1823 copy of the packet back across the OpenFlow connection, which
1824 reduces the bandwidth cost of the connection and improves latency.
1825 This enables the second advantage: the switch can optionally send
1826 only the first part of the packet to the controller (assuming that
1827 the switch only needs to look at the first few bytes of the
1828 packet), further reducing bandwidth and improving latency.
1829
1830 However, buffering introduces some issues of its own. First, any
1831 switch has limited resources, so if the controller does not use a
1832 buffered packet, the switch has to decide how long to keep it
1833 buffered. When many packets are sent to a controller and buffered,
1834 Open vSwitch can discard buffered packets that the controller has
1835 not used after as little as 5 seconds. This means that
1836 controllers, if they make use of packet buffering, should use the
1837 buffered packets promptly. (This includes sending a "packet-out"
1838 with no actions if the controller does not want to do anything with
1839 a buffered packet, to clear the packet buffer and effectively
1840 "drop" its packet.)
1841
1842 Second, packet buffers are one-time-use, meaning that a controller
1843 cannot use a single packet buffer in two or more "packet-out"
1844 commands. Open vSwitch will respond with an error to the second
1845 and subsequent "packet-out"s in such a case.
1846
1847 Finally, a common error early in controller development is to try
1848 to use buffer_id 0 in a "packet-out" message as if 0 represented
1849 "no buffered packet". This is incorrect usage: the buffer_id with
1850 this meaning is actually 0xffffffff.
1851
1852 ovs-vswitchd(8) describes some details of Open vSwitch packet
1853 buffering that the OpenFlow specification requires implementations
1854 to document.
1855
66679738
BP
1856
1857Development
1858-----------
1859
542cc9bb 1860### Q: How do I implement a new OpenFlow message?
66679738
BP
1861
1862A: Add your new message to "enum ofpraw" and "enum ofptype" in
1863 lib/ofp-msgs.h, following the existing pattern. Then recompile and
1864 fix all of the new warnings, implementing new functionality for the
1865 new message as needed. (If you configure with --enable-Werror, as
9feb1017 1866 described in [INSTALL.md], then it is impossible to miss any warnings.)
66679738
BP
1867
1868 If you need to add an OpenFlow vendor extension message for a
1869 vendor that doesn't yet have any extension messages, then you will
1870 also need to edit build-aux/extract-ofp-msgs.
1871
fe540ca9
BP
1872### Q: How do I add support for a new field or header?
1873
1874A: Add new members for your field to "struct flow" in lib/flow.h, and
1875 add new enumerations for your new field to "enum mf_field_id" in
f58df860
BP
1876 lib/meta-flow.h, following the existing pattern. Also, add support
1877 to miniflow_extract() in lib/flow.c for extracting your new field
1878 from a packet into struct miniflow. Then recompile and fix all of
1879 the new warnings, implementing new functionality for the new field
1880 or header as needed. (If you configure with --enable-Werror, as
1881 described in [INSTALL.md], then it is impossible to miss any
1882 warnings.)
1883
1884 If you want kernel datapath support for your new field, you also
1885 need to modify the kernel module for the operating systems you are
1886 interested in. This isn't mandatory, since fields understood only
1887 by userspace work too (with a performance penalty), so it's
1888 reasonable to start development without it. If you implement
1889 kernel module support for Linux, then the Linux kernel "netdev"
1890 mailing list is the place to submit that support first; please read
1891 up on the Linux kernel development process separately. The Windows
1892 datapath kernel module support, on the other hand, is maintained
1893 within the OVS tree, so patches for that can go directly to
1894 ovs-dev.
fe540ca9
BP
1895
1896### Q: How do I add support for a new OpenFlow action?
1897
1898A: Add your new action to "enum ofp_raw_action_type" in
1899 lib/ofp-actions.c, following the existing pattern. Then recompile
1900 and fix all of the new warnings, implementing new functionality for
1901 the new action as needed. (If you configure with --enable-Werror,
1902 as described in [INSTALL.md], then it is impossible to miss any
1903 warnings.)
1904
1905 If you need to add an OpenFlow vendor extension action for a vendor
1906 that doesn't yet have any extension actions, then you will also
1907 need to edit build-aux/extract-ofp-actions.
1908
66679738 1909
c483d489
BP
1910Contact
1911-------
1912
1913bugs@openvswitch.org
1914http://openvswitch.org/
9feb1017
TG
1915
1916[PORTING.md]:PORTING.md
1917[WHY-OVS.md]:WHY-OVS.md
1918[INSTALL.md]:INSTALL.md
1919[OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md
77c180ce 1920[INSTALL.DPDK.md]:INSTALL.DPDK.md