1 <?xml version="1.0" encoding="utf-8"?>
2 <database name="ovs-vswitchd.conf.db" 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-dpdk-rxqs"
156 type='{"type": "integer", "minInteger": 1}'>
158 Specifies the number of rx queues to be created for each dpdk
159 interface. If not specified or specified to 0, one rx queue will
160 be created for each dpdk interface by default.
164 <column name="other_config" key="pmd-cpu-mask">
166 Specifies CPU mask for setting the cpu affinity of PMD (Poll
167 Mode Driver) threads. Value should be in the form of hex string,
168 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
172 The lowest order bit corresponds to the first CPU core. A set bit
173 means the corresponding core is available and a pmd thread will be
174 created and pinned to it. If the input does not cover all cores,
175 those uncovered cores are considered not set.
178 If not specified, one pmd thread will be created for each numa node
179 and pinned to any available core on the numa node by default.
183 <column name="other_config" key="n-handler-threads"
184 type='{"type": "integer", "minInteger": 1}'>
186 Specifies the number of threads for software datapaths to use for
187 handling new flows. The default the number of online CPU cores minus
188 the number of revalidators.
191 This configuration is per datapath. If you have more than one
192 software datapath (e.g. some <code>system</code> bridges and some
193 <code>netdev</code> bridges), then the total number of threads is
194 <code>n-handler-threads</code> times the number of software
199 <column name="other_config" key="n-revalidator-threads"
200 type='{"type": "integer", "minInteger": 1}'>
202 Specifies the number of threads for software datapaths to use for
203 revalidating flows in the datapath. Typically, there is a direct
204 correlation between the number of revalidator threads, and the number
205 of flows allowed in the datapath. The default is the number of cpu
206 cores divided by four plus one. If <code>n-handler-threads</code> is
207 set, the default changes to the number of cpu cores minus the number
211 This configuration is per datapath. If you have more than one
212 software datapath (e.g. some <code>system</code> bridges and some
213 <code>netdev</code> bridges), then the total number of threads is
214 <code>n-handler-threads</code> times the number of software
220 <group title="Status">
221 <column name="next_cfg">
222 Sequence number for client to increment. When a client modifies
223 any part of the database configuration and wishes to wait for
224 Open vSwitch to finish applying the changes, it may increment
225 this sequence number.
228 <column name="cur_cfg">
229 Sequence number that Open vSwitch sets to the current value of
230 <ref column="next_cfg"/> after it finishes applying a set of
231 configuration changes.
234 <group title="Statistics">
236 The <code>statistics</code> column contains key-value pairs that
237 report statistics about a system running an Open vSwitch. These are
238 updated periodically (currently, every 5 seconds). Key-value pairs
239 that cannot be determined or that do not apply to a platform are
243 <column name="other_config" key="enable-statistics"
244 type='{"type": "boolean"}'>
245 Statistics are disabled by default to avoid overhead in the common
246 case when statistics gathering is not useful. Set this value to
247 <code>true</code> to enable populating the <ref column="statistics"/>
248 column or to <code>false</code> to explicitly disable it.
251 <column name="statistics" key="cpu"
252 type='{"type": "integer", "minInteger": 1}'>
254 Number of CPU processors, threads, or cores currently online and
255 available to the operating system on which Open vSwitch is running,
256 as an integer. This may be less than the number installed, if some
257 are not online or if they are not available to the operating
261 Open vSwitch userspace processes are not multithreaded, but the
262 Linux kernel-based datapath is.
266 <column name="statistics" key="load_average">
267 A comma-separated list of three floating-point numbers,
268 representing the system load average over the last 1, 5, and 15
269 minutes, respectively.
272 <column name="statistics" key="memory">
274 A comma-separated list of integers, each of which represents a
275 quantity of memory in kilobytes that describes the operating
276 system on which Open vSwitch is running. In respective order,
281 <li>Total amount of RAM allocated to the OS.</li>
282 <li>RAM allocated to the OS that is in use.</li>
283 <li>RAM that can be flushed out to disk or otherwise discarded
284 if that space is needed for another purpose. This number is
285 necessarily less than or equal to the previous value.</li>
286 <li>Total disk space allocated for swap.</li>
287 <li>Swap space currently in use.</li>
291 On Linux, all five values can be determined and are included. On
292 other operating systems, only the first two values can be
293 determined, so the list will only have two values.
297 <column name="statistics" key="process_NAME">
299 One such key-value pair, with <code>NAME</code> replaced by
300 a process name, will exist for each running Open vSwitch
301 daemon process, with <var>name</var> replaced by the
302 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
303 value is a comma-separated list of integers. The integers
304 represent the following, with memory measured in kilobytes
305 and durations in milliseconds:
309 <li>The process's virtual memory size.</li>
310 <li>The process's resident set size.</li>
311 <li>The amount of user and system CPU time consumed by the
313 <li>The number of times that the process has crashed and been
314 automatically restarted by the monitor.</li>
315 <li>The duration since the process was started.</li>
316 <li>The duration for which the process has been running.</li>
320 The interpretation of some of these values depends on whether the
321 process was started with the <option>--monitor</option>. If it
322 was not, then the crash count will always be 0 and the two
323 durations will always be the same. If <option>--monitor</option>
324 was given, then the crash count may be positive; if it is, the
325 latter duration is the amount of time since the most recent crash
330 There will be one key-value pair for each file in Open vSwitch's
331 ``run directory'' (usually <code>/var/run/openvswitch</code>)
332 whose name ends in <code>.pid</code>, whose contents are a
333 process ID, and which is locked by a running process. The
334 <var>name</var> is taken from the pidfile's name.
338 Currently Open vSwitch is only able to obtain all of the above
339 detail on Linux systems. On other systems, the same key-value
340 pairs will be present but the values will always be the empty
345 <column name="statistics" key="file_systems">
347 A space-separated list of information on local, writable file
348 systems. Each item in the list describes one file system and
349 consists in turn of a comma-separated list of the following:
353 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
354 Any spaces or commas in the mount point are replaced by
356 <li>Total size, in kilobytes, as an integer.</li>
357 <li>Amount of storage in use, in kilobytes, as an integer.</li>
361 This key-value pair is omitted if there are no local, writable
362 file systems or if Open vSwitch cannot obtain the needed
369 <group title="Version Reporting">
371 These columns report the types and versions of the hardware and
372 software running Open vSwitch. We recommend in general that software
373 should test whether specific features are supported instead of relying
374 on version number checks. These values are primarily intended for
375 reporting to human administrators.
378 <column name="ovs_version">
379 The Open vSwitch version number, e.g. <code>1.1.0</code>.
382 <column name="db_version">
384 The database schema version number in the form
385 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
386 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
387 a non-backward compatible way (e.g. deleting a column or a table),
388 <var>major</var> is incremented. When the database schema is changed
389 in a backward compatible way (e.g. adding a new column),
390 <var>minor</var> is incremented. When the database schema is changed
391 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
396 The schema version is part of the database schema, so it can also be
397 retrieved by fetching the schema using the Open vSwitch database
402 <column name="system_type">
404 An identifier for the type of system on top of which Open vSwitch
405 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
408 System integrators are responsible for choosing and setting an
409 appropriate value for this column.
413 <column name="system_version">
415 The version of the system identified by <ref column="system_type"/>,
416 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
419 System integrators are responsible for choosing and setting an
420 appropriate value for this column.
426 <group title="Capabilities">
428 These columns report capabilities of the Open vSwitch instance.
430 <column name="datapath_types">
432 This column reports the different dpifs registered with the system.
433 These are the values that this instance supports in the <ref
434 column="datapath_type" table="Bridge"/> column of the <ref
435 table="Bridge"/> table.
438 <column name="iface_types">
440 This column reports the different netdevs registered with the system.
441 These are the values that this instance supports in the <ref
442 column="type" table="Interface"/> column of the <ref
443 table="Interface"/> table.
448 <group title="Database Configuration">
450 These columns primarily configure the Open vSwitch database
451 (<code>ovsdb-server</code>), not the Open vSwitch switch
452 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
453 column="ssl"/> settings.
457 The Open vSwitch switch does read the database configuration to
458 determine remote IP addresses to which in-band control should apply.
461 <column name="manager_options">
462 Database clients to which the Open vSwitch database server should
463 connect or to which it should listen, along with options for how these
464 connection should be configured. See the <ref table="Manager"/> table
465 for more information.
469 <group title="Common Columns">
470 The overall purpose of these columns is described under <code>Common
471 Columns</code> at the beginning of this document.
473 <column name="other_config"/>
474 <column name="external_ids"/>
478 <table name="Bridge">
480 Configuration for a bridge within an
481 <ref table="Open_vSwitch"/>.
484 A <ref table="Bridge"/> record represents an Ethernet switch with one or
485 more ``ports,'' which are the <ref table="Port"/> records pointed to by
486 the <ref table="Bridge"/>'s <ref column="ports"/> column.
489 <group title="Core Features">
491 Bridge identifier. Should be alphanumeric and no more than about 8
492 bytes long. Must be unique among the names of ports, interfaces, and
496 <column name="ports">
497 Ports included in the bridge.
500 <column name="mirrors">
501 Port mirroring configuration.
504 <column name="netflow">
505 NetFlow configuration.
508 <column name="sflow">
509 sFlow(R) configuration.
512 <column name="ipfix">
516 <column name="flood_vlans">
518 VLAN IDs of VLANs on which MAC address learning should be disabled,
519 so that packets are flooded instead of being sent to specific ports
520 that are believed to contain packets' destination MACs. This should
521 ordinarily be used to disable MAC learning on VLANs used for
522 mirroring (RSPAN VLANs). It may also be useful for debugging.
525 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
526 the <ref table="Port"/> table) is incompatible with
527 <code>flood_vlans</code>. Consider using another bonding mode or
528 a different type of mirror instead.
532 <column name="auto_attach">
533 Auto Attach configuration.
537 <group title="OpenFlow Configuration">
538 <column name="controller">
540 OpenFlow controller set. If unset, then no OpenFlow controllers
545 If there are primary controllers, removing all of them clears the
546 flow table. If there are no primary controllers, adding one also
547 clears the flow table. Other changes to the set of controllers, such
548 as adding or removing a service controller, adding another primary
549 controller to supplement an existing primary controller, or removing
550 only one of two primary controllers, have no effect on the flow
555 <column name="flow_tables">
556 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
557 table ID to configuration for that table.
560 <column name="fail_mode">
561 <p>When a controller is configured, it is, ordinarily, responsible
562 for setting up all flows on the switch. Thus, if the connection to
563 the controller fails, no new network connections can be set up.
564 If the connection to the controller stays down long enough,
565 no packets can pass through the switch at all. This setting
566 determines the switch's response to such a situation. It may be set
567 to one of the following:
569 <dt><code>standalone</code></dt>
570 <dd>If no message is received from the controller for three
571 times the inactivity probe interval
572 (see <ref column="inactivity_probe"/>), then Open vSwitch
573 will take over responsibility for setting up flows. In
574 this mode, Open vSwitch causes the bridge to act like an
575 ordinary MAC-learning switch. Open vSwitch will continue
576 to retry connecting to the controller in the background
577 and, when the connection succeeds, it will discontinue its
578 standalone behavior.</dd>
579 <dt><code>secure</code></dt>
580 <dd>Open vSwitch will not set up flows on its own when the
581 controller connection fails or when no controllers are
582 defined. The bridge will continue to retry connecting to
583 any defined controllers forever.</dd>
587 The default is <code>standalone</code> if the value is unset, but
588 future versions of Open vSwitch may change the default.
591 The <code>standalone</code> mode can create forwarding loops on a
592 bridge that has more than one uplink port unless STP is enabled. To
593 avoid loops on such a bridge, configure <code>secure</code> mode or
594 enable STP (see <ref column="stp_enable"/>).
596 <p>When more than one controller is configured,
597 <ref column="fail_mode"/> is considered only when none of the
598 configured controllers can be contacted.</p>
600 Changing <ref column="fail_mode"/> when no primary controllers are
601 configured clears the flow table.
605 <column name="datapath_id">
606 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
607 (Setting this column has no useful effect. Set <ref
608 column="other-config" key="datapath-id"/> instead.)
611 <column name="datapath_version">
613 Reports the version number of the Open vSwitch datapath in use.
614 This allows management software to detect and report discrepancies
615 between Open vSwitch userspace and datapath versions. (The <ref
616 column="ovs_version" table="Open_vSwitch"/> column in the <ref
617 table="Open_vSwitch"/> reports the Open vSwitch userspace version.)
618 The version reported depends on the datapath in use:
623 When the kernel module included in the Open vSwitch source tree is
624 used, this column reports the Open vSwitch version from which the
629 When the kernel module that is part of the upstream Linux kernel is
630 used, this column reports <code><unknown></code>.
634 When the datapath is built into the <code>ovs-vswitchd</code>
635 binary, this column reports <code><built-in></code>. A
636 built-in datapath is by definition the same version as the rest of
637 the Open VSwitch userspace.
641 Other datapaths (such as the Hyper-V kernel datapath) currently
642 report <code><unknown></code>.
647 A version discrepancy between <code>ovs-vswitchd</code> and the
648 datapath in use is not normally cause for alarm. The Open vSwitch
649 kernel datapaths for Linux and Hyper-V, in particular, are designed
650 for maximum inter-version compatibility: any userspace version works
651 with with any kernel version. Some reasons do exist to insist on
652 particular user/kernel pairings. First, newer kernel versions add
653 new features, that can only be used by new-enough userspace, e.g.
654 VXLAN tunneling requires certain minimal userspace and kernel
655 versions. Second, as an extension to the first reason, some newer
656 kernel versions add new features for enhancing performance that only
657 new-enough userspace versions can take advantage of.
661 <column name="other_config" key="datapath-id">
662 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
663 value. May not be all-zero.
666 <column name="other_config" key="dp-desc">
667 Human readable description of datapath. It it a maximum 256
668 byte-long free-form string to describe the datapath for
669 debugging purposes, e.g. <code>switch3 in room 3120</code>.
672 <column name="other_config" key="disable-in-band"
673 type='{"type": "boolean"}'>
674 If set to <code>true</code>, disable in-band control on the bridge
675 regardless of controller and manager settings.
678 <column name="other_config" key="in-band-queue"
679 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
680 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
681 that will be used by flows set up by in-band control on this bridge.
682 If unset, or if the port used by an in-band control flow does not have
683 QoS configured, or if the port does not have a queue with the specified
684 ID, the default queue is used instead.
687 <column name="protocols">
689 List of OpenFlow protocols that may be used when negotiating
690 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
691 1.3 are enabled by default if this column is empty.
695 OpenFlow 1.4 is not enabled by default because its implementation is
700 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
701 experimental because the OpenFlow 1.5 specification is still under
702 development and thus subject to change. Pass
703 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
704 OpenFlow 1.5 to be enabled.
709 <group title="Spanning Tree Configuration">
711 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
712 that ensures loop-free topologies. It allows redundant links to
713 be included in the network to provide automatic backup paths if
714 the active links fails.
718 These settings configure the slower-to-converge but still widely
719 supported version of Spanning Tree Protocol, sometimes known as
720 802.1D-1998. Open vSwitch also supports the newer Rapid Spanning Tree
721 Protocol (RSTP), documented later in the section titled <code>Rapid
722 Spanning Tree Configuration</code>.
725 <group title="STP Configuration">
726 <column name="stp_enable" type='{"type": "boolean"}'>
728 Enable spanning tree on the bridge. By default, STP is disabled
729 on bridges. Bond, internal, and mirror ports are not supported
730 and will not participate in the spanning tree.
734 STP and RSTP are mutually exclusive. If both are enabled, RSTP
739 <column name="other_config" key="stp-system-id">
740 The bridge's STP identifier (the lower 48 bits of the bridge-id)
742 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
743 By default, the identifier is the MAC address of the bridge.
746 <column name="other_config" key="stp-priority"
747 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
748 The bridge's relative priority value for determining the root
749 bridge (the upper 16 bits of the bridge-id). A bridge with the
750 lowest bridge-id is elected the root. By default, the priority
754 <column name="other_config" key="stp-hello-time"
755 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
756 The interval between transmissions of hello messages by
757 designated ports, in seconds. By default the hello interval is
761 <column name="other_config" key="stp-max-age"
762 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
763 The maximum age of the information transmitted by the bridge
764 when it is the root bridge, in seconds. By default, the maximum
768 <column name="other_config" key="stp-forward-delay"
769 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
770 The delay to wait between transitioning root and designated
771 ports to <code>forwarding</code>, in seconds. By default, the
772 forwarding delay is 15 seconds.
775 <column name="other_config" key="mcast-snooping-aging-time"
776 type='{"type": "integer", "minInteger": 1}'>
778 The maximum number of seconds to retain a multicast snooping entry for
779 which no packets have been seen. The default is currently 300
780 seconds (5 minutes). The value, if specified, is forced into a
781 reasonable range, currently 15 to 3600 seconds.
785 <column name="other_config" key="mcast-snooping-table-size"
786 type='{"type": "integer", "minInteger": 1}'>
788 The maximum number of multicast snooping addresses to learn. The
789 default is currently 2048. The value, if specified, is forced into
790 a reasonable range, currently 10 to 1,000,000.
793 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
794 type='{"type": "boolean"}'>
796 If set to <code>false</code>, unregistered multicast packets are forwarded
798 If set to <code>true</code>, unregistered multicast packets are forwarded
799 to ports connected to multicast routers.
804 <group title="STP Status">
806 These key-value pairs report the status of 802.1D-1998. They are
807 present only if STP is enabled (via the <ref column="stp_enable"/>
810 <column name="status" key="stp_bridge_id">
811 The bridge ID used in spanning tree advertisements, in the form
812 <var>xxxx</var>.<var>yyyyyyyyyyyy</var> where the <var>x</var>s are
813 the STP priority, the <var>y</var>s are the STP system ID, and each
814 <var>x</var> and <var>y</var> is a hex digit.
816 <column name="status" key="stp_designated_root">
817 The designated root for this spanning tree, in the same form as <ref
818 column="status" key="stp_bridge_id"/>. If this bridge is the root,
819 this will have the same value as <ref column="status"
820 key="stp_bridge_id"/>, otherwise it will differ.
822 <column name="status" key="stp_root_path_cost">
823 The path cost of reaching the designated bridge. A lower number is
824 better. The value is 0 if this bridge is the root, otherwise it is
830 <group title="Rapid Spanning Tree">
832 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
833 that ensures loop-free topologies. RSTP superseded STP with the
834 publication of 802.1D-2004. Compared to STP, RSTP converges more
835 quickly and recovers more quickly from failures.
838 <group title="RSTP Configuration">
839 <column name="rstp_enable" type='{"type": "boolean"}'>
841 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
842 on bridges. Bond, internal, and mirror ports are not supported
843 and will not participate in the spanning tree.
847 STP and RSTP are mutually exclusive. If both are enabled, RSTP
852 <column name="other_config" key="rstp-address">
853 The bridge's RSTP address (the lower 48 bits of the bridge-id)
855 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
856 By default, the address is the MAC address of the bridge.
859 <column name="other_config" key="rstp-priority"
860 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
861 The bridge's relative priority value for determining the root
862 bridge (the upper 16 bits of the bridge-id). A bridge with the
863 lowest bridge-id is elected the root. By default, the priority
864 is 0x8000 (32768). This value needs to be a multiple of 4096,
865 otherwise it's rounded to the nearest inferior one.
868 <column name="other_config" key="rstp-ageing-time"
869 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
870 The Ageing Time parameter for the Bridge. The default value
874 <column name="other_config" key="rstp-force-protocol-version"
875 type='{"type": "integer"}'>
876 The Force Protocol Version parameter for the Bridge. This
877 can take the value 0 (STP Compatibility mode) or 2
878 (the default, normal operation).
881 <column name="other_config" key="rstp-max-age"
882 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
883 The maximum age of the information transmitted by the Bridge
884 when it is the Root Bridge. The default value is 20.
887 <column name="other_config" key="rstp-forward-delay"
888 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
889 The delay used by STP Bridges to transition Root and Designated
890 Ports to Forwarding. The default value is 15.
893 <column name="other_config" key="rstp-transmit-hold-count"
894 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
895 The Transmit Hold Count used by the Port Transmit state machine
896 to limit transmission rate. The default value is 6.
900 <group title="RSTP Status">
902 These key-value pairs report the status of 802.1D-2004. They are
903 present only if RSTP is enabled (via the <ref column="rstp_enable"/>
906 <column name="rstp_status" key="rstp_bridge_id">
907 The bridge ID used in rapid spanning tree advertisements, in the form
908 <var>x</var>.<var>yyy</var>.<var>zzzzzzzzzzzz</var> where
909 <var>x</var> is the RSTP priority, the <var>y</var>s are a locally
910 assigned system ID extension, the <var>z</var>s are the STP system
911 ID, and each <var>x</var>, <var>y</var>, or <var>z</var> is a hex
914 <column name="rstp_status" key="rstp_root_id">
915 The root of this spanning tree, in the same form as <ref
916 column="rstp_status" key="rstp_bridge_id"/>. If this bridge is the
917 root, this will have the same value as <ref column="rstp_status"
918 key="rstp_bridge_id"/>, otherwise it will differ.
920 <column name="rstp_status" key="rstp_root_path_cost"
921 type='{"type": "integer", "minInteger": 0}'>
922 The path cost of reaching the root. A lower number is better. The
923 value is 0 if this bridge is the root, otherwise it is higher.
925 <column name="rstp_status" key="rstp_designated_id">
926 The RSTP designated ID, in the same form as <ref column="rstp_status"
927 key="rstp_bridge_id"/>.
929 <column name="rstp_status" key="rstp_designated_port_id">
930 The RSTP designated port ID, as a 4-digit hex number.
932 <column name="rstp_status" key="rstp_bridge_port_id">
933 The RSTP bridge port ID, as a 4-digit hex number.
938 <group title="Multicast Snooping Configuration">
939 Multicast snooping (RFC 4541) monitors the Internet Group Management
940 Protocol (IGMP) traffic between hosts and multicast routers. The
941 switch uses what IGMP snooping learns to forward multicast traffic
942 only to interfaces that are connected to interested receivers.
943 Currently it supports IGMPv1 and IGMPv2 protocols.
945 <column name="mcast_snooping_enable">
946 Enable multicast snooping on the bridge. For now, the default
951 <group title="Other Features">
952 <column name="datapath_type">
953 Name of datapath provider. The kernel datapath has type
954 <code>system</code>. The userspace datapath has type
955 <code>netdev</code>. A manager may refer to the <ref
956 table="Open_vSwitch" column="datapath_types"/> column of the <ref
957 table="Open_vSwitch"/> table for a list of the types accepted by this
958 Open vSwitch instance.
961 <column name="external_ids" key="bridge-id">
962 A unique identifier of the bridge. On Citrix XenServer this will
963 commonly be the same as
964 <ref column="external_ids" key="xs-network-uuids"/>.
967 <column name="external_ids" key="xs-network-uuids">
968 Semicolon-delimited set of universally unique identifier(s) for the
969 network with which this bridge is associated on a Citrix XenServer
970 host. The network identifiers are RFC 4122 UUIDs as displayed by,
971 e.g., <code>xe network-list</code>.
974 <column name="other_config" key="hwaddr">
975 An Ethernet address in the form
976 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
977 to set the hardware address of the local port and influence the
981 <column name="other_config" key="forward-bpdu"
982 type='{"type": "boolean"}'>
985 Controls forwarding of BPDUs and other network control frames when
986 NORMAL action is invoked. When this option is <code>false</code> or
987 unset, frames with reserved Ethernet addresses (see table below) will
988 not be forwarded. When this option is <code>true</code>, such frames
989 will not be treated specially.
993 The above general rule has the following exceptions:
998 If STP is enabled on the bridge (see the <ref column="stp_enable"
999 table="Bridge"/> column in the <ref table="Bridge"/> table), the
1000 bridge processes all received STP packets and never passes them to
1001 OpenFlow or forwards them. This is true even if STP is disabled on
1006 If LLDP is enabled on an interface (see the <ref column="lldp"
1007 table="Interface"/> column in the <ref table="Interface"/> table),
1008 the interface processes received LLDP packets and never passes them
1009 to OpenFlow or forwards them.
1014 Set this option to <code>true</code> if the Open vSwitch bridge
1015 connects different Ethernet networks and is not configured to
1020 This option affects packets with the following destination MAC
1025 <dt><code>01:80:c2:00:00:00</code></dt>
1026 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1028 <dt><code>01:80:c2:00:00:01</code></dt>
1029 <dd>IEEE Pause frame.</dd>
1031 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1032 <dd>Other reserved protocols.</dd>
1034 <dt><code>00:e0:2b:00:00:00</code></dt>
1035 <dd>Extreme Discovery Protocol (EDP).</dd>
1038 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
1040 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
1042 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1044 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1045 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1049 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1050 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1052 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1053 <dd>Cisco STP Uplink Fast.</dd>
1055 <dt><code>01:00:0c:00:00:00</code></dt>
1056 <dd>Cisco Inter Switch Link.</dd>
1058 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
1063 <column name="other_config" key="mac-aging-time"
1064 type='{"type": "integer", "minInteger": 1}'>
1066 The maximum number of seconds to retain a MAC learning entry for
1067 which no packets have been seen. The default is currently 300
1068 seconds (5 minutes). The value, if specified, is forced into a
1069 reasonable range, currently 15 to 3600 seconds.
1073 A short MAC aging time allows a network to more quickly detect that a
1074 host is no longer connected to a switch port. However, it also makes
1075 it more likely that packets will be flooded unnecessarily, when they
1076 are addressed to a connected host that rarely transmits packets. To
1077 reduce the incidence of unnecessary flooding, use a MAC aging time
1078 longer than the maximum interval at which a host will ordinarily
1083 <column name="other_config" key="mac-table-size"
1084 type='{"type": "integer", "minInteger": 1}'>
1086 The maximum number of MAC addresses to learn. The default is
1087 currently 2048. The value, if specified, is forced into a reasonable
1088 range, currently 10 to 1,000,000.
1093 <group title="Common Columns">
1094 The overall purpose of these columns is described under <code>Common
1095 Columns</code> at the beginning of this document.
1097 <column name="other_config"/>
1098 <column name="external_ids"/>
1102 <table name="Port" table="Port or bond configuration.">
1103 <p>A port within a <ref table="Bridge"/>.</p>
1104 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1105 <ref column="interfaces"/> column. Such a port logically
1106 corresponds to a port on a physical Ethernet switch. A port
1107 with more than one interface is a ``bonded port'' (see
1108 <ref group="Bonding Configuration"/>).</p>
1109 <p>Some properties that one might think as belonging to a port are actually
1110 part of the port's <ref table="Interface"/> members.</p>
1112 <column name="name">
1113 Port name. Should be alphanumeric and no more than about 8
1114 bytes long. May be the same as the interface name, for
1115 non-bonded ports. Must otherwise be unique among the names of
1116 ports, interfaces, and bridges on a host.
1119 <column name="interfaces">
1120 The port's interfaces. If there is more than one, this is a
1124 <group title="VLAN Configuration">
1125 <p>Bridge ports support the following types of VLAN configuration:</p>
1130 A trunk port carries packets on one or more specified VLANs
1131 specified in the <ref column="trunks"/> column (often, on every
1132 VLAN). A packet that ingresses on a trunk port is in the VLAN
1133 specified in its 802.1Q header, or VLAN 0 if the packet has no
1134 802.1Q header. A packet that egresses through a trunk port will
1135 have an 802.1Q header if it has a nonzero VLAN ID.
1139 Any packet that ingresses on a trunk port tagged with a VLAN that
1140 the port does not trunk is dropped.
1147 An access port carries packets on exactly one VLAN specified in the
1148 <ref column="tag"/> column. Packets egressing on an access port
1149 have no 802.1Q header.
1153 Any packet with an 802.1Q header with a nonzero VLAN ID that
1154 ingresses on an access port is dropped, regardless of whether the
1155 VLAN ID in the header is the access port's VLAN ID.
1159 <dt>native-tagged</dt>
1161 A native-tagged port resembles a trunk port, with the exception that
1162 a packet without an 802.1Q header that ingresses on a native-tagged
1163 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1167 <dt>native-untagged</dt>
1169 A native-untagged port resembles a native-tagged port, with the
1170 exception that a packet that egresses on a native-untagged port in
1171 the native VLAN will not have an 802.1Q header.
1175 A packet will only egress through bridge ports that carry the VLAN of
1176 the packet, as described by the rules above.
1179 <column name="vlan_mode">
1181 The VLAN mode of the port, as described above. When this column is
1182 empty, a default mode is selected as follows:
1186 If <ref column="tag"/> contains a value, the port is an access
1187 port. The <ref column="trunks"/> column should be empty.
1190 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1191 column value is honored if it is present.
1198 For an access port, the port's implicitly tagged VLAN. For a
1199 native-tagged or native-untagged port, the port's native VLAN. Must
1200 be empty if this is a trunk port.
1204 <column name="trunks">
1206 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1207 or VLANs that this port trunks; if it is empty, then the port trunks
1208 all VLANs. Must be empty if this is an access port.
1211 A native-tagged or native-untagged port always trunks its native
1212 VLAN, regardless of whether <ref column="trunks"/> includes that
1217 <column name="other_config" key="priority-tags"
1218 type='{"type": "boolean"}'>
1220 An 802.1Q header contains two important pieces of information: a VLAN
1221 ID and a priority. A frame with a zero VLAN ID, called a
1222 ``priority-tagged'' frame, is supposed to be treated the same way as
1223 a frame without an 802.1Q header at all (except for the priority).
1227 However, some network elements ignore any frame that has 802.1Q
1228 header at all, even when the VLAN ID is zero. Therefore, by default
1229 Open vSwitch does not output priority-tagged frames, instead omitting
1230 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1231 <code>true</code> to enable priority-tagged frames on a port.
1235 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1236 output if both the VLAN ID and priority would be zero.
1240 All frames output to native-tagged ports have a nonzero VLAN ID, so
1241 this setting is not meaningful on native-tagged ports.
1246 <group title="Bonding Configuration">
1247 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1248 allows for load balancing and fail-over.</p>
1251 The following types of bonding will work with any kind of upstream
1252 switch. On the upstream switch, do not configure the interfaces as a
1257 <dt><code>balance-slb</code></dt>
1259 Balances flows among slaves based on source MAC address and output
1260 VLAN, with periodic rebalancing as traffic patterns change.
1263 <dt><code>active-backup</code></dt>
1265 Assigns all flows to one slave, failing over to a backup slave when
1266 the active slave is disabled. This is the only bonding mode in which
1267 interfaces may be plugged into different upstream switches.
1272 The following modes require the upstream switch to support 802.3ad with
1273 successful LACP negotiation. If LACP negotiation fails and
1274 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1279 <dt><code>balance-tcp</code></dt>
1281 Balances flows among slaves based on L2, L3, and L4 protocol
1282 information such as destination MAC address, IP address, and TCP
1287 <p>These columns apply only to bonded ports. Their values are
1288 otherwise ignored.</p>
1290 <column name="bond_mode">
1291 <p>The type of bonding used for a bonded port. Defaults to
1292 <code>active-backup</code> if unset.
1296 <column name="other_config" key="bond-hash-basis"
1297 type='{"type": "integer"}'>
1298 An integer hashed along with flows when choosing output slaves in load
1299 balanced bonds. When changed, all flows will be assigned different
1300 hash values possibly causing slave selection decisions to change. Does
1301 not affect bonding modes which do not employ load balancing such as
1302 <code>active-backup</code>.
1305 <group title="Link Failure Detection">
1307 An important part of link bonding is detecting that links are down so
1308 that they may be disabled. These settings determine how Open vSwitch
1309 detects link failure.
1312 <column name="other_config" key="bond-detect-mode"
1313 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1314 The means used to detect link failures. Defaults to
1315 <code>carrier</code> which uses each interface's carrier to detect
1316 failures. When set to <code>miimon</code>, will check for failures
1317 by polling each interface's MII.
1320 <column name="other_config" key="bond-miimon-interval"
1321 type='{"type": "integer"}'>
1322 The interval, in milliseconds, between successive attempts to poll
1323 each interface's MII. Relevant only when <ref column="other_config"
1324 key="bond-detect-mode"/> is <code>miimon</code>.
1327 <column name="bond_updelay">
1329 The number of milliseconds for which the link must stay up on an
1330 interface before the interface is considered to be up. Specify
1331 <code>0</code> to enable the interface immediately.
1335 This setting is honored only when at least one bonded interface is
1336 already enabled. When no interfaces are enabled, then the first
1337 bond interface to come up is enabled immediately.
1341 <column name="bond_downdelay">
1342 The number of milliseconds for which the link must stay down on an
1343 interface before the interface is considered to be down. Specify
1344 <code>0</code> to disable the interface immediately.
1348 <group title="LACP Configuration">
1350 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1351 allows switches to automatically detect that they are connected by
1352 multiple links and aggregate across those links. These settings
1353 control LACP behavior.
1356 <column name="lacp">
1357 Configures LACP on this port. LACP allows directly connected
1358 switches to negotiate which links may be bonded. LACP may be enabled
1359 on non-bonded ports for the benefit of any switches they may be
1360 connected to. <code>active</code> ports are allowed to initiate LACP
1361 negotiations. <code>passive</code> ports are allowed to participate
1362 in LACP negotiations initiated by a remote switch, but not allowed to
1363 initiate such negotiations themselves. If LACP is enabled on a port
1364 whose partner switch does not support LACP, the bond will be
1365 disabled, unless other-config:lacp-fallback-ab is set to true.
1366 Defaults to <code>off</code> if unset.
1369 <column name="other_config" key="lacp-system-id">
1370 The LACP system ID of this <ref table="Port"/>. The system ID of a
1371 LACP bond is used to identify itself to its partners. Must be a
1372 nonzero MAC address. Defaults to the bridge Ethernet address if
1376 <column name="other_config" key="lacp-system-priority"
1377 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1378 The LACP system priority of this <ref table="Port"/>. In LACP
1379 negotiations, link status decisions are made by the system with the
1380 numerically lower priority.
1383 <column name="other_config" key="lacp-time"
1384 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1386 The LACP timing which should be used on this <ref table="Port"/>.
1387 By default <code>slow</code> is used. When configured to be
1388 <code>fast</code> LACP heartbeats are requested at a rate of once
1389 per second causing connectivity problems to be detected more
1390 quickly. In <code>slow</code> mode, heartbeats are requested at a
1391 rate of once every 30 seconds.
1395 <column name="other_config" key="lacp-fallback-ab"
1396 type='{"type": "boolean"}'>
1398 Determines the behavior of openvswitch bond in LACP mode. If
1399 the partner switch does not support LACP, setting this option
1400 to <code>true</code> allows openvswitch to fallback to
1401 active-backup. If the option is set to <code>false</code>, the
1402 bond will be disabled. In both the cases, once the partner switch
1403 is configured to LACP mode, the bond will use LACP.
1408 <group title="Rebalancing Configuration">
1410 These settings control behavior when a bond is in
1411 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1414 <column name="other_config" key="bond-rebalance-interval"
1415 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1416 For a load balanced bonded port, the number of milliseconds between
1417 successive attempts to rebalance the bond, that is, to move flows
1418 from one interface on the bond to another in an attempt to keep usage
1419 of each interface roughly equal. If zero, load balancing is disabled
1420 on the bond (link failure still cause flows to move). If
1421 less than 1000ms, the rebalance interval will be 1000ms.
1425 <column name="bond_fake_iface">
1426 For a bonded port, whether to create a fake internal interface with the
1427 name of the port. Use only for compatibility with legacy software that
1432 <group title="Spanning Tree Protocol">
1434 The configuration here is only meaningful, and the status is only
1435 populated, when 802.1D-1998 Spanning Tree Protocol is enabled on the
1436 port's <ref column="Bridge"/> with its <ref column="stp_enable"/>
1440 <group title="STP Configuration">
1441 <column name="other_config" key="stp-enable"
1442 type='{"type": "boolean"}'>
1443 When STP is enabled on a bridge, it is enabled by default on all of
1444 the bridge's ports except bond, internal, and mirror ports (which do
1445 not work with STP). If this column's value is <code>false</code>,
1446 STP is disabled on the port.
1449 <column name="other_config" key="stp-port-num"
1450 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1451 The port number used for the lower 8 bits of the port-id. By
1452 default, the numbers will be assigned automatically. If any
1453 port's number is manually configured on a bridge, then they
1457 <column name="other_config" key="stp-port-priority"
1458 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1459 The port's relative priority value for determining the root
1460 port (the upper 8 bits of the port-id). A port with a lower
1461 port-id will be chosen as the root port. By default, the
1465 <column name="other_config" key="stp-path-cost"
1466 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1467 Spanning tree path cost for the port. A lower number indicates
1468 a faster link. By default, the cost is based on the maximum
1473 <group title="STP Status">
1474 <column name="status" key="stp_port_id">
1475 The port ID used in spanning tree advertisements for this port, as 4
1476 hex digits. Configuring the port ID is described in the
1477 <code>stp-port-num</code> and <code>stp-port-priority</code> keys of
1478 the <code>other_config</code> section earlier.
1480 <column name="status" key="stp_state"
1481 type='{"type": "string", "enum": ["set",
1482 ["disabled", "listening", "learning",
1483 "forwarding", "blocking"]]}'>
1484 STP state of the port.
1486 <column name="status" key="stp_sec_in_state"
1487 type='{"type": "integer", "minInteger": 0}'>
1488 The amount of time this port has been in the current STP state, in
1491 <column name="status" key="stp_role"
1492 type='{"type": "string", "enum": ["set",
1493 ["root", "designated", "alternate"]]}'>
1494 STP role of the port.
1499 <group title="Rapid Spanning Tree Protocol">
1501 The configuration here is only meaningful, and the status and
1502 statistics are only populated, when 802.1D-1998 Spanning Tree Protocol
1503 is enabled on the port's <ref column="Bridge"/> with its <ref
1504 column="stp_enable"/> column.
1507 <group title="RSTP Configuration">
1508 <column name="other_config" key="rstp-enable"
1509 type='{"type": "boolean"}'>
1510 When RSTP is enabled on a bridge, it is enabled by default on all of
1511 the bridge's ports except bond, internal, and mirror ports (which do
1512 not work with RSTP). If this column's value is <code>false</code>,
1513 RSTP is disabled on the port.
1516 <column name="other_config" key="rstp-port-priority"
1517 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1518 The port's relative priority value for determining the root port, in
1519 multiples of 16. By default, the port priority is 0x80 (128). Any
1520 value in the lower 4 bits is rounded off. The significant upper 4
1521 bits become the upper 4 bits of the port-id. A port with the lowest
1522 port-id is elected as the root.
1525 <column name="other_config" key="rstp-port-num"
1526 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1527 The local RSTP port number, used as the lower 12 bits of the port-id.
1528 By default the port numbers are assigned automatically, and typically
1529 may not correspond to the OpenFlow port numbers. A port with the
1530 lowest port-id is elected as the root.
1533 <column name="other_config" key="rstp-port-path-cost"
1534 type='{"type": "integer"}'>
1535 The port path cost. The Port's contribution, when it is
1536 the Root Port, to the Root Path Cost for the Bridge. By default the
1537 cost is automatically calculated from the port's speed.
1540 <column name="other_config" key="rstp-port-admin-edge"
1541 type='{"type": "boolean"}'>
1542 The admin edge port parameter for the Port. Default is
1546 <column name="other_config" key="rstp-port-auto-edge"
1547 type='{"type": "boolean"}'>
1548 The auto edge port parameter for the Port. Default is
1552 <column name="other_config" key="rstp-port-mcheck"
1553 type='{"type": "boolean"}'>
1555 The mcheck port parameter for the Port. Default is
1556 <code>false</code>. May be set to force the Port Protocol
1557 Migration state machine to transmit RST BPDUs for a
1558 MigrateTime period, to test whether all STP Bridges on the
1559 attached LAN have been removed and the Port can continue to
1560 transmit RSTP BPDUs. Setting mcheck has no effect if the
1561 Bridge is operating in STP Compatibility mode.
1564 Changing the value from <code>true</code> to
1565 <code>false</code> has no effect, but needs to be done if
1566 this behavior is to be triggered again by subsequently
1567 changing the value from <code>false</code> to
1573 <group title="RSTP Status">
1574 <column name="rstp_status" key="rstp_port_id">
1575 The port ID used in spanning tree advertisements for this port, as 4
1576 hex digits. Configuring the port ID is described in the
1577 <code>rstp-port-num</code> and <code>rstp-port-priority</code> keys
1578 of the <code>other_config</code> section earlier.
1580 <column name="rstp_status" key="rstp_port_role"
1581 type='{"type": "string", "enum": ["set",
1582 ["Root", "Designated", "Alternate", "Backup", "Disabled"]]}'>
1583 RSTP role of the port.
1585 <column name="rstp_status" key="rstp_port_state"
1586 type='{"type": "string", "enum": ["set",
1587 ["Disabled", "Learning", "Forwarding", "Discarding"]]}'>
1588 RSTP state of the port.
1590 <column name="rstp_status" key="rstp_designated_bridge_id">
1591 The port's RSTP designated bridge ID, in the same form as <ref
1592 column="rstp_status" key="rstp_bridge_id"/> in the <ref
1593 table="Bridge"/> table.
1595 <column name="rstp_status" key="rstp_designated_port_id">
1596 The port's RSTP designated port ID, as 4 hex digits.
1598 <column name="rstp_status" key="rstp_designated_path_cost"
1599 type='{"type": "integer"}'>
1600 The port's RSTP designated path cost. Lower is better.
1604 <group title="RSTP Statistics">
1605 <column name="rstp_statistics" key="rstp_tx_count">
1606 Number of RSTP BPDUs transmitted through this port.
1608 <column name="rstp_statistics" key="rstp_rx_count">
1609 Number of valid RSTP BPDUs received by this port.
1611 <column name="rstp_statistics" key="rstp_error_count">
1612 Number of invalid RSTP BPDUs received by this port.
1614 <column name="rstp_statistics" key="rstp_uptime">
1615 The duration covered by the other RSTP statistics, in seconds.
1620 <group title="Multicast Snooping">
1621 <column name="other_config" key="mcast-snooping-flood"
1622 type='{"type": "boolean"}'>
1624 If set to <code>true</code>, multicast packets (except Reports) are
1625 unconditionally forwarded to the specific port.
1628 <column name="other_config" key="mcast-snooping-flood-reports"
1629 type='{"type": "boolean"}'>
1631 If set to <code>true</code>, multicast Reports are unconditionally
1632 forwarded to the specific port.
1637 <group title="Other Features">
1639 Quality of Service configuration for this port.
1643 The MAC address to use for this port for the purpose of choosing the
1644 bridge's MAC address. This column does not necessarily reflect the
1645 port's actual MAC address, nor will setting it change the port's actual
1649 <column name="fake_bridge">
1650 Does this port represent a sub-bridge for its tagged VLAN within the
1651 Bridge? See ovs-vsctl(8) for more information.
1654 <column name="external_ids" key="fake-bridge-id-*">
1655 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1656 column) are defined by prefixing a <ref table="Bridge"/> <ref
1657 table="Bridge" column="external_ids"/> key with
1658 <code>fake-bridge-</code>,
1659 e.g. <code>fake-bridge-xs-network-uuids</code>.
1663 <column name="bond_active_slave">
1664 For a bonded port, record the mac address of the current active slave.
1667 <group title="Port Statistics">
1669 Key-value pairs that report port statistics. The update period
1670 is controlled by <ref column="other_config"
1671 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1673 <group title="Statistics: STP transmit and receive counters">
1674 <column name="statistics" key="stp_tx_count">
1675 Number of STP BPDUs sent on this port by the spanning
1678 <column name="statistics" key="stp_rx_count">
1679 Number of STP BPDUs received on this port and accepted by the
1680 spanning tree library.
1682 <column name="statistics" key="stp_error_count">
1683 Number of bad STP BPDUs received on this port. Bad BPDUs
1684 include runt packets and those with an unexpected protocol ID.
1689 <group title="Common Columns">
1690 The overall purpose of these columns is described under <code>Common
1691 Columns</code> at the beginning of this document.
1693 <column name="other_config"/>
1694 <column name="external_ids"/>
1698 <table name="Interface" title="One physical network device in a Port.">
1699 An interface within a <ref table="Port"/>.
1701 <group title="Core Features">
1702 <column name="name">
1703 Interface name. Should be alphanumeric and no more than about 8 bytes
1704 long. May be the same as the port name, for non-bonded ports. Must
1705 otherwise be unique among the names of ports, interfaces, and bridges
1709 <column name="ifindex">
1710 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1711 2863, if the interface has one, otherwise 0. The ifindex is useful for
1712 seamless integration with protocols such as SNMP and sFlow.
1715 <column name="mac_in_use">
1716 The MAC address in use by this interface.
1720 <p>Ethernet address to set for this interface. If unset then the
1721 default MAC address is used:</p>
1723 <li>For the local interface, the default is the lowest-numbered MAC
1724 address among the other bridge ports, either the value of the
1725 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1726 if set, or its actual MAC (for bonded ports, the MAC of its slave
1727 whose name is first in alphabetical order). Internal ports and
1728 bridge ports that are used as port mirroring destinations (see the
1729 <ref table="Mirror"/> table) are ignored.</li>
1730 <li>For other internal interfaces, the default MAC is randomly
1732 <li>External interfaces typically have a MAC address associated with
1733 their hardware.</li>
1735 <p>Some interfaces may not have a software-controllable MAC
1739 <column name="error">
1740 If the configuration of the port failed, as indicated by -1 in <ref
1741 column="ofport"/>, Open vSwitch sets this column to an error
1742 description in human readable form. Otherwise, Open vSwitch clears
1746 <group title="OpenFlow Port Number">
1748 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1749 port number for the new port. If the client that adds the port fills
1750 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1751 value as the OpenFlow port number. Otherwise, or if the requested
1752 port number is already in use or cannot be used for another reason,
1753 Open vSwitch automatically assigns a free port number. Regardless of
1754 how the port number was obtained, Open vSwitch then reports in <ref
1755 column="ofport"/> the port number actually assigned.
1759 Open vSwitch limits the port numbers that it automatically assigns to
1760 the range 1 through 32,767, inclusive. Controllers therefore have
1761 free use of ports 32,768 and up.
1764 <column name="ofport">
1766 OpenFlow port number for this interface. Open vSwitch sets this
1767 column's value, so other clients should treat it as read-only.
1770 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1771 The other valid port numbers are in the range 1 to 65,279,
1772 inclusive. Value -1 indicates an error adding the interface.
1776 <column name="ofport_request"
1777 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1779 Requested OpenFlow port number for this interface.
1783 A client should ideally set this column's value in the same
1784 database transaction that it uses to create the interface. Open
1785 vSwitch version 2.1 and later will honor a later request for a
1786 specific port number, althuogh it might confuse some controllers:
1787 OpenFlow does not have a way to announce a port number change, so
1788 Open vSwitch represents it over OpenFlow as a port deletion
1789 followed immediately by a port addition.
1793 If <ref column="ofport_request"/> is set or changed to some other
1794 port's automatically assigned port number, Open vSwitch chooses a
1795 new port number for the latter port.
1801 <group title="System-Specific Details">
1802 <column name="type">
1804 The interface type. The types supported by a particular instance of
1805 Open vSwitch are listed in the <ref table="Open_vSwitch"
1806 column="iface_types"/> column in the <ref table="Open_vSwitch"/>
1807 table. The following types are defined:
1811 <dt><code>system</code></dt>
1812 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1813 Sometimes referred to as ``external interfaces'' since they are
1814 generally connected to hardware external to that on which the Open
1815 vSwitch is running. The empty string is a synonym for
1816 <code>system</code>.</dd>
1818 <dt><code>internal</code></dt>
1819 <dd>A simulated network device that sends and receives traffic. An
1820 internal interface whose <ref column="name"/> is the same as its
1821 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1822 ``local interface.'' It does not make sense to bond an internal
1823 interface, so the terms ``port'' and ``interface'' are often used
1824 imprecisely for internal interfaces.</dd>
1826 <dt><code>tap</code></dt>
1827 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1829 <dt><code>geneve</code></dt>
1831 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1834 Geneve supports options as a means to transport additional metadata,
1835 however, currently only the 24-bit VNI is supported. This is planned
1836 to be extended in the future.
1839 <dt><code>gre</code></dt>
1841 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1845 <dt><code>ipsec_gre</code></dt>
1847 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1851 <dt><code>gre64</code></dt>
1853 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1854 of key, it uses GRE protocol sequence number field. This is non
1855 standard use of GRE protocol since OVS does not increment
1856 sequence number for every packet at time of encap as expected by
1857 standard GRE implementation. See <ref group="Tunnel Options"/>
1858 for information on configuring GRE tunnels.
1861 <dt><code>ipsec_gre64</code></dt>
1863 Same as IPSEC_GRE except 64 bit key.
1866 <dt><code>vxlan</code></dt>
1869 An Ethernet tunnel over the UDP-based VXLAN protocol described in
1873 Open vSwitch uses UDP destination port 4789. The source port used for
1874 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1879 <dt><code>lisp</code></dt>
1882 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1883 Separation Protocol (RFC 6830).
1886 Only IPv4 and IPv6 packets are supported by the protocol, and
1887 they are sent and received without an Ethernet header. Traffic
1888 to/from LISP ports is expected to be configured explicitly, and
1889 the ports are not intended to participate in learning based
1890 switching. As such, they are always excluded from packet
1895 <dt><code>patch</code></dt>
1897 A pair of virtual devices that act as a patch cable.
1900 <dt><code>null</code></dt>
1901 <dd>An ignored interface. Deprecated and slated for removal in
1907 <group title="Tunnel Options">
1909 These options apply to interfaces with <ref column="type"/> of
1910 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1911 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1912 and <code>lisp</code>.
1916 Each tunnel must be uniquely identified by the combination of <ref
1917 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1918 column="options" key="local_ip"/>, and <ref column="options"
1919 key="in_key"/>. If two ports are defined that are the same except one
1920 has an optional identifier and the other does not, the more specific
1921 one is matched first. <ref column="options" key="in_key"/> is
1922 considered more specific than <ref column="options" key="local_ip"/> if
1923 a port defines one and another port defines the other.
1926 <column name="options" key="remote_ip">
1927 <p>Required. The remote tunnel endpoint, one of:</p>
1931 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1932 Only unicast endpoints are supported.
1935 The word <code>flow</code>. The tunnel accepts packets from any
1936 remote tunnel endpoint. To process only packets from a specific
1937 remote tunnel endpoint, the flow entries may match on the
1938 <code>tun_src</code> field. When sending packets to a
1939 <code>remote_ip=flow</code> tunnel, the flow actions must
1940 explicitly set the <code>tun_dst</code> field to the IP address of
1941 the desired remote tunnel endpoint, e.g. with a
1942 <code>set_field</code> action.
1947 The remote tunnel endpoint for any packet received from a tunnel
1948 is available in the <code>tun_src</code> field for matching in the
1953 <column name="options" key="local_ip">
1955 Optional. The tunnel destination IP that received packets must
1956 match. Default is to match all addresses. If specified, may be one
1962 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1965 The word <code>flow</code>. The tunnel accepts packets sent to any
1966 of the local IP addresses of the system running OVS. To process
1967 only packets sent to a specific IP address, the flow entries may
1968 match on the <code>tun_dst</code> field. When sending packets to a
1969 <code>local_ip=flow</code> tunnel, the flow actions may
1970 explicitly set the <code>tun_src</code> field to the desired IP
1971 address, e.g. with a <code>set_field</code> action. However, while
1972 routing the tunneled packet out, the local system may override the
1973 specified address with the local IP address configured for the
1974 outgoing system interface.
1977 This option is valid only for tunnels also configured with the
1978 <code>remote_ip=flow</code> option.
1984 The tunnel destination IP address for any packet received from a
1985 tunnel is available in the <code>tun_dst</code> field for matching in
1990 <column name="options" key="in_key">
1991 <p>Optional. The key that received packets must contain, one of:</p>
1995 <code>0</code>. The tunnel receives packets with no key or with a
1996 key of 0. This is equivalent to specifying no <ref column="options"
1997 key="in_key"/> at all.
2000 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
2001 or 64-bit (for GRE64) number. The tunnel receives only packets
2002 with the specified key.
2005 The word <code>flow</code>. The tunnel accepts packets with any
2006 key. The key will be placed in the <code>tun_id</code> field for
2007 matching in the flow table. The <code>ovs-ofctl</code> manual page
2008 contains additional information about matching fields in OpenFlow
2017 <column name="options" key="out_key">
2018 <p>Optional. The key to be set on outgoing packets, one of:</p>
2022 <code>0</code>. Packets sent through the tunnel will have no key.
2023 This is equivalent to specifying no <ref column="options"
2024 key="out_key"/> at all.
2027 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
2028 64-bit (for GRE64) number. Packets sent through the tunnel will
2029 have the specified key.
2032 The word <code>flow</code>. Packets sent through the tunnel will
2033 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
2034 vendor extension (0 is used in the absence of an action). The
2035 <code>ovs-ofctl</code> manual page contains additional information
2036 about the Nicira OpenFlow vendor extensions.
2041 <column name="options" key="key">
2042 Optional. Shorthand to set <code>in_key</code> and
2043 <code>out_key</code> at the same time.
2046 <column name="options" key="tos">
2047 Optional. The value of the ToS bits to be set on the encapsulating
2048 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2049 zero. It may also be the word <code>inherit</code>, in which case
2050 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2051 (otherwise it will be 0). The ECN fields are always inherited.
2055 <column name="options" key="ttl">
2056 Optional. The TTL to be set on the encapsulating packet. It may also
2057 be the word <code>inherit</code>, in which case the TTL will be copied
2058 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2059 system default, typically 64). Default is the system default TTL.
2062 <column name="options" key="df_default"
2063 type='{"type": "boolean"}'>
2064 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2065 outer headers to allow path MTU discovery. Default is enabled; set
2066 to <code>false</code> to disable.
2069 <group title="Tunnel Options: vxlan only">
2071 <column name="options" key="exts">
2072 <p>Optional. Comma separated list of optional VXLAN extensions to
2073 enable. The following extensions are supported:</p>
2077 <code>gbp</code>: VXLAN-GBP allows to transport the group policy
2078 context of a packet across the VXLAN tunnel to other network
2079 peers. See the field description of <code>tun_gbp_id</code> and
2080 <code>tun_gbp_flags</code> in ovs-ofctl(8) for additional
2082 (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>)
2089 <group title="Tunnel Options: gre, ipsec_gre, geneve, and vxlan">
2091 <code>gre</code>, <code>ipsec_gre</code>, <code>geneve</code>, and
2092 <code>vxlan</code> interfaces support these options.
2095 <column name="options" key="csum" type='{"type": "boolean"}'>
2097 Optional. Compute encapsulation header (either GRE or UDP)
2098 checksums on outgoing packets. Default is disabled, set to
2099 <code>true</code> to enable. Checksums present on incoming
2100 packets will be validated regardless of this setting.
2104 When using the upstream Linux kernel module, computation of
2105 checksums for <code>geneve</code> and <code>vxlan</code> requires
2106 Linux kernel version 4.0 or higher. <code>gre</code> supports
2107 checksums for all versions of Open vSwitch that support GRE.
2108 The out of tree kernel module distributed as part of OVS
2109 can compute all tunnel checksums on any kernel version that it
2114 This option is supported for <code>ipsec_gre</code>, but not useful
2115 because GRE checksums are weaker than, and redundant with, IPsec
2116 payload authentication.
2121 <group title="Tunnel Options: ipsec_gre only">
2123 Only <code>ipsec_gre</code> interfaces support these options.
2126 <column name="options" key="peer_cert">
2127 Required for certificate authentication. A string containing the
2128 peer's certificate in PEM format. Additionally the host's
2129 certificate must be specified with the <code>certificate</code>
2133 <column name="options" key="certificate">
2134 Required for certificate authentication. The name of a PEM file
2135 containing a certificate that will be presented to the peer during
2139 <column name="options" key="private_key">
2140 Optional for certificate authentication. The name of a PEM file
2141 containing the private key associated with <code>certificate</code>.
2142 If <code>certificate</code> contains the private key, this option may
2146 <column name="options" key="psk">
2147 Required for pre-shared key authentication. Specifies a pre-shared
2148 key for authentication that must be identical on both sides of the
2154 <group title="Patch Options">
2156 Only <code>patch</code> interfaces support these options.
2159 <column name="options" key="peer">
2160 The <ref column="name"/> of the <ref table="Interface"/> for the other
2161 side of the patch. The named <ref table="Interface"/>'s own
2162 <code>peer</code> option must specify this <ref table="Interface"/>'s
2163 name. That is, the two patch interfaces must have reversed <ref
2164 column="name"/> and <code>peer</code> values.
2168 <group title="Interface Status">
2170 Status information about interfaces attached to bridges, updated every
2171 5 seconds. Not all interfaces have all of these properties; virtual
2172 interfaces don't have a link speed, for example. Non-applicable
2173 columns will have empty values.
2175 <column name="admin_state">
2177 The administrative state of the physical network link.
2181 <column name="link_state">
2183 The observed state of the physical network link. This is ordinarily
2184 the link's carrier status. If the interface's <ref table="Port"/> is
2185 a bond configured for miimon monitoring, it is instead the network
2186 link's miimon status.
2190 <column name="link_resets">
2192 The number of times Open vSwitch has observed the
2193 <ref column="link_state"/> of this <ref table="Interface"/> change.
2197 <column name="link_speed">
2199 The negotiated speed of the physical network link.
2200 Valid values are positive integers greater than 0.
2204 <column name="duplex">
2206 The duplex mode of the physical network link.
2212 The MTU (maximum transmission unit); i.e. the largest
2213 amount of data that can fit into a single Ethernet frame.
2214 The standard Ethernet MTU is 1500 bytes. Some physical media
2215 and many kinds of virtual interfaces can be configured with
2219 This column will be empty for an interface that does not
2220 have an MTU as, for example, some kinds of tunnels do not.
2224 <column name="lacp_current">
2225 Boolean value indicating LACP status for this interface. If true, this
2226 interface has current LACP information about its LACP partner. This
2227 information may be used to monitor the health of interfaces in a LACP
2228 enabled port. This column will be empty if LACP is not enabled.
2231 <column name="status">
2232 Key-value pairs that report port status. Supported status values are
2233 <ref column="type"/>-dependent; some interfaces may not have a valid
2234 <ref column="status" key="driver_name"/>, for example.
2237 <column name="status" key="driver_name">
2238 The name of the device driver controlling the network adapter.
2241 <column name="status" key="driver_version">
2242 The version string of the device driver controlling the network
2246 <column name="status" key="firmware_version">
2247 The version string of the network adapter's firmware, if available.
2250 <column name="status" key="source_ip">
2251 The source IP address used for an IPv4 tunnel end-point, such as
2255 <column name="status" key="tunnel_egress_iface">
2256 Egress interface for tunnels. Currently only relevant for tunnels
2257 on Linux systems, this column will show the name of the interface
2258 which is responsible for routing traffic destined for the configured
2259 <ref column="options" key="remote_ip"/>. This could be an internal
2260 interface such as a bridge port.
2263 <column name="status" key="tunnel_egress_iface_carrier"
2264 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2265 Whether carrier is detected on <ref column="status"
2266 key="tunnel_egress_iface"/>.
2270 <group title="Statistics">
2272 Key-value pairs that report interface statistics. The current
2273 implementation updates these counters periodically. The update period
2274 is controlled by <ref column="other_config"
2275 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2276 Future implementations may update them when an interface is created,
2277 when they are queried (e.g. using an OVSDB <code>select</code>
2278 operation), and just before an interface is deleted due to virtual
2279 interface hot-unplug or VM shutdown, and perhaps at other times, but
2280 not on any regular periodic basis.
2283 These are the same statistics reported by OpenFlow in its <code>struct
2284 ofp_port_stats</code> structure. If an interface does not support a
2285 given statistic, then that pair is omitted.
2287 <group title="Statistics: Successful transmit and receive counters">
2288 <column name="statistics" key="rx_packets">
2289 Number of received packets.
2291 <column name="statistics" key="rx_bytes">
2292 Number of received bytes.
2294 <column name="statistics" key="tx_packets">
2295 Number of transmitted packets.
2297 <column name="statistics" key="tx_bytes">
2298 Number of transmitted bytes.
2301 <group title="Statistics: Receive errors">
2302 <column name="statistics" key="rx_dropped">
2303 Number of packets dropped by RX.
2305 <column name="statistics" key="rx_frame_err">
2306 Number of frame alignment errors.
2308 <column name="statistics" key="rx_over_err">
2309 Number of packets with RX overrun.
2311 <column name="statistics" key="rx_crc_err">
2312 Number of CRC errors.
2314 <column name="statistics" key="rx_errors">
2315 Total number of receive errors, greater than or equal to the sum of
2319 <group title="Statistics: Transmit errors">
2320 <column name="statistics" key="tx_dropped">
2321 Number of packets dropped by TX.
2323 <column name="statistics" key="collisions">
2324 Number of collisions.
2326 <column name="statistics" key="tx_errors">
2327 Total number of transmit errors, greater than or equal to the sum of
2333 <group title="Ingress Policing">
2335 These settings control ingress policing for packets received on this
2336 interface. On a physical interface, this limits the rate at which
2337 traffic is allowed into the system from the outside; on a virtual
2338 interface (one connected to a virtual machine), this limits the rate at
2339 which the VM is able to transmit.
2342 Policing is a simple form of quality-of-service that simply drops
2343 packets received in excess of the configured rate. Due to its
2344 simplicity, policing is usually less accurate and less effective than
2345 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2346 table="Queue"/> tables).
2349 Policing is currently implemented only on Linux. The Linux
2350 implementation uses a simple ``token bucket'' approach:
2354 The size of the bucket corresponds to <ref
2355 column="ingress_policing_burst"/>. Initially the bucket is full.
2358 Whenever a packet is received, its size (converted to tokens) is
2359 compared to the number of tokens currently in the bucket. If the
2360 required number of tokens are available, they are removed and the
2361 packet is forwarded. Otherwise, the packet is dropped.
2364 Whenever it is not full, the bucket is refilled with tokens at the
2365 rate specified by <ref column="ingress_policing_rate"/>.
2369 Policing interacts badly with some network protocols, and especially
2370 with fragmented IP packets. Suppose that there is enough network
2371 activity to keep the bucket nearly empty all the time. Then this token
2372 bucket algorithm will forward a single packet every so often, with the
2373 period depending on packet size and on the configured rate. All of the
2374 fragments of an IP packets are normally transmitted back-to-back, as a
2375 group. In such a situation, therefore, only one of these fragments
2376 will be forwarded and the rest will be dropped. IP does not provide
2377 any way for the intended recipient to ask for only the remaining
2378 fragments. In such a case there are two likely possibilities for what
2379 will happen next: either all of the fragments will eventually be
2380 retransmitted (as TCP will do), in which case the same problem will
2381 recur, or the sender will not realize that its packet has been dropped
2382 and data will simply be lost (as some UDP-based protocols will do).
2383 Either way, it is possible that no forward progress will ever occur.
2385 <column name="ingress_policing_rate">
2387 Maximum rate for data received on this interface, in kbps. Data
2388 received faster than this rate is dropped. Set to <code>0</code>
2389 (the default) to disable policing.
2393 <column name="ingress_policing_burst">
2394 <p>Maximum burst size for data received on this interface, in kb. The
2395 default burst size if set to <code>0</code> is 1000 kb. This value
2396 has no effect if <ref column="ingress_policing_rate"/>
2397 is <code>0</code>.</p>
2399 Specifying a larger burst size lets the algorithm be more forgiving,
2400 which is important for protocols like TCP that react severely to
2401 dropped packets. The burst size should be at least the size of the
2402 interface's MTU. Specifying a value that is numerically at least as
2403 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2404 closer to achieving the full rate.
2409 <group title="Bidirectional Forwarding Detection (BFD)">
2411 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2412 detection of connectivity failures by occasional transmission of
2413 BFD control messages. Open vSwitch implements BFD to serve
2414 as a more popular and standards compliant alternative to CFM.
2418 BFD operates by regularly transmitting BFD control messages at a rate
2419 negotiated independently in each direction. Each endpoint specifies
2420 the rate at which it expects to receive control messages, and the rate
2421 at which it is willing to transmit them. Open vSwitch uses a detection
2422 multiplier of three, meaning that an endpoint signals a connectivity
2423 fault if three consecutive BFD control messages fail to arrive. In the
2424 case of a unidirectional connectivity issue, the system not receiving
2425 BFD control messages signals the problem to its peer in the messages it
2430 The Open vSwitch implementation of BFD aims to comply faithfully
2431 with RFC 5880 requirements. Open vSwitch does not implement the
2432 optional Authentication or ``Echo Mode'' features.
2435 <group title="BFD Configuration">
2437 A controller sets up key-value pairs in the <ref column="bfd"/>
2438 column to enable and configure BFD.
2441 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2442 True to enable BFD on this <ref table="Interface"/>. If not
2443 specified, BFD will not be enabled by default.
2446 <column name="bfd" key="min_rx"
2447 type='{"type": "integer", "minInteger": 1}'>
2448 The shortest interval, in milliseconds, at which this BFD session
2449 offers to receive BFD control messages. The remote endpoint may
2450 choose to send messages at a slower rate. Defaults to
2454 <column name="bfd" key="min_tx"
2455 type='{"type": "integer", "minInteger": 1}'>
2456 The shortest interval, in milliseconds, at which this BFD session is
2457 willing to transmit BFD control messages. Messages will actually be
2458 transmitted at a slower rate if the remote endpoint is not willing to
2459 receive as quickly as specified. Defaults to <code>100</code>.
2462 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2463 An alternate receive interval, in milliseconds, that must be greater
2464 than or equal to <ref column="bfd" key="min_rx"/>. The
2465 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2466 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2467 data traffic at the interface, to reduce the CPU and bandwidth cost
2468 of monitoring an idle interface. This feature may be disabled by
2469 setting a value of 0. This feature is reset whenever <ref
2470 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2474 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2475 When <code>true</code>, traffic received on the
2476 <ref table="Interface"/> is used to indicate the capability of packet
2477 I/O. BFD control packets are still transmitted and received. At
2478 least one BFD control packet must be received every 100 * <ref
2479 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2480 traffic are received, the <ref column="bfd" key="forwarding"/>
2481 will be <code>false</code>.
2484 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2485 Set to true to notify the remote endpoint that traffic should not be
2486 forwarded to this system for some reason other than a connectivty
2487 failure on the interface being monitored. The typical underlying
2488 reason is ``concatenated path down,'' that is, that connectivity
2489 beyond the local system is down. Defaults to false.
2492 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2493 Set to true to make BFD accept only control messages with a tunnel
2494 key of zero. By default, BFD accepts control messages with any
2498 <column name="bfd" key="bfd_local_src_mac">
2499 Set to an Ethernet address in the form
2500 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2501 to set the MAC used as source for transmitted BFD packets. The
2502 default is the mac address of the BFD enabled interface.
2505 <column name="bfd" key="bfd_local_dst_mac">
2506 Set to an Ethernet address in the form
2507 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2508 to set the MAC used as destination for transmitted BFD packets. The
2509 default is <code>00:23:20:00:00:01</code>.
2512 <column name="bfd" key="bfd_remote_dst_mac">
2513 Set to an Ethernet address in the form
2514 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2515 to set the MAC used for checking the destination of received BFD packets.
2516 Packets with different destination MAC will not be considered as BFD packets.
2517 If not specified the destination MAC address of received BFD packets
2521 <column name="bfd" key="bfd_src_ip">
2522 Set to an IPv4 address to set the IP address used as source for
2523 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2526 <column name="bfd" key="bfd_dst_ip">
2527 Set to an IPv4 address to set the IP address used as destination
2528 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2532 <group title="BFD Status">
2534 The switch sets key-value pairs in the <ref column="bfd_status"/>
2535 column to report the status of BFD on this interface. When BFD is
2536 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2537 all key-value pairs from <ref column="bfd_status"/>.
2540 <column name="bfd_status" key="state"
2541 type='{"type": "string",
2542 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2543 Reports the state of the BFD session. The BFD session is fully
2544 healthy and negotiated if <code>UP</code>.
2547 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2548 Reports whether the BFD session believes this <ref
2549 table="Interface"/> may be used to forward traffic. Typically this
2550 means the local session is signaling <code>UP</code>, and the remote
2551 system isn't signaling a problem such as concatenated path down.
2554 <column name="bfd_status" key="diagnostic">
2555 In case of a problem, set to an error message that reports what the
2556 local BFD session thinks is wrong. The error messages are defined
2557 in section 4.1 of [RFC 5880].
2560 <column name="bfd_status" key="remote_state"
2561 type='{"type": "string",
2562 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2563 Reports the state of the remote endpoint's BFD session.
2566 <column name="bfd_status" key="remote_diagnostic">
2567 In case of a problem, set to an error message that reports what the
2568 remote endpoint's BFD session thinks is wrong. The error messages
2569 are defined in section 4.1 of [RFC 5880].
2572 <column name="bfd_status" key="flap_count"
2573 type='{"type": "integer", "minInteger": 0}'>
2574 Counts the number of <ref column="bfd_status" key="forwarding" />
2575 flaps since start. A flap is considered as a change of the
2576 <ref column="bfd_status" key="forwarding" /> value.
2581 <group title="Connectivity Fault Management">
2583 802.1ag Connectivity Fault Management (CFM) allows a group of
2584 Maintenance Points (MPs) called a Maintenance Association (MA) to
2585 detect connectivity problems with each other. MPs within a MA should
2586 have complete and exclusive interconnectivity. This is verified by
2587 occasionally broadcasting Continuity Check Messages (CCMs) at a
2588 configurable transmission interval.
2592 According to the 802.1ag specification, each Maintenance Point should
2593 be configured out-of-band with a list of Remote Maintenance Points it
2594 should have connectivity to. Open vSwitch differs from the
2595 specification in this area. It simply assumes the link is faulted if
2596 no Remote Maintenance Points are reachable, and considers it not
2601 When operating over tunnels which have no <code>in_key</code>, or an
2602 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2603 with a tunnel key of zero.
2606 <column name="cfm_mpid">
2608 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2609 within a Maintenance Association. The MPID is used to identify this
2610 endpoint to other Maintenance Points in the MA. Each end of a link
2611 being monitored should have a different MPID. Must be configured to
2612 enable CFM on this <ref table="Interface"/>.
2615 According to the 802.1ag specification, MPIDs can only range between
2616 [1, 8191]. However, extended mode (see <ref column="other_config"
2617 key="cfm_extended"/>) supports eight byte MPIDs.
2621 <column name="cfm_flap_count">
2622 Counts the number of cfm fault flapps since boot. A flap is
2623 considered to be a change of the <ref column="cfm_fault"/> value.
2626 <column name="cfm_fault">
2628 Indicates a connectivity fault triggered by an inability to receive
2629 heartbeats from any remote endpoint. When a fault is triggered on
2630 <ref table="Interface"/>s participating in bonds, they will be
2634 Faults can be triggered for several reasons. Most importantly they
2635 are triggered when no CCMs are received for a period of 3.5 times the
2636 transmission interval. Faults are also triggered when any CCMs
2637 indicate that a Remote Maintenance Point is not receiving CCMs but
2638 able to send them. Finally, a fault is triggered if a CCM is
2639 received which indicates unexpected configuration. Notably, this
2640 case arises when a CCM is received which advertises the local MPID.
2644 <column name="cfm_fault_status" key="recv">
2645 Indicates a CFM fault was triggered due to a lack of CCMs received on
2646 the <ref table="Interface"/>.
2649 <column name="cfm_fault_status" key="rdi">
2650 Indicates a CFM fault was triggered due to the reception of a CCM with
2651 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2652 are not receiving CCMs themselves. This typically indicates a
2653 unidirectional connectivity failure.
2656 <column name="cfm_fault_status" key="maid">
2657 Indicates a CFM fault was triggered due to the reception of a CCM with
2658 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2659 with an identification number in addition to the MPID called the MAID.
2660 Open vSwitch only supports receiving CCM broadcasts tagged with the
2661 MAID it uses internally.
2664 <column name="cfm_fault_status" key="loopback">
2665 Indicates a CFM fault was triggered due to the reception of a CCM
2666 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2667 column of this <ref table="Interface"/>. This may indicate a loop in
2671 <column name="cfm_fault_status" key="overflow">
2672 Indicates a CFM fault was triggered because the CFM module received
2673 CCMs from more remote endpoints than it can keep track of.
2676 <column name="cfm_fault_status" key="override">
2677 Indicates a CFM fault was manually triggered by an administrator using
2678 an <code>ovs-appctl</code> command.
2681 <column name="cfm_fault_status" key="interval">
2682 Indicates a CFM fault was triggered due to the reception of a CCM
2683 frame having an invalid interval.
2686 <column name="cfm_remote_opstate">
2687 <p>When in extended mode, indicates the operational state of the
2688 remote endpoint as either <code>up</code> or <code>down</code>. See
2689 <ref column="other_config" key="cfm_opstate"/>.
2693 <column name="cfm_health">
2695 Indicates the health of the interface as a percentage of CCM frames
2696 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2697 The health of an interface is undefined if it is communicating with
2698 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2699 healthy heartbeats are not received at the expected rate, and
2700 gradually improves as healthy heartbeats are received at the desired
2701 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2702 health of the interface is refreshed.
2705 As mentioned above, the faults can be triggered for several reasons.
2706 The link health will deteriorate even if heartbeats are received but
2707 they are reported to be unhealthy. An unhealthy heartbeat in this
2708 context is a heartbeat for which either some fault is set or is out
2709 of sequence. The interface health can be 100 only on receiving
2710 healthy heartbeats at the desired rate.
2714 <column name="cfm_remote_mpids">
2715 When CFM is properly configured, Open vSwitch will occasionally
2716 receive CCM broadcasts. These broadcasts contain the MPID of the
2717 sending Maintenance Point. The list of MPIDs from which this
2718 <ref table="Interface"/> is receiving broadcasts from is regularly
2719 collected and written to this column.
2722 <column name="other_config" key="cfm_interval"
2723 type='{"type": "integer"}'>
2725 The interval, in milliseconds, between transmissions of CFM
2726 heartbeats. Three missed heartbeat receptions indicate a
2731 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2732 60,000, or 600,000 ms are supported. Other values will be rounded
2733 down to the nearest value on the list. Extended mode (see <ref
2734 column="other_config" key="cfm_extended"/>) supports any interval up
2735 to 65,535 ms. In either mode, the default is 1000 ms.
2738 <p>We do not recommend using intervals less than 100 ms.</p>
2741 <column name="other_config" key="cfm_extended"
2742 type='{"type": "boolean"}'>
2743 When <code>true</code>, the CFM module operates in extended mode. This
2744 causes it to use a nonstandard destination address to avoid conflicting
2745 with compliant implementations which may be running concurrently on the
2746 network. Furthermore, extended mode increases the accuracy of the
2747 <code>cfm_interval</code> configuration parameter by breaking wire
2748 compatibility with 802.1ag compliant implementations. And extended
2749 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2752 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2754 When <code>true</code>, and
2755 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2756 module operates in demand mode. When in demand mode, traffic
2757 received on the <ref table="Interface"/> is used to indicate
2758 liveness. CCMs are still transmitted and received. At least one
2759 CCM must be received every 100 * <ref column="other_config"
2760 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2761 are received, the CFM module will raise the connectivity fault.
2765 Demand mode has a couple of caveats:
2768 To ensure that ovs-vswitchd has enough time to pull statistics
2769 from the datapath, the fault detection interval is set to
2770 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2775 To avoid ambiguity, demand mode disables itself when there are
2776 multiple remote maintenance points.
2780 If the <ref table="Interface"/> is heavily congested, CCMs
2781 containing the <ref column="other_config" key="cfm_opstate"/>
2782 status may be dropped causing changes in the operational state to
2783 be delayed. Similarly, if CCMs containing the RDI bit are not
2784 received, unidirectional link failures may not be detected.
2790 <column name="other_config" key="cfm_opstate"
2791 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2792 When <code>down</code>, the CFM module marks all CCMs it generates as
2793 operationally down without triggering a fault. This allows remote
2794 maintenance points to choose not to forward traffic to the
2795 <ref table="Interface"/> on which this CFM module is running.
2796 Currently, in Open vSwitch, the opdown bit of CCMs affects
2797 <ref table="Interface"/>s participating in bonds, and the bundle
2798 OpenFlow action. This setting is ignored when CFM is not in extended
2799 mode. Defaults to <code>up</code>.
2802 <column name="other_config" key="cfm_ccm_vlan"
2803 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2804 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2805 with the given value. May be the string <code>random</code> in which
2806 case each CCM will be tagged with a different randomly generated VLAN.
2809 <column name="other_config" key="cfm_ccm_pcp"
2810 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2811 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2812 with the given PCP value, the VLAN ID of the tag is governed by the
2813 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2814 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2820 <group title="Bonding Configuration">
2821 <column name="other_config" key="lacp-port-id"
2822 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2823 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2824 used in LACP negotiations to identify individual ports
2825 participating in a bond.
2828 <column name="other_config" key="lacp-port-priority"
2829 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2830 The LACP port priority of this <ref table="Interface"/>. In LACP
2831 negotiations <ref table="Interface"/>s with numerically lower
2832 priorities are preferred for aggregation.
2835 <column name="other_config" key="lacp-aggregation-key"
2836 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2837 The LACP aggregation key of this <ref table="Interface"/>. <ref
2838 table="Interface"/>s with different aggregation keys may not be active
2839 within a given <ref table="Port"/> at the same time.
2843 <group title="Virtual Machine Identifiers">
2845 These key-value pairs specifically apply to an interface that
2846 represents a virtual Ethernet interface connected to a virtual
2847 machine. These key-value pairs should not be present for other types
2848 of interfaces. Keys whose names end in <code>-uuid</code> have
2849 values that uniquely identify the entity in question. For a Citrix
2850 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2851 Other hypervisors may use other formats.
2854 <column name="external_ids" key="attached-mac">
2855 The MAC address programmed into the ``virtual hardware'' for this
2856 interface, in the form
2857 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2858 For Citrix XenServer, this is the value of the <code>MAC</code> field
2859 in the VIF record for this interface.
2862 <column name="external_ids" key="iface-id">
2863 A system-unique identifier for the interface. On XenServer, this will
2864 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2867 <column name="external_ids" key="iface-status"
2868 type='{"type": "string",
2869 "enum": ["set", ["active", "inactive"]]}'>
2871 Hypervisors may sometimes have more than one interface associated
2872 with a given <ref column="external_ids" key="iface-id"/>, only one of
2873 which is actually in use at a given time. For example, in some
2874 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2875 for a single <ref column="external_ids" key="iface-id"/>, but only
2876 uses one of them at a time. A hypervisor that behaves this way must
2877 mark the currently in use interface <code>active</code> and the
2878 others <code>inactive</code>. A hypervisor that never has more than
2879 one interface for a given <ref column="external_ids" key="iface-id"/>
2880 may mark that interface <code>active</code> or omit <ref
2881 column="external_ids" key="iface-status"/> entirely.
2885 During VM migration, a given <ref column="external_ids"
2886 key="iface-id"/> might transiently be marked <code>active</code> on
2887 two different hypervisors. That is, <code>active</code> means that
2888 this <ref column="external_ids" key="iface-id"/> is the active
2889 instance within a single hypervisor, not in a broader scope.
2890 There is one exception: some hypervisors support ``migration'' from a
2891 given hypervisor to itself (most often for test purposes). During
2892 such a ``migration,'' two instances of a single <ref
2893 column="external_ids" key="iface-id"/> might both be briefly marked
2894 <code>active</code> on a single hypervisor.
2898 <column name="external_ids" key="xs-vif-uuid">
2899 The virtual interface associated with this interface.
2902 <column name="external_ids" key="xs-network-uuid">
2903 The virtual network to which this interface is attached.
2906 <column name="external_ids" key="vm-id">
2907 The VM to which this interface belongs. On XenServer, this will be the
2908 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2911 <column name="external_ids" key="xs-vm-uuid">
2912 The VM to which this interface belongs.
2916 <group title="VLAN Splinters">
2918 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2919 with buggy network drivers in old versions of Linux that do not
2920 properly support VLANs when VLAN devices are not used, at some cost
2921 in memory and performance.
2925 When VLAN splinters are enabled on a particular interface, Open vSwitch
2926 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2927 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2928 received on the VLAN device is treated as if it had been received on
2929 the interface on the particular VLAN.
2933 VLAN splinters consider a VLAN to be in use if:
2938 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2939 table="Port"/> record.
2943 The VLAN is listed within the <ref table="Port" column="trunks"/>
2944 column of the <ref table="Port"/> record of an interface on which
2945 VLAN splinters are enabled.
2947 An empty <ref table="Port" column="trunks"/> does not influence the
2948 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2949 will exceed the current 1,024 port per datapath limit.
2953 An OpenFlow flow within any bridge matches the VLAN.
2958 The same set of in-use VLANs applies to every interface on which VLAN
2959 splinters are enabled. That is, the set is not chosen separately for
2960 each interface but selected once as the union of all in-use VLANs based
2965 It does not make sense to enable VLAN splinters on an interface for an
2966 access port, or on an interface that is not a physical port.
2970 VLAN splinters are deprecated. When broken device drivers are no
2971 longer in widespread use, we will delete this feature.
2974 <column name="other_config" key="enable-vlan-splinters"
2975 type='{"type": "boolean"}'>
2977 Set to <code>true</code> to enable VLAN splinters on this interface.
2978 Defaults to <code>false</code>.
2982 VLAN splinters increase kernel and userspace memory overhead, so do
2983 not use them unless they are needed.
2987 VLAN splinters do not support 802.1p priority tags. Received
2988 priorities will appear to be 0, regardless of their actual values,
2989 and priorities on transmitted packets will also be cleared to 0.
2994 <group title="Auto Attach Configuration">
2996 Auto Attach configuration for a particular interface.
2999 <column name="lldp" key="enable" type='{"type": "boolean"}'>
3000 True to enable LLDP on this <ref table="Interface"/>. If not
3001 specified, LLDP will be disabled by default.
3005 <group title="Common Columns">
3006 The overall purpose of these columns is described under <code>Common
3007 Columns</code> at the beginning of this document.
3009 <column name="other_config"/>
3010 <column name="external_ids"/>
3014 <table name="Flow_Table" title="OpenFlow table configuration">
3015 <p>Configuration for a particular OpenFlow table.</p>
3017 <column name="name">
3018 The table's name. Set this column to change the name that controllers
3019 will receive when they request table statistics, e.g. <code>ovs-ofctl
3020 dump-tables</code>. The name does not affect switch behavior.
3023 <column name="flow_limit">
3024 If set, limits the number of flows that may be added to the table. Open
3025 vSwitch may limit the number of flows in a table for other reasons,
3026 e.g. due to hardware limitations or for resource availability or
3027 performance reasons.
3030 <column name="overflow_policy">
3032 Controls the switch's behavior when an OpenFlow flow table modification
3033 request would add flows in excess of <ref column="flow_limit"/>. The
3034 supported values are:
3038 <dt><code>refuse</code></dt>
3040 Refuse to add the flow or flows. This is also the default policy
3041 when <ref column="overflow_policy"/> is unset.
3044 <dt><code>evict</code></dt>
3046 Delete the flow that will expire soonest. See <ref column="groups"/>
3052 <column name="groups">
3054 When <ref column="overflow_policy"/> is <code>evict</code>, this
3055 controls how flows are chosen for eviction when the flow table would
3056 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
3057 of NXM fields or sub-fields, each of which takes one of the forms
3058 <code><var>field</var>[]</code> or
3059 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
3060 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
3061 <code>nicira-ext.h</code> for a complete list of NXM field names.
3065 When a flow must be evicted due to overflow, the flow to evict is
3066 chosen through an approximation of the following algorithm:
3071 Divide the flows in the table into groups based on the values of the
3072 specified fields or subfields, so that all of the flows in a given
3073 group have the same values for those fields. If a flow does not
3074 specify a given field, that field's value is treated as 0.
3078 Consider the flows in the largest group, that is, the group that
3079 contains the greatest number of flows. If two or more groups all
3080 have the same largest number of flows, consider the flows in all of
3085 Among the flows under consideration, choose the flow that expires
3086 soonest for eviction.
3091 The eviction process only considers flows that have an idle timeout or
3092 a hard timeout. That is, eviction never deletes permanent flows.
3093 (Permanent flows do count against <ref column="flow_limit"/>.)
3097 Open vSwitch ignores any invalid or unknown field specifications.
3101 When <ref column="overflow_policy"/> is not <code>evict</code>, this
3102 column has no effect.
3106 <column name="prefixes">
3108 This string set specifies which fields should be used for
3109 address prefix tracking. Prefix tracking allows the
3110 classifier to skip rules with longer than necessary prefixes,
3111 resulting in better wildcarding for datapath flows.
3114 Prefix tracking may be beneficial when a flow table contains
3115 matches on IP address fields with different prefix lengths.
3116 For example, when a flow table contains IP address matches on
3117 both full addresses and proper prefixes, the full address
3118 matches will typically cause the datapath flow to un-wildcard
3119 the whole address field (depending on flow entry priorities).
3120 In this case each packet with a different address gets handed
3121 to the userspace for flow processing and generates its own
3122 datapath flow. With prefix tracking enabled for the address
3123 field in question packets with addresses matching shorter
3124 prefixes would generate datapath flows where the irrelevant
3125 address bits are wildcarded, allowing the same datapath flow
3126 to handle all the packets within the prefix in question. In
3127 this case many userspace upcalls can be avoided and the
3128 overall performance can be better.
3131 This is a performance optimization only, so packets will
3132 receive the same treatment with or without prefix tracking.
3135 The supported fields are: <code>tun_id</code>,
3136 <code>tun_src</code>, <code>tun_dst</code>,
3137 <code>nw_src</code>, <code>nw_dst</code> (or aliases
3138 <code>ip_src</code> and <code>ip_dst</code>),
3139 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
3140 feature for <code>tun_id</code> would only make sense if the
3141 tunnel IDs have prefix structure similar to IP addresses.)
3145 By default, the <code>prefixes=ip_dst,ip_src</code> are used
3146 on each flow table. This instructs the flow classifier to
3147 track the IP destination and source addresses used by the
3148 rules in this specific flow table.
3152 The keyword <code>none</code> is recognized as an explicit
3153 override of the default values, causing no prefix fields to be
3158 To set the prefix fields, the flow table record needs to
3163 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
3165 Creates a flow table record for the OpenFlow table number 0.
3168 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
3170 Enables prefix tracking for IP source and destination
3176 There is a maximum number of fields that can be enabled for any
3177 one flow table. Currently this limit is 3.
3181 <group title="Common Columns">
3182 The overall purpose of these columns is described under <code>Common
3183 Columns</code> at the beginning of this document.
3185 <column name="external_ids"/>
3189 <table name="QoS" title="Quality of Service configuration">
3190 <p>Quality of Service (QoS) configuration for each Port that
3193 <column name="type">
3194 <p>The type of QoS to implement. The currently defined types are
3197 <dt><code>linux-htb</code></dt>
3199 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
3200 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
3201 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
3202 for information on how this classifier works and how to configure it.
3206 <dt><code>linux-hfsc</code></dt>
3208 Linux "Hierarchical Fair Service Curve" classifier.
3209 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
3210 information on how this classifier works.
3214 <dt><code>linux-sfq</code></dt>
3216 Linux ``Stochastic Fairness Queueing'' classifier. See
3217 <code>tc-sfq</code>(8) (also at
3218 <code>http://linux.die.net/man/8/tc-sfq</code>) for information on
3219 how this classifier works.
3223 <dt><code>linux-codel</code></dt>
3225 Linux ``Controlled Delay'' classifier. See <code>tc-codel</code>(8)
3227 <code>http://man7.org/linux/man-pages/man8/tc-codel.8.html</code>)
3228 for information on how this classifier works.
3232 <dt><code>linux-fq_codel</code></dt>
3234 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3235 <code>tc-fq_codel</code>(8) (also at
3236 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel.8.html</code>)
3237 for information on how this classifier works.
3242 <column name="queues">
3243 <p>A map from queue numbers to <ref table="Queue"/> records. The
3244 supported range of queue numbers depend on <ref column="type"/>. The
3245 queue numbers are the same as the <code>queue_id</code> used in
3246 OpenFlow in <code>struct ofp_action_enqueue</code> and other
3250 Queue 0 is the ``default queue.'' It is used by OpenFlow output
3251 actions when no specific queue has been set. When no configuration for
3252 queue 0 is present, it is automatically configured as if a <ref
3253 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
3254 and <ref table="Queue" column="other_config"/> columns had been
3256 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
3257 this case. With some queuing disciplines, this dropped all packets
3258 destined for the default queue.)
3262 <group title="Configuration for linux-htb and linux-hfsc">
3264 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
3265 the following key-value pair:
3268 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
3269 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3270 specified, for physical interfaces, the default is the link rate. For
3271 other interfaces or if the link rate cannot be determined, the default
3272 is currently 100 Mbps.
3276 <group title="Common Columns">
3277 The overall purpose of these columns is described under <code>Common
3278 Columns</code> at the beginning of this document.
3280 <column name="other_config"/>
3281 <column name="external_ids"/>
3285 <table name="Queue" title="QoS output queue.">
3286 <p>A configuration for a port output queue, used in configuring Quality of
3287 Service (QoS) features. May be referenced by <ref column="queues"
3288 table="QoS"/> column in <ref table="QoS"/> table.</p>
3290 <column name="dscp">
3291 If set, Open vSwitch will mark all traffic egressing this
3292 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3293 default <ref table="Queue"/> is only marked if it was explicitly selected
3294 as the <ref table="Queue"/> at the time the packet was output. If unset,
3295 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3299 <group title="Configuration for linux-htb QoS">
3301 <ref table="QoS"/> <ref table="QoS" column="type"/>
3302 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3303 It has the following key-value pairs defined.
3306 <column name="other_config" key="min-rate"
3307 type='{"type": "integer", "minInteger": 1}'>
3308 Minimum guaranteed bandwidth, in bit/s.
3311 <column name="other_config" key="max-rate"
3312 type='{"type": "integer", "minInteger": 1}'>
3313 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3314 queue's rate will not be allowed to exceed the specified value, even
3315 if excess bandwidth is available. If unspecified, defaults to no
3319 <column name="other_config" key="burst"
3320 type='{"type": "integer", "minInteger": 1}'>
3321 Burst size, in bits. This is the maximum amount of ``credits'' that a
3322 queue can accumulate while it is idle. Optional. Details of the
3323 <code>linux-htb</code> implementation require a minimum burst size, so
3324 a too-small <code>burst</code> will be silently ignored.
3327 <column name="other_config" key="priority"
3328 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3329 A queue with a smaller <code>priority</code> will receive all the
3330 excess bandwidth that it can use before a queue with a larger value
3331 receives any. Specific priority values are unimportant; only relative
3332 ordering matters. Defaults to 0 if unspecified.
3336 <group title="Configuration for linux-hfsc QoS">
3338 <ref table="QoS"/> <ref table="QoS" column="type"/>
3339 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3340 It has the following key-value pairs defined.
3343 <column name="other_config" key="min-rate"
3344 type='{"type": "integer", "minInteger": 1}'>
3345 Minimum guaranteed bandwidth, in bit/s.
3348 <column name="other_config" key="max-rate"
3349 type='{"type": "integer", "minInteger": 1}'>
3350 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3351 queue's rate will not be allowed to exceed the specified value, even if
3352 excess bandwidth is available. If unspecified, defaults to no
3357 <group title="Common Columns">
3358 The overall purpose of these columns is described under <code>Common
3359 Columns</code> at the beginning of this document.
3361 <column name="other_config"/>
3362 <column name="external_ids"/>
3366 <table name="Mirror" title="Port mirroring.">
3367 <p>A port mirror within a <ref table="Bridge"/>.</p>
3368 <p>A port mirror configures a bridge to send selected frames to special
3369 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3370 traffic may also be referred to as SPAN or RSPAN, depending on how
3371 the mirrored traffic is sent.</p>
3373 <column name="name">
3374 Arbitrary identifier for the <ref table="Mirror"/>.
3377 <group title="Selecting Packets for Mirroring">
3379 To be selected for mirroring, a given packet must enter or leave the
3380 bridge through a selected port and it must also be in one of the
3384 <column name="select_all">
3385 If true, every packet arriving or departing on any port is
3386 selected for mirroring.
3389 <column name="select_dst_port">
3390 Ports on which departing packets are selected for mirroring.
3393 <column name="select_src_port">
3394 Ports on which arriving packets are selected for mirroring.
3397 <column name="select_vlan">
3398 VLANs on which packets are selected for mirroring. An empty set
3399 selects packets on all VLANs.
3403 <group title="Mirroring Destination Configuration">
3405 These columns are mutually exclusive. Exactly one of them must be
3409 <column name="output_port">
3410 <p>Output port for selected packets, if nonempty.</p>
3411 <p>Specifying a port for mirror output reserves that port exclusively
3412 for mirroring. No frames other than those selected for mirroring
3414 will be forwarded to the port, and any frames received on the port
3415 will be discarded.</p>
3417 The output port may be any kind of port supported by Open vSwitch.
3418 It may be, for example, a physical port (sometimes called SPAN) or a
3423 <column name="output_vlan">
3424 <p>Output VLAN for selected packets, if nonempty.</p>
3425 <p>The frames will be sent out all ports that trunk
3426 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3427 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3428 trunk port, the frame's VLAN tag will be set to
3429 <ref column="output_vlan"/>, replacing any existing tag; when it is
3430 sent out an implicit VLAN port, the frame will not be tagged. This
3431 type of mirroring is sometimes called RSPAN.</p>
3433 See the documentation for
3434 <ref column="other_config" key="forward-bpdu"/> in the
3435 <ref table="Interface"/> table for a list of destination MAC
3436 addresses which will not be mirrored to a VLAN to avoid confusing
3437 switches that interpret the protocols that they represent.
3439 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3440 contains unmanaged switches. Consider an unmanaged physical switch
3441 with two ports: port 1, connected to an end host, and port 2,
3442 connected to an Open vSwitch configured to mirror received packets
3443 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3444 port 1 that the physical switch forwards to port 2. The Open vSwitch
3445 forwards this packet to its destination and then reflects it back on
3446 port 2 in VLAN 123. This reflected packet causes the unmanaged
3447 physical switch to replace the MAC learning table entry, which
3448 correctly pointed to port 1, with one that incorrectly points to port
3449 2. Afterward, the physical switch will direct packets destined for
3450 the end host to the Open vSwitch on port 2, instead of to the end
3451 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3452 desired in this scenario, then the physical switch must be replaced
3453 by one that learns Ethernet addresses on a per-VLAN basis. In
3454 addition, learning should be disabled on the VLAN containing mirrored
3455 traffic. If this is not done then intermediate switches will learn
3456 the MAC address of each end host from the mirrored traffic. If
3457 packets being sent to that end host are also mirrored, then they will
3458 be dropped since the switch will attempt to send them out the input
3459 port. Disabling learning for the VLAN will cause the switch to
3460 correctly send the packet out all ports configured for that VLAN. If
3461 Open vSwitch is being used as an intermediate switch, learning can be
3462 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3463 in the appropriate <ref table="Bridge"/> table or tables.</p>
3465 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3466 VLAN and should generally be preferred.
3471 <group title="Statistics: Mirror counters">
3473 Key-value pairs that report mirror statistics. The update period
3474 is controlled by <ref column="other_config"
3475 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3477 <column name="statistics" key="tx_packets">
3478 Number of packets transmitted through this mirror.
3480 <column name="statistics" key="tx_bytes">
3481 Number of bytes transmitted through this mirror.
3485 <group title="Common Columns">
3486 The overall purpose of these columns is described under <code>Common
3487 Columns</code> at the beginning of this document.
3489 <column name="external_ids"/>
3493 <table name="Controller" title="OpenFlow controller configuration.">
3494 <p>An OpenFlow controller.</p>
3497 Open vSwitch supports two kinds of OpenFlow controllers:
3501 <dt>Primary controllers</dt>
3504 This is the kind of controller envisioned by the OpenFlow 1.0
3505 specification. Usually, a primary controller implements a network
3506 policy by taking charge of the switch's flow table.
3510 Open vSwitch initiates and maintains persistent connections to
3511 primary controllers, retrying the connection each time it fails or
3512 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3513 <ref table="Bridge"/> table applies to primary controllers.
3517 Open vSwitch permits a bridge to have any number of primary
3518 controllers. When multiple controllers are configured, Open
3519 vSwitch connects to all of them simultaneously. Because
3520 OpenFlow 1.0 does not specify how multiple controllers
3521 coordinate in interacting with a single switch, more than
3522 one primary controller should be specified only if the
3523 controllers are themselves designed to coordinate with each
3524 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3525 vendor extension may be useful for this.)
3528 <dt>Service controllers</dt>
3531 These kinds of OpenFlow controller connections are intended for
3532 occasional support and maintenance use, e.g. with
3533 <code>ovs-ofctl</code>. Usually a service controller connects only
3534 briefly to inspect or modify some of a switch's state.
3538 Open vSwitch listens for incoming connections from service
3539 controllers. The service controllers initiate and, if necessary,
3540 maintain the connections from their end. The <ref table="Bridge"
3541 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3542 not apply to service controllers.
3546 Open vSwitch supports configuring any number of service controllers.
3552 The <ref column="target"/> determines the type of controller.
3555 <group title="Core Features">
3556 <column name="target">
3557 <p>Connection method for controller.</p>
3559 The following connection methods are currently supported for primary
3563 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3565 <p>The specified SSL <var>port</var> on the host at the
3566 given <var>ip</var>, which must be expressed as an IP
3567 address (not a DNS name). The <ref table="Open_vSwitch"
3568 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3569 table must point to a valid SSL configuration when this form
3571 <p>If <var>port</var> is not specified, it defaults to 6653.</p>
3572 <p>SSL support is an optional feature that is not always built as
3573 part of Open vSwitch.</p>
3575 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3578 The specified TCP <var>port</var> on the host at the given
3579 <var>ip</var>, which must be expressed as an IP address (not a
3580 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3581 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3582 e.g. <code>tcp:[::1]:6653</code>.
3585 If <var>port</var> is not specified, it defaults to 6653.
3590 The following connection methods are currently supported for service
3594 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3597 Listens for SSL connections on the specified TCP <var>port</var>.
3598 If <var>ip</var>, which must be expressed as an IP address (not a
3599 DNS name), is specified, then connections are restricted to the
3600 specified local IP address (either IPv4 or IPv6). If
3601 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3602 e.g. <code>pssl:6653:[::1]</code>.
3605 If <var>port</var> is not specified, it defaults to
3606 6653. If <var>ip</var> is not specified then it listens only on
3607 IPv4 (but not IPv6) addresses. The
3608 <ref table="Open_vSwitch" column="ssl"/>
3609 column in the <ref table="Open_vSwitch"/> table must point to a
3610 valid SSL configuration when this form is used.
3613 If <var>port</var> is not specified, it currently to 6653.
3616 SSL support is an optional feature that is not always built as
3617 part of Open vSwitch.
3620 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3623 Listens for connections on the specified TCP <var>port</var>. If
3624 <var>ip</var>, which must be expressed as an IP address (not a
3625 DNS name), is specified, then connections are restricted to the
3626 specified local IP address (either IPv4 or IPv6). If
3627 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3628 e.g. <code>ptcp:6653:[::1]</code>. If <var>ip</var> is not
3629 specified then it listens only on IPv4 addresses.
3632 If <var>port</var> is not specified, it defaults to 6653.
3636 <p>When multiple controllers are configured for a single bridge, the
3637 <ref column="target"/> values must be unique. Duplicate
3638 <ref column="target"/> values yield unspecified results.</p>
3641 <column name="connection_mode">
3642 <p>If it is specified, this setting must be one of the following
3643 strings that describes how Open vSwitch contacts this OpenFlow
3644 controller over the network:</p>
3647 <dt><code>in-band</code></dt>
3648 <dd>In this mode, this controller's OpenFlow traffic travels over the
3649 bridge associated with the controller. With this setting, Open
3650 vSwitch allows traffic to and from the controller regardless of the
3651 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3652 would never be able to connect to the controller, because it did
3653 not have a flow to enable it.) This is the most common connection
3654 mode because it is not necessary to maintain two independent
3656 <dt><code>out-of-band</code></dt>
3657 <dd>In this mode, OpenFlow traffic uses a control network separate
3658 from the bridge associated with this controller, that is, the
3659 bridge does not use any of its own network devices to communicate
3660 with the controller. The control network must be configured
3661 separately, before or after <code>ovs-vswitchd</code> is started.
3665 <p>If not specified, the default is implementation-specific.</p>
3669 <group title="Controller Failure Detection and Handling">
3670 <column name="max_backoff">
3671 Maximum number of milliseconds to wait between connection attempts.
3672 Default is implementation-specific.
3675 <column name="inactivity_probe">
3676 Maximum number of milliseconds of idle time on connection to
3677 controller before sending an inactivity probe message. If Open
3678 vSwitch does not communicate with the controller for the specified
3679 number of seconds, it will send a probe. If a response is not
3680 received for the same additional amount of time, Open vSwitch
3681 assumes the connection has been broken and attempts to reconnect.
3682 Default is implementation-specific. A value of 0 disables
3687 <group title="Asynchronous Messages">
3689 OpenFlow switches send certain messages to controllers spontanenously,
3690 that is, not in response to any request from the controller. These
3691 messages are called ``asynchronous messages.'' These columns allow
3692 asynchronous messages to be limited or disabled to ensure the best use
3693 of network resources.
3696 <column name="enable_async_messages">
3697 The OpenFlow protocol enables asynchronous messages at time of
3698 connection establishment, which means that a controller can receive
3699 asynchronous messages, potentially many of them, even if it turns them
3700 off immediately after connecting. Set this column to
3701 <code>false</code> to change Open vSwitch behavior to disable, by
3702 default, all asynchronous messages. The controller can use the
3703 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3704 on any messages that it does want to receive, if any.
3707 <group title="Controller Rate Limiting">
3709 A switch can forward packets to a controller over the OpenFlow
3710 protocol. Forwarding packets this way at too high a rate can
3711 overwhelm a controller, frustrate use of the OpenFlow connection for
3712 other purposes, increase the latency of flow setup, and use an
3713 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3714 limiting the rate of packet forwarding to a controller.
3718 There are two main reasons in OpenFlow for a packet to be sent to a
3719 controller: either the packet ``misses'' in the flow table, that is,
3720 there is no matching flow, or a flow table action says to send the
3721 packet to the controller. Open vSwitch limits the rate of each kind
3722 of packet separately at the configured rate. Therefore, the actual
3723 rate that packets are sent to the controller can be up to twice the
3724 configured rate, when packets are sent for both reasons.
3728 This feature is specific to forwarding packets over an OpenFlow
3729 connection. It is not general-purpose QoS. See the <ref
3730 table="QoS"/> table for quality of service configuration, and <ref
3731 column="ingress_policing_rate" table="Interface"/> in the <ref
3732 table="Interface"/> table for ingress policing configuration.
3735 <column name="controller_rate_limit">
3737 The maximum rate at which the switch will forward packets to the
3738 OpenFlow controller, in packets per second. If no value is
3739 specified, rate limiting is disabled.
3743 <column name="controller_burst_limit">
3745 When a high rate triggers rate-limiting, Open vSwitch queues
3746 packets to the controller for each port and transmits them to the
3747 controller at the configured rate. This value limits the number of
3748 queued packets. Ports on a bridge share the packet queue fairly.
3752 This value has no effect unless <ref
3753 column="controller_rate_limit"/> is configured. The current
3754 default when this value is not specified is one-quarter of <ref
3755 column="controller_rate_limit"/>, meaning that queuing can delay
3756 forwarding a packet to the controller by up to 250 ms.
3760 <group title="Controller Rate Limiting Statistics">
3762 These values report the effects of rate limiting. Their values are
3763 relative to establishment of the most recent OpenFlow connection,
3764 or since rate limiting was enabled, whichever happened more
3765 recently. Each consists of two values, one with <code>TYPE</code>
3766 replaced by <code>miss</code> for rate limiting flow table misses,
3767 and the other with <code>TYPE</code> replaced by
3768 <code>action</code> for rate limiting packets sent by OpenFlow
3773 These statistics are reported only when controller rate limiting is
3777 <column name="status" key="packet-in-TYPE-bypassed"
3778 type='{"type": "integer", "minInteger": 0}'>
3779 Number of packets sent directly to the controller, without queuing,
3780 because the rate did not exceed the configured maximum.
3783 <column name="status" key="packet-in-TYPE-queued"
3784 type='{"type": "integer", "minInteger": 0}'>
3785 Number of packets added to the queue to send later.
3788 <column name="status" key="packet-in-TYPE-dropped"
3789 type='{"type": "integer", "minInteger": 0}'>
3790 Number of packets added to the queue that were later dropped due to
3791 overflow. This value is less than or equal to <ref column="status"
3792 key="packet-in-TYPE-queued"/>.
3795 <column name="status" key="packet-in-TYPE-backlog"
3796 type='{"type": "integer", "minInteger": 0}'>
3797 Number of packets currently queued. The other statistics increase
3798 monotonically, but this one fluctuates between 0 and the <ref
3799 column="controller_burst_limit"/> as conditions change.
3805 <group title="Additional In-Band Configuration">
3806 <p>These values are considered only in in-band control mode (see
3807 <ref column="connection_mode"/>).</p>
3809 <p>When multiple controllers are configured on a single bridge, there
3810 should be only one set of unique values in these columns. If different
3811 values are set for these columns in different controllers, the effect
3814 <column name="local_ip">
3815 The IP address to configure on the local port,
3816 e.g. <code>192.168.0.123</code>. If this value is unset, then
3817 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3821 <column name="local_netmask">
3822 The IP netmask to configure on the local port,
3823 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3824 but this value is unset, then the default is chosen based on whether
3825 the IP address is class A, B, or C.
3828 <column name="local_gateway">
3829 The IP address of the gateway to configure on the local port, as a
3830 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3831 this network has no gateway.
3835 <group title="Controller Status">
3836 <column name="is_connected">
3837 <code>true</code> if currently connected to this controller,
3838 <code>false</code> otherwise.
3842 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3843 <p>The level of authority this controller has on the associated
3844 bridge. Possible values are:</p>
3846 <dt><code>other</code></dt>
3847 <dd>Allows the controller access to all OpenFlow features.</dd>
3848 <dt><code>master</code></dt>
3849 <dd>Equivalent to <code>other</code>, except that there may be at
3850 most one master controller at a time. When a controller configures
3851 itself as <code>master</code>, any existing master is demoted to
3852 the <code>slave</code> role.</dd>
3853 <dt><code>slave</code></dt>
3854 <dd>Allows the controller read-only access to OpenFlow features.
3855 Attempts to modify the flow table will be rejected with an
3856 error. Slave controllers do not receive OFPT_PACKET_IN or
3857 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3862 <column name="status" key="last_error">
3863 A human-readable description of the last error on the connection
3864 to the controller; i.e. <code>strerror(errno)</code>. This key
3865 will exist only if an error has occurred.
3868 <column name="status" key="state"
3869 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3871 The state of the connection to the controller:
3874 <dt><code>VOID</code></dt>
3875 <dd>Connection is disabled.</dd>
3877 <dt><code>BACKOFF</code></dt>
3878 <dd>Attempting to reconnect at an increasing period.</dd>
3880 <dt><code>CONNECTING</code></dt>
3881 <dd>Attempting to connect.</dd>
3883 <dt><code>ACTIVE</code></dt>
3884 <dd>Connected, remote host responsive.</dd>
3886 <dt><code>IDLE</code></dt>
3887 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3890 These values may change in the future. They are provided only for
3895 <column name="status" key="sec_since_connect"
3896 type='{"type": "integer", "minInteger": 0}'>
3897 The amount of time since this controller last successfully connected to
3898 the switch (in seconds). Value is empty if controller has never
3899 successfully connected.
3902 <column name="status" key="sec_since_disconnect"
3903 type='{"type": "integer", "minInteger": 1}'>
3904 The amount of time since this controller last disconnected from
3905 the switch (in seconds). Value is empty if controller has never
3910 <group title="Connection Parameters">
3912 Additional configuration for a connection between the controller
3913 and the Open vSwitch.
3916 <column name="other_config" key="dscp"
3917 type='{"type": "integer"}'>
3918 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3919 in the Type of Service (TOS) field in the IP header. DSCP provides a
3920 mechanism to classify the network traffic and provide Quality of
3921 Service (QoS) on IP networks.
3923 The DSCP value specified here is used when establishing the connection
3924 between the controller and the Open vSwitch. If no value is specified,
3925 a default value of 48 is chosen. Valid DSCP values must be in the
3931 <group title="Common Columns">
3932 The overall purpose of these columns is described under <code>Common
3933 Columns</code> at the beginning of this document.
3935 <column name="external_ids"/>
3936 <column name="other_config"/>
3940 <table name="Manager" title="OVSDB management connection.">
3942 Configuration for a database connection to an Open vSwitch database
3947 This table primarily configures the Open vSwitch database
3948 (<code>ovsdb-server</code>), not the Open vSwitch switch
3949 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3950 what connections should be treated as in-band.
3954 The Open vSwitch database server can initiate and maintain active
3955 connections to remote clients. It can also listen for database
3959 <group title="Core Features">
3960 <column name="target">
3961 <p>Connection method for managers.</p>
3963 The following connection methods are currently supported:
3966 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3969 The specified SSL <var>port</var> on the host at the given
3970 <var>ip</var>, which must be expressed as an IP address
3971 (not a DNS name). The <ref table="Open_vSwitch"
3972 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3973 table must point to a valid SSL configuration when this
3977 If <var>port</var> is not specified, it defaults to 6640.
3980 SSL support is an optional feature that is not always
3981 built as part of Open vSwitch.
3985 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3988 The specified TCP <var>port</var> on the host at the given
3989 <var>ip</var>, which must be expressed as an IP address (not a
3990 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3991 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3992 e.g. <code>tcp:[::1]:6640</code>.
3995 If <var>port</var> is not specified, it defaults to 6640.
3998 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4001 Listens for SSL connections on the specified TCP <var>port</var>.
4002 Specify 0 for <var>port</var> to have the kernel automatically
4003 choose an available port. If <var>ip</var>, which must be
4004 expressed as an IP address (not a DNS name), is specified, then
4005 connections are restricted to the specified local IP address
4006 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4007 address, wrap in square brackets,
4008 e.g. <code>pssl:6640:[::1]</code>. If <var>ip</var> is not
4009 specified then it listens only on IPv4 (but not IPv6) addresses.
4010 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
4011 table="Open_vSwitch"/> table must point to a valid SSL
4012 configuration when this form is used.
4015 If <var>port</var> is not specified, it defaults to 6640.
4018 SSL support is an optional feature that is not always built as
4019 part of Open vSwitch.
4022 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4025 Listens for connections on the specified TCP <var>port</var>.
4026 Specify 0 for <var>port</var> to have the kernel automatically
4027 choose an available port. If <var>ip</var>, which must be
4028 expressed as an IP address (not a DNS name), is specified, then
4029 connections are restricted to the specified local IP address
4030 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4031 address, wrap it in square brackets,
4032 e.g. <code>ptcp:6640:[::1]</code>. If <var>ip</var> is not
4033 specified then it listens only on IPv4 addresses.
4036 If <var>port</var> is not specified, it defaults to 6640.
4040 <p>When multiple managers are configured, the <ref column="target"/>
4041 values must be unique. Duplicate <ref column="target"/> values yield
4042 unspecified results.</p>
4045 <column name="connection_mode">
4047 If it is specified, this setting must be one of the following strings
4048 that describes how Open vSwitch contacts this OVSDB client over the
4053 <dt><code>in-band</code></dt>
4055 In this mode, this connection's traffic travels over a bridge
4056 managed by Open vSwitch. With this setting, Open vSwitch allows
4057 traffic to and from the client regardless of the contents of the
4058 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4059 to connect to the client, because it did not have a flow to enable
4060 it.) This is the most common connection mode because it is not
4061 necessary to maintain two independent networks.
4063 <dt><code>out-of-band</code></dt>
4065 In this mode, the client's traffic uses a control network separate
4066 from that managed by Open vSwitch, that is, Open vSwitch does not
4067 use any of its own network devices to communicate with the client.
4068 The control network must be configured separately, before or after
4069 <code>ovs-vswitchd</code> is started.
4074 If not specified, the default is implementation-specific.
4079 <group title="Client Failure Detection and Handling">
4080 <column name="max_backoff">
4081 Maximum number of milliseconds to wait between connection attempts.
4082 Default is implementation-specific.
4085 <column name="inactivity_probe">
4086 Maximum number of milliseconds of idle time on connection to the client
4087 before sending an inactivity probe message. If Open vSwitch does not
4088 communicate with the client for the specified number of seconds, it
4089 will send a probe. If a response is not received for the same
4090 additional amount of time, Open vSwitch assumes the connection has been
4091 broken and attempts to reconnect. Default is implementation-specific.
4092 A value of 0 disables inactivity probes.
4096 <group title="Status">
4097 <column name="is_connected">
4098 <code>true</code> if currently connected to this manager,
4099 <code>false</code> otherwise.
4102 <column name="status" key="last_error">
4103 A human-readable description of the last error on the connection
4104 to the manager; i.e. <code>strerror(errno)</code>. This key
4105 will exist only if an error has occurred.
4108 <column name="status" key="state"
4109 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
4111 The state of the connection to the manager:
4114 <dt><code>VOID</code></dt>
4115 <dd>Connection is disabled.</dd>
4117 <dt><code>BACKOFF</code></dt>
4118 <dd>Attempting to reconnect at an increasing period.</dd>
4120 <dt><code>CONNECTING</code></dt>
4121 <dd>Attempting to connect.</dd>
4123 <dt><code>ACTIVE</code></dt>
4124 <dd>Connected, remote host responsive.</dd>
4126 <dt><code>IDLE</code></dt>
4127 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
4130 These values may change in the future. They are provided only for
4135 <column name="status" key="sec_since_connect"
4136 type='{"type": "integer", "minInteger": 0}'>
4137 The amount of time since this manager last successfully connected
4138 to the database (in seconds). Value is empty if manager has never
4139 successfully connected.
4142 <column name="status" key="sec_since_disconnect"
4143 type='{"type": "integer", "minInteger": 0}'>
4144 The amount of time since this manager last disconnected from the
4145 database (in seconds). Value is empty if manager has never
4149 <column name="status" key="locks_held">
4150 Space-separated list of the names of OVSDB locks that the connection
4151 holds. Omitted if the connection does not hold any locks.
4154 <column name="status" key="locks_waiting">
4155 Space-separated list of the names of OVSDB locks that the connection is
4156 currently waiting to acquire. Omitted if the connection is not waiting
4160 <column name="status" key="locks_lost">
4161 Space-separated list of the names of OVSDB locks that the connection
4162 has had stolen by another OVSDB client. Omitted if no locks have been
4163 stolen from this connection.
4166 <column name="status" key="n_connections"
4167 type='{"type": "integer", "minInteger": 2}'>
4169 When <ref column="target"/> specifies a connection method that
4170 listens for inbound connections (e.g. <code>ptcp:</code> or
4171 <code>pssl:</code>) and more than one connection is actually active,
4172 the value is the number of active connections. Otherwise, this
4173 key-value pair is omitted.
4176 When multiple connections are active, status columns and key-value
4177 pairs (other than this one) report the status of one arbitrarily
4182 <column name="status" key="bound_port" type='{"type": "integer"}'>
4183 When <ref column="target"/> is <code>ptcp:</code> or
4184 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
4185 listening. (This is is particularly useful when <ref
4186 column="target"/> specifies a port of 0, allowing the kernel to
4187 choose any available port.)
4191 <group title="Connection Parameters">
4193 Additional configuration for a connection between the manager
4194 and the Open vSwitch Database.
4197 <column name="other_config" key="dscp"
4198 type='{"type": "integer"}'>
4199 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4200 in the Type of Service (TOS) field in the IP header. DSCP provides a
4201 mechanism to classify the network traffic and provide Quality of
4202 Service (QoS) on IP networks.
4204 The DSCP value specified here is used when establishing the connection
4205 between the manager and the Open vSwitch. If no value is specified, a
4206 default value of 48 is chosen. Valid DSCP values must be in the range
4211 <group title="Common Columns">
4212 The overall purpose of these columns is described under <code>Common
4213 Columns</code> at the beginning of this document.
4215 <column name="external_ids"/>
4216 <column name="other_config"/>
4220 <table name="NetFlow">
4221 A NetFlow target. NetFlow is a protocol that exports a number of
4222 details about terminating IP flows, such as the principals involved
4225 <column name="targets">
4226 NetFlow targets in the form
4227 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
4228 must be specified numerically, not as a DNS name.
4231 <column name="engine_id">
4232 Engine ID to use in NetFlow messages. Defaults to datapath index
4236 <column name="engine_type">
4237 Engine type to use in NetFlow messages. Defaults to datapath
4238 index if not specified.
4241 <column name="active_timeout">
4243 The interval at which NetFlow records are sent for flows that
4244 are still active, in seconds. A value of <code>0</code>
4245 requests the default timeout (currently 600 seconds); a value
4246 of <code>-1</code> disables active timeouts.
4250 The NetFlow passive timeout, for flows that become inactive,
4251 is not configurable. It will vary depending on the Open
4252 vSwitch version, the forms and contents of the OpenFlow flow
4253 tables, CPU and memory usage, and network activity. A typical
4254 passive timeout is about a second.
4258 <column name="add_id_to_interface">
4259 <p>If this column's value is <code>false</code>, the ingress and egress
4260 interface fields of NetFlow flow records are derived from OpenFlow port
4261 numbers. When it is <code>true</code>, the 7 most significant bits of
4262 these fields will be replaced by the least significant 7 bits of the
4263 engine id. This is useful because many NetFlow collectors do not
4264 expect multiple switches to be sending messages from the same host, so
4265 they do not store the engine information which could be used to
4266 disambiguate the traffic.</p>
4267 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
4270 <group title="Common Columns">
4271 The overall purpose of these columns is described under <code>Common
4272 Columns</code> at the beginning of this document.
4274 <column name="external_ids"/>
4279 SSL configuration for an Open_vSwitch.
4281 <column name="private_key">
4282 Name of a PEM file containing the private key used as the switch's
4283 identity for SSL connections to the controller.
4286 <column name="certificate">
4287 Name of a PEM file containing a certificate, signed by the
4288 certificate authority (CA) used by the controller and manager,
4289 that certifies the switch's private key, identifying a trustworthy
4293 <column name="ca_cert">
4294 Name of a PEM file containing the CA certificate used to verify
4295 that the switch is connected to a trustworthy controller.
4298 <column name="bootstrap_ca_cert">
4299 If set to <code>true</code>, then Open vSwitch will attempt to
4300 obtain the CA certificate from the controller on its first SSL
4301 connection and save it to the named PEM file. If it is successful,
4302 it will immediately drop the connection and reconnect, and from then
4303 on all SSL connections must be authenticated by a certificate signed
4304 by the CA certificate thus obtained. <em>This option exposes the
4305 SSL connection to a man-in-the-middle attack obtaining the initial
4306 CA certificate.</em> It may still be useful for bootstrapping.
4309 <group title="Common Columns">
4310 The overall purpose of these columns is described under <code>Common
4311 Columns</code> at the beginning of this document.
4313 <column name="external_ids"/>
4317 <table name="sFlow">
4318 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4319 monitoring of switches.</p>
4321 <column name="agent">
4322 Name of the network device whose IP address should be reported as the
4323 ``agent address'' to collectors. If not specified, the agent device is
4324 figured from the first target address and the routing table. If the
4325 routing table does not contain a route to the target, the IP address
4326 defaults to the <ref table="Controller" column="local_ip"/> in the
4327 collector's <ref table="Controller"/>. If an agent IP address cannot be
4328 determined any of these ways, sFlow is disabled.
4331 <column name="header">
4332 Number of bytes of a sampled packet to send to the collector.
4333 If not specified, the default is 128 bytes.
4336 <column name="polling">
4337 Polling rate in seconds to send port statistics to the collector.
4338 If not specified, defaults to 30 seconds.
4341 <column name="sampling">
4342 Rate at which packets should be sampled and sent to the collector.
4343 If not specified, defaults to 400, which means one out of 400
4344 packets, on average, will be sent to the collector.
4347 <column name="targets">
4348 sFlow targets in the form
4349 <code><var>ip</var>:<var>port</var></code>.
4352 <group title="Common Columns">
4353 The overall purpose of these columns is described under <code>Common
4354 Columns</code> at the beginning of this document.
4356 <column name="external_ids"/>
4360 <table name="IPFIX">
4361 <p>Configuration for sending packets to IPFIX collectors.</p>
4364 IPFIX is a protocol that exports a number of details about flows. The
4365 IPFIX implementation in Open vSwitch samples packets at a configurable
4366 rate, extracts flow information from those packets, optionally caches and
4367 aggregates the flow information, and sends the result to one or more
4372 IPFIX in Open vSwitch can be configured two different ways:
4377 With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling
4378 automatically on all packets that pass through a bridge. To configure
4379 per-bridge sampling, create an <ref table="IPFIX"/> record and point a
4380 <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/>
4381 column to it. The <ref table="Flow_Sample_Collector_Set"/> table is
4382 not used for per-bridge sampling.
4387 With <em>flow-based sampling</em>, <code>sample</code> actions in the
4388 OpenFlow flow table drive IPFIX sampling. See
4389 <code>ovs-ofctl</code>(8) for a description of the
4390 <code>sample</code> action.
4394 Flow-based sampling also requires database configuration: create a
4395 <ref table="IPFIX"/> record that describes the IPFIX configuration
4396 and a <ref table="Flow_Sample_Collector_Set"/> record that points to
4397 the <ref table="Bridge"/> whose flow table holds the
4398 <code>sample</code> actions and to <ref table="IPFIX"/> record. The
4399 <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/>
4400 table is not used for flow-based sampling.
4405 <column name="targets">
4406 IPFIX target collectors in the form
4407 <code><var>ip</var>:<var>port</var></code>.
4410 <column name="cache_active_timeout">
4411 The maximum period in seconds for which an IPFIX flow record is
4412 cached and aggregated before being sent. If not specified,
4413 defaults to 0. If 0, caching is disabled.
4416 <column name="cache_max_flows">
4417 The maximum number of IPFIX flow records that can be cached at a
4418 time. If not specified, defaults to 0. If 0, caching is
4422 <group title="Per-Bridge Sampling">
4424 These values affect only per-bridge sampling. See above for a
4425 description of the differences between per-bridge and flow-based
4429 <column name="sampling">
4430 The rate at which packets should be sampled and sent to each target
4431 collector. If not specified, defaults to 400, which means one out of
4432 400 packets, on average, will be sent to each target collector.
4435 <column name="obs_domain_id">
4436 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4437 specified, defaults to 0.
4440 <column name="obs_point_id">
4441 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4442 specified, defaults to 0.
4445 <column name="other_config" key="enable-tunnel-sampling"
4446 type='{"type": "boolean"}'>
4448 Set to <code>true</code> to enable sampling and reporting tunnel
4449 header 7-tuples in IPFIX flow records. Tunnel sampling is disabled
4454 The following enterprise entities report the sampled tunnel info:
4458 <dt>tunnelType:</dt>
4460 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4461 <p>type: unsigned 8-bit integer.</p>
4462 <p>data type semantics: identifier.</p>
4463 <p>description: Identifier of the layer 2 network overlay network
4464 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4469 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4470 <p>type: variable-length octetarray.</p>
4471 <p>data type semantics: identifier.</p>
4472 <p>description: Key which is used for identifying an individual
4473 traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI),
4474 GRE (32- or 64-bit key), or LISP (24-bit instance ID) tunnel. The
4475 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4476 ID in network byte order.</p>
4478 <dt>tunnelSourceIPv4Address:</dt>
4480 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4481 <p>type: unsigned 32-bit integer.</p>
4482 <p>data type semantics: identifier.</p>
4483 <p>description: The IPv4 source address in the tunnel IP packet
4486 <dt>tunnelDestinationIPv4Address:</dt>
4488 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4489 <p>type: unsigned 32-bit integer.</p>
4490 <p>data type semantics: identifier.</p>
4491 <p>description: The IPv4 destination address in the tunnel IP
4494 <dt>tunnelProtocolIdentifier:</dt>
4496 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4497 <p>type: unsigned 8-bit integer.</p>
4498 <p>data type semantics: identifier.</p>
4499 <p>description: The value of the protocol number in the tunnel
4500 IP packet header. The protocol number identifies the tunnel IP
4501 packet payload type.</p>
4503 <dt>tunnelSourceTransportPort:</dt>
4505 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4506 <p>type: unsigned 16-bit integer.</p>
4507 <p>data type semantics: identifier.</p>
4508 <p>description: The source port identifier in the tunnel transport
4509 header. For the transport protocols UDP, TCP, and SCTP, this is
4510 the source port number given in the respective header.</p>
4512 <dt>tunnelDestinationTransportPort:</dt>
4514 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4515 <p>type: unsigned 16-bit integer.</p>
4516 <p>data type semantics: identifier.</p>
4517 <p>description: The destination port identifier in the tunnel
4518 transport header. For the transport protocols UDP, TCP, and SCTP,
4519 this is the destination port number given in the respective header.
4525 <column name="other_config" key="enable-input-sampling"
4526 type='{"type": "boolean"}'>
4527 By default, Open vSwitch samples and reports flows at bridge port input
4528 in IPFIX flow records. Set this column to <code>false</code> to
4529 disable input sampling.
4532 <column name="other_config" key="enable-output-sampling"
4533 type='{"type": "boolean"}'>
4534 By default, Open vSwitch samples and reports flows at bridge port
4535 output in IPFIX flow records. Set this column to <code>false</code> to
4536 disable output sampling.
4540 <group title="Common Columns">
4541 The overall purpose of these columns is described under <code>Common
4542 Columns</code> at the beginning of this document.
4544 <column name="external_ids"/>
4548 <table name="Flow_Sample_Collector_Set">
4550 A set of IPFIX collectors of packet samples generated by OpenFlow
4551 <code>sample</code> actions. This table is used only for IPFIX
4552 flow-based sampling, not for per-bridge sampling (see the <ref
4553 table="IPFIX"/> table for a description of the two forms).
4557 The ID of this collector set, unique among the bridge's
4558 collector sets, to be used as the <code>collector_set_id</code>
4559 in OpenFlow <code>sample</code> actions.
4562 <column name="bridge">
4563 The bridge into which OpenFlow <code>sample</code> actions can
4564 be added to send packet samples to this set of IPFIX collectors.
4567 <column name="ipfix">
4568 Configuration of the set of IPFIX collectors to send one flow
4569 record per sampled packet to.
4572 <group title="Common Columns">
4573 The overall purpose of these columns is described under <code>Common
4574 Columns</code> at the beginning of this document.
4576 <column name="external_ids"/>
4580 <table name="AutoAttach">
4581 <p>Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4582 draft standard describes a compact method of using IEEE 802.1AB Link
4583 Layer Discovery Protocol (LLDP) together with a IEEE 802.1aq Shortest
4584 Path Bridging (SPB) network to automatically attach network devices
4585 to individual services in a SPB network. The intent here is to allow
4586 network applications and devices using OVS to be able to easily take
4587 advantage of features offered by industry standard SPB networks.</p>
4589 <p>Auto Attach (AA) uses LLDP to communicate between a directly connected
4590 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4591 is extended to add two new Type-Length-Value tuples (TLVs). The first
4592 new TLV supports the ongoing discovery of directly connected AA
4593 correspondents. Auto Attach operates by regularly transmitting AA
4594 discovery TLVs between the AA client and AA server. By exchanging these
4595 discovery messages, both the AAC and AAS learn the system name and
4596 system description of their peer. In the OVS context, OVS operates as
4597 the AA client and the AA server resides on a switch at the edge of the
4600 <p>Once AA discovery has been completed the AAC then uses the
4601 second new TLV to deliver identifier mappings from the AAC to the AAS. A primary
4602 feature of Auto Attach is to facilitate the mapping of VLANs defined
4603 outside the SPB network onto service ids (ISIDs) defined within the SPM
4604 network. By doing so individual external VLANs can be mapped onto
4605 specific SPB network services. These VLAN id to ISID mappings can be
4606 configured and managed locally using new options added to the ovs-vsctl
4609 <p>The Auto Attach OVS feature does not provide a full implementation of
4610 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
4611 standard and support for the AA TLV extensions is provided. LLDP
4612 protocol support in OVS can be enabled or disabled on a port by port
4613 basis. LLDP support is disabled by default.</p>
4615 <column name="system_name">
4616 The system_name string is exported in LLDP messages. It should uniquely
4617 identify the bridge in the network.
4620 <column name="system_description">
4621 The system_description string is exported in LLDP messages. It should
4622 describe the type of software and hardware.
4625 <column name="mappings">
4626 A mapping from SPB network Individual Service Identifier (ISID) to VLAN id.