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