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