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