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. Tweaking this value is
149 discouraged unless you know exactly what you're doing.
152 The default is 200000.
156 <column name="other_config" key="max-idle"
157 type='{"type": "integer", "minInteger": 500}'>
159 The maximum time (in ms) that idle flows will remain cached in the
160 datapath. Internally OVS will check the validity and activity for
161 datapath flows regularly and may expire flows quicker than this
162 number, based on real time network conditions. Tweaking this
163 value is discouraged unless you know exactly what you're doing.
166 The default is 10000.
170 <column name="other_config" key="n-dpdk-rxqs"
171 type='{"type": "integer", "minInteger": 1}'>
173 Specifies the maximum number of rx queues to be created for each dpdk
174 interface. If not specified or specified to 0, one rx queue will
175 be created for each dpdk interface by default.
179 <column name="other_config" key="pmd-cpu-mask">
181 Specifies CPU mask for setting the cpu affinity of PMD (Poll
182 Mode Driver) threads. Value should be in the form of hex string,
183 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
187 The lowest order bit corresponds to the first CPU core. A set bit
188 means the corresponding core is available and a pmd thread will be
189 created and pinned to it. If the input does not cover all cores,
190 those uncovered cores are considered not set.
193 If not specified, one pmd thread will be created for each numa node
194 and pinned to any available core on the numa node by default.
198 <column name="other_config" key="n-handler-threads"
199 type='{"type": "integer", "minInteger": 1}'>
201 Specifies the number of threads for software datapaths to use for
202 handling new flows. The default the number of online CPU cores minus
203 the number of revalidators.
206 This configuration is per datapath. If you have more than one
207 software datapath (e.g. some <code>system</code> bridges and some
208 <code>netdev</code> bridges), then the total number of threads is
209 <code>n-handler-threads</code> times the number of software
214 <column name="other_config" key="n-revalidator-threads"
215 type='{"type": "integer", "minInteger": 1}'>
217 Specifies the number of threads for software datapaths to use for
218 revalidating flows in the datapath. Typically, there is a direct
219 correlation between the number of revalidator threads, and the number
220 of flows allowed in the datapath. The default is the number of cpu
221 cores divided by four plus one. If <code>n-handler-threads</code> is
222 set, the default changes to the number of cpu cores minus the number
226 This configuration is per datapath. If you have more than one
227 software datapath (e.g. some <code>system</code> bridges and some
228 <code>netdev</code> bridges), then the total number of threads is
229 <code>n-handler-threads</code> times the number of software
235 <group title="Status">
236 <column name="next_cfg">
237 Sequence number for client to increment. When a client modifies
238 any part of the database configuration and wishes to wait for
239 Open vSwitch to finish applying the changes, it may increment
240 this sequence number.
243 <column name="cur_cfg">
244 Sequence number that Open vSwitch sets to the current value of
245 <ref column="next_cfg"/> after it finishes applying a set of
246 configuration changes.
249 <group title="Statistics">
251 The <code>statistics</code> column contains key-value pairs that
252 report statistics about a system running an Open vSwitch. These are
253 updated periodically (currently, every 5 seconds). Key-value pairs
254 that cannot be determined or that do not apply to a platform are
258 <column name="other_config" key="enable-statistics"
259 type='{"type": "boolean"}'>
260 Statistics are disabled by default to avoid overhead in the common
261 case when statistics gathering is not useful. Set this value to
262 <code>true</code> to enable populating the <ref column="statistics"/>
263 column or to <code>false</code> to explicitly disable it.
266 <column name="statistics" key="cpu"
267 type='{"type": "integer", "minInteger": 1}'>
269 Number of CPU processors, threads, or cores currently online and
270 available to the operating system on which Open vSwitch is running,
271 as an integer. This may be less than the number installed, if some
272 are not online or if they are not available to the operating
276 Open vSwitch userspace processes are not multithreaded, but the
277 Linux kernel-based datapath is.
281 <column name="statistics" key="load_average">
282 A comma-separated list of three floating-point numbers,
283 representing the system load average over the last 1, 5, and 15
284 minutes, respectively.
287 <column name="statistics" key="memory">
289 A comma-separated list of integers, each of which represents a
290 quantity of memory in kilobytes that describes the operating
291 system on which Open vSwitch is running. In respective order,
296 <li>Total amount of RAM allocated to the OS.</li>
297 <li>RAM allocated to the OS that is in use.</li>
298 <li>RAM that can be flushed out to disk or otherwise discarded
299 if that space is needed for another purpose. This number is
300 necessarily less than or equal to the previous value.</li>
301 <li>Total disk space allocated for swap.</li>
302 <li>Swap space currently in use.</li>
306 On Linux, all five values can be determined and are included. On
307 other operating systems, only the first two values can be
308 determined, so the list will only have two values.
312 <column name="statistics" key="process_NAME">
314 One such key-value pair, with <code>NAME</code> replaced by
315 a process name, will exist for each running Open vSwitch
316 daemon process, with <var>name</var> replaced by the
317 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
318 value is a comma-separated list of integers. The integers
319 represent the following, with memory measured in kilobytes
320 and durations in milliseconds:
324 <li>The process's virtual memory size.</li>
325 <li>The process's resident set size.</li>
326 <li>The amount of user and system CPU time consumed by the
328 <li>The number of times that the process has crashed and been
329 automatically restarted by the monitor.</li>
330 <li>The duration since the process was started.</li>
331 <li>The duration for which the process has been running.</li>
335 The interpretation of some of these values depends on whether the
336 process was started with the <option>--monitor</option>. If it
337 was not, then the crash count will always be 0 and the two
338 durations will always be the same. If <option>--monitor</option>
339 was given, then the crash count may be positive; if it is, the
340 latter duration is the amount of time since the most recent crash
345 There will be one key-value pair for each file in Open vSwitch's
346 ``run directory'' (usually <code>/var/run/openvswitch</code>)
347 whose name ends in <code>.pid</code>, whose contents are a
348 process ID, and which is locked by a running process. The
349 <var>name</var> is taken from the pidfile's name.
353 Currently Open vSwitch is only able to obtain all of the above
354 detail on Linux systems. On other systems, the same key-value
355 pairs will be present but the values will always be the empty
360 <column name="statistics" key="file_systems">
362 A space-separated list of information on local, writable file
363 systems. Each item in the list describes one file system and
364 consists in turn of a comma-separated list of the following:
368 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
369 Any spaces or commas in the mount point are replaced by
371 <li>Total size, in kilobytes, as an integer.</li>
372 <li>Amount of storage in use, in kilobytes, as an integer.</li>
376 This key-value pair is omitted if there are no local, writable
377 file systems or if Open vSwitch cannot obtain the needed
384 <group title="Version Reporting">
386 These columns report the types and versions of the hardware and
387 software running Open vSwitch. We recommend in general that software
388 should test whether specific features are supported instead of relying
389 on version number checks. These values are primarily intended for
390 reporting to human administrators.
393 <column name="ovs_version">
394 The Open vSwitch version number, e.g. <code>1.1.0</code>.
397 <column name="db_version">
399 The database schema version number in the form
400 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
401 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
402 a non-backward compatible way (e.g. deleting a column or a table),
403 <var>major</var> is incremented. When the database schema is changed
404 in a backward compatible way (e.g. adding a new column),
405 <var>minor</var> is incremented. When the database schema is changed
406 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
411 The schema version is part of the database schema, so it can also be
412 retrieved by fetching the schema using the Open vSwitch database
417 <column name="system_type">
419 An identifier for the type of system on top of which Open vSwitch
420 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
423 System integrators are responsible for choosing and setting an
424 appropriate value for this column.
428 <column name="system_version">
430 The version of the system identified by <ref column="system_type"/>,
431 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
434 System integrators are responsible for choosing and setting an
435 appropriate value for this column.
441 <group title="Capabilities">
443 These columns report capabilities of the Open vSwitch instance.
445 <column name="datapath_types">
447 This column reports the different dpifs registered with the system.
448 These are the values that this instance supports in the <ref
449 column="datapath_type" table="Bridge"/> column of the <ref
450 table="Bridge"/> table.
453 <column name="iface_types">
455 This column reports the different netdevs registered with the system.
456 These are the values that this instance supports in the <ref
457 column="type" table="Interface"/> column of the <ref
458 table="Interface"/> table.
463 <group title="Database Configuration">
465 These columns primarily configure the Open vSwitch database
466 (<code>ovsdb-server</code>), not the Open vSwitch switch
467 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
468 column="ssl"/> settings.
472 The Open vSwitch switch does read the database configuration to
473 determine remote IP addresses to which in-band control should apply.
476 <column name="manager_options">
477 Database clients to which the Open vSwitch database server should
478 connect or to which it should listen, along with options for how these
479 connection should be configured. See the <ref table="Manager"/> table
480 for more information.
484 <group title="Common Columns">
485 The overall purpose of these columns is described under <code>Common
486 Columns</code> at the beginning of this document.
488 <column name="other_config"/>
489 <column name="external_ids"/>
493 <table name="Bridge">
495 Configuration for a bridge within an
496 <ref table="Open_vSwitch"/>.
499 A <ref table="Bridge"/> record represents an Ethernet switch with one or
500 more ``ports,'' which are the <ref table="Port"/> records pointed to by
501 the <ref table="Bridge"/>'s <ref column="ports"/> column.
504 <group title="Core Features">
506 Bridge identifier. Should be alphanumeric and no more than about 8
507 bytes long. Must be unique among the names of ports, interfaces, and
511 <column name="ports">
512 Ports included in the bridge.
515 <column name="mirrors">
516 Port mirroring configuration.
519 <column name="netflow">
520 NetFlow configuration.
523 <column name="sflow">
524 sFlow(R) configuration.
527 <column name="ipfix">
531 <column name="flood_vlans">
533 VLAN IDs of VLANs on which MAC address learning should be disabled,
534 so that packets are flooded instead of being sent to specific ports
535 that are believed to contain packets' destination MACs. This should
536 ordinarily be used to disable MAC learning on VLANs used for
537 mirroring (RSPAN VLANs). It may also be useful for debugging.
540 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
541 the <ref table="Port"/> table) is incompatible with
542 <code>flood_vlans</code>. Consider using another bonding mode or
543 a different type of mirror instead.
547 <column name="auto_attach">
548 Auto Attach configuration.
552 <group title="OpenFlow Configuration">
553 <column name="controller">
555 OpenFlow controller set. If unset, then no OpenFlow controllers
560 If there are primary controllers, removing all of them clears the
561 flow table. If there are no primary controllers, adding one also
562 clears the flow table. Other changes to the set of controllers, such
563 as adding or removing a service controller, adding another primary
564 controller to supplement an existing primary controller, or removing
565 only one of two primary controllers, have no effect on the flow
570 <column name="flow_tables">
571 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
572 table ID to configuration for that table.
575 <column name="fail_mode">
576 <p>When a controller is configured, it is, ordinarily, responsible
577 for setting up all flows on the switch. Thus, if the connection to
578 the controller fails, no new network connections can be set up.
579 If the connection to the controller stays down long enough,
580 no packets can pass through the switch at all. This setting
581 determines the switch's response to such a situation. It may be set
582 to one of the following:
584 <dt><code>standalone</code></dt>
585 <dd>If no message is received from the controller for three
586 times the inactivity probe interval
587 (see <ref column="inactivity_probe"/>), then Open vSwitch
588 will take over responsibility for setting up flows. In
589 this mode, Open vSwitch causes the bridge to act like an
590 ordinary MAC-learning switch. Open vSwitch will continue
591 to retry connecting to the controller in the background
592 and, when the connection succeeds, it will discontinue its
593 standalone behavior.</dd>
594 <dt><code>secure</code></dt>
595 <dd>Open vSwitch will not set up flows on its own when the
596 controller connection fails or when no controllers are
597 defined. The bridge will continue to retry connecting to
598 any defined controllers forever.</dd>
602 The default is <code>standalone</code> if the value is unset, but
603 future versions of Open vSwitch may change the default.
606 The <code>standalone</code> mode can create forwarding loops on a
607 bridge that has more than one uplink port unless STP is enabled. To
608 avoid loops on such a bridge, configure <code>secure</code> mode or
609 enable STP (see <ref column="stp_enable"/>).
611 <p>When more than one controller is configured,
612 <ref column="fail_mode"/> is considered only when none of the
613 configured controllers can be contacted.</p>
615 Changing <ref column="fail_mode"/> when no primary controllers are
616 configured clears the flow table.
620 <column name="datapath_id">
621 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
622 (Setting this column has no useful effect. Set <ref
623 column="other-config" key="datapath-id"/> instead.)
626 <column name="datapath_version">
628 Reports the version number of the Open vSwitch datapath in use.
629 This allows management software to detect and report discrepancies
630 between Open vSwitch userspace and datapath versions. (The <ref
631 column="ovs_version" table="Open_vSwitch"/> column in the <ref
632 table="Open_vSwitch"/> reports the Open vSwitch userspace version.)
633 The version reported depends on the datapath in use:
638 When the kernel module included in the Open vSwitch source tree is
639 used, this column reports the Open vSwitch version from which the
644 When the kernel module that is part of the upstream Linux kernel is
645 used, this column reports <code><unknown></code>.
649 When the datapath is built into the <code>ovs-vswitchd</code>
650 binary, this column reports <code><built-in></code>. A
651 built-in datapath is by definition the same version as the rest of
652 the Open VSwitch userspace.
656 Other datapaths (such as the Hyper-V kernel datapath) currently
657 report <code><unknown></code>.
662 A version discrepancy between <code>ovs-vswitchd</code> and the
663 datapath in use is not normally cause for alarm. The Open vSwitch
664 kernel datapaths for Linux and Hyper-V, in particular, are designed
665 for maximum inter-version compatibility: any userspace version works
666 with with any kernel version. Some reasons do exist to insist on
667 particular user/kernel pairings. First, newer kernel versions add
668 new features, that can only be used by new-enough userspace, e.g.
669 VXLAN tunneling requires certain minimal userspace and kernel
670 versions. Second, as an extension to the first reason, some newer
671 kernel versions add new features for enhancing performance that only
672 new-enough userspace versions can take advantage of.
676 <column name="other_config" key="datapath-id">
677 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
678 value. May not be all-zero.
681 <column name="other_config" key="dp-desc">
682 Human readable description of datapath. It it a maximum 256
683 byte-long free-form string to describe the datapath for
684 debugging purposes, e.g. <code>switch3 in room 3120</code>.
687 <column name="other_config" key="disable-in-band"
688 type='{"type": "boolean"}'>
689 If set to <code>true</code>, disable in-band control on the bridge
690 regardless of controller and manager settings.
693 <column name="other_config" key="in-band-queue"
694 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
695 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
696 that will be used by flows set up by in-band control on this bridge.
697 If unset, or if the port used by an in-band control flow does not have
698 QoS configured, or if the port does not have a queue with the specified
699 ID, the default queue is used instead.
702 <column name="protocols">
704 List of OpenFlow protocols that may be used when negotiating
705 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
706 1.3 are enabled by default if this column is empty.
710 OpenFlow 1.4 is not enabled by default because its implementation is
715 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
716 experimental because the OpenFlow 1.5 specification is still under
717 development and thus subject to change. Pass
718 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
719 OpenFlow 1.5 to be enabled.
724 <group title="Spanning Tree Configuration">
726 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
727 that ensures loop-free topologies. It allows redundant links to
728 be included in the network to provide automatic backup paths if
729 the active links fails.
733 These settings configure the slower-to-converge but still widely
734 supported version of Spanning Tree Protocol, sometimes known as
735 802.1D-1998. Open vSwitch also supports the newer Rapid Spanning Tree
736 Protocol (RSTP), documented later in the section titled <code>Rapid
737 Spanning Tree Configuration</code>.
740 <group title="STP Configuration">
741 <column name="stp_enable" type='{"type": "boolean"}'>
743 Enable spanning tree on the bridge. By default, STP is disabled
744 on bridges. Bond, internal, and mirror ports are not supported
745 and will not participate in the spanning tree.
749 STP and RSTP are mutually exclusive. If both are enabled, RSTP
754 <column name="other_config" key="stp-system-id">
755 The bridge's STP identifier (the lower 48 bits of the bridge-id)
757 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
758 By default, the identifier is the MAC address of the bridge.
761 <column name="other_config" key="stp-priority"
762 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
763 The bridge's relative priority value for determining the root
764 bridge (the upper 16 bits of the bridge-id). A bridge with the
765 lowest bridge-id is elected the root. By default, the priority
769 <column name="other_config" key="stp-hello-time"
770 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
771 The interval between transmissions of hello messages by
772 designated ports, in seconds. By default the hello interval is
776 <column name="other_config" key="stp-max-age"
777 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
778 The maximum age of the information transmitted by the bridge
779 when it is the root bridge, in seconds. By default, the maximum
783 <column name="other_config" key="stp-forward-delay"
784 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
785 The delay to wait between transitioning root and designated
786 ports to <code>forwarding</code>, in seconds. By default, the
787 forwarding delay is 15 seconds.
790 <column name="other_config" key="mcast-snooping-aging-time"
791 type='{"type": "integer", "minInteger": 1}'>
793 The maximum number of seconds to retain a multicast snooping entry for
794 which no packets have been seen. The default is currently 300
795 seconds (5 minutes). The value, if specified, is forced into a
796 reasonable range, currently 15 to 3600 seconds.
800 <column name="other_config" key="mcast-snooping-table-size"
801 type='{"type": "integer", "minInteger": 1}'>
803 The maximum number of multicast snooping addresses to learn. The
804 default is currently 2048. The value, if specified, is forced into
805 a reasonable range, currently 10 to 1,000,000.
808 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
809 type='{"type": "boolean"}'>
811 If set to <code>false</code>, unregistered multicast packets are forwarded
813 If set to <code>true</code>, unregistered multicast packets are forwarded
814 to ports connected to multicast routers.
819 <group title="STP Status">
821 These key-value pairs report the status of 802.1D-1998. They are
822 present only if STP is enabled (via the <ref column="stp_enable"/>
825 <column name="status" key="stp_bridge_id">
826 The bridge ID used in spanning tree advertisements, in the form
827 <var>xxxx</var>.<var>yyyyyyyyyyyy</var> where the <var>x</var>s are
828 the STP priority, the <var>y</var>s are the STP system ID, and each
829 <var>x</var> and <var>y</var> is a hex digit.
831 <column name="status" key="stp_designated_root">
832 The designated root for this spanning tree, in the same form as <ref
833 column="status" key="stp_bridge_id"/>. If this bridge is the root,
834 this will have the same value as <ref column="status"
835 key="stp_bridge_id"/>, otherwise it will differ.
837 <column name="status" key="stp_root_path_cost">
838 The path cost of reaching the designated bridge. A lower number is
839 better. The value is 0 if this bridge is the root, otherwise it is
845 <group title="Rapid Spanning Tree">
847 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
848 that ensures loop-free topologies. RSTP superseded STP with the
849 publication of 802.1D-2004. Compared to STP, RSTP converges more
850 quickly and recovers more quickly from failures.
853 <group title="RSTP Configuration">
854 <column name="rstp_enable" type='{"type": "boolean"}'>
856 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
857 on bridges. Bond, internal, and mirror ports are not supported
858 and will not participate in the spanning tree.
862 STP and RSTP are mutually exclusive. If both are enabled, RSTP
867 <column name="other_config" key="rstp-address">
868 The bridge's RSTP address (the lower 48 bits of the bridge-id)
870 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
871 By default, the address is the MAC address of the bridge.
874 <column name="other_config" key="rstp-priority"
875 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
876 The bridge's relative priority value for determining the root
877 bridge (the upper 16 bits of the bridge-id). A bridge with the
878 lowest bridge-id is elected the root. By default, the priority
879 is 0x8000 (32768). This value needs to be a multiple of 4096,
880 otherwise it's rounded to the nearest inferior one.
883 <column name="other_config" key="rstp-ageing-time"
884 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
885 The Ageing Time parameter for the Bridge. The default value
889 <column name="other_config" key="rstp-force-protocol-version"
890 type='{"type": "integer"}'>
891 The Force Protocol Version parameter for the Bridge. This
892 can take the value 0 (STP Compatibility mode) or 2
893 (the default, normal operation).
896 <column name="other_config" key="rstp-max-age"
897 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
898 The maximum age of the information transmitted by the Bridge
899 when it is the Root Bridge. The default value is 20.
902 <column name="other_config" key="rstp-forward-delay"
903 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
904 The delay used by STP Bridges to transition Root and Designated
905 Ports to Forwarding. The default value is 15.
908 <column name="other_config" key="rstp-transmit-hold-count"
909 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
910 The Transmit Hold Count used by the Port Transmit state machine
911 to limit transmission rate. The default value is 6.
915 <group title="RSTP Status">
917 These key-value pairs report the status of 802.1D-2004. They are
918 present only if RSTP is enabled (via the <ref column="rstp_enable"/>
921 <column name="rstp_status" key="rstp_bridge_id">
922 The bridge ID used in rapid spanning tree advertisements, in the form
923 <var>x</var>.<var>yyy</var>.<var>zzzzzzzzzzzz</var> where
924 <var>x</var> is the RSTP priority, the <var>y</var>s are a locally
925 assigned system ID extension, the <var>z</var>s are the STP system
926 ID, and each <var>x</var>, <var>y</var>, or <var>z</var> is a hex
929 <column name="rstp_status" key="rstp_root_id">
930 The root of this spanning tree, in the same form as <ref
931 column="rstp_status" key="rstp_bridge_id"/>. If this bridge is the
932 root, this will have the same value as <ref column="rstp_status"
933 key="rstp_bridge_id"/>, otherwise it will differ.
935 <column name="rstp_status" key="rstp_root_path_cost"
936 type='{"type": "integer", "minInteger": 0}'>
937 The path cost of reaching the root. A lower number is better. The
938 value is 0 if this bridge is the root, otherwise it is higher.
940 <column name="rstp_status" key="rstp_designated_id">
941 The RSTP designated ID, in the same form as <ref column="rstp_status"
942 key="rstp_bridge_id"/>.
944 <column name="rstp_status" key="rstp_designated_port_id">
945 The RSTP designated port ID, as a 4-digit hex number.
947 <column name="rstp_status" key="rstp_bridge_port_id">
948 The RSTP bridge port ID, as a 4-digit hex number.
953 <group title="Multicast Snooping Configuration">
954 Multicast snooping (RFC 4541) monitors the Internet Group Management
955 Protocol (IGMP) and Multicast Listener Discovery traffic between hosts
956 and multicast routers. The switch uses what IGMP and MLD snooping
957 learns to forward multicast traffic only to interfaces that are connected
958 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
959 MLDv1 and MLDv2 protocols.
961 <column name="mcast_snooping_enable">
962 Enable multicast snooping on the bridge. For now, the default
967 <group title="Other Features">
968 <column name="datapath_type">
969 Name of datapath provider. The kernel datapath has type
970 <code>system</code>. The userspace datapath has type
971 <code>netdev</code>. A manager may refer to the <ref
972 table="Open_vSwitch" column="datapath_types"/> column of the <ref
973 table="Open_vSwitch"/> table for a list of the types accepted by this
974 Open vSwitch instance.
977 <column name="external_ids" key="bridge-id">
978 A unique identifier of the bridge. On Citrix XenServer this will
979 commonly be the same as
980 <ref column="external_ids" key="xs-network-uuids"/>.
983 <column name="external_ids" key="xs-network-uuids">
984 Semicolon-delimited set of universally unique identifier(s) for the
985 network with which this bridge is associated on a Citrix XenServer
986 host. The network identifiers are RFC 4122 UUIDs as displayed by,
987 e.g., <code>xe network-list</code>.
990 <column name="other_config" key="hwaddr">
991 An Ethernet address in the form
992 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
993 to set the hardware address of the local port and influence the
997 <column name="other_config" key="forward-bpdu"
998 type='{"type": "boolean"}'>
1001 Controls forwarding of BPDUs and other network control frames when
1002 NORMAL action is invoked. When this option is <code>false</code> or
1003 unset, frames with reserved Ethernet addresses (see table below) will
1004 not be forwarded. When this option is <code>true</code>, such frames
1005 will not be treated specially.
1009 The above general rule has the following exceptions:
1014 If STP is enabled on the bridge (see the <ref column="stp_enable"
1015 table="Bridge"/> column in the <ref table="Bridge"/> table), the
1016 bridge processes all received STP packets and never passes them to
1017 OpenFlow or forwards them. This is true even if STP is disabled on
1022 If LLDP is enabled on an interface (see the <ref column="lldp"
1023 table="Interface"/> column in the <ref table="Interface"/> table),
1024 the interface processes received LLDP packets and never passes them
1025 to OpenFlow or forwards them.
1030 Set this option to <code>true</code> if the Open vSwitch bridge
1031 connects different Ethernet networks and is not configured to
1036 This option affects packets with the following destination MAC
1041 <dt><code>01:80:c2:00:00:00</code></dt>
1042 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1044 <dt><code>01:80:c2:00:00:01</code></dt>
1045 <dd>IEEE Pause frame.</dd>
1047 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1048 <dd>Other reserved protocols.</dd>
1050 <dt><code>00:e0:2b:00:00:00</code></dt>
1051 <dd>Extreme Discovery Protocol (EDP).</dd>
1054 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
1056 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
1058 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1060 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1061 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1065 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1066 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1068 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1069 <dd>Cisco STP Uplink Fast.</dd>
1071 <dt><code>01:00:0c:00:00:00</code></dt>
1072 <dd>Cisco Inter Switch Link.</dd>
1074 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
1079 <column name="other_config" key="mac-aging-time"
1080 type='{"type": "integer", "minInteger": 1}'>
1082 The maximum number of seconds to retain a MAC learning entry for
1083 which no packets have been seen. The default is currently 300
1084 seconds (5 minutes). The value, if specified, is forced into a
1085 reasonable range, currently 15 to 3600 seconds.
1089 A short MAC aging time allows a network to more quickly detect that a
1090 host is no longer connected to a switch port. However, it also makes
1091 it more likely that packets will be flooded unnecessarily, when they
1092 are addressed to a connected host that rarely transmits packets. To
1093 reduce the incidence of unnecessary flooding, use a MAC aging time
1094 longer than the maximum interval at which a host will ordinarily
1099 <column name="other_config" key="mac-table-size"
1100 type='{"type": "integer", "minInteger": 1}'>
1102 The maximum number of MAC addresses to learn. The default is
1103 currently 2048. The value, if specified, is forced into a reasonable
1104 range, currently 10 to 1,000,000.
1109 <group title="Common Columns">
1110 The overall purpose of these columns is described under <code>Common
1111 Columns</code> at the beginning of this document.
1113 <column name="other_config"/>
1114 <column name="external_ids"/>
1118 <table name="Port" table="Port or bond configuration.">
1119 <p>A port within a <ref table="Bridge"/>.</p>
1120 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1121 <ref column="interfaces"/> column. Such a port logically
1122 corresponds to a port on a physical Ethernet switch. A port
1123 with more than one interface is a ``bonded port'' (see
1124 <ref group="Bonding Configuration"/>).</p>
1125 <p>Some properties that one might think as belonging to a port are actually
1126 part of the port's <ref table="Interface"/> members.</p>
1128 <column name="name">
1129 Port name. Should be alphanumeric and no more than about 8
1130 bytes long. May be the same as the interface name, for
1131 non-bonded ports. Must otherwise be unique among the names of
1132 ports, interfaces, and bridges on a host.
1135 <column name="interfaces">
1136 The port's interfaces. If there is more than one, this is a
1140 <group title="VLAN Configuration">
1141 <p>Bridge ports support the following types of VLAN configuration:</p>
1146 A trunk port carries packets on one or more specified VLANs
1147 specified in the <ref column="trunks"/> column (often, on every
1148 VLAN). A packet that ingresses on a trunk port is in the VLAN
1149 specified in its 802.1Q header, or VLAN 0 if the packet has no
1150 802.1Q header. A packet that egresses through a trunk port will
1151 have an 802.1Q header if it has a nonzero VLAN ID.
1155 Any packet that ingresses on a trunk port tagged with a VLAN that
1156 the port does not trunk is dropped.
1163 An access port carries packets on exactly one VLAN specified in the
1164 <ref column="tag"/> column. Packets egressing on an access port
1165 have no 802.1Q header.
1169 Any packet with an 802.1Q header with a nonzero VLAN ID that
1170 ingresses on an access port is dropped, regardless of whether the
1171 VLAN ID in the header is the access port's VLAN ID.
1175 <dt>native-tagged</dt>
1177 A native-tagged port resembles a trunk port, with the exception that
1178 a packet without an 802.1Q header that ingresses on a native-tagged
1179 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1183 <dt>native-untagged</dt>
1185 A native-untagged port resembles a native-tagged port, with the
1186 exception that a packet that egresses on a native-untagged port in
1187 the native VLAN will not have an 802.1Q header.
1191 A packet will only egress through bridge ports that carry the VLAN of
1192 the packet, as described by the rules above.
1195 <column name="vlan_mode">
1197 The VLAN mode of the port, as described above. When this column is
1198 empty, a default mode is selected as follows:
1202 If <ref column="tag"/> contains a value, the port is an access
1203 port. The <ref column="trunks"/> column should be empty.
1206 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1207 column value is honored if it is present.
1214 For an access port, the port's implicitly tagged VLAN. For a
1215 native-tagged or native-untagged port, the port's native VLAN. Must
1216 be empty if this is a trunk port.
1220 <column name="trunks">
1222 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1223 or VLANs that this port trunks; if it is empty, then the port trunks
1224 all VLANs. Must be empty if this is an access port.
1227 A native-tagged or native-untagged port always trunks its native
1228 VLAN, regardless of whether <ref column="trunks"/> includes that
1233 <column name="other_config" key="priority-tags"
1234 type='{"type": "boolean"}'>
1236 An 802.1Q header contains two important pieces of information: a VLAN
1237 ID and a priority. A frame with a zero VLAN ID, called a
1238 ``priority-tagged'' frame, is supposed to be treated the same way as
1239 a frame without an 802.1Q header at all (except for the priority).
1243 However, some network elements ignore any frame that has 802.1Q
1244 header at all, even when the VLAN ID is zero. Therefore, by default
1245 Open vSwitch does not output priority-tagged frames, instead omitting
1246 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1247 <code>true</code> to enable priority-tagged frames on a port.
1251 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1252 output if both the VLAN ID and priority would be zero.
1256 All frames output to native-tagged ports have a nonzero VLAN ID, so
1257 this setting is not meaningful on native-tagged ports.
1262 <group title="Bonding Configuration">
1263 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1264 allows for load balancing and fail-over.</p>
1267 The following types of bonding will work with any kind of upstream
1268 switch. On the upstream switch, do not configure the interfaces as a
1273 <dt><code>balance-slb</code></dt>
1275 Balances flows among slaves based on source MAC address and output
1276 VLAN, with periodic rebalancing as traffic patterns change.
1279 <dt><code>active-backup</code></dt>
1281 Assigns all flows to one slave, failing over to a backup slave when
1282 the active slave is disabled. This is the only bonding mode in which
1283 interfaces may be plugged into different upstream switches.
1288 The following modes require the upstream switch to support 802.3ad with
1289 successful LACP negotiation. If LACP negotiation fails and
1290 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1295 <dt><code>balance-tcp</code></dt>
1297 Balances flows among slaves based on L2, L3, and L4 protocol
1298 information such as destination MAC address, IP address, and TCP
1303 <p>These columns apply only to bonded ports. Their values are
1304 otherwise ignored.</p>
1306 <column name="bond_mode">
1307 <p>The type of bonding used for a bonded port. Defaults to
1308 <code>active-backup</code> if unset.
1312 <column name="other_config" key="bond-hash-basis"
1313 type='{"type": "integer"}'>
1314 An integer hashed along with flows when choosing output slaves in load
1315 balanced bonds. When changed, all flows will be assigned different
1316 hash values possibly causing slave selection decisions to change. Does
1317 not affect bonding modes which do not employ load balancing such as
1318 <code>active-backup</code>.
1321 <group title="Link Failure Detection">
1323 An important part of link bonding is detecting that links are down so
1324 that they may be disabled. These settings determine how Open vSwitch
1325 detects link failure.
1328 <column name="other_config" key="bond-detect-mode"
1329 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1330 The means used to detect link failures. Defaults to
1331 <code>carrier</code> which uses each interface's carrier to detect
1332 failures. When set to <code>miimon</code>, will check for failures
1333 by polling each interface's MII.
1336 <column name="other_config" key="bond-miimon-interval"
1337 type='{"type": "integer"}'>
1338 The interval, in milliseconds, between successive attempts to poll
1339 each interface's MII. Relevant only when <ref column="other_config"
1340 key="bond-detect-mode"/> is <code>miimon</code>.
1343 <column name="bond_updelay">
1345 The number of milliseconds for which the link must stay up on an
1346 interface before the interface is considered to be up. Specify
1347 <code>0</code> to enable the interface immediately.
1351 This setting is honored only when at least one bonded interface is
1352 already enabled. When no interfaces are enabled, then the first
1353 bond interface to come up is enabled immediately.
1357 <column name="bond_downdelay">
1358 The number of milliseconds for which the link must stay down on an
1359 interface before the interface is considered to be down. Specify
1360 <code>0</code> to disable the interface immediately.
1364 <group title="LACP Configuration">
1366 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1367 allows switches to automatically detect that they are connected by
1368 multiple links and aggregate across those links. These settings
1369 control LACP behavior.
1372 <column name="lacp">
1373 Configures LACP on this port. LACP allows directly connected
1374 switches to negotiate which links may be bonded. LACP may be enabled
1375 on non-bonded ports for the benefit of any switches they may be
1376 connected to. <code>active</code> ports are allowed to initiate LACP
1377 negotiations. <code>passive</code> ports are allowed to participate
1378 in LACP negotiations initiated by a remote switch, but not allowed to
1379 initiate such negotiations themselves. If LACP is enabled on a port
1380 whose partner switch does not support LACP, the bond will be
1381 disabled, unless other-config:lacp-fallback-ab is set to true.
1382 Defaults to <code>off</code> if unset.
1385 <column name="other_config" key="lacp-system-id">
1386 The LACP system ID of this <ref table="Port"/>. The system ID of a
1387 LACP bond is used to identify itself to its partners. Must be a
1388 nonzero MAC address. Defaults to the bridge Ethernet address if
1392 <column name="other_config" key="lacp-system-priority"
1393 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1394 The LACP system priority of this <ref table="Port"/>. In LACP
1395 negotiations, link status decisions are made by the system with the
1396 numerically lower priority.
1399 <column name="other_config" key="lacp-time"
1400 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1402 The LACP timing which should be used on this <ref table="Port"/>.
1403 By default <code>slow</code> is used. When configured to be
1404 <code>fast</code> LACP heartbeats are requested at a rate of once
1405 per second causing connectivity problems to be detected more
1406 quickly. In <code>slow</code> mode, heartbeats are requested at a
1407 rate of once every 30 seconds.
1411 <column name="other_config" key="lacp-fallback-ab"
1412 type='{"type": "boolean"}'>
1414 Determines the behavior of openvswitch bond in LACP mode. If
1415 the partner switch does not support LACP, setting this option
1416 to <code>true</code> allows openvswitch to fallback to
1417 active-backup. If the option is set to <code>false</code>, the
1418 bond will be disabled. In both the cases, once the partner switch
1419 is configured to LACP mode, the bond will use LACP.
1424 <group title="Rebalancing Configuration">
1426 These settings control behavior when a bond is in
1427 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1430 <column name="other_config" key="bond-rebalance-interval"
1431 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1432 For a load balanced bonded port, the number of milliseconds between
1433 successive attempts to rebalance the bond, that is, to move flows
1434 from one interface on the bond to another in an attempt to keep usage
1435 of each interface roughly equal. If zero, load balancing is disabled
1436 on the bond (link failure still cause flows to move). If
1437 less than 1000ms, the rebalance interval will be 1000ms.
1441 <column name="bond_fake_iface">
1442 For a bonded port, whether to create a fake internal interface with the
1443 name of the port. Use only for compatibility with legacy software that
1448 <group title="Spanning Tree Protocol">
1450 The configuration here is only meaningful, and the status is only
1451 populated, when 802.1D-1998 Spanning Tree Protocol is enabled on the
1452 port's <ref column="Bridge"/> with its <ref column="stp_enable"/>
1456 <group title="STP Configuration">
1457 <column name="other_config" key="stp-enable"
1458 type='{"type": "boolean"}'>
1459 When STP is enabled on a bridge, it is enabled by default on all of
1460 the bridge's ports except bond, internal, and mirror ports (which do
1461 not work with STP). If this column's value is <code>false</code>,
1462 STP is disabled on the port.
1465 <column name="other_config" key="stp-port-num"
1466 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1467 The port number used for the lower 8 bits of the port-id. By
1468 default, the numbers will be assigned automatically. If any
1469 port's number is manually configured on a bridge, then they
1473 <column name="other_config" key="stp-port-priority"
1474 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1475 The port's relative priority value for determining the root
1476 port (the upper 8 bits of the port-id). A port with a lower
1477 port-id will be chosen as the root port. By default, the
1481 <column name="other_config" key="stp-path-cost"
1482 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1483 Spanning tree path cost for the port. A lower number indicates
1484 a faster link. By default, the cost is based on the maximum
1489 <group title="STP Status">
1490 <column name="status" key="stp_port_id">
1491 The port ID used in spanning tree advertisements for this port, as 4
1492 hex digits. Configuring the port ID is described in the
1493 <code>stp-port-num</code> and <code>stp-port-priority</code> keys of
1494 the <code>other_config</code> section earlier.
1496 <column name="status" key="stp_state"
1497 type='{"type": "string", "enum": ["set",
1498 ["disabled", "listening", "learning",
1499 "forwarding", "blocking"]]}'>
1500 STP state of the port.
1502 <column name="status" key="stp_sec_in_state"
1503 type='{"type": "integer", "minInteger": 0}'>
1504 The amount of time this port has been in the current STP state, in
1507 <column name="status" key="stp_role"
1508 type='{"type": "string", "enum": ["set",
1509 ["root", "designated", "alternate"]]}'>
1510 STP role of the port.
1515 <group title="Rapid Spanning Tree Protocol">
1517 The configuration here is only meaningful, and the status and
1518 statistics are only populated, when 802.1D-1998 Spanning Tree Protocol
1519 is enabled on the port's <ref column="Bridge"/> with its <ref
1520 column="stp_enable"/> column.
1523 <group title="RSTP Configuration">
1524 <column name="other_config" key="rstp-enable"
1525 type='{"type": "boolean"}'>
1526 When RSTP is enabled on a bridge, it is enabled by default on all of
1527 the bridge's ports except bond, internal, and mirror ports (which do
1528 not work with RSTP). If this column's value is <code>false</code>,
1529 RSTP is disabled on the port.
1532 <column name="other_config" key="rstp-port-priority"
1533 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1534 The port's relative priority value for determining the root port, in
1535 multiples of 16. By default, the port priority is 0x80 (128). Any
1536 value in the lower 4 bits is rounded off. The significant upper 4
1537 bits become the upper 4 bits of the port-id. A port with the lowest
1538 port-id is elected as the root.
1541 <column name="other_config" key="rstp-port-num"
1542 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1543 The local RSTP port number, used as the lower 12 bits of the port-id.
1544 By default the port numbers are assigned automatically, and typically
1545 may not correspond to the OpenFlow port numbers. A port with the
1546 lowest port-id is elected as the root.
1549 <column name="other_config" key="rstp-port-path-cost"
1550 type='{"type": "integer"}'>
1551 The port path cost. The Port's contribution, when it is
1552 the Root Port, to the Root Path Cost for the Bridge. By default the
1553 cost is automatically calculated from the port's speed.
1556 <column name="other_config" key="rstp-port-admin-edge"
1557 type='{"type": "boolean"}'>
1558 The admin edge port parameter for the Port. Default is
1562 <column name="other_config" key="rstp-port-auto-edge"
1563 type='{"type": "boolean"}'>
1564 The auto edge port parameter for the Port. Default is
1568 <column name="other_config" key="rstp-port-mcheck"
1569 type='{"type": "boolean"}'>
1571 The mcheck port parameter for the Port. Default is
1572 <code>false</code>. May be set to force the Port Protocol
1573 Migration state machine to transmit RST BPDUs for a
1574 MigrateTime period, to test whether all STP Bridges on the
1575 attached LAN have been removed and the Port can continue to
1576 transmit RSTP BPDUs. Setting mcheck has no effect if the
1577 Bridge is operating in STP Compatibility mode.
1580 Changing the value from <code>true</code> to
1581 <code>false</code> has no effect, but needs to be done if
1582 this behavior is to be triggered again by subsequently
1583 changing the value from <code>false</code> to
1589 <group title="RSTP Status">
1590 <column name="rstp_status" key="rstp_port_id">
1591 The port ID used in spanning tree advertisements for this port, as 4
1592 hex digits. Configuring the port ID is described in the
1593 <code>rstp-port-num</code> and <code>rstp-port-priority</code> keys
1594 of the <code>other_config</code> section earlier.
1596 <column name="rstp_status" key="rstp_port_role"
1597 type='{"type": "string", "enum": ["set",
1598 ["Root", "Designated", "Alternate", "Backup", "Disabled"]]}'>
1599 RSTP role of the port.
1601 <column name="rstp_status" key="rstp_port_state"
1602 type='{"type": "string", "enum": ["set",
1603 ["Disabled", "Learning", "Forwarding", "Discarding"]]}'>
1604 RSTP state of the port.
1606 <column name="rstp_status" key="rstp_designated_bridge_id">
1607 The port's RSTP designated bridge ID, in the same form as <ref
1608 column="rstp_status" key="rstp_bridge_id"/> in the <ref
1609 table="Bridge"/> table.
1611 <column name="rstp_status" key="rstp_designated_port_id">
1612 The port's RSTP designated port ID, as 4 hex digits.
1614 <column name="rstp_status" key="rstp_designated_path_cost"
1615 type='{"type": "integer"}'>
1616 The port's RSTP designated path cost. Lower is better.
1620 <group title="RSTP Statistics">
1621 <column name="rstp_statistics" key="rstp_tx_count">
1622 Number of RSTP BPDUs transmitted through this port.
1624 <column name="rstp_statistics" key="rstp_rx_count">
1625 Number of valid RSTP BPDUs received by this port.
1627 <column name="rstp_statistics" key="rstp_error_count">
1628 Number of invalid RSTP BPDUs received by this port.
1630 <column name="rstp_statistics" key="rstp_uptime">
1631 The duration covered by the other RSTP statistics, in seconds.
1636 <group title="Multicast Snooping">
1637 <column name="other_config" key="mcast-snooping-flood"
1638 type='{"type": "boolean"}'>
1640 If set to <code>true</code>, multicast packets (except Reports) are
1641 unconditionally forwarded to the specific port.
1644 <column name="other_config" key="mcast-snooping-flood-reports"
1645 type='{"type": "boolean"}'>
1647 If set to <code>true</code>, multicast Reports are unconditionally
1648 forwarded to the specific port.
1653 <group title="Other Features">
1655 Quality of Service configuration for this port.
1659 The MAC address to use for this port for the purpose of choosing the
1660 bridge's MAC address. This column does not necessarily reflect the
1661 port's actual MAC address, nor will setting it change the port's actual
1665 <column name="fake_bridge">
1666 Does this port represent a sub-bridge for its tagged VLAN within the
1667 Bridge? See ovs-vsctl(8) for more information.
1670 <column name="external_ids" key="fake-bridge-id-*">
1671 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1672 column) are defined by prefixing a <ref table="Bridge"/> <ref
1673 table="Bridge" column="external_ids"/> key with
1674 <code>fake-bridge-</code>,
1675 e.g. <code>fake-bridge-xs-network-uuids</code>.
1678 <column name="other_config" key="transient"
1679 type='{"type": "boolean"}'>
1681 If set to <code>true</code>, the port will be removed when
1682 <code>ovs-ctl start --delete-transient-ports</code> is used.
1687 <column name="bond_active_slave">
1688 For a bonded port, record the mac address of the current active slave.
1691 <group title="Port Statistics">
1693 Key-value pairs that report port statistics. The update period
1694 is controlled by <ref column="other_config"
1695 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1697 <group title="Statistics: STP transmit and receive counters">
1698 <column name="statistics" key="stp_tx_count">
1699 Number of STP BPDUs sent on this port by the spanning
1702 <column name="statistics" key="stp_rx_count">
1703 Number of STP BPDUs received on this port and accepted by the
1704 spanning tree library.
1706 <column name="statistics" key="stp_error_count">
1707 Number of bad STP BPDUs received on this port. Bad BPDUs
1708 include runt packets and those with an unexpected protocol ID.
1713 <group title="Common Columns">
1714 The overall purpose of these columns is described under <code>Common
1715 Columns</code> at the beginning of this document.
1717 <column name="other_config"/>
1718 <column name="external_ids"/>
1722 <table name="Interface" title="One physical network device in a Port.">
1723 An interface within a <ref table="Port"/>.
1725 <group title="Core Features">
1726 <column name="name">
1727 Interface name. Should be alphanumeric and no more than about 8 bytes
1728 long. May be the same as the port name, for non-bonded ports. Must
1729 otherwise be unique among the names of ports, interfaces, and bridges
1733 <column name="ifindex">
1734 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1735 2863, if the interface has one, otherwise 0. The ifindex is useful for
1736 seamless integration with protocols such as SNMP and sFlow.
1739 <column name="mac_in_use">
1740 The MAC address in use by this interface.
1744 <p>Ethernet address to set for this interface. If unset then the
1745 default MAC address is used:</p>
1747 <li>For the local interface, the default is the lowest-numbered MAC
1748 address among the other bridge ports, either the value of the
1749 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1750 if set, or its actual MAC (for bonded ports, the MAC of its slave
1751 whose name is first in alphabetical order). Internal ports and
1752 bridge ports that are used as port mirroring destinations (see the
1753 <ref table="Mirror"/> table) are ignored.</li>
1754 <li>For other internal interfaces, the default MAC is randomly
1756 <li>External interfaces typically have a MAC address associated with
1757 their hardware.</li>
1759 <p>Some interfaces may not have a software-controllable MAC
1763 <column name="error">
1764 If the configuration of the port failed, as indicated by -1 in <ref
1765 column="ofport"/>, Open vSwitch sets this column to an error
1766 description in human readable form. Otherwise, Open vSwitch clears
1770 <group title="OpenFlow Port Number">
1772 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1773 port number for the new port. If the client that adds the port fills
1774 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1775 value as the OpenFlow port number. Otherwise, or if the requested
1776 port number is already in use or cannot be used for another reason,
1777 Open vSwitch automatically assigns a free port number. Regardless of
1778 how the port number was obtained, Open vSwitch then reports in <ref
1779 column="ofport"/> the port number actually assigned.
1783 Open vSwitch limits the port numbers that it automatically assigns to
1784 the range 1 through 32,767, inclusive. Controllers therefore have
1785 free use of ports 32,768 and up.
1788 <column name="ofport">
1790 OpenFlow port number for this interface. Open vSwitch sets this
1791 column's value, so other clients should treat it as read-only.
1794 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1795 The other valid port numbers are in the range 1 to 65,279,
1796 inclusive. Value -1 indicates an error adding the interface.
1800 <column name="ofport_request"
1801 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1803 Requested OpenFlow port number for this interface.
1807 A client should ideally set this column's value in the same
1808 database transaction that it uses to create the interface. Open
1809 vSwitch version 2.1 and later will honor a later request for a
1810 specific port number, althuogh it might confuse some controllers:
1811 OpenFlow does not have a way to announce a port number change, so
1812 Open vSwitch represents it over OpenFlow as a port deletion
1813 followed immediately by a port addition.
1817 If <ref column="ofport_request"/> is set or changed to some other
1818 port's automatically assigned port number, Open vSwitch chooses a
1819 new port number for the latter port.
1825 <group title="System-Specific Details">
1826 <column name="type">
1828 The interface type. The types supported by a particular instance of
1829 Open vSwitch are listed in the <ref table="Open_vSwitch"
1830 column="iface_types"/> column in the <ref table="Open_vSwitch"/>
1831 table. The following types are defined:
1835 <dt><code>system</code></dt>
1836 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1837 Sometimes referred to as ``external interfaces'' since they are
1838 generally connected to hardware external to that on which the Open
1839 vSwitch is running. The empty string is a synonym for
1840 <code>system</code>.</dd>
1842 <dt><code>internal</code></dt>
1843 <dd>A simulated network device that sends and receives traffic. An
1844 internal interface whose <ref column="name"/> is the same as its
1845 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1846 ``local interface.'' It does not make sense to bond an internal
1847 interface, so the terms ``port'' and ``interface'' are often used
1848 imprecisely for internal interfaces.</dd>
1850 <dt><code>tap</code></dt>
1851 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1853 <dt><code>geneve</code></dt>
1855 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve-00</code>)
1858 A description of how to match and set Geneve options can be found
1859 in the <code>ovs-ofctl</code> manual page.
1862 <dt><code>gre</code></dt>
1864 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1868 <dt><code>ipsec_gre</code></dt>
1870 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1874 <dt><code>vxlan</code></dt>
1877 An Ethernet tunnel over the UDP-based VXLAN protocol described in
1881 Open vSwitch uses UDP destination port 4789. The source port used for
1882 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1887 <dt><code>lisp</code></dt>
1890 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1891 Separation Protocol (RFC 6830).
1894 Only IPv4 and IPv6 packets are supported by the protocol, and
1895 they are sent and received without an Ethernet header. Traffic
1896 to/from LISP ports is expected to be configured explicitly, and
1897 the ports are not intended to participate in learning based
1898 switching. As such, they are always excluded from packet
1903 <dt><code>stt</code></dt>
1905 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
1906 endpoints are in end-systems, as it utilizes the capabilities of
1907 standard network interface cards to improve performance. STT utilizes
1908 a TCP-like header inside the IP header. It is stateless, i.e., there is
1909 no TCP connection state of any kind associated with the tunnel. The
1910 TCP-like header is used to leverage the capabilities of existing
1911 network interface cards, but should not be interpreted as implying
1912 any sort of connection state between endpoints.
1913 Since the STT protocol does not engage in the usual TCP 3-way handshake,
1914 so it will have difficulty traversing stateful firewalls.
1915 The protocol is documented at
1916 http://www.ietf.org/archive/id/draft-davie-stt-06.txt
1918 All traffic uses a default destination port of 7471. STT is only
1919 available in kernel datapath on kernel 3.5 or newer.
1922 <dt><code>patch</code></dt>
1924 A pair of virtual devices that act as a patch cable.
1927 <dt><code>null</code></dt>
1928 <dd>An ignored interface. Deprecated and slated for removal in
1934 <group title="Tunnel Options">
1936 These options apply to interfaces with <ref column="type"/> of
1937 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1938 <code>vxlan</code>, <code>lisp</code> and <code>stt</code>.
1942 Each tunnel must be uniquely identified by the combination of <ref
1943 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1944 column="options" key="local_ip"/>, and <ref column="options"
1945 key="in_key"/>. If two ports are defined that are the same except one
1946 has an optional identifier and the other does not, the more specific
1947 one is matched first. <ref column="options" key="in_key"/> is
1948 considered more specific than <ref column="options" key="local_ip"/> if
1949 a port defines one and another port defines the other.
1952 <column name="options" key="remote_ip">
1953 <p>Required. The remote tunnel endpoint, one of:</p>
1957 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1958 Only unicast endpoints are supported.
1961 The word <code>flow</code>. The tunnel accepts packets from any
1962 remote tunnel endpoint. To process only packets from a specific
1963 remote tunnel endpoint, the flow entries may match on the
1964 <code>tun_src</code> field. When sending packets to a
1965 <code>remote_ip=flow</code> tunnel, the flow actions must
1966 explicitly set the <code>tun_dst</code> field to the IP address of
1967 the desired remote tunnel endpoint, e.g. with a
1968 <code>set_field</code> action.
1973 The remote tunnel endpoint for any packet received from a tunnel
1974 is available in the <code>tun_src</code> field for matching in the
1979 <column name="options" key="local_ip">
1981 Optional. The tunnel destination IP that received packets must
1982 match. Default is to match all addresses. If specified, may be one
1988 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1991 The word <code>flow</code>. The tunnel accepts packets sent to any
1992 of the local IP addresses of the system running OVS. To process
1993 only packets sent to a specific IP address, the flow entries may
1994 match on the <code>tun_dst</code> field. When sending packets to a
1995 <code>local_ip=flow</code> tunnel, the flow actions may
1996 explicitly set the <code>tun_src</code> field to the desired IP
1997 address, e.g. with a <code>set_field</code> action. However, while
1998 routing the tunneled packet out, the local system may override the
1999 specified address with the local IP address configured for the
2000 outgoing system interface.
2003 This option is valid only for tunnels also configured with the
2004 <code>remote_ip=flow</code> option.
2010 The tunnel destination IP address for any packet received from a
2011 tunnel is available in the <code>tun_dst</code> field for matching in
2016 <column name="options" key="in_key">
2017 <p>Optional. The key that received packets must contain, one of:</p>
2021 <code>0</code>. The tunnel receives packets with no key or with a
2022 key of 0. This is equivalent to specifying no <ref column="options"
2023 key="in_key"/> at all.
2026 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
2027 or 64-bit (for STT) number. The tunnel receives only
2028 packets with the specified key.
2031 The word <code>flow</code>. The tunnel accepts packets with any
2032 key. The key will be placed in the <code>tun_id</code> field for
2033 matching in the flow table. The <code>ovs-ofctl</code> manual page
2034 contains additional information about matching fields in OpenFlow
2043 <column name="options" key="out_key">
2044 <p>Optional. The key to be set on outgoing packets, one of:</p>
2048 <code>0</code>. Packets sent through the tunnel will have no key.
2049 This is equivalent to specifying no <ref column="options"
2050 key="out_key"/> at all.
2053 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
2054 64-bit (for STT) number. Packets sent through the tunnel
2055 will have the specified key.
2058 The word <code>flow</code>. Packets sent through the tunnel will
2059 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
2060 vendor extension (0 is used in the absence of an action). The
2061 <code>ovs-ofctl</code> manual page contains additional information
2062 about the Nicira OpenFlow vendor extensions.
2067 <column name="options" key="key">
2068 Optional. Shorthand to set <code>in_key</code> and
2069 <code>out_key</code> at the same time.
2072 <column name="options" key="tos">
2073 Optional. The value of the ToS bits to be set on the encapsulating
2074 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2075 zero. It may also be the word <code>inherit</code>, in which case
2076 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2077 (otherwise it will be 0). The ECN fields are always inherited.
2081 <column name="options" key="ttl">
2082 Optional. The TTL to be set on the encapsulating packet. It may also
2083 be the word <code>inherit</code>, in which case the TTL will be copied
2084 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2085 system default, typically 64). Default is the system default TTL.
2088 <column name="options" key="df_default"
2089 type='{"type": "boolean"}'>
2090 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2091 outer headers to allow path MTU discovery. Default is enabled; set
2092 to <code>false</code> to disable.
2095 <group title="Tunnel Options: vxlan only">
2097 <column name="options" key="exts">
2098 <p>Optional. Comma separated list of optional VXLAN extensions to
2099 enable. The following extensions are supported:</p>
2103 <code>gbp</code>: VXLAN-GBP allows to transport the group policy
2104 context of a packet across the VXLAN tunnel to other network
2105 peers. See the field description of <code>tun_gbp_id</code> and
2106 <code>tun_gbp_flags</code> in ovs-ofctl(8) for additional
2108 (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>)
2115 <group title="Tunnel Options: gre, ipsec_gre, geneve, and vxlan">
2117 <code>gre</code>, <code>ipsec_gre</code>, <code>geneve</code>, and
2118 <code>vxlan</code> interfaces support these options.
2121 <column name="options" key="csum" type='{"type": "boolean"}'>
2123 Optional. Compute encapsulation header (either GRE or UDP)
2124 checksums on outgoing packets. Default is disabled, set to
2125 <code>true</code> to enable. Checksums present on incoming
2126 packets will be validated regardless of this setting.
2130 When using the upstream Linux kernel module, computation of
2131 checksums for <code>geneve</code> and <code>vxlan</code> requires
2132 Linux kernel version 4.0 or higher. <code>gre</code> supports
2133 checksums for all versions of Open vSwitch that support GRE.
2134 The out of tree kernel module distributed as part of OVS
2135 can compute all tunnel checksums on any kernel version that it
2140 This option is supported for <code>ipsec_gre</code>, but not useful
2141 because GRE checksums are weaker than, and redundant with, IPsec
2142 payload authentication.
2147 <group title="Tunnel Options: ipsec_gre only">
2149 Only <code>ipsec_gre</code> interfaces support these options.
2152 <column name="options" key="peer_cert">
2153 Required for certificate authentication. A string containing the
2154 peer's certificate in PEM format. Additionally the host's
2155 certificate must be specified with the <code>certificate</code>
2159 <column name="options" key="certificate">
2160 Required for certificate authentication. The name of a PEM file
2161 containing a certificate that will be presented to the peer during
2165 <column name="options" key="private_key">
2166 Optional for certificate authentication. The name of a PEM file
2167 containing the private key associated with <code>certificate</code>.
2168 If <code>certificate</code> contains the private key, this option may
2172 <column name="options" key="psk">
2173 Required for pre-shared key authentication. Specifies a pre-shared
2174 key for authentication that must be identical on both sides of the
2180 <group title="Patch Options">
2182 Only <code>patch</code> interfaces support these options.
2185 <column name="options" key="peer">
2186 The <ref column="name"/> of the <ref table="Interface"/> for the other
2187 side of the patch. The named <ref table="Interface"/>'s own
2188 <code>peer</code> option must specify this <ref table="Interface"/>'s
2189 name. That is, the two patch interfaces must have reversed <ref
2190 column="name"/> and <code>peer</code> values.
2194 <group title="Interface Status">
2196 Status information about interfaces attached to bridges, updated every
2197 5 seconds. Not all interfaces have all of these properties; virtual
2198 interfaces don't have a link speed, for example. Non-applicable
2199 columns will have empty values.
2201 <column name="admin_state">
2203 The administrative state of the physical network link.
2207 <column name="link_state">
2209 The observed state of the physical network link. This is ordinarily
2210 the link's carrier status. If the interface's <ref table="Port"/> is
2211 a bond configured for miimon monitoring, it is instead the network
2212 link's miimon status.
2216 <column name="link_resets">
2218 The number of times Open vSwitch has observed the
2219 <ref column="link_state"/> of this <ref table="Interface"/> change.
2223 <column name="link_speed">
2225 The negotiated speed of the physical network link.
2226 Valid values are positive integers greater than 0.
2230 <column name="duplex">
2232 The duplex mode of the physical network link.
2238 The MTU (maximum transmission unit); i.e. the largest
2239 amount of data that can fit into a single Ethernet frame.
2240 The standard Ethernet MTU is 1500 bytes. Some physical media
2241 and many kinds of virtual interfaces can be configured with
2245 This column will be empty for an interface that does not
2246 have an MTU as, for example, some kinds of tunnels do not.
2250 <column name="lacp_current">
2251 Boolean value indicating LACP status for this interface. If true, this
2252 interface has current LACP information about its LACP partner. This
2253 information may be used to monitor the health of interfaces in a LACP
2254 enabled port. This column will be empty if LACP is not enabled.
2257 <column name="status">
2258 Key-value pairs that report port status. Supported status values are
2259 <ref column="type"/>-dependent; some interfaces may not have a valid
2260 <ref column="status" key="driver_name"/>, for example.
2263 <column name="status" key="driver_name">
2264 The name of the device driver controlling the network adapter.
2267 <column name="status" key="driver_version">
2268 The version string of the device driver controlling the network
2272 <column name="status" key="firmware_version">
2273 The version string of the network adapter's firmware, if available.
2276 <column name="status" key="source_ip">
2277 The source IP address used for an IPv4 tunnel end-point, such as
2281 <column name="status" key="tunnel_egress_iface">
2282 Egress interface for tunnels. Currently only relevant for tunnels
2283 on Linux systems, this column will show the name of the interface
2284 which is responsible for routing traffic destined for the configured
2285 <ref column="options" key="remote_ip"/>. This could be an internal
2286 interface such as a bridge port.
2289 <column name="status" key="tunnel_egress_iface_carrier"
2290 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2291 Whether carrier is detected on <ref column="status"
2292 key="tunnel_egress_iface"/>.
2296 <group title="Statistics">
2298 Key-value pairs that report interface statistics. The current
2299 implementation updates these counters periodically. The update period
2300 is controlled by <ref column="other_config"
2301 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2302 Future implementations may update them when an interface is created,
2303 when they are queried (e.g. using an OVSDB <code>select</code>
2304 operation), and just before an interface is deleted due to virtual
2305 interface hot-unplug or VM shutdown, and perhaps at other times, but
2306 not on any regular periodic basis.
2309 These are the same statistics reported by OpenFlow in its <code>struct
2310 ofp_port_stats</code> structure. If an interface does not support a
2311 given statistic, then that pair is omitted.
2313 <group title="Statistics: Successful transmit and receive counters">
2314 <column name="statistics" key="rx_packets">
2315 Number of received packets.
2317 <column name="statistics" key="rx_bytes">
2318 Number of received bytes.
2320 <column name="statistics" key="tx_packets">
2321 Number of transmitted packets.
2323 <column name="statistics" key="tx_bytes">
2324 Number of transmitted bytes.
2327 <group title="Statistics: Receive errors">
2328 <column name="statistics" key="rx_dropped">
2329 Number of packets dropped by RX.
2331 <column name="statistics" key="rx_frame_err">
2332 Number of frame alignment errors.
2334 <column name="statistics" key="rx_over_err">
2335 Number of packets with RX overrun.
2337 <column name="statistics" key="rx_crc_err">
2338 Number of CRC errors.
2340 <column name="statistics" key="rx_errors">
2341 Total number of receive errors, greater than or equal to the sum of
2345 <group title="Statistics: Transmit errors">
2346 <column name="statistics" key="tx_dropped">
2347 Number of packets dropped by TX.
2349 <column name="statistics" key="collisions">
2350 Number of collisions.
2352 <column name="statistics" key="tx_errors">
2353 Total number of transmit errors, greater than or equal to the sum of
2359 <group title="Ingress Policing">
2361 These settings control ingress policing for packets received on this
2362 interface. On a physical interface, this limits the rate at which
2363 traffic is allowed into the system from the outside; on a virtual
2364 interface (one connected to a virtual machine), this limits the rate at
2365 which the VM is able to transmit.
2368 Policing is a simple form of quality-of-service that simply drops
2369 packets received in excess of the configured rate. Due to its
2370 simplicity, policing is usually less accurate and less effective than
2371 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2372 table="Queue"/> tables).
2375 Policing is currently implemented only on Linux. The Linux
2376 implementation uses a simple ``token bucket'' approach:
2380 The size of the bucket corresponds to <ref
2381 column="ingress_policing_burst"/>. Initially the bucket is full.
2384 Whenever a packet is received, its size (converted to tokens) is
2385 compared to the number of tokens currently in the bucket. If the
2386 required number of tokens are available, they are removed and the
2387 packet is forwarded. Otherwise, the packet is dropped.
2390 Whenever it is not full, the bucket is refilled with tokens at the
2391 rate specified by <ref column="ingress_policing_rate"/>.
2395 Policing interacts badly with some network protocols, and especially
2396 with fragmented IP packets. Suppose that there is enough network
2397 activity to keep the bucket nearly empty all the time. Then this token
2398 bucket algorithm will forward a single packet every so often, with the
2399 period depending on packet size and on the configured rate. All of the
2400 fragments of an IP packets are normally transmitted back-to-back, as a
2401 group. In such a situation, therefore, only one of these fragments
2402 will be forwarded and the rest will be dropped. IP does not provide
2403 any way for the intended recipient to ask for only the remaining
2404 fragments. In such a case there are two likely possibilities for what
2405 will happen next: either all of the fragments will eventually be
2406 retransmitted (as TCP will do), in which case the same problem will
2407 recur, or the sender will not realize that its packet has been dropped
2408 and data will simply be lost (as some UDP-based protocols will do).
2409 Either way, it is possible that no forward progress will ever occur.
2411 <column name="ingress_policing_rate">
2413 Maximum rate for data received on this interface, in kbps. Data
2414 received faster than this rate is dropped. Set to <code>0</code>
2415 (the default) to disable policing.
2419 <column name="ingress_policing_burst">
2420 <p>Maximum burst size for data received on this interface, in kb. The
2421 default burst size if set to <code>0</code> is 1000 kb. This value
2422 has no effect if <ref column="ingress_policing_rate"/>
2423 is <code>0</code>.</p>
2425 Specifying a larger burst size lets the algorithm be more forgiving,
2426 which is important for protocols like TCP that react severely to
2427 dropped packets. The burst size should be at least the size of the
2428 interface's MTU. Specifying a value that is numerically at least as
2429 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2430 closer to achieving the full rate.
2435 <group title="Bidirectional Forwarding Detection (BFD)">
2437 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2438 detection of connectivity failures by occasional transmission of
2439 BFD control messages. Open vSwitch implements BFD to serve
2440 as a more popular and standards compliant alternative to CFM.
2444 BFD operates by regularly transmitting BFD control messages at a rate
2445 negotiated independently in each direction. Each endpoint specifies
2446 the rate at which it expects to receive control messages, and the rate
2447 at which it is willing to transmit them. Open vSwitch uses a detection
2448 multiplier of three, meaning that an endpoint signals a connectivity
2449 fault if three consecutive BFD control messages fail to arrive. In the
2450 case of a unidirectional connectivity issue, the system not receiving
2451 BFD control messages signals the problem to its peer in the messages it
2456 The Open vSwitch implementation of BFD aims to comply faithfully
2457 with RFC 5880 requirements. Open vSwitch does not implement the
2458 optional Authentication or ``Echo Mode'' features.
2461 <group title="BFD Configuration">
2463 A controller sets up key-value pairs in the <ref column="bfd"/>
2464 column to enable and configure BFD.
2467 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2468 True to enable BFD on this <ref table="Interface"/>. If not
2469 specified, BFD will not be enabled by default.
2472 <column name="bfd" key="min_rx"
2473 type='{"type": "integer", "minInteger": 1}'>
2474 The shortest interval, in milliseconds, at which this BFD session
2475 offers to receive BFD control messages. The remote endpoint may
2476 choose to send messages at a slower rate. Defaults to
2480 <column name="bfd" key="min_tx"
2481 type='{"type": "integer", "minInteger": 1}'>
2482 The shortest interval, in milliseconds, at which this BFD session is
2483 willing to transmit BFD control messages. Messages will actually be
2484 transmitted at a slower rate if the remote endpoint is not willing to
2485 receive as quickly as specified. Defaults to <code>100</code>.
2488 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2489 An alternate receive interval, in milliseconds, that must be greater
2490 than or equal to <ref column="bfd" key="min_rx"/>. The
2491 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2492 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2493 data traffic at the interface, to reduce the CPU and bandwidth cost
2494 of monitoring an idle interface. This feature may be disabled by
2495 setting a value of 0. This feature is reset whenever <ref
2496 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2500 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2501 When <code>true</code>, traffic received on the
2502 <ref table="Interface"/> is used to indicate the capability of packet
2503 I/O. BFD control packets are still transmitted and received. At
2504 least one BFD control packet must be received every 100 * <ref
2505 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2506 traffic are received, the <ref column="bfd" key="forwarding"/>
2507 will be <code>false</code>.
2510 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2511 Set to true to notify the remote endpoint that traffic should not be
2512 forwarded to this system for some reason other than a connectivty
2513 failure on the interface being monitored. The typical underlying
2514 reason is ``concatenated path down,'' that is, that connectivity
2515 beyond the local system is down. Defaults to false.
2518 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2519 Set to true to make BFD accept only control messages with a tunnel
2520 key of zero. By default, BFD accepts control messages with any
2524 <column name="bfd" key="bfd_local_src_mac">
2525 Set to an Ethernet address in the form
2526 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2527 to set the MAC used as source for transmitted BFD packets. The
2528 default is the mac address of the BFD enabled interface.
2531 <column name="bfd" key="bfd_local_dst_mac">
2532 Set to an Ethernet address in the form
2533 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2534 to set the MAC used as destination for transmitted BFD packets. The
2535 default is <code>00:23:20:00:00:01</code>.
2538 <column name="bfd" key="bfd_remote_dst_mac">
2539 Set to an Ethernet address in the form
2540 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2541 to set the MAC used for checking the destination of received BFD packets.
2542 Packets with different destination MAC will not be considered as BFD packets.
2543 If not specified the destination MAC address of received BFD packets
2547 <column name="bfd" key="bfd_src_ip">
2548 Set to an IPv4 address to set the IP address used as source for
2549 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2552 <column name="bfd" key="bfd_dst_ip">
2553 Set to an IPv4 address to set the IP address used as destination
2554 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2558 <group title="BFD Status">
2560 The switch sets key-value pairs in the <ref column="bfd_status"/>
2561 column to report the status of BFD on this interface. When BFD is
2562 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2563 all key-value pairs from <ref column="bfd_status"/>.
2566 <column name="bfd_status" key="state"
2567 type='{"type": "string",
2568 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2569 Reports the state of the BFD session. The BFD session is fully
2570 healthy and negotiated if <code>UP</code>.
2573 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2574 Reports whether the BFD session believes this <ref
2575 table="Interface"/> may be used to forward traffic. Typically this
2576 means the local session is signaling <code>UP</code>, and the remote
2577 system isn't signaling a problem such as concatenated path down.
2580 <column name="bfd_status" key="diagnostic">
2581 A diagnostic code specifying the local system's reason for the
2582 last change in session state. The error messages are defined in
2583 section 4.1 of [RFC 5880].
2586 <column name="bfd_status" key="remote_state"
2587 type='{"type": "string",
2588 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2589 Reports the state of the remote endpoint's BFD session.
2592 <column name="bfd_status" key="remote_diagnostic">
2593 A diagnostic code specifying the remote system's reason for the
2594 last change in session state. The error messages are defined in
2595 section 4.1 of [RFC 5880].
2598 <column name="bfd_status" key="flap_count"
2599 type='{"type": "integer", "minInteger": 0}'>
2600 Counts the number of <ref column="bfd_status" key="forwarding" />
2601 flaps since start. A flap is considered as a change of the
2602 <ref column="bfd_status" key="forwarding" /> value.
2607 <group title="Connectivity Fault Management">
2609 802.1ag Connectivity Fault Management (CFM) allows a group of
2610 Maintenance Points (MPs) called a Maintenance Association (MA) to
2611 detect connectivity problems with each other. MPs within a MA should
2612 have complete and exclusive interconnectivity. This is verified by
2613 occasionally broadcasting Continuity Check Messages (CCMs) at a
2614 configurable transmission interval.
2618 According to the 802.1ag specification, each Maintenance Point should
2619 be configured out-of-band with a list of Remote Maintenance Points it
2620 should have connectivity to. Open vSwitch differs from the
2621 specification in this area. It simply assumes the link is faulted if
2622 no Remote Maintenance Points are reachable, and considers it not
2627 When operating over tunnels which have no <code>in_key</code>, or an
2628 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2629 with a tunnel key of zero.
2632 <column name="cfm_mpid">
2634 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2635 within a Maintenance Association. The MPID is used to identify this
2636 endpoint to other Maintenance Points in the MA. Each end of a link
2637 being monitored should have a different MPID. Must be configured to
2638 enable CFM on this <ref table="Interface"/>.
2641 According to the 802.1ag specification, MPIDs can only range between
2642 [1, 8191]. However, extended mode (see <ref column="other_config"
2643 key="cfm_extended"/>) supports eight byte MPIDs.
2647 <column name="cfm_flap_count">
2648 Counts the number of cfm fault flapps since boot. A flap is
2649 considered to be a change of the <ref column="cfm_fault"/> value.
2652 <column name="cfm_fault">
2654 Indicates a connectivity fault triggered by an inability to receive
2655 heartbeats from any remote endpoint. When a fault is triggered on
2656 <ref table="Interface"/>s participating in bonds, they will be
2660 Faults can be triggered for several reasons. Most importantly they
2661 are triggered when no CCMs are received for a period of 3.5 times the
2662 transmission interval. Faults are also triggered when any CCMs
2663 indicate that a Remote Maintenance Point is not receiving CCMs but
2664 able to send them. Finally, a fault is triggered if a CCM is
2665 received which indicates unexpected configuration. Notably, this
2666 case arises when a CCM is received which advertises the local MPID.
2670 <column name="cfm_fault_status" key="recv">
2671 Indicates a CFM fault was triggered due to a lack of CCMs received on
2672 the <ref table="Interface"/>.
2675 <column name="cfm_fault_status" key="rdi">
2676 Indicates a CFM fault was triggered due to the reception of a CCM with
2677 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2678 are not receiving CCMs themselves. This typically indicates a
2679 unidirectional connectivity failure.
2682 <column name="cfm_fault_status" key="maid">
2683 Indicates a CFM fault was triggered due to the reception of a CCM with
2684 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2685 with an identification number in addition to the MPID called the MAID.
2686 Open vSwitch only supports receiving CCM broadcasts tagged with the
2687 MAID it uses internally.
2690 <column name="cfm_fault_status" key="loopback">
2691 Indicates a CFM fault was triggered due to the reception of a CCM
2692 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2693 column of this <ref table="Interface"/>. This may indicate a loop in
2697 <column name="cfm_fault_status" key="overflow">
2698 Indicates a CFM fault was triggered because the CFM module received
2699 CCMs from more remote endpoints than it can keep track of.
2702 <column name="cfm_fault_status" key="override">
2703 Indicates a CFM fault was manually triggered by an administrator using
2704 an <code>ovs-appctl</code> command.
2707 <column name="cfm_fault_status" key="interval">
2708 Indicates a CFM fault was triggered due to the reception of a CCM
2709 frame having an invalid interval.
2712 <column name="cfm_remote_opstate">
2713 <p>When in extended mode, indicates the operational state of the
2714 remote endpoint as either <code>up</code> or <code>down</code>. See
2715 <ref column="other_config" key="cfm_opstate"/>.
2719 <column name="cfm_health">
2721 Indicates the health of the interface as a percentage of CCM frames
2722 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2723 The health of an interface is undefined if it is communicating with
2724 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2725 healthy heartbeats are not received at the expected rate, and
2726 gradually improves as healthy heartbeats are received at the desired
2727 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2728 health of the interface is refreshed.
2731 As mentioned above, the faults can be triggered for several reasons.
2732 The link health will deteriorate even if heartbeats are received but
2733 they are reported to be unhealthy. An unhealthy heartbeat in this
2734 context is a heartbeat for which either some fault is set or is out
2735 of sequence. The interface health can be 100 only on receiving
2736 healthy heartbeats at the desired rate.
2740 <column name="cfm_remote_mpids">
2741 When CFM is properly configured, Open vSwitch will occasionally
2742 receive CCM broadcasts. These broadcasts contain the MPID of the
2743 sending Maintenance Point. The list of MPIDs from which this
2744 <ref table="Interface"/> is receiving broadcasts from is regularly
2745 collected and written to this column.
2748 <column name="other_config" key="cfm_interval"
2749 type='{"type": "integer"}'>
2751 The interval, in milliseconds, between transmissions of CFM
2752 heartbeats. Three missed heartbeat receptions indicate a
2757 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2758 60,000, or 600,000 ms are supported. Other values will be rounded
2759 down to the nearest value on the list. Extended mode (see <ref
2760 column="other_config" key="cfm_extended"/>) supports any interval up
2761 to 65,535 ms. In either mode, the default is 1000 ms.
2764 <p>We do not recommend using intervals less than 100 ms.</p>
2767 <column name="other_config" key="cfm_extended"
2768 type='{"type": "boolean"}'>
2769 When <code>true</code>, the CFM module operates in extended mode. This
2770 causes it to use a nonstandard destination address to avoid conflicting
2771 with compliant implementations which may be running concurrently on the
2772 network. Furthermore, extended mode increases the accuracy of the
2773 <code>cfm_interval</code> configuration parameter by breaking wire
2774 compatibility with 802.1ag compliant implementations. And extended
2775 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2778 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2780 When <code>true</code>, and
2781 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2782 module operates in demand mode. When in demand mode, traffic
2783 received on the <ref table="Interface"/> is used to indicate
2784 liveness. CCMs are still transmitted and received. At least one
2785 CCM must be received every 100 * <ref column="other_config"
2786 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2787 are received, the CFM module will raise the connectivity fault.
2791 Demand mode has a couple of caveats:
2794 To ensure that ovs-vswitchd has enough time to pull statistics
2795 from the datapath, the fault detection interval is set to
2796 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2801 To avoid ambiguity, demand mode disables itself when there are
2802 multiple remote maintenance points.
2806 If the <ref table="Interface"/> is heavily congested, CCMs
2807 containing the <ref column="other_config" key="cfm_opstate"/>
2808 status may be dropped causing changes in the operational state to
2809 be delayed. Similarly, if CCMs containing the RDI bit are not
2810 received, unidirectional link failures may not be detected.
2816 <column name="other_config" key="cfm_opstate"
2817 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2818 When <code>down</code>, the CFM module marks all CCMs it generates as
2819 operationally down without triggering a fault. This allows remote
2820 maintenance points to choose not to forward traffic to the
2821 <ref table="Interface"/> on which this CFM module is running.
2822 Currently, in Open vSwitch, the opdown bit of CCMs affects
2823 <ref table="Interface"/>s participating in bonds, and the bundle
2824 OpenFlow action. This setting is ignored when CFM is not in extended
2825 mode. Defaults to <code>up</code>.
2828 <column name="other_config" key="cfm_ccm_vlan"
2829 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2830 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2831 with the given value. May be the string <code>random</code> in which
2832 case each CCM will be tagged with a different randomly generated VLAN.
2835 <column name="other_config" key="cfm_ccm_pcp"
2836 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2837 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2838 with the given PCP value, the VLAN ID of the tag is governed by the
2839 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2840 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2846 <group title="Bonding Configuration">
2847 <column name="other_config" key="lacp-port-id"
2848 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2849 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2850 used in LACP negotiations to identify individual ports
2851 participating in a bond.
2854 <column name="other_config" key="lacp-port-priority"
2855 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2856 The LACP port priority of this <ref table="Interface"/>. In LACP
2857 negotiations <ref table="Interface"/>s with numerically lower
2858 priorities are preferred for aggregation.
2861 <column name="other_config" key="lacp-aggregation-key"
2862 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2863 The LACP aggregation key of this <ref table="Interface"/>. <ref
2864 table="Interface"/>s with different aggregation keys may not be active
2865 within a given <ref table="Port"/> at the same time.
2869 <group title="Virtual Machine Identifiers">
2871 These key-value pairs specifically apply to an interface that
2872 represents a virtual Ethernet interface connected to a virtual
2873 machine. These key-value pairs should not be present for other types
2874 of interfaces. Keys whose names end in <code>-uuid</code> have
2875 values that uniquely identify the entity in question. For a Citrix
2876 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2877 Other hypervisors may use other formats.
2880 <column name="external_ids" key="attached-mac">
2881 The MAC address programmed into the ``virtual hardware'' for this
2882 interface, in the form
2883 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2884 For Citrix XenServer, this is the value of the <code>MAC</code> field
2885 in the VIF record for this interface.
2888 <column name="external_ids" key="iface-id">
2889 A system-unique identifier for the interface. On XenServer, this will
2890 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2893 <column name="external_ids" key="iface-status"
2894 type='{"type": "string",
2895 "enum": ["set", ["active", "inactive"]]}'>
2897 Hypervisors may sometimes have more than one interface associated
2898 with a given <ref column="external_ids" key="iface-id"/>, only one of
2899 which is actually in use at a given time. For example, in some
2900 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2901 for a single <ref column="external_ids" key="iface-id"/>, but only
2902 uses one of them at a time. A hypervisor that behaves this way must
2903 mark the currently in use interface <code>active</code> and the
2904 others <code>inactive</code>. A hypervisor that never has more than
2905 one interface for a given <ref column="external_ids" key="iface-id"/>
2906 may mark that interface <code>active</code> or omit <ref
2907 column="external_ids" key="iface-status"/> entirely.
2911 During VM migration, a given <ref column="external_ids"
2912 key="iface-id"/> might transiently be marked <code>active</code> on
2913 two different hypervisors. That is, <code>active</code> means that
2914 this <ref column="external_ids" key="iface-id"/> is the active
2915 instance within a single hypervisor, not in a broader scope.
2916 There is one exception: some hypervisors support ``migration'' from a
2917 given hypervisor to itself (most often for test purposes). During
2918 such a ``migration,'' two instances of a single <ref
2919 column="external_ids" key="iface-id"/> might both be briefly marked
2920 <code>active</code> on a single hypervisor.
2924 <column name="external_ids" key="xs-vif-uuid">
2925 The virtual interface associated with this interface.
2928 <column name="external_ids" key="xs-network-uuid">
2929 The virtual network to which this interface is attached.
2932 <column name="external_ids" key="vm-id">
2933 The VM to which this interface belongs. On XenServer, this will be the
2934 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2937 <column name="external_ids" key="xs-vm-uuid">
2938 The VM to which this interface belongs.
2942 <group title="VLAN Splinters">
2944 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2945 with buggy network drivers in old versions of Linux that do not
2946 properly support VLANs when VLAN devices are not used, at some cost
2947 in memory and performance.
2951 When VLAN splinters are enabled on a particular interface, Open vSwitch
2952 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2953 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2954 received on the VLAN device is treated as if it had been received on
2955 the interface on the particular VLAN.
2959 VLAN splinters consider a VLAN to be in use if:
2964 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2965 table="Port"/> record.
2969 The VLAN is listed within the <ref table="Port" column="trunks"/>
2970 column of the <ref table="Port"/> record of an interface on which
2971 VLAN splinters are enabled.
2973 An empty <ref table="Port" column="trunks"/> does not influence the
2974 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2975 will exceed the current 1,024 port per datapath limit.
2979 An OpenFlow flow within any bridge matches the VLAN.
2984 The same set of in-use VLANs applies to every interface on which VLAN
2985 splinters are enabled. That is, the set is not chosen separately for
2986 each interface but selected once as the union of all in-use VLANs based
2991 It does not make sense to enable VLAN splinters on an interface for an
2992 access port, or on an interface that is not a physical port.
2996 VLAN splinters are deprecated. When broken device drivers are no
2997 longer in widespread use, we will delete this feature.
3000 <column name="other_config" key="enable-vlan-splinters"
3001 type='{"type": "boolean"}'>
3003 Set to <code>true</code> to enable VLAN splinters on this interface.
3004 Defaults to <code>false</code>.
3008 VLAN splinters increase kernel and userspace memory overhead, so do
3009 not use them unless they are needed.
3013 VLAN splinters do not support 802.1p priority tags. Received
3014 priorities will appear to be 0, regardless of their actual values,
3015 and priorities on transmitted packets will also be cleared to 0.
3020 <group title="Auto Attach Configuration">
3022 Auto Attach configuration for a particular interface.
3025 <column name="lldp" key="enable" type='{"type": "boolean"}'>
3026 True to enable LLDP on this <ref table="Interface"/>. If not
3027 specified, LLDP will be disabled by default.
3031 <group title="Common Columns">
3032 The overall purpose of these columns is described under <code>Common
3033 Columns</code> at the beginning of this document.
3035 <column name="other_config"/>
3036 <column name="external_ids"/>
3040 <table name="Flow_Table" title="OpenFlow table configuration">
3041 <p>Configuration for a particular OpenFlow table.</p>
3043 <column name="name">
3044 The table's name. Set this column to change the name that controllers
3045 will receive when they request table statistics, e.g. <code>ovs-ofctl
3046 dump-tables</code>. The name does not affect switch behavior.
3049 <group title="Eviction Policy">
3051 Open vSwitch supports limiting the number of flows that may be
3052 installed in a flow table, via the <ref column="flow_limit"/> column.
3053 When adding a flow would exceed this limit, by default Open vSwitch
3054 reports an error, but there are two ways to configure Open vSwitch to
3055 instead delete (``evict'') a flow to make room for the new one:
3060 Set the <ref column="overflow_policy"/> column to <code>evict</code>.
3064 Send an OpenFlow 1.4+ ``table mod request'' to enable eviction for
3065 the flow table (e.g. <code>ovs-ofctl -O OpenFlow14 mod-table br0 0
3066 evict</code> to enable eviction on flow table 0 of bridge
3072 When a flow must be evicted due to overflow, the flow to evict is
3073 chosen through an approximation of the following algorithm. This
3074 algorithm is used regardless of how eviction was enabled:
3079 Divide the flows in the table into groups based on the values of the
3080 fields or subfields specified in the <ref column="groups"/> column,
3081 so that all of the flows in a given group have the same values for
3082 those fields. If a flow does not specify a given field, that field's
3083 value is treated as 0. If <ref column="groups"/> is empty, then all
3084 of the flows in the flow table are treated as a single group.
3088 Consider the flows in the largest group, that is, the group that
3089 contains the greatest number of flows. If two or more groups all
3090 have the same largest number of flows, consider the flows in all of
3095 If the flows under consideration have different importance values,
3096 eliminate from consideration any flows except those with the lowest
3097 importance. (``Importance,'' a 16-bit integer value attached to each
3098 flow, was introduced in OpenFlow 1.4. Flows inserted with older
3099 versions of OpenFlow always have an importance of 0.)
3103 Among the flows under consideration, choose the flow that expires
3104 soonest for eviction.
3109 The eviction process only considers flows that have an idle timeout
3110 or a hard timeout. That is, eviction never deletes permanent flows.
3111 (Permanent flows do count against <ref column="flow_limit"/>.)
3114 <column name="flow_limit">
3115 If set, limits the number of flows that may be added to the table.
3116 Open vSwitch may limit the number of flows in a table for other
3117 reasons, e.g. due to hardware limitations or for resource availability
3118 or performance reasons.
3121 <column name="overflow_policy">
3123 Controls the switch's behavior when an OpenFlow flow table
3124 modification request would add flows in excess of <ref
3125 column="flow_limit"/>. The supported values are:
3129 <dt><code>refuse</code></dt>
3131 Refuse to add the flow or flows. This is also the default policy
3132 when <ref column="overflow_policy"/> is unset.
3135 <dt><code>evict</code></dt>
3137 Delete a flow chosen according to the algorithm described above.
3142 <column name="groups">
3144 When <ref column="overflow_policy"/> is <code>evict</code>, this
3145 controls how flows are chosen for eviction when the flow table would
3146 otherwise exceed <ref column="flow_limit"/> flows. Its value is a
3147 set of NXM fields or sub-fields, each of which takes one of the forms
3148 <code><var>field</var>[]</code> or
3149 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
3150 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
3151 <code>nicira-ext.h</code> for a complete list of NXM field names.
3155 Open vSwitch ignores any invalid or unknown field specifications.
3159 When eviction is not enabled, via <ref column="overflow_policy"/> or
3160 an OpenFlow 1.4+ ``table mod,'' this column has no effect.
3165 <group title="Classifier Optimization">
3166 <column name="prefixes">
3168 This string set specifies which fields should be used for
3169 address prefix tracking. Prefix tracking allows the
3170 classifier to skip rules with longer than necessary prefixes,
3171 resulting in better wildcarding for datapath flows.
3174 Prefix tracking may be beneficial when a flow table contains
3175 matches on IP address fields with different prefix lengths.
3176 For example, when a flow table contains IP address matches on
3177 both full addresses and proper prefixes, the full address
3178 matches will typically cause the datapath flow to un-wildcard
3179 the whole address field (depending on flow entry priorities).
3180 In this case each packet with a different address gets handed
3181 to the userspace for flow processing and generates its own
3182 datapath flow. With prefix tracking enabled for the address
3183 field in question packets with addresses matching shorter
3184 prefixes would generate datapath flows where the irrelevant
3185 address bits are wildcarded, allowing the same datapath flow
3186 to handle all the packets within the prefix in question. In
3187 this case many userspace upcalls can be avoided and the
3188 overall performance can be better.
3191 This is a performance optimization only, so packets will
3192 receive the same treatment with or without prefix tracking.
3195 The supported fields are: <code>tun_id</code>,
3196 <code>tun_src</code>, <code>tun_dst</code>,
3197 <code>nw_src</code>, <code>nw_dst</code> (or aliases
3198 <code>ip_src</code> and <code>ip_dst</code>),
3199 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
3200 feature for <code>tun_id</code> would only make sense if the
3201 tunnel IDs have prefix structure similar to IP addresses.)
3205 By default, the <code>prefixes=ip_dst,ip_src</code> are used
3206 on each flow table. This instructs the flow classifier to
3207 track the IP destination and source addresses used by the
3208 rules in this specific flow table.
3212 The keyword <code>none</code> is recognized as an explicit
3213 override of the default values, causing no prefix fields to be
3218 To set the prefix fields, the flow table record needs to
3223 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
3225 Creates a flow table record for the OpenFlow table number 0.
3228 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
3230 Enables prefix tracking for IP source and destination
3236 There is a maximum number of fields that can be enabled for any
3237 one flow table. Currently this limit is 3.
3242 <group title="Common Columns">
3243 The overall purpose of these columns is described under <code>Common
3244 Columns</code> at the beginning of this document.
3246 <column name="external_ids"/>
3250 <table name="QoS" title="Quality of Service configuration">
3251 <p>Quality of Service (QoS) configuration for each Port that
3254 <column name="type">
3255 <p>The type of QoS to implement. The currently defined types are
3258 <dt><code>linux-htb</code></dt>
3260 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
3261 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
3262 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
3263 for information on how this classifier works and how to configure it.
3267 <dt><code>linux-hfsc</code></dt>
3269 Linux "Hierarchical Fair Service Curve" classifier.
3270 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
3271 information on how this classifier works.
3275 <dt><code>linux-sfq</code></dt>
3277 Linux ``Stochastic Fairness Queueing'' classifier. See
3278 <code>tc-sfq</code>(8) (also at
3279 <code>http://linux.die.net/man/8/tc-sfq</code>) for information on
3280 how this classifier works.
3284 <dt><code>linux-codel</code></dt>
3286 Linux ``Controlled Delay'' classifier. See <code>tc-codel</code>(8)
3288 <code>http://man7.org/linux/man-pages/man8/tc-codel.8.html</code>)
3289 for information on how this classifier works.
3293 <dt><code>linux-fq_codel</code></dt>
3295 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3296 <code>tc-fq_codel</code>(8) (also at
3297 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel.8.html</code>)
3298 for information on how this classifier works.
3303 <column name="queues">
3304 <p>A map from queue numbers to <ref table="Queue"/> records. The
3305 supported range of queue numbers depend on <ref column="type"/>. The
3306 queue numbers are the same as the <code>queue_id</code> used in
3307 OpenFlow in <code>struct ofp_action_enqueue</code> and other
3311 Queue 0 is the ``default queue.'' It is used by OpenFlow output
3312 actions when no specific queue has been set. When no configuration for
3313 queue 0 is present, it is automatically configured as if a <ref
3314 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
3315 and <ref table="Queue" column="other_config"/> columns had been
3317 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
3318 this case. With some queuing disciplines, this dropped all packets
3319 destined for the default queue.)
3323 <group title="Configuration for linux-htb and linux-hfsc">
3325 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
3326 the following key-value pair:
3329 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
3330 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3331 specified, for physical interfaces, the default is the link rate. For
3332 other interfaces or if the link rate cannot be determined, the default
3333 is currently 100 Mbps.
3337 <group title="Common Columns">
3338 The overall purpose of these columns is described under <code>Common
3339 Columns</code> at the beginning of this document.
3341 <column name="other_config"/>
3342 <column name="external_ids"/>
3346 <table name="Queue" title="QoS output queue.">
3347 <p>A configuration for a port output queue, used in configuring Quality of
3348 Service (QoS) features. May be referenced by <ref column="queues"
3349 table="QoS"/> column in <ref table="QoS"/> table.</p>
3351 <column name="dscp">
3352 If set, Open vSwitch will mark all traffic egressing this
3353 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3354 default <ref table="Queue"/> is only marked if it was explicitly selected
3355 as the <ref table="Queue"/> at the time the packet was output. If unset,
3356 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3360 <group title="Configuration for linux-htb QoS">
3362 <ref table="QoS"/> <ref table="QoS" column="type"/>
3363 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3364 It has the following key-value pairs defined.
3367 <column name="other_config" key="min-rate"
3368 type='{"type": "integer", "minInteger": 1}'>
3369 Minimum guaranteed bandwidth, in bit/s.
3372 <column name="other_config" key="max-rate"
3373 type='{"type": "integer", "minInteger": 1}'>
3374 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3375 queue's rate will not be allowed to exceed the specified value, even
3376 if excess bandwidth is available. If unspecified, defaults to no
3380 <column name="other_config" key="burst"
3381 type='{"type": "integer", "minInteger": 1}'>
3382 Burst size, in bits. This is the maximum amount of ``credits'' that a
3383 queue can accumulate while it is idle. Optional. Details of the
3384 <code>linux-htb</code> implementation require a minimum burst size, so
3385 a too-small <code>burst</code> will be silently ignored.
3388 <column name="other_config" key="priority"
3389 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3390 A queue with a smaller <code>priority</code> will receive all the
3391 excess bandwidth that it can use before a queue with a larger value
3392 receives any. Specific priority values are unimportant; only relative
3393 ordering matters. Defaults to 0 if unspecified.
3397 <group title="Configuration for linux-hfsc QoS">
3399 <ref table="QoS"/> <ref table="QoS" column="type"/>
3400 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3401 It has the following key-value pairs defined.
3404 <column name="other_config" key="min-rate"
3405 type='{"type": "integer", "minInteger": 1}'>
3406 Minimum guaranteed bandwidth, in bit/s.
3409 <column name="other_config" key="max-rate"
3410 type='{"type": "integer", "minInteger": 1}'>
3411 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3412 queue's rate will not be allowed to exceed the specified value, even if
3413 excess bandwidth is available. If unspecified, defaults to no
3418 <group title="Common Columns">
3419 The overall purpose of these columns is described under <code>Common
3420 Columns</code> at the beginning of this document.
3422 <column name="other_config"/>
3423 <column name="external_ids"/>
3427 <table name="Mirror" title="Port mirroring.">
3428 <p>A port mirror within a <ref table="Bridge"/>.</p>
3429 <p>A port mirror configures a bridge to send selected frames to special
3430 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3431 traffic may also be referred to as SPAN or RSPAN, depending on how
3432 the mirrored traffic is sent.</p>
3435 When a packet enters an Open vSwitch bridge, it becomes eligible for
3436 mirroring based on its ingress port and VLAN. As the packet travels
3437 through the flow tables, each time it is output to a port, it becomes
3438 eligible for mirroring based on the egress port and VLAN. In Open
3439 vSwitch 2.5 and later, mirroring occurs just after a packet first becomes
3440 eligible, using the packet as it exists at that point; in Open vSwitch
3441 2.4 and earlier, mirroring occurs only after a packet has traversed all
3442 the flow tables, using the original packet as it entered the bridge.
3443 This makes a difference only when the flow table modifies the packet: in
3444 Open vSwitch 2.4, the modifications are never visible to mirrors, whereas
3445 in Open vSwitch 2.5 and later modifications made before the first output
3446 that makes it eligible for mirroring to a particular destination are
3451 A packet that enters an Open vSwitch bridge is mirrored to a particular
3452 destination only once, even if it is eligible for multiple reasons. For
3453 example, a packet would be mirrored to a particular <ref
3454 column="output_port"/> only once, even if it is selected for mirroring to
3455 that port by <ref column="select_dst_port"/> and <ref
3456 column="select_src_port"/> in the same or different <ref table="Mirror"/>
3460 <column name="name">
3461 Arbitrary identifier for the <ref table="Mirror"/>.
3464 <group title="Selecting Packets for Mirroring">
3466 To be selected for mirroring, a given packet must enter or leave the
3467 bridge through a selected port and it must also be in one of the
3471 <column name="select_all">
3472 If true, every packet arriving or departing on any port is
3473 selected for mirroring.
3476 <column name="select_dst_port">
3477 Ports on which departing packets are selected for mirroring.
3480 <column name="select_src_port">
3481 Ports on which arriving packets are selected for mirroring.
3484 <column name="select_vlan">
3485 VLANs on which packets are selected for mirroring. An empty set
3486 selects packets on all VLANs.
3490 <group title="Mirroring Destination Configuration">
3492 These columns are mutually exclusive. Exactly one of them must be
3496 <column name="output_port">
3497 <p>Output port for selected packets, if nonempty.</p>
3498 <p>Specifying a port for mirror output reserves that port exclusively
3499 for mirroring. No frames other than those selected for mirroring
3501 will be forwarded to the port, and any frames received on the port
3502 will be discarded.</p>
3504 The output port may be any kind of port supported by Open vSwitch.
3505 It may be, for example, a physical port (sometimes called SPAN) or a
3510 <column name="output_vlan">
3511 <p>Output VLAN for selected packets, if nonempty.</p>
3512 <p>The frames will be sent out all ports that trunk
3513 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3514 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3515 trunk port, the frame's VLAN tag will be set to
3516 <ref column="output_vlan"/>, replacing any existing tag; when it is
3517 sent out an implicit VLAN port, the frame will not be tagged. This
3518 type of mirroring is sometimes called RSPAN.</p>
3520 See the documentation for
3521 <ref column="other_config" key="forward-bpdu"/> in the
3522 <ref table="Interface"/> table for a list of destination MAC
3523 addresses which will not be mirrored to a VLAN to avoid confusing
3524 switches that interpret the protocols that they represent.
3526 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3527 contains unmanaged switches. Consider an unmanaged physical switch
3528 with two ports: port 1, connected to an end host, and port 2,
3529 connected to an Open vSwitch configured to mirror received packets
3530 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3531 port 1 that the physical switch forwards to port 2. The Open vSwitch
3532 forwards this packet to its destination and then reflects it back on
3533 port 2 in VLAN 123. This reflected packet causes the unmanaged
3534 physical switch to replace the MAC learning table entry, which
3535 correctly pointed to port 1, with one that incorrectly points to port
3536 2. Afterward, the physical switch will direct packets destined for
3537 the end host to the Open vSwitch on port 2, instead of to the end
3538 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3539 desired in this scenario, then the physical switch must be replaced
3540 by one that learns Ethernet addresses on a per-VLAN basis. In
3541 addition, learning should be disabled on the VLAN containing mirrored
3542 traffic. If this is not done then intermediate switches will learn
3543 the MAC address of each end host from the mirrored traffic. If
3544 packets being sent to that end host are also mirrored, then they will
3545 be dropped since the switch will attempt to send them out the input
3546 port. Disabling learning for the VLAN will cause the switch to
3547 correctly send the packet out all ports configured for that VLAN. If
3548 Open vSwitch is being used as an intermediate switch, learning can be
3549 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3550 in the appropriate <ref table="Bridge"/> table or tables.</p>
3552 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3553 VLAN and should generally be preferred.
3558 <group title="Statistics: Mirror counters">
3560 Key-value pairs that report mirror statistics. The update period
3561 is controlled by <ref column="other_config"
3562 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3564 <column name="statistics" key="tx_packets">
3565 Number of packets transmitted through this mirror.
3567 <column name="statistics" key="tx_bytes">
3568 Number of bytes transmitted through this mirror.
3572 <group title="Common Columns">
3573 The overall purpose of these columns is described under <code>Common
3574 Columns</code> at the beginning of this document.
3576 <column name="external_ids"/>
3580 <table name="Controller" title="OpenFlow controller configuration.">
3581 <p>An OpenFlow controller.</p>
3584 Open vSwitch supports two kinds of OpenFlow controllers:
3588 <dt>Primary controllers</dt>
3591 This is the kind of controller envisioned by the OpenFlow 1.0
3592 specification. Usually, a primary controller implements a network
3593 policy by taking charge of the switch's flow table.
3597 Open vSwitch initiates and maintains persistent connections to
3598 primary controllers, retrying the connection each time it fails or
3599 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3600 <ref table="Bridge"/> table applies to primary controllers.
3604 Open vSwitch permits a bridge to have any number of primary
3605 controllers. When multiple controllers are configured, Open
3606 vSwitch connects to all of them simultaneously. Because
3607 OpenFlow 1.0 does not specify how multiple controllers
3608 coordinate in interacting with a single switch, more than
3609 one primary controller should be specified only if the
3610 controllers are themselves designed to coordinate with each
3611 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3612 vendor extension may be useful for this.)
3615 <dt>Service controllers</dt>
3618 These kinds of OpenFlow controller connections are intended for
3619 occasional support and maintenance use, e.g. with
3620 <code>ovs-ofctl</code>. Usually a service controller connects only
3621 briefly to inspect or modify some of a switch's state.
3625 Open vSwitch listens for incoming connections from service
3626 controllers. The service controllers initiate and, if necessary,
3627 maintain the connections from their end. The <ref table="Bridge"
3628 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3629 not apply to service controllers.
3633 Open vSwitch supports configuring any number of service controllers.
3639 The <ref column="target"/> determines the type of controller.
3642 <group title="Core Features">
3643 <column name="target">
3644 <p>Connection method for controller.</p>
3646 The following connection methods are currently supported for primary
3650 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3652 <p>The specified SSL <var>port</var> on the host at the
3653 given <var>ip</var>, which must be expressed as an IP
3654 address (not a DNS name). The <ref table="Open_vSwitch"
3655 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3656 table must point to a valid SSL configuration when this form
3658 <p>If <var>port</var> is not specified, it defaults to 6653.</p>
3659 <p>SSL support is an optional feature that is not always built as
3660 part of Open vSwitch.</p>
3662 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3665 The specified TCP <var>port</var> on the host at the given
3666 <var>ip</var>, which must be expressed as an IP address (not a
3667 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3668 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3669 e.g. <code>tcp:[::1]:6653</code>.
3672 If <var>port</var> is not specified, it defaults to 6653.
3677 The following connection methods are currently supported for service
3681 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3684 Listens for SSL connections on the specified TCP <var>port</var>.
3685 If <var>ip</var>, which must be expressed as an IP address (not a
3686 DNS name), is specified, then connections are restricted to the
3687 specified local IP address (either IPv4 or IPv6). If
3688 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3689 e.g. <code>pssl:6653:[::1]</code>.
3692 If <var>port</var> is not specified, it defaults to
3693 6653. If <var>ip</var> is not specified then it listens only on
3694 IPv4 (but not IPv6) addresses. The
3695 <ref table="Open_vSwitch" column="ssl"/>
3696 column in the <ref table="Open_vSwitch"/> table must point to a
3697 valid SSL configuration when this form is used.
3700 If <var>port</var> is not specified, it currently to 6653.
3703 SSL support is an optional feature that is not always built as
3704 part of Open vSwitch.
3707 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3710 Listens for connections on the specified TCP <var>port</var>. If
3711 <var>ip</var>, which must be expressed as an IP address (not a
3712 DNS name), is specified, then connections are restricted to the
3713 specified local IP address (either IPv4 or IPv6). If
3714 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3715 e.g. <code>ptcp:6653:[::1]</code>. If <var>ip</var> is not
3716 specified then it listens only on IPv4 addresses.
3719 If <var>port</var> is not specified, it defaults to 6653.
3723 <p>When multiple controllers are configured for a single bridge, the
3724 <ref column="target"/> values must be unique. Duplicate
3725 <ref column="target"/> values yield unspecified results.</p>
3728 <column name="connection_mode">
3729 <p>If it is specified, this setting must be one of the following
3730 strings that describes how Open vSwitch contacts this OpenFlow
3731 controller over the network:</p>
3734 <dt><code>in-band</code></dt>
3735 <dd>In this mode, this controller's OpenFlow traffic travels over the
3736 bridge associated with the controller. With this setting, Open
3737 vSwitch allows traffic to and from the controller regardless of the
3738 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3739 would never be able to connect to the controller, because it did
3740 not have a flow to enable it.) This is the most common connection
3741 mode because it is not necessary to maintain two independent
3743 <dt><code>out-of-band</code></dt>
3744 <dd>In this mode, OpenFlow traffic uses a control network separate
3745 from the bridge associated with this controller, that is, the
3746 bridge does not use any of its own network devices to communicate
3747 with the controller. The control network must be configured
3748 separately, before or after <code>ovs-vswitchd</code> is started.
3752 <p>If not specified, the default is implementation-specific.</p>
3756 <group title="Controller Failure Detection and Handling">
3757 <column name="max_backoff">
3758 Maximum number of milliseconds to wait between connection attempts.
3759 Default is implementation-specific.
3762 <column name="inactivity_probe">
3763 Maximum number of milliseconds of idle time on connection to
3764 controller before sending an inactivity probe message. If Open
3765 vSwitch does not communicate with the controller for the specified
3766 number of seconds, it will send a probe. If a response is not
3767 received for the same additional amount of time, Open vSwitch
3768 assumes the connection has been broken and attempts to reconnect.
3769 Default is implementation-specific. A value of 0 disables
3774 <group title="Asynchronous Messages">
3776 OpenFlow switches send certain messages to controllers spontanenously,
3777 that is, not in response to any request from the controller. These
3778 messages are called ``asynchronous messages.'' These columns allow
3779 asynchronous messages to be limited or disabled to ensure the best use
3780 of network resources.
3783 <column name="enable_async_messages">
3784 The OpenFlow protocol enables asynchronous messages at time of
3785 connection establishment, which means that a controller can receive
3786 asynchronous messages, potentially many of them, even if it turns them
3787 off immediately after connecting. Set this column to
3788 <code>false</code> to change Open vSwitch behavior to disable, by
3789 default, all asynchronous messages. The controller can use the
3790 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3791 on any messages that it does want to receive, if any.
3794 <group title="Controller Rate Limiting">
3796 A switch can forward packets to a controller over the OpenFlow
3797 protocol. Forwarding packets this way at too high a rate can
3798 overwhelm a controller, frustrate use of the OpenFlow connection for
3799 other purposes, increase the latency of flow setup, and use an
3800 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3801 limiting the rate of packet forwarding to a controller.
3805 There are two main reasons in OpenFlow for a packet to be sent to a
3806 controller: either the packet ``misses'' in the flow table, that is,
3807 there is no matching flow, or a flow table action says to send the
3808 packet to the controller. Open vSwitch limits the rate of each kind
3809 of packet separately at the configured rate. Therefore, the actual
3810 rate that packets are sent to the controller can be up to twice the
3811 configured rate, when packets are sent for both reasons.
3815 This feature is specific to forwarding packets over an OpenFlow
3816 connection. It is not general-purpose QoS. See the <ref
3817 table="QoS"/> table for quality of service configuration, and <ref
3818 column="ingress_policing_rate" table="Interface"/> in the <ref
3819 table="Interface"/> table for ingress policing configuration.
3822 <column name="controller_rate_limit">
3824 The maximum rate at which the switch will forward packets to the
3825 OpenFlow controller, in packets per second. If no value is
3826 specified, rate limiting is disabled.
3830 <column name="controller_burst_limit">
3832 When a high rate triggers rate-limiting, Open vSwitch queues
3833 packets to the controller for each port and transmits them to the
3834 controller at the configured rate. This value limits the number of
3835 queued packets. Ports on a bridge share the packet queue fairly.
3839 This value has no effect unless <ref
3840 column="controller_rate_limit"/> is configured. The current
3841 default when this value is not specified is one-quarter of <ref
3842 column="controller_rate_limit"/>, meaning that queuing can delay
3843 forwarding a packet to the controller by up to 250 ms.
3847 <group title="Controller Rate Limiting Statistics">
3849 These values report the effects of rate limiting. Their values are
3850 relative to establishment of the most recent OpenFlow connection,
3851 or since rate limiting was enabled, whichever happened more
3852 recently. Each consists of two values, one with <code>TYPE</code>
3853 replaced by <code>miss</code> for rate limiting flow table misses,
3854 and the other with <code>TYPE</code> replaced by
3855 <code>action</code> for rate limiting packets sent by OpenFlow
3860 These statistics are reported only when controller rate limiting is
3864 <column name="status" key="packet-in-TYPE-bypassed"
3865 type='{"type": "integer", "minInteger": 0}'>
3866 Number of packets sent directly to the controller, without queuing,
3867 because the rate did not exceed the configured maximum.
3870 <column name="status" key="packet-in-TYPE-queued"
3871 type='{"type": "integer", "minInteger": 0}'>
3872 Number of packets added to the queue to send later.
3875 <column name="status" key="packet-in-TYPE-dropped"
3876 type='{"type": "integer", "minInteger": 0}'>
3877 Number of packets added to the queue that were later dropped due to
3878 overflow. This value is less than or equal to <ref column="status"
3879 key="packet-in-TYPE-queued"/>.
3882 <column name="status" key="packet-in-TYPE-backlog"
3883 type='{"type": "integer", "minInteger": 0}'>
3884 Number of packets currently queued. The other statistics increase
3885 monotonically, but this one fluctuates between 0 and the <ref
3886 column="controller_burst_limit"/> as conditions change.
3892 <group title="Additional In-Band Configuration">
3893 <p>These values are considered only in in-band control mode (see
3894 <ref column="connection_mode"/>).</p>
3896 <p>When multiple controllers are configured on a single bridge, there
3897 should be only one set of unique values in these columns. If different
3898 values are set for these columns in different controllers, the effect
3901 <column name="local_ip">
3902 The IP address to configure on the local port,
3903 e.g. <code>192.168.0.123</code>. If this value is unset, then
3904 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3908 <column name="local_netmask">
3909 The IP netmask to configure on the local port,
3910 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3911 but this value is unset, then the default is chosen based on whether
3912 the IP address is class A, B, or C.
3915 <column name="local_gateway">
3916 The IP address of the gateway to configure on the local port, as a
3917 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3918 this network has no gateway.
3922 <group title="Controller Status">
3923 <column name="is_connected">
3924 <code>true</code> if currently connected to this controller,
3925 <code>false</code> otherwise.
3929 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3930 <p>The level of authority this controller has on the associated
3931 bridge. Possible values are:</p>
3933 <dt><code>other</code></dt>
3934 <dd>Allows the controller access to all OpenFlow features.</dd>
3935 <dt><code>master</code></dt>
3936 <dd>Equivalent to <code>other</code>, except that there may be at
3937 most one master controller at a time. When a controller configures
3938 itself as <code>master</code>, any existing master is demoted to
3939 the <code>slave</code> role.</dd>
3940 <dt><code>slave</code></dt>
3941 <dd>Allows the controller read-only access to OpenFlow features.
3942 Attempts to modify the flow table will be rejected with an
3943 error. Slave controllers do not receive OFPT_PACKET_IN or
3944 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3949 <column name="status" key="last_error">
3950 A human-readable description of the last error on the connection
3951 to the controller; i.e. <code>strerror(errno)</code>. This key
3952 will exist only if an error has occurred.
3955 <column name="status" key="state"
3956 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3958 The state of the connection to the controller:
3961 <dt><code>VOID</code></dt>
3962 <dd>Connection is disabled.</dd>
3964 <dt><code>BACKOFF</code></dt>
3965 <dd>Attempting to reconnect at an increasing period.</dd>
3967 <dt><code>CONNECTING</code></dt>
3968 <dd>Attempting to connect.</dd>
3970 <dt><code>ACTIVE</code></dt>
3971 <dd>Connected, remote host responsive.</dd>
3973 <dt><code>IDLE</code></dt>
3974 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3977 These values may change in the future. They are provided only for
3982 <column name="status" key="sec_since_connect"
3983 type='{"type": "integer", "minInteger": 0}'>
3984 The amount of time since this controller last successfully connected to
3985 the switch (in seconds). Value is empty if controller has never
3986 successfully connected.
3989 <column name="status" key="sec_since_disconnect"
3990 type='{"type": "integer", "minInteger": 1}'>
3991 The amount of time since this controller last disconnected from
3992 the switch (in seconds). Value is empty if controller has never
3997 <group title="Connection Parameters">
3999 Additional configuration for a connection between the controller
4000 and the Open vSwitch.
4003 <column name="other_config" key="dscp"
4004 type='{"type": "integer"}'>
4005 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4006 in the Type of Service (TOS) field in the IP header. DSCP provides a
4007 mechanism to classify the network traffic and provide Quality of
4008 Service (QoS) on IP networks.
4010 The DSCP value specified here is used when establishing the connection
4011 between the controller and the Open vSwitch. If no value is specified,
4012 a default value of 48 is chosen. Valid DSCP values must be in the
4018 <group title="Common Columns">
4019 The overall purpose of these columns is described under <code>Common
4020 Columns</code> at the beginning of this document.
4022 <column name="external_ids"/>
4023 <column name="other_config"/>
4027 <table name="Manager" title="OVSDB management connection.">
4029 Configuration for a database connection to an Open vSwitch database
4034 This table primarily configures the Open vSwitch database
4035 (<code>ovsdb-server</code>), not the Open vSwitch switch
4036 (<code>ovs-vswitchd</code>). The switch does read the table to determine
4037 what connections should be treated as in-band.
4041 The Open vSwitch database server can initiate and maintain active
4042 connections to remote clients. It can also listen for database
4046 <group title="Core Features">
4047 <column name="target">
4048 <p>Connection method for managers.</p>
4050 The following connection methods are currently supported:
4053 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
4056 The specified SSL <var>port</var> on the host at the given
4057 <var>ip</var>, which must be expressed as an IP address
4058 (not a DNS name). The <ref table="Open_vSwitch"
4059 column="ssl"/> column in the <ref table="Open_vSwitch"/>
4060 table must point to a valid SSL configuration when this
4064 If <var>port</var> is not specified, it defaults to 6640.
4067 SSL support is an optional feature that is not always
4068 built as part of Open vSwitch.
4072 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
4075 The specified TCP <var>port</var> on the host at the given
4076 <var>ip</var>, which must be expressed as an IP address (not a
4077 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
4078 <var>ip</var> is an IPv6 address, wrap it in square brackets,
4079 e.g. <code>tcp:[::1]:6640</code>.
4082 If <var>port</var> is not specified, it defaults to 6640.
4085 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4088 Listens for SSL connections on the specified TCP <var>port</var>.
4089 Specify 0 for <var>port</var> to have the kernel automatically
4090 choose an available port. If <var>ip</var>, which must be
4091 expressed as an IP address (not a DNS name), is specified, then
4092 connections are restricted to the specified local IP address
4093 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4094 address, wrap in square brackets,
4095 e.g. <code>pssl:6640:[::1]</code>. If <var>ip</var> is not
4096 specified then it listens only on IPv4 (but not IPv6) addresses.
4097 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
4098 table="Open_vSwitch"/> table must point to a valid SSL
4099 configuration when this form is used.
4102 If <var>port</var> is not specified, it defaults to 6640.
4105 SSL support is an optional feature that is not always built as
4106 part of Open vSwitch.
4109 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4112 Listens for connections on the specified TCP <var>port</var>.
4113 Specify 0 for <var>port</var> to have the kernel automatically
4114 choose an available port. If <var>ip</var>, which must be
4115 expressed as an IP address (not a DNS name), is specified, then
4116 connections are restricted to the specified local IP address
4117 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4118 address, wrap it in square brackets,
4119 e.g. <code>ptcp:6640:[::1]</code>. If <var>ip</var> is not
4120 specified then it listens only on IPv4 addresses.
4123 If <var>port</var> is not specified, it defaults to 6640.
4127 <p>When multiple managers are configured, the <ref column="target"/>
4128 values must be unique. Duplicate <ref column="target"/> values yield
4129 unspecified results.</p>
4132 <column name="connection_mode">
4134 If it is specified, this setting must be one of the following strings
4135 that describes how Open vSwitch contacts this OVSDB client over the
4140 <dt><code>in-band</code></dt>
4142 In this mode, this connection's traffic travels over a bridge
4143 managed by Open vSwitch. With this setting, Open vSwitch allows
4144 traffic to and from the client regardless of the contents of the
4145 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4146 to connect to the client, because it did not have a flow to enable
4147 it.) This is the most common connection mode because it is not
4148 necessary to maintain two independent networks.
4150 <dt><code>out-of-band</code></dt>
4152 In this mode, the client's traffic uses a control network separate
4153 from that managed by Open vSwitch, that is, Open vSwitch does not
4154 use any of its own network devices to communicate with the client.
4155 The control network must be configured separately, before or after
4156 <code>ovs-vswitchd</code> is started.
4161 If not specified, the default is implementation-specific.
4166 <group title="Client Failure Detection and Handling">
4167 <column name="max_backoff">
4168 Maximum number of milliseconds to wait between connection attempts.
4169 Default is implementation-specific.
4172 <column name="inactivity_probe">
4173 Maximum number of milliseconds of idle time on connection to the client
4174 before sending an inactivity probe message. If Open vSwitch does not
4175 communicate with the client for the specified number of seconds, it
4176 will send a probe. If a response is not received for the same
4177 additional amount of time, Open vSwitch assumes the connection has been
4178 broken and attempts to reconnect. Default is implementation-specific.
4179 A value of 0 disables inactivity probes.
4183 <group title="Status">
4184 <column name="is_connected">
4185 <code>true</code> if currently connected to this manager,
4186 <code>false</code> otherwise.
4189 <column name="status" key="last_error">
4190 A human-readable description of the last error on the connection
4191 to the manager; i.e. <code>strerror(errno)</code>. This key
4192 will exist only if an error has occurred.
4195 <column name="status" key="state"
4196 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
4198 The state of the connection to the manager:
4201 <dt><code>VOID</code></dt>
4202 <dd>Connection is disabled.</dd>
4204 <dt><code>BACKOFF</code></dt>
4205 <dd>Attempting to reconnect at an increasing period.</dd>
4207 <dt><code>CONNECTING</code></dt>
4208 <dd>Attempting to connect.</dd>
4210 <dt><code>ACTIVE</code></dt>
4211 <dd>Connected, remote host responsive.</dd>
4213 <dt><code>IDLE</code></dt>
4214 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
4217 These values may change in the future. They are provided only for
4222 <column name="status" key="sec_since_connect"
4223 type='{"type": "integer", "minInteger": 0}'>
4224 The amount of time since this manager last successfully connected
4225 to the database (in seconds). Value is empty if manager has never
4226 successfully connected.
4229 <column name="status" key="sec_since_disconnect"
4230 type='{"type": "integer", "minInteger": 0}'>
4231 The amount of time since this manager last disconnected from the
4232 database (in seconds). Value is empty if manager has never
4236 <column name="status" key="locks_held">
4237 Space-separated list of the names of OVSDB locks that the connection
4238 holds. Omitted if the connection does not hold any locks.
4241 <column name="status" key="locks_waiting">
4242 Space-separated list of the names of OVSDB locks that the connection is
4243 currently waiting to acquire. Omitted if the connection is not waiting
4247 <column name="status" key="locks_lost">
4248 Space-separated list of the names of OVSDB locks that the connection
4249 has had stolen by another OVSDB client. Omitted if no locks have been
4250 stolen from this connection.
4253 <column name="status" key="n_connections"
4254 type='{"type": "integer", "minInteger": 2}'>
4256 When <ref column="target"/> specifies a connection method that
4257 listens for inbound connections (e.g. <code>ptcp:</code> or
4258 <code>pssl:</code>) and more than one connection is actually active,
4259 the value is the number of active connections. Otherwise, this
4260 key-value pair is omitted.
4263 When multiple connections are active, status columns and key-value
4264 pairs (other than this one) report the status of one arbitrarily
4269 <column name="status" key="bound_port" type='{"type": "integer"}'>
4270 When <ref column="target"/> is <code>ptcp:</code> or
4271 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
4272 listening. (This is is particularly useful when <ref
4273 column="target"/> specifies a port of 0, allowing the kernel to
4274 choose any available port.)
4278 <group title="Connection Parameters">
4280 Additional configuration for a connection between the manager
4281 and the Open vSwitch Database.
4284 <column name="other_config" key="dscp"
4285 type='{"type": "integer"}'>
4286 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4287 in the Type of Service (TOS) field in the IP header. DSCP provides a
4288 mechanism to classify the network traffic and provide Quality of
4289 Service (QoS) on IP networks.
4291 The DSCP value specified here is used when establishing the connection
4292 between the manager and the Open vSwitch. If no value is specified, a
4293 default value of 48 is chosen. Valid DSCP values must be in the range
4298 <group title="Common Columns">
4299 The overall purpose of these columns is described under <code>Common
4300 Columns</code> at the beginning of this document.
4302 <column name="external_ids"/>
4303 <column name="other_config"/>
4307 <table name="NetFlow">
4308 A NetFlow target. NetFlow is a protocol that exports a number of
4309 details about terminating IP flows, such as the principals involved
4312 <column name="targets">
4313 NetFlow targets in the form
4314 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
4315 must be specified numerically, not as a DNS name.
4318 <column name="engine_id">
4319 Engine ID to use in NetFlow messages. Defaults to datapath index
4323 <column name="engine_type">
4324 Engine type to use in NetFlow messages. Defaults to datapath
4325 index if not specified.
4328 <column name="active_timeout">
4330 The interval at which NetFlow records are sent for flows that
4331 are still active, in seconds. A value of <code>0</code>
4332 requests the default timeout (currently 600 seconds); a value
4333 of <code>-1</code> disables active timeouts.
4337 The NetFlow passive timeout, for flows that become inactive,
4338 is not configurable. It will vary depending on the Open
4339 vSwitch version, the forms and contents of the OpenFlow flow
4340 tables, CPU and memory usage, and network activity. A typical
4341 passive timeout is about a second.
4345 <column name="add_id_to_interface">
4346 <p>If this column's value is <code>false</code>, the ingress and egress
4347 interface fields of NetFlow flow records are derived from OpenFlow port
4348 numbers. When it is <code>true</code>, the 7 most significant bits of
4349 these fields will be replaced by the least significant 7 bits of the
4350 engine id. This is useful because many NetFlow collectors do not
4351 expect multiple switches to be sending messages from the same host, so
4352 they do not store the engine information which could be used to
4353 disambiguate the traffic.</p>
4354 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
4357 <group title="Common Columns">
4358 The overall purpose of these columns is described under <code>Common
4359 Columns</code> at the beginning of this document.
4361 <column name="external_ids"/>
4366 SSL configuration for an Open_vSwitch.
4368 <column name="private_key">
4369 Name of a PEM file containing the private key used as the switch's
4370 identity for SSL connections to the controller.
4373 <column name="certificate">
4374 Name of a PEM file containing a certificate, signed by the
4375 certificate authority (CA) used by the controller and manager,
4376 that certifies the switch's private key, identifying a trustworthy
4380 <column name="ca_cert">
4381 Name of a PEM file containing the CA certificate used to verify
4382 that the switch is connected to a trustworthy controller.
4385 <column name="bootstrap_ca_cert">
4386 If set to <code>true</code>, then Open vSwitch will attempt to
4387 obtain the CA certificate from the controller on its first SSL
4388 connection and save it to the named PEM file. If it is successful,
4389 it will immediately drop the connection and reconnect, and from then
4390 on all SSL connections must be authenticated by a certificate signed
4391 by the CA certificate thus obtained. <em>This option exposes the
4392 SSL connection to a man-in-the-middle attack obtaining the initial
4393 CA certificate.</em> It may still be useful for bootstrapping.
4396 <group title="Common Columns">
4397 The overall purpose of these columns is described under <code>Common
4398 Columns</code> at the beginning of this document.
4400 <column name="external_ids"/>
4404 <table name="sFlow">
4405 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4406 monitoring of switches.</p>
4408 <column name="agent">
4409 Name of the network device whose IP address should be reported as the
4410 ``agent address'' to collectors. If not specified, the agent device is
4411 figured from the first target address and the routing table. If the
4412 routing table does not contain a route to the target, the IP address
4413 defaults to the <ref table="Controller" column="local_ip"/> in the
4414 collector's <ref table="Controller"/>. If an agent IP address cannot be
4415 determined any of these ways, sFlow is disabled.
4418 <column name="header">
4419 Number of bytes of a sampled packet to send to the collector.
4420 If not specified, the default is 128 bytes.
4423 <column name="polling">
4424 Polling rate in seconds to send port statistics to the collector.
4425 If not specified, defaults to 30 seconds.
4428 <column name="sampling">
4429 Rate at which packets should be sampled and sent to the collector.
4430 If not specified, defaults to 400, which means one out of 400
4431 packets, on average, will be sent to the collector.
4434 <column name="targets">
4435 sFlow targets in the form
4436 <code><var>ip</var>:<var>port</var></code>.
4439 <group title="Common Columns">
4440 The overall purpose of these columns is described under <code>Common
4441 Columns</code> at the beginning of this document.
4443 <column name="external_ids"/>
4447 <table name="IPFIX">
4448 <p>Configuration for sending packets to IPFIX collectors.</p>
4451 IPFIX is a protocol that exports a number of details about flows. The
4452 IPFIX implementation in Open vSwitch samples packets at a configurable
4453 rate, extracts flow information from those packets, optionally caches and
4454 aggregates the flow information, and sends the result to one or more
4459 IPFIX in Open vSwitch can be configured two different ways:
4464 With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling
4465 automatically on all packets that pass through a bridge. To configure
4466 per-bridge sampling, create an <ref table="IPFIX"/> record and point a
4467 <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/>
4468 column to it. The <ref table="Flow_Sample_Collector_Set"/> table is
4469 not used for per-bridge sampling.
4474 With <em>flow-based sampling</em>, <code>sample</code> actions in the
4475 OpenFlow flow table drive IPFIX sampling. See
4476 <code>ovs-ofctl</code>(8) for a description of the
4477 <code>sample</code> action.
4481 Flow-based sampling also requires database configuration: create a
4482 <ref table="IPFIX"/> record that describes the IPFIX configuration
4483 and a <ref table="Flow_Sample_Collector_Set"/> record that points to
4484 the <ref table="Bridge"/> whose flow table holds the
4485 <code>sample</code> actions and to <ref table="IPFIX"/> record. The
4486 <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/>
4487 table is not used for flow-based sampling.
4492 <column name="targets">
4493 IPFIX target collectors in the form
4494 <code><var>ip</var>:<var>port</var></code>.
4497 <column name="cache_active_timeout">
4498 The maximum period in seconds for which an IPFIX flow record is
4499 cached and aggregated before being sent. If not specified,
4500 defaults to 0. If 0, caching is disabled.
4503 <column name="cache_max_flows">
4504 The maximum number of IPFIX flow records that can be cached at a
4505 time. If not specified, defaults to 0. If 0, caching is
4509 <group title="Per-Bridge Sampling">
4511 These values affect only per-bridge sampling. See above for a
4512 description of the differences between per-bridge and flow-based
4516 <column name="sampling">
4517 The rate at which packets should be sampled and sent to each target
4518 collector. If not specified, defaults to 400, which means one out of
4519 400 packets, on average, will be sent to each target collector.
4522 <column name="obs_domain_id">
4523 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4524 specified, defaults to 0.
4527 <column name="obs_point_id">
4528 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4529 specified, defaults to 0.
4532 <column name="other_config" key="enable-tunnel-sampling"
4533 type='{"type": "boolean"}'>
4535 Set to <code>true</code> to enable sampling and reporting tunnel
4536 header 7-tuples in IPFIX flow records. Tunnel sampling is disabled
4541 The following enterprise entities report the sampled tunnel info:
4545 <dt>tunnelType:</dt>
4547 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4548 <p>type: unsigned 8-bit integer.</p>
4549 <p>data type semantics: identifier.</p>
4550 <p>description: Identifier of the layer 2 network overlay network
4551 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4556 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4557 <p>type: variable-length octetarray.</p>
4558 <p>data type semantics: identifier.</p>
4559 <p>description: Key which is used for identifying an individual
4560 traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI),
4561 GRE (32-bit key), or LISP (24-bit instance ID) tunnel. The
4562 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4563 ID in network byte order.</p>
4565 <dt>tunnelSourceIPv4Address:</dt>
4567 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4568 <p>type: unsigned 32-bit integer.</p>
4569 <p>data type semantics: identifier.</p>
4570 <p>description: The IPv4 source address in the tunnel IP packet
4573 <dt>tunnelDestinationIPv4Address:</dt>
4575 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4576 <p>type: unsigned 32-bit integer.</p>
4577 <p>data type semantics: identifier.</p>
4578 <p>description: The IPv4 destination address in the tunnel IP
4581 <dt>tunnelProtocolIdentifier:</dt>
4583 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4584 <p>type: unsigned 8-bit integer.</p>
4585 <p>data type semantics: identifier.</p>
4586 <p>description: The value of the protocol number in the tunnel
4587 IP packet header. The protocol number identifies the tunnel IP
4588 packet payload type.</p>
4590 <dt>tunnelSourceTransportPort:</dt>
4592 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4593 <p>type: unsigned 16-bit integer.</p>
4594 <p>data type semantics: identifier.</p>
4595 <p>description: The source port identifier in the tunnel transport
4596 header. For the transport protocols UDP, TCP, and SCTP, this is
4597 the source port number given in the respective header.</p>
4599 <dt>tunnelDestinationTransportPort:</dt>
4601 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4602 <p>type: unsigned 16-bit integer.</p>
4603 <p>data type semantics: identifier.</p>
4604 <p>description: The destination port identifier in the tunnel
4605 transport header. For the transport protocols UDP, TCP, and SCTP,
4606 this is the destination port number given in the respective header.
4612 <column name="other_config" key="enable-input-sampling"
4613 type='{"type": "boolean"}'>
4614 By default, Open vSwitch samples and reports flows at bridge port input
4615 in IPFIX flow records. Set this column to <code>false</code> to
4616 disable input sampling.
4619 <column name="other_config" key="enable-output-sampling"
4620 type='{"type": "boolean"}'>
4621 By default, Open vSwitch samples and reports flows at bridge port
4622 output in IPFIX flow records. Set this column to <code>false</code> to
4623 disable output sampling.
4627 <group title="Common Columns">
4628 The overall purpose of these columns is described under <code>Common
4629 Columns</code> at the beginning of this document.
4631 <column name="external_ids"/>
4635 <table name="Flow_Sample_Collector_Set">
4637 A set of IPFIX collectors of packet samples generated by OpenFlow
4638 <code>sample</code> actions. This table is used only for IPFIX
4639 flow-based sampling, not for per-bridge sampling (see the <ref
4640 table="IPFIX"/> table for a description of the two forms).
4644 The ID of this collector set, unique among the bridge's
4645 collector sets, to be used as the <code>collector_set_id</code>
4646 in OpenFlow <code>sample</code> actions.
4649 <column name="bridge">
4650 The bridge into which OpenFlow <code>sample</code> actions can
4651 be added to send packet samples to this set of IPFIX collectors.
4654 <column name="ipfix">
4655 Configuration of the set of IPFIX collectors to send one flow
4656 record per sampled packet to.
4659 <group title="Common Columns">
4660 The overall purpose of these columns is described under <code>Common
4661 Columns</code> at the beginning of this document.
4663 <column name="external_ids"/>
4667 <table name="AutoAttach">
4669 Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4670 draft standard describes a compact method of using IEEE 802.1AB Link
4671 Layer Discovery Protocol (LLDP) together with a IEEE 802.1aq Shortest
4672 Path Bridging (SPB) network to automatically attach network devices
4673 to individual services in a SPB network. The intent here is to allow
4674 network applications and devices using OVS to be able to easily take
4675 advantage of features offered by industry standard SPB networks.
4679 Auto Attach (AA) uses LLDP to communicate between a directly connected
4680 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4681 is extended to add two new Type-Length-Value tuples (TLVs). The first
4682 new TLV supports the ongoing discovery of directly connected AA
4683 correspondents. Auto Attach operates by regularly transmitting AA
4684 discovery TLVs between the AA client and AA server. By exchanging these
4685 discovery messages, both the AAC and AAS learn the system name and
4686 system description of their peer. In the OVS context, OVS operates as
4687 the AA client and the AA server resides on a switch at the edge of the
4692 Once AA discovery has been completed the AAC then uses the second new TLV
4693 to deliver identifier mappings from the AAC to the AAS. A primary feature
4694 of Auto Attach is to facilitate the mapping of VLANs defined outside the
4695 SPB network onto service ids (ISIDs) defined within the SPM network. By
4696 doing so individual external VLANs can be mapped onto specific SPB
4697 network services. These VLAN id to ISID mappings can be configured and
4698 managed locally using new options added to the ovs-vsctl command.
4702 The Auto Attach OVS feature does not provide a full implementation of
4703 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
4704 standard and support for the AA TLV extensions is provided. LLDP
4705 protocol support in OVS can be enabled or disabled on a port by port
4706 basis. LLDP support is disabled by default.
4709 <column name="system_name">
4710 The system_name string is exported in LLDP messages. It should uniquely
4711 identify the bridge in the network.
4714 <column name="system_description">
4715 The system_description string is exported in LLDP messages. It should
4716 describe the type of software and hardware.
4719 <column name="mappings">
4720 A mapping from SPB network Individual Service Identifier (ISID) to VLAN