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.0</code>.
214 If Open vSwitch was configured with a build number, then it is
215 also included, e.g. <code>1.1.0+build6579</code>.
218 <column name="db_version">
220 The database schema version number in the form
221 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
222 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
223 a non-backward compatible way (e.g. deleting a column or a table),
224 <var>major</var> is incremented. When the database schema is changed
225 in a backward compatible way (e.g. adding a new column),
226 <var>minor</var> is incremented. When the database schema is changed
227 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
232 The schema version is part of the database schema, so it can also be
233 retrieved by fetching the schema using the Open vSwitch database
238 <column name="system_type">
240 An identifier for the type of system on top of which Open vSwitch
241 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
244 System integrators are responsible for choosing and setting an
245 appropriate value for this column.
249 <column name="system_version">
251 The version of the system identified by <ref column="system_type"/>,
252 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
255 System integrators are responsible for choosing and setting an
256 appropriate value for this column.
262 <group title="Database Configuration">
264 These columns primarily configure the Open vSwitch database
265 (<code>ovsdb-server</code>), not the Open vSwitch switch
266 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
267 column="ssl"/> settings.
271 The Open vSwitch switch does read the database configuration to
272 determine remote IP addresses to which in-band control should apply.
275 <column name="manager_options">
276 Database clients to which the Open vSwitch database server should
277 connect or to which it should listen, along with options for how these
278 connection should be configured. See the <ref table="Manager"/> table
279 for more information.
284 <table name="Bridge">
286 Configuration for a bridge within an
287 <ref table="Open_vSwitch"/>.
290 A <ref table="Bridge"/> record represents an Ethernet switch with one or
291 more ``ports,'' which are the <ref table="Port"/> records pointed to by
292 the <ref table="Bridge"/>'s <ref column="ports"/> column.
295 <group title="Core Features">
297 Bridge identifier. Should be alphanumeric and no more than about 8
298 bytes long. Must be unique among the names of ports, interfaces, and
302 <column name="ports">
303 Ports included in the bridge.
306 <column name="mirrors">
307 Port mirroring configuration.
310 <column name="netflow">
311 NetFlow configuration.
314 <column name="sflow">
318 <column name="flood_vlans">
319 VLAN IDs of VLANs on which MAC address learning should be disabled, so
320 that packets are flooded instead of being sent to specific ports that
321 are believed to contain packets' destination MACs. This should
322 ordinarily be used to disable MAC learning on VLANs used for mirroring
323 (RSPAN VLANs). It may also be useful for debugging.
327 <group title="OpenFlow Configuration">
328 <column name="controller">
329 OpenFlow controller set. If unset, then no OpenFlow controllers
333 <column name="fail_mode">
334 <p>When a controller is configured, it is, ordinarily, responsible
335 for setting up all flows on the switch. Thus, if the connection to
336 the controller fails, no new network connections can be set up.
337 If the connection to the controller stays down long enough,
338 no packets can pass through the switch at all. This setting
339 determines the switch's response to such a situation. It may be set
340 to one of the following:
342 <dt><code>standalone</code></dt>
343 <dd>If no message is received from the controller for three
344 times the inactivity probe interval
345 (see <ref column="inactivity_probe"/>), then Open vSwitch
346 will take over responsibility for setting up flows. In
347 this mode, Open vSwitch causes the bridge to act like an
348 ordinary MAC-learning switch. Open vSwitch will continue
349 to retry connecting to the controller in the background
350 and, when the connection succeeds, it will discontinue its
351 standalone behavior.</dd>
352 <dt><code>secure</code></dt>
353 <dd>Open vSwitch will not set up flows on its own when the
354 controller connection fails or when no controllers are
355 defined. The bridge will continue to retry connecting to
356 any defined controllers forever.</dd>
359 <p>If this value is unset, the default is implementation-specific.</p>
360 <p>When more than one controller is configured,
361 <ref column="fail_mode"/> is considered only when none of the
362 configured controllers can be contacted.</p>
365 <column name="datapath_id">
366 Reports the OpenFlow datapath ID in use. Exactly 16 hex
367 digits. (Setting this column will have no useful effect. Set
368 <ref column="other_config"/>:<code>other-config</code>
373 <group title="Other Features">
374 <column name="datapath_type">
375 Name of datapath provider. The kernel datapath has
376 type <code>system</code>. The userspace datapath has
377 type <code>netdev</code>.
380 <column name="external_ids">
381 Key-value pairs for use by external frameworks that integrate
382 with Open vSwitch, rather than by Open vSwitch itself. System
383 integrators should either use the Open vSwitch development
384 mailing list to coordinate on common key-value definitions, or
385 choose key names that are likely to be unique. The currently
386 defined key-value pairs are:
388 <dt><code>bridge-id</code></dt>
389 <dd>A unique identifier of the bridge. On Citrix XenServer this
390 will commonly be the same as <code>xs-network-uuids</code>.</dd>
391 <dt><code>xs-network-uuids</code></dt>
392 <dd>Semicolon-delimited set of universally unique identifier(s) for
393 the network with which this bridge is associated on a Citrix
394 XenServer host. The network identifiers are RFC 4122 UUIDs as
395 displayed by, e.g., <code>xe network-list</code>.</dd>
399 <column name="other_config">
400 Key-value pairs for configuring rarely used bridge
401 features. The currently defined key-value pairs are:
403 <dt><code>datapath-id</code></dt>
405 digits to set the OpenFlow datapath ID to a specific
406 value. May not be all-zero.</dd>
407 <dt><code>disable-in-band</code></dt>
408 <dd>If set to <code>true</code>, disable in-band control on
409 the bridge regardless of controller and manager settings.</dd>
410 <dt><code>hwaddr</code></dt>
411 <dd>An Ethernet address in the form
412 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
413 to set the hardware address of the local port and influence the
415 <dt><code>in-band-queue</code></dt>
417 A queue ID as a nonnegative integer. This sets the OpenFlow queue
418 ID that will be used by flows set up by in-band control on this
419 bridge. If unset, or if the port used by an in-band control flow
420 does not have QoS configured, or if the port does not have a queue
421 with the specified ID, the default queue is used instead.
428 <table name="Port" table="Port or bond configuration.">
429 <p>A port within a <ref table="Bridge"/>.</p>
430 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
431 <ref column="interfaces"/> column. Such a port logically
432 corresponds to a port on a physical Ethernet switch. A port
433 with more than one interface is a ``bonded port'' (see
434 <ref group="Bonding Configuration"/>).</p>
435 <p>Some properties that one might think as belonging to a port are actually
436 part of the port's <ref table="Interface"/> members.</p>
439 Port name. Should be alphanumeric and no more than about 8
440 bytes long. May be the same as the interface name, for
441 non-bonded ports. Must otherwise be unique among the names of
442 ports, interfaces, and bridges on a host.
445 <column name="interfaces">
446 The port's interfaces. If there is more than one, this is a
450 <group title="VLAN Configuration">
451 <p>A bridge port must be configured for VLANs in one of two
452 mutually exclusive ways:
454 <li>A ``trunk port'' has an empty value for <ref
455 column="tag"/>. Its <ref column="trunks"/> value may be
456 empty or non-empty.</li>
457 <li>An ``implicitly tagged VLAN port'' or ``access port''
458 has an nonempty value for <ref column="tag"/>. Its
459 <ref column="trunks"/> value must be empty.</li>
461 If <ref column="trunks"/> and <ref column="tag"/> are both
462 nonempty, the configuration is ill-formed.
467 If this is an access port (see above), the port's implicitly
468 tagged VLAN. Must be empty if this is a trunk port.
471 Frames arriving on trunk ports will be forwarded to this
472 port only if they are tagged with the given VLAN (or, if
473 <ref column="tag"/> is 0, then if they lack a VLAN header).
474 Frames arriving on other access ports will be forwarded to
475 this port only if they have the same <ref column="tag"/>
476 value. Frames forwarded to this port will not have an
480 When a frame with a 802.1Q header that indicates a nonzero
481 VLAN is received on an access port, it is discarded.
485 <column name="trunks">
487 If this is a trunk port (see above), the 802.1Q VLAN(s) that
488 this port trunks; if it is empty, then the port trunks all
489 VLANs. Must be empty if this is an access port.
492 Frames arriving on trunk ports are dropped if they are not
493 in one of the specified VLANs. For this purpose, packets
494 that have no VLAN header are treated as part of VLAN 0.
499 <group title="Bonding Configuration">
500 <p>A port that has more than one interface is a ``bonded port.'' Bonding
501 allows for load balancing and fail-over. Some kinds of bonding will
502 work with any kind of upstream switch:</p>
505 <dt><code>balance-slb</code></dt>
507 Balances flows among slaves based on source MAC address and output
508 VLAN, with periodic rebalancing as traffic patterns change.
511 <dt><code>active-backup</code></dt>
513 Assigns all flows to one slave, failing over to a backup slave when
514 the active slave is disabled.
519 The following modes require the upstream switch to support 802.3ad with
520 successful LACP negotiation. If LACP negotiation fails then
521 <code>balance-slb</code> style flow hashing is used as a fallback:
525 <dt><code>balance-tcp</code></dt>
527 Balances flows among slaves based on L2, L3, and L4 protocol
528 information such as destination MAC address, IP address, and TCP
534 <dt><code>stable</code></dt>
536 <p>Attempts to always assign a given flow to the same slave
537 consistently. In an effort to maintain stability, no load
538 balancing is done. Uses a similar hashing strategy to
539 <code>balance-tcp</code>, falling back to <code>balance-slb</code>
540 style hashing when LACP negotiations are unsuccessful.</p>
541 <p>Slave selection decisions are made based on LACP port ID when LACP
542 negotiations are successful, falling back to openflow port number
543 when unsuccessful. Thus, decisions are consistent across all
544 ovs-vswitchd instances with equivalent port IDs.</p>
548 <p>These columns apply only to bonded ports. Their values are
549 otherwise ignored.</p>
551 <column name="bond_mode">
552 <p>The type of bonding used for a bonded port. Defaults to
553 <code>balance-slb</code> if unset.
557 <column name="bond_updelay">
558 <p>For a bonded port, the number of milliseconds for which carrier must
559 stay up on an interface before the interface is considered to be up.
560 Specify <code>0</code> to enable the interface immediately.</p>
561 <p>This setting is honored only when at least one bonded interface is
562 already enabled. When no interfaces are enabled, then the first bond
563 interface to come up is enabled immediately.</p>
566 <column name="bond_downdelay">
567 For a bonded port, the number of milliseconds for which carrier must
568 stay down on an interface before the interface is considered to be
569 down. Specify <code>0</code> to disable the interface immediately.
572 <column name="bond_fake_iface">
573 For a bonded port, whether to create a fake internal interface with the
574 name of the port. Use only for compatibility with legacy software that
579 <p>Configures LACP on this port. LACP allows directly connected
580 switchs to negotiate which links may be bonded. LACP may be enabled
581 on non-bonded ports for the benefit of any switchs they may be
582 connected to. <code>active</code> ports are allowed to initiate LACP
583 negotiations. <code>passive</code> ports are allowed to participate
584 in LACP negotiations initiated by a remote switch, but not allowed to
585 initiate such negotiations themselves. If unset Open vSwitch will
586 choose a reasonable default. </p>
591 <group title="Other Features">
593 Quality of Service configuration for this port.
597 The MAC address to use for this port for the purpose of choosing the
598 bridge's MAC address. This column does not necessarily reflect the
599 port's actual MAC address, nor will setting it change the port's actual
603 <column name="fake_bridge">
604 Does this port represent a sub-bridge for its tagged VLAN within the
605 Bridge? See ovs-vsctl(8) for more information.
608 <column name="external_ids">
610 Key-value pairs for use by external frameworks that integrate with
611 Open vSwitch, rather than by Open vSwitch itself. System integrators
612 should either use the Open vSwitch development mailing list to
613 coordinate on common key-value definitions, or choose key names that
614 are likely to be unique.
617 No key-value pairs native to <ref table="Port"/> are currently
618 defined. For fake bridges (see the <ref column="fake_bridge"/>
619 column), external IDs for the fake bridge are defined here by
620 prefixing a <ref table="Bridge"/> <ref table="Bridge"
621 column="external_ids"/> key with <code>fake-bridge-</code>,
622 e.g. <code>fake-bridge-xs-network-uuids</code>.
626 <column name="other_config">
627 Key-value pairs for configuring rarely used port features. The
628 currently defined key-value pairs are:
630 <dt><code>hwaddr</code></dt>
631 <dd>An Ethernet address in the form
632 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
633 <dt><code>bond-rebalance-interval</code></dt>
634 <dd>For an SLB bonded port, the number of milliseconds between
635 successive attempts to rebalance the bond, that is, to
636 move source MACs and their flows from one interface on
637 the bond to another in an attempt to keep usage of each
638 interface roughly equal. The default is 10000 (10
639 seconds), and the minimum is 1000 (1 second).</dd>
640 <dt><code>bond-detect-mode</code></dt>
641 <dd> Sets the method used to detect link failures in a bonded port.
642 Options are <code>carrier</code> and <code>miimon</code>. Defaults
643 to <code>carrier</code> which uses each interface's carrier to detect
644 failures. When set to <code>miimon</code>, will check for failures
645 by polling each interface's MII. </dd>
646 <dt><code>bond-miimon-interval</code></dt>
647 <dd> The number of milliseconds between successive attempts to
648 poll each interface's MII. Only relevant on ports which use
649 <code>miimon</code> to detect failures. </dd>
650 <dt><code>lacp-system-priority</code></dt>
651 <dd> The LACP system priority of this <ref table="Port"/>. In
652 LACP negotiations, link status decisions are made by the system
653 with the numerically lower priority. Must be a number between 1
655 <dt><code>lacp-time</code></dt>
656 <dd> The LACP timing which should be used on this
657 <ref table="Port"/>. Possible values are <code>fast</code> and
658 <code>slow</code>. By default <code>slow</code> is used. When
659 configured to be <code>fast</code> more frequent LACP heartbeats
660 will be requested causing connectivity problems to be detected more
662 <dt><code>lacp-strict</code></dt>
663 <dd> When <code>true</code>, configures this <ref table="Port"/> to
664 require successful LACP negotiations to enable any slaves.
665 Defaults to <code>false</code> which safely allows LACP to be used
666 with switchs that do not support the protocol.</dd>
672 <table name="Interface" title="One physical network device in a Port.">
673 An interface within a <ref table="Port"/>.
675 <group title="Core Features">
677 Interface name. Should be alphanumeric and no more than about 8 bytes
678 long. May be the same as the port name, for non-bonded ports. Must
679 otherwise be unique among the names of ports, interfaces, and bridges
684 <p>Ethernet address to set for this interface. If unset then the
685 default MAC address is used:</p>
687 <li>For the local interface, the default is the lowest-numbered MAC
688 address among the other bridge ports, either the value of the
689 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
690 if set, or its actual MAC (for bonded ports, the MAC of its slave
691 whose name is first in alphabetical order). Internal ports and
692 bridge ports that are used as port mirroring destinations (see the
693 <ref table="Mirror"/> table) are ignored.</li>
694 <li>For other internal interfaces, the default MAC is randomly
696 <li>External interfaces typically have a MAC address associated with
699 <p>Some interfaces may not have a software-controllable MAC
703 <column name="ofport">
704 <p>OpenFlow port number for this interface. Unlike most columns, this
705 column's value should be set only by Open vSwitch itself. Other
706 clients should set this column to an empty set (the default) when
707 creating an <ref table="Interface"/>.</p>
708 <p>Open vSwitch populates this column when the port number becomes
709 known. If the interface is successfully added,
710 <ref column="ofport"/> will be set to a number between 1 and 65535
711 (generally either in the range 1 to 65279, inclusive, or 65534, the
712 port number for the OpenFlow ``local port''). If the interface
713 cannot be added then Open vSwitch sets this column
718 <group title="System-Specific Details">
720 The interface type, one of:
722 <dt><code>system</code></dt>
723 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
724 Sometimes referred to as ``external interfaces'' since they are
725 generally connected to hardware external to that on which the Open
726 vSwitch is running. The empty string is a synonym for
727 <code>system</code>.</dd>
728 <dt><code>internal</code></dt>
729 <dd>A simulated network device that sends and receives traffic. An
730 internal interface whose <ref column="name"/> is the same as its
731 bridge's <ref table="Open_vSwitch" column="name"/> is called the
732 ``local interface.'' It does not make sense to bond an internal
733 interface, so the terms ``port'' and ``interface'' are often used
734 imprecisely for internal interfaces.</dd>
735 <dt><code>tap</code></dt>
736 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
737 <dt><code>gre</code></dt>
738 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
739 tunnel. Each tunnel must be uniquely identified by the
740 combination of <code>remote_ip</code>, <code>local_ip</code>, and
741 <code>in_key</code>. Note that if two ports are defined that are
742 the same except one has an optional identifier and the other does
743 not, the more specific one is matched first. <code>in_key</code>
744 is considered more specific than <code>local_ip</code> if a port
745 defines one and another port defines the other. The following
746 options may be specified in the <ref column="options"/> column:
748 <dt><code>remote_ip</code></dt>
749 <dd>Required. The tunnel endpoint.</dd>
752 <dt><code>local_ip</code></dt>
753 <dd>Optional. The destination IP that received packets must
754 match. Default is to match all addresses.</dd>
757 <dt><code>in_key</code></dt>
758 <dd>Optional. The GRE key that received packets must contain.
759 It may either be a 32-bit number (no key and a key of 0 are
760 treated as equivalent) or the word <code>flow</code>. If
761 <code>flow</code> is specified then any key will be accepted
762 and the key will be placed in the <code>tun_id</code> field
763 for matching in the flow table. The ovs-ofctl manual page
764 contains additional information about matching fields in
765 OpenFlow flows. Default is no key.</dd>
768 <dt><code>out_key</code></dt>
769 <dd>Optional. The GRE key to be set on outgoing packets. It may
770 either be a 32-bit number or the word <code>flow</code>. If
771 <code>flow</code> is specified then the key may be set using
772 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
773 is used in the absence of an action). The ovs-ofctl manual
774 page contains additional information about the Nicira OpenFlow
775 vendor extensions. Default is no key.</dd>
778 <dt><code>key</code></dt>
779 <dd>Optional. Shorthand to set <code>in_key</code> and
780 <code>out_key</code> at the same time.</dd>
783 <dt><code>tos</code></dt>
784 <dd>Optional. The value of the ToS bits to be set on the
785 encapsulating packet. It may also be the word
786 <code>inherit</code>, in which case the ToS will be copied from
787 the inner packet if it is IPv4 or IPv6 (otherwise it will be
788 0). Note that the ECN fields are always inherited. Default is
792 <dt><code>ttl</code></dt>
793 <dd>Optional. The TTL to be set on the encapsulating packet.
794 It may also be the word <code>inherit</code>, in which case the
795 TTL will be copied from the inner packet if it is IPv4 or IPv6
796 (otherwise it will be the system default, typically 64).
797 Default is the system default TTL.</dd>
800 <dt><code>csum</code></dt>
801 <dd>Optional. Compute GRE checksums on outgoing packets.
802 Checksums present on incoming packets will be validated
803 regardless of this setting. Note that GRE checksums
804 impose a significant performance penalty as they cover the
805 entire packet. As the contents of the packet is typically
806 covered by L3 and L4 checksums, this additional checksum only
807 adds value for the GRE and encapsulated Ethernet headers.
808 Default is disabled, set to <code>true</code> to enable.</dd>
811 <dt><code>pmtud</code></dt>
812 <dd>Optional. Enable tunnel path MTU discovery. If enabled
813 ``ICMP destination unreachable - fragmentation'' needed
814 messages will be generated for IPv4 packets with the DF bit set
815 and IPv6 packets above the minimum MTU if the packet size
816 exceeds the path MTU minus the size of the tunnel headers. It
817 also forces the encapsulating packet DF bit to be set (it is
818 always set if the inner packet implies path MTU discovery).
819 Note that this option causes behavior that is typically
820 reserved for routers and therefore is not entirely in
821 compliance with the IEEE 802.1D specification for bridges.
822 Default is enabled, set to <code>false</code> to disable.</dd>
825 <dt><code>header_cache</code></dt>
826 <dd>Optional. Enable caching of tunnel headers and the output
827 path. This can lead to a significant performance increase
828 without changing behavior. In general it should not be
829 necessary to adjust this setting. However, the caching can
830 bypass certain components of the IP stack (such as IP tables)
831 and it may be useful to disable it if these features are
832 required or as a debugging measure. Default is enabled, set to
833 <code>false</code> to disable.</dd>
836 <dt><code>ipsec_gre</code></dt>
837 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
838 over IPv4 IPsec tunnel. Each tunnel (including those of type
839 <code>gre</code>) must be uniquely identified by the
840 combination of <code>remote_ip</code> and
841 <code>local_ip</code>. Note that if two ports are defined
842 that are the same except one has an optional identifier and
843 the other does not, the more specific one is matched first.
844 An authentication method of <code>peer_cert</code> or
845 <code>psk</code> must be defined. The following options may
846 be specified in the <ref column="options"/> column:
848 <dt><code>remote_ip</code></dt>
849 <dd>Required. The tunnel endpoint.</dd>
852 <dt><code>local_ip</code></dt>
853 <dd>Optional. The destination IP that received packets must
854 match. Default is to match all addresses.</dd>
857 <dt><code>peer_cert</code></dt>
858 <dd>Required for certificate authentication. A string
859 containing the peer's certificate in PEM format.
860 Additionally the host's certificate must be specified
861 with the <code>certificate</code> option.</dd>
864 <dt><code>certificate</code></dt>
865 <dd>Required for certificate authentication. The name of a
866 PEM file containing a certificate that will be presented
867 to the peer during authentication.</dd>
870 <dt><code>private_key</code></dt>
871 <dd>Optional for certificate authentication. The name of
872 a PEM file containing the private key associated with
873 <code>certificate</code>. If <code>certificate</code>
874 contains the private key, this option may be omitted.</dd>
877 <dt><code>psk</code></dt>
878 <dd>Required for pre-shared key authentication. Specifies a
879 pre-shared key for authentication that must be identical on
880 both sides of the tunnel.</dd>
883 <dt><code>in_key</code></dt>
884 <dd>Optional. The GRE key that received packets must contain.
885 It may either be a 32-bit number (no key and a key of 0 are
886 treated as equivalent) or the word <code>flow</code>. If
887 <code>flow</code> is specified then any key will be accepted
888 and the key will be placed in the <code>tun_id</code> field
889 for matching in the flow table. The ovs-ofctl manual page
890 contains additional information about matching fields in
891 OpenFlow flows. Default is no key.</dd>
894 <dt><code>out_key</code></dt>
895 <dd>Optional. The GRE key to be set on outgoing packets. It may
896 either be a 32-bit number or the word <code>flow</code>. If
897 <code>flow</code> is specified then the key may be set using
898 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
899 is used in the absence of an action). The ovs-ofctl manual
900 page contains additional information about the Nicira OpenFlow
901 vendor extensions. Default is no key.</dd>
904 <dt><code>key</code></dt>
905 <dd>Optional. Shorthand to set <code>in_key</code> and
906 <code>out_key</code> at the same time.</dd>
909 <dt><code>tos</code></dt>
910 <dd>Optional. The value of the ToS bits to be set on the
911 encapsulating packet. It may also be the word
912 <code>inherit</code>, in which case the ToS will be copied from
913 the inner packet if it is IPv4 or IPv6 (otherwise it will be
914 0). Note that the ECN fields are always inherited. Default is
918 <dt><code>ttl</code></dt>
919 <dd>Optional. The TTL to be set on the encapsulating packet.
920 It may also be the word <code>inherit</code>, in which case the
921 TTL will be copied from the inner packet if it is IPv4 or IPv6
922 (otherwise it will be the system default, typically 64).
923 Default is the system default TTL.</dd>
926 <dt><code>csum</code></dt>
927 <dd>Optional. Compute GRE checksums on outgoing packets.
928 Checksums present on incoming packets will be validated
929 regardless of this setting. Note that GRE checksums
930 impose a significant performance penalty as they cover the
931 entire packet. As the contents of the packet is typically
932 covered by L3 and L4 checksums, this additional checksum only
933 adds value for the GRE and encapsulated Ethernet headers.
934 Default is disabled, set to <code>true</code> to enable.</dd>
937 <dt><code>pmtud</code></dt>
938 <dd>Optional. Enable tunnel path MTU discovery. If enabled
939 ``ICMP destination unreachable - fragmentation'' needed
940 messages will be generated for IPv4 packets with the DF bit set
941 and IPv6 packets above the minimum MTU if the packet size
942 exceeds the path MTU minus the size of the tunnel headers. It
943 also forces the encapsulating packet DF bit to be set (it is
944 always set if the inner packet implies path MTU discovery).
945 Note that this option causes behavior that is typically
946 reserved for routers and therefore is not entirely in
947 compliance with the IEEE 802.1D specification for bridges.
948 Default is enabled, set to <code>false</code> to disable.</dd>
951 <dt><code>capwap</code></dt>
952 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
953 (RFC 5415). This allows interoperability with certain switches
954 where GRE is not available. Note that only the tunneling component
955 of the protocol is implemented. Due to the non-standard use of
956 CAPWAP, UDP ports 58881 and 58882 are used as the source and
957 destination ports respectively. Each tunnel must be uniquely
958 identified by the combination of <code>remote_ip</code> and
959 <code>local_ip</code>. If two ports are defined that are the same
960 except one includes <code>local_ip</code> and the other does not,
961 the more specific one is matched first. CAPWAP support is not
962 available on all platforms. Currently it is only supported in the
963 Linux kernel module with kernel versions >= 2.6.25. The following
964 options may be specified in the <ref column="options"/> column:
966 <dt><code>remote_ip</code></dt>
967 <dd>Required. The tunnel endpoint.</dd>
970 <dt><code>local_ip</code></dt>
971 <dd>Optional. The destination IP that received packets must
972 match. Default is to match all addresses.</dd>
975 <dt><code>tos</code></dt>
976 <dd>Optional. The value of the ToS bits to be set on the
977 encapsulating packet. It may also be the word
978 <code>inherit</code>, in which case the ToS will be copied from
979 the inner packet if it is IPv4 or IPv6 (otherwise it will be
980 0). Note that the ECN fields are always inherited. Default is
984 <dt><code>ttl</code></dt>
985 <dd>Optional. The TTL to be set on the encapsulating packet.
986 It may also be the word <code>inherit</code>, in which case the
987 TTL will be copied from the inner packet if it is IPv4 or IPv6
988 (otherwise it will be the system default, typically 64).
989 Default is the system default TTL.</dd>
992 <dt><code>pmtud</code></dt>
993 <dd>Optional. Enable tunnel path MTU discovery. If enabled
994 ``ICMP destination unreachable - fragmentation'' needed
995 messages will be generated for IPv4 packets with the DF bit set
996 and IPv6 packets above the minimum MTU if the packet size
997 exceeds the path MTU minus the size of the tunnel headers. It
998 also forces the encapsulating packet DF bit to be set (it is
999 always set if the inner packet implies path MTU discovery).
1000 Note that this option causes behavior that is typically
1001 reserved for routers and therefore is not entirely in
1002 compliance with the IEEE 802.1D specification for bridges.
1003 Default is enabled, set to <code>false</code> to disable.</dd>
1006 <dt><code>header_cache</code></dt>
1007 <dd>Optional. Enable caching of tunnel headers and the output
1008 path. This can lead to a significant performance increase
1009 without changing behavior. In general it should not be
1010 necessary to adjust this setting. However, the caching can
1011 bypass certain components of the IP stack (such as IP tables)
1012 and it may be useful to disable it if these features are
1013 required or as a debugging measure. Default is enabled, set to
1014 <code>false</code> to disable.</dd>
1017 <dt><code>patch</code></dt>
1020 A pair of virtual devices that act as a patch cable. The <ref
1021 column="options"/> column must have the following key-value pair:
1024 <dt><code>peer</code></dt>
1026 The <ref column="name"/> of the <ref table="Interface"/> for
1027 the other side of the patch. The named <ref
1028 table="Interface"/>'s own <code>peer</code> option must specify
1029 this <ref table="Interface"/>'s name. That is, the two patch
1030 interfaces must have reversed <ref column="name"/> and
1031 <code>peer</code> values.
1038 <column name="options">
1039 Configuration options whose interpretation varies based on
1040 <ref column="type"/>.
1044 <group title="Interface Status">
1046 Status information about interfaces attached to bridges, updated every
1047 5 seconds. Not all interfaces have all of these properties; virtual
1048 interfaces don't have a link speed, for example. Non-applicable
1049 columns will have empty values.
1051 <column name="admin_state">
1053 The administrative state of the physical network link.
1057 <column name="link_state">
1059 The observed state of the physical network link. This is ordinarily
1060 the link's carrier status. If the interface's <ref table="Port"/> is
1061 a bond configured for miimon monitoring, it is instead the network
1062 link's miimon status.
1066 <column name="link_speed">
1068 The negotiated speed of the physical network link.
1069 Valid values are positive integers greater than 0.
1073 <column name="duplex">
1075 The duplex mode of the physical network link.
1081 The MTU (maximum transmission unit); i.e. the largest
1082 amount of data that can fit into a single Ethernet frame.
1083 The standard Ethernet MTU is 1500 bytes. Some physical media
1084 and many kinds of virtual interfaces can be configured with
1088 This column will be empty for an interface that does not
1089 have an MTU as, for example, some kinds of tunnels do not.
1093 <column name="status">
1095 Key-value pairs that report port status. Supported status
1096 values are <code>type</code>-dependent; some interfaces may not have
1097 a valid <code>driver_name</code>, for example.
1099 <p>The currently defined key-value pairs are:</p>
1101 <dt><code>driver_name</code></dt>
1102 <dd>The name of the device driver controlling the network
1106 <dt><code>driver_version</code></dt>
1107 <dd>The version string of the device driver controlling the
1108 network adapter.</dd>
1111 <dt><code>firmware_version</code></dt>
1112 <dd>The version string of the network adapter's firmware, if
1116 <dt><code>source_ip</code></dt>
1117 <dd>The source IP address used for an IPv4 tunnel end-point,
1118 such as <code>gre</code> or <code>capwap</code>.</dd>
1121 <dt><code>tunnel_egress_iface</code></dt>
1122 <dd>Egress interface for tunnels. Currently only relevant for GRE
1123 and CAPWAP tunnels. On Linux systems, this column will show
1124 the name of the interface which is responsible for routing
1125 traffic destined for the configured <code>remote_ip</code>.
1126 This could be an internal interface such as a bridge port.</dd>
1129 <dt><code>tunnel_egress_iface_carrier</code></dt>
1130 <dd>Whether a carrier is detected on <ref
1131 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1132 and <code>up</code>.</dd>
1137 <group title="Ingress Policing">
1139 These settings control ingress policing for packets received on this
1140 interface. On a physical interface, this limits the rate at which
1141 traffic is allowed into the system from the outside; on a virtual
1142 interface (one connected to a virtual machine), this limits the rate at
1143 which the VM is able to transmit.
1146 Policing is a simple form of quality-of-service that simply drops
1147 packets received in excess of the configured rate. Due to its
1148 simplicity, policing is usually less accurate and less effective than
1149 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1150 table="Queue"/> tables).
1153 Policing is currently implemented only on Linux. The Linux
1154 implementation uses a simple ``token bucket'' approach:
1158 The size of the bucket corresponds to <ref
1159 column="ingress_policing_burst"/>. Initially the bucket is full.
1162 Whenever a packet is received, its size (converted to tokens) is
1163 compared to the number of tokens currently in the bucket. If the
1164 required number of tokens are available, they are removed and the
1165 packet is forwarded. Otherwise, the packet is dropped.
1168 Whenever it is not full, the bucket is refilled with tokens at the
1169 rate specified by <ref column="ingress_policing_rate"/>.
1173 Policing interacts badly with some network protocols, and especially
1174 with fragmented IP packets. Suppose that there is enough network
1175 activity to keep the bucket nearly empty all the time. Then this token
1176 bucket algorithm will forward a single packet every so often, with the
1177 period depending on packet size and on the configured rate. All of the
1178 fragments of an IP packets are normally transmitted back-to-back, as a
1179 group. In such a situation, therefore, only one of these fragments
1180 will be forwarded and the rest will be dropped. IP does not provide
1181 any way for the intended recipient to ask for only the remaining
1182 fragments. In such a case there are two likely possibilities for what
1183 will happen next: either all of the fragments will eventually be
1184 retransmitted (as TCP will do), in which case the same problem will
1185 recur, or the sender will not realize that its packet has been dropped
1186 and data will simply be lost (as some UDP-based protocols will do).
1187 Either way, it is possible that no forward progress will ever occur.
1189 <column name="ingress_policing_rate">
1191 Maximum rate for data received on this interface, in kbps. Data
1192 received faster than this rate is dropped. Set to <code>0</code>
1193 (the default) to disable policing.
1197 <column name="ingress_policing_burst">
1198 <p>Maximum burst size for data received on this interface, in kb. The
1199 default burst size if set to <code>0</code> is 1000 kb. This value
1200 has no effect if <ref column="ingress_policing_rate"/>
1201 is <code>0</code>.</p>
1203 Specifying a larger burst size lets the algorithm be more forgiving,
1204 which is important for protocols like TCP that react severely to
1205 dropped packets. The burst size should be at least the size of the
1206 interface's MTU. Specifying a value that is numerically at least as
1207 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1208 closer to achieving the full rate.
1213 <group title="Other Features">
1215 <column name="monitor">
1216 Connectivity monitor configuration for this interface.
1219 <column name="lacp_current">
1220 Boolean value indicating LACP status for this interface. If true, this
1221 interface has current LACP information about its LACP partner. This
1222 information may be used to monitor the health of interfaces in a LACP
1223 enabled port. This column will be empty if LACP is not enabled.
1226 <column name="external_ids">
1227 Key-value pairs for use by external frameworks that integrate
1228 with Open vSwitch, rather than by Open vSwitch itself. System
1229 integrators should either use the Open vSwitch development
1230 mailing list to coordinate on common key-value definitions, or
1231 choose key names that are likely to be unique. The currently
1232 defined common key-value pairs are:
1234 <dt><code>attached-mac</code></dt>
1236 The MAC address programmed into the ``virtual hardware'' for this
1237 interface, in the form
1238 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1239 For Citrix XenServer, this is the value of the <code>MAC</code>
1240 field in the VIF record for this interface.</dd>
1241 <dt><code>iface-id</code></dt>
1242 <dd>A system-unique identifier for the interface. On XenServer,
1243 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1246 Additionally the following key-value pairs specifically
1247 apply to an interface that represents a virtual Ethernet interface
1248 connected to a virtual machine. These key-value pairs should not be
1249 present for other types of interfaces. Keys whose names end
1250 in <code>-uuid</code> have values that uniquely identify the entity
1251 in question. For a Citrix XenServer hypervisor, these values are
1252 UUIDs in RFC 4122 format. Other hypervisors may use other
1255 <p>The currently defined key-value pairs for XenServer are:</p>
1257 <dt><code>xs-vif-uuid</code></dt>
1258 <dd>The virtual interface associated with this interface.</dd>
1259 <dt><code>xs-network-uuid</code></dt>
1260 <dd>The virtual network to which this interface is attached.</dd>
1261 <dt><code>xs-vm-uuid</code></dt>
1262 <dd>The VM to which this interface belongs.</dd>
1266 <column name="other_config">
1267 Key-value pairs for rarely used interface features.
1269 <dt><code>lacp-port-priority</code></dt>
1270 <dd> The LACP port priority of this <ref table="Interface"/>. In
1271 LACP negotiations <ref table="Interface"/>s with numerically lower
1272 priorities are preferred for aggregation. Must be a number between
1277 <column name="statistics">
1279 Key-value pairs that report interface statistics. The current
1280 implementation updates these counters periodically. In the future,
1281 we plan to, instead, update them when an interface is created, when
1282 they are queried (e.g. using an OVSDB <code>select</code> operation),
1283 and just before an interface is deleted due to virtual interface
1284 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1285 regular periodic basis.</p>
1287 The currently defined key-value pairs are listed below. These are
1288 the same statistics reported by OpenFlow in its <code>struct
1289 ofp_port_stats</code> structure. If an interface does not support a
1290 given statistic, then that pair is omitted.</p>
1293 Successful transmit and receive counters:
1295 <dt><code>rx_packets</code></dt>
1296 <dd>Number of received packets.</dd>
1297 <dt><code>rx_bytes</code></dt>
1298 <dd>Number of received bytes.</dd>
1299 <dt><code>tx_packets</code></dt>
1300 <dd>Number of transmitted packets.</dd>
1301 <dt><code>tx_bytes</code></dt>
1302 <dd>Number of transmitted bytes.</dd>
1308 <dt><code>rx_dropped</code></dt>
1309 <dd>Number of packets dropped by RX.</dd>
1310 <dt><code>rx_frame_err</code></dt>
1311 <dd>Number of frame alignment errors.</dd>
1312 <dt><code>rx_over_err</code></dt>
1313 <dd>Number of packets with RX overrun.</dd>
1314 <dt><code>rx_crc_err</code></dt>
1315 <dd>Number of CRC errors.</dd>
1316 <dt><code>rx_errors</code></dt>
1318 Total number of receive errors, greater than or equal
1319 to the sum of the above.
1326 <dt><code>tx_dropped</code></dt>
1327 <dd>Number of packets dropped by TX.</dd>
1328 <dt><code>collisions</code></dt>
1329 <dd>Number of collisions.</dd>
1330 <dt><code>tx_errors</code></dt>
1332 Total number of transmit errors, greater
1333 than or equal to the sum of the above.
1342 <table name="QoS" title="Quality of Service configuration">
1343 <p>Quality of Service (QoS) configuration for each Port that
1346 <column name="type">
1347 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1348 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1349 identifies the types that a switch actually supports. The currently
1350 defined types are listed below:</p>
1352 <dt><code>linux-htb</code></dt>
1354 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1355 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1356 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1357 for information on how this classifier works and how to configure it.
1361 <dt><code>linux-hfsc</code></dt>
1363 Linux "Hierarchical Fair Service Curve" classifier.
1364 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1365 information on how this classifier works.
1370 <column name="queues">
1371 <p>A map from queue numbers to <ref table="Queue"/> records. The
1372 supported range of queue numbers depend on <ref column="type"/>. The
1373 queue numbers are the same as the <code>queue_id</code> used in
1374 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1375 structures. Queue 0 is used by OpenFlow output actions that do not
1376 specify a specific queue.</p>
1379 <column name="other_config">
1380 <p>Key-value pairs for configuring QoS features that depend on
1381 <ref column="type"/>.</p>
1382 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1383 the following key-value pairs:</p>
1385 <dt><code>max-rate</code></dt>
1386 <dd>Maximum rate shared by all queued traffic, in bit/s.
1387 Optional. If not specified, for physical interfaces, the
1388 default is the link rate. For other interfaces or if the
1389 link rate cannot be determined, the default is currently 100
1394 <column name="external_ids">
1395 Key-value pairs for use by external frameworks that integrate with Open
1396 vSwitch, rather than by Open vSwitch itself. System integrators should
1397 either use the Open vSwitch development mailing list to coordinate on
1398 common key-value definitions, or choose key names that are likely to be
1399 unique. No common key-value pairs are currently defined.
1403 <table name="Queue" title="QoS output queue.">
1404 <p>A configuration for a port output queue, used in configuring Quality of
1405 Service (QoS) features. May be referenced by <ref column="queues"
1406 table="QoS"/> column in <ref table="QoS"/> table.</p>
1408 <column name="other_config">
1409 <p>Key-value pairs for configuring the output queue. The supported
1410 key-value pairs and their meanings depend on the <ref column="type"/>
1411 of the <ref column="QoS"/> records that reference this row.</p>
1412 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1413 column="type"/> of <code>min-rate</code> are:</p>
1415 <dt><code>min-rate</code></dt>
1416 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1417 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1419 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1420 column="type"/> of <code>linux-htb</code> are:</p>
1422 <dt><code>min-rate</code></dt>
1423 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1424 <dt><code>max-rate</code></dt>
1425 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1426 queue's rate will not be allowed to exceed the specified value, even
1427 if excess bandwidth is available. If unspecified, defaults to no
1429 <dt><code>burst</code></dt>
1430 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1431 that a queue can accumulate while it is idle. Optional. Details of
1432 the <code>linux-htb</code> implementation require a minimum burst
1433 size, so a too-small <code>burst</code> will be silently
1435 <dt><code>priority</code></dt>
1436 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1437 unspecified. A queue with a smaller <code>priority</code>
1438 will receive all the excess bandwidth that it can use before
1439 a queue with a larger value receives any. Specific priority
1440 values are unimportant; only relative ordering matters.</dd>
1442 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1443 column="type"/> of <code>linux-hfsc</code> are:</p>
1445 <dt><code>min-rate</code></dt>
1446 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1447 <dt><code>max-rate</code></dt>
1448 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1449 queue's rate will not be allowed to exceed the specified value, even
1450 if excess bandwidth is available. If unspecified, defaults to no
1455 <column name="external_ids">
1456 Key-value pairs for use by external frameworks that integrate with Open
1457 vSwitch, rather than by Open vSwitch itself. System integrators should
1458 either use the Open vSwitch development mailing list to coordinate on
1459 common key-value definitions, or choose key names that are likely to be
1460 unique. No common key-value pairs are currently defined.
1464 <table name="Monitor" title="Connectivity Monitor configuration">
1466 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1467 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1468 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1469 to detect connectivity problems with each other. MPs within a MA should
1470 have complete and exclusive interconnectivity. This is verified by
1471 occasionally broadcasting Continuity Check Messages (CCMs) at a
1472 configurable transmission interval. A <ref table="Monitor"/> is
1473 responsible for collecting data about other MPs in its MA and
1477 <group title="Monitor Configuration">
1478 <column name="mpid">
1479 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1480 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1481 used to identify this <ref table="Monitor"/> to other endpoints in the
1485 <column name="remote_mps">
1486 A set of <ref table="Maintenance_Points"/> which this
1487 <ref table="Monitor"/> should have connectivity to. If this
1488 <ref table="Monitor"/> does not have connectivity to any MPs in this
1489 set, or has connectivity to any MPs not in this set, a fault is
1493 <column name="ma_name">
1494 A Maintenance Association (MA) name pairs with a Maintenance Domain
1495 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1496 have complete and exclusive interconnectivity. Defaults to
1497 <code>ovs</code> if unset.
1500 <column name="md_name">
1501 A Maintenance Domain name pairs with a Maintenance Association name to
1502 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1505 <column name="interval">
1506 The transmission interval of CCMs in milliseconds. Three missed CCMs
1507 indicate a connectivity fault. Defaults to 1000ms.
1511 <group title="Monitor Status">
1512 <column name="fault">
1513 Indicates a Connectivity Fault caused by a configuration error, a down
1514 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1519 <table name="Maintenance_Point" title="Maintenance Point configuration">
1521 A <ref table="Maintenance_Point"/> represents a MP which a
1522 <ref table="Monitor"/> has or should have connectivity to.
1525 <group title="Maintenance_Point Configuration">
1526 <column name="mpid">
1527 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1528 a Maintenance Association. All MPs within a MA should have a unique
1533 <group title="Maintenance_Point Status">
1534 <column name="fault">
1535 Indicates a connectivity fault.
1540 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1541 <p>A port mirror within a <ref table="Bridge"/>.</p>
1542 <p>A port mirror configures a bridge to send selected frames to special
1543 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1544 traffic may also be referred to as SPAN or RSPAN, depending on the
1545 mechanism used for delivery.</p>
1547 <column name="name">
1548 Arbitrary identifier for the <ref table="Mirror"/>.
1551 <group title="Selecting Packets for Mirroring">
1553 To be selected for mirroring, a given packet must enter or leave the
1554 bridge through a selected port and it must also be in one of the
1558 <column name="select_all">
1559 If true, every packet arriving or departing on any port is
1560 selected for mirroring.
1563 <column name="select_dst_port">
1564 Ports on which departing packets are selected for mirroring.
1567 <column name="select_src_port">
1568 Ports on which arriving packets are selected for mirroring.
1571 <column name="select_vlan">
1572 VLANs on which packets are selected for mirroring. An empty set
1573 selects packets on all VLANs.
1577 <group title="Mirroring Destination Configuration">
1579 These columns are mutually exclusive. Exactly one of them must be
1583 <column name="output_port">
1584 <p>Output port for selected packets, if nonempty.</p>
1585 <p>Specifying a port for mirror output reserves that port exclusively
1586 for mirroring. No frames other than those selected for mirroring
1587 will be forwarded to the port, and any frames received on the port
1588 will be discarded.</p>
1589 <p>This type of mirroring is sometimes called SPAN.</p>
1592 <column name="output_vlan">
1593 <p>Output VLAN for selected packets, if nonempty.</p>
1594 <p>The frames will be sent out all ports that trunk
1595 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1596 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1597 trunk port, the frame's VLAN tag will be set to
1598 <ref column="output_vlan"/>, replacing any existing tag; when it is
1599 sent out an implicit VLAN port, the frame will not be tagged. This
1600 type of mirroring is sometimes called RSPAN.</p>
1601 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1602 contains unmanaged switches. Consider an unmanaged physical switch
1603 with two ports: port 1, connected to an end host, and port 2,
1604 connected to an Open vSwitch configured to mirror received packets
1605 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1606 port 1 that the physical switch forwards to port 2. The Open vSwitch
1607 forwards this packet to its destination and then reflects it back on
1608 port 2 in VLAN 123. This reflected packet causes the unmanaged
1609 physical switch to replace the MAC learning table entry, which
1610 correctly pointed to port 1, with one that incorrectly points to port
1611 2. Afterward, the physical switch will direct packets destined for
1612 the end host to the Open vSwitch on port 2, instead of to the end
1613 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1614 desired in this scenario, then the physical switch must be replaced
1615 by one that learns Ethernet addresses on a per-VLAN basis. In
1616 addition, learning should be disabled on the VLAN containing mirrored
1617 traffic. If this is not done then intermediate switches will learn
1618 the MAC address of each end host from the mirrored traffic. If
1619 packets being sent to that end host are also mirrored, then they will
1620 be dropped since the switch will attempt to send them out the input
1621 port. Disabling learning for the VLAN will cause the switch to
1622 correctly send the packet out all ports configured for that VLAN. If
1623 Open vSwitch is being used as an intermediate switch, learning can be
1624 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1625 in the appropriate <ref table="Bridge"/> table or tables.</p>
1629 <group title="Other Features">
1630 <column name="external_ids">
1631 Key-value pairs for use by external frameworks that integrate with Open
1632 vSwitch, rather than by Open vSwitch itself. System integrators should
1633 either use the Open vSwitch development mailing list to coordinate on
1634 common key-value definitions, or choose key names that are likely to be
1635 unique. No common key-value pairs are currently defined.
1640 <table name="Controller" title="OpenFlow controller configuration.">
1641 <p>An OpenFlow controller.</p>
1644 Open vSwitch supports two kinds of OpenFlow controllers:
1648 <dt>Primary controllers</dt>
1651 This is the kind of controller envisioned by the OpenFlow 1.0
1652 specification. Usually, a primary controller implements a network
1653 policy by taking charge of the switch's flow table.
1657 Open vSwitch initiates and maintains persistent connections to
1658 primary controllers, retrying the connection each time it fails or
1659 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1660 <ref table="Bridge"/> table applies to primary controllers.
1664 Open vSwitch permits a bridge to have any number of primary
1665 controllers. When multiple controllers are configured, Open
1666 vSwitch connects to all of them simultaneously. Because
1667 OpenFlow 1.0 does not specify how multiple controllers
1668 coordinate in interacting with a single switch, more than
1669 one primary controller should be specified only if the
1670 controllers are themselves designed to coordinate with each
1671 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1672 vendor extension may be useful for this.)
1675 <dt>Service controllers</dt>
1678 These kinds of OpenFlow controller connections are intended for
1679 occasional support and maintenance use, e.g. with
1680 <code>ovs-ofctl</code>. Usually a service controller connects only
1681 briefly to inspect or modify some of a switch's state.
1685 Open vSwitch listens for incoming connections from service
1686 controllers. The service controllers initiate and, if necessary,
1687 maintain the connections from their end. The <ref table="Bridge"
1688 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1689 not apply to service controllers.
1693 Open vSwitch supports configuring any number of service controllers.
1699 The <ref column="target"/> determines the type of controller.
1702 <group title="Core Features">
1703 <column name="target">
1704 <p>Connection method for controller.</p>
1706 The following connection methods are currently supported for primary
1710 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1712 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1713 the given <var>ip</var>, which must be expressed as an IP address
1714 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1715 column in the <ref table="Open_vSwitch"/> table must point to a
1716 valid SSL configuration when this form is used.</p>
1717 <p>SSL support is an optional feature that is not always built as
1718 part of Open vSwitch.</p>
1720 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1721 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1722 the given <var>ip</var>, which must be expressed as an IP address
1723 (not a DNS name).</dd>
1726 The following connection methods are currently supported for service
1730 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1733 Listens for SSL connections on the specified TCP <var>port</var>
1734 (default: 6633). If <var>ip</var>, which must be expressed as an
1735 IP address (not a DNS name), is specified, then connections are
1736 restricted to the specified local IP address.
1739 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1740 table="Open_vSwitch"/> table must point to a valid SSL
1741 configuration when this form is used.
1743 <p>SSL support is an optional feature that is not always built as
1744 part of Open vSwitch.</p>
1746 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1748 Listens for connections on the specified TCP <var>port</var>
1749 (default: 6633). If <var>ip</var>, which must be expressed as an
1750 IP address (not a DNS name), is specified, then connections are
1751 restricted to the specified local IP address.
1754 <p>When multiple controllers are configured for a single bridge, the
1755 <ref column="target"/> values must be unique. Duplicate
1756 <ref column="target"/> values yield unspecified results.</p>
1759 <column name="connection_mode">
1760 <p>If it is specified, this setting must be one of the following
1761 strings that describes how Open vSwitch contacts this OpenFlow
1762 controller over the network:</p>
1765 <dt><code>in-band</code></dt>
1766 <dd>In this mode, this controller's OpenFlow traffic travels over the
1767 bridge associated with the controller. With this setting, Open
1768 vSwitch allows traffic to and from the controller regardless of the
1769 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1770 would never be able to connect to the controller, because it did
1771 not have a flow to enable it.) This is the most common connection
1772 mode because it is not necessary to maintain two independent
1774 <dt><code>out-of-band</code></dt>
1775 <dd>In this mode, OpenFlow traffic uses a control network separate
1776 from the bridge associated with this controller, that is, the
1777 bridge does not use any of its own network devices to communicate
1778 with the controller. The control network must be configured
1779 separately, before or after <code>ovs-vswitchd</code> is started.
1783 <p>If not specified, the default is implementation-specific.</p>
1787 <group title="Controller Failure Detection and Handling">
1788 <column name="max_backoff">
1789 Maximum number of milliseconds to wait between connection attempts.
1790 Default is implementation-specific.
1793 <column name="inactivity_probe">
1794 Maximum number of milliseconds of idle time on connection to
1795 controller before sending an inactivity probe message. If Open
1796 vSwitch does not communicate with the controller for the specified
1797 number of seconds, it will send a probe. If a response is not
1798 received for the same additional amount of time, Open vSwitch
1799 assumes the connection has been broken and attempts to reconnect.
1800 Default is implementation-specific. A value of 0 disables
1805 <group title="OpenFlow Rate Limiting">
1806 <column name="controller_rate_limit">
1807 <p>The maximum rate at which packets in unknown flows will be
1808 forwarded to the OpenFlow controller, in packets per second. This
1809 feature prevents a single bridge from overwhelming the controller.
1810 If not specified, the default is implementation-specific.</p>
1811 <p>In addition, when a high rate triggers rate-limiting, Open
1812 vSwitch queues controller packets for each port and transmits
1813 them to the controller at the configured rate. The number of
1814 queued packets is limited by
1815 the <ref column="controller_burst_limit"/> value. The packet
1816 queue is shared fairly among the ports on a bridge.</p><p>Open
1817 vSwitch maintains two such packet rate-limiters per bridge.
1818 One of these applies to packets sent up to the controller
1819 because they do not correspond to any flow. The other applies
1820 to packets sent up to the controller by request through flow
1821 actions. When both rate-limiters are filled with packets, the
1822 actual rate that packets are sent to the controller is up to
1823 twice the specified rate.</p>
1826 <column name="controller_burst_limit">
1827 In conjunction with <ref column="controller_rate_limit"/>,
1828 the maximum number of unused packet credits that the bridge will
1829 allow to accumulate, in packets. If not specified, the default
1830 is implementation-specific.
1834 <group title="Additional In-Band Configuration">
1835 <p>These values are considered only in in-band control mode (see
1836 <ref column="connection_mode"/>).</p>
1838 <p>When multiple controllers are configured on a single bridge, there
1839 should be only one set of unique values in these columns. If different
1840 values are set for these columns in different controllers, the effect
1843 <column name="local_ip">
1844 The IP address to configure on the local port,
1845 e.g. <code>192.168.0.123</code>. If this value is unset, then
1846 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1850 <column name="local_netmask">
1851 The IP netmask to configure on the local port,
1852 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1853 but this value is unset, then the default is chosen based on whether
1854 the IP address is class A, B, or C.
1857 <column name="local_gateway">
1858 The IP address of the gateway to configure on the local port, as a
1859 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1860 this network has no gateway.
1864 <group title="Other Features">
1865 <column name="external_ids">
1866 Key-value pairs for use by external frameworks that integrate with Open
1867 vSwitch, rather than by Open vSwitch itself. System integrators should
1868 either use the Open vSwitch development mailing list to coordinate on
1869 common key-value definitions, or choose key names that are likely to be
1870 unique. No common key-value pairs are currently defined.
1874 <group title="Controller Status">
1875 <column name="is_connected">
1876 <code>true</code> if currently connected to this controller,
1877 <code>false</code> otherwise.
1880 <column name="role">
1881 <p>The level of authority this controller has on the associated
1882 bridge. Possible values are:</p>
1884 <dt><code>other</code></dt>
1885 <dd>Allows the controller access to all OpenFlow features.</dd>
1886 <dt><code>master</code></dt>
1887 <dd>Equivalent to <code>other</code>, except that there may be at
1888 most one master controller at a time. When a controller configures
1889 itself as <code>master</code>, any existing master is demoted to
1890 the <code>slave</code>role.</dd>
1891 <dt><code>slave</code></dt>
1892 <dd>Allows the controller read-only access to OpenFlow features.
1893 Attempts to modify the flow table will be rejected with an
1894 error. Slave controllers do not receive OFPT_PACKET_IN or
1895 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1900 <column name="status">
1901 <p>Key-value pairs that report controller status.</p>
1903 <dt><code>last_error</code></dt>
1904 <dd>A human-readable description of the last error on the connection
1905 to the controller; i.e. <code>strerror(errno)</code>. This key
1906 will exist only if an error has occurred.</dd>
1907 <dt><code>state</code></dt>
1908 <dd>The state of the connection to the controller. Possible values
1909 are: <code>VOID</code> (connection is disabled),
1910 <code>BACKOFF</code> (attempting to reconnect at an increasing
1911 period), <code>CONNECTING</code> (attempting to connect),
1912 <code>ACTIVE</code> (connected, remote host responsive), and
1913 <code>IDLE</code> (remote host idle, sending keep-alive). These
1914 values may change in the future. They are provided only for human
1916 <dt><code>sec_since_connect</code></dt>
1917 <dd>The amount of time since this controller last successfully
1918 connected to the switch (in seconds). Value is empty if controller
1919 has never successfully connected.</dd>
1920 <dt><code>sec_since_disconnect</code></dt>
1921 <dd>The amount of time since this controller last disconnected from
1922 the switch (in seconds). Value is empty if controller has never
1929 <table name="Manager" title="OVSDB management connection.">
1931 Configuration for a database connection to an Open vSwitch database
1936 This table primarily configures the Open vSwitch database
1937 (<code>ovsdb-server</code>), not the Open vSwitch switch
1938 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1939 what connections should be treated as in-band.
1943 The Open vSwitch database server can initiate and maintain active
1944 connections to remote clients. It can also listen for database
1948 <group title="Core Features">
1949 <column name="target">
1950 <p>Connection method for managers.</p>
1952 The following connection methods are currently supported:
1955 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1958 The specified SSL <var>port</var> (default: 6632) on the host at
1959 the given <var>ip</var>, which must be expressed as an IP address
1960 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1961 column in the <ref table="Open_vSwitch"/> table must point to a
1962 valid SSL configuration when this form is used.
1965 SSL support is an optional feature that is not always built as
1966 part of Open vSwitch.
1970 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1972 The specified TCP <var>port</var> (default: 6632) on the host at
1973 the given <var>ip</var>, which must be expressed as an IP address
1976 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1979 Listens for SSL connections on the specified TCP <var>port</var>
1980 (default: 6632). If <var>ip</var>, which must be expressed as an
1981 IP address (not a DNS name), is specified, then connections are
1982 restricted to the specified local IP address.
1985 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1986 table="Open_vSwitch"/> table must point to a valid SSL
1987 configuration when this form is used.
1990 SSL support is an optional feature that is not always built as
1991 part of Open vSwitch.
1994 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1996 Listens for connections on the specified TCP <var>port</var>
1997 (default: 6632). If <var>ip</var>, which must be expressed as an
1998 IP address (not a DNS name), is specified, then connections are
1999 restricted to the specified local IP address.
2002 <p>When multiple managers are configured, the <ref column="target"/>
2003 values must be unique. Duplicate <ref column="target"/> values yield
2004 unspecified results.</p>
2007 <column name="connection_mode">
2009 If it is specified, this setting must be one of the following strings
2010 that describes how Open vSwitch contacts this OVSDB client over the
2015 <dt><code>in-band</code></dt>
2017 In this mode, this connection's traffic travels over a bridge
2018 managed by Open vSwitch. With this setting, Open vSwitch allows
2019 traffic to and from the client regardless of the contents of the
2020 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2021 to connect to the client, because it did not have a flow to enable
2022 it.) This is the most common connection mode because it is not
2023 necessary to maintain two independent networks.
2025 <dt><code>out-of-band</code></dt>
2027 In this mode, the client's traffic uses a control network separate
2028 from that managed by Open vSwitch, that is, Open vSwitch does not
2029 use any of its own network devices to communicate with the client.
2030 The control network must be configured separately, before or after
2031 <code>ovs-vswitchd</code> is started.
2036 If not specified, the default is implementation-specific.
2041 <group title="Client Failure Detection and Handling">
2042 <column name="max_backoff">
2043 Maximum number of milliseconds to wait between connection attempts.
2044 Default is implementation-specific.
2047 <column name="inactivity_probe">
2048 Maximum number of milliseconds of idle time on connection to the client
2049 before sending an inactivity probe message. If Open vSwitch does not
2050 communicate with the client for the specified number of seconds, it
2051 will send a probe. If a response is not received for the same
2052 additional amount of time, Open vSwitch assumes the connection has been
2053 broken and attempts to reconnect. Default is implementation-specific.
2054 A value of 0 disables inactivity probes.
2058 <group title="Other Features">
2059 <column name="external_ids">
2060 Key-value pairs for use by external frameworks that integrate with Open
2061 vSwitch, rather than by Open vSwitch itself. System integrators should
2062 either use the Open vSwitch development mailing list to coordinate on
2063 common key-value definitions, or choose key names that are likely to be
2064 unique. No common key-value pairs are currently defined.
2068 <group title="Status">
2069 <column name="is_connected">
2070 <code>true</code> if currently connected to this manager,
2071 <code>false</code> otherwise.
2074 <column name="status">
2075 <p>Key-value pairs that report manager status.</p>
2077 <dt><code>last_error</code></dt>
2078 <dd>A human-readable description of the last error on the connection
2079 to the manager; i.e. <code>strerror(errno)</code>. This key
2080 will exist only if an error has occurred.</dd>
2083 <dt><code>state</code></dt>
2084 <dd>The state of the connection to the manager. Possible values
2085 are: <code>VOID</code> (connection is disabled),
2086 <code>BACKOFF</code> (attempting to reconnect at an increasing
2087 period), <code>CONNECTING</code> (attempting to connect),
2088 <code>ACTIVE</code> (connected, remote host responsive), and
2089 <code>IDLE</code> (remote host idle, sending keep-alive). These
2090 values may change in the future. They are provided only for human
2094 <dt><code>sec_since_connect</code></dt>
2095 <dd>The amount of time since this manager last successfully connected
2096 to the database (in seconds). Value is empty if manager has never
2097 successfully connected.</dd>
2100 <dt><code>sec_since_disconnect</code></dt>
2101 <dd>The amount of time since this manager last disconnected from the
2102 database (in seconds). Value is empty if manager has never
2109 <table name="NetFlow">
2110 A NetFlow target. NetFlow is a protocol that exports a number of
2111 details about terminating IP flows, such as the principals involved
2114 <column name="targets">
2115 NetFlow targets in the form
2116 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2117 must be specified numerically, not as a DNS name.
2120 <column name="engine_id">
2121 Engine ID to use in NetFlow messages. Defaults to datapath index
2125 <column name="engine_type">
2126 Engine type to use in NetFlow messages. Defaults to datapath
2127 index if not specified.
2130 <column name="active_timeout">
2131 The interval at which NetFlow records are sent for flows that are
2132 still active, in seconds. A value of <code>0</code> requests the
2133 default timeout (currently 600 seconds); a value of <code>-1</code>
2134 disables active timeouts.
2137 <column name="add_id_to_interface">
2138 <p>If this column's value is <code>false</code>, the ingress and egress
2139 interface fields of NetFlow flow records are derived from OpenFlow port
2140 numbers. When it is <code>true</code>, the 7 most significant bits of
2141 these fields will be replaced by the least significant 7 bits of the
2142 engine id. This is useful because many NetFlow collectors do not
2143 expect multiple switches to be sending messages from the same host, so
2144 they do not store the engine information which could be used to
2145 disambiguate the traffic.</p>
2146 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2149 <column name="external_ids">
2150 Key-value pairs for use by external frameworks that integrate with Open
2151 vSwitch, rather than by Open vSwitch itself. System integrators should
2152 either use the Open vSwitch development mailing list to coordinate on
2153 common key-value definitions, or choose key names that are likely to be
2154 unique. No common key-value pairs are currently defined.
2159 SSL configuration for an Open_vSwitch.
2161 <column name="private_key">
2162 Name of a PEM file containing the private key used as the switch's
2163 identity for SSL connections to the controller.
2166 <column name="certificate">
2167 Name of a PEM file containing a certificate, signed by the
2168 certificate authority (CA) used by the controller and manager,
2169 that certifies the switch's private key, identifying a trustworthy
2173 <column name="ca_cert">
2174 Name of a PEM file containing the CA certificate used to verify
2175 that the switch is connected to a trustworthy controller.
2178 <column name="bootstrap_ca_cert">
2179 If set to <code>true</code>, then Open vSwitch will attempt to
2180 obtain the CA certificate from the controller on its first SSL
2181 connection and save it to the named PEM file. If it is successful,
2182 it will immediately drop the connection and reconnect, and from then
2183 on all SSL connections must be authenticated by a certificate signed
2184 by the CA certificate thus obtained. <em>This option exposes the
2185 SSL connection to a man-in-the-middle attack obtaining the initial
2186 CA certificate.</em> It may still be useful for bootstrapping.
2189 <column name="external_ids">
2190 Key-value pairs for use by external frameworks that integrate with Open
2191 vSwitch, rather than by Open vSwitch itself. System integrators should
2192 either use the Open vSwitch development mailing list to coordinate on
2193 common key-value definitions, or choose key names that are likely to be
2194 unique. No common key-value pairs are currently defined.
2198 <table name="sFlow">
2199 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2202 <column name="agent">
2203 Name of the network device whose IP address should be reported as the
2204 ``agent address'' to collectors. If not specified, the IP address
2205 defaults to the <ref table="Controller" column="local_ip"/> in the
2206 collector's <ref table="Controller"/>. If an agent IP address cannot be
2207 determined either way, sFlow is disabled.
2210 <column name="header">
2211 Number of bytes of a sampled packet to send to the collector.
2212 If not specified, the default is 128 bytes.
2215 <column name="polling">
2216 Polling rate in seconds to send port statistics to the collector.
2217 If not specified, defaults to 30 seconds.
2220 <column name="sampling">
2221 Rate at which packets should be sampled and sent to the collector.
2222 If not specified, defaults to 400, which means one out of 400
2223 packets, on average, will be sent to the collector.
2226 <column name="targets">
2227 sFlow targets in the form
2228 <code><var>ip</var>:<var>port</var></code>.
2231 <column name="external_ids">
2232 Key-value pairs for use by external frameworks that integrate with Open
2233 vSwitch, rather than by Open vSwitch itself. System integrators should
2234 either use the Open vSwitch development mailing list to coordinate on
2235 common key-value definitions, or choose key names that are likely to be
2236 unique. No common key-value pairs are currently defined.
2240 <table name="Capability">
2241 <p>Records in this table describe functionality supported by the hardware
2242 and software platform on which this Open vSwitch is based. Clients
2243 should not modify this table.</p>
2245 <p>A record in this table is meaningful only if it is referenced by the
2246 <ref table="Open_vSwitch" column="capabilities"/> column in the
2247 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2248 the record's ``category,'' determines the meanings of the
2249 <ref column="details"/> column. The following general forms of
2250 categories are currently defined:</p>
2253 <dt><code>qos-<var>type</var></code></dt>
2254 <dd><var>type</var> is supported as the value for
2255 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2259 <column name="details">
2260 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2261 depends on the category key that the <ref table="Open_vSwitch"
2262 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2263 uses to reference this record, as described above.</p>
2265 <p>The presence of a record for category <code>qos-<var>type</var></code>
2266 indicates that the switch supports <var>type</var> as the value of
2267 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2268 table. The following key-value pairs are defined to further describe
2269 QoS capabilities:</p>
2272 <dt><code>n-queues</code></dt>
2273 <dd>Number of supported queues, as a positive integer. Keys in the
2274 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2275 records whose <ref table="QoS" column="type"/> value
2276 equals <var>type</var> must range between 0 and this value minus one,