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