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