]> git.proxmox.com Git - ovs.git/blame - FAQ
ovs-ofctl: Document masked versions of arp_sha and arp_tha matches
[ovs.git] / FAQ
CommitLineData
c483d489
BP
1 Open vSwitch <http://openvswitch.org>
2
3Frequently Asked Questions
4==========================
5
3fc7dc18
JP
6General
7-------
8
9Q: What is Open vSwitch?
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
27Q: What virtualization platforms can use Open vSwitch?
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
37Q: How can I try Open vSwitch?
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
50Q: Does Open vSwitch only work on Linux?
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
62Q: What's involved with porting Open vSwitch to a new platform or
63 switching ASIC?
64
65A: The PORTING document describes how one would go about porting Open
66 vSwitch to a new operating system or hardware platform.
3fc7dc18
JP
67
68Q: Why would I use Open vSwitch instead of the Linux bridge?
69
70A: Open vSwitch is specially designed to make it easier to manage VM
7b287e99
JP
71 network configuration and monitor state spread across many physical
72 hosts in dynamic virtualized environments. Please see WHY-OVS for a
73 more detailed description of how Open vSwitch relates to the Linux
74 Bridge.
3fc7dc18
JP
75
76Q: How is Open vSwitch related to distributed virtual switches like the
77 VMware vNetwork distributed switch or the Cisco Nexus 1000V?
78
79A: Distributed vswitch applications (e.g., VMware vNetwork distributed
80 switch, Cisco Nexus 1000V) provide a centralized way to configure and
81 monitor the network state of VMs that are spread across many physical
82 hosts. Open vSwitch is not a distributed vswitch itself, rather it
83 runs on each physical host and supports remote management in a way
84 that makes it easier for developers of virtualization/cloud
85 management platforms to offer distributed vswitch capabilities.
86
87 To aid in distribution, Open vSwitch provides two open protocols that
88 are specially designed for remote management in virtualized network
89 environments: OpenFlow, which exposes flow-based forwarding state,
90 and the OVSDB management protocol, which exposes switch port state.
91 In addition to the switch implementation itself, Open vSwitch
1d5aaa61
BP
92 includes tools (ovs-ofctl, ovs-vsctl) that developers can script and
93 extend to provide distributed vswitch capabilities that are closely
94 integrated with their virtualization management platform.
3fc7dc18
JP
95
96Q: Why doesn't Open vSwitch support distribution?
97
98A: Open vSwitch is intended to be a useful component for building
99 flexible network infrastructure. There are many different approaches
100 to distribution which balance trade-offs between simplicity,
101 scalability, hardware compatibility, convergence times, logical
102 forwarding model, etc. The goal of Open vSwitch is to be able to
103 support all as a primitive building block rather than choose a
104 particular point in the distributed design space.
105
3fc7dc18
JP
106Q: How can I contribute to the Open vSwitch Community?
107
108A: You can start by joining the mailing lists and helping to answer
7b287e99
JP
109 questions. You can also suggest improvements to documentation. If
110 you have a feature or bug you would like to work on, send a mail to
111 one of the mailing lists:
112
113 http://openvswitch.org/mlists/
114
115
7b287e99
JP
116Releases
117--------
118
119Q: What does it mean for an Open vSwitch release to be LTS (long-term
120 support)?
3fc7dc18 121
7b287e99
JP
122A: All official releases have been through a comprehensive testing
123 process and are suitable for production use. Planned releases will
124 occur several times a year. If a significant bug is identified in an
125 LTS release, we will provide an updated release that includes the
126 fix. Releases that are not LTS may not be fixed and may just be
127 supplanted by the next major release. The current LTS release is
79a6e10e 128 1.9.x.
7b287e99 129
314e60e1
BP
130Q: What Linux kernel versions does each Open vSwitch release work with?
131
132A: The following table lists the Linux kernel versions against which the
133 given versions of the Open vSwitch kernel module will successfully
134 build. The Linux kernel versions are upstream kernel versions, so
a01b5c51
BP
135 Linux kernels modified from the upstream sources may not build in
136 some cases even if they are based on a supported version. This is
137 most notably true of Red Hat Enterprise Linux (RHEL) kernels, which
138 are extensively modified from upstream.
314e60e1
BP
139
140 Open vSwitch Linux kernel
141 ------------ -------------
142 1.4.x 2.6.18 to 3.2
143 1.5.x 2.6.18 to 3.2
144 1.6.x 2.6.18 to 3.2
145 1.7.x 2.6.18 to 3.3
146 1.8.x 2.6.18 to 3.4
64807dfb 147 1.9.x 2.6.18 to 3.8
889be6f9
JG
148 1.10.x 2.6.18 to 3.8
149 1.11.x 2.6.18 to 3.8
31d73806 150 2.0.x 2.6.32 to 3.10
54af97ad 151 2.1.x 2.6.32 to 3.11
314e60e1
BP
152
153 Open vSwitch userspace should also work with the Linux kernel module
154 built into Linux 3.3 and later.
155
156 Open vSwitch userspace is not sensitive to the Linux kernel version.
37418c86 157 It should build against almost any kernel, certainly against 2.6.32
314e60e1
BP
158 and later.
159
29089a54
RL
160Q: What Linux kernel versions does IPFIX flow monitoring work with?
161
162A: IPFIX flow monitoring requires the Linux kernel module from Open
163 vSwitch version 1.10.90 or later.
164
33cec590
JG
165Q: Should userspace or kernel be upgraded first to minimize downtime?
166
167 In general, the Open vSwitch userspace should be used with the
168 kernel version included in the same release or with the version
169 from upstream Linux. However, when upgrading between two releases
170 of Open vSwitch it is best to migrate userspace first to reduce
23a0330f 171 the possibility of incompatibilities.
33cec590 172
7b287e99
JP
173Q: What features are not available in the Open vSwitch kernel datapath
174 that ships as part of the upstream Linux kernel?
175
176A: The kernel module in upstream Linux 3.3 and later does not include
0a740f48 177 tunnel virtual ports, that is, interfaces with type "gre",
a6ae068b 178 "ipsec_gre", "gre64", "ipsec_gre64", "vxlan", or "lisp". It is
0a740f48
EJ
179 possible to create tunnels in Linux and attach them to Open vSwitch
180 as system devices. However, they cannot be dynamically created
181 through the OVSDB protocol or set the tunnel ids as a flow action.
182
183 Work is in progress in adding tunnel virtual ports to the upstream
184 Linux version of the Open vSwitch kernel module. For now, if you
185 need these features, use the kernel module from the Open vSwitch
186 distribution instead of the upstream Linux kernel module.
187
188 The upstream kernel module does not include patch ports, but this
189 only matters for Open vSwitch 1.9 and earlier, because Open vSwitch
190 1.10 and later implement patch ports without using this kernel
191 feature.
6302c641 192
7b287e99
JP
193Q: What features are not available when using the userspace datapath?
194
0a740f48 195A: Tunnel virtual ports are not supported, as described in the
7b287e99
JP
196 previous answer. It is also not possible to use queue-related
197 actions. On Linux kernels before 2.6.39, maximum-sized VLAN packets
198 may not be transmitted.
3fc7dc18 199
900dc97c
BP
200Q: What happened to the bridge compatibility feature?
201
202A: Bridge compatibility was a feature of Open vSwitch 1.9 and earlier.
203 When it was enabled, Open vSwitch imitated the interface of the
204 Linux kernel "bridge" module. This allowed users to drop Open
205 vSwitch into environments designed to use the Linux kernel bridge
206 module without adapting the environment to use Open vSwitch.
207
208 Open vSwitch 1.10 and later do not support bridge compatibility.
209 The feature was dropped because version 1.10 adopted a new internal
210 architecture that made bridge compatibility difficult to maintain.
211 Now that many environments use OVS directly, it would be rarely
212 useful in any case.
213
214 To use bridge compatibility, install OVS 1.9 or earlier, including
215 the accompanying kernel modules (both the main and bridge
216 compatibility modules), following the instructions that come with
217 the release. Be sure to start the ovs-brcompatd daemon.
218
3fc7dc18 219
79aa9fd0
BP
220Terminology
221-----------
222
223Q: I thought Open vSwitch was a virtual Ethernet switch, but the
224 documentation keeps talking about bridges. What's a bridge?
225
226A: In networking, the terms "bridge" and "switch" are synonyms. Open
227 vSwitch implements an Ethernet switch, which means that it is also
228 an Ethernet bridge.
229
230Q: What's a VLAN?
231
232A: See the "VLAN" section below.
233
234
717e7c8d
BP
235Basic Configuration
236-------------------
237
238Q: How do I configure a port as an access port?
239
240A: Add "tag=VLAN" to your "ovs-vsctl add-port" command. For example,
241 the following commands configure br0 with eth0 as a trunk port (the
242 default) and tap0 as an access port for VLAN 9:
243
244 ovs-vsctl add-br br0
245 ovs-vsctl add-port br0 eth0
246 ovs-vsctl add-port br0 tap0 tag=9
247
248 If you want to configure an already added port as an access port,
249 use "ovs-vsctl set", e.g.:
250
251 ovs-vsctl set port tap0 tag=9
252
253Q: How do I configure a port as a SPAN port, that is, enable mirroring
254 of all traffic to that port?
255
256A: The following commands configure br0 with eth0 and tap0 as trunk
257 ports. All traffic coming in or going out on eth0 or tap0 is also
258 mirrored to tap1; any traffic arriving on tap1 is dropped:
259
260 ovs-vsctl add-br br0
261 ovs-vsctl add-port br0 eth0
262 ovs-vsctl add-port br0 tap0
263 ovs-vsctl add-port br0 tap1 \
264 -- --id=@p get port tap1 \
265 -- --id=@m create mirror name=m0 select-all=true output-port=@p \
266 -- set bridge br0 mirrors=@m
267
268 To later disable mirroring, run:
269
270 ovs-vsctl clear bridge br0 mirrors
271
e253f732
BP
272Q: Does Open vSwitch support configuring a port in promiscuous mode?
273
274A: Yes. How you configure it depends on what you mean by "promiscuous
275 mode":
276
277 - Conventionally, "promiscuous mode" is a feature of a network
278 interface card. Ordinarily, a NIC passes to the CPU only the
279 packets actually destined to its host machine. It discards
280 the rest to avoid wasting memory and CPU cycles. When
281 promiscuous mode is enabled, however, it passes every packet
282 to the CPU. On an old-style shared-media or hub-based
283 network, this allows the host to spy on all packets on the
284 network. But in the switched networks that are almost
285 everywhere these days, promiscuous mode doesn't have much
286 effect, because few packets not destined to a host are
287 delivered to the host's NIC.
288
289 This form of promiscuous mode is configured in the guest OS of
290 the VMs on your bridge, e.g. with "ifconfig".
291
292 - The VMware vSwitch uses a different definition of "promiscuous
293 mode". When you configure promiscuous mode on a VMware vNIC,
294 the vSwitch sends a copy of every packet received by the
295 vSwitch to that vNIC. That has a much bigger effect than just
296 enabling promiscuous mode in a guest OS. Rather than getting
297 a few stray packets for which the switch does not yet know the
298 correct destination, the vNIC gets every packet. The effect
299 is similar to replacing the vSwitch by a virtual hub.
300
301 This "promiscuous mode" is what switches normally call "port
302 mirroring" or "SPAN". For information on how to configure
303 SPAN, see "How do I configure a port as a SPAN port, that is,
304 enable mirroring of all traffic to that port?"
305
717e7c8d
BP
306Q: How do I configure a VLAN as an RSPAN VLAN, that is, enable
307 mirroring of all traffic to that VLAN?
308
309A: The following commands configure br0 with eth0 as a trunk port and
310 tap0 as an access port for VLAN 10. All traffic coming in or going
311 out on tap0, as well as traffic coming in or going out on eth0 in
312 VLAN 10, is also mirrored to VLAN 15 on eth0. The original tag for
313 VLAN 10, in cases where one is present, is dropped as part of
314 mirroring:
315
316 ovs-vsctl add-br br0
317 ovs-vsctl add-port br0 eth0
318 ovs-vsctl add-port br0 tap0 tag=10
319 ovs-vsctl \
320 -- --id=@m create mirror name=m0 select-all=true select-vlan=10 \
321 output-vlan=15 \
322 -- set bridge br0 mirrors=@m
323
324 To later disable mirroring, run:
325
326 ovs-vsctl clear bridge br0 mirrors
327
328 Mirroring to a VLAN can disrupt a network that contains unmanaged
329 switches. See ovs-vswitchd.conf.db(5) for details. Mirroring to a
330 GRE tunnel has fewer caveats than mirroring to a VLAN and should
331 generally be preferred.
332
333Q: Can I mirror more than one input VLAN to an RSPAN VLAN?
334
335A: Yes, but mirroring to a VLAN strips the original VLAN tag in favor
336 of the specified output-vlan. This loss of information may make
337 the mirrored traffic too hard to interpret.
338
339 To mirror multiple VLANs, use the commands above, but specify a
340 comma-separated list of VLANs as the value for select-vlan. To
341 mirror every VLAN, use the commands above, but omit select-vlan and
342 its value entirely.
343
344 When a packet arrives on a VLAN that is used as a mirror output
345 VLAN, the mirror is disregarded. Instead, in standalone mode, OVS
346 floods the packet across all the ports for which the mirror output
347 VLAN is configured. (If an OpenFlow controller is in use, then it
348 can override this behavior through the flow table.) If OVS is used
349 as an intermediate switch, rather than an edge switch, this ensures
350 that the RSPAN traffic is distributed through the network.
351
352 Mirroring to a VLAN can disrupt a network that contains unmanaged
353 switches. See ovs-vswitchd.conf.db(5) for details. Mirroring to a
354 GRE tunnel has fewer caveats than mirroring to a VLAN and should
355 generally be preferred.
356
357Q: How do I configure mirroring of all traffic to a GRE tunnel?
358
359A: The following commands configure br0 with eth0 and tap0 as trunk
360 ports. All traffic coming in or going out on eth0 or tap0 is also
361 mirrored to gre0, a GRE tunnel to the remote host 192.168.1.10; any
362 traffic arriving on gre0 is dropped:
363
364 ovs-vsctl add-br br0
365 ovs-vsctl add-port br0 eth0
366 ovs-vsctl add-port br0 tap0
367 ovs-vsctl add-port br0 gre0 \
368 -- set interface gre0 type=gre options:remote_ip=192.168.1.10 \
369 -- --id=@p get port gre0 \
370 -- --id=@m create mirror name=m0 select-all=true output-port=@p \
371 -- set bridge br0 mirrors=@m
372
373 To later disable mirroring and destroy the GRE tunnel:
374
375 ovs-vsctl clear bridge br0 mirrors
376 ovs-vcstl del-port br0 gre0
377
378Q: Does Open vSwitch support ERSPAN?
379
380A: No. ERSPAN is an undocumented proprietary protocol. As an
381 alternative, Open vSwitch supports mirroring to a GRE tunnel (see
382 above).
383
1ab9712b
BP
384Q: How do I connect two bridges?
385
386A: First, why do you want to do this? Two connected bridges are not
387 much different from a single bridge, so you might as well just have
388 a single bridge with all your ports on it.
389
390 If you still want to connect two bridges, you can use a pair of
391 patch ports. The following example creates bridges br0 and br1,
392 adds eth0 and tap0 to br0, adds tap1 to br1, and then connects br0
393 and br1 with a pair of patch ports.
394
395 ovs-vsctl add-br br0
396 ovs-vsctl add-port br0 eth0
397 ovs-vsctl add-port br0 tap0
398 ovs-vsctl add-br br1
399 ovs-vsctl add-port br1 tap1
400 ovs-vsctl \
401 -- add-port br0 patch0 \
402 -- set interface patch0 type=patch options:peer=patch1 \
403 -- add-port br1 patch1 \
404 -- set interface patch1 type=patch options:peer=patch0
405
406 Bridges connected with patch ports are much like a single bridge.
407 For instance, if the example above also added eth1 to br1, and both
408 eth0 and eth1 happened to be connected to the same next-hop switch,
409 then you could loop your network just as you would if you added
410 eth0 and eth1 to the same bridge (see the "Configuration Problems"
411 section below for more information).
412
413 If you are using Open vSwitch 1.9 or an earlier version, then you
414 need to be using the kernel module bundled with Open vSwitch rather
415 than the one that is integrated into Linux 3.3 and later, because
416 Open vSwitch 1.9 and earlier versions need kernel support for patch
417 ports. This also means that in Open vSwitch 1.9 and earlier, patch
418 ports will not work with the userspace datapath, only with the
419 kernel module.
420
a70fc0cf
JP
421Q: Why are there so many different ways to dump flows?
422
423A: Open vSwitch uses different kinds of flows for different purposes:
424
425 - OpenFlow flows are the most important kind of flow. OpenFlow
426 controllers use these flows to define a switch's policy.
427 OpenFlow flows support wildcards, priorities, and multiple
428 tables.
429
430 When in-band control is in use, Open vSwitch sets up a few
431 "hidden" flows, with priority higher than a controller or the
432 user can configure, that are not visible via OpenFlow. (See
433 the "Controller" section of the FAQ for more information
434 about hidden flows.)
435
436 - The Open vSwitch software switch implementation uses a second
437 kind of flow internally. These flows, called "exact-match"
438 or "datapath" or "kernel" flows, do not support wildcards or
439 priorities and comprise only a single table, which makes them
440 suitable for caching. OpenFlow flows and exact-match flows
441 also support different actions and number ports differently.
442
443 Exact-match flows are an implementation detail that is
444 subject to change in future versions of Open vSwitch. Even
445 with the current version of Open vSwitch, hardware switch
446 implementations do not necessarily use exact-match flows.
447
448 Each of the commands for dumping flows has a different purpose:
449
450 - "ovs-ofctl dump-flows <br>" dumps OpenFlow flows, excluding
451 hidden flows. This is the most commonly useful form of flow
452 dump. (Unlike the other commands, this should work with any
453 OpenFlow switch, not just Open vSwitch.)
454
455 - "ovs-appctl bridge/dump-flows <br>" dumps OpenFlow flows,
456 including hidden flows. This is occasionally useful for
457 troubleshooting suspected issues with in-band control.
458
459 - "ovs-dpctl dump-flows [dp]" dumps the exact-match flow table
460 entries for a Linux kernel-based datapath. In Open vSwitch
acaaa4b4
BP
461 1.10 and later, ovs-vswitchd merges multiple switches into a
462 single datapath, so it will show all the flows on all your
463 kernel-based switches. This command can occasionally be
a70fc0cf
JP
464 useful for debugging.
465
466 - "ovs-appctl dpif/dump-flows <br>", new in Open vSwitch 1.10,
467 dumps exact-match flows for only the specified bridge,
468 regardless of the type.
469
717e7c8d 470
c483d489
BP
471Configuration Problems
472----------------------
473
474Q: I created a bridge and added my Ethernet port to it, using commands
475 like these:
476
477 ovs-vsctl add-br br0
478 ovs-vsctl add-port br0 eth0
479
480 and as soon as I ran the "add-port" command I lost all connectivity
481 through eth0. Help!
482
483A: A physical Ethernet device that is part of an Open vSwitch bridge
484 should not have an IP address. If one does, then that IP address
485 will not be fully functional.
486
487 You can restore functionality by moving the IP address to an Open
488 vSwitch "internal" device, such as the network device named after
489 the bridge itself. For example, assuming that eth0's IP address is
490 192.168.128.5, you could run the commands below to fix up the
491 situation:
492
493 ifconfig eth0 0.0.0.0
494 ifconfig br0 192.168.128.5
495
496 (If your only connection to the machine running OVS is through the
497 IP address in question, then you would want to run all of these
498 commands on a single command line, or put them into a script.) If
499 there were any additional routes assigned to eth0, then you would
500 also want to use commands to adjust these routes to go through br0.
501
502 If you use DHCP to obtain an IP address, then you should kill the
503 DHCP client that was listening on the physical Ethernet interface
504 (e.g. eth0) and start one listening on the internal interface
505 (e.g. br0). You might still need to manually clear the IP address
506 from the physical interface (e.g. with "ifconfig eth0 0.0.0.0").
507
508 There is no compelling reason why Open vSwitch must work this way.
509 However, this is the way that the Linux kernel bridge module has
510 always worked, so it's a model that those accustomed to Linux
511 bridging are already used to. Also, the model that most people
512 expect is not implementable without kernel changes on all the
513 versions of Linux that Open vSwitch supports.
514
515 By the way, this issue is not specific to physical Ethernet
516 devices. It applies to all network devices except Open vswitch
517 "internal" devices.
518
519Q: I created a bridge and added a couple of Ethernet ports to it,
520 using commands like these:
521
522 ovs-vsctl add-br br0
523 ovs-vsctl add-port br0 eth0
524 ovs-vsctl add-port br0 eth1
525
526 and now my network seems to have melted: connectivity is unreliable
527 (even connectivity that doesn't go through Open vSwitch), all the
629a6b48
BP
528 LEDs on my physical switches are blinking, wireshark shows
529 duplicated packets, and CPU usage is very high.
c483d489
BP
530
531A: More than likely, you've looped your network. Probably, eth0 and
532 eth1 are connected to the same physical Ethernet switch. This
533 yields a scenario where OVS receives a broadcast packet on eth0 and
534 sends it out on eth1, then the physical switch connected to eth1
535 sends the packet back on eth0, and so on forever. More complicated
536 scenarios, involving a loop through multiple switches, are possible
537 too.
538
539 The solution depends on what you are trying to do:
540
541 - If you added eth0 and eth1 to get higher bandwidth or higher
542 reliability between OVS and your physical Ethernet switch,
543 use a bond. The following commands create br0 and then add
544 eth0 and eth1 as a bond:
545
546 ovs-vsctl add-br br0
547 ovs-vsctl add-bond br0 bond0 eth0 eth1
548
549 Bonds have tons of configuration options. Please read the
550 documentation on the Port table in ovs-vswitchd.conf.db(5)
551 for all the details.
552
553 - Perhaps you don't actually need eth0 and eth1 to be on the
554 same bridge. For example, if you simply want to be able to
555 connect each of them to virtual machines, then you can put
556 each of them on a bridge of its own:
557
558 ovs-vsctl add-br br0
559 ovs-vsctl add-port br0 eth0
560
561 ovs-vsctl add-br br1
562 ovs-vsctl add-port br1 eth1
563
564 and then connect VMs to br0 and br1. (A potential
565 disadvantage is that traffic cannot directly pass between br0
566 and br1. Instead, it will go out eth0 and come back in eth1,
567 or vice versa.)
568
569 - If you have a redundant or complex network topology and you
570 want to prevent loops, turn on spanning tree protocol (STP).
571 The following commands create br0, enable STP, and add eth0
572 and eth1 to the bridge. The order is important because you
573 don't want have to have a loop in your network even
574 transiently:
575
576 ovs-vsctl add-br br0
577 ovs-vsctl set bridge br0 stp_enable=true
578 ovs-vsctl add-port br0 eth0
579 ovs-vsctl add-port br0 eth1
580
581 The Open vSwitch implementation of STP is not well tested.
582 Please report any bugs you observe, but if you'd rather avoid
583 acting as a beta tester then another option might be your
584 best shot.
585
586Q: I can't seem to use Open vSwitch in a wireless network.
587
588A: Wireless base stations generally only allow packets with the source
589 MAC address of NIC that completed the initial handshake.
590 Therefore, without MAC rewriting, only a single device can
591 communicate over a single wireless link.
592
593 This isn't specific to Open vSwitch, it's enforced by the access
594 point, so the same problems will show up with the Linux bridge or
595 any other way to do bridging.
596
8748ec7b
BP
597Q: I can't seem to add my PPP interface to an Open vSwitch bridge.
598
599A: PPP most commonly carries IP packets, but Open vSwitch works only
600 with Ethernet frames. The correct way to interface PPP to an
601 Ethernet network is usually to use routing instead of switching.
602
5aa75474
BP
603Q: Is there any documentation on the database tables and fields?
604
605A: Yes. ovs-vswitchd.conf.db(5) is a comprehensive reference.
606
acf60855
JP
607Q: When I run ovs-dpctl I no longer see the bridges I created. Instead,
608 I only see a datapath called "ovs-system". How can I see datapath
609 information about a particular bridge?
610
611A: In version 1.9.0, OVS switched to using a single datapath that is
612 shared by all bridges of that type. The "ovs-appctl dpif/*"
613 commands provide similar functionality that is scoped by the bridge.
614
c483d489 615
bceafb63
BP
616Quality of Service (QoS)
617------------------------
618
619Q: How do I configure Quality of Service (QoS)?
620
621A: Suppose that you want to set up bridge br0 connected to physical
622 Ethernet port eth0 (a 1 Gbps device) and virtual machine interfaces
623 vif1.0 and vif2.0, and that you want to limit traffic from vif1.0
624 to eth0 to 10 Mbps and from vif2.0 to eth0 to 20 Mbps. Then, you
625 could configure the bridge this way:
626
627 ovs-vsctl -- \
628 add-br br0 -- \
629 add-port br0 eth0 -- \
630 add-port br0 vif1.0 -- set interface vif1.0 ofport_request=5 -- \
631 add-port br0 vif2.0 -- set interface vif2.0 ofport_request=6 -- \
632 set port eth0 qos=@newqos -- \
633 --id=@newqos create qos type=linux-htb \
634 other-config:max-rate=1000000000 \
635 queues:123=@vif10queue \
636 queues:234=@vif20queue -- \
637 --id=@vif10queue create queue other-config:max-rate=10000000 -- \
638 --id=@vif20queue create queue other-config:max-rate=20000000
639
640 At this point, bridge br0 is configured with the ports and eth0 is
641 configured with the queues that you need for QoS, but nothing is
642 actually directing packets from vif1.0 or vif2.0 to the queues that
643 we have set up for them. That means that all of the packets to
644 eth0 are going to the "default queue", which is not what we want.
645
646 We use OpenFlow to direct packets from vif1.0 and vif2.0 to the
647 queues reserved for them:
648
649 ovs-ofctl add-flow br0 in_port=5,actions=set_queue:123,normal
650 ovs-ofctl add-flow br0 in_port=6,actions=set_queue:234,normal
651
652 Each of the above flows matches on the input port, sets up the
653 appropriate queue (123 for vif1.0, 234 for vif2.0), and then
654 executes the "normal" action, which performs the same switching
655 that Open vSwitch would have done without any OpenFlow flows being
656 present. (We know that vif1.0 and vif2.0 have OpenFlow port
657 numbers 5 and 6, respectively, because we set their ofport_request
658 columns above. If we had not done that, then we would have needed
659 to find out their port numbers before setting up these flows.)
660
661 Now traffic going from vif1.0 or vif2.0 to eth0 should be
662 rate-limited.
663
664 By the way, if you delete the bridge created by the above commands,
665 with:
666
667 ovs-vsctl del-br br0
668
669 then that will leave one unreferenced QoS record and two
670 unreferenced Queue records in the Open vSwich database. One way to
671 clear them out, assuming you don't have other QoS or Queue records
672 that you want to keep, is:
673
674 ovs-vsctl -- --all destroy QoS -- --all destroy Queue
675
7839bb41
BP
676 If you do want to keep some QoS or Queue records, or the Open
677 vSwitch you are using is older than version 1.8 (which added the
678 --all option), then you will have to destroy QoS and Queue records
679 individually.
680
bceafb63
BP
681Q: I configured Quality of Service (QoS) in my OpenFlow network by
682 adding records to the QoS and Queue table, but the results aren't
683 what I expect.
684
685A: Did you install OpenFlow flows that use your queues? This is the
686 primary way to tell Open vSwitch which queues you want to use. If
687 you don't do this, then the default queue will be used, which will
688 probably not have the effect you want.
689
690 Refer to the previous question for an example.
691
692Q: I configured QoS, correctly, but my measurements show that it isn't
693 working as well as I expect.
694
695A: With the Linux kernel, the Open vSwitch implementation of QoS has
696 two aspects:
697
698 - Open vSwitch configures a subset of Linux kernel QoS
699 features, according to what is in OVSDB. It is possible that
700 this code has bugs. If you believe that this is so, then you
701 can configure the Linux traffic control (QoS) stack directly
702 with the "tc" program. If you get better results that way,
703 you can send a detailed bug report to bugs@openvswitch.org.
704
705 It is certain that Open vSwitch cannot configure every Linux
706 kernel QoS feature. If you need some feature that OVS cannot
707 configure, then you can also use "tc" directly (or add that
708 feature to OVS).
709
710 - The Open vSwitch implementation of OpenFlow allows flows to
711 be directed to particular queues. This is pretty simple and
712 unlikely to have serious bugs at this point.
713
714 However, most problems with QoS on Linux are not bugs in Open
715 vSwitch at all. They tend to be either configuration errors
716 (please see the earlier questions in this section) or issues with
717 the traffic control (QoS) stack in Linux. The Open vSwitch
718 developers are not experts on Linux traffic control. We suggest
719 that, if you believe you are encountering a problem with Linux
720 traffic control, that you consult the tc manpages (e.g. tc(8),
721 tc-htb(8), tc-hfsc(8)), web resources (e.g. http://lartc.org/), or
722 mailing lists (e.g. http://vger.kernel.org/vger-lists.html#netdev).
723
724
c483d489
BP
725VLANs
726-----
727
14481051
BP
728Q: What's a VLAN?
729
730A: At the simplest level, a VLAN (short for "virtual LAN") is a way to
731 partition a single switch into multiple switches. Suppose, for
732 example, that you have two groups of machines, group A and group B.
733 You want the machines in group A to be able to talk to each other,
734 and you want the machine in group B to be able to talk to each
735 other, but you don't want the machines in group A to be able to
736 talk to the machines in group B. You can do this with two
737 switches, by plugging the machines in group A into one switch and
738 the machines in group B into the other switch.
739
740 If you only have one switch, then you can use VLANs to do the same
741 thing, by configuring the ports for machines in group A as VLAN
742 "access ports" for one VLAN and the ports for group B as "access
743 ports" for a different VLAN. The switch will only forward packets
744 between ports that are assigned to the same VLAN, so this
745 effectively subdivides your single switch into two independent
746 switches, one for each group of machines.
747
748 So far we haven't said anything about VLAN headers. With access
749 ports, like we've described so far, no VLAN header is present in
750 the Ethernet frame. This means that the machines (or switches)
751 connected to access ports need not be aware that VLANs are
752 involved, just like in the case where we use two different physical
753 switches.
754
755 Now suppose that you have a whole bunch of switches in your
756 network, instead of just one, and that some machines in group A are
757 connected directly to both switches 1 and 2. To allow these
758 machines to talk to each other, you could add an access port for
759 group A's VLAN to switch 1 and another to switch 2, and then
760 connect an Ethernet cable between those ports. That works fine,
761 but it doesn't scale well as the number of switches and the number
762 of VLANs increases, because you use up a lot of valuable switch
763 ports just connecting together your VLANs.
764
765 This is where VLAN headers come in. Instead of using one cable and
766 two ports per VLAN to connect a pair of switches, we configure a
767 port on each switch as a VLAN "trunk port". Packets sent and
768 received on a trunk port carry a VLAN header that says what VLAN
769 the packet belongs to, so that only two ports total are required to
770 connect the switches, regardless of the number of VLANs in use.
771 Normally, only switches (either physical or virtual) are connected
772 to a trunk port, not individual hosts, because individual hosts
773 don't expect to see a VLAN header in the traffic that they receive.
774
775 None of the above discussion says anything about particular VLAN
776 numbers. This is because VLAN numbers are completely arbitrary.
777 One must only ensure that a given VLAN is numbered consistently
778 throughout a network and that different VLANs are given different
779 numbers. (That said, VLAN 0 is usually synonymous with a packet
780 that has no VLAN header, and VLAN 4095 is reserved.)
781
c483d489
BP
782Q: VLANs don't work.
783
784A: Many drivers in Linux kernels before version 3.3 had VLAN-related
785 bugs. If you are having problems with VLANs that you suspect to be
786 driver related, then you have several options:
787
788 - Upgrade to Linux 3.3 or later.
789
790 - Build and install a fixed version of the particular driver
791 that is causing trouble, if one is available.
792
793 - Use a NIC whose driver does not have VLAN problems.
794
795 - Use "VLAN splinters", a feature in Open vSwitch 1.4 and later
796 that works around bugs in kernel drivers. To enable VLAN
797 splinters on interface eth0, use the command:
798
7b287e99 799 ovs-vsctl set interface eth0 other-config:enable-vlan-splinters=true
c483d489
BP
800
801 For VLAN splinters to be effective, Open vSwitch must know
802 which VLANs are in use. See the "VLAN splinters" section in
803 the Interface table in ovs-vswitchd.conf.db(5) for details on
804 how Open vSwitch infers in-use VLANs.
805
806 VLAN splinters increase memory use and reduce performance, so
807 use them only if needed.
808
809 - Apply the "vlan workaround" patch from the XenServer kernel
810 patch queue, build Open vSwitch against this patched kernel,
811 and then use ovs-vlan-bug-workaround(8) to enable the VLAN
812 workaround for each interface whose driver is buggy.
813
814 (This is a nontrivial exercise, so this option is included
815 only for completeness.)
816
817 It is not always easy to tell whether a Linux kernel driver has
818 buggy VLAN support. The ovs-vlan-test(8) and ovs-test(8) utilities
819 can help you test. See their manpages for details. Of the two
820 utilities, ovs-test(8) is newer and more thorough, but
821 ovs-vlan-test(8) may be easier to use.
822
823Q: VLANs still don't work. I've tested the driver so I know that it's OK.
824
825A: Do you have VLANs enabled on the physical switch that OVS is
826 attached to? Make sure that the port is configured to trunk the
827 VLAN or VLANs that you are using with OVS.
828
829Q: Outgoing VLAN-tagged traffic goes through OVS to my physical switch
830 and to its destination host, but OVS seems to drop incoming return
831 traffic.
832
833A: It's possible that you have the VLAN configured on your physical
834 switch as the "native" VLAN. In this mode, the switch treats
835 incoming packets either tagged with the native VLAN or untagged as
836 part of the native VLAN. It may also send outgoing packets in the
837 native VLAN without a VLAN tag.
838
839 If this is the case, you have two choices:
840
841 - Change the physical switch port configuration to tag packets
842 it forwards to OVS with the native VLAN instead of forwarding
843 them untagged.
844
845 - Change the OVS configuration for the physical port to a
846 native VLAN mode. For example, the following sets up a
847 bridge with port eth0 in "native-tagged" mode in VLAN 9:
848
849 ovs-vsctl add-br br0
850 ovs-vsctl add-port br0 eth0 tag=9 vlan_mode=native-tagged
851
852 In this situation, "native-untagged" mode will probably work
853 equally well. Refer to the documentation for the Port table
854 in ovs-vswitchd.conf.db(5) for more information.
855
8d45e938
BP
856Q: I added a pair of VMs on different VLANs, like this:
857
858 ovs-vsctl add-br br0
859 ovs-vsctl add-port br0 eth0
860 ovs-vsctl add-port br0 tap0 tag=9
861 ovs-vsctl add-port br0 tap1 tag=10
862
863 but the VMs can't access each other, the external network, or the
864 Internet.
865
866A: It is to be expected that the VMs can't access each other. VLANs
867 are a means to partition a network. When you configured tap0 and
868 tap1 as access ports for different VLANs, you indicated that they
869 should be isolated from each other.
870
871 As for the external network and the Internet, it seems likely that
872 the machines you are trying to access are not on VLAN 9 (or 10) and
873 that the Internet is not available on VLAN 9 (or 10).
874
3c8399a2
BP
875Q: I added a pair of VMs on the same VLAN, like this:
876
877 ovs-vsctl add-br br0
878 ovs-vsctl add-port br0 eth0
879 ovs-vsctl add-port br0 tap0 tag=9
880 ovs-vsctl add-port br0 tap1 tag=9
881
882 The VMs can access each other, but not the external network or the
883 Internet.
884
885A: It seems likely that the machines you are trying to access in the
886 external network are not on VLAN 9 and that the Internet is not
887 available on VLAN 9. Also, ensure VLAN 9 is set up as an allowed
888 trunk VLAN on the upstream switch port to which eth0 is connected.
889
c483d489
BP
890Q: Can I configure an IP address on a VLAN?
891
892A: Yes. Use an "internal port" configured as an access port. For
893 example, the following configures IP address 192.168.0.7 on VLAN 9.
894 That is, OVS will forward packets from eth0 to 192.168.0.7 only if
895 they have an 802.1Q header with VLAN 9. Conversely, traffic
896 forwarded from 192.168.0.7 to eth0 will be tagged with an 802.1Q
897 header with VLAN 9:
898
899 ovs-vsctl add-br br0
900 ovs-vsctl add-port br0 eth0
901 ovs-vsctl add-port br0 vlan9 tag=9 -- set interface vlan9 type=internal
902 ifconfig vlan9 192.168.0.7
903
904Q: My OpenFlow controller doesn't see the VLANs that I expect.
905
906A: The configuration for VLANs in the Open vSwitch database (e.g. via
907 ovs-vsctl) only affects traffic that goes through Open vSwitch's
908 implementation of the OpenFlow "normal switching" action. By
909 default, when Open vSwitch isn't connected to a controller and
910 nothing has been manually configured in the flow table, all traffic
911 goes through the "normal switching" action. But, if you set up
912 OpenFlow flows on your own, through a controller or using ovs-ofctl
913 or through other means, then you have to implement VLAN handling
914 yourself.
915
916 You can use "normal switching" as a component of your OpenFlow
917 actions, e.g. by putting "normal" into the lists of actions on
918 ovs-ofctl or by outputting to OFPP_NORMAL from an OpenFlow
241241f5
BP
919 controller. In situations where this is not suitable, you can
920 implement VLAN handling yourself, e.g.:
921
922 - If a packet comes in on an access port, and the flow table
923 needs to send it out on a trunk port, then the flow can add
924 the appropriate VLAN tag with the "mod_vlan_vid" action.
925
926 - If a packet comes in on a trunk port, and the flow table
927 needs to send it out on an access port, then the flow can
928 strip the VLAN tag with the "strip_vlan" action.
c483d489 929
f0a0c1a6
BP
930Q: I configured ports on a bridge as access ports with different VLAN
931 tags, like this:
932
933 ovs-vsctl add-br br0
934 ovs-vsctl set-controller br0 tcp:192.168.0.10:6633
935 ovs-vsctl add-port br0 eth0
936 ovs-vsctl add-port br0 tap0 tag=9
937 ovs-vsctl add-port br0 tap1 tag=10
938
939 but the VMs running behind tap0 and tap1 can still communicate,
940 that is, they are not isolated from each other even though they are
941 on different VLANs.
942
943A: Do you have a controller configured on br0 (as the commands above
944 do)? If so, then this is a variant on the previous question, "My
945 OpenFlow controller doesn't see the VLANs that I expect," and you
946 can refer to the answer there for more information.
947
c483d489 948
0edbe3fb
KM
949VXLANs
950-----
951
952Q: What's a VXLAN?
953
954A: VXLAN stands for Virtual eXtensible Local Area Network, and is a means
955 to solve the scaling challenges of VLAN networks in a multi-tenant
956 environment. VXLAN is an overlay network which transports an L2 network
957 over an existing L3 network. For more information on VXLAN, please see
958 the IETF draft available here:
959
960 http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03
961
962Q: How much of the VXLAN protocol does Open vSwitch currently support?
963
964A: Open vSwitch currently supports the framing format for packets on the
965 wire. There is currently no support for the multicast aspects of VXLAN.
966 To get around the lack of multicast support, it is possible to
967 pre-provision MAC to IP address mappings either manually or from a
968 controller.
969
970Q: What destination UDP port does the VXLAN implementation in Open vSwitch
971 use?
972
973A: By default, Open vSwitch will use the assigned IANA port for VXLAN, which
974 is 4789. However, it is possible to configure the destination UDP port
975 manually on a per-VXLAN tunnel basis. An example of this configuration is
976 provided below.
977
978 ovs-vsctl add-br br0
979 ovs-vsctl add-port br0 vxlan1 -- set interface vxlan1
980 type=vxlan options:remote_ip=192.168.1.2 options:key=flow
981 options:dst_port=8472
982
983
0f5edef0
BP
984Using OpenFlow (Manually or Via Controller)
985-------------------------------------------
c483d489 986
7b287e99
JP
987Q: What versions of OpenFlow does Open vSwitch support?
988
8e70e196
BP
989A: Open vSwitch 1.9 and earlier support only OpenFlow 1.0 (plus
990 extensions that bring in many of the features from later versions
991 of OpenFlow).
7b287e99 992
75fa58f8
BP
993 Open vSwitch 1.10 and later have experimental support for OpenFlow
994 1.2 and 1.3. On these versions of Open vSwitch, the following
995 command enables OpenFlow 1.0, 1.2, and 1.3 on bridge br0:
8e70e196 996
12eadc32 997 ovs-vsctl set bridge br0 protocols=OpenFlow10,OpenFlow12,OpenFlow13
8e70e196 998
75fa58f8
BP
999 Open vSwitch version 1.12 and later will have experimental support
1000 for OpenFlow 1.1, 1.2, and 1.3. On these versions of Open vSwitch,
1001 the following command enables OpenFlow 1.0, 1.1, 1.2, and 1.3 on
1002 bridge br0:
1003
1004 ovs-vsctl set bridge br0 protocols=OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13
1005
ac12b4cb
BP
1006 Use the -O option to enable support for later versions of OpenFlow
1007 in ovs-ofctl. For example:
1008
1009 ovs-ofctl -O OpenFlow13 dump-flows br0
1010
75fa58f8
BP
1011 Support for OpenFlow 1.1, 1.2, and 1.3 is still incomplete. Work
1012 to be done is tracked in OPENFLOW-1.1+ in the Open vSwitch sources
8e70e196
BP
1013 (also via http://openvswitch.org/development/openflow-1-x-plan/).
1014 When support for a given OpenFlow version is solidly implemented,
1015 Open vSwitch will enable that version by default.
7b287e99 1016
c483d489
BP
1017Q: I'm getting "error type 45250 code 0". What's that?
1018
1019A: This is a Open vSwitch extension to OpenFlow error codes. Open
1020 vSwitch uses this extension when it must report an error to an
1021 OpenFlow controller but no standard OpenFlow error code is
1022 suitable.
1023
1024 Open vSwitch logs the errors that it sends to controllers, so the
1025 easiest thing to do is probably to look at the ovs-vswitchd log to
1026 find out what the error was.
1027
1028 If you want to dissect the extended error message yourself, the
1029 format is documented in include/openflow/nicira-ext.h in the Open
1030 vSwitch source distribution. The extended error codes are
1031 documented in lib/ofp-errors.h.
1032
1033Q1: Some of the traffic that I'd expect my OpenFlow controller to see
1034 doesn't actually appear through the OpenFlow connection, even
1035 though I know that it's going through.
1036Q2: Some of the OpenFlow flows that my controller sets up don't seem
1037 to apply to certain traffic, especially traffic between OVS and
1038 the controller itself.
1039
1040A: By default, Open vSwitch assumes that OpenFlow controllers are
1041 connected "in-band", that is, that the controllers are actually
1042 part of the network that is being controlled. In in-band mode,
1043 Open vSwitch sets up special "hidden" flows to make sure that
1044 traffic can make it back and forth between OVS and the controllers.
1045 These hidden flows are higher priority than any flows that can be
1046 set up through OpenFlow, and they are not visible through normal
1047 OpenFlow flow table dumps.
1048
1049 Usually, the hidden flows are desirable and helpful, but
1050 occasionally they can cause unexpected behavior. You can view the
1051 full OpenFlow flow table, including hidden flows, on bridge br0
1052 with the command:
1053
1054 ovs-appctl bridge/dump-flows br0
1055
1056 to help you debug. The hidden flows are those with priorities
1057 greater than 65535 (the maximum priority that can be set with
1058 OpenFlow).
1059
1060 The DESIGN file at the top level of the Open vSwitch source
1061 distribution describes the in-band model in detail.
1062
1063 If your controllers are not actually in-band (e.g. they are on
1064 localhost via 127.0.0.1, or on a separate network), then you should
1065 configure your controllers in "out-of-band" mode. If you have one
1066 controller on bridge br0, then you can configure out-of-band mode
1067 on it with:
1068
1069 ovs-vsctl set controller br0 connection-mode=out-of-band
1070
1071Q: I configured all my controllers for out-of-band control mode but
1072 "ovs-appctl bridge/dump-flows" still shows some hidden flows.
1073
1074A: You probably have a remote manager configured (e.g. with "ovs-vsctl
1075 set-manager"). By default, Open vSwitch assumes that managers need
1076 in-band rules set up on every bridge. You can disable these rules
1077 on bridge br0 with:
1078
1079 ovs-vsctl set bridge br0 other-config:disable-in-band=true
1080
1081 This actually disables in-band control entirely for the bridge, as
1082 if all the bridge's controllers were configured for out-of-band
1083 control.
1084
1085Q: My OpenFlow controller doesn't see the VLANs that I expect.
1086
1087A: See answer under "VLANs", above.
1088
5cb2356b
BP
1089Q: I ran "ovs-ofctl add-flow br0 nw_dst=192.168.0.1,actions=drop"
1090 but I got a funny message like this:
1091
1092 ofp_util|INFO|normalization changed ofp_match, details:
1093 ofp_util|INFO| pre: nw_dst=192.168.0.1
1094 ofp_util|INFO|post:
1095
1096 and when I ran "ovs-ofctl dump-flows br0" I saw that my nw_dst
1097 match had disappeared, so that the flow ends up matching every
1098 packet.
1099
1100A: The term "normalization" in the log message means that a flow
1101 cannot match on an L3 field without saying what L3 protocol is in
1102 use. The "ovs-ofctl" command above didn't specify an L3 protocol,
1103 so the L3 field match was dropped.
1104
1105 In this case, the L3 protocol could be IP or ARP. A correct
1106 command for each possibility is, respectively:
1107
1108 ovs-ofctl add-flow br0 ip,nw_dst=192.168.0.1,actions=drop
1109
1110 and
1111
1112 ovs-ofctl add-flow br0 arp,nw_dst=192.168.0.1,actions=drop
1113
1114 Similarly, a flow cannot match on an L4 field without saying what
1115 L4 protocol is in use. For example, the flow match "tp_src=1234"
1116 is, by itself, meaningless and will be ignored. Instead, to match
1117 TCP source port 1234, write "tcp,tp_src=1234", or to match UDP
1118 source port 1234, write "udp,tp_src=1234".
1119
c5b25863
BP
1120Q: How can I figure out the OpenFlow port number for a given port?
1121
1122A: The OFPT_FEATURES_REQUEST message requests an OpenFlow switch to
1123 respond with an OFPT_FEATURES_REPLY that, among other information,
1124 includes a mapping between OpenFlow port names and numbers. From a
1125 command prompt, "ovs-ofctl show br0" makes such a request and
1126 prints the response for switch br0.
1127
1128 The Interface table in the Open vSwitch database also maps OpenFlow
1129 port names to numbers. To print the OpenFlow port number
1130 associated with interface eth0, run:
1131
1132 ovs-vsctl get Interface eth0 ofport
1133
1134 You can print the entire mapping with:
1135
1136 ovs-vsctl -- --columns=name,ofport list Interface
1137
1138 but the output mixes together interfaces from all bridges in the
1139 database, so it may be confusing if more than one bridge exists.
1140
1141 In the Open vSwitch database, ofport value -1 means that the
1142 interface could not be created due to an error. (The Open vSwitch
1143 log should indicate the reason.) ofport value [] (the empty set)
1144 means that the interface hasn't been created yet. The latter is
1145 normally an intermittent condition (unless ovs-vswitchd is not
1146 running).
7b287e99 1147
af1ac4b9
BP
1148Q: I added some flows with my controller or with ovs-ofctl, but when I
1149 run "ovs-dpctl dump-flows" I don't see them.
1150
1151A: ovs-dpctl queries a kernel datapath, not an OpenFlow switch. It
1152 won't display the information that you want. You want to use
1153 "ovs-ofctl dump-flows" instead.
1154
15d63ed3
BP
1155Q: It looks like each of the interfaces in my bonded port shows up
1156 as an individual OpenFlow port. Is that right?
1157
1158A: Yes, Open vSwitch makes individual bond interfaces visible as
1159 OpenFlow ports, rather than the bond as a whole. The interfaces
1160 are treated together as a bond for only a few purposes:
1161
1162 - Sending a packet to the OFPP_NORMAL port. (When an OpenFlow
1163 controller is not configured, this happens implicitly to
1164 every packet.)
1165
15d63ed3
BP
1166 - Mirrors configured for output to a bonded port.
1167
1168 It would make a lot of sense for Open vSwitch to present a bond as
1169 a single OpenFlow port. If you want to contribute an
1170 implementation of such a feature, please bring it up on the Open
1171 vSwitch development mailing list at dev@openvswitch.org.
1172
bb955418
BP
1173Q: I have a sophisticated network setup involving Open vSwitch, VMs or
1174 multiple hosts, and other components. The behavior isn't what I
1175 expect. Help!
1176
1177A: To debug network behavior problems, trace the path of a packet,
1178 hop-by-hop, from its origin in one host to a remote host. If
1179 that's correct, then trace the path of the response packet back to
1180 the origin.
1181
1182 Usually a simple ICMP echo request and reply ("ping") packet is
1183 good enough. Start by initiating an ongoing "ping" from the origin
1184 host to a remote host. If you are tracking down a connectivity
1185 problem, the "ping" will not display any successful output, but
1186 packets are still being sent. (In this case the packets being sent
1187 are likely ARP rather than ICMP.)
1188
1189 Tools available for tracing include the following:
1190
1191 - "tcpdump" and "wireshark" for observing hops across network
1192 devices, such as Open vSwitch internal devices and physical
1193 wires.
1194
1195 - "ovs-appctl dpif/dump-flows <br>" in Open vSwitch 1.10 and
1196 later or "ovs-dpctl dump-flows <br>" in earlier versions.
1197 These tools allow one to observe the actions being taken on
1198 packets in ongoing flows.
1199
1200 See ovs-vswitchd(8) for "ovs-appctl dpif/dump-flows"
1201 documentation, ovs-dpctl(8) for "ovs-dpctl dump-flows"
1202 documentation, and "Why are there so many different ways to
1203 dump flows?" above for some background.
1204
1205 - "ovs-appctl ofproto/trace" to observe the logic behind how
1206 ovs-vswitchd treats packets. See ovs-vswitchd(8) for
1207 documentation. You can out more details about a given flow
1208 that "ovs-dpctl dump-flows" displays, by cutting and pasting
1209 a flow from the output into an "ovs-appctl ofproto/trace"
1210 command.
1211
1212 - SPAN, RSPAN, and ERSPAN features of physical switches, to
1213 observe what goes on at these physical hops.
1214
1215 Starting at the origin of a given packet, observe the packet at
1216 each hop in turn. For example, in one plausible scenario, you
1217 might:
1218
1219 1. "tcpdump" the "eth" interface through which an ARP egresses
1220 a VM, from inside the VM.
1221
1222 2. "tcpdump" the "vif" or "tap" interface through which the ARP
1223 ingresses the host machine.
1224
1225 3. Use "ovs-dpctl dump-flows" to spot the ARP flow and observe
1226 the host interface through which the ARP egresses the
1227 physical machine. You may need to use "ovs-dpctl show" to
1228 interpret the port numbers. If the output seems surprising,
1229 you can use "ovs-appctl ofproto/trace" to observe details of
1230 how ovs-vswitchd determined the actions in the "ovs-dpctl
1231 dump-flows" output.
1232
1233 4. "tcpdump" the "eth" interface through which the ARP egresses
1234 the physical machine.
1235
1236 5. "tcpdump" the "eth" interface through which the ARP
1237 ingresses the physical machine, at the remote host that
1238 receives the ARP.
1239
1240 6. Use "ovs-dpctl dump-flows" to spot the ARP flow on the
1241 remote host that receives the ARP and observe the VM "vif"
1242 or "tap" interface to which the flow is directed. Again,
1243 "ovs-dpctl show" and "ovs-appctl ofproto/trace" might help.
1244
1245 7. "tcpdump" the "vif" or "tap" interface to which the ARP is
1246 directed.
1247
1248 8. "tcpdump" the "eth" interface through which the ARP
1249 ingresses a VM, from inside the VM.
1250
1251 It is likely that during one of these steps you will figure out the
1252 problem. If not, then follow the ARP reply back to the origin, in
1253 reverse.
1254
0f5edef0
BP
1255Q: How do I make a flow drop packets?
1256
e5f1da19
BP
1257A: To drop a packet is to receive it without forwarding it. OpenFlow
1258 explicitly specifies forwarding actions. Thus, a flow with an
1259 empty set of actions does not forward packets anywhere, causing
1260 them to be dropped. You can specify an empty set of actions with
1261 "actions=" on the ovs-ofctl command line. For example:
0f5edef0
BP
1262
1263 ovs-ofctl add-flow br0 priority=65535,actions=
1264
1265 would cause every packet entering switch br0 to be dropped.
1266
1267 You can write "drop" explicitly if you like. The effect is the
1268 same. Thus, the following command also causes every packet
1269 entering switch br0 to be dropped:
1270
1271 ovs-ofctl add-flow br0 priority=65535,actions=drop
1272
e5f1da19
BP
1273 "drop" is not an action, either in OpenFlow or Open vSwitch.
1274 Rather, it is only a way to say that there are no actions.
1275
2fafc091
BP
1276Q: I added a flow to send packets out the ingress port, like this:
1277
1278 ovs-ofctl add-flow br0 in_port=2,actions=2
1279
1280 but OVS drops the packets instead.
1281
1282A: Yes, OpenFlow requires a switch to ignore attempts to send a packet
1283 out its ingress port. The rationale is that dropping these packets
1284 makes it harder to loop the network. Sometimes this behavior can
1285 even be convenient, e.g. it is often the desired behavior in a flow
1286 that forwards a packet to several ports ("floods" the packet).
1287
1288 Sometimes one really needs to send a packet out its ingress port.
1289 In this case, output to OFPP_IN_PORT, which in ovs-ofctl syntax is
1290 expressed as just "in_port", e.g.:
1291
1292 ovs-ofctl add-flow br0 in_port=2,actions=in_port
1293
1294 This also works in some circumstances where the flow doesn't match
1295 on the input port. For example, if you know that your switch has
1296 five ports numbered 2 through 6, then the following will send every
1297 received packet out every port, even its ingress port:
1298
1299 ovs-ofctl add-flow br0 actions=2,3,4,5,6,in_port
1300
1301 or, equivalently:
1302
1303 ovs-ofctl add-flow br0 actions=all,in_port
1304
1305 Sometimes, in complicated flow tables with multiple levels of
1306 "resubmit" actions, a flow needs to output to a particular port
1307 that may or may not be the ingress port. It's difficult to take
1308 advantage of OFPP_IN_PORT in this situation. To help, Open vSwitch
1309 provides, as an OpenFlow extension, the ability to modify the
1310 in_port field. Whatever value is currently in the in_port field is
1311 the port to which outputs will be dropped, as well as the
1312 destination for OFPP_IN_PORT. This means that the following will
1313 reliably output to port 2 or to ports 2 through 6, respectively:
1314
1315 ovs-ofctl add-flow br0 in_port=2,actions=load:0->NXM_OF_IN_PORT[],2
1316 ovs-ofctl add-flow br0 actions=load:0->NXM_OF_IN_PORT[],2,3,4,5,6
1317
1318 If the input port is important, then one may save and restore it on
1319 the stack:
1320
1321 ovs-ofctl add-flow br0 actions=push:NXM_OF_IN_PORT[],\
1322 load:0->NXM_OF_IN_PORT[],\
1323 2,3,4,5,6,\
1324 pop:NXM_OF_IN_PORT[]
1325
d4ee72b4
BP
1326Q: My bridge br0 has host 192.168.0.1 on port 1 and host 192.168.0.2
1327 on port 2. I set up flows to forward only traffic destined to the
1328 other host and drop other traffic, like this:
1329
1330 priority=5,in_port=1,ip,nw_dst=192.168.0.2,actions=2
1331 priority=5,in_port=2,ip,nw_dst=192.168.0.1,actions=1
1332 priority=0,actions=drop
1333
1334 But it doesn't work--I don't get any connectivity when I do this.
1335 Why?
1336
1337A: These flows drop the ARP packets that IP hosts use to establish IP
1338 connectivity over Ethernet. To solve the problem, add flows to
1339 allow ARP to pass between the hosts:
1340
1341 priority=5,in_port=1,arp,actions=2
1342 priority=5,in_port=2,arp,actions=1
1343
1344 This issue can manifest other ways, too. The following flows that
1345 match on Ethernet addresses instead of IP addresses will also drop
1346 ARP packets, because ARP requests are broadcast instead of being
1347 directed to a specific host:
1348
1349 priority=5,in_port=1,dl_dst=54:00:00:00:00:02,actions=2
1350 priority=5,in_port=2,dl_dst=54:00:00:00:00:01,actions=1
1351 priority=0,actions=drop
1352
1353 The solution already described above will also work in this case.
1354 It may be better to add flows to allow all multicast and broadcast
1355 traffic:
1356
1357 priority=5,in_port=1,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00,actions=2
1358 priority=5,in_port=2,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00,actions=1
0f5edef0 1359
c483d489
BP
1360Contact
1361-------
1362
1363bugs@openvswitch.org
1364http://openvswitch.org/