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