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-type</code></dt>
32 <dd>An identifier for the switch type, such as
33 <code>XenServer</code> or <code>KVM</code>.</dd>
34 <dt><code>system-version</code></dt>
35 <dd>The version of the switch software, such as
36 <code>5.6.0</code> on XenServer.</dd>
37 <dt><code>system-id</code></dt>
38 <dd>A unique identifier for the Open vSwitch's physical host.
39 The form of the identifier depends on the type of the host.
40 On a Citrix XenServer, this will likely be the same as
41 <code>xs-system-uuid</code>.</dd>
42 <dt><code>xs-system-uuid</code></dt>
43 <dd>The Citrix XenServer universally unique identifier for the
44 physical host as displayed by <code>xe host-list</code>.</dd>
49 <group title="Status">
50 <column name="next_cfg">
51 Sequence number for client to increment. When a client modifies
52 any part of the database configuration and wishes to wait for
53 Open vSwitch to finish applying the changes, it may increment
57 <column name="cur_cfg">
58 Sequence number that Open vSwitch sets to the current value of
59 <ref column="next_cfg"/> after it finishes applying a set of
60 configuration changes.
63 <column name="capabilities">
64 Describes functionality supported by the hardware and software platform
65 on which this Open vSwitch is based. Clients should not modify this
66 column. See the <ref table="Capability"/> description for defined
67 capability categories and the meaning of associated
68 <ref table="Capability"/> records.
71 <column name="statistics">
73 Key-value pairs that report statistics about a system running an Open
74 vSwitch. These are updated periodically (currently, every 5
75 seconds). Key-value pairs that cannot be determined or that do not
76 apply to a platform are omitted.
80 <dt><code>cpu</code></dt>
83 Number of CPU processors, threads, or cores currently online and
84 available to the operating system on which Open vSwitch is
85 running, as an integer. This may be less than the number
86 installed, if some are not online or if they are not available to
90 Open vSwitch userspace processes are not multithreaded, but the
91 Linux kernel-based datapath is.
95 <dt><code>load_average</code></dt>
98 A comma-separated list of three floating-point numbers,
99 representing the system load average over the last 1, 5, and 15
100 minutes, respectively.
104 <dt><code>memory</code></dt>
107 A comma-separated list of integers, each of which represents a
108 quantity of memory in kilobytes that describes the operating
109 system on which Open vSwitch is running. In respective order,
114 <li>Total amount of RAM allocated to the OS.</li>
115 <li>RAM allocated to the OS that is in use.</li>
116 <li>RAM that can be flushed out to disk or otherwise discarded
117 if that space is needed for another purpose. This number is
118 necessarily less than or equal to the previous value.</li>
119 <li>Total disk space allocated for swap.</li>
120 <li>Swap space currently in use.</li>
124 On Linux, all five values can be determined and are included. On
125 other operating systems, only the first two values can be
126 determined, so the list will only have two values.
130 <dt><code>process_</code><var>name</var></dt>
133 One such key-value pair will exist for each running Open vSwitch
134 daemon process, with <var>name</var> replaced by the daemon's
135 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
136 comma-separated list of integers. The integers represent the
137 following, with memory measured in kilobytes and durations in
142 <li>The process's virtual memory size.</li>
143 <li>The process's resident set size.</li>
144 <li>The amount of user and system CPU time consumed by the
146 <li>The number of times that the process has crashed and been
147 automatically restarted by the monitor.</li>
148 <li>The duration since the process was started.</li>
149 <li>The duration for which the process has been running.</li>
153 The interpretation of some of these values depends on whether the
154 process was started with the <option>--monitor</option>. If it
155 was not, then the crash count will always be 0 and the two
156 durations will always be the same. If <option>--monitor</option>
157 was given, then the crash count may be positive; if it is, the
158 latter duration is the amount of time since the most recent crash
163 There will be one key-value pair for each file in Open vSwitch's
164 ``run directory'' (usually <code>/var/run/openvswitch</code>)
165 whose name ends in <code>.pid</code>, whose contents are a
166 process ID, and which is locked by a running process. The
167 <var>name</var> is taken from the pidfile's name.
171 Currently Open vSwitch is only able to obtain all of the above
172 detail on Linux systems. On other systems, the same key-value
173 pairs will be present but the values will always be the empty
178 <dt><code>file_systems</code></dt>
181 A space-separated list of information on local, writable file
182 systems. Each item in the list describes one file system and
183 consists in turn of a comma-separated list of the following:
187 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
188 Any spaces or commas in the mount point are replaced by
190 <li>Total size, in kilobytes, as an integer.</li>
191 <li>Amount of storage in use, in kilobytes, as an integer.</li>
195 This key-value pair is omitted if there are no local, writable
196 file systems or if Open vSwitch cannot obtain the needed
204 <group title="Database Configuration">
206 These columns primarily configure the Open vSwitch database
207 (<code>ovsdb-server</code>), not the Open vSwitch switch
208 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
209 column="ssl"/> settings.
213 The Open vSwitch switch does read the database configuration to
214 determine remote IP addresses to which in-band control should apply.
217 <column name="manager_options">
218 Database clients to which the Open vSwitch database server should
219 connect or to which it should listen, along with options for how these
220 connection should be configured. See the <ref table="Manager"/> table
221 for more information.
224 <column name="managers">
226 Remote database clients to which the Open vSwitch's database server
227 should connect or to which it should listen. Adding an OVSDB target
228 to this set is equivalent to adding it to <ref
229 column="manager_options"/> with all of the default options.
233 Use of this column is deprecated and may be removed sometime in the
234 future. New applications should use and set <ref
235 column="manager_options"/> instead.
241 <table name="Bridge">
243 Configuration for a bridge within an
244 <ref table="Open_vSwitch"/>.
247 A <ref table="Bridge"/> record represents an Ethernet switch with one or
248 more ``ports,'' which are the <ref table="Port"/> records pointed to by
249 the <ref table="Bridge"/>'s <ref column="ports"/> column.
252 <group title="Core Features">
254 Bridge identifier. Should be alphanumeric and no more than about 8
255 bytes long. Must be unique among the names of ports, interfaces, and
259 <column name="ports">
260 Ports included in the bridge.
263 <column name="mirrors">
264 Port mirroring configuration.
267 <column name="netflow">
268 NetFlow configuration.
271 <column name="sflow">
275 <column name="flood_vlans">
276 VLAN IDs of VLANs on which MAC address learning should be disabled, so
277 that packets are flooded instead of being sent to specific ports that
278 are believed to contain packets' destination MACs. This should
279 ordinarily be used to disable MAC learning on VLANs used for mirroring
280 (RSPAN VLANs). It may also be useful for debugging.
284 <group title="OpenFlow Configuration">
285 <column name="controller">
286 OpenFlow controller set. If unset, then no OpenFlow controllers
290 <column name="fail_mode">
291 <p>When a controller is configured, it is, ordinarily, responsible
292 for setting up all flows on the switch. Thus, if the connection to
293 the controller fails, no new network connections can be set up.
294 If the connection to the controller stays down long enough,
295 no packets can pass through the switch at all. This setting
296 determines the switch's response to such a situation. It may be set
297 to one of the following:
299 <dt><code>standalone</code></dt>
300 <dd>If no message is received from the controller for three
301 times the inactivity probe interval
302 (see <ref column="inactivity_probe"/>), then Open vSwitch
303 will take over responsibility for setting up flows. In
304 this mode, Open vSwitch causes the bridge to act like an
305 ordinary MAC-learning switch. Open vSwitch will continue
306 to retry connecting to the controller in the background
307 and, when the connection succeeds, it will discontinue its
308 standalone behavior.</dd>
309 <dt><code>secure</code></dt>
310 <dd>Open vSwitch will not set up flows on its own when the
311 controller connection fails or when no controllers are
312 defined. The bridge will continue to retry connecting to
313 any defined controllers forever.</dd>
316 <p>If this value is unset, the default is implementation-specific.</p>
317 <p>When more than one controller is configured,
318 <ref column="fail_mode"/> is considered only when none of the
319 configured controllers can be contacted.</p>
322 <column name="datapath_id">
323 Reports the OpenFlow datapath ID in use. Exactly 16 hex
324 digits. (Setting this column will have no useful effect. Set
325 <ref column="other_config"/>:<code>other-config</code>
330 <group title="Other Features">
331 <column name="datapath_type">
332 Name of datapath provider. The kernel datapath has
333 type <code>system</code>. The userspace datapath has
334 type <code>netdev</code>.
337 <column name="external_ids">
338 Key-value pairs for use by external frameworks that integrate
339 with Open vSwitch, rather than by Open vSwitch itself. System
340 integrators should either use the Open vSwitch development
341 mailing list to coordinate on common key-value definitions, or
342 choose key names that are likely to be unique. The currently
343 defined key-value pairs are:
345 <dt><code>bridge-id</code></dt>
346 <dd>A unique identifier of the bridge. On Citrix XenServer this
347 will commonly be the same as <code>xs-network-uuids</code>.</dd>
348 <dt><code>xs-network-uuids</code></dt>
349 <dd>Semicolon-delimited set of universally unique identifier(s) for
350 the network with which this bridge is associated on a Citrix
351 XenServer host. The network identifiers are RFC 4122 UUIDs as
352 displayed by, e.g., <code>xe network-list</code>.</dd>
356 <column name="other_config">
357 Key-value pairs for configuring rarely used bridge
358 features. The currently defined key-value pairs are:
360 <dt><code>datapath-id</code></dt>
362 digits to set the OpenFlow datapath ID to a specific
363 value. May not be all-zero.</dd>
364 <dt><code>disable-in-band</code></dt>
365 <dd>If set to <code>true</code>, disable in-band control on
366 the bridge regardless of controller and manager settings.</dd>
367 <dt><code>hwaddr</code></dt>
368 <dd>An Ethernet address in the form
369 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
370 to set the hardware address of the local port and influence the
372 <dt><code>in-band-queue</code></dt>
374 A queue ID as a nonnegative integer. This sets the OpenFlow queue
375 ID that will be used by flows set up by in-band control on this
376 bridge. If unset, or if the port used by an in-band control flow
377 does not have QoS configured, or if the port does not have a queue
378 with the specified ID, the default queue is used instead.
385 <table name="Port" table="Port or bond configuration.">
386 <p>A port within a <ref table="Bridge"/>.</p>
387 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
388 <ref column="interfaces"/> column. Such a port logically
389 corresponds to a port on a physical Ethernet switch. A port
390 with more than one interface is a ``bonded port'' (see
391 <ref group="Bonding Configuration"/>).</p>
392 <p>Some properties that one might think as belonging to a port are actually
393 part of the port's <ref table="Interface"/> members.</p>
396 Port name. Should be alphanumeric and no more than about 8
397 bytes long. May be the same as the interface name, for
398 non-bonded ports. Must otherwise be unique among the names of
399 ports, interfaces, and bridges on a host.
402 <column name="interfaces">
403 The port's interfaces. If there is more than one, this is a
407 <group title="VLAN Configuration">
408 <p>A bridge port must be configured for VLANs in one of two
409 mutually exclusive ways:
411 <li>A ``trunk port'' has an empty value for <ref
412 column="tag"/>. Its <ref column="trunks"/> value may be
413 empty or non-empty.</li>
414 <li>An ``implicitly tagged VLAN port'' or ``access port''
415 has an nonempty value for <ref column="tag"/>. Its
416 <ref column="trunks"/> value must be empty.</li>
418 If <ref column="trunks"/> and <ref column="tag"/> are both
419 nonempty, the configuration is ill-formed.
424 If this is an access port (see above), the port's implicitly
425 tagged VLAN. Must be empty if this is a trunk port.
428 Frames arriving on trunk ports will be forwarded to this
429 port only if they are tagged with the given VLAN (or, if
430 <ref column="tag"/> is 0, then if they lack a VLAN header).
431 Frames arriving on other access ports will be forwarded to
432 this port only if they have the same <ref column="tag"/>
433 value. Frames forwarded to this port will not have an
437 When a frame with a 802.1Q header that indicates a nonzero
438 VLAN is received on an access port, it is discarded.
442 <column name="trunks">
444 If this is a trunk port (see above), the 802.1Q VLAN(s) that
445 this port trunks; if it is empty, then the port trunks all
446 VLANs. Must be empty if this is an access port.
449 Frames arriving on trunk ports are dropped if they are not
450 in one of the specified VLANs. For this purpose, packets
451 that have no VLAN header are treated as part of VLAN 0.
456 <group title="Bonding Configuration">
457 <p>A port that has more than one interface is a ``bonded port.''
458 Bonding allows for load balancing and fail-over. Open vSwitch
459 supports ``source load balancing'' (SLB) bonding, which
460 assigns flows to slaves based on source MAC address, with
461 periodic rebalancing as traffic patterns change. This form of
462 bonding does not require 802.3ad or other special support from
463 the upstream switch to which the slave devices are
466 <p>These columns apply only to bonded ports. Their values are
467 otherwise ignored.</p>
469 <column name="bond_updelay">
470 <p>For a bonded port, the number of milliseconds for which carrier must
471 stay up on an interface before the interface is considered to be up.
472 Specify <code>0</code> to enable the interface immediately.</p>
473 <p>This setting is honored only when at least one bonded interface is
474 already enabled. When no interfaces are enabled, then the first bond
475 interface to come up is enabled immediately.</p>
478 <column name="bond_downdelay">
479 For a bonded port, the number of milliseconds for which carrier must
480 stay down on an interface before the interface is considered to be
481 down. Specify <code>0</code> to disable the interface immediately.
484 <column name="bond_fake_iface">
485 For a bonded port, whether to create a fake internal interface with the
486 name of the port. Use only for compatibility with legacy software that
491 <group title="Other Features">
493 Quality of Service configuration for this port.
497 The MAC address to use for this port for the purpose of choosing the
498 bridge's MAC address. This column does not necessarily reflect the
499 port's actual MAC address, nor will setting it change the port's actual
503 <column name="fake_bridge">
504 Does this port represent a sub-bridge for its tagged VLAN within the
505 Bridge? See ovs-vsctl(8) for more information.
508 <column name="external_ids">
510 Key-value pairs for use by external frameworks that integrate with
511 Open vSwitch, rather than by Open vSwitch itself. System integrators
512 should either use the Open vSwitch development mailing list to
513 coordinate on common key-value definitions, or choose key names that
514 are likely to be unique.
517 No key-value pairs native to <ref table="Port"/> are currently
518 defined. For fake bridges (see the <ref column="fake_bridge"/>
519 column), external IDs for the fake bridge are defined here by
520 prefixing a <ref table="Bridge"/> <ref table="Bridge"
521 column="external_ids"/> key with <code>fake-bridge-</code>,
522 e.g. <code>fake-bridge-xs-network-uuids</code>.
526 <column name="other_config">
527 Key-value pairs for configuring rarely used port features. The
528 currently defined key-value pairs are:
530 <dt><code>hwaddr</code></dt>
531 <dd>An Ethernet address in the form
532 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
533 <dt><code>bond-rebalance-interval</code></dt>
534 <dd>For a bonded port, the number of milliseconds between
535 successive attempts to rebalance the bond, that is, to
536 move source MACs and their flows from one interface on
537 the bond to another in an attempt to keep usage of each
538 interface roughly equal. The default is 10000 (10
539 seconds), and the minimum is 1000 (1 second).</dd>
545 <table name="Interface" title="One physical network device in a Port.">
546 An interface within a <ref table="Port"/>.
548 <group title="Core Features">
550 Interface name. Should be alphanumeric and no more than about 8 bytes
551 long. May be the same as the port name, for non-bonded ports. Must
552 otherwise be unique among the names of ports, interfaces, and bridges
557 <p>Ethernet address to set for this interface. If unset then the
558 default MAC address is used:</p>
560 <li>For the local interface, the default is the lowest-numbered MAC
561 address among the other bridge ports, either the value of the
562 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
563 if set, or its actual MAC (for bonded ports, the MAC of its slave
564 whose name is first in alphabetical order). Internal ports and
565 bridge ports that are used as port mirroring destinations (see the
566 <ref table="Mirror"/> table) are ignored.</li>
567 <li>For other internal interfaces, the default MAC is randomly
569 <li>External interfaces typically have a MAC address associated with
572 <p>Some interfaces may not have a software-controllable MAC
576 <column name="ofport">
577 <p>OpenFlow port number for this interface. Unlike most columns, this
578 column's value should be set only by Open vSwitch itself. Other
579 clients should set this column to an empty set (the default) when
580 creating an <ref table="Interface"/>.</p>
581 <p>Open vSwitch populates this column when the port number becomes
582 known. If the interface is successfully added,
583 <ref column="ofport"/> will be set to a number between 1 and 65535
584 (generally either in the range 1 to 65279, inclusive, or 65534, the
585 port number for the OpenFlow ``local port''). If the interface
586 cannot be added then Open vSwitch sets this column
591 <group title="System-Specific Details">
593 The interface type, one of:
595 <dt><code>system</code></dt>
596 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
597 Sometimes referred to as ``external interfaces'' since they are
598 generally connected to hardware external to that on which the Open
599 vSwitch is running. The empty string is a synonym for
600 <code>system</code>.</dd>
601 <dt><code>internal</code></dt>
602 <dd>A simulated network device that sends and receives traffic. An
603 internal interface whose <ref column="name"/> is the same as its
604 bridge's <ref table="Open_vSwitch" column="name"/> is called the
605 ``local interface.'' It does not make sense to bond an internal
606 interface, so the terms ``port'' and ``interface'' are often used
607 imprecisely for internal interfaces.</dd>
608 <dt><code>tap</code></dt>
609 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
610 <dt><code>gre</code></dt>
611 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
612 tunnel. Each tunnel must be uniquely identified by the
613 combination of <code>remote_ip</code>, <code>local_ip</code>, and
614 <code>in_key</code>. Note that if two ports are defined that are
615 the same except one has an optional identifier and the other does
616 not, the more specific one is matched first. <code>in_key</code>
617 is considered more specific than <code>local_ip</code> if a port
618 defines one and another port defines the other. The following
619 options may be specified in the <ref column="options"/> column:
621 <dt><code>remote_ip</code></dt>
622 <dd>Required. The tunnel endpoint.</dd>
625 <dt><code>local_ip</code></dt>
626 <dd>Optional. The destination IP that received packets must
627 match. Default is to match all addresses.</dd>
630 <dt><code>in_key</code></dt>
631 <dd>Optional. The GRE key that received packets must contain.
632 It may either be a 32-bit number (no key and a key of 0 are
633 treated as equivalent) or the word <code>flow</code>. If
634 <code>flow</code> is specified then any key will be accepted
635 and the key will be placed in the <code>tun_id</code> field
636 for matching in the flow table. The ovs-ofctl manual page
637 contains additional information about matching fields in
638 OpenFlow flows. Default is no key.</dd>
641 <dt><code>out_key</code></dt>
642 <dd>Optional. The GRE key to be set on outgoing packets. It may
643 either be a 32-bit number or the word <code>flow</code>. If
644 <code>flow</code> is specified then the key may be set using
645 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
646 is used in the absence of an action). The ovs-ofctl manual
647 page contains additional information about the Nicira OpenFlow
648 vendor extensions. Default is no key.</dd>
651 <dt><code>key</code></dt>
652 <dd>Optional. Shorthand to set <code>in_key</code> and
653 <code>out_key</code> at the same time.</dd>
656 <dt><code>tos</code></dt>
657 <dd>Optional. The value of the ToS bits to be set on the
658 encapsulating packet. It may also be the word
659 <code>inherit</code>, in which case the ToS will be copied from
660 the inner packet if it is IPv4 or IPv6 (otherwise it will be
661 0). Note that the ECN fields are always inherited. Default is
665 <dt><code>ttl</code></dt>
666 <dd>Optional. The TTL to be set on the encapsulating packet.
667 It may also be the word <code>inherit</code>, in which case the
668 TTL will be copied from the inner packet if it is IPv4 or IPv6
669 (otherwise it will be the system default, typically 64).
670 Default is the system default TTL.</dd>
673 <dt><code>csum</code></dt>
674 <dd>Optional. Compute GRE checksums on outgoing packets.
675 Checksums present on incoming packets will be validated
676 regardless of this setting. Note that GRE checksums
677 impose a significant performance penalty as they cover the
678 entire packet. As the contents of the packet is typically
679 covered by L3 and L4 checksums, this additional checksum only
680 adds value for the GRE and encapsulated Ethernet headers.
681 Default is disabled, set to <code>true</code> to enable.</dd>
684 <dt><code>pmtud</code></dt>
685 <dd>Optional. Enable tunnel path MTU discovery. If enabled
686 ``ICMP destination unreachable - fragmentation'' needed
687 messages will be generated for IPv4 packets with the DF bit set
688 and IPv6 packets above the minimum MTU if the packet size
689 exceeds the path MTU minus the size of the tunnel headers. It
690 also forces the encapsulating packet DF bit to be set (it is
691 always set if the inner packet implies path MTU discovery).
692 Note that this option causes behavior that is typically
693 reserved for routers and therefore is not entirely in
694 compliance with the IEEE 802.1D specification for bridges.
695 Default is enabled, set to <code>false</code> to disable.</dd>
698 <dt><code>header_cache</code></dt>
699 <dd>Optional. Enable caching of tunnel headers and the output
700 path. This can lead to a significant performance increase
701 without changing behavior. In general it should not be
702 necessary to adjust this setting. However, the caching can
703 bypass certain components of the IP stack (such as IP tables)
704 and it may be useful to disable it if these features are
705 required or as a debugging measure. Default is enabled, set to
706 <code>false</code> to disable. If IPsec is enabled through the
707 <ref column="other_config"/> parameters, header caching will be
708 automatically disabled.</dd>
711 <dt><code>capwap</code></dt>
712 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
713 (RFC 5415). This allows interoperability with certain switches
714 where GRE is not available. Note that only the tunneling component
715 of the protocol is implemented. Due to the non-standard use of
716 CAPWAP, UDP ports 58881 and 58882 are used as the source and
717 destinations ports respectivedly. Each tunnel must be uniquely
718 identified by the combination of <code>remote_ip</code> and
719 <code>local_ip</code>. If two ports are defined that are the same
720 except one includes <code>local_ip</code> and the other does not,
721 the more specific one is matched first. CAPWAP support is not
722 available on all platforms. Currently it is only supported in the
723 Linux kernel module with kernel versions >= 2.6.25. The following
724 options may be specified in the <ref column="options"/> column:
726 <dt><code>remote_ip</code></dt>
727 <dd>Required. The tunnel endpoint.</dd>
730 <dt><code>local_ip</code></dt>
731 <dd>Optional. The destination IP that received packets must
732 match. Default is to match all addresses.</dd>
735 <dt><code>tos</code></dt>
736 <dd>Optional. The value of the ToS bits to be set on the
737 encapsulating packet. It may also be the word
738 <code>inherit</code>, in which case the ToS will be copied from
739 the inner packet if it is IPv4 or IPv6 (otherwise it will be
740 0). Note that the ECN fields are always inherited. Default is
744 <dt><code>ttl</code></dt>
745 <dd>Optional. The TTL to be set on the encapsulating packet.
746 It may also be the word <code>inherit</code>, in which case the
747 TTL will be copied from the inner packet if it is IPv4 or IPv6
748 (otherwise it will be the system default, typically 64).
749 Default is the system default TTL.</dd>
752 <dt><code>pmtud</code></dt>
753 <dd>Optional. Enable tunnel path MTU discovery. If enabled
754 ``ICMP destination unreachable - fragmentation'' needed
755 messages will be generated for IPv4 packets with the DF bit set
756 and IPv6 packets above the minimum MTU if the packet size
757 exceeds the path MTU minus the size of the tunnel headers. It
758 also forces the encapsulating packet DF bit to be set (it is
759 always set if the inner packet implies path MTU discovery).
760 Note that this option causes behavior that is typically
761 reserved for routers and therefore is not entirely in
762 compliance with the IEEE 802.1D specification for bridges.
763 Default is enabled, set to <code>false</code> to disable.</dd>
766 <dt><code>header_cache</code></dt>
767 <dd>Optional. Enable caching of tunnel headers and the output
768 path. This can lead to a significant performance increase
769 without changing behavior. In general it should not be
770 necessary to adjust this setting. However, the caching can
771 bypass certain components of the IP stack (such as IP tables)
772 and it may be useful to disable it if these features are
773 required or as a debugging measure. Default is enabled, set to
774 <code>false</code> to disable.</dd>
777 <dt><code>patch</code></dt>
780 A pair of virtual devices that act as a patch cable. The <ref
781 column="options"/> column must have the following key-value pair:
784 <dt><code>peer</code></dt>
786 The <ref column="name"/> of the <ref table="Interface"/> for
787 the other side of the patch. The named <ref
788 table="Interface"/>'s own <code>peer</code> option must specify
789 this <ref table="Interface"/>'s name. That is, the two patch
790 interfaces must have reversed <ref column="name"/> and
791 <code>peer</code> values.
798 <column name="options">
799 Configuration options whose interpretation varies based on
800 <ref column="type"/>.
803 <column name="status">
805 Key-value pairs that report port status. Supported status
806 values are <code>type</code>-dependent.
808 <p>The only currently defined key-value pair is:</p>
810 <dt><code>source_ip</code></dt>
811 <dd>The source IP address used for an IPv4 tunnel end-point,
812 such as <code>gre</code> or <code>capwap</code>. Not
813 supported by all implementations.</dd>
818 <group title="Ingress Policing">
820 These settings control ingress policing for packets received on this
821 interface. On a physical interface, this limits the rate at which
822 traffic is allowed into the system from the outside; on a virtual
823 interface (one connected to a virtual machine), this limits the rate at
824 which the VM is able to transmit.
827 Policing is a simple form of quality-of-service that simply drops
828 packets received in excess of the configured rate. Due to its
829 simplicity, policing is usually less accurate and less effective than
830 egress QoS (which is configured using the <ref table="QoS"/> and <ref
831 table="Queue"/> tables).
834 Policing is currently implemented only on Linux. The Linux
835 implementation uses a simple ``token bucket'' approach:
839 The size of the bucket corresponds to <ref
840 column="ingress_policing_burst"/>. Initially the bucket is full.
843 Whenever a packet is received, its size (converted to tokens) is
844 compared to the number of tokens currently in the bucket. If the
845 required number of tokens are available, they are removed and the
846 packet is forwarded. Otherwise, the packet is dropped.
849 Whenever it is not full, the bucket is refilled with tokens at the
850 rate specified by <ref column="ingress_policing_rate"/>.
854 Policing interacts badly with some network protocols, and especially
855 with fragmented IP packets. Suppose that there is enough network
856 activity to keep the bucket nearly empty all the time. Then this token
857 bucket algorithm will forward a single packet every so often, with the
858 period depending on packet size and on the configured rate. All of the
859 fragments of an IP packets are normally transmitted back-to-back, as a
860 group. In such a situation, therefore, only one of these fragments
861 will be forwarded and the rest will be dropped. IP does not provide
862 any way for the intended recipient to ask for only the remaining
863 fragments. In such a case there are two likely possibilities for what
864 will happen next: either all of the fragments will eventually be
865 retransmitted (as TCP will do), in which case the same problem will
866 recur, or the sender will not realize that its packet has been dropped
867 and data will simply be lost (as some UDP-based protocols will do).
868 Either way, it is possible that no forward progress will ever occur.
870 <column name="ingress_policing_rate">
872 Maximum rate for data received on this interface, in kbps. Data
873 received faster than this rate is dropped. Set to <code>0</code>
874 (the default) to disable policing.
878 <column name="ingress_policing_burst">
879 <p>Maximum burst size for data received on this interface, in kb. The
880 default burst size if set to <code>0</code> is 1000 kb. This value
881 has no effect if <ref column="ingress_policing_rate"/>
882 is <code>0</code>.</p>
884 Specifying a larger burst size lets the algorithm be more forgiving,
885 which is important for protocols like TCP that react severely to
886 dropped packets. The burst size should be at least the size of the
887 interface's MTU. Specifying a value that is numerically at least as
888 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
889 closer to achieving the full rate.
894 <group title="Other Features">
896 <column name="monitor">
897 Connectivity monitor configuration for this interface.
900 <column name="external_ids">
901 Key-value pairs for use by external frameworks that integrate
902 with Open vSwitch, rather than by Open vSwitch itself. System
903 integrators should either use the Open vSwitch development
904 mailing list to coordinate on common key-value definitions, or
905 choose key names that are likely to be unique. The currently
906 defined common key-value pairs are:
908 <dt><code>attached-mac</code></dt>
910 The MAC address programmed into the ``virtual hardware'' for this
911 interface, in the form
912 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
913 For Citrix XenServer, this is the value of the <code>MAC</code>
914 field in the VIF record for this interface.</dd>
915 <dt><code>iface-id</code></dt>
916 <dd>A system-unique identifier for the interface. On XenServer,
917 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
920 Additionally the following key-value pairs specifically
921 apply to an interface that represents a virtual Ethernet interface
922 connected to a virtual machine. These key-value pairs should not be
923 present for other types of interfaces. Keys whose names end
924 in <code>-uuid</code> have values that uniquely identify the entity
925 in question. For a Citrix XenServer hypervisor, these values are
926 UUIDs in RFC 4122 format. Other hypervisors may use other
929 <p>The currently defined key-value pairs for XenServer are:</p>
931 <dt><code>xs-vif-uuid</code></dt>
932 <dd>The virtual interface associated with this interface.</dd>
933 <dt><code>xs-network-uuid</code></dt>
934 <dd>The virtual network to which this interface is attached.</dd>
935 <dt><code>xs-vm-uuid</code></dt>
936 <dd>The VM to which this interface belongs.</dd>
940 <column name="other_config">
941 Key-value pairs for rarely used interface features. Currently,
942 the only keys are for configuring GRE-over-IPsec, which is only
943 available through the <code>openvswitch-ipsec</code> package for
944 Debian. The currently defined key-value pairs are:
946 <dt><code>ipsec_local_ip</code></dt>
947 <dd>Required key for GRE-over-IPsec interfaces. Additionally,
948 the <ref column="type"/> must be <code>gre</code> and the
949 <code>ipsec_psk</code> <ref column="other_config"/> key must
950 be set. The <code>in_key</code>, <code>out_key</code>, and
951 <code>key</code> <ref column="options"/> must not be
953 <dt><code>ipsec_psk</code></dt>
954 <dd>Required key for GRE-over-IPsec interfaces. Specifies a
955 pre-shared key for authentication that must be identical on
956 both sides of the tunnel. Additionally, the
957 <code>ipsec_local_ip</code> key must also be set.</dd>
961 <column name="statistics">
963 Key-value pairs that report interface statistics. The current
964 implementation updates these counters periodically. In the future,
965 we plan to, instead, update them when an interface is created, when
966 they are queried (e.g. using an OVSDB <code>select</code> operation),
967 and just before an interface is deleted due to virtual interface
968 hot-unplug or VM shutdown, and perhaps at other times, but not on any
969 regular periodic basis.</p>
971 The currently defined key-value pairs are listed below. These are
972 the same statistics reported by OpenFlow in its <code>struct
973 ofp_port_stats</code> structure. If an interface does not support a
974 given statistic, then that pair is omitted.</p>
977 Successful transmit and receive counters:
979 <dt><code>rx_packets</code></dt>
980 <dd>Number of received packets.</dd>
981 <dt><code>rx_bytes</code></dt>
982 <dd>Number of received bytes.</dd>
983 <dt><code>tx_packets</code></dt>
984 <dd>Number of transmitted packets.</dd>
985 <dt><code>tx_bytes</code></dt>
986 <dd>Number of transmitted bytes.</dd>
992 <dt><code>rx_dropped</code></dt>
993 <dd>Number of packets dropped by RX.</dd>
994 <dt><code>rx_frame_err</code></dt>
995 <dd>Number of frame alignment errors.</dd>
996 <dt><code>rx_over_err</code></dt>
997 <dd>Number of packets with RX overrun.</dd>
998 <dt><code>rx_crc_err</code></dt>
999 <dd>Number of CRC errors.</dd>
1000 <dt><code>rx_errors</code></dt>
1002 Total number of receive errors, greater than or equal
1003 to the sum of the above.
1010 <dt><code>tx_dropped</code></dt>
1011 <dd>Number of packets dropped by TX.</dd>
1012 <dt><code>collisions</code></dt>
1013 <dd>Number of collisions.</dd>
1014 <dt><code>tx_errors</code></dt>
1016 Total number of transmit errors, greater
1017 than or equal to the sum of the above.
1026 <table name="QoS" title="Quality of Service configuration">
1027 <p>Quality of Service (QoS) configuration for each Port that
1030 <column name="type">
1031 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1032 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1033 identifies the types that a switch actually supports. The currently
1034 defined types are listed below:</p>
1036 <dt><code>linux-htb</code></dt>
1038 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1039 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1040 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1041 for information on how this classifier works and how to configure it.
1045 <dt><code>linux-hfsc</code></dt>
1047 Linux "Hierarchical Fair Service Curve" classifier.
1048 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1049 information on how this classifier works.
1054 <column name="queues">
1055 <p>A map from queue numbers to <ref table="Queue"/> records. The
1056 supported range of queue numbers depend on <ref column="type"/>. The
1057 queue numbers are the same as the <code>queue_id</code> used in
1058 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1059 structures. Queue 0 is used by OpenFlow output actions that do not
1060 specify a specific queue.</p>
1063 <column name="other_config">
1064 <p>Key-value pairs for configuring QoS features that depend on
1065 <ref column="type"/>.</p>
1066 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1067 the following key-value pairs:</p>
1069 <dt><code>max-rate</code></dt>
1070 <dd>Maximum rate shared by all queued traffic, in bit/s.
1071 Optional. If not specified, for physical interfaces, the
1072 default is the link rate. For other interfaces or if the
1073 link rate cannot be determined, the default is currently 100
1078 <column name="external_ids">
1079 Key-value pairs for use by external frameworks that integrate with Open
1080 vSwitch, rather than by Open vSwitch itself. System integrators should
1081 either use the Open vSwitch development mailing list to coordinate on
1082 common key-value definitions, or choose key names that are likely to be
1083 unique. No common key-value pairs are currently defined.
1087 <table name="Queue" title="QoS output queue.">
1088 <p>A configuration for a port output queue, used in configuring Quality of
1089 Service (QoS) features. May be referenced by <ref column="queues"
1090 table="QoS"/> column in <ref table="QoS"/> table.</p>
1092 <column name="other_config">
1093 <p>Key-value pairs for configuring the output queue. The supported
1094 key-value pairs and their meanings depend on the <ref column="type"/>
1095 of the <ref column="QoS"/> records that reference this row.</p>
1096 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1097 column="type"/> of <code>min-rate</code> are:</p>
1099 <dt><code>min-rate</code></dt>
1100 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1101 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1103 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1104 column="type"/> of <code>linux-htb</code> are:</p>
1106 <dt><code>min-rate</code></dt>
1107 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1108 <dt><code>max-rate</code></dt>
1109 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1110 queue's rate will not be allowed to exceed the specified value, even
1111 if excess bandwidth is available. If unspecified, defaults to no
1113 <dt><code>burst</code></dt>
1114 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1115 that a queue can accumulate while it is idle. Optional. Details of
1116 the <code>linux-htb</code> implementation require a minimum burst
1117 size, so a too-small <code>burst</code> will be silently
1119 <dt><code>priority</code></dt>
1120 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1121 unspecified. A queue with a smaller <code>priority</code>
1122 will receive all the excess bandwidth that it can use before
1123 a queue with a larger value receives any. Specific priority
1124 values are unimportant; only relative ordering matters.</dd>
1126 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1127 column="type"/> of <code>linux-hfsc</code> are:</p>
1129 <dt><code>min-rate</code></dt>
1130 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1131 <dt><code>max-rate</code></dt>
1132 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1133 queue's rate will not be allowed to exceed the specified value, even
1134 if excess bandwidth is available. If unspecified, defaults to no
1139 <column name="external_ids">
1140 Key-value pairs for use by external frameworks that integrate with Open
1141 vSwitch, rather than by Open vSwitch itself. System integrators should
1142 either use the Open vSwitch development mailing list to coordinate on
1143 common key-value definitions, or choose key names that are likely to be
1144 unique. No common key-value pairs are currently defined.
1148 <table name="Monitor" title="Connectivity Monitor configuration">
1150 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1151 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1152 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1153 to detect connectivity problems with each other. MPs within a MA should
1154 have complete and exclusive interconnectivity. This is verified by
1155 occasionally broadcasting Continuity Check Messages (CCMs) at a
1156 configurable transmission interval. A <ref table="Monitor"/> is
1157 responsible for collecting data about other MPs in its MA and
1161 <group title="Monitor Configuration">
1162 <column name="mpid">
1163 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1164 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1165 used to identify this <ref table="Monitor"/> to other endpoints in the
1169 <column name="remote_mps">
1170 A set of <ref table="Maintenance_Points"/> which this
1171 <ref table="Monitor"/> should have connectivity to. If this
1172 <ref table="Monitor"/> does not have connectivity to any MPs in this
1173 set, or has connectivity to any MPs not in this set, a fault is
1177 <column name="ma_name">
1178 A Maintenance Association (MA) name pairs with a Maintenance Domain
1179 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1180 have complete and exclusive interconnectivity. Defaults to
1181 <code>ovs</code> if unset.
1184 <column name="md_name">
1185 A Maintenance Domain name pairs with a Maintenance Association name to
1186 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1189 <column name="interval">
1190 The transmission interval of CCMs in milliseconds. Three missed CCMs
1191 indicate a connectivity fault. Defaults to 1000ms.
1195 <group title="Monitor Status">
1196 <column name="unexpected_remote_mpids">
1197 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1198 has detected connectivity that are not in the
1199 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1200 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1201 Thus, if this set is non-empty a fault is indicated.
1204 <column name="unexpected_remote_maids">
1205 A set of MAIDs representing foreign Maintenance Associations (MAs)
1206 which this <ref table="Monitor"/> has detected connectivity to. A
1207 <ref table="Monitor"/> should not have connectivity to a Maintenance
1208 Association other than its own. Thus, if this set is non-empty a fault
1212 <column name="fault">
1213 Indicates a Connectivity Fault caused by a configuration error, a down
1214 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1219 <table name="Maintenance_Point" title="Maintenance Point configuration">
1221 A <ref table="Maintenance_Point"/> represents a MP which a
1222 <ref table="Monitor"/> has or should have connectivity to.
1225 <group title="Maintenance_Point Configuration">
1226 <column name="mpid">
1227 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1228 a Maintenance Association. All MPs within a MA should have a unique
1233 <group title="Maintenance_Point Status">
1234 <column name="fault">
1235 Indicates a connectivity fault.
1240 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1241 <p>A port mirror within a <ref table="Bridge"/>.</p>
1242 <p>A port mirror configures a bridge to send selected frames to special
1243 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1244 traffic may also be referred to as SPAN or RSPAN, depending on the
1245 mechanism used for delivery.</p>
1247 <column name="name">
1248 Arbitrary identifier for the <ref table="Mirror"/>.
1251 <group title="Selecting Packets for Mirroring">
1252 <column name="select_all">
1253 If true, every packet arriving or departing on any port is
1254 selected for mirroring.
1257 <column name="select_dst_port">
1258 Ports on which departing packets are selected for mirroring.
1261 <column name="select_src_port">
1262 Ports on which arriving packets are selected for mirroring.
1265 <column name="select_vlan">
1266 VLANs on which packets are selected for mirroring. An empty set
1267 selects packets on all VLANs.
1271 <group title="Mirroring Destination Configuration">
1272 <column name="output_port">
1273 <p>Output port for selected packets, if nonempty. Mutually exclusive
1274 with <ref column="output_vlan"/>.</p>
1275 <p>Specifying a port for mirror output reserves that port exclusively
1276 for mirroring. No frames other than those selected for mirroring
1277 will be forwarded to the port, and any frames received on the port
1278 will be discarded.</p>
1279 <p>This type of mirroring is sometimes called SPAN.</p>
1282 <column name="output_vlan">
1283 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1284 with <ref column="output_port"/>.</p>
1285 <p>The frames will be sent out all ports that trunk
1286 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1287 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1288 trunk port, the frame's VLAN tag will be set to
1289 <ref column="output_vlan"/>, replacing any existing tag; when it is
1290 sent out an implicit VLAN port, the frame will not be tagged. This
1291 type of mirroring is sometimes called RSPAN.</p>
1292 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1293 contains unmanaged switches. Consider an unmanaged physical switch
1294 with two ports: port 1, connected to an end host, and port 2,
1295 connected to an Open vSwitch configured to mirror received packets
1296 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1297 port 1 that the physical switch forwards to port 2. The Open vSwitch
1298 forwards this packet to its destination and then reflects it back on
1299 port 2 in VLAN 123. This reflected packet causes the unmanaged
1300 physical switch to replace the MAC learning table entry, which
1301 correctly pointed to port 1, with one that incorrectly points to port
1302 2. Afterward, the physical switch will direct packets destined for
1303 the end host to the Open vSwitch on port 2, instead of to the end
1304 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1305 desired in this scenario, then the physical switch must be replaced
1306 by one that learns Ethernet addresses on a per-VLAN basis. In
1307 addition, learning should be disabled on the VLAN containing mirrored
1308 traffic. If this is not done then intermediate switches will learn
1309 the MAC address of each end host from the mirrored traffic. If
1310 packets being sent to that end host are also mirrored, then they will
1311 be dropped since the switch will attempt to send them out the input
1312 port. Disabling learning for the VLAN will cause the switch to
1313 correctly send the packet out all ports configured for that VLAN. If
1314 Open vSwitch is being used as an intermediate switch, learning can be
1315 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1316 in the appropriate <ref table="Bridge"/> table or tables.</p>
1320 <group title="Other Features">
1321 <column name="external_ids">
1322 Key-value pairs for use by external frameworks that integrate with Open
1323 vSwitch, rather than by Open vSwitch itself. System integrators should
1324 either use the Open vSwitch development mailing list to coordinate on
1325 common key-value definitions, or choose key names that are likely to be
1326 unique. No common key-value pairs are currently defined.
1331 <table name="Controller" title="OpenFlow controller configuration.">
1332 <p>An OpenFlow controller.</p>
1335 Open vSwitch supports two kinds of OpenFlow controllers:
1339 <dt>Primary controllers</dt>
1342 This is the kind of controller envisioned by the OpenFlow 1.0
1343 specification. Usually, a primary controller implements a network
1344 policy by taking charge of the switch's flow table.
1348 Open vSwitch initiates and maintains persistent connections to
1349 primary controllers, retrying the connection each time it fails or
1350 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1351 <ref table="Bridge"/> table applies to primary controllers.
1355 Open vSwitch permits a bridge to have any number of primary
1356 controllers. When multiple controllers are configured, Open
1357 vSwitch connects to all of them simultaneously. Because
1358 OpenFlow 1.0 does not specify how multiple controllers
1359 coordinate in interacting with a single switch, more than
1360 one primary controller should be specified only if the
1361 controllers are themselves designed to coordinate with each
1362 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1363 vendor extension may be useful for this.)
1366 <dt>Service controllers</dt>
1369 These kinds of OpenFlow controller connections are intended for
1370 occasional support and maintenance use, e.g. with
1371 <code>ovs-ofctl</code>. Usually a service controller connects only
1372 briefly to inspect or modify some of a switch's state.
1376 Open vSwitch listens for incoming connections from service
1377 controllers. The service controllers initiate and, if necessary,
1378 maintain the connections from their end. The <ref table="Bridge"
1379 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1380 not apply to service controllers.
1384 Open vSwitch supports configuring any number of service controllers.
1390 The <ref column="target"/> determines the type of controller.
1393 <group title="Core Features">
1394 <column name="target">
1395 <p>Connection method for controller.</p>
1397 The following connection methods are currently supported for primary
1401 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1403 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1404 the given <var>ip</var>, which must be expressed as an IP address
1405 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1406 column in the <ref table="Open_vSwitch"/> table must point to a
1407 valid SSL configuration when this form is used.</p>
1408 <p>SSL support is an optional feature that is not always built as
1409 part of Open vSwitch.</p>
1411 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1412 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1413 the given <var>ip</var>, which must be expressed as an IP address
1414 (not a DNS name).</dd>
1415 <dt><code>discover</code></dt>
1417 <p>Enables controller discovery.</p>
1418 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1419 request with vendor class identifier <code>OpenFlow</code> across
1420 all of the bridge's network devices. It will accept any valid
1421 DHCP reply that has the same vendor class identifier and includes
1422 a vendor-specific option with code 1 whose contents are a string
1423 specifying the location of the controller in the same format as
1424 <ref column="target"/>.</p>
1425 <p>The DHCP reply may also, optionally, include a vendor-specific
1426 option with code 2 whose contents are a string specifying the URI
1427 to the base of the OpenFlow PKI
1428 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1429 used only for bootstrapping the OpenFlow PKI at initial switch
1430 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1434 The following connection methods are currently supported for service
1438 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1441 Listens for SSL connections on the specified TCP <var>port</var>
1442 (default: 6633). If <var>ip</var>, which must be expressed as an
1443 IP address (not a DNS name), is specified, then connections are
1444 restricted to the specified local IP address.
1447 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1448 table="Open_vSwitch"/> table must point to a valid SSL
1449 configuration when this form is used.
1451 <p>SSL support is an optional feature that is not always built as
1452 part of Open vSwitch.</p>
1454 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1456 Listens for connections on the specified TCP <var>port</var>
1457 (default: 6633). If <var>ip</var>, which must be expressed as an
1458 IP address (not a DNS name), is specified, then connections are
1459 restricted to the specified local IP address.
1462 <p>When multiple controllers are configured for a single bridge, the
1463 <ref column="target"/> values must be unique. Duplicate
1464 <ref column="target"/> values yield unspecified results.</p>
1467 <column name="connection_mode">
1468 <p>If it is specified, this setting must be one of the following
1469 strings that describes how Open vSwitch contacts this OpenFlow
1470 controller over the network:</p>
1473 <dt><code>in-band</code></dt>
1474 <dd>In this mode, this controller's OpenFlow traffic travels over the
1475 bridge associated with the controller. With this setting, Open
1476 vSwitch allows traffic to and from the controller regardless of the
1477 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1478 would never be able to connect to the controller, because it did
1479 not have a flow to enable it.) This is the most common connection
1480 mode because it is not necessary to maintain two independent
1482 <dt><code>out-of-band</code></dt>
1483 <dd>In this mode, OpenFlow traffic uses a control network separate
1484 from the bridge associated with this controller, that is, the
1485 bridge does not use any of its own network devices to communicate
1486 with the controller. The control network must be configured
1487 separately, before or after <code>ovs-vswitchd</code> is started.
1491 <p>If not specified, the default is implementation-specific. If
1492 <ref column="target"/> is <code>discover</code>, the connection mode
1493 is always treated as <code>in-band</code> regardless of the actual
1498 <group title="Controller Failure Detection and Handling">
1499 <column name="max_backoff">
1500 Maximum number of milliseconds to wait between connection attempts.
1501 Default is implementation-specific.
1504 <column name="inactivity_probe">
1505 Maximum number of milliseconds of idle time on connection to
1506 controller before sending an inactivity probe message. If Open
1507 vSwitch does not communicate with the controller for the specified
1508 number of seconds, it will send a probe. If a response is not
1509 received for the same additional amount of time, Open vSwitch
1510 assumes the connection has been broken and attempts to reconnect.
1511 Default is implementation-specific.
1515 <group title="OpenFlow Rate Limiting">
1516 <column name="controller_rate_limit">
1517 <p>The maximum rate at which packets in unknown flows will be
1518 forwarded to the OpenFlow controller, in packets per second. This
1519 feature prevents a single bridge from overwhelming the controller.
1520 If not specified, the default is implementation-specific.</p>
1521 <p>In addition, when a high rate triggers rate-limiting, Open
1522 vSwitch queues controller packets for each port and transmits
1523 them to the controller at the configured rate. The number of
1524 queued packets is limited by
1525 the <ref column="controller_burst_limit"/> value. The packet
1526 queue is shared fairly among the ports on a bridge.</p><p>Open
1527 vSwitch maintains two such packet rate-limiters per bridge.
1528 One of these applies to packets sent up to the controller
1529 because they do not correspond to any flow. The other applies
1530 to packets sent up to the controller by request through flow
1531 actions. When both rate-limiters are filled with packets, the
1532 actual rate that packets are sent to the controller is up to
1533 twice the specified rate.</p>
1536 <column name="controller_burst_limit">
1537 In conjunction with <ref column="controller_rate_limit"/>,
1538 the maximum number of unused packet credits that the bridge will
1539 allow to accumulate, in packets. If not specified, the default
1540 is implementation-specific.
1544 <group title="Additional Discovery Configuration">
1545 <p>These values are considered only when <ref column="target"/>
1546 is <code>discover</code>.</p>
1548 <column name="discover_accept_regex">
1550 extended regular expression against which the discovered controller
1551 location is validated. The regular expression is implicitly
1552 anchored at the beginning of the controller location string, as
1553 if it begins with <code>^</code>. If not specified, the default
1554 is implementation-specific.
1557 <column name="discover_update_resolv_conf">
1558 Whether to update <code>/etc/resolv.conf</code> when the
1559 controller is discovered. If not specified, the default
1560 is implementation-specific. Open vSwitch will only modify
1561 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1562 specifies one or more DNS servers.
1566 <group title="Additional In-Band Configuration">
1567 <p>These values are considered only in in-band control mode (see
1568 <ref column="connection_mode"/>) and only when <ref column="target"/>
1569 is not <code>discover</code>. (For controller discovery, the network
1570 configuration obtained via DHCP is used instead.)</p>
1572 <p>When multiple controllers are configured on a single bridge, there
1573 should be only one set of unique values in these columns. If different
1574 values are set for these columns in different controllers, the effect
1577 <column name="local_ip">
1578 The IP address to configure on the local port,
1579 e.g. <code>192.168.0.123</code>. If this value is unset, then
1580 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1584 <column name="local_netmask">
1585 The IP netmask to configure on the local port,
1586 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1587 but this value is unset, then the default is chosen based on whether
1588 the IP address is class A, B, or C.
1591 <column name="local_gateway">
1592 The IP address of the gateway to configure on the local port, as a
1593 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1594 this network has no gateway.
1598 <group title="Other Features">
1599 <column name="external_ids">
1600 Key-value pairs for use by external frameworks that integrate with Open
1601 vSwitch, rather than by Open vSwitch itself. System integrators should
1602 either use the Open vSwitch development mailing list to coordinate on
1603 common key-value definitions, or choose key names that are likely to be
1604 unique. No common key-value pairs are currently defined.
1609 <table name="Manager" title="OVSDB management connection.">
1611 Configuration for a database connection to an Open vSwitch database
1616 This table primarily configures the Open vSwitch database
1617 (<code>ovsdb-server</code>), not the Open vSwitch switch
1618 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1619 what connections should be treated as in-band.
1623 The Open vSwitch database server can initiate and maintain active
1624 connections to remote clients. It can also listen for database
1628 <group title="Core Features">
1629 <column name="target">
1630 <p>Connection method for managers.</p>
1632 The following connection methods are currently supported:
1635 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1638 The specified SSL <var>port</var> (default: 6632) on the host at
1639 the given <var>ip</var>, which must be expressed as an IP address
1640 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1641 column in the <ref table="Open_vSwitch"/> table must point to a
1642 valid SSL configuration when this form is used.
1645 SSL support is an optional feature that is not always built as
1646 part of Open vSwitch.
1650 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1652 The specified TCP <var>port</var> (default: 6632) on the host at
1653 the given <var>ip</var>, which must be expressed as an IP address
1656 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1659 Listens for SSL connections on the specified TCP <var>port</var>
1660 (default: 6632). If <var>ip</var>, which must be expressed as an
1661 IP address (not a DNS name), is specified, then connections are
1662 restricted to the specified local IP address.
1665 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1666 table="Open_vSwitch"/> table must point to a valid SSL
1667 configuration when this form is used.
1670 SSL support is an optional feature that is not always built as
1671 part of Open vSwitch.
1674 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1676 Listens for connections on the specified TCP <var>port</var>
1677 (default: 6632). If <var>ip</var>, which must be expressed as an
1678 IP address (not a DNS name), is specified, then connections are
1679 restricted to the specified local IP address.
1682 <p>When multiple managers are configured, the <ref column="target"/>
1683 values must be unique. Duplicate <ref column="target"/> values yield
1684 unspecified results.</p>
1687 <column name="connection_mode">
1689 If it is specified, this setting must be one of the following strings
1690 that describes how Open vSwitch contacts this OVSDB client over the
1695 <dt><code>in-band</code></dt>
1697 In this mode, this connection's traffic travels over a bridge
1698 managed by Open vSwitch. With this setting, Open vSwitch allows
1699 traffic to and from the client regardless of the contents of the
1700 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
1701 to connect to the client, because it did not have a flow to enable
1702 it.) This is the most common connection mode because it is not
1703 necessary to maintain two independent networks.
1705 <dt><code>out-of-band</code></dt>
1707 In this mode, the client's traffic uses a control network separate
1708 from that managed by Open vSwitch, that is, Open vSwitch does not
1709 use any of its own network devices to communicate with the client.
1710 The control network must be configured separately, before or after
1711 <code>ovs-vswitchd</code> is started.
1716 If not specified, the default is implementation-specific.
1721 <group title="Client Failure Detection and Handling">
1722 <column name="max_backoff">
1723 Maximum number of milliseconds to wait between connection attempts.
1724 Default is implementation-specific.
1727 <column name="inactivity_probe">
1728 Maximum number of milliseconds of idle time on connection to the client
1729 before sending an inactivity probe message. If Open vSwitch does not
1730 communicate with the client for the specified number of seconds, it
1731 will send a probe. If a response is not received for the same
1732 additional amount of time, Open vSwitch assumes the connection has been
1733 broken and attempts to reconnect. Default is implementation-specific.
1737 <group title="Other Features">
1738 <column name="external_ids">
1739 Key-value pairs for use by external frameworks that integrate with Open
1740 vSwitch, rather than by Open vSwitch itself. System integrators should
1741 either use the Open vSwitch development mailing list to coordinate on
1742 common key-value definitions, or choose key names that are likely to be
1743 unique. No common key-value pairs are currently defined.
1748 <table name="NetFlow">
1749 A NetFlow target. NetFlow is a protocol that exports a number of
1750 details about terminating IP flows, such as the principals involved
1753 <column name="targets">
1754 NetFlow targets in the form
1755 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
1756 must be specified numerically, not as a DNS name.
1759 <column name="engine_id">
1760 Engine ID to use in NetFlow messages. Defaults to datapath index
1764 <column name="engine_type">
1765 Engine type to use in NetFlow messages. Defaults to datapath
1766 index if not specified.
1769 <column name="active_timeout">
1770 The interval at which NetFlow records are sent for flows that are
1771 still active, in seconds. A value of <code>0</code> requests the
1772 default timeout (currently 600 seconds); a value of <code>-1</code>
1773 disables active timeouts.
1776 <column name="add_id_to_interface">
1777 <p>If this column's value is <code>false</code>, the ingress and egress
1778 interface fields of NetFlow flow records are derived from OpenFlow port
1779 numbers. When it is <code>true</code>, the 7 most significant bits of
1780 these fields will be replaced by the least significant 7 bits of the
1781 engine id. This is useful because many NetFlow collectors do not
1782 expect multiple switches to be sending messages from the same host, so
1783 they do not store the engine information which could be used to
1784 disambiguate the traffic.</p>
1785 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
1788 <column name="external_ids">
1789 Key-value pairs for use by external frameworks that integrate with Open
1790 vSwitch, rather than by Open vSwitch itself. System integrators should
1791 either use the Open vSwitch development mailing list to coordinate on
1792 common key-value definitions, or choose key names that are likely to be
1793 unique. No common key-value pairs are currently defined.
1798 SSL configuration for an Open_vSwitch.
1800 <column name="private_key">
1801 Name of a PEM file containing the private key used as the switch's
1802 identity for SSL connections to the controller.
1805 <column name="certificate">
1806 Name of a PEM file containing a certificate, signed by the
1807 certificate authority (CA) used by the controller and manager,
1808 that certifies the switch's private key, identifying a trustworthy
1812 <column name="ca_cert">
1813 Name of a PEM file containing the CA certificate used to verify
1814 that the switch is connected to a trustworthy controller.
1817 <column name="bootstrap_ca_cert">
1818 If set to <code>true</code>, then Open vSwitch will attempt to
1819 obtain the CA certificate from the controller on its first SSL
1820 connection and save it to the named PEM file. If it is successful,
1821 it will immediately drop the connection and reconnect, and from then
1822 on all SSL connections must be authenticated by a certificate signed
1823 by the CA certificate thus obtained. <em>This option exposes the
1824 SSL connection to a man-in-the-middle attack obtaining the initial
1825 CA certificate.</em> It may still be useful for bootstrapping.
1828 <column name="external_ids">
1829 Key-value pairs for use by external frameworks that integrate with Open
1830 vSwitch, rather than by Open vSwitch itself. System integrators should
1831 either use the Open vSwitch development mailing list to coordinate on
1832 common key-value definitions, or choose key names that are likely to be
1833 unique. No common key-value pairs are currently defined.
1837 <table name="sFlow">
1838 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
1841 <column name="agent">
1842 Name of the network device whose IP address should be reported as the
1843 ``agent address'' to collectors. If not specified, the IP address
1844 defaults to the <ref table="Controller" column="local_ip"/> in the
1845 collector's <ref table="Controller"/>. If an agent IP address cannot be
1846 determined either way, sFlow is disabled.
1849 <column name="header">
1850 Number of bytes of a sampled packet to send to the collector.
1851 If not specified, the default is 128 bytes.
1854 <column name="polling">
1855 Polling rate in seconds to send port statistics to the collector.
1856 If not specified, defaults to 30 seconds.
1859 <column name="sampling">
1860 Rate at which packets should be sampled and sent to the collector.
1861 If not specified, defaults to 400, which means one out of 400
1862 packets, on average, will be sent to the collector.
1865 <column name="targets">
1866 sFlow targets in the form
1867 <code><var>ip</var>:<var>port</var></code>.
1870 <column name="external_ids">
1871 Key-value pairs for use by external frameworks that integrate with Open
1872 vSwitch, rather than by Open vSwitch itself. System integrators should
1873 either use the Open vSwitch development mailing list to coordinate on
1874 common key-value definitions, or choose key names that are likely to be
1875 unique. No common key-value pairs are currently defined.
1879 <table name="Capability">
1880 <p>Records in this table describe functionality supported by the hardware
1881 and software platform on which this Open vSwitch is based. Clients
1882 should not modify this table.</p>
1884 <p>A record in this table is meaningful only if it is referenced by the
1885 <ref table="Open_vSwitch" column="capabilities"/> column in the
1886 <ref table="Open_vSwitch"/> table. The key used to reference it, called
1887 the record's ``category,'' determines the meanings of the
1888 <ref column="details"/> column. The following general forms of
1889 categories are currently defined:</p>
1892 <dt><code>qos-<var>type</var></code></dt>
1893 <dd><var>type</var> is supported as the value for
1894 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
1898 <column name="details">
1899 <p>Key-value pairs that describe capabilities. The meaning of the pairs
1900 depends on the category key that the <ref table="Open_vSwitch"
1901 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1902 uses to reference this record, as described above.</p>
1904 <p>The presence of a record for category <code>qos-<var>type</var></code>
1905 indicates that the switch supports <var>type</var> as the value of
1906 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
1907 table. The following key-value pairs are defined to further describe
1908 QoS capabilities:</p>
1911 <dt><code>n-queues</code></dt>
1912 <dd>Number of supported queues, as a positive integer. Keys in the
1913 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
1914 records whose <ref table="QoS" column="type"/> value
1915 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob