FAQ

   1                  Open vSwitch <http://openvswitch.org>
   2
   3 Frequently Asked Questions
   4 ==========================
   5
   6 General
   7 -------
   8
   9 Q: What is Open vSwitch?
  10
  11 A: Open vSwitch is a production quality open source software switch
  12    designed to be used as a vswitch in virtualized server environments.  A
  13    vswitch forwards traffic between different VMs on the same physical host
  14    and also forwards traffic between VMs and the physical network.  Open
  15    vSwitch supports standard management interfaces (e.g. sFlow, NetFlow,
  16    RSPAN, CLI), and is open to programmatic extension and control using
  17    OpenFlow and the OVSDB management protocol.
  18
  19    Open vSwitch as designed to be compatible with modern switching
  20    chipsets.  This means that it can be ported to existing high-fanout
  21    switches allowing the same flexible control of the physical
  22    infrastructure as the virtual infrastructure.  It also means that
  23    Open vSwitch will be able to take advantage of on-NIC switching
  24    chipsets as their functionality matures.
  25
  26 Q: What virtualization platforms can use Open vSwitch?
  27
  28 A: Open vSwitch can currently run on any Linux-based virtualization
  29    platform (kernel 2.6.18 and newer), including: KVM, VirtualBox, Xen,
  30    Xen Cloud Platform, XenServer. As of Linux 3.3 it is part of the
  31    mainline kernel.  The bulk of the code is written in platform-
  32    independent C and is easily ported to other environments.  We welcome
  33    inquires about integrating Open vSwitch with other virtualization
  34    platforms.
  35
  36 Q: How can I try Open vSwitch?
  37
  38 A: The Open vSwitch source code can be built on a Linux system.  You can
  39    build and experiment with Open vSwitch on any Linux machine.
  40    Packages for various Linux distributions are available on many
  41    platforms, including: Debian, Ubuntu, Fedora.
  42
  43    You may also download and run a virtualization platform that already
  44    has Open vSwitch integrated.  For example, download a recent ISO for
  45    XenServer or Xen Cloud Platform.  Be aware that the version
  46    integrated with a particular platform may not be the most recent Open
  47    vSwitch release.
  48
  49 Q: Does Open vSwitch only work on Linux?
  50
  51 A: No, Open vSwitch has been ported to a number of different operating
  52    systems and hardware platforms.  Most of the development work occurs
  53    on Linux, but the code should be portable to any POSIX system.  We've
  54    seen Open vSwitch ported to a number of different platforms,
  55    including FreeBSD, Windows, and even non-POSIX embedded systems.
  56
  57    By definition, the Open vSwitch Linux kernel module only works on
  58    Linux and will provide the highest performance.  However, a userspace
  59    datapath is available that should be very portable.
  60
  61 Q: What's involved with porting Open vSwitch to a new platform or
  62    switching ASIC?
  63
  64 A: The PORTING document describes how one would go about porting Open
  65    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 WHY-OVS for a
  72    more detailed description of how Open vSwitch relates to the Linux
  73    Bridge.
  74
  75 Q: How is Open vSwitch related to distributed virtual switches like the
  76    VMware vNetwork distributed switch or the Cisco Nexus 1000V?
  77
  78 A: Distributed vswitch applications (e.g., VMware vNetwork distributed
  79    switch, Cisco Nexus 1000V) provide a centralized way to configure and
  80    monitor the network state of VMs that are spread across many physical
  81    hosts.  Open vSwitch is not a distributed vswitch itself, rather it
  82    runs on each physical host and supports remote management in a way
  83    that makes it easier for developers of virtualization/cloud
  84    management platforms to offer distributed vswitch capabilities.
  85
  86    To aid in distribution, Open vSwitch provides two open protocols that
  87    are specially designed for remote management in virtualized network
  88    environments: OpenFlow, which exposes flow-based forwarding state,
  89    and the OVSDB management protocol, which exposes switch port state.
  90    In addition to the switch implementation itself, Open vSwitch
  91    includes tools (ovs-controller, ovs-ofctl, ovs-vsctl) that developers
  92    can script and extend to provide distributed vswitch capabilities
  93    that are closely integrated with their virtualization management
  94    platform.
  95
  96 Q: Why doesn't Open vSwitch support distribution?
  97
  98 A: Open vSwitch is intended to be a useful component for building
  99    flexible network infrastructure. There are many different approaches
 100    to distribution which balance trade-offs between simplicity,
 101    scalability, hardware compatibility, convergence times, logical
 102    forwarding model, etc. The goal of Open vSwitch is to be able to
 103    support all as a primitive building block rather than choose a
 104    particular point in the distributed design space.
 105
 106 Q: How can I contribute to the Open vSwitch Community?
 107
 108 A: You can start by joining the mailing lists and helping to answer
 109    questions.  You can also suggest improvements to documentation.  If
 110    you have a feature or bug you would like to work on, send a mail to
 111    one of the mailing lists:
 112
 113        http://openvswitch.org/mlists/
 114
 115
 116
 117 Releases
 118 --------
 119
 120 Q: What does it mean for an Open vSwitch release to be LTS (long-term
 121    support)?
 122
 123 A: All official releases have been through a comprehensive testing
 124    process and are suitable for production use.  Planned releases will
 125    occur several times a year.  If a significant bug is identified in an
 126    LTS release, we will provide an updated release that includes the
 127    fix.  Releases that are not LTS may not be fixed and may just be
 128    supplanted by the next major release.  The current LTS release is
 129    1.4.x.
 130
 131 Q: What Linux kernel versions does each Open vSwitch release work with?
 132
 133 A: The following table lists the Linux kernel versions against which the
 134    given versions of the Open vSwitch kernel module will successfully
 135    build.  The Linux kernel versions are upstream kernel versions, so
 136    Linux kernels modified from the upstream sources may not build in
 137    some cases even if they are based on a supported version.  This is
 138    most notably true of Red Hat Enterprise Linux (RHEL) kernels, which
 139    are extensively modified from upstream.
 140
 141    Open vSwitch   Linux kernel
 142    ------------   -------------
 143        1.4.x      2.6.18 to 3.2
 144        1.5.x      2.6.18 to 3.2
 145        1.6.x      2.6.18 to 3.2
 146        1.7.x      2.6.18 to 3.3
 147        1.8.x      2.6.18 to 3.4
 148        1.9.x      2.6.18 to 3.8
 149
 150    Open vSwitch userspace should also work with the Linux kernel module
 151    built into Linux 3.3 and later.
 152
 153    Open vSwitch userspace is not sensitive to the Linux kernel version.
 154    It should build against almost any kernel, certainly against 2.6.18
 155    and later.
 156
 157 Q: What features are not available in the Open vSwitch kernel datapath
 158    that ships as part of the upstream Linux kernel?
 159
 160 A: The kernel module in upstream Linux 3.3 and later does not include
 161    tunnel virtual ports, that is, interfaces with type "gre",
 162    "ipsec_gre", "gre64", "ipsec_gre64", "vxlan", or "capwap".  It is
 163    possible to create tunnels in Linux and attach them to Open vSwitch
 164    as system devices.  However, they cannot be dynamically created
 165    through the OVSDB protocol or set the tunnel ids as a flow action.
 166
 167    Work is in progress in adding tunnel virtual ports to the upstream
 168    Linux version of the Open vSwitch kernel module.  For now, if you
 169    need these features, use the kernel module from the Open vSwitch
 170    distribution instead of the upstream Linux kernel module.
 171
 172    The upstream kernel module does not include patch ports, but this
 173    only matters for Open vSwitch 1.9 and earlier, because Open vSwitch
 174    1.10 and later implement patch ports without using this kernel
 175    feature.
 176
 177 Q: What features are not available when using the userspace datapath?
 178
 179 A: Tunnel virtual ports are not supported, as described in the
 180    previous answer.  It is also not possible to use queue-related
 181    actions.  On Linux kernels before 2.6.39, maximum-sized VLAN packets
 182    may not be transmitted.
 183
 184
 185 Terminology
 186 -----------
 187
 188 Q: I thought Open vSwitch was a virtual Ethernet switch, but the
 189    documentation keeps talking about bridges.  What's a bridge?
 190
 191 A: In networking, the terms "bridge" and "switch" are synonyms.  Open
 192    vSwitch implements an Ethernet switch, which means that it is also
 193    an Ethernet bridge.
 194
 195 Q: What's a VLAN?
 196
 197 A: See the "VLAN" section below.
 198
 199
 200 Basic Configuration
 201 -------------------
 202
 203 Q: How do I configure a port as an access port?
 204
 205 A: Add "tag=VLAN" to your "ovs-vsctl add-port" command.  For example,
 206    the following commands configure br0 with eth0 as a trunk port (the
 207    default) and tap0 as an access port for VLAN 9:
 208
 209        ovs-vsctl add-br br0
 210        ovs-vsctl add-port br0 eth0
 211        ovs-vsctl add-port br0 tap0 tag=9
 212
 213    If you want to configure an already added port as an access port,
 214    use "ovs-vsctl set", e.g.:
 215
 216        ovs-vsctl set port tap0 tag=9
 217
 218 Q: How do I configure a port as a SPAN port, that is, enable mirroring
 219    of all traffic to that port?
 220
 221 A: The following commands configure br0 with eth0 and tap0 as trunk
 222    ports.  All traffic coming in or going out on eth0 or tap0 is also
 223    mirrored to tap1; any traffic arriving on tap1 is dropped:
 224
 225        ovs-vsctl add-br br0
 226        ovs-vsctl add-port br0 eth0
 227        ovs-vsctl add-port br0 tap0
 228        ovs-vsctl add-port br0 tap1 \
 229            -- --id=@p get port tap1 \
 230            -- --id=@m create mirror name=m0 select-all=true output-port=@p \
 231            -- set bridge br0 mirrors=@m
 232
 233    To later disable mirroring, run:
 234
 235        ovs-vsctl clear bridge br0 mirrors
 236
 237 Q: How do I configure a VLAN as an RSPAN VLAN, that is, enable
 238    mirroring of all traffic to that VLAN?
 239
 240 A: The following commands configure br0 with eth0 as a trunk port and
 241    tap0 as an access port for VLAN 10.  All traffic coming in or going
 242    out on tap0, as well as traffic coming in or going out on eth0 in
 243    VLAN 10, is also mirrored to VLAN 15 on eth0.  The original tag for
 244    VLAN 10, in cases where one is present, is dropped as part of
 245    mirroring:
 246
 247        ovs-vsctl add-br br0
 248        ovs-vsctl add-port br0 eth0
 249        ovs-vsctl add-port br0 tap0 tag=10
 250        ovs-vsctl \
 251            -- --id=@m create mirror name=m0 select-all=true select-vlan=10 \
 252                                     output-vlan=15 \
 253            -- set bridge br0 mirrors=@m
 254
 255    To later disable mirroring, run:
 256
 257        ovs-vsctl clear bridge br0 mirrors
 258
 259    Mirroring to a VLAN can disrupt a network that contains unmanaged
 260    switches.  See ovs-vswitchd.conf.db(5) for details.  Mirroring to a
 261    GRE tunnel has fewer caveats than mirroring to a VLAN and should
 262    generally be preferred.
 263
 264 Q: Can I mirror more than one input VLAN to an RSPAN VLAN?
 265
 266 A: Yes, but mirroring to a VLAN strips the original VLAN tag in favor
 267    of the specified output-vlan.  This loss of information may make
 268    the mirrored traffic too hard to interpret.
 269
 270    To mirror multiple VLANs, use the commands above, but specify a
 271    comma-separated list of VLANs as the value for select-vlan.  To
 272    mirror every VLAN, use the commands above, but omit select-vlan and
 273    its value entirely.
 274
 275    When a packet arrives on a VLAN that is used as a mirror output
 276    VLAN, the mirror is disregarded.  Instead, in standalone mode, OVS
 277    floods the packet across all the ports for which the mirror output
 278    VLAN is configured.  (If an OpenFlow controller is in use, then it
 279    can override this behavior through the flow table.)  If OVS is used
 280    as an intermediate switch, rather than an edge switch, this ensures
 281    that the RSPAN traffic is distributed through the network.
 282
 283    Mirroring to a VLAN can disrupt a network that contains unmanaged
 284    switches.  See ovs-vswitchd.conf.db(5) for details.  Mirroring to a
 285    GRE tunnel has fewer caveats than mirroring to a VLAN and should
 286    generally be preferred.
 287
 288 Q: How do I configure mirroring of all traffic to a GRE tunnel?
 289
 290 A: The following commands configure br0 with eth0 and tap0 as trunk
 291    ports.  All traffic coming in or going out on eth0 or tap0 is also
 292    mirrored to gre0, a GRE tunnel to the remote host 192.168.1.10; any
 293    traffic arriving on gre0 is dropped:
 294
 295        ovs-vsctl add-br br0
 296        ovs-vsctl add-port br0 eth0
 297        ovs-vsctl add-port br0 tap0
 298        ovs-vsctl add-port br0 gre0 \
 299            -- set interface gre0 type=gre options:remote_ip=192.168.1.10 \
 300            -- --id=@p get port gre0 \
 301            -- --id=@m create mirror name=m0 select-all=true output-port=@p \
 302            -- set bridge br0 mirrors=@m
 303
 304    To later disable mirroring and destroy the GRE tunnel:
 305
 306        ovs-vsctl clear bridge br0 mirrors
 307        ovs-vcstl del-port br0 gre0
 308
 309 Q: Does Open vSwitch support ERSPAN?
 310
 311 A: No.  ERSPAN is an undocumented proprietary protocol.  As an
 312    alternative, Open vSwitch supports mirroring to a GRE tunnel (see
 313    above).
 314
 315
 316 Configuration Problems
 317 ----------------------
 318
 319 Q: I created a bridge and added my Ethernet port to it, using commands
 320    like these:
 321
 322        ovs-vsctl add-br br0
 323        ovs-vsctl add-port br0 eth0
 324
 325    and as soon as I ran the "add-port" command I lost all connectivity
 326    through eth0.  Help!
 327
 328 A: A physical Ethernet device that is part of an Open vSwitch bridge
 329    should not have an IP address.  If one does, then that IP address
 330    will not be fully functional.
 331
 332    You can restore functionality by moving the IP address to an Open
 333    vSwitch "internal" device, such as the network device named after
 334    the bridge itself.  For example, assuming that eth0's IP address is
 335    192.168.128.5, you could run the commands below to fix up the
 336    situation:
 337
 338        ifconfig eth0 0.0.0.0
 339        ifconfig br0 192.168.128.5
 340
 341    (If your only connection to the machine running OVS is through the
 342    IP address in question, then you would want to run all of these
 343    commands on a single command line, or put them into a script.)  If
 344    there were any additional routes assigned to eth0, then you would
 345    also want to use commands to adjust these routes to go through br0.
 346
 347    If you use DHCP to obtain an IP address, then you should kill the
 348    DHCP client that was listening on the physical Ethernet interface
 349    (e.g. eth0) and start one listening on the internal interface
 350    (e.g. br0).  You might still need to manually clear the IP address
 351    from the physical interface (e.g. with "ifconfig eth0 0.0.0.0").
 352
 353    There is no compelling reason why Open vSwitch must work this way.
 354    However, this is the way that the Linux kernel bridge module has
 355    always worked, so it's a model that those accustomed to Linux
 356    bridging are already used to.  Also, the model that most people
 357    expect is not implementable without kernel changes on all the
 358    versions of Linux that Open vSwitch supports.
 359
 360    By the way, this issue is not specific to physical Ethernet
 361    devices.  It applies to all network devices except Open vswitch
 362    "internal" devices.
 363
 364 Q: I created a bridge and added a couple of Ethernet ports to it,
 365    using commands like these:
 366
 367        ovs-vsctl add-br br0
 368        ovs-vsctl add-port br0 eth0
 369        ovs-vsctl add-port br0 eth1
 370
 371    and now my network seems to have melted: connectivity is unreliable
 372    (even connectivity that doesn't go through Open vSwitch), all the
 373    LEDs on my physical switches are blinking, wireshark shows
 374    duplicated packets, and CPU usage is very high.
 375
 376 A: More than likely, you've looped your network.  Probably, eth0 and
 377    eth1 are connected to the same physical Ethernet switch.  This
 378    yields a scenario where OVS receives a broadcast packet on eth0 and
 379    sends it out on eth1, then the physical switch connected to eth1
 380    sends the packet back on eth0, and so on forever.  More complicated
 381    scenarios, involving a loop through multiple switches, are possible
 382    too.
 383
 384    The solution depends on what you are trying to do:
 385
 386        - If you added eth0 and eth1 to get higher bandwidth or higher
 387          reliability between OVS and your physical Ethernet switch,
 388          use a bond.  The following commands create br0 and then add
 389          eth0 and eth1 as a bond:
 390
 391              ovs-vsctl add-br br0
 392              ovs-vsctl add-bond br0 bond0 eth0 eth1
 393
 394          Bonds have tons of configuration options.  Please read the
 395          documentation on the Port table in ovs-vswitchd.conf.db(5)
 396          for all the details.
 397
 398        - Perhaps you don't actually need eth0 and eth1 to be on the
 399          same bridge.  For example, if you simply want to be able to
 400          connect each of them to virtual machines, then you can put
 401          each of them on a bridge of its own:
 402
 403              ovs-vsctl add-br br0
 404              ovs-vsctl add-port br0 eth0
 405
 406              ovs-vsctl add-br br1
 407              ovs-vsctl add-port br1 eth1
 408
 409          and then connect VMs to br0 and br1.  (A potential
 410          disadvantage is that traffic cannot directly pass between br0
 411          and br1.  Instead, it will go out eth0 and come back in eth1,
 412          or vice versa.)
 413
 414        - If you have a redundant or complex network topology and you
 415          want to prevent loops, turn on spanning tree protocol (STP).
 416          The following commands create br0, enable STP, and add eth0
 417          and eth1 to the bridge.  The order is important because you
 418          don't want have to have a loop in your network even
 419          transiently:
 420
 421              ovs-vsctl add-br br0
 422              ovs-vsctl set bridge br0 stp_enable=true
 423              ovs-vsctl add-port br0 eth0
 424              ovs-vsctl add-port br0 eth1
 425
 426          The Open vSwitch implementation of STP is not well tested.
 427          Please report any bugs you observe, but if you'd rather avoid
 428          acting as a beta tester then another option might be your
 429          best shot.
 430
 431 Q: I can't seem to use Open vSwitch in a wireless network.
 432
 433 A: Wireless base stations generally only allow packets with the source
 434    MAC address of NIC that completed the initial handshake.
 435    Therefore, without MAC rewriting, only a single device can
 436    communicate over a single wireless link.
 437
 438    This isn't specific to Open vSwitch, it's enforced by the access
 439    point, so the same problems will show up with the Linux bridge or
 440    any other way to do bridging.
 441
 442 Q: Is there any documentation on the database tables and fields?
 443
 444 A: Yes.  ovs-vswitchd.conf.db(5) is a comprehensive reference.
 445
 446 Q: When I run ovs-dpctl I no longer see the bridges I created.  Instead,
 447    I only see a datapath called "ovs-system".  How can I see datapath
 448    information about a particular bridge?
 449
 450 A: In version 1.9.0, OVS switched to using a single datapath that is
 451    shared by all bridges of that type.  The "ovs-appctl dpif/*"
 452    commands provide similar functionality that is scoped by the bridge.
 453
 454
 455 Quality of Service (QoS)
 456 ------------------------
 457
 458 Q: How do I configure Quality of Service (QoS)?
 459
 460 A: Suppose that you want to set up bridge br0 connected to physical
 461    Ethernet port eth0 (a 1 Gbps device) and virtual machine interfaces
 462    vif1.0 and vif2.0, and that you want to limit traffic from vif1.0
 463    to eth0 to 10 Mbps and from vif2.0 to eth0 to 20 Mbps.  Then, you
 464    could configure the bridge this way:
 465
 466        ovs-vsctl -- \
 467            add-br br0 -- \
 468            add-port br0 eth0 -- \
 469            add-port br0 vif1.0 -- set interface vif1.0 ofport_request=5 -- \
 470            add-port br0 vif2.0 -- set interface vif2.0 ofport_request=6 -- \
 471            set port eth0 qos=@newqos -- \
 472            --id=@newqos create qos type=linux-htb \
 473                other-config:max-rate=1000000000 \
 474                queues:123=@vif10queue \
 475                queues:234=@vif20queue -- \
 476            --id=@vif10queue create queue other-config:max-rate=10000000 -- \
 477            --id=@vif20queue create queue other-config:max-rate=20000000
 478
 479    At this point, bridge br0 is configured with the ports and eth0 is
 480    configured with the queues that you need for QoS, but nothing is
 481    actually directing packets from vif1.0 or vif2.0 to the queues that
 482    we have set up for them.  That means that all of the packets to
 483    eth0 are going to the "default queue", which is not what we want.
 484
 485    We use OpenFlow to direct packets from vif1.0 and vif2.0 to the
 486    queues reserved for them:
 487
 488        ovs-ofctl add-flow br0 in_port=5,actions=set_queue:123,normal
 489        ovs-ofctl add-flow br0 in_port=6,actions=set_queue:234,normal
 490
 491    Each of the above flows matches on the input port, sets up the
 492    appropriate queue (123 for vif1.0, 234 for vif2.0), and then
 493    executes the "normal" action, which performs the same switching
 494    that Open vSwitch would have done without any OpenFlow flows being
 495    present.  (We know that vif1.0 and vif2.0 have OpenFlow port
 496    numbers 5 and 6, respectively, because we set their ofport_request
 497    columns above.  If we had not done that, then we would have needed
 498    to find out their port numbers before setting up these flows.)
 499
 500    Now traffic going from vif1.0 or vif2.0 to eth0 should be
 501    rate-limited.
 502
 503    By the way, if you delete the bridge created by the above commands,
 504    with:
 505
 506        ovs-vsctl del-br br0
 507
 508    then that will leave one unreferenced QoS record and two
 509    unreferenced Queue records in the Open vSwich database.  One way to
 510    clear them out, assuming you don't have other QoS or Queue records
 511    that you want to keep, is:
 512
 513        ovs-vsctl -- --all destroy QoS -- --all destroy Queue
 514
 515 Q: I configured Quality of Service (QoS) in my OpenFlow network by
 516    adding records to the QoS and Queue table, but the results aren't
 517    what I expect.
 518
 519 A: Did you install OpenFlow flows that use your queues?  This is the
 520    primary way to tell Open vSwitch which queues you want to use.  If
 521    you don't do this, then the default queue will be used, which will
 522    probably not have the effect you want.
 523
 524    Refer to the previous question for an example.
 525
 526 Q: I configured QoS, correctly, but my measurements show that it isn't
 527    working as well as I expect.
 528
 529 A: With the Linux kernel, the Open vSwitch implementation of QoS has
 530    two aspects:
 531
 532        - Open vSwitch configures a subset of Linux kernel QoS
 533          features, according to what is in OVSDB.  It is possible that
 534          this code has bugs.  If you believe that this is so, then you
 535          can configure the Linux traffic control (QoS) stack directly
 536          with the "tc" program.  If you get better results that way,
 537          you can send a detailed bug report to bugs@openvswitch.org.
 538
 539          It is certain that Open vSwitch cannot configure every Linux
 540          kernel QoS feature.  If you need some feature that OVS cannot
 541          configure, then you can also use "tc" directly (or add that
 542          feature to OVS).
 543
 544        - The Open vSwitch implementation of OpenFlow allows flows to
 545          be directed to particular queues.  This is pretty simple and
 546          unlikely to have serious bugs at this point.
 547
 548    However, most problems with QoS on Linux are not bugs in Open
 549    vSwitch at all.  They tend to be either configuration errors
 550    (please see the earlier questions in this section) or issues with
 551    the traffic control (QoS) stack in Linux.  The Open vSwitch
 552    developers are not experts on Linux traffic control.  We suggest
 553    that, if you believe you are encountering a problem with Linux
 554    traffic control, that you consult the tc manpages (e.g. tc(8),
 555    tc-htb(8), tc-hfsc(8)), web resources (e.g. http://lartc.org/), or
 556    mailing lists (e.g. http://vger.kernel.org/vger-lists.html#netdev).
 557
 558
 559 VLANs
 560 -----
 561
 562 Q: What's a VLAN?
 563
 564 A: At the simplest level, a VLAN (short for "virtual LAN") is a way to
 565    partition a single switch into multiple switches.  Suppose, for
 566    example, that you have two groups of machines, group A and group B.
 567    You want the machines in group A to be able to talk to each other,
 568    and you want the machine in group B to be able to talk to each
 569    other, but you don't want the machines in group A to be able to
 570    talk to the machines in group B.  You can do this with two
 571    switches, by plugging the machines in group A into one switch and
 572    the machines in group B into the other switch.
 573
 574    If you only have one switch, then you can use VLANs to do the same
 575    thing, by configuring the ports for machines in group A as VLAN
 576    "access ports" for one VLAN and the ports for group B as "access
 577    ports" for a different VLAN.  The switch will only forward packets
 578    between ports that are assigned to the same VLAN, so this
 579    effectively subdivides your single switch into two independent
 580    switches, one for each group of machines.
 581
 582    So far we haven't said anything about VLAN headers.  With access
 583    ports, like we've described so far, no VLAN header is present in
 584    the Ethernet frame.  This means that the machines (or switches)
 585    connected to access ports need not be aware that VLANs are
 586    involved, just like in the case where we use two different physical
 587    switches.
 588
 589    Now suppose that you have a whole bunch of switches in your
 590    network, instead of just one, and that some machines in group A are
 591    connected directly to both switches 1 and 2.  To allow these
 592    machines to talk to each other, you could add an access port for
 593    group A's VLAN to switch 1 and another to switch 2, and then
 594    connect an Ethernet cable between those ports.  That works fine,
 595    but it doesn't scale well as the number of switches and the number
 596    of VLANs increases, because you use up a lot of valuable switch
 597    ports just connecting together your VLANs.
 598
 599    This is where VLAN headers come in.  Instead of using one cable and
 600    two ports per VLAN to connect a pair of switches, we configure a
 601    port on each switch as a VLAN "trunk port".  Packets sent and
 602    received on a trunk port carry a VLAN header that says what VLAN
 603    the packet belongs to, so that only two ports total are required to
 604    connect the switches, regardless of the number of VLANs in use.
 605    Normally, only switches (either physical or virtual) are connected
 606    to a trunk port, not individual hosts, because individual hosts
 607    don't expect to see a VLAN header in the traffic that they receive.
 608
 609    None of the above discussion says anything about particular VLAN
 610    numbers.  This is because VLAN numbers are completely arbitrary.
 611    One must only ensure that a given VLAN is numbered consistently
 612    throughout a network and that different VLANs are given different
 613    numbers.  (That said, VLAN 0 is usually synonymous with a packet
 614    that has no VLAN header, and VLAN 4095 is reserved.)
 615
 616 Q: VLANs don't work.
 617
 618 A: Many drivers in Linux kernels before version 3.3 had VLAN-related
 619    bugs.  If you are having problems with VLANs that you suspect to be
 620    driver related, then you have several options:
 621
 622        - Upgrade to Linux 3.3 or later.
 623
 624        - Build and install a fixed version of the particular driver
 625          that is causing trouble, if one is available.
 626
 627        - Use a NIC whose driver does not have VLAN problems.
 628
 629        - Use "VLAN splinters", a feature in Open vSwitch 1.4 and later
 630          that works around bugs in kernel drivers.  To enable VLAN
 631          splinters on interface eth0, use the command:
 632
 633            ovs-vsctl set interface eth0 other-config:enable-vlan-splinters=true
 634
 635          For VLAN splinters to be effective, Open vSwitch must know
 636          which VLANs are in use.  See the "VLAN splinters" section in
 637          the Interface table in ovs-vswitchd.conf.db(5) for details on
 638          how Open vSwitch infers in-use VLANs.
 639
 640          VLAN splinters increase memory use and reduce performance, so
 641          use them only if needed.
 642
 643        - Apply the "vlan workaround" patch from the XenServer kernel
 644          patch queue, build Open vSwitch against this patched kernel,
 645          and then use ovs-vlan-bug-workaround(8) to enable the VLAN
 646          workaround for each interface whose driver is buggy.
 647
 648          (This is a nontrivial exercise, so this option is included
 649          only for completeness.)
 650
 651    It is not always easy to tell whether a Linux kernel driver has
 652    buggy VLAN support.  The ovs-vlan-test(8) and ovs-test(8) utilities
 653    can help you test.  See their manpages for details.  Of the two
 654    utilities, ovs-test(8) is newer and more thorough, but
 655    ovs-vlan-test(8) may be easier to use.
 656
 657 Q: VLANs still don't work.  I've tested the driver so I know that it's OK.
 658
 659 A: Do you have VLANs enabled on the physical switch that OVS is
 660    attached to?  Make sure that the port is configured to trunk the
 661    VLAN or VLANs that you are using with OVS.
 662
 663 Q: Outgoing VLAN-tagged traffic goes through OVS to my physical switch
 664    and to its destination host, but OVS seems to drop incoming return
 665    traffic.
 666
 667 A: It's possible that you have the VLAN configured on your physical
 668    switch as the "native" VLAN.  In this mode, the switch treats
 669    incoming packets either tagged with the native VLAN or untagged as
 670    part of the native VLAN.  It may also send outgoing packets in the
 671    native VLAN without a VLAN tag.
 672
 673    If this is the case, you have two choices:
 674
 675        - Change the physical switch port configuration to tag packets
 676          it forwards to OVS with the native VLAN instead of forwarding
 677          them untagged.
 678
 679        - Change the OVS configuration for the physical port to a
 680          native VLAN mode.  For example, the following sets up a
 681          bridge with port eth0 in "native-tagged" mode in VLAN 9:
 682
 683              ovs-vsctl add-br br0
 684              ovs-vsctl add-port br0 eth0 tag=9 vlan_mode=native-tagged
 685
 686          In this situation, "native-untagged" mode will probably work
 687          equally well.  Refer to the documentation for the Port table
 688          in ovs-vswitchd.conf.db(5) for more information.
 689
 690 Q: I added a pair of VMs on different VLANs, like this:
 691
 692        ovs-vsctl add-br br0
 693        ovs-vsctl add-port br0 eth0
 694        ovs-vsctl add-port br0 tap0 tag=9
 695        ovs-vsctl add-port br0 tap1 tag=10
 696
 697     but the VMs can't access each other, the external network, or the
 698     Internet.
 699
 700 A: It is to be expected that the VMs can't access each other.  VLANs
 701    are a means to partition a network.  When you configured tap0 and
 702    tap1 as access ports for different VLANs, you indicated that they
 703    should be isolated from each other.
 704
 705    As for the external network and the Internet, it seems likely that
 706    the machines you are trying to access are not on VLAN 9 (or 10) and
 707    that the Internet is not available on VLAN 9 (or 10).
 708
 709 Q: Can I configure an IP address on a VLAN?
 710
 711 A: Yes.  Use an "internal port" configured as an access port.  For
 712    example, the following configures IP address 192.168.0.7 on VLAN 9.
 713    That is, OVS will forward packets from eth0 to 192.168.0.7 only if
 714    they have an 802.1Q header with VLAN 9.  Conversely, traffic
 715    forwarded from 192.168.0.7 to eth0 will be tagged with an 802.1Q
 716    header with VLAN 9:
 717
 718        ovs-vsctl add-br br0
 719        ovs-vsctl add-port br0 eth0
 720        ovs-vsctl add-port br0 vlan9 tag=9 -- set interface vlan9 type=internal
 721        ifconfig vlan9 192.168.0.7
 722
 723 Q: My OpenFlow controller doesn't see the VLANs that I expect.
 724
 725 A: The configuration for VLANs in the Open vSwitch database (e.g. via
 726    ovs-vsctl) only affects traffic that goes through Open vSwitch's
 727    implementation of the OpenFlow "normal switching" action.  By
 728    default, when Open vSwitch isn't connected to a controller and
 729    nothing has been manually configured in the flow table, all traffic
 730    goes through the "normal switching" action.  But, if you set up
 731    OpenFlow flows on your own, through a controller or using ovs-ofctl
 732    or through other means, then you have to implement VLAN handling
 733    yourself.
 734
 735    You can use "normal switching" as a component of your OpenFlow
 736    actions, e.g. by putting "normal" into the lists of actions on
 737    ovs-ofctl or by outputting to OFPP_NORMAL from an OpenFlow
 738    controller.  This will only be suitable for some situations,
 739    though.
 740
 741 Q: I configured ports on a bridge as access ports with different VLAN
 742    tags, like this:
 743
 744        ovs-vsctl add-br br0
 745        ovs-vsctl set-controller br0 tcp:192.168.0.10:6633
 746        ovs-vsctl add-port br0 eth0
 747        ovs-vsctl add-port br0 tap0 tag=9
 748        ovs-vsctl add-port br0 tap1 tag=10
 749
 750    but the VMs running behind tap0 and tap1 can still communicate,
 751    that is, they are not isolated from each other even though they are
 752    on different VLANs.
 753
 754 A: Do you have a controller configured on br0 (as the commands above
 755    do)?  If so, then this is a variant on the previous question, "My
 756    OpenFlow controller doesn't see the VLANs that I expect," and you
 757    can refer to the answer there for more information.
 758
 759
 760 Controllers
 761 -----------
 762
 763 Q: What versions of OpenFlow does Open vSwitch support?
 764
 765 A: Open vSwitch 1.9 and earlier support only OpenFlow 1.0 (plus
 766    extensions that bring in many of the features from later versions
 767    of OpenFlow).
 768
 769    Open vSwitch versions 1.10 and later will have experimental support
 770    for OpenFlow 1.2 and 1.3.  On these versions of Open vSwitch, the
 771    following command enables OpenFlow 1.0, 1.2, and 1.3 on bridge br0:
 772
 773        ovs-vsctl set bridge br0 protocols=openflow10,openflow12,openflow13
 774
 775    Support for OpenFlow 1.1 is incomplete enough that it cannot yet be
 776    enabled, even experimentally.
 777
 778    Support for OpenFlow 1.2 and 1.3 is still incomplete.  Work to be
 779    done is tracked in OPENFLOW-1.1+ in the Open vSwitch source tree
 780    (also via http://openvswitch.org/development/openflow-1-x-plan/).
 781    When support for a given OpenFlow version is solidly implemented,
 782    Open vSwitch will enable that version by default.
 783
 784 Q: I'm getting "error type 45250 code 0".  What's that?
 785
 786 A: This is a Open vSwitch extension to OpenFlow error codes.  Open
 787    vSwitch uses this extension when it must report an error to an
 788    OpenFlow controller but no standard OpenFlow error code is
 789    suitable.
 790
 791    Open vSwitch logs the errors that it sends to controllers, so the
 792    easiest thing to do is probably to look at the ovs-vswitchd log to
 793    find out what the error was.
 794
 795    If you want to dissect the extended error message yourself, the
 796    format is documented in include/openflow/nicira-ext.h in the Open
 797    vSwitch source distribution.  The extended error codes are
 798    documented in lib/ofp-errors.h.
 799
 800 Q1: Some of the traffic that I'd expect my OpenFlow controller to see
 801     doesn't actually appear through the OpenFlow connection, even
 802     though I know that it's going through.
 803 Q2: Some of the OpenFlow flows that my controller sets up don't seem
 804     to apply to certain traffic, especially traffic between OVS and
 805     the controller itself.
 806
 807 A: By default, Open vSwitch assumes that OpenFlow controllers are
 808    connected "in-band", that is, that the controllers are actually
 809    part of the network that is being controlled.  In in-band mode,
 810    Open vSwitch sets up special "hidden" flows to make sure that
 811    traffic can make it back and forth between OVS and the controllers.
 812    These hidden flows are higher priority than any flows that can be
 813    set up through OpenFlow, and they are not visible through normal
 814    OpenFlow flow table dumps.
 815
 816    Usually, the hidden flows are desirable and helpful, but
 817    occasionally they can cause unexpected behavior.  You can view the
 818    full OpenFlow flow table, including hidden flows, on bridge br0
 819    with the command:
 820
 821        ovs-appctl bridge/dump-flows br0
 822
 823    to help you debug.  The hidden flows are those with priorities
 824    greater than 65535 (the maximum priority that can be set with
 825    OpenFlow).
 826
 827    The DESIGN file at the top level of the Open vSwitch source
 828    distribution describes the in-band model in detail.
 829
 830    If your controllers are not actually in-band (e.g. they are on
 831    localhost via 127.0.0.1, or on a separate network), then you should
 832    configure your controllers in "out-of-band" mode.  If you have one
 833    controller on bridge br0, then you can configure out-of-band mode
 834    on it with:
 835
 836        ovs-vsctl set controller br0 connection-mode=out-of-band
 837
 838 Q: I configured all my controllers for out-of-band control mode but
 839    "ovs-appctl bridge/dump-flows" still shows some hidden flows.
 840
 841 A: You probably have a remote manager configured (e.g. with "ovs-vsctl
 842    set-manager").  By default, Open vSwitch assumes that managers need
 843    in-band rules set up on every bridge.  You can disable these rules
 844    on bridge br0 with:
 845
 846        ovs-vsctl set bridge br0 other-config:disable-in-band=true
 847
 848    This actually disables in-band control entirely for the bridge, as
 849    if all the bridge's controllers were configured for out-of-band
 850    control.
 851
 852 Q: My OpenFlow controller doesn't see the VLANs that I expect.
 853
 854 A: See answer under "VLANs", above.
 855
 856 Q: I ran "ovs-ofctl add-flow br0 nw_dst=192.168.0.1,actions=drop"
 857    but I got a funny message like this:
 858
 859        ofp_util|INFO|normalization changed ofp_match, details:
 860        ofp_util|INFO| pre: nw_dst=192.168.0.1
 861        ofp_util|INFO|post:
 862
 863    and when I ran "ovs-ofctl dump-flows br0" I saw that my nw_dst
 864    match had disappeared, so that the flow ends up matching every
 865    packet.
 866
 867 A: The term "normalization" in the log message means that a flow
 868    cannot match on an L3 field without saying what L3 protocol is in
 869    use.  The "ovs-ofctl" command above didn't specify an L3 protocol,
 870    so the L3 field match was dropped.
 871
 872    In this case, the L3 protocol could be IP or ARP.  A correct
 873    command for each possibility is, respectively:
 874
 875        ovs-ofctl add-flow br0 ip,nw_dst=192.168.0.1,actions=drop
 876
 877    and
 878
 879        ovs-ofctl add-flow br0 arp,nw_dst=192.168.0.1,actions=drop
 880
 881    Similarly, a flow cannot match on an L4 field without saying what
 882    L4 protocol is in use.  For example, the flow match "tp_src=1234"
 883    is, by itself, meaningless and will be ignored.  Instead, to match
 884    TCP source port 1234, write "tcp,tp_src=1234", or to match UDP
 885    source port 1234, write "udp,tp_src=1234".
 886
 887 Q: How can I figure out the OpenFlow port number for a given port?
 888
 889 A: The OFPT_FEATURES_REQUEST message requests an OpenFlow switch to
 890    respond with an OFPT_FEATURES_REPLY that, among other information,
 891    includes a mapping between OpenFlow port names and numbers.  From a
 892    command prompt, "ovs-ofctl show br0" makes such a request and
 893    prints the response for switch br0.
 894
 895    The Interface table in the Open vSwitch database also maps OpenFlow
 896    port names to numbers.  To print the OpenFlow port number
 897    associated with interface eth0, run:
 898
 899        ovs-vsctl get Interface eth0 ofport
 900
 901    You can print the entire mapping with:
 902
 903        ovs-vsctl -- --columns=name,ofport list Interface
 904
 905    but the output mixes together interfaces from all bridges in the
 906    database, so it may be confusing if more than one bridge exists.
 907
 908    In the Open vSwitch database, ofport value -1 means that the
 909    interface could not be created due to an error.  (The Open vSwitch
 910    log should indicate the reason.)  ofport value [] (the empty set)
 911    means that the interface hasn't been created yet.  The latter is
 912    normally an intermittent condition (unless ovs-vswitchd is not
 913    running).
 914
 915 Q: I added some flows with my controller or with ovs-ofctl, but when I
 916    run "ovs-dpctl dump-flows" I don't see them.
 917
 918 A: ovs-dpctl queries a kernel datapath, not an OpenFlow switch.  It
 919    won't display the information that you want.  You want to use
 920    "ovs-ofctl dump-flows" instead.
 921
 922 Q: It looks like each of the interfaces in my bonded port shows up
 923    as an individual OpenFlow port.  Is that right?
 924
 925 A: Yes, Open vSwitch makes individual bond interfaces visible as
 926    OpenFlow ports, rather than the bond as a whole.  The interfaces
 927    are treated together as a bond for only a few purposes:
 928
 929        - Sending a packet to the OFPP_NORMAL port.  (When an OpenFlow
 930          controller is not configured, this happens implicitly to
 931          every packet.)
 932
 933        - The "autopath" Nicira extension action.  However, "autopath"
 934          is deprecated and scheduled for removal in February 2013.
 935
 936        - Mirrors configured for output to a bonded port.
 937
 938    It would make a lot of sense for Open vSwitch to present a bond as
 939    a single OpenFlow port.  If you want to contribute an
 940    implementation of such a feature, please bring it up on the Open
 941    vSwitch development mailing list at dev@openvswitch.org.
 942
 943 Contact
 944 -------
 945
 946 bugs@openvswitch.org
 947 http://openvswitch.org/