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