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>.
75 <column name="other_config" key="flow-restore-wait"
76 type='{"type": "boolean"}'>
78 When <code>ovs-vswitchd</code> starts up, it has an empty flow table
79 and therefore it handles all arriving packets in its default fashion
80 according to its configuration, by dropping them or sending them to
81 an OpenFlow controller or switching them as a standalone switch.
82 This behavior is ordinarily desirable. However, if
83 <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
84 then this leads to a relatively long period during which packets are
88 This option allows for improvement. When <code>ovs-vswitchd</code>
89 starts with this value set as <code>true</code>, it will neither
90 flush or expire previously set datapath flows nor will it send and
91 receive any packets to or from the datapath. When this value is
92 later set to <code>false</code>, <code>ovs-vswitchd</code> will
93 start receiving packets from the datapath and re-setup the flows.
96 Thus, with this option, the procedure for a hot-upgrade of
97 <code>ovs-vswitchd</code> becomes roughly the following:
101 Stop <code>ovs-vswitchd</code>.
104 Set <ref column="other_config" key="flow-restore-wait"/>
105 to <code>true</code>.
108 Start <code>ovs-vswitchd</code>.
111 Use <code>ovs-ofctl</code> (or some other program, such as an
112 OpenFlow controller) to restore the OpenFlow flow table
113 to the desired state.
116 Set <ref column="other_config" key="flow-restore-wait"/>
117 to <code>false</code> (or remove it entirely from the database).
121 The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
122 functions use the above config option during hot upgrades.
127 <group title="Status">
128 <column name="next_cfg">
129 Sequence number for client to increment. When a client modifies
130 any part of the database configuration and wishes to wait for
131 Open vSwitch to finish applying the changes, it may increment
132 this sequence number.
135 <column name="cur_cfg">
136 Sequence number that Open vSwitch sets to the current value of
137 <ref column="next_cfg"/> after it finishes applying a set of
138 configuration changes.
141 <group title="Statistics">
143 The <code>statistics</code> column contains key-value pairs that
144 report statistics about a system running an Open vSwitch. These are
145 updated periodically (currently, every 5 seconds). Key-value pairs
146 that cannot be determined or that do not apply to a platform are
150 <column name="other_config" key="enable-statistics"
151 type='{"type": "boolean"}'>
152 Statistics are disabled by default to avoid overhead in the common
153 case when statistics gathering is not useful. Set this value to
154 <code>true</code> to enable populating the <ref column="statistics"/>
155 column or to <code>false</code> to explicitly disable it.
158 <column name="statistics" key="cpu"
159 type='{"type": "integer", "minInteger": 1}'>
161 Number of CPU processors, threads, or cores currently online and
162 available to the operating system on which Open vSwitch is running,
163 as an integer. This may be less than the number installed, if some
164 are not online or if they are not available to the operating
168 Open vSwitch userspace processes are not multithreaded, but the
169 Linux kernel-based datapath is.
173 <column name="statistics" key="load_average">
174 A comma-separated list of three floating-point numbers,
175 representing the system load average over the last 1, 5, and 15
176 minutes, respectively.
179 <column name="statistics" key="memory">
181 A comma-separated list of integers, each of which represents a
182 quantity of memory in kilobytes that describes the operating
183 system on which Open vSwitch is running. In respective order,
188 <li>Total amount of RAM allocated to the OS.</li>
189 <li>RAM allocated to the OS that is in use.</li>
190 <li>RAM that can be flushed out to disk or otherwise discarded
191 if that space is needed for another purpose. This number is
192 necessarily less than or equal to the previous value.</li>
193 <li>Total disk space allocated for swap.</li>
194 <li>Swap space currently in use.</li>
198 On Linux, all five values can be determined and are included. On
199 other operating systems, only the first two values can be
200 determined, so the list will only have two values.
204 <column name="statistics" key="process_NAME">
206 One such key-value pair, with <code>NAME</code> replaced by
207 a process name, will exist for each running Open vSwitch
208 daemon process, with <var>name</var> replaced by the
209 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
210 value is a comma-separated list of integers. The integers
211 represent the following, with memory measured in kilobytes
212 and durations in milliseconds:
216 <li>The process's virtual memory size.</li>
217 <li>The process's resident set size.</li>
218 <li>The amount of user and system CPU time consumed by the
220 <li>The number of times that the process has crashed and been
221 automatically restarted by the monitor.</li>
222 <li>The duration since the process was started.</li>
223 <li>The duration for which the process has been running.</li>
227 The interpretation of some of these values depends on whether the
228 process was started with the <option>--monitor</option>. If it
229 was not, then the crash count will always be 0 and the two
230 durations will always be the same. If <option>--monitor</option>
231 was given, then the crash count may be positive; if it is, the
232 latter duration is the amount of time since the most recent crash
237 There will be one key-value pair for each file in Open vSwitch's
238 ``run directory'' (usually <code>/var/run/openvswitch</code>)
239 whose name ends in <code>.pid</code>, whose contents are a
240 process ID, and which is locked by a running process. The
241 <var>name</var> is taken from the pidfile's name.
245 Currently Open vSwitch is only able to obtain all of the above
246 detail on Linux systems. On other systems, the same key-value
247 pairs will be present but the values will always be the empty
252 <column name="statistics" key="file_systems">
254 A space-separated list of information on local, writable file
255 systems. Each item in the list describes one file system and
256 consists in turn of a comma-separated list of the following:
260 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
261 Any spaces or commas in the mount point are replaced by
263 <li>Total size, in kilobytes, as an integer.</li>
264 <li>Amount of storage in use, in kilobytes, as an integer.</li>
268 This key-value pair is omitted if there are no local, writable
269 file systems or if Open vSwitch cannot obtain the needed
276 <group title="Version Reporting">
278 These columns report the types and versions of the hardware and
279 software running Open vSwitch. We recommend in general that software
280 should test whether specific features are supported instead of relying
281 on version number checks. These values are primarily intended for
282 reporting to human administrators.
285 <column name="ovs_version">
286 The Open vSwitch version number, e.g. <code>1.1.0</code>.
289 <column name="db_version">
291 The database schema version number in the form
292 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
293 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
294 a non-backward compatible way (e.g. deleting a column or a table),
295 <var>major</var> is incremented. When the database schema is changed
296 in a backward compatible way (e.g. adding a new column),
297 <var>minor</var> is incremented. When the database schema is changed
298 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
303 The schema version is part of the database schema, so it can also be
304 retrieved by fetching the schema using the Open vSwitch database
309 <column name="system_type">
311 An identifier for the type of system on top of which Open vSwitch
312 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
315 System integrators are responsible for choosing and setting an
316 appropriate value for this column.
320 <column name="system_version">
322 The version of the system identified by <ref column="system_type"/>,
323 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
326 System integrators are responsible for choosing and setting an
327 appropriate value for this column.
333 <group title="Database Configuration">
335 These columns primarily configure the Open vSwitch database
336 (<code>ovsdb-server</code>), not the Open vSwitch switch
337 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
338 column="ssl"/> settings.
342 The Open vSwitch switch does read the database configuration to
343 determine remote IP addresses to which in-band control should apply.
346 <column name="manager_options">
347 Database clients to which the Open vSwitch database server should
348 connect or to which it should listen, along with options for how these
349 connection should be configured. See the <ref table="Manager"/> table
350 for more information.
354 <group title="Common Columns">
355 The overall purpose of these columns is described under <code>Common
356 Columns</code> at the beginning of this document.
358 <column name="other_config"/>
359 <column name="external_ids"/>
363 <table name="Bridge">
365 Configuration for a bridge within an
366 <ref table="Open_vSwitch"/>.
369 A <ref table="Bridge"/> record represents an Ethernet switch with one or
370 more ``ports,'' which are the <ref table="Port"/> records pointed to by
371 the <ref table="Bridge"/>'s <ref column="ports"/> column.
374 <group title="Core Features">
376 Bridge identifier. Should be alphanumeric and no more than about 8
377 bytes long. Must be unique among the names of ports, interfaces, and
381 <column name="ports">
382 Ports included in the bridge.
385 <column name="mirrors">
386 Port mirroring configuration.
389 <column name="netflow">
390 NetFlow configuration.
393 <column name="sflow">
394 sFlow(R) configuration.
397 <column name="ipfix">
401 <column name="flood_vlans">
403 VLAN IDs of VLANs on which MAC address learning should be disabled,
404 so that packets are flooded instead of being sent to specific ports
405 that are believed to contain packets' destination MACs. This should
406 ordinarily be used to disable MAC learning on VLANs used for
407 mirroring (RSPAN VLANs). It may also be useful for debugging.
410 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
411 the <ref table="Port"/> table) is incompatible with
412 <code>flood_vlans</code>. Consider using another bonding mode or
413 a different type of mirror instead.
418 <group title="OpenFlow Configuration">
419 <column name="controller">
421 OpenFlow controller set. If unset, then no OpenFlow controllers
426 If there are primary controllers, removing all of them clears the
427 flow table. If there are no primary controllers, adding one also
428 clears the flow table. Other changes to the set of controllers, such
429 as adding or removing a service controller, adding another primary
430 controller to supplement an existing primary controller, or removing
431 only one of two primary controllers, have no effect on the flow
436 <column name="flow_tables">
437 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
438 table ID to configuration for that table.
441 <column name="fail_mode">
442 <p>When a controller is configured, it is, ordinarily, responsible
443 for setting up all flows on the switch. Thus, if the connection to
444 the controller fails, no new network connections can be set up.
445 If the connection to the controller stays down long enough,
446 no packets can pass through the switch at all. This setting
447 determines the switch's response to such a situation. It may be set
448 to one of the following:
450 <dt><code>standalone</code></dt>
451 <dd>If no message is received from the controller for three
452 times the inactivity probe interval
453 (see <ref column="inactivity_probe"/>), then Open vSwitch
454 will take over responsibility for setting up flows. In
455 this mode, Open vSwitch causes the bridge to act like an
456 ordinary MAC-learning switch. Open vSwitch will continue
457 to retry connecting to the controller in the background
458 and, when the connection succeeds, it will discontinue its
459 standalone behavior.</dd>
460 <dt><code>secure</code></dt>
461 <dd>Open vSwitch will not set up flows on its own when the
462 controller connection fails or when no controllers are
463 defined. The bridge will continue to retry connecting to
464 any defined controllers forever.</dd>
468 The default is <code>standalone</code> if the value is unset, but
469 future versions of Open vSwitch may change the default.
472 The <code>standalone</code> mode can create forwarding loops on a
473 bridge that has more than one uplink port unless STP is enabled. To
474 avoid loops on such a bridge, configure <code>secure</code> mode or
475 enable STP (see <ref column="stp_enable"/>).
477 <p>When more than one controller is configured,
478 <ref column="fail_mode"/> is considered only when none of the
479 configured controllers can be contacted.</p>
481 Changing <ref column="fail_mode"/> when no primary controllers are
482 configured clears the flow table.
486 <column name="datapath_id">
487 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
488 (Setting this column has no useful effect. Set <ref
489 column="other-config" key="datapath-id"/> instead.)
492 <column name="other_config" key="datapath-id">
493 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
494 value. May not be all-zero.
497 <column name="other_config" key="dp-desc">
498 Human readable description of datapath. It it a maximum 256
499 byte-long free-form string to describe the datapath for
500 debugging purposes, e.g. <code>switch3 in room 3120</code>.
503 <column name="other_config" key="disable-in-band"
504 type='{"type": "boolean"}'>
505 If set to <code>true</code>, disable in-band control on the bridge
506 regardless of controller and manager settings.
509 <column name="other_config" key="in-band-queue"
510 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
511 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
512 that will be used by flows set up by in-band control on this bridge.
513 If unset, or if the port used by an in-band control flow does not have
514 QoS configured, or if the port does not have a queue with the specified
515 ID, the default queue is used instead.
518 <column name="protocols">
519 List of OpenFlow protocols that may be used when negotiating a
520 connection with a controller. A default value of
521 <code>OpenFlow10</code> will be used if this column is empty.
525 <group title="Spanning Tree Configuration">
526 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
527 that ensures loop-free topologies. It allows redundant links to
528 be included in the network to provide automatic backup paths if
529 the active links fails.
531 <column name="stp_enable">
532 Enable spanning tree on the bridge. By default, STP is disabled
533 on bridges. Bond, internal, and mirror ports are not supported
534 and will not participate in the spanning tree.
537 <column name="other_config" key="stp-system-id">
538 The bridge's STP identifier (the lower 48 bits of the bridge-id)
540 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
541 By default, the identifier is the MAC address of the bridge.
544 <column name="other_config" key="stp-priority"
545 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
546 The bridge's relative priority value for determining the root
547 bridge (the upper 16 bits of the bridge-id). A bridge with the
548 lowest bridge-id is elected the root. By default, the priority
552 <column name="other_config" key="stp-hello-time"
553 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
554 The interval between transmissions of hello messages by
555 designated ports, in seconds. By default the hello interval is
559 <column name="other_config" key="stp-max-age"
560 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
561 The maximum age of the information transmitted by the bridge
562 when it is the root bridge, in seconds. By default, the maximum
566 <column name="other_config" key="stp-forward-delay"
567 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
568 The delay to wait between transitioning root and designated
569 ports to <code>forwarding</code>, in seconds. By default, the
570 forwarding delay is 15 seconds.
574 <group title="Other Features">
575 <column name="datapath_type">
576 Name of datapath provider. The kernel datapath has
577 type <code>system</code>. The userspace datapath has
578 type <code>netdev</code>.
581 <column name="external_ids" key="bridge-id">
582 A unique identifier of the bridge. On Citrix XenServer this will
583 commonly be the same as
584 <ref column="external_ids" key="xs-network-uuids"/>.
587 <column name="external_ids" key="xs-network-uuids">
588 Semicolon-delimited set of universally unique identifier(s) for the
589 network with which this bridge is associated on a Citrix XenServer
590 host. The network identifiers are RFC 4122 UUIDs as displayed by,
591 e.g., <code>xe network-list</code>.
594 <column name="other_config" key="hwaddr">
595 An Ethernet address in the form
596 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
597 to set the hardware address of the local port and influence the
601 <column name="other_config" key="flow-eviction-threshold"
602 type='{"type": "integer", "minInteger": 0}'>
604 A number of flows as a nonnegative integer. This sets number of
605 flows at which eviction from the kernel flow table will be triggered.
606 If there are a large number of flows then increasing this value to
607 around the number of flows present can result in reduced CPU usage
611 The default is 2500. Values below 100 will be rounded up to 100.
615 <column name="other_config" key="forward-bpdu"
616 type='{"type": "boolean"}'>
617 Option to allow forwarding of BPDU frames when NORMAL action is
618 invoked. Frames with reserved Ethernet addresses (e.g. STP
619 BPDU) will be forwarded when this option is enabled and the
620 switch is not providing that functionality. If STP is enabled
621 on the port, STP BPDUs will never be forwarded. If the Open
622 vSwitch bridge is used to connect different Ethernet networks,
623 and if Open vSwitch node does not run STP, then this option
624 should be enabled. Default is disabled, set to
625 <code>true</code> to enable.
627 The following destination MAC addresss will not be forwarded when this
630 <dt><code>01:80:c2:00:00:00</code></dt>
631 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
633 <dt><code>01:80:c2:00:00:01</code></dt>
634 <dd>IEEE Pause frame.</dd>
636 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
637 <dd>Other reserved protocols.</dd>
639 <dt><code>00:e0:2b:00:00:00</code></dt>
640 <dd>Extreme Discovery Protocol (EDP).</dd>
643 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
645 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
647 <dt><code>01:00:0c:cc:cc:cc</code></dt>
649 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
650 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
654 <dt><code>01:00:0c:cc:cc:cd</code></dt>
655 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
657 <dt><code>01:00:0c:cd:cd:cd</code></dt>
658 <dd>Cisco STP Uplink Fast.</dd>
660 <dt><code>01:00:0c:00:00:00</code></dt>
661 <dd>Cisco Inter Switch Link.</dd>
663 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
668 <column name="other_config" key="mac-aging-time"
669 type='{"type": "integer", "minInteger": 1}'>
671 The maximum number of seconds to retain a MAC learning entry for
672 which no packets have been seen. The default is currently 300
673 seconds (5 minutes). The value, if specified, is forced into a
674 reasonable range, currently 15 to 3600 seconds.
678 A short MAC aging time allows a network to more quickly detect that a
679 host is no longer connected to a switch port. However, it also makes
680 it more likely that packets will be flooded unnecessarily, when they
681 are addressed to a connected host that rarely transmits packets. To
682 reduce the incidence of unnecessary flooding, use a MAC aging time
683 longer than the maximum interval at which a host will ordinarily
688 <column name="other_config" key="mac-table-size"
689 type='{"type": "integer", "minInteger": 1}'>
691 The maximum number of MAC addresses to learn. The default is
692 currently 2048. The value, if specified, is forced into a reasonable
693 range, currently 10 to 1,000,000.
698 <group title="Bridge Status">
700 Status information about bridges.
702 <column name="status">
703 Key-value pairs that report bridge status.
705 <column name="status" key="stp_bridge_id">
707 The bridge-id (in hex) used in spanning tree advertisements.
708 Configuring the bridge-id is described in the
709 <code>stp-system-id</code> and <code>stp-priority</code> keys
710 of the <code>other_config</code> section earlier.
713 <column name="status" key="stp_designated_root">
715 The designated root (in hex) for this spanning tree.
718 <column name="status" key="stp_root_path_cost">
720 The path cost of reaching the designated bridge. A lower
726 <group title="Common Columns">
727 The overall purpose of these columns is described under <code>Common
728 Columns</code> at the beginning of this document.
730 <column name="other_config"/>
731 <column name="external_ids"/>
735 <table name="Port" table="Port or bond configuration.">
736 <p>A port within a <ref table="Bridge"/>.</p>
737 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
738 <ref column="interfaces"/> column. Such a port logically
739 corresponds to a port on a physical Ethernet switch. A port
740 with more than one interface is a ``bonded port'' (see
741 <ref group="Bonding Configuration"/>).</p>
742 <p>Some properties that one might think as belonging to a port are actually
743 part of the port's <ref table="Interface"/> members.</p>
746 Port name. Should be alphanumeric and no more than about 8
747 bytes long. May be the same as the interface name, for
748 non-bonded ports. Must otherwise be unique among the names of
749 ports, interfaces, and bridges on a host.
752 <column name="interfaces">
753 The port's interfaces. If there is more than one, this is a
757 <group title="VLAN Configuration">
758 <p>Bridge ports support the following types of VLAN configuration:</p>
763 A trunk port carries packets on one or more specified VLANs
764 specified in the <ref column="trunks"/> column (often, on every
765 VLAN). A packet that ingresses on a trunk port is in the VLAN
766 specified in its 802.1Q header, or VLAN 0 if the packet has no
767 802.1Q header. A packet that egresses through a trunk port will
768 have an 802.1Q header if it has a nonzero VLAN ID.
772 Any packet that ingresses on a trunk port tagged with a VLAN that
773 the port does not trunk is dropped.
780 An access port carries packets on exactly one VLAN specified in the
781 <ref column="tag"/> column. Packets egressing on an access port
782 have no 802.1Q header.
786 Any packet with an 802.1Q header with a nonzero VLAN ID that
787 ingresses on an access port is dropped, regardless of whether the
788 VLAN ID in the header is the access port's VLAN ID.
792 <dt>native-tagged</dt>
794 A native-tagged port resembles a trunk port, with the exception that
795 a packet without an 802.1Q header that ingresses on a native-tagged
796 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
800 <dt>native-untagged</dt>
802 A native-untagged port resembles a native-tagged port, with the
803 exception that a packet that egresses on a native-untagged port in
804 the native VLAN will not have an 802.1Q header.
808 A packet will only egress through bridge ports that carry the VLAN of
809 the packet, as described by the rules above.
812 <column name="vlan_mode">
814 The VLAN mode of the port, as described above. When this column is
815 empty, a default mode is selected as follows:
819 If <ref column="tag"/> contains a value, the port is an access
820 port. The <ref column="trunks"/> column should be empty.
823 Otherwise, the port is a trunk port. The <ref column="trunks"/>
824 column value is honored if it is present.
831 For an access port, the port's implicitly tagged VLAN. For a
832 native-tagged or native-untagged port, the port's native VLAN. Must
833 be empty if this is a trunk port.
837 <column name="trunks">
839 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
840 or VLANs that this port trunks; if it is empty, then the port trunks
841 all VLANs. Must be empty if this is an access port.
844 A native-tagged or native-untagged port always trunks its native
845 VLAN, regardless of whether <ref column="trunks"/> includes that
850 <column name="other_config" key="priority-tags"
851 type='{"type": "boolean"}'>
853 An 802.1Q header contains two important pieces of information: a VLAN
854 ID and a priority. A frame with a zero VLAN ID, called a
855 ``priority-tagged'' frame, is supposed to be treated the same way as
856 a frame without an 802.1Q header at all (except for the priority).
860 However, some network elements ignore any frame that has 802.1Q
861 header at all, even when the VLAN ID is zero. Therefore, by default
862 Open vSwitch does not output priority-tagged frames, instead omitting
863 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
864 <code>true</code> to enable priority-tagged frames on a port.
868 Regardless of this setting, Open vSwitch omits the 802.1Q header on
869 output if both the VLAN ID and priority would be zero.
873 All frames output to native-tagged ports have a nonzero VLAN ID, so
874 this setting is not meaningful on native-tagged ports.
879 <group title="Bonding Configuration">
880 <p>A port that has more than one interface is a ``bonded port.'' Bonding
881 allows for load balancing and fail-over.</p>
884 The following types of bonding will work with any kind of upstream
885 switch. On the upstream switch, do not configure the interfaces as a
890 <dt><code>balance-slb</code></dt>
892 Balances flows among slaves based on source MAC address and output
893 VLAN, with periodic rebalancing as traffic patterns change.
896 <dt><code>active-backup</code></dt>
898 Assigns all flows to one slave, failing over to a backup slave when
899 the active slave is disabled. This is the only bonding mode in which
900 interfaces may be plugged into different upstream switches.
905 The following modes require the upstream switch to support 802.3ad with
906 successful LACP negotiation:
910 <dt><code>balance-tcp</code></dt>
912 Balances flows among slaves based on L2, L3, and L4 protocol
913 information such as destination MAC address, IP address, and TCP
918 <p>These columns apply only to bonded ports. Their values are
919 otherwise ignored.</p>
921 <column name="bond_mode">
922 <p>The type of bonding used for a bonded port. Defaults to
923 <code>active-backup</code> if unset.
927 <column name="other_config" key="bond-hash-basis"
928 type='{"type": "integer"}'>
929 An integer hashed along with flows when choosing output slaves in load
930 balanced bonds. When changed, all flows will be assigned different
931 hash values possibly causing slave selection decisions to change. Does
932 not affect bonding modes which do not employ load balancing such as
933 <code>active-backup</code>.
936 <group title="Link Failure Detection">
938 An important part of link bonding is detecting that links are down so
939 that they may be disabled. These settings determine how Open vSwitch
940 detects link failure.
943 <column name="other_config" key="bond-detect-mode"
944 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
945 The means used to detect link failures. Defaults to
946 <code>carrier</code> which uses each interface's carrier to detect
947 failures. When set to <code>miimon</code>, will check for failures
948 by polling each interface's MII.
951 <column name="other_config" key="bond-miimon-interval"
952 type='{"type": "integer"}'>
953 The interval, in milliseconds, between successive attempts to poll
954 each interface's MII. Relevant only when <ref column="other_config"
955 key="bond-detect-mode"/> is <code>miimon</code>.
958 <column name="bond_updelay">
960 The number of milliseconds for which the link must stay up on an
961 interface before the interface is considered to be up. Specify
962 <code>0</code> to enable the interface immediately.
966 This setting is honored only when at least one bonded interface is
967 already enabled. When no interfaces are enabled, then the first
968 bond interface to come up is enabled immediately.
972 <column name="bond_downdelay">
973 The number of milliseconds for which the link must stay down on an
974 interface before the interface is considered to be down. Specify
975 <code>0</code> to disable the interface immediately.
979 <group title="LACP Configuration">
981 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
982 allows switches to automatically detect that they are connected by
983 multiple links and aggregate across those links. These settings
984 control LACP behavior.
988 Configures LACP on this port. LACP allows directly connected
989 switches to negotiate which links may be bonded. LACP may be enabled
990 on non-bonded ports for the benefit of any switches they may be
991 connected to. <code>active</code> ports are allowed to initiate LACP
992 negotiations. <code>passive</code> ports are allowed to participate
993 in LACP negotiations initiated by a remote switch, but not allowed to
994 initiate such negotiations themselves. If LACP is enabled on a port
995 whose partner switch does not support LACP, the bond will be
996 disabled. Defaults to <code>off</code> if unset.
999 <column name="other_config" key="lacp-system-id">
1000 The LACP system ID of this <ref table="Port"/>. The system ID of a
1001 LACP bond is used to identify itself to its partners. Must be a
1002 nonzero MAC address. Defaults to the bridge Ethernet address if
1006 <column name="other_config" key="lacp-system-priority"
1007 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1008 The LACP system priority of this <ref table="Port"/>. In LACP
1009 negotiations, link status decisions are made by the system with the
1010 numerically lower priority.
1013 <column name="other_config" key="lacp-time"
1014 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1016 The LACP timing which should be used on this <ref table="Port"/>.
1017 By default <code>slow</code> is used. When configured to be
1018 <code>fast</code> LACP heartbeats are requested at a rate of once
1019 per second causing connectivity problems to be detected more
1020 quickly. In <code>slow</code> mode, heartbeats are requested at a
1021 rate of once every 30 seconds.
1026 <group title="Rebalancing Configuration">
1028 These settings control behavior when a bond is in
1029 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1032 <column name="other_config" key="bond-rebalance-interval"
1033 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1034 For a load balanced bonded port, the number of milliseconds between
1035 successive attempts to rebalance the bond, that is, to move flows
1036 from one interface on the bond to another in an attempt to keep usage
1037 of each interface roughly equal. If zero, load balancing is disabled
1038 on the bond (link failure still cause flows to move). If
1039 less than 1000ms, the rebalance interval will be 1000ms.
1043 <column name="bond_fake_iface">
1044 For a bonded port, whether to create a fake internal interface with the
1045 name of the port. Use only for compatibility with legacy software that
1050 <group title="Spanning Tree Configuration">
1051 <column name="other_config" key="stp-enable"
1052 type='{"type": "boolean"}'>
1053 If spanning tree is enabled on the bridge, member ports are
1054 enabled by default (with the exception of bond, internal, and
1055 mirror ports which do not work with STP). If this column's
1056 value is <code>false</code> spanning tree is disabled on the
1060 <column name="other_config" key="stp-port-num"
1061 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1062 The port number used for the lower 8 bits of the port-id. By
1063 default, the numbers will be assigned automatically. If any
1064 port's number is manually configured on a bridge, then they
1068 <column name="other_config" key="stp-port-priority"
1069 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1070 The port's relative priority value for determining the root
1071 port (the upper 8 bits of the port-id). A port with a lower
1072 port-id will be chosen as the root port. By default, the
1076 <column name="other_config" key="stp-path-cost"
1077 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1078 Spanning tree path cost for the port. A lower number indicates
1079 a faster link. By default, the cost is based on the maximum
1084 <group title="Other Features">
1086 Quality of Service configuration for this port.
1090 The MAC address to use for this port for the purpose of choosing the
1091 bridge's MAC address. This column does not necessarily reflect the
1092 port's actual MAC address, nor will setting it change the port's actual
1096 <column name="fake_bridge">
1097 Does this port represent a sub-bridge for its tagged VLAN within the
1098 Bridge? See ovs-vsctl(8) for more information.
1101 <column name="external_ids" key="fake-bridge-id-*">
1102 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1103 column) are defined by prefixing a <ref table="Bridge"/> <ref
1104 table="Bridge" column="external_ids"/> key with
1105 <code>fake-bridge-</code>,
1106 e.g. <code>fake-bridge-xs-network-uuids</code>.
1110 <group title="Port Status">
1112 Status information about ports attached to bridges.
1114 <column name="status">
1115 Key-value pairs that report port status.
1117 <column name="status" key="stp_port_id">
1119 The port-id (in hex) used in spanning tree advertisements for
1120 this port. Configuring the port-id is described in the
1121 <code>stp-port-num</code> and <code>stp-port-priority</code>
1122 keys of the <code>other_config</code> section earlier.
1125 <column name="status" key="stp_state"
1126 type='{"type": "string", "enum": ["set",
1127 ["disabled", "listening", "learning",
1128 "forwarding", "blocking"]]}'>
1130 STP state of the port.
1133 <column name="status" key="stp_sec_in_state"
1134 type='{"type": "integer", "minInteger": 0}'>
1136 The amount of time (in seconds) port has been in the current
1140 <column name="status" key="stp_role"
1141 type='{"type": "string", "enum": ["set",
1142 ["root", "designated", "alternate"]]}'>
1144 STP role of the port.
1149 <group title="Port Statistics">
1151 Key-value pairs that report port statistics.
1153 <group title="Statistics: STP transmit and receive counters">
1154 <column name="statistics" key="stp_tx_count">
1155 Number of STP BPDUs sent on this port by the spanning
1158 <column name="statistics" key="stp_rx_count">
1159 Number of STP BPDUs received on this port and accepted by the
1160 spanning tree library.
1162 <column name="statistics" key="stp_error_count">
1163 Number of bad STP BPDUs received on this port. Bad BPDUs
1164 include runt packets and those with an unexpected protocol ID.
1169 <group title="Common Columns">
1170 The overall purpose of these columns is described under <code>Common
1171 Columns</code> at the beginning of this document.
1173 <column name="other_config"/>
1174 <column name="external_ids"/>
1178 <table name="Interface" title="One physical network device in a Port.">
1179 An interface within a <ref table="Port"/>.
1181 <group title="Core Features">
1182 <column name="name">
1183 Interface name. Should be alphanumeric and no more than about 8 bytes
1184 long. May be the same as the port name, for non-bonded ports. Must
1185 otherwise be unique among the names of ports, interfaces, and bridges
1189 <column name="mac_in_use">
1190 The MAC address in use by this interface.
1194 <p>Ethernet address to set for this interface. If unset then the
1195 default MAC address is used:</p>
1197 <li>For the local interface, the default is the lowest-numbered MAC
1198 address among the other bridge ports, either the value of the
1199 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1200 if set, or its actual MAC (for bonded ports, the MAC of its slave
1201 whose name is first in alphabetical order). Internal ports and
1202 bridge ports that are used as port mirroring destinations (see the
1203 <ref table="Mirror"/> table) are ignored.</li>
1204 <li>For other internal interfaces, the default MAC is randomly
1206 <li>External interfaces typically have a MAC address associated with
1207 their hardware.</li>
1209 <p>Some interfaces may not have a software-controllable MAC
1213 <column name="ofport">
1214 <p>OpenFlow port number for this interface. Unlike most columns, this
1215 column's value should be set only by Open vSwitch itself. Other
1216 clients should set this column to an empty set (the default) when
1217 creating an <ref table="Interface"/>.</p>
1218 <p>Open vSwitch populates this column when the port number becomes
1219 known. If the interface is successfully added,
1220 <ref column="ofport"/> will be set to a number between 1 and 65535
1221 (generally either in the range 1 to 65279, inclusive, or 65534, the
1222 port number for the OpenFlow ``local port''). If the interface
1223 cannot be added then Open vSwitch sets this column
1225 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1226 an appropriate value for this column and then tries to keep the value
1227 constant across restarts.</p>
1230 <column name="ofport_request">
1231 <p>Requested OpenFlow port number for this interface. The port
1232 number must be between 1 and 65279, inclusive. Some datapaths
1233 cannot satisfy all requests for particular port numbers. When
1234 this column is empty or the request cannot be fulfilled, the
1235 system will choose a free port. The <ref column="ofport"/>
1236 column reports the assigned OpenFlow port number.</p>
1237 <p>The port number must be requested in the same transaction
1238 that creates the port.</p>
1242 <group title="System-Specific Details">
1243 <column name="type">
1245 The interface type, one of:
1249 <dt><code>system</code></dt>
1250 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1251 Sometimes referred to as ``external interfaces'' since they are
1252 generally connected to hardware external to that on which the Open
1253 vSwitch is running. The empty string is a synonym for
1254 <code>system</code>.</dd>
1256 <dt><code>internal</code></dt>
1257 <dd>A simulated network device that sends and receives traffic. An
1258 internal interface whose <ref column="name"/> is the same as its
1259 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1260 ``local interface.'' It does not make sense to bond an internal
1261 interface, so the terms ``port'' and ``interface'' are often used
1262 imprecisely for internal interfaces.</dd>
1264 <dt><code>tap</code></dt>
1265 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1267 <dt><code>gre</code></dt>
1269 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1273 <dt><code>ipsec_gre</code></dt>
1275 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1279 <dt><code>gre64</code></dt>
1281 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1282 of key, it uses GRE protocol sequence number field. This is non
1283 standard use of GRE protocol since OVS does not increment
1284 sequence number for every packet at time of encap as expected by
1285 standard GRE implementation. See <ref group="Tunnel Options"/>
1286 for information on configuring GRE tunnels.
1289 <dt><code>ipsec_gre64</code></dt>
1291 Same as IPSEC_GRE except 64 bit key.
1294 <dt><code>vxlan</code></dt>
1297 An Ethernet tunnel over the experimental, UDP-based VXLAN
1298 protocol described at
1299 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1300 VXLAN is currently supported only with the Linux kernel datapath
1301 with kernel version 2.6.26 or later.
1304 Open vSwitch uses UDP destination port 4789. The source port used for
1305 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1310 <dt><code>lisp</code></dt>
1312 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1313 Separation Protocol (RFC 6830). LISP is currently supported only
1314 with the Linux kernel datapath with kernel version 2.6.26 or later.
1317 <dt><code>patch</code></dt>
1319 A pair of virtual devices that act as a patch cable.
1322 <dt><code>null</code></dt>
1323 <dd>An ignored interface. Deprecated and slated for removal in
1329 <group title="Tunnel Options">
1331 These options apply to interfaces with <ref column="type"/> of
1332 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1333 <code>ipsec_gre64</code>, <code>vxlan</code>, and <code>lisp</code>.
1337 Each tunnel must be uniquely identified by the combination of <ref
1338 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1339 column="options" key="local_ip"/>, and <ref column="options"
1340 key="in_key"/>. If two ports are defined that are the same except one
1341 has an optional identifier and the other does not, the more specific
1342 one is matched first. <ref column="options" key="in_key"/> is
1343 considered more specific than <ref column="options" key="local_ip"/> if
1344 a port defines one and another port defines the other.
1347 <column name="options" key="remote_ip">
1348 Required. The tunnel endpoint. Only unicast endpoints are supported.
1351 <column name="options" key="local_ip">
1352 Optional. The destination IP that received packets must match.
1353 Default is to match all addresses.
1356 <column name="options" key="in_key">
1357 <p>Optional. The key that received packets must contain, one of:</p>
1361 <code>0</code>. The tunnel receives packets with no key or with a
1362 key of 0. This is equivalent to specifying no <ref column="options"
1363 key="in_key"/> at all.
1366 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1367 (for GRE64) number. The tunnel receives only packets with the
1371 The word <code>flow</code>. The tunnel accepts packets with any
1372 key. The key will be placed in the <code>tun_id</code> field for
1373 matching in the flow table. The <code>ovs-ofctl</code> manual page
1374 contains additional information about matching fields in OpenFlow
1383 <column name="options" key="out_key">
1384 <p>Optional. The key to be set on outgoing packets, one of:</p>
1388 <code>0</code>. Packets sent through the tunnel will have no key.
1389 This is equivalent to specifying no <ref column="options"
1390 key="out_key"/> at all.
1393 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1394 (for GRE64) number. Packets sent through the tunnel will have the
1398 The word <code>flow</code>. Packets sent through the tunnel will
1399 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1400 vendor extension (0 is used in the absence of an action). The
1401 <code>ovs-ofctl</code> manual page contains additional information
1402 about the Nicira OpenFlow vendor extensions.
1407 <column name="options" key="key">
1408 Optional. Shorthand to set <code>in_key</code> and
1409 <code>out_key</code> at the same time.
1412 <column name="options" key="tos">
1413 Optional. The value of the ToS bits to be set on the encapsulating
1414 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1415 zero. It may also be the word <code>inherit</code>, in which case
1416 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1417 (otherwise it will be 0). The ECN fields are always inherited.
1421 <column name="options" key="ttl">
1422 Optional. The TTL to be set on the encapsulating packet. It may also
1423 be the word <code>inherit</code>, in which case the TTL will be copied
1424 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1425 system default, typically 64). Default is the system default TTL.
1428 <column name="options" key="df_default"
1429 type='{"type": "boolean"}'>
1430 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1431 outer headers to allow path MTU discovery. Default is enabled; set
1432 to <code>false</code> to disable.
1435 <group title="Tunnel Options: gre and ipsec_gre only">
1437 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1441 <column name="options" key="csum" type='{"type": "boolean"}'>
1443 Optional. Compute GRE checksums on outgoing packets. Default is
1444 disabled, set to <code>true</code> to enable. Checksums present on
1445 incoming packets will be validated regardless of this setting.
1449 GRE checksums impose a significant performance penalty because they
1450 cover the entire packet. The encapsulated L3, L4, and L7 packet
1451 contents typically have their own checksums, so this additional
1452 checksum only adds value for the GRE and encapsulated L2 headers.
1456 This option is supported for <code>ipsec_gre</code>, but not useful
1457 because GRE checksums are weaker than, and redundant with, IPsec
1458 payload authentication.
1463 <group title="Tunnel Options: ipsec_gre only">
1465 Only <code>ipsec_gre</code> interfaces support these options.
1468 <column name="options" key="peer_cert">
1469 Required for certificate authentication. A string containing the
1470 peer's certificate in PEM format. Additionally the host's
1471 certificate must be specified with the <code>certificate</code>
1475 <column name="options" key="certificate">
1476 Required for certificate authentication. The name of a PEM file
1477 containing a certificate that will be presented to the peer during
1481 <column name="options" key="private_key">
1482 Optional for certificate authentication. The name of a PEM file
1483 containing the private key associated with <code>certificate</code>.
1484 If <code>certificate</code> contains the private key, this option may
1488 <column name="options" key="psk">
1489 Required for pre-shared key authentication. Specifies a pre-shared
1490 key for authentication that must be identical on both sides of the
1496 <group title="Patch Options">
1498 Only <code>patch</code> interfaces support these options.
1501 <column name="options" key="peer">
1502 The <ref column="name"/> of the <ref table="Interface"/> for the other
1503 side of the patch. The named <ref table="Interface"/>'s own
1504 <code>peer</code> option must specify this <ref table="Interface"/>'s
1505 name. That is, the two patch interfaces must have reversed <ref
1506 column="name"/> and <code>peer</code> values.
1510 <group title="Interface Status">
1512 Status information about interfaces attached to bridges, updated every
1513 5 seconds. Not all interfaces have all of these properties; virtual
1514 interfaces don't have a link speed, for example. Non-applicable
1515 columns will have empty values.
1517 <column name="admin_state">
1519 The administrative state of the physical network link.
1523 <column name="link_state">
1525 The observed state of the physical network link. This is ordinarily
1526 the link's carrier status. If the interface's <ref table="Port"/> is
1527 a bond configured for miimon monitoring, it is instead the network
1528 link's miimon status.
1532 <column name="link_resets">
1534 The number of times Open vSwitch has observed the
1535 <ref column="link_state"/> of this <ref table="Interface"/> change.
1539 <column name="link_speed">
1541 The negotiated speed of the physical network link.
1542 Valid values are positive integers greater than 0.
1546 <column name="duplex">
1548 The duplex mode of the physical network link.
1554 The MTU (maximum transmission unit); i.e. the largest
1555 amount of data that can fit into a single Ethernet frame.
1556 The standard Ethernet MTU is 1500 bytes. Some physical media
1557 and many kinds of virtual interfaces can be configured with
1561 This column will be empty for an interface that does not
1562 have an MTU as, for example, some kinds of tunnels do not.
1566 <column name="lacp_current">
1567 Boolean value indicating LACP status for this interface. If true, this
1568 interface has current LACP information about its LACP partner. This
1569 information may be used to monitor the health of interfaces in a LACP
1570 enabled port. This column will be empty if LACP is not enabled.
1573 <column name="status">
1574 Key-value pairs that report port status. Supported status values are
1575 <ref column="type"/>-dependent; some interfaces may not have a valid
1576 <ref column="status" key="driver_name"/>, for example.
1579 <column name="status" key="driver_name">
1580 The name of the device driver controlling the network adapter.
1583 <column name="status" key="driver_version">
1584 The version string of the device driver controlling the network
1588 <column name="status" key="firmware_version">
1589 The version string of the network adapter's firmware, if available.
1592 <column name="status" key="source_ip">
1593 The source IP address used for an IPv4 tunnel end-point, such as
1597 <column name="status" key="tunnel_egress_iface">
1598 Egress interface for tunnels. Currently only relevant for GRE tunnels
1599 On Linux systems, this column will show the name of the interface
1600 which is responsible for routing traffic destined for the configured
1601 <ref column="options" key="remote_ip"/>. This could be an internal
1602 interface such as a bridge port.
1605 <column name="status" key="tunnel_egress_iface_carrier"
1606 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1607 Whether carrier is detected on <ref column="status"
1608 key="tunnel_egress_iface"/>.
1612 <group title="Statistics">
1614 Key-value pairs that report interface statistics. The current
1615 implementation updates these counters periodically. Future
1616 implementations may update them when an interface is created, when they
1617 are queried (e.g. using an OVSDB <code>select</code> operation), and
1618 just before an interface is deleted due to virtual interface hot-unplug
1619 or VM shutdown, and perhaps at other times, but not on any regular
1623 These are the same statistics reported by OpenFlow in its <code>struct
1624 ofp_port_stats</code> structure. If an interface does not support a
1625 given statistic, then that pair is omitted.
1627 <group title="Statistics: Successful transmit and receive counters">
1628 <column name="statistics" key="rx_packets">
1629 Number of received packets.
1631 <column name="statistics" key="rx_bytes">
1632 Number of received bytes.
1634 <column name="statistics" key="tx_packets">
1635 Number of transmitted packets.
1637 <column name="statistics" key="tx_bytes">
1638 Number of transmitted bytes.
1641 <group title="Statistics: Receive errors">
1642 <column name="statistics" key="rx_dropped">
1643 Number of packets dropped by RX.
1645 <column name="statistics" key="rx_frame_err">
1646 Number of frame alignment errors.
1648 <column name="statistics" key="rx_over_err">
1649 Number of packets with RX overrun.
1651 <column name="statistics" key="rx_crc_err">
1652 Number of CRC errors.
1654 <column name="statistics" key="rx_errors">
1655 Total number of receive errors, greater than or equal to the sum of
1659 <group title="Statistics: Transmit errors">
1660 <column name="statistics" key="tx_dropped">
1661 Number of packets dropped by TX.
1663 <column name="statistics" key="collisions">
1664 Number of collisions.
1666 <column name="statistics" key="tx_errors">
1667 Total number of transmit errors, greater than or equal to the sum of
1673 <group title="Ingress Policing">
1675 These settings control ingress policing for packets received on this
1676 interface. On a physical interface, this limits the rate at which
1677 traffic is allowed into the system from the outside; on a virtual
1678 interface (one connected to a virtual machine), this limits the rate at
1679 which the VM is able to transmit.
1682 Policing is a simple form of quality-of-service that simply drops
1683 packets received in excess of the configured rate. Due to its
1684 simplicity, policing is usually less accurate and less effective than
1685 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1686 table="Queue"/> tables).
1689 Policing is currently implemented only on Linux. The Linux
1690 implementation uses a simple ``token bucket'' approach:
1694 The size of the bucket corresponds to <ref
1695 column="ingress_policing_burst"/>. Initially the bucket is full.
1698 Whenever a packet is received, its size (converted to tokens) is
1699 compared to the number of tokens currently in the bucket. If the
1700 required number of tokens are available, they are removed and the
1701 packet is forwarded. Otherwise, the packet is dropped.
1704 Whenever it is not full, the bucket is refilled with tokens at the
1705 rate specified by <ref column="ingress_policing_rate"/>.
1709 Policing interacts badly with some network protocols, and especially
1710 with fragmented IP packets. Suppose that there is enough network
1711 activity to keep the bucket nearly empty all the time. Then this token
1712 bucket algorithm will forward a single packet every so often, with the
1713 period depending on packet size and on the configured rate. All of the
1714 fragments of an IP packets are normally transmitted back-to-back, as a
1715 group. In such a situation, therefore, only one of these fragments
1716 will be forwarded and the rest will be dropped. IP does not provide
1717 any way for the intended recipient to ask for only the remaining
1718 fragments. In such a case there are two likely possibilities for what
1719 will happen next: either all of the fragments will eventually be
1720 retransmitted (as TCP will do), in which case the same problem will
1721 recur, or the sender will not realize that its packet has been dropped
1722 and data will simply be lost (as some UDP-based protocols will do).
1723 Either way, it is possible that no forward progress will ever occur.
1725 <column name="ingress_policing_rate">
1727 Maximum rate for data received on this interface, in kbps. Data
1728 received faster than this rate is dropped. Set to <code>0</code>
1729 (the default) to disable policing.
1733 <column name="ingress_policing_burst">
1734 <p>Maximum burst size for data received on this interface, in kb. The
1735 default burst size if set to <code>0</code> is 1000 kb. This value
1736 has no effect if <ref column="ingress_policing_rate"/>
1737 is <code>0</code>.</p>
1739 Specifying a larger burst size lets the algorithm be more forgiving,
1740 which is important for protocols like TCP that react severely to
1741 dropped packets. The burst size should be at least the size of the
1742 interface's MTU. Specifying a value that is numerically at least as
1743 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1744 closer to achieving the full rate.
1749 <group title="Connectivity Fault Management">
1751 802.1ag Connectivity Fault Management (CFM) allows a group of
1752 Maintenance Points (MPs) called a Maintenance Association (MA) to
1753 detect connectivity problems with each other. MPs within a MA should
1754 have complete and exclusive interconnectivity. This is verified by
1755 occasionally broadcasting Continuity Check Messages (CCMs) at a
1756 configurable transmission interval.
1760 According to the 802.1ag specification, each Maintenance Point should
1761 be configured out-of-band with a list of Remote Maintenance Points it
1762 should have connectivity to. Open vSwitch differs from the
1763 specification in this area. It simply assumes the link is faulted if
1764 no Remote Maintenance Points are reachable, and considers it not
1769 When operating over tunnels which have no <code>in_key</code>, or an
1770 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1771 with a tunnel key of zero.
1774 <column name="cfm_mpid">
1775 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1776 a Maintenance Association. The MPID is used to identify this endpoint
1777 to other Maintenance Points in the MA. Each end of a link being
1778 monitored should have a different MPID. Must be configured to enable
1779 CFM on this <ref table="Interface"/>.
1782 <column name="cfm_fault">
1784 Indicates a connectivity fault triggered by an inability to receive
1785 heartbeats from any remote endpoint. When a fault is triggered on
1786 <ref table="Interface"/>s participating in bonds, they will be
1790 Faults can be triggered for several reasons. Most importantly they
1791 are triggered when no CCMs are received for a period of 3.5 times the
1792 transmission interval. Faults are also triggered when any CCMs
1793 indicate that a Remote Maintenance Point is not receiving CCMs but
1794 able to send them. Finally, a fault is triggered if a CCM is
1795 received which indicates unexpected configuration. Notably, this
1796 case arises when a CCM is received which advertises the local MPID.
1800 <column name="cfm_fault_status" key="recv">
1801 Indicates a CFM fault was triggered due to a lack of CCMs received on
1802 the <ref table="Interface"/>.
1805 <column name="cfm_fault_status" key="rdi">
1806 Indicates a CFM fault was triggered due to the reception of a CCM with
1807 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1808 are not receiving CCMs themselves. This typically indicates a
1809 unidirectional connectivity failure.
1812 <column name="cfm_fault_status" key="maid">
1813 Indicates a CFM fault was triggered due to the reception of a CCM with
1814 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1815 with an identification number in addition to the MPID called the MAID.
1816 Open vSwitch only supports receiving CCM broadcasts tagged with the
1817 MAID it uses internally.
1820 <column name="cfm_fault_status" key="loopback">
1821 Indicates a CFM fault was triggered due to the reception of a CCM
1822 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1823 column of this <ref table="Interface"/>. This may indicate a loop in
1827 <column name="cfm_fault_status" key="overflow">
1828 Indicates a CFM fault was triggered because the CFM module received
1829 CCMs from more remote endpoints than it can keep track of.
1832 <column name="cfm_fault_status" key="override">
1833 Indicates a CFM fault was manually triggered by an administrator using
1834 an <code>ovs-appctl</code> command.
1837 <column name="cfm_fault_status" key="interval">
1838 Indicates a CFM fault was triggered due to the reception of a CCM
1839 frame having an invalid interval.
1842 <column name="cfm_remote_opstate">
1843 <p>When in extended mode, indicates the operational state of the
1844 remote endpoint as either <code>up</code> or <code>down</code>. See
1845 <ref column="other_config" key="cfm_opstate"/>.
1849 <column name="cfm_health">
1851 Indicates the health of the interface as a percentage of CCM frames
1852 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1853 The health of an interface is undefined if it is communicating with
1854 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1855 healthy heartbeats are not received at the expected rate, and
1856 gradually improves as healthy heartbeats are received at the desired
1857 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1858 health of the interface is refreshed.
1861 As mentioned above, the faults can be triggered for several reasons.
1862 The link health will deteriorate even if heartbeats are received but
1863 they are reported to be unhealthy. An unhealthy heartbeat in this
1864 context is a heartbeat for which either some fault is set or is out
1865 of sequence. The interface health can be 100 only on receiving
1866 healthy heartbeats at the desired rate.
1870 <column name="cfm_remote_mpids">
1871 When CFM is properly configured, Open vSwitch will occasionally
1872 receive CCM broadcasts. These broadcasts contain the MPID of the
1873 sending Maintenance Point. The list of MPIDs from which this
1874 <ref table="Interface"/> is receiving broadcasts from is regularly
1875 collected and written to this column.
1878 <column name="other_config" key="cfm_interval"
1879 type='{"type": "integer"}'>
1881 The interval, in milliseconds, between transmissions of CFM
1882 heartbeats. Three missed heartbeat receptions indicate a
1887 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1888 60,000, or 600,000 ms are supported. Other values will be rounded
1889 down to the nearest value on the list. Extended mode (see <ref
1890 column="other_config" key="cfm_extended"/>) supports any interval up
1891 to 65,535 ms. In either mode, the default is 1000 ms.
1894 <p>We do not recommend using intervals less than 100 ms.</p>
1897 <column name="other_config" key="cfm_extended"
1898 type='{"type": "boolean"}'>
1899 When <code>true</code>, the CFM module operates in extended mode. This
1900 causes it to use a nonstandard destination address to avoid conflicting
1901 with compliant implementations which may be running concurrently on the
1902 network. Furthermore, extended mode increases the accuracy of the
1903 <code>cfm_interval</code> configuration parameter by breaking wire
1904 compatibility with 802.1ag compliant implementations. Defaults to
1908 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
1910 When <code>true</code>, and
1911 <ref column="other_config" key="cfm_extended"/> is true, the CFM
1912 module operates in demand mode. When in demand mode, traffic
1913 received on the <ref table="Interface"/> is used to indicate
1914 liveness. CCMs are still transmitted and received, but if the
1915 <ref table="Interface"/> is receiving traffic, their absence does not
1916 cause a connectivity fault.
1920 Demand mode has a couple of caveats:
1923 To ensure that ovs-vswitchd has enough time to pull statistics
1924 from the datapath, the minimum
1925 <ref column="other_config" key="cfm_interval"/> is 500ms.
1929 To avoid ambiguity, demand mode disables itself when there are
1930 multiple remote maintenance points.
1934 If the <ref table="Interface"/> is heavily congested, CCMs
1935 containing the <ref column="other_config" key="cfm_opstate"/>
1936 status may be dropped causing changes in the operational state to
1937 be delayed. Similarly, if CCMs containing the RDI bit are not
1938 received, unidirectional link failures may not be detected.
1944 <column name="other_config" key="cfm_opstate"
1945 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1946 When <code>down</code>, the CFM module marks all CCMs it generates as
1947 operationally down without triggering a fault. This allows remote
1948 maintenance points to choose not to forward traffic to the
1949 <ref table="Interface"/> on which this CFM module is running.
1950 Currently, in Open vSwitch, the opdown bit of CCMs affects
1951 <ref table="Interface"/>s participating in bonds, and the bundle
1952 OpenFlow action. This setting is ignored when CFM is not in extended
1953 mode. Defaults to <code>up</code>.
1956 <column name="other_config" key="cfm_ccm_vlan"
1957 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1958 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1959 with the given value. May be the string <code>random</code> in which
1960 case each CCM will be tagged with a different randomly generated VLAN.
1963 <column name="other_config" key="cfm_ccm_pcp"
1964 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1965 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1966 with the given PCP value, the VLAN ID of the tag is governed by the
1967 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1968 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1974 <group title="Bonding Configuration">
1975 <column name="other_config" key="lacp-port-id"
1976 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1977 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1978 used in LACP negotiations to identify individual ports
1979 participating in a bond.
1982 <column name="other_config" key="lacp-port-priority"
1983 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1984 The LACP port priority of this <ref table="Interface"/>. In LACP
1985 negotiations <ref table="Interface"/>s with numerically lower
1986 priorities are preferred for aggregation.
1989 <column name="other_config" key="lacp-aggregation-key"
1990 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1991 The LACP aggregation key of this <ref table="Interface"/>. <ref
1992 table="Interface"/>s with different aggregation keys may not be active
1993 within a given <ref table="Port"/> at the same time.
1997 <group title="Virtual Machine Identifiers">
1999 These key-value pairs specifically apply to an interface that
2000 represents a virtual Ethernet interface connected to a virtual
2001 machine. These key-value pairs should not be present for other types
2002 of interfaces. Keys whose names end in <code>-uuid</code> have
2003 values that uniquely identify the entity in question. For a Citrix
2004 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2005 Other hypervisors may use other formats.
2008 <column name="external_ids" key="attached-mac">
2009 The MAC address programmed into the ``virtual hardware'' for this
2010 interface, in the form
2011 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2012 For Citrix XenServer, this is the value of the <code>MAC</code> field
2013 in the VIF record for this interface.
2016 <column name="external_ids" key="iface-id">
2017 A system-unique identifier for the interface. On XenServer, this will
2018 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2021 <column name="external_ids" key="iface-status"
2022 type='{"type": "string",
2023 "enum": ["set", ["active", "inactive"]]}'>
2025 Hypervisors may sometimes have more than one interface associated
2026 with a given <ref column="external_ids" key="iface-id"/>, only one of
2027 which is actually in use at a given time. For example, in some
2028 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2029 for a single <ref column="external_ids" key="iface-id"/>, but only
2030 uses one of them at a time. A hypervisor that behaves this way must
2031 mark the currently in use interface <code>active</code> and the
2032 others <code>inactive</code>. A hypervisor that never has more than
2033 one interface for a given <ref column="external_ids" key="iface-id"/>
2034 may mark that interface <code>active</code> or omit <ref
2035 column="external_ids" key="iface-status"/> entirely.
2039 During VM migration, a given <ref column="external_ids"
2040 key="iface-id"/> might transiently be marked <code>active</code> on
2041 two different hypervisors. That is, <code>active</code> means that
2042 this <ref column="external_ids" key="iface-id"/> is the active
2043 instance within a single hypervisor, not in a broader scope.
2044 There is one exception: some hypervisors support ``migration'' from a
2045 given hypervisor to itself (most often for test purposes). During
2046 such a ``migration,'' two instances of a single <ref
2047 column="external_ids" key="iface-id"/> might both be briefly marked
2048 <code>active</code> on a single hypervisor.
2052 <column name="external_ids" key="xs-vif-uuid">
2053 The virtual interface associated with this interface.
2056 <column name="external_ids" key="xs-network-uuid">
2057 The virtual network to which this interface is attached.
2060 <column name="external_ids" key="vm-id">
2061 The VM to which this interface belongs. On XenServer, this will be the
2062 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2065 <column name="external_ids" key="xs-vm-uuid">
2066 The VM to which this interface belongs.
2070 <group title="VLAN Splinters">
2072 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2073 with buggy network drivers in old versions of Linux that do not
2074 properly support VLANs when VLAN devices are not used, at some cost
2075 in memory and performance.
2079 When VLAN splinters are enabled on a particular interface, Open vSwitch
2080 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2081 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2082 received on the VLAN device is treated as if it had been received on
2083 the interface on the particular VLAN.
2087 VLAN splinters consider a VLAN to be in use if:
2092 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2093 table="Port"/> record.
2097 The VLAN is listed within the <ref table="Port" column="trunks"/>
2098 column of the <ref table="Port"/> record of an interface on which
2099 VLAN splinters are enabled.
2101 An empty <ref table="Port" column="trunks"/> does not influence the
2102 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2103 will exceed the current 1,024 port per datapath limit.
2107 An OpenFlow flow within any bridge matches the VLAN.
2112 The same set of in-use VLANs applies to every interface on which VLAN
2113 splinters are enabled. That is, the set is not chosen separately for
2114 each interface but selected once as the union of all in-use VLANs based
2119 It does not make sense to enable VLAN splinters on an interface for an
2120 access port, or on an interface that is not a physical port.
2124 VLAN splinters are deprecated. When broken device drivers are no
2125 longer in widespread use, we will delete this feature.
2128 <column name="other_config" key="enable-vlan-splinters"
2129 type='{"type": "boolean"}'>
2131 Set to <code>true</code> to enable VLAN splinters on this interface.
2132 Defaults to <code>false</code>.
2136 VLAN splinters increase kernel and userspace memory overhead, so do
2137 not use them unless they are needed.
2141 VLAN splinters do not support 802.1p priority tags. Received
2142 priorities will appear to be 0, regardless of their actual values,
2143 and priorities on transmitted packets will also be cleared to 0.
2148 <group title="Common Columns">
2149 The overall purpose of these columns is described under <code>Common
2150 Columns</code> at the beginning of this document.
2152 <column name="other_config"/>
2153 <column name="external_ids"/>
2157 <table name="Flow_Table" title="OpenFlow table configuration">
2158 <p>Configuration for a particular OpenFlow table.</p>
2160 <column name="name">
2161 The table's name. Set this column to change the name that controllers
2162 will receive when they request table statistics, e.g. <code>ovs-ofctl
2163 dump-tables</code>. The name does not affect switch behavior.
2166 <column name="flow_limit">
2167 If set, limits the number of flows that may be added to the table. Open
2168 vSwitch may limit the number of flows in a table for other reasons,
2169 e.g. due to hardware limitations or for resource availability or
2170 performance reasons.
2173 <column name="overflow_policy">
2175 Controls the switch's behavior when an OpenFlow flow table modification
2176 request would add flows in excess of <ref column="flow_limit"/>. The
2177 supported values are:
2181 <dt><code>refuse</code></dt>
2183 Refuse to add the flow or flows. This is also the default policy
2184 when <ref column="overflow_policy"/> is unset.
2187 <dt><code>evict</code></dt>
2189 Delete the flow that will expire soonest. See <ref column="groups"/>
2195 <column name="groups">
2197 When <ref column="overflow_policy"/> is <code>evict</code>, this
2198 controls how flows are chosen for eviction when the flow table would
2199 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2200 of NXM fields or sub-fields, each of which takes one of the forms
2201 <code><var>field</var>[]</code> or
2202 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2203 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2204 <code>nicira-ext.h</code> for a complete list of NXM field names.
2208 When a flow must be evicted due to overflow, the flow to evict is
2209 chosen through an approximation of the following algorithm:
2214 Divide the flows in the table into groups based on the values of the
2215 specified fields or subfields, so that all of the flows in a given
2216 group have the same values for those fields. If a flow does not
2217 specify a given field, that field's value is treated as 0.
2221 Consider the flows in the largest group, that is, the group that
2222 contains the greatest number of flows. If two or more groups all
2223 have the same largest number of flows, consider the flows in all of
2228 Among the flows under consideration, choose the flow that expires
2229 soonest for eviction.
2234 The eviction process only considers flows that have an idle timeout or
2235 a hard timeout. That is, eviction never deletes permanent flows.
2236 (Permanent flows do count against <ref column="flow_limit"/>.)
2240 Open vSwitch ignores any invalid or unknown field specifications.
2244 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2245 column has no effect.
2250 <table name="QoS" title="Quality of Service configuration">
2251 <p>Quality of Service (QoS) configuration for each Port that
2254 <column name="type">
2255 <p>The type of QoS to implement. The currently defined types are
2258 <dt><code>linux-htb</code></dt>
2260 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2261 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2262 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2263 for information on how this classifier works and how to configure it.
2267 <dt><code>linux-hfsc</code></dt>
2269 Linux "Hierarchical Fair Service Curve" classifier.
2270 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2271 information on how this classifier works.
2276 <column name="queues">
2277 <p>A map from queue numbers to <ref table="Queue"/> records. The
2278 supported range of queue numbers depend on <ref column="type"/>. The
2279 queue numbers are the same as the <code>queue_id</code> used in
2280 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2284 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2285 actions when no specific queue has been set. When no configuration for
2286 queue 0 is present, it is automatically configured as if a <ref
2287 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2288 and <ref table="Queue" column="other_config"/> columns had been
2290 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2291 this case. With some queuing disciplines, this dropped all packets
2292 destined for the default queue.)
2296 <group title="Configuration for linux-htb and linux-hfsc">
2298 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2299 the following key-value pair:
2302 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2303 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2304 specified, for physical interfaces, the default is the link rate. For
2305 other interfaces or if the link rate cannot be determined, the default
2306 is currently 100 Mbps.
2310 <group title="Common Columns">
2311 The overall purpose of these columns is described under <code>Common
2312 Columns</code> at the beginning of this document.
2314 <column name="other_config"/>
2315 <column name="external_ids"/>
2319 <table name="Queue" title="QoS output queue.">
2320 <p>A configuration for a port output queue, used in configuring Quality of
2321 Service (QoS) features. May be referenced by <ref column="queues"
2322 table="QoS"/> column in <ref table="QoS"/> table.</p>
2324 <column name="dscp">
2325 If set, Open vSwitch will mark all traffic egressing this
2326 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2327 default <ref table="Queue"/> is only marked if it was explicitly selected
2328 as the <ref table="Queue"/> at the time the packet was output. If unset,
2329 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2333 <group title="Configuration for linux-htb QoS">
2335 <ref table="QoS"/> <ref table="QoS" column="type"/>
2336 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2337 It has the following key-value pairs defined.
2340 <column name="other_config" key="min-rate"
2341 type='{"type": "integer", "minInteger": 1}'>
2342 Minimum guaranteed bandwidth, in bit/s.
2345 <column name="other_config" key="max-rate"
2346 type='{"type": "integer", "minInteger": 1}'>
2347 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2348 queue's rate will not be allowed to exceed the specified value, even
2349 if excess bandwidth is available. If unspecified, defaults to no
2353 <column name="other_config" key="burst"
2354 type='{"type": "integer", "minInteger": 1}'>
2355 Burst size, in bits. This is the maximum amount of ``credits'' that a
2356 queue can accumulate while it is idle. Optional. Details of the
2357 <code>linux-htb</code> implementation require a minimum burst size, so
2358 a too-small <code>burst</code> will be silently ignored.
2361 <column name="other_config" key="priority"
2362 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2363 A queue with a smaller <code>priority</code> will receive all the
2364 excess bandwidth that it can use before a queue with a larger value
2365 receives any. Specific priority values are unimportant; only relative
2366 ordering matters. Defaults to 0 if unspecified.
2370 <group title="Configuration for linux-hfsc QoS">
2372 <ref table="QoS"/> <ref table="QoS" column="type"/>
2373 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2374 It has the following key-value pairs defined.
2377 <column name="other_config" key="min-rate"
2378 type='{"type": "integer", "minInteger": 1}'>
2379 Minimum guaranteed bandwidth, in bit/s.
2382 <column name="other_config" key="max-rate"
2383 type='{"type": "integer", "minInteger": 1}'>
2384 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2385 queue's rate will not be allowed to exceed the specified value, even if
2386 excess bandwidth is available. If unspecified, defaults to no
2391 <group title="Common Columns">
2392 The overall purpose of these columns is described under <code>Common
2393 Columns</code> at the beginning of this document.
2395 <column name="other_config"/>
2396 <column name="external_ids"/>
2400 <table name="Mirror" title="Port mirroring.">
2401 <p>A port mirror within a <ref table="Bridge"/>.</p>
2402 <p>A port mirror configures a bridge to send selected frames to special
2403 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2404 traffic may also be referred to as SPAN or RSPAN, depending on how
2405 the mirrored traffic is sent.</p>
2407 <column name="name">
2408 Arbitrary identifier for the <ref table="Mirror"/>.
2411 <group title="Selecting Packets for Mirroring">
2413 To be selected for mirroring, a given packet must enter or leave the
2414 bridge through a selected port and it must also be in one of the
2418 <column name="select_all">
2419 If true, every packet arriving or departing on any port is
2420 selected for mirroring.
2423 <column name="select_dst_port">
2424 Ports on which departing packets are selected for mirroring.
2427 <column name="select_src_port">
2428 Ports on which arriving packets are selected for mirroring.
2431 <column name="select_vlan">
2432 VLANs on which packets are selected for mirroring. An empty set
2433 selects packets on all VLANs.
2437 <group title="Mirroring Destination Configuration">
2439 These columns are mutually exclusive. Exactly one of them must be
2443 <column name="output_port">
2444 <p>Output port for selected packets, if nonempty.</p>
2445 <p>Specifying a port for mirror output reserves that port exclusively
2446 for mirroring. No frames other than those selected for mirroring
2448 will be forwarded to the port, and any frames received on the port
2449 will be discarded.</p>
2451 The output port may be any kind of port supported by Open vSwitch.
2452 It may be, for example, a physical port (sometimes called SPAN) or a
2457 <column name="output_vlan">
2458 <p>Output VLAN for selected packets, if nonempty.</p>
2459 <p>The frames will be sent out all ports that trunk
2460 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2461 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2462 trunk port, the frame's VLAN tag will be set to
2463 <ref column="output_vlan"/>, replacing any existing tag; when it is
2464 sent out an implicit VLAN port, the frame will not be tagged. This
2465 type of mirroring is sometimes called RSPAN.</p>
2467 See the documentation for
2468 <ref column="other_config" key="forward-bpdu"/> in the
2469 <ref table="Interface"/> table for a list of destination MAC
2470 addresses which will not be mirrored to a VLAN to avoid confusing
2471 switches that interpret the protocols that they represent.
2473 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2474 contains unmanaged switches. Consider an unmanaged physical switch
2475 with two ports: port 1, connected to an end host, and port 2,
2476 connected to an Open vSwitch configured to mirror received packets
2477 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2478 port 1 that the physical switch forwards to port 2. The Open vSwitch
2479 forwards this packet to its destination and then reflects it back on
2480 port 2 in VLAN 123. This reflected packet causes the unmanaged
2481 physical switch to replace the MAC learning table entry, which
2482 correctly pointed to port 1, with one that incorrectly points to port
2483 2. Afterward, the physical switch will direct packets destined for
2484 the end host to the Open vSwitch on port 2, instead of to the end
2485 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2486 desired in this scenario, then the physical switch must be replaced
2487 by one that learns Ethernet addresses on a per-VLAN basis. In
2488 addition, learning should be disabled on the VLAN containing mirrored
2489 traffic. If this is not done then intermediate switches will learn
2490 the MAC address of each end host from the mirrored traffic. If
2491 packets being sent to that end host are also mirrored, then they will
2492 be dropped since the switch will attempt to send them out the input
2493 port. Disabling learning for the VLAN will cause the switch to
2494 correctly send the packet out all ports configured for that VLAN. If
2495 Open vSwitch is being used as an intermediate switch, learning can be
2496 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2497 in the appropriate <ref table="Bridge"/> table or tables.</p>
2499 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2500 VLAN and should generally be preferred.
2505 <group title="Statistics: Mirror counters">
2507 Key-value pairs that report mirror statistics.
2509 <column name="statistics" key="tx_packets">
2510 Number of packets transmitted through this mirror.
2512 <column name="statistics" key="tx_bytes">
2513 Number of bytes transmitted through this mirror.
2517 <group title="Common Columns">
2518 The overall purpose of these columns is described under <code>Common
2519 Columns</code> at the beginning of this document.
2521 <column name="external_ids"/>
2525 <table name="Controller" title="OpenFlow controller configuration.">
2526 <p>An OpenFlow controller.</p>
2529 Open vSwitch supports two kinds of OpenFlow controllers:
2533 <dt>Primary controllers</dt>
2536 This is the kind of controller envisioned by the OpenFlow 1.0
2537 specification. Usually, a primary controller implements a network
2538 policy by taking charge of the switch's flow table.
2542 Open vSwitch initiates and maintains persistent connections to
2543 primary controllers, retrying the connection each time it fails or
2544 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2545 <ref table="Bridge"/> table applies to primary controllers.
2549 Open vSwitch permits a bridge to have any number of primary
2550 controllers. When multiple controllers are configured, Open
2551 vSwitch connects to all of them simultaneously. Because
2552 OpenFlow 1.0 does not specify how multiple controllers
2553 coordinate in interacting with a single switch, more than
2554 one primary controller should be specified only if the
2555 controllers are themselves designed to coordinate with each
2556 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2557 vendor extension may be useful for this.)
2560 <dt>Service controllers</dt>
2563 These kinds of OpenFlow controller connections are intended for
2564 occasional support and maintenance use, e.g. with
2565 <code>ovs-ofctl</code>. Usually a service controller connects only
2566 briefly to inspect or modify some of a switch's state.
2570 Open vSwitch listens for incoming connections from service
2571 controllers. The service controllers initiate and, if necessary,
2572 maintain the connections from their end. The <ref table="Bridge"
2573 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2574 not apply to service controllers.
2578 Open vSwitch supports configuring any number of service controllers.
2584 The <ref column="target"/> determines the type of controller.
2587 <group title="Core Features">
2588 <column name="target">
2589 <p>Connection method for controller.</p>
2591 The following connection methods are currently supported for primary
2595 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2597 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2598 the given <var>ip</var>, which must be expressed as an IP address
2599 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2600 column in the <ref table="Open_vSwitch"/> table must point to a
2601 valid SSL configuration when this form is used.</p>
2602 <p>SSL support is an optional feature that is not always built as
2603 part of Open vSwitch.</p>
2605 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2606 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2607 the given <var>ip</var>, which must be expressed as an IP address
2608 (not a DNS name).</dd>
2611 The following connection methods are currently supported for service
2615 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2618 Listens for SSL connections on the specified TCP <var>port</var>
2619 (default: 6633). If <var>ip</var>, which must be expressed as an
2620 IP address (not a DNS name), is specified, then connections are
2621 restricted to the specified local IP address.
2624 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2625 table="Open_vSwitch"/> table must point to a valid SSL
2626 configuration when this form is used.
2628 <p>SSL support is an optional feature that is not always built as
2629 part of Open vSwitch.</p>
2631 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2633 Listens for connections on the specified TCP <var>port</var>
2634 (default: 6633). If <var>ip</var>, which must be expressed as an
2635 IP address (not a DNS name), is specified, then connections are
2636 restricted to the specified local IP address.
2639 <p>When multiple controllers are configured for a single bridge, the
2640 <ref column="target"/> values must be unique. Duplicate
2641 <ref column="target"/> values yield unspecified results.</p>
2644 <column name="connection_mode">
2645 <p>If it is specified, this setting must be one of the following
2646 strings that describes how Open vSwitch contacts this OpenFlow
2647 controller over the network:</p>
2650 <dt><code>in-band</code></dt>
2651 <dd>In this mode, this controller's OpenFlow traffic travels over the
2652 bridge associated with the controller. With this setting, Open
2653 vSwitch allows traffic to and from the controller regardless of the
2654 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2655 would never be able to connect to the controller, because it did
2656 not have a flow to enable it.) This is the most common connection
2657 mode because it is not necessary to maintain two independent
2659 <dt><code>out-of-band</code></dt>
2660 <dd>In this mode, OpenFlow traffic uses a control network separate
2661 from the bridge associated with this controller, that is, the
2662 bridge does not use any of its own network devices to communicate
2663 with the controller. The control network must be configured
2664 separately, before or after <code>ovs-vswitchd</code> is started.
2668 <p>If not specified, the default is implementation-specific.</p>
2672 <group title="Controller Failure Detection and Handling">
2673 <column name="max_backoff">
2674 Maximum number of milliseconds to wait between connection attempts.
2675 Default is implementation-specific.
2678 <column name="inactivity_probe">
2679 Maximum number of milliseconds of idle time on connection to
2680 controller before sending an inactivity probe message. If Open
2681 vSwitch does not communicate with the controller for the specified
2682 number of seconds, it will send a probe. If a response is not
2683 received for the same additional amount of time, Open vSwitch
2684 assumes the connection has been broken and attempts to reconnect.
2685 Default is implementation-specific. A value of 0 disables
2690 <group title="Asynchronous Message Configuration">
2692 OpenFlow switches send certain messages to controllers spontanenously,
2693 that is, not in response to any request from the controller. These
2694 messages are called ``asynchronous messages.'' These columns allow
2695 asynchronous messages to be limited or disabled to ensure the best use
2696 of network resources.
2699 <column name="enable_async_messages">
2700 The OpenFlow protocol enables asynchronous messages at time of
2701 connection establishment, which means that a controller can receive
2702 asynchronous messages, potentially many of them, even if it turns them
2703 off immediately after connecting. Set this column to
2704 <code>false</code> to change Open vSwitch behavior to disable, by
2705 default, all asynchronous messages. The controller can use the
2706 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2707 on any messages that it does want to receive, if any.
2710 <column name="controller_rate_limit">
2712 The maximum rate at which the switch will forward packets to the
2713 OpenFlow controller, in packets per second. This feature prevents a
2714 single bridge from overwhelming the controller. If not specified,
2715 the default is implementation-specific.
2719 In addition, when a high rate triggers rate-limiting, Open vSwitch
2720 queues controller packets for each port and transmits them to the
2721 controller at the configured rate. The <ref
2722 column="controller_burst_limit"/> value limits the number of queued
2723 packets. Ports on a bridge share the packet queue fairly.
2727 Open vSwitch maintains two such packet rate-limiters per bridge: one
2728 for packets sent up to the controller because they do not correspond
2729 to any flow, and the other for packets sent up to the controller by
2730 request through flow actions. When both rate-limiters are filled with
2731 packets, the actual rate that packets are sent to the controller is
2732 up to twice the specified rate.
2736 <column name="controller_burst_limit">
2737 In conjunction with <ref column="controller_rate_limit"/>,
2738 the maximum number of unused packet credits that the bridge will
2739 allow to accumulate, in packets. If not specified, the default
2740 is implementation-specific.
2744 <group title="Additional In-Band Configuration">
2745 <p>These values are considered only in in-band control mode (see
2746 <ref column="connection_mode"/>).</p>
2748 <p>When multiple controllers are configured on a single bridge, there
2749 should be only one set of unique values in these columns. If different
2750 values are set for these columns in different controllers, the effect
2753 <column name="local_ip">
2754 The IP address to configure on the local port,
2755 e.g. <code>192.168.0.123</code>. If this value is unset, then
2756 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2760 <column name="local_netmask">
2761 The IP netmask to configure on the local port,
2762 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2763 but this value is unset, then the default is chosen based on whether
2764 the IP address is class A, B, or C.
2767 <column name="local_gateway">
2768 The IP address of the gateway to configure on the local port, as a
2769 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2770 this network has no gateway.
2774 <group title="Controller Status">
2775 <column name="is_connected">
2776 <code>true</code> if currently connected to this controller,
2777 <code>false</code> otherwise.
2781 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2782 <p>The level of authority this controller has on the associated
2783 bridge. Possible values are:</p>
2785 <dt><code>other</code></dt>
2786 <dd>Allows the controller access to all OpenFlow features.</dd>
2787 <dt><code>master</code></dt>
2788 <dd>Equivalent to <code>other</code>, except that there may be at
2789 most one master controller at a time. When a controller configures
2790 itself as <code>master</code>, any existing master is demoted to
2791 the <code>slave</code>role.</dd>
2792 <dt><code>slave</code></dt>
2793 <dd>Allows the controller read-only access to OpenFlow features.
2794 Attempts to modify the flow table will be rejected with an
2795 error. Slave controllers do not receive OFPT_PACKET_IN or
2796 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2801 <column name="status" key="last_error">
2802 A human-readable description of the last error on the connection
2803 to the controller; i.e. <code>strerror(errno)</code>. This key
2804 will exist only if an error has occurred.
2807 <column name="status" key="state"
2808 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2810 The state of the connection to the controller:
2813 <dt><code>VOID</code></dt>
2814 <dd>Connection is disabled.</dd>
2816 <dt><code>BACKOFF</code></dt>
2817 <dd>Attempting to reconnect at an increasing period.</dd>
2819 <dt><code>CONNECTING</code></dt>
2820 <dd>Attempting to connect.</dd>
2822 <dt><code>ACTIVE</code></dt>
2823 <dd>Connected, remote host responsive.</dd>
2825 <dt><code>IDLE</code></dt>
2826 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2829 These values may change in the future. They are provided only for
2834 <column name="status" key="sec_since_connect"
2835 type='{"type": "integer", "minInteger": 0}'>
2836 The amount of time since this controller last successfully connected to
2837 the switch (in seconds). Value is empty if controller has never
2838 successfully connected.
2841 <column name="status" key="sec_since_disconnect"
2842 type='{"type": "integer", "minInteger": 1}'>
2843 The amount of time since this controller last disconnected from
2844 the switch (in seconds). Value is empty if controller has never
2849 <group title="Connection Parameters">
2851 Additional configuration for a connection between the controller
2852 and the Open vSwitch.
2855 <column name="other_config" key="dscp"
2856 type='{"type": "integer"}'>
2857 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2858 in the Type of Service (TOS) field in the IP header. DSCP provides a
2859 mechanism to classify the network traffic and provide Quality of
2860 Service (QoS) on IP networks.
2862 The DSCP value specified here is used when establishing the connection
2863 between the controller and the Open vSwitch. If no value is specified,
2864 a default value of 48 is chosen. Valid DSCP values must be in the
2870 <group title="Common Columns">
2871 The overall purpose of these columns is described under <code>Common
2872 Columns</code> at the beginning of this document.
2874 <column name="external_ids"/>
2875 <column name="other_config"/>
2879 <table name="Manager" title="OVSDB management connection.">
2881 Configuration for a database connection to an Open vSwitch database
2886 This table primarily configures the Open vSwitch database
2887 (<code>ovsdb-server</code>), not the Open vSwitch switch
2888 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2889 what connections should be treated as in-band.
2893 The Open vSwitch database server can initiate and maintain active
2894 connections to remote clients. It can also listen for database
2898 <group title="Core Features">
2899 <column name="target">
2900 <p>Connection method for managers.</p>
2902 The following connection methods are currently supported:
2905 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2908 The specified SSL <var>port</var> (default: 6632) on the host at
2909 the given <var>ip</var>, which must be expressed as an IP address
2910 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2911 column in the <ref table="Open_vSwitch"/> table must point to a
2912 valid SSL configuration when this form is used.
2915 SSL support is an optional feature that is not always built as
2916 part of Open vSwitch.
2920 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2922 The specified TCP <var>port</var> (default: 6632) on the host at
2923 the given <var>ip</var>, which must be expressed as an IP address
2926 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2929 Listens for SSL connections on the specified TCP <var>port</var>
2930 (default: 6632). Specify 0 for <var>port</var> to have the
2931 kernel automatically choose an available port. If <var>ip</var>,
2932 which must be expressed as an IP address (not a DNS name), is
2933 specified, then connections are restricted to the specified local
2937 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2938 table="Open_vSwitch"/> table must point to a valid SSL
2939 configuration when this form is used.
2942 SSL support is an optional feature that is not always built as
2943 part of Open vSwitch.
2946 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2948 Listens for connections on the specified TCP <var>port</var>
2949 (default: 6632). Specify 0 for <var>port</var> to have the kernel
2950 automatically choose an available port. If <var>ip</var>, which
2951 must be expressed as an IP address (not a DNS name), is specified,
2952 then connections are restricted to the specified local IP address.
2955 <p>When multiple managers are configured, the <ref column="target"/>
2956 values must be unique. Duplicate <ref column="target"/> values yield
2957 unspecified results.</p>
2960 <column name="connection_mode">
2962 If it is specified, this setting must be one of the following strings
2963 that describes how Open vSwitch contacts this OVSDB client over the
2968 <dt><code>in-band</code></dt>
2970 In this mode, this connection's traffic travels over a bridge
2971 managed by Open vSwitch. With this setting, Open vSwitch allows
2972 traffic to and from the client regardless of the contents of the
2973 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2974 to connect to the client, because it did not have a flow to enable
2975 it.) This is the most common connection mode because it is not
2976 necessary to maintain two independent networks.
2978 <dt><code>out-of-band</code></dt>
2980 In this mode, the client's traffic uses a control network separate
2981 from that managed by Open vSwitch, that is, Open vSwitch does not
2982 use any of its own network devices to communicate with the client.
2983 The control network must be configured separately, before or after
2984 <code>ovs-vswitchd</code> is started.
2989 If not specified, the default is implementation-specific.
2994 <group title="Client Failure Detection and Handling">
2995 <column name="max_backoff">
2996 Maximum number of milliseconds to wait between connection attempts.
2997 Default is implementation-specific.
3000 <column name="inactivity_probe">
3001 Maximum number of milliseconds of idle time on connection to the client
3002 before sending an inactivity probe message. If Open vSwitch does not
3003 communicate with the client for the specified number of seconds, it
3004 will send a probe. If a response is not received for the same
3005 additional amount of time, Open vSwitch assumes the connection has been
3006 broken and attempts to reconnect. Default is implementation-specific.
3007 A value of 0 disables inactivity probes.
3011 <group title="Status">
3012 <column name="is_connected">
3013 <code>true</code> if currently connected to this manager,
3014 <code>false</code> otherwise.
3017 <column name="status" key="last_error">
3018 A human-readable description of the last error on the connection
3019 to the manager; i.e. <code>strerror(errno)</code>. This key
3020 will exist only if an error has occurred.
3023 <column name="status" key="state"
3024 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3026 The state of the connection to the manager:
3029 <dt><code>VOID</code></dt>
3030 <dd>Connection is disabled.</dd>
3032 <dt><code>BACKOFF</code></dt>
3033 <dd>Attempting to reconnect at an increasing period.</dd>
3035 <dt><code>CONNECTING</code></dt>
3036 <dd>Attempting to connect.</dd>
3038 <dt><code>ACTIVE</code></dt>
3039 <dd>Connected, remote host responsive.</dd>
3041 <dt><code>IDLE</code></dt>
3042 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3045 These values may change in the future. They are provided only for
3050 <column name="status" key="sec_since_connect"
3051 type='{"type": "integer", "minInteger": 0}'>
3052 The amount of time since this manager last successfully connected
3053 to the database (in seconds). Value is empty if manager has never
3054 successfully connected.
3057 <column name="status" key="sec_since_disconnect"
3058 type='{"type": "integer", "minInteger": 0}'>
3059 The amount of time since this manager last disconnected from the
3060 database (in seconds). Value is empty if manager has never
3064 <column name="status" key="locks_held">
3065 Space-separated list of the names of OVSDB locks that the connection
3066 holds. Omitted if the connection does not hold any locks.
3069 <column name="status" key="locks_waiting">
3070 Space-separated list of the names of OVSDB locks that the connection is
3071 currently waiting to acquire. Omitted if the connection is not waiting
3075 <column name="status" key="locks_lost">
3076 Space-separated list of the names of OVSDB locks that the connection
3077 has had stolen by another OVSDB client. Omitted if no locks have been
3078 stolen from this connection.
3081 <column name="status" key="n_connections"
3082 type='{"type": "integer", "minInteger": 2}'>
3084 When <ref column="target"/> specifies a connection method that
3085 listens for inbound connections (e.g. <code>ptcp:</code> or
3086 <code>pssl:</code>) and more than one connection is actually active,
3087 the value is the number of active connections. Otherwise, this
3088 key-value pair is omitted.
3091 When multiple connections are active, status columns and key-value
3092 pairs (other than this one) report the status of one arbitrarily
3097 <column name="status" key="bound_port" type='{"type": "integer"}'>
3098 When <ref column="target"/> is <code>ptcp:</code> or
3099 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3100 listening. (This is is particularly useful when <ref
3101 column="target"/> specifies a port of 0, allowing the kernel to
3102 choose any available port.)
3106 <group title="Connection Parameters">
3108 Additional configuration for a connection between the manager
3109 and the Open vSwitch Database.
3112 <column name="other_config" key="dscp"
3113 type='{"type": "integer"}'>
3114 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3115 in the Type of Service (TOS) field in the IP header. DSCP provides a
3116 mechanism to classify the network traffic and provide Quality of
3117 Service (QoS) on IP networks.
3119 The DSCP value specified here is used when establishing the connection
3120 between the manager and the Open vSwitch. If no value is specified, a
3121 default value of 48 is chosen. Valid DSCP values must be in the range
3126 <group title="Common Columns">
3127 The overall purpose of these columns is described under <code>Common
3128 Columns</code> at the beginning of this document.
3130 <column name="external_ids"/>
3131 <column name="other_config"/>
3135 <table name="NetFlow">
3136 A NetFlow target. NetFlow is a protocol that exports a number of
3137 details about terminating IP flows, such as the principals involved
3140 <column name="targets">
3141 NetFlow targets in the form
3142 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3143 must be specified numerically, not as a DNS name.
3146 <column name="engine_id">
3147 Engine ID to use in NetFlow messages. Defaults to datapath index
3151 <column name="engine_type">
3152 Engine type to use in NetFlow messages. Defaults to datapath
3153 index if not specified.
3156 <column name="active_timeout">
3157 The interval at which NetFlow records are sent for flows that are
3158 still active, in seconds. A value of <code>0</code> requests the
3159 default timeout (currently 600 seconds); a value of <code>-1</code>
3160 disables active timeouts.
3163 <column name="add_id_to_interface">
3164 <p>If this column's value is <code>false</code>, the ingress and egress
3165 interface fields of NetFlow flow records are derived from OpenFlow port
3166 numbers. When it is <code>true</code>, the 7 most significant bits of
3167 these fields will be replaced by the least significant 7 bits of the
3168 engine id. This is useful because many NetFlow collectors do not
3169 expect multiple switches to be sending messages from the same host, so
3170 they do not store the engine information which could be used to
3171 disambiguate the traffic.</p>
3172 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3175 <group title="Common Columns">
3176 The overall purpose of these columns is described under <code>Common
3177 Columns</code> at the beginning of this document.
3179 <column name="external_ids"/>
3184 SSL configuration for an Open_vSwitch.
3186 <column name="private_key">
3187 Name of a PEM file containing the private key used as the switch's
3188 identity for SSL connections to the controller.
3191 <column name="certificate">
3192 Name of a PEM file containing a certificate, signed by the
3193 certificate authority (CA) used by the controller and manager,
3194 that certifies the switch's private key, identifying a trustworthy
3198 <column name="ca_cert">
3199 Name of a PEM file containing the CA certificate used to verify
3200 that the switch is connected to a trustworthy controller.
3203 <column name="bootstrap_ca_cert">
3204 If set to <code>true</code>, then Open vSwitch will attempt to
3205 obtain the CA certificate from the controller on its first SSL
3206 connection and save it to the named PEM file. If it is successful,
3207 it will immediately drop the connection and reconnect, and from then
3208 on all SSL connections must be authenticated by a certificate signed
3209 by the CA certificate thus obtained. <em>This option exposes the
3210 SSL connection to a man-in-the-middle attack obtaining the initial
3211 CA certificate.</em> It may still be useful for bootstrapping.
3214 <group title="Common Columns">
3215 The overall purpose of these columns is described under <code>Common
3216 Columns</code> at the beginning of this document.
3218 <column name="external_ids"/>
3222 <table name="sFlow">
3223 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
3224 monitoring of switches.</p>
3226 <column name="agent">
3227 Name of the network device whose IP address should be reported as the
3228 ``agent address'' to collectors. If not specified, the agent device is
3229 figured from the first target address and the routing table. If the
3230 routing table does not contain a route to the target, the IP address
3231 defaults to the <ref table="Controller" column="local_ip"/> in the
3232 collector's <ref table="Controller"/>. If an agent IP address cannot be
3233 determined any of these ways, sFlow is disabled.
3236 <column name="header">
3237 Number of bytes of a sampled packet to send to the collector.
3238 If not specified, the default is 128 bytes.
3241 <column name="polling">
3242 Polling rate in seconds to send port statistics to the collector.
3243 If not specified, defaults to 30 seconds.
3246 <column name="sampling">
3247 Rate at which packets should be sampled and sent to the collector.
3248 If not specified, defaults to 400, which means one out of 400
3249 packets, on average, will be sent to the collector.
3252 <column name="targets">
3253 sFlow targets in the form
3254 <code><var>ip</var>:<var>port</var></code>.
3257 <group title="Common Columns">
3258 The overall purpose of these columns is described under <code>Common
3259 Columns</code> at the beginning of this document.
3261 <column name="external_ids"/>
3265 <table name="IPFIX">
3266 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3267 number of details about flows.</p>
3269 <column name="targets">
3270 IPFIX target collectors in the form
3271 <code><var>ip</var>:<var>port</var></code>.
3274 <column name="sampling">
3275 For per-bridge packet sampling, i.e. when this row is referenced
3276 from a <ref table="Bridge"/>, the rate at which packets should
3277 be sampled and sent to each target collector. If not specified,
3278 defaults to 400, which means one out of 400 packets, on average,
3279 will be sent to each target collector. Ignored for per-flow
3280 sampling, i.e. when this row is referenced from a <ref
3281 table="Flow_Sample_Collector_Set"/>.
3284 <column name="obs_domain_id">
3285 For per-bridge packet sampling, i.e. when this row is referenced
3286 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3287 sent in each IPFIX packet. If not specified, defaults to 0.
3288 Ignored for per-flow sampling, i.e. when this row is referenced
3289 from a <ref table="Flow_Sample_Collector_Set"/>.
3292 <column name="obs_point_id">
3293 For per-bridge packet sampling, i.e. when this row is referenced
3294 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3295 sent in each IPFIX flow record. If not specified, defaults to
3296 0. Ignored for per-flow sampling, i.e. when this row is
3297 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3300 <group title="Common Columns">
3301 The overall purpose of these columns is described under <code>Common
3302 Columns</code> at the beginning of this document.
3304 <column name="external_ids"/>
3308 <table name="Flow_Sample_Collector_Set">
3309 <p>A set of IPFIX collectors of packet samples generated by
3310 OpenFlow <code>sample</code> actions.</p>
3313 The ID of this collector set, unique among the bridge's
3314 collector sets, to be used as the <code>collector_set_id</code>
3315 in OpenFlow <code>sample</code> actions.
3318 <column name="bridge">
3319 The bridge into which OpenFlow <code>sample</code> actions can
3320 be added to send packet samples to this set of IPFIX collectors.
3323 <column name="ipfix">
3324 Configuration of the set of IPFIX collectors to send one flow
3325 record per sampled packet to.
3328 <group title="Common Columns">
3329 The overall purpose of these columns is described under <code>Common
3330 Columns</code> at the beginning of this document.
3332 <column name="external_ids"/>