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 digits.
367 (Setting this column has no useful effect. Set <ref
368 column="other-config" key="datapath-id"/> instead.)
372 <group title="Other Features">
373 <column name="datapath_type">
374 Name of datapath provider. The kernel datapath has
375 type <code>system</code>. The userspace datapath has
376 type <code>netdev</code>.
379 <column name="external_ids">
380 Key-value pairs for use by external frameworks that integrate
381 with Open vSwitch, rather than by Open vSwitch itself. System
382 integrators should either use the Open vSwitch development
383 mailing list to coordinate on common key-value definitions, or
384 choose key names that are likely to be unique. The currently
385 defined key-value pairs are:
387 <dt><code>bridge-id</code></dt>
388 <dd>A unique identifier of the bridge. On Citrix XenServer this
389 will commonly be the same as <code>xs-network-uuids</code>.</dd>
390 <dt><code>xs-network-uuids</code></dt>
391 <dd>Semicolon-delimited set of universally unique identifier(s) for
392 the network with which this bridge is associated on a Citrix
393 XenServer host. The network identifiers are RFC 4122 UUIDs as
394 displayed by, e.g., <code>xe network-list</code>.</dd>
398 <column name="other_config">
399 Key-value pairs for configuring rarely used bridge
400 features. The currently defined key-value pairs are:
402 <dt><code>datapath-id</code></dt>
404 digits to set the OpenFlow datapath ID to a specific
405 value. May not be all-zero.</dd>
406 <dt><code>disable-in-band</code></dt>
407 <dd>If set to <code>true</code>, disable in-band control on
408 the bridge regardless of controller and manager settings.</dd>
409 <dt><code>hwaddr</code></dt>
410 <dd>An Ethernet address in the form
411 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
412 to set the hardware address of the local port and influence the
414 <dt><code>in-band-queue</code></dt>
416 A queue ID as a nonnegative integer. This sets the OpenFlow queue
417 ID that will be used by flows set up by in-band control on this
418 bridge. If unset, or if the port used by an in-band control flow
419 does not have QoS configured, or if the port does not have a queue
420 with the specified ID, the default queue is used instead.
427 <table name="Port" table="Port or bond configuration.">
428 <p>A port within a <ref table="Bridge"/>.</p>
429 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
430 <ref column="interfaces"/> column. Such a port logically
431 corresponds to a port on a physical Ethernet switch. A port
432 with more than one interface is a ``bonded port'' (see
433 <ref group="Bonding Configuration"/>).</p>
434 <p>Some properties that one might think as belonging to a port are actually
435 part of the port's <ref table="Interface"/> members.</p>
438 Port name. Should be alphanumeric and no more than about 8
439 bytes long. May be the same as the interface name, for
440 non-bonded ports. Must otherwise be unique among the names of
441 ports, interfaces, and bridges on a host.
444 <column name="interfaces">
445 The port's interfaces. If there is more than one, this is a
449 <group title="VLAN Configuration">
450 <p>A bridge port must be configured for VLANs in one of two
451 mutually exclusive ways:
453 <li>A ``trunk port'' has an empty value for <ref
454 column="tag"/>. Its <ref column="trunks"/> value may be
455 empty or non-empty.</li>
456 <li>An ``implicitly tagged VLAN port'' or ``access port''
457 has an nonempty value for <ref column="tag"/>. Its
458 <ref column="trunks"/> value must be empty.</li>
460 If <ref column="trunks"/> and <ref column="tag"/> are both
461 nonempty, the configuration is ill-formed.
466 If this is an access port (see above), the port's implicitly
467 tagged VLAN. Must be empty if this is a trunk port.
470 Frames arriving on trunk ports will be forwarded to this
471 port only if they are tagged with the given VLAN (or, if
472 <ref column="tag"/> is 0, then if they lack a VLAN header).
473 Frames arriving on other access ports will be forwarded to
474 this port only if they have the same <ref column="tag"/>
475 value. Frames forwarded to this port will not have an
479 When a frame with a 802.1Q header that indicates a nonzero
480 VLAN is received on an access port, it is discarded.
484 <column name="trunks">
486 If this is a trunk port (see above), the 802.1Q VLAN(s) that
487 this port trunks; if it is empty, then the port trunks all
488 VLANs. Must be empty if this is an access port.
491 Frames arriving on trunk ports are dropped if they are not
492 in one of the specified VLANs. For this purpose, packets
493 that have no VLAN header are treated as part of VLAN 0.
498 <group title="Bonding Configuration">
499 <p>A port that has more than one interface is a ``bonded port.'' Bonding
500 allows for load balancing and fail-over. Some kinds of bonding will
501 work with any kind of upstream switch:</p>
504 <dt><code>balance-slb</code></dt>
506 Balances flows among slaves based on source MAC address and output
507 VLAN, with periodic rebalancing as traffic patterns change.
510 <dt><code>active-backup</code></dt>
512 Assigns all flows to one slave, failing over to a backup slave when
513 the active slave is disabled.
518 The following modes require the upstream switch to support 802.3ad with
519 successful LACP negotiation. If LACP negotiation fails then
520 <code>balance-slb</code> style flow hashing is used as a fallback:
524 <dt><code>balance-tcp</code></dt>
526 Balances flows among slaves based on L2, L3, and L4 protocol
527 information such as destination MAC address, IP address, and TCP
533 <dt><code>stable</code></dt>
535 <p>Attempts to always assign a given flow to the same slave
536 consistently. In an effort to maintain stability, no load
537 balancing is done. Uses a similar hashing strategy to
538 <code>balance-tcp</code>, always taking into account L3 and L4
539 fields even if LACP negotiations are unsuccessful. </p>
540 <p>Slave selection decisions are made based on
541 <code>bond-stable-id</code> if set. Otherwise, OpenFlow port
542 number is used. Decisions are consistent across all ovs-vswitchd
543 instances with equivalent <code>bond-stable-id</code>s.</p>
547 <p>These columns apply only to bonded ports. Their values are
548 otherwise ignored.</p>
550 <column name="bond_mode">
551 <p>The type of bonding used for a bonded port. Defaults to
552 <code>balance-slb</code> if unset.
556 <column name="bond_updelay">
557 <p>For a bonded port, the number of milliseconds for which carrier must
558 stay up on an interface before the interface is considered to be up.
559 Specify <code>0</code> to enable the interface immediately.</p>
560 <p>This setting is honored only when at least one bonded interface is
561 already enabled. When no interfaces are enabled, then the first bond
562 interface to come up is enabled immediately.</p>
565 <column name="bond_downdelay">
566 For a bonded port, the number of milliseconds for which carrier must
567 stay down on an interface before the interface is considered to be
568 down. Specify <code>0</code> to disable the interface immediately.
571 <column name="bond_fake_iface">
572 For a bonded port, whether to create a fake internal interface with the
573 name of the port. Use only for compatibility with legacy software that
578 <p>Configures LACP on this port. LACP allows directly connected
579 switches to negotiate which links may be bonded. LACP may be enabled
580 on non-bonded ports for the benefit of any switches they may be
581 connected to. <code>active</code> ports are allowed to initiate LACP
582 negotiations. <code>passive</code> ports are allowed to participate
583 in LACP negotiations initiated by a remote switch, but not allowed to
584 initiate such negotiations themselves. If unset Open vSwitch will
585 choose a reasonable default. </p>
590 <group title="Other Features">
592 Quality of Service configuration for this port.
596 The MAC address to use for this port for the purpose of choosing the
597 bridge's MAC address. This column does not necessarily reflect the
598 port's actual MAC address, nor will setting it change the port's actual
602 <column name="fake_bridge">
603 Does this port represent a sub-bridge for its tagged VLAN within the
604 Bridge? See ovs-vsctl(8) for more information.
607 <column name="external_ids">
609 Key-value pairs for use by external frameworks that integrate with
610 Open vSwitch, rather than by Open vSwitch itself. System integrators
611 should either use the Open vSwitch development mailing list to
612 coordinate on common key-value definitions, or choose key names that
613 are likely to be unique.
616 No key-value pairs native to <ref table="Port"/> are currently
617 defined. For fake bridges (see the <ref column="fake_bridge"/>
618 column), external IDs for the fake bridge are defined here by
619 prefixing a <ref table="Bridge"/> <ref table="Bridge"
620 column="external_ids"/> key with <code>fake-bridge-</code>,
621 e.g. <code>fake-bridge-xs-network-uuids</code>.
625 <column name="other_config">
626 Key-value pairs for configuring rarely used port features. The
627 currently defined key-value pairs are:
629 <dt><code>hwaddr</code></dt>
630 <dd>An Ethernet address in the form
631 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
632 <dt><code>bond-rebalance-interval</code></dt>
633 <dd>For an SLB bonded port, the number of milliseconds between
634 successive attempts to rebalance the bond, that is, to
635 move source MACs and their flows from one interface on
636 the bond to another in an attempt to keep usage of each
637 interface roughly equal. The default is 10000 (10
638 seconds), and the minimum is 1000 (1 second).</dd>
639 <dt><code>bond-detect-mode</code></dt>
640 <dd> Sets the method used to detect link failures in a bonded port.
641 Options are <code>carrier</code> and <code>miimon</code>. Defaults
642 to <code>carrier</code> which uses each interface's carrier to detect
643 failures. When set to <code>miimon</code>, will check for failures
644 by polling each interface's MII. </dd>
645 <dt><code>bond-miimon-interval</code></dt>
646 <dd> The number of milliseconds between successive attempts to
647 poll each interface's MII. Only relevant on ports which use
648 <code>miimon</code> to detect failures. </dd>
649 <dt><code>bond-hash-basis</code></dt>
650 <dd> An integer hashed along with flows when choosing output slaves.
651 When changed, all flows will be assigned different hash values
652 possibly causing slave selection decisions to change.</dd>
653 <dt><code>lacp-system-id</code></dt>
654 <dd> The LACP system ID of this <ref table="Port"/>. The system ID
655 of a LACP bond is used to identify itself to its partners. Must
656 be a nonzero MAC address.</dd>
657 <dt><code>lacp-system-priority</code></dt>
658 <dd> The LACP system priority of this <ref table="Port"/>. In
659 LACP negotiations, link status decisions are made by the system
660 with the numerically lower priority. Must be a number between 1
662 <dt><code>lacp-time</code></dt>
664 <p>The LACP timing which should be used on this
665 <ref table="Port"/>. Possible values are <code>fast</code>,
666 <code>slow</code> and a positive number of milliseconds. By
667 default <code>slow</code> is used. When configured to be
668 <code>fast</code> LACP heartbeats are requested at a rate of once
669 per second causing connectivity problems to be detected more
670 quickly. In <code>slow</code> mode, heartbeats are requested at
671 a rate of once every 30 seconds.</p>
673 <p>Users may manually set a heartbeat transmission rate to increase
674 the fault detection speed further. When manually set, OVS
675 expects the partner switch to be configured with the same
676 transmission rate. Manually setting <code>lacp-time</code> to
677 something other than <code>fast</code> or <code>slow</code> is
678 not supported by the LACP specification.</p>
680 <dt><code>lacp-heartbeat</code></dt>
681 <dd> Treats LACP like a simple heartbeat protocol for link state
682 monitoring. Most features of the LACP protocol are disabled when
683 this mode is in use.</dd>
689 <table name="Interface" title="One physical network device in a Port.">
690 An interface within a <ref table="Port"/>.
692 <group title="Core Features">
694 Interface name. Should be alphanumeric and no more than about 8 bytes
695 long. May be the same as the port name, for non-bonded ports. Must
696 otherwise be unique among the names of ports, interfaces, and bridges
701 <p>Ethernet address to set for this interface. If unset then the
702 default MAC address is used:</p>
704 <li>For the local interface, the default is the lowest-numbered MAC
705 address among the other bridge ports, either the value of the
706 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
707 if set, or its actual MAC (for bonded ports, the MAC of its slave
708 whose name is first in alphabetical order). Internal ports and
709 bridge ports that are used as port mirroring destinations (see the
710 <ref table="Mirror"/> table) are ignored.</li>
711 <li>For other internal interfaces, the default MAC is randomly
713 <li>External interfaces typically have a MAC address associated with
716 <p>Some interfaces may not have a software-controllable MAC
720 <column name="ofport">
721 <p>OpenFlow port number for this interface. Unlike most columns, this
722 column's value should be set only by Open vSwitch itself. Other
723 clients should set this column to an empty set (the default) when
724 creating an <ref table="Interface"/>.</p>
725 <p>Open vSwitch populates this column when the port number becomes
726 known. If the interface is successfully added,
727 <ref column="ofport"/> will be set to a number between 1 and 65535
728 (generally either in the range 1 to 65279, inclusive, or 65534, the
729 port number for the OpenFlow ``local port''). If the interface
730 cannot be added then Open vSwitch sets this column
735 <group title="System-Specific Details">
737 The interface type, one of:
739 <dt><code>system</code></dt>
740 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
741 Sometimes referred to as ``external interfaces'' since they are
742 generally connected to hardware external to that on which the Open
743 vSwitch is running. The empty string is a synonym for
744 <code>system</code>.</dd>
745 <dt><code>internal</code></dt>
746 <dd>A simulated network device that sends and receives traffic. An
747 internal interface whose <ref column="name"/> is the same as its
748 bridge's <ref table="Open_vSwitch" column="name"/> is called the
749 ``local interface.'' It does not make sense to bond an internal
750 interface, so the terms ``port'' and ``interface'' are often used
751 imprecisely for internal interfaces.</dd>
752 <dt><code>tap</code></dt>
753 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
754 <dt><code>gre</code></dt>
755 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
756 tunnel. Each tunnel must be uniquely identified by the
757 combination of <code>remote_ip</code>, <code>local_ip</code>, and
758 <code>in_key</code>. Note that if two ports are defined that are
759 the same except one has an optional identifier and the other does
760 not, the more specific one is matched first. <code>in_key</code>
761 is considered more specific than <code>local_ip</code> if a port
762 defines one and another port defines the other. The following
763 options may be specified in the <ref column="options"/> column:
765 <dt><code>remote_ip</code></dt>
766 <dd>Required. The tunnel endpoint.</dd>
769 <dt><code>local_ip</code></dt>
770 <dd>Optional. The destination IP that received packets must
771 match. Default is to match all addresses.</dd>
774 <dt><code>in_key</code></dt>
775 <dd>Optional. The GRE key that received packets must contain.
776 It may either be a 32-bit number (no key and a key of 0 are
777 treated as equivalent) or the word <code>flow</code>. If
778 <code>flow</code> is specified then any key will be accepted
779 and the key will be placed in the <code>tun_id</code> field
780 for matching in the flow table. The ovs-ofctl manual page
781 contains additional information about matching fields in
782 OpenFlow flows. Default is no key.</dd>
785 <dt><code>out_key</code></dt>
786 <dd>Optional. The GRE key to be set on outgoing packets. It may
787 either be a 32-bit number or the word <code>flow</code>. If
788 <code>flow</code> is specified then the key may be set using
789 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
790 is used in the absence of an action). The ovs-ofctl manual
791 page contains additional information about the Nicira OpenFlow
792 vendor extensions. Default is no key.</dd>
795 <dt><code>key</code></dt>
796 <dd>Optional. Shorthand to set <code>in_key</code> and
797 <code>out_key</code> at the same time.</dd>
800 <dt><code>tos</code></dt>
801 <dd>Optional. The value of the ToS bits to be set on the
802 encapsulating packet. It may also be the word
803 <code>inherit</code>, in which case the ToS will be copied from
804 the inner packet if it is IPv4 or IPv6 (otherwise it will be
805 0). Note that the ECN fields are always inherited. Default is
809 <dt><code>ttl</code></dt>
810 <dd>Optional. The TTL to be set on the encapsulating packet.
811 It may also be the word <code>inherit</code>, in which case the
812 TTL will be copied from the inner packet if it is IPv4 or IPv6
813 (otherwise it will be the system default, typically 64).
814 Default is the system default TTL.</dd>
817 <dt><code>csum</code></dt>
818 <dd>Optional. Compute GRE checksums on outgoing packets.
819 Checksums present on incoming packets will be validated
820 regardless of this setting. Note that GRE checksums
821 impose a significant performance penalty as they cover the
822 entire packet. As the contents of the packet is typically
823 covered by L3 and L4 checksums, this additional checksum only
824 adds value for the GRE and encapsulated Ethernet headers.
825 Default is disabled, set to <code>true</code> to enable.</dd>
828 <dt><code>df_inherit</code></dt>
829 <dd>Optional. If enabled, the Don't Fragment bit will be copied
830 from the inner IP headers (those of the encapsulated traffic)
831 to the outer (tunnel) headers. Default is disabled; set to
832 <code>true</code> to enable.</dd>
835 <dt><code>df_default</code></dt>
836 <dd>Optional. If enabled, the Don't Fragment bit will be set by
837 default on tunnel headers if the <code>df_inherit</code> option
838 is not set, or if the encapsulated packet is not IP. Default
839 is enabled; set to <code>false</code> to disable.</dd>
842 <dt><code>pmtud</code></dt>
843 <dd>Optional. Enable tunnel path MTU discovery. If enabled
844 ``ICMP Destination Unreachable - Fragmentation Needed''
845 messages will be generated for IPv4 packets with the DF bit set
846 and IPv6 packets above the minimum MTU if the packet size
847 exceeds the path MTU minus the size of the tunnel headers.
848 Note that this option causes behavior that is typically
849 reserved for routers and therefore is not entirely in
850 compliance with the IEEE 802.1D specification for bridges.
851 Default is enabled; set to <code>false</code> to disable.</dd>
854 <dt><code>header_cache</code></dt>
855 <dd>Optional. Enable caching of tunnel headers and the output
856 path. This can lead to a significant performance increase
857 without changing behavior. In general it should not be
858 necessary to adjust this setting. However, the caching can
859 bypass certain components of the IP stack (such as IP tables)
860 and it may be useful to disable it if these features are
861 required or as a debugging measure. Default is enabled, set to
862 <code>false</code> to disable.</dd>
865 <dt><code>ipsec_gre</code></dt>
866 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
867 over IPv4 IPsec tunnel. Each tunnel (including those of type
868 <code>gre</code>) must be uniquely identified by the
869 combination of <code>remote_ip</code> and
870 <code>local_ip</code>. Note that if two ports are defined
871 that are the same except one has an optional identifier and
872 the other does not, the more specific one is matched first.
873 An authentication method of <code>peer_cert</code> or
874 <code>psk</code> must be defined. The following options may
875 be specified in the <ref column="options"/> column:
877 <dt><code>remote_ip</code></dt>
878 <dd>Required. The tunnel endpoint.</dd>
881 <dt><code>local_ip</code></dt>
882 <dd>Optional. The destination IP that received packets must
883 match. Default is to match all addresses.</dd>
886 <dt><code>peer_cert</code></dt>
887 <dd>Required for certificate authentication. A string
888 containing the peer's certificate in PEM format.
889 Additionally the host's certificate must be specified
890 with the <code>certificate</code> option.</dd>
893 <dt><code>certificate</code></dt>
894 <dd>Required for certificate authentication. The name of a
895 PEM file containing a certificate that will be presented
896 to the peer during authentication.</dd>
899 <dt><code>private_key</code></dt>
900 <dd>Optional for certificate authentication. The name of
901 a PEM file containing the private key associated with
902 <code>certificate</code>. If <code>certificate</code>
903 contains the private key, this option may be omitted.</dd>
906 <dt><code>psk</code></dt>
907 <dd>Required for pre-shared key authentication. Specifies a
908 pre-shared key for authentication that must be identical on
909 both sides of the tunnel.</dd>
912 <dt><code>in_key</code></dt>
913 <dd>Optional. The GRE key that received packets must contain.
914 It may either be a 32-bit number (no key and a key of 0 are
915 treated as equivalent) or the word <code>flow</code>. If
916 <code>flow</code> is specified then any key will be accepted
917 and the key will be placed in the <code>tun_id</code> field
918 for matching in the flow table. The ovs-ofctl manual page
919 contains additional information about matching fields in
920 OpenFlow flows. Default is no key.</dd>
923 <dt><code>out_key</code></dt>
924 <dd>Optional. The GRE key to be set on outgoing packets. It may
925 either be a 32-bit number or the word <code>flow</code>. If
926 <code>flow</code> is specified then the key may be set using
927 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
928 is used in the absence of an action). The ovs-ofctl manual
929 page contains additional information about the Nicira OpenFlow
930 vendor extensions. Default is no key.</dd>
933 <dt><code>key</code></dt>
934 <dd>Optional. Shorthand to set <code>in_key</code> and
935 <code>out_key</code> at the same time.</dd>
938 <dt><code>tos</code></dt>
939 <dd>Optional. The value of the ToS bits to be set on the
940 encapsulating packet. It may also be the word
941 <code>inherit</code>, in which case the ToS will be copied from
942 the inner packet if it is IPv4 or IPv6 (otherwise it will be
943 0). Note that the ECN fields are always inherited. Default is
947 <dt><code>ttl</code></dt>
948 <dd>Optional. The TTL to be set on the encapsulating packet.
949 It may also be the word <code>inherit</code>, in which case the
950 TTL will be copied from the inner packet if it is IPv4 or IPv6
951 (otherwise it will be the system default, typically 64).
952 Default is the system default TTL.</dd>
955 <dt><code>csum</code></dt>
956 <dd>Optional. Compute GRE checksums on outgoing packets.
957 Checksums present on incoming packets will be validated
958 regardless of this setting. Note that GRE checksums
959 impose a significant performance penalty as they cover the
960 entire packet. As the contents of the packet is typically
961 covered by L3 and L4 checksums, this additional checksum only
962 adds value for the GRE and encapsulated Ethernet headers.
963 Default is disabled, set to <code>true</code> to enable.</dd>
966 <dt><code>df_inherit</code></dt>
967 <dd>Optional. If enabled, the Don't Fragment bit will be copied
968 from the inner IP headers (those of the encapsulated traffic)
969 to the outer (tunnel) headers. Default is disabled; set to
970 <code>true</code> to enable.</dd>
973 <dt><code>df_default</code></dt>
974 <dd>Optional. If enabled, the Don't Fragment bit will be set by
975 default on tunnel headers if the <code>df_inherit</code> option
976 is not set, or if the encapsulated packet is not IP. Default
977 is enabled; set to <code>false</code> to disable.</dd>
980 <dt><code>pmtud</code></dt>
981 <dd>Optional. Enable tunnel path MTU discovery. If enabled
982 ``ICMP Destination Unreachable - Fragmentation Needed''
983 messages will be generated for IPv4 packets with the DF bit set
984 and IPv6 packets above the minimum MTU if the packet size
985 exceeds the path MTU minus the size of the tunnel headers.
986 Note that this option causes behavior that is typically
987 reserved for routers and therefore is not entirely in
988 compliance with the IEEE 802.1D specification for bridges.
989 Default is enabled; set to <code>false</code> to disable.</dd>
992 <dt><code>capwap</code></dt>
993 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
994 (RFC 5415). This allows interoperability with certain switches
995 where GRE is not available. Note that only the tunneling component
996 of the protocol is implemented. Due to the non-standard use of
997 CAPWAP, UDP ports 58881 and 58882 are used as the source and
998 destination ports respectively. Each tunnel must be uniquely
999 identified by the combination of <code>remote_ip</code> and
1000 <code>local_ip</code>. If two ports are defined that are the same
1001 except one includes <code>local_ip</code> and the other does not,
1002 the more specific one is matched first. CAPWAP support is not
1003 available on all platforms. Currently it is only supported in the
1004 Linux kernel module with kernel versions >= 2.6.25. The following
1005 options may be specified in the <ref column="options"/> column:
1007 <dt><code>remote_ip</code></dt>
1008 <dd>Required. The tunnel endpoint.</dd>
1011 <dt><code>local_ip</code></dt>
1012 <dd>Optional. The destination IP that received packets must
1013 match. Default is to match all addresses.</dd>
1016 <dt><code>tos</code></dt>
1017 <dd>Optional. The value of the ToS bits to be set on the
1018 encapsulating packet. It may also be the word
1019 <code>inherit</code>, in which case the ToS will be copied from
1020 the inner packet if it is IPv4 or IPv6 (otherwise it will be
1021 0). Note that the ECN fields are always inherited. Default is
1025 <dt><code>ttl</code></dt>
1026 <dd>Optional. The TTL to be set on the encapsulating packet.
1027 It may also be the word <code>inherit</code>, in which case the
1028 TTL will be copied from the inner packet if it is IPv4 or IPv6
1029 (otherwise it will be the system default, typically 64).
1030 Default is the system default TTL.</dd>
1033 <dt><code>df_inherit</code></dt>
1034 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1035 from the inner IP headers (those of the encapsulated traffic)
1036 to the outer (tunnel) headers. Default is disabled; set to
1037 <code>true</code> to enable.</dd>
1040 <dt><code>df_default</code></dt>
1041 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1042 default on tunnel headers if the <code>df_inherit</code> option
1043 is not set, or if the encapsulated packet is not IP. Default
1044 is enabled; set to <code>false</code> to disable.</dd>
1047 <dt><code>pmtud</code></dt>
1048 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1049 ``ICMP Destination Unreachable - Fragmentation Needed''
1050 messages will be generated for IPv4 packets with the DF bit set
1051 and IPv6 packets above the minimum MTU if the packet size
1052 exceeds the path MTU minus the size of the tunnel headers.
1053 Note that this option causes behavior that is typically
1054 reserved for routers and therefore is not entirely in
1055 compliance with the IEEE 802.1D specification for bridges.
1056 Default is enabled; set to <code>false</code> to disable.</dd>
1059 <dt><code>header_cache</code></dt>
1060 <dd>Optional. Enable caching of tunnel headers and the output
1061 path. This can lead to a significant performance increase
1062 without changing behavior. In general it should not be
1063 necessary to adjust this setting. However, the caching can
1064 bypass certain components of the IP stack (such as IP tables)
1065 and it may be useful to disable it if these features are
1066 required or as a debugging measure. Default is enabled, set to
1067 <code>false</code> to disable.</dd>
1070 <dt><code>patch</code></dt>
1073 A pair of virtual devices that act as a patch cable. The <ref
1074 column="options"/> column must have the following key-value pair:
1077 <dt><code>peer</code></dt>
1079 The <ref column="name"/> of the <ref table="Interface"/> for
1080 the other side of the patch. The named <ref
1081 table="Interface"/>'s own <code>peer</code> option must specify
1082 this <ref table="Interface"/>'s name. That is, the two patch
1083 interfaces must have reversed <ref column="name"/> and
1084 <code>peer</code> values.
1088 <dt><code>null</code></dt>
1089 <dd>An ignored interface.</dd>
1093 <column name="options">
1094 Configuration options whose interpretation varies based on
1095 <ref column="type"/>.
1099 <group title="Interface Status">
1101 Status information about interfaces attached to bridges, updated every
1102 5 seconds. Not all interfaces have all of these properties; virtual
1103 interfaces don't have a link speed, for example. Non-applicable
1104 columns will have empty values.
1106 <column name="admin_state">
1108 The administrative state of the physical network link.
1112 <column name="link_state">
1114 The observed state of the physical network link. This is ordinarily
1115 the link's carrier status. If the interface's <ref table="Port"/> is
1116 a bond configured for miimon monitoring, it is instead the network
1117 link's miimon status.
1121 <column name="link_speed">
1123 The negotiated speed of the physical network link.
1124 Valid values are positive integers greater than 0.
1128 <column name="duplex">
1130 The duplex mode of the physical network link.
1136 The MTU (maximum transmission unit); i.e. the largest
1137 amount of data that can fit into a single Ethernet frame.
1138 The standard Ethernet MTU is 1500 bytes. Some physical media
1139 and many kinds of virtual interfaces can be configured with
1143 This column will be empty for an interface that does not
1144 have an MTU as, for example, some kinds of tunnels do not.
1148 <column name="status">
1150 Key-value pairs that report port status. Supported status
1151 values are <code>type</code>-dependent; some interfaces may not have
1152 a valid <code>driver_name</code>, for example.
1154 <p>The currently defined key-value pairs are:</p>
1156 <dt><code>driver_name</code></dt>
1157 <dd>The name of the device driver controlling the network
1161 <dt><code>driver_version</code></dt>
1162 <dd>The version string of the device driver controlling the
1163 network adapter.</dd>
1166 <dt><code>firmware_version</code></dt>
1167 <dd>The version string of the network adapter's firmware, if
1171 <dt><code>source_ip</code></dt>
1172 <dd>The source IP address used for an IPv4 tunnel end-point,
1173 such as <code>gre</code> or <code>capwap</code>.</dd>
1176 <dt><code>tunnel_egress_iface</code></dt>
1177 <dd>Egress interface for tunnels. Currently only relevant for GRE
1178 and CAPWAP tunnels. On Linux systems, this column will show
1179 the name of the interface which is responsible for routing
1180 traffic destined for the configured <code>remote_ip</code>.
1181 This could be an internal interface such as a bridge port.</dd>
1184 <dt><code>tunnel_egress_iface_carrier</code></dt>
1185 <dd>Whether a carrier is detected on <ref
1186 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1187 and <code>up</code>.</dd>
1192 <group title="Ingress Policing">
1194 These settings control ingress policing for packets received on this
1195 interface. On a physical interface, this limits the rate at which
1196 traffic is allowed into the system from the outside; on a virtual
1197 interface (one connected to a virtual machine), this limits the rate at
1198 which the VM is able to transmit.
1201 Policing is a simple form of quality-of-service that simply drops
1202 packets received in excess of the configured rate. Due to its
1203 simplicity, policing is usually less accurate and less effective than
1204 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1205 table="Queue"/> tables).
1208 Policing is currently implemented only on Linux. The Linux
1209 implementation uses a simple ``token bucket'' approach:
1213 The size of the bucket corresponds to <ref
1214 column="ingress_policing_burst"/>. Initially the bucket is full.
1217 Whenever a packet is received, its size (converted to tokens) is
1218 compared to the number of tokens currently in the bucket. If the
1219 required number of tokens are available, they are removed and the
1220 packet is forwarded. Otherwise, the packet is dropped.
1223 Whenever it is not full, the bucket is refilled with tokens at the
1224 rate specified by <ref column="ingress_policing_rate"/>.
1228 Policing interacts badly with some network protocols, and especially
1229 with fragmented IP packets. Suppose that there is enough network
1230 activity to keep the bucket nearly empty all the time. Then this token
1231 bucket algorithm will forward a single packet every so often, with the
1232 period depending on packet size and on the configured rate. All of the
1233 fragments of an IP packets are normally transmitted back-to-back, as a
1234 group. In such a situation, therefore, only one of these fragments
1235 will be forwarded and the rest will be dropped. IP does not provide
1236 any way for the intended recipient to ask for only the remaining
1237 fragments. In such a case there are two likely possibilities for what
1238 will happen next: either all of the fragments will eventually be
1239 retransmitted (as TCP will do), in which case the same problem will
1240 recur, or the sender will not realize that its packet has been dropped
1241 and data will simply be lost (as some UDP-based protocols will do).
1242 Either way, it is possible that no forward progress will ever occur.
1244 <column name="ingress_policing_rate">
1246 Maximum rate for data received on this interface, in kbps. Data
1247 received faster than this rate is dropped. Set to <code>0</code>
1248 (the default) to disable policing.
1252 <column name="ingress_policing_burst">
1253 <p>Maximum burst size for data received on this interface, in kb. The
1254 default burst size if set to <code>0</code> is 1000 kb. This value
1255 has no effect if <ref column="ingress_policing_rate"/>
1256 is <code>0</code>.</p>
1258 Specifying a larger burst size lets the algorithm be more forgiving,
1259 which is important for protocols like TCP that react severely to
1260 dropped packets. The burst size should be at least the size of the
1261 interface's MTU. Specifying a value that is numerically at least as
1262 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1263 closer to achieving the full rate.
1268 <group title="Connectivity Fault Management">
1270 802.1ag Connectivity Fault Management (CFM) allows a group of
1271 Maintenance Points (MPs) called a Maintenance Association (MA) to
1272 detect connectivity problems with each other. MPs within a MA should
1273 have complete and exclusive interconnectivity. This is verified by
1274 occasionally broadcasting Continuity Check Messages (CCMs) at a
1275 configurable transmission interval.
1278 <column name="cfm_mpid">
1279 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1280 a Maintenance Association. The MPID is used to identify this endpoint
1281 to other Maintenance Points in the MA. Each end of a link being
1282 monitored should have a different MPID. Must be configured to enable
1283 CFM on this <ref table="Interface"/>.
1286 <column name="cfm_remote_mpid">
1287 The MPID of the remote endpoint being monitored. If this
1288 <ref table="Interface"/> does not have connectivity to an endpoint
1289 advertising the configured MPID, a fault is signalled. Must be
1290 configured to enable CFM on this <ref table="Interface"/>
1293 <column name="cfm_fault">
1294 Indicates a connectivity fault triggered by an inability to receive
1295 heartbeats from the remote endpoint. When a fault is triggered on
1296 <ref table="Interface"/>s participating in bonds, they will be
1301 <group title="Other Features">
1303 <column name="lacp_current">
1304 Boolean value indicating LACP status for this interface. If true, this
1305 interface has current LACP information about its LACP partner. This
1306 information may be used to monitor the health of interfaces in a LACP
1307 enabled port. This column will be empty if LACP is not enabled.
1310 <column name="external_ids">
1311 Key-value pairs for use by external frameworks that integrate
1312 with Open vSwitch, rather than by Open vSwitch itself. System
1313 integrators should either use the Open vSwitch development
1314 mailing list to coordinate on common key-value definitions, or
1315 choose key names that are likely to be unique. The currently
1316 defined common key-value pairs are:
1318 <dt><code>attached-mac</code></dt>
1320 The MAC address programmed into the ``virtual hardware'' for this
1321 interface, in the form
1322 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1323 For Citrix XenServer, this is the value of the <code>MAC</code>
1324 field in the VIF record for this interface.</dd>
1325 <dt><code>iface-id</code></dt>
1326 <dd>A system-unique identifier for the interface. On XenServer,
1327 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1330 Additionally the following key-value pairs specifically
1331 apply to an interface that represents a virtual Ethernet interface
1332 connected to a virtual machine. These key-value pairs should not be
1333 present for other types of interfaces. Keys whose names end
1334 in <code>-uuid</code> have values that uniquely identify the entity
1335 in question. For a Citrix XenServer hypervisor, these values are
1336 UUIDs in RFC 4122 format. Other hypervisors may use other
1339 <p>The currently defined key-value pairs for XenServer are:</p>
1341 <dt><code>xs-vif-uuid</code></dt>
1342 <dd>The virtual interface associated with this interface.</dd>
1343 <dt><code>xs-network-uuid</code></dt>
1344 <dd>The virtual network to which this interface is attached.</dd>
1345 <dt><code>xs-vm-uuid</code></dt>
1346 <dd>The VM to which this interface belongs.</dd>
1350 <column name="other_config">
1351 Key-value pairs for rarely used interface features.
1353 <dt><code>cfm_interval</code></dt>
1354 <dd> The transmission interval of CFM heartbeats in milliseconds.
1355 Three missed heartbeat receptions indicate a connectivity fault.
1356 Defaults to 1000ms. </dd>
1357 <dt><code>bond-stable-id</code></dt>
1358 <dd> A positive integer using in <code>stable</code> bond mode to
1359 make slave selection decisions. Allocating
1360 <code>bond-stable-id</code>s consistently across interfaces
1361 participating in a bond will guarantee consistent slave selection
1362 decisions across ovs-vswitchd instances when using
1363 <code>stable</code> bonding mode.</dd>
1364 <dt><code>lacp-port-id</code></dt>
1365 <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are
1366 used in LACP negotiations to identify individual ports
1367 participating in a bond. Must be a number between 1 and
1369 <dt><code>lacp-port-priority</code></dt>
1370 <dd> The LACP port priority of this <ref table="Interface"/>. In
1371 LACP negotiations <ref table="Interface"/>s with numerically lower
1372 priorities are preferred for aggregation. Must be a number between
1374 <dt><code>lacp-aggregation-key</code></dt>
1375 <dd> The LACP aggregation key of this <ref table="Interface"/>.
1376 <ref table="Interface"/>s with different aggregation keys may not
1377 be active within a given <ref table="Port"/> at the same time. Must
1378 be a number between 1 and 65535.</dd>
1382 <column name="statistics">
1384 Key-value pairs that report interface statistics. The current
1385 implementation updates these counters periodically. In the future,
1386 we plan to, instead, update them when an interface is created, when
1387 they are queried (e.g. using an OVSDB <code>select</code> operation),
1388 and just before an interface is deleted due to virtual interface
1389 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1390 regular periodic basis.</p>
1392 The currently defined key-value pairs are listed below. These are
1393 the same statistics reported by OpenFlow in its <code>struct
1394 ofp_port_stats</code> structure. If an interface does not support a
1395 given statistic, then that pair is omitted.</p>
1398 Successful transmit and receive counters:
1400 <dt><code>rx_packets</code></dt>
1401 <dd>Number of received packets.</dd>
1402 <dt><code>rx_bytes</code></dt>
1403 <dd>Number of received bytes.</dd>
1404 <dt><code>tx_packets</code></dt>
1405 <dd>Number of transmitted packets.</dd>
1406 <dt><code>tx_bytes</code></dt>
1407 <dd>Number of transmitted bytes.</dd>
1413 <dt><code>rx_dropped</code></dt>
1414 <dd>Number of packets dropped by RX.</dd>
1415 <dt><code>rx_frame_err</code></dt>
1416 <dd>Number of frame alignment errors.</dd>
1417 <dt><code>rx_over_err</code></dt>
1418 <dd>Number of packets with RX overrun.</dd>
1419 <dt><code>rx_crc_err</code></dt>
1420 <dd>Number of CRC errors.</dd>
1421 <dt><code>rx_errors</code></dt>
1423 Total number of receive errors, greater than or equal
1424 to the sum of the above.
1431 <dt><code>tx_dropped</code></dt>
1432 <dd>Number of packets dropped by TX.</dd>
1433 <dt><code>collisions</code></dt>
1434 <dd>Number of collisions.</dd>
1435 <dt><code>tx_errors</code></dt>
1437 Total number of transmit errors, greater
1438 than or equal to the sum of the above.
1447 <table name="QoS" title="Quality of Service configuration">
1448 <p>Quality of Service (QoS) configuration for each Port that
1451 <column name="type">
1452 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1453 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1454 identifies the types that a switch actually supports. The currently
1455 defined types are listed below:</p>
1457 <dt><code>linux-htb</code></dt>
1459 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1460 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1461 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1462 for information on how this classifier works and how to configure it.
1466 <dt><code>linux-hfsc</code></dt>
1468 Linux "Hierarchical Fair Service Curve" classifier.
1469 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1470 information on how this classifier works.
1475 <column name="queues">
1476 <p>A map from queue numbers to <ref table="Queue"/> records. The
1477 supported range of queue numbers depend on <ref column="type"/>. The
1478 queue numbers are the same as the <code>queue_id</code> used in
1479 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1480 structures. Queue 0 is used by OpenFlow output actions that do not
1481 specify a specific queue.</p>
1484 <column name="other_config">
1485 <p>Key-value pairs for configuring QoS features that depend on
1486 <ref column="type"/>.</p>
1487 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1488 the following key-value pairs:</p>
1490 <dt><code>max-rate</code></dt>
1491 <dd>Maximum rate shared by all queued traffic, in bit/s.
1492 Optional. If not specified, for physical interfaces, the
1493 default is the link rate. For other interfaces or if the
1494 link rate cannot be determined, the default is currently 100
1499 <column name="external_ids">
1500 Key-value pairs for use by external frameworks that integrate with Open
1501 vSwitch, rather than by Open vSwitch itself. System integrators should
1502 either use the Open vSwitch development mailing list to coordinate on
1503 common key-value definitions, or choose key names that are likely to be
1504 unique. No common key-value pairs are currently defined.
1508 <table name="Queue" title="QoS output queue.">
1509 <p>A configuration for a port output queue, used in configuring Quality of
1510 Service (QoS) features. May be referenced by <ref column="queues"
1511 table="QoS"/> column in <ref table="QoS"/> table.</p>
1513 <column name="other_config">
1514 <p>Key-value pairs for configuring the output queue. The supported
1515 key-value pairs and their meanings depend on the <ref column="type"/>
1516 of the <ref column="QoS"/> records that reference this row.</p>
1517 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1518 column="type"/> of <code>min-rate</code> are:</p>
1520 <dt><code>min-rate</code></dt>
1521 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1522 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1524 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1525 column="type"/> of <code>linux-htb</code> are:</p>
1527 <dt><code>min-rate</code></dt>
1528 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1529 <dt><code>max-rate</code></dt>
1530 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1531 queue's rate will not be allowed to exceed the specified value, even
1532 if excess bandwidth is available. If unspecified, defaults to no
1534 <dt><code>burst</code></dt>
1535 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1536 that a queue can accumulate while it is idle. Optional. Details of
1537 the <code>linux-htb</code> implementation require a minimum burst
1538 size, so a too-small <code>burst</code> will be silently
1540 <dt><code>priority</code></dt>
1541 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1542 unspecified. A queue with a smaller <code>priority</code>
1543 will receive all the excess bandwidth that it can use before
1544 a queue with a larger value receives any. Specific priority
1545 values are unimportant; only relative ordering matters.</dd>
1547 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1548 column="type"/> of <code>linux-hfsc</code> are:</p>
1550 <dt><code>min-rate</code></dt>
1551 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1552 <dt><code>max-rate</code></dt>
1553 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1554 queue's rate will not be allowed to exceed the specified value, even
1555 if excess bandwidth is available. If unspecified, defaults to no
1560 <column name="external_ids">
1561 Key-value pairs for use by external frameworks that integrate with Open
1562 vSwitch, rather than by Open vSwitch itself. System integrators should
1563 either use the Open vSwitch development mailing list to coordinate on
1564 common key-value definitions, or choose key names that are likely to be
1565 unique. No common key-value pairs are currently defined.
1569 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1570 <p>A port mirror within a <ref table="Bridge"/>.</p>
1571 <p>A port mirror configures a bridge to send selected frames to special
1572 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1573 traffic may also be referred to as SPAN or RSPAN, depending on the
1574 mechanism used for delivery.</p>
1576 <column name="name">
1577 Arbitrary identifier for the <ref table="Mirror"/>.
1580 <group title="Selecting Packets for Mirroring">
1582 To be selected for mirroring, a given packet must enter or leave the
1583 bridge through a selected port and it must also be in one of the
1587 <column name="select_all">
1588 If true, every packet arriving or departing on any port is
1589 selected for mirroring.
1592 <column name="select_dst_port">
1593 Ports on which departing packets are selected for mirroring.
1596 <column name="select_src_port">
1597 Ports on which arriving packets are selected for mirroring.
1600 <column name="select_vlan">
1601 VLANs on which packets are selected for mirroring. An empty set
1602 selects packets on all VLANs.
1606 <group title="Mirroring Destination Configuration">
1608 These columns are mutually exclusive. Exactly one of them must be
1612 <column name="output_port">
1613 <p>Output port for selected packets, if nonempty.</p>
1614 <p>Specifying a port for mirror output reserves that port exclusively
1615 for mirroring. No frames other than those selected for mirroring
1616 will be forwarded to the port, and any frames received on the port
1617 will be discarded.</p>
1618 <p>This type of mirroring is sometimes called SPAN.</p>
1621 <column name="output_vlan">
1622 <p>Output VLAN for selected packets, if nonempty.</p>
1623 <p>The frames will be sent out all ports that trunk
1624 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1625 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1626 trunk port, the frame's VLAN tag will be set to
1627 <ref column="output_vlan"/>, replacing any existing tag; when it is
1628 sent out an implicit VLAN port, the frame will not be tagged. This
1629 type of mirroring is sometimes called RSPAN.</p>
1630 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1631 contains unmanaged switches. Consider an unmanaged physical switch
1632 with two ports: port 1, connected to an end host, and port 2,
1633 connected to an Open vSwitch configured to mirror received packets
1634 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1635 port 1 that the physical switch forwards to port 2. The Open vSwitch
1636 forwards this packet to its destination and then reflects it back on
1637 port 2 in VLAN 123. This reflected packet causes the unmanaged
1638 physical switch to replace the MAC learning table entry, which
1639 correctly pointed to port 1, with one that incorrectly points to port
1640 2. Afterward, the physical switch will direct packets destined for
1641 the end host to the Open vSwitch on port 2, instead of to the end
1642 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1643 desired in this scenario, then the physical switch must be replaced
1644 by one that learns Ethernet addresses on a per-VLAN basis. In
1645 addition, learning should be disabled on the VLAN containing mirrored
1646 traffic. If this is not done then intermediate switches will learn
1647 the MAC address of each end host from the mirrored traffic. If
1648 packets being sent to that end host are also mirrored, then they will
1649 be dropped since the switch will attempt to send them out the input
1650 port. Disabling learning for the VLAN will cause the switch to
1651 correctly send the packet out all ports configured for that VLAN. If
1652 Open vSwitch is being used as an intermediate switch, learning can be
1653 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1654 in the appropriate <ref table="Bridge"/> table or tables.</p>
1658 <group title="Other Features">
1659 <column name="external_ids">
1660 Key-value pairs for use by external frameworks that integrate with Open
1661 vSwitch, rather than by Open vSwitch itself. System integrators should
1662 either use the Open vSwitch development mailing list to coordinate on
1663 common key-value definitions, or choose key names that are likely to be
1664 unique. No common key-value pairs are currently defined.
1669 <table name="Controller" title="OpenFlow controller configuration.">
1670 <p>An OpenFlow controller.</p>
1673 Open vSwitch supports two kinds of OpenFlow controllers:
1677 <dt>Primary controllers</dt>
1680 This is the kind of controller envisioned by the OpenFlow 1.0
1681 specification. Usually, a primary controller implements a network
1682 policy by taking charge of the switch's flow table.
1686 Open vSwitch initiates and maintains persistent connections to
1687 primary controllers, retrying the connection each time it fails or
1688 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1689 <ref table="Bridge"/> table applies to primary controllers.
1693 Open vSwitch permits a bridge to have any number of primary
1694 controllers. When multiple controllers are configured, Open
1695 vSwitch connects to all of them simultaneously. Because
1696 OpenFlow 1.0 does not specify how multiple controllers
1697 coordinate in interacting with a single switch, more than
1698 one primary controller should be specified only if the
1699 controllers are themselves designed to coordinate with each
1700 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1701 vendor extension may be useful for this.)
1704 <dt>Service controllers</dt>
1707 These kinds of OpenFlow controller connections are intended for
1708 occasional support and maintenance use, e.g. with
1709 <code>ovs-ofctl</code>. Usually a service controller connects only
1710 briefly to inspect or modify some of a switch's state.
1714 Open vSwitch listens for incoming connections from service
1715 controllers. The service controllers initiate and, if necessary,
1716 maintain the connections from their end. The <ref table="Bridge"
1717 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1718 not apply to service controllers.
1722 Open vSwitch supports configuring any number of service controllers.
1728 The <ref column="target"/> determines the type of controller.
1731 <group title="Core Features">
1732 <column name="target">
1733 <p>Connection method for controller.</p>
1735 The following connection methods are currently supported for primary
1739 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1741 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1742 the given <var>ip</var>, which must be expressed as an IP address
1743 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1744 column in the <ref table="Open_vSwitch"/> table must point to a
1745 valid SSL configuration when this form is used.</p>
1746 <p>SSL support is an optional feature that is not always built as
1747 part of Open vSwitch.</p>
1749 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1750 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1751 the given <var>ip</var>, which must be expressed as an IP address
1752 (not a DNS name).</dd>
1755 The following connection methods are currently supported for service
1759 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1762 Listens for SSL connections on the specified TCP <var>port</var>
1763 (default: 6633). If <var>ip</var>, which must be expressed as an
1764 IP address (not a DNS name), is specified, then connections are
1765 restricted to the specified local IP address.
1768 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1769 table="Open_vSwitch"/> table must point to a valid SSL
1770 configuration when this form is used.
1772 <p>SSL support is an optional feature that is not always built as
1773 part of Open vSwitch.</p>
1775 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1777 Listens for connections on the specified TCP <var>port</var>
1778 (default: 6633). If <var>ip</var>, which must be expressed as an
1779 IP address (not a DNS name), is specified, then connections are
1780 restricted to the specified local IP address.
1783 <p>When multiple controllers are configured for a single bridge, the
1784 <ref column="target"/> values must be unique. Duplicate
1785 <ref column="target"/> values yield unspecified results.</p>
1788 <column name="connection_mode">
1789 <p>If it is specified, this setting must be one of the following
1790 strings that describes how Open vSwitch contacts this OpenFlow
1791 controller over the network:</p>
1794 <dt><code>in-band</code></dt>
1795 <dd>In this mode, this controller's OpenFlow traffic travels over the
1796 bridge associated with the controller. With this setting, Open
1797 vSwitch allows traffic to and from the controller regardless of the
1798 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1799 would never be able to connect to the controller, because it did
1800 not have a flow to enable it.) This is the most common connection
1801 mode because it is not necessary to maintain two independent
1803 <dt><code>out-of-band</code></dt>
1804 <dd>In this mode, OpenFlow traffic uses a control network separate
1805 from the bridge associated with this controller, that is, the
1806 bridge does not use any of its own network devices to communicate
1807 with the controller. The control network must be configured
1808 separately, before or after <code>ovs-vswitchd</code> is started.
1812 <p>If not specified, the default is implementation-specific.</p>
1816 <group title="Controller Failure Detection and Handling">
1817 <column name="max_backoff">
1818 Maximum number of milliseconds to wait between connection attempts.
1819 Default is implementation-specific.
1822 <column name="inactivity_probe">
1823 Maximum number of milliseconds of idle time on connection to
1824 controller before sending an inactivity probe message. If Open
1825 vSwitch does not communicate with the controller for the specified
1826 number of seconds, it will send a probe. If a response is not
1827 received for the same additional amount of time, Open vSwitch
1828 assumes the connection has been broken and attempts to reconnect.
1829 Default is implementation-specific. A value of 0 disables
1834 <group title="OpenFlow Rate Limiting">
1835 <column name="controller_rate_limit">
1836 <p>The maximum rate at which packets in unknown flows will be
1837 forwarded to the OpenFlow controller, in packets per second. This
1838 feature prevents a single bridge from overwhelming the controller.
1839 If not specified, the default is implementation-specific.</p>
1840 <p>In addition, when a high rate triggers rate-limiting, Open
1841 vSwitch queues controller packets for each port and transmits
1842 them to the controller at the configured rate. The number of
1843 queued packets is limited by
1844 the <ref column="controller_burst_limit"/> value. The packet
1845 queue is shared fairly among the ports on a bridge.</p><p>Open
1846 vSwitch maintains two such packet rate-limiters per bridge.
1847 One of these applies to packets sent up to the controller
1848 because they do not correspond to any flow. The other applies
1849 to packets sent up to the controller by request through flow
1850 actions. When both rate-limiters are filled with packets, the
1851 actual rate that packets are sent to the controller is up to
1852 twice the specified rate.</p>
1855 <column name="controller_burst_limit">
1856 In conjunction with <ref column="controller_rate_limit"/>,
1857 the maximum number of unused packet credits that the bridge will
1858 allow to accumulate, in packets. If not specified, the default
1859 is implementation-specific.
1863 <group title="Additional In-Band Configuration">
1864 <p>These values are considered only in in-band control mode (see
1865 <ref column="connection_mode"/>).</p>
1867 <p>When multiple controllers are configured on a single bridge, there
1868 should be only one set of unique values in these columns. If different
1869 values are set for these columns in different controllers, the effect
1872 <column name="local_ip">
1873 The IP address to configure on the local port,
1874 e.g. <code>192.168.0.123</code>. If this value is unset, then
1875 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1879 <column name="local_netmask">
1880 The IP netmask to configure on the local port,
1881 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1882 but this value is unset, then the default is chosen based on whether
1883 the IP address is class A, B, or C.
1886 <column name="local_gateway">
1887 The IP address of the gateway to configure on the local port, as a
1888 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1889 this network has no gateway.
1893 <group title="Other Features">
1894 <column name="external_ids">
1895 Key-value pairs for use by external frameworks that integrate with Open
1896 vSwitch, rather than by Open vSwitch itself. System integrators should
1897 either use the Open vSwitch development mailing list to coordinate on
1898 common key-value definitions, or choose key names that are likely to be
1899 unique. No common key-value pairs are currently defined.
1903 <group title="Controller Status">
1904 <column name="is_connected">
1905 <code>true</code> if currently connected to this controller,
1906 <code>false</code> otherwise.
1909 <column name="role">
1910 <p>The level of authority this controller has on the associated
1911 bridge. Possible values are:</p>
1913 <dt><code>other</code></dt>
1914 <dd>Allows the controller access to all OpenFlow features.</dd>
1915 <dt><code>master</code></dt>
1916 <dd>Equivalent to <code>other</code>, except that there may be at
1917 most one master controller at a time. When a controller configures
1918 itself as <code>master</code>, any existing master is demoted to
1919 the <code>slave</code>role.</dd>
1920 <dt><code>slave</code></dt>
1921 <dd>Allows the controller read-only access to OpenFlow features.
1922 Attempts to modify the flow table will be rejected with an
1923 error. Slave controllers do not receive OFPT_PACKET_IN or
1924 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1929 <column name="status">
1930 <p>Key-value pairs that report controller status.</p>
1932 <dt><code>last_error</code></dt>
1933 <dd>A human-readable description of the last error on the connection
1934 to the controller; i.e. <code>strerror(errno)</code>. This key
1935 will exist only if an error has occurred.</dd>
1936 <dt><code>state</code></dt>
1937 <dd>The state of the connection to the controller. Possible values
1938 are: <code>VOID</code> (connection is disabled),
1939 <code>BACKOFF</code> (attempting to reconnect at an increasing
1940 period), <code>CONNECTING</code> (attempting to connect),
1941 <code>ACTIVE</code> (connected, remote host responsive), and
1942 <code>IDLE</code> (remote host idle, sending keep-alive). These
1943 values may change in the future. They are provided only for human
1945 <dt><code>sec_since_connect</code></dt>
1946 <dd>The amount of time since this controller last successfully
1947 connected to the switch (in seconds). Value is empty if controller
1948 has never successfully connected.</dd>
1949 <dt><code>sec_since_disconnect</code></dt>
1950 <dd>The amount of time since this controller last disconnected from
1951 the switch (in seconds). Value is empty if controller has never
1958 <table name="Manager" title="OVSDB management connection.">
1960 Configuration for a database connection to an Open vSwitch database
1965 This table primarily configures the Open vSwitch database
1966 (<code>ovsdb-server</code>), not the Open vSwitch switch
1967 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1968 what connections should be treated as in-band.
1972 The Open vSwitch database server can initiate and maintain active
1973 connections to remote clients. It can also listen for database
1977 <group title="Core Features">
1978 <column name="target">
1979 <p>Connection method for managers.</p>
1981 The following connection methods are currently supported:
1984 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1987 The specified SSL <var>port</var> (default: 6632) on the host at
1988 the given <var>ip</var>, which must be expressed as an IP address
1989 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1990 column in the <ref table="Open_vSwitch"/> table must point to a
1991 valid SSL configuration when this form is used.
1994 SSL support is an optional feature that is not always built as
1995 part of Open vSwitch.
1999 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2001 The specified TCP <var>port</var> (default: 6632) on the host at
2002 the given <var>ip</var>, which must be expressed as an IP address
2005 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2008 Listens for SSL connections on the specified TCP <var>port</var>
2009 (default: 6632). If <var>ip</var>, which must be expressed as an
2010 IP address (not a DNS name), is specified, then connections are
2011 restricted to the specified local IP address.
2014 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2015 table="Open_vSwitch"/> table must point to a valid SSL
2016 configuration when this form is used.
2019 SSL support is an optional feature that is not always built as
2020 part of Open vSwitch.
2023 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2025 Listens for connections on the specified TCP <var>port</var>
2026 (default: 6632). If <var>ip</var>, which must be expressed as an
2027 IP address (not a DNS name), is specified, then connections are
2028 restricted to the specified local IP address.
2031 <p>When multiple managers are configured, the <ref column="target"/>
2032 values must be unique. Duplicate <ref column="target"/> values yield
2033 unspecified results.</p>
2036 <column name="connection_mode">
2038 If it is specified, this setting must be one of the following strings
2039 that describes how Open vSwitch contacts this OVSDB client over the
2044 <dt><code>in-band</code></dt>
2046 In this mode, this connection's traffic travels over a bridge
2047 managed by Open vSwitch. With this setting, Open vSwitch allows
2048 traffic to and from the client regardless of the contents of the
2049 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2050 to connect to the client, because it did not have a flow to enable
2051 it.) This is the most common connection mode because it is not
2052 necessary to maintain two independent networks.
2054 <dt><code>out-of-band</code></dt>
2056 In this mode, the client's traffic uses a control network separate
2057 from that managed by Open vSwitch, that is, Open vSwitch does not
2058 use any of its own network devices to communicate with the client.
2059 The control network must be configured separately, before or after
2060 <code>ovs-vswitchd</code> is started.
2065 If not specified, the default is implementation-specific.
2070 <group title="Client Failure Detection and Handling">
2071 <column name="max_backoff">
2072 Maximum number of milliseconds to wait between connection attempts.
2073 Default is implementation-specific.
2076 <column name="inactivity_probe">
2077 Maximum number of milliseconds of idle time on connection to the client
2078 before sending an inactivity probe message. If Open vSwitch does not
2079 communicate with the client for the specified number of seconds, it
2080 will send a probe. If a response is not received for the same
2081 additional amount of time, Open vSwitch assumes the connection has been
2082 broken and attempts to reconnect. Default is implementation-specific.
2083 A value of 0 disables inactivity probes.
2087 <group title="Other Features">
2088 <column name="external_ids">
2089 Key-value pairs for use by external frameworks that integrate with Open
2090 vSwitch, rather than by Open vSwitch itself. System integrators should
2091 either use the Open vSwitch development mailing list to coordinate on
2092 common key-value definitions, or choose key names that are likely to be
2093 unique. No common key-value pairs are currently defined.
2097 <group title="Status">
2098 <column name="is_connected">
2099 <code>true</code> if currently connected to this manager,
2100 <code>false</code> otherwise.
2103 <column name="status">
2104 <p>Key-value pairs that report manager status.</p>
2106 <dt><code>last_error</code></dt>
2107 <dd>A human-readable description of the last error on the connection
2108 to the manager; i.e. <code>strerror(errno)</code>. This key
2109 will exist only if an error has occurred.</dd>
2112 <dt><code>state</code></dt>
2113 <dd>The state of the connection to the manager. Possible values
2114 are: <code>VOID</code> (connection is disabled),
2115 <code>BACKOFF</code> (attempting to reconnect at an increasing
2116 period), <code>CONNECTING</code> (attempting to connect),
2117 <code>ACTIVE</code> (connected, remote host responsive), and
2118 <code>IDLE</code> (remote host idle, sending keep-alive). These
2119 values may change in the future. They are provided only for human
2123 <dt><code>sec_since_connect</code></dt>
2124 <dd>The amount of time since this manager last successfully connected
2125 to the database (in seconds). Value is empty if manager has never
2126 successfully connected.</dd>
2129 <dt><code>sec_since_disconnect</code></dt>
2130 <dd>The amount of time since this manager last disconnected from the
2131 database (in seconds). Value is empty if manager has never
2138 <table name="NetFlow">
2139 A NetFlow target. NetFlow is a protocol that exports a number of
2140 details about terminating IP flows, such as the principals involved
2143 <column name="targets">
2144 NetFlow targets in the form
2145 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2146 must be specified numerically, not as a DNS name.
2149 <column name="engine_id">
2150 Engine ID to use in NetFlow messages. Defaults to datapath index
2154 <column name="engine_type">
2155 Engine type to use in NetFlow messages. Defaults to datapath
2156 index if not specified.
2159 <column name="active_timeout">
2160 The interval at which NetFlow records are sent for flows that are
2161 still active, in seconds. A value of <code>0</code> requests the
2162 default timeout (currently 600 seconds); a value of <code>-1</code>
2163 disables active timeouts.
2166 <column name="add_id_to_interface">
2167 <p>If this column's value is <code>false</code>, the ingress and egress
2168 interface fields of NetFlow flow records are derived from OpenFlow port
2169 numbers. When it is <code>true</code>, the 7 most significant bits of
2170 these fields will be replaced by the least significant 7 bits of the
2171 engine id. This is useful because many NetFlow collectors do not
2172 expect multiple switches to be sending messages from the same host, so
2173 they do not store the engine information which could be used to
2174 disambiguate the traffic.</p>
2175 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2178 <column name="external_ids">
2179 Key-value pairs for use by external frameworks that integrate with Open
2180 vSwitch, rather than by Open vSwitch itself. System integrators should
2181 either use the Open vSwitch development mailing list to coordinate on
2182 common key-value definitions, or choose key names that are likely to be
2183 unique. No common key-value pairs are currently defined.
2188 SSL configuration for an Open_vSwitch.
2190 <column name="private_key">
2191 Name of a PEM file containing the private key used as the switch's
2192 identity for SSL connections to the controller.
2195 <column name="certificate">
2196 Name of a PEM file containing a certificate, signed by the
2197 certificate authority (CA) used by the controller and manager,
2198 that certifies the switch's private key, identifying a trustworthy
2202 <column name="ca_cert">
2203 Name of a PEM file containing the CA certificate used to verify
2204 that the switch is connected to a trustworthy controller.
2207 <column name="bootstrap_ca_cert">
2208 If set to <code>true</code>, then Open vSwitch will attempt to
2209 obtain the CA certificate from the controller on its first SSL
2210 connection and save it to the named PEM file. If it is successful,
2211 it will immediately drop the connection and reconnect, and from then
2212 on all SSL connections must be authenticated by a certificate signed
2213 by the CA certificate thus obtained. <em>This option exposes the
2214 SSL connection to a man-in-the-middle attack obtaining the initial
2215 CA certificate.</em> It may still be useful for bootstrapping.
2218 <column name="external_ids">
2219 Key-value pairs for use by external frameworks that integrate with Open
2220 vSwitch, rather than by Open vSwitch itself. System integrators should
2221 either use the Open vSwitch development mailing list to coordinate on
2222 common key-value definitions, or choose key names that are likely to be
2223 unique. No common key-value pairs are currently defined.
2227 <table name="sFlow">
2228 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2231 <column name="agent">
2232 Name of the network device whose IP address should be reported as the
2233 ``agent address'' to collectors. If not specified, the IP address
2234 defaults to the <ref table="Controller" column="local_ip"/> in the
2235 collector's <ref table="Controller"/>. If an agent IP address cannot be
2236 determined either way, sFlow is disabled.
2239 <column name="header">
2240 Number of bytes of a sampled packet to send to the collector.
2241 If not specified, the default is 128 bytes.
2244 <column name="polling">
2245 Polling rate in seconds to send port statistics to the collector.
2246 If not specified, defaults to 30 seconds.
2249 <column name="sampling">
2250 Rate at which packets should be sampled and sent to the collector.
2251 If not specified, defaults to 400, which means one out of 400
2252 packets, on average, will be sent to the collector.
2255 <column name="targets">
2256 sFlow targets in the form
2257 <code><var>ip</var>:<var>port</var></code>.
2260 <column name="external_ids">
2261 Key-value pairs for use by external frameworks that integrate with Open
2262 vSwitch, rather than by Open vSwitch itself. System integrators should
2263 either use the Open vSwitch development mailing list to coordinate on
2264 common key-value definitions, or choose key names that are likely to be
2265 unique. No common key-value pairs are currently defined.
2269 <table name="Capability">
2270 <p>Records in this table describe functionality supported by the hardware
2271 and software platform on which this Open vSwitch is based. Clients
2272 should not modify this table.</p>
2274 <p>A record in this table is meaningful only if it is referenced by the
2275 <ref table="Open_vSwitch" column="capabilities"/> column in the
2276 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2277 the record's ``category,'' determines the meanings of the
2278 <ref column="details"/> column. The following general forms of
2279 categories are currently defined:</p>
2282 <dt><code>qos-<var>type</var></code></dt>
2283 <dd><var>type</var> is supported as the value for
2284 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2288 <column name="details">
2289 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2290 depends on the category key that the <ref table="Open_vSwitch"
2291 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2292 uses to reference this record, as described above.</p>
2294 <p>The presence of a record for category <code>qos-<var>type</var></code>
2295 indicates that the switch supports <var>type</var> as the value of
2296 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2297 table. The following key-value pairs are defined to further describe
2298 QoS capabilities:</p>
2301 <dt><code>n-queues</code></dt>
2302 <dd>Number of supported queues, as a positive integer. Keys in the
2303 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2304 records whose <ref table="QoS" column="type"/> value
2305 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob