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="other_config">
29 Key-value pairs for configuring rarely used Open vSwitch features. The
30 currently defined key-value pairs are:
32 <dt><code>enable-statistics</code></dt>
34 Set to <code>true</code> to enable populating the <ref
35 column="statistics"/> column or <code>false</code> (the default)
36 disable populating it.
41 <column name="external_ids">
42 Key-value pairs for use by external frameworks that integrate
43 with Open vSwitch, rather than by Open vSwitch itself. System
44 integrators should either use the Open vSwitch development
45 mailing list to coordinate on common key-value definitions, or
46 choose key names that are likely to be unique. The currently
47 defined common key-value pairs are:
49 <dt><code>system-id</code></dt>
50 <dd>A unique identifier for the Open vSwitch's physical host.
51 The form of the identifier depends on the type of the host.
52 On a Citrix XenServer, this will likely be the same as
53 <ref column="external_ids" key="xs-system-uuid"/>.</dd>
54 <dt><code>xs-system-uuid</code></dt>
55 <dd>The Citrix XenServer universally unique identifier for the
56 physical host as displayed by <code>xe host-list</code>.</dd>
61 <group title="Status">
62 <column name="next_cfg">
63 Sequence number for client to increment. When a client modifies
64 any part of the database configuration and wishes to wait for
65 Open vSwitch to finish applying the changes, it may increment
69 <column name="cur_cfg">
70 Sequence number that Open vSwitch sets to the current value of
71 <ref column="next_cfg"/> after it finishes applying a set of
72 configuration changes.
75 <column name="capabilities">
76 Describes functionality supported by the hardware and software platform
77 on which this Open vSwitch is based. Clients should not modify this
78 column. See the <ref table="Capability"/> description for defined
79 capability categories and the meaning of associated
80 <ref table="Capability"/> records.
83 <column name="statistics">
85 Key-value pairs that report statistics about a system running an Open
86 vSwitch. These are updated periodically (currently, every 5
87 seconds). Key-value pairs that cannot be determined or that do not
88 apply to a platform are omitted.
92 Statistics are disabled unless <ref column="other-config"
93 key="enable-statistics"/> is set to <code>true</code>.
97 <dt><code>cpu</code></dt>
100 Number of CPU processors, threads, or cores currently online and
101 available to the operating system on which Open vSwitch is
102 running, as an integer. This may be less than the number
103 installed, if some are not online or if they are not available to
104 the operating system.
107 Open vSwitch userspace processes are not multithreaded, but the
108 Linux kernel-based datapath is.
112 <dt><code>load_average</code></dt>
115 A comma-separated list of three floating-point numbers,
116 representing the system load average over the last 1, 5, and 15
117 minutes, respectively.
121 <dt><code>memory</code></dt>
124 A comma-separated list of integers, each of which represents a
125 quantity of memory in kilobytes that describes the operating
126 system on which Open vSwitch is running. In respective order,
131 <li>Total amount of RAM allocated to the OS.</li>
132 <li>RAM allocated to the OS that is in use.</li>
133 <li>RAM that can be flushed out to disk or otherwise discarded
134 if that space is needed for another purpose. This number is
135 necessarily less than or equal to the previous value.</li>
136 <li>Total disk space allocated for swap.</li>
137 <li>Swap space currently in use.</li>
141 On Linux, all five values can be determined and are included. On
142 other operating systems, only the first two values can be
143 determined, so the list will only have two values.
147 <dt><code>process_</code><var>name</var></dt>
150 One such key-value pair will exist for each running Open vSwitch
151 daemon process, with <var>name</var> replaced by the daemon's
152 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
153 comma-separated list of integers. The integers represent the
154 following, with memory measured in kilobytes and durations in
159 <li>The process's virtual memory size.</li>
160 <li>The process's resident set size.</li>
161 <li>The amount of user and system CPU time consumed by the
163 <li>The number of times that the process has crashed and been
164 automatically restarted by the monitor.</li>
165 <li>The duration since the process was started.</li>
166 <li>The duration for which the process has been running.</li>
170 The interpretation of some of these values depends on whether the
171 process was started with the <option>--monitor</option>. If it
172 was not, then the crash count will always be 0 and the two
173 durations will always be the same. If <option>--monitor</option>
174 was given, then the crash count may be positive; if it is, the
175 latter duration is the amount of time since the most recent crash
180 There will be one key-value pair for each file in Open vSwitch's
181 ``run directory'' (usually <code>/var/run/openvswitch</code>)
182 whose name ends in <code>.pid</code>, whose contents are a
183 process ID, and which is locked by a running process. The
184 <var>name</var> is taken from the pidfile's name.
188 Currently Open vSwitch is only able to obtain all of the above
189 detail on Linux systems. On other systems, the same key-value
190 pairs will be present but the values will always be the empty
195 <dt><code>file_systems</code></dt>
198 A space-separated list of information on local, writable file
199 systems. Each item in the list describes one file system and
200 consists in turn of a comma-separated list of the following:
204 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
205 Any spaces or commas in the mount point are replaced by
207 <li>Total size, in kilobytes, as an integer.</li>
208 <li>Amount of storage in use, in kilobytes, as an integer.</li>
212 This key-value pair is omitted if there are no local, writable
213 file systems or if Open vSwitch cannot obtain the needed
221 <group title="Version Reporting">
223 These columns report the types and versions of the hardware and
224 software running Open vSwitch. We recommend in general that software
225 should test whether specific features are supported instead of relying
226 on version number checks. These values are primarily intended for
227 reporting to human administrators.
230 <column name="ovs_version">
231 The Open vSwitch version number, e.g. <code>1.1.0</code>.
232 If Open vSwitch was configured with a build number, then it is
233 also included, e.g. <code>1.1.0+build6579</code>.
236 <column name="db_version">
238 The database schema version number in the form
239 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
240 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
241 a non-backward compatible way (e.g. deleting a column or a table),
242 <var>major</var> is incremented. When the database schema is changed
243 in a backward compatible way (e.g. adding a new column),
244 <var>minor</var> is incremented. When the database schema is changed
245 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
250 The schema version is part of the database schema, so it can also be
251 retrieved by fetching the schema using the Open vSwitch database
256 <column name="system_type">
258 An identifier for the type of system on top of which Open vSwitch
259 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
262 System integrators are responsible for choosing and setting an
263 appropriate value for this column.
267 <column name="system_version">
269 The version of the system identified by <ref column="system_type"/>,
270 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
273 System integrators are responsible for choosing and setting an
274 appropriate value for this column.
280 <group title="Database Configuration">
282 These columns primarily configure the Open vSwitch database
283 (<code>ovsdb-server</code>), not the Open vSwitch switch
284 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
285 column="ssl"/> settings.
289 The Open vSwitch switch does read the database configuration to
290 determine remote IP addresses to which in-band control should apply.
293 <column name="manager_options">
294 Database clients to which the Open vSwitch database server should
295 connect or to which it should listen, along with options for how these
296 connection should be configured. See the <ref table="Manager"/> table
297 for more information.
302 <table name="Bridge">
304 Configuration for a bridge within an
305 <ref table="Open_vSwitch"/>.
308 A <ref table="Bridge"/> record represents an Ethernet switch with one or
309 more ``ports,'' which are the <ref table="Port"/> records pointed to by
310 the <ref table="Bridge"/>'s <ref column="ports"/> column.
313 <group title="Core Features">
315 Bridge identifier. Should be alphanumeric and no more than about 8
316 bytes long. Must be unique among the names of ports, interfaces, and
320 <column name="ports">
321 Ports included in the bridge.
324 <column name="mirrors">
325 Port mirroring configuration.
328 <column name="netflow">
329 NetFlow configuration.
332 <column name="sflow">
336 <column name="flood_vlans">
338 VLAN IDs of VLANs on which MAC address learning should be disabled,
339 so that packets are flooded instead of being sent to specific ports
340 that are believed to contain packets' destination MACs. This should
341 ordinarily be used to disable MAC learning on VLANs used for
342 mirroring (RSPAN VLANs). It may also be useful for debugging.
345 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
346 the <ref table="Port"/> table) is incompatible with
347 <code>flood_vlans</code>. Consider using another bonding mode or
348 a different type of mirror instead.
353 <group title="OpenFlow Configuration">
354 <column name="controller">
355 OpenFlow controller set. If unset, then no OpenFlow controllers
359 <column name="fail_mode">
360 <p>When a controller is configured, it is, ordinarily, responsible
361 for setting up all flows on the switch. Thus, if the connection to
362 the controller fails, no new network connections can be set up.
363 If the connection to the controller stays down long enough,
364 no packets can pass through the switch at all. This setting
365 determines the switch's response to such a situation. It may be set
366 to one of the following:
368 <dt><code>standalone</code></dt>
369 <dd>If no message is received from the controller for three
370 times the inactivity probe interval
371 (see <ref column="inactivity_probe"/>), then Open vSwitch
372 will take over responsibility for setting up flows. In
373 this mode, Open vSwitch causes the bridge to act like an
374 ordinary MAC-learning switch. Open vSwitch will continue
375 to retry connecting to the controller in the background
376 and, when the connection succeeds, it will discontinue its
377 standalone behavior.</dd>
378 <dt><code>secure</code></dt>
379 <dd>Open vSwitch will not set up flows on its own when the
380 controller connection fails or when no controllers are
381 defined. The bridge will continue to retry connecting to
382 any defined controllers forever.</dd>
385 <p>If this value is unset, the default is implementation-specific.</p>
386 <p>When more than one controller is configured,
387 <ref column="fail_mode"/> is considered only when none of the
388 configured controllers can be contacted.</p>
391 <column name="datapath_id">
392 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
393 (Setting this column has no useful effect. Set <ref
394 column="other-config" key="datapath-id"/> instead.)
398 <group title="Other Features">
399 <column name="datapath_type">
400 Name of datapath provider. The kernel datapath has
401 type <code>system</code>. The userspace datapath has
402 type <code>netdev</code>.
405 <column name="external_ids">
406 Key-value pairs for use by external frameworks that integrate
407 with Open vSwitch, rather than by Open vSwitch itself. System
408 integrators should either use the Open vSwitch development
409 mailing list to coordinate on common key-value definitions, or
410 choose key names that are likely to be unique. The currently
411 defined key-value pairs are:
413 <dt><code>bridge-id</code></dt>
414 <dd>A unique identifier of the bridge. On Citrix XenServer this will
415 commonly be the same as
416 <ref column="external_ids" key="xs-network-uuids"/>.</dd>
417 <dt><code>xs-network-uuids</code></dt>
418 <dd>Semicolon-delimited set of universally unique identifier(s) for
419 the network with which this bridge is associated on a Citrix
420 XenServer host. The network identifiers are RFC 4122 UUIDs as
421 displayed by, e.g., <code>xe network-list</code>.</dd>
425 <column name="other_config">
426 Key-value pairs for configuring rarely used bridge
427 features. The currently defined key-value pairs are:
429 <dt><code>datapath-id</code></dt>
431 digits to set the OpenFlow datapath ID to a specific
432 value. May not be all-zero.</dd>
433 <dt><code>disable-in-band</code></dt>
434 <dd>If set to <code>true</code>, disable in-band control on
435 the bridge regardless of controller and manager settings.</dd>
436 <dt><code>hwaddr</code></dt>
437 <dd>An Ethernet address in the form
438 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
439 to set the hardware address of the local port and influence the
441 <dt><code>in-band-queue</code></dt>
443 A queue ID as a nonnegative integer. This sets the OpenFlow queue
444 ID that will be used by flows set up by in-band control on this
445 bridge. If unset, or if the port used by an in-band control flow
446 does not have QoS configured, or if the port does not have a queue
447 with the specified ID, the default queue is used instead.
449 <dt><code>flow-eviction-threshold</code></dt>
451 A number of flows as a nonnegative integer. This sets number
452 of flows at which eviction from the kernel flow table will
454 If there are a large number of flows then increasing this
455 value to around the number of flows present
456 can result in reduced CPU usage and packet loss.
462 Values below 100 will be rounded up to 100.
469 <table name="Port" table="Port or bond configuration.">
470 <p>A port within a <ref table="Bridge"/>.</p>
471 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
472 <ref column="interfaces"/> column. Such a port logically
473 corresponds to a port on a physical Ethernet switch. A port
474 with more than one interface is a ``bonded port'' (see
475 <ref group="Bonding Configuration"/>).</p>
476 <p>Some properties that one might think as belonging to a port are actually
477 part of the port's <ref table="Interface"/> members.</p>
480 Port name. Should be alphanumeric and no more than about 8
481 bytes long. May be the same as the interface name, for
482 non-bonded ports. Must otherwise be unique among the names of
483 ports, interfaces, and bridges on a host.
486 <column name="interfaces">
487 The port's interfaces. If there is more than one, this is a
491 <group title="VLAN Configuration">
492 <p>A bridge port must be configured for VLANs in one of two
493 mutually exclusive ways:
495 <li>A ``trunk port'' has an empty value for <ref
496 column="tag"/>. Its <ref column="trunks"/> value may be
497 empty or non-empty.</li>
498 <li>An ``implicitly tagged VLAN port'' or ``access port''
499 has an nonempty value for <ref column="tag"/>. Its
500 <ref column="trunks"/> value must be empty.</li>
502 If <ref column="trunks"/> and <ref column="tag"/> are both
503 nonempty, the configuration is ill-formed.
508 If this is an access port (see above), the port's implicitly
509 tagged VLAN. Must be empty if this is a trunk port.
512 Frames arriving on trunk ports will be forwarded to this
513 port only if they are tagged with the given VLAN (or, if
514 <ref column="tag"/> is 0, then if they lack a VLAN header).
515 Frames arriving on other access ports will be forwarded to
516 this port only if they have the same <ref column="tag"/>
517 value. Frames forwarded to this port will not have an
521 When a frame with a 802.1Q header that indicates a nonzero
522 VLAN is received on an access port, it is discarded.
526 <column name="trunks">
528 If this is a trunk port (see above), the 802.1Q VLAN(s) that
529 this port trunks; if it is empty, then the port trunks all
530 VLANs. Must be empty if this is an access port.
533 Frames arriving on trunk ports are dropped if they are not
534 in one of the specified VLANs. For this purpose, packets
535 that have no VLAN header are treated as part of VLAN 0.
540 <group title="Bonding Configuration">
541 <p>A port that has more than one interface is a ``bonded port.'' Bonding
542 allows for load balancing and fail-over. Some kinds of bonding will
543 work with any kind of upstream switch:</p>
546 <dt><code>balance-slb</code></dt>
548 Balances flows among slaves based on source MAC address and output
549 VLAN, with periodic rebalancing as traffic patterns change.
552 <dt><code>active-backup</code></dt>
554 Assigns all flows to one slave, failing over to a backup slave when
555 the active slave is disabled.
560 The following modes require the upstream switch to support 802.3ad with
561 successful LACP negotiation. If LACP negotiation fails then
562 <code>balance-slb</code> style flow hashing is used as a fallback:
566 <dt><code>balance-tcp</code></dt>
568 Balances flows among slaves based on L2, L3, and L4 protocol
569 information such as destination MAC address, IP address, and TCP
575 <dt><code>stable</code></dt>
577 <p>Attempts to always assign a given flow to the same slave
578 consistently. In an effort to maintain stability, no load
579 balancing is done. Uses a similar hashing strategy to
580 <code>balance-tcp</code>, always taking into account L3 and L4
581 fields even if LACP negotiations are unsuccessful. </p>
582 <p>Slave selection decisions are made based on <ref table="Interface"
583 column="other_config" key="bond-stable-id"/> if set. Otherwise,
584 OpenFlow port number is used. Decisions are consistent across all
585 <code>ovs-vswitchd</code> instances with equivalent
586 <ref table="Interface" column="other_config" key="bond-stable-id"/>
591 <p>These columns apply only to bonded ports. Their values are
592 otherwise ignored.</p>
594 <column name="bond_mode">
595 <p>The type of bonding used for a bonded port. Defaults to
596 <code>balance-slb</code> if unset.
600 <column name="bond_updelay">
601 <p>For a bonded port, the number of milliseconds for which carrier must
602 stay up on an interface before the interface is considered to be up.
603 Specify <code>0</code> to enable the interface immediately.</p>
604 <p>This setting is honored only when at least one bonded interface is
605 already enabled. When no interfaces are enabled, then the first bond
606 interface to come up is enabled immediately.</p>
609 <column name="bond_downdelay">
610 For a bonded port, the number of milliseconds for which carrier must
611 stay down on an interface before the interface is considered to be
612 down. Specify <code>0</code> to disable the interface immediately.
615 <column name="bond_fake_iface">
616 For a bonded port, whether to create a fake internal interface with the
617 name of the port. Use only for compatibility with legacy software that
622 <p>Configures LACP on this port. LACP allows directly connected
623 switches to negotiate which links may be bonded. LACP may be enabled
624 on non-bonded ports for the benefit of any switches they may be
625 connected to. <code>active</code> ports are allowed to initiate LACP
626 negotiations. <code>passive</code> ports are allowed to participate
627 in LACP negotiations initiated by a remote switch, but not allowed to
628 initiate such negotiations themselves. If unset Open vSwitch will
629 choose a reasonable default. </p>
634 <group title="Other Features">
636 Quality of Service configuration for this port.
640 The MAC address to use for this port for the purpose of choosing the
641 bridge's MAC address. This column does not necessarily reflect the
642 port's actual MAC address, nor will setting it change the port's actual
646 <column name="fake_bridge">
647 Does this port represent a sub-bridge for its tagged VLAN within the
648 Bridge? See ovs-vsctl(8) for more information.
651 <column name="external_ids">
653 Key-value pairs for use by external frameworks that integrate with
654 Open vSwitch, rather than by Open vSwitch itself. System integrators
655 should either use the Open vSwitch development mailing list to
656 coordinate on common key-value definitions, or choose key names that
657 are likely to be unique.
660 No key-value pairs native to <ref table="Port"/> are currently
661 defined. For fake bridges (see the <ref column="fake_bridge"/>
662 column), external IDs for the fake bridge are defined here by
663 prefixing a <ref table="Bridge"/> <ref table="Bridge"
664 column="external_ids"/> key with <code>fake-bridge-</code>,
665 e.g. <code>fake-bridge-xs-network-uuids</code>.
669 <column name="other_config">
670 Key-value pairs for configuring rarely used port features. The
671 currently defined key-value pairs are:
673 <dt><code>hwaddr</code></dt>
674 <dd>An Ethernet address in the form
675 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
676 <dt><code>bond-rebalance-interval</code></dt>
677 <dd>For an SLB bonded port, the number of milliseconds between
678 successive attempts to rebalance the bond, that is, to
679 move source MACs and their flows from one interface on
680 the bond to another in an attempt to keep usage of each
681 interface roughly equal. The default is 10000 (10
682 seconds), and the minimum is 1000 (1 second).</dd>
683 <dt><code>bond-detect-mode</code></dt>
684 <dd> Sets the method used to detect link failures in a bonded port.
685 Options are <code>carrier</code> and <code>miimon</code>. Defaults
686 to <code>carrier</code> which uses each interface's carrier to detect
687 failures. When set to <code>miimon</code>, will check for failures
688 by polling each interface's MII. </dd>
689 <dt><code>bond-miimon-interval</code></dt>
690 <dd> The number of milliseconds between successive attempts to
691 poll each interface's MII. Only relevant on ports which use
692 <code>miimon</code> to detect failures. </dd>
693 <dt><code>bond-hash-basis</code></dt>
694 <dd> An integer hashed along with flows when choosing output slaves.
695 When changed, all flows will be assigned different hash values
696 possibly causing slave selection decisions to change.</dd>
697 <dt><code>lacp-system-id</code></dt>
698 <dd> The LACP system ID of this <ref table="Port"/>. The system ID
699 of a LACP bond is used to identify itself to its partners. Must
700 be a nonzero MAC address.</dd>
701 <dt><code>lacp-system-priority</code></dt>
702 <dd> The LACP system priority of this <ref table="Port"/>. In
703 LACP negotiations, link status decisions are made by the system
704 with the numerically lower priority. Must be a number between 1
706 <dt><code>lacp-time</code></dt>
708 <p>The LACP timing which should be used on this
709 <ref table="Port"/>. Possible values are <code>fast</code>,
710 <code>slow</code> and a positive number of milliseconds. By
711 default <code>slow</code> is used. When configured to be
712 <code>fast</code> LACP heartbeats are requested at a rate of once
713 per second causing connectivity problems to be detected more
714 quickly. In <code>slow</code> mode, heartbeats are requested at
715 a rate of once every 30 seconds.</p>
717 <p>Users may manually set a heartbeat transmission rate to increase
718 the fault detection speed further. When manually set, OVS
719 expects the partner switch to be configured with the same
720 transmission rate. Manually setting <code>lacp-time</code> to
721 something other than <code>fast</code> or <code>slow</code> is
722 not supported by the LACP specification.</p>
724 <dt><code>lacp-heartbeat</code></dt>
725 <dd> Treats LACP like a simple heartbeat protocol for link state
726 monitoring. Most features of the LACP protocol are disabled when
727 this mode is in use.</dd>
733 <table name="Interface" title="One physical network device in a Port.">
734 An interface within a <ref table="Port"/>.
736 <group title="Core Features">
738 Interface name. Should be alphanumeric and no more than about 8 bytes
739 long. May be the same as the port name, for non-bonded ports. Must
740 otherwise be unique among the names of ports, interfaces, and bridges
745 <p>Ethernet address to set for this interface. If unset then the
746 default MAC address is used:</p>
748 <li>For the local interface, the default is the lowest-numbered MAC
749 address among the other bridge ports, either the value of the
750 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
751 if set, or its actual MAC (for bonded ports, the MAC of its slave
752 whose name is first in alphabetical order). Internal ports and
753 bridge ports that are used as port mirroring destinations (see the
754 <ref table="Mirror"/> table) are ignored.</li>
755 <li>For other internal interfaces, the default MAC is randomly
757 <li>External interfaces typically have a MAC address associated with
760 <p>Some interfaces may not have a software-controllable MAC
764 <column name="ofport">
765 <p>OpenFlow port number for this interface. Unlike most columns, this
766 column's value should be set only by Open vSwitch itself. Other
767 clients should set this column to an empty set (the default) when
768 creating an <ref table="Interface"/>.</p>
769 <p>Open vSwitch populates this column when the port number becomes
770 known. If the interface is successfully added,
771 <ref column="ofport"/> will be set to a number between 1 and 65535
772 (generally either in the range 1 to 65279, inclusive, or 65534, the
773 port number for the OpenFlow ``local port''). If the interface
774 cannot be added then Open vSwitch sets this column
779 <group title="System-Specific Details">
781 The interface type, one of:
783 <dt><code>system</code></dt>
784 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
785 Sometimes referred to as ``external interfaces'' since they are
786 generally connected to hardware external to that on which the Open
787 vSwitch is running. The empty string is a synonym for
788 <code>system</code>.</dd>
789 <dt><code>internal</code></dt>
790 <dd>A simulated network device that sends and receives traffic. An
791 internal interface whose <ref column="name"/> is the same as its
792 bridge's <ref table="Open_vSwitch" column="name"/> is called the
793 ``local interface.'' It does not make sense to bond an internal
794 interface, so the terms ``port'' and ``interface'' are often used
795 imprecisely for internal interfaces.</dd>
796 <dt><code>tap</code></dt>
797 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
798 <dt><code>gre</code></dt>
799 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
800 tunnel. Each tunnel must be uniquely identified by the
801 combination of <ref column="options" key="remote_ip"/>,
802 <ref column="options" key="local_ip"/>, and
803 <ref column="options" key="in_key"/>. Note that if two ports
804 are defined that are the same except one has an optional
805 identifier and the other does not, the more specific one is
806 matched first. <ref column="options" key="in_key"/> is considered
807 more specific than <ref column="options" key="local_ip"/> if a port
808 defines one and another port defines the other. The following
809 options may be specified in the <ref column="options"/> column:
811 <dt><code>remote_ip</code></dt>
812 <dd>Required. The tunnel endpoint.</dd>
815 <dt><code>local_ip</code></dt>
816 <dd>Optional. The destination IP that received packets must
817 match. Default is to match all addresses.</dd>
820 <dt><code>in_key</code></dt>
821 <dd>Optional. The GRE key that received packets must contain.
822 It may either be a 32-bit number (no key and a key of 0 are
823 treated as equivalent) or the word <code>flow</code>. If
824 <code>flow</code> is specified then any key will be accepted
825 and the key will be placed in the <code>tun_id</code> field
826 for matching in the flow table. The ovs-ofctl manual page
827 contains additional information about matching fields in
828 OpenFlow flows. Default is no key.</dd>
831 <dt><code>out_key</code></dt>
832 <dd>Optional. The GRE key to be set on outgoing packets. It may
833 either be a 32-bit number or the word <code>flow</code>. If
834 <code>flow</code> is specified then the key may be set using
835 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
836 is used in the absence of an action). The ovs-ofctl manual
837 page contains additional information about the Nicira OpenFlow
838 vendor extensions. Default is no key.</dd>
841 <dt><code>key</code></dt>
842 <dd>Optional. Shorthand to set <code>in_key</code> and
843 <code>out_key</code> at the same time.</dd>
846 <dt><code>tos</code></dt>
847 <dd>Optional. The value of the ToS bits to be set on the
848 encapsulating packet. It may also be the word
849 <code>inherit</code>, in which case the ToS will be copied from
850 the inner packet if it is IPv4 or IPv6 (otherwise it will be
851 0). Note that the ECN fields are always inherited. Default is
855 <dt><code>ttl</code></dt>
856 <dd>Optional. The TTL to be set on the encapsulating packet.
857 It may also be the word <code>inherit</code>, in which case the
858 TTL will be copied from the inner packet if it is IPv4 or IPv6
859 (otherwise it will be the system default, typically 64).
860 Default is the system default TTL.</dd>
863 <dt><code>csum</code></dt>
864 <dd>Optional. Compute GRE checksums on outgoing packets.
865 Checksums present on incoming packets will be validated
866 regardless of this setting. Note that GRE checksums
867 impose a significant performance penalty as they cover the
868 entire packet. As the contents of the packet is typically
869 covered by L3 and L4 checksums, this additional checksum only
870 adds value for the GRE and encapsulated Ethernet headers.
871 Default is disabled, set to <code>true</code> to enable.</dd>
874 <dt><code>df_inherit</code></dt>
875 <dd>Optional. If enabled, the Don't Fragment bit will be copied
876 from the inner IP headers (those of the encapsulated traffic)
877 to the outer (tunnel) headers. Default is disabled; set to
878 <code>true</code> to enable.</dd>
881 <dt><code>df_default</code></dt>
882 <dd>Optional. If enabled, the Don't Fragment bit will be set by
883 default on tunnel headers if the <code>df_inherit</code> option
884 is not set, or if the encapsulated packet is not IP. Default
885 is enabled; set to <code>false</code> to disable.</dd>
888 <dt><code>pmtud</code></dt>
889 <dd>Optional. Enable tunnel path MTU discovery. If enabled
890 ``ICMP Destination Unreachable - Fragmentation Needed''
891 messages will be generated for IPv4 packets with the DF bit set
892 and IPv6 packets above the minimum MTU if the packet size
893 exceeds the path MTU minus the size of the tunnel headers.
894 Note that this option causes behavior that is typically
895 reserved for routers and therefore is not entirely in
896 compliance with the IEEE 802.1D specification for bridges.
897 Default is enabled; set to <code>false</code> to disable.</dd>
900 <dt><code>header_cache</code></dt>
901 <dd>Optional. Enable caching of tunnel headers and the output
902 path. This can lead to a significant performance increase
903 without changing behavior. In general it should not be
904 necessary to adjust this setting. However, the caching can
905 bypass certain components of the IP stack (such as IP tables)
906 and it may be useful to disable it if these features are
907 required or as a debugging measure. Default is enabled, set to
908 <code>false</code> to disable.</dd>
911 <dt><code>ipsec_gre</code></dt>
912 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
913 over IPv4 IPsec tunnel. Each tunnel (including those of type
914 <code>gre</code>) must be uniquely identified by the
915 combination of <ref column="options" key="remote_ip"/> and
916 <ref column="options" key="local_ip"/>. Note that if two ports are
917 defined that are the same except one has an optional identifier and
918 the other does not, the more specific one is matched first.
919 An authentication method of <ref column="options" key="peer_cert"/>
920 or <ref column="options" key="psk"/> must be defined. The
921 following options may be specified in the <ref column="options"/>
924 <dt><code>remote_ip</code></dt>
925 <dd>Required. The tunnel endpoint.</dd>
928 <dt><code>local_ip</code></dt>
929 <dd>Optional. The destination IP that received packets must
930 match. Default is to match all addresses.</dd>
933 <dt><code>peer_cert</code></dt>
934 <dd>Required for certificate authentication. A string
935 containing the peer's certificate in PEM format.
936 Additionally the host's certificate must be specified
937 with the <code>certificate</code> option.</dd>
940 <dt><code>certificate</code></dt>
941 <dd>Required for certificate authentication. The name of a
942 PEM file containing a certificate that will be presented
943 to the peer during authentication.</dd>
946 <dt><code>private_key</code></dt>
947 <dd>Optional for certificate authentication. The name of
948 a PEM file containing the private key associated with
949 <code>certificate</code>. If <code>certificate</code>
950 contains the private key, this option may be omitted.</dd>
953 <dt><code>psk</code></dt>
954 <dd>Required for pre-shared key authentication. Specifies a
955 pre-shared key for authentication that must be identical on
956 both sides of the tunnel.</dd>
959 <dt><code>in_key</code></dt>
960 <dd>Optional. The GRE key that received packets must contain.
961 It may either be a 32-bit number (no key and a key of 0 are
962 treated as equivalent) or the word <code>flow</code>. If
963 <code>flow</code> is specified then any key will be accepted
964 and the key will be placed in the <code>tun_id</code> field
965 for matching in the flow table. The ovs-ofctl manual page
966 contains additional information about matching fields in
967 OpenFlow flows. Default is no key.</dd>
970 <dt><code>out_key</code></dt>
971 <dd>Optional. The GRE key to be set on outgoing packets. It may
972 either be a 32-bit number or the word <code>flow</code>. If
973 <code>flow</code> is specified then the key may be set using
974 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
975 is used in the absence of an action). The ovs-ofctl manual
976 page contains additional information about the Nicira OpenFlow
977 vendor extensions. Default is no key.</dd>
980 <dt><code>key</code></dt>
981 <dd>Optional. Shorthand to set <code>in_key</code> and
982 <code>out_key</code> at the same time.</dd>
985 <dt><code>tos</code></dt>
986 <dd>Optional. The value of the ToS bits to be set on the
987 encapsulating packet. It may also be the word
988 <code>inherit</code>, in which case the ToS will be copied from
989 the inner packet if it is IPv4 or IPv6 (otherwise it will be
990 0). Note that the ECN fields are always inherited. Default is
994 <dt><code>ttl</code></dt>
995 <dd>Optional. The TTL to be set on the encapsulating packet.
996 It may also be the word <code>inherit</code>, in which case the
997 TTL will be copied from the inner packet if it is IPv4 or IPv6
998 (otherwise it will be the system default, typically 64).
999 Default is the system default TTL.</dd>
1002 <dt><code>csum</code></dt>
1003 <dd>Optional. Compute GRE checksums on outgoing packets.
1004 Checksums present on incoming packets will be validated
1005 regardless of this setting. Note that GRE checksums
1006 impose a significant performance penalty as they cover the
1007 entire packet. As the contents of the packet is typically
1008 covered by L3 and L4 checksums, this additional checksum only
1009 adds value for the GRE and encapsulated Ethernet headers.
1010 Default is disabled, set to <code>true</code> to enable.</dd>
1013 <dt><code>df_inherit</code></dt>
1014 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1015 from the inner IP headers (those of the encapsulated traffic)
1016 to the outer (tunnel) headers. Default is disabled; set to
1017 <code>true</code> to enable.</dd>
1020 <dt><code>df_default</code></dt>
1021 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1022 default on tunnel headers if the <code>df_inherit</code> option
1023 is not set, or if the encapsulated packet is not IP. Default
1024 is enabled; set to <code>false</code> to disable.</dd>
1027 <dt><code>pmtud</code></dt>
1028 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1029 ``ICMP Destination Unreachable - Fragmentation Needed''
1030 messages will be generated for IPv4 packets with the DF bit set
1031 and IPv6 packets above the minimum MTU if the packet size
1032 exceeds the path MTU minus the size of the tunnel headers.
1033 Note that this option causes behavior that is typically
1034 reserved for routers and therefore is not entirely in
1035 compliance with the IEEE 802.1D specification for bridges.
1036 Default is enabled; set to <code>false</code> to disable.</dd>
1039 <dt><code>capwap</code></dt>
1040 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
1041 (RFC 5415). This allows interoperability with certain switches
1042 where GRE is not available. Note that only the tunneling component
1043 of the protocol is implemented. Due to the non-standard use of
1044 CAPWAP, UDP ports 58881 and 58882 are used as the source and
1045 destination ports respectively. Each tunnel must be uniquely
1046 identified by the combination of
1047 <ref column="options" key="remote_ip"/> and
1048 <ref column="options" key="local_ip"/>. If two ports are defined
1049 that are the same except one includes
1050 <ref column="options" key="local_ip"/> and the other does not, the
1051 more specific one is matched first. CAPWAP support is not
1052 available on all platforms. Currently it is only supported in the
1053 Linux kernel module with kernel versions >= 2.6.25. The following
1054 options may be specified in the <ref column="options"/> column:
1056 <dt><code>remote_ip</code></dt>
1057 <dd>Required. The tunnel endpoint.</dd>
1060 <dt><code>local_ip</code></dt>
1061 <dd>Optional. The destination IP that received packets must
1062 match. Default is to match all addresses.</dd>
1065 <dt><code>tos</code></dt>
1066 <dd>Optional. The value of the ToS bits to be set on the
1067 encapsulating packet. It may also be the word
1068 <code>inherit</code>, in which case the ToS will be copied from
1069 the inner packet if it is IPv4 or IPv6 (otherwise it will be
1070 0). Note that the ECN fields are always inherited. Default is
1074 <dt><code>ttl</code></dt>
1075 <dd>Optional. The TTL to be set on the encapsulating packet.
1076 It may also be the word <code>inherit</code>, in which case the
1077 TTL will be copied from the inner packet if it is IPv4 or IPv6
1078 (otherwise it will be the system default, typically 64).
1079 Default is the system default TTL.</dd>
1082 <dt><code>df_inherit</code></dt>
1083 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1084 from the inner IP headers (those of the encapsulated traffic)
1085 to the outer (tunnel) headers. Default is disabled; set to
1086 <code>true</code> to enable.</dd>
1089 <dt><code>df_default</code></dt>
1090 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1091 default on tunnel headers if the <code>df_inherit</code> option
1092 is not set, or if the encapsulated packet is not IP. Default
1093 is enabled; set to <code>false</code> to disable.</dd>
1096 <dt><code>pmtud</code></dt>
1097 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1098 ``ICMP Destination Unreachable - Fragmentation Needed''
1099 messages will be generated for IPv4 packets with the DF bit set
1100 and IPv6 packets above the minimum MTU if the packet size
1101 exceeds the path MTU minus the size of the tunnel headers.
1102 Note that this option causes behavior that is typically
1103 reserved for routers and therefore is not entirely in
1104 compliance with the IEEE 802.1D specification for bridges.
1105 Default is enabled; set to <code>false</code> to disable.</dd>
1108 <dt><code>header_cache</code></dt>
1109 <dd>Optional. Enable caching of tunnel headers and the output
1110 path. This can lead to a significant performance increase
1111 without changing behavior. In general it should not be
1112 necessary to adjust this setting. However, the caching can
1113 bypass certain components of the IP stack (such as IP tables)
1114 and it may be useful to disable it if these features are
1115 required or as a debugging measure. Default is enabled, set to
1116 <code>false</code> to disable.</dd>
1119 <dt><code>patch</code></dt>
1122 A pair of virtual devices that act as a patch cable. The <ref
1123 column="options"/> column must have the following key-value pair:
1126 <dt><code>peer</code></dt>
1128 The <ref column="name"/> of the <ref table="Interface"/> for
1129 the other side of the patch. The named <ref
1130 table="Interface"/>'s own <code>peer</code> option must specify
1131 this <ref table="Interface"/>'s name. That is, the two patch
1132 interfaces must have reversed <ref column="name"/> and
1133 <code>peer</code> values.
1137 <dt><code>null</code></dt>
1138 <dd>An ignored interface.</dd>
1142 <column name="options">
1143 Configuration options whose interpretation varies based on
1144 <ref column="type"/>.
1148 <group title="Interface Status">
1150 Status information about interfaces attached to bridges, updated every
1151 5 seconds. Not all interfaces have all of these properties; virtual
1152 interfaces don't have a link speed, for example. Non-applicable
1153 columns will have empty values.
1155 <column name="admin_state">
1157 The administrative state of the physical network link.
1161 <column name="link_state">
1163 The observed state of the physical network link. This is ordinarily
1164 the link's carrier status. If the interface's <ref table="Port"/> is
1165 a bond configured for miimon monitoring, it is instead the network
1166 link's miimon status.
1170 <column name="link_speed">
1172 The negotiated speed of the physical network link.
1173 Valid values are positive integers greater than 0.
1177 <column name="duplex">
1179 The duplex mode of the physical network link.
1185 The MTU (maximum transmission unit); i.e. the largest
1186 amount of data that can fit into a single Ethernet frame.
1187 The standard Ethernet MTU is 1500 bytes. Some physical media
1188 and many kinds of virtual interfaces can be configured with
1192 This column will be empty for an interface that does not
1193 have an MTU as, for example, some kinds of tunnels do not.
1197 <column name="status">
1199 Key-value pairs that report port status. Supported status values are
1200 <ref column="type"/>-dependent; some interfaces may not have a valid
1201 <ref column="status" key="driver_name"/>, for example.
1203 <p>The currently defined key-value pairs are:</p>
1205 <dt><code>driver_name</code></dt>
1206 <dd>The name of the device driver controlling the network
1210 <dt><code>driver_version</code></dt>
1211 <dd>The version string of the device driver controlling the
1212 network adapter.</dd>
1215 <dt><code>firmware_version</code></dt>
1216 <dd>The version string of the network adapter's firmware, if
1220 <dt><code>source_ip</code></dt>
1221 <dd>The source IP address used for an IPv4 tunnel end-point,
1222 such as <code>gre</code> or <code>capwap</code>.</dd>
1225 <dt><code>tunnel_egress_iface</code></dt>
1226 <dd>Egress interface for tunnels. Currently only relevant for GRE
1227 and CAPWAP tunnels. On Linux systems, this column will show
1228 the name of the interface which is responsible for routing
1229 traffic destined for the configured
1230 <ref column="options" key="remote_ip"/>. This could be an
1231 internal interface such as a bridge port.</dd>
1234 <dt><code>tunnel_egress_iface_carrier</code></dt>
1235 <dd>Whether a carrier is detected on
1236 <ref column="status" key="tunnel_egress_iface"/>. Valid values
1237 are <code>down</code> and <code>up</code>.</dd>
1242 <group title="Ingress Policing">
1244 These settings control ingress policing for packets received on this
1245 interface. On a physical interface, this limits the rate at which
1246 traffic is allowed into the system from the outside; on a virtual
1247 interface (one connected to a virtual machine), this limits the rate at
1248 which the VM is able to transmit.
1251 Policing is a simple form of quality-of-service that simply drops
1252 packets received in excess of the configured rate. Due to its
1253 simplicity, policing is usually less accurate and less effective than
1254 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1255 table="Queue"/> tables).
1258 Policing is currently implemented only on Linux. The Linux
1259 implementation uses a simple ``token bucket'' approach:
1263 The size of the bucket corresponds to <ref
1264 column="ingress_policing_burst"/>. Initially the bucket is full.
1267 Whenever a packet is received, its size (converted to tokens) is
1268 compared to the number of tokens currently in the bucket. If the
1269 required number of tokens are available, they are removed and the
1270 packet is forwarded. Otherwise, the packet is dropped.
1273 Whenever it is not full, the bucket is refilled with tokens at the
1274 rate specified by <ref column="ingress_policing_rate"/>.
1278 Policing interacts badly with some network protocols, and especially
1279 with fragmented IP packets. Suppose that there is enough network
1280 activity to keep the bucket nearly empty all the time. Then this token
1281 bucket algorithm will forward a single packet every so often, with the
1282 period depending on packet size and on the configured rate. All of the
1283 fragments of an IP packets are normally transmitted back-to-back, as a
1284 group. In such a situation, therefore, only one of these fragments
1285 will be forwarded and the rest will be dropped. IP does not provide
1286 any way for the intended recipient to ask for only the remaining
1287 fragments. In such a case there are two likely possibilities for what
1288 will happen next: either all of the fragments will eventually be
1289 retransmitted (as TCP will do), in which case the same problem will
1290 recur, or the sender will not realize that its packet has been dropped
1291 and data will simply be lost (as some UDP-based protocols will do).
1292 Either way, it is possible that no forward progress will ever occur.
1294 <column name="ingress_policing_rate">
1296 Maximum rate for data received on this interface, in kbps. Data
1297 received faster than this rate is dropped. Set to <code>0</code>
1298 (the default) to disable policing.
1302 <column name="ingress_policing_burst">
1303 <p>Maximum burst size for data received on this interface, in kb. The
1304 default burst size if set to <code>0</code> is 1000 kb. This value
1305 has no effect if <ref column="ingress_policing_rate"/>
1306 is <code>0</code>.</p>
1308 Specifying a larger burst size lets the algorithm be more forgiving,
1309 which is important for protocols like TCP that react severely to
1310 dropped packets. The burst size should be at least the size of the
1311 interface's MTU. Specifying a value that is numerically at least as
1312 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1313 closer to achieving the full rate.
1318 <group title="Connectivity Fault Management">
1320 802.1ag Connectivity Fault Management (CFM) allows a group of
1321 Maintenance Points (MPs) called a Maintenance Association (MA) to
1322 detect connectivity problems with each other. MPs within a MA should
1323 have complete and exclusive interconnectivity. This is verified by
1324 occasionally broadcasting Continuity Check Messages (CCMs) at a
1325 configurable transmission interval.
1328 <column name="cfm_mpid">
1329 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1330 a Maintenance Association. The MPID is used to identify this endpoint
1331 to other Maintenance Points in the MA. Each end of a link being
1332 monitored should have a different MPID. Must be configured to enable
1333 CFM on this <ref table="Interface"/>.
1336 <column name="cfm_remote_mpid">
1337 The MPID of the remote endpoint being monitored. If this
1338 <ref table="Interface"/> does not have connectivity to an endpoint
1339 advertising the configured MPID, a fault is signalled. Must be
1340 configured to enable CFM on this <ref table="Interface"/>
1343 <column name="cfm_fault">
1344 Indicates a connectivity fault triggered by an inability to receive
1345 heartbeats from the remote endpoint. When a fault is triggered on
1346 <ref table="Interface"/>s participating in bonds, they will be
1351 <group title="Other Features">
1353 <column name="lacp_current">
1354 Boolean value indicating LACP status for this interface. If true, this
1355 interface has current LACP information about its LACP partner. This
1356 information may be used to monitor the health of interfaces in a LACP
1357 enabled port. This column will be empty if LACP is not enabled.
1360 <column name="external_ids">
1361 Key-value pairs for use by external frameworks that integrate
1362 with Open vSwitch, rather than by Open vSwitch itself. System
1363 integrators should either use the Open vSwitch development
1364 mailing list to coordinate on common key-value definitions, or
1365 choose key names that are likely to be unique. The currently
1366 defined common key-value pairs are:
1368 <dt><code>attached-mac</code></dt>
1370 The MAC address programmed into the ``virtual hardware'' for this
1371 interface, in the form
1372 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1373 For Citrix XenServer, this is the value of the <code>MAC</code>
1374 field in the VIF record for this interface.</dd>
1375 <dt><code>iface-id</code></dt>
1376 <dd>A system-unique identifier for the interface. On XenServer,
1377 this will commonly be the same as
1378 <ref column="external_ids" key="xs-vif-uuid"/>.</dd>
1381 Additionally the following key-value pairs specifically
1382 apply to an interface that represents a virtual Ethernet interface
1383 connected to a virtual machine. These key-value pairs should not be
1384 present for other types of interfaces. Keys whose names end
1385 in <code>-uuid</code> have values that uniquely identify the entity
1386 in question. For a Citrix XenServer hypervisor, these values are
1387 UUIDs in RFC 4122 format. Other hypervisors may use other
1390 <p>The currently defined key-value pairs for XenServer are:</p>
1392 <dt><code>xs-vif-uuid</code></dt>
1393 <dd>The virtual interface associated with this interface.</dd>
1394 <dt><code>xs-network-uuid</code></dt>
1395 <dd>The virtual network to which this interface is attached.</dd>
1396 <dt><code>xs-vm-uuid</code></dt>
1397 <dd>The VM to which this interface belongs.</dd>
1401 <column name="other_config">
1402 Key-value pairs for rarely used interface features.
1404 <dt><code>cfm_interval</code></dt>
1405 <dd> The transmission interval of CFM heartbeats in milliseconds.
1406 Three missed heartbeat receptions indicate a connectivity fault.
1407 Defaults to 1000ms. </dd>
1408 <dt><code>bond-stable-id</code></dt>
1409 <dd> A positive integer using in <code>stable</code> bond mode to
1410 make slave selection decisions. Allocating
1411 <ref column="other_config" key="bond-stable-id"/> values
1412 consistently across interfaces participating in a bond will
1413 guarantee consistent slave selection decisions across
1414 <code>ovs-vswitchd</code> instances when using <code>stable</code>
1416 <dt><code>lacp-port-id</code></dt>
1417 <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are
1418 used in LACP negotiations to identify individual ports
1419 participating in a bond. Must be a number between 1 and
1421 <dt><code>lacp-port-priority</code></dt>
1422 <dd> The LACP port priority of this <ref table="Interface"/>. In
1423 LACP negotiations <ref table="Interface"/>s with numerically lower
1424 priorities are preferred for aggregation. Must be a number between
1426 <dt><code>lacp-aggregation-key</code></dt>
1427 <dd> The LACP aggregation key of this <ref table="Interface"/>.
1428 <ref table="Interface"/>s with different aggregation keys may not
1429 be active within a given <ref table="Port"/> at the same time. Must
1430 be a number between 1 and 65535.</dd>
1434 <column name="statistics">
1436 Key-value pairs that report interface statistics. The current
1437 implementation updates these counters periodically. In the future,
1438 we plan to, instead, update them when an interface is created, when
1439 they are queried (e.g. using an OVSDB <code>select</code> operation),
1440 and just before an interface is deleted due to virtual interface
1441 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1442 regular periodic basis.</p>
1444 The currently defined key-value pairs are listed below. These are
1445 the same statistics reported by OpenFlow in its <code>struct
1446 ofp_port_stats</code> structure. If an interface does not support a
1447 given statistic, then that pair is omitted.</p>
1450 Successful transmit and receive counters:
1452 <dt><code>rx_packets</code></dt>
1453 <dd>Number of received packets.</dd>
1454 <dt><code>rx_bytes</code></dt>
1455 <dd>Number of received bytes.</dd>
1456 <dt><code>tx_packets</code></dt>
1457 <dd>Number of transmitted packets.</dd>
1458 <dt><code>tx_bytes</code></dt>
1459 <dd>Number of transmitted bytes.</dd>
1465 <dt><code>rx_dropped</code></dt>
1466 <dd>Number of packets dropped by RX.</dd>
1467 <dt><code>rx_frame_err</code></dt>
1468 <dd>Number of frame alignment errors.</dd>
1469 <dt><code>rx_over_err</code></dt>
1470 <dd>Number of packets with RX overrun.</dd>
1471 <dt><code>rx_crc_err</code></dt>
1472 <dd>Number of CRC errors.</dd>
1473 <dt><code>rx_errors</code></dt>
1475 Total number of receive errors, greater than or equal
1476 to the sum of the above.
1483 <dt><code>tx_dropped</code></dt>
1484 <dd>Number of packets dropped by TX.</dd>
1485 <dt><code>collisions</code></dt>
1486 <dd>Number of collisions.</dd>
1487 <dt><code>tx_errors</code></dt>
1489 Total number of transmit errors, greater
1490 than or equal to the sum of the above.
1499 <table name="QoS" title="Quality of Service configuration">
1500 <p>Quality of Service (QoS) configuration for each Port that
1503 <column name="type">
1504 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1505 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1506 identifies the types that a switch actually supports. The currently
1507 defined types are listed below:</p>
1509 <dt><code>linux-htb</code></dt>
1511 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1512 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1513 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1514 for information on how this classifier works and how to configure it.
1518 <dt><code>linux-hfsc</code></dt>
1520 Linux "Hierarchical Fair Service Curve" classifier.
1521 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1522 information on how this classifier works.
1527 <column name="queues">
1528 <p>A map from queue numbers to <ref table="Queue"/> records. The
1529 supported range of queue numbers depend on <ref column="type"/>. The
1530 queue numbers are the same as the <code>queue_id</code> used in
1531 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1532 structures. Queue 0 is used by OpenFlow output actions that do not
1533 specify a specific queue.</p>
1536 <column name="other_config">
1537 <p>Key-value pairs for configuring QoS features that depend on
1538 <ref column="type"/>.</p>
1539 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1540 the following key-value pairs:</p>
1542 <dt><code>max-rate</code></dt>
1543 <dd>Maximum rate shared by all queued traffic, in bit/s.
1544 Optional. If not specified, for physical interfaces, the
1545 default is the link rate. For other interfaces or if the
1546 link rate cannot be determined, the default is currently 100
1551 <column name="external_ids">
1552 Key-value pairs for use by external frameworks that integrate with Open
1553 vSwitch, rather than by Open vSwitch itself. System integrators should
1554 either use the Open vSwitch development mailing list to coordinate on
1555 common key-value definitions, or choose key names that are likely to be
1556 unique. No common key-value pairs are currently defined.
1560 <table name="Queue" title="QoS output queue.">
1561 <p>A configuration for a port output queue, used in configuring Quality of
1562 Service (QoS) features. May be referenced by <ref column="queues"
1563 table="QoS"/> column in <ref table="QoS"/> table.</p>
1565 <column name="other_config">
1566 <p>Key-value pairs for configuring the output queue. The supported
1567 key-value pairs and their meanings depend on the <ref column="type"/>
1568 of the <ref column="QoS"/> records that reference this row.</p>
1569 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1570 column="type"/> of <code>min-rate</code> are:</p>
1572 <dt><code>min-rate</code></dt>
1573 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1574 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1576 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1577 column="type"/> of <code>linux-htb</code> are:</p>
1579 <dt><code>min-rate</code></dt>
1580 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1581 <dt><code>max-rate</code></dt>
1582 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1583 queue's rate will not be allowed to exceed the specified value, even
1584 if excess bandwidth is available. If unspecified, defaults to no
1586 <dt><code>burst</code></dt>
1587 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1588 that a queue can accumulate while it is idle. Optional. Details of
1589 the <code>linux-htb</code> implementation require a minimum burst
1590 size, so a too-small <code>burst</code> will be silently
1592 <dt><code>priority</code></dt>
1593 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1594 unspecified. A queue with a smaller <code>priority</code>
1595 will receive all the excess bandwidth that it can use before
1596 a queue with a larger value receives any. Specific priority
1597 values are unimportant; only relative ordering matters.</dd>
1599 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1600 column="type"/> of <code>linux-hfsc</code> are:</p>
1602 <dt><code>min-rate</code></dt>
1603 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1604 <dt><code>max-rate</code></dt>
1605 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1606 queue's rate will not be allowed to exceed the specified value, even
1607 if excess bandwidth is available. If unspecified, defaults to no
1612 <column name="external_ids">
1613 Key-value pairs for use by external frameworks that integrate with Open
1614 vSwitch, rather than by Open vSwitch itself. System integrators should
1615 either use the Open vSwitch development mailing list to coordinate on
1616 common key-value definitions, or choose key names that are likely to be
1617 unique. No common key-value pairs are currently defined.
1621 <table name="Mirror" title="Port mirroring (SPAN/RSPAN/ERSPAN).">
1622 <p>A port mirror within a <ref table="Bridge"/>.</p>
1623 <p>A port mirror configures a bridge to send selected frames to special
1624 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1625 traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
1626 the mirrored traffic is sent.</p>
1628 <column name="name">
1629 Arbitrary identifier for the <ref table="Mirror"/>.
1632 <group title="Selecting Packets for Mirroring">
1634 To be selected for mirroring, a given packet must enter or leave the
1635 bridge through a selected port and it must also be in one of the
1639 <column name="select_all">
1640 If true, every packet arriving or departing on any port is
1641 selected for mirroring.
1644 <column name="select_dst_port">
1645 Ports on which departing packets are selected for mirroring.
1648 <column name="select_src_port">
1649 Ports on which arriving packets are selected for mirroring.
1652 <column name="select_vlan">
1653 VLANs on which packets are selected for mirroring. An empty set
1654 selects packets on all VLANs.
1658 <group title="Mirroring Destination Configuration">
1660 These columns are mutually exclusive. Exactly one of them must be
1664 <column name="output_port">
1665 <p>Output port for selected packets, if nonempty.</p>
1666 <p>Specifying a port for mirror output reserves that port exclusively
1667 for mirroring. No frames other than those selected for mirroring
1668 will be forwarded to the port, and any frames received on the port
1669 will be discarded.</p>
1671 The output port may be any kind of port supported by Open vSwitch.
1672 It may be, for example, a physical port (sometimes called SPAN), or a
1673 GRE tunnel (sometimes called ERSPAN).
1677 <column name="output_vlan">
1678 <p>Output VLAN for selected packets, if nonempty.</p>
1679 <p>The frames will be sent out all ports that trunk
1680 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1681 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1682 trunk port, the frame's VLAN tag will be set to
1683 <ref column="output_vlan"/>, replacing any existing tag; when it is
1684 sent out an implicit VLAN port, the frame will not be tagged. This
1685 type of mirroring is sometimes called RSPAN.</p>
1687 The following destination MAC addresses will not be mirrored to a
1688 VLAN to avoid confusing switches that interpret the protocols that
1692 <dt><code>01:80:c2:00:00:00</code></dt>
1693 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1695 <dt><code>01:80:c2:00:00:01</code></dt>
1696 <dd>IEEE Pause frame.</dd>
1698 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1699 <dd>Other reserved protocols.</dd>
1701 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1703 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1704 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1708 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1709 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1711 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1712 <dd>Cisco STP Uplink Fast.</dd>
1714 <dt><code>01:00:0c:00:00:00</code></dt>
1715 <dd>Cisco Inter Switch Link.</dd>
1717 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1718 contains unmanaged switches. Consider an unmanaged physical switch
1719 with two ports: port 1, connected to an end host, and port 2,
1720 connected to an Open vSwitch configured to mirror received packets
1721 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1722 port 1 that the physical switch forwards to port 2. The Open vSwitch
1723 forwards this packet to its destination and then reflects it back on
1724 port 2 in VLAN 123. This reflected packet causes the unmanaged
1725 physical switch to replace the MAC learning table entry, which
1726 correctly pointed to port 1, with one that incorrectly points to port
1727 2. Afterward, the physical switch will direct packets destined for
1728 the end host to the Open vSwitch on port 2, instead of to the end
1729 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1730 desired in this scenario, then the physical switch must be replaced
1731 by one that learns Ethernet addresses on a per-VLAN basis. In
1732 addition, learning should be disabled on the VLAN containing mirrored
1733 traffic. If this is not done then intermediate switches will learn
1734 the MAC address of each end host from the mirrored traffic. If
1735 packets being sent to that end host are also mirrored, then they will
1736 be dropped since the switch will attempt to send them out the input
1737 port. Disabling learning for the VLAN will cause the switch to
1738 correctly send the packet out all ports configured for that VLAN. If
1739 Open vSwitch is being used as an intermediate switch, learning can be
1740 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1741 in the appropriate <ref table="Bridge"/> table or tables.</p>
1743 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
1744 VLAN and should generally be preferred.
1749 <group title="Other Features">
1750 <column name="external_ids">
1751 Key-value pairs for use by external frameworks that integrate with Open
1752 vSwitch, rather than by Open vSwitch itself. System integrators should
1753 either use the Open vSwitch development mailing list to coordinate on
1754 common key-value definitions, or choose key names that are likely to be
1755 unique. No common key-value pairs are currently defined.
1760 <table name="Controller" title="OpenFlow controller configuration.">
1761 <p>An OpenFlow controller.</p>
1764 Open vSwitch supports two kinds of OpenFlow controllers:
1768 <dt>Primary controllers</dt>
1771 This is the kind of controller envisioned by the OpenFlow 1.0
1772 specification. Usually, a primary controller implements a network
1773 policy by taking charge of the switch's flow table.
1777 Open vSwitch initiates and maintains persistent connections to
1778 primary controllers, retrying the connection each time it fails or
1779 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1780 <ref table="Bridge"/> table applies to primary controllers.
1784 Open vSwitch permits a bridge to have any number of primary
1785 controllers. When multiple controllers are configured, Open
1786 vSwitch connects to all of them simultaneously. Because
1787 OpenFlow 1.0 does not specify how multiple controllers
1788 coordinate in interacting with a single switch, more than
1789 one primary controller should be specified only if the
1790 controllers are themselves designed to coordinate with each
1791 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1792 vendor extension may be useful for this.)
1795 <dt>Service controllers</dt>
1798 These kinds of OpenFlow controller connections are intended for
1799 occasional support and maintenance use, e.g. with
1800 <code>ovs-ofctl</code>. Usually a service controller connects only
1801 briefly to inspect or modify some of a switch's state.
1805 Open vSwitch listens for incoming connections from service
1806 controllers. The service controllers initiate and, if necessary,
1807 maintain the connections from their end. The <ref table="Bridge"
1808 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1809 not apply to service controllers.
1813 Open vSwitch supports configuring any number of service controllers.
1819 The <ref column="target"/> determines the type of controller.
1822 <group title="Core Features">
1823 <column name="target">
1824 <p>Connection method for controller.</p>
1826 The following connection methods are currently supported for primary
1830 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1832 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1833 the given <var>ip</var>, which must be expressed as an IP address
1834 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1835 column in the <ref table="Open_vSwitch"/> table must point to a
1836 valid SSL configuration when this form is used.</p>
1837 <p>SSL support is an optional feature that is not always built as
1838 part of Open vSwitch.</p>
1840 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1841 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1842 the given <var>ip</var>, which must be expressed as an IP address
1843 (not a DNS name).</dd>
1846 The following connection methods are currently supported for service
1850 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1853 Listens for SSL connections on the specified TCP <var>port</var>
1854 (default: 6633). If <var>ip</var>, which must be expressed as an
1855 IP address (not a DNS name), is specified, then connections are
1856 restricted to the specified local IP address.
1859 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1860 table="Open_vSwitch"/> table must point to a valid SSL
1861 configuration when this form is used.
1863 <p>SSL support is an optional feature that is not always built as
1864 part of Open vSwitch.</p>
1866 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1868 Listens for connections on the specified TCP <var>port</var>
1869 (default: 6633). If <var>ip</var>, which must be expressed as an
1870 IP address (not a DNS name), is specified, then connections are
1871 restricted to the specified local IP address.
1874 <p>When multiple controllers are configured for a single bridge, the
1875 <ref column="target"/> values must be unique. Duplicate
1876 <ref column="target"/> values yield unspecified results.</p>
1879 <column name="connection_mode">
1880 <p>If it is specified, this setting must be one of the following
1881 strings that describes how Open vSwitch contacts this OpenFlow
1882 controller over the network:</p>
1885 <dt><code>in-band</code></dt>
1886 <dd>In this mode, this controller's OpenFlow traffic travels over the
1887 bridge associated with the controller. With this setting, Open
1888 vSwitch allows traffic to and from the controller regardless of the
1889 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1890 would never be able to connect to the controller, because it did
1891 not have a flow to enable it.) This is the most common connection
1892 mode because it is not necessary to maintain two independent
1894 <dt><code>out-of-band</code></dt>
1895 <dd>In this mode, OpenFlow traffic uses a control network separate
1896 from the bridge associated with this controller, that is, the
1897 bridge does not use any of its own network devices to communicate
1898 with the controller. The control network must be configured
1899 separately, before or after <code>ovs-vswitchd</code> is started.
1903 <p>If not specified, the default is implementation-specific.</p>
1907 <group title="Controller Failure Detection and Handling">
1908 <column name="max_backoff">
1909 Maximum number of milliseconds to wait between connection attempts.
1910 Default is implementation-specific.
1913 <column name="inactivity_probe">
1914 Maximum number of milliseconds of idle time on connection to
1915 controller before sending an inactivity probe message. If Open
1916 vSwitch does not communicate with the controller for the specified
1917 number of seconds, it will send a probe. If a response is not
1918 received for the same additional amount of time, Open vSwitch
1919 assumes the connection has been broken and attempts to reconnect.
1920 Default is implementation-specific. A value of 0 disables
1925 <group title="OpenFlow Rate Limiting">
1926 <column name="controller_rate_limit">
1927 <p>The maximum rate at which packets in unknown flows will be
1928 forwarded to the OpenFlow controller, in packets per second. This
1929 feature prevents a single bridge from overwhelming the controller.
1930 If not specified, the default is implementation-specific.</p>
1931 <p>In addition, when a high rate triggers rate-limiting, Open
1932 vSwitch queues controller packets for each port and transmits
1933 them to the controller at the configured rate. The number of
1934 queued packets is limited by
1935 the <ref column="controller_burst_limit"/> value. The packet
1936 queue is shared fairly among the ports on a bridge.</p><p>Open
1937 vSwitch maintains two such packet rate-limiters per bridge.
1938 One of these applies to packets sent up to the controller
1939 because they do not correspond to any flow. The other applies
1940 to packets sent up to the controller by request through flow
1941 actions. When both rate-limiters are filled with packets, the
1942 actual rate that packets are sent to the controller is up to
1943 twice the specified rate.</p>
1946 <column name="controller_burst_limit">
1947 In conjunction with <ref column="controller_rate_limit"/>,
1948 the maximum number of unused packet credits that the bridge will
1949 allow to accumulate, in packets. If not specified, the default
1950 is implementation-specific.
1954 <group title="Additional In-Band Configuration">
1955 <p>These values are considered only in in-band control mode (see
1956 <ref column="connection_mode"/>).</p>
1958 <p>When multiple controllers are configured on a single bridge, there
1959 should be only one set of unique values in these columns. If different
1960 values are set for these columns in different controllers, the effect
1963 <column name="local_ip">
1964 The IP address to configure on the local port,
1965 e.g. <code>192.168.0.123</code>. If this value is unset, then
1966 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1970 <column name="local_netmask">
1971 The IP netmask to configure on the local port,
1972 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1973 but this value is unset, then the default is chosen based on whether
1974 the IP address is class A, B, or C.
1977 <column name="local_gateway">
1978 The IP address of the gateway to configure on the local port, as a
1979 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1980 this network has no gateway.
1984 <group title="Other Features">
1985 <column name="external_ids">
1986 Key-value pairs for use by external frameworks that integrate with Open
1987 vSwitch, rather than by Open vSwitch itself. System integrators should
1988 either use the Open vSwitch development mailing list to coordinate on
1989 common key-value definitions, or choose key names that are likely to be
1990 unique. No common key-value pairs are currently defined.
1994 <group title="Controller Status">
1995 <column name="is_connected">
1996 <code>true</code> if currently connected to this controller,
1997 <code>false</code> otherwise.
2000 <column name="role">
2001 <p>The level of authority this controller has on the associated
2002 bridge. Possible values are:</p>
2004 <dt><code>other</code></dt>
2005 <dd>Allows the controller access to all OpenFlow features.</dd>
2006 <dt><code>master</code></dt>
2007 <dd>Equivalent to <code>other</code>, except that there may be at
2008 most one master controller at a time. When a controller configures
2009 itself as <code>master</code>, any existing master is demoted to
2010 the <code>slave</code>role.</dd>
2011 <dt><code>slave</code></dt>
2012 <dd>Allows the controller read-only access to OpenFlow features.
2013 Attempts to modify the flow table will be rejected with an
2014 error. Slave controllers do not receive OFPT_PACKET_IN or
2015 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2020 <column name="status">
2021 <p>Key-value pairs that report controller status.</p>
2023 <dt><code>last_error</code></dt>
2024 <dd>A human-readable description of the last error on the connection
2025 to the controller; i.e. <code>strerror(errno)</code>. This key
2026 will exist only if an error has occurred.</dd>
2027 <dt><code>state</code></dt>
2028 <dd>The state of the connection to the controller. Possible values
2029 are: <code>VOID</code> (connection is disabled),
2030 <code>BACKOFF</code> (attempting to reconnect at an increasing
2031 period), <code>CONNECTING</code> (attempting to connect),
2032 <code>ACTIVE</code> (connected, remote host responsive), and
2033 <code>IDLE</code> (remote host idle, sending keep-alive). These
2034 values may change in the future. They are provided only for human
2036 <dt><code>sec_since_connect</code></dt>
2037 <dd>The amount of time since this controller last successfully
2038 connected to the switch (in seconds). Value is empty if controller
2039 has never successfully connected.</dd>
2040 <dt><code>sec_since_disconnect</code></dt>
2041 <dd>The amount of time since this controller last disconnected from
2042 the switch (in seconds). Value is empty if controller has never
2049 <table name="Manager" title="OVSDB management connection.">
2051 Configuration for a database connection to an Open vSwitch database
2056 This table primarily configures the Open vSwitch database
2057 (<code>ovsdb-server</code>), not the Open vSwitch switch
2058 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2059 what connections should be treated as in-band.
2063 The Open vSwitch database server can initiate and maintain active
2064 connections to remote clients. It can also listen for database
2068 <group title="Core Features">
2069 <column name="target">
2070 <p>Connection method for managers.</p>
2072 The following connection methods are currently supported:
2075 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2078 The specified SSL <var>port</var> (default: 6632) on the host at
2079 the given <var>ip</var>, which must be expressed as an IP address
2080 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2081 column in the <ref table="Open_vSwitch"/> table must point to a
2082 valid SSL configuration when this form is used.
2085 SSL support is an optional feature that is not always built as
2086 part of Open vSwitch.
2090 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2092 The specified TCP <var>port</var> (default: 6632) on the host at
2093 the given <var>ip</var>, which must be expressed as an IP address
2096 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2099 Listens for SSL connections on the specified TCP <var>port</var>
2100 (default: 6632). If <var>ip</var>, which must be expressed as an
2101 IP address (not a DNS name), is specified, then connections are
2102 restricted to the specified local IP address.
2105 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2106 table="Open_vSwitch"/> table must point to a valid SSL
2107 configuration when this form is used.
2110 SSL support is an optional feature that is not always built as
2111 part of Open vSwitch.
2114 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2116 Listens for connections on the specified TCP <var>port</var>
2117 (default: 6632). If <var>ip</var>, which must be expressed as an
2118 IP address (not a DNS name), is specified, then connections are
2119 restricted to the specified local IP address.
2122 <p>When multiple managers are configured, the <ref column="target"/>
2123 values must be unique. Duplicate <ref column="target"/> values yield
2124 unspecified results.</p>
2127 <column name="connection_mode">
2129 If it is specified, this setting must be one of the following strings
2130 that describes how Open vSwitch contacts this OVSDB client over the
2135 <dt><code>in-band</code></dt>
2137 In this mode, this connection's traffic travels over a bridge
2138 managed by Open vSwitch. With this setting, Open vSwitch allows
2139 traffic to and from the client regardless of the contents of the
2140 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2141 to connect to the client, because it did not have a flow to enable
2142 it.) This is the most common connection mode because it is not
2143 necessary to maintain two independent networks.
2145 <dt><code>out-of-band</code></dt>
2147 In this mode, the client's traffic uses a control network separate
2148 from that managed by Open vSwitch, that is, Open vSwitch does not
2149 use any of its own network devices to communicate with the client.
2150 The control network must be configured separately, before or after
2151 <code>ovs-vswitchd</code> is started.
2156 If not specified, the default is implementation-specific.
2161 <group title="Client Failure Detection and Handling">
2162 <column name="max_backoff">
2163 Maximum number of milliseconds to wait between connection attempts.
2164 Default is implementation-specific.
2167 <column name="inactivity_probe">
2168 Maximum number of milliseconds of idle time on connection to the client
2169 before sending an inactivity probe message. If Open vSwitch does not
2170 communicate with the client for the specified number of seconds, it
2171 will send a probe. If a response is not received for the same
2172 additional amount of time, Open vSwitch assumes the connection has been
2173 broken and attempts to reconnect. Default is implementation-specific.
2174 A value of 0 disables inactivity probes.
2178 <group title="Other Features">
2179 <column name="external_ids">
2180 Key-value pairs for use by external frameworks that integrate with Open
2181 vSwitch, rather than by Open vSwitch itself. System integrators should
2182 either use the Open vSwitch development mailing list to coordinate on
2183 common key-value definitions, or choose key names that are likely to be
2184 unique. No common key-value pairs are currently defined.
2188 <group title="Status">
2189 <column name="is_connected">
2190 <code>true</code> if currently connected to this manager,
2191 <code>false</code> otherwise.
2194 <column name="status">
2195 <p>Key-value pairs that report manager status.</p>
2197 <dt><code>last_error</code></dt>
2198 <dd>A human-readable description of the last error on the connection
2199 to the manager; i.e. <code>strerror(errno)</code>. This key
2200 will exist only if an error has occurred.</dd>
2203 <dt><code>state</code></dt>
2204 <dd>The state of the connection to the manager. Possible values
2205 are: <code>VOID</code> (connection is disabled),
2206 <code>BACKOFF</code> (attempting to reconnect at an increasing
2207 period), <code>CONNECTING</code> (attempting to connect),
2208 <code>ACTIVE</code> (connected, remote host responsive), and
2209 <code>IDLE</code> (remote host idle, sending keep-alive). These
2210 values may change in the future. They are provided only for human
2214 <dt><code>sec_since_connect</code></dt>
2215 <dd>The amount of time since this manager last successfully connected
2216 to the database (in seconds). Value is empty if manager has never
2217 successfully connected.</dd>
2220 <dt><code>sec_since_disconnect</code></dt>
2221 <dd>The amount of time since this manager last disconnected from the
2222 database (in seconds). Value is empty if manager has never
2226 <dt><code>locks_held</code></dt>
2227 <dt><code>locks_waiting</code></dt>
2228 <dt><code>locks_lost</code></dt>
2230 Space-separated lists of the names of OVSDB locks that the
2231 connection holds, is currently waiting to acquire, or has had
2232 stolen by another OVSDB client, respectively. Key-value pairs for
2233 lists that would be empty are omitted.
2237 <dt><code>n_connections</code></dt>
2240 When <ref column="target"/> specifies a connection method that
2241 listens for inbound connections (e.g. <code>ptcp:</code> or
2242 <code>pssl:</code>) and more than one connection is actually
2243 active, the value is the number of active connections.
2244 Otherwise, this key-value pair is omitted.
2247 When multiple connections are active, status columns and
2248 key-value pairs (other than this one) report the status of one
2249 arbitrarily chosen connection.
2257 <table name="NetFlow">
2258 A NetFlow target. NetFlow is a protocol that exports a number of
2259 details about terminating IP flows, such as the principals involved
2262 <column name="targets">
2263 NetFlow targets in the form
2264 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2265 must be specified numerically, not as a DNS name.
2268 <column name="engine_id">
2269 Engine ID to use in NetFlow messages. Defaults to datapath index
2273 <column name="engine_type">
2274 Engine type to use in NetFlow messages. Defaults to datapath
2275 index if not specified.
2278 <column name="active_timeout">
2279 The interval at which NetFlow records are sent for flows that are
2280 still active, in seconds. A value of <code>0</code> requests the
2281 default timeout (currently 600 seconds); a value of <code>-1</code>
2282 disables active timeouts.
2285 <column name="add_id_to_interface">
2286 <p>If this column's value is <code>false</code>, the ingress and egress
2287 interface fields of NetFlow flow records are derived from OpenFlow port
2288 numbers. When it is <code>true</code>, the 7 most significant bits of
2289 these fields will be replaced by the least significant 7 bits of the
2290 engine id. This is useful because many NetFlow collectors do not
2291 expect multiple switches to be sending messages from the same host, so
2292 they do not store the engine information which could be used to
2293 disambiguate the traffic.</p>
2294 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2297 <column name="external_ids">
2298 Key-value pairs for use by external frameworks that integrate with Open
2299 vSwitch, rather than by Open vSwitch itself. System integrators should
2300 either use the Open vSwitch development mailing list to coordinate on
2301 common key-value definitions, or choose key names that are likely to be
2302 unique. No common key-value pairs are currently defined.
2307 SSL configuration for an Open_vSwitch.
2309 <column name="private_key">
2310 Name of a PEM file containing the private key used as the switch's
2311 identity for SSL connections to the controller.
2314 <column name="certificate">
2315 Name of a PEM file containing a certificate, signed by the
2316 certificate authority (CA) used by the controller and manager,
2317 that certifies the switch's private key, identifying a trustworthy
2321 <column name="ca_cert">
2322 Name of a PEM file containing the CA certificate used to verify
2323 that the switch is connected to a trustworthy controller.
2326 <column name="bootstrap_ca_cert">
2327 If set to <code>true</code>, then Open vSwitch will attempt to
2328 obtain the CA certificate from the controller on its first SSL
2329 connection and save it to the named PEM file. If it is successful,
2330 it will immediately drop the connection and reconnect, and from then
2331 on all SSL connections must be authenticated by a certificate signed
2332 by the CA certificate thus obtained. <em>This option exposes the
2333 SSL connection to a man-in-the-middle attack obtaining the initial
2334 CA certificate.</em> It may still be useful for bootstrapping.
2337 <column name="external_ids">
2338 Key-value pairs for use by external frameworks that integrate with Open
2339 vSwitch, rather than by Open vSwitch itself. System integrators should
2340 either use the Open vSwitch development mailing list to coordinate on
2341 common key-value definitions, or choose key names that are likely to be
2342 unique. No common key-value pairs are currently defined.
2346 <table name="sFlow">
2347 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2350 <column name="agent">
2351 Name of the network device whose IP address should be reported as the
2352 ``agent address'' to collectors. If not specified, the IP address
2353 defaults to the <ref table="Controller" column="local_ip"/> in the
2354 collector's <ref table="Controller"/>. If an agent IP address cannot be
2355 determined either way, sFlow is disabled.
2358 <column name="header">
2359 Number of bytes of a sampled packet to send to the collector.
2360 If not specified, the default is 128 bytes.
2363 <column name="polling">
2364 Polling rate in seconds to send port statistics to the collector.
2365 If not specified, defaults to 30 seconds.
2368 <column name="sampling">
2369 Rate at which packets should be sampled and sent to the collector.
2370 If not specified, defaults to 400, which means one out of 400
2371 packets, on average, will be sent to the collector.
2374 <column name="targets">
2375 sFlow targets in the form
2376 <code><var>ip</var>:<var>port</var></code>.
2379 <column name="external_ids">
2380 Key-value pairs for use by external frameworks that integrate with Open
2381 vSwitch, rather than by Open vSwitch itself. System integrators should
2382 either use the Open vSwitch development mailing list to coordinate on
2383 common key-value definitions, or choose key names that are likely to be
2384 unique. No common key-value pairs are currently defined.
2388 <table name="Capability">
2389 <p>Records in this table describe functionality supported by the hardware
2390 and software platform on which this Open vSwitch is based. Clients
2391 should not modify this table.</p>
2393 <p>A record in this table is meaningful only if it is referenced by the
2394 <ref table="Open_vSwitch" column="capabilities"/> column in the
2395 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2396 the record's ``category,'' determines the meanings of the
2397 <ref column="details"/> column. The following general forms of
2398 categories are currently defined:</p>
2401 <dt><code>qos-<var>type</var></code></dt>
2402 <dd><var>type</var> is supported as the value for
2403 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2407 <column name="details">
2408 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2409 depends on the category key that the <ref table="Open_vSwitch"
2410 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2411 uses to reference this record, as described above.</p>
2413 <p>The presence of a record for category <code>qos-<var>type</var></code>
2414 indicates that the switch supports <var>type</var> as the value of
2415 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2416 table. The following key-value pairs are defined to further describe
2417 QoS capabilities:</p>
2420 <dt><code>n-queues</code></dt>
2421 <dd>Number of supported queues, as a positive integer. Keys in the
2422 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2423 records whose <ref table="QoS" column="type"/> value
2424 equals <var>type</var> must range between 0 and this value minus one,