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