1 <?xml version="1.0" encoding="utf-8"?>
2 <database name="ovs-vswitchd.conf.db" title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
75 <column name="other_config" key="stats-update-interval"
76 type='{"type": "integer", "minInteger": 5000}'>
78 Interval for updating statistics to the database, in milliseconds.
79 This option will affect the update of the <code>statistics</code>
80 column in the following tables: <code>Port</code>, <code>Interface
81 </code>, <code>Mirror</code>.
84 Default value is 5000 ms.
87 Getting statistics more frequently can be achieved via OpenFlow.
91 <column name="other_config" key="flow-restore-wait"
92 type='{"type": "boolean"}'>
94 When <code>ovs-vswitchd</code> starts up, it has an empty flow table
95 and therefore it handles all arriving packets in its default fashion
96 according to its configuration, by dropping them or sending them to
97 an OpenFlow controller or switching them as a standalone switch.
98 This behavior is ordinarily desirable. However, if
99 <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
100 then this leads to a relatively long period during which packets are
104 This option allows for improvement. When <code>ovs-vswitchd</code>
105 starts with this value set as <code>true</code>, it will neither
106 flush or expire previously set datapath flows nor will it send and
107 receive any packets to or from the datapath. When this value is
108 later set to <code>false</code>, <code>ovs-vswitchd</code> will
109 start receiving packets from the datapath and re-setup the flows.
112 Thus, with this option, the procedure for a hot-upgrade of
113 <code>ovs-vswitchd</code> becomes roughly the following:
117 Stop <code>ovs-vswitchd</code>.
120 Set <ref column="other_config" key="flow-restore-wait"/>
121 to <code>true</code>.
124 Start <code>ovs-vswitchd</code>.
127 Use <code>ovs-ofctl</code> (or some other program, such as an
128 OpenFlow controller) to restore the OpenFlow flow table
129 to the desired state.
132 Set <ref column="other_config" key="flow-restore-wait"/>
133 to <code>false</code> (or remove it entirely from the database).
137 The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
138 functions use the above config option during hot upgrades.
142 <column name="other_config" key="flow-limit"
143 type='{"type": "integer", "minInteger": 0}'>
146 number of flows allowed in the datapath flow table. Internally OVS
147 will choose a flow limit which will likely be lower than this number,
148 based on real time network conditions.
151 The default is 200000.
155 <column name="other_config" key="n-dpdk-rxqs"
156 type='{"type": "integer", "minInteger": 1}'>
158 Specifies the number of rx queues to be created for each dpdk
159 interface. If not specified or specified to 0, one rx queue will
160 be created for each dpdk interface by default.
164 <column name="other_config" key="pmd-cpu-mask">
166 Specifies CPU mask for setting the cpu affinity of PMD (Poll
167 Mode Driver) threads. Value should be in the form of hex string,
168 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
172 The lowest order bit corresponds to the first CPU core. A set bit
173 means the corresponding core is available and a pmd thread will be
174 created and pinned to it. If the input does not cover all cores,
175 those uncovered cores are considered not set.
178 If not specified, one pmd thread will be created for each numa node
179 and pinned to any available core on the numa node by default.
183 <column name="other_config" key="n-handler-threads"
184 type='{"type": "integer", "minInteger": 1}'>
186 Specifies the number of threads for software datapaths to use for
187 handling new flows. The default the number of online CPU cores minus
188 the number of revalidators.
191 This configuration is per datapath. If you have more than one
192 software datapath (e.g. some <code>system</code> bridges and some
193 <code>netdev</code> bridges), then the total number of threads is
194 <code>n-handler-threads</code> times the number of software
199 <column name="other_config" key="n-revalidator-threads"
200 type='{"type": "integer", "minInteger": 1}'>
202 Specifies the number of threads for software datapaths to use for
203 revalidating flows in the datapath. Typically, there is a direct
204 correlation between the number of revalidator threads, and the number
205 of flows allowed in the datapath. The default is the number of cpu
206 cores divided by four plus one. If <code>n-handler-threads</code> is
207 set, the default changes to the number of cpu cores minus the number
211 This configuration is per datapath. If you have more than one
212 software datapath (e.g. some <code>system</code> bridges and some
213 <code>netdev</code> bridges), then the total number of threads is
214 <code>n-handler-threads</code> times the number of software
220 <group title="Status">
221 <column name="next_cfg">
222 Sequence number for client to increment. When a client modifies
223 any part of the database configuration and wishes to wait for
224 Open vSwitch to finish applying the changes, it may increment
225 this sequence number.
228 <column name="cur_cfg">
229 Sequence number that Open vSwitch sets to the current value of
230 <ref column="next_cfg"/> after it finishes applying a set of
231 configuration changes.
234 <group title="Statistics">
236 The <code>statistics</code> column contains key-value pairs that
237 report statistics about a system running an Open vSwitch. These are
238 updated periodically (currently, every 5 seconds). Key-value pairs
239 that cannot be determined or that do not apply to a platform are
243 <column name="other_config" key="enable-statistics"
244 type='{"type": "boolean"}'>
245 Statistics are disabled by default to avoid overhead in the common
246 case when statistics gathering is not useful. Set this value to
247 <code>true</code> to enable populating the <ref column="statistics"/>
248 column or to <code>false</code> to explicitly disable it.
251 <column name="statistics" key="cpu"
252 type='{"type": "integer", "minInteger": 1}'>
254 Number of CPU processors, threads, or cores currently online and
255 available to the operating system on which Open vSwitch is running,
256 as an integer. This may be less than the number installed, if some
257 are not online or if they are not available to the operating
261 Open vSwitch userspace processes are not multithreaded, but the
262 Linux kernel-based datapath is.
266 <column name="statistics" key="load_average">
267 A comma-separated list of three floating-point numbers,
268 representing the system load average over the last 1, 5, and 15
269 minutes, respectively.
272 <column name="statistics" key="memory">
274 A comma-separated list of integers, each of which represents a
275 quantity of memory in kilobytes that describes the operating
276 system on which Open vSwitch is running. In respective order,
281 <li>Total amount of RAM allocated to the OS.</li>
282 <li>RAM allocated to the OS that is in use.</li>
283 <li>RAM that can be flushed out to disk or otherwise discarded
284 if that space is needed for another purpose. This number is
285 necessarily less than or equal to the previous value.</li>
286 <li>Total disk space allocated for swap.</li>
287 <li>Swap space currently in use.</li>
291 On Linux, all five values can be determined and are included. On
292 other operating systems, only the first two values can be
293 determined, so the list will only have two values.
297 <column name="statistics" key="process_NAME">
299 One such key-value pair, with <code>NAME</code> replaced by
300 a process name, will exist for each running Open vSwitch
301 daemon process, with <var>name</var> replaced by the
302 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
303 value is a comma-separated list of integers. The integers
304 represent the following, with memory measured in kilobytes
305 and durations in milliseconds:
309 <li>The process's virtual memory size.</li>
310 <li>The process's resident set size.</li>
311 <li>The amount of user and system CPU time consumed by the
313 <li>The number of times that the process has crashed and been
314 automatically restarted by the monitor.</li>
315 <li>The duration since the process was started.</li>
316 <li>The duration for which the process has been running.</li>
320 The interpretation of some of these values depends on whether the
321 process was started with the <option>--monitor</option>. If it
322 was not, then the crash count will always be 0 and the two
323 durations will always be the same. If <option>--monitor</option>
324 was given, then the crash count may be positive; if it is, the
325 latter duration is the amount of time since the most recent crash
330 There will be one key-value pair for each file in Open vSwitch's
331 ``run directory'' (usually <code>/var/run/openvswitch</code>)
332 whose name ends in <code>.pid</code>, whose contents are a
333 process ID, and which is locked by a running process. The
334 <var>name</var> is taken from the pidfile's name.
338 Currently Open vSwitch is only able to obtain all of the above
339 detail on Linux systems. On other systems, the same key-value
340 pairs will be present but the values will always be the empty
345 <column name="statistics" key="file_systems">
347 A space-separated list of information on local, writable file
348 systems. Each item in the list describes one file system and
349 consists in turn of a comma-separated list of the following:
353 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
354 Any spaces or commas in the mount point are replaced by
356 <li>Total size, in kilobytes, as an integer.</li>
357 <li>Amount of storage in use, in kilobytes, as an integer.</li>
361 This key-value pair is omitted if there are no local, writable
362 file systems or if Open vSwitch cannot obtain the needed
369 <group title="Version Reporting">
371 These columns report the types and versions of the hardware and
372 software running Open vSwitch. We recommend in general that software
373 should test whether specific features are supported instead of relying
374 on version number checks. These values are primarily intended for
375 reporting to human administrators.
378 <column name="ovs_version">
379 The Open vSwitch version number, e.g. <code>1.1.0</code>.
382 <column name="db_version">
384 The database schema version number in the form
385 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
386 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
387 a non-backward compatible way (e.g. deleting a column or a table),
388 <var>major</var> is incremented. When the database schema is changed
389 in a backward compatible way (e.g. adding a new column),
390 <var>minor</var> is incremented. When the database schema is changed
391 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
396 The schema version is part of the database schema, so it can also be
397 retrieved by fetching the schema using the Open vSwitch database
402 <column name="system_type">
404 An identifier for the type of system on top of which Open vSwitch
405 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
408 System integrators are responsible for choosing and setting an
409 appropriate value for this column.
413 <column name="system_version">
415 The version of the system identified by <ref column="system_type"/>,
416 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
419 System integrators are responsible for choosing and setting an
420 appropriate value for this column.
426 <group title="Capabilities">
428 These columns report capabilities of the Open vSwitch instance.
430 <column name="datapath_types">
432 This column reports the different dpifs registered with the system.
433 These are the values that this instance supports in the <ref
434 column="datapath_type" table="Bridge"/> column of the <ref
435 table="Bridge"/> table.
438 <column name="iface_types">
440 This column reports the different netdevs registered with the system.
441 These are the values that this instance supports in the <ref
442 column="type" table="Interface"/> column of the <ref
443 table="Interface"/> table.
448 <group title="Database Configuration">
450 These columns primarily configure the Open vSwitch database
451 (<code>ovsdb-server</code>), not the Open vSwitch switch
452 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
453 column="ssl"/> settings.
457 The Open vSwitch switch does read the database configuration to
458 determine remote IP addresses to which in-band control should apply.
461 <column name="manager_options">
462 Database clients to which the Open vSwitch database server should
463 connect or to which it should listen, along with options for how these
464 connection should be configured. See the <ref table="Manager"/> table
465 for more information.
469 <group title="Common Columns">
470 The overall purpose of these columns is described under <code>Common
471 Columns</code> at the beginning of this document.
473 <column name="other_config"/>
474 <column name="external_ids"/>
478 <table name="Bridge">
480 Configuration for a bridge within an
481 <ref table="Open_vSwitch"/>.
484 A <ref table="Bridge"/> record represents an Ethernet switch with one or
485 more ``ports,'' which are the <ref table="Port"/> records pointed to by
486 the <ref table="Bridge"/>'s <ref column="ports"/> column.
489 <group title="Core Features">
491 Bridge identifier. Should be alphanumeric and no more than about 8
492 bytes long. Must be unique among the names of ports, interfaces, and
496 <column name="ports">
497 Ports included in the bridge.
500 <column name="mirrors">
501 Port mirroring configuration.
504 <column name="netflow">
505 NetFlow configuration.
508 <column name="sflow">
509 sFlow(R) configuration.
512 <column name="ipfix">
516 <column name="flood_vlans">
518 VLAN IDs of VLANs on which MAC address learning should be disabled,
519 so that packets are flooded instead of being sent to specific ports
520 that are believed to contain packets' destination MACs. This should
521 ordinarily be used to disable MAC learning on VLANs used for
522 mirroring (RSPAN VLANs). It may also be useful for debugging.
525 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
526 the <ref table="Port"/> table) is incompatible with
527 <code>flood_vlans</code>. Consider using another bonding mode or
528 a different type of mirror instead.
532 <column name="auto_attach">
533 Auto Attach configuration.
537 <group title="OpenFlow Configuration">
538 <column name="controller">
540 OpenFlow controller set. If unset, then no OpenFlow controllers
545 If there are primary controllers, removing all of them clears the
546 flow table. If there are no primary controllers, adding one also
547 clears the flow table. Other changes to the set of controllers, such
548 as adding or removing a service controller, adding another primary
549 controller to supplement an existing primary controller, or removing
550 only one of two primary controllers, have no effect on the flow
555 <column name="flow_tables">
556 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
557 table ID to configuration for that table.
560 <column name="fail_mode">
561 <p>When a controller is configured, it is, ordinarily, responsible
562 for setting up all flows on the switch. Thus, if the connection to
563 the controller fails, no new network connections can be set up.
564 If the connection to the controller stays down long enough,
565 no packets can pass through the switch at all. This setting
566 determines the switch's response to such a situation. It may be set
567 to one of the following:
569 <dt><code>standalone</code></dt>
570 <dd>If no message is received from the controller for three
571 times the inactivity probe interval
572 (see <ref column="inactivity_probe"/>), then Open vSwitch
573 will take over responsibility for setting up flows. In
574 this mode, Open vSwitch causes the bridge to act like an
575 ordinary MAC-learning switch. Open vSwitch will continue
576 to retry connecting to the controller in the background
577 and, when the connection succeeds, it will discontinue its
578 standalone behavior.</dd>
579 <dt><code>secure</code></dt>
580 <dd>Open vSwitch will not set up flows on its own when the
581 controller connection fails or when no controllers are
582 defined. The bridge will continue to retry connecting to
583 any defined controllers forever.</dd>
587 The default is <code>standalone</code> if the value is unset, but
588 future versions of Open vSwitch may change the default.
591 The <code>standalone</code> mode can create forwarding loops on a
592 bridge that has more than one uplink port unless STP is enabled. To
593 avoid loops on such a bridge, configure <code>secure</code> mode or
594 enable STP (see <ref column="stp_enable"/>).
596 <p>When more than one controller is configured,
597 <ref column="fail_mode"/> is considered only when none of the
598 configured controllers can be contacted.</p>
600 Changing <ref column="fail_mode"/> when no primary controllers are
601 configured clears the flow table.
605 <column name="datapath_id">
606 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
607 (Setting this column has no useful effect. Set <ref
608 column="other-config" key="datapath-id"/> instead.)
611 <column name="datapath_version">
613 Reports the version number of the Open vSwitch datapath in use.
614 This allows management software to detect and report discrepancies
615 between Open vSwitch userspace and datapath versions. (The <ref
616 column="ovs_version" table="Open_vSwitch"/> column in the <ref
617 table="Open_vSwitch"/> reports the Open vSwitch userspace version.)
618 The version reported depends on the datapath in use:
623 When the kernel module included in the Open vSwitch source tree is
624 used, this column reports the Open vSwitch version from which the
629 When the kernel module that is part of the upstream Linux kernel is
630 used, this column reports <code><unknown></code>.
634 When the datapath is built into the <code>ovs-vswitchd</code>
635 binary, this column reports <code><built-in></code>. A
636 built-in datapath is by definition the same version as the rest of
637 the Open VSwitch userspace.
641 Other datapaths (such as the Hyper-V kernel datapath) currently
642 report <code><unknown></code>.
647 A version discrepancy between <code>ovs-vswitchd</code> and the
648 datapath in use is not normally cause for alarm. The Open vSwitch
649 kernel datapaths for Linux and Hyper-V, in particular, are designed
650 for maximum inter-version compatibility: any userspace version works
651 with with any kernel version. Some reasons do exist to insist on
652 particular user/kernel pairings. First, newer kernel versions add
653 new features, that can only be used by new-enough userspace, e.g.
654 VXLAN tunneling requires certain minimal userspace and kernel
655 versions. Second, as an extension to the first reason, some newer
656 kernel versions add new features for enhancing performance that only
657 new-enough userspace versions can take advantage of.
661 <column name="other_config" key="datapath-id">
662 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
663 value. May not be all-zero.
666 <column name="other_config" key="dp-desc">
667 Human readable description of datapath. It it a maximum 256
668 byte-long free-form string to describe the datapath for
669 debugging purposes, e.g. <code>switch3 in room 3120</code>.
672 <column name="other_config" key="disable-in-band"
673 type='{"type": "boolean"}'>
674 If set to <code>true</code>, disable in-band control on the bridge
675 regardless of controller and manager settings.
678 <column name="other_config" key="in-band-queue"
679 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
680 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
681 that will be used by flows set up by in-band control on this bridge.
682 If unset, or if the port used by an in-band control flow does not have
683 QoS configured, or if the port does not have a queue with the specified
684 ID, the default queue is used instead.
687 <column name="protocols">
689 List of OpenFlow protocols that may be used when negotiating
690 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
691 1.3 are enabled by default if this column is empty.
695 OpenFlow 1.4 is not enabled by default because its implementation is
700 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
701 experimental because the OpenFlow 1.5 specification is still under
702 development and thus subject to change. Pass
703 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
704 OpenFlow 1.5 to be enabled.
709 <group title="Spanning Tree Configuration">
711 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
712 that ensures loop-free topologies. It allows redundant links to
713 be included in the network to provide automatic backup paths if
714 the active links fails.
718 These settings configure the slower-to-converge but still widely
719 supported version of Spanning Tree Protocol, sometimes known as
720 802.1D-1998. Open vSwitch also supports the newer Rapid Spanning Tree
721 Protocol (RSTP), documented later in the section titled <code>Rapid
722 Spanning Tree Configuration</code>.
725 <group title="STP Configuration">
726 <column name="stp_enable" type='{"type": "boolean"}'>
728 Enable spanning tree on the bridge. By default, STP is disabled
729 on bridges. Bond, internal, and mirror ports are not supported
730 and will not participate in the spanning tree.
734 STP and RSTP are mutually exclusive. If both are enabled, RSTP
739 <column name="other_config" key="stp-system-id">
740 The bridge's STP identifier (the lower 48 bits of the bridge-id)
742 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
743 By default, the identifier is the MAC address of the bridge.
746 <column name="other_config" key="stp-priority"
747 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
748 The bridge's relative priority value for determining the root
749 bridge (the upper 16 bits of the bridge-id). A bridge with the
750 lowest bridge-id is elected the root. By default, the priority
754 <column name="other_config" key="stp-hello-time"
755 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
756 The interval between transmissions of hello messages by
757 designated ports, in seconds. By default the hello interval is
761 <column name="other_config" key="stp-max-age"
762 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
763 The maximum age of the information transmitted by the bridge
764 when it is the root bridge, in seconds. By default, the maximum
768 <column name="other_config" key="stp-forward-delay"
769 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
770 The delay to wait between transitioning root and designated
771 ports to <code>forwarding</code>, in seconds. By default, the
772 forwarding delay is 15 seconds.
775 <column name="other_config" key="mcast-snooping-aging-time"
776 type='{"type": "integer", "minInteger": 1}'>
778 The maximum number of seconds to retain a multicast snooping entry for
779 which no packets have been seen. The default is currently 300
780 seconds (5 minutes). The value, if specified, is forced into a
781 reasonable range, currently 15 to 3600 seconds.
785 <column name="other_config" key="mcast-snooping-table-size"
786 type='{"type": "integer", "minInteger": 1}'>
788 The maximum number of multicast snooping addresses to learn. The
789 default is currently 2048. The value, if specified, is forced into
790 a reasonable range, currently 10 to 1,000,000.
793 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
794 type='{"type": "boolean"}'>
796 If set to <code>false</code>, unregistered multicast packets are forwarded
798 If set to <code>true</code>, unregistered multicast packets are forwarded
799 to ports connected to multicast routers.
804 <group title="STP Status">
806 These key-value pairs report the status of 802.1D-1998. They are
807 present only if STP is enabled (via the <ref column="stp_enable"/>
810 <column name="status" key="stp_bridge_id">
811 The bridge ID used in spanning tree advertisements, in the form
812 <var>xxxx</var>.<var>yyyyyyyyyyyy</var> where the <var>x</var>s are
813 the STP priority, the <var>y</var>s are the STP system ID, and each
814 <var>x</var> and <var>y</var> is a hex digit.
816 <column name="status" key="stp_designated_root">
817 The designated root for this spanning tree, in the same form as <ref
818 column="status" key="stp_bridge_id"/>. If this bridge is the root,
819 this will have the same value as <ref column="status"
820 key="stp_bridge_id"/>, otherwise it will differ.
822 <column name="status" key="stp_root_path_cost">
823 The path cost of reaching the designated bridge. A lower number is
824 better. The value is 0 if this bridge is the root, otherwise it is
830 <group title="Rapid Spanning Tree">
832 Rapid Spanning Tree Protocol (RSTP), like STP, is a network protocol
833 that ensures loop-free topologies. RSTP superseded STP with the
834 publication of 802.1D-2004. Compared to STP, RSTP converges more
835 quickly and recovers more quickly from failures.
838 <group title="RSTP Configuration">
839 <column name="rstp_enable" type='{"type": "boolean"}'>
841 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
842 on bridges. Bond, internal, and mirror ports are not supported
843 and will not participate in the spanning tree.
847 STP and RSTP are mutually exclusive. If both are enabled, RSTP
852 <column name="other_config" key="rstp-address">
853 The bridge's RSTP address (the lower 48 bits of the bridge-id)
855 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
856 By default, the address is the MAC address of the bridge.
859 <column name="other_config" key="rstp-priority"
860 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
861 The bridge's relative priority value for determining the root
862 bridge (the upper 16 bits of the bridge-id). A bridge with the
863 lowest bridge-id is elected the root. By default, the priority
864 is 0x8000 (32768). This value needs to be a multiple of 4096,
865 otherwise it's rounded to the nearest inferior one.
868 <column name="other_config" key="rstp-ageing-time"
869 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
870 The Ageing Time parameter for the Bridge. The default value
874 <column name="other_config" key="rstp-force-protocol-version"
875 type='{"type": "integer"}'>
876 The Force Protocol Version parameter for the Bridge. This
877 can take the value 0 (STP Compatibility mode) or 2
878 (the default, normal operation).
881 <column name="other_config" key="rstp-max-age"
882 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
883 The maximum age of the information transmitted by the Bridge
884 when it is the Root Bridge. The default value is 20.
887 <column name="other_config" key="rstp-forward-delay"
888 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
889 The delay used by STP Bridges to transition Root and Designated
890 Ports to Forwarding. The default value is 15.
893 <column name="other_config" key="rstp-transmit-hold-count"
894 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
895 The Transmit Hold Count used by the Port Transmit state machine
896 to limit transmission rate. The default value is 6.
900 <group title="RSTP Status">
902 These key-value pairs report the status of 802.1D-2004. They are
903 present only if RSTP is enabled (via the <ref column="rstp_enable"/>
906 <column name="rstp_status" key="rstp_bridge_id">
907 The bridge ID used in rapid spanning tree advertisements, in the form
908 <var>x</var>.<var>yyy</var>.<var>zzzzzzzzzzzz</var> where
909 <var>x</var> is the RSTP priority, the <var>y</var>s are a locally
910 assigned system ID extension, the <var>z</var>s are the STP system
911 ID, and each <var>x</var>, <var>y</var>, or <var>z</var> is a hex
914 <column name="rstp_status" key="rstp_root_id">
915 The root of this spanning tree, in the same form as <ref
916 column="rstp_status" key="rstp_bridge_id"/>. If this bridge is the
917 root, this will have the same value as <ref column="rstp_status"
918 key="rstp_bridge_id"/>, otherwise it will differ.
920 <column name="rstp_status" key="rstp_root_path_cost"
921 type='{"type": "integer", "minInteger": 0}'>
922 The path cost of reaching the root. A lower number is better. The
923 value is 0 if this bridge is the root, otherwise it is higher.
925 <column name="rstp_status" key="rstp_designated_id">
926 The RSTP designated ID, in the same form as <ref column="rstp_status"
927 key="rstp_bridge_id"/>.
929 <column name="rstp_status" key="rstp_designated_port_id">
930 The RSTP designated port ID, as a 4-digit hex number.
932 <column name="rstp_status" key="rstp_bridge_port_id">
933 The RSTP bridge port ID, as a 4-digit hex number.
938 <group title="Multicast Snooping Configuration">
939 Multicast snooping (RFC 4541) monitors the Internet Group Management
940 Protocol (IGMP) traffic between hosts and multicast routers. The
941 switch uses what IGMP snooping learns to forward multicast traffic
942 only to interfaces that are connected to interested receivers.
943 Currently it supports IGMPv1 and IGMPv2 protocols.
945 <column name="mcast_snooping_enable">
946 Enable multicast snooping on the bridge. For now, the default
951 <group title="Other Features">
952 <column name="datapath_type">
953 Name of datapath provider. The kernel datapath has type
954 <code>system</code>. The userspace datapath has type
955 <code>netdev</code>. A manager may refer to the <ref
956 table="Open_vSwitch" column="datapath_types"/> column of the <ref
957 table="Open_vSwitch"/> table for a list of the types accepted by this
958 Open vSwitch instance.
961 <column name="external_ids" key="bridge-id">
962 A unique identifier of the bridge. On Citrix XenServer this will
963 commonly be the same as
964 <ref column="external_ids" key="xs-network-uuids"/>.
967 <column name="external_ids" key="xs-network-uuids">
968 Semicolon-delimited set of universally unique identifier(s) for the
969 network with which this bridge is associated on a Citrix XenServer
970 host. The network identifiers are RFC 4122 UUIDs as displayed by,
971 e.g., <code>xe network-list</code>.
974 <column name="other_config" key="hwaddr">
975 An Ethernet address in the form
976 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
977 to set the hardware address of the local port and influence the
981 <column name="other_config" key="forward-bpdu"
982 type='{"type": "boolean"}'>
983 Option to allow forwarding of BPDU frames when NORMAL action is
984 invoked. Frames with reserved Ethernet addresses (e.g. STP
985 BPDU) will be forwarded when this option is enabled and the
986 switch is not providing that functionality. If STP is enabled
987 on the port, STP BPDUs will never be forwarded. If the Open
988 vSwitch bridge is used to connect different Ethernet networks,
989 and if Open vSwitch node does not run STP, then this option
990 should be enabled. Default is disabled, set to
991 <code>true</code> to enable.
993 The following destination MAC addresss will not be forwarded when this
996 <dt><code>01:80:c2:00:00:00</code></dt>
997 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
999 <dt><code>01:80:c2:00:00:01</code></dt>
1000 <dd>IEEE Pause frame.</dd>
1002 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1003 <dd>Other reserved protocols.</dd>
1005 <dt><code>00:e0:2b:00:00:00</code></dt>
1006 <dd>Extreme Discovery Protocol (EDP).</dd>
1009 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
1011 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
1013 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1015 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1016 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1020 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1021 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1023 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1024 <dd>Cisco STP Uplink Fast.</dd>
1026 <dt><code>01:00:0c:00:00:00</code></dt>
1027 <dd>Cisco Inter Switch Link.</dd>
1029 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
1034 <column name="other_config" key="mac-aging-time"
1035 type='{"type": "integer", "minInteger": 1}'>
1037 The maximum number of seconds to retain a MAC learning entry for
1038 which no packets have been seen. The default is currently 300
1039 seconds (5 minutes). The value, if specified, is forced into a
1040 reasonable range, currently 15 to 3600 seconds.
1044 A short MAC aging time allows a network to more quickly detect that a
1045 host is no longer connected to a switch port. However, it also makes
1046 it more likely that packets will be flooded unnecessarily, when they
1047 are addressed to a connected host that rarely transmits packets. To
1048 reduce the incidence of unnecessary flooding, use a MAC aging time
1049 longer than the maximum interval at which a host will ordinarily
1054 <column name="other_config" key="mac-table-size"
1055 type='{"type": "integer", "minInteger": 1}'>
1057 The maximum number of MAC addresses to learn. The default is
1058 currently 2048. The value, if specified, is forced into a reasonable
1059 range, currently 10 to 1,000,000.
1064 <group title="Common Columns">
1065 The overall purpose of these columns is described under <code>Common
1066 Columns</code> at the beginning of this document.
1068 <column name="other_config"/>
1069 <column name="external_ids"/>
1073 <table name="Port" table="Port or bond configuration.">
1074 <p>A port within a <ref table="Bridge"/>.</p>
1075 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1076 <ref column="interfaces"/> column. Such a port logically
1077 corresponds to a port on a physical Ethernet switch. A port
1078 with more than one interface is a ``bonded port'' (see
1079 <ref group="Bonding Configuration"/>).</p>
1080 <p>Some properties that one might think as belonging to a port are actually
1081 part of the port's <ref table="Interface"/> members.</p>
1083 <column name="name">
1084 Port name. Should be alphanumeric and no more than about 8
1085 bytes long. May be the same as the interface name, for
1086 non-bonded ports. Must otherwise be unique among the names of
1087 ports, interfaces, and bridges on a host.
1090 <column name="interfaces">
1091 The port's interfaces. If there is more than one, this is a
1095 <group title="VLAN Configuration">
1096 <p>Bridge ports support the following types of VLAN configuration:</p>
1101 A trunk port carries packets on one or more specified VLANs
1102 specified in the <ref column="trunks"/> column (often, on every
1103 VLAN). A packet that ingresses on a trunk port is in the VLAN
1104 specified in its 802.1Q header, or VLAN 0 if the packet has no
1105 802.1Q header. A packet that egresses through a trunk port will
1106 have an 802.1Q header if it has a nonzero VLAN ID.
1110 Any packet that ingresses on a trunk port tagged with a VLAN that
1111 the port does not trunk is dropped.
1118 An access port carries packets on exactly one VLAN specified in the
1119 <ref column="tag"/> column. Packets egressing on an access port
1120 have no 802.1Q header.
1124 Any packet with an 802.1Q header with a nonzero VLAN ID that
1125 ingresses on an access port is dropped, regardless of whether the
1126 VLAN ID in the header is the access port's VLAN ID.
1130 <dt>native-tagged</dt>
1132 A native-tagged port resembles a trunk port, with the exception that
1133 a packet without an 802.1Q header that ingresses on a native-tagged
1134 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1138 <dt>native-untagged</dt>
1140 A native-untagged port resembles a native-tagged port, with the
1141 exception that a packet that egresses on a native-untagged port in
1142 the native VLAN will not have an 802.1Q header.
1146 A packet will only egress through bridge ports that carry the VLAN of
1147 the packet, as described by the rules above.
1150 <column name="vlan_mode">
1152 The VLAN mode of the port, as described above. When this column is
1153 empty, a default mode is selected as follows:
1157 If <ref column="tag"/> contains a value, the port is an access
1158 port. The <ref column="trunks"/> column should be empty.
1161 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1162 column value is honored if it is present.
1169 For an access port, the port's implicitly tagged VLAN. For a
1170 native-tagged or native-untagged port, the port's native VLAN. Must
1171 be empty if this is a trunk port.
1175 <column name="trunks">
1177 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1178 or VLANs that this port trunks; if it is empty, then the port trunks
1179 all VLANs. Must be empty if this is an access port.
1182 A native-tagged or native-untagged port always trunks its native
1183 VLAN, regardless of whether <ref column="trunks"/> includes that
1188 <column name="other_config" key="priority-tags"
1189 type='{"type": "boolean"}'>
1191 An 802.1Q header contains two important pieces of information: a VLAN
1192 ID and a priority. A frame with a zero VLAN ID, called a
1193 ``priority-tagged'' frame, is supposed to be treated the same way as
1194 a frame without an 802.1Q header at all (except for the priority).
1198 However, some network elements ignore any frame that has 802.1Q
1199 header at all, even when the VLAN ID is zero. Therefore, by default
1200 Open vSwitch does not output priority-tagged frames, instead omitting
1201 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1202 <code>true</code> to enable priority-tagged frames on a port.
1206 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1207 output if both the VLAN ID and priority would be zero.
1211 All frames output to native-tagged ports have a nonzero VLAN ID, so
1212 this setting is not meaningful on native-tagged ports.
1217 <group title="Bonding Configuration">
1218 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1219 allows for load balancing and fail-over.</p>
1222 The following types of bonding will work with any kind of upstream
1223 switch. On the upstream switch, do not configure the interfaces as a
1228 <dt><code>balance-slb</code></dt>
1230 Balances flows among slaves based on source MAC address and output
1231 VLAN, with periodic rebalancing as traffic patterns change.
1234 <dt><code>active-backup</code></dt>
1236 Assigns all flows to one slave, failing over to a backup slave when
1237 the active slave is disabled. This is the only bonding mode in which
1238 interfaces may be plugged into different upstream switches.
1243 The following modes require the upstream switch to support 802.3ad with
1244 successful LACP negotiation. If LACP negotiation fails and
1245 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1250 <dt><code>balance-tcp</code></dt>
1252 Balances flows among slaves based on L2, L3, and L4 protocol
1253 information such as destination MAC address, IP address, and TCP
1258 <p>These columns apply only to bonded ports. Their values are
1259 otherwise ignored.</p>
1261 <column name="bond_mode">
1262 <p>The type of bonding used for a bonded port. Defaults to
1263 <code>active-backup</code> if unset.
1267 <column name="other_config" key="bond-hash-basis"
1268 type='{"type": "integer"}'>
1269 An integer hashed along with flows when choosing output slaves in load
1270 balanced bonds. When changed, all flows will be assigned different
1271 hash values possibly causing slave selection decisions to change. Does
1272 not affect bonding modes which do not employ load balancing such as
1273 <code>active-backup</code>.
1276 <group title="Link Failure Detection">
1278 An important part of link bonding is detecting that links are down so
1279 that they may be disabled. These settings determine how Open vSwitch
1280 detects link failure.
1283 <column name="other_config" key="bond-detect-mode"
1284 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1285 The means used to detect link failures. Defaults to
1286 <code>carrier</code> which uses each interface's carrier to detect
1287 failures. When set to <code>miimon</code>, will check for failures
1288 by polling each interface's MII.
1291 <column name="other_config" key="bond-miimon-interval"
1292 type='{"type": "integer"}'>
1293 The interval, in milliseconds, between successive attempts to poll
1294 each interface's MII. Relevant only when <ref column="other_config"
1295 key="bond-detect-mode"/> is <code>miimon</code>.
1298 <column name="bond_updelay">
1300 The number of milliseconds for which the link must stay up on an
1301 interface before the interface is considered to be up. Specify
1302 <code>0</code> to enable the interface immediately.
1306 This setting is honored only when at least one bonded interface is
1307 already enabled. When no interfaces are enabled, then the first
1308 bond interface to come up is enabled immediately.
1312 <column name="bond_downdelay">
1313 The number of milliseconds for which the link must stay down on an
1314 interface before the interface is considered to be down. Specify
1315 <code>0</code> to disable the interface immediately.
1319 <group title="LACP Configuration">
1321 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1322 allows switches to automatically detect that they are connected by
1323 multiple links and aggregate across those links. These settings
1324 control LACP behavior.
1327 <column name="lacp">
1328 Configures LACP on this port. LACP allows directly connected
1329 switches to negotiate which links may be bonded. LACP may be enabled
1330 on non-bonded ports for the benefit of any switches they may be
1331 connected to. <code>active</code> ports are allowed to initiate LACP
1332 negotiations. <code>passive</code> ports are allowed to participate
1333 in LACP negotiations initiated by a remote switch, but not allowed to
1334 initiate such negotiations themselves. If LACP is enabled on a port
1335 whose partner switch does not support LACP, the bond will be
1336 disabled, unless other-config:lacp-fallback-ab is set to true.
1337 Defaults to <code>off</code> if unset.
1340 <column name="other_config" key="lacp-system-id">
1341 The LACP system ID of this <ref table="Port"/>. The system ID of a
1342 LACP bond is used to identify itself to its partners. Must be a
1343 nonzero MAC address. Defaults to the bridge Ethernet address if
1347 <column name="other_config" key="lacp-system-priority"
1348 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1349 The LACP system priority of this <ref table="Port"/>. In LACP
1350 negotiations, link status decisions are made by the system with the
1351 numerically lower priority.
1354 <column name="other_config" key="lacp-time"
1355 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1357 The LACP timing which should be used on this <ref table="Port"/>.
1358 By default <code>slow</code> is used. When configured to be
1359 <code>fast</code> LACP heartbeats are requested at a rate of once
1360 per second causing connectivity problems to be detected more
1361 quickly. In <code>slow</code> mode, heartbeats are requested at a
1362 rate of once every 30 seconds.
1366 <column name="other_config" key="lacp-fallback-ab"
1367 type='{"type": "boolean"}'>
1369 Determines the behavior of openvswitch bond in LACP mode. If
1370 the partner switch does not support LACP, setting this option
1371 to <code>true</code> allows openvswitch to fallback to
1372 active-backup. If the option is set to <code>false</code>, the
1373 bond will be disabled. In both the cases, once the partner switch
1374 is configured to LACP mode, the bond will use LACP.
1379 <group title="Rebalancing Configuration">
1381 These settings control behavior when a bond is in
1382 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1385 <column name="other_config" key="bond-rebalance-interval"
1386 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1387 For a load balanced bonded port, the number of milliseconds between
1388 successive attempts to rebalance the bond, that is, to move flows
1389 from one interface on the bond to another in an attempt to keep usage
1390 of each interface roughly equal. If zero, load balancing is disabled
1391 on the bond (link failure still cause flows to move). If
1392 less than 1000ms, the rebalance interval will be 1000ms.
1396 <column name="bond_fake_iface">
1397 For a bonded port, whether to create a fake internal interface with the
1398 name of the port. Use only for compatibility with legacy software that
1403 <group title="Spanning Tree Protocol">
1405 The configuration here is only meaningful, and the status is only
1406 populated, when 802.1D-1998 Spanning Tree Protocol is enabled on the
1407 port's <ref column="Bridge"/> with its <ref column="stp_enable"/>
1411 <group title="STP Configuration">
1412 <column name="other_config" key="stp-enable"
1413 type='{"type": "boolean"}'>
1414 When STP is enabled on a bridge, it is enabled by default on all of
1415 the bridge's ports except bond, internal, and mirror ports (which do
1416 not work with STP). If this column's value is <code>false</code>,
1417 STP is disabled on the port.
1420 <column name="other_config" key="stp-port-num"
1421 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1422 The port number used for the lower 8 bits of the port-id. By
1423 default, the numbers will be assigned automatically. If any
1424 port's number is manually configured on a bridge, then they
1428 <column name="other_config" key="stp-port-priority"
1429 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1430 The port's relative priority value for determining the root
1431 port (the upper 8 bits of the port-id). A port with a lower
1432 port-id will be chosen as the root port. By default, the
1436 <column name="other_config" key="stp-path-cost"
1437 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1438 Spanning tree path cost for the port. A lower number indicates
1439 a faster link. By default, the cost is based on the maximum
1444 <group title="STP Status">
1445 <column name="status" key="stp_port_id">
1446 The port ID used in spanning tree advertisements for this port, as 4
1447 hex digits. Configuring the port ID is described in the
1448 <code>stp-port-num</code> and <code>stp-port-priority</code> keys of
1449 the <code>other_config</code> section earlier.
1451 <column name="status" key="stp_state"
1452 type='{"type": "string", "enum": ["set",
1453 ["disabled", "listening", "learning",
1454 "forwarding", "blocking"]]}'>
1455 STP state of the port.
1457 <column name="status" key="stp_sec_in_state"
1458 type='{"type": "integer", "minInteger": 0}'>
1459 The amount of time this port has been in the current STP state, in
1462 <column name="status" key="stp_role"
1463 type='{"type": "string", "enum": ["set",
1464 ["root", "designated", "alternate"]]}'>
1465 STP role of the port.
1470 <group title="Rapid Spanning Tree Protocol">
1472 The configuration here is only meaningful, and the status and
1473 statistics are only populated, when 802.1D-1998 Spanning Tree Protocol
1474 is enabled on the port's <ref column="Bridge"/> with its <ref
1475 column="stp_enable"/> column.
1478 <group title="RSTP Configuration">
1479 <column name="other_config" key="rstp-enable"
1480 type='{"type": "boolean"}'>
1481 When RSTP is enabled on a bridge, it is enabled by default on all of
1482 the bridge's ports except bond, internal, and mirror ports (which do
1483 not work with RSTP). If this column's value is <code>false</code>,
1484 RSTP is disabled on the port.
1487 <column name="other_config" key="rstp-port-priority"
1488 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1489 The port's relative priority value for determining the root port, in
1490 multiples of 16. By default, the port priority is 0x80 (128). Any
1491 value in the lower 4 bits is rounded off. The significant upper 4
1492 bits become the upper 4 bits of the port-id. A port with the lowest
1493 port-id is elected as the root.
1496 <column name="other_config" key="rstp-port-num"
1497 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1498 The local RSTP port number, used as the lower 12 bits of the port-id.
1499 By default the port numbers are assigned automatically, and typically
1500 may not correspond to the OpenFlow port numbers. A port with the
1501 lowest port-id is elected as the root.
1504 <column name="other_config" key="rstp-port-path-cost"
1505 type='{"type": "integer"}'>
1506 The port path cost. The Port's contribution, when it is
1507 the Root Port, to the Root Path Cost for the Bridge. By default the
1508 cost is automatically calculated from the port's speed.
1511 <column name="other_config" key="rstp-port-admin-edge"
1512 type='{"type": "boolean"}'>
1513 The admin edge port parameter for the Port. Default is
1517 <column name="other_config" key="rstp-port-auto-edge"
1518 type='{"type": "boolean"}'>
1519 The auto edge port parameter for the Port. Default is
1523 <column name="other_config" key="rstp-port-mcheck"
1524 type='{"type": "boolean"}'>
1526 The mcheck port parameter for the Port. Default is
1527 <code>false</code>. May be set to force the Port Protocol
1528 Migration state machine to transmit RST BPDUs for a
1529 MigrateTime period, to test whether all STP Bridges on the
1530 attached LAN have been removed and the Port can continue to
1531 transmit RSTP BPDUs. Setting mcheck has no effect if the
1532 Bridge is operating in STP Compatibility mode.
1535 Changing the value from <code>true</code> to
1536 <code>false</code> has no effect, but needs to be done if
1537 this behavior is to be triggered again by subsequently
1538 changing the value from <code>false</code> to
1544 <group title="RSTP Status">
1545 <column name="rstp_status" key="rstp_port_id">
1546 The port ID used in spanning tree advertisements for this port, as 4
1547 hex digits. Configuring the port ID is described in the
1548 <code>rstp-port-num</code> and <code>rstp-port-priority</code> keys
1549 of the <code>other_config</code> section earlier.
1551 <column name="rstp_status" key="rstp_port_role"
1552 type='{"type": "string", "enum": ["set",
1553 ["Root", "Designated", "Alternate", "Backup", "Disabled"]]}'>
1554 RSTP role of the port.
1556 <column name="rstp_status" key="rstp_port_state"
1557 type='{"type": "string", "enum": ["set",
1558 ["Disabled", "Learning", "Forwarding", "Discarding"]]}'>
1559 RSTP state of the port.
1561 <column name="rstp_status" key="rstp_designated_bridge_id">
1562 The port's RSTP designated bridge ID, in the same form as <ref
1563 column="rstp_status" key="rstp_bridge_id"/> in the <ref
1564 table="Bridge"/> table.
1566 <column name="rstp_status" key="rstp_designated_port_id">
1567 The port's RSTP designated port ID, as 4 hex digits.
1569 <column name="rstp_status" key="rstp_designated_path_cost"
1570 type='{"type": "integer"}'>
1571 The port's RSTP designated path cost. Lower is better.
1575 <group title="RSTP Statistics">
1576 <column name="rstp_statistics" key="rstp_tx_count">
1577 Number of RSTP BPDUs transmitted through this port.
1579 <column name="rstp_statistics" key="rstp_rx_count">
1580 Number of valid RSTP BPDUs received by this port.
1582 <column name="rstp_statistics" key="rstp_error_count">
1583 Number of invalid RSTP BPDUs received by this port.
1585 <column name="rstp_statistics" key="rstp_uptime">
1586 The duration covered by the other RSTP statistics, in seconds.
1591 <group title="Multicast Snooping">
1592 <column name="other_config" key="mcast-snooping-flood"
1593 type='{"type": "boolean"}'>
1595 If set to <code>true</code>, multicast packets (except Reports) are
1596 unconditionally forwarded to the specific port.
1599 <column name="other_config" key="mcast-snooping-flood-reports"
1600 type='{"type": "boolean"}'>
1602 If set to <code>true</code>, multicast Reports are unconditionally
1603 forwarded to the specific port.
1608 <group title="Other Features">
1610 Quality of Service configuration for this port.
1614 The MAC address to use for this port for the purpose of choosing the
1615 bridge's MAC address. This column does not necessarily reflect the
1616 port's actual MAC address, nor will setting it change the port's actual
1620 <column name="fake_bridge">
1621 Does this port represent a sub-bridge for its tagged VLAN within the
1622 Bridge? See ovs-vsctl(8) for more information.
1625 <column name="external_ids" key="fake-bridge-id-*">
1626 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1627 column) are defined by prefixing a <ref table="Bridge"/> <ref
1628 table="Bridge" column="external_ids"/> key with
1629 <code>fake-bridge-</code>,
1630 e.g. <code>fake-bridge-xs-network-uuids</code>.
1634 <column name="bond_active_slave">
1635 For a bonded port, record the mac address of the current active slave.
1638 <group title="Port Statistics">
1640 Key-value pairs that report port statistics. The update period
1641 is controlled by <ref column="other_config"
1642 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1644 <group title="Statistics: STP transmit and receive counters">
1645 <column name="statistics" key="stp_tx_count">
1646 Number of STP BPDUs sent on this port by the spanning
1649 <column name="statistics" key="stp_rx_count">
1650 Number of STP BPDUs received on this port and accepted by the
1651 spanning tree library.
1653 <column name="statistics" key="stp_error_count">
1654 Number of bad STP BPDUs received on this port. Bad BPDUs
1655 include runt packets and those with an unexpected protocol ID.
1660 <group title="Common Columns">
1661 The overall purpose of these columns is described under <code>Common
1662 Columns</code> at the beginning of this document.
1664 <column name="other_config"/>
1665 <column name="external_ids"/>
1669 <table name="Interface" title="One physical network device in a Port.">
1670 An interface within a <ref table="Port"/>.
1672 <group title="Core Features">
1673 <column name="name">
1674 Interface name. Should be alphanumeric and no more than about 8 bytes
1675 long. May be the same as the port name, for non-bonded ports. Must
1676 otherwise be unique among the names of ports, interfaces, and bridges
1680 <column name="ifindex">
1681 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1682 2863, if the interface has one, otherwise 0. The ifindex is useful for
1683 seamless integration with protocols such as SNMP and sFlow.
1686 <column name="mac_in_use">
1687 The MAC address in use by this interface.
1691 <p>Ethernet address to set for this interface. If unset then the
1692 default MAC address is used:</p>
1694 <li>For the local interface, the default is the lowest-numbered MAC
1695 address among the other bridge ports, either the value of the
1696 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1697 if set, or its actual MAC (for bonded ports, the MAC of its slave
1698 whose name is first in alphabetical order). Internal ports and
1699 bridge ports that are used as port mirroring destinations (see the
1700 <ref table="Mirror"/> table) are ignored.</li>
1701 <li>For other internal interfaces, the default MAC is randomly
1703 <li>External interfaces typically have a MAC address associated with
1704 their hardware.</li>
1706 <p>Some interfaces may not have a software-controllable MAC
1710 <column name="error">
1711 If the configuration of the port failed, as indicated by -1 in <ref
1712 column="ofport"/>, Open vSwitch sets this column to an error
1713 description in human readable form. Otherwise, Open vSwitch clears
1717 <group title="OpenFlow Port Number">
1719 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1720 port number for the new port. If the client that adds the port fills
1721 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1722 value as the OpenFlow port number. Otherwise, or if the requested
1723 port number is already in use or cannot be used for another reason,
1724 Open vSwitch automatically assigns a free port number. Regardless of
1725 how the port number was obtained, Open vSwitch then reports in <ref
1726 column="ofport"/> the port number actually assigned.
1730 Open vSwitch limits the port numbers that it automatically assigns to
1731 the range 1 through 32,767, inclusive. Controllers therefore have
1732 free use of ports 32,768 and up.
1735 <column name="ofport">
1737 OpenFlow port number for this interface. Open vSwitch sets this
1738 column's value, so other clients should treat it as read-only.
1741 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1742 The other valid port numbers are in the range 1 to 65,279,
1743 inclusive. Value -1 indicates an error adding the interface.
1747 <column name="ofport_request"
1748 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1750 Requested OpenFlow port number for this interface.
1754 A client should ideally set this column's value in the same
1755 database transaction that it uses to create the interface. Open
1756 vSwitch version 2.1 and later will honor a later request for a
1757 specific port number, althuogh it might confuse some controllers:
1758 OpenFlow does not have a way to announce a port number change, so
1759 Open vSwitch represents it over OpenFlow as a port deletion
1760 followed immediately by a port addition.
1764 If <ref column="ofport_request"/> is set or changed to some other
1765 port's automatically assigned port number, Open vSwitch chooses a
1766 new port number for the latter port.
1772 <group title="System-Specific Details">
1773 <column name="type">
1775 The interface type. The types supported by a particular instance of
1776 Open vSwitch are listed in the <ref table="Open_vSwitch"
1777 column="iface_types"/> column in the <ref table="Open_vSwitch"/>
1778 table. The following types are defined:
1782 <dt><code>system</code></dt>
1783 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1784 Sometimes referred to as ``external interfaces'' since they are
1785 generally connected to hardware external to that on which the Open
1786 vSwitch is running. The empty string is a synonym for
1787 <code>system</code>.</dd>
1789 <dt><code>internal</code></dt>
1790 <dd>A simulated network device that sends and receives traffic. An
1791 internal interface whose <ref column="name"/> is the same as its
1792 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1793 ``local interface.'' It does not make sense to bond an internal
1794 interface, so the terms ``port'' and ``interface'' are often used
1795 imprecisely for internal interfaces.</dd>
1797 <dt><code>tap</code></dt>
1798 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1800 <dt><code>geneve</code></dt>
1802 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1805 Geneve supports options as a means to transport additional metadata,
1806 however, currently only the 24-bit VNI is supported. This is planned
1807 to be extended in the future.
1810 <dt><code>gre</code></dt>
1812 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1816 <dt><code>ipsec_gre</code></dt>
1818 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1822 <dt><code>gre64</code></dt>
1824 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1825 of key, it uses GRE protocol sequence number field. This is non
1826 standard use of GRE protocol since OVS does not increment
1827 sequence number for every packet at time of encap as expected by
1828 standard GRE implementation. See <ref group="Tunnel Options"/>
1829 for information on configuring GRE tunnels.
1832 <dt><code>ipsec_gre64</code></dt>
1834 Same as IPSEC_GRE except 64 bit key.
1837 <dt><code>vxlan</code></dt>
1840 An Ethernet tunnel over the UDP-based VXLAN protocol described in
1844 Open vSwitch uses UDP destination port 4789. The source port used for
1845 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1850 <dt><code>lisp</code></dt>
1853 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1854 Separation Protocol (RFC 6830).
1857 Only IPv4 and IPv6 packets are supported by the protocol, and
1858 they are sent and received without an Ethernet header. Traffic
1859 to/from LISP ports is expected to be configured explicitly, and
1860 the ports are not intended to participate in learning based
1861 switching. As such, they are always excluded from packet
1866 <dt><code>patch</code></dt>
1868 A pair of virtual devices that act as a patch cable.
1871 <dt><code>null</code></dt>
1872 <dd>An ignored interface. Deprecated and slated for removal in
1878 <group title="Tunnel Options">
1880 These options apply to interfaces with <ref column="type"/> of
1881 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1882 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1883 and <code>lisp</code>.
1887 Each tunnel must be uniquely identified by the combination of <ref
1888 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1889 column="options" key="local_ip"/>, and <ref column="options"
1890 key="in_key"/>. If two ports are defined that are the same except one
1891 has an optional identifier and the other does not, the more specific
1892 one is matched first. <ref column="options" key="in_key"/> is
1893 considered more specific than <ref column="options" key="local_ip"/> if
1894 a port defines one and another port defines the other.
1897 <column name="options" key="remote_ip">
1898 <p>Required. The remote tunnel endpoint, one of:</p>
1902 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1903 Only unicast endpoints are supported.
1906 The word <code>flow</code>. The tunnel accepts packets from any
1907 remote tunnel endpoint. To process only packets from a specific
1908 remote tunnel endpoint, the flow entries may match on the
1909 <code>tun_src</code> field. When sending packets to a
1910 <code>remote_ip=flow</code> tunnel, the flow actions must
1911 explicitly set the <code>tun_dst</code> field to the IP address of
1912 the desired remote tunnel endpoint, e.g. with a
1913 <code>set_field</code> action.
1918 The remote tunnel endpoint for any packet received from a tunnel
1919 is available in the <code>tun_src</code> field for matching in the
1924 <column name="options" key="local_ip">
1926 Optional. The tunnel destination IP that received packets must
1927 match. Default is to match all addresses. If specified, may be one
1933 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1936 The word <code>flow</code>. The tunnel accepts packets sent to any
1937 of the local IP addresses of the system running OVS. To process
1938 only packets sent to a specific IP address, the flow entries may
1939 match on the <code>tun_dst</code> field. When sending packets to a
1940 <code>local_ip=flow</code> tunnel, the flow actions may
1941 explicitly set the <code>tun_src</code> field to the desired IP
1942 address, e.g. with a <code>set_field</code> action. However, while
1943 routing the tunneled packet out, the local system may override the
1944 specified address with the local IP address configured for the
1945 outgoing system interface.
1948 This option is valid only for tunnels also configured with the
1949 <code>remote_ip=flow</code> option.
1955 The tunnel destination IP address for any packet received from a
1956 tunnel is available in the <code>tun_dst</code> field for matching in
1961 <column name="options" key="in_key">
1962 <p>Optional. The key that received packets must contain, one of:</p>
1966 <code>0</code>. The tunnel receives packets with no key or with a
1967 key of 0. This is equivalent to specifying no <ref column="options"
1968 key="in_key"/> at all.
1971 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
1972 or 64-bit (for GRE64) number. The tunnel receives only packets
1973 with the specified key.
1976 The word <code>flow</code>. The tunnel accepts packets with any
1977 key. The key will be placed in the <code>tun_id</code> field for
1978 matching in the flow table. The <code>ovs-ofctl</code> manual page
1979 contains additional information about matching fields in OpenFlow
1988 <column name="options" key="out_key">
1989 <p>Optional. The key to be set on outgoing packets, one of:</p>
1993 <code>0</code>. Packets sent through the tunnel will have no key.
1994 This is equivalent to specifying no <ref column="options"
1995 key="out_key"/> at all.
1998 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
1999 64-bit (for GRE64) number. Packets sent through the tunnel will
2000 have the specified key.
2003 The word <code>flow</code>. Packets sent through the tunnel will
2004 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
2005 vendor extension (0 is used in the absence of an action). The
2006 <code>ovs-ofctl</code> manual page contains additional information
2007 about the Nicira OpenFlow vendor extensions.
2012 <column name="options" key="key">
2013 Optional. Shorthand to set <code>in_key</code> and
2014 <code>out_key</code> at the same time.
2017 <column name="options" key="tos">
2018 Optional. The value of the ToS bits to be set on the encapsulating
2019 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2020 zero. It may also be the word <code>inherit</code>, in which case
2021 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2022 (otherwise it will be 0). The ECN fields are always inherited.
2026 <column name="options" key="ttl">
2027 Optional. The TTL to be set on the encapsulating packet. It may also
2028 be the word <code>inherit</code>, in which case the TTL will be copied
2029 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2030 system default, typically 64). Default is the system default TTL.
2033 <column name="options" key="df_default"
2034 type='{"type": "boolean"}'>
2035 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2036 outer headers to allow path MTU discovery. Default is enabled; set
2037 to <code>false</code> to disable.
2040 <group title="Tunnel Options: vxlan only">
2042 <column name="options" key="exts">
2043 <p>Optional. Comma separated list of optional VXLAN extensions to
2044 enable. The following extensions are supported:</p>
2048 <code>gbp</code>: VXLAN-GBP allows to transport the group policy
2049 context of a packet across the VXLAN tunnel to other network
2050 peers. See the field description of <code>tun_gbp_id</code> and
2051 <code>tun_gbp_flags</code> in ovs-ofctl(8) for additional
2053 (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>)
2060 <group title="Tunnel Options: gre and ipsec_gre only">
2062 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
2066 <column name="options" key="csum" type='{"type": "boolean"}'>
2068 Optional. Compute GRE checksums on outgoing packets. Default is
2069 disabled, set to <code>true</code> to enable. Checksums present on
2070 incoming packets will be validated regardless of this setting.
2074 GRE checksums impose a significant performance penalty because they
2075 cover the entire packet. The encapsulated L3, L4, and L7 packet
2076 contents typically have their own checksums, so this additional
2077 checksum only adds value for the GRE and encapsulated L2 headers.
2081 This option is supported for <code>ipsec_gre</code>, but not useful
2082 because GRE checksums are weaker than, and redundant with, IPsec
2083 payload authentication.
2088 <group title="Tunnel Options: ipsec_gre only">
2090 Only <code>ipsec_gre</code> interfaces support these options.
2093 <column name="options" key="peer_cert">
2094 Required for certificate authentication. A string containing the
2095 peer's certificate in PEM format. Additionally the host's
2096 certificate must be specified with the <code>certificate</code>
2100 <column name="options" key="certificate">
2101 Required for certificate authentication. The name of a PEM file
2102 containing a certificate that will be presented to the peer during
2106 <column name="options" key="private_key">
2107 Optional for certificate authentication. The name of a PEM file
2108 containing the private key associated with <code>certificate</code>.
2109 If <code>certificate</code> contains the private key, this option may
2113 <column name="options" key="psk">
2114 Required for pre-shared key authentication. Specifies a pre-shared
2115 key for authentication that must be identical on both sides of the
2121 <group title="Patch Options">
2123 Only <code>patch</code> interfaces support these options.
2126 <column name="options" key="peer">
2127 The <ref column="name"/> of the <ref table="Interface"/> for the other
2128 side of the patch. The named <ref table="Interface"/>'s own
2129 <code>peer</code> option must specify this <ref table="Interface"/>'s
2130 name. That is, the two patch interfaces must have reversed <ref
2131 column="name"/> and <code>peer</code> values.
2135 <group title="Interface Status">
2137 Status information about interfaces attached to bridges, updated every
2138 5 seconds. Not all interfaces have all of these properties; virtual
2139 interfaces don't have a link speed, for example. Non-applicable
2140 columns will have empty values.
2142 <column name="admin_state">
2144 The administrative state of the physical network link.
2148 <column name="link_state">
2150 The observed state of the physical network link. This is ordinarily
2151 the link's carrier status. If the interface's <ref table="Port"/> is
2152 a bond configured for miimon monitoring, it is instead the network
2153 link's miimon status.
2157 <column name="link_resets">
2159 The number of times Open vSwitch has observed the
2160 <ref column="link_state"/> of this <ref table="Interface"/> change.
2164 <column name="link_speed">
2166 The negotiated speed of the physical network link.
2167 Valid values are positive integers greater than 0.
2171 <column name="duplex">
2173 The duplex mode of the physical network link.
2179 The MTU (maximum transmission unit); i.e. the largest
2180 amount of data that can fit into a single Ethernet frame.
2181 The standard Ethernet MTU is 1500 bytes. Some physical media
2182 and many kinds of virtual interfaces can be configured with
2186 This column will be empty for an interface that does not
2187 have an MTU as, for example, some kinds of tunnels do not.
2191 <column name="lacp_current">
2192 Boolean value indicating LACP status for this interface. If true, this
2193 interface has current LACP information about its LACP partner. This
2194 information may be used to monitor the health of interfaces in a LACP
2195 enabled port. This column will be empty if LACP is not enabled.
2198 <column name="status">
2199 Key-value pairs that report port status. Supported status values are
2200 <ref column="type"/>-dependent; some interfaces may not have a valid
2201 <ref column="status" key="driver_name"/>, for example.
2204 <column name="status" key="driver_name">
2205 The name of the device driver controlling the network adapter.
2208 <column name="status" key="driver_version">
2209 The version string of the device driver controlling the network
2213 <column name="status" key="firmware_version">
2214 The version string of the network adapter's firmware, if available.
2217 <column name="status" key="source_ip">
2218 The source IP address used for an IPv4 tunnel end-point, such as
2222 <column name="status" key="tunnel_egress_iface">
2223 Egress interface for tunnels. Currently only relevant for tunnels
2224 on Linux systems, this column will show the name of the interface
2225 which is responsible for routing traffic destined for the configured
2226 <ref column="options" key="remote_ip"/>. This could be an internal
2227 interface such as a bridge port.
2230 <column name="status" key="tunnel_egress_iface_carrier"
2231 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2232 Whether carrier is detected on <ref column="status"
2233 key="tunnel_egress_iface"/>.
2237 <group title="Statistics">
2239 Key-value pairs that report interface statistics. The current
2240 implementation updates these counters periodically. The update period
2241 is controlled by <ref column="other_config"
2242 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2243 Future implementations may update them when an interface is created,
2244 when they are queried (e.g. using an OVSDB <code>select</code>
2245 operation), and just before an interface is deleted due to virtual
2246 interface hot-unplug or VM shutdown, and perhaps at other times, but
2247 not on any regular periodic basis.
2250 These are the same statistics reported by OpenFlow in its <code>struct
2251 ofp_port_stats</code> structure. If an interface does not support a
2252 given statistic, then that pair is omitted.
2254 <group title="Statistics: Successful transmit and receive counters">
2255 <column name="statistics" key="rx_packets">
2256 Number of received packets.
2258 <column name="statistics" key="rx_bytes">
2259 Number of received bytes.
2261 <column name="statistics" key="tx_packets">
2262 Number of transmitted packets.
2264 <column name="statistics" key="tx_bytes">
2265 Number of transmitted bytes.
2268 <group title="Statistics: Receive errors">
2269 <column name="statistics" key="rx_dropped">
2270 Number of packets dropped by RX.
2272 <column name="statistics" key="rx_frame_err">
2273 Number of frame alignment errors.
2275 <column name="statistics" key="rx_over_err">
2276 Number of packets with RX overrun.
2278 <column name="statistics" key="rx_crc_err">
2279 Number of CRC errors.
2281 <column name="statistics" key="rx_errors">
2282 Total number of receive errors, greater than or equal to the sum of
2286 <group title="Statistics: Transmit errors">
2287 <column name="statistics" key="tx_dropped">
2288 Number of packets dropped by TX.
2290 <column name="statistics" key="collisions">
2291 Number of collisions.
2293 <column name="statistics" key="tx_errors">
2294 Total number of transmit errors, greater than or equal to the sum of
2300 <group title="Ingress Policing">
2302 These settings control ingress policing for packets received on this
2303 interface. On a physical interface, this limits the rate at which
2304 traffic is allowed into the system from the outside; on a virtual
2305 interface (one connected to a virtual machine), this limits the rate at
2306 which the VM is able to transmit.
2309 Policing is a simple form of quality-of-service that simply drops
2310 packets received in excess of the configured rate. Due to its
2311 simplicity, policing is usually less accurate and less effective than
2312 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2313 table="Queue"/> tables).
2316 Policing is currently implemented only on Linux. The Linux
2317 implementation uses a simple ``token bucket'' approach:
2321 The size of the bucket corresponds to <ref
2322 column="ingress_policing_burst"/>. Initially the bucket is full.
2325 Whenever a packet is received, its size (converted to tokens) is
2326 compared to the number of tokens currently in the bucket. If the
2327 required number of tokens are available, they are removed and the
2328 packet is forwarded. Otherwise, the packet is dropped.
2331 Whenever it is not full, the bucket is refilled with tokens at the
2332 rate specified by <ref column="ingress_policing_rate"/>.
2336 Policing interacts badly with some network protocols, and especially
2337 with fragmented IP packets. Suppose that there is enough network
2338 activity to keep the bucket nearly empty all the time. Then this token
2339 bucket algorithm will forward a single packet every so often, with the
2340 period depending on packet size and on the configured rate. All of the
2341 fragments of an IP packets are normally transmitted back-to-back, as a
2342 group. In such a situation, therefore, only one of these fragments
2343 will be forwarded and the rest will be dropped. IP does not provide
2344 any way for the intended recipient to ask for only the remaining
2345 fragments. In such a case there are two likely possibilities for what
2346 will happen next: either all of the fragments will eventually be
2347 retransmitted (as TCP will do), in which case the same problem will
2348 recur, or the sender will not realize that its packet has been dropped
2349 and data will simply be lost (as some UDP-based protocols will do).
2350 Either way, it is possible that no forward progress will ever occur.
2352 <column name="ingress_policing_rate">
2354 Maximum rate for data received on this interface, in kbps. Data
2355 received faster than this rate is dropped. Set to <code>0</code>
2356 (the default) to disable policing.
2360 <column name="ingress_policing_burst">
2361 <p>Maximum burst size for data received on this interface, in kb. The
2362 default burst size if set to <code>0</code> is 1000 kb. This value
2363 has no effect if <ref column="ingress_policing_rate"/>
2364 is <code>0</code>.</p>
2366 Specifying a larger burst size lets the algorithm be more forgiving,
2367 which is important for protocols like TCP that react severely to
2368 dropped packets. The burst size should be at least the size of the
2369 interface's MTU. Specifying a value that is numerically at least as
2370 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2371 closer to achieving the full rate.
2376 <group title="Bidirectional Forwarding Detection (BFD)">
2378 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2379 detection of connectivity failures by occasional transmission of
2380 BFD control messages. Open vSwitch implements BFD to serve
2381 as a more popular and standards compliant alternative to CFM.
2385 BFD operates by regularly transmitting BFD control messages at a rate
2386 negotiated independently in each direction. Each endpoint specifies
2387 the rate at which it expects to receive control messages, and the rate
2388 at which it is willing to transmit them. Open vSwitch uses a detection
2389 multiplier of three, meaning that an endpoint signals a connectivity
2390 fault if three consecutive BFD control messages fail to arrive. In the
2391 case of a unidirectional connectivity issue, the system not receiving
2392 BFD control messages signals the problem to its peer in the messages it
2397 The Open vSwitch implementation of BFD aims to comply faithfully
2398 with RFC 5880 requirements. Open vSwitch does not implement the
2399 optional Authentication or ``Echo Mode'' features.
2402 <group title="BFD Configuration">
2404 A controller sets up key-value pairs in the <ref column="bfd"/>
2405 column to enable and configure BFD.
2408 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2409 True to enable BFD on this <ref table="Interface"/>. If not
2410 specified, BFD will not be enabled by default.
2413 <column name="bfd" key="min_rx"
2414 type='{"type": "integer", "minInteger": 1}'>
2415 The shortest interval, in milliseconds, at which this BFD session
2416 offers to receive BFD control messages. The remote endpoint may
2417 choose to send messages at a slower rate. Defaults to
2421 <column name="bfd" key="min_tx"
2422 type='{"type": "integer", "minInteger": 1}'>
2423 The shortest interval, in milliseconds, at which this BFD session is
2424 willing to transmit BFD control messages. Messages will actually be
2425 transmitted at a slower rate if the remote endpoint is not willing to
2426 receive as quickly as specified. Defaults to <code>100</code>.
2429 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2430 An alternate receive interval, in milliseconds, that must be greater
2431 than or equal to <ref column="bfd" key="min_rx"/>. The
2432 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2433 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2434 data traffic at the interface, to reduce the CPU and bandwidth cost
2435 of monitoring an idle interface. This feature may be disabled by
2436 setting a value of 0. This feature is reset whenever <ref
2437 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2441 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2442 When <code>true</code>, traffic received on the
2443 <ref table="Interface"/> is used to indicate the capability of packet
2444 I/O. BFD control packets are still transmitted and received. At
2445 least one BFD control packet must be received every 100 * <ref
2446 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2447 traffic are received, the <ref column="bfd" key="forwarding"/>
2448 will be <code>false</code>.
2451 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2452 Set to true to notify the remote endpoint that traffic should not be
2453 forwarded to this system for some reason other than a connectivty
2454 failure on the interface being monitored. The typical underlying
2455 reason is ``concatenated path down,'' that is, that connectivity
2456 beyond the local system is down. Defaults to false.
2459 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2460 Set to true to make BFD accept only control messages with a tunnel
2461 key of zero. By default, BFD accepts control messages with any
2465 <column name="bfd" key="bfd_local_src_mac">
2466 Set to an Ethernet address in the form
2467 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2468 to set the MAC used as source for transmitted BFD packets. The
2469 default is the mac address of the BFD enabled interface.
2472 <column name="bfd" key="bfd_local_dst_mac">
2473 Set to an Ethernet address in the form
2474 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2475 to set the MAC used as destination for transmitted BFD packets. The
2476 default is <code>00:23:20:00:00:01</code>.
2479 <column name="bfd" key="bfd_remote_dst_mac">
2480 Set to an Ethernet address in the form
2481 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2482 to set the MAC used for checking the destination of received BFD packets.
2483 Packets with different destination MAC will not be considered as BFD packets.
2484 If not specified the destination MAC address of received BFD packets
2488 <column name="bfd" key="bfd_src_ip">
2489 Set to an IPv4 address to set the IP address used as source for
2490 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2493 <column name="bfd" key="bfd_dst_ip">
2494 Set to an IPv4 address to set the IP address used as destination
2495 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2499 <group title="BFD Status">
2501 The switch sets key-value pairs in the <ref column="bfd_status"/>
2502 column to report the status of BFD on this interface. When BFD is
2503 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2504 all key-value pairs from <ref column="bfd_status"/>.
2507 <column name="bfd_status" key="state"
2508 type='{"type": "string",
2509 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2510 Reports the state of the BFD session. The BFD session is fully
2511 healthy and negotiated if <code>UP</code>.
2514 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2515 Reports whether the BFD session believes this <ref
2516 table="Interface"/> may be used to forward traffic. Typically this
2517 means the local session is signaling <code>UP</code>, and the remote
2518 system isn't signaling a problem such as concatenated path down.
2521 <column name="bfd_status" key="diagnostic">
2522 In case of a problem, set to an error message that reports what the
2523 local BFD session thinks is wrong. The error messages are defined
2524 in section 4.1 of [RFC 5880].
2527 <column name="bfd_status" key="remote_state"
2528 type='{"type": "string",
2529 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2530 Reports the state of the remote endpoint's BFD session.
2533 <column name="bfd_status" key="remote_diagnostic">
2534 In case of a problem, set to an error message that reports what the
2535 remote endpoint's BFD session thinks is wrong. The error messages
2536 are defined in section 4.1 of [RFC 5880].
2539 <column name="bfd_status" key="flap_count"
2540 type='{"type": "integer", "minInteger": 0}'>
2541 Counts the number of <ref column="bfd_status" key="forwarding" />
2542 flaps since start. A flap is considered as a change of the
2543 <ref column="bfd_status" key="forwarding" /> value.
2548 <group title="Connectivity Fault Management">
2550 802.1ag Connectivity Fault Management (CFM) allows a group of
2551 Maintenance Points (MPs) called a Maintenance Association (MA) to
2552 detect connectivity problems with each other. MPs within a MA should
2553 have complete and exclusive interconnectivity. This is verified by
2554 occasionally broadcasting Continuity Check Messages (CCMs) at a
2555 configurable transmission interval.
2559 According to the 802.1ag specification, each Maintenance Point should
2560 be configured out-of-band with a list of Remote Maintenance Points it
2561 should have connectivity to. Open vSwitch differs from the
2562 specification in this area. It simply assumes the link is faulted if
2563 no Remote Maintenance Points are reachable, and considers it not
2568 When operating over tunnels which have no <code>in_key</code>, or an
2569 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2570 with a tunnel key of zero.
2573 <column name="cfm_mpid">
2575 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2576 within a Maintenance Association. The MPID is used to identify this
2577 endpoint to other Maintenance Points in the MA. Each end of a link
2578 being monitored should have a different MPID. Must be configured to
2579 enable CFM on this <ref table="Interface"/>.
2582 According to the 802.1ag specification, MPIDs can only range between
2583 [1, 8191]. However, extended mode (see <ref column="other_config"
2584 key="cfm_extended"/>) supports eight byte MPIDs.
2588 <column name="cfm_flap_count">
2589 Counts the number of cfm fault flapps since boot. A flap is
2590 considered to be a change of the <ref column="cfm_fault"/> value.
2593 <column name="cfm_fault">
2595 Indicates a connectivity fault triggered by an inability to receive
2596 heartbeats from any remote endpoint. When a fault is triggered on
2597 <ref table="Interface"/>s participating in bonds, they will be
2601 Faults can be triggered for several reasons. Most importantly they
2602 are triggered when no CCMs are received for a period of 3.5 times the
2603 transmission interval. Faults are also triggered when any CCMs
2604 indicate that a Remote Maintenance Point is not receiving CCMs but
2605 able to send them. Finally, a fault is triggered if a CCM is
2606 received which indicates unexpected configuration. Notably, this
2607 case arises when a CCM is received which advertises the local MPID.
2611 <column name="cfm_fault_status" key="recv">
2612 Indicates a CFM fault was triggered due to a lack of CCMs received on
2613 the <ref table="Interface"/>.
2616 <column name="cfm_fault_status" key="rdi">
2617 Indicates a CFM fault was triggered due to the reception of a CCM with
2618 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2619 are not receiving CCMs themselves. This typically indicates a
2620 unidirectional connectivity failure.
2623 <column name="cfm_fault_status" key="maid">
2624 Indicates a CFM fault was triggered due to the reception of a CCM with
2625 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2626 with an identification number in addition to the MPID called the MAID.
2627 Open vSwitch only supports receiving CCM broadcasts tagged with the
2628 MAID it uses internally.
2631 <column name="cfm_fault_status" key="loopback">
2632 Indicates a CFM fault was triggered due to the reception of a CCM
2633 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2634 column of this <ref table="Interface"/>. This may indicate a loop in
2638 <column name="cfm_fault_status" key="overflow">
2639 Indicates a CFM fault was triggered because the CFM module received
2640 CCMs from more remote endpoints than it can keep track of.
2643 <column name="cfm_fault_status" key="override">
2644 Indicates a CFM fault was manually triggered by an administrator using
2645 an <code>ovs-appctl</code> command.
2648 <column name="cfm_fault_status" key="interval">
2649 Indicates a CFM fault was triggered due to the reception of a CCM
2650 frame having an invalid interval.
2653 <column name="cfm_remote_opstate">
2654 <p>When in extended mode, indicates the operational state of the
2655 remote endpoint as either <code>up</code> or <code>down</code>. See
2656 <ref column="other_config" key="cfm_opstate"/>.
2660 <column name="cfm_health">
2662 Indicates the health of the interface as a percentage of CCM frames
2663 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2664 The health of an interface is undefined if it is communicating with
2665 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2666 healthy heartbeats are not received at the expected rate, and
2667 gradually improves as healthy heartbeats are received at the desired
2668 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2669 health of the interface is refreshed.
2672 As mentioned above, the faults can be triggered for several reasons.
2673 The link health will deteriorate even if heartbeats are received but
2674 they are reported to be unhealthy. An unhealthy heartbeat in this
2675 context is a heartbeat for which either some fault is set or is out
2676 of sequence. The interface health can be 100 only on receiving
2677 healthy heartbeats at the desired rate.
2681 <column name="cfm_remote_mpids">
2682 When CFM is properly configured, Open vSwitch will occasionally
2683 receive CCM broadcasts. These broadcasts contain the MPID of the
2684 sending Maintenance Point. The list of MPIDs from which this
2685 <ref table="Interface"/> is receiving broadcasts from is regularly
2686 collected and written to this column.
2689 <column name="other_config" key="cfm_interval"
2690 type='{"type": "integer"}'>
2692 The interval, in milliseconds, between transmissions of CFM
2693 heartbeats. Three missed heartbeat receptions indicate a
2698 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2699 60,000, or 600,000 ms are supported. Other values will be rounded
2700 down to the nearest value on the list. Extended mode (see <ref
2701 column="other_config" key="cfm_extended"/>) supports any interval up
2702 to 65,535 ms. In either mode, the default is 1000 ms.
2705 <p>We do not recommend using intervals less than 100 ms.</p>
2708 <column name="other_config" key="cfm_extended"
2709 type='{"type": "boolean"}'>
2710 When <code>true</code>, the CFM module operates in extended mode. This
2711 causes it to use a nonstandard destination address to avoid conflicting
2712 with compliant implementations which may be running concurrently on the
2713 network. Furthermore, extended mode increases the accuracy of the
2714 <code>cfm_interval</code> configuration parameter by breaking wire
2715 compatibility with 802.1ag compliant implementations. And extended
2716 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2719 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2721 When <code>true</code>, and
2722 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2723 module operates in demand mode. When in demand mode, traffic
2724 received on the <ref table="Interface"/> is used to indicate
2725 liveness. CCMs are still transmitted and received. At least one
2726 CCM must be received every 100 * <ref column="other_config"
2727 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2728 are received, the CFM module will raise the connectivity fault.
2732 Demand mode has a couple of caveats:
2735 To ensure that ovs-vswitchd has enough time to pull statistics
2736 from the datapath, the fault detection interval is set to
2737 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2742 To avoid ambiguity, demand mode disables itself when there are
2743 multiple remote maintenance points.
2747 If the <ref table="Interface"/> is heavily congested, CCMs
2748 containing the <ref column="other_config" key="cfm_opstate"/>
2749 status may be dropped causing changes in the operational state to
2750 be delayed. Similarly, if CCMs containing the RDI bit are not
2751 received, unidirectional link failures may not be detected.
2757 <column name="other_config" key="cfm_opstate"
2758 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2759 When <code>down</code>, the CFM module marks all CCMs it generates as
2760 operationally down without triggering a fault. This allows remote
2761 maintenance points to choose not to forward traffic to the
2762 <ref table="Interface"/> on which this CFM module is running.
2763 Currently, in Open vSwitch, the opdown bit of CCMs affects
2764 <ref table="Interface"/>s participating in bonds, and the bundle
2765 OpenFlow action. This setting is ignored when CFM is not in extended
2766 mode. Defaults to <code>up</code>.
2769 <column name="other_config" key="cfm_ccm_vlan"
2770 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2771 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2772 with the given value. May be the string <code>random</code> in which
2773 case each CCM will be tagged with a different randomly generated VLAN.
2776 <column name="other_config" key="cfm_ccm_pcp"
2777 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2778 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2779 with the given PCP value, the VLAN ID of the tag is governed by the
2780 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2781 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2787 <group title="Bonding Configuration">
2788 <column name="other_config" key="lacp-port-id"
2789 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2790 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2791 used in LACP negotiations to identify individual ports
2792 participating in a bond.
2795 <column name="other_config" key="lacp-port-priority"
2796 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2797 The LACP port priority of this <ref table="Interface"/>. In LACP
2798 negotiations <ref table="Interface"/>s with numerically lower
2799 priorities are preferred for aggregation.
2802 <column name="other_config" key="lacp-aggregation-key"
2803 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2804 The LACP aggregation key of this <ref table="Interface"/>. <ref
2805 table="Interface"/>s with different aggregation keys may not be active
2806 within a given <ref table="Port"/> at the same time.
2810 <group title="Virtual Machine Identifiers">
2812 These key-value pairs specifically apply to an interface that
2813 represents a virtual Ethernet interface connected to a virtual
2814 machine. These key-value pairs should not be present for other types
2815 of interfaces. Keys whose names end in <code>-uuid</code> have
2816 values that uniquely identify the entity in question. For a Citrix
2817 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2818 Other hypervisors may use other formats.
2821 <column name="external_ids" key="attached-mac">
2822 The MAC address programmed into the ``virtual hardware'' for this
2823 interface, in the form
2824 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2825 For Citrix XenServer, this is the value of the <code>MAC</code> field
2826 in the VIF record for this interface.
2829 <column name="external_ids" key="iface-id">
2830 A system-unique identifier for the interface. On XenServer, this will
2831 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2834 <column name="external_ids" key="iface-status"
2835 type='{"type": "string",
2836 "enum": ["set", ["active", "inactive"]]}'>
2838 Hypervisors may sometimes have more than one interface associated
2839 with a given <ref column="external_ids" key="iface-id"/>, only one of
2840 which is actually in use at a given time. For example, in some
2841 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2842 for a single <ref column="external_ids" key="iface-id"/>, but only
2843 uses one of them at a time. A hypervisor that behaves this way must
2844 mark the currently in use interface <code>active</code> and the
2845 others <code>inactive</code>. A hypervisor that never has more than
2846 one interface for a given <ref column="external_ids" key="iface-id"/>
2847 may mark that interface <code>active</code> or omit <ref
2848 column="external_ids" key="iface-status"/> entirely.
2852 During VM migration, a given <ref column="external_ids"
2853 key="iface-id"/> might transiently be marked <code>active</code> on
2854 two different hypervisors. That is, <code>active</code> means that
2855 this <ref column="external_ids" key="iface-id"/> is the active
2856 instance within a single hypervisor, not in a broader scope.
2857 There is one exception: some hypervisors support ``migration'' from a
2858 given hypervisor to itself (most often for test purposes). During
2859 such a ``migration,'' two instances of a single <ref
2860 column="external_ids" key="iface-id"/> might both be briefly marked
2861 <code>active</code> on a single hypervisor.
2865 <column name="external_ids" key="xs-vif-uuid">
2866 The virtual interface associated with this interface.
2869 <column name="external_ids" key="xs-network-uuid">
2870 The virtual network to which this interface is attached.
2873 <column name="external_ids" key="vm-id">
2874 The VM to which this interface belongs. On XenServer, this will be the
2875 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2878 <column name="external_ids" key="xs-vm-uuid">
2879 The VM to which this interface belongs.
2883 <group title="VLAN Splinters">
2885 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2886 with buggy network drivers in old versions of Linux that do not
2887 properly support VLANs when VLAN devices are not used, at some cost
2888 in memory and performance.
2892 When VLAN splinters are enabled on a particular interface, Open vSwitch
2893 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2894 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2895 received on the VLAN device is treated as if it had been received on
2896 the interface on the particular VLAN.
2900 VLAN splinters consider a VLAN to be in use if:
2905 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2906 table="Port"/> record.
2910 The VLAN is listed within the <ref table="Port" column="trunks"/>
2911 column of the <ref table="Port"/> record of an interface on which
2912 VLAN splinters are enabled.
2914 An empty <ref table="Port" column="trunks"/> does not influence the
2915 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2916 will exceed the current 1,024 port per datapath limit.
2920 An OpenFlow flow within any bridge matches the VLAN.
2925 The same set of in-use VLANs applies to every interface on which VLAN
2926 splinters are enabled. That is, the set is not chosen separately for
2927 each interface but selected once as the union of all in-use VLANs based
2932 It does not make sense to enable VLAN splinters on an interface for an
2933 access port, or on an interface that is not a physical port.
2937 VLAN splinters are deprecated. When broken device drivers are no
2938 longer in widespread use, we will delete this feature.
2941 <column name="other_config" key="enable-vlan-splinters"
2942 type='{"type": "boolean"}'>
2944 Set to <code>true</code> to enable VLAN splinters on this interface.
2945 Defaults to <code>false</code>.
2949 VLAN splinters increase kernel and userspace memory overhead, so do
2950 not use them unless they are needed.
2954 VLAN splinters do not support 802.1p priority tags. Received
2955 priorities will appear to be 0, regardless of their actual values,
2956 and priorities on transmitted packets will also be cleared to 0.
2961 <group title="Auto Attach Configuration">
2963 Auto Attach configuration for a particular interface.
2966 <column name="lldp" key="enable" type='{"type": "boolean"}'>
2967 True to enable LLDP on this <ref table="Interface"/>. If not
2968 specified, LLDP will be disabled by default.
2972 <group title="Common Columns">
2973 The overall purpose of these columns is described under <code>Common
2974 Columns</code> at the beginning of this document.
2976 <column name="other_config"/>
2977 <column name="external_ids"/>
2981 <table name="Flow_Table" title="OpenFlow table configuration">
2982 <p>Configuration for a particular OpenFlow table.</p>
2984 <column name="name">
2985 The table's name. Set this column to change the name that controllers
2986 will receive when they request table statistics, e.g. <code>ovs-ofctl
2987 dump-tables</code>. The name does not affect switch behavior.
2990 <column name="flow_limit">
2991 If set, limits the number of flows that may be added to the table. Open
2992 vSwitch may limit the number of flows in a table for other reasons,
2993 e.g. due to hardware limitations or for resource availability or
2994 performance reasons.
2997 <column name="overflow_policy">
2999 Controls the switch's behavior when an OpenFlow flow table modification
3000 request would add flows in excess of <ref column="flow_limit"/>. The
3001 supported values are:
3005 <dt><code>refuse</code></dt>
3007 Refuse to add the flow or flows. This is also the default policy
3008 when <ref column="overflow_policy"/> is unset.
3011 <dt><code>evict</code></dt>
3013 Delete the flow that will expire soonest. See <ref column="groups"/>
3019 <column name="groups">
3021 When <ref column="overflow_policy"/> is <code>evict</code>, this
3022 controls how flows are chosen for eviction when the flow table would
3023 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
3024 of NXM fields or sub-fields, each of which takes one of the forms
3025 <code><var>field</var>[]</code> or
3026 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
3027 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
3028 <code>nicira-ext.h</code> for a complete list of NXM field names.
3032 When a flow must be evicted due to overflow, the flow to evict is
3033 chosen through an approximation of the following algorithm:
3038 Divide the flows in the table into groups based on the values of the
3039 specified fields or subfields, so that all of the flows in a given
3040 group have the same values for those fields. If a flow does not
3041 specify a given field, that field's value is treated as 0.
3045 Consider the flows in the largest group, that is, the group that
3046 contains the greatest number of flows. If two or more groups all
3047 have the same largest number of flows, consider the flows in all of
3052 Among the flows under consideration, choose the flow that expires
3053 soonest for eviction.
3058 The eviction process only considers flows that have an idle timeout or
3059 a hard timeout. That is, eviction never deletes permanent flows.
3060 (Permanent flows do count against <ref column="flow_limit"/>.)
3064 Open vSwitch ignores any invalid or unknown field specifications.
3068 When <ref column="overflow_policy"/> is not <code>evict</code>, this
3069 column has no effect.
3073 <column name="prefixes">
3075 This string set specifies which fields should be used for
3076 address prefix tracking. Prefix tracking allows the
3077 classifier to skip rules with longer than necessary prefixes,
3078 resulting in better wildcarding for datapath flows.
3081 Prefix tracking may be beneficial when a flow table contains
3082 matches on IP address fields with different prefix lengths.
3083 For example, when a flow table contains IP address matches on
3084 both full addresses and proper prefixes, the full address
3085 matches will typically cause the datapath flow to un-wildcard
3086 the whole address field (depending on flow entry priorities).
3087 In this case each packet with a different address gets handed
3088 to the userspace for flow processing and generates its own
3089 datapath flow. With prefix tracking enabled for the address
3090 field in question packets with addresses matching shorter
3091 prefixes would generate datapath flows where the irrelevant
3092 address bits are wildcarded, allowing the same datapath flow
3093 to handle all the packets within the prefix in question. In
3094 this case many userspace upcalls can be avoided and the
3095 overall performance can be better.
3098 This is a performance optimization only, so packets will
3099 receive the same treatment with or without prefix tracking.
3102 The supported fields are: <code>tun_id</code>,
3103 <code>tun_src</code>, <code>tun_dst</code>,
3104 <code>nw_src</code>, <code>nw_dst</code> (or aliases
3105 <code>ip_src</code> and <code>ip_dst</code>),
3106 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
3107 feature for <code>tun_id</code> would only make sense if the
3108 tunnel IDs have prefix structure similar to IP addresses.)
3112 By default, the <code>prefixes=ip_dst,ip_src</code> are used
3113 on each flow table. This instructs the flow classifier to
3114 track the IP destination and source addresses used by the
3115 rules in this specific flow table.
3119 The keyword <code>none</code> is recognized as an explicit
3120 override of the default values, causing no prefix fields to be
3125 To set the prefix fields, the flow table record needs to
3130 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
3132 Creates a flow table record for the OpenFlow table number 0.
3135 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
3137 Enables prefix tracking for IP source and destination
3143 There is a maximum number of fields that can be enabled for any
3144 one flow table. Currently this limit is 3.
3148 <group title="Common Columns">
3149 The overall purpose of these columns is described under <code>Common
3150 Columns</code> at the beginning of this document.
3152 <column name="external_ids"/>
3156 <table name="QoS" title="Quality of Service configuration">
3157 <p>Quality of Service (QoS) configuration for each Port that
3160 <column name="type">
3161 <p>The type of QoS to implement. The currently defined types are
3164 <dt><code>linux-htb</code></dt>
3166 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
3167 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
3168 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
3169 for information on how this classifier works and how to configure it.
3173 <dt><code>linux-hfsc</code></dt>
3175 Linux "Hierarchical Fair Service Curve" classifier.
3176 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
3177 information on how this classifier works.
3181 <dt><code>linux-sfq</code></dt>
3183 Linux ``Stochastic Fairness Queueing'' classifier. See
3184 <code>tc-sfq</code>(8) (also at
3185 <code>http://linux.die.net/man/8/tc-sfq</code>) for information on
3186 how this classifier works.
3190 <dt><code>linux-codel</code></dt>
3192 Linux ``Controlled Delay'' classifier. See <code>tc-codel</code>(8)
3194 <code>http://man7.org/linux/man-pages/man8/tc-codel.8.html</code>)
3195 for information on how this classifier works.
3199 <dt><code>linux-fq_codel</code></dt>
3201 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3202 <code>tc-fq_codel</code>(8) (also at
3203 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel.8.html</code>)
3204 for information on how this classifier works.
3209 <column name="queues">
3210 <p>A map from queue numbers to <ref table="Queue"/> records. The
3211 supported range of queue numbers depend on <ref column="type"/>. The
3212 queue numbers are the same as the <code>queue_id</code> used in
3213 OpenFlow in <code>struct ofp_action_enqueue</code> and other
3217 Queue 0 is the ``default queue.'' It is used by OpenFlow output
3218 actions when no specific queue has been set. When no configuration for
3219 queue 0 is present, it is automatically configured as if a <ref
3220 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
3221 and <ref table="Queue" column="other_config"/> columns had been
3223 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
3224 this case. With some queuing disciplines, this dropped all packets
3225 destined for the default queue.)
3229 <group title="Configuration for linux-htb and linux-hfsc">
3231 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
3232 the following key-value pair:
3235 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
3236 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3237 specified, for physical interfaces, the default is the link rate. For
3238 other interfaces or if the link rate cannot be determined, the default
3239 is currently 100 Mbps.
3243 <group title="Common Columns">
3244 The overall purpose of these columns is described under <code>Common
3245 Columns</code> at the beginning of this document.
3247 <column name="other_config"/>
3248 <column name="external_ids"/>
3252 <table name="Queue" title="QoS output queue.">
3253 <p>A configuration for a port output queue, used in configuring Quality of
3254 Service (QoS) features. May be referenced by <ref column="queues"
3255 table="QoS"/> column in <ref table="QoS"/> table.</p>
3257 <column name="dscp">
3258 If set, Open vSwitch will mark all traffic egressing this
3259 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3260 default <ref table="Queue"/> is only marked if it was explicitly selected
3261 as the <ref table="Queue"/> at the time the packet was output. If unset,
3262 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3266 <group title="Configuration for linux-htb QoS">
3268 <ref table="QoS"/> <ref table="QoS" column="type"/>
3269 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3270 It has the following key-value pairs defined.
3273 <column name="other_config" key="min-rate"
3274 type='{"type": "integer", "minInteger": 1}'>
3275 Minimum guaranteed bandwidth, in bit/s.
3278 <column name="other_config" key="max-rate"
3279 type='{"type": "integer", "minInteger": 1}'>
3280 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3281 queue's rate will not be allowed to exceed the specified value, even
3282 if excess bandwidth is available. If unspecified, defaults to no
3286 <column name="other_config" key="burst"
3287 type='{"type": "integer", "minInteger": 1}'>
3288 Burst size, in bits. This is the maximum amount of ``credits'' that a
3289 queue can accumulate while it is idle. Optional. Details of the
3290 <code>linux-htb</code> implementation require a minimum burst size, so
3291 a too-small <code>burst</code> will be silently ignored.
3294 <column name="other_config" key="priority"
3295 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3296 A queue with a smaller <code>priority</code> will receive all the
3297 excess bandwidth that it can use before a queue with a larger value
3298 receives any. Specific priority values are unimportant; only relative
3299 ordering matters. Defaults to 0 if unspecified.
3303 <group title="Configuration for linux-hfsc QoS">
3305 <ref table="QoS"/> <ref table="QoS" column="type"/>
3306 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3307 It has the following key-value pairs defined.
3310 <column name="other_config" key="min-rate"
3311 type='{"type": "integer", "minInteger": 1}'>
3312 Minimum guaranteed bandwidth, in bit/s.
3315 <column name="other_config" key="max-rate"
3316 type='{"type": "integer", "minInteger": 1}'>
3317 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3318 queue's rate will not be allowed to exceed the specified value, even if
3319 excess bandwidth is available. If unspecified, defaults to no
3324 <group title="Common Columns">
3325 The overall purpose of these columns is described under <code>Common
3326 Columns</code> at the beginning of this document.
3328 <column name="other_config"/>
3329 <column name="external_ids"/>
3333 <table name="Mirror" title="Port mirroring.">
3334 <p>A port mirror within a <ref table="Bridge"/>.</p>
3335 <p>A port mirror configures a bridge to send selected frames to special
3336 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3337 traffic may also be referred to as SPAN or RSPAN, depending on how
3338 the mirrored traffic is sent.</p>
3340 <column name="name">
3341 Arbitrary identifier for the <ref table="Mirror"/>.
3344 <group title="Selecting Packets for Mirroring">
3346 To be selected for mirroring, a given packet must enter or leave the
3347 bridge through a selected port and it must also be in one of the
3351 <column name="select_all">
3352 If true, every packet arriving or departing on any port is
3353 selected for mirroring.
3356 <column name="select_dst_port">
3357 Ports on which departing packets are selected for mirroring.
3360 <column name="select_src_port">
3361 Ports on which arriving packets are selected for mirroring.
3364 <column name="select_vlan">
3365 VLANs on which packets are selected for mirroring. An empty set
3366 selects packets on all VLANs.
3370 <group title="Mirroring Destination Configuration">
3372 These columns are mutually exclusive. Exactly one of them must be
3376 <column name="output_port">
3377 <p>Output port for selected packets, if nonempty.</p>
3378 <p>Specifying a port for mirror output reserves that port exclusively
3379 for mirroring. No frames other than those selected for mirroring
3381 will be forwarded to the port, and any frames received on the port
3382 will be discarded.</p>
3384 The output port may be any kind of port supported by Open vSwitch.
3385 It may be, for example, a physical port (sometimes called SPAN) or a
3390 <column name="output_vlan">
3391 <p>Output VLAN for selected packets, if nonempty.</p>
3392 <p>The frames will be sent out all ports that trunk
3393 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3394 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3395 trunk port, the frame's VLAN tag will be set to
3396 <ref column="output_vlan"/>, replacing any existing tag; when it is
3397 sent out an implicit VLAN port, the frame will not be tagged. This
3398 type of mirroring is sometimes called RSPAN.</p>
3400 See the documentation for
3401 <ref column="other_config" key="forward-bpdu"/> in the
3402 <ref table="Interface"/> table for a list of destination MAC
3403 addresses which will not be mirrored to a VLAN to avoid confusing
3404 switches that interpret the protocols that they represent.
3406 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3407 contains unmanaged switches. Consider an unmanaged physical switch
3408 with two ports: port 1, connected to an end host, and port 2,
3409 connected to an Open vSwitch configured to mirror received packets
3410 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3411 port 1 that the physical switch forwards to port 2. The Open vSwitch
3412 forwards this packet to its destination and then reflects it back on
3413 port 2 in VLAN 123. This reflected packet causes the unmanaged
3414 physical switch to replace the MAC learning table entry, which
3415 correctly pointed to port 1, with one that incorrectly points to port
3416 2. Afterward, the physical switch will direct packets destined for
3417 the end host to the Open vSwitch on port 2, instead of to the end
3418 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3419 desired in this scenario, then the physical switch must be replaced
3420 by one that learns Ethernet addresses on a per-VLAN basis. In
3421 addition, learning should be disabled on the VLAN containing mirrored
3422 traffic. If this is not done then intermediate switches will learn
3423 the MAC address of each end host from the mirrored traffic. If
3424 packets being sent to that end host are also mirrored, then they will
3425 be dropped since the switch will attempt to send them out the input
3426 port. Disabling learning for the VLAN will cause the switch to
3427 correctly send the packet out all ports configured for that VLAN. If
3428 Open vSwitch is being used as an intermediate switch, learning can be
3429 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3430 in the appropriate <ref table="Bridge"/> table or tables.</p>
3432 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3433 VLAN and should generally be preferred.
3438 <group title="Statistics: Mirror counters">
3440 Key-value pairs that report mirror statistics. The update period
3441 is controlled by <ref column="other_config"
3442 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3444 <column name="statistics" key="tx_packets">
3445 Number of packets transmitted through this mirror.
3447 <column name="statistics" key="tx_bytes">
3448 Number of bytes transmitted through this mirror.
3452 <group title="Common Columns">
3453 The overall purpose of these columns is described under <code>Common
3454 Columns</code> at the beginning of this document.
3456 <column name="external_ids"/>
3460 <table name="Controller" title="OpenFlow controller configuration.">
3461 <p>An OpenFlow controller.</p>
3464 Open vSwitch supports two kinds of OpenFlow controllers:
3468 <dt>Primary controllers</dt>
3471 This is the kind of controller envisioned by the OpenFlow 1.0
3472 specification. Usually, a primary controller implements a network
3473 policy by taking charge of the switch's flow table.
3477 Open vSwitch initiates and maintains persistent connections to
3478 primary controllers, retrying the connection each time it fails or
3479 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3480 <ref table="Bridge"/> table applies to primary controllers.
3484 Open vSwitch permits a bridge to have any number of primary
3485 controllers. When multiple controllers are configured, Open
3486 vSwitch connects to all of them simultaneously. Because
3487 OpenFlow 1.0 does not specify how multiple controllers
3488 coordinate in interacting with a single switch, more than
3489 one primary controller should be specified only if the
3490 controllers are themselves designed to coordinate with each
3491 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3492 vendor extension may be useful for this.)
3495 <dt>Service controllers</dt>
3498 These kinds of OpenFlow controller connections are intended for
3499 occasional support and maintenance use, e.g. with
3500 <code>ovs-ofctl</code>. Usually a service controller connects only
3501 briefly to inspect or modify some of a switch's state.
3505 Open vSwitch listens for incoming connections from service
3506 controllers. The service controllers initiate and, if necessary,
3507 maintain the connections from their end. The <ref table="Bridge"
3508 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3509 not apply to service controllers.
3513 Open vSwitch supports configuring any number of service controllers.
3519 The <ref column="target"/> determines the type of controller.
3522 <group title="Core Features">
3523 <column name="target">
3524 <p>Connection method for controller.</p>
3526 The following connection methods are currently supported for primary
3530 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3532 <p>The specified SSL <var>port</var> on the host at the
3533 given <var>ip</var>, which must be expressed as an IP
3534 address (not a DNS name). The <ref table="Open_vSwitch"
3535 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3536 table must point to a valid SSL configuration when this form
3538 <p>If <var>port</var> is not specified, it defaults to 6653.</p>
3539 <p>SSL support is an optional feature that is not always built as
3540 part of Open vSwitch.</p>
3542 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3545 The specified TCP <var>port</var> on the host at the given
3546 <var>ip</var>, which must be expressed as an IP address (not a
3547 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3548 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3549 e.g. <code>tcp:[::1]:6653</code>.
3552 If <var>port</var> is not specified, it defaults to 6653.
3557 The following connection methods are currently supported for service
3561 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3564 Listens for SSL connections on the specified TCP <var>port</var>.
3565 If <var>ip</var>, which must be expressed as an IP address (not a
3566 DNS name), is specified, then connections are restricted to the
3567 specified local IP address (either IPv4 or IPv6). If
3568 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3569 e.g. <code>pssl:6653:[::1]</code>.
3572 If <var>port</var> is not specified, it defaults to
3573 6653. If <var>ip</var> is not specified then it listens only on
3574 IPv4 (but not IPv6) addresses. The
3575 <ref table="Open_vSwitch" column="ssl"/>
3576 column in the <ref table="Open_vSwitch"/> table must point to a
3577 valid SSL configuration when this form is used.
3580 If <var>port</var> is not specified, it currently to 6653.
3583 SSL support is an optional feature that is not always built as
3584 part of Open vSwitch.
3587 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3590 Listens for connections on the specified TCP <var>port</var>. If
3591 <var>ip</var>, which must be expressed as an IP address (not a
3592 DNS name), is specified, then connections are restricted to the
3593 specified local IP address (either IPv4 or IPv6). If
3594 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3595 e.g. <code>ptcp:6653:[::1]</code>. If <var>ip</var> is not
3596 specified then it listens only on IPv4 addresses.
3599 If <var>port</var> is not specified, it defaults to 6653.
3603 <p>When multiple controllers are configured for a single bridge, the
3604 <ref column="target"/> values must be unique. Duplicate
3605 <ref column="target"/> values yield unspecified results.</p>
3608 <column name="connection_mode">
3609 <p>If it is specified, this setting must be one of the following
3610 strings that describes how Open vSwitch contacts this OpenFlow
3611 controller over the network:</p>
3614 <dt><code>in-band</code></dt>
3615 <dd>In this mode, this controller's OpenFlow traffic travels over the
3616 bridge associated with the controller. With this setting, Open
3617 vSwitch allows traffic to and from the controller regardless of the
3618 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3619 would never be able to connect to the controller, because it did
3620 not have a flow to enable it.) This is the most common connection
3621 mode because it is not necessary to maintain two independent
3623 <dt><code>out-of-band</code></dt>
3624 <dd>In this mode, OpenFlow traffic uses a control network separate
3625 from the bridge associated with this controller, that is, the
3626 bridge does not use any of its own network devices to communicate
3627 with the controller. The control network must be configured
3628 separately, before or after <code>ovs-vswitchd</code> is started.
3632 <p>If not specified, the default is implementation-specific.</p>
3636 <group title="Controller Failure Detection and Handling">
3637 <column name="max_backoff">
3638 Maximum number of milliseconds to wait between connection attempts.
3639 Default is implementation-specific.
3642 <column name="inactivity_probe">
3643 Maximum number of milliseconds of idle time on connection to
3644 controller before sending an inactivity probe message. If Open
3645 vSwitch does not communicate with the controller for the specified
3646 number of seconds, it will send a probe. If a response is not
3647 received for the same additional amount of time, Open vSwitch
3648 assumes the connection has been broken and attempts to reconnect.
3649 Default is implementation-specific. A value of 0 disables
3654 <group title="Asynchronous Messages">
3656 OpenFlow switches send certain messages to controllers spontanenously,
3657 that is, not in response to any request from the controller. These
3658 messages are called ``asynchronous messages.'' These columns allow
3659 asynchronous messages to be limited or disabled to ensure the best use
3660 of network resources.
3663 <column name="enable_async_messages">
3664 The OpenFlow protocol enables asynchronous messages at time of
3665 connection establishment, which means that a controller can receive
3666 asynchronous messages, potentially many of them, even if it turns them
3667 off immediately after connecting. Set this column to
3668 <code>false</code> to change Open vSwitch behavior to disable, by
3669 default, all asynchronous messages. The controller can use the
3670 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3671 on any messages that it does want to receive, if any.
3674 <group title="Controller Rate Limiting">
3676 A switch can forward packets to a controller over the OpenFlow
3677 protocol. Forwarding packets this way at too high a rate can
3678 overwhelm a controller, frustrate use of the OpenFlow connection for
3679 other purposes, increase the latency of flow setup, and use an
3680 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3681 limiting the rate of packet forwarding to a controller.
3685 There are two main reasons in OpenFlow for a packet to be sent to a
3686 controller: either the packet ``misses'' in the flow table, that is,
3687 there is no matching flow, or a flow table action says to send the
3688 packet to the controller. Open vSwitch limits the rate of each kind
3689 of packet separately at the configured rate. Therefore, the actual
3690 rate that packets are sent to the controller can be up to twice the
3691 configured rate, when packets are sent for both reasons.
3695 This feature is specific to forwarding packets over an OpenFlow
3696 connection. It is not general-purpose QoS. See the <ref
3697 table="QoS"/> table for quality of service configuration, and <ref
3698 column="ingress_policing_rate" table="Interface"/> in the <ref
3699 table="Interface"/> table for ingress policing configuration.
3702 <column name="controller_rate_limit">
3704 The maximum rate at which the switch will forward packets to the
3705 OpenFlow controller, in packets per second. If no value is
3706 specified, rate limiting is disabled.
3710 <column name="controller_burst_limit">
3712 When a high rate triggers rate-limiting, Open vSwitch queues
3713 packets to the controller for each port and transmits them to the
3714 controller at the configured rate. This value limits the number of
3715 queued packets. Ports on a bridge share the packet queue fairly.
3719 This value has no effect unless <ref
3720 column="controller_rate_limit"/> is configured. The current
3721 default when this value is not specified is one-quarter of <ref
3722 column="controller_rate_limit"/>, meaning that queuing can delay
3723 forwarding a packet to the controller by up to 250 ms.
3727 <group title="Controller Rate Limiting Statistics">
3729 These values report the effects of rate limiting. Their values are
3730 relative to establishment of the most recent OpenFlow connection,
3731 or since rate limiting was enabled, whichever happened more
3732 recently. Each consists of two values, one with <code>TYPE</code>
3733 replaced by <code>miss</code> for rate limiting flow table misses,
3734 and the other with <code>TYPE</code> replaced by
3735 <code>action</code> for rate limiting packets sent by OpenFlow
3740 These statistics are reported only when controller rate limiting is
3744 <column name="status" key="packet-in-TYPE-bypassed"
3745 type='{"type": "integer", "minInteger": 0}'>
3746 Number of packets sent directly to the controller, without queuing,
3747 because the rate did not exceed the configured maximum.
3750 <column name="status" key="packet-in-TYPE-queued"
3751 type='{"type": "integer", "minInteger": 0}'>
3752 Number of packets added to the queue to send later.
3755 <column name="status" key="packet-in-TYPE-dropped"
3756 type='{"type": "integer", "minInteger": 0}'>
3757 Number of packets added to the queue that were later dropped due to
3758 overflow. This value is less than or equal to <ref column="status"
3759 key="packet-in-TYPE-queued"/>.
3762 <column name="status" key="packet-in-TYPE-backlog"
3763 type='{"type": "integer", "minInteger": 0}'>
3764 Number of packets currently queued. The other statistics increase
3765 monotonically, but this one fluctuates between 0 and the <ref
3766 column="controller_burst_limit"/> as conditions change.
3772 <group title="Additional In-Band Configuration">
3773 <p>These values are considered only in in-band control mode (see
3774 <ref column="connection_mode"/>).</p>
3776 <p>When multiple controllers are configured on a single bridge, there
3777 should be only one set of unique values in these columns. If different
3778 values are set for these columns in different controllers, the effect
3781 <column name="local_ip">
3782 The IP address to configure on the local port,
3783 e.g. <code>192.168.0.123</code>. If this value is unset, then
3784 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3788 <column name="local_netmask">
3789 The IP netmask to configure on the local port,
3790 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3791 but this value is unset, then the default is chosen based on whether
3792 the IP address is class A, B, or C.
3795 <column name="local_gateway">
3796 The IP address of the gateway to configure on the local port, as a
3797 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3798 this network has no gateway.
3802 <group title="Controller Status">
3803 <column name="is_connected">
3804 <code>true</code> if currently connected to this controller,
3805 <code>false</code> otherwise.
3809 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3810 <p>The level of authority this controller has on the associated
3811 bridge. Possible values are:</p>
3813 <dt><code>other</code></dt>
3814 <dd>Allows the controller access to all OpenFlow features.</dd>
3815 <dt><code>master</code></dt>
3816 <dd>Equivalent to <code>other</code>, except that there may be at
3817 most one master controller at a time. When a controller configures
3818 itself as <code>master</code>, any existing master is demoted to
3819 the <code>slave</code> role.</dd>
3820 <dt><code>slave</code></dt>
3821 <dd>Allows the controller read-only access to OpenFlow features.
3822 Attempts to modify the flow table will be rejected with an
3823 error. Slave controllers do not receive OFPT_PACKET_IN or
3824 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3829 <column name="status" key="last_error">
3830 A human-readable description of the last error on the connection
3831 to the controller; i.e. <code>strerror(errno)</code>. This key
3832 will exist only if an error has occurred.
3835 <column name="status" key="state"
3836 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3838 The state of the connection to the controller:
3841 <dt><code>VOID</code></dt>
3842 <dd>Connection is disabled.</dd>
3844 <dt><code>BACKOFF</code></dt>
3845 <dd>Attempting to reconnect at an increasing period.</dd>
3847 <dt><code>CONNECTING</code></dt>
3848 <dd>Attempting to connect.</dd>
3850 <dt><code>ACTIVE</code></dt>
3851 <dd>Connected, remote host responsive.</dd>
3853 <dt><code>IDLE</code></dt>
3854 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3857 These values may change in the future. They are provided only for
3862 <column name="status" key="sec_since_connect"
3863 type='{"type": "integer", "minInteger": 0}'>
3864 The amount of time since this controller last successfully connected to
3865 the switch (in seconds). Value is empty if controller has never
3866 successfully connected.
3869 <column name="status" key="sec_since_disconnect"
3870 type='{"type": "integer", "minInteger": 1}'>
3871 The amount of time since this controller last disconnected from
3872 the switch (in seconds). Value is empty if controller has never
3877 <group title="Connection Parameters">
3879 Additional configuration for a connection between the controller
3880 and the Open vSwitch.
3883 <column name="other_config" key="dscp"
3884 type='{"type": "integer"}'>
3885 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3886 in the Type of Service (TOS) field in the IP header. DSCP provides a
3887 mechanism to classify the network traffic and provide Quality of
3888 Service (QoS) on IP networks.
3890 The DSCP value specified here is used when establishing the connection
3891 between the controller and the Open vSwitch. If no value is specified,
3892 a default value of 48 is chosen. Valid DSCP values must be in the
3898 <group title="Common Columns">
3899 The overall purpose of these columns is described under <code>Common
3900 Columns</code> at the beginning of this document.
3902 <column name="external_ids"/>
3903 <column name="other_config"/>
3907 <table name="Manager" title="OVSDB management connection.">
3909 Configuration for a database connection to an Open vSwitch database
3914 This table primarily configures the Open vSwitch database
3915 (<code>ovsdb-server</code>), not the Open vSwitch switch
3916 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3917 what connections should be treated as in-band.
3921 The Open vSwitch database server can initiate and maintain active
3922 connections to remote clients. It can also listen for database
3926 <group title="Core Features">
3927 <column name="target">
3928 <p>Connection method for managers.</p>
3930 The following connection methods are currently supported:
3933 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3936 The specified SSL <var>port</var> on the host at the given
3937 <var>ip</var>, which must be expressed as an IP address
3938 (not a DNS name). The <ref table="Open_vSwitch"
3939 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3940 table must point to a valid SSL configuration when this
3944 If <var>port</var> is not specified, it defaults to 6640.
3947 SSL support is an optional feature that is not always
3948 built as part of Open vSwitch.
3952 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3955 The specified TCP <var>port</var> on the host at the given
3956 <var>ip</var>, which must be expressed as an IP address (not a
3957 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3958 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3959 e.g. <code>tcp:[::1]:6640</code>.
3962 If <var>port</var> is not specified, it defaults to 6640.
3965 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3968 Listens for SSL connections on the specified TCP <var>port</var>.
3969 Specify 0 for <var>port</var> to have the kernel automatically
3970 choose an available port. If <var>ip</var>, which must be
3971 expressed as an IP address (not a DNS name), is specified, then
3972 connections are restricted to the specified local IP address
3973 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3974 address, wrap in square brackets,
3975 e.g. <code>pssl:6640:[::1]</code>. If <var>ip</var> is not
3976 specified then it listens only on IPv4 (but not IPv6) addresses.
3977 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3978 table="Open_vSwitch"/> table must point to a valid SSL
3979 configuration when this form is used.
3982 If <var>port</var> is not specified, it defaults to 6640.
3985 SSL support is an optional feature that is not always built as
3986 part of Open vSwitch.
3989 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3992 Listens for connections on the specified TCP <var>port</var>.
3993 Specify 0 for <var>port</var> to have the kernel automatically
3994 choose an available port. If <var>ip</var>, which must be
3995 expressed as an IP address (not a DNS name), is specified, then
3996 connections are restricted to the specified local IP address
3997 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3998 address, wrap it in square brackets,
3999 e.g. <code>ptcp:6640:[::1]</code>. If <var>ip</var> is not
4000 specified then it listens only on IPv4 addresses.
4003 If <var>port</var> is not specified, it defaults to 6640.
4007 <p>When multiple managers are configured, the <ref column="target"/>
4008 values must be unique. Duplicate <ref column="target"/> values yield
4009 unspecified results.</p>
4012 <column name="connection_mode">
4014 If it is specified, this setting must be one of the following strings
4015 that describes how Open vSwitch contacts this OVSDB client over the
4020 <dt><code>in-band</code></dt>
4022 In this mode, this connection's traffic travels over a bridge
4023 managed by Open vSwitch. With this setting, Open vSwitch allows
4024 traffic to and from the client regardless of the contents of the
4025 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4026 to connect to the client, because it did not have a flow to enable
4027 it.) This is the most common connection mode because it is not
4028 necessary to maintain two independent networks.
4030 <dt><code>out-of-band</code></dt>
4032 In this mode, the client's traffic uses a control network separate
4033 from that managed by Open vSwitch, that is, Open vSwitch does not
4034 use any of its own network devices to communicate with the client.
4035 The control network must be configured separately, before or after
4036 <code>ovs-vswitchd</code> is started.
4041 If not specified, the default is implementation-specific.
4046 <group title="Client Failure Detection and Handling">
4047 <column name="max_backoff">
4048 Maximum number of milliseconds to wait between connection attempts.
4049 Default is implementation-specific.
4052 <column name="inactivity_probe">
4053 Maximum number of milliseconds of idle time on connection to the client
4054 before sending an inactivity probe message. If Open vSwitch does not
4055 communicate with the client for the specified number of seconds, it
4056 will send a probe. If a response is not received for the same
4057 additional amount of time, Open vSwitch assumes the connection has been
4058 broken and attempts to reconnect. Default is implementation-specific.
4059 A value of 0 disables inactivity probes.
4063 <group title="Status">
4064 <column name="is_connected">
4065 <code>true</code> if currently connected to this manager,
4066 <code>false</code> otherwise.
4069 <column name="status" key="last_error">
4070 A human-readable description of the last error on the connection
4071 to the manager; i.e. <code>strerror(errno)</code>. This key
4072 will exist only if an error has occurred.
4075 <column name="status" key="state"
4076 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
4078 The state of the connection to the manager:
4081 <dt><code>VOID</code></dt>
4082 <dd>Connection is disabled.</dd>
4084 <dt><code>BACKOFF</code></dt>
4085 <dd>Attempting to reconnect at an increasing period.</dd>
4087 <dt><code>CONNECTING</code></dt>
4088 <dd>Attempting to connect.</dd>
4090 <dt><code>ACTIVE</code></dt>
4091 <dd>Connected, remote host responsive.</dd>
4093 <dt><code>IDLE</code></dt>
4094 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
4097 These values may change in the future. They are provided only for
4102 <column name="status" key="sec_since_connect"
4103 type='{"type": "integer", "minInteger": 0}'>
4104 The amount of time since this manager last successfully connected
4105 to the database (in seconds). Value is empty if manager has never
4106 successfully connected.
4109 <column name="status" key="sec_since_disconnect"
4110 type='{"type": "integer", "minInteger": 0}'>
4111 The amount of time since this manager last disconnected from the
4112 database (in seconds). Value is empty if manager has never
4116 <column name="status" key="locks_held">
4117 Space-separated list of the names of OVSDB locks that the connection
4118 holds. Omitted if the connection does not hold any locks.
4121 <column name="status" key="locks_waiting">
4122 Space-separated list of the names of OVSDB locks that the connection is
4123 currently waiting to acquire. Omitted if the connection is not waiting
4127 <column name="status" key="locks_lost">
4128 Space-separated list of the names of OVSDB locks that the connection
4129 has had stolen by another OVSDB client. Omitted if no locks have been
4130 stolen from this connection.
4133 <column name="status" key="n_connections"
4134 type='{"type": "integer", "minInteger": 2}'>
4136 When <ref column="target"/> specifies a connection method that
4137 listens for inbound connections (e.g. <code>ptcp:</code> or
4138 <code>pssl:</code>) and more than one connection is actually active,
4139 the value is the number of active connections. Otherwise, this
4140 key-value pair is omitted.
4143 When multiple connections are active, status columns and key-value
4144 pairs (other than this one) report the status of one arbitrarily
4149 <column name="status" key="bound_port" type='{"type": "integer"}'>
4150 When <ref column="target"/> is <code>ptcp:</code> or
4151 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
4152 listening. (This is is particularly useful when <ref
4153 column="target"/> specifies a port of 0, allowing the kernel to
4154 choose any available port.)
4158 <group title="Connection Parameters">
4160 Additional configuration for a connection between the manager
4161 and the Open vSwitch Database.
4164 <column name="other_config" key="dscp"
4165 type='{"type": "integer"}'>
4166 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4167 in the Type of Service (TOS) field in the IP header. DSCP provides a
4168 mechanism to classify the network traffic and provide Quality of
4169 Service (QoS) on IP networks.
4171 The DSCP value specified here is used when establishing the connection
4172 between the manager and the Open vSwitch. If no value is specified, a
4173 default value of 48 is chosen. Valid DSCP values must be in the range
4178 <group title="Common Columns">
4179 The overall purpose of these columns is described under <code>Common
4180 Columns</code> at the beginning of this document.
4182 <column name="external_ids"/>
4183 <column name="other_config"/>
4187 <table name="NetFlow">
4188 A NetFlow target. NetFlow is a protocol that exports a number of
4189 details about terminating IP flows, such as the principals involved
4192 <column name="targets">
4193 NetFlow targets in the form
4194 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
4195 must be specified numerically, not as a DNS name.
4198 <column name="engine_id">
4199 Engine ID to use in NetFlow messages. Defaults to datapath index
4203 <column name="engine_type">
4204 Engine type to use in NetFlow messages. Defaults to datapath
4205 index if not specified.
4208 <column name="active_timeout">
4210 The interval at which NetFlow records are sent for flows that
4211 are still active, in seconds. A value of <code>0</code>
4212 requests the default timeout (currently 600 seconds); a value
4213 of <code>-1</code> disables active timeouts.
4217 The NetFlow passive timeout, for flows that become inactive,
4218 is not configurable. It will vary depending on the Open
4219 vSwitch version, the forms and contents of the OpenFlow flow
4220 tables, CPU and memory usage, and network activity. A typical
4221 passive timeout is about a second.
4225 <column name="add_id_to_interface">
4226 <p>If this column's value is <code>false</code>, the ingress and egress
4227 interface fields of NetFlow flow records are derived from OpenFlow port
4228 numbers. When it is <code>true</code>, the 7 most significant bits of
4229 these fields will be replaced by the least significant 7 bits of the
4230 engine id. This is useful because many NetFlow collectors do not
4231 expect multiple switches to be sending messages from the same host, so
4232 they do not store the engine information which could be used to
4233 disambiguate the traffic.</p>
4234 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
4237 <group title="Common Columns">
4238 The overall purpose of these columns is described under <code>Common
4239 Columns</code> at the beginning of this document.
4241 <column name="external_ids"/>
4246 SSL configuration for an Open_vSwitch.
4248 <column name="private_key">
4249 Name of a PEM file containing the private key used as the switch's
4250 identity for SSL connections to the controller.
4253 <column name="certificate">
4254 Name of a PEM file containing a certificate, signed by the
4255 certificate authority (CA) used by the controller and manager,
4256 that certifies the switch's private key, identifying a trustworthy
4260 <column name="ca_cert">
4261 Name of a PEM file containing the CA certificate used to verify
4262 that the switch is connected to a trustworthy controller.
4265 <column name="bootstrap_ca_cert">
4266 If set to <code>true</code>, then Open vSwitch will attempt to
4267 obtain the CA certificate from the controller on its first SSL
4268 connection and save it to the named PEM file. If it is successful,
4269 it will immediately drop the connection and reconnect, and from then
4270 on all SSL connections must be authenticated by a certificate signed
4271 by the CA certificate thus obtained. <em>This option exposes the
4272 SSL connection to a man-in-the-middle attack obtaining the initial
4273 CA certificate.</em> It may still be useful for bootstrapping.
4276 <group title="Common Columns">
4277 The overall purpose of these columns is described under <code>Common
4278 Columns</code> at the beginning of this document.
4280 <column name="external_ids"/>
4284 <table name="sFlow">
4285 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4286 monitoring of switches.</p>
4288 <column name="agent">
4289 Name of the network device whose IP address should be reported as the
4290 ``agent address'' to collectors. If not specified, the agent device is
4291 figured from the first target address and the routing table. If the
4292 routing table does not contain a route to the target, the IP address
4293 defaults to the <ref table="Controller" column="local_ip"/> in the
4294 collector's <ref table="Controller"/>. If an agent IP address cannot be
4295 determined any of these ways, sFlow is disabled.
4298 <column name="header">
4299 Number of bytes of a sampled packet to send to the collector.
4300 If not specified, the default is 128 bytes.
4303 <column name="polling">
4304 Polling rate in seconds to send port statistics to the collector.
4305 If not specified, defaults to 30 seconds.
4308 <column name="sampling">
4309 Rate at which packets should be sampled and sent to the collector.
4310 If not specified, defaults to 400, which means one out of 400
4311 packets, on average, will be sent to the collector.
4314 <column name="targets">
4315 sFlow targets in the form
4316 <code><var>ip</var>:<var>port</var></code>.
4319 <group title="Common Columns">
4320 The overall purpose of these columns is described under <code>Common
4321 Columns</code> at the beginning of this document.
4323 <column name="external_ids"/>
4327 <table name="IPFIX">
4328 <p>Configuration for sending packets to IPFIX collectors.</p>
4331 IPFIX is a protocol that exports a number of details about flows. The
4332 IPFIX implementation in Open vSwitch samples packets at a configurable
4333 rate, extracts flow information from those packets, optionally caches and
4334 aggregates the flow information, and sends the result to one or more
4339 IPFIX in Open vSwitch can be configured two different ways:
4344 With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling
4345 automatically on all packets that pass through a bridge. To configure
4346 per-bridge sampling, create an <ref table="IPFIX"/> record and point a
4347 <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/>
4348 column to it. The <ref table="Flow_Sample_Collector_Set"/> table is
4349 not used for per-bridge sampling.
4354 With <em>flow-based sampling</em>, <code>sample</code> actions in the
4355 OpenFlow flow table drive IPFIX sampling. See
4356 <code>ovs-ofctl</code>(8) for a description of the
4357 <code>sample</code> action.
4361 Flow-based sampling also requires database configuration: create a
4362 <ref table="IPFIX"/> record that describes the IPFIX configuration
4363 and a <ref table="Flow_Sample_Collector_Set"/> record that points to
4364 the <ref table="Bridge"/> whose flow table holds the
4365 <code>sample</code> actions and to <ref table="IPFIX"/> record. The
4366 <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/>
4367 table is not used for flow-based sampling.
4372 <column name="targets">
4373 IPFIX target collectors in the form
4374 <code><var>ip</var>:<var>port</var></code>.
4377 <column name="cache_active_timeout">
4378 The maximum period in seconds for which an IPFIX flow record is
4379 cached and aggregated before being sent. If not specified,
4380 defaults to 0. If 0, caching is disabled.
4383 <column name="cache_max_flows">
4384 The maximum number of IPFIX flow records that can be cached at a
4385 time. If not specified, defaults to 0. If 0, caching is
4389 <group title="Per-Bridge Sampling">
4391 These values affect only per-bridge sampling. See above for a
4392 description of the differences between per-bridge and flow-based
4396 <column name="sampling">
4397 The rate at which packets should be sampled and sent to each target
4398 collector. If not specified, defaults to 400, which means one out of
4399 400 packets, on average, will be sent to each target collector.
4402 <column name="obs_domain_id">
4403 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4404 specified, defaults to 0.
4407 <column name="obs_point_id">
4408 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4409 specified, defaults to 0.
4412 <column name="other_config" key="enable-tunnel-sampling"
4413 type='{"type": "boolean"}'>
4415 Set to <code>true</code> to enable sampling and reporting tunnel
4416 header 7-tuples in IPFIX flow records. Tunnel sampling is disabled
4421 The following enterprise entities report the sampled tunnel info:
4425 <dt>tunnelType:</dt>
4427 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4428 <p>type: unsigned 8-bit integer.</p>
4429 <p>data type semantics: identifier.</p>
4430 <p>description: Identifier of the layer 2 network overlay network
4431 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4436 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4437 <p>type: variable-length octetarray.</p>
4438 <p>data type semantics: identifier.</p>
4439 <p>description: Key which is used for identifying an individual
4440 traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI),
4441 GRE (32- or 64-bit key), or LISP (24-bit instance ID) tunnel. The
4442 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4443 ID in network byte order.</p>
4445 <dt>tunnelSourceIPv4Address:</dt>
4447 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4448 <p>type: unsigned 32-bit integer.</p>
4449 <p>data type semantics: identifier.</p>
4450 <p>description: The IPv4 source address in the tunnel IP packet
4453 <dt>tunnelDestinationIPv4Address:</dt>
4455 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4456 <p>type: unsigned 32-bit integer.</p>
4457 <p>data type semantics: identifier.</p>
4458 <p>description: The IPv4 destination address in the tunnel IP
4461 <dt>tunnelProtocolIdentifier:</dt>
4463 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4464 <p>type: unsigned 8-bit integer.</p>
4465 <p>data type semantics: identifier.</p>
4466 <p>description: The value of the protocol number in the tunnel
4467 IP packet header. The protocol number identifies the tunnel IP
4468 packet payload type.</p>
4470 <dt>tunnelSourceTransportPort:</dt>
4472 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4473 <p>type: unsigned 16-bit integer.</p>
4474 <p>data type semantics: identifier.</p>
4475 <p>description: The source port identifier in the tunnel transport
4476 header. For the transport protocols UDP, TCP, and SCTP, this is
4477 the source port number given in the respective header.</p>
4479 <dt>tunnelDestinationTransportPort:</dt>
4481 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4482 <p>type: unsigned 16-bit integer.</p>
4483 <p>data type semantics: identifier.</p>
4484 <p>description: The destination port identifier in the tunnel
4485 transport header. For the transport protocols UDP, TCP, and SCTP,
4486 this is the destination port number given in the respective header.
4492 <column name="other_config" key="enable-input-sampling"
4493 type='{"type": "boolean"}'>
4494 By default, Open vSwitch samples and reports flows at bridge port input
4495 in IPFIX flow records. Set this column to <code>false</code> to
4496 disable input sampling.
4499 <column name="other_config" key="enable-output-sampling"
4500 type='{"type": "boolean"}'>
4501 By default, Open vSwitch samples and reports flows at bridge port
4502 output in IPFIX flow records. Set this column to <code>false</code> to
4503 disable output sampling.
4507 <group title="Common Columns">
4508 The overall purpose of these columns is described under <code>Common
4509 Columns</code> at the beginning of this document.
4511 <column name="external_ids"/>
4515 <table name="Flow_Sample_Collector_Set">
4517 A set of IPFIX collectors of packet samples generated by OpenFlow
4518 <code>sample</code> actions. This table is used only for IPFIX
4519 flow-based sampling, not for per-bridge sampling (see the <ref
4520 table="IPFIX"/> table for a description of the two forms).
4524 The ID of this collector set, unique among the bridge's
4525 collector sets, to be used as the <code>collector_set_id</code>
4526 in OpenFlow <code>sample</code> actions.
4529 <column name="bridge">
4530 The bridge into which OpenFlow <code>sample</code> actions can
4531 be added to send packet samples to this set of IPFIX collectors.
4534 <column name="ipfix">
4535 Configuration of the set of IPFIX collectors to send one flow
4536 record per sampled packet to.
4539 <group title="Common Columns">
4540 The overall purpose of these columns is described under <code>Common
4541 Columns</code> at the beginning of this document.
4543 <column name="external_ids"/>
4547 <table name="AutoAttach">
4548 <p>Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4549 draft standard describes a compact method of using IEEE 802.1AB Link
4550 Layer Discovery Protocol (LLDP) together with a IEEE 802.1aq Shortest
4551 Path Bridging (SPB) network to automatically attach network devices
4552 to individual services in a SPB network. The intent here is to allow
4553 network applications and devices using OVS to be able to easily take
4554 advantage of features offered by industry standard SPB networks.</p>
4556 <p>Auto Attach (AA) uses LLDP to communicate between a directly connected
4557 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4558 is extended to add two new Type-Length-Value tuples (TLVs). The first
4559 new TLV supports the ongoing discovery of directly connected AA
4560 correspondents. Auto Attach operates by regularly transmitting AA
4561 discovery TLVs between the AA client and AA server. By exchanging these
4562 discovery messages, both the AAC and AAS learn the system name and
4563 system description of their peer. In the OVS context, OVS operates as
4564 the AA client and the AA server resides on a switch at the edge of the
4567 <p>Once AA discovery has been completed the AAC then uses the
4568 second new TLV to deliver identifier mappings from the AAC to the AAS. A primary
4569 feature of Auto Attach is to facilitate the mapping of VLANs defined
4570 outside the SPB network onto service ids (ISIDs) defined within the SPM
4571 network. By doing so individual external VLANs can be mapped onto
4572 specific SPB network services. These VLAN id to ISID mappings can be
4573 configured and managed locally using new options added to the ovs-vsctl
4576 <p>The Auto Attach OVS feature does not provide a full implementation of
4577 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
4578 standard and support for the AA TLV extensions is provided. LLDP
4579 protocol support in OVS can be enabled or disabled on a port by port
4580 basis. LLDP support is disabled by default.</p>
4582 <column name="system_name">
4583 The system_name string is exported in LLDP messages. It should uniquely
4584 identify the bridge in the network.
4587 <column name="system_description">
4588 The system_description string is exported in LLDP messages. It should
4589 describe the type of software and hardware.
4592 <column name="mappings">
4593 A mapping from SPB network Individual Service Identifier (ISID) to VLAN id.