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.
464 <dt><code>forward-bpdu</code></dt>
466 Option to allow forwarding of BPDU frames when NORMAL
467 action if invoked. Frames with reserved Ethernet addresses
468 (e.g. STP BPDU) will be forwarded when this option is enabled.
469 If the Open vSwitch bridge is used to connect different
470 Ethernet networks, and if Open vSwtich node does not run STP,
471 then this option should be enabled.
472 Default is disabled, set to <code>true</code> to enable.
479 <table name="Port" table="Port or bond configuration.">
480 <p>A port within a <ref table="Bridge"/>.</p>
481 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
482 <ref column="interfaces"/> column. Such a port logically
483 corresponds to a port on a physical Ethernet switch. A port
484 with more than one interface is a ``bonded port'' (see
485 <ref group="Bonding Configuration"/>).</p>
486 <p>Some properties that one might think as belonging to a port are actually
487 part of the port's <ref table="Interface"/> members.</p>
490 Port name. Should be alphanumeric and no more than about 8
491 bytes long. May be the same as the interface name, for
492 non-bonded ports. Must otherwise be unique among the names of
493 ports, interfaces, and bridges on a host.
496 <column name="interfaces">
497 The port's interfaces. If there is more than one, this is a
501 <group title="VLAN Configuration">
502 <p>A bridge port must be configured for VLANs in one of two
503 mutually exclusive ways:
505 <li>A ``trunk port'' has an empty value for <ref
506 column="tag"/>. Its <ref column="trunks"/> value may be
507 empty or non-empty.</li>
508 <li>An ``implicitly tagged VLAN port'' or ``access port''
509 has an nonempty value for <ref column="tag"/>. Its
510 <ref column="trunks"/> value must be empty.</li>
512 If <ref column="trunks"/> and <ref column="tag"/> are both
513 nonempty, the configuration is ill-formed.
518 If this is an access port (see above), the port's implicitly
519 tagged VLAN. Must be empty if this is a trunk port.
522 Frames arriving on trunk ports will be forwarded to this
523 port only if they are tagged with the given VLAN (or, if
524 <ref column="tag"/> is 0, then if they lack a VLAN header).
525 Frames arriving on other access ports will be forwarded to
526 this port only if they have the same <ref column="tag"/>
527 value. Frames forwarded to this port will not have an
531 When a frame with a 802.1Q header that indicates a nonzero
532 VLAN is received on an access port, it is discarded.
536 <column name="trunks">
538 If this is a trunk port (see above), the 802.1Q VLAN(s) that
539 this port trunks; if it is empty, then the port trunks all
540 VLANs. Must be empty if this is an access port.
543 Frames arriving on trunk ports are dropped if they are not
544 in one of the specified VLANs. For this purpose, packets
545 that have no VLAN header are treated as part of VLAN 0.
550 <group title="Bonding Configuration">
551 <p>A port that has more than one interface is a ``bonded port.'' Bonding
552 allows for load balancing and fail-over. Some kinds of bonding will
553 work with any kind of upstream switch:</p>
556 <dt><code>balance-slb</code></dt>
558 Balances flows among slaves based on source MAC address and output
559 VLAN, with periodic rebalancing as traffic patterns change.
562 <dt><code>active-backup</code></dt>
564 Assigns all flows to one slave, failing over to a backup slave when
565 the active slave is disabled.
570 The following modes require the upstream switch to support 802.3ad with
571 successful LACP negotiation. If LACP negotiation fails then
572 <code>balance-slb</code> style flow hashing is used as a fallback:
576 <dt><code>balance-tcp</code></dt>
578 Balances flows among slaves based on L2, L3, and L4 protocol
579 information such as destination MAC address, IP address, and TCP
585 <dt><code>stable</code></dt>
587 <p>Attempts to always assign a given flow to the same slave
588 consistently. In an effort to maintain stability, no load
589 balancing is done. Uses a similar hashing strategy to
590 <code>balance-tcp</code>, always taking into account L3 and L4
591 fields even if LACP negotiations are unsuccessful. </p>
592 <p>Slave selection decisions are made based on <ref table="Interface"
593 column="other_config" key="bond-stable-id"/> if set. Otherwise,
594 OpenFlow port number is used. Decisions are consistent across all
595 <code>ovs-vswitchd</code> instances with equivalent
596 <ref table="Interface" column="other_config" key="bond-stable-id"/>
601 <p>These columns apply only to bonded ports. Their values are
602 otherwise ignored.</p>
604 <column name="bond_mode">
605 <p>The type of bonding used for a bonded port. Defaults to
606 <code>balance-slb</code> if unset.
610 <column name="bond_updelay">
611 <p>For a bonded port, the number of milliseconds for which carrier must
612 stay up on an interface before the interface is considered to be up.
613 Specify <code>0</code> to enable the interface immediately.</p>
614 <p>This setting is honored only when at least one bonded interface is
615 already enabled. When no interfaces are enabled, then the first bond
616 interface to come up is enabled immediately.</p>
619 <column name="bond_downdelay">
620 For a bonded port, the number of milliseconds for which carrier must
621 stay down on an interface before the interface is considered to be
622 down. Specify <code>0</code> to disable the interface immediately.
625 <column name="bond_fake_iface">
626 For a bonded port, whether to create a fake internal interface with the
627 name of the port. Use only for compatibility with legacy software that
632 <p>Configures LACP on this port. LACP allows directly connected
633 switches to negotiate which links may be bonded. LACP may be enabled
634 on non-bonded ports for the benefit of any switches they may be
635 connected to. <code>active</code> ports are allowed to initiate LACP
636 negotiations. <code>passive</code> ports are allowed to participate
637 in LACP negotiations initiated by a remote switch, but not allowed to
638 initiate such negotiations themselves. If unset Open vSwitch will
639 choose a reasonable default. </p>
644 <group title="Other Features">
646 Quality of Service configuration for this port.
650 The MAC address to use for this port for the purpose of choosing the
651 bridge's MAC address. This column does not necessarily reflect the
652 port's actual MAC address, nor will setting it change the port's actual
656 <column name="fake_bridge">
657 Does this port represent a sub-bridge for its tagged VLAN within the
658 Bridge? See ovs-vsctl(8) for more information.
661 <column name="external_ids">
663 Key-value pairs for use by external frameworks that integrate with
664 Open vSwitch, rather than by Open vSwitch itself. System integrators
665 should either use the Open vSwitch development mailing list to
666 coordinate on common key-value definitions, or choose key names that
667 are likely to be unique.
670 No key-value pairs native to <ref table="Port"/> are currently
671 defined. For fake bridges (see the <ref column="fake_bridge"/>
672 column), external IDs for the fake bridge are defined here by
673 prefixing a <ref table="Bridge"/> <ref table="Bridge"
674 column="external_ids"/> key with <code>fake-bridge-</code>,
675 e.g. <code>fake-bridge-xs-network-uuids</code>.
679 <column name="other_config">
680 Key-value pairs for configuring rarely used port features. The
681 currently defined key-value pairs are:
683 <dt><code>hwaddr</code></dt>
684 <dd>An Ethernet address in the form
685 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
686 <dt><code>bond-rebalance-interval</code></dt>
687 <dd>For an SLB bonded port, the number of milliseconds between
688 successive attempts to rebalance the bond, that is, to
689 move source MACs and their flows from one interface on
690 the bond to another in an attempt to keep usage of each
691 interface roughly equal. The default is 10000 (10
692 seconds), and the minimum is 1000 (1 second).</dd>
693 <dt><code>bond-detect-mode</code></dt>
694 <dd> Sets the method used to detect link failures in a bonded port.
695 Options are <code>carrier</code> and <code>miimon</code>. Defaults
696 to <code>carrier</code> which uses each interface's carrier to detect
697 failures. When set to <code>miimon</code>, will check for failures
698 by polling each interface's MII. </dd>
699 <dt><code>bond-miimon-interval</code></dt>
700 <dd> The number of milliseconds between successive attempts to
701 poll each interface's MII. Only relevant on ports which use
702 <code>miimon</code> to detect failures. </dd>
703 <dt><code>bond-hash-basis</code></dt>
704 <dd> An integer hashed along with flows when choosing output slaves.
705 When changed, all flows will be assigned different hash values
706 possibly causing slave selection decisions to change.</dd>
707 <dt><code>lacp-system-id</code></dt>
708 <dd> The LACP system ID of this <ref table="Port"/>. The system ID
709 of a LACP bond is used to identify itself to its partners. Must
710 be a nonzero MAC address.</dd>
711 <dt><code>lacp-system-priority</code></dt>
712 <dd> The LACP system priority of this <ref table="Port"/>. In
713 LACP negotiations, link status decisions are made by the system
714 with the numerically lower priority. Must be a number between 1
716 <dt><code>lacp-time</code></dt>
718 <p>The LACP timing which should be used on this
719 <ref table="Port"/>. Possible values are <code>fast</code>,
720 <code>slow</code> and a positive number of milliseconds. By
721 default <code>slow</code> is used. When configured to be
722 <code>fast</code> LACP heartbeats are requested at a rate of once
723 per second causing connectivity problems to be detected more
724 quickly. In <code>slow</code> mode, heartbeats are requested at
725 a rate of once every 30 seconds.</p>
727 <p>Users may manually set a heartbeat transmission rate to increase
728 the fault detection speed further. When manually set, OVS
729 expects the partner switch to be configured with the same
730 transmission rate. Manually setting <code>lacp-time</code> to
731 something other than <code>fast</code> or <code>slow</code> is
732 not supported by the LACP specification.</p>
734 <dt><code>lacp-heartbeat</code></dt>
735 <dd> Treats LACP like a simple heartbeat protocol for link state
736 monitoring. Most features of the LACP protocol are disabled when
737 this mode is in use.</dd>
743 <table name="Interface" title="One physical network device in a Port.">
744 An interface within a <ref table="Port"/>.
746 <group title="Core Features">
748 Interface name. Should be alphanumeric and no more than about 8 bytes
749 long. May be the same as the port name, for non-bonded ports. Must
750 otherwise be unique among the names of ports, interfaces, and bridges
755 <p>Ethernet address to set for this interface. If unset then the
756 default MAC address is used:</p>
758 <li>For the local interface, the default is the lowest-numbered MAC
759 address among the other bridge ports, either the value of the
760 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
761 if set, or its actual MAC (for bonded ports, the MAC of its slave
762 whose name is first in alphabetical order). Internal ports and
763 bridge ports that are used as port mirroring destinations (see the
764 <ref table="Mirror"/> table) are ignored.</li>
765 <li>For other internal interfaces, the default MAC is randomly
767 <li>External interfaces typically have a MAC address associated with
770 <p>Some interfaces may not have a software-controllable MAC
774 <column name="ofport">
775 <p>OpenFlow port number for this interface. Unlike most columns, this
776 column's value should be set only by Open vSwitch itself. Other
777 clients should set this column to an empty set (the default) when
778 creating an <ref table="Interface"/>.</p>
779 <p>Open vSwitch populates this column when the port number becomes
780 known. If the interface is successfully added,
781 <ref column="ofport"/> will be set to a number between 1 and 65535
782 (generally either in the range 1 to 65279, inclusive, or 65534, the
783 port number for the OpenFlow ``local port''). If the interface
784 cannot be added then Open vSwitch sets this column
789 <group title="System-Specific Details">
791 The interface type, one of:
793 <dt><code>system</code></dt>
794 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
795 Sometimes referred to as ``external interfaces'' since they are
796 generally connected to hardware external to that on which the Open
797 vSwitch is running. The empty string is a synonym for
798 <code>system</code>.</dd>
799 <dt><code>internal</code></dt>
800 <dd>A simulated network device that sends and receives traffic. An
801 internal interface whose <ref column="name"/> is the same as its
802 bridge's <ref table="Open_vSwitch" column="name"/> is called the
803 ``local interface.'' It does not make sense to bond an internal
804 interface, so the terms ``port'' and ``interface'' are often used
805 imprecisely for internal interfaces.</dd>
806 <dt><code>tap</code></dt>
807 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
808 <dt><code>gre</code></dt>
809 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
810 tunnel. Each tunnel must be uniquely identified by the
811 combination of <ref column="options" key="remote_ip"/>,
812 <ref column="options" key="local_ip"/>, and
813 <ref column="options" key="in_key"/>. Note that if two ports
814 are defined that are the same except one has an optional
815 identifier and the other does not, the more specific one is
816 matched first. <ref column="options" key="in_key"/> is considered
817 more specific than <ref column="options" key="local_ip"/> if a port
818 defines one and another port defines the other. The following
819 options may be specified in the <ref column="options"/> column:
821 <dt><code>remote_ip</code></dt>
822 <dd>Required. The tunnel endpoint.</dd>
825 <dt><code>local_ip</code></dt>
826 <dd>Optional. The destination IP that received packets must
827 match. Default is to match all addresses.</dd>
830 <dt><code>in_key</code></dt>
831 <dd>Optional. The GRE key that received packets must contain.
832 It may either be a 32-bit number (no key and a key of 0 are
833 treated as equivalent) or the word <code>flow</code>. If
834 <code>flow</code> is specified then any key will be accepted
835 and the key will be placed in the <code>tun_id</code> field
836 for matching in the flow table. The ovs-ofctl manual page
837 contains additional information about matching fields in
838 OpenFlow flows. Default is no key.</dd>
841 <dt><code>out_key</code></dt>
842 <dd>Optional. The GRE key to be set on outgoing packets. It may
843 either be a 32-bit number or the word <code>flow</code>. If
844 <code>flow</code> is specified then the key may be set using
845 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
846 is used in the absence of an action). The ovs-ofctl manual
847 page contains additional information about the Nicira OpenFlow
848 vendor extensions. Default is no key.</dd>
851 <dt><code>key</code></dt>
852 <dd>Optional. Shorthand to set <code>in_key</code> and
853 <code>out_key</code> at the same time.</dd>
856 <dt><code>tos</code></dt>
857 <dd>Optional. The value of the ToS bits to be set on the
858 encapsulating packet. It may also be the word
859 <code>inherit</code>, in which case the ToS will be copied from
860 the inner packet if it is IPv4 or IPv6 (otherwise it will be
861 0). Note that the ECN fields are always inherited. Default is
865 <dt><code>ttl</code></dt>
866 <dd>Optional. The TTL to be set on the encapsulating packet.
867 It may also be the word <code>inherit</code>, in which case the
868 TTL will be copied from the inner packet if it is IPv4 or IPv6
869 (otherwise it will be the system default, typically 64).
870 Default is the system default TTL.</dd>
873 <dt><code>csum</code></dt>
874 <dd>Optional. Compute GRE checksums on outgoing packets.
875 Checksums present on incoming packets will be validated
876 regardless of this setting. Note that GRE checksums
877 impose a significant performance penalty as they cover the
878 entire packet. As the contents of the packet is typically
879 covered by L3 and L4 checksums, this additional checksum only
880 adds value for the GRE and encapsulated Ethernet headers.
881 Default is disabled, set to <code>true</code> to enable.</dd>
884 <dt><code>df_inherit</code></dt>
885 <dd>Optional. If enabled, the Don't Fragment bit will be copied
886 from the inner IP headers (those of the encapsulated traffic)
887 to the outer (tunnel) headers. Default is disabled; set to
888 <code>true</code> to enable.</dd>
891 <dt><code>df_default</code></dt>
892 <dd>Optional. If enabled, the Don't Fragment bit will be set by
893 default on tunnel headers if the <code>df_inherit</code> option
894 is not set, or if the encapsulated packet is not IP. Default
895 is enabled; set to <code>false</code> to disable.</dd>
898 <dt><code>pmtud</code></dt>
899 <dd>Optional. Enable tunnel path MTU discovery. If enabled
900 ``ICMP Destination Unreachable - Fragmentation Needed''
901 messages will be generated for IPv4 packets with the DF bit set
902 and IPv6 packets above the minimum MTU if the packet size
903 exceeds the path MTU minus the size of the tunnel headers.
904 Note that this option causes behavior that is typically
905 reserved for routers and therefore is not entirely in
906 compliance with the IEEE 802.1D specification for bridges.
907 Default is enabled; set to <code>false</code> to disable.</dd>
910 <dt><code>header_cache</code></dt>
911 <dd>Optional. Enable caching of tunnel headers and the output
912 path. This can lead to a significant performance increase
913 without changing behavior. In general it should not be
914 necessary to adjust this setting. However, the caching can
915 bypass certain components of the IP stack (such as IP tables)
916 and it may be useful to disable it if these features are
917 required or as a debugging measure. Default is enabled, set to
918 <code>false</code> to disable.</dd>
921 <dt><code>ipsec_gre</code></dt>
922 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
923 over IPv4 IPsec tunnel. Each tunnel (including those of type
924 <code>gre</code>) must be uniquely identified by the
925 combination of <ref column="options" key="remote_ip"/> and
926 <ref column="options" key="local_ip"/>. Note that if two ports are
927 defined that are the same except one has an optional identifier and
928 the other does not, the more specific one is matched first.
929 An authentication method of <ref column="options" key="peer_cert"/>
930 or <ref column="options" key="psk"/> must be defined. The
931 following options may be specified in the <ref column="options"/>
934 <dt><code>remote_ip</code></dt>
935 <dd>Required. The tunnel endpoint.</dd>
938 <dt><code>local_ip</code></dt>
939 <dd>Optional. The destination IP that received packets must
940 match. Default is to match all addresses.</dd>
943 <dt><code>peer_cert</code></dt>
944 <dd>Required for certificate authentication. A string
945 containing the peer's certificate in PEM format.
946 Additionally the host's certificate must be specified
947 with the <code>certificate</code> option.</dd>
950 <dt><code>certificate</code></dt>
951 <dd>Required for certificate authentication. The name of a
952 PEM file containing a certificate that will be presented
953 to the peer during authentication.</dd>
956 <dt><code>private_key</code></dt>
957 <dd>Optional for certificate authentication. The name of
958 a PEM file containing the private key associated with
959 <code>certificate</code>. If <code>certificate</code>
960 contains the private key, this option may be omitted.</dd>
963 <dt><code>psk</code></dt>
964 <dd>Required for pre-shared key authentication. Specifies a
965 pre-shared key for authentication that must be identical on
966 both sides of the tunnel.</dd>
969 <dt><code>in_key</code></dt>
970 <dd>Optional. The GRE key that received packets must contain.
971 It may either be a 32-bit number (no key and a key of 0 are
972 treated as equivalent) or the word <code>flow</code>. If
973 <code>flow</code> is specified then any key will be accepted
974 and the key will be placed in the <code>tun_id</code> field
975 for matching in the flow table. The ovs-ofctl manual page
976 contains additional information about matching fields in
977 OpenFlow flows. Default is no key.</dd>
980 <dt><code>out_key</code></dt>
981 <dd>Optional. The GRE key to be set on outgoing packets. It may
982 either be a 32-bit number or the word <code>flow</code>. If
983 <code>flow</code> is specified then the key may be set using
984 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
985 is used in the absence of an action). The ovs-ofctl manual
986 page contains additional information about the Nicira OpenFlow
987 vendor extensions. Default is no key.</dd>
990 <dt><code>key</code></dt>
991 <dd>Optional. Shorthand to set <code>in_key</code> and
992 <code>out_key</code> at the same time.</dd>
995 <dt><code>tos</code></dt>
996 <dd>Optional. The value of the ToS bits to be set on the
997 encapsulating packet. It may also be the word
998 <code>inherit</code>, in which case the ToS will be copied from
999 the inner packet if it is IPv4 or IPv6 (otherwise it will be
1000 0). Note that the ECN fields are always inherited. Default is
1004 <dt><code>ttl</code></dt>
1005 <dd>Optional. The TTL to be set on the encapsulating packet.
1006 It may also be the word <code>inherit</code>, in which case the
1007 TTL will be copied from the inner packet if it is IPv4 or IPv6
1008 (otherwise it will be the system default, typically 64).
1009 Default is the system default TTL.</dd>
1012 <dt><code>csum</code></dt>
1013 <dd>Optional. Compute GRE checksums on outgoing packets.
1014 Checksums present on incoming packets will be validated
1015 regardless of this setting. Note that GRE checksums
1016 impose a significant performance penalty as they cover the
1017 entire packet. As the contents of the packet is typically
1018 covered by L3 and L4 checksums, this additional checksum only
1019 adds value for the GRE and encapsulated Ethernet headers.
1020 Default is disabled, set to <code>true</code> to enable.</dd>
1023 <dt><code>df_inherit</code></dt>
1024 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1025 from the inner IP headers (those of the encapsulated traffic)
1026 to the outer (tunnel) headers. Default is disabled; set to
1027 <code>true</code> to enable.</dd>
1030 <dt><code>df_default</code></dt>
1031 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1032 default on tunnel headers if the <code>df_inherit</code> option
1033 is not set, or if the encapsulated packet is not IP. Default
1034 is enabled; set to <code>false</code> to disable.</dd>
1037 <dt><code>pmtud</code></dt>
1038 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1039 ``ICMP Destination Unreachable - Fragmentation Needed''
1040 messages will be generated for IPv4 packets with the DF bit set
1041 and IPv6 packets above the minimum MTU if the packet size
1042 exceeds the path MTU minus the size of the tunnel headers.
1043 Note that this option causes behavior that is typically
1044 reserved for routers and therefore is not entirely in
1045 compliance with the IEEE 802.1D specification for bridges.
1046 Default is enabled; set to <code>false</code> to disable.</dd>
1049 <dt><code>capwap</code></dt>
1050 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
1051 (RFC 5415). This allows interoperability with certain switches
1052 where GRE is not available. Note that only the tunneling component
1053 of the protocol is implemented. Due to the non-standard use of
1054 CAPWAP, UDP ports 58881 and 58882 are used as the source and
1055 destination ports respectively. Each tunnel must be uniquely
1056 identified by the combination of
1057 <ref column="options" key="remote_ip"/> and
1058 <ref column="options" key="local_ip"/>. If two ports are defined
1059 that are the same except one includes
1060 <ref column="options" key="local_ip"/> and the other does not, the
1061 more specific one is matched first. CAPWAP support is not
1062 available on all platforms. Currently it is only supported in the
1063 Linux kernel module with kernel versions >= 2.6.25. The following
1064 options may be specified in the <ref column="options"/> column:
1066 <dt><code>remote_ip</code></dt>
1067 <dd>Required. The tunnel endpoint.</dd>
1070 <dt><code>local_ip</code></dt>
1071 <dd>Optional. The destination IP that received packets must
1072 match. Default is to match all addresses.</dd>
1075 <dt><code>tos</code></dt>
1076 <dd>Optional. The value of the ToS bits to be set on the
1077 encapsulating packet. It may also be the word
1078 <code>inherit</code>, in which case the ToS will be copied from
1079 the inner packet if it is IPv4 or IPv6 (otherwise it will be
1080 0). Note that the ECN fields are always inherited. Default is
1084 <dt><code>ttl</code></dt>
1085 <dd>Optional. The TTL to be set on the encapsulating packet.
1086 It may also be the word <code>inherit</code>, in which case the
1087 TTL will be copied from the inner packet if it is IPv4 or IPv6
1088 (otherwise it will be the system default, typically 64).
1089 Default is the system default TTL.</dd>
1092 <dt><code>df_inherit</code></dt>
1093 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1094 from the inner IP headers (those of the encapsulated traffic)
1095 to the outer (tunnel) headers. Default is disabled; set to
1096 <code>true</code> to enable.</dd>
1099 <dt><code>df_default</code></dt>
1100 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1101 default on tunnel headers if the <code>df_inherit</code> option
1102 is not set, or if the encapsulated packet is not IP. Default
1103 is enabled; set to <code>false</code> to disable.</dd>
1106 <dt><code>pmtud</code></dt>
1107 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1108 ``ICMP Destination Unreachable - Fragmentation Needed''
1109 messages will be generated for IPv4 packets with the DF bit set
1110 and IPv6 packets above the minimum MTU if the packet size
1111 exceeds the path MTU minus the size of the tunnel headers.
1112 Note that this option causes behavior that is typically
1113 reserved for routers and therefore is not entirely in
1114 compliance with the IEEE 802.1D specification for bridges.
1115 Default is enabled; set to <code>false</code> to disable.</dd>
1118 <dt><code>header_cache</code></dt>
1119 <dd>Optional. Enable caching of tunnel headers and the output
1120 path. This can lead to a significant performance increase
1121 without changing behavior. In general it should not be
1122 necessary to adjust this setting. However, the caching can
1123 bypass certain components of the IP stack (such as IP tables)
1124 and it may be useful to disable it if these features are
1125 required or as a debugging measure. Default is enabled, set to
1126 <code>false</code> to disable.</dd>
1129 <dt><code>patch</code></dt>
1132 A pair of virtual devices that act as a patch cable. The <ref
1133 column="options"/> column must have the following key-value pair:
1136 <dt><code>peer</code></dt>
1138 The <ref column="name"/> of the <ref table="Interface"/> for
1139 the other side of the patch. The named <ref
1140 table="Interface"/>'s own <code>peer</code> option must specify
1141 this <ref table="Interface"/>'s name. That is, the two patch
1142 interfaces must have reversed <ref column="name"/> and
1143 <code>peer</code> values.
1147 <dt><code>null</code></dt>
1148 <dd>An ignored interface.</dd>
1152 <column name="options">
1153 Configuration options whose interpretation varies based on
1154 <ref column="type"/>.
1158 <group title="Interface Status">
1160 Status information about interfaces attached to bridges, updated every
1161 5 seconds. Not all interfaces have all of these properties; virtual
1162 interfaces don't have a link speed, for example. Non-applicable
1163 columns will have empty values.
1165 <column name="admin_state">
1167 The administrative state of the physical network link.
1171 <column name="link_state">
1173 The observed state of the physical network link. This is ordinarily
1174 the link's carrier status. If the interface's <ref table="Port"/> is
1175 a bond configured for miimon monitoring, it is instead the network
1176 link's miimon status.
1180 <column name="link_speed">
1182 The negotiated speed of the physical network link.
1183 Valid values are positive integers greater than 0.
1187 <column name="duplex">
1189 The duplex mode of the physical network link.
1195 The MTU (maximum transmission unit); i.e. the largest
1196 amount of data that can fit into a single Ethernet frame.
1197 The standard Ethernet MTU is 1500 bytes. Some physical media
1198 and many kinds of virtual interfaces can be configured with
1202 This column will be empty for an interface that does not
1203 have an MTU as, for example, some kinds of tunnels do not.
1207 <column name="status">
1209 Key-value pairs that report port status. Supported status values are
1210 <ref column="type"/>-dependent; some interfaces may not have a valid
1211 <ref column="status" key="driver_name"/>, for example.
1213 <p>The currently defined key-value pairs are:</p>
1215 <dt><code>driver_name</code></dt>
1216 <dd>The name of the device driver controlling the network
1220 <dt><code>driver_version</code></dt>
1221 <dd>The version string of the device driver controlling the
1222 network adapter.</dd>
1225 <dt><code>firmware_version</code></dt>
1226 <dd>The version string of the network adapter's firmware, if
1230 <dt><code>source_ip</code></dt>
1231 <dd>The source IP address used for an IPv4 tunnel end-point,
1232 such as <code>gre</code> or <code>capwap</code>.</dd>
1235 <dt><code>tunnel_egress_iface</code></dt>
1236 <dd>Egress interface for tunnels. Currently only relevant for GRE
1237 and CAPWAP tunnels. On Linux systems, this column will show
1238 the name of the interface which is responsible for routing
1239 traffic destined for the configured
1240 <ref column="options" key="remote_ip"/>. This could be an
1241 internal interface such as a bridge port.</dd>
1244 <dt><code>tunnel_egress_iface_carrier</code></dt>
1245 <dd>Whether a carrier is detected on
1246 <ref column="status" key="tunnel_egress_iface"/>. Valid values
1247 are <code>down</code> and <code>up</code>.</dd>
1252 <group title="Ingress Policing">
1254 These settings control ingress policing for packets received on this
1255 interface. On a physical interface, this limits the rate at which
1256 traffic is allowed into the system from the outside; on a virtual
1257 interface (one connected to a virtual machine), this limits the rate at
1258 which the VM is able to transmit.
1261 Policing is a simple form of quality-of-service that simply drops
1262 packets received in excess of the configured rate. Due to its
1263 simplicity, policing is usually less accurate and less effective than
1264 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1265 table="Queue"/> tables).
1268 Policing is currently implemented only on Linux. The Linux
1269 implementation uses a simple ``token bucket'' approach:
1273 The size of the bucket corresponds to <ref
1274 column="ingress_policing_burst"/>. Initially the bucket is full.
1277 Whenever a packet is received, its size (converted to tokens) is
1278 compared to the number of tokens currently in the bucket. If the
1279 required number of tokens are available, they are removed and the
1280 packet is forwarded. Otherwise, the packet is dropped.
1283 Whenever it is not full, the bucket is refilled with tokens at the
1284 rate specified by <ref column="ingress_policing_rate"/>.
1288 Policing interacts badly with some network protocols, and especially
1289 with fragmented IP packets. Suppose that there is enough network
1290 activity to keep the bucket nearly empty all the time. Then this token
1291 bucket algorithm will forward a single packet every so often, with the
1292 period depending on packet size and on the configured rate. All of the
1293 fragments of an IP packets are normally transmitted back-to-back, as a
1294 group. In such a situation, therefore, only one of these fragments
1295 will be forwarded and the rest will be dropped. IP does not provide
1296 any way for the intended recipient to ask for only the remaining
1297 fragments. In such a case there are two likely possibilities for what
1298 will happen next: either all of the fragments will eventually be
1299 retransmitted (as TCP will do), in which case the same problem will
1300 recur, or the sender will not realize that its packet has been dropped
1301 and data will simply be lost (as some UDP-based protocols will do).
1302 Either way, it is possible that no forward progress will ever occur.
1304 <column name="ingress_policing_rate">
1306 Maximum rate for data received on this interface, in kbps. Data
1307 received faster than this rate is dropped. Set to <code>0</code>
1308 (the default) to disable policing.
1312 <column name="ingress_policing_burst">
1313 <p>Maximum burst size for data received on this interface, in kb. The
1314 default burst size if set to <code>0</code> is 1000 kb. This value
1315 has no effect if <ref column="ingress_policing_rate"/>
1316 is <code>0</code>.</p>
1318 Specifying a larger burst size lets the algorithm be more forgiving,
1319 which is important for protocols like TCP that react severely to
1320 dropped packets. The burst size should be at least the size of the
1321 interface's MTU. Specifying a value that is numerically at least as
1322 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1323 closer to achieving the full rate.
1328 <group title="Connectivity Fault Management">
1330 802.1ag Connectivity Fault Management (CFM) allows a group of
1331 Maintenance Points (MPs) called a Maintenance Association (MA) to
1332 detect connectivity problems with each other. MPs within a MA should
1333 have complete and exclusive interconnectivity. This is verified by
1334 occasionally broadcasting Continuity Check Messages (CCMs) at a
1335 configurable transmission interval.
1338 <column name="cfm_mpid">
1339 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1340 a Maintenance Association. The MPID is used to identify this endpoint
1341 to other Maintenance Points in the MA. Each end of a link being
1342 monitored should have a different MPID. Must be configured to enable
1343 CFM on this <ref table="Interface"/>.
1346 <column name="cfm_remote_mpid">
1347 The MPID of the remote endpoint being monitored. If this
1348 <ref table="Interface"/> does not have connectivity to an endpoint
1349 advertising the configured MPID, a fault is signalled. Must be
1350 configured to enable CFM on this <ref table="Interface"/>
1353 <column name="cfm_fault">
1354 Indicates a connectivity fault triggered by an inability to receive
1355 heartbeats from the remote endpoint. When a fault is triggered on
1356 <ref table="Interface"/>s participating in bonds, they will be
1361 <group title="Other Features">
1363 <column name="lacp_current">
1364 Boolean value indicating LACP status for this interface. If true, this
1365 interface has current LACP information about its LACP partner. This
1366 information may be used to monitor the health of interfaces in a LACP
1367 enabled port. This column will be empty if LACP is not enabled.
1370 <column name="external_ids">
1371 Key-value pairs for use by external frameworks that integrate
1372 with Open vSwitch, rather than by Open vSwitch itself. System
1373 integrators should either use the Open vSwitch development
1374 mailing list to coordinate on common key-value definitions, or
1375 choose key names that are likely to be unique. The currently
1376 defined common key-value pairs are:
1378 <dt><code>attached-mac</code></dt>
1380 The MAC address programmed into the ``virtual hardware'' for this
1381 interface, in the form
1382 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1383 For Citrix XenServer, this is the value of the <code>MAC</code>
1384 field in the VIF record for this interface.</dd>
1385 <dt><code>iface-id</code></dt>
1386 <dd>A system-unique identifier for the interface. On XenServer,
1387 this will commonly be the same as
1388 <ref column="external_ids" key="xs-vif-uuid"/>.</dd>
1391 Additionally the following key-value pairs specifically
1392 apply to an interface that represents a virtual Ethernet interface
1393 connected to a virtual machine. These key-value pairs should not be
1394 present for other types of interfaces. Keys whose names end
1395 in <code>-uuid</code> have values that uniquely identify the entity
1396 in question. For a Citrix XenServer hypervisor, these values are
1397 UUIDs in RFC 4122 format. Other hypervisors may use other
1400 <p>The currently defined key-value pairs for XenServer are:</p>
1402 <dt><code>xs-vif-uuid</code></dt>
1403 <dd>The virtual interface associated with this interface.</dd>
1404 <dt><code>xs-network-uuid</code></dt>
1405 <dd>The virtual network to which this interface is attached.</dd>
1406 <dt><code>xs-vm-uuid</code></dt>
1407 <dd>The VM to which this interface belongs.</dd>
1411 <column name="other_config">
1412 Key-value pairs for rarely used interface features.
1414 <dt><code>cfm_interval</code></dt>
1415 <dd> The transmission interval of CFM heartbeats in milliseconds.
1416 Three missed heartbeat receptions indicate a connectivity fault.
1417 Defaults to 1000ms. </dd>
1418 <dt><code>bond-stable-id</code></dt>
1419 <dd> A positive integer using in <code>stable</code> bond mode to
1420 make slave selection decisions. Allocating
1421 <ref column="other_config" key="bond-stable-id"/> values
1422 consistently across interfaces participating in a bond will
1423 guarantee consistent slave selection decisions across
1424 <code>ovs-vswitchd</code> instances when using <code>stable</code>
1426 <dt><code>lacp-port-id</code></dt>
1427 <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are
1428 used in LACP negotiations to identify individual ports
1429 participating in a bond. Must be a number between 1 and
1431 <dt><code>lacp-port-priority</code></dt>
1432 <dd> The LACP port priority of this <ref table="Interface"/>. In
1433 LACP negotiations <ref table="Interface"/>s with numerically lower
1434 priorities are preferred for aggregation. Must be a number between
1436 <dt><code>lacp-aggregation-key</code></dt>
1437 <dd> The LACP aggregation key of this <ref table="Interface"/>.
1438 <ref table="Interface"/>s with different aggregation keys may not
1439 be active within a given <ref table="Port"/> at the same time. Must
1440 be a number between 1 and 65535.</dd>
1444 <column name="statistics">
1446 Key-value pairs that report interface statistics. The current
1447 implementation updates these counters periodically. In the future,
1448 we plan to, instead, update them when an interface is created, when
1449 they are queried (e.g. using an OVSDB <code>select</code> operation),
1450 and just before an interface is deleted due to virtual interface
1451 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1452 regular periodic basis.</p>
1454 The currently defined key-value pairs are listed below. These are
1455 the same statistics reported by OpenFlow in its <code>struct
1456 ofp_port_stats</code> structure. If an interface does not support a
1457 given statistic, then that pair is omitted.</p>
1460 Successful transmit and receive counters:
1462 <dt><code>rx_packets</code></dt>
1463 <dd>Number of received packets.</dd>
1464 <dt><code>rx_bytes</code></dt>
1465 <dd>Number of received bytes.</dd>
1466 <dt><code>tx_packets</code></dt>
1467 <dd>Number of transmitted packets.</dd>
1468 <dt><code>tx_bytes</code></dt>
1469 <dd>Number of transmitted bytes.</dd>
1475 <dt><code>rx_dropped</code></dt>
1476 <dd>Number of packets dropped by RX.</dd>
1477 <dt><code>rx_frame_err</code></dt>
1478 <dd>Number of frame alignment errors.</dd>
1479 <dt><code>rx_over_err</code></dt>
1480 <dd>Number of packets with RX overrun.</dd>
1481 <dt><code>rx_crc_err</code></dt>
1482 <dd>Number of CRC errors.</dd>
1483 <dt><code>rx_errors</code></dt>
1485 Total number of receive errors, greater than or equal
1486 to the sum of the above.
1493 <dt><code>tx_dropped</code></dt>
1494 <dd>Number of packets dropped by TX.</dd>
1495 <dt><code>collisions</code></dt>
1496 <dd>Number of collisions.</dd>
1497 <dt><code>tx_errors</code></dt>
1499 Total number of transmit errors, greater
1500 than or equal to the sum of the above.
1509 <table name="QoS" title="Quality of Service configuration">
1510 <p>Quality of Service (QoS) configuration for each Port that
1513 <column name="type">
1514 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1515 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1516 identifies the types that a switch actually supports. The currently
1517 defined types are listed below:</p>
1519 <dt><code>linux-htb</code></dt>
1521 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1522 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1523 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1524 for information on how this classifier works and how to configure it.
1528 <dt><code>linux-hfsc</code></dt>
1530 Linux "Hierarchical Fair Service Curve" classifier.
1531 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1532 information on how this classifier works.
1537 <column name="queues">
1538 <p>A map from queue numbers to <ref table="Queue"/> records. The
1539 supported range of queue numbers depend on <ref column="type"/>. The
1540 queue numbers are the same as the <code>queue_id</code> used in
1541 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1542 structures. Queue 0 is used by OpenFlow output actions that do not
1543 specify a specific queue.</p>
1546 <column name="other_config">
1547 <p>Key-value pairs for configuring QoS features that depend on
1548 <ref column="type"/>.</p>
1549 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1550 the following key-value pairs:</p>
1552 <dt><code>max-rate</code></dt>
1553 <dd>Maximum rate shared by all queued traffic, in bit/s.
1554 Optional. If not specified, for physical interfaces, the
1555 default is the link rate. For other interfaces or if the
1556 link rate cannot be determined, the default is currently 100
1561 <column name="external_ids">
1562 Key-value pairs for use by external frameworks that integrate with Open
1563 vSwitch, rather than by Open vSwitch itself. System integrators should
1564 either use the Open vSwitch development mailing list to coordinate on
1565 common key-value definitions, or choose key names that are likely to be
1566 unique. No common key-value pairs are currently defined.
1570 <table name="Queue" title="QoS output queue.">
1571 <p>A configuration for a port output queue, used in configuring Quality of
1572 Service (QoS) features. May be referenced by <ref column="queues"
1573 table="QoS"/> column in <ref table="QoS"/> table.</p>
1575 <column name="other_config">
1576 <p>Key-value pairs for configuring the output queue. The supported
1577 key-value pairs and their meanings depend on the <ref column="type"/>
1578 of the <ref column="QoS"/> records that reference this row.</p>
1579 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1580 column="type"/> of <code>min-rate</code> are:</p>
1582 <dt><code>min-rate</code></dt>
1583 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1584 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1586 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1587 column="type"/> of <code>linux-htb</code> are:</p>
1589 <dt><code>min-rate</code></dt>
1590 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1591 <dt><code>max-rate</code></dt>
1592 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1593 queue's rate will not be allowed to exceed the specified value, even
1594 if excess bandwidth is available. If unspecified, defaults to no
1596 <dt><code>burst</code></dt>
1597 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1598 that a queue can accumulate while it is idle. Optional. Details of
1599 the <code>linux-htb</code> implementation require a minimum burst
1600 size, so a too-small <code>burst</code> will be silently
1602 <dt><code>priority</code></dt>
1603 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1604 unspecified. A queue with a smaller <code>priority</code>
1605 will receive all the excess bandwidth that it can use before
1606 a queue with a larger value receives any. Specific priority
1607 values are unimportant; only relative ordering matters.</dd>
1609 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1610 column="type"/> of <code>linux-hfsc</code> are:</p>
1612 <dt><code>min-rate</code></dt>
1613 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1614 <dt><code>max-rate</code></dt>
1615 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1616 queue's rate will not be allowed to exceed the specified value, even
1617 if excess bandwidth is available. If unspecified, defaults to no
1622 <column name="external_ids">
1623 Key-value pairs for use by external frameworks that integrate with Open
1624 vSwitch, rather than by Open vSwitch itself. System integrators should
1625 either use the Open vSwitch development mailing list to coordinate on
1626 common key-value definitions, or choose key names that are likely to be
1627 unique. No common key-value pairs are currently defined.
1631 <table name="Mirror" title="Port mirroring (SPAN/RSPAN/ERSPAN).">
1632 <p>A port mirror within a <ref table="Bridge"/>.</p>
1633 <p>A port mirror configures a bridge to send selected frames to special
1634 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1635 traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
1636 the mirrored traffic is sent.</p>
1638 <column name="name">
1639 Arbitrary identifier for the <ref table="Mirror"/>.
1642 <group title="Selecting Packets for Mirroring">
1644 To be selected for mirroring, a given packet must enter or leave the
1645 bridge through a selected port and it must also be in one of the
1649 <column name="select_all">
1650 If true, every packet arriving or departing on any port is
1651 selected for mirroring.
1654 <column name="select_dst_port">
1655 Ports on which departing packets are selected for mirroring.
1658 <column name="select_src_port">
1659 Ports on which arriving packets are selected for mirroring.
1662 <column name="select_vlan">
1663 VLANs on which packets are selected for mirroring. An empty set
1664 selects packets on all VLANs.
1668 <group title="Mirroring Destination Configuration">
1670 These columns are mutually exclusive. Exactly one of them must be
1674 <column name="output_port">
1675 <p>Output port for selected packets, if nonempty.</p>
1676 <p>Specifying a port for mirror output reserves that port exclusively
1677 for mirroring. No frames other than those selected for mirroring
1678 will be forwarded to the port, and any frames received on the port
1679 will be discarded.</p>
1681 The output port may be any kind of port supported by Open vSwitch.
1682 It may be, for example, a physical port (sometimes called SPAN), or a
1683 GRE tunnel (sometimes called ERSPAN).
1687 <column name="output_vlan">
1688 <p>Output VLAN for selected packets, if nonempty.</p>
1689 <p>The frames will be sent out all ports that trunk
1690 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1691 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1692 trunk port, the frame's VLAN tag will be set to
1693 <ref column="output_vlan"/>, replacing any existing tag; when it is
1694 sent out an implicit VLAN port, the frame will not be tagged. This
1695 type of mirroring is sometimes called RSPAN.</p>
1697 The following destination MAC addresses will not be mirrored to a
1698 VLAN to avoid confusing switches that interpret the protocols that
1702 <dt><code>01:80:c2:00:00:00</code></dt>
1703 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1705 <dt><code>01:80:c2:00:00:01</code></dt>
1706 <dd>IEEE Pause frame.</dd>
1708 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1709 <dd>Other reserved protocols.</dd>
1711 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1713 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1714 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1718 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1719 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1721 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1722 <dd>Cisco STP Uplink Fast.</dd>
1724 <dt><code>01:00:0c:00:00:00</code></dt>
1725 <dd>Cisco Inter Switch Link.</dd>
1727 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1728 contains unmanaged switches. Consider an unmanaged physical switch
1729 with two ports: port 1, connected to an end host, and port 2,
1730 connected to an Open vSwitch configured to mirror received packets
1731 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1732 port 1 that the physical switch forwards to port 2. The Open vSwitch
1733 forwards this packet to its destination and then reflects it back on
1734 port 2 in VLAN 123. This reflected packet causes the unmanaged
1735 physical switch to replace the MAC learning table entry, which
1736 correctly pointed to port 1, with one that incorrectly points to port
1737 2. Afterward, the physical switch will direct packets destined for
1738 the end host to the Open vSwitch on port 2, instead of to the end
1739 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1740 desired in this scenario, then the physical switch must be replaced
1741 by one that learns Ethernet addresses on a per-VLAN basis. In
1742 addition, learning should be disabled on the VLAN containing mirrored
1743 traffic. If this is not done then intermediate switches will learn
1744 the MAC address of each end host from the mirrored traffic. If
1745 packets being sent to that end host are also mirrored, then they will
1746 be dropped since the switch will attempt to send them out the input
1747 port. Disabling learning for the VLAN will cause the switch to
1748 correctly send the packet out all ports configured for that VLAN. If
1749 Open vSwitch is being used as an intermediate switch, learning can be
1750 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1751 in the appropriate <ref table="Bridge"/> table or tables.</p>
1753 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
1754 VLAN and should generally be preferred.
1759 <group title="Other Features">
1760 <column name="external_ids">
1761 Key-value pairs for use by external frameworks that integrate with Open
1762 vSwitch, rather than by Open vSwitch itself. System integrators should
1763 either use the Open vSwitch development mailing list to coordinate on
1764 common key-value definitions, or choose key names that are likely to be
1765 unique. No common key-value pairs are currently defined.
1770 <table name="Controller" title="OpenFlow controller configuration.">
1771 <p>An OpenFlow controller.</p>
1774 Open vSwitch supports two kinds of OpenFlow controllers:
1778 <dt>Primary controllers</dt>
1781 This is the kind of controller envisioned by the OpenFlow 1.0
1782 specification. Usually, a primary controller implements a network
1783 policy by taking charge of the switch's flow table.
1787 Open vSwitch initiates and maintains persistent connections to
1788 primary controllers, retrying the connection each time it fails or
1789 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1790 <ref table="Bridge"/> table applies to primary controllers.
1794 Open vSwitch permits a bridge to have any number of primary
1795 controllers. When multiple controllers are configured, Open
1796 vSwitch connects to all of them simultaneously. Because
1797 OpenFlow 1.0 does not specify how multiple controllers
1798 coordinate in interacting with a single switch, more than
1799 one primary controller should be specified only if the
1800 controllers are themselves designed to coordinate with each
1801 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1802 vendor extension may be useful for this.)
1805 <dt>Service controllers</dt>
1808 These kinds of OpenFlow controller connections are intended for
1809 occasional support and maintenance use, e.g. with
1810 <code>ovs-ofctl</code>. Usually a service controller connects only
1811 briefly to inspect or modify some of a switch's state.
1815 Open vSwitch listens for incoming connections from service
1816 controllers. The service controllers initiate and, if necessary,
1817 maintain the connections from their end. The <ref table="Bridge"
1818 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1819 not apply to service controllers.
1823 Open vSwitch supports configuring any number of service controllers.
1829 The <ref column="target"/> determines the type of controller.
1832 <group title="Core Features">
1833 <column name="target">
1834 <p>Connection method for controller.</p>
1836 The following connection methods are currently supported for primary
1840 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1842 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1843 the given <var>ip</var>, which must be expressed as an IP address
1844 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1845 column in the <ref table="Open_vSwitch"/> table must point to a
1846 valid SSL configuration when this form is used.</p>
1847 <p>SSL support is an optional feature that is not always built as
1848 part of Open vSwitch.</p>
1850 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1851 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1852 the given <var>ip</var>, which must be expressed as an IP address
1853 (not a DNS name).</dd>
1856 The following connection methods are currently supported for service
1860 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1863 Listens for SSL connections on the specified TCP <var>port</var>
1864 (default: 6633). If <var>ip</var>, which must be expressed as an
1865 IP address (not a DNS name), is specified, then connections are
1866 restricted to the specified local IP address.
1869 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1870 table="Open_vSwitch"/> table must point to a valid SSL
1871 configuration when this form is used.
1873 <p>SSL support is an optional feature that is not always built as
1874 part of Open vSwitch.</p>
1876 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1878 Listens for connections on the specified TCP <var>port</var>
1879 (default: 6633). If <var>ip</var>, which must be expressed as an
1880 IP address (not a DNS name), is specified, then connections are
1881 restricted to the specified local IP address.
1884 <p>When multiple controllers are configured for a single bridge, the
1885 <ref column="target"/> values must be unique. Duplicate
1886 <ref column="target"/> values yield unspecified results.</p>
1889 <column name="connection_mode">
1890 <p>If it is specified, this setting must be one of the following
1891 strings that describes how Open vSwitch contacts this OpenFlow
1892 controller over the network:</p>
1895 <dt><code>in-band</code></dt>
1896 <dd>In this mode, this controller's OpenFlow traffic travels over the
1897 bridge associated with the controller. With this setting, Open
1898 vSwitch allows traffic to and from the controller regardless of the
1899 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1900 would never be able to connect to the controller, because it did
1901 not have a flow to enable it.) This is the most common connection
1902 mode because it is not necessary to maintain two independent
1904 <dt><code>out-of-band</code></dt>
1905 <dd>In this mode, OpenFlow traffic uses a control network separate
1906 from the bridge associated with this controller, that is, the
1907 bridge does not use any of its own network devices to communicate
1908 with the controller. The control network must be configured
1909 separately, before or after <code>ovs-vswitchd</code> is started.
1913 <p>If not specified, the default is implementation-specific.</p>
1917 <group title="Controller Failure Detection and Handling">
1918 <column name="max_backoff">
1919 Maximum number of milliseconds to wait between connection attempts.
1920 Default is implementation-specific.
1923 <column name="inactivity_probe">
1924 Maximum number of milliseconds of idle time on connection to
1925 controller before sending an inactivity probe message. If Open
1926 vSwitch does not communicate with the controller for the specified
1927 number of seconds, it will send a probe. If a response is not
1928 received for the same additional amount of time, Open vSwitch
1929 assumes the connection has been broken and attempts to reconnect.
1930 Default is implementation-specific. A value of 0 disables
1935 <group title="OpenFlow Rate Limiting">
1936 <column name="controller_rate_limit">
1937 <p>The maximum rate at which packets in unknown flows will be
1938 forwarded to the OpenFlow controller, in packets per second. This
1939 feature prevents a single bridge from overwhelming the controller.
1940 If not specified, the default is implementation-specific.</p>
1941 <p>In addition, when a high rate triggers rate-limiting, Open
1942 vSwitch queues controller packets for each port and transmits
1943 them to the controller at the configured rate. The number of
1944 queued packets is limited by
1945 the <ref column="controller_burst_limit"/> value. The packet
1946 queue is shared fairly among the ports on a bridge.</p><p>Open
1947 vSwitch maintains two such packet rate-limiters per bridge.
1948 One of these applies to packets sent up to the controller
1949 because they do not correspond to any flow. The other applies
1950 to packets sent up to the controller by request through flow
1951 actions. When both rate-limiters are filled with packets, the
1952 actual rate that packets are sent to the controller is up to
1953 twice the specified rate.</p>
1956 <column name="controller_burst_limit">
1957 In conjunction with <ref column="controller_rate_limit"/>,
1958 the maximum number of unused packet credits that the bridge will
1959 allow to accumulate, in packets. If not specified, the default
1960 is implementation-specific.
1964 <group title="Additional In-Band Configuration">
1965 <p>These values are considered only in in-band control mode (see
1966 <ref column="connection_mode"/>).</p>
1968 <p>When multiple controllers are configured on a single bridge, there
1969 should be only one set of unique values in these columns. If different
1970 values are set for these columns in different controllers, the effect
1973 <column name="local_ip">
1974 The IP address to configure on the local port,
1975 e.g. <code>192.168.0.123</code>. If this value is unset, then
1976 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1980 <column name="local_netmask">
1981 The IP netmask to configure on the local port,
1982 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1983 but this value is unset, then the default is chosen based on whether
1984 the IP address is class A, B, or C.
1987 <column name="local_gateway">
1988 The IP address of the gateway to configure on the local port, as a
1989 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1990 this network has no gateway.
1994 <group title="Other Features">
1995 <column name="external_ids">
1996 Key-value pairs for use by external frameworks that integrate with Open
1997 vSwitch, rather than by Open vSwitch itself. System integrators should
1998 either use the Open vSwitch development mailing list to coordinate on
1999 common key-value definitions, or choose key names that are likely to be
2000 unique. No common key-value pairs are currently defined.
2004 <group title="Controller Status">
2005 <column name="is_connected">
2006 <code>true</code> if currently connected to this controller,
2007 <code>false</code> otherwise.
2010 <column name="role">
2011 <p>The level of authority this controller has on the associated
2012 bridge. Possible values are:</p>
2014 <dt><code>other</code></dt>
2015 <dd>Allows the controller access to all OpenFlow features.</dd>
2016 <dt><code>master</code></dt>
2017 <dd>Equivalent to <code>other</code>, except that there may be at
2018 most one master controller at a time. When a controller configures
2019 itself as <code>master</code>, any existing master is demoted to
2020 the <code>slave</code>role.</dd>
2021 <dt><code>slave</code></dt>
2022 <dd>Allows the controller read-only access to OpenFlow features.
2023 Attempts to modify the flow table will be rejected with an
2024 error. Slave controllers do not receive OFPT_PACKET_IN or
2025 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2030 <column name="status">
2031 <p>Key-value pairs that report controller status.</p>
2033 <dt><code>last_error</code></dt>
2034 <dd>A human-readable description of the last error on the connection
2035 to the controller; i.e. <code>strerror(errno)</code>. This key
2036 will exist only if an error has occurred.</dd>
2037 <dt><code>state</code></dt>
2038 <dd>The state of the connection to the controller. Possible values
2039 are: <code>VOID</code> (connection is disabled),
2040 <code>BACKOFF</code> (attempting to reconnect at an increasing
2041 period), <code>CONNECTING</code> (attempting to connect),
2042 <code>ACTIVE</code> (connected, remote host responsive), and
2043 <code>IDLE</code> (remote host idle, sending keep-alive). These
2044 values may change in the future. They are provided only for human
2046 <dt><code>sec_since_connect</code></dt>
2047 <dd>The amount of time since this controller last successfully
2048 connected to the switch (in seconds). Value is empty if controller
2049 has never successfully connected.</dd>
2050 <dt><code>sec_since_disconnect</code></dt>
2051 <dd>The amount of time since this controller last disconnected from
2052 the switch (in seconds). Value is empty if controller has never
2059 <table name="Manager" title="OVSDB management connection.">
2061 Configuration for a database connection to an Open vSwitch database
2066 This table primarily configures the Open vSwitch database
2067 (<code>ovsdb-server</code>), not the Open vSwitch switch
2068 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2069 what connections should be treated as in-band.
2073 The Open vSwitch database server can initiate and maintain active
2074 connections to remote clients. It can also listen for database
2078 <group title="Core Features">
2079 <column name="target">
2080 <p>Connection method for managers.</p>
2082 The following connection methods are currently supported:
2085 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2088 The specified SSL <var>port</var> (default: 6632) on the host at
2089 the given <var>ip</var>, which must be expressed as an IP address
2090 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2091 column in the <ref table="Open_vSwitch"/> table must point to a
2092 valid SSL configuration when this form is used.
2095 SSL support is an optional feature that is not always built as
2096 part of Open vSwitch.
2100 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2102 The specified TCP <var>port</var> (default: 6632) on the host at
2103 the given <var>ip</var>, which must be expressed as an IP address
2106 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2109 Listens for SSL connections on the specified TCP <var>port</var>
2110 (default: 6632). If <var>ip</var>, which must be expressed as an
2111 IP address (not a DNS name), is specified, then connections are
2112 restricted to the specified local IP address.
2115 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2116 table="Open_vSwitch"/> table must point to a valid SSL
2117 configuration when this form is used.
2120 SSL support is an optional feature that is not always built as
2121 part of Open vSwitch.
2124 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2126 Listens for connections on the specified TCP <var>port</var>
2127 (default: 6632). If <var>ip</var>, which must be expressed as an
2128 IP address (not a DNS name), is specified, then connections are
2129 restricted to the specified local IP address.
2132 <p>When multiple managers are configured, the <ref column="target"/>
2133 values must be unique. Duplicate <ref column="target"/> values yield
2134 unspecified results.</p>
2137 <column name="connection_mode">
2139 If it is specified, this setting must be one of the following strings
2140 that describes how Open vSwitch contacts this OVSDB client over the
2145 <dt><code>in-band</code></dt>
2147 In this mode, this connection's traffic travels over a bridge
2148 managed by Open vSwitch. With this setting, Open vSwitch allows
2149 traffic to and from the client regardless of the contents of the
2150 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2151 to connect to the client, because it did not have a flow to enable
2152 it.) This is the most common connection mode because it is not
2153 necessary to maintain two independent networks.
2155 <dt><code>out-of-band</code></dt>
2157 In this mode, the client's traffic uses a control network separate
2158 from that managed by Open vSwitch, that is, Open vSwitch does not
2159 use any of its own network devices to communicate with the client.
2160 The control network must be configured separately, before or after
2161 <code>ovs-vswitchd</code> is started.
2166 If not specified, the default is implementation-specific.
2171 <group title="Client Failure Detection and Handling">
2172 <column name="max_backoff">
2173 Maximum number of milliseconds to wait between connection attempts.
2174 Default is implementation-specific.
2177 <column name="inactivity_probe">
2178 Maximum number of milliseconds of idle time on connection to the client
2179 before sending an inactivity probe message. If Open vSwitch does not
2180 communicate with the client for the specified number of seconds, it
2181 will send a probe. If a response is not received for the same
2182 additional amount of time, Open vSwitch assumes the connection has been
2183 broken and attempts to reconnect. Default is implementation-specific.
2184 A value of 0 disables inactivity probes.
2188 <group title="Other Features">
2189 <column name="external_ids">
2190 Key-value pairs for use by external frameworks that integrate with Open
2191 vSwitch, rather than by Open vSwitch itself. System integrators should
2192 either use the Open vSwitch development mailing list to coordinate on
2193 common key-value definitions, or choose key names that are likely to be
2194 unique. No common key-value pairs are currently defined.
2198 <group title="Status">
2199 <column name="is_connected">
2200 <code>true</code> if currently connected to this manager,
2201 <code>false</code> otherwise.
2204 <column name="status">
2205 <p>Key-value pairs that report manager status.</p>
2207 <dt><code>last_error</code></dt>
2208 <dd>A human-readable description of the last error on the connection
2209 to the manager; i.e. <code>strerror(errno)</code>. This key
2210 will exist only if an error has occurred.</dd>
2213 <dt><code>state</code></dt>
2214 <dd>The state of the connection to the manager. Possible values
2215 are: <code>VOID</code> (connection is disabled),
2216 <code>BACKOFF</code> (attempting to reconnect at an increasing
2217 period), <code>CONNECTING</code> (attempting to connect),
2218 <code>ACTIVE</code> (connected, remote host responsive), and
2219 <code>IDLE</code> (remote host idle, sending keep-alive). These
2220 values may change in the future. They are provided only for human
2224 <dt><code>sec_since_connect</code></dt>
2225 <dd>The amount of time since this manager last successfully connected
2226 to the database (in seconds). Value is empty if manager has never
2227 successfully connected.</dd>
2230 <dt><code>sec_since_disconnect</code></dt>
2231 <dd>The amount of time since this manager last disconnected from the
2232 database (in seconds). Value is empty if manager has never
2236 <dt><code>locks_held</code></dt>
2237 <dt><code>locks_waiting</code></dt>
2238 <dt><code>locks_lost</code></dt>
2240 Space-separated lists of the names of OVSDB locks that the
2241 connection holds, is currently waiting to acquire, or has had
2242 stolen by another OVSDB client, respectively. Key-value pairs for
2243 lists that would be empty are omitted.
2247 <dt><code>n_connections</code></dt>
2250 When <ref column="target"/> specifies a connection method that
2251 listens for inbound connections (e.g. <code>ptcp:</code> or
2252 <code>pssl:</code>) and more than one connection is actually
2253 active, the value is the number of active connections.
2254 Otherwise, this key-value pair is omitted.
2257 When multiple connections are active, status columns and
2258 key-value pairs (other than this one) report the status of one
2259 arbitrarily chosen connection.
2267 <table name="NetFlow">
2268 A NetFlow target. NetFlow is a protocol that exports a number of
2269 details about terminating IP flows, such as the principals involved
2272 <column name="targets">
2273 NetFlow targets in the form
2274 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2275 must be specified numerically, not as a DNS name.
2278 <column name="engine_id">
2279 Engine ID to use in NetFlow messages. Defaults to datapath index
2283 <column name="engine_type">
2284 Engine type to use in NetFlow messages. Defaults to datapath
2285 index if not specified.
2288 <column name="active_timeout">
2289 The interval at which NetFlow records are sent for flows that are
2290 still active, in seconds. A value of <code>0</code> requests the
2291 default timeout (currently 600 seconds); a value of <code>-1</code>
2292 disables active timeouts.
2295 <column name="add_id_to_interface">
2296 <p>If this column's value is <code>false</code>, the ingress and egress
2297 interface fields of NetFlow flow records are derived from OpenFlow port
2298 numbers. When it is <code>true</code>, the 7 most significant bits of
2299 these fields will be replaced by the least significant 7 bits of the
2300 engine id. This is useful because many NetFlow collectors do not
2301 expect multiple switches to be sending messages from the same host, so
2302 they do not store the engine information which could be used to
2303 disambiguate the traffic.</p>
2304 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2307 <column name="external_ids">
2308 Key-value pairs for use by external frameworks that integrate with Open
2309 vSwitch, rather than by Open vSwitch itself. System integrators should
2310 either use the Open vSwitch development mailing list to coordinate on
2311 common key-value definitions, or choose key names that are likely to be
2312 unique. No common key-value pairs are currently defined.
2317 SSL configuration for an Open_vSwitch.
2319 <column name="private_key">
2320 Name of a PEM file containing the private key used as the switch's
2321 identity for SSL connections to the controller.
2324 <column name="certificate">
2325 Name of a PEM file containing a certificate, signed by the
2326 certificate authority (CA) used by the controller and manager,
2327 that certifies the switch's private key, identifying a trustworthy
2331 <column name="ca_cert">
2332 Name of a PEM file containing the CA certificate used to verify
2333 that the switch is connected to a trustworthy controller.
2336 <column name="bootstrap_ca_cert">
2337 If set to <code>true</code>, then Open vSwitch will attempt to
2338 obtain the CA certificate from the controller on its first SSL
2339 connection and save it to the named PEM file. If it is successful,
2340 it will immediately drop the connection and reconnect, and from then
2341 on all SSL connections must be authenticated by a certificate signed
2342 by the CA certificate thus obtained. <em>This option exposes the
2343 SSL connection to a man-in-the-middle attack obtaining the initial
2344 CA certificate.</em> It may still be useful for bootstrapping.
2347 <column name="external_ids">
2348 Key-value pairs for use by external frameworks that integrate with Open
2349 vSwitch, rather than by Open vSwitch itself. System integrators should
2350 either use the Open vSwitch development mailing list to coordinate on
2351 common key-value definitions, or choose key names that are likely to be
2352 unique. No common key-value pairs are currently defined.
2356 <table name="sFlow">
2357 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2360 <column name="agent">
2361 Name of the network device whose IP address should be reported as the
2362 ``agent address'' to collectors. If not specified, the IP address
2363 defaults to the <ref table="Controller" column="local_ip"/> in the
2364 collector's <ref table="Controller"/>. If an agent IP address cannot be
2365 determined either way, sFlow is disabled.
2368 <column name="header">
2369 Number of bytes of a sampled packet to send to the collector.
2370 If not specified, the default is 128 bytes.
2373 <column name="polling">
2374 Polling rate in seconds to send port statistics to the collector.
2375 If not specified, defaults to 30 seconds.
2378 <column name="sampling">
2379 Rate at which packets should be sampled and sent to the collector.
2380 If not specified, defaults to 400, which means one out of 400
2381 packets, on average, will be sent to the collector.
2384 <column name="targets">
2385 sFlow targets in the form
2386 <code><var>ip</var>:<var>port</var></code>.
2389 <column name="external_ids">
2390 Key-value pairs for use by external frameworks that integrate with Open
2391 vSwitch, rather than by Open vSwitch itself. System integrators should
2392 either use the Open vSwitch development mailing list to coordinate on
2393 common key-value definitions, or choose key names that are likely to be
2394 unique. No common key-value pairs are currently defined.
2398 <table name="Capability">
2399 <p>Records in this table describe functionality supported by the hardware
2400 and software platform on which this Open vSwitch is based. Clients
2401 should not modify this table.</p>
2403 <p>A record in this table is meaningful only if it is referenced by the
2404 <ref table="Open_vSwitch" column="capabilities"/> column in the
2405 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2406 the record's ``category,'' determines the meanings of the
2407 <ref column="details"/> column. The following general forms of
2408 categories are currently defined:</p>
2411 <dt><code>qos-<var>type</var></code></dt>
2412 <dd><var>type</var> is supported as the value for
2413 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2417 <column name="details">
2418 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2419 depends on the category key that the <ref table="Open_vSwitch"
2420 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2421 uses to reference this record, as described above.</p>
2423 <p>The presence of a record for category <code>qos-<var>type</var></code>
2424 indicates that the switch supports <var>type</var> as the value of
2425 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2426 table. The following key-value pairs are defined to further describe
2427 QoS capabilities:</p>
2430 <dt><code>n-queues</code></dt>
2431 <dd>Number of supported queues, as a positive integer. Keys in the
2432 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2433 records whose <ref table="QoS" column="type"/> value
2434 equals <var>type</var> must range between 0 and this value minus one,