]>
Commit | Line | Data |
---|---|---|
89365653 BP |
1 | <database title="Open vSwitch Configuration Database"> |
2 | <p>A database with this schema holds the configuration for one Open | |
3 | vSwitch daemon. The root of the configuration for the daemon is | |
4 | the <ref table="Open_vSwitch"/> table, which must have exactly one | |
5 | record. Records in other tables are significant only when they | |
6 | can be reached directly or indirectly from the | |
7 | <ref table="Open_vSwitch"/> table.</p> | |
8 | ||
9 | <table name="Open_vSwitch" title="Open vSwitch configuration."> | |
10 | Configuration for an Open vSwitch daemon. There must be exactly one record | |
11 | in the <ref table="Open_vSwitch"/> table. | |
12 | ||
13 | <group title="Configuration"> | |
14 | <column name="bridges"> | |
15 | Set of bridges managed by the daemon. | |
16 | </column> | |
17 | ||
89365653 BP |
18 | <column name="managers"> |
19 | Remote database clients to which the Open vSwitch's database server | |
20 | should connect or to which it should listen. | |
21 | </column> | |
22 | ||
23 | <column name="ssl"> | |
24 | SSL used globally by the daemon. | |
25 | </column> | |
f5e7ed5d JP |
26 | |
27 | <column name="external_ids"> | |
0e869da1 BP |
28 | Key-value pairs for use by external frameworks that integrate |
29 | with Open vSwitch, rather than by Open vSwitch itself. System | |
30 | integrators should either use the Open vSwitch development | |
31 | mailing list to coordinate on common key-value definitions, or | |
32 | choose key names that are likely to be unique. The currently | |
33 | defined common key-value pairs are: | |
f5e7ed5d JP |
34 | <dl> |
35 | <dt><code>system-uuid</code></dt> | |
36 | <dd>A universally unique identifier for the Open vSwitch's | |
37 | physical host. The form of the identifier depends on the | |
38 | type of the host. On a Citrix XenServer, this is the host | |
39 | UUID displayed by, e.g., <code>xe host-list</code>.</dd> | |
40 | </dl> | |
41 | </column> | |
89365653 BP |
42 | </group> |
43 | ||
44 | <group title="Status"> | |
45 | <column name="next_cfg"> | |
46 | Sequence number for client to increment. When a client modifies | |
47 | any part of the database configuration and wishes to wait for | |
48 | Open vSwitch to finish applying the changes, it may increment | |
49 | this sequence number. | |
50 | </column> | |
51 | ||
52 | <column name="cur_cfg"> | |
53 | Sequence number that Open vSwitch sets to the current value of | |
2e57b537 | 54 | <ref column="next_cfg"/> after it finishes applying a set of |
89365653 BP |
55 | configuration changes. |
56 | </column> | |
c1c9c9c4 BP |
57 | |
58 | <column name="capabilities"> | |
59 | Describes functionality supported by the hardware and software platform | |
60 | on which this Open vSwitch is based. Clients should not modify this | |
61 | column. See the <ref table="Capability"/> description for defined | |
62 | capability categories and the meaning of associated | |
63 | <ref table="Capability"/> records. | |
64 | </column> | |
018f1525 BP |
65 | |
66 | <column name="statistics"> | |
67 | <p> | |
68 | Key-value pairs that report statistics about a running Open_vSwitch | |
69 | daemon. The current implementation updates these counters | |
70 | periodically. In the future, we plan to, instead, update them only | |
71 | when they are queried (e.g. using an OVSDB <code>select</code> | |
72 | operation) and perhaps at other times, but not on any regular | |
73 | periodic basis.</p> | |
74 | <p> | |
75 | The currently defined key-value pairs are listed below. Some Open | |
76 | vSwitch implementations may not support some statistics, in which | |
77 | case those key-value pairs are omitted.</p> | |
78 | <dl> | |
79 | <dt><code>load-average</code></dt> | |
80 | <dd> | |
81 | System load average multiplied by 100 and rounded to the nearest | |
82 | integer.</dd> | |
83 | </dl> | |
84 | </column> | |
89365653 BP |
85 | </group> |
86 | </table> | |
87 | ||
88 | <table name="Bridge"> | |
89 | <p> | |
90 | Configuration for a bridge within an | |
91 | <ref table="Open_vSwitch"/>. | |
92 | </p> | |
93 | <p> | |
94 | A <ref table="Bridge"/> record represents an Ethernet switch with one or | |
95 | more ``ports,'' which are the <ref table="Port"/> records pointed to by | |
96 | the <ref table="Bridge"/>'s <ref column="ports"/> column. | |
97 | </p> | |
98 | ||
99 | <group title="Core Features"> | |
100 | <column name="name"> | |
101 | Bridge identifier. Should be alphanumeric and no more than about 8 | |
102 | bytes long. Must be unique among the names of ports, interfaces, and | |
103 | bridges on a host. | |
104 | </column> | |
105 | ||
106 | <column name="ports"> | |
107 | Ports included in the bridge. | |
108 | </column> | |
109 | ||
110 | <column name="mirrors"> | |
111 | Port mirroring configuration. | |
112 | </column> | |
113 | ||
114 | <column name="netflow"> | |
115 | NetFlow configuration. | |
116 | </column> | |
117 | ||
118 | <column name="sflow"> | |
119 | sFlow configuration. | |
120 | </column> | |
121 | ||
122 | <column name="flood_vlans"> | |
123 | VLAN IDs of VLANs on which MAC address learning should be disabled, so | |
124 | that packets are flooded instead of being sent to specific ports that | |
125 | are believed to contain packets' destination MACs. This should | |
126 | ordinarily be used to disable MAC learning on VLANs used for mirroring | |
127 | (RSPAN VLANs). It may also be useful for debugging. | |
128 | </column> | |
129 | </group> | |
130 | ||
131 | <group title="OpenFlow Configuration"> | |
132 | <column name="controller"> | |
1a048029 JP |
133 | OpenFlow controller set. If unset, then no OpenFlow controllers |
134 | will be used. | |
89365653 BP |
135 | </column> |
136 | ||
31681a5d JP |
137 | <column name="fail_mode"> |
138 | <p>When a controller is configured, it is, ordinarily, responsible | |
139 | for setting up all flows on the switch. Thus, if the connection to | |
140 | the controller fails, no new network connections can be set up. | |
141 | If the connection to the controller stays down long enough, | |
142 | no packets can pass through the switch at all. This setting | |
143 | determines the switch's response to such a situation. It may be set | |
144 | to one of the following: | |
145 | <dl> | |
146 | <dt><code>standalone</code></dt> | |
147 | <dd>If no message is received from the controller for three | |
148 | times the inactivity probe interval | |
149 | (see <ref column="inactivity_probe"/>), then Open vSwitch | |
150 | will take over responsibility for setting up flows. In | |
151 | this mode, Open vSwitch causes the bridge to act like an | |
152 | ordinary MAC-learning switch. Open vSwitch will continue | |
153 | to retry connecting to the controller in the background | |
154 | and, when the connection succeeds, it will discontinue its | |
155 | standalone behavior.</dd> | |
156 | <dt><code>secure</code></dt> | |
157 | <dd>Open vSwitch will not set up flows on its own when the | |
abdfe474 JP |
158 | controller connection fails or when no controllers are |
159 | defined. The bridge will continue to retry connecting to | |
160 | any defined controllers forever.</dd> | |
31681a5d JP |
161 | </dl> |
162 | </p> | |
163 | <p>If this value is unset, the default is implementation-specific.</p> | |
164 | <p>When more than one controller is configured, | |
165 | <ref column="fail_mode"/> is considered only when none of the | |
166 | configured controllers can be contacted.</p> | |
167 | </column> | |
168 | ||
89365653 | 169 | <column name="datapath_id"> |
78c54bde BP |
170 | Reports the OpenFlow datapath ID in use. Exactly 16 hex |
171 | digits. (Setting this column will have no useful effect. Set | |
172 | <ref column="other_config"/>:<code>other-config</code> | |
173 | instead.) | |
89365653 BP |
174 | </column> |
175 | </group> | |
176 | ||
177 | <group title="Other Features"> | |
178 | <column name="datapath_type"> | |
179 | Name of datapath provider. The kernel datapath has | |
180 | type <code>system</code>. The userspace datapath has | |
181 | type <code>netdev</code>. | |
182 | </column> | |
183 | ||
184 | <column name="external_ids"> | |
0e869da1 BP |
185 | Key-value pairs for use by external frameworks that integrate |
186 | with Open vSwitch, rather than by Open vSwitch itself. System | |
187 | integrators should either use the Open vSwitch development | |
188 | mailing list to coordinate on common key-value definitions, or | |
189 | choose key names that are likely to be unique. The currently | |
190 | defined common key-value pairs are: | |
89365653 | 191 | <dl> |
5c43922c | 192 | <dt><code>network-uuids</code></dt> |
9b180fbb BP |
193 | <dd>Semicolon-delimited set of universally unique identifier(s) for |
194 | the network with which this bridge is associated. The form of the | |
5c43922c BP |
195 | identifier(s) depends on the type of the host. On a Citrix |
196 | XenServer host, the network identifiers are RFC 4122 UUIDs as | |
197 | displayed by, e.g., <code>xe network-list</code>.</dd> | |
89365653 BP |
198 | </dl> |
199 | </column> | |
200 | ||
201 | <column name="other_config"> | |
202 | Key-value pairs for configuring rarely used bridge | |
203 | features. The currently defined key-value pairs are: | |
204 | <dl> | |
205 | <dt><code>datapath-id</code></dt> | |
2e57b537 | 206 | <dd>Exactly 16 hex |
89365653 BP |
207 | digits to set the OpenFlow datapath ID to a specific |
208 | value.</dd> | |
209 | <dt><code>hwaddr</code></dt> | |
2e57b537 | 210 | <dd>An Ethernet address in the form |
89365653 BP |
211 | <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var> |
212 | to set the hardware address of the local port and influence the | |
213 | datapath ID.</dd> | |
214 | </dl> | |
215 | </column> | |
216 | </group> | |
217 | </table> | |
218 | ||
219 | <table name="Port" table="Port or bond configuration."> | |
220 | <p>A port within a <ref table="Bridge"/>.</p> | |
221 | <p>Most commonly, a port has exactly one ``interface,'' pointed to by its | |
2e57b537 | 222 | <ref column="interfaces"/> column. Such a port logically |
89365653 BP |
223 | corresponds to a port on a physical Ethernet switch. A port |
224 | with more than one interface is a ``bonded port'' (see | |
225 | <ref group="Bonding Configuration"/>).</p> | |
226 | <p>Some properties that one might think as belonging to a port are actually | |
227 | part of the port's <ref table="Interface"/> members.</p> | |
228 | ||
229 | <column name="name"> | |
230 | Port name. Should be alphanumeric and no more than about 8 | |
231 | bytes long. May be the same as the interface name, for | |
232 | non-bonded ports. Must otherwise be unique among the names of | |
233 | ports, interfaces, and bridges on a host. | |
234 | </column> | |
235 | ||
236 | <column name="interfaces"> | |
237 | The port's interfaces. If there is more than one, this is a | |
238 | bonded Port. | |
239 | </column> | |
240 | ||
241 | <group title="VLAN Configuration"> | |
242 | <p>A bridge port must be configured for VLANs in one of two | |
243 | mutually exclusive ways: | |
244 | <ul> | |
7894d33b BP |
245 | <li>A ``trunk port'' has an empty value for <ref |
246 | column="tag"/>. Its <ref column="trunks"/> value may be | |
247 | empty or non-empty.</li> | |
89365653 | 248 | <li>An ``implicitly tagged VLAN port'' or ``access port'' |
7894d33b BP |
249 | has an nonempty value for <ref column="tag"/>. Its |
250 | <ref column="trunks"/> value must be empty.</li> | |
89365653 BP |
251 | </ul> |
252 | If <ref column="trunks"/> and <ref column="tag"/> are both | |
253 | nonempty, the configuration is ill-formed. | |
254 | </p> | |
255 | ||
256 | <column name="tag"> | |
7894d33b BP |
257 | <p> |
258 | If this is an access port (see above), the port's implicitly | |
259 | tagged VLAN. Must be empty if this is a trunk port. | |
260 | </p> | |
261 | <p> | |
262 | Frames arriving on trunk ports will be forwarded to this | |
263 | port only if they are tagged with the given VLAN (or, if | |
264 | <ref column="tag"/> is 0, then if they lack a VLAN header). | |
265 | Frames arriving on other access ports will be forwarded to | |
266 | this port only if they have the same <ref column="tag"/> | |
267 | value. Frames forwarded to this port will not have an | |
268 | 802.1Q header. | |
269 | </p> | |
270 | <p> | |
271 | When a frame with a 802.1Q header that indicates a nonzero | |
272 | VLAN is received on an access port, it is discarded. | |
273 | </p> | |
89365653 BP |
274 | </column> |
275 | ||
276 | <column name="trunks"> | |
7894d33b BP |
277 | <p> |
278 | If this is a trunk port (see above), the 802.1Q VLAN(s) that | |
279 | this port trunks; if it is empty, then the port trunks all | |
280 | VLANs. Must be empty if this is an access port. | |
281 | </p> | |
282 | <p> | |
283 | Frames arriving on trunk ports are dropped if they are not | |
284 | in one of the specified VLANs. For this purpose, packets | |
285 | that have no VLAN header are treated as part of VLAN 0. | |
286 | </p> | |
89365653 BP |
287 | </column> |
288 | </group> | |
289 | ||
290 | <group title="Bonding Configuration"> | |
291 | <p>A port that has more than one interface is a ``bonded port.'' | |
292 | Bonding allows for load balancing and fail-over. Open vSwitch | |
293 | supports ``source load balancing'' (SLB) bonding, which | |
294 | assigns flows to slaves based on source MAC address, with | |
295 | periodic rebalancing as traffic patterns change. This form of | |
296 | bonding does not require 802.3ad or other special support from | |
297 | the upstream switch to which the slave devices are | |
298 | connected.</p> | |
299 | ||
300 | <p>These columns apply only to bonded ports. Their values are | |
301 | otherwise ignored.</p> | |
302 | ||
303 | <column name="bond_updelay"> | |
304 | <p>For a bonded port, the number of milliseconds for which carrier must | |
305 | stay up on an interface before the interface is considered to be up. | |
306 | Specify <code>0</code> to enable the interface immediately.</p> | |
307 | <p>This setting is honored only when at least one bonded interface is | |
308 | already enabled. When no interfaces are enabled, then the first bond | |
309 | interface to come up is enabled immediately.</p> | |
310 | </column> | |
311 | ||
312 | <column name="bond_downdelay"> | |
313 | For a bonded port, the number of milliseconds for which carrier must | |
314 | stay down on an interface before the interface is considered to be | |
2e57b537 | 315 | down. Specify <code>0</code> to disable the interface immediately. |
89365653 BP |
316 | </column> |
317 | ||
318 | <column name="bond_fake_iface"> | |
2e57b537 BP |
319 | For a bonded port, whether to create a fake internal interface with the |
320 | name of the port. Use only for compatibility with legacy software that | |
89365653 BP |
321 | requires this. |
322 | </column> | |
323 | </group> | |
324 | ||
325 | <group title="Other Features"> | |
c1c9c9c4 BP |
326 | <column name="qos"> |
327 | Quality of Service configuration for this port. | |
328 | </column> | |
329 | ||
89365653 BP |
330 | <column name="mac"> |
331 | The MAC address to use for this port for the purpose of choosing the | |
332 | bridge's MAC address. This column does not necessarily reflect the | |
333 | port's actual MAC address, nor will setting it change the port's actual | |
334 | MAC address. | |
335 | </column> | |
336 | ||
337 | <column name="fake_bridge"> | |
338 | Does this port represent a sub-bridge for its tagged VLAN within the | |
339 | Bridge? See ovs-vsctl(8) for more information. | |
340 | </column> | |
341 | ||
342 | <column name="external_ids"> | |
0e869da1 BP |
343 | <p> |
344 | Key-value pairs for use by external frameworks that integrate with | |
345 | Open vSwitch, rather than by Open vSwitch itself. System integrators | |
346 | should either use the Open vSwitch development mailing list to | |
347 | coordinate on common key-value definitions, or choose key names that | |
348 | are likely to be unique. | |
349 | </p> | |
350 | <p> | |
351 | No key-value pairs native to <ref table="Port"/> are currently | |
352 | defined. For fake bridges (see the <ref column="fake_bridge"/> | |
353 | column), external IDs for the fake bridge are defined here by | |
354 | prefixing a <ref table="Bridge"/> <ref table="Bridge" | |
355 | column="external_ids"/> key with <code>fake-bridge-</code>, | |
356 | e.g. <code>fake-bridge-network-uuids</code>. | |
357 | </p> | |
89365653 BP |
358 | </column> |
359 | ||
360 | <column name="other_config"> | |
361 | Key-value pairs for configuring rarely used port features. The | |
362 | currently defined key-value pairs are: | |
363 | <dl> | |
364 | <dt><code>hwaddr</code></dt> | |
2e57b537 | 365 | <dd>An Ethernet address in the form |
89365653 | 366 | <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd> |
c8143c88 BP |
367 | <dt><code>bond-rebalance-interval</code></dt> |
368 | <dd>For a bonded port, the number of milliseconds between | |
369 | successive attempts to rebalance the bond, that is, to | |
370 | move source MACs and their flows from one interface on | |
371 | the bond to another in an attempt to keep usage of each | |
372 | interface roughly equal. The default is 10000 (10 | |
373 | seconds), and the minimum is 1000 (1 second).</dd> | |
89365653 BP |
374 | </dl> |
375 | </column> | |
376 | </group> | |
377 | </table> | |
378 | ||
379 | <table name="Interface" title="One physical network device in a Port."> | |
380 | An interface within a <ref table="Port"/>. | |
381 | ||
382 | <group title="Core Features"> | |
383 | <column name="name"> | |
384 | Interface name. Should be alphanumeric and no more than about 8 bytes | |
385 | long. May be the same as the port name, for non-bonded ports. Must | |
386 | otherwise be unique among the names of ports, interfaces, and bridges | |
387 | on a host. | |
388 | </column> | |
389 | ||
390 | <column name="mac"> | |
391 | <p>Ethernet address to set for this interface. If unset then the | |
392 | default MAC address is used:</p> | |
393 | <ul> | |
394 | <li>For the local interface, the default is the lowest-numbered MAC | |
395 | address among the other bridge ports, either the value of the | |
396 | <ref table="Port" column="mac"/> in its <ref table="Port"/> record, | |
397 | if set, or its actual MAC (for bonded ports, the MAC of its slave | |
398 | whose name is first in alphabetical order). Internal ports and | |
399 | bridge ports that are used as port mirroring destinations (see the | |
400 | <ref table="Mirror"/> table) are ignored.</li> | |
2e57b537 | 401 | <li>For other internal interfaces, the default MAC is randomly |
89365653 BP |
402 | generated.</li> |
403 | <li>External interfaces typically have a MAC address associated with | |
404 | their hardware.</li> | |
405 | </ul> | |
406 | <p>Some interfaces may not have a software-controllable MAC | |
407 | address.</p> | |
408 | </column> | |
409 | ||
410 | <column name="ofport"> | |
411 | <p>OpenFlow port number for this interface. Unlike most columns, this | |
412 | column's value should be set only by Open vSwitch itself. Other | |
413 | clients should set this column to an empty set (the default) when | |
414 | creating an <ref table="Interface"/>.</p> | |
415 | <p>Open vSwitch populates this column when the port number becomes | |
416 | known. If the interface is successfully added, | |
417 | <ref column="ofport"/> will be set to a number between 1 and 65535 | |
2e57b537 BP |
418 | (generally either in the range 1 to 65280, exclusive, or 65534, the |
419 | port number for the OpenFlow ``local port''). If the interface | |
420 | cannot be added then Open vSwitch sets this column | |
421 | to -1.</p> | |
89365653 BP |
422 | </column> |
423 | </group> | |
424 | ||
425 | <group title="System-Specific Details"> | |
426 | <column name="type"> | |
427 | The interface type, one of: | |
428 | <dl> | |
429 | <dt><code>system</code></dt> | |
430 | <dd>An ordinary network device, e.g. <code>eth0</code> on Linux. | |
431 | Sometimes referred to as ``external interfaces'' since they are | |
432 | generally connected to hardware external to that on which the Open | |
433 | vSwitch is running. The empty string is a synonym for | |
434 | <code>system</code>.</dd> | |
435 | <dt><code>internal</code></dt> | |
2e57b537 | 436 | <dd>A simulated network device that sends and receives traffic. An |
89365653 BP |
437 | internal interface whose <ref column="name"/> is the same as its |
438 | bridge's <ref table="Open_vSwitch" column="name"/> is called the | |
439 | ``local interface.'' It does not make sense to bond an internal | |
440 | interface, so the terms ``port'' and ``interface'' are often used | |
441 | imprecisely for internal interfaces.</dd> | |
442 | <dt><code>tap</code></dt> | |
443 | <dd>A TUN/TAP device managed by Open vSwitch.</dd> | |
444 | <dt><code>gre</code></dt> | |
88720519 JG |
445 | <dd>An Ethernet over RFC 1702 Generic Routing Encapsulation over IPv4 |
446 | tunnel. Each tunnel must be uniquely identified by the | |
447 | combination of <code>remote_ip</code>, <code>local_ip</code>, and | |
448 | <code>in_key</code>. Note that if two ports are defined that are | |
449 | the same except one has an optional identifier and the other does | |
450 | not, the more specific one is matched first. <code>in_key</code> | |
451 | is considered more specific than <code>local_ip</code> if a port | |
452 | defines one and another port defines the other. The arguments | |
453 | are: | |
454 | <dl> | |
455 | <dt><code>remote_ip</code></dt> | |
456 | <dd>Required. The tunnel endpoint.</dd> | |
457 | </dl> | |
458 | <dl> | |
459 | <dt><code>local_ip</code></dt> | |
460 | <dd>Optional. The destination IP that received packets must | |
461 | match. Default is to match all addresses.</dd> | |
462 | </dl> | |
463 | <dl> | |
464 | <dt><code>in_key</code></dt> | |
465 | <dd>Optional. The GRE key that received packets must contain. | |
466 | It may either be a 32-bit number (no key and a key of 0 are | |
467 | treated as equivalent) or the word <code>flow</code>. If | |
468 | <code>flow</code> is specified then any key will be accepted | |
469 | and the key will be placed in the <code>tun_id</code> field | |
470 | for matching in the flow table. The ovs-ofctl manual page | |
471 | contains additional information about matching fields in | |
472 | OpenFlow flows. Default is no key.</dd> | |
473 | </dl> | |
474 | <dl> | |
475 | <dt><code>out_key</code></dt> | |
476 | <dd>Optional. The GRE key to be set on outgoing packets. It may | |
477 | either be a 32-bit number or the word <code>flow</code>. If | |
478 | <code>flow</code> is specified then the key may be set using | |
479 | the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0 | |
480 | is used in the absense of an action). The ovs-ofctl manual | |
481 | page contains additional information about the Nicira OpenFlow | |
482 | vendor extensions. Default is no key.</dd> | |
483 | </dl> | |
484 | <dl> | |
485 | <dt><code>key</code></dt> | |
486 | <dd>Optional. Shorthand to set <code>in_key</code> and | |
487 | <code>out_key</code> at the same time.</dd> | |
488 | </dl> | |
489 | <dl> | |
490 | <dt><code>tos</code></dt> | |
491 | <dd>Optional. The value of the ToS bits to be set on the | |
492 | encapsulating packet. It may also be the word | |
493 | <code>inherit</code>, in which case the ToS will be copied from | |
494 | the inner packet if it is IPv4 or IPv6 (otherwise it will be | |
495 | 0). Note that the ECN fields are always inherited. Default is | |
496 | 0.</dd> | |
497 | </dl> | |
498 | <dl> | |
499 | <dt><code>ttl</code></dt> | |
500 | <dd>Optional. The TTL to be set on the encapsulating packet. | |
501 | It may also be the word <code>inherit</code>, in which case the | |
502 | TTL will be copied from the inner packet if it is IPv4 or IPv6 | |
503 | (otherwise it will be the system default, typically 64). | |
504 | Default is the system default TTL.</dd> | |
505 | </dl> | |
506 | <dl> | |
507 | <dt><code>csum</code></dt> | |
508 | <dd>Optional. Compute GRE checksums for outgoing packets and | |
509 | require checksums for incoming packets. Default is enabled, | |
510 | set to <code>false</code> to disable.</dd> | |
511 | </dl> | |
512 | <dl> | |
513 | <dt><code>pmtud</code></dt> | |
514 | <dd>Optional. Enable tunnel path MTU discovery. If enabled | |
515 | ``ICMP destination unreachable - fragmentation'' needed | |
516 | messages will be generated for IPv4 packets with the DF bit set | |
517 | and IPv6 packets above the minimum MTU if the packet size | |
518 | exceeds the path MTU minus the size of the tunnel headers. It | |
519 | also forces the encapsulating packet DF bit to be set (it is | |
520 | always set if the inner packet implies path MTU discovery). | |
521 | Note that this option causes behavior that is typically | |
522 | reserved for routers and therefore is not entirely in | |
523 | compliance with the IEEE 802.1D specification for bridges. | |
524 | Default is enabled, set to <code>false</code> to disable.</dd> | |
525 | </dl> | |
526 | </dd> | |
8aed4223 JP |
527 | <dt><code>patch</code></dt> |
528 | <dd>A pair of virtual devices that act as a patch cable. A | |
529 | <code>peer</code> argument is required that indicates the name | |
530 | of the other side of the patch. Since a patch must work in | |
531 | pairs, a second patch interface must be declared with the | |
532 | <code>name</code> and <code>peer</code> arguments reversed.</dd> | |
89365653 BP |
533 | </dl> |
534 | </column> | |
535 | ||
536 | <column name="options"> | |
537 | Configuration options whose interpretation varies based on | |
538 | <ref column="type"/>. | |
539 | </column> | |
540 | </group> | |
541 | ||
542 | <group title="Ingress Policing"> | |
543 | <column name="ingress_policing_burst"> | |
544 | <p>Maximum burst size for data received on this interface, in kb. The | |
545 | default burst size if set to <code>0</code> is 1000 kb. This value | |
546 | has no effect if <ref column="ingress_policing_rate"/> | |
547 | is <code>0</code>.</p> | |
548 | <p>The burst size should be at least the size of the interface's | |
549 | MTU.</p> | |
550 | </column> | |
551 | ||
552 | <column name="ingress_policing_rate"> | |
553 | <p>Maximum rate for data received on this interface, in kbps. Data | |
554 | received faster than this rate is dropped. Set to <code>0</code> to | |
555 | disable policing.</p> | |
556 | <p>The meaning of ``ingress'' is from Open vSwitch's perspective. If | |
557 | configured on a physical interface, then it limits the rate at which | |
558 | traffic is allowed into the system from the outside. If configured | |
559 | on a virtual interface that is connected to a virtual machine, then | |
560 | it limits the rate at which the guest is able to transmit.</p> | |
561 | </column> | |
562 | </group> | |
563 | ||
564 | <group title="Other Features"> | |
565 | <column name="external_ids"> | |
0e869da1 BP |
566 | <p> |
567 | Key-value pairs for use by external frameworks that integrate | |
568 | with Open vSwitch, rather than by Open vSwitch itself. System | |
569 | integrators should either use the Open vSwitch development | |
570 | mailing list to coordinate on common key-value definitions, or | |
571 | choose key names that are likely to be unique. | |
572 | </p> | |
573 | <p> | |
574 | All of the currently defined key-value pairs specifically | |
c0f9490c BP |
575 | apply to an interface that represents a virtual Ethernet interface |
576 | connected to a virtual machine. These key-value pairs should not be | |
577 | present for other types of interfaces. Keys whose names end | |
578 | in <code>-uuid</code> have values that uniquely identify the entity | |
579 | in question. For a Citrix XenServer hypervisor, these values are | |
580 | UUIDs in RFC 4122 format. Other hypervisors may use other | |
0e869da1 BP |
581 | formats. |
582 | </p> | |
c0f9490c | 583 | <p>The currently defined key-value pairs are:</p> |
89365653 | 584 | <dl> |
c0f9490c BP |
585 | <dt><code>vif-uuid</code></dt> |
586 | <dd>The virtual interface associated with this interface.</dd> | |
587 | <dt><code>network-uuid</code></dt> | |
588 | <dd>The virtual network to which this interface is attached.</dd> | |
589 | <dt><code>vm-uuid</code></dt> | |
590 | <dd>The VM to which this interface belongs.</dd> | |
591 | <dt><code>vif-mac</code></dt> | |
592 | <dd>The MAC address programmed into the "virtual hardware" for this | |
593 | interface, in the | |
594 | form <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>. | |
595 | For Citrix XenServer, this is the value of the <code>MAC</code> | |
596 | field in the VIF record for this interface.</dd> | |
89365653 BP |
597 | </dl> |
598 | </column> | |
018f1525 BP |
599 | |
600 | <column name="statistics"> | |
601 | <p> | |
602 | Key-value pairs that report interface statistics. The current | |
603 | implementation updates these counters periodically. In the future, | |
604 | we plan to, instead, update them when an interface is created, when | |
605 | they are queried (e.g. using an OVSDB <code>select</code> operation), | |
606 | and just before an interface is deleted due to virtual interface | |
607 | hot-unplug or VM shutdown, and perhaps at other times, but not on any | |
608 | regular periodic basis.</p> | |
609 | <p> | |
610 | The currently defined key-value pairs are listed below. These are | |
611 | the same statistics reported by OpenFlow in its <code>struct | |
612 | ofp_port_stats</code> structure. If an interface does not support a | |
613 | given statistic, then that pair is omitted.</p> | |
614 | <ul> | |
615 | <li> | |
616 | Successful transmit and receive counters: | |
617 | <dl> | |
618 | <dt><code>rx_packets</code></dt> | |
619 | <dd>Number of received packets.</dd> | |
620 | <dt><code>rx_bytes</code></dt> | |
621 | <dd>Number of received bytes.</dd> | |
622 | <dt><code>tx_packets</code></dt> | |
623 | <dd>Number of transmitted packets.</dd> | |
624 | <dt><code>tx_bytes</code></dt> | |
625 | <dd>Number of transmitted bytes.</dd> | |
626 | </dl> | |
627 | </li> | |
628 | <li> | |
629 | Receive errors: | |
630 | <dl> | |
631 | <dt><code>rx_dropped</code></dt> | |
632 | <dd>Number of packets dropped by RX.</dd> | |
633 | <dt><code>rx_frame_err</code></dt> | |
634 | <dd>Number of frame alignment errors.</dd> | |
635 | <dt><code>rx_over_err</code></dt> | |
636 | <dd>Number of packets with RX overrun.</dd> | |
637 | <dt><code>rx_crc_err</code></dt> | |
638 | <dd>Number of CRC errors.</dd> | |
639 | <dt><code>rx_errors</code></dt> | |
640 | <dd> | |
641 | Total number of receive errors, greater than or equal | |
642 | to the sum of the above. | |
643 | </dd> | |
644 | </dl> | |
645 | </li> | |
646 | <li> | |
647 | Transmit errors: | |
648 | <dl> | |
649 | <dt><code>tx_dropped</code></dt> | |
650 | <dd>Number of packets dropped by TX.</dd> | |
651 | <dt><code>collisions</code></dt> | |
652 | <dd>Number of collisions.</dd> | |
653 | <dt><code>tx_errors</code></dt> | |
654 | <dd> | |
655 | Total number of transmit errors, greater | |
656 | than or equal to the sum of the above. | |
657 | </dd> | |
658 | </dl> | |
659 | </li> | |
660 | </ul> | |
661 | </column> | |
89365653 BP |
662 | </group> |
663 | </table> | |
664 | ||
c1c9c9c4 BP |
665 | <table name="QoS" title="Quality of Service configuration"> |
666 | <p>Quality of Service (QoS) configuration for each Port that | |
667 | references it.</p> | |
668 | ||
669 | <column name="type"> | |
670 | <p>The type of QoS to implement. The <ref table="Open_vSwitch" | |
671 | column="capabilities"/> column in the <ref table="Open_vSwitch"/> table | |
672 | identifies the types that a switch actually supports. The currently | |
673 | defined types are listed below:</p> | |
674 | <dl> | |
675 | <dt><code>linux-htb</code></dt> | |
676 | <dd>Linux ``hierarchy token bucket'' classifier.</dd> | |
677 | </dl> | |
678 | </column> | |
679 | ||
680 | <column name="queues"> | |
681 | <p>A map from queue numbers to <ref table="Queue"/> records. The | |
682 | supported range of queue numbers depend on <ref column="type"/>. The | |
683 | queue numbers are the same as the <code>queue_id</code> used in | |
684 | OpenFlow in <code>struct ofp_action_enqueue</code> and other | |
685 | structures. Queue 0 is used by OpenFlow output actions that do not | |
686 | specify a specific queue.</p> | |
687 | </column> | |
688 | ||
689 | <column name="other_config"> | |
690 | <p>Key-value pairs for configuring QoS features that depend on | |
691 | <ref column="type"/>.</p> | |
692 | <p>The <code>linux-htb</code> class supports the following key-value | |
693 | pairs:</p> | |
694 | <dl> | |
695 | <dt><code>max-rate</code></dt> | |
696 | <dd>Maximum rate shared by all queued traffic, in bit/s. | |
697 | Optional. If not specified, for physical interfaces, the | |
698 | default is the link rate. For other interfaces or if the | |
699 | link rate cannot be determined, the default is currently 100 | |
700 | Mbps.</dd> | |
701 | </dl> | |
702 | </column> | |
703 | </table> | |
704 | ||
705 | <table name="Queue" title="QoS output queue."> | |
706 | <p>A configuration for a port output queue, used in configuring Quality of | |
707 | Service (QoS) features. May be referenced by <ref column="queues" | |
708 | table="QoS"/> column in <ref table="QoS"/> table.</p> | |
709 | ||
710 | <column name="other_config"> | |
711 | <p>Key-value pairs for configuring the output queue. The supported | |
712 | key-value pairs and their meanings depend on the <ref column="type"/> | |
713 | of the <ref column="QoS"/> records that reference this row.</p> | |
714 | <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS" | |
715 | column="type"/> of <code>min-rate</code> are:</p> | |
716 | <dl> | |
717 | <dt><code>min-rate</code></dt> | |
718 | <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd> | |
719 | </dl> | |
720 | <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS" | |
721 | column="type"/> of <code>linux-htb</code> are:</p> | |
722 | <dl> | |
723 | <dt><code>min-rate</code></dt> | |
724 | <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd> | |
725 | <dt><code>max-rate</code></dt> | |
726 | <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the | |
727 | queue's rate will not be allowed to exceed the specified value, even | |
728 | if excess bandwidth is available. If unspecified, defaults to no | |
729 | limit.</dd> | |
730 | <dt><code>burst</code></dt> | |
731 | <dd>Burst size, in bits. This is the maximum amount of ``credits'' | |
732 | that a queue can accumulate while it is idle. Optional. Details of | |
733 | the <code>linux-htb</code> implementation require a minimum burst | |
734 | size, so a too-small <code>burst</code> will be silently | |
735 | ignored.</dd> | |
736 | <dt><code>priority</code></dt> | |
737 | <dd>A nonnegative 32-bit integer. Defaults to 0 if | |
738 | unspecified. A queue with a smaller <code>priority</code> | |
739 | will receive all the excess bandwidth that it can use before | |
740 | a queue with a larger value receives any. Specific priority | |
741 | values are unimportant; only relative ordering matters.</dd> | |
742 | </dl> | |
743 | </column> | |
744 | </table> | |
745 | ||
89365653 BP |
746 | <table name="Mirror" title="Port mirroring (SPAN/RSPAN)."> |
747 | <p>A port mirror within a <ref table="Bridge"/>.</p> | |
748 | <p>A port mirror configures a bridge to send selected frames to special | |
749 | ``mirrored'' ports, in addition to their normal destinations. Mirroring | |
750 | traffic may also be referred to as SPAN or RSPAN, depending on the | |
751 | mechanism used for delivery.</p> | |
752 | ||
753 | <column name="name"> | |
754 | Arbitrary identifier for the <ref table="Mirror"/>. | |
755 | </column> | |
756 | ||
757 | <group title="Selecting Packets for Mirroring"> | |
939ff267 BP |
758 | <column name="select_all"> |
759 | If true, every packet arriving or departing on any port is | |
760 | selected for mirroring. | |
761 | </column> | |
762 | ||
89365653 BP |
763 | <column name="select_dst_port"> |
764 | Ports on which departing packets are selected for mirroring. | |
765 | </column> | |
766 | ||
767 | <column name="select_src_port"> | |
939ff267 | 768 | Ports on which arriving packets are selected for mirroring. |
89365653 BP |
769 | </column> |
770 | ||
771 | <column name="select_vlan"> | |
772 | VLANs on which packets are selected for mirroring. An empty set | |
773 | selects packets on all VLANs. | |
774 | </column> | |
775 | </group> | |
776 | ||
777 | <group title="Mirroring Destination Configuration"> | |
778 | <column name="output_port"> | |
779 | <p>Output port for selected packets, if nonempty. Mutually exclusive | |
780 | with <ref column="output_vlan"/>.</p> | |
781 | <p>Specifying a port for mirror output reserves that port exclusively | |
782 | for mirroring. No frames other than those selected for mirroring | |
783 | will be forwarded to the port, and any frames received on the port | |
784 | will be discarded.</p> | |
785 | <p>This type of mirroring is sometimes called SPAN.</p> | |
786 | </column> | |
787 | ||
788 | <column name="output_vlan"> | |
789 | <p>Output VLAN for selected packets, if nonempty. Mutually exclusive | |
790 | with <ref column="output_port"/>.</p> | |
791 | <p>The frames will be sent out all ports that trunk | |
792 | <ref column="output_vlan"/>, as well as any ports with implicit VLAN | |
793 | <ref column="output_vlan"/>. When a mirrored frame is sent out a | |
794 | trunk port, the frame's VLAN tag will be set to | |
795 | <ref column="output_vlan"/>, replacing any existing tag; when it is | |
796 | sent out an implicit VLAN port, the frame will not be tagged. This | |
797 | type of mirroring is sometimes called RSPAN.</p> | |
798 | <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that | |
799 | contains unmanaged switches. Consider an unmanaged physical switch | |
800 | with two ports: port 1, connected to an end host, and port 2, | |
801 | connected to an Open vSwitch configured to mirror received packets | |
802 | into VLAN 123 on port 2. Suppose that the end host sends a packet on | |
803 | port 1 that the physical switch forwards to port 2. The Open vSwitch | |
804 | forwards this packet to its destination and then reflects it back on | |
805 | port 2 in VLAN 123. This reflected packet causes the unmanaged | |
806 | physical switch to replace the MAC learning table entry, which | |
807 | correctly pointed to port 1, with one that incorrectly points to port | |
808 | 2. Afterward, the physical switch will direct packets destined for | |
809 | the end host to the Open vSwitch on port 2, instead of to the end | |
810 | host on port 1, disrupting connectivity. If mirroring to a VLAN is | |
811 | desired in this scenario, then the physical switch must be replaced | |
812 | by one that learns Ethernet addresses on a per-VLAN basis. In | |
813 | addition, learning should be disabled on the VLAN containing mirrored | |
814 | traffic. If this is not done then intermediate switches will learn | |
815 | the MAC address of each end host from the mirrored traffic. If | |
816 | packets being sent to that end host are also mirrored, then they will | |
817 | be dropped since the switch will attempt to send them out the input | |
818 | port. Disabling learning for the VLAN will cause the switch to | |
819 | correctly send the packet out all ports configured for that VLAN. If | |
820 | Open vSwitch is being used as an intermediate switch, learning can be | |
821 | disabled by adding the mirrored VLAN to <ref column="flood_vlans"/> | |
822 | in the appropriate <ref table="Bridge"/> table or tables.</p> | |
823 | </column> | |
824 | </group> | |
825 | </table> | |
826 | ||
827 | <table name="Controller" title="OpenFlow controller configuration."> | |
76ce9432 BP |
828 | <p>An OpenFlow controller.</p> |
829 | ||
830 | <p>Open vSwitch permits a bridge to have any number of OpenFlow | |
831 | controllers. When multiple controllers are configured, Open vSwitch | |
832 | connects to all of them simultaneously. OpenFlow 1.0 does not specify | |
833 | how multiple controllers coordinate in interacting with a single switch, | |
834 | so more than one controller should be specified only if the controllers | |
835 | are themselves designed to coordinate with each other.</p> | |
89365653 BP |
836 | |
837 | <group title="Core Features"> | |
838 | <column name="target"> | |
76ce9432 BP |
839 | <p>Connection method for controller. |
840 | The following connection methods are currently | |
841 | supported:</p> | |
89365653 BP |
842 | <dl> |
843 | <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt> | |
844 | <dd> | |
845 | <p>The specified SSL <var>port</var> (default: 6633) on the host at | |
846 | the given <var>ip</var>, which must be expressed as an IP address | |
847 | (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/> | |
848 | column in the <ref table="Open_vSwitch"/> must point to a valid | |
849 | SSL configuration when this form is used.</p> | |
850 | <p>SSL support is an optional feature that is not always built as | |
851 | part of Open vSwitch.</p> | |
852 | </dd> | |
853 | <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt> | |
854 | <dd>The specified TCP <var>port</var> (default: 6633) on the host at | |
855 | the given <var>ip</var>, which must be expressed as an IP address | |
856 | (not a DNS name).</dd> | |
857 | <dt><code>discover</code></dt> | |
76ce9432 BP |
858 | <dd> |
859 | <p>Enables controller discovery.</p> | |
860 | <p>In controller discovery mode, Open vSwitch broadcasts a DHCP | |
861 | request with vendor class identifier <code>OpenFlow</code> across | |
862 | all of the bridge's network devices. It will accept any valid | |
863 | DHCP reply that has the same vendor class identifier and includes | |
864 | a vendor-specific option with code 1 whose contents are a string | |
865 | specifying the location of the controller in the same format as | |
866 | <ref column="target"/>.</p> | |
867 | <p>The DHCP reply may also, optionally, include a vendor-specific | |
868 | option with code 2 whose contents are a string specifying the URI | |
869 | to the base of the OpenFlow PKI | |
870 | (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is | |
871 | used only for bootstrapping the OpenFlow PKI at initial switch | |
872 | setup; <code>ovs-vswitchd</code> does not use it at all.</p> | |
873 | </dd> | |
89365653 BP |
874 | <dt><code>none</code></dt> |
875 | <dd>Disables the controller.</dd> | |
876 | </dl> | |
76ce9432 BP |
877 | <p>When multiple controllers are configured for a single bridge, the |
878 | <ref column="target"/> values must be unique. Duplicate | |
879 | <ref column="target"/> values yield unspecified results.</p> | |
89365653 BP |
880 | </column> |
881 | ||
882 | <column name="connection_mode"> | |
76ce9432 BP |
883 | <p>If it is specified, this setting must be one of the following |
884 | strings that describes how Open vSwitch contacts this OpenFlow | |
885 | controller over the network:</p> | |
886 | ||
887 | <dl> | |
888 | <dt><code>in-band</code></dt> | |
889 | <dd>In this mode, this controller's OpenFlow traffic travels over the | |
890 | bridge associated with the controller. With this setting, Open | |
891 | vSwitch allows traffic to and from the controller regardless of the | |
892 | contents of the OpenFlow flow table. (Otherwise, Open vSwitch | |
893 | would never be able to connect to the controller, because it did | |
894 | not have a flow to enable it.) This is the most common connection | |
895 | mode because it is not necessary to maintain two independent | |
896 | networks.</dd> | |
897 | <dt><code>out-of-band</code></dt> | |
898 | <dd>In this mode, OpenFlow traffic uses a control network separate | |
899 | from the bridge associated with this controller, that is, the | |
900 | bridge does not use any of its own network devices to communicate | |
901 | with the controller. The control network must be configured | |
902 | separately, before or after <code>ovs-vswitchd</code> is started. | |
903 | </dd> | |
904 | </dl> | |
905 | ||
906 | <p>If not specified, the default is implementation-specific. If | |
907 | <ref column="target"/> is <code>discover</code>, the connection mode | |
908 | is always treated as <code>in-band</code> regardless of the actual | |
909 | setting.</p> | |
89365653 BP |
910 | </column> |
911 | </group> | |
912 | ||
913 | <group title="Controller Failure Detection and Handling"> | |
914 | <column name="max_backoff"> | |
915 | Maximum number of milliseconds to wait between connection attempts. | |
916 | Default is implementation-specific. | |
917 | </column> | |
918 | ||
919 | <column name="inactivity_probe"> | |
920 | Maximum number of milliseconds of idle time on connection to | |
921 | controller before sending an inactivity probe message. If Open | |
922 | vSwitch does not communicate with the controller for the specified | |
923 | number of seconds, it will send a probe. If a response is not | |
924 | received for the same additional amount of time, Open vSwitch | |
925 | assumes the connection has been broken and attempts to reconnect. | |
926 | Default is implementation-specific. | |
927 | </column> | |
89365653 BP |
928 | </group> |
929 | ||
930 | <group title="OpenFlow Rate Limiting"> | |
89365653 BP |
931 | <column name="controller_rate_limit"> |
932 | <p>The maximum rate at which packets in unknown flows will be | |
933 | forwarded to the OpenFlow controller, in packets per second. This | |
934 | feature prevents a single bridge from overwhelming the controller. | |
935 | If not specified, the default is implementation-specific.</p> | |
936 | <p>In addition, when a high rate triggers rate-limiting, Open | |
937 | vSwitch queues controller packets for each port and transmits | |
938 | them to the controller at the configured rate. The number of | |
939 | queued packets is limited by | |
940 | the <ref column="controller_burst_limit"/> value. The packet | |
941 | queue is shared fairly among the ports on a bridge.</p><p>Open | |
942 | vSwitch maintains two such packet rate-limiters per bridge. | |
943 | One of these applies to packets sent up to the controller | |
944 | because they do not correspond to any flow. The other applies | |
945 | to packets sent up to the controller by request through flow | |
946 | actions. When both rate-limiters are filled with packets, the | |
947 | actual rate that packets are sent to the controller is up to | |
948 | twice the specified rate.</p> | |
949 | </column> | |
76ce9432 BP |
950 | |
951 | <column name="controller_burst_limit"> | |
952 | In conjunction with <ref column="controller_rate_limit"/>, | |
953 | the maximum number of unused packet credits that the bridge will | |
954 | allow to accumulate, in packets. If not specified, the default | |
955 | is implementation-specific. | |
956 | </column> | |
89365653 BP |
957 | </group> |
958 | ||
76ce9432 BP |
959 | <group title="Additional Discovery Configuration"> |
960 | <p>These values are considered only when <ref column="target"/> | |
961 | is <code>discover</code>.</p> | |
962 | ||
89365653 | 963 | <column name="discover_accept_regex"> |
76ce9432 | 964 | A POSIX |
89365653 BP |
965 | extended regular expression against which the discovered controller |
966 | location is validated. The regular expression is implicitly | |
967 | anchored at the beginning of the controller location string, as | |
968 | if it begins with <code>^</code>. If not specified, the default | |
969 | is implementation-specific. | |
970 | </column> | |
971 | ||
972 | <column name="discover_update_resolv_conf"> | |
76ce9432 | 973 | Whether to update <code>/etc/resolv.conf</code> when the |
89365653 BP |
974 | controller is discovered. If not specified, the default |
975 | is implementation-specific. Open vSwitch will only modify | |
976 | <code>/etc/resolv.conf</code> if the DHCP response that it receives | |
977 | specifies one or more DNS servers. | |
978 | </column> | |
979 | </group> | |
980 | ||
76ce9432 BP |
981 | <group title="Additional In-Band Configuration"> |
982 | <p>These values are considered only in in-band control mode (see | |
983 | <ref column="connection_mode"/>) and only when <ref column="target"/> | |
984 | is not <code>discover</code>. (For controller discovery, the network | |
985 | configuration obtained via DHCP is used instead.)</p> | |
986 | ||
987 | <p>When multiple controllers are configured on a single bridge, there | |
988 | should be only one set of unique values in these columns. If different | |
989 | values are set for these columns in different controllers, the effect | |
990 | is unspecified.</p> | |
89365653 BP |
991 | |
992 | <column name="local_ip"> | |
76ce9432 BP |
993 | The IP address to configure on the local port, |
994 | e.g. <code>192.168.0.123</code>. If this value is unset, then | |
995 | <ref column="local_netmask"/> and <ref column="local_gateway"/> are | |
996 | ignored. | |
89365653 BP |
997 | </column> |
998 | ||
999 | <column name="local_netmask"> | |
76ce9432 BP |
1000 | The IP netmask to configure on the local port, |
1001 | e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set | |
1002 | but this value is unset, then the default is chosen based on whether | |
1003 | the IP address is class A, B, or C. | |
1004 | </column> | |
1005 | ||
1006 | <column name="local_gateway"> | |
1007 | The IP address of the gateway to configure on the local port, as a | |
1008 | string, e.g. <code>192.168.0.1</code>. Leave this column unset if | |
1009 | this network has no gateway. | |
89365653 BP |
1010 | </column> |
1011 | </group> | |
1012 | </table> | |
1013 | ||
1014 | <table name="NetFlow"> | |
1015 | A NetFlow target. NetFlow is a protocol that exports a number of | |
1016 | details about terminating IP flows, such as the principals involved | |
1017 | and duration. | |
1018 | ||
1019 | <column name="targets"> | |
1020 | NetFlow targets in the form | |
1021 | <code><var>ip</var>:<var>port</var></code>. The <var>ip</var> | |
1022 | must be specified numerically, not as a DNS name. | |
1023 | </column> | |
1024 | ||
1025 | <column name="engine_id"> | |
1026 | Engine ID to use in NetFlow messages. Defaults to datapath index | |
1027 | if not specified. | |
1028 | </column> | |
1029 | ||
1030 | <column name="engine_type"> | |
1031 | Engine type to use in NetFlow messages. Defaults to datapath | |
1032 | index if not specified. | |
1033 | </column> | |
1034 | ||
1035 | <column name="active_timeout"> | |
1036 | The interval at which NetFlow records are sent for flows that are | |
1037 | still active, in seconds. A value of <code>0</code> requests the | |
1038 | default timeout (currently 600 seconds); a value of <code>-1</code> | |
1039 | disables active timeouts. | |
1040 | </column> | |
1041 | ||
1042 | <column name="add_id_to_interface"> | |
1043 | <p>If this column's value is <code>false</code>, the ingress and egress | |
1044 | interface fields of NetFlow flow records are derived from OpenFlow port | |
1045 | numbers. When it is <code>true</code>, the 7 most significant bits of | |
1046 | these fields will be replaced by the least significant 7 bits of the | |
1047 | engine id. This is useful because many NetFlow collectors do not | |
1048 | expect multiple switches to be sending messages from the same host, so | |
1049 | they do not store the engine information which could be used to | |
1050 | disambiguate the traffic.</p> | |
1051 | <p>When this option is enabled, a maximum of 508 ports are supported.</p> | |
1052 | </column> | |
1053 | </table> | |
1054 | ||
1055 | <table name="SSL"> | |
1056 | SSL configuration for an Open_vSwitch. | |
1057 | ||
1058 | <column name="private_key"> | |
1059 | Name of a PEM file containing the private key used as the switch's | |
1060 | identity for SSL connections to the controller. | |
1061 | </column> | |
1062 | ||
1063 | <column name="certificate"> | |
1064 | Name of a PEM file containing a certificate, signed by the | |
1065 | certificate authority (CA) used by the controller and manager, | |
1066 | that certifies the switch's private key, identifying a trustworthy | |
1067 | switch. | |
1068 | </column> | |
1069 | ||
1070 | <column name="ca_cert"> | |
1071 | Name of a PEM file containing the CA certificate used to verify | |
1072 | that the switch is connected to a trustworthy controller. | |
1073 | </column> | |
1074 | ||
1075 | <column name="bootstrap_ca_cert"> | |
1076 | If set to <code>true</code>, then Open vSwitch will attempt to | |
1077 | obtain the CA certificate from the controller on its first SSL | |
1078 | connection and save it to the named PEM file. If it is successful, | |
1079 | it will immediately drop the connection and reconnect, and from then | |
1080 | on all SSL connections must be authenticated by a certificate signed | |
1081 | by the CA certificate thus obtained. <em>This option exposes the | |
1082 | SSL connection to a man-in-the-middle attack obtaining the initial | |
1083 | CA certificate.</em> It may still be useful for bootstrapping. | |
1084 | </column> | |
1085 | </table> | |
1086 | ||
1087 | <table name="sFlow"> | |
1088 | <p>An sFlow(R) target. sFlow is a protocol for remote monitoring | |
1089 | of switches.</p> | |
1090 | ||
1091 | <column name="agent"> | |
e723ff43 BP |
1092 | Name of the network device whose IP address should be reported as the |
1093 | ``agent address'' to collectors. If not specified, the IP address | |
1094 | defaults to the <ref table="Controller" column="local_ip"/> in the | |
1095 | collector's <ref table="Controller"/>. If an agent IP address cannot be | |
1096 | determined either way, sFlow is disabled. | |
89365653 BP |
1097 | </column> |
1098 | ||
1099 | <column name="header"> | |
1100 | Number of bytes of a sampled packet to send to the collector. | |
1101 | If not specified, the default is 128 bytes. | |
1102 | </column> | |
1103 | ||
1104 | <column name="polling"> | |
1105 | Polling rate in seconds to send port statistics to the collector. | |
1106 | If not specified, defaults to 30 seconds. | |
1107 | </column> | |
1108 | ||
1109 | <column name="sampling"> | |
1110 | Rate at which packets should be sampled and sent to the collector. | |
1111 | If not specified, defaults to 400, which means one out of 400 | |
1112 | packets, on average, will be sent to the collector. | |
1113 | </column> | |
1114 | ||
1115 | <column name="targets"> | |
1116 | sFlow targets in the form | |
1117 | <code><var>ip</var>:<var>port</var></code>. | |
1118 | </column> | |
1119 | </table> | |
c1c9c9c4 BP |
1120 | |
1121 | <table name="Capability"> | |
1122 | <p>Records in this table describe functionality supported by the hardware | |
1123 | and software platform on which this Open vSwitch is based. Clients | |
1124 | should not modify this table.</p> | |
1125 | ||
1126 | <p>A record in this table is meaningful only if it is referenced by the | |
1127 | <ref table="Open_vSwitch" column="capabilities"/> column in the | |
1128 | <ref table="Open_vSwitch"/> table. The key used to reference it, called | |
1129 | the record's ``category,'' determines the meanings of the | |
1130 | <ref column="details"/> column. The following general forms of | |
1131 | categories are currently defined:</p> | |
1132 | ||
1133 | <dl> | |
1134 | <dt><code>qos-<var>type</var></code></dt> | |
1135 | <dd><var>type</var> is supported as the value for | |
1136 | <ref column="type" table="QoS"/> in the <ref table="QoS"/> table. | |
1137 | </dd> | |
1138 | </dl> | |
1139 | ||
1140 | <column name="details"> | |
1141 | <p>Key-value pairs that describe capabilities. The meaning of the pairs | |
1142 | depends on the category key that the <ref table="Open_vSwitch" | |
1143 | column="capabilities"/> column in the <ref table="Open_vSwitch"/> table | |
1144 | uses to reference this record, as described above.</p> | |
1145 | ||
1146 | <p>The presence of a record for category <code>qos-<var>type</var></code> | |
1147 | indicates that the switch supports <var>type</var> as the value of | |
1148 | the <ref table="QoS" column="type"/> column in the <ref table="QoS"/> | |
1149 | table. The following key-value pairs are defined to further describe | |
1150 | QoS capabilities:</p> | |
1151 | ||
1152 | <dl> | |
1153 | <dt><code>n-queues</code></dt> | |
1154 | <dd>Number of supported queues, as a positive integer. Keys in the | |
1155 | <ref table="QoS" column="queues"/> column for <ref table="QoS"/> | |
1156 | records whose <ref table="QoS" column="type"/> value | |
1157 | equals <var>type</var> must range between 0 and this value minus one, | |
1158 | inclusive.</dd> | |
1159 | </dl> | |
1160 | </column> | |
1161 | </table> | |
89365653 | 1162 | </database> |