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