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.
126 <column name="other_config" key="flow-eviction-threshold"
127 type='{"type": "integer", "minInteger": 0}'>
129 A number of flows as a nonnegative integer. This sets number of
130 flows at which eviction from the datapath flow table will be
131 triggered. If there are a large number of flows then increasing this
132 value to around the number of flows present can result in reduced CPU
133 usage and packet loss.
136 The default is 2500. Values below 100 will be rounded up to 100.
140 <column name="other_config" key="force-miss-model">
142 Specifies userspace behaviour for handling flow misses. This takes
143 precedence over flow-eviction-threshold.
147 <dt><code>auto</code></dt>
148 <dd>Handle automatically based on the flow-eviction-threshold and
149 the flow setup governer (default, recommended).</dd>
150 <dt><code>with-facets</code></dt>
151 <dd>Always create facets. Expensive kernel flow creation and
152 statistics tracking is always performed, even on flows with only
153 a small number of packets.</dd>
154 <dt><code>without-facets</code></dt>
155 <dd>Always handle without facets. Forces flow misses to be handled
156 in userspace. May cause an increase in CPU usage and packet loss
157 on high throughput.</dd>
162 <column name="other_config" key="n-handler-threads"
163 type='{"type": "integer", "minInteger": 1}'>
165 Specifies the number of threads for software datapaths to use for
166 handling new flows. The default is two less than the number of
167 online CPU cores (but at least 1).
170 This configuration is per datapath. If you have more than one
171 software datapath (e.g. some <code>system</code> bridges and some
172 <code>netdev</code> bridges), then the total number of threads is
173 <code>n-handler-threads</code> times the number of software
179 <group title="Status">
180 <column name="next_cfg">
181 Sequence number for client to increment. When a client modifies
182 any part of the database configuration and wishes to wait for
183 Open vSwitch to finish applying the changes, it may increment
184 this sequence number.
187 <column name="cur_cfg">
188 Sequence number that Open vSwitch sets to the current value of
189 <ref column="next_cfg"/> after it finishes applying a set of
190 configuration changes.
193 <group title="Statistics">
195 The <code>statistics</code> column contains key-value pairs that
196 report statistics about a system running an Open vSwitch. These are
197 updated periodically (currently, every 5 seconds). Key-value pairs
198 that cannot be determined or that do not apply to a platform are
202 <column name="other_config" key="enable-statistics"
203 type='{"type": "boolean"}'>
204 Statistics are disabled by default to avoid overhead in the common
205 case when statistics gathering is not useful. Set this value to
206 <code>true</code> to enable populating the <ref column="statistics"/>
207 column or to <code>false</code> to explicitly disable it.
210 <column name="statistics" key="cpu"
211 type='{"type": "integer", "minInteger": 1}'>
213 Number of CPU processors, threads, or cores currently online and
214 available to the operating system on which Open vSwitch is running,
215 as an integer. This may be less than the number installed, if some
216 are not online or if they are not available to the operating
220 Open vSwitch userspace processes are not multithreaded, but the
221 Linux kernel-based datapath is.
225 <column name="statistics" key="load_average">
226 A comma-separated list of three floating-point numbers,
227 representing the system load average over the last 1, 5, and 15
228 minutes, respectively.
231 <column name="statistics" key="memory">
233 A comma-separated list of integers, each of which represents a
234 quantity of memory in kilobytes that describes the operating
235 system on which Open vSwitch is running. In respective order,
240 <li>Total amount of RAM allocated to the OS.</li>
241 <li>RAM allocated to the OS that is in use.</li>
242 <li>RAM that can be flushed out to disk or otherwise discarded
243 if that space is needed for another purpose. This number is
244 necessarily less than or equal to the previous value.</li>
245 <li>Total disk space allocated for swap.</li>
246 <li>Swap space currently in use.</li>
250 On Linux, all five values can be determined and are included. On
251 other operating systems, only the first two values can be
252 determined, so the list will only have two values.
256 <column name="statistics" key="process_NAME">
258 One such key-value pair, with <code>NAME</code> replaced by
259 a process name, will exist for each running Open vSwitch
260 daemon process, with <var>name</var> replaced by the
261 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
262 value is a comma-separated list of integers. The integers
263 represent the following, with memory measured in kilobytes
264 and durations in milliseconds:
268 <li>The process's virtual memory size.</li>
269 <li>The process's resident set size.</li>
270 <li>The amount of user and system CPU time consumed by the
272 <li>The number of times that the process has crashed and been
273 automatically restarted by the monitor.</li>
274 <li>The duration since the process was started.</li>
275 <li>The duration for which the process has been running.</li>
279 The interpretation of some of these values depends on whether the
280 process was started with the <option>--monitor</option>. If it
281 was not, then the crash count will always be 0 and the two
282 durations will always be the same. If <option>--monitor</option>
283 was given, then the crash count may be positive; if it is, the
284 latter duration is the amount of time since the most recent crash
289 There will be one key-value pair for each file in Open vSwitch's
290 ``run directory'' (usually <code>/var/run/openvswitch</code>)
291 whose name ends in <code>.pid</code>, whose contents are a
292 process ID, and which is locked by a running process. The
293 <var>name</var> is taken from the pidfile's name.
297 Currently Open vSwitch is only able to obtain all of the above
298 detail on Linux systems. On other systems, the same key-value
299 pairs will be present but the values will always be the empty
304 <column name="statistics" key="file_systems">
306 A space-separated list of information on local, writable file
307 systems. Each item in the list describes one file system and
308 consists in turn of a comma-separated list of the following:
312 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
313 Any spaces or commas in the mount point are replaced by
315 <li>Total size, in kilobytes, as an integer.</li>
316 <li>Amount of storage in use, in kilobytes, as an integer.</li>
320 This key-value pair is omitted if there are no local, writable
321 file systems or if Open vSwitch cannot obtain the needed
328 <group title="Version Reporting">
330 These columns report the types and versions of the hardware and
331 software running Open vSwitch. We recommend in general that software
332 should test whether specific features are supported instead of relying
333 on version number checks. These values are primarily intended for
334 reporting to human administrators.
337 <column name="ovs_version">
338 The Open vSwitch version number, e.g. <code>1.1.0</code>.
341 <column name="db_version">
343 The database schema version number in the form
344 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
345 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
346 a non-backward compatible way (e.g. deleting a column or a table),
347 <var>major</var> is incremented. When the database schema is changed
348 in a backward compatible way (e.g. adding a new column),
349 <var>minor</var> is incremented. When the database schema is changed
350 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
355 The schema version is part of the database schema, so it can also be
356 retrieved by fetching the schema using the Open vSwitch database
361 <column name="system_type">
363 An identifier for the type of system on top of which Open vSwitch
364 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
367 System integrators are responsible for choosing and setting an
368 appropriate value for this column.
372 <column name="system_version">
374 The version of the system identified by <ref column="system_type"/>,
375 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
378 System integrators are responsible for choosing and setting an
379 appropriate value for this column.
385 <group title="Database Configuration">
387 These columns primarily configure the Open vSwitch database
388 (<code>ovsdb-server</code>), not the Open vSwitch switch
389 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
390 column="ssl"/> settings.
394 The Open vSwitch switch does read the database configuration to
395 determine remote IP addresses to which in-band control should apply.
398 <column name="manager_options">
399 Database clients to which the Open vSwitch database server should
400 connect or to which it should listen, along with options for how these
401 connection should be configured. See the <ref table="Manager"/> table
402 for more information.
406 <group title="Common Columns">
407 The overall purpose of these columns is described under <code>Common
408 Columns</code> at the beginning of this document.
410 <column name="other_config"/>
411 <column name="external_ids"/>
415 <table name="Bridge">
417 Configuration for a bridge within an
418 <ref table="Open_vSwitch"/>.
421 A <ref table="Bridge"/> record represents an Ethernet switch with one or
422 more ``ports,'' which are the <ref table="Port"/> records pointed to by
423 the <ref table="Bridge"/>'s <ref column="ports"/> column.
426 <group title="Core Features">
428 Bridge identifier. Should be alphanumeric and no more than about 8
429 bytes long. Must be unique among the names of ports, interfaces, and
433 <column name="ports">
434 Ports included in the bridge.
437 <column name="mirrors">
438 Port mirroring configuration.
441 <column name="netflow">
442 NetFlow configuration.
445 <column name="sflow">
446 sFlow(R) configuration.
449 <column name="ipfix">
453 <column name="flood_vlans">
455 VLAN IDs of VLANs on which MAC address learning should be disabled,
456 so that packets are flooded instead of being sent to specific ports
457 that are believed to contain packets' destination MACs. This should
458 ordinarily be used to disable MAC learning on VLANs used for
459 mirroring (RSPAN VLANs). It may also be useful for debugging.
462 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
463 the <ref table="Port"/> table) is incompatible with
464 <code>flood_vlans</code>. Consider using another bonding mode or
465 a different type of mirror instead.
470 <group title="OpenFlow Configuration">
471 <column name="controller">
473 OpenFlow controller set. If unset, then no OpenFlow controllers
478 If there are primary controllers, removing all of them clears the
479 flow table. If there are no primary controllers, adding one also
480 clears the flow table. Other changes to the set of controllers, such
481 as adding or removing a service controller, adding another primary
482 controller to supplement an existing primary controller, or removing
483 only one of two primary controllers, have no effect on the flow
488 <column name="flow_tables">
489 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
490 table ID to configuration for that table.
493 <column name="fail_mode">
494 <p>When a controller is configured, it is, ordinarily, responsible
495 for setting up all flows on the switch. Thus, if the connection to
496 the controller fails, no new network connections can be set up.
497 If the connection to the controller stays down long enough,
498 no packets can pass through the switch at all. This setting
499 determines the switch's response to such a situation. It may be set
500 to one of the following:
502 <dt><code>standalone</code></dt>
503 <dd>If no message is received from the controller for three
504 times the inactivity probe interval
505 (see <ref column="inactivity_probe"/>), then Open vSwitch
506 will take over responsibility for setting up flows. In
507 this mode, Open vSwitch causes the bridge to act like an
508 ordinary MAC-learning switch. Open vSwitch will continue
509 to retry connecting to the controller in the background
510 and, when the connection succeeds, it will discontinue its
511 standalone behavior.</dd>
512 <dt><code>secure</code></dt>
513 <dd>Open vSwitch will not set up flows on its own when the
514 controller connection fails or when no controllers are
515 defined. The bridge will continue to retry connecting to
516 any defined controllers forever.</dd>
520 The default is <code>standalone</code> if the value is unset, but
521 future versions of Open vSwitch may change the default.
524 The <code>standalone</code> mode can create forwarding loops on a
525 bridge that has more than one uplink port unless STP is enabled. To
526 avoid loops on such a bridge, configure <code>secure</code> mode or
527 enable STP (see <ref column="stp_enable"/>).
529 <p>When more than one controller is configured,
530 <ref column="fail_mode"/> is considered only when none of the
531 configured controllers can be contacted.</p>
533 Changing <ref column="fail_mode"/> when no primary controllers are
534 configured clears the flow table.
538 <column name="datapath_id">
539 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
540 (Setting this column has no useful effect. Set <ref
541 column="other-config" key="datapath-id"/> instead.)
544 <column name="other_config" key="datapath-id">
545 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
546 value. May not be all-zero.
549 <column name="other_config" key="dp-desc">
550 Human readable description of datapath. It it a maximum 256
551 byte-long free-form string to describe the datapath for
552 debugging purposes, e.g. <code>switch3 in room 3120</code>.
555 <column name="other_config" key="disable-in-band"
556 type='{"type": "boolean"}'>
557 If set to <code>true</code>, disable in-band control on the bridge
558 regardless of controller and manager settings.
561 <column name="other_config" key="in-band-queue"
562 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
563 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
564 that will be used by flows set up by in-band control on this bridge.
565 If unset, or if the port used by an in-band control flow does not have
566 QoS configured, or if the port does not have a queue with the specified
567 ID, the default queue is used instead.
570 <column name="protocols">
571 List of OpenFlow protocols that may be used when negotiating a
572 connection with a controller. A default value of
573 <code>OpenFlow10</code> will be used if this column is empty.
577 <group title="Spanning Tree Configuration">
578 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
579 that ensures loop-free topologies. It allows redundant links to
580 be included in the network to provide automatic backup paths if
581 the active links fails.
583 <column name="stp_enable">
584 Enable spanning tree on the bridge. By default, STP is disabled
585 on bridges. Bond, internal, and mirror ports are not supported
586 and will not participate in the spanning tree.
589 <column name="other_config" key="stp-system-id">
590 The bridge's STP identifier (the lower 48 bits of the bridge-id)
592 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
593 By default, the identifier is the MAC address of the bridge.
596 <column name="other_config" key="stp-priority"
597 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
598 The bridge's relative priority value for determining the root
599 bridge (the upper 16 bits of the bridge-id). A bridge with the
600 lowest bridge-id is elected the root. By default, the priority
604 <column name="other_config" key="stp-hello-time"
605 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
606 The interval between transmissions of hello messages by
607 designated ports, in seconds. By default the hello interval is
611 <column name="other_config" key="stp-max-age"
612 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
613 The maximum age of the information transmitted by the bridge
614 when it is the root bridge, in seconds. By default, the maximum
618 <column name="other_config" key="stp-forward-delay"
619 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
620 The delay to wait between transitioning root and designated
621 ports to <code>forwarding</code>, in seconds. By default, the
622 forwarding delay is 15 seconds.
626 <group title="Other Features">
627 <column name="datapath_type">
628 Name of datapath provider. The kernel datapath has
629 type <code>system</code>. The userspace datapath has
630 type <code>netdev</code>.
633 <column name="external_ids" key="bridge-id">
634 A unique identifier of the bridge. On Citrix XenServer this will
635 commonly be the same as
636 <ref column="external_ids" key="xs-network-uuids"/>.
639 <column name="external_ids" key="xs-network-uuids">
640 Semicolon-delimited set of universally unique identifier(s) for the
641 network with which this bridge is associated on a Citrix XenServer
642 host. The network identifiers are RFC 4122 UUIDs as displayed by,
643 e.g., <code>xe network-list</code>.
646 <column name="other_config" key="hwaddr">
647 An Ethernet address in the form
648 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
649 to set the hardware address of the local port and influence the
653 <column name="other_config" key="forward-bpdu"
654 type='{"type": "boolean"}'>
655 Option to allow forwarding of BPDU frames when NORMAL action is
656 invoked. Frames with reserved Ethernet addresses (e.g. STP
657 BPDU) will be forwarded when this option is enabled and the
658 switch is not providing that functionality. If STP is enabled
659 on the port, STP BPDUs will never be forwarded. If the Open
660 vSwitch bridge is used to connect different Ethernet networks,
661 and if Open vSwitch node does not run STP, then this option
662 should be enabled. Default is disabled, set to
663 <code>true</code> to enable.
665 The following destination MAC addresss will not be forwarded when this
668 <dt><code>01:80:c2:00:00:00</code></dt>
669 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
671 <dt><code>01:80:c2:00:00:01</code></dt>
672 <dd>IEEE Pause frame.</dd>
674 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
675 <dd>Other reserved protocols.</dd>
677 <dt><code>00:e0:2b:00:00:00</code></dt>
678 <dd>Extreme Discovery Protocol (EDP).</dd>
681 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
683 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
685 <dt><code>01:00:0c:cc:cc:cc</code></dt>
687 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
688 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
692 <dt><code>01:00:0c:cc:cc:cd</code></dt>
693 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
695 <dt><code>01:00:0c:cd:cd:cd</code></dt>
696 <dd>Cisco STP Uplink Fast.</dd>
698 <dt><code>01:00:0c:00:00:00</code></dt>
699 <dd>Cisco Inter Switch Link.</dd>
701 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
706 <column name="other_config" key="mac-aging-time"
707 type='{"type": "integer", "minInteger": 1}'>
709 The maximum number of seconds to retain a MAC learning entry for
710 which no packets have been seen. The default is currently 300
711 seconds (5 minutes). The value, if specified, is forced into a
712 reasonable range, currently 15 to 3600 seconds.
716 A short MAC aging time allows a network to more quickly detect that a
717 host is no longer connected to a switch port. However, it also makes
718 it more likely that packets will be flooded unnecessarily, when they
719 are addressed to a connected host that rarely transmits packets. To
720 reduce the incidence of unnecessary flooding, use a MAC aging time
721 longer than the maximum interval at which a host will ordinarily
726 <column name="other_config" key="mac-table-size"
727 type='{"type": "integer", "minInteger": 1}'>
729 The maximum number of MAC addresses to learn. The default is
730 currently 2048. The value, if specified, is forced into a reasonable
731 range, currently 10 to 1,000,000.
736 <group title="Bridge Status">
738 Status information about bridges.
740 <column name="status">
741 Key-value pairs that report bridge status.
743 <column name="status" key="stp_bridge_id">
745 The bridge-id (in hex) used in spanning tree advertisements.
746 Configuring the bridge-id is described in the
747 <code>stp-system-id</code> and <code>stp-priority</code> keys
748 of the <code>other_config</code> section earlier.
751 <column name="status" key="stp_designated_root">
753 The designated root (in hex) for this spanning tree.
756 <column name="status" key="stp_root_path_cost">
758 The path cost of reaching the designated bridge. A lower
764 <group title="Common Columns">
765 The overall purpose of these columns is described under <code>Common
766 Columns</code> at the beginning of this document.
768 <column name="other_config"/>
769 <column name="external_ids"/>
773 <table name="Port" table="Port or bond configuration.">
774 <p>A port within a <ref table="Bridge"/>.</p>
775 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
776 <ref column="interfaces"/> column. Such a port logically
777 corresponds to a port on a physical Ethernet switch. A port
778 with more than one interface is a ``bonded port'' (see
779 <ref group="Bonding Configuration"/>).</p>
780 <p>Some properties that one might think as belonging to a port are actually
781 part of the port's <ref table="Interface"/> members.</p>
784 Port name. Should be alphanumeric and no more than about 8
785 bytes long. May be the same as the interface name, for
786 non-bonded ports. Must otherwise be unique among the names of
787 ports, interfaces, and bridges on a host.
790 <column name="interfaces">
791 The port's interfaces. If there is more than one, this is a
795 <group title="VLAN Configuration">
796 <p>Bridge ports support the following types of VLAN configuration:</p>
801 A trunk port carries packets on one or more specified VLANs
802 specified in the <ref column="trunks"/> column (often, on every
803 VLAN). A packet that ingresses on a trunk port is in the VLAN
804 specified in its 802.1Q header, or VLAN 0 if the packet has no
805 802.1Q header. A packet that egresses through a trunk port will
806 have an 802.1Q header if it has a nonzero VLAN ID.
810 Any packet that ingresses on a trunk port tagged with a VLAN that
811 the port does not trunk is dropped.
818 An access port carries packets on exactly one VLAN specified in the
819 <ref column="tag"/> column. Packets egressing on an access port
820 have no 802.1Q header.
824 Any packet with an 802.1Q header with a nonzero VLAN ID that
825 ingresses on an access port is dropped, regardless of whether the
826 VLAN ID in the header is the access port's VLAN ID.
830 <dt>native-tagged</dt>
832 A native-tagged port resembles a trunk port, with the exception that
833 a packet without an 802.1Q header that ingresses on a native-tagged
834 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
838 <dt>native-untagged</dt>
840 A native-untagged port resembles a native-tagged port, with the
841 exception that a packet that egresses on a native-untagged port in
842 the native VLAN will not have an 802.1Q header.
846 A packet will only egress through bridge ports that carry the VLAN of
847 the packet, as described by the rules above.
850 <column name="vlan_mode">
852 The VLAN mode of the port, as described above. When this column is
853 empty, a default mode is selected as follows:
857 If <ref column="tag"/> contains a value, the port is an access
858 port. The <ref column="trunks"/> column should be empty.
861 Otherwise, the port is a trunk port. The <ref column="trunks"/>
862 column value is honored if it is present.
869 For an access port, the port's implicitly tagged VLAN. For a
870 native-tagged or native-untagged port, the port's native VLAN. Must
871 be empty if this is a trunk port.
875 <column name="trunks">
877 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
878 or VLANs that this port trunks; if it is empty, then the port trunks
879 all VLANs. Must be empty if this is an access port.
882 A native-tagged or native-untagged port always trunks its native
883 VLAN, regardless of whether <ref column="trunks"/> includes that
888 <column name="other_config" key="priority-tags"
889 type='{"type": "boolean"}'>
891 An 802.1Q header contains two important pieces of information: a VLAN
892 ID and a priority. A frame with a zero VLAN ID, called a
893 ``priority-tagged'' frame, is supposed to be treated the same way as
894 a frame without an 802.1Q header at all (except for the priority).
898 However, some network elements ignore any frame that has 802.1Q
899 header at all, even when the VLAN ID is zero. Therefore, by default
900 Open vSwitch does not output priority-tagged frames, instead omitting
901 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
902 <code>true</code> to enable priority-tagged frames on a port.
906 Regardless of this setting, Open vSwitch omits the 802.1Q header on
907 output if both the VLAN ID and priority would be zero.
911 All frames output to native-tagged ports have a nonzero VLAN ID, so
912 this setting is not meaningful on native-tagged ports.
917 <group title="Bonding Configuration">
918 <p>A port that has more than one interface is a ``bonded port.'' Bonding
919 allows for load balancing and fail-over.</p>
922 The following types of bonding will work with any kind of upstream
923 switch. On the upstream switch, do not configure the interfaces as a
928 <dt><code>balance-slb</code></dt>
930 Balances flows among slaves based on source MAC address and output
931 VLAN, with periodic rebalancing as traffic patterns change.
934 <dt><code>active-backup</code></dt>
936 Assigns all flows to one slave, failing over to a backup slave when
937 the active slave is disabled. This is the only bonding mode in which
938 interfaces may be plugged into different upstream switches.
943 The following modes require the upstream switch to support 802.3ad with
944 successful LACP negotiation:
948 <dt><code>balance-tcp</code></dt>
950 Balances flows among slaves based on L2, L3, and L4 protocol
951 information such as destination MAC address, IP address, and TCP
956 <p>These columns apply only to bonded ports. Their values are
957 otherwise ignored.</p>
959 <column name="bond_mode">
960 <p>The type of bonding used for a bonded port. Defaults to
961 <code>active-backup</code> if unset.
965 <column name="other_config" key="bond-hash-basis"
966 type='{"type": "integer"}'>
967 An integer hashed along with flows when choosing output slaves in load
968 balanced bonds. When changed, all flows will be assigned different
969 hash values possibly causing slave selection decisions to change. Does
970 not affect bonding modes which do not employ load balancing such as
971 <code>active-backup</code>.
974 <group title="Link Failure Detection">
976 An important part of link bonding is detecting that links are down so
977 that they may be disabled. These settings determine how Open vSwitch
978 detects link failure.
981 <column name="other_config" key="bond-detect-mode"
982 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
983 The means used to detect link failures. Defaults to
984 <code>carrier</code> which uses each interface's carrier to detect
985 failures. When set to <code>miimon</code>, will check for failures
986 by polling each interface's MII.
989 <column name="other_config" key="bond-miimon-interval"
990 type='{"type": "integer"}'>
991 The interval, in milliseconds, between successive attempts to poll
992 each interface's MII. Relevant only when <ref column="other_config"
993 key="bond-detect-mode"/> is <code>miimon</code>.
996 <column name="bond_updelay">
998 The number of milliseconds for which the link must stay up on an
999 interface before the interface is considered to be up. Specify
1000 <code>0</code> to enable the interface immediately.
1004 This setting is honored only when at least one bonded interface is
1005 already enabled. When no interfaces are enabled, then the first
1006 bond interface to come up is enabled immediately.
1010 <column name="bond_downdelay">
1011 The number of milliseconds for which the link must stay down on an
1012 interface before the interface is considered to be down. Specify
1013 <code>0</code> to disable the interface immediately.
1017 <group title="LACP Configuration">
1019 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1020 allows switches to automatically detect that they are connected by
1021 multiple links and aggregate across those links. These settings
1022 control LACP behavior.
1025 <column name="lacp">
1026 Configures LACP on this port. LACP allows directly connected
1027 switches to negotiate which links may be bonded. LACP may be enabled
1028 on non-bonded ports for the benefit of any switches they may be
1029 connected to. <code>active</code> ports are allowed to initiate LACP
1030 negotiations. <code>passive</code> ports are allowed to participate
1031 in LACP negotiations initiated by a remote switch, but not allowed to
1032 initiate such negotiations themselves. If LACP is enabled on a port
1033 whose partner switch does not support LACP, the bond will be
1034 disabled. Defaults to <code>off</code> if unset.
1037 <column name="other_config" key="lacp-system-id">
1038 The LACP system ID of this <ref table="Port"/>. The system ID of a
1039 LACP bond is used to identify itself to its partners. Must be a
1040 nonzero MAC address. Defaults to the bridge Ethernet address if
1044 <column name="other_config" key="lacp-system-priority"
1045 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1046 The LACP system priority of this <ref table="Port"/>. In LACP
1047 negotiations, link status decisions are made by the system with the
1048 numerically lower priority.
1051 <column name="other_config" key="lacp-time"
1052 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1054 The LACP timing which should be used on this <ref table="Port"/>.
1055 By default <code>slow</code> is used. When configured to be
1056 <code>fast</code> LACP heartbeats are requested at a rate of once
1057 per second causing connectivity problems to be detected more
1058 quickly. In <code>slow</code> mode, heartbeats are requested at a
1059 rate of once every 30 seconds.
1064 <group title="Rebalancing Configuration">
1066 These settings control behavior when a bond is in
1067 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1070 <column name="other_config" key="bond-rebalance-interval"
1071 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1072 For a load balanced bonded port, the number of milliseconds between
1073 successive attempts to rebalance the bond, that is, to move flows
1074 from one interface on the bond to another in an attempt to keep usage
1075 of each interface roughly equal. If zero, load balancing is disabled
1076 on the bond (link failure still cause flows to move). If
1077 less than 1000ms, the rebalance interval will be 1000ms.
1081 <column name="bond_fake_iface">
1082 For a bonded port, whether to create a fake internal interface with the
1083 name of the port. Use only for compatibility with legacy software that
1088 <group title="Spanning Tree Configuration">
1089 <column name="other_config" key="stp-enable"
1090 type='{"type": "boolean"}'>
1091 If spanning tree is enabled on the bridge, member ports are
1092 enabled by default (with the exception of bond, internal, and
1093 mirror ports which do not work with STP). If this column's
1094 value is <code>false</code> spanning tree is disabled on the
1098 <column name="other_config" key="stp-port-num"
1099 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1100 The port number used for the lower 8 bits of the port-id. By
1101 default, the numbers will be assigned automatically. If any
1102 port's number is manually configured on a bridge, then they
1106 <column name="other_config" key="stp-port-priority"
1107 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1108 The port's relative priority value for determining the root
1109 port (the upper 8 bits of the port-id). A port with a lower
1110 port-id will be chosen as the root port. By default, the
1114 <column name="other_config" key="stp-path-cost"
1115 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1116 Spanning tree path cost for the port. A lower number indicates
1117 a faster link. By default, the cost is based on the maximum
1122 <group title="Other Features">
1124 Quality of Service configuration for this port.
1128 The MAC address to use for this port for the purpose of choosing the
1129 bridge's MAC address. This column does not necessarily reflect the
1130 port's actual MAC address, nor will setting it change the port's actual
1134 <column name="fake_bridge">
1135 Does this port represent a sub-bridge for its tagged VLAN within the
1136 Bridge? See ovs-vsctl(8) for more information.
1139 <column name="external_ids" key="fake-bridge-id-*">
1140 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1141 column) are defined by prefixing a <ref table="Bridge"/> <ref
1142 table="Bridge" column="external_ids"/> key with
1143 <code>fake-bridge-</code>,
1144 e.g. <code>fake-bridge-xs-network-uuids</code>.
1148 <group title="Port Status">
1150 Status information about ports attached to bridges.
1152 <column name="status">
1153 Key-value pairs that report port status.
1155 <column name="status" key="stp_port_id">
1157 The port-id (in hex) used in spanning tree advertisements for
1158 this port. Configuring the port-id is described in the
1159 <code>stp-port-num</code> and <code>stp-port-priority</code>
1160 keys of the <code>other_config</code> section earlier.
1163 <column name="status" key="stp_state"
1164 type='{"type": "string", "enum": ["set",
1165 ["disabled", "listening", "learning",
1166 "forwarding", "blocking"]]}'>
1168 STP state of the port.
1171 <column name="status" key="stp_sec_in_state"
1172 type='{"type": "integer", "minInteger": 0}'>
1174 The amount of time (in seconds) port has been in the current
1178 <column name="status" key="stp_role"
1179 type='{"type": "string", "enum": ["set",
1180 ["root", "designated", "alternate"]]}'>
1182 STP role of the port.
1187 <group title="Port Statistics">
1189 Key-value pairs that report port statistics.
1191 <group title="Statistics: STP transmit and receive counters">
1192 <column name="statistics" key="stp_tx_count">
1193 Number of STP BPDUs sent on this port by the spanning
1196 <column name="statistics" key="stp_rx_count">
1197 Number of STP BPDUs received on this port and accepted by the
1198 spanning tree library.
1200 <column name="statistics" key="stp_error_count">
1201 Number of bad STP BPDUs received on this port. Bad BPDUs
1202 include runt packets and those with an unexpected protocol ID.
1207 <group title="Common Columns">
1208 The overall purpose of these columns is described under <code>Common
1209 Columns</code> at the beginning of this document.
1211 <column name="other_config"/>
1212 <column name="external_ids"/>
1216 <table name="Interface" title="One physical network device in a Port.">
1217 An interface within a <ref table="Port"/>.
1219 <group title="Core Features">
1220 <column name="name">
1221 Interface name. Should be alphanumeric and no more than about 8 bytes
1222 long. May be the same as the port name, for non-bonded ports. Must
1223 otherwise be unique among the names of ports, interfaces, and bridges
1227 <column name="ifindex">
1228 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1229 2863, if the interface has one, otherwise 0. The ifindex is useful for
1230 seamless integration with protocols such as SNMP and sFlow.
1233 <column name="mac_in_use">
1234 The MAC address in use by this interface.
1238 <p>Ethernet address to set for this interface. If unset then the
1239 default MAC address is used:</p>
1241 <li>For the local interface, the default is the lowest-numbered MAC
1242 address among the other bridge ports, either the value of the
1243 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1244 if set, or its actual MAC (for bonded ports, the MAC of its slave
1245 whose name is first in alphabetical order). Internal ports and
1246 bridge ports that are used as port mirroring destinations (see the
1247 <ref table="Mirror"/> table) are ignored.</li>
1248 <li>For other internal interfaces, the default MAC is randomly
1250 <li>External interfaces typically have a MAC address associated with
1251 their hardware.</li>
1253 <p>Some interfaces may not have a software-controllable MAC
1257 <group title="OpenFlow Port Number">
1259 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1260 port number for the new port. If the client that adds the port fills
1261 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1262 value as the OpenFlow port number. Otherwise, or if the requested
1263 port number is already in use or cannot be used for another reason,
1264 Open vSwitch automatically assigns a free port number. Regardless of
1265 how the port number was obtained, Open vSwitch then reports in <ref
1266 column="ofport"/> the port number actually assigned.
1270 Open vSwitch limits the port numbers that it automatically assigns to
1271 the range 1 through 32,767, inclusive. Controllers therefore have
1272 free use of ports 32,768 and up.
1275 <column name="ofport">
1277 OpenFlow port number for this interface. Open vSwitch sets this
1278 column's value, so other clients should treat it as read-only.
1281 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1282 The other valid port numbers are in the range 1 to 65,279,
1283 inclusive. Value -1 indicates an error adding the interface.
1287 <column name="ofport_request"
1288 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1290 Requested OpenFlow port number for this interface.
1294 Open vSwitch currently assigns the OpenFlow port number for an
1295 interface once, when the client first adds the interface. It does
1296 not change the port number later if the client sets or changes or
1297 clears <ref column="ofport_request"/>. Therefore, to ensure that
1298 <ref column="ofport_request"/> takes effect, the client should set
1299 it in the same database transaction that creates the interface.
1300 (Future versions of Open vSwitch might honor changes to <ref
1301 column="ofport_request"/>.)
1307 <group title="System-Specific Details">
1308 <column name="type">
1310 The interface type, one of:
1314 <dt><code>system</code></dt>
1315 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1316 Sometimes referred to as ``external interfaces'' since they are
1317 generally connected to hardware external to that on which the Open
1318 vSwitch is running. The empty string is a synonym for
1319 <code>system</code>.</dd>
1321 <dt><code>internal</code></dt>
1322 <dd>A simulated network device that sends and receives traffic. An
1323 internal interface whose <ref column="name"/> is the same as its
1324 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1325 ``local interface.'' It does not make sense to bond an internal
1326 interface, so the terms ``port'' and ``interface'' are often used
1327 imprecisely for internal interfaces.</dd>
1329 <dt><code>tap</code></dt>
1330 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1332 <dt><code>gre</code></dt>
1334 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1338 <dt><code>ipsec_gre</code></dt>
1340 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1344 <dt><code>gre64</code></dt>
1346 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1347 of key, it uses GRE protocol sequence number field. This is non
1348 standard use of GRE protocol since OVS does not increment
1349 sequence number for every packet at time of encap as expected by
1350 standard GRE implementation. See <ref group="Tunnel Options"/>
1351 for information on configuring GRE tunnels.
1354 <dt><code>ipsec_gre64</code></dt>
1356 Same as IPSEC_GRE except 64 bit key.
1359 <dt><code>vxlan</code></dt>
1362 An Ethernet tunnel over the experimental, UDP-based VXLAN
1363 protocol described at
1364 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1367 Open vSwitch uses UDP destination port 4789. The source port used for
1368 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1373 <dt><code>lisp</code></dt>
1375 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1376 Separation Protocol (RFC 6830).
1379 <dt><code>patch</code></dt>
1381 A pair of virtual devices that act as a patch cable.
1384 <dt><code>null</code></dt>
1385 <dd>An ignored interface. Deprecated and slated for removal in
1391 <group title="Tunnel Options">
1393 These options apply to interfaces with <ref column="type"/> of
1394 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1395 <code>ipsec_gre64</code>, <code>vxlan</code>, and <code>lisp</code>.
1399 Each tunnel must be uniquely identified by the combination of <ref
1400 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1401 column="options" key="local_ip"/>, and <ref column="options"
1402 key="in_key"/>. If two ports are defined that are the same except one
1403 has an optional identifier and the other does not, the more specific
1404 one is matched first. <ref column="options" key="in_key"/> is
1405 considered more specific than <ref column="options" key="local_ip"/> if
1406 a port defines one and another port defines the other.
1409 <column name="options" key="remote_ip">
1410 <p>Required. The remote tunnel endpoint, one of:</p>
1414 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1415 Only unicast endpoints are supported.
1418 The word <code>flow</code>. The tunnel accepts packets from any
1419 remote tunnel endpoint. To process only packets from a specific
1420 remote tunnel endpoint, the flow entries may match on the
1421 <code>tun_src</code> field. When sending packets to a
1422 <code>remote_ip=flow</code> tunnel, the flow actions must
1423 explicitly set the <code>tun_dst</code> field to the IP address of
1424 the desired remote tunnel endpoint, e.g. with a
1425 <code>set_field</code> action.
1430 The remote tunnel endpoint for any packet received from a tunnel
1431 is available in the <code>tun_src</code> field for matching in the
1436 <column name="options" key="local_ip">
1438 Optional. The tunnel destination IP that received packets must
1439 match. Default is to match all addresses. If specified, may be one
1445 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1448 The word <code>flow</code>. The tunnel accepts packets sent to any
1449 of the local IP addresses of the system running OVS. To process
1450 only packets sent to a specific IP address, the flow entries may
1451 match on the <code>tun_dst</code> field. When sending packets to a
1452 <code>local_ip=flow</code> tunnel, the flow actions may
1453 explicitly set the <code>tun_src</code> field to the desired IP
1454 address, e.g. with a <code>set_field</code> action. However, while
1455 routing the tunneled packet out, the local system may override the
1456 specified address with the local IP address configured for the
1457 outgoing system interface.
1460 This option is valid only for tunnels also configured with the
1461 <code>remote_ip=flow</code> option.
1467 The tunnel destination IP address for any packet received from a
1468 tunnel is available in the <code>tun_dst</code> field for matching in
1473 <column name="options" key="in_key">
1474 <p>Optional. The key that received packets must contain, one of:</p>
1478 <code>0</code>. The tunnel receives packets with no key or with a
1479 key of 0. This is equivalent to specifying no <ref column="options"
1480 key="in_key"/> at all.
1483 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1484 (for GRE64) number. The tunnel receives only packets with the
1488 The word <code>flow</code>. The tunnel accepts packets with any
1489 key. The key will be placed in the <code>tun_id</code> field for
1490 matching in the flow table. The <code>ovs-ofctl</code> manual page
1491 contains additional information about matching fields in OpenFlow
1500 <column name="options" key="out_key">
1501 <p>Optional. The key to be set on outgoing packets, one of:</p>
1505 <code>0</code>. Packets sent through the tunnel will have no key.
1506 This is equivalent to specifying no <ref column="options"
1507 key="out_key"/> at all.
1510 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1511 (for GRE64) number. Packets sent through the tunnel will have the
1515 The word <code>flow</code>. Packets sent through the tunnel will
1516 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1517 vendor extension (0 is used in the absence of an action). The
1518 <code>ovs-ofctl</code> manual page contains additional information
1519 about the Nicira OpenFlow vendor extensions.
1524 <column name="options" key="key">
1525 Optional. Shorthand to set <code>in_key</code> and
1526 <code>out_key</code> at the same time.
1529 <column name="options" key="tos">
1530 Optional. The value of the ToS bits to be set on the encapsulating
1531 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1532 zero. It may also be the word <code>inherit</code>, in which case
1533 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1534 (otherwise it will be 0). The ECN fields are always inherited.
1538 <column name="options" key="ttl">
1539 Optional. The TTL to be set on the encapsulating packet. It may also
1540 be the word <code>inherit</code>, in which case the TTL will be copied
1541 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1542 system default, typically 64). Default is the system default TTL.
1545 <column name="options" key="df_default"
1546 type='{"type": "boolean"}'>
1547 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1548 outer headers to allow path MTU discovery. Default is enabled; set
1549 to <code>false</code> to disable.
1552 <group title="Tunnel Options: gre and ipsec_gre only">
1554 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1558 <column name="options" key="csum" type='{"type": "boolean"}'>
1560 Optional. Compute GRE checksums on outgoing packets. Default is
1561 disabled, set to <code>true</code> to enable. Checksums present on
1562 incoming packets will be validated regardless of this setting.
1566 GRE checksums impose a significant performance penalty because they
1567 cover the entire packet. The encapsulated L3, L4, and L7 packet
1568 contents typically have their own checksums, so this additional
1569 checksum only adds value for the GRE and encapsulated L2 headers.
1573 This option is supported for <code>ipsec_gre</code>, but not useful
1574 because GRE checksums are weaker than, and redundant with, IPsec
1575 payload authentication.
1580 <group title="Tunnel Options: ipsec_gre only">
1582 Only <code>ipsec_gre</code> interfaces support these options.
1585 <column name="options" key="peer_cert">
1586 Required for certificate authentication. A string containing the
1587 peer's certificate in PEM format. Additionally the host's
1588 certificate must be specified with the <code>certificate</code>
1592 <column name="options" key="certificate">
1593 Required for certificate authentication. The name of a PEM file
1594 containing a certificate that will be presented to the peer during
1598 <column name="options" key="private_key">
1599 Optional for certificate authentication. The name of a PEM file
1600 containing the private key associated with <code>certificate</code>.
1601 If <code>certificate</code> contains the private key, this option may
1605 <column name="options" key="psk">
1606 Required for pre-shared key authentication. Specifies a pre-shared
1607 key for authentication that must be identical on both sides of the
1613 <group title="Patch Options">
1615 Only <code>patch</code> interfaces support these options.
1618 <column name="options" key="peer">
1619 The <ref column="name"/> of the <ref table="Interface"/> for the other
1620 side of the patch. The named <ref table="Interface"/>'s own
1621 <code>peer</code> option must specify this <ref table="Interface"/>'s
1622 name. That is, the two patch interfaces must have reversed <ref
1623 column="name"/> and <code>peer</code> values.
1627 <group title="Interface Status">
1629 Status information about interfaces attached to bridges, updated every
1630 5 seconds. Not all interfaces have all of these properties; virtual
1631 interfaces don't have a link speed, for example. Non-applicable
1632 columns will have empty values.
1634 <column name="admin_state">
1636 The administrative state of the physical network link.
1640 <column name="link_state">
1642 The observed state of the physical network link. This is ordinarily
1643 the link's carrier status. If the interface's <ref table="Port"/> is
1644 a bond configured for miimon monitoring, it is instead the network
1645 link's miimon status.
1649 <column name="link_resets">
1651 The number of times Open vSwitch has observed the
1652 <ref column="link_state"/> of this <ref table="Interface"/> change.
1656 <column name="link_speed">
1658 The negotiated speed of the physical network link.
1659 Valid values are positive integers greater than 0.
1663 <column name="duplex">
1665 The duplex mode of the physical network link.
1671 The MTU (maximum transmission unit); i.e. the largest
1672 amount of data that can fit into a single Ethernet frame.
1673 The standard Ethernet MTU is 1500 bytes. Some physical media
1674 and many kinds of virtual interfaces can be configured with
1678 This column will be empty for an interface that does not
1679 have an MTU as, for example, some kinds of tunnels do not.
1683 <column name="lacp_current">
1684 Boolean value indicating LACP status for this interface. If true, this
1685 interface has current LACP information about its LACP partner. This
1686 information may be used to monitor the health of interfaces in a LACP
1687 enabled port. This column will be empty if LACP is not enabled.
1690 <column name="status">
1691 Key-value pairs that report port status. Supported status values are
1692 <ref column="type"/>-dependent; some interfaces may not have a valid
1693 <ref column="status" key="driver_name"/>, for example.
1696 <column name="status" key="driver_name">
1697 The name of the device driver controlling the network adapter.
1700 <column name="status" key="driver_version">
1701 The version string of the device driver controlling the network
1705 <column name="status" key="firmware_version">
1706 The version string of the network adapter's firmware, if available.
1709 <column name="status" key="source_ip">
1710 The source IP address used for an IPv4 tunnel end-point, such as
1714 <column name="status" key="tunnel_egress_iface">
1715 Egress interface for tunnels. Currently only relevant for GRE tunnels
1716 On Linux systems, this column will show the name of the interface
1717 which is responsible for routing traffic destined for the configured
1718 <ref column="options" key="remote_ip"/>. This could be an internal
1719 interface such as a bridge port.
1722 <column name="status" key="tunnel_egress_iface_carrier"
1723 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1724 Whether carrier is detected on <ref column="status"
1725 key="tunnel_egress_iface"/>.
1729 <group title="Statistics">
1731 Key-value pairs that report interface statistics. The current
1732 implementation updates these counters periodically. Future
1733 implementations may update them when an interface is created, when they
1734 are queried (e.g. using an OVSDB <code>select</code> operation), and
1735 just before an interface is deleted due to virtual interface hot-unplug
1736 or VM shutdown, and perhaps at other times, but not on any regular
1740 These are the same statistics reported by OpenFlow in its <code>struct
1741 ofp_port_stats</code> structure. If an interface does not support a
1742 given statistic, then that pair is omitted.
1744 <group title="Statistics: Successful transmit and receive counters">
1745 <column name="statistics" key="rx_packets">
1746 Number of received packets.
1748 <column name="statistics" key="rx_bytes">
1749 Number of received bytes.
1751 <column name="statistics" key="tx_packets">
1752 Number of transmitted packets.
1754 <column name="statistics" key="tx_bytes">
1755 Number of transmitted bytes.
1758 <group title="Statistics: Receive errors">
1759 <column name="statistics" key="rx_dropped">
1760 Number of packets dropped by RX.
1762 <column name="statistics" key="rx_frame_err">
1763 Number of frame alignment errors.
1765 <column name="statistics" key="rx_over_err">
1766 Number of packets with RX overrun.
1768 <column name="statistics" key="rx_crc_err">
1769 Number of CRC errors.
1771 <column name="statistics" key="rx_errors">
1772 Total number of receive errors, greater than or equal to the sum of
1776 <group title="Statistics: Transmit errors">
1777 <column name="statistics" key="tx_dropped">
1778 Number of packets dropped by TX.
1780 <column name="statistics" key="collisions">
1781 Number of collisions.
1783 <column name="statistics" key="tx_errors">
1784 Total number of transmit errors, greater than or equal to the sum of
1790 <group title="Ingress Policing">
1792 These settings control ingress policing for packets received on this
1793 interface. On a physical interface, this limits the rate at which
1794 traffic is allowed into the system from the outside; on a virtual
1795 interface (one connected to a virtual machine), this limits the rate at
1796 which the VM is able to transmit.
1799 Policing is a simple form of quality-of-service that simply drops
1800 packets received in excess of the configured rate. Due to its
1801 simplicity, policing is usually less accurate and less effective than
1802 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1803 table="Queue"/> tables).
1806 Policing is currently implemented only on Linux. The Linux
1807 implementation uses a simple ``token bucket'' approach:
1811 The size of the bucket corresponds to <ref
1812 column="ingress_policing_burst"/>. Initially the bucket is full.
1815 Whenever a packet is received, its size (converted to tokens) is
1816 compared to the number of tokens currently in the bucket. If the
1817 required number of tokens are available, they are removed and the
1818 packet is forwarded. Otherwise, the packet is dropped.
1821 Whenever it is not full, the bucket is refilled with tokens at the
1822 rate specified by <ref column="ingress_policing_rate"/>.
1826 Policing interacts badly with some network protocols, and especially
1827 with fragmented IP packets. Suppose that there is enough network
1828 activity to keep the bucket nearly empty all the time. Then this token
1829 bucket algorithm will forward a single packet every so often, with the
1830 period depending on packet size and on the configured rate. All of the
1831 fragments of an IP packets are normally transmitted back-to-back, as a
1832 group. In such a situation, therefore, only one of these fragments
1833 will be forwarded and the rest will be dropped. IP does not provide
1834 any way for the intended recipient to ask for only the remaining
1835 fragments. In such a case there are two likely possibilities for what
1836 will happen next: either all of the fragments will eventually be
1837 retransmitted (as TCP will do), in which case the same problem will
1838 recur, or the sender will not realize that its packet has been dropped
1839 and data will simply be lost (as some UDP-based protocols will do).
1840 Either way, it is possible that no forward progress will ever occur.
1842 <column name="ingress_policing_rate">
1844 Maximum rate for data received on this interface, in kbps. Data
1845 received faster than this rate is dropped. Set to <code>0</code>
1846 (the default) to disable policing.
1850 <column name="ingress_policing_burst">
1851 <p>Maximum burst size for data received on this interface, in kb. The
1852 default burst size if set to <code>0</code> is 1000 kb. This value
1853 has no effect if <ref column="ingress_policing_rate"/>
1854 is <code>0</code>.</p>
1856 Specifying a larger burst size lets the algorithm be more forgiving,
1857 which is important for protocols like TCP that react severely to
1858 dropped packets. The burst size should be at least the size of the
1859 interface's MTU. Specifying a value that is numerically at least as
1860 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1861 closer to achieving the full rate.
1866 <group title="Bidirectional Forwarding Detection (BFD)">
1868 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
1869 detection of connectivity failures by occasional transmission of
1870 BFD control messages. Open vSwitch implements BFD to serve
1871 as a more popular and standards compliant alternative to CFM.
1875 BFD operates by regularly transmitting BFD control messages at a rate
1876 negotiated independently in each direction. Each endpoint specifies
1877 the rate at which it expects to receive control messages, and the rate
1878 at which it is willing to transmit them. Open vSwitch uses a detection
1879 multiplier of three, meaning that an endpoint signals a connectivity
1880 fault if three consecutive BFD control messages fail to arrive. In the
1881 case of a unidirectional connectivity issue, the system not receiving
1882 BFD control messages signals the problem to its peer in the messages it
1887 The Open vSwitch implementation of BFD aims to comply faithfully
1888 with RFC 5880 requirements. Open vSwitch does not implement the
1889 optional Authentication or ``Echo Mode'' features.
1892 <group title="BFD Configuration">
1894 A controller sets up key-value pairs in the <ref column="bfd"/>
1895 column to enable and configure BFD.
1898 <column name="bfd" key="enable" type='{"type": "boolean"}'>
1899 True to enable BFD on this <ref table="Interface"/>.
1902 <column name="bfd" key="min_rx"
1903 type='{"type": "integer", "minInteger": 1}'>
1904 The shortest interval, in milliseconds, at which this BFD session
1905 offers to receive BFD control messages. The remote endpoint may
1906 choose to send messages at a slower rate. Defaults to
1910 <column name="bfd" key="min_tx"
1911 type='{"type": "integer", "minInteger": 1}'>
1912 The shortest interval, in milliseconds, at which this BFD session is
1913 willing to transmit BFD control messages. Messages will actually be
1914 transmitted at a slower rate if the remote endpoint is not willing to
1915 receive as quickly as specified. Defaults to <code>100</code>.
1918 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
1919 An alternate receive interval, in milliseconds, that must be greater
1920 than or equal to <ref column="bfd" key="min_rx"/>. The
1921 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
1922 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
1923 data traffic at the interface, to reduce the CPU and bandwidth cost
1924 of monitoring an idle interface. This feature may be disabled by
1925 setting a value of 0. This feature is reset whenever <ref
1926 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
1930 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
1931 True to consider the interface capable of packet I/O as long as it
1932 continues to receive any packets (not just BFD packets). This
1933 prevents link congestion that causes consecutive BFD control packets
1934 to be lost from marking the interface down.
1937 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
1938 Set to true to notify the remote endpoint that traffic should not be
1939 forwarded to this system for some reason other than a connectivty
1940 failure on the interface being monitored. The typical underlying
1941 reason is ``concatenated path down,'' that is, that connectivity
1942 beyond the local system is down. Defaults to false.
1945 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
1946 Set to true to make BFD accept only control messages with a tunnel
1947 key of zero. By default, BFD accepts control messages with any
1951 <column name="bfd" key="bfd_dst_mac">
1952 Set to an Ethernet address in the form
1953 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
1954 to set the MAC used as destination for transmitted BFD packets and
1955 expected as destination for received BFD packets. The default is
1956 <code>00:23:20:00:00:01</code>.
1960 <group title="BFD Status">
1962 The switch sets key-value pairs in the <ref column="bfd_status"/>
1963 column to report the status of BFD on this interface. When BFD is
1964 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
1965 all key-value pairs from <ref column="bfd_status"/>.
1968 <column name="bfd_status" key="state"
1969 type='{"type": "string",
1970 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
1971 Reports the state of the BFD session. The BFD session is fully
1972 healthy and negotiated if <code>UP</code>.
1975 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
1976 Reports whether the BFD session believes this <ref
1977 table="Interface"/> may be used to forward traffic. Typically this
1978 means the local session is signaling <code>UP</code>, and the remote
1979 system isn't signaling a problem such as concatenated path down.
1982 <column name="bfd_status" key="diagnostic">
1983 In case of a problem, set to a short message that reports what the
1984 local BFD session thinks is wrong.
1987 <column name="bfd_status" key="remote_state"
1988 type='{"type": "string",
1989 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
1990 Reports the state of the remote endpoint's BFD session.
1993 <column name="bfd_status" key="remote_diagnostic">
1994 In case of a problem, set to a short message that reports what the
1995 remote endpoint's BFD session thinks is wrong.
2000 <group title="Connectivity Fault Management">
2002 802.1ag Connectivity Fault Management (CFM) allows a group of
2003 Maintenance Points (MPs) called a Maintenance Association (MA) to
2004 detect connectivity problems with each other. MPs within a MA should
2005 have complete and exclusive interconnectivity. This is verified by
2006 occasionally broadcasting Continuity Check Messages (CCMs) at a
2007 configurable transmission interval.
2011 According to the 802.1ag specification, each Maintenance Point should
2012 be configured out-of-band with a list of Remote Maintenance Points it
2013 should have connectivity to. Open vSwitch differs from the
2014 specification in this area. It simply assumes the link is faulted if
2015 no Remote Maintenance Points are reachable, and considers it not
2020 When operating over tunnels which have no <code>in_key</code>, or an
2021 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2022 with a tunnel key of zero.
2025 <column name="cfm_mpid">
2026 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
2027 a Maintenance Association. The MPID is used to identify this endpoint
2028 to other Maintenance Points in the MA. Each end of a link being
2029 monitored should have a different MPID. Must be configured to enable
2030 CFM on this <ref table="Interface"/>.
2033 <column name="cfm_flap_count">
2034 Counts the number of cfm fault flapps since boot. A flap is
2035 considered to be a change of the <ref column="cfm_fault"/> value.
2038 <column name="cfm_fault">
2040 Indicates a connectivity fault triggered by an inability to receive
2041 heartbeats from any remote endpoint. When a fault is triggered on
2042 <ref table="Interface"/>s participating in bonds, they will be
2046 Faults can be triggered for several reasons. Most importantly they
2047 are triggered when no CCMs are received for a period of 3.5 times the
2048 transmission interval. Faults are also triggered when any CCMs
2049 indicate that a Remote Maintenance Point is not receiving CCMs but
2050 able to send them. Finally, a fault is triggered if a CCM is
2051 received which indicates unexpected configuration. Notably, this
2052 case arises when a CCM is received which advertises the local MPID.
2056 <column name="cfm_fault_status" key="recv">
2057 Indicates a CFM fault was triggered due to a lack of CCMs received on
2058 the <ref table="Interface"/>.
2061 <column name="cfm_fault_status" key="rdi">
2062 Indicates a CFM fault was triggered due to the reception of a CCM with
2063 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2064 are not receiving CCMs themselves. This typically indicates a
2065 unidirectional connectivity failure.
2068 <column name="cfm_fault_status" key="maid">
2069 Indicates a CFM fault was triggered due to the reception of a CCM with
2070 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2071 with an identification number in addition to the MPID called the MAID.
2072 Open vSwitch only supports receiving CCM broadcasts tagged with the
2073 MAID it uses internally.
2076 <column name="cfm_fault_status" key="loopback">
2077 Indicates a CFM fault was triggered due to the reception of a CCM
2078 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2079 column of this <ref table="Interface"/>. This may indicate a loop in
2083 <column name="cfm_fault_status" key="overflow">
2084 Indicates a CFM fault was triggered because the CFM module received
2085 CCMs from more remote endpoints than it can keep track of.
2088 <column name="cfm_fault_status" key="override">
2089 Indicates a CFM fault was manually triggered by an administrator using
2090 an <code>ovs-appctl</code> command.
2093 <column name="cfm_fault_status" key="interval">
2094 Indicates a CFM fault was triggered due to the reception of a CCM
2095 frame having an invalid interval.
2098 <column name="cfm_remote_opstate">
2099 <p>When in extended mode, indicates the operational state of the
2100 remote endpoint as either <code>up</code> or <code>down</code>. See
2101 <ref column="other_config" key="cfm_opstate"/>.
2105 <column name="cfm_health">
2107 Indicates the health of the interface as a percentage of CCM frames
2108 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2109 The health of an interface is undefined if it is communicating with
2110 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2111 healthy heartbeats are not received at the expected rate, and
2112 gradually improves as healthy heartbeats are received at the desired
2113 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2114 health of the interface is refreshed.
2117 As mentioned above, the faults can be triggered for several reasons.
2118 The link health will deteriorate even if heartbeats are received but
2119 they are reported to be unhealthy. An unhealthy heartbeat in this
2120 context is a heartbeat for which either some fault is set or is out
2121 of sequence. The interface health can be 100 only on receiving
2122 healthy heartbeats at the desired rate.
2126 <column name="cfm_remote_mpids">
2127 When CFM is properly configured, Open vSwitch will occasionally
2128 receive CCM broadcasts. These broadcasts contain the MPID of the
2129 sending Maintenance Point. The list of MPIDs from which this
2130 <ref table="Interface"/> is receiving broadcasts from is regularly
2131 collected and written to this column.
2134 <column name="other_config" key="cfm_interval"
2135 type='{"type": "integer"}'>
2137 The interval, in milliseconds, between transmissions of CFM
2138 heartbeats. Three missed heartbeat receptions indicate a
2143 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2144 60,000, or 600,000 ms are supported. Other values will be rounded
2145 down to the nearest value on the list. Extended mode (see <ref
2146 column="other_config" key="cfm_extended"/>) supports any interval up
2147 to 65,535 ms. In either mode, the default is 1000 ms.
2150 <p>We do not recommend using intervals less than 100 ms.</p>
2153 <column name="other_config" key="cfm_extended"
2154 type='{"type": "boolean"}'>
2155 When <code>true</code>, the CFM module operates in extended mode. This
2156 causes it to use a nonstandard destination address to avoid conflicting
2157 with compliant implementations which may be running concurrently on the
2158 network. Furthermore, extended mode increases the accuracy of the
2159 <code>cfm_interval</code> configuration parameter by breaking wire
2160 compatibility with 802.1ag compliant implementations. Defaults to
2164 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2166 When <code>true</code>, and
2167 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2168 module operates in demand mode. When in demand mode, traffic
2169 received on the <ref table="Interface"/> is used to indicate
2170 liveness. CCMs are still transmitted and received, but if the
2171 <ref table="Interface"/> is receiving traffic, their absence does not
2172 cause a connectivity fault.
2176 Demand mode has a couple of caveats:
2179 To ensure that ovs-vswitchd has enough time to pull statistics
2180 from the datapath, the fault detection interval is set to
2181 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2186 To avoid ambiguity, demand mode disables itself when there are
2187 multiple remote maintenance points.
2191 If the <ref table="Interface"/> is heavily congested, CCMs
2192 containing the <ref column="other_config" key="cfm_opstate"/>
2193 status may be dropped causing changes in the operational state to
2194 be delayed. Similarly, if CCMs containing the RDI bit are not
2195 received, unidirectional link failures may not be detected.
2201 <column name="other_config" key="cfm_opstate"
2202 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2203 When <code>down</code>, the CFM module marks all CCMs it generates as
2204 operationally down without triggering a fault. This allows remote
2205 maintenance points to choose not to forward traffic to the
2206 <ref table="Interface"/> on which this CFM module is running.
2207 Currently, in Open vSwitch, the opdown bit of CCMs affects
2208 <ref table="Interface"/>s participating in bonds, and the bundle
2209 OpenFlow action. This setting is ignored when CFM is not in extended
2210 mode. Defaults to <code>up</code>.
2213 <column name="other_config" key="cfm_ccm_vlan"
2214 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2215 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2216 with the given value. May be the string <code>random</code> in which
2217 case each CCM will be tagged with a different randomly generated VLAN.
2220 <column name="other_config" key="cfm_ccm_pcp"
2221 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2222 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2223 with the given PCP value, the VLAN ID of the tag is governed by the
2224 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2225 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2231 <group title="Bonding Configuration">
2232 <column name="other_config" key="lacp-port-id"
2233 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2234 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2235 used in LACP negotiations to identify individual ports
2236 participating in a bond.
2239 <column name="other_config" key="lacp-port-priority"
2240 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2241 The LACP port priority of this <ref table="Interface"/>. In LACP
2242 negotiations <ref table="Interface"/>s with numerically lower
2243 priorities are preferred for aggregation.
2246 <column name="other_config" key="lacp-aggregation-key"
2247 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2248 The LACP aggregation key of this <ref table="Interface"/>. <ref
2249 table="Interface"/>s with different aggregation keys may not be active
2250 within a given <ref table="Port"/> at the same time.
2254 <group title="Virtual Machine Identifiers">
2256 These key-value pairs specifically apply to an interface that
2257 represents a virtual Ethernet interface connected to a virtual
2258 machine. These key-value pairs should not be present for other types
2259 of interfaces. Keys whose names end in <code>-uuid</code> have
2260 values that uniquely identify the entity in question. For a Citrix
2261 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2262 Other hypervisors may use other formats.
2265 <column name="external_ids" key="attached-mac">
2266 The MAC address programmed into the ``virtual hardware'' for this
2267 interface, in the form
2268 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2269 For Citrix XenServer, this is the value of the <code>MAC</code> field
2270 in the VIF record for this interface.
2273 <column name="external_ids" key="iface-id">
2274 A system-unique identifier for the interface. On XenServer, this will
2275 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2278 <column name="external_ids" key="iface-status"
2279 type='{"type": "string",
2280 "enum": ["set", ["active", "inactive"]]}'>
2282 Hypervisors may sometimes have more than one interface associated
2283 with a given <ref column="external_ids" key="iface-id"/>, only one of
2284 which is actually in use at a given time. For example, in some
2285 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2286 for a single <ref column="external_ids" key="iface-id"/>, but only
2287 uses one of them at a time. A hypervisor that behaves this way must
2288 mark the currently in use interface <code>active</code> and the
2289 others <code>inactive</code>. A hypervisor that never has more than
2290 one interface for a given <ref column="external_ids" key="iface-id"/>
2291 may mark that interface <code>active</code> or omit <ref
2292 column="external_ids" key="iface-status"/> entirely.
2296 During VM migration, a given <ref column="external_ids"
2297 key="iface-id"/> might transiently be marked <code>active</code> on
2298 two different hypervisors. That is, <code>active</code> means that
2299 this <ref column="external_ids" key="iface-id"/> is the active
2300 instance within a single hypervisor, not in a broader scope.
2301 There is one exception: some hypervisors support ``migration'' from a
2302 given hypervisor to itself (most often for test purposes). During
2303 such a ``migration,'' two instances of a single <ref
2304 column="external_ids" key="iface-id"/> might both be briefly marked
2305 <code>active</code> on a single hypervisor.
2309 <column name="external_ids" key="xs-vif-uuid">
2310 The virtual interface associated with this interface.
2313 <column name="external_ids" key="xs-network-uuid">
2314 The virtual network to which this interface is attached.
2317 <column name="external_ids" key="vm-id">
2318 The VM to which this interface belongs. On XenServer, this will be the
2319 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2322 <column name="external_ids" key="xs-vm-uuid">
2323 The VM to which this interface belongs.
2327 <group title="VLAN Splinters">
2329 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2330 with buggy network drivers in old versions of Linux that do not
2331 properly support VLANs when VLAN devices are not used, at some cost
2332 in memory and performance.
2336 When VLAN splinters are enabled on a particular interface, Open vSwitch
2337 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2338 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2339 received on the VLAN device is treated as if it had been received on
2340 the interface on the particular VLAN.
2344 VLAN splinters consider a VLAN to be in use if:
2349 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2350 table="Port"/> record.
2354 The VLAN is listed within the <ref table="Port" column="trunks"/>
2355 column of the <ref table="Port"/> record of an interface on which
2356 VLAN splinters are enabled.
2358 An empty <ref table="Port" column="trunks"/> does not influence the
2359 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2360 will exceed the current 1,024 port per datapath limit.
2364 An OpenFlow flow within any bridge matches the VLAN.
2369 The same set of in-use VLANs applies to every interface on which VLAN
2370 splinters are enabled. That is, the set is not chosen separately for
2371 each interface but selected once as the union of all in-use VLANs based
2376 It does not make sense to enable VLAN splinters on an interface for an
2377 access port, or on an interface that is not a physical port.
2381 VLAN splinters are deprecated. When broken device drivers are no
2382 longer in widespread use, we will delete this feature.
2385 <column name="other_config" key="enable-vlan-splinters"
2386 type='{"type": "boolean"}'>
2388 Set to <code>true</code> to enable VLAN splinters on this interface.
2389 Defaults to <code>false</code>.
2393 VLAN splinters increase kernel and userspace memory overhead, so do
2394 not use them unless they are needed.
2398 VLAN splinters do not support 802.1p priority tags. Received
2399 priorities will appear to be 0, regardless of their actual values,
2400 and priorities on transmitted packets will also be cleared to 0.
2405 <group title="Common Columns">
2406 The overall purpose of these columns is described under <code>Common
2407 Columns</code> at the beginning of this document.
2409 <column name="other_config"/>
2410 <column name="external_ids"/>
2414 <table name="Flow_Table" title="OpenFlow table configuration">
2415 <p>Configuration for a particular OpenFlow table.</p>
2417 <column name="name">
2418 The table's name. Set this column to change the name that controllers
2419 will receive when they request table statistics, e.g. <code>ovs-ofctl
2420 dump-tables</code>. The name does not affect switch behavior.
2423 <column name="flow_limit">
2424 If set, limits the number of flows that may be added to the table. Open
2425 vSwitch may limit the number of flows in a table for other reasons,
2426 e.g. due to hardware limitations or for resource availability or
2427 performance reasons.
2430 <column name="overflow_policy">
2432 Controls the switch's behavior when an OpenFlow flow table modification
2433 request would add flows in excess of <ref column="flow_limit"/>. The
2434 supported values are:
2438 <dt><code>refuse</code></dt>
2440 Refuse to add the flow or flows. This is also the default policy
2441 when <ref column="overflow_policy"/> is unset.
2444 <dt><code>evict</code></dt>
2446 Delete the flow that will expire soonest. See <ref column="groups"/>
2452 <column name="groups">
2454 When <ref column="overflow_policy"/> is <code>evict</code>, this
2455 controls how flows are chosen for eviction when the flow table would
2456 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2457 of NXM fields or sub-fields, each of which takes one of the forms
2458 <code><var>field</var>[]</code> or
2459 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2460 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2461 <code>nicira-ext.h</code> for a complete list of NXM field names.
2465 When a flow must be evicted due to overflow, the flow to evict is
2466 chosen through an approximation of the following algorithm:
2471 Divide the flows in the table into groups based on the values of the
2472 specified fields or subfields, so that all of the flows in a given
2473 group have the same values for those fields. If a flow does not
2474 specify a given field, that field's value is treated as 0.
2478 Consider the flows in the largest group, that is, the group that
2479 contains the greatest number of flows. If two or more groups all
2480 have the same largest number of flows, consider the flows in all of
2485 Among the flows under consideration, choose the flow that expires
2486 soonest for eviction.
2491 The eviction process only considers flows that have an idle timeout or
2492 a hard timeout. That is, eviction never deletes permanent flows.
2493 (Permanent flows do count against <ref column="flow_limit"/>.)
2497 Open vSwitch ignores any invalid or unknown field specifications.
2501 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2502 column has no effect.
2507 <table name="QoS" title="Quality of Service configuration">
2508 <p>Quality of Service (QoS) configuration for each Port that
2511 <column name="type">
2512 <p>The type of QoS to implement. The currently defined types are
2515 <dt><code>linux-htb</code></dt>
2517 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2518 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2519 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2520 for information on how this classifier works and how to configure it.
2524 <dt><code>linux-hfsc</code></dt>
2526 Linux "Hierarchical Fair Service Curve" classifier.
2527 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2528 information on how this classifier works.
2533 <column name="queues">
2534 <p>A map from queue numbers to <ref table="Queue"/> records. The
2535 supported range of queue numbers depend on <ref column="type"/>. The
2536 queue numbers are the same as the <code>queue_id</code> used in
2537 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2541 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2542 actions when no specific queue has been set. When no configuration for
2543 queue 0 is present, it is automatically configured as if a <ref
2544 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2545 and <ref table="Queue" column="other_config"/> columns had been
2547 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2548 this case. With some queuing disciplines, this dropped all packets
2549 destined for the default queue.)
2553 <group title="Configuration for linux-htb and linux-hfsc">
2555 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2556 the following key-value pair:
2559 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2560 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2561 specified, for physical interfaces, the default is the link rate. For
2562 other interfaces or if the link rate cannot be determined, the default
2563 is currently 100 Mbps.
2567 <group title="Common Columns">
2568 The overall purpose of these columns is described under <code>Common
2569 Columns</code> at the beginning of this document.
2571 <column name="other_config"/>
2572 <column name="external_ids"/>
2576 <table name="Queue" title="QoS output queue.">
2577 <p>A configuration for a port output queue, used in configuring Quality of
2578 Service (QoS) features. May be referenced by <ref column="queues"
2579 table="QoS"/> column in <ref table="QoS"/> table.</p>
2581 <column name="dscp">
2582 If set, Open vSwitch will mark all traffic egressing this
2583 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2584 default <ref table="Queue"/> is only marked if it was explicitly selected
2585 as the <ref table="Queue"/> at the time the packet was output. If unset,
2586 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2590 <group title="Configuration for linux-htb QoS">
2592 <ref table="QoS"/> <ref table="QoS" column="type"/>
2593 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2594 It has the following key-value pairs defined.
2597 <column name="other_config" key="min-rate"
2598 type='{"type": "integer", "minInteger": 1}'>
2599 Minimum guaranteed bandwidth, in bit/s.
2602 <column name="other_config" key="max-rate"
2603 type='{"type": "integer", "minInteger": 1}'>
2604 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2605 queue's rate will not be allowed to exceed the specified value, even
2606 if excess bandwidth is available. If unspecified, defaults to no
2610 <column name="other_config" key="burst"
2611 type='{"type": "integer", "minInteger": 1}'>
2612 Burst size, in bits. This is the maximum amount of ``credits'' that a
2613 queue can accumulate while it is idle. Optional. Details of the
2614 <code>linux-htb</code> implementation require a minimum burst size, so
2615 a too-small <code>burst</code> will be silently ignored.
2618 <column name="other_config" key="priority"
2619 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2620 A queue with a smaller <code>priority</code> will receive all the
2621 excess bandwidth that it can use before a queue with a larger value
2622 receives any. Specific priority values are unimportant; only relative
2623 ordering matters. Defaults to 0 if unspecified.
2627 <group title="Configuration for linux-hfsc QoS">
2629 <ref table="QoS"/> <ref table="QoS" column="type"/>
2630 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2631 It has the following key-value pairs defined.
2634 <column name="other_config" key="min-rate"
2635 type='{"type": "integer", "minInteger": 1}'>
2636 Minimum guaranteed bandwidth, in bit/s.
2639 <column name="other_config" key="max-rate"
2640 type='{"type": "integer", "minInteger": 1}'>
2641 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2642 queue's rate will not be allowed to exceed the specified value, even if
2643 excess bandwidth is available. If unspecified, defaults to no
2648 <group title="Common Columns">
2649 The overall purpose of these columns is described under <code>Common
2650 Columns</code> at the beginning of this document.
2652 <column name="other_config"/>
2653 <column name="external_ids"/>
2657 <table name="Mirror" title="Port mirroring.">
2658 <p>A port mirror within a <ref table="Bridge"/>.</p>
2659 <p>A port mirror configures a bridge to send selected frames to special
2660 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2661 traffic may also be referred to as SPAN or RSPAN, depending on how
2662 the mirrored traffic is sent.</p>
2664 <column name="name">
2665 Arbitrary identifier for the <ref table="Mirror"/>.
2668 <group title="Selecting Packets for Mirroring">
2670 To be selected for mirroring, a given packet must enter or leave the
2671 bridge through a selected port and it must also be in one of the
2675 <column name="select_all">
2676 If true, every packet arriving or departing on any port is
2677 selected for mirroring.
2680 <column name="select_dst_port">
2681 Ports on which departing packets are selected for mirroring.
2684 <column name="select_src_port">
2685 Ports on which arriving packets are selected for mirroring.
2688 <column name="select_vlan">
2689 VLANs on which packets are selected for mirroring. An empty set
2690 selects packets on all VLANs.
2694 <group title="Mirroring Destination Configuration">
2696 These columns are mutually exclusive. Exactly one of them must be
2700 <column name="output_port">
2701 <p>Output port for selected packets, if nonempty.</p>
2702 <p>Specifying a port for mirror output reserves that port exclusively
2703 for mirroring. No frames other than those selected for mirroring
2705 will be forwarded to the port, and any frames received on the port
2706 will be discarded.</p>
2708 The output port may be any kind of port supported by Open vSwitch.
2709 It may be, for example, a physical port (sometimes called SPAN) or a
2714 <column name="output_vlan">
2715 <p>Output VLAN for selected packets, if nonempty.</p>
2716 <p>The frames will be sent out all ports that trunk
2717 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2718 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2719 trunk port, the frame's VLAN tag will be set to
2720 <ref column="output_vlan"/>, replacing any existing tag; when it is
2721 sent out an implicit VLAN port, the frame will not be tagged. This
2722 type of mirroring is sometimes called RSPAN.</p>
2724 See the documentation for
2725 <ref column="other_config" key="forward-bpdu"/> in the
2726 <ref table="Interface"/> table for a list of destination MAC
2727 addresses which will not be mirrored to a VLAN to avoid confusing
2728 switches that interpret the protocols that they represent.
2730 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2731 contains unmanaged switches. Consider an unmanaged physical switch
2732 with two ports: port 1, connected to an end host, and port 2,
2733 connected to an Open vSwitch configured to mirror received packets
2734 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2735 port 1 that the physical switch forwards to port 2. The Open vSwitch
2736 forwards this packet to its destination and then reflects it back on
2737 port 2 in VLAN 123. This reflected packet causes the unmanaged
2738 physical switch to replace the MAC learning table entry, which
2739 correctly pointed to port 1, with one that incorrectly points to port
2740 2. Afterward, the physical switch will direct packets destined for
2741 the end host to the Open vSwitch on port 2, instead of to the end
2742 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2743 desired in this scenario, then the physical switch must be replaced
2744 by one that learns Ethernet addresses on a per-VLAN basis. In
2745 addition, learning should be disabled on the VLAN containing mirrored
2746 traffic. If this is not done then intermediate switches will learn
2747 the MAC address of each end host from the mirrored traffic. If
2748 packets being sent to that end host are also mirrored, then they will
2749 be dropped since the switch will attempt to send them out the input
2750 port. Disabling learning for the VLAN will cause the switch to
2751 correctly send the packet out all ports configured for that VLAN. If
2752 Open vSwitch is being used as an intermediate switch, learning can be
2753 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2754 in the appropriate <ref table="Bridge"/> table or tables.</p>
2756 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2757 VLAN and should generally be preferred.
2762 <group title="Statistics: Mirror counters">
2764 Key-value pairs that report mirror statistics.
2766 <column name="statistics" key="tx_packets">
2767 Number of packets transmitted through this mirror.
2769 <column name="statistics" key="tx_bytes">
2770 Number of bytes transmitted through this mirror.
2774 <group title="Common Columns">
2775 The overall purpose of these columns is described under <code>Common
2776 Columns</code> at the beginning of this document.
2778 <column name="external_ids"/>
2782 <table name="Controller" title="OpenFlow controller configuration.">
2783 <p>An OpenFlow controller.</p>
2786 Open vSwitch supports two kinds of OpenFlow controllers:
2790 <dt>Primary controllers</dt>
2793 This is the kind of controller envisioned by the OpenFlow 1.0
2794 specification. Usually, a primary controller implements a network
2795 policy by taking charge of the switch's flow table.
2799 Open vSwitch initiates and maintains persistent connections to
2800 primary controllers, retrying the connection each time it fails or
2801 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2802 <ref table="Bridge"/> table applies to primary controllers.
2806 Open vSwitch permits a bridge to have any number of primary
2807 controllers. When multiple controllers are configured, Open
2808 vSwitch connects to all of them simultaneously. Because
2809 OpenFlow 1.0 does not specify how multiple controllers
2810 coordinate in interacting with a single switch, more than
2811 one primary controller should be specified only if the
2812 controllers are themselves designed to coordinate with each
2813 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2814 vendor extension may be useful for this.)
2817 <dt>Service controllers</dt>
2820 These kinds of OpenFlow controller connections are intended for
2821 occasional support and maintenance use, e.g. with
2822 <code>ovs-ofctl</code>. Usually a service controller connects only
2823 briefly to inspect or modify some of a switch's state.
2827 Open vSwitch listens for incoming connections from service
2828 controllers. The service controllers initiate and, if necessary,
2829 maintain the connections from their end. The <ref table="Bridge"
2830 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2831 not apply to service controllers.
2835 Open vSwitch supports configuring any number of service controllers.
2841 The <ref column="target"/> determines the type of controller.
2844 <group title="Core Features">
2845 <column name="target">
2846 <p>Connection method for controller.</p>
2848 The following connection methods are currently supported for primary
2852 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2854 <p>The specified SSL <var>port</var> on the host at the
2855 given <var>ip</var>, which must be expressed as an IP
2856 address (not a DNS name). The <ref table="Open_vSwitch"
2857 column="ssl"/> column in the <ref table="Open_vSwitch"/>
2858 table must point to a valid SSL configuration when this form
2860 <p>If <var>port</var> is not specified, it currently
2861 defaults to 6633. In the future, the default will change to
2862 6653, which is the IANA-defined value.</p>
2863 <p>SSL support is an optional feature that is not always built as
2864 part of Open vSwitch.</p>
2866 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2868 <p>The specified TCP <var>port</var> on the host at the
2869 given <var>ip</var>, which must be expressed as an IP
2870 address (not a DNS name).</p>
2871 <p>If <var>port</var> is not specified, it currently
2872 defaults to 6633. In the future, the default will change to
2873 6653, which is the IANA-defined value.</p>
2877 The following connection methods are currently supported for service
2881 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2883 <p> Listens for SSL connections on the specified TCP
2884 <var>port</var>. If <var>ip</var>, which must be expressed
2885 as an IP address (not a DNS name), is specified, then
2886 connections are restricted to the specified local IP
2887 address. The <ref table="Open_vSwitch" column="ssl"/>
2888 column in the <ref table="Open_vSwitch"/> table must point
2889 to a valid SSL configuration when this form is used.</p>
2890 <p>If <var>port</var> is not specified, it currently
2891 defaults to 6633. In the future, the default will change to
2892 6653, which is the IANA-defined value.</p>
2893 <p>SSL support is an optional feature that is not always built as
2894 part of Open vSwitch.</p>
2896 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2898 <p>Listens for connections on the specified TCP
2899 <var>port</var>. If <var>ip</var>, which must be expressed
2900 as an IP address (not a DNS name), is specified, then
2901 connections are restricted to the specified local IP
2903 <p>If <var>port</var> is not specified, it currently
2904 defaults to 6633. In the future, the default will change to
2905 6653, which is the IANA-defined value.</p>
2908 <p>When multiple controllers are configured for a single bridge, the
2909 <ref column="target"/> values must be unique. Duplicate
2910 <ref column="target"/> values yield unspecified results.</p>
2913 <column name="connection_mode">
2914 <p>If it is specified, this setting must be one of the following
2915 strings that describes how Open vSwitch contacts this OpenFlow
2916 controller over the network:</p>
2919 <dt><code>in-band</code></dt>
2920 <dd>In this mode, this controller's OpenFlow traffic travels over the
2921 bridge associated with the controller. With this setting, Open
2922 vSwitch allows traffic to and from the controller regardless of the
2923 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2924 would never be able to connect to the controller, because it did
2925 not have a flow to enable it.) This is the most common connection
2926 mode because it is not necessary to maintain two independent
2928 <dt><code>out-of-band</code></dt>
2929 <dd>In this mode, OpenFlow traffic uses a control network separate
2930 from the bridge associated with this controller, that is, the
2931 bridge does not use any of its own network devices to communicate
2932 with the controller. The control network must be configured
2933 separately, before or after <code>ovs-vswitchd</code> is started.
2937 <p>If not specified, the default is implementation-specific.</p>
2941 <group title="Controller Failure Detection and Handling">
2942 <column name="max_backoff">
2943 Maximum number of milliseconds to wait between connection attempts.
2944 Default is implementation-specific.
2947 <column name="inactivity_probe">
2948 Maximum number of milliseconds of idle time on connection to
2949 controller before sending an inactivity probe message. If Open
2950 vSwitch does not communicate with the controller for the specified
2951 number of seconds, it will send a probe. If a response is not
2952 received for the same additional amount of time, Open vSwitch
2953 assumes the connection has been broken and attempts to reconnect.
2954 Default is implementation-specific. A value of 0 disables
2959 <group title="Asynchronous Message Configuration">
2961 OpenFlow switches send certain messages to controllers spontanenously,
2962 that is, not in response to any request from the controller. These
2963 messages are called ``asynchronous messages.'' These columns allow
2964 asynchronous messages to be limited or disabled to ensure the best use
2965 of network resources.
2968 <column name="enable_async_messages">
2969 The OpenFlow protocol enables asynchronous messages at time of
2970 connection establishment, which means that a controller can receive
2971 asynchronous messages, potentially many of them, even if it turns them
2972 off immediately after connecting. Set this column to
2973 <code>false</code> to change Open vSwitch behavior to disable, by
2974 default, all asynchronous messages. The controller can use the
2975 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2976 on any messages that it does want to receive, if any.
2979 <column name="controller_rate_limit">
2981 The maximum rate at which the switch will forward packets to the
2982 OpenFlow controller, in packets per second. This feature prevents a
2983 single bridge from overwhelming the controller. If not specified,
2984 the default is implementation-specific.
2988 In addition, when a high rate triggers rate-limiting, Open vSwitch
2989 queues controller packets for each port and transmits them to the
2990 controller at the configured rate. The <ref
2991 column="controller_burst_limit"/> value limits the number of queued
2992 packets. Ports on a bridge share the packet queue fairly.
2996 Open vSwitch maintains two such packet rate-limiters per bridge: one
2997 for packets sent up to the controller because they do not correspond
2998 to any flow, and the other for packets sent up to the controller by
2999 request through flow actions. When both rate-limiters are filled with
3000 packets, the actual rate that packets are sent to the controller is
3001 up to twice the specified rate.
3005 <column name="controller_burst_limit">
3006 In conjunction with <ref column="controller_rate_limit"/>,
3007 the maximum number of unused packet credits that the bridge will
3008 allow to accumulate, in packets. If not specified, the default
3009 is implementation-specific.
3013 <group title="Additional In-Band Configuration">
3014 <p>These values are considered only in in-band control mode (see
3015 <ref column="connection_mode"/>).</p>
3017 <p>When multiple controllers are configured on a single bridge, there
3018 should be only one set of unique values in these columns. If different
3019 values are set for these columns in different controllers, the effect
3022 <column name="local_ip">
3023 The IP address to configure on the local port,
3024 e.g. <code>192.168.0.123</code>. If this value is unset, then
3025 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3029 <column name="local_netmask">
3030 The IP netmask to configure on the local port,
3031 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3032 but this value is unset, then the default is chosen based on whether
3033 the IP address is class A, B, or C.
3036 <column name="local_gateway">
3037 The IP address of the gateway to configure on the local port, as a
3038 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3039 this network has no gateway.
3043 <group title="Controller Status">
3044 <column name="is_connected">
3045 <code>true</code> if currently connected to this controller,
3046 <code>false</code> otherwise.
3050 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3051 <p>The level of authority this controller has on the associated
3052 bridge. Possible values are:</p>
3054 <dt><code>other</code></dt>
3055 <dd>Allows the controller access to all OpenFlow features.</dd>
3056 <dt><code>master</code></dt>
3057 <dd>Equivalent to <code>other</code>, except that there may be at
3058 most one master controller at a time. When a controller configures
3059 itself as <code>master</code>, any existing master is demoted to
3060 the <code>slave</code>role.</dd>
3061 <dt><code>slave</code></dt>
3062 <dd>Allows the controller read-only access to OpenFlow features.
3063 Attempts to modify the flow table will be rejected with an
3064 error. Slave controllers do not receive OFPT_PACKET_IN or
3065 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3070 <column name="status" key="last_error">
3071 A human-readable description of the last error on the connection
3072 to the controller; i.e. <code>strerror(errno)</code>. This key
3073 will exist only if an error has occurred.
3076 <column name="status" key="state"
3077 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3079 The state of the connection to the controller:
3082 <dt><code>VOID</code></dt>
3083 <dd>Connection is disabled.</dd>
3085 <dt><code>BACKOFF</code></dt>
3086 <dd>Attempting to reconnect at an increasing period.</dd>
3088 <dt><code>CONNECTING</code></dt>
3089 <dd>Attempting to connect.</dd>
3091 <dt><code>ACTIVE</code></dt>
3092 <dd>Connected, remote host responsive.</dd>
3094 <dt><code>IDLE</code></dt>
3095 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3098 These values may change in the future. They are provided only for
3103 <column name="status" key="sec_since_connect"
3104 type='{"type": "integer", "minInteger": 0}'>
3105 The amount of time since this controller last successfully connected to
3106 the switch (in seconds). Value is empty if controller has never
3107 successfully connected.
3110 <column name="status" key="sec_since_disconnect"
3111 type='{"type": "integer", "minInteger": 1}'>
3112 The amount of time since this controller last disconnected from
3113 the switch (in seconds). Value is empty if controller has never
3118 <group title="Connection Parameters">
3120 Additional configuration for a connection between the controller
3121 and the Open vSwitch.
3124 <column name="other_config" key="dscp"
3125 type='{"type": "integer"}'>
3126 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3127 in the Type of Service (TOS) field in the IP header. DSCP provides a
3128 mechanism to classify the network traffic and provide Quality of
3129 Service (QoS) on IP networks.
3131 The DSCP value specified here is used when establishing the connection
3132 between the controller and the Open vSwitch. If no value is specified,
3133 a default value of 48 is chosen. Valid DSCP values must be in the
3139 <group title="Common Columns">
3140 The overall purpose of these columns is described under <code>Common
3141 Columns</code> at the beginning of this document.
3143 <column name="external_ids"/>
3144 <column name="other_config"/>
3148 <table name="Manager" title="OVSDB management connection.">
3150 Configuration for a database connection to an Open vSwitch database
3155 This table primarily configures the Open vSwitch database
3156 (<code>ovsdb-server</code>), not the Open vSwitch switch
3157 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3158 what connections should be treated as in-band.
3162 The Open vSwitch database server can initiate and maintain active
3163 connections to remote clients. It can also listen for database
3167 <group title="Core Features">
3168 <column name="target">
3169 <p>Connection method for managers.</p>
3171 The following connection methods are currently supported:
3174 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3177 The specified SSL <var>port</var> on the host at the given
3178 <var>ip</var>, which must be expressed as an IP address
3179 (not a DNS name). The <ref table="Open_vSwitch"
3180 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3181 table must point to a valid SSL configuration when this
3185 If <var>port</var> is not specified, it currently defaults
3186 to 6632. In the future, the default will change to 6640,
3187 which is the IANA-defined value.
3190 SSL support is an optional feature that is not always
3191 built as part of Open vSwitch.
3195 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3198 The specified TCP <var>port</var> on the host at the given
3199 <var>ip</var>, which must be expressed as an IP address
3203 If <var>port</var> is not specified, it currently defaults
3204 to 6632. In the future, the default will change to 6640,
3205 which is the IANA-defined value.
3208 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3211 Listens for SSL connections on the specified TCP
3212 <var>port</var>. Specify 0 for <var>port</var> to have
3213 the kernel automatically choose an available port. If
3214 <var>ip</var>, which must be expressed as an IP address
3215 (not a DNS name), is specified, then connections are
3216 restricted to the specified local IP address. The <ref
3217 table="Open_vSwitch" column="ssl"/> column in the <ref
3218 table="Open_vSwitch"/> table must point to a valid SSL
3219 configuration when this form is used.
3222 If <var>port</var> is not specified, it currently defaults
3223 to 6632. In the future, the default will change to 6640,
3224 which is the IANA-defined value.
3227 SSL support is an optional feature that is not always built as
3228 part of Open vSwitch.
3231 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3234 Listens for connections on the specified TCP
3235 <var>port</var>. Specify 0 for <var>port</var> to have
3236 the kernel automatically choose an available port. If
3237 <var>ip</var>, which must be expressed as an IP address
3238 (not a DNS name), is specified, then connections are
3239 restricted to the specified local IP address.
3242 If <var>port</var> is not specified, it currently defaults
3243 to 6632. In the future, the default will change to 6640,
3244 which is the IANA-defined value.
3248 <p>When multiple managers are configured, the <ref column="target"/>
3249 values must be unique. Duplicate <ref column="target"/> values yield
3250 unspecified results.</p>
3253 <column name="connection_mode">
3255 If it is specified, this setting must be one of the following strings
3256 that describes how Open vSwitch contacts this OVSDB client over the
3261 <dt><code>in-band</code></dt>
3263 In this mode, this connection's traffic travels over a bridge
3264 managed by Open vSwitch. With this setting, Open vSwitch allows
3265 traffic to and from the client regardless of the contents of the
3266 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3267 to connect to the client, because it did not have a flow to enable
3268 it.) This is the most common connection mode because it is not
3269 necessary to maintain two independent networks.
3271 <dt><code>out-of-band</code></dt>
3273 In this mode, the client's traffic uses a control network separate
3274 from that managed by Open vSwitch, that is, Open vSwitch does not
3275 use any of its own network devices to communicate with the client.
3276 The control network must be configured separately, before or after
3277 <code>ovs-vswitchd</code> is started.
3282 If not specified, the default is implementation-specific.
3287 <group title="Client Failure Detection and Handling">
3288 <column name="max_backoff">
3289 Maximum number of milliseconds to wait between connection attempts.
3290 Default is implementation-specific.
3293 <column name="inactivity_probe">
3294 Maximum number of milliseconds of idle time on connection to the client
3295 before sending an inactivity probe message. If Open vSwitch does not
3296 communicate with the client for the specified number of seconds, it
3297 will send a probe. If a response is not received for the same
3298 additional amount of time, Open vSwitch assumes the connection has been
3299 broken and attempts to reconnect. Default is implementation-specific.
3300 A value of 0 disables inactivity probes.
3304 <group title="Status">
3305 <column name="is_connected">
3306 <code>true</code> if currently connected to this manager,
3307 <code>false</code> otherwise.
3310 <column name="status" key="last_error">
3311 A human-readable description of the last error on the connection
3312 to the manager; i.e. <code>strerror(errno)</code>. This key
3313 will exist only if an error has occurred.
3316 <column name="status" key="state"
3317 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3319 The state of the connection to the manager:
3322 <dt><code>VOID</code></dt>
3323 <dd>Connection is disabled.</dd>
3325 <dt><code>BACKOFF</code></dt>
3326 <dd>Attempting to reconnect at an increasing period.</dd>
3328 <dt><code>CONNECTING</code></dt>
3329 <dd>Attempting to connect.</dd>
3331 <dt><code>ACTIVE</code></dt>
3332 <dd>Connected, remote host responsive.</dd>
3334 <dt><code>IDLE</code></dt>
3335 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3338 These values may change in the future. They are provided only for
3343 <column name="status" key="sec_since_connect"
3344 type='{"type": "integer", "minInteger": 0}'>
3345 The amount of time since this manager last successfully connected
3346 to the database (in seconds). Value is empty if manager has never
3347 successfully connected.
3350 <column name="status" key="sec_since_disconnect"
3351 type='{"type": "integer", "minInteger": 0}'>
3352 The amount of time since this manager last disconnected from the
3353 database (in seconds). Value is empty if manager has never
3357 <column name="status" key="locks_held">
3358 Space-separated list of the names of OVSDB locks that the connection
3359 holds. Omitted if the connection does not hold any locks.
3362 <column name="status" key="locks_waiting">
3363 Space-separated list of the names of OVSDB locks that the connection is
3364 currently waiting to acquire. Omitted if the connection is not waiting
3368 <column name="status" key="locks_lost">
3369 Space-separated list of the names of OVSDB locks that the connection
3370 has had stolen by another OVSDB client. Omitted if no locks have been
3371 stolen from this connection.
3374 <column name="status" key="n_connections"
3375 type='{"type": "integer", "minInteger": 2}'>
3377 When <ref column="target"/> specifies a connection method that
3378 listens for inbound connections (e.g. <code>ptcp:</code> or
3379 <code>pssl:</code>) and more than one connection is actually active,
3380 the value is the number of active connections. Otherwise, this
3381 key-value pair is omitted.
3384 When multiple connections are active, status columns and key-value
3385 pairs (other than this one) report the status of one arbitrarily
3390 <column name="status" key="bound_port" type='{"type": "integer"}'>
3391 When <ref column="target"/> is <code>ptcp:</code> or
3392 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3393 listening. (This is is particularly useful when <ref
3394 column="target"/> specifies a port of 0, allowing the kernel to
3395 choose any available port.)
3399 <group title="Connection Parameters">
3401 Additional configuration for a connection between the manager
3402 and the Open vSwitch Database.
3405 <column name="other_config" key="dscp"
3406 type='{"type": "integer"}'>
3407 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3408 in the Type of Service (TOS) field in the IP header. DSCP provides a
3409 mechanism to classify the network traffic and provide Quality of
3410 Service (QoS) on IP networks.
3412 The DSCP value specified here is used when establishing the connection
3413 between the manager and the Open vSwitch. If no value is specified, a
3414 default value of 48 is chosen. Valid DSCP values must be in the range
3419 <group title="Common Columns">
3420 The overall purpose of these columns is described under <code>Common
3421 Columns</code> at the beginning of this document.
3423 <column name="external_ids"/>
3424 <column name="other_config"/>
3428 <table name="NetFlow">
3429 A NetFlow target. NetFlow is a protocol that exports a number of
3430 details about terminating IP flows, such as the principals involved
3433 <column name="targets">
3434 NetFlow targets in the form
3435 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3436 must be specified numerically, not as a DNS name.
3439 <column name="engine_id">
3440 Engine ID to use in NetFlow messages. Defaults to datapath index
3444 <column name="engine_type">
3445 Engine type to use in NetFlow messages. Defaults to datapath
3446 index if not specified.
3449 <column name="active_timeout">
3450 The interval at which NetFlow records are sent for flows that are
3451 still active, in seconds. A value of <code>0</code> requests the
3452 default timeout (currently 600 seconds); a value of <code>-1</code>
3453 disables active timeouts.
3456 <column name="add_id_to_interface">
3457 <p>If this column's value is <code>false</code>, the ingress and egress
3458 interface fields of NetFlow flow records are derived from OpenFlow port
3459 numbers. When it is <code>true</code>, the 7 most significant bits of
3460 these fields will be replaced by the least significant 7 bits of the
3461 engine id. This is useful because many NetFlow collectors do not
3462 expect multiple switches to be sending messages from the same host, so
3463 they do not store the engine information which could be used to
3464 disambiguate the traffic.</p>
3465 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3468 <group title="Common Columns">
3469 The overall purpose of these columns is described under <code>Common
3470 Columns</code> at the beginning of this document.
3472 <column name="external_ids"/>
3477 SSL configuration for an Open_vSwitch.
3479 <column name="private_key">
3480 Name of a PEM file containing the private key used as the switch's
3481 identity for SSL connections to the controller.
3484 <column name="certificate">
3485 Name of a PEM file containing a certificate, signed by the
3486 certificate authority (CA) used by the controller and manager,
3487 that certifies the switch's private key, identifying a trustworthy
3491 <column name="ca_cert">
3492 Name of a PEM file containing the CA certificate used to verify
3493 that the switch is connected to a trustworthy controller.
3496 <column name="bootstrap_ca_cert">
3497 If set to <code>true</code>, then Open vSwitch will attempt to
3498 obtain the CA certificate from the controller on its first SSL
3499 connection and save it to the named PEM file. If it is successful,
3500 it will immediately drop the connection and reconnect, and from then
3501 on all SSL connections must be authenticated by a certificate signed
3502 by the CA certificate thus obtained. <em>This option exposes the
3503 SSL connection to a man-in-the-middle attack obtaining the initial
3504 CA certificate.</em> It may still be useful for bootstrapping.
3507 <group title="Common Columns">
3508 The overall purpose of these columns is described under <code>Common
3509 Columns</code> at the beginning of this document.
3511 <column name="external_ids"/>
3515 <table name="sFlow">
3516 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
3517 monitoring of switches.</p>
3519 <column name="agent">
3520 Name of the network device whose IP address should be reported as the
3521 ``agent address'' to collectors. If not specified, the agent device is
3522 figured from the first target address and the routing table. If the
3523 routing table does not contain a route to the target, the IP address
3524 defaults to the <ref table="Controller" column="local_ip"/> in the
3525 collector's <ref table="Controller"/>. If an agent IP address cannot be
3526 determined any of these ways, sFlow is disabled.
3529 <column name="header">
3530 Number of bytes of a sampled packet to send to the collector.
3531 If not specified, the default is 128 bytes.
3534 <column name="polling">
3535 Polling rate in seconds to send port statistics to the collector.
3536 If not specified, defaults to 30 seconds.
3539 <column name="sampling">
3540 Rate at which packets should be sampled and sent to the collector.
3541 If not specified, defaults to 400, which means one out of 400
3542 packets, on average, will be sent to the collector.
3545 <column name="targets">
3546 sFlow targets in the form
3547 <code><var>ip</var>:<var>port</var></code>.
3550 <group title="Common Columns">
3551 The overall purpose of these columns is described under <code>Common
3552 Columns</code> at the beginning of this document.
3554 <column name="external_ids"/>
3558 <table name="IPFIX">
3559 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3560 number of details about flows.</p>
3562 <column name="targets">
3563 IPFIX target collectors in the form
3564 <code><var>ip</var>:<var>port</var></code>.
3567 <column name="sampling">
3568 For per-bridge packet sampling, i.e. when this row is referenced
3569 from a <ref table="Bridge"/>, the rate at which packets should
3570 be sampled and sent to each target collector. If not specified,
3571 defaults to 400, which means one out of 400 packets, on average,
3572 will be sent to each target collector. Ignored for per-flow
3573 sampling, i.e. when this row is referenced from a <ref
3574 table="Flow_Sample_Collector_Set"/>.
3577 <column name="obs_domain_id">
3578 For per-bridge packet sampling, i.e. when this row is referenced
3579 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3580 sent in each IPFIX packet. If not specified, defaults to 0.
3581 Ignored for per-flow sampling, i.e. when this row is referenced
3582 from a <ref table="Flow_Sample_Collector_Set"/>.
3585 <column name="obs_point_id">
3586 For per-bridge packet sampling, i.e. when this row is referenced
3587 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3588 sent in each IPFIX flow record. If not specified, defaults to
3589 0. Ignored for per-flow sampling, i.e. when this row is
3590 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3593 <column name="cache_active_timeout">
3594 The maximum period in seconds for which an IPFIX flow record is
3595 cached and aggregated before being sent. If not specified,
3596 defaults to 0. If 0, caching is disabled.
3599 <column name="cache_max_flows">
3600 The maximum number of IPFIX flow records that can be cached at a
3601 time. If not specified, defaults to 0. If 0, caching is
3605 <group title="Common Columns">
3606 The overall purpose of these columns is described under <code>Common
3607 Columns</code> at the beginning of this document.
3609 <column name="external_ids"/>
3613 <table name="Flow_Sample_Collector_Set">
3614 <p>A set of IPFIX collectors of packet samples generated by
3615 OpenFlow <code>sample</code> actions.</p>
3618 The ID of this collector set, unique among the bridge's
3619 collector sets, to be used as the <code>collector_set_id</code>
3620 in OpenFlow <code>sample</code> actions.
3623 <column name="bridge">
3624 The bridge into which OpenFlow <code>sample</code> actions can
3625 be added to send packet samples to this set of IPFIX collectors.
3628 <column name="ipfix">
3629 Configuration of the set of IPFIX collectors to send one flow
3630 record per sampled packet to.
3633 <group title="Common Columns">
3634 The overall purpose of these columns is described under <code>Common
3635 Columns</code> at the beginning of this document.
3637 <column name="external_ids"/>