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