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 features are not available in the Open vSwitch kernel datapath
 132    that ships as part of the upstream Linux kernel?
 133
 134 A: The kernel module in upstream Linux 3.3 and later does not include
 135    the following features:
 136
 137        - Bridge compatibility, that is, support for the ovs-brcompatd
 138          daemon that (if you enable it) lets "brctl" and other Linux
 139          bridge tools transparently work with Open vSwitch instead.
 140
 141          We do not expect bridge compatibility to ever be available in
 142          upstream Linux.  If you need bridge compatibility, use the
 143          kernel module from the Open vSwitch distribution instead of the
 144          upstream Linux kernel module.
 145
 146        - Tunnel virtual ports, that is, interfaces with type "gre",
 147          "ipsec_gre", "capwap".  It is possible to create tunnels in
 148          Linux and attach them to Open vSwitch as system devices.
 149          However, they cannot be dynamically created through the OVSDB
 150          protocol or set the tunnel ids as a flow action.
 151
 152          Work is in progress in adding these features to the upstream
 153          Linux version of the Open vSwitch kernel module.  For now, if
 154          you need these features, use the kernel module from the Open
 155          vSwitch distribution instead of the upstream Linux kernel
 156          module.
 157
 158        - Patch virtual ports, that is, interfaces with type "patch".
 159          You can use Linux "veth" devices as a substitute.
 160
 161          We don't have any plans to add patch ports upstream.
 162
 163 Q: What features are not available when using the userspace datapath?
 164
 165 A: Tunnel and patch virtual ports are not supported, as described in the
 166    previous answer.  It is also not possible to use queue-related
 167    actions.  On Linux kernels before 2.6.39, maximum-sized VLAN packets
 168    may not be transmitted.
 169
 170
 171 Basic Configuration
 172 -------------------
 173
 174 Q: How do I configure a port as an access port?
 175
 176 A: Add "tag=VLAN" to your "ovs-vsctl add-port" command.  For example,
 177    the following commands configure br0 with eth0 as a trunk port (the
 178    default) and tap0 as an access port for VLAN 9:
 179
 180        ovs-vsctl add-br br0
 181        ovs-vsctl add-port br0 eth0
 182        ovs-vsctl add-port br0 tap0 tag=9
 183
 184    If you want to configure an already added port as an access port,
 185    use "ovs-vsctl set", e.g.:
 186
 187        ovs-vsctl set port tap0 tag=9
 188
 189 Q: How do I configure a port as a SPAN port, that is, enable mirroring
 190    of all traffic to that port?
 191
 192 A: The following commands configure br0 with eth0 and tap0 as trunk
 193    ports.  All traffic coming in or going out on eth0 or tap0 is also
 194    mirrored to tap1; any traffic arriving on tap1 is dropped:
 195
 196        ovs-vsctl add-br br0
 197        ovs-vsctl add-port br0 eth0
 198        ovs-vsctl add-port br0 tap0
 199        ovs-vsctl add-port br0 tap1 \
 200            -- --id=@p get port tap1 \
 201            -- --id=@m create mirror name=m0 select-all=true output-port=@p \
 202            -- set bridge br0 mirrors=@m
 203
 204    To later disable mirroring, run:
 205
 206        ovs-vsctl clear bridge br0 mirrors
 207
 208 Q: How do I configure a VLAN as an RSPAN VLAN, that is, enable
 209    mirroring of all traffic to that VLAN?
 210
 211 A: The following commands configure br0 with eth0 as a trunk port and
 212    tap0 as an access port for VLAN 10.  All traffic coming in or going
 213    out on tap0, as well as traffic coming in or going out on eth0 in
 214    VLAN 10, is also mirrored to VLAN 15 on eth0.  The original tag for
 215    VLAN 10, in cases where one is present, is dropped as part of
 216    mirroring:
 217
 218        ovs-vsctl add-br br0
 219        ovs-vsctl add-port br0 eth0
 220        ovs-vsctl add-port br0 tap0 tag=10
 221        ovs-vsctl \
 222            -- --id=@m create mirror name=m0 select-all=true select-vlan=10 \
 223                                     output-vlan=15 \
 224            -- set bridge br0 mirrors=@m
 225
 226    To later disable mirroring, run:
 227
 228        ovs-vsctl clear bridge br0 mirrors
 229
 230    Mirroring to a VLAN can disrupt a network that contains unmanaged
 231    switches.  See ovs-vswitchd.conf.db(5) for details.  Mirroring to a
 232    GRE tunnel has fewer caveats than mirroring to a VLAN and should
 233    generally be preferred.
 234
 235 Q: Can I mirror more than one input VLAN to an RSPAN VLAN?
 236
 237 A: Yes, but mirroring to a VLAN strips the original VLAN tag in favor
 238    of the specified output-vlan.  This loss of information may make
 239    the mirrored traffic too hard to interpret.
 240
 241    To mirror multiple VLANs, use the commands above, but specify a
 242    comma-separated list of VLANs as the value for select-vlan.  To
 243    mirror every VLAN, use the commands above, but omit select-vlan and
 244    its value entirely.
 245
 246    When a packet arrives on a VLAN that is used as a mirror output
 247    VLAN, the mirror is disregarded.  Instead, in standalone mode, OVS
 248    floods the packet across all the ports for which the mirror output
 249    VLAN is configured.  (If an OpenFlow controller is in use, then it
 250    can override this behavior through the flow table.)  If OVS is used
 251    as an intermediate switch, rather than an edge switch, this ensures
 252    that the RSPAN traffic is distributed through the network.
 253
 254    Mirroring to a VLAN can disrupt a network that contains unmanaged
 255    switches.  See ovs-vswitchd.conf.db(5) for details.  Mirroring to a
 256    GRE tunnel has fewer caveats than mirroring to a VLAN and should
 257    generally be preferred.
 258
 259 Q: How do I configure mirroring of all traffic to a GRE tunnel?
 260
 261 A: The following commands configure br0 with eth0 and tap0 as trunk
 262    ports.  All traffic coming in or going out on eth0 or tap0 is also
 263    mirrored to gre0, a GRE tunnel to the remote host 192.168.1.10; any
 264    traffic arriving on gre0 is dropped:
 265
 266        ovs-vsctl add-br br0
 267        ovs-vsctl add-port br0 eth0
 268        ovs-vsctl add-port br0 tap0
 269        ovs-vsctl add-port br0 gre0 \
 270            -- set interface gre0 type=gre options:remote_ip=192.168.1.10 \
 271            -- --id=@p get port gre0 \
 272            -- --id=@m create mirror name=m0 select-all=true output-port=@p \
 273            -- set bridge br0 mirrors=@m
 274
 275    To later disable mirroring and destroy the GRE tunnel:
 276
 277        ovs-vsctl clear bridge br0 mirrors
 278        ovs-vcstl del-port br0 gre0
 279
 280 Q: Does Open vSwitch support ERSPAN?
 281
 282 A: No.  ERSPAN is an undocumented proprietary protocol.  As an
 283    alternative, Open vSwitch supports mirroring to a GRE tunnel (see
 284    above).
 285
 286
 287 Configuration Problems
 288 ----------------------
 289
 290 Q: I created a bridge and added my Ethernet port to it, using commands
 291    like these:
 292
 293        ovs-vsctl add-br br0
 294        ovs-vsctl add-port br0 eth0
 295
 296    and as soon as I ran the "add-port" command I lost all connectivity
 297    through eth0.  Help!
 298
 299 A: A physical Ethernet device that is part of an Open vSwitch bridge
 300    should not have an IP address.  If one does, then that IP address
 301    will not be fully functional.
 302
 303    You can restore functionality by moving the IP address to an Open
 304    vSwitch "internal" device, such as the network device named after
 305    the bridge itself.  For example, assuming that eth0's IP address is
 306    192.168.128.5, you could run the commands below to fix up the
 307    situation:
 308
 309        ifconfig eth0 0.0.0.0
 310        ifconfig br0 192.168.128.5
 311
 312    (If your only connection to the machine running OVS is through the
 313    IP address in question, then you would want to run all of these
 314    commands on a single command line, or put them into a script.)  If
 315    there were any additional routes assigned to eth0, then you would
 316    also want to use commands to adjust these routes to go through br0.
 317
 318    If you use DHCP to obtain an IP address, then you should kill the
 319    DHCP client that was listening on the physical Ethernet interface
 320    (e.g. eth0) and start one listening on the internal interface
 321    (e.g. br0).  You might still need to manually clear the IP address
 322    from the physical interface (e.g. with "ifconfig eth0 0.0.0.0").
 323
 324    There is no compelling reason why Open vSwitch must work this way.
 325    However, this is the way that the Linux kernel bridge module has
 326    always worked, so it's a model that those accustomed to Linux
 327    bridging are already used to.  Also, the model that most people
 328    expect is not implementable without kernel changes on all the
 329    versions of Linux that Open vSwitch supports.
 330
 331    By the way, this issue is not specific to physical Ethernet
 332    devices.  It applies to all network devices except Open vswitch
 333    "internal" devices.
 334
 335 Q: I created a bridge and added a couple of Ethernet ports to it,
 336    using commands like these:
 337
 338        ovs-vsctl add-br br0
 339        ovs-vsctl add-port br0 eth0
 340        ovs-vsctl add-port br0 eth1
 341
 342    and now my network seems to have melted: connectivity is unreliable
 343    (even connectivity that doesn't go through Open vSwitch), all the
 344    LEDs on my physical switches are blinking, wireshark shows
 345    duplicated packets, and CPU usage is very high.
 346
 347 A: More than likely, you've looped your network.  Probably, eth0 and
 348    eth1 are connected to the same physical Ethernet switch.  This
 349    yields a scenario where OVS receives a broadcast packet on eth0 and
 350    sends it out on eth1, then the physical switch connected to eth1
 351    sends the packet back on eth0, and so on forever.  More complicated
 352    scenarios, involving a loop through multiple switches, are possible
 353    too.
 354
 355    The solution depends on what you are trying to do:
 356
 357        - If you added eth0 and eth1 to get higher bandwidth or higher
 358          reliability between OVS and your physical Ethernet switch,
 359          use a bond.  The following commands create br0 and then add
 360          eth0 and eth1 as a bond:
 361
 362              ovs-vsctl add-br br0
 363              ovs-vsctl add-bond br0 bond0 eth0 eth1
 364
 365          Bonds have tons of configuration options.  Please read the
 366          documentation on the Port table in ovs-vswitchd.conf.db(5)
 367          for all the details.
 368
 369        - Perhaps you don't actually need eth0 and eth1 to be on the
 370          same bridge.  For example, if you simply want to be able to
 371          connect each of them to virtual machines, then you can put
 372          each of them on a bridge of its own:
 373
 374              ovs-vsctl add-br br0
 375              ovs-vsctl add-port br0 eth0
 376
 377              ovs-vsctl add-br br1
 378              ovs-vsctl add-port br1 eth1
 379
 380          and then connect VMs to br0 and br1.  (A potential
 381          disadvantage is that traffic cannot directly pass between br0
 382          and br1.  Instead, it will go out eth0 and come back in eth1,
 383          or vice versa.)
 384
 385        - If you have a redundant or complex network topology and you
 386          want to prevent loops, turn on spanning tree protocol (STP).
 387          The following commands create br0, enable STP, and add eth0
 388          and eth1 to the bridge.  The order is important because you
 389          don't want have to have a loop in your network even
 390          transiently:
 391
 392              ovs-vsctl add-br br0
 393              ovs-vsctl set bridge br0 stp_enable=true
 394              ovs-vsctl add-port br0 eth0
 395              ovs-vsctl add-port br0 eth1
 396
 397          The Open vSwitch implementation of STP is not well tested.
 398          Please report any bugs you observe, but if you'd rather avoid
 399          acting as a beta tester then another option might be your
 400          best shot.
 401
 402 Q: I can't seem to use Open vSwitch in a wireless network.
 403
 404 A: Wireless base stations generally only allow packets with the source
 405    MAC address of NIC that completed the initial handshake.
 406    Therefore, without MAC rewriting, only a single device can
 407    communicate over a single wireless link.
 408
 409    This isn't specific to Open vSwitch, it's enforced by the access
 410    point, so the same problems will show up with the Linux bridge or
 411    any other way to do bridging.
 412
 413 Q: Is there any documentation on the database tables and fields?
 414
 415 A: Yes.  ovs-vswitchd.conf.db(5) is a comprehensive reference.
 416
 417 Q: When I run ovs-dpctl I no longer see the bridges I created.  Instead,
 418    I only see a datapath called "ovs-system".  How can I see datapath
 419    information about a particular bridge?
 420
 421 A: In version 1.9.0, OVS switched to using a single datapath that is
 422    shared by all bridges of that type.  The "ovs-appctl dpif/*"
 423    commands provide similar functionality that is scoped by the bridge.
 424
 425
 426 VLANs
 427 -----
 428
 429 Q: What's a VLAN?
 430
 431 A: At the simplest level, a VLAN (short for "virtual LAN") is a way to
 432    partition a single switch into multiple switches.  Suppose, for
 433    example, that you have two groups of machines, group A and group B.
 434    You want the machines in group A to be able to talk to each other,
 435    and you want the machine in group B to be able to talk to each
 436    other, but you don't want the machines in group A to be able to
 437    talk to the machines in group B.  You can do this with two
 438    switches, by plugging the machines in group A into one switch and
 439    the machines in group B into the other switch.
 440
 441    If you only have one switch, then you can use VLANs to do the same
 442    thing, by configuring the ports for machines in group A as VLAN
 443    "access ports" for one VLAN and the ports for group B as "access
 444    ports" for a different VLAN.  The switch will only forward packets
 445    between ports that are assigned to the same VLAN, so this
 446    effectively subdivides your single switch into two independent
 447    switches, one for each group of machines.
 448
 449    So far we haven't said anything about VLAN headers.  With access
 450    ports, like we've described so far, no VLAN header is present in
 451    the Ethernet frame.  This means that the machines (or switches)
 452    connected to access ports need not be aware that VLANs are
 453    involved, just like in the case where we use two different physical
 454    switches.
 455
 456    Now suppose that you have a whole bunch of switches in your
 457    network, instead of just one, and that some machines in group A are
 458    connected directly to both switches 1 and 2.  To allow these
 459    machines to talk to each other, you could add an access port for
 460    group A's VLAN to switch 1 and another to switch 2, and then
 461    connect an Ethernet cable between those ports.  That works fine,
 462    but it doesn't scale well as the number of switches and the number
 463    of VLANs increases, because you use up a lot of valuable switch
 464    ports just connecting together your VLANs.
 465
 466    This is where VLAN headers come in.  Instead of using one cable and
 467    two ports per VLAN to connect a pair of switches, we configure a
 468    port on each switch as a VLAN "trunk port".  Packets sent and
 469    received on a trunk port carry a VLAN header that says what VLAN
 470    the packet belongs to, so that only two ports total are required to
 471    connect the switches, regardless of the number of VLANs in use.
 472    Normally, only switches (either physical or virtual) are connected
 473    to a trunk port, not individual hosts, because individual hosts
 474    don't expect to see a VLAN header in the traffic that they receive.
 475
 476    None of the above discussion says anything about particular VLAN
 477    numbers.  This is because VLAN numbers are completely arbitrary.
 478    One must only ensure that a given VLAN is numbered consistently
 479    throughout a network and that different VLANs are given different
 480    numbers.  (That said, VLAN 0 is usually synonymous with a packet
 481    that has no VLAN header, and VLAN 4095 is reserved.)
 482
 483 Q: VLANs don't work.
 484
 485 A: Many drivers in Linux kernels before version 3.3 had VLAN-related
 486    bugs.  If you are having problems with VLANs that you suspect to be
 487    driver related, then you have several options:
 488
 489        - Upgrade to Linux 3.3 or later.
 490
 491        - Build and install a fixed version of the particular driver
 492          that is causing trouble, if one is available.
 493
 494        - Use a NIC whose driver does not have VLAN problems.
 495
 496        - Use "VLAN splinters", a feature in Open vSwitch 1.4 and later
 497          that works around bugs in kernel drivers.  To enable VLAN
 498          splinters on interface eth0, use the command:
 499
 500            ovs-vsctl set interface eth0 other-config:enable-vlan-splinters=true
 501
 502          For VLAN splinters to be effective, Open vSwitch must know
 503          which VLANs are in use.  See the "VLAN splinters" section in
 504          the Interface table in ovs-vswitchd.conf.db(5) for details on
 505          how Open vSwitch infers in-use VLANs.
 506
 507          VLAN splinters increase memory use and reduce performance, so
 508          use them only if needed.
 509
 510        - Apply the "vlan workaround" patch from the XenServer kernel
 511          patch queue, build Open vSwitch against this patched kernel,
 512          and then use ovs-vlan-bug-workaround(8) to enable the VLAN
 513          workaround for each interface whose driver is buggy.
 514
 515          (This is a nontrivial exercise, so this option is included
 516          only for completeness.)
 517
 518    It is not always easy to tell whether a Linux kernel driver has
 519    buggy VLAN support.  The ovs-vlan-test(8) and ovs-test(8) utilities
 520    can help you test.  See their manpages for details.  Of the two
 521    utilities, ovs-test(8) is newer and more thorough, but
 522    ovs-vlan-test(8) may be easier to use.
 523
 524 Q: VLANs still don't work.  I've tested the driver so I know that it's OK.
 525
 526 A: Do you have VLANs enabled on the physical switch that OVS is
 527    attached to?  Make sure that the port is configured to trunk the
 528    VLAN or VLANs that you are using with OVS.
 529
 530 Q: Outgoing VLAN-tagged traffic goes through OVS to my physical switch
 531    and to its destination host, but OVS seems to drop incoming return
 532    traffic.
 533
 534 A: It's possible that you have the VLAN configured on your physical
 535    switch as the "native" VLAN.  In this mode, the switch treats
 536    incoming packets either tagged with the native VLAN or untagged as
 537    part of the native VLAN.  It may also send outgoing packets in the
 538    native VLAN without a VLAN tag.
 539
 540    If this is the case, you have two choices:
 541
 542        - Change the physical switch port configuration to tag packets
 543          it forwards to OVS with the native VLAN instead of forwarding
 544          them untagged.
 545
 546        - Change the OVS configuration for the physical port to a
 547          native VLAN mode.  For example, the following sets up a
 548          bridge with port eth0 in "native-tagged" mode in VLAN 9:
 549
 550              ovs-vsctl add-br br0
 551              ovs-vsctl add-port br0 eth0 tag=9 vlan_mode=native-tagged
 552
 553          In this situation, "native-untagged" mode will probably work
 554          equally well.  Refer to the documentation for the Port table
 555          in ovs-vswitchd.conf.db(5) for more information.
 556
 557 Q: Can I configure an IP address on a VLAN?
 558
 559 A: Yes.  Use an "internal port" configured as an access port.  For
 560    example, the following configures IP address 192.168.0.7 on VLAN 9.
 561    That is, OVS will forward packets from eth0 to 192.168.0.7 only if
 562    they have an 802.1Q header with VLAN 9.  Conversely, traffic
 563    forwarded from 192.168.0.7 to eth0 will be tagged with an 802.1Q
 564    header with VLAN 9:
 565
 566        ovs-vsctl add-br br0
 567        ovs-vsctl add-port br0 eth0
 568        ovs-vsctl add-port br0 vlan9 tag=9 -- set interface vlan9 type=internal
 569        ifconfig vlan9 192.168.0.7
 570
 571 Q: My OpenFlow controller doesn't see the VLANs that I expect.
 572
 573 A: The configuration for VLANs in the Open vSwitch database (e.g. via
 574    ovs-vsctl) only affects traffic that goes through Open vSwitch's
 575    implementation of the OpenFlow "normal switching" action.  By
 576    default, when Open vSwitch isn't connected to a controller and
 577    nothing has been manually configured in the flow table, all traffic
 578    goes through the "normal switching" action.  But, if you set up
 579    OpenFlow flows on your own, through a controller or using ovs-ofctl
 580    or through other means, then you have to implement VLAN handling
 581    yourself.
 582
 583    You can use "normal switching" as a component of your OpenFlow
 584    actions, e.g. by putting "normal" into the lists of actions on
 585    ovs-ofctl or by outputting to OFPP_NORMAL from an OpenFlow
 586    controller.  This will only be suitable for some situations,
 587    though.
 588
 589 Q: I configured ports on a bridge as access ports with different VLAN
 590    tags, like this:
 591
 592        ovs-vsctl add-br br0
 593        ovs-vsctl set-controller br0 tcp:192.168.0.10:6633
 594        ovs-vsctl add-port br0 eth0
 595        ovs-vsctl add-port br0 tap0 tag=9
 596        ovs-vsctl add-port br0 tap1 tag=10
 597
 598    but the VMs running behind tap0 and tap1 can still communicate,
 599    that is, they are not isolated from each other even though they are
 600    on different VLANs.
 601
 602 A: Do you have a controller configured on br0 (as the commands above
 603    do)?  If so, then this is a variant on the previous question, "My
 604    OpenFlow controller doesn't see the VLANs that I expect," and you
 605    can refer to the answer there for more information.
 606
 607
 608 Controllers
 609 -----------
 610
 611 Q: What versions of OpenFlow does Open vSwitch support?
 612
 613 A: Open vSwitch supports OpenFlow 1.0.  It also includes a number of
 614    extensions that bring many of the features from later versions of
 615    OpenFlow.  Work is underway to provide support for later versions and
 616    can be tracked here:
 617
 618        http://openvswitch.org/development/openflow-1-x-plan/
 619
 620 Q: I'm getting "error type 45250 code 0".  What's that?
 621
 622 A: This is a Open vSwitch extension to OpenFlow error codes.  Open
 623    vSwitch uses this extension when it must report an error to an
 624    OpenFlow controller but no standard OpenFlow error code is
 625    suitable.
 626
 627    Open vSwitch logs the errors that it sends to controllers, so the
 628    easiest thing to do is probably to look at the ovs-vswitchd log to
 629    find out what the error was.
 630
 631    If you want to dissect the extended error message yourself, the
 632    format is documented in include/openflow/nicira-ext.h in the Open
 633    vSwitch source distribution.  The extended error codes are
 634    documented in lib/ofp-errors.h.
 635
 636 Q1: Some of the traffic that I'd expect my OpenFlow controller to see
 637     doesn't actually appear through the OpenFlow connection, even
 638     though I know that it's going through.
 639 Q2: Some of the OpenFlow flows that my controller sets up don't seem
 640     to apply to certain traffic, especially traffic between OVS and
 641     the controller itself.
 642
 643 A: By default, Open vSwitch assumes that OpenFlow controllers are
 644    connected "in-band", that is, that the controllers are actually
 645    part of the network that is being controlled.  In in-band mode,
 646    Open vSwitch sets up special "hidden" flows to make sure that
 647    traffic can make it back and forth between OVS and the controllers.
 648    These hidden flows are higher priority than any flows that can be
 649    set up through OpenFlow, and they are not visible through normal
 650    OpenFlow flow table dumps.
 651
 652    Usually, the hidden flows are desirable and helpful, but
 653    occasionally they can cause unexpected behavior.  You can view the
 654    full OpenFlow flow table, including hidden flows, on bridge br0
 655    with the command:
 656
 657        ovs-appctl bridge/dump-flows br0
 658
 659    to help you debug.  The hidden flows are those with priorities
 660    greater than 65535 (the maximum priority that can be set with
 661    OpenFlow).
 662
 663    The DESIGN file at the top level of the Open vSwitch source
 664    distribution describes the in-band model in detail.
 665
 666    If your controllers are not actually in-band (e.g. they are on
 667    localhost via 127.0.0.1, or on a separate network), then you should
 668    configure your controllers in "out-of-band" mode.  If you have one
 669    controller on bridge br0, then you can configure out-of-band mode
 670    on it with:
 671
 672        ovs-vsctl set controller br0 connection-mode=out-of-band
 673
 674 Q: I configured all my controllers for out-of-band control mode but
 675    "ovs-appctl bridge/dump-flows" still shows some hidden flows.
 676
 677 A: You probably have a remote manager configured (e.g. with "ovs-vsctl
 678    set-manager").  By default, Open vSwitch assumes that managers need
 679    in-band rules set up on every bridge.  You can disable these rules
 680    on bridge br0 with:
 681
 682        ovs-vsctl set bridge br0 other-config:disable-in-band=true
 683
 684    This actually disables in-band control entirely for the bridge, as
 685    if all the bridge's controllers were configured for out-of-band
 686    control.
 687
 688 Q: My OpenFlow controller doesn't see the VLANs that I expect.
 689
 690 A: See answer under "VLANs", above.
 691
 692 Q: I ran "ovs-ofctl add-flow br0 nw_dst=192.168.0.1,actions=drop"
 693    but I got a funny message like this:
 694
 695        ofp_util|INFO|normalization changed ofp_match, details:
 696        ofp_util|INFO| pre: nw_dst=192.168.0.1
 697        ofp_util|INFO|post:
 698
 699    and when I ran "ovs-ofctl dump-flows br0" I saw that my nw_dst
 700    match had disappeared, so that the flow ends up matching every
 701    packet.
 702
 703 A: The term "normalization" in the log message means that a flow
 704    cannot match on an L3 field without saying what L3 protocol is in
 705    use.  The "ovs-ofctl" command above didn't specify an L3 protocol,
 706    so the L3 field match was dropped.
 707
 708    In this case, the L3 protocol could be IP or ARP.  A correct
 709    command for each possibility is, respectively:
 710
 711        ovs-ofctl add-flow br0 ip,nw_dst=192.168.0.1,actions=drop
 712
 713    and
 714
 715        ovs-ofctl add-flow br0 arp,nw_dst=192.168.0.1,actions=drop
 716
 717    Similarly, a flow cannot match on an L4 field without saying what
 718    L4 protocol is in use.  For example, the flow match "tp_src=1234"
 719    is, by itself, meaningless and will be ignored.  Instead, to match
 720    TCP source port 1234, write "tcp,tp_src=1234", or to match UDP
 721    source port 1234, write "udp,tp_src=1234".
 722
 723 Q: How can I figure out the OpenFlow port number for a given port?
 724
 725 A: The OFPT_FEATURES_REQUEST message requests an OpenFlow switch to
 726    respond with an OFPT_FEATURES_REPLY that, among other information,
 727    includes a mapping between OpenFlow port names and numbers.  From a
 728    command prompt, "ovs-ofctl show br0" makes such a request and
 729    prints the response for switch br0.
 730
 731    The Interface table in the Open vSwitch database also maps OpenFlow
 732    port names to numbers.  To print the OpenFlow port number
 733    associated with interface eth0, run:
 734
 735        ovs-vsctl get Interface eth0 ofport
 736
 737    You can print the entire mapping with:
 738
 739        ovs-vsctl -- --columns=name,ofport list Interface
 740
 741    but the output mixes together interfaces from all bridges in the
 742    database, so it may be confusing if more than one bridge exists.
 743
 744    In the Open vSwitch database, ofport value -1 means that the
 745    interface could not be created due to an error.  (The Open vSwitch
 746    log should indicate the reason.)  ofport value [] (the empty set)
 747    means that the interface hasn't been created yet.  The latter is
 748    normally an intermittent condition (unless ovs-vswitchd is not
 749    running).
 750
 751 Q: I added some flows with my controller or with ovs-ofctl, but when I
 752    run "ovs-dpctl dump-flows" I don't see them.
 753
 754 A: ovs-dpctl queries a kernel datapath, not an OpenFlow switch.  It
 755    won't display the information that you want.  You want to use
 756    "ovs-ofctl dump-flows" instead.
 757
 758 Q: It looks like each of the interfaces in my bonded port shows up
 759    as an individual OpenFlow port.  Is that right?
 760
 761 A: Yes, Open vSwitch makes individual bond interfaces visible as
 762    OpenFlow ports, rather than the bond as a whole.  The interfaces
 763    are treated together as a bond for only a few purposes:
 764
 765        - Sending a packet to the OFPP_NORMAL port.  (When an OpenFlow
 766          controller is not configured, this happens implicitly to
 767          every packet.)
 768
 769        - The "autopath" Nicira extension action.  However, "autopath"
 770          is deprecated and scheduled for removal in February 2013.
 771
 772        - Mirrors configured for output to a bonded port.
 773
 774    It would make a lot of sense for Open vSwitch to present a bond as
 775    a single OpenFlow port.  If you want to contribute an
 776    implementation of such a feature, please bring it up on the Open
 777    vSwitch development mailing list at dev@openvswitch.org.
 778
 779 Contact
 780 -------
 781
 782 bugs@openvswitch.org
 783 http://openvswitch.org/