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" type='{"type": "boolean"}'>
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="Rapid Spanning Tree Configuration">
696 In IEEE Std 802.1D, 1998 Edition, and prior editions of this standard,
697 Clause 8 specified the spanning tree algorithm and protocol (STP). STP
698 has now been superseded by the Rapid Spanning Tree Protocol (RSTP)
699 specified in Clause 17 of the IEEE Std 802.1D, 2004 Edition.
700 The IEEE 802.1D-2004 Rapid Spanning Tree Algorithm Protocol configures
701 full, simple, and symmetric connectivity throughout a Bridged Local Area
702 Network that comprises individual LANs interconnected by Bridges.
703 Like STP, RSTP is a network protocol that ensures loop-free topologies.
704 It allows redundant links to be included in the network to provide
705 automatic backup paths if the active links fails.
707 <column name="rstp_enable" type='{"type": "boolean"}'>
708 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
709 on bridges. Bond, internal, and mirror ports are not supported
710 and will not participate in the spanning tree.
713 <column name="other_config" key="rstp-address">
714 The bridge's RSTP address (the lower 48 bits of the bridge-id)
716 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
717 By default, the address is the MAC address of the bridge.
720 <column name="other_config" key="rstp-priority"
721 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
722 The bridge's relative priority value for determining the root
723 bridge (the upper 16 bits of the bridge-id). A bridge with the
724 lowest bridge-id is elected the root. By default, the priority
725 is 0x8000 (32768). This value needs to be a multiple of 4096,
726 otherwise it's rounded to the nearest inferior one.
729 <column name="other_config" key="rstp-ageing-time"
730 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
731 The Ageing Time parameter for the Bridge. The default value
735 <column name="other_config" key="rstp-force-protocol-version"
736 type='{"type": "integer"}'>
737 The Force Protocol Version parameter for the Bridge. This
738 can take the value 0 (STP Compatibility mode) or 2
739 (the default, normal operation).
742 <column name="other_config" key="rstp-max-age"
743 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
744 The maximum age of the information transmitted by the Bridge
745 when it is the Root Bridge. The default value is 20.
748 <column name="other_config" key="rstp-forward-delay"
749 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
750 The delay used by STP Bridges to transition Root and Designated
751 Ports to Forwarding. The default value is 15.
754 <column name="other_config" key="rstp-transmit-hold-count"
755 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
756 The Transmit Hold Count used by the Port Transmit state machine
757 to limit transmission rate. The default value is 6.
762 <group title="Other Features">
763 <column name="datapath_type">
764 Name of datapath provider. The kernel datapath has
765 type <code>system</code>. The userspace datapath has
766 type <code>netdev</code>.
769 <column name="external_ids" key="bridge-id">
770 A unique identifier of the bridge. On Citrix XenServer this will
771 commonly be the same as
772 <ref column="external_ids" key="xs-network-uuids"/>.
775 <column name="external_ids" key="xs-network-uuids">
776 Semicolon-delimited set of universally unique identifier(s) for the
777 network with which this bridge is associated on a Citrix XenServer
778 host. The network identifiers are RFC 4122 UUIDs as displayed by,
779 e.g., <code>xe network-list</code>.
782 <column name="other_config" key="hwaddr">
783 An Ethernet address in the form
784 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
785 to set the hardware address of the local port and influence the
789 <column name="other_config" key="forward-bpdu"
790 type='{"type": "boolean"}'>
791 Option to allow forwarding of BPDU frames when NORMAL action is
792 invoked. Frames with reserved Ethernet addresses (e.g. STP
793 BPDU) will be forwarded when this option is enabled and the
794 switch is not providing that functionality. If STP is enabled
795 on the port, STP BPDUs will never be forwarded. If the Open
796 vSwitch bridge is used to connect different Ethernet networks,
797 and if Open vSwitch node does not run STP, then this option
798 should be enabled. Default is disabled, set to
799 <code>true</code> to enable.
801 The following destination MAC addresss will not be forwarded when this
804 <dt><code>01:80:c2:00:00:00</code></dt>
805 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
807 <dt><code>01:80:c2:00:00:01</code></dt>
808 <dd>IEEE Pause frame.</dd>
810 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
811 <dd>Other reserved protocols.</dd>
813 <dt><code>00:e0:2b:00:00:00</code></dt>
814 <dd>Extreme Discovery Protocol (EDP).</dd>
817 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
819 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
821 <dt><code>01:00:0c:cc:cc:cc</code></dt>
823 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
824 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
828 <dt><code>01:00:0c:cc:cc:cd</code></dt>
829 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
831 <dt><code>01:00:0c:cd:cd:cd</code></dt>
832 <dd>Cisco STP Uplink Fast.</dd>
834 <dt><code>01:00:0c:00:00:00</code></dt>
835 <dd>Cisco Inter Switch Link.</dd>
837 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
842 <column name="other_config" key="mac-aging-time"
843 type='{"type": "integer", "minInteger": 1}'>
845 The maximum number of seconds to retain a MAC learning entry for
846 which no packets have been seen. The default is currently 300
847 seconds (5 minutes). The value, if specified, is forced into a
848 reasonable range, currently 15 to 3600 seconds.
852 A short MAC aging time allows a network to more quickly detect that a
853 host is no longer connected to a switch port. However, it also makes
854 it more likely that packets will be flooded unnecessarily, when they
855 are addressed to a connected host that rarely transmits packets. To
856 reduce the incidence of unnecessary flooding, use a MAC aging time
857 longer than the maximum interval at which a host will ordinarily
862 <column name="other_config" key="mac-table-size"
863 type='{"type": "integer", "minInteger": 1}'>
865 The maximum number of MAC addresses to learn. The default is
866 currently 2048. The value, if specified, is forced into a reasonable
867 range, currently 10 to 1,000,000.
872 <group title="Bridge Status">
874 Status information about bridges.
876 <column name="status">
877 Key-value pairs that report bridge status.
879 <column name="status" key="stp_bridge_id">
881 The bridge-id (in hex) used in spanning tree advertisements.
882 Configuring the bridge-id is described in the
883 <code>stp-system-id</code> and <code>stp-priority</code> keys
884 of the <code>other_config</code> section earlier.
887 <column name="status" key="stp_designated_root">
889 The designated root (in hex) for this spanning tree.
892 <column name="status" key="stp_root_path_cost">
894 The path cost of reaching the designated bridge. A lower
900 <group title="Common Columns">
901 The overall purpose of these columns is described under <code>Common
902 Columns</code> at the beginning of this document.
904 <column name="other_config"/>
905 <column name="external_ids"/>
909 <table name="Port" table="Port or bond configuration.">
910 <p>A port within a <ref table="Bridge"/>.</p>
911 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
912 <ref column="interfaces"/> column. Such a port logically
913 corresponds to a port on a physical Ethernet switch. A port
914 with more than one interface is a ``bonded port'' (see
915 <ref group="Bonding Configuration"/>).</p>
916 <p>Some properties that one might think as belonging to a port are actually
917 part of the port's <ref table="Interface"/> members.</p>
920 Port name. Should be alphanumeric and no more than about 8
921 bytes long. May be the same as the interface name, for
922 non-bonded ports. Must otherwise be unique among the names of
923 ports, interfaces, and bridges on a host.
926 <column name="interfaces">
927 The port's interfaces. If there is more than one, this is a
931 <group title="VLAN Configuration">
932 <p>Bridge ports support the following types of VLAN configuration:</p>
937 A trunk port carries packets on one or more specified VLANs
938 specified in the <ref column="trunks"/> column (often, on every
939 VLAN). A packet that ingresses on a trunk port is in the VLAN
940 specified in its 802.1Q header, or VLAN 0 if the packet has no
941 802.1Q header. A packet that egresses through a trunk port will
942 have an 802.1Q header if it has a nonzero VLAN ID.
946 Any packet that ingresses on a trunk port tagged with a VLAN that
947 the port does not trunk is dropped.
954 An access port carries packets on exactly one VLAN specified in the
955 <ref column="tag"/> column. Packets egressing on an access port
956 have no 802.1Q header.
960 Any packet with an 802.1Q header with a nonzero VLAN ID that
961 ingresses on an access port is dropped, regardless of whether the
962 VLAN ID in the header is the access port's VLAN ID.
966 <dt>native-tagged</dt>
968 A native-tagged port resembles a trunk port, with the exception that
969 a packet without an 802.1Q header that ingresses on a native-tagged
970 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
974 <dt>native-untagged</dt>
976 A native-untagged port resembles a native-tagged port, with the
977 exception that a packet that egresses on a native-untagged port in
978 the native VLAN will not have an 802.1Q header.
982 A packet will only egress through bridge ports that carry the VLAN of
983 the packet, as described by the rules above.
986 <column name="vlan_mode">
988 The VLAN mode of the port, as described above. When this column is
989 empty, a default mode is selected as follows:
993 If <ref column="tag"/> contains a value, the port is an access
994 port. The <ref column="trunks"/> column should be empty.
997 Otherwise, the port is a trunk port. The <ref column="trunks"/>
998 column value is honored if it is present.
1005 For an access port, the port's implicitly tagged VLAN. For a
1006 native-tagged or native-untagged port, the port's native VLAN. Must
1007 be empty if this is a trunk port.
1011 <column name="trunks">
1013 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1014 or VLANs that this port trunks; if it is empty, then the port trunks
1015 all VLANs. Must be empty if this is an access port.
1018 A native-tagged or native-untagged port always trunks its native
1019 VLAN, regardless of whether <ref column="trunks"/> includes that
1024 <column name="other_config" key="priority-tags"
1025 type='{"type": "boolean"}'>
1027 An 802.1Q header contains two important pieces of information: a VLAN
1028 ID and a priority. A frame with a zero VLAN ID, called a
1029 ``priority-tagged'' frame, is supposed to be treated the same way as
1030 a frame without an 802.1Q header at all (except for the priority).
1034 However, some network elements ignore any frame that has 802.1Q
1035 header at all, even when the VLAN ID is zero. Therefore, by default
1036 Open vSwitch does not output priority-tagged frames, instead omitting
1037 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1038 <code>true</code> to enable priority-tagged frames on a port.
1042 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1043 output if both the VLAN ID and priority would be zero.
1047 All frames output to native-tagged ports have a nonzero VLAN ID, so
1048 this setting is not meaningful on native-tagged ports.
1053 <group title="Bonding Configuration">
1054 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1055 allows for load balancing and fail-over.</p>
1058 The following types of bonding will work with any kind of upstream
1059 switch. On the upstream switch, do not configure the interfaces as a
1064 <dt><code>balance-slb</code></dt>
1066 Balances flows among slaves based on source MAC address and output
1067 VLAN, with periodic rebalancing as traffic patterns change.
1070 <dt><code>active-backup</code></dt>
1072 Assigns all flows to one slave, failing over to a backup slave when
1073 the active slave is disabled. This is the only bonding mode in which
1074 interfaces may be plugged into different upstream switches.
1079 The following modes require the upstream switch to support 802.3ad with
1080 successful LACP negotiation. If LACP negotiation fails and
1081 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1086 <dt><code>balance-tcp</code></dt>
1088 Balances flows among slaves based on L2, L3, and L4 protocol
1089 information such as destination MAC address, IP address, and TCP
1094 <p>These columns apply only to bonded ports. Their values are
1095 otherwise ignored.</p>
1097 <column name="bond_mode">
1098 <p>The type of bonding used for a bonded port. Defaults to
1099 <code>active-backup</code> if unset.
1103 <column name="other_config" key="bond-hash-basis"
1104 type='{"type": "integer"}'>
1105 An integer hashed along with flows when choosing output slaves in load
1106 balanced bonds. When changed, all flows will be assigned different
1107 hash values possibly causing slave selection decisions to change. Does
1108 not affect bonding modes which do not employ load balancing such as
1109 <code>active-backup</code>.
1112 <group title="Link Failure Detection">
1114 An important part of link bonding is detecting that links are down so
1115 that they may be disabled. These settings determine how Open vSwitch
1116 detects link failure.
1119 <column name="other_config" key="bond-detect-mode"
1120 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1121 The means used to detect link failures. Defaults to
1122 <code>carrier</code> which uses each interface's carrier to detect
1123 failures. When set to <code>miimon</code>, will check for failures
1124 by polling each interface's MII.
1127 <column name="other_config" key="bond-miimon-interval"
1128 type='{"type": "integer"}'>
1129 The interval, in milliseconds, between successive attempts to poll
1130 each interface's MII. Relevant only when <ref column="other_config"
1131 key="bond-detect-mode"/> is <code>miimon</code>.
1134 <column name="bond_updelay">
1136 The number of milliseconds for which the link must stay up on an
1137 interface before the interface is considered to be up. Specify
1138 <code>0</code> to enable the interface immediately.
1142 This setting is honored only when at least one bonded interface is
1143 already enabled. When no interfaces are enabled, then the first
1144 bond interface to come up is enabled immediately.
1148 <column name="bond_downdelay">
1149 The number of milliseconds for which the link must stay down on an
1150 interface before the interface is considered to be down. Specify
1151 <code>0</code> to disable the interface immediately.
1155 <group title="LACP Configuration">
1157 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1158 allows switches to automatically detect that they are connected by
1159 multiple links and aggregate across those links. These settings
1160 control LACP behavior.
1163 <column name="lacp">
1164 Configures LACP on this port. LACP allows directly connected
1165 switches to negotiate which links may be bonded. LACP may be enabled
1166 on non-bonded ports for the benefit of any switches they may be
1167 connected to. <code>active</code> ports are allowed to initiate LACP
1168 negotiations. <code>passive</code> ports are allowed to participate
1169 in LACP negotiations initiated by a remote switch, but not allowed to
1170 initiate such negotiations themselves. If LACP is enabled on a port
1171 whose partner switch does not support LACP, the bond will be
1172 disabled, unless other-config:lacp-fallback-ab is set to true.
1173 Defaults to <code>off</code> if unset.
1176 <column name="other_config" key="lacp-system-id">
1177 The LACP system ID of this <ref table="Port"/>. The system ID of a
1178 LACP bond is used to identify itself to its partners. Must be a
1179 nonzero MAC address. Defaults to the bridge Ethernet address if
1183 <column name="other_config" key="lacp-system-priority"
1184 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1185 The LACP system priority of this <ref table="Port"/>. In LACP
1186 negotiations, link status decisions are made by the system with the
1187 numerically lower priority.
1190 <column name="other_config" key="lacp-time"
1191 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1193 The LACP timing which should be used on this <ref table="Port"/>.
1194 By default <code>slow</code> is used. When configured to be
1195 <code>fast</code> LACP heartbeats are requested at a rate of once
1196 per second causing connectivity problems to be detected more
1197 quickly. In <code>slow</code> mode, heartbeats are requested at a
1198 rate of once every 30 seconds.
1202 <column name="other_config" key="lacp-fallback-ab"
1203 type='{"type": "boolean"}'>
1205 Determines the behavior of openvswitch bond in LACP mode. If
1206 the partner switch does not support LACP, setting this option
1207 to <code>true</code> allows openvswitch to fallback to
1208 active-backup. If the option is set to <code>false</code>, the
1209 bond will be disabled. In both the cases, once the partner switch
1210 is configured to LACP mode, the bond will use LACP.
1215 <group title="Rebalancing Configuration">
1217 These settings control behavior when a bond is in
1218 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1221 <column name="other_config" key="bond-rebalance-interval"
1222 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1223 For a load balanced bonded port, the number of milliseconds between
1224 successive attempts to rebalance the bond, that is, to move flows
1225 from one interface on the bond to another in an attempt to keep usage
1226 of each interface roughly equal. If zero, load balancing is disabled
1227 on the bond (link failure still cause flows to move). If
1228 less than 1000ms, the rebalance interval will be 1000ms.
1232 <column name="bond_fake_iface">
1233 For a bonded port, whether to create a fake internal interface with the
1234 name of the port. Use only for compatibility with legacy software that
1239 <group title="Spanning Tree Configuration">
1240 <column name="other_config" key="stp-enable"
1241 type='{"type": "boolean"}'>
1242 If spanning tree is enabled on the bridge, member ports are
1243 enabled by default (with the exception of bond, internal, and
1244 mirror ports which do not work with STP). If this column's
1245 value is <code>false</code> spanning tree is disabled on the
1249 <column name="other_config" key="stp-port-num"
1250 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1251 The port number used for the lower 8 bits of the port-id. By
1252 default, the numbers will be assigned automatically. If any
1253 port's number is manually configured on a bridge, then they
1257 <column name="other_config" key="stp-port-priority"
1258 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1259 The port's relative priority value for determining the root
1260 port (the upper 8 bits of the port-id). A port with a lower
1261 port-id will be chosen as the root port. By default, the
1265 <column name="other_config" key="stp-path-cost"
1266 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1267 Spanning tree path cost for the port. A lower number indicates
1268 a faster link. By default, the cost is based on the maximum
1273 <group title="Rapid Spanning Tree Configuration">
1274 <column name="other_config" key="rstp-enable"
1275 type='{"type": "boolean"}'>
1276 If rapid spanning tree is enabled on the bridge, member ports are
1277 enabled by default (with the exception of bond, internal, and
1278 mirror ports which do not work with RSTP). If this column's
1279 value is <code>false</code> rapid spanning tree is disabled on the
1283 <column name="other_config" key="rstp-port-priority"
1284 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1285 The port's relative priority value for determining the root
1286 port, in multiples of 16. By default, the port priority is 0x80
1287 (128). Any value in the lower 4 bits is rounded off. The significant
1288 upper 4 bits become the upper 4 bits of the port-id. A port with the
1289 lowest port-id is elected as the root.
1292 <column name="other_config" key="rstp-port-num"
1293 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1294 The local RSTP port number, used as the lower 12 bits of the port-id.
1295 By default the port numbers are assigned automatically, and typically
1296 may not correspond to the OpenFlow port numbers. A port with the
1297 lowest port-id is elected as the root.
1300 <column name="other_config" key="rstp-port-path-cost"
1301 type='{"type": "integer"}'>
1302 The port path cost. The Port's contribution, when it is
1303 the Root Port, to the Root Path Cost for the Bridge. By default the
1304 cost is automatically calculated from the port's speed.
1307 <column name="other_config" key="rstp-port-admin-edge"
1308 type='{"type": "boolean"}'>
1309 The admin edge port parameter for the Port. Default is
1313 <column name="other_config" key="rstp-port-auto-edge"
1314 type='{"type": "boolean"}'>
1315 The auto edge port parameter for the Port. Default is
1319 <column name="other_config" key="rstp-port-mcheck"
1320 type='{"type": "boolean"}'>
1322 The mcheck port parameter for the Port. Default is
1323 <code>false</code>. May be set to force the Port Protocol
1324 Migration state machine to transmit RST BPDUs for a
1325 MigrateTime period, to test whether all STP Bridges on the
1326 attached LAN have been removed and the Port can continue to
1327 transmit RSTP BPDUs. Setting mcheck has no effect if the
1328 Bridge is operating in STP Compatibility mode.
1331 Changing the value from <code>true</code> to
1332 <code>false</code> has no effect, but needs to be done if
1333 this behavior is to be triggered again by subsequently
1334 changing the value from <code>false</code> to
1340 <group title="Multicast Snooping">
1341 <column name="other_config" key="mcast-snooping-flood"
1342 type='{"type": "boolean"}'>
1344 If set to <code>true</code>, multicast packets are unconditionally
1345 forwarded to the specific port.
1350 <group title="Other Features">
1352 Quality of Service configuration for this port.
1356 The MAC address to use for this port for the purpose of choosing the
1357 bridge's MAC address. This column does not necessarily reflect the
1358 port's actual MAC address, nor will setting it change the port's actual
1362 <column name="fake_bridge">
1363 Does this port represent a sub-bridge for its tagged VLAN within the
1364 Bridge? See ovs-vsctl(8) for more information.
1367 <column name="external_ids" key="fake-bridge-id-*">
1368 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1369 column) are defined by prefixing a <ref table="Bridge"/> <ref
1370 table="Bridge" column="external_ids"/> key with
1371 <code>fake-bridge-</code>,
1372 e.g. <code>fake-bridge-xs-network-uuids</code>.
1376 <group title="Port Status">
1378 Status information about ports attached to bridges.
1380 <column name="status">
1381 Key-value pairs that report port status.
1383 <column name="status" key="stp_port_id">
1385 The port-id (in hex) used in spanning tree advertisements for
1386 this port. Configuring the port-id is described in the
1387 <code>stp-port-num</code> and <code>stp-port-priority</code>
1388 keys of the <code>other_config</code> section earlier.
1391 <column name="status" key="stp_state"
1392 type='{"type": "string", "enum": ["set",
1393 ["disabled", "listening", "learning",
1394 "forwarding", "blocking"]]}'>
1396 STP state of the port.
1399 <column name="status" key="stp_sec_in_state"
1400 type='{"type": "integer", "minInteger": 0}'>
1402 The amount of time (in seconds) port has been in the current
1406 <column name="status" key="stp_role"
1407 type='{"type": "string", "enum": ["set",
1408 ["root", "designated", "alternate"]]}'>
1410 STP role of the port.
1415 <group title="Port Statistics">
1417 Key-value pairs that report port statistics. The update period
1418 is controlled by <ref column="other_config"
1419 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1421 <group title="Statistics: STP transmit and receive counters">
1422 <column name="statistics" key="stp_tx_count">
1423 Number of STP BPDUs sent on this port by the spanning
1426 <column name="statistics" key="stp_rx_count">
1427 Number of STP BPDUs received on this port and accepted by the
1428 spanning tree library.
1430 <column name="statistics" key="stp_error_count">
1431 Number of bad STP BPDUs received on this port. Bad BPDUs
1432 include runt packets and those with an unexpected protocol ID.
1437 <group title="Common Columns">
1438 The overall purpose of these columns is described under <code>Common
1439 Columns</code> at the beginning of this document.
1441 <column name="other_config"/>
1442 <column name="external_ids"/>
1446 <table name="Interface" title="One physical network device in a Port.">
1447 An interface within a <ref table="Port"/>.
1449 <group title="Core Features">
1450 <column name="name">
1451 Interface name. Should be alphanumeric and no more than about 8 bytes
1452 long. May be the same as the port name, for non-bonded ports. Must
1453 otherwise be unique among the names of ports, interfaces, and bridges
1457 <column name="ifindex">
1458 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1459 2863, if the interface has one, otherwise 0. The ifindex is useful for
1460 seamless integration with protocols such as SNMP and sFlow.
1463 <column name="mac_in_use">
1464 The MAC address in use by this interface.
1468 <p>Ethernet address to set for this interface. If unset then the
1469 default MAC address is used:</p>
1471 <li>For the local interface, the default is the lowest-numbered MAC
1472 address among the other bridge ports, either the value of the
1473 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1474 if set, or its actual MAC (for bonded ports, the MAC of its slave
1475 whose name is first in alphabetical order). Internal ports and
1476 bridge ports that are used as port mirroring destinations (see the
1477 <ref table="Mirror"/> table) are ignored.</li>
1478 <li>For other internal interfaces, the default MAC is randomly
1480 <li>External interfaces typically have a MAC address associated with
1481 their hardware.</li>
1483 <p>Some interfaces may not have a software-controllable MAC
1487 <column name="error">
1488 If the configuration of the port failed, as indicated by -1 in <ref
1489 column="ofport"/>, Open vSwitch sets this column to an error
1490 description in human readable form. Otherwise, Open vSwitch clears
1494 <group title="OpenFlow Port Number">
1496 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1497 port number for the new port. If the client that adds the port fills
1498 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1499 value as the OpenFlow port number. Otherwise, or if the requested
1500 port number is already in use or cannot be used for another reason,
1501 Open vSwitch automatically assigns a free port number. Regardless of
1502 how the port number was obtained, Open vSwitch then reports in <ref
1503 column="ofport"/> the port number actually assigned.
1507 Open vSwitch limits the port numbers that it automatically assigns to
1508 the range 1 through 32,767, inclusive. Controllers therefore have
1509 free use of ports 32,768 and up.
1512 <column name="ofport">
1514 OpenFlow port number for this interface. Open vSwitch sets this
1515 column's value, so other clients should treat it as read-only.
1518 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1519 The other valid port numbers are in the range 1 to 65,279,
1520 inclusive. Value -1 indicates an error adding the interface.
1524 <column name="ofport_request"
1525 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1527 Requested OpenFlow port number for this interface.
1531 A client should ideally set this column's value in the same
1532 database transaction that it uses to create the interface. Open
1533 vSwitch version 2.1 and later will honor a later request for a
1534 specific port number, althuogh it might confuse some controllers:
1535 OpenFlow does not have a way to announce a port number change, so
1536 Open vSwitch represents it over OpenFlow as a port deletion
1537 followed immediately by a port addition.
1541 If <ref column="ofport_request"/> is set or changed to some other
1542 port's automatically assigned port number, Open vSwitch chooses a
1543 new port number for the latter port.
1549 <group title="System-Specific Details">
1550 <column name="type">
1552 The interface type, one of:
1556 <dt><code>system</code></dt>
1557 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1558 Sometimes referred to as ``external interfaces'' since they are
1559 generally connected to hardware external to that on which the Open
1560 vSwitch is running. The empty string is a synonym for
1561 <code>system</code>.</dd>
1563 <dt><code>internal</code></dt>
1564 <dd>A simulated network device that sends and receives traffic. An
1565 internal interface whose <ref column="name"/> is the same as its
1566 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1567 ``local interface.'' It does not make sense to bond an internal
1568 interface, so the terms ``port'' and ``interface'' are often used
1569 imprecisely for internal interfaces.</dd>
1571 <dt><code>tap</code></dt>
1572 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1574 <dt><code>geneve</code></dt>
1576 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1579 Geneve supports options as a means to transport additional metadata,
1580 however, currently only the 24-bit VNI is supported. This is planned
1581 to be extended in the future.
1584 <dt><code>gre</code></dt>
1586 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1590 <dt><code>ipsec_gre</code></dt>
1592 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1596 <dt><code>gre64</code></dt>
1598 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1599 of key, it uses GRE protocol sequence number field. This is non
1600 standard use of GRE protocol since OVS does not increment
1601 sequence number for every packet at time of encap as expected by
1602 standard GRE implementation. See <ref group="Tunnel Options"/>
1603 for information on configuring GRE tunnels.
1606 <dt><code>ipsec_gre64</code></dt>
1608 Same as IPSEC_GRE except 64 bit key.
1611 <dt><code>vxlan</code></dt>
1614 An Ethernet tunnel over the experimental, UDP-based VXLAN
1615 protocol described at
1616 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1619 Open vSwitch uses UDP destination port 4789. The source port used for
1620 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1625 <dt><code>lisp</code></dt>
1628 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1629 Separation Protocol (RFC 6830).
1632 Only IPv4 and IPv6 packets are supported by the protocol, and
1633 they are sent and received without an Ethernet header. Traffic
1634 to/from LISP ports is expected to be configured explicitly, and
1635 the ports are not intended to participate in learning based
1636 switching. As such, they are always excluded from packet
1641 <dt><code>patch</code></dt>
1643 A pair of virtual devices that act as a patch cable.
1646 <dt><code>null</code></dt>
1647 <dd>An ignored interface. Deprecated and slated for removal in
1653 <group title="Tunnel Options">
1655 These options apply to interfaces with <ref column="type"/> of
1656 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1657 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1658 and <code>lisp</code>.
1662 Each tunnel must be uniquely identified by the combination of <ref
1663 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1664 column="options" key="local_ip"/>, and <ref column="options"
1665 key="in_key"/>. If two ports are defined that are the same except one
1666 has an optional identifier and the other does not, the more specific
1667 one is matched first. <ref column="options" key="in_key"/> is
1668 considered more specific than <ref column="options" key="local_ip"/> if
1669 a port defines one and another port defines the other.
1672 <column name="options" key="remote_ip">
1673 <p>Required. The remote tunnel endpoint, one of:</p>
1677 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1678 Only unicast endpoints are supported.
1681 The word <code>flow</code>. The tunnel accepts packets from any
1682 remote tunnel endpoint. To process only packets from a specific
1683 remote tunnel endpoint, the flow entries may match on the
1684 <code>tun_src</code> field. When sending packets to a
1685 <code>remote_ip=flow</code> tunnel, the flow actions must
1686 explicitly set the <code>tun_dst</code> field to the IP address of
1687 the desired remote tunnel endpoint, e.g. with a
1688 <code>set_field</code> action.
1693 The remote tunnel endpoint for any packet received from a tunnel
1694 is available in the <code>tun_src</code> field for matching in the
1699 <column name="options" key="local_ip">
1701 Optional. The tunnel destination IP that received packets must
1702 match. Default is to match all addresses. If specified, may be one
1708 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1711 The word <code>flow</code>. The tunnel accepts packets sent to any
1712 of the local IP addresses of the system running OVS. To process
1713 only packets sent to a specific IP address, the flow entries may
1714 match on the <code>tun_dst</code> field. When sending packets to a
1715 <code>local_ip=flow</code> tunnel, the flow actions may
1716 explicitly set the <code>tun_src</code> field to the desired IP
1717 address, e.g. with a <code>set_field</code> action. However, while
1718 routing the tunneled packet out, the local system may override the
1719 specified address with the local IP address configured for the
1720 outgoing system interface.
1723 This option is valid only for tunnels also configured with the
1724 <code>remote_ip=flow</code> option.
1730 The tunnel destination IP address for any packet received from a
1731 tunnel is available in the <code>tun_dst</code> field for matching in
1736 <column name="options" key="in_key">
1737 <p>Optional. The key that received packets must contain, one of:</p>
1741 <code>0</code>. The tunnel receives packets with no key or with a
1742 key of 0. This is equivalent to specifying no <ref column="options"
1743 key="in_key"/> at all.
1746 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
1747 or 64-bit (for GRE64) number. The tunnel receives only packets
1748 with the specified key.
1751 The word <code>flow</code>. The tunnel accepts packets with any
1752 key. The key will be placed in the <code>tun_id</code> field for
1753 matching in the flow table. The <code>ovs-ofctl</code> manual page
1754 contains additional information about matching fields in OpenFlow
1763 <column name="options" key="out_key">
1764 <p>Optional. The key to be set on outgoing packets, one of:</p>
1768 <code>0</code>. Packets sent through the tunnel will have no key.
1769 This is equivalent to specifying no <ref column="options"
1770 key="out_key"/> at all.
1773 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
1774 64-bit (for GRE64) number. Packets sent through the tunnel will
1775 have the specified key.
1778 The word <code>flow</code>. Packets sent through the tunnel will
1779 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1780 vendor extension (0 is used in the absence of an action). The
1781 <code>ovs-ofctl</code> manual page contains additional information
1782 about the Nicira OpenFlow vendor extensions.
1787 <column name="options" key="key">
1788 Optional. Shorthand to set <code>in_key</code> and
1789 <code>out_key</code> at the same time.
1792 <column name="options" key="tos">
1793 Optional. The value of the ToS bits to be set on the encapsulating
1794 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1795 zero. It may also be the word <code>inherit</code>, in which case
1796 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1797 (otherwise it will be 0). The ECN fields are always inherited.
1801 <column name="options" key="ttl">
1802 Optional. The TTL to be set on the encapsulating packet. It may also
1803 be the word <code>inherit</code>, in which case the TTL will be copied
1804 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1805 system default, typically 64). Default is the system default TTL.
1808 <column name="options" key="df_default"
1809 type='{"type": "boolean"}'>
1810 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1811 outer headers to allow path MTU discovery. Default is enabled; set
1812 to <code>false</code> to disable.
1815 <group title="Tunnel Options: gre and ipsec_gre only">
1817 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1821 <column name="options" key="csum" type='{"type": "boolean"}'>
1823 Optional. Compute GRE checksums on outgoing packets. Default is
1824 disabled, set to <code>true</code> to enable. Checksums present on
1825 incoming packets will be validated regardless of this setting.
1829 GRE checksums impose a significant performance penalty because they
1830 cover the entire packet. The encapsulated L3, L4, and L7 packet
1831 contents typically have their own checksums, so this additional
1832 checksum only adds value for the GRE and encapsulated L2 headers.
1836 This option is supported for <code>ipsec_gre</code>, but not useful
1837 because GRE checksums are weaker than, and redundant with, IPsec
1838 payload authentication.
1843 <group title="Tunnel Options: ipsec_gre only">
1845 Only <code>ipsec_gre</code> interfaces support these options.
1848 <column name="options" key="peer_cert">
1849 Required for certificate authentication. A string containing the
1850 peer's certificate in PEM format. Additionally the host's
1851 certificate must be specified with the <code>certificate</code>
1855 <column name="options" key="certificate">
1856 Required for certificate authentication. The name of a PEM file
1857 containing a certificate that will be presented to the peer during
1861 <column name="options" key="private_key">
1862 Optional for certificate authentication. The name of a PEM file
1863 containing the private key associated with <code>certificate</code>.
1864 If <code>certificate</code> contains the private key, this option may
1868 <column name="options" key="psk">
1869 Required for pre-shared key authentication. Specifies a pre-shared
1870 key for authentication that must be identical on both sides of the
1876 <group title="Patch Options">
1878 Only <code>patch</code> interfaces support these options.
1881 <column name="options" key="peer">
1882 The <ref column="name"/> of the <ref table="Interface"/> for the other
1883 side of the patch. The named <ref table="Interface"/>'s own
1884 <code>peer</code> option must specify this <ref table="Interface"/>'s
1885 name. That is, the two patch interfaces must have reversed <ref
1886 column="name"/> and <code>peer</code> values.
1890 <group title="Interface Status">
1892 Status information about interfaces attached to bridges, updated every
1893 5 seconds. Not all interfaces have all of these properties; virtual
1894 interfaces don't have a link speed, for example. Non-applicable
1895 columns will have empty values.
1897 <column name="admin_state">
1899 The administrative state of the physical network link.
1903 <column name="link_state">
1905 The observed state of the physical network link. This is ordinarily
1906 the link's carrier status. If the interface's <ref table="Port"/> is
1907 a bond configured for miimon monitoring, it is instead the network
1908 link's miimon status.
1912 <column name="link_resets">
1914 The number of times Open vSwitch has observed the
1915 <ref column="link_state"/> of this <ref table="Interface"/> change.
1919 <column name="link_speed">
1921 The negotiated speed of the physical network link.
1922 Valid values are positive integers greater than 0.
1926 <column name="duplex">
1928 The duplex mode of the physical network link.
1934 The MTU (maximum transmission unit); i.e. the largest
1935 amount of data that can fit into a single Ethernet frame.
1936 The standard Ethernet MTU is 1500 bytes. Some physical media
1937 and many kinds of virtual interfaces can be configured with
1941 This column will be empty for an interface that does not
1942 have an MTU as, for example, some kinds of tunnels do not.
1946 <column name="lacp_current">
1947 Boolean value indicating LACP status for this interface. If true, this
1948 interface has current LACP information about its LACP partner. This
1949 information may be used to monitor the health of interfaces in a LACP
1950 enabled port. This column will be empty if LACP is not enabled.
1953 <column name="status">
1954 Key-value pairs that report port status. Supported status values are
1955 <ref column="type"/>-dependent; some interfaces may not have a valid
1956 <ref column="status" key="driver_name"/>, for example.
1959 <column name="status" key="driver_name">
1960 The name of the device driver controlling the network adapter.
1963 <column name="status" key="driver_version">
1964 The version string of the device driver controlling the network
1968 <column name="status" key="firmware_version">
1969 The version string of the network adapter's firmware, if available.
1972 <column name="status" key="source_ip">
1973 The source IP address used for an IPv4 tunnel end-point, such as
1977 <column name="status" key="tunnel_egress_iface">
1978 Egress interface for tunnels. Currently only relevant for tunnels
1979 on Linux systems, this column will show the name of the interface
1980 which is responsible for routing traffic destined for the configured
1981 <ref column="options" key="remote_ip"/>. This could be an internal
1982 interface such as a bridge port.
1985 <column name="status" key="tunnel_egress_iface_carrier"
1986 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1987 Whether carrier is detected on <ref column="status"
1988 key="tunnel_egress_iface"/>.
1992 <group title="Statistics">
1994 Key-value pairs that report interface statistics. The current
1995 implementation updates these counters periodically. The update period
1996 is controlled by <ref column="other_config"
1997 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1998 Future implementations may update them when an interface is created,
1999 when they are queried (e.g. using an OVSDB <code>select</code>
2000 operation), and just before an interface is deleted due to virtual
2001 interface hot-unplug or VM shutdown, and perhaps at other times, but
2002 not on any regular periodic basis.
2005 These are the same statistics reported by OpenFlow in its <code>struct
2006 ofp_port_stats</code> structure. If an interface does not support a
2007 given statistic, then that pair is omitted.
2009 <group title="Statistics: Successful transmit and receive counters">
2010 <column name="statistics" key="rx_packets">
2011 Number of received packets.
2013 <column name="statistics" key="rx_bytes">
2014 Number of received bytes.
2016 <column name="statistics" key="tx_packets">
2017 Number of transmitted packets.
2019 <column name="statistics" key="tx_bytes">
2020 Number of transmitted bytes.
2023 <group title="Statistics: Receive errors">
2024 <column name="statistics" key="rx_dropped">
2025 Number of packets dropped by RX.
2027 <column name="statistics" key="rx_frame_err">
2028 Number of frame alignment errors.
2030 <column name="statistics" key="rx_over_err">
2031 Number of packets with RX overrun.
2033 <column name="statistics" key="rx_crc_err">
2034 Number of CRC errors.
2036 <column name="statistics" key="rx_errors">
2037 Total number of receive errors, greater than or equal to the sum of
2041 <group title="Statistics: Transmit errors">
2042 <column name="statistics" key="tx_dropped">
2043 Number of packets dropped by TX.
2045 <column name="statistics" key="collisions">
2046 Number of collisions.
2048 <column name="statistics" key="tx_errors">
2049 Total number of transmit errors, greater than or equal to the sum of
2055 <group title="Ingress Policing">
2057 These settings control ingress policing for packets received on this
2058 interface. On a physical interface, this limits the rate at which
2059 traffic is allowed into the system from the outside; on a virtual
2060 interface (one connected to a virtual machine), this limits the rate at
2061 which the VM is able to transmit.
2064 Policing is a simple form of quality-of-service that simply drops
2065 packets received in excess of the configured rate. Due to its
2066 simplicity, policing is usually less accurate and less effective than
2067 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2068 table="Queue"/> tables).
2071 Policing is currently implemented only on Linux. The Linux
2072 implementation uses a simple ``token bucket'' approach:
2076 The size of the bucket corresponds to <ref
2077 column="ingress_policing_burst"/>. Initially the bucket is full.
2080 Whenever a packet is received, its size (converted to tokens) is
2081 compared to the number of tokens currently in the bucket. If the
2082 required number of tokens are available, they are removed and the
2083 packet is forwarded. Otherwise, the packet is dropped.
2086 Whenever it is not full, the bucket is refilled with tokens at the
2087 rate specified by <ref column="ingress_policing_rate"/>.
2091 Policing interacts badly with some network protocols, and especially
2092 with fragmented IP packets. Suppose that there is enough network
2093 activity to keep the bucket nearly empty all the time. Then this token
2094 bucket algorithm will forward a single packet every so often, with the
2095 period depending on packet size and on the configured rate. All of the
2096 fragments of an IP packets are normally transmitted back-to-back, as a
2097 group. In such a situation, therefore, only one of these fragments
2098 will be forwarded and the rest will be dropped. IP does not provide
2099 any way for the intended recipient to ask for only the remaining
2100 fragments. In such a case there are two likely possibilities for what
2101 will happen next: either all of the fragments will eventually be
2102 retransmitted (as TCP will do), in which case the same problem will
2103 recur, or the sender will not realize that its packet has been dropped
2104 and data will simply be lost (as some UDP-based protocols will do).
2105 Either way, it is possible that no forward progress will ever occur.
2107 <column name="ingress_policing_rate">
2109 Maximum rate for data received on this interface, in kbps. Data
2110 received faster than this rate is dropped. Set to <code>0</code>
2111 (the default) to disable policing.
2115 <column name="ingress_policing_burst">
2116 <p>Maximum burst size for data received on this interface, in kb. The
2117 default burst size if set to <code>0</code> is 1000 kb. This value
2118 has no effect if <ref column="ingress_policing_rate"/>
2119 is <code>0</code>.</p>
2121 Specifying a larger burst size lets the algorithm be more forgiving,
2122 which is important for protocols like TCP that react severely to
2123 dropped packets. The burst size should be at least the size of the
2124 interface's MTU. Specifying a value that is numerically at least as
2125 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2126 closer to achieving the full rate.
2131 <group title="Bidirectional Forwarding Detection (BFD)">
2133 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2134 detection of connectivity failures by occasional transmission of
2135 BFD control messages. Open vSwitch implements BFD to serve
2136 as a more popular and standards compliant alternative to CFM.
2140 BFD operates by regularly transmitting BFD control messages at a rate
2141 negotiated independently in each direction. Each endpoint specifies
2142 the rate at which it expects to receive control messages, and the rate
2143 at which it is willing to transmit them. Open vSwitch uses a detection
2144 multiplier of three, meaning that an endpoint signals a connectivity
2145 fault if three consecutive BFD control messages fail to arrive. In the
2146 case of a unidirectional connectivity issue, the system not receiving
2147 BFD control messages signals the problem to its peer in the messages it
2152 The Open vSwitch implementation of BFD aims to comply faithfully
2153 with RFC 5880 requirements. Open vSwitch does not implement the
2154 optional Authentication or ``Echo Mode'' features.
2157 <group title="BFD Configuration">
2159 A controller sets up key-value pairs in the <ref column="bfd"/>
2160 column to enable and configure BFD.
2163 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2164 True to enable BFD on this <ref table="Interface"/>. If not
2165 specified, BFD will not be enabled by default.
2168 <column name="bfd" key="min_rx"
2169 type='{"type": "integer", "minInteger": 1}'>
2170 The shortest interval, in milliseconds, at which this BFD session
2171 offers to receive BFD control messages. The remote endpoint may
2172 choose to send messages at a slower rate. Defaults to
2176 <column name="bfd" key="min_tx"
2177 type='{"type": "integer", "minInteger": 1}'>
2178 The shortest interval, in milliseconds, at which this BFD session is
2179 willing to transmit BFD control messages. Messages will actually be
2180 transmitted at a slower rate if the remote endpoint is not willing to
2181 receive as quickly as specified. Defaults to <code>100</code>.
2184 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2185 An alternate receive interval, in milliseconds, that must be greater
2186 than or equal to <ref column="bfd" key="min_rx"/>. The
2187 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2188 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2189 data traffic at the interface, to reduce the CPU and bandwidth cost
2190 of monitoring an idle interface. This feature may be disabled by
2191 setting a value of 0. This feature is reset whenever <ref
2192 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2196 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2197 When <code>true</code>, traffic received on the
2198 <ref table="Interface"/> is used to indicate the capability of packet
2199 I/O. BFD control packets are still transmitted and received. At
2200 least one BFD control packet must be received every 100 * <ref
2201 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2202 traffic are received, the <ref column="bfd" key="forwarding"/>
2203 will be <code>false</code>.
2206 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2207 Set to true to notify the remote endpoint that traffic should not be
2208 forwarded to this system for some reason other than a connectivty
2209 failure on the interface being monitored. The typical underlying
2210 reason is ``concatenated path down,'' that is, that connectivity
2211 beyond the local system is down. Defaults to false.
2214 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2215 Set to true to make BFD accept only control messages with a tunnel
2216 key of zero. By default, BFD accepts control messages with any
2220 <column name="bfd" key="bfd_local_src_mac">
2221 Set to an Ethernet address in the form
2222 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2223 to set the MAC used as source for transmitted BFD packets. The
2224 default is the mac address of the BFD enabled interface.
2227 <column name="bfd" key="bfd_local_dst_mac">
2228 Set to an Ethernet address in the form
2229 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2230 to set the MAC used as destination for transmitted BFD packets. The
2231 default is <code>00:23:20:00:00:01</code>.
2234 <column name="bfd" key="bfd_remote_dst_mac">
2235 Set to an Ethernet address in the form
2236 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2237 to set the MAC used for checking the destination of received BFD packets.
2238 Packets with different destination MAC will not be considered as BFD packets.
2239 If not specified the destination MAC address of received BFD packets
2243 <column name="bfd" key="bfd_src_ip">
2244 Set to an IPv4 address to set the IP address used as source for
2245 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2248 <column name="bfd" key="bfd_dst_ip">
2249 Set to an IPv4 address to set the IP address used as destination
2250 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2254 <group title="BFD Status">
2256 The switch sets key-value pairs in the <ref column="bfd_status"/>
2257 column to report the status of BFD on this interface. When BFD is
2258 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2259 all key-value pairs from <ref column="bfd_status"/>.
2262 <column name="bfd_status" key="state"
2263 type='{"type": "string",
2264 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2265 Reports the state of the BFD session. The BFD session is fully
2266 healthy and negotiated if <code>UP</code>.
2269 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2270 Reports whether the BFD session believes this <ref
2271 table="Interface"/> may be used to forward traffic. Typically this
2272 means the local session is signaling <code>UP</code>, and the remote
2273 system isn't signaling a problem such as concatenated path down.
2276 <column name="bfd_status" key="diagnostic">
2277 In case of a problem, set to an error message that reports what the
2278 local BFD session thinks is wrong. The error messages are defined
2279 in section 4.1 of [RFC 5880].
2282 <column name="bfd_status" key="remote_state"
2283 type='{"type": "string",
2284 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2285 Reports the state of the remote endpoint's BFD session.
2288 <column name="bfd_status" key="remote_diagnostic">
2289 In case of a problem, set to an error message that reports what the
2290 remote endpoint's BFD session thinks is wrong. The error messages
2291 are defined in section 4.1 of [RFC 5880].
2294 <column name="bfd_status" key="flap_count"
2295 type='{"type": "integer", "minInteger": 0}'>
2296 Counts the number of <ref column="bfd_status" key="forwarding" />
2297 flaps since start. A flap is considered as a change of the
2298 <ref column="bfd_status" key="forwarding" /> value.
2303 <group title="Connectivity Fault Management">
2305 802.1ag Connectivity Fault Management (CFM) allows a group of
2306 Maintenance Points (MPs) called a Maintenance Association (MA) to
2307 detect connectivity problems with each other. MPs within a MA should
2308 have complete and exclusive interconnectivity. This is verified by
2309 occasionally broadcasting Continuity Check Messages (CCMs) at a
2310 configurable transmission interval.
2314 According to the 802.1ag specification, each Maintenance Point should
2315 be configured out-of-band with a list of Remote Maintenance Points it
2316 should have connectivity to. Open vSwitch differs from the
2317 specification in this area. It simply assumes the link is faulted if
2318 no Remote Maintenance Points are reachable, and considers it not
2323 When operating over tunnels which have no <code>in_key</code>, or an
2324 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2325 with a tunnel key of zero.
2328 <column name="cfm_mpid">
2330 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2331 within a Maintenance Association. The MPID is used to identify this
2332 endpoint to other Maintenance Points in the MA. Each end of a link
2333 being monitored should have a different MPID. Must be configured to
2334 enable CFM on this <ref table="Interface"/>.
2337 According to the 802.1ag specification, MPIDs can only range between
2338 [1, 8191]. However, extended mode (see <ref column="other_config"
2339 key="cfm_extended"/>) supports eight byte MPIDs.
2343 <column name="cfm_flap_count">
2344 Counts the number of cfm fault flapps since boot. A flap is
2345 considered to be a change of the <ref column="cfm_fault"/> value.
2348 <column name="cfm_fault">
2350 Indicates a connectivity fault triggered by an inability to receive
2351 heartbeats from any remote endpoint. When a fault is triggered on
2352 <ref table="Interface"/>s participating in bonds, they will be
2356 Faults can be triggered for several reasons. Most importantly they
2357 are triggered when no CCMs are received for a period of 3.5 times the
2358 transmission interval. Faults are also triggered when any CCMs
2359 indicate that a Remote Maintenance Point is not receiving CCMs but
2360 able to send them. Finally, a fault is triggered if a CCM is
2361 received which indicates unexpected configuration. Notably, this
2362 case arises when a CCM is received which advertises the local MPID.
2366 <column name="cfm_fault_status" key="recv">
2367 Indicates a CFM fault was triggered due to a lack of CCMs received on
2368 the <ref table="Interface"/>.
2371 <column name="cfm_fault_status" key="rdi">
2372 Indicates a CFM fault was triggered due to the reception of a CCM with
2373 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2374 are not receiving CCMs themselves. This typically indicates a
2375 unidirectional connectivity failure.
2378 <column name="cfm_fault_status" key="maid">
2379 Indicates a CFM fault was triggered due to the reception of a CCM with
2380 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2381 with an identification number in addition to the MPID called the MAID.
2382 Open vSwitch only supports receiving CCM broadcasts tagged with the
2383 MAID it uses internally.
2386 <column name="cfm_fault_status" key="loopback">
2387 Indicates a CFM fault was triggered due to the reception of a CCM
2388 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2389 column of this <ref table="Interface"/>. This may indicate a loop in
2393 <column name="cfm_fault_status" key="overflow">
2394 Indicates a CFM fault was triggered because the CFM module received
2395 CCMs from more remote endpoints than it can keep track of.
2398 <column name="cfm_fault_status" key="override">
2399 Indicates a CFM fault was manually triggered by an administrator using
2400 an <code>ovs-appctl</code> command.
2403 <column name="cfm_fault_status" key="interval">
2404 Indicates a CFM fault was triggered due to the reception of a CCM
2405 frame having an invalid interval.
2408 <column name="cfm_remote_opstate">
2409 <p>When in extended mode, indicates the operational state of the
2410 remote endpoint as either <code>up</code> or <code>down</code>. See
2411 <ref column="other_config" key="cfm_opstate"/>.
2415 <column name="cfm_health">
2417 Indicates the health of the interface as a percentage of CCM frames
2418 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2419 The health of an interface is undefined if it is communicating with
2420 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2421 healthy heartbeats are not received at the expected rate, and
2422 gradually improves as healthy heartbeats are received at the desired
2423 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2424 health of the interface is refreshed.
2427 As mentioned above, the faults can be triggered for several reasons.
2428 The link health will deteriorate even if heartbeats are received but
2429 they are reported to be unhealthy. An unhealthy heartbeat in this
2430 context is a heartbeat for which either some fault is set or is out
2431 of sequence. The interface health can be 100 only on receiving
2432 healthy heartbeats at the desired rate.
2436 <column name="cfm_remote_mpids">
2437 When CFM is properly configured, Open vSwitch will occasionally
2438 receive CCM broadcasts. These broadcasts contain the MPID of the
2439 sending Maintenance Point. The list of MPIDs from which this
2440 <ref table="Interface"/> is receiving broadcasts from is regularly
2441 collected and written to this column.
2444 <column name="other_config" key="cfm_interval"
2445 type='{"type": "integer"}'>
2447 The interval, in milliseconds, between transmissions of CFM
2448 heartbeats. Three missed heartbeat receptions indicate a
2453 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2454 60,000, or 600,000 ms are supported. Other values will be rounded
2455 down to the nearest value on the list. Extended mode (see <ref
2456 column="other_config" key="cfm_extended"/>) supports any interval up
2457 to 65,535 ms. In either mode, the default is 1000 ms.
2460 <p>We do not recommend using intervals less than 100 ms.</p>
2463 <column name="other_config" key="cfm_extended"
2464 type='{"type": "boolean"}'>
2465 When <code>true</code>, the CFM module operates in extended mode. This
2466 causes it to use a nonstandard destination address to avoid conflicting
2467 with compliant implementations which may be running concurrently on the
2468 network. Furthermore, extended mode increases the accuracy of the
2469 <code>cfm_interval</code> configuration parameter by breaking wire
2470 compatibility with 802.1ag compliant implementations. And extended
2471 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2474 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2476 When <code>true</code>, and
2477 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2478 module operates in demand mode. When in demand mode, traffic
2479 received on the <ref table="Interface"/> is used to indicate
2480 liveness. CCMs are still transmitted and received. At least one
2481 CCM must be received every 100 * <ref column="other_config"
2482 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2483 are received, the CFM module will raise the connectivity fault.
2487 Demand mode has a couple of caveats:
2490 To ensure that ovs-vswitchd has enough time to pull statistics
2491 from the datapath, the fault detection interval is set to
2492 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2497 To avoid ambiguity, demand mode disables itself when there are
2498 multiple remote maintenance points.
2502 If the <ref table="Interface"/> is heavily congested, CCMs
2503 containing the <ref column="other_config" key="cfm_opstate"/>
2504 status may be dropped causing changes in the operational state to
2505 be delayed. Similarly, if CCMs containing the RDI bit are not
2506 received, unidirectional link failures may not be detected.
2512 <column name="other_config" key="cfm_opstate"
2513 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2514 When <code>down</code>, the CFM module marks all CCMs it generates as
2515 operationally down without triggering a fault. This allows remote
2516 maintenance points to choose not to forward traffic to the
2517 <ref table="Interface"/> on which this CFM module is running.
2518 Currently, in Open vSwitch, the opdown bit of CCMs affects
2519 <ref table="Interface"/>s participating in bonds, and the bundle
2520 OpenFlow action. This setting is ignored when CFM is not in extended
2521 mode. Defaults to <code>up</code>.
2524 <column name="other_config" key="cfm_ccm_vlan"
2525 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2526 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2527 with the given value. May be the string <code>random</code> in which
2528 case each CCM will be tagged with a different randomly generated VLAN.
2531 <column name="other_config" key="cfm_ccm_pcp"
2532 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2533 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2534 with the given PCP value, the VLAN ID of the tag is governed by the
2535 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2536 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2542 <group title="Bonding Configuration">
2543 <column name="other_config" key="lacp-port-id"
2544 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2545 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2546 used in LACP negotiations to identify individual ports
2547 participating in a bond.
2550 <column name="other_config" key="lacp-port-priority"
2551 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2552 The LACP port priority of this <ref table="Interface"/>. In LACP
2553 negotiations <ref table="Interface"/>s with numerically lower
2554 priorities are preferred for aggregation.
2557 <column name="other_config" key="lacp-aggregation-key"
2558 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2559 The LACP aggregation key of this <ref table="Interface"/>. <ref
2560 table="Interface"/>s with different aggregation keys may not be active
2561 within a given <ref table="Port"/> at the same time.
2565 <group title="Virtual Machine Identifiers">
2567 These key-value pairs specifically apply to an interface that
2568 represents a virtual Ethernet interface connected to a virtual
2569 machine. These key-value pairs should not be present for other types
2570 of interfaces. Keys whose names end in <code>-uuid</code> have
2571 values that uniquely identify the entity in question. For a Citrix
2572 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2573 Other hypervisors may use other formats.
2576 <column name="external_ids" key="attached-mac">
2577 The MAC address programmed into the ``virtual hardware'' for this
2578 interface, in the form
2579 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2580 For Citrix XenServer, this is the value of the <code>MAC</code> field
2581 in the VIF record for this interface.
2584 <column name="external_ids" key="iface-id">
2585 A system-unique identifier for the interface. On XenServer, this will
2586 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2589 <column name="external_ids" key="iface-status"
2590 type='{"type": "string",
2591 "enum": ["set", ["active", "inactive"]]}'>
2593 Hypervisors may sometimes have more than one interface associated
2594 with a given <ref column="external_ids" key="iface-id"/>, only one of
2595 which is actually in use at a given time. For example, in some
2596 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2597 for a single <ref column="external_ids" key="iface-id"/>, but only
2598 uses one of them at a time. A hypervisor that behaves this way must
2599 mark the currently in use interface <code>active</code> and the
2600 others <code>inactive</code>. A hypervisor that never has more than
2601 one interface for a given <ref column="external_ids" key="iface-id"/>
2602 may mark that interface <code>active</code> or omit <ref
2603 column="external_ids" key="iface-status"/> entirely.
2607 During VM migration, a given <ref column="external_ids"
2608 key="iface-id"/> might transiently be marked <code>active</code> on
2609 two different hypervisors. That is, <code>active</code> means that
2610 this <ref column="external_ids" key="iface-id"/> is the active
2611 instance within a single hypervisor, not in a broader scope.
2612 There is one exception: some hypervisors support ``migration'' from a
2613 given hypervisor to itself (most often for test purposes). During
2614 such a ``migration,'' two instances of a single <ref
2615 column="external_ids" key="iface-id"/> might both be briefly marked
2616 <code>active</code> on a single hypervisor.
2620 <column name="external_ids" key="xs-vif-uuid">
2621 The virtual interface associated with this interface.
2624 <column name="external_ids" key="xs-network-uuid">
2625 The virtual network to which this interface is attached.
2628 <column name="external_ids" key="vm-id">
2629 The VM to which this interface belongs. On XenServer, this will be the
2630 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2633 <column name="external_ids" key="xs-vm-uuid">
2634 The VM to which this interface belongs.
2638 <group title="VLAN Splinters">
2640 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2641 with buggy network drivers in old versions of Linux that do not
2642 properly support VLANs when VLAN devices are not used, at some cost
2643 in memory and performance.
2647 When VLAN splinters are enabled on a particular interface, Open vSwitch
2648 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2649 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2650 received on the VLAN device is treated as if it had been received on
2651 the interface on the particular VLAN.
2655 VLAN splinters consider a VLAN to be in use if:
2660 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2661 table="Port"/> record.
2665 The VLAN is listed within the <ref table="Port" column="trunks"/>
2666 column of the <ref table="Port"/> record of an interface on which
2667 VLAN splinters are enabled.
2669 An empty <ref table="Port" column="trunks"/> does not influence the
2670 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2671 will exceed the current 1,024 port per datapath limit.
2675 An OpenFlow flow within any bridge matches the VLAN.
2680 The same set of in-use VLANs applies to every interface on which VLAN
2681 splinters are enabled. That is, the set is not chosen separately for
2682 each interface but selected once as the union of all in-use VLANs based
2687 It does not make sense to enable VLAN splinters on an interface for an
2688 access port, or on an interface that is not a physical port.
2692 VLAN splinters are deprecated. When broken device drivers are no
2693 longer in widespread use, we will delete this feature.
2696 <column name="other_config" key="enable-vlan-splinters"
2697 type='{"type": "boolean"}'>
2699 Set to <code>true</code> to enable VLAN splinters on this interface.
2700 Defaults to <code>false</code>.
2704 VLAN splinters increase kernel and userspace memory overhead, so do
2705 not use them unless they are needed.
2709 VLAN splinters do not support 802.1p priority tags. Received
2710 priorities will appear to be 0, regardless of their actual values,
2711 and priorities on transmitted packets will also be cleared to 0.
2716 <group title="Common Columns">
2717 The overall purpose of these columns is described under <code>Common
2718 Columns</code> at the beginning of this document.
2720 <column name="other_config"/>
2721 <column name="external_ids"/>
2725 <table name="Flow_Table" title="OpenFlow table configuration">
2726 <p>Configuration for a particular OpenFlow table.</p>
2728 <column name="name">
2729 The table's name. Set this column to change the name that controllers
2730 will receive when they request table statistics, e.g. <code>ovs-ofctl
2731 dump-tables</code>. The name does not affect switch behavior.
2734 <column name="flow_limit">
2735 If set, limits the number of flows that may be added to the table. Open
2736 vSwitch may limit the number of flows in a table for other reasons,
2737 e.g. due to hardware limitations or for resource availability or
2738 performance reasons.
2741 <column name="overflow_policy">
2743 Controls the switch's behavior when an OpenFlow flow table modification
2744 request would add flows in excess of <ref column="flow_limit"/>. The
2745 supported values are:
2749 <dt><code>refuse</code></dt>
2751 Refuse to add the flow or flows. This is also the default policy
2752 when <ref column="overflow_policy"/> is unset.
2755 <dt><code>evict</code></dt>
2757 Delete the flow that will expire soonest. See <ref column="groups"/>
2763 <column name="groups">
2765 When <ref column="overflow_policy"/> is <code>evict</code>, this
2766 controls how flows are chosen for eviction when the flow table would
2767 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2768 of NXM fields or sub-fields, each of which takes one of the forms
2769 <code><var>field</var>[]</code> or
2770 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2771 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2772 <code>nicira-ext.h</code> for a complete list of NXM field names.
2776 When a flow must be evicted due to overflow, the flow to evict is
2777 chosen through an approximation of the following algorithm:
2782 Divide the flows in the table into groups based on the values of the
2783 specified fields or subfields, so that all of the flows in a given
2784 group have the same values for those fields. If a flow does not
2785 specify a given field, that field's value is treated as 0.
2789 Consider the flows in the largest group, that is, the group that
2790 contains the greatest number of flows. If two or more groups all
2791 have the same largest number of flows, consider the flows in all of
2796 Among the flows under consideration, choose the flow that expires
2797 soonest for eviction.
2802 The eviction process only considers flows that have an idle timeout or
2803 a hard timeout. That is, eviction never deletes permanent flows.
2804 (Permanent flows do count against <ref column="flow_limit"/>.)
2808 Open vSwitch ignores any invalid or unknown field specifications.
2812 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2813 column has no effect.
2817 <column name="prefixes">
2819 This string set specifies which fields should be used for
2820 address prefix tracking. Prefix tracking allows the
2821 classifier to skip rules with longer than necessary prefixes,
2822 resulting in better wildcarding for datapath flows.
2825 Prefix tracking may be beneficial when a flow table contains
2826 matches on IP address fields with different prefix lengths.
2827 For example, when a flow table contains IP address matches on
2828 both full addresses and proper prefixes, the full address
2829 matches will typically cause the datapath flow to un-wildcard
2830 the whole address field (depending on flow entry priorities).
2831 In this case each packet with a different address gets handed
2832 to the userspace for flow processing and generates its own
2833 datapath flow. With prefix tracking enabled for the address
2834 field in question packets with addresses matching shorter
2835 prefixes would generate datapath flows where the irrelevant
2836 address bits are wildcarded, allowing the same datapath flow
2837 to handle all the packets within the prefix in question. In
2838 this case many userspace upcalls can be avoided and the
2839 overall performance can be better.
2842 This is a performance optimization only, so packets will
2843 receive the same treatment with or without prefix tracking.
2846 The supported fields are: <code>tun_id</code>,
2847 <code>tun_src</code>, <code>tun_dst</code>,
2848 <code>nw_src</code>, <code>nw_dst</code> (or aliases
2849 <code>ip_src</code> and <code>ip_dst</code>),
2850 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
2851 feature for <code>tun_id</code> would only make sense if the
2852 tunnel IDs have prefix structure similar to IP addresses.)
2856 By default, the <code>prefixes=ip_dst,ip_src</code> are used
2857 on each flow table. This instructs the flow classifier to
2858 track the IP destination and source addresses used by the
2859 rules in this specific flow table.
2863 The keyword <code>none</code> is recognized as an explicit
2864 override of the default values, causing no prefix fields to be
2869 To set the prefix fields, the flow table record needs to
2874 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
2876 Creates a flow table record for the OpenFlow table number 0.
2879 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
2881 Enables prefix tracking for IP source and destination
2887 There is a maximum number of fields that can be enabled for any
2888 one flow table. Currently this limit is 3.
2892 <group title="Common Columns">
2893 The overall purpose of these columns is described under <code>Common
2894 Columns</code> at the beginning of this document.
2896 <column name="external_ids"/>
2900 <table name="QoS" title="Quality of Service configuration">
2901 <p>Quality of Service (QoS) configuration for each Port that
2904 <column name="type">
2905 <p>The type of QoS to implement. The currently defined types are
2908 <dt><code>linux-htb</code></dt>
2910 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2911 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2912 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2913 for information on how this classifier works and how to configure it.
2917 <dt><code>linux-hfsc</code></dt>
2919 Linux "Hierarchical Fair Service Curve" classifier.
2920 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2921 information on how this classifier works.
2926 <column name="queues">
2927 <p>A map from queue numbers to <ref table="Queue"/> records. The
2928 supported range of queue numbers depend on <ref column="type"/>. The
2929 queue numbers are the same as the <code>queue_id</code> used in
2930 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2934 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2935 actions when no specific queue has been set. When no configuration for
2936 queue 0 is present, it is automatically configured as if a <ref
2937 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2938 and <ref table="Queue" column="other_config"/> columns had been
2940 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2941 this case. With some queuing disciplines, this dropped all packets
2942 destined for the default queue.)
2946 <group title="Configuration for linux-htb and linux-hfsc">
2948 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2949 the following key-value pair:
2952 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2953 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2954 specified, for physical interfaces, the default is the link rate. For
2955 other interfaces or if the link rate cannot be determined, the default
2956 is currently 100 Mbps.
2960 <group title="Common Columns">
2961 The overall purpose of these columns is described under <code>Common
2962 Columns</code> at the beginning of this document.
2964 <column name="other_config"/>
2965 <column name="external_ids"/>
2969 <table name="Queue" title="QoS output queue.">
2970 <p>A configuration for a port output queue, used in configuring Quality of
2971 Service (QoS) features. May be referenced by <ref column="queues"
2972 table="QoS"/> column in <ref table="QoS"/> table.</p>
2974 <column name="dscp">
2975 If set, Open vSwitch will mark all traffic egressing this
2976 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2977 default <ref table="Queue"/> is only marked if it was explicitly selected
2978 as the <ref table="Queue"/> at the time the packet was output. If unset,
2979 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2983 <group title="Configuration for linux-htb QoS">
2985 <ref table="QoS"/> <ref table="QoS" column="type"/>
2986 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2987 It has the following key-value pairs defined.
2990 <column name="other_config" key="min-rate"
2991 type='{"type": "integer", "minInteger": 1}'>
2992 Minimum guaranteed bandwidth, in bit/s.
2995 <column name="other_config" key="max-rate"
2996 type='{"type": "integer", "minInteger": 1}'>
2997 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2998 queue's rate will not be allowed to exceed the specified value, even
2999 if excess bandwidth is available. If unspecified, defaults to no
3003 <column name="other_config" key="burst"
3004 type='{"type": "integer", "minInteger": 1}'>
3005 Burst size, in bits. This is the maximum amount of ``credits'' that a
3006 queue can accumulate while it is idle. Optional. Details of the
3007 <code>linux-htb</code> implementation require a minimum burst size, so
3008 a too-small <code>burst</code> will be silently ignored.
3011 <column name="other_config" key="priority"
3012 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3013 A queue with a smaller <code>priority</code> will receive all the
3014 excess bandwidth that it can use before a queue with a larger value
3015 receives any. Specific priority values are unimportant; only relative
3016 ordering matters. Defaults to 0 if unspecified.
3020 <group title="Configuration for linux-hfsc QoS">
3022 <ref table="QoS"/> <ref table="QoS" column="type"/>
3023 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3024 It has the following key-value pairs defined.
3027 <column name="other_config" key="min-rate"
3028 type='{"type": "integer", "minInteger": 1}'>
3029 Minimum guaranteed bandwidth, in bit/s.
3032 <column name="other_config" key="max-rate"
3033 type='{"type": "integer", "minInteger": 1}'>
3034 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3035 queue's rate will not be allowed to exceed the specified value, even if
3036 excess bandwidth is available. If unspecified, defaults to no
3041 <group title="Common Columns">
3042 The overall purpose of these columns is described under <code>Common
3043 Columns</code> at the beginning of this document.
3045 <column name="other_config"/>
3046 <column name="external_ids"/>
3050 <table name="Mirror" title="Port mirroring.">
3051 <p>A port mirror within a <ref table="Bridge"/>.</p>
3052 <p>A port mirror configures a bridge to send selected frames to special
3053 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3054 traffic may also be referred to as SPAN or RSPAN, depending on how
3055 the mirrored traffic is sent.</p>
3057 <column name="name">
3058 Arbitrary identifier for the <ref table="Mirror"/>.
3061 <group title="Selecting Packets for Mirroring">
3063 To be selected for mirroring, a given packet must enter or leave the
3064 bridge through a selected port and it must also be in one of the
3068 <column name="select_all">
3069 If true, every packet arriving or departing on any port is
3070 selected for mirroring.
3073 <column name="select_dst_port">
3074 Ports on which departing packets are selected for mirroring.
3077 <column name="select_src_port">
3078 Ports on which arriving packets are selected for mirroring.
3081 <column name="select_vlan">
3082 VLANs on which packets are selected for mirroring. An empty set
3083 selects packets on all VLANs.
3087 <group title="Mirroring Destination Configuration">
3089 These columns are mutually exclusive. Exactly one of them must be
3093 <column name="output_port">
3094 <p>Output port for selected packets, if nonempty.</p>
3095 <p>Specifying a port for mirror output reserves that port exclusively
3096 for mirroring. No frames other than those selected for mirroring
3098 will be forwarded to the port, and any frames received on the port
3099 will be discarded.</p>
3101 The output port may be any kind of port supported by Open vSwitch.
3102 It may be, for example, a physical port (sometimes called SPAN) or a
3107 <column name="output_vlan">
3108 <p>Output VLAN for selected packets, if nonempty.</p>
3109 <p>The frames will be sent out all ports that trunk
3110 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3111 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3112 trunk port, the frame's VLAN tag will be set to
3113 <ref column="output_vlan"/>, replacing any existing tag; when it is
3114 sent out an implicit VLAN port, the frame will not be tagged. This
3115 type of mirroring is sometimes called RSPAN.</p>
3117 See the documentation for
3118 <ref column="other_config" key="forward-bpdu"/> in the
3119 <ref table="Interface"/> table for a list of destination MAC
3120 addresses which will not be mirrored to a VLAN to avoid confusing
3121 switches that interpret the protocols that they represent.
3123 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3124 contains unmanaged switches. Consider an unmanaged physical switch
3125 with two ports: port 1, connected to an end host, and port 2,
3126 connected to an Open vSwitch configured to mirror received packets
3127 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3128 port 1 that the physical switch forwards to port 2. The Open vSwitch
3129 forwards this packet to its destination and then reflects it back on
3130 port 2 in VLAN 123. This reflected packet causes the unmanaged
3131 physical switch to replace the MAC learning table entry, which
3132 correctly pointed to port 1, with one that incorrectly points to port
3133 2. Afterward, the physical switch will direct packets destined for
3134 the end host to the Open vSwitch on port 2, instead of to the end
3135 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3136 desired in this scenario, then the physical switch must be replaced
3137 by one that learns Ethernet addresses on a per-VLAN basis. In
3138 addition, learning should be disabled on the VLAN containing mirrored
3139 traffic. If this is not done then intermediate switches will learn
3140 the MAC address of each end host from the mirrored traffic. If
3141 packets being sent to that end host are also mirrored, then they will
3142 be dropped since the switch will attempt to send them out the input
3143 port. Disabling learning for the VLAN will cause the switch to
3144 correctly send the packet out all ports configured for that VLAN. If
3145 Open vSwitch is being used as an intermediate switch, learning can be
3146 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3147 in the appropriate <ref table="Bridge"/> table or tables.</p>
3149 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3150 VLAN and should generally be preferred.
3155 <group title="Statistics: Mirror counters">
3157 Key-value pairs that report mirror statistics. The update period
3158 is controlled by <ref column="other_config"
3159 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3161 <column name="statistics" key="tx_packets">
3162 Number of packets transmitted through this mirror.
3164 <column name="statistics" key="tx_bytes">
3165 Number of bytes transmitted through this mirror.
3169 <group title="Common Columns">
3170 The overall purpose of these columns is described under <code>Common
3171 Columns</code> at the beginning of this document.
3173 <column name="external_ids"/>
3177 <table name="Controller" title="OpenFlow controller configuration.">
3178 <p>An OpenFlow controller.</p>
3181 Open vSwitch supports two kinds of OpenFlow controllers:
3185 <dt>Primary controllers</dt>
3188 This is the kind of controller envisioned by the OpenFlow 1.0
3189 specification. Usually, a primary controller implements a network
3190 policy by taking charge of the switch's flow table.
3194 Open vSwitch initiates and maintains persistent connections to
3195 primary controllers, retrying the connection each time it fails or
3196 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3197 <ref table="Bridge"/> table applies to primary controllers.
3201 Open vSwitch permits a bridge to have any number of primary
3202 controllers. When multiple controllers are configured, Open
3203 vSwitch connects to all of them simultaneously. Because
3204 OpenFlow 1.0 does not specify how multiple controllers
3205 coordinate in interacting with a single switch, more than
3206 one primary controller should be specified only if the
3207 controllers are themselves designed to coordinate with each
3208 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3209 vendor extension may be useful for this.)
3212 <dt>Service controllers</dt>
3215 These kinds of OpenFlow controller connections are intended for
3216 occasional support and maintenance use, e.g. with
3217 <code>ovs-ofctl</code>. Usually a service controller connects only
3218 briefly to inspect or modify some of a switch's state.
3222 Open vSwitch listens for incoming connections from service
3223 controllers. The service controllers initiate and, if necessary,
3224 maintain the connections from their end. The <ref table="Bridge"
3225 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3226 not apply to service controllers.
3230 Open vSwitch supports configuring any number of service controllers.
3236 The <ref column="target"/> determines the type of controller.
3239 <group title="Core Features">
3240 <column name="target">
3241 <p>Connection method for controller.</p>
3243 The following connection methods are currently supported for primary
3247 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3249 <p>The specified SSL <var>port</var> on the host at the
3250 given <var>ip</var>, which must be expressed as an IP
3251 address (not a DNS name). The <ref table="Open_vSwitch"
3252 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3253 table must point to a valid SSL configuration when this form
3255 <p>If <var>port</var> is not specified, it currently
3256 defaults to 6633. In the future, the default will change to
3257 6653, which is the IANA-defined value.</p>
3258 <p>SSL support is an optional feature that is not always built as
3259 part of Open vSwitch.</p>
3261 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3264 The specified TCP <var>port</var> on the host at the given
3265 <var>ip</var>, which must be expressed as an IP address (not a
3266 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3267 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3268 e.g. <code>tcp:[::1]:6632</code>.
3271 If <var>port</var> is not specified, it currently defaults to
3272 6633. In the future, the default will change to 6653, which is
3273 the IANA-defined value.
3278 The following connection methods are currently supported for service
3282 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3285 Listens for SSL connections on the specified TCP <var>port</var>.
3286 If <var>ip</var>, which must be expressed as an IP address (not a
3287 DNS name), is specified, then connections are restricted to the
3288 specified local IP address (either IPv4 or IPv6). If
3289 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3290 e.g. <code>pssl:6632:[::1]</code>.
3293 If <var>port</var> is not specified, it currently defaults to
3294 6633. If <var>ip</var> is not specified then it listens only on
3295 IPv4 (but not IPv6) addresses. The
3296 <ref table="Open_vSwitch" column="ssl"/>
3297 column in the <ref table="Open_vSwitch"/> table must point to a
3298 valid SSL configuration when this form is used.
3301 If <var>port</var> is not specified, it currently defaults to
3302 6633. In the future, the default will change to 6653, which is
3303 the IANA-defined value.
3306 SSL support is an optional feature that is not always built as
3307 part of Open vSwitch.
3310 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3313 Listens for connections on the specified TCP <var>port</var>. If
3314 <var>ip</var>, which must be expressed as an IP address (not a
3315 DNS name), is specified, then connections are restricted to the
3316 specified local IP address (either IPv4 or IPv6). If
3317 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3318 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3319 specified then it listens only on IPv4 addresses.
3322 If <var>port</var> is not specified, it currently defaults to
3323 6633. In the future, the default will change to 6653, which is
3324 the IANA-defined value.
3328 <p>When multiple controllers are configured for a single bridge, the
3329 <ref column="target"/> values must be unique. Duplicate
3330 <ref column="target"/> values yield unspecified results.</p>
3333 <column name="connection_mode">
3334 <p>If it is specified, this setting must be one of the following
3335 strings that describes how Open vSwitch contacts this OpenFlow
3336 controller over the network:</p>
3339 <dt><code>in-band</code></dt>
3340 <dd>In this mode, this controller's OpenFlow traffic travels over the
3341 bridge associated with the controller. With this setting, Open
3342 vSwitch allows traffic to and from the controller regardless of the
3343 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3344 would never be able to connect to the controller, because it did
3345 not have a flow to enable it.) This is the most common connection
3346 mode because it is not necessary to maintain two independent
3348 <dt><code>out-of-band</code></dt>
3349 <dd>In this mode, OpenFlow traffic uses a control network separate
3350 from the bridge associated with this controller, that is, the
3351 bridge does not use any of its own network devices to communicate
3352 with the controller. The control network must be configured
3353 separately, before or after <code>ovs-vswitchd</code> is started.
3357 <p>If not specified, the default is implementation-specific.</p>
3361 <group title="Controller Failure Detection and Handling">
3362 <column name="max_backoff">
3363 Maximum number of milliseconds to wait between connection attempts.
3364 Default is implementation-specific.
3367 <column name="inactivity_probe">
3368 Maximum number of milliseconds of idle time on connection to
3369 controller before sending an inactivity probe message. If Open
3370 vSwitch does not communicate with the controller for the specified
3371 number of seconds, it will send a probe. If a response is not
3372 received for the same additional amount of time, Open vSwitch
3373 assumes the connection has been broken and attempts to reconnect.
3374 Default is implementation-specific. A value of 0 disables
3379 <group title="Asynchronous Messages">
3381 OpenFlow switches send certain messages to controllers spontanenously,
3382 that is, not in response to any request from the controller. These
3383 messages are called ``asynchronous messages.'' These columns allow
3384 asynchronous messages to be limited or disabled to ensure the best use
3385 of network resources.
3388 <column name="enable_async_messages">
3389 The OpenFlow protocol enables asynchronous messages at time of
3390 connection establishment, which means that a controller can receive
3391 asynchronous messages, potentially many of them, even if it turns them
3392 off immediately after connecting. Set this column to
3393 <code>false</code> to change Open vSwitch behavior to disable, by
3394 default, all asynchronous messages. The controller can use the
3395 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3396 on any messages that it does want to receive, if any.
3399 <group title="Controller Rate Limiting">
3401 A switch can forward packets to a controller over the OpenFlow
3402 protocol. Forwarding packets this way at too high a rate can
3403 overwhelm a controller, frustrate use of the OpenFlow connection for
3404 other purposes, increase the latency of flow setup, and use an
3405 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3406 limiting the rate of packet forwarding to a controller.
3410 There are two main reasons in OpenFlow for a packet to be sent to a
3411 controller: either the packet ``misses'' in the flow table, that is,
3412 there is no matching flow, or a flow table action says to send the
3413 packet to the controller. Open vSwitch limits the rate of each kind
3414 of packet separately at the configured rate. Therefore, the actual
3415 rate that packets are sent to the controller can be up to twice the
3416 configured rate, when packets are sent for both reasons.
3420 This feature is specific to forwarding packets over an OpenFlow
3421 connection. It is not general-purpose QoS. See the <ref
3422 table="QoS"/> table for quality of service configuration, and <ref
3423 column="ingress_policing_rate" table="Interface"/> in the <ref
3424 table="Interface"/> table for ingress policing configuration.
3427 <column name="controller_rate_limit">
3429 The maximum rate at which the switch will forward packets to the
3430 OpenFlow controller, in packets per second. If no value is
3431 specified, rate limiting is disabled.
3435 <column name="controller_burst_limit">
3437 When a high rate triggers rate-limiting, Open vSwitch queues
3438 packets to the controller for each port and transmits them to the
3439 controller at the configured rate. This value limits the number of
3440 queued packets. Ports on a bridge share the packet queue fairly.
3444 This value has no effect unless <ref
3445 column="controller_rate_limit"/> is configured. The current
3446 default when this value is not specified is one-quarter of <ref
3447 column="controller_rate_limit"/>, meaning that queuing can delay
3448 forwarding a packet to the controller by up to 250 ms.
3452 <group title="Controller Rate Limiting Statistics">
3454 These values report the effects of rate limiting. Their values are
3455 relative to establishment of the most recent OpenFlow connection,
3456 or since rate limiting was enabled, whichever happened more
3457 recently. Each consists of two values, one with <code>TYPE</code>
3458 replaced by <code>miss</code> for rate limiting flow table misses,
3459 and the other with <code>TYPE</code> replaced by
3460 <code>action</code> for rate limiting packets sent by OpenFlow
3465 These statistics are reported only when controller rate limiting is
3469 <column name="status" key="packet-in-TYPE-bypassed"
3470 type='{"type": "integer", "minInteger": 0}'>
3471 Number of packets sent directly to the controller, without queuing,
3472 because the rate did not exceed the configured maximum.
3475 <column name="status" key="packet-in-TYPE-queued"
3476 type='{"type": "integer", "minInteger": 0}'>
3477 Number of packets added to the queue to send later.
3480 <column name="status" key="packet-in-TYPE-dropped"
3481 type='{"type": "integer", "minInteger": 0}'>
3482 Number of packets added to the queue that were later dropped due to
3483 overflow. This value is less than or equal to <ref column="status"
3484 key="packet-in-TYPE-queued"/>.
3487 <column name="status" key="packet-in-TYPE-backlog"
3488 type='{"type": "integer", "minInteger": 0}'>
3489 Number of packets currently queued. The other statistics increase
3490 monotonically, but this one fluctuates between 0 and the <ref
3491 column="controller_burst_limit"/> as conditions change.
3497 <group title="Additional In-Band Configuration">
3498 <p>These values are considered only in in-band control mode (see
3499 <ref column="connection_mode"/>).</p>
3501 <p>When multiple controllers are configured on a single bridge, there
3502 should be only one set of unique values in these columns. If different
3503 values are set for these columns in different controllers, the effect
3506 <column name="local_ip">
3507 The IP address to configure on the local port,
3508 e.g. <code>192.168.0.123</code>. If this value is unset, then
3509 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3513 <column name="local_netmask">
3514 The IP netmask to configure on the local port,
3515 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3516 but this value is unset, then the default is chosen based on whether
3517 the IP address is class A, B, or C.
3520 <column name="local_gateway">
3521 The IP address of the gateway to configure on the local port, as a
3522 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3523 this network has no gateway.
3527 <group title="Controller Status">
3528 <column name="is_connected">
3529 <code>true</code> if currently connected to this controller,
3530 <code>false</code> otherwise.
3534 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3535 <p>The level of authority this controller has on the associated
3536 bridge. Possible values are:</p>
3538 <dt><code>other</code></dt>
3539 <dd>Allows the controller access to all OpenFlow features.</dd>
3540 <dt><code>master</code></dt>
3541 <dd>Equivalent to <code>other</code>, except that there may be at
3542 most one master controller at a time. When a controller configures
3543 itself as <code>master</code>, any existing master is demoted to
3544 the <code>slave</code> role.</dd>
3545 <dt><code>slave</code></dt>
3546 <dd>Allows the controller read-only access to OpenFlow features.
3547 Attempts to modify the flow table will be rejected with an
3548 error. Slave controllers do not receive OFPT_PACKET_IN or
3549 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3554 <column name="status" key="last_error">
3555 A human-readable description of the last error on the connection
3556 to the controller; i.e. <code>strerror(errno)</code>. This key
3557 will exist only if an error has occurred.
3560 <column name="status" key="state"
3561 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3563 The state of the connection to the controller:
3566 <dt><code>VOID</code></dt>
3567 <dd>Connection is disabled.</dd>
3569 <dt><code>BACKOFF</code></dt>
3570 <dd>Attempting to reconnect at an increasing period.</dd>
3572 <dt><code>CONNECTING</code></dt>
3573 <dd>Attempting to connect.</dd>
3575 <dt><code>ACTIVE</code></dt>
3576 <dd>Connected, remote host responsive.</dd>
3578 <dt><code>IDLE</code></dt>
3579 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3582 These values may change in the future. They are provided only for
3587 <column name="status" key="sec_since_connect"
3588 type='{"type": "integer", "minInteger": 0}'>
3589 The amount of time since this controller last successfully connected to
3590 the switch (in seconds). Value is empty if controller has never
3591 successfully connected.
3594 <column name="status" key="sec_since_disconnect"
3595 type='{"type": "integer", "minInteger": 1}'>
3596 The amount of time since this controller last disconnected from
3597 the switch (in seconds). Value is empty if controller has never
3602 <group title="Connection Parameters">
3604 Additional configuration for a connection between the controller
3605 and the Open vSwitch.
3608 <column name="other_config" key="dscp"
3609 type='{"type": "integer"}'>
3610 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3611 in the Type of Service (TOS) field in the IP header. DSCP provides a
3612 mechanism to classify the network traffic and provide Quality of
3613 Service (QoS) on IP networks.
3615 The DSCP value specified here is used when establishing the connection
3616 between the controller and the Open vSwitch. If no value is specified,
3617 a default value of 48 is chosen. Valid DSCP values must be in the
3623 <group title="Common Columns">
3624 The overall purpose of these columns is described under <code>Common
3625 Columns</code> at the beginning of this document.
3627 <column name="external_ids"/>
3628 <column name="other_config"/>
3632 <table name="Manager" title="OVSDB management connection.">
3634 Configuration for a database connection to an Open vSwitch database
3639 This table primarily configures the Open vSwitch database
3640 (<code>ovsdb-server</code>), not the Open vSwitch switch
3641 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3642 what connections should be treated as in-band.
3646 The Open vSwitch database server can initiate and maintain active
3647 connections to remote clients. It can also listen for database
3651 <group title="Core Features">
3652 <column name="target">
3653 <p>Connection method for managers.</p>
3655 The following connection methods are currently supported:
3658 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3661 The specified SSL <var>port</var> on the host at the given
3662 <var>ip</var>, which must be expressed as an IP address
3663 (not a DNS name). The <ref table="Open_vSwitch"
3664 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3665 table must point to a valid SSL configuration when this
3669 If <var>port</var> is not specified, it currently defaults
3670 to 6632. In the future, the default will change to 6640,
3671 which is the IANA-defined value.
3674 SSL support is an optional feature that is not always
3675 built as part of Open vSwitch.
3679 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3682 The specified TCP <var>port</var> on the host at the given
3683 <var>ip</var>, which must be expressed as an IP address (not a
3684 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3685 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3686 e.g. <code>tcp:[::1]:6632</code>.
3689 If <var>port</var> is not specified, it currently defaults
3690 to 6632. In the future, the default will change to 6640,
3691 which is the IANA-defined value.
3694 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3697 Listens for SSL connections on the specified TCP <var>port</var>.
3698 Specify 0 for <var>port</var> to have the kernel automatically
3699 choose an available port. If <var>ip</var>, which must be
3700 expressed as an IP address (not a DNS name), is specified, then
3701 connections are restricted to the specified local IP address
3702 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3703 address, wrap in square brackets,
3704 e.g. <code>pssl:6632:[::1]</code>. If <var>ip</var> is not
3705 specified then it listens only on IPv4 (but not IPv6) addresses.
3706 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3707 table="Open_vSwitch"/> table must point to a valid SSL
3708 configuration when this form is used.
3711 If <var>port</var> is not specified, it currently defaults
3712 to 6632. In the future, the default will change to 6640,
3713 which is the IANA-defined value.
3716 SSL support is an optional feature that is not always built as
3717 part of Open vSwitch.
3720 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3723 Listens for connections on the specified TCP <var>port</var>.
3724 Specify 0 for <var>port</var> to have the kernel automatically
3725 choose an available port. If <var>ip</var>, which must be
3726 expressed as an IP address (not a DNS name), is specified, then
3727 connections are restricted to the specified local IP address
3728 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3729 address, wrap it in square brackets,
3730 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3731 specified then it listens only on IPv4 addresses.
3734 If <var>port</var> is not specified, it currently defaults
3735 to 6632. In the future, the default will change to 6640,
3736 which is the IANA-defined value.
3740 <p>When multiple managers are configured, the <ref column="target"/>
3741 values must be unique. Duplicate <ref column="target"/> values yield
3742 unspecified results.</p>
3745 <column name="connection_mode">
3747 If it is specified, this setting must be one of the following strings
3748 that describes how Open vSwitch contacts this OVSDB client over the
3753 <dt><code>in-band</code></dt>
3755 In this mode, this connection's traffic travels over a bridge
3756 managed by Open vSwitch. With this setting, Open vSwitch allows
3757 traffic to and from the client regardless of the contents of the
3758 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3759 to connect to the client, because it did not have a flow to enable
3760 it.) This is the most common connection mode because it is not
3761 necessary to maintain two independent networks.
3763 <dt><code>out-of-band</code></dt>
3765 In this mode, the client's traffic uses a control network separate
3766 from that managed by Open vSwitch, that is, Open vSwitch does not
3767 use any of its own network devices to communicate with the client.
3768 The control network must be configured separately, before or after
3769 <code>ovs-vswitchd</code> is started.
3774 If not specified, the default is implementation-specific.
3779 <group title="Client Failure Detection and Handling">
3780 <column name="max_backoff">
3781 Maximum number of milliseconds to wait between connection attempts.
3782 Default is implementation-specific.
3785 <column name="inactivity_probe">
3786 Maximum number of milliseconds of idle time on connection to the client
3787 before sending an inactivity probe message. If Open vSwitch does not
3788 communicate with the client for the specified number of seconds, it
3789 will send a probe. If a response is not received for the same
3790 additional amount of time, Open vSwitch assumes the connection has been
3791 broken and attempts to reconnect. Default is implementation-specific.
3792 A value of 0 disables inactivity probes.
3796 <group title="Status">
3797 <column name="is_connected">
3798 <code>true</code> if currently connected to this manager,
3799 <code>false</code> otherwise.
3802 <column name="status" key="last_error">
3803 A human-readable description of the last error on the connection
3804 to the manager; i.e. <code>strerror(errno)</code>. This key
3805 will exist only if an error has occurred.
3808 <column name="status" key="state"
3809 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3811 The state of the connection to the manager:
3814 <dt><code>VOID</code></dt>
3815 <dd>Connection is disabled.</dd>
3817 <dt><code>BACKOFF</code></dt>
3818 <dd>Attempting to reconnect at an increasing period.</dd>
3820 <dt><code>CONNECTING</code></dt>
3821 <dd>Attempting to connect.</dd>
3823 <dt><code>ACTIVE</code></dt>
3824 <dd>Connected, remote host responsive.</dd>
3826 <dt><code>IDLE</code></dt>
3827 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3830 These values may change in the future. They are provided only for
3835 <column name="status" key="sec_since_connect"
3836 type='{"type": "integer", "minInteger": 0}'>
3837 The amount of time since this manager last successfully connected
3838 to the database (in seconds). Value is empty if manager has never
3839 successfully connected.
3842 <column name="status" key="sec_since_disconnect"
3843 type='{"type": "integer", "minInteger": 0}'>
3844 The amount of time since this manager last disconnected from the
3845 database (in seconds). Value is empty if manager has never
3849 <column name="status" key="locks_held">
3850 Space-separated list of the names of OVSDB locks that the connection
3851 holds. Omitted if the connection does not hold any locks.
3854 <column name="status" key="locks_waiting">
3855 Space-separated list of the names of OVSDB locks that the connection is
3856 currently waiting to acquire. Omitted if the connection is not waiting
3860 <column name="status" key="locks_lost">
3861 Space-separated list of the names of OVSDB locks that the connection
3862 has had stolen by another OVSDB client. Omitted if no locks have been
3863 stolen from this connection.
3866 <column name="status" key="n_connections"
3867 type='{"type": "integer", "minInteger": 2}'>
3869 When <ref column="target"/> specifies a connection method that
3870 listens for inbound connections (e.g. <code>ptcp:</code> or
3871 <code>pssl:</code>) and more than one connection is actually active,
3872 the value is the number of active connections. Otherwise, this
3873 key-value pair is omitted.
3876 When multiple connections are active, status columns and key-value
3877 pairs (other than this one) report the status of one arbitrarily
3882 <column name="status" key="bound_port" type='{"type": "integer"}'>
3883 When <ref column="target"/> is <code>ptcp:</code> or
3884 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3885 listening. (This is is particularly useful when <ref
3886 column="target"/> specifies a port of 0, allowing the kernel to
3887 choose any available port.)
3891 <group title="Connection Parameters">
3893 Additional configuration for a connection between the manager
3894 and the Open vSwitch Database.
3897 <column name="other_config" key="dscp"
3898 type='{"type": "integer"}'>
3899 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3900 in the Type of Service (TOS) field in the IP header. DSCP provides a
3901 mechanism to classify the network traffic and provide Quality of
3902 Service (QoS) on IP networks.
3904 The DSCP value specified here is used when establishing the connection
3905 between the manager and the Open vSwitch. If no value is specified, a
3906 default value of 48 is chosen. Valid DSCP values must be in the range
3911 <group title="Common Columns">
3912 The overall purpose of these columns is described under <code>Common
3913 Columns</code> at the beginning of this document.
3915 <column name="external_ids"/>
3916 <column name="other_config"/>
3920 <table name="NetFlow">
3921 A NetFlow target. NetFlow is a protocol that exports a number of
3922 details about terminating IP flows, such as the principals involved
3925 <column name="targets">
3926 NetFlow targets in the form
3927 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3928 must be specified numerically, not as a DNS name.
3931 <column name="engine_id">
3932 Engine ID to use in NetFlow messages. Defaults to datapath index
3936 <column name="engine_type">
3937 Engine type to use in NetFlow messages. Defaults to datapath
3938 index if not specified.
3941 <column name="active_timeout">
3942 The interval at which NetFlow records are sent for flows that are
3943 still active, in seconds. A value of <code>0</code> requests the
3944 default timeout (currently 600 seconds); a value of <code>-1</code>
3945 disables active timeouts.
3948 <column name="add_id_to_interface">
3949 <p>If this column's value is <code>false</code>, the ingress and egress
3950 interface fields of NetFlow flow records are derived from OpenFlow port
3951 numbers. When it is <code>true</code>, the 7 most significant bits of
3952 these fields will be replaced by the least significant 7 bits of the
3953 engine id. This is useful because many NetFlow collectors do not
3954 expect multiple switches to be sending messages from the same host, so
3955 they do not store the engine information which could be used to
3956 disambiguate the traffic.</p>
3957 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3960 <group title="Common Columns">
3961 The overall purpose of these columns is described under <code>Common
3962 Columns</code> at the beginning of this document.
3964 <column name="external_ids"/>
3969 SSL configuration for an Open_vSwitch.
3971 <column name="private_key">
3972 Name of a PEM file containing the private key used as the switch's
3973 identity for SSL connections to the controller.
3976 <column name="certificate">
3977 Name of a PEM file containing a certificate, signed by the
3978 certificate authority (CA) used by the controller and manager,
3979 that certifies the switch's private key, identifying a trustworthy
3983 <column name="ca_cert">
3984 Name of a PEM file containing the CA certificate used to verify
3985 that the switch is connected to a trustworthy controller.
3988 <column name="bootstrap_ca_cert">
3989 If set to <code>true</code>, then Open vSwitch will attempt to
3990 obtain the CA certificate from the controller on its first SSL
3991 connection and save it to the named PEM file. If it is successful,
3992 it will immediately drop the connection and reconnect, and from then
3993 on all SSL connections must be authenticated by a certificate signed
3994 by the CA certificate thus obtained. <em>This option exposes the
3995 SSL connection to a man-in-the-middle attack obtaining the initial
3996 CA certificate.</em> It may still be useful for bootstrapping.
3999 <group title="Common Columns">
4000 The overall purpose of these columns is described under <code>Common
4001 Columns</code> at the beginning of this document.
4003 <column name="external_ids"/>
4007 <table name="sFlow">
4008 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4009 monitoring of switches.</p>
4011 <column name="agent">
4012 Name of the network device whose IP address should be reported as the
4013 ``agent address'' to collectors. If not specified, the agent device is
4014 figured from the first target address and the routing table. If the
4015 routing table does not contain a route to the target, the IP address
4016 defaults to the <ref table="Controller" column="local_ip"/> in the
4017 collector's <ref table="Controller"/>. If an agent IP address cannot be
4018 determined any of these ways, sFlow is disabled.
4021 <column name="header">
4022 Number of bytes of a sampled packet to send to the collector.
4023 If not specified, the default is 128 bytes.
4026 <column name="polling">
4027 Polling rate in seconds to send port statistics to the collector.
4028 If not specified, defaults to 30 seconds.
4031 <column name="sampling">
4032 Rate at which packets should be sampled and sent to the collector.
4033 If not specified, defaults to 400, which means one out of 400
4034 packets, on average, will be sent to the collector.
4037 <column name="targets">
4038 sFlow targets in the form
4039 <code><var>ip</var>:<var>port</var></code>.
4042 <group title="Common Columns">
4043 The overall purpose of these columns is described under <code>Common
4044 Columns</code> at the beginning of this document.
4046 <column name="external_ids"/>
4050 <table name="IPFIX">
4051 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
4052 number of details about flows.</p>
4054 <column name="targets">
4055 IPFIX target collectors in the form
4056 <code><var>ip</var>:<var>port</var></code>.
4059 <column name="sampling">
4060 For per-bridge packet sampling, i.e. when this row is referenced
4061 from a <ref table="Bridge"/>, the rate at which packets should
4062 be sampled and sent to each target collector. If not specified,
4063 defaults to 400, which means one out of 400 packets, on average,
4064 will be sent to each target collector. Ignored for per-flow
4065 sampling, i.e. when this row is referenced from a <ref
4066 table="Flow_Sample_Collector_Set"/>.
4069 <column name="obs_domain_id">
4070 For per-bridge packet sampling, i.e. when this row is referenced
4071 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
4072 sent in each IPFIX packet. If not specified, defaults to 0.
4073 Ignored for per-flow sampling, i.e. when this row is referenced
4074 from a <ref table="Flow_Sample_Collector_Set"/>.
4077 <column name="obs_point_id">
4078 For per-bridge packet sampling, i.e. when this row is referenced
4079 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
4080 sent in each IPFIX flow record. If not specified, defaults to
4081 0. Ignored for per-flow sampling, i.e. when this row is
4082 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
4085 <column name="cache_active_timeout">
4086 The maximum period in seconds for which an IPFIX flow record is
4087 cached and aggregated before being sent. If not specified,
4088 defaults to 0. If 0, caching is disabled.
4091 <column name="cache_max_flows">
4092 The maximum number of IPFIX flow records that can be cached at a
4093 time. If not specified, defaults to 0. If 0, caching is
4097 <column name="other_config" key="enable-tunnel-sampling"
4098 type='{"type": "boolean"}'>
4099 <p>For per-bridge packet sampling, i.e. when this row is referenced
4100 from a <ref table="Bridge"/>, enable sampling and reporting tunnel
4101 header 7-tuples in IPFIX flow records. Disabled by default.
4102 Ignored for per-flow sampling, i.e. when this row is referenced
4103 from a <ref table="Flow_Sample_Collector_Set"/>.</p>
4104 <p><em>Please note:</em> The following enterprise entities are
4105 currently used when exporting the sampled tunnel info.</p>
4107 <dt>tunnelType:</dt>
4109 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4110 <p>type: unsigned 8-bit interger.</p>
4111 <p>data type semantics: identifier.</p>
4112 <p>description: Identifier of the layer 2 network overlay network
4113 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4118 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4119 <p>type: variable-length octetarray.</p>
4120 <p>data type semantics: identifier.</p>
4121 <p>description: Key which is used for identifying an individual
4122 traffic flow within a VxLAN (24-bit VNI), GENEVE(24-bit VNI),
4123 GRE (32- or 64-bit key), or LISP (24-bit instance ID) tunnel. The
4124 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4125 ID in network byte order.</p>
4127 <dt>tunnelSourceIPv4Address:</dt>
4129 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4130 <p>type: unsigned 32-bit interger.</p>
4131 <p>data type semantics: identifier.</p>
4132 <p>description: The IPv4 source address in the tunnel IP packet
4135 <dt>tunnelDestinationIPv4Address:</dt>
4137 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4138 <p>type: unsigned 32-bit integer.</p>
4139 <p>data type semantics: identifier.</p>
4140 <p>description: The IPv4 destination address in the tunnel IP
4143 <dt>tunnelProtocolIdentifier:</dt>
4145 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4146 <p>type: unsigned 8-bit integer.</p>
4147 <p>data type semantics: identifier.</p>
4148 <p>description: The value of the protocol number in the tunnel
4149 IP packet header. The protocol number identifies the tunnel IP
4150 packet payload type.</p>
4152 <dt>tunnelSourceTransportPort:</dt>
4154 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4155 <p>type: unsigned 16-bit integer.</p>
4156 <p>data type semantics: identifier.</p>
4157 <p>description: The source port identifier in the tunnel transport
4158 header. For the transport protocols UDP, TCP, and SCTP, this is
4159 the source port number given in the respective header.</p>
4161 <dt>tunnelDestinationTransportPort:</dt>
4163 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4164 <p>type: unsigned 16-bit integer.</p>
4165 <p>data type semantics: identifier.</p>
4166 <p>description: The destination port identifier in the tunnel
4167 transport header. For the transport protocols UDP, TCP, and SCTP,
4168 this is the destination port number given in the respective header.
4174 <column name="other_config" key="enable-input-sampling"
4175 type='{"type": "boolean"}'>
4176 For per-bridge packet sampling, i.e. when this row is referenced
4177 from a <ref table="Bridge"/>, enable sampling and reporting flows
4178 at bridge port input in IPFIX flow records. Enabled by default.
4179 Ignored for per-flow sampling, i.e. when this row is referenced
4180 from a <ref table="Flow_Sample_Collector_Set"/>.
4183 <column name="other_config" key="enable-output-sampling"
4184 type='{"type": "boolean"}'>
4185 For per-bridge packet sampling, i.e. when this row is referenced
4186 from a <ref table="Bridge"/>, enable sampling and reporting flows
4187 at bridge port output in IPFIX flow records. Enabled by default.
4188 Ignored for per-flow sampling, i.e. when this row is referenced
4189 from a <ref table="Flow_Sample_Collector_Set"/>.
4192 <group title="Common Columns">
4193 The overall purpose of these columns is described under <code>Common
4194 Columns</code> at the beginning of this document.
4196 <column name="external_ids"/>
4200 <table name="Flow_Sample_Collector_Set">
4201 <p>A set of IPFIX collectors of packet samples generated by
4202 OpenFlow <code>sample</code> actions.</p>
4205 The ID of this collector set, unique among the bridge's
4206 collector sets, to be used as the <code>collector_set_id</code>
4207 in OpenFlow <code>sample</code> actions.
4210 <column name="bridge">
4211 The bridge into which OpenFlow <code>sample</code> actions can
4212 be added to send packet samples to this set of IPFIX collectors.
4215 <column name="ipfix">
4216 Configuration of the set of IPFIX collectors to send one flow
4217 record per sampled packet to.
4220 <group title="Common Columns">
4221 The overall purpose of these columns is described under <code>Common
4222 Columns</code> at the beginning of this document.
4224 <column name="external_ids"/>