]>
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 | |
12 | ``root set'' tables noted below. | |
13 | </p> | |
89365653 BP |
14 | |
15 | <table name="Open_vSwitch" title="Open vSwitch configuration."> | |
c5f341ab BP |
16 | Configuration for an Open vSwitch daemon. There must be exactly |
17 | one record in the <ref table="Open_vSwitch"/> table. | |
89365653 BP |
18 | |
19 | <group title="Configuration"> | |
20 | <column name="bridges"> | |
21 | Set of bridges managed by the daemon. | |
22 | </column> | |
23 | ||
89365653 BP |
24 | <column name="ssl"> |
25 | SSL used globally by the daemon. | |
26 | </column> | |
f5e7ed5d JP |
27 | |
28 | <column name="external_ids"> | |
0e869da1 BP |
29 | Key-value pairs for use by external frameworks that integrate |
30 | with Open vSwitch, rather than by Open vSwitch itself. System | |
31 | integrators should either use the Open vSwitch development | |
32 | mailing list to coordinate on common key-value definitions, or | |
33 | choose key names that are likely to be unique. The currently | |
34 | defined common key-value pairs are: | |
f5e7ed5d | 35 | <dl> |
d9af660c JP |
36 | <dt><code>system-id</code></dt> |
37 | <dd>A unique identifier for the Open vSwitch's physical host. | |
38 | The form of the identifier depends on the type of the host. | |
39 | On a Citrix XenServer, this will likely be the same as | |
40 | <code>xs-system-uuid</code>.</dd> | |
41 | <dt><code>xs-system-uuid</code></dt> | |
42 | <dd>The Citrix XenServer universally unique identifier for the | |
43 | physical host as displayed by <code>xe host-list</code>.</dd> | |
f5e7ed5d JP |
44 | </dl> |
45 | </column> | |
89365653 BP |
46 | </group> |
47 | ||
48 | <group title="Status"> | |
49 | <column name="next_cfg"> | |
50 | Sequence number for client to increment. When a client modifies | |
51 | any part of the database configuration and wishes to wait for | |
52 | Open vSwitch to finish applying the changes, it may increment | |
53 | this sequence number. | |
54 | </column> | |
55 | ||
56 | <column name="cur_cfg"> | |
57 | Sequence number that Open vSwitch sets to the current value of | |
2e57b537 | 58 | <ref column="next_cfg"/> after it finishes applying a set of |
89365653 BP |
59 | configuration changes. |
60 | </column> | |
c1c9c9c4 BP |
61 | |
62 | <column name="capabilities"> | |
63 | Describes functionality supported by the hardware and software platform | |
64 | on which this Open vSwitch is based. Clients should not modify this | |
65 | column. See the <ref table="Capability"/> description for defined | |
66 | capability categories and the meaning of associated | |
67 | <ref table="Capability"/> records. | |
68 | </column> | |
018f1525 BP |
69 | |
70 | <column name="statistics"> | |
71 | <p> | |
ce887677 BP |
72 | Key-value pairs that report statistics about a system running an Open |
73 | vSwitch. These are updated periodically (currently, every 5 | |
74 | seconds). Key-value pairs that cannot be determined or that do not | |
75 | apply to a platform are omitted. | |
76 | </p> | |
77 | ||
018f1525 | 78 | <dl> |
ce887677 BP |
79 | <dt><code>cpu</code></dt> |
80 | <dd> | |
81 | <p> | |
82 | Number of CPU processors, threads, or cores currently online and | |
83 | available to the operating system on which Open vSwitch is | |
84 | running, as an integer. This may be less than the number | |
85 | installed, if some are not online or if they are not available to | |
86 | the operating system. | |
87 | </p> | |
88 | <p> | |
89 | Open vSwitch userspace processes are not multithreaded, but the | |
90 | Linux kernel-based datapath is. | |
91 | </p> | |
92 | </dd> | |
93 | ||
94 | <dt><code>load_average</code></dt> | |
95 | <dd> | |
96 | <p> | |
97 | A comma-separated list of three floating-point numbers, | |
98 | representing the system load average over the last 1, 5, and 15 | |
99 | minutes, respectively. | |
100 | </p> | |
101 | </dd> | |
102 | ||
103 | <dt><code>memory</code></dt> | |
104 | <dd> | |
105 | <p> | |
106 | A comma-separated list of integers, each of which represents a | |
107 | quantity of memory in kilobytes that describes the operating | |
108 | system on which Open vSwitch is running. In respective order, | |
109 | these values are: | |
110 | </p> | |
111 | ||
112 | <ol> | |
113 | <li>Total amount of RAM allocated to the OS.</li> | |
114 | <li>RAM allocated to the OS that is in use.</li> | |
115 | <li>RAM that can be flushed out to disk or otherwise discarded | |
116 | if that space is needed for another purpose. This number is | |
117 | necessarily less than or equal to the previous value.</li> | |
118 | <li>Total disk space allocated for swap.</li> | |
119 | <li>Swap space currently in use.</li> | |
120 | </ol> | |
121 | ||
122 | <p> | |
123 | On Linux, all five values can be determined and are included. On | |
124 | other operating systems, only the first two values can be | |
125 | determined, so the list will only have two values. | |
126 | </p> | |
127 | </dd> | |
128 | ||
129 | <dt><code>process_</code><var>name</var></dt> | |
018f1525 | 130 | <dd> |
ce887677 BP |
131 | <p> |
132 | One such key-value pair will exist for each running Open vSwitch | |
133 | daemon process, with <var>name</var> replaced by the daemon's | |
134 | name (e.g. <code>process_ovs-vswitchd</code>). The value is a | |
135 | comma-separated list of integers. The integers represent the | |
136 | following, with memory measured in kilobytes and durations in | |
137 | milliseconds: | |
138 | </p> | |
139 | ||
140 | <ol> | |
141 | <li>The process's virtual memory size.</li> | |
142 | <li>The process's resident set size.</li> | |
143 | <li>The amount of user and system CPU time consumed by the | |
144 | process.</li> | |
145 | <li>The number of times that the process has crashed and been | |
146 | automatically restarted by the monitor.</li> | |
147 | <li>The duration since the process was started.</li> | |
148 | <li>The duration for which the process has been running.</li> | |
149 | </ol> | |
150 | ||
151 | <p> | |
152 | The interpretation of some of these values depends on whether the | |
153 | process was started with the <option>--monitor</option>. If it | |
154 | was not, then the crash count will always be 0 and the two | |
155 | durations will always be the same. If <option>--monitor</option> | |
156 | was given, then the crash count may be positive; if it is, the | |
157 | latter duration is the amount of time since the most recent crash | |
158 | and restart. | |
159 | </p> | |
160 | ||
161 | <p> | |
162 | There will be one key-value pair for each file in Open vSwitch's | |
163 | ``run directory'' (usually <code>/var/run/openvswitch</code>) | |
164 | whose name ends in <code>.pid</code>, whose contents are a | |
165 | process ID, and which is locked by a running process. The | |
166 | <var>name</var> is taken from the pidfile's name. | |
167 | </p> | |
168 | ||
169 | <p> | |
170 | Currently Open vSwitch is only able to obtain all of the above | |
171 | detail on Linux systems. On other systems, the same key-value | |
172 | pairs will be present but the values will always be the empty | |
173 | string. | |
174 | </p> | |
175 | </dd> | |
176 | ||
177 | <dt><code>file_systems</code></dt> | |
178 | <dd> | |
179 | <p> | |
180 | A space-separated list of information on local, writable file | |
181 | systems. Each item in the list describes one file system and | |
182 | consists in turn of a comma-separated list of the following: | |
183 | </p> | |
184 | ||
185 | <ol> | |
186 | <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>. | |
187 | Any spaces or commas in the mount point are replaced by | |
188 | underscores.</li> | |
189 | <li>Total size, in kilobytes, as an integer.</li> | |
190 | <li>Amount of storage in use, in kilobytes, as an integer.</li> | |
191 | </ol> | |
192 | ||
193 | <p> | |
194 | This key-value pair is omitted if there are no local, writable | |
195 | file systems or if Open vSwitch cannot obtain the needed | |
196 | information. | |
197 | </p> | |
198 | </dd> | |
018f1525 BP |
199 | </dl> |
200 | </column> | |
89365653 | 201 | </group> |
94db5407 | 202 | |
538c6dfa BP |
203 | <group title="Version Reporting"> |
204 | <p> | |
6b4186af EJ |
205 | These columns report the types and versions of the hardware and |
206 | software running Open vSwitch. We recommend in general that software | |
207 | should test whether specific features are supported instead of relying | |
208 | on version number checks. These values are primarily intended for | |
209 | reporting to human administrators. | |
538c6dfa BP |
210 | </p> |
211 | ||
212 | <column name="ovs_version"> | |
d4da3acc | 213 | The Open vSwitch version number, e.g. <code>1.1.0</code>. |
6b4186af | 214 | If Open vSwitch was configured with a build number, then it is |
d4da3acc | 215 | also included, e.g. <code>1.1.0+build6579</code>. |
538c6dfa BP |
216 | </column> |
217 | ||
8159b984 | 218 | <column name="db_version"> |
6b4186af | 219 | <p> |
8159b984 BP |
220 | The database schema version number in the form |
221 | <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>, | |
222 | e.g. <code>1.2.3</code>. Whenever the database schema is changed in | |
223 | a non-backward compatible way (e.g. deleting a column or a table), | |
224 | <var>major</var> is incremented. When the database schema is changed | |
225 | in a backward compatible way (e.g. adding a new column), | |
226 | <var>minor</var> is incremented. When the database schema is changed | |
227 | cosmetically (e.g. reindenting its syntax), <var>tweak</var> is | |
228 | incremented. | |
229 | </p> | |
230 | ||
231 | <p> | |
232 | The schema version is part of the database schema, so it can also be | |
233 | retrieved by fetching the schema using the Open vSwitch database | |
234 | protocol. | |
235 | </p> | |
236 | </column> | |
237 | ||
538c6dfa BP |
238 | <column name="system_type"> |
239 | <p> | |
6b4186af EJ |
240 | An identifier for the type of system on top of which Open vSwitch |
241 | runs, e.g. <code>XenServer</code> or <code>KVM</code>. | |
242 | </p> | |
243 | <p> | |
244 | System integrators are responsible for choosing and setting an | |
245 | appropriate value for this column. | |
246 | </p> | |
538c6dfa BP |
247 | </column> |
248 | ||
249 | <column name="system_version"> | |
250 | <p> | |
6b4186af | 251 | The version of the system identified by <ref column="system_type"/>, |
404c1692 | 252 | e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265. |
6b4186af EJ |
253 | </p> |
254 | <p> | |
255 | System integrators are responsible for choosing and setting an | |
256 | appropriate value for this column. | |
257 | </p> | |
538c6dfa | 258 | </column> |
6b4186af | 259 | |
538c6dfa BP |
260 | </group> |
261 | ||
94db5407 BP |
262 | <group title="Database Configuration"> |
263 | <p> | |
264 | These columns primarily configure the Open vSwitch database | |
265 | (<code>ovsdb-server</code>), not the Open vSwitch switch | |
266 | (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref | |
267 | column="ssl"/> settings. | |
268 | </p> | |
269 | ||
270 | <p> | |
271 | The Open vSwitch switch does read the database configuration to | |
272 | determine remote IP addresses to which in-band control should apply. | |
273 | </p> | |
274 | ||
275 | <column name="manager_options"> | |
276 | Database clients to which the Open vSwitch database server should | |
277 | connect or to which it should listen, along with options for how these | |
278 | connection should be configured. See the <ref table="Manager"/> table | |
279 | for more information. | |
280 | </column> | |
94db5407 | 281 | </group> |
89365653 BP |
282 | </table> |
283 | ||
284 | <table name="Bridge"> | |
285 | <p> | |
286 | Configuration for a bridge within an | |
287 | <ref table="Open_vSwitch"/>. | |
288 | </p> | |
289 | <p> | |
290 | A <ref table="Bridge"/> record represents an Ethernet switch with one or | |
291 | more ``ports,'' which are the <ref table="Port"/> records pointed to by | |
292 | the <ref table="Bridge"/>'s <ref column="ports"/> column. | |
293 | </p> | |
294 | ||
295 | <group title="Core Features"> | |
296 | <column name="name"> | |
297 | Bridge identifier. Should be alphanumeric and no more than about 8 | |
298 | bytes long. Must be unique among the names of ports, interfaces, and | |
299 | bridges on a host. | |
300 | </column> | |
301 | ||
302 | <column name="ports"> | |
303 | Ports included in the bridge. | |
304 | </column> | |
305 | ||
306 | <column name="mirrors"> | |
307 | Port mirroring configuration. | |
308 | </column> | |
309 | ||
310 | <column name="netflow"> | |
311 | NetFlow configuration. | |
312 | </column> | |
313 | ||
314 | <column name="sflow"> | |
315 | sFlow configuration. | |
316 | </column> | |
317 | ||
318 | <column name="flood_vlans"> | |
319 | VLAN IDs of VLANs on which MAC address learning should be disabled, so | |
320 | that packets are flooded instead of being sent to specific ports that | |
321 | are believed to contain packets' destination MACs. This should | |
322 | ordinarily be used to disable MAC learning on VLANs used for mirroring | |
323 | (RSPAN VLANs). It may also be useful for debugging. | |
324 | </column> | |
325 | </group> | |
326 | ||
327 | <group title="OpenFlow Configuration"> | |
328 | <column name="controller"> | |
1a048029 JP |
329 | OpenFlow controller set. If unset, then no OpenFlow controllers |
330 | will be used. | |
89365653 BP |
331 | </column> |
332 | ||
31681a5d JP |
333 | <column name="fail_mode"> |
334 | <p>When a controller is configured, it is, ordinarily, responsible | |
335 | for setting up all flows on the switch. Thus, if the connection to | |
336 | the controller fails, no new network connections can be set up. | |
337 | If the connection to the controller stays down long enough, | |
338 | no packets can pass through the switch at all. This setting | |
339 | determines the switch's response to such a situation. It may be set | |
340 | to one of the following: | |
341 | <dl> | |
342 | <dt><code>standalone</code></dt> | |
343 | <dd>If no message is received from the controller for three | |
344 | times the inactivity probe interval | |
345 | (see <ref column="inactivity_probe"/>), then Open vSwitch | |
346 | will take over responsibility for setting up flows. In | |
347 | this mode, Open vSwitch causes the bridge to act like an | |
348 | ordinary MAC-learning switch. Open vSwitch will continue | |
349 | to retry connecting to the controller in the background | |
350 | and, when the connection succeeds, it will discontinue its | |
351 | standalone behavior.</dd> | |
352 | <dt><code>secure</code></dt> | |
353 | <dd>Open vSwitch will not set up flows on its own when the | |
abdfe474 JP |
354 | controller connection fails or when no controllers are |
355 | defined. The bridge will continue to retry connecting to | |
356 | any defined controllers forever.</dd> | |
31681a5d JP |
357 | </dl> |
358 | </p> | |
359 | <p>If this value is unset, the default is implementation-specific.</p> | |
299a244b | 360 | <p>When more than one controller is configured, |
31681a5d JP |
361 | <ref column="fail_mode"/> is considered only when none of the |
362 | configured controllers can be contacted.</p> | |
363 | </column> | |
364 | ||
89365653 | 365 | <column name="datapath_id"> |
78c54bde BP |
366 | Reports the OpenFlow datapath ID in use. Exactly 16 hex |
367 | digits. (Setting this column will have no useful effect. Set | |
368 | <ref column="other_config"/>:<code>other-config</code> | |
369 | instead.) | |
89365653 BP |
370 | </column> |
371 | </group> | |
372 | ||
373 | <group title="Other Features"> | |
374 | <column name="datapath_type"> | |
375 | Name of datapath provider. The kernel datapath has | |
376 | type <code>system</code>. The userspace datapath has | |
377 | type <code>netdev</code>. | |
378 | </column> | |
379 | ||
380 | <column name="external_ids"> | |
0e869da1 BP |
381 | Key-value pairs for use by external frameworks that integrate |
382 | with Open vSwitch, rather than by Open vSwitch itself. System | |
383 | integrators should either use the Open vSwitch development | |
384 | mailing list to coordinate on common key-value definitions, or | |
385 | choose key names that are likely to be unique. The currently | |
d9af660c | 386 | defined key-value pairs are: |
89365653 | 387 | <dl> |
d9af660c | 388 | <dt><code>bridge-id</code></dt> |
299a244b | 389 | <dd>A unique identifier of the bridge. On Citrix XenServer this |
d9af660c JP |
390 | will commonly be the same as <code>xs-network-uuids</code>.</dd> |
391 | <dt><code>xs-network-uuids</code></dt> | |
9b180fbb | 392 | <dd>Semicolon-delimited set of universally unique identifier(s) for |
d9af660c JP |
393 | the network with which this bridge is associated on a Citrix |
394 | XenServer host. The network identifiers are RFC 4122 UUIDs as | |
5c43922c | 395 | displayed by, e.g., <code>xe network-list</code>.</dd> |
89365653 BP |
396 | </dl> |
397 | </column> | |
398 | ||
399 | <column name="other_config"> | |
400 | Key-value pairs for configuring rarely used bridge | |
401 | features. The currently defined key-value pairs are: | |
402 | <dl> | |
403 | <dt><code>datapath-id</code></dt> | |
2e57b537 | 404 | <dd>Exactly 16 hex |
89365653 | 405 | digits to set the OpenFlow datapath ID to a specific |
093ca5b3 | 406 | value. May not be all-zero.</dd> |
8731b2b6 | 407 | <dt><code>disable-in-band</code></dt> |
299a244b | 408 | <dd>If set to <code>true</code>, disable in-band control on |
8731b2b6 | 409 | the bridge regardless of controller and manager settings.</dd> |
89365653 | 410 | <dt><code>hwaddr</code></dt> |
2e57b537 | 411 | <dd>An Ethernet address in the form |
89365653 BP |
412 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var> |
413 | to set the hardware address of the local port and influence the | |
414 | datapath ID.</dd> | |
b1da6250 BP |
415 | <dt><code>in-band-queue</code></dt> |
416 | <dd> | |
417 | A queue ID as a nonnegative integer. This sets the OpenFlow queue | |
418 | ID that will be used by flows set up by in-band control on this | |
419 | bridge. If unset, or if the port used by an in-band control flow | |
420 | does not have QoS configured, or if the port does not have a queue | |
421 | with the specified ID, the default queue is used instead. | |
422 | </dd> | |
89365653 BP |
423 | </dl> |
424 | </column> | |
425 | </group> | |
426 | </table> | |
427 | ||
428 | <table name="Port" table="Port or bond configuration."> | |
429 | <p>A port within a <ref table="Bridge"/>.</p> | |
430 | <p>Most commonly, a port has exactly one ``interface,'' pointed to by its | |
2e57b537 | 431 | <ref column="interfaces"/> column. Such a port logically |
89365653 BP |
432 | corresponds to a port on a physical Ethernet switch. A port |
433 | with more than one interface is a ``bonded port'' (see | |
434 | <ref group="Bonding Configuration"/>).</p> | |
435 | <p>Some properties that one might think as belonging to a port are actually | |
436 | part of the port's <ref table="Interface"/> members.</p> | |
437 | ||
438 | <column name="name"> | |
439 | Port name. Should be alphanumeric and no more than about 8 | |
440 | bytes long. May be the same as the interface name, for | |
441 | non-bonded ports. Must otherwise be unique among the names of | |
442 | ports, interfaces, and bridges on a host. | |
443 | </column> | |
444 | ||
445 | <column name="interfaces"> | |
446 | The port's interfaces. If there is more than one, this is a | |
447 | bonded Port. | |
448 | </column> | |
449 | ||
450 | <group title="VLAN Configuration"> | |
451 | <p>A bridge port must be configured for VLANs in one of two | |
452 | mutually exclusive ways: | |
453 | <ul> | |
7894d33b BP |
454 | <li>A ``trunk port'' has an empty value for <ref |
455 | column="tag"/>. Its <ref column="trunks"/> value may be | |
456 | empty or non-empty.</li> | |
89365653 | 457 | <li>An ``implicitly tagged VLAN port'' or ``access port'' |
7894d33b BP |
458 | has an nonempty value for <ref column="tag"/>. Its |
459 | <ref column="trunks"/> value must be empty.</li> | |
89365653 BP |
460 | </ul> |
461 | If <ref column="trunks"/> and <ref column="tag"/> are both | |
462 | nonempty, the configuration is ill-formed. | |
463 | </p> | |
464 | ||
465 | <column name="tag"> | |
7894d33b BP |
466 | <p> |
467 | If this is an access port (see above), the port's implicitly | |
468 | tagged VLAN. Must be empty if this is a trunk port. | |
469 | </p> | |
470 | <p> | |
471 | Frames arriving on trunk ports will be forwarded to this | |
472 | port only if they are tagged with the given VLAN (or, if | |
473 | <ref column="tag"/> is 0, then if they lack a VLAN header). | |
474 | Frames arriving on other access ports will be forwarded to | |
475 | this port only if they have the same <ref column="tag"/> | |
476 | value. Frames forwarded to this port will not have an | |
477 | 802.1Q header. | |
478 | </p> | |
479 | <p> | |
480 | When a frame with a 802.1Q header that indicates a nonzero | |
481 | VLAN is received on an access port, it is discarded. | |
482 | </p> | |
89365653 BP |
483 | </column> |
484 | ||
485 | <column name="trunks"> | |
7894d33b BP |
486 | <p> |
487 | If this is a trunk port (see above), the 802.1Q VLAN(s) that | |
488 | this port trunks; if it is empty, then the port trunks all | |
489 | VLANs. Must be empty if this is an access port. | |
490 | </p> | |
491 | <p> | |
492 | Frames arriving on trunk ports are dropped if they are not | |
493 | in one of the specified VLANs. For this purpose, packets | |
494 | that have no VLAN header are treated as part of VLAN 0. | |
495 | </p> | |
89365653 BP |
496 | </column> |
497 | </group> | |
498 | ||
499 | <group title="Bonding Configuration"> | |
be02e7c3 | 500 | <p>A port that has more than one interface is a ``bonded port.'' Bonding |
9f5073d8 EJ |
501 | allows for load balancing and fail-over. Some kinds of bonding will |
502 | work with any kind of upstream switch:</p> | |
503 | ||
504 | <dl> | |
505 | <dt><code>balance-slb</code></dt> | |
506 | <dd> | |
507 | Balances flows among slaves based on source MAC address and output | |
508 | VLAN, with periodic rebalancing as traffic patterns change. | |
509 | </dd> | |
510 | ||
511 | <dt><code>active-backup</code></dt> | |
512 | <dd> | |
513 | Assigns all flows to one slave, failing over to a backup slave when | |
514 | the active slave is disabled. | |
515 | </dd> | |
516 | </dl> | |
517 | ||
518 | <p> | |
fb0b29a3 | 519 | The following modes require the upstream switch to support 802.3ad with |
9f5073d8 | 520 | successful LACP negotiation. If LACP negotiation fails then |
fb0b29a3 | 521 | <code>balance-slb</code> style flow hashing is used as a fallback: |
9f5073d8 EJ |
522 | </p> |
523 | ||
524 | <dl> | |
525 | <dt><code>balance-tcp</code></dt> | |
526 | <dd> | |
527 | Balances flows among slaves based on L2, L3, and L4 protocol | |
528 | information such as destination MAC address, IP address, and TCP | |
529 | port. | |
530 | </dd> | |
531 | </dl> | |
89365653 | 532 | |
fb0b29a3 EJ |
533 | <dl> |
534 | <dt><code>stable</code></dt> | |
535 | <dd> | |
536 | <p>Attempts to always assign a given flow to the same slave | |
537 | consistently. In an effort to maintain stability, no load | |
538 | balancing is done. Uses a similar hashing strategy to | |
539 | <code>balance-tcp</code>, falling back to <code>balance-slb</code> | |
540 | style hashing when LACP negotiations are unsuccessful.</p> | |
541 | <p>Slave selection decisions are made based on LACP port ID when LACP | |
542 | negotiations are successful, falling back to openflow port number | |
543 | when unsuccessful. Thus, decisions are consistent across all | |
544 | ovs-vswitchd instances with equivalent port IDs.</p> | |
545 | </dd> | |
546 | </dl> | |
547 | ||
89365653 BP |
548 | <p>These columns apply only to bonded ports. Their values are |
549 | otherwise ignored.</p> | |
550 | ||
27dcaa1a | 551 | <column name="bond_mode"> |
9f5073d8 EJ |
552 | <p>The type of bonding used for a bonded port. Defaults to |
553 | <code>balance-slb</code> if unset. | |
554 | </p> | |
be02e7c3 EJ |
555 | </column> |
556 | ||
89365653 BP |
557 | <column name="bond_updelay"> |
558 | <p>For a bonded port, the number of milliseconds for which carrier must | |
559 | stay up on an interface before the interface is considered to be up. | |
560 | Specify <code>0</code> to enable the interface immediately.</p> | |
561 | <p>This setting is honored only when at least one bonded interface is | |
562 | already enabled. When no interfaces are enabled, then the first bond | |
563 | interface to come up is enabled immediately.</p> | |
564 | </column> | |
565 | ||
566 | <column name="bond_downdelay"> | |
567 | For a bonded port, the number of milliseconds for which carrier must | |
568 | stay down on an interface before the interface is considered to be | |
2e57b537 | 569 | down. Specify <code>0</code> to disable the interface immediately. |
89365653 BP |
570 | </column> |
571 | ||
572 | <column name="bond_fake_iface"> | |
2e57b537 BP |
573 | For a bonded port, whether to create a fake internal interface with the |
574 | name of the port. Use only for compatibility with legacy software that | |
89365653 BP |
575 | requires this. |
576 | </column> | |
c25c91fd EJ |
577 | |
578 | <column name="lacp"> | |
579 | <p>Configures LACP on this port. LACP allows directly connected | |
20601813 EJ |
580 | switchs to negotiate which links may be bonded. LACP may be enabled |
581 | on non-bonded ports for the benefit of any switchs they may be | |
c25c91fd EJ |
582 | connected to. <code>active</code> ports are allowed to initiate LACP |
583 | negotiations. <code>passive</code> ports are allowed to participate | |
584 | in LACP negotiations initiated by a remote switch, but not allowed to | |
585 | initiate such negotiations themselves. If unset Open vSwitch will | |
586 | choose a reasonable default. </p> | |
587 | </column> | |
588 | ||
89365653 BP |
589 | </group> |
590 | ||
591 | <group title="Other Features"> | |
c1c9c9c4 BP |
592 | <column name="qos"> |
593 | Quality of Service configuration for this port. | |
594 | </column> | |
299a244b | 595 | |
89365653 BP |
596 | <column name="mac"> |
597 | The MAC address to use for this port for the purpose of choosing the | |
598 | bridge's MAC address. This column does not necessarily reflect the | |
599 | port's actual MAC address, nor will setting it change the port's actual | |
600 | MAC address. | |
601 | </column> | |
602 | ||
603 | <column name="fake_bridge"> | |
604 | Does this port represent a sub-bridge for its tagged VLAN within the | |
605 | Bridge? See ovs-vsctl(8) for more information. | |
606 | </column> | |
607 | ||
608 | <column name="external_ids"> | |
0e869da1 BP |
609 | <p> |
610 | Key-value pairs for use by external frameworks that integrate with | |
611 | Open vSwitch, rather than by Open vSwitch itself. System integrators | |
612 | should either use the Open vSwitch development mailing list to | |
613 | coordinate on common key-value definitions, or choose key names that | |
614 | are likely to be unique. | |
615 | </p> | |
616 | <p> | |
617 | No key-value pairs native to <ref table="Port"/> are currently | |
618 | defined. For fake bridges (see the <ref column="fake_bridge"/> | |
619 | column), external IDs for the fake bridge are defined here by | |
620 | prefixing a <ref table="Bridge"/> <ref table="Bridge" | |
621 | column="external_ids"/> key with <code>fake-bridge-</code>, | |
c76fde78 | 622 | e.g. <code>fake-bridge-xs-network-uuids</code>. |
0e869da1 | 623 | </p> |
89365653 BP |
624 | </column> |
625 | ||
626 | <column name="other_config"> | |
627 | Key-value pairs for configuring rarely used port features. The | |
628 | currently defined key-value pairs are: | |
629 | <dl> | |
630 | <dt><code>hwaddr</code></dt> | |
2e57b537 | 631 | <dd>An Ethernet address in the form |
89365653 | 632 | <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd> |
c8143c88 | 633 | <dt><code>bond-rebalance-interval</code></dt> |
be02e7c3 | 634 | <dd>For an SLB bonded port, the number of milliseconds between |
c8143c88 BP |
635 | successive attempts to rebalance the bond, that is, to |
636 | move source MACs and their flows from one interface on | |
637 | the bond to another in an attempt to keep usage of each | |
638 | interface roughly equal. The default is 10000 (10 | |
639 | seconds), and the minimum is 1000 (1 second).</dd> | |
63331829 EJ |
640 | <dt><code>bond-detect-mode</code></dt> |
641 | <dd> Sets the method used to detect link failures in a bonded port. | |
642 | Options are <code>carrier</code> and <code>miimon</code>. Defaults | |
643 | to <code>carrier</code> which uses each interface's carrier to detect | |
644 | failures. When set to <code>miimon</code>, will check for failures | |
645 | by polling each interface's MII. </dd> | |
646 | <dt><code>bond-miimon-interval</code></dt> | |
647 | <dd> The number of milliseconds between successive attempts to | |
648 | poll each interface's MII. Only relevant on ports which use | |
649 | <code>miimon</code> to detect failures. </dd> | |
672d18b2 EJ |
650 | <dt><code>bond-hash-basis</code></dt> |
651 | <dd> An integer hashed along with flows when choosing output slaves. | |
652 | When changed, all flows will be assigned different hash values | |
653 | possibly causing slave selection decisions to change.</dd> | |
abd4a95d EJ |
654 | <dt><code>lacp-system-id</code></dt> |
655 | <dd> The LACP system ID of this <ref table="Port"/>. The system ID | |
656 | of a LACP bond is used to identify itself to its partners. Must | |
657 | be a nonzero MAC address.</dd> | |
c25c91fd EJ |
658 | <dt><code>lacp-system-priority</code></dt> |
659 | <dd> The LACP system priority of this <ref table="Port"/>. In | |
660 | LACP negotiations, link status decisions are made by the system | |
661 | with the numerically lower priority. Must be a number between 1 | |
662 | and 65535.</dd> | |
269340fa | 663 | <dt><code>lacp-time</code></dt> |
cdcf42c6 EJ |
664 | <dd> |
665 | <p>The LACP timing which should be used on this | |
666 | <ref table="Port"/>. Possible values are <code>fast</code>, | |
667 | <code>slow</code> and a positive number of milliseconds. By | |
668 | default <code>slow</code> is used. When configured to be | |
669 | <code>fast</code> LACP heartbeats are requested at a rate of once | |
670 | per second causing connectivity problems to be detected more | |
671 | quickly. In <code>slow</code> mode, heartbeats are requested at | |
672 | a rate of once every 30 seconds.</p> | |
673 | ||
674 | <p>Users may manually set a heartbeat transmission rate to increase | |
675 | the fault detection speed further. When manually set, OVS | |
676 | expects the partner switch to be configured with the same | |
677 | transmission rate. Manually setting <code>lacp-time</code> to | |
678 | something other than <code>fast</code> or <code>slow</code> is | |
679 | not supported by the LACP specification.</p> | |
680 | </dd> | |
20601813 EJ |
681 | <dt><code>lacp-strict</code></dt> |
682 | <dd> When <code>true</code>, configures this <ref table="Port"/> to | |
683 | require successful LACP negotiations to enable any slaves. | |
684 | Defaults to <code>false</code> which safely allows LACP to be used | |
685 | with switchs that do not support the protocol.</dd> | |
89365653 BP |
686 | </dl> |
687 | </column> | |
688 | </group> | |
689 | </table> | |
690 | ||
691 | <table name="Interface" title="One physical network device in a Port."> | |
692 | An interface within a <ref table="Port"/>. | |
693 | ||
694 | <group title="Core Features"> | |
695 | <column name="name"> | |
696 | Interface name. Should be alphanumeric and no more than about 8 bytes | |
697 | long. May be the same as the port name, for non-bonded ports. Must | |
698 | otherwise be unique among the names of ports, interfaces, and bridges | |
699 | on a host. | |
700 | </column> | |
701 | ||
702 | <column name="mac"> | |
703 | <p>Ethernet address to set for this interface. If unset then the | |
704 | default MAC address is used:</p> | |
705 | <ul> | |
706 | <li>For the local interface, the default is the lowest-numbered MAC | |
707 | address among the other bridge ports, either the value of the | |
708 | <ref table="Port" column="mac"/> in its <ref table="Port"/> record, | |
709 | if set, or its actual MAC (for bonded ports, the MAC of its slave | |
710 | whose name is first in alphabetical order). Internal ports and | |
711 | bridge ports that are used as port mirroring destinations (see the | |
712 | <ref table="Mirror"/> table) are ignored.</li> | |
2e57b537 | 713 | <li>For other internal interfaces, the default MAC is randomly |
89365653 BP |
714 | generated.</li> |
715 | <li>External interfaces typically have a MAC address associated with | |
716 | their hardware.</li> | |
717 | </ul> | |
718 | <p>Some interfaces may not have a software-controllable MAC | |
719 | address.</p> | |
720 | </column> | |
721 | ||
722 | <column name="ofport"> | |
723 | <p>OpenFlow port number for this interface. Unlike most columns, this | |
724 | column's value should be set only by Open vSwitch itself. Other | |
725 | clients should set this column to an empty set (the default) when | |
726 | creating an <ref table="Interface"/>.</p> | |
727 | <p>Open vSwitch populates this column when the port number becomes | |
728 | known. If the interface is successfully added, | |
729 | <ref column="ofport"/> will be set to a number between 1 and 65535 | |
439b6fcc | 730 | (generally either in the range 1 to 65279, inclusive, or 65534, the |
2e57b537 BP |
731 | port number for the OpenFlow ``local port''). If the interface |
732 | cannot be added then Open vSwitch sets this column | |
733 | to -1.</p> | |
89365653 BP |
734 | </column> |
735 | </group> | |
736 | ||
737 | <group title="System-Specific Details"> | |
738 | <column name="type"> | |
739 | The interface type, one of: | |
740 | <dl> | |
741 | <dt><code>system</code></dt> | |
742 | <dd>An ordinary network device, e.g. <code>eth0</code> on Linux. | |
743 | Sometimes referred to as ``external interfaces'' since they are | |
744 | generally connected to hardware external to that on which the Open | |
745 | vSwitch is running. The empty string is a synonym for | |
746 | <code>system</code>.</dd> | |
747 | <dt><code>internal</code></dt> | |
2e57b537 | 748 | <dd>A simulated network device that sends and receives traffic. An |
89365653 BP |
749 | internal interface whose <ref column="name"/> is the same as its |
750 | bridge's <ref table="Open_vSwitch" column="name"/> is called the | |
751 | ``local interface.'' It does not make sense to bond an internal | |
752 | interface, so the terms ``port'' and ``interface'' are often used | |
753 | imprecisely for internal interfaces.</dd> | |
754 | <dt><code>tap</code></dt> | |
755 | <dd>A TUN/TAP device managed by Open vSwitch.</dd> | |
756 | <dt><code>gre</code></dt> | |
bd1bcd39 | 757 | <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4 |
88720519 JG |
758 | tunnel. Each tunnel must be uniquely identified by the |
759 | combination of <code>remote_ip</code>, <code>local_ip</code>, and | |
760 | <code>in_key</code>. Note that if two ports are defined that are | |
761 | the same except one has an optional identifier and the other does | |
762 | not, the more specific one is matched first. <code>in_key</code> | |
763 | is considered more specific than <code>local_ip</code> if a port | |
299a244b | 764 | defines one and another port defines the other. The following |
eca2df31 | 765 | options may be specified in the <ref column="options"/> column: |
88720519 JG |
766 | <dl> |
767 | <dt><code>remote_ip</code></dt> | |
768 | <dd>Required. The tunnel endpoint.</dd> | |
769 | </dl> | |
770 | <dl> | |
771 | <dt><code>local_ip</code></dt> | |
772 | <dd>Optional. The destination IP that received packets must | |
773 | match. Default is to match all addresses.</dd> | |
774 | </dl> | |
775 | <dl> | |
776 | <dt><code>in_key</code></dt> | |
777 | <dd>Optional. The GRE key that received packets must contain. | |
778 | It may either be a 32-bit number (no key and a key of 0 are | |
779 | treated as equivalent) or the word <code>flow</code>. If | |
780 | <code>flow</code> is specified then any key will be accepted | |
781 | and the key will be placed in the <code>tun_id</code> field | |
782 | for matching in the flow table. The ovs-ofctl manual page | |
783 | contains additional information about matching fields in | |
784 | OpenFlow flows. Default is no key.</dd> | |
785 | </dl> | |
786 | <dl> | |
787 | <dt><code>out_key</code></dt> | |
788 | <dd>Optional. The GRE key to be set on outgoing packets. It may | |
789 | either be a 32-bit number or the word <code>flow</code>. If | |
790 | <code>flow</code> is specified then the key may be set using | |
791 | the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0 | |
68eb0391 | 792 | is used in the absence of an action). The ovs-ofctl manual |
88720519 JG |
793 | page contains additional information about the Nicira OpenFlow |
794 | vendor extensions. Default is no key.</dd> | |
795 | </dl> | |
796 | <dl> | |
797 | <dt><code>key</code></dt> | |
798 | <dd>Optional. Shorthand to set <code>in_key</code> and | |
799 | <code>out_key</code> at the same time.</dd> | |
800 | </dl> | |
801 | <dl> | |
802 | <dt><code>tos</code></dt> | |
803 | <dd>Optional. The value of the ToS bits to be set on the | |
804 | encapsulating packet. It may also be the word | |
805 | <code>inherit</code>, in which case the ToS will be copied from | |
806 | the inner packet if it is IPv4 or IPv6 (otherwise it will be | |
807 | 0). Note that the ECN fields are always inherited. Default is | |
808 | 0.</dd> | |
809 | </dl> | |
810 | <dl> | |
811 | <dt><code>ttl</code></dt> | |
812 | <dd>Optional. The TTL to be set on the encapsulating packet. | |
813 | It may also be the word <code>inherit</code>, in which case the | |
814 | TTL will be copied from the inner packet if it is IPv4 or IPv6 | |
815 | (otherwise it will be the system default, typically 64). | |
816 | Default is the system default TTL.</dd> | |
817 | </dl> | |
818 | <dl> | |
819 | <dt><code>csum</code></dt> | |
16e9d4f6 JG |
820 | <dd>Optional. Compute GRE checksums on outgoing packets. |
821 | Checksums present on incoming packets will be validated | |
822 | regardless of this setting. Note that GRE checksums | |
bd1bcd39 JG |
823 | impose a significant performance penalty as they cover the |
824 | entire packet. As the contents of the packet is typically | |
825 | covered by L3 and L4 checksums, this additional checksum only | |
826 | adds value for the GRE and encapsulated Ethernet headers. | |
827 | Default is disabled, set to <code>true</code> to enable.</dd> | |
88720519 JG |
828 | </dl> |
829 | <dl> | |
830 | <dt><code>pmtud</code></dt> | |
831 | <dd>Optional. Enable tunnel path MTU discovery. If enabled | |
832 | ``ICMP destination unreachable - fragmentation'' needed | |
a28716da JG |
833 | messages will be generated for IPv4 packets with the DF bit set |
834 | and IPv6 packets above the minimum MTU if the packet size | |
835 | exceeds the path MTU minus the size of the tunnel headers. It | |
836 | also forces the encapsulating packet DF bit to be set (it is | |
837 | always set if the inner packet implies path MTU discovery). | |
838 | Note that this option causes behavior that is typically | |
839 | reserved for routers and therefore is not entirely in | |
840 | compliance with the IEEE 802.1D specification for bridges. | |
841 | Default is enabled, set to <code>false</code> to disable.</dd> | |
842 | </dl> | |
dca9309a JG |
843 | <dl> |
844 | <dt><code>header_cache</code></dt> | |
845 | <dd>Optional. Enable caching of tunnel headers and the output | |
9a3f4a49 JP |
846 | path. This can lead to a significant performance increase |
847 | without changing behavior. In general it should not be | |
848 | necessary to adjust this setting. However, the caching can | |
849 | bypass certain components of the IP stack (such as IP tables) | |
850 | and it may be useful to disable it if these features are | |
851 | required or as a debugging measure. Default is enabled, set to | |
e16a28b5 JP |
852 | <code>false</code> to disable.</dd> |
853 | </dl> | |
854 | </dd> | |
855 | <dt><code>ipsec_gre</code></dt> | |
3c52fa7b JP |
856 | <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation |
857 | over IPv4 IPsec tunnel. Each tunnel (including those of type | |
858 | <code>gre</code>) must be uniquely identified by the | |
859 | combination of <code>remote_ip</code> and | |
860 | <code>local_ip</code>. Note that if two ports are defined | |
861 | that are the same except one has an optional identifier and | |
862 | the other does not, the more specific one is matched first. | |
863 | An authentication method of <code>peer_cert</code> or | |
864 | <code>psk</code> must be defined. The following options may | |
865 | be specified in the <ref column="options"/> column: | |
e16a28b5 JP |
866 | <dl> |
867 | <dt><code>remote_ip</code></dt> | |
868 | <dd>Required. The tunnel endpoint.</dd> | |
869 | </dl> | |
870 | <dl> | |
871 | <dt><code>local_ip</code></dt> | |
872 | <dd>Optional. The destination IP that received packets must | |
873 | match. Default is to match all addresses.</dd> | |
874 | </dl> | |
875 | <dl> | |
3c52fa7b JP |
876 | <dt><code>peer_cert</code></dt> |
877 | <dd>Required for certificate authentication. A string | |
878 | containing the peer's certificate in PEM format. | |
879 | Additionally the host's certificate must be specified | |
880 | with the <code>certificate</code> option.</dd> | |
881 | </dl> | |
882 | <dl> | |
883 | <dt><code>certificate</code></dt> | |
884 | <dd>Required for certificate authentication. The name of a | |
885 | PEM file containing a certificate that will be presented | |
886 | to the peer during authentication.</dd> | |
887 | </dl> | |
888 | <dl> | |
889 | <dt><code>private_key</code></dt> | |
890 | <dd>Optional for certificate authentication. The name of | |
891 | a PEM file containing the private key associated with | |
892 | <code>certificate</code>. If <code>certificate</code> | |
893 | contains the private key, this option may be omitted.</dd> | |
894 | </dl> | |
895 | <dl> | |
896 | <dt><code>psk</code></dt> | |
897 | <dd>Required for pre-shared key authentication. Specifies a | |
898 | pre-shared key for authentication that must be identical on | |
899 | both sides of the tunnel.</dd> | |
e16a28b5 JP |
900 | </dl> |
901 | <dl> | |
902 | <dt><code>in_key</code></dt> | |
903 | <dd>Optional. The GRE key that received packets must contain. | |
904 | It may either be a 32-bit number (no key and a key of 0 are | |
905 | treated as equivalent) or the word <code>flow</code>. If | |
906 | <code>flow</code> is specified then any key will be accepted | |
907 | and the key will be placed in the <code>tun_id</code> field | |
908 | for matching in the flow table. The ovs-ofctl manual page | |
909 | contains additional information about matching fields in | |
910 | OpenFlow flows. Default is no key.</dd> | |
911 | </dl> | |
912 | <dl> | |
913 | <dt><code>out_key</code></dt> | |
914 | <dd>Optional. The GRE key to be set on outgoing packets. It may | |
915 | either be a 32-bit number or the word <code>flow</code>. If | |
916 | <code>flow</code> is specified then the key may be set using | |
917 | the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0 | |
918 | is used in the absence of an action). The ovs-ofctl manual | |
919 | page contains additional information about the Nicira OpenFlow | |
920 | vendor extensions. Default is no key.</dd> | |
921 | </dl> | |
922 | <dl> | |
923 | <dt><code>key</code></dt> | |
924 | <dd>Optional. Shorthand to set <code>in_key</code> and | |
925 | <code>out_key</code> at the same time.</dd> | |
926 | </dl> | |
927 | <dl> | |
928 | <dt><code>tos</code></dt> | |
929 | <dd>Optional. The value of the ToS bits to be set on the | |
930 | encapsulating packet. It may also be the word | |
931 | <code>inherit</code>, in which case the ToS will be copied from | |
932 | the inner packet if it is IPv4 or IPv6 (otherwise it will be | |
933 | 0). Note that the ECN fields are always inherited. Default is | |
934 | 0.</dd> | |
935 | </dl> | |
936 | <dl> | |
937 | <dt><code>ttl</code></dt> | |
938 | <dd>Optional. The TTL to be set on the encapsulating packet. | |
939 | It may also be the word <code>inherit</code>, in which case the | |
940 | TTL will be copied from the inner packet if it is IPv4 or IPv6 | |
941 | (otherwise it will be the system default, typically 64). | |
942 | Default is the system default TTL.</dd> | |
943 | </dl> | |
944 | <dl> | |
945 | <dt><code>csum</code></dt> | |
946 | <dd>Optional. Compute GRE checksums on outgoing packets. | |
947 | Checksums present on incoming packets will be validated | |
948 | regardless of this setting. Note that GRE checksums | |
949 | impose a significant performance penalty as they cover the | |
950 | entire packet. As the contents of the packet is typically | |
951 | covered by L3 and L4 checksums, this additional checksum only | |
952 | adds value for the GRE and encapsulated Ethernet headers. | |
953 | Default is disabled, set to <code>true</code> to enable.</dd> | |
954 | </dl> | |
955 | <dl> | |
956 | <dt><code>pmtud</code></dt> | |
957 | <dd>Optional. Enable tunnel path MTU discovery. If enabled | |
958 | ``ICMP destination unreachable - fragmentation'' needed | |
959 | messages will be generated for IPv4 packets with the DF bit set | |
960 | and IPv6 packets above the minimum MTU if the packet size | |
961 | exceeds the path MTU minus the size of the tunnel headers. It | |
962 | also forces the encapsulating packet DF bit to be set (it is | |
963 | always set if the inner packet implies path MTU discovery). | |
964 | Note that this option causes behavior that is typically | |
965 | reserved for routers and therefore is not entirely in | |
966 | compliance with the IEEE 802.1D specification for bridges. | |
967 | Default is enabled, set to <code>false</code> to disable.</dd> | |
dca9309a | 968 | </dl> |
a28716da JG |
969 | </dd> |
970 | <dt><code>capwap</code></dt> | |
971 | <dd>Ethernet tunneling over the UDP transport portion of CAPWAP | |
972 | (RFC 5415). This allows interoperability with certain switches | |
973 | where GRE is not available. Note that only the tunneling component | |
974 | of the protocol is implemented. Due to the non-standard use of | |
975 | CAPWAP, UDP ports 58881 and 58882 are used as the source and | |
4acfc635 | 976 | destination ports respectively. Each tunnel must be uniquely |
a28716da JG |
977 | identified by the combination of <code>remote_ip</code> and |
978 | <code>local_ip</code>. If two ports are defined that are the same | |
979 | except one includes <code>local_ip</code> and the other does not, | |
980 | the more specific one is matched first. CAPWAP support is not | |
981 | available on all platforms. Currently it is only supported in the | |
982 | Linux kernel module with kernel versions >= 2.6.25. The following | |
983 | options may be specified in the <ref column="options"/> column: | |
984 | <dl> | |
985 | <dt><code>remote_ip</code></dt> | |
986 | <dd>Required. The tunnel endpoint.</dd> | |
987 | </dl> | |
988 | <dl> | |
989 | <dt><code>local_ip</code></dt> | |
990 | <dd>Optional. The destination IP that received packets must | |
991 | match. Default is to match all addresses.</dd> | |
992 | </dl> | |
993 | <dl> | |
994 | <dt><code>tos</code></dt> | |
995 | <dd>Optional. The value of the ToS bits to be set on the | |
996 | encapsulating packet. It may also be the word | |
997 | <code>inherit</code>, in which case the ToS will be copied from | |
998 | the inner packet if it is IPv4 or IPv6 (otherwise it will be | |
999 | 0). Note that the ECN fields are always inherited. Default is | |
1000 | 0.</dd> | |
1001 | </dl> | |
1002 | <dl> | |
1003 | <dt><code>ttl</code></dt> | |
1004 | <dd>Optional. The TTL to be set on the encapsulating packet. | |
1005 | It may also be the word <code>inherit</code>, in which case the | |
1006 | TTL will be copied from the inner packet if it is IPv4 or IPv6 | |
1007 | (otherwise it will be the system default, typically 64). | |
1008 | Default is the system default TTL.</dd> | |
1009 | </dl> | |
1010 | <dl> | |
1011 | <dt><code>pmtud</code></dt> | |
1012 | <dd>Optional. Enable tunnel path MTU discovery. If enabled | |
1013 | ``ICMP destination unreachable - fragmentation'' needed | |
88720519 JG |
1014 | messages will be generated for IPv4 packets with the DF bit set |
1015 | and IPv6 packets above the minimum MTU if the packet size | |
1016 | exceeds the path MTU minus the size of the tunnel headers. It | |
1017 | also forces the encapsulating packet DF bit to be set (it is | |
1018 | always set if the inner packet implies path MTU discovery). | |
1019 | Note that this option causes behavior that is typically | |
1020 | reserved for routers and therefore is not entirely in | |
1021 | compliance with the IEEE 802.1D specification for bridges. | |
1022 | Default is enabled, set to <code>false</code> to disable.</dd> | |
1023 | </dl> | |
dca9309a JG |
1024 | <dl> |
1025 | <dt><code>header_cache</code></dt> | |
1026 | <dd>Optional. Enable caching of tunnel headers and the output | |
9a3f4a49 JP |
1027 | path. This can lead to a significant performance increase |
1028 | without changing behavior. In general it should not be | |
1029 | necessary to adjust this setting. However, the caching can | |
1030 | bypass certain components of the IP stack (such as IP tables) | |
1031 | and it may be useful to disable it if these features are | |
1032 | required or as a debugging measure. Default is enabled, set to | |
1033 | <code>false</code> to disable.</dd> | |
dca9309a | 1034 | </dl> |
88720519 | 1035 | </dd> |
8aed4223 | 1036 | <dt><code>patch</code></dt> |
eca2df31 BP |
1037 | <dd> |
1038 | <p> | |
1039 | A pair of virtual devices that act as a patch cable. The <ref | |
1040 | column="options"/> column must have the following key-value pair: | |
1041 | </p> | |
1042 | <dl> | |
1043 | <dt><code>peer</code></dt> | |
1044 | <dd> | |
1045 | The <ref column="name"/> of the <ref table="Interface"/> for | |
1046 | the other side of the patch. The named <ref | |
1047 | table="Interface"/>'s own <code>peer</code> option must specify | |
1048 | this <ref table="Interface"/>'s name. That is, the two patch | |
1049 | interfaces must have reversed <ref column="name"/> and | |
1050 | <code>peer</code> values. | |
1051 | </dd> | |
1052 | </dl> | |
1053 | </dd> | |
84b32864 EJ |
1054 | <dt><code>null</code></dt> |
1055 | <dd>An ignored interface.</dd> | |
89365653 BP |
1056 | </dl> |
1057 | </column> | |
1058 | ||
1059 | <column name="options"> | |
1060 | Configuration options whose interpretation varies based on | |
1061 | <ref column="type"/>. | |
1062 | </column> | |
e210037e AE |
1063 | </group> |
1064 | ||
1065 | <group title="Interface Status"> | |
1066 | <p> | |
1067 | Status information about interfaces attached to bridges, updated every | |
1068 | 5 seconds. Not all interfaces have all of these properties; virtual | |
1069 | interfaces don't have a link speed, for example. Non-applicable | |
1070 | columns will have empty values. | |
1071 | </p> | |
1072 | <column name="admin_state"> | |
1073 | <p> | |
1074 | The administrative state of the physical network link. | |
1075 | </p> | |
1076 | </column> | |
1077 | ||
1078 | <column name="link_state"> | |
1079 | <p> | |
0b8024eb BP |
1080 | The observed state of the physical network link. This is ordinarily |
1081 | the link's carrier status. If the interface's <ref table="Port"/> is | |
1082 | a bond configured for miimon monitoring, it is instead the network | |
1083 | link's miimon status. | |
e210037e AE |
1084 | </p> |
1085 | </column> | |
1086 | ||
1087 | <column name="link_speed"> | |
1088 | <p> | |
1089 | The negotiated speed of the physical network link. | |
1090 | Valid values are positive integers greater than 0. | |
1091 | </p> | |
1092 | </column> | |
1093 | ||
1094 | <column name="duplex"> | |
1095 | <p> | |
1096 | The duplex mode of the physical network link. | |
1097 | </p> | |
1098 | </column> | |
1099 | ||
1100 | <column name="mtu"> | |
1101 | <p> | |
1102 | The MTU (maximum transmission unit); i.e. the largest | |
1103 | amount of data that can fit into a single Ethernet frame. | |
1104 | The standard Ethernet MTU is 1500 bytes. Some physical media | |
1105 | and many kinds of virtual interfaces can be configured with | |
1106 | higher MTUs. | |
1107 | </p> | |
f915f1a8 BP |
1108 | <p> |
1109 | This column will be empty for an interface that does not | |
1110 | have an MTU as, for example, some kinds of tunnels do not. | |
1111 | </p> | |
e210037e | 1112 | </column> |
573c1db9 JP |
1113 | |
1114 | <column name="status"> | |
1115 | <p> | |
1116 | Key-value pairs that report port status. Supported status | |
e210037e AE |
1117 | values are <code>type</code>-dependent; some interfaces may not have |
1118 | a valid <code>driver_name</code>, for example. | |
573c1db9 | 1119 | </p> |
ea763e0e | 1120 | <p>The currently defined key-value pairs are:</p> |
e210037e AE |
1121 | <dl> |
1122 | <dt><code>driver_name</code></dt> | |
1123 | <dd>The name of the device driver controlling the network | |
1124 | adapter.</dd> | |
1125 | </dl> | |
1126 | <dl> | |
1127 | <dt><code>driver_version</code></dt> | |
1128 | <dd>The version string of the device driver controlling the | |
1129 | network adapter.</dd> | |
1130 | </dl> | |
1131 | <dl> | |
1132 | <dt><code>firmware_version</code></dt> | |
1133 | <dd>The version string of the network adapter's firmware, if | |
1134 | available.</dd> | |
1135 | </dl> | |
573c1db9 JP |
1136 | <dl> |
1137 | <dt><code>source_ip</code></dt> | |
1138 | <dd>The source IP address used for an IPv4 tunnel end-point, | |
e210037e | 1139 | such as <code>gre</code> or <code>capwap</code>.</dd> |
573c1db9 | 1140 | </dl> |
ea763e0e EJ |
1141 | <dl> |
1142 | <dt><code>tunnel_egress_iface</code></dt> | |
1143 | <dd>Egress interface for tunnels. Currently only relevant for GRE | |
1144 | and CAPWAP tunnels. On Linux systems, this column will show | |
1145 | the name of the interface which is responsible for routing | |
1146 | traffic destined for the configured <code>remote_ip</code>. | |
1147 | This could be an internal interface such as a bridge port.</dd> | |
1148 | </dl> | |
a404826e AE |
1149 | <dl> |
1150 | <dt><code>tunnel_egress_iface_carrier</code></dt> | |
1151 | <dd>Whether a carrier is detected on <ref | |
1152 | column="tunnel_egress_iface"/>. Valid values are <code>down</code> | |
1153 | and <code>up</code>.</dd> | |
1154 | </dl> | |
573c1db9 | 1155 | </column> |
89365653 BP |
1156 | </group> |
1157 | ||
1158 | <group title="Ingress Policing"> | |
3f5d8c02 BP |
1159 | <p> |
1160 | These settings control ingress policing for packets received on this | |
1161 | interface. On a physical interface, this limits the rate at which | |
1162 | traffic is allowed into the system from the outside; on a virtual | |
1163 | interface (one connected to a virtual machine), this limits the rate at | |
1164 | which the VM is able to transmit. | |
1165 | </p> | |
1166 | <p> | |
1167 | Policing is a simple form of quality-of-service that simply drops | |
1168 | packets received in excess of the configured rate. Due to its | |
1169 | simplicity, policing is usually less accurate and less effective than | |
1170 | egress QoS (which is configured using the <ref table="QoS"/> and <ref | |
1171 | table="Queue"/> tables). | |
1172 | </p> | |
1173 | <p> | |
1174 | Policing is currently implemented only on Linux. The Linux | |
1175 | implementation uses a simple ``token bucket'' approach: | |
1176 | </p> | |
1177 | <ul> | |
1178 | <li> | |
1179 | The size of the bucket corresponds to <ref | |
1180 | column="ingress_policing_burst"/>. Initially the bucket is full. | |
1181 | </li> | |
1182 | <li> | |
1183 | Whenever a packet is received, its size (converted to tokens) is | |
1184 | compared to the number of tokens currently in the bucket. If the | |
1185 | required number of tokens are available, they are removed and the | |
1186 | packet is forwarded. Otherwise, the packet is dropped. | |
1187 | </li> | |
1188 | <li> | |
1189 | Whenever it is not full, the bucket is refilled with tokens at the | |
1190 | rate specified by <ref column="ingress_policing_rate"/>. | |
1191 | </li> | |
1192 | </ul> | |
1193 | <p> | |
1194 | Policing interacts badly with some network protocols, and especially | |
1195 | with fragmented IP packets. Suppose that there is enough network | |
1196 | activity to keep the bucket nearly empty all the time. Then this token | |
1197 | bucket algorithm will forward a single packet every so often, with the | |
1198 | period depending on packet size and on the configured rate. All of the | |
1199 | fragments of an IP packets are normally transmitted back-to-back, as a | |
1200 | group. In such a situation, therefore, only one of these fragments | |
1201 | will be forwarded and the rest will be dropped. IP does not provide | |
1202 | any way for the intended recipient to ask for only the remaining | |
1203 | fragments. In such a case there are two likely possibilities for what | |
1204 | will happen next: either all of the fragments will eventually be | |
1205 | retransmitted (as TCP will do), in which case the same problem will | |
1206 | recur, or the sender will not realize that its packet has been dropped | |
1207 | and data will simply be lost (as some UDP-based protocols will do). | |
1208 | Either way, it is possible that no forward progress will ever occur. | |
1209 | </p> | |
1210 | <column name="ingress_policing_rate"> | |
1211 | <p> | |
1212 | Maximum rate for data received on this interface, in kbps. Data | |
1213 | received faster than this rate is dropped. Set to <code>0</code> | |
1214 | (the default) to disable policing. | |
1215 | </p> | |
1216 | </column> | |
1217 | ||
89365653 BP |
1218 | <column name="ingress_policing_burst"> |
1219 | <p>Maximum burst size for data received on this interface, in kb. The | |
1220 | default burst size if set to <code>0</code> is 1000 kb. This value | |
1221 | has no effect if <ref column="ingress_policing_rate"/> | |
1222 | is <code>0</code>.</p> | |
3f5d8c02 BP |
1223 | <p> |
1224 | Specifying a larger burst size lets the algorithm be more forgiving, | |
1225 | which is important for protocols like TCP that react severely to | |
1226 | dropped packets. The burst size should be at least the size of the | |
1227 | interface's MTU. Specifying a value that is numerically at least as | |
1228 | large as 10% of <ref column="ingress_policing_rate"/> helps TCP come | |
1229 | closer to achieving the full rate. | |
1230 | </p> | |
89365653 BP |
1231 | </column> |
1232 | </group> | |
1233 | ||
1234 | <group title="Other Features"> | |
b31bcf60 EJ |
1235 | |
1236 | <column name="monitor"> | |
1237 | Connectivity monitor configuration for this interface. | |
1238 | </column> | |
1239 | ||
a8172aa3 EJ |
1240 | <column name="lacp_current"> |
1241 | Boolean value indicating LACP status for this interface. If true, this | |
1242 | interface has current LACP information about its LACP partner. This | |
1243 | information may be used to monitor the health of interfaces in a LACP | |
1244 | enabled port. This column will be empty if LACP is not enabled. | |
1245 | </column> | |
1246 | ||
89365653 | 1247 | <column name="external_ids"> |
d9af660c JP |
1248 | Key-value pairs for use by external frameworks that integrate |
1249 | with Open vSwitch, rather than by Open vSwitch itself. System | |
1250 | integrators should either use the Open vSwitch development | |
1251 | mailing list to coordinate on common key-value definitions, or | |
1252 | choose key names that are likely to be unique. The currently | |
e61070c3 | 1253 | defined common key-value pairs are: |
d9af660c | 1254 | <dl> |
e61070c3 BP |
1255 | <dt><code>attached-mac</code></dt> |
1256 | <dd> | |
1257 | The MAC address programmed into the ``virtual hardware'' for this | |
1258 | interface, in the form | |
1259 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>. | |
1260 | For Citrix XenServer, this is the value of the <code>MAC</code> | |
1261 | field in the VIF record for this interface.</dd> | |
d9af660c | 1262 | <dt><code>iface-id</code></dt> |
299a244b | 1263 | <dd>A system-unique identifier for the interface. On XenServer, |
d9af660c JP |
1264 | this will commonly be the same as <code>xs-vif-uuid</code>.</dd> |
1265 | </dl> | |
0e869da1 | 1266 | <p> |
d9af660c | 1267 | Additionally the following key-value pairs specifically |
c0f9490c BP |
1268 | apply to an interface that represents a virtual Ethernet interface |
1269 | connected to a virtual machine. These key-value pairs should not be | |
1270 | present for other types of interfaces. Keys whose names end | |
1271 | in <code>-uuid</code> have values that uniquely identify the entity | |
1272 | in question. For a Citrix XenServer hypervisor, these values are | |
1273 | UUIDs in RFC 4122 format. Other hypervisors may use other | |
0e869da1 BP |
1274 | formats. |
1275 | </p> | |
d9af660c | 1276 | <p>The currently defined key-value pairs for XenServer are:</p> |
89365653 | 1277 | <dl> |
d9af660c | 1278 | <dt><code>xs-vif-uuid</code></dt> |
c0f9490c | 1279 | <dd>The virtual interface associated with this interface.</dd> |
d9af660c | 1280 | <dt><code>xs-network-uuid</code></dt> |
c0f9490c | 1281 | <dd>The virtual network to which this interface is attached.</dd> |
d9af660c | 1282 | <dt><code>xs-vm-uuid</code></dt> |
c0f9490c | 1283 | <dd>The VM to which this interface belongs.</dd> |
89365653 BP |
1284 | </dl> |
1285 | </column> | |
018f1525 | 1286 | |
a3acf0b0 | 1287 | <column name="other_config"> |
c25c91fd EJ |
1288 | Key-value pairs for rarely used interface features. |
1289 | <dl> | |
abd4a95d EJ |
1290 | <dt><code>lacp-port-id</code></dt> |
1291 | <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are | |
1292 | used in LACP negotiations to identify individual ports | |
1293 | participating in a bond. Must be a number between 1 and | |
1294 | 65535.</dd> | |
c25c91fd EJ |
1295 | <dt><code>lacp-port-priority</code></dt> |
1296 | <dd> The LACP port priority of this <ref table="Interface"/>. In | |
1297 | LACP negotiations <ref table="Interface"/>s with numerically lower | |
1298 | priorities are preferred for aggregation. Must be a number between | |
1299 | 1 and 65535.</dd> | |
1300 | </dl> | |
a3acf0b0 JP |
1301 | </column> |
1302 | ||
018f1525 BP |
1303 | <column name="statistics"> |
1304 | <p> | |
1305 | Key-value pairs that report interface statistics. The current | |
1306 | implementation updates these counters periodically. In the future, | |
1307 | we plan to, instead, update them when an interface is created, when | |
1308 | they are queried (e.g. using an OVSDB <code>select</code> operation), | |
1309 | and just before an interface is deleted due to virtual interface | |
1310 | hot-unplug or VM shutdown, and perhaps at other times, but not on any | |
1311 | regular periodic basis.</p> | |
1312 | <p> | |
1313 | The currently defined key-value pairs are listed below. These are | |
1314 | the same statistics reported by OpenFlow in its <code>struct | |
1315 | ofp_port_stats</code> structure. If an interface does not support a | |
1316 | given statistic, then that pair is omitted.</p> | |
1317 | <ul> | |
1318 | <li> | |
1319 | Successful transmit and receive counters: | |
1320 | <dl> | |
1321 | <dt><code>rx_packets</code></dt> | |
1322 | <dd>Number of received packets.</dd> | |
1323 | <dt><code>rx_bytes</code></dt> | |
1324 | <dd>Number of received bytes.</dd> | |
1325 | <dt><code>tx_packets</code></dt> | |
1326 | <dd>Number of transmitted packets.</dd> | |
1327 | <dt><code>tx_bytes</code></dt> | |
1328 | <dd>Number of transmitted bytes.</dd> | |
1329 | </dl> | |
1330 | </li> | |
1331 | <li> | |
1332 | Receive errors: | |
1333 | <dl> | |
1334 | <dt><code>rx_dropped</code></dt> | |
1335 | <dd>Number of packets dropped by RX.</dd> | |
1336 | <dt><code>rx_frame_err</code></dt> | |
1337 | <dd>Number of frame alignment errors.</dd> | |
1338 | <dt><code>rx_over_err</code></dt> | |
1339 | <dd>Number of packets with RX overrun.</dd> | |
1340 | <dt><code>rx_crc_err</code></dt> | |
1341 | <dd>Number of CRC errors.</dd> | |
1342 | <dt><code>rx_errors</code></dt> | |
1343 | <dd> | |
1344 | Total number of receive errors, greater than or equal | |
1345 | to the sum of the above. | |
1346 | </dd> | |
1347 | </dl> | |
1348 | </li> | |
1349 | <li> | |
1350 | Transmit errors: | |
1351 | <dl> | |
1352 | <dt><code>tx_dropped</code></dt> | |
1353 | <dd>Number of packets dropped by TX.</dd> | |
1354 | <dt><code>collisions</code></dt> | |
1355 | <dd>Number of collisions.</dd> | |
1356 | <dt><code>tx_errors</code></dt> | |
1357 | <dd> | |
1358 | Total number of transmit errors, greater | |
1359 | than or equal to the sum of the above. | |
1360 | </dd> | |
1361 | </dl> | |
1362 | </li> | |
1363 | </ul> | |
1364 | </column> | |
89365653 BP |
1365 | </group> |
1366 | </table> | |
1367 | ||
c1c9c9c4 BP |
1368 | <table name="QoS" title="Quality of Service configuration"> |
1369 | <p>Quality of Service (QoS) configuration for each Port that | |
1370 | references it.</p> | |
1371 | ||
1372 | <column name="type"> | |
1373 | <p>The type of QoS to implement. The <ref table="Open_vSwitch" | |
1374 | column="capabilities"/> column in the <ref table="Open_vSwitch"/> table | |
1375 | identifies the types that a switch actually supports. The currently | |
1376 | defined types are listed below:</p> | |
1377 | <dl> | |
1378 | <dt><code>linux-htb</code></dt> | |
6784cb57 BP |
1379 | <dd> |
1380 | Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at | |
1381 | <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual | |
1382 | (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>) | |
1383 | for information on how this classifier works and how to configure it. | |
1384 | </dd> | |
c1c9c9c4 | 1385 | </dl> |
a339aa81 EJ |
1386 | <dl> |
1387 | <dt><code>linux-hfsc</code></dt> | |
1388 | <dd> | |
1389 | Linux "Hierarchical Fair Service Curve" classifier. | |
1390 | See <code>http://linux-ip.net/articles/hfsc.en/</code> for | |
1391 | information on how this classifier works. | |
1392 | </dd> | |
1393 | </dl> | |
c1c9c9c4 BP |
1394 | </column> |
1395 | ||
1396 | <column name="queues"> | |
1397 | <p>A map from queue numbers to <ref table="Queue"/> records. The | |
1398 | supported range of queue numbers depend on <ref column="type"/>. The | |
1399 | queue numbers are the same as the <code>queue_id</code> used in | |
1400 | OpenFlow in <code>struct ofp_action_enqueue</code> and other | |
1401 | structures. Queue 0 is used by OpenFlow output actions that do not | |
1402 | specify a specific queue.</p> | |
1403 | </column> | |
1404 | ||
1405 | <column name="other_config"> | |
1406 | <p>Key-value pairs for configuring QoS features that depend on | |
1407 | <ref column="type"/>.</p> | |
a339aa81 EJ |
1408 | <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support |
1409 | the following key-value pairs:</p> | |
c1c9c9c4 BP |
1410 | <dl> |
1411 | <dt><code>max-rate</code></dt> | |
1412 | <dd>Maximum rate shared by all queued traffic, in bit/s. | |
1413 | Optional. If not specified, for physical interfaces, the | |
1414 | default is the link rate. For other interfaces or if the | |
1415 | link rate cannot be determined, the default is currently 100 | |
1416 | Mbps.</dd> | |
1417 | </dl> | |
1418 | </column> | |
13008eb3 BP |
1419 | |
1420 | <column name="external_ids"> | |
1421 | Key-value pairs for use by external frameworks that integrate with Open | |
1422 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
1423 | either use the Open vSwitch development mailing list to coordinate on | |
1424 | common key-value definitions, or choose key names that are likely to be | |
1425 | unique. No common key-value pairs are currently defined. | |
1426 | </column> | |
c1c9c9c4 BP |
1427 | </table> |
1428 | ||
1429 | <table name="Queue" title="QoS output queue."> | |
1430 | <p>A configuration for a port output queue, used in configuring Quality of | |
1431 | Service (QoS) features. May be referenced by <ref column="queues" | |
1432 | table="QoS"/> column in <ref table="QoS"/> table.</p> | |
1433 | ||
1434 | <column name="other_config"> | |
1435 | <p>Key-value pairs for configuring the output queue. The supported | |
1436 | key-value pairs and their meanings depend on the <ref column="type"/> | |
1437 | of the <ref column="QoS"/> records that reference this row.</p> | |
1438 | <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS" | |
1439 | column="type"/> of <code>min-rate</code> are:</p> | |
1440 | <dl> | |
1441 | <dt><code>min-rate</code></dt> | |
da3827b5 JP |
1442 | <dd>Minimum guaranteed bandwidth, in bit/s. Required. The |
1443 | floor value is 1500 bytes/s (12,000 bit/s).</dd> | |
c1c9c9c4 BP |
1444 | </dl> |
1445 | <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS" | |
1446 | column="type"/> of <code>linux-htb</code> are:</p> | |
1447 | <dl> | |
1448 | <dt><code>min-rate</code></dt> | |
c45ab5e9 | 1449 | <dd>Minimum guaranteed bandwidth, in bit/s.</dd> |
c1c9c9c4 BP |
1450 | <dt><code>max-rate</code></dt> |
1451 | <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the | |
1452 | queue's rate will not be allowed to exceed the specified value, even | |
1453 | if excess bandwidth is available. If unspecified, defaults to no | |
1454 | limit.</dd> | |
1455 | <dt><code>burst</code></dt> | |
1456 | <dd>Burst size, in bits. This is the maximum amount of ``credits'' | |
1457 | that a queue can accumulate while it is idle. Optional. Details of | |
1458 | the <code>linux-htb</code> implementation require a minimum burst | |
1459 | size, so a too-small <code>burst</code> will be silently | |
1460 | ignored.</dd> | |
1461 | <dt><code>priority</code></dt> | |
1462 | <dd>A nonnegative 32-bit integer. Defaults to 0 if | |
1463 | unspecified. A queue with a smaller <code>priority</code> | |
1464 | will receive all the excess bandwidth that it can use before | |
1465 | a queue with a larger value receives any. Specific priority | |
1466 | values are unimportant; only relative ordering matters.</dd> | |
1467 | </dl> | |
a339aa81 EJ |
1468 | <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS" |
1469 | column="type"/> of <code>linux-hfsc</code> are:</p> | |
1470 | <dl> | |
1471 | <dt><code>min-rate</code></dt> | |
c45ab5e9 | 1472 | <dd>Minimum guaranteed bandwidth, in bit/s.</dd> |
a339aa81 EJ |
1473 | <dt><code>max-rate</code></dt> |
1474 | <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the | |
1475 | queue's rate will not be allowed to exceed the specified value, even | |
1476 | if excess bandwidth is available. If unspecified, defaults to no | |
1477 | limit.</dd> | |
1478 | </dl> | |
c1c9c9c4 | 1479 | </column> |
13008eb3 BP |
1480 | |
1481 | <column name="external_ids"> | |
1482 | Key-value pairs for use by external frameworks that integrate with Open | |
1483 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
1484 | either use the Open vSwitch development mailing list to coordinate on | |
1485 | common key-value definitions, or choose key names that are likely to be | |
1486 | unique. No common key-value pairs are currently defined. | |
1487 | </column> | |
c1c9c9c4 BP |
1488 | </table> |
1489 | ||
b31bcf60 EJ |
1490 | <table name="Monitor" title="Connectivity Monitor configuration"> |
1491 | <p> | |
1492 | A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to | |
1493 | implement 802.1ag Connectivity Fault Management (CFM). CFM allows a | |
1494 | group of Maintenance Points (MPs) called a Maintenance Association (MA) | |
1495 | to detect connectivity problems with each other. MPs within a MA should | |
1496 | have complete and exclusive interconnectivity. This is verified by | |
1497 | occasionally broadcasting Continuity Check Messages (CCMs) at a | |
1498 | configurable transmission interval. A <ref table="Monitor"/> is | |
1499 | responsible for collecting data about other MPs in its MA and | |
1500 | broadcasting CCMs. | |
1501 | </p> | |
1502 | ||
1503 | <group title="Monitor Configuration"> | |
1504 | <column name="mpid"> | |
1505 | A Maintenance Point ID (MPID) uniquely identifies each endpoint within | |
1506 | a Maintenance Association (see <ref column="ma_name"/>). The MPID is | |
1507 | used to identify this <ref table="Monitor"/> to other endpoints in the | |
1508 | MA. | |
1509 | </column> | |
1510 | ||
1511 | <column name="remote_mps"> | |
1512 | A set of <ref table="Maintenance_Points"/> which this | |
1513 | <ref table="Monitor"/> should have connectivity to. If this | |
1514 | <ref table="Monitor"/> does not have connectivity to any MPs in this | |
1515 | set, or has connectivity to any MPs not in this set, a fault is | |
1516 | signaled. | |
1517 | </column> | |
1518 | ||
1519 | <column name="ma_name"> | |
1520 | A Maintenance Association (MA) name pairs with a Maintenance Domain | |
1521 | (MD) name to uniquely identify a MA. A MA is a group of endpoints who | |
1522 | have complete and exclusive interconnectivity. Defaults to | |
1523 | <code>ovs</code> if unset. | |
1524 | </column> | |
1525 | ||
1526 | <column name="md_name"> | |
1527 | A Maintenance Domain name pairs with a Maintenance Association name to | |
1528 | uniquely identify a MA. Defaults to <code>ovs</code> if unset. | |
1529 | </column> | |
1530 | ||
1531 | <column name="interval"> | |
1532 | The transmission interval of CCMs in milliseconds. Three missed CCMs | |
1533 | indicate a connectivity fault. Defaults to 1000ms. | |
1534 | </column> | |
1535 | </group> | |
1536 | ||
1537 | <group title="Monitor Status"> | |
b31bcf60 EJ |
1538 | <column name="fault"> |
1539 | Indicates a Connectivity Fault caused by a configuration error, a down | |
1540 | remote MP, or unexpected connectivity to a remote MAID or remote MP. | |
1541 | </column> | |
1542 | </group> | |
1543 | </table> | |
1544 | ||
1545 | <table name="Maintenance_Point" title="Maintenance Point configuration"> | |
1546 | <p> | |
1547 | A <ref table="Maintenance_Point"/> represents a MP which a | |
1548 | <ref table="Monitor"/> has or should have connectivity to. | |
1549 | </p> | |
1550 | ||
1551 | <group title="Maintenance_Point Configuration"> | |
1552 | <column name="mpid"> | |
1553 | A Maintenance Point ID (MPID) uniquely identifies each endpoint within | |
1554 | a Maintenance Association. All MPs within a MA should have a unique | |
1555 | MPID. | |
1556 | </column> | |
1557 | </group> | |
1558 | ||
1559 | <group title="Maintenance_Point Status"> | |
1560 | <column name="fault"> | |
1561 | Indicates a connectivity fault. | |
1562 | </column> | |
1563 | </group> | |
1564 | </table> | |
1565 | ||
89365653 BP |
1566 | <table name="Mirror" title="Port mirroring (SPAN/RSPAN)."> |
1567 | <p>A port mirror within a <ref table="Bridge"/>.</p> | |
1568 | <p>A port mirror configures a bridge to send selected frames to special | |
1569 | ``mirrored'' ports, in addition to their normal destinations. Mirroring | |
1570 | traffic may also be referred to as SPAN or RSPAN, depending on the | |
1571 | mechanism used for delivery.</p> | |
1572 | ||
1573 | <column name="name"> | |
1574 | Arbitrary identifier for the <ref table="Mirror"/>. | |
1575 | </column> | |
1576 | ||
1577 | <group title="Selecting Packets for Mirroring"> | |
3e519d8e BP |
1578 | <p> |
1579 | To be selected for mirroring, a given packet must enter or leave the | |
1580 | bridge through a selected port and it must also be in one of the | |
1581 | selected VLANs. | |
1582 | </p> | |
1583 | ||
939ff267 BP |
1584 | <column name="select_all"> |
1585 | If true, every packet arriving or departing on any port is | |
1586 | selected for mirroring. | |
1587 | </column> | |
1588 | ||
89365653 BP |
1589 | <column name="select_dst_port"> |
1590 | Ports on which departing packets are selected for mirroring. | |
1591 | </column> | |
1592 | ||
1593 | <column name="select_src_port"> | |
939ff267 | 1594 | Ports on which arriving packets are selected for mirroring. |
89365653 BP |
1595 | </column> |
1596 | ||
1597 | <column name="select_vlan"> | |
1598 | VLANs on which packets are selected for mirroring. An empty set | |
1599 | selects packets on all VLANs. | |
1600 | </column> | |
1601 | </group> | |
1602 | ||
1603 | <group title="Mirroring Destination Configuration"> | |
3e519d8e BP |
1604 | <p> |
1605 | These columns are mutually exclusive. Exactly one of them must be | |
1606 | nonempty. | |
1607 | </p> | |
1608 | ||
89365653 | 1609 | <column name="output_port"> |
3e519d8e | 1610 | <p>Output port for selected packets, if nonempty.</p> |
89365653 BP |
1611 | <p>Specifying a port for mirror output reserves that port exclusively |
1612 | for mirroring. No frames other than those selected for mirroring | |
1613 | will be forwarded to the port, and any frames received on the port | |
1614 | will be discarded.</p> | |
1615 | <p>This type of mirroring is sometimes called SPAN.</p> | |
1616 | </column> | |
1617 | ||
1618 | <column name="output_vlan"> | |
3e519d8e | 1619 | <p>Output VLAN for selected packets, if nonempty.</p> |
89365653 BP |
1620 | <p>The frames will be sent out all ports that trunk |
1621 | <ref column="output_vlan"/>, as well as any ports with implicit VLAN | |
1622 | <ref column="output_vlan"/>. When a mirrored frame is sent out a | |
1623 | trunk port, the frame's VLAN tag will be set to | |
1624 | <ref column="output_vlan"/>, replacing any existing tag; when it is | |
1625 | sent out an implicit VLAN port, the frame will not be tagged. This | |
1626 | type of mirroring is sometimes called RSPAN.</p> | |
1627 | <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that | |
1628 | contains unmanaged switches. Consider an unmanaged physical switch | |
1629 | with two ports: port 1, connected to an end host, and port 2, | |
1630 | connected to an Open vSwitch configured to mirror received packets | |
1631 | into VLAN 123 on port 2. Suppose that the end host sends a packet on | |
1632 | port 1 that the physical switch forwards to port 2. The Open vSwitch | |
1633 | forwards this packet to its destination and then reflects it back on | |
1634 | port 2 in VLAN 123. This reflected packet causes the unmanaged | |
1635 | physical switch to replace the MAC learning table entry, which | |
1636 | correctly pointed to port 1, with one that incorrectly points to port | |
1637 | 2. Afterward, the physical switch will direct packets destined for | |
1638 | the end host to the Open vSwitch on port 2, instead of to the end | |
1639 | host on port 1, disrupting connectivity. If mirroring to a VLAN is | |
1640 | desired in this scenario, then the physical switch must be replaced | |
1641 | by one that learns Ethernet addresses on a per-VLAN basis. In | |
1642 | addition, learning should be disabled on the VLAN containing mirrored | |
1643 | traffic. If this is not done then intermediate switches will learn | |
1644 | the MAC address of each end host from the mirrored traffic. If | |
1645 | packets being sent to that end host are also mirrored, then they will | |
1646 | be dropped since the switch will attempt to send them out the input | |
1647 | port. Disabling learning for the VLAN will cause the switch to | |
1648 | correctly send the packet out all ports configured for that VLAN. If | |
1649 | Open vSwitch is being used as an intermediate switch, learning can be | |
1650 | disabled by adding the mirrored VLAN to <ref column="flood_vlans"/> | |
1651 | in the appropriate <ref table="Bridge"/> table or tables.</p> | |
1652 | </column> | |
1653 | </group> | |
13008eb3 BP |
1654 | |
1655 | <group title="Other Features"> | |
1656 | <column name="external_ids"> | |
1657 | Key-value pairs for use by external frameworks that integrate with Open | |
1658 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
1659 | either use the Open vSwitch development mailing list to coordinate on | |
1660 | common key-value definitions, or choose key names that are likely to be | |
1661 | unique. No common key-value pairs are currently defined. | |
1662 | </column> | |
1663 | </group> | |
89365653 BP |
1664 | </table> |
1665 | ||
1666 | <table name="Controller" title="OpenFlow controller configuration."> | |
76ce9432 BP |
1667 | <p>An OpenFlow controller.</p> |
1668 | ||
7d674866 BP |
1669 | <p> |
1670 | Open vSwitch supports two kinds of OpenFlow controllers: | |
1671 | </p> | |
299a244b | 1672 | |
7d674866 BP |
1673 | <dl> |
1674 | <dt>Primary controllers</dt> | |
1675 | <dd> | |
1676 | <p> | |
1677 | This is the kind of controller envisioned by the OpenFlow 1.0 | |
1678 | specification. Usually, a primary controller implements a network | |
1679 | policy by taking charge of the switch's flow table. | |
1680 | </p> | |
1681 | ||
1682 | <p> | |
1683 | Open vSwitch initiates and maintains persistent connections to | |
1684 | primary controllers, retrying the connection each time it fails or | |
1685 | drops. The <ref table="Bridge" column="fail_mode"/> column in the | |
1686 | <ref table="Bridge"/> table applies to primary controllers. | |
1687 | </p> | |
1688 | ||
1689 | <p> | |
1690 | Open vSwitch permits a bridge to have any number of primary | |
1691 | controllers. When multiple controllers are configured, Open | |
1692 | vSwitch connects to all of them simultaneously. Because | |
1693 | OpenFlow 1.0 does not specify how multiple controllers | |
1694 | coordinate in interacting with a single switch, more than | |
1695 | one primary controller should be specified only if the | |
1696 | controllers are themselves designed to coordinate with each | |
1697 | other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow | |
1698 | vendor extension may be useful for this.) | |
1699 | </p> | |
1700 | </dd> | |
1701 | <dt>Service controllers</dt> | |
1702 | <dd> | |
1703 | <p> | |
1704 | These kinds of OpenFlow controller connections are intended for | |
1705 | occasional support and maintenance use, e.g. with | |
1706 | <code>ovs-ofctl</code>. Usually a service controller connects only | |
1707 | briefly to inspect or modify some of a switch's state. | |
1708 | </p> | |
1709 | ||
1710 | <p> | |
1711 | Open vSwitch listens for incoming connections from service | |
1712 | controllers. The service controllers initiate and, if necessary, | |
1713 | maintain the connections from their end. The <ref table="Bridge" | |
1714 | column="fail_mode"/> column in the <ref table="Bridge"/> table does | |
1715 | not apply to service controllers. | |
1716 | </p> | |
1717 | ||
1718 | <p> | |
1719 | Open vSwitch supports configuring any number of service controllers. | |
1720 | </p> | |
1721 | </dd> | |
1722 | </dl> | |
1723 | ||
1724 | <p> | |
1725 | The <ref column="target"/> determines the type of controller. | |
1726 | </p> | |
89365653 BP |
1727 | |
1728 | <group title="Core Features"> | |
1729 | <column name="target"> | |
7d674866 BP |
1730 | <p>Connection method for controller.</p> |
1731 | <p> | |
1732 | The following connection methods are currently supported for primary | |
1733 | controllers: | |
1734 | </p> | |
89365653 BP |
1735 | <dl> |
1736 | <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt> | |
1737 | <dd> | |
1738 | <p>The specified SSL <var>port</var> (default: 6633) on the host at | |
7d674866 BP |
1739 | the given <var>ip</var>, which must be expressed as an IP address |
1740 | (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/> | |
1741 | column in the <ref table="Open_vSwitch"/> table must point to a | |
1742 | valid SSL configuration when this form is used.</p> | |
89365653 BP |
1743 | <p>SSL support is an optional feature that is not always built as |
1744 | part of Open vSwitch.</p> | |
1745 | </dd> | |
1746 | <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt> | |
1747 | <dd>The specified TCP <var>port</var> (default: 6633) on the host at | |
1748 | the given <var>ip</var>, which must be expressed as an IP address | |
1749 | (not a DNS name).</dd> | |
7d674866 BP |
1750 | </dl> |
1751 | <p> | |
1752 | The following connection methods are currently supported for service | |
1753 | controllers: | |
1754 | </p> | |
1755 | <dl> | |
1756 | <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt> | |
1757 | <dd> | |
1758 | <p> | |
1759 | Listens for SSL connections on the specified TCP <var>port</var> | |
1760 | (default: 6633). If <var>ip</var>, which must be expressed as an | |
1761 | IP address (not a DNS name), is specified, then connections are | |
1762 | restricted to the specified local IP address. | |
1763 | </p> | |
1764 | <p> | |
1765 | The <ref table="Open_vSwitch" column="ssl"/> column in the <ref | |
1766 | table="Open_vSwitch"/> table must point to a valid SSL | |
1767 | configuration when this form is used. | |
1768 | </p> | |
1769 | <p>SSL support is an optional feature that is not always built as | |
1770 | part of Open vSwitch.</p> | |
1771 | </dd> | |
1772 | <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt> | |
1773 | <dd> | |
1774 | Listens for connections on the specified TCP <var>port</var> | |
1775 | (default: 6633). If <var>ip</var>, which must be expressed as an | |
1776 | IP address (not a DNS name), is specified, then connections are | |
1777 | restricted to the specified local IP address. | |
1778 | </dd> | |
89365653 | 1779 | </dl> |
9a3f4a49 JP |
1780 | <p>When multiple controllers are configured for a single bridge, the |
1781 | <ref column="target"/> values must be unique. Duplicate | |
1782 | <ref column="target"/> values yield unspecified results.</p> | |
89365653 BP |
1783 | </column> |
1784 | ||
1785 | <column name="connection_mode"> | |
9a3f4a49 JP |
1786 | <p>If it is specified, this setting must be one of the following |
1787 | strings that describes how Open vSwitch contacts this OpenFlow | |
1788 | controller over the network:</p> | |
1789 | ||
1790 | <dl> | |
1791 | <dt><code>in-band</code></dt> | |
1792 | <dd>In this mode, this controller's OpenFlow traffic travels over the | |
1793 | bridge associated with the controller. With this setting, Open | |
1794 | vSwitch allows traffic to and from the controller regardless of the | |
1795 | contents of the OpenFlow flow table. (Otherwise, Open vSwitch | |
1796 | would never be able to connect to the controller, because it did | |
1797 | not have a flow to enable it.) This is the most common connection | |
1798 | mode because it is not necessary to maintain two independent | |
1799 | networks.</dd> | |
1800 | <dt><code>out-of-band</code></dt> | |
1801 | <dd>In this mode, OpenFlow traffic uses a control network separate | |
1802 | from the bridge associated with this controller, that is, the | |
1803 | bridge does not use any of its own network devices to communicate | |
1804 | with the controller. The control network must be configured | |
1805 | separately, before or after <code>ovs-vswitchd</code> is started. | |
1806 | </dd> | |
1807 | </dl> | |
76ce9432 | 1808 | |
195c8086 | 1809 | <p>If not specified, the default is implementation-specific.</p> |
89365653 BP |
1810 | </column> |
1811 | </group> | |
1812 | ||
1813 | <group title="Controller Failure Detection and Handling"> | |
1814 | <column name="max_backoff"> | |
1815 | Maximum number of milliseconds to wait between connection attempts. | |
1816 | Default is implementation-specific. | |
1817 | </column> | |
1818 | ||
1819 | <column name="inactivity_probe"> | |
1820 | Maximum number of milliseconds of idle time on connection to | |
1821 | controller before sending an inactivity probe message. If Open | |
1822 | vSwitch does not communicate with the controller for the specified | |
1823 | number of seconds, it will send a probe. If a response is not | |
1824 | received for the same additional amount of time, Open vSwitch | |
1825 | assumes the connection has been broken and attempts to reconnect. | |
2bb82bf0 BP |
1826 | Default is implementation-specific. A value of 0 disables |
1827 | inactivity probes. | |
89365653 | 1828 | </column> |
89365653 BP |
1829 | </group> |
1830 | ||
1831 | <group title="OpenFlow Rate Limiting"> | |
89365653 BP |
1832 | <column name="controller_rate_limit"> |
1833 | <p>The maximum rate at which packets in unknown flows will be | |
1834 | forwarded to the OpenFlow controller, in packets per second. This | |
1835 | feature prevents a single bridge from overwhelming the controller. | |
1836 | If not specified, the default is implementation-specific.</p> | |
1837 | <p>In addition, when a high rate triggers rate-limiting, Open | |
1838 | vSwitch queues controller packets for each port and transmits | |
1839 | them to the controller at the configured rate. The number of | |
1840 | queued packets is limited by | |
1841 | the <ref column="controller_burst_limit"/> value. The packet | |
1842 | queue is shared fairly among the ports on a bridge.</p><p>Open | |
1843 | vSwitch maintains two such packet rate-limiters per bridge. | |
1844 | One of these applies to packets sent up to the controller | |
1845 | because they do not correspond to any flow. The other applies | |
1846 | to packets sent up to the controller by request through flow | |
1847 | actions. When both rate-limiters are filled with packets, the | |
1848 | actual rate that packets are sent to the controller is up to | |
1849 | twice the specified rate.</p> | |
1850 | </column> | |
76ce9432 BP |
1851 | |
1852 | <column name="controller_burst_limit"> | |
1853 | In conjunction with <ref column="controller_rate_limit"/>, | |
1854 | the maximum number of unused packet credits that the bridge will | |
1855 | allow to accumulate, in packets. If not specified, the default | |
1856 | is implementation-specific. | |
1857 | </column> | |
89365653 BP |
1858 | </group> |
1859 | ||
76ce9432 BP |
1860 | <group title="Additional In-Band Configuration"> |
1861 | <p>These values are considered only in in-band control mode (see | |
195c8086 | 1862 | <ref column="connection_mode"/>).</p> |
76ce9432 BP |
1863 | |
1864 | <p>When multiple controllers are configured on a single bridge, there | |
9a3f4a49 JP |
1865 | should be only one set of unique values in these columns. If different |
1866 | values are set for these columns in different controllers, the effect | |
1867 | is unspecified.</p> | |
89365653 BP |
1868 | |
1869 | <column name="local_ip"> | |
76ce9432 BP |
1870 | The IP address to configure on the local port, |
1871 | e.g. <code>192.168.0.123</code>. If this value is unset, then | |
1872 | <ref column="local_netmask"/> and <ref column="local_gateway"/> are | |
1873 | ignored. | |
89365653 BP |
1874 | </column> |
1875 | ||
1876 | <column name="local_netmask"> | |
76ce9432 BP |
1877 | The IP netmask to configure on the local port, |
1878 | e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set | |
1879 | but this value is unset, then the default is chosen based on whether | |
1880 | the IP address is class A, B, or C. | |
1881 | </column> | |
1882 | ||
1883 | <column name="local_gateway"> | |
1884 | The IP address of the gateway to configure on the local port, as a | |
1885 | string, e.g. <code>192.168.0.1</code>. Leave this column unset if | |
1886 | this network has no gateway. | |
89365653 BP |
1887 | </column> |
1888 | </group> | |
13008eb3 BP |
1889 | |
1890 | <group title="Other Features"> | |
1891 | <column name="external_ids"> | |
1892 | Key-value pairs for use by external frameworks that integrate with Open | |
1893 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
1894 | either use the Open vSwitch development mailing list to coordinate on | |
1895 | common key-value definitions, or choose key names that are likely to be | |
1896 | unique. No common key-value pairs are currently defined. | |
1897 | </column> | |
1898 | </group> | |
bffc0589 AE |
1899 | |
1900 | <group title="Controller Status"> | |
1901 | <column name="is_connected"> | |
1902 | <code>true</code> if currently connected to this controller, | |
1903 | <code>false</code> otherwise. | |
1904 | </column> | |
1905 | ||
1906 | <column name="role"> | |
1907 | <p>The level of authority this controller has on the associated | |
1908 | bridge. Possible values are:</p> | |
1909 | <dl> | |
1910 | <dt><code>other</code></dt> | |
1911 | <dd>Allows the controller access to all OpenFlow features.</dd> | |
bffc0589 AE |
1912 | <dt><code>master</code></dt> |
1913 | <dd>Equivalent to <code>other</code>, except that there may be at | |
1914 | most one master controller at a time. When a controller configures | |
1915 | itself as <code>master</code>, any existing master is demoted to | |
1916 | the <code>slave</code>role.</dd> | |
bffc0589 AE |
1917 | <dt><code>slave</code></dt> |
1918 | <dd>Allows the controller read-only access to OpenFlow features. | |
1919 | Attempts to modify the flow table will be rejected with an | |
1920 | error. Slave controllers do not receive OFPT_PACKET_IN or | |
1921 | OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS | |
1922 | messages.</dd> | |
1923 | </dl> | |
1924 | </column> | |
1925 | ||
1926 | <column name="status"> | |
1927 | <p>Key-value pairs that report controller status.</p> | |
1928 | <dl> | |
1929 | <dt><code>last_error</code></dt> | |
1930 | <dd>A human-readable description of the last error on the connection | |
1931 | to the controller; i.e. <code>strerror(errno)</code>. This key | |
1932 | will exist only if an error has occurred.</dd> | |
bffc0589 AE |
1933 | <dt><code>state</code></dt> |
1934 | <dd>The state of the connection to the controller. Possible values | |
2cdcb898 AE |
1935 | are: <code>VOID</code> (connection is disabled), |
1936 | <code>BACKOFF</code> (attempting to reconnect at an increasing | |
1937 | period), <code>CONNECTING</code> (attempting to connect), | |
1938 | <code>ACTIVE</code> (connected, remote host responsive), and | |
1939 | <code>IDLE</code> (remote host idle, sending keep-alive). These | |
1940 | values may change in the future. They are provided only for human | |
1941 | consumption.</dd> | |
1942 | <dt><code>sec_since_connect</code></dt> | |
1943 | <dd>The amount of time since this controller last successfully | |
1944 | connected to the switch (in seconds). Value is empty if controller | |
1945 | has never successfully connected.</dd> | |
1946 | <dt><code>sec_since_disconnect</code></dt> | |
1947 | <dd>The amount of time since this controller last disconnected from | |
1948 | the switch (in seconds). Value is empty if controller has never | |
1949 | disconnected.</dd> | |
bffc0589 AE |
1950 | </dl> |
1951 | </column> | |
1952 | </group> | |
89365653 BP |
1953 | </table> |
1954 | ||
94db5407 BP |
1955 | <table name="Manager" title="OVSDB management connection."> |
1956 | <p> | |
1957 | Configuration for a database connection to an Open vSwitch database | |
1958 | (OVSDB) client. | |
1959 | </p> | |
1960 | ||
1961 | <p> | |
1962 | This table primarily configures the Open vSwitch database | |
1963 | (<code>ovsdb-server</code>), not the Open vSwitch switch | |
1964 | (<code>ovs-vswitchd</code>). The switch does read the table to determine | |
1965 | what connections should be treated as in-band. | |
1966 | </p> | |
1967 | ||
1968 | <p> | |
1969 | The Open vSwitch database server can initiate and maintain active | |
1970 | connections to remote clients. It can also listen for database | |
1971 | connections. | |
1972 | </p> | |
1973 | ||
1974 | <group title="Core Features"> | |
1975 | <column name="target"> | |
1976 | <p>Connection method for managers.</p> | |
1977 | <p> | |
1978 | The following connection methods are currently supported: | |
1979 | </p> | |
1980 | <dl> | |
1981 | <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt> | |
1982 | <dd> | |
1983 | <p> | |
1984 | The specified SSL <var>port</var> (default: 6632) on the host at | |
1985 | the given <var>ip</var>, which must be expressed as an IP address | |
1986 | (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/> | |
1987 | column in the <ref table="Open_vSwitch"/> table must point to a | |
1988 | valid SSL configuration when this form is used. | |
1989 | </p> | |
1990 | <p> | |
1991 | SSL support is an optional feature that is not always built as | |
1992 | part of Open vSwitch. | |
1993 | </p> | |
1994 | </dd> | |
1995 | ||
1996 | <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt> | |
1997 | <dd> | |
1998 | The specified TCP <var>port</var> (default: 6632) on the host at | |
1999 | the given <var>ip</var>, which must be expressed as an IP address | |
2000 | (not a DNS name). | |
2001 | </dd> | |
2002 | <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt> | |
2003 | <dd> | |
2004 | <p> | |
2005 | Listens for SSL connections on the specified TCP <var>port</var> | |
2006 | (default: 6632). If <var>ip</var>, which must be expressed as an | |
2007 | IP address (not a DNS name), is specified, then connections are | |
2008 | restricted to the specified local IP address. | |
2009 | </p> | |
2010 | <p> | |
2011 | The <ref table="Open_vSwitch" column="ssl"/> column in the <ref | |
2012 | table="Open_vSwitch"/> table must point to a valid SSL | |
2013 | configuration when this form is used. | |
2014 | </p> | |
2015 | <p> | |
2016 | SSL support is an optional feature that is not always built as | |
2017 | part of Open vSwitch. | |
2018 | </p> | |
2019 | </dd> | |
2020 | <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt> | |
2021 | <dd> | |
2022 | Listens for connections on the specified TCP <var>port</var> | |
2023 | (default: 6632). If <var>ip</var>, which must be expressed as an | |
2024 | IP address (not a DNS name), is specified, then connections are | |
2025 | restricted to the specified local IP address. | |
2026 | </dd> | |
2027 | </dl> | |
2028 | <p>When multiple managers are configured, the <ref column="target"/> | |
2029 | values must be unique. Duplicate <ref column="target"/> values yield | |
2030 | unspecified results.</p> | |
2031 | </column> | |
2032 | ||
2033 | <column name="connection_mode"> | |
2034 | <p> | |
2035 | If it is specified, this setting must be one of the following strings | |
2036 | that describes how Open vSwitch contacts this OVSDB client over the | |
2037 | network: | |
2038 | </p> | |
299a244b | 2039 | |
94db5407 BP |
2040 | <dl> |
2041 | <dt><code>in-band</code></dt> | |
2042 | <dd> | |
2043 | In this mode, this connection's traffic travels over a bridge | |
2044 | managed by Open vSwitch. With this setting, Open vSwitch allows | |
2045 | traffic to and from the client regardless of the contents of the | |
2046 | OpenFlow flow table. (Otherwise, Open vSwitch would never be able | |
2047 | to connect to the client, because it did not have a flow to enable | |
2048 | it.) This is the most common connection mode because it is not | |
2049 | necessary to maintain two independent networks. | |
2050 | </dd> | |
2051 | <dt><code>out-of-band</code></dt> | |
2052 | <dd> | |
2053 | In this mode, the client's traffic uses a control network separate | |
2054 | from that managed by Open vSwitch, that is, Open vSwitch does not | |
2055 | use any of its own network devices to communicate with the client. | |
2056 | The control network must be configured separately, before or after | |
2057 | <code>ovs-vswitchd</code> is started. | |
2058 | </dd> | |
2059 | </dl> | |
2060 | ||
2061 | <p> | |
2062 | If not specified, the default is implementation-specific. | |
2063 | </p> | |
2064 | </column> | |
2065 | </group> | |
2066 | ||
2067 | <group title="Client Failure Detection and Handling"> | |
2068 | <column name="max_backoff"> | |
2069 | Maximum number of milliseconds to wait between connection attempts. | |
2070 | Default is implementation-specific. | |
2071 | </column> | |
2072 | ||
2073 | <column name="inactivity_probe"> | |
2074 | Maximum number of milliseconds of idle time on connection to the client | |
2075 | before sending an inactivity probe message. If Open vSwitch does not | |
2076 | communicate with the client for the specified number of seconds, it | |
2077 | will send a probe. If a response is not received for the same | |
2078 | additional amount of time, Open vSwitch assumes the connection has been | |
2079 | broken and attempts to reconnect. Default is implementation-specific. | |
2bb82bf0 | 2080 | A value of 0 disables inactivity probes. |
94db5407 BP |
2081 | </column> |
2082 | </group> | |
2083 | ||
2084 | <group title="Other Features"> | |
2085 | <column name="external_ids"> | |
2086 | Key-value pairs for use by external frameworks that integrate with Open | |
2087 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
2088 | either use the Open vSwitch development mailing list to coordinate on | |
2089 | common key-value definitions, or choose key names that are likely to be | |
2090 | unique. No common key-value pairs are currently defined. | |
2091 | </column> | |
2092 | </group> | |
0b3e7a8b AE |
2093 | |
2094 | <group title="Status"> | |
2095 | <column name="is_connected"> | |
2096 | <code>true</code> if currently connected to this manager, | |
2097 | <code>false</code> otherwise. | |
2098 | </column> | |
2099 | ||
2100 | <column name="status"> | |
2101 | <p>Key-value pairs that report manager status.</p> | |
2102 | <dl> | |
2103 | <dt><code>last_error</code></dt> | |
2104 | <dd>A human-readable description of the last error on the connection | |
2105 | to the manager; i.e. <code>strerror(errno)</code>. This key | |
2106 | will exist only if an error has occurred.</dd> | |
2107 | </dl> | |
2108 | <dl> | |
2109 | <dt><code>state</code></dt> | |
2110 | <dd>The state of the connection to the manager. Possible values | |
2111 | are: <code>VOID</code> (connection is disabled), | |
2112 | <code>BACKOFF</code> (attempting to reconnect at an increasing | |
5eda645e | 2113 | period), <code>CONNECTING</code> (attempting to connect), |
0b3e7a8b | 2114 | <code>ACTIVE</code> (connected, remote host responsive), and |
5eda645e | 2115 | <code>IDLE</code> (remote host idle, sending keep-alive). These |
0b3e7a8b AE |
2116 | values may change in the future. They are provided only for human |
2117 | consumption.</dd> | |
2118 | </dl> | |
2119 | <dl> | |
5eda645e AE |
2120 | <dt><code>sec_since_connect</code></dt> |
2121 | <dd>The amount of time since this manager last successfully connected | |
2122 | to the database (in seconds). Value is empty if manager has never | |
2123 | successfully connected.</dd> | |
2124 | </dl> | |
2125 | <dl> | |
2126 | <dt><code>sec_since_disconnect</code></dt> | |
2127 | <dd>The amount of time since this manager last disconnected from the | |
2128 | database (in seconds). Value is empty if manager has never | |
2129 | disconnected.</dd> | |
0b3e7a8b AE |
2130 | </dl> |
2131 | </column> | |
2132 | </group> | |
94db5407 BP |
2133 | </table> |
2134 | ||
89365653 BP |
2135 | <table name="NetFlow"> |
2136 | A NetFlow target. NetFlow is a protocol that exports a number of | |
2137 | details about terminating IP flows, such as the principals involved | |
2138 | and duration. | |
2139 | ||
2140 | <column name="targets"> | |
2141 | NetFlow targets in the form | |
2142 | <code><var>ip</var>:<var>port</var></code>. The <var>ip</var> | |
2143 | must be specified numerically, not as a DNS name. | |
2144 | </column> | |
2145 | ||
2146 | <column name="engine_id"> | |
2147 | Engine ID to use in NetFlow messages. Defaults to datapath index | |
2148 | if not specified. | |
2149 | </column> | |
2150 | ||
2151 | <column name="engine_type"> | |
2152 | Engine type to use in NetFlow messages. Defaults to datapath | |
2153 | index if not specified. | |
2154 | </column> | |
2155 | ||
2156 | <column name="active_timeout"> | |
2157 | The interval at which NetFlow records are sent for flows that are | |
2158 | still active, in seconds. A value of <code>0</code> requests the | |
2159 | default timeout (currently 600 seconds); a value of <code>-1</code> | |
2160 | disables active timeouts. | |
2161 | </column> | |
2162 | ||
2163 | <column name="add_id_to_interface"> | |
2164 | <p>If this column's value is <code>false</code>, the ingress and egress | |
2165 | interface fields of NetFlow flow records are derived from OpenFlow port | |
2166 | numbers. When it is <code>true</code>, the 7 most significant bits of | |
2167 | these fields will be replaced by the least significant 7 bits of the | |
2168 | engine id. This is useful because many NetFlow collectors do not | |
2169 | expect multiple switches to be sending messages from the same host, so | |
2170 | they do not store the engine information which could be used to | |
2171 | disambiguate the traffic.</p> | |
2172 | <p>When this option is enabled, a maximum of 508 ports are supported.</p> | |
2173 | </column> | |
13008eb3 BP |
2174 | |
2175 | <column name="external_ids"> | |
2176 | Key-value pairs for use by external frameworks that integrate with Open | |
2177 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
2178 | either use the Open vSwitch development mailing list to coordinate on | |
2179 | common key-value definitions, or choose key names that are likely to be | |
2180 | unique. No common key-value pairs are currently defined. | |
2181 | </column> | |
89365653 BP |
2182 | </table> |
2183 | ||
2184 | <table name="SSL"> | |
2185 | SSL configuration for an Open_vSwitch. | |
2186 | ||
2187 | <column name="private_key"> | |
2188 | Name of a PEM file containing the private key used as the switch's | |
2189 | identity for SSL connections to the controller. | |
2190 | </column> | |
2191 | ||
2192 | <column name="certificate"> | |
2193 | Name of a PEM file containing a certificate, signed by the | |
2194 | certificate authority (CA) used by the controller and manager, | |
2195 | that certifies the switch's private key, identifying a trustworthy | |
2196 | switch. | |
2197 | </column> | |
2198 | ||
2199 | <column name="ca_cert"> | |
2200 | Name of a PEM file containing the CA certificate used to verify | |
2201 | that the switch is connected to a trustworthy controller. | |
2202 | </column> | |
2203 | ||
2204 | <column name="bootstrap_ca_cert"> | |
2205 | If set to <code>true</code>, then Open vSwitch will attempt to | |
2206 | obtain the CA certificate from the controller on its first SSL | |
2207 | connection and save it to the named PEM file. If it is successful, | |
2208 | it will immediately drop the connection and reconnect, and from then | |
2209 | on all SSL connections must be authenticated by a certificate signed | |
2210 | by the CA certificate thus obtained. <em>This option exposes the | |
2211 | SSL connection to a man-in-the-middle attack obtaining the initial | |
2212 | CA certificate.</em> It may still be useful for bootstrapping. | |
2213 | </column> | |
13008eb3 BP |
2214 | |
2215 | <column name="external_ids"> | |
2216 | Key-value pairs for use by external frameworks that integrate with Open | |
2217 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
2218 | either use the Open vSwitch development mailing list to coordinate on | |
2219 | common key-value definitions, or choose key names that are likely to be | |
2220 | unique. No common key-value pairs are currently defined. | |
2221 | </column> | |
89365653 BP |
2222 | </table> |
2223 | ||
2224 | <table name="sFlow"> | |
2225 | <p>An sFlow(R) target. sFlow is a protocol for remote monitoring | |
2226 | of switches.</p> | |
2227 | ||
2228 | <column name="agent"> | |
e723ff43 BP |
2229 | Name of the network device whose IP address should be reported as the |
2230 | ``agent address'' to collectors. If not specified, the IP address | |
2231 | defaults to the <ref table="Controller" column="local_ip"/> in the | |
2232 | collector's <ref table="Controller"/>. If an agent IP address cannot be | |
2233 | determined either way, sFlow is disabled. | |
89365653 BP |
2234 | </column> |
2235 | ||
2236 | <column name="header"> | |
2237 | Number of bytes of a sampled packet to send to the collector. | |
2238 | If not specified, the default is 128 bytes. | |
2239 | </column> | |
2240 | ||
2241 | <column name="polling"> | |
2242 | Polling rate in seconds to send port statistics to the collector. | |
2243 | If not specified, defaults to 30 seconds. | |
2244 | </column> | |
2245 | ||
2246 | <column name="sampling"> | |
2247 | Rate at which packets should be sampled and sent to the collector. | |
2248 | If not specified, defaults to 400, which means one out of 400 | |
2249 | packets, on average, will be sent to the collector. | |
2250 | </column> | |
2251 | ||
2252 | <column name="targets"> | |
2253 | sFlow targets in the form | |
2254 | <code><var>ip</var>:<var>port</var></code>. | |
2255 | </column> | |
13008eb3 BP |
2256 | |
2257 | <column name="external_ids"> | |
2258 | Key-value pairs for use by external frameworks that integrate with Open | |
2259 | vSwitch, rather than by Open vSwitch itself. System integrators should | |
2260 | either use the Open vSwitch development mailing list to coordinate on | |
2261 | common key-value definitions, or choose key names that are likely to be | |
2262 | unique. No common key-value pairs are currently defined. | |
2263 | </column> | |
89365653 | 2264 | </table> |
c1c9c9c4 BP |
2265 | |
2266 | <table name="Capability"> | |
2267 | <p>Records in this table describe functionality supported by the hardware | |
2268 | and software platform on which this Open vSwitch is based. Clients | |
2269 | should not modify this table.</p> | |
2270 | ||
2271 | <p>A record in this table is meaningful only if it is referenced by the | |
2272 | <ref table="Open_vSwitch" column="capabilities"/> column in the | |
2273 | <ref table="Open_vSwitch"/> table. The key used to reference it, called | |
2274 | the record's ``category,'' determines the meanings of the | |
2275 | <ref column="details"/> column. The following general forms of | |
2276 | categories are currently defined:</p> | |
2277 | ||
2278 | <dl> | |
2279 | <dt><code>qos-<var>type</var></code></dt> | |
2280 | <dd><var>type</var> is supported as the value for | |
2281 | <ref column="type" table="QoS"/> in the <ref table="QoS"/> table. | |
2282 | </dd> | |
2283 | </dl> | |
2284 | ||
2285 | <column name="details"> | |
2286 | <p>Key-value pairs that describe capabilities. The meaning of the pairs | |
2287 | depends on the category key that the <ref table="Open_vSwitch" | |
2288 | column="capabilities"/> column in the <ref table="Open_vSwitch"/> table | |
2289 | uses to reference this record, as described above.</p> | |
2290 | ||
2291 | <p>The presence of a record for category <code>qos-<var>type</var></code> | |
2292 | indicates that the switch supports <var>type</var> as the value of | |
2293 | the <ref table="QoS" column="type"/> column in the <ref table="QoS"/> | |
2294 | table. The following key-value pairs are defined to further describe | |
2295 | QoS capabilities:</p> | |
2296 | ||
2297 | <dl> | |
2298 | <dt><code>n-queues</code></dt> | |
2299 | <dd>Number of supported queues, as a positive integer. Keys in the | |
2300 | <ref table="QoS" column="queues"/> column for <ref table="QoS"/> | |
2301 | records whose <ref table="QoS" column="type"/> value | |
2302 | equals <var>type</var> must range between 0 and this value minus one, | |
2303 | inclusive.</dd> | |
2304 | </dl> | |
2305 | </column> | |
2306 | </table> | |
89365653 | 2307 | </database> |