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