1 <?xml version="1.0" encoding="utf-8"?>
2 <database name="ovs-vswitchd.conf.db" title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
75 <column name="other_config" key="stats-update-interval"
76 type='{"type": "integer", "minInteger": 5000}'>
78 Interval for updating statistics to the database, in milliseconds.
79 This option will affect the update of the <code>statistics</code>
80 column in the following tables: <code>Port</code>, <code>Interface
81 </code>, <code>Mirror</code>.
84 Default value is 5000 ms.
87 Getting statistics more frequently can be achieved via OpenFlow.
91 <column name="other_config" key="flow-restore-wait"
92 type='{"type": "boolean"}'>
94 When <code>ovs-vswitchd</code> starts up, it has an empty flow table
95 and therefore it handles all arriving packets in its default fashion
96 according to its configuration, by dropping them or sending them to
97 an OpenFlow controller or switching them as a standalone switch.
98 This behavior is ordinarily desirable. However, if
99 <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
100 then this leads to a relatively long period during which packets are
104 This option allows for improvement. When <code>ovs-vswitchd</code>
105 starts with this value set as <code>true</code>, it will neither
106 flush or expire previously set datapath flows nor will it send and
107 receive any packets to or from the datapath. When this value is
108 later set to <code>false</code>, <code>ovs-vswitchd</code> will
109 start receiving packets from the datapath and re-setup the flows.
112 Thus, with this option, the procedure for a hot-upgrade of
113 <code>ovs-vswitchd</code> becomes roughly the following:
117 Stop <code>ovs-vswitchd</code>.
120 Set <ref column="other_config" key="flow-restore-wait"/>
121 to <code>true</code>.
124 Start <code>ovs-vswitchd</code>.
127 Use <code>ovs-ofctl</code> (or some other program, such as an
128 OpenFlow controller) to restore the OpenFlow flow table
129 to the desired state.
132 Set <ref column="other_config" key="flow-restore-wait"/>
133 to <code>false</code> (or remove it entirely from the database).
137 The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
138 functions use the above config option during hot upgrades.
142 <column name="other_config" key="flow-limit"
143 type='{"type": "integer", "minInteger": 0}'>
146 number of flows allowed in the datapath flow table. Internally OVS
147 will choose a flow limit which will likely be lower than this number,
148 based on real time network conditions.
151 The default is 200000.
155 <column name="other_config" key="max-idle"
156 type='{"type": "integer", "minInteger": 500}'>
158 The maximum time (in ms) that idle flows will remain cached in the
159 datapath. Internally OVS will check the validity and activity for
160 datapath flows regularly and may expire flows quicker than this
161 number, based on real time network conditions. Tweaking this
162 value is discouraged unless you know exactly what you're doing.
165 The default is 10000.
169 <column name="other_config" key="n-dpdk-rxqs"
170 type='{"type": "integer", "minInteger": 1}'>
172 Specifies the maximum number of rx queues to be created for each dpdk
173 interface. If not specified or specified to 0, one rx queue will
174 be created for each dpdk interface by default.
178 <column name="other_config" key="pmd-cpu-mask">
180 Specifies CPU mask for setting the cpu affinity of PMD (Poll
181 Mode Driver) threads. Value should be in the form of hex string,
182 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
186 The lowest order bit corresponds to the first CPU core. A set bit
187 means the corresponding core is available and a pmd thread will be
188 created and pinned to it. If the input does not cover all cores,
189 those uncovered cores are considered not set.
192 If not specified, one pmd thread will be created for each numa node
193 and pinned to any available core on the numa node by default.
197 <column name="other_config" key="n-handler-threads"
198 type='{"type": "integer", "minInteger": 1}'>
200 Specifies the number of threads for software datapaths to use for
201 handling new flows. The default the number of online CPU cores minus
202 the number of revalidators.
205 This configuration is per datapath. If you have more than one
206 software datapath (e.g. some <code>system</code> bridges and some
207 <code>netdev</code> bridges), then the total number of threads is
208 <code>n-handler-threads</code> times the number of software
213 <column name="other_config" key="n-revalidator-threads"
214 type='{"type": "integer", "minInteger": 1}'>
216 Specifies the number of threads for software datapaths to use for
217 revalidating flows in the datapath. Typically, there is a direct
218 correlation between the number of revalidator threads, and the number
219 of flows allowed in the datapath. The default is the number of cpu
220 cores divided by four plus one. If <code>n-handler-threads</code> is
221 set, the default changes to the number of cpu cores minus the number
225 This configuration is per datapath. If you have more than one
226 software datapath (e.g. some <code>system</code> bridges and some
227 <code>netdev</code> bridges), then the total number of threads is
228 <code>n-handler-threads</code> times the number of software
234 <group title="Status">
235 <column name="next_cfg">
236 Sequence number for client to increment. When a client modifies
237 any part of the database configuration and wishes to wait for
238 Open vSwitch to finish applying the changes, it may increment
239 this sequence number.
242 <column name="cur_cfg">
243 Sequence number that Open vSwitch sets to the current value of
244 <ref column="next_cfg"/> after it finishes applying a set of
245 configuration changes.
248 <group title="Statistics">
250 The <code>statistics</code> column contains key-value pairs that
251 report statistics about a system running an Open vSwitch. These are
252 updated periodically (currently, every 5 seconds). Key-value pairs
253 that cannot be determined or that do not apply to a platform are
257 <column name="other_config" key="enable-statistics"
258 type='{"type": "boolean"}'>
259 Statistics are disabled by default to avoid overhead in the common
260 case when statistics gathering is not useful. Set this value to
261 <code>true</code> to enable populating the <ref column="statistics"/>
262 column or to <code>false</code> to explicitly disable it.
265 <column name="statistics" key="cpu"
266 type='{"type": "integer", "minInteger": 1}'>
268 Number of CPU processors, threads, or cores currently online and
269 available to the operating system on which Open vSwitch is running,
270 as an integer. This may be less than the number installed, if some
271 are not online or if they are not available to the operating
275 Open vSwitch userspace processes are not multithreaded, but the
276 Linux kernel-based datapath is.
280 <column name="statistics" key="load_average">
281 A comma-separated list of three floating-point numbers,
282 representing the system load average over the last 1, 5, and 15
283 minutes, respectively.
286 <column name="statistics" key="memory">
288 A comma-separated list of integers, each of which represents a
289 quantity of memory in kilobytes that describes the operating
290 system on which Open vSwitch is running. In respective order,
295 <li>Total amount of RAM allocated to the OS.</li>
296 <li>RAM allocated to the OS that is in use.</li>
297 <li>RAM that can be flushed out to disk or otherwise discarded
298 if that space is needed for another purpose. This number is
299 necessarily less than or equal to the previous value.</li>
300 <li>Total disk space allocated for swap.</li>
301 <li>Swap space currently in use.</li>
305 On Linux, all five values can be determined and are included. On
306 other operating systems, only the first two values can be
307 determined, so the list will only have two values.
311 <column name="statistics" key="process_NAME">
313 One such key-value pair, with <code>NAME</code> replaced by
314 a process name, will exist for each running Open vSwitch
315 daemon process, with <var>name</var> replaced by the
316 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
317 value is a comma-separated list of integers. The integers
318 represent the following, with memory measured in kilobytes
319 and durations in milliseconds:
323 <li>The process's virtual memory size.</li>
324 <li>The process's resident set size.</li>
325 <li>The amount of user and system CPU time consumed by the
327 <li>The number of times that the process has crashed and been
328 automatically restarted by the monitor.</li>
329 <li>The duration since the process was started.</li>
330 <li>The duration for which the process has been running.</li>
334 The interpretation of some of these values depends on whether the
335 process was started with the <option>--monitor</option>. If it
336 was not, then the crash count will always be 0 and the two
337 durations will always be the same. If <option>--monitor</option>
338 was given, then the crash count may be positive; if it is, the
339 latter duration is the amount of time since the most recent crash
344 There will be one key-value pair for each file in Open vSwitch's
345 ``run directory'' (usually <code>/var/run/openvswitch</code>)
346 whose name ends in <code>.pid</code>, whose contents are a
347 process ID, and which is locked by a running process. The
348 <var>name</var> is taken from the pidfile's name.
352 Currently Open vSwitch is only able to obtain all of the above
353 detail on Linux systems. On other systems, the same key-value
354 pairs will be present but the values will always be the empty
359 <column name="statistics" key="file_systems">
361 A space-separated list of information on local, writable file
362 systems. Each item in the list describes one file system and
363 consists in turn of a comma-separated list of the following:
367 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
368 Any spaces or commas in the mount point are replaced by
370 <li>Total size, in kilobytes, as an integer.</li>
371 <li>Amount of storage in use, in kilobytes, as an integer.</li>
375 This key-value pair is omitted if there are no local, writable
376 file systems or if Open vSwitch cannot obtain the needed
383 <group title="Version Reporting">
385 These columns report the types and versions of the hardware and
386 software running Open vSwitch. We recommend in general that software
387 should test whether specific features are supported instead of relying
388 on version number checks. These values are primarily intended for
389 reporting to human administrators.
392 <column name="ovs_version">
393 The Open vSwitch version number, e.g. <code>1.1.0</code>.
396 <column name="db_version">
398 The database schema version number in the form
399 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
400 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
401 a non-backward compatible way (e.g. deleting a column or a table),
402 <var>major</var> is incremented. When the database schema is changed
403 in a backward compatible way (e.g. adding a new column),
404 <var>minor</var> is incremented. When the database schema is changed
405 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
410 The schema version is part of the database schema, so it can also be
411 retrieved by fetching the schema using the Open vSwitch database
416 <column name="system_type">
418 An identifier for the type of system on top of which Open vSwitch
419 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
422 System integrators are responsible for choosing and setting an
423 appropriate value for this column.
427 <column name="system_version">
429 The version of the system identified by <ref column="system_type"/>,
430 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
433 System integrators are responsible for choosing and setting an
434 appropriate value for this column.
440 <group title="Capabilities">
442 These columns report capabilities of the Open vSwitch instance.
444 <column name="datapath_types">
446 This column reports the different dpifs registered with the system.
447 These are the values that this instance supports in the <ref
448 column="datapath_type" table="Bridge"/> column of the <ref
449 table="Bridge"/> table.
452 <column name="iface_types">
454 This column reports the different netdevs registered with the system.
455 These are the values that this instance supports in the <ref
456 column="type" table="Interface"/> column of the <ref
457 table="Interface"/> table.
462 <group title="Database Configuration">
464 These columns primarily configure the Open vSwitch database
465 (<code>ovsdb-server</code>), not the Open vSwitch switch
466 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
467 column="ssl"/> settings.
471 The Open vSwitch switch does read the database configuration to
472 determine remote IP addresses to which in-band control should apply.
475 <column name="manager_options">
476 Database clients to which the Open vSwitch database server should
477 connect or to which it should listen, along with options for how these
478 connection should be configured. See the <ref table="Manager"/> table
479 for more information.
483 <group title="Common Columns">
484 The overall purpose of these columns is described under <code>Common
485 Columns</code> at the beginning of this document.
487 <column name="other_config"/>
488 <column name="external_ids"/>
492 <table name="Bridge">
494 Configuration for a bridge within an
495 <ref table="Open_vSwitch"/>.
498 A <ref table="Bridge"/> record represents an Ethernet switch with one or
499 more ``ports,'' which are the <ref table="Port"/> records pointed to by
500 the <ref table="Bridge"/>'s <ref column="ports"/> column.
503 <group title="Core Features">
505 Bridge identifier. Should be alphanumeric and no more than about 8
506 bytes long. Must be unique among the names of ports, interfaces, and
510 <column name="ports">
511 Ports included in the bridge.
514 <column name="mirrors">
515 Port mirroring configuration.
518 <column name="netflow">
519 NetFlow configuration.
522 <column name="sflow">
523 sFlow(R) configuration.
526 <column name="ipfix">
530 <column name="flood_vlans">
532 VLAN IDs of VLANs on which MAC address learning should be disabled,
533 so that packets are flooded instead of being sent to specific ports
534 that are believed to contain packets' destination MACs. This should
535 ordinarily be used to disable MAC learning on VLANs used for
536 mirroring (RSPAN VLANs). It may also be useful for debugging.
539 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
540 the <ref table="Port"/> table) is incompatible with
541 <code>flood_vlans</code>. Consider using another bonding mode or
542 a different type of mirror instead.
546 <column name="auto_attach">
547 Auto Attach configuration.
551 <group title="OpenFlow Configuration">
552 <column name="controller">
554 OpenFlow controller set. If unset, then no OpenFlow controllers
559 If there are primary controllers, removing all of them clears the
560 flow table. If there are no primary controllers, adding one also
561 clears the flow table. Other changes to the set of controllers, such
562 as adding or removing a service controller, adding another primary
563 controller to supplement an existing primary controller, or removing
564 only one of two primary controllers, have no effect on the flow
569 <column name="flow_tables">
570 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
571 table ID to configuration for that table.
574 <column name="fail_mode">
575 <p>When a controller is configured, it is, ordinarily, responsible
576 for setting up all flows on the switch. Thus, if the connection to
577 the controller fails, no new network connections can be set up.
578 If the connection to the controller stays down long enough,
579 no packets can pass through the switch at all. This setting
580 determines the switch's response to such a situation. It may be set
581 to one of the following:
583 <dt><code>standalone</code></dt>
584 <dd>If no message is received from the controller for three
585 times the inactivity probe interval
586 (see <ref column="inactivity_probe"/>), then Open vSwitch
587 will take over responsibility for setting up flows. In
588 this mode, Open vSwitch causes the bridge to act like an
589 ordinary MAC-learning switch. Open vSwitch will continue
590 to retry connecting to the controller in the background
591 and, when the connection succeeds, it will discontinue its
592 standalone behavior.</dd>
593 <dt><code>secure</code></dt>
594 <dd>Open vSwitch will not set up flows on its own when the
595 controller connection fails or when no controllers are
596 defined. The bridge will continue to retry connecting to
597 any defined controllers forever.</dd>
601 The default is <code>standalone</code> if the value is unset, but
602 future versions of Open vSwitch may change the default.
605 The <code>standalone</code> mode can create forwarding loops on a
606 bridge that has more than one uplink port unless STP is enabled. To
607 avoid loops on such a bridge, configure <code>secure</code> mode or
608 enable STP (see <ref column="stp_enable"/>).
610 <p>When more than one controller is configured,
611 <ref column="fail_mode"/> is considered only when none of the
612 configured controllers can be contacted.</p>
614 Changing <ref column="fail_mode"/> when no primary controllers are
615 configured clears the flow table.
619 <column name="datapath_id">
620 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
621 (Setting this column has no useful effect. Set <ref
622 column="other-config" key="datapath-id"/> instead.)
625 <column name="datapath_version">
627 Reports the version number of the Open vSwitch datapath in use.
628 This allows management software to detect and report discrepancies
629 between Open vSwitch userspace and datapath versions. (The <ref
630 column="ovs_version" table="Open_vSwitch"/> column in the <ref
631 table="Open_vSwitch"/> reports the Open vSwitch userspace version.)
632 The version reported depends on the datapath in use:
637 When the kernel module included in the Open vSwitch source tree is
638 used, this column reports the Open vSwitch version from which the
643 When the kernel module that is part of the upstream Linux kernel is
644 used, this column reports <code><unknown></code>.
648 When the datapath is built into the <code>ovs-vswitchd</code>
649 binary, this column reports <code><built-in></code>. A
650 built-in datapath is by definition the same version as the rest of
651 the Open VSwitch userspace.
655 Other datapaths (such as the Hyper-V kernel datapath) currently
656 report <code><unknown></code>.
661 A version discrepancy between <code>ovs-vswitchd</code> and the
662 datapath in use is not normally cause for alarm. The Open vSwitch
663 kernel datapaths for Linux and Hyper-V, in particular, are designed
664 for maximum inter-version compatibility: any userspace version works
665 with with any kernel version. Some reasons do exist to insist on
666 particular user/kernel pairings. First, newer kernel versions add
667 new features, that can only be used by new-enough userspace, e.g.
668 VXLAN tunneling requires certain minimal userspace and kernel
669 versions. Second, as an extension to the first reason, some newer
670 kernel versions add new features for enhancing performance that only
671 new-enough userspace versions can take advantage of.
675 <column name="other_config" key="datapath-id">
676 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
677 value. May not be all-zero.
680 <column name="other_config" key="dp-desc">
681 Human readable description of datapath. It it a maximum 256
682 byte-long free-form string to describe the datapath for
683 debugging purposes, e.g. <code>switch3 in room 3120</code>.
686 <column name="other_config" key="disable-in-band"
687 type='{"type": "boolean"}'>
688 If set to <code>true</code>, disable in-band control on the bridge
689 regardless of controller and manager settings.
692 <column name="other_config" key="in-band-queue"
693 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
694 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
695 that will be used by flows set up by in-band control on this bridge.
696 If unset, or if the port used by an in-band control flow does not have
697 QoS configured, or if the port does not have a queue with the specified
698 ID, the default queue is used instead.
701 <column name="protocols">
703 List of OpenFlow protocols that may be used when negotiating
704 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
705 1.3 are enabled by default if this column is empty.
709 OpenFlow 1.4 is not enabled by default because its implementation is
714 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
715 experimental because the OpenFlow 1.5 specification is still under
716 development and thus subject to change. Pass
717 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
718 OpenFlow 1.5 to be enabled.
723 <group title="Spanning Tree Configuration">
725 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
726 that ensures loop-free topologies. It allows redundant links to
727 be included in the network to provide automatic backup paths if
728 the active links fails.
732 These settings configure the slower-to-converge but still widely
733 supported version of Spanning Tree Protocol, sometimes known as
734 802.1D-1998. Open vSwitch also supports the newer Rapid Spanning Tree
735 Protocol (RSTP), documented later in the section titled <code>Rapid
736 Spanning Tree Configuration</code>.
739 <group title="STP Configuration">
740 <column name="stp_enable" type='{"type": "boolean"}'>
742 Enable spanning tree on the bridge. By default, STP is disabled
743 on bridges. Bond, internal, and mirror ports are not supported
744 and will not participate in the spanning tree.
748 STP and RSTP are mutually exclusive. If both are enabled, RSTP
753 <column name="other_config" key="stp-system-id">
754 The bridge's STP identifier (the lower 48 bits of the bridge-id)
756 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
757 By default, the identifier is the MAC address of the bridge.
760 <column name="other_config" key="stp-priority"
761 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
762 The bridge's relative priority value for determining the root
763 bridge (the upper 16 bits of the bridge-id). A bridge with the
764 lowest bridge-id is elected the root. By default, the priority
768 <column name="other_config" key="stp-hello-time"
769 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
770 The interval between transmissions of hello messages by
771 designated ports, in seconds. By default the hello interval is
775 <column name="other_config" key="stp-max-age"
776 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
777 The maximum age of the information transmitted by the bridge
778 when it is the root bridge, in seconds. By default, the maximum
782 <column name="other_config" key="stp-forward-delay"
783 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
784 The delay to wait between transitioning root and designated
785 ports to <code>forwarding</code>, in seconds. By default, the
786 forwarding delay is 15 seconds.
789 <column name="other_config" key="mcast-snooping-aging-time"
790 type='{"type": "integer", "minInteger": 1}'>
792 The maximum number of seconds to retain a multicast snooping entry for
793 which no packets have been seen. The default is currently 300
794 seconds (5 minutes). The value, if specified, is forced into a
795 reasonable range, currently 15 to 3600 seconds.
799 <column name="other_config" key="mcast-snooping-table-size"
800 type='{"type": "integer", "minInteger": 1}'>
802 The maximum number of multicast snooping addresses to learn. The
803 default is currently 2048. The value, if specified, is forced into
804 a reasonable range, currently 10 to 1,000,000.
807 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
808 type='{"type": "boolean"}'>
810 If set to <code>false</code>, unregistered multicast packets are forwarded
812 If set to <code>true</code>, unregistered multicast packets are forwarded
813 to ports connected to multicast routers.
818 <group title="STP Status">
820 These key-value pairs report the status of 802.1D-1998. They are
821 present only if STP is enabled (via the <ref column="stp_enable"/>
824 <column name="status" key="stp_bridge_id">
825 The bridge ID used in spanning tree advertisements, in the form
826 <var>xxxx</var>.<var>yyyyyyyyyyyy</var> where the <var>x</var>s are
827 the STP priority, the <var>y</var>s are the STP system ID, and each
828 <var>x</var> and <var>y</var> is a hex digit.
830 <column name="status" key="stp_designated_root">
831 The designated root for this spanning tree, in the same form as <ref
832 column="status" key="stp_bridge_id"/>. If this bridge is the root,
833 this will have the same value as <ref column="status"
834 key="stp_bridge_id"/>, otherwise it will differ.
836 <column name="status" key="stp_root_path_cost">
837 The path cost of reaching the designated bridge. A lower number is
838 better. The value is 0 if this bridge is the root, otherwise it is
844 <group title="Rapid Spanning Tree">
846 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
847 that ensures loop-free topologies. RSTP superseded STP with the
848 publication of 802.1D-2004. Compared to STP, RSTP converges more
849 quickly and recovers more quickly from failures.
852 <group title="RSTP Configuration">
853 <column name="rstp_enable" type='{"type": "boolean"}'>
855 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
856 on bridges. Bond, internal, and mirror ports are not supported
857 and will not participate in the spanning tree.
861 STP and RSTP are mutually exclusive. If both are enabled, RSTP
866 <column name="other_config" key="rstp-address">
867 The bridge's RSTP address (the lower 48 bits of the bridge-id)
869 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
870 By default, the address is the MAC address of the bridge.
873 <column name="other_config" key="rstp-priority"
874 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
875 The bridge's relative priority value for determining the root
876 bridge (the upper 16 bits of the bridge-id). A bridge with the
877 lowest bridge-id is elected the root. By default, the priority
878 is 0x8000 (32768). This value needs to be a multiple of 4096,
879 otherwise it's rounded to the nearest inferior one.
882 <column name="other_config" key="rstp-ageing-time"
883 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
884 The Ageing Time parameter for the Bridge. The default value
888 <column name="other_config" key="rstp-force-protocol-version"
889 type='{"type": "integer"}'>
890 The Force Protocol Version parameter for the Bridge. This
891 can take the value 0 (STP Compatibility mode) or 2
892 (the default, normal operation).
895 <column name="other_config" key="rstp-max-age"
896 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
897 The maximum age of the information transmitted by the Bridge
898 when it is the Root Bridge. The default value is 20.
901 <column name="other_config" key="rstp-forward-delay"
902 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
903 The delay used by STP Bridges to transition Root and Designated
904 Ports to Forwarding. The default value is 15.
907 <column name="other_config" key="rstp-transmit-hold-count"
908 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
909 The Transmit Hold Count used by the Port Transmit state machine
910 to limit transmission rate. The default value is 6.
914 <group title="RSTP Status">
916 These key-value pairs report the status of 802.1D-2004. They are
917 present only if RSTP is enabled (via the <ref column="rstp_enable"/>
920 <column name="rstp_status" key="rstp_bridge_id">
921 The bridge ID used in rapid spanning tree advertisements, in the form
922 <var>x</var>.<var>yyy</var>.<var>zzzzzzzzzzzz</var> where
923 <var>x</var> is the RSTP priority, the <var>y</var>s are a locally
924 assigned system ID extension, the <var>z</var>s are the STP system
925 ID, and each <var>x</var>, <var>y</var>, or <var>z</var> is a hex
928 <column name="rstp_status" key="rstp_root_id">
929 The root of this spanning tree, in the same form as <ref
930 column="rstp_status" key="rstp_bridge_id"/>. If this bridge is the
931 root, this will have the same value as <ref column="rstp_status"
932 key="rstp_bridge_id"/>, otherwise it will differ.
934 <column name="rstp_status" key="rstp_root_path_cost"
935 type='{"type": "integer", "minInteger": 0}'>
936 The path cost of reaching the root. A lower number is better. The
937 value is 0 if this bridge is the root, otherwise it is higher.
939 <column name="rstp_status" key="rstp_designated_id">
940 The RSTP designated ID, in the same form as <ref column="rstp_status"
941 key="rstp_bridge_id"/>.
943 <column name="rstp_status" key="rstp_designated_port_id">
944 The RSTP designated port ID, as a 4-digit hex number.
946 <column name="rstp_status" key="rstp_bridge_port_id">
947 The RSTP bridge port ID, as a 4-digit hex number.
952 <group title="Multicast Snooping Configuration">
953 Multicast snooping (RFC 4541) monitors the Internet Group Management
954 Protocol (IGMP) and Multicast Listener Discovery traffic between hosts
955 and multicast routers. The switch uses what IGMP and MLD snooping
956 learns to forward multicast traffic only to interfaces that are connected
957 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
958 MLDv1 and MLDv2 protocols.
960 <column name="mcast_snooping_enable">
961 Enable multicast snooping on the bridge. For now, the default
966 <group title="Other Features">
967 <column name="datapath_type">
968 Name of datapath provider. The kernel datapath has type
969 <code>system</code>. The userspace datapath has type
970 <code>netdev</code>. A manager may refer to the <ref
971 table="Open_vSwitch" column="datapath_types"/> column of the <ref
972 table="Open_vSwitch"/> table for a list of the types accepted by this
973 Open vSwitch instance.
976 <column name="external_ids" key="bridge-id">
977 A unique identifier of the bridge. On Citrix XenServer this will
978 commonly be the same as
979 <ref column="external_ids" key="xs-network-uuids"/>.
982 <column name="external_ids" key="xs-network-uuids">
983 Semicolon-delimited set of universally unique identifier(s) for the
984 network with which this bridge is associated on a Citrix XenServer
985 host. The network identifiers are RFC 4122 UUIDs as displayed by,
986 e.g., <code>xe network-list</code>.
989 <column name="other_config" key="hwaddr">
990 An Ethernet address in the form
991 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
992 to set the hardware address of the local port and influence the
996 <column name="other_config" key="forward-bpdu"
997 type='{"type": "boolean"}'>
1000 Controls forwarding of BPDUs and other network control frames when
1001 NORMAL action is invoked. When this option is <code>false</code> or
1002 unset, frames with reserved Ethernet addresses (see table below) will
1003 not be forwarded. When this option is <code>true</code>, such frames
1004 will not be treated specially.
1008 The above general rule has the following exceptions:
1013 If STP is enabled on the bridge (see the <ref column="stp_enable"
1014 table="Bridge"/> column in the <ref table="Bridge"/> table), the
1015 bridge processes all received STP packets and never passes them to
1016 OpenFlow or forwards them. This is true even if STP is disabled on
1021 If LLDP is enabled on an interface (see the <ref column="lldp"
1022 table="Interface"/> column in the <ref table="Interface"/> table),
1023 the interface processes received LLDP packets and never passes them
1024 to OpenFlow or forwards them.
1029 Set this option to <code>true</code> if the Open vSwitch bridge
1030 connects different Ethernet networks and is not configured to
1035 This option affects packets with the following destination MAC
1040 <dt><code>01:80:c2:00:00:00</code></dt>
1041 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1043 <dt><code>01:80:c2:00:00:01</code></dt>
1044 <dd>IEEE Pause frame.</dd>
1046 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1047 <dd>Other reserved protocols.</dd>
1049 <dt><code>00:e0:2b:00:00:00</code></dt>
1050 <dd>Extreme Discovery Protocol (EDP).</dd>
1053 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
1055 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
1057 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1059 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1060 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1064 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1065 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1067 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1068 <dd>Cisco STP Uplink Fast.</dd>
1070 <dt><code>01:00:0c:00:00:00</code></dt>
1071 <dd>Cisco Inter Switch Link.</dd>
1073 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
1078 <column name="other_config" key="mac-aging-time"
1079 type='{"type": "integer", "minInteger": 1}'>
1081 The maximum number of seconds to retain a MAC learning entry for
1082 which no packets have been seen. The default is currently 300
1083 seconds (5 minutes). The value, if specified, is forced into a
1084 reasonable range, currently 15 to 3600 seconds.
1088 A short MAC aging time allows a network to more quickly detect that a
1089 host is no longer connected to a switch port. However, it also makes
1090 it more likely that packets will be flooded unnecessarily, when they
1091 are addressed to a connected host that rarely transmits packets. To
1092 reduce the incidence of unnecessary flooding, use a MAC aging time
1093 longer than the maximum interval at which a host will ordinarily
1098 <column name="other_config" key="mac-table-size"
1099 type='{"type": "integer", "minInteger": 1}'>
1101 The maximum number of MAC addresses to learn. The default is
1102 currently 2048. The value, if specified, is forced into a reasonable
1103 range, currently 10 to 1,000,000.
1108 <group title="Common Columns">
1109 The overall purpose of these columns is described under <code>Common
1110 Columns</code> at the beginning of this document.
1112 <column name="other_config"/>
1113 <column name="external_ids"/>
1117 <table name="Port" table="Port or bond configuration.">
1118 <p>A port within a <ref table="Bridge"/>.</p>
1119 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1120 <ref column="interfaces"/> column. Such a port logically
1121 corresponds to a port on a physical Ethernet switch. A port
1122 with more than one interface is a ``bonded port'' (see
1123 <ref group="Bonding Configuration"/>).</p>
1124 <p>Some properties that one might think as belonging to a port are actually
1125 part of the port's <ref table="Interface"/> members.</p>
1127 <column name="name">
1128 Port name. Should be alphanumeric and no more than about 8
1129 bytes long. May be the same as the interface name, for
1130 non-bonded ports. Must otherwise be unique among the names of
1131 ports, interfaces, and bridges on a host.
1134 <column name="interfaces">
1135 The port's interfaces. If there is more than one, this is a
1139 <group title="VLAN Configuration">
1140 <p>Bridge ports support the following types of VLAN configuration:</p>
1145 A trunk port carries packets on one or more specified VLANs
1146 specified in the <ref column="trunks"/> column (often, on every
1147 VLAN). A packet that ingresses on a trunk port is in the VLAN
1148 specified in its 802.1Q header, or VLAN 0 if the packet has no
1149 802.1Q header. A packet that egresses through a trunk port will
1150 have an 802.1Q header if it has a nonzero VLAN ID.
1154 Any packet that ingresses on a trunk port tagged with a VLAN that
1155 the port does not trunk is dropped.
1162 An access port carries packets on exactly one VLAN specified in the
1163 <ref column="tag"/> column. Packets egressing on an access port
1164 have no 802.1Q header.
1168 Any packet with an 802.1Q header with a nonzero VLAN ID that
1169 ingresses on an access port is dropped, regardless of whether the
1170 VLAN ID in the header is the access port's VLAN ID.
1174 <dt>native-tagged</dt>
1176 A native-tagged port resembles a trunk port, with the exception that
1177 a packet without an 802.1Q header that ingresses on a native-tagged
1178 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1182 <dt>native-untagged</dt>
1184 A native-untagged port resembles a native-tagged port, with the
1185 exception that a packet that egresses on a native-untagged port in
1186 the native VLAN will not have an 802.1Q header.
1190 A packet will only egress through bridge ports that carry the VLAN of
1191 the packet, as described by the rules above.
1194 <column name="vlan_mode">
1196 The VLAN mode of the port, as described above. When this column is
1197 empty, a default mode is selected as follows:
1201 If <ref column="tag"/> contains a value, the port is an access
1202 port. The <ref column="trunks"/> column should be empty.
1205 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1206 column value is honored if it is present.
1213 For an access port, the port's implicitly tagged VLAN. For a
1214 native-tagged or native-untagged port, the port's native VLAN. Must
1215 be empty if this is a trunk port.
1219 <column name="trunks">
1221 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1222 or VLANs that this port trunks; if it is empty, then the port trunks
1223 all VLANs. Must be empty if this is an access port.
1226 A native-tagged or native-untagged port always trunks its native
1227 VLAN, regardless of whether <ref column="trunks"/> includes that
1232 <column name="other_config" key="priority-tags"
1233 type='{"type": "boolean"}'>
1235 An 802.1Q header contains two important pieces of information: a VLAN
1236 ID and a priority. A frame with a zero VLAN ID, called a
1237 ``priority-tagged'' frame, is supposed to be treated the same way as
1238 a frame without an 802.1Q header at all (except for the priority).
1242 However, some network elements ignore any frame that has 802.1Q
1243 header at all, even when the VLAN ID is zero. Therefore, by default
1244 Open vSwitch does not output priority-tagged frames, instead omitting
1245 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1246 <code>true</code> to enable priority-tagged frames on a port.
1250 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1251 output if both the VLAN ID and priority would be zero.
1255 All frames output to native-tagged ports have a nonzero VLAN ID, so
1256 this setting is not meaningful on native-tagged ports.
1261 <group title="Bonding Configuration">
1262 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1263 allows for load balancing and fail-over.</p>
1266 The following types of bonding will work with any kind of upstream
1267 switch. On the upstream switch, do not configure the interfaces as a
1272 <dt><code>balance-slb</code></dt>
1274 Balances flows among slaves based on source MAC address and output
1275 VLAN, with periodic rebalancing as traffic patterns change.
1278 <dt><code>active-backup</code></dt>
1280 Assigns all flows to one slave, failing over to a backup slave when
1281 the active slave is disabled. This is the only bonding mode in which
1282 interfaces may be plugged into different upstream switches.
1287 The following modes require the upstream switch to support 802.3ad with
1288 successful LACP negotiation. If LACP negotiation fails and
1289 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1294 <dt><code>balance-tcp</code></dt>
1296 Balances flows among slaves based on L2, L3, and L4 protocol
1297 information such as destination MAC address, IP address, and TCP
1302 <p>These columns apply only to bonded ports. Their values are
1303 otherwise ignored.</p>
1305 <column name="bond_mode">
1306 <p>The type of bonding used for a bonded port. Defaults to
1307 <code>active-backup</code> if unset.
1311 <column name="other_config" key="bond-hash-basis"
1312 type='{"type": "integer"}'>
1313 An integer hashed along with flows when choosing output slaves in load
1314 balanced bonds. When changed, all flows will be assigned different
1315 hash values possibly causing slave selection decisions to change. Does
1316 not affect bonding modes which do not employ load balancing such as
1317 <code>active-backup</code>.
1320 <group title="Link Failure Detection">
1322 An important part of link bonding is detecting that links are down so
1323 that they may be disabled. These settings determine how Open vSwitch
1324 detects link failure.
1327 <column name="other_config" key="bond-detect-mode"
1328 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1329 The means used to detect link failures. Defaults to
1330 <code>carrier</code> which uses each interface's carrier to detect
1331 failures. When set to <code>miimon</code>, will check for failures
1332 by polling each interface's MII.
1335 <column name="other_config" key="bond-miimon-interval"
1336 type='{"type": "integer"}'>
1337 The interval, in milliseconds, between successive attempts to poll
1338 each interface's MII. Relevant only when <ref column="other_config"
1339 key="bond-detect-mode"/> is <code>miimon</code>.
1342 <column name="bond_updelay">
1344 The number of milliseconds for which the link must stay up on an
1345 interface before the interface is considered to be up. Specify
1346 <code>0</code> to enable the interface immediately.
1350 This setting is honored only when at least one bonded interface is
1351 already enabled. When no interfaces are enabled, then the first
1352 bond interface to come up is enabled immediately.
1356 <column name="bond_downdelay">
1357 The number of milliseconds for which the link must stay down on an
1358 interface before the interface is considered to be down. Specify
1359 <code>0</code> to disable the interface immediately.
1363 <group title="LACP Configuration">
1365 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1366 allows switches to automatically detect that they are connected by
1367 multiple links and aggregate across those links. These settings
1368 control LACP behavior.
1371 <column name="lacp">
1372 Configures LACP on this port. LACP allows directly connected
1373 switches to negotiate which links may be bonded. LACP may be enabled
1374 on non-bonded ports for the benefit of any switches they may be
1375 connected to. <code>active</code> ports are allowed to initiate LACP
1376 negotiations. <code>passive</code> ports are allowed to participate
1377 in LACP negotiations initiated by a remote switch, but not allowed to
1378 initiate such negotiations themselves. If LACP is enabled on a port
1379 whose partner switch does not support LACP, the bond will be
1380 disabled, unless other-config:lacp-fallback-ab is set to true.
1381 Defaults to <code>off</code> if unset.
1384 <column name="other_config" key="lacp-system-id">
1385 The LACP system ID of this <ref table="Port"/>. The system ID of a
1386 LACP bond is used to identify itself to its partners. Must be a
1387 nonzero MAC address. Defaults to the bridge Ethernet address if
1391 <column name="other_config" key="lacp-system-priority"
1392 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1393 The LACP system priority of this <ref table="Port"/>. In LACP
1394 negotiations, link status decisions are made by the system with the
1395 numerically lower priority.
1398 <column name="other_config" key="lacp-time"
1399 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1401 The LACP timing which should be used on this <ref table="Port"/>.
1402 By default <code>slow</code> is used. When configured to be
1403 <code>fast</code> LACP heartbeats are requested at a rate of once
1404 per second causing connectivity problems to be detected more
1405 quickly. In <code>slow</code> mode, heartbeats are requested at a
1406 rate of once every 30 seconds.
1410 <column name="other_config" key="lacp-fallback-ab"
1411 type='{"type": "boolean"}'>
1413 Determines the behavior of openvswitch bond in LACP mode. If
1414 the partner switch does not support LACP, setting this option
1415 to <code>true</code> allows openvswitch to fallback to
1416 active-backup. If the option is set to <code>false</code>, the
1417 bond will be disabled. In both the cases, once the partner switch
1418 is configured to LACP mode, the bond will use LACP.
1423 <group title="Rebalancing Configuration">
1425 These settings control behavior when a bond is in
1426 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1429 <column name="other_config" key="bond-rebalance-interval"
1430 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1431 For a load balanced bonded port, the number of milliseconds between
1432 successive attempts to rebalance the bond, that is, to move flows
1433 from one interface on the bond to another in an attempt to keep usage
1434 of each interface roughly equal. If zero, load balancing is disabled
1435 on the bond (link failure still cause flows to move). If
1436 less than 1000ms, the rebalance interval will be 1000ms.
1440 <column name="bond_fake_iface">
1441 For a bonded port, whether to create a fake internal interface with the
1442 name of the port. Use only for compatibility with legacy software that
1447 <group title="Spanning Tree Protocol">
1449 The configuration here is only meaningful, and the status is only
1450 populated, when 802.1D-1998 Spanning Tree Protocol is enabled on the
1451 port's <ref column="Bridge"/> with its <ref column="stp_enable"/>
1455 <group title="STP Configuration">
1456 <column name="other_config" key="stp-enable"
1457 type='{"type": "boolean"}'>
1458 When STP is enabled on a bridge, it is enabled by default on all of
1459 the bridge's ports except bond, internal, and mirror ports (which do
1460 not work with STP). If this column's value is <code>false</code>,
1461 STP is disabled on the port.
1464 <column name="other_config" key="stp-port-num"
1465 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1466 The port number used for the lower 8 bits of the port-id. By
1467 default, the numbers will be assigned automatically. If any
1468 port's number is manually configured on a bridge, then they
1472 <column name="other_config" key="stp-port-priority"
1473 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1474 The port's relative priority value for determining the root
1475 port (the upper 8 bits of the port-id). A port with a lower
1476 port-id will be chosen as the root port. By default, the
1480 <column name="other_config" key="stp-path-cost"
1481 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1482 Spanning tree path cost for the port. A lower number indicates
1483 a faster link. By default, the cost is based on the maximum
1488 <group title="STP Status">
1489 <column name="status" key="stp_port_id">
1490 The port ID used in spanning tree advertisements for this port, as 4
1491 hex digits. Configuring the port ID is described in the
1492 <code>stp-port-num</code> and <code>stp-port-priority</code> keys of
1493 the <code>other_config</code> section earlier.
1495 <column name="status" key="stp_state"
1496 type='{"type": "string", "enum": ["set",
1497 ["disabled", "listening", "learning",
1498 "forwarding", "blocking"]]}'>
1499 STP state of the port.
1501 <column name="status" key="stp_sec_in_state"
1502 type='{"type": "integer", "minInteger": 0}'>
1503 The amount of time this port has been in the current STP state, in
1506 <column name="status" key="stp_role"
1507 type='{"type": "string", "enum": ["set",
1508 ["root", "designated", "alternate"]]}'>
1509 STP role of the port.
1514 <group title="Rapid Spanning Tree Protocol">
1516 The configuration here is only meaningful, and the status and
1517 statistics are only populated, when 802.1D-1998 Spanning Tree Protocol
1518 is enabled on the port's <ref column="Bridge"/> with its <ref
1519 column="stp_enable"/> column.
1522 <group title="RSTP Configuration">
1523 <column name="other_config" key="rstp-enable"
1524 type='{"type": "boolean"}'>
1525 When RSTP is enabled on a bridge, it is enabled by default on all of
1526 the bridge's ports except bond, internal, and mirror ports (which do
1527 not work with RSTP). If this column's value is <code>false</code>,
1528 RSTP is disabled on the port.
1531 <column name="other_config" key="rstp-port-priority"
1532 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1533 The port's relative priority value for determining the root port, in
1534 multiples of 16. By default, the port priority is 0x80 (128). Any
1535 value in the lower 4 bits is rounded off. The significant upper 4
1536 bits become the upper 4 bits of the port-id. A port with the lowest
1537 port-id is elected as the root.
1540 <column name="other_config" key="rstp-port-num"
1541 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1542 The local RSTP port number, used as the lower 12 bits of the port-id.
1543 By default the port numbers are assigned automatically, and typically
1544 may not correspond to the OpenFlow port numbers. A port with the
1545 lowest port-id is elected as the root.
1548 <column name="other_config" key="rstp-port-path-cost"
1549 type='{"type": "integer"}'>
1550 The port path cost. The Port's contribution, when it is
1551 the Root Port, to the Root Path Cost for the Bridge. By default the
1552 cost is automatically calculated from the port's speed.
1555 <column name="other_config" key="rstp-port-admin-edge"
1556 type='{"type": "boolean"}'>
1557 The admin edge port parameter for the Port. Default is
1561 <column name="other_config" key="rstp-port-auto-edge"
1562 type='{"type": "boolean"}'>
1563 The auto edge port parameter for the Port. Default is
1567 <column name="other_config" key="rstp-port-mcheck"
1568 type='{"type": "boolean"}'>
1570 The mcheck port parameter for the Port. Default is
1571 <code>false</code>. May be set to force the Port Protocol
1572 Migration state machine to transmit RST BPDUs for a
1573 MigrateTime period, to test whether all STP Bridges on the
1574 attached LAN have been removed and the Port can continue to
1575 transmit RSTP BPDUs. Setting mcheck has no effect if the
1576 Bridge is operating in STP Compatibility mode.
1579 Changing the value from <code>true</code> to
1580 <code>false</code> has no effect, but needs to be done if
1581 this behavior is to be triggered again by subsequently
1582 changing the value from <code>false</code> to
1588 <group title="RSTP Status">
1589 <column name="rstp_status" key="rstp_port_id">
1590 The port ID used in spanning tree advertisements for this port, as 4
1591 hex digits. Configuring the port ID is described in the
1592 <code>rstp-port-num</code> and <code>rstp-port-priority</code> keys
1593 of the <code>other_config</code> section earlier.
1595 <column name="rstp_status" key="rstp_port_role"
1596 type='{"type": "string", "enum": ["set",
1597 ["Root", "Designated", "Alternate", "Backup", "Disabled"]]}'>
1598 RSTP role of the port.
1600 <column name="rstp_status" key="rstp_port_state"
1601 type='{"type": "string", "enum": ["set",
1602 ["Disabled", "Learning", "Forwarding", "Discarding"]]}'>
1603 RSTP state of the port.
1605 <column name="rstp_status" key="rstp_designated_bridge_id">
1606 The port's RSTP designated bridge ID, in the same form as <ref
1607 column="rstp_status" key="rstp_bridge_id"/> in the <ref
1608 table="Bridge"/> table.
1610 <column name="rstp_status" key="rstp_designated_port_id">
1611 The port's RSTP designated port ID, as 4 hex digits.
1613 <column name="rstp_status" key="rstp_designated_path_cost"
1614 type='{"type": "integer"}'>
1615 The port's RSTP designated path cost. Lower is better.
1619 <group title="RSTP Statistics">
1620 <column name="rstp_statistics" key="rstp_tx_count">
1621 Number of RSTP BPDUs transmitted through this port.
1623 <column name="rstp_statistics" key="rstp_rx_count">
1624 Number of valid RSTP BPDUs received by this port.
1626 <column name="rstp_statistics" key="rstp_error_count">
1627 Number of invalid RSTP BPDUs received by this port.
1629 <column name="rstp_statistics" key="rstp_uptime">
1630 The duration covered by the other RSTP statistics, in seconds.
1635 <group title="Multicast Snooping">
1636 <column name="other_config" key="mcast-snooping-flood"
1637 type='{"type": "boolean"}'>
1639 If set to <code>true</code>, multicast packets (except Reports) are
1640 unconditionally forwarded to the specific port.
1643 <column name="other_config" key="mcast-snooping-flood-reports"
1644 type='{"type": "boolean"}'>
1646 If set to <code>true</code>, multicast Reports are unconditionally
1647 forwarded to the specific port.
1652 <group title="Other Features">
1654 Quality of Service configuration for this port.
1658 The MAC address to use for this port for the purpose of choosing the
1659 bridge's MAC address. This column does not necessarily reflect the
1660 port's actual MAC address, nor will setting it change the port's actual
1664 <column name="fake_bridge">
1665 Does this port represent a sub-bridge for its tagged VLAN within the
1666 Bridge? See ovs-vsctl(8) for more information.
1669 <column name="external_ids" key="fake-bridge-id-*">
1670 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1671 column) are defined by prefixing a <ref table="Bridge"/> <ref
1672 table="Bridge" column="external_ids"/> key with
1673 <code>fake-bridge-</code>,
1674 e.g. <code>fake-bridge-xs-network-uuids</code>.
1677 <column name="other_config" key="transient"
1678 type='{"type": "boolean"}'>
1680 If set to <code>true</code>, the port will be removed when
1681 <code>ovs-ctl start --delete-transient-ports</code> is used.
1686 <column name="bond_active_slave">
1687 For a bonded port, record the mac address of the current active slave.
1690 <group title="Port Statistics">
1692 Key-value pairs that report port statistics. The update period
1693 is controlled by <ref column="other_config"
1694 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1696 <group title="Statistics: STP transmit and receive counters">
1697 <column name="statistics" key="stp_tx_count">
1698 Number of STP BPDUs sent on this port by the spanning
1701 <column name="statistics" key="stp_rx_count">
1702 Number of STP BPDUs received on this port and accepted by the
1703 spanning tree library.
1705 <column name="statistics" key="stp_error_count">
1706 Number of bad STP BPDUs received on this port. Bad BPDUs
1707 include runt packets and those with an unexpected protocol ID.
1712 <group title="Common Columns">
1713 The overall purpose of these columns is described under <code>Common
1714 Columns</code> at the beginning of this document.
1716 <column name="other_config"/>
1717 <column name="external_ids"/>
1721 <table name="Interface" title="One physical network device in a Port.">
1722 An interface within a <ref table="Port"/>.
1724 <group title="Core Features">
1725 <column name="name">
1726 Interface name. Should be alphanumeric and no more than about 8 bytes
1727 long. May be the same as the port name, for non-bonded ports. Must
1728 otherwise be unique among the names of ports, interfaces, and bridges
1732 <column name="ifindex">
1733 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1734 2863, if the interface has one, otherwise 0. The ifindex is useful for
1735 seamless integration with protocols such as SNMP and sFlow.
1738 <column name="mac_in_use">
1739 The MAC address in use by this interface.
1743 <p>Ethernet address to set for this interface. If unset then the
1744 default MAC address is used:</p>
1746 <li>For the local interface, the default is the lowest-numbered MAC
1747 address among the other bridge ports, either the value of the
1748 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1749 if set, or its actual MAC (for bonded ports, the MAC of its slave
1750 whose name is first in alphabetical order). Internal ports and
1751 bridge ports that are used as port mirroring destinations (see the
1752 <ref table="Mirror"/> table) are ignored.</li>
1753 <li>For other internal interfaces, the default MAC is randomly
1755 <li>External interfaces typically have a MAC address associated with
1756 their hardware.</li>
1758 <p>Some interfaces may not have a software-controllable MAC
1762 <column name="error">
1763 If the configuration of the port failed, as indicated by -1 in <ref
1764 column="ofport"/>, Open vSwitch sets this column to an error
1765 description in human readable form. Otherwise, Open vSwitch clears
1769 <group title="OpenFlow Port Number">
1771 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1772 port number for the new port. If the client that adds the port fills
1773 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1774 value as the OpenFlow port number. Otherwise, or if the requested
1775 port number is already in use or cannot be used for another reason,
1776 Open vSwitch automatically assigns a free port number. Regardless of
1777 how the port number was obtained, Open vSwitch then reports in <ref
1778 column="ofport"/> the port number actually assigned.
1782 Open vSwitch limits the port numbers that it automatically assigns to
1783 the range 1 through 32,767, inclusive. Controllers therefore have
1784 free use of ports 32,768 and up.
1787 <column name="ofport">
1789 OpenFlow port number for this interface. Open vSwitch sets this
1790 column's value, so other clients should treat it as read-only.
1793 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1794 The other valid port numbers are in the range 1 to 65,279,
1795 inclusive. Value -1 indicates an error adding the interface.
1799 <column name="ofport_request"
1800 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1802 Requested OpenFlow port number for this interface.
1806 A client should ideally set this column's value in the same
1807 database transaction that it uses to create the interface. Open
1808 vSwitch version 2.1 and later will honor a later request for a
1809 specific port number, althuogh it might confuse some controllers:
1810 OpenFlow does not have a way to announce a port number change, so
1811 Open vSwitch represents it over OpenFlow as a port deletion
1812 followed immediately by a port addition.
1816 If <ref column="ofport_request"/> is set or changed to some other
1817 port's automatically assigned port number, Open vSwitch chooses a
1818 new port number for the latter port.
1824 <group title="System-Specific Details">
1825 <column name="type">
1827 The interface type. The types supported by a particular instance of
1828 Open vSwitch are listed in the <ref table="Open_vSwitch"
1829 column="iface_types"/> column in the <ref table="Open_vSwitch"/>
1830 table. The following types are defined:
1834 <dt><code>system</code></dt>
1835 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1836 Sometimes referred to as ``external interfaces'' since they are
1837 generally connected to hardware external to that on which the Open
1838 vSwitch is running. The empty string is a synonym for
1839 <code>system</code>.</dd>
1841 <dt><code>internal</code></dt>
1842 <dd>A simulated network device that sends and receives traffic. An
1843 internal interface whose <ref column="name"/> is the same as its
1844 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1845 ``local interface.'' It does not make sense to bond an internal
1846 interface, so the terms ``port'' and ``interface'' are often used
1847 imprecisely for internal interfaces.</dd>
1849 <dt><code>tap</code></dt>
1850 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1852 <dt><code>geneve</code></dt>
1854 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve-00</code>)
1857 A description of how to match and set Geneve options can be found
1858 in the <code>ovs-ofctl</code> manual page.
1861 <dt><code>gre</code></dt>
1863 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1867 <dt><code>ipsec_gre</code></dt>
1869 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1873 <dt><code>vxlan</code></dt>
1876 An Ethernet tunnel over the UDP-based VXLAN protocol described in
1880 Open vSwitch uses UDP destination port 4789. The source port used for
1881 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1886 <dt><code>lisp</code></dt>
1889 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1890 Separation Protocol (RFC 6830).
1893 Only IPv4 and IPv6 packets are supported by the protocol, and
1894 they are sent and received without an Ethernet header. Traffic
1895 to/from LISP ports is expected to be configured explicitly, and
1896 the ports are not intended to participate in learning based
1897 switching. As such, they are always excluded from packet
1902 <dt><code>stt</code></dt>
1904 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
1905 endpoints are in end-systems, as it utilizes the capabilities of
1906 standard network interface cards to improve performance. STT utilizes
1907 a TCP-like header inside the IP header. It is stateless, i.e., there is
1908 no TCP connection state of any kind associated with the tunnel. The
1909 TCP-like header is used to leverage the capabilities of existing
1910 network interface cards, but should not be interpreted as implying
1911 any sort of connection state between endpoints.
1912 Since the STT protocol does not engage in the usual TCP 3-way handshake,
1913 so it will have difficulty traversing stateful firewalls.
1914 The protocol is documented at
1915 http://www.ietf.org/archive/id/draft-davie-stt-06.txt
1917 All traffic uses a default destination port of 7471. STT is only
1918 available in kernel datapath on kernel 3.5 or newer.
1921 <dt><code>patch</code></dt>
1923 A pair of virtual devices that act as a patch cable.
1926 <dt><code>null</code></dt>
1927 <dd>An ignored interface. Deprecated and slated for removal in
1933 <group title="Tunnel Options">
1935 These options apply to interfaces with <ref column="type"/> of
1936 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1937 <code>vxlan</code>, <code>lisp</code> and <code>stt</code>.
1941 Each tunnel must be uniquely identified by the combination of <ref
1942 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1943 column="options" key="local_ip"/>, and <ref column="options"
1944 key="in_key"/>. If two ports are defined that are the same except one
1945 has an optional identifier and the other does not, the more specific
1946 one is matched first. <ref column="options" key="in_key"/> is
1947 considered more specific than <ref column="options" key="local_ip"/> if
1948 a port defines one and another port defines the other.
1951 <column name="options" key="remote_ip">
1952 <p>Required. The remote tunnel endpoint, one of:</p>
1956 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1957 Only unicast endpoints are supported.
1960 The word <code>flow</code>. The tunnel accepts packets from any
1961 remote tunnel endpoint. To process only packets from a specific
1962 remote tunnel endpoint, the flow entries may match on the
1963 <code>tun_src</code> field. When sending packets to a
1964 <code>remote_ip=flow</code> tunnel, the flow actions must
1965 explicitly set the <code>tun_dst</code> field to the IP address of
1966 the desired remote tunnel endpoint, e.g. with a
1967 <code>set_field</code> action.
1972 The remote tunnel endpoint for any packet received from a tunnel
1973 is available in the <code>tun_src</code> field for matching in the
1978 <column name="options" key="local_ip">
1980 Optional. The tunnel destination IP that received packets must
1981 match. Default is to match all addresses. If specified, may be one
1987 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1990 The word <code>flow</code>. The tunnel accepts packets sent to any
1991 of the local IP addresses of the system running OVS. To process
1992 only packets sent to a specific IP address, the flow entries may
1993 match on the <code>tun_dst</code> field. When sending packets to a
1994 <code>local_ip=flow</code> tunnel, the flow actions may
1995 explicitly set the <code>tun_src</code> field to the desired IP
1996 address, e.g. with a <code>set_field</code> action. However, while
1997 routing the tunneled packet out, the local system may override the
1998 specified address with the local IP address configured for the
1999 outgoing system interface.
2002 This option is valid only for tunnels also configured with the
2003 <code>remote_ip=flow</code> option.
2009 The tunnel destination IP address for any packet received from a
2010 tunnel is available in the <code>tun_dst</code> field for matching in
2015 <column name="options" key="in_key">
2016 <p>Optional. The key that received packets must contain, one of:</p>
2020 <code>0</code>. The tunnel receives packets with no key or with a
2021 key of 0. This is equivalent to specifying no <ref column="options"
2022 key="in_key"/> at all.
2025 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
2026 or 64-bit (for STT) number. The tunnel receives only
2027 packets with the specified key.
2030 The word <code>flow</code>. The tunnel accepts packets with any
2031 key. The key will be placed in the <code>tun_id</code> field for
2032 matching in the flow table. The <code>ovs-ofctl</code> manual page
2033 contains additional information about matching fields in OpenFlow
2042 <column name="options" key="out_key">
2043 <p>Optional. The key to be set on outgoing packets, one of:</p>
2047 <code>0</code>. Packets sent through the tunnel will have no key.
2048 This is equivalent to specifying no <ref column="options"
2049 key="out_key"/> at all.
2052 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
2053 64-bit (for STT) number. Packets sent through the tunnel
2054 will have the specified key.
2057 The word <code>flow</code>. Packets sent through the tunnel will
2058 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
2059 vendor extension (0 is used in the absence of an action). The
2060 <code>ovs-ofctl</code> manual page contains additional information
2061 about the Nicira OpenFlow vendor extensions.
2066 <column name="options" key="key">
2067 Optional. Shorthand to set <code>in_key</code> and
2068 <code>out_key</code> at the same time.
2071 <column name="options" key="tos">
2072 Optional. The value of the ToS bits to be set on the encapsulating
2073 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2074 zero. It may also be the word <code>inherit</code>, in which case
2075 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2076 (otherwise it will be 0). The ECN fields are always inherited.
2080 <column name="options" key="ttl">
2081 Optional. The TTL to be set on the encapsulating packet. It may also
2082 be the word <code>inherit</code>, in which case the TTL will be copied
2083 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2084 system default, typically 64). Default is the system default TTL.
2087 <column name="options" key="df_default"
2088 type='{"type": "boolean"}'>
2089 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2090 outer headers to allow path MTU discovery. Default is enabled; set
2091 to <code>false</code> to disable.
2094 <group title="Tunnel Options: vxlan only">
2096 <column name="options" key="exts">
2097 <p>Optional. Comma separated list of optional VXLAN extensions to
2098 enable. The following extensions are supported:</p>
2102 <code>gbp</code>: VXLAN-GBP allows to transport the group policy
2103 context of a packet across the VXLAN tunnel to other network
2104 peers. See the field description of <code>tun_gbp_id</code> and
2105 <code>tun_gbp_flags</code> in ovs-ofctl(8) for additional
2107 (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>)
2114 <group title="Tunnel Options: gre, ipsec_gre, geneve, and vxlan">
2116 <code>gre</code>, <code>ipsec_gre</code>, <code>geneve</code>, and
2117 <code>vxlan</code> interfaces support these options.
2120 <column name="options" key="csum" type='{"type": "boolean"}'>
2122 Optional. Compute encapsulation header (either GRE or UDP)
2123 checksums on outgoing packets. Default is disabled, set to
2124 <code>true</code> to enable. Checksums present on incoming
2125 packets will be validated regardless of this setting.
2129 When using the upstream Linux kernel module, computation of
2130 checksums for <code>geneve</code> and <code>vxlan</code> requires
2131 Linux kernel version 4.0 or higher. <code>gre</code> supports
2132 checksums for all versions of Open vSwitch that support GRE.
2133 The out of tree kernel module distributed as part of OVS
2134 can compute all tunnel checksums on any kernel version that it
2139 This option is supported for <code>ipsec_gre</code>, but not useful
2140 because GRE checksums are weaker than, and redundant with, IPsec
2141 payload authentication.
2146 <group title="Tunnel Options: ipsec_gre only">
2148 Only <code>ipsec_gre</code> interfaces support these options.
2151 <column name="options" key="peer_cert">
2152 Required for certificate authentication. A string containing the
2153 peer's certificate in PEM format. Additionally the host's
2154 certificate must be specified with the <code>certificate</code>
2158 <column name="options" key="certificate">
2159 Required for certificate authentication. The name of a PEM file
2160 containing a certificate that will be presented to the peer during
2164 <column name="options" key="private_key">
2165 Optional for certificate authentication. The name of a PEM file
2166 containing the private key associated with <code>certificate</code>.
2167 If <code>certificate</code> contains the private key, this option may
2171 <column name="options" key="psk">
2172 Required for pre-shared key authentication. Specifies a pre-shared
2173 key for authentication that must be identical on both sides of the
2179 <group title="Patch Options">
2181 Only <code>patch</code> interfaces support these options.
2184 <column name="options" key="peer">
2185 The <ref column="name"/> of the <ref table="Interface"/> for the other
2186 side of the patch. The named <ref table="Interface"/>'s own
2187 <code>peer</code> option must specify this <ref table="Interface"/>'s
2188 name. That is, the two patch interfaces must have reversed <ref
2189 column="name"/> and <code>peer</code> values.
2193 <group title="Interface Status">
2195 Status information about interfaces attached to bridges, updated every
2196 5 seconds. Not all interfaces have all of these properties; virtual
2197 interfaces don't have a link speed, for example. Non-applicable
2198 columns will have empty values.
2200 <column name="admin_state">
2202 The administrative state of the physical network link.
2206 <column name="link_state">
2208 The observed state of the physical network link. This is ordinarily
2209 the link's carrier status. If the interface's <ref table="Port"/> is
2210 a bond configured for miimon monitoring, it is instead the network
2211 link's miimon status.
2215 <column name="link_resets">
2217 The number of times Open vSwitch has observed the
2218 <ref column="link_state"/> of this <ref table="Interface"/> change.
2222 <column name="link_speed">
2224 The negotiated speed of the physical network link.
2225 Valid values are positive integers greater than 0.
2229 <column name="duplex">
2231 The duplex mode of the physical network link.
2237 The MTU (maximum transmission unit); i.e. the largest
2238 amount of data that can fit into a single Ethernet frame.
2239 The standard Ethernet MTU is 1500 bytes. Some physical media
2240 and many kinds of virtual interfaces can be configured with
2244 This column will be empty for an interface that does not
2245 have an MTU as, for example, some kinds of tunnels do not.
2249 <column name="lacp_current">
2250 Boolean value indicating LACP status for this interface. If true, this
2251 interface has current LACP information about its LACP partner. This
2252 information may be used to monitor the health of interfaces in a LACP
2253 enabled port. This column will be empty if LACP is not enabled.
2256 <column name="status">
2257 Key-value pairs that report port status. Supported status values are
2258 <ref column="type"/>-dependent; some interfaces may not have a valid
2259 <ref column="status" key="driver_name"/>, for example.
2262 <column name="status" key="driver_name">
2263 The name of the device driver controlling the network adapter.
2266 <column name="status" key="driver_version">
2267 The version string of the device driver controlling the network
2271 <column name="status" key="firmware_version">
2272 The version string of the network adapter's firmware, if available.
2275 <column name="status" key="source_ip">
2276 The source IP address used for an IPv4 tunnel end-point, such as
2280 <column name="status" key="tunnel_egress_iface">
2281 Egress interface for tunnels. Currently only relevant for tunnels
2282 on Linux systems, this column will show the name of the interface
2283 which is responsible for routing traffic destined for the configured
2284 <ref column="options" key="remote_ip"/>. This could be an internal
2285 interface such as a bridge port.
2288 <column name="status" key="tunnel_egress_iface_carrier"
2289 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2290 Whether carrier is detected on <ref column="status"
2291 key="tunnel_egress_iface"/>.
2295 <group title="Statistics">
2297 Key-value pairs that report interface statistics. The current
2298 implementation updates these counters periodically. The update period
2299 is controlled by <ref column="other_config"
2300 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2301 Future implementations may update them when an interface is created,
2302 when they are queried (e.g. using an OVSDB <code>select</code>
2303 operation), and just before an interface is deleted due to virtual
2304 interface hot-unplug or VM shutdown, and perhaps at other times, but
2305 not on any regular periodic basis.
2308 These are the same statistics reported by OpenFlow in its <code>struct
2309 ofp_port_stats</code> structure. If an interface does not support a
2310 given statistic, then that pair is omitted.
2312 <group title="Statistics: Successful transmit and receive counters">
2313 <column name="statistics" key="rx_packets">
2314 Number of received packets.
2316 <column name="statistics" key="rx_bytes">
2317 Number of received bytes.
2319 <column name="statistics" key="tx_packets">
2320 Number of transmitted packets.
2322 <column name="statistics" key="tx_bytes">
2323 Number of transmitted bytes.
2326 <group title="Statistics: Receive errors">
2327 <column name="statistics" key="rx_dropped">
2328 Number of packets dropped by RX.
2330 <column name="statistics" key="rx_frame_err">
2331 Number of frame alignment errors.
2333 <column name="statistics" key="rx_over_err">
2334 Number of packets with RX overrun.
2336 <column name="statistics" key="rx_crc_err">
2337 Number of CRC errors.
2339 <column name="statistics" key="rx_errors">
2340 Total number of receive errors, greater than or equal to the sum of
2344 <group title="Statistics: Transmit errors">
2345 <column name="statistics" key="tx_dropped">
2346 Number of packets dropped by TX.
2348 <column name="statistics" key="collisions">
2349 Number of collisions.
2351 <column name="statistics" key="tx_errors">
2352 Total number of transmit errors, greater than or equal to the sum of
2358 <group title="Ingress Policing">
2360 These settings control ingress policing for packets received on this
2361 interface. On a physical interface, this limits the rate at which
2362 traffic is allowed into the system from the outside; on a virtual
2363 interface (one connected to a virtual machine), this limits the rate at
2364 which the VM is able to transmit.
2367 Policing is a simple form of quality-of-service that simply drops
2368 packets received in excess of the configured rate. Due to its
2369 simplicity, policing is usually less accurate and less effective than
2370 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2371 table="Queue"/> tables).
2374 Policing is currently implemented only on Linux. The Linux
2375 implementation uses a simple ``token bucket'' approach:
2379 The size of the bucket corresponds to <ref
2380 column="ingress_policing_burst"/>. Initially the bucket is full.
2383 Whenever a packet is received, its size (converted to tokens) is
2384 compared to the number of tokens currently in the bucket. If the
2385 required number of tokens are available, they are removed and the
2386 packet is forwarded. Otherwise, the packet is dropped.
2389 Whenever it is not full, the bucket is refilled with tokens at the
2390 rate specified by <ref column="ingress_policing_rate"/>.
2394 Policing interacts badly with some network protocols, and especially
2395 with fragmented IP packets. Suppose that there is enough network
2396 activity to keep the bucket nearly empty all the time. Then this token
2397 bucket algorithm will forward a single packet every so often, with the
2398 period depending on packet size and on the configured rate. All of the
2399 fragments of an IP packets are normally transmitted back-to-back, as a
2400 group. In such a situation, therefore, only one of these fragments
2401 will be forwarded and the rest will be dropped. IP does not provide
2402 any way for the intended recipient to ask for only the remaining
2403 fragments. In such a case there are two likely possibilities for what
2404 will happen next: either all of the fragments will eventually be
2405 retransmitted (as TCP will do), in which case the same problem will
2406 recur, or the sender will not realize that its packet has been dropped
2407 and data will simply be lost (as some UDP-based protocols will do).
2408 Either way, it is possible that no forward progress will ever occur.
2410 <column name="ingress_policing_rate">
2412 Maximum rate for data received on this interface, in kbps. Data
2413 received faster than this rate is dropped. Set to <code>0</code>
2414 (the default) to disable policing.
2418 <column name="ingress_policing_burst">
2419 <p>Maximum burst size for data received on this interface, in kb. The
2420 default burst size if set to <code>0</code> is 1000 kb. This value
2421 has no effect if <ref column="ingress_policing_rate"/>
2422 is <code>0</code>.</p>
2424 Specifying a larger burst size lets the algorithm be more forgiving,
2425 which is important for protocols like TCP that react severely to
2426 dropped packets. The burst size should be at least the size of the
2427 interface's MTU. Specifying a value that is numerically at least as
2428 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2429 closer to achieving the full rate.
2434 <group title="Bidirectional Forwarding Detection (BFD)">
2436 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2437 detection of connectivity failures by occasional transmission of
2438 BFD control messages. Open vSwitch implements BFD to serve
2439 as a more popular and standards compliant alternative to CFM.
2443 BFD operates by regularly transmitting BFD control messages at a rate
2444 negotiated independently in each direction. Each endpoint specifies
2445 the rate at which it expects to receive control messages, and the rate
2446 at which it is willing to transmit them. Open vSwitch uses a detection
2447 multiplier of three, meaning that an endpoint signals a connectivity
2448 fault if three consecutive BFD control messages fail to arrive. In the
2449 case of a unidirectional connectivity issue, the system not receiving
2450 BFD control messages signals the problem to its peer in the messages it
2455 The Open vSwitch implementation of BFD aims to comply faithfully
2456 with RFC 5880 requirements. Open vSwitch does not implement the
2457 optional Authentication or ``Echo Mode'' features.
2460 <group title="BFD Configuration">
2462 A controller sets up key-value pairs in the <ref column="bfd"/>
2463 column to enable and configure BFD.
2466 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2467 True to enable BFD on this <ref table="Interface"/>. If not
2468 specified, BFD will not be enabled by default.
2471 <column name="bfd" key="min_rx"
2472 type='{"type": "integer", "minInteger": 1}'>
2473 The shortest interval, in milliseconds, at which this BFD session
2474 offers to receive BFD control messages. The remote endpoint may
2475 choose to send messages at a slower rate. Defaults to
2479 <column name="bfd" key="min_tx"
2480 type='{"type": "integer", "minInteger": 1}'>
2481 The shortest interval, in milliseconds, at which this BFD session is
2482 willing to transmit BFD control messages. Messages will actually be
2483 transmitted at a slower rate if the remote endpoint is not willing to
2484 receive as quickly as specified. Defaults to <code>100</code>.
2487 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2488 An alternate receive interval, in milliseconds, that must be greater
2489 than or equal to <ref column="bfd" key="min_rx"/>. The
2490 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2491 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2492 data traffic at the interface, to reduce the CPU and bandwidth cost
2493 of monitoring an idle interface. This feature may be disabled by
2494 setting a value of 0. This feature is reset whenever <ref
2495 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2499 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2500 When <code>true</code>, traffic received on the
2501 <ref table="Interface"/> is used to indicate the capability of packet
2502 I/O. BFD control packets are still transmitted and received. At
2503 least one BFD control packet must be received every 100 * <ref
2504 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2505 traffic are received, the <ref column="bfd" key="forwarding"/>
2506 will be <code>false</code>.
2509 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2510 Set to true to notify the remote endpoint that traffic should not be
2511 forwarded to this system for some reason other than a connectivty
2512 failure on the interface being monitored. The typical underlying
2513 reason is ``concatenated path down,'' that is, that connectivity
2514 beyond the local system is down. Defaults to false.
2517 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2518 Set to true to make BFD accept only control messages with a tunnel
2519 key of zero. By default, BFD accepts control messages with any
2523 <column name="bfd" key="bfd_local_src_mac">
2524 Set to an Ethernet address in the form
2525 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2526 to set the MAC used as source for transmitted BFD packets. The
2527 default is the mac address of the BFD enabled interface.
2530 <column name="bfd" key="bfd_local_dst_mac">
2531 Set to an Ethernet address in the form
2532 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2533 to set the MAC used as destination for transmitted BFD packets. The
2534 default is <code>00:23:20:00:00:01</code>.
2537 <column name="bfd" key="bfd_remote_dst_mac">
2538 Set to an Ethernet address in the form
2539 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2540 to set the MAC used for checking the destination of received BFD packets.
2541 Packets with different destination MAC will not be considered as BFD packets.
2542 If not specified the destination MAC address of received BFD packets
2546 <column name="bfd" key="bfd_src_ip">
2547 Set to an IPv4 address to set the IP address used as source for
2548 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2551 <column name="bfd" key="bfd_dst_ip">
2552 Set to an IPv4 address to set the IP address used as destination
2553 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2557 <group title="BFD Status">
2559 The switch sets key-value pairs in the <ref column="bfd_status"/>
2560 column to report the status of BFD on this interface. When BFD is
2561 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2562 all key-value pairs from <ref column="bfd_status"/>.
2565 <column name="bfd_status" key="state"
2566 type='{"type": "string",
2567 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2568 Reports the state of the BFD session. The BFD session is fully
2569 healthy and negotiated if <code>UP</code>.
2572 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2573 Reports whether the BFD session believes this <ref
2574 table="Interface"/> may be used to forward traffic. Typically this
2575 means the local session is signaling <code>UP</code>, and the remote
2576 system isn't signaling a problem such as concatenated path down.
2579 <column name="bfd_status" key="diagnostic">
2580 In case of a problem, set to an error message that reports what the
2581 local BFD session thinks is wrong. The error messages are defined
2582 in section 4.1 of [RFC 5880].
2585 <column name="bfd_status" key="remote_state"
2586 type='{"type": "string",
2587 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2588 Reports the state of the remote endpoint's BFD session.
2591 <column name="bfd_status" key="remote_diagnostic">
2592 In case of a problem, set to an error message that reports what the
2593 remote endpoint's BFD session thinks is wrong. The error messages
2594 are defined in section 4.1 of [RFC 5880].
2597 <column name="bfd_status" key="flap_count"
2598 type='{"type": "integer", "minInteger": 0}'>
2599 Counts the number of <ref column="bfd_status" key="forwarding" />
2600 flaps since start. A flap is considered as a change of the
2601 <ref column="bfd_status" key="forwarding" /> value.
2606 <group title="Connectivity Fault Management">
2608 802.1ag Connectivity Fault Management (CFM) allows a group of
2609 Maintenance Points (MPs) called a Maintenance Association (MA) to
2610 detect connectivity problems with each other. MPs within a MA should
2611 have complete and exclusive interconnectivity. This is verified by
2612 occasionally broadcasting Continuity Check Messages (CCMs) at a
2613 configurable transmission interval.
2617 According to the 802.1ag specification, each Maintenance Point should
2618 be configured out-of-band with a list of Remote Maintenance Points it
2619 should have connectivity to. Open vSwitch differs from the
2620 specification in this area. It simply assumes the link is faulted if
2621 no Remote Maintenance Points are reachable, and considers it not
2626 When operating over tunnels which have no <code>in_key</code>, or an
2627 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2628 with a tunnel key of zero.
2631 <column name="cfm_mpid">
2633 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2634 within a Maintenance Association. The MPID is used to identify this
2635 endpoint to other Maintenance Points in the MA. Each end of a link
2636 being monitored should have a different MPID. Must be configured to
2637 enable CFM on this <ref table="Interface"/>.
2640 According to the 802.1ag specification, MPIDs can only range between
2641 [1, 8191]. However, extended mode (see <ref column="other_config"
2642 key="cfm_extended"/>) supports eight byte MPIDs.
2646 <column name="cfm_flap_count">
2647 Counts the number of cfm fault flapps since boot. A flap is
2648 considered to be a change of the <ref column="cfm_fault"/> value.
2651 <column name="cfm_fault">
2653 Indicates a connectivity fault triggered by an inability to receive
2654 heartbeats from any remote endpoint. When a fault is triggered on
2655 <ref table="Interface"/>s participating in bonds, they will be
2659 Faults can be triggered for several reasons. Most importantly they
2660 are triggered when no CCMs are received for a period of 3.5 times the
2661 transmission interval. Faults are also triggered when any CCMs
2662 indicate that a Remote Maintenance Point is not receiving CCMs but
2663 able to send them. Finally, a fault is triggered if a CCM is
2664 received which indicates unexpected configuration. Notably, this
2665 case arises when a CCM is received which advertises the local MPID.
2669 <column name="cfm_fault_status" key="recv">
2670 Indicates a CFM fault was triggered due to a lack of CCMs received on
2671 the <ref table="Interface"/>.
2674 <column name="cfm_fault_status" key="rdi">
2675 Indicates a CFM fault was triggered due to the reception of a CCM with
2676 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2677 are not receiving CCMs themselves. This typically indicates a
2678 unidirectional connectivity failure.
2681 <column name="cfm_fault_status" key="maid">
2682 Indicates a CFM fault was triggered due to the reception of a CCM with
2683 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2684 with an identification number in addition to the MPID called the MAID.
2685 Open vSwitch only supports receiving CCM broadcasts tagged with the
2686 MAID it uses internally.
2689 <column name="cfm_fault_status" key="loopback">
2690 Indicates a CFM fault was triggered due to the reception of a CCM
2691 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2692 column of this <ref table="Interface"/>. This may indicate a loop in
2696 <column name="cfm_fault_status" key="overflow">
2697 Indicates a CFM fault was triggered because the CFM module received
2698 CCMs from more remote endpoints than it can keep track of.
2701 <column name="cfm_fault_status" key="override">
2702 Indicates a CFM fault was manually triggered by an administrator using
2703 an <code>ovs-appctl</code> command.
2706 <column name="cfm_fault_status" key="interval">
2707 Indicates a CFM fault was triggered due to the reception of a CCM
2708 frame having an invalid interval.
2711 <column name="cfm_remote_opstate">
2712 <p>When in extended mode, indicates the operational state of the
2713 remote endpoint as either <code>up</code> or <code>down</code>. See
2714 <ref column="other_config" key="cfm_opstate"/>.
2718 <column name="cfm_health">
2720 Indicates the health of the interface as a percentage of CCM frames
2721 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2722 The health of an interface is undefined if it is communicating with
2723 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2724 healthy heartbeats are not received at the expected rate, and
2725 gradually improves as healthy heartbeats are received at the desired
2726 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2727 health of the interface is refreshed.
2730 As mentioned above, the faults can be triggered for several reasons.
2731 The link health will deteriorate even if heartbeats are received but
2732 they are reported to be unhealthy. An unhealthy heartbeat in this
2733 context is a heartbeat for which either some fault is set or is out
2734 of sequence. The interface health can be 100 only on receiving
2735 healthy heartbeats at the desired rate.
2739 <column name="cfm_remote_mpids">
2740 When CFM is properly configured, Open vSwitch will occasionally
2741 receive CCM broadcasts. These broadcasts contain the MPID of the
2742 sending Maintenance Point. The list of MPIDs from which this
2743 <ref table="Interface"/> is receiving broadcasts from is regularly
2744 collected and written to this column.
2747 <column name="other_config" key="cfm_interval"
2748 type='{"type": "integer"}'>
2750 The interval, in milliseconds, between transmissions of CFM
2751 heartbeats. Three missed heartbeat receptions indicate a
2756 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2757 60,000, or 600,000 ms are supported. Other values will be rounded
2758 down to the nearest value on the list. Extended mode (see <ref
2759 column="other_config" key="cfm_extended"/>) supports any interval up
2760 to 65,535 ms. In either mode, the default is 1000 ms.
2763 <p>We do not recommend using intervals less than 100 ms.</p>
2766 <column name="other_config" key="cfm_extended"
2767 type='{"type": "boolean"}'>
2768 When <code>true</code>, the CFM module operates in extended mode. This
2769 causes it to use a nonstandard destination address to avoid conflicting
2770 with compliant implementations which may be running concurrently on the
2771 network. Furthermore, extended mode increases the accuracy of the
2772 <code>cfm_interval</code> configuration parameter by breaking wire
2773 compatibility with 802.1ag compliant implementations. And extended
2774 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2777 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2779 When <code>true</code>, and
2780 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2781 module operates in demand mode. When in demand mode, traffic
2782 received on the <ref table="Interface"/> is used to indicate
2783 liveness. CCMs are still transmitted and received. At least one
2784 CCM must be received every 100 * <ref column="other_config"
2785 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2786 are received, the CFM module will raise the connectivity fault.
2790 Demand mode has a couple of caveats:
2793 To ensure that ovs-vswitchd has enough time to pull statistics
2794 from the datapath, the fault detection interval is set to
2795 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2800 To avoid ambiguity, demand mode disables itself when there are
2801 multiple remote maintenance points.
2805 If the <ref table="Interface"/> is heavily congested, CCMs
2806 containing the <ref column="other_config" key="cfm_opstate"/>
2807 status may be dropped causing changes in the operational state to
2808 be delayed. Similarly, if CCMs containing the RDI bit are not
2809 received, unidirectional link failures may not be detected.
2815 <column name="other_config" key="cfm_opstate"
2816 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2817 When <code>down</code>, the CFM module marks all CCMs it generates as
2818 operationally down without triggering a fault. This allows remote
2819 maintenance points to choose not to forward traffic to the
2820 <ref table="Interface"/> on which this CFM module is running.
2821 Currently, in Open vSwitch, the opdown bit of CCMs affects
2822 <ref table="Interface"/>s participating in bonds, and the bundle
2823 OpenFlow action. This setting is ignored when CFM is not in extended
2824 mode. Defaults to <code>up</code>.
2827 <column name="other_config" key="cfm_ccm_vlan"
2828 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2829 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2830 with the given value. May be the string <code>random</code> in which
2831 case each CCM will be tagged with a different randomly generated VLAN.
2834 <column name="other_config" key="cfm_ccm_pcp"
2835 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2836 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2837 with the given PCP value, the VLAN ID of the tag is governed by the
2838 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2839 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2845 <group title="Bonding Configuration">
2846 <column name="other_config" key="lacp-port-id"
2847 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2848 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2849 used in LACP negotiations to identify individual ports
2850 participating in a bond.
2853 <column name="other_config" key="lacp-port-priority"
2854 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2855 The LACP port priority of this <ref table="Interface"/>. In LACP
2856 negotiations <ref table="Interface"/>s with numerically lower
2857 priorities are preferred for aggregation.
2860 <column name="other_config" key="lacp-aggregation-key"
2861 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2862 The LACP aggregation key of this <ref table="Interface"/>. <ref
2863 table="Interface"/>s with different aggregation keys may not be active
2864 within a given <ref table="Port"/> at the same time.
2868 <group title="Virtual Machine Identifiers">
2870 These key-value pairs specifically apply to an interface that
2871 represents a virtual Ethernet interface connected to a virtual
2872 machine. These key-value pairs should not be present for other types
2873 of interfaces. Keys whose names end in <code>-uuid</code> have
2874 values that uniquely identify the entity in question. For a Citrix
2875 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2876 Other hypervisors may use other formats.
2879 <column name="external_ids" key="attached-mac">
2880 The MAC address programmed into the ``virtual hardware'' for this
2881 interface, in the form
2882 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2883 For Citrix XenServer, this is the value of the <code>MAC</code> field
2884 in the VIF record for this interface.
2887 <column name="external_ids" key="iface-id">
2888 A system-unique identifier for the interface. On XenServer, this will
2889 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2892 <column name="external_ids" key="iface-status"
2893 type='{"type": "string",
2894 "enum": ["set", ["active", "inactive"]]}'>
2896 Hypervisors may sometimes have more than one interface associated
2897 with a given <ref column="external_ids" key="iface-id"/>, only one of
2898 which is actually in use at a given time. For example, in some
2899 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2900 for a single <ref column="external_ids" key="iface-id"/>, but only
2901 uses one of them at a time. A hypervisor that behaves this way must
2902 mark the currently in use interface <code>active</code> and the
2903 others <code>inactive</code>. A hypervisor that never has more than
2904 one interface for a given <ref column="external_ids" key="iface-id"/>
2905 may mark that interface <code>active</code> or omit <ref
2906 column="external_ids" key="iface-status"/> entirely.
2910 During VM migration, a given <ref column="external_ids"
2911 key="iface-id"/> might transiently be marked <code>active</code> on
2912 two different hypervisors. That is, <code>active</code> means that
2913 this <ref column="external_ids" key="iface-id"/> is the active
2914 instance within a single hypervisor, not in a broader scope.
2915 There is one exception: some hypervisors support ``migration'' from a
2916 given hypervisor to itself (most often for test purposes). During
2917 such a ``migration,'' two instances of a single <ref
2918 column="external_ids" key="iface-id"/> might both be briefly marked
2919 <code>active</code> on a single hypervisor.
2923 <column name="external_ids" key="xs-vif-uuid">
2924 The virtual interface associated with this interface.
2927 <column name="external_ids" key="xs-network-uuid">
2928 The virtual network to which this interface is attached.
2931 <column name="external_ids" key="vm-id">
2932 The VM to which this interface belongs. On XenServer, this will be the
2933 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2936 <column name="external_ids" key="xs-vm-uuid">
2937 The VM to which this interface belongs.
2941 <group title="VLAN Splinters">
2943 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2944 with buggy network drivers in old versions of Linux that do not
2945 properly support VLANs when VLAN devices are not used, at some cost
2946 in memory and performance.
2950 When VLAN splinters are enabled on a particular interface, Open vSwitch
2951 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2952 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2953 received on the VLAN device is treated as if it had been received on
2954 the interface on the particular VLAN.
2958 VLAN splinters consider a VLAN to be in use if:
2963 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2964 table="Port"/> record.
2968 The VLAN is listed within the <ref table="Port" column="trunks"/>
2969 column of the <ref table="Port"/> record of an interface on which
2970 VLAN splinters are enabled.
2972 An empty <ref table="Port" column="trunks"/> does not influence the
2973 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2974 will exceed the current 1,024 port per datapath limit.
2978 An OpenFlow flow within any bridge matches the VLAN.
2983 The same set of in-use VLANs applies to every interface on which VLAN
2984 splinters are enabled. That is, the set is not chosen separately for
2985 each interface but selected once as the union of all in-use VLANs based
2990 It does not make sense to enable VLAN splinters on an interface for an
2991 access port, or on an interface that is not a physical port.
2995 VLAN splinters are deprecated. When broken device drivers are no
2996 longer in widespread use, we will delete this feature.
2999 <column name="other_config" key="enable-vlan-splinters"
3000 type='{"type": "boolean"}'>
3002 Set to <code>true</code> to enable VLAN splinters on this interface.
3003 Defaults to <code>false</code>.
3007 VLAN splinters increase kernel and userspace memory overhead, so do
3008 not use them unless they are needed.
3012 VLAN splinters do not support 802.1p priority tags. Received
3013 priorities will appear to be 0, regardless of their actual values,
3014 and priorities on transmitted packets will also be cleared to 0.
3019 <group title="Auto Attach Configuration">
3021 Auto Attach configuration for a particular interface.
3024 <column name="lldp" key="enable" type='{"type": "boolean"}'>
3025 True to enable LLDP on this <ref table="Interface"/>. If not
3026 specified, LLDP will be disabled by default.
3030 <group title="Common Columns">
3031 The overall purpose of these columns is described under <code>Common
3032 Columns</code> at the beginning of this document.
3034 <column name="other_config"/>
3035 <column name="external_ids"/>
3039 <table name="Flow_Table" title="OpenFlow table configuration">
3040 <p>Configuration for a particular OpenFlow table.</p>
3042 <column name="name">
3043 The table's name. Set this column to change the name that controllers
3044 will receive when they request table statistics, e.g. <code>ovs-ofctl
3045 dump-tables</code>. The name does not affect switch behavior.
3048 <group title="Eviction Policy">
3050 Open vSwitch supports limiting the number of flows that may be
3051 installed in a flow table, via the <ref column="flow_limit"/> column.
3052 When adding a flow would exceed this limit, by default Open vSwitch
3053 reports an error, but there are two ways to configure Open vSwitch to
3054 instead delete (``evict'') a flow to make room for the new one:
3059 Set the <ref column="overflow_policy"/> column to <code>evict</code>.
3063 Send an OpenFlow 1.4+ ``table mod request'' to enable eviction for
3064 the flow table (e.g. <code>ovs-ofctl -O OpenFlow14 mod-table br0 0
3065 evict</code> to enable eviction on flow table 0 of bridge
3071 When a flow must be evicted due to overflow, the flow to evict is
3072 chosen through an approximation of the following algorithm. This
3073 algorithm is used regardless of how eviction was enabled:
3078 Divide the flows in the table into groups based on the values of the
3079 fields or subfields specified in the <ref column="groups"/> column,
3080 so that all of the flows in a given group have the same values for
3081 those fields. If a flow does not specify a given field, that field's
3082 value is treated as 0. If <ref column="groups"/> is empty, then all
3083 of the flows in the flow table are treated as a single group.
3087 Consider the flows in the largest group, that is, the group that
3088 contains the greatest number of flows. If two or more groups all
3089 have the same largest number of flows, consider the flows in all of
3094 If the flows under consideration have different importance values,
3095 eliminate from consideration any flows except those with the lowest
3096 importance. (``Importance,'' a 16-bit integer value attached to each
3097 flow, was introduced in OpenFlow 1.4. Flows inserted with older
3098 versions of OpenFlow always have an importance of 0.)
3102 Among the flows under consideration, choose the flow that expires
3103 soonest for eviction.
3108 The eviction process only considers flows that have an idle timeout
3109 or a hard timeout. That is, eviction never deletes permanent flows.
3110 (Permanent flows do count against <ref column="flow_limit"/>.)
3113 <column name="flow_limit">
3114 If set, limits the number of flows that may be added to the table.
3115 Open vSwitch may limit the number of flows in a table for other
3116 reasons, e.g. due to hardware limitations or for resource availability
3117 or performance reasons.
3120 <column name="overflow_policy">
3122 Controls the switch's behavior when an OpenFlow flow table
3123 modification request would add flows in excess of <ref
3124 column="flow_limit"/>. The supported values are:
3128 <dt><code>refuse</code></dt>
3130 Refuse to add the flow or flows. This is also the default policy
3131 when <ref column="overflow_policy"/> is unset.
3134 <dt><code>evict</code></dt>
3136 Delete a flow chosen according to the algorithm described above.
3141 <column name="groups">
3143 When <ref column="overflow_policy"/> is <code>evict</code>, this
3144 controls how flows are chosen for eviction when the flow table would
3145 otherwise exceed <ref column="flow_limit"/> flows. Its value is a
3146 set of NXM fields or sub-fields, each of which takes one of the forms
3147 <code><var>field</var>[]</code> or
3148 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
3149 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
3150 <code>nicira-ext.h</code> for a complete list of NXM field names.
3154 Open vSwitch ignores any invalid or unknown field specifications.
3158 When eviction is not enabled, via <ref column="overflow_policy"/> or
3159 an OpenFlow 1.4+ ``table mod,'' this column has no effect.
3164 <group title="Classifier Optimization">
3165 <column name="prefixes">
3167 This string set specifies which fields should be used for
3168 address prefix tracking. Prefix tracking allows the
3169 classifier to skip rules with longer than necessary prefixes,
3170 resulting in better wildcarding for datapath flows.
3173 Prefix tracking may be beneficial when a flow table contains
3174 matches on IP address fields with different prefix lengths.
3175 For example, when a flow table contains IP address matches on
3176 both full addresses and proper prefixes, the full address
3177 matches will typically cause the datapath flow to un-wildcard
3178 the whole address field (depending on flow entry priorities).
3179 In this case each packet with a different address gets handed
3180 to the userspace for flow processing and generates its own
3181 datapath flow. With prefix tracking enabled for the address
3182 field in question packets with addresses matching shorter
3183 prefixes would generate datapath flows where the irrelevant
3184 address bits are wildcarded, allowing the same datapath flow
3185 to handle all the packets within the prefix in question. In
3186 this case many userspace upcalls can be avoided and the
3187 overall performance can be better.
3190 This is a performance optimization only, so packets will
3191 receive the same treatment with or without prefix tracking.
3194 The supported fields are: <code>tun_id</code>,
3195 <code>tun_src</code>, <code>tun_dst</code>,
3196 <code>nw_src</code>, <code>nw_dst</code> (or aliases
3197 <code>ip_src</code> and <code>ip_dst</code>),
3198 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
3199 feature for <code>tun_id</code> would only make sense if the
3200 tunnel IDs have prefix structure similar to IP addresses.)
3204 By default, the <code>prefixes=ip_dst,ip_src</code> are used
3205 on each flow table. This instructs the flow classifier to
3206 track the IP destination and source addresses used by the
3207 rules in this specific flow table.
3211 The keyword <code>none</code> is recognized as an explicit
3212 override of the default values, causing no prefix fields to be
3217 To set the prefix fields, the flow table record needs to
3222 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
3224 Creates a flow table record for the OpenFlow table number 0.
3227 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
3229 Enables prefix tracking for IP source and destination
3235 There is a maximum number of fields that can be enabled for any
3236 one flow table. Currently this limit is 3.
3241 <group title="Common Columns">
3242 The overall purpose of these columns is described under <code>Common
3243 Columns</code> at the beginning of this document.
3245 <column name="external_ids"/>
3249 <table name="QoS" title="Quality of Service configuration">
3250 <p>Quality of Service (QoS) configuration for each Port that
3253 <column name="type">
3254 <p>The type of QoS to implement. The currently defined types are
3257 <dt><code>linux-htb</code></dt>
3259 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
3260 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
3261 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
3262 for information on how this classifier works and how to configure it.
3266 <dt><code>linux-hfsc</code></dt>
3268 Linux "Hierarchical Fair Service Curve" classifier.
3269 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
3270 information on how this classifier works.
3274 <dt><code>linux-sfq</code></dt>
3276 Linux ``Stochastic Fairness Queueing'' classifier. See
3277 <code>tc-sfq</code>(8) (also at
3278 <code>http://linux.die.net/man/8/tc-sfq</code>) for information on
3279 how this classifier works.
3283 <dt><code>linux-codel</code></dt>
3285 Linux ``Controlled Delay'' classifier. See <code>tc-codel</code>(8)
3287 <code>http://man7.org/linux/man-pages/man8/tc-codel.8.html</code>)
3288 for information on how this classifier works.
3292 <dt><code>linux-fq_codel</code></dt>
3294 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3295 <code>tc-fq_codel</code>(8) (also at
3296 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel.8.html</code>)
3297 for information on how this classifier works.
3302 <column name="queues">
3303 <p>A map from queue numbers to <ref table="Queue"/> records. The
3304 supported range of queue numbers depend on <ref column="type"/>. The
3305 queue numbers are the same as the <code>queue_id</code> used in
3306 OpenFlow in <code>struct ofp_action_enqueue</code> and other
3310 Queue 0 is the ``default queue.'' It is used by OpenFlow output
3311 actions when no specific queue has been set. When no configuration for
3312 queue 0 is present, it is automatically configured as if a <ref
3313 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
3314 and <ref table="Queue" column="other_config"/> columns had been
3316 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
3317 this case. With some queuing disciplines, this dropped all packets
3318 destined for the default queue.)
3322 <group title="Configuration for linux-htb and linux-hfsc">
3324 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
3325 the following key-value pair:
3328 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
3329 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3330 specified, for physical interfaces, the default is the link rate. For
3331 other interfaces or if the link rate cannot be determined, the default
3332 is currently 100 Mbps.
3336 <group title="Common Columns">
3337 The overall purpose of these columns is described under <code>Common
3338 Columns</code> at the beginning of this document.
3340 <column name="other_config"/>
3341 <column name="external_ids"/>
3345 <table name="Queue" title="QoS output queue.">
3346 <p>A configuration for a port output queue, used in configuring Quality of
3347 Service (QoS) features. May be referenced by <ref column="queues"
3348 table="QoS"/> column in <ref table="QoS"/> table.</p>
3350 <column name="dscp">
3351 If set, Open vSwitch will mark all traffic egressing this
3352 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3353 default <ref table="Queue"/> is only marked if it was explicitly selected
3354 as the <ref table="Queue"/> at the time the packet was output. If unset,
3355 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3359 <group title="Configuration for linux-htb QoS">
3361 <ref table="QoS"/> <ref table="QoS" column="type"/>
3362 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3363 It has the following key-value pairs defined.
3366 <column name="other_config" key="min-rate"
3367 type='{"type": "integer", "minInteger": 1}'>
3368 Minimum guaranteed bandwidth, in bit/s.
3371 <column name="other_config" key="max-rate"
3372 type='{"type": "integer", "minInteger": 1}'>
3373 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3374 queue's rate will not be allowed to exceed the specified value, even
3375 if excess bandwidth is available. If unspecified, defaults to no
3379 <column name="other_config" key="burst"
3380 type='{"type": "integer", "minInteger": 1}'>
3381 Burst size, in bits. This is the maximum amount of ``credits'' that a
3382 queue can accumulate while it is idle. Optional. Details of the
3383 <code>linux-htb</code> implementation require a minimum burst size, so
3384 a too-small <code>burst</code> will be silently ignored.
3387 <column name="other_config" key="priority"
3388 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3389 A queue with a smaller <code>priority</code> will receive all the
3390 excess bandwidth that it can use before a queue with a larger value
3391 receives any. Specific priority values are unimportant; only relative
3392 ordering matters. Defaults to 0 if unspecified.
3396 <group title="Configuration for linux-hfsc QoS">
3398 <ref table="QoS"/> <ref table="QoS" column="type"/>
3399 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3400 It has the following key-value pairs defined.
3403 <column name="other_config" key="min-rate"
3404 type='{"type": "integer", "minInteger": 1}'>
3405 Minimum guaranteed bandwidth, in bit/s.
3408 <column name="other_config" key="max-rate"
3409 type='{"type": "integer", "minInteger": 1}'>
3410 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3411 queue's rate will not be allowed to exceed the specified value, even if
3412 excess bandwidth is available. If unspecified, defaults to no
3417 <group title="Common Columns">
3418 The overall purpose of these columns is described under <code>Common
3419 Columns</code> at the beginning of this document.
3421 <column name="other_config"/>
3422 <column name="external_ids"/>
3426 <table name="Mirror" title="Port mirroring.">
3427 <p>A port mirror within a <ref table="Bridge"/>.</p>
3428 <p>A port mirror configures a bridge to send selected frames to special
3429 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3430 traffic may also be referred to as SPAN or RSPAN, depending on how
3431 the mirrored traffic is sent.</p>
3434 When a packet enters an Open vSwitch bridge, it becomes eligible for
3435 mirroring based on its ingress port and VLAN. As the packet travels
3436 through the flow tables, each time it is output to a port, it becomes
3437 eligible for mirroring based on the egress port and VLAN. In Open
3438 vSwitch 2.5 and later, mirroring occurs just after a packet first becomes
3439 eligible, using the packet as it exists at that point; in Open vSwitch
3440 2.4 and earlier, mirroring occurs only after a packet has traversed all
3441 the flow tables, using the original packet as it entered the bridge.
3442 This makes a difference only when the flow table modifies the packet: in
3443 Open vSwitch 2.4, the modifications are never visible to mirrors, whereas
3444 in Open vSwitch 2.5 and later modifications made before the first output
3445 that makes it eligible for mirroring to a particular destination are
3450 A packet that enters an Open vSwitch bridge is mirrored to a particular
3451 destination only once, even if it is eligible for multiple reasons. For
3452 example, a packet would be mirrored to a particular <ref
3453 column="output_port"/> only once, even if it is selected for mirroring to
3454 that port by <ref column="select_dst_port"/> and <ref
3455 column="select_src_port"/> in the same or different <ref table="Mirror"/>
3459 <column name="name">
3460 Arbitrary identifier for the <ref table="Mirror"/>.
3463 <group title="Selecting Packets for Mirroring">
3465 To be selected for mirroring, a given packet must enter or leave the
3466 bridge through a selected port and it must also be in one of the
3470 <column name="select_all">
3471 If true, every packet arriving or departing on any port is
3472 selected for mirroring.
3475 <column name="select_dst_port">
3476 Ports on which departing packets are selected for mirroring.
3479 <column name="select_src_port">
3480 Ports on which arriving packets are selected for mirroring.
3483 <column name="select_vlan">
3484 VLANs on which packets are selected for mirroring. An empty set
3485 selects packets on all VLANs.
3489 <group title="Mirroring Destination Configuration">
3491 These columns are mutually exclusive. Exactly one of them must be
3495 <column name="output_port">
3496 <p>Output port for selected packets, if nonempty.</p>
3497 <p>Specifying a port for mirror output reserves that port exclusively
3498 for mirroring. No frames other than those selected for mirroring
3500 will be forwarded to the port, and any frames received on the port
3501 will be discarded.</p>
3503 The output port may be any kind of port supported by Open vSwitch.
3504 It may be, for example, a physical port (sometimes called SPAN) or a
3509 <column name="output_vlan">
3510 <p>Output VLAN for selected packets, if nonempty.</p>
3511 <p>The frames will be sent out all ports that trunk
3512 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3513 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3514 trunk port, the frame's VLAN tag will be set to
3515 <ref column="output_vlan"/>, replacing any existing tag; when it is
3516 sent out an implicit VLAN port, the frame will not be tagged. This
3517 type of mirroring is sometimes called RSPAN.</p>
3519 See the documentation for
3520 <ref column="other_config" key="forward-bpdu"/> in the
3521 <ref table="Interface"/> table for a list of destination MAC
3522 addresses which will not be mirrored to a VLAN to avoid confusing
3523 switches that interpret the protocols that they represent.
3525 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3526 contains unmanaged switches. Consider an unmanaged physical switch
3527 with two ports: port 1, connected to an end host, and port 2,
3528 connected to an Open vSwitch configured to mirror received packets
3529 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3530 port 1 that the physical switch forwards to port 2. The Open vSwitch
3531 forwards this packet to its destination and then reflects it back on
3532 port 2 in VLAN 123. This reflected packet causes the unmanaged
3533 physical switch to replace the MAC learning table entry, which
3534 correctly pointed to port 1, with one that incorrectly points to port
3535 2. Afterward, the physical switch will direct packets destined for
3536 the end host to the Open vSwitch on port 2, instead of to the end
3537 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3538 desired in this scenario, then the physical switch must be replaced
3539 by one that learns Ethernet addresses on a per-VLAN basis. In
3540 addition, learning should be disabled on the VLAN containing mirrored
3541 traffic. If this is not done then intermediate switches will learn
3542 the MAC address of each end host from the mirrored traffic. If
3543 packets being sent to that end host are also mirrored, then they will
3544 be dropped since the switch will attempt to send them out the input
3545 port. Disabling learning for the VLAN will cause the switch to
3546 correctly send the packet out all ports configured for that VLAN. If
3547 Open vSwitch is being used as an intermediate switch, learning can be
3548 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3549 in the appropriate <ref table="Bridge"/> table or tables.</p>
3551 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3552 VLAN and should generally be preferred.
3557 <group title="Statistics: Mirror counters">
3559 Key-value pairs that report mirror statistics. The update period
3560 is controlled by <ref column="other_config"
3561 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3563 <column name="statistics" key="tx_packets">
3564 Number of packets transmitted through this mirror.
3566 <column name="statistics" key="tx_bytes">
3567 Number of bytes transmitted through this mirror.
3571 <group title="Common Columns">
3572 The overall purpose of these columns is described under <code>Common
3573 Columns</code> at the beginning of this document.
3575 <column name="external_ids"/>
3579 <table name="Controller" title="OpenFlow controller configuration.">
3580 <p>An OpenFlow controller.</p>
3583 Open vSwitch supports two kinds of OpenFlow controllers:
3587 <dt>Primary controllers</dt>
3590 This is the kind of controller envisioned by the OpenFlow 1.0
3591 specification. Usually, a primary controller implements a network
3592 policy by taking charge of the switch's flow table.
3596 Open vSwitch initiates and maintains persistent connections to
3597 primary controllers, retrying the connection each time it fails or
3598 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3599 <ref table="Bridge"/> table applies to primary controllers.
3603 Open vSwitch permits a bridge to have any number of primary
3604 controllers. When multiple controllers are configured, Open
3605 vSwitch connects to all of them simultaneously. Because
3606 OpenFlow 1.0 does not specify how multiple controllers
3607 coordinate in interacting with a single switch, more than
3608 one primary controller should be specified only if the
3609 controllers are themselves designed to coordinate with each
3610 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3611 vendor extension may be useful for this.)
3614 <dt>Service controllers</dt>
3617 These kinds of OpenFlow controller connections are intended for
3618 occasional support and maintenance use, e.g. with
3619 <code>ovs-ofctl</code>. Usually a service controller connects only
3620 briefly to inspect or modify some of a switch's state.
3624 Open vSwitch listens for incoming connections from service
3625 controllers. The service controllers initiate and, if necessary,
3626 maintain the connections from their end. The <ref table="Bridge"
3627 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3628 not apply to service controllers.
3632 Open vSwitch supports configuring any number of service controllers.
3638 The <ref column="target"/> determines the type of controller.
3641 <group title="Core Features">
3642 <column name="target">
3643 <p>Connection method for controller.</p>
3645 The following connection methods are currently supported for primary
3649 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3651 <p>The specified SSL <var>port</var> on the host at the
3652 given <var>ip</var>, which must be expressed as an IP
3653 address (not a DNS name). The <ref table="Open_vSwitch"
3654 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3655 table must point to a valid SSL configuration when this form
3657 <p>If <var>port</var> is not specified, it defaults to 6653.</p>
3658 <p>SSL support is an optional feature that is not always built as
3659 part of Open vSwitch.</p>
3661 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3664 The specified TCP <var>port</var> on the host at the given
3665 <var>ip</var>, which must be expressed as an IP address (not a
3666 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3667 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3668 e.g. <code>tcp:[::1]:6653</code>.
3671 If <var>port</var> is not specified, it defaults to 6653.
3676 The following connection methods are currently supported for service
3680 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3683 Listens for SSL connections on the specified TCP <var>port</var>.
3684 If <var>ip</var>, which must be expressed as an IP address (not a
3685 DNS name), is specified, then connections are restricted to the
3686 specified local IP address (either IPv4 or IPv6). If
3687 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3688 e.g. <code>pssl:6653:[::1]</code>.
3691 If <var>port</var> is not specified, it defaults to
3692 6653. If <var>ip</var> is not specified then it listens only on
3693 IPv4 (but not IPv6) addresses. The
3694 <ref table="Open_vSwitch" column="ssl"/>
3695 column in the <ref table="Open_vSwitch"/> table must point to a
3696 valid SSL configuration when this form is used.
3699 If <var>port</var> is not specified, it currently to 6653.
3702 SSL support is an optional feature that is not always built as
3703 part of Open vSwitch.
3706 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3709 Listens for connections on the specified TCP <var>port</var>. If
3710 <var>ip</var>, which must be expressed as an IP address (not a
3711 DNS name), is specified, then connections are restricted to the
3712 specified local IP address (either IPv4 or IPv6). If
3713 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3714 e.g. <code>ptcp:6653:[::1]</code>. If <var>ip</var> is not
3715 specified then it listens only on IPv4 addresses.
3718 If <var>port</var> is not specified, it defaults to 6653.
3722 <p>When multiple controllers are configured for a single bridge, the
3723 <ref column="target"/> values must be unique. Duplicate
3724 <ref column="target"/> values yield unspecified results.</p>
3727 <column name="connection_mode">
3728 <p>If it is specified, this setting must be one of the following
3729 strings that describes how Open vSwitch contacts this OpenFlow
3730 controller over the network:</p>
3733 <dt><code>in-band</code></dt>
3734 <dd>In this mode, this controller's OpenFlow traffic travels over the
3735 bridge associated with the controller. With this setting, Open
3736 vSwitch allows traffic to and from the controller regardless of the
3737 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3738 would never be able to connect to the controller, because it did
3739 not have a flow to enable it.) This is the most common connection
3740 mode because it is not necessary to maintain two independent
3742 <dt><code>out-of-band</code></dt>
3743 <dd>In this mode, OpenFlow traffic uses a control network separate
3744 from the bridge associated with this controller, that is, the
3745 bridge does not use any of its own network devices to communicate
3746 with the controller. The control network must be configured
3747 separately, before or after <code>ovs-vswitchd</code> is started.
3751 <p>If not specified, the default is implementation-specific.</p>
3755 <group title="Controller Failure Detection and Handling">
3756 <column name="max_backoff">
3757 Maximum number of milliseconds to wait between connection attempts.
3758 Default is implementation-specific.
3761 <column name="inactivity_probe">
3762 Maximum number of milliseconds of idle time on connection to
3763 controller before sending an inactivity probe message. If Open
3764 vSwitch does not communicate with the controller for the specified
3765 number of seconds, it will send a probe. If a response is not
3766 received for the same additional amount of time, Open vSwitch
3767 assumes the connection has been broken and attempts to reconnect.
3768 Default is implementation-specific. A value of 0 disables
3773 <group title="Asynchronous Messages">
3775 OpenFlow switches send certain messages to controllers spontanenously,
3776 that is, not in response to any request from the controller. These
3777 messages are called ``asynchronous messages.'' These columns allow
3778 asynchronous messages to be limited or disabled to ensure the best use
3779 of network resources.
3782 <column name="enable_async_messages">
3783 The OpenFlow protocol enables asynchronous messages at time of
3784 connection establishment, which means that a controller can receive
3785 asynchronous messages, potentially many of them, even if it turns them
3786 off immediately after connecting. Set this column to
3787 <code>false</code> to change Open vSwitch behavior to disable, by
3788 default, all asynchronous messages. The controller can use the
3789 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3790 on any messages that it does want to receive, if any.
3793 <group title="Controller Rate Limiting">
3795 A switch can forward packets to a controller over the OpenFlow
3796 protocol. Forwarding packets this way at too high a rate can
3797 overwhelm a controller, frustrate use of the OpenFlow connection for
3798 other purposes, increase the latency of flow setup, and use an
3799 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3800 limiting the rate of packet forwarding to a controller.
3804 There are two main reasons in OpenFlow for a packet to be sent to a
3805 controller: either the packet ``misses'' in the flow table, that is,
3806 there is no matching flow, or a flow table action says to send the
3807 packet to the controller. Open vSwitch limits the rate of each kind
3808 of packet separately at the configured rate. Therefore, the actual
3809 rate that packets are sent to the controller can be up to twice the
3810 configured rate, when packets are sent for both reasons.
3814 This feature is specific to forwarding packets over an OpenFlow
3815 connection. It is not general-purpose QoS. See the <ref
3816 table="QoS"/> table for quality of service configuration, and <ref
3817 column="ingress_policing_rate" table="Interface"/> in the <ref
3818 table="Interface"/> table for ingress policing configuration.
3821 <column name="controller_rate_limit">
3823 The maximum rate at which the switch will forward packets to the
3824 OpenFlow controller, in packets per second. If no value is
3825 specified, rate limiting is disabled.
3829 <column name="controller_burst_limit">
3831 When a high rate triggers rate-limiting, Open vSwitch queues
3832 packets to the controller for each port and transmits them to the
3833 controller at the configured rate. This value limits the number of
3834 queued packets. Ports on a bridge share the packet queue fairly.
3838 This value has no effect unless <ref
3839 column="controller_rate_limit"/> is configured. The current
3840 default when this value is not specified is one-quarter of <ref
3841 column="controller_rate_limit"/>, meaning that queuing can delay
3842 forwarding a packet to the controller by up to 250 ms.
3846 <group title="Controller Rate Limiting Statistics">
3848 These values report the effects of rate limiting. Their values are
3849 relative to establishment of the most recent OpenFlow connection,
3850 or since rate limiting was enabled, whichever happened more
3851 recently. Each consists of two values, one with <code>TYPE</code>
3852 replaced by <code>miss</code> for rate limiting flow table misses,
3853 and the other with <code>TYPE</code> replaced by
3854 <code>action</code> for rate limiting packets sent by OpenFlow
3859 These statistics are reported only when controller rate limiting is
3863 <column name="status" key="packet-in-TYPE-bypassed"
3864 type='{"type": "integer", "minInteger": 0}'>
3865 Number of packets sent directly to the controller, without queuing,
3866 because the rate did not exceed the configured maximum.
3869 <column name="status" key="packet-in-TYPE-queued"
3870 type='{"type": "integer", "minInteger": 0}'>
3871 Number of packets added to the queue to send later.
3874 <column name="status" key="packet-in-TYPE-dropped"
3875 type='{"type": "integer", "minInteger": 0}'>
3876 Number of packets added to the queue that were later dropped due to
3877 overflow. This value is less than or equal to <ref column="status"
3878 key="packet-in-TYPE-queued"/>.
3881 <column name="status" key="packet-in-TYPE-backlog"
3882 type='{"type": "integer", "minInteger": 0}'>
3883 Number of packets currently queued. The other statistics increase
3884 monotonically, but this one fluctuates between 0 and the <ref
3885 column="controller_burst_limit"/> as conditions change.
3891 <group title="Additional In-Band Configuration">
3892 <p>These values are considered only in in-band control mode (see
3893 <ref column="connection_mode"/>).</p>
3895 <p>When multiple controllers are configured on a single bridge, there
3896 should be only one set of unique values in these columns. If different
3897 values are set for these columns in different controllers, the effect
3900 <column name="local_ip">
3901 The IP address to configure on the local port,
3902 e.g. <code>192.168.0.123</code>. If this value is unset, then
3903 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3907 <column name="local_netmask">
3908 The IP netmask to configure on the local port,
3909 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3910 but this value is unset, then the default is chosen based on whether
3911 the IP address is class A, B, or C.
3914 <column name="local_gateway">
3915 The IP address of the gateway to configure on the local port, as a
3916 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3917 this network has no gateway.
3921 <group title="Controller Status">
3922 <column name="is_connected">
3923 <code>true</code> if currently connected to this controller,
3924 <code>false</code> otherwise.
3928 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3929 <p>The level of authority this controller has on the associated
3930 bridge. Possible values are:</p>
3932 <dt><code>other</code></dt>
3933 <dd>Allows the controller access to all OpenFlow features.</dd>
3934 <dt><code>master</code></dt>
3935 <dd>Equivalent to <code>other</code>, except that there may be at
3936 most one master controller at a time. When a controller configures
3937 itself as <code>master</code>, any existing master is demoted to
3938 the <code>slave</code> role.</dd>
3939 <dt><code>slave</code></dt>
3940 <dd>Allows the controller read-only access to OpenFlow features.
3941 Attempts to modify the flow table will be rejected with an
3942 error. Slave controllers do not receive OFPT_PACKET_IN or
3943 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3948 <column name="status" key="last_error">
3949 A human-readable description of the last error on the connection
3950 to the controller; i.e. <code>strerror(errno)</code>. This key
3951 will exist only if an error has occurred.
3954 <column name="status" key="state"
3955 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3957 The state of the connection to the controller:
3960 <dt><code>VOID</code></dt>
3961 <dd>Connection is disabled.</dd>
3963 <dt><code>BACKOFF</code></dt>
3964 <dd>Attempting to reconnect at an increasing period.</dd>
3966 <dt><code>CONNECTING</code></dt>
3967 <dd>Attempting to connect.</dd>
3969 <dt><code>ACTIVE</code></dt>
3970 <dd>Connected, remote host responsive.</dd>
3972 <dt><code>IDLE</code></dt>
3973 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3976 These values may change in the future. They are provided only for
3981 <column name="status" key="sec_since_connect"
3982 type='{"type": "integer", "minInteger": 0}'>
3983 The amount of time since this controller last successfully connected to
3984 the switch (in seconds). Value is empty if controller has never
3985 successfully connected.
3988 <column name="status" key="sec_since_disconnect"
3989 type='{"type": "integer", "minInteger": 1}'>
3990 The amount of time since this controller last disconnected from
3991 the switch (in seconds). Value is empty if controller has never
3996 <group title="Connection Parameters">
3998 Additional configuration for a connection between the controller
3999 and the Open vSwitch.
4002 <column name="other_config" key="dscp"
4003 type='{"type": "integer"}'>
4004 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4005 in the Type of Service (TOS) field in the IP header. DSCP provides a
4006 mechanism to classify the network traffic and provide Quality of
4007 Service (QoS) on IP networks.
4009 The DSCP value specified here is used when establishing the connection
4010 between the controller and the Open vSwitch. If no value is specified,
4011 a default value of 48 is chosen. Valid DSCP values must be in the
4017 <group title="Common Columns">
4018 The overall purpose of these columns is described under <code>Common
4019 Columns</code> at the beginning of this document.
4021 <column name="external_ids"/>
4022 <column name="other_config"/>
4026 <table name="Manager" title="OVSDB management connection.">
4028 Configuration for a database connection to an Open vSwitch database
4033 This table primarily configures the Open vSwitch database
4034 (<code>ovsdb-server</code>), not the Open vSwitch switch
4035 (<code>ovs-vswitchd</code>). The switch does read the table to determine
4036 what connections should be treated as in-band.
4040 The Open vSwitch database server can initiate and maintain active
4041 connections to remote clients. It can also listen for database
4045 <group title="Core Features">
4046 <column name="target">
4047 <p>Connection method for managers.</p>
4049 The following connection methods are currently supported:
4052 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
4055 The specified SSL <var>port</var> on the host at the given
4056 <var>ip</var>, which must be expressed as an IP address
4057 (not a DNS name). The <ref table="Open_vSwitch"
4058 column="ssl"/> column in the <ref table="Open_vSwitch"/>
4059 table must point to a valid SSL configuration when this
4063 If <var>port</var> is not specified, it defaults to 6640.
4066 SSL support is an optional feature that is not always
4067 built as part of Open vSwitch.
4071 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
4074 The specified TCP <var>port</var> on the host at the given
4075 <var>ip</var>, which must be expressed as an IP address (not a
4076 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
4077 <var>ip</var> is an IPv6 address, wrap it in square brackets,
4078 e.g. <code>tcp:[::1]:6640</code>.
4081 If <var>port</var> is not specified, it defaults to 6640.
4084 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4087 Listens for SSL connections on the specified TCP <var>port</var>.
4088 Specify 0 for <var>port</var> to have the kernel automatically
4089 choose an available port. If <var>ip</var>, which must be
4090 expressed as an IP address (not a DNS name), is specified, then
4091 connections are restricted to the specified local IP address
4092 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4093 address, wrap in square brackets,
4094 e.g. <code>pssl:6640:[::1]</code>. If <var>ip</var> is not
4095 specified then it listens only on IPv4 (but not IPv6) addresses.
4096 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
4097 table="Open_vSwitch"/> table must point to a valid SSL
4098 configuration when this form is used.
4101 If <var>port</var> is not specified, it defaults to 6640.
4104 SSL support is an optional feature that is not always built as
4105 part of Open vSwitch.
4108 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4111 Listens for connections on the specified TCP <var>port</var>.
4112 Specify 0 for <var>port</var> to have the kernel automatically
4113 choose an available port. If <var>ip</var>, which must be
4114 expressed as an IP address (not a DNS name), is specified, then
4115 connections are restricted to the specified local IP address
4116 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4117 address, wrap it in square brackets,
4118 e.g. <code>ptcp:6640:[::1]</code>. If <var>ip</var> is not
4119 specified then it listens only on IPv4 addresses.
4122 If <var>port</var> is not specified, it defaults to 6640.
4126 <p>When multiple managers are configured, the <ref column="target"/>
4127 values must be unique. Duplicate <ref column="target"/> values yield
4128 unspecified results.</p>
4131 <column name="connection_mode">
4133 If it is specified, this setting must be one of the following strings
4134 that describes how Open vSwitch contacts this OVSDB client over the
4139 <dt><code>in-band</code></dt>
4141 In this mode, this connection's traffic travels over a bridge
4142 managed by Open vSwitch. With this setting, Open vSwitch allows
4143 traffic to and from the client regardless of the contents of the
4144 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4145 to connect to the client, because it did not have a flow to enable
4146 it.) This is the most common connection mode because it is not
4147 necessary to maintain two independent networks.
4149 <dt><code>out-of-band</code></dt>
4151 In this mode, the client's traffic uses a control network separate
4152 from that managed by Open vSwitch, that is, Open vSwitch does not
4153 use any of its own network devices to communicate with the client.
4154 The control network must be configured separately, before or after
4155 <code>ovs-vswitchd</code> is started.
4160 If not specified, the default is implementation-specific.
4165 <group title="Client Failure Detection and Handling">
4166 <column name="max_backoff">
4167 Maximum number of milliseconds to wait between connection attempts.
4168 Default is implementation-specific.
4171 <column name="inactivity_probe">
4172 Maximum number of milliseconds of idle time on connection to the client
4173 before sending an inactivity probe message. If Open vSwitch does not
4174 communicate with the client for the specified number of seconds, it
4175 will send a probe. If a response is not received for the same
4176 additional amount of time, Open vSwitch assumes the connection has been
4177 broken and attempts to reconnect. Default is implementation-specific.
4178 A value of 0 disables inactivity probes.
4182 <group title="Status">
4183 <column name="is_connected">
4184 <code>true</code> if currently connected to this manager,
4185 <code>false</code> otherwise.
4188 <column name="status" key="last_error">
4189 A human-readable description of the last error on the connection
4190 to the manager; i.e. <code>strerror(errno)</code>. This key
4191 will exist only if an error has occurred.
4194 <column name="status" key="state"
4195 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
4197 The state of the connection to the manager:
4200 <dt><code>VOID</code></dt>
4201 <dd>Connection is disabled.</dd>
4203 <dt><code>BACKOFF</code></dt>
4204 <dd>Attempting to reconnect at an increasing period.</dd>
4206 <dt><code>CONNECTING</code></dt>
4207 <dd>Attempting to connect.</dd>
4209 <dt><code>ACTIVE</code></dt>
4210 <dd>Connected, remote host responsive.</dd>
4212 <dt><code>IDLE</code></dt>
4213 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
4216 These values may change in the future. They are provided only for
4221 <column name="status" key="sec_since_connect"
4222 type='{"type": "integer", "minInteger": 0}'>
4223 The amount of time since this manager last successfully connected
4224 to the database (in seconds). Value is empty if manager has never
4225 successfully connected.
4228 <column name="status" key="sec_since_disconnect"
4229 type='{"type": "integer", "minInteger": 0}'>
4230 The amount of time since this manager last disconnected from the
4231 database (in seconds). Value is empty if manager has never
4235 <column name="status" key="locks_held">
4236 Space-separated list of the names of OVSDB locks that the connection
4237 holds. Omitted if the connection does not hold any locks.
4240 <column name="status" key="locks_waiting">
4241 Space-separated list of the names of OVSDB locks that the connection is
4242 currently waiting to acquire. Omitted if the connection is not waiting
4246 <column name="status" key="locks_lost">
4247 Space-separated list of the names of OVSDB locks that the connection
4248 has had stolen by another OVSDB client. Omitted if no locks have been
4249 stolen from this connection.
4252 <column name="status" key="n_connections"
4253 type='{"type": "integer", "minInteger": 2}'>
4255 When <ref column="target"/> specifies a connection method that
4256 listens for inbound connections (e.g. <code>ptcp:</code> or
4257 <code>pssl:</code>) and more than one connection is actually active,
4258 the value is the number of active connections. Otherwise, this
4259 key-value pair is omitted.
4262 When multiple connections are active, status columns and key-value
4263 pairs (other than this one) report the status of one arbitrarily
4268 <column name="status" key="bound_port" type='{"type": "integer"}'>
4269 When <ref column="target"/> is <code>ptcp:</code> or
4270 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
4271 listening. (This is is particularly useful when <ref
4272 column="target"/> specifies a port of 0, allowing the kernel to
4273 choose any available port.)
4277 <group title="Connection Parameters">
4279 Additional configuration for a connection between the manager
4280 and the Open vSwitch Database.
4283 <column name="other_config" key="dscp"
4284 type='{"type": "integer"}'>
4285 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4286 in the Type of Service (TOS) field in the IP header. DSCP provides a
4287 mechanism to classify the network traffic and provide Quality of
4288 Service (QoS) on IP networks.
4290 The DSCP value specified here is used when establishing the connection
4291 between the manager and the Open vSwitch. If no value is specified, a
4292 default value of 48 is chosen. Valid DSCP values must be in the range
4297 <group title="Common Columns">
4298 The overall purpose of these columns is described under <code>Common
4299 Columns</code> at the beginning of this document.
4301 <column name="external_ids"/>
4302 <column name="other_config"/>
4306 <table name="NetFlow">
4307 A NetFlow target. NetFlow is a protocol that exports a number of
4308 details about terminating IP flows, such as the principals involved
4311 <column name="targets">
4312 NetFlow targets in the form
4313 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
4314 must be specified numerically, not as a DNS name.
4317 <column name="engine_id">
4318 Engine ID to use in NetFlow messages. Defaults to datapath index
4322 <column name="engine_type">
4323 Engine type to use in NetFlow messages. Defaults to datapath
4324 index if not specified.
4327 <column name="active_timeout">
4329 The interval at which NetFlow records are sent for flows that
4330 are still active, in seconds. A value of <code>0</code>
4331 requests the default timeout (currently 600 seconds); a value
4332 of <code>-1</code> disables active timeouts.
4336 The NetFlow passive timeout, for flows that become inactive,
4337 is not configurable. It will vary depending on the Open
4338 vSwitch version, the forms and contents of the OpenFlow flow
4339 tables, CPU and memory usage, and network activity. A typical
4340 passive timeout is about a second.
4344 <column name="add_id_to_interface">
4345 <p>If this column's value is <code>false</code>, the ingress and egress
4346 interface fields of NetFlow flow records are derived from OpenFlow port
4347 numbers. When it is <code>true</code>, the 7 most significant bits of
4348 these fields will be replaced by the least significant 7 bits of the
4349 engine id. This is useful because many NetFlow collectors do not
4350 expect multiple switches to be sending messages from the same host, so
4351 they do not store the engine information which could be used to
4352 disambiguate the traffic.</p>
4353 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
4356 <group title="Common Columns">
4357 The overall purpose of these columns is described under <code>Common
4358 Columns</code> at the beginning of this document.
4360 <column name="external_ids"/>
4365 SSL configuration for an Open_vSwitch.
4367 <column name="private_key">
4368 Name of a PEM file containing the private key used as the switch's
4369 identity for SSL connections to the controller.
4372 <column name="certificate">
4373 Name of a PEM file containing a certificate, signed by the
4374 certificate authority (CA) used by the controller and manager,
4375 that certifies the switch's private key, identifying a trustworthy
4379 <column name="ca_cert">
4380 Name of a PEM file containing the CA certificate used to verify
4381 that the switch is connected to a trustworthy controller.
4384 <column name="bootstrap_ca_cert">
4385 If set to <code>true</code>, then Open vSwitch will attempt to
4386 obtain the CA certificate from the controller on its first SSL
4387 connection and save it to the named PEM file. If it is successful,
4388 it will immediately drop the connection and reconnect, and from then
4389 on all SSL connections must be authenticated by a certificate signed
4390 by the CA certificate thus obtained. <em>This option exposes the
4391 SSL connection to a man-in-the-middle attack obtaining the initial
4392 CA certificate.</em> It may still be useful for bootstrapping.
4395 <group title="Common Columns">
4396 The overall purpose of these columns is described under <code>Common
4397 Columns</code> at the beginning of this document.
4399 <column name="external_ids"/>
4403 <table name="sFlow">
4404 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4405 monitoring of switches.</p>
4407 <column name="agent">
4408 Name of the network device whose IP address should be reported as the
4409 ``agent address'' to collectors. If not specified, the agent device is
4410 figured from the first target address and the routing table. If the
4411 routing table does not contain a route to the target, the IP address
4412 defaults to the <ref table="Controller" column="local_ip"/> in the
4413 collector's <ref table="Controller"/>. If an agent IP address cannot be
4414 determined any of these ways, sFlow is disabled.
4417 <column name="header">
4418 Number of bytes of a sampled packet to send to the collector.
4419 If not specified, the default is 128 bytes.
4422 <column name="polling">
4423 Polling rate in seconds to send port statistics to the collector.
4424 If not specified, defaults to 30 seconds.
4427 <column name="sampling">
4428 Rate at which packets should be sampled and sent to the collector.
4429 If not specified, defaults to 400, which means one out of 400
4430 packets, on average, will be sent to the collector.
4433 <column name="targets">
4434 sFlow targets in the form
4435 <code><var>ip</var>:<var>port</var></code>.
4438 <group title="Common Columns">
4439 The overall purpose of these columns is described under <code>Common
4440 Columns</code> at the beginning of this document.
4442 <column name="external_ids"/>
4446 <table name="IPFIX">
4447 <p>Configuration for sending packets to IPFIX collectors.</p>
4450 IPFIX is a protocol that exports a number of details about flows. The
4451 IPFIX implementation in Open vSwitch samples packets at a configurable
4452 rate, extracts flow information from those packets, optionally caches and
4453 aggregates the flow information, and sends the result to one or more
4458 IPFIX in Open vSwitch can be configured two different ways:
4463 With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling
4464 automatically on all packets that pass through a bridge. To configure
4465 per-bridge sampling, create an <ref table="IPFIX"/> record and point a
4466 <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/>
4467 column to it. The <ref table="Flow_Sample_Collector_Set"/> table is
4468 not used for per-bridge sampling.
4473 With <em>flow-based sampling</em>, <code>sample</code> actions in the
4474 OpenFlow flow table drive IPFIX sampling. See
4475 <code>ovs-ofctl</code>(8) for a description of the
4476 <code>sample</code> action.
4480 Flow-based sampling also requires database configuration: create a
4481 <ref table="IPFIX"/> record that describes the IPFIX configuration
4482 and a <ref table="Flow_Sample_Collector_Set"/> record that points to
4483 the <ref table="Bridge"/> whose flow table holds the
4484 <code>sample</code> actions and to <ref table="IPFIX"/> record. The
4485 <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/>
4486 table is not used for flow-based sampling.
4491 <column name="targets">
4492 IPFIX target collectors in the form
4493 <code><var>ip</var>:<var>port</var></code>.
4496 <column name="cache_active_timeout">
4497 The maximum period in seconds for which an IPFIX flow record is
4498 cached and aggregated before being sent. If not specified,
4499 defaults to 0. If 0, caching is disabled.
4502 <column name="cache_max_flows">
4503 The maximum number of IPFIX flow records that can be cached at a
4504 time. If not specified, defaults to 0. If 0, caching is
4508 <group title="Per-Bridge Sampling">
4510 These values affect only per-bridge sampling. See above for a
4511 description of the differences between per-bridge and flow-based
4515 <column name="sampling">
4516 The rate at which packets should be sampled and sent to each target
4517 collector. If not specified, defaults to 400, which means one out of
4518 400 packets, on average, will be sent to each target collector.
4521 <column name="obs_domain_id">
4522 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4523 specified, defaults to 0.
4526 <column name="obs_point_id">
4527 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4528 specified, defaults to 0.
4531 <column name="other_config" key="enable-tunnel-sampling"
4532 type='{"type": "boolean"}'>
4534 Set to <code>true</code> to enable sampling and reporting tunnel
4535 header 7-tuples in IPFIX flow records. Tunnel sampling is disabled
4540 The following enterprise entities report the sampled tunnel info:
4544 <dt>tunnelType:</dt>
4546 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4547 <p>type: unsigned 8-bit integer.</p>
4548 <p>data type semantics: identifier.</p>
4549 <p>description: Identifier of the layer 2 network overlay network
4550 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4555 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4556 <p>type: variable-length octetarray.</p>
4557 <p>data type semantics: identifier.</p>
4558 <p>description: Key which is used for identifying an individual
4559 traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI),
4560 GRE (32-bit key), or LISP (24-bit instance ID) tunnel. The
4561 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4562 ID in network byte order.</p>
4564 <dt>tunnelSourceIPv4Address:</dt>
4566 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4567 <p>type: unsigned 32-bit integer.</p>
4568 <p>data type semantics: identifier.</p>
4569 <p>description: The IPv4 source address in the tunnel IP packet
4572 <dt>tunnelDestinationIPv4Address:</dt>
4574 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4575 <p>type: unsigned 32-bit integer.</p>
4576 <p>data type semantics: identifier.</p>
4577 <p>description: The IPv4 destination address in the tunnel IP
4580 <dt>tunnelProtocolIdentifier:</dt>
4582 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4583 <p>type: unsigned 8-bit integer.</p>
4584 <p>data type semantics: identifier.</p>
4585 <p>description: The value of the protocol number in the tunnel
4586 IP packet header. The protocol number identifies the tunnel IP
4587 packet payload type.</p>
4589 <dt>tunnelSourceTransportPort:</dt>
4591 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4592 <p>type: unsigned 16-bit integer.</p>
4593 <p>data type semantics: identifier.</p>
4594 <p>description: The source port identifier in the tunnel transport
4595 header. For the transport protocols UDP, TCP, and SCTP, this is
4596 the source port number given in the respective header.</p>
4598 <dt>tunnelDestinationTransportPort:</dt>
4600 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4601 <p>type: unsigned 16-bit integer.</p>
4602 <p>data type semantics: identifier.</p>
4603 <p>description: The destination port identifier in the tunnel
4604 transport header. For the transport protocols UDP, TCP, and SCTP,
4605 this is the destination port number given in the respective header.
4611 <column name="other_config" key="enable-input-sampling"
4612 type='{"type": "boolean"}'>
4613 By default, Open vSwitch samples and reports flows at bridge port input
4614 in IPFIX flow records. Set this column to <code>false</code> to
4615 disable input sampling.
4618 <column name="other_config" key="enable-output-sampling"
4619 type='{"type": "boolean"}'>
4620 By default, Open vSwitch samples and reports flows at bridge port
4621 output in IPFIX flow records. Set this column to <code>false</code> to
4622 disable output sampling.
4626 <group title="Common Columns">
4627 The overall purpose of these columns is described under <code>Common
4628 Columns</code> at the beginning of this document.
4630 <column name="external_ids"/>
4634 <table name="Flow_Sample_Collector_Set">
4636 A set of IPFIX collectors of packet samples generated by OpenFlow
4637 <code>sample</code> actions. This table is used only for IPFIX
4638 flow-based sampling, not for per-bridge sampling (see the <ref
4639 table="IPFIX"/> table for a description of the two forms).
4643 The ID of this collector set, unique among the bridge's
4644 collector sets, to be used as the <code>collector_set_id</code>
4645 in OpenFlow <code>sample</code> actions.
4648 <column name="bridge">
4649 The bridge into which OpenFlow <code>sample</code> actions can
4650 be added to send packet samples to this set of IPFIX collectors.
4653 <column name="ipfix">
4654 Configuration of the set of IPFIX collectors to send one flow
4655 record per sampled packet to.
4658 <group title="Common Columns">
4659 The overall purpose of these columns is described under <code>Common
4660 Columns</code> at the beginning of this document.
4662 <column name="external_ids"/>
4666 <table name="AutoAttach">
4668 Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4669 draft standard describes a compact method of using IEEE 802.1AB Link
4670 Layer Discovery Protocol (LLDP) together with a IEEE 802.1aq Shortest
4671 Path Bridging (SPB) network to automatically attach network devices
4672 to individual services in a SPB network. The intent here is to allow
4673 network applications and devices using OVS to be able to easily take
4674 advantage of features offered by industry standard SPB networks.
4678 Auto Attach (AA) uses LLDP to communicate between a directly connected
4679 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4680 is extended to add two new Type-Length-Value tuples (TLVs). The first
4681 new TLV supports the ongoing discovery of directly connected AA
4682 correspondents. Auto Attach operates by regularly transmitting AA
4683 discovery TLVs between the AA client and AA server. By exchanging these
4684 discovery messages, both the AAC and AAS learn the system name and
4685 system description of their peer. In the OVS context, OVS operates as
4686 the AA client and the AA server resides on a switch at the edge of the
4691 Once AA discovery has been completed the AAC then uses the second new TLV
4692 to deliver identifier mappings from the AAC to the AAS. A primary feature
4693 of Auto Attach is to facilitate the mapping of VLANs defined outside the
4694 SPB network onto service ids (ISIDs) defined within the SPM network. By
4695 doing so individual external VLANs can be mapped onto specific SPB
4696 network services. These VLAN id to ISID mappings can be configured and
4697 managed locally using new options added to the ovs-vsctl command.
4701 The Auto Attach OVS feature does not provide a full implementation of
4702 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
4703 standard and support for the AA TLV extensions is provided. LLDP
4704 protocol support in OVS can be enabled or disabled on a port by port
4705 basis. LLDP support is disabled by default.
4708 <column name="system_name">
4709 The system_name string is exported in LLDP messages. It should uniquely
4710 identify the bridge in the network.
4713 <column name="system_description">
4714 The system_description string is exported in LLDP messages. It should
4715 describe the type of software and hardware.
4718 <column name="mappings">
4719 A mapping from SPB network Individual Service Identifier (ISID) to VLAN