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="dp-desc">
443 Human readable description of datapath. It it a maximum 256
444 byte-long free-form string to describe the datapath for
445 debugging purposes, e.g. <code>switch3 in room 3120</code>.
448 <column name="other_config" key="disable-in-band"
449 type='{"type": "boolean"}'>
450 If set to <code>true</code>, disable in-band control on the bridge
451 regardless of controller and manager settings.
454 <column name="other_config" key="in-band-queue"
455 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
456 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
457 that will be used by flows set up by in-band control on this bridge.
458 If unset, or if the port used by an in-band control flow does not have
459 QoS configured, or if the port does not have a queue with the specified
460 ID, the default queue is used instead.
463 <column name="protocols">
464 List of OpenFlow protocols that may be used when negotiating a
465 connection with a controller. A default value of
466 <code>OpenFlow10</code> will be used if this column is empty.
470 <group title="Spanning Tree Configuration">
471 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
472 that ensures loop-free topologies. It allows redundant links to
473 be included in the network to provide automatic backup paths if
474 the active links fails.
476 <column name="stp_enable">
477 Enable spanning tree on the bridge. By default, STP is disabled
478 on bridges. Bond, internal, and mirror ports are not supported
479 and will not participate in the spanning tree.
482 <column name="other_config" key="stp-system-id">
483 The bridge's STP identifier (the lower 48 bits of the bridge-id)
485 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
486 By default, the identifier is the MAC address of the bridge.
489 <column name="other_config" key="stp-priority"
490 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
491 The bridge's relative priority value for determining the root
492 bridge (the upper 16 bits of the bridge-id). A bridge with the
493 lowest bridge-id is elected the root. By default, the priority
497 <column name="other_config" key="stp-hello-time"
498 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
499 The interval between transmissions of hello messages by
500 designated ports, in seconds. By default the hello interval is
504 <column name="other_config" key="stp-max-age"
505 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
506 The maximum age of the information transmitted by the bridge
507 when it is the root bridge, in seconds. By default, the maximum
511 <column name="other_config" key="stp-forward-delay"
512 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
513 The delay to wait between transitioning root and designated
514 ports to <code>forwarding</code>, in seconds. By default, the
515 forwarding delay is 15 seconds.
519 <group title="Other Features">
520 <column name="datapath_type">
521 Name of datapath provider. The kernel datapath has
522 type <code>system</code>. The userspace datapath has
523 type <code>netdev</code>.
526 <column name="external_ids" key="bridge-id">
527 A unique identifier of the bridge. On Citrix XenServer this will
528 commonly be the same as
529 <ref column="external_ids" key="xs-network-uuids"/>.
532 <column name="external_ids" key="xs-network-uuids">
533 Semicolon-delimited set of universally unique identifier(s) for the
534 network with which this bridge is associated on a Citrix XenServer
535 host. The network identifiers are RFC 4122 UUIDs as displayed by,
536 e.g., <code>xe network-list</code>.
539 <column name="other_config" key="hwaddr">
540 An Ethernet address in the form
541 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
542 to set the hardware address of the local port and influence the
546 <column name="other_config" key="flow-eviction-threshold"
547 type='{"type": "integer", "minInteger": 0}'>
549 A number of flows as a nonnegative integer. This sets number of
550 flows at which eviction from the kernel flow table will be triggered.
551 If there are a large number of flows then increasing this value to
552 around the number of flows present can result in reduced CPU usage
556 The default is 1000. Values below 100 will be rounded up to 100.
560 <column name="other_config" key="forward-bpdu"
561 type='{"type": "boolean"}'>
562 Option to allow forwarding of BPDU frames when NORMAL action is
563 invoked. Frames with reserved Ethernet addresses (e.g. STP
564 BPDU) will be forwarded when this option is enabled and the
565 switch is not providing that functionality. If STP is enabled
566 on the port, STP BPDUs will never be forwarded. If the Open
567 vSwitch bridge is used to connect different Ethernet networks,
568 and if Open vSwitch node does not run STP, then this option
569 should be enabled. Default is disabled, set to
570 <code>true</code> to enable.
572 The following destination MAC addresss will not be forwarded when this
575 <dt><code>01:80:c2:00:00:00</code></dt>
576 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
578 <dt><code>01:80:c2:00:00:01</code></dt>
579 <dd>IEEE Pause frame.</dd>
581 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
582 <dd>Other reserved protocols.</dd>
584 <dt><code>00:e0:2b:00:00:00</code></dt>
585 <dd>Extreme Discovery Protocol (EDP).</dd>
588 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
590 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
592 <dt><code>01:00:0c:cc:cc:cc</code></dt>
594 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
595 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
599 <dt><code>01:00:0c:cc:cc:cd</code></dt>
600 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
602 <dt><code>01:00:0c:cd:cd:cd</code></dt>
603 <dd>Cisco STP Uplink Fast.</dd>
605 <dt><code>01:00:0c:00:00:00</code></dt>
606 <dd>Cisco Inter Switch Link.</dd>
608 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
613 <column name="other_config" key="mac-aging-time"
614 type='{"type": "integer", "minInteger": 1}'>
616 The maximum number of seconds to retain a MAC learning entry for
617 which no packets have been seen. The default is currently 300
618 seconds (5 minutes). The value, if specified, is forced into a
619 reasonable range, currently 15 to 3600 seconds.
623 A short MAC aging time allows a network to more quickly detect that a
624 host is no longer connected to a switch port. However, it also makes
625 it more likely that packets will be flooded unnecessarily, when they
626 are addressed to a connected host that rarely transmits packets. To
627 reduce the incidence of unnecessary flooding, use a MAC aging time
628 longer than the maximum interval at which a host will ordinarily
633 <column name="other_config" key="mac-table-size"
634 type='{"type": "integer", "minInteger": 1}'>
636 The maximum number of MAC addresses to learn. The default is
637 currently 2048. The value, if specified, is forced into a reasonable
638 range, currently 10 to 1,000,000.
643 <group title="Bridge Status">
645 Status information about bridges.
647 <column name="status">
648 Key-value pairs that report bridge status.
650 <column name="status" key="stp_bridge_id">
652 The bridge-id (in hex) used in spanning tree advertisements.
653 Configuring the bridge-id is described in the
654 <code>stp-system-id</code> and <code>stp-priority</code> keys
655 of the <code>other_config</code> section earlier.
658 <column name="status" key="stp_designated_root">
660 The designated root (in hex) for this spanning tree.
663 <column name="status" key="stp_root_path_cost">
665 The path cost of reaching the designated bridge. A lower
671 <group title="Common Columns">
672 The overall purpose of these columns is described under <code>Common
673 Columns</code> at the beginning of this document.
675 <column name="other_config"/>
676 <column name="external_ids"/>
680 <table name="Port" table="Port or bond configuration.">
681 <p>A port within a <ref table="Bridge"/>.</p>
682 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
683 <ref column="interfaces"/> column. Such a port logically
684 corresponds to a port on a physical Ethernet switch. A port
685 with more than one interface is a ``bonded port'' (see
686 <ref group="Bonding Configuration"/>).</p>
687 <p>Some properties that one might think as belonging to a port are actually
688 part of the port's <ref table="Interface"/> members.</p>
691 Port name. Should be alphanumeric and no more than about 8
692 bytes long. May be the same as the interface name, for
693 non-bonded ports. Must otherwise be unique among the names of
694 ports, interfaces, and bridges on a host.
697 <column name="interfaces">
698 The port's interfaces. If there is more than one, this is a
702 <group title="VLAN Configuration">
703 <p>Bridge ports support the following types of VLAN configuration:</p>
708 A trunk port carries packets on one or more specified VLANs
709 specified in the <ref column="trunks"/> column (often, on every
710 VLAN). A packet that ingresses on a trunk port is in the VLAN
711 specified in its 802.1Q header, or VLAN 0 if the packet has no
712 802.1Q header. A packet that egresses through a trunk port will
713 have an 802.1Q header if it has a nonzero VLAN ID.
717 Any packet that ingresses on a trunk port tagged with a VLAN that
718 the port does not trunk is dropped.
725 An access port carries packets on exactly one VLAN specified in the
726 <ref column="tag"/> column. Packets egressing on an access port
727 have no 802.1Q header.
731 Any packet with an 802.1Q header with a nonzero VLAN ID that
732 ingresses on an access port is dropped, regardless of whether the
733 VLAN ID in the header is the access port's VLAN ID.
737 <dt>native-tagged</dt>
739 A native-tagged port resembles a trunk port, with the exception that
740 a packet without an 802.1Q header that ingresses on a native-tagged
741 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
745 <dt>native-untagged</dt>
747 A native-untagged port resembles a native-tagged port, with the
748 exception that a packet that egresses on a native-untagged port in
749 the native VLAN will not have an 802.1Q header.
753 A packet will only egress through bridge ports that carry the VLAN of
754 the packet, as described by the rules above.
757 <column name="vlan_mode">
759 The VLAN mode of the port, as described above. When this column is
760 empty, a default mode is selected as follows:
764 If <ref column="tag"/> contains a value, the port is an access
765 port. The <ref column="trunks"/> column should be empty.
768 Otherwise, the port is a trunk port. The <ref column="trunks"/>
769 column value is honored if it is present.
776 For an access port, the port's implicitly tagged VLAN. For a
777 native-tagged or native-untagged port, the port's native VLAN. Must
778 be empty if this is a trunk port.
782 <column name="trunks">
784 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
785 or VLANs that this port trunks; if it is empty, then the port trunks
786 all VLANs. Must be empty if this is an access port.
789 A native-tagged or native-untagged port always trunks its native
790 VLAN, regardless of whether <ref column="trunks"/> includes that
795 <column name="other_config" key="priority-tags"
796 type='{"type": "boolean"}'>
798 An 802.1Q header contains two important pieces of information: a VLAN
799 ID and a priority. A frame with a zero VLAN ID, called a
800 ``priority-tagged'' frame, is supposed to be treated the same way as
801 a frame without an 802.1Q header at all (except for the priority).
805 However, some network elements ignore any frame that has 802.1Q
806 header at all, even when the VLAN ID is zero. Therefore, by default
807 Open vSwitch does not output priority-tagged frames, instead omitting
808 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
809 <code>true</code> to enable priority-tagged frames on a port.
813 Regardless of this setting, Open vSwitch omits the 802.1Q header on
814 output if both the VLAN ID and priority would be zero.
818 All frames output to native-tagged ports have a nonzero VLAN ID, so
819 this setting is not meaningful on native-tagged ports.
824 <group title="Bonding Configuration">
825 <p>A port that has more than one interface is a ``bonded port.'' Bonding
826 allows for load balancing and fail-over.</p>
829 The following types of bonding will work with any kind of upstream
830 switch. On the upstream switch, do not configure the interfaces as a
835 <dt><code>balance-slb</code></dt>
837 Balances flows among slaves based on source MAC address and output
838 VLAN, with periodic rebalancing as traffic patterns change.
841 <dt><code>active-backup</code></dt>
843 Assigns all flows to one slave, failing over to a backup slave when
844 the active slave is disabled. This is the only bonding mode in which
845 interfaces may be plugged into different upstream switches.
850 The following modes require the upstream switch to support 802.3ad with
851 successful LACP negotiation:
855 <dt><code>balance-tcp</code></dt>
857 Balances flows among slaves based on L2, L3, and L4 protocol
858 information such as destination MAC address, IP address, and TCP
862 <dt><code>stable</code></dt>
864 <p>Deprecated and slated for removal in February 2013.</p>
865 <p>Attempts to always assign a given flow to the same slave
866 consistently. In an effort to maintain stability, no load
867 balancing is done. Uses a similar hashing strategy to
868 <code>balance-tcp</code>, always taking into account L3 and L4
869 fields even if LACP negotiations are unsuccessful. </p>
870 <p>Slave selection decisions are made based on <ref table="Interface"
871 column="other_config" key="bond-stable-id"/> if set. Otherwise,
872 OpenFlow port number is used. Decisions are consistent across all
873 <code>ovs-vswitchd</code> instances with equivalent
874 <ref table="Interface" column="other_config" key="bond-stable-id"/>
879 <p>These columns apply only to bonded ports. Their values are
880 otherwise ignored.</p>
882 <column name="bond_mode">
883 <p>The type of bonding used for a bonded port. Defaults to
884 <code>active-backup</code> if unset.
888 <column name="other_config" key="bond-hash-basis"
889 type='{"type": "integer"}'>
890 An integer hashed along with flows when choosing output slaves in load
891 balanced bonds. When changed, all flows will be assigned different
892 hash values possibly causing slave selection decisions to change. Does
893 not affect bonding modes which do not employ load balancing such as
894 <code>active-backup</code>.
897 <group title="Link Failure Detection">
899 An important part of link bonding is detecting that links are down so
900 that they may be disabled. These settings determine how Open vSwitch
901 detects link failure.
904 <column name="other_config" key="bond-detect-mode"
905 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
906 The means used to detect link failures. Defaults to
907 <code>carrier</code> which uses each interface's carrier to detect
908 failures. When set to <code>miimon</code>, will check for failures
909 by polling each interface's MII.
912 <column name="other_config" key="bond-miimon-interval"
913 type='{"type": "integer"}'>
914 The interval, in milliseconds, between successive attempts to poll
915 each interface's MII. Relevant only when <ref column="other_config"
916 key="bond-detect-mode"/> is <code>miimon</code>.
919 <column name="bond_updelay">
921 The number of milliseconds for which the link must stay up on an
922 interface before the interface is considered to be up. Specify
923 <code>0</code> to enable the interface immediately.
927 This setting is honored only when at least one bonded interface is
928 already enabled. When no interfaces are enabled, then the first
929 bond interface to come up is enabled immediately.
933 <column name="bond_downdelay">
934 The number of milliseconds for which the link must stay down on an
935 interface before the interface is considered to be down. Specify
936 <code>0</code> to disable the interface immediately.
940 <group title="LACP Configuration">
942 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
943 allows switches to automatically detect that they are connected by
944 multiple links and aggregate across those links. These settings
945 control LACP behavior.
949 Configures LACP on this port. LACP allows directly connected
950 switches to negotiate which links may be bonded. LACP may be enabled
951 on non-bonded ports for the benefit of any switches they may be
952 connected to. <code>active</code> ports are allowed to initiate LACP
953 negotiations. <code>passive</code> ports are allowed to participate
954 in LACP negotiations initiated by a remote switch, but not allowed to
955 initiate such negotiations themselves. If LACP is enabled on a port
956 whose partner switch does not support LACP, the bond will be
957 disabled. Defaults to <code>off</code> if unset.
960 <column name="other_config" key="lacp-system-id">
961 The LACP system ID of this <ref table="Port"/>. The system ID of a
962 LACP bond is used to identify itself to its partners. Must be a
963 nonzero MAC address. Defaults to the bridge Ethernet address if
967 <column name="other_config" key="lacp-system-priority"
968 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
969 The LACP system priority of this <ref table="Port"/>. In LACP
970 negotiations, link status decisions are made by the system with the
971 numerically lower priority.
974 <column name="other_config" key="lacp-time"
975 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
977 The LACP timing which should be used on this <ref table="Port"/>.
978 By default <code>slow</code> is used. When configured to be
979 <code>fast</code> LACP heartbeats are requested at a rate of once
980 per second causing connectivity problems to be detected more
981 quickly. In <code>slow</code> mode, heartbeats are requested at a
982 rate of once every 30 seconds.
987 <group title="Rebalancing Configuration">
989 These settings control behavior when a bond is in
990 <code>balance-slb</code> or <code>balance-tcp</code> mode.
993 <column name="other_config" key="bond-rebalance-interval"
994 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
995 For a load balanced bonded port, the number of milliseconds between
996 successive attempts to rebalance the bond, that is, to move flows
997 from one interface on the bond to another in an attempt to keep usage
998 of each interface roughly equal. If zero, load balancing is disabled
999 on the bond (link failure still cause flows to move). If
1000 less than 1000ms, the rebalance interval will be 1000ms.
1004 <column name="bond_fake_iface">
1005 For a bonded port, whether to create a fake internal interface with the
1006 name of the port. Use only for compatibility with legacy software that
1011 <group title="Spanning Tree Configuration">
1012 <column name="other_config" key="stp-enable"
1013 type='{"type": "boolean"}'>
1014 If spanning tree is enabled on the bridge, member ports are
1015 enabled by default (with the exception of bond, internal, and
1016 mirror ports which do not work with STP). If this column's
1017 value is <code>false</code> spanning tree is disabled on the
1021 <column name="other_config" key="stp-port-num"
1022 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1023 The port number used for the lower 8 bits of the port-id. By
1024 default, the numbers will be assigned automatically. If any
1025 port's number is manually configured on a bridge, then they
1029 <column name="other_config" key="stp-port-priority"
1030 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1031 The port's relative priority value for determining the root
1032 port (the upper 8 bits of the port-id). A port with a lower
1033 port-id will be chosen as the root port. By default, the
1037 <column name="other_config" key="stp-path-cost"
1038 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1039 Spanning tree path cost for the port. A lower number indicates
1040 a faster link. By default, the cost is based on the maximum
1045 <group title="Other Features">
1047 Quality of Service configuration for this port.
1051 The MAC address to use for this port for the purpose of choosing the
1052 bridge's MAC address. This column does not necessarily reflect the
1053 port's actual MAC address, nor will setting it change the port's actual
1057 <column name="fake_bridge">
1058 Does this port represent a sub-bridge for its tagged VLAN within the
1059 Bridge? See ovs-vsctl(8) for more information.
1062 <column name="external_ids" key="fake-bridge-id-*">
1063 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1064 column) are defined by prefixing a <ref table="Bridge"/> <ref
1065 table="Bridge" column="external_ids"/> key with
1066 <code>fake-bridge-</code>,
1067 e.g. <code>fake-bridge-xs-network-uuids</code>.
1071 <group title="Port Status">
1073 Status information about ports attached to bridges.
1075 <column name="status">
1076 Key-value pairs that report port status.
1078 <column name="status" key="stp_port_id">
1080 The port-id (in hex) used in spanning tree advertisements for
1081 this port. Configuring the port-id is described in the
1082 <code>stp-port-num</code> and <code>stp-port-priority</code>
1083 keys of the <code>other_config</code> section earlier.
1086 <column name="status" key="stp_state"
1087 type='{"type": "string", "enum": ["set",
1088 ["disabled", "listening", "learning",
1089 "forwarding", "blocking"]]}'>
1091 STP state of the port.
1094 <column name="status" key="stp_sec_in_state"
1095 type='{"type": "integer", "minInteger": 0}'>
1097 The amount of time (in seconds) port has been in the current
1101 <column name="status" key="stp_role"
1102 type='{"type": "string", "enum": ["set",
1103 ["root", "designated", "alternate"]]}'>
1105 STP role of the port.
1110 <group title="Port Statistics">
1112 Key-value pairs that report port statistics.
1114 <group title="Statistics: STP transmit and receive counters">
1115 <column name="statistics" key="stp_tx_count">
1116 Number of STP BPDUs sent on this port by the spanning
1119 <column name="statistics" key="stp_rx_count">
1120 Number of STP BPDUs received on this port and accepted by the
1121 spanning tree library.
1123 <column name="statistics" key="stp_error_count">
1124 Number of bad STP BPDUs received on this port. Bad BPDUs
1125 include runt packets and those with an unexpected protocol ID.
1130 <group title="Common Columns">
1131 The overall purpose of these columns is described under <code>Common
1132 Columns</code> at the beginning of this document.
1134 <column name="other_config"/>
1135 <column name="external_ids"/>
1139 <table name="Interface" title="One physical network device in a Port.">
1140 An interface within a <ref table="Port"/>.
1142 <group title="Core Features">
1143 <column name="name">
1144 Interface name. Should be alphanumeric and no more than about 8 bytes
1145 long. May be the same as the port name, for non-bonded ports. Must
1146 otherwise be unique among the names of ports, interfaces, and bridges
1151 <p>Ethernet address to set for this interface. If unset then the
1152 default MAC address is used:</p>
1154 <li>For the local interface, the default is the lowest-numbered MAC
1155 address among the other bridge ports, either the value of the
1156 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1157 if set, or its actual MAC (for bonded ports, the MAC of its slave
1158 whose name is first in alphabetical order). Internal ports and
1159 bridge ports that are used as port mirroring destinations (see the
1160 <ref table="Mirror"/> table) are ignored.</li>
1161 <li>For other internal interfaces, the default MAC is randomly
1163 <li>External interfaces typically have a MAC address associated with
1164 their hardware.</li>
1166 <p>Some interfaces may not have a software-controllable MAC
1170 <column name="ofport">
1171 <p>OpenFlow port number for this interface. Unlike most columns, this
1172 column's value should be set only by Open vSwitch itself. Other
1173 clients should set this column to an empty set (the default) when
1174 creating an <ref table="Interface"/>.</p>
1175 <p>Open vSwitch populates this column when the port number becomes
1176 known. If the interface is successfully added,
1177 <ref column="ofport"/> will be set to a number between 1 and 65535
1178 (generally either in the range 1 to 65279, inclusive, or 65534, the
1179 port number for the OpenFlow ``local port''). If the interface
1180 cannot be added then Open vSwitch sets this column
1182 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1183 an appropriate value for this column and then tries to keep the value
1184 constant across restarts.</p>
1187 <column name="ofport_request">
1188 <p>Requested OpenFlow port number for this interface. The port
1189 number must be between 1 and 65279, inclusive. Some datapaths
1190 cannot satisfy all requests for particular port numbers. When
1191 this column is empty or the request cannot be fulfilled, the
1192 system will choose a free port. The <ref column="ofport"/>
1193 column reports the assigned OpenFlow port number.</p>
1194 <p>The port number must be requested in the same transaction
1195 that creates the port.</p>
1199 <group title="System-Specific Details">
1200 <column name="type">
1202 The interface type, one of:
1206 <dt><code>system</code></dt>
1207 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1208 Sometimes referred to as ``external interfaces'' since they are
1209 generally connected to hardware external to that on which the Open
1210 vSwitch is running. The empty string is a synonym for
1211 <code>system</code>.</dd>
1213 <dt><code>internal</code></dt>
1214 <dd>A simulated network device that sends and receives traffic. An
1215 internal interface whose <ref column="name"/> is the same as its
1216 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1217 ``local interface.'' It does not make sense to bond an internal
1218 interface, so the terms ``port'' and ``interface'' are often used
1219 imprecisely for internal interfaces.</dd>
1221 <dt><code>tap</code></dt>
1222 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1224 <dt><code>gre</code></dt>
1226 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1230 <dt><code>ipsec_gre</code></dt>
1232 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1236 <dt><code>gre64</code></dt>
1238 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1239 of key, it uses GRE protocol sequence number field. This is non
1240 standard use of GRE protocol since OVS does not increment
1241 sequence number for every packet at time of encap as expected by
1242 standard GRE implementation. See <ref group="Tunnel Options"/>
1243 for information on configuring GRE tunnels.
1246 <dt><code>ipsec_gre64</code></dt>
1248 Same as IPSEC_GRE except 64 bit key.
1251 <dt><code>capwap</code></dt>
1253 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1254 5415). This allows interoperability with certain switches that do
1255 not support GRE. Only the tunneling component of the protocol is
1256 implemented. UDP ports 58881 and 58882 are used as the source and
1257 destination ports respectively. CAPWAP is currently supported only
1258 with the Linux kernel datapath with kernel version 2.6.26 or later.
1260 CAPWAP support is deprecated and will be removed no earlier than
1264 <dt><code>vxlan</code></dt>
1267 An Ethernet tunnel over the experimental, UDP-based VXLAN
1268 protocol described at
1269 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-02</code>.
1270 VXLAN is currently supported only with the Linux kernel datapath
1271 with kernel version 2.6.26 or later.
1274 As an experimental protocol, VXLAN has no officially assigned UDP
1275 port. Open vSwitch currently uses UDP destination port 8472.
1276 The source port used for VXLAN traffic varies on a per-flow basis
1277 and is in the ephemeral port range.
1281 <dt><code>patch</code></dt>
1283 A pair of virtual devices that act as a patch cable.
1286 <dt><code>null</code></dt>
1287 <dd>An ignored interface. Deprecated and slated for removal in
1293 <group title="Tunnel Options">
1295 These options apply to interfaces with <ref column="type"/> of
1296 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1297 <code>ipsec_gre64</code>, <code>capwap</code>, and
1302 Each tunnel must be uniquely identified by the combination of <ref
1303 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1304 column="options" key="local_ip"/>, and <ref column="options"
1305 key="in_key"/>. If two ports are defined that are the same except one
1306 has an optional identifier and the other does not, the more specific
1307 one is matched first. <ref column="options" key="in_key"/> is
1308 considered more specific than <ref column="options" key="local_ip"/> if
1309 a port defines one and another port defines the other.
1312 <column name="options" key="remote_ip">
1314 Required. The tunnel endpoint. Unicast and multicast endpoints are
1319 When a multicast endpoint is specified, a routing table lookup occurs
1320 only when the tunnel is created. Following a routing change, delete
1321 and then re-create the tunnel to force a new routing table lookup.
1325 <column name="options" key="local_ip">
1326 Optional. The destination IP that received packets must match.
1327 Default is to match all addresses. Must be omitted when <ref
1328 column="options" key="remote_ip"/> is a multicast address.
1331 <column name="options" key="in_key">
1332 <p>Optional. The key that received packets must contain, one of:</p>
1336 <code>0</code>. The tunnel receives packets with no key or with a
1337 key of 0. This is equivalent to specifying no <ref column="options"
1338 key="in_key"/> at all.
1341 A positive 24-bit (for VXLAN), 32-bit (for GRE) or 64-bit (for
1342 CAPWAP) number. The tunnel receives only packets with the
1346 The word <code>flow</code>. The tunnel accepts packets with any
1347 key. The key will be placed in the <code>tun_id</code> field for
1348 matching in the flow table. The <code>ovs-ofctl</code> manual page
1349 contains additional information about matching fields in OpenFlow
1358 <column name="options" key="out_key">
1359 <p>Optional. The key to be set on outgoing packets, one of:</p>
1363 <code>0</code>. Packets sent through the tunnel will have no key.
1364 This is equivalent to specifying no <ref column="options"
1365 key="out_key"/> at all.
1368 A positive 24-bit (for VXLAN), 32-bit (for GRE) or 64-bit (for
1369 CAPWAP) number. Packets sent through the tunnel will have the
1373 The word <code>flow</code>. Packets sent through the tunnel will
1374 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1375 vendor extension (0 is used in the absence of an action). The
1376 <code>ovs-ofctl</code> manual page contains additional information
1377 about the Nicira OpenFlow vendor extensions.
1382 <column name="options" key="key">
1383 Optional. Shorthand to set <code>in_key</code> and
1384 <code>out_key</code> at the same time.
1387 <column name="options" key="tos">
1388 Optional. The value of the ToS bits to be set on the encapsulating
1389 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1390 zero. It may also be the word <code>inherit</code>, in which case
1391 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1392 (otherwise it will be 0). The ECN fields are always inherited.
1396 <column name="options" key="ttl">
1397 Optional. The TTL to be set on the encapsulating packet. It may also
1398 be the word <code>inherit</code>, in which case the TTL will be copied
1399 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1400 system default, typically 64). Default is the system default TTL.
1403 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1404 Optional. If enabled, the Don't Fragment bit will be copied from the
1405 inner IP headers (those of the encapsulated traffic) to the outer
1406 (tunnel) headers. Default is disabled; set to <code>true</code> to
1410 <column name="options" key="df_default"
1411 type='{"type": "boolean"}'>
1412 Optional. If enabled, the Don't Fragment bit will be set by default on
1413 tunnel headers if the <code>df_inherit</code> option is not set, or if
1414 the encapsulated packet is not IP. Default is enabled; set to
1415 <code>false</code> to disable.
1418 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1419 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1420 Destination Unreachable - Fragmentation Needed'' messages will be
1421 generated for IPv4 packets with the DF bit set and IPv6 packets above
1422 the minimum MTU if the packet size exceeds the path MTU minus the size
1423 of the tunnel headers. Note that this option causes behavior that is
1424 typically reserved for routers and therefore is not entirely in
1425 compliance with the IEEE 802.1D specification for bridges. Default is
1426 disabled; set to <code>true</code> to enable. This feature is
1427 deprecated and will be removed soon.
1430 <group title="Tunnel Options: gre and ipsec_gre only">
1432 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1436 <column name="options" key="csum" type='{"type": "boolean"}'>
1438 Optional. Compute GRE checksums on outgoing packets. Default is
1439 disabled, set to <code>true</code> to enable. Checksums present on
1440 incoming packets will be validated regardless of this setting.
1444 GRE checksums impose a significant performance penalty because they
1445 cover the entire packet. The encapsulated L3, L4, and L7 packet
1446 contents typically have their own checksums, so this additional
1447 checksum only adds value for the GRE and encapsulated L2 headers.
1451 This option is supported for <code>ipsec_gre</code>, but not useful
1452 because GRE checksums are weaker than, and redundant with, IPsec
1453 payload authentication.
1458 <group title="Tunnel Options: ipsec_gre only">
1460 Only <code>ipsec_gre</code> interfaces support these options.
1463 <column name="options" key="peer_cert">
1464 Required for certificate authentication. A string containing the
1465 peer's certificate in PEM format. Additionally the host's
1466 certificate must be specified with the <code>certificate</code>
1470 <column name="options" key="certificate">
1471 Required for certificate authentication. The name of a PEM file
1472 containing a certificate that will be presented to the peer during
1476 <column name="options" key="private_key">
1477 Optional for certificate authentication. The name of a PEM file
1478 containing the private key associated with <code>certificate</code>.
1479 If <code>certificate</code> contains the private key, this option may
1483 <column name="options" key="psk">
1484 Required for pre-shared key authentication. Specifies a pre-shared
1485 key for authentication that must be identical on both sides of the
1491 <group title="Patch Options">
1493 Only <code>patch</code> interfaces support these options.
1496 <column name="options" key="peer">
1497 The <ref column="name"/> of the <ref table="Interface"/> for the other
1498 side of the patch. The named <ref table="Interface"/>'s own
1499 <code>peer</code> option must specify this <ref table="Interface"/>'s
1500 name. That is, the two patch interfaces must have reversed <ref
1501 column="name"/> and <code>peer</code> values.
1505 <group title="Interface Status">
1507 Status information about interfaces attached to bridges, updated every
1508 5 seconds. Not all interfaces have all of these properties; virtual
1509 interfaces don't have a link speed, for example. Non-applicable
1510 columns will have empty values.
1512 <column name="admin_state">
1514 The administrative state of the physical network link.
1518 <column name="link_state">
1520 The observed state of the physical network link. This is ordinarily
1521 the link's carrier status. If the interface's <ref table="Port"/> is
1522 a bond configured for miimon monitoring, it is instead the network
1523 link's miimon status.
1527 <column name="link_resets">
1529 The number of times Open vSwitch has observed the
1530 <ref column="link_state"/> of this <ref table="Interface"/> change.
1534 <column name="link_speed">
1536 The negotiated speed of the physical network link.
1537 Valid values are positive integers greater than 0.
1541 <column name="duplex">
1543 The duplex mode of the physical network link.
1549 The MTU (maximum transmission unit); i.e. the largest
1550 amount of data that can fit into a single Ethernet frame.
1551 The standard Ethernet MTU is 1500 bytes. Some physical media
1552 and many kinds of virtual interfaces can be configured with
1556 This column will be empty for an interface that does not
1557 have an MTU as, for example, some kinds of tunnels do not.
1561 <column name="lacp_current">
1562 Boolean value indicating LACP status for this interface. If true, this
1563 interface has current LACP information about its LACP partner. This
1564 information may be used to monitor the health of interfaces in a LACP
1565 enabled port. This column will be empty if LACP is not enabled.
1568 <column name="status">
1569 Key-value pairs that report port status. Supported status values are
1570 <ref column="type"/>-dependent; some interfaces may not have a valid
1571 <ref column="status" key="driver_name"/>, for example.
1574 <column name="status" key="driver_name">
1575 The name of the device driver controlling the network adapter.
1578 <column name="status" key="driver_version">
1579 The version string of the device driver controlling the network
1583 <column name="status" key="firmware_version">
1584 The version string of the network adapter's firmware, if available.
1587 <column name="status" key="source_ip">
1588 The source IP address used for an IPv4 tunnel end-point, such as
1589 <code>gre</code> or <code>capwap</code>.
1592 <column name="status" key="tunnel_egress_iface">
1593 Egress interface for tunnels. Currently only relevant for GRE and
1594 CAPWAP tunnels. On Linux systems, this column will show the name of
1595 the interface which is responsible for routing traffic destined for the
1596 configured <ref column="options" key="remote_ip"/>. This could be an
1597 internal interface such as a bridge port.
1600 <column name="status" key="tunnel_egress_iface_carrier"
1601 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1602 Whether carrier is detected on <ref column="status"
1603 key="tunnel_egress_iface"/>.
1607 <group title="Statistics">
1609 Key-value pairs that report interface statistics. The current
1610 implementation updates these counters periodically. Future
1611 implementations may update them when an interface is created, when they
1612 are queried (e.g. using an OVSDB <code>select</code> operation), and
1613 just before an interface is deleted due to virtual interface hot-unplug
1614 or VM shutdown, and perhaps at other times, but not on any regular
1618 These are the same statistics reported by OpenFlow in its <code>struct
1619 ofp_port_stats</code> structure. If an interface does not support a
1620 given statistic, then that pair is omitted.
1622 <group title="Statistics: Successful transmit and receive counters">
1623 <column name="statistics" key="rx_packets">
1624 Number of received packets.
1626 <column name="statistics" key="rx_bytes">
1627 Number of received bytes.
1629 <column name="statistics" key="tx_packets">
1630 Number of transmitted packets.
1632 <column name="statistics" key="tx_bytes">
1633 Number of transmitted bytes.
1636 <group title="Statistics: Receive errors">
1637 <column name="statistics" key="rx_dropped">
1638 Number of packets dropped by RX.
1640 <column name="statistics" key="rx_frame_err">
1641 Number of frame alignment errors.
1643 <column name="statistics" key="rx_over_err">
1644 Number of packets with RX overrun.
1646 <column name="statistics" key="rx_crc_err">
1647 Number of CRC errors.
1649 <column name="statistics" key="rx_errors">
1650 Total number of receive errors, greater than or equal to the sum of
1654 <group title="Statistics: Transmit errors">
1655 <column name="statistics" key="tx_dropped">
1656 Number of packets dropped by TX.
1658 <column name="statistics" key="collisions">
1659 Number of collisions.
1661 <column name="statistics" key="tx_errors">
1662 Total number of transmit errors, greater than or equal to the sum of
1668 <group title="Ingress Policing">
1670 These settings control ingress policing for packets received on this
1671 interface. On a physical interface, this limits the rate at which
1672 traffic is allowed into the system from the outside; on a virtual
1673 interface (one connected to a virtual machine), this limits the rate at
1674 which the VM is able to transmit.
1677 Policing is a simple form of quality-of-service that simply drops
1678 packets received in excess of the configured rate. Due to its
1679 simplicity, policing is usually less accurate and less effective than
1680 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1681 table="Queue"/> tables).
1684 Policing is currently implemented only on Linux. The Linux
1685 implementation uses a simple ``token bucket'' approach:
1689 The size of the bucket corresponds to <ref
1690 column="ingress_policing_burst"/>. Initially the bucket is full.
1693 Whenever a packet is received, its size (converted to tokens) is
1694 compared to the number of tokens currently in the bucket. If the
1695 required number of tokens are available, they are removed and the
1696 packet is forwarded. Otherwise, the packet is dropped.
1699 Whenever it is not full, the bucket is refilled with tokens at the
1700 rate specified by <ref column="ingress_policing_rate"/>.
1704 Policing interacts badly with some network protocols, and especially
1705 with fragmented IP packets. Suppose that there is enough network
1706 activity to keep the bucket nearly empty all the time. Then this token
1707 bucket algorithm will forward a single packet every so often, with the
1708 period depending on packet size and on the configured rate. All of the
1709 fragments of an IP packets are normally transmitted back-to-back, as a
1710 group. In such a situation, therefore, only one of these fragments
1711 will be forwarded and the rest will be dropped. IP does not provide
1712 any way for the intended recipient to ask for only the remaining
1713 fragments. In such a case there are two likely possibilities for what
1714 will happen next: either all of the fragments will eventually be
1715 retransmitted (as TCP will do), in which case the same problem will
1716 recur, or the sender will not realize that its packet has been dropped
1717 and data will simply be lost (as some UDP-based protocols will do).
1718 Either way, it is possible that no forward progress will ever occur.
1720 <column name="ingress_policing_rate">
1722 Maximum rate for data received on this interface, in kbps. Data
1723 received faster than this rate is dropped. Set to <code>0</code>
1724 (the default) to disable policing.
1728 <column name="ingress_policing_burst">
1729 <p>Maximum burst size for data received on this interface, in kb. The
1730 default burst size if set to <code>0</code> is 1000 kb. This value
1731 has no effect if <ref column="ingress_policing_rate"/>
1732 is <code>0</code>.</p>
1734 Specifying a larger burst size lets the algorithm be more forgiving,
1735 which is important for protocols like TCP that react severely to
1736 dropped packets. The burst size should be at least the size of the
1737 interface's MTU. Specifying a value that is numerically at least as
1738 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1739 closer to achieving the full rate.
1744 <group title="Connectivity Fault Management">
1746 802.1ag Connectivity Fault Management (CFM) allows a group of
1747 Maintenance Points (MPs) called a Maintenance Association (MA) to
1748 detect connectivity problems with each other. MPs within a MA should
1749 have complete and exclusive interconnectivity. This is verified by
1750 occasionally broadcasting Continuity Check Messages (CCMs) at a
1751 configurable transmission interval.
1755 According to the 802.1ag specification, each Maintenance Point should
1756 be configured out-of-band with a list of Remote Maintenance Points it
1757 should have connectivity to. Open vSwitch differs from the
1758 specification in this area. It simply assumes the link is faulted if
1759 no Remote Maintenance Points are reachable, and considers it not
1764 When operating over tunnels which have no <code>in_key</code>, or an
1765 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1766 with a tunnel key of zero.
1769 <column name="cfm_mpid">
1770 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1771 a Maintenance Association. The MPID is used to identify this endpoint
1772 to other Maintenance Points in the MA. Each end of a link being
1773 monitored should have a different MPID. Must be configured to enable
1774 CFM on this <ref table="Interface"/>.
1777 <column name="cfm_fault">
1779 Indicates a connectivity fault triggered by an inability to receive
1780 heartbeats from any remote endpoint. When a fault is triggered on
1781 <ref table="Interface"/>s participating in bonds, they will be
1785 Faults can be triggered for several reasons. Most importantly they
1786 are triggered when no CCMs are received for a period of 3.5 times the
1787 transmission interval. Faults are also triggered when any CCMs
1788 indicate that a Remote Maintenance Point is not receiving CCMs but
1789 able to send them. Finally, a fault is triggered if a CCM is
1790 received which indicates unexpected configuration. Notably, this
1791 case arises when a CCM is received which advertises the local MPID.
1795 <column name="cfm_fault_status" key="recv">
1796 Indicates a CFM fault was triggered due to a lack of CCMs received on
1797 the <ref table="Interface"/>.
1800 <column name="cfm_fault_status" key="rdi">
1801 Indicates a CFM fault was triggered due to the reception of a CCM with
1802 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1803 are not receiving CCMs themselves. This typically indicates a
1804 unidirectional connectivity failure.
1807 <column name="cfm_fault_status" key="maid">
1808 Indicates a CFM fault was triggered due to the reception of a CCM with
1809 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1810 with an identification number in addition to the MPID called the MAID.
1811 Open vSwitch only supports receiving CCM broadcasts tagged with the
1812 MAID it uses internally.
1815 <column name="cfm_fault_status" key="loopback">
1816 Indicates a CFM fault was triggered due to the reception of a CCM
1817 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1818 column of this <ref table="Interface"/>. This may indicate a loop in
1822 <column name="cfm_fault_status" key="overflow">
1823 Indicates a CFM fault was triggered because the CFM module received
1824 CCMs from more remote endpoints than it can keep track of.
1827 <column name="cfm_fault_status" key="override">
1828 Indicates a CFM fault was manually triggered by an administrator using
1829 an <code>ovs-appctl</code> command.
1832 <column name="cfm_fault_status" key="interval">
1833 Indicates a CFM fault was triggered due to the reception of a CCM
1834 frame having an invalid interval.
1837 <column name="cfm_remote_opstate">
1838 <p>When in extended mode, indicates the operational state of the
1839 remote endpoint as either <code>up</code> or <code>down</code>. See
1840 <ref column="other_config" key="cfm_opstate"/>.
1844 <column name="cfm_health">
1846 Indicates the health of the interface as a percentage of CCM frames
1847 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1848 The health of an interface is undefined if it is communicating with
1849 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1850 healthy heartbeats are not received at the expected rate, and
1851 gradually improves as healthy heartbeats are received at the desired
1852 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1853 health of the interface is refreshed.
1856 As mentioned above, the faults can be triggered for several reasons.
1857 The link health will deteriorate even if heartbeats are received but
1858 they are reported to be unhealthy. An unhealthy heartbeat in this
1859 context is a heartbeat for which either some fault is set or is out
1860 of sequence. The interface health can be 100 only on receiving
1861 healthy heartbeats at the desired rate.
1865 <column name="cfm_remote_mpids">
1866 When CFM is properly configured, Open vSwitch will occasionally
1867 receive CCM broadcasts. These broadcasts contain the MPID of the
1868 sending Maintenance Point. The list of MPIDs from which this
1869 <ref table="Interface"/> is receiving broadcasts from is regularly
1870 collected and written to this column.
1873 <column name="other_config" key="cfm_interval"
1874 type='{"type": "integer"}'>
1876 The interval, in milliseconds, between transmissions of CFM
1877 heartbeats. Three missed heartbeat receptions indicate a
1882 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1883 60,000, or 600,000 ms are supported. Other values will be rounded
1884 down to the nearest value on the list. Extended mode (see <ref
1885 column="other_config" key="cfm_extended"/>) supports any interval up
1886 to 65,535 ms. In either mode, the default is 1000 ms.
1889 <p>We do not recommend using intervals less than 100 ms.</p>
1892 <column name="other_config" key="cfm_extended"
1893 type='{"type": "boolean"}'>
1894 When <code>true</code>, the CFM module operates in extended mode. This
1895 causes it to use a nonstandard destination address to avoid conflicting
1896 with compliant implementations which may be running concurrently on the
1897 network. Furthermore, extended mode increases the accuracy of the
1898 <code>cfm_interval</code> configuration parameter by breaking wire
1899 compatibility with 802.1ag compliant implementations. Defaults to
1902 <column name="other_config" key="cfm_opstate"
1903 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1904 When <code>down</code>, the CFM module marks all CCMs it generates as
1905 operationally down without triggering a fault. This allows remote
1906 maintenance points to choose not to forward traffic to the
1907 <ref table="Interface"/> on which this CFM module is running.
1908 Currently, in Open vSwitch, the opdown bit of CCMs affects
1909 <ref table="Interface"/>s participating in bonds, and the bundle
1910 OpenFlow action. This setting is ignored when CFM is not in extended
1911 mode. Defaults to <code>up</code>.
1914 <column name="other_config" key="cfm_ccm_vlan"
1915 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1916 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1917 with the given value. May be the string <code>random</code> in which
1918 case each CCM will be tagged with a different randomly generated VLAN.
1921 <column name="other_config" key="cfm_ccm_pcp"
1922 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1923 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1924 with the given PCP value, the VLAN ID of the tag is governed by the
1925 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1926 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1932 <group title="Bonding Configuration">
1933 <column name="other_config" key="bond-stable-id"
1934 type='{"type": "integer", "minInteger": 1}'>
1935 Used in <code>stable</code> bond mode to make slave
1936 selection decisions. Allocating <ref column="other_config"
1937 key="bond-stable-id"/> values consistently across interfaces
1938 participating in a bond will guarantee consistent slave selection
1939 decisions across <code>ovs-vswitchd</code> instances when using
1940 <code>stable</code> bonding mode.
1943 <column name="other_config" key="lacp-port-id"
1944 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1945 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1946 used in LACP negotiations to identify individual ports
1947 participating in a bond.
1950 <column name="other_config" key="lacp-port-priority"
1951 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1952 The LACP port priority of this <ref table="Interface"/>. In LACP
1953 negotiations <ref table="Interface"/>s with numerically lower
1954 priorities are preferred for aggregation.
1957 <column name="other_config" key="lacp-aggregation-key"
1958 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1959 The LACP aggregation key of this <ref table="Interface"/>. <ref
1960 table="Interface"/>s with different aggregation keys may not be active
1961 within a given <ref table="Port"/> at the same time.
1965 <group title="Virtual Machine Identifiers">
1967 These key-value pairs specifically apply to an interface that
1968 represents a virtual Ethernet interface connected to a virtual
1969 machine. These key-value pairs should not be present for other types
1970 of interfaces. Keys whose names end in <code>-uuid</code> have
1971 values that uniquely identify the entity in question. For a Citrix
1972 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1973 Other hypervisors may use other formats.
1976 <column name="external_ids" key="attached-mac">
1977 The MAC address programmed into the ``virtual hardware'' for this
1978 interface, in the form
1979 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1980 For Citrix XenServer, this is the value of the <code>MAC</code> field
1981 in the VIF record for this interface.
1984 <column name="external_ids" key="iface-id">
1985 A system-unique identifier for the interface. On XenServer, this will
1986 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1989 <column name="external_ids" key="iface-status"
1990 type='{"type": "string",
1991 "enum": ["set", ["active", "inactive"]]}'>
1993 Hypervisors may sometimes have more than one interface associated
1994 with a given <ref column="external_ids" key="iface-id"/>, only one of
1995 which is actually in use at a given time. For example, in some
1996 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1997 for a single <ref column="external_ids" key="iface-id"/>, but only
1998 uses one of them at a time. A hypervisor that behaves this way must
1999 mark the currently in use interface <code>active</code> and the
2000 others <code>inactive</code>. A hypervisor that never has more than
2001 one interface for a given <ref column="external_ids" key="iface-id"/>
2002 may mark that interface <code>active</code> or omit <ref
2003 column="external_ids" key="iface-status"/> entirely.
2007 During VM migration, a given <ref column="external_ids"
2008 key="iface-id"/> might transiently be marked <code>active</code> on
2009 two different hypervisors. That is, <code>active</code> means that
2010 this <ref column="external_ids" key="iface-id"/> is the active
2011 instance within a single hypervisor, not in a broader scope.
2015 <column name="external_ids" key="xs-vif-uuid">
2016 The virtual interface associated with this interface.
2019 <column name="external_ids" key="xs-network-uuid">
2020 The virtual network to which this interface is attached.
2023 <column name="external_ids" key="vm-id">
2024 The VM to which this interface belongs. On XenServer, this will be the
2025 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2028 <column name="external_ids" key="xs-vm-uuid">
2029 The VM to which this interface belongs.
2033 <group title="VLAN Splinters">
2035 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2036 with buggy network drivers in old versions of Linux that do not
2037 properly support VLANs when VLAN devices are not used, at some cost
2038 in memory and performance.
2042 When VLAN splinters are enabled on a particular interface, Open vSwitch
2043 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2044 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2045 received on the VLAN device is treated as if it had been received on
2046 the interface on the particular VLAN.
2050 VLAN splinters consider a VLAN to be in use if:
2055 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2056 table="Port"/> record.
2060 The VLAN is listed within the <ref table="Port" column="trunks"/>
2061 column of the <ref table="Port"/> record of an interface on which
2062 VLAN splinters are enabled.
2064 An empty <ref table="Port" column="trunks"/> does not influence the
2065 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2066 will exceed the current 1,024 port per datapath limit.
2070 An OpenFlow flow within any bridge matches the VLAN.
2075 The same set of in-use VLANs applies to every interface on which VLAN
2076 splinters are enabled. That is, the set is not chosen separately for
2077 each interface but selected once as the union of all in-use VLANs based
2082 It does not make sense to enable VLAN splinters on an interface for an
2083 access port, or on an interface that is not a physical port.
2087 VLAN splinters are deprecated. When broken device drivers are no
2088 longer in widespread use, we will delete this feature.
2091 <column name="other_config" key="enable-vlan-splinters"
2092 type='{"type": "boolean"}'>
2094 Set to <code>true</code> to enable VLAN splinters on this interface.
2095 Defaults to <code>false</code>.
2099 VLAN splinters increase kernel and userspace memory overhead, so do
2100 not use them unless they are needed.
2104 VLAN splinters do not support 802.1p priority tags. Received
2105 priorities will appear to be 0, regardless of their actual values,
2106 and priorities on transmitted packets will also be cleared to 0.
2111 <group title="Common Columns">
2112 The overall purpose of these columns is described under <code>Common
2113 Columns</code> at the beginning of this document.
2115 <column name="other_config"/>
2116 <column name="external_ids"/>
2120 <table name="Flow_Table" title="OpenFlow table configuration">
2121 <p>Configuration for a particular OpenFlow table.</p>
2123 <column name="name">
2124 The table's name. Set this column to change the name that controllers
2125 will receive when they request table statistics, e.g. <code>ovs-ofctl
2126 dump-tables</code>. The name does not affect switch behavior.
2129 <column name="flow_limit">
2130 If set, limits the number of flows that may be added to the table. Open
2131 vSwitch may limit the number of flows in a table for other reasons,
2132 e.g. due to hardware limitations or for resource availability or
2133 performance reasons.
2136 <column name="overflow_policy">
2138 Controls the switch's behavior when an OpenFlow flow table modification
2139 request would add flows in excess of <ref column="flow_limit"/>. The
2140 supported values are:
2144 <dt><code>refuse</code></dt>
2146 Refuse to add the flow or flows. This is also the default policy
2147 when <ref column="overflow_policy"/> is unset.
2150 <dt><code>evict</code></dt>
2152 Delete the flow that will expire soonest. See <ref column="groups"/>
2158 <column name="groups">
2160 When <ref column="overflow_policy"/> is <code>evict</code>, this
2161 controls how flows are chosen for eviction when the flow table would
2162 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2163 of NXM fields or sub-fields, each of which takes one of the forms
2164 <code><var>field</var>[]</code> or
2165 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2166 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2167 <code>nicira-ext.h</code> for a complete list of NXM field names.
2171 When a flow must be evicted due to overflow, the flow to evict is
2172 chosen through an approximation of the following algorithm:
2177 Divide the flows in the table into groups based on the values of the
2178 specified fields or subfields, so that all of the flows in a given
2179 group have the same values for those fields. If a flow does not
2180 specify a given field, that field's value is treated as 0.
2184 Consider the flows in the largest group, that is, the group that
2185 contains the greatest number of flows. If two or more groups all
2186 have the same largest number of flows, consider the flows in all of
2191 Among the flows under consideration, choose the flow that expires
2192 soonest for eviction.
2197 The eviction process only considers flows that have an idle timeout or
2198 a hard timeout. That is, eviction never deletes permanent flows.
2199 (Permanent flows do count against <ref column="flow_limit"/>.)
2203 Open vSwitch ignores any invalid or unknown field specifications.
2207 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2208 column has no effect.
2213 <table name="QoS" title="Quality of Service configuration">
2214 <p>Quality of Service (QoS) configuration for each Port that
2217 <column name="type">
2218 <p>The type of QoS to implement. The currently defined types are
2221 <dt><code>linux-htb</code></dt>
2223 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2224 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2225 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2226 for information on how this classifier works and how to configure it.
2230 <dt><code>linux-hfsc</code></dt>
2232 Linux "Hierarchical Fair Service Curve" classifier.
2233 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2234 information on how this classifier works.
2239 <column name="queues">
2240 <p>A map from queue numbers to <ref table="Queue"/> records. The
2241 supported range of queue numbers depend on <ref column="type"/>. The
2242 queue numbers are the same as the <code>queue_id</code> used in
2243 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2247 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2248 actions when no specific queue has been set. When no configuration for
2249 queue 0 is present, it is automatically configured as if a <ref
2250 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2251 and <ref table="Queue" column="other_config"/> columns had been
2253 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2254 this case. With some queuing disciplines, this dropped all packets
2255 destined for the default queue.)
2259 <group title="Configuration for linux-htb and linux-hfsc">
2261 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2262 the following key-value pair:
2265 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2266 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2267 specified, for physical interfaces, the default is the link rate. For
2268 other interfaces or if the link rate cannot be determined, the default
2269 is currently 100 Mbps.
2273 <group title="Common Columns">
2274 The overall purpose of these columns is described under <code>Common
2275 Columns</code> at the beginning of this document.
2277 <column name="other_config"/>
2278 <column name="external_ids"/>
2282 <table name="Queue" title="QoS output queue.">
2283 <p>A configuration for a port output queue, used in configuring Quality of
2284 Service (QoS) features. May be referenced by <ref column="queues"
2285 table="QoS"/> column in <ref table="QoS"/> table.</p>
2287 <column name="dscp">
2288 If set, Open vSwitch will mark all traffic egressing this
2289 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2290 default <ref table="Queue"/> is only marked if it was explicitly selected
2291 as the <ref table="Queue"/> at the time the packet was output. If unset,
2292 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2296 <group title="Configuration for linux-htb QoS">
2298 <ref table="QoS"/> <ref table="QoS" column="type"/>
2299 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2300 It has the following key-value pairs defined.
2303 <column name="other_config" key="min-rate"
2304 type='{"type": "integer", "minInteger": 1}'>
2305 Minimum guaranteed bandwidth, in bit/s.
2308 <column name="other_config" key="max-rate"
2309 type='{"type": "integer", "minInteger": 1}'>
2310 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2311 queue's rate will not be allowed to exceed the specified value, even
2312 if excess bandwidth is available. If unspecified, defaults to no
2316 <column name="other_config" key="burst"
2317 type='{"type": "integer", "minInteger": 1}'>
2318 Burst size, in bits. This is the maximum amount of ``credits'' that a
2319 queue can accumulate while it is idle. Optional. Details of the
2320 <code>linux-htb</code> implementation require a minimum burst size, so
2321 a too-small <code>burst</code> will be silently ignored.
2324 <column name="other_config" key="priority"
2325 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2326 A queue with a smaller <code>priority</code> will receive all the
2327 excess bandwidth that it can use before a queue with a larger value
2328 receives any. Specific priority values are unimportant; only relative
2329 ordering matters. Defaults to 0 if unspecified.
2333 <group title="Configuration for linux-hfsc QoS">
2335 <ref table="QoS"/> <ref table="QoS" column="type"/>
2336 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2337 It has the following key-value pairs defined.
2340 <column name="other_config" key="min-rate"
2341 type='{"type": "integer", "minInteger": 1}'>
2342 Minimum guaranteed bandwidth, in bit/s.
2345 <column name="other_config" key="max-rate"
2346 type='{"type": "integer", "minInteger": 1}'>
2347 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2348 queue's rate will not be allowed to exceed the specified value, even if
2349 excess bandwidth is available. If unspecified, defaults to no
2354 <group title="Common Columns">
2355 The overall purpose of these columns is described under <code>Common
2356 Columns</code> at the beginning of this document.
2358 <column name="other_config"/>
2359 <column name="external_ids"/>
2363 <table name="Mirror" title="Port mirroring.">
2364 <p>A port mirror within a <ref table="Bridge"/>.</p>
2365 <p>A port mirror configures a bridge to send selected frames to special
2366 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2367 traffic may also be referred to as SPAN or RSPAN, depending on how
2368 the mirrored traffic is sent.</p>
2370 <column name="name">
2371 Arbitrary identifier for the <ref table="Mirror"/>.
2374 <group title="Selecting Packets for Mirroring">
2376 To be selected for mirroring, a given packet must enter or leave the
2377 bridge through a selected port and it must also be in one of the
2381 <column name="select_all">
2382 If true, every packet arriving or departing on any port is
2383 selected for mirroring.
2386 <column name="select_dst_port">
2387 Ports on which departing packets are selected for mirroring.
2390 <column name="select_src_port">
2391 Ports on which arriving packets are selected for mirroring.
2394 <column name="select_vlan">
2395 VLANs on which packets are selected for mirroring. An empty set
2396 selects packets on all VLANs.
2400 <group title="Mirroring Destination Configuration">
2402 These columns are mutually exclusive. Exactly one of them must be
2406 <column name="output_port">
2407 <p>Output port for selected packets, if nonempty.</p>
2408 <p>Specifying a port for mirror output reserves that port exclusively
2409 for mirroring. No frames other than those selected for mirroring
2411 will be forwarded to the port, and any frames received on the port
2412 will be discarded.</p>
2414 The output port may be any kind of port supported by Open vSwitch.
2415 It may be, for example, a physical port (sometimes called SPAN) or a
2420 <column name="output_vlan">
2421 <p>Output VLAN for selected packets, if nonempty.</p>
2422 <p>The frames will be sent out all ports that trunk
2423 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2424 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2425 trunk port, the frame's VLAN tag will be set to
2426 <ref column="output_vlan"/>, replacing any existing tag; when it is
2427 sent out an implicit VLAN port, the frame will not be tagged. This
2428 type of mirroring is sometimes called RSPAN.</p>
2430 See the documentation for
2431 <ref column="other_config" key="forward-bpdu"/> in the
2432 <ref table="Interface"/> table for a list of destination MAC
2433 addresses which will not be mirrored to a VLAN to avoid confusing
2434 switches that interpret the protocols that they represent.
2436 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2437 contains unmanaged switches. Consider an unmanaged physical switch
2438 with two ports: port 1, connected to an end host, and port 2,
2439 connected to an Open vSwitch configured to mirror received packets
2440 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2441 port 1 that the physical switch forwards to port 2. The Open vSwitch
2442 forwards this packet to its destination and then reflects it back on
2443 port 2 in VLAN 123. This reflected packet causes the unmanaged
2444 physical switch to replace the MAC learning table entry, which
2445 correctly pointed to port 1, with one that incorrectly points to port
2446 2. Afterward, the physical switch will direct packets destined for
2447 the end host to the Open vSwitch on port 2, instead of to the end
2448 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2449 desired in this scenario, then the physical switch must be replaced
2450 by one that learns Ethernet addresses on a per-VLAN basis. In
2451 addition, learning should be disabled on the VLAN containing mirrored
2452 traffic. If this is not done then intermediate switches will learn
2453 the MAC address of each end host from the mirrored traffic. If
2454 packets being sent to that end host are also mirrored, then they will
2455 be dropped since the switch will attempt to send them out the input
2456 port. Disabling learning for the VLAN will cause the switch to
2457 correctly send the packet out all ports configured for that VLAN. If
2458 Open vSwitch is being used as an intermediate switch, learning can be
2459 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2460 in the appropriate <ref table="Bridge"/> table or tables.</p>
2462 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2463 VLAN and should generally be preferred.
2468 <group title="Statistics: Mirror counters">
2470 Key-value pairs that report mirror statistics.
2472 <column name="statistics" key="tx_packets">
2473 Number of packets transmitted through this mirror.
2475 <column name="statistics" key="tx_bytes">
2476 Number of bytes transmitted through this mirror.
2480 <group title="Common Columns">
2481 The overall purpose of these columns is described under <code>Common
2482 Columns</code> at the beginning of this document.
2484 <column name="external_ids"/>
2488 <table name="Controller" title="OpenFlow controller configuration.">
2489 <p>An OpenFlow controller.</p>
2492 Open vSwitch supports two kinds of OpenFlow controllers:
2496 <dt>Primary controllers</dt>
2499 This is the kind of controller envisioned by the OpenFlow 1.0
2500 specification. Usually, a primary controller implements a network
2501 policy by taking charge of the switch's flow table.
2505 Open vSwitch initiates and maintains persistent connections to
2506 primary controllers, retrying the connection each time it fails or
2507 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2508 <ref table="Bridge"/> table applies to primary controllers.
2512 Open vSwitch permits a bridge to have any number of primary
2513 controllers. When multiple controllers are configured, Open
2514 vSwitch connects to all of them simultaneously. Because
2515 OpenFlow 1.0 does not specify how multiple controllers
2516 coordinate in interacting with a single switch, more than
2517 one primary controller should be specified only if the
2518 controllers are themselves designed to coordinate with each
2519 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2520 vendor extension may be useful for this.)
2523 <dt>Service controllers</dt>
2526 These kinds of OpenFlow controller connections are intended for
2527 occasional support and maintenance use, e.g. with
2528 <code>ovs-ofctl</code>. Usually a service controller connects only
2529 briefly to inspect or modify some of a switch's state.
2533 Open vSwitch listens for incoming connections from service
2534 controllers. The service controllers initiate and, if necessary,
2535 maintain the connections from their end. The <ref table="Bridge"
2536 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2537 not apply to service controllers.
2541 Open vSwitch supports configuring any number of service controllers.
2547 The <ref column="target"/> determines the type of controller.
2550 <group title="Core Features">
2551 <column name="target">
2552 <p>Connection method for controller.</p>
2554 The following connection methods are currently supported for primary
2558 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2560 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2561 the given <var>ip</var>, which must be expressed as an IP address
2562 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2563 column in the <ref table="Open_vSwitch"/> table must point to a
2564 valid SSL configuration when this form is used.</p>
2565 <p>SSL support is an optional feature that is not always built as
2566 part of Open vSwitch.</p>
2568 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2569 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2570 the given <var>ip</var>, which must be expressed as an IP address
2571 (not a DNS name).</dd>
2574 The following connection methods are currently supported for service
2578 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2581 Listens for SSL connections on the specified TCP <var>port</var>
2582 (default: 6633). If <var>ip</var>, which must be expressed as an
2583 IP address (not a DNS name), is specified, then connections are
2584 restricted to the specified local IP address.
2587 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2588 table="Open_vSwitch"/> table must point to a valid SSL
2589 configuration when this form is used.
2591 <p>SSL support is an optional feature that is not always built as
2592 part of Open vSwitch.</p>
2594 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2596 Listens for connections on the specified TCP <var>port</var>
2597 (default: 6633). If <var>ip</var>, which must be expressed as an
2598 IP address (not a DNS name), is specified, then connections are
2599 restricted to the specified local IP address.
2602 <p>When multiple controllers are configured for a single bridge, the
2603 <ref column="target"/> values must be unique. Duplicate
2604 <ref column="target"/> values yield unspecified results.</p>
2607 <column name="connection_mode">
2608 <p>If it is specified, this setting must be one of the following
2609 strings that describes how Open vSwitch contacts this OpenFlow
2610 controller over the network:</p>
2613 <dt><code>in-band</code></dt>
2614 <dd>In this mode, this controller's OpenFlow traffic travels over the
2615 bridge associated with the controller. With this setting, Open
2616 vSwitch allows traffic to and from the controller regardless of the
2617 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2618 would never be able to connect to the controller, because it did
2619 not have a flow to enable it.) This is the most common connection
2620 mode because it is not necessary to maintain two independent
2622 <dt><code>out-of-band</code></dt>
2623 <dd>In this mode, OpenFlow traffic uses a control network separate
2624 from the bridge associated with this controller, that is, the
2625 bridge does not use any of its own network devices to communicate
2626 with the controller. The control network must be configured
2627 separately, before or after <code>ovs-vswitchd</code> is started.
2631 <p>If not specified, the default is implementation-specific.</p>
2635 <group title="Controller Failure Detection and Handling">
2636 <column name="max_backoff">
2637 Maximum number of milliseconds to wait between connection attempts.
2638 Default is implementation-specific.
2641 <column name="inactivity_probe">
2642 Maximum number of milliseconds of idle time on connection to
2643 controller before sending an inactivity probe message. If Open
2644 vSwitch does not communicate with the controller for the specified
2645 number of seconds, it will send a probe. If a response is not
2646 received for the same additional amount of time, Open vSwitch
2647 assumes the connection has been broken and attempts to reconnect.
2648 Default is implementation-specific. A value of 0 disables
2653 <group title="Asynchronous Message Configuration">
2655 OpenFlow switches send certain messages to controllers spontanenously,
2656 that is, not in response to any request from the controller. These
2657 messages are called ``asynchronous messages.'' These columns allow
2658 asynchronous messages to be limited or disabled to ensure the best use
2659 of network resources.
2662 <column name="enable_async_messages">
2663 The OpenFlow protocol enables asynchronous messages at time of
2664 connection establishment, which means that a controller can receive
2665 asynchronous messages, potentially many of them, even if it turns them
2666 off immediately after connecting. Set this column to
2667 <code>false</code> to change Open vSwitch behavior to disable, by
2668 default, all asynchronous messages. The controller can use the
2669 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2670 on any messages that it does want to receive, if any.
2673 <column name="controller_rate_limit">
2675 The maximum rate at which the switch will forward packets to the
2676 OpenFlow controller, in packets per second. This feature prevents a
2677 single bridge from overwhelming the controller. If not specified,
2678 the default is implementation-specific.
2682 In addition, when a high rate triggers rate-limiting, Open vSwitch
2683 queues controller packets for each port and transmits them to the
2684 controller at the configured rate. The <ref
2685 column="controller_burst_limit"/> value limits the number of queued
2686 packets. Ports on a bridge share the packet queue fairly.
2690 Open vSwitch maintains two such packet rate-limiters per bridge: one
2691 for packets sent up to the controller because they do not correspond
2692 to any flow, and the other for packets sent up to the controller by
2693 request through flow actions. When both rate-limiters are filled with
2694 packets, the actual rate that packets are sent to the controller is
2695 up to twice the specified rate.
2699 <column name="controller_burst_limit">
2700 In conjunction with <ref column="controller_rate_limit"/>,
2701 the maximum number of unused packet credits that the bridge will
2702 allow to accumulate, in packets. If not specified, the default
2703 is implementation-specific.
2707 <group title="Additional In-Band Configuration">
2708 <p>These values are considered only in in-band control mode (see
2709 <ref column="connection_mode"/>).</p>
2711 <p>When multiple controllers are configured on a single bridge, there
2712 should be only one set of unique values in these columns. If different
2713 values are set for these columns in different controllers, the effect
2716 <column name="local_ip">
2717 The IP address to configure on the local port,
2718 e.g. <code>192.168.0.123</code>. If this value is unset, then
2719 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2723 <column name="local_netmask">
2724 The IP netmask to configure on the local port,
2725 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2726 but this value is unset, then the default is chosen based on whether
2727 the IP address is class A, B, or C.
2730 <column name="local_gateway">
2731 The IP address of the gateway to configure on the local port, as a
2732 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2733 this network has no gateway.
2737 <group title="Controller Status">
2738 <column name="is_connected">
2739 <code>true</code> if currently connected to this controller,
2740 <code>false</code> otherwise.
2744 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2745 <p>The level of authority this controller has on the associated
2746 bridge. Possible values are:</p>
2748 <dt><code>other</code></dt>
2749 <dd>Allows the controller access to all OpenFlow features.</dd>
2750 <dt><code>master</code></dt>
2751 <dd>Equivalent to <code>other</code>, except that there may be at
2752 most one master controller at a time. When a controller configures
2753 itself as <code>master</code>, any existing master is demoted to
2754 the <code>slave</code>role.</dd>
2755 <dt><code>slave</code></dt>
2756 <dd>Allows the controller read-only access to OpenFlow features.
2757 Attempts to modify the flow table will be rejected with an
2758 error. Slave controllers do not receive OFPT_PACKET_IN or
2759 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2764 <column name="status" key="last_error">
2765 A human-readable description of the last error on the connection
2766 to the controller; i.e. <code>strerror(errno)</code>. This key
2767 will exist only if an error has occurred.
2770 <column name="status" key="state"
2771 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2773 The state of the connection to the controller:
2776 <dt><code>VOID</code></dt>
2777 <dd>Connection is disabled.</dd>
2779 <dt><code>BACKOFF</code></dt>
2780 <dd>Attempting to reconnect at an increasing period.</dd>
2782 <dt><code>CONNECTING</code></dt>
2783 <dd>Attempting to connect.</dd>
2785 <dt><code>ACTIVE</code></dt>
2786 <dd>Connected, remote host responsive.</dd>
2788 <dt><code>IDLE</code></dt>
2789 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2792 These values may change in the future. They are provided only for
2797 <column name="status" key="sec_since_connect"
2798 type='{"type": "integer", "minInteger": 0}'>
2799 The amount of time since this controller last successfully connected to
2800 the switch (in seconds). Value is empty if controller has never
2801 successfully connected.
2804 <column name="status" key="sec_since_disconnect"
2805 type='{"type": "integer", "minInteger": 1}'>
2806 The amount of time since this controller last disconnected from
2807 the switch (in seconds). Value is empty if controller has never
2812 <group title="Connection Parameters">
2814 Additional configuration for a connection between the controller
2815 and the Open vSwitch.
2818 <column name="other_config" key="dscp"
2819 type='{"type": "integer"}'>
2820 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2821 in the Type of Service (TOS) field in the IP header. DSCP provides a
2822 mechanism to classify the network traffic and provide Quality of
2823 Service (QoS) on IP networks.
2825 The DSCP value specified here is used when establishing the connection
2826 between the controller and the Open vSwitch. If no value is specified,
2827 a default value of 48 is chosen. Valid DSCP values must be in the
2833 <group title="Common Columns">
2834 The overall purpose of these columns is described under <code>Common
2835 Columns</code> at the beginning of this document.
2837 <column name="external_ids"/>
2838 <column name="other_config"/>
2842 <table name="Manager" title="OVSDB management connection.">
2844 Configuration for a database connection to an Open vSwitch database
2849 This table primarily configures the Open vSwitch database
2850 (<code>ovsdb-server</code>), not the Open vSwitch switch
2851 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2852 what connections should be treated as in-band.
2856 The Open vSwitch database server can initiate and maintain active
2857 connections to remote clients. It can also listen for database
2861 <group title="Core Features">
2862 <column name="target">
2863 <p>Connection method for managers.</p>
2865 The following connection methods are currently supported:
2868 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2871 The specified SSL <var>port</var> (default: 6632) on the host at
2872 the given <var>ip</var>, which must be expressed as an IP address
2873 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2874 column in the <ref table="Open_vSwitch"/> table must point to a
2875 valid SSL configuration when this form is used.
2878 SSL support is an optional feature that is not always built as
2879 part of Open vSwitch.
2883 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2885 The specified TCP <var>port</var> (default: 6632) on the host at
2886 the given <var>ip</var>, which must be expressed as an IP address
2889 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2892 Listens for SSL connections on the specified TCP <var>port</var>
2893 (default: 6632). If <var>ip</var>, which must be expressed as an
2894 IP address (not a DNS name), is specified, then connections are
2895 restricted to the specified local IP address.
2898 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2899 table="Open_vSwitch"/> table must point to a valid SSL
2900 configuration when this form is used.
2903 SSL support is an optional feature that is not always built as
2904 part of Open vSwitch.
2907 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2909 Listens for connections on the specified TCP <var>port</var>
2910 (default: 6632). If <var>ip</var>, which must be expressed as an
2911 IP address (not a DNS name), is specified, then connections are
2912 restricted to the specified local IP address.
2915 <p>When multiple managers are configured, the <ref column="target"/>
2916 values must be unique. Duplicate <ref column="target"/> values yield
2917 unspecified results.</p>
2920 <column name="connection_mode">
2922 If it is specified, this setting must be one of the following strings
2923 that describes how Open vSwitch contacts this OVSDB client over the
2928 <dt><code>in-band</code></dt>
2930 In this mode, this connection's traffic travels over a bridge
2931 managed by Open vSwitch. With this setting, Open vSwitch allows
2932 traffic to and from the client regardless of the contents of the
2933 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2934 to connect to the client, because it did not have a flow to enable
2935 it.) This is the most common connection mode because it is not
2936 necessary to maintain two independent networks.
2938 <dt><code>out-of-band</code></dt>
2940 In this mode, the client's traffic uses a control network separate
2941 from that managed by Open vSwitch, that is, Open vSwitch does not
2942 use any of its own network devices to communicate with the client.
2943 The control network must be configured separately, before or after
2944 <code>ovs-vswitchd</code> is started.
2949 If not specified, the default is implementation-specific.
2954 <group title="Client Failure Detection and Handling">
2955 <column name="max_backoff">
2956 Maximum number of milliseconds to wait between connection attempts.
2957 Default is implementation-specific.
2960 <column name="inactivity_probe">
2961 Maximum number of milliseconds of idle time on connection to the client
2962 before sending an inactivity probe message. If Open vSwitch does not
2963 communicate with the client for the specified number of seconds, it
2964 will send a probe. If a response is not received for the same
2965 additional amount of time, Open vSwitch assumes the connection has been
2966 broken and attempts to reconnect. Default is implementation-specific.
2967 A value of 0 disables inactivity probes.
2971 <group title="Status">
2972 <column name="is_connected">
2973 <code>true</code> if currently connected to this manager,
2974 <code>false</code> otherwise.
2977 <column name="status" key="last_error">
2978 A human-readable description of the last error on the connection
2979 to the manager; i.e. <code>strerror(errno)</code>. This key
2980 will exist only if an error has occurred.
2983 <column name="status" key="state"
2984 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2986 The state of the connection to the manager:
2989 <dt><code>VOID</code></dt>
2990 <dd>Connection is disabled.</dd>
2992 <dt><code>BACKOFF</code></dt>
2993 <dd>Attempting to reconnect at an increasing period.</dd>
2995 <dt><code>CONNECTING</code></dt>
2996 <dd>Attempting to connect.</dd>
2998 <dt><code>ACTIVE</code></dt>
2999 <dd>Connected, remote host responsive.</dd>
3001 <dt><code>IDLE</code></dt>
3002 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3005 These values may change in the future. They are provided only for
3010 <column name="status" key="sec_since_connect"
3011 type='{"type": "integer", "minInteger": 0}'>
3012 The amount of time since this manager last successfully connected
3013 to the database (in seconds). Value is empty if manager has never
3014 successfully connected.
3017 <column name="status" key="sec_since_disconnect"
3018 type='{"type": "integer", "minInteger": 0}'>
3019 The amount of time since this manager last disconnected from the
3020 database (in seconds). Value is empty if manager has never
3024 <column name="status" key="locks_held">
3025 Space-separated list of the names of OVSDB locks that the connection
3026 holds. Omitted if the connection does not hold any locks.
3029 <column name="status" key="locks_waiting">
3030 Space-separated list of the names of OVSDB locks that the connection is
3031 currently waiting to acquire. Omitted if the connection is not waiting
3035 <column name="status" key="locks_lost">
3036 Space-separated list of the names of OVSDB locks that the connection
3037 has had stolen by another OVSDB client. Omitted if no locks have been
3038 stolen from this connection.
3041 <column name="status" key="n_connections"
3042 type='{"type": "integer", "minInteger": 2}'>
3044 When <ref column="target"/> specifies a connection method that
3045 listens for inbound connections (e.g. <code>ptcp:</code> or
3046 <code>pssl:</code>) and more than one connection is actually active,
3047 the value is the number of active connections. Otherwise, this
3048 key-value pair is omitted.
3051 When multiple connections are active, status columns and key-value
3052 pairs (other than this one) report the status of one arbitrarily
3058 <group title="Connection Parameters">
3060 Additional configuration for a connection between the manager
3061 and the Open vSwitch Database.
3064 <column name="other_config" key="dscp"
3065 type='{"type": "integer"}'>
3066 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3067 in the Type of Service (TOS) field in the IP header. DSCP provides a
3068 mechanism to classify the network traffic and provide Quality of
3069 Service (QoS) on IP networks.
3071 The DSCP value specified here is used when establishing the connection
3072 between the manager and the Open vSwitch. If no value is specified, a
3073 default value of 48 is chosen. Valid DSCP values must be in the range
3078 <group title="Common Columns">
3079 The overall purpose of these columns is described under <code>Common
3080 Columns</code> at the beginning of this document.
3082 <column name="external_ids"/>
3083 <column name="other_config"/>
3087 <table name="NetFlow">
3088 A NetFlow target. NetFlow is a protocol that exports a number of
3089 details about terminating IP flows, such as the principals involved
3092 <column name="targets">
3093 NetFlow targets in the form
3094 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3095 must be specified numerically, not as a DNS name.
3098 <column name="engine_id">
3099 Engine ID to use in NetFlow messages. Defaults to datapath index
3103 <column name="engine_type">
3104 Engine type to use in NetFlow messages. Defaults to datapath
3105 index if not specified.
3108 <column name="active_timeout">
3109 The interval at which NetFlow records are sent for flows that are
3110 still active, in seconds. A value of <code>0</code> requests the
3111 default timeout (currently 600 seconds); a value of <code>-1</code>
3112 disables active timeouts.
3115 <column name="add_id_to_interface">
3116 <p>If this column's value is <code>false</code>, the ingress and egress
3117 interface fields of NetFlow flow records are derived from OpenFlow port
3118 numbers. When it is <code>true</code>, the 7 most significant bits of
3119 these fields will be replaced by the least significant 7 bits of the
3120 engine id. This is useful because many NetFlow collectors do not
3121 expect multiple switches to be sending messages from the same host, so
3122 they do not store the engine information which could be used to
3123 disambiguate the traffic.</p>
3124 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3127 <group title="Common Columns">
3128 The overall purpose of these columns is described under <code>Common
3129 Columns</code> at the beginning of this document.
3131 <column name="external_ids"/>
3136 SSL configuration for an Open_vSwitch.
3138 <column name="private_key">
3139 Name of a PEM file containing the private key used as the switch's
3140 identity for SSL connections to the controller.
3143 <column name="certificate">
3144 Name of a PEM file containing a certificate, signed by the
3145 certificate authority (CA) used by the controller and manager,
3146 that certifies the switch's private key, identifying a trustworthy
3150 <column name="ca_cert">
3151 Name of a PEM file containing the CA certificate used to verify
3152 that the switch is connected to a trustworthy controller.
3155 <column name="bootstrap_ca_cert">
3156 If set to <code>true</code>, then Open vSwitch will attempt to
3157 obtain the CA certificate from the controller on its first SSL
3158 connection and save it to the named PEM file. If it is successful,
3159 it will immediately drop the connection and reconnect, and from then
3160 on all SSL connections must be authenticated by a certificate signed
3161 by the CA certificate thus obtained. <em>This option exposes the
3162 SSL connection to a man-in-the-middle attack obtaining the initial
3163 CA certificate.</em> It may still be useful for bootstrapping.
3166 <group title="Common Columns">
3167 The overall purpose of these columns is described under <code>Common
3168 Columns</code> at the beginning of this document.
3170 <column name="external_ids"/>
3174 <table name="sFlow">
3175 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3178 <column name="agent">
3179 Name of the network device whose IP address should be reported as the
3180 ``agent address'' to collectors. If not specified, the agent device is
3181 figured from the first target address and the routing table. If the
3182 routing table does not contain a route to the target, the IP address
3183 defaults to the <ref table="Controller" column="local_ip"/> in the
3184 collector's <ref table="Controller"/>. If an agent IP address cannot be
3185 determined any of these ways, sFlow is disabled.
3188 <column name="header">
3189 Number of bytes of a sampled packet to send to the collector.
3190 If not specified, the default is 128 bytes.
3193 <column name="polling">
3194 Polling rate in seconds to send port statistics to the collector.
3195 If not specified, defaults to 30 seconds.
3198 <column name="sampling">
3199 Rate at which packets should be sampled and sent to the collector.
3200 If not specified, defaults to 400, which means one out of 400
3201 packets, on average, will be sent to the collector.
3204 <column name="targets">
3205 sFlow targets in the form
3206 <code><var>ip</var>:<var>port</var></code>.
3209 <group title="Common Columns">
3210 The overall purpose of these columns is described under <code>Common
3211 Columns</code> at the beginning of this document.
3213 <column name="external_ids"/>