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 maximum 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) and Multicast Listener Discovery traffic between hosts
941 and multicast routers. The switch uses what IGMP and MLD snooping
942 learns to forward multicast traffic only to interfaces that are connected
943 to interested receivers. Currently it supports IGMPv1, IGMPv2, IGMPv3,
944 MLDv1 and MLDv2 protocols.
946 <column name="mcast_snooping_enable">
947 Enable multicast snooping on the bridge. For now, the default
952 <group title="Other Features">
953 <column name="datapath_type">
954 Name of datapath provider. The kernel datapath has type
955 <code>system</code>. The userspace datapath has type
956 <code>netdev</code>. A manager may refer to the <ref
957 table="Open_vSwitch" column="datapath_types"/> column of the <ref
958 table="Open_vSwitch"/> table for a list of the types accepted by this
959 Open vSwitch instance.
962 <column name="external_ids" key="bridge-id">
963 A unique identifier of the bridge. On Citrix XenServer this will
964 commonly be the same as
965 <ref column="external_ids" key="xs-network-uuids"/>.
968 <column name="external_ids" key="xs-network-uuids">
969 Semicolon-delimited set of universally unique identifier(s) for the
970 network with which this bridge is associated on a Citrix XenServer
971 host. The network identifiers are RFC 4122 UUIDs as displayed by,
972 e.g., <code>xe network-list</code>.
975 <column name="other_config" key="hwaddr">
976 An Ethernet address in the form
977 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
978 to set the hardware address of the local port and influence the
982 <column name="other_config" key="forward-bpdu"
983 type='{"type": "boolean"}'>
986 Controls forwarding of BPDUs and other network control frames when
987 NORMAL action is invoked. When this option is <code>false</code> or
988 unset, frames with reserved Ethernet addresses (see table below) will
989 not be forwarded. When this option is <code>true</code>, such frames
990 will not be treated specially.
994 The above general rule has the following exceptions:
999 If STP is enabled on the bridge (see the <ref column="stp_enable"
1000 table="Bridge"/> column in the <ref table="Bridge"/> table), the
1001 bridge processes all received STP packets and never passes them to
1002 OpenFlow or forwards them. This is true even if STP is disabled on
1007 If LLDP is enabled on an interface (see the <ref column="lldp"
1008 table="Interface"/> column in the <ref table="Interface"/> table),
1009 the interface processes received LLDP packets and never passes them
1010 to OpenFlow or forwards them.
1015 Set this option to <code>true</code> if the Open vSwitch bridge
1016 connects different Ethernet networks and is not configured to
1021 This option affects packets with the following destination MAC
1026 <dt><code>01:80:c2:00:00:00</code></dt>
1027 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1029 <dt><code>01:80:c2:00:00:01</code></dt>
1030 <dd>IEEE Pause frame.</dd>
1032 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1033 <dd>Other reserved protocols.</dd>
1035 <dt><code>00:e0:2b:00:00:00</code></dt>
1036 <dd>Extreme Discovery Protocol (EDP).</dd>
1039 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
1041 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
1043 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1045 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1046 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1050 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1051 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1053 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1054 <dd>Cisco STP Uplink Fast.</dd>
1056 <dt><code>01:00:0c:00:00:00</code></dt>
1057 <dd>Cisco Inter Switch Link.</dd>
1059 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
1064 <column name="other_config" key="mac-aging-time"
1065 type='{"type": "integer", "minInteger": 1}'>
1067 The maximum number of seconds to retain a MAC learning entry for
1068 which no packets have been seen. The default is currently 300
1069 seconds (5 minutes). The value, if specified, is forced into a
1070 reasonable range, currently 15 to 3600 seconds.
1074 A short MAC aging time allows a network to more quickly detect that a
1075 host is no longer connected to a switch port. However, it also makes
1076 it more likely that packets will be flooded unnecessarily, when they
1077 are addressed to a connected host that rarely transmits packets. To
1078 reduce the incidence of unnecessary flooding, use a MAC aging time
1079 longer than the maximum interval at which a host will ordinarily
1084 <column name="other_config" key="mac-table-size"
1085 type='{"type": "integer", "minInteger": 1}'>
1087 The maximum number of MAC addresses to learn. The default is
1088 currently 2048. The value, if specified, is forced into a reasonable
1089 range, currently 10 to 1,000,000.
1094 <group title="Common Columns">
1095 The overall purpose of these columns is described under <code>Common
1096 Columns</code> at the beginning of this document.
1098 <column name="other_config"/>
1099 <column name="external_ids"/>
1103 <table name="Port" table="Port or bond configuration.">
1104 <p>A port within a <ref table="Bridge"/>.</p>
1105 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
1106 <ref column="interfaces"/> column. Such a port logically
1107 corresponds to a port on a physical Ethernet switch. A port
1108 with more than one interface is a ``bonded port'' (see
1109 <ref group="Bonding Configuration"/>).</p>
1110 <p>Some properties that one might think as belonging to a port are actually
1111 part of the port's <ref table="Interface"/> members.</p>
1113 <column name="name">
1114 Port name. Should be alphanumeric and no more than about 8
1115 bytes long. May be the same as the interface name, for
1116 non-bonded ports. Must otherwise be unique among the names of
1117 ports, interfaces, and bridges on a host.
1120 <column name="interfaces">
1121 The port's interfaces. If there is more than one, this is a
1125 <group title="VLAN Configuration">
1126 <p>Bridge ports support the following types of VLAN configuration:</p>
1131 A trunk port carries packets on one or more specified VLANs
1132 specified in the <ref column="trunks"/> column (often, on every
1133 VLAN). A packet that ingresses on a trunk port is in the VLAN
1134 specified in its 802.1Q header, or VLAN 0 if the packet has no
1135 802.1Q header. A packet that egresses through a trunk port will
1136 have an 802.1Q header if it has a nonzero VLAN ID.
1140 Any packet that ingresses on a trunk port tagged with a VLAN that
1141 the port does not trunk is dropped.
1148 An access port carries packets on exactly one VLAN specified in the
1149 <ref column="tag"/> column. Packets egressing on an access port
1150 have no 802.1Q header.
1154 Any packet with an 802.1Q header with a nonzero VLAN ID that
1155 ingresses on an access port is dropped, regardless of whether the
1156 VLAN ID in the header is the access port's VLAN ID.
1160 <dt>native-tagged</dt>
1162 A native-tagged port resembles a trunk port, with the exception that
1163 a packet without an 802.1Q header that ingresses on a native-tagged
1164 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1168 <dt>native-untagged</dt>
1170 A native-untagged port resembles a native-tagged port, with the
1171 exception that a packet that egresses on a native-untagged port in
1172 the native VLAN will not have an 802.1Q header.
1176 A packet will only egress through bridge ports that carry the VLAN of
1177 the packet, as described by the rules above.
1180 <column name="vlan_mode">
1182 The VLAN mode of the port, as described above. When this column is
1183 empty, a default mode is selected as follows:
1187 If <ref column="tag"/> contains a value, the port is an access
1188 port. The <ref column="trunks"/> column should be empty.
1191 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1192 column value is honored if it is present.
1199 For an access port, the port's implicitly tagged VLAN. For a
1200 native-tagged or native-untagged port, the port's native VLAN. Must
1201 be empty if this is a trunk port.
1205 <column name="trunks">
1207 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1208 or VLANs that this port trunks; if it is empty, then the port trunks
1209 all VLANs. Must be empty if this is an access port.
1212 A native-tagged or native-untagged port always trunks its native
1213 VLAN, regardless of whether <ref column="trunks"/> includes that
1218 <column name="other_config" key="priority-tags"
1219 type='{"type": "boolean"}'>
1221 An 802.1Q header contains two important pieces of information: a VLAN
1222 ID and a priority. A frame with a zero VLAN ID, called a
1223 ``priority-tagged'' frame, is supposed to be treated the same way as
1224 a frame without an 802.1Q header at all (except for the priority).
1228 However, some network elements ignore any frame that has 802.1Q
1229 header at all, even when the VLAN ID is zero. Therefore, by default
1230 Open vSwitch does not output priority-tagged frames, instead omitting
1231 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1232 <code>true</code> to enable priority-tagged frames on a port.
1236 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1237 output if both the VLAN ID and priority would be zero.
1241 All frames output to native-tagged ports have a nonzero VLAN ID, so
1242 this setting is not meaningful on native-tagged ports.
1247 <group title="Bonding Configuration">
1248 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1249 allows for load balancing and fail-over.</p>
1252 The following types of bonding will work with any kind of upstream
1253 switch. On the upstream switch, do not configure the interfaces as a
1258 <dt><code>balance-slb</code></dt>
1260 Balances flows among slaves based on source MAC address and output
1261 VLAN, with periodic rebalancing as traffic patterns change.
1264 <dt><code>active-backup</code></dt>
1266 Assigns all flows to one slave, failing over to a backup slave when
1267 the active slave is disabled. This is the only bonding mode in which
1268 interfaces may be plugged into different upstream switches.
1273 The following modes require the upstream switch to support 802.3ad with
1274 successful LACP negotiation. If LACP negotiation fails and
1275 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1280 <dt><code>balance-tcp</code></dt>
1282 Balances flows among slaves based on L2, L3, and L4 protocol
1283 information such as destination MAC address, IP address, and TCP
1288 <p>These columns apply only to bonded ports. Their values are
1289 otherwise ignored.</p>
1291 <column name="bond_mode">
1292 <p>The type of bonding used for a bonded port. Defaults to
1293 <code>active-backup</code> if unset.
1297 <column name="other_config" key="bond-hash-basis"
1298 type='{"type": "integer"}'>
1299 An integer hashed along with flows when choosing output slaves in load
1300 balanced bonds. When changed, all flows will be assigned different
1301 hash values possibly causing slave selection decisions to change. Does
1302 not affect bonding modes which do not employ load balancing such as
1303 <code>active-backup</code>.
1306 <group title="Link Failure Detection">
1308 An important part of link bonding is detecting that links are down so
1309 that they may be disabled. These settings determine how Open vSwitch
1310 detects link failure.
1313 <column name="other_config" key="bond-detect-mode"
1314 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1315 The means used to detect link failures. Defaults to
1316 <code>carrier</code> which uses each interface's carrier to detect
1317 failures. When set to <code>miimon</code>, will check for failures
1318 by polling each interface's MII.
1321 <column name="other_config" key="bond-miimon-interval"
1322 type='{"type": "integer"}'>
1323 The interval, in milliseconds, between successive attempts to poll
1324 each interface's MII. Relevant only when <ref column="other_config"
1325 key="bond-detect-mode"/> is <code>miimon</code>.
1328 <column name="bond_updelay">
1330 The number of milliseconds for which the link must stay up on an
1331 interface before the interface is considered to be up. Specify
1332 <code>0</code> to enable the interface immediately.
1336 This setting is honored only when at least one bonded interface is
1337 already enabled. When no interfaces are enabled, then the first
1338 bond interface to come up is enabled immediately.
1342 <column name="bond_downdelay">
1343 The number of milliseconds for which the link must stay down on an
1344 interface before the interface is considered to be down. Specify
1345 <code>0</code> to disable the interface immediately.
1349 <group title="LACP Configuration">
1351 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1352 allows switches to automatically detect that they are connected by
1353 multiple links and aggregate across those links. These settings
1354 control LACP behavior.
1357 <column name="lacp">
1358 Configures LACP on this port. LACP allows directly connected
1359 switches to negotiate which links may be bonded. LACP may be enabled
1360 on non-bonded ports for the benefit of any switches they may be
1361 connected to. <code>active</code> ports are allowed to initiate LACP
1362 negotiations. <code>passive</code> ports are allowed to participate
1363 in LACP negotiations initiated by a remote switch, but not allowed to
1364 initiate such negotiations themselves. If LACP is enabled on a port
1365 whose partner switch does not support LACP, the bond will be
1366 disabled, unless other-config:lacp-fallback-ab is set to true.
1367 Defaults to <code>off</code> if unset.
1370 <column name="other_config" key="lacp-system-id">
1371 The LACP system ID of this <ref table="Port"/>. The system ID of a
1372 LACP bond is used to identify itself to its partners. Must be a
1373 nonzero MAC address. Defaults to the bridge Ethernet address if
1377 <column name="other_config" key="lacp-system-priority"
1378 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1379 The LACP system priority of this <ref table="Port"/>. In LACP
1380 negotiations, link status decisions are made by the system with the
1381 numerically lower priority.
1384 <column name="other_config" key="lacp-time"
1385 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1387 The LACP timing which should be used on this <ref table="Port"/>.
1388 By default <code>slow</code> is used. When configured to be
1389 <code>fast</code> LACP heartbeats are requested at a rate of once
1390 per second causing connectivity problems to be detected more
1391 quickly. In <code>slow</code> mode, heartbeats are requested at a
1392 rate of once every 30 seconds.
1396 <column name="other_config" key="lacp-fallback-ab"
1397 type='{"type": "boolean"}'>
1399 Determines the behavior of openvswitch bond in LACP mode. If
1400 the partner switch does not support LACP, setting this option
1401 to <code>true</code> allows openvswitch to fallback to
1402 active-backup. If the option is set to <code>false</code>, the
1403 bond will be disabled. In both the cases, once the partner switch
1404 is configured to LACP mode, the bond will use LACP.
1409 <group title="Rebalancing Configuration">
1411 These settings control behavior when a bond is in
1412 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1415 <column name="other_config" key="bond-rebalance-interval"
1416 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1417 For a load balanced bonded port, the number of milliseconds between
1418 successive attempts to rebalance the bond, that is, to move flows
1419 from one interface on the bond to another in an attempt to keep usage
1420 of each interface roughly equal. If zero, load balancing is disabled
1421 on the bond (link failure still cause flows to move). If
1422 less than 1000ms, the rebalance interval will be 1000ms.
1426 <column name="bond_fake_iface">
1427 For a bonded port, whether to create a fake internal interface with the
1428 name of the port. Use only for compatibility with legacy software that
1433 <group title="Spanning Tree Protocol">
1435 The configuration here is only meaningful, and the status is only
1436 populated, when 802.1D-1998 Spanning Tree Protocol is enabled on the
1437 port's <ref column="Bridge"/> with its <ref column="stp_enable"/>
1441 <group title="STP Configuration">
1442 <column name="other_config" key="stp-enable"
1443 type='{"type": "boolean"}'>
1444 When STP is enabled on a bridge, it is enabled by default on all of
1445 the bridge's ports except bond, internal, and mirror ports (which do
1446 not work with STP). If this column's value is <code>false</code>,
1447 STP is disabled on the port.
1450 <column name="other_config" key="stp-port-num"
1451 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1452 The port number used for the lower 8 bits of the port-id. By
1453 default, the numbers will be assigned automatically. If any
1454 port's number is manually configured on a bridge, then they
1458 <column name="other_config" key="stp-port-priority"
1459 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1460 The port's relative priority value for determining the root
1461 port (the upper 8 bits of the port-id). A port with a lower
1462 port-id will be chosen as the root port. By default, the
1466 <column name="other_config" key="stp-path-cost"
1467 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1468 Spanning tree path cost for the port. A lower number indicates
1469 a faster link. By default, the cost is based on the maximum
1474 <group title="STP Status">
1475 <column name="status" key="stp_port_id">
1476 The port ID used in spanning tree advertisements for this port, as 4
1477 hex digits. Configuring the port ID is described in the
1478 <code>stp-port-num</code> and <code>stp-port-priority</code> keys of
1479 the <code>other_config</code> section earlier.
1481 <column name="status" key="stp_state"
1482 type='{"type": "string", "enum": ["set",
1483 ["disabled", "listening", "learning",
1484 "forwarding", "blocking"]]}'>
1485 STP state of the port.
1487 <column name="status" key="stp_sec_in_state"
1488 type='{"type": "integer", "minInteger": 0}'>
1489 The amount of time this port has been in the current STP state, in
1492 <column name="status" key="stp_role"
1493 type='{"type": "string", "enum": ["set",
1494 ["root", "designated", "alternate"]]}'>
1495 STP role of the port.
1500 <group title="Rapid Spanning Tree Protocol">
1502 The configuration here is only meaningful, and the status and
1503 statistics are only populated, when 802.1D-1998 Spanning Tree Protocol
1504 is enabled on the port's <ref column="Bridge"/> with its <ref
1505 column="stp_enable"/> column.
1508 <group title="RSTP Configuration">
1509 <column name="other_config" key="rstp-enable"
1510 type='{"type": "boolean"}'>
1511 When RSTP is enabled on a bridge, it is enabled by default on all of
1512 the bridge's ports except bond, internal, and mirror ports (which do
1513 not work with RSTP). If this column's value is <code>false</code>,
1514 RSTP is disabled on the port.
1517 <column name="other_config" key="rstp-port-priority"
1518 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1519 The port's relative priority value for determining the root port, in
1520 multiples of 16. By default, the port priority is 0x80 (128). Any
1521 value in the lower 4 bits is rounded off. The significant upper 4
1522 bits become the upper 4 bits of the port-id. A port with the lowest
1523 port-id is elected as the root.
1526 <column name="other_config" key="rstp-port-num"
1527 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1528 The local RSTP port number, used as the lower 12 bits of the port-id.
1529 By default the port numbers are assigned automatically, and typically
1530 may not correspond to the OpenFlow port numbers. A port with the
1531 lowest port-id is elected as the root.
1534 <column name="other_config" key="rstp-port-path-cost"
1535 type='{"type": "integer"}'>
1536 The port path cost. The Port's contribution, when it is
1537 the Root Port, to the Root Path Cost for the Bridge. By default the
1538 cost is automatically calculated from the port's speed.
1541 <column name="other_config" key="rstp-port-admin-edge"
1542 type='{"type": "boolean"}'>
1543 The admin edge port parameter for the Port. Default is
1547 <column name="other_config" key="rstp-port-auto-edge"
1548 type='{"type": "boolean"}'>
1549 The auto edge port parameter for the Port. Default is
1553 <column name="other_config" key="rstp-port-mcheck"
1554 type='{"type": "boolean"}'>
1556 The mcheck port parameter for the Port. Default is
1557 <code>false</code>. May be set to force the Port Protocol
1558 Migration state machine to transmit RST BPDUs for a
1559 MigrateTime period, to test whether all STP Bridges on the
1560 attached LAN have been removed and the Port can continue to
1561 transmit RSTP BPDUs. Setting mcheck has no effect if the
1562 Bridge is operating in STP Compatibility mode.
1565 Changing the value from <code>true</code> to
1566 <code>false</code> has no effect, but needs to be done if
1567 this behavior is to be triggered again by subsequently
1568 changing the value from <code>false</code> to
1574 <group title="RSTP Status">
1575 <column name="rstp_status" key="rstp_port_id">
1576 The port ID used in spanning tree advertisements for this port, as 4
1577 hex digits. Configuring the port ID is described in the
1578 <code>rstp-port-num</code> and <code>rstp-port-priority</code> keys
1579 of the <code>other_config</code> section earlier.
1581 <column name="rstp_status" key="rstp_port_role"
1582 type='{"type": "string", "enum": ["set",
1583 ["Root", "Designated", "Alternate", "Backup", "Disabled"]]}'>
1584 RSTP role of the port.
1586 <column name="rstp_status" key="rstp_port_state"
1587 type='{"type": "string", "enum": ["set",
1588 ["Disabled", "Learning", "Forwarding", "Discarding"]]}'>
1589 RSTP state of the port.
1591 <column name="rstp_status" key="rstp_designated_bridge_id">
1592 The port's RSTP designated bridge ID, in the same form as <ref
1593 column="rstp_status" key="rstp_bridge_id"/> in the <ref
1594 table="Bridge"/> table.
1596 <column name="rstp_status" key="rstp_designated_port_id">
1597 The port's RSTP designated port ID, as 4 hex digits.
1599 <column name="rstp_status" key="rstp_designated_path_cost"
1600 type='{"type": "integer"}'>
1601 The port's RSTP designated path cost. Lower is better.
1605 <group title="RSTP Statistics">
1606 <column name="rstp_statistics" key="rstp_tx_count">
1607 Number of RSTP BPDUs transmitted through this port.
1609 <column name="rstp_statistics" key="rstp_rx_count">
1610 Number of valid RSTP BPDUs received by this port.
1612 <column name="rstp_statistics" key="rstp_error_count">
1613 Number of invalid RSTP BPDUs received by this port.
1615 <column name="rstp_statistics" key="rstp_uptime">
1616 The duration covered by the other RSTP statistics, in seconds.
1621 <group title="Multicast Snooping">
1622 <column name="other_config" key="mcast-snooping-flood"
1623 type='{"type": "boolean"}'>
1625 If set to <code>true</code>, multicast packets (except Reports) are
1626 unconditionally forwarded to the specific port.
1629 <column name="other_config" key="mcast-snooping-flood-reports"
1630 type='{"type": "boolean"}'>
1632 If set to <code>true</code>, multicast Reports are unconditionally
1633 forwarded to the specific port.
1638 <group title="Other Features">
1640 Quality of Service configuration for this port.
1644 The MAC address to use for this port for the purpose of choosing the
1645 bridge's MAC address. This column does not necessarily reflect the
1646 port's actual MAC address, nor will setting it change the port's actual
1650 <column name="fake_bridge">
1651 Does this port represent a sub-bridge for its tagged VLAN within the
1652 Bridge? See ovs-vsctl(8) for more information.
1655 <column name="external_ids" key="fake-bridge-id-*">
1656 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1657 column) are defined by prefixing a <ref table="Bridge"/> <ref
1658 table="Bridge" column="external_ids"/> key with
1659 <code>fake-bridge-</code>,
1660 e.g. <code>fake-bridge-xs-network-uuids</code>.
1663 <column name="other_config" key="transient"
1664 type='{"type": "boolean"}'>
1666 If set to <code>true</code>, the port will be removed when
1667 <code>ovs-ctl start --delete-transient-ports</code> is used.
1672 <column name="bond_active_slave">
1673 For a bonded port, record the mac address of the current active slave.
1676 <group title="Port Statistics">
1678 Key-value pairs that report port statistics. The update period
1679 is controlled by <ref column="other_config"
1680 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1682 <group title="Statistics: STP transmit and receive counters">
1683 <column name="statistics" key="stp_tx_count">
1684 Number of STP BPDUs sent on this port by the spanning
1687 <column name="statistics" key="stp_rx_count">
1688 Number of STP BPDUs received on this port and accepted by the
1689 spanning tree library.
1691 <column name="statistics" key="stp_error_count">
1692 Number of bad STP BPDUs received on this port. Bad BPDUs
1693 include runt packets and those with an unexpected protocol ID.
1698 <group title="Common Columns">
1699 The overall purpose of these columns is described under <code>Common
1700 Columns</code> at the beginning of this document.
1702 <column name="other_config"/>
1703 <column name="external_ids"/>
1707 <table name="Interface" title="One physical network device in a Port.">
1708 An interface within a <ref table="Port"/>.
1710 <group title="Core Features">
1711 <column name="name">
1712 Interface name. Should be alphanumeric and no more than about 8 bytes
1713 long. May be the same as the port name, for non-bonded ports. Must
1714 otherwise be unique among the names of ports, interfaces, and bridges
1718 <column name="ifindex">
1719 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1720 2863, if the interface has one, otherwise 0. The ifindex is useful for
1721 seamless integration with protocols such as SNMP and sFlow.
1724 <column name="mac_in_use">
1725 The MAC address in use by this interface.
1729 <p>Ethernet address to set for this interface. If unset then the
1730 default MAC address is used:</p>
1732 <li>For the local interface, the default is the lowest-numbered MAC
1733 address among the other bridge ports, either the value of the
1734 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1735 if set, or its actual MAC (for bonded ports, the MAC of its slave
1736 whose name is first in alphabetical order). Internal ports and
1737 bridge ports that are used as port mirroring destinations (see the
1738 <ref table="Mirror"/> table) are ignored.</li>
1739 <li>For other internal interfaces, the default MAC is randomly
1741 <li>External interfaces typically have a MAC address associated with
1742 their hardware.</li>
1744 <p>Some interfaces may not have a software-controllable MAC
1748 <column name="error">
1749 If the configuration of the port failed, as indicated by -1 in <ref
1750 column="ofport"/>, Open vSwitch sets this column to an error
1751 description in human readable form. Otherwise, Open vSwitch clears
1755 <group title="OpenFlow Port Number">
1757 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1758 port number for the new port. If the client that adds the port fills
1759 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1760 value as the OpenFlow port number. Otherwise, or if the requested
1761 port number is already in use or cannot be used for another reason,
1762 Open vSwitch automatically assigns a free port number. Regardless of
1763 how the port number was obtained, Open vSwitch then reports in <ref
1764 column="ofport"/> the port number actually assigned.
1768 Open vSwitch limits the port numbers that it automatically assigns to
1769 the range 1 through 32,767, inclusive. Controllers therefore have
1770 free use of ports 32,768 and up.
1773 <column name="ofport">
1775 OpenFlow port number for this interface. Open vSwitch sets this
1776 column's value, so other clients should treat it as read-only.
1779 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1780 The other valid port numbers are in the range 1 to 65,279,
1781 inclusive. Value -1 indicates an error adding the interface.
1785 <column name="ofport_request"
1786 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1788 Requested OpenFlow port number for this interface.
1792 A client should ideally set this column's value in the same
1793 database transaction that it uses to create the interface. Open
1794 vSwitch version 2.1 and later will honor a later request for a
1795 specific port number, althuogh it might confuse some controllers:
1796 OpenFlow does not have a way to announce a port number change, so
1797 Open vSwitch represents it over OpenFlow as a port deletion
1798 followed immediately by a port addition.
1802 If <ref column="ofport_request"/> is set or changed to some other
1803 port's automatically assigned port number, Open vSwitch chooses a
1804 new port number for the latter port.
1810 <group title="System-Specific Details">
1811 <column name="type">
1813 The interface type. The types supported by a particular instance of
1814 Open vSwitch are listed in the <ref table="Open_vSwitch"
1815 column="iface_types"/> column in the <ref table="Open_vSwitch"/>
1816 table. The following types are defined:
1820 <dt><code>system</code></dt>
1821 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1822 Sometimes referred to as ``external interfaces'' since they are
1823 generally connected to hardware external to that on which the Open
1824 vSwitch is running. The empty string is a synonym for
1825 <code>system</code>.</dd>
1827 <dt><code>internal</code></dt>
1828 <dd>A simulated network device that sends and receives traffic. An
1829 internal interface whose <ref column="name"/> is the same as its
1830 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1831 ``local interface.'' It does not make sense to bond an internal
1832 interface, so the terms ``port'' and ``interface'' are often used
1833 imprecisely for internal interfaces.</dd>
1835 <dt><code>tap</code></dt>
1836 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1838 <dt><code>geneve</code></dt>
1840 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-ietf-nvo3-geneve-00</code>)
1843 A description of how to match and set Geneve options can be found
1844 in the <code>ovs-ofctl</code> manual page.
1847 <dt><code>gre</code></dt>
1849 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1853 <dt><code>ipsec_gre</code></dt>
1855 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1859 <dt><code>vxlan</code></dt>
1862 An Ethernet tunnel over the UDP-based VXLAN protocol described in
1866 Open vSwitch uses UDP destination port 4789. The source port used for
1867 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1872 <dt><code>lisp</code></dt>
1875 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1876 Separation Protocol (RFC 6830).
1879 Only IPv4 and IPv6 packets are supported by the protocol, and
1880 they are sent and received without an Ethernet header. Traffic
1881 to/from LISP ports is expected to be configured explicitly, and
1882 the ports are not intended to participate in learning based
1883 switching. As such, they are always excluded from packet
1888 <dt><code>stt</code></dt>
1890 The Stateless TCP Tunnel (STT) is particularly useful when tunnel
1891 endpoints are in end-systems, as it utilizes the capabilities of
1892 standard network interface cards to improve performance. STT utilizes
1893 a TCP-like header inside the IP header. It is stateless, i.e., there is
1894 no TCP connection state of any kind associated with the tunnel. The
1895 TCP-like header is used to leverage the capabilities of existing
1896 network interface cards, but should not be interpreted as implying
1897 any sort of connection state between endpoints.
1898 Since the STT protocol does not engage in the usual TCP 3-way handshake,
1899 so it will have difficulty traversing stateful firewalls.
1900 The protocol is documented at
1901 http://www.ietf.org/archive/id/draft-davie-stt-06.txt
1903 All traffic uses a default destination port of 7471. STT is only
1904 available in kernel datapath on kernel 3.5 or newer.
1907 <dt><code>patch</code></dt>
1909 A pair of virtual devices that act as a patch cable.
1912 <dt><code>null</code></dt>
1913 <dd>An ignored interface. Deprecated and slated for removal in
1919 <group title="Tunnel Options">
1921 These options apply to interfaces with <ref column="type"/> of
1922 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1923 <code>vxlan</code>, <code>lisp</code> and <code>stt</code>.
1927 Each tunnel must be uniquely identified by the combination of <ref
1928 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1929 column="options" key="local_ip"/>, and <ref column="options"
1930 key="in_key"/>. If two ports are defined that are the same except one
1931 has an optional identifier and the other does not, the more specific
1932 one is matched first. <ref column="options" key="in_key"/> is
1933 considered more specific than <ref column="options" key="local_ip"/> if
1934 a port defines one and another port defines the other.
1937 <column name="options" key="remote_ip">
1938 <p>Required. The remote tunnel endpoint, one of:</p>
1942 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1943 Only unicast endpoints are supported.
1946 The word <code>flow</code>. The tunnel accepts packets from any
1947 remote tunnel endpoint. To process only packets from a specific
1948 remote tunnel endpoint, the flow entries may match on the
1949 <code>tun_src</code> field. When sending packets to a
1950 <code>remote_ip=flow</code> tunnel, the flow actions must
1951 explicitly set the <code>tun_dst</code> field to the IP address of
1952 the desired remote tunnel endpoint, e.g. with a
1953 <code>set_field</code> action.
1958 The remote tunnel endpoint for any packet received from a tunnel
1959 is available in the <code>tun_src</code> field for matching in the
1964 <column name="options" key="local_ip">
1966 Optional. The tunnel destination IP that received packets must
1967 match. Default is to match all addresses. If specified, may be one
1973 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1976 The word <code>flow</code>. The tunnel accepts packets sent to any
1977 of the local IP addresses of the system running OVS. To process
1978 only packets sent to a specific IP address, the flow entries may
1979 match on the <code>tun_dst</code> field. When sending packets to a
1980 <code>local_ip=flow</code> tunnel, the flow actions may
1981 explicitly set the <code>tun_src</code> field to the desired IP
1982 address, e.g. with a <code>set_field</code> action. However, while
1983 routing the tunneled packet out, the local system may override the
1984 specified address with the local IP address configured for the
1985 outgoing system interface.
1988 This option is valid only for tunnels also configured with the
1989 <code>remote_ip=flow</code> option.
1995 The tunnel destination IP address for any packet received from a
1996 tunnel is available in the <code>tun_dst</code> field for matching in
2001 <column name="options" key="in_key">
2002 <p>Optional. The key that received packets must contain, one of:</p>
2006 <code>0</code>. The tunnel receives packets with no key or with a
2007 key of 0. This is equivalent to specifying no <ref column="options"
2008 key="in_key"/> at all.
2011 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
2012 or 64-bit (for STT) number. The tunnel receives only
2013 packets with the specified key.
2016 The word <code>flow</code>. The tunnel accepts packets with any
2017 key. The key will be placed in the <code>tun_id</code> field for
2018 matching in the flow table. The <code>ovs-ofctl</code> manual page
2019 contains additional information about matching fields in OpenFlow
2028 <column name="options" key="out_key">
2029 <p>Optional. The key to be set on outgoing packets, one of:</p>
2033 <code>0</code>. Packets sent through the tunnel will have no key.
2034 This is equivalent to specifying no <ref column="options"
2035 key="out_key"/> at all.
2038 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
2039 64-bit (for STT) number. Packets sent through the tunnel
2040 will have the specified key.
2043 The word <code>flow</code>. Packets sent through the tunnel will
2044 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
2045 vendor extension (0 is used in the absence of an action). The
2046 <code>ovs-ofctl</code> manual page contains additional information
2047 about the Nicira OpenFlow vendor extensions.
2052 <column name="options" key="key">
2053 Optional. Shorthand to set <code>in_key</code> and
2054 <code>out_key</code> at the same time.
2057 <column name="options" key="tos">
2058 Optional. The value of the ToS bits to be set on the encapsulating
2059 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
2060 zero. It may also be the word <code>inherit</code>, in which case
2061 the ToS will be copied from the inner packet if it is IPv4 or IPv6
2062 (otherwise it will be 0). The ECN fields are always inherited.
2066 <column name="options" key="ttl">
2067 Optional. The TTL to be set on the encapsulating packet. It may also
2068 be the word <code>inherit</code>, in which case the TTL will be copied
2069 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
2070 system default, typically 64). Default is the system default TTL.
2073 <column name="options" key="df_default"
2074 type='{"type": "boolean"}'>
2075 Optional. If enabled, the Don't Fragment bit will be set on tunnel
2076 outer headers to allow path MTU discovery. Default is enabled; set
2077 to <code>false</code> to disable.
2080 <group title="Tunnel Options: vxlan only">
2082 <column name="options" key="exts">
2083 <p>Optional. Comma separated list of optional VXLAN extensions to
2084 enable. The following extensions are supported:</p>
2088 <code>gbp</code>: VXLAN-GBP allows to transport the group policy
2089 context of a packet across the VXLAN tunnel to other network
2090 peers. See the field description of <code>tun_gbp_id</code> and
2091 <code>tun_gbp_flags</code> in ovs-ofctl(8) for additional
2093 (<code>https://tools.ietf.org/html/draft-smith-vxlan-group-policy</code>)
2100 <group title="Tunnel Options: gre, ipsec_gre, geneve, and vxlan">
2102 <code>gre</code>, <code>ipsec_gre</code>, <code>geneve</code>, and
2103 <code>vxlan</code> interfaces support these options.
2106 <column name="options" key="csum" type='{"type": "boolean"}'>
2108 Optional. Compute encapsulation header (either GRE or UDP)
2109 checksums on outgoing packets. Default is disabled, set to
2110 <code>true</code> to enable. Checksums present on incoming
2111 packets will be validated regardless of this setting.
2115 When using the upstream Linux kernel module, computation of
2116 checksums for <code>geneve</code> and <code>vxlan</code> requires
2117 Linux kernel version 4.0 or higher. <code>gre</code> supports
2118 checksums for all versions of Open vSwitch that support GRE.
2119 The out of tree kernel module distributed as part of OVS
2120 can compute all tunnel checksums on any kernel version that it
2125 This option is supported for <code>ipsec_gre</code>, but not useful
2126 because GRE checksums are weaker than, and redundant with, IPsec
2127 payload authentication.
2132 <group title="Tunnel Options: ipsec_gre only">
2134 Only <code>ipsec_gre</code> interfaces support these options.
2137 <column name="options" key="peer_cert">
2138 Required for certificate authentication. A string containing the
2139 peer's certificate in PEM format. Additionally the host's
2140 certificate must be specified with the <code>certificate</code>
2144 <column name="options" key="certificate">
2145 Required for certificate authentication. The name of a PEM file
2146 containing a certificate that will be presented to the peer during
2150 <column name="options" key="private_key">
2151 Optional for certificate authentication. The name of a PEM file
2152 containing the private key associated with <code>certificate</code>.
2153 If <code>certificate</code> contains the private key, this option may
2157 <column name="options" key="psk">
2158 Required for pre-shared key authentication. Specifies a pre-shared
2159 key for authentication that must be identical on both sides of the
2165 <group title="Patch Options">
2167 Only <code>patch</code> interfaces support these options.
2170 <column name="options" key="peer">
2171 The <ref column="name"/> of the <ref table="Interface"/> for the other
2172 side of the patch. The named <ref table="Interface"/>'s own
2173 <code>peer</code> option must specify this <ref table="Interface"/>'s
2174 name. That is, the two patch interfaces must have reversed <ref
2175 column="name"/> and <code>peer</code> values.
2179 <group title="Interface Status">
2181 Status information about interfaces attached to bridges, updated every
2182 5 seconds. Not all interfaces have all of these properties; virtual
2183 interfaces don't have a link speed, for example. Non-applicable
2184 columns will have empty values.
2186 <column name="admin_state">
2188 The administrative state of the physical network link.
2192 <column name="link_state">
2194 The observed state of the physical network link. This is ordinarily
2195 the link's carrier status. If the interface's <ref table="Port"/> is
2196 a bond configured for miimon monitoring, it is instead the network
2197 link's miimon status.
2201 <column name="link_resets">
2203 The number of times Open vSwitch has observed the
2204 <ref column="link_state"/> of this <ref table="Interface"/> change.
2208 <column name="link_speed">
2210 The negotiated speed of the physical network link.
2211 Valid values are positive integers greater than 0.
2215 <column name="duplex">
2217 The duplex mode of the physical network link.
2223 The MTU (maximum transmission unit); i.e. the largest
2224 amount of data that can fit into a single Ethernet frame.
2225 The standard Ethernet MTU is 1500 bytes. Some physical media
2226 and many kinds of virtual interfaces can be configured with
2230 This column will be empty for an interface that does not
2231 have an MTU as, for example, some kinds of tunnels do not.
2235 <column name="lacp_current">
2236 Boolean value indicating LACP status for this interface. If true, this
2237 interface has current LACP information about its LACP partner. This
2238 information may be used to monitor the health of interfaces in a LACP
2239 enabled port. This column will be empty if LACP is not enabled.
2242 <column name="status">
2243 Key-value pairs that report port status. Supported status values are
2244 <ref column="type"/>-dependent; some interfaces may not have a valid
2245 <ref column="status" key="driver_name"/>, for example.
2248 <column name="status" key="driver_name">
2249 The name of the device driver controlling the network adapter.
2252 <column name="status" key="driver_version">
2253 The version string of the device driver controlling the network
2257 <column name="status" key="firmware_version">
2258 The version string of the network adapter's firmware, if available.
2261 <column name="status" key="source_ip">
2262 The source IP address used for an IPv4 tunnel end-point, such as
2266 <column name="status" key="tunnel_egress_iface">
2267 Egress interface for tunnels. Currently only relevant for tunnels
2268 on Linux systems, this column will show the name of the interface
2269 which is responsible for routing traffic destined for the configured
2270 <ref column="options" key="remote_ip"/>. This could be an internal
2271 interface such as a bridge port.
2274 <column name="status" key="tunnel_egress_iface_carrier"
2275 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2276 Whether carrier is detected on <ref column="status"
2277 key="tunnel_egress_iface"/>.
2281 <group title="Statistics">
2283 Key-value pairs that report interface statistics. The current
2284 implementation updates these counters periodically. The update period
2285 is controlled by <ref column="other_config"
2286 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2287 Future implementations may update them when an interface is created,
2288 when they are queried (e.g. using an OVSDB <code>select</code>
2289 operation), and just before an interface is deleted due to virtual
2290 interface hot-unplug or VM shutdown, and perhaps at other times, but
2291 not on any regular periodic basis.
2294 These are the same statistics reported by OpenFlow in its <code>struct
2295 ofp_port_stats</code> structure. If an interface does not support a
2296 given statistic, then that pair is omitted.
2298 <group title="Statistics: Successful transmit and receive counters">
2299 <column name="statistics" key="rx_packets">
2300 Number of received packets.
2302 <column name="statistics" key="rx_bytes">
2303 Number of received bytes.
2305 <column name="statistics" key="tx_packets">
2306 Number of transmitted packets.
2308 <column name="statistics" key="tx_bytes">
2309 Number of transmitted bytes.
2312 <group title="Statistics: Receive errors">
2313 <column name="statistics" key="rx_dropped">
2314 Number of packets dropped by RX.
2316 <column name="statistics" key="rx_frame_err">
2317 Number of frame alignment errors.
2319 <column name="statistics" key="rx_over_err">
2320 Number of packets with RX overrun.
2322 <column name="statistics" key="rx_crc_err">
2323 Number of CRC errors.
2325 <column name="statistics" key="rx_errors">
2326 Total number of receive errors, greater than or equal to the sum of
2330 <group title="Statistics: Transmit errors">
2331 <column name="statistics" key="tx_dropped">
2332 Number of packets dropped by TX.
2334 <column name="statistics" key="collisions">
2335 Number of collisions.
2337 <column name="statistics" key="tx_errors">
2338 Total number of transmit errors, greater than or equal to the sum of
2344 <group title="Ingress Policing">
2346 These settings control ingress policing for packets received on this
2347 interface. On a physical interface, this limits the rate at which
2348 traffic is allowed into the system from the outside; on a virtual
2349 interface (one connected to a virtual machine), this limits the rate at
2350 which the VM is able to transmit.
2353 Policing is a simple form of quality-of-service that simply drops
2354 packets received in excess of the configured rate. Due to its
2355 simplicity, policing is usually less accurate and less effective than
2356 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2357 table="Queue"/> tables).
2360 Policing is currently implemented only on Linux. The Linux
2361 implementation uses a simple ``token bucket'' approach:
2365 The size of the bucket corresponds to <ref
2366 column="ingress_policing_burst"/>. Initially the bucket is full.
2369 Whenever a packet is received, its size (converted to tokens) is
2370 compared to the number of tokens currently in the bucket. If the
2371 required number of tokens are available, they are removed and the
2372 packet is forwarded. Otherwise, the packet is dropped.
2375 Whenever it is not full, the bucket is refilled with tokens at the
2376 rate specified by <ref column="ingress_policing_rate"/>.
2380 Policing interacts badly with some network protocols, and especially
2381 with fragmented IP packets. Suppose that there is enough network
2382 activity to keep the bucket nearly empty all the time. Then this token
2383 bucket algorithm will forward a single packet every so often, with the
2384 period depending on packet size and on the configured rate. All of the
2385 fragments of an IP packets are normally transmitted back-to-back, as a
2386 group. In such a situation, therefore, only one of these fragments
2387 will be forwarded and the rest will be dropped. IP does not provide
2388 any way for the intended recipient to ask for only the remaining
2389 fragments. In such a case there are two likely possibilities for what
2390 will happen next: either all of the fragments will eventually be
2391 retransmitted (as TCP will do), in which case the same problem will
2392 recur, or the sender will not realize that its packet has been dropped
2393 and data will simply be lost (as some UDP-based protocols will do).
2394 Either way, it is possible that no forward progress will ever occur.
2396 <column name="ingress_policing_rate">
2398 Maximum rate for data received on this interface, in kbps. Data
2399 received faster than this rate is dropped. Set to <code>0</code>
2400 (the default) to disable policing.
2404 <column name="ingress_policing_burst">
2405 <p>Maximum burst size for data received on this interface, in kb. The
2406 default burst size if set to <code>0</code> is 1000 kb. This value
2407 has no effect if <ref column="ingress_policing_rate"/>
2408 is <code>0</code>.</p>
2410 Specifying a larger burst size lets the algorithm be more forgiving,
2411 which is important for protocols like TCP that react severely to
2412 dropped packets. The burst size should be at least the size of the
2413 interface's MTU. Specifying a value that is numerically at least as
2414 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2415 closer to achieving the full rate.
2420 <group title="Bidirectional Forwarding Detection (BFD)">
2422 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2423 detection of connectivity failures by occasional transmission of
2424 BFD control messages. Open vSwitch implements BFD to serve
2425 as a more popular and standards compliant alternative to CFM.
2429 BFD operates by regularly transmitting BFD control messages at a rate
2430 negotiated independently in each direction. Each endpoint specifies
2431 the rate at which it expects to receive control messages, and the rate
2432 at which it is willing to transmit them. Open vSwitch uses a detection
2433 multiplier of three, meaning that an endpoint signals a connectivity
2434 fault if three consecutive BFD control messages fail to arrive. In the
2435 case of a unidirectional connectivity issue, the system not receiving
2436 BFD control messages signals the problem to its peer in the messages it
2441 The Open vSwitch implementation of BFD aims to comply faithfully
2442 with RFC 5880 requirements. Open vSwitch does not implement the
2443 optional Authentication or ``Echo Mode'' features.
2446 <group title="BFD Configuration">
2448 A controller sets up key-value pairs in the <ref column="bfd"/>
2449 column to enable and configure BFD.
2452 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2453 True to enable BFD on this <ref table="Interface"/>. If not
2454 specified, BFD will not be enabled by default.
2457 <column name="bfd" key="min_rx"
2458 type='{"type": "integer", "minInteger": 1}'>
2459 The shortest interval, in milliseconds, at which this BFD session
2460 offers to receive BFD control messages. The remote endpoint may
2461 choose to send messages at a slower rate. Defaults to
2465 <column name="bfd" key="min_tx"
2466 type='{"type": "integer", "minInteger": 1}'>
2467 The shortest interval, in milliseconds, at which this BFD session is
2468 willing to transmit BFD control messages. Messages will actually be
2469 transmitted at a slower rate if the remote endpoint is not willing to
2470 receive as quickly as specified. Defaults to <code>100</code>.
2473 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2474 An alternate receive interval, in milliseconds, that must be greater
2475 than or equal to <ref column="bfd" key="min_rx"/>. The
2476 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2477 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2478 data traffic at the interface, to reduce the CPU and bandwidth cost
2479 of monitoring an idle interface. This feature may be disabled by
2480 setting a value of 0. This feature is reset whenever <ref
2481 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2485 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2486 When <code>true</code>, traffic received on the
2487 <ref table="Interface"/> is used to indicate the capability of packet
2488 I/O. BFD control packets are still transmitted and received. At
2489 least one BFD control packet must be received every 100 * <ref
2490 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2491 traffic are received, the <ref column="bfd" key="forwarding"/>
2492 will be <code>false</code>.
2495 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2496 Set to true to notify the remote endpoint that traffic should not be
2497 forwarded to this system for some reason other than a connectivty
2498 failure on the interface being monitored. The typical underlying
2499 reason is ``concatenated path down,'' that is, that connectivity
2500 beyond the local system is down. Defaults to false.
2503 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2504 Set to true to make BFD accept only control messages with a tunnel
2505 key of zero. By default, BFD accepts control messages with any
2509 <column name="bfd" key="bfd_local_src_mac">
2510 Set to an Ethernet address in the form
2511 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2512 to set the MAC used as source for transmitted BFD packets. The
2513 default is the mac address of the BFD enabled interface.
2516 <column name="bfd" key="bfd_local_dst_mac">
2517 Set to an Ethernet address in the form
2518 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2519 to set the MAC used as destination for transmitted BFD packets. The
2520 default is <code>00:23:20:00:00:01</code>.
2523 <column name="bfd" key="bfd_remote_dst_mac">
2524 Set to an Ethernet address in the form
2525 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2526 to set the MAC used for checking the destination of received BFD packets.
2527 Packets with different destination MAC will not be considered as BFD packets.
2528 If not specified the destination MAC address of received BFD packets
2532 <column name="bfd" key="bfd_src_ip">
2533 Set to an IPv4 address to set the IP address used as source for
2534 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2537 <column name="bfd" key="bfd_dst_ip">
2538 Set to an IPv4 address to set the IP address used as destination
2539 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2543 <group title="BFD Status">
2545 The switch sets key-value pairs in the <ref column="bfd_status"/>
2546 column to report the status of BFD on this interface. When BFD is
2547 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2548 all key-value pairs from <ref column="bfd_status"/>.
2551 <column name="bfd_status" key="state"
2552 type='{"type": "string",
2553 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2554 Reports the state of the BFD session. The BFD session is fully
2555 healthy and negotiated if <code>UP</code>.
2558 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2559 Reports whether the BFD session believes this <ref
2560 table="Interface"/> may be used to forward traffic. Typically this
2561 means the local session is signaling <code>UP</code>, and the remote
2562 system isn't signaling a problem such as concatenated path down.
2565 <column name="bfd_status" key="diagnostic">
2566 In case of a problem, set to an error message that reports what the
2567 local BFD session thinks is wrong. The error messages are defined
2568 in section 4.1 of [RFC 5880].
2571 <column name="bfd_status" key="remote_state"
2572 type='{"type": "string",
2573 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2574 Reports the state of the remote endpoint's BFD session.
2577 <column name="bfd_status" key="remote_diagnostic">
2578 In case of a problem, set to an error message that reports what the
2579 remote endpoint's BFD session thinks is wrong. The error messages
2580 are defined in section 4.1 of [RFC 5880].
2583 <column name="bfd_status" key="flap_count"
2584 type='{"type": "integer", "minInteger": 0}'>
2585 Counts the number of <ref column="bfd_status" key="forwarding" />
2586 flaps since start. A flap is considered as a change of the
2587 <ref column="bfd_status" key="forwarding" /> value.
2592 <group title="Connectivity Fault Management">
2594 802.1ag Connectivity Fault Management (CFM) allows a group of
2595 Maintenance Points (MPs) called a Maintenance Association (MA) to
2596 detect connectivity problems with each other. MPs within a MA should
2597 have complete and exclusive interconnectivity. This is verified by
2598 occasionally broadcasting Continuity Check Messages (CCMs) at a
2599 configurable transmission interval.
2603 According to the 802.1ag specification, each Maintenance Point should
2604 be configured out-of-band with a list of Remote Maintenance Points it
2605 should have connectivity to. Open vSwitch differs from the
2606 specification in this area. It simply assumes the link is faulted if
2607 no Remote Maintenance Points are reachable, and considers it not
2612 When operating over tunnels which have no <code>in_key</code>, or an
2613 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2614 with a tunnel key of zero.
2617 <column name="cfm_mpid">
2619 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2620 within a Maintenance Association. The MPID is used to identify this
2621 endpoint to other Maintenance Points in the MA. Each end of a link
2622 being monitored should have a different MPID. Must be configured to
2623 enable CFM on this <ref table="Interface"/>.
2626 According to the 802.1ag specification, MPIDs can only range between
2627 [1, 8191]. However, extended mode (see <ref column="other_config"
2628 key="cfm_extended"/>) supports eight byte MPIDs.
2632 <column name="cfm_flap_count">
2633 Counts the number of cfm fault flapps since boot. A flap is
2634 considered to be a change of the <ref column="cfm_fault"/> value.
2637 <column name="cfm_fault">
2639 Indicates a connectivity fault triggered by an inability to receive
2640 heartbeats from any remote endpoint. When a fault is triggered on
2641 <ref table="Interface"/>s participating in bonds, they will be
2645 Faults can be triggered for several reasons. Most importantly they
2646 are triggered when no CCMs are received for a period of 3.5 times the
2647 transmission interval. Faults are also triggered when any CCMs
2648 indicate that a Remote Maintenance Point is not receiving CCMs but
2649 able to send them. Finally, a fault is triggered if a CCM is
2650 received which indicates unexpected configuration. Notably, this
2651 case arises when a CCM is received which advertises the local MPID.
2655 <column name="cfm_fault_status" key="recv">
2656 Indicates a CFM fault was triggered due to a lack of CCMs received on
2657 the <ref table="Interface"/>.
2660 <column name="cfm_fault_status" key="rdi">
2661 Indicates a CFM fault was triggered due to the reception of a CCM with
2662 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2663 are not receiving CCMs themselves. This typically indicates a
2664 unidirectional connectivity failure.
2667 <column name="cfm_fault_status" key="maid">
2668 Indicates a CFM fault was triggered due to the reception of a CCM with
2669 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2670 with an identification number in addition to the MPID called the MAID.
2671 Open vSwitch only supports receiving CCM broadcasts tagged with the
2672 MAID it uses internally.
2675 <column name="cfm_fault_status" key="loopback">
2676 Indicates a CFM fault was triggered due to the reception of a CCM
2677 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2678 column of this <ref table="Interface"/>. This may indicate a loop in
2682 <column name="cfm_fault_status" key="overflow">
2683 Indicates a CFM fault was triggered because the CFM module received
2684 CCMs from more remote endpoints than it can keep track of.
2687 <column name="cfm_fault_status" key="override">
2688 Indicates a CFM fault was manually triggered by an administrator using
2689 an <code>ovs-appctl</code> command.
2692 <column name="cfm_fault_status" key="interval">
2693 Indicates a CFM fault was triggered due to the reception of a CCM
2694 frame having an invalid interval.
2697 <column name="cfm_remote_opstate">
2698 <p>When in extended mode, indicates the operational state of the
2699 remote endpoint as either <code>up</code> or <code>down</code>. See
2700 <ref column="other_config" key="cfm_opstate"/>.
2704 <column name="cfm_health">
2706 Indicates the health of the interface as a percentage of CCM frames
2707 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2708 The health of an interface is undefined if it is communicating with
2709 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2710 healthy heartbeats are not received at the expected rate, and
2711 gradually improves as healthy heartbeats are received at the desired
2712 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2713 health of the interface is refreshed.
2716 As mentioned above, the faults can be triggered for several reasons.
2717 The link health will deteriorate even if heartbeats are received but
2718 they are reported to be unhealthy. An unhealthy heartbeat in this
2719 context is a heartbeat for which either some fault is set or is out
2720 of sequence. The interface health can be 100 only on receiving
2721 healthy heartbeats at the desired rate.
2725 <column name="cfm_remote_mpids">
2726 When CFM is properly configured, Open vSwitch will occasionally
2727 receive CCM broadcasts. These broadcasts contain the MPID of the
2728 sending Maintenance Point. The list of MPIDs from which this
2729 <ref table="Interface"/> is receiving broadcasts from is regularly
2730 collected and written to this column.
2733 <column name="other_config" key="cfm_interval"
2734 type='{"type": "integer"}'>
2736 The interval, in milliseconds, between transmissions of CFM
2737 heartbeats. Three missed heartbeat receptions indicate a
2742 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2743 60,000, or 600,000 ms are supported. Other values will be rounded
2744 down to the nearest value on the list. Extended mode (see <ref
2745 column="other_config" key="cfm_extended"/>) supports any interval up
2746 to 65,535 ms. In either mode, the default is 1000 ms.
2749 <p>We do not recommend using intervals less than 100 ms.</p>
2752 <column name="other_config" key="cfm_extended"
2753 type='{"type": "boolean"}'>
2754 When <code>true</code>, the CFM module operates in extended mode. This
2755 causes it to use a nonstandard destination address to avoid conflicting
2756 with compliant implementations which may be running concurrently on the
2757 network. Furthermore, extended mode increases the accuracy of the
2758 <code>cfm_interval</code> configuration parameter by breaking wire
2759 compatibility with 802.1ag compliant implementations. And extended
2760 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2763 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2765 When <code>true</code>, and
2766 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2767 module operates in demand mode. When in demand mode, traffic
2768 received on the <ref table="Interface"/> is used to indicate
2769 liveness. CCMs are still transmitted and received. At least one
2770 CCM must be received every 100 * <ref column="other_config"
2771 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2772 are received, the CFM module will raise the connectivity fault.
2776 Demand mode has a couple of caveats:
2779 To ensure that ovs-vswitchd has enough time to pull statistics
2780 from the datapath, the fault detection interval is set to
2781 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2786 To avoid ambiguity, demand mode disables itself when there are
2787 multiple remote maintenance points.
2791 If the <ref table="Interface"/> is heavily congested, CCMs
2792 containing the <ref column="other_config" key="cfm_opstate"/>
2793 status may be dropped causing changes in the operational state to
2794 be delayed. Similarly, if CCMs containing the RDI bit are not
2795 received, unidirectional link failures may not be detected.
2801 <column name="other_config" key="cfm_opstate"
2802 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2803 When <code>down</code>, the CFM module marks all CCMs it generates as
2804 operationally down without triggering a fault. This allows remote
2805 maintenance points to choose not to forward traffic to the
2806 <ref table="Interface"/> on which this CFM module is running.
2807 Currently, in Open vSwitch, the opdown bit of CCMs affects
2808 <ref table="Interface"/>s participating in bonds, and the bundle
2809 OpenFlow action. This setting is ignored when CFM is not in extended
2810 mode. Defaults to <code>up</code>.
2813 <column name="other_config" key="cfm_ccm_vlan"
2814 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2815 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2816 with the given value. May be the string <code>random</code> in which
2817 case each CCM will be tagged with a different randomly generated VLAN.
2820 <column name="other_config" key="cfm_ccm_pcp"
2821 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2822 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2823 with the given PCP value, the VLAN ID of the tag is governed by the
2824 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2825 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2831 <group title="Bonding Configuration">
2832 <column name="other_config" key="lacp-port-id"
2833 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2834 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2835 used in LACP negotiations to identify individual ports
2836 participating in a bond.
2839 <column name="other_config" key="lacp-port-priority"
2840 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2841 The LACP port priority of this <ref table="Interface"/>. In LACP
2842 negotiations <ref table="Interface"/>s with numerically lower
2843 priorities are preferred for aggregation.
2846 <column name="other_config" key="lacp-aggregation-key"
2847 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2848 The LACP aggregation key of this <ref table="Interface"/>. <ref
2849 table="Interface"/>s with different aggregation keys may not be active
2850 within a given <ref table="Port"/> at the same time.
2854 <group title="Virtual Machine Identifiers">
2856 These key-value pairs specifically apply to an interface that
2857 represents a virtual Ethernet interface connected to a virtual
2858 machine. These key-value pairs should not be present for other types
2859 of interfaces. Keys whose names end in <code>-uuid</code> have
2860 values that uniquely identify the entity in question. For a Citrix
2861 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2862 Other hypervisors may use other formats.
2865 <column name="external_ids" key="attached-mac">
2866 The MAC address programmed into the ``virtual hardware'' for this
2867 interface, in the form
2868 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2869 For Citrix XenServer, this is the value of the <code>MAC</code> field
2870 in the VIF record for this interface.
2873 <column name="external_ids" key="iface-id">
2874 A system-unique identifier for the interface. On XenServer, this will
2875 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2878 <column name="external_ids" key="iface-status"
2879 type='{"type": "string",
2880 "enum": ["set", ["active", "inactive"]]}'>
2882 Hypervisors may sometimes have more than one interface associated
2883 with a given <ref column="external_ids" key="iface-id"/>, only one of
2884 which is actually in use at a given time. For example, in some
2885 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2886 for a single <ref column="external_ids" key="iface-id"/>, but only
2887 uses one of them at a time. A hypervisor that behaves this way must
2888 mark the currently in use interface <code>active</code> and the
2889 others <code>inactive</code>. A hypervisor that never has more than
2890 one interface for a given <ref column="external_ids" key="iface-id"/>
2891 may mark that interface <code>active</code> or omit <ref
2892 column="external_ids" key="iface-status"/> entirely.
2896 During VM migration, a given <ref column="external_ids"
2897 key="iface-id"/> might transiently be marked <code>active</code> on
2898 two different hypervisors. That is, <code>active</code> means that
2899 this <ref column="external_ids" key="iface-id"/> is the active
2900 instance within a single hypervisor, not in a broader scope.
2901 There is one exception: some hypervisors support ``migration'' from a
2902 given hypervisor to itself (most often for test purposes). During
2903 such a ``migration,'' two instances of a single <ref
2904 column="external_ids" key="iface-id"/> might both be briefly marked
2905 <code>active</code> on a single hypervisor.
2909 <column name="external_ids" key="xs-vif-uuid">
2910 The virtual interface associated with this interface.
2913 <column name="external_ids" key="xs-network-uuid">
2914 The virtual network to which this interface is attached.
2917 <column name="external_ids" key="vm-id">
2918 The VM to which this interface belongs. On XenServer, this will be the
2919 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2922 <column name="external_ids" key="xs-vm-uuid">
2923 The VM to which this interface belongs.
2927 <group title="VLAN Splinters">
2929 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2930 with buggy network drivers in old versions of Linux that do not
2931 properly support VLANs when VLAN devices are not used, at some cost
2932 in memory and performance.
2936 When VLAN splinters are enabled on a particular interface, Open vSwitch
2937 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2938 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2939 received on the VLAN device is treated as if it had been received on
2940 the interface on the particular VLAN.
2944 VLAN splinters consider a VLAN to be in use if:
2949 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2950 table="Port"/> record.
2954 The VLAN is listed within the <ref table="Port" column="trunks"/>
2955 column of the <ref table="Port"/> record of an interface on which
2956 VLAN splinters are enabled.
2958 An empty <ref table="Port" column="trunks"/> does not influence the
2959 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2960 will exceed the current 1,024 port per datapath limit.
2964 An OpenFlow flow within any bridge matches the VLAN.
2969 The same set of in-use VLANs applies to every interface on which VLAN
2970 splinters are enabled. That is, the set is not chosen separately for
2971 each interface but selected once as the union of all in-use VLANs based
2976 It does not make sense to enable VLAN splinters on an interface for an
2977 access port, or on an interface that is not a physical port.
2981 VLAN splinters are deprecated. When broken device drivers are no
2982 longer in widespread use, we will delete this feature.
2985 <column name="other_config" key="enable-vlan-splinters"
2986 type='{"type": "boolean"}'>
2988 Set to <code>true</code> to enable VLAN splinters on this interface.
2989 Defaults to <code>false</code>.
2993 VLAN splinters increase kernel and userspace memory overhead, so do
2994 not use them unless they are needed.
2998 VLAN splinters do not support 802.1p priority tags. Received
2999 priorities will appear to be 0, regardless of their actual values,
3000 and priorities on transmitted packets will also be cleared to 0.
3005 <group title="Auto Attach Configuration">
3007 Auto Attach configuration for a particular interface.
3010 <column name="lldp" key="enable" type='{"type": "boolean"}'>
3011 True to enable LLDP on this <ref table="Interface"/>. If not
3012 specified, LLDP will be disabled by default.
3016 <group title="Common Columns">
3017 The overall purpose of these columns is described under <code>Common
3018 Columns</code> at the beginning of this document.
3020 <column name="other_config"/>
3021 <column name="external_ids"/>
3025 <table name="Flow_Table" title="OpenFlow table configuration">
3026 <p>Configuration for a particular OpenFlow table.</p>
3028 <column name="name">
3029 The table's name. Set this column to change the name that controllers
3030 will receive when they request table statistics, e.g. <code>ovs-ofctl
3031 dump-tables</code>. The name does not affect switch behavior.
3034 <group title="Eviction Policy">
3036 Open vSwitch supports limiting the number of flows that may be
3037 installed in a flow table, via the <ref column="flow_limit"/> column.
3038 When adding a flow would exceed this limit, by default Open vSwitch
3039 reports an error, but there are two ways to configure Open vSwitch to
3040 instead delete (``evict'') a flow to make room for the new one:
3045 Set the <ref column="overflow_policy"/> column to <code>evict</code>.
3049 Send an OpenFlow 1.4+ ``table mod request'' to enable eviction for
3050 the flow table (e.g. <code>ovs-ofctl -O OpenFlow14 mod-table br0 0
3051 evict</code> to enable eviction on flow table 0 of bridge
3057 When a flow must be evicted due to overflow, the flow to evict is
3058 chosen through an approximation of the following algorithm. This
3059 algorithm is used regardless of how eviction was enabled:
3064 Divide the flows in the table into groups based on the values of the
3065 fields or subfields specified in the <ref column="groups"/> column,
3066 so that all of the flows in a given group have the same values for
3067 those fields. If a flow does not specify a given field, that field's
3068 value is treated as 0. If <ref column="groups"/> is empty, then all
3069 of the flows in the flow table are treated as a single group.
3073 Consider the flows in the largest group, that is, the group that
3074 contains the greatest number of flows. If two or more groups all
3075 have the same largest number of flows, consider the flows in all of
3080 If the flows under consideration have different importance values,
3081 eliminate from consideration any flows except those with the lowest
3082 importance. (``Importance,'' a 16-bit integer value attached to each
3083 flow, was introduced in OpenFlow 1.4. Flows inserted with older
3084 versions of OpenFlow always have an importance of 0.)
3088 Among the flows under consideration, choose the flow that expires
3089 soonest for eviction.
3094 The eviction process only considers flows that have an idle timeout
3095 or a hard timeout. That is, eviction never deletes permanent flows.
3096 (Permanent flows do count against <ref column="flow_limit"/>.)
3099 <column name="flow_limit">
3100 If set, limits the number of flows that may be added to the table.
3101 Open vSwitch may limit the number of flows in a table for other
3102 reasons, e.g. due to hardware limitations or for resource availability
3103 or performance reasons.
3106 <column name="overflow_policy">
3108 Controls the switch's behavior when an OpenFlow flow table
3109 modification request would add flows in excess of <ref
3110 column="flow_limit"/>. The supported values are:
3114 <dt><code>refuse</code></dt>
3116 Refuse to add the flow or flows. This is also the default policy
3117 when <ref column="overflow_policy"/> is unset.
3120 <dt><code>evict</code></dt>
3122 Delete a flow chosen according to the algorithm described above.
3127 <column name="groups">
3129 When <ref column="overflow_policy"/> is <code>evict</code>, this
3130 controls how flows are chosen for eviction when the flow table would
3131 otherwise exceed <ref column="flow_limit"/> flows. Its value is a
3132 set of NXM fields or sub-fields, each of which takes one of the forms
3133 <code><var>field</var>[]</code> or
3134 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
3135 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
3136 <code>nicira-ext.h</code> for a complete list of NXM field names.
3140 Open vSwitch ignores any invalid or unknown field specifications.
3144 When eviction is not enabled, via <ref column="overflow_policy"/> or
3145 an OpenFlow 1.4+ ``table mod,'' this column has no effect.
3150 <group title="Classifier Optimization">
3151 <column name="prefixes">
3153 This string set specifies which fields should be used for
3154 address prefix tracking. Prefix tracking allows the
3155 classifier to skip rules with longer than necessary prefixes,
3156 resulting in better wildcarding for datapath flows.
3159 Prefix tracking may be beneficial when a flow table contains
3160 matches on IP address fields with different prefix lengths.
3161 For example, when a flow table contains IP address matches on
3162 both full addresses and proper prefixes, the full address
3163 matches will typically cause the datapath flow to un-wildcard
3164 the whole address field (depending on flow entry priorities).
3165 In this case each packet with a different address gets handed
3166 to the userspace for flow processing and generates its own
3167 datapath flow. With prefix tracking enabled for the address
3168 field in question packets with addresses matching shorter
3169 prefixes would generate datapath flows where the irrelevant
3170 address bits are wildcarded, allowing the same datapath flow
3171 to handle all the packets within the prefix in question. In
3172 this case many userspace upcalls can be avoided and the
3173 overall performance can be better.
3176 This is a performance optimization only, so packets will
3177 receive the same treatment with or without prefix tracking.
3180 The supported fields are: <code>tun_id</code>,
3181 <code>tun_src</code>, <code>tun_dst</code>,
3182 <code>nw_src</code>, <code>nw_dst</code> (or aliases
3183 <code>ip_src</code> and <code>ip_dst</code>),
3184 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
3185 feature for <code>tun_id</code> would only make sense if the
3186 tunnel IDs have prefix structure similar to IP addresses.)
3190 By default, the <code>prefixes=ip_dst,ip_src</code> are used
3191 on each flow table. This instructs the flow classifier to
3192 track the IP destination and source addresses used by the
3193 rules in this specific flow table.
3197 The keyword <code>none</code> is recognized as an explicit
3198 override of the default values, causing no prefix fields to be
3203 To set the prefix fields, the flow table record needs to
3208 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
3210 Creates a flow table record for the OpenFlow table number 0.
3213 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
3215 Enables prefix tracking for IP source and destination
3221 There is a maximum number of fields that can be enabled for any
3222 one flow table. Currently this limit is 3.
3227 <group title="Common Columns">
3228 The overall purpose of these columns is described under <code>Common
3229 Columns</code> at the beginning of this document.
3231 <column name="external_ids"/>
3235 <table name="QoS" title="Quality of Service configuration">
3236 <p>Quality of Service (QoS) configuration for each Port that
3239 <column name="type">
3240 <p>The type of QoS to implement. The currently defined types are
3243 <dt><code>linux-htb</code></dt>
3245 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
3246 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
3247 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
3248 for information on how this classifier works and how to configure it.
3252 <dt><code>linux-hfsc</code></dt>
3254 Linux "Hierarchical Fair Service Curve" classifier.
3255 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
3256 information on how this classifier works.
3260 <dt><code>linux-sfq</code></dt>
3262 Linux ``Stochastic Fairness Queueing'' classifier. See
3263 <code>tc-sfq</code>(8) (also at
3264 <code>http://linux.die.net/man/8/tc-sfq</code>) for information on
3265 how this classifier works.
3269 <dt><code>linux-codel</code></dt>
3271 Linux ``Controlled Delay'' classifier. See <code>tc-codel</code>(8)
3273 <code>http://man7.org/linux/man-pages/man8/tc-codel.8.html</code>)
3274 for information on how this classifier works.
3278 <dt><code>linux-fq_codel</code></dt>
3280 Linux ``Fair Queuing with Controlled Delay'' classifier. See
3281 <code>tc-fq_codel</code>(8) (also at
3282 <code>http://man7.org/linux/man-pages/man8/tc-fq_codel.8.html</code>)
3283 for information on how this classifier works.
3288 <column name="queues">
3289 <p>A map from queue numbers to <ref table="Queue"/> records. The
3290 supported range of queue numbers depend on <ref column="type"/>. The
3291 queue numbers are the same as the <code>queue_id</code> used in
3292 OpenFlow in <code>struct ofp_action_enqueue</code> and other
3296 Queue 0 is the ``default queue.'' It is used by OpenFlow output
3297 actions when no specific queue has been set. When no configuration for
3298 queue 0 is present, it is automatically configured as if a <ref
3299 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
3300 and <ref table="Queue" column="other_config"/> columns had been
3302 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
3303 this case. With some queuing disciplines, this dropped all packets
3304 destined for the default queue.)
3308 <group title="Configuration for linux-htb and linux-hfsc">
3310 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
3311 the following key-value pair:
3314 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
3315 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
3316 specified, for physical interfaces, the default is the link rate. For
3317 other interfaces or if the link rate cannot be determined, the default
3318 is currently 100 Mbps.
3322 <group title="Common Columns">
3323 The overall purpose of these columns is described under <code>Common
3324 Columns</code> at the beginning of this document.
3326 <column name="other_config"/>
3327 <column name="external_ids"/>
3331 <table name="Queue" title="QoS output queue.">
3332 <p>A configuration for a port output queue, used in configuring Quality of
3333 Service (QoS) features. May be referenced by <ref column="queues"
3334 table="QoS"/> column in <ref table="QoS"/> table.</p>
3336 <column name="dscp">
3337 If set, Open vSwitch will mark all traffic egressing this
3338 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3339 default <ref table="Queue"/> is only marked if it was explicitly selected
3340 as the <ref table="Queue"/> at the time the packet was output. If unset,
3341 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3345 <group title="Configuration for linux-htb QoS">
3347 <ref table="QoS"/> <ref table="QoS" column="type"/>
3348 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3349 It has the following key-value pairs defined.
3352 <column name="other_config" key="min-rate"
3353 type='{"type": "integer", "minInteger": 1}'>
3354 Minimum guaranteed bandwidth, in bit/s.
3357 <column name="other_config" key="max-rate"
3358 type='{"type": "integer", "minInteger": 1}'>
3359 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3360 queue's rate will not be allowed to exceed the specified value, even
3361 if excess bandwidth is available. If unspecified, defaults to no
3365 <column name="other_config" key="burst"
3366 type='{"type": "integer", "minInteger": 1}'>
3367 Burst size, in bits. This is the maximum amount of ``credits'' that a
3368 queue can accumulate while it is idle. Optional. Details of the
3369 <code>linux-htb</code> implementation require a minimum burst size, so
3370 a too-small <code>burst</code> will be silently ignored.
3373 <column name="other_config" key="priority"
3374 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3375 A queue with a smaller <code>priority</code> will receive all the
3376 excess bandwidth that it can use before a queue with a larger value
3377 receives any. Specific priority values are unimportant; only relative
3378 ordering matters. Defaults to 0 if unspecified.
3382 <group title="Configuration for linux-hfsc QoS">
3384 <ref table="QoS"/> <ref table="QoS" column="type"/>
3385 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3386 It has the following key-value pairs defined.
3389 <column name="other_config" key="min-rate"
3390 type='{"type": "integer", "minInteger": 1}'>
3391 Minimum guaranteed bandwidth, in bit/s.
3394 <column name="other_config" key="max-rate"
3395 type='{"type": "integer", "minInteger": 1}'>
3396 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3397 queue's rate will not be allowed to exceed the specified value, even if
3398 excess bandwidth is available. If unspecified, defaults to no
3403 <group title="Common Columns">
3404 The overall purpose of these columns is described under <code>Common
3405 Columns</code> at the beginning of this document.
3407 <column name="other_config"/>
3408 <column name="external_ids"/>
3412 <table name="Mirror" title="Port mirroring.">
3413 <p>A port mirror within a <ref table="Bridge"/>.</p>
3414 <p>A port mirror configures a bridge to send selected frames to special
3415 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3416 traffic may also be referred to as SPAN or RSPAN, depending on how
3417 the mirrored traffic is sent.</p>
3420 When a packet enters an Open vSwitch bridge, it becomes eligible for
3421 mirroring based on its ingress port and VLAN. As the packet travels
3422 through the flow tables, each time it is output to a port, it becomes
3423 eligible for mirroring based on the egress port and VLAN. In Open
3424 vSwitch 2.5 and later, mirroring occurs just after a packet first becomes
3425 eligible, using the packet as it exists at that point; in Open vSwitch
3426 2.4 and earlier, mirroring occurs only after a packet has traversed all
3427 the flow tables, using the original packet as it entered the bridge.
3428 This makes a difference only when the flow table modifies the packet: in
3429 Open vSwitch 2.4, the modifications are never visible to mirrors, whereas
3430 in Open vSwitch 2.5 and later modifications made before the first output
3431 that makes it eligible for mirroring to a particular destination are
3436 A packet that enters an Open vSwitch bridge is mirrored to a particular
3437 destination only once, even if it is eligible for multiple reasons. For
3438 example, a packet would be mirrored to a particular <ref
3439 column="output_port"/> only once, even if it is selected for mirroring to
3440 that port by <ref column="select_dst_port"/> and <ref
3441 column="select_src_port"/> in the same or different <ref table="Mirror"/>
3445 <column name="name">
3446 Arbitrary identifier for the <ref table="Mirror"/>.
3449 <group title="Selecting Packets for Mirroring">
3451 To be selected for mirroring, a given packet must enter or leave the
3452 bridge through a selected port and it must also be in one of the
3456 <column name="select_all">
3457 If true, every packet arriving or departing on any port is
3458 selected for mirroring.
3461 <column name="select_dst_port">
3462 Ports on which departing packets are selected for mirroring.
3465 <column name="select_src_port">
3466 Ports on which arriving packets are selected for mirroring.
3469 <column name="select_vlan">
3470 VLANs on which packets are selected for mirroring. An empty set
3471 selects packets on all VLANs.
3475 <group title="Mirroring Destination Configuration">
3477 These columns are mutually exclusive. Exactly one of them must be
3481 <column name="output_port">
3482 <p>Output port for selected packets, if nonempty.</p>
3483 <p>Specifying a port for mirror output reserves that port exclusively
3484 for mirroring. No frames other than those selected for mirroring
3486 will be forwarded to the port, and any frames received on the port
3487 will be discarded.</p>
3489 The output port may be any kind of port supported by Open vSwitch.
3490 It may be, for example, a physical port (sometimes called SPAN) or a
3495 <column name="output_vlan">
3496 <p>Output VLAN for selected packets, if nonempty.</p>
3497 <p>The frames will be sent out all ports that trunk
3498 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3499 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3500 trunk port, the frame's VLAN tag will be set to
3501 <ref column="output_vlan"/>, replacing any existing tag; when it is
3502 sent out an implicit VLAN port, the frame will not be tagged. This
3503 type of mirroring is sometimes called RSPAN.</p>
3505 See the documentation for
3506 <ref column="other_config" key="forward-bpdu"/> in the
3507 <ref table="Interface"/> table for a list of destination MAC
3508 addresses which will not be mirrored to a VLAN to avoid confusing
3509 switches that interpret the protocols that they represent.
3511 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3512 contains unmanaged switches. Consider an unmanaged physical switch
3513 with two ports: port 1, connected to an end host, and port 2,
3514 connected to an Open vSwitch configured to mirror received packets
3515 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3516 port 1 that the physical switch forwards to port 2. The Open vSwitch
3517 forwards this packet to its destination and then reflects it back on
3518 port 2 in VLAN 123. This reflected packet causes the unmanaged
3519 physical switch to replace the MAC learning table entry, which
3520 correctly pointed to port 1, with one that incorrectly points to port
3521 2. Afterward, the physical switch will direct packets destined for
3522 the end host to the Open vSwitch on port 2, instead of to the end
3523 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3524 desired in this scenario, then the physical switch must be replaced
3525 by one that learns Ethernet addresses on a per-VLAN basis. In
3526 addition, learning should be disabled on the VLAN containing mirrored
3527 traffic. If this is not done then intermediate switches will learn
3528 the MAC address of each end host from the mirrored traffic. If
3529 packets being sent to that end host are also mirrored, then they will
3530 be dropped since the switch will attempt to send them out the input
3531 port. Disabling learning for the VLAN will cause the switch to
3532 correctly send the packet out all ports configured for that VLAN. If
3533 Open vSwitch is being used as an intermediate switch, learning can be
3534 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3535 in the appropriate <ref table="Bridge"/> table or tables.</p>
3537 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3538 VLAN and should generally be preferred.
3543 <group title="Statistics: Mirror counters">
3545 Key-value pairs that report mirror statistics. The update period
3546 is controlled by <ref column="other_config"
3547 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3549 <column name="statistics" key="tx_packets">
3550 Number of packets transmitted through this mirror.
3552 <column name="statistics" key="tx_bytes">
3553 Number of bytes transmitted through this mirror.
3557 <group title="Common Columns">
3558 The overall purpose of these columns is described under <code>Common
3559 Columns</code> at the beginning of this document.
3561 <column name="external_ids"/>
3565 <table name="Controller" title="OpenFlow controller configuration.">
3566 <p>An OpenFlow controller.</p>
3569 Open vSwitch supports two kinds of OpenFlow controllers:
3573 <dt>Primary controllers</dt>
3576 This is the kind of controller envisioned by the OpenFlow 1.0
3577 specification. Usually, a primary controller implements a network
3578 policy by taking charge of the switch's flow table.
3582 Open vSwitch initiates and maintains persistent connections to
3583 primary controllers, retrying the connection each time it fails or
3584 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3585 <ref table="Bridge"/> table applies to primary controllers.
3589 Open vSwitch permits a bridge to have any number of primary
3590 controllers. When multiple controllers are configured, Open
3591 vSwitch connects to all of them simultaneously. Because
3592 OpenFlow 1.0 does not specify how multiple controllers
3593 coordinate in interacting with a single switch, more than
3594 one primary controller should be specified only if the
3595 controllers are themselves designed to coordinate with each
3596 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3597 vendor extension may be useful for this.)
3600 <dt>Service controllers</dt>
3603 These kinds of OpenFlow controller connections are intended for
3604 occasional support and maintenance use, e.g. with
3605 <code>ovs-ofctl</code>. Usually a service controller connects only
3606 briefly to inspect or modify some of a switch's state.
3610 Open vSwitch listens for incoming connections from service
3611 controllers. The service controllers initiate and, if necessary,
3612 maintain the connections from their end. The <ref table="Bridge"
3613 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3614 not apply to service controllers.
3618 Open vSwitch supports configuring any number of service controllers.
3624 The <ref column="target"/> determines the type of controller.
3627 <group title="Core Features">
3628 <column name="target">
3629 <p>Connection method for controller.</p>
3631 The following connection methods are currently supported for primary
3635 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3637 <p>The specified SSL <var>port</var> on the host at the
3638 given <var>ip</var>, which must be expressed as an IP
3639 address (not a DNS name). The <ref table="Open_vSwitch"
3640 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3641 table must point to a valid SSL configuration when this form
3643 <p>If <var>port</var> is not specified, it defaults to 6653.</p>
3644 <p>SSL support is an optional feature that is not always built as
3645 part of Open vSwitch.</p>
3647 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3650 The specified TCP <var>port</var> on the host at the given
3651 <var>ip</var>, which must be expressed as an IP address (not a
3652 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3653 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3654 e.g. <code>tcp:[::1]:6653</code>.
3657 If <var>port</var> is not specified, it defaults to 6653.
3662 The following connection methods are currently supported for service
3666 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3669 Listens for SSL connections on the specified TCP <var>port</var>.
3670 If <var>ip</var>, which must be expressed as an IP address (not a
3671 DNS name), is specified, then connections are restricted to the
3672 specified local IP address (either IPv4 or IPv6). If
3673 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3674 e.g. <code>pssl:6653:[::1]</code>.
3677 If <var>port</var> is not specified, it defaults to
3678 6653. If <var>ip</var> is not specified then it listens only on
3679 IPv4 (but not IPv6) addresses. The
3680 <ref table="Open_vSwitch" column="ssl"/>
3681 column in the <ref table="Open_vSwitch"/> table must point to a
3682 valid SSL configuration when this form is used.
3685 If <var>port</var> is not specified, it currently to 6653.
3688 SSL support is an optional feature that is not always built as
3689 part of Open vSwitch.
3692 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3695 Listens for connections on the specified TCP <var>port</var>. If
3696 <var>ip</var>, which must be expressed as an IP address (not a
3697 DNS name), is specified, then connections are restricted to the
3698 specified local IP address (either IPv4 or IPv6). If
3699 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3700 e.g. <code>ptcp:6653:[::1]</code>. If <var>ip</var> is not
3701 specified then it listens only on IPv4 addresses.
3704 If <var>port</var> is not specified, it defaults to 6653.
3708 <p>When multiple controllers are configured for a single bridge, the
3709 <ref column="target"/> values must be unique. Duplicate
3710 <ref column="target"/> values yield unspecified results.</p>
3713 <column name="connection_mode">
3714 <p>If it is specified, this setting must be one of the following
3715 strings that describes how Open vSwitch contacts this OpenFlow
3716 controller over the network:</p>
3719 <dt><code>in-band</code></dt>
3720 <dd>In this mode, this controller's OpenFlow traffic travels over the
3721 bridge associated with the controller. With this setting, Open
3722 vSwitch allows traffic to and from the controller regardless of the
3723 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3724 would never be able to connect to the controller, because it did
3725 not have a flow to enable it.) This is the most common connection
3726 mode because it is not necessary to maintain two independent
3728 <dt><code>out-of-band</code></dt>
3729 <dd>In this mode, OpenFlow traffic uses a control network separate
3730 from the bridge associated with this controller, that is, the
3731 bridge does not use any of its own network devices to communicate
3732 with the controller. The control network must be configured
3733 separately, before or after <code>ovs-vswitchd</code> is started.
3737 <p>If not specified, the default is implementation-specific.</p>
3741 <group title="Controller Failure Detection and Handling">
3742 <column name="max_backoff">
3743 Maximum number of milliseconds to wait between connection attempts.
3744 Default is implementation-specific.
3747 <column name="inactivity_probe">
3748 Maximum number of milliseconds of idle time on connection to
3749 controller before sending an inactivity probe message. If Open
3750 vSwitch does not communicate with the controller for the specified
3751 number of seconds, it will send a probe. If a response is not
3752 received for the same additional amount of time, Open vSwitch
3753 assumes the connection has been broken and attempts to reconnect.
3754 Default is implementation-specific. A value of 0 disables
3759 <group title="Asynchronous Messages">
3761 OpenFlow switches send certain messages to controllers spontanenously,
3762 that is, not in response to any request from the controller. These
3763 messages are called ``asynchronous messages.'' These columns allow
3764 asynchronous messages to be limited or disabled to ensure the best use
3765 of network resources.
3768 <column name="enable_async_messages">
3769 The OpenFlow protocol enables asynchronous messages at time of
3770 connection establishment, which means that a controller can receive
3771 asynchronous messages, potentially many of them, even if it turns them
3772 off immediately after connecting. Set this column to
3773 <code>false</code> to change Open vSwitch behavior to disable, by
3774 default, all asynchronous messages. The controller can use the
3775 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3776 on any messages that it does want to receive, if any.
3779 <group title="Controller Rate Limiting">
3781 A switch can forward packets to a controller over the OpenFlow
3782 protocol. Forwarding packets this way at too high a rate can
3783 overwhelm a controller, frustrate use of the OpenFlow connection for
3784 other purposes, increase the latency of flow setup, and use an
3785 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3786 limiting the rate of packet forwarding to a controller.
3790 There are two main reasons in OpenFlow for a packet to be sent to a
3791 controller: either the packet ``misses'' in the flow table, that is,
3792 there is no matching flow, or a flow table action says to send the
3793 packet to the controller. Open vSwitch limits the rate of each kind
3794 of packet separately at the configured rate. Therefore, the actual
3795 rate that packets are sent to the controller can be up to twice the
3796 configured rate, when packets are sent for both reasons.
3800 This feature is specific to forwarding packets over an OpenFlow
3801 connection. It is not general-purpose QoS. See the <ref
3802 table="QoS"/> table for quality of service configuration, and <ref
3803 column="ingress_policing_rate" table="Interface"/> in the <ref
3804 table="Interface"/> table for ingress policing configuration.
3807 <column name="controller_rate_limit">
3809 The maximum rate at which the switch will forward packets to the
3810 OpenFlow controller, in packets per second. If no value is
3811 specified, rate limiting is disabled.
3815 <column name="controller_burst_limit">
3817 When a high rate triggers rate-limiting, Open vSwitch queues
3818 packets to the controller for each port and transmits them to the
3819 controller at the configured rate. This value limits the number of
3820 queued packets. Ports on a bridge share the packet queue fairly.
3824 This value has no effect unless <ref
3825 column="controller_rate_limit"/> is configured. The current
3826 default when this value is not specified is one-quarter of <ref
3827 column="controller_rate_limit"/>, meaning that queuing can delay
3828 forwarding a packet to the controller by up to 250 ms.
3832 <group title="Controller Rate Limiting Statistics">
3834 These values report the effects of rate limiting. Their values are
3835 relative to establishment of the most recent OpenFlow connection,
3836 or since rate limiting was enabled, whichever happened more
3837 recently. Each consists of two values, one with <code>TYPE</code>
3838 replaced by <code>miss</code> for rate limiting flow table misses,
3839 and the other with <code>TYPE</code> replaced by
3840 <code>action</code> for rate limiting packets sent by OpenFlow
3845 These statistics are reported only when controller rate limiting is
3849 <column name="status" key="packet-in-TYPE-bypassed"
3850 type='{"type": "integer", "minInteger": 0}'>
3851 Number of packets sent directly to the controller, without queuing,
3852 because the rate did not exceed the configured maximum.
3855 <column name="status" key="packet-in-TYPE-queued"
3856 type='{"type": "integer", "minInteger": 0}'>
3857 Number of packets added to the queue to send later.
3860 <column name="status" key="packet-in-TYPE-dropped"
3861 type='{"type": "integer", "minInteger": 0}'>
3862 Number of packets added to the queue that were later dropped due to
3863 overflow. This value is less than or equal to <ref column="status"
3864 key="packet-in-TYPE-queued"/>.
3867 <column name="status" key="packet-in-TYPE-backlog"
3868 type='{"type": "integer", "minInteger": 0}'>
3869 Number of packets currently queued. The other statistics increase
3870 monotonically, but this one fluctuates between 0 and the <ref
3871 column="controller_burst_limit"/> as conditions change.
3877 <group title="Additional In-Band Configuration">
3878 <p>These values are considered only in in-band control mode (see
3879 <ref column="connection_mode"/>).</p>
3881 <p>When multiple controllers are configured on a single bridge, there
3882 should be only one set of unique values in these columns. If different
3883 values are set for these columns in different controllers, the effect
3886 <column name="local_ip">
3887 The IP address to configure on the local port,
3888 e.g. <code>192.168.0.123</code>. If this value is unset, then
3889 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3893 <column name="local_netmask">
3894 The IP netmask to configure on the local port,
3895 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3896 but this value is unset, then the default is chosen based on whether
3897 the IP address is class A, B, or C.
3900 <column name="local_gateway">
3901 The IP address of the gateway to configure on the local port, as a
3902 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3903 this network has no gateway.
3907 <group title="Controller Status">
3908 <column name="is_connected">
3909 <code>true</code> if currently connected to this controller,
3910 <code>false</code> otherwise.
3914 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3915 <p>The level of authority this controller has on the associated
3916 bridge. Possible values are:</p>
3918 <dt><code>other</code></dt>
3919 <dd>Allows the controller access to all OpenFlow features.</dd>
3920 <dt><code>master</code></dt>
3921 <dd>Equivalent to <code>other</code>, except that there may be at
3922 most one master controller at a time. When a controller configures
3923 itself as <code>master</code>, any existing master is demoted to
3924 the <code>slave</code> role.</dd>
3925 <dt><code>slave</code></dt>
3926 <dd>Allows the controller read-only access to OpenFlow features.
3927 Attempts to modify the flow table will be rejected with an
3928 error. Slave controllers do not receive OFPT_PACKET_IN or
3929 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3934 <column name="status" key="last_error">
3935 A human-readable description of the last error on the connection
3936 to the controller; i.e. <code>strerror(errno)</code>. This key
3937 will exist only if an error has occurred.
3940 <column name="status" key="state"
3941 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3943 The state of the connection to the controller:
3946 <dt><code>VOID</code></dt>
3947 <dd>Connection is disabled.</dd>
3949 <dt><code>BACKOFF</code></dt>
3950 <dd>Attempting to reconnect at an increasing period.</dd>
3952 <dt><code>CONNECTING</code></dt>
3953 <dd>Attempting to connect.</dd>
3955 <dt><code>ACTIVE</code></dt>
3956 <dd>Connected, remote host responsive.</dd>
3958 <dt><code>IDLE</code></dt>
3959 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3962 These values may change in the future. They are provided only for
3967 <column name="status" key="sec_since_connect"
3968 type='{"type": "integer", "minInteger": 0}'>
3969 The amount of time since this controller last successfully connected to
3970 the switch (in seconds). Value is empty if controller has never
3971 successfully connected.
3974 <column name="status" key="sec_since_disconnect"
3975 type='{"type": "integer", "minInteger": 1}'>
3976 The amount of time since this controller last disconnected from
3977 the switch (in seconds). Value is empty if controller has never
3982 <group title="Connection Parameters">
3984 Additional configuration for a connection between the controller
3985 and the Open vSwitch.
3988 <column name="other_config" key="dscp"
3989 type='{"type": "integer"}'>
3990 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3991 in the Type of Service (TOS) field in the IP header. DSCP provides a
3992 mechanism to classify the network traffic and provide Quality of
3993 Service (QoS) on IP networks.
3995 The DSCP value specified here is used when establishing the connection
3996 between the controller and the Open vSwitch. If no value is specified,
3997 a default value of 48 is chosen. Valid DSCP values must be in the
4003 <group title="Common Columns">
4004 The overall purpose of these columns is described under <code>Common
4005 Columns</code> at the beginning of this document.
4007 <column name="external_ids"/>
4008 <column name="other_config"/>
4012 <table name="Manager" title="OVSDB management connection.">
4014 Configuration for a database connection to an Open vSwitch database
4019 This table primarily configures the Open vSwitch database
4020 (<code>ovsdb-server</code>), not the Open vSwitch switch
4021 (<code>ovs-vswitchd</code>). The switch does read the table to determine
4022 what connections should be treated as in-band.
4026 The Open vSwitch database server can initiate and maintain active
4027 connections to remote clients. It can also listen for database
4031 <group title="Core Features">
4032 <column name="target">
4033 <p>Connection method for managers.</p>
4035 The following connection methods are currently supported:
4038 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
4041 The specified SSL <var>port</var> on the host at the given
4042 <var>ip</var>, which must be expressed as an IP address
4043 (not a DNS name). The <ref table="Open_vSwitch"
4044 column="ssl"/> column in the <ref table="Open_vSwitch"/>
4045 table must point to a valid SSL configuration when this
4049 If <var>port</var> is not specified, it defaults to 6640.
4052 SSL support is an optional feature that is not always
4053 built as part of Open vSwitch.
4057 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
4060 The specified TCP <var>port</var> on the host at the given
4061 <var>ip</var>, which must be expressed as an IP address (not a
4062 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
4063 <var>ip</var> is an IPv6 address, wrap it in square brackets,
4064 e.g. <code>tcp:[::1]:6640</code>.
4067 If <var>port</var> is not specified, it defaults to 6640.
4070 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4073 Listens for SSL connections on the specified TCP <var>port</var>.
4074 Specify 0 for <var>port</var> to have the kernel automatically
4075 choose an available port. If <var>ip</var>, which must be
4076 expressed as an IP address (not a DNS name), is specified, then
4077 connections are restricted to the specified local IP address
4078 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4079 address, wrap in square brackets,
4080 e.g. <code>pssl:6640:[::1]</code>. If <var>ip</var> is not
4081 specified then it listens only on IPv4 (but not IPv6) addresses.
4082 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
4083 table="Open_vSwitch"/> table must point to a valid SSL
4084 configuration when this form is used.
4087 If <var>port</var> is not specified, it defaults to 6640.
4090 SSL support is an optional feature that is not always built as
4091 part of Open vSwitch.
4094 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
4097 Listens for connections on the specified TCP <var>port</var>.
4098 Specify 0 for <var>port</var> to have the kernel automatically
4099 choose an available port. If <var>ip</var>, which must be
4100 expressed as an IP address (not a DNS name), is specified, then
4101 connections are restricted to the specified local IP address
4102 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
4103 address, wrap it in square brackets,
4104 e.g. <code>ptcp:6640:[::1]</code>. If <var>ip</var> is not
4105 specified then it listens only on IPv4 addresses.
4108 If <var>port</var> is not specified, it defaults to 6640.
4112 <p>When multiple managers are configured, the <ref column="target"/>
4113 values must be unique. Duplicate <ref column="target"/> values yield
4114 unspecified results.</p>
4117 <column name="connection_mode">
4119 If it is specified, this setting must be one of the following strings
4120 that describes how Open vSwitch contacts this OVSDB client over the
4125 <dt><code>in-band</code></dt>
4127 In this mode, this connection's traffic travels over a bridge
4128 managed by Open vSwitch. With this setting, Open vSwitch allows
4129 traffic to and from the client regardless of the contents of the
4130 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
4131 to connect to the client, because it did not have a flow to enable
4132 it.) This is the most common connection mode because it is not
4133 necessary to maintain two independent networks.
4135 <dt><code>out-of-band</code></dt>
4137 In this mode, the client's traffic uses a control network separate
4138 from that managed by Open vSwitch, that is, Open vSwitch does not
4139 use any of its own network devices to communicate with the client.
4140 The control network must be configured separately, before or after
4141 <code>ovs-vswitchd</code> is started.
4146 If not specified, the default is implementation-specific.
4151 <group title="Client Failure Detection and Handling">
4152 <column name="max_backoff">
4153 Maximum number of milliseconds to wait between connection attempts.
4154 Default is implementation-specific.
4157 <column name="inactivity_probe">
4158 Maximum number of milliseconds of idle time on connection to the client
4159 before sending an inactivity probe message. If Open vSwitch does not
4160 communicate with the client for the specified number of seconds, it
4161 will send a probe. If a response is not received for the same
4162 additional amount of time, Open vSwitch assumes the connection has been
4163 broken and attempts to reconnect. Default is implementation-specific.
4164 A value of 0 disables inactivity probes.
4168 <group title="Status">
4169 <column name="is_connected">
4170 <code>true</code> if currently connected to this manager,
4171 <code>false</code> otherwise.
4174 <column name="status" key="last_error">
4175 A human-readable description of the last error on the connection
4176 to the manager; i.e. <code>strerror(errno)</code>. This key
4177 will exist only if an error has occurred.
4180 <column name="status" key="state"
4181 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
4183 The state of the connection to the manager:
4186 <dt><code>VOID</code></dt>
4187 <dd>Connection is disabled.</dd>
4189 <dt><code>BACKOFF</code></dt>
4190 <dd>Attempting to reconnect at an increasing period.</dd>
4192 <dt><code>CONNECTING</code></dt>
4193 <dd>Attempting to connect.</dd>
4195 <dt><code>ACTIVE</code></dt>
4196 <dd>Connected, remote host responsive.</dd>
4198 <dt><code>IDLE</code></dt>
4199 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
4202 These values may change in the future. They are provided only for
4207 <column name="status" key="sec_since_connect"
4208 type='{"type": "integer", "minInteger": 0}'>
4209 The amount of time since this manager last successfully connected
4210 to the database (in seconds). Value is empty if manager has never
4211 successfully connected.
4214 <column name="status" key="sec_since_disconnect"
4215 type='{"type": "integer", "minInteger": 0}'>
4216 The amount of time since this manager last disconnected from the
4217 database (in seconds). Value is empty if manager has never
4221 <column name="status" key="locks_held">
4222 Space-separated list of the names of OVSDB locks that the connection
4223 holds. Omitted if the connection does not hold any locks.
4226 <column name="status" key="locks_waiting">
4227 Space-separated list of the names of OVSDB locks that the connection is
4228 currently waiting to acquire. Omitted if the connection is not waiting
4232 <column name="status" key="locks_lost">
4233 Space-separated list of the names of OVSDB locks that the connection
4234 has had stolen by another OVSDB client. Omitted if no locks have been
4235 stolen from this connection.
4238 <column name="status" key="n_connections"
4239 type='{"type": "integer", "minInteger": 2}'>
4241 When <ref column="target"/> specifies a connection method that
4242 listens for inbound connections (e.g. <code>ptcp:</code> or
4243 <code>pssl:</code>) and more than one connection is actually active,
4244 the value is the number of active connections. Otherwise, this
4245 key-value pair is omitted.
4248 When multiple connections are active, status columns and key-value
4249 pairs (other than this one) report the status of one arbitrarily
4254 <column name="status" key="bound_port" type='{"type": "integer"}'>
4255 When <ref column="target"/> is <code>ptcp:</code> or
4256 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
4257 listening. (This is is particularly useful when <ref
4258 column="target"/> specifies a port of 0, allowing the kernel to
4259 choose any available port.)
4263 <group title="Connection Parameters">
4265 Additional configuration for a connection between the manager
4266 and the Open vSwitch Database.
4269 <column name="other_config" key="dscp"
4270 type='{"type": "integer"}'>
4271 The Differentiated Service Code Point (DSCP) is specified using 6 bits
4272 in the Type of Service (TOS) field in the IP header. DSCP provides a
4273 mechanism to classify the network traffic and provide Quality of
4274 Service (QoS) on IP networks.
4276 The DSCP value specified here is used when establishing the connection
4277 between the manager and the Open vSwitch. If no value is specified, a
4278 default value of 48 is chosen. Valid DSCP values must be in the range
4283 <group title="Common Columns">
4284 The overall purpose of these columns is described under <code>Common
4285 Columns</code> at the beginning of this document.
4287 <column name="external_ids"/>
4288 <column name="other_config"/>
4292 <table name="NetFlow">
4293 A NetFlow target. NetFlow is a protocol that exports a number of
4294 details about terminating IP flows, such as the principals involved
4297 <column name="targets">
4298 NetFlow targets in the form
4299 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
4300 must be specified numerically, not as a DNS name.
4303 <column name="engine_id">
4304 Engine ID to use in NetFlow messages. Defaults to datapath index
4308 <column name="engine_type">
4309 Engine type to use in NetFlow messages. Defaults to datapath
4310 index if not specified.
4313 <column name="active_timeout">
4315 The interval at which NetFlow records are sent for flows that
4316 are still active, in seconds. A value of <code>0</code>
4317 requests the default timeout (currently 600 seconds); a value
4318 of <code>-1</code> disables active timeouts.
4322 The NetFlow passive timeout, for flows that become inactive,
4323 is not configurable. It will vary depending on the Open
4324 vSwitch version, the forms and contents of the OpenFlow flow
4325 tables, CPU and memory usage, and network activity. A typical
4326 passive timeout is about a second.
4330 <column name="add_id_to_interface">
4331 <p>If this column's value is <code>false</code>, the ingress and egress
4332 interface fields of NetFlow flow records are derived from OpenFlow port
4333 numbers. When it is <code>true</code>, the 7 most significant bits of
4334 these fields will be replaced by the least significant 7 bits of the
4335 engine id. This is useful because many NetFlow collectors do not
4336 expect multiple switches to be sending messages from the same host, so
4337 they do not store the engine information which could be used to
4338 disambiguate the traffic.</p>
4339 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
4342 <group title="Common Columns">
4343 The overall purpose of these columns is described under <code>Common
4344 Columns</code> at the beginning of this document.
4346 <column name="external_ids"/>
4351 SSL configuration for an Open_vSwitch.
4353 <column name="private_key">
4354 Name of a PEM file containing the private key used as the switch's
4355 identity for SSL connections to the controller.
4358 <column name="certificate">
4359 Name of a PEM file containing a certificate, signed by the
4360 certificate authority (CA) used by the controller and manager,
4361 that certifies the switch's private key, identifying a trustworthy
4365 <column name="ca_cert">
4366 Name of a PEM file containing the CA certificate used to verify
4367 that the switch is connected to a trustworthy controller.
4370 <column name="bootstrap_ca_cert">
4371 If set to <code>true</code>, then Open vSwitch will attempt to
4372 obtain the CA certificate from the controller on its first SSL
4373 connection and save it to the named PEM file. If it is successful,
4374 it will immediately drop the connection and reconnect, and from then
4375 on all SSL connections must be authenticated by a certificate signed
4376 by the CA certificate thus obtained. <em>This option exposes the
4377 SSL connection to a man-in-the-middle attack obtaining the initial
4378 CA certificate.</em> It may still be useful for bootstrapping.
4381 <group title="Common Columns">
4382 The overall purpose of these columns is described under <code>Common
4383 Columns</code> at the beginning of this document.
4385 <column name="external_ids"/>
4389 <table name="sFlow">
4390 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4391 monitoring of switches.</p>
4393 <column name="agent">
4394 Name of the network device whose IP address should be reported as the
4395 ``agent address'' to collectors. If not specified, the agent device is
4396 figured from the first target address and the routing table. If the
4397 routing table does not contain a route to the target, the IP address
4398 defaults to the <ref table="Controller" column="local_ip"/> in the
4399 collector's <ref table="Controller"/>. If an agent IP address cannot be
4400 determined any of these ways, sFlow is disabled.
4403 <column name="header">
4404 Number of bytes of a sampled packet to send to the collector.
4405 If not specified, the default is 128 bytes.
4408 <column name="polling">
4409 Polling rate in seconds to send port statistics to the collector.
4410 If not specified, defaults to 30 seconds.
4413 <column name="sampling">
4414 Rate at which packets should be sampled and sent to the collector.
4415 If not specified, defaults to 400, which means one out of 400
4416 packets, on average, will be sent to the collector.
4419 <column name="targets">
4420 sFlow targets in the form
4421 <code><var>ip</var>:<var>port</var></code>.
4424 <group title="Common Columns">
4425 The overall purpose of these columns is described under <code>Common
4426 Columns</code> at the beginning of this document.
4428 <column name="external_ids"/>
4432 <table name="IPFIX">
4433 <p>Configuration for sending packets to IPFIX collectors.</p>
4436 IPFIX is a protocol that exports a number of details about flows. The
4437 IPFIX implementation in Open vSwitch samples packets at a configurable
4438 rate, extracts flow information from those packets, optionally caches and
4439 aggregates the flow information, and sends the result to one or more
4444 IPFIX in Open vSwitch can be configured two different ways:
4449 With <em>per-bridge sampling</em>, Open vSwitch performs IPFIX sampling
4450 automatically on all packets that pass through a bridge. To configure
4451 per-bridge sampling, create an <ref table="IPFIX"/> record and point a
4452 <ref table="Bridge"/> table's <ref table="Bridge" column="ipfix"/>
4453 column to it. The <ref table="Flow_Sample_Collector_Set"/> table is
4454 not used for per-bridge sampling.
4459 With <em>flow-based sampling</em>, <code>sample</code> actions in the
4460 OpenFlow flow table drive IPFIX sampling. See
4461 <code>ovs-ofctl</code>(8) for a description of the
4462 <code>sample</code> action.
4466 Flow-based sampling also requires database configuration: create a
4467 <ref table="IPFIX"/> record that describes the IPFIX configuration
4468 and a <ref table="Flow_Sample_Collector_Set"/> record that points to
4469 the <ref table="Bridge"/> whose flow table holds the
4470 <code>sample</code> actions and to <ref table="IPFIX"/> record. The
4471 <ref table="Bridge" column="ipfix"/> in the <ref table="Bridge"/>
4472 table is not used for flow-based sampling.
4477 <column name="targets">
4478 IPFIX target collectors in the form
4479 <code><var>ip</var>:<var>port</var></code>.
4482 <column name="cache_active_timeout">
4483 The maximum period in seconds for which an IPFIX flow record is
4484 cached and aggregated before being sent. If not specified,
4485 defaults to 0. If 0, caching is disabled.
4488 <column name="cache_max_flows">
4489 The maximum number of IPFIX flow records that can be cached at a
4490 time. If not specified, defaults to 0. If 0, caching is
4494 <group title="Per-Bridge Sampling">
4496 These values affect only per-bridge sampling. See above for a
4497 description of the differences between per-bridge and flow-based
4501 <column name="sampling">
4502 The rate at which packets should be sampled and sent to each target
4503 collector. If not specified, defaults to 400, which means one out of
4504 400 packets, on average, will be sent to each target collector.
4507 <column name="obs_domain_id">
4508 The IPFIX Observation Domain ID sent in each IPFIX packet. If not
4509 specified, defaults to 0.
4512 <column name="obs_point_id">
4513 The IPFIX Observation Point ID sent in each IPFIX flow record. If not
4514 specified, defaults to 0.
4517 <column name="other_config" key="enable-tunnel-sampling"
4518 type='{"type": "boolean"}'>
4520 Set to <code>true</code> to enable sampling and reporting tunnel
4521 header 7-tuples in IPFIX flow records. Tunnel sampling is disabled
4526 The following enterprise entities report the sampled tunnel info:
4530 <dt>tunnelType:</dt>
4532 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4533 <p>type: unsigned 8-bit integer.</p>
4534 <p>data type semantics: identifier.</p>
4535 <p>description: Identifier of the layer 2 network overlay network
4536 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4541 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4542 <p>type: variable-length octetarray.</p>
4543 <p>data type semantics: identifier.</p>
4544 <p>description: Key which is used for identifying an individual
4545 traffic flow within a VxLAN (24-bit VNI), GENEVE (24-bit VNI),
4546 GRE (32-bit key), or LISP (24-bit instance ID) tunnel. The
4547 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4548 ID in network byte order.</p>
4550 <dt>tunnelSourceIPv4Address:</dt>
4552 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4553 <p>type: unsigned 32-bit integer.</p>
4554 <p>data type semantics: identifier.</p>
4555 <p>description: The IPv4 source address in the tunnel IP packet
4558 <dt>tunnelDestinationIPv4Address:</dt>
4560 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4561 <p>type: unsigned 32-bit integer.</p>
4562 <p>data type semantics: identifier.</p>
4563 <p>description: The IPv4 destination address in the tunnel IP
4566 <dt>tunnelProtocolIdentifier:</dt>
4568 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4569 <p>type: unsigned 8-bit integer.</p>
4570 <p>data type semantics: identifier.</p>
4571 <p>description: The value of the protocol number in the tunnel
4572 IP packet header. The protocol number identifies the tunnel IP
4573 packet payload type.</p>
4575 <dt>tunnelSourceTransportPort:</dt>
4577 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4578 <p>type: unsigned 16-bit integer.</p>
4579 <p>data type semantics: identifier.</p>
4580 <p>description: The source port identifier in the tunnel transport
4581 header. For the transport protocols UDP, TCP, and SCTP, this is
4582 the source port number given in the respective header.</p>
4584 <dt>tunnelDestinationTransportPort:</dt>
4586 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4587 <p>type: unsigned 16-bit integer.</p>
4588 <p>data type semantics: identifier.</p>
4589 <p>description: The destination port identifier in the tunnel
4590 transport header. For the transport protocols UDP, TCP, and SCTP,
4591 this is the destination port number given in the respective header.
4597 <column name="other_config" key="enable-input-sampling"
4598 type='{"type": "boolean"}'>
4599 By default, Open vSwitch samples and reports flows at bridge port input
4600 in IPFIX flow records. Set this column to <code>false</code> to
4601 disable input sampling.
4604 <column name="other_config" key="enable-output-sampling"
4605 type='{"type": "boolean"}'>
4606 By default, Open vSwitch samples and reports flows at bridge port
4607 output in IPFIX flow records. Set this column to <code>false</code> to
4608 disable output sampling.
4612 <group title="Common Columns">
4613 The overall purpose of these columns is described under <code>Common
4614 Columns</code> at the beginning of this document.
4616 <column name="external_ids"/>
4620 <table name="Flow_Sample_Collector_Set">
4622 A set of IPFIX collectors of packet samples generated by OpenFlow
4623 <code>sample</code> actions. This table is used only for IPFIX
4624 flow-based sampling, not for per-bridge sampling (see the <ref
4625 table="IPFIX"/> table for a description of the two forms).
4629 The ID of this collector set, unique among the bridge's
4630 collector sets, to be used as the <code>collector_set_id</code>
4631 in OpenFlow <code>sample</code> actions.
4634 <column name="bridge">
4635 The bridge into which OpenFlow <code>sample</code> actions can
4636 be added to send packet samples to this set of IPFIX collectors.
4639 <column name="ipfix">
4640 Configuration of the set of IPFIX collectors to send one flow
4641 record per sampled packet to.
4644 <group title="Common Columns">
4645 The overall purpose of these columns is described under <code>Common
4646 Columns</code> at the beginning of this document.
4648 <column name="external_ids"/>
4652 <table name="AutoAttach">
4653 <p>Auto Attach configuration within a bridge. The IETF Auto-Attach SPBM
4654 draft standard describes a compact method of using IEEE 802.1AB Link
4655 Layer Discovery Protocol (LLDP) together with a IEEE 802.1aq Shortest
4656 Path Bridging (SPB) network to automatically attach network devices
4657 to individual services in a SPB network. The intent here is to allow
4658 network applications and devices using OVS to be able to easily take
4659 advantage of features offered by industry standard SPB networks.</p>
4661 <p>Auto Attach (AA) uses LLDP to communicate between a directly connected
4662 Auto Attach Client (AAC) and Auto Attach Server (AAS). The LLDP protocol
4663 is extended to add two new Type-Length-Value tuples (TLVs). The first
4664 new TLV supports the ongoing discovery of directly connected AA
4665 correspondents. Auto Attach operates by regularly transmitting AA
4666 discovery TLVs between the AA client and AA server. By exchanging these
4667 discovery messages, both the AAC and AAS learn the system name and
4668 system description of their peer. In the OVS context, OVS operates as
4669 the AA client and the AA server resides on a switch at the edge of the
4672 <p>Once AA discovery has been completed the AAC then uses the
4673 second new TLV to deliver identifier mappings from the AAC to the AAS. A primary
4674 feature of Auto Attach is to facilitate the mapping of VLANs defined
4675 outside the SPB network onto service ids (ISIDs) defined within the SPM
4676 network. By doing so individual external VLANs can be mapped onto
4677 specific SPB network services. These VLAN id to ISID mappings can be
4678 configured and managed locally using new options added to the ovs-vsctl
4681 <p>The Auto Attach OVS feature does not provide a full implementation of
4682 the LLDP protocol. Support for the mandatory TLVs as defined by the LLDP
4683 standard and support for the AA TLV extensions is provided. LLDP
4684 protocol support in OVS can be enabled or disabled on a port by port
4685 basis. LLDP support is disabled by default.</p>
4687 <column name="system_name">
4688 The system_name string is exported in LLDP messages. It should uniquely
4689 identify the bridge in the network.
4692 <column name="system_description">
4693 The system_description string is exported in LLDP messages. It should
4694 describe the type of software and hardware.
4697 <column name="mappings">
4698 A mapping from SPB network Individual Service Identifier (ISID) to VLAN id.