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>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
413 The default is <code>standalone</code> if the value is unset, but
414 future versions of Open vSwitch may change the default.
417 The <code>standalone</code> mode can create forwarding loops on a
418 bridge that has more than one uplink port unless STP is enabled. To
419 avoid loops on such a bridge, configure <code>secure</code> mode or
420 enable STP (see <ref column="stp_enable"/>).
422 <p>When more than one controller is configured,
423 <ref column="fail_mode"/> is considered only when none of the
424 configured controllers can be contacted.</p>
426 Changing <ref column="fail_mode"/> when no primary controllers are
427 configured clears the flow table.
431 <column name="datapath_id">
432 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
433 (Setting this column has no useful effect. Set <ref
434 column="other-config" key="datapath-id"/> instead.)
437 <column name="other_config" key="datapath-id">
438 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
439 value. May not be all-zero.
442 <column name="other_config" key="disable-in-band"
443 type='{"type": "boolean"}'>
444 If set to <code>true</code>, disable in-band control on the bridge
445 regardless of controller and manager settings.
448 <column name="other_config" key="in-band-queue"
449 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
450 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
451 that will be used by flows set up by in-band control on this bridge.
452 If unset, or if the port used by an in-band control flow does not have
453 QoS configured, or if the port does not have a queue with the specified
454 ID, the default queue is used instead.
457 <column name="protocols">
458 List of OpenFlow protocols that may be used when negotiating a
459 connection with a controller. A default value of
460 <code>OpenFlow10</code> will be used if this column is empty.
464 <group title="Spanning Tree Configuration">
465 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
466 that ensures loop-free topologies. It allows redundant links to
467 be included in the network to provide automatic backup paths if
468 the active links fails.
470 <column name="stp_enable">
471 Enable spanning tree on the bridge. By default, STP is disabled
472 on bridges. Bond, internal, and mirror ports are not supported
473 and will not participate in the spanning tree.
476 <column name="other_config" key="stp-system-id">
477 The bridge's STP identifier (the lower 48 bits of the bridge-id)
479 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
480 By default, the identifier is the MAC address of the bridge.
483 <column name="other_config" key="stp-priority"
484 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
485 The bridge's relative priority value for determining the root
486 bridge (the upper 16 bits of the bridge-id). A bridge with the
487 lowest bridge-id is elected the root. By default, the priority
491 <column name="other_config" key="stp-hello-time"
492 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
493 The interval between transmissions of hello messages by
494 designated ports, in seconds. By default the hello interval is
498 <column name="other_config" key="stp-max-age"
499 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
500 The maximum age of the information transmitted by the bridge
501 when it is the root bridge, in seconds. By default, the maximum
505 <column name="other_config" key="stp-forward-delay"
506 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
507 The delay to wait between transitioning root and designated
508 ports to <code>forwarding</code>, in seconds. By default, the
509 forwarding delay is 15 seconds.
513 <group title="Other Features">
514 <column name="datapath_type">
515 Name of datapath provider. The kernel datapath has
516 type <code>system</code>. The userspace datapath has
517 type <code>netdev</code>.
520 <column name="external_ids" key="bridge-id">
521 A unique identifier of the bridge. On Citrix XenServer this will
522 commonly be the same as
523 <ref column="external_ids" key="xs-network-uuids"/>.
526 <column name="external_ids" key="xs-network-uuids">
527 Semicolon-delimited set of universally unique identifier(s) for the
528 network with which this bridge is associated on a Citrix XenServer
529 host. The network identifiers are RFC 4122 UUIDs as displayed by,
530 e.g., <code>xe network-list</code>.
533 <column name="other_config" key="hwaddr">
534 An Ethernet address in the form
535 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
536 to set the hardware address of the local port and influence the
540 <column name="other_config" key="flow-eviction-threshold"
541 type='{"type": "integer", "minInteger": 0}'>
543 A number of flows as a nonnegative integer. This sets number of
544 flows at which eviction from the kernel flow table will be triggered.
545 If there are a large number of flows then increasing this value to
546 around the number of flows present can result in reduced CPU usage
550 The default is 1000. Values below 100 will be rounded up to 100.
554 <column name="other_config" key="forward-bpdu"
555 type='{"type": "boolean"}'>
556 Option to allow forwarding of BPDU frames when NORMAL action is
557 invoked. Frames with reserved Ethernet addresses (e.g. STP
558 BPDU) will be forwarded when this option is enabled and the
559 switch is not providing that functionality. If STP is enabled
560 on the port, STP BPDUs will never be forwarded. If the Open
561 vSwitch bridge is used to connect different Ethernet networks,
562 and if Open vSwitch node does not run STP, then this option
563 should be enabled. Default is disabled, set to
564 <code>true</code> to enable.
566 The following destination MAC addresss will not be forwarded when this
569 <dt><code>01:80:c2:00:00:00</code></dt>
570 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
572 <dt><code>01:80:c2:00:00:01</code></dt>
573 <dd>IEEE Pause frame.</dd>
575 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
576 <dd>Other reserved protocols.</dd>
578 <dt><code>00:e0:2b:00:00:00</code></dt>
579 <dd>Extreme Discovery Protocol (EDP).</dd>
582 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
584 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
586 <dt><code>01:00:0c:cc:cc:cc</code></dt>
588 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
589 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
593 <dt><code>01:00:0c:cc:cc:cd</code></dt>
594 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
596 <dt><code>01:00:0c:cd:cd:cd</code></dt>
597 <dd>Cisco STP Uplink Fast.</dd>
599 <dt><code>01:00:0c:00:00:00</code></dt>
600 <dd>Cisco Inter Switch Link.</dd>
602 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
607 <column name="other_config" key="mac-aging-time"
608 type='{"type": "integer", "minInteger": 1}'>
610 The maximum number of seconds to retain a MAC learning entry for
611 which no packets have been seen. The default is currently 300
612 seconds (5 minutes). The value, if specified, is forced into a
613 reasonable range, currently 15 to 3600 seconds.
617 A short MAC aging time allows a network to more quickly detect that a
618 host is no longer connected to a switch port. However, it also makes
619 it more likely that packets will be flooded unnecessarily, when they
620 are addressed to a connected host that rarely transmits packets. To
621 reduce the incidence of unnecessary flooding, use a MAC aging time
622 longer than the maximum interval at which a host will ordinarily
628 <group title="Bridge Status">
630 Status information about bridges.
632 <column name="status">
633 Key-value pairs that report bridge status.
635 <column name="status" key="stp_bridge_id">
637 The bridge-id (in hex) used in spanning tree advertisements.
638 Configuring the bridge-id is described in the
639 <code>stp-system-id</code> and <code>stp-priority</code> keys
640 of the <code>other_config</code> section earlier.
643 <column name="status" key="stp_designated_root">
645 The designated root (in hex) for this spanning tree.
648 <column name="status" key="stp_root_path_cost">
650 The path cost of reaching the designated bridge. A lower
656 <group title="Common Columns">
657 The overall purpose of these columns is described under <code>Common
658 Columns</code> at the beginning of this document.
660 <column name="other_config"/>
661 <column name="external_ids"/>
665 <table name="Port" table="Port or bond configuration.">
666 <p>A port within a <ref table="Bridge"/>.</p>
667 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
668 <ref column="interfaces"/> column. Such a port logically
669 corresponds to a port on a physical Ethernet switch. A port
670 with more than one interface is a ``bonded port'' (see
671 <ref group="Bonding Configuration"/>).</p>
672 <p>Some properties that one might think as belonging to a port are actually
673 part of the port's <ref table="Interface"/> members.</p>
676 Port name. Should be alphanumeric and no more than about 8
677 bytes long. May be the same as the interface name, for
678 non-bonded ports. Must otherwise be unique among the names of
679 ports, interfaces, and bridges on a host.
682 <column name="interfaces">
683 The port's interfaces. If there is more than one, this is a
687 <group title="VLAN Configuration">
688 <p>Bridge ports support the following types of VLAN configuration:</p>
693 A trunk port carries packets on one or more specified VLANs
694 specified in the <ref column="trunks"/> column (often, on every
695 VLAN). A packet that ingresses on a trunk port is in the VLAN
696 specified in its 802.1Q header, or VLAN 0 if the packet has no
697 802.1Q header. A packet that egresses through a trunk port will
698 have an 802.1Q header if it has a nonzero VLAN ID.
702 Any packet that ingresses on a trunk port tagged with a VLAN that
703 the port does not trunk is dropped.
710 An access port carries packets on exactly one VLAN specified in the
711 <ref column="tag"/> column. Packets egressing on an access port
712 have no 802.1Q header.
716 Any packet with an 802.1Q header with a nonzero VLAN ID that
717 ingresses on an access port is dropped, regardless of whether the
718 VLAN ID in the header is the access port's VLAN ID.
722 <dt>native-tagged</dt>
724 A native-tagged port resembles a trunk port, with the exception that
725 a packet without an 802.1Q header that ingresses on a native-tagged
726 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
730 <dt>native-untagged</dt>
732 A native-untagged port resembles a native-tagged port, with the
733 exception that a packet that egresses on a native-untagged port in
734 the native VLAN will not have an 802.1Q header.
738 A packet will only egress through bridge ports that carry the VLAN of
739 the packet, as described by the rules above.
742 <column name="vlan_mode">
744 The VLAN mode of the port, as described above. When this column is
745 empty, a default mode is selected as follows:
749 If <ref column="tag"/> contains a value, the port is an access
750 port. The <ref column="trunks"/> column should be empty.
753 Otherwise, the port is a trunk port. The <ref column="trunks"/>
754 column value is honored if it is present.
761 For an access port, the port's implicitly tagged VLAN. For a
762 native-tagged or native-untagged port, the port's native VLAN. Must
763 be empty if this is a trunk port.
767 <column name="trunks">
769 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
770 or VLANs that this port trunks; if it is empty, then the port trunks
771 all VLANs. Must be empty if this is an access port.
774 A native-tagged or native-untagged port always trunks its native
775 VLAN, regardless of whether <ref column="trunks"/> includes that
780 <column name="other_config" key="priority-tags"
781 type='{"type": "boolean"}'>
783 An 802.1Q header contains two important pieces of information: a VLAN
784 ID and a priority. A frame with a zero VLAN ID, called a
785 ``priority-tagged'' frame, is supposed to be treated the same way as
786 a frame without an 802.1Q header at all (except for the priority).
790 However, some network elements ignore any frame that has 802.1Q
791 header at all, even when the VLAN ID is zero. Therefore, by default
792 Open vSwitch does not output priority-tagged frames, instead omitting
793 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
794 <code>true</code> to enable priority-tagged frames on a port.
798 Regardless of this setting, Open vSwitch omits the 802.1Q header on
799 output if both the VLAN ID and priority would be zero.
803 All frames output to native-tagged ports have a nonzero VLAN ID, so
804 this setting is not meaningful on native-tagged ports.
809 <group title="Bonding Configuration">
810 <p>A port that has more than one interface is a ``bonded port.'' Bonding
811 allows for load balancing and fail-over.</p>
814 The following types of bonding will work with any kind of upstream
815 switch. On the upstream switch, do not configure the interfaces as a
820 <dt><code>balance-slb</code></dt>
822 Balances flows among slaves based on source MAC address and output
823 VLAN, with periodic rebalancing as traffic patterns change.
826 <dt><code>active-backup</code></dt>
828 Assigns all flows to one slave, failing over to a backup slave when
829 the active slave is disabled. This is the only bonding mode in which
830 interfaces may be plugged into different upstream switches.
835 The following modes require the upstream switch to support 802.3ad with
836 successful LACP negotiation:
840 <dt><code>balance-tcp</code></dt>
842 Balances flows among slaves based on L2, L3, and L4 protocol
843 information such as destination MAC address, IP address, and TCP
847 <dt><code>stable</code></dt>
849 <p>Deprecated and slated for removal in February 2013.</p>
850 <p>Attempts to always assign a given flow to the same slave
851 consistently. In an effort to maintain stability, no load
852 balancing is done. Uses a similar hashing strategy to
853 <code>balance-tcp</code>, always taking into account L3 and L4
854 fields even if LACP negotiations are unsuccessful. </p>
855 <p>Slave selection decisions are made based on <ref table="Interface"
856 column="other_config" key="bond-stable-id"/> if set. Otherwise,
857 OpenFlow port number is used. Decisions are consistent across all
858 <code>ovs-vswitchd</code> instances with equivalent
859 <ref table="Interface" column="other_config" key="bond-stable-id"/>
864 <p>These columns apply only to bonded ports. Their values are
865 otherwise ignored.</p>
867 <column name="bond_mode">
868 <p>The type of bonding used for a bonded port. Defaults to
869 <code>active-backup</code> if unset.
873 <column name="other_config" key="bond-hash-basis"
874 type='{"type": "integer"}'>
875 An integer hashed along with flows when choosing output slaves in load
876 balanced bonds. When changed, all flows will be assigned different
877 hash values possibly causing slave selection decisions to change. Does
878 not affect bonding modes which do not employ load balancing such as
879 <code>active-backup</code>.
882 <group title="Link Failure Detection">
884 An important part of link bonding is detecting that links are down so
885 that they may be disabled. These settings determine how Open vSwitch
886 detects link failure.
889 <column name="other_config" key="bond-detect-mode"
890 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
891 The means used to detect link failures. Defaults to
892 <code>carrier</code> which uses each interface's carrier to detect
893 failures. When set to <code>miimon</code>, will check for failures
894 by polling each interface's MII.
897 <column name="other_config" key="bond-miimon-interval"
898 type='{"type": "integer"}'>
899 The interval, in milliseconds, between successive attempts to poll
900 each interface's MII. Relevant only when <ref column="other_config"
901 key="bond-detect-mode"/> is <code>miimon</code>.
904 <column name="bond_updelay">
906 The number of milliseconds for which the link must stay up on an
907 interface before the interface is considered to be up. Specify
908 <code>0</code> to enable the interface immediately.
912 This setting is honored only when at least one bonded interface is
913 already enabled. When no interfaces are enabled, then the first
914 bond interface to come up is enabled immediately.
918 <column name="bond_downdelay">
919 The number of milliseconds for which the link must stay down on an
920 interface before the interface is considered to be down. Specify
921 <code>0</code> to disable the interface immediately.
925 <group title="LACP Configuration">
927 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
928 allows switches to automatically detect that they are connected by
929 multiple links and aggregate across those links. These settings
930 control LACP behavior.
934 Configures LACP on this port. LACP allows directly connected
935 switches to negotiate which links may be bonded. LACP may be enabled
936 on non-bonded ports for the benefit of any switches they may be
937 connected to. <code>active</code> ports are allowed to initiate LACP
938 negotiations. <code>passive</code> ports are allowed to participate
939 in LACP negotiations initiated by a remote switch, but not allowed to
940 initiate such negotiations themselves. If LACP is enabled on a port
941 whose partner switch does not support LACP, the bond will be
942 disabled. Defaults to <code>off</code> if unset.
945 <column name="other_config" key="lacp-system-id">
946 The LACP system ID of this <ref table="Port"/>. The system ID of a
947 LACP bond is used to identify itself to its partners. Must be a
948 nonzero MAC address. Defaults to the bridge Ethernet address if
952 <column name="other_config" key="lacp-system-priority"
953 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
954 The LACP system priority of this <ref table="Port"/>. In LACP
955 negotiations, link status decisions are made by the system with the
956 numerically lower priority.
959 <column name="other_config" key="lacp-time"
960 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
962 The LACP timing which should be used on this <ref table="Port"/>.
963 By default <code>slow</code> is used. When configured to be
964 <code>fast</code> LACP heartbeats are requested at a rate of once
965 per second causing connectivity problems to be detected more
966 quickly. In <code>slow</code> mode, heartbeats are requested at a
967 rate of once every 30 seconds.
972 <group title="Rebalancing Configuration">
974 These settings control behavior when a bond is in
975 <code>balance-slb</code> or <code>balance-tcp</code> mode.
978 <column name="other_config" key="bond-rebalance-interval"
979 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
980 For a load balanced bonded port, the number of milliseconds between
981 successive attempts to rebalance the bond, that is, to move flows
982 from one interface on the bond to another in an attempt to keep usage
983 of each interface roughly equal. If zero, load balancing is disabled
984 on the bond (link failure still cause flows to move). If
985 less than 1000ms, the rebalance interval will be 1000ms.
989 <column name="bond_fake_iface">
990 For a bonded port, whether to create a fake internal interface with the
991 name of the port. Use only for compatibility with legacy software that
996 <group title="Spanning Tree Configuration">
997 <column name="other_config" key="stp-enable"
998 type='{"type": "boolean"}'>
999 If spanning tree is enabled on the bridge, member ports are
1000 enabled by default (with the exception of bond, internal, and
1001 mirror ports which do not work with STP). If this column's
1002 value is <code>false</code> spanning tree is disabled on the
1006 <column name="other_config" key="stp-port-num"
1007 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1008 The port number used for the lower 8 bits of the port-id. By
1009 default, the numbers will be assigned automatically. If any
1010 port's number is manually configured on a bridge, then they
1014 <column name="other_config" key="stp-port-priority"
1015 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1016 The port's relative priority value for determining the root
1017 port (the upper 8 bits of the port-id). A port with a lower
1018 port-id will be chosen as the root port. By default, the
1022 <column name="other_config" key="stp-path-cost"
1023 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1024 Spanning tree path cost for the port. A lower number indicates
1025 a faster link. By default, the cost is based on the maximum
1030 <group title="Other Features">
1032 Quality of Service configuration for this port.
1036 The MAC address to use for this port for the purpose of choosing the
1037 bridge's MAC address. This column does not necessarily reflect the
1038 port's actual MAC address, nor will setting it change the port's actual
1042 <column name="fake_bridge">
1043 Does this port represent a sub-bridge for its tagged VLAN within the
1044 Bridge? See ovs-vsctl(8) for more information.
1047 <column name="external_ids" key="fake-bridge-id-*">
1048 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1049 column) are defined by prefixing a <ref table="Bridge"/> <ref
1050 table="Bridge" column="external_ids"/> key with
1051 <code>fake-bridge-</code>,
1052 e.g. <code>fake-bridge-xs-network-uuids</code>.
1056 <group title="Port Status">
1058 Status information about ports attached to bridges.
1060 <column name="status">
1061 Key-value pairs that report port status.
1063 <column name="status" key="stp_port_id">
1065 The port-id (in hex) used in spanning tree advertisements for
1066 this port. Configuring the port-id is described in the
1067 <code>stp-port-num</code> and <code>stp-port-priority</code>
1068 keys of the <code>other_config</code> section earlier.
1071 <column name="status" key="stp_state"
1072 type='{"type": "string", "enum": ["set",
1073 ["disabled", "listening", "learning",
1074 "forwarding", "blocking"]]}'>
1076 STP state of the port.
1079 <column name="status" key="stp_sec_in_state"
1080 type='{"type": "integer", "minInteger": 0}'>
1082 The amount of time (in seconds) port has been in the current
1086 <column name="status" key="stp_role"
1087 type='{"type": "string", "enum": ["set",
1088 ["root", "designated", "alternate"]]}'>
1090 STP role of the port.
1095 <group title="Port Statistics">
1097 Key-value pairs that report port statistics.
1099 <group title="Statistics: STP transmit and receive counters">
1100 <column name="statistics" key="stp_tx_count">
1101 Number of STP BPDUs sent on this port by the spanning
1104 <column name="statistics" key="stp_rx_count">
1105 Number of STP BPDUs received on this port and accepted by the
1106 spanning tree library.
1108 <column name="statistics" key="stp_error_count">
1109 Number of bad STP BPDUs received on this port. Bad BPDUs
1110 include runt packets and those with an unexpected protocol ID.
1115 <group title="Common Columns">
1116 The overall purpose of these columns is described under <code>Common
1117 Columns</code> at the beginning of this document.
1119 <column name="other_config"/>
1120 <column name="external_ids"/>
1124 <table name="Interface" title="One physical network device in a Port.">
1125 An interface within a <ref table="Port"/>.
1127 <group title="Core Features">
1128 <column name="name">
1129 Interface name. Should be alphanumeric and no more than about 8 bytes
1130 long. May be the same as the port name, for non-bonded ports. Must
1131 otherwise be unique among the names of ports, interfaces, and bridges
1136 <p>Ethernet address to set for this interface. If unset then the
1137 default MAC address is used:</p>
1139 <li>For the local interface, the default is the lowest-numbered MAC
1140 address among the other bridge ports, either the value of the
1141 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1142 if set, or its actual MAC (for bonded ports, the MAC of its slave
1143 whose name is first in alphabetical order). Internal ports and
1144 bridge ports that are used as port mirroring destinations (see the
1145 <ref table="Mirror"/> table) are ignored.</li>
1146 <li>For other internal interfaces, the default MAC is randomly
1148 <li>External interfaces typically have a MAC address associated with
1149 their hardware.</li>
1151 <p>Some interfaces may not have a software-controllable MAC
1155 <column name="ofport">
1156 <p>OpenFlow port number for this interface. Unlike most columns, this
1157 column's value should be set only by Open vSwitch itself. Other
1158 clients should set this column to an empty set (the default) when
1159 creating an <ref table="Interface"/>.</p>
1160 <p>Open vSwitch populates this column when the port number becomes
1161 known. If the interface is successfully added,
1162 <ref column="ofport"/> will be set to a number between 1 and 65535
1163 (generally either in the range 1 to 65279, inclusive, or 65534, the
1164 port number for the OpenFlow ``local port''). If the interface
1165 cannot be added then Open vSwitch sets this column
1167 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1168 an appropriate value for this column and then tries to keep the value
1169 constant across restarts.</p>
1172 <column name="ofport_request">
1173 <p>Requested OpenFlow port number for this interface. The port
1174 number must be between 1 and 65279, inclusive. Some datapaths
1175 cannot satisfy all requests for particular port numbers. When
1176 this column is empty or the request cannot be fulfilled, the
1177 system will choose a free port. The <ref column="ofport"/>
1178 column reports the assigned OpenFlow port number.</p>
1179 <p>The port number must be requested in the same transaction
1180 that creates the port.</p>
1184 <group title="System-Specific Details">
1185 <column name="type">
1187 The interface type, one of:
1191 <dt><code>system</code></dt>
1192 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1193 Sometimes referred to as ``external interfaces'' since they are
1194 generally connected to hardware external to that on which the Open
1195 vSwitch is running. The empty string is a synonym for
1196 <code>system</code>.</dd>
1198 <dt><code>internal</code></dt>
1199 <dd>A simulated network device that sends and receives traffic. An
1200 internal interface whose <ref column="name"/> is the same as its
1201 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1202 ``local interface.'' It does not make sense to bond an internal
1203 interface, so the terms ``port'' and ``interface'' are often used
1204 imprecisely for internal interfaces.</dd>
1206 <dt><code>tap</code></dt>
1207 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1209 <dt><code>gre</code></dt>
1211 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1212 tunnel. See <ref group="Tunnel Options"/> for information on
1213 configuring GRE tunnels.
1216 <dt><code>ipsec_gre</code></dt>
1218 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1222 <dt><code>gre64</code></dt>
1224 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1225 of key, it uses GRE protocol sequence number field. This is non
1226 standard use of GRE protocol since OVS does not increment
1227 sequence number for every packet at time of encap as expected by
1228 standard GRE implementation. See <ref group="Tunnel Options"/>
1229 for information on configuring GRE tunnels.
1232 <dt><code>ipsec_gre64</code></dt>
1234 Same as IPSEC_GRE except 64 bit key.
1237 <dt><code>capwap</code></dt>
1239 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1240 5415). This allows interoperability with certain switches that do
1241 not support GRE. Only the tunneling component of the protocol is
1242 implemented. UDP ports 58881 and 58882 are used as the source and
1243 destination ports respectively. CAPWAP is currently supported only
1244 with the Linux kernel datapath with kernel version 2.6.26 or later.
1246 CAPWAP support is deprecated and will be removed no earlier than
1250 <dt><code>patch</code></dt>
1252 A pair of virtual devices that act as a patch cable.
1255 <dt><code>null</code></dt>
1256 <dd>An ignored interface. Deprecated and slated for removal in
1262 <group title="Tunnel Options">
1264 These options apply to interfaces with <ref column="type"/> of
1265 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1266 <code>ipsec_gre64</code>, and <code>capwap</code>.
1270 Each tunnel must be uniquely identified by the combination of <ref
1271 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1272 column="options" key="local_ip"/>, and <ref column="options"
1273 key="in_key"/>. If two ports are defined that are the same except one
1274 has an optional identifier and the other does not, the more specific
1275 one is matched first. <ref column="options" key="in_key"/> is
1276 considered more specific than <ref column="options" key="local_ip"/> if
1277 a port defines one and another port defines the other.
1280 <column name="options" key="remote_ip">
1282 Required. The tunnel endpoint. Unicast and multicast endpoints are
1287 When a multicast endpoint is specified, a routing table lookup occurs
1288 only when the tunnel is created. Following a routing change, delete
1289 and then re-create the tunnel to force a new routing table lookup.
1293 <column name="options" key="local_ip">
1294 Optional. The destination IP that received packets must match.
1295 Default is to match all addresses. Must be omitted when <ref
1296 column="options" key="remote_ip"/> is a multicast address.
1299 <column name="options" key="in_key">
1300 <p>Optional. The key that received packets must contain, one of:</p>
1304 <code>0</code>. The tunnel receives packets with no key or with a
1305 key of 0. This is equivalent to specifying no <ref column="options"
1306 key="in_key"/> at all.
1309 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1310 tunnel receives only packets with the specified key.
1313 The word <code>flow</code>. The tunnel accepts packets with any
1314 key. The key will be placed in the <code>tun_id</code> field for
1315 matching in the flow table. The <code>ovs-ofctl</code> manual page
1316 contains additional information about matching fields in OpenFlow
1325 <column name="options" key="out_key">
1326 <p>Optional. The key to be set on outgoing packets, one of:</p>
1330 <code>0</code>. Packets sent through the tunnel will have no key.
1331 This is equivalent to specifying no <ref column="options"
1332 key="out_key"/> at all.
1335 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1336 sent through the tunnel will have the specified key.
1339 The word <code>flow</code>. Packets sent through the tunnel will
1340 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1341 vendor extension (0 is used in the absence of an action). The
1342 <code>ovs-ofctl</code> manual page contains additional information
1343 about the Nicira OpenFlow vendor extensions.
1348 <column name="options" key="key">
1349 Optional. Shorthand to set <code>in_key</code> and
1350 <code>out_key</code> at the same time.
1353 <column name="options" key="tos">
1354 Optional. The value of the ToS bits to be set on the encapsulating
1355 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1356 zero. It may also be the word <code>inherit</code>, in which case
1357 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1358 (otherwise it will be 0). The ECN fields are always inherited.
1362 <column name="options" key="ttl">
1363 Optional. The TTL to be set on the encapsulating packet. It may also
1364 be the word <code>inherit</code>, in which case the TTL will be copied
1365 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1366 system default, typically 64). Default is the system default TTL.
1369 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1370 Optional. If enabled, the Don't Fragment bit will be copied from the
1371 inner IP headers (those of the encapsulated traffic) to the outer
1372 (tunnel) headers. Default is disabled; set to <code>true</code> to
1376 <column name="options" key="df_default"
1377 type='{"type": "boolean"}'>
1378 Optional. If enabled, the Don't Fragment bit will be set by default on
1379 tunnel headers if the <code>df_inherit</code> option is not set, or if
1380 the encapsulated packet is not IP. Default is enabled; set to
1381 <code>false</code> to disable.
1384 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1385 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1386 Destination Unreachable - Fragmentation Needed'' messages will be
1387 generated for IPv4 packets with the DF bit set and IPv6 packets above
1388 the minimum MTU if the packet size exceeds the path MTU minus the size
1389 of the tunnel headers. Note that this option causes behavior that is
1390 typically reserved for routers and therefore is not entirely in
1391 compliance with the IEEE 802.1D specification for bridges. Default is
1392 disabled; set to <code>true</code> to enable. This feature is
1393 deprecated and will be removed soon.
1396 <group title="Tunnel Options: gre only">
1398 Only <code>gre</code> interfaces support these options.
1402 <group title="Tunnel Options: gre and ipsec_gre only">
1404 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1408 <column name="options" key="csum" type='{"type": "boolean"}'>
1410 Optional. Compute GRE checksums on outgoing packets. Default is
1411 disabled, set to <code>true</code> to enable. Checksums present on
1412 incoming packets will be validated regardless of this setting.
1416 GRE checksums impose a significant performance penalty because they
1417 cover the entire packet. The encapsulated L3, L4, and L7 packet
1418 contents typically have their own checksums, so this additional
1419 checksum only adds value for the GRE and encapsulated L2 headers.
1423 This option is supported for <code>ipsec_gre</code>, but not useful
1424 because GRE checksums are weaker than, and redundant with, IPsec
1425 payload authentication.
1430 <group title="Tunnel Options: ipsec_gre only">
1432 Only <code>ipsec_gre</code> interfaces support these options.
1435 <column name="options" key="peer_cert">
1436 Required for certificate authentication. A string containing the
1437 peer's certificate in PEM format. Additionally the host's
1438 certificate must be specified with the <code>certificate</code>
1442 <column name="options" key="certificate">
1443 Required for certificate authentication. The name of a PEM file
1444 containing a certificate that will be presented to the peer during
1448 <column name="options" key="private_key">
1449 Optional for certificate authentication. The name of a PEM file
1450 containing the private key associated with <code>certificate</code>.
1451 If <code>certificate</code> contains the private key, this option may
1455 <column name="options" key="psk">
1456 Required for pre-shared key authentication. Specifies a pre-shared
1457 key for authentication that must be identical on both sides of the
1463 <group title="Patch Options">
1465 Only <code>patch</code> interfaces support these options.
1468 <column name="options" key="peer">
1469 The <ref column="name"/> of the <ref table="Interface"/> for the other
1470 side of the patch. The named <ref table="Interface"/>'s own
1471 <code>peer</code> option must specify this <ref table="Interface"/>'s
1472 name. That is, the two patch interfaces must have reversed <ref
1473 column="name"/> and <code>peer</code> values.
1477 <group title="Interface Status">
1479 Status information about interfaces attached to bridges, updated every
1480 5 seconds. Not all interfaces have all of these properties; virtual
1481 interfaces don't have a link speed, for example. Non-applicable
1482 columns will have empty values.
1484 <column name="admin_state">
1486 The administrative state of the physical network link.
1490 <column name="link_state">
1492 The observed state of the physical network link. This is ordinarily
1493 the link's carrier status. If the interface's <ref table="Port"/> is
1494 a bond configured for miimon monitoring, it is instead the network
1495 link's miimon status.
1499 <column name="link_resets">
1501 The number of times Open vSwitch has observed the
1502 <ref column="link_state"/> of this <ref table="Interface"/> change.
1506 <column name="link_speed">
1508 The negotiated speed of the physical network link.
1509 Valid values are positive integers greater than 0.
1513 <column name="duplex">
1515 The duplex mode of the physical network link.
1521 The MTU (maximum transmission unit); i.e. the largest
1522 amount of data that can fit into a single Ethernet frame.
1523 The standard Ethernet MTU is 1500 bytes. Some physical media
1524 and many kinds of virtual interfaces can be configured with
1528 This column will be empty for an interface that does not
1529 have an MTU as, for example, some kinds of tunnels do not.
1533 <column name="lacp_current">
1534 Boolean value indicating LACP status for this interface. If true, this
1535 interface has current LACP information about its LACP partner. This
1536 information may be used to monitor the health of interfaces in a LACP
1537 enabled port. This column will be empty if LACP is not enabled.
1540 <column name="status">
1541 Key-value pairs that report port status. Supported status values are
1542 <ref column="type"/>-dependent; some interfaces may not have a valid
1543 <ref column="status" key="driver_name"/>, for example.
1546 <column name="status" key="driver_name">
1547 The name of the device driver controlling the network adapter.
1550 <column name="status" key="driver_version">
1551 The version string of the device driver controlling the network
1555 <column name="status" key="firmware_version">
1556 The version string of the network adapter's firmware, if available.
1559 <column name="status" key="source_ip">
1560 The source IP address used for an IPv4 tunnel end-point, such as
1561 <code>gre</code> or <code>capwap</code>.
1564 <column name="status" key="tunnel_egress_iface">
1565 Egress interface for tunnels. Currently only relevant for GRE and
1566 CAPWAP tunnels. On Linux systems, this column will show the name of
1567 the interface which is responsible for routing traffic destined for the
1568 configured <ref column="options" key="remote_ip"/>. This could be an
1569 internal interface such as a bridge port.
1572 <column name="status" key="tunnel_egress_iface_carrier"
1573 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1574 Whether carrier is detected on <ref column="status"
1575 key="tunnel_egress_iface"/>.
1579 <group title="Statistics">
1581 Key-value pairs that report interface statistics. The current
1582 implementation updates these counters periodically. Future
1583 implementations may update them when an interface is created, when they
1584 are queried (e.g. using an OVSDB <code>select</code> operation), and
1585 just before an interface is deleted due to virtual interface hot-unplug
1586 or VM shutdown, and perhaps at other times, but not on any regular
1590 These are the same statistics reported by OpenFlow in its <code>struct
1591 ofp_port_stats</code> structure. If an interface does not support a
1592 given statistic, then that pair is omitted.
1594 <group title="Statistics: Successful transmit and receive counters">
1595 <column name="statistics" key="rx_packets">
1596 Number of received packets.
1598 <column name="statistics" key="rx_bytes">
1599 Number of received bytes.
1601 <column name="statistics" key="tx_packets">
1602 Number of transmitted packets.
1604 <column name="statistics" key="tx_bytes">
1605 Number of transmitted bytes.
1608 <group title="Statistics: Receive errors">
1609 <column name="statistics" key="rx_dropped">
1610 Number of packets dropped by RX.
1612 <column name="statistics" key="rx_frame_err">
1613 Number of frame alignment errors.
1615 <column name="statistics" key="rx_over_err">
1616 Number of packets with RX overrun.
1618 <column name="statistics" key="rx_crc_err">
1619 Number of CRC errors.
1621 <column name="statistics" key="rx_errors">
1622 Total number of receive errors, greater than or equal to the sum of
1626 <group title="Statistics: Transmit errors">
1627 <column name="statistics" key="tx_dropped">
1628 Number of packets dropped by TX.
1630 <column name="statistics" key="collisions">
1631 Number of collisions.
1633 <column name="statistics" key="tx_errors">
1634 Total number of transmit errors, greater than or equal to the sum of
1640 <group title="Ingress Policing">
1642 These settings control ingress policing for packets received on this
1643 interface. On a physical interface, this limits the rate at which
1644 traffic is allowed into the system from the outside; on a virtual
1645 interface (one connected to a virtual machine), this limits the rate at
1646 which the VM is able to transmit.
1649 Policing is a simple form of quality-of-service that simply drops
1650 packets received in excess of the configured rate. Due to its
1651 simplicity, policing is usually less accurate and less effective than
1652 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1653 table="Queue"/> tables).
1656 Policing is currently implemented only on Linux. The Linux
1657 implementation uses a simple ``token bucket'' approach:
1661 The size of the bucket corresponds to <ref
1662 column="ingress_policing_burst"/>. Initially the bucket is full.
1665 Whenever a packet is received, its size (converted to tokens) is
1666 compared to the number of tokens currently in the bucket. If the
1667 required number of tokens are available, they are removed and the
1668 packet is forwarded. Otherwise, the packet is dropped.
1671 Whenever it is not full, the bucket is refilled with tokens at the
1672 rate specified by <ref column="ingress_policing_rate"/>.
1676 Policing interacts badly with some network protocols, and especially
1677 with fragmented IP packets. Suppose that there is enough network
1678 activity to keep the bucket nearly empty all the time. Then this token
1679 bucket algorithm will forward a single packet every so often, with the
1680 period depending on packet size and on the configured rate. All of the
1681 fragments of an IP packets are normally transmitted back-to-back, as a
1682 group. In such a situation, therefore, only one of these fragments
1683 will be forwarded and the rest will be dropped. IP does not provide
1684 any way for the intended recipient to ask for only the remaining
1685 fragments. In such a case there are two likely possibilities for what
1686 will happen next: either all of the fragments will eventually be
1687 retransmitted (as TCP will do), in which case the same problem will
1688 recur, or the sender will not realize that its packet has been dropped
1689 and data will simply be lost (as some UDP-based protocols will do).
1690 Either way, it is possible that no forward progress will ever occur.
1692 <column name="ingress_policing_rate">
1694 Maximum rate for data received on this interface, in kbps. Data
1695 received faster than this rate is dropped. Set to <code>0</code>
1696 (the default) to disable policing.
1700 <column name="ingress_policing_burst">
1701 <p>Maximum burst size for data received on this interface, in kb. The
1702 default burst size if set to <code>0</code> is 1000 kb. This value
1703 has no effect if <ref column="ingress_policing_rate"/>
1704 is <code>0</code>.</p>
1706 Specifying a larger burst size lets the algorithm be more forgiving,
1707 which is important for protocols like TCP that react severely to
1708 dropped packets. The burst size should be at least the size of the
1709 interface's MTU. Specifying a value that is numerically at least as
1710 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1711 closer to achieving the full rate.
1716 <group title="Connectivity Fault Management">
1718 802.1ag Connectivity Fault Management (CFM) allows a group of
1719 Maintenance Points (MPs) called a Maintenance Association (MA) to
1720 detect connectivity problems with each other. MPs within a MA should
1721 have complete and exclusive interconnectivity. This is verified by
1722 occasionally broadcasting Continuity Check Messages (CCMs) at a
1723 configurable transmission interval.
1727 According to the 802.1ag specification, each Maintenance Point should
1728 be configured out-of-band with a list of Remote Maintenance Points it
1729 should have connectivity to. Open vSwitch differs from the
1730 specification in this area. It simply assumes the link is faulted if
1731 no Remote Maintenance Points are reachable, and considers it not
1736 When operating over tunnels which have no <code>in_key</code>, or an
1737 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1738 with a tunnel key of zero.
1741 <column name="cfm_mpid">
1742 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1743 a Maintenance Association. The MPID is used to identify this endpoint
1744 to other Maintenance Points in the MA. Each end of a link being
1745 monitored should have a different MPID. Must be configured to enable
1746 CFM on this <ref table="Interface"/>.
1749 <column name="cfm_fault">
1751 Indicates a connectivity fault triggered by an inability to receive
1752 heartbeats from any remote endpoint. When a fault is triggered on
1753 <ref table="Interface"/>s participating in bonds, they will be
1757 Faults can be triggered for several reasons. Most importantly they
1758 are triggered when no CCMs are received for a period of 3.5 times the
1759 transmission interval. Faults are also triggered when any CCMs
1760 indicate that a Remote Maintenance Point is not receiving CCMs but
1761 able to send them. Finally, a fault is triggered if a CCM is
1762 received which indicates unexpected configuration. Notably, this
1763 case arises when a CCM is received which advertises the local MPID.
1767 <column name="cfm_fault_status" key="recv">
1768 Indicates a CFM fault was triggered due to a lack of CCMs received on
1769 the <ref table="Interface"/>.
1772 <column name="cfm_fault_status" key="rdi">
1773 Indicates a CFM fault was triggered due to the reception of a CCM with
1774 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1775 are not receiving CCMs themselves. This typically indicates a
1776 unidirectional connectivity failure.
1779 <column name="cfm_fault_status" key="maid">
1780 Indicates a CFM fault was triggered due to the reception of a CCM with
1781 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1782 with an identification number in addition to the MPID called the MAID.
1783 Open vSwitch only supports receiving CCM broadcasts tagged with the
1784 MAID it uses internally.
1787 <column name="cfm_fault_status" key="loopback">
1788 Indicates a CFM fault was triggered due to the reception of a CCM
1789 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1790 column of this <ref table="Interface"/>. This may indicate a loop in
1794 <column name="cfm_fault_status" key="overflow">
1795 Indicates a CFM fault was triggered because the CFM module received
1796 CCMs from more remote endpoints than it can keep track of.
1799 <column name="cfm_fault_status" key="override">
1800 Indicates a CFM fault was manually triggered by an administrator using
1801 an <code>ovs-appctl</code> command.
1804 <column name="cfm_fault_status" key="interval">
1805 Indicates a CFM fault was triggered due to the reception of a CCM
1806 frame having an invalid interval.
1809 <column name="cfm_remote_opstate">
1810 <p>When in extended mode, indicates the operational state of the
1811 remote endpoint as either <code>up</code> or <code>down</code>. See
1812 <ref column="other_config" key="cfm_opstate"/>.
1816 <column name="cfm_health">
1818 Indicates the health of the interface as a percentage of CCM frames
1819 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1820 The health of an interface is undefined if it is communicating with
1821 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1822 healthy heartbeats are not received at the expected rate, and
1823 gradually improves as healthy heartbeats are received at the desired
1824 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1825 health of the interface is refreshed.
1828 As mentioned above, the faults can be triggered for several reasons.
1829 The link health will deteriorate even if heartbeats are received but
1830 they are reported to be unhealthy. An unhealthy heartbeat in this
1831 context is a heartbeat for which either some fault is set or is out
1832 of sequence. The interface health can be 100 only on receiving
1833 healthy heartbeats at the desired rate.
1837 <column name="cfm_remote_mpids">
1838 When CFM is properly configured, Open vSwitch will occasionally
1839 receive CCM broadcasts. These broadcasts contain the MPID of the
1840 sending Maintenance Point. The list of MPIDs from which this
1841 <ref table="Interface"/> is receiving broadcasts from is regularly
1842 collected and written to this column.
1845 <column name="other_config" key="cfm_interval"
1846 type='{"type": "integer"}'>
1848 The interval, in milliseconds, between transmissions of CFM
1849 heartbeats. Three missed heartbeat receptions indicate a
1854 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1855 60,000, or 600,000 ms are supported. Other values will be rounded
1856 down to the nearest value on the list. Extended mode (see <ref
1857 column="other_config" key="cfm_extended"/>) supports any interval up
1858 to 65,535 ms. In either mode, the default is 1000 ms.
1861 <p>We do not recommend using intervals less than 100 ms.</p>
1864 <column name="other_config" key="cfm_extended"
1865 type='{"type": "boolean"}'>
1866 When <code>true</code>, the CFM module operates in extended mode. This
1867 causes it to use a nonstandard destination address to avoid conflicting
1868 with compliant implementations which may be running concurrently on the
1869 network. Furthermore, extended mode increases the accuracy of the
1870 <code>cfm_interval</code> configuration parameter by breaking wire
1871 compatibility with 802.1ag compliant implementations. Defaults to
1874 <column name="other_config" key="cfm_opstate"
1875 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1876 When <code>down</code>, the CFM module marks all CCMs it generates as
1877 operationally down without triggering a fault. This allows remote
1878 maintenance points to choose not to forward traffic to the
1879 <ref table="Interface"/> on which this CFM module is running.
1880 Currently, in Open vSwitch, the opdown bit of CCMs affects
1881 <ref table="Interface"/>s participating in bonds, and the bundle
1882 OpenFlow action. This setting is ignored when CFM is not in extended
1883 mode. Defaults to <code>up</code>.
1886 <column name="other_config" key="cfm_ccm_vlan"
1887 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1888 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1889 with the given value. May be the string <code>random</code> in which
1890 case each CCM will be tagged with a different randomly generated VLAN.
1893 <column name="other_config" key="cfm_ccm_pcp"
1894 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1895 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1896 with the given PCP value, the VLAN ID of the tag is governed by the
1897 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1898 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1904 <group title="Bonding Configuration">
1905 <column name="other_config" key="bond-stable-id"
1906 type='{"type": "integer", "minInteger": 1}'>
1907 Used in <code>stable</code> bond mode to make slave
1908 selection decisions. Allocating <ref column="other_config"
1909 key="bond-stable-id"/> values consistently across interfaces
1910 participating in a bond will guarantee consistent slave selection
1911 decisions across <code>ovs-vswitchd</code> instances when using
1912 <code>stable</code> bonding mode.
1915 <column name="other_config" key="lacp-port-id"
1916 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1917 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1918 used in LACP negotiations to identify individual ports
1919 participating in a bond.
1922 <column name="other_config" key="lacp-port-priority"
1923 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1924 The LACP port priority of this <ref table="Interface"/>. In LACP
1925 negotiations <ref table="Interface"/>s with numerically lower
1926 priorities are preferred for aggregation.
1929 <column name="other_config" key="lacp-aggregation-key"
1930 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1931 The LACP aggregation key of this <ref table="Interface"/>. <ref
1932 table="Interface"/>s with different aggregation keys may not be active
1933 within a given <ref table="Port"/> at the same time.
1937 <group title="Virtual Machine Identifiers">
1939 These key-value pairs specifically apply to an interface that
1940 represents a virtual Ethernet interface connected to a virtual
1941 machine. These key-value pairs should not be present for other types
1942 of interfaces. Keys whose names end in <code>-uuid</code> have
1943 values that uniquely identify the entity in question. For a Citrix
1944 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1945 Other hypervisors may use other formats.
1948 <column name="external_ids" key="attached-mac">
1949 The MAC address programmed into the ``virtual hardware'' for this
1950 interface, in the form
1951 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1952 For Citrix XenServer, this is the value of the <code>MAC</code> field
1953 in the VIF record for this interface.
1956 <column name="external_ids" key="iface-id">
1957 A system-unique identifier for the interface. On XenServer, this will
1958 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1961 <column name="external_ids" key="iface-status"
1962 type='{"type": "string",
1963 "enum": ["set", ["active", "inactive"]]}'>
1965 Hypervisors may sometimes have more than one interface associated
1966 with a given <ref column="external_ids" key="iface-id"/>, only one of
1967 which is actually in use at a given time. For example, in some
1968 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1969 for a single <ref column="external_ids" key="iface-id"/>, but only
1970 uses one of them at a time. A hypervisor that behaves this way must
1971 mark the currently in use interface <code>active</code> and the
1972 others <code>inactive</code>. A hypervisor that never has more than
1973 one interface for a given <ref column="external_ids" key="iface-id"/>
1974 may mark that interface <code>active</code> or omit <ref
1975 column="external_ids" key="iface-status"/> entirely.
1979 During VM migration, a given <ref column="external_ids"
1980 key="iface-id"/> might transiently be marked <code>active</code> on
1981 two different hypervisors. That is, <code>active</code> means that
1982 this <ref column="external_ids" key="iface-id"/> is the active
1983 instance within a single hypervisor, not in a broader scope.
1987 <column name="external_ids" key="xs-vif-uuid">
1988 The virtual interface associated with this interface.
1991 <column name="external_ids" key="xs-network-uuid">
1992 The virtual network to which this interface is attached.
1995 <column name="external_ids" key="vm-id">
1996 The VM to which this interface belongs. On XenServer, this will be the
1997 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2000 <column name="external_ids" key="xs-vm-uuid">
2001 The VM to which this interface belongs.
2005 <group title="VLAN Splinters">
2007 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2008 with buggy network drivers in old versions of Linux that do not
2009 properly support VLANs when VLAN devices are not used, at some cost
2010 in memory and performance.
2014 When VLAN splinters are enabled on a particular interface, Open vSwitch
2015 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2016 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2017 received on the VLAN device is treated as if it had been received on
2018 the interface on the particular VLAN.
2022 VLAN splinters consider a VLAN to be in use if:
2027 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2028 table="Port"/> record.
2032 The VLAN is listed within the <ref table="Port" column="trunks"/>
2033 column of the <ref table="Port"/> record of an interface on which
2034 VLAN splinters are enabled.
2036 An empty <ref table="Port" column="trunks"/> does not influence the
2037 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2038 will exceed the current 1,024 port per datapath limit.
2042 An OpenFlow flow within any bridge matches the VLAN.
2047 The same set of in-use VLANs applies to every interface on which VLAN
2048 splinters are enabled. That is, the set is not chosen separately for
2049 each interface but selected once as the union of all in-use VLANs based
2054 It does not make sense to enable VLAN splinters on an interface for an
2055 access port, or on an interface that is not a physical port.
2059 VLAN splinters are deprecated. When broken device drivers are no
2060 longer in widespread use, we will delete this feature.
2063 <column name="other_config" key="enable-vlan-splinters"
2064 type='{"type": "boolean"}'>
2066 Set to <code>true</code> to enable VLAN splinters on this interface.
2067 Defaults to <code>false</code>.
2071 VLAN splinters increase kernel and userspace memory overhead, so do
2072 not use them unless they are needed.
2076 VLAN splinters do not support 802.1p priority tags. Received
2077 priorities will appear to be 0, regardless of their actual values,
2078 and priorities on transmitted packets will also be cleared to 0.
2083 <group title="Common Columns">
2084 The overall purpose of these columns is described under <code>Common
2085 Columns</code> at the beginning of this document.
2087 <column name="other_config"/>
2088 <column name="external_ids"/>
2092 <table name="Flow_Table" title="OpenFlow table configuration">
2093 <p>Configuration for a particular OpenFlow table.</p>
2095 <column name="name">
2096 The table's name. Set this column to change the name that controllers
2097 will receive when they request table statistics, e.g. <code>ovs-ofctl
2098 dump-tables</code>. The name does not affect switch behavior.
2101 <column name="flow_limit">
2102 If set, limits the number of flows that may be added to the table. Open
2103 vSwitch may limit the number of flows in a table for other reasons,
2104 e.g. due to hardware limitations or for resource availability or
2105 performance reasons.
2108 <column name="overflow_policy">
2110 Controls the switch's behavior when an OpenFlow flow table modification
2111 request would add flows in excess of <ref column="flow_limit"/>. The
2112 supported values are:
2116 <dt><code>refuse</code></dt>
2118 Refuse to add the flow or flows. This is also the default policy
2119 when <ref column="overflow_policy"/> is unset.
2122 <dt><code>evict</code></dt>
2124 Delete the flow that will expire soonest. See <ref column="groups"/>
2130 <column name="groups">
2132 When <ref column="overflow_policy"/> is <code>evict</code>, this
2133 controls how flows are chosen for eviction when the flow table would
2134 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2135 of NXM fields or sub-fields, each of which takes one of the forms
2136 <code><var>field</var>[]</code> or
2137 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2138 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2139 <code>nicira-ext.h</code> for a complete list of NXM field names.
2143 When a flow must be evicted due to overflow, the flow to evict is
2144 chosen through an approximation of the following algorithm:
2149 Divide the flows in the table into groups based on the values of the
2150 specified fields or subfields, so that all of the flows in a given
2151 group have the same values for those fields. If a flow does not
2152 specify a given field, that field's value is treated as 0.
2156 Consider the flows in the largest group, that is, the group that
2157 contains the greatest number of flows. If two or more groups all
2158 have the same largest number of flows, consider the flows in all of
2163 Among the flows under consideration, choose the flow that expires
2164 soonest for eviction.
2169 The eviction process only considers flows that have an idle timeout or
2170 a hard timeout. That is, eviction never deletes permanent flows.
2171 (Permanent flows do count against <ref column="flow_limit"/>.)
2175 Open vSwitch ignores any invalid or unknown field specifications.
2179 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2180 column has no effect.
2185 <table name="QoS" title="Quality of Service configuration">
2186 <p>Quality of Service (QoS) configuration for each Port that
2189 <column name="type">
2190 <p>The type of QoS to implement. The currently defined types are
2193 <dt><code>linux-htb</code></dt>
2195 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2196 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2197 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2198 for information on how this classifier works and how to configure it.
2202 <dt><code>linux-hfsc</code></dt>
2204 Linux "Hierarchical Fair Service Curve" classifier.
2205 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2206 information on how this classifier works.
2211 <column name="queues">
2212 <p>A map from queue numbers to <ref table="Queue"/> records. The
2213 supported range of queue numbers depend on <ref column="type"/>. The
2214 queue numbers are the same as the <code>queue_id</code> used in
2215 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2219 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2220 actions when no specific queue has been set. When no configuration for
2221 queue 0 is present, it is automatically configured as if a <ref
2222 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2223 and <ref table="Queue" column="other_config"/> columns had been
2225 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2226 this case. With some queuing disciplines, this dropped all packets
2227 destined for the default queue.)
2231 <group title="Configuration for linux-htb and linux-hfsc">
2233 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2234 the following key-value pair:
2237 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2238 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2239 specified, for physical interfaces, the default is the link rate. For
2240 other interfaces or if the link rate cannot be determined, the default
2241 is currently 100 Mbps.
2245 <group title="Common Columns">
2246 The overall purpose of these columns is described under <code>Common
2247 Columns</code> at the beginning of this document.
2249 <column name="other_config"/>
2250 <column name="external_ids"/>
2254 <table name="Queue" title="QoS output queue.">
2255 <p>A configuration for a port output queue, used in configuring Quality of
2256 Service (QoS) features. May be referenced by <ref column="queues"
2257 table="QoS"/> column in <ref table="QoS"/> table.</p>
2259 <column name="dscp">
2260 If set, Open vSwitch will mark all traffic egressing this
2261 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2262 default <ref table="Queue"/> is only marked if it was explicitly selected
2263 as the <ref table="Queue"/> at the time the packet was output. If unset,
2264 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2268 <group title="Configuration for linux-htb QoS">
2270 <ref table="QoS"/> <ref table="QoS" column="type"/>
2271 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2272 It has the following key-value pairs defined.
2275 <column name="other_config" key="min-rate"
2276 type='{"type": "integer", "minInteger": 1}'>
2277 Minimum guaranteed bandwidth, in bit/s.
2280 <column name="other_config" key="max-rate"
2281 type='{"type": "integer", "minInteger": 1}'>
2282 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2283 queue's rate will not be allowed to exceed the specified value, even
2284 if excess bandwidth is available. If unspecified, defaults to no
2288 <column name="other_config" key="burst"
2289 type='{"type": "integer", "minInteger": 1}'>
2290 Burst size, in bits. This is the maximum amount of ``credits'' that a
2291 queue can accumulate while it is idle. Optional. Details of the
2292 <code>linux-htb</code> implementation require a minimum burst size, so
2293 a too-small <code>burst</code> will be silently ignored.
2296 <column name="other_config" key="priority"
2297 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2298 A queue with a smaller <code>priority</code> will receive all the
2299 excess bandwidth that it can use before a queue with a larger value
2300 receives any. Specific priority values are unimportant; only relative
2301 ordering matters. Defaults to 0 if unspecified.
2305 <group title="Configuration for linux-hfsc QoS">
2307 <ref table="QoS"/> <ref table="QoS" column="type"/>
2308 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2309 It has the following key-value pairs defined.
2312 <column name="other_config" key="min-rate"
2313 type='{"type": "integer", "minInteger": 1}'>
2314 Minimum guaranteed bandwidth, in bit/s.
2317 <column name="other_config" key="max-rate"
2318 type='{"type": "integer", "minInteger": 1}'>
2319 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2320 queue's rate will not be allowed to exceed the specified value, even if
2321 excess bandwidth is available. If unspecified, defaults to no
2326 <group title="Common Columns">
2327 The overall purpose of these columns is described under <code>Common
2328 Columns</code> at the beginning of this document.
2330 <column name="other_config"/>
2331 <column name="external_ids"/>
2335 <table name="Mirror" title="Port mirroring.">
2336 <p>A port mirror within a <ref table="Bridge"/>.</p>
2337 <p>A port mirror configures a bridge to send selected frames to special
2338 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2339 traffic may also be referred to as SPAN or RSPAN, depending on how
2340 the mirrored traffic is sent.</p>
2342 <column name="name">
2343 Arbitrary identifier for the <ref table="Mirror"/>.
2346 <group title="Selecting Packets for Mirroring">
2348 To be selected for mirroring, a given packet must enter or leave the
2349 bridge through a selected port and it must also be in one of the
2353 <column name="select_all">
2354 If true, every packet arriving or departing on any port is
2355 selected for mirroring.
2358 <column name="select_dst_port">
2359 Ports on which departing packets are selected for mirroring.
2362 <column name="select_src_port">
2363 Ports on which arriving packets are selected for mirroring.
2366 <column name="select_vlan">
2367 VLANs on which packets are selected for mirroring. An empty set
2368 selects packets on all VLANs.
2372 <group title="Mirroring Destination Configuration">
2374 These columns are mutually exclusive. Exactly one of them must be
2378 <column name="output_port">
2379 <p>Output port for selected packets, if nonempty.</p>
2380 <p>Specifying a port for mirror output reserves that port exclusively
2381 for mirroring. No frames other than those selected for mirroring
2383 will be forwarded to the port, and any frames received on the port
2384 will be discarded.</p>
2386 The output port may be any kind of port supported by Open vSwitch.
2387 It may be, for example, a physical port (sometimes called SPAN) or a
2392 <column name="output_vlan">
2393 <p>Output VLAN for selected packets, if nonempty.</p>
2394 <p>The frames will be sent out all ports that trunk
2395 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2396 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2397 trunk port, the frame's VLAN tag will be set to
2398 <ref column="output_vlan"/>, replacing any existing tag; when it is
2399 sent out an implicit VLAN port, the frame will not be tagged. This
2400 type of mirroring is sometimes called RSPAN.</p>
2402 See the documentation for
2403 <ref column="other_config" key="forward-bpdu"/> in the
2404 <ref table="Interface"/> table for a list of destination MAC
2405 addresses which will not be mirrored to a VLAN to avoid confusing
2406 switches that interpret the protocols that they represent.
2408 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2409 contains unmanaged switches. Consider an unmanaged physical switch
2410 with two ports: port 1, connected to an end host, and port 2,
2411 connected to an Open vSwitch configured to mirror received packets
2412 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2413 port 1 that the physical switch forwards to port 2. The Open vSwitch
2414 forwards this packet to its destination and then reflects it back on
2415 port 2 in VLAN 123. This reflected packet causes the unmanaged
2416 physical switch to replace the MAC learning table entry, which
2417 correctly pointed to port 1, with one that incorrectly points to port
2418 2. Afterward, the physical switch will direct packets destined for
2419 the end host to the Open vSwitch on port 2, instead of to the end
2420 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2421 desired in this scenario, then the physical switch must be replaced
2422 by one that learns Ethernet addresses on a per-VLAN basis. In
2423 addition, learning should be disabled on the VLAN containing mirrored
2424 traffic. If this is not done then intermediate switches will learn
2425 the MAC address of each end host from the mirrored traffic. If
2426 packets being sent to that end host are also mirrored, then they will
2427 be dropped since the switch will attempt to send them out the input
2428 port. Disabling learning for the VLAN will cause the switch to
2429 correctly send the packet out all ports configured for that VLAN. If
2430 Open vSwitch is being used as an intermediate switch, learning can be
2431 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2432 in the appropriate <ref table="Bridge"/> table or tables.</p>
2434 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2435 VLAN and should generally be preferred.
2440 <group title="Statistics: Mirror counters">
2442 Key-value pairs that report mirror statistics.
2444 <column name="statistics" key="tx_packets">
2445 Number of packets transmitted through this mirror.
2447 <column name="statistics" key="tx_bytes">
2448 Number of bytes transmitted through this mirror.
2452 <group title="Common Columns">
2453 The overall purpose of these columns is described under <code>Common
2454 Columns</code> at the beginning of this document.
2456 <column name="external_ids"/>
2460 <table name="Controller" title="OpenFlow controller configuration.">
2461 <p>An OpenFlow controller.</p>
2464 Open vSwitch supports two kinds of OpenFlow controllers:
2468 <dt>Primary controllers</dt>
2471 This is the kind of controller envisioned by the OpenFlow 1.0
2472 specification. Usually, a primary controller implements a network
2473 policy by taking charge of the switch's flow table.
2477 Open vSwitch initiates and maintains persistent connections to
2478 primary controllers, retrying the connection each time it fails or
2479 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2480 <ref table="Bridge"/> table applies to primary controllers.
2484 Open vSwitch permits a bridge to have any number of primary
2485 controllers. When multiple controllers are configured, Open
2486 vSwitch connects to all of them simultaneously. Because
2487 OpenFlow 1.0 does not specify how multiple controllers
2488 coordinate in interacting with a single switch, more than
2489 one primary controller should be specified only if the
2490 controllers are themselves designed to coordinate with each
2491 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2492 vendor extension may be useful for this.)
2495 <dt>Service controllers</dt>
2498 These kinds of OpenFlow controller connections are intended for
2499 occasional support and maintenance use, e.g. with
2500 <code>ovs-ofctl</code>. Usually a service controller connects only
2501 briefly to inspect or modify some of a switch's state.
2505 Open vSwitch listens for incoming connections from service
2506 controllers. The service controllers initiate and, if necessary,
2507 maintain the connections from their end. The <ref table="Bridge"
2508 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2509 not apply to service controllers.
2513 Open vSwitch supports configuring any number of service controllers.
2519 The <ref column="target"/> determines the type of controller.
2522 <group title="Core Features">
2523 <column name="target">
2524 <p>Connection method for controller.</p>
2526 The following connection methods are currently supported for primary
2530 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2532 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2533 the given <var>ip</var>, which must be expressed as an IP address
2534 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2535 column in the <ref table="Open_vSwitch"/> table must point to a
2536 valid SSL configuration when this form is used.</p>
2537 <p>SSL support is an optional feature that is not always built as
2538 part of Open vSwitch.</p>
2540 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2541 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2542 the given <var>ip</var>, which must be expressed as an IP address
2543 (not a DNS name).</dd>
2546 The following connection methods are currently supported for service
2550 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2553 Listens for SSL connections on the specified TCP <var>port</var>
2554 (default: 6633). If <var>ip</var>, which must be expressed as an
2555 IP address (not a DNS name), is specified, then connections are
2556 restricted to the specified local IP address.
2559 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2560 table="Open_vSwitch"/> table must point to a valid SSL
2561 configuration when this form is used.
2563 <p>SSL support is an optional feature that is not always built as
2564 part of Open vSwitch.</p>
2566 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2568 Listens for connections on the specified TCP <var>port</var>
2569 (default: 6633). If <var>ip</var>, which must be expressed as an
2570 IP address (not a DNS name), is specified, then connections are
2571 restricted to the specified local IP address.
2574 <p>When multiple controllers are configured for a single bridge, the
2575 <ref column="target"/> values must be unique. Duplicate
2576 <ref column="target"/> values yield unspecified results.</p>
2579 <column name="connection_mode">
2580 <p>If it is specified, this setting must be one of the following
2581 strings that describes how Open vSwitch contacts this OpenFlow
2582 controller over the network:</p>
2585 <dt><code>in-band</code></dt>
2586 <dd>In this mode, this controller's OpenFlow traffic travels over the
2587 bridge associated with the controller. With this setting, Open
2588 vSwitch allows traffic to and from the controller regardless of the
2589 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2590 would never be able to connect to the controller, because it did
2591 not have a flow to enable it.) This is the most common connection
2592 mode because it is not necessary to maintain two independent
2594 <dt><code>out-of-band</code></dt>
2595 <dd>In this mode, OpenFlow traffic uses a control network separate
2596 from the bridge associated with this controller, that is, the
2597 bridge does not use any of its own network devices to communicate
2598 with the controller. The control network must be configured
2599 separately, before or after <code>ovs-vswitchd</code> is started.
2603 <p>If not specified, the default is implementation-specific.</p>
2607 <group title="Controller Failure Detection and Handling">
2608 <column name="max_backoff">
2609 Maximum number of milliseconds to wait between connection attempts.
2610 Default is implementation-specific.
2613 <column name="inactivity_probe">
2614 Maximum number of milliseconds of idle time on connection to
2615 controller before sending an inactivity probe message. If Open
2616 vSwitch does not communicate with the controller for the specified
2617 number of seconds, it will send a probe. If a response is not
2618 received for the same additional amount of time, Open vSwitch
2619 assumes the connection has been broken and attempts to reconnect.
2620 Default is implementation-specific. A value of 0 disables
2625 <group title="Asynchronous Message Configuration">
2627 OpenFlow switches send certain messages to controllers spontanenously,
2628 that is, not in response to any request from the controller. These
2629 messages are called ``asynchronous messages.'' These columns allow
2630 asynchronous messages to be limited or disabled to ensure the best use
2631 of network resources.
2634 <column name="enable_async_messages">
2635 The OpenFlow protocol enables asynchronous messages at time of
2636 connection establishment, which means that a controller can receive
2637 asynchronous messages, potentially many of them, even if it turns them
2638 off immediately after connecting. Set this column to
2639 <code>false</code> to change Open vSwitch behavior to disable, by
2640 default, all asynchronous messages. The controller can use the
2641 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2642 on any messages that it does want to receive, if any.
2645 <column name="controller_rate_limit">
2647 The maximum rate at which the switch will forward packets to the
2648 OpenFlow controller, in packets per second. This feature prevents a
2649 single bridge from overwhelming the controller. If not specified,
2650 the default is implementation-specific.
2654 In addition, when a high rate triggers rate-limiting, Open vSwitch
2655 queues controller packets for each port and transmits them to the
2656 controller at the configured rate. The <ref
2657 column="controller_burst_limit"/> value limits the number of queued
2658 packets. Ports on a bridge share the packet queue fairly.
2662 Open vSwitch maintains two such packet rate-limiters per bridge: one
2663 for packets sent up to the controller because they do not correspond
2664 to any flow, and the other for packets sent up to the controller by
2665 request through flow actions. When both rate-limiters are filled with
2666 packets, the actual rate that packets are sent to the controller is
2667 up to twice the specified rate.
2671 <column name="controller_burst_limit">
2672 In conjunction with <ref column="controller_rate_limit"/>,
2673 the maximum number of unused packet credits that the bridge will
2674 allow to accumulate, in packets. If not specified, the default
2675 is implementation-specific.
2679 <group title="Additional In-Band Configuration">
2680 <p>These values are considered only in in-band control mode (see
2681 <ref column="connection_mode"/>).</p>
2683 <p>When multiple controllers are configured on a single bridge, there
2684 should be only one set of unique values in these columns. If different
2685 values are set for these columns in different controllers, the effect
2688 <column name="local_ip">
2689 The IP address to configure on the local port,
2690 e.g. <code>192.168.0.123</code>. If this value is unset, then
2691 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2695 <column name="local_netmask">
2696 The IP netmask to configure on the local port,
2697 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2698 but this value is unset, then the default is chosen based on whether
2699 the IP address is class A, B, or C.
2702 <column name="local_gateway">
2703 The IP address of the gateway to configure on the local port, as a
2704 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2705 this network has no gateway.
2709 <group title="Controller Status">
2710 <column name="is_connected">
2711 <code>true</code> if currently connected to this controller,
2712 <code>false</code> otherwise.
2716 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2717 <p>The level of authority this controller has on the associated
2718 bridge. Possible values are:</p>
2720 <dt><code>other</code></dt>
2721 <dd>Allows the controller access to all OpenFlow features.</dd>
2722 <dt><code>master</code></dt>
2723 <dd>Equivalent to <code>other</code>, except that there may be at
2724 most one master controller at a time. When a controller configures
2725 itself as <code>master</code>, any existing master is demoted to
2726 the <code>slave</code>role.</dd>
2727 <dt><code>slave</code></dt>
2728 <dd>Allows the controller read-only access to OpenFlow features.
2729 Attempts to modify the flow table will be rejected with an
2730 error. Slave controllers do not receive OFPT_PACKET_IN or
2731 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2736 <column name="status" key="last_error">
2737 A human-readable description of the last error on the connection
2738 to the controller; i.e. <code>strerror(errno)</code>. This key
2739 will exist only if an error has occurred.
2742 <column name="status" key="state"
2743 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2745 The state of the connection to the controller:
2748 <dt><code>VOID</code></dt>
2749 <dd>Connection is disabled.</dd>
2751 <dt><code>BACKOFF</code></dt>
2752 <dd>Attempting to reconnect at an increasing period.</dd>
2754 <dt><code>CONNECTING</code></dt>
2755 <dd>Attempting to connect.</dd>
2757 <dt><code>ACTIVE</code></dt>
2758 <dd>Connected, remote host responsive.</dd>
2760 <dt><code>IDLE</code></dt>
2761 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2764 These values may change in the future. They are provided only for
2769 <column name="status" key="sec_since_connect"
2770 type='{"type": "integer", "minInteger": 0}'>
2771 The amount of time since this controller last successfully connected to
2772 the switch (in seconds). Value is empty if controller has never
2773 successfully connected.
2776 <column name="status" key="sec_since_disconnect"
2777 type='{"type": "integer", "minInteger": 1}'>
2778 The amount of time since this controller last disconnected from
2779 the switch (in seconds). Value is empty if controller has never
2784 <group title="Connection Parameters">
2786 Additional configuration for a connection between the controller
2787 and the Open vSwitch.
2790 <column name="other_config" key="dscp"
2791 type='{"type": "integer"}'>
2792 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2793 in the Type of Service (TOS) field in the IP header. DSCP provides a
2794 mechanism to classify the network traffic and provide Quality of
2795 Service (QoS) on IP networks.
2797 The DSCP value specified here is used when establishing the connection
2798 between the controller and the Open vSwitch. If no value is specified,
2799 a default value of 48 is chosen. Valid DSCP values must be in the
2805 <group title="Common Columns">
2806 The overall purpose of these columns is described under <code>Common
2807 Columns</code> at the beginning of this document.
2809 <column name="external_ids"/>
2810 <column name="other_config"/>
2814 <table name="Manager" title="OVSDB management connection.">
2816 Configuration for a database connection to an Open vSwitch database
2821 This table primarily configures the Open vSwitch database
2822 (<code>ovsdb-server</code>), not the Open vSwitch switch
2823 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2824 what connections should be treated as in-band.
2828 The Open vSwitch database server can initiate and maintain active
2829 connections to remote clients. It can also listen for database
2833 <group title="Core Features">
2834 <column name="target">
2835 <p>Connection method for managers.</p>
2837 The following connection methods are currently supported:
2840 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2843 The specified SSL <var>port</var> (default: 6632) on the host at
2844 the given <var>ip</var>, which must be expressed as an IP address
2845 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2846 column in the <ref table="Open_vSwitch"/> table must point to a
2847 valid SSL configuration when this form is used.
2850 SSL support is an optional feature that is not always built as
2851 part of Open vSwitch.
2855 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2857 The specified TCP <var>port</var> (default: 6632) on the host at
2858 the given <var>ip</var>, which must be expressed as an IP address
2861 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2864 Listens for SSL connections on the specified TCP <var>port</var>
2865 (default: 6632). If <var>ip</var>, which must be expressed as an
2866 IP address (not a DNS name), is specified, then connections are
2867 restricted to the specified local IP address.
2870 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2871 table="Open_vSwitch"/> table must point to a valid SSL
2872 configuration when this form is used.
2875 SSL support is an optional feature that is not always built as
2876 part of Open vSwitch.
2879 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2881 Listens for connections on the specified TCP <var>port</var>
2882 (default: 6632). If <var>ip</var>, which must be expressed as an
2883 IP address (not a DNS name), is specified, then connections are
2884 restricted to the specified local IP address.
2887 <p>When multiple managers are configured, the <ref column="target"/>
2888 values must be unique. Duplicate <ref column="target"/> values yield
2889 unspecified results.</p>
2892 <column name="connection_mode">
2894 If it is specified, this setting must be one of the following strings
2895 that describes how Open vSwitch contacts this OVSDB client over the
2900 <dt><code>in-band</code></dt>
2902 In this mode, this connection's traffic travels over a bridge
2903 managed by Open vSwitch. With this setting, Open vSwitch allows
2904 traffic to and from the client regardless of the contents of the
2905 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2906 to connect to the client, because it did not have a flow to enable
2907 it.) This is the most common connection mode because it is not
2908 necessary to maintain two independent networks.
2910 <dt><code>out-of-band</code></dt>
2912 In this mode, the client's traffic uses a control network separate
2913 from that managed by Open vSwitch, that is, Open vSwitch does not
2914 use any of its own network devices to communicate with the client.
2915 The control network must be configured separately, before or after
2916 <code>ovs-vswitchd</code> is started.
2921 If not specified, the default is implementation-specific.
2926 <group title="Client Failure Detection and Handling">
2927 <column name="max_backoff">
2928 Maximum number of milliseconds to wait between connection attempts.
2929 Default is implementation-specific.
2932 <column name="inactivity_probe">
2933 Maximum number of milliseconds of idle time on connection to the client
2934 before sending an inactivity probe message. If Open vSwitch does not
2935 communicate with the client for the specified number of seconds, it
2936 will send a probe. If a response is not received for the same
2937 additional amount of time, Open vSwitch assumes the connection has been
2938 broken and attempts to reconnect. Default is implementation-specific.
2939 A value of 0 disables inactivity probes.
2943 <group title="Status">
2944 <column name="is_connected">
2945 <code>true</code> if currently connected to this manager,
2946 <code>false</code> otherwise.
2949 <column name="status" key="last_error">
2950 A human-readable description of the last error on the connection
2951 to the manager; i.e. <code>strerror(errno)</code>. This key
2952 will exist only if an error has occurred.
2955 <column name="status" key="state"
2956 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2958 The state of the connection to the manager:
2961 <dt><code>VOID</code></dt>
2962 <dd>Connection is disabled.</dd>
2964 <dt><code>BACKOFF</code></dt>
2965 <dd>Attempting to reconnect at an increasing period.</dd>
2967 <dt><code>CONNECTING</code></dt>
2968 <dd>Attempting to connect.</dd>
2970 <dt><code>ACTIVE</code></dt>
2971 <dd>Connected, remote host responsive.</dd>
2973 <dt><code>IDLE</code></dt>
2974 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2977 These values may change in the future. They are provided only for
2982 <column name="status" key="sec_since_connect"
2983 type='{"type": "integer", "minInteger": 0}'>
2984 The amount of time since this manager last successfully connected
2985 to the database (in seconds). Value is empty if manager has never
2986 successfully connected.
2989 <column name="status" key="sec_since_disconnect"
2990 type='{"type": "integer", "minInteger": 0}'>
2991 The amount of time since this manager last disconnected from the
2992 database (in seconds). Value is empty if manager has never
2996 <column name="status" key="locks_held">
2997 Space-separated list of the names of OVSDB locks that the connection
2998 holds. Omitted if the connection does not hold any locks.
3001 <column name="status" key="locks_waiting">
3002 Space-separated list of the names of OVSDB locks that the connection is
3003 currently waiting to acquire. Omitted if the connection is not waiting
3007 <column name="status" key="locks_lost">
3008 Space-separated list of the names of OVSDB locks that the connection
3009 has had stolen by another OVSDB client. Omitted if no locks have been
3010 stolen from this connection.
3013 <column name="status" key="n_connections"
3014 type='{"type": "integer", "minInteger": 2}'>
3016 When <ref column="target"/> specifies a connection method that
3017 listens for inbound connections (e.g. <code>ptcp:</code> or
3018 <code>pssl:</code>) and more than one connection is actually active,
3019 the value is the number of active connections. Otherwise, this
3020 key-value pair is omitted.
3023 When multiple connections are active, status columns and key-value
3024 pairs (other than this one) report the status of one arbitrarily
3030 <group title="Connection Parameters">
3032 Additional configuration for a connection between the manager
3033 and the Open vSwitch Database.
3036 <column name="other_config" key="dscp"
3037 type='{"type": "integer"}'>
3038 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3039 in the Type of Service (TOS) field in the IP header. DSCP provides a
3040 mechanism to classify the network traffic and provide Quality of
3041 Service (QoS) on IP networks.
3043 The DSCP value specified here is used when establishing the connection
3044 between the manager and the Open vSwitch. If no value is specified, a
3045 default value of 48 is chosen. Valid DSCP values must be in the range
3050 <group title="Common Columns">
3051 The overall purpose of these columns is described under <code>Common
3052 Columns</code> at the beginning of this document.
3054 <column name="external_ids"/>
3055 <column name="other_config"/>
3059 <table name="NetFlow">
3060 A NetFlow target. NetFlow is a protocol that exports a number of
3061 details about terminating IP flows, such as the principals involved
3064 <column name="targets">
3065 NetFlow targets in the form
3066 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3067 must be specified numerically, not as a DNS name.
3070 <column name="engine_id">
3071 Engine ID to use in NetFlow messages. Defaults to datapath index
3075 <column name="engine_type">
3076 Engine type to use in NetFlow messages. Defaults to datapath
3077 index if not specified.
3080 <column name="active_timeout">
3081 The interval at which NetFlow records are sent for flows that are
3082 still active, in seconds. A value of <code>0</code> requests the
3083 default timeout (currently 600 seconds); a value of <code>-1</code>
3084 disables active timeouts.
3087 <column name="add_id_to_interface">
3088 <p>If this column's value is <code>false</code>, the ingress and egress
3089 interface fields of NetFlow flow records are derived from OpenFlow port
3090 numbers. When it is <code>true</code>, the 7 most significant bits of
3091 these fields will be replaced by the least significant 7 bits of the
3092 engine id. This is useful because many NetFlow collectors do not
3093 expect multiple switches to be sending messages from the same host, so
3094 they do not store the engine information which could be used to
3095 disambiguate the traffic.</p>
3096 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3099 <group title="Common Columns">
3100 The overall purpose of these columns is described under <code>Common
3101 Columns</code> at the beginning of this document.
3103 <column name="external_ids"/>
3108 SSL configuration for an Open_vSwitch.
3110 <column name="private_key">
3111 Name of a PEM file containing the private key used as the switch's
3112 identity for SSL connections to the controller.
3115 <column name="certificate">
3116 Name of a PEM file containing a certificate, signed by the
3117 certificate authority (CA) used by the controller and manager,
3118 that certifies the switch's private key, identifying a trustworthy
3122 <column name="ca_cert">
3123 Name of a PEM file containing the CA certificate used to verify
3124 that the switch is connected to a trustworthy controller.
3127 <column name="bootstrap_ca_cert">
3128 If set to <code>true</code>, then Open vSwitch will attempt to
3129 obtain the CA certificate from the controller on its first SSL
3130 connection and save it to the named PEM file. If it is successful,
3131 it will immediately drop the connection and reconnect, and from then
3132 on all SSL connections must be authenticated by a certificate signed
3133 by the CA certificate thus obtained. <em>This option exposes the
3134 SSL connection to a man-in-the-middle attack obtaining the initial
3135 CA certificate.</em> It may still be useful for bootstrapping.
3138 <group title="Common Columns">
3139 The overall purpose of these columns is described under <code>Common
3140 Columns</code> at the beginning of this document.
3142 <column name="external_ids"/>
3146 <table name="sFlow">
3147 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3150 <column name="agent">
3151 Name of the network device whose IP address should be reported as the
3152 ``agent address'' to collectors. If not specified, the agent device is
3153 figured from the first target address and the routing table. If the
3154 routing table does not contain a route to the target, the IP address
3155 defaults to the <ref table="Controller" column="local_ip"/> in the
3156 collector's <ref table="Controller"/>. If an agent IP address cannot be
3157 determined any of these ways, sFlow is disabled.
3160 <column name="header">
3161 Number of bytes of a sampled packet to send to the collector.
3162 If not specified, the default is 128 bytes.
3165 <column name="polling">
3166 Polling rate in seconds to send port statistics to the collector.
3167 If not specified, defaults to 30 seconds.
3170 <column name="sampling">
3171 Rate at which packets should be sampled and sent to the collector.
3172 If not specified, defaults to 400, which means one out of 400
3173 packets, on average, will be sent to the collector.
3176 <column name="targets">
3177 sFlow targets in the form
3178 <code><var>ip</var>:<var>port</var></code>.
3181 <group title="Common Columns">
3182 The overall purpose of these columns is described under <code>Common
3183 Columns</code> at the beginning of this document.
3185 <column name="external_ids"/>