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 digits.
367 (Setting this column has no useful effect. Set <ref
368 column="other-config" key="datapath-id"/> instead.)
372 <group title="Other Features">
373 <column name="datapath_type">
374 Name of datapath provider. The kernel datapath has
375 type <code>system</code>. The userspace datapath has
376 type <code>netdev</code>.
379 <column name="external_ids">
380 Key-value pairs for use by external frameworks that integrate
381 with Open vSwitch, rather than by Open vSwitch itself. System
382 integrators should either use the Open vSwitch development
383 mailing list to coordinate on common key-value definitions, or
384 choose key names that are likely to be unique. The currently
385 defined key-value pairs are:
387 <dt><code>bridge-id</code></dt>
388 <dd>A unique identifier of the bridge. On Citrix XenServer this
389 will commonly be the same as <code>xs-network-uuids</code>.</dd>
390 <dt><code>xs-network-uuids</code></dt>
391 <dd>Semicolon-delimited set of universally unique identifier(s) for
392 the network with which this bridge is associated on a Citrix
393 XenServer host. The network identifiers are RFC 4122 UUIDs as
394 displayed by, e.g., <code>xe network-list</code>.</dd>
398 <column name="other_config">
399 Key-value pairs for configuring rarely used bridge
400 features. The currently defined key-value pairs are:
402 <dt><code>datapath-id</code></dt>
404 digits to set the OpenFlow datapath ID to a specific
405 value. May not be all-zero.</dd>
406 <dt><code>disable-in-band</code></dt>
407 <dd>If set to <code>true</code>, disable in-band control on
408 the bridge regardless of controller and manager settings.</dd>
409 <dt><code>hwaddr</code></dt>
410 <dd>An Ethernet address in the form
411 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
412 to set the hardware address of the local port and influence the
414 <dt><code>in-band-queue</code></dt>
416 A queue ID as a nonnegative integer. This sets the OpenFlow queue
417 ID that will be used by flows set up by in-band control on this
418 bridge. If unset, or if the port used by an in-band control flow
419 does not have QoS configured, or if the port does not have a queue
420 with the specified ID, the default queue is used instead.
427 <table name="Port" table="Port or bond configuration.">
428 <p>A port within a <ref table="Bridge"/>.</p>
429 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
430 <ref column="interfaces"/> column. Such a port logically
431 corresponds to a port on a physical Ethernet switch. A port
432 with more than one interface is a ``bonded port'' (see
433 <ref group="Bonding Configuration"/>).</p>
434 <p>Some properties that one might think as belonging to a port are actually
435 part of the port's <ref table="Interface"/> members.</p>
438 Port name. Should be alphanumeric and no more than about 8
439 bytes long. May be the same as the interface name, for
440 non-bonded ports. Must otherwise be unique among the names of
441 ports, interfaces, and bridges on a host.
444 <column name="interfaces">
445 The port's interfaces. If there is more than one, this is a
449 <group title="VLAN Configuration">
450 <p>A bridge port must be configured for VLANs in one of two
451 mutually exclusive ways:
453 <li>A ``trunk port'' has an empty value for <ref
454 column="tag"/>. Its <ref column="trunks"/> value may be
455 empty or non-empty.</li>
456 <li>An ``implicitly tagged VLAN port'' or ``access port''
457 has an nonempty value for <ref column="tag"/>. Its
458 <ref column="trunks"/> value must be empty.</li>
460 If <ref column="trunks"/> and <ref column="tag"/> are both
461 nonempty, the configuration is ill-formed.
466 If this is an access port (see above), the port's implicitly
467 tagged VLAN. Must be empty if this is a trunk port.
470 Frames arriving on trunk ports will be forwarded to this
471 port only if they are tagged with the given VLAN (or, if
472 <ref column="tag"/> is 0, then if they lack a VLAN header).
473 Frames arriving on other access ports will be forwarded to
474 this port only if they have the same <ref column="tag"/>
475 value. Frames forwarded to this port will not have an
479 When a frame with a 802.1Q header that indicates a nonzero
480 VLAN is received on an access port, it is discarded.
484 <column name="trunks">
486 If this is a trunk port (see above), the 802.1Q VLAN(s) that
487 this port trunks; if it is empty, then the port trunks all
488 VLANs. Must be empty if this is an access port.
491 Frames arriving on trunk ports are dropped if they are not
492 in one of the specified VLANs. For this purpose, packets
493 that have no VLAN header are treated as part of VLAN 0.
498 <group title="Bonding Configuration">
499 <p>A port that has more than one interface is a ``bonded port.'' Bonding
500 allows for load balancing and fail-over. Some kinds of bonding will
501 work with any kind of upstream switch:</p>
504 <dt><code>balance-slb</code></dt>
506 Balances flows among slaves based on source MAC address and output
507 VLAN, with periodic rebalancing as traffic patterns change.
510 <dt><code>active-backup</code></dt>
512 Assigns all flows to one slave, failing over to a backup slave when
513 the active slave is disabled.
518 The following mode requires the upstream switch to support 802.3ad with
519 successful LACP negotiation. If LACP negotiation fails then
520 <code>balance-slb</code> mode is used as a fallback:
524 <dt><code>balance-tcp</code></dt>
526 Balances flows among slaves based on L2, L3, and L4 protocol
527 information such as destination MAC address, IP address, and TCP
532 <p>These columns apply only to bonded ports. Their values are
533 otherwise ignored.</p>
535 <column name="bond_mode">
536 <p>The type of bonding used for a bonded port. Defaults to
537 <code>balance-slb</code> if unset.
541 <column name="bond_updelay">
542 <p>For a bonded port, the number of milliseconds for which carrier must
543 stay up on an interface before the interface is considered to be up.
544 Specify <code>0</code> to enable the interface immediately.</p>
545 <p>This setting is honored only when at least one bonded interface is
546 already enabled. When no interfaces are enabled, then the first bond
547 interface to come up is enabled immediately.</p>
550 <column name="bond_downdelay">
551 For a bonded port, the number of milliseconds for which carrier must
552 stay down on an interface before the interface is considered to be
553 down. Specify <code>0</code> to disable the interface immediately.
556 <column name="bond_fake_iface">
557 For a bonded port, whether to create a fake internal interface with the
558 name of the port. Use only for compatibility with legacy software that
563 <p>Configures LACP on this port. LACP allows directly connected
564 switches to negotiate which links may be bonded. LACP may be enabled
565 on non-bonded ports for the benefit of any switches they may be
566 connected to. <code>active</code> ports are allowed to initiate LACP
567 negotiations. <code>passive</code> ports are allowed to participate
568 in LACP negotiations initiated by a remote switch, but not allowed to
569 initiate such negotiations themselves. If unset Open vSwitch will
570 choose a reasonable default. </p>
575 <group title="Other Features">
577 Quality of Service configuration for this port.
581 The MAC address to use for this port for the purpose of choosing the
582 bridge's MAC address. This column does not necessarily reflect the
583 port's actual MAC address, nor will setting it change the port's actual
587 <column name="fake_bridge">
588 Does this port represent a sub-bridge for its tagged VLAN within the
589 Bridge? See ovs-vsctl(8) for more information.
592 <column name="external_ids">
594 Key-value pairs for use by external frameworks that integrate with
595 Open vSwitch, rather than by Open vSwitch itself. System integrators
596 should either use the Open vSwitch development mailing list to
597 coordinate on common key-value definitions, or choose key names that
598 are likely to be unique.
601 No key-value pairs native to <ref table="Port"/> are currently
602 defined. For fake bridges (see the <ref column="fake_bridge"/>
603 column), external IDs for the fake bridge are defined here by
604 prefixing a <ref table="Bridge"/> <ref table="Bridge"
605 column="external_ids"/> key with <code>fake-bridge-</code>,
606 e.g. <code>fake-bridge-xs-network-uuids</code>.
610 <column name="other_config">
611 Key-value pairs for configuring rarely used port features. The
612 currently defined key-value pairs are:
614 <dt><code>hwaddr</code></dt>
615 <dd>An Ethernet address in the form
616 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
617 <dt><code>bond-rebalance-interval</code></dt>
618 <dd>For an SLB bonded port, the number of milliseconds between
619 successive attempts to rebalance the bond, that is, to
620 move source MACs and their flows from one interface on
621 the bond to another in an attempt to keep usage of each
622 interface roughly equal. The default is 10000 (10
623 seconds), and the minimum is 1000 (1 second).</dd>
624 <dt><code>bond-detect-mode</code></dt>
625 <dd> Sets the method used to detect link failures in a bonded port.
626 Options are <code>carrier</code> and <code>miimon</code>. Defaults
627 to <code>carrier</code> which uses each interface's carrier to detect
628 failures. When set to <code>miimon</code>, will check for failures
629 by polling each interface's MII. </dd>
630 <dt><code>bond-miimon-interval</code></dt>
631 <dd> The number of milliseconds between successive attempts to
632 poll each interface's MII. Only relevant on ports which use
633 <code>miimon</code> to detect failures. </dd>
634 <dt><code>lacp-system-priority</code></dt>
635 <dd> The LACP system priority of this <ref table="Port"/>. In
636 LACP negotiations, link status decisions are made by the system
637 with the numerically lower priority. Must be a number between 1
644 <table name="Interface" title="One physical network device in a Port.">
645 An interface within a <ref table="Port"/>.
647 <group title="Core Features">
649 Interface name. Should be alphanumeric and no more than about 8 bytes
650 long. May be the same as the port name, for non-bonded ports. Must
651 otherwise be unique among the names of ports, interfaces, and bridges
656 <p>Ethernet address to set for this interface. If unset then the
657 default MAC address is used:</p>
659 <li>For the local interface, the default is the lowest-numbered MAC
660 address among the other bridge ports, either the value of the
661 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
662 if set, or its actual MAC (for bonded ports, the MAC of its slave
663 whose name is first in alphabetical order). Internal ports and
664 bridge ports that are used as port mirroring destinations (see the
665 <ref table="Mirror"/> table) are ignored.</li>
666 <li>For other internal interfaces, the default MAC is randomly
668 <li>External interfaces typically have a MAC address associated with
671 <p>Some interfaces may not have a software-controllable MAC
675 <column name="ofport">
676 <p>OpenFlow port number for this interface. Unlike most columns, this
677 column's value should be set only by Open vSwitch itself. Other
678 clients should set this column to an empty set (the default) when
679 creating an <ref table="Interface"/>.</p>
680 <p>Open vSwitch populates this column when the port number becomes
681 known. If the interface is successfully added,
682 <ref column="ofport"/> will be set to a number between 1 and 65535
683 (generally either in the range 1 to 65279, inclusive, or 65534, the
684 port number for the OpenFlow ``local port''). If the interface
685 cannot be added then Open vSwitch sets this column
690 <group title="System-Specific Details">
692 The interface type, one of:
694 <dt><code>system</code></dt>
695 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
696 Sometimes referred to as ``external interfaces'' since they are
697 generally connected to hardware external to that on which the Open
698 vSwitch is running. The empty string is a synonym for
699 <code>system</code>.</dd>
700 <dt><code>internal</code></dt>
701 <dd>A simulated network device that sends and receives traffic. An
702 internal interface whose <ref column="name"/> is the same as its
703 bridge's <ref table="Open_vSwitch" column="name"/> is called the
704 ``local interface.'' It does not make sense to bond an internal
705 interface, so the terms ``port'' and ``interface'' are often used
706 imprecisely for internal interfaces.</dd>
707 <dt><code>tap</code></dt>
708 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
709 <dt><code>gre</code></dt>
710 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
711 tunnel. Each tunnel must be uniquely identified by the
712 combination of <code>remote_ip</code>, <code>local_ip</code>, and
713 <code>in_key</code>. Note that if two ports are defined that are
714 the same except one has an optional identifier and the other does
715 not, the more specific one is matched first. <code>in_key</code>
716 is considered more specific than <code>local_ip</code> if a port
717 defines one and another port defines the other. The following
718 options may be specified in the <ref column="options"/> column:
720 <dt><code>remote_ip</code></dt>
721 <dd>Required. The tunnel endpoint.</dd>
724 <dt><code>local_ip</code></dt>
725 <dd>Optional. The destination IP that received packets must
726 match. Default is to match all addresses.</dd>
729 <dt><code>in_key</code></dt>
730 <dd>Optional. The GRE key that received packets must contain.
731 It may either be a 32-bit number (no key and a key of 0 are
732 treated as equivalent) or the word <code>flow</code>. If
733 <code>flow</code> is specified then any key will be accepted
734 and the key will be placed in the <code>tun_id</code> field
735 for matching in the flow table. The ovs-ofctl manual page
736 contains additional information about matching fields in
737 OpenFlow flows. Default is no key.</dd>
740 <dt><code>out_key</code></dt>
741 <dd>Optional. The GRE key to be set on outgoing packets. It may
742 either be a 32-bit number or the word <code>flow</code>. If
743 <code>flow</code> is specified then the key may be set using
744 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
745 is used in the absence of an action). The ovs-ofctl manual
746 page contains additional information about the Nicira OpenFlow
747 vendor extensions. Default is no key.</dd>
750 <dt><code>key</code></dt>
751 <dd>Optional. Shorthand to set <code>in_key</code> and
752 <code>out_key</code> at the same time.</dd>
755 <dt><code>tos</code></dt>
756 <dd>Optional. The value of the ToS bits to be set on the
757 encapsulating packet. It may also be the word
758 <code>inherit</code>, in which case the ToS will be copied from
759 the inner packet if it is IPv4 or IPv6 (otherwise it will be
760 0). Note that the ECN fields are always inherited. Default is
764 <dt><code>ttl</code></dt>
765 <dd>Optional. The TTL to be set on the encapsulating packet.
766 It may also be the word <code>inherit</code>, in which case the
767 TTL will be copied from the inner packet if it is IPv4 or IPv6
768 (otherwise it will be the system default, typically 64).
769 Default is the system default TTL.</dd>
772 <dt><code>csum</code></dt>
773 <dd>Optional. Compute GRE checksums on outgoing packets.
774 Checksums present on incoming packets will be validated
775 regardless of this setting. Note that GRE checksums
776 impose a significant performance penalty as they cover the
777 entire packet. As the contents of the packet is typically
778 covered by L3 and L4 checksums, this additional checksum only
779 adds value for the GRE and encapsulated Ethernet headers.
780 Default is disabled, set to <code>true</code> to enable.</dd>
783 <dt><code>pmtud</code></dt>
784 <dd>Optional. Enable tunnel path MTU discovery. If enabled
785 ``ICMP destination unreachable - fragmentation'' needed
786 messages will be generated for IPv4 packets with the DF bit set
787 and IPv6 packets above the minimum MTU if the packet size
788 exceeds the path MTU minus the size of the tunnel headers. It
789 also forces the encapsulating packet DF bit to be set (it is
790 always set if the inner packet implies path MTU discovery).
791 Note that this option causes behavior that is typically
792 reserved for routers and therefore is not entirely in
793 compliance with the IEEE 802.1D specification for bridges.
794 Default is enabled, set to <code>false</code> to disable.</dd>
797 <dt><code>header_cache</code></dt>
798 <dd>Optional. Enable caching of tunnel headers and the output
799 path. This can lead to a significant performance increase
800 without changing behavior. In general it should not be
801 necessary to adjust this setting. However, the caching can
802 bypass certain components of the IP stack (such as IP tables)
803 and it may be useful to disable it if these features are
804 required or as a debugging measure. Default is enabled, set to
805 <code>false</code> to disable.</dd>
808 <dt><code>ipsec_gre</code></dt>
809 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
810 over IPv4 IPsec tunnel. Each tunnel (including those of type
811 <code>gre</code>) must be uniquely identified by the
812 combination of <code>remote_ip</code> and
813 <code>local_ip</code>. Note that if two ports are defined
814 that are the same except one has an optional identifier and
815 the other does not, the more specific one is matched first.
816 An authentication method of <code>peer_cert</code> or
817 <code>psk</code> must be defined. The following options may
818 be specified in the <ref column="options"/> column:
820 <dt><code>remote_ip</code></dt>
821 <dd>Required. The tunnel endpoint.</dd>
824 <dt><code>local_ip</code></dt>
825 <dd>Optional. The destination IP that received packets must
826 match. Default is to match all addresses.</dd>
829 <dt><code>peer_cert</code></dt>
830 <dd>Required for certificate authentication. A string
831 containing the peer's certificate in PEM format.
832 Additionally the host's certificate must be specified
833 with the <code>certificate</code> option.</dd>
836 <dt><code>certificate</code></dt>
837 <dd>Required for certificate authentication. The name of a
838 PEM file containing a certificate that will be presented
839 to the peer during authentication.</dd>
842 <dt><code>private_key</code></dt>
843 <dd>Optional for certificate authentication. The name of
844 a PEM file containing the private key associated with
845 <code>certificate</code>. If <code>certificate</code>
846 contains the private key, this option may be omitted.</dd>
849 <dt><code>psk</code></dt>
850 <dd>Required for pre-shared key authentication. Specifies a
851 pre-shared key for authentication that must be identical on
852 both sides of the tunnel.</dd>
855 <dt><code>in_key</code></dt>
856 <dd>Optional. The GRE key that received packets must contain.
857 It may either be a 32-bit number (no key and a key of 0 are
858 treated as equivalent) or the word <code>flow</code>. If
859 <code>flow</code> is specified then any key will be accepted
860 and the key will be placed in the <code>tun_id</code> field
861 for matching in the flow table. The ovs-ofctl manual page
862 contains additional information about matching fields in
863 OpenFlow flows. Default is no key.</dd>
866 <dt><code>out_key</code></dt>
867 <dd>Optional. The GRE key to be set on outgoing packets. It may
868 either be a 32-bit number or the word <code>flow</code>. If
869 <code>flow</code> is specified then the key may be set using
870 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
871 is used in the absence of an action). The ovs-ofctl manual
872 page contains additional information about the Nicira OpenFlow
873 vendor extensions. Default is no key.</dd>
876 <dt><code>key</code></dt>
877 <dd>Optional. Shorthand to set <code>in_key</code> and
878 <code>out_key</code> at the same time.</dd>
881 <dt><code>tos</code></dt>
882 <dd>Optional. The value of the ToS bits to be set on the
883 encapsulating packet. It may also be the word
884 <code>inherit</code>, in which case the ToS will be copied from
885 the inner packet if it is IPv4 or IPv6 (otherwise it will be
886 0). Note that the ECN fields are always inherited. Default is
890 <dt><code>ttl</code></dt>
891 <dd>Optional. The TTL to be set on the encapsulating packet.
892 It may also be the word <code>inherit</code>, in which case the
893 TTL will be copied from the inner packet if it is IPv4 or IPv6
894 (otherwise it will be the system default, typically 64).
895 Default is the system default TTL.</dd>
898 <dt><code>csum</code></dt>
899 <dd>Optional. Compute GRE checksums on outgoing packets.
900 Checksums present on incoming packets will be validated
901 regardless of this setting. Note that GRE checksums
902 impose a significant performance penalty as they cover the
903 entire packet. As the contents of the packet is typically
904 covered by L3 and L4 checksums, this additional checksum only
905 adds value for the GRE and encapsulated Ethernet headers.
906 Default is disabled, set to <code>true</code> to enable.</dd>
909 <dt><code>pmtud</code></dt>
910 <dd>Optional. Enable tunnel path MTU discovery. If enabled
911 ``ICMP destination unreachable - fragmentation'' needed
912 messages will be generated for IPv4 packets with the DF bit set
913 and IPv6 packets above the minimum MTU if the packet size
914 exceeds the path MTU minus the size of the tunnel headers. It
915 also forces the encapsulating packet DF bit to be set (it is
916 always set if the inner packet implies path MTU discovery).
917 Note that this option causes behavior that is typically
918 reserved for routers and therefore is not entirely in
919 compliance with the IEEE 802.1D specification for bridges.
920 Default is enabled, set to <code>false</code> to disable.</dd>
923 <dt><code>capwap</code></dt>
924 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
925 (RFC 5415). This allows interoperability with certain switches
926 where GRE is not available. Note that only the tunneling component
927 of the protocol is implemented. Due to the non-standard use of
928 CAPWAP, UDP ports 58881 and 58882 are used as the source and
929 destination ports respectively. Each tunnel must be uniquely
930 identified by the combination of <code>remote_ip</code> and
931 <code>local_ip</code>. If two ports are defined that are the same
932 except one includes <code>local_ip</code> and the other does not,
933 the more specific one is matched first. CAPWAP support is not
934 available on all platforms. Currently it is only supported in the
935 Linux kernel module with kernel versions >= 2.6.25. The following
936 options may be specified in the <ref column="options"/> column:
938 <dt><code>remote_ip</code></dt>
939 <dd>Required. The tunnel endpoint.</dd>
942 <dt><code>local_ip</code></dt>
943 <dd>Optional. The destination IP that received packets must
944 match. Default is to match all addresses.</dd>
947 <dt><code>tos</code></dt>
948 <dd>Optional. The value of the ToS bits to be set on the
949 encapsulating packet. It may also be the word
950 <code>inherit</code>, in which case the ToS will be copied from
951 the inner packet if it is IPv4 or IPv6 (otherwise it will be
952 0). Note that the ECN fields are always inherited. Default is
956 <dt><code>ttl</code></dt>
957 <dd>Optional. The TTL to be set on the encapsulating packet.
958 It may also be the word <code>inherit</code>, in which case the
959 TTL will be copied from the inner packet if it is IPv4 or IPv6
960 (otherwise it will be the system default, typically 64).
961 Default is the system default TTL.</dd>
964 <dt><code>pmtud</code></dt>
965 <dd>Optional. Enable tunnel path MTU discovery. If enabled
966 ``ICMP destination unreachable - fragmentation'' needed
967 messages will be generated for IPv4 packets with the DF bit set
968 and IPv6 packets above the minimum MTU if the packet size
969 exceeds the path MTU minus the size of the tunnel headers. It
970 also forces the encapsulating packet DF bit to be set (it is
971 always set if the inner packet implies path MTU discovery).
972 Note that this option causes behavior that is typically
973 reserved for routers and therefore is not entirely in
974 compliance with the IEEE 802.1D specification for bridges.
975 Default is enabled, set to <code>false</code> to disable.</dd>
978 <dt><code>header_cache</code></dt>
979 <dd>Optional. Enable caching of tunnel headers and the output
980 path. This can lead to a significant performance increase
981 without changing behavior. In general it should not be
982 necessary to adjust this setting. However, the caching can
983 bypass certain components of the IP stack (such as IP tables)
984 and it may be useful to disable it if these features are
985 required or as a debugging measure. Default is enabled, set to
986 <code>false</code> to disable.</dd>
989 <dt><code>patch</code></dt>
992 A pair of virtual devices that act as a patch cable. The <ref
993 column="options"/> column must have the following key-value pair:
996 <dt><code>peer</code></dt>
998 The <ref column="name"/> of the <ref table="Interface"/> for
999 the other side of the patch. The named <ref
1000 table="Interface"/>'s own <code>peer</code> option must specify
1001 this <ref table="Interface"/>'s name. That is, the two patch
1002 interfaces must have reversed <ref column="name"/> and
1003 <code>peer</code> values.
1010 <column name="options">
1011 Configuration options whose interpretation varies based on
1012 <ref column="type"/>.
1016 <group title="Interface Status">
1018 Status information about interfaces attached to bridges, updated every
1019 5 seconds. Not all interfaces have all of these properties; virtual
1020 interfaces don't have a link speed, for example. Non-applicable
1021 columns will have empty values.
1023 <column name="admin_state">
1025 The administrative state of the physical network link.
1029 <column name="link_state">
1031 The observed state of the physical network link;
1032 i.e. whether a carrier is detected by the interface.
1036 <column name="link_speed">
1038 The negotiated speed of the physical network link.
1039 Valid values are positive integers greater than 0.
1043 <column name="duplex">
1045 The duplex mode of the physical network link.
1051 The MTU (maximum transmission unit); i.e. the largest
1052 amount of data that can fit into a single Ethernet frame.
1053 The standard Ethernet MTU is 1500 bytes. Some physical media
1054 and many kinds of virtual interfaces can be configured with
1058 This column will be empty for an interface that does not
1059 have an MTU as, for example, some kinds of tunnels do not.
1063 <column name="status">
1065 Key-value pairs that report port status. Supported status
1066 values are <code>type</code>-dependent; some interfaces may not have
1067 a valid <code>driver_name</code>, for example.
1069 <p>The currently defined key-value pairs are:</p>
1071 <dt><code>driver_name</code></dt>
1072 <dd>The name of the device driver controlling the network
1076 <dt><code>driver_version</code></dt>
1077 <dd>The version string of the device driver controlling the
1078 network adapter.</dd>
1081 <dt><code>firmware_version</code></dt>
1082 <dd>The version string of the network adapter's firmware, if
1086 <dt><code>source_ip</code></dt>
1087 <dd>The source IP address used for an IPv4 tunnel end-point,
1088 such as <code>gre</code> or <code>capwap</code>.</dd>
1091 <dt><code>tunnel_egress_iface</code></dt>
1092 <dd>Egress interface for tunnels. Currently only relevant for GRE
1093 and CAPWAP tunnels. On Linux systems, this column will show
1094 the name of the interface which is responsible for routing
1095 traffic destined for the configured <code>remote_ip</code>.
1096 This could be an internal interface such as a bridge port.</dd>
1099 <dt><code>tunnel_egress_iface_carrier</code></dt>
1100 <dd>Whether a carrier is detected on <ref
1101 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1102 and <code>up</code>.</dd>
1107 <group title="Ingress Policing">
1109 These settings control ingress policing for packets received on this
1110 interface. On a physical interface, this limits the rate at which
1111 traffic is allowed into the system from the outside; on a virtual
1112 interface (one connected to a virtual machine), this limits the rate at
1113 which the VM is able to transmit.
1116 Policing is a simple form of quality-of-service that simply drops
1117 packets received in excess of the configured rate. Due to its
1118 simplicity, policing is usually less accurate and less effective than
1119 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1120 table="Queue"/> tables).
1123 Policing is currently implemented only on Linux. The Linux
1124 implementation uses a simple ``token bucket'' approach:
1128 The size of the bucket corresponds to <ref
1129 column="ingress_policing_burst"/>. Initially the bucket is full.
1132 Whenever a packet is received, its size (converted to tokens) is
1133 compared to the number of tokens currently in the bucket. If the
1134 required number of tokens are available, they are removed and the
1135 packet is forwarded. Otherwise, the packet is dropped.
1138 Whenever it is not full, the bucket is refilled with tokens at the
1139 rate specified by <ref column="ingress_policing_rate"/>.
1143 Policing interacts badly with some network protocols, and especially
1144 with fragmented IP packets. Suppose that there is enough network
1145 activity to keep the bucket nearly empty all the time. Then this token
1146 bucket algorithm will forward a single packet every so often, with the
1147 period depending on packet size and on the configured rate. All of the
1148 fragments of an IP packets are normally transmitted back-to-back, as a
1149 group. In such a situation, therefore, only one of these fragments
1150 will be forwarded and the rest will be dropped. IP does not provide
1151 any way for the intended recipient to ask for only the remaining
1152 fragments. In such a case there are two likely possibilities for what
1153 will happen next: either all of the fragments will eventually be
1154 retransmitted (as TCP will do), in which case the same problem will
1155 recur, or the sender will not realize that its packet has been dropped
1156 and data will simply be lost (as some UDP-based protocols will do).
1157 Either way, it is possible that no forward progress will ever occur.
1159 <column name="ingress_policing_rate">
1161 Maximum rate for data received on this interface, in kbps. Data
1162 received faster than this rate is dropped. Set to <code>0</code>
1163 (the default) to disable policing.
1167 <column name="ingress_policing_burst">
1168 <p>Maximum burst size for data received on this interface, in kb. The
1169 default burst size if set to <code>0</code> is 1000 kb. This value
1170 has no effect if <ref column="ingress_policing_rate"/>
1171 is <code>0</code>.</p>
1173 Specifying a larger burst size lets the algorithm be more forgiving,
1174 which is important for protocols like TCP that react severely to
1175 dropped packets. The burst size should be at least the size of the
1176 interface's MTU. Specifying a value that is numerically at least as
1177 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1178 closer to achieving the full rate.
1183 <group title="Other Features">
1185 <column name="monitor">
1186 Connectivity monitor configuration for this interface.
1189 <column name="external_ids">
1190 Key-value pairs for use by external frameworks that integrate
1191 with Open vSwitch, rather than by Open vSwitch itself. System
1192 integrators should either use the Open vSwitch development
1193 mailing list to coordinate on common key-value definitions, or
1194 choose key names that are likely to be unique. The currently
1195 defined common key-value pairs are:
1197 <dt><code>attached-mac</code></dt>
1199 The MAC address programmed into the ``virtual hardware'' for this
1200 interface, in the form
1201 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1202 For Citrix XenServer, this is the value of the <code>MAC</code>
1203 field in the VIF record for this interface.</dd>
1204 <dt><code>iface-id</code></dt>
1205 <dd>A system-unique identifier for the interface. On XenServer,
1206 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1209 Additionally the following key-value pairs specifically
1210 apply to an interface that represents a virtual Ethernet interface
1211 connected to a virtual machine. These key-value pairs should not be
1212 present for other types of interfaces. Keys whose names end
1213 in <code>-uuid</code> have values that uniquely identify the entity
1214 in question. For a Citrix XenServer hypervisor, these values are
1215 UUIDs in RFC 4122 format. Other hypervisors may use other
1218 <p>The currently defined key-value pairs for XenServer are:</p>
1220 <dt><code>xs-vif-uuid</code></dt>
1221 <dd>The virtual interface associated with this interface.</dd>
1222 <dt><code>xs-network-uuid</code></dt>
1223 <dd>The virtual network to which this interface is attached.</dd>
1224 <dt><code>xs-vm-uuid</code></dt>
1225 <dd>The VM to which this interface belongs.</dd>
1229 <column name="other_config">
1230 Key-value pairs for rarely used interface features.
1232 <dt><code>lacp-port-priority</code></dt>
1233 <dd> The LACP port priority of this <ref table="Interface"/>. In
1234 LACP negotiations <ref table="Interface"/>s with numerically lower
1235 priorities are preferred for aggregation. Must be a number between
1240 <column name="statistics">
1242 Key-value pairs that report interface statistics. The current
1243 implementation updates these counters periodically. In the future,
1244 we plan to, instead, update them when an interface is created, when
1245 they are queried (e.g. using an OVSDB <code>select</code> operation),
1246 and just before an interface is deleted due to virtual interface
1247 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1248 regular periodic basis.</p>
1250 The currently defined key-value pairs are listed below. These are
1251 the same statistics reported by OpenFlow in its <code>struct
1252 ofp_port_stats</code> structure. If an interface does not support a
1253 given statistic, then that pair is omitted.</p>
1256 Successful transmit and receive counters:
1258 <dt><code>rx_packets</code></dt>
1259 <dd>Number of received packets.</dd>
1260 <dt><code>rx_bytes</code></dt>
1261 <dd>Number of received bytes.</dd>
1262 <dt><code>tx_packets</code></dt>
1263 <dd>Number of transmitted packets.</dd>
1264 <dt><code>tx_bytes</code></dt>
1265 <dd>Number of transmitted bytes.</dd>
1271 <dt><code>rx_dropped</code></dt>
1272 <dd>Number of packets dropped by RX.</dd>
1273 <dt><code>rx_frame_err</code></dt>
1274 <dd>Number of frame alignment errors.</dd>
1275 <dt><code>rx_over_err</code></dt>
1276 <dd>Number of packets with RX overrun.</dd>
1277 <dt><code>rx_crc_err</code></dt>
1278 <dd>Number of CRC errors.</dd>
1279 <dt><code>rx_errors</code></dt>
1281 Total number of receive errors, greater than or equal
1282 to the sum of the above.
1289 <dt><code>tx_dropped</code></dt>
1290 <dd>Number of packets dropped by TX.</dd>
1291 <dt><code>collisions</code></dt>
1292 <dd>Number of collisions.</dd>
1293 <dt><code>tx_errors</code></dt>
1295 Total number of transmit errors, greater
1296 than or equal to the sum of the above.
1305 <table name="QoS" title="Quality of Service configuration">
1306 <p>Quality of Service (QoS) configuration for each Port that
1309 <column name="type">
1310 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1311 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1312 identifies the types that a switch actually supports. The currently
1313 defined types are listed below:</p>
1315 <dt><code>linux-htb</code></dt>
1317 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1318 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1319 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1320 for information on how this classifier works and how to configure it.
1324 <dt><code>linux-hfsc</code></dt>
1326 Linux "Hierarchical Fair Service Curve" classifier.
1327 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1328 information on how this classifier works.
1333 <column name="queues">
1334 <p>A map from queue numbers to <ref table="Queue"/> records. The
1335 supported range of queue numbers depend on <ref column="type"/>. The
1336 queue numbers are the same as the <code>queue_id</code> used in
1337 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1338 structures. Queue 0 is used by OpenFlow output actions that do not
1339 specify a specific queue.</p>
1342 <column name="other_config">
1343 <p>Key-value pairs for configuring QoS features that depend on
1344 <ref column="type"/>.</p>
1345 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1346 the following key-value pairs:</p>
1348 <dt><code>max-rate</code></dt>
1349 <dd>Maximum rate shared by all queued traffic, in bit/s.
1350 Optional. If not specified, for physical interfaces, the
1351 default is the link rate. For other interfaces or if the
1352 link rate cannot be determined, the default is currently 100
1357 <column name="external_ids">
1358 Key-value pairs for use by external frameworks that integrate with Open
1359 vSwitch, rather than by Open vSwitch itself. System integrators should
1360 either use the Open vSwitch development mailing list to coordinate on
1361 common key-value definitions, or choose key names that are likely to be
1362 unique. No common key-value pairs are currently defined.
1366 <table name="Queue" title="QoS output queue.">
1367 <p>A configuration for a port output queue, used in configuring Quality of
1368 Service (QoS) features. May be referenced by <ref column="queues"
1369 table="QoS"/> column in <ref table="QoS"/> table.</p>
1371 <column name="other_config">
1372 <p>Key-value pairs for configuring the output queue. The supported
1373 key-value pairs and their meanings depend on the <ref column="type"/>
1374 of the <ref column="QoS"/> records that reference this row.</p>
1375 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1376 column="type"/> of <code>min-rate</code> are:</p>
1378 <dt><code>min-rate</code></dt>
1379 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1380 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1382 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1383 column="type"/> of <code>linux-htb</code> are:</p>
1385 <dt><code>min-rate</code></dt>
1386 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1387 <dt><code>max-rate</code></dt>
1388 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1389 queue's rate will not be allowed to exceed the specified value, even
1390 if excess bandwidth is available. If unspecified, defaults to no
1392 <dt><code>burst</code></dt>
1393 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1394 that a queue can accumulate while it is idle. Optional. Details of
1395 the <code>linux-htb</code> implementation require a minimum burst
1396 size, so a too-small <code>burst</code> will be silently
1398 <dt><code>priority</code></dt>
1399 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1400 unspecified. A queue with a smaller <code>priority</code>
1401 will receive all the excess bandwidth that it can use before
1402 a queue with a larger value receives any. Specific priority
1403 values are unimportant; only relative ordering matters.</dd>
1405 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1406 column="type"/> of <code>linux-hfsc</code> are:</p>
1408 <dt><code>min-rate</code></dt>
1409 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1410 <dt><code>max-rate</code></dt>
1411 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1412 queue's rate will not be allowed to exceed the specified value, even
1413 if excess bandwidth is available. If unspecified, defaults to no
1418 <column name="external_ids">
1419 Key-value pairs for use by external frameworks that integrate with Open
1420 vSwitch, rather than by Open vSwitch itself. System integrators should
1421 either use the Open vSwitch development mailing list to coordinate on
1422 common key-value definitions, or choose key names that are likely to be
1423 unique. No common key-value pairs are currently defined.
1427 <table name="Monitor" title="Connectivity Monitor configuration">
1429 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1430 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1431 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1432 to detect connectivity problems with each other. MPs within a MA should
1433 have complete and exclusive interconnectivity. This is verified by
1434 occasionally broadcasting Continuity Check Messages (CCMs) at a
1435 configurable transmission interval. A <ref table="Monitor"/> is
1436 responsible for collecting data about other MPs in its MA and
1440 <group title="Monitor Configuration">
1441 <column name="mpid">
1442 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1443 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1444 used to identify this <ref table="Monitor"/> to other endpoints in the
1448 <column name="remote_mps">
1449 A set of <ref table="Maintenance_Points"/> which this
1450 <ref table="Monitor"/> should have connectivity to. If this
1451 <ref table="Monitor"/> does not have connectivity to any MPs in this
1452 set, or has connectivity to any MPs not in this set, a fault is
1456 <column name="ma_name">
1457 A Maintenance Association (MA) name pairs with a Maintenance Domain
1458 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1459 have complete and exclusive interconnectivity. Defaults to
1460 <code>ovs</code> if unset.
1463 <column name="md_name">
1464 A Maintenance Domain name pairs with a Maintenance Association name to
1465 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1468 <column name="interval">
1469 The transmission interval of CCMs in milliseconds. Three missed CCMs
1470 indicate a connectivity fault. Defaults to 1000ms.
1474 <group title="Monitor Status">
1475 <column name="unexpected_remote_mpids">
1476 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1477 has detected connectivity that are not in the
1478 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1479 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1480 Thus, if this set is non-empty a fault is indicated.
1483 <column name="unexpected_remote_maids">
1484 A set of MAIDs representing foreign Maintenance Associations (MAs)
1485 which this <ref table="Monitor"/> has detected connectivity to. A
1486 <ref table="Monitor"/> should not have connectivity to a Maintenance
1487 Association other than its own. Thus, if this set is non-empty a fault
1491 <column name="fault">
1492 Indicates a Connectivity Fault caused by a configuration error, a down
1493 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1498 <table name="Maintenance_Point" title="Maintenance Point configuration">
1500 A <ref table="Maintenance_Point"/> represents a MP which a
1501 <ref table="Monitor"/> has or should have connectivity to.
1504 <group title="Maintenance_Point Configuration">
1505 <column name="mpid">
1506 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1507 a Maintenance Association. All MPs within a MA should have a unique
1512 <group title="Maintenance_Point Status">
1513 <column name="fault">
1514 Indicates a connectivity fault.
1519 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1520 <p>A port mirror within a <ref table="Bridge"/>.</p>
1521 <p>A port mirror configures a bridge to send selected frames to special
1522 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1523 traffic may also be referred to as SPAN or RSPAN, depending on the
1524 mechanism used for delivery.</p>
1526 <column name="name">
1527 Arbitrary identifier for the <ref table="Mirror"/>.
1530 <group title="Selecting Packets for Mirroring">
1531 <column name="select_all">
1532 If true, every packet arriving or departing on any port is
1533 selected for mirroring.
1536 <column name="select_dst_port">
1537 Ports on which departing packets are selected for mirroring.
1540 <column name="select_src_port">
1541 Ports on which arriving packets are selected for mirroring.
1544 <column name="select_vlan">
1545 VLANs on which packets are selected for mirroring. An empty set
1546 selects packets on all VLANs.
1550 <group title="Mirroring Destination Configuration">
1551 <column name="output_port">
1552 <p>Output port for selected packets, if nonempty. Mutually exclusive
1553 with <ref column="output_vlan"/>.</p>
1554 <p>Specifying a port for mirror output reserves that port exclusively
1555 for mirroring. No frames other than those selected for mirroring
1556 will be forwarded to the port, and any frames received on the port
1557 will be discarded.</p>
1558 <p>This type of mirroring is sometimes called SPAN.</p>
1561 <column name="output_vlan">
1562 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1563 with <ref column="output_port"/>.</p>
1564 <p>The frames will be sent out all ports that trunk
1565 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1566 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1567 trunk port, the frame's VLAN tag will be set to
1568 <ref column="output_vlan"/>, replacing any existing tag; when it is
1569 sent out an implicit VLAN port, the frame will not be tagged. This
1570 type of mirroring is sometimes called RSPAN.</p>
1571 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1572 contains unmanaged switches. Consider an unmanaged physical switch
1573 with two ports: port 1, connected to an end host, and port 2,
1574 connected to an Open vSwitch configured to mirror received packets
1575 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1576 port 1 that the physical switch forwards to port 2. The Open vSwitch
1577 forwards this packet to its destination and then reflects it back on
1578 port 2 in VLAN 123. This reflected packet causes the unmanaged
1579 physical switch to replace the MAC learning table entry, which
1580 correctly pointed to port 1, with one that incorrectly points to port
1581 2. Afterward, the physical switch will direct packets destined for
1582 the end host to the Open vSwitch on port 2, instead of to the end
1583 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1584 desired in this scenario, then the physical switch must be replaced
1585 by one that learns Ethernet addresses on a per-VLAN basis. In
1586 addition, learning should be disabled on the VLAN containing mirrored
1587 traffic. If this is not done then intermediate switches will learn
1588 the MAC address of each end host from the mirrored traffic. If
1589 packets being sent to that end host are also mirrored, then they will
1590 be dropped since the switch will attempt to send them out the input
1591 port. Disabling learning for the VLAN will cause the switch to
1592 correctly send the packet out all ports configured for that VLAN. If
1593 Open vSwitch is being used as an intermediate switch, learning can be
1594 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1595 in the appropriate <ref table="Bridge"/> table or tables.</p>
1599 <group title="Other Features">
1600 <column name="external_ids">
1601 Key-value pairs for use by external frameworks that integrate with Open
1602 vSwitch, rather than by Open vSwitch itself. System integrators should
1603 either use the Open vSwitch development mailing list to coordinate on
1604 common key-value definitions, or choose key names that are likely to be
1605 unique. No common key-value pairs are currently defined.
1610 <table name="Controller" title="OpenFlow controller configuration.">
1611 <p>An OpenFlow controller.</p>
1614 Open vSwitch supports two kinds of OpenFlow controllers:
1618 <dt>Primary controllers</dt>
1621 This is the kind of controller envisioned by the OpenFlow 1.0
1622 specification. Usually, a primary controller implements a network
1623 policy by taking charge of the switch's flow table.
1627 Open vSwitch initiates and maintains persistent connections to
1628 primary controllers, retrying the connection each time it fails or
1629 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1630 <ref table="Bridge"/> table applies to primary controllers.
1634 Open vSwitch permits a bridge to have any number of primary
1635 controllers. When multiple controllers are configured, Open
1636 vSwitch connects to all of them simultaneously. Because
1637 OpenFlow 1.0 does not specify how multiple controllers
1638 coordinate in interacting with a single switch, more than
1639 one primary controller should be specified only if the
1640 controllers are themselves designed to coordinate with each
1641 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1642 vendor extension may be useful for this.)
1645 <dt>Service controllers</dt>
1648 These kinds of OpenFlow controller connections are intended for
1649 occasional support and maintenance use, e.g. with
1650 <code>ovs-ofctl</code>. Usually a service controller connects only
1651 briefly to inspect or modify some of a switch's state.
1655 Open vSwitch listens for incoming connections from service
1656 controllers. The service controllers initiate and, if necessary,
1657 maintain the connections from their end. The <ref table="Bridge"
1658 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1659 not apply to service controllers.
1663 Open vSwitch supports configuring any number of service controllers.
1669 The <ref column="target"/> determines the type of controller.
1672 <group title="Core Features">
1673 <column name="target">
1674 <p>Connection method for controller.</p>
1676 The following connection methods are currently supported for primary
1680 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1682 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1683 the given <var>ip</var>, which must be expressed as an IP address
1684 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1685 column in the <ref table="Open_vSwitch"/> table must point to a
1686 valid SSL configuration when this form is used.</p>
1687 <p>SSL support is an optional feature that is not always built as
1688 part of Open vSwitch.</p>
1690 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1691 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1692 the given <var>ip</var>, which must be expressed as an IP address
1693 (not a DNS name).</dd>
1696 The following connection methods are currently supported for service
1700 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1703 Listens for SSL connections on the specified TCP <var>port</var>
1704 (default: 6633). If <var>ip</var>, which must be expressed as an
1705 IP address (not a DNS name), is specified, then connections are
1706 restricted to the specified local IP address.
1709 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1710 table="Open_vSwitch"/> table must point to a valid SSL
1711 configuration when this form is used.
1713 <p>SSL support is an optional feature that is not always built as
1714 part of Open vSwitch.</p>
1716 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1718 Listens for connections on the specified TCP <var>port</var>
1719 (default: 6633). If <var>ip</var>, which must be expressed as an
1720 IP address (not a DNS name), is specified, then connections are
1721 restricted to the specified local IP address.
1724 <p>When multiple controllers are configured for a single bridge, the
1725 <ref column="target"/> values must be unique. Duplicate
1726 <ref column="target"/> values yield unspecified results.</p>
1729 <column name="connection_mode">
1730 <p>If it is specified, this setting must be one of the following
1731 strings that describes how Open vSwitch contacts this OpenFlow
1732 controller over the network:</p>
1735 <dt><code>in-band</code></dt>
1736 <dd>In this mode, this controller's OpenFlow traffic travels over the
1737 bridge associated with the controller. With this setting, Open
1738 vSwitch allows traffic to and from the controller regardless of the
1739 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1740 would never be able to connect to the controller, because it did
1741 not have a flow to enable it.) This is the most common connection
1742 mode because it is not necessary to maintain two independent
1744 <dt><code>out-of-band</code></dt>
1745 <dd>In this mode, OpenFlow traffic uses a control network separate
1746 from the bridge associated with this controller, that is, the
1747 bridge does not use any of its own network devices to communicate
1748 with the controller. The control network must be configured
1749 separately, before or after <code>ovs-vswitchd</code> is started.
1753 <p>If not specified, the default is implementation-specific.</p>
1757 <group title="Controller Failure Detection and Handling">
1758 <column name="max_backoff">
1759 Maximum number of milliseconds to wait between connection attempts.
1760 Default is implementation-specific.
1763 <column name="inactivity_probe">
1764 Maximum number of milliseconds of idle time on connection to
1765 controller before sending an inactivity probe message. If Open
1766 vSwitch does not communicate with the controller for the specified
1767 number of seconds, it will send a probe. If a response is not
1768 received for the same additional amount of time, Open vSwitch
1769 assumes the connection has been broken and attempts to reconnect.
1770 Default is implementation-specific.
1774 <group title="OpenFlow Rate Limiting">
1775 <column name="controller_rate_limit">
1776 <p>The maximum rate at which packets in unknown flows will be
1777 forwarded to the OpenFlow controller, in packets per second. This
1778 feature prevents a single bridge from overwhelming the controller.
1779 If not specified, the default is implementation-specific.</p>
1780 <p>In addition, when a high rate triggers rate-limiting, Open
1781 vSwitch queues controller packets for each port and transmits
1782 them to the controller at the configured rate. The number of
1783 queued packets is limited by
1784 the <ref column="controller_burst_limit"/> value. The packet
1785 queue is shared fairly among the ports on a bridge.</p><p>Open
1786 vSwitch maintains two such packet rate-limiters per bridge.
1787 One of these applies to packets sent up to the controller
1788 because they do not correspond to any flow. The other applies
1789 to packets sent up to the controller by request through flow
1790 actions. When both rate-limiters are filled with packets, the
1791 actual rate that packets are sent to the controller is up to
1792 twice the specified rate.</p>
1795 <column name="controller_burst_limit">
1796 In conjunction with <ref column="controller_rate_limit"/>,
1797 the maximum number of unused packet credits that the bridge will
1798 allow to accumulate, in packets. If not specified, the default
1799 is implementation-specific.
1803 <group title="Additional In-Band Configuration">
1804 <p>These values are considered only in in-band control mode (see
1805 <ref column="connection_mode"/>).</p>
1807 <p>When multiple controllers are configured on a single bridge, there
1808 should be only one set of unique values in these columns. If different
1809 values are set for these columns in different controllers, the effect
1812 <column name="local_ip">
1813 The IP address to configure on the local port,
1814 e.g. <code>192.168.0.123</code>. If this value is unset, then
1815 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1819 <column name="local_netmask">
1820 The IP netmask to configure on the local port,
1821 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1822 but this value is unset, then the default is chosen based on whether
1823 the IP address is class A, B, or C.
1826 <column name="local_gateway">
1827 The IP address of the gateway to configure on the local port, as a
1828 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1829 this network has no gateway.
1833 <group title="Other Features">
1834 <column name="external_ids">
1835 Key-value pairs for use by external frameworks that integrate with Open
1836 vSwitch, rather than by Open vSwitch itself. System integrators should
1837 either use the Open vSwitch development mailing list to coordinate on
1838 common key-value definitions, or choose key names that are likely to be
1839 unique. No common key-value pairs are currently defined.
1843 <group title="Controller Status">
1844 <column name="is_connected">
1845 <code>true</code> if currently connected to this controller,
1846 <code>false</code> otherwise.
1849 <column name="role">
1850 <p>The level of authority this controller has on the associated
1851 bridge. Possible values are:</p>
1853 <dt><code>other</code></dt>
1854 <dd>Allows the controller access to all OpenFlow features.</dd>
1855 <dt><code>master</code></dt>
1856 <dd>Equivalent to <code>other</code>, except that there may be at
1857 most one master controller at a time. When a controller configures
1858 itself as <code>master</code>, any existing master is demoted to
1859 the <code>slave</code>role.</dd>
1860 <dt><code>slave</code></dt>
1861 <dd>Allows the controller read-only access to OpenFlow features.
1862 Attempts to modify the flow table will be rejected with an
1863 error. Slave controllers do not receive OFPT_PACKET_IN or
1864 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1869 <column name="status">
1870 <p>Key-value pairs that report controller status.</p>
1872 <dt><code>last_error</code></dt>
1873 <dd>A human-readable description of the last error on the connection
1874 to the controller; i.e. <code>strerror(errno)</code>. This key
1875 will exist only if an error has occurred.</dd>
1876 <dt><code>state</code></dt>
1877 <dd>The state of the connection to the controller. Possible values
1878 are: <code>VOID</code> (connection is disabled),
1879 <code>BACKOFF</code> (attempting to reconnect at an increasing
1880 period), <code>CONNECTING</code> (attempting to connect),
1881 <code>ACTIVE</code> (connected, remote host responsive), and
1882 <code>IDLE</code> (remote host idle, sending keep-alive). These
1883 values may change in the future. They are provided only for human
1885 <dt><code>sec_since_connect</code></dt>
1886 <dd>The amount of time since this controller last successfully
1887 connected to the switch (in seconds). Value is empty if controller
1888 has never successfully connected.</dd>
1889 <dt><code>sec_since_disconnect</code></dt>
1890 <dd>The amount of time since this controller last disconnected from
1891 the switch (in seconds). Value is empty if controller has never
1898 <table name="Manager" title="OVSDB management connection.">
1900 Configuration for a database connection to an Open vSwitch database
1905 This table primarily configures the Open vSwitch database
1906 (<code>ovsdb-server</code>), not the Open vSwitch switch
1907 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1908 what connections should be treated as in-band.
1912 The Open vSwitch database server can initiate and maintain active
1913 connections to remote clients. It can also listen for database
1917 <group title="Core Features">
1918 <column name="target">
1919 <p>Connection method for managers.</p>
1921 The following connection methods are currently supported:
1924 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1927 The specified SSL <var>port</var> (default: 6632) on the host at
1928 the given <var>ip</var>, which must be expressed as an IP address
1929 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1930 column in the <ref table="Open_vSwitch"/> table must point to a
1931 valid SSL configuration when this form is used.
1934 SSL support is an optional feature that is not always built as
1935 part of Open vSwitch.
1939 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1941 The specified TCP <var>port</var> (default: 6632) on the host at
1942 the given <var>ip</var>, which must be expressed as an IP address
1945 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1948 Listens for SSL connections on the specified TCP <var>port</var>
1949 (default: 6632). If <var>ip</var>, which must be expressed as an
1950 IP address (not a DNS name), is specified, then connections are
1951 restricted to the specified local IP address.
1954 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1955 table="Open_vSwitch"/> table must point to a valid SSL
1956 configuration when this form is used.
1959 SSL support is an optional feature that is not always built as
1960 part of Open vSwitch.
1963 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1965 Listens for connections on the specified TCP <var>port</var>
1966 (default: 6632). If <var>ip</var>, which must be expressed as an
1967 IP address (not a DNS name), is specified, then connections are
1968 restricted to the specified local IP address.
1971 <p>When multiple managers are configured, the <ref column="target"/>
1972 values must be unique. Duplicate <ref column="target"/> values yield
1973 unspecified results.</p>
1976 <column name="connection_mode">
1978 If it is specified, this setting must be one of the following strings
1979 that describes how Open vSwitch contacts this OVSDB client over the
1984 <dt><code>in-band</code></dt>
1986 In this mode, this connection's traffic travels over a bridge
1987 managed by Open vSwitch. With this setting, Open vSwitch allows
1988 traffic to and from the client regardless of the contents of the
1989 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
1990 to connect to the client, because it did not have a flow to enable
1991 it.) This is the most common connection mode because it is not
1992 necessary to maintain two independent networks.
1994 <dt><code>out-of-band</code></dt>
1996 In this mode, the client's traffic uses a control network separate
1997 from that managed by Open vSwitch, that is, Open vSwitch does not
1998 use any of its own network devices to communicate with the client.
1999 The control network must be configured separately, before or after
2000 <code>ovs-vswitchd</code> is started.
2005 If not specified, the default is implementation-specific.
2010 <group title="Client Failure Detection and Handling">
2011 <column name="max_backoff">
2012 Maximum number of milliseconds to wait between connection attempts.
2013 Default is implementation-specific.
2016 <column name="inactivity_probe">
2017 Maximum number of milliseconds of idle time on connection to the client
2018 before sending an inactivity probe message. If Open vSwitch does not
2019 communicate with the client for the specified number of seconds, it
2020 will send a probe. If a response is not received for the same
2021 additional amount of time, Open vSwitch assumes the connection has been
2022 broken and attempts to reconnect. Default is implementation-specific.
2026 <group title="Other Features">
2027 <column name="external_ids">
2028 Key-value pairs for use by external frameworks that integrate with Open
2029 vSwitch, rather than by Open vSwitch itself. System integrators should
2030 either use the Open vSwitch development mailing list to coordinate on
2031 common key-value definitions, or choose key names that are likely to be
2032 unique. No common key-value pairs are currently defined.
2036 <group title="Status">
2037 <column name="is_connected">
2038 <code>true</code> if currently connected to this manager,
2039 <code>false</code> otherwise.
2042 <column name="status">
2043 <p>Key-value pairs that report manager status.</p>
2045 <dt><code>last_error</code></dt>
2046 <dd>A human-readable description of the last error on the connection
2047 to the manager; i.e. <code>strerror(errno)</code>. This key
2048 will exist only if an error has occurred.</dd>
2051 <dt><code>state</code></dt>
2052 <dd>The state of the connection to the manager. Possible values
2053 are: <code>VOID</code> (connection is disabled),
2054 <code>BACKOFF</code> (attempting to reconnect at an increasing
2055 period), <code>CONNECTING</code> (attempting to connect),
2056 <code>ACTIVE</code> (connected, remote host responsive), and
2057 <code>IDLE</code> (remote host idle, sending keep-alive). These
2058 values may change in the future. They are provided only for human
2062 <dt><code>sec_since_connect</code></dt>
2063 <dd>The amount of time since this manager last successfully connected
2064 to the database (in seconds). Value is empty if manager has never
2065 successfully connected.</dd>
2068 <dt><code>sec_since_disconnect</code></dt>
2069 <dd>The amount of time since this manager last disconnected from the
2070 database (in seconds). Value is empty if manager has never
2077 <table name="NetFlow">
2078 A NetFlow target. NetFlow is a protocol that exports a number of
2079 details about terminating IP flows, such as the principals involved
2082 <column name="targets">
2083 NetFlow targets in the form
2084 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2085 must be specified numerically, not as a DNS name.
2088 <column name="engine_id">
2089 Engine ID to use in NetFlow messages. Defaults to datapath index
2093 <column name="engine_type">
2094 Engine type to use in NetFlow messages. Defaults to datapath
2095 index if not specified.
2098 <column name="active_timeout">
2099 The interval at which NetFlow records are sent for flows that are
2100 still active, in seconds. A value of <code>0</code> requests the
2101 default timeout (currently 600 seconds); a value of <code>-1</code>
2102 disables active timeouts.
2105 <column name="add_id_to_interface">
2106 <p>If this column's value is <code>false</code>, the ingress and egress
2107 interface fields of NetFlow flow records are derived from OpenFlow port
2108 numbers. When it is <code>true</code>, the 7 most significant bits of
2109 these fields will be replaced by the least significant 7 bits of the
2110 engine id. This is useful because many NetFlow collectors do not
2111 expect multiple switches to be sending messages from the same host, so
2112 they do not store the engine information which could be used to
2113 disambiguate the traffic.</p>
2114 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2117 <column name="external_ids">
2118 Key-value pairs for use by external frameworks that integrate with Open
2119 vSwitch, rather than by Open vSwitch itself. System integrators should
2120 either use the Open vSwitch development mailing list to coordinate on
2121 common key-value definitions, or choose key names that are likely to be
2122 unique. No common key-value pairs are currently defined.
2127 SSL configuration for an Open_vSwitch.
2129 <column name="private_key">
2130 Name of a PEM file containing the private key used as the switch's
2131 identity for SSL connections to the controller.
2134 <column name="certificate">
2135 Name of a PEM file containing a certificate, signed by the
2136 certificate authority (CA) used by the controller and manager,
2137 that certifies the switch's private key, identifying a trustworthy
2141 <column name="ca_cert">
2142 Name of a PEM file containing the CA certificate used to verify
2143 that the switch is connected to a trustworthy controller.
2146 <column name="bootstrap_ca_cert">
2147 If set to <code>true</code>, then Open vSwitch will attempt to
2148 obtain the CA certificate from the controller on its first SSL
2149 connection and save it to the named PEM file. If it is successful,
2150 it will immediately drop the connection and reconnect, and from then
2151 on all SSL connections must be authenticated by a certificate signed
2152 by the CA certificate thus obtained. <em>This option exposes the
2153 SSL connection to a man-in-the-middle attack obtaining the initial
2154 CA certificate.</em> It may still be useful for bootstrapping.
2157 <column name="external_ids">
2158 Key-value pairs for use by external frameworks that integrate with Open
2159 vSwitch, rather than by Open vSwitch itself. System integrators should
2160 either use the Open vSwitch development mailing list to coordinate on
2161 common key-value definitions, or choose key names that are likely to be
2162 unique. No common key-value pairs are currently defined.
2166 <table name="sFlow">
2167 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2170 <column name="agent">
2171 Name of the network device whose IP address should be reported as the
2172 ``agent address'' to collectors. If not specified, the IP address
2173 defaults to the <ref table="Controller" column="local_ip"/> in the
2174 collector's <ref table="Controller"/>. If an agent IP address cannot be
2175 determined either way, sFlow is disabled.
2178 <column name="header">
2179 Number of bytes of a sampled packet to send to the collector.
2180 If not specified, the default is 128 bytes.
2183 <column name="polling">
2184 Polling rate in seconds to send port statistics to the collector.
2185 If not specified, defaults to 30 seconds.
2188 <column name="sampling">
2189 Rate at which packets should be sampled and sent to the collector.
2190 If not specified, defaults to 400, which means one out of 400
2191 packets, on average, will be sent to the collector.
2194 <column name="targets">
2195 sFlow targets in the form
2196 <code><var>ip</var>:<var>port</var></code>.
2199 <column name="external_ids">
2200 Key-value pairs for use by external frameworks that integrate with Open
2201 vSwitch, rather than by Open vSwitch itself. System integrators should
2202 either use the Open vSwitch development mailing list to coordinate on
2203 common key-value definitions, or choose key names that are likely to be
2204 unique. No common key-value pairs are currently defined.
2208 <table name="Capability">
2209 <p>Records in this table describe functionality supported by the hardware
2210 and software platform on which this Open vSwitch is based. Clients
2211 should not modify this table.</p>
2213 <p>A record in this table is meaningful only if it is referenced by the
2214 <ref table="Open_vSwitch" column="capabilities"/> column in the
2215 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2216 the record's ``category,'' determines the meanings of the
2217 <ref column="details"/> column. The following general forms of
2218 categories are currently defined:</p>
2221 <dt><code>qos-<var>type</var></code></dt>
2222 <dd><var>type</var> is supported as the value for
2223 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2227 <column name="details">
2228 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2229 depends on the category key that the <ref table="Open_vSwitch"
2230 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2231 uses to reference this record, as described above.</p>
2233 <p>The presence of a record for category <code>qos-<var>type</var></code>
2234 indicates that the switch supports <var>type</var> as the value of
2235 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2236 table. The following key-value pairs are defined to further describe
2237 QoS capabilities:</p>
2240 <dt><code>n-queues</code></dt>
2241 <dd>Number of supported queues, as a positive integer. Keys in the
2242 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2243 records whose <ref table="QoS" column="type"/> value
2244 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob