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