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="stats-update-interval"
76 type='{"type": "integer", "minInteger": 5000}'>
78 Interval for updating statistics to the database, in milliseconds.
79 This option will affect the update of the <code>statistics</code>
80 column in the following tables: <code>Port</code>, <code>Interface
81 </code>, <code>Mirror</code>.
84 Default value is 5000 ms.
87 Getting statistics more frequently can be achieved via OpenFlow.
91 <column name="other_config" key="flow-restore-wait"
92 type='{"type": "boolean"}'>
94 When <code>ovs-vswitchd</code> starts up, it has an empty flow table
95 and therefore it handles all arriving packets in its default fashion
96 according to its configuration, by dropping them or sending them to
97 an OpenFlow controller or switching them as a standalone switch.
98 This behavior is ordinarily desirable. However, if
99 <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
100 then this leads to a relatively long period during which packets are
104 This option allows for improvement. When <code>ovs-vswitchd</code>
105 starts with this value set as <code>true</code>, it will neither
106 flush or expire previously set datapath flows nor will it send and
107 receive any packets to or from the datapath. When this value is
108 later set to <code>false</code>, <code>ovs-vswitchd</code> will
109 start receiving packets from the datapath and re-setup the flows.
112 Thus, with this option, the procedure for a hot-upgrade of
113 <code>ovs-vswitchd</code> becomes roughly the following:
117 Stop <code>ovs-vswitchd</code>.
120 Set <ref column="other_config" key="flow-restore-wait"/>
121 to <code>true</code>.
124 Start <code>ovs-vswitchd</code>.
127 Use <code>ovs-ofctl</code> (or some other program, such as an
128 OpenFlow controller) to restore the OpenFlow flow table
129 to the desired state.
132 Set <ref column="other_config" key="flow-restore-wait"/>
133 to <code>false</code> (or remove it entirely from the database).
137 The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
138 functions use the above config option during hot upgrades.
142 <column name="other_config" key="flow-limit"
143 type='{"type": "integer", "minInteger": 0}'>
146 number of flows allowed in the datapath flow table. Internally OVS
147 will choose a flow limit which will likely be lower than this number,
148 based on real time network conditions.
151 The default is 200000.
155 <column name="other_config" key="n-handler-threads"
156 type='{"type": "integer", "minInteger": 1}'>
158 Specifies the number of threads for software datapaths to use for
159 handling new flows. The default the number of online CPU cores minus
160 the number of revalidators.
163 This configuration is per datapath. If you have more than one
164 software datapath (e.g. some <code>system</code> bridges and some
165 <code>netdev</code> bridges), then the total number of threads is
166 <code>n-handler-threads</code> times the number of software
171 <column name="other_config" key="n-revalidator-threads"
172 type='{"type": "integer", "minInteger": 1}'>
174 Specifies the number of threads for software datapaths to use for
175 revalidating flows in the datapath. Typically, there is a direct
176 correlation between the number of revalidator threads, and the number
177 of flows allowed in the datapath. The default is the number of cpu
178 cores divided by four plus one. If <code>n-handler-threads</code> is
179 set, the default changes to the number of cpu cores minus the number
183 This configuration is per datapath. If you have more than one
184 software datapath (e.g. some <code>system</code> bridges and some
185 <code>netdev</code> bridges), then the total number of threads is
186 <code>n-handler-threads</code> times the number of software
192 <group title="Status">
193 <column name="next_cfg">
194 Sequence number for client to increment. When a client modifies
195 any part of the database configuration and wishes to wait for
196 Open vSwitch to finish applying the changes, it may increment
197 this sequence number.
200 <column name="cur_cfg">
201 Sequence number that Open vSwitch sets to the current value of
202 <ref column="next_cfg"/> after it finishes applying a set of
203 configuration changes.
206 <group title="Statistics">
208 The <code>statistics</code> column contains key-value pairs that
209 report statistics about a system running an Open vSwitch. These are
210 updated periodically (currently, every 5 seconds). Key-value pairs
211 that cannot be determined or that do not apply to a platform are
215 <column name="other_config" key="enable-statistics"
216 type='{"type": "boolean"}'>
217 Statistics are disabled by default to avoid overhead in the common
218 case when statistics gathering is not useful. Set this value to
219 <code>true</code> to enable populating the <ref column="statistics"/>
220 column or to <code>false</code> to explicitly disable it.
223 <column name="statistics" key="cpu"
224 type='{"type": "integer", "minInteger": 1}'>
226 Number of CPU processors, threads, or cores currently online and
227 available to the operating system on which Open vSwitch is running,
228 as an integer. This may be less than the number installed, if some
229 are not online or if they are not available to the operating
233 Open vSwitch userspace processes are not multithreaded, but the
234 Linux kernel-based datapath is.
238 <column name="statistics" key="load_average">
239 A comma-separated list of three floating-point numbers,
240 representing the system load average over the last 1, 5, and 15
241 minutes, respectively.
244 <column name="statistics" key="memory">
246 A comma-separated list of integers, each of which represents a
247 quantity of memory in kilobytes that describes the operating
248 system on which Open vSwitch is running. In respective order,
253 <li>Total amount of RAM allocated to the OS.</li>
254 <li>RAM allocated to the OS that is in use.</li>
255 <li>RAM that can be flushed out to disk or otherwise discarded
256 if that space is needed for another purpose. This number is
257 necessarily less than or equal to the previous value.</li>
258 <li>Total disk space allocated for swap.</li>
259 <li>Swap space currently in use.</li>
263 On Linux, all five values can be determined and are included. On
264 other operating systems, only the first two values can be
265 determined, so the list will only have two values.
269 <column name="statistics" key="process_NAME">
271 One such key-value pair, with <code>NAME</code> replaced by
272 a process name, will exist for each running Open vSwitch
273 daemon process, with <var>name</var> replaced by the
274 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
275 value is a comma-separated list of integers. The integers
276 represent the following, with memory measured in kilobytes
277 and durations in milliseconds:
281 <li>The process's virtual memory size.</li>
282 <li>The process's resident set size.</li>
283 <li>The amount of user and system CPU time consumed by the
285 <li>The number of times that the process has crashed and been
286 automatically restarted by the monitor.</li>
287 <li>The duration since the process was started.</li>
288 <li>The duration for which the process has been running.</li>
292 The interpretation of some of these values depends on whether the
293 process was started with the <option>--monitor</option>. If it
294 was not, then the crash count will always be 0 and the two
295 durations will always be the same. If <option>--monitor</option>
296 was given, then the crash count may be positive; if it is, the
297 latter duration is the amount of time since the most recent crash
302 There will be one key-value pair for each file in Open vSwitch's
303 ``run directory'' (usually <code>/var/run/openvswitch</code>)
304 whose name ends in <code>.pid</code>, whose contents are a
305 process ID, and which is locked by a running process. The
306 <var>name</var> is taken from the pidfile's name.
310 Currently Open vSwitch is only able to obtain all of the above
311 detail on Linux systems. On other systems, the same key-value
312 pairs will be present but the values will always be the empty
317 <column name="statistics" key="file_systems">
319 A space-separated list of information on local, writable file
320 systems. Each item in the list describes one file system and
321 consists in turn of a comma-separated list of the following:
325 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
326 Any spaces or commas in the mount point are replaced by
328 <li>Total size, in kilobytes, as an integer.</li>
329 <li>Amount of storage in use, in kilobytes, as an integer.</li>
333 This key-value pair is omitted if there are no local, writable
334 file systems or if Open vSwitch cannot obtain the needed
341 <group title="Version Reporting">
343 These columns report the types and versions of the hardware and
344 software running Open vSwitch. We recommend in general that software
345 should test whether specific features are supported instead of relying
346 on version number checks. These values are primarily intended for
347 reporting to human administrators.
350 <column name="ovs_version">
351 The Open vSwitch version number, e.g. <code>1.1.0</code>.
354 <column name="db_version">
356 The database schema version number in the form
357 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
358 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
359 a non-backward compatible way (e.g. deleting a column or a table),
360 <var>major</var> is incremented. When the database schema is changed
361 in a backward compatible way (e.g. adding a new column),
362 <var>minor</var> is incremented. When the database schema is changed
363 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
368 The schema version is part of the database schema, so it can also be
369 retrieved by fetching the schema using the Open vSwitch database
374 <column name="system_type">
376 An identifier for the type of system on top of which Open vSwitch
377 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
380 System integrators are responsible for choosing and setting an
381 appropriate value for this column.
385 <column name="system_version">
387 The version of the system identified by <ref column="system_type"/>,
388 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
391 System integrators are responsible for choosing and setting an
392 appropriate value for this column.
398 <group title="Database Configuration">
400 These columns primarily configure the Open vSwitch database
401 (<code>ovsdb-server</code>), not the Open vSwitch switch
402 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
403 column="ssl"/> settings.
407 The Open vSwitch switch does read the database configuration to
408 determine remote IP addresses to which in-band control should apply.
411 <column name="manager_options">
412 Database clients to which the Open vSwitch database server should
413 connect or to which it should listen, along with options for how these
414 connection should be configured. See the <ref table="Manager"/> table
415 for more information.
419 <group title="Common Columns">
420 The overall purpose of these columns is described under <code>Common
421 Columns</code> at the beginning of this document.
423 <column name="other_config"/>
424 <column name="external_ids"/>
428 <table name="Bridge">
430 Configuration for a bridge within an
431 <ref table="Open_vSwitch"/>.
434 A <ref table="Bridge"/> record represents an Ethernet switch with one or
435 more ``ports,'' which are the <ref table="Port"/> records pointed to by
436 the <ref table="Bridge"/>'s <ref column="ports"/> column.
439 <group title="Core Features">
441 Bridge identifier. Should be alphanumeric and no more than about 8
442 bytes long. Must be unique among the names of ports, interfaces, and
446 <column name="ports">
447 Ports included in the bridge.
450 <column name="mirrors">
451 Port mirroring configuration.
454 <column name="netflow">
455 NetFlow configuration.
458 <column name="sflow">
459 sFlow(R) configuration.
462 <column name="ipfix">
466 <column name="flood_vlans">
468 VLAN IDs of VLANs on which MAC address learning should be disabled,
469 so that packets are flooded instead of being sent to specific ports
470 that are believed to contain packets' destination MACs. This should
471 ordinarily be used to disable MAC learning on VLANs used for
472 mirroring (RSPAN VLANs). It may also be useful for debugging.
475 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
476 the <ref table="Port"/> table) is incompatible with
477 <code>flood_vlans</code>. Consider using another bonding mode or
478 a different type of mirror instead.
483 <group title="OpenFlow Configuration">
484 <column name="controller">
486 OpenFlow controller set. If unset, then no OpenFlow controllers
491 If there are primary controllers, removing all of them clears the
492 flow table. If there are no primary controllers, adding one also
493 clears the flow table. Other changes to the set of controllers, such
494 as adding or removing a service controller, adding another primary
495 controller to supplement an existing primary controller, or removing
496 only one of two primary controllers, have no effect on the flow
501 <column name="flow_tables">
502 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
503 table ID to configuration for that table.
506 <column name="fail_mode">
507 <p>When a controller is configured, it is, ordinarily, responsible
508 for setting up all flows on the switch. Thus, if the connection to
509 the controller fails, no new network connections can be set up.
510 If the connection to the controller stays down long enough,
511 no packets can pass through the switch at all. This setting
512 determines the switch's response to such a situation. It may be set
513 to one of the following:
515 <dt><code>standalone</code></dt>
516 <dd>If no message is received from the controller for three
517 times the inactivity probe interval
518 (see <ref column="inactivity_probe"/>), then Open vSwitch
519 will take over responsibility for setting up flows. In
520 this mode, Open vSwitch causes the bridge to act like an
521 ordinary MAC-learning switch. Open vSwitch will continue
522 to retry connecting to the controller in the background
523 and, when the connection succeeds, it will discontinue its
524 standalone behavior.</dd>
525 <dt><code>secure</code></dt>
526 <dd>Open vSwitch will not set up flows on its own when the
527 controller connection fails or when no controllers are
528 defined. The bridge will continue to retry connecting to
529 any defined controllers forever.</dd>
533 The default is <code>standalone</code> if the value is unset, but
534 future versions of Open vSwitch may change the default.
537 The <code>standalone</code> mode can create forwarding loops on a
538 bridge that has more than one uplink port unless STP is enabled. To
539 avoid loops on such a bridge, configure <code>secure</code> mode or
540 enable STP (see <ref column="stp_enable"/>).
542 <p>When more than one controller is configured,
543 <ref column="fail_mode"/> is considered only when none of the
544 configured controllers can be contacted.</p>
546 Changing <ref column="fail_mode"/> when no primary controllers are
547 configured clears the flow table.
551 <column name="datapath_id">
552 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
553 (Setting this column has no useful effect. Set <ref
554 column="other-config" key="datapath-id"/> instead.)
557 <column name="other_config" key="datapath-id">
558 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
559 value. May not be all-zero.
562 <column name="other_config" key="dp-desc">
563 Human readable description of datapath. It it a maximum 256
564 byte-long free-form string to describe the datapath for
565 debugging purposes, e.g. <code>switch3 in room 3120</code>.
568 <column name="other_config" key="disable-in-band"
569 type='{"type": "boolean"}'>
570 If set to <code>true</code>, disable in-band control on the bridge
571 regardless of controller and manager settings.
574 <column name="other_config" key="in-band-queue"
575 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
576 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
577 that will be used by flows set up by in-band control on this bridge.
578 If unset, or if the port used by an in-band control flow does not have
579 QoS configured, or if the port does not have a queue with the specified
580 ID, the default queue is used instead.
583 <column name="protocols">
585 List of OpenFlow protocols that may be used when negotiating
586 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
587 1.3 are enabled by default if this column is empty.
591 OpenFlow 1.4 is not enabled by default because its implementation is
596 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
597 experimental because the OpenFlow 1.5 specification is still under
598 development and thus subject to change. Pass
599 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
600 OpenFlow 1.5 to be enabled.
605 <group title="Spanning Tree Configuration">
606 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
607 that ensures loop-free topologies. It allows redundant links to
608 be included in the network to provide automatic backup paths if
609 the active links fails.
611 <column name="stp_enable">
612 Enable spanning tree on the bridge. By default, STP is disabled
613 on bridges. Bond, internal, and mirror ports are not supported
614 and will not participate in the spanning tree.
617 <column name="other_config" key="stp-system-id">
618 The bridge's STP identifier (the lower 48 bits of the bridge-id)
620 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
621 By default, the identifier is the MAC address of the bridge.
624 <column name="other_config" key="stp-priority"
625 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
626 The bridge's relative priority value for determining the root
627 bridge (the upper 16 bits of the bridge-id). A bridge with the
628 lowest bridge-id is elected the root. By default, the priority
632 <column name="other_config" key="stp-hello-time"
633 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
634 The interval between transmissions of hello messages by
635 designated ports, in seconds. By default the hello interval is
639 <column name="other_config" key="stp-max-age"
640 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
641 The maximum age of the information transmitted by the bridge
642 when it is the root bridge, in seconds. By default, the maximum
646 <column name="other_config" key="stp-forward-delay"
647 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
648 The delay to wait between transitioning root and designated
649 ports to <code>forwarding</code>, in seconds. By default, the
650 forwarding delay is 15 seconds.
654 <group title="Other Features">
655 <column name="datapath_type">
656 Name of datapath provider. The kernel datapath has
657 type <code>system</code>. The userspace datapath has
658 type <code>netdev</code>.
661 <column name="external_ids" key="bridge-id">
662 A unique identifier of the bridge. On Citrix XenServer this will
663 commonly be the same as
664 <ref column="external_ids" key="xs-network-uuids"/>.
667 <column name="external_ids" key="xs-network-uuids">
668 Semicolon-delimited set of universally unique identifier(s) for the
669 network with which this bridge is associated on a Citrix XenServer
670 host. The network identifiers are RFC 4122 UUIDs as displayed by,
671 e.g., <code>xe network-list</code>.
674 <column name="other_config" key="hwaddr">
675 An Ethernet address in the form
676 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
677 to set the hardware address of the local port and influence the
681 <column name="other_config" key="forward-bpdu"
682 type='{"type": "boolean"}'>
683 Option to allow forwarding of BPDU frames when NORMAL action is
684 invoked. Frames with reserved Ethernet addresses (e.g. STP
685 BPDU) will be forwarded when this option is enabled and the
686 switch is not providing that functionality. If STP is enabled
687 on the port, STP BPDUs will never be forwarded. If the Open
688 vSwitch bridge is used to connect different Ethernet networks,
689 and if Open vSwitch node does not run STP, then this option
690 should be enabled. Default is disabled, set to
691 <code>true</code> to enable.
693 The following destination MAC addresss will not be forwarded when this
696 <dt><code>01:80:c2:00:00:00</code></dt>
697 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
699 <dt><code>01:80:c2:00:00:01</code></dt>
700 <dd>IEEE Pause frame.</dd>
702 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
703 <dd>Other reserved protocols.</dd>
705 <dt><code>00:e0:2b:00:00:00</code></dt>
706 <dd>Extreme Discovery Protocol (EDP).</dd>
709 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
711 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
713 <dt><code>01:00:0c:cc:cc:cc</code></dt>
715 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
716 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
720 <dt><code>01:00:0c:cc:cc:cd</code></dt>
721 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
723 <dt><code>01:00:0c:cd:cd:cd</code></dt>
724 <dd>Cisco STP Uplink Fast.</dd>
726 <dt><code>01:00:0c:00:00:00</code></dt>
727 <dd>Cisco Inter Switch Link.</dd>
729 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
734 <column name="other_config" key="mac-aging-time"
735 type='{"type": "integer", "minInteger": 1}'>
737 The maximum number of seconds to retain a MAC learning entry for
738 which no packets have been seen. The default is currently 300
739 seconds (5 minutes). The value, if specified, is forced into a
740 reasonable range, currently 15 to 3600 seconds.
744 A short MAC aging time allows a network to more quickly detect that a
745 host is no longer connected to a switch port. However, it also makes
746 it more likely that packets will be flooded unnecessarily, when they
747 are addressed to a connected host that rarely transmits packets. To
748 reduce the incidence of unnecessary flooding, use a MAC aging time
749 longer than the maximum interval at which a host will ordinarily
754 <column name="other_config" key="mac-table-size"
755 type='{"type": "integer", "minInteger": 1}'>
757 The maximum number of MAC addresses to learn. The default is
758 currently 2048. The value, if specified, is forced into a reasonable
759 range, currently 10 to 1,000,000.
764 <group title="Bridge Status">
766 Status information about bridges.
768 <column name="status">
769 Key-value pairs that report bridge status.
771 <column name="status" key="stp_bridge_id">
773 The bridge-id (in hex) used in spanning tree advertisements.
774 Configuring the bridge-id is described in the
775 <code>stp-system-id</code> and <code>stp-priority</code> keys
776 of the <code>other_config</code> section earlier.
779 <column name="status" key="stp_designated_root">
781 The designated root (in hex) for this spanning tree.
784 <column name="status" key="stp_root_path_cost">
786 The path cost of reaching the designated bridge. A lower
792 <group title="Common Columns">
793 The overall purpose of these columns is described under <code>Common
794 Columns</code> at the beginning of this document.
796 <column name="other_config"/>
797 <column name="external_ids"/>
801 <table name="Port" table="Port or bond configuration.">
802 <p>A port within a <ref table="Bridge"/>.</p>
803 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
804 <ref column="interfaces"/> column. Such a port logically
805 corresponds to a port on a physical Ethernet switch. A port
806 with more than one interface is a ``bonded port'' (see
807 <ref group="Bonding Configuration"/>).</p>
808 <p>Some properties that one might think as belonging to a port are actually
809 part of the port's <ref table="Interface"/> members.</p>
812 Port name. Should be alphanumeric and no more than about 8
813 bytes long. May be the same as the interface name, for
814 non-bonded ports. Must otherwise be unique among the names of
815 ports, interfaces, and bridges on a host.
818 <column name="interfaces">
819 The port's interfaces. If there is more than one, this is a
823 <group title="VLAN Configuration">
824 <p>Bridge ports support the following types of VLAN configuration:</p>
829 A trunk port carries packets on one or more specified VLANs
830 specified in the <ref column="trunks"/> column (often, on every
831 VLAN). A packet that ingresses on a trunk port is in the VLAN
832 specified in its 802.1Q header, or VLAN 0 if the packet has no
833 802.1Q header. A packet that egresses through a trunk port will
834 have an 802.1Q header if it has a nonzero VLAN ID.
838 Any packet that ingresses on a trunk port tagged with a VLAN that
839 the port does not trunk is dropped.
846 An access port carries packets on exactly one VLAN specified in the
847 <ref column="tag"/> column. Packets egressing on an access port
848 have no 802.1Q header.
852 Any packet with an 802.1Q header with a nonzero VLAN ID that
853 ingresses on an access port is dropped, regardless of whether the
854 VLAN ID in the header is the access port's VLAN ID.
858 <dt>native-tagged</dt>
860 A native-tagged port resembles a trunk port, with the exception that
861 a packet without an 802.1Q header that ingresses on a native-tagged
862 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
866 <dt>native-untagged</dt>
868 A native-untagged port resembles a native-tagged port, with the
869 exception that a packet that egresses on a native-untagged port in
870 the native VLAN will not have an 802.1Q header.
874 A packet will only egress through bridge ports that carry the VLAN of
875 the packet, as described by the rules above.
878 <column name="vlan_mode">
880 The VLAN mode of the port, as described above. When this column is
881 empty, a default mode is selected as follows:
885 If <ref column="tag"/> contains a value, the port is an access
886 port. The <ref column="trunks"/> column should be empty.
889 Otherwise, the port is a trunk port. The <ref column="trunks"/>
890 column value is honored if it is present.
897 For an access port, the port's implicitly tagged VLAN. For a
898 native-tagged or native-untagged port, the port's native VLAN. Must
899 be empty if this is a trunk port.
903 <column name="trunks">
905 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
906 or VLANs that this port trunks; if it is empty, then the port trunks
907 all VLANs. Must be empty if this is an access port.
910 A native-tagged or native-untagged port always trunks its native
911 VLAN, regardless of whether <ref column="trunks"/> includes that
916 <column name="other_config" key="priority-tags"
917 type='{"type": "boolean"}'>
919 An 802.1Q header contains two important pieces of information: a VLAN
920 ID and a priority. A frame with a zero VLAN ID, called a
921 ``priority-tagged'' frame, is supposed to be treated the same way as
922 a frame without an 802.1Q header at all (except for the priority).
926 However, some network elements ignore any frame that has 802.1Q
927 header at all, even when the VLAN ID is zero. Therefore, by default
928 Open vSwitch does not output priority-tagged frames, instead omitting
929 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
930 <code>true</code> to enable priority-tagged frames on a port.
934 Regardless of this setting, Open vSwitch omits the 802.1Q header on
935 output if both the VLAN ID and priority would be zero.
939 All frames output to native-tagged ports have a nonzero VLAN ID, so
940 this setting is not meaningful on native-tagged ports.
945 <group title="Bonding Configuration">
946 <p>A port that has more than one interface is a ``bonded port.'' Bonding
947 allows for load balancing and fail-over.</p>
950 The following types of bonding will work with any kind of upstream
951 switch. On the upstream switch, do not configure the interfaces as a
956 <dt><code>balance-slb</code></dt>
958 Balances flows among slaves based on source MAC address and output
959 VLAN, with periodic rebalancing as traffic patterns change.
962 <dt><code>active-backup</code></dt>
964 Assigns all flows to one slave, failing over to a backup slave when
965 the active slave is disabled. This is the only bonding mode in which
966 interfaces may be plugged into different upstream switches.
971 The following modes require the upstream switch to support 802.3ad with
972 successful LACP negotiation. If LACP negotiation fails and
973 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
978 <dt><code>balance-tcp</code></dt>
980 Balances flows among slaves based on L2, L3, and L4 protocol
981 information such as destination MAC address, IP address, and TCP
986 <p>These columns apply only to bonded ports. Their values are
987 otherwise ignored.</p>
989 <column name="bond_mode">
990 <p>The type of bonding used for a bonded port. Defaults to
991 <code>active-backup</code> if unset.
995 <column name="other_config" key="bond-hash-basis"
996 type='{"type": "integer"}'>
997 An integer hashed along with flows when choosing output slaves in load
998 balanced bonds. When changed, all flows will be assigned different
999 hash values possibly causing slave selection decisions to change. Does
1000 not affect bonding modes which do not employ load balancing such as
1001 <code>active-backup</code>.
1004 <group title="Link Failure Detection">
1006 An important part of link bonding is detecting that links are down so
1007 that they may be disabled. These settings determine how Open vSwitch
1008 detects link failure.
1011 <column name="other_config" key="bond-detect-mode"
1012 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1013 The means used to detect link failures. Defaults to
1014 <code>carrier</code> which uses each interface's carrier to detect
1015 failures. When set to <code>miimon</code>, will check for failures
1016 by polling each interface's MII.
1019 <column name="other_config" key="bond-miimon-interval"
1020 type='{"type": "integer"}'>
1021 The interval, in milliseconds, between successive attempts to poll
1022 each interface's MII. Relevant only when <ref column="other_config"
1023 key="bond-detect-mode"/> is <code>miimon</code>.
1026 <column name="bond_updelay">
1028 The number of milliseconds for which the link must stay up on an
1029 interface before the interface is considered to be up. Specify
1030 <code>0</code> to enable the interface immediately.
1034 This setting is honored only when at least one bonded interface is
1035 already enabled. When no interfaces are enabled, then the first
1036 bond interface to come up is enabled immediately.
1040 <column name="bond_downdelay">
1041 The number of milliseconds for which the link must stay down on an
1042 interface before the interface is considered to be down. Specify
1043 <code>0</code> to disable the interface immediately.
1047 <group title="LACP Configuration">
1049 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1050 allows switches to automatically detect that they are connected by
1051 multiple links and aggregate across those links. These settings
1052 control LACP behavior.
1055 <column name="lacp">
1056 Configures LACP on this port. LACP allows directly connected
1057 switches to negotiate which links may be bonded. LACP may be enabled
1058 on non-bonded ports for the benefit of any switches they may be
1059 connected to. <code>active</code> ports are allowed to initiate LACP
1060 negotiations. <code>passive</code> ports are allowed to participate
1061 in LACP negotiations initiated by a remote switch, but not allowed to
1062 initiate such negotiations themselves. If LACP is enabled on a port
1063 whose partner switch does not support LACP, the bond will be
1064 disabled, unless other-config:lacp-fallback-ab is set to true.
1065 Defaults to <code>off</code> if unset.
1068 <column name="other_config" key="lacp-system-id">
1069 The LACP system ID of this <ref table="Port"/>. The system ID of a
1070 LACP bond is used to identify itself to its partners. Must be a
1071 nonzero MAC address. Defaults to the bridge Ethernet address if
1075 <column name="other_config" key="lacp-system-priority"
1076 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1077 The LACP system priority of this <ref table="Port"/>. In LACP
1078 negotiations, link status decisions are made by the system with the
1079 numerically lower priority.
1082 <column name="other_config" key="lacp-time"
1083 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1085 The LACP timing which should be used on this <ref table="Port"/>.
1086 By default <code>slow</code> is used. When configured to be
1087 <code>fast</code> LACP heartbeats are requested at a rate of once
1088 per second causing connectivity problems to be detected more
1089 quickly. In <code>slow</code> mode, heartbeats are requested at a
1090 rate of once every 30 seconds.
1094 <column name="other_config" key="lacp-fallback-ab"
1095 type='{"type": "boolean"}'>
1097 Determines the behavior of openvswitch bond in LACP mode. If
1098 the partner switch does not support LACP, setting this option
1099 to <code>true</code> allows openvswitch to fallback to
1100 active-backup. If the option is set to <code>false</code>, the
1101 bond will be disabled. In both the cases, once the partner switch
1102 is configured to LACP mode, the bond will use LACP.
1107 <group title="Rebalancing Configuration">
1109 These settings control behavior when a bond is in
1110 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1113 <column name="other_config" key="bond-rebalance-interval"
1114 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1115 For a load balanced bonded port, the number of milliseconds between
1116 successive attempts to rebalance the bond, that is, to move flows
1117 from one interface on the bond to another in an attempt to keep usage
1118 of each interface roughly equal. If zero, load balancing is disabled
1119 on the bond (link failure still cause flows to move). If
1120 less than 1000ms, the rebalance interval will be 1000ms.
1124 <column name="bond_fake_iface">
1125 For a bonded port, whether to create a fake internal interface with the
1126 name of the port. Use only for compatibility with legacy software that
1131 <group title="Spanning Tree Configuration">
1132 <column name="other_config" key="stp-enable"
1133 type='{"type": "boolean"}'>
1134 If spanning tree is enabled on the bridge, member ports are
1135 enabled by default (with the exception of bond, internal, and
1136 mirror ports which do not work with STP). If this column's
1137 value is <code>false</code> spanning tree is disabled on the
1141 <column name="other_config" key="stp-port-num"
1142 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1143 The port number used for the lower 8 bits of the port-id. By
1144 default, the numbers will be assigned automatically. If any
1145 port's number is manually configured on a bridge, then they
1149 <column name="other_config" key="stp-port-priority"
1150 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1151 The port's relative priority value for determining the root
1152 port (the upper 8 bits of the port-id). A port with a lower
1153 port-id will be chosen as the root port. By default, the
1157 <column name="other_config" key="stp-path-cost"
1158 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1159 Spanning tree path cost for the port. A lower number indicates
1160 a faster link. By default, the cost is based on the maximum
1165 <group title="Other Features">
1167 Quality of Service configuration for this port.
1171 The MAC address to use for this port for the purpose of choosing the
1172 bridge's MAC address. This column does not necessarily reflect the
1173 port's actual MAC address, nor will setting it change the port's actual
1177 <column name="fake_bridge">
1178 Does this port represent a sub-bridge for its tagged VLAN within the
1179 Bridge? See ovs-vsctl(8) for more information.
1182 <column name="external_ids" key="fake-bridge-id-*">
1183 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1184 column) are defined by prefixing a <ref table="Bridge"/> <ref
1185 table="Bridge" column="external_ids"/> key with
1186 <code>fake-bridge-</code>,
1187 e.g. <code>fake-bridge-xs-network-uuids</code>.
1191 <group title="Port Status">
1193 Status information about ports attached to bridges.
1195 <column name="status">
1196 Key-value pairs that report port status.
1198 <column name="status" key="stp_port_id">
1200 The port-id (in hex) used in spanning tree advertisements for
1201 this port. Configuring the port-id is described in the
1202 <code>stp-port-num</code> and <code>stp-port-priority</code>
1203 keys of the <code>other_config</code> section earlier.
1206 <column name="status" key="stp_state"
1207 type='{"type": "string", "enum": ["set",
1208 ["disabled", "listening", "learning",
1209 "forwarding", "blocking"]]}'>
1211 STP state of the port.
1214 <column name="status" key="stp_sec_in_state"
1215 type='{"type": "integer", "minInteger": 0}'>
1217 The amount of time (in seconds) port has been in the current
1221 <column name="status" key="stp_role"
1222 type='{"type": "string", "enum": ["set",
1223 ["root", "designated", "alternate"]]}'>
1225 STP role of the port.
1230 <group title="Port Statistics">
1232 Key-value pairs that report port statistics. The update period
1233 is controlled by <ref column="other_config"
1234 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1236 <group title="Statistics: STP transmit and receive counters">
1237 <column name="statistics" key="stp_tx_count">
1238 Number of STP BPDUs sent on this port by the spanning
1241 <column name="statistics" key="stp_rx_count">
1242 Number of STP BPDUs received on this port and accepted by the
1243 spanning tree library.
1245 <column name="statistics" key="stp_error_count">
1246 Number of bad STP BPDUs received on this port. Bad BPDUs
1247 include runt packets and those with an unexpected protocol ID.
1252 <group title="Common Columns">
1253 The overall purpose of these columns is described under <code>Common
1254 Columns</code> at the beginning of this document.
1256 <column name="other_config"/>
1257 <column name="external_ids"/>
1261 <table name="Interface" title="One physical network device in a Port.">
1262 An interface within a <ref table="Port"/>.
1264 <group title="Core Features">
1265 <column name="name">
1266 Interface name. Should be alphanumeric and no more than about 8 bytes
1267 long. May be the same as the port name, for non-bonded ports. Must
1268 otherwise be unique among the names of ports, interfaces, and bridges
1272 <column name="ifindex">
1273 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1274 2863, if the interface has one, otherwise 0. The ifindex is useful for
1275 seamless integration with protocols such as SNMP and sFlow.
1278 <column name="mac_in_use">
1279 The MAC address in use by this interface.
1283 <p>Ethernet address to set for this interface. If unset then the
1284 default MAC address is used:</p>
1286 <li>For the local interface, the default is the lowest-numbered MAC
1287 address among the other bridge ports, either the value of the
1288 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1289 if set, or its actual MAC (for bonded ports, the MAC of its slave
1290 whose name is first in alphabetical order). Internal ports and
1291 bridge ports that are used as port mirroring destinations (see the
1292 <ref table="Mirror"/> table) are ignored.</li>
1293 <li>For other internal interfaces, the default MAC is randomly
1295 <li>External interfaces typically have a MAC address associated with
1296 their hardware.</li>
1298 <p>Some interfaces may not have a software-controllable MAC
1302 <column name="error">
1303 If the configuration of the port failed, as indicated by -1 in <ref
1304 column="ofport"/>, Open vSwitch sets this column to an error
1305 description in human readable form. Otherwise, Open vSwitch clears
1309 <group title="OpenFlow Port Number">
1311 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1312 port number for the new port. If the client that adds the port fills
1313 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1314 value as the OpenFlow port number. Otherwise, or if the requested
1315 port number is already in use or cannot be used for another reason,
1316 Open vSwitch automatically assigns a free port number. Regardless of
1317 how the port number was obtained, Open vSwitch then reports in <ref
1318 column="ofport"/> the port number actually assigned.
1322 Open vSwitch limits the port numbers that it automatically assigns to
1323 the range 1 through 32,767, inclusive. Controllers therefore have
1324 free use of ports 32,768 and up.
1327 <column name="ofport">
1329 OpenFlow port number for this interface. Open vSwitch sets this
1330 column's value, so other clients should treat it as read-only.
1333 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1334 The other valid port numbers are in the range 1 to 65,279,
1335 inclusive. Value -1 indicates an error adding the interface.
1339 <column name="ofport_request"
1340 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1342 Requested OpenFlow port number for this interface.
1346 A client should ideally set this column's value in the same
1347 database transaction that it uses to create the interface. Open
1348 vSwitch version 2.1 and later will honor a later request for a
1349 specific port number, althuogh it might confuse some controllers:
1350 OpenFlow does not have a way to announce a port number change, so
1351 Open vSwitch represents it over OpenFlow as a port deletion
1352 followed immediately by a port addition.
1356 If <ref column="ofport_request"/> is set or changed to some other
1357 port's automatically assigned port number, Open vSwitch chooses a
1358 new port number for the latter port.
1364 <group title="System-Specific Details">
1365 <column name="type">
1367 The interface type, one of:
1371 <dt><code>system</code></dt>
1372 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1373 Sometimes referred to as ``external interfaces'' since they are
1374 generally connected to hardware external to that on which the Open
1375 vSwitch is running. The empty string is a synonym for
1376 <code>system</code>.</dd>
1378 <dt><code>internal</code></dt>
1379 <dd>A simulated network device that sends and receives traffic. An
1380 internal interface whose <ref column="name"/> is the same as its
1381 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1382 ``local interface.'' It does not make sense to bond an internal
1383 interface, so the terms ``port'' and ``interface'' are often used
1384 imprecisely for internal interfaces.</dd>
1386 <dt><code>tap</code></dt>
1387 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1389 <dt><code>geneve</code></dt>
1391 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1394 Geneve supports options as a means to transport additional metadata,
1395 however, currently only the 24-bit VNI is supported. This is planned
1396 to be extended in the future.
1399 <dt><code>gre</code></dt>
1401 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1405 <dt><code>ipsec_gre</code></dt>
1407 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1411 <dt><code>gre64</code></dt>
1413 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1414 of key, it uses GRE protocol sequence number field. This is non
1415 standard use of GRE protocol since OVS does not increment
1416 sequence number for every packet at time of encap as expected by
1417 standard GRE implementation. See <ref group="Tunnel Options"/>
1418 for information on configuring GRE tunnels.
1421 <dt><code>ipsec_gre64</code></dt>
1423 Same as IPSEC_GRE except 64 bit key.
1426 <dt><code>vxlan</code></dt>
1429 An Ethernet tunnel over the experimental, UDP-based VXLAN
1430 protocol described at
1431 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1434 Open vSwitch uses UDP destination port 4789. The source port used for
1435 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1440 <dt><code>lisp</code></dt>
1443 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1444 Separation Protocol (RFC 6830).
1447 Only IPv4 and IPv6 packets are supported by the protocol, and
1448 they are sent and received without an Ethernet header. Traffic
1449 to/from LISP ports is expected to be configured explicitly, and
1450 the ports are not intended to participate in learning based
1451 switching. As such, they are always excluded from packet
1456 <dt><code>patch</code></dt>
1458 A pair of virtual devices that act as a patch cable.
1461 <dt><code>null</code></dt>
1462 <dd>An ignored interface. Deprecated and slated for removal in
1468 <group title="Tunnel Options">
1470 These options apply to interfaces with <ref column="type"/> of
1471 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1472 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1473 and <code>lisp</code>.
1477 Each tunnel must be uniquely identified by the combination of <ref
1478 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1479 column="options" key="local_ip"/>, and <ref column="options"
1480 key="in_key"/>. If two ports are defined that are the same except one
1481 has an optional identifier and the other does not, the more specific
1482 one is matched first. <ref column="options" key="in_key"/> is
1483 considered more specific than <ref column="options" key="local_ip"/> if
1484 a port defines one and another port defines the other.
1487 <column name="options" key="remote_ip">
1488 <p>Required. The remote tunnel endpoint, one of:</p>
1492 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1493 Only unicast endpoints are supported.
1496 The word <code>flow</code>. The tunnel accepts packets from any
1497 remote tunnel endpoint. To process only packets from a specific
1498 remote tunnel endpoint, the flow entries may match on the
1499 <code>tun_src</code> field. When sending packets to a
1500 <code>remote_ip=flow</code> tunnel, the flow actions must
1501 explicitly set the <code>tun_dst</code> field to the IP address of
1502 the desired remote tunnel endpoint, e.g. with a
1503 <code>set_field</code> action.
1508 The remote tunnel endpoint for any packet received from a tunnel
1509 is available in the <code>tun_src</code> field for matching in the
1514 <column name="options" key="local_ip">
1516 Optional. The tunnel destination IP that received packets must
1517 match. Default is to match all addresses. If specified, may be one
1523 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1526 The word <code>flow</code>. The tunnel accepts packets sent to any
1527 of the local IP addresses of the system running OVS. To process
1528 only packets sent to a specific IP address, the flow entries may
1529 match on the <code>tun_dst</code> field. When sending packets to a
1530 <code>local_ip=flow</code> tunnel, the flow actions may
1531 explicitly set the <code>tun_src</code> field to the desired IP
1532 address, e.g. with a <code>set_field</code> action. However, while
1533 routing the tunneled packet out, the local system may override the
1534 specified address with the local IP address configured for the
1535 outgoing system interface.
1538 This option is valid only for tunnels also configured with the
1539 <code>remote_ip=flow</code> option.
1545 The tunnel destination IP address for any packet received from a
1546 tunnel is available in the <code>tun_dst</code> field for matching in
1551 <column name="options" key="in_key">
1552 <p>Optional. The key that received packets must contain, one of:</p>
1556 <code>0</code>. The tunnel receives packets with no key or with a
1557 key of 0. This is equivalent to specifying no <ref column="options"
1558 key="in_key"/> at all.
1561 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1562 (for GRE64) number. The tunnel receives only packets with the
1566 The word <code>flow</code>. The tunnel accepts packets with any
1567 key. The key will be placed in the <code>tun_id</code> field for
1568 matching in the flow table. The <code>ovs-ofctl</code> manual page
1569 contains additional information about matching fields in OpenFlow
1578 <column name="options" key="out_key">
1579 <p>Optional. The key to be set on outgoing packets, one of:</p>
1583 <code>0</code>. Packets sent through the tunnel will have no key.
1584 This is equivalent to specifying no <ref column="options"
1585 key="out_key"/> at all.
1588 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1589 (for GRE64) number. Packets sent through the tunnel will have the
1593 The word <code>flow</code>. Packets sent through the tunnel will
1594 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1595 vendor extension (0 is used in the absence of an action). The
1596 <code>ovs-ofctl</code> manual page contains additional information
1597 about the Nicira OpenFlow vendor extensions.
1602 <column name="options" key="key">
1603 Optional. Shorthand to set <code>in_key</code> and
1604 <code>out_key</code> at the same time.
1607 <column name="options" key="tos">
1608 Optional. The value of the ToS bits to be set on the encapsulating
1609 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1610 zero. It may also be the word <code>inherit</code>, in which case
1611 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1612 (otherwise it will be 0). The ECN fields are always inherited.
1616 <column name="options" key="ttl">
1617 Optional. The TTL to be set on the encapsulating packet. It may also
1618 be the word <code>inherit</code>, in which case the TTL will be copied
1619 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1620 system default, typically 64). Default is the system default TTL.
1623 <column name="options" key="df_default"
1624 type='{"type": "boolean"}'>
1625 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1626 outer headers to allow path MTU discovery. Default is enabled; set
1627 to <code>false</code> to disable.
1630 <group title="Tunnel Options: gre and ipsec_gre only">
1632 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1636 <column name="options" key="csum" type='{"type": "boolean"}'>
1638 Optional. Compute GRE checksums on outgoing packets. Default is
1639 disabled, set to <code>true</code> to enable. Checksums present on
1640 incoming packets will be validated regardless of this setting.
1644 GRE checksums impose a significant performance penalty because they
1645 cover the entire packet. The encapsulated L3, L4, and L7 packet
1646 contents typically have their own checksums, so this additional
1647 checksum only adds value for the GRE and encapsulated L2 headers.
1651 This option is supported for <code>ipsec_gre</code>, but not useful
1652 because GRE checksums are weaker than, and redundant with, IPsec
1653 payload authentication.
1658 <group title="Tunnel Options: ipsec_gre only">
1660 Only <code>ipsec_gre</code> interfaces support these options.
1663 <column name="options" key="peer_cert">
1664 Required for certificate authentication. A string containing the
1665 peer's certificate in PEM format. Additionally the host's
1666 certificate must be specified with the <code>certificate</code>
1670 <column name="options" key="certificate">
1671 Required for certificate authentication. The name of a PEM file
1672 containing a certificate that will be presented to the peer during
1676 <column name="options" key="private_key">
1677 Optional for certificate authentication. The name of a PEM file
1678 containing the private key associated with <code>certificate</code>.
1679 If <code>certificate</code> contains the private key, this option may
1683 <column name="options" key="psk">
1684 Required for pre-shared key authentication. Specifies a pre-shared
1685 key for authentication that must be identical on both sides of the
1691 <group title="Patch Options">
1693 Only <code>patch</code> interfaces support these options.
1696 <column name="options" key="peer">
1697 The <ref column="name"/> of the <ref table="Interface"/> for the other
1698 side of the patch. The named <ref table="Interface"/>'s own
1699 <code>peer</code> option must specify this <ref table="Interface"/>'s
1700 name. That is, the two patch interfaces must have reversed <ref
1701 column="name"/> and <code>peer</code> values.
1705 <group title="Interface Status">
1707 Status information about interfaces attached to bridges, updated every
1708 5 seconds. Not all interfaces have all of these properties; virtual
1709 interfaces don't have a link speed, for example. Non-applicable
1710 columns will have empty values.
1712 <column name="admin_state">
1714 The administrative state of the physical network link.
1718 <column name="link_state">
1720 The observed state of the physical network link. This is ordinarily
1721 the link's carrier status. If the interface's <ref table="Port"/> is
1722 a bond configured for miimon monitoring, it is instead the network
1723 link's miimon status.
1727 <column name="link_resets">
1729 The number of times Open vSwitch has observed the
1730 <ref column="link_state"/> of this <ref table="Interface"/> change.
1734 <column name="link_speed">
1736 The negotiated speed of the physical network link.
1737 Valid values are positive integers greater than 0.
1741 <column name="duplex">
1743 The duplex mode of the physical network link.
1749 The MTU (maximum transmission unit); i.e. the largest
1750 amount of data that can fit into a single Ethernet frame.
1751 The standard Ethernet MTU is 1500 bytes. Some physical media
1752 and many kinds of virtual interfaces can be configured with
1756 This column will be empty for an interface that does not
1757 have an MTU as, for example, some kinds of tunnels do not.
1761 <column name="lacp_current">
1762 Boolean value indicating LACP status for this interface. If true, this
1763 interface has current LACP information about its LACP partner. This
1764 information may be used to monitor the health of interfaces in a LACP
1765 enabled port. This column will be empty if LACP is not enabled.
1768 <column name="status">
1769 Key-value pairs that report port status. Supported status values are
1770 <ref column="type"/>-dependent; some interfaces may not have a valid
1771 <ref column="status" key="driver_name"/>, for example.
1774 <column name="status" key="driver_name">
1775 The name of the device driver controlling the network adapter.
1778 <column name="status" key="driver_version">
1779 The version string of the device driver controlling the network
1783 <column name="status" key="firmware_version">
1784 The version string of the network adapter's firmware, if available.
1787 <column name="status" key="source_ip">
1788 The source IP address used for an IPv4 tunnel end-point, such as
1792 <column name="status" key="tunnel_egress_iface">
1793 Egress interface for tunnels. Currently only relevant for GRE tunnels
1794 On Linux systems, this column will show the name of the interface
1795 which is responsible for routing traffic destined for the configured
1796 <ref column="options" key="remote_ip"/>. This could be an internal
1797 interface such as a bridge port.
1800 <column name="status" key="tunnel_egress_iface_carrier"
1801 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1802 Whether carrier is detected on <ref column="status"
1803 key="tunnel_egress_iface"/>.
1807 <group title="Statistics">
1809 Key-value pairs that report interface statistics. The current
1810 implementation updates these counters periodically. The update period
1811 is controlled by <ref column="other_config"
1812 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1813 Future implementations may update them when an interface is created,
1814 when they are queried (e.g. using an OVSDB <code>select</code>
1815 operation), and just before an interface is deleted due to virtual
1816 interface hot-unplug or VM shutdown, and perhaps at other times, but
1817 not on any regular periodic basis.
1820 These are the same statistics reported by OpenFlow in its <code>struct
1821 ofp_port_stats</code> structure. If an interface does not support a
1822 given statistic, then that pair is omitted.
1824 <group title="Statistics: Successful transmit and receive counters">
1825 <column name="statistics" key="rx_packets">
1826 Number of received packets.
1828 <column name="statistics" key="rx_bytes">
1829 Number of received bytes.
1831 <column name="statistics" key="tx_packets">
1832 Number of transmitted packets.
1834 <column name="statistics" key="tx_bytes">
1835 Number of transmitted bytes.
1838 <group title="Statistics: Receive errors">
1839 <column name="statistics" key="rx_dropped">
1840 Number of packets dropped by RX.
1842 <column name="statistics" key="rx_frame_err">
1843 Number of frame alignment errors.
1845 <column name="statistics" key="rx_over_err">
1846 Number of packets with RX overrun.
1848 <column name="statistics" key="rx_crc_err">
1849 Number of CRC errors.
1851 <column name="statistics" key="rx_errors">
1852 Total number of receive errors, greater than or equal to the sum of
1856 <group title="Statistics: Transmit errors">
1857 <column name="statistics" key="tx_dropped">
1858 Number of packets dropped by TX.
1860 <column name="statistics" key="collisions">
1861 Number of collisions.
1863 <column name="statistics" key="tx_errors">
1864 Total number of transmit errors, greater than or equal to the sum of
1870 <group title="Ingress Policing">
1872 These settings control ingress policing for packets received on this
1873 interface. On a physical interface, this limits the rate at which
1874 traffic is allowed into the system from the outside; on a virtual
1875 interface (one connected to a virtual machine), this limits the rate at
1876 which the VM is able to transmit.
1879 Policing is a simple form of quality-of-service that simply drops
1880 packets received in excess of the configured rate. Due to its
1881 simplicity, policing is usually less accurate and less effective than
1882 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1883 table="Queue"/> tables).
1886 Policing is currently implemented only on Linux. The Linux
1887 implementation uses a simple ``token bucket'' approach:
1891 The size of the bucket corresponds to <ref
1892 column="ingress_policing_burst"/>. Initially the bucket is full.
1895 Whenever a packet is received, its size (converted to tokens) is
1896 compared to the number of tokens currently in the bucket. If the
1897 required number of tokens are available, they are removed and the
1898 packet is forwarded. Otherwise, the packet is dropped.
1901 Whenever it is not full, the bucket is refilled with tokens at the
1902 rate specified by <ref column="ingress_policing_rate"/>.
1906 Policing interacts badly with some network protocols, and especially
1907 with fragmented IP packets. Suppose that there is enough network
1908 activity to keep the bucket nearly empty all the time. Then this token
1909 bucket algorithm will forward a single packet every so often, with the
1910 period depending on packet size and on the configured rate. All of the
1911 fragments of an IP packets are normally transmitted back-to-back, as a
1912 group. In such a situation, therefore, only one of these fragments
1913 will be forwarded and the rest will be dropped. IP does not provide
1914 any way for the intended recipient to ask for only the remaining
1915 fragments. In such a case there are two likely possibilities for what
1916 will happen next: either all of the fragments will eventually be
1917 retransmitted (as TCP will do), in which case the same problem will
1918 recur, or the sender will not realize that its packet has been dropped
1919 and data will simply be lost (as some UDP-based protocols will do).
1920 Either way, it is possible that no forward progress will ever occur.
1922 <column name="ingress_policing_rate">
1924 Maximum rate for data received on this interface, in kbps. Data
1925 received faster than this rate is dropped. Set to <code>0</code>
1926 (the default) to disable policing.
1930 <column name="ingress_policing_burst">
1931 <p>Maximum burst size for data received on this interface, in kb. The
1932 default burst size if set to <code>0</code> is 1000 kb. This value
1933 has no effect if <ref column="ingress_policing_rate"/>
1934 is <code>0</code>.</p>
1936 Specifying a larger burst size lets the algorithm be more forgiving,
1937 which is important for protocols like TCP that react severely to
1938 dropped packets. The burst size should be at least the size of the
1939 interface's MTU. Specifying a value that is numerically at least as
1940 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1941 closer to achieving the full rate.
1946 <group title="Bidirectional Forwarding Detection (BFD)">
1948 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
1949 detection of connectivity failures by occasional transmission of
1950 BFD control messages. Open vSwitch implements BFD to serve
1951 as a more popular and standards compliant alternative to CFM.
1955 BFD operates by regularly transmitting BFD control messages at a rate
1956 negotiated independently in each direction. Each endpoint specifies
1957 the rate at which it expects to receive control messages, and the rate
1958 at which it is willing to transmit them. Open vSwitch uses a detection
1959 multiplier of three, meaning that an endpoint signals a connectivity
1960 fault if three consecutive BFD control messages fail to arrive. In the
1961 case of a unidirectional connectivity issue, the system not receiving
1962 BFD control messages signals the problem to its peer in the messages it
1967 The Open vSwitch implementation of BFD aims to comply faithfully
1968 with RFC 5880 requirements. Open vSwitch does not implement the
1969 optional Authentication or ``Echo Mode'' features.
1972 <group title="BFD Configuration">
1974 A controller sets up key-value pairs in the <ref column="bfd"/>
1975 column to enable and configure BFD.
1978 <column name="bfd" key="enable" type='{"type": "boolean"}'>
1979 True to enable BFD on this <ref table="Interface"/>.
1982 <column name="bfd" key="min_rx"
1983 type='{"type": "integer", "minInteger": 1}'>
1984 The shortest interval, in milliseconds, at which this BFD session
1985 offers to receive BFD control messages. The remote endpoint may
1986 choose to send messages at a slower rate. Defaults to
1990 <column name="bfd" key="min_tx"
1991 type='{"type": "integer", "minInteger": 1}'>
1992 The shortest interval, in milliseconds, at which this BFD session is
1993 willing to transmit BFD control messages. Messages will actually be
1994 transmitted at a slower rate if the remote endpoint is not willing to
1995 receive as quickly as specified. Defaults to <code>100</code>.
1998 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
1999 An alternate receive interval, in milliseconds, that must be greater
2000 than or equal to <ref column="bfd" key="min_rx"/>. The
2001 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2002 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2003 data traffic at the interface, to reduce the CPU and bandwidth cost
2004 of monitoring an idle interface. This feature may be disabled by
2005 setting a value of 0. This feature is reset whenever <ref
2006 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2010 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2011 When <code>true</code>, traffic received on the
2012 <ref table="Interface"/> is used to indicate the capability of packet
2013 I/O. BFD control packets are still transmitted and received. At
2014 least one BFD control packet must be received every 100 * <ref
2015 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2016 traffic are received, the <ref column="bfd" key="forwarding"/>
2017 will be <code>false</code>.
2020 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2021 Set to true to notify the remote endpoint that traffic should not be
2022 forwarded to this system for some reason other than a connectivty
2023 failure on the interface being monitored. The typical underlying
2024 reason is ``concatenated path down,'' that is, that connectivity
2025 beyond the local system is down. Defaults to false.
2028 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2029 Set to true to make BFD accept only control messages with a tunnel
2030 key of zero. By default, BFD accepts control messages with any
2034 <column name="bfd" key="bfd_dst_mac">
2035 Set to an Ethernet address in the form
2036 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2037 to set the MAC used as destination for transmitted BFD packets and
2038 expected as destination for received BFD packets. The default is
2039 <code>00:23:20:00:00:01</code>.
2042 <column name="bfd" key="bfd_src_ip">
2043 Set to an IPv4 address to set the IP address used as source for
2044 transmitted BFD packets. The default is <code>169.254.1.0</code>.
2047 <column name="bfd" key="bfd_dst_ip">
2048 Set to an IPv4 address to set the IP address used as destination
2049 for transmitted BFD packets. The default is <code>169.254.1.1</code>.
2053 <group title="BFD Status">
2055 The switch sets key-value pairs in the <ref column="bfd_status"/>
2056 column to report the status of BFD on this interface. When BFD is
2057 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2058 all key-value pairs from <ref column="bfd_status"/>.
2061 <column name="bfd_status" key="state"
2062 type='{"type": "string",
2063 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2064 Reports the state of the BFD session. The BFD session is fully
2065 healthy and negotiated if <code>UP</code>.
2068 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2069 Reports whether the BFD session believes this <ref
2070 table="Interface"/> may be used to forward traffic. Typically this
2071 means the local session is signaling <code>UP</code>, and the remote
2072 system isn't signaling a problem such as concatenated path down.
2075 <column name="bfd_status" key="diagnostic">
2076 In case of a problem, set to a short message that reports what the
2077 local BFD session thinks is wrong.
2080 <column name="bfd_status" key="remote_state"
2081 type='{"type": "string",
2082 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2083 Reports the state of the remote endpoint's BFD session.
2086 <column name="bfd_status" key="remote_diagnostic">
2087 In case of a problem, set to a short message that reports what the
2088 remote endpoint's BFD session thinks is wrong.
2091 <column name="bfd_status" key="flap_count"
2092 type='{"type": "integer", "minInteger": 0}'>
2093 Counts the number of <ref column="bfd_status" key="forwarding" />
2094 flaps since start. A flap is considered as a change of the
2095 <ref column="bfd_status" key="forwarding" /> value.
2100 <group title="Connectivity Fault Management">
2102 802.1ag Connectivity Fault Management (CFM) allows a group of
2103 Maintenance Points (MPs) called a Maintenance Association (MA) to
2104 detect connectivity problems with each other. MPs within a MA should
2105 have complete and exclusive interconnectivity. This is verified by
2106 occasionally broadcasting Continuity Check Messages (CCMs) at a
2107 configurable transmission interval.
2111 According to the 802.1ag specification, each Maintenance Point should
2112 be configured out-of-band with a list of Remote Maintenance Points it
2113 should have connectivity to. Open vSwitch differs from the
2114 specification in this area. It simply assumes the link is faulted if
2115 no Remote Maintenance Points are reachable, and considers it not
2120 When operating over tunnels which have no <code>in_key</code>, or an
2121 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2122 with a tunnel key of zero.
2125 <column name="cfm_mpid">
2127 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2128 within a Maintenance Association. The MPID is used to identify this
2129 endpoint to other Maintenance Points in the MA. Each end of a link
2130 being monitored should have a different MPID. Must be configured to
2131 enable CFM on this <ref table="Interface"/>.
2134 According to the 802.1ag specification, MPIDs can only range between
2135 [1, 8191]. However, extended mode (see <ref column="other_config"
2136 key="cfm_extended"/>) supports eight byte MPIDs.
2140 <column name="cfm_flap_count">
2141 Counts the number of cfm fault flapps since boot. A flap is
2142 considered to be a change of the <ref column="cfm_fault"/> value.
2145 <column name="cfm_fault">
2147 Indicates a connectivity fault triggered by an inability to receive
2148 heartbeats from any remote endpoint. When a fault is triggered on
2149 <ref table="Interface"/>s participating in bonds, they will be
2153 Faults can be triggered for several reasons. Most importantly they
2154 are triggered when no CCMs are received for a period of 3.5 times the
2155 transmission interval. Faults are also triggered when any CCMs
2156 indicate that a Remote Maintenance Point is not receiving CCMs but
2157 able to send them. Finally, a fault is triggered if a CCM is
2158 received which indicates unexpected configuration. Notably, this
2159 case arises when a CCM is received which advertises the local MPID.
2163 <column name="cfm_fault_status" key="recv">
2164 Indicates a CFM fault was triggered due to a lack of CCMs received on
2165 the <ref table="Interface"/>.
2168 <column name="cfm_fault_status" key="rdi">
2169 Indicates a CFM fault was triggered due to the reception of a CCM with
2170 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2171 are not receiving CCMs themselves. This typically indicates a
2172 unidirectional connectivity failure.
2175 <column name="cfm_fault_status" key="maid">
2176 Indicates a CFM fault was triggered due to the reception of a CCM with
2177 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2178 with an identification number in addition to the MPID called the MAID.
2179 Open vSwitch only supports receiving CCM broadcasts tagged with the
2180 MAID it uses internally.
2183 <column name="cfm_fault_status" key="loopback">
2184 Indicates a CFM fault was triggered due to the reception of a CCM
2185 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2186 column of this <ref table="Interface"/>. This may indicate a loop in
2190 <column name="cfm_fault_status" key="overflow">
2191 Indicates a CFM fault was triggered because the CFM module received
2192 CCMs from more remote endpoints than it can keep track of.
2195 <column name="cfm_fault_status" key="override">
2196 Indicates a CFM fault was manually triggered by an administrator using
2197 an <code>ovs-appctl</code> command.
2200 <column name="cfm_fault_status" key="interval">
2201 Indicates a CFM fault was triggered due to the reception of a CCM
2202 frame having an invalid interval.
2205 <column name="cfm_remote_opstate">
2206 <p>When in extended mode, indicates the operational state of the
2207 remote endpoint as either <code>up</code> or <code>down</code>. See
2208 <ref column="other_config" key="cfm_opstate"/>.
2212 <column name="cfm_health">
2214 Indicates the health of the interface as a percentage of CCM frames
2215 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2216 The health of an interface is undefined if it is communicating with
2217 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2218 healthy heartbeats are not received at the expected rate, and
2219 gradually improves as healthy heartbeats are received at the desired
2220 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2221 health of the interface is refreshed.
2224 As mentioned above, the faults can be triggered for several reasons.
2225 The link health will deteriorate even if heartbeats are received but
2226 they are reported to be unhealthy. An unhealthy heartbeat in this
2227 context is a heartbeat for which either some fault is set or is out
2228 of sequence. The interface health can be 100 only on receiving
2229 healthy heartbeats at the desired rate.
2233 <column name="cfm_remote_mpids">
2234 When CFM is properly configured, Open vSwitch will occasionally
2235 receive CCM broadcasts. These broadcasts contain the MPID of the
2236 sending Maintenance Point. The list of MPIDs from which this
2237 <ref table="Interface"/> is receiving broadcasts from is regularly
2238 collected and written to this column.
2241 <column name="other_config" key="cfm_interval"
2242 type='{"type": "integer"}'>
2244 The interval, in milliseconds, between transmissions of CFM
2245 heartbeats. Three missed heartbeat receptions indicate a
2250 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2251 60,000, or 600,000 ms are supported. Other values will be rounded
2252 down to the nearest value on the list. Extended mode (see <ref
2253 column="other_config" key="cfm_extended"/>) supports any interval up
2254 to 65,535 ms. In either mode, the default is 1000 ms.
2257 <p>We do not recommend using intervals less than 100 ms.</p>
2260 <column name="other_config" key="cfm_extended"
2261 type='{"type": "boolean"}'>
2262 When <code>true</code>, the CFM module operates in extended mode. This
2263 causes it to use a nonstandard destination address to avoid conflicting
2264 with compliant implementations which may be running concurrently on the
2265 network. Furthermore, extended mode increases the accuracy of the
2266 <code>cfm_interval</code> configuration parameter by breaking wire
2267 compatibility with 802.1ag compliant implementations. And extended
2268 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2271 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2273 When <code>true</code>, and
2274 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2275 module operates in demand mode. When in demand mode, traffic
2276 received on the <ref table="Interface"/> is used to indicate
2277 liveness. CCMs are still transmitted and received. At least one
2278 CCM must be received every 100 * <ref column="other_config"
2279 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2280 are received, the CFM module will raise the connectivity fault.
2284 Demand mode has a couple of caveats:
2287 To ensure that ovs-vswitchd has enough time to pull statistics
2288 from the datapath, the fault detection interval is set to
2289 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2294 To avoid ambiguity, demand mode disables itself when there are
2295 multiple remote maintenance points.
2299 If the <ref table="Interface"/> is heavily congested, CCMs
2300 containing the <ref column="other_config" key="cfm_opstate"/>
2301 status may be dropped causing changes in the operational state to
2302 be delayed. Similarly, if CCMs containing the RDI bit are not
2303 received, unidirectional link failures may not be detected.
2309 <column name="other_config" key="cfm_opstate"
2310 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2311 When <code>down</code>, the CFM module marks all CCMs it generates as
2312 operationally down without triggering a fault. This allows remote
2313 maintenance points to choose not to forward traffic to the
2314 <ref table="Interface"/> on which this CFM module is running.
2315 Currently, in Open vSwitch, the opdown bit of CCMs affects
2316 <ref table="Interface"/>s participating in bonds, and the bundle
2317 OpenFlow action. This setting is ignored when CFM is not in extended
2318 mode. Defaults to <code>up</code>.
2321 <column name="other_config" key="cfm_ccm_vlan"
2322 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2323 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2324 with the given value. May be the string <code>random</code> in which
2325 case each CCM will be tagged with a different randomly generated VLAN.
2328 <column name="other_config" key="cfm_ccm_pcp"
2329 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2330 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2331 with the given PCP value, the VLAN ID of the tag is governed by the
2332 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2333 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2339 <group title="Bonding Configuration">
2340 <column name="other_config" key="lacp-port-id"
2341 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2342 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2343 used in LACP negotiations to identify individual ports
2344 participating in a bond.
2347 <column name="other_config" key="lacp-port-priority"
2348 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2349 The LACP port priority of this <ref table="Interface"/>. In LACP
2350 negotiations <ref table="Interface"/>s with numerically lower
2351 priorities are preferred for aggregation.
2354 <column name="other_config" key="lacp-aggregation-key"
2355 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2356 The LACP aggregation key of this <ref table="Interface"/>. <ref
2357 table="Interface"/>s with different aggregation keys may not be active
2358 within a given <ref table="Port"/> at the same time.
2362 <group title="Virtual Machine Identifiers">
2364 These key-value pairs specifically apply to an interface that
2365 represents a virtual Ethernet interface connected to a virtual
2366 machine. These key-value pairs should not be present for other types
2367 of interfaces. Keys whose names end in <code>-uuid</code> have
2368 values that uniquely identify the entity in question. For a Citrix
2369 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2370 Other hypervisors may use other formats.
2373 <column name="external_ids" key="attached-mac">
2374 The MAC address programmed into the ``virtual hardware'' for this
2375 interface, in the form
2376 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2377 For Citrix XenServer, this is the value of the <code>MAC</code> field
2378 in the VIF record for this interface.
2381 <column name="external_ids" key="iface-id">
2382 A system-unique identifier for the interface. On XenServer, this will
2383 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2386 <column name="external_ids" key="iface-status"
2387 type='{"type": "string",
2388 "enum": ["set", ["active", "inactive"]]}'>
2390 Hypervisors may sometimes have more than one interface associated
2391 with a given <ref column="external_ids" key="iface-id"/>, only one of
2392 which is actually in use at a given time. For example, in some
2393 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2394 for a single <ref column="external_ids" key="iface-id"/>, but only
2395 uses one of them at a time. A hypervisor that behaves this way must
2396 mark the currently in use interface <code>active</code> and the
2397 others <code>inactive</code>. A hypervisor that never has more than
2398 one interface for a given <ref column="external_ids" key="iface-id"/>
2399 may mark that interface <code>active</code> or omit <ref
2400 column="external_ids" key="iface-status"/> entirely.
2404 During VM migration, a given <ref column="external_ids"
2405 key="iface-id"/> might transiently be marked <code>active</code> on
2406 two different hypervisors. That is, <code>active</code> means that
2407 this <ref column="external_ids" key="iface-id"/> is the active
2408 instance within a single hypervisor, not in a broader scope.
2409 There is one exception: some hypervisors support ``migration'' from a
2410 given hypervisor to itself (most often for test purposes). During
2411 such a ``migration,'' two instances of a single <ref
2412 column="external_ids" key="iface-id"/> might both be briefly marked
2413 <code>active</code> on a single hypervisor.
2417 <column name="external_ids" key="xs-vif-uuid">
2418 The virtual interface associated with this interface.
2421 <column name="external_ids" key="xs-network-uuid">
2422 The virtual network to which this interface is attached.
2425 <column name="external_ids" key="vm-id">
2426 The VM to which this interface belongs. On XenServer, this will be the
2427 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2430 <column name="external_ids" key="xs-vm-uuid">
2431 The VM to which this interface belongs.
2435 <group title="VLAN Splinters">
2437 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2438 with buggy network drivers in old versions of Linux that do not
2439 properly support VLANs when VLAN devices are not used, at some cost
2440 in memory and performance.
2444 When VLAN splinters are enabled on a particular interface, Open vSwitch
2445 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2446 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2447 received on the VLAN device is treated as if it had been received on
2448 the interface on the particular VLAN.
2452 VLAN splinters consider a VLAN to be in use if:
2457 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2458 table="Port"/> record.
2462 The VLAN is listed within the <ref table="Port" column="trunks"/>
2463 column of the <ref table="Port"/> record of an interface on which
2464 VLAN splinters are enabled.
2466 An empty <ref table="Port" column="trunks"/> does not influence the
2467 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2468 will exceed the current 1,024 port per datapath limit.
2472 An OpenFlow flow within any bridge matches the VLAN.
2477 The same set of in-use VLANs applies to every interface on which VLAN
2478 splinters are enabled. That is, the set is not chosen separately for
2479 each interface but selected once as the union of all in-use VLANs based
2484 It does not make sense to enable VLAN splinters on an interface for an
2485 access port, or on an interface that is not a physical port.
2489 VLAN splinters are deprecated. When broken device drivers are no
2490 longer in widespread use, we will delete this feature.
2493 <column name="other_config" key="enable-vlan-splinters"
2494 type='{"type": "boolean"}'>
2496 Set to <code>true</code> to enable VLAN splinters on this interface.
2497 Defaults to <code>false</code>.
2501 VLAN splinters increase kernel and userspace memory overhead, so do
2502 not use them unless they are needed.
2506 VLAN splinters do not support 802.1p priority tags. Received
2507 priorities will appear to be 0, regardless of their actual values,
2508 and priorities on transmitted packets will also be cleared to 0.
2513 <group title="Common Columns">
2514 The overall purpose of these columns is described under <code>Common
2515 Columns</code> at the beginning of this document.
2517 <column name="other_config"/>
2518 <column name="external_ids"/>
2522 <table name="Flow_Table" title="OpenFlow table configuration">
2523 <p>Configuration for a particular OpenFlow table.</p>
2525 <column name="name">
2526 The table's name. Set this column to change the name that controllers
2527 will receive when they request table statistics, e.g. <code>ovs-ofctl
2528 dump-tables</code>. The name does not affect switch behavior.
2531 <column name="flow_limit">
2532 If set, limits the number of flows that may be added to the table. Open
2533 vSwitch may limit the number of flows in a table for other reasons,
2534 e.g. due to hardware limitations or for resource availability or
2535 performance reasons.
2538 <column name="overflow_policy">
2540 Controls the switch's behavior when an OpenFlow flow table modification
2541 request would add flows in excess of <ref column="flow_limit"/>. The
2542 supported values are:
2546 <dt><code>refuse</code></dt>
2548 Refuse to add the flow or flows. This is also the default policy
2549 when <ref column="overflow_policy"/> is unset.
2552 <dt><code>evict</code></dt>
2554 Delete the flow that will expire soonest. See <ref column="groups"/>
2560 <column name="groups">
2562 When <ref column="overflow_policy"/> is <code>evict</code>, this
2563 controls how flows are chosen for eviction when the flow table would
2564 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2565 of NXM fields or sub-fields, each of which takes one of the forms
2566 <code><var>field</var>[]</code> or
2567 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2568 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2569 <code>nicira-ext.h</code> for a complete list of NXM field names.
2573 When a flow must be evicted due to overflow, the flow to evict is
2574 chosen through an approximation of the following algorithm:
2579 Divide the flows in the table into groups based on the values of the
2580 specified fields or subfields, so that all of the flows in a given
2581 group have the same values for those fields. If a flow does not
2582 specify a given field, that field's value is treated as 0.
2586 Consider the flows in the largest group, that is, the group that
2587 contains the greatest number of flows. If two or more groups all
2588 have the same largest number of flows, consider the flows in all of
2593 Among the flows under consideration, choose the flow that expires
2594 soonest for eviction.
2599 The eviction process only considers flows that have an idle timeout or
2600 a hard timeout. That is, eviction never deletes permanent flows.
2601 (Permanent flows do count against <ref column="flow_limit"/>.)
2605 Open vSwitch ignores any invalid or unknown field specifications.
2609 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2610 column has no effect.
2614 <column name="prefixes">
2616 This string set specifies which fields should be used for
2617 address prefix tracking. Prefix tracking allows the
2618 classifier to skip rules with longer than necessary prefixes,
2619 resulting in better wildcarding for datapath flows.
2622 Prefix tracking may be beneficial when a flow table contains
2623 matches on IP address fields with different prefix lengths.
2624 For example, when a flow table contains IP address matches on
2625 both full addresses and proper prefixes, the full address
2626 matches will typically cause the datapath flow to un-wildcard
2627 the whole address field (depending on flow entry priorities).
2628 In this case each packet with a different address gets handed
2629 to the userspace for flow processing and generates its own
2630 datapath flow. With prefix tracking enabled for the address
2631 field in question packets with addresses matching shorter
2632 prefixes would generate datapath flows where the irrelevant
2633 address bits are wildcarded, allowing the same datapath flow
2634 to handle all the packets within the prefix in question. In
2635 this case many userspace upcalls can be avoided and the
2636 overall performance can be better.
2639 This is a performance optimization only, so packets will
2640 receive the same treatment with or without prefix tracking.
2643 The supported fields are: <code>tun_id</code>,
2644 <code>tun_src</code>, <code>tun_dst</code>,
2645 <code>nw_src</code>, <code>nw_dst</code> (or aliases
2646 <code>ip_src</code> and <code>ip_dst</code>),
2647 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
2648 feature for <code>tun_id</code> would only make sense if the
2649 tunnel IDs have prefix structure similar to IP addresses.)
2653 By default, the <code>prefixes=ip_dst,ip_src</code> are used
2654 on each flow table. This instructs the flow classifier to
2655 track the IP destination and source addresses used by the
2656 rules in this specific flow table.
2660 The keyword <code>none</code> is recognized as an explicit
2661 override of the default values, causing no prefix fields to be
2666 To set the prefix fields, the flow table record needs to
2671 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
2673 Creates a flow table record for the OpenFlow table number 0.
2676 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
2678 Enables prefix tracking for IP source and destination
2684 There is a maximum number of fields that can be enabled for any
2685 one flow table. Currently this limit is 3.
2689 <group title="Common Columns">
2690 The overall purpose of these columns is described under <code>Common
2691 Columns</code> at the beginning of this document.
2693 <column name="external_ids"/>
2697 <table name="QoS" title="Quality of Service configuration">
2698 <p>Quality of Service (QoS) configuration for each Port that
2701 <column name="type">
2702 <p>The type of QoS to implement. The currently defined types are
2705 <dt><code>linux-htb</code></dt>
2707 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2708 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2709 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2710 for information on how this classifier works and how to configure it.
2714 <dt><code>linux-hfsc</code></dt>
2716 Linux "Hierarchical Fair Service Curve" classifier.
2717 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2718 information on how this classifier works.
2723 <column name="queues">
2724 <p>A map from queue numbers to <ref table="Queue"/> records. The
2725 supported range of queue numbers depend on <ref column="type"/>. The
2726 queue numbers are the same as the <code>queue_id</code> used in
2727 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2731 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2732 actions when no specific queue has been set. When no configuration for
2733 queue 0 is present, it is automatically configured as if a <ref
2734 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2735 and <ref table="Queue" column="other_config"/> columns had been
2737 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2738 this case. With some queuing disciplines, this dropped all packets
2739 destined for the default queue.)
2743 <group title="Configuration for linux-htb and linux-hfsc">
2745 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2746 the following key-value pair:
2749 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2750 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2751 specified, for physical interfaces, the default is the link rate. For
2752 other interfaces or if the link rate cannot be determined, the default
2753 is currently 100 Mbps.
2757 <group title="Common Columns">
2758 The overall purpose of these columns is described under <code>Common
2759 Columns</code> at the beginning of this document.
2761 <column name="other_config"/>
2762 <column name="external_ids"/>
2766 <table name="Queue" title="QoS output queue.">
2767 <p>A configuration for a port output queue, used in configuring Quality of
2768 Service (QoS) features. May be referenced by <ref column="queues"
2769 table="QoS"/> column in <ref table="QoS"/> table.</p>
2771 <column name="dscp">
2772 If set, Open vSwitch will mark all traffic egressing this
2773 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2774 default <ref table="Queue"/> is only marked if it was explicitly selected
2775 as the <ref table="Queue"/> at the time the packet was output. If unset,
2776 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2780 <group title="Configuration for linux-htb QoS">
2782 <ref table="QoS"/> <ref table="QoS" column="type"/>
2783 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2784 It has the following key-value pairs defined.
2787 <column name="other_config" key="min-rate"
2788 type='{"type": "integer", "minInteger": 1}'>
2789 Minimum guaranteed bandwidth, in bit/s.
2792 <column name="other_config" key="max-rate"
2793 type='{"type": "integer", "minInteger": 1}'>
2794 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2795 queue's rate will not be allowed to exceed the specified value, even
2796 if excess bandwidth is available. If unspecified, defaults to no
2800 <column name="other_config" key="burst"
2801 type='{"type": "integer", "minInteger": 1}'>
2802 Burst size, in bits. This is the maximum amount of ``credits'' that a
2803 queue can accumulate while it is idle. Optional. Details of the
2804 <code>linux-htb</code> implementation require a minimum burst size, so
2805 a too-small <code>burst</code> will be silently ignored.
2808 <column name="other_config" key="priority"
2809 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2810 A queue with a smaller <code>priority</code> will receive all the
2811 excess bandwidth that it can use before a queue with a larger value
2812 receives any. Specific priority values are unimportant; only relative
2813 ordering matters. Defaults to 0 if unspecified.
2817 <group title="Configuration for linux-hfsc QoS">
2819 <ref table="QoS"/> <ref table="QoS" column="type"/>
2820 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2821 It has the following key-value pairs defined.
2824 <column name="other_config" key="min-rate"
2825 type='{"type": "integer", "minInteger": 1}'>
2826 Minimum guaranteed bandwidth, in bit/s.
2829 <column name="other_config" key="max-rate"
2830 type='{"type": "integer", "minInteger": 1}'>
2831 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2832 queue's rate will not be allowed to exceed the specified value, even if
2833 excess bandwidth is available. If unspecified, defaults to no
2838 <group title="Common Columns">
2839 The overall purpose of these columns is described under <code>Common
2840 Columns</code> at the beginning of this document.
2842 <column name="other_config"/>
2843 <column name="external_ids"/>
2847 <table name="Mirror" title="Port mirroring.">
2848 <p>A port mirror within a <ref table="Bridge"/>.</p>
2849 <p>A port mirror configures a bridge to send selected frames to special
2850 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2851 traffic may also be referred to as SPAN or RSPAN, depending on how
2852 the mirrored traffic is sent.</p>
2854 <column name="name">
2855 Arbitrary identifier for the <ref table="Mirror"/>.
2858 <group title="Selecting Packets for Mirroring">
2860 To be selected for mirroring, a given packet must enter or leave the
2861 bridge through a selected port and it must also be in one of the
2865 <column name="select_all">
2866 If true, every packet arriving or departing on any port is
2867 selected for mirroring.
2870 <column name="select_dst_port">
2871 Ports on which departing packets are selected for mirroring.
2874 <column name="select_src_port">
2875 Ports on which arriving packets are selected for mirroring.
2878 <column name="select_vlan">
2879 VLANs on which packets are selected for mirroring. An empty set
2880 selects packets on all VLANs.
2884 <group title="Mirroring Destination Configuration">
2886 These columns are mutually exclusive. Exactly one of them must be
2890 <column name="output_port">
2891 <p>Output port for selected packets, if nonempty.</p>
2892 <p>Specifying a port for mirror output reserves that port exclusively
2893 for mirroring. No frames other than those selected for mirroring
2895 will be forwarded to the port, and any frames received on the port
2896 will be discarded.</p>
2898 The output port may be any kind of port supported by Open vSwitch.
2899 It may be, for example, a physical port (sometimes called SPAN) or a
2904 <column name="output_vlan">
2905 <p>Output VLAN for selected packets, if nonempty.</p>
2906 <p>The frames will be sent out all ports that trunk
2907 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2908 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2909 trunk port, the frame's VLAN tag will be set to
2910 <ref column="output_vlan"/>, replacing any existing tag; when it is
2911 sent out an implicit VLAN port, the frame will not be tagged. This
2912 type of mirroring is sometimes called RSPAN.</p>
2914 See the documentation for
2915 <ref column="other_config" key="forward-bpdu"/> in the
2916 <ref table="Interface"/> table for a list of destination MAC
2917 addresses which will not be mirrored to a VLAN to avoid confusing
2918 switches that interpret the protocols that they represent.
2920 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2921 contains unmanaged switches. Consider an unmanaged physical switch
2922 with two ports: port 1, connected to an end host, and port 2,
2923 connected to an Open vSwitch configured to mirror received packets
2924 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2925 port 1 that the physical switch forwards to port 2. The Open vSwitch
2926 forwards this packet to its destination and then reflects it back on
2927 port 2 in VLAN 123. This reflected packet causes the unmanaged
2928 physical switch to replace the MAC learning table entry, which
2929 correctly pointed to port 1, with one that incorrectly points to port
2930 2. Afterward, the physical switch will direct packets destined for
2931 the end host to the Open vSwitch on port 2, instead of to the end
2932 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2933 desired in this scenario, then the physical switch must be replaced
2934 by one that learns Ethernet addresses on a per-VLAN basis. In
2935 addition, learning should be disabled on the VLAN containing mirrored
2936 traffic. If this is not done then intermediate switches will learn
2937 the MAC address of each end host from the mirrored traffic. If
2938 packets being sent to that end host are also mirrored, then they will
2939 be dropped since the switch will attempt to send them out the input
2940 port. Disabling learning for the VLAN will cause the switch to
2941 correctly send the packet out all ports configured for that VLAN. If
2942 Open vSwitch is being used as an intermediate switch, learning can be
2943 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2944 in the appropriate <ref table="Bridge"/> table or tables.</p>
2946 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2947 VLAN and should generally be preferred.
2952 <group title="Statistics: Mirror counters">
2954 Key-value pairs that report mirror statistics. The update period
2955 is controlled by <ref column="other_config"
2956 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2958 <column name="statistics" key="tx_packets">
2959 Number of packets transmitted through this mirror.
2961 <column name="statistics" key="tx_bytes">
2962 Number of bytes transmitted through this mirror.
2966 <group title="Common Columns">
2967 The overall purpose of these columns is described under <code>Common
2968 Columns</code> at the beginning of this document.
2970 <column name="external_ids"/>
2974 <table name="Controller" title="OpenFlow controller configuration.">
2975 <p>An OpenFlow controller.</p>
2978 Open vSwitch supports two kinds of OpenFlow controllers:
2982 <dt>Primary controllers</dt>
2985 This is the kind of controller envisioned by the OpenFlow 1.0
2986 specification. Usually, a primary controller implements a network
2987 policy by taking charge of the switch's flow table.
2991 Open vSwitch initiates and maintains persistent connections to
2992 primary controllers, retrying the connection each time it fails or
2993 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2994 <ref table="Bridge"/> table applies to primary controllers.
2998 Open vSwitch permits a bridge to have any number of primary
2999 controllers. When multiple controllers are configured, Open
3000 vSwitch connects to all of them simultaneously. Because
3001 OpenFlow 1.0 does not specify how multiple controllers
3002 coordinate in interacting with a single switch, more than
3003 one primary controller should be specified only if the
3004 controllers are themselves designed to coordinate with each
3005 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3006 vendor extension may be useful for this.)
3009 <dt>Service controllers</dt>
3012 These kinds of OpenFlow controller connections are intended for
3013 occasional support and maintenance use, e.g. with
3014 <code>ovs-ofctl</code>. Usually a service controller connects only
3015 briefly to inspect or modify some of a switch's state.
3019 Open vSwitch listens for incoming connections from service
3020 controllers. The service controllers initiate and, if necessary,
3021 maintain the connections from their end. The <ref table="Bridge"
3022 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3023 not apply to service controllers.
3027 Open vSwitch supports configuring any number of service controllers.
3033 The <ref column="target"/> determines the type of controller.
3036 <group title="Core Features">
3037 <column name="target">
3038 <p>Connection method for controller.</p>
3040 The following connection methods are currently supported for primary
3044 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3046 <p>The specified SSL <var>port</var> on the host at the
3047 given <var>ip</var>, which must be expressed as an IP
3048 address (not a DNS name). The <ref table="Open_vSwitch"
3049 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3050 table must point to a valid SSL configuration when this form
3052 <p>If <var>port</var> is not specified, it currently
3053 defaults to 6633. In the future, the default will change to
3054 6653, which is the IANA-defined value.</p>
3055 <p>SSL support is an optional feature that is not always built as
3056 part of Open vSwitch.</p>
3058 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3061 The specified TCP <var>port</var> on the host at the given
3062 <var>ip</var>, which must be expressed as an IP address (not a
3063 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3064 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3065 e.g. <code>tcp:[::1]:6632</code>.
3068 If <var>port</var> is not specified, it currently defaults to
3069 6633. In the future, the default will change to 6653, which is
3070 the IANA-defined value.
3075 The following connection methods are currently supported for service
3079 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3082 Listens for SSL connections on the specified TCP <var>port</var>.
3083 If <var>ip</var>, which must be expressed as an IP address (not a
3084 DNS name), is specified, then connections are restricted to the
3085 specified local IP address (either IPv4 or IPv6). If
3086 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3087 e.g. <code>pssl:6632:[::1]</code>.
3090 If <var>port</var> is not specified, it currently defaults to
3091 6633. If <var>ip</var> is not specified then it listens only on
3092 IPv4 (but not IPv6) addresses. The
3093 <ref table="Open_vSwitch" column="ssl"/>
3094 column in the <ref table="Open_vSwitch"/> table must point to a
3095 valid SSL configuration when this form is used.
3098 If <var>port</var> is not specified, it currently defaults to
3099 6633. In the future, the default will change to 6653, which is
3100 the IANA-defined value.
3103 SSL support is an optional feature that is not always built as
3104 part of Open vSwitch.
3107 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3110 Listens for connections on the specified TCP <var>port</var>. If
3111 <var>ip</var>, which must be expressed as an IP address (not a
3112 DNS name), is specified, then connections are restricted to the
3113 specified local IP address (either IPv4 or IPv6). If
3114 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3115 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3116 specified then it listens only on IPv4 addresses.
3119 If <var>port</var> is not specified, it currently defaults to
3120 6633. In the future, the default will change to 6653, which is
3121 the IANA-defined value.
3125 <p>When multiple controllers are configured for a single bridge, the
3126 <ref column="target"/> values must be unique. Duplicate
3127 <ref column="target"/> values yield unspecified results.</p>
3130 <column name="connection_mode">
3131 <p>If it is specified, this setting must be one of the following
3132 strings that describes how Open vSwitch contacts this OpenFlow
3133 controller over the network:</p>
3136 <dt><code>in-band</code></dt>
3137 <dd>In this mode, this controller's OpenFlow traffic travels over the
3138 bridge associated with the controller. With this setting, Open
3139 vSwitch allows traffic to and from the controller regardless of the
3140 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3141 would never be able to connect to the controller, because it did
3142 not have a flow to enable it.) This is the most common connection
3143 mode because it is not necessary to maintain two independent
3145 <dt><code>out-of-band</code></dt>
3146 <dd>In this mode, OpenFlow traffic uses a control network separate
3147 from the bridge associated with this controller, that is, the
3148 bridge does not use any of its own network devices to communicate
3149 with the controller. The control network must be configured
3150 separately, before or after <code>ovs-vswitchd</code> is started.
3154 <p>If not specified, the default is implementation-specific.</p>
3158 <group title="Controller Failure Detection and Handling">
3159 <column name="max_backoff">
3160 Maximum number of milliseconds to wait between connection attempts.
3161 Default is implementation-specific.
3164 <column name="inactivity_probe">
3165 Maximum number of milliseconds of idle time on connection to
3166 controller before sending an inactivity probe message. If Open
3167 vSwitch does not communicate with the controller for the specified
3168 number of seconds, it will send a probe. If a response is not
3169 received for the same additional amount of time, Open vSwitch
3170 assumes the connection has been broken and attempts to reconnect.
3171 Default is implementation-specific. A value of 0 disables
3176 <group title="Asynchronous Message Configuration">
3178 OpenFlow switches send certain messages to controllers spontanenously,
3179 that is, not in response to any request from the controller. These
3180 messages are called ``asynchronous messages.'' These columns allow
3181 asynchronous messages to be limited or disabled to ensure the best use
3182 of network resources.
3185 <column name="enable_async_messages">
3186 The OpenFlow protocol enables asynchronous messages at time of
3187 connection establishment, which means that a controller can receive
3188 asynchronous messages, potentially many of them, even if it turns them
3189 off immediately after connecting. Set this column to
3190 <code>false</code> to change Open vSwitch behavior to disable, by
3191 default, all asynchronous messages. The controller can use the
3192 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3193 on any messages that it does want to receive, if any.
3196 <column name="controller_rate_limit">
3198 The maximum rate at which the switch will forward packets to the
3199 OpenFlow controller, in packets per second. This feature prevents a
3200 single bridge from overwhelming the controller. If not specified,
3201 the default is implementation-specific.
3205 In addition, when a high rate triggers rate-limiting, Open vSwitch
3206 queues controller packets for each port and transmits them to the
3207 controller at the configured rate. The <ref
3208 column="controller_burst_limit"/> value limits the number of queued
3209 packets. Ports on a bridge share the packet queue fairly.
3213 Open vSwitch maintains two such packet rate-limiters per bridge: one
3214 for packets sent up to the controller because they do not correspond
3215 to any flow, and the other for packets sent up to the controller by
3216 request through flow actions. When both rate-limiters are filled with
3217 packets, the actual rate that packets are sent to the controller is
3218 up to twice the specified rate.
3222 <column name="controller_burst_limit">
3223 In conjunction with <ref column="controller_rate_limit"/>,
3224 the maximum number of unused packet credits that the bridge will
3225 allow to accumulate, in packets. If not specified, the default
3226 is implementation-specific.
3230 <group title="Additional In-Band Configuration">
3231 <p>These values are considered only in in-band control mode (see
3232 <ref column="connection_mode"/>).</p>
3234 <p>When multiple controllers are configured on a single bridge, there
3235 should be only one set of unique values in these columns. If different
3236 values are set for these columns in different controllers, the effect
3239 <column name="local_ip">
3240 The IP address to configure on the local port,
3241 e.g. <code>192.168.0.123</code>. If this value is unset, then
3242 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3246 <column name="local_netmask">
3247 The IP netmask to configure on the local port,
3248 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3249 but this value is unset, then the default is chosen based on whether
3250 the IP address is class A, B, or C.
3253 <column name="local_gateway">
3254 The IP address of the gateway to configure on the local port, as a
3255 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3256 this network has no gateway.
3260 <group title="Controller Status">
3261 <column name="is_connected">
3262 <code>true</code> if currently connected to this controller,
3263 <code>false</code> otherwise.
3267 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3268 <p>The level of authority this controller has on the associated
3269 bridge. Possible values are:</p>
3271 <dt><code>other</code></dt>
3272 <dd>Allows the controller access to all OpenFlow features.</dd>
3273 <dt><code>master</code></dt>
3274 <dd>Equivalent to <code>other</code>, except that there may be at
3275 most one master controller at a time. When a controller configures
3276 itself as <code>master</code>, any existing master is demoted to
3277 the <code>slave</code>role.</dd>
3278 <dt><code>slave</code></dt>
3279 <dd>Allows the controller read-only access to OpenFlow features.
3280 Attempts to modify the flow table will be rejected with an
3281 error. Slave controllers do not receive OFPT_PACKET_IN or
3282 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3287 <column name="status" key="last_error">
3288 A human-readable description of the last error on the connection
3289 to the controller; i.e. <code>strerror(errno)</code>. This key
3290 will exist only if an error has occurred.
3293 <column name="status" key="state"
3294 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3296 The state of the connection to the controller:
3299 <dt><code>VOID</code></dt>
3300 <dd>Connection is disabled.</dd>
3302 <dt><code>BACKOFF</code></dt>
3303 <dd>Attempting to reconnect at an increasing period.</dd>
3305 <dt><code>CONNECTING</code></dt>
3306 <dd>Attempting to connect.</dd>
3308 <dt><code>ACTIVE</code></dt>
3309 <dd>Connected, remote host responsive.</dd>
3311 <dt><code>IDLE</code></dt>
3312 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3315 These values may change in the future. They are provided only for
3320 <column name="status" key="sec_since_connect"
3321 type='{"type": "integer", "minInteger": 0}'>
3322 The amount of time since this controller last successfully connected to
3323 the switch (in seconds). Value is empty if controller has never
3324 successfully connected.
3327 <column name="status" key="sec_since_disconnect"
3328 type='{"type": "integer", "minInteger": 1}'>
3329 The amount of time since this controller last disconnected from
3330 the switch (in seconds). Value is empty if controller has never
3335 <group title="Connection Parameters">
3337 Additional configuration for a connection between the controller
3338 and the Open vSwitch.
3341 <column name="other_config" key="dscp"
3342 type='{"type": "integer"}'>
3343 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3344 in the Type of Service (TOS) field in the IP header. DSCP provides a
3345 mechanism to classify the network traffic and provide Quality of
3346 Service (QoS) on IP networks.
3348 The DSCP value specified here is used when establishing the connection
3349 between the controller and the Open vSwitch. If no value is specified,
3350 a default value of 48 is chosen. Valid DSCP values must be in the
3356 <group title="Common Columns">
3357 The overall purpose of these columns is described under <code>Common
3358 Columns</code> at the beginning of this document.
3360 <column name="external_ids"/>
3361 <column name="other_config"/>
3365 <table name="Manager" title="OVSDB management connection.">
3367 Configuration for a database connection to an Open vSwitch database
3372 This table primarily configures the Open vSwitch database
3373 (<code>ovsdb-server</code>), not the Open vSwitch switch
3374 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3375 what connections should be treated as in-band.
3379 The Open vSwitch database server can initiate and maintain active
3380 connections to remote clients. It can also listen for database
3384 <group title="Core Features">
3385 <column name="target">
3386 <p>Connection method for managers.</p>
3388 The following connection methods are currently supported:
3391 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3394 The specified SSL <var>port</var> on the host at the given
3395 <var>ip</var>, which must be expressed as an IP address
3396 (not a DNS name). The <ref table="Open_vSwitch"
3397 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3398 table must point to a valid SSL configuration when this
3402 If <var>port</var> is not specified, it currently defaults
3403 to 6632. In the future, the default will change to 6640,
3404 which is the IANA-defined value.
3407 SSL support is an optional feature that is not always
3408 built as part of Open vSwitch.
3412 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3415 The specified TCP <var>port</var> on the host at the given
3416 <var>ip</var>, which must be expressed as an IP address (not a
3417 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3418 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3419 e.g. <code>tcp:[::1]:6632</code>.
3422 If <var>port</var> is not specified, it currently defaults
3423 to 6632. In the future, the default will change to 6640,
3424 which is the IANA-defined value.
3427 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3430 Listens for SSL connections on the specified TCP <var>port</var>.
3431 Specify 0 for <var>port</var> to have the kernel automatically
3432 choose an available port. If <var>ip</var>, which must be
3433 expressed as an IP address (not a DNS name), is specified, then
3434 connections are restricted to the specified local IP address
3435 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3436 address, wrap in square brackets,
3437 e.g. <code>pssl:6632:[::1]</code>. If <var>ip</var> is not
3438 specified then it listens only on IPv4 (but not IPv6) addresses.
3439 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3440 table="Open_vSwitch"/> table must point to a valid SSL
3441 configuration when this form is used.
3444 If <var>port</var> is not specified, it currently defaults
3445 to 6632. In the future, the default will change to 6640,
3446 which is the IANA-defined value.
3449 SSL support is an optional feature that is not always built as
3450 part of Open vSwitch.
3453 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3456 Listens for connections on the specified TCP <var>port</var>.
3457 Specify 0 for <var>port</var> to have the kernel automatically
3458 choose an available port. If <var>ip</var>, which must be
3459 expressed as an IP address (not a DNS name), is specified, then
3460 connections are restricted to the specified local IP address
3461 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3462 address, wrap it in square brackets,
3463 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3464 specified then it listens only on IPv4 addresses.
3467 If <var>port</var> is not specified, it currently defaults
3468 to 6632. In the future, the default will change to 6640,
3469 which is the IANA-defined value.
3473 <p>When multiple managers are configured, the <ref column="target"/>
3474 values must be unique. Duplicate <ref column="target"/> values yield
3475 unspecified results.</p>
3478 <column name="connection_mode">
3480 If it is specified, this setting must be one of the following strings
3481 that describes how Open vSwitch contacts this OVSDB client over the
3486 <dt><code>in-band</code></dt>
3488 In this mode, this connection's traffic travels over a bridge
3489 managed by Open vSwitch. With this setting, Open vSwitch allows
3490 traffic to and from the client regardless of the contents of the
3491 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3492 to connect to the client, because it did not have a flow to enable
3493 it.) This is the most common connection mode because it is not
3494 necessary to maintain two independent networks.
3496 <dt><code>out-of-band</code></dt>
3498 In this mode, the client's traffic uses a control network separate
3499 from that managed by Open vSwitch, that is, Open vSwitch does not
3500 use any of its own network devices to communicate with the client.
3501 The control network must be configured separately, before or after
3502 <code>ovs-vswitchd</code> is started.
3507 If not specified, the default is implementation-specific.
3512 <group title="Client Failure Detection and Handling">
3513 <column name="max_backoff">
3514 Maximum number of milliseconds to wait between connection attempts.
3515 Default is implementation-specific.
3518 <column name="inactivity_probe">
3519 Maximum number of milliseconds of idle time on connection to the client
3520 before sending an inactivity probe message. If Open vSwitch does not
3521 communicate with the client for the specified number of seconds, it
3522 will send a probe. If a response is not received for the same
3523 additional amount of time, Open vSwitch assumes the connection has been
3524 broken and attempts to reconnect. Default is implementation-specific.
3525 A value of 0 disables inactivity probes.
3529 <group title="Status">
3530 <column name="is_connected">
3531 <code>true</code> if currently connected to this manager,
3532 <code>false</code> otherwise.
3535 <column name="status" key="last_error">
3536 A human-readable description of the last error on the connection
3537 to the manager; i.e. <code>strerror(errno)</code>. This key
3538 will exist only if an error has occurred.
3541 <column name="status" key="state"
3542 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3544 The state of the connection to the manager:
3547 <dt><code>VOID</code></dt>
3548 <dd>Connection is disabled.</dd>
3550 <dt><code>BACKOFF</code></dt>
3551 <dd>Attempting to reconnect at an increasing period.</dd>
3553 <dt><code>CONNECTING</code></dt>
3554 <dd>Attempting to connect.</dd>
3556 <dt><code>ACTIVE</code></dt>
3557 <dd>Connected, remote host responsive.</dd>
3559 <dt><code>IDLE</code></dt>
3560 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3563 These values may change in the future. They are provided only for
3568 <column name="status" key="sec_since_connect"
3569 type='{"type": "integer", "minInteger": 0}'>
3570 The amount of time since this manager last successfully connected
3571 to the database (in seconds). Value is empty if manager has never
3572 successfully connected.
3575 <column name="status" key="sec_since_disconnect"
3576 type='{"type": "integer", "minInteger": 0}'>
3577 The amount of time since this manager last disconnected from the
3578 database (in seconds). Value is empty if manager has never
3582 <column name="status" key="locks_held">
3583 Space-separated list of the names of OVSDB locks that the connection
3584 holds. Omitted if the connection does not hold any locks.
3587 <column name="status" key="locks_waiting">
3588 Space-separated list of the names of OVSDB locks that the connection is
3589 currently waiting to acquire. Omitted if the connection is not waiting
3593 <column name="status" key="locks_lost">
3594 Space-separated list of the names of OVSDB locks that the connection
3595 has had stolen by another OVSDB client. Omitted if no locks have been
3596 stolen from this connection.
3599 <column name="status" key="n_connections"
3600 type='{"type": "integer", "minInteger": 2}'>
3602 When <ref column="target"/> specifies a connection method that
3603 listens for inbound connections (e.g. <code>ptcp:</code> or
3604 <code>pssl:</code>) and more than one connection is actually active,
3605 the value is the number of active connections. Otherwise, this
3606 key-value pair is omitted.
3609 When multiple connections are active, status columns and key-value
3610 pairs (other than this one) report the status of one arbitrarily
3615 <column name="status" key="bound_port" type='{"type": "integer"}'>
3616 When <ref column="target"/> is <code>ptcp:</code> or
3617 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3618 listening. (This is is particularly useful when <ref
3619 column="target"/> specifies a port of 0, allowing the kernel to
3620 choose any available port.)
3624 <group title="Connection Parameters">
3626 Additional configuration for a connection between the manager
3627 and the Open vSwitch Database.
3630 <column name="other_config" key="dscp"
3631 type='{"type": "integer"}'>
3632 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3633 in the Type of Service (TOS) field in the IP header. DSCP provides a
3634 mechanism to classify the network traffic and provide Quality of
3635 Service (QoS) on IP networks.
3637 The DSCP value specified here is used when establishing the connection
3638 between the manager and the Open vSwitch. If no value is specified, a
3639 default value of 48 is chosen. Valid DSCP values must be in the range
3644 <group title="Common Columns">
3645 The overall purpose of these columns is described under <code>Common
3646 Columns</code> at the beginning of this document.
3648 <column name="external_ids"/>
3649 <column name="other_config"/>
3653 <table name="NetFlow">
3654 A NetFlow target. NetFlow is a protocol that exports a number of
3655 details about terminating IP flows, such as the principals involved
3658 <column name="targets">
3659 NetFlow targets in the form
3660 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3661 must be specified numerically, not as a DNS name.
3664 <column name="engine_id">
3665 Engine ID to use in NetFlow messages. Defaults to datapath index
3669 <column name="engine_type">
3670 Engine type to use in NetFlow messages. Defaults to datapath
3671 index if not specified.
3674 <column name="active_timeout">
3675 The interval at which NetFlow records are sent for flows that are
3676 still active, in seconds. A value of <code>0</code> requests the
3677 default timeout (currently 600 seconds); a value of <code>-1</code>
3678 disables active timeouts.
3681 <column name="add_id_to_interface">
3682 <p>If this column's value is <code>false</code>, the ingress and egress
3683 interface fields of NetFlow flow records are derived from OpenFlow port
3684 numbers. When it is <code>true</code>, the 7 most significant bits of
3685 these fields will be replaced by the least significant 7 bits of the
3686 engine id. This is useful because many NetFlow collectors do not
3687 expect multiple switches to be sending messages from the same host, so
3688 they do not store the engine information which could be used to
3689 disambiguate the traffic.</p>
3690 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3693 <group title="Common Columns">
3694 The overall purpose of these columns is described under <code>Common
3695 Columns</code> at the beginning of this document.
3697 <column name="external_ids"/>
3702 SSL configuration for an Open_vSwitch.
3704 <column name="private_key">
3705 Name of a PEM file containing the private key used as the switch's
3706 identity for SSL connections to the controller.
3709 <column name="certificate">
3710 Name of a PEM file containing a certificate, signed by the
3711 certificate authority (CA) used by the controller and manager,
3712 that certifies the switch's private key, identifying a trustworthy
3716 <column name="ca_cert">
3717 Name of a PEM file containing the CA certificate used to verify
3718 that the switch is connected to a trustworthy controller.
3721 <column name="bootstrap_ca_cert">
3722 If set to <code>true</code>, then Open vSwitch will attempt to
3723 obtain the CA certificate from the controller on its first SSL
3724 connection and save it to the named PEM file. If it is successful,
3725 it will immediately drop the connection and reconnect, and from then
3726 on all SSL connections must be authenticated by a certificate signed
3727 by the CA certificate thus obtained. <em>This option exposes the
3728 SSL connection to a man-in-the-middle attack obtaining the initial
3729 CA certificate.</em> It may still be useful for bootstrapping.
3732 <group title="Common Columns">
3733 The overall purpose of these columns is described under <code>Common
3734 Columns</code> at the beginning of this document.
3736 <column name="external_ids"/>
3740 <table name="sFlow">
3741 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
3742 monitoring of switches.</p>
3744 <column name="agent">
3745 Name of the network device whose IP address should be reported as the
3746 ``agent address'' to collectors. If not specified, the agent device is
3747 figured from the first target address and the routing table. If the
3748 routing table does not contain a route to the target, the IP address
3749 defaults to the <ref table="Controller" column="local_ip"/> in the
3750 collector's <ref table="Controller"/>. If an agent IP address cannot be
3751 determined any of these ways, sFlow is disabled.
3754 <column name="header">
3755 Number of bytes of a sampled packet to send to the collector.
3756 If not specified, the default is 128 bytes.
3759 <column name="polling">
3760 Polling rate in seconds to send port statistics to the collector.
3761 If not specified, defaults to 30 seconds.
3764 <column name="sampling">
3765 Rate at which packets should be sampled and sent to the collector.
3766 If not specified, defaults to 400, which means one out of 400
3767 packets, on average, will be sent to the collector.
3770 <column name="targets">
3771 sFlow targets in the form
3772 <code><var>ip</var>:<var>port</var></code>.
3775 <group title="Common Columns">
3776 The overall purpose of these columns is described under <code>Common
3777 Columns</code> at the beginning of this document.
3779 <column name="external_ids"/>
3783 <table name="IPFIX">
3784 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3785 number of details about flows.</p>
3787 <column name="targets">
3788 IPFIX target collectors in the form
3789 <code><var>ip</var>:<var>port</var></code>.
3792 <column name="sampling">
3793 For per-bridge packet sampling, i.e. when this row is referenced
3794 from a <ref table="Bridge"/>, the rate at which packets should
3795 be sampled and sent to each target collector. If not specified,
3796 defaults to 400, which means one out of 400 packets, on average,
3797 will be sent to each target collector. Ignored for per-flow
3798 sampling, i.e. when this row is referenced from a <ref
3799 table="Flow_Sample_Collector_Set"/>.
3802 <column name="obs_domain_id">
3803 For per-bridge packet sampling, i.e. when this row is referenced
3804 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3805 sent in each IPFIX packet. If not specified, defaults to 0.
3806 Ignored for per-flow sampling, i.e. when this row is referenced
3807 from a <ref table="Flow_Sample_Collector_Set"/>.
3810 <column name="obs_point_id">
3811 For per-bridge packet sampling, i.e. when this row is referenced
3812 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3813 sent in each IPFIX flow record. If not specified, defaults to
3814 0. Ignored for per-flow sampling, i.e. when this row is
3815 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3818 <column name="cache_active_timeout">
3819 The maximum period in seconds for which an IPFIX flow record is
3820 cached and aggregated before being sent. If not specified,
3821 defaults to 0. If 0, caching is disabled.
3824 <column name="cache_max_flows">
3825 The maximum number of IPFIX flow records that can be cached at a
3826 time. If not specified, defaults to 0. If 0, caching is
3830 <group title="Common Columns">
3831 The overall purpose of these columns is described under <code>Common
3832 Columns</code> at the beginning of this document.
3834 <column name="external_ids"/>
3838 <table name="Flow_Sample_Collector_Set">
3839 <p>A set of IPFIX collectors of packet samples generated by
3840 OpenFlow <code>sample</code> actions.</p>
3843 The ID of this collector set, unique among the bridge's
3844 collector sets, to be used as the <code>collector_set_id</code>
3845 in OpenFlow <code>sample</code> actions.
3848 <column name="bridge">
3849 The bridge into which OpenFlow <code>sample</code> actions can
3850 be added to send packet samples to this set of IPFIX collectors.
3853 <column name="ipfix">
3854 Configuration of the set of IPFIX collectors to send one flow
3855 record per sampled packet to.
3858 <group title="Common Columns">
3859 The overall purpose of these columns is described under <code>Common
3860 Columns</code> at the beginning of this document.
3862 <column name="external_ids"/>