1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
3 <p>A database with this schema holds the configuration for one Open
4 vSwitch daemon. The root of the configuration for the daemon is
5 the <ref table="Open_vSwitch"/> table, which must have exactly one
6 record. Records in other tables are significant only when they
7 can be reached directly or indirectly from the
8 <ref table="Open_vSwitch"/> table.</p>
10 <table name="Open_vSwitch" title="Open vSwitch configuration.">
11 Configuration for an Open vSwitch daemon. There must be exactly one record
12 in the <ref table="Open_vSwitch"/> table.
14 <group title="Configuration">
15 <column name="bridges">
16 Set of bridges managed by the daemon.
20 SSL used globally by the daemon.
23 <column name="external_ids">
24 Key-value pairs for use by external frameworks that integrate
25 with Open vSwitch, rather than by Open vSwitch itself. System
26 integrators should either use the Open vSwitch development
27 mailing list to coordinate on common key-value definitions, or
28 choose key names that are likely to be unique. The currently
29 defined common key-value pairs are:
31 <dt><code>system-id</code></dt>
32 <dd>A unique identifier for the Open vSwitch's physical host.
33 The form of the identifier depends on the type of the host.
34 On a Citrix XenServer, this will likely be the same as
35 <code>xs-system-uuid</code>.</dd>
36 <dt><code>xs-system-uuid</code></dt>
37 <dd>The Citrix XenServer universally unique identifier for the
38 physical host as displayed by <code>xe host-list</code>.</dd>
43 <group title="Status">
44 <column name="next_cfg">
45 Sequence number for client to increment. When a client modifies
46 any part of the database configuration and wishes to wait for
47 Open vSwitch to finish applying the changes, it may increment
51 <column name="cur_cfg">
52 Sequence number that Open vSwitch sets to the current value of
53 <ref column="next_cfg"/> after it finishes applying a set of
54 configuration changes.
57 <column name="capabilities">
58 Describes functionality supported by the hardware and software platform
59 on which this Open vSwitch is based. Clients should not modify this
60 column. See the <ref table="Capability"/> description for defined
61 capability categories and the meaning of associated
62 <ref table="Capability"/> records.
65 <column name="statistics">
67 Key-value pairs that report statistics about a system running an Open
68 vSwitch. These are updated periodically (currently, every 5
69 seconds). Key-value pairs that cannot be determined or that do not
70 apply to a platform are omitted.
74 <dt><code>cpu</code></dt>
77 Number of CPU processors, threads, or cores currently online and
78 available to the operating system on which Open vSwitch is
79 running, as an integer. This may be less than the number
80 installed, if some are not online or if they are not available to
84 Open vSwitch userspace processes are not multithreaded, but the
85 Linux kernel-based datapath is.
89 <dt><code>load_average</code></dt>
92 A comma-separated list of three floating-point numbers,
93 representing the system load average over the last 1, 5, and 15
94 minutes, respectively.
98 <dt><code>memory</code></dt>
101 A comma-separated list of integers, each of which represents a
102 quantity of memory in kilobytes that describes the operating
103 system on which Open vSwitch is running. In respective order,
108 <li>Total amount of RAM allocated to the OS.</li>
109 <li>RAM allocated to the OS that is in use.</li>
110 <li>RAM that can be flushed out to disk or otherwise discarded
111 if that space is needed for another purpose. This number is
112 necessarily less than or equal to the previous value.</li>
113 <li>Total disk space allocated for swap.</li>
114 <li>Swap space currently in use.</li>
118 On Linux, all five values can be determined and are included. On
119 other operating systems, only the first two values can be
120 determined, so the list will only have two values.
124 <dt><code>process_</code><var>name</var></dt>
127 One such key-value pair will exist for each running Open vSwitch
128 daemon process, with <var>name</var> replaced by the daemon's
129 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
130 comma-separated list of integers. The integers represent the
131 following, with memory measured in kilobytes and durations in
136 <li>The process's virtual memory size.</li>
137 <li>The process's resident set size.</li>
138 <li>The amount of user and system CPU time consumed by the
140 <li>The number of times that the process has crashed and been
141 automatically restarted by the monitor.</li>
142 <li>The duration since the process was started.</li>
143 <li>The duration for which the process has been running.</li>
147 The interpretation of some of these values depends on whether the
148 process was started with the <option>--monitor</option>. If it
149 was not, then the crash count will always be 0 and the two
150 durations will always be the same. If <option>--monitor</option>
151 was given, then the crash count may be positive; if it is, the
152 latter duration is the amount of time since the most recent crash
157 There will be one key-value pair for each file in Open vSwitch's
158 ``run directory'' (usually <code>/var/run/openvswitch</code>)
159 whose name ends in <code>.pid</code>, whose contents are a
160 process ID, and which is locked by a running process. The
161 <var>name</var> is taken from the pidfile's name.
165 Currently Open vSwitch is only able to obtain all of the above
166 detail on Linux systems. On other systems, the same key-value
167 pairs will be present but the values will always be the empty
172 <dt><code>file_systems</code></dt>
175 A space-separated list of information on local, writable file
176 systems. Each item in the list describes one file system and
177 consists in turn of a comma-separated list of the following:
181 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
182 Any spaces or commas in the mount point are replaced by
184 <li>Total size, in kilobytes, as an integer.</li>
185 <li>Amount of storage in use, in kilobytes, as an integer.</li>
189 This key-value pair is omitted if there are no local, writable
190 file systems or if Open vSwitch cannot obtain the needed
198 <group title="Version Reporting">
200 These columns report the types and versions of the hardware and
201 software running Open vSwitch. We recommend in general that software
202 should test whether specific features are supported instead of relying
203 on version number checks. These values are primarily intended for
204 reporting to human administrators.
207 <column name="ovs_version">
208 The Open vSwitch version number, e.g. <code>1.1.0pre2</code>.
209 If Open vSwitch was configured with a build number, then it is
210 also included, e.g. <code>1.1.0pre2+build4948</code>.
213 <column name="system_type">
215 An identifier for the type of system on top of which Open vSwitch
216 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
219 System integrators are responsible for choosing and setting an
220 appropriate value for this column.
224 <column name="system_version">
226 The version of the system identified by <ref column="system_type"/>,
227 e.g. <code>5.5.0-24648p</code> on XenServer 5.5.0 build 24648.
230 System integrators are responsible for choosing and setting an
231 appropriate value for this column.
237 <group title="Database Configuration">
239 These columns primarily configure the Open vSwitch database
240 (<code>ovsdb-server</code>), not the Open vSwitch switch
241 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
242 column="ssl"/> settings.
246 The Open vSwitch switch does read the database configuration to
247 determine remote IP addresses to which in-band control should apply.
250 <column name="manager_options">
251 Database clients to which the Open vSwitch database server should
252 connect or to which it should listen, along with options for how these
253 connection should be configured. See the <ref table="Manager"/> table
254 for more information.
257 <column name="managers">
259 Remote database clients to which the Open vSwitch's database server
260 should connect or to which it should listen. Adding an OVSDB target
261 to this set is equivalent to adding it to <ref
262 column="manager_options"/> with all of the default options.
266 Use of this column is deprecated and may be removed sometime in the
267 future. New applications should use and set <ref
268 column="manager_options"/> instead.
274 <table name="Bridge">
276 Configuration for a bridge within an
277 <ref table="Open_vSwitch"/>.
280 A <ref table="Bridge"/> record represents an Ethernet switch with one or
281 more ``ports,'' which are the <ref table="Port"/> records pointed to by
282 the <ref table="Bridge"/>'s <ref column="ports"/> column.
285 <group title="Core Features">
287 Bridge identifier. Should be alphanumeric and no more than about 8
288 bytes long. Must be unique among the names of ports, interfaces, and
292 <column name="ports">
293 Ports included in the bridge.
296 <column name="mirrors">
297 Port mirroring configuration.
300 <column name="netflow">
301 NetFlow configuration.
304 <column name="sflow">
308 <column name="flood_vlans">
309 VLAN IDs of VLANs on which MAC address learning should be disabled, so
310 that packets are flooded instead of being sent to specific ports that
311 are believed to contain packets' destination MACs. This should
312 ordinarily be used to disable MAC learning on VLANs used for mirroring
313 (RSPAN VLANs). It may also be useful for debugging.
317 <group title="OpenFlow Configuration">
318 <column name="controller">
319 OpenFlow controller set. If unset, then no OpenFlow controllers
323 <column name="fail_mode">
324 <p>When a controller is configured, it is, ordinarily, responsible
325 for setting up all flows on the switch. Thus, if the connection to
326 the controller fails, no new network connections can be set up.
327 If the connection to the controller stays down long enough,
328 no packets can pass through the switch at all. This setting
329 determines the switch's response to such a situation. It may be set
330 to one of the following:
332 <dt><code>standalone</code></dt>
333 <dd>If no message is received from the controller for three
334 times the inactivity probe interval
335 (see <ref column="inactivity_probe"/>), then Open vSwitch
336 will take over responsibility for setting up flows. In
337 this mode, Open vSwitch causes the bridge to act like an
338 ordinary MAC-learning switch. Open vSwitch will continue
339 to retry connecting to the controller in the background
340 and, when the connection succeeds, it will discontinue its
341 standalone behavior.</dd>
342 <dt><code>secure</code></dt>
343 <dd>Open vSwitch will not set up flows on its own when the
344 controller connection fails or when no controllers are
345 defined. The bridge will continue to retry connecting to
346 any defined controllers forever.</dd>
349 <p>If this value is unset, the default is implementation-specific.</p>
350 <p>When more than one controller is configured,
351 <ref column="fail_mode"/> is considered only when none of the
352 configured controllers can be contacted.</p>
355 <column name="datapath_id">
356 Reports the OpenFlow datapath ID in use. Exactly 16 hex
357 digits. (Setting this column will have no useful effect. Set
358 <ref column="other_config"/>:<code>other-config</code>
363 <group title="Other Features">
364 <column name="datapath_type">
365 Name of datapath provider. The kernel datapath has
366 type <code>system</code>. The userspace datapath has
367 type <code>netdev</code>.
370 <column name="external_ids">
371 Key-value pairs for use by external frameworks that integrate
372 with Open vSwitch, rather than by Open vSwitch itself. System
373 integrators should either use the Open vSwitch development
374 mailing list to coordinate on common key-value definitions, or
375 choose key names that are likely to be unique. The currently
376 defined key-value pairs are:
378 <dt><code>bridge-id</code></dt>
379 <dd>A unique identifier of the bridge. On Citrix XenServer this
380 will commonly be the same as <code>xs-network-uuids</code>.</dd>
381 <dt><code>xs-network-uuids</code></dt>
382 <dd>Semicolon-delimited set of universally unique identifier(s) for
383 the network with which this bridge is associated on a Citrix
384 XenServer host. The network identifiers are RFC 4122 UUIDs as
385 displayed by, e.g., <code>xe network-list</code>.</dd>
389 <column name="other_config">
390 Key-value pairs for configuring rarely used bridge
391 features. The currently defined key-value pairs are:
393 <dt><code>datapath-id</code></dt>
395 digits to set the OpenFlow datapath ID to a specific
396 value. May not be all-zero.</dd>
397 <dt><code>disable-in-band</code></dt>
398 <dd>If set to <code>true</code>, disable in-band control on
399 the bridge regardless of controller and manager settings.</dd>
400 <dt><code>hwaddr</code></dt>
401 <dd>An Ethernet address in the form
402 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
403 to set the hardware address of the local port and influence the
405 <dt><code>in-band-queue</code></dt>
407 A queue ID as a nonnegative integer. This sets the OpenFlow queue
408 ID that will be used by flows set up by in-band control on this
409 bridge. If unset, or if the port used by an in-band control flow
410 does not have QoS configured, or if the port does not have a queue
411 with the specified ID, the default queue is used instead.
418 <table name="Port" table="Port or bond configuration.">
419 <p>A port within a <ref table="Bridge"/>.</p>
420 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
421 <ref column="interfaces"/> column. Such a port logically
422 corresponds to a port on a physical Ethernet switch. A port
423 with more than one interface is a ``bonded port'' (see
424 <ref group="Bonding Configuration"/>).</p>
425 <p>Some properties that one might think as belonging to a port are actually
426 part of the port's <ref table="Interface"/> members.</p>
429 Port name. Should be alphanumeric and no more than about 8
430 bytes long. May be the same as the interface name, for
431 non-bonded ports. Must otherwise be unique among the names of
432 ports, interfaces, and bridges on a host.
435 <column name="interfaces">
436 The port's interfaces. If there is more than one, this is a
440 <group title="VLAN Configuration">
441 <p>A bridge port must be configured for VLANs in one of two
442 mutually exclusive ways:
444 <li>A ``trunk port'' has an empty value for <ref
445 column="tag"/>. Its <ref column="trunks"/> value may be
446 empty or non-empty.</li>
447 <li>An ``implicitly tagged VLAN port'' or ``access port''
448 has an nonempty value for <ref column="tag"/>. Its
449 <ref column="trunks"/> value must be empty.</li>
451 If <ref column="trunks"/> and <ref column="tag"/> are both
452 nonempty, the configuration is ill-formed.
457 If this is an access port (see above), the port's implicitly
458 tagged VLAN. Must be empty if this is a trunk port.
461 Frames arriving on trunk ports will be forwarded to this
462 port only if they are tagged with the given VLAN (or, if
463 <ref column="tag"/> is 0, then if they lack a VLAN header).
464 Frames arriving on other access ports will be forwarded to
465 this port only if they have the same <ref column="tag"/>
466 value. Frames forwarded to this port will not have an
470 When a frame with a 802.1Q header that indicates a nonzero
471 VLAN is received on an access port, it is discarded.
475 <column name="trunks">
477 If this is a trunk port (see above), the 802.1Q VLAN(s) that
478 this port trunks; if it is empty, then the port trunks all
479 VLANs. Must be empty if this is an access port.
482 Frames arriving on trunk ports are dropped if they are not
483 in one of the specified VLANs. For this purpose, packets
484 that have no VLAN header are treated as part of VLAN 0.
489 <group title="Bonding Configuration">
490 <p>A port that has more than one interface is a ``bonded port.''
491 Bonding allows for load balancing and fail-over. Open vSwitch
492 supports ``source load balancing'' (SLB) bonding, which
493 assigns flows to slaves based on source MAC address and output VLAN,
494 with periodic rebalancing as traffic patterns change. This form of
495 bonding does not require 802.3ad or other special support from the
496 upstream switch to which the slave devices are connected.</p>
498 <p>These columns apply only to bonded ports. Their values are
499 otherwise ignored.</p>
501 <column name="bond_updelay">
502 <p>For a bonded port, the number of milliseconds for which carrier must
503 stay up on an interface before the interface is considered to be up.
504 Specify <code>0</code> to enable the interface immediately.</p>
505 <p>This setting is honored only when at least one bonded interface is
506 already enabled. When no interfaces are enabled, then the first bond
507 interface to come up is enabled immediately.</p>
510 <column name="bond_downdelay">
511 For a bonded port, the number of milliseconds for which carrier must
512 stay down on an interface before the interface is considered to be
513 down. Specify <code>0</code> to disable the interface immediately.
516 <column name="bond_fake_iface">
517 For a bonded port, whether to create a fake internal interface with the
518 name of the port. Use only for compatibility with legacy software that
523 <group title="Other Features">
525 Quality of Service configuration for this port.
529 The MAC address to use for this port for the purpose of choosing the
530 bridge's MAC address. This column does not necessarily reflect the
531 port's actual MAC address, nor will setting it change the port's actual
535 <column name="fake_bridge">
536 Does this port represent a sub-bridge for its tagged VLAN within the
537 Bridge? See ovs-vsctl(8) for more information.
540 <column name="external_ids">
542 Key-value pairs for use by external frameworks that integrate with
543 Open vSwitch, rather than by Open vSwitch itself. System integrators
544 should either use the Open vSwitch development mailing list to
545 coordinate on common key-value definitions, or choose key names that
546 are likely to be unique.
549 No key-value pairs native to <ref table="Port"/> are currently
550 defined. For fake bridges (see the <ref column="fake_bridge"/>
551 column), external IDs for the fake bridge are defined here by
552 prefixing a <ref table="Bridge"/> <ref table="Bridge"
553 column="external_ids"/> key with <code>fake-bridge-</code>,
554 e.g. <code>fake-bridge-xs-network-uuids</code>.
558 <column name="other_config">
559 Key-value pairs for configuring rarely used port features. The
560 currently defined key-value pairs are:
562 <dt><code>hwaddr</code></dt>
563 <dd>An Ethernet address in the form
564 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
565 <dt><code>bond-rebalance-interval</code></dt>
566 <dd>For a bonded port, the number of milliseconds between
567 successive attempts to rebalance the bond, that is, to
568 move source MACs and their flows from one interface on
569 the bond to another in an attempt to keep usage of each
570 interface roughly equal. The default is 10000 (10
571 seconds), and the minimum is 1000 (1 second).</dd>
577 <table name="Interface" title="One physical network device in a Port.">
578 An interface within a <ref table="Port"/>.
580 <group title="Core Features">
582 Interface name. Should be alphanumeric and no more than about 8 bytes
583 long. May be the same as the port name, for non-bonded ports. Must
584 otherwise be unique among the names of ports, interfaces, and bridges
589 <p>Ethernet address to set for this interface. If unset then the
590 default MAC address is used:</p>
592 <li>For the local interface, the default is the lowest-numbered MAC
593 address among the other bridge ports, either the value of the
594 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
595 if set, or its actual MAC (for bonded ports, the MAC of its slave
596 whose name is first in alphabetical order). Internal ports and
597 bridge ports that are used as port mirroring destinations (see the
598 <ref table="Mirror"/> table) are ignored.</li>
599 <li>For other internal interfaces, the default MAC is randomly
601 <li>External interfaces typically have a MAC address associated with
604 <p>Some interfaces may not have a software-controllable MAC
608 <column name="ofport">
609 <p>OpenFlow port number for this interface. Unlike most columns, this
610 column's value should be set only by Open vSwitch itself. Other
611 clients should set this column to an empty set (the default) when
612 creating an <ref table="Interface"/>.</p>
613 <p>Open vSwitch populates this column when the port number becomes
614 known. If the interface is successfully added,
615 <ref column="ofport"/> will be set to a number between 1 and 65535
616 (generally either in the range 1 to 65279, inclusive, or 65534, the
617 port number for the OpenFlow ``local port''). If the interface
618 cannot be added then Open vSwitch sets this column
623 <group title="System-Specific Details">
625 The interface type, one of:
627 <dt><code>system</code></dt>
628 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
629 Sometimes referred to as ``external interfaces'' since they are
630 generally connected to hardware external to that on which the Open
631 vSwitch is running. The empty string is a synonym for
632 <code>system</code>.</dd>
633 <dt><code>internal</code></dt>
634 <dd>A simulated network device that sends and receives traffic. An
635 internal interface whose <ref column="name"/> is the same as its
636 bridge's <ref table="Open_vSwitch" column="name"/> is called the
637 ``local interface.'' It does not make sense to bond an internal
638 interface, so the terms ``port'' and ``interface'' are often used
639 imprecisely for internal interfaces.</dd>
640 <dt><code>tap</code></dt>
641 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
642 <dt><code>gre</code></dt>
643 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
644 tunnel. Each tunnel must be uniquely identified by the
645 combination of <code>remote_ip</code>, <code>local_ip</code>, and
646 <code>in_key</code>. Note that if two ports are defined that are
647 the same except one has an optional identifier and the other does
648 not, the more specific one is matched first. <code>in_key</code>
649 is considered more specific than <code>local_ip</code> if a port
650 defines one and another port defines the other. The following
651 options may be specified in the <ref column="options"/> column:
653 <dt><code>remote_ip</code></dt>
654 <dd>Required. The tunnel endpoint.</dd>
657 <dt><code>local_ip</code></dt>
658 <dd>Optional. The destination IP that received packets must
659 match. Default is to match all addresses.</dd>
662 <dt><code>in_key</code></dt>
663 <dd>Optional. The GRE key that received packets must contain.
664 It may either be a 32-bit number (no key and a key of 0 are
665 treated as equivalent) or the word <code>flow</code>. If
666 <code>flow</code> is specified then any key will be accepted
667 and the key will be placed in the <code>tun_id</code> field
668 for matching in the flow table. The ovs-ofctl manual page
669 contains additional information about matching fields in
670 OpenFlow flows. Default is no key.</dd>
673 <dt><code>out_key</code></dt>
674 <dd>Optional. The GRE key to be set on outgoing packets. It may
675 either be a 32-bit number or the word <code>flow</code>. If
676 <code>flow</code> is specified then the key may be set using
677 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
678 is used in the absence of an action). The ovs-ofctl manual
679 page contains additional information about the Nicira OpenFlow
680 vendor extensions. Default is no key.</dd>
683 <dt><code>key</code></dt>
684 <dd>Optional. Shorthand to set <code>in_key</code> and
685 <code>out_key</code> at the same time.</dd>
688 <dt><code>tos</code></dt>
689 <dd>Optional. The value of the ToS bits to be set on the
690 encapsulating packet. It may also be the word
691 <code>inherit</code>, in which case the ToS will be copied from
692 the inner packet if it is IPv4 or IPv6 (otherwise it will be
693 0). Note that the ECN fields are always inherited. Default is
697 <dt><code>ttl</code></dt>
698 <dd>Optional. The TTL to be set on the encapsulating packet.
699 It may also be the word <code>inherit</code>, in which case the
700 TTL will be copied from the inner packet if it is IPv4 or IPv6
701 (otherwise it will be the system default, typically 64).
702 Default is the system default TTL.</dd>
705 <dt><code>csum</code></dt>
706 <dd>Optional. Compute GRE checksums on outgoing packets.
707 Checksums present on incoming packets will be validated
708 regardless of this setting. Note that GRE checksums
709 impose a significant performance penalty as they cover the
710 entire packet. As the contents of the packet is typically
711 covered by L3 and L4 checksums, this additional checksum only
712 adds value for the GRE and encapsulated Ethernet headers.
713 Default is disabled, set to <code>true</code> to enable.</dd>
716 <dt><code>pmtud</code></dt>
717 <dd>Optional. Enable tunnel path MTU discovery. If enabled
718 ``ICMP destination unreachable - fragmentation'' needed
719 messages will be generated for IPv4 packets with the DF bit set
720 and IPv6 packets above the minimum MTU if the packet size
721 exceeds the path MTU minus the size of the tunnel headers. It
722 also forces the encapsulating packet DF bit to be set (it is
723 always set if the inner packet implies path MTU discovery).
724 Note that this option causes behavior that is typically
725 reserved for routers and therefore is not entirely in
726 compliance with the IEEE 802.1D specification for bridges.
727 Default is enabled, set to <code>false</code> to disable.</dd>
730 <dt><code>header_cache</code></dt>
731 <dd>Optional. Enable caching of tunnel headers and the output
732 path. This can lead to a significant performance increase
733 without changing behavior. In general it should not be
734 necessary to adjust this setting. However, the caching can
735 bypass certain components of the IP stack (such as IP tables)
736 and it may be useful to disable it if these features are
737 required or as a debugging measure. Default is enabled, set to
738 <code>false</code> to disable. If IPsec is enabled through the
739 <ref column="other_config"/> parameters, header caching will be
740 automatically disabled.</dd>
743 <dt><code>capwap</code></dt>
744 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
745 (RFC 5415). This allows interoperability with certain switches
746 where GRE is not available. Note that only the tunneling component
747 of the protocol is implemented. Due to the non-standard use of
748 CAPWAP, UDP ports 58881 and 58882 are used as the source and
749 destinations ports respectivedly. Each tunnel must be uniquely
750 identified by the combination of <code>remote_ip</code> and
751 <code>local_ip</code>. If two ports are defined that are the same
752 except one includes <code>local_ip</code> and the other does not,
753 the more specific one is matched first. CAPWAP support is not
754 available on all platforms. Currently it is only supported in the
755 Linux kernel module with kernel versions >= 2.6.25. The following
756 options may be specified in the <ref column="options"/> column:
758 <dt><code>remote_ip</code></dt>
759 <dd>Required. The tunnel endpoint.</dd>
762 <dt><code>local_ip</code></dt>
763 <dd>Optional. The destination IP that received packets must
764 match. Default is to match all addresses.</dd>
767 <dt><code>tos</code></dt>
768 <dd>Optional. The value of the ToS bits to be set on the
769 encapsulating packet. It may also be the word
770 <code>inherit</code>, in which case the ToS will be copied from
771 the inner packet if it is IPv4 or IPv6 (otherwise it will be
772 0). Note that the ECN fields are always inherited. Default is
776 <dt><code>ttl</code></dt>
777 <dd>Optional. The TTL to be set on the encapsulating packet.
778 It may also be the word <code>inherit</code>, in which case the
779 TTL will be copied from the inner packet if it is IPv4 or IPv6
780 (otherwise it will be the system default, typically 64).
781 Default is the system default TTL.</dd>
784 <dt><code>pmtud</code></dt>
785 <dd>Optional. Enable tunnel path MTU discovery. If enabled
786 ``ICMP destination unreachable - fragmentation'' needed
787 messages will be generated for IPv4 packets with the DF bit set
788 and IPv6 packets above the minimum MTU if the packet size
789 exceeds the path MTU minus the size of the tunnel headers. It
790 also forces the encapsulating packet DF bit to be set (it is
791 always set if the inner packet implies path MTU discovery).
792 Note that this option causes behavior that is typically
793 reserved for routers and therefore is not entirely in
794 compliance with the IEEE 802.1D specification for bridges.
795 Default is enabled, set to <code>false</code> to disable.</dd>
798 <dt><code>header_cache</code></dt>
799 <dd>Optional. Enable caching of tunnel headers and the output
800 path. This can lead to a significant performance increase
801 without changing behavior. In general it should not be
802 necessary to adjust this setting. However, the caching can
803 bypass certain components of the IP stack (such as IP tables)
804 and it may be useful to disable it if these features are
805 required or as a debugging measure. Default is enabled, set to
806 <code>false</code> to disable.</dd>
809 <dt><code>patch</code></dt>
812 A pair of virtual devices that act as a patch cable. The <ref
813 column="options"/> column must have the following key-value pair:
816 <dt><code>peer</code></dt>
818 The <ref column="name"/> of the <ref table="Interface"/> for
819 the other side of the patch. The named <ref
820 table="Interface"/>'s own <code>peer</code> option must specify
821 this <ref table="Interface"/>'s name. That is, the two patch
822 interfaces must have reversed <ref column="name"/> and
823 <code>peer</code> values.
830 <column name="options">
831 Configuration options whose interpretation varies based on
832 <ref column="type"/>.
835 <column name="status">
837 Key-value pairs that report port status. Supported status
838 values are <code>type</code>-dependent.
840 <p>The only currently defined key-value pair is:</p>
842 <dt><code>source_ip</code></dt>
843 <dd>The source IP address used for an IPv4 tunnel end-point,
844 such as <code>gre</code> or <code>capwap</code>. Not
845 supported by all implementations.</dd>
850 <group title="Ingress Policing">
852 These settings control ingress policing for packets received on this
853 interface. On a physical interface, this limits the rate at which
854 traffic is allowed into the system from the outside; on a virtual
855 interface (one connected to a virtual machine), this limits the rate at
856 which the VM is able to transmit.
859 Policing is a simple form of quality-of-service that simply drops
860 packets received in excess of the configured rate. Due to its
861 simplicity, policing is usually less accurate and less effective than
862 egress QoS (which is configured using the <ref table="QoS"/> and <ref
863 table="Queue"/> tables).
866 Policing is currently implemented only on Linux. The Linux
867 implementation uses a simple ``token bucket'' approach:
871 The size of the bucket corresponds to <ref
872 column="ingress_policing_burst"/>. Initially the bucket is full.
875 Whenever a packet is received, its size (converted to tokens) is
876 compared to the number of tokens currently in the bucket. If the
877 required number of tokens are available, they are removed and the
878 packet is forwarded. Otherwise, the packet is dropped.
881 Whenever it is not full, the bucket is refilled with tokens at the
882 rate specified by <ref column="ingress_policing_rate"/>.
886 Policing interacts badly with some network protocols, and especially
887 with fragmented IP packets. Suppose that there is enough network
888 activity to keep the bucket nearly empty all the time. Then this token
889 bucket algorithm will forward a single packet every so often, with the
890 period depending on packet size and on the configured rate. All of the
891 fragments of an IP packets are normally transmitted back-to-back, as a
892 group. In such a situation, therefore, only one of these fragments
893 will be forwarded and the rest will be dropped. IP does not provide
894 any way for the intended recipient to ask for only the remaining
895 fragments. In such a case there are two likely possibilities for what
896 will happen next: either all of the fragments will eventually be
897 retransmitted (as TCP will do), in which case the same problem will
898 recur, or the sender will not realize that its packet has been dropped
899 and data will simply be lost (as some UDP-based protocols will do).
900 Either way, it is possible that no forward progress will ever occur.
902 <column name="ingress_policing_rate">
904 Maximum rate for data received on this interface, in kbps. Data
905 received faster than this rate is dropped. Set to <code>0</code>
906 (the default) to disable policing.
910 <column name="ingress_policing_burst">
911 <p>Maximum burst size for data received on this interface, in kb. The
912 default burst size if set to <code>0</code> is 1000 kb. This value
913 has no effect if <ref column="ingress_policing_rate"/>
914 is <code>0</code>.</p>
916 Specifying a larger burst size lets the algorithm be more forgiving,
917 which is important for protocols like TCP that react severely to
918 dropped packets. The burst size should be at least the size of the
919 interface's MTU. Specifying a value that is numerically at least as
920 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
921 closer to achieving the full rate.
926 <group title="Other Features">
928 <column name="monitor">
929 Connectivity monitor configuration for this interface.
932 <column name="external_ids">
933 Key-value pairs for use by external frameworks that integrate
934 with Open vSwitch, rather than by Open vSwitch itself. System
935 integrators should either use the Open vSwitch development
936 mailing list to coordinate on common key-value definitions, or
937 choose key names that are likely to be unique. The currently
938 defined common key-value pairs are:
940 <dt><code>attached-mac</code></dt>
942 The MAC address programmed into the ``virtual hardware'' for this
943 interface, in the form
944 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
945 For Citrix XenServer, this is the value of the <code>MAC</code>
946 field in the VIF record for this interface.</dd>
947 <dt><code>iface-id</code></dt>
948 <dd>A system-unique identifier for the interface. On XenServer,
949 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
952 Additionally the following key-value pairs specifically
953 apply to an interface that represents a virtual Ethernet interface
954 connected to a virtual machine. These key-value pairs should not be
955 present for other types of interfaces. Keys whose names end
956 in <code>-uuid</code> have values that uniquely identify the entity
957 in question. For a Citrix XenServer hypervisor, these values are
958 UUIDs in RFC 4122 format. Other hypervisors may use other
961 <p>The currently defined key-value pairs for XenServer are:</p>
963 <dt><code>xs-vif-uuid</code></dt>
964 <dd>The virtual interface associated with this interface.</dd>
965 <dt><code>xs-network-uuid</code></dt>
966 <dd>The virtual network to which this interface is attached.</dd>
967 <dt><code>xs-vm-uuid</code></dt>
968 <dd>The VM to which this interface belongs.</dd>
972 <column name="other_config">
973 Key-value pairs for rarely used interface features. Currently,
974 the only keys are for configuring GRE-over-IPsec, which is only
975 available through the <code>openvswitch-ipsec</code> package for
976 Debian. The currently defined key-value pairs are:
978 <dt><code>ipsec_local_ip</code></dt>
979 <dd>Required key for GRE-over-IPsec interfaces. Additionally,
980 the <ref column="type"/> must be <code>gre</code> and the
981 <code>ipsec_psk</code> <ref column="other_config"/> key must
982 be set. The <code>in_key</code>, <code>out_key</code>, and
983 <code>key</code> <ref column="options"/> must not be
985 <dt><code>ipsec_psk</code></dt>
986 <dd>Required key for GRE-over-IPsec interfaces. Specifies a
987 pre-shared key for authentication that must be identical on
988 both sides of the tunnel. Additionally, the
989 <code>ipsec_local_ip</code> key must also be set.</dd>
993 <column name="statistics">
995 Key-value pairs that report interface statistics. The current
996 implementation updates these counters periodically. In the future,
997 we plan to, instead, update them when an interface is created, when
998 they are queried (e.g. using an OVSDB <code>select</code> operation),
999 and just before an interface is deleted due to virtual interface
1000 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1001 regular periodic basis.</p>
1003 The currently defined key-value pairs are listed below. These are
1004 the same statistics reported by OpenFlow in its <code>struct
1005 ofp_port_stats</code> structure. If an interface does not support a
1006 given statistic, then that pair is omitted.</p>
1009 Successful transmit and receive counters:
1011 <dt><code>rx_packets</code></dt>
1012 <dd>Number of received packets.</dd>
1013 <dt><code>rx_bytes</code></dt>
1014 <dd>Number of received bytes.</dd>
1015 <dt><code>tx_packets</code></dt>
1016 <dd>Number of transmitted packets.</dd>
1017 <dt><code>tx_bytes</code></dt>
1018 <dd>Number of transmitted bytes.</dd>
1024 <dt><code>rx_dropped</code></dt>
1025 <dd>Number of packets dropped by RX.</dd>
1026 <dt><code>rx_frame_err</code></dt>
1027 <dd>Number of frame alignment errors.</dd>
1028 <dt><code>rx_over_err</code></dt>
1029 <dd>Number of packets with RX overrun.</dd>
1030 <dt><code>rx_crc_err</code></dt>
1031 <dd>Number of CRC errors.</dd>
1032 <dt><code>rx_errors</code></dt>
1034 Total number of receive errors, greater than or equal
1035 to the sum of the above.
1042 <dt><code>tx_dropped</code></dt>
1043 <dd>Number of packets dropped by TX.</dd>
1044 <dt><code>collisions</code></dt>
1045 <dd>Number of collisions.</dd>
1046 <dt><code>tx_errors</code></dt>
1048 Total number of transmit errors, greater
1049 than or equal to the sum of the above.
1058 <table name="QoS" title="Quality of Service configuration">
1059 <p>Quality of Service (QoS) configuration for each Port that
1062 <column name="type">
1063 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1064 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1065 identifies the types that a switch actually supports. The currently
1066 defined types are listed below:</p>
1068 <dt><code>linux-htb</code></dt>
1070 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1071 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1072 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1073 for information on how this classifier works and how to configure it.
1077 <dt><code>linux-hfsc</code></dt>
1079 Linux "Hierarchical Fair Service Curve" classifier.
1080 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1081 information on how this classifier works.
1086 <column name="queues">
1087 <p>A map from queue numbers to <ref table="Queue"/> records. The
1088 supported range of queue numbers depend on <ref column="type"/>. The
1089 queue numbers are the same as the <code>queue_id</code> used in
1090 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1091 structures. Queue 0 is used by OpenFlow output actions that do not
1092 specify a specific queue.</p>
1095 <column name="other_config">
1096 <p>Key-value pairs for configuring QoS features that depend on
1097 <ref column="type"/>.</p>
1098 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1099 the following key-value pairs:</p>
1101 <dt><code>max-rate</code></dt>
1102 <dd>Maximum rate shared by all queued traffic, in bit/s.
1103 Optional. If not specified, for physical interfaces, the
1104 default is the link rate. For other interfaces or if the
1105 link rate cannot be determined, the default is currently 100
1110 <column name="external_ids">
1111 Key-value pairs for use by external frameworks that integrate with Open
1112 vSwitch, rather than by Open vSwitch itself. System integrators should
1113 either use the Open vSwitch development mailing list to coordinate on
1114 common key-value definitions, or choose key names that are likely to be
1115 unique. No common key-value pairs are currently defined.
1119 <table name="Queue" title="QoS output queue.">
1120 <p>A configuration for a port output queue, used in configuring Quality of
1121 Service (QoS) features. May be referenced by <ref column="queues"
1122 table="QoS"/> column in <ref table="QoS"/> table.</p>
1124 <column name="other_config">
1125 <p>Key-value pairs for configuring the output queue. The supported
1126 key-value pairs and their meanings depend on the <ref column="type"/>
1127 of the <ref column="QoS"/> records that reference this row.</p>
1128 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1129 column="type"/> of <code>min-rate</code> are:</p>
1131 <dt><code>min-rate</code></dt>
1132 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1133 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1135 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1136 column="type"/> of <code>linux-htb</code> are:</p>
1138 <dt><code>min-rate</code></dt>
1139 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1140 <dt><code>max-rate</code></dt>
1141 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1142 queue's rate will not be allowed to exceed the specified value, even
1143 if excess bandwidth is available. If unspecified, defaults to no
1145 <dt><code>burst</code></dt>
1146 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1147 that a queue can accumulate while it is idle. Optional. Details of
1148 the <code>linux-htb</code> implementation require a minimum burst
1149 size, so a too-small <code>burst</code> will be silently
1151 <dt><code>priority</code></dt>
1152 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1153 unspecified. A queue with a smaller <code>priority</code>
1154 will receive all the excess bandwidth that it can use before
1155 a queue with a larger value receives any. Specific priority
1156 values are unimportant; only relative ordering matters.</dd>
1158 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1159 column="type"/> of <code>linux-hfsc</code> are:</p>
1161 <dt><code>min-rate</code></dt>
1162 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1163 <dt><code>max-rate</code></dt>
1164 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1165 queue's rate will not be allowed to exceed the specified value, even
1166 if excess bandwidth is available. If unspecified, defaults to no
1171 <column name="external_ids">
1172 Key-value pairs for use by external frameworks that integrate with Open
1173 vSwitch, rather than by Open vSwitch itself. System integrators should
1174 either use the Open vSwitch development mailing list to coordinate on
1175 common key-value definitions, or choose key names that are likely to be
1176 unique. No common key-value pairs are currently defined.
1180 <table name="Monitor" title="Connectivity Monitor configuration">
1182 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1183 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1184 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1185 to detect connectivity problems with each other. MPs within a MA should
1186 have complete and exclusive interconnectivity. This is verified by
1187 occasionally broadcasting Continuity Check Messages (CCMs) at a
1188 configurable transmission interval. A <ref table="Monitor"/> is
1189 responsible for collecting data about other MPs in its MA and
1193 <group title="Monitor Configuration">
1194 <column name="mpid">
1195 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1196 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1197 used to identify this <ref table="Monitor"/> to other endpoints in the
1201 <column name="remote_mps">
1202 A set of <ref table="Maintenance_Points"/> which this
1203 <ref table="Monitor"/> should have connectivity to. If this
1204 <ref table="Monitor"/> does not have connectivity to any MPs in this
1205 set, or has connectivity to any MPs not in this set, a fault is
1209 <column name="ma_name">
1210 A Maintenance Association (MA) name pairs with a Maintenance Domain
1211 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1212 have complete and exclusive interconnectivity. Defaults to
1213 <code>ovs</code> if unset.
1216 <column name="md_name">
1217 A Maintenance Domain name pairs with a Maintenance Association name to
1218 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1221 <column name="interval">
1222 The transmission interval of CCMs in milliseconds. Three missed CCMs
1223 indicate a connectivity fault. Defaults to 1000ms.
1227 <group title="Monitor Status">
1228 <column name="unexpected_remote_mpids">
1229 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1230 has detected connectivity that are not in the
1231 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1232 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1233 Thus, if this set is non-empty a fault is indicated.
1236 <column name="unexpected_remote_maids">
1237 A set of MAIDs representing foreign Maintenance Associations (MAs)
1238 which this <ref table="Monitor"/> has detected connectivity to. A
1239 <ref table="Monitor"/> should not have connectivity to a Maintenance
1240 Association other than its own. Thus, if this set is non-empty a fault
1244 <column name="fault">
1245 Indicates a Connectivity Fault caused by a configuration error, a down
1246 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1251 <table name="Maintenance_Point" title="Maintenance Point configuration">
1253 A <ref table="Maintenance_Point"/> represents a MP which a
1254 <ref table="Monitor"/> has or should have connectivity to.
1257 <group title="Maintenance_Point Configuration">
1258 <column name="mpid">
1259 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1260 a Maintenance Association. All MPs within a MA should have a unique
1265 <group title="Maintenance_Point Status">
1266 <column name="fault">
1267 Indicates a connectivity fault.
1272 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1273 <p>A port mirror within a <ref table="Bridge"/>.</p>
1274 <p>A port mirror configures a bridge to send selected frames to special
1275 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1276 traffic may also be referred to as SPAN or RSPAN, depending on the
1277 mechanism used for delivery.</p>
1279 <column name="name">
1280 Arbitrary identifier for the <ref table="Mirror"/>.
1283 <group title="Selecting Packets for Mirroring">
1284 <column name="select_all">
1285 If true, every packet arriving or departing on any port is
1286 selected for mirroring.
1289 <column name="select_dst_port">
1290 Ports on which departing packets are selected for mirroring.
1293 <column name="select_src_port">
1294 Ports on which arriving packets are selected for mirroring.
1297 <column name="select_vlan">
1298 VLANs on which packets are selected for mirroring. An empty set
1299 selects packets on all VLANs.
1303 <group title="Mirroring Destination Configuration">
1304 <column name="output_port">
1305 <p>Output port for selected packets, if nonempty. Mutually exclusive
1306 with <ref column="output_vlan"/>.</p>
1307 <p>Specifying a port for mirror output reserves that port exclusively
1308 for mirroring. No frames other than those selected for mirroring
1309 will be forwarded to the port, and any frames received on the port
1310 will be discarded.</p>
1311 <p>This type of mirroring is sometimes called SPAN.</p>
1314 <column name="output_vlan">
1315 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1316 with <ref column="output_port"/>.</p>
1317 <p>The frames will be sent out all ports that trunk
1318 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1319 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1320 trunk port, the frame's VLAN tag will be set to
1321 <ref column="output_vlan"/>, replacing any existing tag; when it is
1322 sent out an implicit VLAN port, the frame will not be tagged. This
1323 type of mirroring is sometimes called RSPAN.</p>
1324 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1325 contains unmanaged switches. Consider an unmanaged physical switch
1326 with two ports: port 1, connected to an end host, and port 2,
1327 connected to an Open vSwitch configured to mirror received packets
1328 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1329 port 1 that the physical switch forwards to port 2. The Open vSwitch
1330 forwards this packet to its destination and then reflects it back on
1331 port 2 in VLAN 123. This reflected packet causes the unmanaged
1332 physical switch to replace the MAC learning table entry, which
1333 correctly pointed to port 1, with one that incorrectly points to port
1334 2. Afterward, the physical switch will direct packets destined for
1335 the end host to the Open vSwitch on port 2, instead of to the end
1336 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1337 desired in this scenario, then the physical switch must be replaced
1338 by one that learns Ethernet addresses on a per-VLAN basis. In
1339 addition, learning should be disabled on the VLAN containing mirrored
1340 traffic. If this is not done then intermediate switches will learn
1341 the MAC address of each end host from the mirrored traffic. If
1342 packets being sent to that end host are also mirrored, then they will
1343 be dropped since the switch will attempt to send them out the input
1344 port. Disabling learning for the VLAN will cause the switch to
1345 correctly send the packet out all ports configured for that VLAN. If
1346 Open vSwitch is being used as an intermediate switch, learning can be
1347 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1348 in the appropriate <ref table="Bridge"/> table or tables.</p>
1352 <group title="Other Features">
1353 <column name="external_ids">
1354 Key-value pairs for use by external frameworks that integrate with Open
1355 vSwitch, rather than by Open vSwitch itself. System integrators should
1356 either use the Open vSwitch development mailing list to coordinate on
1357 common key-value definitions, or choose key names that are likely to be
1358 unique. No common key-value pairs are currently defined.
1363 <table name="Controller" title="OpenFlow controller configuration.">
1364 <p>An OpenFlow controller.</p>
1367 Open vSwitch supports two kinds of OpenFlow controllers:
1371 <dt>Primary controllers</dt>
1374 This is the kind of controller envisioned by the OpenFlow 1.0
1375 specification. Usually, a primary controller implements a network
1376 policy by taking charge of the switch's flow table.
1380 Open vSwitch initiates and maintains persistent connections to
1381 primary controllers, retrying the connection each time it fails or
1382 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1383 <ref table="Bridge"/> table applies to primary controllers.
1387 Open vSwitch permits a bridge to have any number of primary
1388 controllers. When multiple controllers are configured, Open
1389 vSwitch connects to all of them simultaneously. Because
1390 OpenFlow 1.0 does not specify how multiple controllers
1391 coordinate in interacting with a single switch, more than
1392 one primary controller should be specified only if the
1393 controllers are themselves designed to coordinate with each
1394 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1395 vendor extension may be useful for this.)
1398 <dt>Service controllers</dt>
1401 These kinds of OpenFlow controller connections are intended for
1402 occasional support and maintenance use, e.g. with
1403 <code>ovs-ofctl</code>. Usually a service controller connects only
1404 briefly to inspect or modify some of a switch's state.
1408 Open vSwitch listens for incoming connections from service
1409 controllers. The service controllers initiate and, if necessary,
1410 maintain the connections from their end. The <ref table="Bridge"
1411 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1412 not apply to service controllers.
1416 Open vSwitch supports configuring any number of service controllers.
1422 The <ref column="target"/> determines the type of controller.
1425 <group title="Core Features">
1426 <column name="target">
1427 <p>Connection method for controller.</p>
1429 The following connection methods are currently supported for primary
1433 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1435 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1436 the given <var>ip</var>, which must be expressed as an IP address
1437 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1438 column in the <ref table="Open_vSwitch"/> table must point to a
1439 valid SSL configuration when this form is used.</p>
1440 <p>SSL support is an optional feature that is not always built as
1441 part of Open vSwitch.</p>
1443 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1444 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1445 the given <var>ip</var>, which must be expressed as an IP address
1446 (not a DNS name).</dd>
1447 <dt><code>discover</code></dt>
1449 <p>Enables controller discovery.</p>
1450 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1451 request with vendor class identifier <code>OpenFlow</code> across
1452 all of the bridge's network devices. It will accept any valid
1453 DHCP reply that has the same vendor class identifier and includes
1454 a vendor-specific option with code 1 whose contents are a string
1455 specifying the location of the controller in the same format as
1456 <ref column="target"/>.</p>
1457 <p>The DHCP reply may also, optionally, include a vendor-specific
1458 option with code 2 whose contents are a string specifying the URI
1459 to the base of the OpenFlow PKI
1460 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1461 used only for bootstrapping the OpenFlow PKI at initial switch
1462 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1466 The following connection methods are currently supported for service
1470 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1473 Listens for SSL connections on the specified TCP <var>port</var>
1474 (default: 6633). If <var>ip</var>, which must be expressed as an
1475 IP address (not a DNS name), is specified, then connections are
1476 restricted to the specified local IP address.
1479 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1480 table="Open_vSwitch"/> table must point to a valid SSL
1481 configuration when this form is used.
1483 <p>SSL support is an optional feature that is not always built as
1484 part of Open vSwitch.</p>
1486 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1488 Listens for connections on the specified TCP <var>port</var>
1489 (default: 6633). If <var>ip</var>, which must be expressed as an
1490 IP address (not a DNS name), is specified, then connections are
1491 restricted to the specified local IP address.
1494 <p>When multiple controllers are configured for a single bridge, the
1495 <ref column="target"/> values must be unique. Duplicate
1496 <ref column="target"/> values yield unspecified results.</p>
1499 <column name="connection_mode">
1500 <p>If it is specified, this setting must be one of the following
1501 strings that describes how Open vSwitch contacts this OpenFlow
1502 controller over the network:</p>
1505 <dt><code>in-band</code></dt>
1506 <dd>In this mode, this controller's OpenFlow traffic travels over the
1507 bridge associated with the controller. With this setting, Open
1508 vSwitch allows traffic to and from the controller regardless of the
1509 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1510 would never be able to connect to the controller, because it did
1511 not have a flow to enable it.) This is the most common connection
1512 mode because it is not necessary to maintain two independent
1514 <dt><code>out-of-band</code></dt>
1515 <dd>In this mode, OpenFlow traffic uses a control network separate
1516 from the bridge associated with this controller, that is, the
1517 bridge does not use any of its own network devices to communicate
1518 with the controller. The control network must be configured
1519 separately, before or after <code>ovs-vswitchd</code> is started.
1523 <p>If not specified, the default is implementation-specific. If
1524 <ref column="target"/> is <code>discover</code>, the connection mode
1525 is always treated as <code>in-band</code> regardless of the actual
1530 <group title="Controller Failure Detection and Handling">
1531 <column name="max_backoff">
1532 Maximum number of milliseconds to wait between connection attempts.
1533 Default is implementation-specific.
1536 <column name="inactivity_probe">
1537 Maximum number of milliseconds of idle time on connection to
1538 controller before sending an inactivity probe message. If Open
1539 vSwitch does not communicate with the controller for the specified
1540 number of seconds, it will send a probe. If a response is not
1541 received for the same additional amount of time, Open vSwitch
1542 assumes the connection has been broken and attempts to reconnect.
1543 Default is implementation-specific.
1547 <group title="OpenFlow Rate Limiting">
1548 <column name="controller_rate_limit">
1549 <p>The maximum rate at which packets in unknown flows will be
1550 forwarded to the OpenFlow controller, in packets per second. This
1551 feature prevents a single bridge from overwhelming the controller.
1552 If not specified, the default is implementation-specific.</p>
1553 <p>In addition, when a high rate triggers rate-limiting, Open
1554 vSwitch queues controller packets for each port and transmits
1555 them to the controller at the configured rate. The number of
1556 queued packets is limited by
1557 the <ref column="controller_burst_limit"/> value. The packet
1558 queue is shared fairly among the ports on a bridge.</p><p>Open
1559 vSwitch maintains two such packet rate-limiters per bridge.
1560 One of these applies to packets sent up to the controller
1561 because they do not correspond to any flow. The other applies
1562 to packets sent up to the controller by request through flow
1563 actions. When both rate-limiters are filled with packets, the
1564 actual rate that packets are sent to the controller is up to
1565 twice the specified rate.</p>
1568 <column name="controller_burst_limit">
1569 In conjunction with <ref column="controller_rate_limit"/>,
1570 the maximum number of unused packet credits that the bridge will
1571 allow to accumulate, in packets. If not specified, the default
1572 is implementation-specific.
1576 <group title="Additional Discovery Configuration">
1577 <p>These values are considered only when <ref column="target"/>
1578 is <code>discover</code>.</p>
1580 <column name="discover_accept_regex">
1582 extended regular expression against which the discovered controller
1583 location is validated. The regular expression is implicitly
1584 anchored at the beginning of the controller location string, as
1585 if it begins with <code>^</code>. If not specified, the default
1586 is implementation-specific.
1589 <column name="discover_update_resolv_conf">
1590 Whether to update <code>/etc/resolv.conf</code> when the
1591 controller is discovered. If not specified, the default
1592 is implementation-specific. Open vSwitch will only modify
1593 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1594 specifies one or more DNS servers.
1598 <group title="Additional In-Band Configuration">
1599 <p>These values are considered only in in-band control mode (see
1600 <ref column="connection_mode"/>) and only when <ref column="target"/>
1601 is not <code>discover</code>. (For controller discovery, the network
1602 configuration obtained via DHCP is used instead.)</p>
1604 <p>When multiple controllers are configured on a single bridge, there
1605 should be only one set of unique values in these columns. If different
1606 values are set for these columns in different controllers, the effect
1609 <column name="local_ip">
1610 The IP address to configure on the local port,
1611 e.g. <code>192.168.0.123</code>. If this value is unset, then
1612 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1616 <column name="local_netmask">
1617 The IP netmask to configure on the local port,
1618 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1619 but this value is unset, then the default is chosen based on whether
1620 the IP address is class A, B, or C.
1623 <column name="local_gateway">
1624 The IP address of the gateway to configure on the local port, as a
1625 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1626 this network has no gateway.
1630 <group title="Other Features">
1631 <column name="external_ids">
1632 Key-value pairs for use by external frameworks that integrate with Open
1633 vSwitch, rather than by Open vSwitch itself. System integrators should
1634 either use the Open vSwitch development mailing list to coordinate on
1635 common key-value definitions, or choose key names that are likely to be
1636 unique. No common key-value pairs are currently defined.
1641 <table name="Manager" title="OVSDB management connection.">
1643 Configuration for a database connection to an Open vSwitch database
1648 This table primarily configures the Open vSwitch database
1649 (<code>ovsdb-server</code>), not the Open vSwitch switch
1650 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1651 what connections should be treated as in-band.
1655 The Open vSwitch database server can initiate and maintain active
1656 connections to remote clients. It can also listen for database
1660 <group title="Core Features">
1661 <column name="target">
1662 <p>Connection method for managers.</p>
1664 The following connection methods are currently supported:
1667 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1670 The specified SSL <var>port</var> (default: 6632) on the host at
1671 the given <var>ip</var>, which must be expressed as an IP address
1672 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1673 column in the <ref table="Open_vSwitch"/> table must point to a
1674 valid SSL configuration when this form is used.
1677 SSL support is an optional feature that is not always built as
1678 part of Open vSwitch.
1682 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1684 The specified TCP <var>port</var> (default: 6632) on the host at
1685 the given <var>ip</var>, which must be expressed as an IP address
1688 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1691 Listens for SSL connections on the specified TCP <var>port</var>
1692 (default: 6632). If <var>ip</var>, which must be expressed as an
1693 IP address (not a DNS name), is specified, then connections are
1694 restricted to the specified local IP address.
1697 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1698 table="Open_vSwitch"/> table must point to a valid SSL
1699 configuration when this form is used.
1702 SSL support is an optional feature that is not always built as
1703 part of Open vSwitch.
1706 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1708 Listens for connections on the specified TCP <var>port</var>
1709 (default: 6632). If <var>ip</var>, which must be expressed as an
1710 IP address (not a DNS name), is specified, then connections are
1711 restricted to the specified local IP address.
1714 <p>When multiple managers are configured, the <ref column="target"/>
1715 values must be unique. Duplicate <ref column="target"/> values yield
1716 unspecified results.</p>
1719 <column name="connection_mode">
1721 If it is specified, this setting must be one of the following strings
1722 that describes how Open vSwitch contacts this OVSDB client over the
1727 <dt><code>in-band</code></dt>
1729 In this mode, this connection's traffic travels over a bridge
1730 managed by Open vSwitch. With this setting, Open vSwitch allows
1731 traffic to and from the client regardless of the contents of the
1732 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
1733 to connect to the client, because it did not have a flow to enable
1734 it.) This is the most common connection mode because it is not
1735 necessary to maintain two independent networks.
1737 <dt><code>out-of-band</code></dt>
1739 In this mode, the client's traffic uses a control network separate
1740 from that managed by Open vSwitch, that is, Open vSwitch does not
1741 use any of its own network devices to communicate with the client.
1742 The control network must be configured separately, before or after
1743 <code>ovs-vswitchd</code> is started.
1748 If not specified, the default is implementation-specific.
1753 <group title="Client Failure Detection and Handling">
1754 <column name="max_backoff">
1755 Maximum number of milliseconds to wait between connection attempts.
1756 Default is implementation-specific.
1759 <column name="inactivity_probe">
1760 Maximum number of milliseconds of idle time on connection to the client
1761 before sending an inactivity probe message. If Open vSwitch does not
1762 communicate with the client for the specified number of seconds, it
1763 will send a probe. If a response is not received for the same
1764 additional amount of time, Open vSwitch assumes the connection has been
1765 broken and attempts to reconnect. Default is implementation-specific.
1769 <group title="Other Features">
1770 <column name="external_ids">
1771 Key-value pairs for use by external frameworks that integrate with Open
1772 vSwitch, rather than by Open vSwitch itself. System integrators should
1773 either use the Open vSwitch development mailing list to coordinate on
1774 common key-value definitions, or choose key names that are likely to be
1775 unique. No common key-value pairs are currently defined.
1780 <table name="NetFlow">
1781 A NetFlow target. NetFlow is a protocol that exports a number of
1782 details about terminating IP flows, such as the principals involved
1785 <column name="targets">
1786 NetFlow targets in the form
1787 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
1788 must be specified numerically, not as a DNS name.
1791 <column name="engine_id">
1792 Engine ID to use in NetFlow messages. Defaults to datapath index
1796 <column name="engine_type">
1797 Engine type to use in NetFlow messages. Defaults to datapath
1798 index if not specified.
1801 <column name="active_timeout">
1802 The interval at which NetFlow records are sent for flows that are
1803 still active, in seconds. A value of <code>0</code> requests the
1804 default timeout (currently 600 seconds); a value of <code>-1</code>
1805 disables active timeouts.
1808 <column name="add_id_to_interface">
1809 <p>If this column's value is <code>false</code>, the ingress and egress
1810 interface fields of NetFlow flow records are derived from OpenFlow port
1811 numbers. When it is <code>true</code>, the 7 most significant bits of
1812 these fields will be replaced by the least significant 7 bits of the
1813 engine id. This is useful because many NetFlow collectors do not
1814 expect multiple switches to be sending messages from the same host, so
1815 they do not store the engine information which could be used to
1816 disambiguate the traffic.</p>
1817 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
1820 <column name="external_ids">
1821 Key-value pairs for use by external frameworks that integrate with Open
1822 vSwitch, rather than by Open vSwitch itself. System integrators should
1823 either use the Open vSwitch development mailing list to coordinate on
1824 common key-value definitions, or choose key names that are likely to be
1825 unique. No common key-value pairs are currently defined.
1830 SSL configuration for an Open_vSwitch.
1832 <column name="private_key">
1833 Name of a PEM file containing the private key used as the switch's
1834 identity for SSL connections to the controller.
1837 <column name="certificate">
1838 Name of a PEM file containing a certificate, signed by the
1839 certificate authority (CA) used by the controller and manager,
1840 that certifies the switch's private key, identifying a trustworthy
1844 <column name="ca_cert">
1845 Name of a PEM file containing the CA certificate used to verify
1846 that the switch is connected to a trustworthy controller.
1849 <column name="bootstrap_ca_cert">
1850 If set to <code>true</code>, then Open vSwitch will attempt to
1851 obtain the CA certificate from the controller on its first SSL
1852 connection and save it to the named PEM file. If it is successful,
1853 it will immediately drop the connection and reconnect, and from then
1854 on all SSL connections must be authenticated by a certificate signed
1855 by the CA certificate thus obtained. <em>This option exposes the
1856 SSL connection to a man-in-the-middle attack obtaining the initial
1857 CA certificate.</em> It may still be useful for bootstrapping.
1860 <column name="external_ids">
1861 Key-value pairs for use by external frameworks that integrate with Open
1862 vSwitch, rather than by Open vSwitch itself. System integrators should
1863 either use the Open vSwitch development mailing list to coordinate on
1864 common key-value definitions, or choose key names that are likely to be
1865 unique. No common key-value pairs are currently defined.
1869 <table name="sFlow">
1870 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
1873 <column name="agent">
1874 Name of the network device whose IP address should be reported as the
1875 ``agent address'' to collectors. If not specified, the IP address
1876 defaults to the <ref table="Controller" column="local_ip"/> in the
1877 collector's <ref table="Controller"/>. If an agent IP address cannot be
1878 determined either way, sFlow is disabled.
1881 <column name="header">
1882 Number of bytes of a sampled packet to send to the collector.
1883 If not specified, the default is 128 bytes.
1886 <column name="polling">
1887 Polling rate in seconds to send port statistics to the collector.
1888 If not specified, defaults to 30 seconds.
1891 <column name="sampling">
1892 Rate at which packets should be sampled and sent to the collector.
1893 If not specified, defaults to 400, which means one out of 400
1894 packets, on average, will be sent to the collector.
1897 <column name="targets">
1898 sFlow targets in the form
1899 <code><var>ip</var>:<var>port</var></code>.
1902 <column name="external_ids">
1903 Key-value pairs for use by external frameworks that integrate with Open
1904 vSwitch, rather than by Open vSwitch itself. System integrators should
1905 either use the Open vSwitch development mailing list to coordinate on
1906 common key-value definitions, or choose key names that are likely to be
1907 unique. No common key-value pairs are currently defined.
1911 <table name="Capability">
1912 <p>Records in this table describe functionality supported by the hardware
1913 and software platform on which this Open vSwitch is based. Clients
1914 should not modify this table.</p>
1916 <p>A record in this table is meaningful only if it is referenced by the
1917 <ref table="Open_vSwitch" column="capabilities"/> column in the
1918 <ref table="Open_vSwitch"/> table. The key used to reference it, called
1919 the record's ``category,'' determines the meanings of the
1920 <ref column="details"/> column. The following general forms of
1921 categories are currently defined:</p>
1924 <dt><code>qos-<var>type</var></code></dt>
1925 <dd><var>type</var> is supported as the value for
1926 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
1930 <column name="details">
1931 <p>Key-value pairs that describe capabilities. The meaning of the pairs
1932 depends on the category key that the <ref table="Open_vSwitch"
1933 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1934 uses to reference this record, as described above.</p>
1936 <p>The presence of a record for category <code>qos-<var>type</var></code>
1937 indicates that the switch supports <var>type</var> as the value of
1938 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
1939 table. The following key-value pairs are defined to further describe
1940 QoS capabilities:</p>
1943 <dt><code>n-queues</code></dt>
1944 <dd>Number of supported queues, as a positive integer. Keys in the
1945 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
1946 records whose <ref table="QoS" column="type"/> value
1947 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob