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
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <column name="capabilities">
91 Describes functionality supported by the hardware and software platform
92 on which this Open vSwitch is based. Clients should not modify this
93 column. See the <ref table="Capability"/> description for defined
94 capability categories and the meaning of associated
95 <ref table="Capability"/> records.
98 <group title="Statistics">
100 The <code>statistics</code> column contains key-value pairs that
101 report statistics about a system running an Open vSwitch. These are
102 updated periodically (currently, every 5 seconds). Key-value pairs
103 that cannot be determined or that do not apply to a platform are
107 <column name="other_config" key="enable-statistics"
108 type='{"type": "boolean"}'>
109 Statistics are disabled by default to avoid overhead in the common
110 case when statistics gathering is not useful. Set this value to
111 <code>true</code> to enable populating the <ref column="statistics"/>
112 column or to <code>false</code> to explicitly disable it.
115 <column name="statistics" key="cpu"
116 type='{"type": "integer", "minInteger": 1}'>
118 Number of CPU processors, threads, or cores currently online and
119 available to the operating system on which Open vSwitch is running,
120 as an integer. This may be less than the number installed, if some
121 are not online or if they are not available to the operating
125 Open vSwitch userspace processes are not multithreaded, but the
126 Linux kernel-based datapath is.
130 <column name="statistics" key="load_average">
131 A comma-separated list of three floating-point numbers,
132 representing the system load average over the last 1, 5, and 15
133 minutes, respectively.
136 <column name="statistics" key="memory">
138 A comma-separated list of integers, each of which represents a
139 quantity of memory in kilobytes that describes the operating
140 system on which Open vSwitch is running. In respective order,
145 <li>Total amount of RAM allocated to the OS.</li>
146 <li>RAM allocated to the OS that is in use.</li>
147 <li>RAM that can be flushed out to disk or otherwise discarded
148 if that space is needed for another purpose. This number is
149 necessarily less than or equal to the previous value.</li>
150 <li>Total disk space allocated for swap.</li>
151 <li>Swap space currently in use.</li>
155 On Linux, all five values can be determined and are included. On
156 other operating systems, only the first two values can be
157 determined, so the list will only have two values.
161 <column name="statistics" key="process_NAME">
163 One such key-value pair, with <code>NAME</code> replaced by
164 a process name, will exist for each running Open vSwitch
165 daemon process, with <var>name</var> replaced by the
166 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
167 value is a comma-separated list of integers. The integers
168 represent the following, with memory measured in kilobytes
169 and durations in milliseconds:
173 <li>The process's virtual memory size.</li>
174 <li>The process's resident set size.</li>
175 <li>The amount of user and system CPU time consumed by the
177 <li>The number of times that the process has crashed and been
178 automatically restarted by the monitor.</li>
179 <li>The duration since the process was started.</li>
180 <li>The duration for which the process has been running.</li>
184 The interpretation of some of these values depends on whether the
185 process was started with the <option>--monitor</option>. If it
186 was not, then the crash count will always be 0 and the two
187 durations will always be the same. If <option>--monitor</option>
188 was given, then the crash count may be positive; if it is, the
189 latter duration is the amount of time since the most recent crash
194 There will be one key-value pair for each file in Open vSwitch's
195 ``run directory'' (usually <code>/var/run/openvswitch</code>)
196 whose name ends in <code>.pid</code>, whose contents are a
197 process ID, and which is locked by a running process. The
198 <var>name</var> is taken from the pidfile's name.
202 Currently Open vSwitch is only able to obtain all of the above
203 detail on Linux systems. On other systems, the same key-value
204 pairs will be present but the values will always be the empty
209 <column name="statistics" key="file_systems">
211 A space-separated list of information on local, writable file
212 systems. Each item in the list describes one file system and
213 consists in turn of a comma-separated list of the following:
217 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
218 Any spaces or commas in the mount point are replaced by
220 <li>Total size, in kilobytes, as an integer.</li>
221 <li>Amount of storage in use, in kilobytes, as an integer.</li>
225 This key-value pair is omitted if there are no local, writable
226 file systems or if Open vSwitch cannot obtain the needed
233 <group title="Version Reporting">
235 These columns report the types and versions of the hardware and
236 software running Open vSwitch. We recommend in general that software
237 should test whether specific features are supported instead of relying
238 on version number checks. These values are primarily intended for
239 reporting to human administrators.
242 <column name="ovs_version">
243 The Open vSwitch version number, e.g. <code>1.1.0</code>.
244 If Open vSwitch was configured with a build number, then it is
245 also included, e.g. <code>1.1.0+build6579</code>.
248 <column name="db_version">
250 The database schema version number in the form
251 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
252 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
253 a non-backward compatible way (e.g. deleting a column or a table),
254 <var>major</var> is incremented. When the database schema is changed
255 in a backward compatible way (e.g. adding a new column),
256 <var>minor</var> is incremented. When the database schema is changed
257 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
262 The schema version is part of the database schema, so it can also be
263 retrieved by fetching the schema using the Open vSwitch database
268 <column name="system_type">
270 An identifier for the type of system on top of which Open vSwitch
271 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
274 System integrators are responsible for choosing and setting an
275 appropriate value for this column.
279 <column name="system_version">
281 The version of the system identified by <ref column="system_type"/>,
282 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
285 System integrators are responsible for choosing and setting an
286 appropriate value for this column.
292 <group title="Database Configuration">
294 These columns primarily configure the Open vSwitch database
295 (<code>ovsdb-server</code>), not the Open vSwitch switch
296 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
297 column="ssl"/> settings.
301 The Open vSwitch switch does read the database configuration to
302 determine remote IP addresses to which in-band control should apply.
305 <column name="manager_options">
306 Database clients to which the Open vSwitch database server should
307 connect or to which it should listen, along with options for how these
308 connection should be configured. See the <ref table="Manager"/> table
309 for more information.
313 <group title="Common Columns">
314 The overall purpose of these columns is described under <code>Common
315 Columns</code> at the beginning of this document.
317 <column name="other_config"/>
318 <column name="external_ids"/>
322 <table name="Bridge">
324 Configuration for a bridge within an
325 <ref table="Open_vSwitch"/>.
328 A <ref table="Bridge"/> record represents an Ethernet switch with one or
329 more ``ports,'' which are the <ref table="Port"/> records pointed to by
330 the <ref table="Bridge"/>'s <ref column="ports"/> column.
333 <group title="Core Features">
335 Bridge identifier. Should be alphanumeric and no more than about 8
336 bytes long. Must be unique among the names of ports, interfaces, and
340 <column name="ports">
341 Ports included in the bridge.
344 <column name="mirrors">
345 Port mirroring configuration.
348 <column name="netflow">
349 NetFlow configuration.
352 <column name="sflow">
356 <column name="flood_vlans">
358 VLAN IDs of VLANs on which MAC address learning should be disabled,
359 so that packets are flooded instead of being sent to specific ports
360 that are believed to contain packets' destination MACs. This should
361 ordinarily be used to disable MAC learning on VLANs used for
362 mirroring (RSPAN VLANs). It may also be useful for debugging.
365 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
366 the <ref table="Port"/> table) is incompatible with
367 <code>flood_vlans</code>. Consider using another bonding mode or
368 a different type of mirror instead.
373 <group title="OpenFlow Configuration">
374 <column name="controller">
376 OpenFlow controller set. If unset, then no OpenFlow controllers
381 If there are primary controllers, removing all of them clears the
382 flow table. If there are no primary controllers, adding one also
383 clears the flow table. Other changes to the set of controllers, such
384 as adding or removing a service controller, adding another primary
385 controller to supplement an existing primary controller, or removing
386 only one of two primary controllers, have no effect on the flow
391 <column name="fail_mode">
392 <p>When a controller is configured, it is, ordinarily, responsible
393 for setting up all flows on the switch. Thus, if the connection to
394 the controller fails, no new network connections can be set up.
395 If the connection to the controller stays down long enough,
396 no packets can pass through the switch at all. This setting
397 determines the switch's response to such a situation. It may be set
398 to one of the following:
400 <dt><code>standalone</code></dt>
401 <dd>If no message is received from the controller for three
402 times the inactivity probe interval
403 (see <ref column="inactivity_probe"/>), then Open vSwitch
404 will take over responsibility for setting up flows. In
405 this mode, Open vSwitch causes the bridge to act like an
406 ordinary MAC-learning switch. Open vSwitch will continue
407 to retry connecting to the controller in the background
408 and, when the connection succeeds, it will discontinue its
409 standalone behavior.</dd>
410 <dt><code>secure</code></dt>
411 <dd>Open vSwitch will not set up flows on its own when the
412 controller connection fails or when no controllers are
413 defined. The bridge will continue to retry connecting to
414 any defined controllers forever.</dd>
417 <p>If this value is unset, the default is implementation-specific.</p>
418 <p>When more than one controller is configured,
419 <ref column="fail_mode"/> is considered only when none of the
420 configured controllers can be contacted.</p>
422 Changing <ref column="fail_mode"/> when no primary controllers are
423 configured clears the flow table.
427 <column name="datapath_id">
428 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
429 (Setting this column has no useful effect. Set <ref
430 column="other-config" key="datapath-id"/> instead.)
433 <column name="other_config" key="datapath-id">
434 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
435 value. May not be all-zero.
438 <column name="other_config" key="disable-in-band"
439 type='{"type": "boolean"}'>
440 If set to <code>true</code>, disable in-band control on the bridge
441 regardless of controller and manager settings.
444 <column name="other_config" key="in-band-queue"
445 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
446 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
447 that will be used by flows set up by in-band control on this bridge.
448 If unset, or if the port used by an in-band control flow does not have
449 QoS configured, or if the port does not have a queue with the specified
450 ID, the default queue is used instead.
454 <group title="Spanning Tree Configuration">
455 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
456 that ensures loop-free topologies. It allows redundant links to
457 be included in the network to provide automatic backup paths if
458 the active links fails.
460 <column name="stp_enable">
461 Enable spanning tree on the bridge. By default, STP is disabled
462 on bridges. Bond, internal, and mirror ports are not supported
463 and will not participate in the spanning tree.
466 <column name="other_config" key="stp-system-id">
467 The bridge's STP identifier (the lower 48 bits of the bridge-id)
469 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
470 By default, the identifier is the MAC address of the bridge.
473 <column name="other_config" key="stp-priority"
474 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
475 The bridge's relative priority value for determining the root
476 bridge (the upper 16 bits of the bridge-id). A bridge with the
477 lowest bridge-id is elected the root. By default, the priority
481 <column name="other_config" key="stp-hello-time"
482 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
483 The interval between transmissions of hello messages by
484 designated ports, in seconds. By default the hello interval is
488 <column name="other_config" key="stp-max-age"
489 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
490 The maximum age of the information transmitted by the bridge
491 when it is the root bridge, in seconds. By default, the maximum
495 <column name="other_config" key="stp-forward-delay"
496 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
497 The delay to wait between transitioning root and designated
498 ports to <code>forwarding</code>, in seconds. By default, the
499 forwarding delay is 15 seconds.
503 <group title="Other Features">
504 <column name="datapath_type">
505 Name of datapath provider. The kernel datapath has
506 type <code>system</code>. The userspace datapath has
507 type <code>netdev</code>.
510 <column name="external_ids" key="bridge-id">
511 A unique identifier of the bridge. On Citrix XenServer this will
512 commonly be the same as
513 <ref column="external_ids" key="xs-network-uuids"/>.
516 <column name="external_ids" key="xs-network-uuids">
517 Semicolon-delimited set of universally unique identifier(s) for the
518 network with which this bridge is associated on a Citrix XenServer
519 host. The network identifiers are RFC 4122 UUIDs as displayed by,
520 e.g., <code>xe network-list</code>.
523 <column name="other_config" key="hwaddr">
524 An Ethernet address in the form
525 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
526 to set the hardware address of the local port and influence the
530 <column name="other_config" key="flow-eviction-threshold"
531 type='{"type": "integer", "minInteger": 0}'>
533 A number of flows as a nonnegative integer. This sets number of
534 flows at which eviction from the kernel flow table will be triggered.
535 If there are a large number of flows then increasing this value to
536 around the number of flows present can result in reduced CPU usage
540 The default is 1000. Values below 100 will be rounded up to 100.
544 <column name="other_config" key="forward-bpdu"
545 type='{"type": "boolean"}'>
546 Option to allow forwarding of BPDU frames when NORMAL action is
547 invoked. Frames with reserved Ethernet addresses (e.g. STP
548 BPDU) will be forwarded when this option is enabled and the
549 switch is not providing that functionality. If STP is enabled
550 on the port, STP BPDUs will never be forwarded. If the Open
551 vSwitch bridge is used to connect different Ethernet networks,
552 and if Open vSwitch node does not run STP, then this option
553 should be enabled. Default is disabled, set to
554 <code>true</code> to enable.
557 <column name="other_config" key="mac-aging-time"
558 type='{"type": "integer", "minInteger": 1}'>
560 The maximum number of seconds to retain a MAC learning entry for
561 which no packets have been seen. The default is currently 300
562 seconds (5 minutes). The value, if specified, is forced into a
563 reasonable range, currently 15 to 3600 seconds.
567 A short MAC aging time allows a network to more quickly detect that a
568 host is no longer connected to a switch port. However, it also makes
569 it more likely that packets will be flooded unnecessarily, when they
570 are addressed to a connected host that rarely transmits packets. To
571 reduce the incidence of unnecessary flooding, use a MAC aging time
572 longer than the maximum interval at which a host will ordinarily
578 <group title="Bridge Status">
580 Status information about bridges.
582 <column name="status">
583 Key-value pairs that report bridge status.
585 <column name="status" key="stp_bridge_id">
587 The bridge-id (in hex) used in spanning tree advertisements.
588 Configuring the bridge-id is described in the
589 <code>stp-system-id</code> and <code>stp-priority</code> keys
590 of the <code>other_config</code> section earlier.
593 <column name="status" key="stp_designated_root">
595 The designated root (in hex) for this spanning tree.
598 <column name="status" key="stp_root_path_cost">
600 The path cost of reaching the designated bridge. A lower
606 <group title="Common Columns">
607 The overall purpose of these columns is described under <code>Common
608 Columns</code> at the beginning of this document.
610 <column name="other_config"/>
611 <column name="external_ids"/>
615 <table name="Port" table="Port or bond configuration.">
616 <p>A port within a <ref table="Bridge"/>.</p>
617 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
618 <ref column="interfaces"/> column. Such a port logically
619 corresponds to a port on a physical Ethernet switch. A port
620 with more than one interface is a ``bonded port'' (see
621 <ref group="Bonding Configuration"/>).</p>
622 <p>Some properties that one might think as belonging to a port are actually
623 part of the port's <ref table="Interface"/> members.</p>
626 Port name. Should be alphanumeric and no more than about 8
627 bytes long. May be the same as the interface name, for
628 non-bonded ports. Must otherwise be unique among the names of
629 ports, interfaces, and bridges on a host.
632 <column name="interfaces">
633 The port's interfaces. If there is more than one, this is a
637 <group title="VLAN Configuration">
638 <p>Bridge ports support the following types of VLAN configuration:</p>
643 A trunk port carries packets on one or more specified VLANs
644 specified in the <ref column="trunks"/> column (often, on every
645 VLAN). A packet that ingresses on a trunk port is in the VLAN
646 specified in its 802.1Q header, or VLAN 0 if the packet has no
647 802.1Q header. A packet that egresses through a trunk port will
648 have an 802.1Q header if it has a nonzero VLAN ID.
652 Any packet that ingresses on a trunk port tagged with a VLAN that
653 the port does not trunk is dropped.
660 An access port carries packets on exactly one VLAN specified in the
661 <ref column="tag"/> column. Packets egressing on an access port
662 have no 802.1Q header.
666 Any packet with an 802.1Q header with a nonzero VLAN ID that
667 ingresses on an access port is dropped, regardless of whether the
668 VLAN ID in the header is the access port's VLAN ID.
672 <dt>native-tagged</dt>
674 A native-tagged port resembles a trunk port, with the exception that
675 a packet without an 802.1Q header that ingresses on a native-tagged
676 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
680 <dt>native-untagged</dt>
682 A native-untagged port resembles a native-tagged port, with the
683 exception that a packet that egresses on a native-untagged port in
684 the native VLAN will not have an 802.1Q header.
688 A packet will only egress through bridge ports that carry the VLAN of
689 the packet, as described by the rules above.
692 <column name="vlan_mode">
694 The VLAN mode of the port, as described above. When this column is
695 empty, a default mode is selected as follows:
699 If <ref column="tag"/> contains a value, the port is an access
700 port. The <ref column="trunks"/> column should be empty.
703 Otherwise, the port is a trunk port. The <ref column="trunks"/>
704 column value is honored if it is present.
711 For an access port, the port's implicitly tagged VLAN. For a
712 native-tagged or native-untagged port, the port's native VLAN. Must
713 be empty if this is a trunk port.
717 <column name="trunks">
719 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
720 or VLANs that this port trunks; if it is empty, then the port trunks
721 all VLANs. Must be empty if this is an access port.
724 A native-tagged or native-untagged port always trunks its native
725 VLAN, regardless of whether <ref column="trunks"/> includes that
730 <column name="other_config" key="priority-tags"
731 type='{"type": "boolean"}'>
733 An 802.1Q header contains two important pieces of information: a VLAN
734 ID and a priority. A frame with a zero VLAN ID, called a
735 ``priority-tagged'' frame, is supposed to be treated the same way as
736 a frame without an 802.1Q header at all (except for the priority).
740 However, some network elements ignore any frame that has 802.1Q
741 header at all, even when the VLAN ID is zero. Therefore, by default
742 Open vSwitch does not output priority-tagged frames, instead omitting
743 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
744 <code>true</code> to enable priority-tagged frames on a port.
748 Regardless of this setting, Open vSwitch omits the 802.1Q header on
749 output if both the VLAN ID and priority would be zero.
753 All frames output to native-tagged ports have a nonzero VLAN ID, so
754 this setting is not meaningful on native-tagged ports.
759 <group title="Bonding Configuration">
760 <p>A port that has more than one interface is a ``bonded port.'' Bonding
761 allows for load balancing and fail-over. Some kinds of bonding will
762 work with any kind of upstream switch:</p>
765 <dt><code>balance-slb</code></dt>
767 Balances flows among slaves based on source MAC address and output
768 VLAN, with periodic rebalancing as traffic patterns change.
771 <dt><code>active-backup</code></dt>
773 Assigns all flows to one slave, failing over to a backup slave when
774 the active slave is disabled.
779 The following modes require the upstream switch to support 802.3ad with
780 successful LACP negotiation. If LACP negotiation fails then
781 <code>balance-slb</code> style flow hashing is used as a fallback:
785 <dt><code>balance-tcp</code></dt>
787 Balances flows among slaves based on L2, L3, and L4 protocol
788 information such as destination MAC address, IP address, and TCP
792 <dt><code>stable</code></dt>
794 <p>Attempts to always assign a given flow to the same slave
795 consistently. In an effort to maintain stability, no load
796 balancing is done. Uses a similar hashing strategy to
797 <code>balance-tcp</code>, always taking into account L3 and L4
798 fields even if LACP negotiations are unsuccessful. </p>
799 <p>Slave selection decisions are made based on <ref table="Interface"
800 column="other_config" key="bond-stable-id"/> if set. Otherwise,
801 OpenFlow port number is used. Decisions are consistent across all
802 <code>ovs-vswitchd</code> instances with equivalent
803 <ref table="Interface" column="other_config" key="bond-stable-id"/>
808 <p>These columns apply only to bonded ports. Their values are
809 otherwise ignored.</p>
811 <column name="bond_mode">
812 <p>The type of bonding used for a bonded port. Defaults to
813 <code>balance-slb</code> if unset.
817 <column name="other_config" key="bond-hash-basis"
818 type='{"type": "integer"}'>
819 An integer hashed along with flows when choosing output slaves in load
820 balanced bonds. When changed, all flows will be assigned different
821 hash values possibly causing slave selection decisions to change. Does
822 not affect bonding modes which do not employ load balancing such as
823 <code>active-backup</code>.
826 <group title="Link Failure Detection">
828 An important part of link bonding is detecting that links are down so
829 that they may be disabled. These settings determine how Open vSwitch
830 detects link failure.
833 <column name="other_config" key="bond-detect-mode"
834 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
835 The means used to detect link failures. Defaults to
836 <code>carrier</code> which uses each interface's carrier to detect
837 failures. When set to <code>miimon</code>, will check for failures
838 by polling each interface's MII.
841 <column name="other_config" key="bond-miimon-interval"
842 type='{"type": "integer"}'>
843 The interval, in milliseconds, between successive attempts to poll
844 each interface's MII. Relevant only when <ref column="other_config"
845 key="bond-detect-mode"/> is <code>miimon</code>.
848 <column name="bond_updelay">
850 The number of milliseconds for which carrier must stay up on an
851 interface before the interface is considered to be up. Specify
852 <code>0</code> to enable the interface immediately.
856 This setting is honored only when at least one bonded interface is
857 already enabled. When no interfaces are enabled, then the first
858 bond interface to come up is enabled immediately.
862 <column name="bond_downdelay">
863 The number of milliseconds for which carrier must stay down on an
864 interface before the interface is considered to be down. Specify
865 <code>0</code> to disable the interface immediately.
869 <group title="LACP Configuration">
871 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
872 allows switches to automatically detect that they are connected by
873 multiple links and aggregate across those links. These settings
874 control LACP behavior.
878 Configures LACP on this port. LACP allows directly connected
879 switches to negotiate which links may be bonded. LACP may be enabled
880 on non-bonded ports for the benefit of any switches they may be
881 connected to. <code>active</code> ports are allowed to initiate LACP
882 negotiations. <code>passive</code> ports are allowed to participate
883 in LACP negotiations initiated by a remote switch, but not allowed to
884 initiate such negotiations themselves. Defaults to <code>off</code>
888 <column name="other_config" key="lacp-system-id">
889 The LACP system ID of this <ref table="Port"/>. The system ID of a
890 LACP bond is used to identify itself to its partners. Must be a
894 <column name="other_config" key="lacp-system-priority"
895 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
896 The LACP system priority of this <ref table="Port"/>. In LACP
897 negotiations, link status decisions are made by the system with the
898 numerically lower priority.
901 <column name="other_config" key="lacp-time">
903 The LACP timing which should be used on this <ref table="Port"/>.
904 Possible values are <code>fast</code>, <code>slow</code> and a
905 positive number of milliseconds. By default <code>slow</code> is
906 used. When configured to be <code>fast</code> LACP heartbeats are
907 requested at a rate of once per second causing connectivity
908 problems to be detected more quickly. In <code>slow</code> mode,
909 heartbeats are requested at a rate of once every 30 seconds.
913 Users may manually set a heartbeat transmission rate to increase
914 the fault detection speed further. When manually set, OVS expects
915 the partner switch to be configured with the same transmission
916 rate. Manually setting <code>lacp-time</code> to something other
917 than <code>fast</code> or <code>slow</code> is not supported by the
922 <column name="other_config" key="lacp-heartbeat"
923 type='{"type": "boolean"}'>
924 Treat LACP like a simple heartbeat protocol for link state
925 monitoring. Most features of the LACP protocol are disabled
926 when this mode is in use. The default if not specified is
931 <group title="SLB Configuration">
933 These settings control behavior when a bond is in
934 <code>balance-slb</code> mode, regardless of whether the bond was
935 intentionally configured in SLB mode or it fell back to SLB mode
936 because LACP negotiation failed.
939 <column name="other_config" key="bond-rebalance-interval"
940 type='{"type": "integer", "minInteger": 1000, "maxInteger": 10000}'>
941 For an SLB bonded port, the number of milliseconds between successive
942 attempts to rebalance the bond, that is, to move source MACs and
943 their flows from one interface on the bond to another in an attempt
944 to keep usage of each interface roughly equal.
948 <column name="bond_fake_iface">
949 For a bonded port, whether to create a fake internal interface with the
950 name of the port. Use only for compatibility with legacy software that
955 <group title="Spanning Tree Configuration">
956 <column name="other_config" key="stp-enable"
957 type='{"type": "boolean"}'>
958 If spanning tree is enabled on the bridge, member ports are
959 enabled by default (with the exception of bond, internal, and
960 mirror ports which do not work with STP). If this column's
961 value is <code>false</code> spanning tree is disabled on the
965 <column name="other_config" key="stp-port-num"
966 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
967 The port number used for the lower 8 bits of the port-id. By
968 default, the numbers will be assigned automatically. If any
969 port's number is manually configured on a bridge, then they
973 <column name="other_config" key="stp-port-priority"
974 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
975 The port's relative priority value for determining the root
976 port (the upper 8 bits of the port-id). A port with a lower
977 port-id will be chosen as the root port. By default, the
981 <column name="other_config" key="stp-path-cost"
982 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
983 Spanning tree path cost for the port. A lower number indicates
984 a faster link. By default, the cost is based on the maximum
989 <group title="Other Features">
991 Quality of Service configuration for this port.
995 The MAC address to use for this port for the purpose of choosing the
996 bridge's MAC address. This column does not necessarily reflect the
997 port's actual MAC address, nor will setting it change the port's actual
1001 <column name="fake_bridge">
1002 Does this port represent a sub-bridge for its tagged VLAN within the
1003 Bridge? See ovs-vsctl(8) for more information.
1006 <column name="external_ids" key="fake-bridge-id-*">
1007 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1008 column) are defined by prefixing a <ref table="Bridge"/> <ref
1009 table="Bridge" column="external_ids"/> key with
1010 <code>fake-bridge-</code>,
1011 e.g. <code>fake-bridge-xs-network-uuids</code>.
1015 <group title="Port Status">
1017 Status information about ports attached to bridges.
1019 <column name="status">
1020 Key-value pairs that report port status.
1022 <column name="status" key="stp_port_id">
1024 The port-id (in hex) used in spanning tree advertisements for
1025 this port. Configuring the port-id is described in the
1026 <code>stp-port-num</code> and <code>stp-port-priority</code>
1027 keys of the <code>other_config</code> section earlier.
1030 <column name="status" key="stp_state"
1031 type='{"type": "string", "enum": ["set",
1032 ["disabled", "listening", "learning",
1033 "forwarding", "blocking"]]}'>
1035 STP state of the port.
1038 <column name="status" key="stp_sec_in_state"
1039 type='{"type": "integer", "minInteger": 0}'>
1041 The amount of time (in seconds) port has been in the current
1045 <column name="status" key="stp_role"
1046 type='{"type": "string", "enum": ["set",
1047 ["root", "designated", "alternate"]]}'>
1049 STP role of the port.
1054 <group title="Port Statistics">
1056 Key-value pairs that report port statistics.
1058 <group title="Statistics: STP transmit and receive counters">
1059 <column name="statistics" key="stp_tx_count">
1060 Number of STP BPDUs sent on this port by the spanning
1063 <column name="statistics" key="stp_rx_count">
1064 Number of STP BPDUs received on this port and accepted by the
1065 spanning tree library.
1067 <column name="statistics" key="stp_error_count">
1068 Number of bad STP BPDUs received on this port. Bad BPDUs
1069 include runt packets and those with an unexpected protocol ID.
1074 <group title="Common Columns">
1075 The overall purpose of these columns is described under <code>Common
1076 Columns</code> at the beginning of this document.
1078 <column name="other_config"/>
1079 <column name="external_ids"/>
1083 <table name="Interface" title="One physical network device in a Port.">
1084 An interface within a <ref table="Port"/>.
1086 <group title="Core Features">
1087 <column name="name">
1088 Interface name. Should be alphanumeric and no more than about 8 bytes
1089 long. May be the same as the port name, for non-bonded ports. Must
1090 otherwise be unique among the names of ports, interfaces, and bridges
1095 <p>Ethernet address to set for this interface. If unset then the
1096 default MAC address is used:</p>
1098 <li>For the local interface, the default is the lowest-numbered MAC
1099 address among the other bridge ports, either the value of the
1100 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1101 if set, or its actual MAC (for bonded ports, the MAC of its slave
1102 whose name is first in alphabetical order). Internal ports and
1103 bridge ports that are used as port mirroring destinations (see the
1104 <ref table="Mirror"/> table) are ignored.</li>
1105 <li>For other internal interfaces, the default MAC is randomly
1107 <li>External interfaces typically have a MAC address associated with
1108 their hardware.</li>
1110 <p>Some interfaces may not have a software-controllable MAC
1114 <column name="ofport">
1115 <p>OpenFlow port number for this interface. Unlike most columns, this
1116 column's value should be set only by Open vSwitch itself. Other
1117 clients should set this column to an empty set (the default) when
1118 creating an <ref table="Interface"/>.</p>
1119 <p>Open vSwitch populates this column when the port number becomes
1120 known. If the interface is successfully added,
1121 <ref column="ofport"/> will be set to a number between 1 and 65535
1122 (generally either in the range 1 to 65279, inclusive, or 65534, the
1123 port number for the OpenFlow ``local port''). If the interface
1124 cannot be added then Open vSwitch sets this column
1129 <group title="System-Specific Details">
1130 <column name="type">
1132 The interface type, one of:
1136 <dt><code>system</code></dt>
1137 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1138 Sometimes referred to as ``external interfaces'' since they are
1139 generally connected to hardware external to that on which the Open
1140 vSwitch is running. The empty string is a synonym for
1141 <code>system</code>.</dd>
1143 <dt><code>internal</code></dt>
1144 <dd>A simulated network device that sends and receives traffic. An
1145 internal interface whose <ref column="name"/> is the same as its
1146 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1147 ``local interface.'' It does not make sense to bond an internal
1148 interface, so the terms ``port'' and ``interface'' are often used
1149 imprecisely for internal interfaces.</dd>
1151 <dt><code>tap</code></dt>
1152 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1154 <dt><code>gre</code></dt>
1156 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1157 tunnel. See <ref group="Tunnel Options"/> for information on
1158 configuring GRE tunnels.
1161 <dt><code>ipsec_gre</code></dt>
1163 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1167 <dt><code>capwap</code></dt>
1169 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1170 5415). This allows interoperability with certain switches that do
1171 not support GRE. Only the tunneling component of the protocol is
1172 implemented. UDP ports 58881 and 58882 are used as the source and
1173 destination ports respectively. CAPWAP is currently supported only
1174 with the Linux kernel datapath with kernel version 2.6.26 or later.
1177 <dt><code>patch</code></dt>
1179 A pair of virtual devices that act as a patch cable.
1182 <dt><code>null</code></dt>
1183 <dd>An ignored interface.</dd>
1188 <group title="Tunnel Options">
1190 These options apply to interfaces with <ref column="type"/> of
1191 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1195 Each tunnel must be uniquely identified by the combination of <ref
1196 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1197 column="options" key="local_ip"/>, and <ref column="options"
1198 key="in_key"/>. If two ports are defined that are the same except one
1199 has an optional identifier and the other does not, the more specific
1200 one is matched first. <ref column="options" key="in_key"/> is
1201 considered more specific than <ref column="options" key="local_ip"/> if
1202 a port defines one and another port defines the other.
1205 <column name="options" key="remote_ip">
1207 Required. The tunnel endpoint. Unicast and multicast endpoints are
1212 When a multicast endpoint is specified, a routing table lookup occurs
1213 only when the tunnel is created. Following a routing change, delete
1214 and then re-create the tunnel to force a new routing table lookup.
1218 <column name="options" key="local_ip">
1219 Optional. The destination IP that received packets must match.
1220 Default is to match all addresses. Must be omitted when <ref
1221 column="options" key="remote_ip"/> is a multicast address.
1224 <column name="options" key="in_key">
1225 <p>Optional. The key that received packets must contain, one of:</p>
1229 <code>0</code>. The tunnel receives packets with no key or with a
1230 key of 0. This is equivalent to specifying no <ref column="options"
1231 key="in_key"/> at all.
1234 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1235 tunnel receives only packets with the specified key.
1238 The word <code>flow</code>. The tunnel accepts packets with any
1239 key. The key will be placed in the <code>tun_id</code> field for
1240 matching in the flow table. The <code>ovs-ofctl</code> manual page
1241 contains additional information about matching fields in OpenFlow
1250 <column name="options" key="out_key">
1251 <p>Optional. The key to be set on outgoing packets, one of:</p>
1255 <code>0</code>. Packets sent through the tunnel will have no key.
1256 This is equivalent to specifying no <ref column="options"
1257 key="out_key"/> at all.
1260 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1261 sent through the tunnel will have the specified key.
1264 The word <code>flow</code>. Packets sent through the tunnel will
1265 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1266 vendor extension (0 is used in the absence of an action). The
1267 <code>ovs-ofctl</code> manual page contains additional information
1268 about the Nicira OpenFlow vendor extensions.
1273 <column name="options" key="key">
1274 Optional. Shorthand to set <code>in_key</code> and
1275 <code>out_key</code> at the same time.
1278 <column name="options" key="tos">
1279 Optional. The value of the ToS bits to be set on the encapsulating
1280 packet. It may also be the word <code>inherit</code>, in which case
1281 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1282 (otherwise it will be 0). The ECN fields are always inherited.
1286 <column name="options" key="ttl">
1287 Optional. The TTL to be set on the encapsulating packet. It may also
1288 be the word <code>inherit</code>, in which case the TTL will be copied
1289 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1290 system default, typically 64). Default is the system default TTL.
1293 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1294 Optional. If enabled, the Don't Fragment bit will be copied from the
1295 inner IP headers (those of the encapsulated traffic) to the outer
1296 (tunnel) headers. Default is disabled; set to <code>true</code> to
1300 <column name="options" key="df_default"
1301 type='{"type": "boolean"}'>
1302 Optional. If enabled, the Don't Fragment bit will be set by default on
1303 tunnel headers if the <code>df_inherit</code> option is not set, or if
1304 the encapsulated packet is not IP. Default is enabled; set to
1305 <code>false</code> to disable.
1308 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1309 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1310 Destination Unreachable - Fragmentation Needed'' messages will be
1311 generated for IPv4 packets with the DF bit set and IPv6 packets above
1312 the minimum MTU if the packet size exceeds the path MTU minus the size
1313 of the tunnel headers. Note that this option causes behavior that is
1314 typically reserved for routers and therefore is not entirely in
1315 compliance with the IEEE 802.1D specification for bridges. Default is
1316 enabled; set to <code>false</code> to disable.
1319 <group title="Tunnel Options: gre only">
1321 Only <code>gre</code> interfaces support these options.
1324 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1325 Enable caching of tunnel headers and the output path. This can lead
1326 to a significant performance increase without changing behavior. In
1327 general it should not be necessary to adjust this setting. However,
1328 the caching can bypass certain components of the IP stack (such as
1329 <code>iptables</code>) and it may be useful to disable it if these
1330 features are required or as a debugging measure. Default is enabled,
1331 set to <code>false</code> to disable.
1335 <group title="Tunnel Options: gre and ipsec_gre only">
1337 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1341 <column name="options" key="csum" type='{"type": "boolean"}'>
1343 Optional. Compute GRE checksums on outgoing packets. Default is
1344 disabled, set to <code>true</code> to enable. Checksums present on
1345 incoming packets will be validated regardless of this setting.
1349 GRE checksums impose a significant performance penalty because they
1350 cover the entire packet. The encapsulated L3, L4, and L7 packet
1351 contents typically have their own checksums, so this additional
1352 checksum only adds value for the GRE and encapsulated L2 headers.
1356 This option is supported for <code>ipsec_gre</code>, but not useful
1357 because GRE checksums are weaker than, and redundant with, IPsec
1358 payload authentication.
1363 <group title="Tunnel Options: ipsec_gre only">
1365 Only <code>ipsec_gre</code> interfaces support these options.
1368 <column name="options" key="peer_cert">
1369 Required for certificate authentication. A string containing the
1370 peer's certificate in PEM format. Additionally the host's
1371 certificate must be specified with the <code>certificate</code>
1375 <column name="options" key="certificate">
1376 Required for certificate authentication. The name of a PEM file
1377 containing a certificate that will be presented to the peer during
1381 <column name="options" key="private_key">
1382 Optional for certificate authentication. The name of a PEM file
1383 containing the private key associated with <code>certificate</code>.
1384 If <code>certificate</code> contains the private key, this option may
1388 <column name="options" key="psk">
1389 Required for pre-shared key authentication. Specifies a pre-shared
1390 key for authentication that must be identical on both sides of the
1396 <group title="Patch Options">
1398 Only <code>patch</code> interfaces support these options.
1401 <column name="options" key="peer">
1402 The <ref column="name"/> of the <ref table="Interface"/> for the other
1403 side of the patch. The named <ref table="Interface"/>'s own
1404 <code>peer</code> option must specify this <ref table="Interface"/>'s
1405 name. That is, the two patch interfaces must have reversed <ref
1406 column="name"/> and <code>peer</code> values.
1410 <group title="Interface Status">
1412 Status information about interfaces attached to bridges, updated every
1413 5 seconds. Not all interfaces have all of these properties; virtual
1414 interfaces don't have a link speed, for example. Non-applicable
1415 columns will have empty values.
1417 <column name="admin_state">
1419 The administrative state of the physical network link.
1423 <column name="link_state">
1425 The observed state of the physical network link. This is ordinarily
1426 the link's carrier status. If the interface's <ref table="Port"/> is
1427 a bond configured for miimon monitoring, it is instead the network
1428 link's miimon status.
1432 <column name="link_resets">
1434 The number of times Open vSwitch has observed the
1435 <ref column="link_state"/> of this <ref table="Interface"/> change.
1439 <column name="link_speed">
1441 The negotiated speed of the physical network link.
1442 Valid values are positive integers greater than 0.
1446 <column name="duplex">
1448 The duplex mode of the physical network link.
1454 The MTU (maximum transmission unit); i.e. the largest
1455 amount of data that can fit into a single Ethernet frame.
1456 The standard Ethernet MTU is 1500 bytes. Some physical media
1457 and many kinds of virtual interfaces can be configured with
1461 This column will be empty for an interface that does not
1462 have an MTU as, for example, some kinds of tunnels do not.
1466 <column name="lacp_current">
1467 Boolean value indicating LACP status for this interface. If true, this
1468 interface has current LACP information about its LACP partner. This
1469 information may be used to monitor the health of interfaces in a LACP
1470 enabled port. This column will be empty if LACP is not enabled.
1473 <column name="status">
1474 Key-value pairs that report port status. Supported status values are
1475 <ref column="type"/>-dependent; some interfaces may not have a valid
1476 <ref column="status" key="driver_name"/>, for example.
1479 <column name="status" key="driver_name">
1480 The name of the device driver controlling the network adapter.
1483 <column name="status" key="driver_version">
1484 The version string of the device driver controlling the network
1488 <column name="status" key="firmware_version">
1489 The version string of the network adapter's firmware, if available.
1492 <column name="status" key="source_ip">
1493 The source IP address used for an IPv4 tunnel end-point, such as
1494 <code>gre</code> or <code>capwap</code>.
1497 <column name="status" key="tunnel_egress_iface">
1498 Egress interface for tunnels. Currently only relevant for GRE and
1499 CAPWAP tunnels. On Linux systems, this column will show the name of
1500 the interface which is responsible for routing traffic destined for the
1501 configured <ref column="options" key="remote_ip"/>. This could be an
1502 internal interface such as a bridge port.
1505 <column name="status" key="tunnel_egress_iface_carrier"
1506 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1507 Whether carrier is detected on <ref column="status"
1508 key="tunnel_egress_iface"/>.
1512 <group title="Statistics">
1514 Key-value pairs that report interface statistics. The current
1515 implementation updates these counters periodically. Future
1516 implementations may update them when an interface is created, when they
1517 are queried (e.g. using an OVSDB <code>select</code> operation), and
1518 just before an interface is deleted due to virtual interface hot-unplug
1519 or VM shutdown, and perhaps at other times, but not on any regular
1523 These are the same statistics reported by OpenFlow in its <code>struct
1524 ofp_port_stats</code> structure. If an interface does not support a
1525 given statistic, then that pair is omitted.
1527 <group title="Statistics: Successful transmit and receive counters">
1528 <column name="statistics" key="rx_packets">
1529 Number of received packets.
1531 <column name="statistics" key="rx_bytes">
1532 Number of received bytes.
1534 <column name="statistics" key="tx_packets">
1535 Number of transmitted packets.
1537 <column name="statistics" key="tx_bytes">
1538 Number of transmitted bytes.
1541 <group title="Statistics: Receive errors">
1542 <column name="statistics" key="rx_dropped">
1543 Number of packets dropped by RX.
1545 <column name="statistics" key="rx_frame_err">
1546 Number of frame alignment errors.
1548 <column name="statistics" key="rx_over_err">
1549 Number of packets with RX overrun.
1551 <column name="statistics" key="rx_crc_err">
1552 Number of CRC errors.
1554 <column name="statistics" key="rx_errors">
1555 Total number of receive errors, greater than or equal to the sum of
1559 <group title="Statistics: Transmit errors">
1560 <column name="statistics" key="tx_dropped">
1561 Number of packets dropped by TX.
1563 <column name="statistics" key="collisions">
1564 Number of collisions.
1566 <column name="statistics" key="tx_errors">
1567 Total number of transmit errors, greater than or equal to the sum of
1573 <group title="Ingress Policing">
1575 These settings control ingress policing for packets received on this
1576 interface. On a physical interface, this limits the rate at which
1577 traffic is allowed into the system from the outside; on a virtual
1578 interface (one connected to a virtual machine), this limits the rate at
1579 which the VM is able to transmit.
1582 Policing is a simple form of quality-of-service that simply drops
1583 packets received in excess of the configured rate. Due to its
1584 simplicity, policing is usually less accurate and less effective than
1585 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1586 table="Queue"/> tables).
1589 Policing is currently implemented only on Linux. The Linux
1590 implementation uses a simple ``token bucket'' approach:
1594 The size of the bucket corresponds to <ref
1595 column="ingress_policing_burst"/>. Initially the bucket is full.
1598 Whenever a packet is received, its size (converted to tokens) is
1599 compared to the number of tokens currently in the bucket. If the
1600 required number of tokens are available, they are removed and the
1601 packet is forwarded. Otherwise, the packet is dropped.
1604 Whenever it is not full, the bucket is refilled with tokens at the
1605 rate specified by <ref column="ingress_policing_rate"/>.
1609 Policing interacts badly with some network protocols, and especially
1610 with fragmented IP packets. Suppose that there is enough network
1611 activity to keep the bucket nearly empty all the time. Then this token
1612 bucket algorithm will forward a single packet every so often, with the
1613 period depending on packet size and on the configured rate. All of the
1614 fragments of an IP packets are normally transmitted back-to-back, as a
1615 group. In such a situation, therefore, only one of these fragments
1616 will be forwarded and the rest will be dropped. IP does not provide
1617 any way for the intended recipient to ask for only the remaining
1618 fragments. In such a case there are two likely possibilities for what
1619 will happen next: either all of the fragments will eventually be
1620 retransmitted (as TCP will do), in which case the same problem will
1621 recur, or the sender will not realize that its packet has been dropped
1622 and data will simply be lost (as some UDP-based protocols will do).
1623 Either way, it is possible that no forward progress will ever occur.
1625 <column name="ingress_policing_rate">
1627 Maximum rate for data received on this interface, in kbps. Data
1628 received faster than this rate is dropped. Set to <code>0</code>
1629 (the default) to disable policing.
1633 <column name="ingress_policing_burst">
1634 <p>Maximum burst size for data received on this interface, in kb. The
1635 default burst size if set to <code>0</code> is 1000 kb. This value
1636 has no effect if <ref column="ingress_policing_rate"/>
1637 is <code>0</code>.</p>
1639 Specifying a larger burst size lets the algorithm be more forgiving,
1640 which is important for protocols like TCP that react severely to
1641 dropped packets. The burst size should be at least the size of the
1642 interface's MTU. Specifying a value that is numerically at least as
1643 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1644 closer to achieving the full rate.
1649 <group title="Connectivity Fault Management">
1651 802.1ag Connectivity Fault Management (CFM) allows a group of
1652 Maintenance Points (MPs) called a Maintenance Association (MA) to
1653 detect connectivity problems with each other. MPs within a MA should
1654 have complete and exclusive interconnectivity. This is verified by
1655 occasionally broadcasting Continuity Check Messages (CCMs) at a
1656 configurable transmission interval.
1660 According to the 802.1ag specification, each Maintenance Point should
1661 be configured out-of-band with a list of Remote Maintenance Points it
1662 should have connectivity to. Open vSwitch differs from the
1663 specification in this area. It simply assumes the link is faulted if
1664 no Remote Maintenance Points are reachable, and considers it not
1668 <column name="cfm_mpid">
1669 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1670 a Maintenance Association. The MPID is used to identify this endpoint
1671 to other Maintenance Points in the MA. Each end of a link being
1672 monitored should have a different MPID. Must be configured to enable
1673 CFM on this <ref table="Interface"/>.
1676 <column name="cfm_fault">
1678 Indicates a connectivity fault triggered by an inability to receive
1679 heartbeats from any remote endpoint. When a fault is triggered on
1680 <ref table="Interface"/>s participating in bonds, they will be
1684 Faults can be triggered for several reasons. Most importantly they
1685 are triggered when no CCMs are received for a period of 3.5 times the
1686 transmission interval. Faults are also triggered when any CCMs
1687 indicate that a Remote Maintenance Point is not receiving CCMs but
1688 able to send them. Finally, a fault is triggered if a CCM is
1689 received which indicates unexpected configuration. Notably, this
1690 case arises when a CCM is received which advertises the local MPID.
1694 <column name="cfm_remote_mpids">
1695 When CFM is properly configured, Open vSwitch will occasionally
1696 receive CCM broadcasts. These broadcasts contain the MPID of the
1697 sending Maintenance Point. The list of MPIDs from which this
1698 <ref table="Interface"/> is receiving broadcasts from is regularly
1699 collected and written to this column.
1702 <column name="other_config" key="cfm_interval"
1703 type='{"type": "integer"}'>
1704 The interval, in milliseconds, between transmissions of CFM heartbeats.
1705 Three missed heartbeat receptions indicate a connectivity fault.
1709 <column name="other_config" key="cfm_extended"
1710 type='{"type": "boolean"}'>
1711 When <code>true</code>, the CFM module operates in extended mode. This
1712 causes it to use a nonstandard destination address to avoid conflicting
1713 with compliant implementations which may be running concurrently on the
1714 network. Furthermore, extended mode increases the accuracy of the
1715 <code>cfm_interval</code> configuration parameter by breaking wire
1716 compatibility with 802.1ag compliant implementations. Defaults to
1719 <column name="other_config" key="cfm_opstate"
1720 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1721 When <code>down</code>, the CFM module marks all CCMs it generates as
1722 operationally down without triggering a fault. This allows remote
1723 maintenance points to choose not to forward traffic to the
1724 <ref table="Interface"/> on which this CFM module is running.
1725 Currently, in Open vSwitch, the opdown bit of CCMs affects
1726 <ref table="Interface"/>s participating in bonds, and the bundle
1727 OpenFlow action. This setting is ignored when CFM is not in extended
1728 mode. Defaults to <code>up</code>.
1731 <column name="other_config" key="cfm_ccm_vlan"
1732 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1733 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1734 with the given value.
1739 <group title="Bonding Configuration">
1740 <column name="other_config" key="bond-stable-id"
1741 type='{"type": "integer", "minInteger": 1}'>
1742 Used in <code>stable</code> bond mode to make slave
1743 selection decisions. Allocating <ref column="other_config"
1744 key="bond-stable-id"/> values consistently across interfaces
1745 participating in a bond will guarantee consistent slave selection
1746 decisions across <code>ovs-vswitchd</code> instances when using
1747 <code>stable</code> bonding mode.
1750 <column name="other_config" key="lacp-port-id"
1751 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1752 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1753 used in LACP negotiations to identify individual ports
1754 participating in a bond.
1757 <column name="other_config" key="lacp-port-priority"
1758 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1759 The LACP port priority of this <ref table="Interface"/>. In LACP
1760 negotiations <ref table="Interface"/>s with numerically lower
1761 priorities are preferred for aggregation.
1764 <column name="other_config" key="lacp-aggregation-key"
1765 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1766 The LACP aggregation key of this <ref table="Interface"/>. <ref
1767 table="Interface"/>s with different aggregation keys may not be active
1768 within a given <ref table="Port"/> at the same time.
1772 <group title="Virtual Machine Identifiers">
1774 These key-value pairs specifically apply to an interface that
1775 represents a virtual Ethernet interface connected to a virtual
1776 machine. These key-value pairs should not be present for other types
1777 of interfaces. Keys whose names end in <code>-uuid</code> have
1778 values that uniquely identify the entity in question. For a Citrix
1779 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1780 Other hypervisors may use other formats.
1783 <column name="external_ids" key="attached-mac">
1784 The MAC address programmed into the ``virtual hardware'' for this
1785 interface, in the form
1786 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1787 For Citrix XenServer, this is the value of the <code>MAC</code> field
1788 in the VIF record for this interface.
1791 <column name="external_ids" key="iface-id">
1792 A system-unique identifier for the interface. On XenServer, this will
1793 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1796 <column name="external_ids" key="xs-vif-uuid">
1797 The virtual interface associated with this interface.
1800 <column name="external_ids" key="xs-network-uuid">
1801 The virtual network to which this interface is attached.
1804 <column name="external_ids" key="xs-vm-uuid">
1805 The VM to which this interface belongs.
1809 <group title="VLAN Splinters">
1811 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1812 with buggy network drivers in old versions of Linux that do not
1813 properly support VLANs when VLAN devices are not used, at some cost
1814 in memory and performance.
1818 When VLAN splinters are enabled on a particular interface, Open vSwitch
1819 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1820 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1821 received on the VLAN device is treated as if it had been received on
1822 the interface on the particular VLAN.
1826 VLAN splinters consider a VLAN to be in use if:
1831 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1832 table="Port"/> record.
1836 The VLAN is listed within the <ref table="Port" column="trunks"/>
1837 column of the <ref table="Port"/> record of an interface on which
1838 VLAN splinters are enabled.
1840 An empty <ref table="Port" column="trunks"/> does not influence the
1841 in-use VLANs: creating 4,096 VLAN devices is impractical because it
1842 will exceed the current 1,024 port per datapath limit.
1846 An OpenFlow flow within any bridge matches the VLAN.
1851 The same set of in-use VLANs applies to every interface on which VLAN
1852 splinters are enabled. That is, the set is not chosen separately for
1853 each interface but selected once as the union of all in-use VLANs based
1858 It does not make sense to enable VLAN splinters on an interface for an
1859 access port, or on an interface that is not a physical port.
1863 VLAN splinters are deprecated. When broken device drivers are no
1864 longer in widespread use, we will delete this feature.
1867 <column name="other_config" key="enable-vlan-splinters"
1868 type='{"type": "boolean"}'>
1870 Set to <code>true</code> to enable VLAN splinters on this interface.
1871 Defaults to <code>false</code>.
1875 VLAN splinters increase kernel and userspace memory overhead, so do
1876 not use them unless they are needed.
1881 <group title="Common Columns">
1882 The overall purpose of these columns is described under <code>Common
1883 Columns</code> at the beginning of this document.
1885 <column name="other_config"/>
1886 <column name="external_ids"/>
1890 <table name="QoS" title="Quality of Service configuration">
1891 <p>Quality of Service (QoS) configuration for each Port that
1894 <column name="type">
1895 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1896 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1897 identifies the types that a switch actually supports. The currently
1898 defined types are listed below:</p>
1900 <dt><code>linux-htb</code></dt>
1902 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1903 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1904 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1905 for information on how this classifier works and how to configure it.
1909 <dt><code>linux-hfsc</code></dt>
1911 Linux "Hierarchical Fair Service Curve" classifier.
1912 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1913 information on how this classifier works.
1918 <column name="queues">
1919 <p>A map from queue numbers to <ref table="Queue"/> records. The
1920 supported range of queue numbers depend on <ref column="type"/>. The
1921 queue numbers are the same as the <code>queue_id</code> used in
1922 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1926 Queue 0 is the ``default queue.'' It is used by OpenFlow output
1927 actions when no specific queue has been set. Ordinarily <ref
1928 column="queues"/> should include a configuration for queue 0. When no
1929 configuration for queue 0 is present, a default configuration is used.
1930 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
1931 this case. With some queuing disciplines, this dropped all packets
1932 destined for the default queue.)
1936 <group title="Configuration for linux-htb and linux-hfsc">
1938 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1939 the following key-value pair:
1942 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
1943 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
1944 specified, for physical interfaces, the default is the link rate. For
1945 other interfaces or if the link rate cannot be determined, the default
1946 is currently 100 Mbps.
1950 <group title="Common Columns">
1951 The overall purpose of these columns is described under <code>Common
1952 Columns</code> at the beginning of this document.
1954 <column name="other_config"/>
1955 <column name="external_ids"/>
1959 <table name="Queue" title="QoS output queue.">
1960 <p>A configuration for a port output queue, used in configuring Quality of
1961 Service (QoS) features. May be referenced by <ref column="queues"
1962 table="QoS"/> column in <ref table="QoS"/> table.</p>
1964 <column name="dscp">
1965 If set, Open vSwitch will mark all traffic egressing this
1966 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
1967 default <ref table="Queue"/> is only marked if it was explicitly selected
1968 as the <ref table="Queue"/> at the time the packet was output. If unset,
1969 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
1973 <group title="Configuration for min-rate QoS">
1975 These key-value pairs are defined for <ref table="QoS"/> <ref
1976 table="QoS" column="type"/> of <code>min-rate</code>.
1979 <column name="other_config" key="min-rate"
1980 type='{"type": "integer", "minInteger": 12000}'>
1981 Minimum guaranteed bandwidth, in bit/s. Required. The floor value is
1982 1500 bytes/s (12,000 bit/s).
1986 <group title="Configuration for linux-htb QoS">
1988 <ref table="QoS"/> <ref table="QoS" column="type"/>
1989 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
1990 It has the following key-value pairs defined.
1993 <column name="other_config" key="min-rate"
1994 type='{"type": "integer", "minInteger": 1}'>
1995 Minimum guaranteed bandwidth, in bit/s.
1998 <column name="other_config" key="max-rate"
1999 type='{"type": "integer", "minInteger": 1}'>
2000 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2001 queue's rate will not be allowed to exceed the specified value, even
2002 if excess bandwidth is available. If unspecified, defaults to no
2006 <column name="other_config" key="burst"
2007 type='{"type": "integer", "minInteger": 1}'>
2008 Burst size, in bits. This is the maximum amount of ``credits'' that a
2009 queue can accumulate while it is idle. Optional. Details of the
2010 <code>linux-htb</code> implementation require a minimum burst size, so
2011 a too-small <code>burst</code> will be silently ignored.
2014 <column name="other_config" key="priority"
2015 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2016 A queue with a smaller <code>priority</code> will receive all the
2017 excess bandwidth that it can use before a queue with a larger value
2018 receives any. Specific priority values are unimportant; only relative
2019 ordering matters. Defaults to 0 if unspecified.
2023 <group title="Configuration for linux-hfsc QoS">
2025 <ref table="QoS"/> <ref table="QoS" column="type"/>
2026 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2027 It has the following key-value pairs defined.
2030 <column name="other_config" key="min-rate"
2031 type='{"type": "integer", "minInteger": 1}'>
2032 Minimum guaranteed bandwidth, in bit/s.
2035 <column name="other_config" key="max-rate"
2036 type='{"type": "integer", "minInteger": 1}'>
2037 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2038 queue's rate will not be allowed to exceed the specified value, even if
2039 excess bandwidth is available. If unspecified, defaults to no
2044 <group title="Common Columns">
2045 The overall purpose of these columns is described under <code>Common
2046 Columns</code> at the beginning of this document.
2048 <column name="other_config"/>
2049 <column name="external_ids"/>
2053 <table name="Mirror" title="Port mirroring.">
2054 <p>A port mirror within a <ref table="Bridge"/>.</p>
2055 <p>A port mirror configures a bridge to send selected frames to special
2056 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2057 traffic may also be referred to as SPAN or RSPAN, depending on how
2058 the mirrored traffic is sent.</p>
2060 <column name="name">
2061 Arbitrary identifier for the <ref table="Mirror"/>.
2064 <group title="Selecting Packets for Mirroring">
2066 To be selected for mirroring, a given packet must enter or leave the
2067 bridge through a selected port and it must also be in one of the
2071 <column name="select_all">
2072 If true, every packet arriving or departing on any port is
2073 selected for mirroring.
2076 <column name="select_dst_port">
2077 Ports on which departing packets are selected for mirroring.
2080 <column name="select_src_port">
2081 Ports on which arriving packets are selected for mirroring.
2084 <column name="select_vlan">
2085 VLANs on which packets are selected for mirroring. An empty set
2086 selects packets on all VLANs.
2090 <group title="Mirroring Destination Configuration">
2092 These columns are mutually exclusive. Exactly one of them must be
2096 <column name="output_port">
2097 <p>Output port for selected packets, if nonempty.</p>
2098 <p>Specifying a port for mirror output reserves that port exclusively
2099 for mirroring. No frames other than those selected for mirroring
2101 will be forwarded to the port, and any frames received on the port
2102 will be discarded.</p>
2104 The output port may be any kind of port supported by Open vSwitch.
2105 It may be, for example, a physical port (sometimes called SPAN) or a
2110 <column name="output_vlan">
2111 <p>Output VLAN for selected packets, if nonempty.</p>
2112 <p>The frames will be sent out all ports that trunk
2113 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2114 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2115 trunk port, the frame's VLAN tag will be set to
2116 <ref column="output_vlan"/>, replacing any existing tag; when it is
2117 sent out an implicit VLAN port, the frame will not be tagged. This
2118 type of mirroring is sometimes called RSPAN.</p>
2120 The following destination MAC addresses will not be mirrored to a
2121 VLAN to avoid confusing switches that interpret the protocols that
2125 <dt><code>01:80:c2:00:00:00</code></dt>
2126 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
2128 <dt><code>01:80:c2:00:00:01</code></dt>
2129 <dd>IEEE Pause frame.</dd>
2131 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
2132 <dd>Other reserved protocols.</dd>
2134 <dt><code>01:00:0c:cc:cc:cc</code></dt>
2136 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
2137 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
2141 <dt><code>01:00:0c:cc:cc:cd</code></dt>
2142 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
2144 <dt><code>01:00:0c:cd:cd:cd</code></dt>
2145 <dd>Cisco STP Uplink Fast.</dd>
2147 <dt><code>01:00:0c:00:00:00</code></dt>
2148 <dd>Cisco Inter Switch Link.</dd>
2150 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2151 contains unmanaged switches. Consider an unmanaged physical switch
2152 with two ports: port 1, connected to an end host, and port 2,
2153 connected to an Open vSwitch configured to mirror received packets
2154 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2155 port 1 that the physical switch forwards to port 2. The Open vSwitch
2156 forwards this packet to its destination and then reflects it back on
2157 port 2 in VLAN 123. This reflected packet causes the unmanaged
2158 physical switch to replace the MAC learning table entry, which
2159 correctly pointed to port 1, with one that incorrectly points to port
2160 2. Afterward, the physical switch will direct packets destined for
2161 the end host to the Open vSwitch on port 2, instead of to the end
2162 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2163 desired in this scenario, then the physical switch must be replaced
2164 by one that learns Ethernet addresses on a per-VLAN basis. In
2165 addition, learning should be disabled on the VLAN containing mirrored
2166 traffic. If this is not done then intermediate switches will learn
2167 the MAC address of each end host from the mirrored traffic. If
2168 packets being sent to that end host are also mirrored, then they will
2169 be dropped since the switch will attempt to send them out the input
2170 port. Disabling learning for the VLAN will cause the switch to
2171 correctly send the packet out all ports configured for that VLAN. If
2172 Open vSwitch is being used as an intermediate switch, learning can be
2173 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2174 in the appropriate <ref table="Bridge"/> table or tables.</p>
2176 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2177 VLAN and should generally be preferred.
2182 <group title="Statistics: Mirror counters">
2184 Key-value pairs that report mirror statistics.
2186 <column name="statistics" key="tx_packets">
2187 Number of packets transmitted through this mirror.
2189 <column name="statistics" key="tx_bytes">
2190 Number of bytes transmitted through this mirror.
2194 <group title="Common Columns">
2195 The overall purpose of these columns is described under <code>Common
2196 Columns</code> at the beginning of this document.
2198 <column name="external_ids"/>
2202 <table name="Controller" title="OpenFlow controller configuration.">
2203 <p>An OpenFlow controller.</p>
2206 Open vSwitch supports two kinds of OpenFlow controllers:
2210 <dt>Primary controllers</dt>
2213 This is the kind of controller envisioned by the OpenFlow 1.0
2214 specification. Usually, a primary controller implements a network
2215 policy by taking charge of the switch's flow table.
2219 Open vSwitch initiates and maintains persistent connections to
2220 primary controllers, retrying the connection each time it fails or
2221 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2222 <ref table="Bridge"/> table applies to primary controllers.
2226 Open vSwitch permits a bridge to have any number of primary
2227 controllers. When multiple controllers are configured, Open
2228 vSwitch connects to all of them simultaneously. Because
2229 OpenFlow 1.0 does not specify how multiple controllers
2230 coordinate in interacting with a single switch, more than
2231 one primary controller should be specified only if the
2232 controllers are themselves designed to coordinate with each
2233 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2234 vendor extension may be useful for this.)
2237 <dt>Service controllers</dt>
2240 These kinds of OpenFlow controller connections are intended for
2241 occasional support and maintenance use, e.g. with
2242 <code>ovs-ofctl</code>. Usually a service controller connects only
2243 briefly to inspect or modify some of a switch's state.
2247 Open vSwitch listens for incoming connections from service
2248 controllers. The service controllers initiate and, if necessary,
2249 maintain the connections from their end. The <ref table="Bridge"
2250 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2251 not apply to service controllers.
2255 Open vSwitch supports configuring any number of service controllers.
2261 The <ref column="target"/> determines the type of controller.
2264 <group title="Core Features">
2265 <column name="target">
2266 <p>Connection method for controller.</p>
2268 The following connection methods are currently supported for primary
2272 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2274 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2275 the given <var>ip</var>, which must be expressed as an IP address
2276 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2277 column in the <ref table="Open_vSwitch"/> table must point to a
2278 valid SSL configuration when this form is used.</p>
2279 <p>SSL support is an optional feature that is not always built as
2280 part of Open vSwitch.</p>
2282 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2283 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2284 the given <var>ip</var>, which must be expressed as an IP address
2285 (not a DNS name).</dd>
2288 The following connection methods are currently supported for service
2292 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2295 Listens for SSL connections on the specified TCP <var>port</var>
2296 (default: 6633). If <var>ip</var>, which must be expressed as an
2297 IP address (not a DNS name), is specified, then connections are
2298 restricted to the specified local IP address.
2301 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2302 table="Open_vSwitch"/> table must point to a valid SSL
2303 configuration when this form is used.
2305 <p>SSL support is an optional feature that is not always built as
2306 part of Open vSwitch.</p>
2308 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2310 Listens for connections on the specified TCP <var>port</var>
2311 (default: 6633). If <var>ip</var>, which must be expressed as an
2312 IP address (not a DNS name), is specified, then connections are
2313 restricted to the specified local IP address.
2316 <p>When multiple controllers are configured for a single bridge, the
2317 <ref column="target"/> values must be unique. Duplicate
2318 <ref column="target"/> values yield unspecified results.</p>
2321 <column name="connection_mode">
2322 <p>If it is specified, this setting must be one of the following
2323 strings that describes how Open vSwitch contacts this OpenFlow
2324 controller over the network:</p>
2327 <dt><code>in-band</code></dt>
2328 <dd>In this mode, this controller's OpenFlow traffic travels over the
2329 bridge associated with the controller. With this setting, Open
2330 vSwitch allows traffic to and from the controller regardless of the
2331 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2332 would never be able to connect to the controller, because it did
2333 not have a flow to enable it.) This is the most common connection
2334 mode because it is not necessary to maintain two independent
2336 <dt><code>out-of-band</code></dt>
2337 <dd>In this mode, OpenFlow traffic uses a control network separate
2338 from the bridge associated with this controller, that is, the
2339 bridge does not use any of its own network devices to communicate
2340 with the controller. The control network must be configured
2341 separately, before or after <code>ovs-vswitchd</code> is started.
2345 <p>If not specified, the default is implementation-specific.</p>
2349 <group title="Controller Failure Detection and Handling">
2350 <column name="max_backoff">
2351 Maximum number of milliseconds to wait between connection attempts.
2352 Default is implementation-specific.
2355 <column name="inactivity_probe">
2356 Maximum number of milliseconds of idle time on connection to
2357 controller before sending an inactivity probe message. If Open
2358 vSwitch does not communicate with the controller for the specified
2359 number of seconds, it will send a probe. If a response is not
2360 received for the same additional amount of time, Open vSwitch
2361 assumes the connection has been broken and attempts to reconnect.
2362 Default is implementation-specific. A value of 0 disables
2367 <group title="OpenFlow Rate Limiting">
2368 <column name="controller_rate_limit">
2369 <p>The maximum rate at which packets in unknown flows will be
2370 forwarded to the OpenFlow controller, in packets per second. This
2371 feature prevents a single bridge from overwhelming the controller.
2372 If not specified, the default is implementation-specific.</p>
2373 <p>In addition, when a high rate triggers rate-limiting, Open
2374 vSwitch queues controller packets for each port and transmits
2375 them to the controller at the configured rate. The number of
2376 queued packets is limited by
2377 the <ref column="controller_burst_limit"/> value. The packet
2378 queue is shared fairly among the ports on a bridge.</p><p>Open
2379 vSwitch maintains two such packet rate-limiters per bridge.
2380 One of these applies to packets sent up to the controller
2381 because they do not correspond to any flow. The other applies
2382 to packets sent up to the controller by request through flow
2383 actions. When both rate-limiters are filled with packets, the
2384 actual rate that packets are sent to the controller is up to
2385 twice the specified rate.</p>
2388 <column name="controller_burst_limit">
2389 In conjunction with <ref column="controller_rate_limit"/>,
2390 the maximum number of unused packet credits that the bridge will
2391 allow to accumulate, in packets. If not specified, the default
2392 is implementation-specific.
2396 <group title="Additional In-Band Configuration">
2397 <p>These values are considered only in in-band control mode (see
2398 <ref column="connection_mode"/>).</p>
2400 <p>When multiple controllers are configured on a single bridge, there
2401 should be only one set of unique values in these columns. If different
2402 values are set for these columns in different controllers, the effect
2405 <column name="local_ip">
2406 The IP address to configure on the local port,
2407 e.g. <code>192.168.0.123</code>. If this value is unset, then
2408 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2412 <column name="local_netmask">
2413 The IP netmask to configure on the local port,
2414 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2415 but this value is unset, then the default is chosen based on whether
2416 the IP address is class A, B, or C.
2419 <column name="local_gateway">
2420 The IP address of the gateway to configure on the local port, as a
2421 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2422 this network has no gateway.
2426 <group title="Controller Status">
2427 <column name="is_connected">
2428 <code>true</code> if currently connected to this controller,
2429 <code>false</code> otherwise.
2433 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2434 <p>The level of authority this controller has on the associated
2435 bridge. Possible values are:</p>
2437 <dt><code>other</code></dt>
2438 <dd>Allows the controller access to all OpenFlow features.</dd>
2439 <dt><code>master</code></dt>
2440 <dd>Equivalent to <code>other</code>, except that there may be at
2441 most one master controller at a time. When a controller configures
2442 itself as <code>master</code>, any existing master is demoted to
2443 the <code>slave</code>role.</dd>
2444 <dt><code>slave</code></dt>
2445 <dd>Allows the controller read-only access to OpenFlow features.
2446 Attempts to modify the flow table will be rejected with an
2447 error. Slave controllers do not receive OFPT_PACKET_IN or
2448 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2453 <column name="status" key="last_error">
2454 A human-readable description of the last error on the connection
2455 to the controller; i.e. <code>strerror(errno)</code>. This key
2456 will exist only if an error has occurred.
2459 <column name="status" key="state"
2460 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2462 The state of the connection to the controller:
2465 <dt><code>VOID</code></dt>
2466 <dd>Connection is disabled.</dd>
2468 <dt><code>BACKOFF</code></dt>
2469 <dd>Attempting to reconnect at an increasing period.</dd>
2471 <dt><code>CONNECTING</code></dt>
2472 <dd>Attempting to connect.</dd>
2474 <dt><code>ACTIVE</code></dt>
2475 <dd>Connected, remote host responsive.</dd>
2477 <dt><code>IDLE</code></dt>
2478 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2481 These values may change in the future. They are provided only for
2486 <column name="status" key="sec_since_connect"
2487 type='{"type": "integer", "minInteger": 0}'>
2488 The amount of time since this controller last successfully connected to
2489 the switch (in seconds). Value is empty if controller has never
2490 successfully connected.
2493 <column name="status" key="sec_since_disconnect"
2494 type='{"type": "integer", "minInteger": 1}'>
2495 The amount of time since this controller last disconnected from
2496 the switch (in seconds). Value is empty if controller has never
2501 <group title="Common Columns">
2502 The overall purpose of these columns is described under <code>Common
2503 Columns</code> at the beginning of this document.
2505 <column name="external_ids"/>
2509 <table name="Manager" title="OVSDB management connection.">
2511 Configuration for a database connection to an Open vSwitch database
2516 This table primarily configures the Open vSwitch database
2517 (<code>ovsdb-server</code>), not the Open vSwitch switch
2518 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2519 what connections should be treated as in-band.
2523 The Open vSwitch database server can initiate and maintain active
2524 connections to remote clients. It can also listen for database
2528 <group title="Core Features">
2529 <column name="target">
2530 <p>Connection method for managers.</p>
2532 The following connection methods are currently supported:
2535 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2538 The specified SSL <var>port</var> (default: 6632) on the host at
2539 the given <var>ip</var>, which must be expressed as an IP address
2540 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2541 column in the <ref table="Open_vSwitch"/> table must point to a
2542 valid SSL configuration when this form is used.
2545 SSL support is an optional feature that is not always built as
2546 part of Open vSwitch.
2550 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2552 The specified TCP <var>port</var> (default: 6632) on the host at
2553 the given <var>ip</var>, which must be expressed as an IP address
2556 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2559 Listens for SSL connections on the specified TCP <var>port</var>
2560 (default: 6632). If <var>ip</var>, which must be expressed as an
2561 IP address (not a DNS name), is specified, then connections are
2562 restricted to the specified local IP address.
2565 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2566 table="Open_vSwitch"/> table must point to a valid SSL
2567 configuration when this form is used.
2570 SSL support is an optional feature that is not always built as
2571 part of Open vSwitch.
2574 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2576 Listens for connections on the specified TCP <var>port</var>
2577 (default: 6632). If <var>ip</var>, which must be expressed as an
2578 IP address (not a DNS name), is specified, then connections are
2579 restricted to the specified local IP address.
2582 <p>When multiple managers are configured, the <ref column="target"/>
2583 values must be unique. Duplicate <ref column="target"/> values yield
2584 unspecified results.</p>
2587 <column name="connection_mode">
2589 If it is specified, this setting must be one of the following strings
2590 that describes how Open vSwitch contacts this OVSDB client over the
2595 <dt><code>in-band</code></dt>
2597 In this mode, this connection's traffic travels over a bridge
2598 managed by Open vSwitch. With this setting, Open vSwitch allows
2599 traffic to and from the client regardless of the contents of the
2600 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2601 to connect to the client, because it did not have a flow to enable
2602 it.) This is the most common connection mode because it is not
2603 necessary to maintain two independent networks.
2605 <dt><code>out-of-band</code></dt>
2607 In this mode, the client's traffic uses a control network separate
2608 from that managed by Open vSwitch, that is, Open vSwitch does not
2609 use any of its own network devices to communicate with the client.
2610 The control network must be configured separately, before or after
2611 <code>ovs-vswitchd</code> is started.
2616 If not specified, the default is implementation-specific.
2621 <group title="Client Failure Detection and Handling">
2622 <column name="max_backoff">
2623 Maximum number of milliseconds to wait between connection attempts.
2624 Default is implementation-specific.
2627 <column name="inactivity_probe">
2628 Maximum number of milliseconds of idle time on connection to the client
2629 before sending an inactivity probe message. If Open vSwitch does not
2630 communicate with the client for the specified number of seconds, it
2631 will send a probe. If a response is not received for the same
2632 additional amount of time, Open vSwitch assumes the connection has been
2633 broken and attempts to reconnect. Default is implementation-specific.
2634 A value of 0 disables inactivity probes.
2638 <group title="Status">
2639 <column name="is_connected">
2640 <code>true</code> if currently connected to this manager,
2641 <code>false</code> otherwise.
2644 <column name="status" key="last_error">
2645 A human-readable description of the last error on the connection
2646 to the manager; i.e. <code>strerror(errno)</code>. This key
2647 will exist only if an error has occurred.
2650 <column name="status" key="state"
2651 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2653 The state of the connection to the manager:
2656 <dt><code>VOID</code></dt>
2657 <dd>Connection is disabled.</dd>
2659 <dt><code>BACKOFF</code></dt>
2660 <dd>Attempting to reconnect at an increasing period.</dd>
2662 <dt><code>CONNECTING</code></dt>
2663 <dd>Attempting to connect.</dd>
2665 <dt><code>ACTIVE</code></dt>
2666 <dd>Connected, remote host responsive.</dd>
2668 <dt><code>IDLE</code></dt>
2669 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2672 These values may change in the future. They are provided only for
2677 <column name="status" key="sec_since_connect"
2678 type='{"type": "integer", "minInteger": 0}'>
2679 The amount of time since this manager last successfully connected
2680 to the database (in seconds). Value is empty if manager has never
2681 successfully connected.
2684 <column name="status" key="sec_since_disconnect"
2685 type='{"type": "integer", "minInteger": 0}'>
2686 The amount of time since this manager last disconnected from the
2687 database (in seconds). Value is empty if manager has never
2691 <column name="status" key="locks_held">
2692 Space-separated list of the names of OVSDB locks that the connection
2693 holds. Omitted if the connection does not hold any locks.
2696 <column name="status" key="locks_waiting">
2697 Space-separated list of the names of OVSDB locks that the connection is
2698 currently waiting to acquire. Omitted if the connection is not waiting
2702 <column name="status" key="locks_lost">
2703 Space-separated list of the names of OVSDB locks that the connection
2704 has had stolen by another OVSDB client. Omitted if no locks have been
2705 stolen from this connection.
2708 <column name="status" key="n_connections"
2709 type='{"type": "integer", "minInteger": 2}'>
2711 When <ref column="target"/> specifies a connection method that
2712 listens for inbound connections (e.g. <code>ptcp:</code> or
2713 <code>pssl:</code>) and more than one connection is actually active,
2714 the value is the number of active connections. Otherwise, this
2715 key-value pair is omitted.
2718 When multiple connections are active, status columns and key-value
2719 pairs (other than this one) report the status of one arbitrarily
2725 <group title="Common Columns">
2726 The overall purpose of these columns is described under <code>Common
2727 Columns</code> at the beginning of this document.
2729 <column name="external_ids"/>
2733 <table name="NetFlow">
2734 A NetFlow target. NetFlow is a protocol that exports a number of
2735 details about terminating IP flows, such as the principals involved
2738 <column name="targets">
2739 NetFlow targets in the form
2740 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2741 must be specified numerically, not as a DNS name.
2744 <column name="engine_id">
2745 Engine ID to use in NetFlow messages. Defaults to datapath index
2749 <column name="engine_type">
2750 Engine type to use in NetFlow messages. Defaults to datapath
2751 index if not specified.
2754 <column name="active_timeout">
2755 The interval at which NetFlow records are sent for flows that are
2756 still active, in seconds. A value of <code>0</code> requests the
2757 default timeout (currently 600 seconds); a value of <code>-1</code>
2758 disables active timeouts.
2761 <column name="add_id_to_interface">
2762 <p>If this column's value is <code>false</code>, the ingress and egress
2763 interface fields of NetFlow flow records are derived from OpenFlow port
2764 numbers. When it is <code>true</code>, the 7 most significant bits of
2765 these fields will be replaced by the least significant 7 bits of the
2766 engine id. This is useful because many NetFlow collectors do not
2767 expect multiple switches to be sending messages from the same host, so
2768 they do not store the engine information which could be used to
2769 disambiguate the traffic.</p>
2770 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2773 <group title="Common Columns">
2774 The overall purpose of these columns is described under <code>Common
2775 Columns</code> at the beginning of this document.
2777 <column name="external_ids"/>
2782 SSL configuration for an Open_vSwitch.
2784 <column name="private_key">
2785 Name of a PEM file containing the private key used as the switch's
2786 identity for SSL connections to the controller.
2789 <column name="certificate">
2790 Name of a PEM file containing a certificate, signed by the
2791 certificate authority (CA) used by the controller and manager,
2792 that certifies the switch's private key, identifying a trustworthy
2796 <column name="ca_cert">
2797 Name of a PEM file containing the CA certificate used to verify
2798 that the switch is connected to a trustworthy controller.
2801 <column name="bootstrap_ca_cert">
2802 If set to <code>true</code>, then Open vSwitch will attempt to
2803 obtain the CA certificate from the controller on its first SSL
2804 connection and save it to the named PEM file. If it is successful,
2805 it will immediately drop the connection and reconnect, and from then
2806 on all SSL connections must be authenticated by a certificate signed
2807 by the CA certificate thus obtained. <em>This option exposes the
2808 SSL connection to a man-in-the-middle attack obtaining the initial
2809 CA certificate.</em> It may still be useful for bootstrapping.
2812 <group title="Common Columns">
2813 The overall purpose of these columns is described under <code>Common
2814 Columns</code> at the beginning of this document.
2816 <column name="external_ids"/>
2820 <table name="sFlow">
2821 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2824 <column name="agent">
2825 Name of the network device whose IP address should be reported as the
2826 ``agent address'' to collectors. If not specified, the agent device is
2827 figured from the first target address and the routing table. If the
2828 routing table does not contain a route to the target, the IP address
2829 defaults to the <ref table="Controller" column="local_ip"/> in the
2830 collector's <ref table="Controller"/>. If an agent IP address cannot be
2831 determined any of these ways, sFlow is disabled.
2834 <column name="header">
2835 Number of bytes of a sampled packet to send to the collector.
2836 If not specified, the default is 128 bytes.
2839 <column name="polling">
2840 Polling rate in seconds to send port statistics to the collector.
2841 If not specified, defaults to 30 seconds.
2844 <column name="sampling">
2845 Rate at which packets should be sampled and sent to the collector.
2846 If not specified, defaults to 400, which means one out of 400
2847 packets, on average, will be sent to the collector.
2850 <column name="targets">
2851 sFlow targets in the form
2852 <code><var>ip</var>:<var>port</var></code>.
2855 <group title="Common Columns">
2856 The overall purpose of these columns is described under <code>Common
2857 Columns</code> at the beginning of this document.
2859 <column name="external_ids"/>
2863 <table name="Capability">
2864 <p>Records in this table describe functionality supported by the hardware
2865 and software platform on which this Open vSwitch is based. Clients
2866 should not modify this table.</p>
2868 <p>A record in this table is meaningful only if it is referenced by the
2869 <ref table="Open_vSwitch" column="capabilities"/> column in the
2870 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2871 the record's ``category,'' determines the meanings of the
2872 <ref column="details"/> column. The following general forms of
2873 categories are currently defined:</p>
2876 <dt><code>qos-<var>type</var></code></dt>
2877 <dd><var>type</var> is supported as the value for
2878 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2882 <column name="details">
2883 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2884 depends on the category key that the <ref table="Open_vSwitch"
2885 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2886 uses to reference this record, as described above.</p>
2888 <p>The presence of a record for category <code>qos-<var>type</var></code>
2889 indicates that the switch supports <var>type</var> as the value of
2890 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2891 table. The following key-value pairs are defined to further describe
2892 QoS capabilities:</p>
2895 <dt><code>n-queues</code></dt>
2896 <dd>Number of supported queues, as a positive integer. Keys in the
2897 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2898 records whose <ref table="QoS" column="type"/> value
2899 equals <var>type</var> must range between 0 and this value minus one,