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
627 <column name="other_config" key="mac-table-size"
628 type='{"type": "integer", "minInteger": 1}'>
630 The maximum number of MAC addresses to learn. The default is
631 currently 2048. The value, if specified, is forced into a reasonable
632 range, currently 10 to 1,000,000.
637 <group title="Bridge Status">
639 Status information about bridges.
641 <column name="status">
642 Key-value pairs that report bridge status.
644 <column name="status" key="stp_bridge_id">
646 The bridge-id (in hex) used in spanning tree advertisements.
647 Configuring the bridge-id is described in the
648 <code>stp-system-id</code> and <code>stp-priority</code> keys
649 of the <code>other_config</code> section earlier.
652 <column name="status" key="stp_designated_root">
654 The designated root (in hex) for this spanning tree.
657 <column name="status" key="stp_root_path_cost">
659 The path cost of reaching the designated bridge. A lower
665 <group title="Common Columns">
666 The overall purpose of these columns is described under <code>Common
667 Columns</code> at the beginning of this document.
669 <column name="other_config"/>
670 <column name="external_ids"/>
674 <table name="Port" table="Port or bond configuration.">
675 <p>A port within a <ref table="Bridge"/>.</p>
676 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
677 <ref column="interfaces"/> column. Such a port logically
678 corresponds to a port on a physical Ethernet switch. A port
679 with more than one interface is a ``bonded port'' (see
680 <ref group="Bonding Configuration"/>).</p>
681 <p>Some properties that one might think as belonging to a port are actually
682 part of the port's <ref table="Interface"/> members.</p>
685 Port name. Should be alphanumeric and no more than about 8
686 bytes long. May be the same as the interface name, for
687 non-bonded ports. Must otherwise be unique among the names of
688 ports, interfaces, and bridges on a host.
691 <column name="interfaces">
692 The port's interfaces. If there is more than one, this is a
696 <group title="VLAN Configuration">
697 <p>Bridge ports support the following types of VLAN configuration:</p>
702 A trunk port carries packets on one or more specified VLANs
703 specified in the <ref column="trunks"/> column (often, on every
704 VLAN). A packet that ingresses on a trunk port is in the VLAN
705 specified in its 802.1Q header, or VLAN 0 if the packet has no
706 802.1Q header. A packet that egresses through a trunk port will
707 have an 802.1Q header if it has a nonzero VLAN ID.
711 Any packet that ingresses on a trunk port tagged with a VLAN that
712 the port does not trunk is dropped.
719 An access port carries packets on exactly one VLAN specified in the
720 <ref column="tag"/> column. Packets egressing on an access port
721 have no 802.1Q header.
725 Any packet with an 802.1Q header with a nonzero VLAN ID that
726 ingresses on an access port is dropped, regardless of whether the
727 VLAN ID in the header is the access port's VLAN ID.
731 <dt>native-tagged</dt>
733 A native-tagged port resembles a trunk port, with the exception that
734 a packet without an 802.1Q header that ingresses on a native-tagged
735 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
739 <dt>native-untagged</dt>
741 A native-untagged port resembles a native-tagged port, with the
742 exception that a packet that egresses on a native-untagged port in
743 the native VLAN will not have an 802.1Q header.
747 A packet will only egress through bridge ports that carry the VLAN of
748 the packet, as described by the rules above.
751 <column name="vlan_mode">
753 The VLAN mode of the port, as described above. When this column is
754 empty, a default mode is selected as follows:
758 If <ref column="tag"/> contains a value, the port is an access
759 port. The <ref column="trunks"/> column should be empty.
762 Otherwise, the port is a trunk port. The <ref column="trunks"/>
763 column value is honored if it is present.
770 For an access port, the port's implicitly tagged VLAN. For a
771 native-tagged or native-untagged port, the port's native VLAN. Must
772 be empty if this is a trunk port.
776 <column name="trunks">
778 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
779 or VLANs that this port trunks; if it is empty, then the port trunks
780 all VLANs. Must be empty if this is an access port.
783 A native-tagged or native-untagged port always trunks its native
784 VLAN, regardless of whether <ref column="trunks"/> includes that
789 <column name="other_config" key="priority-tags"
790 type='{"type": "boolean"}'>
792 An 802.1Q header contains two important pieces of information: a VLAN
793 ID and a priority. A frame with a zero VLAN ID, called a
794 ``priority-tagged'' frame, is supposed to be treated the same way as
795 a frame without an 802.1Q header at all (except for the priority).
799 However, some network elements ignore any frame that has 802.1Q
800 header at all, even when the VLAN ID is zero. Therefore, by default
801 Open vSwitch does not output priority-tagged frames, instead omitting
802 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
803 <code>true</code> to enable priority-tagged frames on a port.
807 Regardless of this setting, Open vSwitch omits the 802.1Q header on
808 output if both the VLAN ID and priority would be zero.
812 All frames output to native-tagged ports have a nonzero VLAN ID, so
813 this setting is not meaningful on native-tagged ports.
818 <group title="Bonding Configuration">
819 <p>A port that has more than one interface is a ``bonded port.'' Bonding
820 allows for load balancing and fail-over.</p>
823 The following types of bonding will work with any kind of upstream
824 switch. On the upstream switch, do not configure the interfaces as a
829 <dt><code>balance-slb</code></dt>
831 Balances flows among slaves based on source MAC address and output
832 VLAN, with periodic rebalancing as traffic patterns change.
835 <dt><code>active-backup</code></dt>
837 Assigns all flows to one slave, failing over to a backup slave when
838 the active slave is disabled. This is the only bonding mode in which
839 interfaces may be plugged into different upstream switches.
844 The following modes require the upstream switch to support 802.3ad with
845 successful LACP negotiation:
849 <dt><code>balance-tcp</code></dt>
851 Balances flows among slaves based on L2, L3, and L4 protocol
852 information such as destination MAC address, IP address, and TCP
856 <dt><code>stable</code></dt>
858 <p>Deprecated and slated for removal in February 2013.</p>
859 <p>Attempts to always assign a given flow to the same slave
860 consistently. In an effort to maintain stability, no load
861 balancing is done. Uses a similar hashing strategy to
862 <code>balance-tcp</code>, always taking into account L3 and L4
863 fields even if LACP negotiations are unsuccessful. </p>
864 <p>Slave selection decisions are made based on <ref table="Interface"
865 column="other_config" key="bond-stable-id"/> if set. Otherwise,
866 OpenFlow port number is used. Decisions are consistent across all
867 <code>ovs-vswitchd</code> instances with equivalent
868 <ref table="Interface" column="other_config" key="bond-stable-id"/>
873 <p>These columns apply only to bonded ports. Their values are
874 otherwise ignored.</p>
876 <column name="bond_mode">
877 <p>The type of bonding used for a bonded port. Defaults to
878 <code>active-backup</code> if unset.
882 <column name="other_config" key="bond-hash-basis"
883 type='{"type": "integer"}'>
884 An integer hashed along with flows when choosing output slaves in load
885 balanced bonds. When changed, all flows will be assigned different
886 hash values possibly causing slave selection decisions to change. Does
887 not affect bonding modes which do not employ load balancing such as
888 <code>active-backup</code>.
891 <group title="Link Failure Detection">
893 An important part of link bonding is detecting that links are down so
894 that they may be disabled. These settings determine how Open vSwitch
895 detects link failure.
898 <column name="other_config" key="bond-detect-mode"
899 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
900 The means used to detect link failures. Defaults to
901 <code>carrier</code> which uses each interface's carrier to detect
902 failures. When set to <code>miimon</code>, will check for failures
903 by polling each interface's MII.
906 <column name="other_config" key="bond-miimon-interval"
907 type='{"type": "integer"}'>
908 The interval, in milliseconds, between successive attempts to poll
909 each interface's MII. Relevant only when <ref column="other_config"
910 key="bond-detect-mode"/> is <code>miimon</code>.
913 <column name="bond_updelay">
915 The number of milliseconds for which the link must stay up on an
916 interface before the interface is considered to be up. Specify
917 <code>0</code> to enable the interface immediately.
921 This setting is honored only when at least one bonded interface is
922 already enabled. When no interfaces are enabled, then the first
923 bond interface to come up is enabled immediately.
927 <column name="bond_downdelay">
928 The number of milliseconds for which the link must stay down on an
929 interface before the interface is considered to be down. Specify
930 <code>0</code> to disable the interface immediately.
934 <group title="LACP Configuration">
936 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
937 allows switches to automatically detect that they are connected by
938 multiple links and aggregate across those links. These settings
939 control LACP behavior.
943 Configures LACP on this port. LACP allows directly connected
944 switches to negotiate which links may be bonded. LACP may be enabled
945 on non-bonded ports for the benefit of any switches they may be
946 connected to. <code>active</code> ports are allowed to initiate LACP
947 negotiations. <code>passive</code> ports are allowed to participate
948 in LACP negotiations initiated by a remote switch, but not allowed to
949 initiate such negotiations themselves. If LACP is enabled on a port
950 whose partner switch does not support LACP, the bond will be
951 disabled. Defaults to <code>off</code> if unset.
954 <column name="other_config" key="lacp-system-id">
955 The LACP system ID of this <ref table="Port"/>. The system ID of a
956 LACP bond is used to identify itself to its partners. Must be a
957 nonzero MAC address. Defaults to the bridge Ethernet address if
961 <column name="other_config" key="lacp-system-priority"
962 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
963 The LACP system priority of this <ref table="Port"/>. In LACP
964 negotiations, link status decisions are made by the system with the
965 numerically lower priority.
968 <column name="other_config" key="lacp-time"
969 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
971 The LACP timing which should be used on this <ref table="Port"/>.
972 By default <code>slow</code> is used. When configured to be
973 <code>fast</code> LACP heartbeats are requested at a rate of once
974 per second causing connectivity problems to be detected more
975 quickly. In <code>slow</code> mode, heartbeats are requested at a
976 rate of once every 30 seconds.
981 <group title="Rebalancing Configuration">
983 These settings control behavior when a bond is in
984 <code>balance-slb</code> or <code>balance-tcp</code> mode.
987 <column name="other_config" key="bond-rebalance-interval"
988 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
989 For a load balanced bonded port, the number of milliseconds between
990 successive attempts to rebalance the bond, that is, to move flows
991 from one interface on the bond to another in an attempt to keep usage
992 of each interface roughly equal. If zero, load balancing is disabled
993 on the bond (link failure still cause flows to move). If
994 less than 1000ms, the rebalance interval will be 1000ms.
998 <column name="bond_fake_iface">
999 For a bonded port, whether to create a fake internal interface with the
1000 name of the port. Use only for compatibility with legacy software that
1005 <group title="Spanning Tree Configuration">
1006 <column name="other_config" key="stp-enable"
1007 type='{"type": "boolean"}'>
1008 If spanning tree is enabled on the bridge, member ports are
1009 enabled by default (with the exception of bond, internal, and
1010 mirror ports which do not work with STP). If this column's
1011 value is <code>false</code> spanning tree is disabled on the
1015 <column name="other_config" key="stp-port-num"
1016 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1017 The port number used for the lower 8 bits of the port-id. By
1018 default, the numbers will be assigned automatically. If any
1019 port's number is manually configured on a bridge, then they
1023 <column name="other_config" key="stp-port-priority"
1024 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1025 The port's relative priority value for determining the root
1026 port (the upper 8 bits of the port-id). A port with a lower
1027 port-id will be chosen as the root port. By default, the
1031 <column name="other_config" key="stp-path-cost"
1032 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1033 Spanning tree path cost for the port. A lower number indicates
1034 a faster link. By default, the cost is based on the maximum
1039 <group title="Other Features">
1041 Quality of Service configuration for this port.
1045 The MAC address to use for this port for the purpose of choosing the
1046 bridge's MAC address. This column does not necessarily reflect the
1047 port's actual MAC address, nor will setting it change the port's actual
1051 <column name="fake_bridge">
1052 Does this port represent a sub-bridge for its tagged VLAN within the
1053 Bridge? See ovs-vsctl(8) for more information.
1056 <column name="external_ids" key="fake-bridge-id-*">
1057 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1058 column) are defined by prefixing a <ref table="Bridge"/> <ref
1059 table="Bridge" column="external_ids"/> key with
1060 <code>fake-bridge-</code>,
1061 e.g. <code>fake-bridge-xs-network-uuids</code>.
1065 <group title="Port Status">
1067 Status information about ports attached to bridges.
1069 <column name="status">
1070 Key-value pairs that report port status.
1072 <column name="status" key="stp_port_id">
1074 The port-id (in hex) used in spanning tree advertisements for
1075 this port. Configuring the port-id is described in the
1076 <code>stp-port-num</code> and <code>stp-port-priority</code>
1077 keys of the <code>other_config</code> section earlier.
1080 <column name="status" key="stp_state"
1081 type='{"type": "string", "enum": ["set",
1082 ["disabled", "listening", "learning",
1083 "forwarding", "blocking"]]}'>
1085 STP state of the port.
1088 <column name="status" key="stp_sec_in_state"
1089 type='{"type": "integer", "minInteger": 0}'>
1091 The amount of time (in seconds) port has been in the current
1095 <column name="status" key="stp_role"
1096 type='{"type": "string", "enum": ["set",
1097 ["root", "designated", "alternate"]]}'>
1099 STP role of the port.
1104 <group title="Port Statistics">
1106 Key-value pairs that report port statistics.
1108 <group title="Statistics: STP transmit and receive counters">
1109 <column name="statistics" key="stp_tx_count">
1110 Number of STP BPDUs sent on this port by the spanning
1113 <column name="statistics" key="stp_rx_count">
1114 Number of STP BPDUs received on this port and accepted by the
1115 spanning tree library.
1117 <column name="statistics" key="stp_error_count">
1118 Number of bad STP BPDUs received on this port. Bad BPDUs
1119 include runt packets and those with an unexpected protocol ID.
1124 <group title="Common Columns">
1125 The overall purpose of these columns is described under <code>Common
1126 Columns</code> at the beginning of this document.
1128 <column name="other_config"/>
1129 <column name="external_ids"/>
1133 <table name="Interface" title="One physical network device in a Port.">
1134 An interface within a <ref table="Port"/>.
1136 <group title="Core Features">
1137 <column name="name">
1138 Interface name. Should be alphanumeric and no more than about 8 bytes
1139 long. May be the same as the port name, for non-bonded ports. Must
1140 otherwise be unique among the names of ports, interfaces, and bridges
1145 <p>Ethernet address to set for this interface. If unset then the
1146 default MAC address is used:</p>
1148 <li>For the local interface, the default is the lowest-numbered MAC
1149 address among the other bridge ports, either the value of the
1150 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1151 if set, or its actual MAC (for bonded ports, the MAC of its slave
1152 whose name is first in alphabetical order). Internal ports and
1153 bridge ports that are used as port mirroring destinations (see the
1154 <ref table="Mirror"/> table) are ignored.</li>
1155 <li>For other internal interfaces, the default MAC is randomly
1157 <li>External interfaces typically have a MAC address associated with
1158 their hardware.</li>
1160 <p>Some interfaces may not have a software-controllable MAC
1164 <column name="ofport">
1165 <p>OpenFlow port number for this interface. Unlike most columns, this
1166 column's value should be set only by Open vSwitch itself. Other
1167 clients should set this column to an empty set (the default) when
1168 creating an <ref table="Interface"/>.</p>
1169 <p>Open vSwitch populates this column when the port number becomes
1170 known. If the interface is successfully added,
1171 <ref column="ofport"/> will be set to a number between 1 and 65535
1172 (generally either in the range 1 to 65279, inclusive, or 65534, the
1173 port number for the OpenFlow ``local port''). If the interface
1174 cannot be added then Open vSwitch sets this column
1176 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1177 an appropriate value for this column and then tries to keep the value
1178 constant across restarts.</p>
1181 <column name="ofport_request">
1182 <p>Requested OpenFlow port number for this interface. The port
1183 number must be between 1 and 65279, inclusive. Some datapaths
1184 cannot satisfy all requests for particular port numbers. When
1185 this column is empty or the request cannot be fulfilled, the
1186 system will choose a free port. The <ref column="ofport"/>
1187 column reports the assigned OpenFlow port number.</p>
1188 <p>The port number must be requested in the same transaction
1189 that creates the port.</p>
1193 <group title="System-Specific Details">
1194 <column name="type">
1196 The interface type, one of:
1200 <dt><code>system</code></dt>
1201 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1202 Sometimes referred to as ``external interfaces'' since they are
1203 generally connected to hardware external to that on which the Open
1204 vSwitch is running. The empty string is a synonym for
1205 <code>system</code>.</dd>
1207 <dt><code>internal</code></dt>
1208 <dd>A simulated network device that sends and receives traffic. An
1209 internal interface whose <ref column="name"/> is the same as its
1210 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1211 ``local interface.'' It does not make sense to bond an internal
1212 interface, so the terms ``port'' and ``interface'' are often used
1213 imprecisely for internal interfaces.</dd>
1215 <dt><code>tap</code></dt>
1216 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1218 <dt><code>gre</code></dt>
1220 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1224 <dt><code>ipsec_gre</code></dt>
1226 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1230 <dt><code>gre64</code></dt>
1232 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1233 of key, it uses GRE protocol sequence number field. This is non
1234 standard use of GRE protocol since OVS does not increment
1235 sequence number for every packet at time of encap as expected by
1236 standard GRE implementation. See <ref group="Tunnel Options"/>
1237 for information on configuring GRE tunnels.
1240 <dt><code>ipsec_gre64</code></dt>
1242 Same as IPSEC_GRE except 64 bit key.
1245 <dt><code>capwap</code></dt>
1247 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1248 5415). This allows interoperability with certain switches that do
1249 not support GRE. Only the tunneling component of the protocol is
1250 implemented. UDP ports 58881 and 58882 are used as the source and
1251 destination ports respectively. CAPWAP is currently supported only
1252 with the Linux kernel datapath with kernel version 2.6.26 or later.
1254 CAPWAP support is deprecated and will be removed no earlier than
1258 <dt><code>vxlan</code></dt>
1261 An Ethernet tunnel over the experimental, UDP-based VXLAN
1262 protocol described at
1263 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-02</code>.
1264 VXLAN is currently supported only with the Linux kernel datapath
1265 with kernel version 2.6.26 or later.
1268 As an experimental protocol, VXLAN has no officially assigned UDP
1269 port. Open vSwitch currently uses UDP destination port 8472.
1270 The source port used for VXLAN traffic varies on a per-flow basis
1271 and is in the ephemeral port range.
1275 <dt><code>patch</code></dt>
1277 A pair of virtual devices that act as a patch cable.
1280 <dt><code>null</code></dt>
1281 <dd>An ignored interface. Deprecated and slated for removal in
1287 <group title="Tunnel Options">
1289 These options apply to interfaces with <ref column="type"/> of
1290 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1291 <code>ipsec_gre64</code>, <code>capwap</code>, and
1296 Each tunnel must be uniquely identified by the combination of <ref
1297 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1298 column="options" key="local_ip"/>, and <ref column="options"
1299 key="in_key"/>. If two ports are defined that are the same except one
1300 has an optional identifier and the other does not, the more specific
1301 one is matched first. <ref column="options" key="in_key"/> is
1302 considered more specific than <ref column="options" key="local_ip"/> if
1303 a port defines one and another port defines the other.
1306 <column name="options" key="remote_ip">
1308 Required. The tunnel endpoint. Unicast and multicast endpoints are
1313 When a multicast endpoint is specified, a routing table lookup occurs
1314 only when the tunnel is created. Following a routing change, delete
1315 and then re-create the tunnel to force a new routing table lookup.
1319 <column name="options" key="local_ip">
1320 Optional. The destination IP that received packets must match.
1321 Default is to match all addresses. Must be omitted when <ref
1322 column="options" key="remote_ip"/> is a multicast address.
1325 <column name="options" key="in_key">
1326 <p>Optional. The key that received packets must contain, one of:</p>
1330 <code>0</code>. The tunnel receives packets with no key or with a
1331 key of 0. This is equivalent to specifying no <ref column="options"
1332 key="in_key"/> at all.
1335 A positive 24-bit (for VXLAN), 32-bit (for GRE) or 64-bit (for
1336 CAPWAP) number. The tunnel receives only packets with the
1340 The word <code>flow</code>. The tunnel accepts packets with any
1341 key. The key will be placed in the <code>tun_id</code> field for
1342 matching in the flow table. The <code>ovs-ofctl</code> manual page
1343 contains additional information about matching fields in OpenFlow
1352 <column name="options" key="out_key">
1353 <p>Optional. The key to be set on outgoing packets, one of:</p>
1357 <code>0</code>. Packets sent through the tunnel will have no key.
1358 This is equivalent to specifying no <ref column="options"
1359 key="out_key"/> at all.
1362 A positive 24-bit (for VXLAN), 32-bit (for GRE) or 64-bit (for
1363 CAPWAP) number. Packets sent through the tunnel will have the
1367 The word <code>flow</code>. Packets sent through the tunnel will
1368 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1369 vendor extension (0 is used in the absence of an action). The
1370 <code>ovs-ofctl</code> manual page contains additional information
1371 about the Nicira OpenFlow vendor extensions.
1376 <column name="options" key="key">
1377 Optional. Shorthand to set <code>in_key</code> and
1378 <code>out_key</code> at the same time.
1381 <column name="options" key="tos">
1382 Optional. The value of the ToS bits to be set on the encapsulating
1383 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1384 zero. It may also be the word <code>inherit</code>, in which case
1385 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1386 (otherwise it will be 0). The ECN fields are always inherited.
1390 <column name="options" key="ttl">
1391 Optional. The TTL to be set on the encapsulating packet. It may also
1392 be the word <code>inherit</code>, in which case the TTL will be copied
1393 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1394 system default, typically 64). Default is the system default TTL.
1397 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1398 Optional. If enabled, the Don't Fragment bit will be copied from the
1399 inner IP headers (those of the encapsulated traffic) to the outer
1400 (tunnel) headers. Default is disabled; set to <code>true</code> to
1404 <column name="options" key="df_default"
1405 type='{"type": "boolean"}'>
1406 Optional. If enabled, the Don't Fragment bit will be set by default on
1407 tunnel headers if the <code>df_inherit</code> option is not set, or if
1408 the encapsulated packet is not IP. Default is enabled; set to
1409 <code>false</code> to disable.
1412 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1413 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1414 Destination Unreachable - Fragmentation Needed'' messages will be
1415 generated for IPv4 packets with the DF bit set and IPv6 packets above
1416 the minimum MTU if the packet size exceeds the path MTU minus the size
1417 of the tunnel headers. Note that this option causes behavior that is
1418 typically reserved for routers and therefore is not entirely in
1419 compliance with the IEEE 802.1D specification for bridges. Default is
1420 disabled; set to <code>true</code> to enable. This feature is
1421 deprecated and will be removed soon.
1424 <group title="Tunnel Options: gre and ipsec_gre only">
1426 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1430 <column name="options" key="csum" type='{"type": "boolean"}'>
1432 Optional. Compute GRE checksums on outgoing packets. Default is
1433 disabled, set to <code>true</code> to enable. Checksums present on
1434 incoming packets will be validated regardless of this setting.
1438 GRE checksums impose a significant performance penalty because they
1439 cover the entire packet. The encapsulated L3, L4, and L7 packet
1440 contents typically have their own checksums, so this additional
1441 checksum only adds value for the GRE and encapsulated L2 headers.
1445 This option is supported for <code>ipsec_gre</code>, but not useful
1446 because GRE checksums are weaker than, and redundant with, IPsec
1447 payload authentication.
1452 <group title="Tunnel Options: ipsec_gre only">
1454 Only <code>ipsec_gre</code> interfaces support these options.
1457 <column name="options" key="peer_cert">
1458 Required for certificate authentication. A string containing the
1459 peer's certificate in PEM format. Additionally the host's
1460 certificate must be specified with the <code>certificate</code>
1464 <column name="options" key="certificate">
1465 Required for certificate authentication. The name of a PEM file
1466 containing a certificate that will be presented to the peer during
1470 <column name="options" key="private_key">
1471 Optional for certificate authentication. The name of a PEM file
1472 containing the private key associated with <code>certificate</code>.
1473 If <code>certificate</code> contains the private key, this option may
1477 <column name="options" key="psk">
1478 Required for pre-shared key authentication. Specifies a pre-shared
1479 key for authentication that must be identical on both sides of the
1485 <group title="Patch Options">
1487 Only <code>patch</code> interfaces support these options.
1490 <column name="options" key="peer">
1491 The <ref column="name"/> of the <ref table="Interface"/> for the other
1492 side of the patch. The named <ref table="Interface"/>'s own
1493 <code>peer</code> option must specify this <ref table="Interface"/>'s
1494 name. That is, the two patch interfaces must have reversed <ref
1495 column="name"/> and <code>peer</code> values.
1499 <group title="Interface Status">
1501 Status information about interfaces attached to bridges, updated every
1502 5 seconds. Not all interfaces have all of these properties; virtual
1503 interfaces don't have a link speed, for example. Non-applicable
1504 columns will have empty values.
1506 <column name="admin_state">
1508 The administrative state of the physical network link.
1512 <column name="link_state">
1514 The observed state of the physical network link. This is ordinarily
1515 the link's carrier status. If the interface's <ref table="Port"/> is
1516 a bond configured for miimon monitoring, it is instead the network
1517 link's miimon status.
1521 <column name="link_resets">
1523 The number of times Open vSwitch has observed the
1524 <ref column="link_state"/> of this <ref table="Interface"/> change.
1528 <column name="link_speed">
1530 The negotiated speed of the physical network link.
1531 Valid values are positive integers greater than 0.
1535 <column name="duplex">
1537 The duplex mode of the physical network link.
1543 The MTU (maximum transmission unit); i.e. the largest
1544 amount of data that can fit into a single Ethernet frame.
1545 The standard Ethernet MTU is 1500 bytes. Some physical media
1546 and many kinds of virtual interfaces can be configured with
1550 This column will be empty for an interface that does not
1551 have an MTU as, for example, some kinds of tunnels do not.
1555 <column name="lacp_current">
1556 Boolean value indicating LACP status for this interface. If true, this
1557 interface has current LACP information about its LACP partner. This
1558 information may be used to monitor the health of interfaces in a LACP
1559 enabled port. This column will be empty if LACP is not enabled.
1562 <column name="status">
1563 Key-value pairs that report port status. Supported status values are
1564 <ref column="type"/>-dependent; some interfaces may not have a valid
1565 <ref column="status" key="driver_name"/>, for example.
1568 <column name="status" key="driver_name">
1569 The name of the device driver controlling the network adapter.
1572 <column name="status" key="driver_version">
1573 The version string of the device driver controlling the network
1577 <column name="status" key="firmware_version">
1578 The version string of the network adapter's firmware, if available.
1581 <column name="status" key="source_ip">
1582 The source IP address used for an IPv4 tunnel end-point, such as
1583 <code>gre</code> or <code>capwap</code>.
1586 <column name="status" key="tunnel_egress_iface">
1587 Egress interface for tunnels. Currently only relevant for GRE and
1588 CAPWAP tunnels. On Linux systems, this column will show the name of
1589 the interface which is responsible for routing traffic destined for the
1590 configured <ref column="options" key="remote_ip"/>. This could be an
1591 internal interface such as a bridge port.
1594 <column name="status" key="tunnel_egress_iface_carrier"
1595 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1596 Whether carrier is detected on <ref column="status"
1597 key="tunnel_egress_iface"/>.
1601 <group title="Statistics">
1603 Key-value pairs that report interface statistics. The current
1604 implementation updates these counters periodically. Future
1605 implementations may update them when an interface is created, when they
1606 are queried (e.g. using an OVSDB <code>select</code> operation), and
1607 just before an interface is deleted due to virtual interface hot-unplug
1608 or VM shutdown, and perhaps at other times, but not on any regular
1612 These are the same statistics reported by OpenFlow in its <code>struct
1613 ofp_port_stats</code> structure. If an interface does not support a
1614 given statistic, then that pair is omitted.
1616 <group title="Statistics: Successful transmit and receive counters">
1617 <column name="statistics" key="rx_packets">
1618 Number of received packets.
1620 <column name="statistics" key="rx_bytes">
1621 Number of received bytes.
1623 <column name="statistics" key="tx_packets">
1624 Number of transmitted packets.
1626 <column name="statistics" key="tx_bytes">
1627 Number of transmitted bytes.
1630 <group title="Statistics: Receive errors">
1631 <column name="statistics" key="rx_dropped">
1632 Number of packets dropped by RX.
1634 <column name="statistics" key="rx_frame_err">
1635 Number of frame alignment errors.
1637 <column name="statistics" key="rx_over_err">
1638 Number of packets with RX overrun.
1640 <column name="statistics" key="rx_crc_err">
1641 Number of CRC errors.
1643 <column name="statistics" key="rx_errors">
1644 Total number of receive errors, greater than or equal to the sum of
1648 <group title="Statistics: Transmit errors">
1649 <column name="statistics" key="tx_dropped">
1650 Number of packets dropped by TX.
1652 <column name="statistics" key="collisions">
1653 Number of collisions.
1655 <column name="statistics" key="tx_errors">
1656 Total number of transmit errors, greater than or equal to the sum of
1662 <group title="Ingress Policing">
1664 These settings control ingress policing for packets received on this
1665 interface. On a physical interface, this limits the rate at which
1666 traffic is allowed into the system from the outside; on a virtual
1667 interface (one connected to a virtual machine), this limits the rate at
1668 which the VM is able to transmit.
1671 Policing is a simple form of quality-of-service that simply drops
1672 packets received in excess of the configured rate. Due to its
1673 simplicity, policing is usually less accurate and less effective than
1674 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1675 table="Queue"/> tables).
1678 Policing is currently implemented only on Linux. The Linux
1679 implementation uses a simple ``token bucket'' approach:
1683 The size of the bucket corresponds to <ref
1684 column="ingress_policing_burst"/>. Initially the bucket is full.
1687 Whenever a packet is received, its size (converted to tokens) is
1688 compared to the number of tokens currently in the bucket. If the
1689 required number of tokens are available, they are removed and the
1690 packet is forwarded. Otherwise, the packet is dropped.
1693 Whenever it is not full, the bucket is refilled with tokens at the
1694 rate specified by <ref column="ingress_policing_rate"/>.
1698 Policing interacts badly with some network protocols, and especially
1699 with fragmented IP packets. Suppose that there is enough network
1700 activity to keep the bucket nearly empty all the time. Then this token
1701 bucket algorithm will forward a single packet every so often, with the
1702 period depending on packet size and on the configured rate. All of the
1703 fragments of an IP packets are normally transmitted back-to-back, as a
1704 group. In such a situation, therefore, only one of these fragments
1705 will be forwarded and the rest will be dropped. IP does not provide
1706 any way for the intended recipient to ask for only the remaining
1707 fragments. In such a case there are two likely possibilities for what
1708 will happen next: either all of the fragments will eventually be
1709 retransmitted (as TCP will do), in which case the same problem will
1710 recur, or the sender will not realize that its packet has been dropped
1711 and data will simply be lost (as some UDP-based protocols will do).
1712 Either way, it is possible that no forward progress will ever occur.
1714 <column name="ingress_policing_rate">
1716 Maximum rate for data received on this interface, in kbps. Data
1717 received faster than this rate is dropped. Set to <code>0</code>
1718 (the default) to disable policing.
1722 <column name="ingress_policing_burst">
1723 <p>Maximum burst size for data received on this interface, in kb. The
1724 default burst size if set to <code>0</code> is 1000 kb. This value
1725 has no effect if <ref column="ingress_policing_rate"/>
1726 is <code>0</code>.</p>
1728 Specifying a larger burst size lets the algorithm be more forgiving,
1729 which is important for protocols like TCP that react severely to
1730 dropped packets. The burst size should be at least the size of the
1731 interface's MTU. Specifying a value that is numerically at least as
1732 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1733 closer to achieving the full rate.
1738 <group title="Connectivity Fault Management">
1740 802.1ag Connectivity Fault Management (CFM) allows a group of
1741 Maintenance Points (MPs) called a Maintenance Association (MA) to
1742 detect connectivity problems with each other. MPs within a MA should
1743 have complete and exclusive interconnectivity. This is verified by
1744 occasionally broadcasting Continuity Check Messages (CCMs) at a
1745 configurable transmission interval.
1749 According to the 802.1ag specification, each Maintenance Point should
1750 be configured out-of-band with a list of Remote Maintenance Points it
1751 should have connectivity to. Open vSwitch differs from the
1752 specification in this area. It simply assumes the link is faulted if
1753 no Remote Maintenance Points are reachable, and considers it not
1758 When operating over tunnels which have no <code>in_key</code>, or an
1759 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1760 with a tunnel key of zero.
1763 <column name="cfm_mpid">
1764 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1765 a Maintenance Association. The MPID is used to identify this endpoint
1766 to other Maintenance Points in the MA. Each end of a link being
1767 monitored should have a different MPID. Must be configured to enable
1768 CFM on this <ref table="Interface"/>.
1771 <column name="cfm_fault">
1773 Indicates a connectivity fault triggered by an inability to receive
1774 heartbeats from any remote endpoint. When a fault is triggered on
1775 <ref table="Interface"/>s participating in bonds, they will be
1779 Faults can be triggered for several reasons. Most importantly they
1780 are triggered when no CCMs are received for a period of 3.5 times the
1781 transmission interval. Faults are also triggered when any CCMs
1782 indicate that a Remote Maintenance Point is not receiving CCMs but
1783 able to send them. Finally, a fault is triggered if a CCM is
1784 received which indicates unexpected configuration. Notably, this
1785 case arises when a CCM is received which advertises the local MPID.
1789 <column name="cfm_fault_status" key="recv">
1790 Indicates a CFM fault was triggered due to a lack of CCMs received on
1791 the <ref table="Interface"/>.
1794 <column name="cfm_fault_status" key="rdi">
1795 Indicates a CFM fault was triggered due to the reception of a CCM with
1796 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1797 are not receiving CCMs themselves. This typically indicates a
1798 unidirectional connectivity failure.
1801 <column name="cfm_fault_status" key="maid">
1802 Indicates a CFM fault was triggered due to the reception of a CCM with
1803 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1804 with an identification number in addition to the MPID called the MAID.
1805 Open vSwitch only supports receiving CCM broadcasts tagged with the
1806 MAID it uses internally.
1809 <column name="cfm_fault_status" key="loopback">
1810 Indicates a CFM fault was triggered due to the reception of a CCM
1811 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1812 column of this <ref table="Interface"/>. This may indicate a loop in
1816 <column name="cfm_fault_status" key="overflow">
1817 Indicates a CFM fault was triggered because the CFM module received
1818 CCMs from more remote endpoints than it can keep track of.
1821 <column name="cfm_fault_status" key="override">
1822 Indicates a CFM fault was manually triggered by an administrator using
1823 an <code>ovs-appctl</code> command.
1826 <column name="cfm_fault_status" key="interval">
1827 Indicates a CFM fault was triggered due to the reception of a CCM
1828 frame having an invalid interval.
1831 <column name="cfm_remote_opstate">
1832 <p>When in extended mode, indicates the operational state of the
1833 remote endpoint as either <code>up</code> or <code>down</code>. See
1834 <ref column="other_config" key="cfm_opstate"/>.
1838 <column name="cfm_health">
1840 Indicates the health of the interface as a percentage of CCM frames
1841 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1842 The health of an interface is undefined if it is communicating with
1843 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1844 healthy heartbeats are not received at the expected rate, and
1845 gradually improves as healthy heartbeats are received at the desired
1846 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1847 health of the interface is refreshed.
1850 As mentioned above, the faults can be triggered for several reasons.
1851 The link health will deteriorate even if heartbeats are received but
1852 they are reported to be unhealthy. An unhealthy heartbeat in this
1853 context is a heartbeat for which either some fault is set or is out
1854 of sequence. The interface health can be 100 only on receiving
1855 healthy heartbeats at the desired rate.
1859 <column name="cfm_remote_mpids">
1860 When CFM is properly configured, Open vSwitch will occasionally
1861 receive CCM broadcasts. These broadcasts contain the MPID of the
1862 sending Maintenance Point. The list of MPIDs from which this
1863 <ref table="Interface"/> is receiving broadcasts from is regularly
1864 collected and written to this column.
1867 <column name="other_config" key="cfm_interval"
1868 type='{"type": "integer"}'>
1870 The interval, in milliseconds, between transmissions of CFM
1871 heartbeats. Three missed heartbeat receptions indicate a
1876 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1877 60,000, or 600,000 ms are supported. Other values will be rounded
1878 down to the nearest value on the list. Extended mode (see <ref
1879 column="other_config" key="cfm_extended"/>) supports any interval up
1880 to 65,535 ms. In either mode, the default is 1000 ms.
1883 <p>We do not recommend using intervals less than 100 ms.</p>
1886 <column name="other_config" key="cfm_extended"
1887 type='{"type": "boolean"}'>
1888 When <code>true</code>, the CFM module operates in extended mode. This
1889 causes it to use a nonstandard destination address to avoid conflicting
1890 with compliant implementations which may be running concurrently on the
1891 network. Furthermore, extended mode increases the accuracy of the
1892 <code>cfm_interval</code> configuration parameter by breaking wire
1893 compatibility with 802.1ag compliant implementations. Defaults to
1896 <column name="other_config" key="cfm_opstate"
1897 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1898 When <code>down</code>, the CFM module marks all CCMs it generates as
1899 operationally down without triggering a fault. This allows remote
1900 maintenance points to choose not to forward traffic to the
1901 <ref table="Interface"/> on which this CFM module is running.
1902 Currently, in Open vSwitch, the opdown bit of CCMs affects
1903 <ref table="Interface"/>s participating in bonds, and the bundle
1904 OpenFlow action. This setting is ignored when CFM is not in extended
1905 mode. Defaults to <code>up</code>.
1908 <column name="other_config" key="cfm_ccm_vlan"
1909 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1910 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1911 with the given value. May be the string <code>random</code> in which
1912 case each CCM will be tagged with a different randomly generated VLAN.
1915 <column name="other_config" key="cfm_ccm_pcp"
1916 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1917 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1918 with the given PCP value, the VLAN ID of the tag is governed by the
1919 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1920 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1926 <group title="Bonding Configuration">
1927 <column name="other_config" key="bond-stable-id"
1928 type='{"type": "integer", "minInteger": 1}'>
1929 Used in <code>stable</code> bond mode to make slave
1930 selection decisions. Allocating <ref column="other_config"
1931 key="bond-stable-id"/> values consistently across interfaces
1932 participating in a bond will guarantee consistent slave selection
1933 decisions across <code>ovs-vswitchd</code> instances when using
1934 <code>stable</code> bonding mode.
1937 <column name="other_config" key="lacp-port-id"
1938 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1939 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1940 used in LACP negotiations to identify individual ports
1941 participating in a bond.
1944 <column name="other_config" key="lacp-port-priority"
1945 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1946 The LACP port priority of this <ref table="Interface"/>. In LACP
1947 negotiations <ref table="Interface"/>s with numerically lower
1948 priorities are preferred for aggregation.
1951 <column name="other_config" key="lacp-aggregation-key"
1952 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1953 The LACP aggregation key of this <ref table="Interface"/>. <ref
1954 table="Interface"/>s with different aggregation keys may not be active
1955 within a given <ref table="Port"/> at the same time.
1959 <group title="Virtual Machine Identifiers">
1961 These key-value pairs specifically apply to an interface that
1962 represents a virtual Ethernet interface connected to a virtual
1963 machine. These key-value pairs should not be present for other types
1964 of interfaces. Keys whose names end in <code>-uuid</code> have
1965 values that uniquely identify the entity in question. For a Citrix
1966 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1967 Other hypervisors may use other formats.
1970 <column name="external_ids" key="attached-mac">
1971 The MAC address programmed into the ``virtual hardware'' for this
1972 interface, in the form
1973 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1974 For Citrix XenServer, this is the value of the <code>MAC</code> field
1975 in the VIF record for this interface.
1978 <column name="external_ids" key="iface-id">
1979 A system-unique identifier for the interface. On XenServer, this will
1980 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1983 <column name="external_ids" key="iface-status"
1984 type='{"type": "string",
1985 "enum": ["set", ["active", "inactive"]]}'>
1987 Hypervisors may sometimes have more than one interface associated
1988 with a given <ref column="external_ids" key="iface-id"/>, only one of
1989 which is actually in use at a given time. For example, in some
1990 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1991 for a single <ref column="external_ids" key="iface-id"/>, but only
1992 uses one of them at a time. A hypervisor that behaves this way must
1993 mark the currently in use interface <code>active</code> and the
1994 others <code>inactive</code>. A hypervisor that never has more than
1995 one interface for a given <ref column="external_ids" key="iface-id"/>
1996 may mark that interface <code>active</code> or omit <ref
1997 column="external_ids" key="iface-status"/> entirely.
2001 During VM migration, a given <ref column="external_ids"
2002 key="iface-id"/> might transiently be marked <code>active</code> on
2003 two different hypervisors. That is, <code>active</code> means that
2004 this <ref column="external_ids" key="iface-id"/> is the active
2005 instance within a single hypervisor, not in a broader scope.
2009 <column name="external_ids" key="xs-vif-uuid">
2010 The virtual interface associated with this interface.
2013 <column name="external_ids" key="xs-network-uuid">
2014 The virtual network to which this interface is attached.
2017 <column name="external_ids" key="vm-id">
2018 The VM to which this interface belongs. On XenServer, this will be the
2019 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2022 <column name="external_ids" key="xs-vm-uuid">
2023 The VM to which this interface belongs.
2027 <group title="VLAN Splinters">
2029 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2030 with buggy network drivers in old versions of Linux that do not
2031 properly support VLANs when VLAN devices are not used, at some cost
2032 in memory and performance.
2036 When VLAN splinters are enabled on a particular interface, Open vSwitch
2037 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2038 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2039 received on the VLAN device is treated as if it had been received on
2040 the interface on the particular VLAN.
2044 VLAN splinters consider a VLAN to be in use if:
2049 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2050 table="Port"/> record.
2054 The VLAN is listed within the <ref table="Port" column="trunks"/>
2055 column of the <ref table="Port"/> record of an interface on which
2056 VLAN splinters are enabled.
2058 An empty <ref table="Port" column="trunks"/> does not influence the
2059 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2060 will exceed the current 1,024 port per datapath limit.
2064 An OpenFlow flow within any bridge matches the VLAN.
2069 The same set of in-use VLANs applies to every interface on which VLAN
2070 splinters are enabled. That is, the set is not chosen separately for
2071 each interface but selected once as the union of all in-use VLANs based
2076 It does not make sense to enable VLAN splinters on an interface for an
2077 access port, or on an interface that is not a physical port.
2081 VLAN splinters are deprecated. When broken device drivers are no
2082 longer in widespread use, we will delete this feature.
2085 <column name="other_config" key="enable-vlan-splinters"
2086 type='{"type": "boolean"}'>
2088 Set to <code>true</code> to enable VLAN splinters on this interface.
2089 Defaults to <code>false</code>.
2093 VLAN splinters increase kernel and userspace memory overhead, so do
2094 not use them unless they are needed.
2098 VLAN splinters do not support 802.1p priority tags. Received
2099 priorities will appear to be 0, regardless of their actual values,
2100 and priorities on transmitted packets will also be cleared to 0.
2105 <group title="Common Columns">
2106 The overall purpose of these columns is described under <code>Common
2107 Columns</code> at the beginning of this document.
2109 <column name="other_config"/>
2110 <column name="external_ids"/>
2114 <table name="Flow_Table" title="OpenFlow table configuration">
2115 <p>Configuration for a particular OpenFlow table.</p>
2117 <column name="name">
2118 The table's name. Set this column to change the name that controllers
2119 will receive when they request table statistics, e.g. <code>ovs-ofctl
2120 dump-tables</code>. The name does not affect switch behavior.
2123 <column name="flow_limit">
2124 If set, limits the number of flows that may be added to the table. Open
2125 vSwitch may limit the number of flows in a table for other reasons,
2126 e.g. due to hardware limitations or for resource availability or
2127 performance reasons.
2130 <column name="overflow_policy">
2132 Controls the switch's behavior when an OpenFlow flow table modification
2133 request would add flows in excess of <ref column="flow_limit"/>. The
2134 supported values are:
2138 <dt><code>refuse</code></dt>
2140 Refuse to add the flow or flows. This is also the default policy
2141 when <ref column="overflow_policy"/> is unset.
2144 <dt><code>evict</code></dt>
2146 Delete the flow that will expire soonest. See <ref column="groups"/>
2152 <column name="groups">
2154 When <ref column="overflow_policy"/> is <code>evict</code>, this
2155 controls how flows are chosen for eviction when the flow table would
2156 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2157 of NXM fields or sub-fields, each of which takes one of the forms
2158 <code><var>field</var>[]</code> or
2159 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2160 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2161 <code>nicira-ext.h</code> for a complete list of NXM field names.
2165 When a flow must be evicted due to overflow, the flow to evict is
2166 chosen through an approximation of the following algorithm:
2171 Divide the flows in the table into groups based on the values of the
2172 specified fields or subfields, so that all of the flows in a given
2173 group have the same values for those fields. If a flow does not
2174 specify a given field, that field's value is treated as 0.
2178 Consider the flows in the largest group, that is, the group that
2179 contains the greatest number of flows. If two or more groups all
2180 have the same largest number of flows, consider the flows in all of
2185 Among the flows under consideration, choose the flow that expires
2186 soonest for eviction.
2191 The eviction process only considers flows that have an idle timeout or
2192 a hard timeout. That is, eviction never deletes permanent flows.
2193 (Permanent flows do count against <ref column="flow_limit"/>.)
2197 Open vSwitch ignores any invalid or unknown field specifications.
2201 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2202 column has no effect.
2207 <table name="QoS" title="Quality of Service configuration">
2208 <p>Quality of Service (QoS) configuration for each Port that
2211 <column name="type">
2212 <p>The type of QoS to implement. The currently defined types are
2215 <dt><code>linux-htb</code></dt>
2217 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2218 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2219 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2220 for information on how this classifier works and how to configure it.
2224 <dt><code>linux-hfsc</code></dt>
2226 Linux "Hierarchical Fair Service Curve" classifier.
2227 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2228 information on how this classifier works.
2233 <column name="queues">
2234 <p>A map from queue numbers to <ref table="Queue"/> records. The
2235 supported range of queue numbers depend on <ref column="type"/>. The
2236 queue numbers are the same as the <code>queue_id</code> used in
2237 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2241 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2242 actions when no specific queue has been set. When no configuration for
2243 queue 0 is present, it is automatically configured as if a <ref
2244 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2245 and <ref table="Queue" column="other_config"/> columns had been
2247 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2248 this case. With some queuing disciplines, this dropped all packets
2249 destined for the default queue.)
2253 <group title="Configuration for linux-htb and linux-hfsc">
2255 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2256 the following key-value pair:
2259 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2260 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2261 specified, for physical interfaces, the default is the link rate. For
2262 other interfaces or if the link rate cannot be determined, the default
2263 is currently 100 Mbps.
2267 <group title="Common Columns">
2268 The overall purpose of these columns is described under <code>Common
2269 Columns</code> at the beginning of this document.
2271 <column name="other_config"/>
2272 <column name="external_ids"/>
2276 <table name="Queue" title="QoS output queue.">
2277 <p>A configuration for a port output queue, used in configuring Quality of
2278 Service (QoS) features. May be referenced by <ref column="queues"
2279 table="QoS"/> column in <ref table="QoS"/> table.</p>
2281 <column name="dscp">
2282 If set, Open vSwitch will mark all traffic egressing this
2283 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2284 default <ref table="Queue"/> is only marked if it was explicitly selected
2285 as the <ref table="Queue"/> at the time the packet was output. If unset,
2286 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2290 <group title="Configuration for linux-htb QoS">
2292 <ref table="QoS"/> <ref table="QoS" column="type"/>
2293 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2294 It has the following key-value pairs defined.
2297 <column name="other_config" key="min-rate"
2298 type='{"type": "integer", "minInteger": 1}'>
2299 Minimum guaranteed bandwidth, in bit/s.
2302 <column name="other_config" key="max-rate"
2303 type='{"type": "integer", "minInteger": 1}'>
2304 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2305 queue's rate will not be allowed to exceed the specified value, even
2306 if excess bandwidth is available. If unspecified, defaults to no
2310 <column name="other_config" key="burst"
2311 type='{"type": "integer", "minInteger": 1}'>
2312 Burst size, in bits. This is the maximum amount of ``credits'' that a
2313 queue can accumulate while it is idle. Optional. Details of the
2314 <code>linux-htb</code> implementation require a minimum burst size, so
2315 a too-small <code>burst</code> will be silently ignored.
2318 <column name="other_config" key="priority"
2319 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2320 A queue with a smaller <code>priority</code> will receive all the
2321 excess bandwidth that it can use before a queue with a larger value
2322 receives any. Specific priority values are unimportant; only relative
2323 ordering matters. Defaults to 0 if unspecified.
2327 <group title="Configuration for linux-hfsc QoS">
2329 <ref table="QoS"/> <ref table="QoS" column="type"/>
2330 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2331 It has the following key-value pairs defined.
2334 <column name="other_config" key="min-rate"
2335 type='{"type": "integer", "minInteger": 1}'>
2336 Minimum guaranteed bandwidth, in bit/s.
2339 <column name="other_config" key="max-rate"
2340 type='{"type": "integer", "minInteger": 1}'>
2341 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2342 queue's rate will not be allowed to exceed the specified value, even if
2343 excess bandwidth is available. If unspecified, defaults to no
2348 <group title="Common Columns">
2349 The overall purpose of these columns is described under <code>Common
2350 Columns</code> at the beginning of this document.
2352 <column name="other_config"/>
2353 <column name="external_ids"/>
2357 <table name="Mirror" title="Port mirroring.">
2358 <p>A port mirror within a <ref table="Bridge"/>.</p>
2359 <p>A port mirror configures a bridge to send selected frames to special
2360 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2361 traffic may also be referred to as SPAN or RSPAN, depending on how
2362 the mirrored traffic is sent.</p>
2364 <column name="name">
2365 Arbitrary identifier for the <ref table="Mirror"/>.
2368 <group title="Selecting Packets for Mirroring">
2370 To be selected for mirroring, a given packet must enter or leave the
2371 bridge through a selected port and it must also be in one of the
2375 <column name="select_all">
2376 If true, every packet arriving or departing on any port is
2377 selected for mirroring.
2380 <column name="select_dst_port">
2381 Ports on which departing packets are selected for mirroring.
2384 <column name="select_src_port">
2385 Ports on which arriving packets are selected for mirroring.
2388 <column name="select_vlan">
2389 VLANs on which packets are selected for mirroring. An empty set
2390 selects packets on all VLANs.
2394 <group title="Mirroring Destination Configuration">
2396 These columns are mutually exclusive. Exactly one of them must be
2400 <column name="output_port">
2401 <p>Output port for selected packets, if nonempty.</p>
2402 <p>Specifying a port for mirror output reserves that port exclusively
2403 for mirroring. No frames other than those selected for mirroring
2405 will be forwarded to the port, and any frames received on the port
2406 will be discarded.</p>
2408 The output port may be any kind of port supported by Open vSwitch.
2409 It may be, for example, a physical port (sometimes called SPAN) or a
2414 <column name="output_vlan">
2415 <p>Output VLAN for selected packets, if nonempty.</p>
2416 <p>The frames will be sent out all ports that trunk
2417 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2418 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2419 trunk port, the frame's VLAN tag will be set to
2420 <ref column="output_vlan"/>, replacing any existing tag; when it is
2421 sent out an implicit VLAN port, the frame will not be tagged. This
2422 type of mirroring is sometimes called RSPAN.</p>
2424 See the documentation for
2425 <ref column="other_config" key="forward-bpdu"/> in the
2426 <ref table="Interface"/> table for a list of destination MAC
2427 addresses which will not be mirrored to a VLAN to avoid confusing
2428 switches that interpret the protocols that they represent.
2430 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2431 contains unmanaged switches. Consider an unmanaged physical switch
2432 with two ports: port 1, connected to an end host, and port 2,
2433 connected to an Open vSwitch configured to mirror received packets
2434 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2435 port 1 that the physical switch forwards to port 2. The Open vSwitch
2436 forwards this packet to its destination and then reflects it back on
2437 port 2 in VLAN 123. This reflected packet causes the unmanaged
2438 physical switch to replace the MAC learning table entry, which
2439 correctly pointed to port 1, with one that incorrectly points to port
2440 2. Afterward, the physical switch will direct packets destined for
2441 the end host to the Open vSwitch on port 2, instead of to the end
2442 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2443 desired in this scenario, then the physical switch must be replaced
2444 by one that learns Ethernet addresses on a per-VLAN basis. In
2445 addition, learning should be disabled on the VLAN containing mirrored
2446 traffic. If this is not done then intermediate switches will learn
2447 the MAC address of each end host from the mirrored traffic. If
2448 packets being sent to that end host are also mirrored, then they will
2449 be dropped since the switch will attempt to send them out the input
2450 port. Disabling learning for the VLAN will cause the switch to
2451 correctly send the packet out all ports configured for that VLAN. If
2452 Open vSwitch is being used as an intermediate switch, learning can be
2453 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2454 in the appropriate <ref table="Bridge"/> table or tables.</p>
2456 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2457 VLAN and should generally be preferred.
2462 <group title="Statistics: Mirror counters">
2464 Key-value pairs that report mirror statistics.
2466 <column name="statistics" key="tx_packets">
2467 Number of packets transmitted through this mirror.
2469 <column name="statistics" key="tx_bytes">
2470 Number of bytes transmitted through this mirror.
2474 <group title="Common Columns">
2475 The overall purpose of these columns is described under <code>Common
2476 Columns</code> at the beginning of this document.
2478 <column name="external_ids"/>
2482 <table name="Controller" title="OpenFlow controller configuration.">
2483 <p>An OpenFlow controller.</p>
2486 Open vSwitch supports two kinds of OpenFlow controllers:
2490 <dt>Primary controllers</dt>
2493 This is the kind of controller envisioned by the OpenFlow 1.0
2494 specification. Usually, a primary controller implements a network
2495 policy by taking charge of the switch's flow table.
2499 Open vSwitch initiates and maintains persistent connections to
2500 primary controllers, retrying the connection each time it fails or
2501 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2502 <ref table="Bridge"/> table applies to primary controllers.
2506 Open vSwitch permits a bridge to have any number of primary
2507 controllers. When multiple controllers are configured, Open
2508 vSwitch connects to all of them simultaneously. Because
2509 OpenFlow 1.0 does not specify how multiple controllers
2510 coordinate in interacting with a single switch, more than
2511 one primary controller should be specified only if the
2512 controllers are themselves designed to coordinate with each
2513 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2514 vendor extension may be useful for this.)
2517 <dt>Service controllers</dt>
2520 These kinds of OpenFlow controller connections are intended for
2521 occasional support and maintenance use, e.g. with
2522 <code>ovs-ofctl</code>. Usually a service controller connects only
2523 briefly to inspect or modify some of a switch's state.
2527 Open vSwitch listens for incoming connections from service
2528 controllers. The service controllers initiate and, if necessary,
2529 maintain the connections from their end. The <ref table="Bridge"
2530 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2531 not apply to service controllers.
2535 Open vSwitch supports configuring any number of service controllers.
2541 The <ref column="target"/> determines the type of controller.
2544 <group title="Core Features">
2545 <column name="target">
2546 <p>Connection method for controller.</p>
2548 The following connection methods are currently supported for primary
2552 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2554 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2555 the given <var>ip</var>, which must be expressed as an IP address
2556 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2557 column in the <ref table="Open_vSwitch"/> table must point to a
2558 valid SSL configuration when this form is used.</p>
2559 <p>SSL support is an optional feature that is not always built as
2560 part of Open vSwitch.</p>
2562 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2563 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2564 the given <var>ip</var>, which must be expressed as an IP address
2565 (not a DNS name).</dd>
2568 The following connection methods are currently supported for service
2572 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2575 Listens for SSL connections on the specified TCP <var>port</var>
2576 (default: 6633). If <var>ip</var>, which must be expressed as an
2577 IP address (not a DNS name), is specified, then connections are
2578 restricted to the specified local IP address.
2581 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2582 table="Open_vSwitch"/> table must point to a valid SSL
2583 configuration when this form is used.
2585 <p>SSL support is an optional feature that is not always built as
2586 part of Open vSwitch.</p>
2588 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2590 Listens for connections on the specified TCP <var>port</var>
2591 (default: 6633). If <var>ip</var>, which must be expressed as an
2592 IP address (not a DNS name), is specified, then connections are
2593 restricted to the specified local IP address.
2596 <p>When multiple controllers are configured for a single bridge, the
2597 <ref column="target"/> values must be unique. Duplicate
2598 <ref column="target"/> values yield unspecified results.</p>
2601 <column name="connection_mode">
2602 <p>If it is specified, this setting must be one of the following
2603 strings that describes how Open vSwitch contacts this OpenFlow
2604 controller over the network:</p>
2607 <dt><code>in-band</code></dt>
2608 <dd>In this mode, this controller's OpenFlow traffic travels over the
2609 bridge associated with the controller. With this setting, Open
2610 vSwitch allows traffic to and from the controller regardless of the
2611 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2612 would never be able to connect to the controller, because it did
2613 not have a flow to enable it.) This is the most common connection
2614 mode because it is not necessary to maintain two independent
2616 <dt><code>out-of-band</code></dt>
2617 <dd>In this mode, OpenFlow traffic uses a control network separate
2618 from the bridge associated with this controller, that is, the
2619 bridge does not use any of its own network devices to communicate
2620 with the controller. The control network must be configured
2621 separately, before or after <code>ovs-vswitchd</code> is started.
2625 <p>If not specified, the default is implementation-specific.</p>
2629 <group title="Controller Failure Detection and Handling">
2630 <column name="max_backoff">
2631 Maximum number of milliseconds to wait between connection attempts.
2632 Default is implementation-specific.
2635 <column name="inactivity_probe">
2636 Maximum number of milliseconds of idle time on connection to
2637 controller before sending an inactivity probe message. If Open
2638 vSwitch does not communicate with the controller for the specified
2639 number of seconds, it will send a probe. If a response is not
2640 received for the same additional amount of time, Open vSwitch
2641 assumes the connection has been broken and attempts to reconnect.
2642 Default is implementation-specific. A value of 0 disables
2647 <group title="Asynchronous Message Configuration">
2649 OpenFlow switches send certain messages to controllers spontanenously,
2650 that is, not in response to any request from the controller. These
2651 messages are called ``asynchronous messages.'' These columns allow
2652 asynchronous messages to be limited or disabled to ensure the best use
2653 of network resources.
2656 <column name="enable_async_messages">
2657 The OpenFlow protocol enables asynchronous messages at time of
2658 connection establishment, which means that a controller can receive
2659 asynchronous messages, potentially many of them, even if it turns them
2660 off immediately after connecting. Set this column to
2661 <code>false</code> to change Open vSwitch behavior to disable, by
2662 default, all asynchronous messages. The controller can use the
2663 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2664 on any messages that it does want to receive, if any.
2667 <column name="controller_rate_limit">
2669 The maximum rate at which the switch will forward packets to the
2670 OpenFlow controller, in packets per second. This feature prevents a
2671 single bridge from overwhelming the controller. If not specified,
2672 the default is implementation-specific.
2676 In addition, when a high rate triggers rate-limiting, Open vSwitch
2677 queues controller packets for each port and transmits them to the
2678 controller at the configured rate. The <ref
2679 column="controller_burst_limit"/> value limits the number of queued
2680 packets. Ports on a bridge share the packet queue fairly.
2684 Open vSwitch maintains two such packet rate-limiters per bridge: one
2685 for packets sent up to the controller because they do not correspond
2686 to any flow, and the other for packets sent up to the controller by
2687 request through flow actions. When both rate-limiters are filled with
2688 packets, the actual rate that packets are sent to the controller is
2689 up to twice the specified rate.
2693 <column name="controller_burst_limit">
2694 In conjunction with <ref column="controller_rate_limit"/>,
2695 the maximum number of unused packet credits that the bridge will
2696 allow to accumulate, in packets. If not specified, the default
2697 is implementation-specific.
2701 <group title="Additional In-Band Configuration">
2702 <p>These values are considered only in in-band control mode (see
2703 <ref column="connection_mode"/>).</p>
2705 <p>When multiple controllers are configured on a single bridge, there
2706 should be only one set of unique values in these columns. If different
2707 values are set for these columns in different controllers, the effect
2710 <column name="local_ip">
2711 The IP address to configure on the local port,
2712 e.g. <code>192.168.0.123</code>. If this value is unset, then
2713 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2717 <column name="local_netmask">
2718 The IP netmask to configure on the local port,
2719 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2720 but this value is unset, then the default is chosen based on whether
2721 the IP address is class A, B, or C.
2724 <column name="local_gateway">
2725 The IP address of the gateway to configure on the local port, as a
2726 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2727 this network has no gateway.
2731 <group title="Controller Status">
2732 <column name="is_connected">
2733 <code>true</code> if currently connected to this controller,
2734 <code>false</code> otherwise.
2738 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2739 <p>The level of authority this controller has on the associated
2740 bridge. Possible values are:</p>
2742 <dt><code>other</code></dt>
2743 <dd>Allows the controller access to all OpenFlow features.</dd>
2744 <dt><code>master</code></dt>
2745 <dd>Equivalent to <code>other</code>, except that there may be at
2746 most one master controller at a time. When a controller configures
2747 itself as <code>master</code>, any existing master is demoted to
2748 the <code>slave</code>role.</dd>
2749 <dt><code>slave</code></dt>
2750 <dd>Allows the controller read-only access to OpenFlow features.
2751 Attempts to modify the flow table will be rejected with an
2752 error. Slave controllers do not receive OFPT_PACKET_IN or
2753 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2758 <column name="status" key="last_error">
2759 A human-readable description of the last error on the connection
2760 to the controller; i.e. <code>strerror(errno)</code>. This key
2761 will exist only if an error has occurred.
2764 <column name="status" key="state"
2765 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2767 The state of the connection to the controller:
2770 <dt><code>VOID</code></dt>
2771 <dd>Connection is disabled.</dd>
2773 <dt><code>BACKOFF</code></dt>
2774 <dd>Attempting to reconnect at an increasing period.</dd>
2776 <dt><code>CONNECTING</code></dt>
2777 <dd>Attempting to connect.</dd>
2779 <dt><code>ACTIVE</code></dt>
2780 <dd>Connected, remote host responsive.</dd>
2782 <dt><code>IDLE</code></dt>
2783 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2786 These values may change in the future. They are provided only for
2791 <column name="status" key="sec_since_connect"
2792 type='{"type": "integer", "minInteger": 0}'>
2793 The amount of time since this controller last successfully connected to
2794 the switch (in seconds). Value is empty if controller has never
2795 successfully connected.
2798 <column name="status" key="sec_since_disconnect"
2799 type='{"type": "integer", "minInteger": 1}'>
2800 The amount of time since this controller last disconnected from
2801 the switch (in seconds). Value is empty if controller has never
2806 <group title="Connection Parameters">
2808 Additional configuration for a connection between the controller
2809 and the Open vSwitch.
2812 <column name="other_config" key="dscp"
2813 type='{"type": "integer"}'>
2814 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2815 in the Type of Service (TOS) field in the IP header. DSCP provides a
2816 mechanism to classify the network traffic and provide Quality of
2817 Service (QoS) on IP networks.
2819 The DSCP value specified here is used when establishing the connection
2820 between the controller and the Open vSwitch. If no value is specified,
2821 a default value of 48 is chosen. Valid DSCP values must be in the
2827 <group title="Common Columns">
2828 The overall purpose of these columns is described under <code>Common
2829 Columns</code> at the beginning of this document.
2831 <column name="external_ids"/>
2832 <column name="other_config"/>
2836 <table name="Manager" title="OVSDB management connection.">
2838 Configuration for a database connection to an Open vSwitch database
2843 This table primarily configures the Open vSwitch database
2844 (<code>ovsdb-server</code>), not the Open vSwitch switch
2845 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2846 what connections should be treated as in-band.
2850 The Open vSwitch database server can initiate and maintain active
2851 connections to remote clients. It can also listen for database
2855 <group title="Core Features">
2856 <column name="target">
2857 <p>Connection method for managers.</p>
2859 The following connection methods are currently supported:
2862 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2865 The specified SSL <var>port</var> (default: 6632) on the host at
2866 the given <var>ip</var>, which must be expressed as an IP address
2867 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2868 column in the <ref table="Open_vSwitch"/> table must point to a
2869 valid SSL configuration when this form is used.
2872 SSL support is an optional feature that is not always built as
2873 part of Open vSwitch.
2877 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2879 The specified TCP <var>port</var> (default: 6632) on the host at
2880 the given <var>ip</var>, which must be expressed as an IP address
2883 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2886 Listens for SSL connections on the specified TCP <var>port</var>
2887 (default: 6632). If <var>ip</var>, which must be expressed as an
2888 IP address (not a DNS name), is specified, then connections are
2889 restricted to the specified local IP address.
2892 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2893 table="Open_vSwitch"/> table must point to a valid SSL
2894 configuration when this form is used.
2897 SSL support is an optional feature that is not always built as
2898 part of Open vSwitch.
2901 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2903 Listens for connections on the specified TCP <var>port</var>
2904 (default: 6632). If <var>ip</var>, which must be expressed as an
2905 IP address (not a DNS name), is specified, then connections are
2906 restricted to the specified local IP address.
2909 <p>When multiple managers are configured, the <ref column="target"/>
2910 values must be unique. Duplicate <ref column="target"/> values yield
2911 unspecified results.</p>
2914 <column name="connection_mode">
2916 If it is specified, this setting must be one of the following strings
2917 that describes how Open vSwitch contacts this OVSDB client over the
2922 <dt><code>in-band</code></dt>
2924 In this mode, this connection's traffic travels over a bridge
2925 managed by Open vSwitch. With this setting, Open vSwitch allows
2926 traffic to and from the client regardless of the contents of the
2927 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2928 to connect to the client, because it did not have a flow to enable
2929 it.) This is the most common connection mode because it is not
2930 necessary to maintain two independent networks.
2932 <dt><code>out-of-band</code></dt>
2934 In this mode, the client's traffic uses a control network separate
2935 from that managed by Open vSwitch, that is, Open vSwitch does not
2936 use any of its own network devices to communicate with the client.
2937 The control network must be configured separately, before or after
2938 <code>ovs-vswitchd</code> is started.
2943 If not specified, the default is implementation-specific.
2948 <group title="Client Failure Detection and Handling">
2949 <column name="max_backoff">
2950 Maximum number of milliseconds to wait between connection attempts.
2951 Default is implementation-specific.
2954 <column name="inactivity_probe">
2955 Maximum number of milliseconds of idle time on connection to the client
2956 before sending an inactivity probe message. If Open vSwitch does not
2957 communicate with the client for the specified number of seconds, it
2958 will send a probe. If a response is not received for the same
2959 additional amount of time, Open vSwitch assumes the connection has been
2960 broken and attempts to reconnect. Default is implementation-specific.
2961 A value of 0 disables inactivity probes.
2965 <group title="Status">
2966 <column name="is_connected">
2967 <code>true</code> if currently connected to this manager,
2968 <code>false</code> otherwise.
2971 <column name="status" key="last_error">
2972 A human-readable description of the last error on the connection
2973 to the manager; i.e. <code>strerror(errno)</code>. This key
2974 will exist only if an error has occurred.
2977 <column name="status" key="state"
2978 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2980 The state of the connection to the manager:
2983 <dt><code>VOID</code></dt>
2984 <dd>Connection is disabled.</dd>
2986 <dt><code>BACKOFF</code></dt>
2987 <dd>Attempting to reconnect at an increasing period.</dd>
2989 <dt><code>CONNECTING</code></dt>
2990 <dd>Attempting to connect.</dd>
2992 <dt><code>ACTIVE</code></dt>
2993 <dd>Connected, remote host responsive.</dd>
2995 <dt><code>IDLE</code></dt>
2996 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2999 These values may change in the future. They are provided only for
3004 <column name="status" key="sec_since_connect"
3005 type='{"type": "integer", "minInteger": 0}'>
3006 The amount of time since this manager last successfully connected
3007 to the database (in seconds). Value is empty if manager has never
3008 successfully connected.
3011 <column name="status" key="sec_since_disconnect"
3012 type='{"type": "integer", "minInteger": 0}'>
3013 The amount of time since this manager last disconnected from the
3014 database (in seconds). Value is empty if manager has never
3018 <column name="status" key="locks_held">
3019 Space-separated list of the names of OVSDB locks that the connection
3020 holds. Omitted if the connection does not hold any locks.
3023 <column name="status" key="locks_waiting">
3024 Space-separated list of the names of OVSDB locks that the connection is
3025 currently waiting to acquire. Omitted if the connection is not waiting
3029 <column name="status" key="locks_lost">
3030 Space-separated list of the names of OVSDB locks that the connection
3031 has had stolen by another OVSDB client. Omitted if no locks have been
3032 stolen from this connection.
3035 <column name="status" key="n_connections"
3036 type='{"type": "integer", "minInteger": 2}'>
3038 When <ref column="target"/> specifies a connection method that
3039 listens for inbound connections (e.g. <code>ptcp:</code> or
3040 <code>pssl:</code>) and more than one connection is actually active,
3041 the value is the number of active connections. Otherwise, this
3042 key-value pair is omitted.
3045 When multiple connections are active, status columns and key-value
3046 pairs (other than this one) report the status of one arbitrarily
3052 <group title="Connection Parameters">
3054 Additional configuration for a connection between the manager
3055 and the Open vSwitch Database.
3058 <column name="other_config" key="dscp"
3059 type='{"type": "integer"}'>
3060 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3061 in the Type of Service (TOS) field in the IP header. DSCP provides a
3062 mechanism to classify the network traffic and provide Quality of
3063 Service (QoS) on IP networks.
3065 The DSCP value specified here is used when establishing the connection
3066 between the manager and the Open vSwitch. If no value is specified, a
3067 default value of 48 is chosen. Valid DSCP values must be in the range
3072 <group title="Common Columns">
3073 The overall purpose of these columns is described under <code>Common
3074 Columns</code> at the beginning of this document.
3076 <column name="external_ids"/>
3077 <column name="other_config"/>
3081 <table name="NetFlow">
3082 A NetFlow target. NetFlow is a protocol that exports a number of
3083 details about terminating IP flows, such as the principals involved
3086 <column name="targets">
3087 NetFlow targets in the form
3088 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3089 must be specified numerically, not as a DNS name.
3092 <column name="engine_id">
3093 Engine ID to use in NetFlow messages. Defaults to datapath index
3097 <column name="engine_type">
3098 Engine type to use in NetFlow messages. Defaults to datapath
3099 index if not specified.
3102 <column name="active_timeout">
3103 The interval at which NetFlow records are sent for flows that are
3104 still active, in seconds. A value of <code>0</code> requests the
3105 default timeout (currently 600 seconds); a value of <code>-1</code>
3106 disables active timeouts.
3109 <column name="add_id_to_interface">
3110 <p>If this column's value is <code>false</code>, the ingress and egress
3111 interface fields of NetFlow flow records are derived from OpenFlow port
3112 numbers. When it is <code>true</code>, the 7 most significant bits of
3113 these fields will be replaced by the least significant 7 bits of the
3114 engine id. This is useful because many NetFlow collectors do not
3115 expect multiple switches to be sending messages from the same host, so
3116 they do not store the engine information which could be used to
3117 disambiguate the traffic.</p>
3118 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3121 <group title="Common Columns">
3122 The overall purpose of these columns is described under <code>Common
3123 Columns</code> at the beginning of this document.
3125 <column name="external_ids"/>
3130 SSL configuration for an Open_vSwitch.
3132 <column name="private_key">
3133 Name of a PEM file containing the private key used as the switch's
3134 identity for SSL connections to the controller.
3137 <column name="certificate">
3138 Name of a PEM file containing a certificate, signed by the
3139 certificate authority (CA) used by the controller and manager,
3140 that certifies the switch's private key, identifying a trustworthy
3144 <column name="ca_cert">
3145 Name of a PEM file containing the CA certificate used to verify
3146 that the switch is connected to a trustworthy controller.
3149 <column name="bootstrap_ca_cert">
3150 If set to <code>true</code>, then Open vSwitch will attempt to
3151 obtain the CA certificate from the controller on its first SSL
3152 connection and save it to the named PEM file. If it is successful,
3153 it will immediately drop the connection and reconnect, and from then
3154 on all SSL connections must be authenticated by a certificate signed
3155 by the CA certificate thus obtained. <em>This option exposes the
3156 SSL connection to a man-in-the-middle attack obtaining the initial
3157 CA certificate.</em> It may still be useful for bootstrapping.
3160 <group title="Common Columns">
3161 The overall purpose of these columns is described under <code>Common
3162 Columns</code> at the beginning of this document.
3164 <column name="external_ids"/>
3168 <table name="sFlow">
3169 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3172 <column name="agent">
3173 Name of the network device whose IP address should be reported as the
3174 ``agent address'' to collectors. If not specified, the agent device is
3175 figured from the first target address and the routing table. If the
3176 routing table does not contain a route to the target, the IP address
3177 defaults to the <ref table="Controller" column="local_ip"/> in the
3178 collector's <ref table="Controller"/>. If an agent IP address cannot be
3179 determined any of these ways, sFlow is disabled.
3182 <column name="header">
3183 Number of bytes of a sampled packet to send to the collector.
3184 If not specified, the default is 128 bytes.
3187 <column name="polling">
3188 Polling rate in seconds to send port statistics to the collector.
3189 If not specified, defaults to 30 seconds.
3192 <column name="sampling">
3193 Rate at which packets should be sampled and sent to the collector.
3194 If not specified, defaults to 400, which means one out of 400
3195 packets, on average, will be sent to the collector.
3198 <column name="targets">
3199 sFlow targets in the form
3200 <code><var>ip</var>:<var>port</var></code>.
3203 <group title="Common Columns">
3204 The overall purpose of these columns is described under <code>Common
3205 Columns</code> at the beginning of this document.
3207 <column name="external_ids"/>