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.
19 <column name="managers">
20 Remote database clients to which the Open vSwitch's database server
21 should connect or to which it should listen.
25 SSL used globally by the daemon.
28 <column name="external_ids">
29 Key-value pairs for use by external frameworks that integrate
30 with Open vSwitch, rather than by Open vSwitch itself. System
31 integrators should either use the Open vSwitch development
32 mailing list to coordinate on common key-value definitions, or
33 choose key names that are likely to be unique. The currently
34 defined common key-value pairs are:
36 <dt><code>system-type</code></dt>
37 <dd>An identifier for the switch type, such as
38 <code>XenServer</code> or <code>KVM</code>.</dd>
39 <dt><code>system-version</code></dt>
40 <dd>The version of the switch software, such as
41 <code>5.6.0</code> on XenServer.</dd>
42 <dt><code>system-id</code></dt>
43 <dd>A unique identifier for the Open vSwitch's physical host.
44 The form of the identifier depends on the type of the host.
45 On a Citrix XenServer, this will likely be the same as
46 <code>xs-system-uuid</code>.</dd>
47 <dt><code>xs-system-uuid</code></dt>
48 <dd>The Citrix XenServer universally unique identifier for the
49 physical host as displayed by <code>xe host-list</code>.</dd>
54 <group title="Status">
55 <column name="next_cfg">
56 Sequence number for client to increment. When a client modifies
57 any part of the database configuration and wishes to wait for
58 Open vSwitch to finish applying the changes, it may increment
62 <column name="cur_cfg">
63 Sequence number that Open vSwitch sets to the current value of
64 <ref column="next_cfg"/> after it finishes applying a set of
65 configuration changes.
68 <column name="capabilities">
69 Describes functionality supported by the hardware and software platform
70 on which this Open vSwitch is based. Clients should not modify this
71 column. See the <ref table="Capability"/> description for defined
72 capability categories and the meaning of associated
73 <ref table="Capability"/> records.
76 <column name="statistics">
78 Key-value pairs that report statistics about a system running an Open
79 vSwitch. These are updated periodically (currently, every 5
80 seconds). Key-value pairs that cannot be determined or that do not
81 apply to a platform are omitted.
85 <dt><code>cpu</code></dt>
88 Number of CPU processors, threads, or cores currently online and
89 available to the operating system on which Open vSwitch is
90 running, as an integer. This may be less than the number
91 installed, if some are not online or if they are not available to
95 Open vSwitch userspace processes are not multithreaded, but the
96 Linux kernel-based datapath is.
100 <dt><code>load_average</code></dt>
103 A comma-separated list of three floating-point numbers,
104 representing the system load average over the last 1, 5, and 15
105 minutes, respectively.
109 <dt><code>memory</code></dt>
112 A comma-separated list of integers, each of which represents a
113 quantity of memory in kilobytes that describes the operating
114 system on which Open vSwitch is running. In respective order,
119 <li>Total amount of RAM allocated to the OS.</li>
120 <li>RAM allocated to the OS that is in use.</li>
121 <li>RAM that can be flushed out to disk or otherwise discarded
122 if that space is needed for another purpose. This number is
123 necessarily less than or equal to the previous value.</li>
124 <li>Total disk space allocated for swap.</li>
125 <li>Swap space currently in use.</li>
129 On Linux, all five values can be determined and are included. On
130 other operating systems, only the first two values can be
131 determined, so the list will only have two values.
135 <dt><code>process_</code><var>name</var></dt>
138 One such key-value pair will exist for each running Open vSwitch
139 daemon process, with <var>name</var> replaced by the daemon's
140 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
141 comma-separated list of integers. The integers represent the
142 following, with memory measured in kilobytes and durations in
147 <li>The process's virtual memory size.</li>
148 <li>The process's resident set size.</li>
149 <li>The amount of user and system CPU time consumed by the
151 <li>The number of times that the process has crashed and been
152 automatically restarted by the monitor.</li>
153 <li>The duration since the process was started.</li>
154 <li>The duration for which the process has been running.</li>
158 The interpretation of some of these values depends on whether the
159 process was started with the <option>--monitor</option>. If it
160 was not, then the crash count will always be 0 and the two
161 durations will always be the same. If <option>--monitor</option>
162 was given, then the crash count may be positive; if it is, the
163 latter duration is the amount of time since the most recent crash
168 There will be one key-value pair for each file in Open vSwitch's
169 ``run directory'' (usually <code>/var/run/openvswitch</code>)
170 whose name ends in <code>.pid</code>, whose contents are a
171 process ID, and which is locked by a running process. The
172 <var>name</var> is taken from the pidfile's name.
176 Currently Open vSwitch is only able to obtain all of the above
177 detail on Linux systems. On other systems, the same key-value
178 pairs will be present but the values will always be the empty
183 <dt><code>file_systems</code></dt>
186 A space-separated list of information on local, writable file
187 systems. Each item in the list describes one file system and
188 consists in turn of a comma-separated list of the following:
192 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
193 Any spaces or commas in the mount point are replaced by
195 <li>Total size, in kilobytes, as an integer.</li>
196 <li>Amount of storage in use, in kilobytes, as an integer.</li>
200 This key-value pair is omitted if there are no local, writable
201 file systems or if Open vSwitch cannot obtain the needed
210 <table name="Bridge">
212 Configuration for a bridge within an
213 <ref table="Open_vSwitch"/>.
216 A <ref table="Bridge"/> record represents an Ethernet switch with one or
217 more ``ports,'' which are the <ref table="Port"/> records pointed to by
218 the <ref table="Bridge"/>'s <ref column="ports"/> column.
221 <group title="Core Features">
223 Bridge identifier. Should be alphanumeric and no more than about 8
224 bytes long. Must be unique among the names of ports, interfaces, and
228 <column name="ports">
229 Ports included in the bridge.
232 <column name="mirrors">
233 Port mirroring configuration.
236 <column name="netflow">
237 NetFlow configuration.
240 <column name="sflow">
244 <column name="flood_vlans">
245 VLAN IDs of VLANs on which MAC address learning should be disabled, so
246 that packets are flooded instead of being sent to specific ports that
247 are believed to contain packets' destination MACs. This should
248 ordinarily be used to disable MAC learning on VLANs used for mirroring
249 (RSPAN VLANs). It may also be useful for debugging.
253 <group title="OpenFlow Configuration">
254 <column name="controller">
255 OpenFlow controller set. If unset, then no OpenFlow controllers
259 <column name="fail_mode">
260 <p>When a controller is configured, it is, ordinarily, responsible
261 for setting up all flows on the switch. Thus, if the connection to
262 the controller fails, no new network connections can be set up.
263 If the connection to the controller stays down long enough,
264 no packets can pass through the switch at all. This setting
265 determines the switch's response to such a situation. It may be set
266 to one of the following:
268 <dt><code>standalone</code></dt>
269 <dd>If no message is received from the controller for three
270 times the inactivity probe interval
271 (see <ref column="inactivity_probe"/>), then Open vSwitch
272 will take over responsibility for setting up flows. In
273 this mode, Open vSwitch causes the bridge to act like an
274 ordinary MAC-learning switch. Open vSwitch will continue
275 to retry connecting to the controller in the background
276 and, when the connection succeeds, it will discontinue its
277 standalone behavior.</dd>
278 <dt><code>secure</code></dt>
279 <dd>Open vSwitch will not set up flows on its own when the
280 controller connection fails or when no controllers are
281 defined. The bridge will continue to retry connecting to
282 any defined controllers forever.</dd>
285 <p>If this value is unset, the default is implementation-specific.</p>
286 <p>When more than one controller is configured,
287 <ref column="fail_mode"/> is considered only when none of the
288 configured controllers can be contacted.</p>
291 <column name="datapath_id">
292 Reports the OpenFlow datapath ID in use. Exactly 16 hex
293 digits. (Setting this column will have no useful effect. Set
294 <ref column="other_config"/>:<code>other-config</code>
299 <group title="Other Features">
300 <column name="datapath_type">
301 Name of datapath provider. The kernel datapath has
302 type <code>system</code>. The userspace datapath has
303 type <code>netdev</code>.
306 <column name="external_ids">
307 Key-value pairs for use by external frameworks that integrate
308 with Open vSwitch, rather than by Open vSwitch itself. System
309 integrators should either use the Open vSwitch development
310 mailing list to coordinate on common key-value definitions, or
311 choose key names that are likely to be unique. The currently
312 defined key-value pairs are:
314 <dt><code>bridge-id</code></dt>
315 <dd>A unique identifier of the bridge. On Citrix XenServer this
316 will commonly be the same as <code>xs-network-uuids</code>.</dd>
317 <dt><code>xs-network-uuids</code></dt>
318 <dd>Semicolon-delimited set of universally unique identifier(s) for
319 the network with which this bridge is associated on a Citrix
320 XenServer host. The network identifiers are RFC 4122 UUIDs as
321 displayed by, e.g., <code>xe network-list</code>.</dd>
325 <column name="other_config">
326 Key-value pairs for configuring rarely used bridge
327 features. The currently defined key-value pairs are:
329 <dt><code>datapath-id</code></dt>
331 digits to set the OpenFlow datapath ID to a specific
332 value. May not be all-zero.</dd>
333 <dt><code>disable-in-band</code></dt>
334 <dd>If set to <code>true</code>, disable in-band control on
335 the bridge regardless of controller and manager settings.</dd>
336 <dt><code>hwaddr</code></dt>
337 <dd>An Ethernet address in the form
338 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
339 to set the hardware address of the local port and influence the
346 <table name="Port" table="Port or bond configuration.">
347 <p>A port within a <ref table="Bridge"/>.</p>
348 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
349 <ref column="interfaces"/> column. Such a port logically
350 corresponds to a port on a physical Ethernet switch. A port
351 with more than one interface is a ``bonded port'' (see
352 <ref group="Bonding Configuration"/>).</p>
353 <p>Some properties that one might think as belonging to a port are actually
354 part of the port's <ref table="Interface"/> members.</p>
357 Port name. Should be alphanumeric and no more than about 8
358 bytes long. May be the same as the interface name, for
359 non-bonded ports. Must otherwise be unique among the names of
360 ports, interfaces, and bridges on a host.
363 <column name="interfaces">
364 The port's interfaces. If there is more than one, this is a
368 <group title="VLAN Configuration">
369 <p>A bridge port must be configured for VLANs in one of two
370 mutually exclusive ways:
372 <li>A ``trunk port'' has an empty value for <ref
373 column="tag"/>. Its <ref column="trunks"/> value may be
374 empty or non-empty.</li>
375 <li>An ``implicitly tagged VLAN port'' or ``access port''
376 has an nonempty value for <ref column="tag"/>. Its
377 <ref column="trunks"/> value must be empty.</li>
379 If <ref column="trunks"/> and <ref column="tag"/> are both
380 nonempty, the configuration is ill-formed.
385 If this is an access port (see above), the port's implicitly
386 tagged VLAN. Must be empty if this is a trunk port.
389 Frames arriving on trunk ports will be forwarded to this
390 port only if they are tagged with the given VLAN (or, if
391 <ref column="tag"/> is 0, then if they lack a VLAN header).
392 Frames arriving on other access ports will be forwarded to
393 this port only if they have the same <ref column="tag"/>
394 value. Frames forwarded to this port will not have an
398 When a frame with a 802.1Q header that indicates a nonzero
399 VLAN is received on an access port, it is discarded.
403 <column name="trunks">
405 If this is a trunk port (see above), the 802.1Q VLAN(s) that
406 this port trunks; if it is empty, then the port trunks all
407 VLANs. Must be empty if this is an access port.
410 Frames arriving on trunk ports are dropped if they are not
411 in one of the specified VLANs. For this purpose, packets
412 that have no VLAN header are treated as part of VLAN 0.
417 <group title="Bonding Configuration">
418 <p>A port that has more than one interface is a ``bonded port.''
419 Bonding allows for load balancing and fail-over. Open vSwitch
420 supports ``source load balancing'' (SLB) bonding, which
421 assigns flows to slaves based on source MAC address, with
422 periodic rebalancing as traffic patterns change. This form of
423 bonding does not require 802.3ad or other special support from
424 the upstream switch to which the slave devices are
427 <p>These columns apply only to bonded ports. Their values are
428 otherwise ignored.</p>
430 <column name="bond_updelay">
431 <p>For a bonded port, the number of milliseconds for which carrier must
432 stay up on an interface before the interface is considered to be up.
433 Specify <code>0</code> to enable the interface immediately.</p>
434 <p>This setting is honored only when at least one bonded interface is
435 already enabled. When no interfaces are enabled, then the first bond
436 interface to come up is enabled immediately.</p>
439 <column name="bond_downdelay">
440 For a bonded port, the number of milliseconds for which carrier must
441 stay down on an interface before the interface is considered to be
442 down. Specify <code>0</code> to disable the interface immediately.
445 <column name="bond_fake_iface">
446 For a bonded port, whether to create a fake internal interface with the
447 name of the port. Use only for compatibility with legacy software that
452 <group title="Other Features">
454 Quality of Service configuration for this port.
458 The MAC address to use for this port for the purpose of choosing the
459 bridge's MAC address. This column does not necessarily reflect the
460 port's actual MAC address, nor will setting it change the port's actual
464 <column name="fake_bridge">
465 Does this port represent a sub-bridge for its tagged VLAN within the
466 Bridge? See ovs-vsctl(8) for more information.
469 <column name="external_ids">
471 Key-value pairs for use by external frameworks that integrate with
472 Open vSwitch, rather than by Open vSwitch itself. System integrators
473 should either use the Open vSwitch development mailing list to
474 coordinate on common key-value definitions, or choose key names that
475 are likely to be unique.
478 No key-value pairs native to <ref table="Port"/> are currently
479 defined. For fake bridges (see the <ref column="fake_bridge"/>
480 column), external IDs for the fake bridge are defined here by
481 prefixing a <ref table="Bridge"/> <ref table="Bridge"
482 column="external_ids"/> key with <code>fake-bridge-</code>,
483 e.g. <code>fake-bridge-xs-network-uuids</code>.
487 <column name="other_config">
488 Key-value pairs for configuring rarely used port features. The
489 currently defined key-value pairs are:
491 <dt><code>hwaddr</code></dt>
492 <dd>An Ethernet address in the form
493 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
494 <dt><code>bond-rebalance-interval</code></dt>
495 <dd>For a bonded port, the number of milliseconds between
496 successive attempts to rebalance the bond, that is, to
497 move source MACs and their flows from one interface on
498 the bond to another in an attempt to keep usage of each
499 interface roughly equal. The default is 10000 (10
500 seconds), and the minimum is 1000 (1 second).</dd>
506 <table name="Interface" title="One physical network device in a Port.">
507 An interface within a <ref table="Port"/>.
509 <group title="Core Features">
511 Interface name. Should be alphanumeric and no more than about 8 bytes
512 long. May be the same as the port name, for non-bonded ports. Must
513 otherwise be unique among the names of ports, interfaces, and bridges
518 <p>Ethernet address to set for this interface. If unset then the
519 default MAC address is used:</p>
521 <li>For the local interface, the default is the lowest-numbered MAC
522 address among the other bridge ports, either the value of the
523 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
524 if set, or its actual MAC (for bonded ports, the MAC of its slave
525 whose name is first in alphabetical order). Internal ports and
526 bridge ports that are used as port mirroring destinations (see the
527 <ref table="Mirror"/> table) are ignored.</li>
528 <li>For other internal interfaces, the default MAC is randomly
530 <li>External interfaces typically have a MAC address associated with
533 <p>Some interfaces may not have a software-controllable MAC
537 <column name="ofport">
538 <p>OpenFlow port number for this interface. Unlike most columns, this
539 column's value should be set only by Open vSwitch itself. Other
540 clients should set this column to an empty set (the default) when
541 creating an <ref table="Interface"/>.</p>
542 <p>Open vSwitch populates this column when the port number becomes
543 known. If the interface is successfully added,
544 <ref column="ofport"/> will be set to a number between 1 and 65535
545 (generally either in the range 1 to 65279, inclusive, or 65534, the
546 port number for the OpenFlow ``local port''). If the interface
547 cannot be added then Open vSwitch sets this column
552 <group title="System-Specific Details">
554 The interface type, one of:
556 <dt><code>system</code></dt>
557 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
558 Sometimes referred to as ``external interfaces'' since they are
559 generally connected to hardware external to that on which the Open
560 vSwitch is running. The empty string is a synonym for
561 <code>system</code>.</dd>
562 <dt><code>internal</code></dt>
563 <dd>A simulated network device that sends and receives traffic. An
564 internal interface whose <ref column="name"/> is the same as its
565 bridge's <ref table="Open_vSwitch" column="name"/> is called the
566 ``local interface.'' It does not make sense to bond an internal
567 interface, so the terms ``port'' and ``interface'' are often used
568 imprecisely for internal interfaces.</dd>
569 <dt><code>tap</code></dt>
570 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
571 <dt><code>gre</code></dt>
572 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
573 tunnel. Each tunnel must be uniquely identified by the
574 combination of <code>remote_ip</code>, <code>local_ip</code>, and
575 <code>in_key</code>. Note that if two ports are defined that are
576 the same except one has an optional identifier and the other does
577 not, the more specific one is matched first. <code>in_key</code>
578 is considered more specific than <code>local_ip</code> if a port
579 defines one and another port defines the other. The following
580 options may be specified in the <ref column="options"/> column:
582 <dt><code>remote_ip</code></dt>
583 <dd>Required. The tunnel endpoint.</dd>
586 <dt><code>local_ip</code></dt>
587 <dd>Optional. The destination IP that received packets must
588 match. Default is to match all addresses.</dd>
591 <dt><code>in_key</code></dt>
592 <dd>Optional. The GRE key that received packets must contain.
593 It may either be a 32-bit number (no key and a key of 0 are
594 treated as equivalent) or the word <code>flow</code>. If
595 <code>flow</code> is specified then any key will be accepted
596 and the key will be placed in the <code>tun_id</code> field
597 for matching in the flow table. The ovs-ofctl manual page
598 contains additional information about matching fields in
599 OpenFlow flows. Default is no key.</dd>
602 <dt><code>out_key</code></dt>
603 <dd>Optional. The GRE key to be set on outgoing packets. It may
604 either be a 32-bit number or the word <code>flow</code>. If
605 <code>flow</code> is specified then the key may be set using
606 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
607 is used in the absence of an action). The ovs-ofctl manual
608 page contains additional information about the Nicira OpenFlow
609 vendor extensions. Default is no key.</dd>
612 <dt><code>key</code></dt>
613 <dd>Optional. Shorthand to set <code>in_key</code> and
614 <code>out_key</code> at the same time.</dd>
617 <dt><code>tos</code></dt>
618 <dd>Optional. The value of the ToS bits to be set on the
619 encapsulating packet. It may also be the word
620 <code>inherit</code>, in which case the ToS will be copied from
621 the inner packet if it is IPv4 or IPv6 (otherwise it will be
622 0). Note that the ECN fields are always inherited. Default is
626 <dt><code>ttl</code></dt>
627 <dd>Optional. The TTL to be set on the encapsulating packet.
628 It may also be the word <code>inherit</code>, in which case the
629 TTL will be copied from the inner packet if it is IPv4 or IPv6
630 (otherwise it will be the system default, typically 64).
631 Default is the system default TTL.</dd>
634 <dt><code>csum</code></dt>
635 <dd>Optional. Compute GRE checksums on outgoing packets.
636 Checksums present on incoming packets will be validated
637 regardless of this setting. Note that GRE checksums
638 impose a significant performance penalty as they cover the
639 entire packet. As the contents of the packet is typically
640 covered by L3 and L4 checksums, this additional checksum only
641 adds value for the GRE and encapsulated Ethernet headers.
642 Default is disabled, set to <code>true</code> to enable.</dd>
645 <dt><code>pmtud</code></dt>
646 <dd>Optional. Enable tunnel path MTU discovery. If enabled
647 ``ICMP destination unreachable - fragmentation'' needed
648 messages will be generated for IPv4 packets with the DF bit set
649 and IPv6 packets above the minimum MTU if the packet size
650 exceeds the path MTU minus the size of the tunnel headers. It
651 also forces the encapsulating packet DF bit to be set (it is
652 always set if the inner packet implies path MTU discovery).
653 Note that this option causes behavior that is typically
654 reserved for routers and therefore is not entirely in
655 compliance with the IEEE 802.1D specification for bridges.
656 Default is enabled, set to <code>false</code> to disable.</dd>
659 <dt><code>header_cache</code></dt>
660 <dd>Optional. Enable caching of tunnel headers and the output
661 path. This can lead to a significant performance increase
662 without changing behavior. In general it should not be
663 necessary to adjust this setting. However, the caching can
664 bypass certain components of the IP stack (such as IP tables)
665 and it may be useful to disable it if these features are
666 required or as a debugging measure. Default is enabled, set to
667 <code>false</code> to disable. If IPsec is enabled through the
668 <ref column="other_config"/> parameters, header caching will be
669 automatically disabled.</dd>
672 <dt><code>capwap</code></dt>
673 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
674 (RFC 5415). This allows interoperability with certain switches
675 where GRE is not available. Note that only the tunneling component
676 of the protocol is implemented. Due to the non-standard use of
677 CAPWAP, UDP ports 58881 and 58882 are used as the source and
678 destinations ports respectivedly. Each tunnel must be uniquely
679 identified by the combination of <code>remote_ip</code> and
680 <code>local_ip</code>. If two ports are defined that are the same
681 except one includes <code>local_ip</code> and the other does not,
682 the more specific one is matched first. CAPWAP support is not
683 available on all platforms. Currently it is only supported in the
684 Linux kernel module with kernel versions >= 2.6.25. The following
685 options may be specified in the <ref column="options"/> column:
687 <dt><code>remote_ip</code></dt>
688 <dd>Required. The tunnel endpoint.</dd>
691 <dt><code>local_ip</code></dt>
692 <dd>Optional. The destination IP that received packets must
693 match. Default is to match all addresses.</dd>
696 <dt><code>tos</code></dt>
697 <dd>Optional. The value of the ToS bits to be set on the
698 encapsulating packet. It may also be the word
699 <code>inherit</code>, in which case the ToS will be copied from
700 the inner packet if it is IPv4 or IPv6 (otherwise it will be
701 0). Note that the ECN fields are always inherited. Default is
705 <dt><code>ttl</code></dt>
706 <dd>Optional. The TTL to be set on the encapsulating packet.
707 It may also be the word <code>inherit</code>, in which case the
708 TTL will be copied from the inner packet if it is IPv4 or IPv6
709 (otherwise it will be the system default, typically 64).
710 Default is the system default TTL.</dd>
713 <dt><code>pmtud</code></dt>
714 <dd>Optional. Enable tunnel path MTU discovery. If enabled
715 ``ICMP destination unreachable - fragmentation'' needed
716 messages will be generated for IPv4 packets with the DF bit set
717 and IPv6 packets above the minimum MTU if the packet size
718 exceeds the path MTU minus the size of the tunnel headers. It
719 also forces the encapsulating packet DF bit to be set (it is
720 always set if the inner packet implies path MTU discovery).
721 Note that this option causes behavior that is typically
722 reserved for routers and therefore is not entirely in
723 compliance with the IEEE 802.1D specification for bridges.
724 Default is enabled, set to <code>false</code> to disable.</dd>
727 <dt><code>header_cache</code></dt>
728 <dd>Optional. Enable caching of tunnel headers and the output
729 path. This can lead to a significant performance increase
730 without changing behavior. In general it should not be
731 necessary to adjust this setting. However, the caching can
732 bypass certain components of the IP stack (such as IP tables)
733 and it may be useful to disable it if these features are
734 required or as a debugging measure. Default is enabled, set to
735 <code>false</code> to disable.</dd>
738 <dt><code>patch</code></dt>
741 A pair of virtual devices that act as a patch cable. The <ref
742 column="options"/> column must have the following key-value pair:
745 <dt><code>peer</code></dt>
747 The <ref column="name"/> of the <ref table="Interface"/> for
748 the other side of the patch. The named <ref
749 table="Interface"/>'s own <code>peer</code> option must specify
750 this <ref table="Interface"/>'s name. That is, the two patch
751 interfaces must have reversed <ref column="name"/> and
752 <code>peer</code> values.
759 <column name="options">
760 Configuration options whose interpretation varies based on
761 <ref column="type"/>.
764 <column name="status">
766 Key-value pairs that report port status. Supported status
767 values are <code>type</code>-dependent.
769 <p>The only currently defined key-value pair is:</p>
771 <dt><code>source_ip</code></dt>
772 <dd>The source IP address used for an IPv4 tunnel end-point,
773 such as <code>gre</code> or <code>capwap</code>. Not
774 supported by all implementations.</dd>
779 <group title="Ingress Policing">
781 These settings control ingress policing for packets received on this
782 interface. On a physical interface, this limits the rate at which
783 traffic is allowed into the system from the outside; on a virtual
784 interface (one connected to a virtual machine), this limits the rate at
785 which the VM is able to transmit.
788 Policing is a simple form of quality-of-service that simply drops
789 packets received in excess of the configured rate. Due to its
790 simplicity, policing is usually less accurate and less effective than
791 egress QoS (which is configured using the <ref table="QoS"/> and <ref
792 table="Queue"/> tables).
795 Policing is currently implemented only on Linux. The Linux
796 implementation uses a simple ``token bucket'' approach:
800 The size of the bucket corresponds to <ref
801 column="ingress_policing_burst"/>. Initially the bucket is full.
804 Whenever a packet is received, its size (converted to tokens) is
805 compared to the number of tokens currently in the bucket. If the
806 required number of tokens are available, they are removed and the
807 packet is forwarded. Otherwise, the packet is dropped.
810 Whenever it is not full, the bucket is refilled with tokens at the
811 rate specified by <ref column="ingress_policing_rate"/>.
815 Policing interacts badly with some network protocols, and especially
816 with fragmented IP packets. Suppose that there is enough network
817 activity to keep the bucket nearly empty all the time. Then this token
818 bucket algorithm will forward a single packet every so often, with the
819 period depending on packet size and on the configured rate. All of the
820 fragments of an IP packets are normally transmitted back-to-back, as a
821 group. In such a situation, therefore, only one of these fragments
822 will be forwarded and the rest will be dropped. IP does not provide
823 any way for the intended recipient to ask for only the remaining
824 fragments. In such a case there are two likely possibilities for what
825 will happen next: either all of the fragments will eventually be
826 retransmitted (as TCP will do), in which case the same problem will
827 recur, or the sender will not realize that its packet has been dropped
828 and data will simply be lost (as some UDP-based protocols will do).
829 Either way, it is possible that no forward progress will ever occur.
831 <column name="ingress_policing_rate">
833 Maximum rate for data received on this interface, in kbps. Data
834 received faster than this rate is dropped. Set to <code>0</code>
835 (the default) to disable policing.
839 <column name="ingress_policing_burst">
840 <p>Maximum burst size for data received on this interface, in kb. The
841 default burst size if set to <code>0</code> is 1000 kb. This value
842 has no effect if <ref column="ingress_policing_rate"/>
843 is <code>0</code>.</p>
845 Specifying a larger burst size lets the algorithm be more forgiving,
846 which is important for protocols like TCP that react severely to
847 dropped packets. The burst size should be at least the size of the
848 interface's MTU. Specifying a value that is numerically at least as
849 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
850 closer to achieving the full rate.
855 <group title="Other Features">
856 <column name="external_ids">
857 Key-value pairs for use by external frameworks that integrate
858 with Open vSwitch, rather than by Open vSwitch itself. System
859 integrators should either use the Open vSwitch development
860 mailing list to coordinate on common key-value definitions, or
861 choose key names that are likely to be unique. The currently
862 defined common key-value pairs are:
864 <dt><code>attached-mac</code></dt>
866 The MAC address programmed into the ``virtual hardware'' for this
867 interface, in the form
868 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
869 For Citrix XenServer, this is the value of the <code>MAC</code>
870 field in the VIF record for this interface.</dd>
871 <dt><code>iface-id</code></dt>
872 <dd>A system-unique identifier for the interface. On XenServer,
873 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
876 Additionally the following key-value pairs specifically
877 apply to an interface that represents a virtual Ethernet interface
878 connected to a virtual machine. These key-value pairs should not be
879 present for other types of interfaces. Keys whose names end
880 in <code>-uuid</code> have values that uniquely identify the entity
881 in question. For a Citrix XenServer hypervisor, these values are
882 UUIDs in RFC 4122 format. Other hypervisors may use other
885 <p>The currently defined key-value pairs for XenServer are:</p>
887 <dt><code>xs-vif-uuid</code></dt>
888 <dd>The virtual interface associated with this interface.</dd>
889 <dt><code>xs-network-uuid</code></dt>
890 <dd>The virtual network to which this interface is attached.</dd>
891 <dt><code>xs-vm-uuid</code></dt>
892 <dd>The VM to which this interface belongs.</dd>
896 <column name="other_config">
897 Key-value pairs for rarely used interface features. Currently,
898 the only keys are for configuring GRE-over-IPsec, which is only
899 available through the <code>openvswitch-ipsec</code> package for
900 Debian. The currently defined key-value pairs are:
902 <dt><code>ipsec_local_ip</code></dt>
903 <dd>Required key for GRE-over-IPsec interfaces. Additionally,
904 the <ref column="type"/> must be <code>gre</code> and the
905 <code>ipsec_psk</code> <ref column="other_config"/> key must
906 be set. The <code>in_key</code>, <code>out_key</code>, and
907 <code>key</code> <ref column="options"/> must not be
909 <dt><code>ipsec_psk</code></dt>
910 <dd>Required key for GRE-over-IPsec interfaces. Specifies a
911 pre-shared key for authentication that must be identical on
912 both sides of the tunnel. Additionally, the
913 <code>ipsec_local_ip</code> key must also be set.</dd>
917 <column name="statistics">
919 Key-value pairs that report interface statistics. The current
920 implementation updates these counters periodically. In the future,
921 we plan to, instead, update them when an interface is created, when
922 they are queried (e.g. using an OVSDB <code>select</code> operation),
923 and just before an interface is deleted due to virtual interface
924 hot-unplug or VM shutdown, and perhaps at other times, but not on any
925 regular periodic basis.</p>
927 The currently defined key-value pairs are listed below. These are
928 the same statistics reported by OpenFlow in its <code>struct
929 ofp_port_stats</code> structure. If an interface does not support a
930 given statistic, then that pair is omitted.</p>
933 Successful transmit and receive counters:
935 <dt><code>rx_packets</code></dt>
936 <dd>Number of received packets.</dd>
937 <dt><code>rx_bytes</code></dt>
938 <dd>Number of received bytes.</dd>
939 <dt><code>tx_packets</code></dt>
940 <dd>Number of transmitted packets.</dd>
941 <dt><code>tx_bytes</code></dt>
942 <dd>Number of transmitted bytes.</dd>
948 <dt><code>rx_dropped</code></dt>
949 <dd>Number of packets dropped by RX.</dd>
950 <dt><code>rx_frame_err</code></dt>
951 <dd>Number of frame alignment errors.</dd>
952 <dt><code>rx_over_err</code></dt>
953 <dd>Number of packets with RX overrun.</dd>
954 <dt><code>rx_crc_err</code></dt>
955 <dd>Number of CRC errors.</dd>
956 <dt><code>rx_errors</code></dt>
958 Total number of receive errors, greater than or equal
959 to the sum of the above.
966 <dt><code>tx_dropped</code></dt>
967 <dd>Number of packets dropped by TX.</dd>
968 <dt><code>collisions</code></dt>
969 <dd>Number of collisions.</dd>
970 <dt><code>tx_errors</code></dt>
972 Total number of transmit errors, greater
973 than or equal to the sum of the above.
982 <table name="QoS" title="Quality of Service configuration">
983 <p>Quality of Service (QoS) configuration for each Port that
987 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
988 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
989 identifies the types that a switch actually supports. The currently
990 defined types are listed below:</p>
992 <dt><code>linux-htb</code></dt>
994 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
995 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
996 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
997 for information on how this classifier works and how to configure it.
1002 <column name="queues">
1003 <p>A map from queue numbers to <ref table="Queue"/> records. The
1004 supported range of queue numbers depend on <ref column="type"/>. The
1005 queue numbers are the same as the <code>queue_id</code> used in
1006 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1007 structures. Queue 0 is used by OpenFlow output actions that do not
1008 specify a specific queue.</p>
1011 <column name="other_config">
1012 <p>Key-value pairs for configuring QoS features that depend on
1013 <ref column="type"/>.</p>
1014 <p>The <code>linux-htb</code> class supports the following key-value
1017 <dt><code>max-rate</code></dt>
1018 <dd>Maximum rate shared by all queued traffic, in bit/s.
1019 Optional. If not specified, for physical interfaces, the
1020 default is the link rate. For other interfaces or if the
1021 link rate cannot be determined, the default is currently 100
1026 <column name="external_ids">
1027 Key-value pairs for use by external frameworks that integrate with Open
1028 vSwitch, rather than by Open vSwitch itself. System integrators should
1029 either use the Open vSwitch development mailing list to coordinate on
1030 common key-value definitions, or choose key names that are likely to be
1031 unique. No common key-value pairs are currently defined.
1035 <table name="Queue" title="QoS output queue.">
1036 <p>A configuration for a port output queue, used in configuring Quality of
1037 Service (QoS) features. May be referenced by <ref column="queues"
1038 table="QoS"/> column in <ref table="QoS"/> table.</p>
1040 <column name="other_config">
1041 <p>Key-value pairs for configuring the output queue. The supported
1042 key-value pairs and their meanings depend on the <ref column="type"/>
1043 of the <ref column="QoS"/> records that reference this row.</p>
1044 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1045 column="type"/> of <code>min-rate</code> are:</p>
1047 <dt><code>min-rate</code></dt>
1048 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1049 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1051 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1052 column="type"/> of <code>linux-htb</code> are:</p>
1054 <dt><code>min-rate</code></dt>
1055 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1056 <dt><code>max-rate</code></dt>
1057 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1058 queue's rate will not be allowed to exceed the specified value, even
1059 if excess bandwidth is available. If unspecified, defaults to no
1061 <dt><code>burst</code></dt>
1062 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1063 that a queue can accumulate while it is idle. Optional. Details of
1064 the <code>linux-htb</code> implementation require a minimum burst
1065 size, so a too-small <code>burst</code> will be silently
1067 <dt><code>priority</code></dt>
1068 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1069 unspecified. A queue with a smaller <code>priority</code>
1070 will receive all the excess bandwidth that it can use before
1071 a queue with a larger value receives any. Specific priority
1072 values are unimportant; only relative ordering matters.</dd>
1076 <column name="external_ids">
1077 Key-value pairs for use by external frameworks that integrate with Open
1078 vSwitch, rather than by Open vSwitch itself. System integrators should
1079 either use the Open vSwitch development mailing list to coordinate on
1080 common key-value definitions, or choose key names that are likely to be
1081 unique. No common key-value pairs are currently defined.
1085 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1086 <p>A port mirror within a <ref table="Bridge"/>.</p>
1087 <p>A port mirror configures a bridge to send selected frames to special
1088 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1089 traffic may also be referred to as SPAN or RSPAN, depending on the
1090 mechanism used for delivery.</p>
1092 <column name="name">
1093 Arbitrary identifier for the <ref table="Mirror"/>.
1096 <group title="Selecting Packets for Mirroring">
1097 <column name="select_all">
1098 If true, every packet arriving or departing on any port is
1099 selected for mirroring.
1102 <column name="select_dst_port">
1103 Ports on which departing packets are selected for mirroring.
1106 <column name="select_src_port">
1107 Ports on which arriving packets are selected for mirroring.
1110 <column name="select_vlan">
1111 VLANs on which packets are selected for mirroring. An empty set
1112 selects packets on all VLANs.
1116 <group title="Mirroring Destination Configuration">
1117 <column name="output_port">
1118 <p>Output port for selected packets, if nonempty. Mutually exclusive
1119 with <ref column="output_vlan"/>.</p>
1120 <p>Specifying a port for mirror output reserves that port exclusively
1121 for mirroring. No frames other than those selected for mirroring
1122 will be forwarded to the port, and any frames received on the port
1123 will be discarded.</p>
1124 <p>This type of mirroring is sometimes called SPAN.</p>
1127 <column name="output_vlan">
1128 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1129 with <ref column="output_port"/>.</p>
1130 <p>The frames will be sent out all ports that trunk
1131 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1132 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1133 trunk port, the frame's VLAN tag will be set to
1134 <ref column="output_vlan"/>, replacing any existing tag; when it is
1135 sent out an implicit VLAN port, the frame will not be tagged. This
1136 type of mirroring is sometimes called RSPAN.</p>
1137 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1138 contains unmanaged switches. Consider an unmanaged physical switch
1139 with two ports: port 1, connected to an end host, and port 2,
1140 connected to an Open vSwitch configured to mirror received packets
1141 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1142 port 1 that the physical switch forwards to port 2. The Open vSwitch
1143 forwards this packet to its destination and then reflects it back on
1144 port 2 in VLAN 123. This reflected packet causes the unmanaged
1145 physical switch to replace the MAC learning table entry, which
1146 correctly pointed to port 1, with one that incorrectly points to port
1147 2. Afterward, the physical switch will direct packets destined for
1148 the end host to the Open vSwitch on port 2, instead of to the end
1149 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1150 desired in this scenario, then the physical switch must be replaced
1151 by one that learns Ethernet addresses on a per-VLAN basis. In
1152 addition, learning should be disabled on the VLAN containing mirrored
1153 traffic. If this is not done then intermediate switches will learn
1154 the MAC address of each end host from the mirrored traffic. If
1155 packets being sent to that end host are also mirrored, then they will
1156 be dropped since the switch will attempt to send them out the input
1157 port. Disabling learning for the VLAN will cause the switch to
1158 correctly send the packet out all ports configured for that VLAN. If
1159 Open vSwitch is being used as an intermediate switch, learning can be
1160 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1161 in the appropriate <ref table="Bridge"/> table or tables.</p>
1165 <group title="Other Features">
1166 <column name="external_ids">
1167 Key-value pairs for use by external frameworks that integrate with Open
1168 vSwitch, rather than by Open vSwitch itself. System integrators should
1169 either use the Open vSwitch development mailing list to coordinate on
1170 common key-value definitions, or choose key names that are likely to be
1171 unique. No common key-value pairs are currently defined.
1176 <table name="Controller" title="OpenFlow controller configuration.">
1177 <p>An OpenFlow controller.</p>
1180 Open vSwitch supports two kinds of OpenFlow controllers:
1184 <dt>Primary controllers</dt>
1187 This is the kind of controller envisioned by the OpenFlow 1.0
1188 specification. Usually, a primary controller implements a network
1189 policy by taking charge of the switch's flow table.
1193 Open vSwitch initiates and maintains persistent connections to
1194 primary controllers, retrying the connection each time it fails or
1195 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1196 <ref table="Bridge"/> table applies to primary controllers.
1200 Open vSwitch permits a bridge to have any number of primary
1201 controllers. When multiple controllers are configured, Open
1202 vSwitch connects to all of them simultaneously. Because
1203 OpenFlow 1.0 does not specify how multiple controllers
1204 coordinate in interacting with a single switch, more than
1205 one primary controller should be specified only if the
1206 controllers are themselves designed to coordinate with each
1207 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1208 vendor extension may be useful for this.)
1211 <dt>Service controllers</dt>
1214 These kinds of OpenFlow controller connections are intended for
1215 occasional support and maintenance use, e.g. with
1216 <code>ovs-ofctl</code>. Usually a service controller connects only
1217 briefly to inspect or modify some of a switch's state.
1221 Open vSwitch listens for incoming connections from service
1222 controllers. The service controllers initiate and, if necessary,
1223 maintain the connections from their end. The <ref table="Bridge"
1224 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1225 not apply to service controllers.
1229 Open vSwitch supports configuring any number of service controllers.
1235 The <ref column="target"/> determines the type of controller.
1238 <group title="Core Features">
1239 <column name="target">
1240 <p>Connection method for controller.</p>
1242 The following connection methods are currently supported for primary
1246 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1248 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1249 the given <var>ip</var>, which must be expressed as an IP address
1250 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1251 column in the <ref table="Open_vSwitch"/> table must point to a
1252 valid SSL configuration when this form is used.</p>
1253 <p>SSL support is an optional feature that is not always built as
1254 part of Open vSwitch.</p>
1256 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1257 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1258 the given <var>ip</var>, which must be expressed as an IP address
1259 (not a DNS name).</dd>
1260 <dt><code>discover</code></dt>
1262 <p>Enables controller discovery.</p>
1263 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1264 request with vendor class identifier <code>OpenFlow</code> across
1265 all of the bridge's network devices. It will accept any valid
1266 DHCP reply that has the same vendor class identifier and includes
1267 a vendor-specific option with code 1 whose contents are a string
1268 specifying the location of the controller in the same format as
1269 <ref column="target"/>.</p>
1270 <p>The DHCP reply may also, optionally, include a vendor-specific
1271 option with code 2 whose contents are a string specifying the URI
1272 to the base of the OpenFlow PKI
1273 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1274 used only for bootstrapping the OpenFlow PKI at initial switch
1275 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1279 The following connection methods are currently supported for service
1283 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1286 Listens for SSL connections on the specified TCP <var>port</var>
1287 (default: 6633). If <var>ip</var>, which must be expressed as an
1288 IP address (not a DNS name), is specified, then connections are
1289 restricted to the specified local IP address.
1292 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1293 table="Open_vSwitch"/> table must point to a valid SSL
1294 configuration when this form is used.
1296 <p>SSL support is an optional feature that is not always built as
1297 part of Open vSwitch.</p>
1299 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1301 Listens for connections on the specified TCP <var>port</var>
1302 (default: 6633). If <var>ip</var>, which must be expressed as an
1303 IP address (not a DNS name), is specified, then connections are
1304 restricted to the specified local IP address.
1307 <p>When multiple controllers are configured for a single bridge, the
1308 <ref column="target"/> values must be unique. Duplicate
1309 <ref column="target"/> values yield unspecified results.</p>
1312 <column name="connection_mode">
1313 <p>If it is specified, this setting must be one of the following
1314 strings that describes how Open vSwitch contacts this OpenFlow
1315 controller over the network:</p>
1318 <dt><code>in-band</code></dt>
1319 <dd>In this mode, this controller's OpenFlow traffic travels over the
1320 bridge associated with the controller. With this setting, Open
1321 vSwitch allows traffic to and from the controller regardless of the
1322 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1323 would never be able to connect to the controller, because it did
1324 not have a flow to enable it.) This is the most common connection
1325 mode because it is not necessary to maintain two independent
1327 <dt><code>out-of-band</code></dt>
1328 <dd>In this mode, OpenFlow traffic uses a control network separate
1329 from the bridge associated with this controller, that is, the
1330 bridge does not use any of its own network devices to communicate
1331 with the controller. The control network must be configured
1332 separately, before or after <code>ovs-vswitchd</code> is started.
1336 <p>If not specified, the default is implementation-specific. If
1337 <ref column="target"/> is <code>discover</code>, the connection mode
1338 is always treated as <code>in-band</code> regardless of the actual
1343 <group title="Controller Failure Detection and Handling">
1344 <column name="max_backoff">
1345 Maximum number of milliseconds to wait between connection attempts.
1346 Default is implementation-specific.
1349 <column name="inactivity_probe">
1350 Maximum number of milliseconds of idle time on connection to
1351 controller before sending an inactivity probe message. If Open
1352 vSwitch does not communicate with the controller for the specified
1353 number of seconds, it will send a probe. If a response is not
1354 received for the same additional amount of time, Open vSwitch
1355 assumes the connection has been broken and attempts to reconnect.
1356 Default is implementation-specific.
1360 <group title="OpenFlow Rate Limiting">
1361 <column name="controller_rate_limit">
1362 <p>The maximum rate at which packets in unknown flows will be
1363 forwarded to the OpenFlow controller, in packets per second. This
1364 feature prevents a single bridge from overwhelming the controller.
1365 If not specified, the default is implementation-specific.</p>
1366 <p>In addition, when a high rate triggers rate-limiting, Open
1367 vSwitch queues controller packets for each port and transmits
1368 them to the controller at the configured rate. The number of
1369 queued packets is limited by
1370 the <ref column="controller_burst_limit"/> value. The packet
1371 queue is shared fairly among the ports on a bridge.</p><p>Open
1372 vSwitch maintains two such packet rate-limiters per bridge.
1373 One of these applies to packets sent up to the controller
1374 because they do not correspond to any flow. The other applies
1375 to packets sent up to the controller by request through flow
1376 actions. When both rate-limiters are filled with packets, the
1377 actual rate that packets are sent to the controller is up to
1378 twice the specified rate.</p>
1381 <column name="controller_burst_limit">
1382 In conjunction with <ref column="controller_rate_limit"/>,
1383 the maximum number of unused packet credits that the bridge will
1384 allow to accumulate, in packets. If not specified, the default
1385 is implementation-specific.
1389 <group title="Additional Discovery Configuration">
1390 <p>These values are considered only when <ref column="target"/>
1391 is <code>discover</code>.</p>
1393 <column name="discover_accept_regex">
1395 extended regular expression against which the discovered controller
1396 location is validated. The regular expression is implicitly
1397 anchored at the beginning of the controller location string, as
1398 if it begins with <code>^</code>. If not specified, the default
1399 is implementation-specific.
1402 <column name="discover_update_resolv_conf">
1403 Whether to update <code>/etc/resolv.conf</code> when the
1404 controller is discovered. If not specified, the default
1405 is implementation-specific. Open vSwitch will only modify
1406 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1407 specifies one or more DNS servers.
1411 <group title="Additional In-Band Configuration">
1412 <p>These values are considered only in in-band control mode (see
1413 <ref column="connection_mode"/>) and only when <ref column="target"/>
1414 is not <code>discover</code>. (For controller discovery, the network
1415 configuration obtained via DHCP is used instead.)</p>
1417 <p>When multiple controllers are configured on a single bridge, there
1418 should be only one set of unique values in these columns. If different
1419 values are set for these columns in different controllers, the effect
1422 <column name="local_ip">
1423 The IP address to configure on the local port,
1424 e.g. <code>192.168.0.123</code>. If this value is unset, then
1425 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1429 <column name="local_netmask">
1430 The IP netmask to configure on the local port,
1431 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1432 but this value is unset, then the default is chosen based on whether
1433 the IP address is class A, B, or C.
1436 <column name="local_gateway">
1437 The IP address of the gateway to configure on the local port, as a
1438 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1439 this network has no gateway.
1443 <group title="Other Features">
1444 <column name="external_ids">
1445 Key-value pairs for use by external frameworks that integrate with Open
1446 vSwitch, rather than by Open vSwitch itself. System integrators should
1447 either use the Open vSwitch development mailing list to coordinate on
1448 common key-value definitions, or choose key names that are likely to be
1449 unique. No common key-value pairs are currently defined.
1454 <table name="NetFlow">
1455 A NetFlow target. NetFlow is a protocol that exports a number of
1456 details about terminating IP flows, such as the principals involved
1459 <column name="targets">
1460 NetFlow targets in the form
1461 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
1462 must be specified numerically, not as a DNS name.
1465 <column name="engine_id">
1466 Engine ID to use in NetFlow messages. Defaults to datapath index
1470 <column name="engine_type">
1471 Engine type to use in NetFlow messages. Defaults to datapath
1472 index if not specified.
1475 <column name="active_timeout">
1476 The interval at which NetFlow records are sent for flows that are
1477 still active, in seconds. A value of <code>0</code> requests the
1478 default timeout (currently 600 seconds); a value of <code>-1</code>
1479 disables active timeouts.
1482 <column name="add_id_to_interface">
1483 <p>If this column's value is <code>false</code>, the ingress and egress
1484 interface fields of NetFlow flow records are derived from OpenFlow port
1485 numbers. When it is <code>true</code>, the 7 most significant bits of
1486 these fields will be replaced by the least significant 7 bits of the
1487 engine id. This is useful because many NetFlow collectors do not
1488 expect multiple switches to be sending messages from the same host, so
1489 they do not store the engine information which could be used to
1490 disambiguate the traffic.</p>
1491 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
1494 <column name="external_ids">
1495 Key-value pairs for use by external frameworks that integrate with Open
1496 vSwitch, rather than by Open vSwitch itself. System integrators should
1497 either use the Open vSwitch development mailing list to coordinate on
1498 common key-value definitions, or choose key names that are likely to be
1499 unique. No common key-value pairs are currently defined.
1504 SSL configuration for an Open_vSwitch.
1506 <column name="private_key">
1507 Name of a PEM file containing the private key used as the switch's
1508 identity for SSL connections to the controller.
1511 <column name="certificate">
1512 Name of a PEM file containing a certificate, signed by the
1513 certificate authority (CA) used by the controller and manager,
1514 that certifies the switch's private key, identifying a trustworthy
1518 <column name="ca_cert">
1519 Name of a PEM file containing the CA certificate used to verify
1520 that the switch is connected to a trustworthy controller.
1523 <column name="bootstrap_ca_cert">
1524 If set to <code>true</code>, then Open vSwitch will attempt to
1525 obtain the CA certificate from the controller on its first SSL
1526 connection and save it to the named PEM file. If it is successful,
1527 it will immediately drop the connection and reconnect, and from then
1528 on all SSL connections must be authenticated by a certificate signed
1529 by the CA certificate thus obtained. <em>This option exposes the
1530 SSL connection to a man-in-the-middle attack obtaining the initial
1531 CA certificate.</em> It may still be useful for bootstrapping.
1534 <column name="external_ids">
1535 Key-value pairs for use by external frameworks that integrate with Open
1536 vSwitch, rather than by Open vSwitch itself. System integrators should
1537 either use the Open vSwitch development mailing list to coordinate on
1538 common key-value definitions, or choose key names that are likely to be
1539 unique. No common key-value pairs are currently defined.
1543 <table name="sFlow">
1544 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
1547 <column name="agent">
1548 Name of the network device whose IP address should be reported as the
1549 ``agent address'' to collectors. If not specified, the IP address
1550 defaults to the <ref table="Controller" column="local_ip"/> in the
1551 collector's <ref table="Controller"/>. If an agent IP address cannot be
1552 determined either way, sFlow is disabled.
1555 <column name="header">
1556 Number of bytes of a sampled packet to send to the collector.
1557 If not specified, the default is 128 bytes.
1560 <column name="polling">
1561 Polling rate in seconds to send port statistics to the collector.
1562 If not specified, defaults to 30 seconds.
1565 <column name="sampling">
1566 Rate at which packets should be sampled and sent to the collector.
1567 If not specified, defaults to 400, which means one out of 400
1568 packets, on average, will be sent to the collector.
1571 <column name="targets">
1572 sFlow targets in the form
1573 <code><var>ip</var>:<var>port</var></code>.
1576 <column name="external_ids">
1577 Key-value pairs for use by external frameworks that integrate with Open
1578 vSwitch, rather than by Open vSwitch itself. System integrators should
1579 either use the Open vSwitch development mailing list to coordinate on
1580 common key-value definitions, or choose key names that are likely to be
1581 unique. No common key-value pairs are currently defined.
1585 <table name="Capability">
1586 <p>Records in this table describe functionality supported by the hardware
1587 and software platform on which this Open vSwitch is based. Clients
1588 should not modify this table.</p>
1590 <p>A record in this table is meaningful only if it is referenced by the
1591 <ref table="Open_vSwitch" column="capabilities"/> column in the
1592 <ref table="Open_vSwitch"/> table. The key used to reference it, called
1593 the record's ``category,'' determines the meanings of the
1594 <ref column="details"/> column. The following general forms of
1595 categories are currently defined:</p>
1598 <dt><code>qos-<var>type</var></code></dt>
1599 <dd><var>type</var> is supported as the value for
1600 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
1604 <column name="details">
1605 <p>Key-value pairs that describe capabilities. The meaning of the pairs
1606 depends on the category key that the <ref table="Open_vSwitch"
1607 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1608 uses to reference this record, as described above.</p>
1610 <p>The presence of a record for category <code>qos-<var>type</var></code>
1611 indicates that the switch supports <var>type</var> as the value of
1612 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
1613 table. The following key-value pairs are defined to further describe
1614 QoS capabilities:</p>
1617 <dt><code>n-queues</code></dt>
1618 <dd>Number of supported queues, as a positive integer. Keys in the
1619 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
1620 records whose <ref table="QoS" column="type"/> value
1621 equals <var>type</var> must range between 0 and this value minus one,