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