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 The current implementation of OpenFlow 1.4 support is not safe:
592 <code>ovs-vswitchd</code> will abort when certain unimplemented
593 features are tested. Thus, for now it is suitable only for
594 experimental use. For this reason, OpenFlow 1.4 is supported only
595 if, in addition to specifying <code>OpenFlow14</code> in this field,
596 <code>ovs-vswitchd</code> is invoked with the
597 <code>--enable-of14</code> option. (When support becomes safe, this
598 option will be removed.)
603 <group title="Spanning Tree Configuration">
604 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
605 that ensures loop-free topologies. It allows redundant links to
606 be included in the network to provide automatic backup paths if
607 the active links fails.
609 <column name="stp_enable">
610 Enable spanning tree on the bridge. By default, STP is disabled
611 on bridges. Bond, internal, and mirror ports are not supported
612 and will not participate in the spanning tree.
615 <column name="other_config" key="stp-system-id">
616 The bridge's STP identifier (the lower 48 bits of the bridge-id)
618 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
619 By default, the identifier is the MAC address of the bridge.
622 <column name="other_config" key="stp-priority"
623 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
624 The bridge's relative priority value for determining the root
625 bridge (the upper 16 bits of the bridge-id). A bridge with the
626 lowest bridge-id is elected the root. By default, the priority
630 <column name="other_config" key="stp-hello-time"
631 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
632 The interval between transmissions of hello messages by
633 designated ports, in seconds. By default the hello interval is
637 <column name="other_config" key="stp-max-age"
638 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
639 The maximum age of the information transmitted by the bridge
640 when it is the root bridge, in seconds. By default, the maximum
644 <column name="other_config" key="stp-forward-delay"
645 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
646 The delay to wait between transitioning root and designated
647 ports to <code>forwarding</code>, in seconds. By default, the
648 forwarding delay is 15 seconds.
652 <group title="Other Features">
653 <column name="datapath_type">
654 Name of datapath provider. The kernel datapath has
655 type <code>system</code>. The userspace datapath has
656 type <code>netdev</code>.
659 <column name="external_ids" key="bridge-id">
660 A unique identifier of the bridge. On Citrix XenServer this will
661 commonly be the same as
662 <ref column="external_ids" key="xs-network-uuids"/>.
665 <column name="external_ids" key="xs-network-uuids">
666 Semicolon-delimited set of universally unique identifier(s) for the
667 network with which this bridge is associated on a Citrix XenServer
668 host. The network identifiers are RFC 4122 UUIDs as displayed by,
669 e.g., <code>xe network-list</code>.
672 <column name="other_config" key="hwaddr">
673 An Ethernet address in the form
674 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
675 to set the hardware address of the local port and influence the
679 <column name="other_config" key="forward-bpdu"
680 type='{"type": "boolean"}'>
681 Option to allow forwarding of BPDU frames when NORMAL action is
682 invoked. Frames with reserved Ethernet addresses (e.g. STP
683 BPDU) will be forwarded when this option is enabled and the
684 switch is not providing that functionality. If STP is enabled
685 on the port, STP BPDUs will never be forwarded. If the Open
686 vSwitch bridge is used to connect different Ethernet networks,
687 and if Open vSwitch node does not run STP, then this option
688 should be enabled. Default is disabled, set to
689 <code>true</code> to enable.
691 The following destination MAC addresss will not be forwarded when this
694 <dt><code>01:80:c2:00:00:00</code></dt>
695 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
697 <dt><code>01:80:c2:00:00:01</code></dt>
698 <dd>IEEE Pause frame.</dd>
700 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
701 <dd>Other reserved protocols.</dd>
703 <dt><code>00:e0:2b:00:00:00</code></dt>
704 <dd>Extreme Discovery Protocol (EDP).</dd>
707 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
709 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
711 <dt><code>01:00:0c:cc:cc:cc</code></dt>
713 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
714 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
718 <dt><code>01:00:0c:cc:cc:cd</code></dt>
719 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
721 <dt><code>01:00:0c:cd:cd:cd</code></dt>
722 <dd>Cisco STP Uplink Fast.</dd>
724 <dt><code>01:00:0c:00:00:00</code></dt>
725 <dd>Cisco Inter Switch Link.</dd>
727 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
732 <column name="other_config" key="mac-aging-time"
733 type='{"type": "integer", "minInteger": 1}'>
735 The maximum number of seconds to retain a MAC learning entry for
736 which no packets have been seen. The default is currently 300
737 seconds (5 minutes). The value, if specified, is forced into a
738 reasonable range, currently 15 to 3600 seconds.
742 A short MAC aging time allows a network to more quickly detect that a
743 host is no longer connected to a switch port. However, it also makes
744 it more likely that packets will be flooded unnecessarily, when they
745 are addressed to a connected host that rarely transmits packets. To
746 reduce the incidence of unnecessary flooding, use a MAC aging time
747 longer than the maximum interval at which a host will ordinarily
752 <column name="other_config" key="mac-table-size"
753 type='{"type": "integer", "minInteger": 1}'>
755 The maximum number of MAC addresses to learn. The default is
756 currently 2048. The value, if specified, is forced into a reasonable
757 range, currently 10 to 1,000,000.
762 <group title="Bridge Status">
764 Status information about bridges.
766 <column name="status">
767 Key-value pairs that report bridge status.
769 <column name="status" key="stp_bridge_id">
771 The bridge-id (in hex) used in spanning tree advertisements.
772 Configuring the bridge-id is described in the
773 <code>stp-system-id</code> and <code>stp-priority</code> keys
774 of the <code>other_config</code> section earlier.
777 <column name="status" key="stp_designated_root">
779 The designated root (in hex) for this spanning tree.
782 <column name="status" key="stp_root_path_cost">
784 The path cost of reaching the designated bridge. A lower
790 <group title="Common Columns">
791 The overall purpose of these columns is described under <code>Common
792 Columns</code> at the beginning of this document.
794 <column name="other_config"/>
795 <column name="external_ids"/>
799 <table name="Port" table="Port or bond configuration.">
800 <p>A port within a <ref table="Bridge"/>.</p>
801 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
802 <ref column="interfaces"/> column. Such a port logically
803 corresponds to a port on a physical Ethernet switch. A port
804 with more than one interface is a ``bonded port'' (see
805 <ref group="Bonding Configuration"/>).</p>
806 <p>Some properties that one might think as belonging to a port are actually
807 part of the port's <ref table="Interface"/> members.</p>
810 Port name. Should be alphanumeric and no more than about 8
811 bytes long. May be the same as the interface name, for
812 non-bonded ports. Must otherwise be unique among the names of
813 ports, interfaces, and bridges on a host.
816 <column name="interfaces">
817 The port's interfaces. If there is more than one, this is a
821 <group title="VLAN Configuration">
822 <p>Bridge ports support the following types of VLAN configuration:</p>
827 A trunk port carries packets on one or more specified VLANs
828 specified in the <ref column="trunks"/> column (often, on every
829 VLAN). A packet that ingresses on a trunk port is in the VLAN
830 specified in its 802.1Q header, or VLAN 0 if the packet has no
831 802.1Q header. A packet that egresses through a trunk port will
832 have an 802.1Q header if it has a nonzero VLAN ID.
836 Any packet that ingresses on a trunk port tagged with a VLAN that
837 the port does not trunk is dropped.
844 An access port carries packets on exactly one VLAN specified in the
845 <ref column="tag"/> column. Packets egressing on an access port
846 have no 802.1Q header.
850 Any packet with an 802.1Q header with a nonzero VLAN ID that
851 ingresses on an access port is dropped, regardless of whether the
852 VLAN ID in the header is the access port's VLAN ID.
856 <dt>native-tagged</dt>
858 A native-tagged port resembles a trunk port, with the exception that
859 a packet without an 802.1Q header that ingresses on a native-tagged
860 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
864 <dt>native-untagged</dt>
866 A native-untagged port resembles a native-tagged port, with the
867 exception that a packet that egresses on a native-untagged port in
868 the native VLAN will not have an 802.1Q header.
872 A packet will only egress through bridge ports that carry the VLAN of
873 the packet, as described by the rules above.
876 <column name="vlan_mode">
878 The VLAN mode of the port, as described above. When this column is
879 empty, a default mode is selected as follows:
883 If <ref column="tag"/> contains a value, the port is an access
884 port. The <ref column="trunks"/> column should be empty.
887 Otherwise, the port is a trunk port. The <ref column="trunks"/>
888 column value is honored if it is present.
895 For an access port, the port's implicitly tagged VLAN. For a
896 native-tagged or native-untagged port, the port's native VLAN. Must
897 be empty if this is a trunk port.
901 <column name="trunks">
903 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
904 or VLANs that this port trunks; if it is empty, then the port trunks
905 all VLANs. Must be empty if this is an access port.
908 A native-tagged or native-untagged port always trunks its native
909 VLAN, regardless of whether <ref column="trunks"/> includes that
914 <column name="other_config" key="priority-tags"
915 type='{"type": "boolean"}'>
917 An 802.1Q header contains two important pieces of information: a VLAN
918 ID and a priority. A frame with a zero VLAN ID, called a
919 ``priority-tagged'' frame, is supposed to be treated the same way as
920 a frame without an 802.1Q header at all (except for the priority).
924 However, some network elements ignore any frame that has 802.1Q
925 header at all, even when the VLAN ID is zero. Therefore, by default
926 Open vSwitch does not output priority-tagged frames, instead omitting
927 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
928 <code>true</code> to enable priority-tagged frames on a port.
932 Regardless of this setting, Open vSwitch omits the 802.1Q header on
933 output if both the VLAN ID and priority would be zero.
937 All frames output to native-tagged ports have a nonzero VLAN ID, so
938 this setting is not meaningful on native-tagged ports.
943 <group title="Bonding Configuration">
944 <p>A port that has more than one interface is a ``bonded port.'' Bonding
945 allows for load balancing and fail-over.</p>
948 The following types of bonding will work with any kind of upstream
949 switch. On the upstream switch, do not configure the interfaces as a
954 <dt><code>balance-slb</code></dt>
956 Balances flows among slaves based on source MAC address and output
957 VLAN, with periodic rebalancing as traffic patterns change.
960 <dt><code>active-backup</code></dt>
962 Assigns all flows to one slave, failing over to a backup slave when
963 the active slave is disabled. This is the only bonding mode in which
964 interfaces may be plugged into different upstream switches.
969 The following modes require the upstream switch to support 802.3ad with
970 successful LACP negotiation. If LACP negotiation fails and
971 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
976 <dt><code>balance-tcp</code></dt>
978 Balances flows among slaves based on L2, L3, and L4 protocol
979 information such as destination MAC address, IP address, and TCP
984 <p>These columns apply only to bonded ports. Their values are
985 otherwise ignored.</p>
987 <column name="bond_mode">
988 <p>The type of bonding used for a bonded port. Defaults to
989 <code>active-backup</code> if unset.
993 <column name="other_config" key="bond-hash-basis"
994 type='{"type": "integer"}'>
995 An integer hashed along with flows when choosing output slaves in load
996 balanced bonds. When changed, all flows will be assigned different
997 hash values possibly causing slave selection decisions to change. Does
998 not affect bonding modes which do not employ load balancing such as
999 <code>active-backup</code>.
1002 <group title="Link Failure Detection">
1004 An important part of link bonding is detecting that links are down so
1005 that they may be disabled. These settings determine how Open vSwitch
1006 detects link failure.
1009 <column name="other_config" key="bond-detect-mode"
1010 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1011 The means used to detect link failures. Defaults to
1012 <code>carrier</code> which uses each interface's carrier to detect
1013 failures. When set to <code>miimon</code>, will check for failures
1014 by polling each interface's MII.
1017 <column name="other_config" key="bond-miimon-interval"
1018 type='{"type": "integer"}'>
1019 The interval, in milliseconds, between successive attempts to poll
1020 each interface's MII. Relevant only when <ref column="other_config"
1021 key="bond-detect-mode"/> is <code>miimon</code>.
1024 <column name="bond_updelay">
1026 The number of milliseconds for which the link must stay up on an
1027 interface before the interface is considered to be up. Specify
1028 <code>0</code> to enable the interface immediately.
1032 This setting is honored only when at least one bonded interface is
1033 already enabled. When no interfaces are enabled, then the first
1034 bond interface to come up is enabled immediately.
1038 <column name="bond_downdelay">
1039 The number of milliseconds for which the link must stay down on an
1040 interface before the interface is considered to be down. Specify
1041 <code>0</code> to disable the interface immediately.
1045 <group title="LACP Configuration">
1047 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1048 allows switches to automatically detect that they are connected by
1049 multiple links and aggregate across those links. These settings
1050 control LACP behavior.
1053 <column name="lacp">
1054 Configures LACP on this port. LACP allows directly connected
1055 switches to negotiate which links may be bonded. LACP may be enabled
1056 on non-bonded ports for the benefit of any switches they may be
1057 connected to. <code>active</code> ports are allowed to initiate LACP
1058 negotiations. <code>passive</code> ports are allowed to participate
1059 in LACP negotiations initiated by a remote switch, but not allowed to
1060 initiate such negotiations themselves. If LACP is enabled on a port
1061 whose partner switch does not support LACP, the bond will be
1062 disabled, unless other-config:lacp-fallback-ab is set to true.
1063 Defaults to <code>off</code> if unset.
1066 <column name="other_config" key="lacp-system-id">
1067 The LACP system ID of this <ref table="Port"/>. The system ID of a
1068 LACP bond is used to identify itself to its partners. Must be a
1069 nonzero MAC address. Defaults to the bridge Ethernet address if
1073 <column name="other_config" key="lacp-system-priority"
1074 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1075 The LACP system priority of this <ref table="Port"/>. In LACP
1076 negotiations, link status decisions are made by the system with the
1077 numerically lower priority.
1080 <column name="other_config" key="lacp-time"
1081 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1083 The LACP timing which should be used on this <ref table="Port"/>.
1084 By default <code>slow</code> is used. When configured to be
1085 <code>fast</code> LACP heartbeats are requested at a rate of once
1086 per second causing connectivity problems to be detected more
1087 quickly. In <code>slow</code> mode, heartbeats are requested at a
1088 rate of once every 30 seconds.
1092 <column name="other_config" key="lacp-fallback-ab"
1093 type='{"type": "boolean"}'>
1095 Determines the behavior of openvswitch bond in LACP mode. If
1096 the partner switch does not support LACP, setting this option
1097 to <code>true</code> allows openvswitch to fallback to
1098 active-backup. If the option is set to <code>false</code>, the
1099 bond will be disabled. In both the cases, once the partner switch
1100 is configured to LACP mode, the bond will use LACP.
1105 <group title="Rebalancing Configuration">
1107 These settings control behavior when a bond is in
1108 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1111 <column name="other_config" key="bond-rebalance-interval"
1112 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1113 For a load balanced bonded port, the number of milliseconds between
1114 successive attempts to rebalance the bond, that is, to move flows
1115 from one interface on the bond to another in an attempt to keep usage
1116 of each interface roughly equal. If zero, load balancing is disabled
1117 on the bond (link failure still cause flows to move). If
1118 less than 1000ms, the rebalance interval will be 1000ms.
1122 <column name="bond_fake_iface">
1123 For a bonded port, whether to create a fake internal interface with the
1124 name of the port. Use only for compatibility with legacy software that
1129 <group title="Spanning Tree Configuration">
1130 <column name="other_config" key="stp-enable"
1131 type='{"type": "boolean"}'>
1132 If spanning tree is enabled on the bridge, member ports are
1133 enabled by default (with the exception of bond, internal, and
1134 mirror ports which do not work with STP). If this column's
1135 value is <code>false</code> spanning tree is disabled on the
1139 <column name="other_config" key="stp-port-num"
1140 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1141 The port number used for the lower 8 bits of the port-id. By
1142 default, the numbers will be assigned automatically. If any
1143 port's number is manually configured on a bridge, then they
1147 <column name="other_config" key="stp-port-priority"
1148 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1149 The port's relative priority value for determining the root
1150 port (the upper 8 bits of the port-id). A port with a lower
1151 port-id will be chosen as the root port. By default, the
1155 <column name="other_config" key="stp-path-cost"
1156 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1157 Spanning tree path cost for the port. A lower number indicates
1158 a faster link. By default, the cost is based on the maximum
1163 <group title="Other Features">
1165 Quality of Service configuration for this port.
1169 The MAC address to use for this port for the purpose of choosing the
1170 bridge's MAC address. This column does not necessarily reflect the
1171 port's actual MAC address, nor will setting it change the port's actual
1175 <column name="fake_bridge">
1176 Does this port represent a sub-bridge for its tagged VLAN within the
1177 Bridge? See ovs-vsctl(8) for more information.
1180 <column name="external_ids" key="fake-bridge-id-*">
1181 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1182 column) are defined by prefixing a <ref table="Bridge"/> <ref
1183 table="Bridge" column="external_ids"/> key with
1184 <code>fake-bridge-</code>,
1185 e.g. <code>fake-bridge-xs-network-uuids</code>.
1189 <group title="Port Status">
1191 Status information about ports attached to bridges.
1193 <column name="status">
1194 Key-value pairs that report port status.
1196 <column name="status" key="stp_port_id">
1198 The port-id (in hex) used in spanning tree advertisements for
1199 this port. Configuring the port-id is described in the
1200 <code>stp-port-num</code> and <code>stp-port-priority</code>
1201 keys of the <code>other_config</code> section earlier.
1204 <column name="status" key="stp_state"
1205 type='{"type": "string", "enum": ["set",
1206 ["disabled", "listening", "learning",
1207 "forwarding", "blocking"]]}'>
1209 STP state of the port.
1212 <column name="status" key="stp_sec_in_state"
1213 type='{"type": "integer", "minInteger": 0}'>
1215 The amount of time (in seconds) port has been in the current
1219 <column name="status" key="stp_role"
1220 type='{"type": "string", "enum": ["set",
1221 ["root", "designated", "alternate"]]}'>
1223 STP role of the port.
1228 <group title="Port Statistics">
1230 Key-value pairs that report port statistics. The update period
1231 is controlled by <ref column="other_config"
1232 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1234 <group title="Statistics: STP transmit and receive counters">
1235 <column name="statistics" key="stp_tx_count">
1236 Number of STP BPDUs sent on this port by the spanning
1239 <column name="statistics" key="stp_rx_count">
1240 Number of STP BPDUs received on this port and accepted by the
1241 spanning tree library.
1243 <column name="statistics" key="stp_error_count">
1244 Number of bad STP BPDUs received on this port. Bad BPDUs
1245 include runt packets and those with an unexpected protocol ID.
1250 <group title="Common Columns">
1251 The overall purpose of these columns is described under <code>Common
1252 Columns</code> at the beginning of this document.
1254 <column name="other_config"/>
1255 <column name="external_ids"/>
1259 <table name="Interface" title="One physical network device in a Port.">
1260 An interface within a <ref table="Port"/>.
1262 <group title="Core Features">
1263 <column name="name">
1264 Interface name. Should be alphanumeric and no more than about 8 bytes
1265 long. May be the same as the port name, for non-bonded ports. Must
1266 otherwise be unique among the names of ports, interfaces, and bridges
1270 <column name="ifindex">
1271 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1272 2863, if the interface has one, otherwise 0. The ifindex is useful for
1273 seamless integration with protocols such as SNMP and sFlow.
1276 <column name="mac_in_use">
1277 The MAC address in use by this interface.
1281 <p>Ethernet address to set for this interface. If unset then the
1282 default MAC address is used:</p>
1284 <li>For the local interface, the default is the lowest-numbered MAC
1285 address among the other bridge ports, either the value of the
1286 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1287 if set, or its actual MAC (for bonded ports, the MAC of its slave
1288 whose name is first in alphabetical order). Internal ports and
1289 bridge ports that are used as port mirroring destinations (see the
1290 <ref table="Mirror"/> table) are ignored.</li>
1291 <li>For other internal interfaces, the default MAC is randomly
1293 <li>External interfaces typically have a MAC address associated with
1294 their hardware.</li>
1296 <p>Some interfaces may not have a software-controllable MAC
1300 <group title="OpenFlow Port Number">
1302 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1303 port number for the new port. If the client that adds the port fills
1304 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1305 value as the OpenFlow port number. Otherwise, or if the requested
1306 port number is already in use or cannot be used for another reason,
1307 Open vSwitch automatically assigns a free port number. Regardless of
1308 how the port number was obtained, Open vSwitch then reports in <ref
1309 column="ofport"/> the port number actually assigned.
1313 Open vSwitch limits the port numbers that it automatically assigns to
1314 the range 1 through 32,767, inclusive. Controllers therefore have
1315 free use of ports 32,768 and up.
1318 <column name="ofport">
1320 OpenFlow port number for this interface. Open vSwitch sets this
1321 column's value, so other clients should treat it as read-only.
1324 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1325 The other valid port numbers are in the range 1 to 65,279,
1326 inclusive. Value -1 indicates an error adding the interface.
1330 <column name="ofport_request"
1331 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1333 Requested OpenFlow port number for this interface.
1337 A client should ideally set this column's value in the same
1338 database transaction that it uses to create the interface. Open
1339 vSwitch version 2.1 and later will honor a later request for a
1340 specific port number, althuogh it might confuse some controllers:
1341 OpenFlow does not have a way to announce a port number change, so
1342 Open vSwitch represents it over OpenFlow as a port deletion
1343 followed immediately by a port addition.
1347 If <ref column="ofport_request"/> is set or changed to some other
1348 port's automatically assigned port number, Open vSwitch chooses a
1349 new port number for the latter port.
1355 <group title="System-Specific Details">
1356 <column name="type">
1358 The interface type, one of:
1362 <dt><code>system</code></dt>
1363 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1364 Sometimes referred to as ``external interfaces'' since they are
1365 generally connected to hardware external to that on which the Open
1366 vSwitch is running. The empty string is a synonym for
1367 <code>system</code>.</dd>
1369 <dt><code>internal</code></dt>
1370 <dd>A simulated network device that sends and receives traffic. An
1371 internal interface whose <ref column="name"/> is the same as its
1372 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1373 ``local interface.'' It does not make sense to bond an internal
1374 interface, so the terms ``port'' and ``interface'' are often used
1375 imprecisely for internal interfaces.</dd>
1377 <dt><code>tap</code></dt>
1378 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1380 <dt><code>gre</code></dt>
1382 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1386 <dt><code>ipsec_gre</code></dt>
1388 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1392 <dt><code>gre64</code></dt>
1394 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1395 of key, it uses GRE protocol sequence number field. This is non
1396 standard use of GRE protocol since OVS does not increment
1397 sequence number for every packet at time of encap as expected by
1398 standard GRE implementation. See <ref group="Tunnel Options"/>
1399 for information on configuring GRE tunnels.
1402 <dt><code>ipsec_gre64</code></dt>
1404 Same as IPSEC_GRE except 64 bit key.
1407 <dt><code>vxlan</code></dt>
1410 An Ethernet tunnel over the experimental, UDP-based VXLAN
1411 protocol described at
1412 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1415 Open vSwitch uses UDP destination port 4789. The source port used for
1416 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1421 <dt><code>lisp</code></dt>
1424 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1425 Separation Protocol (RFC 6830).
1428 Only IPv4 and IPv6 packets are supported by the protocol, and
1429 they are sent and received without an Ethernet header. Traffic
1430 to/from LISP ports is expected to be configured explicitly, and
1431 the ports are not intended to participate in learning based
1432 switching. As such, they are always excluded from packet
1437 <dt><code>patch</code></dt>
1439 A pair of virtual devices that act as a patch cable.
1442 <dt><code>null</code></dt>
1443 <dd>An ignored interface. Deprecated and slated for removal in
1449 <group title="Tunnel Options">
1451 These options apply to interfaces with <ref column="type"/> of
1452 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1453 <code>ipsec_gre64</code>, <code>vxlan</code>, and <code>lisp</code>.
1457 Each tunnel must be uniquely identified by the combination of <ref
1458 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1459 column="options" key="local_ip"/>, and <ref column="options"
1460 key="in_key"/>. If two ports are defined that are the same except one
1461 has an optional identifier and the other does not, the more specific
1462 one is matched first. <ref column="options" key="in_key"/> is
1463 considered more specific than <ref column="options" key="local_ip"/> if
1464 a port defines one and another port defines the other.
1467 <column name="options" key="remote_ip">
1468 <p>Required. The remote tunnel endpoint, one of:</p>
1472 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1473 Only unicast endpoints are supported.
1476 The word <code>flow</code>. The tunnel accepts packets from any
1477 remote tunnel endpoint. To process only packets from a specific
1478 remote tunnel endpoint, the flow entries may match on the
1479 <code>tun_src</code> field. When sending packets to a
1480 <code>remote_ip=flow</code> tunnel, the flow actions must
1481 explicitly set the <code>tun_dst</code> field to the IP address of
1482 the desired remote tunnel endpoint, e.g. with a
1483 <code>set_field</code> action.
1488 The remote tunnel endpoint for any packet received from a tunnel
1489 is available in the <code>tun_src</code> field for matching in the
1494 <column name="options" key="local_ip">
1496 Optional. The tunnel destination IP that received packets must
1497 match. Default is to match all addresses. If specified, may be one
1503 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1506 The word <code>flow</code>. The tunnel accepts packets sent to any
1507 of the local IP addresses of the system running OVS. To process
1508 only packets sent to a specific IP address, the flow entries may
1509 match on the <code>tun_dst</code> field. When sending packets to a
1510 <code>local_ip=flow</code> tunnel, the flow actions may
1511 explicitly set the <code>tun_src</code> field to the desired IP
1512 address, e.g. with a <code>set_field</code> action. However, while
1513 routing the tunneled packet out, the local system may override the
1514 specified address with the local IP address configured for the
1515 outgoing system interface.
1518 This option is valid only for tunnels also configured with the
1519 <code>remote_ip=flow</code> option.
1525 The tunnel destination IP address for any packet received from a
1526 tunnel is available in the <code>tun_dst</code> field for matching in
1531 <column name="options" key="in_key">
1532 <p>Optional. The key that received packets must contain, one of:</p>
1536 <code>0</code>. The tunnel receives packets with no key or with a
1537 key of 0. This is equivalent to specifying no <ref column="options"
1538 key="in_key"/> at all.
1541 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1542 (for GRE64) number. The tunnel receives only packets with the
1546 The word <code>flow</code>. The tunnel accepts packets with any
1547 key. The key will be placed in the <code>tun_id</code> field for
1548 matching in the flow table. The <code>ovs-ofctl</code> manual page
1549 contains additional information about matching fields in OpenFlow
1558 <column name="options" key="out_key">
1559 <p>Optional. The key to be set on outgoing packets, one of:</p>
1563 <code>0</code>. Packets sent through the tunnel will have no key.
1564 This is equivalent to specifying no <ref column="options"
1565 key="out_key"/> at all.
1568 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1569 (for GRE64) number. Packets sent through the tunnel will have the
1573 The word <code>flow</code>. Packets sent through the tunnel will
1574 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1575 vendor extension (0 is used in the absence of an action). The
1576 <code>ovs-ofctl</code> manual page contains additional information
1577 about the Nicira OpenFlow vendor extensions.
1582 <column name="options" key="key">
1583 Optional. Shorthand to set <code>in_key</code> and
1584 <code>out_key</code> at the same time.
1587 <column name="options" key="tos">
1588 Optional. The value of the ToS bits to be set on the encapsulating
1589 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1590 zero. It may also be the word <code>inherit</code>, in which case
1591 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1592 (otherwise it will be 0). The ECN fields are always inherited.
1596 <column name="options" key="ttl">
1597 Optional. The TTL to be set on the encapsulating packet. It may also
1598 be the word <code>inherit</code>, in which case the TTL will be copied
1599 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1600 system default, typically 64). Default is the system default TTL.
1603 <column name="options" key="df_default"
1604 type='{"type": "boolean"}'>
1605 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1606 outer headers to allow path MTU discovery. Default is enabled; set
1607 to <code>false</code> to disable.
1610 <group title="Tunnel Options: gre and ipsec_gre only">
1612 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1616 <column name="options" key="csum" type='{"type": "boolean"}'>
1618 Optional. Compute GRE checksums on outgoing packets. Default is
1619 disabled, set to <code>true</code> to enable. Checksums present on
1620 incoming packets will be validated regardless of this setting.
1624 GRE checksums impose a significant performance penalty because they
1625 cover the entire packet. The encapsulated L3, L4, and L7 packet
1626 contents typically have their own checksums, so this additional
1627 checksum only adds value for the GRE and encapsulated L2 headers.
1631 This option is supported for <code>ipsec_gre</code>, but not useful
1632 because GRE checksums are weaker than, and redundant with, IPsec
1633 payload authentication.
1638 <group title="Tunnel Options: ipsec_gre only">
1640 Only <code>ipsec_gre</code> interfaces support these options.
1643 <column name="options" key="peer_cert">
1644 Required for certificate authentication. A string containing the
1645 peer's certificate in PEM format. Additionally the host's
1646 certificate must be specified with the <code>certificate</code>
1650 <column name="options" key="certificate">
1651 Required for certificate authentication. The name of a PEM file
1652 containing a certificate that will be presented to the peer during
1656 <column name="options" key="private_key">
1657 Optional for certificate authentication. The name of a PEM file
1658 containing the private key associated with <code>certificate</code>.
1659 If <code>certificate</code> contains the private key, this option may
1663 <column name="options" key="psk">
1664 Required for pre-shared key authentication. Specifies a pre-shared
1665 key for authentication that must be identical on both sides of the
1671 <group title="Patch Options">
1673 Only <code>patch</code> interfaces support these options.
1676 <column name="options" key="peer">
1677 The <ref column="name"/> of the <ref table="Interface"/> for the other
1678 side of the patch. The named <ref table="Interface"/>'s own
1679 <code>peer</code> option must specify this <ref table="Interface"/>'s
1680 name. That is, the two patch interfaces must have reversed <ref
1681 column="name"/> and <code>peer</code> values.
1685 <group title="Interface Status">
1687 Status information about interfaces attached to bridges, updated every
1688 5 seconds. Not all interfaces have all of these properties; virtual
1689 interfaces don't have a link speed, for example. Non-applicable
1690 columns will have empty values.
1692 <column name="admin_state">
1694 The administrative state of the physical network link.
1698 <column name="link_state">
1700 The observed state of the physical network link. This is ordinarily
1701 the link's carrier status. If the interface's <ref table="Port"/> is
1702 a bond configured for miimon monitoring, it is instead the network
1703 link's miimon status.
1707 <column name="link_resets">
1709 The number of times Open vSwitch has observed the
1710 <ref column="link_state"/> of this <ref table="Interface"/> change.
1714 <column name="link_speed">
1716 The negotiated speed of the physical network link.
1717 Valid values are positive integers greater than 0.
1721 <column name="duplex">
1723 The duplex mode of the physical network link.
1729 The MTU (maximum transmission unit); i.e. the largest
1730 amount of data that can fit into a single Ethernet frame.
1731 The standard Ethernet MTU is 1500 bytes. Some physical media
1732 and many kinds of virtual interfaces can be configured with
1736 This column will be empty for an interface that does not
1737 have an MTU as, for example, some kinds of tunnels do not.
1741 <column name="lacp_current">
1742 Boolean value indicating LACP status for this interface. If true, this
1743 interface has current LACP information about its LACP partner. This
1744 information may be used to monitor the health of interfaces in a LACP
1745 enabled port. This column will be empty if LACP is not enabled.
1748 <column name="status">
1749 Key-value pairs that report port status. Supported status values are
1750 <ref column="type"/>-dependent; some interfaces may not have a valid
1751 <ref column="status" key="driver_name"/>, for example.
1754 <column name="status" key="driver_name">
1755 The name of the device driver controlling the network adapter.
1758 <column name="status" key="driver_version">
1759 The version string of the device driver controlling the network
1763 <column name="status" key="firmware_version">
1764 The version string of the network adapter's firmware, if available.
1767 <column name="status" key="source_ip">
1768 The source IP address used for an IPv4 tunnel end-point, such as
1772 <column name="status" key="tunnel_egress_iface">
1773 Egress interface for tunnels. Currently only relevant for GRE tunnels
1774 On Linux systems, this column will show the name of the interface
1775 which is responsible for routing traffic destined for the configured
1776 <ref column="options" key="remote_ip"/>. This could be an internal
1777 interface such as a bridge port.
1780 <column name="status" key="tunnel_egress_iface_carrier"
1781 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1782 Whether carrier is detected on <ref column="status"
1783 key="tunnel_egress_iface"/>.
1787 <group title="Statistics">
1789 Key-value pairs that report interface statistics. The current
1790 implementation updates these counters periodically. The update period
1791 is controlled by <ref column="other_config"
1792 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1793 Future implementations may update them when an interface is created,
1794 when they are queried (e.g. using an OVSDB <code>select</code>
1795 operation), and just before an interface is deleted due to virtual
1796 interface hot-unplug or VM shutdown, and perhaps at other times, but
1797 not on any regular periodic basis.
1800 These are the same statistics reported by OpenFlow in its <code>struct
1801 ofp_port_stats</code> structure. If an interface does not support a
1802 given statistic, then that pair is omitted.
1804 <group title="Statistics: Successful transmit and receive counters">
1805 <column name="statistics" key="rx_packets">
1806 Number of received packets.
1808 <column name="statistics" key="rx_bytes">
1809 Number of received bytes.
1811 <column name="statistics" key="tx_packets">
1812 Number of transmitted packets.
1814 <column name="statistics" key="tx_bytes">
1815 Number of transmitted bytes.
1818 <group title="Statistics: Receive errors">
1819 <column name="statistics" key="rx_dropped">
1820 Number of packets dropped by RX.
1822 <column name="statistics" key="rx_frame_err">
1823 Number of frame alignment errors.
1825 <column name="statistics" key="rx_over_err">
1826 Number of packets with RX overrun.
1828 <column name="statistics" key="rx_crc_err">
1829 Number of CRC errors.
1831 <column name="statistics" key="rx_errors">
1832 Total number of receive errors, greater than or equal to the sum of
1836 <group title="Statistics: Transmit errors">
1837 <column name="statistics" key="tx_dropped">
1838 Number of packets dropped by TX.
1840 <column name="statistics" key="collisions">
1841 Number of collisions.
1843 <column name="statistics" key="tx_errors">
1844 Total number of transmit errors, greater than or equal to the sum of
1850 <group title="Ingress Policing">
1852 These settings control ingress policing for packets received on this
1853 interface. On a physical interface, this limits the rate at which
1854 traffic is allowed into the system from the outside; on a virtual
1855 interface (one connected to a virtual machine), this limits the rate at
1856 which the VM is able to transmit.
1859 Policing is a simple form of quality-of-service that simply drops
1860 packets received in excess of the configured rate. Due to its
1861 simplicity, policing is usually less accurate and less effective than
1862 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1863 table="Queue"/> tables).
1866 Policing is currently implemented only on Linux. The Linux
1867 implementation uses a simple ``token bucket'' approach:
1871 The size of the bucket corresponds to <ref
1872 column="ingress_policing_burst"/>. Initially the bucket is full.
1875 Whenever a packet is received, its size (converted to tokens) is
1876 compared to the number of tokens currently in the bucket. If the
1877 required number of tokens are available, they are removed and the
1878 packet is forwarded. Otherwise, the packet is dropped.
1881 Whenever it is not full, the bucket is refilled with tokens at the
1882 rate specified by <ref column="ingress_policing_rate"/>.
1886 Policing interacts badly with some network protocols, and especially
1887 with fragmented IP packets. Suppose that there is enough network
1888 activity to keep the bucket nearly empty all the time. Then this token
1889 bucket algorithm will forward a single packet every so often, with the
1890 period depending on packet size and on the configured rate. All of the
1891 fragments of an IP packets are normally transmitted back-to-back, as a
1892 group. In such a situation, therefore, only one of these fragments
1893 will be forwarded and the rest will be dropped. IP does not provide
1894 any way for the intended recipient to ask for only the remaining
1895 fragments. In such a case there are two likely possibilities for what
1896 will happen next: either all of the fragments will eventually be
1897 retransmitted (as TCP will do), in which case the same problem will
1898 recur, or the sender will not realize that its packet has been dropped
1899 and data will simply be lost (as some UDP-based protocols will do).
1900 Either way, it is possible that no forward progress will ever occur.
1902 <column name="ingress_policing_rate">
1904 Maximum rate for data received on this interface, in kbps. Data
1905 received faster than this rate is dropped. Set to <code>0</code>
1906 (the default) to disable policing.
1910 <column name="ingress_policing_burst">
1911 <p>Maximum burst size for data received on this interface, in kb. The
1912 default burst size if set to <code>0</code> is 1000 kb. This value
1913 has no effect if <ref column="ingress_policing_rate"/>
1914 is <code>0</code>.</p>
1916 Specifying a larger burst size lets the algorithm be more forgiving,
1917 which is important for protocols like TCP that react severely to
1918 dropped packets. The burst size should be at least the size of the
1919 interface's MTU. Specifying a value that is numerically at least as
1920 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1921 closer to achieving the full rate.
1926 <group title="Bidirectional Forwarding Detection (BFD)">
1928 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
1929 detection of connectivity failures by occasional transmission of
1930 BFD control messages. Open vSwitch implements BFD to serve
1931 as a more popular and standards compliant alternative to CFM.
1935 BFD operates by regularly transmitting BFD control messages at a rate
1936 negotiated independently in each direction. Each endpoint specifies
1937 the rate at which it expects to receive control messages, and the rate
1938 at which it is willing to transmit them. Open vSwitch uses a detection
1939 multiplier of three, meaning that an endpoint signals a connectivity
1940 fault if three consecutive BFD control messages fail to arrive. In the
1941 case of a unidirectional connectivity issue, the system not receiving
1942 BFD control messages signals the problem to its peer in the messages it
1947 The Open vSwitch implementation of BFD aims to comply faithfully
1948 with RFC 5880 requirements. Open vSwitch does not implement the
1949 optional Authentication or ``Echo Mode'' features.
1952 <group title="BFD Configuration">
1954 A controller sets up key-value pairs in the <ref column="bfd"/>
1955 column to enable and configure BFD.
1958 <column name="bfd" key="enable" type='{"type": "boolean"}'>
1959 True to enable BFD on this <ref table="Interface"/>.
1962 <column name="bfd" key="min_rx"
1963 type='{"type": "integer", "minInteger": 1}'>
1964 The shortest interval, in milliseconds, at which this BFD session
1965 offers to receive BFD control messages. The remote endpoint may
1966 choose to send messages at a slower rate. Defaults to
1970 <column name="bfd" key="min_tx"
1971 type='{"type": "integer", "minInteger": 1}'>
1972 The shortest interval, in milliseconds, at which this BFD session is
1973 willing to transmit BFD control messages. Messages will actually be
1974 transmitted at a slower rate if the remote endpoint is not willing to
1975 receive as quickly as specified. Defaults to <code>100</code>.
1978 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
1979 An alternate receive interval, in milliseconds, that must be greater
1980 than or equal to <ref column="bfd" key="min_rx"/>. The
1981 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
1982 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
1983 data traffic at the interface, to reduce the CPU and bandwidth cost
1984 of monitoring an idle interface. This feature may be disabled by
1985 setting a value of 0. This feature is reset whenever <ref
1986 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
1990 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
1991 When <code>true</code>, traffic received on the
1992 <ref table="Interface"/> is used to indicate the capability of packet
1993 I/O. BFD control packets are still transmitted and received. At
1994 least one BFD control packet must be received every 100 * <ref
1995 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
1996 traffic are received, the <ref column="bfd" key="forwarding"/>
1997 will be <code>false</code>.
2000 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2001 Set to true to notify the remote endpoint that traffic should not be
2002 forwarded to this system for some reason other than a connectivty
2003 failure on the interface being monitored. The typical underlying
2004 reason is ``concatenated path down,'' that is, that connectivity
2005 beyond the local system is down. Defaults to false.
2008 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2009 Set to true to make BFD accept only control messages with a tunnel
2010 key of zero. By default, BFD accepts control messages with any
2014 <column name="bfd" key="bfd_dst_mac">
2015 Set to an Ethernet address in the form
2016 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2017 to set the MAC used as destination for transmitted BFD packets and
2018 expected as destination for received BFD packets. The default is
2019 <code>00:23:20:00:00:01</code>.
2022 <column name="bfd" key="bfd_src_ip">
2023 Set to an IPv4 address to set the IP address used as source for
2024 transmitted BFD packets. The default is <code>169.254.1.0</code>.
2027 <column name="bfd" key="bfd_dst_ip">
2028 Set to an IPv4 address to set the IP address used as destination
2029 for transmitted BFD packets. The default is <code>169.254.1.1</code>.
2033 <group title="BFD Status">
2035 The switch sets key-value pairs in the <ref column="bfd_status"/>
2036 column to report the status of BFD on this interface. When BFD is
2037 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2038 all key-value pairs from <ref column="bfd_status"/>.
2041 <column name="bfd_status" key="state"
2042 type='{"type": "string",
2043 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2044 Reports the state of the BFD session. The BFD session is fully
2045 healthy and negotiated if <code>UP</code>.
2048 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2049 Reports whether the BFD session believes this <ref
2050 table="Interface"/> may be used to forward traffic. Typically this
2051 means the local session is signaling <code>UP</code>, and the remote
2052 system isn't signaling a problem such as concatenated path down.
2055 <column name="bfd_status" key="diagnostic">
2056 In case of a problem, set to a short message that reports what the
2057 local BFD session thinks is wrong.
2060 <column name="bfd_status" key="remote_state"
2061 type='{"type": "string",
2062 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2063 Reports the state of the remote endpoint's BFD session.
2066 <column name="bfd_status" key="remote_diagnostic">
2067 In case of a problem, set to a short message that reports what the
2068 remote endpoint's BFD session thinks is wrong.
2071 <column name="bfd_status" key="flap_count"
2072 type='{"type": "integer", "minInteger": 0}'>
2073 Counts the number of <ref column="bfd_status" key="forwarding" />
2074 flaps since start. A flap is considered as a change of the
2075 <ref column="bfd_status" key="forwarding" /> value.
2080 <group title="Connectivity Fault Management">
2082 802.1ag Connectivity Fault Management (CFM) allows a group of
2083 Maintenance Points (MPs) called a Maintenance Association (MA) to
2084 detect connectivity problems with each other. MPs within a MA should
2085 have complete and exclusive interconnectivity. This is verified by
2086 occasionally broadcasting Continuity Check Messages (CCMs) at a
2087 configurable transmission interval.
2091 According to the 802.1ag specification, each Maintenance Point should
2092 be configured out-of-band with a list of Remote Maintenance Points it
2093 should have connectivity to. Open vSwitch differs from the
2094 specification in this area. It simply assumes the link is faulted if
2095 no Remote Maintenance Points are reachable, and considers it not
2100 When operating over tunnels which have no <code>in_key</code>, or an
2101 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2102 with a tunnel key of zero.
2105 <column name="cfm_mpid">
2107 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2108 within a Maintenance Association. The MPID is used to identify this
2109 endpoint to other Maintenance Points in the MA. Each end of a link
2110 being monitored should have a different MPID. Must be configured to
2111 enable CFM on this <ref table="Interface"/>.
2114 According to the 802.1ag specification, MPIDs can only range between
2115 [1, 8191]. However, extended mode (see <ref column="other_config"
2116 key="cfm_extended"/>) supports eight byte MPIDs.
2120 <column name="cfm_flap_count">
2121 Counts the number of cfm fault flapps since boot. A flap is
2122 considered to be a change of the <ref column="cfm_fault"/> value.
2125 <column name="cfm_fault">
2127 Indicates a connectivity fault triggered by an inability to receive
2128 heartbeats from any remote endpoint. When a fault is triggered on
2129 <ref table="Interface"/>s participating in bonds, they will be
2133 Faults can be triggered for several reasons. Most importantly they
2134 are triggered when no CCMs are received for a period of 3.5 times the
2135 transmission interval. Faults are also triggered when any CCMs
2136 indicate that a Remote Maintenance Point is not receiving CCMs but
2137 able to send them. Finally, a fault is triggered if a CCM is
2138 received which indicates unexpected configuration. Notably, this
2139 case arises when a CCM is received which advertises the local MPID.
2143 <column name="cfm_fault_status" key="recv">
2144 Indicates a CFM fault was triggered due to a lack of CCMs received on
2145 the <ref table="Interface"/>.
2148 <column name="cfm_fault_status" key="rdi">
2149 Indicates a CFM fault was triggered due to the reception of a CCM with
2150 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2151 are not receiving CCMs themselves. This typically indicates a
2152 unidirectional connectivity failure.
2155 <column name="cfm_fault_status" key="maid">
2156 Indicates a CFM fault was triggered due to the reception of a CCM with
2157 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2158 with an identification number in addition to the MPID called the MAID.
2159 Open vSwitch only supports receiving CCM broadcasts tagged with the
2160 MAID it uses internally.
2163 <column name="cfm_fault_status" key="loopback">
2164 Indicates a CFM fault was triggered due to the reception of a CCM
2165 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2166 column of this <ref table="Interface"/>. This may indicate a loop in
2170 <column name="cfm_fault_status" key="overflow">
2171 Indicates a CFM fault was triggered because the CFM module received
2172 CCMs from more remote endpoints than it can keep track of.
2175 <column name="cfm_fault_status" key="override">
2176 Indicates a CFM fault was manually triggered by an administrator using
2177 an <code>ovs-appctl</code> command.
2180 <column name="cfm_fault_status" key="interval">
2181 Indicates a CFM fault was triggered due to the reception of a CCM
2182 frame having an invalid interval.
2185 <column name="cfm_remote_opstate">
2186 <p>When in extended mode, indicates the operational state of the
2187 remote endpoint as either <code>up</code> or <code>down</code>. See
2188 <ref column="other_config" key="cfm_opstate"/>.
2192 <column name="cfm_health">
2194 Indicates the health of the interface as a percentage of CCM frames
2195 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2196 The health of an interface is undefined if it is communicating with
2197 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2198 healthy heartbeats are not received at the expected rate, and
2199 gradually improves as healthy heartbeats are received at the desired
2200 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2201 health of the interface is refreshed.
2204 As mentioned above, the faults can be triggered for several reasons.
2205 The link health will deteriorate even if heartbeats are received but
2206 they are reported to be unhealthy. An unhealthy heartbeat in this
2207 context is a heartbeat for which either some fault is set or is out
2208 of sequence. The interface health can be 100 only on receiving
2209 healthy heartbeats at the desired rate.
2213 <column name="cfm_remote_mpids">
2214 When CFM is properly configured, Open vSwitch will occasionally
2215 receive CCM broadcasts. These broadcasts contain the MPID of the
2216 sending Maintenance Point. The list of MPIDs from which this
2217 <ref table="Interface"/> is receiving broadcasts from is regularly
2218 collected and written to this column.
2221 <column name="other_config" key="cfm_interval"
2222 type='{"type": "integer"}'>
2224 The interval, in milliseconds, between transmissions of CFM
2225 heartbeats. Three missed heartbeat receptions indicate a
2230 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2231 60,000, or 600,000 ms are supported. Other values will be rounded
2232 down to the nearest value on the list. Extended mode (see <ref
2233 column="other_config" key="cfm_extended"/>) supports any interval up
2234 to 65,535 ms. In either mode, the default is 1000 ms.
2237 <p>We do not recommend using intervals less than 100 ms.</p>
2240 <column name="other_config" key="cfm_extended"
2241 type='{"type": "boolean"}'>
2242 When <code>true</code>, the CFM module operates in extended mode. This
2243 causes it to use a nonstandard destination address to avoid conflicting
2244 with compliant implementations which may be running concurrently on the
2245 network. Furthermore, extended mode increases the accuracy of the
2246 <code>cfm_interval</code> configuration parameter by breaking wire
2247 compatibility with 802.1ag compliant implementations. And extended
2248 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2251 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2253 When <code>true</code>, and
2254 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2255 module operates in demand mode. When in demand mode, traffic
2256 received on the <ref table="Interface"/> is used to indicate
2257 liveness. CCMs are still transmitted and received. At least one
2258 CCM must be received every 100 * <ref column="other_config"
2259 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2260 are received, the CFM module will raise the connectivity fault.
2264 Demand mode has a couple of caveats:
2267 To ensure that ovs-vswitchd has enough time to pull statistics
2268 from the datapath, the fault detection interval is set to
2269 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2274 To avoid ambiguity, demand mode disables itself when there are
2275 multiple remote maintenance points.
2279 If the <ref table="Interface"/> is heavily congested, CCMs
2280 containing the <ref column="other_config" key="cfm_opstate"/>
2281 status may be dropped causing changes in the operational state to
2282 be delayed. Similarly, if CCMs containing the RDI bit are not
2283 received, unidirectional link failures may not be detected.
2289 <column name="other_config" key="cfm_opstate"
2290 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2291 When <code>down</code>, the CFM module marks all CCMs it generates as
2292 operationally down without triggering a fault. This allows remote
2293 maintenance points to choose not to forward traffic to the
2294 <ref table="Interface"/> on which this CFM module is running.
2295 Currently, in Open vSwitch, the opdown bit of CCMs affects
2296 <ref table="Interface"/>s participating in bonds, and the bundle
2297 OpenFlow action. This setting is ignored when CFM is not in extended
2298 mode. Defaults to <code>up</code>.
2301 <column name="other_config" key="cfm_ccm_vlan"
2302 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2303 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2304 with the given value. May be the string <code>random</code> in which
2305 case each CCM will be tagged with a different randomly generated VLAN.
2308 <column name="other_config" key="cfm_ccm_pcp"
2309 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2310 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2311 with the given PCP value, the VLAN ID of the tag is governed by the
2312 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2313 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2319 <group title="Bonding Configuration">
2320 <column name="other_config" key="lacp-port-id"
2321 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2322 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2323 used in LACP negotiations to identify individual ports
2324 participating in a bond.
2327 <column name="other_config" key="lacp-port-priority"
2328 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2329 The LACP port priority of this <ref table="Interface"/>. In LACP
2330 negotiations <ref table="Interface"/>s with numerically lower
2331 priorities are preferred for aggregation.
2334 <column name="other_config" key="lacp-aggregation-key"
2335 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2336 The LACP aggregation key of this <ref table="Interface"/>. <ref
2337 table="Interface"/>s with different aggregation keys may not be active
2338 within a given <ref table="Port"/> at the same time.
2342 <group title="Virtual Machine Identifiers">
2344 These key-value pairs specifically apply to an interface that
2345 represents a virtual Ethernet interface connected to a virtual
2346 machine. These key-value pairs should not be present for other types
2347 of interfaces. Keys whose names end in <code>-uuid</code> have
2348 values that uniquely identify the entity in question. For a Citrix
2349 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2350 Other hypervisors may use other formats.
2353 <column name="external_ids" key="attached-mac">
2354 The MAC address programmed into the ``virtual hardware'' for this
2355 interface, in the form
2356 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2357 For Citrix XenServer, this is the value of the <code>MAC</code> field
2358 in the VIF record for this interface.
2361 <column name="external_ids" key="iface-id">
2362 A system-unique identifier for the interface. On XenServer, this will
2363 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2366 <column name="external_ids" key="iface-status"
2367 type='{"type": "string",
2368 "enum": ["set", ["active", "inactive"]]}'>
2370 Hypervisors may sometimes have more than one interface associated
2371 with a given <ref column="external_ids" key="iface-id"/>, only one of
2372 which is actually in use at a given time. For example, in some
2373 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2374 for a single <ref column="external_ids" key="iface-id"/>, but only
2375 uses one of them at a time. A hypervisor that behaves this way must
2376 mark the currently in use interface <code>active</code> and the
2377 others <code>inactive</code>. A hypervisor that never has more than
2378 one interface for a given <ref column="external_ids" key="iface-id"/>
2379 may mark that interface <code>active</code> or omit <ref
2380 column="external_ids" key="iface-status"/> entirely.
2384 During VM migration, a given <ref column="external_ids"
2385 key="iface-id"/> might transiently be marked <code>active</code> on
2386 two different hypervisors. That is, <code>active</code> means that
2387 this <ref column="external_ids" key="iface-id"/> is the active
2388 instance within a single hypervisor, not in a broader scope.
2389 There is one exception: some hypervisors support ``migration'' from a
2390 given hypervisor to itself (most often for test purposes). During
2391 such a ``migration,'' two instances of a single <ref
2392 column="external_ids" key="iface-id"/> might both be briefly marked
2393 <code>active</code> on a single hypervisor.
2397 <column name="external_ids" key="xs-vif-uuid">
2398 The virtual interface associated with this interface.
2401 <column name="external_ids" key="xs-network-uuid">
2402 The virtual network to which this interface is attached.
2405 <column name="external_ids" key="vm-id">
2406 The VM to which this interface belongs. On XenServer, this will be the
2407 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2410 <column name="external_ids" key="xs-vm-uuid">
2411 The VM to which this interface belongs.
2415 <group title="VLAN Splinters">
2417 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2418 with buggy network drivers in old versions of Linux that do not
2419 properly support VLANs when VLAN devices are not used, at some cost
2420 in memory and performance.
2424 When VLAN splinters are enabled on a particular interface, Open vSwitch
2425 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2426 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2427 received on the VLAN device is treated as if it had been received on
2428 the interface on the particular VLAN.
2432 VLAN splinters consider a VLAN to be in use if:
2437 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2438 table="Port"/> record.
2442 The VLAN is listed within the <ref table="Port" column="trunks"/>
2443 column of the <ref table="Port"/> record of an interface on which
2444 VLAN splinters are enabled.
2446 An empty <ref table="Port" column="trunks"/> does not influence the
2447 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2448 will exceed the current 1,024 port per datapath limit.
2452 An OpenFlow flow within any bridge matches the VLAN.
2457 The same set of in-use VLANs applies to every interface on which VLAN
2458 splinters are enabled. That is, the set is not chosen separately for
2459 each interface but selected once as the union of all in-use VLANs based
2464 It does not make sense to enable VLAN splinters on an interface for an
2465 access port, or on an interface that is not a physical port.
2469 VLAN splinters are deprecated. When broken device drivers are no
2470 longer in widespread use, we will delete this feature.
2473 <column name="other_config" key="enable-vlan-splinters"
2474 type='{"type": "boolean"}'>
2476 Set to <code>true</code> to enable VLAN splinters on this interface.
2477 Defaults to <code>false</code>.
2481 VLAN splinters increase kernel and userspace memory overhead, so do
2482 not use them unless they are needed.
2486 VLAN splinters do not support 802.1p priority tags. Received
2487 priorities will appear to be 0, regardless of their actual values,
2488 and priorities on transmitted packets will also be cleared to 0.
2493 <group title="Common Columns">
2494 The overall purpose of these columns is described under <code>Common
2495 Columns</code> at the beginning of this document.
2497 <column name="other_config"/>
2498 <column name="external_ids"/>
2502 <table name="Flow_Table" title="OpenFlow table configuration">
2503 <p>Configuration for a particular OpenFlow table.</p>
2505 <column name="name">
2506 The table's name. Set this column to change the name that controllers
2507 will receive when they request table statistics, e.g. <code>ovs-ofctl
2508 dump-tables</code>. The name does not affect switch behavior.
2511 <column name="flow_limit">
2512 If set, limits the number of flows that may be added to the table. Open
2513 vSwitch may limit the number of flows in a table for other reasons,
2514 e.g. due to hardware limitations or for resource availability or
2515 performance reasons.
2518 <column name="overflow_policy">
2520 Controls the switch's behavior when an OpenFlow flow table modification
2521 request would add flows in excess of <ref column="flow_limit"/>. The
2522 supported values are:
2526 <dt><code>refuse</code></dt>
2528 Refuse to add the flow or flows. This is also the default policy
2529 when <ref column="overflow_policy"/> is unset.
2532 <dt><code>evict</code></dt>
2534 Delete the flow that will expire soonest. See <ref column="groups"/>
2540 <column name="groups">
2542 When <ref column="overflow_policy"/> is <code>evict</code>, this
2543 controls how flows are chosen for eviction when the flow table would
2544 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2545 of NXM fields or sub-fields, each of which takes one of the forms
2546 <code><var>field</var>[]</code> or
2547 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2548 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2549 <code>nicira-ext.h</code> for a complete list of NXM field names.
2553 When a flow must be evicted due to overflow, the flow to evict is
2554 chosen through an approximation of the following algorithm:
2559 Divide the flows in the table into groups based on the values of the
2560 specified fields or subfields, so that all of the flows in a given
2561 group have the same values for those fields. If a flow does not
2562 specify a given field, that field's value is treated as 0.
2566 Consider the flows in the largest group, that is, the group that
2567 contains the greatest number of flows. If two or more groups all
2568 have the same largest number of flows, consider the flows in all of
2573 Among the flows under consideration, choose the flow that expires
2574 soonest for eviction.
2579 The eviction process only considers flows that have an idle timeout or
2580 a hard timeout. That is, eviction never deletes permanent flows.
2581 (Permanent flows do count against <ref column="flow_limit"/>.)
2585 Open vSwitch ignores any invalid or unknown field specifications.
2589 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2590 column has no effect.
2594 <column name="prefixes">
2596 This string set specifies which fields should be used for
2597 address prefix tracking. Prefix tracking allows the
2598 classifier to skip rules with longer than necessary prefixes,
2599 resulting in better wildcarding for datapath flows.
2602 Prefix tracking may be beneficial when a flow table contains
2603 matches on IP address fields with different prefix lengths.
2604 For example, when a flow table contains IP address matches on
2605 both full addresses and proper prefixes, the full address
2606 matches will typically cause the datapath flow to un-wildcard
2607 the whole address field (depending on flow entry priorities).
2608 In this case each packet with a different address gets handed
2609 to the userspace for flow processing and generates its own
2610 datapath flow. With prefix tracking enabled for the address
2611 field in question packets with addresses matching shorter
2612 prefixes would generate datapath flows where the irrelevant
2613 address bits are wildcarded, allowing the same datapath flow
2614 to handle all the packets within the prefix in question. In
2615 this case many userspace upcalls can be avoided and the
2616 overall performance can be better.
2619 This is a performance optimization only, so packets will
2620 receive the same treatment with or without prefix tracking.
2623 The supported fields are: <code>tun_id</code>,
2624 <code>tun_src</code>, <code>tun_dst</code>,
2625 <code>nw_src</code>, <code>nw_dst</code> (or aliases
2626 <code>ip_src</code> and <code>ip_dst</code>),
2627 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
2628 feature for <code>tun_id</code> would only make sense if the
2629 tunnel IDs have prefix structure similar to IP addresses.)
2632 For example, <code>prefixes=ip_dst,ip_src</code> instructs the
2633 flow classifier to track the IP destination and source
2634 addresses used by the rules in this specific flow table. To
2635 set the prefix fields, the flow table record needs to exist:
2638 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
2640 Creates a flow table record for the OpenFlow table number 0.
2643 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
2645 Enables prefix tracking for IP source and destination
2651 There is a maximum number of fields that can be enabled for any
2652 one flow table. Currently this limit is 3.
2656 <group title="Common Columns">
2657 The overall purpose of these columns is described under <code>Common
2658 Columns</code> at the beginning of this document.
2660 <column name="external_ids"/>
2664 <table name="QoS" title="Quality of Service configuration">
2665 <p>Quality of Service (QoS) configuration for each Port that
2668 <column name="type">
2669 <p>The type of QoS to implement. The currently defined types are
2672 <dt><code>linux-htb</code></dt>
2674 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2675 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2676 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2677 for information on how this classifier works and how to configure it.
2681 <dt><code>linux-hfsc</code></dt>
2683 Linux "Hierarchical Fair Service Curve" classifier.
2684 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2685 information on how this classifier works.
2690 <column name="queues">
2691 <p>A map from queue numbers to <ref table="Queue"/> records. The
2692 supported range of queue numbers depend on <ref column="type"/>. The
2693 queue numbers are the same as the <code>queue_id</code> used in
2694 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2698 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2699 actions when no specific queue has been set. When no configuration for
2700 queue 0 is present, it is automatically configured as if a <ref
2701 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2702 and <ref table="Queue" column="other_config"/> columns had been
2704 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2705 this case. With some queuing disciplines, this dropped all packets
2706 destined for the default queue.)
2710 <group title="Configuration for linux-htb and linux-hfsc">
2712 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2713 the following key-value pair:
2716 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2717 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2718 specified, for physical interfaces, the default is the link rate. For
2719 other interfaces or if the link rate cannot be determined, the default
2720 is currently 100 Mbps.
2724 <group title="Common Columns">
2725 The overall purpose of these columns is described under <code>Common
2726 Columns</code> at the beginning of this document.
2728 <column name="other_config"/>
2729 <column name="external_ids"/>
2733 <table name="Queue" title="QoS output queue.">
2734 <p>A configuration for a port output queue, used in configuring Quality of
2735 Service (QoS) features. May be referenced by <ref column="queues"
2736 table="QoS"/> column in <ref table="QoS"/> table.</p>
2738 <column name="dscp">
2739 If set, Open vSwitch will mark all traffic egressing this
2740 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2741 default <ref table="Queue"/> is only marked if it was explicitly selected
2742 as the <ref table="Queue"/> at the time the packet was output. If unset,
2743 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2747 <group title="Configuration for linux-htb QoS">
2749 <ref table="QoS"/> <ref table="QoS" column="type"/>
2750 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2751 It has the following key-value pairs defined.
2754 <column name="other_config" key="min-rate"
2755 type='{"type": "integer", "minInteger": 1}'>
2756 Minimum guaranteed bandwidth, in bit/s.
2759 <column name="other_config" key="max-rate"
2760 type='{"type": "integer", "minInteger": 1}'>
2761 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2762 queue's rate will not be allowed to exceed the specified value, even
2763 if excess bandwidth is available. If unspecified, defaults to no
2767 <column name="other_config" key="burst"
2768 type='{"type": "integer", "minInteger": 1}'>
2769 Burst size, in bits. This is the maximum amount of ``credits'' that a
2770 queue can accumulate while it is idle. Optional. Details of the
2771 <code>linux-htb</code> implementation require a minimum burst size, so
2772 a too-small <code>burst</code> will be silently ignored.
2775 <column name="other_config" key="priority"
2776 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2777 A queue with a smaller <code>priority</code> will receive all the
2778 excess bandwidth that it can use before a queue with a larger value
2779 receives any. Specific priority values are unimportant; only relative
2780 ordering matters. Defaults to 0 if unspecified.
2784 <group title="Configuration for linux-hfsc QoS">
2786 <ref table="QoS"/> <ref table="QoS" column="type"/>
2787 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2788 It has the following key-value pairs defined.
2791 <column name="other_config" key="min-rate"
2792 type='{"type": "integer", "minInteger": 1}'>
2793 Minimum guaranteed bandwidth, in bit/s.
2796 <column name="other_config" key="max-rate"
2797 type='{"type": "integer", "minInteger": 1}'>
2798 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2799 queue's rate will not be allowed to exceed the specified value, even if
2800 excess bandwidth is available. If unspecified, defaults to no
2805 <group title="Common Columns">
2806 The overall purpose of these columns is described under <code>Common
2807 Columns</code> at the beginning of this document.
2809 <column name="other_config"/>
2810 <column name="external_ids"/>
2814 <table name="Mirror" title="Port mirroring.">
2815 <p>A port mirror within a <ref table="Bridge"/>.</p>
2816 <p>A port mirror configures a bridge to send selected frames to special
2817 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2818 traffic may also be referred to as SPAN or RSPAN, depending on how
2819 the mirrored traffic is sent.</p>
2821 <column name="name">
2822 Arbitrary identifier for the <ref table="Mirror"/>.
2825 <group title="Selecting Packets for Mirroring">
2827 To be selected for mirroring, a given packet must enter or leave the
2828 bridge through a selected port and it must also be in one of the
2832 <column name="select_all">
2833 If true, every packet arriving or departing on any port is
2834 selected for mirroring.
2837 <column name="select_dst_port">
2838 Ports on which departing packets are selected for mirroring.
2841 <column name="select_src_port">
2842 Ports on which arriving packets are selected for mirroring.
2845 <column name="select_vlan">
2846 VLANs on which packets are selected for mirroring. An empty set
2847 selects packets on all VLANs.
2851 <group title="Mirroring Destination Configuration">
2853 These columns are mutually exclusive. Exactly one of them must be
2857 <column name="output_port">
2858 <p>Output port for selected packets, if nonempty.</p>
2859 <p>Specifying a port for mirror output reserves that port exclusively
2860 for mirroring. No frames other than those selected for mirroring
2862 will be forwarded to the port, and any frames received on the port
2863 will be discarded.</p>
2865 The output port may be any kind of port supported by Open vSwitch.
2866 It may be, for example, a physical port (sometimes called SPAN) or a
2871 <column name="output_vlan">
2872 <p>Output VLAN for selected packets, if nonempty.</p>
2873 <p>The frames will be sent out all ports that trunk
2874 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2875 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2876 trunk port, the frame's VLAN tag will be set to
2877 <ref column="output_vlan"/>, replacing any existing tag; when it is
2878 sent out an implicit VLAN port, the frame will not be tagged. This
2879 type of mirroring is sometimes called RSPAN.</p>
2881 See the documentation for
2882 <ref column="other_config" key="forward-bpdu"/> in the
2883 <ref table="Interface"/> table for a list of destination MAC
2884 addresses which will not be mirrored to a VLAN to avoid confusing
2885 switches that interpret the protocols that they represent.
2887 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2888 contains unmanaged switches. Consider an unmanaged physical switch
2889 with two ports: port 1, connected to an end host, and port 2,
2890 connected to an Open vSwitch configured to mirror received packets
2891 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2892 port 1 that the physical switch forwards to port 2. The Open vSwitch
2893 forwards this packet to its destination and then reflects it back on
2894 port 2 in VLAN 123. This reflected packet causes the unmanaged
2895 physical switch to replace the MAC learning table entry, which
2896 correctly pointed to port 1, with one that incorrectly points to port
2897 2. Afterward, the physical switch will direct packets destined for
2898 the end host to the Open vSwitch on port 2, instead of to the end
2899 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2900 desired in this scenario, then the physical switch must be replaced
2901 by one that learns Ethernet addresses on a per-VLAN basis. In
2902 addition, learning should be disabled on the VLAN containing mirrored
2903 traffic. If this is not done then intermediate switches will learn
2904 the MAC address of each end host from the mirrored traffic. If
2905 packets being sent to that end host are also mirrored, then they will
2906 be dropped since the switch will attempt to send them out the input
2907 port. Disabling learning for the VLAN will cause the switch to
2908 correctly send the packet out all ports configured for that VLAN. If
2909 Open vSwitch is being used as an intermediate switch, learning can be
2910 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2911 in the appropriate <ref table="Bridge"/> table or tables.</p>
2913 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2914 VLAN and should generally be preferred.
2919 <group title="Statistics: Mirror counters">
2921 Key-value pairs that report mirror statistics. The update period
2922 is controlled by <ref column="other_config"
2923 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2925 <column name="statistics" key="tx_packets">
2926 Number of packets transmitted through this mirror.
2928 <column name="statistics" key="tx_bytes">
2929 Number of bytes transmitted through this mirror.
2933 <group title="Common Columns">
2934 The overall purpose of these columns is described under <code>Common
2935 Columns</code> at the beginning of this document.
2937 <column name="external_ids"/>
2941 <table name="Controller" title="OpenFlow controller configuration.">
2942 <p>An OpenFlow controller.</p>
2945 Open vSwitch supports two kinds of OpenFlow controllers:
2949 <dt>Primary controllers</dt>
2952 This is the kind of controller envisioned by the OpenFlow 1.0
2953 specification. Usually, a primary controller implements a network
2954 policy by taking charge of the switch's flow table.
2958 Open vSwitch initiates and maintains persistent connections to
2959 primary controllers, retrying the connection each time it fails or
2960 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2961 <ref table="Bridge"/> table applies to primary controllers.
2965 Open vSwitch permits a bridge to have any number of primary
2966 controllers. When multiple controllers are configured, Open
2967 vSwitch connects to all of them simultaneously. Because
2968 OpenFlow 1.0 does not specify how multiple controllers
2969 coordinate in interacting with a single switch, more than
2970 one primary controller should be specified only if the
2971 controllers are themselves designed to coordinate with each
2972 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2973 vendor extension may be useful for this.)
2976 <dt>Service controllers</dt>
2979 These kinds of OpenFlow controller connections are intended for
2980 occasional support and maintenance use, e.g. with
2981 <code>ovs-ofctl</code>. Usually a service controller connects only
2982 briefly to inspect or modify some of a switch's state.
2986 Open vSwitch listens for incoming connections from service
2987 controllers. The service controllers initiate and, if necessary,
2988 maintain the connections from their end. The <ref table="Bridge"
2989 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2990 not apply to service controllers.
2994 Open vSwitch supports configuring any number of service controllers.
3000 The <ref column="target"/> determines the type of controller.
3003 <group title="Core Features">
3004 <column name="target">
3005 <p>Connection method for controller.</p>
3007 The following connection methods are currently supported for primary
3011 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3013 <p>The specified SSL <var>port</var> on the host at the
3014 given <var>ip</var>, which must be expressed as an IP
3015 address (not a DNS name). The <ref table="Open_vSwitch"
3016 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3017 table must point to a valid SSL configuration when this form
3019 <p>If <var>port</var> is not specified, it currently
3020 defaults to 6633. In the future, the default will change to
3021 6653, which is the IANA-defined value.</p>
3022 <p>SSL support is an optional feature that is not always built as
3023 part of Open vSwitch.</p>
3025 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3028 The specified TCP <var>port</var> on the host at the given
3029 <var>ip</var>, which must be expressed as an IP address (not a
3030 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3031 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3032 e.g. <code>tcp:[::1]:6632</code>.
3035 If <var>port</var> is not specified, it currently defaults to
3036 6633. In the future, the default will change to 6653, which is
3037 the IANA-defined value.
3042 The following connection methods are currently supported for service
3046 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3049 Listens for SSL connections on the specified TCP <var>port</var>.
3050 If <var>ip</var>, which must be expressed as an IP address (not a
3051 DNS name), is specified, then connections are restricted to the
3052 specified local IP address (either IPv4 or IPv6). If
3053 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3054 e.g. <code>pssl:6632:[::1]</code>.
3057 If <var>port</var> is not specified, it currently defaults to
3058 6633. If <var>ip</var> is not specified then it listens only on
3059 IPv4 (but not IPv6) addresses. The
3060 <ref table="Open_vSwitch" column="ssl"/>
3061 column in the <ref table="Open_vSwitch"/> table must point to a
3062 valid SSL configuration when this form is used.
3065 If <var>port</var> is not specified, it currently defaults to
3066 6633. In the future, the default will change to 6653, which is
3067 the IANA-defined value.
3070 SSL support is an optional feature that is not always built as
3071 part of Open vSwitch.
3074 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3077 Listens for connections on the specified TCP <var>port</var>. If
3078 <var>ip</var>, which must be expressed as an IP address (not a
3079 DNS name), is specified, then connections are restricted to the
3080 specified local IP address (either IPv4 or IPv6). If
3081 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3082 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3083 specified then it listens only on IPv4 addresses.
3086 If <var>port</var> is not specified, it currently defaults to
3087 6633. In the future, the default will change to 6653, which is
3088 the IANA-defined value.
3092 <p>When multiple controllers are configured for a single bridge, the
3093 <ref column="target"/> values must be unique. Duplicate
3094 <ref column="target"/> values yield unspecified results.</p>
3097 <column name="connection_mode">
3098 <p>If it is specified, this setting must be one of the following
3099 strings that describes how Open vSwitch contacts this OpenFlow
3100 controller over the network:</p>
3103 <dt><code>in-band</code></dt>
3104 <dd>In this mode, this controller's OpenFlow traffic travels over the
3105 bridge associated with the controller. With this setting, Open
3106 vSwitch allows traffic to and from the controller regardless of the
3107 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3108 would never be able to connect to the controller, because it did
3109 not have a flow to enable it.) This is the most common connection
3110 mode because it is not necessary to maintain two independent
3112 <dt><code>out-of-band</code></dt>
3113 <dd>In this mode, OpenFlow traffic uses a control network separate
3114 from the bridge associated with this controller, that is, the
3115 bridge does not use any of its own network devices to communicate
3116 with the controller. The control network must be configured
3117 separately, before or after <code>ovs-vswitchd</code> is started.
3121 <p>If not specified, the default is implementation-specific.</p>
3125 <group title="Controller Failure Detection and Handling">
3126 <column name="max_backoff">
3127 Maximum number of milliseconds to wait between connection attempts.
3128 Default is implementation-specific.
3131 <column name="inactivity_probe">
3132 Maximum number of milliseconds of idle time on connection to
3133 controller before sending an inactivity probe message. If Open
3134 vSwitch does not communicate with the controller for the specified
3135 number of seconds, it will send a probe. If a response is not
3136 received for the same additional amount of time, Open vSwitch
3137 assumes the connection has been broken and attempts to reconnect.
3138 Default is implementation-specific. A value of 0 disables
3143 <group title="Asynchronous Message Configuration">
3145 OpenFlow switches send certain messages to controllers spontanenously,
3146 that is, not in response to any request from the controller. These
3147 messages are called ``asynchronous messages.'' These columns allow
3148 asynchronous messages to be limited or disabled to ensure the best use
3149 of network resources.
3152 <column name="enable_async_messages">
3153 The OpenFlow protocol enables asynchronous messages at time of
3154 connection establishment, which means that a controller can receive
3155 asynchronous messages, potentially many of them, even if it turns them
3156 off immediately after connecting. Set this column to
3157 <code>false</code> to change Open vSwitch behavior to disable, by
3158 default, all asynchronous messages. The controller can use the
3159 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3160 on any messages that it does want to receive, if any.
3163 <column name="controller_rate_limit">
3165 The maximum rate at which the switch will forward packets to the
3166 OpenFlow controller, in packets per second. This feature prevents a
3167 single bridge from overwhelming the controller. If not specified,
3168 the default is implementation-specific.
3172 In addition, when a high rate triggers rate-limiting, Open vSwitch
3173 queues controller packets for each port and transmits them to the
3174 controller at the configured rate. The <ref
3175 column="controller_burst_limit"/> value limits the number of queued
3176 packets. Ports on a bridge share the packet queue fairly.
3180 Open vSwitch maintains two such packet rate-limiters per bridge: one
3181 for packets sent up to the controller because they do not correspond
3182 to any flow, and the other for packets sent up to the controller by
3183 request through flow actions. When both rate-limiters are filled with
3184 packets, the actual rate that packets are sent to the controller is
3185 up to twice the specified rate.
3189 <column name="controller_burst_limit">
3190 In conjunction with <ref column="controller_rate_limit"/>,
3191 the maximum number of unused packet credits that the bridge will
3192 allow to accumulate, in packets. If not specified, the default
3193 is implementation-specific.
3197 <group title="Additional In-Band Configuration">
3198 <p>These values are considered only in in-band control mode (see
3199 <ref column="connection_mode"/>).</p>
3201 <p>When multiple controllers are configured on a single bridge, there
3202 should be only one set of unique values in these columns. If different
3203 values are set for these columns in different controllers, the effect
3206 <column name="local_ip">
3207 The IP address to configure on the local port,
3208 e.g. <code>192.168.0.123</code>. If this value is unset, then
3209 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3213 <column name="local_netmask">
3214 The IP netmask to configure on the local port,
3215 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3216 but this value is unset, then the default is chosen based on whether
3217 the IP address is class A, B, or C.
3220 <column name="local_gateway">
3221 The IP address of the gateway to configure on the local port, as a
3222 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3223 this network has no gateway.
3227 <group title="Controller Status">
3228 <column name="is_connected">
3229 <code>true</code> if currently connected to this controller,
3230 <code>false</code> otherwise.
3234 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3235 <p>The level of authority this controller has on the associated
3236 bridge. Possible values are:</p>
3238 <dt><code>other</code></dt>
3239 <dd>Allows the controller access to all OpenFlow features.</dd>
3240 <dt><code>master</code></dt>
3241 <dd>Equivalent to <code>other</code>, except that there may be at
3242 most one master controller at a time. When a controller configures
3243 itself as <code>master</code>, any existing master is demoted to
3244 the <code>slave</code>role.</dd>
3245 <dt><code>slave</code></dt>
3246 <dd>Allows the controller read-only access to OpenFlow features.
3247 Attempts to modify the flow table will be rejected with an
3248 error. Slave controllers do not receive OFPT_PACKET_IN or
3249 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3254 <column name="status" key="last_error">
3255 A human-readable description of the last error on the connection
3256 to the controller; i.e. <code>strerror(errno)</code>. This key
3257 will exist only if an error has occurred.
3260 <column name="status" key="state"
3261 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3263 The state of the connection to the controller:
3266 <dt><code>VOID</code></dt>
3267 <dd>Connection is disabled.</dd>
3269 <dt><code>BACKOFF</code></dt>
3270 <dd>Attempting to reconnect at an increasing period.</dd>
3272 <dt><code>CONNECTING</code></dt>
3273 <dd>Attempting to connect.</dd>
3275 <dt><code>ACTIVE</code></dt>
3276 <dd>Connected, remote host responsive.</dd>
3278 <dt><code>IDLE</code></dt>
3279 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3282 These values may change in the future. They are provided only for
3287 <column name="status" key="sec_since_connect"
3288 type='{"type": "integer", "minInteger": 0}'>
3289 The amount of time since this controller last successfully connected to
3290 the switch (in seconds). Value is empty if controller has never
3291 successfully connected.
3294 <column name="status" key="sec_since_disconnect"
3295 type='{"type": "integer", "minInteger": 1}'>
3296 The amount of time since this controller last disconnected from
3297 the switch (in seconds). Value is empty if controller has never
3302 <group title="Connection Parameters">
3304 Additional configuration for a connection between the controller
3305 and the Open vSwitch.
3308 <column name="other_config" key="dscp"
3309 type='{"type": "integer"}'>
3310 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3311 in the Type of Service (TOS) field in the IP header. DSCP provides a
3312 mechanism to classify the network traffic and provide Quality of
3313 Service (QoS) on IP networks.
3315 The DSCP value specified here is used when establishing the connection
3316 between the controller and the Open vSwitch. If no value is specified,
3317 a default value of 48 is chosen. Valid DSCP values must be in the
3323 <group title="Common Columns">
3324 The overall purpose of these columns is described under <code>Common
3325 Columns</code> at the beginning of this document.
3327 <column name="external_ids"/>
3328 <column name="other_config"/>
3332 <table name="Manager" title="OVSDB management connection.">
3334 Configuration for a database connection to an Open vSwitch database
3339 This table primarily configures the Open vSwitch database
3340 (<code>ovsdb-server</code>), not the Open vSwitch switch
3341 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3342 what connections should be treated as in-band.
3346 The Open vSwitch database server can initiate and maintain active
3347 connections to remote clients. It can also listen for database
3351 <group title="Core Features">
3352 <column name="target">
3353 <p>Connection method for managers.</p>
3355 The following connection methods are currently supported:
3358 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3361 The specified SSL <var>port</var> on the host at the given
3362 <var>ip</var>, which must be expressed as an IP address
3363 (not a DNS name). The <ref table="Open_vSwitch"
3364 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3365 table must point to a valid SSL configuration when this
3369 If <var>port</var> is not specified, it currently defaults
3370 to 6632. In the future, the default will change to 6640,
3371 which is the IANA-defined value.
3374 SSL support is an optional feature that is not always
3375 built as part of Open vSwitch.
3379 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3382 The specified TCP <var>port</var> on the host at the given
3383 <var>ip</var>, which must be expressed as an IP address (not a
3384 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3385 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3386 e.g. <code>tcp:[::1]:6632</code>.
3389 If <var>port</var> is not specified, it currently defaults
3390 to 6632. In the future, the default will change to 6640,
3391 which is the IANA-defined value.
3394 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3397 Listens for SSL connections on the specified TCP <var>port</var>.
3398 Specify 0 for <var>port</var> to have the kernel automatically
3399 choose an available port. If <var>ip</var>, which must be
3400 expressed as an IP address (not a DNS name), is specified, then
3401 connections are restricted to the specified local IP address
3402 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3403 address, wrap in square brackets,
3404 e.g. <code>pssl:6632:[::1]</code>. If <var>ip</var> is not
3405 specified then it listens only on IPv4 (but not IPv6) addresses.
3406 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3407 table="Open_vSwitch"/> table must point to a valid SSL
3408 configuration when this form is used.
3411 If <var>port</var> is not specified, it currently defaults
3412 to 6632. In the future, the default will change to 6640,
3413 which is the IANA-defined value.
3416 SSL support is an optional feature that is not always built as
3417 part of Open vSwitch.
3420 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3423 Listens for connections on the specified TCP <var>port</var>.
3424 Specify 0 for <var>port</var> to have the kernel automatically
3425 choose an available port. If <var>ip</var>, which must be
3426 expressed as an IP address (not a DNS name), is specified, then
3427 connections are restricted to the specified local IP address
3428 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3429 address, wrap it in square brackets,
3430 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3431 specified then it listens only on IPv4 addresses.
3434 If <var>port</var> is not specified, it currently defaults
3435 to 6632. In the future, the default will change to 6640,
3436 which is the IANA-defined value.
3440 <p>When multiple managers are configured, the <ref column="target"/>
3441 values must be unique. Duplicate <ref column="target"/> values yield
3442 unspecified results.</p>
3445 <column name="connection_mode">
3447 If it is specified, this setting must be one of the following strings
3448 that describes how Open vSwitch contacts this OVSDB client over the
3453 <dt><code>in-band</code></dt>
3455 In this mode, this connection's traffic travels over a bridge
3456 managed by Open vSwitch. With this setting, Open vSwitch allows
3457 traffic to and from the client regardless of the contents of the
3458 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3459 to connect to the client, because it did not have a flow to enable
3460 it.) This is the most common connection mode because it is not
3461 necessary to maintain two independent networks.
3463 <dt><code>out-of-band</code></dt>
3465 In this mode, the client's traffic uses a control network separate
3466 from that managed by Open vSwitch, that is, Open vSwitch does not
3467 use any of its own network devices to communicate with the client.
3468 The control network must be configured separately, before or after
3469 <code>ovs-vswitchd</code> is started.
3474 If not specified, the default is implementation-specific.
3479 <group title="Client Failure Detection and Handling">
3480 <column name="max_backoff">
3481 Maximum number of milliseconds to wait between connection attempts.
3482 Default is implementation-specific.
3485 <column name="inactivity_probe">
3486 Maximum number of milliseconds of idle time on connection to the client
3487 before sending an inactivity probe message. If Open vSwitch does not
3488 communicate with the client for the specified number of seconds, it
3489 will send a probe. If a response is not received for the same
3490 additional amount of time, Open vSwitch assumes the connection has been
3491 broken and attempts to reconnect. Default is implementation-specific.
3492 A value of 0 disables inactivity probes.
3496 <group title="Status">
3497 <column name="is_connected">
3498 <code>true</code> if currently connected to this manager,
3499 <code>false</code> otherwise.
3502 <column name="status" key="last_error">
3503 A human-readable description of the last error on the connection
3504 to the manager; i.e. <code>strerror(errno)</code>. This key
3505 will exist only if an error has occurred.
3508 <column name="status" key="state"
3509 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3511 The state of the connection to the manager:
3514 <dt><code>VOID</code></dt>
3515 <dd>Connection is disabled.</dd>
3517 <dt><code>BACKOFF</code></dt>
3518 <dd>Attempting to reconnect at an increasing period.</dd>
3520 <dt><code>CONNECTING</code></dt>
3521 <dd>Attempting to connect.</dd>
3523 <dt><code>ACTIVE</code></dt>
3524 <dd>Connected, remote host responsive.</dd>
3526 <dt><code>IDLE</code></dt>
3527 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3530 These values may change in the future. They are provided only for
3535 <column name="status" key="sec_since_connect"
3536 type='{"type": "integer", "minInteger": 0}'>
3537 The amount of time since this manager last successfully connected
3538 to the database (in seconds). Value is empty if manager has never
3539 successfully connected.
3542 <column name="status" key="sec_since_disconnect"
3543 type='{"type": "integer", "minInteger": 0}'>
3544 The amount of time since this manager last disconnected from the
3545 database (in seconds). Value is empty if manager has never
3549 <column name="status" key="locks_held">
3550 Space-separated list of the names of OVSDB locks that the connection
3551 holds. Omitted if the connection does not hold any locks.
3554 <column name="status" key="locks_waiting">
3555 Space-separated list of the names of OVSDB locks that the connection is
3556 currently waiting to acquire. Omitted if the connection is not waiting
3560 <column name="status" key="locks_lost">
3561 Space-separated list of the names of OVSDB locks that the connection
3562 has had stolen by another OVSDB client. Omitted if no locks have been
3563 stolen from this connection.
3566 <column name="status" key="n_connections"
3567 type='{"type": "integer", "minInteger": 2}'>
3569 When <ref column="target"/> specifies a connection method that
3570 listens for inbound connections (e.g. <code>ptcp:</code> or
3571 <code>pssl:</code>) and more than one connection is actually active,
3572 the value is the number of active connections. Otherwise, this
3573 key-value pair is omitted.
3576 When multiple connections are active, status columns and key-value
3577 pairs (other than this one) report the status of one arbitrarily
3582 <column name="status" key="bound_port" type='{"type": "integer"}'>
3583 When <ref column="target"/> is <code>ptcp:</code> or
3584 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3585 listening. (This is is particularly useful when <ref
3586 column="target"/> specifies a port of 0, allowing the kernel to
3587 choose any available port.)
3591 <group title="Connection Parameters">
3593 Additional configuration for a connection between the manager
3594 and the Open vSwitch Database.
3597 <column name="other_config" key="dscp"
3598 type='{"type": "integer"}'>
3599 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3600 in the Type of Service (TOS) field in the IP header. DSCP provides a
3601 mechanism to classify the network traffic and provide Quality of
3602 Service (QoS) on IP networks.
3604 The DSCP value specified here is used when establishing the connection
3605 between the manager and the Open vSwitch. If no value is specified, a
3606 default value of 48 is chosen. Valid DSCP values must be in the range
3611 <group title="Common Columns">
3612 The overall purpose of these columns is described under <code>Common
3613 Columns</code> at the beginning of this document.
3615 <column name="external_ids"/>
3616 <column name="other_config"/>
3620 <table name="NetFlow">
3621 A NetFlow target. NetFlow is a protocol that exports a number of
3622 details about terminating IP flows, such as the principals involved
3625 <column name="targets">
3626 NetFlow targets in the form
3627 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3628 must be specified numerically, not as a DNS name.
3631 <column name="engine_id">
3632 Engine ID to use in NetFlow messages. Defaults to datapath index
3636 <column name="engine_type">
3637 Engine type to use in NetFlow messages. Defaults to datapath
3638 index if not specified.
3641 <column name="active_timeout">
3642 The interval at which NetFlow records are sent for flows that are
3643 still active, in seconds. A value of <code>0</code> requests the
3644 default timeout (currently 600 seconds); a value of <code>-1</code>
3645 disables active timeouts.
3648 <column name="add_id_to_interface">
3649 <p>If this column's value is <code>false</code>, the ingress and egress
3650 interface fields of NetFlow flow records are derived from OpenFlow port
3651 numbers. When it is <code>true</code>, the 7 most significant bits of
3652 these fields will be replaced by the least significant 7 bits of the
3653 engine id. This is useful because many NetFlow collectors do not
3654 expect multiple switches to be sending messages from the same host, so
3655 they do not store the engine information which could be used to
3656 disambiguate the traffic.</p>
3657 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3660 <group title="Common Columns">
3661 The overall purpose of these columns is described under <code>Common
3662 Columns</code> at the beginning of this document.
3664 <column name="external_ids"/>
3669 SSL configuration for an Open_vSwitch.
3671 <column name="private_key">
3672 Name of a PEM file containing the private key used as the switch's
3673 identity for SSL connections to the controller.
3676 <column name="certificate">
3677 Name of a PEM file containing a certificate, signed by the
3678 certificate authority (CA) used by the controller and manager,
3679 that certifies the switch's private key, identifying a trustworthy
3683 <column name="ca_cert">
3684 Name of a PEM file containing the CA certificate used to verify
3685 that the switch is connected to a trustworthy controller.
3688 <column name="bootstrap_ca_cert">
3689 If set to <code>true</code>, then Open vSwitch will attempt to
3690 obtain the CA certificate from the controller on its first SSL
3691 connection and save it to the named PEM file. If it is successful,
3692 it will immediately drop the connection and reconnect, and from then
3693 on all SSL connections must be authenticated by a certificate signed
3694 by the CA certificate thus obtained. <em>This option exposes the
3695 SSL connection to a man-in-the-middle attack obtaining the initial
3696 CA certificate.</em> It may still be useful for bootstrapping.
3699 <group title="Common Columns">
3700 The overall purpose of these columns is described under <code>Common
3701 Columns</code> at the beginning of this document.
3703 <column name="external_ids"/>
3707 <table name="sFlow">
3708 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
3709 monitoring of switches.</p>
3711 <column name="agent">
3712 Name of the network device whose IP address should be reported as the
3713 ``agent address'' to collectors. If not specified, the agent device is
3714 figured from the first target address and the routing table. If the
3715 routing table does not contain a route to the target, the IP address
3716 defaults to the <ref table="Controller" column="local_ip"/> in the
3717 collector's <ref table="Controller"/>. If an agent IP address cannot be
3718 determined any of these ways, sFlow is disabled.
3721 <column name="header">
3722 Number of bytes of a sampled packet to send to the collector.
3723 If not specified, the default is 128 bytes.
3726 <column name="polling">
3727 Polling rate in seconds to send port statistics to the collector.
3728 If not specified, defaults to 30 seconds.
3731 <column name="sampling">
3732 Rate at which packets should be sampled and sent to the collector.
3733 If not specified, defaults to 400, which means one out of 400
3734 packets, on average, will be sent to the collector.
3737 <column name="targets">
3738 sFlow targets in the form
3739 <code><var>ip</var>:<var>port</var></code>.
3742 <group title="Common Columns">
3743 The overall purpose of these columns is described under <code>Common
3744 Columns</code> at the beginning of this document.
3746 <column name="external_ids"/>
3750 <table name="IPFIX">
3751 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3752 number of details about flows.</p>
3754 <column name="targets">
3755 IPFIX target collectors in the form
3756 <code><var>ip</var>:<var>port</var></code>.
3759 <column name="sampling">
3760 For per-bridge packet sampling, i.e. when this row is referenced
3761 from a <ref table="Bridge"/>, the rate at which packets should
3762 be sampled and sent to each target collector. If not specified,
3763 defaults to 400, which means one out of 400 packets, on average,
3764 will be sent to each target collector. Ignored for per-flow
3765 sampling, i.e. when this row is referenced from a <ref
3766 table="Flow_Sample_Collector_Set"/>.
3769 <column name="obs_domain_id">
3770 For per-bridge packet sampling, i.e. when this row is referenced
3771 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3772 sent in each IPFIX packet. If not specified, defaults to 0.
3773 Ignored for per-flow sampling, i.e. when this row is referenced
3774 from a <ref table="Flow_Sample_Collector_Set"/>.
3777 <column name="obs_point_id">
3778 For per-bridge packet sampling, i.e. when this row is referenced
3779 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3780 sent in each IPFIX flow record. If not specified, defaults to
3781 0. Ignored for per-flow sampling, i.e. when this row is
3782 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3785 <column name="cache_active_timeout">
3786 The maximum period in seconds for which an IPFIX flow record is
3787 cached and aggregated before being sent. If not specified,
3788 defaults to 0. If 0, caching is disabled.
3791 <column name="cache_max_flows">
3792 The maximum number of IPFIX flow records that can be cached at a
3793 time. If not specified, defaults to 0. If 0, caching is
3797 <group title="Common Columns">
3798 The overall purpose of these columns is described under <code>Common
3799 Columns</code> at the beginning of this document.
3801 <column name="external_ids"/>
3805 <table name="Flow_Sample_Collector_Set">
3806 <p>A set of IPFIX collectors of packet samples generated by
3807 OpenFlow <code>sample</code> actions.</p>
3810 The ID of this collector set, unique among the bridge's
3811 collector sets, to be used as the <code>collector_set_id</code>
3812 in OpenFlow <code>sample</code> actions.
3815 <column name="bridge">
3816 The bridge into which OpenFlow <code>sample</code> actions can
3817 be added to send packet samples to this set of IPFIX collectors.
3820 <column name="ipfix">
3821 Configuration of the set of IPFIX collectors to send one flow
3822 record per sampled packet to.
3825 <group title="Common Columns">
3826 The overall purpose of these columns is described under <code>Common
3827 Columns</code> at the beginning of this document.
3829 <column name="external_ids"/>