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">
337 VLAN IDs of VLANs on which MAC address learning should be disabled, so
338 that packets are flooded instead of being sent to specific ports that
339 are believed to contain packets' destination MACs. This should
340 ordinarily be used to disable MAC learning on VLANs used for mirroring
341 (RSPAN VLANs). It may also be useful for debugging.
345 <group title="OpenFlow Configuration">
346 <column name="controller">
347 OpenFlow controller set. If unset, then no OpenFlow controllers
351 <column name="fail_mode">
352 <p>When a controller is configured, it is, ordinarily, responsible
353 for setting up all flows on the switch. Thus, if the connection to
354 the controller fails, no new network connections can be set up.
355 If the connection to the controller stays down long enough,
356 no packets can pass through the switch at all. This setting
357 determines the switch's response to such a situation. It may be set
358 to one of the following:
360 <dt><code>standalone</code></dt>
361 <dd>If no message is received from the controller for three
362 times the inactivity probe interval
363 (see <ref column="inactivity_probe"/>), then Open vSwitch
364 will take over responsibility for setting up flows. In
365 this mode, Open vSwitch causes the bridge to act like an
366 ordinary MAC-learning switch. Open vSwitch will continue
367 to retry connecting to the controller in the background
368 and, when the connection succeeds, it will discontinue its
369 standalone behavior.</dd>
370 <dt><code>secure</code></dt>
371 <dd>Open vSwitch will not set up flows on its own when the
372 controller connection fails or when no controllers are
373 defined. The bridge will continue to retry connecting to
374 any defined controllers forever.</dd>
377 <p>If this value is unset, the default is implementation-specific.</p>
378 <p>When more than one controller is configured,
379 <ref column="fail_mode"/> is considered only when none of the
380 configured controllers can be contacted.</p>
383 <column name="datapath_id">
384 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
385 (Setting this column has no useful effect. Set <ref
386 column="other-config" key="datapath-id"/> instead.)
390 <group title="Other Features">
391 <column name="datapath_type">
392 Name of datapath provider. The kernel datapath has
393 type <code>system</code>. The userspace datapath has
394 type <code>netdev</code>.
397 <column name="external_ids">
398 Key-value pairs for use by external frameworks that integrate
399 with Open vSwitch, rather than by Open vSwitch itself. System
400 integrators should either use the Open vSwitch development
401 mailing list to coordinate on common key-value definitions, or
402 choose key names that are likely to be unique. The currently
403 defined key-value pairs are:
405 <dt><code>bridge-id</code></dt>
406 <dd>A unique identifier of the bridge. On Citrix XenServer this will
407 commonly be the same as
408 <ref column="external_ids" key="xs-network-uuids"/>.</dd>
409 <dt><code>xs-network-uuids</code></dt>
410 <dd>Semicolon-delimited set of universally unique identifier(s) for
411 the network with which this bridge is associated on a Citrix
412 XenServer host. The network identifiers are RFC 4122 UUIDs as
413 displayed by, e.g., <code>xe network-list</code>.</dd>
417 <column name="other_config">
418 Key-value pairs for configuring rarely used bridge
419 features. The currently defined key-value pairs are:
421 <dt><code>datapath-id</code></dt>
423 digits to set the OpenFlow datapath ID to a specific
424 value. May not be all-zero.</dd>
425 <dt><code>disable-in-band</code></dt>
426 <dd>If set to <code>true</code>, disable in-band control on
427 the bridge regardless of controller and manager settings.</dd>
428 <dt><code>hwaddr</code></dt>
429 <dd>An Ethernet address in the form
430 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
431 to set the hardware address of the local port and influence the
433 <dt><code>in-band-queue</code></dt>
435 A queue ID as a nonnegative integer. This sets the OpenFlow queue
436 ID that will be used by flows set up by in-band control on this
437 bridge. If unset, or if the port used by an in-band control flow
438 does not have QoS configured, or if the port does not have a queue
439 with the specified ID, the default queue is used instead.
446 <table name="Port" table="Port or bond configuration.">
447 <p>A port within a <ref table="Bridge"/>.</p>
448 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
449 <ref column="interfaces"/> column. Such a port logically
450 corresponds to a port on a physical Ethernet switch. A port
451 with more than one interface is a ``bonded port'' (see
452 <ref group="Bonding Configuration"/>).</p>
453 <p>Some properties that one might think as belonging to a port are actually
454 part of the port's <ref table="Interface"/> members.</p>
457 Port name. Should be alphanumeric and no more than about 8
458 bytes long. May be the same as the interface name, for
459 non-bonded ports. Must otherwise be unique among the names of
460 ports, interfaces, and bridges on a host.
463 <column name="interfaces">
464 The port's interfaces. If there is more than one, this is a
468 <group title="VLAN Configuration">
469 <p>A bridge port must be configured for VLANs in one of two
470 mutually exclusive ways:
472 <li>A ``trunk port'' has an empty value for <ref
473 column="tag"/>. Its <ref column="trunks"/> value may be
474 empty or non-empty.</li>
475 <li>An ``implicitly tagged VLAN port'' or ``access port''
476 has an nonempty value for <ref column="tag"/>. Its
477 <ref column="trunks"/> value must be empty.</li>
479 If <ref column="trunks"/> and <ref column="tag"/> are both
480 nonempty, the configuration is ill-formed.
485 If this is an access port (see above), the port's implicitly
486 tagged VLAN. Must be empty if this is a trunk port.
489 Frames arriving on trunk ports will be forwarded to this
490 port only if they are tagged with the given VLAN (or, if
491 <ref column="tag"/> is 0, then if they lack a VLAN header).
492 Frames arriving on other access ports will be forwarded to
493 this port only if they have the same <ref column="tag"/>
494 value. Frames forwarded to this port will not have an
498 When a frame with a 802.1Q header that indicates a nonzero
499 VLAN is received on an access port, it is discarded.
503 <column name="trunks">
505 If this is a trunk port (see above), the 802.1Q VLAN(s) that
506 this port trunks; if it is empty, then the port trunks all
507 VLANs. Must be empty if this is an access port.
510 Frames arriving on trunk ports are dropped if they are not
511 in one of the specified VLANs. For this purpose, packets
512 that have no VLAN header are treated as part of VLAN 0.
517 <group title="Bonding Configuration">
518 <p>A port that has more than one interface is a ``bonded port.'' Bonding
519 allows for load balancing and fail-over. Some kinds of bonding will
520 work with any kind of upstream switch:</p>
523 <dt><code>balance-slb</code></dt>
525 Balances flows among slaves based on source MAC address and output
526 VLAN, with periodic rebalancing as traffic patterns change.
529 <dt><code>active-backup</code></dt>
531 Assigns all flows to one slave, failing over to a backup slave when
532 the active slave is disabled.
537 The following modes require the upstream switch to support 802.3ad with
538 successful LACP negotiation. If LACP negotiation fails then
539 <code>balance-slb</code> style flow hashing is used as a fallback:
543 <dt><code>balance-tcp</code></dt>
545 Balances flows among slaves based on L2, L3, and L4 protocol
546 information such as destination MAC address, IP address, and TCP
552 <dt><code>stable</code></dt>
554 <p>Attempts to always assign a given flow to the same slave
555 consistently. In an effort to maintain stability, no load
556 balancing is done. Uses a similar hashing strategy to
557 <code>balance-tcp</code>, always taking into account L3 and L4
558 fields even if LACP negotiations are unsuccessful. </p>
559 <p>Slave selection decisions are made based on <ref table="Interface"
560 column="other_config" key="bond-stable-id"/> if set. Otherwise,
561 OpenFlow port number is used. Decisions are consistent across all
562 <code>ovs-vswitchd</code> instances with equivalent
563 <ref table="Interface" column="other_config" key="bond-stable-id"/>
568 <p>These columns apply only to bonded ports. Their values are
569 otherwise ignored.</p>
571 <column name="bond_mode">
572 <p>The type of bonding used for a bonded port. Defaults to
573 <code>balance-slb</code> if unset.
577 <column name="bond_updelay">
578 <p>For a bonded port, the number of milliseconds for which carrier must
579 stay up on an interface before the interface is considered to be up.
580 Specify <code>0</code> to enable the interface immediately.</p>
581 <p>This setting is honored only when at least one bonded interface is
582 already enabled. When no interfaces are enabled, then the first bond
583 interface to come up is enabled immediately.</p>
586 <column name="bond_downdelay">
587 For a bonded port, the number of milliseconds for which carrier must
588 stay down on an interface before the interface is considered to be
589 down. Specify <code>0</code> to disable the interface immediately.
592 <column name="bond_fake_iface">
593 For a bonded port, whether to create a fake internal interface with the
594 name of the port. Use only for compatibility with legacy software that
599 <p>Configures LACP on this port. LACP allows directly connected
600 switches to negotiate which links may be bonded. LACP may be enabled
601 on non-bonded ports for the benefit of any switches they may be
602 connected to. <code>active</code> ports are allowed to initiate LACP
603 negotiations. <code>passive</code> ports are allowed to participate
604 in LACP negotiations initiated by a remote switch, but not allowed to
605 initiate such negotiations themselves. If unset Open vSwitch will
606 choose a reasonable default. </p>
611 <group title="Other Features">
613 Quality of Service configuration for this port.
617 The MAC address to use for this port for the purpose of choosing the
618 bridge's MAC address. This column does not necessarily reflect the
619 port's actual MAC address, nor will setting it change the port's actual
623 <column name="fake_bridge">
624 Does this port represent a sub-bridge for its tagged VLAN within the
625 Bridge? See ovs-vsctl(8) for more information.
628 <column name="external_ids">
630 Key-value pairs for use by external frameworks that integrate with
631 Open vSwitch, rather than by Open vSwitch itself. System integrators
632 should either use the Open vSwitch development mailing list to
633 coordinate on common key-value definitions, or choose key names that
634 are likely to be unique.
637 No key-value pairs native to <ref table="Port"/> are currently
638 defined. For fake bridges (see the <ref column="fake_bridge"/>
639 column), external IDs for the fake bridge are defined here by
640 prefixing a <ref table="Bridge"/> <ref table="Bridge"
641 column="external_ids"/> key with <code>fake-bridge-</code>,
642 e.g. <code>fake-bridge-xs-network-uuids</code>.
646 <column name="other_config">
647 Key-value pairs for configuring rarely used port features. The
648 currently defined key-value pairs are:
650 <dt><code>hwaddr</code></dt>
651 <dd>An Ethernet address in the form
652 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
653 <dt><code>bond-rebalance-interval</code></dt>
654 <dd>For an SLB bonded port, the number of milliseconds between
655 successive attempts to rebalance the bond, that is, to
656 move source MACs and their flows from one interface on
657 the bond to another in an attempt to keep usage of each
658 interface roughly equal. The default is 10000 (10
659 seconds), and the minimum is 1000 (1 second).</dd>
660 <dt><code>bond-detect-mode</code></dt>
661 <dd> Sets the method used to detect link failures in a bonded port.
662 Options are <code>carrier</code> and <code>miimon</code>. Defaults
663 to <code>carrier</code> which uses each interface's carrier to detect
664 failures. When set to <code>miimon</code>, will check for failures
665 by polling each interface's MII. </dd>
666 <dt><code>bond-miimon-interval</code></dt>
667 <dd> The number of milliseconds between successive attempts to
668 poll each interface's MII. Only relevant on ports which use
669 <code>miimon</code> to detect failures. </dd>
670 <dt><code>bond-hash-basis</code></dt>
671 <dd> An integer hashed along with flows when choosing output slaves.
672 When changed, all flows will be assigned different hash values
673 possibly causing slave selection decisions to change.</dd>
674 <dt><code>lacp-system-id</code></dt>
675 <dd> The LACP system ID of this <ref table="Port"/>. The system ID
676 of a LACP bond is used to identify itself to its partners. Must
677 be a nonzero MAC address.</dd>
678 <dt><code>lacp-system-priority</code></dt>
679 <dd> The LACP system priority of this <ref table="Port"/>. In
680 LACP negotiations, link status decisions are made by the system
681 with the numerically lower priority. Must be a number between 1
683 <dt><code>lacp-time</code></dt>
685 <p>The LACP timing which should be used on this
686 <ref table="Port"/>. Possible values are <code>fast</code>,
687 <code>slow</code> and a positive number of milliseconds. By
688 default <code>slow</code> is used. When configured to be
689 <code>fast</code> LACP heartbeats are requested at a rate of once
690 per second causing connectivity problems to be detected more
691 quickly. In <code>slow</code> mode, heartbeats are requested at
692 a rate of once every 30 seconds.</p>
694 <p>Users may manually set a heartbeat transmission rate to increase
695 the fault detection speed further. When manually set, OVS
696 expects the partner switch to be configured with the same
697 transmission rate. Manually setting <code>lacp-time</code> to
698 something other than <code>fast</code> or <code>slow</code> is
699 not supported by the LACP specification.</p>
701 <dt><code>lacp-heartbeat</code></dt>
702 <dd> Treats LACP like a simple heartbeat protocol for link state
703 monitoring. Most features of the LACP protocol are disabled when
704 this mode is in use.</dd>
710 <table name="Interface" title="One physical network device in a Port.">
711 An interface within a <ref table="Port"/>.
713 <group title="Core Features">
715 Interface name. Should be alphanumeric and no more than about 8 bytes
716 long. May be the same as the port name, for non-bonded ports. Must
717 otherwise be unique among the names of ports, interfaces, and bridges
722 <p>Ethernet address to set for this interface. If unset then the
723 default MAC address is used:</p>
725 <li>For the local interface, the default is the lowest-numbered MAC
726 address among the other bridge ports, either the value of the
727 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
728 if set, or its actual MAC (for bonded ports, the MAC of its slave
729 whose name is first in alphabetical order). Internal ports and
730 bridge ports that are used as port mirroring destinations (see the
731 <ref table="Mirror"/> table) are ignored.</li>
732 <li>For other internal interfaces, the default MAC is randomly
734 <li>External interfaces typically have a MAC address associated with
737 <p>Some interfaces may not have a software-controllable MAC
741 <column name="ofport">
742 <p>OpenFlow port number for this interface. Unlike most columns, this
743 column's value should be set only by Open vSwitch itself. Other
744 clients should set this column to an empty set (the default) when
745 creating an <ref table="Interface"/>.</p>
746 <p>Open vSwitch populates this column when the port number becomes
747 known. If the interface is successfully added,
748 <ref column="ofport"/> will be set to a number between 1 and 65535
749 (generally either in the range 1 to 65279, inclusive, or 65534, the
750 port number for the OpenFlow ``local port''). If the interface
751 cannot be added then Open vSwitch sets this column
756 <group title="System-Specific Details">
758 The interface type, one of:
760 <dt><code>system</code></dt>
761 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
762 Sometimes referred to as ``external interfaces'' since they are
763 generally connected to hardware external to that on which the Open
764 vSwitch is running. The empty string is a synonym for
765 <code>system</code>.</dd>
766 <dt><code>internal</code></dt>
767 <dd>A simulated network device that sends and receives traffic. An
768 internal interface whose <ref column="name"/> is the same as its
769 bridge's <ref table="Open_vSwitch" column="name"/> is called the
770 ``local interface.'' It does not make sense to bond an internal
771 interface, so the terms ``port'' and ``interface'' are often used
772 imprecisely for internal interfaces.</dd>
773 <dt><code>tap</code></dt>
774 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
775 <dt><code>gre</code></dt>
776 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
777 tunnel. Each tunnel must be uniquely identified by the
778 combination of <ref column="options" key="remote_ip"/>,
779 <ref column="options" key="local_ip"/>, and
780 <ref column="options" key="in_key"/>. Note that if two ports
781 are defined that are the same except one has an optional
782 identifier and the other does not, the more specific one is
783 matched first. <ref column="options" key="in_key"/> is considered
784 more specific than <ref column="options" key="local_ip"/> if a port
785 defines one and another port defines the other. The following
786 options may be specified in the <ref column="options"/> column:
788 <dt><code>remote_ip</code></dt>
789 <dd>Required. The tunnel endpoint.</dd>
792 <dt><code>local_ip</code></dt>
793 <dd>Optional. The destination IP that received packets must
794 match. Default is to match all addresses.</dd>
797 <dt><code>in_key</code></dt>
798 <dd>Optional. The GRE key that received packets must contain.
799 It may either be a 32-bit number (no key and a key of 0 are
800 treated as equivalent) or the word <code>flow</code>. If
801 <code>flow</code> is specified then any key will be accepted
802 and the key will be placed in the <code>tun_id</code> field
803 for matching in the flow table. The ovs-ofctl manual page
804 contains additional information about matching fields in
805 OpenFlow flows. Default is no key.</dd>
808 <dt><code>out_key</code></dt>
809 <dd>Optional. The GRE key to be set on outgoing packets. It may
810 either be a 32-bit number or the word <code>flow</code>. If
811 <code>flow</code> is specified then the key may be set using
812 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
813 is used in the absence of an action). The ovs-ofctl manual
814 page contains additional information about the Nicira OpenFlow
815 vendor extensions. Default is no key.</dd>
818 <dt><code>key</code></dt>
819 <dd>Optional. Shorthand to set <code>in_key</code> and
820 <code>out_key</code> at the same time.</dd>
823 <dt><code>tos</code></dt>
824 <dd>Optional. The value of the ToS bits to be set on the
825 encapsulating packet. It may also be the word
826 <code>inherit</code>, in which case the ToS will be copied from
827 the inner packet if it is IPv4 or IPv6 (otherwise it will be
828 0). Note that the ECN fields are always inherited. Default is
832 <dt><code>ttl</code></dt>
833 <dd>Optional. The TTL to be set on the encapsulating packet.
834 It may also be the word <code>inherit</code>, in which case the
835 TTL will be copied from the inner packet if it is IPv4 or IPv6
836 (otherwise it will be the system default, typically 64).
837 Default is the system default TTL.</dd>
840 <dt><code>csum</code></dt>
841 <dd>Optional. Compute GRE checksums on outgoing packets.
842 Checksums present on incoming packets will be validated
843 regardless of this setting. Note that GRE checksums
844 impose a significant performance penalty as they cover the
845 entire packet. As the contents of the packet is typically
846 covered by L3 and L4 checksums, this additional checksum only
847 adds value for the GRE and encapsulated Ethernet headers.
848 Default is disabled, set to <code>true</code> to enable.</dd>
851 <dt><code>df_inherit</code></dt>
852 <dd>Optional. If enabled, the Don't Fragment bit will be copied
853 from the inner IP headers (those of the encapsulated traffic)
854 to the outer (tunnel) headers. Default is disabled; set to
855 <code>true</code> to enable.</dd>
858 <dt><code>df_default</code></dt>
859 <dd>Optional. If enabled, the Don't Fragment bit will be set by
860 default on tunnel headers if the <code>df_inherit</code> option
861 is not set, or if the encapsulated packet is not IP. Default
862 is enabled; set to <code>false</code> to disable.</dd>
865 <dt><code>pmtud</code></dt>
866 <dd>Optional. Enable tunnel path MTU discovery. If enabled
867 ``ICMP Destination Unreachable - Fragmentation Needed''
868 messages will be generated for IPv4 packets with the DF bit set
869 and IPv6 packets above the minimum MTU if the packet size
870 exceeds the path MTU minus the size of the tunnel headers.
871 Note that this option causes behavior that is typically
872 reserved for routers and therefore is not entirely in
873 compliance with the IEEE 802.1D specification for bridges.
874 Default is enabled; set to <code>false</code> to disable.</dd>
877 <dt><code>header_cache</code></dt>
878 <dd>Optional. Enable caching of tunnel headers and the output
879 path. This can lead to a significant performance increase
880 without changing behavior. In general it should not be
881 necessary to adjust this setting. However, the caching can
882 bypass certain components of the IP stack (such as IP tables)
883 and it may be useful to disable it if these features are
884 required or as a debugging measure. Default is enabled, set to
885 <code>false</code> to disable.</dd>
888 <dt><code>ipsec_gre</code></dt>
889 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
890 over IPv4 IPsec tunnel. Each tunnel (including those of type
891 <code>gre</code>) must be uniquely identified by the
892 combination of <ref column="options" key="remote_ip"/> and
893 <ref column="options" key="local_ip"/>. Note that if two ports are
894 defined that are the same except one has an optional identifier and
895 the other does not, the more specific one is matched first.
896 An authentication method of <ref column="options" key="peer_cert"/>
897 or <ref column="options" key="psk"/> must be defined. The
898 following options may be specified in the <ref column="options"/>
901 <dt><code>remote_ip</code></dt>
902 <dd>Required. The tunnel endpoint.</dd>
905 <dt><code>local_ip</code></dt>
906 <dd>Optional. The destination IP that received packets must
907 match. Default is to match all addresses.</dd>
910 <dt><code>peer_cert</code></dt>
911 <dd>Required for certificate authentication. A string
912 containing the peer's certificate in PEM format.
913 Additionally the host's certificate must be specified
914 with the <code>certificate</code> option.</dd>
917 <dt><code>certificate</code></dt>
918 <dd>Required for certificate authentication. The name of a
919 PEM file containing a certificate that will be presented
920 to the peer during authentication.</dd>
923 <dt><code>private_key</code></dt>
924 <dd>Optional for certificate authentication. The name of
925 a PEM file containing the private key associated with
926 <code>certificate</code>. If <code>certificate</code>
927 contains the private key, this option may be omitted.</dd>
930 <dt><code>psk</code></dt>
931 <dd>Required for pre-shared key authentication. Specifies a
932 pre-shared key for authentication that must be identical on
933 both sides of the tunnel.</dd>
936 <dt><code>in_key</code></dt>
937 <dd>Optional. The GRE key that received packets must contain.
938 It may either be a 32-bit number (no key and a key of 0 are
939 treated as equivalent) or the word <code>flow</code>. If
940 <code>flow</code> is specified then any key will be accepted
941 and the key will be placed in the <code>tun_id</code> field
942 for matching in the flow table. The ovs-ofctl manual page
943 contains additional information about matching fields in
944 OpenFlow flows. Default is no key.</dd>
947 <dt><code>out_key</code></dt>
948 <dd>Optional. The GRE key to be set on outgoing packets. It may
949 either be a 32-bit number or the word <code>flow</code>. If
950 <code>flow</code> is specified then the key may be set using
951 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
952 is used in the absence of an action). The ovs-ofctl manual
953 page contains additional information about the Nicira OpenFlow
954 vendor extensions. Default is no key.</dd>
957 <dt><code>key</code></dt>
958 <dd>Optional. Shorthand to set <code>in_key</code> and
959 <code>out_key</code> at the same time.</dd>
962 <dt><code>tos</code></dt>
963 <dd>Optional. The value of the ToS bits to be set on the
964 encapsulating packet. It may also be the word
965 <code>inherit</code>, in which case the ToS will be copied from
966 the inner packet if it is IPv4 or IPv6 (otherwise it will be
967 0). Note that the ECN fields are always inherited. Default is
971 <dt><code>ttl</code></dt>
972 <dd>Optional. The TTL to be set on the encapsulating packet.
973 It may also be the word <code>inherit</code>, in which case the
974 TTL will be copied from the inner packet if it is IPv4 or IPv6
975 (otherwise it will be the system default, typically 64).
976 Default is the system default TTL.</dd>
979 <dt><code>csum</code></dt>
980 <dd>Optional. Compute GRE checksums on outgoing packets.
981 Checksums present on incoming packets will be validated
982 regardless of this setting. Note that GRE checksums
983 impose a significant performance penalty as they cover the
984 entire packet. As the contents of the packet is typically
985 covered by L3 and L4 checksums, this additional checksum only
986 adds value for the GRE and encapsulated Ethernet headers.
987 Default is disabled, set to <code>true</code> to enable.</dd>
990 <dt><code>df_inherit</code></dt>
991 <dd>Optional. If enabled, the Don't Fragment bit will be copied
992 from the inner IP headers (those of the encapsulated traffic)
993 to the outer (tunnel) headers. Default is disabled; set to
994 <code>true</code> to enable.</dd>
997 <dt><code>df_default</code></dt>
998 <dd>Optional. If enabled, the Don't Fragment bit will be set by
999 default on tunnel headers if the <code>df_inherit</code> option
1000 is not set, or if the encapsulated packet is not IP. Default
1001 is enabled; set to <code>false</code> to disable.</dd>
1004 <dt><code>pmtud</code></dt>
1005 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1006 ``ICMP Destination Unreachable - Fragmentation Needed''
1007 messages will be generated for IPv4 packets with the DF bit set
1008 and IPv6 packets above the minimum MTU if the packet size
1009 exceeds the path MTU minus the size of the tunnel headers.
1010 Note that this option causes behavior that is typically
1011 reserved for routers and therefore is not entirely in
1012 compliance with the IEEE 802.1D specification for bridges.
1013 Default is enabled; set to <code>false</code> to disable.</dd>
1016 <dt><code>capwap</code></dt>
1017 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
1018 (RFC 5415). This allows interoperability with certain switches
1019 where GRE is not available. Note that only the tunneling component
1020 of the protocol is implemented. Due to the non-standard use of
1021 CAPWAP, UDP ports 58881 and 58882 are used as the source and
1022 destination ports respectively. Each tunnel must be uniquely
1023 identified by the combination of
1024 <ref column="options" key="remote_ip"/> and
1025 <ref column="options" key="local_ip"/>. If two ports are defined
1026 that are the same except one includes
1027 <ref column="options" key="local_ip"/> and the other does not, the
1028 more specific one is matched first. CAPWAP support is not
1029 available on all platforms. Currently it is only supported in the
1030 Linux kernel module with kernel versions >= 2.6.25. The following
1031 options may be specified in the <ref column="options"/> column:
1033 <dt><code>remote_ip</code></dt>
1034 <dd>Required. The tunnel endpoint.</dd>
1037 <dt><code>local_ip</code></dt>
1038 <dd>Optional. The destination IP that received packets must
1039 match. Default is to match all addresses.</dd>
1042 <dt><code>tos</code></dt>
1043 <dd>Optional. The value of the ToS bits to be set on the
1044 encapsulating packet. It may also be the word
1045 <code>inherit</code>, in which case the ToS will be copied from
1046 the inner packet if it is IPv4 or IPv6 (otherwise it will be
1047 0). Note that the ECN fields are always inherited. Default is
1051 <dt><code>ttl</code></dt>
1052 <dd>Optional. The TTL to be set on the encapsulating packet.
1053 It may also be the word <code>inherit</code>, in which case the
1054 TTL will be copied from the inner packet if it is IPv4 or IPv6
1055 (otherwise it will be the system default, typically 64).
1056 Default is the system default TTL.</dd>
1059 <dt><code>df_inherit</code></dt>
1060 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1061 from the inner IP headers (those of the encapsulated traffic)
1062 to the outer (tunnel) headers. Default is disabled; set to
1063 <code>true</code> to enable.</dd>
1066 <dt><code>df_default</code></dt>
1067 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1068 default on tunnel headers if the <code>df_inherit</code> option
1069 is not set, or if the encapsulated packet is not IP. Default
1070 is enabled; set to <code>false</code> to disable.</dd>
1073 <dt><code>pmtud</code></dt>
1074 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1075 ``ICMP Destination Unreachable - Fragmentation Needed''
1076 messages will be generated for IPv4 packets with the DF bit set
1077 and IPv6 packets above the minimum MTU if the packet size
1078 exceeds the path MTU minus the size of the tunnel headers.
1079 Note that this option causes behavior that is typically
1080 reserved for routers and therefore is not entirely in
1081 compliance with the IEEE 802.1D specification for bridges.
1082 Default is enabled; set to <code>false</code> to disable.</dd>
1085 <dt><code>header_cache</code></dt>
1086 <dd>Optional. Enable caching of tunnel headers and the output
1087 path. This can lead to a significant performance increase
1088 without changing behavior. In general it should not be
1089 necessary to adjust this setting. However, the caching can
1090 bypass certain components of the IP stack (such as IP tables)
1091 and it may be useful to disable it if these features are
1092 required or as a debugging measure. Default is enabled, set to
1093 <code>false</code> to disable.</dd>
1096 <dt><code>patch</code></dt>
1099 A pair of virtual devices that act as a patch cable. The <ref
1100 column="options"/> column must have the following key-value pair:
1103 <dt><code>peer</code></dt>
1105 The <ref column="name"/> of the <ref table="Interface"/> for
1106 the other side of the patch. The named <ref
1107 table="Interface"/>'s own <code>peer</code> option must specify
1108 this <ref table="Interface"/>'s name. That is, the two patch
1109 interfaces must have reversed <ref column="name"/> and
1110 <code>peer</code> values.
1114 <dt><code>null</code></dt>
1115 <dd>An ignored interface.</dd>
1119 <column name="options">
1120 Configuration options whose interpretation varies based on
1121 <ref column="type"/>.
1125 <group title="Interface Status">
1127 Status information about interfaces attached to bridges, updated every
1128 5 seconds. Not all interfaces have all of these properties; virtual
1129 interfaces don't have a link speed, for example. Non-applicable
1130 columns will have empty values.
1132 <column name="admin_state">
1134 The administrative state of the physical network link.
1138 <column name="link_state">
1140 The observed state of the physical network link. This is ordinarily
1141 the link's carrier status. If the interface's <ref table="Port"/> is
1142 a bond configured for miimon monitoring, it is instead the network
1143 link's miimon status.
1147 <column name="link_speed">
1149 The negotiated speed of the physical network link.
1150 Valid values are positive integers greater than 0.
1154 <column name="duplex">
1156 The duplex mode of the physical network link.
1162 The MTU (maximum transmission unit); i.e. the largest
1163 amount of data that can fit into a single Ethernet frame.
1164 The standard Ethernet MTU is 1500 bytes. Some physical media
1165 and many kinds of virtual interfaces can be configured with
1169 This column will be empty for an interface that does not
1170 have an MTU as, for example, some kinds of tunnels do not.
1174 <column name="status">
1176 Key-value pairs that report port status. Supported status values are
1177 <ref column="type"/>-dependent; some interfaces may not have a valid
1178 <ref column="status" key="driver_name"/>, for example.
1180 <p>The currently defined key-value pairs are:</p>
1182 <dt><code>driver_name</code></dt>
1183 <dd>The name of the device driver controlling the network
1187 <dt><code>driver_version</code></dt>
1188 <dd>The version string of the device driver controlling the
1189 network adapter.</dd>
1192 <dt><code>firmware_version</code></dt>
1193 <dd>The version string of the network adapter's firmware, if
1197 <dt><code>source_ip</code></dt>
1198 <dd>The source IP address used for an IPv4 tunnel end-point,
1199 such as <code>gre</code> or <code>capwap</code>.</dd>
1202 <dt><code>tunnel_egress_iface</code></dt>
1203 <dd>Egress interface for tunnels. Currently only relevant for GRE
1204 and CAPWAP tunnels. On Linux systems, this column will show
1205 the name of the interface which is responsible for routing
1206 traffic destined for the configured
1207 <ref column="options" key="remote_ip"/>. This could be an
1208 internal interface such as a bridge port.</dd>
1211 <dt><code>tunnel_egress_iface_carrier</code></dt>
1212 <dd>Whether a carrier is detected on
1213 <ref column="status" key="tunnel_egress_iface"/>. Valid values
1214 are <code>down</code> and <code>up</code>.</dd>
1219 <group title="Ingress Policing">
1221 These settings control ingress policing for packets received on this
1222 interface. On a physical interface, this limits the rate at which
1223 traffic is allowed into the system from the outside; on a virtual
1224 interface (one connected to a virtual machine), this limits the rate at
1225 which the VM is able to transmit.
1228 Policing is a simple form of quality-of-service that simply drops
1229 packets received in excess of the configured rate. Due to its
1230 simplicity, policing is usually less accurate and less effective than
1231 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1232 table="Queue"/> tables).
1235 Policing is currently implemented only on Linux. The Linux
1236 implementation uses a simple ``token bucket'' approach:
1240 The size of the bucket corresponds to <ref
1241 column="ingress_policing_burst"/>. Initially the bucket is full.
1244 Whenever a packet is received, its size (converted to tokens) is
1245 compared to the number of tokens currently in the bucket. If the
1246 required number of tokens are available, they are removed and the
1247 packet is forwarded. Otherwise, the packet is dropped.
1250 Whenever it is not full, the bucket is refilled with tokens at the
1251 rate specified by <ref column="ingress_policing_rate"/>.
1255 Policing interacts badly with some network protocols, and especially
1256 with fragmented IP packets. Suppose that there is enough network
1257 activity to keep the bucket nearly empty all the time. Then this token
1258 bucket algorithm will forward a single packet every so often, with the
1259 period depending on packet size and on the configured rate. All of the
1260 fragments of an IP packets are normally transmitted back-to-back, as a
1261 group. In such a situation, therefore, only one of these fragments
1262 will be forwarded and the rest will be dropped. IP does not provide
1263 any way for the intended recipient to ask for only the remaining
1264 fragments. In such a case there are two likely possibilities for what
1265 will happen next: either all of the fragments will eventually be
1266 retransmitted (as TCP will do), in which case the same problem will
1267 recur, or the sender will not realize that its packet has been dropped
1268 and data will simply be lost (as some UDP-based protocols will do).
1269 Either way, it is possible that no forward progress will ever occur.
1271 <column name="ingress_policing_rate">
1273 Maximum rate for data received on this interface, in kbps. Data
1274 received faster than this rate is dropped. Set to <code>0</code>
1275 (the default) to disable policing.
1279 <column name="ingress_policing_burst">
1280 <p>Maximum burst size for data received on this interface, in kb. The
1281 default burst size if set to <code>0</code> is 1000 kb. This value
1282 has no effect if <ref column="ingress_policing_rate"/>
1283 is <code>0</code>.</p>
1285 Specifying a larger burst size lets the algorithm be more forgiving,
1286 which is important for protocols like TCP that react severely to
1287 dropped packets. The burst size should be at least the size of the
1288 interface's MTU. Specifying a value that is numerically at least as
1289 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1290 closer to achieving the full rate.
1295 <group title="Connectivity Fault Management">
1297 802.1ag Connectivity Fault Management (CFM) allows a group of
1298 Maintenance Points (MPs) called a Maintenance Association (MA) to
1299 detect connectivity problems with each other. MPs within a MA should
1300 have complete and exclusive interconnectivity. This is verified by
1301 occasionally broadcasting Continuity Check Messages (CCMs) at a
1302 configurable transmission interval.
1305 <column name="cfm_mpid">
1306 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1307 a Maintenance Association. The MPID is used to identify this endpoint
1308 to other Maintenance Points in the MA. Each end of a link being
1309 monitored should have a different MPID. Must be configured to enable
1310 CFM on this <ref table="Interface"/>.
1313 <column name="cfm_remote_mpid">
1314 The MPID of the remote endpoint being monitored. If this
1315 <ref table="Interface"/> does not have connectivity to an endpoint
1316 advertising the configured MPID, a fault is signalled. Must be
1317 configured to enable CFM on this <ref table="Interface"/>
1320 <column name="cfm_fault">
1321 Indicates a connectivity fault triggered by an inability to receive
1322 heartbeats from the remote endpoint. When a fault is triggered on
1323 <ref table="Interface"/>s participating in bonds, they will be
1328 <group title="Other Features">
1330 <column name="lacp_current">
1331 Boolean value indicating LACP status for this interface. If true, this
1332 interface has current LACP information about its LACP partner. This
1333 information may be used to monitor the health of interfaces in a LACP
1334 enabled port. This column will be empty if LACP is not enabled.
1337 <column name="external_ids">
1338 Key-value pairs for use by external frameworks that integrate
1339 with Open vSwitch, rather than by Open vSwitch itself. System
1340 integrators should either use the Open vSwitch development
1341 mailing list to coordinate on common key-value definitions, or
1342 choose key names that are likely to be unique. The currently
1343 defined common key-value pairs are:
1345 <dt><code>attached-mac</code></dt>
1347 The MAC address programmed into the ``virtual hardware'' for this
1348 interface, in the form
1349 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1350 For Citrix XenServer, this is the value of the <code>MAC</code>
1351 field in the VIF record for this interface.</dd>
1352 <dt><code>iface-id</code></dt>
1353 <dd>A system-unique identifier for the interface. On XenServer,
1354 this will commonly be the same as
1355 <ref column="external_ids" key="xs-vif-uuid"/>.</dd>
1358 Additionally the following key-value pairs specifically
1359 apply to an interface that represents a virtual Ethernet interface
1360 connected to a virtual machine. These key-value pairs should not be
1361 present for other types of interfaces. Keys whose names end
1362 in <code>-uuid</code> have values that uniquely identify the entity
1363 in question. For a Citrix XenServer hypervisor, these values are
1364 UUIDs in RFC 4122 format. Other hypervisors may use other
1367 <p>The currently defined key-value pairs for XenServer are:</p>
1369 <dt><code>xs-vif-uuid</code></dt>
1370 <dd>The virtual interface associated with this interface.</dd>
1371 <dt><code>xs-network-uuid</code></dt>
1372 <dd>The virtual network to which this interface is attached.</dd>
1373 <dt><code>xs-vm-uuid</code></dt>
1374 <dd>The VM to which this interface belongs.</dd>
1378 <column name="other_config">
1379 Key-value pairs for rarely used interface features.
1381 <dt><code>cfm_interval</code></dt>
1382 <dd> The transmission interval of CFM heartbeats in milliseconds.
1383 Three missed heartbeat receptions indicate a connectivity fault.
1384 Defaults to 1000ms. </dd>
1385 <dt><code>bond-stable-id</code></dt>
1386 <dd> A positive integer using in <code>stable</code> bond mode to
1387 make slave selection decisions. Allocating
1388 <ref column="other_config" key="bond-stable-id"/> values
1389 consistently across interfaces participating in a bond will
1390 guarantee consistent slave selection decisions across
1391 <code>ovs-vswitchd</code> instances when using <code>stable</code>
1393 <dt><code>lacp-port-id</code></dt>
1394 <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are
1395 used in LACP negotiations to identify individual ports
1396 participating in a bond. Must be a number between 1 and
1398 <dt><code>lacp-port-priority</code></dt>
1399 <dd> The LACP port priority of this <ref table="Interface"/>. In
1400 LACP negotiations <ref table="Interface"/>s with numerically lower
1401 priorities are preferred for aggregation. Must be a number between
1403 <dt><code>lacp-aggregation-key</code></dt>
1404 <dd> The LACP aggregation key of this <ref table="Interface"/>.
1405 <ref table="Interface"/>s with different aggregation keys may not
1406 be active within a given <ref table="Port"/> at the same time. Must
1407 be a number between 1 and 65535.</dd>
1411 <column name="statistics">
1413 Key-value pairs that report interface statistics. The current
1414 implementation updates these counters periodically. In the future,
1415 we plan to, instead, update them when an interface is created, when
1416 they are queried (e.g. using an OVSDB <code>select</code> operation),
1417 and just before an interface is deleted due to virtual interface
1418 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1419 regular periodic basis.</p>
1421 The currently defined key-value pairs are listed below. These are
1422 the same statistics reported by OpenFlow in its <code>struct
1423 ofp_port_stats</code> structure. If an interface does not support a
1424 given statistic, then that pair is omitted.</p>
1427 Successful transmit and receive counters:
1429 <dt><code>rx_packets</code></dt>
1430 <dd>Number of received packets.</dd>
1431 <dt><code>rx_bytes</code></dt>
1432 <dd>Number of received bytes.</dd>
1433 <dt><code>tx_packets</code></dt>
1434 <dd>Number of transmitted packets.</dd>
1435 <dt><code>tx_bytes</code></dt>
1436 <dd>Number of transmitted bytes.</dd>
1442 <dt><code>rx_dropped</code></dt>
1443 <dd>Number of packets dropped by RX.</dd>
1444 <dt><code>rx_frame_err</code></dt>
1445 <dd>Number of frame alignment errors.</dd>
1446 <dt><code>rx_over_err</code></dt>
1447 <dd>Number of packets with RX overrun.</dd>
1448 <dt><code>rx_crc_err</code></dt>
1449 <dd>Number of CRC errors.</dd>
1450 <dt><code>rx_errors</code></dt>
1452 Total number of receive errors, greater than or equal
1453 to the sum of the above.
1460 <dt><code>tx_dropped</code></dt>
1461 <dd>Number of packets dropped by TX.</dd>
1462 <dt><code>collisions</code></dt>
1463 <dd>Number of collisions.</dd>
1464 <dt><code>tx_errors</code></dt>
1466 Total number of transmit errors, greater
1467 than or equal to the sum of the above.
1476 <table name="QoS" title="Quality of Service configuration">
1477 <p>Quality of Service (QoS) configuration for each Port that
1480 <column name="type">
1481 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1482 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1483 identifies the types that a switch actually supports. The currently
1484 defined types are listed below:</p>
1486 <dt><code>linux-htb</code></dt>
1488 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1489 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1490 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1491 for information on how this classifier works and how to configure it.
1495 <dt><code>linux-hfsc</code></dt>
1497 Linux "Hierarchical Fair Service Curve" classifier.
1498 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1499 information on how this classifier works.
1504 <column name="queues">
1505 <p>A map from queue numbers to <ref table="Queue"/> records. The
1506 supported range of queue numbers depend on <ref column="type"/>. The
1507 queue numbers are the same as the <code>queue_id</code> used in
1508 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1509 structures. Queue 0 is used by OpenFlow output actions that do not
1510 specify a specific queue.</p>
1513 <column name="other_config">
1514 <p>Key-value pairs for configuring QoS features that depend on
1515 <ref column="type"/>.</p>
1516 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1517 the following key-value pairs:</p>
1519 <dt><code>max-rate</code></dt>
1520 <dd>Maximum rate shared by all queued traffic, in bit/s.
1521 Optional. If not specified, for physical interfaces, the
1522 default is the link rate. For other interfaces or if the
1523 link rate cannot be determined, the default is currently 100
1528 <column name="external_ids">
1529 Key-value pairs for use by external frameworks that integrate with Open
1530 vSwitch, rather than by Open vSwitch itself. System integrators should
1531 either use the Open vSwitch development mailing list to coordinate on
1532 common key-value definitions, or choose key names that are likely to be
1533 unique. No common key-value pairs are currently defined.
1537 <table name="Queue" title="QoS output queue.">
1538 <p>A configuration for a port output queue, used in configuring Quality of
1539 Service (QoS) features. May be referenced by <ref column="queues"
1540 table="QoS"/> column in <ref table="QoS"/> table.</p>
1542 <column name="other_config">
1543 <p>Key-value pairs for configuring the output queue. The supported
1544 key-value pairs and their meanings depend on the <ref column="type"/>
1545 of the <ref column="QoS"/> records that reference this row.</p>
1546 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1547 column="type"/> of <code>min-rate</code> are:</p>
1549 <dt><code>min-rate</code></dt>
1550 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1551 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1553 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1554 column="type"/> of <code>linux-htb</code> are:</p>
1556 <dt><code>min-rate</code></dt>
1557 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1558 <dt><code>max-rate</code></dt>
1559 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1560 queue's rate will not be allowed to exceed the specified value, even
1561 if excess bandwidth is available. If unspecified, defaults to no
1563 <dt><code>burst</code></dt>
1564 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1565 that a queue can accumulate while it is idle. Optional. Details of
1566 the <code>linux-htb</code> implementation require a minimum burst
1567 size, so a too-small <code>burst</code> will be silently
1569 <dt><code>priority</code></dt>
1570 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1571 unspecified. A queue with a smaller <code>priority</code>
1572 will receive all the excess bandwidth that it can use before
1573 a queue with a larger value receives any. Specific priority
1574 values are unimportant; only relative ordering matters.</dd>
1576 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1577 column="type"/> of <code>linux-hfsc</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
1589 <column name="external_ids">
1590 Key-value pairs for use by external frameworks that integrate with Open
1591 vSwitch, rather than by Open vSwitch itself. System integrators should
1592 either use the Open vSwitch development mailing list to coordinate on
1593 common key-value definitions, or choose key names that are likely to be
1594 unique. No common key-value pairs are currently defined.
1598 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1599 <p>A port mirror within a <ref table="Bridge"/>.</p>
1600 <p>A port mirror configures a bridge to send selected frames to special
1601 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1602 traffic may also be referred to as SPAN or RSPAN, depending on the
1603 mechanism used for delivery.</p>
1605 <column name="name">
1606 Arbitrary identifier for the <ref table="Mirror"/>.
1609 <group title="Selecting Packets for Mirroring">
1611 To be selected for mirroring, a given packet must enter or leave the
1612 bridge through a selected port and it must also be in one of the
1616 <column name="select_all">
1617 If true, every packet arriving or departing on any port is
1618 selected for mirroring.
1621 <column name="select_dst_port">
1622 Ports on which departing packets are selected for mirroring.
1625 <column name="select_src_port">
1626 Ports on which arriving packets are selected for mirroring.
1629 <column name="select_vlan">
1630 VLANs on which packets are selected for mirroring. An empty set
1631 selects packets on all VLANs.
1635 <group title="Mirroring Destination Configuration">
1637 These columns are mutually exclusive. Exactly one of them must be
1641 <column name="output_port">
1642 <p>Output port for selected packets, if nonempty.</p>
1643 <p>Specifying a port for mirror output reserves that port exclusively
1644 for mirroring. No frames other than those selected for mirroring
1645 will be forwarded to the port, and any frames received on the port
1646 will be discarded.</p>
1647 <p>This type of mirroring is sometimes called SPAN.</p>
1650 <column name="output_vlan">
1651 <p>Output VLAN for selected packets, if nonempty.</p>
1652 <p>The frames will be sent out all ports that trunk
1653 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1654 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1655 trunk port, the frame's VLAN tag will be set to
1656 <ref column="output_vlan"/>, replacing any existing tag; when it is
1657 sent out an implicit VLAN port, the frame will not be tagged. This
1658 type of mirroring is sometimes called RSPAN.</p>
1659 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1660 contains unmanaged switches. Consider an unmanaged physical switch
1661 with two ports: port 1, connected to an end host, and port 2,
1662 connected to an Open vSwitch configured to mirror received packets
1663 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1664 port 1 that the physical switch forwards to port 2. The Open vSwitch
1665 forwards this packet to its destination and then reflects it back on
1666 port 2 in VLAN 123. This reflected packet causes the unmanaged
1667 physical switch to replace the MAC learning table entry, which
1668 correctly pointed to port 1, with one that incorrectly points to port
1669 2. Afterward, the physical switch will direct packets destined for
1670 the end host to the Open vSwitch on port 2, instead of to the end
1671 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1672 desired in this scenario, then the physical switch must be replaced
1673 by one that learns Ethernet addresses on a per-VLAN basis. In
1674 addition, learning should be disabled on the VLAN containing mirrored
1675 traffic. If this is not done then intermediate switches will learn
1676 the MAC address of each end host from the mirrored traffic. If
1677 packets being sent to that end host are also mirrored, then they will
1678 be dropped since the switch will attempt to send them out the input
1679 port. Disabling learning for the VLAN will cause the switch to
1680 correctly send the packet out all ports configured for that VLAN. If
1681 Open vSwitch is being used as an intermediate switch, learning can be
1682 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1683 in the appropriate <ref table="Bridge"/> table or tables.</p>
1687 <group title="Other Features">
1688 <column name="external_ids">
1689 Key-value pairs for use by external frameworks that integrate with Open
1690 vSwitch, rather than by Open vSwitch itself. System integrators should
1691 either use the Open vSwitch development mailing list to coordinate on
1692 common key-value definitions, or choose key names that are likely to be
1693 unique. No common key-value pairs are currently defined.
1698 <table name="Controller" title="OpenFlow controller configuration.">
1699 <p>An OpenFlow controller.</p>
1702 Open vSwitch supports two kinds of OpenFlow controllers:
1706 <dt>Primary controllers</dt>
1709 This is the kind of controller envisioned by the OpenFlow 1.0
1710 specification. Usually, a primary controller implements a network
1711 policy by taking charge of the switch's flow table.
1715 Open vSwitch initiates and maintains persistent connections to
1716 primary controllers, retrying the connection each time it fails or
1717 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1718 <ref table="Bridge"/> table applies to primary controllers.
1722 Open vSwitch permits a bridge to have any number of primary
1723 controllers. When multiple controllers are configured, Open
1724 vSwitch connects to all of them simultaneously. Because
1725 OpenFlow 1.0 does not specify how multiple controllers
1726 coordinate in interacting with a single switch, more than
1727 one primary controller should be specified only if the
1728 controllers are themselves designed to coordinate with each
1729 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1730 vendor extension may be useful for this.)
1733 <dt>Service controllers</dt>
1736 These kinds of OpenFlow controller connections are intended for
1737 occasional support and maintenance use, e.g. with
1738 <code>ovs-ofctl</code>. Usually a service controller connects only
1739 briefly to inspect or modify some of a switch's state.
1743 Open vSwitch listens for incoming connections from service
1744 controllers. The service controllers initiate and, if necessary,
1745 maintain the connections from their end. The <ref table="Bridge"
1746 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1747 not apply to service controllers.
1751 Open vSwitch supports configuring any number of service controllers.
1757 The <ref column="target"/> determines the type of controller.
1760 <group title="Core Features">
1761 <column name="target">
1762 <p>Connection method for controller.</p>
1764 The following connection methods are currently supported for primary
1768 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1770 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1771 the given <var>ip</var>, which must be expressed as an IP address
1772 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1773 column in the <ref table="Open_vSwitch"/> table must point to a
1774 valid SSL configuration when this form is used.</p>
1775 <p>SSL support is an optional feature that is not always built as
1776 part of Open vSwitch.</p>
1778 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1779 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1780 the given <var>ip</var>, which must be expressed as an IP address
1781 (not a DNS name).</dd>
1784 The following connection methods are currently supported for service
1788 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1791 Listens for SSL connections on the specified TCP <var>port</var>
1792 (default: 6633). If <var>ip</var>, which must be expressed as an
1793 IP address (not a DNS name), is specified, then connections are
1794 restricted to the specified local IP address.
1797 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1798 table="Open_vSwitch"/> table must point to a valid SSL
1799 configuration when this form is used.
1801 <p>SSL support is an optional feature that is not always built as
1802 part of Open vSwitch.</p>
1804 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1806 Listens for connections on the specified TCP <var>port</var>
1807 (default: 6633). If <var>ip</var>, which must be expressed as an
1808 IP address (not a DNS name), is specified, then connections are
1809 restricted to the specified local IP address.
1812 <p>When multiple controllers are configured for a single bridge, the
1813 <ref column="target"/> values must be unique. Duplicate
1814 <ref column="target"/> values yield unspecified results.</p>
1817 <column name="connection_mode">
1818 <p>If it is specified, this setting must be one of the following
1819 strings that describes how Open vSwitch contacts this OpenFlow
1820 controller over the network:</p>
1823 <dt><code>in-band</code></dt>
1824 <dd>In this mode, this controller's OpenFlow traffic travels over the
1825 bridge associated with the controller. With this setting, Open
1826 vSwitch allows traffic to and from the controller regardless of the
1827 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1828 would never be able to connect to the controller, because it did
1829 not have a flow to enable it.) This is the most common connection
1830 mode because it is not necessary to maintain two independent
1832 <dt><code>out-of-band</code></dt>
1833 <dd>In this mode, OpenFlow traffic uses a control network separate
1834 from the bridge associated with this controller, that is, the
1835 bridge does not use any of its own network devices to communicate
1836 with the controller. The control network must be configured
1837 separately, before or after <code>ovs-vswitchd</code> is started.
1841 <p>If not specified, the default is implementation-specific.</p>
1845 <group title="Controller Failure Detection and Handling">
1846 <column name="max_backoff">
1847 Maximum number of milliseconds to wait between connection attempts.
1848 Default is implementation-specific.
1851 <column name="inactivity_probe">
1852 Maximum number of milliseconds of idle time on connection to
1853 controller before sending an inactivity probe message. If Open
1854 vSwitch does not communicate with the controller for the specified
1855 number of seconds, it will send a probe. If a response is not
1856 received for the same additional amount of time, Open vSwitch
1857 assumes the connection has been broken and attempts to reconnect.
1858 Default is implementation-specific. A value of 0 disables
1863 <group title="OpenFlow Rate Limiting">
1864 <column name="controller_rate_limit">
1865 <p>The maximum rate at which packets in unknown flows will be
1866 forwarded to the OpenFlow controller, in packets per second. This
1867 feature prevents a single bridge from overwhelming the controller.
1868 If not specified, the default is implementation-specific.</p>
1869 <p>In addition, when a high rate triggers rate-limiting, Open
1870 vSwitch queues controller packets for each port and transmits
1871 them to the controller at the configured rate. The number of
1872 queued packets is limited by
1873 the <ref column="controller_burst_limit"/> value. The packet
1874 queue is shared fairly among the ports on a bridge.</p><p>Open
1875 vSwitch maintains two such packet rate-limiters per bridge.
1876 One of these applies to packets sent up to the controller
1877 because they do not correspond to any flow. The other applies
1878 to packets sent up to the controller by request through flow
1879 actions. When both rate-limiters are filled with packets, the
1880 actual rate that packets are sent to the controller is up to
1881 twice the specified rate.</p>
1884 <column name="controller_burst_limit">
1885 In conjunction with <ref column="controller_rate_limit"/>,
1886 the maximum number of unused packet credits that the bridge will
1887 allow to accumulate, in packets. If not specified, the default
1888 is implementation-specific.
1892 <group title="Additional In-Band Configuration">
1893 <p>These values are considered only in in-band control mode (see
1894 <ref column="connection_mode"/>).</p>
1896 <p>When multiple controllers are configured on a single bridge, there
1897 should be only one set of unique values in these columns. If different
1898 values are set for these columns in different controllers, the effect
1901 <column name="local_ip">
1902 The IP address to configure on the local port,
1903 e.g. <code>192.168.0.123</code>. If this value is unset, then
1904 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1908 <column name="local_netmask">
1909 The IP netmask to configure on the local port,
1910 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1911 but this value is unset, then the default is chosen based on whether
1912 the IP address is class A, B, or C.
1915 <column name="local_gateway">
1916 The IP address of the gateway to configure on the local port, as a
1917 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1918 this network has no gateway.
1922 <group title="Other Features">
1923 <column name="external_ids">
1924 Key-value pairs for use by external frameworks that integrate with Open
1925 vSwitch, rather than by Open vSwitch itself. System integrators should
1926 either use the Open vSwitch development mailing list to coordinate on
1927 common key-value definitions, or choose key names that are likely to be
1928 unique. No common key-value pairs are currently defined.
1932 <group title="Controller Status">
1933 <column name="is_connected">
1934 <code>true</code> if currently connected to this controller,
1935 <code>false</code> otherwise.
1938 <column name="role">
1939 <p>The level of authority this controller has on the associated
1940 bridge. Possible values are:</p>
1942 <dt><code>other</code></dt>
1943 <dd>Allows the controller access to all OpenFlow features.</dd>
1944 <dt><code>master</code></dt>
1945 <dd>Equivalent to <code>other</code>, except that there may be at
1946 most one master controller at a time. When a controller configures
1947 itself as <code>master</code>, any existing master is demoted to
1948 the <code>slave</code>role.</dd>
1949 <dt><code>slave</code></dt>
1950 <dd>Allows the controller read-only access to OpenFlow features.
1951 Attempts to modify the flow table will be rejected with an
1952 error. Slave controllers do not receive OFPT_PACKET_IN or
1953 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1958 <column name="status">
1959 <p>Key-value pairs that report controller status.</p>
1961 <dt><code>last_error</code></dt>
1962 <dd>A human-readable description of the last error on the connection
1963 to the controller; i.e. <code>strerror(errno)</code>. This key
1964 will exist only if an error has occurred.</dd>
1965 <dt><code>state</code></dt>
1966 <dd>The state of the connection to the controller. Possible values
1967 are: <code>VOID</code> (connection is disabled),
1968 <code>BACKOFF</code> (attempting to reconnect at an increasing
1969 period), <code>CONNECTING</code> (attempting to connect),
1970 <code>ACTIVE</code> (connected, remote host responsive), and
1971 <code>IDLE</code> (remote host idle, sending keep-alive). These
1972 values may change in the future. They are provided only for human
1974 <dt><code>sec_since_connect</code></dt>
1975 <dd>The amount of time since this controller last successfully
1976 connected to the switch (in seconds). Value is empty if controller
1977 has never successfully connected.</dd>
1978 <dt><code>sec_since_disconnect</code></dt>
1979 <dd>The amount of time since this controller last disconnected from
1980 the switch (in seconds). Value is empty if controller has never
1987 <table name="Manager" title="OVSDB management connection.">
1989 Configuration for a database connection to an Open vSwitch database
1994 This table primarily configures the Open vSwitch database
1995 (<code>ovsdb-server</code>), not the Open vSwitch switch
1996 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1997 what connections should be treated as in-band.
2001 The Open vSwitch database server can initiate and maintain active
2002 connections to remote clients. It can also listen for database
2006 <group title="Core Features">
2007 <column name="target">
2008 <p>Connection method for managers.</p>
2010 The following connection methods are currently supported:
2013 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2016 The specified SSL <var>port</var> (default: 6632) on the host at
2017 the given <var>ip</var>, which must be expressed as an IP address
2018 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2019 column in the <ref table="Open_vSwitch"/> table must point to a
2020 valid SSL configuration when this form is used.
2023 SSL support is an optional feature that is not always built as
2024 part of Open vSwitch.
2028 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2030 The specified TCP <var>port</var> (default: 6632) on the host at
2031 the given <var>ip</var>, which must be expressed as an IP address
2034 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2037 Listens for SSL connections on the specified TCP <var>port</var>
2038 (default: 6632). If <var>ip</var>, which must be expressed as an
2039 IP address (not a DNS name), is specified, then connections are
2040 restricted to the specified local IP address.
2043 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2044 table="Open_vSwitch"/> table must point to a valid SSL
2045 configuration when this form is used.
2048 SSL support is an optional feature that is not always built as
2049 part of Open vSwitch.
2052 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2054 Listens for connections on the specified TCP <var>port</var>
2055 (default: 6632). If <var>ip</var>, which must be expressed as an
2056 IP address (not a DNS name), is specified, then connections are
2057 restricted to the specified local IP address.
2060 <p>When multiple managers are configured, the <ref column="target"/>
2061 values must be unique. Duplicate <ref column="target"/> values yield
2062 unspecified results.</p>
2065 <column name="connection_mode">
2067 If it is specified, this setting must be one of the following strings
2068 that describes how Open vSwitch contacts this OVSDB client over the
2073 <dt><code>in-band</code></dt>
2075 In this mode, this connection's traffic travels over a bridge
2076 managed by Open vSwitch. With this setting, Open vSwitch allows
2077 traffic to and from the client regardless of the contents of the
2078 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2079 to connect to the client, because it did not have a flow to enable
2080 it.) This is the most common connection mode because it is not
2081 necessary to maintain two independent networks.
2083 <dt><code>out-of-band</code></dt>
2085 In this mode, the client's traffic uses a control network separate
2086 from that managed by Open vSwitch, that is, Open vSwitch does not
2087 use any of its own network devices to communicate with the client.
2088 The control network must be configured separately, before or after
2089 <code>ovs-vswitchd</code> is started.
2094 If not specified, the default is implementation-specific.
2099 <group title="Client Failure Detection and Handling">
2100 <column name="max_backoff">
2101 Maximum number of milliseconds to wait between connection attempts.
2102 Default is implementation-specific.
2105 <column name="inactivity_probe">
2106 Maximum number of milliseconds of idle time on connection to the client
2107 before sending an inactivity probe message. If Open vSwitch does not
2108 communicate with the client for the specified number of seconds, it
2109 will send a probe. If a response is not received for the same
2110 additional amount of time, Open vSwitch assumes the connection has been
2111 broken and attempts to reconnect. Default is implementation-specific.
2112 A value of 0 disables inactivity probes.
2116 <group title="Other Features">
2117 <column name="external_ids">
2118 Key-value pairs for use by external frameworks that integrate with Open
2119 vSwitch, rather than by Open vSwitch itself. System integrators should
2120 either use the Open vSwitch development mailing list to coordinate on
2121 common key-value definitions, or choose key names that are likely to be
2122 unique. No common key-value pairs are currently defined.
2126 <group title="Status">
2127 <column name="is_connected">
2128 <code>true</code> if currently connected to this manager,
2129 <code>false</code> otherwise.
2132 <column name="status">
2133 <p>Key-value pairs that report manager status.</p>
2135 <dt><code>last_error</code></dt>
2136 <dd>A human-readable description of the last error on the connection
2137 to the manager; i.e. <code>strerror(errno)</code>. This key
2138 will exist only if an error has occurred.</dd>
2141 <dt><code>state</code></dt>
2142 <dd>The state of the connection to the manager. Possible values
2143 are: <code>VOID</code> (connection is disabled),
2144 <code>BACKOFF</code> (attempting to reconnect at an increasing
2145 period), <code>CONNECTING</code> (attempting to connect),
2146 <code>ACTIVE</code> (connected, remote host responsive), and
2147 <code>IDLE</code> (remote host idle, sending keep-alive). These
2148 values may change in the future. They are provided only for human
2152 <dt><code>sec_since_connect</code></dt>
2153 <dd>The amount of time since this manager last successfully connected
2154 to the database (in seconds). Value is empty if manager has never
2155 successfully connected.</dd>
2158 <dt><code>sec_since_disconnect</code></dt>
2159 <dd>The amount of time since this manager last disconnected from the
2160 database (in seconds). Value is empty if manager has never
2167 <table name="NetFlow">
2168 A NetFlow target. NetFlow is a protocol that exports a number of
2169 details about terminating IP flows, such as the principals involved
2172 <column name="targets">
2173 NetFlow targets in the form
2174 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2175 must be specified numerically, not as a DNS name.
2178 <column name="engine_id">
2179 Engine ID to use in NetFlow messages. Defaults to datapath index
2183 <column name="engine_type">
2184 Engine type to use in NetFlow messages. Defaults to datapath
2185 index if not specified.
2188 <column name="active_timeout">
2189 The interval at which NetFlow records are sent for flows that are
2190 still active, in seconds. A value of <code>0</code> requests the
2191 default timeout (currently 600 seconds); a value of <code>-1</code>
2192 disables active timeouts.
2195 <column name="add_id_to_interface">
2196 <p>If this column's value is <code>false</code>, the ingress and egress
2197 interface fields of NetFlow flow records are derived from OpenFlow port
2198 numbers. When it is <code>true</code>, the 7 most significant bits of
2199 these fields will be replaced by the least significant 7 bits of the
2200 engine id. This is useful because many NetFlow collectors do not
2201 expect multiple switches to be sending messages from the same host, so
2202 they do not store the engine information which could be used to
2203 disambiguate the traffic.</p>
2204 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2207 <column name="external_ids">
2208 Key-value pairs for use by external frameworks that integrate with Open
2209 vSwitch, rather than by Open vSwitch itself. System integrators should
2210 either use the Open vSwitch development mailing list to coordinate on
2211 common key-value definitions, or choose key names that are likely to be
2212 unique. No common key-value pairs are currently defined.
2217 SSL configuration for an Open_vSwitch.
2219 <column name="private_key">
2220 Name of a PEM file containing the private key used as the switch's
2221 identity for SSL connections to the controller.
2224 <column name="certificate">
2225 Name of a PEM file containing a certificate, signed by the
2226 certificate authority (CA) used by the controller and manager,
2227 that certifies the switch's private key, identifying a trustworthy
2231 <column name="ca_cert">
2232 Name of a PEM file containing the CA certificate used to verify
2233 that the switch is connected to a trustworthy controller.
2236 <column name="bootstrap_ca_cert">
2237 If set to <code>true</code>, then Open vSwitch will attempt to
2238 obtain the CA certificate from the controller on its first SSL
2239 connection and save it to the named PEM file. If it is successful,
2240 it will immediately drop the connection and reconnect, and from then
2241 on all SSL connections must be authenticated by a certificate signed
2242 by the CA certificate thus obtained. <em>This option exposes the
2243 SSL connection to a man-in-the-middle attack obtaining the initial
2244 CA certificate.</em> It may still be useful for bootstrapping.
2247 <column name="external_ids">
2248 Key-value pairs for use by external frameworks that integrate with Open
2249 vSwitch, rather than by Open vSwitch itself. System integrators should
2250 either use the Open vSwitch development mailing list to coordinate on
2251 common key-value definitions, or choose key names that are likely to be
2252 unique. No common key-value pairs are currently defined.
2256 <table name="sFlow">
2257 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2260 <column name="agent">
2261 Name of the network device whose IP address should be reported as the
2262 ``agent address'' to collectors. If not specified, the IP address
2263 defaults to the <ref table="Controller" column="local_ip"/> in the
2264 collector's <ref table="Controller"/>. If an agent IP address cannot be
2265 determined either way, sFlow is disabled.
2268 <column name="header">
2269 Number of bytes of a sampled packet to send to the collector.
2270 If not specified, the default is 128 bytes.
2273 <column name="polling">
2274 Polling rate in seconds to send port statistics to the collector.
2275 If not specified, defaults to 30 seconds.
2278 <column name="sampling">
2279 Rate at which packets should be sampled and sent to the collector.
2280 If not specified, defaults to 400, which means one out of 400
2281 packets, on average, will be sent to the collector.
2284 <column name="targets">
2285 sFlow targets in the form
2286 <code><var>ip</var>:<var>port</var></code>.
2289 <column name="external_ids">
2290 Key-value pairs for use by external frameworks that integrate with Open
2291 vSwitch, rather than by Open vSwitch itself. System integrators should
2292 either use the Open vSwitch development mailing list to coordinate on
2293 common key-value definitions, or choose key names that are likely to be
2294 unique. No common key-value pairs are currently defined.
2298 <table name="Capability">
2299 <p>Records in this table describe functionality supported by the hardware
2300 and software platform on which this Open vSwitch is based. Clients
2301 should not modify this table.</p>
2303 <p>A record in this table is meaningful only if it is referenced by the
2304 <ref table="Open_vSwitch" column="capabilities"/> column in the
2305 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2306 the record's ``category,'' determines the meanings of the
2307 <ref column="details"/> column. The following general forms of
2308 categories are currently defined:</p>
2311 <dt><code>qos-<var>type</var></code></dt>
2312 <dd><var>type</var> is supported as the value for
2313 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2317 <column name="details">
2318 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2319 depends on the category key that the <ref table="Open_vSwitch"
2320 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2321 uses to reference this record, as described above.</p>
2323 <p>The presence of a record for category <code>qos-<var>type</var></code>
2324 indicates that the switch supports <var>type</var> as the value of
2325 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2326 table. The following key-value pairs are defined to further describe
2327 QoS capabilities:</p>
2330 <dt><code>n-queues</code></dt>
2331 <dd>Number of supported queues, as a positive integer. Keys in the
2332 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2333 records whose <ref table="QoS" column="type"/> value
2334 equals <var>type</var> must range between 0 and this value minus one,
projects / openvswitch / blob