1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
12 ``root set'' tables noted below.
15 <table name="Open_vSwitch" title="Open vSwitch configuration.">
16 Configuration for an Open vSwitch daemon. There must be exactly
17 one record in the <ref table="Open_vSwitch"/> table.
19 <group title="Configuration">
20 <column name="bridges">
21 Set of bridges managed by the daemon.
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-id</code></dt>
37 <dd>A unique identifier for the Open vSwitch's physical host.
38 The form of the identifier depends on the type of the host.
39 On a Citrix XenServer, this will likely be the same as
40 <code>xs-system-uuid</code>.</dd>
41 <dt><code>xs-system-uuid</code></dt>
42 <dd>The Citrix XenServer universally unique identifier for the
43 physical host as displayed by <code>xe host-list</code>.</dd>
48 <group title="Status">
49 <column name="next_cfg">
50 Sequence number for client to increment. When a client modifies
51 any part of the database configuration and wishes to wait for
52 Open vSwitch to finish applying the changes, it may increment
56 <column name="cur_cfg">
57 Sequence number that Open vSwitch sets to the current value of
58 <ref column="next_cfg"/> after it finishes applying a set of
59 configuration changes.
62 <column name="capabilities">
63 Describes functionality supported by the hardware and software platform
64 on which this Open vSwitch is based. Clients should not modify this
65 column. See the <ref table="Capability"/> description for defined
66 capability categories and the meaning of associated
67 <ref table="Capability"/> records.
70 <column name="statistics">
72 Key-value pairs that report statistics about a system running an Open
73 vSwitch. These are updated periodically (currently, every 5
74 seconds). Key-value pairs that cannot be determined or that do not
75 apply to a platform are omitted.
79 <dt><code>cpu</code></dt>
82 Number of CPU processors, threads, or cores currently online and
83 available to the operating system on which Open vSwitch is
84 running, as an integer. This may be less than the number
85 installed, if some are not online or if they are not available to
89 Open vSwitch userspace processes are not multithreaded, but the
90 Linux kernel-based datapath is.
94 <dt><code>load_average</code></dt>
97 A comma-separated list of three floating-point numbers,
98 representing the system load average over the last 1, 5, and 15
99 minutes, respectively.
103 <dt><code>memory</code></dt>
106 A comma-separated list of integers, each of which represents a
107 quantity of memory in kilobytes that describes the operating
108 system on which Open vSwitch is running. In respective order,
113 <li>Total amount of RAM allocated to the OS.</li>
114 <li>RAM allocated to the OS that is in use.</li>
115 <li>RAM that can be flushed out to disk or otherwise discarded
116 if that space is needed for another purpose. This number is
117 necessarily less than or equal to the previous value.</li>
118 <li>Total disk space allocated for swap.</li>
119 <li>Swap space currently in use.</li>
123 On Linux, all five values can be determined and are included. On
124 other operating systems, only the first two values can be
125 determined, so the list will only have two values.
129 <dt><code>process_</code><var>name</var></dt>
132 One such key-value pair will exist for each running Open vSwitch
133 daemon process, with <var>name</var> replaced by the daemon's
134 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
135 comma-separated list of integers. The integers represent the
136 following, with memory measured in kilobytes and durations in
141 <li>The process's virtual memory size.</li>
142 <li>The process's resident set size.</li>
143 <li>The amount of user and system CPU time consumed by the
145 <li>The number of times that the process has crashed and been
146 automatically restarted by the monitor.</li>
147 <li>The duration since the process was started.</li>
148 <li>The duration for which the process has been running.</li>
152 The interpretation of some of these values depends on whether the
153 process was started with the <option>--monitor</option>. If it
154 was not, then the crash count will always be 0 and the two
155 durations will always be the same. If <option>--monitor</option>
156 was given, then the crash count may be positive; if it is, the
157 latter duration is the amount of time since the most recent crash
162 There will be one key-value pair for each file in Open vSwitch's
163 ``run directory'' (usually <code>/var/run/openvswitch</code>)
164 whose name ends in <code>.pid</code>, whose contents are a
165 process ID, and which is locked by a running process. The
166 <var>name</var> is taken from the pidfile's name.
170 Currently Open vSwitch is only able to obtain all of the above
171 detail on Linux systems. On other systems, the same key-value
172 pairs will be present but the values will always be the empty
177 <dt><code>file_systems</code></dt>
180 A space-separated list of information on local, writable file
181 systems. Each item in the list describes one file system and
182 consists in turn of a comma-separated list of the following:
186 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
187 Any spaces or commas in the mount point are replaced by
189 <li>Total size, in kilobytes, as an integer.</li>
190 <li>Amount of storage in use, in kilobytes, as an integer.</li>
194 This key-value pair is omitted if there are no local, writable
195 file systems or if Open vSwitch cannot obtain the needed
203 <group title="Version Reporting">
205 These columns report the types and versions of the hardware and
206 software running Open vSwitch. We recommend in general that software
207 should test whether specific features are supported instead of relying
208 on version number checks. These values are primarily intended for
209 reporting to human administrators.
212 <column name="ovs_version">
213 The Open vSwitch version number, e.g. <code>1.1.0pre2</code>.
214 If Open vSwitch was configured with a build number, then it is
215 also included, e.g. <code>1.1.0pre2+build4948</code>.
218 <column name="db_version">
220 The database schema version number in the form
221 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
222 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
223 a non-backward compatible way (e.g. deleting a column or a table),
224 <var>major</var> is incremented. When the database schema is changed
225 in a backward compatible way (e.g. adding a new column),
226 <var>minor</var> is incremented. When the database schema is changed
227 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
232 The schema version is part of the database schema, so it can also be
233 retrieved by fetching the schema using the Open vSwitch database
238 <column name="system_type">
240 An identifier for the type of system on top of which Open vSwitch
241 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
244 System integrators are responsible for choosing and setting an
245 appropriate value for this column.
249 <column name="system_version">
251 The version of the system identified by <ref column="system_type"/>,
252 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
255 System integrators are responsible for choosing and setting an
256 appropriate value for this column.
262 <group title="Database Configuration">
264 These columns primarily configure the Open vSwitch database
265 (<code>ovsdb-server</code>), not the Open vSwitch switch
266 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
267 column="ssl"/> settings.
271 The Open vSwitch switch does read the database configuration to
272 determine remote IP addresses to which in-band control should apply.
275 <column name="manager_options">
276 Database clients to which the Open vSwitch database server should
277 connect or to which it should listen, along with options for how these
278 connection should be configured. See the <ref table="Manager"/> table
279 for more information.
284 <table name="Bridge">
286 Configuration for a bridge within an
287 <ref table="Open_vSwitch"/>.
290 A <ref table="Bridge"/> record represents an Ethernet switch with one or
291 more ``ports,'' which are the <ref table="Port"/> records pointed to by
292 the <ref table="Bridge"/>'s <ref column="ports"/> column.
295 <group title="Core Features">
297 Bridge identifier. Should be alphanumeric and no more than about 8
298 bytes long. Must be unique among the names of ports, interfaces, and
302 <column name="ports">
303 Ports included in the bridge.
306 <column name="mirrors">
307 Port mirroring configuration.
310 <column name="netflow">
311 NetFlow configuration.
314 <column name="sflow">
318 <column name="flood_vlans">
319 VLAN IDs of VLANs on which MAC address learning should be disabled, so
320 that packets are flooded instead of being sent to specific ports that
321 are believed to contain packets' destination MACs. This should
322 ordinarily be used to disable MAC learning on VLANs used for mirroring
323 (RSPAN VLANs). It may also be useful for debugging.
327 <group title="OpenFlow Configuration">
328 <column name="controller">
329 OpenFlow controller set. If unset, then no OpenFlow controllers
333 <column name="fail_mode">
334 <p>When a controller is configured, it is, ordinarily, responsible
335 for setting up all flows on the switch. Thus, if the connection to
336 the controller fails, no new network connections can be set up.
337 If the connection to the controller stays down long enough,
338 no packets can pass through the switch at all. This setting
339 determines the switch's response to such a situation. It may be set
340 to one of the following:
342 <dt><code>standalone</code></dt>
343 <dd>If no message is received from the controller for three
344 times the inactivity probe interval
345 (see <ref column="inactivity_probe"/>), then Open vSwitch
346 will take over responsibility for setting up flows. In
347 this mode, Open vSwitch causes the bridge to act like an
348 ordinary MAC-learning switch. Open vSwitch will continue
349 to retry connecting to the controller in the background
350 and, when the connection succeeds, it will discontinue its
351 standalone behavior.</dd>
352 <dt><code>secure</code></dt>
353 <dd>Open vSwitch will not set up flows on its own when the
354 controller connection fails or when no controllers are
355 defined. The bridge will continue to retry connecting to
356 any defined controllers forever.</dd>
359 <p>If this value is unset, the default is implementation-specific.</p>
360 <p>When more than one controller is configured,
361 <ref column="fail_mode"/> is considered only when none of the
362 configured controllers can be contacted.</p>
365 <column name="datapath_id">
366 Reports the OpenFlow datapath ID in use. Exactly 16 hex
367 digits. (Setting this column will have no useful effect. Set
368 <ref column="other_config"/>:<code>other-config</code>
373 <group title="Other Features">
374 <column name="datapath_type">
375 Name of datapath provider. The kernel datapath has
376 type <code>system</code>. The userspace datapath has
377 type <code>netdev</code>.
380 <column name="external_ids">
381 Key-value pairs for use by external frameworks that integrate
382 with Open vSwitch, rather than by Open vSwitch itself. System
383 integrators should either use the Open vSwitch development
384 mailing list to coordinate on common key-value definitions, or
385 choose key names that are likely to be unique. The currently
386 defined key-value pairs are:
388 <dt><code>bridge-id</code></dt>
389 <dd>A unique identifier of the bridge. On Citrix XenServer this
390 will commonly be the same as <code>xs-network-uuids</code>.</dd>
391 <dt><code>xs-network-uuids</code></dt>
392 <dd>Semicolon-delimited set of universally unique identifier(s) for
393 the network with which this bridge is associated on a Citrix
394 XenServer host. The network identifiers are RFC 4122 UUIDs as
395 displayed by, e.g., <code>xe network-list</code>.</dd>
399 <column name="other_config">
400 Key-value pairs for configuring rarely used bridge
401 features. The currently defined key-value pairs are:
403 <dt><code>datapath-id</code></dt>
405 digits to set the OpenFlow datapath ID to a specific
406 value. May not be all-zero.</dd>
407 <dt><code>disable-in-band</code></dt>
408 <dd>If set to <code>true</code>, disable in-band control on
409 the bridge regardless of controller and manager settings.</dd>
410 <dt><code>hwaddr</code></dt>
411 <dd>An Ethernet address in the form
412 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
413 to set the hardware address of the local port and influence the
415 <dt><code>in-band-queue</code></dt>
417 A queue ID as a nonnegative integer. This sets the OpenFlow queue
418 ID that will be used by flows set up by in-band control on this
419 bridge. If unset, or if the port used by an in-band control flow
420 does not have QoS configured, or if the port does not have a queue
421 with the specified ID, the default queue is used instead.
428 <table name="Port" table="Port or bond configuration.">
429 <p>A port within a <ref table="Bridge"/>.</p>
430 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
431 <ref column="interfaces"/> column. Such a port logically
432 corresponds to a port on a physical Ethernet switch. A port
433 with more than one interface is a ``bonded port'' (see
434 <ref group="Bonding Configuration"/>).</p>
435 <p>Some properties that one might think as belonging to a port are actually
436 part of the port's <ref table="Interface"/> members.</p>
439 Port name. Should be alphanumeric and no more than about 8
440 bytes long. May be the same as the interface name, for
441 non-bonded ports. Must otherwise be unique among the names of
442 ports, interfaces, and bridges on a host.
445 <column name="interfaces">
446 The port's interfaces. If there is more than one, this is a
450 <group title="VLAN Configuration">
451 <p>A bridge port must be configured for VLANs in one of two
452 mutually exclusive ways:
454 <li>A ``trunk port'' has an empty value for <ref
455 column="tag"/>. Its <ref column="trunks"/> value may be
456 empty or non-empty.</li>
457 <li>An ``implicitly tagged VLAN port'' or ``access port''
458 has an nonempty value for <ref column="tag"/>. Its
459 <ref column="trunks"/> value must be empty.</li>
461 If <ref column="trunks"/> and <ref column="tag"/> are both
462 nonempty, the configuration is ill-formed.
467 If this is an access port (see above), the port's implicitly
468 tagged VLAN. Must be empty if this is a trunk port.
471 Frames arriving on trunk ports will be forwarded to this
472 port only if they are tagged with the given VLAN (or, if
473 <ref column="tag"/> is 0, then if they lack a VLAN header).
474 Frames arriving on other access ports will be forwarded to
475 this port only if they have the same <ref column="tag"/>
476 value. Frames forwarded to this port will not have an
480 When a frame with a 802.1Q header that indicates a nonzero
481 VLAN is received on an access port, it is discarded.
485 <column name="trunks">
487 If this is a trunk port (see above), the 802.1Q VLAN(s) that
488 this port trunks; if it is empty, then the port trunks all
489 VLANs. Must be empty if this is an access port.
492 Frames arriving on trunk ports are dropped if they are not
493 in one of the specified VLANs. For this purpose, packets
494 that have no VLAN header are treated as part of VLAN 0.
499 <group title="Bonding Configuration">
500 <p>A port that has more than one interface is a ``bonded port.'' Bonding
501 allows for load balancing and fail-over. Some kinds of bonding will
502 work with any kind of upstream switch:</p>
505 <dt><code>balance-slb</code></dt>
507 Balances flows among slaves based on source MAC address and output
508 VLAN, with periodic rebalancing as traffic patterns change.
511 <dt><code>active-backup</code></dt>
513 Assigns all flows to one slave, failing over to a backup slave when
514 the active slave is disabled.
519 The following mode requires the upstream switch to support 802.3ad with
520 successful LACP negotiation. If LACP negotiation fails then
521 <code>balance-slb</code> mode is used as a fallback:
525 <dt><code>balance-tcp</code></dt>
527 Balances flows among slaves based on L2, L3, and L4 protocol
528 information such as destination MAC address, IP address, and TCP
533 <p>These columns apply only to bonded ports. Their values are
534 otherwise ignored.</p>
536 <column name="bond_mode">
537 <p>The type of bonding used for a bonded port. Defaults to
538 <code>balance-slb</code> if unset.
542 <column name="bond_updelay">
543 <p>For a bonded port, the number of milliseconds for which carrier must
544 stay up on an interface before the interface is considered to be up.
545 Specify <code>0</code> to enable the interface immediately.</p>
546 <p>This setting is honored only when at least one bonded interface is
547 already enabled. When no interfaces are enabled, then the first bond
548 interface to come up is enabled immediately.</p>
551 <column name="bond_downdelay">
552 For a bonded port, the number of milliseconds for which carrier must
553 stay down on an interface before the interface is considered to be
554 down. Specify <code>0</code> to disable the interface immediately.
557 <column name="bond_fake_iface">
558 For a bonded port, whether to create a fake internal interface with the
559 name of the port. Use only for compatibility with legacy software that
564 <p>Configures LACP on this port. LACP allows directly connected
565 switches to negotiate which links may be bonded. LACP may be enabled
566 on non-bonded ports for the benefit of any switches they may be
567 connected to. <code>active</code> ports are allowed to initiate LACP
568 negotiations. <code>passive</code> ports are allowed to participate
569 in LACP negotiations initiated by a remote switch, but not allowed to
570 initiate such negotiations themselves. If unset Open vSwitch will
571 choose a reasonable default. </p>
576 <group title="Other Features">
578 Quality of Service configuration for this port.
582 The MAC address to use for this port for the purpose of choosing the
583 bridge's MAC address. This column does not necessarily reflect the
584 port's actual MAC address, nor will setting it change the port's actual
588 <column name="fake_bridge">
589 Does this port represent a sub-bridge for its tagged VLAN within the
590 Bridge? See ovs-vsctl(8) for more information.
593 <column name="external_ids">
595 Key-value pairs for use by external frameworks that integrate with
596 Open vSwitch, rather than by Open vSwitch itself. System integrators
597 should either use the Open vSwitch development mailing list to
598 coordinate on common key-value definitions, or choose key names that
599 are likely to be unique.
602 No key-value pairs native to <ref table="Port"/> are currently
603 defined. For fake bridges (see the <ref column="fake_bridge"/>
604 column), external IDs for the fake bridge are defined here by
605 prefixing a <ref table="Bridge"/> <ref table="Bridge"
606 column="external_ids"/> key with <code>fake-bridge-</code>,
607 e.g. <code>fake-bridge-xs-network-uuids</code>.
611 <column name="other_config">
612 Key-value pairs for configuring rarely used port features. The
613 currently defined key-value pairs are:
615 <dt><code>hwaddr</code></dt>
616 <dd>An Ethernet address in the form
617 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
618 <dt><code>bond-rebalance-interval</code></dt>
619 <dd>For an SLB bonded port, the number of milliseconds between
620 successive attempts to rebalance the bond, that is, to
621 move source MACs and their flows from one interface on
622 the bond to another in an attempt to keep usage of each
623 interface roughly equal. The default is 10000 (10
624 seconds), and the minimum is 1000 (1 second).</dd>
625 <dt><code>bond-detect-mode</code></dt>
626 <dd> Sets the method used to detect link failures in a bonded port.
627 Options are <code>carrier</code> and <code>miimon</code>. Defaults
628 to <code>carrier</code> which uses each interface's carrier to detect
629 failures. When set to <code>miimon</code>, will check for failures
630 by polling each interface's MII. </dd>
631 <dt><code>bond-miimon-interval</code></dt>
632 <dd> The number of milliseconds between successive attempts to
633 poll each interface's MII. Only relevant on ports which use
634 <code>miimon</code> to detect failures. </dd>
635 <dt><code>lacp-system-priority</code></dt>
636 <dd> The LACP system priority of this <ref table="Port"/>. In
637 LACP negotiations, link status decisions are made by the system
638 with the numerically lower priority. Must be a number between 1
645 <table name="Interface" title="One physical network device in a Port.">
646 An interface within a <ref table="Port"/>.
648 <group title="Core Features">
650 Interface name. Should be alphanumeric and no more than about 8 bytes
651 long. May be the same as the port name, for non-bonded ports. Must
652 otherwise be unique among the names of ports, interfaces, and bridges
657 <p>Ethernet address to set for this interface. If unset then the
658 default MAC address is used:</p>
660 <li>For the local interface, the default is the lowest-numbered MAC
661 address among the other bridge ports, either the value of the
662 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
663 if set, or its actual MAC (for bonded ports, the MAC of its slave
664 whose name is first in alphabetical order). Internal ports and
665 bridge ports that are used as port mirroring destinations (see the
666 <ref table="Mirror"/> table) are ignored.</li>
667 <li>For other internal interfaces, the default MAC is randomly
669 <li>External interfaces typically have a MAC address associated with
672 <p>Some interfaces may not have a software-controllable MAC
676 <column name="ofport">
677 <p>OpenFlow port number for this interface. Unlike most columns, this
678 column's value should be set only by Open vSwitch itself. Other
679 clients should set this column to an empty set (the default) when
680 creating an <ref table="Interface"/>.</p>
681 <p>Open vSwitch populates this column when the port number becomes
682 known. If the interface is successfully added,
683 <ref column="ofport"/> will be set to a number between 1 and 65535
684 (generally either in the range 1 to 65279, inclusive, or 65534, the
685 port number for the OpenFlow ``local port''). If the interface
686 cannot be added then Open vSwitch sets this column
691 <group title="System-Specific Details">
693 The interface type, one of:
695 <dt><code>system</code></dt>
696 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
697 Sometimes referred to as ``external interfaces'' since they are
698 generally connected to hardware external to that on which the Open
699 vSwitch is running. The empty string is a synonym for
700 <code>system</code>.</dd>
701 <dt><code>internal</code></dt>
702 <dd>A simulated network device that sends and receives traffic. An
703 internal interface whose <ref column="name"/> is the same as its
704 bridge's <ref table="Open_vSwitch" column="name"/> is called the
705 ``local interface.'' It does not make sense to bond an internal
706 interface, so the terms ``port'' and ``interface'' are often used
707 imprecisely for internal interfaces.</dd>
708 <dt><code>tap</code></dt>
709 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
710 <dt><code>gre</code></dt>
711 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
712 tunnel. Each tunnel must be uniquely identified by the
713 combination of <code>remote_ip</code>, <code>local_ip</code>, and
714 <code>in_key</code>. Note that if two ports are defined that are
715 the same except one has an optional identifier and the other does
716 not, the more specific one is matched first. <code>in_key</code>
717 is considered more specific than <code>local_ip</code> if a port
718 defines one and another port defines the other. The following
719 options may be specified in the <ref column="options"/> column:
721 <dt><code>remote_ip</code></dt>
722 <dd>Required. The tunnel endpoint.</dd>
725 <dt><code>local_ip</code></dt>
726 <dd>Optional. The destination IP that received packets must
727 match. Default is to match all addresses.</dd>
730 <dt><code>in_key</code></dt>
731 <dd>Optional. The GRE key that received packets must contain.
732 It may either be a 32-bit number (no key and a key of 0 are
733 treated as equivalent) or the word <code>flow</code>. If
734 <code>flow</code> is specified then any key will be accepted
735 and the key will be placed in the <code>tun_id</code> field
736 for matching in the flow table. The ovs-ofctl manual page
737 contains additional information about matching fields in
738 OpenFlow flows. Default is no key.</dd>
741 <dt><code>out_key</code></dt>
742 <dd>Optional. The GRE key to be set on outgoing packets. It may
743 either be a 32-bit number or the word <code>flow</code>. If
744 <code>flow</code> is specified then the key may be set using
745 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
746 is used in the absence of an action). The ovs-ofctl manual
747 page contains additional information about the Nicira OpenFlow
748 vendor extensions. Default is no key.</dd>
751 <dt><code>key</code></dt>
752 <dd>Optional. Shorthand to set <code>in_key</code> and
753 <code>out_key</code> at the same time.</dd>
756 <dt><code>tos</code></dt>
757 <dd>Optional. The value of the ToS bits to be set on the
758 encapsulating packet. It may also be the word
759 <code>inherit</code>, in which case the ToS will be copied from
760 the inner packet if it is IPv4 or IPv6 (otherwise it will be
761 0). Note that the ECN fields are always inherited. Default is
765 <dt><code>ttl</code></dt>
766 <dd>Optional. The TTL to be set on the encapsulating packet.
767 It may also be the word <code>inherit</code>, in which case the
768 TTL will be copied from the inner packet if it is IPv4 or IPv6
769 (otherwise it will be the system default, typically 64).
770 Default is the system default TTL.</dd>
773 <dt><code>csum</code></dt>
774 <dd>Optional. Compute GRE checksums on outgoing packets.
775 Checksums present on incoming packets will be validated
776 regardless of this setting. Note that GRE checksums
777 impose a significant performance penalty as they cover the
778 entire packet. As the contents of the packet is typically
779 covered by L3 and L4 checksums, this additional checksum only
780 adds value for the GRE and encapsulated Ethernet headers.
781 Default is disabled, set to <code>true</code> to enable.</dd>
784 <dt><code>pmtud</code></dt>
785 <dd>Optional. Enable tunnel path MTU discovery. If enabled
786 ``ICMP destination unreachable - fragmentation'' needed
787 messages will be generated for IPv4 packets with the DF bit set
788 and IPv6 packets above the minimum MTU if the packet size
789 exceeds the path MTU minus the size of the tunnel headers. It
790 also forces the encapsulating packet DF bit to be set (it is
791 always set if the inner packet implies path MTU discovery).
792 Note that this option causes behavior that is typically
793 reserved for routers and therefore is not entirely in
794 compliance with the IEEE 802.1D specification for bridges.
795 Default is enabled, set to <code>false</code> to disable.</dd>
798 <dt><code>header_cache</code></dt>
799 <dd>Optional. Enable caching of tunnel headers and the output
800 path. This can lead to a significant performance increase
801 without changing behavior. In general it should not be
802 necessary to adjust this setting. However, the caching can
803 bypass certain components of the IP stack (such as IP tables)
804 and it may be useful to disable it if these features are
805 required or as a debugging measure. Default is enabled, set to
806 <code>false</code> to disable.</dd>
809 <dt><code>ipsec_gre</code></dt>
810 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
811 over IPv4 IPsec tunnel. Each tunnel (including those of type
812 <code>gre</code>) must be uniquely identified by the
813 combination of <code>remote_ip</code> and
814 <code>local_ip</code>. Note that if two ports are defined
815 that are the same except one has an optional identifier and
816 the other does not, the more specific one is matched first.
817 An authentication method of <code>peer_cert</code> or
818 <code>psk</code> must be defined. The following options may
819 be specified in the <ref column="options"/> column:
821 <dt><code>remote_ip</code></dt>
822 <dd>Required. The tunnel endpoint.</dd>
825 <dt><code>local_ip</code></dt>
826 <dd>Optional. The destination IP that received packets must
827 match. Default is to match all addresses.</dd>
830 <dt><code>peer_cert</code></dt>
831 <dd>Required for certificate authentication. A string
832 containing the peer's certificate in PEM format.
833 Additionally the host's certificate must be specified
834 with the <code>certificate</code> option.</dd>
837 <dt><code>certificate</code></dt>
838 <dd>Required for certificate authentication. The name of a
839 PEM file containing a certificate that will be presented
840 to the peer during authentication.</dd>
843 <dt><code>private_key</code></dt>
844 <dd>Optional for certificate authentication. The name of
845 a PEM file containing the private key associated with
846 <code>certificate</code>. If <code>certificate</code>
847 contains the private key, this option may be omitted.</dd>
850 <dt><code>psk</code></dt>
851 <dd>Required for pre-shared key authentication. Specifies a
852 pre-shared key for authentication that must be identical on
853 both sides of the tunnel.</dd>
856 <dt><code>in_key</code></dt>
857 <dd>Optional. The GRE key that received packets must contain.
858 It may either be a 32-bit number (no key and a key of 0 are
859 treated as equivalent) or the word <code>flow</code>. If
860 <code>flow</code> is specified then any key will be accepted
861 and the key will be placed in the <code>tun_id</code> field
862 for matching in the flow table. The ovs-ofctl manual page
863 contains additional information about matching fields in
864 OpenFlow flows. Default is no key.</dd>
867 <dt><code>out_key</code></dt>
868 <dd>Optional. The GRE key to be set on outgoing packets. It may
869 either be a 32-bit number or the word <code>flow</code>. If
870 <code>flow</code> is specified then the key may be set using
871 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
872 is used in the absence of an action). The ovs-ofctl manual
873 page contains additional information about the Nicira OpenFlow
874 vendor extensions. Default is no key.</dd>
877 <dt><code>key</code></dt>
878 <dd>Optional. Shorthand to set <code>in_key</code> and
879 <code>out_key</code> at the same time.</dd>
882 <dt><code>tos</code></dt>
883 <dd>Optional. The value of the ToS bits to be set on the
884 encapsulating packet. It may also be the word
885 <code>inherit</code>, in which case the ToS will be copied from
886 the inner packet if it is IPv4 or IPv6 (otherwise it will be
887 0). Note that the ECN fields are always inherited. Default is
891 <dt><code>ttl</code></dt>
892 <dd>Optional. The TTL to be set on the encapsulating packet.
893 It may also be the word <code>inherit</code>, in which case the
894 TTL will be copied from the inner packet if it is IPv4 or IPv6
895 (otherwise it will be the system default, typically 64).
896 Default is the system default TTL.</dd>
899 <dt><code>csum</code></dt>
900 <dd>Optional. Compute GRE checksums on outgoing packets.
901 Checksums present on incoming packets will be validated
902 regardless of this setting. Note that GRE checksums
903 impose a significant performance penalty as they cover the
904 entire packet. As the contents of the packet is typically
905 covered by L3 and L4 checksums, this additional checksum only
906 adds value for the GRE and encapsulated Ethernet headers.
907 Default is disabled, set to <code>true</code> to enable.</dd>
910 <dt><code>pmtud</code></dt>
911 <dd>Optional. Enable tunnel path MTU discovery. If enabled
912 ``ICMP destination unreachable - fragmentation'' needed
913 messages will be generated for IPv4 packets with the DF bit set
914 and IPv6 packets above the minimum MTU if the packet size
915 exceeds the path MTU minus the size of the tunnel headers. It
916 also forces the encapsulating packet DF bit to be set (it is
917 always set if the inner packet implies path MTU discovery).
918 Note that this option causes behavior that is typically
919 reserved for routers and therefore is not entirely in
920 compliance with the IEEE 802.1D specification for bridges.
921 Default is enabled, set to <code>false</code> to disable.</dd>
924 <dt><code>capwap</code></dt>
925 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
926 (RFC 5415). This allows interoperability with certain switches
927 where GRE is not available. Note that only the tunneling component
928 of the protocol is implemented. Due to the non-standard use of
929 CAPWAP, UDP ports 58881 and 58882 are used as the source and
930 destination ports respectively. Each tunnel must be uniquely
931 identified by the combination of <code>remote_ip</code> and
932 <code>local_ip</code>. If two ports are defined that are the same
933 except one includes <code>local_ip</code> and the other does not,
934 the more specific one is matched first. CAPWAP support is not
935 available on all platforms. Currently it is only supported in the
936 Linux kernel module with kernel versions >= 2.6.25. The following
937 options may be specified in the <ref column="options"/> column:
939 <dt><code>remote_ip</code></dt>
940 <dd>Required. The tunnel endpoint.</dd>
943 <dt><code>local_ip</code></dt>
944 <dd>Optional. The destination IP that received packets must
945 match. Default is to match all addresses.</dd>
948 <dt><code>tos</code></dt>
949 <dd>Optional. The value of the ToS bits to be set on the
950 encapsulating packet. It may also be the word
951 <code>inherit</code>, in which case the ToS will be copied from
952 the inner packet if it is IPv4 or IPv6 (otherwise it will be
953 0). Note that the ECN fields are always inherited. Default is
957 <dt><code>ttl</code></dt>
958 <dd>Optional. The TTL to be set on the encapsulating packet.
959 It may also be the word <code>inherit</code>, in which case the
960 TTL will be copied from the inner packet if it is IPv4 or IPv6
961 (otherwise it will be the system default, typically 64).
962 Default is the system default TTL.</dd>
965 <dt><code>pmtud</code></dt>
966 <dd>Optional. Enable tunnel path MTU discovery. If enabled
967 ``ICMP destination unreachable - fragmentation'' needed
968 messages will be generated for IPv4 packets with the DF bit set
969 and IPv6 packets above the minimum MTU if the packet size
970 exceeds the path MTU minus the size of the tunnel headers. It
971 also forces the encapsulating packet DF bit to be set (it is
972 always set if the inner packet implies path MTU discovery).
973 Note that this option causes behavior that is typically
974 reserved for routers and therefore is not entirely in
975 compliance with the IEEE 802.1D specification for bridges.
976 Default is enabled, set to <code>false</code> to disable.</dd>
979 <dt><code>header_cache</code></dt>
980 <dd>Optional. Enable caching of tunnel headers and the output
981 path. This can lead to a significant performance increase
982 without changing behavior. In general it should not be
983 necessary to adjust this setting. However, the caching can
984 bypass certain components of the IP stack (such as IP tables)
985 and it may be useful to disable it if these features are
986 required or as a debugging measure. Default is enabled, set to
987 <code>false</code> to disable.</dd>
990 <dt><code>patch</code></dt>
993 A pair of virtual devices that act as a patch cable. The <ref
994 column="options"/> column must have the following key-value pair:
997 <dt><code>peer</code></dt>
999 The <ref column="name"/> of the <ref table="Interface"/> for
1000 the other side of the patch. The named <ref
1001 table="Interface"/>'s own <code>peer</code> option must specify
1002 this <ref table="Interface"/>'s name. That is, the two patch
1003 interfaces must have reversed <ref column="name"/> and
1004 <code>peer</code> values.
1011 <column name="options">
1012 Configuration options whose interpretation varies based on
1013 <ref column="type"/>.
1017 <group title="Interface Status">
1019 Status information about interfaces attached to bridges, updated every
1020 5 seconds. Not all interfaces have all of these properties; virtual
1021 interfaces don't have a link speed, for example. Non-applicable
1022 columns will have empty values.
1024 <column name="admin_state">
1026 The administrative state of the physical network link.
1030 <column name="link_state">
1032 The observed state of the physical network link;
1033 i.e. whether a carrier is detected by the interface.
1037 <column name="link_speed">
1039 The negotiated speed of the physical network link.
1040 Valid values are positive integers greater than 0.
1044 <column name="duplex">
1046 The duplex mode of the physical network link.
1052 The MTU (maximum transmission unit); i.e. the largest
1053 amount of data that can fit into a single Ethernet frame.
1054 The standard Ethernet MTU is 1500 bytes. Some physical media
1055 and many kinds of virtual interfaces can be configured with
1059 This column will be empty for an interface that does not
1060 have an MTU as, for example, some kinds of tunnels do not.
1064 <column name="status">
1066 Key-value pairs that report port status. Supported status
1067 values are <code>type</code>-dependent; some interfaces may not have
1068 a valid <code>driver_name</code>, for example.
1070 <p>The currently defined key-value pairs are:</p>
1072 <dt><code>driver_name</code></dt>
1073 <dd>The name of the device driver controlling the network
1077 <dt><code>driver_version</code></dt>
1078 <dd>The version string of the device driver controlling the
1079 network adapter.</dd>
1082 <dt><code>firmware_version</code></dt>
1083 <dd>The version string of the network adapter's firmware, if
1087 <dt><code>source_ip</code></dt>
1088 <dd>The source IP address used for an IPv4 tunnel end-point,
1089 such as <code>gre</code> or <code>capwap</code>.</dd>
1092 <dt><code>tunnel_egress_iface</code></dt>
1093 <dd>Egress interface for tunnels. Currently only relevant for GRE
1094 and CAPWAP tunnels. On Linux systems, this column will show
1095 the name of the interface which is responsible for routing
1096 traffic destined for the configured <code>remote_ip</code>.
1097 This could be an internal interface such as a bridge port.</dd>
1100 <dt><code>tunnel_egress_iface_carrier</code></dt>
1101 <dd>Whether a carrier is detected on <ref
1102 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1103 and <code>up</code>.</dd>
1108 <group title="Ingress Policing">
1110 These settings control ingress policing for packets received on this
1111 interface. On a physical interface, this limits the rate at which
1112 traffic is allowed into the system from the outside; on a virtual
1113 interface (one connected to a virtual machine), this limits the rate at
1114 which the VM is able to transmit.
1117 Policing is a simple form of quality-of-service that simply drops
1118 packets received in excess of the configured rate. Due to its
1119 simplicity, policing is usually less accurate and less effective than
1120 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1121 table="Queue"/> tables).
1124 Policing is currently implemented only on Linux. The Linux
1125 implementation uses a simple ``token bucket'' approach:
1129 The size of the bucket corresponds to <ref
1130 column="ingress_policing_burst"/>. Initially the bucket is full.
1133 Whenever a packet is received, its size (converted to tokens) is
1134 compared to the number of tokens currently in the bucket. If the
1135 required number of tokens are available, they are removed and the
1136 packet is forwarded. Otherwise, the packet is dropped.
1139 Whenever it is not full, the bucket is refilled with tokens at the
1140 rate specified by <ref column="ingress_policing_rate"/>.
1144 Policing interacts badly with some network protocols, and especially
1145 with fragmented IP packets. Suppose that there is enough network
1146 activity to keep the bucket nearly empty all the time. Then this token
1147 bucket algorithm will forward a single packet every so often, with the
1148 period depending on packet size and on the configured rate. All of the
1149 fragments of an IP packets are normally transmitted back-to-back, as a
1150 group. In such a situation, therefore, only one of these fragments
1151 will be forwarded and the rest will be dropped. IP does not provide
1152 any way for the intended recipient to ask for only the remaining
1153 fragments. In such a case there are two likely possibilities for what
1154 will happen next: either all of the fragments will eventually be
1155 retransmitted (as TCP will do), in which case the same problem will
1156 recur, or the sender will not realize that its packet has been dropped
1157 and data will simply be lost (as some UDP-based protocols will do).
1158 Either way, it is possible that no forward progress will ever occur.
1160 <column name="ingress_policing_rate">
1162 Maximum rate for data received on this interface, in kbps. Data
1163 received faster than this rate is dropped. Set to <code>0</code>
1164 (the default) to disable policing.
1168 <column name="ingress_policing_burst">
1169 <p>Maximum burst size for data received on this interface, in kb. The
1170 default burst size if set to <code>0</code> is 1000 kb. This value
1171 has no effect if <ref column="ingress_policing_rate"/>
1172 is <code>0</code>.</p>
1174 Specifying a larger burst size lets the algorithm be more forgiving,
1175 which is important for protocols like TCP that react severely to
1176 dropped packets. The burst size should be at least the size of the
1177 interface's MTU. Specifying a value that is numerically at least as
1178 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1179 closer to achieving the full rate.
1184 <group title="Other Features">
1186 <column name="monitor">
1187 Connectivity monitor configuration for this interface.
1190 <column name="external_ids">
1191 Key-value pairs for use by external frameworks that integrate
1192 with Open vSwitch, rather than by Open vSwitch itself. System
1193 integrators should either use the Open vSwitch development
1194 mailing list to coordinate on common key-value definitions, or
1195 choose key names that are likely to be unique. The currently
1196 defined common key-value pairs are:
1198 <dt><code>attached-mac</code></dt>
1200 The MAC address programmed into the ``virtual hardware'' for this
1201 interface, in the form
1202 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1203 For Citrix XenServer, this is the value of the <code>MAC</code>
1204 field in the VIF record for this interface.</dd>
1205 <dt><code>iface-id</code></dt>
1206 <dd>A system-unique identifier for the interface. On XenServer,
1207 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1210 Additionally the following key-value pairs specifically
1211 apply to an interface that represents a virtual Ethernet interface
1212 connected to a virtual machine. These key-value pairs should not be
1213 present for other types of interfaces. Keys whose names end
1214 in <code>-uuid</code> have values that uniquely identify the entity
1215 in question. For a Citrix XenServer hypervisor, these values are
1216 UUIDs in RFC 4122 format. Other hypervisors may use other
1219 <p>The currently defined key-value pairs for XenServer are:</p>
1221 <dt><code>xs-vif-uuid</code></dt>
1222 <dd>The virtual interface associated with this interface.</dd>
1223 <dt><code>xs-network-uuid</code></dt>
1224 <dd>The virtual network to which this interface is attached.</dd>
1225 <dt><code>xs-vm-uuid</code></dt>
1226 <dd>The VM to which this interface belongs.</dd>
1230 <column name="other_config">
1231 Key-value pairs for rarely used interface features.
1233 <dt><code>lacp-port-priority</code></dt>
1234 <dd> The LACP port priority of this <ref table="Interface"/>. In
1235 LACP negotiations <ref table="Interface"/>s with numerically lower
1236 priorities are preferred for aggregation. Must be a number between
1241 <column name="statistics">
1243 Key-value pairs that report interface statistics. The current
1244 implementation updates these counters periodically. In the future,
1245 we plan to, instead, update them when an interface is created, when
1246 they are queried (e.g. using an OVSDB <code>select</code> operation),
1247 and just before an interface is deleted due to virtual interface
1248 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1249 regular periodic basis.</p>
1251 The currently defined key-value pairs are listed below. These are
1252 the same statistics reported by OpenFlow in its <code>struct
1253 ofp_port_stats</code> structure. If an interface does not support a
1254 given statistic, then that pair is omitted.</p>
1257 Successful transmit and receive counters:
1259 <dt><code>rx_packets</code></dt>
1260 <dd>Number of received packets.</dd>
1261 <dt><code>rx_bytes</code></dt>
1262 <dd>Number of received bytes.</dd>
1263 <dt><code>tx_packets</code></dt>
1264 <dd>Number of transmitted packets.</dd>
1265 <dt><code>tx_bytes</code></dt>
1266 <dd>Number of transmitted bytes.</dd>
1272 <dt><code>rx_dropped</code></dt>
1273 <dd>Number of packets dropped by RX.</dd>
1274 <dt><code>rx_frame_err</code></dt>
1275 <dd>Number of frame alignment errors.</dd>
1276 <dt><code>rx_over_err</code></dt>
1277 <dd>Number of packets with RX overrun.</dd>
1278 <dt><code>rx_crc_err</code></dt>
1279 <dd>Number of CRC errors.</dd>
1280 <dt><code>rx_errors</code></dt>
1282 Total number of receive errors, greater than or equal
1283 to the sum of the above.
1290 <dt><code>tx_dropped</code></dt>
1291 <dd>Number of packets dropped by TX.</dd>
1292 <dt><code>collisions</code></dt>
1293 <dd>Number of collisions.</dd>
1294 <dt><code>tx_errors</code></dt>
1296 Total number of transmit errors, greater
1297 than or equal to the sum of the above.
1306 <table name="QoS" title="Quality of Service configuration">
1307 <p>Quality of Service (QoS) configuration for each Port that
1310 <column name="type">
1311 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1312 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1313 identifies the types that a switch actually supports. The currently
1314 defined types are listed below:</p>
1316 <dt><code>linux-htb</code></dt>
1318 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1319 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1320 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1321 for information on how this classifier works and how to configure it.
1325 <dt><code>linux-hfsc</code></dt>
1327 Linux "Hierarchical Fair Service Curve" classifier.
1328 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1329 information on how this classifier works.
1334 <column name="queues">
1335 <p>A map from queue numbers to <ref table="Queue"/> records. The
1336 supported range of queue numbers depend on <ref column="type"/>. The
1337 queue numbers are the same as the <code>queue_id</code> used in
1338 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1339 structures. Queue 0 is used by OpenFlow output actions that do not
1340 specify a specific queue.</p>
1343 <column name="other_config">
1344 <p>Key-value pairs for configuring QoS features that depend on
1345 <ref column="type"/>.</p>
1346 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1347 the following key-value pairs:</p>
1349 <dt><code>max-rate</code></dt>
1350 <dd>Maximum rate shared by all queued traffic, in bit/s.
1351 Optional. If not specified, for physical interfaces, the
1352 default is the link rate. For other interfaces or if the
1353 link rate cannot be determined, the default is currently 100
1358 <column name="external_ids">
1359 Key-value pairs for use by external frameworks that integrate with Open
1360 vSwitch, rather than by Open vSwitch itself. System integrators should
1361 either use the Open vSwitch development mailing list to coordinate on
1362 common key-value definitions, or choose key names that are likely to be
1363 unique. No common key-value pairs are currently defined.
1367 <table name="Queue" title="QoS output queue.">
1368 <p>A configuration for a port output queue, used in configuring Quality of
1369 Service (QoS) features. May be referenced by <ref column="queues"
1370 table="QoS"/> column in <ref table="QoS"/> table.</p>
1372 <column name="other_config">
1373 <p>Key-value pairs for configuring the output queue. The supported
1374 key-value pairs and their meanings depend on the <ref column="type"/>
1375 of the <ref column="QoS"/> records that reference this row.</p>
1376 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1377 column="type"/> of <code>min-rate</code> are:</p>
1379 <dt><code>min-rate</code></dt>
1380 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1381 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1383 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1384 column="type"/> of <code>linux-htb</code> are:</p>
1386 <dt><code>min-rate</code></dt>
1387 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1388 <dt><code>max-rate</code></dt>
1389 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1390 queue's rate will not be allowed to exceed the specified value, even
1391 if excess bandwidth is available. If unspecified, defaults to no
1393 <dt><code>burst</code></dt>
1394 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1395 that a queue can accumulate while it is idle. Optional. Details of
1396 the <code>linux-htb</code> implementation require a minimum burst
1397 size, so a too-small <code>burst</code> will be silently
1399 <dt><code>priority</code></dt>
1400 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1401 unspecified. A queue with a smaller <code>priority</code>
1402 will receive all the excess bandwidth that it can use before
1403 a queue with a larger value receives any. Specific priority
1404 values are unimportant; only relative ordering matters.</dd>
1406 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1407 column="type"/> of <code>linux-hfsc</code> are:</p>
1409 <dt><code>min-rate</code></dt>
1410 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1411 <dt><code>max-rate</code></dt>
1412 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1413 queue's rate will not be allowed to exceed the specified value, even
1414 if excess bandwidth is available. If unspecified, defaults to no
1419 <column name="external_ids">
1420 Key-value pairs for use by external frameworks that integrate with Open
1421 vSwitch, rather than by Open vSwitch itself. System integrators should
1422 either use the Open vSwitch development mailing list to coordinate on
1423 common key-value definitions, or choose key names that are likely to be
1424 unique. No common key-value pairs are currently defined.
1428 <table name="Monitor" title="Connectivity Monitor configuration">
1430 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1431 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1432 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1433 to detect connectivity problems with each other. MPs within a MA should
1434 have complete and exclusive interconnectivity. This is verified by
1435 occasionally broadcasting Continuity Check Messages (CCMs) at a
1436 configurable transmission interval. A <ref table="Monitor"/> is
1437 responsible for collecting data about other MPs in its MA and
1441 <group title="Monitor Configuration">
1442 <column name="mpid">
1443 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1444 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1445 used to identify this <ref table="Monitor"/> to other endpoints in the
1449 <column name="remote_mps">
1450 A set of <ref table="Maintenance_Points"/> which this
1451 <ref table="Monitor"/> should have connectivity to. If this
1452 <ref table="Monitor"/> does not have connectivity to any MPs in this
1453 set, or has connectivity to any MPs not in this set, a fault is
1457 <column name="ma_name">
1458 A Maintenance Association (MA) name pairs with a Maintenance Domain
1459 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1460 have complete and exclusive interconnectivity. Defaults to
1461 <code>ovs</code> if unset.
1464 <column name="md_name">
1465 A Maintenance Domain name pairs with a Maintenance Association name to
1466 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1469 <column name="interval">
1470 The transmission interval of CCMs in milliseconds. Three missed CCMs
1471 indicate a connectivity fault. Defaults to 1000ms.
1475 <group title="Monitor Status">
1476 <column name="unexpected_remote_mpids">
1477 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1478 has detected connectivity that are not in the
1479 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1480 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1481 Thus, if this set is non-empty a fault is indicated.
1484 <column name="unexpected_remote_maids">
1485 A set of MAIDs representing foreign Maintenance Associations (MAs)
1486 which this <ref table="Monitor"/> has detected connectivity to. A
1487 <ref table="Monitor"/> should not have connectivity to a Maintenance
1488 Association other than its own. Thus, if this set is non-empty a fault
1492 <column name="fault">
1493 Indicates a Connectivity Fault caused by a configuration error, a down
1494 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1499 <table name="Maintenance_Point" title="Maintenance Point configuration">
1501 A <ref table="Maintenance_Point"/> represents a MP which a
1502 <ref table="Monitor"/> has or should have connectivity to.
1505 <group title="Maintenance_Point Configuration">
1506 <column name="mpid">
1507 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1508 a Maintenance Association. All MPs within a MA should have a unique
1513 <group title="Maintenance_Point Status">
1514 <column name="fault">
1515 Indicates a connectivity fault.
1520 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1521 <p>A port mirror within a <ref table="Bridge"/>.</p>
1522 <p>A port mirror configures a bridge to send selected frames to special
1523 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1524 traffic may also be referred to as SPAN or RSPAN, depending on the
1525 mechanism used for delivery.</p>
1527 <column name="name">
1528 Arbitrary identifier for the <ref table="Mirror"/>.
1531 <group title="Selecting Packets for Mirroring">
1532 <column name="select_all">
1533 If true, every packet arriving or departing on any port is
1534 selected for mirroring.
1537 <column name="select_dst_port">
1538 Ports on which departing packets are selected for mirroring.
1541 <column name="select_src_port">
1542 Ports on which arriving packets are selected for mirroring.
1545 <column name="select_vlan">
1546 VLANs on which packets are selected for mirroring. An empty set
1547 selects packets on all VLANs.
1551 <group title="Mirroring Destination Configuration">
1552 <column name="output_port">
1553 <p>Output port for selected packets, if nonempty. Mutually exclusive
1554 with <ref column="output_vlan"/>.</p>
1555 <p>Specifying a port for mirror output reserves that port exclusively
1556 for mirroring. No frames other than those selected for mirroring
1557 will be forwarded to the port, and any frames received on the port
1558 will be discarded.</p>
1559 <p>This type of mirroring is sometimes called SPAN.</p>
1562 <column name="output_vlan">
1563 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1564 with <ref column="output_port"/>.</p>
1565 <p>The frames will be sent out all ports that trunk
1566 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1567 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1568 trunk port, the frame's VLAN tag will be set to
1569 <ref column="output_vlan"/>, replacing any existing tag; when it is
1570 sent out an implicit VLAN port, the frame will not be tagged. This
1571 type of mirroring is sometimes called RSPAN.</p>
1572 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1573 contains unmanaged switches. Consider an unmanaged physical switch
1574 with two ports: port 1, connected to an end host, and port 2,
1575 connected to an Open vSwitch configured to mirror received packets
1576 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1577 port 1 that the physical switch forwards to port 2. The Open vSwitch
1578 forwards this packet to its destination and then reflects it back on
1579 port 2 in VLAN 123. This reflected packet causes the unmanaged
1580 physical switch to replace the MAC learning table entry, which
1581 correctly pointed to port 1, with one that incorrectly points to port
1582 2. Afterward, the physical switch will direct packets destined for
1583 the end host to the Open vSwitch on port 2, instead of to the end
1584 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1585 desired in this scenario, then the physical switch must be replaced
1586 by one that learns Ethernet addresses on a per-VLAN basis. In
1587 addition, learning should be disabled on the VLAN containing mirrored
1588 traffic. If this is not done then intermediate switches will learn
1589 the MAC address of each end host from the mirrored traffic. If
1590 packets being sent to that end host are also mirrored, then they will
1591 be dropped since the switch will attempt to send them out the input
1592 port. Disabling learning for the VLAN will cause the switch to
1593 correctly send the packet out all ports configured for that VLAN. If
1594 Open vSwitch is being used as an intermediate switch, learning can be
1595 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1596 in the appropriate <ref table="Bridge"/> table or tables.</p>
1600 <group title="Other Features">
1601 <column name="external_ids">
1602 Key-value pairs for use by external frameworks that integrate with Open
1603 vSwitch, rather than by Open vSwitch itself. System integrators should
1604 either use the Open vSwitch development mailing list to coordinate on
1605 common key-value definitions, or choose key names that are likely to be
1606 unique. No common key-value pairs are currently defined.
1611 <table name="Controller" title="OpenFlow controller configuration.">
1612 <p>An OpenFlow controller.</p>
1615 Open vSwitch supports two kinds of OpenFlow controllers:
1619 <dt>Primary controllers</dt>
1622 This is the kind of controller envisioned by the OpenFlow 1.0
1623 specification. Usually, a primary controller implements a network
1624 policy by taking charge of the switch's flow table.
1628 Open vSwitch initiates and maintains persistent connections to
1629 primary controllers, retrying the connection each time it fails or
1630 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1631 <ref table="Bridge"/> table applies to primary controllers.
1635 Open vSwitch permits a bridge to have any number of primary
1636 controllers. When multiple controllers are configured, Open
1637 vSwitch connects to all of them simultaneously. Because
1638 OpenFlow 1.0 does not specify how multiple controllers
1639 coordinate in interacting with a single switch, more than
1640 one primary controller should be specified only if the
1641 controllers are themselves designed to coordinate with each
1642 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1643 vendor extension may be useful for this.)
1646 <dt>Service controllers</dt>
1649 These kinds of OpenFlow controller connections are intended for
1650 occasional support and maintenance use, e.g. with
1651 <code>ovs-ofctl</code>. Usually a service controller connects only
1652 briefly to inspect or modify some of a switch's state.
1656 Open vSwitch listens for incoming connections from service
1657 controllers. The service controllers initiate and, if necessary,
1658 maintain the connections from their end. The <ref table="Bridge"
1659 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1660 not apply to service controllers.
1664 Open vSwitch supports configuring any number of service controllers.
1670 The <ref column="target"/> determines the type of controller.
1673 <group title="Core Features">
1674 <column name="target">
1675 <p>Connection method for controller.</p>
1677 The following connection methods are currently supported for primary
1681 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1683 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1684 the given <var>ip</var>, which must be expressed as an IP address
1685 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1686 column in the <ref table="Open_vSwitch"/> table must point to a
1687 valid SSL configuration when this form is used.</p>
1688 <p>SSL support is an optional feature that is not always built as
1689 part of Open vSwitch.</p>
1691 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1692 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1693 the given <var>ip</var>, which must be expressed as an IP address
1694 (not a DNS name).</dd>
1695 <dt><code>discover</code></dt>
1697 <p>Enables controller discovery.</p>
1698 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1699 request with vendor class identifier <code>OpenFlow</code> across
1700 all of the bridge's network devices. It will accept any valid
1701 DHCP reply that has the same vendor class identifier and includes
1702 a vendor-specific option with code 1 whose contents are a string
1703 specifying the location of the controller in the same format as
1704 <ref column="target"/>.</p>
1705 <p>The DHCP reply may also, optionally, include a vendor-specific
1706 option with code 2 whose contents are a string specifying the URI
1707 to the base of the OpenFlow PKI
1708 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1709 used only for bootstrapping the OpenFlow PKI at initial switch
1710 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1714 The following connection methods are currently supported for service
1718 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1721 Listens for SSL connections on the specified TCP <var>port</var>
1722 (default: 6633). If <var>ip</var>, which must be expressed as an
1723 IP address (not a DNS name), is specified, then connections are
1724 restricted to the specified local IP address.
1727 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1728 table="Open_vSwitch"/> table must point to a valid SSL
1729 configuration when this form is used.
1731 <p>SSL support is an optional feature that is not always built as
1732 part of Open vSwitch.</p>
1734 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1736 Listens for connections on the specified TCP <var>port</var>
1737 (default: 6633). If <var>ip</var>, which must be expressed as an
1738 IP address (not a DNS name), is specified, then connections are
1739 restricted to the specified local IP address.
1742 <p>When multiple controllers are configured for a single bridge, the
1743 <ref column="target"/> values must be unique. Duplicate
1744 <ref column="target"/> values yield unspecified results.</p>
1747 <column name="connection_mode">
1748 <p>If it is specified, this setting must be one of the following
1749 strings that describes how Open vSwitch contacts this OpenFlow
1750 controller over the network:</p>
1753 <dt><code>in-band</code></dt>
1754 <dd>In this mode, this controller's OpenFlow traffic travels over the
1755 bridge associated with the controller. With this setting, Open
1756 vSwitch allows traffic to and from the controller regardless of the
1757 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1758 would never be able to connect to the controller, because it did
1759 not have a flow to enable it.) This is the most common connection
1760 mode because it is not necessary to maintain two independent
1762 <dt><code>out-of-band</code></dt>
1763 <dd>In this mode, OpenFlow traffic uses a control network separate
1764 from the bridge associated with this controller, that is, the
1765 bridge does not use any of its own network devices to communicate
1766 with the controller. The control network must be configured
1767 separately, before or after <code>ovs-vswitchd</code> is started.
1771 <p>If not specified, the default is implementation-specific. If
1772 <ref column="target"/> is <code>discover</code>, the connection mode
1773 is always treated as <code>in-band</code> regardless of the actual
1778 <group title="Controller Failure Detection and Handling">
1779 <column name="max_backoff">
1780 Maximum number of milliseconds to wait between connection attempts.
1781 Default is implementation-specific.
1784 <column name="inactivity_probe">
1785 Maximum number of milliseconds of idle time on connection to
1786 controller before sending an inactivity probe message. If Open
1787 vSwitch does not communicate with the controller for the specified
1788 number of seconds, it will send a probe. If a response is not
1789 received for the same additional amount of time, Open vSwitch
1790 assumes the connection has been broken and attempts to reconnect.
1791 Default is implementation-specific.
1795 <group title="OpenFlow Rate Limiting">
1796 <column name="controller_rate_limit">
1797 <p>The maximum rate at which packets in unknown flows will be
1798 forwarded to the OpenFlow controller, in packets per second. This
1799 feature prevents a single bridge from overwhelming the controller.
1800 If not specified, the default is implementation-specific.</p>
1801 <p>In addition, when a high rate triggers rate-limiting, Open
1802 vSwitch queues controller packets for each port and transmits
1803 them to the controller at the configured rate. The number of
1804 queued packets is limited by
1805 the <ref column="controller_burst_limit"/> value. The packet
1806 queue is shared fairly among the ports on a bridge.</p><p>Open
1807 vSwitch maintains two such packet rate-limiters per bridge.
1808 One of these applies to packets sent up to the controller
1809 because they do not correspond to any flow. The other applies
1810 to packets sent up to the controller by request through flow
1811 actions. When both rate-limiters are filled with packets, the
1812 actual rate that packets are sent to the controller is up to
1813 twice the specified rate.</p>
1816 <column name="controller_burst_limit">
1817 In conjunction with <ref column="controller_rate_limit"/>,
1818 the maximum number of unused packet credits that the bridge will
1819 allow to accumulate, in packets. If not specified, the default
1820 is implementation-specific.
1824 <group title="Additional Discovery Configuration">
1825 <p>These values are considered only when <ref column="target"/>
1826 is <code>discover</code>.</p>
1828 <column name="discover_accept_regex">
1830 extended regular expression against which the discovered controller
1831 location is validated. The regular expression is implicitly
1832 anchored at the beginning of the controller location string, as
1833 if it begins with <code>^</code>. If not specified, the default
1834 is implementation-specific.
1837 <column name="discover_update_resolv_conf">
1838 Whether to update <code>/etc/resolv.conf</code> when the
1839 controller is discovered. If not specified, the default
1840 is implementation-specific. Open vSwitch will only modify
1841 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1842 specifies one or more DNS servers.
1846 <group title="Additional In-Band Configuration">
1847 <p>These values are considered only in in-band control mode (see
1848 <ref column="connection_mode"/>) and only when <ref column="target"/>
1849 is not <code>discover</code>. (For controller discovery, the network
1850 configuration obtained via DHCP is used instead.)</p>
1852 <p>When multiple controllers are configured on a single bridge, there
1853 should be only one set of unique values in these columns. If different
1854 values are set for these columns in different controllers, the effect
1857 <column name="local_ip">
1858 The IP address to configure on the local port,
1859 e.g. <code>192.168.0.123</code>. If this value is unset, then
1860 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1864 <column name="local_netmask">
1865 The IP netmask to configure on the local port,
1866 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1867 but this value is unset, then the default is chosen based on whether
1868 the IP address is class A, B, or C.
1871 <column name="local_gateway">
1872 The IP address of the gateway to configure on the local port, as a
1873 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1874 this network has no gateway.
1878 <group title="Other Features">
1879 <column name="external_ids">
1880 Key-value pairs for use by external frameworks that integrate with Open
1881 vSwitch, rather than by Open vSwitch itself. System integrators should
1882 either use the Open vSwitch development mailing list to coordinate on
1883 common key-value definitions, or choose key names that are likely to be
1884 unique. No common key-value pairs are currently defined.
1888 <group title="Controller Status">
1889 <column name="is_connected">
1890 <code>true</code> if currently connected to this controller,
1891 <code>false</code> otherwise.
1894 <column name="role">
1895 <p>The level of authority this controller has on the associated
1896 bridge. Possible values are:</p>
1898 <dt><code>other</code></dt>
1899 <dd>Allows the controller access to all OpenFlow features.</dd>
1900 <dt><code>master</code></dt>
1901 <dd>Equivalent to <code>other</code>, except that there may be at
1902 most one master controller at a time. When a controller configures
1903 itself as <code>master</code>, any existing master is demoted to
1904 the <code>slave</code>role.</dd>
1905 <dt><code>slave</code></dt>
1906 <dd>Allows the controller read-only access to OpenFlow features.
1907 Attempts to modify the flow table will be rejected with an
1908 error. Slave controllers do not receive OFPT_PACKET_IN or
1909 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1914 <column name="status">
1915 <p>Key-value pairs that report controller status.</p>
1917 <dt><code>last_error</code></dt>
1918 <dd>A human-readable description of the last error on the connection
1919 to the controller; i.e. <code>strerror(errno)</code>. This key
1920 will exist only if an error has occurred.</dd>
1921 <dt><code>state</code></dt>
1922 <dd>The state of the connection to the controller. Possible values
1923 are: <code>VOID</code> (connection is disabled),
1924 <code>BACKOFF</code> (attempting to reconnect at an increasing
1925 period), <code>CONNECTING</code> (attempting to connect),
1926 <code>ACTIVE</code> (connected, remote host responsive), and
1927 <code>IDLE</code> (remote host idle, sending keep-alive). These
1928 values may change in the future. They are provided only for human
1930 <dt><code>sec_since_connect</code></dt>
1931 <dd>The amount of time since this controller last successfully
1932 connected to the switch (in seconds). Value is empty if controller
1933 has never successfully connected.</dd>
1934 <dt><code>sec_since_disconnect</code></dt>
1935 <dd>The amount of time since this controller last disconnected from
1936 the switch (in seconds). Value is empty if controller has never
1943 <table name="Manager" title="OVSDB management connection.">
1945 Configuration for a database connection to an Open vSwitch database
1950 This table primarily configures the Open vSwitch database
1951 (<code>ovsdb-server</code>), not the Open vSwitch switch
1952 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1953 what connections should be treated as in-band.
1957 The Open vSwitch database server can initiate and maintain active
1958 connections to remote clients. It can also listen for database
1962 <group title="Core Features">
1963 <column name="target">
1964 <p>Connection method for managers.</p>
1966 The following connection methods are currently supported:
1969 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1972 The specified SSL <var>port</var> (default: 6632) on the host at
1973 the given <var>ip</var>, which must be expressed as an IP address
1974 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1975 column in the <ref table="Open_vSwitch"/> table must point to a
1976 valid SSL configuration when this form is used.
1979 SSL support is an optional feature that is not always built as
1980 part of Open vSwitch.
1984 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1986 The specified TCP <var>port</var> (default: 6632) on the host at
1987 the given <var>ip</var>, which must be expressed as an IP address
1990 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1993 Listens for SSL connections on the specified TCP <var>port</var>
1994 (default: 6632). If <var>ip</var>, which must be expressed as an
1995 IP address (not a DNS name), is specified, then connections are
1996 restricted to the specified local IP address.
1999 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2000 table="Open_vSwitch"/> table must point to a valid SSL
2001 configuration when this form is used.
2004 SSL support is an optional feature that is not always built as
2005 part of Open vSwitch.
2008 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2010 Listens for connections on the specified TCP <var>port</var>
2011 (default: 6632). If <var>ip</var>, which must be expressed as an
2012 IP address (not a DNS name), is specified, then connections are
2013 restricted to the specified local IP address.
2016 <p>When multiple managers are configured, the <ref column="target"/>
2017 values must be unique. Duplicate <ref column="target"/> values yield
2018 unspecified results.</p>
2021 <column name="connection_mode">
2023 If it is specified, this setting must be one of the following strings
2024 that describes how Open vSwitch contacts this OVSDB client over the
2029 <dt><code>in-band</code></dt>
2031 In this mode, this connection's traffic travels over a bridge
2032 managed by Open vSwitch. With this setting, Open vSwitch allows
2033 traffic to and from the client regardless of the contents of the
2034 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2035 to connect to the client, because it did not have a flow to enable
2036 it.) This is the most common connection mode because it is not
2037 necessary to maintain two independent networks.
2039 <dt><code>out-of-band</code></dt>
2041 In this mode, the client's traffic uses a control network separate
2042 from that managed by Open vSwitch, that is, Open vSwitch does not
2043 use any of its own network devices to communicate with the client.
2044 The control network must be configured separately, before or after
2045 <code>ovs-vswitchd</code> is started.
2050 If not specified, the default is implementation-specific.
2055 <group title="Client Failure Detection and Handling">
2056 <column name="max_backoff">
2057 Maximum number of milliseconds to wait between connection attempts.
2058 Default is implementation-specific.
2061 <column name="inactivity_probe">
2062 Maximum number of milliseconds of idle time on connection to the client
2063 before sending an inactivity probe message. If Open vSwitch does not
2064 communicate with the client for the specified number of seconds, it
2065 will send a probe. If a response is not received for the same
2066 additional amount of time, Open vSwitch assumes the connection has been
2067 broken and attempts to reconnect. Default is implementation-specific.
2071 <group title="Other Features">
2072 <column name="external_ids">
2073 Key-value pairs for use by external frameworks that integrate with Open
2074 vSwitch, rather than by Open vSwitch itself. System integrators should
2075 either use the Open vSwitch development mailing list to coordinate on
2076 common key-value definitions, or choose key names that are likely to be
2077 unique. No common key-value pairs are currently defined.
2081 <group title="Status">
2082 <column name="is_connected">
2083 <code>true</code> if currently connected to this manager,
2084 <code>false</code> otherwise.
2087 <column name="status">
2088 <p>Key-value pairs that report manager status.</p>
2090 <dt><code>last_error</code></dt>
2091 <dd>A human-readable description of the last error on the connection
2092 to the manager; i.e. <code>strerror(errno)</code>. This key
2093 will exist only if an error has occurred.</dd>
2096 <dt><code>state</code></dt>
2097 <dd>The state of the connection to the manager. Possible values
2098 are: <code>VOID</code> (connection is disabled),
2099 <code>BACKOFF</code> (attempting to reconnect at an increasing
2100 period), <code>CONNECTING</code> (attempting to connect),
2101 <code>ACTIVE</code> (connected, remote host responsive), and
2102 <code>IDLE</code> (remote host idle, sending keep-alive). These
2103 values may change in the future. They are provided only for human
2107 <dt><code>sec_since_connect</code></dt>
2108 <dd>The amount of time since this manager last successfully connected
2109 to the database (in seconds). Value is empty if manager has never
2110 successfully connected.</dd>
2113 <dt><code>sec_since_disconnect</code></dt>
2114 <dd>The amount of time since this manager last disconnected from the
2115 database (in seconds). Value is empty if manager has never
2122 <table name="NetFlow">
2123 A NetFlow target. NetFlow is a protocol that exports a number of
2124 details about terminating IP flows, such as the principals involved
2127 <column name="targets">
2128 NetFlow targets in the form
2129 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2130 must be specified numerically, not as a DNS name.
2133 <column name="engine_id">
2134 Engine ID to use in NetFlow messages. Defaults to datapath index
2138 <column name="engine_type">
2139 Engine type to use in NetFlow messages. Defaults to datapath
2140 index if not specified.
2143 <column name="active_timeout">
2144 The interval at which NetFlow records are sent for flows that are
2145 still active, in seconds. A value of <code>0</code> requests the
2146 default timeout (currently 600 seconds); a value of <code>-1</code>
2147 disables active timeouts.
2150 <column name="add_id_to_interface">
2151 <p>If this column's value is <code>false</code>, the ingress and egress
2152 interface fields of NetFlow flow records are derived from OpenFlow port
2153 numbers. When it is <code>true</code>, the 7 most significant bits of
2154 these fields will be replaced by the least significant 7 bits of the
2155 engine id. This is useful because many NetFlow collectors do not
2156 expect multiple switches to be sending messages from the same host, so
2157 they do not store the engine information which could be used to
2158 disambiguate the traffic.</p>
2159 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2162 <column name="external_ids">
2163 Key-value pairs for use by external frameworks that integrate with Open
2164 vSwitch, rather than by Open vSwitch itself. System integrators should
2165 either use the Open vSwitch development mailing list to coordinate on
2166 common key-value definitions, or choose key names that are likely to be
2167 unique. No common key-value pairs are currently defined.
2172 SSL configuration for an Open_vSwitch.
2174 <column name="private_key">
2175 Name of a PEM file containing the private key used as the switch's
2176 identity for SSL connections to the controller.
2179 <column name="certificate">
2180 Name of a PEM file containing a certificate, signed by the
2181 certificate authority (CA) used by the controller and manager,
2182 that certifies the switch's private key, identifying a trustworthy
2186 <column name="ca_cert">
2187 Name of a PEM file containing the CA certificate used to verify
2188 that the switch is connected to a trustworthy controller.
2191 <column name="bootstrap_ca_cert">
2192 If set to <code>true</code>, then Open vSwitch will attempt to
2193 obtain the CA certificate from the controller on its first SSL
2194 connection and save it to the named PEM file. If it is successful,
2195 it will immediately drop the connection and reconnect, and from then
2196 on all SSL connections must be authenticated by a certificate signed
2197 by the CA certificate thus obtained. <em>This option exposes the
2198 SSL connection to a man-in-the-middle attack obtaining the initial
2199 CA certificate.</em> It may still be useful for bootstrapping.
2202 <column name="external_ids">
2203 Key-value pairs for use by external frameworks that integrate with Open
2204 vSwitch, rather than by Open vSwitch itself. System integrators should
2205 either use the Open vSwitch development mailing list to coordinate on
2206 common key-value definitions, or choose key names that are likely to be
2207 unique. No common key-value pairs are currently defined.
2211 <table name="sFlow">
2212 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2215 <column name="agent">
2216 Name of the network device whose IP address should be reported as the
2217 ``agent address'' to collectors. If not specified, the IP address
2218 defaults to the <ref table="Controller" column="local_ip"/> in the
2219 collector's <ref table="Controller"/>. If an agent IP address cannot be
2220 determined either way, sFlow is disabled.
2223 <column name="header">
2224 Number of bytes of a sampled packet to send to the collector.
2225 If not specified, the default is 128 bytes.
2228 <column name="polling">
2229 Polling rate in seconds to send port statistics to the collector.
2230 If not specified, defaults to 30 seconds.
2233 <column name="sampling">
2234 Rate at which packets should be sampled and sent to the collector.
2235 If not specified, defaults to 400, which means one out of 400
2236 packets, on average, will be sent to the collector.
2239 <column name="targets">
2240 sFlow targets in the form
2241 <code><var>ip</var>:<var>port</var></code>.
2244 <column name="external_ids">
2245 Key-value pairs for use by external frameworks that integrate with Open
2246 vSwitch, rather than by Open vSwitch itself. System integrators should
2247 either use the Open vSwitch development mailing list to coordinate on
2248 common key-value definitions, or choose key names that are likely to be
2249 unique. No common key-value pairs are currently defined.
2253 <table name="Capability">
2254 <p>Records in this table describe functionality supported by the hardware
2255 and software platform on which this Open vSwitch is based. Clients
2256 should not modify this table.</p>
2258 <p>A record in this table is meaningful only if it is referenced by the
2259 <ref table="Open_vSwitch" column="capabilities"/> column in the
2260 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2261 the record's ``category,'' determines the meanings of the
2262 <ref column="details"/> column. The following general forms of
2263 categories are currently defined:</p>
2266 <dt><code>qos-<var>type</var></code></dt>
2267 <dd><var>type</var> is supported as the value for
2268 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2272 <column name="details">
2273 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2274 depends on the category key that the <ref table="Open_vSwitch"
2275 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2276 uses to reference this record, as described above.</p>
2278 <p>The presence of a record for category <code>qos-<var>type</var></code>
2279 indicates that the switch supports <var>type</var> as the value of
2280 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2281 table. The following key-value pairs are defined to further describe
2282 QoS capabilities:</p>
2285 <dt><code>n-queues</code></dt>
2286 <dd>Number of supported queues, as a positive integer. Keys in the
2287 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2288 records whose <ref table="QoS" column="type"/> value
2289 equals <var>type</var> must range between 0 and this value minus one,
projects / openvswitch / blob