1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
3 <p>A database with this schema holds the configuration for one Open
4 vSwitch daemon. The root of the configuration for the daemon is
5 the <ref table="Open_vSwitch"/> table, which must have exactly one
6 record. Records in other tables are significant only when they
7 can be reached directly or indirectly from the
8 <ref table="Open_vSwitch"/> table.</p>
10 <table name="Open_vSwitch" title="Open vSwitch configuration.">
11 Configuration for an Open vSwitch daemon. There must be exactly one record
12 in the <ref table="Open_vSwitch"/> table.
14 <group title="Configuration">
15 <column name="bridges">
16 Set of bridges managed by the daemon.
20 SSL used globally by the daemon.
23 <column name="external_ids">
24 Key-value pairs for use by external frameworks that integrate
25 with Open vSwitch, rather than by Open vSwitch itself. System
26 integrators should either use the Open vSwitch development
27 mailing list to coordinate on common key-value definitions, or
28 choose key names that are likely to be unique. The currently
29 defined common key-value pairs are:
31 <dt><code>system-id</code></dt>
32 <dd>A unique identifier for the Open vSwitch's physical host.
33 The form of the identifier depends on the type of the host.
34 On a Citrix XenServer, this will likely be the same as
35 <code>xs-system-uuid</code>.</dd>
36 <dt><code>xs-system-uuid</code></dt>
37 <dd>The Citrix XenServer universally unique identifier for the
38 physical host as displayed by <code>xe host-list</code>.</dd>
43 <group title="Status">
44 <column name="next_cfg">
45 Sequence number for client to increment. When a client modifies
46 any part of the database configuration and wishes to wait for
47 Open vSwitch to finish applying the changes, it may increment
51 <column name="cur_cfg">
52 Sequence number that Open vSwitch sets to the current value of
53 <ref column="next_cfg"/> after it finishes applying a set of
54 configuration changes.
57 <column name="capabilities">
58 Describes functionality supported by the hardware and software platform
59 on which this Open vSwitch is based. Clients should not modify this
60 column. See the <ref table="Capability"/> description for defined
61 capability categories and the meaning of associated
62 <ref table="Capability"/> records.
65 <column name="statistics">
67 Key-value pairs that report statistics about a system running an Open
68 vSwitch. These are updated periodically (currently, every 5
69 seconds). Key-value pairs that cannot be determined or that do not
70 apply to a platform are omitted.
74 <dt><code>cpu</code></dt>
77 Number of CPU processors, threads, or cores currently online and
78 available to the operating system on which Open vSwitch is
79 running, as an integer. This may be less than the number
80 installed, if some are not online or if they are not available to
84 Open vSwitch userspace processes are not multithreaded, but the
85 Linux kernel-based datapath is.
89 <dt><code>load_average</code></dt>
92 A comma-separated list of three floating-point numbers,
93 representing the system load average over the last 1, 5, and 15
94 minutes, respectively.
98 <dt><code>memory</code></dt>
101 A comma-separated list of integers, each of which represents a
102 quantity of memory in kilobytes that describes the operating
103 system on which Open vSwitch is running. In respective order,
108 <li>Total amount of RAM allocated to the OS.</li>
109 <li>RAM allocated to the OS that is in use.</li>
110 <li>RAM that can be flushed out to disk or otherwise discarded
111 if that space is needed for another purpose. This number is
112 necessarily less than or equal to the previous value.</li>
113 <li>Total disk space allocated for swap.</li>
114 <li>Swap space currently in use.</li>
118 On Linux, all five values can be determined and are included. On
119 other operating systems, only the first two values can be
120 determined, so the list will only have two values.
124 <dt><code>process_</code><var>name</var></dt>
127 One such key-value pair will exist for each running Open vSwitch
128 daemon process, with <var>name</var> replaced by the daemon's
129 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
130 comma-separated list of integers. The integers represent the
131 following, with memory measured in kilobytes and durations in
136 <li>The process's virtual memory size.</li>
137 <li>The process's resident set size.</li>
138 <li>The amount of user and system CPU time consumed by the
140 <li>The number of times that the process has crashed and been
141 automatically restarted by the monitor.</li>
142 <li>The duration since the process was started.</li>
143 <li>The duration for which the process has been running.</li>
147 The interpretation of some of these values depends on whether the
148 process was started with the <option>--monitor</option>. If it
149 was not, then the crash count will always be 0 and the two
150 durations will always be the same. If <option>--monitor</option>
151 was given, then the crash count may be positive; if it is, the
152 latter duration is the amount of time since the most recent crash
157 There will be one key-value pair for each file in Open vSwitch's
158 ``run directory'' (usually <code>/var/run/openvswitch</code>)
159 whose name ends in <code>.pid</code>, whose contents are a
160 process ID, and which is locked by a running process. The
161 <var>name</var> is taken from the pidfile's name.
165 Currently Open vSwitch is only able to obtain all of the above
166 detail on Linux systems. On other systems, the same key-value
167 pairs will be present but the values will always be the empty
172 <dt><code>file_systems</code></dt>
175 A space-separated list of information on local, writable file
176 systems. Each item in the list describes one file system and
177 consists in turn of a comma-separated list of the following:
181 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
182 Any spaces or commas in the mount point are replaced by
184 <li>Total size, in kilobytes, as an integer.</li>
185 <li>Amount of storage in use, in kilobytes, as an integer.</li>
189 This key-value pair is omitted if there are no local, writable
190 file systems or if Open vSwitch cannot obtain the needed
198 <group title="Version Reporting">
200 These columns report the types and versions of the hardware and
201 software running Open vSwitch. We recommend in general that software
202 should test whether specific features are supported instead of relying
203 on version number checks. These values are primarily intended for
204 reporting to human administrators.
207 <column name="ovs_version">
208 The Open vSwitch version number, e.g. <code>1.1.0pre2</code>.
209 If Open vSwitch was configured with a build number, then it is
210 also included, e.g. <code>1.1.0pre2+build4948</code>.
213 <column name="db_version">
215 The database schema version number in the form
216 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
217 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
218 a non-backward compatible way (e.g. deleting a column or a table),
219 <var>major</var> is incremented. When the database schema is changed
220 in a backward compatible way (e.g. adding a new column),
221 <var>minor</var> is incremented. When the database schema is changed
222 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
227 The schema version is part of the database schema, so it can also be
228 retrieved by fetching the schema using the Open vSwitch database
233 <column name="system_type">
235 An identifier for the type of system on top of which Open vSwitch
236 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
239 System integrators are responsible for choosing and setting an
240 appropriate value for this column.
244 <column name="system_version">
246 The version of the system identified by <ref column="system_type"/>,
247 e.g. <code>5.5.0-24648p</code> on XenServer 5.5.0 build 24648.
250 System integrators are responsible for choosing and setting an
251 appropriate value for this column.
257 <group title="Database Configuration">
259 These columns primarily configure the Open vSwitch database
260 (<code>ovsdb-server</code>), not the Open vSwitch switch
261 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
262 column="ssl"/> settings.
266 The Open vSwitch switch does read the database configuration to
267 determine remote IP addresses to which in-band control should apply.
270 <column name="manager_options">
271 Database clients to which the Open vSwitch database server should
272 connect or to which it should listen, along with options for how these
273 connection should be configured. See the <ref table="Manager"/> table
274 for more information.
277 <column name="managers">
279 Remote database clients to which the Open vSwitch's database server
280 should connect or to which it should listen. Adding an OVSDB target
281 to this set is equivalent to adding it to <ref
282 column="manager_options"/> with all of the default options.
286 Use of this column is deprecated and may be removed sometime in the
287 future. New applications should use and set <ref
288 column="manager_options"/> instead.
294 <table name="Bridge">
296 Configuration for a bridge within an
297 <ref table="Open_vSwitch"/>.
300 A <ref table="Bridge"/> record represents an Ethernet switch with one or
301 more ``ports,'' which are the <ref table="Port"/> records pointed to by
302 the <ref table="Bridge"/>'s <ref column="ports"/> column.
305 <group title="Core Features">
307 Bridge identifier. Should be alphanumeric and no more than about 8
308 bytes long. Must be unique among the names of ports, interfaces, and
312 <column name="ports">
313 Ports included in the bridge.
316 <column name="mirrors">
317 Port mirroring configuration.
320 <column name="netflow">
321 NetFlow configuration.
324 <column name="sflow">
328 <column name="flood_vlans">
329 VLAN IDs of VLANs on which MAC address learning should be disabled, so
330 that packets are flooded instead of being sent to specific ports that
331 are believed to contain packets' destination MACs. This should
332 ordinarily be used to disable MAC learning on VLANs used for mirroring
333 (RSPAN VLANs). It may also be useful for debugging.
337 <group title="OpenFlow Configuration">
338 <column name="controller">
339 OpenFlow controller set. If unset, then no OpenFlow controllers
343 <column name="fail_mode">
344 <p>When a controller is configured, it is, ordinarily, responsible
345 for setting up all flows on the switch. Thus, if the connection to
346 the controller fails, no new network connections can be set up.
347 If the connection to the controller stays down long enough,
348 no packets can pass through the switch at all. This setting
349 determines the switch's response to such a situation. It may be set
350 to one of the following:
352 <dt><code>standalone</code></dt>
353 <dd>If no message is received from the controller for three
354 times the inactivity probe interval
355 (see <ref column="inactivity_probe"/>), then Open vSwitch
356 will take over responsibility for setting up flows. In
357 this mode, Open vSwitch causes the bridge to act like an
358 ordinary MAC-learning switch. Open vSwitch will continue
359 to retry connecting to the controller in the background
360 and, when the connection succeeds, it will discontinue its
361 standalone behavior.</dd>
362 <dt><code>secure</code></dt>
363 <dd>Open vSwitch will not set up flows on its own when the
364 controller connection fails or when no controllers are
365 defined. The bridge will continue to retry connecting to
366 any defined controllers forever.</dd>
369 <p>If this value is unset, the default is implementation-specific.</p>
370 <p>When more than one controller is configured,
371 <ref column="fail_mode"/> is considered only when none of the
372 configured controllers can be contacted.</p>
375 <column name="datapath_id">
376 Reports the OpenFlow datapath ID in use. Exactly 16 hex
377 digits. (Setting this column will have no useful effect. Set
378 <ref column="other_config"/>:<code>other-config</code>
383 <group title="Other Features">
384 <column name="datapath_type">
385 Name of datapath provider. The kernel datapath has
386 type <code>system</code>. The userspace datapath has
387 type <code>netdev</code>.
390 <column name="external_ids">
391 Key-value pairs for use by external frameworks that integrate
392 with Open vSwitch, rather than by Open vSwitch itself. System
393 integrators should either use the Open vSwitch development
394 mailing list to coordinate on common key-value definitions, or
395 choose key names that are likely to be unique. The currently
396 defined key-value pairs are:
398 <dt><code>bridge-id</code></dt>
399 <dd>A unique identifier of the bridge. On Citrix XenServer this
400 will commonly be the same as <code>xs-network-uuids</code>.</dd>
401 <dt><code>xs-network-uuids</code></dt>
402 <dd>Semicolon-delimited set of universally unique identifier(s) for
403 the network with which this bridge is associated on a Citrix
404 XenServer host. The network identifiers are RFC 4122 UUIDs as
405 displayed by, e.g., <code>xe network-list</code>.</dd>
409 <column name="other_config">
410 Key-value pairs for configuring rarely used bridge
411 features. The currently defined key-value pairs are:
413 <dt><code>datapath-id</code></dt>
415 digits to set the OpenFlow datapath ID to a specific
416 value. May not be all-zero.</dd>
417 <dt><code>disable-in-band</code></dt>
418 <dd>If set to <code>true</code>, disable in-band control on
419 the bridge regardless of controller and manager settings.</dd>
420 <dt><code>hwaddr</code></dt>
421 <dd>An Ethernet address in the form
422 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
423 to set the hardware address of the local port and influence the
425 <dt><code>in-band-queue</code></dt>
427 A queue ID as a nonnegative integer. This sets the OpenFlow queue
428 ID that will be used by flows set up by in-band control on this
429 bridge. If unset, or if the port used by an in-band control flow
430 does not have QoS configured, or if the port does not have a queue
431 with the specified ID, the default queue is used instead.
438 <table name="Port" table="Port or bond configuration.">
439 <p>A port within a <ref table="Bridge"/>.</p>
440 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
441 <ref column="interfaces"/> column. Such a port logically
442 corresponds to a port on a physical Ethernet switch. A port
443 with more than one interface is a ``bonded port'' (see
444 <ref group="Bonding Configuration"/>).</p>
445 <p>Some properties that one might think as belonging to a port are actually
446 part of the port's <ref table="Interface"/> members.</p>
449 Port name. Should be alphanumeric and no more than about 8
450 bytes long. May be the same as the interface name, for
451 non-bonded ports. Must otherwise be unique among the names of
452 ports, interfaces, and bridges on a host.
455 <column name="interfaces">
456 The port's interfaces. If there is more than one, this is a
460 <group title="VLAN Configuration">
461 <p>A bridge port must be configured for VLANs in one of two
462 mutually exclusive ways:
464 <li>A ``trunk port'' has an empty value for <ref
465 column="tag"/>. Its <ref column="trunks"/> value may be
466 empty or non-empty.</li>
467 <li>An ``implicitly tagged VLAN port'' or ``access port''
468 has an nonempty value for <ref column="tag"/>. Its
469 <ref column="trunks"/> value must be empty.</li>
471 If <ref column="trunks"/> and <ref column="tag"/> are both
472 nonempty, the configuration is ill-formed.
477 If this is an access port (see above), the port's implicitly
478 tagged VLAN. Must be empty if this is a trunk port.
481 Frames arriving on trunk ports will be forwarded to this
482 port only if they are tagged with the given VLAN (or, if
483 <ref column="tag"/> is 0, then if they lack a VLAN header).
484 Frames arriving on other access ports will be forwarded to
485 this port only if they have the same <ref column="tag"/>
486 value. Frames forwarded to this port will not have an
490 When a frame with a 802.1Q header that indicates a nonzero
491 VLAN is received on an access port, it is discarded.
495 <column name="trunks">
497 If this is a trunk port (see above), the 802.1Q VLAN(s) that
498 this port trunks; if it is empty, then the port trunks all
499 VLANs. Must be empty if this is an access port.
502 Frames arriving on trunk ports are dropped if they are not
503 in one of the specified VLANs. For this purpose, packets
504 that have no VLAN header are treated as part of VLAN 0.
509 <group title="Bonding Configuration">
510 <p>A port that has more than one interface is a ``bonded port.'' Bonding
511 allows for load balancing and fail-over. Some kinds of bonding will
512 work with any kind of upstream switch:</p>
515 <dt><code>balance-slb</code></dt>
517 Balances flows among slaves based on source MAC address and output
518 VLAN, with periodic rebalancing as traffic patterns change.
521 <dt><code>active-backup</code></dt>
523 Assigns all flows to one slave, failing over to a backup slave when
524 the active slave is disabled.
529 The following mode requires the upstream switch to support 802.3ad with
530 successful LACP negotiation. If LACP negotiation fails then
531 <code>balance-slb</code> mode is used as a fallback:
535 <dt><code>balance-tcp</code></dt>
537 Balances flows among slaves based on L2, L3, and L4 protocol
538 information such as destination MAC address, IP address, and TCP
543 <p>These columns apply only to bonded ports. Their values are
544 otherwise ignored.</p>
546 <column name="bond_mode">
547 <p>The type of bonding used for a bonded port. Defaults to
548 <code>balance-slb</code> if unset.
552 <column name="bond_updelay">
553 <p>For a bonded port, the number of milliseconds for which carrier must
554 stay up on an interface before the interface is considered to be up.
555 Specify <code>0</code> to enable the interface immediately.</p>
556 <p>This setting is honored only when at least one bonded interface is
557 already enabled. When no interfaces are enabled, then the first bond
558 interface to come up is enabled immediately.</p>
561 <column name="bond_downdelay">
562 For a bonded port, the number of milliseconds for which carrier must
563 stay down on an interface before the interface is considered to be
564 down. Specify <code>0</code> to disable the interface immediately.
567 <column name="bond_fake_iface">
568 For a bonded port, whether to create a fake internal interface with the
569 name of the port. Use only for compatibility with legacy software that
574 <p>Configures LACP on this port. LACP allows directly connected
575 switches to negotiate which links may be bonded. LACP may be enabled
576 on non-bonded ports for the benefit of any switches they may be
577 connected to. <code>active</code> ports are allowed to initiate LACP
578 negotiations. <code>passive</code> ports are allowed to participate
579 in LACP negotiations initiated by a remote switch, but not allowed to
580 initiate such negotiations themselves. If unset Open vSwitch will
581 choose a reasonable default. </p>
586 <group title="Other Features">
588 Quality of Service configuration for this port.
592 The MAC address to use for this port for the purpose of choosing the
593 bridge's MAC address. This column does not necessarily reflect the
594 port's actual MAC address, nor will setting it change the port's actual
598 <column name="fake_bridge">
599 Does this port represent a sub-bridge for its tagged VLAN within the
600 Bridge? See ovs-vsctl(8) for more information.
603 <column name="external_ids">
605 Key-value pairs for use by external frameworks that integrate with
606 Open vSwitch, rather than by Open vSwitch itself. System integrators
607 should either use the Open vSwitch development mailing list to
608 coordinate on common key-value definitions, or choose key names that
609 are likely to be unique.
612 No key-value pairs native to <ref table="Port"/> are currently
613 defined. For fake bridges (see the <ref column="fake_bridge"/>
614 column), external IDs for the fake bridge are defined here by
615 prefixing a <ref table="Bridge"/> <ref table="Bridge"
616 column="external_ids"/> key with <code>fake-bridge-</code>,
617 e.g. <code>fake-bridge-xs-network-uuids</code>.
621 <column name="other_config">
622 Key-value pairs for configuring rarely used port features. The
623 currently defined key-value pairs are:
625 <dt><code>hwaddr</code></dt>
626 <dd>An Ethernet address in the form
627 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
628 <dt><code>bond-rebalance-interval</code></dt>
629 <dd>For an SLB bonded port, the number of milliseconds between
630 successive attempts to rebalance the bond, that is, to
631 move source MACs and their flows from one interface on
632 the bond to another in an attempt to keep usage of each
633 interface roughly equal. The default is 10000 (10
634 seconds), and the minimum is 1000 (1 second).</dd>
635 <dt><code>bond-detect-mode</code></dt>
636 <dd> Sets the method used to detect link failures in a bonded port.
637 Options are <code>carrier</code> and <code>miimon</code>. Defaults
638 to <code>carrier</code> which uses each interface's carrier to detect
639 failures. When set to <code>miimon</code>, will check for failures
640 by polling each interface's MII. </dd>
641 <dt><code>bond-miimon-interval</code></dt>
642 <dd> The number of milliseconds between successive attempts to
643 poll each interface's MII. Only relevant on ports which use
644 <code>miimon</code> to detect failures. </dd>
645 <dt><code>lacp-system-priority</code></dt>
646 <dd> The LACP system priority of this <ref table="Port"/>. In
647 LACP negotiations, link status decisions are made by the system
648 with the numerically lower priority. Must be a number between 1
655 <table name="Interface" title="One physical network device in a Port.">
656 An interface within a <ref table="Port"/>.
658 <group title="Core Features">
660 Interface name. Should be alphanumeric and no more than about 8 bytes
661 long. May be the same as the port name, for non-bonded ports. Must
662 otherwise be unique among the names of ports, interfaces, and bridges
667 <p>Ethernet address to set for this interface. If unset then the
668 default MAC address is used:</p>
670 <li>For the local interface, the default is the lowest-numbered MAC
671 address among the other bridge ports, either the value of the
672 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
673 if set, or its actual MAC (for bonded ports, the MAC of its slave
674 whose name is first in alphabetical order). Internal ports and
675 bridge ports that are used as port mirroring destinations (see the
676 <ref table="Mirror"/> table) are ignored.</li>
677 <li>For other internal interfaces, the default MAC is randomly
679 <li>External interfaces typically have a MAC address associated with
682 <p>Some interfaces may not have a software-controllable MAC
686 <column name="ofport">
687 <p>OpenFlow port number for this interface. Unlike most columns, this
688 column's value should be set only by Open vSwitch itself. Other
689 clients should set this column to an empty set (the default) when
690 creating an <ref table="Interface"/>.</p>
691 <p>Open vSwitch populates this column when the port number becomes
692 known. If the interface is successfully added,
693 <ref column="ofport"/> will be set to a number between 1 and 65535
694 (generally either in the range 1 to 65279, inclusive, or 65534, the
695 port number for the OpenFlow ``local port''). If the interface
696 cannot be added then Open vSwitch sets this column
701 <group title="System-Specific Details">
703 The interface type, one of:
705 <dt><code>system</code></dt>
706 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
707 Sometimes referred to as ``external interfaces'' since they are
708 generally connected to hardware external to that on which the Open
709 vSwitch is running. The empty string is a synonym for
710 <code>system</code>.</dd>
711 <dt><code>internal</code></dt>
712 <dd>A simulated network device that sends and receives traffic. An
713 internal interface whose <ref column="name"/> is the same as its
714 bridge's <ref table="Open_vSwitch" column="name"/> is called the
715 ``local interface.'' It does not make sense to bond an internal
716 interface, so the terms ``port'' and ``interface'' are often used
717 imprecisely for internal interfaces.</dd>
718 <dt><code>tap</code></dt>
719 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
720 <dt><code>gre</code></dt>
721 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
722 tunnel. Each tunnel must be uniquely identified by the
723 combination of <code>remote_ip</code>, <code>local_ip</code>, and
724 <code>in_key</code>. Note that if two ports are defined that are
725 the same except one has an optional identifier and the other does
726 not, the more specific one is matched first. <code>in_key</code>
727 is considered more specific than <code>local_ip</code> if a port
728 defines one and another port defines the other. The following
729 options may be specified in the <ref column="options"/> column:
731 <dt><code>remote_ip</code></dt>
732 <dd>Required. The tunnel endpoint.</dd>
735 <dt><code>local_ip</code></dt>
736 <dd>Optional. The destination IP that received packets must
737 match. Default is to match all addresses.</dd>
740 <dt><code>in_key</code></dt>
741 <dd>Optional. The GRE key that received packets must contain.
742 It may either be a 32-bit number (no key and a key of 0 are
743 treated as equivalent) or the word <code>flow</code>. If
744 <code>flow</code> is specified then any key will be accepted
745 and the key will be placed in the <code>tun_id</code> field
746 for matching in the flow table. The ovs-ofctl manual page
747 contains additional information about matching fields in
748 OpenFlow flows. Default is no key.</dd>
751 <dt><code>out_key</code></dt>
752 <dd>Optional. The GRE key to be set on outgoing packets. It may
753 either be a 32-bit number or the word <code>flow</code>. If
754 <code>flow</code> is specified then the key may be set using
755 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
756 is used in the absence of an action). The ovs-ofctl manual
757 page contains additional information about the Nicira OpenFlow
758 vendor extensions. Default is no key.</dd>
761 <dt><code>key</code></dt>
762 <dd>Optional. Shorthand to set <code>in_key</code> and
763 <code>out_key</code> at the same time.</dd>
766 <dt><code>tos</code></dt>
767 <dd>Optional. The value of the ToS bits to be set on the
768 encapsulating packet. It may also be the word
769 <code>inherit</code>, in which case the ToS will be copied from
770 the inner packet if it is IPv4 or IPv6 (otherwise it will be
771 0). Note that the ECN fields are always inherited. Default is
775 <dt><code>ttl</code></dt>
776 <dd>Optional. The TTL to be set on the encapsulating packet.
777 It may also be the word <code>inherit</code>, in which case the
778 TTL will be copied from the inner packet if it is IPv4 or IPv6
779 (otherwise it will be the system default, typically 64).
780 Default is the system default TTL.</dd>
783 <dt><code>csum</code></dt>
784 <dd>Optional. Compute GRE checksums on outgoing packets.
785 Checksums present on incoming packets will be validated
786 regardless of this setting. Note that GRE checksums
787 impose a significant performance penalty as they cover the
788 entire packet. As the contents of the packet is typically
789 covered by L3 and L4 checksums, this additional checksum only
790 adds value for the GRE and encapsulated Ethernet headers.
791 Default is disabled, set to <code>true</code> to enable.</dd>
794 <dt><code>pmtud</code></dt>
795 <dd>Optional. Enable tunnel path MTU discovery. If enabled
796 ``ICMP destination unreachable - fragmentation'' needed
797 messages will be generated for IPv4 packets with the DF bit set
798 and IPv6 packets above the minimum MTU if the packet size
799 exceeds the path MTU minus the size of the tunnel headers. It
800 also forces the encapsulating packet DF bit to be set (it is
801 always set if the inner packet implies path MTU discovery).
802 Note that this option causes behavior that is typically
803 reserved for routers and therefore is not entirely in
804 compliance with the IEEE 802.1D specification for bridges.
805 Default is enabled, set to <code>false</code> to disable.</dd>
808 <dt><code>header_cache</code></dt>
809 <dd>Optional. Enable caching of tunnel headers and the output
810 path. This can lead to a significant performance increase
811 without changing behavior. In general it should not be
812 necessary to adjust this setting. However, the caching can
813 bypass certain components of the IP stack (such as IP tables)
814 and it may be useful to disable it if these features are
815 required or as a debugging measure. Default is enabled, set to
816 <code>false</code> to disable.</dd>
819 <dt><code>ipsec_gre</code></dt>
820 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
821 over IPv4 IPsec tunnel. Each tunnel (including those of type
822 <code>gre</code>) must be uniquely identified by the
823 combination of <code>remote_ip</code> and
824 <code>local_ip</code>. Note that if two ports are defined
825 that are the same except one has an optional identifier and
826 the other does not, the more specific one is matched first.
827 An authentication method of <code>peer_cert</code> or
828 <code>psk</code> must be defined. The following options may
829 be specified in the <ref column="options"/> column:
831 <dt><code>remote_ip</code></dt>
832 <dd>Required. The tunnel endpoint.</dd>
835 <dt><code>local_ip</code></dt>
836 <dd>Optional. The destination IP that received packets must
837 match. Default is to match all addresses.</dd>
840 <dt><code>peer_cert</code></dt>
841 <dd>Required for certificate authentication. A string
842 containing the peer's certificate in PEM format.
843 Additionally the host's certificate must be specified
844 with the <code>certificate</code> option.</dd>
847 <dt><code>certificate</code></dt>
848 <dd>Required for certificate authentication. The name of a
849 PEM file containing a certificate that will be presented
850 to the peer during authentication.</dd>
853 <dt><code>private_key</code></dt>
854 <dd>Optional for certificate authentication. The name of
855 a PEM file containing the private key associated with
856 <code>certificate</code>. If <code>certificate</code>
857 contains the private key, this option may be omitted.</dd>
860 <dt><code>psk</code></dt>
861 <dd>Required for pre-shared key authentication. Specifies a
862 pre-shared key for authentication that must be identical on
863 both sides of the tunnel.</dd>
866 <dt><code>in_key</code></dt>
867 <dd>Optional. The GRE key that received packets must contain.
868 It may either be a 32-bit number (no key and a key of 0 are
869 treated as equivalent) or the word <code>flow</code>. If
870 <code>flow</code> is specified then any key will be accepted
871 and the key will be placed in the <code>tun_id</code> field
872 for matching in the flow table. The ovs-ofctl manual page
873 contains additional information about matching fields in
874 OpenFlow flows. Default is no key.</dd>
877 <dt><code>out_key</code></dt>
878 <dd>Optional. The GRE key to be set on outgoing packets. It may
879 either be a 32-bit number or the word <code>flow</code>. If
880 <code>flow</code> is specified then the key may be set using
881 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
882 is used in the absence of an action). The ovs-ofctl manual
883 page contains additional information about the Nicira OpenFlow
884 vendor extensions. Default is no key.</dd>
887 <dt><code>key</code></dt>
888 <dd>Optional. Shorthand to set <code>in_key</code> and
889 <code>out_key</code> at the same time.</dd>
892 <dt><code>tos</code></dt>
893 <dd>Optional. The value of the ToS bits to be set on the
894 encapsulating packet. It may also be the word
895 <code>inherit</code>, in which case the ToS will be copied from
896 the inner packet if it is IPv4 or IPv6 (otherwise it will be
897 0). Note that the ECN fields are always inherited. Default is
901 <dt><code>ttl</code></dt>
902 <dd>Optional. The TTL to be set on the encapsulating packet.
903 It may also be the word <code>inherit</code>, in which case the
904 TTL will be copied from the inner packet if it is IPv4 or IPv6
905 (otherwise it will be the system default, typically 64).
906 Default is the system default TTL.</dd>
909 <dt><code>csum</code></dt>
910 <dd>Optional. Compute GRE checksums on outgoing packets.
911 Checksums present on incoming packets will be validated
912 regardless of this setting. Note that GRE checksums
913 impose a significant performance penalty as they cover the
914 entire packet. As the contents of the packet is typically
915 covered by L3 and L4 checksums, this additional checksum only
916 adds value for the GRE and encapsulated Ethernet headers.
917 Default is disabled, set to <code>true</code> to enable.</dd>
920 <dt><code>pmtud</code></dt>
921 <dd>Optional. Enable tunnel path MTU discovery. If enabled
922 ``ICMP destination unreachable - fragmentation'' needed
923 messages will be generated for IPv4 packets with the DF bit set
924 and IPv6 packets above the minimum MTU if the packet size
925 exceeds the path MTU minus the size of the tunnel headers. It
926 also forces the encapsulating packet DF bit to be set (it is
927 always set if the inner packet implies path MTU discovery).
928 Note that this option causes behavior that is typically
929 reserved for routers and therefore is not entirely in
930 compliance with the IEEE 802.1D specification for bridges.
931 Default is enabled, set to <code>false</code> to disable.</dd>
934 <dt><code>capwap</code></dt>
935 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
936 (RFC 5415). This allows interoperability with certain switches
937 where GRE is not available. Note that only the tunneling component
938 of the protocol is implemented. Due to the non-standard use of
939 CAPWAP, UDP ports 58881 and 58882 are used as the source and
940 destinations ports respectivedly. Each tunnel must be uniquely
941 identified by the combination of <code>remote_ip</code> and
942 <code>local_ip</code>. If two ports are defined that are the same
943 except one includes <code>local_ip</code> and the other does not,
944 the more specific one is matched first. CAPWAP support is not
945 available on all platforms. Currently it is only supported in the
946 Linux kernel module with kernel versions >= 2.6.25. The following
947 options may be specified in the <ref column="options"/> column:
949 <dt><code>remote_ip</code></dt>
950 <dd>Required. The tunnel endpoint.</dd>
953 <dt><code>local_ip</code></dt>
954 <dd>Optional. The destination IP that received packets must
955 match. Default is to match all addresses.</dd>
958 <dt><code>tos</code></dt>
959 <dd>Optional. The value of the ToS bits to be set on the
960 encapsulating packet. It may also be the word
961 <code>inherit</code>, in which case the ToS will be copied from
962 the inner packet if it is IPv4 or IPv6 (otherwise it will be
963 0). Note that the ECN fields are always inherited. Default is
967 <dt><code>ttl</code></dt>
968 <dd>Optional. The TTL to be set on the encapsulating packet.
969 It may also be the word <code>inherit</code>, in which case the
970 TTL will be copied from the inner packet if it is IPv4 or IPv6
971 (otherwise it will be the system default, typically 64).
972 Default is the system default TTL.</dd>
975 <dt><code>pmtud</code></dt>
976 <dd>Optional. Enable tunnel path MTU discovery. If enabled
977 ``ICMP destination unreachable - fragmentation'' needed
978 messages will be generated for IPv4 packets with the DF bit set
979 and IPv6 packets above the minimum MTU if the packet size
980 exceeds the path MTU minus the size of the tunnel headers. It
981 also forces the encapsulating packet DF bit to be set (it is
982 always set if the inner packet implies path MTU discovery).
983 Note that this option causes behavior that is typically
984 reserved for routers and therefore is not entirely in
985 compliance with the IEEE 802.1D specification for bridges.
986 Default is enabled, set to <code>false</code> to disable.</dd>
989 <dt><code>header_cache</code></dt>
990 <dd>Optional. Enable caching of tunnel headers and the output
991 path. This can lead to a significant performance increase
992 without changing behavior. In general it should not be
993 necessary to adjust this setting. However, the caching can
994 bypass certain components of the IP stack (such as IP tables)
995 and it may be useful to disable it if these features are
996 required or as a debugging measure. Default is enabled, set to
997 <code>false</code> to disable.</dd>
1000 <dt><code>patch</code></dt>
1003 A pair of virtual devices that act as a patch cable. The <ref
1004 column="options"/> column must have the following key-value pair:
1007 <dt><code>peer</code></dt>
1009 The <ref column="name"/> of the <ref table="Interface"/> for
1010 the other side of the patch. The named <ref
1011 table="Interface"/>'s own <code>peer</code> option must specify
1012 this <ref table="Interface"/>'s name. That is, the two patch
1013 interfaces must have reversed <ref column="name"/> and
1014 <code>peer</code> values.
1021 <column name="options">
1022 Configuration options whose interpretation varies based on
1023 <ref column="type"/>.
1027 <group title="Interface Status">
1029 Status information about interfaces attached to bridges, updated every
1030 5 seconds. Not all interfaces have all of these properties; virtual
1031 interfaces don't have a link speed, for example. Non-applicable
1032 columns will have empty values.
1034 <column name="admin_state">
1036 The administrative state of the physical network link.
1040 <column name="link_state">
1042 The observed state of the physical network link;
1043 i.e. whether a carrier is detected by the interface.
1047 <column name="link_speed">
1049 The negotiated speed of the physical network link.
1050 Valid values are positive integers greater than 0.
1054 <column name="duplex">
1056 The duplex mode of the physical network link.
1062 The MTU (maximum transmission unit); i.e. the largest
1063 amount of data that can fit into a single Ethernet frame.
1064 The standard Ethernet MTU is 1500 bytes. Some physical media
1065 and many kinds of virtual interfaces can be configured with
1070 <column name="status">
1072 Key-value pairs that report port status. Supported status
1073 values are <code>type</code>-dependent; some interfaces may not have
1074 a valid <code>driver_name</code>, for example.
1076 <p>The currently defined key-value pairs are:</p>
1078 <dt><code>driver_name</code></dt>
1079 <dd>The name of the device driver controlling the network
1083 <dt><code>driver_version</code></dt>
1084 <dd>The version string of the device driver controlling the
1085 network adapter.</dd>
1088 <dt><code>firmware_version</code></dt>
1089 <dd>The version string of the network adapter's firmware, if
1093 <dt><code>source_ip</code></dt>
1094 <dd>The source IP address used for an IPv4 tunnel end-point,
1095 such as <code>gre</code> or <code>capwap</code>.</dd>
1098 <dt><code>tunnel_egress_iface</code></dt>
1099 <dd>Egress interface for tunnels. Currently only relevant for GRE
1100 and CAPWAP tunnels. On Linux systems, this column will show
1101 the name of the interface which is responsible for routing
1102 traffic destined for the configured <code>remote_ip</code>.
1103 This could be an internal interface such as a bridge port.</dd>
1106 <dt><code>tunnel_egress_iface_carrier</code></dt>
1107 <dd>Whether a carrier is detected on <ref
1108 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1109 and <code>up</code>.</dd>
1114 <group title="Ingress Policing">
1116 These settings control ingress policing for packets received on this
1117 interface. On a physical interface, this limits the rate at which
1118 traffic is allowed into the system from the outside; on a virtual
1119 interface (one connected to a virtual machine), this limits the rate at
1120 which the VM is able to transmit.
1123 Policing is a simple form of quality-of-service that simply drops
1124 packets received in excess of the configured rate. Due to its
1125 simplicity, policing is usually less accurate and less effective than
1126 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1127 table="Queue"/> tables).
1130 Policing is currently implemented only on Linux. The Linux
1131 implementation uses a simple ``token bucket'' approach:
1135 The size of the bucket corresponds to <ref
1136 column="ingress_policing_burst"/>. Initially the bucket is full.
1139 Whenever a packet is received, its size (converted to tokens) is
1140 compared to the number of tokens currently in the bucket. If the
1141 required number of tokens are available, they are removed and the
1142 packet is forwarded. Otherwise, the packet is dropped.
1145 Whenever it is not full, the bucket is refilled with tokens at the
1146 rate specified by <ref column="ingress_policing_rate"/>.
1150 Policing interacts badly with some network protocols, and especially
1151 with fragmented IP packets. Suppose that there is enough network
1152 activity to keep the bucket nearly empty all the time. Then this token
1153 bucket algorithm will forward a single packet every so often, with the
1154 period depending on packet size and on the configured rate. All of the
1155 fragments of an IP packets are normally transmitted back-to-back, as a
1156 group. In such a situation, therefore, only one of these fragments
1157 will be forwarded and the rest will be dropped. IP does not provide
1158 any way for the intended recipient to ask for only the remaining
1159 fragments. In such a case there are two likely possibilities for what
1160 will happen next: either all of the fragments will eventually be
1161 retransmitted (as TCP will do), in which case the same problem will
1162 recur, or the sender will not realize that its packet has been dropped
1163 and data will simply be lost (as some UDP-based protocols will do).
1164 Either way, it is possible that no forward progress will ever occur.
1166 <column name="ingress_policing_rate">
1168 Maximum rate for data received on this interface, in kbps. Data
1169 received faster than this rate is dropped. Set to <code>0</code>
1170 (the default) to disable policing.
1174 <column name="ingress_policing_burst">
1175 <p>Maximum burst size for data received on this interface, in kb. The
1176 default burst size if set to <code>0</code> is 1000 kb. This value
1177 has no effect if <ref column="ingress_policing_rate"/>
1178 is <code>0</code>.</p>
1180 Specifying a larger burst size lets the algorithm be more forgiving,
1181 which is important for protocols like TCP that react severely to
1182 dropped packets. The burst size should be at least the size of the
1183 interface's MTU. Specifying a value that is numerically at least as
1184 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1185 closer to achieving the full rate.
1190 <group title="Other Features">
1192 <column name="monitor">
1193 Connectivity monitor configuration for this interface.
1196 <column name="external_ids">
1197 Key-value pairs for use by external frameworks that integrate
1198 with Open vSwitch, rather than by Open vSwitch itself. System
1199 integrators should either use the Open vSwitch development
1200 mailing list to coordinate on common key-value definitions, or
1201 choose key names that are likely to be unique. The currently
1202 defined common key-value pairs are:
1204 <dt><code>attached-mac</code></dt>
1206 The MAC address programmed into the ``virtual hardware'' for this
1207 interface, in the form
1208 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1209 For Citrix XenServer, this is the value of the <code>MAC</code>
1210 field in the VIF record for this interface.</dd>
1211 <dt><code>iface-id</code></dt>
1212 <dd>A system-unique identifier for the interface. On XenServer,
1213 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1216 Additionally the following key-value pairs specifically
1217 apply to an interface that represents a virtual Ethernet interface
1218 connected to a virtual machine. These key-value pairs should not be
1219 present for other types of interfaces. Keys whose names end
1220 in <code>-uuid</code> have values that uniquely identify the entity
1221 in question. For a Citrix XenServer hypervisor, these values are
1222 UUIDs in RFC 4122 format. Other hypervisors may use other
1225 <p>The currently defined key-value pairs for XenServer are:</p>
1227 <dt><code>xs-vif-uuid</code></dt>
1228 <dd>The virtual interface associated with this interface.</dd>
1229 <dt><code>xs-network-uuid</code></dt>
1230 <dd>The virtual network to which this interface is attached.</dd>
1231 <dt><code>xs-vm-uuid</code></dt>
1232 <dd>The VM to which this interface belongs.</dd>
1236 <column name="other_config">
1237 Key-value pairs for rarely used interface features.
1239 <dt><code>lacp-port-priority</code></dt>
1240 <dd> The LACP port priority of this <ref table="Interface"/>. In
1241 LACP negotiations <ref table="Interface"/>s with numerically lower
1242 priorities are preferred for aggregation. Must be a number between
1247 <column name="statistics">
1249 Key-value pairs that report interface statistics. The current
1250 implementation updates these counters periodically. In the future,
1251 we plan to, instead, update them when an interface is created, when
1252 they are queried (e.g. using an OVSDB <code>select</code> operation),
1253 and just before an interface is deleted due to virtual interface
1254 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1255 regular periodic basis.</p>
1257 The currently defined key-value pairs are listed below. These are
1258 the same statistics reported by OpenFlow in its <code>struct
1259 ofp_port_stats</code> structure. If an interface does not support a
1260 given statistic, then that pair is omitted.</p>
1263 Successful transmit and receive counters:
1265 <dt><code>rx_packets</code></dt>
1266 <dd>Number of received packets.</dd>
1267 <dt><code>rx_bytes</code></dt>
1268 <dd>Number of received bytes.</dd>
1269 <dt><code>tx_packets</code></dt>
1270 <dd>Number of transmitted packets.</dd>
1271 <dt><code>tx_bytes</code></dt>
1272 <dd>Number of transmitted bytes.</dd>
1278 <dt><code>rx_dropped</code></dt>
1279 <dd>Number of packets dropped by RX.</dd>
1280 <dt><code>rx_frame_err</code></dt>
1281 <dd>Number of frame alignment errors.</dd>
1282 <dt><code>rx_over_err</code></dt>
1283 <dd>Number of packets with RX overrun.</dd>
1284 <dt><code>rx_crc_err</code></dt>
1285 <dd>Number of CRC errors.</dd>
1286 <dt><code>rx_errors</code></dt>
1288 Total number of receive errors, greater than or equal
1289 to the sum of the above.
1296 <dt><code>tx_dropped</code></dt>
1297 <dd>Number of packets dropped by TX.</dd>
1298 <dt><code>collisions</code></dt>
1299 <dd>Number of collisions.</dd>
1300 <dt><code>tx_errors</code></dt>
1302 Total number of transmit errors, greater
1303 than or equal to the sum of the above.
1312 <table name="QoS" title="Quality of Service configuration">
1313 <p>Quality of Service (QoS) configuration for each Port that
1316 <column name="type">
1317 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1318 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1319 identifies the types that a switch actually supports. The currently
1320 defined types are listed below:</p>
1322 <dt><code>linux-htb</code></dt>
1324 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1325 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1326 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1327 for information on how this classifier works and how to configure it.
1331 <dt><code>linux-hfsc</code></dt>
1333 Linux "Hierarchical Fair Service Curve" classifier.
1334 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1335 information on how this classifier works.
1340 <column name="queues">
1341 <p>A map from queue numbers to <ref table="Queue"/> records. The
1342 supported range of queue numbers depend on <ref column="type"/>. The
1343 queue numbers are the same as the <code>queue_id</code> used in
1344 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1345 structures. Queue 0 is used by OpenFlow output actions that do not
1346 specify a specific queue.</p>
1349 <column name="other_config">
1350 <p>Key-value pairs for configuring QoS features that depend on
1351 <ref column="type"/>.</p>
1352 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1353 the following key-value pairs:</p>
1355 <dt><code>max-rate</code></dt>
1356 <dd>Maximum rate shared by all queued traffic, in bit/s.
1357 Optional. If not specified, for physical interfaces, the
1358 default is the link rate. For other interfaces or if the
1359 link rate cannot be determined, the default is currently 100
1364 <column name="external_ids">
1365 Key-value pairs for use by external frameworks that integrate with Open
1366 vSwitch, rather than by Open vSwitch itself. System integrators should
1367 either use the Open vSwitch development mailing list to coordinate on
1368 common key-value definitions, or choose key names that are likely to be
1369 unique. No common key-value pairs are currently defined.
1373 <table name="Queue" title="QoS output queue.">
1374 <p>A configuration for a port output queue, used in configuring Quality of
1375 Service (QoS) features. May be referenced by <ref column="queues"
1376 table="QoS"/> column in <ref table="QoS"/> table.</p>
1378 <column name="other_config">
1379 <p>Key-value pairs for configuring the output queue. The supported
1380 key-value pairs and their meanings depend on the <ref column="type"/>
1381 of the <ref column="QoS"/> records that reference this row.</p>
1382 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1383 column="type"/> of <code>min-rate</code> are:</p>
1385 <dt><code>min-rate</code></dt>
1386 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1387 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1389 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1390 column="type"/> of <code>linux-htb</code> are:</p>
1392 <dt><code>min-rate</code></dt>
1393 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1394 <dt><code>max-rate</code></dt>
1395 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1396 queue's rate will not be allowed to exceed the specified value, even
1397 if excess bandwidth is available. If unspecified, defaults to no
1399 <dt><code>burst</code></dt>
1400 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1401 that a queue can accumulate while it is idle. Optional. Details of
1402 the <code>linux-htb</code> implementation require a minimum burst
1403 size, so a too-small <code>burst</code> will be silently
1405 <dt><code>priority</code></dt>
1406 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1407 unspecified. A queue with a smaller <code>priority</code>
1408 will receive all the excess bandwidth that it can use before
1409 a queue with a larger value receives any. Specific priority
1410 values are unimportant; only relative ordering matters.</dd>
1412 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1413 column="type"/> of <code>linux-hfsc</code> are:</p>
1415 <dt><code>min-rate</code></dt>
1416 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1417 <dt><code>max-rate</code></dt>
1418 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1419 queue's rate will not be allowed to exceed the specified value, even
1420 if excess bandwidth is available. If unspecified, defaults to no
1425 <column name="external_ids">
1426 Key-value pairs for use by external frameworks that integrate with Open
1427 vSwitch, rather than by Open vSwitch itself. System integrators should
1428 either use the Open vSwitch development mailing list to coordinate on
1429 common key-value definitions, or choose key names that are likely to be
1430 unique. No common key-value pairs are currently defined.
1434 <table name="Monitor" title="Connectivity Monitor configuration">
1436 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1437 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1438 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1439 to detect connectivity problems with each other. MPs within a MA should
1440 have complete and exclusive interconnectivity. This is verified by
1441 occasionally broadcasting Continuity Check Messages (CCMs) at a
1442 configurable transmission interval. A <ref table="Monitor"/> is
1443 responsible for collecting data about other MPs in its MA and
1447 <group title="Monitor Configuration">
1448 <column name="mpid">
1449 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1450 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1451 used to identify this <ref table="Monitor"/> to other endpoints in the
1455 <column name="remote_mps">
1456 A set of <ref table="Maintenance_Points"/> which this
1457 <ref table="Monitor"/> should have connectivity to. If this
1458 <ref table="Monitor"/> does not have connectivity to any MPs in this
1459 set, or has connectivity to any MPs not in this set, a fault is
1463 <column name="ma_name">
1464 A Maintenance Association (MA) name pairs with a Maintenance Domain
1465 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1466 have complete and exclusive interconnectivity. Defaults to
1467 <code>ovs</code> if unset.
1470 <column name="md_name">
1471 A Maintenance Domain name pairs with a Maintenance Association name to
1472 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1475 <column name="interval">
1476 The transmission interval of CCMs in milliseconds. Three missed CCMs
1477 indicate a connectivity fault. Defaults to 1000ms.
1481 <group title="Monitor Status">
1482 <column name="unexpected_remote_mpids">
1483 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1484 has detected connectivity that are not in the
1485 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1486 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1487 Thus, if this set is non-empty a fault is indicated.
1490 <column name="unexpected_remote_maids">
1491 A set of MAIDs representing foreign Maintenance Associations (MAs)
1492 which this <ref table="Monitor"/> has detected connectivity to. A
1493 <ref table="Monitor"/> should not have connectivity to a Maintenance
1494 Association other than its own. Thus, if this set is non-empty a fault
1498 <column name="fault">
1499 Indicates a Connectivity Fault caused by a configuration error, a down
1500 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1505 <table name="Maintenance_Point" title="Maintenance Point configuration">
1507 A <ref table="Maintenance_Point"/> represents a MP which a
1508 <ref table="Monitor"/> has or should have connectivity to.
1511 <group title="Maintenance_Point Configuration">
1512 <column name="mpid">
1513 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1514 a Maintenance Association. All MPs within a MA should have a unique
1519 <group title="Maintenance_Point Status">
1520 <column name="fault">
1521 Indicates a connectivity fault.
1526 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1527 <p>A port mirror within a <ref table="Bridge"/>.</p>
1528 <p>A port mirror configures a bridge to send selected frames to special
1529 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1530 traffic may also be referred to as SPAN or RSPAN, depending on the
1531 mechanism used for delivery.</p>
1533 <column name="name">
1534 Arbitrary identifier for the <ref table="Mirror"/>.
1537 <group title="Selecting Packets for Mirroring">
1538 <column name="select_all">
1539 If true, every packet arriving or departing on any port is
1540 selected for mirroring.
1543 <column name="select_dst_port">
1544 Ports on which departing packets are selected for mirroring.
1547 <column name="select_src_port">
1548 Ports on which arriving packets are selected for mirroring.
1551 <column name="select_vlan">
1552 VLANs on which packets are selected for mirroring. An empty set
1553 selects packets on all VLANs.
1557 <group title="Mirroring Destination Configuration">
1558 <column name="output_port">
1559 <p>Output port for selected packets, if nonempty. Mutually exclusive
1560 with <ref column="output_vlan"/>.</p>
1561 <p>Specifying a port for mirror output reserves that port exclusively
1562 for mirroring. No frames other than those selected for mirroring
1563 will be forwarded to the port, and any frames received on the port
1564 will be discarded.</p>
1565 <p>This type of mirroring is sometimes called SPAN.</p>
1568 <column name="output_vlan">
1569 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1570 with <ref column="output_port"/>.</p>
1571 <p>The frames will be sent out all ports that trunk
1572 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1573 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1574 trunk port, the frame's VLAN tag will be set to
1575 <ref column="output_vlan"/>, replacing any existing tag; when it is
1576 sent out an implicit VLAN port, the frame will not be tagged. This
1577 type of mirroring is sometimes called RSPAN.</p>
1578 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1579 contains unmanaged switches. Consider an unmanaged physical switch
1580 with two ports: port 1, connected to an end host, and port 2,
1581 connected to an Open vSwitch configured to mirror received packets
1582 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1583 port 1 that the physical switch forwards to port 2. The Open vSwitch
1584 forwards this packet to its destination and then reflects it back on
1585 port 2 in VLAN 123. This reflected packet causes the unmanaged
1586 physical switch to replace the MAC learning table entry, which
1587 correctly pointed to port 1, with one that incorrectly points to port
1588 2. Afterward, the physical switch will direct packets destined for
1589 the end host to the Open vSwitch on port 2, instead of to the end
1590 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1591 desired in this scenario, then the physical switch must be replaced
1592 by one that learns Ethernet addresses on a per-VLAN basis. In
1593 addition, learning should be disabled on the VLAN containing mirrored
1594 traffic. If this is not done then intermediate switches will learn
1595 the MAC address of each end host from the mirrored traffic. If
1596 packets being sent to that end host are also mirrored, then they will
1597 be dropped since the switch will attempt to send them out the input
1598 port. Disabling learning for the VLAN will cause the switch to
1599 correctly send the packet out all ports configured for that VLAN. If
1600 Open vSwitch is being used as an intermediate switch, learning can be
1601 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1602 in the appropriate <ref table="Bridge"/> table or tables.</p>
1606 <group title="Other Features">
1607 <column name="external_ids">
1608 Key-value pairs for use by external frameworks that integrate with Open
1609 vSwitch, rather than by Open vSwitch itself. System integrators should
1610 either use the Open vSwitch development mailing list to coordinate on
1611 common key-value definitions, or choose key names that are likely to be
1612 unique. No common key-value pairs are currently defined.
1617 <table name="Controller" title="OpenFlow controller configuration.">
1618 <p>An OpenFlow controller.</p>
1621 Open vSwitch supports two kinds of OpenFlow controllers:
1625 <dt>Primary controllers</dt>
1628 This is the kind of controller envisioned by the OpenFlow 1.0
1629 specification. Usually, a primary controller implements a network
1630 policy by taking charge of the switch's flow table.
1634 Open vSwitch initiates and maintains persistent connections to
1635 primary controllers, retrying the connection each time it fails or
1636 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1637 <ref table="Bridge"/> table applies to primary controllers.
1641 Open vSwitch permits a bridge to have any number of primary
1642 controllers. When multiple controllers are configured, Open
1643 vSwitch connects to all of them simultaneously. Because
1644 OpenFlow 1.0 does not specify how multiple controllers
1645 coordinate in interacting with a single switch, more than
1646 one primary controller should be specified only if the
1647 controllers are themselves designed to coordinate with each
1648 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1649 vendor extension may be useful for this.)
1652 <dt>Service controllers</dt>
1655 These kinds of OpenFlow controller connections are intended for
1656 occasional support and maintenance use, e.g. with
1657 <code>ovs-ofctl</code>. Usually a service controller connects only
1658 briefly to inspect or modify some of a switch's state.
1662 Open vSwitch listens for incoming connections from service
1663 controllers. The service controllers initiate and, if necessary,
1664 maintain the connections from their end. The <ref table="Bridge"
1665 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1666 not apply to service controllers.
1670 Open vSwitch supports configuring any number of service controllers.
1676 The <ref column="target"/> determines the type of controller.
1679 <group title="Core Features">
1680 <column name="target">
1681 <p>Connection method for controller.</p>
1683 The following connection methods are currently supported for primary
1687 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1689 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1690 the given <var>ip</var>, which must be expressed as an IP address
1691 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1692 column in the <ref table="Open_vSwitch"/> table must point to a
1693 valid SSL configuration when this form is used.</p>
1694 <p>SSL support is an optional feature that is not always built as
1695 part of Open vSwitch.</p>
1697 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1698 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1699 the given <var>ip</var>, which must be expressed as an IP address
1700 (not a DNS name).</dd>
1701 <dt><code>discover</code></dt>
1703 <p>Enables controller discovery.</p>
1704 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1705 request with vendor class identifier <code>OpenFlow</code> across
1706 all of the bridge's network devices. It will accept any valid
1707 DHCP reply that has the same vendor class identifier and includes
1708 a vendor-specific option with code 1 whose contents are a string
1709 specifying the location of the controller in the same format as
1710 <ref column="target"/>.</p>
1711 <p>The DHCP reply may also, optionally, include a vendor-specific
1712 option with code 2 whose contents are a string specifying the URI
1713 to the base of the OpenFlow PKI
1714 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1715 used only for bootstrapping the OpenFlow PKI at initial switch
1716 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1720 The following connection methods are currently supported for service
1724 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1727 Listens for SSL connections on the specified TCP <var>port</var>
1728 (default: 6633). If <var>ip</var>, which must be expressed as an
1729 IP address (not a DNS name), is specified, then connections are
1730 restricted to the specified local IP address.
1733 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1734 table="Open_vSwitch"/> table must point to a valid SSL
1735 configuration when this form is used.
1737 <p>SSL support is an optional feature that is not always built as
1738 part of Open vSwitch.</p>
1740 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1742 Listens for connections on the specified TCP <var>port</var>
1743 (default: 6633). If <var>ip</var>, which must be expressed as an
1744 IP address (not a DNS name), is specified, then connections are
1745 restricted to the specified local IP address.
1748 <p>When multiple controllers are configured for a single bridge, the
1749 <ref column="target"/> values must be unique. Duplicate
1750 <ref column="target"/> values yield unspecified results.</p>
1753 <column name="connection_mode">
1754 <p>If it is specified, this setting must be one of the following
1755 strings that describes how Open vSwitch contacts this OpenFlow
1756 controller over the network:</p>
1759 <dt><code>in-band</code></dt>
1760 <dd>In this mode, this controller's OpenFlow traffic travels over the
1761 bridge associated with the controller. With this setting, Open
1762 vSwitch allows traffic to and from the controller regardless of the
1763 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1764 would never be able to connect to the controller, because it did
1765 not have a flow to enable it.) This is the most common connection
1766 mode because it is not necessary to maintain two independent
1768 <dt><code>out-of-band</code></dt>
1769 <dd>In this mode, OpenFlow traffic uses a control network separate
1770 from the bridge associated with this controller, that is, the
1771 bridge does not use any of its own network devices to communicate
1772 with the controller. The control network must be configured
1773 separately, before or after <code>ovs-vswitchd</code> is started.
1777 <p>If not specified, the default is implementation-specific. If
1778 <ref column="target"/> is <code>discover</code>, the connection mode
1779 is always treated as <code>in-band</code> regardless of the actual
1784 <group title="Controller Failure Detection and Handling">
1785 <column name="max_backoff">
1786 Maximum number of milliseconds to wait between connection attempts.
1787 Default is implementation-specific.
1790 <column name="inactivity_probe">
1791 Maximum number of milliseconds of idle time on connection to
1792 controller before sending an inactivity probe message. If Open
1793 vSwitch does not communicate with the controller for the specified
1794 number of seconds, it will send a probe. If a response is not
1795 received for the same additional amount of time, Open vSwitch
1796 assumes the connection has been broken and attempts to reconnect.
1797 Default is implementation-specific.
1801 <group title="OpenFlow Rate Limiting">
1802 <column name="controller_rate_limit">
1803 <p>The maximum rate at which packets in unknown flows will be
1804 forwarded to the OpenFlow controller, in packets per second. This
1805 feature prevents a single bridge from overwhelming the controller.
1806 If not specified, the default is implementation-specific.</p>
1807 <p>In addition, when a high rate triggers rate-limiting, Open
1808 vSwitch queues controller packets for each port and transmits
1809 them to the controller at the configured rate. The number of
1810 queued packets is limited by
1811 the <ref column="controller_burst_limit"/> value. The packet
1812 queue is shared fairly among the ports on a bridge.</p><p>Open
1813 vSwitch maintains two such packet rate-limiters per bridge.
1814 One of these applies to packets sent up to the controller
1815 because they do not correspond to any flow. The other applies
1816 to packets sent up to the controller by request through flow
1817 actions. When both rate-limiters are filled with packets, the
1818 actual rate that packets are sent to the controller is up to
1819 twice the specified rate.</p>
1822 <column name="controller_burst_limit">
1823 In conjunction with <ref column="controller_rate_limit"/>,
1824 the maximum number of unused packet credits that the bridge will
1825 allow to accumulate, in packets. If not specified, the default
1826 is implementation-specific.
1830 <group title="Additional Discovery Configuration">
1831 <p>These values are considered only when <ref column="target"/>
1832 is <code>discover</code>.</p>
1834 <column name="discover_accept_regex">
1836 extended regular expression against which the discovered controller
1837 location is validated. The regular expression is implicitly
1838 anchored at the beginning of the controller location string, as
1839 if it begins with <code>^</code>. If not specified, the default
1840 is implementation-specific.
1843 <column name="discover_update_resolv_conf">
1844 Whether to update <code>/etc/resolv.conf</code> when the
1845 controller is discovered. If not specified, the default
1846 is implementation-specific. Open vSwitch will only modify
1847 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1848 specifies one or more DNS servers.
1852 <group title="Additional In-Band Configuration">
1853 <p>These values are considered only in in-band control mode (see
1854 <ref column="connection_mode"/>) and only when <ref column="target"/>
1855 is not <code>discover</code>. (For controller discovery, the network
1856 configuration obtained via DHCP is used instead.)</p>
1858 <p>When multiple controllers are configured on a single bridge, there
1859 should be only one set of unique values in these columns. If different
1860 values are set for these columns in different controllers, the effect
1863 <column name="local_ip">
1864 The IP address to configure on the local port,
1865 e.g. <code>192.168.0.123</code>. If this value is unset, then
1866 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1870 <column name="local_netmask">
1871 The IP netmask to configure on the local port,
1872 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1873 but this value is unset, then the default is chosen based on whether
1874 the IP address is class A, B, or C.
1877 <column name="local_gateway">
1878 The IP address of the gateway to configure on the local port, as a
1879 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1880 this network has no gateway.
1884 <group title="Other Features">
1885 <column name="external_ids">
1886 Key-value pairs for use by external frameworks that integrate with Open
1887 vSwitch, rather than by Open vSwitch itself. System integrators should
1888 either use the Open vSwitch development mailing list to coordinate on
1889 common key-value definitions, or choose key names that are likely to be
1890 unique. No common key-value pairs are currently defined.
1894 <group title="Controller Status">
1895 <column name="is_connected">
1896 <code>true</code> if currently connected to this controller,
1897 <code>false</code> otherwise.
1900 <column name="role">
1901 <p>The level of authority this controller has on the associated
1902 bridge. Possible values are:</p>
1904 <dt><code>other</code></dt>
1905 <dd>Allows the controller access to all OpenFlow features.</dd>
1908 <dt><code>master</code></dt>
1909 <dd>Equivalent to <code>other</code>, except that there may be at
1910 most one master controller at a time. When a controller configures
1911 itself as <code>master</code>, any existing master is demoted to
1912 the <code>slave</code>role.</dd>
1915 <dt><code>slave</code></dt>
1916 <dd>Allows the controller read-only access to OpenFlow features.
1917 Attempts to modify the flow table will be rejected with an
1918 error. Slave controllers do not receive OFPT_PACKET_IN or
1919 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1924 <column name="status">
1925 <p>Key-value pairs that report controller status.</p>
1927 <dt><code>last_error</code></dt>
1928 <dd>A human-readable description of the last error on the connection
1929 to the controller; i.e. <code>strerror(errno)</code>. This key
1930 will exist only if an error has occurred.</dd>
1933 <dt><code>state</code></dt>
1934 <dd>The state of the connection to the controller. Possible values
1935 are: <code>VOID</code>, <code>BACKOFF</code>,
1936 <code>CONNECTING</code>, <code>ACTIVE</code>, and
1937 <code>IDLE</code>.</dd>
1940 <dt><code>time_in_state</code></dt>
1941 <dd>Seconds since connecting to (if currently connected) or
1942 disconnecting from (if currently disconnected) this
1949 <table name="Manager" title="OVSDB management connection.">
1951 Configuration for a database connection to an Open vSwitch database
1956 This table primarily configures the Open vSwitch database
1957 (<code>ovsdb-server</code>), not the Open vSwitch switch
1958 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1959 what connections should be treated as in-band.
1963 The Open vSwitch database server can initiate and maintain active
1964 connections to remote clients. It can also listen for database
1968 <group title="Core Features">
1969 <column name="target">
1970 <p>Connection method for managers.</p>
1972 The following connection methods are currently supported:
1975 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1978 The specified SSL <var>port</var> (default: 6632) on the host at
1979 the given <var>ip</var>, which must be expressed as an IP address
1980 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1981 column in the <ref table="Open_vSwitch"/> table must point to a
1982 valid SSL configuration when this form is used.
1985 SSL support is an optional feature that is not always built as
1986 part of Open vSwitch.
1990 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1992 The specified TCP <var>port</var> (default: 6632) on the host at
1993 the given <var>ip</var>, which must be expressed as an IP address
1996 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1999 Listens for SSL connections on the specified TCP <var>port</var>
2000 (default: 6632). If <var>ip</var>, which must be expressed as an
2001 IP address (not a DNS name), is specified, then connections are
2002 restricted to the specified local IP address.
2005 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2006 table="Open_vSwitch"/> table must point to a valid SSL
2007 configuration when this form is used.
2010 SSL support is an optional feature that is not always built as
2011 part of Open vSwitch.
2014 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2016 Listens for connections on the specified TCP <var>port</var>
2017 (default: 6632). If <var>ip</var>, which must be expressed as an
2018 IP address (not a DNS name), is specified, then connections are
2019 restricted to the specified local IP address.
2022 <p>When multiple managers are configured, the <ref column="target"/>
2023 values must be unique. Duplicate <ref column="target"/> values yield
2024 unspecified results.</p>
2027 <column name="connection_mode">
2029 If it is specified, this setting must be one of the following strings
2030 that describes how Open vSwitch contacts this OVSDB client over the
2035 <dt><code>in-band</code></dt>
2037 In this mode, this connection's traffic travels over a bridge
2038 managed by Open vSwitch. With this setting, Open vSwitch allows
2039 traffic to and from the client regardless of the contents of the
2040 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2041 to connect to the client, because it did not have a flow to enable
2042 it.) This is the most common connection mode because it is not
2043 necessary to maintain two independent networks.
2045 <dt><code>out-of-band</code></dt>
2047 In this mode, the client's traffic uses a control network separate
2048 from that managed by Open vSwitch, that is, Open vSwitch does not
2049 use any of its own network devices to communicate with the client.
2050 The control network must be configured separately, before or after
2051 <code>ovs-vswitchd</code> is started.
2056 If not specified, the default is implementation-specific.
2061 <group title="Client Failure Detection and Handling">
2062 <column name="max_backoff">
2063 Maximum number of milliseconds to wait between connection attempts.
2064 Default is implementation-specific.
2067 <column name="inactivity_probe">
2068 Maximum number of milliseconds of idle time on connection to the client
2069 before sending an inactivity probe message. If Open vSwitch does not
2070 communicate with the client for the specified number of seconds, it
2071 will send a probe. If a response is not received for the same
2072 additional amount of time, Open vSwitch assumes the connection has been
2073 broken and attempts to reconnect. Default is implementation-specific.
2077 <group title="Other Features">
2078 <column name="external_ids">
2079 Key-value pairs for use by external frameworks that integrate with Open
2080 vSwitch, rather than by Open vSwitch itself. System integrators should
2081 either use the Open vSwitch development mailing list to coordinate on
2082 common key-value definitions, or choose key names that are likely to be
2083 unique. No common key-value pairs are currently defined.
2087 <group title="Status">
2088 <column name="is_connected">
2089 <code>true</code> if currently connected to this manager,
2090 <code>false</code> otherwise.
2093 <column name="status">
2094 <p>Key-value pairs that report manager status.</p>
2096 <dt><code>last_error</code></dt>
2097 <dd>A human-readable description of the last error on the connection
2098 to the manager; i.e. <code>strerror(errno)</code>. This key
2099 will exist only if an error has occurred.</dd>
2102 <dt><code>state</code></dt>
2103 <dd>The state of the connection to the manager. Possible values
2104 are: <code>VOID</code> (connection is disabled),
2105 <code>BACKOFF</code> (attempting to reconnect at an increasing
2106 period), <code>CONNECT_IN_PROGRESS</code> (attempting to connect),
2107 <code>ACTIVE</code> (connected, remote host responsive), and
2108 <code>IDLE</code> (remote host unresponsive, disconnecting). These
2109 values may change in the future. They are provided only for human
2113 <dt><code>time_in_state</code></dt>
2114 <dd>Milliseconds since the <code>state</code> key changed.</dd>
2120 <table name="NetFlow">
2121 A NetFlow target. NetFlow is a protocol that exports a number of
2122 details about terminating IP flows, such as the principals involved
2125 <column name="targets">
2126 NetFlow targets in the form
2127 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2128 must be specified numerically, not as a DNS name.
2131 <column name="engine_id">
2132 Engine ID to use in NetFlow messages. Defaults to datapath index
2136 <column name="engine_type">
2137 Engine type to use in NetFlow messages. Defaults to datapath
2138 index if not specified.
2141 <column name="active_timeout">
2142 The interval at which NetFlow records are sent for flows that are
2143 still active, in seconds. A value of <code>0</code> requests the
2144 default timeout (currently 600 seconds); a value of <code>-1</code>
2145 disables active timeouts.
2148 <column name="add_id_to_interface">
2149 <p>If this column's value is <code>false</code>, the ingress and egress
2150 interface fields of NetFlow flow records are derived from OpenFlow port
2151 numbers. When it is <code>true</code>, the 7 most significant bits of
2152 these fields will be replaced by the least significant 7 bits of the
2153 engine id. This is useful because many NetFlow collectors do not
2154 expect multiple switches to be sending messages from the same host, so
2155 they do not store the engine information which could be used to
2156 disambiguate the traffic.</p>
2157 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2160 <column name="external_ids">
2161 Key-value pairs for use by external frameworks that integrate with Open
2162 vSwitch, rather than by Open vSwitch itself. System integrators should
2163 either use the Open vSwitch development mailing list to coordinate on
2164 common key-value definitions, or choose key names that are likely to be
2165 unique. No common key-value pairs are currently defined.
2170 SSL configuration for an Open_vSwitch.
2172 <column name="private_key">
2173 Name of a PEM file containing the private key used as the switch's
2174 identity for SSL connections to the controller.
2177 <column name="certificate">
2178 Name of a PEM file containing a certificate, signed by the
2179 certificate authority (CA) used by the controller and manager,
2180 that certifies the switch's private key, identifying a trustworthy
2184 <column name="ca_cert">
2185 Name of a PEM file containing the CA certificate used to verify
2186 that the switch is connected to a trustworthy controller.
2189 <column name="bootstrap_ca_cert">
2190 If set to <code>true</code>, then Open vSwitch will attempt to
2191 obtain the CA certificate from the controller on its first SSL
2192 connection and save it to the named PEM file. If it is successful,
2193 it will immediately drop the connection and reconnect, and from then
2194 on all SSL connections must be authenticated by a certificate signed
2195 by the CA certificate thus obtained. <em>This option exposes the
2196 SSL connection to a man-in-the-middle attack obtaining the initial
2197 CA certificate.</em> It may still be useful for bootstrapping.
2200 <column name="external_ids">
2201 Key-value pairs for use by external frameworks that integrate with Open
2202 vSwitch, rather than by Open vSwitch itself. System integrators should
2203 either use the Open vSwitch development mailing list to coordinate on
2204 common key-value definitions, or choose key names that are likely to be
2205 unique. No common key-value pairs are currently defined.
2209 <table name="sFlow">
2210 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2213 <column name="agent">
2214 Name of the network device whose IP address should be reported as the
2215 ``agent address'' to collectors. If not specified, the IP address
2216 defaults to the <ref table="Controller" column="local_ip"/> in the
2217 collector's <ref table="Controller"/>. If an agent IP address cannot be
2218 determined either way, sFlow is disabled.
2221 <column name="header">
2222 Number of bytes of a sampled packet to send to the collector.
2223 If not specified, the default is 128 bytes.
2226 <column name="polling">
2227 Polling rate in seconds to send port statistics to the collector.
2228 If not specified, defaults to 30 seconds.
2231 <column name="sampling">
2232 Rate at which packets should be sampled and sent to the collector.
2233 If not specified, defaults to 400, which means one out of 400
2234 packets, on average, will be sent to the collector.
2237 <column name="targets">
2238 sFlow targets in the form
2239 <code><var>ip</var>:<var>port</var></code>.
2242 <column name="external_ids">
2243 Key-value pairs for use by external frameworks that integrate with Open
2244 vSwitch, rather than by Open vSwitch itself. System integrators should
2245 either use the Open vSwitch development mailing list to coordinate on
2246 common key-value definitions, or choose key names that are likely to be
2247 unique. No common key-value pairs are currently defined.
2251 <table name="Capability">
2252 <p>Records in this table describe functionality supported by the hardware
2253 and software platform on which this Open vSwitch is based. Clients
2254 should not modify this table.</p>
2256 <p>A record in this table is meaningful only if it is referenced by the
2257 <ref table="Open_vSwitch" column="capabilities"/> column in the
2258 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2259 the record's ``category,'' determines the meanings of the
2260 <ref column="details"/> column. The following general forms of
2261 categories are currently defined:</p>
2264 <dt><code>qos-<var>type</var></code></dt>
2265 <dd><var>type</var> is supported as the value for
2266 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2270 <column name="details">
2271 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2272 depends on the category key that the <ref table="Open_vSwitch"
2273 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2274 uses to reference this record, as described above.</p>
2276 <p>The presence of a record for category <code>qos-<var>type</var></code>
2277 indicates that the switch supports <var>type</var> as the value of
2278 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2279 table. The following key-value pairs are defined to further describe
2280 QoS capabilities:</p>
2283 <dt><code>n-queues</code></dt>
2284 <dd>Number of supported queues, as a positive integer. Keys in the
2285 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2286 records whose <ref table="QoS" column="type"/> value
2287 equals <var>type</var> must range between 0 and this value minus one,
projects / cascardo / ovs.git / blob