1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
3 <p>A database with this schema holds the configuration for one Open
4 vSwitch daemon. The root of the configuration for the daemon is
5 the <ref table="Open_vSwitch"/> table, which must have exactly one
6 record. Records in other tables are significant only when they
7 can be reached directly or indirectly from the
8 <ref table="Open_vSwitch"/> table.</p>
10 <table name="Open_vSwitch" title="Open vSwitch configuration.">
11 Configuration for an Open vSwitch daemon. There must be exactly one record
12 in the <ref table="Open_vSwitch"/> table.
14 <group title="Configuration">
15 <column name="bridges">
16 Set of bridges managed by the daemon.
20 SSL used globally by the daemon.
23 <column name="external_ids">
24 Key-value pairs for use by external frameworks that integrate
25 with Open vSwitch, rather than by Open vSwitch itself. System
26 integrators should either use the Open vSwitch development
27 mailing list to coordinate on common key-value definitions, or
28 choose key names that are likely to be unique. The currently
29 defined common key-value pairs are:
31 <dt><code>system-id</code></dt>
32 <dd>A unique identifier for the Open vSwitch's physical host.
33 The form of the identifier depends on the type of the host.
34 On a Citrix XenServer, this will likely be the same as
35 <code>xs-system-uuid</code>.</dd>
36 <dt><code>xs-system-uuid</code></dt>
37 <dd>The Citrix XenServer universally unique identifier for the
38 physical host as displayed by <code>xe host-list</code>.</dd>
43 <group title="Status">
44 <column name="next_cfg">
45 Sequence number for client to increment. When a client modifies
46 any part of the database configuration and wishes to wait for
47 Open vSwitch to finish applying the changes, it may increment
51 <column name="cur_cfg">
52 Sequence number that Open vSwitch sets to the current value of
53 <ref column="next_cfg"/> after it finishes applying a set of
54 configuration changes.
57 <column name="capabilities">
58 Describes functionality supported by the hardware and software platform
59 on which this Open vSwitch is based. Clients should not modify this
60 column. See the <ref table="Capability"/> description for defined
61 capability categories and the meaning of associated
62 <ref table="Capability"/> records.
65 <column name="statistics">
67 Key-value pairs that report statistics about a system running an Open
68 vSwitch. These are updated periodically (currently, every 5
69 seconds). Key-value pairs that cannot be determined or that do not
70 apply to a platform are omitted.
74 <dt><code>cpu</code></dt>
77 Number of CPU processors, threads, or cores currently online and
78 available to the operating system on which Open vSwitch is
79 running, as an integer. This may be less than the number
80 installed, if some are not online or if they are not available to
84 Open vSwitch userspace processes are not multithreaded, but the
85 Linux kernel-based datapath is.
89 <dt><code>load_average</code></dt>
92 A comma-separated list of three floating-point numbers,
93 representing the system load average over the last 1, 5, and 15
94 minutes, respectively.
98 <dt><code>memory</code></dt>
101 A comma-separated list of integers, each of which represents a
102 quantity of memory in kilobytes that describes the operating
103 system on which Open vSwitch is running. In respective order,
108 <li>Total amount of RAM allocated to the OS.</li>
109 <li>RAM allocated to the OS that is in use.</li>
110 <li>RAM that can be flushed out to disk or otherwise discarded
111 if that space is needed for another purpose. This number is
112 necessarily less than or equal to the previous value.</li>
113 <li>Total disk space allocated for swap.</li>
114 <li>Swap space currently in use.</li>
118 On Linux, all five values can be determined and are included. On
119 other operating systems, only the first two values can be
120 determined, so the list will only have two values.
124 <dt><code>process_</code><var>name</var></dt>
127 One such key-value pair will exist for each running Open vSwitch
128 daemon process, with <var>name</var> replaced by the daemon's
129 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
130 comma-separated list of integers. The integers represent the
131 following, with memory measured in kilobytes and durations in
136 <li>The process's virtual memory size.</li>
137 <li>The process's resident set size.</li>
138 <li>The amount of user and system CPU time consumed by the
140 <li>The number of times that the process has crashed and been
141 automatically restarted by the monitor.</li>
142 <li>The duration since the process was started.</li>
143 <li>The duration for which the process has been running.</li>
147 The interpretation of some of these values depends on whether the
148 process was started with the <option>--monitor</option>. If it
149 was not, then the crash count will always be 0 and the two
150 durations will always be the same. If <option>--monitor</option>
151 was given, then the crash count may be positive; if it is, the
152 latter duration is the amount of time since the most recent crash
157 There will be one key-value pair for each file in Open vSwitch's
158 ``run directory'' (usually <code>/var/run/openvswitch</code>)
159 whose name ends in <code>.pid</code>, whose contents are a
160 process ID, and which is locked by a running process. The
161 <var>name</var> is taken from the pidfile's name.
165 Currently Open vSwitch is only able to obtain all of the above
166 detail on Linux systems. On other systems, the same key-value
167 pairs will be present but the values will always be the empty
172 <dt><code>file_systems</code></dt>
175 A space-separated list of information on local, writable file
176 systems. Each item in the list describes one file system and
177 consists in turn of a comma-separated list of the following:
181 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
182 Any spaces or commas in the mount point are replaced by
184 <li>Total size, in kilobytes, as an integer.</li>
185 <li>Amount of storage in use, in kilobytes, as an integer.</li>
189 This key-value pair is omitted if there are no local, writable
190 file systems or if Open vSwitch cannot obtain the needed
198 <group title="Version Reporting">
200 These columns report the types and versions of the hardware and
201 software running Open vSwitch. We recommend in general that software
202 should test whether specific features are supported instead of relying
203 on version number checks. These values are primarily intended for
204 reporting to human administrators.
207 <column name="ovs_version">
208 The Open vSwitch version number, e.g. <code>1.1.0pre2</code>.
209 If Open vSwitch was configured with a build number, then it is
210 also included, e.g. <code>1.1.0pre2+build4948</code>.
213 <column name="db_version">
215 The database schema version number in the form
216 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
217 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
218 a non-backward compatible way (e.g. deleting a column or a table),
219 <var>major</var> is incremented. When the database schema is changed
220 in a backward compatible way (e.g. adding a new column),
221 <var>minor</var> is incremented. When the database schema is changed
222 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
227 The schema version is part of the database schema, so it can also be
228 retrieved by fetching the schema using the Open vSwitch database
233 <column name="system_type">
235 An identifier for the type of system on top of which Open vSwitch
236 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
239 System integrators are responsible for choosing and setting an
240 appropriate value for this column.
244 <column name="system_version">
246 The version of the system identified by <ref column="system_type"/>,
247 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
250 System integrators are responsible for choosing and setting an
251 appropriate value for this column.
257 <group title="Database Configuration">
259 These columns primarily configure the Open vSwitch database
260 (<code>ovsdb-server</code>), not the Open vSwitch switch
261 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
262 column="ssl"/> settings.
266 The Open vSwitch switch does read the database configuration to
267 determine remote IP addresses to which in-band control should apply.
270 <column name="manager_options">
271 Database clients to which the Open vSwitch database server should
272 connect or to which it should listen, along with options for how these
273 connection should be configured. See the <ref table="Manager"/> table
274 for more information.
279 <table name="Bridge">
281 Configuration for a bridge within an
282 <ref table="Open_vSwitch"/>.
285 A <ref table="Bridge"/> record represents an Ethernet switch with one or
286 more ``ports,'' which are the <ref table="Port"/> records pointed to by
287 the <ref table="Bridge"/>'s <ref column="ports"/> column.
290 <group title="Core Features">
292 Bridge identifier. Should be alphanumeric and no more than about 8
293 bytes long. Must be unique among the names of ports, interfaces, and
297 <column name="ports">
298 Ports included in the bridge.
301 <column name="mirrors">
302 Port mirroring configuration.
305 <column name="netflow">
306 NetFlow configuration.
309 <column name="sflow">
313 <column name="flood_vlans">
314 VLAN IDs of VLANs on which MAC address learning should be disabled, so
315 that packets are flooded instead of being sent to specific ports that
316 are believed to contain packets' destination MACs. This should
317 ordinarily be used to disable MAC learning on VLANs used for mirroring
318 (RSPAN VLANs). It may also be useful for debugging.
322 <group title="OpenFlow Configuration">
323 <column name="controller">
324 OpenFlow controller set. If unset, then no OpenFlow controllers
328 <column name="fail_mode">
329 <p>When a controller is configured, it is, ordinarily, responsible
330 for setting up all flows on the switch. Thus, if the connection to
331 the controller fails, no new network connections can be set up.
332 If the connection to the controller stays down long enough,
333 no packets can pass through the switch at all. This setting
334 determines the switch's response to such a situation. It may be set
335 to one of the following:
337 <dt><code>standalone</code></dt>
338 <dd>If no message is received from the controller for three
339 times the inactivity probe interval
340 (see <ref column="inactivity_probe"/>), then Open vSwitch
341 will take over responsibility for setting up flows. In
342 this mode, Open vSwitch causes the bridge to act like an
343 ordinary MAC-learning switch. Open vSwitch will continue
344 to retry connecting to the controller in the background
345 and, when the connection succeeds, it will discontinue its
346 standalone behavior.</dd>
347 <dt><code>secure</code></dt>
348 <dd>Open vSwitch will not set up flows on its own when the
349 controller connection fails or when no controllers are
350 defined. The bridge will continue to retry connecting to
351 any defined controllers forever.</dd>
354 <p>If this value is unset, the default is implementation-specific.</p>
355 <p>When more than one controller is configured,
356 <ref column="fail_mode"/> is considered only when none of the
357 configured controllers can be contacted.</p>
360 <column name="datapath_id">
361 Reports the OpenFlow datapath ID in use. Exactly 16 hex
362 digits. (Setting this column will have no useful effect. Set
363 <ref column="other_config"/>:<code>other-config</code>
368 <group title="Other Features">
369 <column name="datapath_type">
370 Name of datapath provider. The kernel datapath has
371 type <code>system</code>. The userspace datapath has
372 type <code>netdev</code>.
375 <column name="external_ids">
376 Key-value pairs for use by external frameworks that integrate
377 with Open vSwitch, rather than by Open vSwitch itself. System
378 integrators should either use the Open vSwitch development
379 mailing list to coordinate on common key-value definitions, or
380 choose key names that are likely to be unique. The currently
381 defined key-value pairs are:
383 <dt><code>bridge-id</code></dt>
384 <dd>A unique identifier of the bridge. On Citrix XenServer this
385 will commonly be the same as <code>xs-network-uuids</code>.</dd>
386 <dt><code>xs-network-uuids</code></dt>
387 <dd>Semicolon-delimited set of universally unique identifier(s) for
388 the network with which this bridge is associated on a Citrix
389 XenServer host. The network identifiers are RFC 4122 UUIDs as
390 displayed by, e.g., <code>xe network-list</code>.</dd>
394 <column name="other_config">
395 Key-value pairs for configuring rarely used bridge
396 features. The currently defined key-value pairs are:
398 <dt><code>datapath-id</code></dt>
400 digits to set the OpenFlow datapath ID to a specific
401 value. May not be all-zero.</dd>
402 <dt><code>disable-in-band</code></dt>
403 <dd>If set to <code>true</code>, disable in-band control on
404 the bridge regardless of controller and manager settings.</dd>
405 <dt><code>hwaddr</code></dt>
406 <dd>An Ethernet address in the form
407 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
408 to set the hardware address of the local port and influence the
410 <dt><code>in-band-queue</code></dt>
412 A queue ID as a nonnegative integer. This sets the OpenFlow queue
413 ID that will be used by flows set up by in-band control on this
414 bridge. If unset, or if the port used by an in-band control flow
415 does not have QoS configured, or if the port does not have a queue
416 with the specified ID, the default queue is used instead.
423 <table name="Port" table="Port or bond configuration.">
424 <p>A port within a <ref table="Bridge"/>.</p>
425 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
426 <ref column="interfaces"/> column. Such a port logically
427 corresponds to a port on a physical Ethernet switch. A port
428 with more than one interface is a ``bonded port'' (see
429 <ref group="Bonding Configuration"/>).</p>
430 <p>Some properties that one might think as belonging to a port are actually
431 part of the port's <ref table="Interface"/> members.</p>
434 Port name. Should be alphanumeric and no more than about 8
435 bytes long. May be the same as the interface name, for
436 non-bonded ports. Must otherwise be unique among the names of
437 ports, interfaces, and bridges on a host.
440 <column name="interfaces">
441 The port's interfaces. If there is more than one, this is a
445 <group title="VLAN Configuration">
446 <p>A bridge port must be configured for VLANs in one of two
447 mutually exclusive ways:
449 <li>A ``trunk port'' has an empty value for <ref
450 column="tag"/>. Its <ref column="trunks"/> value may be
451 empty or non-empty.</li>
452 <li>An ``implicitly tagged VLAN port'' or ``access port''
453 has an nonempty value for <ref column="tag"/>. Its
454 <ref column="trunks"/> value must be empty.</li>
456 If <ref column="trunks"/> and <ref column="tag"/> are both
457 nonempty, the configuration is ill-formed.
462 If this is an access port (see above), the port's implicitly
463 tagged VLAN. Must be empty if this is a trunk port.
466 Frames arriving on trunk ports will be forwarded to this
467 port only if they are tagged with the given VLAN (or, if
468 <ref column="tag"/> is 0, then if they lack a VLAN header).
469 Frames arriving on other access ports will be forwarded to
470 this port only if they have the same <ref column="tag"/>
471 value. Frames forwarded to this port will not have an
475 When a frame with a 802.1Q header that indicates a nonzero
476 VLAN is received on an access port, it is discarded.
480 <column name="trunks">
482 If this is a trunk port (see above), the 802.1Q VLAN(s) that
483 this port trunks; if it is empty, then the port trunks all
484 VLANs. Must be empty if this is an access port.
487 Frames arriving on trunk ports are dropped if they are not
488 in one of the specified VLANs. For this purpose, packets
489 that have no VLAN header are treated as part of VLAN 0.
494 <group title="Bonding Configuration">
495 <p>A port that has more than one interface is a ``bonded port.'' Bonding
496 allows for load balancing and fail-over. Some kinds of bonding will
497 work with any kind of upstream switch:</p>
500 <dt><code>balance-slb</code></dt>
502 Balances flows among slaves based on source MAC address and output
503 VLAN, with periodic rebalancing as traffic patterns change.
506 <dt><code>active-backup</code></dt>
508 Assigns all flows to one slave, failing over to a backup slave when
509 the active slave is disabled.
514 The following mode requires the upstream switch to support 802.3ad with
515 successful LACP negotiation. If LACP negotiation fails then
516 <code>balance-slb</code> mode is used as a fallback:
520 <dt><code>balance-tcp</code></dt>
522 Balances flows among slaves based on L2, L3, and L4 protocol
523 information such as destination MAC address, IP address, and TCP
528 <p>These columns apply only to bonded ports. Their values are
529 otherwise ignored.</p>
531 <column name="bond_mode">
532 <p>The type of bonding used for a bonded port. Defaults to
533 <code>balance-slb</code> if unset.
537 <column name="bond_updelay">
538 <p>For a bonded port, the number of milliseconds for which carrier must
539 stay up on an interface before the interface is considered to be up.
540 Specify <code>0</code> to enable the interface immediately.</p>
541 <p>This setting is honored only when at least one bonded interface is
542 already enabled. When no interfaces are enabled, then the first bond
543 interface to come up is enabled immediately.</p>
546 <column name="bond_downdelay">
547 For a bonded port, the number of milliseconds for which carrier must
548 stay down on an interface before the interface is considered to be
549 down. Specify <code>0</code> to disable the interface immediately.
552 <column name="bond_fake_iface">
553 For a bonded port, whether to create a fake internal interface with the
554 name of the port. Use only for compatibility with legacy software that
559 <p>Configures LACP on this port. LACP allows directly connected
560 switches to negotiate which links may be bonded. LACP may be enabled
561 on non-bonded ports for the benefit of any switches they may be
562 connected to. <code>active</code> ports are allowed to initiate LACP
563 negotiations. <code>passive</code> ports are allowed to participate
564 in LACP negotiations initiated by a remote switch, but not allowed to
565 initiate such negotiations themselves. If unset Open vSwitch will
566 choose a reasonable default. </p>
571 <group title="Other Features">
573 Quality of Service configuration for this port.
577 The MAC address to use for this port for the purpose of choosing the
578 bridge's MAC address. This column does not necessarily reflect the
579 port's actual MAC address, nor will setting it change the port's actual
583 <column name="fake_bridge">
584 Does this port represent a sub-bridge for its tagged VLAN within the
585 Bridge? See ovs-vsctl(8) for more information.
588 <column name="external_ids">
590 Key-value pairs for use by external frameworks that integrate with
591 Open vSwitch, rather than by Open vSwitch itself. System integrators
592 should either use the Open vSwitch development mailing list to
593 coordinate on common key-value definitions, or choose key names that
594 are likely to be unique.
597 No key-value pairs native to <ref table="Port"/> are currently
598 defined. For fake bridges (see the <ref column="fake_bridge"/>
599 column), external IDs for the fake bridge are defined here by
600 prefixing a <ref table="Bridge"/> <ref table="Bridge"
601 column="external_ids"/> key with <code>fake-bridge-</code>,
602 e.g. <code>fake-bridge-xs-network-uuids</code>.
606 <column name="other_config">
607 Key-value pairs for configuring rarely used port features. The
608 currently defined key-value pairs are:
610 <dt><code>hwaddr</code></dt>
611 <dd>An Ethernet address in the form
612 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
613 <dt><code>bond-rebalance-interval</code></dt>
614 <dd>For an SLB bonded port, the number of milliseconds between
615 successive attempts to rebalance the bond, that is, to
616 move source MACs and their flows from one interface on
617 the bond to another in an attempt to keep usage of each
618 interface roughly equal. The default is 10000 (10
619 seconds), and the minimum is 1000 (1 second).</dd>
620 <dt><code>bond-detect-mode</code></dt>
621 <dd> Sets the method used to detect link failures in a bonded port.
622 Options are <code>carrier</code> and <code>miimon</code>. Defaults
623 to <code>carrier</code> which uses each interface's carrier to detect
624 failures. When set to <code>miimon</code>, will check for failures
625 by polling each interface's MII. </dd>
626 <dt><code>bond-miimon-interval</code></dt>
627 <dd> The number of milliseconds between successive attempts to
628 poll each interface's MII. Only relevant on ports which use
629 <code>miimon</code> to detect failures. </dd>
630 <dt><code>lacp-system-priority</code></dt>
631 <dd> The LACP system priority of this <ref table="Port"/>. In
632 LACP negotiations, link status decisions are made by the system
633 with the numerically lower priority. Must be a number between 1
640 <table name="Interface" title="One physical network device in a Port.">
641 An interface within a <ref table="Port"/>.
643 <group title="Core Features">
645 Interface name. Should be alphanumeric and no more than about 8 bytes
646 long. May be the same as the port name, for non-bonded ports. Must
647 otherwise be unique among the names of ports, interfaces, and bridges
652 <p>Ethernet address to set for this interface. If unset then the
653 default MAC address is used:</p>
655 <li>For the local interface, the default is the lowest-numbered MAC
656 address among the other bridge ports, either the value of the
657 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
658 if set, or its actual MAC (for bonded ports, the MAC of its slave
659 whose name is first in alphabetical order). Internal ports and
660 bridge ports that are used as port mirroring destinations (see the
661 <ref table="Mirror"/> table) are ignored.</li>
662 <li>For other internal interfaces, the default MAC is randomly
664 <li>External interfaces typically have a MAC address associated with
667 <p>Some interfaces may not have a software-controllable MAC
671 <column name="ofport">
672 <p>OpenFlow port number for this interface. Unlike most columns, this
673 column's value should be set only by Open vSwitch itself. Other
674 clients should set this column to an empty set (the default) when
675 creating an <ref table="Interface"/>.</p>
676 <p>Open vSwitch populates this column when the port number becomes
677 known. If the interface is successfully added,
678 <ref column="ofport"/> will be set to a number between 1 and 65535
679 (generally either in the range 1 to 65279, inclusive, or 65534, the
680 port number for the OpenFlow ``local port''). If the interface
681 cannot be added then Open vSwitch sets this column
686 <group title="System-Specific Details">
688 The interface type, one of:
690 <dt><code>system</code></dt>
691 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
692 Sometimes referred to as ``external interfaces'' since they are
693 generally connected to hardware external to that on which the Open
694 vSwitch is running. The empty string is a synonym for
695 <code>system</code>.</dd>
696 <dt><code>internal</code></dt>
697 <dd>A simulated network device that sends and receives traffic. An
698 internal interface whose <ref column="name"/> is the same as its
699 bridge's <ref table="Open_vSwitch" column="name"/> is called the
700 ``local interface.'' It does not make sense to bond an internal
701 interface, so the terms ``port'' and ``interface'' are often used
702 imprecisely for internal interfaces.</dd>
703 <dt><code>tap</code></dt>
704 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
705 <dt><code>gre</code></dt>
706 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
707 tunnel. Each tunnel must be uniquely identified by the
708 combination of <code>remote_ip</code>, <code>local_ip</code>, and
709 <code>in_key</code>. Note that if two ports are defined that are
710 the same except one has an optional identifier and the other does
711 not, the more specific one is matched first. <code>in_key</code>
712 is considered more specific than <code>local_ip</code> if a port
713 defines one and another port defines the other. The following
714 options may be specified in the <ref column="options"/> column:
716 <dt><code>remote_ip</code></dt>
717 <dd>Required. The tunnel endpoint.</dd>
720 <dt><code>local_ip</code></dt>
721 <dd>Optional. The destination IP that received packets must
722 match. Default is to match all addresses.</dd>
725 <dt><code>in_key</code></dt>
726 <dd>Optional. The GRE key that received packets must contain.
727 It may either be a 32-bit number (no key and a key of 0 are
728 treated as equivalent) or the word <code>flow</code>. If
729 <code>flow</code> is specified then any key will be accepted
730 and the key will be placed in the <code>tun_id</code> field
731 for matching in the flow table. The ovs-ofctl manual page
732 contains additional information about matching fields in
733 OpenFlow flows. Default is no key.</dd>
736 <dt><code>out_key</code></dt>
737 <dd>Optional. The GRE key to be set on outgoing packets. It may
738 either be a 32-bit number or the word <code>flow</code>. If
739 <code>flow</code> is specified then the key may be set using
740 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
741 is used in the absence of an action). The ovs-ofctl manual
742 page contains additional information about the Nicira OpenFlow
743 vendor extensions. Default is no key.</dd>
746 <dt><code>key</code></dt>
747 <dd>Optional. Shorthand to set <code>in_key</code> and
748 <code>out_key</code> at the same time.</dd>
751 <dt><code>tos</code></dt>
752 <dd>Optional. The value of the ToS bits to be set on the
753 encapsulating packet. It may also be the word
754 <code>inherit</code>, in which case the ToS will be copied from
755 the inner packet if it is IPv4 or IPv6 (otherwise it will be
756 0). Note that the ECN fields are always inherited. Default is
760 <dt><code>ttl</code></dt>
761 <dd>Optional. The TTL to be set on the encapsulating packet.
762 It may also be the word <code>inherit</code>, in which case the
763 TTL will be copied from the inner packet if it is IPv4 or IPv6
764 (otherwise it will be the system default, typically 64).
765 Default is the system default TTL.</dd>
768 <dt><code>csum</code></dt>
769 <dd>Optional. Compute GRE checksums on outgoing packets.
770 Checksums present on incoming packets will be validated
771 regardless of this setting. Note that GRE checksums
772 impose a significant performance penalty as they cover the
773 entire packet. As the contents of the packet is typically
774 covered by L3 and L4 checksums, this additional checksum only
775 adds value for the GRE and encapsulated Ethernet headers.
776 Default is disabled, set to <code>true</code> to enable.</dd>
779 <dt><code>pmtud</code></dt>
780 <dd>Optional. Enable tunnel path MTU discovery. If enabled
781 ``ICMP destination unreachable - fragmentation'' needed
782 messages will be generated for IPv4 packets with the DF bit set
783 and IPv6 packets above the minimum MTU if the packet size
784 exceeds the path MTU minus the size of the tunnel headers. It
785 also forces the encapsulating packet DF bit to be set (it is
786 always set if the inner packet implies path MTU discovery).
787 Note that this option causes behavior that is typically
788 reserved for routers and therefore is not entirely in
789 compliance with the IEEE 802.1D specification for bridges.
790 Default is enabled, set to <code>false</code> to disable.</dd>
793 <dt><code>header_cache</code></dt>
794 <dd>Optional. Enable caching of tunnel headers and the output
795 path. This can lead to a significant performance increase
796 without changing behavior. In general it should not be
797 necessary to adjust this setting. However, the caching can
798 bypass certain components of the IP stack (such as IP tables)
799 and it may be useful to disable it if these features are
800 required or as a debugging measure. Default is enabled, set to
801 <code>false</code> to disable.</dd>
804 <dt><code>ipsec_gre</code></dt>
805 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
806 over IPv4 IPsec tunnel. Each tunnel (including those of type
807 <code>gre</code>) must be uniquely identified by the
808 combination of <code>remote_ip</code> and
809 <code>local_ip</code>. Note that if two ports are defined
810 that are the same except one has an optional identifier and
811 the other does not, the more specific one is matched first.
812 An authentication method of <code>peer_cert</code> or
813 <code>psk</code> must be defined. The following options may
814 be specified in the <ref column="options"/> column:
816 <dt><code>remote_ip</code></dt>
817 <dd>Required. The tunnel endpoint.</dd>
820 <dt><code>local_ip</code></dt>
821 <dd>Optional. The destination IP that received packets must
822 match. Default is to match all addresses.</dd>
825 <dt><code>peer_cert</code></dt>
826 <dd>Required for certificate authentication. A string
827 containing the peer's certificate in PEM format.
828 Additionally the host's certificate must be specified
829 with the <code>certificate</code> option.</dd>
832 <dt><code>certificate</code></dt>
833 <dd>Required for certificate authentication. The name of a
834 PEM file containing a certificate that will be presented
835 to the peer during authentication.</dd>
838 <dt><code>private_key</code></dt>
839 <dd>Optional for certificate authentication. The name of
840 a PEM file containing the private key associated with
841 <code>certificate</code>. If <code>certificate</code>
842 contains the private key, this option may be omitted.</dd>
845 <dt><code>psk</code></dt>
846 <dd>Required for pre-shared key authentication. Specifies a
847 pre-shared key for authentication that must be identical on
848 both sides of the tunnel.</dd>
851 <dt><code>in_key</code></dt>
852 <dd>Optional. The GRE key that received packets must contain.
853 It may either be a 32-bit number (no key and a key of 0 are
854 treated as equivalent) or the word <code>flow</code>. If
855 <code>flow</code> is specified then any key will be accepted
856 and the key will be placed in the <code>tun_id</code> field
857 for matching in the flow table. The ovs-ofctl manual page
858 contains additional information about matching fields in
859 OpenFlow flows. Default is no key.</dd>
862 <dt><code>out_key</code></dt>
863 <dd>Optional. The GRE key to be set on outgoing packets. It may
864 either be a 32-bit number or the word <code>flow</code>. If
865 <code>flow</code> is specified then the key may be set using
866 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
867 is used in the absence of an action). The ovs-ofctl manual
868 page contains additional information about the Nicira OpenFlow
869 vendor extensions. Default is no key.</dd>
872 <dt><code>key</code></dt>
873 <dd>Optional. Shorthand to set <code>in_key</code> and
874 <code>out_key</code> at the same time.</dd>
877 <dt><code>tos</code></dt>
878 <dd>Optional. The value of the ToS bits to be set on the
879 encapsulating packet. It may also be the word
880 <code>inherit</code>, in which case the ToS will be copied from
881 the inner packet if it is IPv4 or IPv6 (otherwise it will be
882 0). Note that the ECN fields are always inherited. Default is
886 <dt><code>ttl</code></dt>
887 <dd>Optional. The TTL to be set on the encapsulating packet.
888 It may also be the word <code>inherit</code>, in which case the
889 TTL will be copied from the inner packet if it is IPv4 or IPv6
890 (otherwise it will be the system default, typically 64).
891 Default is the system default TTL.</dd>
894 <dt><code>csum</code></dt>
895 <dd>Optional. Compute GRE checksums on outgoing packets.
896 Checksums present on incoming packets will be validated
897 regardless of this setting. Note that GRE checksums
898 impose a significant performance penalty as they cover the
899 entire packet. As the contents of the packet is typically
900 covered by L3 and L4 checksums, this additional checksum only
901 adds value for the GRE and encapsulated Ethernet headers.
902 Default is disabled, set to <code>true</code> to enable.</dd>
905 <dt><code>pmtud</code></dt>
906 <dd>Optional. Enable tunnel path MTU discovery. If enabled
907 ``ICMP destination unreachable - fragmentation'' needed
908 messages will be generated for IPv4 packets with the DF bit set
909 and IPv6 packets above the minimum MTU if the packet size
910 exceeds the path MTU minus the size of the tunnel headers. It
911 also forces the encapsulating packet DF bit to be set (it is
912 always set if the inner packet implies path MTU discovery).
913 Note that this option causes behavior that is typically
914 reserved for routers and therefore is not entirely in
915 compliance with the IEEE 802.1D specification for bridges.
916 Default is enabled, set to <code>false</code> to disable.</dd>
919 <dt><code>capwap</code></dt>
920 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
921 (RFC 5415). This allows interoperability with certain switches
922 where GRE is not available. Note that only the tunneling component
923 of the protocol is implemented. Due to the non-standard use of
924 CAPWAP, UDP ports 58881 and 58882 are used as the source and
925 destinations ports respectivedly. Each tunnel must be uniquely
926 identified by the combination of <code>remote_ip</code> and
927 <code>local_ip</code>. If two ports are defined that are the same
928 except one includes <code>local_ip</code> and the other does not,
929 the more specific one is matched first. CAPWAP support is not
930 available on all platforms. Currently it is only supported in the
931 Linux kernel module with kernel versions >= 2.6.25. The following
932 options may be specified in the <ref column="options"/> column:
934 <dt><code>remote_ip</code></dt>
935 <dd>Required. The tunnel endpoint.</dd>
938 <dt><code>local_ip</code></dt>
939 <dd>Optional. The destination IP that received packets must
940 match. Default is to match all addresses.</dd>
943 <dt><code>tos</code></dt>
944 <dd>Optional. The value of the ToS bits to be set on the
945 encapsulating packet. It may also be the word
946 <code>inherit</code>, in which case the ToS will be copied from
947 the inner packet if it is IPv4 or IPv6 (otherwise it will be
948 0). Note that the ECN fields are always inherited. Default is
952 <dt><code>ttl</code></dt>
953 <dd>Optional. The TTL to be set on the encapsulating packet.
954 It may also be the word <code>inherit</code>, in which case the
955 TTL will be copied from the inner packet if it is IPv4 or IPv6
956 (otherwise it will be the system default, typically 64).
957 Default is the system default TTL.</dd>
960 <dt><code>pmtud</code></dt>
961 <dd>Optional. Enable tunnel path MTU discovery. If enabled
962 ``ICMP destination unreachable - fragmentation'' needed
963 messages will be generated for IPv4 packets with the DF bit set
964 and IPv6 packets above the minimum MTU if the packet size
965 exceeds the path MTU minus the size of the tunnel headers. It
966 also forces the encapsulating packet DF bit to be set (it is
967 always set if the inner packet implies path MTU discovery).
968 Note that this option causes behavior that is typically
969 reserved for routers and therefore is not entirely in
970 compliance with the IEEE 802.1D specification for bridges.
971 Default is enabled, set to <code>false</code> to disable.</dd>
974 <dt><code>header_cache</code></dt>
975 <dd>Optional. Enable caching of tunnel headers and the output
976 path. This can lead to a significant performance increase
977 without changing behavior. In general it should not be
978 necessary to adjust this setting. However, the caching can
979 bypass certain components of the IP stack (such as IP tables)
980 and it may be useful to disable it if these features are
981 required or as a debugging measure. Default is enabled, set to
982 <code>false</code> to disable.</dd>
985 <dt><code>patch</code></dt>
988 A pair of virtual devices that act as a patch cable. The <ref
989 column="options"/> column must have the following key-value pair:
992 <dt><code>peer</code></dt>
994 The <ref column="name"/> of the <ref table="Interface"/> for
995 the other side of the patch. The named <ref
996 table="Interface"/>'s own <code>peer</code> option must specify
997 this <ref table="Interface"/>'s name. That is, the two patch
998 interfaces must have reversed <ref column="name"/> and
999 <code>peer</code> values.
1006 <column name="options">
1007 Configuration options whose interpretation varies based on
1008 <ref column="type"/>.
1012 <group title="Interface Status">
1014 Status information about interfaces attached to bridges, updated every
1015 5 seconds. Not all interfaces have all of these properties; virtual
1016 interfaces don't have a link speed, for example. Non-applicable
1017 columns will have empty values.
1019 <column name="admin_state">
1021 The administrative state of the physical network link.
1025 <column name="link_state">
1027 The observed state of the physical network link;
1028 i.e. whether a carrier is detected by the interface.
1032 <column name="link_speed">
1034 The negotiated speed of the physical network link.
1035 Valid values are positive integers greater than 0.
1039 <column name="duplex">
1041 The duplex mode of the physical network link.
1047 The MTU (maximum transmission unit); i.e. the largest
1048 amount of data that can fit into a single Ethernet frame.
1049 The standard Ethernet MTU is 1500 bytes. Some physical media
1050 and many kinds of virtual interfaces can be configured with
1054 This column will be empty for an interface that does not
1055 have an MTU as, for example, some kinds of tunnels do not.
1059 <column name="status">
1061 Key-value pairs that report port status. Supported status
1062 values are <code>type</code>-dependent; some interfaces may not have
1063 a valid <code>driver_name</code>, for example.
1065 <p>The currently defined key-value pairs are:</p>
1067 <dt><code>driver_name</code></dt>
1068 <dd>The name of the device driver controlling the network
1072 <dt><code>driver_version</code></dt>
1073 <dd>The version string of the device driver controlling the
1074 network adapter.</dd>
1077 <dt><code>firmware_version</code></dt>
1078 <dd>The version string of the network adapter's firmware, if
1082 <dt><code>source_ip</code></dt>
1083 <dd>The source IP address used for an IPv4 tunnel end-point,
1084 such as <code>gre</code> or <code>capwap</code>.</dd>
1087 <dt><code>tunnel_egress_iface</code></dt>
1088 <dd>Egress interface for tunnels. Currently only relevant for GRE
1089 and CAPWAP tunnels. On Linux systems, this column will show
1090 the name of the interface which is responsible for routing
1091 traffic destined for the configured <code>remote_ip</code>.
1092 This could be an internal interface such as a bridge port.</dd>
1095 <dt><code>tunnel_egress_iface_carrier</code></dt>
1096 <dd>Whether a carrier is detected on <ref
1097 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1098 and <code>up</code>.</dd>
1103 <group title="Ingress Policing">
1105 These settings control ingress policing for packets received on this
1106 interface. On a physical interface, this limits the rate at which
1107 traffic is allowed into the system from the outside; on a virtual
1108 interface (one connected to a virtual machine), this limits the rate at
1109 which the VM is able to transmit.
1112 Policing is a simple form of quality-of-service that simply drops
1113 packets received in excess of the configured rate. Due to its
1114 simplicity, policing is usually less accurate and less effective than
1115 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1116 table="Queue"/> tables).
1119 Policing is currently implemented only on Linux. The Linux
1120 implementation uses a simple ``token bucket'' approach:
1124 The size of the bucket corresponds to <ref
1125 column="ingress_policing_burst"/>. Initially the bucket is full.
1128 Whenever a packet is received, its size (converted to tokens) is
1129 compared to the number of tokens currently in the bucket. If the
1130 required number of tokens are available, they are removed and the
1131 packet is forwarded. Otherwise, the packet is dropped.
1134 Whenever it is not full, the bucket is refilled with tokens at the
1135 rate specified by <ref column="ingress_policing_rate"/>.
1139 Policing interacts badly with some network protocols, and especially
1140 with fragmented IP packets. Suppose that there is enough network
1141 activity to keep the bucket nearly empty all the time. Then this token
1142 bucket algorithm will forward a single packet every so often, with the
1143 period depending on packet size and on the configured rate. All of the
1144 fragments of an IP packets are normally transmitted back-to-back, as a
1145 group. In such a situation, therefore, only one of these fragments
1146 will be forwarded and the rest will be dropped. IP does not provide
1147 any way for the intended recipient to ask for only the remaining
1148 fragments. In such a case there are two likely possibilities for what
1149 will happen next: either all of the fragments will eventually be
1150 retransmitted (as TCP will do), in which case the same problem will
1151 recur, or the sender will not realize that its packet has been dropped
1152 and data will simply be lost (as some UDP-based protocols will do).
1153 Either way, it is possible that no forward progress will ever occur.
1155 <column name="ingress_policing_rate">
1157 Maximum rate for data received on this interface, in kbps. Data
1158 received faster than this rate is dropped. Set to <code>0</code>
1159 (the default) to disable policing.
1163 <column name="ingress_policing_burst">
1164 <p>Maximum burst size for data received on this interface, in kb. The
1165 default burst size if set to <code>0</code> is 1000 kb. This value
1166 has no effect if <ref column="ingress_policing_rate"/>
1167 is <code>0</code>.</p>
1169 Specifying a larger burst size lets the algorithm be more forgiving,
1170 which is important for protocols like TCP that react severely to
1171 dropped packets. The burst size should be at least the size of the
1172 interface's MTU. Specifying a value that is numerically at least as
1173 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1174 closer to achieving the full rate.
1179 <group title="Other Features">
1181 <column name="monitor">
1182 Connectivity monitor configuration for this interface.
1185 <column name="external_ids">
1186 Key-value pairs for use by external frameworks that integrate
1187 with Open vSwitch, rather than by Open vSwitch itself. System
1188 integrators should either use the Open vSwitch development
1189 mailing list to coordinate on common key-value definitions, or
1190 choose key names that are likely to be unique. The currently
1191 defined common key-value pairs are:
1193 <dt><code>attached-mac</code></dt>
1195 The MAC address programmed into the ``virtual hardware'' for this
1196 interface, in the form
1197 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1198 For Citrix XenServer, this is the value of the <code>MAC</code>
1199 field in the VIF record for this interface.</dd>
1200 <dt><code>iface-id</code></dt>
1201 <dd>A system-unique identifier for the interface. On XenServer,
1202 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1205 Additionally the following key-value pairs specifically
1206 apply to an interface that represents a virtual Ethernet interface
1207 connected to a virtual machine. These key-value pairs should not be
1208 present for other types of interfaces. Keys whose names end
1209 in <code>-uuid</code> have values that uniquely identify the entity
1210 in question. For a Citrix XenServer hypervisor, these values are
1211 UUIDs in RFC 4122 format. Other hypervisors may use other
1214 <p>The currently defined key-value pairs for XenServer are:</p>
1216 <dt><code>xs-vif-uuid</code></dt>
1217 <dd>The virtual interface associated with this interface.</dd>
1218 <dt><code>xs-network-uuid</code></dt>
1219 <dd>The virtual network to which this interface is attached.</dd>
1220 <dt><code>xs-vm-uuid</code></dt>
1221 <dd>The VM to which this interface belongs.</dd>
1225 <column name="other_config">
1226 Key-value pairs for rarely used interface features.
1228 <dt><code>lacp-port-priority</code></dt>
1229 <dd> The LACP port priority of this <ref table="Interface"/>. In
1230 LACP negotiations <ref table="Interface"/>s with numerically lower
1231 priorities are preferred for aggregation. Must be a number between
1236 <column name="statistics">
1238 Key-value pairs that report interface statistics. The current
1239 implementation updates these counters periodically. In the future,
1240 we plan to, instead, update them when an interface is created, when
1241 they are queried (e.g. using an OVSDB <code>select</code> operation),
1242 and just before an interface is deleted due to virtual interface
1243 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1244 regular periodic basis.</p>
1246 The currently defined key-value pairs are listed below. These are
1247 the same statistics reported by OpenFlow in its <code>struct
1248 ofp_port_stats</code> structure. If an interface does not support a
1249 given statistic, then that pair is omitted.</p>
1252 Successful transmit and receive counters:
1254 <dt><code>rx_packets</code></dt>
1255 <dd>Number of received packets.</dd>
1256 <dt><code>rx_bytes</code></dt>
1257 <dd>Number of received bytes.</dd>
1258 <dt><code>tx_packets</code></dt>
1259 <dd>Number of transmitted packets.</dd>
1260 <dt><code>tx_bytes</code></dt>
1261 <dd>Number of transmitted bytes.</dd>
1267 <dt><code>rx_dropped</code></dt>
1268 <dd>Number of packets dropped by RX.</dd>
1269 <dt><code>rx_frame_err</code></dt>
1270 <dd>Number of frame alignment errors.</dd>
1271 <dt><code>rx_over_err</code></dt>
1272 <dd>Number of packets with RX overrun.</dd>
1273 <dt><code>rx_crc_err</code></dt>
1274 <dd>Number of CRC errors.</dd>
1275 <dt><code>rx_errors</code></dt>
1277 Total number of receive errors, greater than or equal
1278 to the sum of the above.
1285 <dt><code>tx_dropped</code></dt>
1286 <dd>Number of packets dropped by TX.</dd>
1287 <dt><code>collisions</code></dt>
1288 <dd>Number of collisions.</dd>
1289 <dt><code>tx_errors</code></dt>
1291 Total number of transmit errors, greater
1292 than or equal to the sum of the above.
1301 <table name="QoS" title="Quality of Service configuration">
1302 <p>Quality of Service (QoS) configuration for each Port that
1305 <column name="type">
1306 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1307 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1308 identifies the types that a switch actually supports. The currently
1309 defined types are listed below:</p>
1311 <dt><code>linux-htb</code></dt>
1313 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1314 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1315 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1316 for information on how this classifier works and how to configure it.
1320 <dt><code>linux-hfsc</code></dt>
1322 Linux "Hierarchical Fair Service Curve" classifier.
1323 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1324 information on how this classifier works.
1329 <column name="queues">
1330 <p>A map from queue numbers to <ref table="Queue"/> records. The
1331 supported range of queue numbers depend on <ref column="type"/>. The
1332 queue numbers are the same as the <code>queue_id</code> used in
1333 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1334 structures. Queue 0 is used by OpenFlow output actions that do not
1335 specify a specific queue.</p>
1338 <column name="other_config">
1339 <p>Key-value pairs for configuring QoS features that depend on
1340 <ref column="type"/>.</p>
1341 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1342 the following key-value pairs:</p>
1344 <dt><code>max-rate</code></dt>
1345 <dd>Maximum rate shared by all queued traffic, in bit/s.
1346 Optional. If not specified, for physical interfaces, the
1347 default is the link rate. For other interfaces or if the
1348 link rate cannot be determined, the default is currently 100
1353 <column name="external_ids">
1354 Key-value pairs for use by external frameworks that integrate with Open
1355 vSwitch, rather than by Open vSwitch itself. System integrators should
1356 either use the Open vSwitch development mailing list to coordinate on
1357 common key-value definitions, or choose key names that are likely to be
1358 unique. No common key-value pairs are currently defined.
1362 <table name="Queue" title="QoS output queue.">
1363 <p>A configuration for a port output queue, used in configuring Quality of
1364 Service (QoS) features. May be referenced by <ref column="queues"
1365 table="QoS"/> column in <ref table="QoS"/> table.</p>
1367 <column name="other_config">
1368 <p>Key-value pairs for configuring the output queue. The supported
1369 key-value pairs and their meanings depend on the <ref column="type"/>
1370 of the <ref column="QoS"/> records that reference this row.</p>
1371 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1372 column="type"/> of <code>min-rate</code> are:</p>
1374 <dt><code>min-rate</code></dt>
1375 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1376 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1378 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1379 column="type"/> of <code>linux-htb</code> are:</p>
1381 <dt><code>min-rate</code></dt>
1382 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1383 <dt><code>max-rate</code></dt>
1384 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1385 queue's rate will not be allowed to exceed the specified value, even
1386 if excess bandwidth is available. If unspecified, defaults to no
1388 <dt><code>burst</code></dt>
1389 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1390 that a queue can accumulate while it is idle. Optional. Details of
1391 the <code>linux-htb</code> implementation require a minimum burst
1392 size, so a too-small <code>burst</code> will be silently
1394 <dt><code>priority</code></dt>
1395 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1396 unspecified. A queue with a smaller <code>priority</code>
1397 will receive all the excess bandwidth that it can use before
1398 a queue with a larger value receives any. Specific priority
1399 values are unimportant; only relative ordering matters.</dd>
1401 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1402 column="type"/> of <code>linux-hfsc</code> are:</p>
1404 <dt><code>min-rate</code></dt>
1405 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1406 <dt><code>max-rate</code></dt>
1407 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1408 queue's rate will not be allowed to exceed the specified value, even
1409 if excess bandwidth is available. If unspecified, defaults to no
1414 <column name="external_ids">
1415 Key-value pairs for use by external frameworks that integrate with Open
1416 vSwitch, rather than by Open vSwitch itself. System integrators should
1417 either use the Open vSwitch development mailing list to coordinate on
1418 common key-value definitions, or choose key names that are likely to be
1419 unique. No common key-value pairs are currently defined.
1423 <table name="Monitor" title="Connectivity Monitor configuration">
1425 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1426 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1427 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1428 to detect connectivity problems with each other. MPs within a MA should
1429 have complete and exclusive interconnectivity. This is verified by
1430 occasionally broadcasting Continuity Check Messages (CCMs) at a
1431 configurable transmission interval. A <ref table="Monitor"/> is
1432 responsible for collecting data about other MPs in its MA and
1436 <group title="Monitor Configuration">
1437 <column name="mpid">
1438 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1439 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1440 used to identify this <ref table="Monitor"/> to other endpoints in the
1444 <column name="remote_mps">
1445 A set of <ref table="Maintenance_Points"/> which this
1446 <ref table="Monitor"/> should have connectivity to. If this
1447 <ref table="Monitor"/> does not have connectivity to any MPs in this
1448 set, or has connectivity to any MPs not in this set, a fault is
1452 <column name="ma_name">
1453 A Maintenance Association (MA) name pairs with a Maintenance Domain
1454 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1455 have complete and exclusive interconnectivity. Defaults to
1456 <code>ovs</code> if unset.
1459 <column name="md_name">
1460 A Maintenance Domain name pairs with a Maintenance Association name to
1461 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1464 <column name="interval">
1465 The transmission interval of CCMs in milliseconds. Three missed CCMs
1466 indicate a connectivity fault. Defaults to 1000ms.
1470 <group title="Monitor Status">
1471 <column name="unexpected_remote_mpids">
1472 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1473 has detected connectivity that are not in the
1474 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1475 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1476 Thus, if this set is non-empty a fault is indicated.
1479 <column name="unexpected_remote_maids">
1480 A set of MAIDs representing foreign Maintenance Associations (MAs)
1481 which this <ref table="Monitor"/> has detected connectivity to. A
1482 <ref table="Monitor"/> should not have connectivity to a Maintenance
1483 Association other than its own. Thus, if this set is non-empty a fault
1487 <column name="fault">
1488 Indicates a Connectivity Fault caused by a configuration error, a down
1489 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1494 <table name="Maintenance_Point" title="Maintenance Point configuration">
1496 A <ref table="Maintenance_Point"/> represents a MP which a
1497 <ref table="Monitor"/> has or should have connectivity to.
1500 <group title="Maintenance_Point Configuration">
1501 <column name="mpid">
1502 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1503 a Maintenance Association. All MPs within a MA should have a unique
1508 <group title="Maintenance_Point Status">
1509 <column name="fault">
1510 Indicates a connectivity fault.
1515 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1516 <p>A port mirror within a <ref table="Bridge"/>.</p>
1517 <p>A port mirror configures a bridge to send selected frames to special
1518 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1519 traffic may also be referred to as SPAN or RSPAN, depending on the
1520 mechanism used for delivery.</p>
1522 <column name="name">
1523 Arbitrary identifier for the <ref table="Mirror"/>.
1526 <group title="Selecting Packets for Mirroring">
1527 <column name="select_all">
1528 If true, every packet arriving or departing on any port is
1529 selected for mirroring.
1532 <column name="select_dst_port">
1533 Ports on which departing packets are selected for mirroring.
1536 <column name="select_src_port">
1537 Ports on which arriving packets are selected for mirroring.
1540 <column name="select_vlan">
1541 VLANs on which packets are selected for mirroring. An empty set
1542 selects packets on all VLANs.
1546 <group title="Mirroring Destination Configuration">
1547 <column name="output_port">
1548 <p>Output port for selected packets, if nonempty. Mutually exclusive
1549 with <ref column="output_vlan"/>.</p>
1550 <p>Specifying a port for mirror output reserves that port exclusively
1551 for mirroring. No frames other than those selected for mirroring
1552 will be forwarded to the port, and any frames received on the port
1553 will be discarded.</p>
1554 <p>This type of mirroring is sometimes called SPAN.</p>
1557 <column name="output_vlan">
1558 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1559 with <ref column="output_port"/>.</p>
1560 <p>The frames will be sent out all ports that trunk
1561 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1562 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1563 trunk port, the frame's VLAN tag will be set to
1564 <ref column="output_vlan"/>, replacing any existing tag; when it is
1565 sent out an implicit VLAN port, the frame will not be tagged. This
1566 type of mirroring is sometimes called RSPAN.</p>
1567 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1568 contains unmanaged switches. Consider an unmanaged physical switch
1569 with two ports: port 1, connected to an end host, and port 2,
1570 connected to an Open vSwitch configured to mirror received packets
1571 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1572 port 1 that the physical switch forwards to port 2. The Open vSwitch
1573 forwards this packet to its destination and then reflects it back on
1574 port 2 in VLAN 123. This reflected packet causes the unmanaged
1575 physical switch to replace the MAC learning table entry, which
1576 correctly pointed to port 1, with one that incorrectly points to port
1577 2. Afterward, the physical switch will direct packets destined for
1578 the end host to the Open vSwitch on port 2, instead of to the end
1579 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1580 desired in this scenario, then the physical switch must be replaced
1581 by one that learns Ethernet addresses on a per-VLAN basis. In
1582 addition, learning should be disabled on the VLAN containing mirrored
1583 traffic. If this is not done then intermediate switches will learn
1584 the MAC address of each end host from the mirrored traffic. If
1585 packets being sent to that end host are also mirrored, then they will
1586 be dropped since the switch will attempt to send them out the input
1587 port. Disabling learning for the VLAN will cause the switch to
1588 correctly send the packet out all ports configured for that VLAN. If
1589 Open vSwitch is being used as an intermediate switch, learning can be
1590 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1591 in the appropriate <ref table="Bridge"/> table or tables.</p>
1595 <group title="Other Features">
1596 <column name="external_ids">
1597 Key-value pairs for use by external frameworks that integrate with Open
1598 vSwitch, rather than by Open vSwitch itself. System integrators should
1599 either use the Open vSwitch development mailing list to coordinate on
1600 common key-value definitions, or choose key names that are likely to be
1601 unique. No common key-value pairs are currently defined.
1606 <table name="Controller" title="OpenFlow controller configuration.">
1607 <p>An OpenFlow controller.</p>
1610 Open vSwitch supports two kinds of OpenFlow controllers:
1614 <dt>Primary controllers</dt>
1617 This is the kind of controller envisioned by the OpenFlow 1.0
1618 specification. Usually, a primary controller implements a network
1619 policy by taking charge of the switch's flow table.
1623 Open vSwitch initiates and maintains persistent connections to
1624 primary controllers, retrying the connection each time it fails or
1625 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1626 <ref table="Bridge"/> table applies to primary controllers.
1630 Open vSwitch permits a bridge to have any number of primary
1631 controllers. When multiple controllers are configured, Open
1632 vSwitch connects to all of them simultaneously. Because
1633 OpenFlow 1.0 does not specify how multiple controllers
1634 coordinate in interacting with a single switch, more than
1635 one primary controller should be specified only if the
1636 controllers are themselves designed to coordinate with each
1637 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1638 vendor extension may be useful for this.)
1641 <dt>Service controllers</dt>
1644 These kinds of OpenFlow controller connections are intended for
1645 occasional support and maintenance use, e.g. with
1646 <code>ovs-ofctl</code>. Usually a service controller connects only
1647 briefly to inspect or modify some of a switch's state.
1651 Open vSwitch listens for incoming connections from service
1652 controllers. The service controllers initiate and, if necessary,
1653 maintain the connections from their end. The <ref table="Bridge"
1654 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1655 not apply to service controllers.
1659 Open vSwitch supports configuring any number of service controllers.
1665 The <ref column="target"/> determines the type of controller.
1668 <group title="Core Features">
1669 <column name="target">
1670 <p>Connection method for controller.</p>
1672 The following connection methods are currently supported for primary
1676 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1678 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1679 the given <var>ip</var>, which must be expressed as an IP address
1680 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1681 column in the <ref table="Open_vSwitch"/> table must point to a
1682 valid SSL configuration when this form is used.</p>
1683 <p>SSL support is an optional feature that is not always built as
1684 part of Open vSwitch.</p>
1686 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1687 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1688 the given <var>ip</var>, which must be expressed as an IP address
1689 (not a DNS name).</dd>
1690 <dt><code>discover</code></dt>
1692 <p>Enables controller discovery.</p>
1693 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1694 request with vendor class identifier <code>OpenFlow</code> across
1695 all of the bridge's network devices. It will accept any valid
1696 DHCP reply that has the same vendor class identifier and includes
1697 a vendor-specific option with code 1 whose contents are a string
1698 specifying the location of the controller in the same format as
1699 <ref column="target"/>.</p>
1700 <p>The DHCP reply may also, optionally, include a vendor-specific
1701 option with code 2 whose contents are a string specifying the URI
1702 to the base of the OpenFlow PKI
1703 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1704 used only for bootstrapping the OpenFlow PKI at initial switch
1705 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1709 The following connection methods are currently supported for service
1713 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1716 Listens for SSL connections on the specified TCP <var>port</var>
1717 (default: 6633). If <var>ip</var>, which must be expressed as an
1718 IP address (not a DNS name), is specified, then connections are
1719 restricted to the specified local IP address.
1722 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1723 table="Open_vSwitch"/> table must point to a valid SSL
1724 configuration when this form is used.
1726 <p>SSL support is an optional feature that is not always built as
1727 part of Open vSwitch.</p>
1729 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1731 Listens for connections on the specified TCP <var>port</var>
1732 (default: 6633). If <var>ip</var>, which must be expressed as an
1733 IP address (not a DNS name), is specified, then connections are
1734 restricted to the specified local IP address.
1737 <p>When multiple controllers are configured for a single bridge, the
1738 <ref column="target"/> values must be unique. Duplicate
1739 <ref column="target"/> values yield unspecified results.</p>
1742 <column name="connection_mode">
1743 <p>If it is specified, this setting must be one of the following
1744 strings that describes how Open vSwitch contacts this OpenFlow
1745 controller over the network:</p>
1748 <dt><code>in-band</code></dt>
1749 <dd>In this mode, this controller's OpenFlow traffic travels over the
1750 bridge associated with the controller. With this setting, Open
1751 vSwitch allows traffic to and from the controller regardless of the
1752 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1753 would never be able to connect to the controller, because it did
1754 not have a flow to enable it.) This is the most common connection
1755 mode because it is not necessary to maintain two independent
1757 <dt><code>out-of-band</code></dt>
1758 <dd>In this mode, OpenFlow traffic uses a control network separate
1759 from the bridge associated with this controller, that is, the
1760 bridge does not use any of its own network devices to communicate
1761 with the controller. The control network must be configured
1762 separately, before or after <code>ovs-vswitchd</code> is started.
1766 <p>If not specified, the default is implementation-specific. If
1767 <ref column="target"/> is <code>discover</code>, the connection mode
1768 is always treated as <code>in-band</code> regardless of the actual
1773 <group title="Controller Failure Detection and Handling">
1774 <column name="max_backoff">
1775 Maximum number of milliseconds to wait between connection attempts.
1776 Default is implementation-specific.
1779 <column name="inactivity_probe">
1780 Maximum number of milliseconds of idle time on connection to
1781 controller before sending an inactivity probe message. If Open
1782 vSwitch does not communicate with the controller for the specified
1783 number of seconds, it will send a probe. If a response is not
1784 received for the same additional amount of time, Open vSwitch
1785 assumes the connection has been broken and attempts to reconnect.
1786 Default is implementation-specific.
1790 <group title="OpenFlow Rate Limiting">
1791 <column name="controller_rate_limit">
1792 <p>The maximum rate at which packets in unknown flows will be
1793 forwarded to the OpenFlow controller, in packets per second. This
1794 feature prevents a single bridge from overwhelming the controller.
1795 If not specified, the default is implementation-specific.</p>
1796 <p>In addition, when a high rate triggers rate-limiting, Open
1797 vSwitch queues controller packets for each port and transmits
1798 them to the controller at the configured rate. The number of
1799 queued packets is limited by
1800 the <ref column="controller_burst_limit"/> value. The packet
1801 queue is shared fairly among the ports on a bridge.</p><p>Open
1802 vSwitch maintains two such packet rate-limiters per bridge.
1803 One of these applies to packets sent up to the controller
1804 because they do not correspond to any flow. The other applies
1805 to packets sent up to the controller by request through flow
1806 actions. When both rate-limiters are filled with packets, the
1807 actual rate that packets are sent to the controller is up to
1808 twice the specified rate.</p>
1811 <column name="controller_burst_limit">
1812 In conjunction with <ref column="controller_rate_limit"/>,
1813 the maximum number of unused packet credits that the bridge will
1814 allow to accumulate, in packets. If not specified, the default
1815 is implementation-specific.
1819 <group title="Additional Discovery Configuration">
1820 <p>These values are considered only when <ref column="target"/>
1821 is <code>discover</code>.</p>
1823 <column name="discover_accept_regex">
1825 extended regular expression against which the discovered controller
1826 location is validated. The regular expression is implicitly
1827 anchored at the beginning of the controller location string, as
1828 if it begins with <code>^</code>. If not specified, the default
1829 is implementation-specific.
1832 <column name="discover_update_resolv_conf">
1833 Whether to update <code>/etc/resolv.conf</code> when the
1834 controller is discovered. If not specified, the default
1835 is implementation-specific. Open vSwitch will only modify
1836 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1837 specifies one or more DNS servers.
1841 <group title="Additional In-Band Configuration">
1842 <p>These values are considered only in in-band control mode (see
1843 <ref column="connection_mode"/>) and only when <ref column="target"/>
1844 is not <code>discover</code>. (For controller discovery, the network
1845 configuration obtained via DHCP is used instead.)</p>
1847 <p>When multiple controllers are configured on a single bridge, there
1848 should be only one set of unique values in these columns. If different
1849 values are set for these columns in different controllers, the effect
1852 <column name="local_ip">
1853 The IP address to configure on the local port,
1854 e.g. <code>192.168.0.123</code>. If this value is unset, then
1855 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1859 <column name="local_netmask">
1860 The IP netmask to configure on the local port,
1861 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1862 but this value is unset, then the default is chosen based on whether
1863 the IP address is class A, B, or C.
1866 <column name="local_gateway">
1867 The IP address of the gateway to configure on the local port, as a
1868 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1869 this network has no gateway.
1873 <group title="Other Features">
1874 <column name="external_ids">
1875 Key-value pairs for use by external frameworks that integrate with Open
1876 vSwitch, rather than by Open vSwitch itself. System integrators should
1877 either use the Open vSwitch development mailing list to coordinate on
1878 common key-value definitions, or choose key names that are likely to be
1879 unique. No common key-value pairs are currently defined.
1883 <group title="Controller Status">
1884 <column name="is_connected">
1885 <code>true</code> if currently connected to this controller,
1886 <code>false</code> otherwise.
1889 <column name="role">
1890 <p>The level of authority this controller has on the associated
1891 bridge. Possible values are:</p>
1893 <dt><code>other</code></dt>
1894 <dd>Allows the controller access to all OpenFlow features.</dd>
1897 <dt><code>master</code></dt>
1898 <dd>Equivalent to <code>other</code>, except that there may be at
1899 most one master controller at a time. When a controller configures
1900 itself as <code>master</code>, any existing master is demoted to
1901 the <code>slave</code>role.</dd>
1904 <dt><code>slave</code></dt>
1905 <dd>Allows the controller read-only access to OpenFlow features.
1906 Attempts to modify the flow table will be rejected with an
1907 error. Slave controllers do not receive OFPT_PACKET_IN or
1908 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1913 <column name="status">
1914 <p>Key-value pairs that report controller status.</p>
1916 <dt><code>last_error</code></dt>
1917 <dd>A human-readable description of the last error on the connection
1918 to the controller; i.e. <code>strerror(errno)</code>. This key
1919 will exist only if an error has occurred.</dd>
1922 <dt><code>state</code></dt>
1923 <dd>The state of the connection to the controller. Possible values
1924 are: <code>VOID</code>, <code>BACKOFF</code>,
1925 <code>CONNECTING</code>, <code>ACTIVE</code>, and
1926 <code>IDLE</code>.</dd>
1929 <dt><code>time_in_state</code></dt>
1930 <dd>Seconds since connecting to (if currently connected) or
1931 disconnecting from (if currently disconnected) this
1938 <table name="Manager" title="OVSDB management connection.">
1940 Configuration for a database connection to an Open vSwitch database
1945 This table primarily configures the Open vSwitch database
1946 (<code>ovsdb-server</code>), not the Open vSwitch switch
1947 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1948 what connections should be treated as in-band.
1952 The Open vSwitch database server can initiate and maintain active
1953 connections to remote clients. It can also listen for database
1957 <group title="Core Features">
1958 <column name="target">
1959 <p>Connection method for managers.</p>
1961 The following connection methods are currently supported:
1964 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1967 The specified SSL <var>port</var> (default: 6632) on the host at
1968 the given <var>ip</var>, which must be expressed as an IP address
1969 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1970 column in the <ref table="Open_vSwitch"/> table must point to a
1971 valid SSL configuration when this form is used.
1974 SSL support is an optional feature that is not always built as
1975 part of Open vSwitch.
1979 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1981 The specified TCP <var>port</var> (default: 6632) on the host at
1982 the given <var>ip</var>, which must be expressed as an IP address
1985 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1988 Listens for SSL connections on the specified TCP <var>port</var>
1989 (default: 6632). If <var>ip</var>, which must be expressed as an
1990 IP address (not a DNS name), is specified, then connections are
1991 restricted to the specified local IP address.
1994 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1995 table="Open_vSwitch"/> table must point to a valid SSL
1996 configuration when this form is used.
1999 SSL support is an optional feature that is not always built as
2000 part of Open vSwitch.
2003 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2005 Listens for connections on the specified TCP <var>port</var>
2006 (default: 6632). If <var>ip</var>, which must be expressed as an
2007 IP address (not a DNS name), is specified, then connections are
2008 restricted to the specified local IP address.
2011 <p>When multiple managers are configured, the <ref column="target"/>
2012 values must be unique. Duplicate <ref column="target"/> values yield
2013 unspecified results.</p>
2016 <column name="connection_mode">
2018 If it is specified, this setting must be one of the following strings
2019 that describes how Open vSwitch contacts this OVSDB client over the
2024 <dt><code>in-band</code></dt>
2026 In this mode, this connection's traffic travels over a bridge
2027 managed by Open vSwitch. With this setting, Open vSwitch allows
2028 traffic to and from the client regardless of the contents of the
2029 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2030 to connect to the client, because it did not have a flow to enable
2031 it.) This is the most common connection mode because it is not
2032 necessary to maintain two independent networks.
2034 <dt><code>out-of-band</code></dt>
2036 In this mode, the client's traffic uses a control network separate
2037 from that managed by Open vSwitch, that is, Open vSwitch does not
2038 use any of its own network devices to communicate with the client.
2039 The control network must be configured separately, before or after
2040 <code>ovs-vswitchd</code> is started.
2045 If not specified, the default is implementation-specific.
2050 <group title="Client Failure Detection and Handling">
2051 <column name="max_backoff">
2052 Maximum number of milliseconds to wait between connection attempts.
2053 Default is implementation-specific.
2056 <column name="inactivity_probe">
2057 Maximum number of milliseconds of idle time on connection to the client
2058 before sending an inactivity probe message. If Open vSwitch does not
2059 communicate with the client for the specified number of seconds, it
2060 will send a probe. If a response is not received for the same
2061 additional amount of time, Open vSwitch assumes the connection has been
2062 broken and attempts to reconnect. Default is implementation-specific.
2066 <group title="Other Features">
2067 <column name="external_ids">
2068 Key-value pairs for use by external frameworks that integrate with Open
2069 vSwitch, rather than by Open vSwitch itself. System integrators should
2070 either use the Open vSwitch development mailing list to coordinate on
2071 common key-value definitions, or choose key names that are likely to be
2072 unique. No common key-value pairs are currently defined.
2076 <group title="Status">
2077 <column name="is_connected">
2078 <code>true</code> if currently connected to this manager,
2079 <code>false</code> otherwise.
2082 <column name="status">
2083 <p>Key-value pairs that report manager status.</p>
2085 <dt><code>last_error</code></dt>
2086 <dd>A human-readable description of the last error on the connection
2087 to the manager; i.e. <code>strerror(errno)</code>. This key
2088 will exist only if an error has occurred.</dd>
2091 <dt><code>state</code></dt>
2092 <dd>The state of the connection to the manager. Possible values
2093 are: <code>VOID</code> (connection is disabled),
2094 <code>BACKOFF</code> (attempting to reconnect at an increasing
2095 period), <code>CONNECT_IN_PROGRESS</code> (attempting to connect),
2096 <code>ACTIVE</code> (connected, remote host responsive), and
2097 <code>IDLE</code> (remote host unresponsive, disconnecting). These
2098 values may change in the future. They are provided only for human
2102 <dt><code>time_in_state</code></dt>
2103 <dd>Milliseconds since the <code>state</code> key changed.</dd>
2109 <table name="NetFlow">
2110 A NetFlow target. NetFlow is a protocol that exports a number of
2111 details about terminating IP flows, such as the principals involved
2114 <column name="targets">
2115 NetFlow targets in the form
2116 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2117 must be specified numerically, not as a DNS name.
2120 <column name="engine_id">
2121 Engine ID to use in NetFlow messages. Defaults to datapath index
2125 <column name="engine_type">
2126 Engine type to use in NetFlow messages. Defaults to datapath
2127 index if not specified.
2130 <column name="active_timeout">
2131 The interval at which NetFlow records are sent for flows that are
2132 still active, in seconds. A value of <code>0</code> requests the
2133 default timeout (currently 600 seconds); a value of <code>-1</code>
2134 disables active timeouts.
2137 <column name="add_id_to_interface">
2138 <p>If this column's value is <code>false</code>, the ingress and egress
2139 interface fields of NetFlow flow records are derived from OpenFlow port
2140 numbers. When it is <code>true</code>, the 7 most significant bits of
2141 these fields will be replaced by the least significant 7 bits of the
2142 engine id. This is useful because many NetFlow collectors do not
2143 expect multiple switches to be sending messages from the same host, so
2144 they do not store the engine information which could be used to
2145 disambiguate the traffic.</p>
2146 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2149 <column name="external_ids">
2150 Key-value pairs for use by external frameworks that integrate with Open
2151 vSwitch, rather than by Open vSwitch itself. System integrators should
2152 either use the Open vSwitch development mailing list to coordinate on
2153 common key-value definitions, or choose key names that are likely to be
2154 unique. No common key-value pairs are currently defined.
2159 SSL configuration for an Open_vSwitch.
2161 <column name="private_key">
2162 Name of a PEM file containing the private key used as the switch's
2163 identity for SSL connections to the controller.
2166 <column name="certificate">
2167 Name of a PEM file containing a certificate, signed by the
2168 certificate authority (CA) used by the controller and manager,
2169 that certifies the switch's private key, identifying a trustworthy
2173 <column name="ca_cert">
2174 Name of a PEM file containing the CA certificate used to verify
2175 that the switch is connected to a trustworthy controller.
2178 <column name="bootstrap_ca_cert">
2179 If set to <code>true</code>, then Open vSwitch will attempt to
2180 obtain the CA certificate from the controller on its first SSL
2181 connection and save it to the named PEM file. If it is successful,
2182 it will immediately drop the connection and reconnect, and from then
2183 on all SSL connections must be authenticated by a certificate signed
2184 by the CA certificate thus obtained. <em>This option exposes the
2185 SSL connection to a man-in-the-middle attack obtaining the initial
2186 CA certificate.</em> It may still be useful for bootstrapping.
2189 <column name="external_ids">
2190 Key-value pairs for use by external frameworks that integrate with Open
2191 vSwitch, rather than by Open vSwitch itself. System integrators should
2192 either use the Open vSwitch development mailing list to coordinate on
2193 common key-value definitions, or choose key names that are likely to be
2194 unique. No common key-value pairs are currently defined.
2198 <table name="sFlow">
2199 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2202 <column name="agent">
2203 Name of the network device whose IP address should be reported as the
2204 ``agent address'' to collectors. If not specified, the IP address
2205 defaults to the <ref table="Controller" column="local_ip"/> in the
2206 collector's <ref table="Controller"/>. If an agent IP address cannot be
2207 determined either way, sFlow is disabled.
2210 <column name="header">
2211 Number of bytes of a sampled packet to send to the collector.
2212 If not specified, the default is 128 bytes.
2215 <column name="polling">
2216 Polling rate in seconds to send port statistics to the collector.
2217 If not specified, defaults to 30 seconds.
2220 <column name="sampling">
2221 Rate at which packets should be sampled and sent to the collector.
2222 If not specified, defaults to 400, which means one out of 400
2223 packets, on average, will be sent to the collector.
2226 <column name="targets">
2227 sFlow targets in the form
2228 <code><var>ip</var>:<var>port</var></code>.
2231 <column name="external_ids">
2232 Key-value pairs for use by external frameworks that integrate with Open
2233 vSwitch, rather than by Open vSwitch itself. System integrators should
2234 either use the Open vSwitch development mailing list to coordinate on
2235 common key-value definitions, or choose key names that are likely to be
2236 unique. No common key-value pairs are currently defined.
2240 <table name="Capability">
2241 <p>Records in this table describe functionality supported by the hardware
2242 and software platform on which this Open vSwitch is based. Clients
2243 should not modify this table.</p>
2245 <p>A record in this table is meaningful only if it is referenced by the
2246 <ref table="Open_vSwitch" column="capabilities"/> column in the
2247 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2248 the record's ``category,'' determines the meanings of the
2249 <ref column="details"/> column. The following general forms of
2250 categories are currently defined:</p>
2253 <dt><code>qos-<var>type</var></code></dt>
2254 <dd><var>type</var> is supported as the value for
2255 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2259 <column name="details">
2260 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2261 depends on the category key that the <ref table="Open_vSwitch"
2262 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2263 uses to reference this record, as described above.</p>
2265 <p>The presence of a record for category <code>qos-<var>type</var></code>
2266 indicates that the switch supports <var>type</var> as the value of
2267 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2268 table. The following key-value pairs are defined to further describe
2269 QoS capabilities:</p>
2272 <dt><code>n-queues</code></dt>
2273 <dd>Number of supported queues, as a positive integer. Keys in the
2274 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2275 records whose <ref table="QoS" column="type"/> value
2276 equals <var>type</var> must range between 0 and this value minus one,
projects / openvswitch / blob