]>
Commit | Line | Data |
---|---|---|
ce887677 | 1 | <?xml version="1.0" encoding="utf-8"?> |
57ba0a77 | 2 | <database name="ovs-vswitchd.conf.db" title="Open vSwitch Configuration Database"> |
c5f341ab BP |
3 | <p> |
4 | A database with this schema holds the configuration for one Open | |
5 | vSwitch daemon. The top-level configuration for the daemon is the | |
6 | <ref table="Open_vSwitch"/> table, which must have exactly one | |
89365653 | 7 | record. Records in other tables are significant only when they |
c5f341ab BP |
8 | can be reached directly or indirectly from the <ref |
9 | table="Open_vSwitch"/> table. Records that are not reachable from | |
10 | the <ref table="Open_vSwitch"/> table are automatically deleted | |
11 | from the database, except for records in a few distinguished | |
3fd8d445 | 12 | ``root set'' tables. |
c5f341ab | 13 | </p> |
89365653 | 14 | |
3fd8d445 BP |
15 | <h2>Common Columns</h2> |
16 | ||
17 | <p> | |
18 | Most tables contain two special columns, named <code>other_config</code> | |
19 | and <code>external_ids</code>. These columns have the same form and | |
20 | purpose each place that they appear, so we describe them here to save space | |
21 | later. | |
22 | </p> | |
23 | ||
24 | <dl> | |
25 | <dt><code>other_config</code>: map of string-string pairs</dt> | |
26 | <dd> | |
27 | <p> | |
28 | Key-value pairs for configuring rarely used features. Supported keys, | |
29 | along with the forms taken by their values, are documented individually | |
30 | for each table. | |
31 | </p> | |
32 | <p> | |
33 | A few tables do not have <code>other_config</code> columns because no | |
34 | key-value pairs have yet been defined for them. | |
35 | </p> | |
36 | </dd> | |
37 | ||
38 | <dt><code>external_ids</code>: map of string-string pairs</dt> | |
39 | <dd> | |
40 | Key-value pairs for use by external frameworks that integrate with Open | |
41 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
42 | either use the Open vSwitch development mailing list to coordinate on | |
43 | common key-value definitions, or choose key names that are likely to be | |
44 | unique. In some cases, where key-value pairs have been defined that are | |
45 | likely to be widely useful, they are documented individually for each | |
46 | table. | |
47 | </dd> | |
48 | </dl> | |
49 | ||
89365653 | 50 | <table name="Open_vSwitch" title="Open vSwitch configuration."> |
c5f341ab BP |
51 | Configuration for an Open vSwitch daemon. There must be exactly |
52 | one record in the <ref table="Open_vSwitch"/> table. | |
89365653 BP |
53 | |
54 | <group title="Configuration"> | |
61a5264d JP |
55 | <column name="datapaths"> |
56 | Map of datapath types to datapaths. The | |
57 | <ref column="datapath_type"/> column of the <ref table="Bridge"/> | |
58 | table is used as a key for this map. The value points to a row in | |
59 | the <ref table="Datapath"/> table. | |
60 | </column> | |
61 | ||
89365653 BP |
62 | <column name="bridges"> |
63 | Set of bridges managed by the daemon. | |
64 | </column> | |
65 | ||
89365653 BP |
66 | <column name="ssl"> |
67 | SSL used globally by the daemon. | |
68 | </column> | |
f5e7ed5d | 69 | |
3fd8d445 BP |
70 | <column name="external_ids" key="system-id"> |
71 | A unique identifier for the Open vSwitch's physical host. | |
72 | The form of the identifier depends on the type of the host. | |
73 | On a Citrix XenServer, this will likely be the same as | |
74 | <ref column="external_ids" key="xs-system-uuid"/>. | |
3fe80505 BP |
75 | </column> |
76 | ||
3fd8d445 BP |
77 | <column name="external_ids" key="xs-system-uuid"> |
78 | The Citrix XenServer universally unique identifier for the physical | |
79 | host as displayed by <code>xe host-list</code>. | |
f5e7ed5d | 80 | </column> |
40358701 | 81 | |
9e6ec60a | 82 | <column name="external_ids" key="hostname"> |
207e85db BS |
83 | The hostname for the host running Open vSwitch. This is a fully |
84 | qualified domain name since version 2.6.2. | |
9e6ec60a RB |
85 | </column> |
86 | ||
34d4f74d RW |
87 | <column name="external_ids" key="rundir"> |
88 | In Open vSwitch 2.8 and later, the run directory of the running Open | |
89 | vSwitch daemon. This directory is used for runtime state such as | |
90 | control and management sockets. The value of <ref | |
91 | column="other_config" key="vhost-sock-dir"/> is relative to this | |
92 | directory. | |
93 | </column> | |
94 | ||
12eb035b AW |
95 | <column name="other_config" key="stats-update-interval" |
96 | type='{"type": "integer", "minInteger": 5000}'> | |
97 | <p> | |
98 | Interval for updating statistics to the database, in milliseconds. | |
99 | This option will affect the update of the <code>statistics</code> | |
100 | column in the following tables: <code>Port</code>, <code>Interface | |
101 | </code>, <code>Mirror</code>. | |
102 | </p> | |
103 | <p> | |
104 | Default value is 5000 ms. | |
105 | </p> | |
106 | <p> | |
107 | Getting statistics more frequently can be achieved via OpenFlow. | |
108 | </p> | |
109 | </column> | |
110 | ||
40358701 GS |
111 | <column name="other_config" key="flow-restore-wait" |
112 | type='{"type": "boolean"}'> | |
113 | <p> | |
114 | When <code>ovs-vswitchd</code> starts up, it has an empty flow table | |
115 | and therefore it handles all arriving packets in its default fashion | |
116 | according to its configuration, by dropping them or sending them to | |
117 | an OpenFlow controller or switching them as a standalone switch. | |
118 | This behavior is ordinarily desirable. However, if | |
119 | <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,'' | |
120 | then this leads to a relatively long period during which packets are | |
121 | mishandled. | |
122 | </p> | |
123 | <p> | |
124 | This option allows for improvement. When <code>ovs-vswitchd</code> | |
125 | starts with this value set as <code>true</code>, it will neither | |
126 | flush or expire previously set datapath flows nor will it send and | |
127 | receive any packets to or from the datapath. When this value is | |
128 | later set to <code>false</code>, <code>ovs-vswitchd</code> will | |
129 | start receiving packets from the datapath and re-setup the flows. | |
130 | </p> | |
df514c62 ZW |
131 | <p> |
132 | Additionally, <code>ovs-vswitchd</code> is prevented from connecting | |
133 | to controllers when this value is set to <code>true</code>. This | |
134 | prevents controllers from making changes to the flow table in the | |
135 | middle of flow restoration, which could result in undesirable | |
136 | intermediate states. Once this value has been set to | |
137 | <code>false</code> and the desired flow state has been | |
138 | restored, <code>ovs-vswitchd</code> will be able to reconnect to | |
139 | controllers and process any new flow table modifications. | |
140 | </p> | |
40358701 GS |
141 | <p> |
142 | Thus, with this option, the procedure for a hot-upgrade of | |
143 | <code>ovs-vswitchd</code> becomes roughly the following: | |
144 | </p> | |
145 | <ol> | |
146 | <li> | |
147 | Stop <code>ovs-vswitchd</code>. | |
148 | </li> | |
149 | <li> | |
150 | Set <ref column="other_config" key="flow-restore-wait"/> | |
151 | to <code>true</code>. | |
152 | </li> | |
153 | <li> | |
154 | Start <code>ovs-vswitchd</code>. | |
155 | </li> | |
156 | <li> | |
157 | Use <code>ovs-ofctl</code> (or some other program, such as an | |
158 | OpenFlow controller) to restore the OpenFlow flow table | |
159 | to the desired state. | |
160 | </li> | |
161 | <li> | |
162 | Set <ref column="other_config" key="flow-restore-wait"/> | |
163 | to <code>false</code> (or remove it entirely from the database). | |
164 | </li> | |
165 | </ol> | |
407b1473 GS |
166 | <p> |
167 | The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod'' | |
168 | functions use the above config option during hot upgrades. | |
169 | </p> | |
40358701 | 170 | </column> |
380f49c4 | 171 | |
e79a6c83 | 172 | <column name="other_config" key="flow-limit" |
380f49c4 EJ |
173 | type='{"type": "integer", "minInteger": 0}'> |
174 | <p> | |
e79a6c83 EJ |
175 | The maximum |
176 | number of flows allowed in the datapath flow table. Internally OVS | |
177 | will choose a flow limit which will likely be lower than this number, | |
38b366b1 JS |
178 | based on real time network conditions. Tweaking this value is |
179 | discouraged unless you know exactly what you're doing. | |
380f49c4 EJ |
180 | </p> |
181 | <p> | |
e79a6c83 | 182 | The default is 200000. |
380f49c4 EJ |
183 | </p> |
184 | </column> | |
7155fa52 | 185 | |
06745dc3 JS |
186 | <column name="other_config" key="max-idle" |
187 | type='{"type": "integer", "minInteger": 500}'> | |
188 | <p> | |
189 | The maximum time (in ms) that idle flows will remain cached in the | |
190 | datapath. Internally OVS will check the validity and activity for | |
191 | datapath flows regularly and may expire flows quicker than this | |
192 | number, based on real time network conditions. Tweaking this | |
193 | value is discouraged unless you know exactly what you're doing. | |
194 | </p> | |
195 | <p> | |
196 | The default is 10000. | |
197 | </p> | |
53611f7b PB |
198 | </column> |
199 | ||
b6bdc3cd VB |
200 | <column name="other_config" key="max-revalidator" |
201 | type='{"type": "integer", "minInteger": 100}'> | |
202 | <p> | |
203 | The maximum time (in ms) that revalidator threads will wait before | |
204 | executing flow revalidation. Note that this is maximum allowed value. | |
205 | Actual timeout used by OVS is minimum of max-idle and max-revalidator | |
206 | values. Tweaking this value is discouraged unless you know exactly | |
207 | what you're doing. | |
208 | </p> | |
209 | <p> | |
210 | The default is 500. | |
211 | </p> | |
212 | </column> | |
213 | ||
e31ecf58 VB |
214 | <column name="other_config" key="min-revalidate-pps" |
215 | type='{"type": "integer", "minInteger": 1}'> | |
216 | <p> | |
217 | Set minimum pps that flow must have in order to be revalidated when | |
218 | revalidation duration exceeds half of max-revalidator config variable. | |
219 | </p> | |
220 | <p> | |
221 | The default is 5. | |
222 | </p> | |
223 | </column> | |
224 | ||
53611f7b PB |
225 | <column name="other_config" key="hw-offload" |
226 | type='{"type": "boolean"}'> | |
227 | <p> | |
228 | Set this value to <code>true</code> to enable netdev flow offload. | |
229 | </p> | |
230 | <p> | |
231 | The default value is <code>false</code>. Changing this value requires | |
232 | restarting the daemon | |
233 | </p> | |
234 | <p> | |
235 | Currently Open vSwitch supports hardware offloading on | |
236 | Linux systems. On other systems, this value is ignored. | |
2a85b7cc JS |
237 | This functionality is considered 'experimental'. Depending |
238 | on which OpenFlow matches and actions are configured, | |
239 | which kernel version is used, and what hardware is | |
240 | available, Open vSwitch may not be able to offload | |
241 | functionality to hardware. | |
53611f7b | 242 | </p> |
d74ca226 IM |
243 | <p> |
244 | In order to dump HW offloaded flows use | |
245 | <code>ovs-appctl dpctl/dump-flows</code>, <code>ovs-dpctl</code> | |
246 | doesn't support this functionality. See ovs-vswitchd(8) for details. | |
247 | </p> | |
06745dc3 JS |
248 | </column> |
249 | ||
691d20cb | 250 | <column name="other_config" key="tc-policy" |
3988f56a IM |
251 | type='{"type": "string", |
252 | "enum": ["set", ["none", "skip_sw", "skip_hw"]]}'> | |
253 | <p> | |
254 | Specified the policy used with HW offloading. | |
255 | Options: | |
256 | <dl> | |
257 | <dt><code>none</code></dt> | |
258 | <dd>Add software rule and offload rule to HW.</dd> | |
259 | <dt><code>skip_sw</code></dt> | |
260 | <dd>Offload rule to HW only.</dd> | |
261 | <dt><code>skip_hw</code></dt> | |
262 | <dd>Add software rule without offloading rule to HW.</dd> | |
263 | </dl> | |
264 | </p> | |
265 | <p> | |
266 | This is only relevant if | |
267 | <ref column="other_config" key="hw-offload"/> is enabled. | |
691d20cb PB |
268 | </p> |
269 | <p> | |
270 | The default value is <code>none</code>. | |
271 | </p> | |
272 | </column> | |
273 | ||
bab69409 | 274 | <column name="other_config" key="dpdk-init" |
03ca6aa0 IM |
275 | type='{"type": "string", |
276 | "enum": ["set", ["false", "true", "try"]]}'> | |
6d947d50 KT |
277 | <p> |
278 | Set this value to <code>true</code> or <code>try</code> to enable | |
279 | runtime support for DPDK ports. The vswitch must have compile-time | |
280 | support for DPDK as well. | |
281 | </p> | |
bab69409 | 282 | <p> |
6d947d50 KT |
283 | A value of <code>true</code> will cause the ovs-vswitchd process to |
284 | abort if DPDK cannot be initialized. A value of <code>try</code> | |
285 | will allow the ovs-vswitchd process to continue running even if DPDK | |
286 | cannot be initialized. | |
bab69409 AC |
287 | </p> |
288 | <p> | |
289 | The default value is <code>false</code>. Changing this value requires | |
290 | restarting the daemon | |
291 | </p> | |
292 | <p> | |
293 | If this value is <code>false</code> at startup, any dpdk ports which | |
294 | are configured in the bridge will fail due to memory errors. | |
295 | </p> | |
296 | </column> | |
297 | ||
298 | <column name="other_config" key="dpdk-lcore-mask" | |
299 | type='{"type": "integer", "minInteger": 1}'> | |
300 | <p> | |
301 | Specifies the CPU cores where dpdk lcore threads should be spawned. | |
302 | The DPDK lcore threads are used for DPDK library tasks, such as | |
303 | library internal message processing, logging, etc. Value should be in | |
304 | the form of a hex string (so '0x123') similar to the 'taskset' mask | |
305 | input. | |
306 | </p> | |
307 | <p> | |
308 | The lowest order bit corresponds to the first CPU core. A set bit | |
309 | means the corresponding core is available and an lcore thread will be | |
310 | created and pinned to it. If the input does not cover all cores, | |
311 | those uncovered cores are considered not set. | |
312 | </p> | |
313 | <p> | |
314 | For performance reasons, it is best to set this to a single core on | |
315 | the system, rather than allow lcore threads to float. | |
316 | </p> | |
317 | <p> | |
318 | If not specified, the value will be determined by choosing the lowest | |
319 | CPU core from initial cpu affinity list. Otherwise, the value will be | |
320 | passed directly to the DPDK library. | |
321 | </p> | |
322 | </column> | |
323 | ||
f2eee189 AW |
324 | <column name="other_config" key="pmd-cpu-mask"> |
325 | <p> | |
326 | Specifies CPU mask for setting the cpu affinity of PMD (Poll | |
327 | Mode Driver) threads. Value should be in the form of hex string, | |
328 | similar to the dpdk EAL '-c COREMASK' option input or the 'taskset' | |
329 | mask input. | |
330 | </p> | |
331 | <p> | |
332 | The lowest order bit corresponds to the first CPU core. A set bit | |
ee8627fa AW |
333 | means the corresponding core is available and a pmd thread will be |
334 | created and pinned to it. If the input does not cover all cores, | |
335 | those uncovered cores are considered not set. | |
f2eee189 AW |
336 | </p> |
337 | <p> | |
338 | If not specified, one pmd thread will be created for each numa node | |
339 | and pinned to any available core on the numa node by default. | |
340 | </p> | |
341 | </column> | |
342 | ||
bab69409 AC |
343 | <column name="other_config" key="dpdk-alloc-mem" |
344 | type='{"type": "integer", "minInteger": 0}'> | |
345 | <p> | |
346 | Specifies the amount of memory to preallocate from the hugepage pool, | |
347 | regardless of socket. It is recommended that dpdk-socket-mem is used | |
348 | instead. | |
349 | </p> | |
bab69409 AC |
350 | </column> |
351 | ||
352 | <column name="other_config" key="dpdk-socket-mem" | |
353 | type='{"type": "string"}'> | |
354 | <p> | |
355 | Specifies the amount of memory to preallocate from the hugepage pool, | |
356 | on a per-socket basis. | |
357 | </p> | |
358 | <p> | |
359 | The specifier is a comma-separated string, in ascending order of CPU | |
cd6c5bc8 KT |
360 | socket. E.g. On a four socket system 1024,0,2048 would set socket 0 |
361 | to preallocate 1024MB, socket 1 to preallocate 0MB, socket 2 to | |
362 | preallocate 2048MB and socket 3 (no value given) to preallocate 0MB. | |
bab69409 AC |
363 | </p> |
364 | <p> | |
b838f879 | 365 | If dpdk-socket-mem and dpdk-alloc-mem are not specified, dpdk-socket-mem |
7189d54c MR |
366 | will be used and the default value is 1024 for each numa node. If |
367 | dpdk-socket-mem and dpdk-alloc-mem are specified at same time, | |
368 | dpdk-socket-mem will be used as default. Changing this value | |
369 | requires restarting the daemon. | |
bab69409 AC |
370 | </p> |
371 | </column> | |
372 | ||
8411b6cc IM |
373 | <column name="other_config" key="dpdk-socket-limit" |
374 | type='{"type": "string"}'> | |
375 | <p> | |
376 | Limits the maximum amount of memory that can be used from the | |
377 | hugepage pool, on a per-socket basis. | |
378 | </p> | |
379 | <p> | |
380 | The specifier is a comma-separated list of memory limits per socket. | |
381 | <code>0</code> will disable the limit for a particular socket. | |
382 | </p> | |
383 | <p> | |
384 | If not specified, OVS will configure limits equal to the amount of | |
385 | preallocated memory specified by <ref column="other_config" | |
386 | key="dpdk-socket-mem"/> or <code>--socket-mem</code> in | |
387 | <ref column="other_config" key="dpdk-extra"/>. If none of the above | |
388 | options specified or <code>--legacy-mem</code> provided in | |
389 | <ref column="other_config" key="dpdk-extra"/>, limits will not be | |
390 | applied. | |
391 | Changing this value requires restarting the daemon. | |
392 | </p> | |
393 | </column> | |
394 | ||
bab69409 AC |
395 | <column name="other_config" key="dpdk-hugepage-dir" |
396 | type='{"type": "string"}'> | |
397 | <p> | |
398 | Specifies the path to the hugetlbfs mount point. | |
399 | </p> | |
400 | <p> | |
401 | If not specified, this will be guessed by the DPDK library (default | |
402 | is /dev/hugepages). Changing this value requires restarting the | |
403 | daemon. | |
404 | </p> | |
405 | </column> | |
406 | ||
eac84432 AC |
407 | <column name="other_config" key="dpdk-extra" |
408 | type='{"type": "string"}'> | |
409 | <p> | |
410 | Specifies additional eal command line arguments for DPDK. | |
411 | </p> | |
412 | <p> | |
413 | The default is empty. Changing this value requires restarting the | |
414 | daemon | |
415 | </p> | |
416 | </column> | |
417 | ||
bab69409 AC |
418 | <column name="other_config" key="vhost-sock-dir" |
419 | type='{"type": "string"}'> | |
420 | <p> | |
34d4f74d RW |
421 | Specifies a relative path from <ref column="external_ids" |
422 | key="rundir"/> to the vhost-user unix domain socket files. If this | |
423 | value is unset, the sockets are put directly in <ref | |
424 | column="external_ids" key="rundir"/>. | |
bab69409 AC |
425 | </p> |
426 | <p> | |
34d4f74d | 427 | Changing this value requires restarting the daemon. |
bab69409 AC |
428 | </p> |
429 | </column> | |
430 | ||
a14d1cc8 MK |
431 | <column name="other_config" key="vhost-iommu-support" |
432 | type='{"type": "boolean"}'> | |
433 | <p> | |
434 | vHost IOMMU is a security feature, which restricts the vhost memory | |
435 | that a virtio device may access. vHost IOMMU support is disabled by | |
436 | default, due to a bug in QEMU implementations of the vhost REPLY_ACK | |
437 | protocol, (on which vHost IOMMU relies) prior to v2.9.1. Setting this | |
438 | value to <code>true</code> enables vHost IOMMU support for vHost User | |
439 | Client ports in OvS-DPDK, starting from DPDK v17.11. | |
440 | </p> | |
441 | <p> | |
442 | Changing this value requires restarting the daemon. | |
443 | </p> | |
444 | </column> | |
445 | ||
30e834dc LB |
446 | <column name="other_config" key="vhost-postcopy-support" |
447 | type='{"type": "boolean"}'> | |
448 | <p> | |
449 | vHost post-copy is a feature which allows switching live migration | |
450 | of VM attached to dpdkvhostuserclient port to post-copy mode if | |
451 | default pre-copy migration can not be converged or takes too long to | |
452 | converge. | |
453 | Setting this value to <code>true</code> enables vHost post-copy | |
454 | support for all dpdkvhostuserclient ports. Available starting from | |
455 | DPDK v18.11 and QEMU 2.12. | |
456 | </p> | |
457 | <p> | |
458 | Changing this value requires restarting the daemon. | |
459 | </p> | |
460 | </column> | |
461 | ||
43307ad0 IS |
462 | <column name="other_config" key="per-port-memory" |
463 | type='{"type": "boolean"}'> | |
464 | <p> | |
465 | By default OVS DPDK uses a shared memory model wherein devices | |
466 | that have the same MTU and socket values can share the same | |
467 | mempool. Setting this value to <code>true</code> changes this | |
468 | behaviour. Per port memory allow DPDK devices to use private | |
469 | memory per device. This can provide greater transparency as | |
470 | regards memory usage but potentially at the cost of greater memory | |
471 | requirements. | |
472 | </p> | |
473 | <p> | |
474 | Changing this value requires restarting the daemon if dpdk-init has | |
475 | already been set to true. | |
476 | </p> | |
477 | </column> | |
478 | ||
c71ea3c4 IM |
479 | <column name="other_config" key="tx-flush-interval" |
480 | type='{"type": "integer", | |
481 | "minInteger": 0, "maxInteger": 1000000}'> | |
482 | <p> | |
483 | Specifies the time in microseconds that a packet can wait in output | |
484 | batch for sending i.e. amount of time that packet can spend in an | |
485 | intermediate output queue before sending to netdev. | |
486 | This option can be used to configure balance between throughput | |
487 | and latency. Lower values decreases latency while higher values | |
488 | may be useful to achieve higher performance. | |
489 | </p> | |
490 | <p> | |
491 | Defaults to 0 i.e. instant packet sending (latency optimized). | |
492 | </p> | |
493 | </column> | |
494 | ||
79f36875 JS |
495 | <column name="other_config" key="pmd-perf-metrics" |
496 | type='{"type": "boolean"}'> | |
497 | <p> | |
498 | Enables recording of detailed PMD performance metrics for analysis | |
499 | and trouble-shooting. This can have a performance impact in the | |
500 | order of 1%. | |
501 | </p> | |
502 | <p> | |
503 | Defaults to false but can be changed at any time. | |
504 | </p> | |
505 | </column> | |
506 | ||
60d8ccae YW |
507 | <column name="other_config" key="smc-enable" |
508 | type='{"type": "boolean"}'> | |
509 | <p> | |
510 | Signature match cache or SMC is a cache between EMC and megaflow | |
511 | cache. It does not store the full key of the flow, so it is more | |
512 | memory efficient comparing to EMC cache. SMC is especially useful | |
513 | when flow count is larger than EMC capacity. | |
514 | </p> | |
515 | <p> | |
516 | Defaults to false but can be changed at any time. | |
517 | </p> | |
518 | </column> | |
519 | ||
e77c97b9 KT |
520 | <column name="other_config" key="pmd-rxq-assign" |
521 | type='{"type": "string", | |
522 | "enum": ["set", ["cycles", "roundrobin"]]}'> | |
523 | <p> | |
524 | Specifies how RX queues will be automatically assigned to CPU cores. | |
525 | Options: | |
526 | <dl> | |
527 | <dt><code>cycles</code></dt> | |
528 | <dd>Rxqs will be sorted by order of measured processing cycles | |
529 | before being assigned to CPU cores.</dd> | |
530 | <dt><code>roundrobin</code></dt> | |
531 | <dd>Rxqs will be round-robined across CPU cores.</dd> | |
532 | </dl> | |
533 | </p> | |
534 | <p> | |
535 | The default value is <code>cycles</code>. | |
536 | </p> | |
537 | <p> | |
538 | Changing this value will affect an automatic re-assignment of Rxqs to | |
539 | CPUs. Note: Rxqs mapped to CPU cores with | |
540 | <code>pmd-rxq-affinity</code> are unaffected. | |
541 | </p> | |
542 | </column> | |
543 | ||
448a4b2f AW |
544 | <column name="other_config" key="n-handler-threads" |
545 | type='{"type": "integer", "minInteger": 1}'> | |
546 | <p> | |
547 | Specifies the number of threads for software datapaths to use for | |
e79a6c83 EJ |
548 | handling new flows. The default the number of online CPU cores minus |
549 | the number of revalidators. | |
550 | </p> | |
551 | <p> | |
552 | This configuration is per datapath. If you have more than one | |
553 | software datapath (e.g. some <code>system</code> bridges and some | |
554 | <code>netdev</code> bridges), then the total number of threads is | |
555 | <code>n-handler-threads</code> times the number of software | |
556 | datapaths. | |
557 | </p> | |
558 | </column> | |
559 | ||
560 | <column name="other_config" key="n-revalidator-threads" | |
561 | type='{"type": "integer", "minInteger": 1}'> | |
562 | <p> | |
563 | Specifies the number of threads for software datapaths to use for | |
564 | revalidating flows in the datapath. Typically, there is a direct | |
565 | correlation between the number of revalidator threads, and the number | |
566 | of flows allowed in the datapath. The default is the number of cpu | |
567 | cores divided by four plus one. If <code>n-handler-threads</code> is | |
568 | set, the default changes to the number of cpu cores minus the number | |
569 | of handler threads. | |
448a4b2f AW |
570 | </p> |
571 | <p> | |
572 | This configuration is per datapath. If you have more than one | |
573 | software datapath (e.g. some <code>system</code> bridges and some | |
574 | <code>netdev</code> bridges), then the total number of threads is | |
575 | <code>n-handler-threads</code> times the number of software | |
576 | datapaths. | |
577 | </p> | |
578 | </column> | |
4c30b246 CL |
579 | |
580 | <column name="other_config" key="emc-insert-inv-prob" | |
581 | type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'> | |
582 | <p> | |
583 | Specifies the inverse probability (1/emc-insert-inv-prob) of a flow | |
584 | being inserted into the Exact Match Cache (EMC). On average one in | |
585 | every <code>emc-insert-inv-prob</code> packets that generate a unique | |
586 | flow will cause an insertion into the EMC. | |
587 | ||
588 | A value of 1 will result in an insertion for every flow (1/1 = 100%) | |
589 | whereas a value of zero will result in no insertions and essentially | |
590 | disable the EMC. | |
591 | </p> | |
592 | <p> | |
593 | Defaults to 100 ie. there is (1/100 =) 1% chance of EMC insertion. | |
594 | </p> | |
595 | </column> | |
f0fb825a EG |
596 | |
597 | <column name="other_config" key="vlan-limit" | |
598 | type='{"type": "integer", "minInteger": 0}'> | |
599 | <p> | |
600 | Limits the number of VLAN headers that can be matched to the | |
601 | specified number. Further VLAN headers will be treated as payload, | |
602 | e.g. a packet with more 802.1q headers will match Ethernet type | |
603 | 0x8100. | |
604 | </p> | |
c7e22c6e | 605 | |
f0fb825a | 606 | <p> |
c7e22c6e BP |
607 | Open vSwitch userspace currently supports at most 2 VLANs, and each |
608 | datapath has its own limit. If <code>vlan-limit</code> is nonzero, | |
609 | it acts as a further limit. | |
f0fb825a EG |
610 | </p> |
611 | ||
612 | <p> | |
613 | If this value is absent, the default is currently 1. This maintains | |
614 | backward compatibility with controllers that were designed for use | |
615 | with Open vSwitch versions earlier than 2.8, which only supported one | |
616 | VLAN. | |
617 | </p> | |
618 | </column> | |
7fdd2082 FL |
619 | <column name="other_config" key="bundle-idle-timeout" |
620 | type='{"type": "integer", "minInteger": 1}'> | |
621 | <p> | |
622 | The maximum time (in seconds) that idle bundles will wait | |
623 | to be expired since it was either opened, modified or closed. | |
624 | </p> | |
625 | <p> | |
626 | OpenFlow specification mandates the timeout to be at least one | |
627 | second. The default is 10 seconds. | |
628 | </p> | |
7b243c30 | 629 | </column> |
7fdd2082 | 630 | |
57924fc9 SB |
631 | <column name="other_config" key="offload-rebalance" |
632 | type='{"type": "boolean"}'> | |
633 | <p> | |
634 | Configures HW offload rebalancing, that allows to dynamically | |
635 | offload and un-offload flows while an offload-device is out of | |
636 | resources (OOR). This policy allows flows to be selected for | |
637 | offloading based on the packets-per-second (pps) rate of flows. | |
638 | </p> | |
639 | <p> | |
640 | Set this value to <code>true</code> to enable this option. | |
641 | </p> | |
642 | <p> | |
643 | The default value is <code>false</code>. Changing this value requires | |
644 | restarting the daemon. | |
645 | </p> | |
646 | <p> | |
647 | This is only relevant if HW offloading is enabled (hw-offload). | |
648 | When this policy is enabled, it also requires 'tc-policy' to | |
649 | be set to 'skip_sw'. | |
650 | </p> | |
651 | </column> | |
5bf84282 NK |
652 | <column name="other_config" key="pmd-auto-lb" |
653 | type='{"type": "boolean"}'> | |
654 | <p> | |
655 | Configures PMD Auto Load Balancing that allows automatic assignment of | |
656 | RX queues to PMDs if any of PMDs is overloaded (i.e. processing cycles | |
657 | > 95%). | |
658 | </p> | |
659 | <p> | |
660 | It uses current scheme of cycle based assignment of RX queues that | |
661 | are not statically pinned to PMDs. | |
662 | </p> | |
663 | <p> | |
664 | The default value is <code>false</code>. | |
665 | </p> | |
666 | <p> | |
667 | Set this value to <code>true</code> to enable this option. It is | |
668 | currently disabled by default and an experimental feature. | |
669 | </p> | |
670 | <p> | |
671 | This only comes in effect if cycle based assignment is enabled and | |
672 | there are more than one non-isolated PMDs present and at least one of | |
673 | it polls more than one queue. | |
674 | </p> | |
675 | </column> | |
676 | <column name="other_config" key="pmd-auto-lb-rebal-interval" | |
677 | type='{"type": "integer", | |
678 | "minInteger": 0, "maxInteger": 20000}'> | |
679 | <p> | |
680 | The minimum time (in minutes) 2 consecutive PMD Auto Load Balancing | |
681 | iterations. | |
682 | </p> | |
683 | <p> | |
684 | The defaul value is 1 min. If configured to 0 then it would be | |
685 | converted to default value i.e. 1 min | |
686 | </p> | |
687 | <p> | |
688 | This option can be configured to avoid frequent trigger of auto load | |
689 | balancing of PMDs. For e.g. set the value (in min) such that it occurs | |
690 | once in few hours or a day or a week. | |
691 | </p> | |
692 | </column> | |
89365653 | 693 | </group> |
89365653 BP |
694 | <group title="Status"> |
695 | <column name="next_cfg"> | |
696 | Sequence number for client to increment. When a client modifies | |
697 | any part of the database configuration and wishes to wait for | |
698 | Open vSwitch to finish applying the changes, it may increment | |
699 | this sequence number. | |
700 | </column> | |
701 | ||
702 | <column name="cur_cfg"> | |
703 | Sequence number that Open vSwitch sets to the current value of | |
2e57b537 | 704 | <ref column="next_cfg"/> after it finishes applying a set of |
89365653 BP |
705 | configuration changes. |
706 | </column> | |
c1c9c9c4 | 707 | |
3e52fa56 AC |
708 | <column name="dpdk_initialized"> |
709 | True if <ref column="other_config" key="dpdk-init"/> is set to | |
710 | true and the DPDK library is successfully initialized. | |
711 | </column> | |
712 | ||
3fd8d445 | 713 | <group title="Statistics"> |
018f1525 | 714 | <p> |
3fd8d445 BP |
715 | The <code>statistics</code> column contains key-value pairs that |
716 | report statistics about a system running an Open vSwitch. These are | |
717 | updated periodically (currently, every 5 seconds). Key-value pairs | |
718 | that cannot be determined or that do not apply to a platform are | |
719 | omitted. | |
ce887677 BP |
720 | </p> |
721 | ||
f9e5e5b3 BP |
722 | <column name="other_config" key="enable-statistics" |
723 | type='{"type": "boolean"}'> | |
3fd8d445 BP |
724 | Statistics are disabled by default to avoid overhead in the common |
725 | case when statistics gathering is not useful. Set this value to | |
726 | <code>true</code> to enable populating the <ref column="statistics"/> | |
727 | column or to <code>false</code> to explicitly disable it. | |
728 | </column> | |
3fe80505 | 729 | |
f9e5e5b3 BP |
730 | <column name="statistics" key="cpu" |
731 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
732 | <p> |
733 | Number of CPU processors, threads, or cores currently online and | |
734 | available to the operating system on which Open vSwitch is running, | |
735 | as an integer. This may be less than the number installed, if some | |
736 | are not online or if they are not available to the operating | |
737 | system. | |
738 | </p> | |
739 | <p> | |
740 | Open vSwitch userspace processes are not multithreaded, but the | |
741 | Linux kernel-based datapath is. | |
742 | </p> | |
743 | </column> | |
ce887677 | 744 | |
3fd8d445 BP |
745 | <column name="statistics" key="load_average"> |
746 | A comma-separated list of three floating-point numbers, | |
747 | representing the system load average over the last 1, 5, and 15 | |
748 | minutes, respectively. | |
749 | </column> | |
ce887677 | 750 | |
3fd8d445 BP |
751 | <column name="statistics" key="memory"> |
752 | <p> | |
753 | A comma-separated list of integers, each of which represents a | |
754 | quantity of memory in kilobytes that describes the operating | |
755 | system on which Open vSwitch is running. In respective order, | |
756 | these values are: | |
757 | </p> | |
ce887677 | 758 | |
3fd8d445 BP |
759 | <ol> |
760 | <li>Total amount of RAM allocated to the OS.</li> | |
761 | <li>RAM allocated to the OS that is in use.</li> | |
762 | <li>RAM that can be flushed out to disk or otherwise discarded | |
763 | if that space is needed for another purpose. This number is | |
764 | necessarily less than or equal to the previous value.</li> | |
765 | <li>Total disk space allocated for swap.</li> | |
766 | <li>Swap space currently in use.</li> | |
767 | </ol> | |
ce887677 | 768 | |
3fd8d445 BP |
769 | <p> |
770 | On Linux, all five values can be determined and are included. On | |
771 | other operating systems, only the first two values can be | |
772 | determined, so the list will only have two values. | |
773 | </p> | |
774 | </column> | |
ce887677 | 775 | |
3fd8d445 BP |
776 | <column name="statistics" key="process_NAME"> |
777 | <p> | |
778 | One such key-value pair, with <code>NAME</code> replaced by | |
779 | a process name, will exist for each running Open vSwitch | |
780 | daemon process, with <var>name</var> replaced by the | |
781 | daemon's name (e.g. <code>process_ovs-vswitchd</code>). The | |
782 | value is a comma-separated list of integers. The integers | |
783 | represent the following, with memory measured in kilobytes | |
784 | and durations in milliseconds: | |
785 | </p> | |
ce887677 | 786 | |
3fd8d445 BP |
787 | <ol> |
788 | <li>The process's virtual memory size.</li> | |
789 | <li>The process's resident set size.</li> | |
790 | <li>The amount of user and system CPU time consumed by the | |
791 | process.</li> | |
792 | <li>The number of times that the process has crashed and been | |
793 | automatically restarted by the monitor.</li> | |
794 | <li>The duration since the process was started.</li> | |
795 | <li>The duration for which the process has been running.</li> | |
796 | </ol> | |
ce887677 | 797 | |
3fd8d445 BP |
798 | <p> |
799 | The interpretation of some of these values depends on whether the | |
800 | process was started with the <option>--monitor</option>. If it | |
801 | was not, then the crash count will always be 0 and the two | |
802 | durations will always be the same. If <option>--monitor</option> | |
803 | was given, then the crash count may be positive; if it is, the | |
804 | latter duration is the amount of time since the most recent crash | |
805 | and restart. | |
806 | </p> | |
ce887677 | 807 | |
3fd8d445 BP |
808 | <p> |
809 | There will be one key-value pair for each file in Open vSwitch's | |
810 | ``run directory'' (usually <code>/var/run/openvswitch</code>) | |
811 | whose name ends in <code>.pid</code>, whose contents are a | |
812 | process ID, and which is locked by a running process. The | |
813 | <var>name</var> is taken from the pidfile's name. | |
814 | </p> | |
ce887677 | 815 | |
3fd8d445 BP |
816 | <p> |
817 | Currently Open vSwitch is only able to obtain all of the above | |
818 | detail on Linux systems. On other systems, the same key-value | |
819 | pairs will be present but the values will always be the empty | |
820 | string. | |
821 | </p> | |
822 | </column> | |
ce887677 | 823 | |
3fd8d445 BP |
824 | <column name="statistics" key="file_systems"> |
825 | <p> | |
826 | A space-separated list of information on local, writable file | |
827 | systems. Each item in the list describes one file system and | |
828 | consists in turn of a comma-separated list of the following: | |
829 | </p> | |
ce887677 | 830 | |
3fd8d445 BP |
831 | <ol> |
832 | <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>. | |
833 | Any spaces or commas in the mount point are replaced by | |
834 | underscores.</li> | |
835 | <li>Total size, in kilobytes, as an integer.</li> | |
836 | <li>Amount of storage in use, in kilobytes, as an integer.</li> | |
837 | </ol> | |
ce887677 | 838 | |
3fd8d445 BP |
839 | <p> |
840 | This key-value pair is omitted if there are no local, writable | |
841 | file systems or if Open vSwitch cannot obtain the needed | |
842 | information. | |
843 | </p> | |
844 | </column> | |
845 | </group> | |
89365653 | 846 | </group> |
94db5407 | 847 | |
538c6dfa BP |
848 | <group title="Version Reporting"> |
849 | <p> | |
6b4186af EJ |
850 | These columns report the types and versions of the hardware and |
851 | software running Open vSwitch. We recommend in general that software | |
852 | should test whether specific features are supported instead of relying | |
853 | on version number checks. These values are primarily intended for | |
854 | reporting to human administrators. | |
538c6dfa BP |
855 | </p> |
856 | ||
857 | <column name="ovs_version"> | |
d4da3acc | 858 | The Open vSwitch version number, e.g. <code>1.1.0</code>. |
538c6dfa BP |
859 | </column> |
860 | ||
8159b984 | 861 | <column name="db_version"> |
6b4186af | 862 | <p> |
51738fe1 BP |
863 | The database schema version number, e.g. <code>1.2.3</code>. See |
864 | ovsdb-tool(1) for an explanation of the numbering scheme. | |
8159b984 BP |
865 | </p> |
866 | ||
867 | <p> | |
868 | The schema version is part of the database schema, so it can also be | |
869 | retrieved by fetching the schema using the Open vSwitch database | |
870 | protocol. | |
871 | </p> | |
872 | </column> | |
873 | ||
538c6dfa BP |
874 | <column name="system_type"> |
875 | <p> | |
6b4186af EJ |
876 | An identifier for the type of system on top of which Open vSwitch |
877 | runs, e.g. <code>XenServer</code> or <code>KVM</code>. | |
878 | </p> | |
879 | <p> | |
880 | System integrators are responsible for choosing and setting an | |
881 | appropriate value for this column. | |
882 | </p> | |
538c6dfa BP |
883 | </column> |
884 | ||
885 | <column name="system_version"> | |
886 | <p> | |
6b4186af | 887 | The version of the system identified by <ref column="system_type"/>, |
404c1692 | 888 | e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265. |
6b4186af EJ |
889 | </p> |
890 | <p> | |
891 | System integrators are responsible for choosing and setting an | |
892 | appropriate value for this column. | |
893 | </p> | |
538c6dfa | 894 | </column> |
6b4186af | 895 | |
3e52fa56 AC |
896 | <column name="dpdk_version"> |
897 | <p> | |
898 | The version of the linked DPDK library. | |
899 | </p> | |
900 | </column> | |
901 | ||
538c6dfa BP |
902 | </group> |
903 | ||
842733c3 MG |
904 | <group title="Capabilities"> |
905 | <p> | |
906 | These columns report capabilities of the Open vSwitch instance. | |
907 | </p> | |
908 | <column name="datapath_types"> | |
909 | <p> | |
910 | This column reports the different dpifs registered with the system. | |
911 | These are the values that this instance supports in the <ref | |
912 | column="datapath_type" table="Bridge"/> column of the <ref | |
913 | table="Bridge"/> table. | |
914 | </p> | |
915 | </column> | |
916 | <column name="iface_types"> | |
917 | <p> | |
918 | This column reports the different netdevs registered with the system. | |
919 | These are the values that this instance supports in the <ref | |
920 | column="type" table="Interface"/> column of the <ref | |
921 | table="Interface"/> table. | |
922 | </p> | |
923 | </column> | |
924 | </group> | |
925 | ||
94db5407 BP |
926 | <group title="Database Configuration"> |
927 | <p> | |
928 | These columns primarily configure the Open vSwitch database | |
929 | (<code>ovsdb-server</code>), not the Open vSwitch switch | |
930 | (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref | |
931 | column="ssl"/> settings. | |
932 | </p> | |
933 | ||
934 | <p> | |
935 | The Open vSwitch switch does read the database configuration to | |
936 | determine remote IP addresses to which in-band control should apply. | |
937 | </p> | |
938 | ||
939 | <column name="manager_options"> | |
58db70c7 DB |
940 | <p> |
941 | Database clients to which the Open vSwitch database server should | |
942 | connect or to which it should listen, along with options for how | |
943 | these connections should be configured. See the <ref | |
944 | table="Manager"/> table for more information. | |
945 | </p> | |
946 | ||
947 | <p> | |
948 | For this column to serve its purpose, <code>ovsdb-server</code> must | |
949 | be configured to honor it. The easiest way to do this is to invoke | |
950 | <code>ovsdb-server</code> with the option | |
951 | <option>--remote=db:Open_vSwitch,Open_vSwitch,manager_options</option> | |
952 | The startup scripts that accompany Open vSwitch do this by default. | |
953 | </p> | |
94db5407 | 954 | </column> |
94db5407 | 955 | </group> |
3fd8d445 | 956 | |
7b243c30 QX |
957 | <group title="IPsec"> |
958 | <p> | |
959 | These settings control the global configuration of IPsec tunnels. The | |
960 | <code>options</code> column of the <code>Interface</code> table | |
961 | configures IPsec for individual tunnels. | |
962 | </p> | |
963 | <p> | |
964 | OVS IPsec supports the following three forms of authentication. | |
965 | Currently, all IPsec tunnels must use the same form: | |
966 | </p> | |
967 | <ol> | |
968 | <li> | |
969 | Pre-shared keys: Omit the global settings. On each tunnel, set <ref | |
970 | column="options" key="psk"/>. | |
971 | </li> | |
972 | <li> | |
973 | Self-signed certificates: Set the <code>private_key</code> and | |
974 | <code>certificate</code> global settings. On each tunnel, set <ref | |
975 | column="options" key="remote_cert"/>. The remote certificate can be | |
976 | self-signed. | |
977 | </li> | |
978 | <li> | |
979 | CA-signed certificates: Set all of the global settings. On each | |
980 | tunnel, set <ref column="options" key="remote_name"/> to the common | |
981 | name (CN) of the remote certificate. The remote certificate must be | |
982 | signed by the CA. | |
983 | </li> | |
984 | </ol> | |
985 | <column name="other_config" key="private_key" | |
986 | type='{"type": "string"}'> | |
987 | <p> | |
988 | Name of a PEM file containing the private key used as the switch's | |
989 | identity for IPsec tunnels. | |
990 | </p> | |
991 | </column> | |
992 | <column name="other_config" key="certificate" | |
993 | type='{"type": "string"}'> | |
994 | <p> | |
995 | Name of a PEM file containing a certificate that certifies the | |
996 | switch's private key, and identifies a trustworthy switch for IPsec | |
997 | tunnels. The certificate must be x.509 version 3 and with the | |
998 | string in common name (CN) also set in the subject alternative name | |
999 | (SAN). | |
1000 | </p> | |
1001 | </column> | |
1002 | <column name="other_config" key="ca_cert" | |
1003 | type='{"type": "string"}'> | |
1004 | <p> | |
1005 | Name of a PEM file containing the CA certificate used to verify | |
1006 | that a remote switch of the IPsec tunnel is trustworthy. | |
1007 | </p> | |
1008 | </column> | |
1009 | ||
1010 | <group title="Plaintext Tunnel Policy"> | |
1011 | <p> | |
1012 | When an IPsec tunnel is configured in this database, multiple | |
1013 | independent components take responsibility for implementing it. | |
1014 | <code>ovs-vswitchd</code> and its datapath handle packet forwarding | |
1015 | to the tunnel and a separate daemon pushes the tunnel's IPsec policy | |
1016 | configuration to the kernel or other entity that implements it. | |
1017 | There is a race: if the former configuration completes before the | |
1018 | latter, then packets sent by the local host over the tunnel can be | |
1019 | transmitted in plaintext. Using this setting, OVS users can avoid | |
1020 | this undesirable situation. | |
1021 | </p> | |
1022 | <column name="other_config" key="ipsec_skb_mark" | |
1023 | type='{"type": "string"}'> | |
1024 | <p> | |
1025 | This setting takes the form | |
1026 | <code><var>value</var>/<var>mask</var></code>. If it is specified, | |
1027 | then the <code>skb_mark</code> field in every outgoing tunneled | |
1028 | packet sent in plaintext is compared against it and, if it matches, | |
1029 | the packet is dropped. This is a global setting that is applied to | |
1030 | every tunneled packet, regardless of whether IPsec encryption is | |
1031 | enabled for the tunnel, the type of tunnel, or whether OVS is | |
1032 | involved. | |
1033 | </p> | |
1034 | ||
1035 | <p> | |
1036 | Example policies: | |
1037 | </p> | |
1038 | ||
1039 | <dl> | |
1040 | <dt><code>1/1</code></dt> | |
1041 | <dd> | |
1042 | Drop all unencrypted tunneled packets in which the | |
1043 | least-significant bit of <code>skb_mark</code> is 1. This would | |
1044 | be a useful policy given an OpenFlow flow table that sets | |
1045 | <code>skb_mark</code> to 1 for traffic that should be encrypted. | |
1046 | The default <code>skb_mark</code> is 0, so this would not affect | |
1047 | other traffic. | |
1048 | </dd> | |
1049 | ||
1050 | <dt><code>0/1</code></dt> | |
1051 | <dd> | |
1052 | Drop all unencrypted tunneled packets in which the | |
1053 | least-significant bit of <code>skb_mark</code> is 0. This would | |
1054 | be a useful policy if no unencrypted tunneled traffic should exit | |
1055 | the system without being specially whitelisted by setting | |
1056 | <code>skb_mark</code> to 1. | |
1057 | </dd> | |
1058 | ||
1059 | <dt>(empty)</dt> | |
1060 | <dd> | |
1061 | If this setting is empty or unset, then all unencrypted tunneled | |
1062 | packets are transmitted in the usual way. | |
1063 | </dd> | |
1064 | </dl> | |
1065 | </column> | |
1066 | </group> | |
1067 | </group> | |
1068 | ||
3fd8d445 BP |
1069 | <group title="Common Columns"> |
1070 | The overall purpose of these columns is described under <code>Common | |
1071 | Columns</code> at the beginning of this document. | |
1072 | ||
1073 | <column name="other_config"/> | |
1074 | <column name="external_ids"/> | |
1075 | </group> | |
89365653 BP |
1076 | </table> |
1077 | ||
1078 | <table name="Bridge"> | |
1079 | <p> | |
1080 | Configuration for a bridge within an | |
1081 | <ref table="Open_vSwitch"/>. | |
1082 | </p> | |
1083 | <p> | |
1084 | A <ref table="Bridge"/> record represents an Ethernet switch with one or | |
1085 | more ``ports,'' which are the <ref table="Port"/> records pointed to by | |
1086 | the <ref table="Bridge"/>'s <ref column="ports"/> column. | |
1087 | </p> | |
1088 | ||
1089 | <group title="Core Features"> | |
1090 | <column name="name"> | |
3cbe33df | 1091 | <p> |
c885f934 BP |
1092 | Bridge identifier. Must be unique among the names of ports, |
1093 | interfaces, and bridges on a host. | |
3cbe33df BP |
1094 | </p> |
1095 | ||
1096 | <p> | |
c885f934 BP |
1097 | The name must be alphanumeric and must not contain forward or |
1098 | backward slashes. The name of a bridge is also the name of an <ref | |
1099 | table="Interface"/> (and a <ref table="Port"/>) within the bridge, so | |
1100 | the restrictions on the <ref table="Interface" column="name"/> column | |
1101 | in the <ref table="Interface"/> table, particularly on length, also | |
1102 | apply to bridge names. Refer to the documentation for <ref | |
1103 | table="Interface"/> names for details. | |
3cbe33df | 1104 | </p> |
89365653 BP |
1105 | </column> |
1106 | ||
1107 | <column name="ports"> | |
1108 | Ports included in the bridge. | |
1109 | </column> | |
1110 | ||
1111 | <column name="mirrors"> | |
1112 | Port mirroring configuration. | |
1113 | </column> | |
1114 | ||
1115 | <column name="netflow"> | |
1116 | NetFlow configuration. | |
1117 | </column> | |
1118 | ||
1119 | <column name="sflow"> | |
29089a54 RL |
1120 | sFlow(R) configuration. |
1121 | </column> | |
1122 | ||
1123 | <column name="ipfix"> | |
1124 | IPFIX configuration. | |
89365653 BP |
1125 | </column> |
1126 | ||
1127 | <column name="flood_vlans"> | |
6c2d2a9f BP |
1128 | <p> |
1129 | VLAN IDs of VLANs on which MAC address learning should be disabled, | |
1130 | so that packets are flooded instead of being sent to specific ports | |
1131 | that are believed to contain packets' destination MACs. This should | |
1132 | ordinarily be used to disable MAC learning on VLANs used for | |
1133 | mirroring (RSPAN VLANs). It may also be useful for debugging. | |
1134 | </p> | |
1135 | <p> | |
1136 | SLB bonding (see the <ref table="Port" column="bond_mode"/> column in | |
1137 | the <ref table="Port"/> table) is incompatible with | |
1138 | <code>flood_vlans</code>. Consider using another bonding mode or | |
1139 | a different type of mirror instead. | |
1140 | </p> | |
89365653 | 1141 | </column> |
99eef98b DF |
1142 | |
1143 | <column name="auto_attach"> | |
039a8ccd | 1144 | Auto Attach configuration. |
99eef98b | 1145 | </column> |
89365653 BP |
1146 | </group> |
1147 | ||
1148 | <group title="OpenFlow Configuration"> | |
1149 | <column name="controller"> | |
88f69f88 BP |
1150 | <p> |
1151 | OpenFlow controller set. If unset, then no OpenFlow controllers | |
1152 | will be used. | |
1153 | </p> | |
1154 | ||
1155 | <p> | |
1156 | If there are primary controllers, removing all of them clears the | |
d3b84833 BP |
1157 | OpenFlow flow tables, group table, and meter table. If there are no |
1158 | primary controllers, adding one also clears these tables. Other | |
1159 | changes to the set of controllers, such as adding or removing a | |
1160 | service controller, adding another primary controller to supplement | |
1161 | an existing primary controller, or removing only one of two primary | |
1162 | controllers, have no effect on these tables. | |
88f69f88 | 1163 | </p> |
89365653 BP |
1164 | </column> |
1165 | ||
254750ce BP |
1166 | <column name="flow_tables"> |
1167 | Configuration for OpenFlow tables. Each pair maps from an OpenFlow | |
1168 | table ID to configuration for that table. | |
1169 | </column> | |
1170 | ||
31681a5d JP |
1171 | <column name="fail_mode"> |
1172 | <p>When a controller is configured, it is, ordinarily, responsible | |
3fd8d445 BP |
1173 | for setting up all flows on the switch. Thus, if the connection to |
1174 | the controller fails, no new network connections can be set up. | |
1175 | If the connection to the controller stays down long enough, | |
1176 | no packets can pass through the switch at all. This setting | |
1177 | determines the switch's response to such a situation. It may be set | |
1178 | to one of the following: | |
1179 | <dl> | |
1180 | <dt><code>standalone</code></dt> | |
1181 | <dd>If no message is received from the controller for three | |
1182 | times the inactivity probe interval | |
1183 | (see <ref column="inactivity_probe"/>), then Open vSwitch | |
1184 | will take over responsibility for setting up flows. In | |
1185 | this mode, Open vSwitch causes the bridge to act like an | |
1186 | ordinary MAC-learning switch. Open vSwitch will continue | |
1187 | to retry connecting to the controller in the background | |
1188 | and, when the connection succeeds, it will discontinue its | |
1189 | standalone behavior.</dd> | |
1190 | <dt><code>secure</code></dt> | |
1191 | <dd>Open vSwitch will not set up flows on its own when the | |
1192 | controller connection fails or when no controllers are | |
1193 | defined. The bridge will continue to retry connecting to | |
1194 | any defined controllers forever.</dd> | |
1195 | </dl> | |
31681a5d | 1196 | </p> |
aed2db18 BP |
1197 | <p> |
1198 | The default is <code>standalone</code> if the value is unset, but | |
1199 | future versions of Open vSwitch may change the default. | |
1200 | </p> | |
7dea6ace BP |
1201 | <p> |
1202 | The <code>standalone</code> mode can create forwarding loops on a | |
1203 | bridge that has more than one uplink port unless STP is enabled. To | |
1204 | avoid loops on such a bridge, configure <code>secure</code> mode or | |
1205 | enable STP (see <ref column="stp_enable"/>). | |
1206 | </p> | |
c66be90b BP |
1207 | <p> |
1208 | The <ref column="fail_mode"/> setting applies only to primary | |
1209 | controllers. When more than one primary controller is configured, | |
1210 | <ref column="fail_mode"/> is considered only when none of the | |
1211 | configured controllers can be contacted. | |
1212 | </p> | |
88f69f88 BP |
1213 | <p> |
1214 | Changing <ref column="fail_mode"/> when no primary controllers are | |
d3b84833 BP |
1215 | configured clears the OpenFlow flow tables, group table, and meter |
1216 | table. | |
88f69f88 | 1217 | </p> |
31681a5d JP |
1218 | </column> |
1219 | ||
89365653 | 1220 | <column name="datapath_id"> |
8de67146 BP |
1221 | Reports the OpenFlow datapath ID in use. Exactly 16 hex digits. |
1222 | (Setting this column has no useful effect. Set <ref | |
1223 | column="other-config" key="datapath-id"/> instead.) | |
89365653 | 1224 | </column> |
3fd8d445 | 1225 | |
b5cbbcf6 | 1226 | <column name="datapath_version"> |
61a5264d JP |
1227 | Reports the datapath version. This column is maintained for |
1228 | backwards compatibility. The preferred locatation is the | |
1229 | <ref column="datapath_id" table="Datapath"/> column of the | |
1230 | <ref table="Datapath"/> table. The full documentation for this | |
1231 | column is there. | |
b5cbbcf6 AZ |
1232 | </column> |
1233 | ||
3fd8d445 | 1234 | <column name="other_config" key="datapath-id"> |
62705b81 BP |
1235 | Overrides the default OpenFlow datapath ID, setting it to the specified |
1236 | value specified in hex. The value must either have a <code>0x</code> | |
1237 | prefix or be exactly 16 hex digits long. May not be all-zero. | |
3fd8d445 BP |
1238 | </column> |
1239 | ||
8b6ff729 | 1240 | <column name="other_config" key="dp-desc"> |
dbb51cd2 | 1241 | Human readable description of datapath. It is a maximum 256 |
8b6ff729 BP |
1242 | byte-long free-form string to describe the datapath for |
1243 | debugging purposes, e.g. <code>switch3 in room 3120</code>. | |
1244 | </column> | |
1245 | ||
f9e5e5b3 BP |
1246 | <column name="other_config" key="disable-in-band" |
1247 | type='{"type": "boolean"}'> | |
3fd8d445 BP |
1248 | If set to <code>true</code>, disable in-band control on the bridge |
1249 | regardless of controller and manager settings. | |
1250 | </column> | |
1251 | ||
f9e5e5b3 BP |
1252 | <column name="other_config" key="in-band-queue" |
1253 | type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'> | |
3fd8d445 BP |
1254 | A queue ID as a nonnegative integer. This sets the OpenFlow queue ID |
1255 | that will be used by flows set up by in-band control on this bridge. | |
1256 | If unset, or if the port used by an in-band control flow does not have | |
1257 | QoS configured, or if the port does not have a queue with the specified | |
1258 | ID, the default queue is used instead. | |
1259 | </column> | |
7beaa082 | 1260 | |
3dabc687 DC |
1261 | <column name="other_config" key="controller-queue-size" |
1262 | type='{"type": "integer", "minInteger": 1, "maxInteger": 512}'> | |
1263 | This sets the maximum size of the queue of packets that need to be | |
1264 | sent to the OpenFlow management controller. The value must be less | |
1265 | than 512. If not specified the queue size is limited to 100 packets | |
1266 | by default. Note: increasing the queue size might have a negative | |
1267 | impact on latency. | |
1268 | </column> | |
1269 | ||
7beaa082 | 1270 | <column name="protocols"> |
13c952ca BP |
1271 | List of OpenFlow protocols that may be used when negotiating a |
1272 | connection with a controller. OpenFlow 1.0, 1.1, 1.2, 1.3, 1.4, and | |
1273 | 1.5 are enabled by default if this column is empty. | |
7beaa082 | 1274 | </column> |
89365653 BP |
1275 | </group> |
1276 | ||
21f7563c | 1277 | <group title="Spanning Tree Configuration"> |
01f13d4f BP |
1278 | <p> |
1279 | The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol | |
1280 | that ensures loop-free topologies. It allows redundant links to | |
1281 | be included in the network to provide automatic backup paths if | |
1282 | the active links fails. | |
1283 | </p> | |
9cc6bf75 | 1284 | |
01f13d4f BP |
1285 | <p> |
1286 | These settings configure the slower-to-converge but still widely | |
1287 | supported version of Spanning Tree Protocol, sometimes known as | |
1288 | 802.1D-1998. Open vSwitch also supports the newer Rapid Spanning Tree | |
1289 | Protocol (RSTP), documented later in the section titled <code>Rapid | |
1290 | Spanning Tree Configuration</code>. | |
1291 | </p> | |
21f7563c | 1292 | |
01f13d4f BP |
1293 | <group title="STP Configuration"> |
1294 | <column name="stp_enable" type='{"type": "boolean"}'> | |
1295 | <p> | |
1296 | Enable spanning tree on the bridge. By default, STP is disabled | |
1297 | on bridges. Bond, internal, and mirror ports are not supported | |
1298 | and will not participate in the spanning tree. | |
1299 | </p> | |
21f7563c | 1300 | |
01f13d4f BP |
1301 | <p> |
1302 | STP and RSTP are mutually exclusive. If both are enabled, RSTP | |
1303 | will be used. | |
1304 | </p> | |
1305 | </column> | |
21f7563c | 1306 | |
01f13d4f BP |
1307 | <column name="other_config" key="stp-system-id"> |
1308 | The bridge's STP identifier (the lower 48 bits of the bridge-id) | |
1309 | in the form | |
1310 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>. | |
1311 | By default, the identifier is the MAC address of the bridge. | |
1312 | </column> | |
21f7563c | 1313 | |
01f13d4f BP |
1314 | <column name="other_config" key="stp-priority" |
1315 | type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'> | |
1316 | The bridge's relative priority value for determining the root | |
1317 | bridge (the upper 16 bits of the bridge-id). A bridge with the | |
1318 | lowest bridge-id is elected the root. By default, the priority | |
1319 | is 0x8000. | |
1320 | </column> | |
dc2b70ba | 1321 | |
01f13d4f BP |
1322 | <column name="other_config" key="stp-hello-time" |
1323 | type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'> | |
1324 | The interval between transmissions of hello messages by | |
1325 | designated ports, in seconds. By default the hello interval is | |
1326 | 2 seconds. | |
1327 | </column> | |
dc2b70ba | 1328 | |
01f13d4f BP |
1329 | <column name="other_config" key="stp-max-age" |
1330 | type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'> | |
1331 | The maximum age of the information transmitted by the bridge | |
1332 | when it is the root bridge, in seconds. By default, the maximum | |
1333 | age is 20 seconds. | |
1334 | </column> | |
1335 | ||
1336 | <column name="other_config" key="stp-forward-delay" | |
1337 | type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'> | |
1338 | The delay to wait between transitioning root and designated | |
1339 | ports to <code>forwarding</code>, in seconds. By default, the | |
1340 | forwarding delay is 15 seconds. | |
1341 | </column> | |
1342 | ||
1343 | <column name="other_config" key="mcast-snooping-aging-time" | |
1344 | type='{"type": "integer", "minInteger": 1}'> | |
1345 | <p> | |
1346 | The maximum number of seconds to retain a multicast snooping entry for | |
1347 | which no packets have been seen. The default is currently 300 | |
1348 | seconds (5 minutes). The value, if specified, is forced into a | |
1349 | reasonable range, currently 15 to 3600 seconds. | |
1350 | </p> | |
1351 | </column> | |
1352 | ||
1353 | <column name="other_config" key="mcast-snooping-table-size" | |
1354 | type='{"type": "integer", "minInteger": 1}'> | |
1355 | <p> | |
1356 | The maximum number of multicast snooping addresses to learn. The | |
1357 | default is currently 2048. The value, if specified, is forced into | |
1358 | a reasonable range, currently 10 to 1,000,000. | |
1359 | </p> | |
1360 | </column> | |
1361 | <column name="other_config" key="mcast-snooping-disable-flood-unregistered" | |
1362 | type='{"type": "boolean"}'> | |
1363 | <p> | |
1364 | If set to <code>false</code>, unregistered multicast packets are forwarded | |
1365 | to all ports. | |
1366 | If set to <code>true</code>, unregistered multicast packets are forwarded | |
1367 | to ports connected to multicast routers. | |
1368 | </p> | |
1369 | </column> | |
1370 | </group> | |
1371 | ||
1372 | <group title="STP Status"> | |
dc2b70ba | 1373 | <p> |
01f13d4f BP |
1374 | These key-value pairs report the status of 802.1D-1998. They are |
1375 | present only if STP is enabled (via the <ref column="stp_enable"/> | |
1376 | column). | |
dc2b70ba | 1377 | </p> |
01f13d4f BP |
1378 | <column name="status" key="stp_bridge_id"> |
1379 | The bridge ID used in spanning tree advertisements, in the form | |
1380 | <var>xxxx</var>.<var>yyyyyyyyyyyy</var> where the <var>x</var>s are | |
1381 | the STP priority, the <var>y</var>s are the STP system ID, and each | |
1382 | <var>x</var> and <var>y</var> is a hex digit. | |
1383 | </column> | |
1384 | <column name="status" key="stp_designated_root"> | |
1385 | The designated root for this spanning tree, in the same form as <ref | |
1386 | column="status" key="stp_bridge_id"/>. If this bridge is the root, | |
1387 | this will have the same value as <ref column="status" | |
1388 | key="stp_bridge_id"/>, otherwise it will differ. | |
1389 | </column> | |
1390 | <column name="status" key="stp_root_path_cost"> | |
1391 | The path cost of reaching the designated bridge. A lower number is | |
1392 | better. The value is 0 if this bridge is the root, otherwise it is | |
1393 | higher. | |
1394 | </column> | |
1395 | </group> | |
1396 | </group> | |
1397 | ||
1398 | <group title="Rapid Spanning Tree"> | |
1399 | <p> | |
1400 | Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol | |
1401 | that ensures loop-free topologies. RSTP superseded STP with the | |
1402 | publication of 802.1D-2004. Compared to STP, RSTP converges more | |
1403 | quickly and recovers more quickly from failures. | |
1404 | </p> | |
1405 | ||
1406 | <group title="RSTP Configuration"> | |
1407 | <column name="rstp_enable" type='{"type": "boolean"}'> | |
1408 | <p> | |
1409 | Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled | |
1410 | on bridges. Bond, internal, and mirror ports are not supported | |
1411 | and will not participate in the spanning tree. | |
1412 | </p> | |
1413 | ||
1414 | <p> | |
1415 | STP and RSTP are mutually exclusive. If both are enabled, RSTP | |
1416 | will be used. | |
1417 | </p> | |
1418 | </column> | |
1419 | ||
1420 | <column name="other_config" key="rstp-address"> | |
1421 | The bridge's RSTP address (the lower 48 bits of the bridge-id) | |
1422 | in the form | |
1423 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>. | |
1424 | By default, the address is the MAC address of the bridge. | |
1425 | </column> | |
1426 | ||
1427 | <column name="other_config" key="rstp-priority" | |
1428 | type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'> | |
1429 | The bridge's relative priority value for determining the root | |
1430 | bridge (the upper 16 bits of the bridge-id). A bridge with the | |
1431 | lowest bridge-id is elected the root. By default, the priority | |
1432 | is 0x8000 (32768). This value needs to be a multiple of 4096, | |
1433 | otherwise it's rounded to the nearest inferior one. | |
1434 | </column> | |
1435 | ||
1436 | <column name="other_config" key="rstp-ageing-time" | |
1437 | type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'> | |
1438 | The Ageing Time parameter for the Bridge. The default value | |
1439 | is 300 seconds. | |
1440 | </column> | |
1441 | ||
1442 | <column name="other_config" key="rstp-force-protocol-version" | |
1443 | type='{"type": "integer"}'> | |
1444 | The Force Protocol Version parameter for the Bridge. This | |
1445 | can take the value 0 (STP Compatibility mode) or 2 | |
1446 | (the default, normal operation). | |
1447 | </column> | |
1448 | ||
1449 | <column name="other_config" key="rstp-max-age" | |
1450 | type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'> | |
1451 | The maximum age of the information transmitted by the Bridge | |
1452 | when it is the Root Bridge. The default value is 20. | |
1453 | </column> | |
1454 | ||
1455 | <column name="other_config" key="rstp-forward-delay" | |
1456 | type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'> | |
1457 | The delay used by STP Bridges to transition Root and Designated | |
1458 | Ports to Forwarding. The default value is 15. | |
1459 | </column> | |
1460 | ||
1461 | <column name="other_config" key="rstp-transmit-hold-count" | |
1462 | type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'> | |
1463 | The Transmit Hold Count used by the Port Transmit state machine | |
1464 | to limit transmission rate. The default value is 6. | |
1465 | </column> | |
1466 | </group> | |
1467 | ||
1468 | <group title="RSTP Status"> | |
dc2b70ba | 1469 | <p> |
01f13d4f BP |
1470 | These key-value pairs report the status of 802.1D-2004. They are |
1471 | present only if RSTP is enabled (via the <ref column="rstp_enable"/> | |
1472 | column). | |
dc2b70ba | 1473 | </p> |
01f13d4f BP |
1474 | <column name="rstp_status" key="rstp_bridge_id"> |
1475 | The bridge ID used in rapid spanning tree advertisements, in the form | |
1476 | <var>x</var>.<var>yyy</var>.<var>zzzzzzzzzzzz</var> where | |
1477 | <var>x</var> is the RSTP priority, the <var>y</var>s are a locally | |
1478 | assigned system ID extension, the <var>z</var>s are the STP system | |
1479 | ID, and each <var>x</var>, <var>y</var>, or <var>z</var> is a hex | |
1480 | digit. | |
1481 | </column> | |
1482 | <column name="rstp_status" key="rstp_root_id"> | |
1483 | The root of this spanning tree, in the same form as <ref | |
1484 | column="rstp_status" key="rstp_bridge_id"/>. If this bridge is the | |
1485 | root, this will have the same value as <ref column="rstp_status" | |
1486 | key="rstp_bridge_id"/>, otherwise it will differ. | |
1487 | </column> | |
1488 | <column name="rstp_status" key="rstp_root_path_cost" | |
1489 | type='{"type": "integer", "minInteger": 0}'> | |
1490 | The path cost of reaching the root. A lower number is better. The | |
1491 | value is 0 if this bridge is the root, otherwise it is higher. | |
1492 | </column> | |
1493 | <column name="rstp_status" key="rstp_designated_id"> | |
1494 | The RSTP designated ID, in the same form as <ref column="rstp_status" | |
1495 | key="rstp_bridge_id"/>. | |
1496 | </column> | |
1497 | <column name="rstp_status" key="rstp_designated_port_id"> | |
1498 | The RSTP designated port ID, as a 4-digit hex number. | |
1499 | </column> | |
1500 | <column name="rstp_status" key="rstp_bridge_port_id"> | |
1501 | The RSTP bridge port ID, as a 4-digit hex number. | |
1502 | </column> | |
1503 | </group> | |
dc2b70ba FL |
1504 | </group> |
1505 | ||
1506 | <group title="Multicast Snooping Configuration"> | |
1507 | Multicast snooping (RFC 4541) monitors the Internet Group Management | |
06994f87 TLSC |
1508 | Protocol (IGMP) and Multicast Listener Discovery traffic between hosts |
1509 | and multicast routers. The switch uses what IGMP and MLD snooping | |
1510 | learns to forward multicast traffic only to interfaces that are connected | |
1511 | to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3, | |
1512 | MLDv1 and MLDv2 protocols. | |
dc2b70ba FL |
1513 | |
1514 | <column name="mcast_snooping_enable"> | |
1515 | Enable multicast snooping on the bridge. For now, the default | |
1516 | is disabled. | |
1517 | </column> | |
21f7563c JP |
1518 | </group> |
1519 | ||
89365653 BP |
1520 | <group title="Other Features"> |
1521 | <column name="datapath_type"> | |
842733c3 MG |
1522 | Name of datapath provider. The kernel datapath has type |
1523 | <code>system</code>. The userspace datapath has type | |
1524 | <code>netdev</code>. A manager may refer to the <ref | |
1525 | table="Open_vSwitch" column="datapath_types"/> column of the <ref | |
1526 | table="Open_vSwitch"/> table for a list of the types accepted by this | |
1527 | Open vSwitch instance. | |
89365653 BP |
1528 | </column> |
1529 | ||
3fd8d445 BP |
1530 | <column name="external_ids" key="bridge-id"> |
1531 | A unique identifier of the bridge. On Citrix XenServer this will | |
1532 | commonly be the same as | |
1533 | <ref column="external_ids" key="xs-network-uuids"/>. | |
89365653 BP |
1534 | </column> |
1535 | ||
3fd8d445 BP |
1536 | <column name="external_ids" key="xs-network-uuids"> |
1537 | Semicolon-delimited set of universally unique identifier(s) for the | |
1538 | network with which this bridge is associated on a Citrix XenServer | |
1539 | host. The network identifiers are RFC 4122 UUIDs as displayed by, | |
1540 | e.g., <code>xe network-list</code>. | |
1541 | </column> | |
1542 | ||
1543 | <column name="other_config" key="hwaddr"> | |
1544 | An Ethernet address in the form | |
1545 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var> | |
1546 | to set the hardware address of the local port and influence the | |
1547 | datapath ID. | |
1548 | </column> | |
1549 | ||
f9e5e5b3 BP |
1550 | <column name="other_config" key="forward-bpdu" |
1551 | type='{"type": "boolean"}'> | |
da1e25d5 | 1552 | |
039a8ccd | 1553 | <p> |
da1e25d5 BP |
1554 | Controls forwarding of BPDUs and other network control frames when |
1555 | NORMAL action is invoked. When this option is <code>false</code> or | |
1556 | unset, frames with reserved Ethernet addresses (see table below) will | |
1557 | not be forwarded. When this option is <code>true</code>, such frames | |
1558 | will not be treated specially. | |
039a8ccd BP |
1559 | </p> |
1560 | ||
1561 | <p> | |
1562 | The above general rule has the following exceptions: | |
1563 | </p> | |
1564 | ||
1565 | <ul> | |
1566 | <li> | |
1567 | If STP is enabled on the bridge (see the <ref column="stp_enable" | |
1568 | table="Bridge"/> column in the <ref table="Bridge"/> table), the | |
1569 | bridge processes all received STP packets and never passes them to | |
1570 | OpenFlow or forwards them. This is true even if STP is disabled on | |
1571 | an individual port. | |
1572 | </li> | |
1573 | ||
1574 | <li> | |
1575 | If LLDP is enabled on an interface (see the <ref column="lldp" | |
1576 | table="Interface"/> column in the <ref table="Interface"/> table), | |
1577 | the interface processes received LLDP packets and never passes them | |
1578 | to OpenFlow or forwards them. | |
1579 | </li> | |
1580 | </ul> | |
1581 | ||
1582 | <p> | |
1583 | Set this option to <code>true</code> if the Open vSwitch bridge | |
1584 | connects different Ethernet networks and is not configured to | |
1585 | participate in STP. | |
1586 | </p> | |
1587 | ||
1588 | <p> | |
1589 | This option affects packets with the following destination MAC | |
1590 | addresses: | |
1591 | </p> | |
da1e25d5 | 1592 | |
05be4e2c EJ |
1593 | <dl> |
1594 | <dt><code>01:80:c2:00:00:00</code></dt> | |
1595 | <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd> | |
1596 | ||
1597 | <dt><code>01:80:c2:00:00:01</code></dt> | |
1598 | <dd>IEEE Pause frame.</dd> | |
1599 | ||
1600 | <dt><code>01:80:c2:00:00:0<var>x</var></code></dt> | |
1601 | <dd>Other reserved protocols.</dd> | |
1602 | ||
7d48a4cc BP |
1603 | <dt><code>00:e0:2b:00:00:00</code></dt> |
1604 | <dd>Extreme Discovery Protocol (EDP).</dd> | |
c93f9a78 | 1605 | |
7d48a4cc | 1606 | <dt> |
039a8ccd BP |
1607 | <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code> |
1608 | </dt> | |
7d48a4cc | 1609 | <dd>Ethernet Automatic Protection Switching (EAPS).</dd> |
c93f9a78 | 1610 | |
05be4e2c EJ |
1611 | <dt><code>01:00:0c:cc:cc:cc</code></dt> |
1612 | <dd> | |
1613 | Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP), | |
1614 | Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP), | |
1615 | and others. | |
1616 | </dd> | |
1617 | ||
1618 | <dt><code>01:00:0c:cc:cc:cd</code></dt> | |
1619 | <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd> | |
1620 | ||
1621 | <dt><code>01:00:0c:cd:cd:cd</code></dt> | |
1622 | <dd>Cisco STP Uplink Fast.</dd> | |
1623 | ||
1624 | <dt><code>01:00:0c:00:00:00</code></dt> | |
1625 | <dd>Cisco Inter Switch Link.</dd> | |
7d48a4cc BP |
1626 | |
1627 | <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt> | |
1628 | <dd>Cisco CFM.</dd> | |
05be4e2c | 1629 | </dl> |
21f7563c | 1630 | </column> |
e764773c BP |
1631 | |
1632 | <column name="other_config" key="mac-aging-time" | |
1633 | type='{"type": "integer", "minInteger": 1}'> | |
1634 | <p> | |
1635 | The maximum number of seconds to retain a MAC learning entry for | |
1636 | which no packets have been seen. The default is currently 300 | |
1637 | seconds (5 minutes). The value, if specified, is forced into a | |
1638 | reasonable range, currently 15 to 3600 seconds. | |
1639 | </p> | |
1640 | ||
1641 | <p> | |
1642 | A short MAC aging time allows a network to more quickly detect that a | |
1643 | host is no longer connected to a switch port. However, it also makes | |
1644 | it more likely that packets will be flooded unnecessarily, when they | |
1645 | are addressed to a connected host that rarely transmits packets. To | |
1646 | reduce the incidence of unnecessary flooding, use a MAC aging time | |
1647 | longer than the maximum interval at which a host will ordinarily | |
1648 | transmit packets. | |
1649 | </p> | |
1650 | </column> | |
c4069512 BP |
1651 | |
1652 | <column name="other_config" key="mac-table-size" | |
1653 | type='{"type": "integer", "minInteger": 1}'> | |
1654 | <p> | |
1655 | The maximum number of MAC addresses to learn. The default is | |
2468f675 | 1656 | currently 8192. The value, if specified, is forced into a reasonable |
c4069512 BP |
1657 | range, currently 10 to 1,000,000. |
1658 | </p> | |
1659 | </column> | |
21f7563c JP |
1660 | </group> |
1661 | ||
3fd8d445 BP |
1662 | <group title="Common Columns"> |
1663 | The overall purpose of these columns is described under <code>Common | |
1664 | Columns</code> at the beginning of this document. | |
1665 | ||
1666 | <column name="other_config"/> | |
1667 | <column name="external_ids"/> | |
1668 | </group> | |
89365653 | 1669 | </table> |
7b243c30 | 1670 | |
039a8ccd | 1671 | <table name="Port" table="Port or bond configuration."> |
89365653 BP |
1672 | <p>A port within a <ref table="Bridge"/>.</p> |
1673 | <p>Most commonly, a port has exactly one ``interface,'' pointed to by its | |
3fd8d445 BP |
1674 | <ref column="interfaces"/> column. Such a port logically |
1675 | corresponds to a port on a physical Ethernet switch. A port | |
1676 | with more than one interface is a ``bonded port'' (see | |
1677 | <ref group="Bonding Configuration"/>).</p> | |
89365653 | 1678 | <p>Some properties that one might think as belonging to a port are actually |
3fd8d445 | 1679 | part of the port's <ref table="Interface"/> members.</p> |
89365653 BP |
1680 | |
1681 | <column name="name"> | |
c885f934 BP |
1682 | Port name. For a non-bonded port, this should be the same as its |
1683 | interface's name. Port names must otherwise be unique among the names of | |
1684 | ports, interfaces, and bridges on a host. Because port and interfaces | |
1685 | names are usually the same, the restrictions on the <ref | |
1686 | table="Interface" column="name"/> column in the <ref table="Interface"/> | |
1687 | table, particularly on length, also apply to port names. Refer to the | |
1688 | documentation for <ref table="Interface"/> names for details. | |
89365653 BP |
1689 | </column> |
1690 | ||
1691 | <column name="interfaces"> | |
1692 | The port's interfaces. If there is more than one, this is a | |
1693 | bonded Port. | |
1694 | </column> | |
1695 | ||
1696 | <group title="VLAN Configuration"> | |
fed8962a EG |
1697 | <p> |
1698 | In short, a VLAN (short for ``virtual LAN'') is a way to partition a | |
1699 | single switch into multiple switches. VLANs can be confusing, so for | |
1700 | an introduction, please refer to the question ``What's a VLAN?'' in the | |
1701 | Open vSwitch FAQ. | |
1702 | </p> | |
1703 | ||
1704 | <p> | |
1705 | A VLAN is sometimes encoded into a packet using a 802.1Q or 802.1ad | |
1706 | VLAN header, but every packet is part of some VLAN whether or not it is | |
1707 | encoded in the packet. (A packet that appears to have no VLAN is part | |
1708 | of VLAN 0, by default.) As a result, it's useful to think of a VLAN as | |
1709 | a metadata property of a packet, separate from how the VLAN is encoded. | |
1710 | For a given port, this column determines how the encoding of a packet | |
1711 | that ingresses or egresses the port maps to the packet's VLAN. When a | |
1712 | packet enters the switch, its VLAN is determined based on its setting | |
1713 | in this column and its VLAN headers, if any, and then, conceptually, | |
1714 | the VLAN headers are then stripped off. Conversely, when a packet | |
1715 | exits the switch, its VLAN and the settings in this column determine | |
1716 | what VLAN headers, if any, are pushed onto the packet before it | |
1717 | egresses the port. | |
1718 | </p> | |
1719 | ||
1720 | <p> | |
1721 | The VLAN configuration in this column affects Open vSwitch only when it | |
1722 | is doing ``normal switching.'' It does not affect flows set up by an | |
1723 | OpenFlow controller, outside of the OpenFlow ``normal action.'' | |
1724 | </p> | |
1725 | ||
1726 | <p> | |
1727 | Bridge ports support the following types of VLAN configuration: | |
1728 | </p> | |
1729 | ||
ecac4ebf BP |
1730 | <dl> |
1731 | <dt>trunk</dt> | |
1732 | <dd> | |
1733 | <p> | |
1734 | A trunk port carries packets on one or more specified VLANs | |
1735 | specified in the <ref column="trunks"/> column (often, on every | |
1736 | VLAN). A packet that ingresses on a trunk port is in the VLAN | |
1737 | specified in its 802.1Q header, or VLAN 0 if the packet has no | |
1738 | 802.1Q header. A packet that egresses through a trunk port will | |
5e9ceccd | 1739 | have an 802.1Q header if it has a nonzero VLAN ID. |
ecac4ebf BP |
1740 | </p> |
1741 | ||
1742 | <p> | |
1743 | Any packet that ingresses on a trunk port tagged with a VLAN that | |
1744 | the port does not trunk is dropped. | |
1745 | </p> | |
1746 | </dd> | |
1747 | ||
1748 | <dt>access</dt> | |
1749 | <dd> | |
1750 | <p> | |
1751 | An access port carries packets on exactly one VLAN specified in the | |
5e9ceccd BP |
1752 | <ref column="tag"/> column. Packets egressing on an access port |
1753 | have no 802.1Q header. | |
ecac4ebf BP |
1754 | </p> |
1755 | ||
1756 | <p> | |
5e9ceccd BP |
1757 | Any packet with an 802.1Q header with a nonzero VLAN ID that |
1758 | ingresses on an access port is dropped, regardless of whether the | |
1759 | VLAN ID in the header is the access port's VLAN ID. | |
ecac4ebf BP |
1760 | </p> |
1761 | </dd> | |
1762 | ||
1763 | <dt>native-tagged</dt> | |
1764 | <dd> | |
1765 | A native-tagged port resembles a trunk port, with the exception that | |
1766 | a packet without an 802.1Q header that ingresses on a native-tagged | |
1767 | port is in the ``native VLAN'' (specified in the <ref column="tag"/> | |
1768 | column). | |
1769 | </dd> | |
1770 | ||
1771 | <dt>native-untagged</dt> | |
1772 | <dd> | |
1773 | A native-untagged port resembles a native-tagged port, with the | |
1774 | exception that a packet that egresses on a native-untagged port in | |
5e9ceccd | 1775 | the native VLAN will not have an 802.1Q header. |
ecac4ebf | 1776 | </dd> |
fed8962a EG |
1777 | |
1778 | <dt>dot1q-tunnel</dt> | |
1779 | <dd> | |
1780 | <p> | |
1781 | A dot1q-tunnel port is somewhat like an access port. Like an | |
1782 | access port, it carries packets on the single VLAN specified in the | |
1783 | <ref column="tag"/> column and this VLAN, called the service VLAN, | |
1784 | does not appear in an 802.1Q header for packets that ingress or | |
1785 | egress on the port. The main difference lies in the behavior when | |
1786 | packets that include a 802.1Q header ingress on the port. Whereas | |
1787 | an access port drops such packets, a dot1q-tunnel port treats these | |
1788 | as double-tagged with the outer service VLAN <ref column="tag"/> | |
1789 | and the inner customer VLAN taken from the 802.1Q header. | |
1790 | Correspondingly, to egress on the port, a packet outer VLAN (or | |
1791 | only VLAN) must be <ref column="tag"/>, which is removed before | |
1792 | egress, which exposes the inner (customer) VLAN if one is present. | |
1793 | </p> | |
1794 | ||
1795 | <p> | |
1796 | If <ref column="cvlans"/> is set, only allows packets in the | |
1797 | specified customer VLANs. | |
1798 | </p> | |
1799 | </dd> | |
ecac4ebf BP |
1800 | </dl> |
1801 | <p> | |
1802 | A packet will only egress through bridge ports that carry the VLAN of | |
1803 | the packet, as described by the rules above. | |
89365653 BP |
1804 | </p> |
1805 | ||
ecac4ebf | 1806 | <column name="vlan_mode"> |
7894d33b | 1807 | <p> |
ecac4ebf BP |
1808 | The VLAN mode of the port, as described above. When this column is |
1809 | empty, a default mode is selected as follows: | |
7894d33b | 1810 | </p> |
ecac4ebf BP |
1811 | <ul> |
1812 | <li> | |
1813 | If <ref column="tag"/> contains a value, the port is an access | |
1814 | port. The <ref column="trunks"/> column should be empty. | |
1815 | </li> | |
1816 | <li> | |
1817 | Otherwise, the port is a trunk port. The <ref column="trunks"/> | |
1818 | column value is honored if it is present. | |
1819 | </li> | |
1820 | </ul> | |
1821 | </column> | |
1822 | ||
1823 | <column name="tag"> | |
7894d33b | 1824 | <p> |
ecac4ebf BP |
1825 | For an access port, the port's implicitly tagged VLAN. For a |
1826 | native-tagged or native-untagged port, the port's native VLAN. Must | |
1827 | be empty if this is a trunk port. | |
7894d33b | 1828 | </p> |
89365653 BP |
1829 | </column> |
1830 | ||
1831 | <column name="trunks"> | |
7894d33b | 1832 | <p> |
ecac4ebf BP |
1833 | For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN |
1834 | or VLANs that this port trunks; if it is empty, then the port trunks | |
1835 | all VLANs. Must be empty if this is an access port. | |
7894d33b BP |
1836 | </p> |
1837 | <p> | |
ecac4ebf BP |
1838 | A native-tagged or native-untagged port always trunks its native |
1839 | VLAN, regardless of whether <ref column="trunks"/> includes that | |
1840 | VLAN. | |
7894d33b | 1841 | </p> |
89365653 | 1842 | </column> |
5e9ceccd | 1843 | |
fed8962a EG |
1844 | <column name="cvlans"> |
1845 | <p> | |
1846 | For a dot1q-tunnel port, the customer VLANs that this port includes. | |
1847 | If this is empty, the port includes all customer VLANs. | |
1848 | </p> | |
1849 | <p> | |
1850 | For other kinds of ports, this setting is ignored. | |
1851 | </p> | |
1852 | </column> | |
1853 | ||
1854 | <column name="other_config" key="qinq-ethtype" | |
1855 | type='{"type": "string", "enum": ["set", ["802.1ad", "802.1q"]]}'> | |
1856 | <p> | |
1857 | For a dot1q-tunnel port, this is the TPID for the service tag, that | |
1858 | is, for the 802.1Q header that contains the service VLAN ID. Because | |
1859 | packets that actually ingress and egress a dot1q-tunnel port do not | |
1860 | include an 802.1Q header for the service VLAN, this does not affect | |
1861 | packets on the dot1q-tunnel port itself. Rather, it determines the | |
1862 | service VLAN for a packet that ingresses on a dot1q-tunnel port and | |
1863 | egresses on a trunk port. | |
1864 | </p> | |
1865 | <p> | |
1866 | The value <code>802.1ad</code> specifies TPID 0x88a8, which is also | |
1867 | the default if the setting is omitted. The value <code>802.1q</code> | |
1868 | specifies TPID 0x8100. | |
1869 | </p> | |
1870 | <p> | |
1871 | For other kinds of ports, this setting is ignored. | |
1872 | </p> | |
1873 | </column> | |
1874 | ||
5e9ceccd | 1875 | <column name="other_config" key="priority-tags" |
88f52d7f | 1876 | type='{"type": "string", |
ffbe41db | 1877 | "enum": ["set", ["never", "if-nonzero", "always"]]}'> |
5e9ceccd BP |
1878 | <p> |
1879 | An 802.1Q header contains two important pieces of information: a VLAN | |
1880 | ID and a priority. A frame with a zero VLAN ID, called a | |
1881 | ``priority-tagged'' frame, is supposed to be treated the same way as | |
1882 | a frame without an 802.1Q header at all (except for the priority). | |
1883 | </p> | |
1884 | ||
1885 | <p> | |
1886 | However, some network elements ignore any frame that has 802.1Q | |
1887 | header at all, even when the VLAN ID is zero. Therefore, by default | |
1888 | Open vSwitch does not output priority-tagged frames, instead omitting | |
1889 | the 802.1Q header entirely if the VLAN ID is zero. Set this key to | |
88f52d7f | 1890 | <code>if-nonzero</code> to enable priority-tagged frames on a port. |
5e9ceccd BP |
1891 | </p> |
1892 | ||
1893 | <p> | |
ffbe41db EB |
1894 | For <code>if-nonzero</code> Open vSwitch omits the 802.1Q header on |
1895 | output if both the VLAN ID and priority would be zero. Set to | |
1896 | <code>always</code> to retain the 802.1Q header in such frames as | |
1897 | well. | |
5e9ceccd BP |
1898 | </p> |
1899 | ||
1900 | <p> | |
1901 | All frames output to native-tagged ports have a nonzero VLAN ID, so | |
1902 | this setting is not meaningful on native-tagged ports. | |
1903 | </p> | |
1904 | </column> | |
89365653 BP |
1905 | </group> |
1906 | ||
1907 | <group title="Bonding Configuration"> | |
be02e7c3 | 1908 | <p>A port that has more than one interface is a ``bonded port.'' Bonding |
d64e1870 BP |
1909 | allows for load balancing and fail-over.</p> |
1910 | ||
1911 | <p> | |
1912 | The following types of bonding will work with any kind of upstream | |
1913 | switch. On the upstream switch, do not configure the interfaces as a | |
1914 | bond: | |
1915 | </p> | |
9f5073d8 EJ |
1916 | |
1917 | <dl> | |
1918 | <dt><code>balance-slb</code></dt> | |
1919 | <dd> | |
1920 | Balances flows among slaves based on source MAC address and output | |
1921 | VLAN, with periodic rebalancing as traffic patterns change. | |
1922 | </dd> | |
1923 | ||
1924 | <dt><code>active-backup</code></dt> | |
1925 | <dd> | |
1926 | Assigns all flows to one slave, failing over to a backup slave when | |
629d868c BP |
1927 | the active slave is disabled. This is the only bonding mode in which |
1928 | interfaces may be plugged into different upstream switches. | |
9f5073d8 EJ |
1929 | </dd> |
1930 | </dl> | |
1931 | ||
1932 | <p> | |
fb0b29a3 | 1933 | The following modes require the upstream switch to support 802.3ad with |
9dd165e0 RK |
1934 | successful LACP negotiation. If LACP negotiation fails and |
1935 | other-config:lacp-fallback-ab is true, then <code>active-backup</code> | |
1936 | mode is used: | |
9f5073d8 EJ |
1937 | </p> |
1938 | ||
1939 | <dl> | |
1940 | <dt><code>balance-tcp</code></dt> | |
1941 | <dd> | |
ecbca23d IM |
1942 | Balances flows among slaves based on L3 and L4 protocol information |
1943 | such as IP addresses and TCP/UDP ports. | |
9f5073d8 | 1944 | </dd> |
fb0b29a3 EJ |
1945 | </dl> |
1946 | ||
89365653 | 1947 | <p>These columns apply only to bonded ports. Their values are |
3fd8d445 | 1948 | otherwise ignored.</p> |
89365653 | 1949 | |
27dcaa1a | 1950 | <column name="bond_mode"> |
9f5073d8 | 1951 | <p>The type of bonding used for a bonded port. Defaults to |
4df08875 | 1952 | <code>active-backup</code> if unset. |
9f5073d8 | 1953 | </p> |
be02e7c3 EJ |
1954 | </column> |
1955 | ||
96ada1a4 EJ |
1956 | <column name="other_config" key="bond-hash-basis" |
1957 | type='{"type": "integer"}'> | |
1958 | An integer hashed along with flows when choosing output slaves in load | |
1959 | balanced bonds. When changed, all flows will be assigned different | |
1960 | hash values possibly causing slave selection decisions to change. Does | |
1961 | not affect bonding modes which do not employ load balancing such as | |
1962 | <code>active-backup</code>. | |
1963 | </column> | |
1964 | ||
3fd8d445 BP |
1965 | <group title="Link Failure Detection"> |
1966 | <p> | |
1967 | An important part of link bonding is detecting that links are down so | |
1968 | that they may be disabled. These settings determine how Open vSwitch | |
1969 | detects link failure. | |
1970 | </p> | |
89365653 | 1971 | |
f9e5e5b3 BP |
1972 | <column name="other_config" key="bond-detect-mode" |
1973 | type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'> | |
1974 | The means used to detect link failures. Defaults to | |
3fd8d445 BP |
1975 | <code>carrier</code> which uses each interface's carrier to detect |
1976 | failures. When set to <code>miimon</code>, will check for failures | |
1977 | by polling each interface's MII. | |
1978 | </column> | |
89365653 | 1979 | |
f9e5e5b3 BP |
1980 | <column name="other_config" key="bond-miimon-interval" |
1981 | type='{"type": "integer"}'> | |
3fd8d445 BP |
1982 | The interval, in milliseconds, between successive attempts to poll |
1983 | each interface's MII. Relevant only when <ref column="other_config" | |
1984 | key="bond-detect-mode"/> is <code>miimon</code>. | |
1985 | </column> | |
1986 | ||
1987 | <column name="bond_updelay"> | |
1988 | <p> | |
1c144051 | 1989 | The number of milliseconds for which the link must stay up on an |
3fd8d445 BP |
1990 | interface before the interface is considered to be up. Specify |
1991 | <code>0</code> to enable the interface immediately. | |
1992 | </p> | |
1993 | ||
1994 | <p> | |
1995 | This setting is honored only when at least one bonded interface is | |
1996 | already enabled. When no interfaces are enabled, then the first | |
1997 | bond interface to come up is enabled immediately. | |
1998 | </p> | |
1999 | </column> | |
2000 | ||
2001 | <column name="bond_downdelay"> | |
1c144051 | 2002 | The number of milliseconds for which the link must stay down on an |
3fd8d445 BP |
2003 | interface before the interface is considered to be down. Specify |
2004 | <code>0</code> to disable the interface immediately. | |
2005 | </column> | |
2006 | </group> | |
c25c91fd | 2007 | |
3fd8d445 BP |
2008 | <group title="LACP Configuration"> |
2009 | <p> | |
2010 | LACP, the Link Aggregation Control Protocol, is an IEEE standard that | |
2011 | allows switches to automatically detect that they are connected by | |
2012 | multiple links and aggregate across those links. These settings | |
2013 | control LACP behavior. | |
2014 | </p> | |
2015 | ||
2016 | <column name="lacp"> | |
2017 | Configures LACP on this port. LACP allows directly connected | |
76ea8efd AE |
2018 | switches to negotiate which links may be bonded. LACP may be enabled |
2019 | on non-bonded ports for the benefit of any switches they may be | |
c25c91fd EJ |
2020 | connected to. <code>active</code> ports are allowed to initiate LACP |
2021 | negotiations. <code>passive</code> ports are allowed to participate | |
2022 | in LACP negotiations initiated by a remote switch, but not allowed to | |
bdebeece EJ |
2023 | initiate such negotiations themselves. If LACP is enabled on a port |
2024 | whose partner switch does not support LACP, the bond will be | |
9dd165e0 RK |
2025 | disabled, unless other-config:lacp-fallback-ab is set to true. |
2026 | Defaults to <code>off</code> if unset. | |
3fd8d445 BP |
2027 | </column> |
2028 | ||
2029 | <column name="other_config" key="lacp-system-id"> | |
2030 | The LACP system ID of this <ref table="Port"/>. The system ID of a | |
2031 | LACP bond is used to identify itself to its partners. Must be a | |
a9bf011b EJ |
2032 | nonzero MAC address. Defaults to the bridge Ethernet address if |
2033 | unset. | |
3fd8d445 BP |
2034 | </column> |
2035 | ||
f9e5e5b3 BP |
2036 | <column name="other_config" key="lacp-system-priority" |
2037 | type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'> | |
3fd8d445 BP |
2038 | The LACP system priority of this <ref table="Port"/>. In LACP |
2039 | negotiations, link status decisions are made by the system with the | |
f9e5e5b3 | 2040 | numerically lower priority. |
3fd8d445 BP |
2041 | </column> |
2042 | ||
bf83f7c8 | 2043 | <column name="other_config" key="lacp-time" |
039a8ccd | 2044 | type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'> |
3fd8d445 BP |
2045 | <p> |
2046 | The LACP timing which should be used on this <ref table="Port"/>. | |
bf83f7c8 EJ |
2047 | By default <code>slow</code> is used. When configured to be |
2048 | <code>fast</code> LACP heartbeats are requested at a rate of once | |
2049 | per second causing connectivity problems to be detected more | |
2050 | quickly. In <code>slow</code> mode, heartbeats are requested at a | |
2051 | rate of once every 30 seconds. | |
3fd8d445 BP |
2052 | </p> |
2053 | </column> | |
9dd165e0 RK |
2054 | |
2055 | <column name="other_config" key="lacp-fallback-ab" | |
039a8ccd | 2056 | type='{"type": "boolean"}'> |
9dd165e0 RK |
2057 | <p> |
2058 | Determines the behavior of openvswitch bond in LACP mode. If | |
2059 | the partner switch does not support LACP, setting this option | |
2060 | to <code>true</code> allows openvswitch to fallback to | |
2061 | active-backup. If the option is set to <code>false</code>, the | |
2062 | bond will be disabled. In both the cases, once the partner switch | |
2063 | is configured to LACP mode, the bond will use LACP. | |
2064 | </p> | |
2065 | </column> | |
3fd8d445 BP |
2066 | </group> |
2067 | ||
b62ee96f | 2068 | <group title="Rebalancing Configuration"> |
3fd8d445 BP |
2069 | <p> |
2070 | These settings control behavior when a bond is in | |
b62ee96f | 2071 | <code>balance-slb</code> or <code>balance-tcp</code> mode. |
3fd8d445 BP |
2072 | </p> |
2073 | ||
f9e5e5b3 | 2074 | <column name="other_config" key="bond-rebalance-interval" |
bc1b010c EJ |
2075 | type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'> |
2076 | For a load balanced bonded port, the number of milliseconds between | |
2077 | successive attempts to rebalance the bond, that is, to move flows | |
2078 | from one interface on the bond to another in an attempt to keep usage | |
2079 | of each interface roughly equal. If zero, load balancing is disabled | |
1c144051 | 2080 | on the bond (link failure still cause flows to move). If |
bc1b010c | 2081 | less than 1000ms, the rebalance interval will be 1000ms. |
3fd8d445 BP |
2082 | </column> |
2083 | </group> | |
2084 | ||
2085 | <column name="bond_fake_iface"> | |
2086 | For a bonded port, whether to create a fake internal interface with the | |
2087 | name of the port. Use only for compatibility with legacy software that | |
2088 | requires this. | |
2089 | </column> | |
89365653 BP |
2090 | </group> |
2091 | ||
01f13d4f BP |
2092 | <group title="Spanning Tree Protocol"> |
2093 | <p> | |
2094 | The configuration here is only meaningful, and the status is only | |
2095 | populated, when 802.1D-1998 Spanning Tree Protocol is enabled on the | |
2096 | port's <ref column="Bridge"/> with its <ref column="stp_enable"/> | |
2097 | column. | |
2098 | </p> | |
21f7563c | 2099 | |
01f13d4f BP |
2100 | <group title="STP Configuration"> |
2101 | <column name="other_config" key="stp-enable" | |
2102 | type='{"type": "boolean"}'> | |
2103 | When STP is enabled on a bridge, it is enabled by default on all of | |
2104 | the bridge's ports except bond, internal, and mirror ports (which do | |
2105 | not work with STP). If this column's value is <code>false</code>, | |
2106 | STP is disabled on the port. | |
2107 | </column> | |
21f7563c | 2108 | |
01f13d4f BP |
2109 | <column name="other_config" key="stp-port-num" |
2110 | type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'> | |
2111 | The port number used for the lower 8 bits of the port-id. By | |
2112 | default, the numbers will be assigned automatically. If any | |
2113 | port's number is manually configured on a bridge, then they | |
2114 | must all be. | |
2115 | </column> | |
21f7563c | 2116 | |
01f13d4f BP |
2117 | <column name="other_config" key="stp-port-priority" |
2118 | type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'> | |
2119 | The port's relative priority value for determining the root | |
2120 | port (the upper 8 bits of the port-id). A port with a lower | |
2121 | port-id will be chosen as the root port. By default, the | |
2122 | priority is 0x80. | |
2123 | </column> | |
2124 | ||
2125 | <column name="other_config" key="stp-path-cost" | |
2126 | type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'> | |
2127 | Spanning tree path cost for the port. A lower number indicates | |
2128 | a faster link. By default, the cost is based on the maximum | |
2129 | speed of the link. | |
2130 | </column> | |
2131 | </group> | |
2132 | ||
2133 | <group title="STP Status"> | |
2134 | <column name="status" key="stp_port_id"> | |
2135 | The port ID used in spanning tree advertisements for this port, as 4 | |
2136 | hex digits. Configuring the port ID is described in the | |
2137 | <code>stp-port-num</code> and <code>stp-port-priority</code> keys of | |
2138 | the <code>other_config</code> section earlier. | |
2139 | </column> | |
2140 | <column name="status" key="stp_state" | |
2141 | type='{"type": "string", "enum": ["set", | |
2142 | ["disabled", "listening", "learning", | |
2143 | "forwarding", "blocking"]]}'> | |
2144 | STP state of the port. | |
2145 | </column> | |
2146 | <column name="status" key="stp_sec_in_state" | |
2147 | type='{"type": "integer", "minInteger": 0}'> | |
2148 | The amount of time this port has been in the current STP state, in | |
2149 | seconds. | |
2150 | </column> | |
2151 | <column name="status" key="stp_role" | |
2152 | type='{"type": "string", "enum": ["set", | |
2153 | ["root", "designated", "alternate"]]}'> | |
2154 | STP role of the port. | |
2155 | </column> | |
2156 | </group> | |
21f7563c | 2157 | </group> |
d62d7cb1 | 2158 | |
01f13d4f BP |
2159 | <group title="Rapid Spanning Tree Protocol"> |
2160 | <p> | |
2161 | The configuration here is only meaningful, and the status and | |
2162 | statistics are only populated, when 802.1D-1998 Spanning Tree Protocol | |
2163 | is enabled on the port's <ref column="Bridge"/> with its <ref | |
2164 | column="stp_enable"/> column. | |
2165 | </p> | |
d62d7cb1 | 2166 | |
01f13d4f BP |
2167 | <group title="RSTP Configuration"> |
2168 | <column name="other_config" key="rstp-enable" | |
2169 | type='{"type": "boolean"}'> | |
2170 | When RSTP is enabled on a bridge, it is enabled by default on all of | |
2171 | the bridge's ports except bond, internal, and mirror ports (which do | |
2172 | not work with RSTP). If this column's value is <code>false</code>, | |
2173 | RSTP is disabled on the port. | |
2174 | </column> | |
d62d7cb1 | 2175 | |
01f13d4f BP |
2176 | <column name="other_config" key="rstp-port-priority" |
2177 | type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'> | |
2178 | The port's relative priority value for determining the root port, in | |
2179 | multiples of 16. By default, the port priority is 0x80 (128). Any | |
2180 | value in the lower 4 bits is rounded off. The significant upper 4 | |
2181 | bits become the upper 4 bits of the port-id. A port with the lowest | |
2182 | port-id is elected as the root. | |
2183 | </column> | |
d62d7cb1 | 2184 | |
01f13d4f BP |
2185 | <column name="other_config" key="rstp-port-num" |
2186 | type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'> | |
2187 | The local RSTP port number, used as the lower 12 bits of the port-id. | |
2188 | By default the port numbers are assigned automatically, and typically | |
2189 | may not correspond to the OpenFlow port numbers. A port with the | |
2190 | lowest port-id is elected as the root. | |
2191 | </column> | |
d62d7cb1 | 2192 | |
01f13d4f BP |
2193 | <column name="other_config" key="rstp-port-path-cost" |
2194 | type='{"type": "integer"}'> | |
2195 | The port path cost. The Port's contribution, when it is | |
2196 | the Root Port, to the Root Path Cost for the Bridge. By default the | |
2197 | cost is automatically calculated from the port's speed. | |
2198 | </column> | |
d62d7cb1 | 2199 | |
01f13d4f BP |
2200 | <column name="other_config" key="rstp-port-admin-edge" |
2201 | type='{"type": "boolean"}'> | |
2202 | The admin edge port parameter for the Port. Default is | |
2203 | <code>false</code>. | |
2204 | </column> | |
d62d7cb1 | 2205 | |
01f13d4f BP |
2206 | <column name="other_config" key="rstp-port-auto-edge" |
2207 | type='{"type": "boolean"}'> | |
2208 | The auto edge port parameter for the Port. Default is | |
d62d7cb1 | 2209 | <code>true</code>. |
01f13d4f BP |
2210 | </column> |
2211 | ||
2212 | <column name="other_config" key="rstp-port-mcheck" | |
2213 | type='{"type": "boolean"}'> | |
2214 | <p> | |
2215 | The mcheck port parameter for the Port. Default is | |
2216 | <code>false</code>. May be set to force the Port Protocol | |
2217 | Migration state machine to transmit RST BPDUs for a | |
2218 | MigrateTime period, to test whether all STP Bridges on the | |
2219 | attached LAN have been removed and the Port can continue to | |
2220 | transmit RSTP BPDUs. Setting mcheck has no effect if the | |
2221 | Bridge is operating in STP Compatibility mode. | |
2222 | </p> | |
2223 | <p> | |
2224 | Changing the value from <code>true</code> to | |
2225 | <code>false</code> has no effect, but needs to be done if | |
2226 | this behavior is to be triggered again by subsequently | |
2227 | changing the value from <code>false</code> to | |
2228 | <code>true</code>. | |
2229 | </p> | |
2230 | </column> | |
2231 | </group> | |
2232 | ||
2233 | <group title="RSTP Status"> | |
2234 | <column name="rstp_status" key="rstp_port_id"> | |
2235 | The port ID used in spanning tree advertisements for this port, as 4 | |
2236 | hex digits. Configuring the port ID is described in the | |
2237 | <code>rstp-port-num</code> and <code>rstp-port-priority</code> keys | |
2238 | of the <code>other_config</code> section earlier. | |
2239 | </column> | |
2240 | <column name="rstp_status" key="rstp_port_role" | |
2241 | type='{"type": "string", "enum": ["set", | |
2242 | ["Root", "Designated", "Alternate", "Backup", "Disabled"]]}'> | |
2243 | RSTP role of the port. | |
2244 | </column> | |
2245 | <column name="rstp_status" key="rstp_port_state" | |
2246 | type='{"type": "string", "enum": ["set", | |
2247 | ["Disabled", "Learning", "Forwarding", "Discarding"]]}'> | |
2248 | RSTP state of the port. | |
2249 | </column> | |
2250 | <column name="rstp_status" key="rstp_designated_bridge_id"> | |
2251 | The port's RSTP designated bridge ID, in the same form as <ref | |
2252 | column="rstp_status" key="rstp_bridge_id"/> in the <ref | |
2253 | table="Bridge"/> table. | |
2254 | </column> | |
2255 | <column name="rstp_status" key="rstp_designated_port_id"> | |
2256 | The port's RSTP designated port ID, as 4 hex digits. | |
2257 | </column> | |
2258 | <column name="rstp_status" key="rstp_designated_path_cost" | |
2259 | type='{"type": "integer"}'> | |
2260 | The port's RSTP designated path cost. Lower is better. | |
2261 | </column> | |
2262 | </group> | |
2263 | ||
2264 | <group title="RSTP Statistics"> | |
2265 | <column name="rstp_statistics" key="rstp_tx_count"> | |
2266 | Number of RSTP BPDUs transmitted through this port. | |
2267 | </column> | |
2268 | <column name="rstp_statistics" key="rstp_rx_count"> | |
2269 | Number of valid RSTP BPDUs received by this port. | |
2270 | </column> | |
2271 | <column name="rstp_statistics" key="rstp_error_count"> | |
2272 | Number of invalid RSTP BPDUs received by this port. | |
2273 | </column> | |
2274 | <column name="rstp_statistics" key="rstp_uptime"> | |
2275 | The duration covered by the other RSTP statistics, in seconds. | |
2276 | </column> | |
2277 | </group> | |
d62d7cb1 JR |
2278 | </group> |
2279 | ||
dc2b70ba FL |
2280 | <group title="Multicast Snooping"> |
2281 | <column name="other_config" key="mcast-snooping-flood" | |
2282 | type='{"type": "boolean"}'> | |
2283 | <p> | |
8e04a33f FL |
2284 | If set to <code>true</code>, multicast packets (except Reports) are |
2285 | unconditionally forwarded to the specific port. | |
2286 | </p> | |
2287 | </column> | |
2288 | <column name="other_config" key="mcast-snooping-flood-reports" | |
2289 | type='{"type": "boolean"}'> | |
2290 | <p> | |
2291 | If set to <code>true</code>, multicast Reports are unconditionally | |
dc2b70ba FL |
2292 | forwarded to the specific port. |
2293 | </p> | |
2294 | </column> | |
2295 | </group> | |
21f7563c | 2296 | |
89365653 | 2297 | <group title="Other Features"> |
c1c9c9c4 BP |
2298 | <column name="qos"> |
2299 | Quality of Service configuration for this port. | |
2300 | </column> | |
299a244b | 2301 | |
89365653 BP |
2302 | <column name="mac"> |
2303 | The MAC address to use for this port for the purpose of choosing the | |
2304 | bridge's MAC address. This column does not necessarily reflect the | |
2305 | port's actual MAC address, nor will setting it change the port's actual | |
2306 | MAC address. | |
2307 | </column> | |
2308 | ||
2309 | <column name="fake_bridge"> | |
2310 | Does this port represent a sub-bridge for its tagged VLAN within the | |
2311 | Bridge? See ovs-vsctl(8) for more information. | |
2312 | </column> | |
2313 | ||
ced947ae BK |
2314 | <column name="protected" type='{"type": "boolean"}'> |
2315 | The protected ports feature allows certain ports to be designated as | |
2316 | protected. Traffic between protected ports is blocked. Protected | |
2317 | ports can send traffic to unprotected ports. Unprotected ports can | |
2318 | send traffic to any port. | |
2319 | Default is false. | |
2320 | </column> | |
2321 | ||
3fd8d445 BP |
2322 | <column name="external_ids" key="fake-bridge-id-*"> |
2323 | External IDs for a fake bridge (see the <ref column="fake_bridge"/> | |
2324 | column) are defined by prefixing a <ref table="Bridge"/> <ref | |
2325 | table="Bridge" column="external_ids"/> key with | |
2326 | <code>fake-bridge-</code>, | |
2327 | e.g. <code>fake-bridge-xs-network-uuids</code>. | |
89365653 | 2328 | </column> |
54b21db7 TLSC |
2329 | |
2330 | <column name="other_config" key="transient" | |
2331 | type='{"type": "boolean"}'> | |
2332 | <p> | |
2333 | If set to <code>true</code>, the port will be removed when | |
2334 | <code>ovs-ctl start --delete-transient-ports</code> is used. | |
2335 | </p> | |
2336 | </column> | |
3fd8d445 | 2337 | </group> |
89365653 | 2338 | |
01f13d4f BP |
2339 | <column name="bond_active_slave"> |
2340 | For a bonded port, record the mac address of the current active slave. | |
2341 | </column> | |
21f7563c | 2342 | |
80740385 JP |
2343 | <group title="Port Statistics"> |
2344 | <p> | |
12eb035b AW |
2345 | Key-value pairs that report port statistics. The update period |
2346 | is controlled by <ref column="other_config" | |
2347 | key="stats-update-interval"/> in the <code>Open_vSwitch</code> table. | |
80740385 JP |
2348 | </p> |
2349 | <group title="Statistics: STP transmit and receive counters"> | |
2350 | <column name="statistics" key="stp_tx_count"> | |
2351 | Number of STP BPDUs sent on this port by the spanning | |
2352 | tree library. | |
2353 | </column> | |
2354 | <column name="statistics" key="stp_rx_count"> | |
2355 | Number of STP BPDUs received on this port and accepted by the | |
2356 | spanning tree library. | |
2357 | </column> | |
2358 | <column name="statistics" key="stp_error_count"> | |
2359 | Number of bad STP BPDUs received on this port. Bad BPDUs | |
2360 | include runt packets and those with an unexpected protocol ID. | |
2361 | </column> | |
2362 | </group> | |
2363 | </group> | |
2364 | ||
3fd8d445 BP |
2365 | <group title="Common Columns"> |
2366 | The overall purpose of these columns is described under <code>Common | |
2367 | Columns</code> at the beginning of this document. | |
2368 | ||
2369 | <column name="other_config"/> | |
2370 | <column name="external_ids"/> | |
89365653 BP |
2371 | </group> |
2372 | </table> | |
2373 | ||
2374 | <table name="Interface" title="One physical network device in a Port."> | |
2375 | An interface within a <ref table="Port"/>. | |
2376 | ||
2377 | <group title="Core Features"> | |
2378 | <column name="name"> | |
c885f934 BP |
2379 | <p> |
2380 | Interface name. Should be alphanumeric. For non-bonded port, this | |
2381 | should be the same as the port name. It must otherwise be unique | |
2382 | among the names of ports, interfaces, and bridges on a host. | |
2383 | </p> | |
2384 | ||
2385 | <p> | |
2386 | The maximum length of an interface name depends on the underlying | |
2387 | datapath: | |
2388 | </p> | |
2389 | ||
2390 | <ul> | |
2391 | <li> | |
2392 | The names of interfaces implemented as Linux and BSD network | |
2393 | devices, including interfaces with type <code>internal</code>, | |
59a0ef1d JG |
2394 | <code>tap</code>, or <code>system</code> plus the different types |
2395 | of tunnel ports, are limited to 15 bytes. Windows limits these | |
2396 | names to 255 bytes. | |
c885f934 BP |
2397 | </li> |
2398 | ||
2399 | <li> | |
59a0ef1d JG |
2400 | The names of patch ports are not used in the underlying datapath, |
2401 | so operating system restrictions do not apply. Thus, they may have | |
2402 | arbitrary length. | |
c885f934 BP |
2403 | </li> |
2404 | </ul> | |
2405 | ||
2406 | <p> | |
2407 | Regardless of other restrictions, OpenFlow only supports 15-byte | |
2408 | names, which means that <code>ovs-ofctl</code> and OpenFlow | |
2409 | controllers will show names truncated to 15 bytes. | |
2410 | </p> | |
89365653 BP |
2411 | </column> |
2412 | ||
ea401d9a NM |
2413 | <column name="ifindex"> |
2414 | A positive interface index as defined for SNMP MIB-II in RFCs 1213 and | |
2415 | 2863, if the interface has one, otherwise 0. The ifindex is useful for | |
2416 | seamless integration with protocols such as SNMP and sFlow. | |
2417 | </column> | |
2418 | ||
df867eda JP |
2419 | <column name="mac_in_use"> |
2420 | The MAC address in use by this interface. | |
2421 | </column> | |
2422 | ||
89365653 BP |
2423 | <column name="mac"> |
2424 | <p>Ethernet address to set for this interface. If unset then the | |
3fd8d445 | 2425 | default MAC address is used:</p> |
89365653 BP |
2426 | <ul> |
2427 | <li>For the local interface, the default is the lowest-numbered MAC | |
3fd8d445 BP |
2428 | address among the other bridge ports, either the value of the |
2429 | <ref table="Port" column="mac"/> in its <ref table="Port"/> record, | |
2430 | if set, or its actual MAC (for bonded ports, the MAC of its slave | |
2431 | whose name is first in alphabetical order). Internal ports and | |
2432 | bridge ports that are used as port mirroring destinations (see the | |
2433 | <ref table="Mirror"/> table) are ignored.</li> | |
2e57b537 | 2434 | <li>For other internal interfaces, the default MAC is randomly |
3fd8d445 | 2435 | generated.</li> |
89365653 | 2436 | <li>External interfaces typically have a MAC address associated with |
3fd8d445 | 2437 | their hardware.</li> |
89365653 BP |
2438 | </ul> |
2439 | <p>Some interfaces may not have a software-controllable MAC | |
1c300ffa | 2440 | address. This option only affects internal ports. For other type ports, |
5a0e4aec | 2441 | you can change the MAC address outside Open vSwitch, using ip command.</p> |
89365653 BP |
2442 | </column> |
2443 | ||
bbe6109d TG |
2444 | <column name="error"> |
2445 | If the configuration of the port failed, as indicated by -1 in <ref | |
2446 | column="ofport"/>, Open vSwitch sets this column to an error | |
2447 | description in human readable form. Otherwise, Open vSwitch clears | |
2448 | this column. | |
2449 | </column> | |
2450 | ||
484c8355 | 2451 | <group title="OpenFlow Port Number"> |
039a8ccd BP |
2452 | <p> |
2453 | When a client adds a new interface, Open vSwitch chooses an OpenFlow | |
2454 | port number for the new port. If the client that adds the port fills | |
2455 | in <ref column="ofport_request"/>, then Open vSwitch tries to use its | |
2456 | value as the OpenFlow port number. Otherwise, or if the requested | |
2457 | port number is already in use or cannot be used for another reason, | |
2458 | Open vSwitch automatically assigns a free port number. Regardless of | |
2459 | how the port number was obtained, Open vSwitch then reports in <ref | |
2460 | column="ofport"/> the port number actually assigned. | |
2461 | </p> | |
2462 | ||
2463 | <p> | |
2464 | Open vSwitch limits the port numbers that it automatically assigns to | |
2465 | the range 1 through 32,767, inclusive. Controllers therefore have | |
2466 | free use of ports 32,768 and up. | |
2467 | </p> | |
2468 | ||
2469 | <column name="ofport"> | |
2470 | <p> | |
2471 | OpenFlow port number for this interface. Open vSwitch sets this | |
2472 | column's value, so other clients should treat it as read-only. | |
2473 | </p> | |
2474 | <p> | |
2475 | The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534. | |
2476 | The other valid port numbers are in the range 1 to 65,279, | |
2477 | inclusive. Value -1 indicates an error adding the interface. | |
2478 | </p> | |
2479 | </column> | |
2480 | ||
2481 | <column name="ofport_request" | |
2482 | type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'> | |
2483 | <p> | |
2484 | Requested OpenFlow port number for this interface. | |
2485 | </p> | |
2486 | ||
2487 | <p> | |
2488 | A client should ideally set this column's value in the same | |
2489 | database transaction that it uses to create the interface. Open | |
2490 | vSwitch version 2.1 and later will honor a later request for a | |
2491 | specific port number, althuogh it might confuse some controllers: | |
2492 | OpenFlow does not have a way to announce a port number change, so | |
2493 | Open vSwitch represents it over OpenFlow as a port deletion | |
2494 | followed immediately by a port addition. | |
2495 | </p> | |
2496 | ||
2497 | <p> | |
2498 | If <ref column="ofport_request"/> is set or changed to some other | |
2499 | port's automatically assigned port number, Open vSwitch chooses a | |
2500 | new port number for the latter port. | |
2501 | </p> | |
2502 | </column> | |
484c8355 | 2503 | </group> |
89365653 BP |
2504 | </group> |
2505 | ||
2506 | <group title="System-Specific Details"> | |
2507 | <column name="type"> | |
3fd8d445 | 2508 | <p> |
842733c3 MG |
2509 | The interface type. The types supported by a particular instance of |
2510 | Open vSwitch are listed in the <ref table="Open_vSwitch" | |
2511 | column="iface_types"/> column in the <ref table="Open_vSwitch"/> | |
2512 | table. The following types are defined: | |
3fd8d445 BP |
2513 | </p> |
2514 | ||
89365653 BP |
2515 | <dl> |
2516 | <dt><code>system</code></dt> | |
2517 | <dd>An ordinary network device, e.g. <code>eth0</code> on Linux. | |
3fd8d445 BP |
2518 | Sometimes referred to as ``external interfaces'' since they are |
2519 | generally connected to hardware external to that on which the Open | |
2520 | vSwitch is running. The empty string is a synonym for | |
2521 | <code>system</code>.</dd> | |
2522 | ||
89365653 | 2523 | <dt><code>internal</code></dt> |
2e57b537 | 2524 | <dd>A simulated network device that sends and receives traffic. An |
3fd8d445 BP |
2525 | internal interface whose <ref column="name"/> is the same as its |
2526 | bridge's <ref table="Open_vSwitch" column="name"/> is called the | |
2527 | ``local interface.'' It does not make sense to bond an internal | |
2528 | interface, so the terms ``port'' and ``interface'' are often used | |
2529 | imprecisely for internal interfaces.</dd> | |
2530 | ||
89365653 | 2531 | <dt><code>tap</code></dt> |
22dcb534 FL |
2532 | <dd> |
2533 | <p> | |
2534 | A TUN/TAP device managed by Open vSwitch. | |
2535 | </p> | |
2536 | <p> | |
2537 | Open vSwitch checks the interface state before send packets | |
2538 | to the device. When it is <code>down</code>, the packets are | |
2539 | dropped and the tx_dropped statistic is updated accordingly. | |
2540 | Older versions of Open vSwitch did not check the interface state | |
2541 | and then the tx_packets was incremented along with tx_dropped. | |
2542 | </p> | |
2543 | </dd> | |
3fd8d445 | 2544 | |
c1fc1411 JG |
2545 | <dt><code>geneve</code></dt> |
2546 | <dd> | |
59a0ef1d | 2547 | An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve</code>) |
80c4589a | 2548 | IPv4/IPv6 tunnel. |
c1fc1411 | 2549 | |
9558d2a5 JG |
2550 | A description of how to match and set Geneve options can be found |
2551 | in the <code>ovs-ofctl</code> manual page. | |
c1fc1411 JG |
2552 | </dd> |
2553 | ||
89365653 | 2554 | <dt><code>gre</code></dt> |
3fd8d445 | 2555 | <dd> |
a3173ee1 | 2556 | Generic Routing Encapsulation (GRE) over IPv4 tunnel, |
63171f04 | 2557 | configurable to encapsulate layer 2 or layer 3 traffic. |
e16a28b5 | 2558 | </dd> |
3fd8d445 | 2559 | |
a3173ee1 WT |
2560 | <dt><code>ip6gre</code></dt> |
2561 | <dd> | |
2562 | Generic Routing Encapsulation (GRE) over IPv6 tunnel, | |
2563 | encapsulate layer 2 traffic. | |
2564 | </dd> | |
2565 | ||
79f827fa KM |
2566 | <dt><code>vxlan</code></dt> |
2567 | <dd> | |
039a8ccd BP |
2568 | <p> |
2569 | An Ethernet tunnel over the UDP-based VXLAN protocol described in | |
2570 | RFC 7348. | |
2571 | </p> | |
2572 | <p> | |
59a0ef1d JG |
2573 | Open vSwitch uses IANA-assigned UDP destination port 4789. The |
2574 | source port used for VXLAN traffic varies on a per-flow basis | |
2575 | and is in the ephemeral port range. | |
039a8ccd | 2576 | </p> |
79f827fa KM |
2577 | </dd> |
2578 | ||
a6ae068b LJ |
2579 | <dt><code>lisp</code></dt> |
2580 | <dd> | |
a6363cfd LJ |
2581 | <p> |
2582 | A layer 3 tunnel over the experimental, UDP-based Locator/ID | |
2583 | Separation Protocol (RFC 6830). | |
2584 | </p> | |
2585 | <p> | |
2586 | Only IPv4 and IPv6 packets are supported by the protocol, and | |
2587 | they are sent and received without an Ethernet header. Traffic | |
2588 | to/from LISP ports is expected to be configured explicitly, and | |
2589 | the ports are not intended to participate in learning based | |
2590 | switching. As such, they are always excluded from packet | |
2591 | flooding. | |
2592 | </p> | |
a6ae068b LJ |
2593 | </dd> |
2594 | ||
4237026e PS |
2595 | <dt><code>stt</code></dt> |
2596 | <dd> | |
039a8ccd BP |
2597 | The Stateless TCP Tunnel (STT) is particularly useful when tunnel |
2598 | endpoints are in end-systems, as it utilizes the capabilities of | |
2599 | standard network interface cards to improve performance. STT utilizes | |
2600 | a TCP-like header inside the IP header. It is stateless, i.e., there is | |
2601 | no TCP connection state of any kind associated with the tunnel. The | |
2602 | TCP-like header is used to leverage the capabilities of existing | |
2603 | network interface cards, but should not be interpreted as implying | |
2604 | any sort of connection state between endpoints. | |
2605 | Since the STT protocol does not engage in the usual TCP 3-way handshake, | |
2606 | so it will have difficulty traversing stateful firewalls. | |
2607 | The protocol is documented at | |
59a0ef1d | 2608 | https://tools.ietf.org/html/draft-davie-stt |
039a8ccd | 2609 | |
59a0ef1d | 2610 | All traffic uses a default destination port of 7471. |
4237026e PS |
2611 | </dd> |
2612 | ||
8aed4223 | 2613 | <dt><code>patch</code></dt> |
eca2df31 | 2614 | <dd> |
3fd8d445 | 2615 | A pair of virtual devices that act as a patch cable. |
eca2df31 | 2616 | </dd> |
89365653 BP |
2617 | </dl> |
2618 | </column> | |
3fd8d445 BP |
2619 | </group> |
2620 | ||
2621 | <group title="Tunnel Options"> | |
2622 | <p> | |
2623 | These options apply to interfaces with <ref column="type"/> of | |
a3173ee1 WT |
2624 | <code>geneve</code>, <code>gre</code>, <code>ip6gre</code>, |
2625 | <code>vxlan</code>, <code>lisp</code> and <code>stt</code>. | |
3fd8d445 BP |
2626 | </p> |
2627 | ||
2628 | <p> | |
2629 | Each tunnel must be uniquely identified by the combination of <ref | |
2630 | column="type"/>, <ref column="options" key="remote_ip"/>, <ref | |
2631 | column="options" key="local_ip"/>, and <ref column="options" | |
2632 | key="in_key"/>. If two ports are defined that are the same except one | |
2633 | has an optional identifier and the other does not, the more specific | |
2634 | one is matched first. <ref column="options" key="in_key"/> is | |
2635 | considered more specific than <ref column="options" key="local_ip"/> if | |
2636 | a port defines one and another port defines the other. | |
2637 | </p> | |
2638 | ||
2639 | <column name="options" key="remote_ip"> | |
0ad90c84 JR |
2640 | <p>Required. The remote tunnel endpoint, one of:</p> |
2641 | ||
2642 | <ul> | |
2643 | <li> | |
80c4589a | 2644 | An IPv4 or IPv6 address (not a DNS name), e.g. <code>192.168.0.123</code>. |
0ad90c84 JR |
2645 | Only unicast endpoints are supported. |
2646 | </li> | |
2647 | <li> | |
2648 | The word <code>flow</code>. The tunnel accepts packets from any | |
2649 | remote tunnel endpoint. To process only packets from a specific | |
2650 | remote tunnel endpoint, the flow entries may match on the | |
80c4589a PS |
2651 | <code>tun_src</code> or <code>tun_ipv6_src</code>field. When |
2652 | sending packets to a <code>remote_ip=flow</code> tunnel, the flow | |
2653 | actions must explicitly set the <code>tun_dst</code> or | |
2654 | <code>tun_ipv6_dst</code> field to the IP address of the desired | |
2655 | remote tunnel endpoint, e.g. with a <code>set_field</code> action. | |
0ad90c84 JR |
2656 | </li> |
2657 | </ul> | |
2658 | ||
2659 | <p> | |
039a8ccd BP |
2660 | The remote tunnel endpoint for any packet received from a tunnel |
2661 | is available in the <code>tun_src</code> field for matching in the | |
2662 | flow table. | |
0ad90c84 | 2663 | </p> |
3fd8d445 BP |
2664 | </column> |
2665 | ||
2666 | <column name="options" key="local_ip"> | |
0ad90c84 | 2667 | <p> |
7b243c30 QX |
2668 | Optional. The tunnel destination IP that received packets must match. |
2669 | Default is to match all addresses. If specified, may be one of: | |
0ad90c84 JR |
2670 | </p> |
2671 | ||
2672 | <ul> | |
2673 | <li> | |
80c4589a | 2674 | An IPv4/IPv6 address (not a DNS name), e.g. <code>192.168.12.3</code>. |
0ad90c84 JR |
2675 | </li> |
2676 | <li> | |
2677 | The word <code>flow</code>. The tunnel accepts packets sent to any | |
2678 | of the local IP addresses of the system running OVS. To process | |
2679 | only packets sent to a specific IP address, the flow entries may | |
80c4589a PS |
2680 | match on the <code>tun_dst</code> or <code>tun_ipv6_dst</code> field. |
2681 | When sending packets to a <code>local_ip=flow</code> tunnel, the flow | |
2682 | actions may explicitly set the <code>tun_src</code> or <code>tun_ipv6_src</code> | |
2683 | field to the desired IP address, e.g. with a <code>set_field</code> action. | |
2684 | However, while routing the tunneled packet out, the local system may | |
2685 | override the specified address with the local IP address configured for the | |
0ad90c84 JR |
2686 | outgoing system interface. |
2687 | ||
2688 | <p> | |
2689 | This option is valid only for tunnels also configured with the | |
2690 | <code>remote_ip=flow</code> option. | |
2691 | </p> | |
2692 | </li> | |
2693 | </ul> | |
2694 | ||
2695 | <p> | |
2696 | The tunnel destination IP address for any packet received from a | |
80c4589a PS |
2697 | tunnel is available in the <code>tun_dst</code> or <code>tun_ipv6_dst</code> |
2698 | field for matching in the flow table. | |
0ad90c84 | 2699 | </p> |
3fd8d445 BP |
2700 | </column> |
2701 | ||
2702 | <column name="options" key="in_key"> | |
2703 | <p>Optional. The key that received packets must contain, one of:</p> | |
2704 | ||
2705 | <ul> | |
2706 | <li> | |
2707 | <code>0</code>. The tunnel receives packets with no key or with a | |
2708 | key of 0. This is equivalent to specifying no <ref column="options" | |
2709 | key="in_key"/> at all. | |
2710 | </li> | |
2711 | <li> | |
271e6bc7 | 2712 | A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE) |
99e7b077 | 2713 | or 64-bit (for STT) number. The tunnel receives only |
4237026e | 2714 | packets with the specified key. |
3fd8d445 BP |
2715 | </li> |
2716 | <li> | |
2717 | The word <code>flow</code>. The tunnel accepts packets with any | |
2718 | key. The key will be placed in the <code>tun_id</code> field for | |
0f3a7416 BP |
2719 | matching in the flow table. The <code>ovs-fields</code>(7) manual |
2720 | page contains additional information about matching fields in | |
2721 | OpenFlow flows. | |
3fd8d445 BP |
2722 | </li> |
2723 | </ul> | |
2724 | ||
2725 | <p> | |
2726 | </p> | |
2727 | </column> | |
2728 | ||
2729 | <column name="options" key="out_key"> | |
2730 | <p>Optional. The key to be set on outgoing packets, one of:</p> | |
2731 | ||
2732 | <ul> | |
2733 | <li> | |
2734 | <code>0</code>. Packets sent through the tunnel will have no key. | |
2735 | This is equivalent to specifying no <ref column="options" | |
2736 | key="out_key"/> at all. | |
2737 | </li> | |
2738 | <li> | |
271e6bc7 | 2739 | A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or |
99e7b077 | 2740 | 64-bit (for STT) number. Packets sent through the tunnel |
4237026e | 2741 | will have the specified key. |
3fd8d445 BP |
2742 | </li> |
2743 | <li> | |
2744 | The word <code>flow</code>. Packets sent through the tunnel will | |
2745 | have the key set using the <code>set_tunnel</code> Nicira OpenFlow | |
2746 | vendor extension (0 is used in the absence of an action). The | |
0f3a7416 BP |
2747 | <code>ovs-fields</code>(7) manual page contains additional |
2748 | information about the Nicira OpenFlow vendor extensions. | |
3fd8d445 BP |
2749 | </li> |
2750 | </ul> | |
2751 | </column> | |
2752 | ||
fb9fdd72 | 2753 | <column name="options" key="dst_port"> |
3220b8a8 | 2754 | Optional. The tunnel transport layer destination port, for UDP and TCP |
fb9fdd72 | 2755 | based tunnel protocols (Geneve, VXLAN, LISP, and STT). |
2756 | </column> | |
2757 | ||
3fd8d445 BP |
2758 | <column name="options" key="key"> |
2759 | Optional. Shorthand to set <code>in_key</code> and | |
2760 | <code>out_key</code> at the same time. | |
2761 | </column> | |
2762 | ||
2763 | <column name="options" key="tos"> | |
2764 | Optional. The value of the ToS bits to be set on the encapsulating | |
749ae950 PS |
2765 | packet. ToS is interpreted as DSCP and ECN bits, ECN part must be |
2766 | zero. It may also be the word <code>inherit</code>, in which case | |
3fd8d445 BP |
2767 | the ToS will be copied from the inner packet if it is IPv4 or IPv6 |
2768 | (otherwise it will be 0). The ECN fields are always inherited. | |
2769 | Default is 0. | |
2770 | </column> | |
2771 | ||
2772 | <column name="options" key="ttl"> | |
2773 | Optional. The TTL to be set on the encapsulating packet. It may also | |
2774 | be the word <code>inherit</code>, in which case the TTL will be copied | |
2775 | from the inner packet if it is IPv4 or IPv6 (otherwise it will be the | |
2776 | system default, typically 64). Default is the system default TTL. | |
2777 | </column> | |
9cc6bf75 | 2778 | |
f9e5e5b3 BP |
2779 | <column name="options" key="df_default" |
2780 | type='{"type": "boolean"}'> | |
9b9f4d60 EJ |
2781 | Optional. If enabled, the Don't Fragment bit will be set on tunnel |
2782 | outer headers to allow path MTU discovery. Default is enabled; set | |
2783 | to <code>false</code> to disable. | |
3fd8d445 BP |
2784 | </column> |
2785 | ||
bf4bbd0d PS |
2786 | <column name="options" key="egress_pkt_mark"> |
2787 | Optional. The pkt_mark to be set on the encapsulating packet. This | |
2788 | option sets packet mark for the tunnel endpoint for all tunnel packets | |
2789 | including tunnel monitoring. | |
2790 | </column> | |
2791 | ||
875ab130 BP |
2792 | <group title="Tunnel Options: lisp only"> |
2793 | <column name="options" key="packet_type" | |
2794 | type='{"type": "string", "enum": ["set", | |
2795 | ["legacy_l3", "ptap"]]}'> | |
2796 | <p> | |
2797 | A LISP tunnel sends and receives only IPv4 and IPv6 packets. This | |
2798 | option controls what how the tunnel represents the packets that it | |
2799 | sends and receives: | |
2800 | </p> | |
2801 | ||
2802 | <ul> | |
2803 | <li> | |
2804 | By default, or if this option is <code>legacy_l3</code>, the | |
2805 | tunnel represents packets as Ethernet frames for compatibility | |
2806 | with legacy OpenFlow controllers that expect this behavior. | |
2807 | </li> | |
2808 | <li> | |
2809 | If this option is <code>ptap</code>, the tunnel represents | |
2810 | packets using the <code>packet_type</code> mechanism introduced | |
2811 | in OpenFlow 1.5. | |
2812 | </li> | |
2813 | </ul> | |
2814 | </column> | |
2815 | </group> | |
2816 | ||
526df7d8 TG |
2817 | <group title="Tunnel Options: vxlan only"> |
2818 | ||
039a8ccd BP |
2819 | <column name="options" key="exts"> |
2820 | <p>Optional. Comma separated list of optional VXLAN extensions to | |
2821 | enable. The following extensions are supported:</p> | |
526df7d8 | 2822 | |
039a8ccd BP |
2823 | <ul> |
2824 | <li> | |
2825 | <code>gbp</code>: VXLAN-GBP allows to transport the group policy | |
2826 | context of a packet across the VXLAN tunnel to other network | |
96fee5e0 BP |
2827 | peers. See the description of <code>tun_gbp_id</code> and |
2828 | <code>tun_gbp_flags</code> in <code>ovs-fields</code>(7) for | |
2829 | additional information. | |
039a8ccd BP |
2830 | (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>) |
2831 | </li> | |
439f39cb GS |
2832 | <li> |
2833 | <code>gpe</code>: Support for Generic Protocol Encapsulation in | |
2834 | accordance with IETF draft | |
2835 | <code>https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe</code>. | |
875ab130 BP |
2836 | Without this option, a VXLAN packet always encapsulates an |
2837 | Ethernet frame. With this option, an VXLAN packet may also | |
2838 | encapsulate an IPv4, IPv6, NSH, or MPLS packet. | |
439f39cb | 2839 | </li> |
039a8ccd BP |
2840 | </ul> |
2841 | </column> | |
526df7d8 | 2842 | |
875ab130 BP |
2843 | <column name="options" key="packet_type" |
2844 | type='{"type": "string", "enum": ["set", | |
2845 | ["legacy_l2", "legacy_l3", "ptap"]]}'> | |
439f39cb | 2846 | <p> |
875ab130 BP |
2847 | This option controls what types of packets the tunnel sends and |
2848 | receives and how it represents them: | |
439f39cb GS |
2849 | </p> |
2850 | ||
875ab130 BP |
2851 | <ul> |
2852 | <li> | |
2853 | By default, or if this option is <code>legacy_l2</code>, the | |
2854 | tunnel sends and receives only Ethernet frames. | |
2855 | </li> | |
2856 | <li> | |
2857 | If this option is <code>legacy_l3</code>, the tunnel sends and | |
2858 | receives only non-Ethernet (L3) packet, but the packets are | |
2859 | represented as Ethernet frames for compatibility with legacy | |
2860 | OpenFlow controllers that expect this behavior. This requires | |
2861 | enabling <code>gpe</code> in <ref column="options" key="exts"/>. | |
2862 | </li> | |
2863 | <li> | |
2864 | If this option is <code>ptap</code>, Open vSwitch represents | |
2865 | packets in the tunnel using the <code>packet_type</code> | |
2866 | mechanism introduced in OpenFlow 1.5. This mechanism supports | |
2867 | any kind of packet, but actually sending and receiving | |
2868 | non-Ethernet packets requires additionally enabling | |
2869 | <code>gpe</code> in <ref column="options" key="exts"/>. | |
2870 | </li> | |
2871 | </ul> | |
439f39cb | 2872 | </column> |
039a8ccd | 2873 | </group> |
526df7d8 | 2874 | |
63171f04 JS |
2875 | <group title="Tunnel Options: gre only"> |
2876 | <p> | |
2877 | <code>gre</code> interfaces support these options. | |
2878 | </p> | |
2879 | ||
875ab130 BP |
2880 | <column name="options" key="packet_type" |
2881 | type='{"type": "string", "enum": ["set", | |
2882 | ["legacy_l2", "legacy_l3", "ptap"]]}'> | |
63171f04 | 2883 | <p> |
875ab130 BP |
2884 | This option controls what types of packets the tunnel sends and |
2885 | receives and how it represents them: | |
63171f04 JS |
2886 | </p> |
2887 | ||
875ab130 BP |
2888 | <ul> |
2889 | <li> | |
2890 | By default, or if this option is <code>legacy_l2</code>, the | |
2891 | tunnel sends and receives only Ethernet frames. | |
2892 | </li> | |
2893 | <li> | |
2894 | If this option is <code>legacy_l3</code>, the tunnel sends and | |
2895 | receives only non-Ethernet (L3) packet, but the packets are | |
2896 | represented as Ethernet frames for compatibility with legacy | |
2897 | OpenFlow controllers that expect this behavior. | |
2898 | </li> | |
02775821 GR |
2899 | <li> |
2900 | The <code>legacy_l3</code> option is only available via the | |
2901 | user space datapath. The OVS kernel datapath does not support | |
2902 | devices of type ARPHRD_IPGRE which is the requirement for | |
2903 | <code>legacy_l3</code> type packets. | |
2904 | </li> | |
875ab130 BP |
2905 | <li> |
2906 | If this option is <code>ptap</code>, the tunnel sends and | |
2907 | receives any kind of packet. Open vSwitch represents packets in | |
2908 | the tunnel using the <code>packet_type</code> mechanism | |
2909 | introduced in OpenFlow 1.5. | |
2910 | </li> | |
2911 | </ul> | |
63171f04 | 2912 | </column> |
0ffff497 WT |
2913 | <column name="options" key="seq" type='{"type": "boolean"}'> |
2914 | <p> | |
2915 | Optional. A 4-byte sequence number field for GRE tunnel only. | |
2916 | Default is disabled, set to <code>true</code> to enable. | |
2917 | Sequence number is incremented by one on each outgoing packet. | |
2918 | </p> | |
2919 | </column> | |
63171f04 JS |
2920 | </group> |
2921 | ||
a3173ee1 | 2922 | <group title="Tunnel Options: gre, ip6gre, geneve, and vxlan"> |
3fd8d445 | 2923 | <p> |
a3173ee1 WT |
2924 | <code>gre</code>, <code>ip6gre</code>, <code>geneve</code>, |
2925 | and <code>vxlan</code> interfaces support these options. | |
3fd8d445 BP |
2926 | </p> |
2927 | ||
f9e5e5b3 | 2928 | <column name="options" key="csum" type='{"type": "boolean"}'> |
3fd8d445 | 2929 | <p> |
7b243c30 | 2930 | Optional. Compute encapsulation header (either GRE or UDP) |
4752cc0c JG |
2931 | checksums on outgoing packets. Default is disabled, set to |
2932 | <code>true</code> to enable. Checksums present on incoming | |
2933 | packets will be validated regardless of this setting. | |
039a8ccd | 2934 | </p> |
3fd8d445 | 2935 | |
4752cc0c JG |
2936 | <p> |
2937 | When using the upstream Linux kernel module, computation of | |
2938 | checksums for <code>geneve</code> and <code>vxlan</code> requires | |
a3173ee1 WT |
2939 | Linux kernel version 4.0 or higher. <code>gre</code> and |
2940 | <code>ip6gre</code> support checksums for all versions of | |
2941 | Open vSwitch that support GRE. | |
4752cc0c JG |
2942 | The out of tree kernel module distributed as part of OVS |
2943 | can compute all tunnel checksums on any kernel version that it | |
2944 | is compatible with. | |
3fd8d445 BP |
2945 | </p> |
2946 | ||
3fd8d445 BP |
2947 | </column> |
2948 | </group> | |
3fd8d445 | 2949 | |
7b243c30 QX |
2950 | <group title="Tunnel Options: IPsec"> |
2951 | <p> | |
2952 | Setting any of these options enables IPsec support for a given | |
a3173ee1 WT |
2953 | tunnel. <code>gre</code>, <code>ip6gre</code>, |
2954 | <code>geneve</code>, <code>vxlan</code> and <code>stt</code> | |
2955 | interfaces support these options. See the <code>IPsec</code> | |
2956 | section in the <ref table="Open_vSwitch"/> table for a description | |
2957 | of each mode. | |
7b243c30 QX |
2958 | </p> |
2959 | <column name="options" key="psk" type='{"type": "string"}'> | |
2960 | <p> | |
2961 | In PSK mode only, the preshared secret to negotiate tunnel. This | |
2962 | value must match on both tunnel ends. | |
2963 | </p> | |
2964 | </column> | |
2965 | <column name="options" key="remote_cert" type='{"type": "string"}'> | |
2966 | <p> | |
2967 | In self-signed certificate mode only, name of a PEM file | |
2968 | containing a certificate of the remote switch. The certificate | |
2969 | must be x.509 version 3 and with the string in common name (CN) | |
2970 | also set in the subject alternative name (SAN). | |
2971 | </p> | |
2972 | </column> | |
2973 | <column name="options" key="remote_name" type='{"type": "string"}'> | |
2974 | <p> | |
2975 | In CA-signed certificate mode only, common name (CN) of the remote | |
2976 | certificate. | |
2977 | </p> | |
2978 | </column> | |
2979 | </group> | |
2980 | </group> | |
7dc18ae9 WT |
2981 | <group title="Tunnel Options: erspan only"> |
2982 | <p> | |
2983 | Only <code>erspan</code> interfaces support these options. | |
2984 | </p> | |
2985 | <column name="options" key="erspan_idx"> | |
2986 | <p> | |
2987 | 20 bit index/port number associated with the ERSPAN traffic's | |
2988 | source port and direction (ingress/egress). This field is | |
2989 | platform dependent. | |
2990 | </p> | |
2991 | </column> | |
2992 | ||
2993 | <column name="options" key="erspan_ver"> | |
2994 | <p> | |
2995 | ERSPAN version: 1 for version 1 (type II) | |
2996 | or 2 for version 2 (type III). | |
2997 | </p> | |
2998 | </column> | |
2999 | ||
3000 | <column name="options" key="erspan_dir"> | |
3001 | <p> | |
3002 | Specifies the ERSPAN v2 mirrored traffic's direction. | |
3003 | 1 for egress traffic, and 0 for ingress traffic. | |
3004 | </p> | |
3005 | </column> | |
3006 | ||
3007 | <column name="options" key="erspan_hwid"> | |
3008 | <p> | |
3009 | ERSPAN hardware ID is a 6-bit unique identifier of an | |
3010 | ERSPAN v2 engine within a system. | |
3011 | </p> | |
3012 | </column> | |
3013 | </group> | |
3014 | ||
3fd8d445 BP |
3015 | <group title="Patch Options"> |
3016 | <p> | |
52f7b2cf BP |
3017 | These options apply only to <dfn>patch ports</dfn>, that is, interfaces |
3018 | whose <ref column="type"/> column is <code>patch</code>. Patch ports | |
3019 | are mainly a way to connect otherwise independent bridges to one | |
3020 | another, similar to how one might plug an Ethernet cable (a ``patch | |
3021 | cable'') into two physical switches to connect those switches. The | |
3022 | effect of plugging a patch port into two switches is conceptually | |
3023 | similar to that of plugging the two ends of a Linux <code>veth</code> | |
3024 | device into those switches, but the implementation of patch ports makes | |
3025 | them much more efficient. | |
3fd8d445 | 3026 | </p> |
89365653 | 3027 | |
52f7b2cf BP |
3028 | <p> |
3029 | Patch ports may connect two different bridges (the usual case) or the | |
3030 | same bridge. In the latter case, take special care to avoid loops, | |
3031 | e.g. by programming appropriate flows with OpenFlow. Patch ports do | |
3032 | not work if its ends are attached to bridges on different datapaths, | |
3033 | e.g. to connect bridges in <code>system</code> and <code>netdev</code> | |
3034 | datapaths. | |
3035 | </p> | |
3036 | ||
3037 | <p> | |
3038 | The following command creates and connects patch ports <code>p0</code> | |
3039 | and <code>p1</code> and adds them to bridges <code>br0</code> and | |
3040 | <code>br1</code>, respectively: | |
3041 | </p> | |
3042 | ||
3043 | <pre> | |
3044 | ovs-vsctl add-port br0 p0 -- set Interface p0 type=patch options:peer=p1 \ | |
3045 | -- add-port br1 p1 -- set Interface p1 type=patch options:peer=p0 | |
3046 | </pre> | |
3047 | ||
3fd8d445 BP |
3048 | <column name="options" key="peer"> |
3049 | The <ref column="name"/> of the <ref table="Interface"/> for the other | |
3050 | side of the patch. The named <ref table="Interface"/>'s own | |
3051 | <code>peer</code> option must specify this <ref table="Interface"/>'s | |
3052 | name. That is, the two patch interfaces must have reversed <ref | |
3053 | column="name"/> and <code>peer</code> values. | |
89365653 | 3054 | </column> |
e210037e AE |
3055 | </group> |
3056 | ||
a14b8947 IM |
3057 | <group title="PMD (Poll Mode Driver) Options"> |
3058 | <p> | |
3059 | Only PMD netdevs support these options. | |
3060 | </p> | |
3061 | ||
81acebda | 3062 | <column name="options" key="n_rxq" |
a14b8947 IM |
3063 | type='{"type": "integer", "minInteger": 1}'> |
3064 | <p> | |
3065 | Specifies the maximum number of rx queues to be created for PMD | |
3066 | netdev. If not specified or specified to 0, one rx queue will | |
3067 | be created by default. | |
81acebda | 3068 | Not supported by DPDK vHost interfaces. |
a14b8947 IM |
3069 | </p> |
3070 | </column> | |
3eb67853 | 3071 | |
55e075e6 CL |
3072 | <column name="options" key="dpdk-devargs" |
3073 | type='{"type": "string"}'> | |
3074 | <p> | |
69876ed7 CL |
3075 | Specifies the PCI address associated with the port for physical |
3076 | devices, or the virtual driver to be used for the port when a virtual | |
3077 | PMD is intended to be used. For the latter, the argument string | |
b132189d CL |
3078 | typically takes the form of |
3079 | <code>eth_<var>driver_name</var><var>x</var></code>, where | |
3080 | <var>driver_name</var> is a valid virtual DPDK PMD driver name and | |
3081 | <var>x</var> is a unique identifier of your choice for the given | |
3082 | port. Only supported by the dpdk port type. | |
55e075e6 CL |
3083 | </p> |
3084 | </column> | |
3085 | ||
3eb67853 IM |
3086 | <column name="other_config" key="pmd-rxq-affinity"> |
3087 | <p>Specifies mapping of RX queues of this interface to CPU cores.</p> | |
3088 | <p>Value should be set in the following form:</p> | |
3089 | <p> | |
3090 | <code>other_config:pmd-rxq-affinity=<rxq-affinity-list></code> | |
3091 | </p> | |
3092 | <p>where</p> | |
3093 | <p> | |
3094 | <ul> | |
3095 | <li> | |
3096 | <rxq-affinity-list> ::= NULL | <non-empty-list> | |
3097 | </li> | |
3098 | <li> | |
3099 | <non-empty-list> ::= <affinity-pair> | | |
3100 | <affinity-pair> , <non-empty-list> | |
3101 | </li> | |
3102 | <li> | |
3103 | <affinity-pair> ::= <queue-id> : <core-id> | |
3104 | </li> | |
3105 | </ul> | |
3106 | </p> | |
3107 | </column> | |
c1ff66ac | 3108 | |
0de1b425 WT |
3109 | <column name="other_config" key="xdpmode" |
3110 | type='{"type": "string", | |
3111 | "enum": ["set", ["skb", "drv"]]}'> | |
3112 | <p> | |
3113 | Specifies the operational mode of the XDP program. | |
3114 | If "drv", the XDP program is loaded into the device driver with | |
3115 | zero-copy RX and TX enabled. This mode requires device driver with | |
3116 | AF_XDP support and has the best performance. | |
3117 | If "skb", the XDP program is using generic XDP mode in kernel with | |
3118 | extra data copying between userspace and kernel. No device driver | |
3119 | support is needed. Note that this is afxdp netdev type only. | |
3120 | Defaults to "skb" mode. | |
3121 | </p> | |
3122 | </column> | |
3123 | ||
c1ff66ac CL |
3124 | <column name="options" key="vhost-server-path" |
3125 | type='{"type": "string"}'> | |
3126 | <p> | |
2d24d165 CL |
3127 | The value specifies the path to the socket associated with a vHost |
3128 | User client mode device that has been or will be created by QEMU. | |
3129 | Only supported by dpdkvhostuserclient interfaces. | |
c1ff66ac CL |
3130 | </p> |
3131 | </column> | |
b685696b | 3132 | |
10087cba CL |
3133 | <column name="options" key="dq-zero-copy" |
3134 | type='{"type": "boolean"}'> | |
3135 | <p> | |
3136 | The value specifies whether or not to enable dequeue zero copy on | |
3137 | the given interface. | |
3138 | Must be set before vhost-server-path is specified. | |
3139 | Only supported by dpdkvhostuserclient interfaces. | |
3140 | The feature is considered experimental. | |
3141 | </p> | |
3142 | </column> | |
3143 | ||
080f080c KT |
3144 | <column name="options" key="tx-retries-max" |
3145 | type='{"type": "integer", "minInteger": 0, "maxInteger": 32}'> | |
3146 | <p> | |
3147 | The value specifies the maximum amount of vhost tx retries that can | |
3148 | be made while trying to send a batch of packets to an interface. | |
3149 | Only supported by dpdkvhostuserclient interfaces. | |
3150 | </p> | |
3151 | <p> | |
3152 | Default value is 8. | |
3153 | </p> | |
3154 | </column> | |
3155 | ||
b685696b CL |
3156 | <column name="options" key="n_rxq_desc" |
3157 | type='{"type": "integer", "minInteger": 1, "maxInteger": 4096}'> | |
3158 | <p> | |
3159 | Specifies the rx queue size (number rx descriptors) for dpdk ports. | |
3160 | The value must be a power of 2, less than 4096 and supported | |
3161 | by the hardware of the device being configured. | |
3162 | If not specified or an incorrect value is specified, 2048 rx | |
3163 | descriptors will be used by default. | |
3164 | </p> | |
3165 | </column> | |
3166 | ||
3167 | <column name="options" key="n_txq_desc" | |
3168 | type='{"type": "integer", "minInteger": 1, "maxInteger": 4096}'> | |
3169 | <p> | |
3170 | Specifies the tx queue size (number tx descriptors) for dpdk ports. | |
3171 | The value must be a power of 2, less than 4096 and supported | |
3172 | by the hardware of the device being configured. | |
3173 | If not specified or an incorrect value is specified, 2048 tx | |
3174 | descriptors will be used by default. | |
3175 | </p> | |
3176 | </column> | |
a14b8947 IM |
3177 | </group> |
3178 | ||
2fbadeb6 IM |
3179 | <group title="EMC (Exact Match Cache) Configuration"> |
3180 | <p> | |
3181 | These settings controls behaviour of EMC lookups/insertions for packets | |
3182 | received from the interface. | |
3183 | </p> | |
3184 | ||
3185 | <column name="other_config" key="emc-enable" type='{"type": "boolean"}'> | |
3186 | <p> | |
3187 | Specifies if Exact Match Cache (EMC) should be used while processing | |
3188 | packets received from this interface. | |
3189 | If true, <ref table="Open_vSwitch" column="other_config" | |
3190 | key="emc-insert-inv-prob"/> will have effect on this interface. | |
3191 | </p> | |
3192 | <p> | |
3193 | Defaults to true. | |
3194 | </p> | |
3195 | </column> | |
3196 | </group> | |
3197 | ||
56abcf49 DDP |
3198 | <group title="MTU"> |
3199 | <p> | |
3200 | The MTU (maximum transmission unit) is the largest amount of data | |
3201 | that can fit into a single Ethernet frame. The standard Ethernet | |
3202 | MTU is 1500 bytes. Some physical media and many kinds of virtual | |
3203 | interfaces can be configured with higher MTUs. | |
3204 | </p> | |
3205 | ||
3206 | <p> | |
3a414a0a DDP |
3207 | A client may change an interface MTU by filling in |
3208 | <ref column="mtu_request"/>. Open vSwitch then reports in | |
3209 | <ref column="mtu"/> the currently configured value. | |
56abcf49 DDP |
3210 | </p> |
3211 | ||
3212 | <column name="mtu"> | |
3a414a0a DDP |
3213 | <p> |
3214 | The currently configured MTU for the interface. | |
3215 | </p> | |
3216 | ||
56abcf49 DDP |
3217 | <p> |
3218 | This column will be empty for an interface that does not | |
3219 | have an MTU as, for example, some kinds of tunnels do not. | |
3220 | </p> | |
3221 | ||
3222 | <p> | |
3223 | Open vSwitch sets this column's value, so other clients should treat | |
3224 | it as read-only. | |
3225 | </p> | |
3226 | </column> | |
3227 | ||
3228 | <column name="mtu_request" | |
3229 | type='{"type": "integer", "minInteger": 1}'> | |
3230 | <p> | |
3231 | Requested MTU (Maximum Transmission Unit) for the interface. A client | |
3a414a0a DDP |
3232 | can fill this column to change the MTU of an interface. |
3233 | </p> | |
3234 | ||
06ca9597 | 3235 | <p> |
3236 | RFC 791 requires every internet module to be able to forward a | |
3237 | datagram of 68 octets without further fragmentation. The maximum | |
3238 | size of an IP packet is 65535 bytes. | |
3239 | </p> | |
3240 | ||
3a414a0a DDP |
3241 | <p> |
3242 | If this is not set and if the interface has <code>internal</code> | |
3243 | type, Open vSwitch will change the MTU to match the minimum of the | |
3244 | other interfaces in the bridge. | |
56abcf49 DDP |
3245 | </p> |
3246 | </column> | |
3247 | ||
3248 | </group> | |
3249 | ||
e210037e AE |
3250 | <group title="Interface Status"> |
3251 | <p> | |
3252 | Status information about interfaces attached to bridges, updated every | |
3253 | 5 seconds. Not all interfaces have all of these properties; virtual | |
3254 | interfaces don't have a link speed, for example. Non-applicable | |
3255 | columns will have empty values. | |
3256 | </p> | |
3257 | <column name="admin_state"> | |
3258 | <p> | |
3259 | The administrative state of the physical network link. | |
3260 | </p> | |
3261 | </column> | |
3262 | ||
3263 | <column name="link_state"> | |
3264 | <p> | |
0b8024eb BP |
3265 | The observed state of the physical network link. This is ordinarily |
3266 | the link's carrier status. If the interface's <ref table="Port"/> is | |
3267 | a bond configured for miimon monitoring, it is instead the network | |
3268 | link's miimon status. | |
e210037e AE |
3269 | </p> |
3270 | </column> | |
3271 | ||
65c3058c EJ |
3272 | <column name="link_resets"> |
3273 | <p> | |
3274 | The number of times Open vSwitch has observed the | |
3275 | <ref column="link_state"/> of this <ref table="Interface"/> change. | |
3276 | </p> | |
3277 | </column> | |
3278 | ||
e210037e AE |
3279 | <column name="link_speed"> |
3280 | <p> | |
3281 | The negotiated speed of the physical network link. | |
3282 | Valid values are positive integers greater than 0. | |
3283 | </p> | |
3284 | </column> | |
3285 | ||
3286 | <column name="duplex"> | |
3287 | <p> | |
3288 | The duplex mode of the physical network link. | |
3289 | </p> | |
3290 | </column> | |
3291 | ||
3fd8d445 BP |
3292 | <column name="lacp_current"> |
3293 | Boolean value indicating LACP status for this interface. If true, this | |
3294 | interface has current LACP information about its LACP partner. This | |
3295 | information may be used to monitor the health of interfaces in a LACP | |
3296 | enabled port. This column will be empty if LACP is not enabled. | |
3297 | </column> | |
3298 | ||
573c1db9 | 3299 | <column name="status"> |
3fd8d445 BP |
3300 | Key-value pairs that report port status. Supported status values are |
3301 | <ref column="type"/>-dependent; some interfaces may not have a valid | |
3302 | <ref column="status" key="driver_name"/>, for example. | |
3303 | </column> | |
3304 | ||
3305 | <column name="status" key="driver_name"> | |
3306 | The name of the device driver controlling the network adapter. | |
3307 | </column> | |
3308 | ||
3309 | <column name="status" key="driver_version"> | |
3310 | The version string of the device driver controlling the network | |
3311 | adapter. | |
3312 | </column> | |
3313 | ||
3314 | <column name="status" key="firmware_version"> | |
3315 | The version string of the network adapter's firmware, if available. | |
3316 | </column> | |
3317 | ||
3318 | <column name="status" key="source_ip"> | |
80c4589a | 3319 | The source IP address used for an IPv4/IPv6 tunnel end-point, such as |
09538fdc | 3320 | <code>gre</code>. |
573c1db9 | 3321 | </column> |
3fd8d445 BP |
3322 | |
3323 | <column name="status" key="tunnel_egress_iface"> | |
271e6bc7 JG |
3324 | Egress interface for tunnels. Currently only relevant for tunnels |
3325 | on Linux systems, this column will show the name of the interface | |
09538fdc PS |
3326 | which is responsible for routing traffic destined for the configured |
3327 | <ref column="options" key="remote_ip"/>. This could be an internal | |
3328 | interface such as a bridge port. | |
3fd8d445 BP |
3329 | </column> |
3330 | ||
f9e5e5b3 BP |
3331 | <column name="status" key="tunnel_egress_iface_carrier" |
3332 | type='{"type": "string", "enum": ["set", ["down", "up"]]}'> | |
3333 | Whether carrier is detected on <ref column="status" | |
3334 | key="tunnel_egress_iface"/>. | |
3fd8d445 | 3335 | </column> |
3eb8d4fa MW |
3336 | |
3337 | <group title="dpdk"> | |
3338 | <p> | |
3339 | DPDK specific interface status options. | |
3340 | </p> | |
3341 | ||
3342 | <column name="status" key="port_no"> | |
3343 | DPDK port ID. | |
3344 | </column> | |
3345 | ||
3346 | <column name="status" key="numa_id"> | |
3347 | NUMA socket ID to which an Ethernet device is connected. | |
3348 | </column> | |
3349 | ||
3350 | <column name="status" key="min_rx_bufsize"> | |
3351 | Minimum size of RX buffer. | |
3352 | </column> | |
3353 | ||
3354 | <column name="status" key="max_rx_pktlen"> | |
3355 | Maximum configurable length of RX pkt. | |
3356 | </column> | |
3357 | ||
3358 | <column name="status" key="max_rx_queues"> | |
3359 | Maximum number of RX queues. | |
3360 | </column> | |
3361 | ||
3362 | <column name="status" key="max_tx_queues"> | |
3363 | Maximum number of TX queues. | |
3364 | </column> | |
3365 | ||
3366 | <column name="status" key="max_mac_addrs"> | |
3367 | Maximum number of MAC addresses. | |
3368 | </column> | |
3369 | ||
3370 | <column name="status" key="max_hash_mac_addrs"> | |
3371 | Maximum number of hash MAC addresses for MTA and UTA. | |
3372 | </column> | |
3373 | ||
3374 | <column name="status" key="max_vfs"> | |
3375 | Maximum number of hash MAC addresses for MTA and UTA. | |
3376 | Maximum number of VFs. | |
3377 | </column> | |
3378 | ||
3379 | <column name="status" key="max_vmdq_pools"> | |
3380 | Maximum number of VMDq pools. | |
3381 | </column> | |
3382 | ||
3383 | <column name="status" key="if_type"> | |
3384 | Interface type ID according to IANA ifTYPE MIB definitions. | |
3385 | </column> | |
3386 | ||
3387 | <column name="status" key="if_descr"> | |
3388 | Interface description string. | |
3389 | </column> | |
3390 | ||
3391 | <column name="status" key="pci-vendor_id"> | |
3392 | Vendor ID of PCI device. | |
3393 | </column> | |
3394 | ||
3395 | <column name="status" key="pci-device_id"> | |
3396 | Device ID of PCI device. | |
3397 | </column> | |
3398 | ||
3399 | </group> | |
3fd8d445 BP |
3400 | </group> |
3401 | ||
3402 | <group title="Statistics"> | |
3403 | <p> | |
3404 | Key-value pairs that report interface statistics. The current | |
12eb035b AW |
3405 | implementation updates these counters periodically. The update period |
3406 | is controlled by <ref column="other_config" | |
3407 | key="stats-update-interval"/> in the <code>Open_vSwitch</code> table. | |
3408 | Future implementations may update them when an interface is created, | |
3409 | when they are queried (e.g. using an OVSDB <code>select</code> | |
3410 | operation), and just before an interface is deleted due to virtual | |
3411 | interface hot-unplug or VM shutdown, and perhaps at other times, but | |
3412 | not on any regular periodic basis. | |
3fd8d445 BP |
3413 | </p> |
3414 | <p> | |
3415 | These are the same statistics reported by OpenFlow in its <code>struct | |
3416 | ofp_port_stats</code> structure. If an interface does not support a | |
3417 | given statistic, then that pair is omitted. | |
3418 | </p> | |
3419 | <group title="Statistics: Successful transmit and receive counters"> | |
3420 | <column name="statistics" key="rx_packets"> | |
3421 | Number of received packets. | |
3422 | </column> | |
3423 | <column name="statistics" key="rx_bytes"> | |
3424 | Number of received bytes. | |
3425 | </column> | |
3426 | <column name="statistics" key="tx_packets"> | |
3427 | Number of transmitted packets. | |
3428 | </column> | |
3429 | <column name="statistics" key="tx_bytes"> | |
3430 | Number of transmitted bytes. | |
3431 | </column> | |
3432 | </group> | |
3433 | <group title="Statistics: Receive errors"> | |
3434 | <column name="statistics" key="rx_dropped"> | |
3435 | Number of packets dropped by RX. | |
3436 | </column> | |
3437 | <column name="statistics" key="rx_frame_err"> | |
3438 | Number of frame alignment errors. | |
3439 | </column> | |
3440 | <column name="statistics" key="rx_over_err"> | |
3441 | Number of packets with RX overrun. | |
3442 | </column> | |
3443 | <column name="statistics" key="rx_crc_err"> | |
3444 | Number of CRC errors. | |
3445 | </column> | |
3446 | <column name="statistics" key="rx_errors"> | |
3447 | Total number of receive errors, greater than or equal to the sum of | |
3448 | the above. | |
3449 | </column> | |
9cc6bf75 | 3450 | </group> |
3fd8d445 BP |
3451 | <group title="Statistics: Transmit errors"> |
3452 | <column name="statistics" key="tx_dropped"> | |
3453 | Number of packets dropped by TX. | |
3454 | </column> | |
3455 | <column name="statistics" key="collisions"> | |
3456 | Number of collisions. | |
3457 | </column> | |
3458 | <column name="statistics" key="tx_errors"> | |
3459 | Total number of transmit errors, greater than or equal to the sum of | |
3460 | the above. | |
3461 | </column> | |
3462 | </group> | |
89365653 BP |
3463 | </group> |
3464 | ||
3465 | <group title="Ingress Policing"> | |
3f5d8c02 BP |
3466 | <p> |
3467 | These settings control ingress policing for packets received on this | |
3468 | interface. On a physical interface, this limits the rate at which | |
3469 | traffic is allowed into the system from the outside; on a virtual | |
3470 | interface (one connected to a virtual machine), this limits the rate at | |
3471 | which the VM is able to transmit. | |
3472 | </p> | |
3473 | <p> | |
3474 | Policing is a simple form of quality-of-service that simply drops | |
3475 | packets received in excess of the configured rate. Due to its | |
3476 | simplicity, policing is usually less accurate and less effective than | |
3477 | egress QoS (which is configured using the <ref table="QoS"/> and <ref | |
3478 | table="Queue"/> tables). | |
3479 | </p> | |
3480 | <p> | |
9509913a IS |
3481 | Policing is currently implemented on Linux and OVS with DPDK. Both |
3482 | implementations use a simple ``token bucket'' approach: | |
3f5d8c02 BP |
3483 | </p> |
3484 | <ul> | |
3485 | <li> | |
3486 | The size of the bucket corresponds to <ref | |
3487 | column="ingress_policing_burst"/>. Initially the bucket is full. | |
3488 | </li> | |
3489 | <li> | |
3490 | Whenever a packet is received, its size (converted to tokens) is | |
3491 | compared to the number of tokens currently in the bucket. If the | |
3492 | required number of tokens are available, they are removed and the | |
3493 | packet is forwarded. Otherwise, the packet is dropped. | |
3494 | </li> | |
3495 | <li> | |
3496 | Whenever it is not full, the bucket is refilled with tokens at the | |
3497 | rate specified by <ref column="ingress_policing_rate"/>. | |
3498 | </li> | |
3499 | </ul> | |
3500 | <p> | |
3501 | Policing interacts badly with some network protocols, and especially | |
3502 | with fragmented IP packets. Suppose that there is enough network | |
3503 | activity to keep the bucket nearly empty all the time. Then this token | |
3504 | bucket algorithm will forward a single packet every so often, with the | |
3505 | period depending on packet size and on the configured rate. All of the | |
3506 | fragments of an IP packets are normally transmitted back-to-back, as a | |
3507 | group. In such a situation, therefore, only one of these fragments | |
3508 | will be forwarded and the rest will be dropped. IP does not provide | |
3509 | any way for the intended recipient to ask for only the remaining | |
3510 | fragments. In such a case there are two likely possibilities for what | |
3511 | will happen next: either all of the fragments will eventually be | |
3512 | retransmitted (as TCP will do), in which case the same problem will | |
3513 | recur, or the sender will not realize that its packet has been dropped | |
3514 | and data will simply be lost (as some UDP-based protocols will do). | |
3515 | Either way, it is possible that no forward progress will ever occur. | |
3516 | </p> | |
3517 | <column name="ingress_policing_rate"> | |
3518 | <p> | |
3519 | Maximum rate for data received on this interface, in kbps. Data | |
3520 | received faster than this rate is dropped. Set to <code>0</code> | |
3521 | (the default) to disable policing. | |
3522 | </p> | |
3523 | </column> | |
3524 | ||
89365653 BP |
3525 | <column name="ingress_policing_burst"> |
3526 | <p>Maximum burst size for data received on this interface, in kb. The | |
79abacc8 | 3527 | default burst size if set to <code>0</code> is 8000 kbit. This value |
3fd8d445 BP |
3528 | has no effect if <ref column="ingress_policing_rate"/> |
3529 | is <code>0</code>.</p> | |
3f5d8c02 BP |
3530 | <p> |
3531 | Specifying a larger burst size lets the algorithm be more forgiving, | |
3532 | which is important for protocols like TCP that react severely to | |
3533 | dropped packets. The burst size should be at least the size of the | |
3534 | interface's MTU. Specifying a value that is numerically at least as | |
79abacc8 | 3535 | large as 80% of <ref column="ingress_policing_rate"/> helps TCP come |
3f5d8c02 BP |
3536 | closer to achieving the full rate. |
3537 | </p> | |
89365653 BP |
3538 | </column> |
3539 | </group> | |
3540 | ||
ccc09689 | 3541 | <group title="Bidirectional Forwarding Detection (BFD)"> |
e58855ec | 3542 | <p> |
039a8ccd BP |
3543 | BFD, defined in RFC 5880 and RFC 5881, allows point-to-point |
3544 | detection of connectivity failures by occasional transmission of | |
3545 | BFD control messages. Open vSwitch implements BFD to serve | |
3546 | as a more popular and standards compliant alternative to CFM. | |
e58855ec | 3547 | </p> |
ccc09689 | 3548 | |
e58855ec | 3549 | <p> |
039a8ccd BP |
3550 | BFD operates by regularly transmitting BFD control messages at a rate |
3551 | negotiated independently in each direction. Each endpoint specifies | |
3552 | the rate at which it expects to receive control messages, and the rate | |
4cefc3da SG |
3553 | at which it is willing to transmit them. By default, Open vSwitch uses |
3554 | a detection multiplier of three, meaning that an endpoint signals a | |
3555 | connectivity fault if three consecutive BFD control messages fail to | |
3556 | arrive. In the case of a unidirectional connectivity issue, the system | |
3557 | not receiving BFD control messages signals the problem to its peer in | |
3558 | the messages it transmits. | |
e58855ec | 3559 | </p> |
ccc09689 | 3560 | |
e58855ec | 3561 | <p> |
039a8ccd BP |
3562 | The Open vSwitch implementation of BFD aims to comply faithfully |
3563 | with RFC 5880 requirements. Open vSwitch does not implement the | |
3564 | optional Authentication or ``Echo Mode'' features. | |
e58855ec | 3565 | </p> |
ccc09689 | 3566 | |
e58855ec | 3567 | <group title="BFD Configuration"> |
039a8ccd BP |
3568 | <p> |
3569 | A controller sets up key-value pairs in the <ref column="bfd"/> | |
3570 | column to enable and configure BFD. | |
3571 | </p> | |
e58855ec | 3572 | |
039a8ccd | 3573 | <column name="bfd" key="enable" type='{"type": "boolean"}'> |
f7491dce AW |
3574 | True to enable BFD on this <ref table="Interface"/>. If not |
3575 | specified, BFD will not be enabled by default. | |
039a8ccd | 3576 | </column> |
e58855ec | 3577 | |
039a8ccd BP |
3578 | <column name="bfd" key="min_rx" |
3579 | type='{"type": "integer", "minInteger": 1}'> | |
e58855ec BP |
3580 | The shortest interval, in milliseconds, at which this BFD session |
3581 | offers to receive BFD control messages. The remote endpoint may | |
3582 | choose to send messages at a slower rate. Defaults to | |
3583 | <code>1000</code>. | |
039a8ccd | 3584 | </column> |
e58855ec | 3585 | |
039a8ccd BP |
3586 | <column name="bfd" key="min_tx" |
3587 | type='{"type": "integer", "minInteger": 1}'> | |
e58855ec BP |
3588 | The shortest interval, in milliseconds, at which this BFD session is |
3589 | willing to transmit BFD control messages. Messages will actually be | |
3590 | transmitted at a slower rate if the remote endpoint is not willing to | |
3591 | receive as quickly as specified. Defaults to <code>100</code>. | |
039a8ccd BP |
3592 | </column> |
3593 | ||
3594 | <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'> | |
3595 | An alternate receive interval, in milliseconds, that must be greater | |
3596 | than or equal to <ref column="bfd" key="min_rx"/>. The | |
3597 | implementation switches from <ref column="bfd" key="min_rx"/> to <ref | |
3598 | column="bfd" key="decay_min_rx"/> when there is no obvious incoming | |
3599 | data traffic at the interface, to reduce the CPU and bandwidth cost | |
3600 | of monitoring an idle interface. This feature may be disabled by | |
3601 | setting a value of 0. This feature is reset whenever <ref | |
3602 | column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/> | |
3603 | changes. | |
3604 | </column> | |
3605 | ||
3606 | <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'> | |
34c88624 AW |
3607 | When <code>true</code>, traffic received on the |
3608 | <ref table="Interface"/> is used to indicate the capability of packet | |
3609 | I/O. BFD control packets are still transmitted and received. At | |
3610 | least one BFD control packet must be received every 100 * <ref | |
3611 | column="bfd" key="min_rx"/> amount of time. Otherwise, even if | |
3612 | traffic are received, the <ref column="bfd" key="forwarding"/> | |
3613 | will be <code>false</code>. | |
039a8ccd | 3614 | </column> |
e58855ec | 3615 | |
039a8ccd BP |
3616 | <column name="bfd" key="cpath_down" type='{"type": "boolean"}'> |
3617 | Set to true to notify the remote endpoint that traffic should not be | |
3618 | forwarded to this system for some reason other than a connectivty | |
3619 | failure on the interface being monitored. The typical underlying | |
3620 | reason is ``concatenated path down,'' that is, that connectivity | |
3621 | beyond the local system is down. Defaults to false. | |
3622 | </column> | |
e58855ec | 3623 | |
039a8ccd | 3624 | <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'> |
e58855ec BP |
3625 | Set to true to make BFD accept only control messages with a tunnel |
3626 | key of zero. By default, BFD accepts control messages with any | |
3627 | tunnel key. | |
039a8ccd BP |
3628 | </column> |
3629 | ||
3630 | <column name="bfd" key="bfd_local_src_mac"> | |
3631 | Set to an Ethernet address in the form | |
3632 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var> | |
3633 | to set the MAC used as source for transmitted BFD packets. The | |
3634 | default is the mac address of the BFD enabled interface. | |
3635 | </column> | |
3636 | ||
3637 | <column name="bfd" key="bfd_local_dst_mac"> | |
3638 | Set to an Ethernet address in the form | |
3639 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var> | |
3640 | to set the MAC used as destination for transmitted BFD packets. The | |
3641 | default is <code>00:23:20:00:00:01</code>. | |
3642 | </column> | |
3643 | ||
3644 | <column name="bfd" key="bfd_remote_dst_mac"> | |
3645 | Set to an Ethernet address in the form | |
3646 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var> | |
3647 | to set the MAC used for checking the destination of received BFD packets. | |
3648 | Packets with different destination MAC will not be considered as BFD packets. | |
3649 | If not specified the destination MAC address of received BFD packets | |
3650 | are not checked. | |
3651 | </column> | |
3652 | ||
3653 | <column name="bfd" key="bfd_src_ip"> | |
dfe37e6a | 3654 | Set to an IPv4 address to set the IP address used as source for |
1314739c | 3655 | transmitted BFD packets. The default is <code>169.254.1.1</code>. |
039a8ccd | 3656 | </column> |
dfe37e6a | 3657 | |
039a8ccd | 3658 | <column name="bfd" key="bfd_dst_ip"> |
dfe37e6a | 3659 | Set to an IPv4 address to set the IP address used as destination |
1314739c | 3660 | for transmitted BFD packets. The default is <code>169.254.1.0</code>. |
039a8ccd | 3661 | </column> |
2eb79142 JG |
3662 | |
3663 | <column name="bfd" key="oam"> | |
3664 | Some tunnel protocols (such as Geneve) include a bit in the header | |
3665 | to indicate that the encapsulated packet is an OAM frame. By setting | |
3666 | this to true, BFD packets will be marked as OAM if encapsulated in | |
3667 | one of these tunnels. | |
3668 | </column> | |
4cefc3da SG |
3669 | |
3670 | <column name="bfd" key="mult" | |
3671 | type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'> | |
3672 | The BFD detection multiplier, which defaults to 3. An endpoint | |
3673 | signals a connectivity fault if the given number of consecutive BFD | |
3674 | control messages fail to arrive. | |
3675 | </column> | |
e58855ec | 3676 | </group> |
ccc09689 | 3677 | |
e58855ec | 3678 | <group title="BFD Status"> |
039a8ccd BP |
3679 | <p> |
3680 | The switch sets key-value pairs in the <ref column="bfd_status"/> | |
3681 | column to report the status of BFD on this interface. When BFD is | |
3682 | not enabled, with <ref column="bfd" key="enable"/>, the switch clears | |
3683 | all key-value pairs from <ref column="bfd_status"/>. | |
3684 | </p> | |
3685 | ||
3686 | <column name="bfd_status" key="state" | |
3687 | type='{"type": "string", | |
3688 | "enum": ["set", ["admin_down", "down", "init", "up"]]}'> | |
3689 | Reports the state of the BFD session. The BFD session is fully | |
3690 | healthy and negotiated if <code>UP</code>. | |
3691 | </column> | |
3692 | ||
3693 | <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'> | |
3694 | Reports whether the BFD session believes this <ref | |
3695 | table="Interface"/> may be used to forward traffic. Typically this | |
3696 | means the local session is signaling <code>UP</code>, and the remote | |
3697 | system isn't signaling a problem such as concatenated path down. | |
3698 | </column> | |
3699 | ||
3700 | <column name="bfd_status" key="diagnostic"> | |
60a15922 AZ |
3701 | A diagnostic code specifying the local system's reason for the |
3702 | last change in session state. The error messages are defined in | |
3703 | section 4.1 of [RFC 5880]. | |
039a8ccd BP |
3704 | </column> |
3705 | ||
3706 | <column name="bfd_status" key="remote_state" | |
3707 | type='{"type": "string", | |
3708 | "enum": ["set", ["admin_down", "down", "init", "up"]]}'> | |
3709 | Reports the state of the remote endpoint's BFD session. | |
3710 | </column> | |
3711 | ||
3712 | <column name="bfd_status" key="remote_diagnostic"> | |
60a15922 AZ |
3713 | A diagnostic code specifying the remote system's reason for the |
3714 | last change in session state. The error messages are defined in | |
3715 | section 4.1 of [RFC 5880]. | |
039a8ccd | 3716 | </column> |
4905e2df AW |
3717 | |
3718 | <column name="bfd_status" key="flap_count" | |
039a8ccd | 3719 | type='{"type": "integer", "minInteger": 0}'> |
4905e2df AW |
3720 | Counts the number of <ref column="bfd_status" key="forwarding" /> |
3721 | flaps since start. A flap is considered as a change of the | |
3722 | <ref column="bfd_status" key="forwarding" /> value. | |
3723 | </column> | |
e58855ec | 3724 | </group> |
ccc09689 EJ |
3725 | </group> |
3726 | ||
93b8df38 EJ |
3727 | <group title="Connectivity Fault Management"> |
3728 | <p> | |
3729 | 802.1ag Connectivity Fault Management (CFM) allows a group of | |
3730 | Maintenance Points (MPs) called a Maintenance Association (MA) to | |
3731 | detect connectivity problems with each other. MPs within a MA should | |
3732 | have complete and exclusive interconnectivity. This is verified by | |
3733 | occasionally broadcasting Continuity Check Messages (CCMs) at a | |
3734 | configurable transmission interval. | |
3735 | </p> | |
3736 | ||
144216a3 EJ |
3737 | <p> |
3738 | According to the 802.1ag specification, each Maintenance Point should | |
3739 | be configured out-of-band with a list of Remote Maintenance Points it | |
3740 | should have connectivity to. Open vSwitch differs from the | |
3741 | specification in this area. It simply assumes the link is faulted if | |
3742 | no Remote Maintenance Points are reachable, and considers it not | |
3743 | faulted otherwise. | |
3744 | </p> | |
3745 | ||
b363bae4 | 3746 | <p> |
039a8ccd BP |
3747 | When operating over tunnels which have no <code>in_key</code>, or an |
3748 | <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs | |
3749 | with a tunnel key of zero. | |
b363bae4 EJ |
3750 | </p> |
3751 | ||
93b8df38 | 3752 | <column name="cfm_mpid"> |
b1a6083a AW |
3753 | <p> |
3754 | A Maintenance Point ID (MPID) uniquely identifies each endpoint | |
3755 | within a Maintenance Association. The MPID is used to identify this | |
3756 | endpoint to other Maintenance Points in the MA. Each end of a link | |
3757 | being monitored should have a different MPID. Must be configured to | |
3758 | enable CFM on this <ref table="Interface"/>. | |
3759 | </p> | |
3760 | <p> | |
3761 | According to the 802.1ag specification, MPIDs can only range between | |
3762 | [1, 8191]. However, extended mode (see <ref column="other_config" | |
3763 | key="cfm_extended"/>) supports eight byte MPIDs. | |
3764 | </p> | |
93b8df38 | 3765 | </column> |
b31bcf60 | 3766 | |
76c4290d AW |
3767 | <column name="cfm_flap_count"> |
3768 | Counts the number of cfm fault flapps since boot. A flap is | |
3769 | considered to be a change of the <ref column="cfm_fault"/> value. | |
3770 | </column> | |
3771 | ||
93b8df38 | 3772 | <column name="cfm_fault"> |
144216a3 EJ |
3773 | <p> |
3774 | Indicates a connectivity fault triggered by an inability to receive | |
3775 | heartbeats from any remote endpoint. When a fault is triggered on | |
3776 | <ref table="Interface"/>s participating in bonds, they will be | |
3777 | disabled. | |
3778 | </p> | |
3779 | <p> | |
3780 | Faults can be triggered for several reasons. Most importantly they | |
3781 | are triggered when no CCMs are received for a period of 3.5 times the | |
3782 | transmission interval. Faults are also triggered when any CCMs | |
3783 | indicate that a Remote Maintenance Point is not receiving CCMs but | |
3784 | able to send them. Finally, a fault is triggered if a CCM is | |
3785 | received which indicates unexpected configuration. Notably, this | |
3786 | case arises when a CCM is received which advertises the local MPID. | |
3787 | </p> | |
93b8df38 | 3788 | </column> |
a5faa982 | 3789 | |
b9380396 EJ |
3790 | <column name="cfm_fault_status" key="recv"> |
3791 | Indicates a CFM fault was triggered due to a lack of CCMs received on | |
3792 | the <ref table="Interface"/>. | |
3793 | </column> | |
3794 | ||
3795 | <column name="cfm_fault_status" key="rdi"> | |
3796 | Indicates a CFM fault was triggered due to the reception of a CCM with | |
3797 | the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they | |
3798 | are not receiving CCMs themselves. This typically indicates a | |
3799 | unidirectional connectivity failure. | |
3800 | </column> | |
3801 | ||
3802 | <column name="cfm_fault_status" key="maid"> | |
3803 | Indicates a CFM fault was triggered due to the reception of a CCM with | |
3804 | a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged | |
3805 | with an identification number in addition to the MPID called the MAID. | |
3806 | Open vSwitch only supports receiving CCM broadcasts tagged with the | |
3807 | MAID it uses internally. | |
3808 | </column> | |
3809 | ||
3810 | <column name="cfm_fault_status" key="loopback"> | |
3811 | Indicates a CFM fault was triggered due to the reception of a CCM | |
3812 | advertising the same MPID configured in the <ref column="cfm_mpid"/> | |
3813 | column of this <ref table="Interface"/>. This may indicate a loop in | |
3814 | the network. | |
3815 | </column> | |
3816 | ||
3817 | <column name="cfm_fault_status" key="overflow"> | |
3818 | Indicates a CFM fault was triggered because the CFM module received | |
3819 | CCMs from more remote endpoints than it can keep track of. | |
3820 | </column> | |
3821 | ||
3822 | <column name="cfm_fault_status" key="override"> | |
3823 | Indicates a CFM fault was manually triggered by an administrator using | |
3824 | an <code>ovs-appctl</code> command. | |
3825 | </column> | |
3826 | ||
2b540ecb MM |
3827 | <column name="cfm_fault_status" key="interval"> |
3828 | Indicates a CFM fault was triggered due to the reception of a CCM | |
3829 | frame having an invalid interval. | |
3830 | </column> | |
3831 | ||
1c0333b6 EJ |
3832 | <column name="cfm_remote_opstate"> |
3833 | <p>When in extended mode, indicates the operational state of the | |
039a8ccd BP |
3834 | remote endpoint as either <code>up</code> or <code>down</code>. See |
3835 | <ref column="other_config" key="cfm_opstate"/>. | |
1c0333b6 EJ |
3836 | </p> |
3837 | </column> | |
3838 | ||
3967a833 MM |
3839 | <column name="cfm_health"> |
3840 | <p> | |
3841 | Indicates the health of the interface as a percentage of CCM frames | |
3842 | received over 21 <ref column="other_config" key="cfm_interval"/>s. | |
3843 | The health of an interface is undefined if it is communicating with | |
3844 | more than one <ref column="cfm_remote_mpids"/>. It reduces if | |
3845 | healthy heartbeats are not received at the expected rate, and | |
3846 | gradually improves as healthy heartbeats are received at the desired | |
3847 | rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the | |
3848 | health of the interface is refreshed. | |
3849 | </p> | |
3850 | <p> | |
3851 | As mentioned above, the faults can be triggered for several reasons. | |
3852 | The link health will deteriorate even if heartbeats are received but | |
3853 | they are reported to be unhealthy. An unhealthy heartbeat in this | |
3854 | context is a heartbeat for which either some fault is set or is out | |
3855 | of sequence. The interface health can be 100 only on receiving | |
3856 | healthy heartbeats at the desired rate. | |
3857 | </p> | |
3858 | </column> | |
3859 | ||
a5faa982 EJ |
3860 | <column name="cfm_remote_mpids"> |
3861 | When CFM is properly configured, Open vSwitch will occasionally | |
3862 | receive CCM broadcasts. These broadcasts contain the MPID of the | |
3863 | sending Maintenance Point. The list of MPIDs from which this | |
3864 | <ref table="Interface"/> is receiving broadcasts from is regularly | |
3865 | collected and written to this column. | |
3866 | </column> | |
3fd8d445 | 3867 | |
f9e5e5b3 BP |
3868 | <column name="other_config" key="cfm_interval" |
3869 | type='{"type": "integer"}'> | |
612ca9c5 BP |
3870 | <p> |
3871 | The interval, in milliseconds, between transmissions of CFM | |
3872 | heartbeats. Three missed heartbeat receptions indicate a | |
3873 | connectivity fault. | |
3874 | </p> | |
3875 | ||
3876 | <p> | |
3877 | In standard operation only intervals of 3, 10, 100, 1,000, 10,000, | |
3878 | 60,000, or 600,000 ms are supported. Other values will be rounded | |
3879 | down to the nearest value on the list. Extended mode (see <ref | |
3880 | column="other_config" key="cfm_extended"/>) supports any interval up | |
3881 | to 65,535 ms. In either mode, the default is 1000 ms. | |
3882 | </p> | |
3883 | ||
3884 | <p>We do not recommend using intervals less than 100 ms.</p> | |
3fd8d445 BP |
3885 | </column> |
3886 | ||
f9e5e5b3 BP |
3887 | <column name="other_config" key="cfm_extended" |
3888 | type='{"type": "boolean"}'> | |
3fd8d445 BP |
3889 | When <code>true</code>, the CFM module operates in extended mode. This |
3890 | causes it to use a nonstandard destination address to avoid conflicting | |
3891 | with compliant implementations which may be running concurrently on the | |
3892 | network. Furthermore, extended mode increases the accuracy of the | |
3893 | <code>cfm_interval</code> configuration parameter by breaking wire | |
b1a6083a AW |
3894 | compatibility with 802.1ag compliant implementations. And extended |
3895 | mode allows eight byte MPIDs. Defaults to <code>false</code>. | |
3fd8d445 | 3896 | </column> |
90967e95 EJ |
3897 | |
3898 | <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'> | |
3899 | <p> | |
3900 | When <code>true</code>, and | |
3901 | <ref column="other_config" key="cfm_extended"/> is true, the CFM | |
3902 | module operates in demand mode. When in demand mode, traffic | |
3903 | received on the <ref table="Interface"/> is used to indicate | |
5767a79a AW |
3904 | liveness. CCMs are still transmitted and received. At least one |
3905 | CCM must be received every 100 * <ref column="other_config" | |
3906 | key="cfm_interval"/> amount of time. Otherwise, even if traffic | |
3907 | are received, the CFM module will raise the connectivity fault. | |
90967e95 EJ |
3908 | </p> |
3909 | ||
3910 | <p> | |
039a8ccd | 3911 | Demand mode has a couple of caveats: |
90967e95 EJ |
3912 | <ul> |
3913 | <li> | |
3914 | To ensure that ovs-vswitchd has enough time to pull statistics | |
03f209ba AW |
3915 | from the datapath, the fault detection interval is set to |
3916 | 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500) | |
3917 | ms. | |
90967e95 EJ |
3918 | </li> |
3919 | ||
3920 | <li> | |
3921 | To avoid ambiguity, demand mode disables itself when there are | |
3922 | multiple remote maintenance points. | |
3923 | </li> | |
3924 | ||
3925 | <li> | |
3926 | If the <ref table="Interface"/> is heavily congested, CCMs | |
3927 | containing the <ref column="other_config" key="cfm_opstate"/> | |
3928 | status may be dropped causing changes in the operational state to | |
3929 | be delayed. Similarly, if CCMs containing the RDI bit are not | |
3930 | received, unidirectional link failures may not be detected. | |
3931 | </li> | |
3932 | </ul> | |
3933 | </p> | |
3934 | </column> | |
3935 | ||
dae57238 BP |
3936 | <column name="other_config" key="cfm_opstate" |
3937 | type='{"type": "string", "enum": ["set", ["down", "up"]]}'> | |
86dc6501 EJ |
3938 | When <code>down</code>, the CFM module marks all CCMs it generates as |
3939 | operationally down without triggering a fault. This allows remote | |
3940 | maintenance points to choose not to forward traffic to the | |
3941 | <ref table="Interface"/> on which this CFM module is running. | |
3942 | Currently, in Open vSwitch, the opdown bit of CCMs affects | |
3943 | <ref table="Interface"/>s participating in bonds, and the bundle | |
3944 | OpenFlow action. This setting is ignored when CFM is not in extended | |
3945 | mode. Defaults to <code>up</code>. | |
3946 | </column> | |
75a4ead1 EJ |
3947 | |
3948 | <column name="other_config" key="cfm_ccm_vlan" | |
039a8ccd | 3949 | type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'> |
75a4ead1 | 3950 | When set, the CFM module will apply a VLAN tag to all CCMs it generates |
189cb9e4 EJ |
3951 | with the given value. May be the string <code>random</code> in which |
3952 | case each CCM will be tagged with a different randomly generated VLAN. | |
75a4ead1 EJ |
3953 | </column> |
3954 | ||
a7aa2d3c | 3955 | <column name="other_config" key="cfm_ccm_pcp" |
039a8ccd | 3956 | type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'> |
a7aa2d3c | 3957 | When set, the CFM module will apply a VLAN tag to all CCMs it generates |
b363bae4 | 3958 | with the given PCP value, the VLAN ID of the tag is governed by the |
a7aa2d3c EJ |
3959 | value of <ref column="other_config" key="cfm_ccm_vlan"/>. If |
3960 | <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of | |
3961 | zero is used. | |
3962 | </column> | |
3963 | ||
93b8df38 EJ |
3964 | </group> |
3965 | ||
3fd8d445 | 3966 | <group title="Bonding Configuration"> |
f9e5e5b3 BP |
3967 | <column name="other_config" key="lacp-port-id" |
3968 | type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'> | |
3fd8d445 BP |
3969 | The LACP port ID of this <ref table="Interface"/>. Port IDs are |
3970 | used in LACP negotiations to identify individual ports | |
f9e5e5b3 | 3971 | participating in a bond. |
a8172aa3 EJ |
3972 | </column> |
3973 | ||
f9e5e5b3 BP |
3974 | <column name="other_config" key="lacp-port-priority" |
3975 | type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'> | |
3fd8d445 BP |
3976 | The LACP port priority of this <ref table="Interface"/>. In LACP |
3977 | negotiations <ref table="Interface"/>s with numerically lower | |
f9e5e5b3 | 3978 | priorities are preferred for aggregation. |
89365653 | 3979 | </column> |
018f1525 | 3980 | |
f9e5e5b3 BP |
3981 | <column name="other_config" key="lacp-aggregation-key" |
3982 | type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'> | |
3fd8d445 BP |
3983 | The LACP aggregation key of this <ref table="Interface"/>. <ref |
3984 | table="Interface"/>s with different aggregation keys may not be active | |
f9e5e5b3 | 3985 | within a given <ref table="Port"/> at the same time. |
a3acf0b0 | 3986 | </column> |
3fd8d445 | 3987 | </group> |
a3acf0b0 | 3988 | |
3fd8d445 BP |
3989 | <group title="Virtual Machine Identifiers"> |
3990 | <p> | |
3991 | These key-value pairs specifically apply to an interface that | |
3992 | represents a virtual Ethernet interface connected to a virtual | |
3993 | machine. These key-value pairs should not be present for other types | |
3994 | of interfaces. Keys whose names end in <code>-uuid</code> have | |
3995 | values that uniquely identify the entity in question. For a Citrix | |
3996 | XenServer hypervisor, these values are UUIDs in RFC 4122 format. | |
3997 | Other hypervisors may use other formats. | |
3998 | </p> | |
3999 | ||
4000 | <column name="external_ids" key="attached-mac"> | |
4001 | The MAC address programmed into the ``virtual hardware'' for this | |
4002 | interface, in the form | |
4003 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>. | |
4004 | For Citrix XenServer, this is the value of the <code>MAC</code> field | |
4005 | in the VIF record for this interface. | |
4006 | </column> | |
4007 | ||
4008 | <column name="external_ids" key="iface-id"> | |
4009 | A system-unique identifier for the interface. On XenServer, this will | |
4010 | commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>. | |
4011 | </column> | |
4012 | ||
cf9deac5 BP |
4013 | <column name="external_ids" key="iface-status" |
4014 | type='{"type": "string", | |
4015 | "enum": ["set", ["active", "inactive"]]}'> | |
4016 | <p> | |
4017 | Hypervisors may sometimes have more than one interface associated | |
4018 | with a given <ref column="external_ids" key="iface-id"/>, only one of | |
4019 | which is actually in use at a given time. For example, in some | |
4020 | circumstances XenServer has both a ``tap'' and a ``vif'' interface | |
4021 | for a single <ref column="external_ids" key="iface-id"/>, but only | |
4022 | uses one of them at a time. A hypervisor that behaves this way must | |
4023 | mark the currently in use interface <code>active</code> and the | |
4024 | others <code>inactive</code>. A hypervisor that never has more than | |
4025 | one interface for a given <ref column="external_ids" key="iface-id"/> | |
4026 | may mark that interface <code>active</code> or omit <ref | |
4027 | column="external_ids" key="iface-status"/> entirely. | |
4028 | </p> | |
4029 | ||
4030 | <p> | |
4031 | During VM migration, a given <ref column="external_ids" | |
4032 | key="iface-id"/> might transiently be marked <code>active</code> on | |
4033 | two different hypervisors. That is, <code>active</code> means that | |
4034 | this <ref column="external_ids" key="iface-id"/> is the active | |
4035 | instance within a single hypervisor, not in a broader scope. | |
3634eb99 BP |
4036 | There is one exception: some hypervisors support ``migration'' from a |
4037 | given hypervisor to itself (most often for test purposes). During | |
4038 | such a ``migration,'' two instances of a single <ref | |
4039 | column="external_ids" key="iface-id"/> might both be briefly marked | |
4040 | <code>active</code> on a single hypervisor. | |
cf9deac5 BP |
4041 | </p> |
4042 | </column> | |
4043 | ||
3fd8d445 BP |
4044 | <column name="external_ids" key="xs-vif-uuid"> |
4045 | The virtual interface associated with this interface. | |
4046 | </column> | |
4047 | ||
4048 | <column name="external_ids" key="xs-network-uuid"> | |
4049 | The virtual network to which this interface is attached. | |
4050 | </column> | |
4051 | ||
c473936b GS |
4052 | <column name="external_ids" key="vm-id"> |
4053 | The VM to which this interface belongs. On XenServer, this will be the | |
4054 | same as <ref column="external_ids" key="xs-vm-uuid"/>. | |
4055 | </column> | |
4056 | ||
3fd8d445 BP |
4057 | <column name="external_ids" key="xs-vm-uuid"> |
4058 | The VM to which this interface belongs. | |
018f1525 | 4059 | </column> |
89365653 | 4060 | </group> |
3fd8d445 | 4061 | |
99eef98b DF |
4062 | <group title="Auto Attach Configuration"> |
4063 | <p> | |
039a8ccd | 4064 | Auto Attach configuration for a particular interface. |
99eef98b DF |
4065 | </p> |
4066 | ||
4067 | <column name="lldp" key="enable" type='{"type": "boolean"}'> | |
039a8ccd BP |
4068 | True to enable LLDP on this <ref table="Interface"/>. If not |
4069 | specified, LLDP will be disabled by default. | |
99eef98b DF |
4070 | </column> |
4071 | </group> | |
4072 | ||
9fd39370 SC |
4073 | <group title="Flow control Configuration"> |
4074 | <p> | |
4075 | Ethernet flow control defined in IEEE 802.1Qbb provides link level flow | |
4076 | control using MAC pause frames. Implemented only for interfaces with | |
4077 | type <code>dpdk</code>. | |
4078 | </p> | |
4079 | ||
4080 | <column name="options" key="rx-flow-ctrl" type='{"type": "boolean"}'> | |
4081 | Set to <code>true</code> to enable Rx flow control on physical ports. | |
4082 | By default, Rx flow control is disabled. | |
4083 | </column> | |
4084 | ||
4085 | <column name="options" key="tx-flow-ctrl" type='{"type": "boolean"}'> | |
4086 | Set to <code>true</code> to enable Tx flow control on physical ports. | |
4087 | By default, Tx flow control is disabled. | |
4088 | </column> | |
4089 | ||
4090 | <column name="options" key="flow-ctrl-autoneg" | |
4091 | type='{"type": "boolean"}'> | |
4092 | Set to <code>true</code> to enable flow control auto negotiation on | |
4093 | physical ports. By default, auto-neg is disabled. | |
4094 | </column> | |
4095 | </group> | |
4096 | ||
f8b64a61 RM |
4097 | <group title="Link State Change detection mode"> |
4098 | <column name="options" key="dpdk-lsc-interrupt" | |
4099 | type='{"type": "boolean"}'> | |
4100 | <p> | |
4101 | Set this value to <code>true</code> to configure interrupt mode for | |
4102 | Link State Change (LSC) detection instead of poll mode for the DPDK | |
4103 | interface. | |
4104 | </p> | |
4105 | <p> | |
4106 | If this value is not set, poll mode is configured. | |
4107 | </p> | |
4108 | <p> | |
4109 | This parameter has an effect only on netdev dpdk interfaces. | |
4110 | </p> | |
4111 | </column> | |
4112 | </group> | |
4113 | ||
3fd8d445 BP |
4114 | <group title="Common Columns"> |
4115 | The overall purpose of these columns is described under <code>Common | |
4116 | Columns</code> at the beginning of this document. | |
4117 | ||
4118 | <column name="other_config"/> | |
4119 | <column name="external_ids"/> | |
4120 | </group> | |
89365653 BP |
4121 | </table> |
4122 | ||
254750ce BP |
4123 | <table name="Flow_Table" title="OpenFlow table configuration"> |
4124 | <p>Configuration for a particular OpenFlow table.</p> | |
4125 | ||
4126 | <column name="name"> | |
4127 | The table's name. Set this column to change the name that controllers | |
4128 | will receive when they request table statistics, e.g. <code>ovs-ofctl | |
4129 | dump-tables</code>. The name does not affect switch behavior. | |
4130 | </column> | |
4131 | ||
82c22d34 | 4132 | <group title="Eviction Policy"> |
254750ce | 4133 | <p> |
82c22d34 BP |
4134 | Open vSwitch supports limiting the number of flows that may be |
4135 | installed in a flow table, via the <ref column="flow_limit"/> column. | |
4136 | When adding a flow would exceed this limit, by default Open vSwitch | |
4137 | reports an error, but there are two ways to configure Open vSwitch to | |
4138 | instead delete (``evict'') a flow to make room for the new one: | |
254750ce BP |
4139 | </p> |
4140 | ||
82c22d34 BP |
4141 | <ul> |
4142 | <li> | |
4143 | Set the <ref column="overflow_policy"/> column to <code>evict</code>. | |
4144 | </li> | |
254750ce | 4145 | |
82c22d34 BP |
4146 | <li> |
4147 | Send an OpenFlow 1.4+ ``table mod request'' to enable eviction for | |
4148 | the flow table (e.g. <code>ovs-ofctl -O OpenFlow14 mod-table br0 0 | |
4149 | evict</code> to enable eviction on flow table 0 of bridge | |
4150 | <code>br0</code>). | |
4151 | </li> | |
4152 | </ul> | |
254750ce BP |
4153 | |
4154 | <p> | |
4155 | When a flow must be evicted due to overflow, the flow to evict is | |
f70b94de BP |
4156 | chosen through an approximation of the following algorithm. This |
4157 | algorithm is used regardless of how eviction was enabled: | |
254750ce BP |
4158 | </p> |
4159 | ||
4160 | <ol> | |
4161 | <li> | |
4162 | Divide the flows in the table into groups based on the values of the | |
f70b94de BP |
4163 | fields or subfields specified in the <ref column="groups"/> column, |
4164 | so that all of the flows in a given group have the same values for | |
4165 | those fields. If a flow does not specify a given field, that field's | |
4166 | value is treated as 0. If <ref column="groups"/> is empty, then all | |
4167 | of the flows in the flow table are treated as a single group. | |
254750ce BP |
4168 | </li> |
4169 | ||
4170 | <li> | |
4171 | Consider the flows in the largest group, that is, the group that | |
4172 | contains the greatest number of flows. If two or more groups all | |
4173 | have the same largest number of flows, consider the flows in all of | |
4174 | those groups. | |
4175 | </li> | |
4176 | ||
f70b94de BP |
4177 | <li> |
4178 | If the flows under consideration have different importance values, | |
4179 | eliminate from consideration any flows except those with the lowest | |
4180 | importance. (``Importance,'' a 16-bit integer value attached to each | |
4181 | flow, was introduced in OpenFlow 1.4. Flows inserted with older | |
4182 | versions of OpenFlow always have an importance of 0.) | |
4183 | </li> | |
4184 | ||
254750ce BP |
4185 | <li> |
4186 | Among the flows under consideration, choose the flow that expires | |
4187 | soonest for eviction. | |
4188 | </li> | |
4189 | </ol> | |
4190 | ||
4191 | <p> | |
82c22d34 BP |
4192 | The eviction process only considers flows that have an idle timeout |
4193 | or a hard timeout. That is, eviction never deletes permanent flows. | |
7792bfe0 | 4194 | (Permanent flows do count against <ref column="flow_limit"/>.) |
254750ce BP |
4195 | </p> |
4196 | ||
82c22d34 BP |
4197 | <column name="flow_limit"> |
4198 | If set, limits the number of flows that may be added to the table. | |
4199 | Open vSwitch may limit the number of flows in a table for other | |
4200 | reasons, e.g. due to hardware limitations or for resource availability | |
4201 | or performance reasons. | |
4202 | </column> | |
254750ce | 4203 | |
82c22d34 BP |
4204 | <column name="overflow_policy"> |
4205 | <p> | |
4206 | Controls the switch's behavior when an OpenFlow flow table | |
4207 | modification request would add flows in excess of <ref | |
4208 | column="flow_limit"/>. The supported values are: | |
4209 | </p> | |
13751fd8 | 4210 | |
82c22d34 BP |
4211 | <dl> |
4212 | <dt><code>refuse</code></dt> | |
4213 | <dd> | |
4214 | Refuse to add the flow or flows. This is also the default policy | |
4215 | when <ref column="overflow_policy"/> is unset. | |
4216 | </dd> | |
f017d986 | 4217 | |
82c22d34 BP |
4218 | <dt><code>evict</code></dt> |
4219 | <dd> | |
4220 | Delete a flow chosen according to the algorithm described above. | |
4221 | </dd> | |
4222 | </dl> | |
4223 | </column> | |
f017d986 | 4224 | |
82c22d34 BP |
4225 | <column name="groups"> |
4226 | <p> | |
4227 | When <ref column="overflow_policy"/> is <code>evict</code>, this | |
4228 | controls how flows are chosen for eviction when the flow table would | |
4229 | otherwise exceed <ref column="flow_limit"/> flows. Its value is a | |
4230 | set of NXM fields or sub-fields, each of which takes one of the forms | |
4231 | <code><var>field</var>[]</code> or | |
4232 | <code><var>field</var>[<var>start</var>..<var>end</var>]</code>, | |
4233 | e.g. <code>NXM_OF_IN_PORT[]</code>. Please see | |
0da61033 | 4234 | <code>meta-flow.h</code> for a complete list of NXM field names. |
82c22d34 | 4235 | </p> |
f017d986 | 4236 | |
82c22d34 BP |
4237 | <p> |
4238 | Open vSwitch ignores any invalid or unknown field specifications. | |
4239 | </p> | |
f017d986 | 4240 | |
82c22d34 BP |
4241 | <p> |
4242 | When eviction is not enabled, via <ref column="overflow_policy"/> or | |
4243 | an OpenFlow 1.4+ ``table mod,'' this column has no effect. | |
4244 | </p> | |
4245 | </column> | |
4246 | </group> | |
13751fd8 | 4247 | |
82c22d34 BP |
4248 | <group title="Classifier Optimization"> |
4249 | <column name="prefixes"> | |
4250 | <p> | |
4251 | This string set specifies which fields should be used for | |
4252 | address prefix tracking. Prefix tracking allows the | |
4253 | classifier to skip rules with longer than necessary prefixes, | |
4254 | resulting in better wildcarding for datapath flows. | |
4255 | </p> | |
4256 | <p> | |
4257 | Prefix tracking may be beneficial when a flow table contains | |
4258 | matches on IP address fields with different prefix lengths. | |
4259 | For example, when a flow table contains IP address matches on | |
4260 | both full addresses and proper prefixes, the full address | |
4261 | matches will typically cause the datapath flow to un-wildcard | |
4262 | the whole address field (depending on flow entry priorities). | |
4263 | In this case each packet with a different address gets handed | |
4264 | to the userspace for flow processing and generates its own | |
4265 | datapath flow. With prefix tracking enabled for the address | |
4266 | field in question packets with addresses matching shorter | |
4267 | prefixes would generate datapath flows where the irrelevant | |
4268 | address bits are wildcarded, allowing the same datapath flow | |
4269 | to handle all the packets within the prefix in question. In | |
4270 | this case many userspace upcalls can be avoided and the | |
4271 | overall performance can be better. | |
4272 | </p> | |
4273 | <p> | |
4274 | This is a performance optimization only, so packets will | |
4275 | receive the same treatment with or without prefix tracking. | |
4276 | </p> | |
4277 | <p> | |
4278 | The supported fields are: <code>tun_id</code>, | |
4279 | <code>tun_src</code>, <code>tun_dst</code>, | |
80c4589a | 4280 | <code>tun_ipv6_src</code>, <code>tun_ipv6_dst</code>, |
82c22d34 BP |
4281 | <code>nw_src</code>, <code>nw_dst</code> (or aliases |
4282 | <code>ip_src</code> and <code>ip_dst</code>), | |
4283 | <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this | |
4284 | feature for <code>tun_id</code> would only make sense if the | |
4285 | tunnel IDs have prefix structure similar to IP addresses.) | |
4286 | </p> | |
13751fd8 | 4287 | |
82c22d34 BP |
4288 | <p> |
4289 | By default, the <code>prefixes=ip_dst,ip_src</code> are used | |
4290 | on each flow table. This instructs the flow classifier to | |
4291 | track the IP destination and source addresses used by the | |
4292 | rules in this specific flow table. | |
4293 | </p> | |
4294 | ||
4295 | <p> | |
4296 | The keyword <code>none</code> is recognized as an explicit | |
4297 | override of the default values, causing no prefix fields to be | |
4298 | tracked. | |
4299 | </p> | |
4300 | ||
4301 | <p> | |
4302 | To set the prefix fields, the flow table record needs to | |
4303 | exist: | |
4304 | </p> | |
4305 | ||
4306 | <dl> | |
4307 | <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt> | |
4308 | <dd> | |
4309 | Creates a flow table record for the OpenFlow table number 0. | |
4310 | </dd> | |
4311 | ||
4312 | <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt> | |
4313 | <dd> | |
4314 | Enables prefix tracking for IP source and destination | |
4315 | address fields. | |
4316 | </dd> | |
4317 | </dl> | |
4318 | ||
4319 | <p> | |
4320 | There is a maximum number of fields that can be enabled for any | |
4321 | one flow table. Currently this limit is 3. | |
4322 | </p> | |
4323 | </column> | |
4324 | </group> | |
e3fbd9df BP |
4325 | |
4326 | <group title="Common Columns"> | |
4327 | The overall purpose of these columns is described under <code>Common | |
4328 | Columns</code> at the beginning of this document. | |
4329 | ||
4330 | <column name="external_ids"/> | |
4331 | </group> | |
254750ce BP |
4332 | </table> |
4333 | ||
c1c9c9c4 BP |
4334 | <table name="QoS" title="Quality of Service configuration"> |
4335 | <p>Quality of Service (QoS) configuration for each Port that | |
3fd8d445 | 4336 | references it.</p> |
c1c9c9c4 BP |
4337 | |
4338 | <column name="type"> | |
b850dc6d BP |
4339 | <p>The type of QoS to implement. The currently defined types are |
4340 | listed below:</p> | |
c1c9c9c4 BP |
4341 | <dl> |
4342 | <dt><code>linux-htb</code></dt> | |
6784cb57 BP |
4343 | <dd> |
4344 | Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at | |
4345 | <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual | |
4346 | (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>) | |
4347 | for information on how this classifier works and how to configure it. | |
4348 | </dd> | |
6cf888b8 | 4349 | |
a339aa81 EJ |
4350 | <dt><code>linux-hfsc</code></dt> |
4351 | <dd> | |
4352 | Linux "Hierarchical Fair Service Curve" classifier. | |
4353 | See <code>http://linux-ip.net/articles/hfsc.en/</code> for | |
4354 | information on how this classifier works. | |
4355 | </dd> | |
6cf888b8 | 4356 | |
677d9158 JV |
4357 | <dt><code>linux-sfq</code></dt> |
4358 | <dd> | |
4359 | Linux ``Stochastic Fairness Queueing'' classifier. See | |
4360 | <code>tc-sfq</code>(8) (also at | |
4361 | <code>http://linux.die.net/man/8/tc-sfq</code>) for information on | |
4362 | how this classifier works. | |
4363 | </dd> | |
6cf888b8 | 4364 | |
677d9158 JV |
4365 | <dt><code>linux-codel</code></dt> |
4366 | <dd> | |
4367 | Linux ``Controlled Delay'' classifier. See <code>tc-codel</code>(8) | |
4368 | (also at | |
4369 | <code>http://man7.org/linux/man-pages/man8/tc-codel.8.html</code>) | |
4370 | for information on how this classifier works. | |
4371 | </dd> | |
6cf888b8 | 4372 | |
677d9158 JV |
4373 | <dt><code>linux-fq_codel</code></dt> |
4374 | <dd> | |
4375 | Linux ``Fair Queuing with Controlled Delay'' classifier. See | |
4376 | <code>tc-fq_codel</code>(8) (also at | |
4377 | <code>http://man7.org/linux/man-pages/man8/tc-fq_codel.8.html</code>) | |
4378 | for information on how this classifier works. | |
4379 | </dd> | |
6cf888b8 | 4380 | |
2f564bb1 S |
4381 | <dt><code>linux-netem</code></dt> |
4382 | <dd> | |
4383 | Linux ``Network Emulator'' classifier. See | |
4384 | <code>tc-netem</code>(8) (also at | |
4385 | <code>http://man7.org/linux/man-pages/man8/tc-netem.8.html</code>) | |
4386 | for information on how this classifier works. | |
4387 | </dd> | |
4388 | ||
6cf888b8 BS |
4389 | <dt><code>linux-noop</code></dt> |
4390 | <dd> | |
4391 | Linux ``No operation.'' By default, Open vSwitch manages quality of | |
4392 | service on all of its configured ports. This can be helpful, but | |
4393 | sometimes administrators prefer to use other software to manage QoS. | |
4394 | This <ref column="type"/> prevents Open vSwitch from changing the QoS | |
4395 | configuration for a port. | |
4396 | </dd> | |
4397 | ||
0bf765f7 IS |
4398 | <dt><code>egress-policer</code></dt> |
4399 | <dd> | |
6cf888b8 | 4400 | A DPDK egress policer algorithm using the DPDK |
0bf765f7 IS |
4401 | rte_meter library. The rte_meter library provides an implementation |
4402 | which allows the metering and policing of traffic. The implementation | |
4403 | in OVS essentially creates a single token bucket used to police | |
4404 | traffic. It should be noted that when the rte_meter is configured as | |
4405 | part of QoS there will be a performance overhead as the rte_meter | |
4406 | itself will consume CPU cycles in order to police traffic. These CPU | |
4407 | cycles ordinarily are used for packet proccessing. As such the drop | |
4408 | in performance will be noticed in terms of overall aggregate traffic | |
4409 | throughput. | |
4410 | </dd> | |
4411 | </dl> | |
c1c9c9c4 BP |
4412 | </column> |
4413 | ||
4414 | <column name="queues"> | |
4415 | <p>A map from queue numbers to <ref table="Queue"/> records. The | |
3fd8d445 BP |
4416 | supported range of queue numbers depend on <ref column="type"/>. The |
4417 | queue numbers are the same as the <code>queue_id</code> used in | |
4418 | OpenFlow in <code>struct ofp_action_enqueue</code> and other | |
2c999774 BP |
4419 | structures.</p> |
4420 | ||
4421 | <p> | |
4422 | Queue 0 is the ``default queue.'' It is used by OpenFlow output | |
8bddb894 BP |
4423 | actions when no specific queue has been set. When no configuration for |
4424 | queue 0 is present, it is automatically configured as if a <ref | |
4425 | table="Queue"/> record with empty <ref table="Queue" column="dscp"/> | |
4426 | and <ref table="Queue" column="other_config"/> columns had been | |
4427 | specified. | |
2c999774 BP |
4428 | (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in |
4429 | this case. With some queuing disciplines, this dropped all packets | |
4430 | destined for the default queue.) | |
4431 | </p> | |
c1c9c9c4 BP |
4432 | </column> |
4433 | ||
3fd8d445 BP |
4434 | <group title="Configuration for linux-htb and linux-hfsc"> |
4435 | <p> | |
4436 | The <code>linux-htb</code> and <code>linux-hfsc</code> classes support | |
4437 | the following key-value pair: | |
4438 | </p> | |
9cc6bf75 | 4439 | |
f9e5e5b3 | 4440 | <column name="other_config" key="max-rate" type='{"type": "integer"}'> |
3fd8d445 BP |
4441 | Maximum rate shared by all queued traffic, in bit/s. Optional. If not |
4442 | specified, for physical interfaces, the default is the link rate. For | |
4443 | other interfaces or if the link rate cannot be determined, the default | |
4444 | is currently 100 Mbps. | |
4445 | </column> | |
4446 | </group> | |
13008eb3 | 4447 | |
0bf765f7 IS |
4448 | <group title="Configuration for egress-policer QoS"> |
4449 | <p> | |
4450 | <ref table="QoS"/> <ref table="QoS" column="type"/> | |
4451 | <code>egress-policer</code> provides egress policing for userspace | |
4452 | port types with DPDK. | |
4453 | ||
4454 | It has the following key-value pairs defined. | |
4455 | </p> | |
4456 | ||
4457 | <column name="other_config" key="cir" type='{"type": "integer"}'> | |
4458 | The Committed Information Rate (CIR) is measured in bytes of IP | |
4459 | packets per second, i.e. it includes the IP header, but not link | |
4460 | specific (e.g. Ethernet) headers. This represents the bytes per second | |
4461 | rate at which the token bucket will be updated. The cir value is | |
4462 | calculated by (pps x packet data size). For example assuming a user | |
4463 | wishes to limit a stream consisting of 64 byte packets to 1 million | |
4464 | packets per second the CIR would be set to to to 46000000. This value | |
4465 | can be broken into '1,000,000 x 46'. Where 1,000,000 is the policing | |
4466 | rate for the number of packets per second and 46 represents the size | |
4467 | of the packet data for a 64 byte ip packet. | |
4468 | </column> | |
4469 | <column name="other_config" key="cbs" type='{"type": "integer"}'> | |
4470 | The Committed Burst Size (CBS) is measured in bytes and represents a | |
4471 | token bucket. At a minimum this value should be be set to the expected | |
4472 | largest size packet in the traffic stream. In practice larger values | |
4473 | may be used to increase the size of the token bucket. If a packet can | |
4474 | be transmitted then the cbs will be decremented by the number of | |
4475 | bytes/tokens of the packet. If there are not enough tokens in the cbs | |
4476 | bucket the packet will be dropped. | |
4477 | </column> | |
4478 | </group> | |
4479 | ||
804c477b LR |
4480 | <group title="Configuration for linux-sfq"> |
4481 | <p> | |
4482 | The <code>linux-sfq</code> QoS supports the following key-value pairs: | |
4483 | </p> | |
4484 | ||
4485 | <column name="other_config" key="perturb" type='{"type": "integer"}'> | |
4486 | Number of seconds between consecutive perturbations in hashing algorithm. | |
4487 | Different flows can end up in the same hash bucket causing unfairness. | |
4488 | Perturbation's goal is to remove possible unfairness. | |
4489 | The default and recommended value is 10. Too low a value is discouraged | |
4490 | because each perturbation can cause packet reordering. | |
4491 | </column> | |
4492 | <column name="other_config" key="quantum" type='{"type": "integer"}'> | |
4493 | Number of bytes <code>linux-sfq</code> QoS can dequeue in one turn in | |
4494 | round-robin from one flow. The default and recommended value is equal | |
4495 | to interface's MTU. | |
4496 | </column> | |
4497 | </group> | |
4498 | ||
2f564bb1 S |
4499 | <group title="Configuration for linux-netem"> |
4500 | <p> | |
4501 | The <code>linux-netem</code> QoS supports the following key-value | |
4502 | pairs: | |
4503 | </p> | |
4504 | ||
4505 | <column name="other_config" key="latency" type='{"type": "integer"}'> | |
4506 | Adds the chosen delay to the packets outgoing to chosen network | |
4507 | interface. The latency value expressed in us. | |
4508 | </column> | |
4509 | <column name="other_config" key="limit" type='{"type": "integer"}'> | |
4510 | Maximum number of packets the qdisc may hold queued at a time. | |
4511 | The default value is 1000. | |
4512 | </column> | |
4513 | <column name="other_config" key="loss" type='{"type": "integer"}'> | |
4514 | Adds an independent loss probability to the packets outgoing from the | |
4515 | chosen network interface. | |
4516 | </column> | |
4517 | </group> | |
4518 | ||
3fd8d445 BP |
4519 | <group title="Common Columns"> |
4520 | The overall purpose of these columns is described under <code>Common | |
4521 | Columns</code> at the beginning of this document. | |
4522 | ||
4523 | <column name="other_config"/> | |
4524 | <column name="external_ids"/> | |
4525 | </group> | |
c1c9c9c4 BP |
4526 | </table> |
4527 | ||
4528 | <table name="Queue" title="QoS output queue."> | |
4529 | <p>A configuration for a port output queue, used in configuring Quality of | |
3fd8d445 BP |
4530 | Service (QoS) features. May be referenced by <ref column="queues" |
4531 | table="QoS"/> column in <ref table="QoS"/> table.</p> | |
13008eb3 | 4532 | |
8b36f51e EJ |
4533 | <column name="dscp"> |
4534 | If set, Open vSwitch will mark all traffic egressing this | |
4535 | <ref table="Queue"/> with the given DSCP bits. Traffic egressing the | |
4536 | default <ref table="Queue"/> is only marked if it was explicitly selected | |
4537 | as the <ref table="Queue"/> at the time the packet was output. If unset, | |
4538 | the DSCP bits of traffic egressing this <ref table="Queue"/> will remain | |
4539 | unchanged. | |
4540 | </column> | |
4541 | ||
3fd8d445 BP |
4542 | <group title="Configuration for linux-htb QoS"> |
4543 | <p> | |
69822b3c EJ |
4544 | <ref table="QoS"/> <ref table="QoS" column="type"/> |
4545 | <code>linux-htb</code> may use <code>queue_id</code>s less than 61440. | |
4546 | It has the following key-value pairs defined. | |
3fd8d445 | 4547 | </p> |
9cc6bf75 | 4548 | |
f9e5e5b3 BP |
4549 | <column name="other_config" key="min-rate" |
4550 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
4551 | Minimum guaranteed bandwidth, in bit/s. |
4552 | </column> | |
4553 | ||
f9e5e5b3 BP |
4554 | <column name="other_config" key="max-rate" |
4555 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
4556 | Maximum allowed bandwidth, in bit/s. Optional. If specified, the |
4557 | queue's rate will not be allowed to exceed the specified value, even | |
4558 | if excess bandwidth is available. If unspecified, defaults to no | |
4559 | limit. | |
4560 | </column> | |
4561 | ||
f9e5e5b3 BP |
4562 | <column name="other_config" key="burst" |
4563 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
4564 | Burst size, in bits. This is the maximum amount of ``credits'' that a |
4565 | queue can accumulate while it is idle. Optional. Details of the | |
4566 | <code>linux-htb</code> implementation require a minimum burst size, so | |
4567 | a too-small <code>burst</code> will be silently ignored. | |
4568 | </column> | |
4569 | ||
f9e5e5b3 BP |
4570 | <column name="other_config" key="priority" |
4571 | type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'> | |
4572 | A queue with a smaller <code>priority</code> will receive all the | |
4573 | excess bandwidth that it can use before a queue with a larger value | |
4574 | receives any. Specific priority values are unimportant; only relative | |
4575 | ordering matters. Defaults to 0 if unspecified. | |
3fd8d445 BP |
4576 | </column> |
4577 | </group> | |
4578 | ||
4579 | <group title="Configuration for linux-hfsc QoS"> | |
4580 | <p> | |
69822b3c EJ |
4581 | <ref table="QoS"/> <ref table="QoS" column="type"/> |
4582 | <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440. | |
4583 | It has the following key-value pairs defined. | |
3fd8d445 | 4584 | </p> |
9cc6bf75 | 4585 | |
f9e5e5b3 BP |
4586 | <column name="other_config" key="min-rate" |
4587 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
4588 | Minimum guaranteed bandwidth, in bit/s. |
4589 | </column> | |
9cc6bf75 | 4590 | |
f9e5e5b3 BP |
4591 | <column name="other_config" key="max-rate" |
4592 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
4593 | Maximum allowed bandwidth, in bit/s. Optional. If specified, the |
4594 | queue's rate will not be allowed to exceed the specified value, even if | |
4595 | excess bandwidth is available. If unspecified, defaults to no | |
4596 | limit. | |
4597 | </column> | |
4598 | </group> | |
4599 | ||
4600 | <group title="Common Columns"> | |
4601 | The overall purpose of these columns is described under <code>Common | |
4602 | Columns</code> at the beginning of this document. | |
4603 | ||
4604 | <column name="other_config"/> | |
4605 | <column name="external_ids"/> | |
4606 | </group> | |
c1c9c9c4 BP |
4607 | </table> |
4608 | ||
9ae7ddc0 | 4609 | <table name="Mirror" title="Port mirroring."> |
89365653 BP |
4610 | <p>A port mirror within a <ref table="Bridge"/>.</p> |
4611 | <p>A port mirror configures a bridge to send selected frames to special | |
92ada132 | 4612 | ``mirrored'' ports, in addition to their normal destinations. Mirroring |
9ae7ddc0 | 4613 | traffic may also be referred to as SPAN or RSPAN, depending on how |
92ada132 | 4614 | the mirrored traffic is sent.</p> |
89365653 | 4615 | |
7efbc3b7 BP |
4616 | <p> |
4617 | When a packet enters an Open vSwitch bridge, it becomes eligible for | |
4618 | mirroring based on its ingress port and VLAN. As the packet travels | |
4619 | through the flow tables, each time it is output to a port, it becomes | |
4620 | eligible for mirroring based on the egress port and VLAN. In Open | |
4621 | vSwitch 2.5 and later, mirroring occurs just after a packet first becomes | |
4622 | eligible, using the packet as it exists at that point; in Open vSwitch | |
4623 | 2.4 and earlier, mirroring occurs only after a packet has traversed all | |
4624 | the flow tables, using the original packet as it entered the bridge. | |
4625 | This makes a difference only when the flow table modifies the packet: in | |
4626 | Open vSwitch 2.4, the modifications are never visible to mirrors, whereas | |
4627 | in Open vSwitch 2.5 and later modifications made before the first output | |
4628 | that makes it eligible for mirroring to a particular destination are | |
4629 | visible. | |
4630 | </p> | |
4631 | ||
4632 | <p> | |
4633 | A packet that enters an Open vSwitch bridge is mirrored to a particular | |
4634 | destination only once, even if it is eligible for multiple reasons. For | |
4635 | example, a packet would be mirrored to a particular <ref | |
4636 | column="output_port"/> only once, even if it is selected for mirroring to | |
4637 | that port by <ref column="select_dst_port"/> and <ref | |
4638 | column="select_src_port"/> in the same or different <ref table="Mirror"/> | |
4639 | records. | |
4640 | </p> | |
4641 | ||
89365653 BP |
4642 | <column name="name"> |
4643 | Arbitrary identifier for the <ref table="Mirror"/>. | |
4644 | </column> | |
4645 | ||
4646 | <group title="Selecting Packets for Mirroring"> | |
3e519d8e BP |
4647 | <p> |
4648 | To be selected for mirroring, a given packet must enter or leave the | |
4649 | bridge through a selected port and it must also be in one of the | |
4650 | selected VLANs. | |
4651 | </p> | |
4652 | ||
939ff267 BP |
4653 | <column name="select_all"> |
4654 | If true, every packet arriving or departing on any port is | |
4655 | selected for mirroring. | |
4656 | </column> | |
4657 | ||
89365653 BP |
4658 | <column name="select_dst_port"> |
4659 | Ports on which departing packets are selected for mirroring. | |
4660 | </column> | |
4661 | ||
4662 | <column name="select_src_port"> | |
939ff267 | 4663 | Ports on which arriving packets are selected for mirroring. |
89365653 BP |
4664 | </column> |
4665 | ||
4666 | <column name="select_vlan"> | |
4667 | VLANs on which packets are selected for mirroring. An empty set | |
4668 | selects packets on all VLANs. | |
4669 | </column> | |
4670 | </group> | |
4671 | ||
4672 | <group title="Mirroring Destination Configuration"> | |
3e519d8e BP |
4673 | <p> |
4674 | These columns are mutually exclusive. Exactly one of them must be | |
4675 | nonempty. | |
4676 | </p> | |
4677 | ||
89365653 | 4678 | <column name="output_port"> |
3e519d8e | 4679 | <p>Output port for selected packets, if nonempty.</p> |
89365653 | 4680 | <p>Specifying a port for mirror output reserves that port exclusively |
92ada132 | 4681 | for mirroring. No frames other than those selected for mirroring |
653fe3a3 | 4682 | via this column |
92ada132 BP |
4683 | will be forwarded to the port, and any frames received on the port |
4684 | will be discarded.</p> | |
4685 | <p> | |
4686 | The output port may be any kind of port supported by Open vSwitch. | |
9ae7ddc0 JP |
4687 | It may be, for example, a physical port (sometimes called SPAN) or a |
4688 | GRE tunnel. | |
92ada132 | 4689 | </p> |
89365653 BP |
4690 | </column> |
4691 | ||
4692 | <column name="output_vlan"> | |
3e519d8e | 4693 | <p>Output VLAN for selected packets, if nonempty.</p> |
89365653 | 4694 | <p>The frames will be sent out all ports that trunk |
3fd8d445 BP |
4695 | <ref column="output_vlan"/>, as well as any ports with implicit VLAN |
4696 | <ref column="output_vlan"/>. When a mirrored frame is sent out a | |
4697 | trunk port, the frame's VLAN tag will be set to | |
4698 | <ref column="output_vlan"/>, replacing any existing tag; when it is | |
4699 | sent out an implicit VLAN port, the frame will not be tagged. This | |
4700 | type of mirroring is sometimes called RSPAN.</p> | |
07817dfe | 4701 | <p> |
05be4e2c EJ |
4702 | See the documentation for |
4703 | <ref column="other_config" key="forward-bpdu"/> in the | |
4704 | <ref table="Interface"/> table for a list of destination MAC | |
4705 | addresses which will not be mirrored to a VLAN to avoid confusing | |
4706 | switches that interpret the protocols that they represent. | |
07817dfe | 4707 | </p> |
89365653 | 4708 | <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that |
3fd8d445 BP |
4709 | contains unmanaged switches. Consider an unmanaged physical switch |
4710 | with two ports: port 1, connected to an end host, and port 2, | |
4711 | connected to an Open vSwitch configured to mirror received packets | |
4712 | into VLAN 123 on port 2. Suppose that the end host sends a packet on | |
4713 | port 1 that the physical switch forwards to port 2. The Open vSwitch | |
4714 | forwards this packet to its destination and then reflects it back on | |
4715 | port 2 in VLAN 123. This reflected packet causes the unmanaged | |
4716 | physical switch to replace the MAC learning table entry, which | |
4717 | correctly pointed to port 1, with one that incorrectly points to port | |
4718 | 2. Afterward, the physical switch will direct packets destined for | |
4719 | the end host to the Open vSwitch on port 2, instead of to the end | |
4720 | host on port 1, disrupting connectivity. If mirroring to a VLAN is | |
4721 | desired in this scenario, then the physical switch must be replaced | |
4722 | by one that learns Ethernet addresses on a per-VLAN basis. In | |
4723 | addition, learning should be disabled on the VLAN containing mirrored | |
4724 | traffic. If this is not done then intermediate switches will learn | |
4725 | the MAC address of each end host from the mirrored traffic. If | |
4726 | packets being sent to that end host are also mirrored, then they will | |
4727 | be dropped since the switch will attempt to send them out the input | |
4728 | port. Disabling learning for the VLAN will cause the switch to | |
4729 | correctly send the packet out all ports configured for that VLAN. If | |
4730 | Open vSwitch is being used as an intermediate switch, learning can be | |
4731 | disabled by adding the mirrored VLAN to <ref column="flood_vlans"/> | |
4732 | in the appropriate <ref table="Bridge"/> table or tables.</p> | |
4733 | <p> | |
4734 | Mirroring to a GRE tunnel has fewer caveats than mirroring to a | |
4735 | VLAN and should generally be preferred. | |
4736 | </p> | |
89365653 | 4737 | </column> |
1356dbd1 WT |
4738 | |
4739 | <column name="snaplen"> | |
4740 | <p>Maximum per-packet number of bytes to mirror.</p> | |
4741 | <p>A mirrored packet with size larger than <ref column="snaplen"/> | |
4742 | will be truncated in datapath to <ref column="snaplen"/> bytes | |
4743 | before sending to the mirror output port. If omitted, packets | |
4744 | are not truncated. | |
4745 | </p> | |
4746 | </column> | |
89365653 | 4747 | </group> |
13008eb3 | 4748 | |
9d24de3b JP |
4749 | <group title="Statistics: Mirror counters"> |
4750 | <p> | |
12eb035b AW |
4751 | Key-value pairs that report mirror statistics. The update period |
4752 | is controlled by <ref column="other_config" | |
4753 | key="stats-update-interval"/> in the <code>Open_vSwitch</code> table. | |
9d24de3b JP |
4754 | </p> |
4755 | <column name="statistics" key="tx_packets"> | |
4756 | Number of packets transmitted through this mirror. | |
4757 | </column> | |
4758 | <column name="statistics" key="tx_bytes"> | |
4759 | Number of bytes transmitted through this mirror. | |
4760 | </column> | |
4761 | </group> | |
4762 | ||
3fd8d445 BP |
4763 | <group title="Common Columns"> |
4764 | The overall purpose of these columns is described under <code>Common | |
4765 | Columns</code> at the beginning of this document. | |
4766 | ||
4767 | <column name="external_ids"/> | |
13008eb3 | 4768 | </group> |
89365653 BP |
4769 | </table> |
4770 | ||
4771 | <table name="Controller" title="OpenFlow controller configuration."> | |
76ce9432 BP |
4772 | <p>An OpenFlow controller.</p> |
4773 | ||
c66be90b BP |
4774 | <group title="Core Features"> |
4775 | <column name="type"> | |
7d674866 | 4776 | <p> |
c66be90b BP |
4777 | Open vSwitch supports two kinds of OpenFlow controllers. A bridge |
4778 | may have any number of each kind: | |
7d674866 BP |
4779 | </p> |
4780 | ||
c66be90b BP |
4781 | <dl> |
4782 | <dt>Primary controllers</dt> | |
4783 | <dd> | |
4784 | <p> | |
4785 | This is the kind of controller envisioned by the OpenFlow | |
4786 | specifications. Usually, a primary controller implements a | |
4787 | network policy by taking charge of the switch's flow table. | |
4788 | </p> | |
7d674866 | 4789 | |
c66be90b BP |
4790 | <p> |
4791 | The <ref table="Bridge" column="fail_mode"/> column in the <ref | |
4792 | table="Bridge"/> table applies to primary controllers. | |
4793 | </p> | |
7d674866 | 4794 | |
c66be90b BP |
4795 | <p> |
4796 | When multiple primary controllers are configured, Open vSwitch | |
4797 | connects to all of them simultaneously. OpenFlow provides few | |
4798 | facilities to allow multiple controllers to coordinate in | |
4799 | interacting with a single switch, so more than one primary | |
4800 | controller should be specified only if the controllers are | |
4801 | themselves designed to coordinate with each other. | |
4802 | </p> | |
4803 | </dd> | |
4804 | <dt>Service controllers</dt> | |
4805 | <dd> | |
4806 | <p> | |
4807 | These kinds of OpenFlow controller connections are intended for | |
4808 | occasional support and maintenance use, e.g. with | |
4809 | <code>ovs-ofctl</code>. Usually a service controller connects | |
4810 | only briefly to inspect or modify some of a switch's state. | |
4811 | </p> | |
4812 | ||
4813 | <p> | |
4814 | The <ref table="Bridge" column="fail_mode"/> column in the <ref | |
4815 | table="Bridge"/> table does not apply to service controllers. | |
4816 | </p> | |
4817 | </dd> | |
4818 | </dl> | |
7d674866 BP |
4819 | |
4820 | <p> | |
c66be90b BP |
4821 | By default, Open vSwitch treats controllers with active connection |
4822 | methods as primary controllers and those with passive connection | |
4823 | methods as service controllers. Set this column to the desired type | |
4824 | to override this default. | |
7d674866 | 4825 | </p> |
c66be90b | 4826 | </column> |
89365653 | 4827 | |
89365653 | 4828 | <column name="target"> |
7d674866 BP |
4829 | <p>Connection method for controller.</p> |
4830 | <p> | |
c66be90b | 4831 | The following active connection methods are currently supported: |
7d674866 | 4832 | </p> |
89365653 | 4833 | <dl> |
771680d9 | 4834 | <dt><code>ssl:<var>host</var></code>[<code>:<var>port</var></code>]</dt> |
89365653 | 4835 | <dd> |
125b0291 | 4836 | <p>The specified SSL <var>port</var> on the host at the |
771680d9 YS |
4837 | given <var>host</var>, which can either be a DNS name (if built |
4838 | with unbound library) or an IP address. The <ref table="Open_vSwitch" | |
4839 | column="ssl"/> column in the <ref table="Open_vSwitch"/> table must | |
4840 | point to a valid SSL configuration when this form is used.</p> | |
d4763d1d | 4841 | <p>If <var>port</var> is not specified, it defaults to 6653.</p> |
89365653 | 4842 | <p>SSL support is an optional feature that is not always built as |
3fd8d445 | 4843 | part of Open vSwitch.</p> |
89365653 | 4844 | </dd> |
771680d9 | 4845 | <dt><code>tcp:<var>host</var></code>[<code>:<var>port</var></code>]</dt> |
125b0291 | 4846 | <dd> |
e731d71b AS |
4847 | <p> |
4848 | The specified TCP <var>port</var> on the host at the given | |
771680d9 YS |
4849 | <var>host</var>, which can either be a DNS name (if built with |
4850 | unbound library) or an IP address (IPv4 or IPv6). If <var>host</var> | |
4851 | is an IPv6 address, wrap it in square brackets, e.g. | |
4852 | <code>tcp:[::1]:6653</code>. | |
e731d71b AS |
4853 | </p> |
4854 | <p> | |
d4763d1d | 4855 | If <var>port</var> is not specified, it defaults to 6653. |
e731d71b | 4856 | </p> |
125b0291 | 4857 | </dd> |
7d674866 BP |
4858 | </dl> |
4859 | <p> | |
c66be90b | 4860 | The following passive connection methods are currently supported: |
7d674866 BP |
4861 | </p> |
4862 | <dl> | |
771680d9 | 4863 | <dt><code>pssl:</code>[<var>port</var>][<code>:<var>host</var></code>]</dt> |
7d674866 | 4864 | <dd> |
e731d71b AS |
4865 | <p> |
4866 | Listens for SSL connections on the specified TCP <var>port</var>. | |
771680d9 YS |
4867 | If <var>host</var>, which can either be a DNS name (if built with |
4868 | unbound library) or an IP address, is specified, then connections | |
4869 | are restricted to the resolved or specified local IP address | |
4870 | (either IPv4 or IPv6). If <var>host</var> is an IPv6 address, | |
4871 | wrap it in square brackets, e.g. <code>pssl:6653:[::1]</code>. | |
e731d71b AS |
4872 | </p> |
4873 | <p> | |
d4763d1d | 4874 | If <var>port</var> is not specified, it defaults to |
771680d9 | 4875 | 6653. If <var>host</var> is not specified then it listens only on |
e731d71b AS |
4876 | IPv4 (but not IPv6) addresses. The |
4877 | <ref table="Open_vSwitch" column="ssl"/> | |
4878 | column in the <ref table="Open_vSwitch"/> table must point to a | |
4879 | valid SSL configuration when this form is used. | |
4880 | </p> | |
4881 | <p> | |
d4763d1d | 4882 | If <var>port</var> is not specified, it currently to 6653. |
e731d71b AS |
4883 | </p> |
4884 | <p> | |
4885 | SSL support is an optional feature that is not always built as | |
4886 | part of Open vSwitch. | |
4887 | </p> | |
7d674866 | 4888 | </dd> |
771680d9 | 4889 | <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>host</var></code>]</dt> |
7d674866 | 4890 | <dd> |
e731d71b AS |
4891 | <p> |
4892 | Listens for connections on the specified TCP <var>port</var>. If | |
771680d9 YS |
4893 | <var>host</var>, which can either be a DNS name (if built with |
4894 | unbound library) or an IP address, is specified, then connections | |
4895 | are restricted to the resolved or specified local IP address | |
4896 | (either IPv4 or IPv6). If <var>host</var> is an IPv6 address, wrap | |
4897 | it in square brackets, e.g. <code>ptcp:6653:[::1]</code>. If | |
4898 | <var>host</var> is not specified then it listens only on IPv4 | |
4899 | addresses. | |
e731d71b AS |
4900 | </p> |
4901 | <p> | |
d4763d1d | 4902 | If <var>port</var> is not specified, it defaults to 6653. |
e731d71b | 4903 | </p> |
7d674866 | 4904 | </dd> |
89365653 | 4905 | </dl> |
9a3f4a49 | 4906 | <p>When multiple controllers are configured for a single bridge, the |
3fd8d445 BP |
4907 | <ref column="target"/> values must be unique. Duplicate |
4908 | <ref column="target"/> values yield unspecified results.</p> | |
89365653 BP |
4909 | </column> |
4910 | ||
4911 | <column name="connection_mode"> | |
9a3f4a49 JP |
4912 | <p>If it is specified, this setting must be one of the following |
4913 | strings that describes how Open vSwitch contacts this OpenFlow | |
4914 | controller over the network:</p> | |
4915 | ||
4916 | <dl> | |
4917 | <dt><code>in-band</code></dt> | |
4918 | <dd>In this mode, this controller's OpenFlow traffic travels over the | |
3fd8d445 BP |
4919 | bridge associated with the controller. With this setting, Open |
4920 | vSwitch allows traffic to and from the controller regardless of the | |
4921 | contents of the OpenFlow flow table. (Otherwise, Open vSwitch | |
4922 | would never be able to connect to the controller, because it did | |
4923 | not have a flow to enable it.) This is the most common connection | |
4924 | mode because it is not necessary to maintain two independent | |
4925 | networks.</dd> | |
9a3f4a49 JP |
4926 | <dt><code>out-of-band</code></dt> |
4927 | <dd>In this mode, OpenFlow traffic uses a control network separate | |
3fd8d445 BP |
4928 | from the bridge associated with this controller, that is, the |
4929 | bridge does not use any of its own network devices to communicate | |
4930 | with the controller. The control network must be configured | |
4931 | separately, before or after <code>ovs-vswitchd</code> is started. | |
9a3f4a49 JP |
4932 | </dd> |
4933 | </dl> | |
76ce9432 | 4934 | |
195c8086 | 4935 | <p>If not specified, the default is implementation-specific.</p> |
89365653 BP |
4936 | </column> |
4937 | </group> | |
4938 | ||
4939 | <group title="Controller Failure Detection and Handling"> | |
4940 | <column name="max_backoff"> | |
4941 | Maximum number of milliseconds to wait between connection attempts. | |
4942 | Default is implementation-specific. | |
4943 | </column> | |
4944 | ||
4945 | <column name="inactivity_probe"> | |
4946 | Maximum number of milliseconds of idle time on connection to | |
4947 | controller before sending an inactivity probe message. If Open | |
4948 | vSwitch does not communicate with the controller for the specified | |
4949 | number of seconds, it will send a probe. If a response is not | |
4950 | received for the same additional amount of time, Open vSwitch | |
4951 | assumes the connection has been broken and attempts to reconnect. | |
2bb82bf0 BP |
4952 | Default is implementation-specific. A value of 0 disables |
4953 | inactivity probes. | |
89365653 | 4954 | </column> |
89365653 BP |
4955 | </group> |
4956 | ||
a413195e | 4957 | <group title="Asynchronous Messages"> |
9886b662 BP |
4958 | <p> |
4959 | OpenFlow switches send certain messages to controllers spontanenously, | |
4960 | that is, not in response to any request from the controller. These | |
4961 | messages are called ``asynchronous messages.'' These columns allow | |
4962 | asynchronous messages to be limited or disabled to ensure the best use | |
4963 | of network resources. | |
4964 | </p> | |
4965 | ||
4966 | <column name="enable_async_messages"> | |
4967 | The OpenFlow protocol enables asynchronous messages at time of | |
4968 | connection establishment, which means that a controller can receive | |
4969 | asynchronous messages, potentially many of them, even if it turns them | |
4970 | off immediately after connecting. Set this column to | |
4971 | <code>false</code> to change Open vSwitch behavior to disable, by | |
4972 | default, all asynchronous messages. The controller can use the | |
4973 | <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn | |
4974 | on any messages that it does want to receive, if any. | |
4975 | </column> | |
4976 | ||
a413195e | 4977 | <group title="Controller Rate Limiting"> |
ebb65354 | 4978 | <p> |
a413195e BP |
4979 | A switch can forward packets to a controller over the OpenFlow |
4980 | protocol. Forwarding packets this way at too high a rate can | |
4981 | overwhelm a controller, frustrate use of the OpenFlow connection for | |
4982 | other purposes, increase the latency of flow setup, and use an | |
4983 | unreasonable amount of bandwidth. Therefore, Open vSwitch supports | |
4984 | limiting the rate of packet forwarding to a controller. | |
ebb65354 BP |
4985 | </p> |
4986 | ||
4987 | <p> | |
a413195e BP |
4988 | There are two main reasons in OpenFlow for a packet to be sent to a |
4989 | controller: either the packet ``misses'' in the flow table, that is, | |
4990 | there is no matching flow, or a flow table action says to send the | |
4991 | packet to the controller. Open vSwitch limits the rate of each kind | |
4992 | of packet separately at the configured rate. Therefore, the actual | |
4993 | rate that packets are sent to the controller can be up to twice the | |
4994 | configured rate, when packets are sent for both reasons. | |
ebb65354 BP |
4995 | </p> |
4996 | ||
4997 | <p> | |
a413195e BP |
4998 | This feature is specific to forwarding packets over an OpenFlow |
4999 | connection. It is not general-purpose QoS. See the <ref | |
5000 | table="QoS"/> table for quality of service configuration, and <ref | |
5001 | column="ingress_policing_rate" table="Interface"/> in the <ref | |
5002 | table="Interface"/> table for ingress policing configuration. | |
ebb65354 | 5003 | </p> |
3fd8d445 | 5004 | |
3dabc687 DC |
5005 | <column name="controller_queue_size"> |
5006 | <p> | |
5007 | This sets the maximum size of the queue of packets that need to be | |
5008 | sent to this OpenFlow controller. The value must be less than 512. | |
5009 | If not specified the queue size is limited to the value set for | |
5010 | the management controller in <ref table="Bridge" | |
5011 | column="other_config" key="controller-queue-size"/> if present or | |
5012 | 100 packets by default. Note: increasing the queue size might | |
5013 | have a negative impact on latency. | |
5014 | </p> | |
5015 | </column> | |
5016 | ||
a413195e BP |
5017 | <column name="controller_rate_limit"> |
5018 | <p> | |
5019 | The maximum rate at which the switch will forward packets to the | |
5020 | OpenFlow controller, in packets per second. If no value is | |
5021 | specified, rate limiting is disabled. | |
5022 | </p> | |
5023 | </column> | |
5024 | ||
5025 | <column name="controller_burst_limit"> | |
5026 | <p> | |
5027 | When a high rate triggers rate-limiting, Open vSwitch queues | |
5028 | packets to the controller for each port and transmits them to the | |
5029 | controller at the configured rate. This value limits the number of | |
5030 | queued packets. Ports on a bridge share the packet queue fairly. | |
5031 | </p> | |
5032 | ||
5033 | <p> | |
5034 | This value has no effect unless <ref | |
5035 | column="controller_rate_limit"/> is configured. The current | |
5036 | default when this value is not specified is one-quarter of <ref | |
5037 | column="controller_rate_limit"/>, meaning that queuing can delay | |
5038 | forwarding a packet to the controller by up to 250 ms. | |
5039 | </p> | |
5040 | </column> | |
5041 | ||
5042 | <group title="Controller Rate Limiting Statistics"> | |
5043 | <p> | |
5044 | These values report the effects of rate limiting. Their values are | |
5045 | relative to establishment of the most recent OpenFlow connection, | |
5046 | or since rate limiting was enabled, whichever happened more | |
5047 | recently. Each consists of two values, one with <code>TYPE</code> | |
5048 | replaced by <code>miss</code> for rate limiting flow table misses, | |
5049 | and the other with <code>TYPE</code> replaced by | |
5050 | <code>action</code> for rate limiting packets sent by OpenFlow | |
5051 | actions. | |
5052 | </p> | |
5053 | ||
5054 | <p> | |
5055 | These statistics are reported only when controller rate limiting is | |
5056 | enabled. | |
5057 | </p> | |
5058 | ||
5059 | <column name="status" key="packet-in-TYPE-bypassed" | |
5060 | type='{"type": "integer", "minInteger": 0}'> | |
5061 | Number of packets sent directly to the controller, without queuing, | |
5062 | because the rate did not exceed the configured maximum. | |
5063 | </column> | |
5064 | ||
5065 | <column name="status" key="packet-in-TYPE-queued" | |
5066 | type='{"type": "integer", "minInteger": 0}'> | |
5067 | Number of packets added to the queue to send later. | |
5068 | </column> | |
5069 | ||
5070 | <column name="status" key="packet-in-TYPE-dropped" | |
5071 | type='{"type": "integer", "minInteger": 0}'> | |
5072 | Number of packets added to the queue that were later dropped due to | |
5073 | overflow. This value is less than or equal to <ref column="status" | |
5074 | key="packet-in-TYPE-queued"/>. | |
5075 | </column> | |
5076 | ||
5077 | <column name="status" key="packet-in-TYPE-backlog" | |
5078 | type='{"type": "integer", "minInteger": 0}'> | |
5079 | Number of packets currently queued. The other statistics increase | |
5080 | monotonically, but this one fluctuates between 0 and the <ref | |
5081 | column="controller_burst_limit"/> as conditions change. | |
5082 | </column> | |
5083 | </group> | |
5084 | </group> | |
89365653 BP |
5085 | </group> |
5086 | ||
76ce9432 BP |
5087 | <group title="Additional In-Band Configuration"> |
5088 | <p>These values are considered only in in-band control mode (see | |
3fd8d445 | 5089 | <ref column="connection_mode"/>).</p> |
76ce9432 BP |
5090 | |
5091 | <p>When multiple controllers are configured on a single bridge, there | |
3fd8d445 BP |
5092 | should be only one set of unique values in these columns. If different |
5093 | values are set for these columns in different controllers, the effect | |
5094 | is unspecified.</p> | |
89365653 BP |
5095 | |
5096 | <column name="local_ip"> | |
76ce9432 BP |
5097 | The IP address to configure on the local port, |
5098 | e.g. <code>192.168.0.123</code>. If this value is unset, then | |
5099 | <ref column="local_netmask"/> and <ref column="local_gateway"/> are | |
5100 | ignored. | |
89365653 BP |
5101 | </column> |
5102 | ||
5103 | <column name="local_netmask"> | |
76ce9432 BP |
5104 | The IP netmask to configure on the local port, |
5105 | e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set | |
5106 | but this value is unset, then the default is chosen based on whether | |
5107 | the IP address is class A, B, or C. | |
5108 | </column> | |
5109 | ||
5110 | <column name="local_gateway"> | |
5111 | The IP address of the gateway to configure on the local port, as a | |
5112 | string, e.g. <code>192.168.0.1</code>. Leave this column unset if | |
5113 | this network has no gateway. | |
89365653 BP |
5114 | </column> |
5115 | </group> | |
13008eb3 | 5116 | |
bffc0589 AE |
5117 | <group title="Controller Status"> |
5118 | <column name="is_connected"> | |
5119 | <code>true</code> if currently connected to this controller, | |
5120 | <code>false</code> otherwise. | |
5121 | </column> | |
5122 | ||
f9e5e5b3 BP |
5123 | <column name="role" |
5124 | type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'> | |
bffc0589 | 5125 | <p>The level of authority this controller has on the associated |
3fd8d445 | 5126 | bridge. Possible values are:</p> |
bffc0589 AE |
5127 | <dl> |
5128 | <dt><code>other</code></dt> | |
5129 | <dd>Allows the controller access to all OpenFlow features.</dd> | |
bffc0589 AE |
5130 | <dt><code>master</code></dt> |
5131 | <dd>Equivalent to <code>other</code>, except that there may be at | |
3fd8d445 BP |
5132 | most one master controller at a time. When a controller configures |
5133 | itself as <code>master</code>, any existing master is demoted to | |
9f90ed90 | 5134 | the <code>slave</code> role.</dd> |
bffc0589 AE |
5135 | <dt><code>slave</code></dt> |
5136 | <dd>Allows the controller read-only access to OpenFlow features. | |
3fd8d445 BP |
5137 | Attempts to modify the flow table will be rejected with an |
5138 | error. Slave controllers do not receive OFPT_PACKET_IN or | |
5139 | OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS | |
5140 | messages.</dd> | |
bffc0589 AE |
5141 | </dl> |
5142 | </column> | |
5143 | ||
3fd8d445 BP |
5144 | <column name="status" key="last_error"> |
5145 | A human-readable description of the last error on the connection | |
5146 | to the controller; i.e. <code>strerror(errno)</code>. This key | |
5147 | will exist only if an error has occurred. | |
5148 | </column> | |
5149 | ||
f9e5e5b3 BP |
5150 | <column name="status" key="state" |
5151 | type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'> | |
3fd8d445 | 5152 | <p> |
f9e5e5b3 | 5153 | The state of the connection to the controller: |
3fd8d445 | 5154 | </p> |
bffc0589 | 5155 | <dl> |
3fd8d445 BP |
5156 | <dt><code>VOID</code></dt> |
5157 | <dd>Connection is disabled.</dd> | |
5158 | ||
5159 | <dt><code>BACKOFF</code></dt> | |
5160 | <dd>Attempting to reconnect at an increasing period.</dd> | |
5161 | ||
5162 | <dt><code>CONNECTING</code></dt> | |
5163 | <dd>Attempting to connect.</dd> | |
5164 | ||
5165 | <dt><code>ACTIVE</code></dt> | |
5166 | <dd>Connected, remote host responsive.</dd> | |
5167 | ||
5168 | <dt><code>IDLE</code></dt> | |
5169 | <dd>Connection is idle. Waiting for response to keep-alive.</dd> | |
bffc0589 | 5170 | </dl> |
3fd8d445 BP |
5171 | <p> |
5172 | These values may change in the future. They are provided only for | |
5173 | human consumption. | |
5174 | </p> | |
5175 | </column> | |
9cc6bf75 | 5176 | |
f9e5e5b3 BP |
5177 | <column name="status" key="sec_since_connect" |
5178 | type='{"type": "integer", "minInteger": 0}'> | |
3fd8d445 BP |
5179 | The amount of time since this controller last successfully connected to |
5180 | the switch (in seconds). Value is empty if controller has never | |
5181 | successfully connected. | |
bffc0589 | 5182 | </column> |
9cc6bf75 | 5183 | |
f9e5e5b3 BP |
5184 | <column name="status" key="sec_since_disconnect" |
5185 | type='{"type": "integer", "minInteger": 1}'> | |
3fd8d445 BP |
5186 | The amount of time since this controller last disconnected from |
5187 | the switch (in seconds). Value is empty if controller has never | |
5188 | disconnected. | |
5189 | </column> | |
5190 | </group> | |
5191 | ||
f125905c MM |
5192 | <group title="Connection Parameters"> |
5193 | <p> | |
5194 | Additional configuration for a connection between the controller | |
5195 | and the Open vSwitch. | |
5196 | </p> | |
5197 | ||
5198 | <column name="other_config" key="dscp" | |
039a8ccd | 5199 | type='{"type": "integer"}'> |
cea15768 EJ |
5200 | The Differentiated Service Code Point (DSCP) is specified using 6 bits |
5201 | in the Type of Service (TOS) field in the IP header. DSCP provides a | |
5202 | mechanism to classify the network traffic and provide Quality of | |
5203 | Service (QoS) on IP networks. | |
5204 | ||
5205 | The DSCP value specified here is used when establishing the connection | |
0442efd9 MM |
5206 | between the controller and the Open vSwitch. If no value is specified, |
5207 | a default value of 48 is chosen. Valid DSCP values must be in the | |
5208 | range 0 to 63. | |
f125905c MM |
5209 | </column> |
5210 | </group> | |
5211 | ||
5212 | ||
3fd8d445 BP |
5213 | <group title="Common Columns"> |
5214 | The overall purpose of these columns is described under <code>Common | |
5215 | Columns</code> at the beginning of this document. | |
5216 | ||
5217 | <column name="external_ids"/> | |
f125905c | 5218 | <column name="other_config"/> |
bffc0589 | 5219 | </group> |
89365653 BP |
5220 | </table> |
5221 | ||
94db5407 BP |
5222 | <table name="Manager" title="OVSDB management connection."> |
5223 | <p> | |
5224 | Configuration for a database connection to an Open vSwitch database | |
5225 | (OVSDB) client. | |
5226 | </p> | |
5227 | ||
5228 | <p> | |
5229 | This table primarily configures the Open vSwitch database | |
5230 | (<code>ovsdb-server</code>), not the Open vSwitch switch | |
5231 | (<code>ovs-vswitchd</code>). The switch does read the table to determine | |
5232 | what connections should be treated as in-band. | |
5233 | </p> | |
5234 | ||
5235 | <p> | |
5236 | The Open vSwitch database server can initiate and maintain active | |
5237 | connections to remote clients. It can also listen for database | |
5238 | connections. | |
5239 | </p> | |
5240 | ||
5241 | <group title="Core Features"> | |
5242 | <column name="target"> | |
5243 | <p>Connection method for managers.</p> | |
5244 | <p> | |
5245 | The following connection methods are currently supported: | |
5246 | </p> | |
5247 | <dl> | |
771680d9 | 5248 | <dt><code>ssl:<var>host</var></code>[<code>:<var>port</var></code>]</dt> |
94db5407 BP |
5249 | <dd> |
5250 | <p> | |
efc295d2 | 5251 | The specified SSL <var>port</var> on the host at the given |
771680d9 YS |
5252 | <var>host</var>, which can either be a DNS name (if built with |
5253 | unbound library) or an IP address. The <ref table="Open_vSwitch" | |
efc295d2 JP |
5254 | column="ssl"/> column in the <ref table="Open_vSwitch"/> |
5255 | table must point to a valid SSL configuration when this | |
5256 | form is used. | |
94db5407 BP |
5257 | </p> |
5258 | <p> | |
d4763d1d | 5259 | If <var>port</var> is not specified, it defaults to 6640. |
efc295d2 JP |
5260 | </p> |
5261 | <p> | |
5262 | SSL support is an optional feature that is not always | |
5263 | built as part of Open vSwitch. | |
94db5407 BP |
5264 | </p> |
5265 | </dd> | |
5266 | ||
771680d9 | 5267 | <dt><code>tcp:<var>host</var></code>[<code>:<var>port</var></code>]</dt> |
94db5407 | 5268 | <dd> |
efc295d2 JP |
5269 | <p> |
5270 | The specified TCP <var>port</var> on the host at the given | |
771680d9 YS |
5271 | <var>host</var>, which can either be a DNS name (if built with |
5272 | unbound library) or an IP address (IPv4 or IPv6). If <var>host</var> | |
5273 | is an IPv6 address, wrap it in square brackets, e.g. | |
5274 | <code>tcp:[::1]:6640</code>. | |
efc295d2 JP |
5275 | </p> |
5276 | <p> | |
d4763d1d | 5277 | If <var>port</var> is not specified, it defaults to 6640. |
efc295d2 | 5278 | </p> |
94db5407 | 5279 | </dd> |
771680d9 | 5280 | <dt><code>pssl:</code>[<var>port</var>][<code>:<var>host</var></code>]</dt> |
94db5407 BP |
5281 | <dd> |
5282 | <p> | |
e731d71b AS |
5283 | Listens for SSL connections on the specified TCP <var>port</var>. |
5284 | Specify 0 for <var>port</var> to have the kernel automatically | |
771680d9 YS |
5285 | choose an available port. If <var>host</var>, which can either |
5286 | be a DNS name (if built with unbound library) or an IP address, | |
5287 | is specified, then connections are restricted to the resolved or | |
5288 | specified local IP address (either IPv4 or IPv6 address). If | |
5289 | <var>host</var> is an IPv6 address, wrap in square brackets, | |
5290 | e.g. <code>pssl:6640:[::1]</code>. If <var>host</var> is not | |
e731d71b AS |
5291 | specified then it listens only on IPv4 (but not IPv6) addresses. |
5292 | The <ref table="Open_vSwitch" column="ssl"/> column in the <ref | |
94db5407 BP |
5293 | table="Open_vSwitch"/> table must point to a valid SSL |
5294 | configuration when this form is used. | |
5295 | </p> | |
efc295d2 | 5296 | <p> |
d4763d1d | 5297 | If <var>port</var> is not specified, it defaults to 6640. |
efc295d2 | 5298 | </p> |
94db5407 BP |
5299 | <p> |
5300 | SSL support is an optional feature that is not always built as | |
5301 | part of Open vSwitch. | |
5302 | </p> | |
5303 | </dd> | |
771680d9 | 5304 | <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>host</var></code>]</dt> |
94db5407 | 5305 | <dd> |
efc295d2 | 5306 | <p> |
e731d71b AS |
5307 | Listens for connections on the specified TCP <var>port</var>. |
5308 | Specify 0 for <var>port</var> to have the kernel automatically | |
771680d9 YS |
5309 | choose an available port. If <var>host</var>, which can either |
5310 | be a DNS name (if built with unbound library) or an IP address, | |
5311 | is specified, then connections are restricted to the resolved or | |
5312 | specified local IP address (either IPv4 or IPv6 address). If | |
5313 | <var>host</var> is an IPv6 address, wrap it in square brackets, | |
5314 | e.g. <code>ptcp:6640:[::1]</code>. If <var>host</var> is not | |
e731d71b | 5315 | specified then it listens only on IPv4 addresses. |
efc295d2 JP |
5316 | </p> |
5317 | <p> | |
d4763d1d | 5318 | If <var>port</var> is not specified, it defaults to 6640. |
efc295d2 | 5319 | </p> |
94db5407 BP |
5320 | </dd> |
5321 | </dl> | |
5322 | <p>When multiple managers are configured, the <ref column="target"/> | |
5323 | values must be unique. Duplicate <ref column="target"/> values yield | |
5324 | unspecified results.</p> | |
5325 | </column> | |
5326 | ||
5327 | <column name="connection_mode"> | |
5328 | <p> | |
5329 | If it is specified, this setting must be one of the following strings | |
5330 | that describes how Open vSwitch contacts this OVSDB client over the | |
5331 | network: | |
5332 | </p> | |
299a244b | 5333 | |
94db5407 BP |
5334 | <dl> |
5335 | <dt><code>in-band</code></dt> | |
5336 | <dd> | |
5337 | In this mode, this connection's traffic travels over a bridge | |
5338 | managed by Open vSwitch. With this setting, Open vSwitch allows | |
5339 | traffic to and from the client regardless of the contents of the | |
5340 | OpenFlow flow table. (Otherwise, Open vSwitch would never be able | |
5341 | to connect to the client, because it did not have a flow to enable | |
5342 | it.) This is the most common connection mode because it is not | |
5343 | necessary to maintain two independent networks. | |
5344 | </dd> | |
5345 | <dt><code>out-of-band</code></dt> | |
5346 | <dd> | |
5347 | In this mode, the client's traffic uses a control network separate | |
5348 | from that managed by Open vSwitch, that is, Open vSwitch does not | |
5349 | use any of its own network devices to communicate with the client. | |
5350 | The control network must be configured separately, before or after | |
5351 | <code>ovs-vswitchd</code> is started. | |
5352 | </dd> | |
5353 | </dl> | |
5354 | ||
5355 | <p> | |
5356 | If not specified, the default is implementation-specific. | |
5357 | </p> | |
5358 | </column> | |
5359 | </group> | |
5360 | ||
5361 | <group title="Client Failure Detection and Handling"> | |
5362 | <column name="max_backoff"> | |
5363 | Maximum number of milliseconds to wait between connection attempts. | |
5364 | Default is implementation-specific. | |
5365 | </column> | |
5366 | ||
5367 | <column name="inactivity_probe"> | |
5368 | Maximum number of milliseconds of idle time on connection to the client | |
5369 | before sending an inactivity probe message. If Open vSwitch does not | |
5370 | communicate with the client for the specified number of seconds, it | |
5371 | will send a probe. If a response is not received for the same | |
5372 | additional amount of time, Open vSwitch assumes the connection has been | |
5373 | broken and attempts to reconnect. Default is implementation-specific. | |
2bb82bf0 | 5374 | A value of 0 disables inactivity probes. |
94db5407 BP |
5375 | </column> |
5376 | </group> | |
5377 | ||
0b3e7a8b | 5378 | <group title="Status"> |
600766e8 AZ |
5379 | <p> |
5380 | Key-value pair of <ref column="is_connected"/> is always updated. | |
5381 | Other key-value pairs in the status columns may be updated depends | |
5382 | on the <ref column="target"/> type. | |
5383 | </p> | |
5384 | ||
5385 | <p> | |
5386 | When <ref column="target"/> specifies a connection method that | |
5387 | listens for inbound connections (e.g. <code>ptcp:</code> or | |
5388 | <code>punix:</code>), both <ref column="n_connections"/> and | |
5389 | <ref column="is_connected"/> may also be updated while the | |
5390 | remaining key-value pairs are omitted. | |
5391 | </p> | |
5392 | ||
5393 | <p> | |
5394 | On the other hand, when <ref column="target"/> specifies an | |
5395 | outbound connection, all key-value pairs may be updated, except | |
5396 | the above-mentioned two key-value pairs associated with inbound | |
5397 | connection targets. They are omitted. | |
5398 | </p> | |
5399 | ||
5400 | <column name="is_connected"> | |
0b3e7a8b AE |
5401 | <code>true</code> if currently connected to this manager, |
5402 | <code>false</code> otherwise. | |
5403 | </column> | |
5404 | ||
3fd8d445 BP |
5405 | <column name="status" key="last_error"> |
5406 | A human-readable description of the last error on the connection | |
5407 | to the manager; i.e. <code>strerror(errno)</code>. This key | |
5408 | will exist only if an error has occurred. | |
5409 | </column> | |
5410 | ||
f9e5e5b3 BP |
5411 | <column name="status" key="state" |
5412 | type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'> | |
3fd8d445 | 5413 | <p> |
f9e5e5b3 | 5414 | The state of the connection to the manager: |
3fd8d445 | 5415 | </p> |
a11f6164 | 5416 | <dl> |
3fd8d445 BP |
5417 | <dt><code>VOID</code></dt> |
5418 | <dd>Connection is disabled.</dd> | |
5419 | ||
5420 | <dt><code>BACKOFF</code></dt> | |
5421 | <dd>Attempting to reconnect at an increasing period.</dd> | |
5422 | ||
5423 | <dt><code>CONNECTING</code></dt> | |
5424 | <dd>Attempting to connect.</dd> | |
5425 | ||
5426 | <dt><code>ACTIVE</code></dt> | |
5427 | <dd>Connected, remote host responsive.</dd> | |
5428 | ||
5429 | <dt><code>IDLE</code></dt> | |
5430 | <dd>Connection is idle. Waiting for response to keep-alive.</dd> | |
a11f6164 | 5431 | </dl> |
3fd8d445 BP |
5432 | <p> |
5433 | These values may change in the future. They are provided only for | |
5434 | human consumption. | |
5435 | </p> | |
5436 | </column> | |
5437 | ||
f9e5e5b3 BP |
5438 | <column name="status" key="sec_since_connect" |
5439 | type='{"type": "integer", "minInteger": 0}'> | |
3fd8d445 BP |
5440 | The amount of time since this manager last successfully connected |
5441 | to the database (in seconds). Value is empty if manager has never | |
5442 | successfully connected. | |
5443 | </column> | |
5444 | ||
f9e5e5b3 BP |
5445 | <column name="status" key="sec_since_disconnect" |
5446 | type='{"type": "integer", "minInteger": 0}'> | |
3fd8d445 BP |
5447 | The amount of time since this manager last disconnected from the |
5448 | database (in seconds). Value is empty if manager has never | |
5449 | disconnected. | |
5450 | </column> | |
5451 | ||
5452 | <column name="status" key="locks_held"> | |
5453 | Space-separated list of the names of OVSDB locks that the connection | |
5454 | holds. Omitted if the connection does not hold any locks. | |
5455 | </column> | |
5456 | ||
5457 | <column name="status" key="locks_waiting"> | |
5458 | Space-separated list of the names of OVSDB locks that the connection is | |
5459 | currently waiting to acquire. Omitted if the connection is not waiting | |
5460 | for any locks. | |
5461 | </column> | |
5462 | ||
5463 | <column name="status" key="locks_lost"> | |
5464 | Space-separated list of the names of OVSDB locks that the connection | |
5465 | has had stolen by another OVSDB client. Omitted if no locks have been | |
5466 | stolen from this connection. | |
5467 | </column> | |
5468 | ||
f9e5e5b3 BP |
5469 | <column name="status" key="n_connections" |
5470 | type='{"type": "integer", "minInteger": 2}'> | |
600766e8 AZ |
5471 | When <ref column="target"/> specifies a connection method that |
5472 | listens for inbound connections (e.g. <code>ptcp:</code> or | |
5473 | <code>pssl:</code>) and more than one connection is actually active, | |
5474 | the value is the number of active connections. Otherwise, this | |
5475 | key-value pair is omitted. | |
0b3e7a8b | 5476 | </column> |
798e1352 BP |
5477 | |
5478 | <column name="status" key="bound_port" type='{"type": "integer"}'> | |
039a8ccd BP |
5479 | When <ref column="target"/> is <code>ptcp:</code> or |
5480 | <code>pssl:</code>, this is the TCP port on which the OVSDB server is | |
6c75e208 | 5481 | listening. (This is particularly useful when <ref |
039a8ccd BP |
5482 | column="target"/> specifies a port of 0, allowing the kernel to |
5483 | choose any available port.) | |
798e1352 | 5484 | </column> |
0b3e7a8b | 5485 | </group> |
3fd8d445 | 5486 | |
f125905c MM |
5487 | <group title="Connection Parameters"> |
5488 | <p> | |
5489 | Additional configuration for a connection between the manager | |
5490 | and the Open vSwitch Database. | |
5491 | </p> | |
5492 | ||
5493 | <column name="other_config" key="dscp" | |
039a8ccd | 5494 | type='{"type": "integer"}'> |
cea15768 EJ |
5495 | The Differentiated Service Code Point (DSCP) is specified using 6 bits |
5496 | in the Type of Service (TOS) field in the IP header. DSCP provides a | |
5497 | mechanism to classify the network traffic and provide Quality of | |
5498 | Service (QoS) on IP networks. | |
5499 | ||
5500 | The DSCP value specified here is used when establishing the connection | |
0442efd9 MM |
5501 | between the manager and the Open vSwitch. If no value is specified, a |
5502 | default value of 48 is chosen. Valid DSCP values must be in the range | |
5503 | 0 to 63. | |
f125905c MM |
5504 | </column> |
5505 | </group> | |
5506 | ||
3fd8d445 BP |
5507 | <group title="Common Columns"> |
5508 | The overall purpose of these columns is described under <code>Common | |
5509 | Columns</code> at the beginning of this document. | |
5510 | ||
5511 | <column name="external_ids"/> | |
f125905c | 5512 | <column name="other_config"/> |
3fd8d445 | 5513 | </group> |
94db5407 BP |
5514 | </table> |
5515 | ||
89365653 BP |
5516 | <table name="NetFlow"> |
5517 | A NetFlow target. NetFlow is a protocol that exports a number of | |
5518 | details about terminating IP flows, such as the principals involved | |
5519 | and duration. | |
5520 | ||
5521 | <column name="targets"> | |
5522 | NetFlow targets in the form | |
5523 | <code><var>ip</var>:<var>port</var></code>. The <var>ip</var> | |
5524 | must be specified numerically, not as a DNS name. | |
5525 | </column> | |
5526 | ||
5527 | <column name="engine_id"> | |
5528 | Engine ID to use in NetFlow messages. Defaults to datapath index | |
5529 | if not specified. | |
5530 | </column> | |
5531 | ||
5532 | <column name="engine_type"> | |
5533 | Engine type to use in NetFlow messages. Defaults to datapath | |
5534 | index if not specified. | |
5535 | </column> | |
5536 | ||
5537 | <column name="active_timeout"> | |
a70f8b11 | 5538 | <p> |
039a8ccd BP |
5539 | The interval at which NetFlow records are sent for flows that |
5540 | are still active, in seconds. A value of <code>0</code> | |
5541 | requests the default timeout (currently 600 seconds); a value | |
5542 | of <code>-1</code> disables active timeouts. | |
a70f8b11 BP |
5543 | </p> |
5544 | ||
5545 | <p> | |
039a8ccd BP |
5546 | The NetFlow passive timeout, for flows that become inactive, |
5547 | is not configurable. It will vary depending on the Open | |
5548 | vSwitch version, the forms and contents of the OpenFlow flow | |
5549 | tables, CPU and memory usage, and network activity. A typical | |
5550 | passive timeout is about a second. | |
a70f8b11 | 5551 | </p> |
89365653 BP |
5552 | </column> |
5553 | ||
5554 | <column name="add_id_to_interface"> | |
5555 | <p>If this column's value is <code>false</code>, the ingress and egress | |
3fd8d445 BP |
5556 | interface fields of NetFlow flow records are derived from OpenFlow port |
5557 | numbers. When it is <code>true</code>, the 7 most significant bits of | |
5558 | these fields will be replaced by the least significant 7 bits of the | |
5559 | engine id. This is useful because many NetFlow collectors do not | |
5560 | expect multiple switches to be sending messages from the same host, so | |
5561 | they do not store the engine information which could be used to | |
5562 | disambiguate the traffic.</p> | |
89365653 BP |
5563 | <p>When this option is enabled, a maximum of 508 ports are supported.</p> |
5564 | </column> | |
13008eb3 | 5565 | |
3fd8d445 BP |
5566 | <group title="Common Columns"> |
5567 | The overall purpose of these columns is described under <code>Common | |
5568 | Columns</code> at the beginning of this document. | |
5569 | ||
5570 | <column name="external_ids"/> | |
5571 | </group> | |
89365653 BP |
5572 | </table> |
5573 | ||
61a5264d JP |
5574 | <table name="Datapath"> |
5575 | <p> | |
5576 | Configuration for a datapath within <ref table="Open_vSwitch"/>. | |
5577 | </p> | |
5578 | <p> | |
5579 | A datapath is responsible for providing the packet handling in Open | |
5580 | vSwitch. There are two primary datapath implementations used by | |
5581 | Open vSwitch: kernel and userspace. Kernel datapath | |
5582 | implementations are available for Linux and Hyper-V, and selected | |
5583 | as <code>system</code> in the <ref column="datapath_type"/> column | |
5584 | of the <ref table="Bridge"/> table. The userspace datapath is used | |
5585 | by DPDK and AF-XDP, and is selected as <code>netdev</code> in the | |
5586 | <ref column="datapath_type"/> column of the <ref table="Bridge"/> | |
5587 | table. | |
5588 | </p> | |
5589 | <p> | |
5590 | A datapath of a particular type is shared by all the bridges that use | |
5591 | that datapath. Thus, configurations applied to this table affect | |
5592 | all bridges that use this datapath. | |
5593 | </p> | |
5594 | ||
5595 | <column name="datapath_version"> | |
5596 | <p> | |
5597 | Reports the version number of the Open vSwitch datapath in use. | |
5598 | This allows management software to detect and report discrepancies | |
5599 | between Open vSwitch userspace and datapath versions. (The <ref | |
5600 | column="ovs_version" table="Open_vSwitch"/> column in the <ref | |
5601 | table="Open_vSwitch"/> reports the Open vSwitch userspace version.) | |
5602 | The version reported depends on the datapath in use: | |
5603 | </p> | |
5604 | ||
5605 | <ul> | |
5606 | <li> | |
5607 | When the kernel module included in the Open vSwitch source tree is | |
5608 | used, this column reports the Open vSwitch version from which the | |
5609 | module was taken. | |
5610 | </li> | |
5611 | ||
5612 | <li> | |
5613 | When the kernel module that is part of the upstream Linux kernel is | |
5614 | used, this column reports <code><unknown></code>. | |
5615 | </li> | |
5616 | ||
5617 | <li> | |
5618 | When the datapath is built into the <code>ovs-vswitchd</code> | |
5619 | binary, this column reports <code><built-in></code>. A | |
5620 | built-in datapath is by definition the same version as the rest of | |
5621 | the Open vSwitch userspace. | |
5622 | </li> | |
5623 | ||
5624 | <li> | |
5625 | Other datapaths (such as the Hyper-V kernel datapath) currently | |
5626 | report <code><unknown></code>. | |
5627 | </li> | |
5628 | </ul> | |
5629 | ||
5630 | <p> | |
5631 | A version discrepancy between <code>ovs-vswitchd</code> and the | |
5632 | datapath in use is not normally cause for alarm. The Open vSwitch | |
5633 | kernel datapaths for Linux and Hyper-V, in particular, are designed | |
5634 | for maximum inter-version compatibility: any userspace version works | |
5635 | with with any kernel version. Some reasons do exist to insist on | |
5636 | particular user/kernel pairings. First, newer kernel versions add | |
5637 | new features, that can only be used by new-enough userspace, e.g. | |
5638 | VXLAN tunneling requires certain minimal userspace and kernel | |
5639 | versions. Second, as an extension to the first reason, some newer | |
5640 | kernel versions add new features for enhancing performance that only | |
5641 | new-enough userspace versions can take advantage of. | |
5642 | </p> | |
5643 | </column> | |
5644 | ||
5645 | <column name="ct_zones"> | |
5646 | Configuration for connection tracking zones. Each pair maps from a | |
5647 | zone id to a configuration for that zone. Zone <code>0</code> applies | |
5648 | to the default zone (ie, the one used if a zone is not specified in | |
5649 | connection tracking-related OpenFlow matches and actions). | |
5650 | </column> | |
5651 | ||
5652 | <group title="Common Columns"> | |
5653 | The overall purpose of these columns is described under <code>Common | |
5654 | Columns</code> at the beginning of this document. | |
5655 | ||
5656 | <column name="external_ids"/> | |
5657 | </group> | |
5658 | </table> | |
5659 | ||
5660 | <table name="CT_Zone"> | |
5661 | Connection tracking zone configuration | |
5662 | ||
5663 | <column name="timeout_policy"> | |
5664 | Connection tracking timeout policy for this zone. If a timeout policy | |
5665 | is not specified, it defaults to the timeout policy in the system. | |
5666 | </column> | |
5667 | ||
5668 | <group title="Common Columns"> | |
5669 | The overall purpose of these columns is described under <code>Common | |
5670 | Columns</code> at the beginning of this document. | |
5671 | ||
5672 | <column name="external_ids"/> | |
5673 | </group> | |
5674 | </table> | |
5675 | ||
5676 | <table name="CT_Timeout_Policy"> | |
5677 | Connection tracking timeout policy configuration | |
5678 | ||
5679 | <group title="Timeouts"> | |
5680 | <column name="timeouts"> | |
5681 | The <code>timeouts</code> column contains key-value pairs used | |
5682 | to configure connection tracking timeouts in a datapath. | |
5683 | Key-value pairs that are not supported by a datapath are | |
5684 | ignored. The timeout value is in seconds. | |
5685 | </column> | |
5686 | ||
5687 | <group title="TCP Timeouts"> | |
5688 | <column name="timeouts" key="tcp_syn_sent"> | |
5689 | The timeout for the connection after the first TCP SYN packet has | |
5690 | been seen by conntrack. | |
5691 | </column> | |
5692 | ||
5693 | <column name="timeouts" key="tcp_syn_recv"> | |
5694 | The timeout of the connection after the first TCP SYN-ACK packet | |
5695 | has been seen by conntrack. | |
5696 | </column> | |
5697 | ||
5698 | <column name="timeouts" key="tcp_established"> | |
5699 | The timeout of the connection after the connection has been fully | |
5700 | established. | |
5701 | </column> | |
5702 | ||
5703 | <column name="timeouts" key="tcp_fin_wait"> | |
5704 | The timeout of the connection after the first TCP FIN packet | |
5705 | has been seen by conntrack. | |
5706 | </column> | |
5707 | ||
5708 | <column name="timeouts" key="tcp_close_wait"> | |
5709 | The timeout of the connection after the first TCP ACK packet | |
5710 | has been seen after it receives TCP FIN packet. This timeout | |
5711 | is only supported by the Linux kernel datapath. | |
5712 | </column> | |
5713 | ||
5714 | <column name="timeouts" key="tcp_last_ack"> | |
5715 | The timeout of the connection after TCP FIN packets have been | |
5716 | seen by conntrack from both directions. This timeout is only | |
5717 | supported by the Linux kernel datapath. | |
5718 | </column> | |
5719 | ||
5720 | <column name="timeouts" key="tcp_time_wait"> | |
5721 | The timeout of the connection after conntrack has seen the | |
5722 | TCP ACK packet for the second TCP FIN packet. | |
5723 | </column> | |
5724 | ||
5725 | <column name="timeouts" key="tcp_close"> | |
5726 | The timeout of the connection after the first TCP RST packet | |
5727 | has been seen by conntrack. | |
5728 | </column> | |
5729 | ||
5730 | <column name="timeouts" key="tcp_syn_sent2"> | |
5731 | The timeout of the connection when only a TCP SYN packet has been | |
5732 | seen by conntrack from both directions (simultaneous open). | |
5733 | This timeout is only supported by the Linux kernel datapath. | |
5734 | </column> | |
5735 | ||
5736 | <column name="timeouts" key="tcp_retransmit"> | |
5737 | The timeout of the connection when it exceeds the maximum | |
5738 | number of retransmissions. This timeout is only supported by | |
5739 | the Linux kernel datapath. | |
5740 | </column> | |
5741 | ||
5742 | <column name="timeouts" key="tcp_unack"> | |
5743 | The timeout of the connection when non-SYN packets create an | |
5744 | established connection in TCP loose tracking mode. This timeout | |
5745 | is only supported by the Linux kernel datapath. | |
5746 | </column> | |
5747 | </group> | |
5748 | ||
5749 | <group title="UDP Timeouts"> | |
5750 | <column name="timeouts" key="udp_first"> | |
5751 | The timeout of the connection after the first UDP packet has | |
5752 | been seen by conntrack. This timeout is only supported by the | |
5753 | userspace datapath. | |
5754 | </column> | |
5755 | ||
5756 | <column name="timeouts" key="udp_single"> | |
5757 | The timeout of the connection when conntrack only seen UDP | |
5758 | packet from the source host, but the destination host has never | |
5759 | sent one back. | |
5760 | </column> | |
5761 | ||
5762 | <column name="timeouts" key="udp_multiple"> | |
5763 | The timeout of the connection when UDP packets have been seen in | |
5764 | both directions. | |
5765 | </column> | |
5766 | </group> | |
5767 | ||
5768 | <group title="ICMP Timeouts"> | |
5769 | <column name="timeouts" key="icmp_first"> | |
5770 | The timeout of the connection after the first ICMP packet has | |
5771 | been seen by conntrack. | |
5772 | </column> | |
5773 | ||
5774 | <column name="timeouts" key="icmp_reply"> | |
5775 | The timeout of the connection after an ICMP error is replied in | |
5776 | response to an ICMP packet. This timeout is only supported by | |
5777 | the userspace datapath. | |
5778 | </column> | |
5779 | </group> | |
5780 | </group> | |
5781 | ||
5782 | <group title="Common Columns"> | |
5783 | The overall purpose of these columns is described under <code>Common | |
5784 | Columns</code> at the beginning of this document. | |
5785 | ||
5786 | <column name="external_ids"/> | |
5787 | </group> | |
5788 | </table> | |
5789 | ||
89365653 BP |
5790 | <table name="SSL"> |
5791 | SSL configuration for an Open_vSwitch. | |
5792 | ||
5793 | <column name="private_key"> | |
5794 | Name of a PEM file containing the private key used as the switch's | |
5795 | identity for SSL connections to the controller. | |
5796 | </column> | |
5797 | ||
5798 | <column name="certificate"> | |
5799 | Name of a PEM file containing a certificate, signed by the | |
5800 | certificate authority (CA) used by the controller and manager, | |
5801 | that certifies the switch's private key, identifying a trustworthy | |
5802 | switch. | |
5803 | </column> | |
5804 | ||
5805 | <column name="ca_cert"> | |
5806 | Name of a PEM file containing the CA certificate used to verify | |
5807 | that the switch is connected to a trustworthy controller. | |
5808 | </column> | |
5809 | ||
5810 | <column name="bootstrap_ca_cert"> | |
5811 | If set to <code>true</code>, then Open vSwitch will attempt to | |
5812 | obtain the CA certificate from the controller on its first SSL | |
5813 | connection and save it to the named PEM file. If it is successful, | |
5814 | it will immediately drop the connection and reconnect, and from then | |
5815 | on all SSL connections must be authenticated by a certificate signed | |
5816 | by the CA certificate thus obtained. <em>This option exposes the | |
3fd8d445 BP |
5817 | SSL connection to a man-in-the-middle attack obtaining the initial |
5818 | CA certificate.</em> It may still be useful for bootstrapping. | |
89365653 | 5819 | </column> |
13008eb3 | 5820 | |
3fd8d445 BP |
5821 | <group title="Common Columns"> |
5822 | The overall purpose of these columns is described under <code>Common | |
5823 | Columns</code> at the beginning of this document. | |
5824 | ||
5825 | <column name="external_ids"/> | |
5826 | </group> | |
89365653 BP |
5827 | </table> |
5828 | ||
5829 | <table name="sFlow"> | |
29089a54 RL |
5830 | <p>A set of sFlow(R) targets. sFlow is a protocol for remote |
5831 | monitoring of switches.</p> | |
89365653 BP |
5832 | |
5833 | <column name="agent"> | |
96657459 BP |
5834 | <p> |
5835 | Determines the agent address, that is, the IP address reported to | |
5836 | collectors as the source of the sFlow data. It may be an IP address or | |
5837 | the name of a network device. In the latter case, the network device's | |
5838 | IP address is used, | |
5839 | </p> | |
5840 | ||
5841 | <p> | |
5842 | If not specified, the agent device is figured from the first target | |
5843 | address and the routing table. If the routing table does not contain a | |
5844 | route to the target, the IP address defaults to the <ref | |
5845 | table="Controller" column="local_ip"/> in the collector's <ref | |
5846 | table="Controller"/>. | |
5847 | </p> | |
5848 | ||
5849 | <p> | |
5850 | If an agent IP address cannot be determined, sFlow is disabled. | |
5851 | </p> | |
89365653 BP |
5852 | </column> |
5853 | ||
5854 | <column name="header"> | |
5855 | Number of bytes of a sampled packet to send to the collector. | |
5856 | If not specified, the default is 128 bytes. | |
5857 | </column> | |
5858 | ||
5859 | <column name="polling"> | |
5860 | Polling rate in seconds to send port statistics to the collector. | |
5861 | If not specified, defaults to 30 seconds. | |
5862 | </column> | |
5863 | ||
5864 | <column name="sampling"> | |
5865 | Rate at which packets should be sampled and sent to the collector. | |
5866 | If not specified, defaults to 400, which means one out of 400 | |
5867 | packets, on average, will be sent to the collector. | |
5868 | </column> | |
5869 | ||
5870 | <column name="targets"> | |
5871 | sFlow targets in the form | |
5872 | <code><var>ip</var>:<var>port</var></code>. | |
5873 | </column> | |
13008eb3 | 5874 | |
3fd8d445 BP |
5875 | <group title="Common Columns"> |
5876 | The overall purpose of these columns is described under <code>Common | |
5877 | Columns</code> at the beginning of this document. | |
5878 | ||
5879 | <column name="external_ids"/> | |
5880 | </group> | |
89365653 | 5881 | </table> |
c1c9c9c4 | 5882 | |
29089a54 | 5883 | <table name="IPFIX"> |
99ec8f05 | 5884 | <p>Configuration for sending packets to IPFIX collectors.</p> |
29089a54 | 5885 | |
99ec8f05 BP |
5886 | <p> |
5887 | IPFIX is a protocol that exports a number of details about flows. The | |
5888 | IPFIX implementation in Open vSwitch samples packets at a configurable | |
5889 | rate, extracts flow information from those packets, optionally caches and | |
5890 | aggregates the flow information, and sends the result to one or more | |
5891 | collectors. | |
5892 | </p> | |
29089a54 | 5893 | |
99ec8f05 BP |
5894 | <p> |
5895 | IPFIX in Open vSwitch can be configured two different ways: | |
5896 | </p> | |
29089a54 | 5897 | |
99ec8f05 BP |
5898 | <ul> |
5899 | <li> | |
5900 | With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling | |
5901 | automatically on all packets that pass through a bridge. To configure | |
5902 | per-bridge sampling, create an <ref table="IPFIX"/> record and point a | |
5903 | <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/> | |
5904 | column to it. The <ref table="Flow_Sample_Collector_Set"/> table is | |
5905 | not used for per-bridge sampling. | |
5906 | </li> | |
5907 | ||
5908 | <li> | |
5909 | <p> | |
5910 | With <em>flow-based sampling</em>, <code>sample</code> actions in the | |
5911 | OpenFlow flow table drive IPFIX sampling. See | |
be51cd41 | 5912 | <code>ovs-actions</code>(7) for a description of the |
99ec8f05 BP |
5913 | <code>sample</code> action. |
5914 | </p> | |
5915 | ||
5916 | <p> | |
5917 | Flow-based sampling also requires database configuration: create a | |
5918 | <ref table="IPFIX"/> record that describes the IPFIX configuration | |
5919 | and a <ref table="Flow_Sample_Collector_Set"/> record that points to | |
5920 | the <ref table="Bridge"/> whose flow table holds the | |
5921 | <code>sample</code> actions and to <ref table="IPFIX"/> record. The | |
5922 | <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/> | |
5923 | table is not used for flow-based sampling. | |
5924 | </p> | |
5925 | </li> | |
5926 | </ul> | |
29089a54 | 5927 | |
99ec8f05 BP |
5928 | <column name="targets"> |
5929 | IPFIX target collectors in the form | |
5930 | <code><var>ip</var>:<var>port</var></code>. | |
29089a54 RL |
5931 | </column> |
5932 | ||
978427a5 RL |
5933 | <column name="cache_active_timeout"> |
5934 | The maximum period in seconds for which an IPFIX flow record is | |
5935 | cached and aggregated before being sent. If not specified, | |
5936 | defaults to 0. If 0, caching is disabled. | |
5937 | </column> | |
5938 | ||
5939 | <column name="cache_max_flows"> | |
5940 | The maximum number of IPFIX flow records that can be cached at a | |
5941 | time. If not specified, defaults to 0. If 0, caching is | |
5942 | disabled. | |
5943 | </column> | |
5944 | ||
f69f713b BY |
5945 | <column name="other_config" key="enable-tunnel-sampling" |
5946 | type='{"type": "boolean"}'> | |
5947 | <p> | |
5948 | Set to <code>true</code> to enable sampling and reporting tunnel | |
5949 | header 7-tuples in IPFIX flow records. Tunnel sampling is enabled | |
5950 | by default. | |
5951 | </p> | |
5952 | ||
5953 | <p> | |
5954 | The following enterprise entities report the sampled tunnel info: | |
5955 | </p> | |
5956 | ||
5957 | <dl> | |
5958 | <dt>tunnelType:</dt> | |
5959 | <dd> | |
5960 | <p>ID: 891, and enterprise ID 6876 (VMware).</p> | |
5961 | <p>type: unsigned 8-bit integer.</p> | |
5962 | <p>data type semantics: identifier.</p> | |
5963 | <p>description: Identifier of the layer 2 network overlay network | |
2b02d770 | 5964 | encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x07 GENEVE.</p> |
f69f713b BY |
5965 | </dd> |
5966 | <dt>tunnelKey:</dt> | |
5967 | <dd> | |
5968 | <p>ID: 892, and enterprise ID 6876 (VMware).</p> | |
5969 | <p>type: variable-length octetarray.</p> | |
5970 | <p>data type semantics: identifier.</p> | |
5971 | <p>description: Key which is used for identifying an individual | |
5972 | traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI), | |
5973 | GRE (32-bit key), or LISP (24-bit instance ID) tunnel. The | |
5974 | key is encoded in this octetarray as a 3-, 4-, or 8-byte integer | |
5975 | ID in network byte order.</p> | |
5976 | </dd> | |
5977 | <dt>tunnelSourceIPv4Address:</dt> | |
5978 | <dd> | |
5979 | <p>ID: 893, and enterprise ID 6876 (VMware).</p> | |
5980 | <p>type: unsigned 32-bit integer.</p> | |
5981 | <p>data type semantics: identifier.</p> | |
5982 | <p>description: The IPv4 source address in the tunnel IP packet | |
5983 | header.</p> | |
5984 | </dd> | |
5985 | <dt>tunnelDestinationIPv4Address:</dt> | |
5986 | <dd> | |
5987 | <p>ID: 894, and enterprise ID 6876 (VMware).</p> | |
5988 | <p>type: unsigned 32-bit integer.</p> | |
5989 | <p>data type semantics: identifier.</p> | |
5990 | <p>description: The IPv4 destination address in the tunnel IP | |
5991 | packet header.</p> | |
5992 | </dd> | |
5993 | <dt>tunnelProtocolIdentifier:</dt> | |
5994 | <dd> | |
5995 | <p>ID: 895, and enterprise ID 6876 (VMware).</p> | |
5996 | <p>type: unsigned 8-bit integer.</p> | |
5997 | <p>data type semantics: identifier.</p> | |
5998 | <p>description: The value of the protocol number in the tunnel | |
5999 | IP packet header. The protocol number identifies the tunnel IP | |
6000 | packet payload type.</p> | |
6001 | </dd> | |
6002 | <dt>tunnelSourceTransportPort:</dt> | |
6003 | <dd> | |
6004 | <p>ID: 896, and enterprise ID 6876 (VMware).</p> | |
6005 | <p>type: unsigned 16-bit integer.</p> | |
6006 | <p>data type semantics: identifier.</p> | |
6007 | <p>description: The source port identifier in the tunnel transport | |
6008 | header. For the transport protocols UDP, TCP, and SCTP, this is | |
6009 | the source port number given in the respective header.</p> | |
6010 | </dd> | |
6011 | <dt>tunnelDestinationTransportPort:</dt> | |
6012 | <dd> | |
6013 | <p>ID: 897, and enterprise ID 6876 (VMware).</p> | |
6014 | <p>type: unsigned 16-bit integer.</p> | |
6015 | <p>data type semantics: identifier.</p> | |
6016 | <p>description: The destination port identifier in the tunnel | |
6017 | transport header. For the transport protocols UDP, TCP, and SCTP, | |
6018 | this is the destination port number given in the respective header. | |
6019 | </p> | |
6020 | </dd> | |
6021 | </dl> | |
6022 | ||
6023 | <p> | |
6024 | Before Open vSwitch 2.5.90, <ref column="other_config" | |
6025 | key="enable-tunnel-sampling"/> was only supported with per-bridge | |
6026 | sampling, and ignored otherwise. Open vSwitch 2.5.90 and later support | |
6027 | <ref column="other_config" key="enable-tunnel-sampling"/> for | |
6028 | per-bridge and per-flow sampling. | |
6029 | </p> | |
6030 | </column> | |
6031 | ||
c97320eb WZ |
6032 | <column name="other_config" key="virtual_obs_id" |
6033 | type='{"type": "string"}'> | |
6034 | <p> | |
6035 | A string that accompanies each IPFIX flow record. Its intended use is | |
6036 | for the ``virtual observation ID,'' an identifier of a virtual | |
6037 | observation point that is locally unique in a virtual network. It | |
6038 | describes a location in the virtual network where IP packets can be | |
6039 | observed. The maximum length is 254 bytes. If not specified, the | |
6040 | field is omitted from the IPFIX flow record. | |
6041 | </p> | |
6042 | ||
6043 | <p> | |
6044 | The following enterprise entity reports the specified virtual | |
6045 | observation ID: | |
6046 | </p> | |
6047 | ||
6048 | <dl> | |
6049 | <dt>virtualObsID:</dt> | |
6050 | <dd> | |
6051 | <p>ID: 898, and enterprise ID 6876 (VMware).</p> | |
6052 | <p>type: variable-length string.</p> | |
6053 | <p>data type semantics: identifier.</p> | |
6054 | <p>description: A virtual observation domain ID that is locally | |
6055 | unique in a virtual network. | |
6056 | </p> | |
6057 | </dd> | |
6058 | </dl> | |
6059 | ||
6060 | <p> | |
6061 | This feature was introduced in Open vSwitch 2.5.90. | |
6062 | </p> | |
6063 | </column> | |
6064 | ||
99ec8f05 BP |
6065 | <group title="Per-Bridge Sampling"> |
6066 | <p> | |
6067 | These values affect only per-bridge sampling. See above for a | |
6068 | description of the differences between per-bridge and flow-based | |
6069 | sampling. | |
6070 | </p> | |
8b7ea2d4 | 6071 | |
99ec8f05 BP |
6072 | <column name="sampling"> |
6073 | The rate at which packets should be sampled and sent to each target | |
6074 | collector. If not specified, defaults to 400, which means one out of | |
6075 | 400 packets, on average, will be sent to each target collector. | |
6076 | </column> | |
8b7ea2d4 | 6077 | |
99ec8f05 BP |
6078 | <column name="obs_domain_id"> |
6079 | The IPFIX Observation Domain ID sent in each IPFIX packet. If not | |
6080 | specified, defaults to 0. | |
6081 | </column> | |
6082 | ||
6083 | <column name="obs_point_id"> | |
6084 | The IPFIX Observation Point ID sent in each IPFIX flow record. If not | |
6085 | specified, defaults to 0. | |
6086 | </column> | |
6087 | ||
99ec8f05 BP |
6088 | <column name="other_config" key="enable-input-sampling" |
6089 | type='{"type": "boolean"}'> | |
6090 | By default, Open vSwitch samples and reports flows at bridge port input | |
6091 | in IPFIX flow records. Set this column to <code>false</code> to | |
6092 | disable input sampling. | |
6093 | </column> | |
6094 | ||
6095 | <column name="other_config" key="enable-output-sampling" | |
6096 | type='{"type": "boolean"}'> | |
6097 | By default, Open vSwitch samples and reports flows at bridge port | |
6098 | output in IPFIX flow records. Set this column to <code>false</code> to | |
6099 | disable output sampling. | |
6100 | </column> | |
6101 | </group> | |
8b7ea2d4 | 6102 | |
29089a54 RL |
6103 | <group title="Common Columns"> |
6104 | The overall purpose of these columns is described under <code>Common | |
6105 | Columns</code> at the beginning of this document. | |
6106 | ||
6107 | <column name="external_ids"/> | |
6108 | </group> | |
6109 | </table> | |
6110 | ||
6111 | <table name="Flow_Sample_Collector_Set"> | |
99ec8f05 BP |
6112 | <p> |
6113 | A set of IPFIX collectors of packet samples generated by OpenFlow | |
6114 | <code>sample</code> actions. This table is used only for IPFIX | |
6115 | flow-based sampling, not for per-bridge sampling (see the <ref | |
6116 | table="IPFIX"/> table for a description of the two forms). | |
6117 | </p> | |
29089a54 RL |
6118 | |
6119 | <column name="id"> | |
6120 | The ID of this collector set, unique among the bridge's | |
6121 | collector sets, to be used as the <code>collector_set_id</code> | |
6122 | in OpenFlow <code>sample</code> actions. | |
6123 | </column> | |
6124 | ||
6125 | <column name="bridge"> | |
6126 | The bridge into which OpenFlow <code>sample</code> actions can | |
6127 | be added to send packet samples to this set of IPFIX collectors. | |
6128 | </column> | |
6129 | ||
6130 | <column name="ipfix"> | |
6131 | Configuration of the set of IPFIX collectors to send one flow | |
6132 | record per sampled packet to. | |
6133 | </column> | |
6134 | ||
6135 | <group title="Common Columns"> | |
6136 | The overall purpose of these columns is described under <code>Common | |
6137 | Columns</code> at the beginning of this document. | |
6138 | ||
6139 | <column name="external_ids"/> | |
6140 | </group> | |
6141 | </table> | |
6142 | ||
99eef98b | 6143 | <table name="AutoAttach"> |
039a8ccd BP |
6144 | <p> |
6145 | Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM | |
6146 | draft standard describes a compact method of using IEEE 802.1AB Link | |
6147 | Layer Discovery Protocol (LLDP) together with a IEEE 802.1aq Shortest | |
6148 | Path Bridging (SPB) network to automatically attach network devices | |
6149 | to individual services in a SPB network. The intent here is to allow | |
6150 | network applications and devices using OVS to be able to easily take | |
6151 | advantage of features offered by industry standard SPB networks. | |
6152 | </p> | |
6153 | ||
6154 | <p> | |
6155 | Auto Attach (AA) uses LLDP to communicate between a directly connected | |
6156 | Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol | |
6157 | is extended to add two new Type-Length-Value tuples (TLVs). The first | |
6158 | new TLV supports the ongoing discovery of directly connected AA | |
6159 | correspondents. Auto Attach operates by regularly transmitting AA | |
6160 | discovery TLVs between the AA client and AA server. By exchanging these | |
6161 | discovery messages, both the AAC and AAS learn the system name and | |
6162 | system description of their peer. In the OVS context, OVS operates as | |
6163 | the AA client and the AA server resides on a switch at the edge of the | |
6164 | SPB network. | |
6165 | </p> | |
6166 | ||
6167 | <p> | |
6168 | Once AA discovery has been completed the AAC then uses the second new TLV | |
6169 | to deliver identifier mappings from the AAC to the AAS. A primary feature | |
6170 | of Auto Attach is to facilitate the mapping of VLANs defined outside the | |
6171 | SPB network onto service ids (ISIDs) defined within the SPM network. By | |
6172 | doing so individual external VLANs can be mapped onto specific SPB | |
6173 | network services. These VLAN id to ISID mappings can be configured and | |
6174 | managed locally using new options added to the ovs-vsctl command. | |
6175 | </p> | |
6176 | ||
6177 | <p> | |
6178 | The Auto Attach OVS feature does not provide a full implementation of | |
6179 | the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP | |
6180 | standard and support for the AA TLV extensions is provided. LLDP | |
6181 | protocol support in OVS can be enabled or disabled on a port by port | |
6182 | basis. LLDP support is disabled by default. | |
6183 | </p> | |
99eef98b DF |
6184 | |
6185 | <column name="system_name"> | |
6186 | The system_name string is exported in LLDP messages. It should uniquely | |
6187 | identify the bridge in the network. | |
6188 | </column> | |
6189 | ||
6190 | <column name="system_description"> | |
6191 | The system_description string is exported in LLDP messages. It should | |
6192 | describe the type of software and hardware. | |
6193 | </column> | |
6194 | ||
6195 | <column name="mappings"> | |
039a8ccd BP |
6196 | A mapping from SPB network Individual Service Identifier (ISID) to VLAN |
6197 | id. | |
99eef98b DF |
6198 | </column> |
6199 | </table> | |
89365653 | 6200 | </database> |