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