1 <?xml version="1.0" encoding="utf-8"?>
2 <database 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-handler-threads"
156 type='{"type": "integer", "minInteger": 1}'>
158 Specifies the number of threads for software datapaths to use for
159 handling new flows. The default the number of online CPU cores minus
160 the number of revalidators.
163 This configuration is per datapath. If you have more than one
164 software datapath (e.g. some <code>system</code> bridges and some
165 <code>netdev</code> bridges), then the total number of threads is
166 <code>n-handler-threads</code> times the number of software
171 <column name="other_config" key="n-revalidator-threads"
172 type='{"type": "integer", "minInteger": 1}'>
174 Specifies the number of threads for software datapaths to use for
175 revalidating flows in the datapath. Typically, there is a direct
176 correlation between the number of revalidator threads, and the number
177 of flows allowed in the datapath. The default is the number of cpu
178 cores divided by four plus one. If <code>n-handler-threads</code> is
179 set, the default changes to the number of cpu cores minus the number
183 This configuration is per datapath. If you have more than one
184 software datapath (e.g. some <code>system</code> bridges and some
185 <code>netdev</code> bridges), then the total number of threads is
186 <code>n-handler-threads</code> times the number of software
192 <group title="Status">
193 <column name="next_cfg">
194 Sequence number for client to increment. When a client modifies
195 any part of the database configuration and wishes to wait for
196 Open vSwitch to finish applying the changes, it may increment
197 this sequence number.
200 <column name="cur_cfg">
201 Sequence number that Open vSwitch sets to the current value of
202 <ref column="next_cfg"/> after it finishes applying a set of
203 configuration changes.
206 <group title="Statistics">
208 The <code>statistics</code> column contains key-value pairs that
209 report statistics about a system running an Open vSwitch. These are
210 updated periodically (currently, every 5 seconds). Key-value pairs
211 that cannot be determined or that do not apply to a platform are
215 <column name="other_config" key="enable-statistics"
216 type='{"type": "boolean"}'>
217 Statistics are disabled by default to avoid overhead in the common
218 case when statistics gathering is not useful. Set this value to
219 <code>true</code> to enable populating the <ref column="statistics"/>
220 column or to <code>false</code> to explicitly disable it.
223 <column name="statistics" key="cpu"
224 type='{"type": "integer", "minInteger": 1}'>
226 Number of CPU processors, threads, or cores currently online and
227 available to the operating system on which Open vSwitch is running,
228 as an integer. This may be less than the number installed, if some
229 are not online or if they are not available to the operating
233 Open vSwitch userspace processes are not multithreaded, but the
234 Linux kernel-based datapath is.
238 <column name="statistics" key="load_average">
239 A comma-separated list of three floating-point numbers,
240 representing the system load average over the last 1, 5, and 15
241 minutes, respectively.
244 <column name="statistics" key="memory">
246 A comma-separated list of integers, each of which represents a
247 quantity of memory in kilobytes that describes the operating
248 system on which Open vSwitch is running. In respective order,
253 <li>Total amount of RAM allocated to the OS.</li>
254 <li>RAM allocated to the OS that is in use.</li>
255 <li>RAM that can be flushed out to disk or otherwise discarded
256 if that space is needed for another purpose. This number is
257 necessarily less than or equal to the previous value.</li>
258 <li>Total disk space allocated for swap.</li>
259 <li>Swap space currently in use.</li>
263 On Linux, all five values can be determined and are included. On
264 other operating systems, only the first two values can be
265 determined, so the list will only have two values.
269 <column name="statistics" key="process_NAME">
271 One such key-value pair, with <code>NAME</code> replaced by
272 a process name, will exist for each running Open vSwitch
273 daemon process, with <var>name</var> replaced by the
274 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
275 value is a comma-separated list of integers. The integers
276 represent the following, with memory measured in kilobytes
277 and durations in milliseconds:
281 <li>The process's virtual memory size.</li>
282 <li>The process's resident set size.</li>
283 <li>The amount of user and system CPU time consumed by the
285 <li>The number of times that the process has crashed and been
286 automatically restarted by the monitor.</li>
287 <li>The duration since the process was started.</li>
288 <li>The duration for which the process has been running.</li>
292 The interpretation of some of these values depends on whether the
293 process was started with the <option>--monitor</option>. If it
294 was not, then the crash count will always be 0 and the two
295 durations will always be the same. If <option>--monitor</option>
296 was given, then the crash count may be positive; if it is, the
297 latter duration is the amount of time since the most recent crash
302 There will be one key-value pair for each file in Open vSwitch's
303 ``run directory'' (usually <code>/var/run/openvswitch</code>)
304 whose name ends in <code>.pid</code>, whose contents are a
305 process ID, and which is locked by a running process. The
306 <var>name</var> is taken from the pidfile's name.
310 Currently Open vSwitch is only able to obtain all of the above
311 detail on Linux systems. On other systems, the same key-value
312 pairs will be present but the values will always be the empty
317 <column name="statistics" key="file_systems">
319 A space-separated list of information on local, writable file
320 systems. Each item in the list describes one file system and
321 consists in turn of a comma-separated list of the following:
325 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
326 Any spaces or commas in the mount point are replaced by
328 <li>Total size, in kilobytes, as an integer.</li>
329 <li>Amount of storage in use, in kilobytes, as an integer.</li>
333 This key-value pair is omitted if there are no local, writable
334 file systems or if Open vSwitch cannot obtain the needed
341 <group title="Version Reporting">
343 These columns report the types and versions of the hardware and
344 software running Open vSwitch. We recommend in general that software
345 should test whether specific features are supported instead of relying
346 on version number checks. These values are primarily intended for
347 reporting to human administrators.
350 <column name="ovs_version">
351 The Open vSwitch version number, e.g. <code>1.1.0</code>.
354 <column name="db_version">
356 The database schema version number in the form
357 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
358 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
359 a non-backward compatible way (e.g. deleting a column or a table),
360 <var>major</var> is incremented. When the database schema is changed
361 in a backward compatible way (e.g. adding a new column),
362 <var>minor</var> is incremented. When the database schema is changed
363 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
368 The schema version is part of the database schema, so it can also be
369 retrieved by fetching the schema using the Open vSwitch database
374 <column name="system_type">
376 An identifier for the type of system on top of which Open vSwitch
377 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
380 System integrators are responsible for choosing and setting an
381 appropriate value for this column.
385 <column name="system_version">
387 The version of the system identified by <ref column="system_type"/>,
388 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
391 System integrators are responsible for choosing and setting an
392 appropriate value for this column.
398 <group title="Database Configuration">
400 These columns primarily configure the Open vSwitch database
401 (<code>ovsdb-server</code>), not the Open vSwitch switch
402 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
403 column="ssl"/> settings.
407 The Open vSwitch switch does read the database configuration to
408 determine remote IP addresses to which in-band control should apply.
411 <column name="manager_options">
412 Database clients to which the Open vSwitch database server should
413 connect or to which it should listen, along with options for how these
414 connection should be configured. See the <ref table="Manager"/> table
415 for more information.
419 <group title="Common Columns">
420 The overall purpose of these columns is described under <code>Common
421 Columns</code> at the beginning of this document.
423 <column name="other_config"/>
424 <column name="external_ids"/>
428 <table name="Bridge">
430 Configuration for a bridge within an
431 <ref table="Open_vSwitch"/>.
434 A <ref table="Bridge"/> record represents an Ethernet switch with one or
435 more ``ports,'' which are the <ref table="Port"/> records pointed to by
436 the <ref table="Bridge"/>'s <ref column="ports"/> column.
439 <group title="Core Features">
441 Bridge identifier. Should be alphanumeric and no more than about 8
442 bytes long. Must be unique among the names of ports, interfaces, and
446 <column name="ports">
447 Ports included in the bridge.
450 <column name="mirrors">
451 Port mirroring configuration.
454 <column name="netflow">
455 NetFlow configuration.
458 <column name="sflow">
459 sFlow(R) configuration.
462 <column name="ipfix">
466 <column name="flood_vlans">
468 VLAN IDs of VLANs on which MAC address learning should be disabled,
469 so that packets are flooded instead of being sent to specific ports
470 that are believed to contain packets' destination MACs. This should
471 ordinarily be used to disable MAC learning on VLANs used for
472 mirroring (RSPAN VLANs). It may also be useful for debugging.
475 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
476 the <ref table="Port"/> table) is incompatible with
477 <code>flood_vlans</code>. Consider using another bonding mode or
478 a different type of mirror instead.
483 <group title="OpenFlow Configuration">
484 <column name="controller">
486 OpenFlow controller set. If unset, then no OpenFlow controllers
491 If there are primary controllers, removing all of them clears the
492 flow table. If there are no primary controllers, adding one also
493 clears the flow table. Other changes to the set of controllers, such
494 as adding or removing a service controller, adding another primary
495 controller to supplement an existing primary controller, or removing
496 only one of two primary controllers, have no effect on the flow
501 <column name="flow_tables">
502 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
503 table ID to configuration for that table.
506 <column name="fail_mode">
507 <p>When a controller is configured, it is, ordinarily, responsible
508 for setting up all flows on the switch. Thus, if the connection to
509 the controller fails, no new network connections can be set up.
510 If the connection to the controller stays down long enough,
511 no packets can pass through the switch at all. This setting
512 determines the switch's response to such a situation. It may be set
513 to one of the following:
515 <dt><code>standalone</code></dt>
516 <dd>If no message is received from the controller for three
517 times the inactivity probe interval
518 (see <ref column="inactivity_probe"/>), then Open vSwitch
519 will take over responsibility for setting up flows. In
520 this mode, Open vSwitch causes the bridge to act like an
521 ordinary MAC-learning switch. Open vSwitch will continue
522 to retry connecting to the controller in the background
523 and, when the connection succeeds, it will discontinue its
524 standalone behavior.</dd>
525 <dt><code>secure</code></dt>
526 <dd>Open vSwitch will not set up flows on its own when the
527 controller connection fails or when no controllers are
528 defined. The bridge will continue to retry connecting to
529 any defined controllers forever.</dd>
533 The default is <code>standalone</code> if the value is unset, but
534 future versions of Open vSwitch may change the default.
537 The <code>standalone</code> mode can create forwarding loops on a
538 bridge that has more than one uplink port unless STP is enabled. To
539 avoid loops on such a bridge, configure <code>secure</code> mode or
540 enable STP (see <ref column="stp_enable"/>).
542 <p>When more than one controller is configured,
543 <ref column="fail_mode"/> is considered only when none of the
544 configured controllers can be contacted.</p>
546 Changing <ref column="fail_mode"/> when no primary controllers are
547 configured clears the flow table.
551 <column name="datapath_id">
552 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
553 (Setting this column has no useful effect. Set <ref
554 column="other-config" key="datapath-id"/> instead.)
557 <column name="other_config" key="datapath-id">
558 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
559 value. May not be all-zero.
562 <column name="other_config" key="dp-desc">
563 Human readable description of datapath. It it a maximum 256
564 byte-long free-form string to describe the datapath for
565 debugging purposes, e.g. <code>switch3 in room 3120</code>.
568 <column name="other_config" key="disable-in-band"
569 type='{"type": "boolean"}'>
570 If set to <code>true</code>, disable in-band control on the bridge
571 regardless of controller and manager settings.
574 <column name="other_config" key="in-band-queue"
575 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
576 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
577 that will be used by flows set up by in-band control on this bridge.
578 If unset, or if the port used by an in-band control flow does not have
579 QoS configured, or if the port does not have a queue with the specified
580 ID, the default queue is used instead.
583 <column name="protocols">
585 List of OpenFlow protocols that may be used when negotiating
586 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
587 1.3 are enabled by default if this column is empty.
591 OpenFlow 1.4 is not enabled by default because its implementation is
596 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
597 experimental because the OpenFlow 1.5 specification is still under
598 development and thus subject to change. Pass
599 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
600 OpenFlow 1.5 to be enabled.
605 <group title="Spanning Tree Configuration">
606 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
607 that ensures loop-free topologies. It allows redundant links to
608 be included in the network to provide automatic backup paths if
609 the active links fails.
611 <column name="stp_enable">
612 Enable spanning tree on the bridge. By default, STP is disabled
613 on bridges. Bond, internal, and mirror ports are not supported
614 and will not participate in the spanning tree.
617 <column name="other_config" key="stp-system-id">
618 The bridge's STP identifier (the lower 48 bits of the bridge-id)
620 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
621 By default, the identifier is the MAC address of the bridge.
624 <column name="other_config" key="stp-priority"
625 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
626 The bridge's relative priority value for determining the root
627 bridge (the upper 16 bits of the bridge-id). A bridge with the
628 lowest bridge-id is elected the root. By default, the priority
632 <column name="other_config" key="stp-hello-time"
633 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
634 The interval between transmissions of hello messages by
635 designated ports, in seconds. By default the hello interval is
639 <column name="other_config" key="stp-max-age"
640 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
641 The maximum age of the information transmitted by the bridge
642 when it is the root bridge, in seconds. By default, the maximum
646 <column name="other_config" key="stp-forward-delay"
647 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
648 The delay to wait between transitioning root and designated
649 ports to <code>forwarding</code>, in seconds. By default, the
650 forwarding delay is 15 seconds.
653 <column name="other_config" key="mcast-snooping-aging-time"
654 type='{"type": "integer", "minInteger": 1}'>
656 The maximum number of seconds to retain a multicast snooping entry for
657 which no packets have been seen. The default is currently 300
658 seconds (5 minutes). The value, if specified, is forced into a
659 reasonable range, currently 15 to 3600 seconds.
663 <column name="other_config" key="mcast-snooping-table-size"
664 type='{"type": "integer", "minInteger": 1}'>
666 The maximum number of multicast snooping addresses to learn. The
667 default is currently 2048. The value, if specified, is forced into
668 a reasonable range, currently 10 to 1,000,000.
671 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
672 type='{"type": "boolean"}'>
674 If set to <code>false</code>, unregistered multicast packets are forwarded
676 If set to <code>true</code>, unregistered multicast packets are forwarded
677 to ports connected to multicast routers.
682 <group title="Multicast Snooping Configuration">
683 Multicast snooping (RFC 4541) monitors the Internet Group Management
684 Protocol (IGMP) traffic between hosts and multicast routers. The
685 switch uses what IGMP snooping learns to forward multicast traffic
686 only to interfaces that are connected to interested receivers.
687 Currently it supports IGMPv1 and IGMPv2 protocols.
689 <column name="mcast_snooping_enable">
690 Enable multicast snooping on the bridge. For now, the default
695 <group title="Other Features">
696 <column name="datapath_type">
697 Name of datapath provider. The kernel datapath has
698 type <code>system</code>. The userspace datapath has
699 type <code>netdev</code>.
702 <column name="external_ids" key="bridge-id">
703 A unique identifier of the bridge. On Citrix XenServer this will
704 commonly be the same as
705 <ref column="external_ids" key="xs-network-uuids"/>.
708 <column name="external_ids" key="xs-network-uuids">
709 Semicolon-delimited set of universally unique identifier(s) for the
710 network with which this bridge is associated on a Citrix XenServer
711 host. The network identifiers are RFC 4122 UUIDs as displayed by,
712 e.g., <code>xe network-list</code>.
715 <column name="other_config" key="hwaddr">
716 An Ethernet address in the form
717 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
718 to set the hardware address of the local port and influence the
722 <column name="other_config" key="forward-bpdu"
723 type='{"type": "boolean"}'>
724 Option to allow forwarding of BPDU frames when NORMAL action is
725 invoked. Frames with reserved Ethernet addresses (e.g. STP
726 BPDU) will be forwarded when this option is enabled and the
727 switch is not providing that functionality. If STP is enabled
728 on the port, STP BPDUs will never be forwarded. If the Open
729 vSwitch bridge is used to connect different Ethernet networks,
730 and if Open vSwitch node does not run STP, then this option
731 should be enabled. Default is disabled, set to
732 <code>true</code> to enable.
734 The following destination MAC addresss will not be forwarded when this
737 <dt><code>01:80:c2:00:00:00</code></dt>
738 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
740 <dt><code>01:80:c2:00:00:01</code></dt>
741 <dd>IEEE Pause frame.</dd>
743 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
744 <dd>Other reserved protocols.</dd>
746 <dt><code>00:e0:2b:00:00:00</code></dt>
747 <dd>Extreme Discovery Protocol (EDP).</dd>
750 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
752 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
754 <dt><code>01:00:0c:cc:cc:cc</code></dt>
756 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
757 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
761 <dt><code>01:00:0c:cc:cc:cd</code></dt>
762 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
764 <dt><code>01:00:0c:cd:cd:cd</code></dt>
765 <dd>Cisco STP Uplink Fast.</dd>
767 <dt><code>01:00:0c:00:00:00</code></dt>
768 <dd>Cisco Inter Switch Link.</dd>
770 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
775 <column name="other_config" key="mac-aging-time"
776 type='{"type": "integer", "minInteger": 1}'>
778 The maximum number of seconds to retain a MAC learning 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 A short MAC aging time allows a network to more quickly detect that a
786 host is no longer connected to a switch port. However, it also makes
787 it more likely that packets will be flooded unnecessarily, when they
788 are addressed to a connected host that rarely transmits packets. To
789 reduce the incidence of unnecessary flooding, use a MAC aging time
790 longer than the maximum interval at which a host will ordinarily
795 <column name="other_config" key="mac-table-size"
796 type='{"type": "integer", "minInteger": 1}'>
798 The maximum number of MAC addresses to learn. The default is
799 currently 2048. The value, if specified, is forced into a reasonable
800 range, currently 10 to 1,000,000.
805 <group title="Bridge Status">
807 Status information about bridges.
809 <column name="status">
810 Key-value pairs that report bridge status.
812 <column name="status" key="stp_bridge_id">
814 The bridge-id (in hex) used in spanning tree advertisements.
815 Configuring the bridge-id is described in the
816 <code>stp-system-id</code> and <code>stp-priority</code> keys
817 of the <code>other_config</code> section earlier.
820 <column name="status" key="stp_designated_root">
822 The designated root (in hex) for this spanning tree.
825 <column name="status" key="stp_root_path_cost">
827 The path cost of reaching the designated bridge. A lower
833 <group title="Common Columns">
834 The overall purpose of these columns is described under <code>Common
835 Columns</code> at the beginning of this document.
837 <column name="other_config"/>
838 <column name="external_ids"/>
842 <table name="Port" table="Port or bond configuration.">
843 <p>A port within a <ref table="Bridge"/>.</p>
844 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
845 <ref column="interfaces"/> column. Such a port logically
846 corresponds to a port on a physical Ethernet switch. A port
847 with more than one interface is a ``bonded port'' (see
848 <ref group="Bonding Configuration"/>).</p>
849 <p>Some properties that one might think as belonging to a port are actually
850 part of the port's <ref table="Interface"/> members.</p>
853 Port name. Should be alphanumeric and no more than about 8
854 bytes long. May be the same as the interface name, for
855 non-bonded ports. Must otherwise be unique among the names of
856 ports, interfaces, and bridges on a host.
859 <column name="interfaces">
860 The port's interfaces. If there is more than one, this is a
864 <group title="VLAN Configuration">
865 <p>Bridge ports support the following types of VLAN configuration:</p>
870 A trunk port carries packets on one or more specified VLANs
871 specified in the <ref column="trunks"/> column (often, on every
872 VLAN). A packet that ingresses on a trunk port is in the VLAN
873 specified in its 802.1Q header, or VLAN 0 if the packet has no
874 802.1Q header. A packet that egresses through a trunk port will
875 have an 802.1Q header if it has a nonzero VLAN ID.
879 Any packet that ingresses on a trunk port tagged with a VLAN that
880 the port does not trunk is dropped.
887 An access port carries packets on exactly one VLAN specified in the
888 <ref column="tag"/> column. Packets egressing on an access port
889 have no 802.1Q header.
893 Any packet with an 802.1Q header with a nonzero VLAN ID that
894 ingresses on an access port is dropped, regardless of whether the
895 VLAN ID in the header is the access port's VLAN ID.
899 <dt>native-tagged</dt>
901 A native-tagged port resembles a trunk port, with the exception that
902 a packet without an 802.1Q header that ingresses on a native-tagged
903 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
907 <dt>native-untagged</dt>
909 A native-untagged port resembles a native-tagged port, with the
910 exception that a packet that egresses on a native-untagged port in
911 the native VLAN will not have an 802.1Q header.
915 A packet will only egress through bridge ports that carry the VLAN of
916 the packet, as described by the rules above.
919 <column name="vlan_mode">
921 The VLAN mode of the port, as described above. When this column is
922 empty, a default mode is selected as follows:
926 If <ref column="tag"/> contains a value, the port is an access
927 port. The <ref column="trunks"/> column should be empty.
930 Otherwise, the port is a trunk port. The <ref column="trunks"/>
931 column value is honored if it is present.
938 For an access port, the port's implicitly tagged VLAN. For a
939 native-tagged or native-untagged port, the port's native VLAN. Must
940 be empty if this is a trunk port.
944 <column name="trunks">
946 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
947 or VLANs that this port trunks; if it is empty, then the port trunks
948 all VLANs. Must be empty if this is an access port.
951 A native-tagged or native-untagged port always trunks its native
952 VLAN, regardless of whether <ref column="trunks"/> includes that
957 <column name="other_config" key="priority-tags"
958 type='{"type": "boolean"}'>
960 An 802.1Q header contains two important pieces of information: a VLAN
961 ID and a priority. A frame with a zero VLAN ID, called a
962 ``priority-tagged'' frame, is supposed to be treated the same way as
963 a frame without an 802.1Q header at all (except for the priority).
967 However, some network elements ignore any frame that has 802.1Q
968 header at all, even when the VLAN ID is zero. Therefore, by default
969 Open vSwitch does not output priority-tagged frames, instead omitting
970 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
971 <code>true</code> to enable priority-tagged frames on a port.
975 Regardless of this setting, Open vSwitch omits the 802.1Q header on
976 output if both the VLAN ID and priority would be zero.
980 All frames output to native-tagged ports have a nonzero VLAN ID, so
981 this setting is not meaningful on native-tagged ports.
986 <group title="Bonding Configuration">
987 <p>A port that has more than one interface is a ``bonded port.'' Bonding
988 allows for load balancing and fail-over.</p>
991 The following types of bonding will work with any kind of upstream
992 switch. On the upstream switch, do not configure the interfaces as a
997 <dt><code>balance-slb</code></dt>
999 Balances flows among slaves based on source MAC address and output
1000 VLAN, with periodic rebalancing as traffic patterns change.
1003 <dt><code>active-backup</code></dt>
1005 Assigns all flows to one slave, failing over to a backup slave when
1006 the active slave is disabled. This is the only bonding mode in which
1007 interfaces may be plugged into different upstream switches.
1012 The following modes require the upstream switch to support 802.3ad with
1013 successful LACP negotiation. If LACP negotiation fails and
1014 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1019 <dt><code>balance-tcp</code></dt>
1021 Balances flows among slaves based on L2, L3, and L4 protocol
1022 information such as destination MAC address, IP address, and TCP
1027 <p>These columns apply only to bonded ports. Their values are
1028 otherwise ignored.</p>
1030 <column name="bond_mode">
1031 <p>The type of bonding used for a bonded port. Defaults to
1032 <code>active-backup</code> if unset.
1036 <column name="other_config" key="bond-hash-basis"
1037 type='{"type": "integer"}'>
1038 An integer hashed along with flows when choosing output slaves in load
1039 balanced bonds. When changed, all flows will be assigned different
1040 hash values possibly causing slave selection decisions to change. Does
1041 not affect bonding modes which do not employ load balancing such as
1042 <code>active-backup</code>.
1045 <group title="Link Failure Detection">
1047 An important part of link bonding is detecting that links are down so
1048 that they may be disabled. These settings determine how Open vSwitch
1049 detects link failure.
1052 <column name="other_config" key="bond-detect-mode"
1053 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1054 The means used to detect link failures. Defaults to
1055 <code>carrier</code> which uses each interface's carrier to detect
1056 failures. When set to <code>miimon</code>, will check for failures
1057 by polling each interface's MII.
1060 <column name="other_config" key="bond-miimon-interval"
1061 type='{"type": "integer"}'>
1062 The interval, in milliseconds, between successive attempts to poll
1063 each interface's MII. Relevant only when <ref column="other_config"
1064 key="bond-detect-mode"/> is <code>miimon</code>.
1067 <column name="bond_updelay">
1069 The number of milliseconds for which the link must stay up on an
1070 interface before the interface is considered to be up. Specify
1071 <code>0</code> to enable the interface immediately.
1075 This setting is honored only when at least one bonded interface is
1076 already enabled. When no interfaces are enabled, then the first
1077 bond interface to come up is enabled immediately.
1081 <column name="bond_downdelay">
1082 The number of milliseconds for which the link must stay down on an
1083 interface before the interface is considered to be down. Specify
1084 <code>0</code> to disable the interface immediately.
1088 <group title="LACP Configuration">
1090 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1091 allows switches to automatically detect that they are connected by
1092 multiple links and aggregate across those links. These settings
1093 control LACP behavior.
1096 <column name="lacp">
1097 Configures LACP on this port. LACP allows directly connected
1098 switches to negotiate which links may be bonded. LACP may be enabled
1099 on non-bonded ports for the benefit of any switches they may be
1100 connected to. <code>active</code> ports are allowed to initiate LACP
1101 negotiations. <code>passive</code> ports are allowed to participate
1102 in LACP negotiations initiated by a remote switch, but not allowed to
1103 initiate such negotiations themselves. If LACP is enabled on a port
1104 whose partner switch does not support LACP, the bond will be
1105 disabled, unless other-config:lacp-fallback-ab is set to true.
1106 Defaults to <code>off</code> if unset.
1109 <column name="other_config" key="lacp-system-id">
1110 The LACP system ID of this <ref table="Port"/>. The system ID of a
1111 LACP bond is used to identify itself to its partners. Must be a
1112 nonzero MAC address. Defaults to the bridge Ethernet address if
1116 <column name="other_config" key="lacp-system-priority"
1117 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1118 The LACP system priority of this <ref table="Port"/>. In LACP
1119 negotiations, link status decisions are made by the system with the
1120 numerically lower priority.
1123 <column name="other_config" key="lacp-time"
1124 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1126 The LACP timing which should be used on this <ref table="Port"/>.
1127 By default <code>slow</code> is used. When configured to be
1128 <code>fast</code> LACP heartbeats are requested at a rate of once
1129 per second causing connectivity problems to be detected more
1130 quickly. In <code>slow</code> mode, heartbeats are requested at a
1131 rate of once every 30 seconds.
1135 <column name="other_config" key="lacp-fallback-ab"
1136 type='{"type": "boolean"}'>
1138 Determines the behavior of openvswitch bond in LACP mode. If
1139 the partner switch does not support LACP, setting this option
1140 to <code>true</code> allows openvswitch to fallback to
1141 active-backup. If the option is set to <code>false</code>, the
1142 bond will be disabled. In both the cases, once the partner switch
1143 is configured to LACP mode, the bond will use LACP.
1148 <group title="Rebalancing Configuration">
1150 These settings control behavior when a bond is in
1151 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1154 <column name="other_config" key="bond-rebalance-interval"
1155 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1156 For a load balanced bonded port, the number of milliseconds between
1157 successive attempts to rebalance the bond, that is, to move flows
1158 from one interface on the bond to another in an attempt to keep usage
1159 of each interface roughly equal. If zero, load balancing is disabled
1160 on the bond (link failure still cause flows to move). If
1161 less than 1000ms, the rebalance interval will be 1000ms.
1165 <column name="bond_fake_iface">
1166 For a bonded port, whether to create a fake internal interface with the
1167 name of the port. Use only for compatibility with legacy software that
1172 <group title="Spanning Tree Configuration">
1173 <column name="other_config" key="stp-enable"
1174 type='{"type": "boolean"}'>
1175 If spanning tree is enabled on the bridge, member ports are
1176 enabled by default (with the exception of bond, internal, and
1177 mirror ports which do not work with STP). If this column's
1178 value is <code>false</code> spanning tree is disabled on the
1182 <column name="other_config" key="stp-port-num"
1183 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1184 The port number used for the lower 8 bits of the port-id. By
1185 default, the numbers will be assigned automatically. If any
1186 port's number is manually configured on a bridge, then they
1190 <column name="other_config" key="stp-port-priority"
1191 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1192 The port's relative priority value for determining the root
1193 port (the upper 8 bits of the port-id). A port with a lower
1194 port-id will be chosen as the root port. By default, the
1198 <column name="other_config" key="stp-path-cost"
1199 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1200 Spanning tree path cost for the port. A lower number indicates
1201 a faster link. By default, the cost is based on the maximum
1205 <group title="Multicast Snooping">
1206 <column name="other_config" key="mcast-snooping-flood"
1207 type='{"type": "boolean"}'>
1209 If set to <code>true</code>, multicast packets are unconditionally
1210 forwarded to the specific port.
1215 <group title="Other Features">
1217 Quality of Service configuration for this port.
1221 The MAC address to use for this port for the purpose of choosing the
1222 bridge's MAC address. This column does not necessarily reflect the
1223 port's actual MAC address, nor will setting it change the port's actual
1227 <column name="fake_bridge">
1228 Does this port represent a sub-bridge for its tagged VLAN within the
1229 Bridge? See ovs-vsctl(8) for more information.
1232 <column name="external_ids" key="fake-bridge-id-*">
1233 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1234 column) are defined by prefixing a <ref table="Bridge"/> <ref
1235 table="Bridge" column="external_ids"/> key with
1236 <code>fake-bridge-</code>,
1237 e.g. <code>fake-bridge-xs-network-uuids</code>.
1241 <group title="Port Status">
1243 Status information about ports attached to bridges.
1245 <column name="status">
1246 Key-value pairs that report port status.
1248 <column name="status" key="stp_port_id">
1250 The port-id (in hex) used in spanning tree advertisements for
1251 this port. Configuring the port-id is described in the
1252 <code>stp-port-num</code> and <code>stp-port-priority</code>
1253 keys of the <code>other_config</code> section earlier.
1256 <column name="status" key="stp_state"
1257 type='{"type": "string", "enum": ["set",
1258 ["disabled", "listening", "learning",
1259 "forwarding", "blocking"]]}'>
1261 STP state of the port.
1264 <column name="status" key="stp_sec_in_state"
1265 type='{"type": "integer", "minInteger": 0}'>
1267 The amount of time (in seconds) port has been in the current
1271 <column name="status" key="stp_role"
1272 type='{"type": "string", "enum": ["set",
1273 ["root", "designated", "alternate"]]}'>
1275 STP role of the port.
1280 <group title="Port Statistics">
1282 Key-value pairs that report port statistics. The update period
1283 is controlled by <ref column="other_config"
1284 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1286 <group title="Statistics: STP transmit and receive counters">
1287 <column name="statistics" key="stp_tx_count">
1288 Number of STP BPDUs sent on this port by the spanning
1291 <column name="statistics" key="stp_rx_count">
1292 Number of STP BPDUs received on this port and accepted by the
1293 spanning tree library.
1295 <column name="statistics" key="stp_error_count">
1296 Number of bad STP BPDUs received on this port. Bad BPDUs
1297 include runt packets and those with an unexpected protocol ID.
1302 <group title="Common Columns">
1303 The overall purpose of these columns is described under <code>Common
1304 Columns</code> at the beginning of this document.
1306 <column name="other_config"/>
1307 <column name="external_ids"/>
1311 <table name="Interface" title="One physical network device in a Port.">
1312 An interface within a <ref table="Port"/>.
1314 <group title="Core Features">
1315 <column name="name">
1316 Interface name. Should be alphanumeric and no more than about 8 bytes
1317 long. May be the same as the port name, for non-bonded ports. Must
1318 otherwise be unique among the names of ports, interfaces, and bridges
1322 <column name="ifindex">
1323 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1324 2863, if the interface has one, otherwise 0. The ifindex is useful for
1325 seamless integration with protocols such as SNMP and sFlow.
1328 <column name="mac_in_use">
1329 The MAC address in use by this interface.
1333 <p>Ethernet address to set for this interface. If unset then the
1334 default MAC address is used:</p>
1336 <li>For the local interface, the default is the lowest-numbered MAC
1337 address among the other bridge ports, either the value of the
1338 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1339 if set, or its actual MAC (for bonded ports, the MAC of its slave
1340 whose name is first in alphabetical order). Internal ports and
1341 bridge ports that are used as port mirroring destinations (see the
1342 <ref table="Mirror"/> table) are ignored.</li>
1343 <li>For other internal interfaces, the default MAC is randomly
1345 <li>External interfaces typically have a MAC address associated with
1346 their hardware.</li>
1348 <p>Some interfaces may not have a software-controllable MAC
1352 <column name="error">
1353 If the configuration of the port failed, as indicated by -1 in <ref
1354 column="ofport"/>, Open vSwitch sets this column to an error
1355 description in human readable form. Otherwise, Open vSwitch clears
1359 <group title="OpenFlow Port Number">
1361 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1362 port number for the new port. If the client that adds the port fills
1363 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1364 value as the OpenFlow port number. Otherwise, or if the requested
1365 port number is already in use or cannot be used for another reason,
1366 Open vSwitch automatically assigns a free port number. Regardless of
1367 how the port number was obtained, Open vSwitch then reports in <ref
1368 column="ofport"/> the port number actually assigned.
1372 Open vSwitch limits the port numbers that it automatically assigns to
1373 the range 1 through 32,767, inclusive. Controllers therefore have
1374 free use of ports 32,768 and up.
1377 <column name="ofport">
1379 OpenFlow port number for this interface. Open vSwitch sets this
1380 column's value, so other clients should treat it as read-only.
1383 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1384 The other valid port numbers are in the range 1 to 65,279,
1385 inclusive. Value -1 indicates an error adding the interface.
1389 <column name="ofport_request"
1390 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1392 Requested OpenFlow port number for this interface.
1396 A client should ideally set this column's value in the same
1397 database transaction that it uses to create the interface. Open
1398 vSwitch version 2.1 and later will honor a later request for a
1399 specific port number, althuogh it might confuse some controllers:
1400 OpenFlow does not have a way to announce a port number change, so
1401 Open vSwitch represents it over OpenFlow as a port deletion
1402 followed immediately by a port addition.
1406 If <ref column="ofport_request"/> is set or changed to some other
1407 port's automatically assigned port number, Open vSwitch chooses a
1408 new port number for the latter port.
1414 <group title="System-Specific Details">
1415 <column name="type">
1417 The interface type, one of:
1421 <dt><code>system</code></dt>
1422 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1423 Sometimes referred to as ``external interfaces'' since they are
1424 generally connected to hardware external to that on which the Open
1425 vSwitch is running. The empty string is a synonym for
1426 <code>system</code>.</dd>
1428 <dt><code>internal</code></dt>
1429 <dd>A simulated network device that sends and receives traffic. An
1430 internal interface whose <ref column="name"/> is the same as its
1431 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1432 ``local interface.'' It does not make sense to bond an internal
1433 interface, so the terms ``port'' and ``interface'' are often used
1434 imprecisely for internal interfaces.</dd>
1436 <dt><code>tap</code></dt>
1437 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1439 <dt><code>geneve</code></dt>
1441 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1444 Geneve supports options as a means to transport additional metadata,
1445 however, currently only the 24-bit VNI is supported. This is planned
1446 to be extended in the future.
1449 <dt><code>gre</code></dt>
1451 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1455 <dt><code>ipsec_gre</code></dt>
1457 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1461 <dt><code>gre64</code></dt>
1463 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1464 of key, it uses GRE protocol sequence number field. This is non
1465 standard use of GRE protocol since OVS does not increment
1466 sequence number for every packet at time of encap as expected by
1467 standard GRE implementation. See <ref group="Tunnel Options"/>
1468 for information on configuring GRE tunnels.
1471 <dt><code>ipsec_gre64</code></dt>
1473 Same as IPSEC_GRE except 64 bit key.
1476 <dt><code>vxlan</code></dt>
1479 An Ethernet tunnel over the experimental, UDP-based VXLAN
1480 protocol described at
1481 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1484 Open vSwitch uses UDP destination port 4789. The source port used for
1485 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1490 <dt><code>lisp</code></dt>
1493 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1494 Separation Protocol (RFC 6830).
1497 Only IPv4 and IPv6 packets are supported by the protocol, and
1498 they are sent and received without an Ethernet header. Traffic
1499 to/from LISP ports is expected to be configured explicitly, and
1500 the ports are not intended to participate in learning based
1501 switching. As such, they are always excluded from packet
1506 <dt><code>patch</code></dt>
1508 A pair of virtual devices that act as a patch cable.
1511 <dt><code>null</code></dt>
1512 <dd>An ignored interface. Deprecated and slated for removal in
1518 <group title="Tunnel Options">
1520 These options apply to interfaces with <ref column="type"/> of
1521 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1522 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1523 and <code>lisp</code>.
1527 Each tunnel must be uniquely identified by the combination of <ref
1528 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1529 column="options" key="local_ip"/>, and <ref column="options"
1530 key="in_key"/>. If two ports are defined that are the same except one
1531 has an optional identifier and the other does not, the more specific
1532 one is matched first. <ref column="options" key="in_key"/> is
1533 considered more specific than <ref column="options" key="local_ip"/> if
1534 a port defines one and another port defines the other.
1537 <column name="options" key="remote_ip">
1538 <p>Required. The remote tunnel endpoint, one of:</p>
1542 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1543 Only unicast endpoints are supported.
1546 The word <code>flow</code>. The tunnel accepts packets from any
1547 remote tunnel endpoint. To process only packets from a specific
1548 remote tunnel endpoint, the flow entries may match on the
1549 <code>tun_src</code> field. When sending packets to a
1550 <code>remote_ip=flow</code> tunnel, the flow actions must
1551 explicitly set the <code>tun_dst</code> field to the IP address of
1552 the desired remote tunnel endpoint, e.g. with a
1553 <code>set_field</code> action.
1558 The remote tunnel endpoint for any packet received from a tunnel
1559 is available in the <code>tun_src</code> field for matching in the
1564 <column name="options" key="local_ip">
1566 Optional. The tunnel destination IP that received packets must
1567 match. Default is to match all addresses. If specified, may be one
1573 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1576 The word <code>flow</code>. The tunnel accepts packets sent to any
1577 of the local IP addresses of the system running OVS. To process
1578 only packets sent to a specific IP address, the flow entries may
1579 match on the <code>tun_dst</code> field. When sending packets to a
1580 <code>local_ip=flow</code> tunnel, the flow actions may
1581 explicitly set the <code>tun_src</code> field to the desired IP
1582 address, e.g. with a <code>set_field</code> action. However, while
1583 routing the tunneled packet out, the local system may override the
1584 specified address with the local IP address configured for the
1585 outgoing system interface.
1588 This option is valid only for tunnels also configured with the
1589 <code>remote_ip=flow</code> option.
1595 The tunnel destination IP address for any packet received from a
1596 tunnel is available in the <code>tun_dst</code> field for matching in
1601 <column name="options" key="in_key">
1602 <p>Optional. The key that received packets must contain, one of:</p>
1606 <code>0</code>. The tunnel receives packets with no key or with a
1607 key of 0. This is equivalent to specifying no <ref column="options"
1608 key="in_key"/> at all.
1611 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
1612 or 64-bit (for GRE64) number. The tunnel receives only packets
1613 with the specified key.
1616 The word <code>flow</code>. The tunnel accepts packets with any
1617 key. The key will be placed in the <code>tun_id</code> field for
1618 matching in the flow table. The <code>ovs-ofctl</code> manual page
1619 contains additional information about matching fields in OpenFlow
1628 <column name="options" key="out_key">
1629 <p>Optional. The key to be set on outgoing packets, one of:</p>
1633 <code>0</code>. Packets sent through the tunnel will have no key.
1634 This is equivalent to specifying no <ref column="options"
1635 key="out_key"/> at all.
1638 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
1639 64-bit (for GRE64) number. Packets sent through the tunnel will
1640 have the specified key.
1643 The word <code>flow</code>. Packets sent through the tunnel will
1644 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1645 vendor extension (0 is used in the absence of an action). The
1646 <code>ovs-ofctl</code> manual page contains additional information
1647 about the Nicira OpenFlow vendor extensions.
1652 <column name="options" key="key">
1653 Optional. Shorthand to set <code>in_key</code> and
1654 <code>out_key</code> at the same time.
1657 <column name="options" key="tos">
1658 Optional. The value of the ToS bits to be set on the encapsulating
1659 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1660 zero. It may also be the word <code>inherit</code>, in which case
1661 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1662 (otherwise it will be 0). The ECN fields are always inherited.
1666 <column name="options" key="ttl">
1667 Optional. The TTL to be set on the encapsulating packet. It may also
1668 be the word <code>inherit</code>, in which case the TTL will be copied
1669 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1670 system default, typically 64). Default is the system default TTL.
1673 <column name="options" key="df_default"
1674 type='{"type": "boolean"}'>
1675 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1676 outer headers to allow path MTU discovery. Default is enabled; set
1677 to <code>false</code> to disable.
1680 <group title="Tunnel Options: gre and ipsec_gre only">
1682 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1686 <column name="options" key="csum" type='{"type": "boolean"}'>
1688 Optional. Compute GRE checksums on outgoing packets. Default is
1689 disabled, set to <code>true</code> to enable. Checksums present on
1690 incoming packets will be validated regardless of this setting.
1694 GRE checksums impose a significant performance penalty because they
1695 cover the entire packet. The encapsulated L3, L4, and L7 packet
1696 contents typically have their own checksums, so this additional
1697 checksum only adds value for the GRE and encapsulated L2 headers.
1701 This option is supported for <code>ipsec_gre</code>, but not useful
1702 because GRE checksums are weaker than, and redundant with, IPsec
1703 payload authentication.
1708 <group title="Tunnel Options: ipsec_gre only">
1710 Only <code>ipsec_gre</code> interfaces support these options.
1713 <column name="options" key="peer_cert">
1714 Required for certificate authentication. A string containing the
1715 peer's certificate in PEM format. Additionally the host's
1716 certificate must be specified with the <code>certificate</code>
1720 <column name="options" key="certificate">
1721 Required for certificate authentication. The name of a PEM file
1722 containing a certificate that will be presented to the peer during
1726 <column name="options" key="private_key">
1727 Optional for certificate authentication. The name of a PEM file
1728 containing the private key associated with <code>certificate</code>.
1729 If <code>certificate</code> contains the private key, this option may
1733 <column name="options" key="psk">
1734 Required for pre-shared key authentication. Specifies a pre-shared
1735 key for authentication that must be identical on both sides of the
1741 <group title="Patch Options">
1743 Only <code>patch</code> interfaces support these options.
1746 <column name="options" key="peer">
1747 The <ref column="name"/> of the <ref table="Interface"/> for the other
1748 side of the patch. The named <ref table="Interface"/>'s own
1749 <code>peer</code> option must specify this <ref table="Interface"/>'s
1750 name. That is, the two patch interfaces must have reversed <ref
1751 column="name"/> and <code>peer</code> values.
1755 <group title="Interface Status">
1757 Status information about interfaces attached to bridges, updated every
1758 5 seconds. Not all interfaces have all of these properties; virtual
1759 interfaces don't have a link speed, for example. Non-applicable
1760 columns will have empty values.
1762 <column name="admin_state">
1764 The administrative state of the physical network link.
1768 <column name="link_state">
1770 The observed state of the physical network link. This is ordinarily
1771 the link's carrier status. If the interface's <ref table="Port"/> is
1772 a bond configured for miimon monitoring, it is instead the network
1773 link's miimon status.
1777 <column name="link_resets">
1779 The number of times Open vSwitch has observed the
1780 <ref column="link_state"/> of this <ref table="Interface"/> change.
1784 <column name="link_speed">
1786 The negotiated speed of the physical network link.
1787 Valid values are positive integers greater than 0.
1791 <column name="duplex">
1793 The duplex mode of the physical network link.
1799 The MTU (maximum transmission unit); i.e. the largest
1800 amount of data that can fit into a single Ethernet frame.
1801 The standard Ethernet MTU is 1500 bytes. Some physical media
1802 and many kinds of virtual interfaces can be configured with
1806 This column will be empty for an interface that does not
1807 have an MTU as, for example, some kinds of tunnels do not.
1811 <column name="lacp_current">
1812 Boolean value indicating LACP status for this interface. If true, this
1813 interface has current LACP information about its LACP partner. This
1814 information may be used to monitor the health of interfaces in a LACP
1815 enabled port. This column will be empty if LACP is not enabled.
1818 <column name="status">
1819 Key-value pairs that report port status. Supported status values are
1820 <ref column="type"/>-dependent; some interfaces may not have a valid
1821 <ref column="status" key="driver_name"/>, for example.
1824 <column name="status" key="driver_name">
1825 The name of the device driver controlling the network adapter.
1828 <column name="status" key="driver_version">
1829 The version string of the device driver controlling the network
1833 <column name="status" key="firmware_version">
1834 The version string of the network adapter's firmware, if available.
1837 <column name="status" key="source_ip">
1838 The source IP address used for an IPv4 tunnel end-point, such as
1842 <column name="status" key="tunnel_egress_iface">
1843 Egress interface for tunnels. Currently only relevant for tunnels
1844 on Linux systems, this column will show the name of the interface
1845 which is responsible for routing traffic destined for the configured
1846 <ref column="options" key="remote_ip"/>. This could be an internal
1847 interface such as a bridge port.
1850 <column name="status" key="tunnel_egress_iface_carrier"
1851 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1852 Whether carrier is detected on <ref column="status"
1853 key="tunnel_egress_iface"/>.
1857 <group title="Statistics">
1859 Key-value pairs that report interface statistics. The current
1860 implementation updates these counters periodically. The update period
1861 is controlled by <ref column="other_config"
1862 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1863 Future implementations may update them when an interface is created,
1864 when they are queried (e.g. using an OVSDB <code>select</code>
1865 operation), and just before an interface is deleted due to virtual
1866 interface hot-unplug or VM shutdown, and perhaps at other times, but
1867 not on any regular periodic basis.
1870 These are the same statistics reported by OpenFlow in its <code>struct
1871 ofp_port_stats</code> structure. If an interface does not support a
1872 given statistic, then that pair is omitted.
1874 <group title="Statistics: Successful transmit and receive counters">
1875 <column name="statistics" key="rx_packets">
1876 Number of received packets.
1878 <column name="statistics" key="rx_bytes">
1879 Number of received bytes.
1881 <column name="statistics" key="tx_packets">
1882 Number of transmitted packets.
1884 <column name="statistics" key="tx_bytes">
1885 Number of transmitted bytes.
1888 <group title="Statistics: Receive errors">
1889 <column name="statistics" key="rx_dropped">
1890 Number of packets dropped by RX.
1892 <column name="statistics" key="rx_frame_err">
1893 Number of frame alignment errors.
1895 <column name="statistics" key="rx_over_err">
1896 Number of packets with RX overrun.
1898 <column name="statistics" key="rx_crc_err">
1899 Number of CRC errors.
1901 <column name="statistics" key="rx_errors">
1902 Total number of receive errors, greater than or equal to the sum of
1906 <group title="Statistics: Transmit errors">
1907 <column name="statistics" key="tx_dropped">
1908 Number of packets dropped by TX.
1910 <column name="statistics" key="collisions">
1911 Number of collisions.
1913 <column name="statistics" key="tx_errors">
1914 Total number of transmit errors, greater than or equal to the sum of
1920 <group title="Ingress Policing">
1922 These settings control ingress policing for packets received on this
1923 interface. On a physical interface, this limits the rate at which
1924 traffic is allowed into the system from the outside; on a virtual
1925 interface (one connected to a virtual machine), this limits the rate at
1926 which the VM is able to transmit.
1929 Policing is a simple form of quality-of-service that simply drops
1930 packets received in excess of the configured rate. Due to its
1931 simplicity, policing is usually less accurate and less effective than
1932 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1933 table="Queue"/> tables).
1936 Policing is currently implemented only on Linux. The Linux
1937 implementation uses a simple ``token bucket'' approach:
1941 The size of the bucket corresponds to <ref
1942 column="ingress_policing_burst"/>. Initially the bucket is full.
1945 Whenever a packet is received, its size (converted to tokens) is
1946 compared to the number of tokens currently in the bucket. If the
1947 required number of tokens are available, they are removed and the
1948 packet is forwarded. Otherwise, the packet is dropped.
1951 Whenever it is not full, the bucket is refilled with tokens at the
1952 rate specified by <ref column="ingress_policing_rate"/>.
1956 Policing interacts badly with some network protocols, and especially
1957 with fragmented IP packets. Suppose that there is enough network
1958 activity to keep the bucket nearly empty all the time. Then this token
1959 bucket algorithm will forward a single packet every so often, with the
1960 period depending on packet size and on the configured rate. All of the
1961 fragments of an IP packets are normally transmitted back-to-back, as a
1962 group. In such a situation, therefore, only one of these fragments
1963 will be forwarded and the rest will be dropped. IP does not provide
1964 any way for the intended recipient to ask for only the remaining
1965 fragments. In such a case there are two likely possibilities for what
1966 will happen next: either all of the fragments will eventually be
1967 retransmitted (as TCP will do), in which case the same problem will
1968 recur, or the sender will not realize that its packet has been dropped
1969 and data will simply be lost (as some UDP-based protocols will do).
1970 Either way, it is possible that no forward progress will ever occur.
1972 <column name="ingress_policing_rate">
1974 Maximum rate for data received on this interface, in kbps. Data
1975 received faster than this rate is dropped. Set to <code>0</code>
1976 (the default) to disable policing.
1980 <column name="ingress_policing_burst">
1981 <p>Maximum burst size for data received on this interface, in kb. The
1982 default burst size if set to <code>0</code> is 1000 kb. This value
1983 has no effect if <ref column="ingress_policing_rate"/>
1984 is <code>0</code>.</p>
1986 Specifying a larger burst size lets the algorithm be more forgiving,
1987 which is important for protocols like TCP that react severely to
1988 dropped packets. The burst size should be at least the size of the
1989 interface's MTU. Specifying a value that is numerically at least as
1990 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1991 closer to achieving the full rate.
1996 <group title="Bidirectional Forwarding Detection (BFD)">
1998 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
1999 detection of connectivity failures by occasional transmission of
2000 BFD control messages. Open vSwitch implements BFD to serve
2001 as a more popular and standards compliant alternative to CFM.
2005 BFD operates by regularly transmitting BFD control messages at a rate
2006 negotiated independently in each direction. Each endpoint specifies
2007 the rate at which it expects to receive control messages, and the rate
2008 at which it is willing to transmit them. Open vSwitch uses a detection
2009 multiplier of three, meaning that an endpoint signals a connectivity
2010 fault if three consecutive BFD control messages fail to arrive. In the
2011 case of a unidirectional connectivity issue, the system not receiving
2012 BFD control messages signals the problem to its peer in the messages it
2017 The Open vSwitch implementation of BFD aims to comply faithfully
2018 with RFC 5880 requirements. Open vSwitch does not implement the
2019 optional Authentication or ``Echo Mode'' features.
2022 <group title="BFD Configuration">
2024 A controller sets up key-value pairs in the <ref column="bfd"/>
2025 column to enable and configure BFD.
2028 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2029 True to enable BFD on this <ref table="Interface"/>. If not
2030 specified, BFD will not be enabled by default.
2033 <column name="bfd" key="min_rx"
2034 type='{"type": "integer", "minInteger": 1}'>
2035 The shortest interval, in milliseconds, at which this BFD session
2036 offers to receive BFD control messages. The remote endpoint may
2037 choose to send messages at a slower rate. Defaults to
2041 <column name="bfd" key="min_tx"
2042 type='{"type": "integer", "minInteger": 1}'>
2043 The shortest interval, in milliseconds, at which this BFD session is
2044 willing to transmit BFD control messages. Messages will actually be
2045 transmitted at a slower rate if the remote endpoint is not willing to
2046 receive as quickly as specified. Defaults to <code>100</code>.
2049 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2050 An alternate receive interval, in milliseconds, that must be greater
2051 than or equal to <ref column="bfd" key="min_rx"/>. The
2052 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2053 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2054 data traffic at the interface, to reduce the CPU and bandwidth cost
2055 of monitoring an idle interface. This feature may be disabled by
2056 setting a value of 0. This feature is reset whenever <ref
2057 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2061 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2062 When <code>true</code>, traffic received on the
2063 <ref table="Interface"/> is used to indicate the capability of packet
2064 I/O. BFD control packets are still transmitted and received. At
2065 least one BFD control packet must be received every 100 * <ref
2066 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2067 traffic are received, the <ref column="bfd" key="forwarding"/>
2068 will be <code>false</code>.
2071 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2072 Set to true to notify the remote endpoint that traffic should not be
2073 forwarded to this system for some reason other than a connectivty
2074 failure on the interface being monitored. The typical underlying
2075 reason is ``concatenated path down,'' that is, that connectivity
2076 beyond the local system is down. Defaults to false.
2079 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2080 Set to true to make BFD accept only control messages with a tunnel
2081 key of zero. By default, BFD accepts control messages with any
2085 <column name="bfd" key="bfd_local_src_mac">
2086 Set to an Ethernet address in the form
2087 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2088 to set the MAC used as source for transmitted BFD packets. The
2089 default is the mac address of the BFD enabled interface.
2092 <column name="bfd" key="bfd_local_dst_mac">
2093 Set to an Ethernet address in the form
2094 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2095 to set the MAC used as destination for transmitted BFD packets. The
2096 default is <code>00:23:20:00:00:01</code>.
2099 <column name="bfd" key="bfd_remote_dst_mac">
2100 Set to an Ethernet address in the form
2101 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2102 to set the MAC used for checking the destination of received BFD packets.
2103 Packets with different destination MAC will not be considered as BFD packets.
2104 If not specified the destination MAC address of received BFD packets
2108 <column name="bfd" key="bfd_src_ip">
2109 Set to an IPv4 address to set the IP address used as source for
2110 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2113 <column name="bfd" key="bfd_dst_ip">
2114 Set to an IPv4 address to set the IP address used as destination
2115 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2119 <group title="BFD Status">
2121 The switch sets key-value pairs in the <ref column="bfd_status"/>
2122 column to report the status of BFD on this interface. When BFD is
2123 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2124 all key-value pairs from <ref column="bfd_status"/>.
2127 <column name="bfd_status" key="state"
2128 type='{"type": "string",
2129 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2130 Reports the state of the BFD session. The BFD session is fully
2131 healthy and negotiated if <code>UP</code>.
2134 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2135 Reports whether the BFD session believes this <ref
2136 table="Interface"/> may be used to forward traffic. Typically this
2137 means the local session is signaling <code>UP</code>, and the remote
2138 system isn't signaling a problem such as concatenated path down.
2141 <column name="bfd_status" key="diagnostic">
2142 In case of a problem, set to an error message that reports what the
2143 local BFD session thinks is wrong. The error messages are defined
2144 in section 4.1 of [RFC 5880].
2147 <column name="bfd_status" key="remote_state"
2148 type='{"type": "string",
2149 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2150 Reports the state of the remote endpoint's BFD session.
2153 <column name="bfd_status" key="remote_diagnostic">
2154 In case of a problem, set to an error message that reports what the
2155 remote endpoint's BFD session thinks is wrong. The error messages
2156 are defined in section 4.1 of [RFC 5880].
2159 <column name="bfd_status" key="flap_count"
2160 type='{"type": "integer", "minInteger": 0}'>
2161 Counts the number of <ref column="bfd_status" key="forwarding" />
2162 flaps since start. A flap is considered as a change of the
2163 <ref column="bfd_status" key="forwarding" /> value.
2168 <group title="Connectivity Fault Management">
2170 802.1ag Connectivity Fault Management (CFM) allows a group of
2171 Maintenance Points (MPs) called a Maintenance Association (MA) to
2172 detect connectivity problems with each other. MPs within a MA should
2173 have complete and exclusive interconnectivity. This is verified by
2174 occasionally broadcasting Continuity Check Messages (CCMs) at a
2175 configurable transmission interval.
2179 According to the 802.1ag specification, each Maintenance Point should
2180 be configured out-of-band with a list of Remote Maintenance Points it
2181 should have connectivity to. Open vSwitch differs from the
2182 specification in this area. It simply assumes the link is faulted if
2183 no Remote Maintenance Points are reachable, and considers it not
2188 When operating over tunnels which have no <code>in_key</code>, or an
2189 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2190 with a tunnel key of zero.
2193 <column name="cfm_mpid">
2195 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2196 within a Maintenance Association. The MPID is used to identify this
2197 endpoint to other Maintenance Points in the MA. Each end of a link
2198 being monitored should have a different MPID. Must be configured to
2199 enable CFM on this <ref table="Interface"/>.
2202 According to the 802.1ag specification, MPIDs can only range between
2203 [1, 8191]. However, extended mode (see <ref column="other_config"
2204 key="cfm_extended"/>) supports eight byte MPIDs.
2208 <column name="cfm_flap_count">
2209 Counts the number of cfm fault flapps since boot. A flap is
2210 considered to be a change of the <ref column="cfm_fault"/> value.
2213 <column name="cfm_fault">
2215 Indicates a connectivity fault triggered by an inability to receive
2216 heartbeats from any remote endpoint. When a fault is triggered on
2217 <ref table="Interface"/>s participating in bonds, they will be
2221 Faults can be triggered for several reasons. Most importantly they
2222 are triggered when no CCMs are received for a period of 3.5 times the
2223 transmission interval. Faults are also triggered when any CCMs
2224 indicate that a Remote Maintenance Point is not receiving CCMs but
2225 able to send them. Finally, a fault is triggered if a CCM is
2226 received which indicates unexpected configuration. Notably, this
2227 case arises when a CCM is received which advertises the local MPID.
2231 <column name="cfm_fault_status" key="recv">
2232 Indicates a CFM fault was triggered due to a lack of CCMs received on
2233 the <ref table="Interface"/>.
2236 <column name="cfm_fault_status" key="rdi">
2237 Indicates a CFM fault was triggered due to the reception of a CCM with
2238 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2239 are not receiving CCMs themselves. This typically indicates a
2240 unidirectional connectivity failure.
2243 <column name="cfm_fault_status" key="maid">
2244 Indicates a CFM fault was triggered due to the reception of a CCM with
2245 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2246 with an identification number in addition to the MPID called the MAID.
2247 Open vSwitch only supports receiving CCM broadcasts tagged with the
2248 MAID it uses internally.
2251 <column name="cfm_fault_status" key="loopback">
2252 Indicates a CFM fault was triggered due to the reception of a CCM
2253 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2254 column of this <ref table="Interface"/>. This may indicate a loop in
2258 <column name="cfm_fault_status" key="overflow">
2259 Indicates a CFM fault was triggered because the CFM module received
2260 CCMs from more remote endpoints than it can keep track of.
2263 <column name="cfm_fault_status" key="override">
2264 Indicates a CFM fault was manually triggered by an administrator using
2265 an <code>ovs-appctl</code> command.
2268 <column name="cfm_fault_status" key="interval">
2269 Indicates a CFM fault was triggered due to the reception of a CCM
2270 frame having an invalid interval.
2273 <column name="cfm_remote_opstate">
2274 <p>When in extended mode, indicates the operational state of the
2275 remote endpoint as either <code>up</code> or <code>down</code>. See
2276 <ref column="other_config" key="cfm_opstate"/>.
2280 <column name="cfm_health">
2282 Indicates the health of the interface as a percentage of CCM frames
2283 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2284 The health of an interface is undefined if it is communicating with
2285 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2286 healthy heartbeats are not received at the expected rate, and
2287 gradually improves as healthy heartbeats are received at the desired
2288 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2289 health of the interface is refreshed.
2292 As mentioned above, the faults can be triggered for several reasons.
2293 The link health will deteriorate even if heartbeats are received but
2294 they are reported to be unhealthy. An unhealthy heartbeat in this
2295 context is a heartbeat for which either some fault is set or is out
2296 of sequence. The interface health can be 100 only on receiving
2297 healthy heartbeats at the desired rate.
2301 <column name="cfm_remote_mpids">
2302 When CFM is properly configured, Open vSwitch will occasionally
2303 receive CCM broadcasts. These broadcasts contain the MPID of the
2304 sending Maintenance Point. The list of MPIDs from which this
2305 <ref table="Interface"/> is receiving broadcasts from is regularly
2306 collected and written to this column.
2309 <column name="other_config" key="cfm_interval"
2310 type='{"type": "integer"}'>
2312 The interval, in milliseconds, between transmissions of CFM
2313 heartbeats. Three missed heartbeat receptions indicate a
2318 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2319 60,000, or 600,000 ms are supported. Other values will be rounded
2320 down to the nearest value on the list. Extended mode (see <ref
2321 column="other_config" key="cfm_extended"/>) supports any interval up
2322 to 65,535 ms. In either mode, the default is 1000 ms.
2325 <p>We do not recommend using intervals less than 100 ms.</p>
2328 <column name="other_config" key="cfm_extended"
2329 type='{"type": "boolean"}'>
2330 When <code>true</code>, the CFM module operates in extended mode. This
2331 causes it to use a nonstandard destination address to avoid conflicting
2332 with compliant implementations which may be running concurrently on the
2333 network. Furthermore, extended mode increases the accuracy of the
2334 <code>cfm_interval</code> configuration parameter by breaking wire
2335 compatibility with 802.1ag compliant implementations. And extended
2336 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2339 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2341 When <code>true</code>, and
2342 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2343 module operates in demand mode. When in demand mode, traffic
2344 received on the <ref table="Interface"/> is used to indicate
2345 liveness. CCMs are still transmitted and received. At least one
2346 CCM must be received every 100 * <ref column="other_config"
2347 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2348 are received, the CFM module will raise the connectivity fault.
2352 Demand mode has a couple of caveats:
2355 To ensure that ovs-vswitchd has enough time to pull statistics
2356 from the datapath, the fault detection interval is set to
2357 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2362 To avoid ambiguity, demand mode disables itself when there are
2363 multiple remote maintenance points.
2367 If the <ref table="Interface"/> is heavily congested, CCMs
2368 containing the <ref column="other_config" key="cfm_opstate"/>
2369 status may be dropped causing changes in the operational state to
2370 be delayed. Similarly, if CCMs containing the RDI bit are not
2371 received, unidirectional link failures may not be detected.
2377 <column name="other_config" key="cfm_opstate"
2378 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2379 When <code>down</code>, the CFM module marks all CCMs it generates as
2380 operationally down without triggering a fault. This allows remote
2381 maintenance points to choose not to forward traffic to the
2382 <ref table="Interface"/> on which this CFM module is running.
2383 Currently, in Open vSwitch, the opdown bit of CCMs affects
2384 <ref table="Interface"/>s participating in bonds, and the bundle
2385 OpenFlow action. This setting is ignored when CFM is not in extended
2386 mode. Defaults to <code>up</code>.
2389 <column name="other_config" key="cfm_ccm_vlan"
2390 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2391 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2392 with the given value. May be the string <code>random</code> in which
2393 case each CCM will be tagged with a different randomly generated VLAN.
2396 <column name="other_config" key="cfm_ccm_pcp"
2397 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2398 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2399 with the given PCP value, the VLAN ID of the tag is governed by the
2400 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2401 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2407 <group title="Bonding Configuration">
2408 <column name="other_config" key="lacp-port-id"
2409 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2410 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2411 used in LACP negotiations to identify individual ports
2412 participating in a bond.
2415 <column name="other_config" key="lacp-port-priority"
2416 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2417 The LACP port priority of this <ref table="Interface"/>. In LACP
2418 negotiations <ref table="Interface"/>s with numerically lower
2419 priorities are preferred for aggregation.
2422 <column name="other_config" key="lacp-aggregation-key"
2423 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2424 The LACP aggregation key of this <ref table="Interface"/>. <ref
2425 table="Interface"/>s with different aggregation keys may not be active
2426 within a given <ref table="Port"/> at the same time.
2430 <group title="Virtual Machine Identifiers">
2432 These key-value pairs specifically apply to an interface that
2433 represents a virtual Ethernet interface connected to a virtual
2434 machine. These key-value pairs should not be present for other types
2435 of interfaces. Keys whose names end in <code>-uuid</code> have
2436 values that uniquely identify the entity in question. For a Citrix
2437 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2438 Other hypervisors may use other formats.
2441 <column name="external_ids" key="attached-mac">
2442 The MAC address programmed into the ``virtual hardware'' for this
2443 interface, in the form
2444 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2445 For Citrix XenServer, this is the value of the <code>MAC</code> field
2446 in the VIF record for this interface.
2449 <column name="external_ids" key="iface-id">
2450 A system-unique identifier for the interface. On XenServer, this will
2451 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2454 <column name="external_ids" key="iface-status"
2455 type='{"type": "string",
2456 "enum": ["set", ["active", "inactive"]]}'>
2458 Hypervisors may sometimes have more than one interface associated
2459 with a given <ref column="external_ids" key="iface-id"/>, only one of
2460 which is actually in use at a given time. For example, in some
2461 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2462 for a single <ref column="external_ids" key="iface-id"/>, but only
2463 uses one of them at a time. A hypervisor that behaves this way must
2464 mark the currently in use interface <code>active</code> and the
2465 others <code>inactive</code>. A hypervisor that never has more than
2466 one interface for a given <ref column="external_ids" key="iface-id"/>
2467 may mark that interface <code>active</code> or omit <ref
2468 column="external_ids" key="iface-status"/> entirely.
2472 During VM migration, a given <ref column="external_ids"
2473 key="iface-id"/> might transiently be marked <code>active</code> on
2474 two different hypervisors. That is, <code>active</code> means that
2475 this <ref column="external_ids" key="iface-id"/> is the active
2476 instance within a single hypervisor, not in a broader scope.
2477 There is one exception: some hypervisors support ``migration'' from a
2478 given hypervisor to itself (most often for test purposes). During
2479 such a ``migration,'' two instances of a single <ref
2480 column="external_ids" key="iface-id"/> might both be briefly marked
2481 <code>active</code> on a single hypervisor.
2485 <column name="external_ids" key="xs-vif-uuid">
2486 The virtual interface associated with this interface.
2489 <column name="external_ids" key="xs-network-uuid">
2490 The virtual network to which this interface is attached.
2493 <column name="external_ids" key="vm-id">
2494 The VM to which this interface belongs. On XenServer, this will be the
2495 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2498 <column name="external_ids" key="xs-vm-uuid">
2499 The VM to which this interface belongs.
2503 <group title="VLAN Splinters">
2505 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2506 with buggy network drivers in old versions of Linux that do not
2507 properly support VLANs when VLAN devices are not used, at some cost
2508 in memory and performance.
2512 When VLAN splinters are enabled on a particular interface, Open vSwitch
2513 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2514 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2515 received on the VLAN device is treated as if it had been received on
2516 the interface on the particular VLAN.
2520 VLAN splinters consider a VLAN to be in use if:
2525 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2526 table="Port"/> record.
2530 The VLAN is listed within the <ref table="Port" column="trunks"/>
2531 column of the <ref table="Port"/> record of an interface on which
2532 VLAN splinters are enabled.
2534 An empty <ref table="Port" column="trunks"/> does not influence the
2535 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2536 will exceed the current 1,024 port per datapath limit.
2540 An OpenFlow flow within any bridge matches the VLAN.
2545 The same set of in-use VLANs applies to every interface on which VLAN
2546 splinters are enabled. That is, the set is not chosen separately for
2547 each interface but selected once as the union of all in-use VLANs based
2552 It does not make sense to enable VLAN splinters on an interface for an
2553 access port, or on an interface that is not a physical port.
2557 VLAN splinters are deprecated. When broken device drivers are no
2558 longer in widespread use, we will delete this feature.
2561 <column name="other_config" key="enable-vlan-splinters"
2562 type='{"type": "boolean"}'>
2564 Set to <code>true</code> to enable VLAN splinters on this interface.
2565 Defaults to <code>false</code>.
2569 VLAN splinters increase kernel and userspace memory overhead, so do
2570 not use them unless they are needed.
2574 VLAN splinters do not support 802.1p priority tags. Received
2575 priorities will appear to be 0, regardless of their actual values,
2576 and priorities on transmitted packets will also be cleared to 0.
2581 <group title="Common Columns">
2582 The overall purpose of these columns is described under <code>Common
2583 Columns</code> at the beginning of this document.
2585 <column name="other_config"/>
2586 <column name="external_ids"/>
2590 <table name="Flow_Table" title="OpenFlow table configuration">
2591 <p>Configuration for a particular OpenFlow table.</p>
2593 <column name="name">
2594 The table's name. Set this column to change the name that controllers
2595 will receive when they request table statistics, e.g. <code>ovs-ofctl
2596 dump-tables</code>. The name does not affect switch behavior.
2599 <column name="flow_limit">
2600 If set, limits the number of flows that may be added to the table. Open
2601 vSwitch may limit the number of flows in a table for other reasons,
2602 e.g. due to hardware limitations or for resource availability or
2603 performance reasons.
2606 <column name="overflow_policy">
2608 Controls the switch's behavior when an OpenFlow flow table modification
2609 request would add flows in excess of <ref column="flow_limit"/>. The
2610 supported values are:
2614 <dt><code>refuse</code></dt>
2616 Refuse to add the flow or flows. This is also the default policy
2617 when <ref column="overflow_policy"/> is unset.
2620 <dt><code>evict</code></dt>
2622 Delete the flow that will expire soonest. See <ref column="groups"/>
2628 <column name="groups">
2630 When <ref column="overflow_policy"/> is <code>evict</code>, this
2631 controls how flows are chosen for eviction when the flow table would
2632 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2633 of NXM fields or sub-fields, each of which takes one of the forms
2634 <code><var>field</var>[]</code> or
2635 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2636 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2637 <code>nicira-ext.h</code> for a complete list of NXM field names.
2641 When a flow must be evicted due to overflow, the flow to evict is
2642 chosen through an approximation of the following algorithm:
2647 Divide the flows in the table into groups based on the values of the
2648 specified fields or subfields, so that all of the flows in a given
2649 group have the same values for those fields. If a flow does not
2650 specify a given field, that field's value is treated as 0.
2654 Consider the flows in the largest group, that is, the group that
2655 contains the greatest number of flows. If two or more groups all
2656 have the same largest number of flows, consider the flows in all of
2661 Among the flows under consideration, choose the flow that expires
2662 soonest for eviction.
2667 The eviction process only considers flows that have an idle timeout or
2668 a hard timeout. That is, eviction never deletes permanent flows.
2669 (Permanent flows do count against <ref column="flow_limit"/>.)
2673 Open vSwitch ignores any invalid or unknown field specifications.
2677 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2678 column has no effect.
2682 <column name="prefixes">
2684 This string set specifies which fields should be used for
2685 address prefix tracking. Prefix tracking allows the
2686 classifier to skip rules with longer than necessary prefixes,
2687 resulting in better wildcarding for datapath flows.
2690 Prefix tracking may be beneficial when a flow table contains
2691 matches on IP address fields with different prefix lengths.
2692 For example, when a flow table contains IP address matches on
2693 both full addresses and proper prefixes, the full address
2694 matches will typically cause the datapath flow to un-wildcard
2695 the whole address field (depending on flow entry priorities).
2696 In this case each packet with a different address gets handed
2697 to the userspace for flow processing and generates its own
2698 datapath flow. With prefix tracking enabled for the address
2699 field in question packets with addresses matching shorter
2700 prefixes would generate datapath flows where the irrelevant
2701 address bits are wildcarded, allowing the same datapath flow
2702 to handle all the packets within the prefix in question. In
2703 this case many userspace upcalls can be avoided and the
2704 overall performance can be better.
2707 This is a performance optimization only, so packets will
2708 receive the same treatment with or without prefix tracking.
2711 The supported fields are: <code>tun_id</code>,
2712 <code>tun_src</code>, <code>tun_dst</code>,
2713 <code>nw_src</code>, <code>nw_dst</code> (or aliases
2714 <code>ip_src</code> and <code>ip_dst</code>),
2715 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
2716 feature for <code>tun_id</code> would only make sense if the
2717 tunnel IDs have prefix structure similar to IP addresses.)
2721 By default, the <code>prefixes=ip_dst,ip_src</code> are used
2722 on each flow table. This instructs the flow classifier to
2723 track the IP destination and source addresses used by the
2724 rules in this specific flow table.
2728 The keyword <code>none</code> is recognized as an explicit
2729 override of the default values, causing no prefix fields to be
2734 To set the prefix fields, the flow table record needs to
2739 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
2741 Creates a flow table record for the OpenFlow table number 0.
2744 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
2746 Enables prefix tracking for IP source and destination
2752 There is a maximum number of fields that can be enabled for any
2753 one flow table. Currently this limit is 3.
2757 <group title="Common Columns">
2758 The overall purpose of these columns is described under <code>Common
2759 Columns</code> at the beginning of this document.
2761 <column name="external_ids"/>
2765 <table name="QoS" title="Quality of Service configuration">
2766 <p>Quality of Service (QoS) configuration for each Port that
2769 <column name="type">
2770 <p>The type of QoS to implement. The currently defined types are
2773 <dt><code>linux-htb</code></dt>
2775 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2776 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2777 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2778 for information on how this classifier works and how to configure it.
2782 <dt><code>linux-hfsc</code></dt>
2784 Linux "Hierarchical Fair Service Curve" classifier.
2785 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2786 information on how this classifier works.
2791 <column name="queues">
2792 <p>A map from queue numbers to <ref table="Queue"/> records. The
2793 supported range of queue numbers depend on <ref column="type"/>. The
2794 queue numbers are the same as the <code>queue_id</code> used in
2795 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2799 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2800 actions when no specific queue has been set. When no configuration for
2801 queue 0 is present, it is automatically configured as if a <ref
2802 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2803 and <ref table="Queue" column="other_config"/> columns had been
2805 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2806 this case. With some queuing disciplines, this dropped all packets
2807 destined for the default queue.)
2811 <group title="Configuration for linux-htb and linux-hfsc">
2813 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2814 the following key-value pair:
2817 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2818 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2819 specified, for physical interfaces, the default is the link rate. For
2820 other interfaces or if the link rate cannot be determined, the default
2821 is currently 100 Mbps.
2825 <group title="Common Columns">
2826 The overall purpose of these columns is described under <code>Common
2827 Columns</code> at the beginning of this document.
2829 <column name="other_config"/>
2830 <column name="external_ids"/>
2834 <table name="Queue" title="QoS output queue.">
2835 <p>A configuration for a port output queue, used in configuring Quality of
2836 Service (QoS) features. May be referenced by <ref column="queues"
2837 table="QoS"/> column in <ref table="QoS"/> table.</p>
2839 <column name="dscp">
2840 If set, Open vSwitch will mark all traffic egressing this
2841 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2842 default <ref table="Queue"/> is only marked if it was explicitly selected
2843 as the <ref table="Queue"/> at the time the packet was output. If unset,
2844 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2848 <group title="Configuration for linux-htb QoS">
2850 <ref table="QoS"/> <ref table="QoS" column="type"/>
2851 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2852 It has the following key-value pairs defined.
2855 <column name="other_config" key="min-rate"
2856 type='{"type": "integer", "minInteger": 1}'>
2857 Minimum guaranteed bandwidth, in bit/s.
2860 <column name="other_config" key="max-rate"
2861 type='{"type": "integer", "minInteger": 1}'>
2862 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2863 queue's rate will not be allowed to exceed the specified value, even
2864 if excess bandwidth is available. If unspecified, defaults to no
2868 <column name="other_config" key="burst"
2869 type='{"type": "integer", "minInteger": 1}'>
2870 Burst size, in bits. This is the maximum amount of ``credits'' that a
2871 queue can accumulate while it is idle. Optional. Details of the
2872 <code>linux-htb</code> implementation require a minimum burst size, so
2873 a too-small <code>burst</code> will be silently ignored.
2876 <column name="other_config" key="priority"
2877 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2878 A queue with a smaller <code>priority</code> will receive all the
2879 excess bandwidth that it can use before a queue with a larger value
2880 receives any. Specific priority values are unimportant; only relative
2881 ordering matters. Defaults to 0 if unspecified.
2885 <group title="Configuration for linux-hfsc QoS">
2887 <ref table="QoS"/> <ref table="QoS" column="type"/>
2888 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2889 It has the following key-value pairs defined.
2892 <column name="other_config" key="min-rate"
2893 type='{"type": "integer", "minInteger": 1}'>
2894 Minimum guaranteed bandwidth, in bit/s.
2897 <column name="other_config" key="max-rate"
2898 type='{"type": "integer", "minInteger": 1}'>
2899 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2900 queue's rate will not be allowed to exceed the specified value, even if
2901 excess bandwidth is available. If unspecified, defaults to no
2906 <group title="Common Columns">
2907 The overall purpose of these columns is described under <code>Common
2908 Columns</code> at the beginning of this document.
2910 <column name="other_config"/>
2911 <column name="external_ids"/>
2915 <table name="Mirror" title="Port mirroring.">
2916 <p>A port mirror within a <ref table="Bridge"/>.</p>
2917 <p>A port mirror configures a bridge to send selected frames to special
2918 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2919 traffic may also be referred to as SPAN or RSPAN, depending on how
2920 the mirrored traffic is sent.</p>
2922 <column name="name">
2923 Arbitrary identifier for the <ref table="Mirror"/>.
2926 <group title="Selecting Packets for Mirroring">
2928 To be selected for mirroring, a given packet must enter or leave the
2929 bridge through a selected port and it must also be in one of the
2933 <column name="select_all">
2934 If true, every packet arriving or departing on any port is
2935 selected for mirroring.
2938 <column name="select_dst_port">
2939 Ports on which departing packets are selected for mirroring.
2942 <column name="select_src_port">
2943 Ports on which arriving packets are selected for mirroring.
2946 <column name="select_vlan">
2947 VLANs on which packets are selected for mirroring. An empty set
2948 selects packets on all VLANs.
2952 <group title="Mirroring Destination Configuration">
2954 These columns are mutually exclusive. Exactly one of them must be
2958 <column name="output_port">
2959 <p>Output port for selected packets, if nonempty.</p>
2960 <p>Specifying a port for mirror output reserves that port exclusively
2961 for mirroring. No frames other than those selected for mirroring
2963 will be forwarded to the port, and any frames received on the port
2964 will be discarded.</p>
2966 The output port may be any kind of port supported by Open vSwitch.
2967 It may be, for example, a physical port (sometimes called SPAN) or a
2972 <column name="output_vlan">
2973 <p>Output VLAN for selected packets, if nonempty.</p>
2974 <p>The frames will be sent out all ports that trunk
2975 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2976 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2977 trunk port, the frame's VLAN tag will be set to
2978 <ref column="output_vlan"/>, replacing any existing tag; when it is
2979 sent out an implicit VLAN port, the frame will not be tagged. This
2980 type of mirroring is sometimes called RSPAN.</p>
2982 See the documentation for
2983 <ref column="other_config" key="forward-bpdu"/> in the
2984 <ref table="Interface"/> table for a list of destination MAC
2985 addresses which will not be mirrored to a VLAN to avoid confusing
2986 switches that interpret the protocols that they represent.
2988 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2989 contains unmanaged switches. Consider an unmanaged physical switch
2990 with two ports: port 1, connected to an end host, and port 2,
2991 connected to an Open vSwitch configured to mirror received packets
2992 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2993 port 1 that the physical switch forwards to port 2. The Open vSwitch
2994 forwards this packet to its destination and then reflects it back on
2995 port 2 in VLAN 123. This reflected packet causes the unmanaged
2996 physical switch to replace the MAC learning table entry, which
2997 correctly pointed to port 1, with one that incorrectly points to port
2998 2. Afterward, the physical switch will direct packets destined for
2999 the end host to the Open vSwitch on port 2, instead of to the end
3000 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3001 desired in this scenario, then the physical switch must be replaced
3002 by one that learns Ethernet addresses on a per-VLAN basis. In
3003 addition, learning should be disabled on the VLAN containing mirrored
3004 traffic. If this is not done then intermediate switches will learn
3005 the MAC address of each end host from the mirrored traffic. If
3006 packets being sent to that end host are also mirrored, then they will
3007 be dropped since the switch will attempt to send them out the input
3008 port. Disabling learning for the VLAN will cause the switch to
3009 correctly send the packet out all ports configured for that VLAN. If
3010 Open vSwitch is being used as an intermediate switch, learning can be
3011 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3012 in the appropriate <ref table="Bridge"/> table or tables.</p>
3014 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3015 VLAN and should generally be preferred.
3020 <group title="Statistics: Mirror counters">
3022 Key-value pairs that report mirror statistics. The update period
3023 is controlled by <ref column="other_config"
3024 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3026 <column name="statistics" key="tx_packets">
3027 Number of packets transmitted through this mirror.
3029 <column name="statistics" key="tx_bytes">
3030 Number of bytes transmitted through this mirror.
3034 <group title="Common Columns">
3035 The overall purpose of these columns is described under <code>Common
3036 Columns</code> at the beginning of this document.
3038 <column name="external_ids"/>
3042 <table name="Controller" title="OpenFlow controller configuration.">
3043 <p>An OpenFlow controller.</p>
3046 Open vSwitch supports two kinds of OpenFlow controllers:
3050 <dt>Primary controllers</dt>
3053 This is the kind of controller envisioned by the OpenFlow 1.0
3054 specification. Usually, a primary controller implements a network
3055 policy by taking charge of the switch's flow table.
3059 Open vSwitch initiates and maintains persistent connections to
3060 primary controllers, retrying the connection each time it fails or
3061 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3062 <ref table="Bridge"/> table applies to primary controllers.
3066 Open vSwitch permits a bridge to have any number of primary
3067 controllers. When multiple controllers are configured, Open
3068 vSwitch connects to all of them simultaneously. Because
3069 OpenFlow 1.0 does not specify how multiple controllers
3070 coordinate in interacting with a single switch, more than
3071 one primary controller should be specified only if the
3072 controllers are themselves designed to coordinate with each
3073 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3074 vendor extension may be useful for this.)
3077 <dt>Service controllers</dt>
3080 These kinds of OpenFlow controller connections are intended for
3081 occasional support and maintenance use, e.g. with
3082 <code>ovs-ofctl</code>. Usually a service controller connects only
3083 briefly to inspect or modify some of a switch's state.
3087 Open vSwitch listens for incoming connections from service
3088 controllers. The service controllers initiate and, if necessary,
3089 maintain the connections from their end. The <ref table="Bridge"
3090 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3091 not apply to service controllers.
3095 Open vSwitch supports configuring any number of service controllers.
3101 The <ref column="target"/> determines the type of controller.
3104 <group title="Core Features">
3105 <column name="target">
3106 <p>Connection method for controller.</p>
3108 The following connection methods are currently supported for primary
3112 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3114 <p>The specified SSL <var>port</var> on the host at the
3115 given <var>ip</var>, which must be expressed as an IP
3116 address (not a DNS name). The <ref table="Open_vSwitch"
3117 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3118 table must point to a valid SSL configuration when this form
3120 <p>If <var>port</var> is not specified, it currently
3121 defaults to 6633. In the future, the default will change to
3122 6653, which is the IANA-defined value.</p>
3123 <p>SSL support is an optional feature that is not always built as
3124 part of Open vSwitch.</p>
3126 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3129 The specified TCP <var>port</var> on the host at the given
3130 <var>ip</var>, which must be expressed as an IP address (not a
3131 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3132 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3133 e.g. <code>tcp:[::1]:6632</code>.
3136 If <var>port</var> is not specified, it currently defaults to
3137 6633. In the future, the default will change to 6653, which is
3138 the IANA-defined value.
3143 The following connection methods are currently supported for service
3147 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3150 Listens for SSL connections on the specified TCP <var>port</var>.
3151 If <var>ip</var>, which must be expressed as an IP address (not a
3152 DNS name), is specified, then connections are restricted to the
3153 specified local IP address (either IPv4 or IPv6). If
3154 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3155 e.g. <code>pssl:6632:[::1]</code>.
3158 If <var>port</var> is not specified, it currently defaults to
3159 6633. If <var>ip</var> is not specified then it listens only on
3160 IPv4 (but not IPv6) addresses. The
3161 <ref table="Open_vSwitch" column="ssl"/>
3162 column in the <ref table="Open_vSwitch"/> table must point to a
3163 valid SSL configuration when this form is used.
3166 If <var>port</var> is not specified, it currently defaults to
3167 6633. In the future, the default will change to 6653, which is
3168 the IANA-defined value.
3171 SSL support is an optional feature that is not always built as
3172 part of Open vSwitch.
3175 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3178 Listens for connections on the specified TCP <var>port</var>. If
3179 <var>ip</var>, which must be expressed as an IP address (not a
3180 DNS name), is specified, then connections are restricted to the
3181 specified local IP address (either IPv4 or IPv6). If
3182 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3183 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3184 specified then it listens only on IPv4 addresses.
3187 If <var>port</var> is not specified, it currently defaults to
3188 6633. In the future, the default will change to 6653, which is
3189 the IANA-defined value.
3193 <p>When multiple controllers are configured for a single bridge, the
3194 <ref column="target"/> values must be unique. Duplicate
3195 <ref column="target"/> values yield unspecified results.</p>
3198 <column name="connection_mode">
3199 <p>If it is specified, this setting must be one of the following
3200 strings that describes how Open vSwitch contacts this OpenFlow
3201 controller over the network:</p>
3204 <dt><code>in-band</code></dt>
3205 <dd>In this mode, this controller's OpenFlow traffic travels over the
3206 bridge associated with the controller. With this setting, Open
3207 vSwitch allows traffic to and from the controller regardless of the
3208 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3209 would never be able to connect to the controller, because it did
3210 not have a flow to enable it.) This is the most common connection
3211 mode because it is not necessary to maintain two independent
3213 <dt><code>out-of-band</code></dt>
3214 <dd>In this mode, OpenFlow traffic uses a control network separate
3215 from the bridge associated with this controller, that is, the
3216 bridge does not use any of its own network devices to communicate
3217 with the controller. The control network must be configured
3218 separately, before or after <code>ovs-vswitchd</code> is started.
3222 <p>If not specified, the default is implementation-specific.</p>
3226 <group title="Controller Failure Detection and Handling">
3227 <column name="max_backoff">
3228 Maximum number of milliseconds to wait between connection attempts.
3229 Default is implementation-specific.
3232 <column name="inactivity_probe">
3233 Maximum number of milliseconds of idle time on connection to
3234 controller before sending an inactivity probe message. If Open
3235 vSwitch does not communicate with the controller for the specified
3236 number of seconds, it will send a probe. If a response is not
3237 received for the same additional amount of time, Open vSwitch
3238 assumes the connection has been broken and attempts to reconnect.
3239 Default is implementation-specific. A value of 0 disables
3244 <group title="Asynchronous Messages">
3246 OpenFlow switches send certain messages to controllers spontanenously,
3247 that is, not in response to any request from the controller. These
3248 messages are called ``asynchronous messages.'' These columns allow
3249 asynchronous messages to be limited or disabled to ensure the best use
3250 of network resources.
3253 <column name="enable_async_messages">
3254 The OpenFlow protocol enables asynchronous messages at time of
3255 connection establishment, which means that a controller can receive
3256 asynchronous messages, potentially many of them, even if it turns them
3257 off immediately after connecting. Set this column to
3258 <code>false</code> to change Open vSwitch behavior to disable, by
3259 default, all asynchronous messages. The controller can use the
3260 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3261 on any messages that it does want to receive, if any.
3264 <group title="Controller Rate Limiting">
3266 A switch can forward packets to a controller over the OpenFlow
3267 protocol. Forwarding packets this way at too high a rate can
3268 overwhelm a controller, frustrate use of the OpenFlow connection for
3269 other purposes, increase the latency of flow setup, and use an
3270 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3271 limiting the rate of packet forwarding to a controller.
3275 There are two main reasons in OpenFlow for a packet to be sent to a
3276 controller: either the packet ``misses'' in the flow table, that is,
3277 there is no matching flow, or a flow table action says to send the
3278 packet to the controller. Open vSwitch limits the rate of each kind
3279 of packet separately at the configured rate. Therefore, the actual
3280 rate that packets are sent to the controller can be up to twice the
3281 configured rate, when packets are sent for both reasons.
3285 This feature is specific to forwarding packets over an OpenFlow
3286 connection. It is not general-purpose QoS. See the <ref
3287 table="QoS"/> table for quality of service configuration, and <ref
3288 column="ingress_policing_rate" table="Interface"/> in the <ref
3289 table="Interface"/> table for ingress policing configuration.
3292 <column name="controller_rate_limit">
3294 The maximum rate at which the switch will forward packets to the
3295 OpenFlow controller, in packets per second. If no value is
3296 specified, rate limiting is disabled.
3300 <column name="controller_burst_limit">
3302 When a high rate triggers rate-limiting, Open vSwitch queues
3303 packets to the controller for each port and transmits them to the
3304 controller at the configured rate. This value limits the number of
3305 queued packets. Ports on a bridge share the packet queue fairly.
3309 This value has no effect unless <ref
3310 column="controller_rate_limit"/> is configured. The current
3311 default when this value is not specified is one-quarter of <ref
3312 column="controller_rate_limit"/>, meaning that queuing can delay
3313 forwarding a packet to the controller by up to 250 ms.
3317 <group title="Controller Rate Limiting Statistics">
3319 These values report the effects of rate limiting. Their values are
3320 relative to establishment of the most recent OpenFlow connection,
3321 or since rate limiting was enabled, whichever happened more
3322 recently. Each consists of two values, one with <code>TYPE</code>
3323 replaced by <code>miss</code> for rate limiting flow table misses,
3324 and the other with <code>TYPE</code> replaced by
3325 <code>action</code> for rate limiting packets sent by OpenFlow
3330 These statistics are reported only when controller rate limiting is
3334 <column name="status" key="packet-in-TYPE-bypassed"
3335 type='{"type": "integer", "minInteger": 0}'>
3336 Number of packets sent directly to the controller, without queuing,
3337 because the rate did not exceed the configured maximum.
3340 <column name="status" key="packet-in-TYPE-queued"
3341 type='{"type": "integer", "minInteger": 0}'>
3342 Number of packets added to the queue to send later.
3345 <column name="status" key="packet-in-TYPE-dropped"
3346 type='{"type": "integer", "minInteger": 0}'>
3347 Number of packets added to the queue that were later dropped due to
3348 overflow. This value is less than or equal to <ref column="status"
3349 key="packet-in-TYPE-queued"/>.
3352 <column name="status" key="packet-in-TYPE-backlog"
3353 type='{"type": "integer", "minInteger": 0}'>
3354 Number of packets currently queued. The other statistics increase
3355 monotonically, but this one fluctuates between 0 and the <ref
3356 column="controller_burst_limit"/> as conditions change.
3362 <group title="Additional In-Band Configuration">
3363 <p>These values are considered only in in-band control mode (see
3364 <ref column="connection_mode"/>).</p>
3366 <p>When multiple controllers are configured on a single bridge, there
3367 should be only one set of unique values in these columns. If different
3368 values are set for these columns in different controllers, the effect
3371 <column name="local_ip">
3372 The IP address to configure on the local port,
3373 e.g. <code>192.168.0.123</code>. If this value is unset, then
3374 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3378 <column name="local_netmask">
3379 The IP netmask to configure on the local port,
3380 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3381 but this value is unset, then the default is chosen based on whether
3382 the IP address is class A, B, or C.
3385 <column name="local_gateway">
3386 The IP address of the gateway to configure on the local port, as a
3387 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3388 this network has no gateway.
3392 <group title="Controller Status">
3393 <column name="is_connected">
3394 <code>true</code> if currently connected to this controller,
3395 <code>false</code> otherwise.
3399 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3400 <p>The level of authority this controller has on the associated
3401 bridge. Possible values are:</p>
3403 <dt><code>other</code></dt>
3404 <dd>Allows the controller access to all OpenFlow features.</dd>
3405 <dt><code>master</code></dt>
3406 <dd>Equivalent to <code>other</code>, except that there may be at
3407 most one master controller at a time. When a controller configures
3408 itself as <code>master</code>, any existing master is demoted to
3409 the <code>slave</code> role.</dd>
3410 <dt><code>slave</code></dt>
3411 <dd>Allows the controller read-only access to OpenFlow features.
3412 Attempts to modify the flow table will be rejected with an
3413 error. Slave controllers do not receive OFPT_PACKET_IN or
3414 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3419 <column name="status" key="last_error">
3420 A human-readable description of the last error on the connection
3421 to the controller; i.e. <code>strerror(errno)</code>. This key
3422 will exist only if an error has occurred.
3425 <column name="status" key="state"
3426 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3428 The state of the connection to the controller:
3431 <dt><code>VOID</code></dt>
3432 <dd>Connection is disabled.</dd>
3434 <dt><code>BACKOFF</code></dt>
3435 <dd>Attempting to reconnect at an increasing period.</dd>
3437 <dt><code>CONNECTING</code></dt>
3438 <dd>Attempting to connect.</dd>
3440 <dt><code>ACTIVE</code></dt>
3441 <dd>Connected, remote host responsive.</dd>
3443 <dt><code>IDLE</code></dt>
3444 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3447 These values may change in the future. They are provided only for
3452 <column name="status" key="sec_since_connect"
3453 type='{"type": "integer", "minInteger": 0}'>
3454 The amount of time since this controller last successfully connected to
3455 the switch (in seconds). Value is empty if controller has never
3456 successfully connected.
3459 <column name="status" key="sec_since_disconnect"
3460 type='{"type": "integer", "minInteger": 1}'>
3461 The amount of time since this controller last disconnected from
3462 the switch (in seconds). Value is empty if controller has never
3467 <group title="Connection Parameters">
3469 Additional configuration for a connection between the controller
3470 and the Open vSwitch.
3473 <column name="other_config" key="dscp"
3474 type='{"type": "integer"}'>
3475 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3476 in the Type of Service (TOS) field in the IP header. DSCP provides a
3477 mechanism to classify the network traffic and provide Quality of
3478 Service (QoS) on IP networks.
3480 The DSCP value specified here is used when establishing the connection
3481 between the controller and the Open vSwitch. If no value is specified,
3482 a default value of 48 is chosen. Valid DSCP values must be in the
3488 <group title="Common Columns">
3489 The overall purpose of these columns is described under <code>Common
3490 Columns</code> at the beginning of this document.
3492 <column name="external_ids"/>
3493 <column name="other_config"/>
3497 <table name="Manager" title="OVSDB management connection.">
3499 Configuration for a database connection to an Open vSwitch database
3504 This table primarily configures the Open vSwitch database
3505 (<code>ovsdb-server</code>), not the Open vSwitch switch
3506 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3507 what connections should be treated as in-band.
3511 The Open vSwitch database server can initiate and maintain active
3512 connections to remote clients. It can also listen for database
3516 <group title="Core Features">
3517 <column name="target">
3518 <p>Connection method for managers.</p>
3520 The following connection methods are currently supported:
3523 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3526 The specified SSL <var>port</var> on the host at the given
3527 <var>ip</var>, which must be expressed as an IP address
3528 (not a DNS name). The <ref table="Open_vSwitch"
3529 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3530 table must point to a valid SSL configuration when this
3534 If <var>port</var> is not specified, it currently defaults
3535 to 6632. In the future, the default will change to 6640,
3536 which is the IANA-defined value.
3539 SSL support is an optional feature that is not always
3540 built as part of Open vSwitch.
3544 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3547 The specified TCP <var>port</var> on the host at the given
3548 <var>ip</var>, which must be expressed as an IP address (not a
3549 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3550 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3551 e.g. <code>tcp:[::1]:6632</code>.
3554 If <var>port</var> is not specified, it currently defaults
3555 to 6632. In the future, the default will change to 6640,
3556 which is the IANA-defined value.
3559 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3562 Listens for SSL connections on the specified TCP <var>port</var>.
3563 Specify 0 for <var>port</var> to have the kernel automatically
3564 choose an available port. If <var>ip</var>, which must be
3565 expressed as an IP address (not a DNS name), is specified, then
3566 connections are restricted to the specified local IP address
3567 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3568 address, wrap in square brackets,
3569 e.g. <code>pssl:6632:[::1]</code>. If <var>ip</var> is not
3570 specified then it listens only on IPv4 (but not IPv6) addresses.
3571 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3572 table="Open_vSwitch"/> table must point to a valid SSL
3573 configuration when this form is used.
3576 If <var>port</var> is not specified, it currently defaults
3577 to 6632. In the future, the default will change to 6640,
3578 which is the IANA-defined value.
3581 SSL support is an optional feature that is not always built as
3582 part of Open vSwitch.
3585 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3588 Listens for connections on the specified TCP <var>port</var>.
3589 Specify 0 for <var>port</var> to have the kernel automatically
3590 choose an available port. If <var>ip</var>, which must be
3591 expressed as an IP address (not a DNS name), is specified, then
3592 connections are restricted to the specified local IP address
3593 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3594 address, wrap it in square brackets,
3595 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3596 specified then it listens only on IPv4 addresses.
3599 If <var>port</var> is not specified, it currently defaults
3600 to 6632. In the future, the default will change to 6640,
3601 which is the IANA-defined value.
3605 <p>When multiple managers are configured, the <ref column="target"/>
3606 values must be unique. Duplicate <ref column="target"/> values yield
3607 unspecified results.</p>
3610 <column name="connection_mode">
3612 If it is specified, this setting must be one of the following strings
3613 that describes how Open vSwitch contacts this OVSDB client over the
3618 <dt><code>in-band</code></dt>
3620 In this mode, this connection's traffic travels over a bridge
3621 managed by Open vSwitch. With this setting, Open vSwitch allows
3622 traffic to and from the client regardless of the contents of the
3623 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3624 to connect to the client, because it did not have a flow to enable
3625 it.) This is the most common connection mode because it is not
3626 necessary to maintain two independent networks.
3628 <dt><code>out-of-band</code></dt>
3630 In this mode, the client's traffic uses a control network separate
3631 from that managed by Open vSwitch, that is, Open vSwitch does not
3632 use any of its own network devices to communicate with the client.
3633 The control network must be configured separately, before or after
3634 <code>ovs-vswitchd</code> is started.
3639 If not specified, the default is implementation-specific.
3644 <group title="Client Failure Detection and Handling">
3645 <column name="max_backoff">
3646 Maximum number of milliseconds to wait between connection attempts.
3647 Default is implementation-specific.
3650 <column name="inactivity_probe">
3651 Maximum number of milliseconds of idle time on connection to the client
3652 before sending an inactivity probe message. If Open vSwitch does not
3653 communicate with the client for the specified number of seconds, it
3654 will send a probe. If a response is not received for the same
3655 additional amount of time, Open vSwitch assumes the connection has been
3656 broken and attempts to reconnect. Default is implementation-specific.
3657 A value of 0 disables inactivity probes.
3661 <group title="Status">
3662 <column name="is_connected">
3663 <code>true</code> if currently connected to this manager,
3664 <code>false</code> otherwise.
3667 <column name="status" key="last_error">
3668 A human-readable description of the last error on the connection
3669 to the manager; i.e. <code>strerror(errno)</code>. This key
3670 will exist only if an error has occurred.
3673 <column name="status" key="state"
3674 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3676 The state of the connection to the manager:
3679 <dt><code>VOID</code></dt>
3680 <dd>Connection is disabled.</dd>
3682 <dt><code>BACKOFF</code></dt>
3683 <dd>Attempting to reconnect at an increasing period.</dd>
3685 <dt><code>CONNECTING</code></dt>
3686 <dd>Attempting to connect.</dd>
3688 <dt><code>ACTIVE</code></dt>
3689 <dd>Connected, remote host responsive.</dd>
3691 <dt><code>IDLE</code></dt>
3692 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3695 These values may change in the future. They are provided only for
3700 <column name="status" key="sec_since_connect"
3701 type='{"type": "integer", "minInteger": 0}'>
3702 The amount of time since this manager last successfully connected
3703 to the database (in seconds). Value is empty if manager has never
3704 successfully connected.
3707 <column name="status" key="sec_since_disconnect"
3708 type='{"type": "integer", "minInteger": 0}'>
3709 The amount of time since this manager last disconnected from the
3710 database (in seconds). Value is empty if manager has never
3714 <column name="status" key="locks_held">
3715 Space-separated list of the names of OVSDB locks that the connection
3716 holds. Omitted if the connection does not hold any locks.
3719 <column name="status" key="locks_waiting">
3720 Space-separated list of the names of OVSDB locks that the connection is
3721 currently waiting to acquire. Omitted if the connection is not waiting
3725 <column name="status" key="locks_lost">
3726 Space-separated list of the names of OVSDB locks that the connection
3727 has had stolen by another OVSDB client. Omitted if no locks have been
3728 stolen from this connection.
3731 <column name="status" key="n_connections"
3732 type='{"type": "integer", "minInteger": 2}'>
3734 When <ref column="target"/> specifies a connection method that
3735 listens for inbound connections (e.g. <code>ptcp:</code> or
3736 <code>pssl:</code>) and more than one connection is actually active,
3737 the value is the number of active connections. Otherwise, this
3738 key-value pair is omitted.
3741 When multiple connections are active, status columns and key-value
3742 pairs (other than this one) report the status of one arbitrarily
3747 <column name="status" key="bound_port" type='{"type": "integer"}'>
3748 When <ref column="target"/> is <code>ptcp:</code> or
3749 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3750 listening. (This is is particularly useful when <ref
3751 column="target"/> specifies a port of 0, allowing the kernel to
3752 choose any available port.)
3756 <group title="Connection Parameters">
3758 Additional configuration for a connection between the manager
3759 and the Open vSwitch Database.
3762 <column name="other_config" key="dscp"
3763 type='{"type": "integer"}'>
3764 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3765 in the Type of Service (TOS) field in the IP header. DSCP provides a
3766 mechanism to classify the network traffic and provide Quality of
3767 Service (QoS) on IP networks.
3769 The DSCP value specified here is used when establishing the connection
3770 between the manager and the Open vSwitch. If no value is specified, a
3771 default value of 48 is chosen. Valid DSCP values must be in the range
3776 <group title="Common Columns">
3777 The overall purpose of these columns is described under <code>Common
3778 Columns</code> at the beginning of this document.
3780 <column name="external_ids"/>
3781 <column name="other_config"/>
3785 <table name="NetFlow">
3786 A NetFlow target. NetFlow is a protocol that exports a number of
3787 details about terminating IP flows, such as the principals involved
3790 <column name="targets">
3791 NetFlow targets in the form
3792 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3793 must be specified numerically, not as a DNS name.
3796 <column name="engine_id">
3797 Engine ID to use in NetFlow messages. Defaults to datapath index
3801 <column name="engine_type">
3802 Engine type to use in NetFlow messages. Defaults to datapath
3803 index if not specified.
3806 <column name="active_timeout">
3807 The interval at which NetFlow records are sent for flows that are
3808 still active, in seconds. A value of <code>0</code> requests the
3809 default timeout (currently 600 seconds); a value of <code>-1</code>
3810 disables active timeouts.
3813 <column name="add_id_to_interface">
3814 <p>If this column's value is <code>false</code>, the ingress and egress
3815 interface fields of NetFlow flow records are derived from OpenFlow port
3816 numbers. When it is <code>true</code>, the 7 most significant bits of
3817 these fields will be replaced by the least significant 7 bits of the
3818 engine id. This is useful because many NetFlow collectors do not
3819 expect multiple switches to be sending messages from the same host, so
3820 they do not store the engine information which could be used to
3821 disambiguate the traffic.</p>
3822 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3825 <group title="Common Columns">
3826 The overall purpose of these columns is described under <code>Common
3827 Columns</code> at the beginning of this document.
3829 <column name="external_ids"/>
3834 SSL configuration for an Open_vSwitch.
3836 <column name="private_key">
3837 Name of a PEM file containing the private key used as the switch's
3838 identity for SSL connections to the controller.
3841 <column name="certificate">
3842 Name of a PEM file containing a certificate, signed by the
3843 certificate authority (CA) used by the controller and manager,
3844 that certifies the switch's private key, identifying a trustworthy
3848 <column name="ca_cert">
3849 Name of a PEM file containing the CA certificate used to verify
3850 that the switch is connected to a trustworthy controller.
3853 <column name="bootstrap_ca_cert">
3854 If set to <code>true</code>, then Open vSwitch will attempt to
3855 obtain the CA certificate from the controller on its first SSL
3856 connection and save it to the named PEM file. If it is successful,
3857 it will immediately drop the connection and reconnect, and from then
3858 on all SSL connections must be authenticated by a certificate signed
3859 by the CA certificate thus obtained. <em>This option exposes the
3860 SSL connection to a man-in-the-middle attack obtaining the initial
3861 CA certificate.</em> It may still be useful for bootstrapping.
3864 <group title="Common Columns">
3865 The overall purpose of these columns is described under <code>Common
3866 Columns</code> at the beginning of this document.
3868 <column name="external_ids"/>
3872 <table name="sFlow">
3873 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
3874 monitoring of switches.</p>
3876 <column name="agent">
3877 Name of the network device whose IP address should be reported as the
3878 ``agent address'' to collectors. If not specified, the agent device is
3879 figured from the first target address and the routing table. If the
3880 routing table does not contain a route to the target, the IP address
3881 defaults to the <ref table="Controller" column="local_ip"/> in the
3882 collector's <ref table="Controller"/>. If an agent IP address cannot be
3883 determined any of these ways, sFlow is disabled.
3886 <column name="header">
3887 Number of bytes of a sampled packet to send to the collector.
3888 If not specified, the default is 128 bytes.
3891 <column name="polling">
3892 Polling rate in seconds to send port statistics to the collector.
3893 If not specified, defaults to 30 seconds.
3896 <column name="sampling">
3897 Rate at which packets should be sampled and sent to the collector.
3898 If not specified, defaults to 400, which means one out of 400
3899 packets, on average, will be sent to the collector.
3902 <column name="targets">
3903 sFlow targets in the form
3904 <code><var>ip</var>:<var>port</var></code>.
3907 <group title="Common Columns">
3908 The overall purpose of these columns is described under <code>Common
3909 Columns</code> at the beginning of this document.
3911 <column name="external_ids"/>
3915 <table name="IPFIX">
3916 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3917 number of details about flows.</p>
3919 <column name="targets">
3920 IPFIX target collectors in the form
3921 <code><var>ip</var>:<var>port</var></code>.
3924 <column name="sampling">
3925 For per-bridge packet sampling, i.e. when this row is referenced
3926 from a <ref table="Bridge"/>, the rate at which packets should
3927 be sampled and sent to each target collector. If not specified,
3928 defaults to 400, which means one out of 400 packets, on average,
3929 will be sent to each target collector. Ignored for per-flow
3930 sampling, i.e. when this row is referenced from a <ref
3931 table="Flow_Sample_Collector_Set"/>.
3934 <column name="obs_domain_id">
3935 For per-bridge packet sampling, i.e. when this row is referenced
3936 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3937 sent in each IPFIX packet. If not specified, defaults to 0.
3938 Ignored for per-flow sampling, i.e. when this row is referenced
3939 from a <ref table="Flow_Sample_Collector_Set"/>.
3942 <column name="obs_point_id">
3943 For per-bridge packet sampling, i.e. when this row is referenced
3944 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3945 sent in each IPFIX flow record. If not specified, defaults to
3946 0. Ignored for per-flow sampling, i.e. when this row is
3947 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3950 <column name="cache_active_timeout">
3951 The maximum period in seconds for which an IPFIX flow record is
3952 cached and aggregated before being sent. If not specified,
3953 defaults to 0. If 0, caching is disabled.
3956 <column name="cache_max_flows">
3957 The maximum number of IPFIX flow records that can be cached at a
3958 time. If not specified, defaults to 0. If 0, caching is
3962 <column name="other_config" key="enable-tunnel-sampling"
3963 type='{"type": "boolean"}'>
3964 <p>For per-bridge packet sampling, i.e. when this row is referenced
3965 from a <ref table="Bridge"/>, enable sampling and reporting tunnel
3966 header 7-tuples in IPFIX flow records. Disabled by default.
3967 Ignored for per-flow sampling, i.e. when this row is referenced
3968 from a <ref table="Flow_Sample_Collector_Set"/>.</p>
3969 <p><em>Please note:</em> The following enterprise entities are
3970 currently used when exporting the sampled tunnel info.</p>
3972 <dt>tunnelType:</dt>
3974 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
3975 <p>type: unsigned 8-bit interger.</p>
3976 <p>data type semantics: identifier.</p>
3977 <p>description: Identifier of the layer 2 network overlay network
3978 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
3983 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
3984 <p>type: variable-length octetarray.</p>
3985 <p>data type semantics: identifier.</p>
3986 <p>description: Key which is used for identifying an individual
3987 traffic flow within a VxLAN (24-bit VNI), GENEVE(24-bit VNI),
3988 GRE (32- or 64-bit key), or LISP (24-bit instance ID) tunnel. The
3989 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
3990 ID in network byte order.</p>
3992 <dt>tunnelSourceIPv4Address:</dt>
3994 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
3995 <p>type: unsigned 32-bit interger.</p>
3996 <p>data type semantics: identifier.</p>
3997 <p>description: The IPv4 source address in the tunnel IP packet
4000 <dt>tunnelDestinationIPv4Address:</dt>
4002 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4003 <p>type: unsigned 32-bit integer.</p>
4004 <p>data type semantics: identifier.</p>
4005 <p>description: The IPv4 destination address in the tunnel IP
4008 <dt>tunnelProtocolIdentifier:</dt>
4010 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4011 <p>type: unsigned 8-bit integer.</p>
4012 <p>data type semantics: identifier.</p>
4013 <p>description: The value of the protocol number in the tunnel
4014 IP packet header. The protocol number identifies the tunnel IP
4015 packet payload type.</p>
4017 <dt>tunnelSourceTransportPort:</dt>
4019 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4020 <p>type: unsigned 16-bit integer.</p>
4021 <p>data type semantics: identifier.</p>
4022 <p>description: The source port identifier in the tunnel transport
4023 header. For the transport protocols UDP, TCP, and SCTP, this is
4024 the source port number given in the respective header.</p>
4026 <dt>tunnelDestinationTransportPort:</dt>
4028 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4029 <p>type: unsigned 16-bit integer.</p>
4030 <p>data type semantics: identifier.</p>
4031 <p>description: The destination port identifier in the tunnel
4032 transport header. For the transport protocols UDP, TCP, and SCTP,
4033 this is the destination port number given in the respective header.
4039 <column name="other_config" key="enable-input-sampling"
4040 type='{"type": "boolean"}'>
4041 For per-bridge packet sampling, i.e. when this row is referenced
4042 from a <ref table="Bridge"/>, enable sampling and reporting flows
4043 at bridge port input in IPFIX flow records. Enabled by default.
4044 Ignored for per-flow sampling, i.e. when this row is referenced
4045 from a <ref table="Flow_Sample_Collector_Set"/>.
4048 <column name="other_config" key="enable-output-sampling"
4049 type='{"type": "boolean"}'>
4050 For per-bridge packet sampling, i.e. when this row is referenced
4051 from a <ref table="Bridge"/>, enable sampling and reporting flows
4052 at bridge port output in IPFIX flow records. Enabled by default.
4053 Ignored for per-flow sampling, i.e. when this row is referenced
4054 from a <ref table="Flow_Sample_Collector_Set"/>.
4057 <group title="Common Columns">
4058 The overall purpose of these columns is described under <code>Common
4059 Columns</code> at the beginning of this document.
4061 <column name="external_ids"/>
4065 <table name="Flow_Sample_Collector_Set">
4066 <p>A set of IPFIX collectors of packet samples generated by
4067 OpenFlow <code>sample</code> actions.</p>
4070 The ID of this collector set, unique among the bridge's
4071 collector sets, to be used as the <code>collector_set_id</code>
4072 in OpenFlow <code>sample</code> actions.
4075 <column name="bridge">
4076 The bridge into which OpenFlow <code>sample</code> actions can
4077 be added to send packet samples to this set of IPFIX collectors.
4080 <column name="ipfix">
4081 Configuration of the set of IPFIX collectors to send one flow
4082 record per sampled packet to.
4085 <group title="Common Columns">
4086 The overall purpose of these columns is described under <code>Common
4087 Columns</code> at the beginning of this document.
4089 <column name="external_ids"/>